| blob | 203ea514e15996a0574be6e727a068ee03a7cd50 |
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.
1545 "Read command name to invoke in `execute-extended-command'."
1555 ;; Get a command name at point in the original buffer
1556 ;; to propose it after M-n.
1560 ;; Read a string, completing from and restricting to the set of
1561 ;; all defined commands. Don't provide any initial input.
1562 ;; Save the command read on the extended-command history list.
1573 ;; This isn't strictly correct if `execute-extended-command'
1574 ;; is bound to anything else (e.g. [menu]).
1575 ;; It could use (key-description (this-single-command-keys)),
1576 ;; but actually a prompt other than "M-x" would be confusing,
1577 ;; because "M-x" is a well-known prompt to read a command
1578 ;; and it serves as a shorthand for "Extended command: ".
1583 ;; Exclude obsolete commands from completions.
1588 pred)))
1593 "Non-nil means show the equivalent key-binding when M-x command has one.
1594 The value can be a length of time to show the message for.
1595 If the value is non-nil and not a number, we wait 2 seconds."
1617 binding)
1623 name len)))
1630 binding))
1633 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1634 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1635 "Read a command name, then read the arguments and call the command.
1636 To pass a prefix argument to the command you are
1637 invoking, give a prefix argument to `execute-extended-command'."
1639 ;; FIXME: Remember the actual text typed by the user before completion,
1640 ;; so that we don't later on suggest the same shortening.
1645 execute-extended-command--last-typed)))
1646 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1659 ;; Normally `real-this-command' should never be changed, but here we really
1660 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1661 ;; binding" for <cmd>, so the command the user really wanted to run is
1662 ;; `function' and not `execute-extended-command'. The difference is
1663 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1667 ;; If enabled, show which key runs this command.
1668 ;; (when binding
1669 ;; But first wait, and skip the message if there is input.
1671 ;; If this command displayed something in the echo area;
1672 ;; wait a few seconds, then display our suggestion message.
1673 ;; FIXME: Wait *after* running post-command-hook!
1674 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1675 ;; find a better answer anyway!
1683 ;; There's no binding for CMD. Let's try and find the shortest
1684 ;; string to use in M-x.
1685 ;; FIXME: Can be slow. Cache it maybe?
1692 function
1697 suggest-key-bindings
1701 ;; BEWARE: Called directly from the C code.
1702 "Execute CMD as an editor command.
1703 CMD must be a symbol that satisfies the `commandp' predicate.
1704 Optional second arg RECORD-FLAG non-nil
1705 means unconditionally put this command in the variable `command-history'.
1706 Otherwise, that is done only if an arg is read using the minibuffer.
1707 The argument KEYS specifies the value to use instead of (this-command-keys)
1708 when reading the arguments; if it is nil, (this-command-keys) is used.
1709 The argument SPECIAL, if non-nil, means that this command is executing
1710 a special event, so ignore the prefix argument and don't clear it."
1718 disabled-command-function)
1719 ;; FIXME: Weird calling convention!
1729 ;; If requested, place the macro in the command history. For
1730 ;; other sorts of commands, call-interactively takes care of this.
1733 ;; Don't keep command history around forever.
1739 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1747 \f
1749 "Default minibuffer history list.
1750 This is used for all minibuffer input
1751 except when an alternate history list is specified.
1753 Maximum length of the history list is determined by the value
1756 "Control whether history list elements are expressions or strings.
1757 If the value of this variable equals current minibuffer depth,
1758 they are expressions; otherwise they are strings.
1759 \(That convention is designed to do the right thing for
1766 "Text that was in this minibuffer before any history commands.
1767 This is nil if there have not yet been any history commands
1776 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1780 "Minibuffer history variables for which matching should ignore case.
1781 If a history variable is a member of this list, then the
1783 commands ignore case when searching it, regardless of `case-fold-search'."
1788 "Find the previous history element that matches REGEXP.
1789 \(Previous history elements refer to earlier actions.)
1790 With prefix argument N, search for Nth previous match.
1791 If N is negative, find the next or Nth next match.
1792 Normally, history elements are matched case-insensitively if
1793 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1794 makes the search case-sensitive.
1795 See also `minibuffer-history-case-insensitive-variables'."
1799 nil
1800 minibuffer-local-map
1801 nil
1802 'minibuffer-history-search-history
1804 ;; Use the last regexp specified, by default, if input is empty.
1809 regexp)
1819 ;; On some systems, ignore case for file names.
1821 minibuffer-history-case-insensitive-variables)
1822 t
1823 ;; Respect the user's setting for case-fold-search:
1824 case-fold-search)
1825 nil))
1826 prevpos
1827 match-string
1828 match-offset
1835 "No later matching history item"
1856 next-matching-history-element))
1860 "Find the next history element that matches REGEXP.
1861 \(The next history element refers to a more recent action.)
1862 With prefix argument N, search for Nth next match.
1863 If N is negative, find the previous or Nth previous match.
1864 Normally, history elements are matched case-insensitively if
1865 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1866 makes the search case-sensitive."
1870 nil
1871 minibuffer-local-map
1872 nil
1873 'minibuffer-history-search-history
1875 ;; Use the last regexp specified, by default, if input is empty.
1880 regexp)
1887 "Function run by `goto-history-element' before consuming default values.
1888 This is useful to dynamically add more elements to the list of default values
1889 when `goto-history-element' reaches the end of this list.
1890 Before calling this function `goto-history-element' sets the variable
1891 `minibuffer-default-add-done' to t, so it will call this function only
1892 once. In special cases, when this function needs to be called more
1893 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1897 "When nil, add more elements to the end of the list of default values.
1898 The value nil causes `goto-history-element' to add more elements to
1899 the list of defaults when it reaches the end of this list. It does
1905 "Return a list of all completions without the default value.
1906 This function is used to add all elements of the completion table to
1907 the end of the list of defaults just after the default value."
1910 minibuffer-completion-table
1911 minibuffer-completion-predicate)))
1917 "Puts element of the minibuffer history in the minibuffer.
1918 The argument NABS specifies the absolute history position."
1932 elt minibuffer-returned-to-present)
1939 "End of defaults; no next item"
1944 previous-history-element))
1956 minibuffer-default)))
1968 elt))
1972 "Puts next element of the minibuffer history in the minibuffer.
1973 With argument N, it uses the Nth following element."
1979 "Puts previous element of the minibuffer history in the minibuffer.
1980 With argument N, it uses the Nth previous element."
1986 "Get next history element which completes the minibuffer before the point.
1987 The contents of the minibuffer after the point are deleted, and replaced
1988 by the new completion."
1994 n)
1995 ;; next-matching-history-element always puts us at (point-min).
1996 ;; Move to the position we were at before changing the buffer contents.
1997 ;; This is still sensible, because the text before point has not changed.
2001 "\
2002 Get previous history element which completes the minibuffer before the point.
2003 The contents of the minibuffer after the point are deleted, and replaced
2004 by the new completion."
2008 ;; For compatibility with the old subr of the same name.
2010 "Return the display width of the minibuffer prompt.
2011 Return 0 if current buffer is not a minibuffer."
2012 ;; Return the width of everything before the field at the end of
2013 ;; the buffer; this should be 0 for normal buffers.
2015 \f
2016 ;; isearch minibuffer history
2023 "Set up a minibuffer for using isearch to search the minibuffer history.
2024 Intended to be added to `minibuffer-setup-hook'."
2036 "Clean up the minibuffer after terminating isearch in the minibuffer."
2041 "Return the proper search function, for isearch in minibuffer history."
2044 ;; Use standard functions to search within minibuffer text
2046 found)
2047 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2048 ;; searching forward. Lazy-highlight calls this lambda with the
2049 ;; bound arg, so skip the minibuffer prompt.
2053 ;; 1. First try searching in the initial minibuffer text
2056 noerror)
2057 ;; 2. If the above search fails, start putting next/prev history
2058 ;; elements in the minibuffer successively, and search the string
2059 ;; in them. Do this only when bound is nil (i.e. not while
2060 ;; lazy-highlighting search strings in the current minibuffer text).
2072 ;; After putting the next/prev history element, search
2073 ;; the string in them again, until next-history-element
2074 ;; or previous-history-element raises an error at the
2075 ;; beginning/end of history.
2078 ;; For backward search, don't search
2079 ;; in the minibuffer prompt
2081 noerror)))
2082 ;; Return point of the new search result
2084 ;; Return nil when next(prev)-history-element fails
2088 "Display the minibuffer history search prompt.
2089 If there are no search errors, this function displays an overlay with
2090 the isearch prompt which replaces the original minibuffer prompt.
2091 Otherwise, it displays the standard isearch message returned from
2092 the function `isearch-message'."
2094 ;; Use standard function `isearch-message' when not in the minibuffer,
2095 ;; or search fails, or has an error (like incomplete regexp).
2096 ;; This function overwrites minibuffer text with isearch message,
2097 ;; so it's possible to see what is wrong in the search string.
2099 ;; Otherwise, put the overlay with the standard isearch prompt over
2100 ;; the initial minibuffer prompt.
2109 ;; And clear any previous isearch message.
2113 "Wrap the minibuffer history search when search fails.
2114 Move point to the first history element for a forward search,
2115 or to the last history element for a backward search."
2116 ;; When `minibuffer-history-isearch-search' fails on reaching the
2117 ;; beginning/end of the history, wrap the search to the first/last
2118 ;; minibuffer history element.
2126 "Save a function restoring the state of minibuffer history search.
2127 Save `minibuffer-history-position' to the additional state parameter
2128 in the search status stack."
2134 "Restore the minibuffer history search state.
2135 Go to the history element by the absolute history position HIST-POS."
2138 \f
2139 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2143 "Table mapping redo records to the corresponding undo one.
2144 A redo record for undo-in-region maps to t.
2154 "Within a run of consecutive undo commands, list remaining to be undone.
2158 "Undo some previous changes.
2159 Repeat this command to undo more changes.
2160 A numeric ARG serves as a repeat count.
2162 In Transient Mark mode when the mark is active, only undo changes within
2164 as an argument limits undo to changes within the current region."
2166 ;; Make last-command indicate for the next command that this was an undo.
2167 ;; That way, another undo will undo more.
2168 ;; If we get to the end of the undo history and get an error,
2169 ;; another undo command will find the undo history empty
2170 ;; and will get another error. To begin undoing the undos,
2171 ;; you must type some other command.
2173 ;; For an indirect buffer, look in the base buffer for the
2174 ;; auto-save data.
2178 message)
2179 ;; If we get an error in undo-start,
2180 ;; the next command should not be a "consecutive undo".
2181 ;; So set `this-command' to something other than `undo'.
2186 ;; If something (a timer or filter?) changed the buffer
2187 ;; since the previous command, don't continue the undo seq.
2191 ;; If the last undo record made was made by undo
2192 ;; it shows nothing else happened in between.
2199 ;; get rid of initial undo boundary
2201 ;; If we got this far, the next command should be a consecutive undo.
2203 ;; Check to see whether we're hitting a redo record, and if
2204 ;; so, ask the user whether she wants to skip the redo/undo pair.
2212 ;; The equiv entry might point to another redo record if we have done
2213 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2221 ;; Record the fact that the just-generated undo records come from an
2222 ;; undo operation--that is, they are redo records.
2223 ;; In the ordinary case (not within a region), map the redo
2224 ;; record to the following undos.
2225 ;; I don't know how to do that in the undo-in-region case.
2227 ;; Strip any leading undo boundaries there might be, like we do
2228 ;; above when checking.
2232 ;; Prevent identity mapping. This can happen if
2233 ;; consecutive nils are erroneously in undo list.
2235 t
2236 pending-undo-list)
2237 undo-equiv-table))
2238 ;; Don't specify a position in the undo record for the undo command.
2239 ;; Instead, undoing this should move point to where the change is.
2258 ;; Record what the current undo list says,
2259 ;; so the next command can tell if the buffer was modified in between.
2263 ;; Display a message announcing success.
2268 "Make BUFFER stop keeping undo information.
2269 No argument or nil as argument means do this for the current buffer."
2275 "Undo some previous changes.
2276 Repeat this command to undo more changes.
2277 A numeric ARG serves as a repeat count.
2278 Contrary to `undo', this will not redo a previous undo."
2283 "Non-nil while performing an undo.
2287 "Undo back N undo-boundaries beyond what was already undone recently.
2288 Call `undo-start' to get ready to undo recent changes,
2289 then call `undo-more' one or more times to undo them."
2294 ;; Note: The following, while pulling elements off
2295 ;; `pending-undo-list' will call primitive change functions which
2296 ;; will push more elements onto `buffer-undo-list'.
2302 "Undo N records from the front of the list LIST.
2303 Return what remains of the list."
2305 ;; This is a good feature, but would make undo-start
2306 ;; unable to do what is expected.
2307 ;;(when (null (car (list)))
2308 ;; ;; If the head of the list is a boundary, it is the boundary
2309 ;; ;; preceding this command. Get rid of it and don't count it.
2310 ;; (setq list (cdr list))))
2313 ;; In a writable buffer, enable undoing read-only text that is
2314 ;; so because of text properties.
2316 ;; Don't let `intangible' properties interfere with undo.
2318 ;; We use oldlist only to check for EQ. ++kfs
2324 ;; Handle an integer by setting point to that value.
2327 ;; Element (t . TIME) records previous modtime.
2328 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2329 ;; UNKNOWN_MODTIME_NSECS.
2331 ;; If this records an obsolete save
2332 ;; (not matching the actual disk file)
2333 ;; then don't mark unmodified.
2341 ;; Element (nil PROP VAL BEG . END) is property change.
2346 ;; Element (BEG . END) means range was inserted.
2348 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2349 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2352 ;; Set point first thing, so that undoing this undo
2353 ;; does not send point back to where it is now.
2356 ;; Element (apply FUN . ARGS) means call FUN to undo.
2360 ;; Long format: (apply DELTA START END FUN . ARGS).
2367 ;; Check that the function did what the entry
2368 ;; said it would do.
2378 ;; Element (STRING . POS) means STRING was deleted.
2384 ;; Check that marker adjustments which were recorded
2385 ;; with the (STRING . POS) record are still valid, ie
2386 ;; the markers haven't moved. We check their validity
2387 ;; before reinserting the string so as we don't need to
2388 ;; mind marker insertion-type.
2396 ;; Insert string and adjust point
2404 ;; Adjust the valid marker adjustments
2408 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2411 next)
2412 ;; Even though these elements are not expected in the undo
2413 ;; list, adjust them to be conservative for the 24.4
2414 ;; release. (Bug#16818)
2421 ;; Make sure an apply entry produces at least one undo entry,
2422 ;; so the test in `undo' for continuing an undo series
2423 ;; will work right.
2428 list)
2430 ;; Deep copy of a list
2432 "Make a copy of undo list LIST."
2438 elt))
2441 "Set `pending-undo-list' to the front of the undo list.
2442 The next call to `undo-more' will undo the most recently made change.
2443 If BEG and END are specified, then only undo elements
2444 that apply to text between BEG and END are used; other undo elements
2445 are ignored. If BEG and END are nil, all undo elements are used."
2451 buffer-undo-list)))
2453 ;; The positions given in elements of the undo list are the positions
2454 ;; as of the time that element was recorded to undo history. In
2455 ;; general, subsequent buffer edits render those positions invalid in
2456 ;; the current buffer, unless adjusted according to the intervening
2457 ;; undo elements.
2458 ;;
2459 ;; Undo in region is a use case that requires adjustments to undo
2460 ;; elements. It must adjust positions of elements in the region based
2461 ;; on newer elements not in the region so as they may be correctly
2462 ;; applied in the current buffer. undo-make-selective-list
2463 ;; accomplishes this with its undo-deltas list of adjustments. An
2464 ;; example undo history from oldest to newest:
2465 ;;
2466 ;; buf pos:
2467 ;; 123456789 buffer-undo-list undo-deltas
2468 ;; --------- ---------------- -----------
2469 ;; aaa (1 . 4) (1 . -3)
2470 ;; aaba (3 . 4) N/A (in region)
2471 ;; ccaaba (1 . 3) (1 . -2)
2472 ;; ccaabaddd (7 . 10) (7 . -3)
2473 ;; ccaabdd ("ad" . 6) (6 . 2)
2474 ;; ccaabaddd (6 . 8) (6 . -2)
2475 ;; | |<-- region: "caab", from 2 to 6
2476 ;;
2477 ;; When the user starts a run of undos in region,
2478 ;; undo-make-selective-list is called to create the full list of in
2479 ;; region elements. Each element is adjusted forward chronologically
2480 ;; through undo-deltas to determine if it is in the region.
2481 ;;
2482 ;; In the above example, the insertion of "b" is (3 . 4) in the
2483 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2484 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2485 ;; . 6) is assessed as in the region and placed in the selective list.
2486 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2487 ;; due to the selected element. The "b" insertion is the only element
2488 ;; fully in the region, so in this example undo-make-selective-list
2489 ;; returns (nil (5 . 6)).
2490 ;;
2491 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2492 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2493 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2494 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2495 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2496 ;;
2497 ;; More interesting is how to adjust the "ddd" insertion due to the
2498 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2499 ;; If the reinsertion was a manual retyping of "ad", then the total
2500 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2501 ;; the reinsertion was due to undo, one might expect the first "d"
2502 ;; character would again be a part of the "ddd" text, meaning its
2503 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2504 ;;
2505 ;; undo-make-selective-list assumes in this situation that "ad" was a
2506 ;; new edit, even if it was inserted because of an undo.
2507 ;; Consequently, if the user undos in region "8 to 10" of the
2508 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2509 ;; "ccaabad", as though the first "d" became detached from the
2510 ;; original "ddd" insertion. This quirk is a FIXME.
2513 "Return a list of undo elements for the region START to END.
2514 The elements come from `buffer-undo-list', but we keep only the
2515 elements inside this region, and discard those outside this
2516 region. The elements' positions are adjusted so as the returned
2517 list can be applied to the current buffer."
2519 ;; A list of position adjusted undo elements in the region.
2521 ;; A list of undo-deltas for out of region undo elements.
2522 undo-deltas
2523 undo-elt)
2531 ;; Don't put two nils together in the list
2535 ;; This is a "was unmodified" element. Keep it
2536 ;; if we have kept everything thus far.
2539 ;; Skip over marker adjustments, instead relying
2540 ;; on finding them after (TEXT . POS) elements
2542 nil)
2545 undo-deltas)))
2550 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2551 ;; kept. primitive-undo may discard them later.
2564 "Determine whether UNDO-ELT falls inside the region START ... END.
2565 If it crosses the edge, we return nil.
2567 Generally this function is not useful for determining
2568 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2569 because markers can be arbitrarily relocated. Instead, pass the
2570 marker adjustment's corresponding (TEXT . POS) element."
2575 t)
2577 nil)
2579 ;; (TEXT . POSITION)
2583 ;; (MARKER . ADJUSTMENT)
2586 ;; (nil PROPERTY VALUE BEG . END)
2591 ;; (BEGIN . END)
2596 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2597 This assumes we have already decided that UNDO-ELT
2598 is not *inside* the region START...END."
2602 ;; (nil PROPERTY VALUE BEG . END)
2607 ;; (BEGIN . END)
2612 "Return adjustment of undo element ELT by the undo DELTAS
2613 list."
2615 ;; POSITION
2618 ;; (BEG . END)
2621 ;; (TEXT . POSITION)
2625 ;; (nil PROPERTY VALUE BEG . END)
2628 ;; (apply DELTA START END FUN . ARGS)
2629 ;; FIXME
2630 ;; All others return same elt
2633 ;; (BEG . END) can adjust to the same positions, commonly when an
2634 ;; insertion was undone and they are out of region, for example:
2635 ;;
2636 ;; buf pos:
2637 ;; 123456789 buffer-undo-list undo-deltas
2638 ;; --------- ---------------- -----------
2639 ;; [...]
2640 ;; abbaa (2 . 4) (2 . -2)
2641 ;; aaa ("bb" . 2) (2 . 2)
2642 ;; [...]
2643 ;;
2644 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2645 ;; undo. Further adjustments to such an element should be the same as
2646 ;; for (TEXT . POSITION) elements. The options are:
2647 ;;
2648 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2649 ;; analogous to marker insertion-type t.
2650 ;;
2651 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2652 ;; marker insertion-type nil.
2653 ;;
2654 ;; There was no strong reason to prefer one or the other, except that
2655 ;; the first is more consistent with prior undo in region behavior.
2657 "Return cons of adjustments to BEG and END by the undo DELTAS
2658 list."
2660 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2665 "Return adjustment of POS by the undo DELTAS list, comparing
2666 with < or <= based on USE-<."
2672 ;; Don't allow pos to become less than the undo-delta
2673 ;; position. This edge case is described in the overview
2674 ;; comments.
2677 ;; Return the first affected buffer position and the delta for an undo element
2678 ;; delta is defined as the change in subsequent buffer positions if we *did*
2679 ;; the undo.
2683 ;; (TEXT . POSITION)
2686 ;; (BEGIN . END)
2693 "If non-nil ask about discarding undo info for the current command.
2694 Normally, Emacs discards the undo info for the current command if
2695 it exceeds `undo-outer-limit'. But if you set this option
2696 non-nil, it asks in the echo area whether to discard the info.
2697 If you answer no, there is a slight risk that Emacs might crash, so
2698 only do it if you really want to undo the command.
2700 This option is mainly intended for debugging. You have to be
2701 careful if you use it for other purposes. Garbage collection is
2702 inhibited while the question is asked, meaning that Emacs might
2703 leak memory. So you should make sure that you do not wait
2704 excessively long before answering the question."
2710 "If non-nil, an extra level of size that's ok in an undo item.
2711 We don't ask the user about truncating the undo list until the
2712 current item gets bigger than this amount.
2717 ;; When the first undo batch in an undo list is longer than
2718 ;; undo-outer-limit, this function gets called to warn the user that
2719 ;; the undo info for the current command was discarded. Garbage
2720 ;; collection is inhibited around the call, so it had better not do a
2721 ;; lot of consing.
2727 ;; Don't ask the question again unless it gets even bigger.
2728 ;; This applies, in particular, if the user quits from the question.
2729 ;; Such a quit quits out of GC, but something else will call GC
2730 ;; again momentarily. It will call this function again,
2731 ;; but we don't want to ask the question again.
2738 t)
2739 nil))
2744 "The undo info was discarded because it exceeded \
2745 `undo-outer-limit'.
2747 This is normal if you executed a command that made a huge change
2748 to the buffer. In that case, to prevent similar problems in the
2749 future, set `undo-outer-limit' to a value that is large enough to
2750 cover the maximum size of normal changes you expect a single
2751 command to make, but not so large that it might exceed the
2752 maximum memory allotted to Emacs.
2754 If you did not execute any such command, the situation is
2755 probably due to a bug and you should report it.
2757 You can disable the popping up of this buffer by adding the entry
2758 \(undo discard-info) to the user option `warning-suppress-types',
2762 t))
2763 \f
2766 ; These are sorted according to the GNU en_US locale.
2809 )
2811 This is used by Shell mode and other parts of Emacs to recognize
2812 password prompts, including prompts in languages other than
2813 English. Different case choices should not be assumed to be
2814 included; callers should bind `case-fold-search' to t."
2820 "History list for some commands that read shell commands.
2822 Maximum length of the history list is determined by the value
2829 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2830 This buffer is used when `shell-command' or `shell-command-on-region'
2831 is run interactively. A value of nil means that output to stderr and
2838 "Return a list of all commands associated with the current file.
2839 This function is used to add all related commands retrieved by `mailcap'
2840 to the end of the list of defaults just after the default value."
2844 minibuffer-default))
2849 commands))
2860 map)
2864 "Read a shell command from the minibuffer.
2865 The arguments are the same as the ones of `read-from-minibuffer',
2866 except READ and KEYMAP are missing and HIST defaults
2867 to `shell-command-history'."
2875 minibuffer-local-shell-command-map
2876 nil
2878 args)))
2881 "What to do when the output buffer is used by another shell command.
2882 This option specifies how to resolve the conflict where a new command
2883 wants to direct its output to the buffer `*Async Shell Command*',
2884 but this buffer is already taken by another running shell command.
2886 The value `confirm-kill-process' is used to ask for confirmation before
2887 killing the already running process and running a new process
2888 in the same buffer, `confirm-new-buffer' for confirmation before running
2889 the command in a new buffer with a name other than the default buffer name,
2890 `new-buffer' for doing the same without confirmation,
2891 `confirm-rename-buffer' for confirmation before renaming the existing
2892 output buffer and running a new command in the default buffer,
2893 `rename-buffer' for doing the same without confirmation."
2895 confirm-kill-process)
2897 confirm-new-buffer)
2899 new-buffer)
2901 confirm-rename-buffer)
2903 rename-buffer))
2908 "Execute string COMMAND asynchronously in background.
2910 Like `shell-command', but adds `&' at the end of COMMAND
2911 to execute it asynchronously.
2913 The output appears in the buffer `*Async Shell Command*'.
2914 That buffer is in shell mode.
2916 You can configure `async-shell-command-buffer' to specify what to do in
2917 case when `*Async Shell Command*' buffer is already taken by another
2918 running shell command. To run COMMAND without displaying the output
2919 in a window you can configure `display-buffer-alist' to use the action
2920 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
2922 In Elisp, you will often be better served by calling `start-process'
2923 directly, since it offers more control and does not impose the use of a
2924 shell (with its need to quote arguments)."
2934 current-prefix-arg
2935 shell-command-default-error-buffer))
2941 "Execute string COMMAND in inferior shell; display output, if any.
2942 With prefix argument, insert the COMMAND's output at point.
2944 If COMMAND ends in `&', execute it asynchronously.
2945 The output appears in the buffer `*Async Shell Command*'.
2946 That buffer is in shell mode. You can also use
2947 `async-shell-command' that automatically adds `&'.
2949 Otherwise, COMMAND is executed synchronously. The output appears in
2950 the buffer `*Shell Command Output*'. If the output is short enough to
2951 display in the echo area (which is determined by the variables
2952 `resize-mini-windows' and `max-mini-window-height'), it is shown
2953 there, but it is nonetheless available in buffer `*Shell Command
2954 Output*' even though that buffer is not automatically displayed.
2956 To specify a coding system for converting non-ASCII characters
2958 before this command.
2960 Noninteractive callers can specify coding systems by binding
2961 `coding-system-for-read' and `coding-system-for-write'.
2963 The optional second argument OUTPUT-BUFFER, if non-nil,
2964 says to put the output in some other buffer.
2965 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2966 If OUTPUT-BUFFER is not a buffer and not nil,
2967 insert output in current buffer. (This cannot be done asynchronously.)
2968 In either case, the buffer is first erased, and the output is
2969 inserted after point (leaving mark after it).
2971 If the command terminates without error, but generates output,
2973 the output can be displayed in the echo area or in its buffer.
2974 If the output is short enough to display in the echo area
2975 \(determined by the variable `max-mini-window-height' if
2976 `resize-mini-windows' is non-nil), it is shown there.
2977 Otherwise,the buffer containing the output is displayed.
2981 of the output.
2983 If there is no output, or if output is inserted in the current buffer,
2984 then `*Shell Command Output*' is deleted.
2986 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2987 or buffer name to which to direct the command's standard error output.
2988 If it is nil, error output is mingled with regular output.
2989 In an interactive call, the variable `shell-command-default-error-buffer'
2990 specifies the value of ERROR-BUFFER.
2992 In Elisp, you will often be better served by calling `call-process' or
2993 `start-process' directly, since it offers more control and does not impose
2994 the use of a shell (with its need to quote arguments)."
3005 current-prefix-arg
3006 shell-command-default-error-buffer))
3007 ;; Look for a handler in case default-directory is a remote file name.
3015 ;; Output goes in current buffer.
3021 temporary-file-directory)))
3022 nil)))
3025 ;; We do not use -f for csh; we will not support broken use of
3026 ;; .cshrcs. Even the BSD csh manual says to use
3027 ;; "if ($?prompt) exit" before things which are not useful
3028 ;; non-interactively. Besides, if someone wants their other
3029 ;; aliases for shell commands then they can still have them.
3033 t)
3034 nil shell-command-switch command)
3041 ;; Do no formatting while reading error file,
3042 ;; because that can run a shell command, and we
3043 ;; don't want that to cause an infinite recursion.
3045 ;; Put point after the inserted errors.
3049 ;; This is like exchange-point-and-mark, but doesn't
3050 ;; activate the mark. It is cleaner to avoid activation,
3051 ;; even though the command loop would deactivate the mark
3052 ;; because we inserted text.
3056 ;; Output goes in a separate buffer.
3057 ;; Preserve the match data in case called from a program.
3060 ;; Command ending with ampersand means asynchronous.
3064 proc)
3065 ;; Remove the ampersand.
3067 ;; Ask the user what to do with already running process.
3072 ;; If will kill a process, query first.
3077 ;; If will create a new buffer, query first.
3084 ;; It will create a new buffer.
3089 ;; If will rename the buffer, query first.
3098 ;; It will rename the buffer.
3105 ;; Setting buffer-read-only to nil doesn't suffice
3106 ;; if some text has a non-nil read-only property,
3107 ;; which comint sometimes adds for prompts.
3113 shell-command-switch command))
3117 ;; Use the comint filter for proper handling of carriage motion
3118 ;; (see `comint-inhibit-carriage-motion'),.
3120 ))
3121 ;; Otherwise, command is executed synchronously.
3123 output-buffer nil error-buffer)))))))
3127 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3128 MESSAGE may be either a string or a buffer.
3130 A buffer is displayed using `display-buffer' if MESSAGE is too long for
3131 the maximum height of the echo area, as defined by `max-mini-window-height'
3132 if `resize-mini-windows' is non-nil.
3134 Returns either the string shown in the echo area, or when a pop-up
3135 buffer is used, the window used to display it.
3137 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3138 name of the buffer used to display it in the case where a pop-up buffer
3139 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3140 string and it is displayed in the echo area, it is not specified whether
3141 the contents are inserted into the buffer anyway.
3143 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
3144 and only used if a buffer is displayed."
3146 ;; Trivial case where we can use the echo area
3150 ;; Trivial case where we can just remove single trailing newline
3153 ;; General case
3156 message
3165 0
3169 (<= lines
3173 max-mini-window-height))
3175 max-mini-window-height)
3179 ;; Don't use the echo area if the output buffer is
3180 ;; already displayed in the selected frame.
3182 ;; Echo area
3188 ;; Buffer
3191 not-this-window frame))))))))
3194 ;; We have a sentinel to prevent insertion of a termination message
3195 ;; in the buffer itself.
3203 &optional output-buffer replace
3204 error-buffer display-error-buffer)
3205 "Execute string COMMAND in inferior shell with region as input.
3206 Normally display output (if any) in temp buffer `*Shell Command Output*';
3207 Prefix arg means replace the region with it. Return the exit code of
3208 COMMAND.
3210 To specify a coding system for converting non-ASCII characters
3212 before this command. By default, the input (from the current buffer)
3213 is encoded using coding-system specified by `process-coding-system-alist',
3214 falling back to `default-process-coding-system' if no match for COMMAND
3215 is found in `process-coding-system-alist'.
3217 Noninteractive callers can specify coding systems by binding
3218 `coding-system-for-read' and `coding-system-for-write'.
3220 If the command generates output, the output may be displayed
3221 in the echo area or in a buffer.
3222 If the output is short enough to display in the echo area
3223 \(determined by the variable `max-mini-window-height' if
3224 `resize-mini-windows' is non-nil), it is shown there.
3225 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3226 The output is available in that buffer in both cases.
3228 If there is output and an error, a message about the error
3229 appears at the end of the output. If there is no output, or if
3230 output is inserted in the current buffer, the buffer `*Shell
3231 Command Output*' is deleted.
3233 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3234 command's output. If the value is a buffer or buffer name,
3235 put the output there. If the value is nil, use the buffer
3236 `*Shell Command Output*'. Any other value, excluding nil,
3237 means to insert the output in the current buffer. In either case,
3238 the output is inserted after point (leaving mark after it).
3240 Optional fifth arg REPLACE, if non-nil, means to insert the
3241 output in place of text from START to END, putting point and mark
3242 around it.
3244 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3245 or buffer name to which to direct the command's standard error
3246 output. If nil, error output is mingled with regular output.
3247 When called interactively, `shell-command-default-error-buffer'
3248 is used for ERROR-BUFFER.
3250 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3251 display the error buffer if there were any errors. When called
3252 interactively, this is t."
3256 ;; Do this before calling region-beginning
3257 ;; and region-end, in case subprocess output
3258 ;; relocates them while we are in the minibuffer.
3260 ;; call-interactively recognizes region-beginning and
3261 ;; region-end specially, leaving them in the history.
3263 string
3264 current-prefix-arg
3265 current-prefix-arg
3266 shell-command-default-error-buffer
3267 t)))
3273 temporary-file-directory)))
3274 nil))
3275 exit-status)
3279 ;; Replace specified region with output from command.
3281 ;; Don't muck with mark unless REPLACE says we should.
3288 t)
3289 nil shell-command-switch command))
3290 ;; It is rude to delete a buffer which the command is not using.
3291 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3292 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3293 ;; (kill-buffer shell-buffer)))
3294 ;; Don't muck with mark unless REPLACE says we should.
3296 ;; No prefix argument: put the output in a temp buffer,
3297 ;; replacing its entire contents.
3302 ;; If the input is the same buffer as the output,
3303 ;; delete everything but the specified region,
3304 ;; then replace that region with the output.
3310 shell-file-name t
3313 t)
3314 nil shell-command-switch
3315 command)))
3316 ;; Clear the output buffer, then run the command with
3317 ;; output there.
3328 buffer)
3329 nil shell-command-switch command)))
3330 ;; Report the output.
3340 ;; There's some output, display it
3342 ;; No output; error?
3349 shell-command-default-error-buffer)
3356 output))
3359 exit-status))
3362 exit-status output))))
3363 ;; Don't kill: there might be useful info in the undo-log.
3364 ;; (kill-buffer buffer)
3365 ))))
3373 ;; Do no formatting while reading error file,
3374 ;; because that can run a shell command, and we
3375 ;; don't want that to cause an infinite recursion.
3377 ;; Put point after the inserted errors.
3382 exit-status))
3385 "Execute shell command COMMAND and return its output as a string."
3388 standard-output
3392 "Process files synchronously in a separate process.
3393 Similar to `call-process', but may invoke a file handler based on
3394 `default-directory'. The current working directory of the
3395 subprocess is `default-directory'.
3397 File names in INFILE and BUFFER are handled normally, but file
3398 names in ARGS should be relative to `default-directory', as they
3399 are passed to the process verbatim. (This is a difference to
3400 `call-process' which does not support file handlers for INFILE
3401 and BUFFER.)
3403 Some file handlers might not support all variants, for example
3404 they might behave as if DISPLAY was nil, regardless of the actual
3405 value passed."
3407 lc stderr-file)
3417 display args)
3423 "Whether a call of `process-file' changes remote files.
3425 By default, this variable is always set to `t', meaning that a
3426 call of `process-file' could potentially change any file on a
3427 remote host. When set to `nil', a file handler could optimize
3428 its behavior with respect to remote file attribute caching.
3430 You should only ever change this variable with a let-binding;
3434 "Start a program in a subprocess. Return the process object for it.
3436 Similar to `start-process', but may invoke a file handler based on
3437 `default-directory'. See Info node `(elisp)Magic File Names'.
3439 This handler ought to run PROGRAM, perhaps on the local host,
3440 perhaps on a remote host that corresponds to `default-directory'.
3441 In the latter case, the local part of `default-directory' becomes
3442 the working directory of the process.
3444 PROGRAM and PROGRAM-ARGS might be file names. They are not
3445 objects of file handler invocation. File handlers might not
3446 support pty association, if PROGRAM is nil."
3450 \f
3451 ;;;; Process menu
3465 map))
3468 "Major mode for listing the processes called by Emacs."
3480 "Kill process at point in a `list-processes' buffer."
3486 "Recompute the list of processes for the Process List buffer.
3487 Also, delete any process that is exited or signaled."
3500 face link
3503 follow-link t
3504 process-buffer ,buf
3505 action process-menu-visit-buffer)
3514 "datagram"
3531 tabulated-list-entries))))))
3537 "Display a list of all processes that are Emacs sub-processes.
3538 If optional argument QUERY-ONLY is non-nil, only processes with
3539 the query-on-exit flag set are listed.
3540 Any process listed as exited or signaled is actually eliminated
3541 after the listing is made.
3542 Optional argument BUFFER specifies a buffer to use, instead of
3544 The return value is always nil.
3546 This function lists only processes that were launched by Emacs. To
3547 see other processes running on the system, use `list-system-processes'."
3559 nil)
3560 \f
3564 ;; For backward compatibility, minus with no modifiers is an ordinary
3565 ;; command if digits have already been entered.
3595 map)
3602 "Begin a numeric argument for the following command.
3607 multiplies the argument by 4 each time.
3609 which is different in effect from any particular numeric argument.
3616 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3617 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3623 arg)))
3627 "Begin a negative numeric argument for the next command.
3636 "Part of the numeric argument for the next command.
3640 last-command-event
3647 ;; Treat -0 as just -, so that -01 will work.
3650 digit))))
3652 \f
3660 "Function to perform the filtering in `filter-buffer-substring'.
3661 The function is called with the same 3 arguments (BEG END DELETE)
3662 that `filter-buffer-substring' received. It should return the
3663 buffer substring between BEG and END, after filtering. If DELETE is
3667 "List of filter functions for `buffer-substring--filter'.
3668 Each function must accept a single argument, a string, and return a string.
3669 The buffer substring is passed to the first function in the list,
3670 and the return value of each function is passed to the next.
3671 As a special convention, point is set to the start of the buffer text
3672 being operated on (i.e., the first argument of `buffer-substring--filter')
3678 "Return the buffer substring between BEG and END, after filtering.
3679 If DELETE is non-nil, delete the text between BEG and END from the buffer.
3681 This calls the function that `filter-buffer-substring-function' specifies
3682 \(passing the same three arguments that it received) to do the work,
3683 and returns whatever it does. The default function does no filtering,
3684 unless a hook has been set.
3686 Use `filter-buffer-substring' instead of `buffer-substring',
3687 `buffer-substring-no-properties', or `delete-and-extract-region' when
3688 you want to allow filtering to take place. For example, major or minor
3689 modes can use `filter-buffer-substring-function' to extract characters
3690 that are special to a buffer, and should not be copied into other buffers."
3694 "Default function to use for `filter-buffer-substring-function'.
3695 Its arguments and return value are as specified for `filter-buffer-substring'.
3696 This respects the wrapper hook `filter-buffer-substring-functions',
3697 and the abnormal hook `buffer-substring-filters'.
3698 No filtering is done unless a hook says to."
3708 string)))
3713 ;;;; Window system cut and paste hooks.
3716 "Function to call to make a killed region available to other programs.
3717 Most window systems provide a facility for cutting and pasting
3718 text between different programs, such as the clipboard on X and
3719 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3721 This variable holds a function that Emacs calls whenever text is
3722 put in the kill ring, to make the new kill available to other
3723 programs. The function takes one argument, TEXT, which is a
3727 "Function to call to get text cut from other programs.
3728 Most window systems provide a facility for cutting and pasting
3729 text between different programs, such as the clipboard on X and
3730 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3732 This variable holds a function that Emacs calls to obtain text
3733 that other programs have provided for pasting. The function is
3734 called with no arguments. If no other program has provided text
3735 to paste, the function should return nil (in which case the
3736 caller, usually `current-kill', should use the top of the Emacs
3737 kill ring). If another program has provided text to paste, the
3738 function should return that text as a string (in which case the
3739 caller should put this string in the kill ring as the latest
3740 kill).
3742 The function may also return a list of strings if the window
3743 system supports multiple selections. The first string will be
3744 used as the pasted text, but the other will be placed in the kill
3745 ring for easy access via `yank-pop'.
3747 Note that the function should return a string only if a program
3748 other than Emacs has provided a string for pasting; if Emacs
3749 provided the most recent string, the function should return nil.
3750 If it is difficult to tell whether Emacs or some other program
3751 provided the current string, it is probably good enough to return
3752 nil if the string is equal (according to `string=') to the last
3754 \f
3757 ;;;; The kill ring data structure.
3760 "List of killed text sequences.
3761 Since the kill ring is supposed to interact nicely with cut-and-paste
3762 facilities offered by window systems, use of this variable should
3763 interact nicely with `interprogram-cut-function' and
3764 `interprogram-paste-function'. The functions `kill-new',
3765 `kill-append', and `current-kill' are supposed to implement this
3766 interaction; you may want to use them instead of manipulating the kill
3770 "Maximum length of kill ring before oldest elements are thrown away."
3778 "Save clipboard strings into kill ring before replacing them.
3779 When one selects something in another program to paste it into Emacs,
3780 but kills something in Emacs before actually pasting it,
3781 this selection is gone unless this variable is non-nil,
3782 in which case the other program's selection is saved in the `kill-ring'
3789 "Do not add a new string to `kill-ring' if it duplicates the last one.
3790 The comparison is done using `equal-including-properties'."
3796 "Make STRING the latest kill in the kill ring.
3797 Set `kill-ring-yank-pointer' to point to it.
3798 If `interprogram-cut-function' is non-nil, apply it to STRING.
3799 Optional second argument REPLACE non-nil means that STRING will replace
3800 the front of the kill ring, rather than being added to the list.
3802 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3803 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3804 STRING.
3806 When the yank handler has a non-nil PARAM element, the original STRING
3807 argument is not used by `insert-for-yank'. However, since Lisp code
3808 may access and use elements from the kill ring directly, the STRING
3811 ;; Due to text properties such as 'yank-handler that
3812 ;; can alter the contents to yank, comparison using
3813 ;; `equal' is unsafe.
3838 ;; It has been argued that this should work similar to `self-insert-command'
3839 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
3841 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
3847 "Append STRING to the end of the latest kill in the kill ring.
3848 If BEFORE-P is non-nil, prepend STRING to the kill.
3849 Also removes the last undo boundary in the current buffer,
3850 depending on `kill-append-merge-undo'.
3851 If `interprogram-cut-function' is set, pass the resulting kill to it."
3859 ;; find the next undo boundary
3863 ;; remove this undo boundary
3868 "Whether rotating the kill ring changes the window system selection.
3869 If non-nil, whenever the kill ring is rotated (usually via the
3870 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3871 to copy the new kill to the window system selection."
3877 "Rotate the yanking point by N places, and then return that kill.
3878 If N is zero and `interprogram-paste-function' is set to a
3879 function that returns a string or a list of strings, and if that
3880 function doesn't return nil, then that string (or list) is added
3881 to the front of the kill ring and the string (or first string in
3882 the list) is returned as the latest kill.
3884 If N is not zero, and if `yank-pop-change-selection' is
3885 non-nil, use `interprogram-cut-function' to transfer the
3886 kill at the new yank point into the window system selection.
3888 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3889 move the yanking point; just return the Nth kill forward."
3892 interprogram-paste-function
3896 ;; Disable the interprogram cut function when we add the new
3897 ;; text to the kill ring, so Emacs doesn't try to own the
3898 ;; selection, with identical text.
3908 kill-ring)))
3913 interprogram-cut-function)
3919 ;;;; Commands for manipulating the kill ring.
3922 "Non-nil means don't signal an error for killing read-only text."
3928 This deletes the text from the buffer and saves it in the kill ring.
3932 If you want to append the killed region to the last killed text,
3935 If the buffer is read-only, Emacs will beep and refrain from deleting
3936 the text, but put the text in the kill ring anyway. This means that
3937 you can use the killing commands to copy text from a read-only buffer.
3939 Lisp programs should use this function for killing text.
3940 (To delete text, use `delete-region'.)
3941 Supply two arguments, character positions indicating the stretch of text
3942 to be killed.
3944 If the previous command was also a kill command,
3945 the text killed this time appends to the text killed last time
3946 to make one entry in the kill ring.
3948 The optional argument REGION if non-nil, indicates that we're not just killing
3949 some text between BEG and END, but we're killing the region."
3950 ;; Pass mark first, then point, because the order matters when
3951 ;; calling `kill-append'.
3960 ;; Add that string to the kill ring, one way or another.
3967 nil)
3969 ;; The code above failed because the buffer, or some of the characters
3970 ;; in the region, are read-only.
3971 ;; We should beep, in case the user just isn't aware of this.
3972 ;; However, there's no harm in putting
3973 ;; the region's text in the kill ring, anyway.
3975 ;; Set this-command now, so it will be set even if we get an error.
3977 ;; This should barf, if appropriate, and give us the correct error.
3980 ;; Signal an error if the buffer is read-only.
3982 ;; If the buffer isn't read-only, the text is.
3985 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3986 ;; to get two copies of the text when the user accidentally types M-w and
3987 ;; then corrects it with the intended C-w.
3989 "Save the region as if killed, but don't kill it.
3990 In Transient Mark mode, deactivate the mark.
3991 If `interprogram-cut-function' is non-nil, also save the text for a window
3992 system cut and paste.
3994 The optional argument REGION if non-nil, indicates that we're not just copying
3995 some text between BEG and END, but we're copying the region.
3997 This command's old key binding has been given to `kill-ring-save'."
3998 ;; Pass mark first, then point, because the order matters when
3999 ;; calling `kill-append'.
4009 nil)
4012 "Save the region as if killed, but don't kill it.
4013 In Transient Mark mode, deactivate the mark.
4014 If `interprogram-cut-function' is non-nil, also save the text for a window
4015 system cut and paste.
4017 If you want to append the killed line to the last killed text,
4020 The optional argument REGION if non-nil, indicates that we're not just copying
4021 some text between BEG and END, but we're copying the region.
4023 This command is similar to `copy-region-as-kill', except that it gives
4024 visual feedback indicating the extent of the region being copied."
4025 ;; Pass mark first, then point, because the order matters when
4026 ;; calling `kill-append'.
4030 ;; This use of called-interactively-p is correct because the code it
4031 ;; controls just gives the user visual feedback.
4036 "Indicate that the region text has been copied interactively.
4037 If the mark is visible in the selected window, blink the cursor
4038 between point and mark if there is currently no active region
4039 highlighting.
4041 If the mark lies outside the selected window, display an
4042 informative message containing a sample of the copied text. The
4043 optional argument MESSAGE-LEN, if non-nil, specifies the length
4044 of this sample text; it defaults to 40."
4047 ;; Inhibit quitting so we can make a quit here
4048 ;; look like a C-g typed as a command.
4051 ;; Swap point-and-mark quickly so as to show the region that
4052 ;; was selected. Don't do it if the region is highlighted.
4055 ;; Swap point and mark.
4059 ;; Swap back.
4062 ;; If user quit, deactivate the mark
4063 ;; as C-g would as a command.
4069 ;; Don't say "killed"; that is misleading.
4076 "Cause following command, if it kills, to add to previous kill.
4077 If the next command kills forward from point, the kill is
4078 appended to the previous killed text. If the command kills
4079 backward, the kill is prepended. Kill commands that act on the
4080 region, such as `kill-region', are regarded as killing forward if
4081 point is after mark, and killing backward if point is before
4082 mark.
4084 If the next command is not a kill command, `append-next-kill' has
4085 no effect.
4087 The argument is used for internal purposes; do not supply one."
4089 ;; We don't use (interactive-p), since that breaks kbd macros.
4095 \f
4096 ;; Yanking.
4101 "List of special text property handling conditions for yanking.
4102 Each element should have the form (PROP . FUN), where PROP is a
4103 property symbol and FUN is a function. When the `yank' command
4104 inserts text into the buffer, it scans the inserted text for
4105 stretches of text that have `eq' values of the text property
4106 PROP; for each such stretch of text, FUN is called with three
4107 arguments: the property's value in that text, and the start and
4108 end positions of the text.
4110 This is done prior to removing the properties specified by
4111 `yank-excluded-properties'."
4114 function))
4117 ;; This is actually used in subr.el but defcustom does not work there.
4120 intangible invisible keymap local-map mouse-face read-only
4121 yank-handler)
4122 "Text properties to discard when yanking.
4123 The value should be a list of text properties to discard or t,
4124 which means to discard all text properties.
4126 See also `yank-handled-properties'."
4133 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4134 Function is called with two parameters, START and END corresponding to
4135 the value of the mark and point; it is guaranteed that START <= END.
4139 "Replace just-yanked stretch of killed text with a different stretch.
4140 This command is allowed only immediately after a `yank' or a `yank-pop'.
4141 At such a time, the region contains a stretch of reinserted
4142 previously-killed text. `yank-pop' deletes that text and inserts in its
4143 place a different stretch of killed text.
4145 With no argument, the previous kill is inserted.
4146 With argument N, insert the Nth previous kill.
4147 If N is negative, this is a more recent kill.
4149 The sequence of kills wraps around, so that after the oldest one
4150 comes the newest one.
4152 When this command inserts killed text into the buffer, it honors
4153 `yank-excluded-properties' and `yank-handler' as described in the
4154 doc string for `insert-for-yank-1', which see."
4168 ;; Set the window start back where it was in the yank command,
4169 ;; if possible.
4172 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4173 ;; It is cleaner to avoid activation, even though the command
4174 ;; loop would deactivate the mark because we inserted text.
4177 nil)
4181 More precisely, reinsert the most recent kill, which is the
4182 stretch of killed text most recently killed OR yanked. Put point
4183 at the end, and set mark at the beginning without activating it.
4185 With argument N, reinsert the Nth most recent kill.
4187 When this command inserts text into the buffer, it honors the
4188 `yank-handled-properties' and `yank-excluded-properties'
4189 variables, and the `yank-handler' text property. See
4190 `insert-for-yank-1' for details.
4195 ;; If we don't get all the way thru, make last-command indicate that
4196 ;; for the following command.
4204 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4205 ;; It is cleaner to avoid activation, even though the command
4206 ;; loop would deactivate the mark because we inserted text.
4209 ;; If we do get all the way thru, make this-command indicate that.
4212 nil)
4215 "Rotate the yanking point in the kill ring.
4216 With ARG, rotate that many kills forward (or backward, if negative)."
4219 \f
4220 ;; Some kill commands.
4222 ;; Internal subroutine of delete-char
4228 ;; Internal subroutine of backward-delete-char
4235 "The method for untabifying when deleting backward.
4236 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4237 `hungry' -- delete all whitespace, both tabs and spaces;
4238 `all' -- delete all whitespace, including tabs, spaces and newlines;
4239 nil -- just delete one character."
4245 "Delete characters backward, changing tabs into spaces.
4246 The exact behavior depends on `backward-delete-char-untabify-method'.
4247 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4248 Interactively, ARG is the prefix arg (default 1)
4249 and KILLP is t if a prefix arg was specified."
4272 arg)))
4273 ;; Avoid warning about delete-backward-char
4277 "Kill up to and including ARGth occurrence of CHAR.
4278 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4279 Goes backward if ARG is negative; error if CHAR not found."
4282 ;; Avoid "obsolete" warnings for translation-table-for-input.
4290 ;; kill-line and its subroutines.
4293 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4298 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4299 With prefix argument ARG, kill that many lines from point.
4300 Negative arguments kill lines backward.
4301 With zero argument, kills the text before point on the current line.
4304 a number counts as a prefix arg.
4306 To kill a whole line, when point is not at the beginning, type \
4309 If `show-trailing-whitespace' is non-nil, this command will just
4310 kill the rest of the current line, even if there are only
4311 nonblanks there.
4313 If option `kill-whole-line' is non-nil, then this command kills the whole line
4314 including its terminating newline, when used at the beginning of a line
4315 with no argument. As a consequence, you can always kill a whole line
4318 If you want to append the killed line to the last killed text,
4321 If the buffer is read-only, Emacs will beep and refrain from deleting
4322 the line, but put the line in the kill ring anyway. This means that
4323 you can use this command to copy text from a read-only buffer.
4324 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4325 even beep.)"
4328 ;; It is better to move point to the other end of the kill
4329 ;; before killing. That way, in a read-only buffer, point
4330 ;; moves across the text that is copied to the kill ring.
4331 ;; The choice has no effect on undo now that undo records
4332 ;; the value of point from before the command was run.
4342 ;; If trailing whitespace is visible,
4343 ;; don't treat it as nothing.
4353 "Kill current line.
4354 With prefix ARG, kill that many lines starting from the current line.
4355 If ARG is negative, kill backward. Also kill the preceding newline.
4357 If ARG is zero, kill current line but exclude the trailing newline."
4368 ;; We need to kill in two steps, because the previous command
4369 ;; could have been a kill command, in which case the text
4370 ;; before point needs to be prepended to the current kill
4371 ;; ring entry and the text after point appended. Also, we
4372 ;; need to use save-excursion to avoid copying the same text
4373 ;; twice to the kill ring in read-only buffers.
4391 "Move forward by ARG lines, ignoring currently invisible newlines only.
4392 If ARG is negative, move backward -ARG lines.
4393 If ARG is zero, move to the beginning of the current line."
4400 ;; If the newline we just skipped is invisible,
4401 ;; don't count it.
4405 prop
4410 ;; If invisible text follows, and it is a number of complete lines,
4411 ;; skip it.
4417 prop
4433 ;; If the newline we just moved to is invisible,
4434 ;; don't count it.
4439 prop
4444 ;; If invisible text follows, and it is a number of complete lines,
4445 ;; skip it.
4451 prop
4462 nil)))
4465 "Move to end of current visible line."
4467 ;; If the following character is currently invisible,
4468 ;; skip all characters with that same `invisible' property value,
4469 ;; then find the next newline.
4476 prop
4485 \f
4487 "Insert after point the contents of BUFFER.
4488 Puts mark after the inserted text.
4489 BUFFER may be a buffer or a buffer name."
4499 t))))
4504 nil)
4507 "Append to specified buffer the text of the region.
4508 It is inserted into that buffer before its point.
4510 When calling from a program, give three arguments:
4511 BUFFER (or buffer name), START and END.
4512 START and END specify the portion of the current buffer to be copied."
4519 point)
4530 "Prepend to specified buffer the text of the region.
4531 It is inserted into that buffer after its point.
4533 When calling from a program, give three arguments:
4534 BUFFER (or buffer name), START and END.
4535 START and END specify the portion of the current buffer to be copied."
4544 "Copy to specified buffer the text of the region.
4545 It is inserted into that buffer, replacing existing text there.
4547 When calling from a program, give three arguments:
4548 BUFFER (or buffer name), START and END.
4549 START and END specify the portion of the current buffer to be copied."
4557 \f
4561 "Hook run when the mark becomes active.
4562 It is also run at the end of a command, if the mark is active and
4569 "Return this buffer's mark value as integer, or nil if never set.
4571 In Transient Mark mode, this function signals an error if
4572 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4573 or the argument FORCE is non-nil, it disregards whether the mark
4574 is active, and returns an integer or nil in the usual way.
4576 If you are using this in an editing command, you are most likely making
4577 a mistake; see the documentation of `set-mark'."
4582 ;; Behind display-selections-p.
4585 "Deactivate the mark.
4586 If Transient Mark mode is disabled, this function normally does
4587 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4589 Deactivating the mark sets `mark-active' to nil, updates the
4590 primary selection according to `select-active-regions', and runs
4591 `deactivate-mark-hook'.
4593 If Transient Mark mode was temporarily enabled, reset the value
4594 of the variable `transient-mark-mode'; if this causes Transient
4595 Mark mode to be disabled, don't change `mark-active' to nil or
4596 run `deactivate-mark-hook'."
4600 select-active-regions)
4603 ;; The var `saved-region-selection', if non-nil, is the text in
4604 ;; the region prior to the last command modifying the buffer.
4605 ;; Set the selection to that, or to the current region.
4609 ;; If another program has acquired the selection, region
4610 ;; deactivation should not clobber it (Bug#11772).
4629 "Activate the mark.
4630 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
4640 "Set this buffer's mark to POS. Don't use this function!
4641 That is to say, don't use this function unless you want
4642 the user to see that the mark has moved, and you want the previous
4643 mark position to be lost.
4645 Normally, when a new mark is set, the old one should go on the stack.
4646 This is why most applications should use `push-mark', not `set-mark'.
4648 Novice Emacs Lisp programmers often try to use the mark for the wrong
4649 purposes. The mark saves a location for the user's convenience.
4650 Most editing commands should not alter the mark.
4651 To remember a location for internal use in the Lisp program,
4652 store it in a Lisp variable. Example:
4654 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4659 ;; Normally we never clear mark-active except in Transient Mark mode.
4660 ;; But when we actually clear out the mark value too, we must
4661 ;; clear mark-active in any mode.
4663 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
4664 ;; it should never be nil if the mark is nil.
4670 If nil, region-aware commands treat empty regions as inactive.
4671 If non-nil, region-aware commands treat the region as active as
4672 long as the mark is active, even if the region is empty.
4674 Region-aware commands are those that act on the region if it is
4675 active and Transient Mark mode is enabled, and on the text near
4676 point otherwise."
4682 "Return t if the region is active and it is appropriate to act on it.
4683 This is used by commands that act specially on the region under
4684 Transient Mark mode.
4686 The return value is t if Transient Mark mode is enabled and the
4687 mark is active; furthermore, if `use-empty-active-region' is nil,
4688 the region must not be empty. Otherwise, the return value is nil.
4690 For some commands, it may be appropriate to ignore the value of
4691 `use-empty-active-region'; in that case, use `region-active-p'."
4696 "Return t if Transient Mark mode is enabled and the mark is active.
4698 Some commands act specially on the region when Transient Mark
4699 mode is enabled. Usually, such commands should use
4700 `use-region-p' instead of this function, because `use-region-p'
4701 also checks the value of `use-empty-active-region'."
4703 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
4704 ;; without the mark being set (e.g. bug#17324). We really should fix
4705 ;; that problem, but in the mean time, let's make sure we don't say the
4706 ;; region is active when there's no mark.
4720 ;; Normal priority so that a large region doesn't hide all the
4721 ;; overlays within it, but high secondary priority so that if it
4722 ;; ends/starts in the middle of a small overlay, that small overlay
4723 ;; won't hide the region's boundaries.
4725 nrol)
4730 rol)))
4743 start end window rol)))
4746 new)))))))
4771 "Maximum size of mark ring. Start discarding off end if gets this big."
4779 "Maximum size of global mark ring. \
4780 Start discarding off end if gets this big."
4785 "Jump to mark, and pop a new position for mark off the ring.
4786 \(Does not affect global mark ring)."
4796 "Set mark at where point is.
4797 If no prefix ARG and mark is already set there, just activate it.
4798 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4810 will pop the mark twice, and
4812 will pop the mark three times.
4820 "Set the mark where point is, or jump to the mark.
4821 Setting the mark also alters the region, which is the text
4822 between point and mark; this is the closest equivalent in
4825 With no prefix argument, set the mark at point, and push the
4826 old mark position on local mark ring. Also push the old mark on
4827 global mark ring, if the previous mark was set in another buffer.
4829 When Transient Mark Mode is off, immediately repeating this
4830 command activates `transient-mark-mode' temporarily.
4833 jump to the mark, and set the mark from
4834 position popped off the local mark ring (this does not affect the global
4836 mark ring (see `pop-global-mark').
4838 If `set-mark-command-repeat-pop' is non-nil, repeating
4840 off the local (or global) mark ring and jumps there.
4843 argument, unconditionally set mark where point is, even if
4844 `set-mark-command-repeat-pop' is non-nil.
4846 Novice Emacs Lisp programmers often try to use the mark for the wrong
4847 purposes. See the documentation of `set-mark' for more information."
4867 arg)
4881 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4882 If the last global mark pushed was not in the current buffer,
4883 also push LOCATION on the global mark ring.
4884 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4886 Novice Emacs Lisp programmers often try to use the mark for the wrong
4887 purposes. See the documentation of `set-mark' for more information.
4889 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4896 ;; Now push the mark on the global mark ring.
4899 ;; The last global mark pushed was in this same buffer.
4900 ;; Don't push another one.
4901 nil
4910 nil)
4913 "Pop off mark ring into the buffer's actual mark.
4914 Does not set point. Does nothing if mark ring is empty."
4926 "Put the mark where point is now, and point where the mark is now.
4927 This command works even when the mark is not active,
4928 and it reactivates the mark.
4930 If Transient Mark mode is on, a prefix ARG deactivates the mark
4931 if it is active, and otherwise avoids reactivating it. If
4932 Transient Mark mode is off, a prefix ARG enables Transient Mark
4933 mode temporarily."
4947 nil))
4950 "When non-nil, shifted motion keys activate the mark momentarily.
4952 While the mark is activated in this way, any shift-translated point
4953 motion key extends the region, and if Transient Mark mode was off, it
4954 is temporarily turned on. Furthermore, the mark will be deactivated
4955 by any subsequent point motion key that was not shift-translated, or
4956 by any action that normally deactivates the mark in Transient Mark mode.
4958 See `this-command-keys-shift-translated' for the meaning of
4959 shift-translation."
4964 "Activate/deactivate mark depending on invocation thru shift translation.
4965 This function is called by `call-interactively' when a command
4966 with a `^' character in its `interactive' spec is invoked, before
4967 running the command itself.
4969 If `shift-select-mode' is enabled and the command was invoked
4970 through shift translation, set the mark and activate the region
4971 temporarily, unless it was already set in this way. See
4972 `this-command-keys-shift-translated' for the meaning of shift
4973 translation.
4975 Otherwise, if the region has been activated temporarily,
4976 deactivate it, and restore the variable `transient-mark-mode' to
4977 its earlier value."
4984 transient-mark-mode)))
4993 "Toggle Transient Mark mode.
4994 With a prefix argument ARG, enable Transient Mark mode if ARG is
4995 positive, and disable it otherwise. If called from Lisp, enable
4996 Transient Mark mode if ARG is omitted or nil.
4998 Transient Mark mode is a global minor mode. When enabled, the
4999 region is highlighted whenever the mark is active. The mark is
5001 operations that set the mark but whose main purpose is something
5007 Many commands change their behavior when Transient Mark mode is
5008 in effect and the mark is active, by acting on the region instead
5009 of their usual default part of the buffer's text. Examples of
5012 To see the documentation of commands which are sensitive to the
5015 :global t
5016 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5020 "Non-nil means it is ok for commands to call `widen' when they want to.
5021 Some commands will do this in order to go to positions outside
5022 the current accessible part of the buffer.
5024 If `widen-automatically' is nil, these commands will do something else
5028 "Whether the currently executing code is performing an essential task.
5029 This variable should be non-nil only when running code which should not
5030 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5031 user for a password when we are simply scanning a set of files in the
5032 background or displaying possible completions before the user even asked
5036 "Pop off global mark ring and jump to the top location."
5038 ;; Pop entries which refer to non-existent buffers.
5056 \f
5058 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5064 "Move cursor vertically down ARG lines.
5065 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5066 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5067 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5068 function will not vscroll.
5070 ARG defaults to 1.
5072 If there is no character in the target line exactly under the current column,
5073 the cursor is positioned after the character in that line which spans this
5074 column, or at the end of the line if it is not long enough.
5075 If there is no line in the buffer after this one, behavior depends on the
5076 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5077 to create a line, and moves the cursor to that line. Otherwise it moves the
5078 cursor to the end of the buffer.
5080 If the variable `line-move-visual' is non-nil, this command moves
5081 by display lines. Otherwise, it moves by buffer lines, without
5082 taking variable-width characters or continued lines into account.
5085 a semipermanent goal column for this command.
5086 Then instead of trying to move exactly vertically (or as close as possible),
5087 this command moves to the specified goal column (or as close as possible).
5088 The goal column is stored in the variable `goal-column', which is nil
5089 when there is no goal column. Note that setting `goal-column'
5090 overrides `line-move-visual' and causes this command to move by buffer
5091 lines rather than by display lines."
5097 ;; When adding a newline, don't expand an abbrev.
5108 nil)
5111 "Move cursor vertically up ARG lines.
5112 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5113 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5114 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5115 function will not vscroll.
5117 ARG defaults to 1.
5119 If there is no character in the target line exactly over the current column,
5120 the cursor is positioned after the character in that line which spans this
5121 column, or at the end of the line if it is not long enough.
5123 If the variable `line-move-visual' is non-nil, this command moves
5124 by display lines. Otherwise, it moves by buffer lines, without
5125 taking variable-width characters or continued lines into account.
5128 a semipermanent goal column for this command.
5129 Then instead of trying to move exactly vertically (or as close as possible),
5130 this command moves to the specified goal column (or as close as possible).
5131 The goal column is stored in the variable `goal-column', which is nil
5132 when there is no goal column. Note that setting `goal-column'
5133 overrides `line-move-visual' and causes this command to move by buffer
5134 lines rather than by display lines."
5145 nil)
5148 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5149 This means moving to the end of each line moved onto.
5150 The beginning of a blank line does not count as the end of a line.
5151 This has no effect when the variable `line-move-visual' is non-nil."
5157 A non-nil setting overrides the variable `line-move-visual', which see."
5164 "Current goal column for vertical motion.
5165 It is the column where point was at the start of the current run
5166 of vertical motion commands.
5168 When moving by visual lines via the function `line-move-visual', it is a cons
5169 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5170 divided by the default column width, and HSCROLL is the number of
5171 columns by which window is scrolled from left margin.
5173 When the `track-eol' feature is doing its job, the value is
5177 "Non-nil means commands that move by lines ignore invisible newlines.
5178 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5179 as if newlines that are invisible didn't exist, and count
5180 only visible newlines. Thus, moving across across 2 newlines
5181 one of which is invisible will be counted as a one-line move.
5182 Also, a non-nil value causes invisible text to be ignored when
5183 counting columns for the purposes of keeping point in the same
5186 Outline mode sets this."
5191 "When non-nil, `line-move' moves point by visual lines.
5192 This movement is based on where the cursor is displayed on the
5193 screen, instead of relying on buffer contents alone. It takes
5194 into account variable-width characters and line continuation.
5195 If nil, `line-move' moves point by logical lines.
5196 A non-nil setting of `goal-column' overrides the value of this variable
5197 and forces movement by logical lines.
5198 A window that is horizontally scrolled also forces movement by logical
5199 lines."
5204 ;; Only used if display-graphic-p.
5208 "Return the height in pixels of the current buffer's default face font."
5212 ;; Avoid calling font-info if the frame's default font was
5213 ;; not changed since the frame was created. That's because
5214 ;; font-info is expensive for some fonts, see bug #14838.
5220 "Return the pixel height of current buffer's default-face text line.
5222 The value includes `line-spacing', if any, defined for the buffer
5223 or the frame."
5236 "Return the number of screen lines in the text area of the selected window.
5238 This is different from `window-text-height' in that this function counts
5239 lines in units of the height of the font used by the default face displayed
5240 in the window, not in units of the frame's default font, and also accounts
5241 for `line-spacing', if any, defined for the window's buffer or frame.
5243 The value is a floating-point number."
5248 ;; Returns non-nil if partial move was done.
5251 ;; Move backward (up).
5252 ;; If already vscrolled, reduce vscroll
5258 ;; Move forward (down).
5271 py vs last-line)
5291 col-row)
5296 ;; VPOS > 0 means the last line is only partially visible.
5297 ;; But if the part that is visible is at least as tall as the
5298 ;; default font, that means the line is actually fully
5299 ;; readable, and something like line-spacing is hidden. So in
5300 ;; that case we accept the last line in the window as still
5301 ;; visible, and consider the margin as starting one line
5302 ;; later.
5310 ;; If last line of window is fully visible, and vscrolling
5311 ;; more would make this line invisible, move forward.
5316 nil)
5317 ;; If cursor is not in the bottom scroll margin, and the
5318 ;; current line is is not too tall, move forward.
5320 vpos
5323 nil)
5324 ;; When already vscrolled, we vscroll some more if we can,
5325 ;; or clear vscroll and move forward at end of tall image.
5330 ;; If cursor just entered the bottom scroll margin, move forward,
5331 ;; but also optionally vscroll one line so redisplay won't recenter.
5335 ;; Don't vscroll if the partially-visible line at window
5336 ;; bottom is not too tall (a.k.a. "just one more text
5337 ;; line"): in that case, we do want redisplay to behave
5338 ;; normally, i.e. recenter or whatever.
5339 ;;
5340 ;; Note: ROWH + RBOT from the value returned by
5341 ;; pos-visible-in-window-p give the total height of the
5342 ;; partially-visible glyph row at the end of the window. As
5343 ;; we are dealing with floats, we disregard sub-pixel
5344 ;; discrepancies between that and DLH.
5348 t)
5349 ;; If there are lines above the last line, scroll-up one line.
5352 t)
5353 ;; Finally, start vscroll.
5358 ;; This is like line-move-1 except that it also performs
5359 ;; vertical scrolling of tall images if appropriate.
5360 ;; That is not really a clean thing to do, since it mixes
5361 ;; scrolling with cursor motion. But so far we don't have
5362 ;; a cleaner solution to the problem of making C-n do something
5363 ;; useful given a tall image.
5365 "Move forward ARG lines.
5366 If NOERROR, don't signal an error if we can't move ARG lines.
5367 TO-END is unused.
5368 TRY-VSCROLL controls whether to vscroll tall lines: if either
5369 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5370 not vscroll."
5374 ;; Only vscroll for single line moves
5376 ;; Under scroll-conservatively, the display engine
5377 ;; does this better.
5379 ;; But don't vscroll in a keyboard macro.
5385 ;; Display-based column are incompatible with goal-column.
5387 ;; When the text in the window is scrolled to the left,
5388 ;; display-based motion doesn't make sense (because each
5389 ;; logical line occupies exactly one screen line).
5391 ;; Likewise when the text _was_ scrolled to the left
5392 ;; when the current run of vertical motion commands
5393 ;; started.
5396 auto-hscroll-mode
5398 (>= temporary-goal-column
5401 ;; If we moved into a tall line, set vscroll to make
5402 ;; scrolling through tall images more smooth.
5406 winh)
5412 nil
5416 ;; Display-based alternative to line-move-1.
5417 ;; Arg says how many lines to move. The value is t if we can move the
5418 ;; specified number of lines.
5420 "Move ARG lines forward.
5421 If NOERROR, don't signal an error if we can't move that many lines."
5424 target-hscroll)
5425 ;; Check if the previous command was a line-motion command, or if
5426 ;; we were called from some other command.
5429 ;; If so, there's no need to reset `temporary-goal-column',
5430 ;; but we may need to hscroll.
5434 ;; Otherwise, we should reset `temporary-goal-column'.
5437 ;; Handle the `overflow-newline-into-fringe' case:
5444 hscroll))))))
5447 ;; vertical-motion can move more than it was asked to if it moves
5448 ;; across display strings with newlines. We don't want to ring
5449 ;; the bell and announce beginning/end of buffer in that case.
5455 temporary-goal-column))
5456 arg))
5457 arg))
5463 temporary-goal-column))
5464 arg))
5465 arg)))
5468 ;; If the goal column lies on a display string,
5469 ;; `vertical-motion' advances the cursor to the end
5470 ;; of the string. For arg < 0, this can cause the
5471 ;; cursor to get stuck. (Bug#3020).
5475 nil)))))
5477 ;; This is the guts of next-line and previous-line.
5478 ;; Arg says how many lines to move.
5479 ;; The value is t if we can move the specified number of lines.
5481 ;; Don't run any point-motion hooks, and disregard intangibility,
5482 ;; for intermediate positions.
5494 ;; Don't count beg of empty line as end of line
5495 ;; unless we just did explicit end-of-line.
5497 most-positive-fixnum
5501 line-move-ignore-invisible))
5502 ;; Use just newline characters.
5503 ;; Set ARG to 0 if we move as many lines as requested.
5506 ;; This way of moving forward ARG lines
5507 ;; verifies that we have a newline after the last one.
5508 ;; It doesn't get confused by intangible text.
5517 'beginning-of-buffer
5519 nil)))
5520 ;; Move by arg lines, but ignore invisible ones.
5523 ;; If the following character is currently invisible,
5524 ;; skip all characters with that same `invisible' property value.
5527 ;; Move a line.
5528 ;; We don't use `end-of-line', since we want to escape
5529 ;; from field boundaries occurring exactly at point.
5535 ;; If there's no invisibility here, move over the newline.
5544 ;; We avoid vertical-motion when possible
5545 ;; because that has to fontify.
5547 ;; Otherwise move a more sophisticated way.
5554 ;; The logic of this is the same as the loop above,
5555 ;; it just goes in the other direction.
5557 ;; For completely consistency with the forward-motion
5558 ;; case, we should call beginning-of-line here.
5559 ;; However, if point is inside a field and on a
5560 ;; continued line, the call to (vertical-motion -1)
5561 ;; below won't move us back far enough; then we return
5562 ;; to the same column in line-move-finish, and point
5563 ;; gets stuck -- cyd
5581 ;; if our target is the middle of this line.
5586 ;; This is the value the function returns.
5590 ;; If we did not move down as far as desired, at least go
5591 ;; to end of line. Be sure to call point-entered and
5592 ;; point-left-hooks.
5598 ;; If we did not move up as far as desired,
5599 ;; at least go to beginning of line.
5611 ;; Set REPEAT to t to repeat the whole thing.
5618 ;; Compute the end of the line
5619 ;; ignoring effectively invisible newlines.
5621 ;; Like end-of-line but ignores fields.
5628 ;; Move to the desired column.
5631 ;; Corner case: suppose we start out in a field boundary in
5632 ;; the middle of a continued line. When we get to
5633 ;; line-move-finish, point is at the start of a new *screen*
5634 ;; line but the same text line; then line-move-to-column would
5635 ;; move us backwards. Test using C-n with point on the "x" in
5636 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5643 ;; Process intangibility within a line.
5644 ;; With inhibit-point-motion-hooks bound to nil, a call to
5645 ;; goto-char moves point past intangible text.
5647 ;; However, inhibit-point-motion-hooks controls both the
5648 ;; intangibility and the point-entered/point-left hooks. The
5649 ;; following hack avoids calling the point-* hooks
5650 ;; unnecessarily. Note that we move *forward* past intangible
5651 ;; text when the initial and final points are the same.
5656 ;; If intangibility moves us to a different (later) place
5657 ;; in the same line, use that as the destination.
5660 ;; If that position is "too late",
5661 ;; try the previous allowable position.
5662 ;; See if it is ok.
5665 ;; If going forward, don't accept the previous
5666 ;; allowable position if it is before the target line.
5668 ;; If going backward, don't accept the previous
5669 ;; allowable position if it is still after the target line.
5672 ;; As a last resort, use the end of the line.
5675 ;; Now move to the updated destination, processing fields
5676 ;; as well as intangibility.
5680 ;; Ignore field boundaries if the initial and final
5681 ;; positions have the same `field' property, even if the
5682 ;; fields are non-contiguous. This seems to be "nicer"
5683 ;; behavior in many situations.
5686 new
5690 ;; If all this moved us to a different line,
5691 ;; retry everything within that new line.
5693 ;; Repeat the intangibility and field processing.
5697 "Try to find column COL, considering invisibility.
5698 This function works only in certain cases,
5699 because what we really need is for `move-to-column'
5700 and `current-column' to be able to ignore invisible text."
5709 ;; If the following character is currently invisible,
5710 ;; skip all characters with that same `invisible' property value.
5714 ;; Have we advanced to a larger column position?
5716 ;; We have made some progress towards the desired column.
5717 ;; See if we can make any further progress.
5719 ;; Otherwise, go to the place we originally found
5720 ;; and move back over invisible text.
5721 ;; that will get us to the same place on the screen
5722 ;; but with a more reasonable buffer position.
5729 "Move point to end of current line as displayed.
5730 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5731 If point reaches the beginning or end of buffer, it stops there.
5733 To ignore the effects of the `intangible' text or overlay
5734 property, bind `inhibit-point-motion-hooks' to t.
5735 If there is an image in the current line, this function
5736 disregards newlines that are part of the text on which the image
5737 rests."
5747 ;; With bidi reordering, we may not be at bol,
5748 ;; so make sure we are.
5763 ;; If we skipped something intangible and now we're not
5764 ;; really at eol, keep going.
5769 "Move point to beginning of current line as displayed.
5770 \(If there's an image in the line, this disregards newlines
5771 which are part of the text that the image rests on.)
5773 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5774 If point reaches the beginning or end of buffer, it stops there.
5775 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5780 first-vis first-vis-field-value)
5782 ;; Move by lines, if ARG is not 1 (the default).
5787 ;; Move to beginning-of-line, ignoring fields and invisible text.
5793 ;; Now find first visible char in the line.
5798 ;; See if fields would stop us from reaching FIRST-VIS.
5803 ;; If yes, obey them.
5804 first-vis-field-value
5805 ;; Otherwise, move to START with attention to fields.
5806 ;; (It is possible that fields never matter in this case.)
5811 ;; Many people have said they rarely use this feature, and often type
5812 ;; it by accident. Maybe it shouldn't even be on a key.
5817 Those commands will move to this position in the line moved to
5818 rather than trying to keep the same horizontal position.
5819 With a non-nil argument ARG, clears out the goal column
5821 The goal column is stored in the variable `goal-column'."
5828 ;; The older method below can be erroneous if `set-goal-column' is bound
5829 ;; to a sequence containing %
5830 ;;(message (substitute-command-keys
5831 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
5832 ;;goal-column)
5839 )
5840 nil)
5841 \f
5842 ;;; Editing based on visual lines, as opposed to logical lines.
5845 "Move point to end of current visual line.
5846 With argument N not nil or 1, move forward N - 1 visual lines first.
5847 If point reaches the beginning or end of buffer, it stops there.
5848 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5854 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5855 ;; constrain to field boundaries, so we don't either.
5859 "Move point to beginning of current visual line.
5860 With argument N not nil or 1, move forward N - 1 visual lines first.
5861 If point reaches the beginning or end of buffer, it stops there.
5862 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5870 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5874 "Kill the rest of the visual line.
5875 With prefix argument ARG, kill that many visual lines from point.
5876 If ARG is negative, kill visual lines backward.
5877 If ARG is zero, kill the text before point on the current visual
5878 line.
5880 If you want to append the killed line to the last killed text,
5883 If the buffer is read-only, Emacs will beep and refrain from deleting
5884 the line, but put the line in the kill ring anyway. This means that
5885 you can use this command to copy text from a read-only buffer.
5886 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5887 even beep.)"
5889 ;; Like in `kill-line', it's better to move point to the other end
5890 ;; of the kill before killing.
5898 ;; Skip any trailing whitespace at the end of the visual line.
5899 ;; We used to do this only if `show-trailing-whitespace' is
5900 ;; nil, but that's wrong; the correct thing would be to check
5901 ;; whether the trailing whitespace is highlighted. But, it's
5902 ;; OK to just do this unconditionally.
5909 "Move cursor vertically down ARG lines.
5910 This is identical to `next-line', except that it always moves
5911 by logical lines instead of visual lines, ignoring the value of
5912 the variable `line-move-visual'."
5919 "Move cursor vertically up ARG lines.
5920 This is identical to `previous-line', except that it always moves
5921 by logical lines instead of visual lines, ignoring the value of
5922 the variable `line-move-visual'."
5929 "Editing based on visual lines."
5938 ;; These keybindings interfere with xterm function keys. Are
5939 ;; there any other suitable bindings?
5940 ;; (define-key map "\M-[" 'previous-logical-line)
5941 ;; (define-key map "\M-]" 'next-logical-line)
5942 map))
5945 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5946 The value should be a list of the form (LEFT RIGHT), where LEFT
5947 and RIGHT are symbols representing the bitmaps to display, to
5948 indicate wrapped lines, in the left and right fringes respectively.
5949 See also `fringe-indicator-alist'.
5950 The default is not to display fringe indicators for wrapped lines.
5951 This variable does not affect fringe indicators displayed for
5952 other purposes."
5967 'continuation
5974 "Toggle visual line based editing (Visual Line mode).
5975 With a prefix argument ARG, enable Visual Line mode if ARG is
5976 positive, and disable it otherwise. If called from Lisp, enable
5977 the mode if ARG is omitted or nil.
5979 When Visual Line mode is enabled, `word-wrap' is turned on in
5980 this buffer, and simple editing commands are redefined to act on
5981 visual lines, not logical lines. See Info node `Visual Line
5982 Mode' for details."
5983 :keymap visual-line-mode-map
5989 ;; Save the local values of some variables, to be restored if
5990 ;; visual-line-mode is turned off.
5992 truncate-partial-width-windows
5993 word-wrap fringe-indicator-alist))
5996 visual-line--saved-state)))
6000 word-wrap t
6001 fringe-indicator-alist
6003 fringe-indicator-alist)))
6017 visual-line-mode turn-on-visual-line-mode)
6019 \f
6021 "Interchange characters around point, moving forward one character.
6022 With prefix arg ARG, effect is to take character before point
6023 and drag it forward past ARG other characters (backward if ARG negative).
6024 If no argument and at end of line, the previous two chars are exchanged."
6032 "Interchange words around point, leaving point at end of them.
6033 With prefix arg ARG, effect is to take word before or around point
6034 and drag it forward past ARG other words (backward if ARG negative).
6035 If ARG is zero, the words around or after point and around or after mark
6036 are interchanged."
6037 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6043 Does not work on a sexp that point is in the middle of
6044 if it is a list or string."
6048 ;; Here we should try to simulate the behavior of
6049 ;; (cons (progn (forward-sexp x) (point))
6050 ;; (progn (forward-sexp (- x)) (point)))
6051 ;; Except that we don't want to rely on the second forward-sexp
6052 ;; putting us back to where we want to be, since forward-sexp-function
6053 ;; might do funny things like infix-precedence.
6058 ;; Jumping over a symbol. We might be inside it, mind you.
6063 ;; Otherwise, we're between sexps. Take a step back before jumping
6064 ;; to make sure we'll obey the same precedence no matter which direction
6065 ;; we're going.
6070 'skip-syntax-forward
6077 "Exchange current line and previous line, leaving point after both.
6078 With argument ARG, takes previous line and moves it past ARG lines.
6079 With argument 0, interchanges line point is in with line mark is in."
6085 ;; Move forward over ARG lines,
6086 ;; but create newlines if necessary.
6093 arg))
6095 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6096 ;; which seems inconsistent with the ARG /= 0 case.
6097 ;; FIXME document SPECIAL.
6099 "Subroutine to do the work of transposing objects.
6100 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6101 moves forward by units of the given object (e.g. forward-sentence,
6102 forward-paragraph). If ARG is zero, exchanges the current object
6103 with the one containing mark. If ARG is an integer, moves the
6104 current object past ARG following (if ARG is positive) or
6105 preceding (if ARG is negative) objects, leaving point after the
6106 current object."
6111 pos1 pos2)
6139 ;; This sequence of insertions attempts to preserve marker
6140 ;; positions at the start and end of the transposed objects.
6154 \f
6156 "Move backward until encountering the beginning of a word.
6157 With argument ARG, do this that many times.
6158 If ARG is omitted or nil, move point backward one word."
6163 "Set mark ARG words away from point.
6165 move to with the same argument.
6166 Interactively, if this command is repeated
6167 or (in Transient Mark mode) if the mark is active,
6168 it marks the next ARG words after the ones already marked."
6185 nil t))))
6188 "Kill characters forward until encountering the end of a word.
6189 With argument ARG, do this that many times."
6194 "Kill characters backward until encountering the beginning of a word.
6195 With argument ARG, do this that many times."
6200 "Return the symbol or word that point is on (or a nearby one) as a string.
6201 The return value includes no text properties.
6202 If optional arg STRICT is non-nil, return nil unless point is within
6203 or adjacent to a symbol or word. In all cases the value can be nil
6204 if there is no word nearby.
6205 The function, belying its name, normally finds a symbol.
6206 If optional arg REALLY-WORD is non-nil, it finds just a word."
6215 ;; Point is neither within nor adjacent to a word.
6217 ;; Look for preceding word in same line.
6220 ;; No preceding word in same line.
6221 ;; Look for following word in same line.
6230 ;; If we found something nonempty, return it as a string.
6233 \f
6235 "String for filling to insert at front of new line, or nil for none."
6237 string)
6243 "Regexp to match lines which should not be auto-filled."
6245 regexp)
6249 "The default value for `normal-auto-fill-function'.
6250 This is the default auto-fill function, some major modes use a different one.
6251 Returns t if it really did any work."
6261 nil ;; Auto-filling not required
6265 ;; Choose a fill-prefix automatically.
6273 ;; Use auto-indentation rather than a guessed empty prefix.
6279 ;; Determine where to split the line.
6292 ;; See whether the place we found is any good.
6296 ;; There is no use breaking at end of line.
6298 ;; It is futile to split at the end of the prefix
6299 ;; since we would just insert the prefix again.
6301 ;; Don't split right after a comment starter
6302 ;; since we would just make another comment starter.
6307 limit t)
6309 ;; No good place to break => stop trying.
6311 ;; Ok, we have a useful place to break the line. Do it.
6313 ;; If point is at the fill-point, do not `save-excursion'.
6314 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6315 ;; point will end up before it rather than after it.
6323 ;; Now do justification, if required
6328 ;; If making the new line didn't reduce the hpos of
6329 ;; the end of the line, then give up now;
6330 ;; trying again will not help.
6333 ;; Justify last line.
6335 t)))
6338 "Mode-specific function which line breaks and continues a comment.
6339 This function is called during auto-filling when a comment syntax
6340 is defined.
6341 The function should take a single optional argument, which is a flag
6345 "Break line at point and indent.
6346 If a comment syntax is defined, call `comment-indent-new-line'.
6348 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6349 unless optional argument SOFT is non-nil."
6353 ;; Insert the newline before removing empty space so that markers
6354 ;; get preserved better.
6360 ;; Blindly trust a non-adaptive fill-prefix.
6366 ;; If there's an adaptive prefix, use it unless we're inside
6367 ;; a comment and the prefix is not a comment starter.
6371 ;; If we're not inside a comment, just try to indent.
6375 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6379 ;; `functions' and `hooks' are usually unsafe to set, but setting
6380 ;; auto-fill-function to nil in a file-local setting is safe and
6381 ;; can be useful to prevent auto-filling.
6385 "Toggle automatic line breaking (Auto Fill mode).
6386 With a prefix argument ARG, enable Auto Fill mode if ARG is
6387 positive, and disable it otherwise. If called from Lisp, enable
6388 the mode if ARG is omitted or nil.
6390 When Auto Fill mode is enabled, inserting a space at a column
6391 beyond `current-fill-column' automatically breaks the line at a
6392 previous space.
6394 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6395 non-`nil'.
6397 The value of `normal-auto-fill-function' specifies the function to use
6398 for `auto-fill-function' when turning Auto Fill mode on."
6403 ;; This holds a document string used to document auto-fill-mode.
6405 "Automatically break line at a previous space, in insertion of text."
6406 nil)
6409 "Unconditionally turn on Auto Fill mode."
6413 "Unconditionally turn off Auto Fill mode."
6419 "Set `fill-column' to specified argument.
6424 ;; We used to use current-column silently, but C-x f is too easily
6425 ;; typed as a typo for C-x C-f, so we turned it into an error and
6426 ;; now an interactive prompt.
6431 ;; Disallow missing argument; it's probably a typo for C-x C-f.
6435 \f
6437 "Set `selective-display' to ARG; clear it if no arg.
6438 When the value of `selective-display' is a number > 0,
6439 lines whose indentation is >= that value are not displayed.
6440 The variable `selective-display' has a separate value for each buffer."
6460 "Toggle truncating of long lines for the current buffer.
6461 When truncating is off, long lines are folded.
6462 With prefix argument ARG, truncate long lines if ARG is positive,
6463 otherwise fold them. Note that in side-by-side windows, this
6464 command has no effect if `truncate-partial-width-windows' is
6465 non-nil."
6477 nil t)))
6482 "Toggle whether to use word-wrapping for continuation lines.
6483 With prefix argument ARG, wrap continuation lines at word boundaries
6484 if ARG is positive, otherwise wrap them at the right screen edge.
6485 This command toggles the value of `word-wrap'. It has no effect
6486 if long lines are truncated."
6502 "Toggle Overwrite mode.
6503 With a prefix argument ARG, enable Overwrite mode if ARG is
6504 positive, and disable it otherwise. If called from Lisp, enable
6505 the mode if ARG is omitted or nil.
6507 When Overwrite mode is enabled, printing characters typed in
6508 replace existing text on a one-for-one basis, rather than pushing
6509 it to the right. At the end of a line, such characters extend
6510 the line. Before a tab, such characters insert until the tab is
6512 overwrite mode; this is supposed to make it easier to insert
6513 characters when necessary."
6518 "Toggle Binary Overwrite mode.
6519 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6520 is positive, and disable it otherwise. If called from Lisp,
6521 enable the mode if ARG is omitted or nil.
6523 When Binary Overwrite mode is enabled, printing characters typed
6524 in replace existing text. Newlines are not treated specially, so
6525 typing at the end of a line joins the line to the next, with the
6526 typed character between them. Typing before a tab character
6527 simply replaces the tab with the character typed.
6529 ordinary typing characters do.
6531 Note that Binary Overwrite mode is not its own minor mode; it is
6532 a specialization of overwrite mode, entered by setting the
6533 `overwrite-mode' variable to `overwrite-mode-binary'."
6538 "Toggle line number display in the mode line (Line Number mode).
6539 With a prefix argument ARG, enable Line Number mode if ARG is
6540 positive, and disable it otherwise. If called from Lisp, enable
6541 the mode if ARG is omitted or nil.
6543 Line numbers do not appear for very large buffers and buffers
6544 with very long lines; see variables `line-number-display-limit'
6545 and `line-number-display-limit-width'."
6549 "Toggle column number display in the mode line (Column Number mode).
6550 With a prefix argument ARG, enable Column Number mode if ARG is
6551 positive, and disable it otherwise.
6553 If called from Lisp, enable the mode if ARG is omitted or nil."
6557 "Toggle buffer size display in the mode line (Size Indication mode).
6558 With a prefix argument ARG, enable Size Indication mode if ARG is
6559 positive, and disable it otherwise.
6561 If called from Lisp, enable the mode if ARG is omitted or nil."
6565 "Toggle auto-saving in the current buffer (Auto Save mode).
6566 With a prefix argument ARG, enable Auto Save mode if ARG is
6567 positive, and disable it otherwise.
6569 If called from Lisp, enable the mode if ARG is omitted or nil."
6571 ;; If auto-save is off because buffer has shrunk,
6572 ;; then toggling should turn it on.
6580 buffer-file-name)
6582 ;; If -1 was stored here, to temporarily turn off saving,
6583 ;; turn it back on.
6586 \f
6588 "Blinking matching of parens and expressions."
6593 "Non-nil means show matching open-paren when close-paren is inserted.
6594 If t, highlight the paren. If `jump', move cursor to its position."
6602 "Non-nil means show matching open-paren when it is on screen.
6603 If nil, don't show it (but the open-paren can still be shown
6604 when it is off screen).
6606 This variable has no effect if `blink-matching-paren' is nil.
6607 \(In that case, the open-paren is never shown.)
6608 It is also ignored if `show-paren-mode' is enabled."
6613 "If non-nil, maximum distance to search backwards for matching open-paren.
6614 If nil, search stops at the beginning of the accessible portion of the buffer."
6620 "Time in seconds to delay after showing a matching paren."
6625 "If nil, `blink-matching-paren' ignores comments.
6626 More precisely, when looking for the matching parenthesis,
6627 it skips the contents of comments that end before point."
6632 "Return whether or not START...END are matching parens.
6633 END is the current point and START is the blink position.
6634 START might be nil if no matching starter was found.
6635 Returns non-nil if we find there is a mismatch."
6640 ;; For self-matched chars like " and $, we can't know when they're
6641 ;; mismatched or unmatched, so we can only do it for parens.
6646 ;; The cdr might hold a new paren-class info rather than
6647 ;; a matching-char info, in which case the two CDRs
6648 ;; should match.
6652 "Function to check parentheses mismatches.
6653 The function takes two arguments (START and END) where START is the
6654 position just before the opening token and END is the position right after.
6655 START can be nil, if it was not found.
6662 ol)
6666 "Momentarily highlight the beginning of the sexp before point."
6669 blink-matching-paren)
6679 oldpos))
6687 ;; backward-sexp skips backward over prefix chars,
6688 ;; so move back to the matching paren.
6709 ;; Matching open within window, temporarily move to or highlight
6710 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
6711 ;; is non-nil.
6728 ;; Show what precedes the open in its line, if anything.
6733 ;; Show what follows the open in its line, if anything.
6740 ;; Otherwise show the previous nonblank line,
6741 ;; if there is one.
6750 ;; Replace the newline and other whitespace with `...'.
6751 "..."
6753 ;; There is nothing to show except the char itself.
6759 "Function called, if non-nil, whenever a close parenthesis is inserted.
6765 blink-paren-function
6768 ;; Verify an even number of quoting characters precede the close.
6779 ;; Most likely, this hook is nil, so this arg doesn't matter,
6780 ;; but I use it as a reminder that this function usually
6781 ;; likes to be run after others since it does
6782 ;; `sit-for'. That's also the reason it get a `priority' prop
6783 ;; of 100.
6785 \f
6786 ;; This executes C-g typed while Emacs is waiting for a command.
6787 ;; Quitting out of a program does not go through here;
6788 ;; that happens in the QUIT macro at the C code level.
6790 "Signal a `quit' condition.
6791 During execution of Lisp code, this character causes a quit directly.
6792 At top-level, as an editor command, this simply beeps."
6794 ;; Avoid adding the region to the window selection.
6802 ;; Force the next redisplay cycle to remove the "Def" indicator from
6803 ;; all the mode lines.
6817 This command can exit an interactive command such as `query-replace',
6818 can clear out a prefix argument or a region,
6819 can get out of the minibuffer or other recursive edit,
6820 cancel the use of the current buffer (for special-purpose buffers),
6821 or go back to just one window (by deleting all but the selected window)."
6829 nil)
6840 "Play sound stored in FILE.
6841 VOLUME and DEVICE correspond to the keywords of the sound
6842 specification for `play-sound'."
6852 \f
6854 "Your preference for a mail reading package.
6855 This is used by some keybindings which support reading mail.
6856 See also `mail-user-agent' concerning sending mail."
6866 "Your preference for a mail composition package.
6867 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6868 outgoing email message. This variable lets you specify which
6869 mail-sending package you prefer.
6871 Valid values include:
6873 `message-user-agent' -- use the Message package.
6874 See Info node `(message)'.
6875 `sendmail-user-agent' -- use the Mail package.
6876 See Info node `(emacs)Sending Mail'.
6877 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6878 See Info node `(mh-e)'.
6879 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6880 paraphernalia if Gnus is running, particularly
6881 the Gcc: header for archiving.
6883 Additional valid symbols may be available; check with the author of
6884 your package for details. The function should return non-nil if it
6885 succeeds.
6887 See also `read-mail-command' concerning reading mail."
6890 message-user-agent)
6893 sendmail-user-agent)
6896 mh-e-user-agent)
6899 gnus-user-agent)
6905 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6906 If the value of `mail-user-agent' is the default, and the user
6907 appears to have customizations applying to the old default,
6908 `compose-mail' issues a warning."
6914 "If the buffer starts with a mail header, move point to the header's end.
6915 Otherwise, moves to `point-min'.
6916 The end of the header is the start of the next line, if there is one,
6917 else the end of the last line. This function obeys RFC822."
6923 ;; Used by Rmail (e.g., rmail-forward).
6925 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6929 switch-function yank-action send-actions
6930 return-action)
6931 "Start composing a mail message to send.
6932 This uses the user's chosen mail composition package
6933 as selected with the variable `mail-user-agent'.
6934 The optional arguments TO and SUBJECT specify recipients
6935 and the initial Subject field, respectively.
6937 OTHER-HEADERS is an alist specifying additional
6938 header fields. Elements look like (HEADER . VALUE) where both
6939 HEADER and VALUE are strings.
6941 CONTINUE, if non-nil, says to continue editing a message already
6942 being composed. Interactively, CONTINUE is the prefix argument.
6944 SWITCH-FUNCTION, if non-nil, is a function to use to
6945 switch to and display the buffer used for mail composition.
6947 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6948 to insert the raw text of the message being replied to.
6949 It has the form (FUNCTION . ARGS). The user agent will apply
6950 FUNCTION to ARGS, to insert the raw text of the original message.
6951 \(The user agent will also run `mail-citation-hook', *after* the
6952 original text has been inserted in this way.)
6954 SEND-ACTIONS is a list of actions to call when the message is sent.
6955 Each action has the form (FUNCTION . ARGS).
6957 RETURN-ACTION, if non-nil, is an action for returning to the
6958 caller. It has the form (FUNCTION . ARGS). The function is
6959 called after the mail has been sent or put aside, and the mail
6960 buffer buried."
6964 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6965 ;; from sendmail-user-agent to message-user-agent. Some users may
6966 ;; encounter incompatibilities. This hack tries to detect problems
6967 ;; and warn about them.
6972 mail-yank-hooks mail-archive-file-name
6973 mail-default-reply-to mail-mailing-lists
6974 mail-self-blind))
6981 The default mail mode is now Message mode.
6982 You have the following Mail mode variable%s customized:
6984 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6991 yank-action send-actions return-action)))
6994 yank-action send-actions
6995 return-action)
6999 'switch-to-buffer-other-window yank-action send-actions
7000 return-action))
7003 yank-action send-actions
7004 return-action)
7008 'switch-to-buffer-other-frame yank-action send-actions
7009 return-action))
7011 \f
7013 "History of values entered with `set-variable'.
7015 Maximum length of the history list is determined by the value
7019 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7020 VARIABLE should be a user option variable name, a Lisp variable
7021 meant to be customized by users. You should enter VALUE in Lisp syntax,
7022 so if you want VALUE to be a string, you must surround it with doublequotes.
7023 VALUE is used literally, not evaluated.
7025 If VARIABLE has a `variable-interactive' property, that is used as if
7026 it were the arg to `interactive' (which see) to interactively read VALUE.
7028 If VARIABLE has been defined with `defcustom', then the type information
7029 in the definition is used to check that VALUE is valid.
7031 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7036 default-var)
7052 var obsolete)
7055 ;; Use VAR's `variable-interactive' property
7056 ;; as an interactive spec for prompting.
7059 arg))
7061 read-expression-map t
7062 'set-variable-value-history
7071 ;; Match with custom type.
7083 ;; Force a thorough redisplay for the case that the variable
7084 ;; has an effect on the display, like `tab-width' has.
7086 \f
7087 ;; Define the major mode for lists of completions.
7097 (define-key map [right] 'next-completion)
7099 (define-key map [backtab] 'previous-completion)
7100 (define-key map "q" 'quit-window)
7101 (define-key map "z" 'kill-this-buffer)
7102 map)
7103 "Local map for completion list buffers.")
7105 ;; Completion mode is suitable only for specially formatted data.
7106 (put 'completion-list-mode 'mode-class 'special)
7108 (defvar completion-reference-buffer nil
7109 "Record the buffer that was current when the completion list was requested.
7110 This is a local variable in the completion list buffer.
7111 Initial value is nil to avoid some compiler warnings.")
7113 (defvar completion-no-auto-exit nil
7114 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7115 This also applies to other functions such as `choose-completion'.")
7117 (defvar completion-base-position nil
7118 "Position of the base of the text corresponding to the shown completions.
7119 This variable is used in the *Completions* buffers.
7120 Its value is a list of the form (START END) where START is the place
7121 where the completion should be inserted and END (if non-nil) is the end
7122 of the text to replace. If END is nil, point is used instead.")
7124 (defvar completion-list-insert-choice-function #'completion--replace
7125 "Function to use to insert the text chosen in *Completions*.
7126 Called with three arguments (BEG END TEXT), it should replace the text
7127 between BEG and END with TEXT. Expected to be set buffer-locally
7128 in the *Completions* buffer.")
7130 (defvar completion-base-size nil
7131 "Number of chars before point not involved in completion.
7132 This is a local variable in the completion list buffer.
7133 It refers to the chars in the minibuffer if completing in the
7134 minibuffer, or in `completion-reference-buffer' otherwise.
7135 Only characters in the field at point are included.
7137 If nil, Emacs determines which part of the tail end of the
7138 buffer's text is involved in completion by comparing the text
7139 directly.")
7140 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7142 (defun delete-completion-window ()
7143 "Delete the completion list window.
7144 Go to the window from which completion was requested."
7145 (interactive)
7146 (let ((buf completion-reference-buffer))
7147 (if (one-window-p t)
7148 (if (window-dedicated-p) (delete-frame))
7149 (delete-window (selected-window))
7150 (if (get-buffer-window buf)
7151 (select-window (get-buffer-window buf))))))
7153 (defun previous-completion (n)
7154 "Move to the previous item in the completion list."
7155 (interactive "p")
7156 (next-completion (- n)))
7158 (defun next-completion (n)
7159 "Move to the next item in the completion list.
7160 With prefix argument N, move N items (negative N means move backward)."
7161 (interactive "p")
7162 (let ((beg (point-min)) (end (point-max)))
7163 (while (and (> n 0) (not (eobp)))
7164 ;; If in a completion, move to the end of it.
7165 (when (get-text-property (point) 'mouse-face)
7166 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7167 ;; Move to start of next one.
7168 (unless (get-text-property (point) 'mouse-face)
7169 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7170 (setq n (1- n)))
7171 (while (and (< n 0) (not (bobp)))
7172 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7173 ;; If in a completion, move to the start of it.
7174 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7175 (goto-char (previous-single-property-change
7176 (point) 'mouse-face nil beg)))
7177 ;; Move to end of the previous completion.
7178 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7179 (goto-char (previous-single-property-change
7180 (point) 'mouse-face nil beg)))
7181 ;; Move to the start of that one.
7182 (goto-char (previous-single-property-change
7183 (point) 'mouse-face nil beg))
7184 (setq n (1+ n))))))
7186 (defun choose-completion (&optional event)
7187 "Choose the completion at point.
7188 If EVENT, use EVENT's position to determine the starting position."
7189 (interactive (list last-nonmenu-event))
7190 ;; In case this is run via the mouse, give temporary modes such as
7191 ;; isearch a chance to turn off.
7192 (run-hooks 'mouse-leave-buffer-hook)
7193 (with-current-buffer (window-buffer (posn-window (event-start event)))
7194 (let ((buffer completion-reference-buffer)
7195 (base-size completion-base-size)
7196 (base-position completion-base-position)
7197 (insert-function completion-list-insert-choice-function)
7198 (choice
7199 (save-excursion
7200 (goto-char (posn-point (event-start event)))
7201 (let (beg end)
7202 (cond
7203 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7204 (setq end (point) beg (1+ (point))))
7205 ((and (not (bobp))
7206 (get-text-property (1- (point)) 'mouse-face))
7207 (setq end (1- (point)) beg (point)))
7208 (t (error "No completion here")))
7209 (setq beg (previous-single-property-change beg 'mouse-face))
7210 (setq end (or (next-single-property-change end 'mouse-face)
7211 (point-max)))
7212 (buffer-substring-no-properties beg end)))))
7214 (unless (buffer-live-p buffer)
7215 (error "Destination buffer is dead"))
7216 (quit-window nil (posn-window (event-start event)))
7218 (with-current-buffer buffer
7219 (choose-completion-string
7220 choice buffer
7221 (or base-position
7222 (when base-size
7223 ;; Someone's using old completion code that doesn't know
7224 ;; about base-position yet.
7225 (list (+ base-size (field-beginning))))
7226 ;; If all else fails, just guess.
7227 (list (choose-completion-guess-base-position choice)))
7228 insert-function)))))
7230 ;; Delete the longest partial match for STRING
7231 ;; that can be found before POINT.
7232 (defun choose-completion-guess-base-position (string)
7233 (save-excursion
7234 (let ((opoint (point))
7235 len)
7236 ;; Try moving back by the length of the string.
7237 (goto-char (max (- (point) (length string))
7238 (minibuffer-prompt-end)))
7239 ;; See how far back we were actually able to move. That is the
7240 ;; upper bound on how much we can match and delete.
7241 (setq len (- opoint (point)))
7242 (if completion-ignore-case
7243 (setq string (downcase string)))
7244 (while (and (> len 0)
7245 (let ((tail (buffer-substring (point) opoint)))
7246 (if completion-ignore-case
7247 (setq tail (downcase tail)))
7248 (not (string= tail (substring string 0 len)))))
7249 (setq len (1- len))
7250 (forward-char 1))
7251 (point))))
7253 (defun choose-completion-delete-max-match (string)
7254 (declare (obsolete choose-completion-guess-base-position "23.2"))
7255 (delete-region (choose-completion-guess-base-position string) (point)))
7257 (defvar choose-completion-string-functions nil
7258 "Functions that may override the normal insertion of a completion choice.
7259 These functions are called in order with three arguments:
7260 CHOICE - the string to insert in the buffer,
7261 BUFFER - the buffer in which the choice should be inserted,
7262 BASE-POSITION - where to insert the completion.
7264 If a function in the list returns non-nil, that function is supposed
7265 to have inserted the CHOICE in the BUFFER, and possibly exited
7266 the minibuffer; no further functions will be called.
7268 If all functions in the list return nil, that means to use
7269 the default method of inserting the completion in BUFFER.")
7271 (defun choose-completion-string (choice &optional
7272 buffer base-position insert-function)
7273 "Switch to BUFFER and insert the completion choice CHOICE.
7274 BASE-POSITION says where to insert the completion.
7275 INSERT-FUNCTION says how to insert the completion and falls
7276 back on `completion-list-insert-choice-function' when nil."
7278 ;; If BUFFER is the minibuffer, exit the minibuffer
7279 ;; unless it is reading a file name and CHOICE is a directory,
7280 ;; or completion-no-auto-exit is non-nil.
7282 ;; Some older code may call us passing `base-size' instead of
7283 ;; `base-position'. It's difficult to make any use of `base-size',
7284 ;; so we just ignore it.
7285 (unless (consp base-position)
7286 (message "Obsolete `base-size' passed to choose-completion-string")
7287 (setq base-position nil))
7289 (let* ((buffer (or buffer completion-reference-buffer))
7290 (mini-p (minibufferp buffer)))
7291 ;; If BUFFER is a minibuffer, barf unless it's the currently
7292 ;; active minibuffer.
7293 (if (and mini-p
7294 (not (and (active-minibuffer-window)
7295 (equal buffer
7296 (window-buffer (active-minibuffer-window))))))
7297 (error "Minibuffer is not active for completion")
7298 ;; Set buffer so buffer-local choose-completion-string-functions works.
7299 (set-buffer buffer)
7300 (unless (run-hook-with-args-until-success
7301 'choose-completion-string-functions
7302 ;; The fourth arg used to be `mini-p' but was useless
7303 ;; (since minibufferp can be used on the `buffer' arg)
7304 ;; and indeed unused. The last used to be `base-size', so we
7305 ;; keep it to try and avoid breaking old code.
7306 choice buffer base-position nil)
7307 ;; This remove-text-properties should be unnecessary since `choice'
7308 ;; comes from buffer-substring-no-properties.
7309 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7310 ;; Insert the completion into the buffer where it was requested.
7311 (funcall (or insert-function completion-list-insert-choice-function)
7312 (or (car base-position) (point))
7313 (or (cadr base-position) (point))
7314 choice)
7315 ;; Update point in the window that BUFFER is showing in.
7316 (let ((window (get-buffer-window buffer t)))
7317 (set-window-point window (point)))
7318 ;; If completing for the minibuffer, exit it with this choice.
7319 (and (not completion-no-auto-exit)
7320 (minibufferp buffer)
7321 minibuffer-completion-table
7322 ;; If this is reading a file name, and the file name chosen
7323 ;; is a directory, don't exit the minibuffer.
7324 (let* ((result (buffer-substring (field-beginning) (point)))
7325 (bounds
7326 (completion-boundaries result minibuffer-completion-table
7327 minibuffer-completion-predicate
7328 "")))
7329 (if (eq (car bounds) (length result))
7330 ;; The completion chosen leads to a new set of completions
7331 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7332 (let ((mini (active-minibuffer-window)))
7333 (select-window mini)
7334 (when minibuffer-auto-raise
7335 (raise-frame (window-frame mini))))
7336 (exit-minibuffer))))))))
7338 (define-derived-mode completion-list-mode nil "Completion List"
7339 "Major mode for buffers showing lists of possible completions.
7341 to select the completion near point.
7342 Or click to select one with the mouse.
7345 (set (make-local-variable 'completion-base-size) nil))
7347 (defun completion-list-mode-finish ()
7348 "Finish setup of the completions buffer.
7349 Called from `temp-buffer-show-hook'."
7350 (when (eq major-mode 'completion-list-mode)
7351 (setq buffer-read-only t)))
7353 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7356 ;; Variables and faces used in `completion-setup-function'.
7358 (defcustom completion-show-help t
7359 "Non-nil means show help message in *Completions* buffer."
7360 :type 'boolean
7361 :version "22.1"
7362 :group 'completion)
7364 ;; This function goes in completion-setup-hook, so that it is called
7365 ;; after the text of the completion list buffer is written.
7366 (defun completion-setup-function ()
7367 (let* ((mainbuf (current-buffer))
7368 (base-dir
7369 ;; FIXME: This is a bad hack. We try to set the default-directory
7370 ;; in the *Completions* buffer so that the relative file names
7371 ;; displayed there can be treated as valid file names, independently
7372 ;; from the completion context. But this suffers from many problems:
7373 ;; - It's not clear when the completions are file names. With some
7374 ;; completion tables (e.g. bzr revision specs), the listed
7375 ;; completions can mix file names and other things.
7376 ;; - It doesn't pay attention to possible quoting.
7377 ;; - With fancy completion styles, the code below will not always
7378 ;; find the right base directory.
7379 (if minibuffer-completing-file-name
7380 (file-name-as-directory
7381 (expand-file-name
7382 (buffer-substring (minibuffer-prompt-end)
7383 (- (point) (or completion-base-size 0))))))))
7384 (with-current-buffer standard-output
7385 (let ((base-size completion-base-size) ;Read before killing localvars.
7386 (base-position completion-base-position)
7387 (insert-fun completion-list-insert-choice-function))
7388 (completion-list-mode)
7389 (set (make-local-variable 'completion-base-size) base-size)
7390 (set (make-local-variable 'completion-base-position) base-position)
7391 (set (make-local-variable 'completion-list-insert-choice-function)
7392 insert-fun))
7393 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7394 (if base-dir (setq default-directory base-dir))
7395 ;; Maybe insert help string.
7396 (when completion-show-help
7397 (goto-char (point-min))
7398 (if (display-mouse-p)
7399 (insert (substitute-command-keys
7401 (insert (substitute-command-keys
7405 (add-hook 'completion-setup-hook 'completion-setup-function)
7407 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7408 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7410 (defun switch-to-completions ()
7411 "Select the completion list window."
7412 (interactive)
7413 (let ((window (or (get-buffer-window "*Completions*" 0)
7414 ;; Make sure we have a completions window.
7415 (progn (minibuffer-completion-help)
7416 (get-buffer-window "*Completions*" 0)))))
7417 (when window
7418 (select-window window)
7419 ;; In the new buffer, go to the first completion.
7420 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
7421 (when (bobp)
7422 (next-completion 1)))))
7423 \f
7424 ;;; Support keyboard commands to turn on various modifiers.
7426 ;; These functions -- which are not commands -- each add one modifier
7427 ;; to the following event.
7429 (defun event-apply-alt-modifier (_ignore-prompt)
7432 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
7433 (defun event-apply-super-modifier (_ignore-prompt)
7436 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
7437 (defun event-apply-hyper-modifier (_ignore-prompt)
7440 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
7441 (defun event-apply-shift-modifier (_ignore-prompt)
7444 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
7445 (defun event-apply-control-modifier (_ignore-prompt)
7448 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
7449 (defun event-apply-meta-modifier (_ignore-prompt)
7452 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
7454 (defun event-apply-modifier (event symbol lshiftby prefix)
7455 "Apply a modifier flag to event EVENT.
7456 SYMBOL is the name of this modifier, as a symbol.
7457 LSHIFTBY is the numeric value of this modifier, in keyboard events.
7458 PREFIX is the string that represents this modifier in an event type symbol."
7459 (if (numberp event)
7460 (cond ((eq symbol 'control)
7461 (if (and (<= (downcase event) ?z)
7462 (>= (downcase event) ?a))
7463 (- (downcase event) ?a -1)
7464 (if (and (<= (downcase event) ?Z)
7465 (>= (downcase event) ?A))
7466 (- (downcase event) ?A -1)
7467 (logior (lsh 1 lshiftby) event))))
7468 ((eq symbol 'shift)
7469 (if (and (<= (downcase event) ?z)
7470 (>= (downcase event) ?a))
7471 (upcase event)
7472 (logior (lsh 1 lshiftby) event)))
7473 (t
7474 (logior (lsh 1 lshiftby) event)))
7475 (if (memq symbol (event-modifiers event))
7476 event
7477 (let ((event-type (if (symbolp event) event (car event))))
7478 (setq event-type (intern (concat prefix (symbol-name event-type))))
7479 (if (symbolp event)
7480 event-type
7481 (cons event-type (cdr event)))))))
7483 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
7484 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
7485 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
7486 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
7487 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
7488 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
7489 \f
7490 ;;;; Keypad support.
7492 ;; Make the keypad keys act like ordinary typing keys. If people add
7493 ;; bindings for the function key symbols, then those bindings will
7494 ;; override these, so this shouldn't interfere with any existing
7495 ;; bindings.
7497 ;; Also tell read-char how to handle these keys.
7498 (mapc
7499 (lambda (keypad-normal)
7500 (let ((keypad (nth 0 keypad-normal))
7501 (normal (nth 1 keypad-normal)))
7502 (put keypad 'ascii-character normal)
7503 (define-key function-key-map (vector keypad) (vector normal))))
7504 ;; See also kp-keys bound in bindings.el.
7505 '((kp-space ?\s)
7508 (kp-separator ?,)
7509 (kp-equal ?=)
7510 ;; Do the same for various keys that are represented as symbols under
7511 ;; GUIs but naturally correspond to characters.
7512 (backspace 127)
7513 (delete 127)
7516 (clear ?\C-l)
7517 (return ?\C-m)
7518 (escape ?\e)
7519 ))
7520 \f
7521 ;;;;
7522 ;;;; forking a twin copy of a buffer.
7523 ;;;;
7525 (defvar clone-buffer-hook nil
7526 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7528 (defvar clone-indirect-buffer-hook nil
7529 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7531 (defun clone-process (process &optional newname)
7532 "Create a twin copy of PROCESS.
7533 If NEWNAME is nil, it defaults to PROCESS' name;
7534 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7535 If PROCESS is associated with a buffer, the new process will be associated
7536 with the current buffer instead.
7537 Returns nil if PROCESS has already terminated."
7538 (setq newname (or newname (process-name process)))
7540 (setq newname (substring newname 0 (match-beginning 0))))
7541 (when (memq (process-status process) '(run stop open))
7542 (let* ((process-connection-type (process-tty-name process))
7543 (new-process
7544 (if (memq (process-status process) '(open))
7545 (let ((args (process-contact process t)))
7546 (setq args (plist-put args :name newname))
7547 (setq args (plist-put args :buffer
7548 (if (process-buffer process)
7549 (current-buffer))))
7550 (apply 'make-network-process args))
7551 (apply 'start-process newname
7552 (if (process-buffer process) (current-buffer))
7553 (process-command process)))))
7554 (set-process-query-on-exit-flag
7555 new-process (process-query-on-exit-flag process))
7556 (set-process-inherit-coding-system-flag
7557 new-process (process-inherit-coding-system-flag process))
7558 (set-process-filter new-process (process-filter process))
7559 (set-process-sentinel new-process (process-sentinel process))
7560 (set-process-plist new-process (copy-sequence (process-plist process)))
7561 new-process)))
7563 ;; things to maybe add (currently partly covered by `funcall mode'):
7564 ;; - syntax-table
7565 ;; - overlays
7566 (defun clone-buffer (&optional newname display-flag)
7567 "Create and return a twin copy of the current buffer.
7568 Unlike an indirect buffer, the new buffer can be edited
7569 independently of the old one (if it is not read-only).
7570 NEWNAME is the name of the new buffer. It may be modified by
7571 adding or incrementing <N> at the end as necessary to create a
7572 unique buffer name. If nil, it defaults to the name of the
7573 current buffer, with the proper suffix. If DISPLAY-FLAG is
7574 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7575 clone a file-visiting buffer, or a buffer whose major mode symbol
7576 has a non-nil `no-clone' property, results in an error.
7578 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7579 current buffer with appropriate suffix. However, if a prefix
7580 argument is given, then the command prompts for NEWNAME in the
7581 minibuffer.
7583 This runs the normal hook `clone-buffer-hook' in the new buffer
7584 after it has been set up properly in other respects."
7585 (interactive
7586 (progn
7587 (if buffer-file-name
7588 (error "Cannot clone a file-visiting buffer"))
7589 (if (get major-mode 'no-clone)
7590 (error "Cannot clone a buffer in %s mode" mode-name))
7591 (list (if current-prefix-arg
7592 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7593 t)))
7594 (if buffer-file-name
7595 (error "Cannot clone a file-visiting buffer"))
7596 (if (get major-mode 'no-clone)
7597 (error "Cannot clone a buffer in %s mode" mode-name))
7598 (setq newname (or newname (buffer-name)))
7600 (setq newname (substring newname 0 (match-beginning 0))))
7601 (let ((buf (current-buffer))
7602 (ptmin (point-min))
7603 (ptmax (point-max))
7604 (pt (point))
7605 (mk (if mark-active (mark t)))
7606 (modified (buffer-modified-p))
7607 (mode major-mode)
7608 (lvars (buffer-local-variables))
7609 (process (get-buffer-process (current-buffer)))
7610 (new (generate-new-buffer (or newname (buffer-name)))))
7611 (save-restriction
7612 (widen)
7613 (with-current-buffer new
7614 (insert-buffer-substring buf)))
7615 (with-current-buffer new
7616 (narrow-to-region ptmin ptmax)
7617 (goto-char pt)
7618 (if mk (set-mark mk))
7619 (set-buffer-modified-p modified)
7621 ;; Clone the old buffer's process, if any.
7622 (when process (clone-process process))
7624 ;; Now set up the major mode.
7625 (funcall mode)
7627 ;; Set up other local variables.
7628 (mapc (lambda (v)
7629 (condition-case () ;in case var is read-only
7630 (if (symbolp v)
7631 (makunbound v)
7632 (set (make-local-variable (car v)) (cdr v)))
7633 (error nil)))
7634 lvars)
7636 ;; Run any hooks (typically set up by the major mode
7637 ;; for cloning to work properly).
7638 (run-hooks 'clone-buffer-hook))
7639 (if display-flag
7640 ;; Presumably the current buffer is shown in the selected frame, so
7641 ;; we want to display the clone elsewhere.
7642 (let ((same-window-regexps nil)
7643 (same-window-buffer-names))
7644 (pop-to-buffer new)))
7645 new))
7648 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7649 "Create an indirect buffer that is a twin copy of the current buffer.
7651 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7652 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7653 or if not called with a prefix arg, NEWNAME defaults to the current
7654 buffer's name. The name is modified by adding a `<N>' suffix to it
7655 or by incrementing the N in an existing suffix. Trying to clone a
7656 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7657 property results in an error.
7659 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7660 This is always done when called interactively.
7662 Optional third arg NORECORD non-nil means do not put this buffer at the
7663 front of the list of recently selected ones.
7665 Returns the newly created indirect buffer."
7666 (interactive
7667 (progn
7668 (if (get major-mode 'no-clone-indirect)
7669 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7670 (list (if current-prefix-arg
7671 (read-buffer "Name of indirect buffer: " (current-buffer)))
7672 t)))
7673 (if (get major-mode 'no-clone-indirect)
7674 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7675 (setq newname (or newname (buffer-name)))
7677 (setq newname (substring newname 0 (match-beginning 0))))
7678 (let* ((name (generate-new-buffer-name newname))
7679 (buffer (make-indirect-buffer (current-buffer) name t)))
7680 (with-current-buffer buffer
7681 (run-hooks 'clone-indirect-buffer-hook))
7682 (when display-flag
7683 (pop-to-buffer buffer norecord))
7684 buffer))
7687 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7688 "Like `clone-indirect-buffer' but display in another window."
7689 (interactive
7690 (progn
7691 (if (get major-mode 'no-clone-indirect)
7692 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7693 (list (if current-prefix-arg
7694 (read-buffer "Name of indirect buffer: " (current-buffer)))
7695 t)))
7696 (let ((pop-up-windows t))
7697 (clone-indirect-buffer newname display-flag norecord)))
7699 \f
7700 ;;; Handling of Backspace and Delete keys.
7702 (defcustom normal-erase-is-backspace 'maybe
7703 "Set the default behavior of the Delete and Backspace keys.
7705 If set to t, Delete key deletes forward and Backspace key deletes
7706 backward.
7708 If set to nil, both Delete and Backspace keys delete backward.
7710 If set to 'maybe (which is the default), Emacs automatically
7711 selects a behavior. On window systems, the behavior depends on
7712 the keyboard used. If the keyboard has both a Backspace key and
7713 a Delete key, and both are mapped to their usual meanings, the
7714 option's default value is set to t, so that Backspace can be used
7715 to delete backward, and Delete can be used to delete forward.
7717 If not running under a window system, customizing this option
7718 accomplishes a similar effect by mapping C-h, which is usually
7719 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7720 via `keyboard-translate'. The former functionality of C-h is
7721 available on the F1 key. You should probably not use this
7722 setting if you don't have both Backspace, Delete and F1 keys.
7724 Setting this variable with setq doesn't take effect. Programmatically,
7725 call `normal-erase-is-backspace-mode' (which see) instead."
7726 :type '(choice (const :tag "Off" nil)
7727 (const :tag "Maybe" maybe)
7728 (other :tag "On" t))
7729 :group 'editing-basics
7730 :version "21.1"
7731 :set (lambda (symbol value)
7732 ;; The fboundp is because of a problem with :set when
7733 ;; dumping Emacs. It doesn't really matter.
7734 (if (fboundp 'normal-erase-is-backspace-mode)
7735 (normal-erase-is-backspace-mode (or value 0))
7736 (set-default symbol value))))
7738 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7739 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7740 (unless frame (setq frame (selected-frame)))
7741 (with-selected-frame frame
7742 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7743 (normal-erase-is-backspace-mode
7744 (if (if (eq normal-erase-is-backspace 'maybe)
7745 (and (not noninteractive)
7746 (or (memq system-type '(ms-dos windows-nt))
7747 (memq window-system '(w32 ns))
7748 (and (memq window-system '(x))
7749 (fboundp 'x-backspace-delete-keys-p)
7750 (x-backspace-delete-keys-p))
7751 ;; If the terminal Emacs is running on has erase char
7752 ;; set to ^H, use the Backspace key for deleting
7753 ;; backward, and the Delete key for deleting forward.
7754 (and (null window-system)
7755 (eq tty-erase-char ?\^H))))
7756 normal-erase-is-backspace)
7757 1 0)))))
7759 (define-minor-mode normal-erase-is-backspace-mode
7760 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7761 With a prefix argument ARG, enable this feature if ARG is
7762 positive, and disable it otherwise. If called from Lisp, enable
7763 the mode if ARG is omitted or nil.
7765 On window systems, when this mode is on, Delete is mapped to C-d
7766 and Backspace is mapped to DEL; when this mode is off, both
7767 Delete and Backspace are mapped to DEL. (The remapping goes via
7768 `local-function-key-map', so binding Delete or Backspace in the
7769 global or local keymap will override that.)
7771 In addition, on window systems, the bindings of C-Delete, M-Delete,
7772 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7773 the global keymap in accordance with the functionality of Delete and
7774 Backspace. For example, if Delete is remapped to C-d, which deletes
7775 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7776 to DEL, which deletes backward, C-Delete is bound to
7777 `backward-kill-word'.
7779 If not running on a window system, a similar effect is accomplished by
7780 remapping C-h (normally produced by the Backspace key) and DEL via
7781 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7782 to C-d; if it's off, the keys are not remapped.
7784 When not running on a window system, and this mode is turned on, the
7785 former functionality of C-h is available on the F1 key. You should
7786 probably not turn on this mode on a text-only terminal if you don't
7787 have both Backspace, Delete and F1 keys.
7789 See also `normal-erase-is-backspace'."
7790 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7791 . (lambda (v)
7792 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7793 (if v 1 0))))
7794 (let ((enabled (eq 1 (terminal-parameter
7795 nil 'normal-erase-is-backspace))))
7797 (cond ((or (memq window-system '(x w32 ns pc))
7798 (memq system-type '(ms-dos windows-nt)))
7799 (let ((bindings
7800 `(([M-delete] [M-backspace])
7801 ([C-M-delete] [C-M-backspace])
7802 ([?\e C-delete] [?\e C-backspace]))))
7804 (if enabled
7805 (progn
7806 (define-key local-function-key-map [delete] [deletechar])
7807 (define-key local-function-key-map [kp-delete] [deletechar])
7808 (define-key local-function-key-map [backspace] [?\C-?])
7809 (dolist (b bindings)
7810 ;; Not sure if input-decode-map is really right, but
7811 ;; keyboard-translate-table (used below) only works
7812 ;; for integer events, and key-translation-table is
7813 ;; global (like the global-map, used earlier).
7814 (define-key input-decode-map (car b) nil)
7815 (define-key input-decode-map (cadr b) nil)))
7816 (define-key local-function-key-map [delete] [?\C-?])
7817 (define-key local-function-key-map [kp-delete] [?\C-?])
7818 (define-key local-function-key-map [backspace] [?\C-?])
7819 (dolist (b bindings)
7820 (define-key input-decode-map (car b) (cadr b))
7821 (define-key input-decode-map (cadr b) (car b))))))
7822 (t
7823 (if enabled
7824 (progn
7825 (keyboard-translate ?\C-h ?\C-?)
7826 (keyboard-translate ?\C-? ?\C-d))
7827 (keyboard-translate ?\C-h ?\C-h)
7828 (keyboard-translate ?\C-? ?\C-?))))
7830 (if (called-interactively-p 'interactive)
7831 (message "Delete key deletes %s"
7832 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7833 "forward" "backward")))))
7834 \f
7835 (defvar vis-mode-saved-buffer-invisibility-spec nil
7836 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7838 (define-minor-mode read-only-mode
7839 "Change whether the current buffer is read-only.
7840 With prefix argument ARG, make the buffer read-only if ARG is
7841 positive, otherwise make it writable. If buffer is read-only
7842 and `view-read-only' is non-nil, enter view mode.
7844 Do not call this from a Lisp program unless you really intend to
7846 possibly enabling or disabling View mode. Also, note that this
7847 command works by setting the variable `buffer-read-only', which
7848 does not affect read-only regions caused by text properties. To
7849 ignore read-only status in a Lisp program (whether due to text
7850 properties or buffer state), bind `inhibit-read-only' temporarily
7851 to a non-nil value."
7852 :variable buffer-read-only
7853 (cond
7854 ((and (not buffer-read-only) view-mode)
7855 (View-exit-and-edit)
7856 (make-local-variable 'view-read-only)
7857 (setq view-read-only t)) ; Must leave view mode.
7858 ((and buffer-read-only view-read-only
7859 ;; If view-mode is already active, `view-mode-enter' is a nop.
7860 (not view-mode)
7861 (not (eq (get major-mode 'mode-class) 'special)))
7862 (view-mode-enter))))
7864 (define-minor-mode visible-mode
7865 "Toggle making all invisible text temporarily visible (Visible mode).
7866 With a prefix argument ARG, enable Visible mode if ARG is
7867 positive, and disable it otherwise. If called from Lisp, enable
7868 the mode if ARG is omitted or nil.
7870 This mode works by saving the value of `buffer-invisibility-spec'
7871 and setting it to nil."
7872 :lighter " Vis"
7873 :group 'editing-basics
7874 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7875 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7876 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7877 (when visible-mode
7878 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7879 buffer-invisibility-spec)
7880 (setq buffer-invisibility-spec nil)))
7881 \f
7882 (defvar messages-buffer-mode-map
7883 (let ((map (make-sparse-keymap)))
7884 (set-keymap-parent map special-mode-map)
7885 (define-key map "g" nil) ; nothing to revert
7886 map))
7888 (define-derived-mode messages-buffer-mode special-mode "Messages"
7891 (defun messages-buffer ()
7893 If it does not exist, create and it switch it to `messages-buffer-mode'."
7894 (or (get-buffer "*Messages*")
7895 (with-current-buffer (get-buffer-create "*Messages*")
7896 (messages-buffer-mode)
7897 (current-buffer))))
7899 \f
7900 ;; Minibuffer prompt stuff.
7902 ;;(defun minibuffer-prompt-modification (start end)
7903 ;; (error "You cannot modify the prompt"))
7904 ;;
7905 ;;
7906 ;;(defun minibuffer-prompt-insertion (start end)
7907 ;; (let ((inhibit-modification-hooks t))
7908 ;; (delete-region start end)
7909 ;; ;; Discard undo information for the text insertion itself
7910 ;; ;; and for the text deletion.above.
7911 ;; (when (consp buffer-undo-list)
7912 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7913 ;; (message "You cannot modify the prompt")))
7914 ;;
7915 ;;
7916 ;;(setq minibuffer-prompt-properties
7917 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7918 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7920 \f
7921 ;;;; Problematic external packages.
7923 ;; rms says this should be done by specifying symbols that define
7924 ;; versions together with bad values. This is therefore not as
7925 ;; flexible as it could be. See the thread:
7926 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7927 (defconst bad-packages-alist
7928 ;; Not sure exactly which semantic versions have problems.
7929 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7931 "The version of `semantic' loaded does not work in Emacs 22.
7932 It can cause constant high CPU load.
7933 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7934 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7935 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7936 ;; provided the `CUA-mode' feature. Since this is no longer true,
7937 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7938 (CUA-mode t nil
7939 "CUA-mode is now part of the standard GNU Emacs distribution,
7940 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7942 You have loaded an older version of CUA-mode which does not work
7943 correctly with this version of Emacs. You should remove the old
7944 version and use the one distributed with Emacs."))
7945 "Alist of packages known to cause problems in this version of Emacs.
7946 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7947 PACKAGE is either a regular expression to match file names, or a
7948 symbol (a feature name), like for `with-eval-after-load'.
7949 SYMBOL is either the name of a string variable, or `t'. Upon
7950 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7951 warning using STRING as the message.")
7953 (defun bad-package-check (package)
7954 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7955 (condition-case nil
7956 (let* ((list (assoc package bad-packages-alist))
7957 (symbol (nth 1 list)))
7958 (and list
7959 (boundp symbol)
7960 (or (eq symbol t)
7961 (and (stringp (setq symbol (eval symbol)))
7962 (string-match-p (nth 2 list) symbol)))
7963 (display-warning package (nth 3 list) :warning)))
7964 (error nil)))
7966 (dolist (elem bad-packages-alist)
7967 (let ((pkg (car elem)))
7968 (with-eval-after-load pkg
7969 (bad-package-check pkg))))
7971 \f
7972 ;;; Generic dispatcher commands
7974 ;; Macro `define-alternatives' is used to create generic commands.
7975 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
7976 ;; that can have different alternative implementations where choosing
7977 ;; among them is exclusively a matter of user preference.
7979 ;; (define-alternatives COMMAND) creates a new interactive command
7980 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
7981 ;; Typically, the user will not need to customize this variable; packages
7982 ;; wanting to add alternative implementations should use
7983 ;;
7984 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
7986 (defmacro define-alternatives (command &rest customizations)
7987 "Define the new command `COMMAND'.
7989 The argument `COMMAND' should be a symbol.
7991 Running `M-x COMMAND RET' for the first time prompts for which
7992 alternative to use and records the selected command as a custom
7993 variable.
7995 Running `C-u M-x COMMAND RET' prompts again for an alternative
7996 and overwrites the previous choice.
7998 The variable `COMMAND-alternatives' contains an alist with
7999 alternative implementations of COMMAND. `define-alternatives'
8000 does not have any effect until this variable is set.
8002 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8003 `defcustom' keywords and values to add to the declaration of
8004 `COMMAND-alternatives' (typically :group and :version)."
8005 (let* ((command-name (symbol-name command))
8006 (varalt-name (concat command-name "-alternatives"))
8007 (varalt-sym (intern varalt-name))
8008 (varimp-sym (intern (concat command-name "--implementation"))))
8009 `(progn
8011 (defcustom ,varalt-sym nil
8012 ,(format "Alist of alternative implementations for the `%s' command.
8014 Each entry must be a pair (ALTNAME . ALTFUN), where:
8015 ALTNAME - The name shown at user to describe the alternative implementation.
8016 ALTFUN - The function called to implement this alternative."
8017 command-name)
8018 :type '(alist :key-type string :value-type function)
8019 ,@customizations)
8021 (put ',varalt-sym 'definition-name ',command)
8022 (defvar ,varimp-sym nil "Internal use only.")
8024 (defun ,command (&optional arg)
8025 ,(format "Run generic command `%s'.
8026 If used for the first time, or with interactive ARG, ask the user which
8027 implementation to use for `%s'. The variable `%s'
8028 contains the list of implementations currently supported for this command."
8029 command-name command-name varalt-name)
8030 (interactive "P")
8031 (when (or arg (null ,varimp-sym))
8032 (let ((val (completing-read
8033 ,(format "Select implementation for command `%s': "
8034 command-name)
8035 ,varalt-sym nil t)))
8036 (unless (string-equal val "")
8037 (when (null ,varimp-sym)
8038 (message
8039 "Use `C-u M-x %s RET' to select another implementation"
8040 ,command-name)
8041 (sit-for 3))
8042 (customize-save-variable ',varimp-sym
8043 (cdr (assoc-string val ,varalt-sym))))))
8044 (if ,varimp-sym
8045 (call-interactively ,varimp-sym)
8046 (message ,(format "No implementation selected for command `%s'"
8047 command-name)))))))
8049 \f
8051 (provide 'simple)
8053 ;;; simple.el ends here