| blob | 5da662c21248498de38ad065d53b67d489a0b19e |
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:
34 ;;; From compile.el
39 "Idle time delay before updating various things on the screen.
40 Various Emacs features that update auxiliary information when point moves
41 wait this many seconds after Emacs becomes idle before doing an update."
47 "Killing and yanking commands."
51 "Highlight (un)matching of parens and expressions."
53 \f
54 ;;; next-error support framework
57 "`next-error' support framework."
63 "Face used to highlight next error locus."
68 "Highlighting of locations in selected source buffers.
69 If a number, highlight the locus in `next-error' face for the given time
70 in seconds, or until the next command is executed.
71 If t, highlight the locus until the next command is executed, or until
72 some other locus replaces it.
73 If nil, don't highlight the locus in the source buffer.
74 If `fringe-arrow', indicate the locus by the fringe arrow
75 indefinitely until some other locus replaces it."
84 "Highlighting of locations in `next-error-no-select'.
85 If number, highlight the locus in `next-error' face for given time in seconds.
86 If t, highlight the locus indefinitely until some other locus replaces it.
87 If nil, don't highlight the locus in the source buffer.
88 If `fringe-arrow', indicate the locus by the fringe arrow
89 indefinitely until some other locus replaces it."
98 "Display the line in the visited source file recentered as specified.
99 If non-nil, the value is passed directly to `recenter'."
107 "List of hook functions run by `next-error' after visiting source file."
118 "The most recent `next-error' buffer.
119 A buffer becomes most recent when its compilation, grep, or
124 "Function to use to find the next error in the current buffer.
125 The function is called with 2 parameters:
126 ARG is an integer specifying by how many errors to move.
127 RESET is a boolean which, if non-nil, says to go back to the beginning
128 of the errors before moving.
129 Major modes providing compile-like functionality should set this variable
130 to indicate to `next-error' that this is a candidate buffer and how
135 "Function to use to move to an error locus.
136 It takes two arguments, a buffer position in the error buffer
137 and a buffer position in the error locus buffer.
138 The buffer for the error locus should already be current.
143 &optional avoid-current
144 extra-test-inclusive
145 extra-test-exclusive)
146 "Test if BUFFER is a `next-error' capable buffer.
148 If AVOID-CURRENT is non-nil, treat the current buffer
149 as an absolute last resort only.
151 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
152 that normally would not qualify. If it returns t, the buffer
153 in question is treated as usable.
155 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
156 that would normally be considered usable. If it returns nil,
157 that buffer is rejected."
162 ;; Optionally reject some buffers.
165 t)
166 ;; Optionally accept some other buffers.
171 extra-test-inclusive
172 extra-test-exclusive)
173 "Return a `next-error' capable buffer.
175 If AVOID-CURRENT is non-nil, treat the current buffer
176 as an absolute last resort only.
178 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
179 that normally would not qualify. If it returns t, the buffer
180 in question is treated as usable.
182 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
183 that would normally be considered usable. If it returns nil,
184 that buffer is rejected."
186 ;; 1. If one window on the selected frame displays such buffer, return it.
192 avoid-current
193 extra-test-inclusive extra-test-exclusive)
198 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
201 extra-test-inclusive extra-test-exclusive))
202 next-error-last-buffer)
203 ;; 3. If the current buffer is acceptable, choose it.
205 extra-test-inclusive extra-test-exclusive)
207 ;; 4. Look for any acceptable buffer.
212 extra-test-inclusive extra-test-exclusive)))
215 ;; 5. Use the current buffer as a last resort if it qualifies,
216 ;; even despite AVOID-CURRENT.
219 extra-test-inclusive extra-test-exclusive)
223 ;; 6. Give up.
227 "Visit next `next-error' message and corresponding source code.
229 If all the error messages parsed so far have been processed already,
230 the message buffer is checked for new ones.
232 A prefix ARG specifies how many error messages to move;
233 negative means move back to previous error messages.
235 and start at the first error.
237 The RESET argument specifies that we should restart from the beginning.
240 compilation, grep, or occur buffer. It can also operate on any
242 more generally, on any buffer in Compilation mode or with
243 Compilation Minor mode enabled, or any buffer in which
244 `next-error-function' is bound to an appropriate function.
245 To specify use of a particular buffer for error messages, type
247 in the current frame.
250 runs `next-error-hook' with `run-hooks', and stays with that buffer
251 until you use it in some other buffer which uses Compilation mode
252 or Compilation Minor mode.
254 To control which errors are matched, customize the variable
255 `compilation-error-regexp-alist'."
259 ;; we know here that next-error-function is a valid symbol we can funcall
267 "Visit the source code corresponding to the `next-error' message at point."
269 ;; we know here that next-error-function is a valid symbol we can funcall
280 "Visit previous `next-error' message and corresponding source code.
282 Prefix arg N says how many error messages to move backwards (or
283 forwards, if negative).
290 "Restart at the first error.
291 Visit corresponding source code.
292 With prefix arg N, visit the source code of the Nth error.
298 "Move point to the next error in the `next-error' buffer and highlight match.
299 Prefix arg N says how many error messages to move forwards (or
300 backwards, if negative).
302 select the source buffer."
309 "Move point to the previous error in the `next-error' buffer and highlight match.
310 Prefix arg N says how many error messages to move backwards (or
311 forwards, if negative).
313 select the source buffer."
317 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
321 "Minor mode for compilation, occur and diff modes.
322 With a prefix argument ARG, enable mode if ARG is positive, and
323 disable it otherwise. If called from Lisp, enable mode if ARG is
324 omitted or nil.
325 When turned on, cursor motion in the compilation, grep, occur or diff
326 buffer causes automatic display of the corresponding source code location."
333 ;; Used as a `post-command-hook' by `next-error-follow-mode'
334 ;; for the *Compilation* *grep* and *Occur* buffers.
344 \f
345 ;;;
348 "Major mode not specialized for anything in particular.
349 Other major modes are defined by comparison with this one."
354 ;; Special major modes to view specially formatted data rather than files.
368 map))
372 "Parent major mode from which special major modes should inherit."
375 ;; Making and deleting lines.
381 "Insert a newline, and move to left margin of the new line if it's blank.
382 If option `use-hard-newlines' is non-nil, the newline is marked with the
383 text-property `hard'.
384 With ARG, insert that many newlines.
386 If `electric-indent-mode' is enabled, this indents the final new line
387 that it adds, and reindents the preceding line. To just insert
390 Calls `auto-fill-function' if the current column number is greater
391 than the value of `fill-column' and ARG is nil.
392 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
395 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
396 ;; Set last-command-event to tell self-insert what to insert.
400 ;; Don't auto-fill if we have a numeric argument.
403 ;; Do the rest in post-self-insert-hook, because we want to do it
404 ;; *before* other functions on that hook.
406 ;; Mark the newline(s) `hard'.
410 ;; If the newline leaves the previous line blank, and we
411 ;; have a left margin, delete that from the blank line.
419 ;; Indent the line after the newline, except in one case:
420 ;; when we added the newline at the beginning of a line which
421 ;; starts a page.
425 ;; FIXME: For non-interactive uses, many calls actually just want
426 ;; (insert "\n"), so maybe we should do just that, so as to avoid
427 ;; the risk of filling or running abbrevs unexpectedly.
434 ;; We first used let-binding to protect the hook, but that was naive
435 ;; since add-hook affects the symbol-default value of the variable,
436 ;; whereas the let-binding might only protect the buffer-local value.
438 nil)
443 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
449 "Insert a newline and leave point before it.
450 If there is a fill prefix and/or a `left-margin', insert them
451 on the new line if the line would have been blank.
452 With arg N, insert N newlines."
457 ;; Don't expand an abbrev before point.
471 "Split current line, moving portion beyond point vertically down.
472 If the current line starts with `fill-prefix', insert it on the new
473 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
475 When called from Lisp code, ARG may be a prefix string to copy."
480 ;; What prefix should we check for (nil means don't).
484 ;; Does this line start with it?
495 "Join this line to previous and fix up whitespace at join.
496 If there is a fill prefix, delete it from the beginning of this line.
497 With argument, join this line to following line."
504 ;; If the second line started with the fill prefix,
505 ;; delete the prefix.
517 "On blank line, delete all surrounding blank lines, leaving just one.
518 On isolated blank line, delete that one.
519 On nonblank line, delete any immediately following blank lines."
525 ;; Set singleblank if there is just one blank line here.
532 ;; Delete preceding blank lines, and this one too if it's the only one.
541 ;; Delete following blank lines, unless the current line is blank
542 ;; and there are no following blank lines.
551 ;; Handle the special case where point is followed by newline and eob.
552 ;; Delete the line, leaving point at eob.
558 Trailing lines are deleted only if `delete-trailing-whitespace'
559 is called on the entire buffer (rather than an active region)."
565 "Delete trailing whitespace between START and END.
566 If called interactively, START and END are the start/end of the
567 region if the mark is active, or of the buffer's accessible
568 portion if the mark is inactive.
570 This command deletes whitespace characters after the last
571 non-whitespace character in each line between START and END. It
572 does not consider formfeed characters to be whitespace.
574 If this command acts on the entire buffer (i.e. if called
575 interactively with the mark inactive, or called from Lisp with
576 END nil), it also deletes all trailing lines at the end of the
577 buffer if the variable `delete-trailing-lines' is non-nil."
590 ;; Don't delete formfeeds, even if they are considered whitespace.
594 ;; Delete trailing empty lines.
597 delete-trailing-lines
598 ;; Really the end of buffer.
603 ;; Return nil for the benefit of `write-file-functions'.
604 nil)
607 "Insert a newline, then indent according to major mode.
608 Indentation is done using the value of `indent-line-function'.
609 In programming language modes, this is the same as TAB.
610 In some text modes, where TAB inserts a tab, this command indents to the
611 column specified by the function `current-left-margin'."
618 "Reindent current line, insert newline, then indent the new line.
619 Indentation of both lines is done according to the current major mode,
620 which means calling the current value of `indent-line-function'.
621 In programming language modes, this is the same as TAB.
622 In some text modes, where TAB inserts a tab, this indents to the
623 column specified by the function `current-left-margin'."
626 ;; Be careful to insert the newline before indenting the line.
627 ;; Otherwise, the indentation might be wrong.
631 ;; We are at EOL before the call to indent-according-to-mode, and
632 ;; after it we usually are as well, but not always. We tried to
633 ;; address it with `save-excursion' but that uses a normal marker
634 ;; whereas we need `move after insertion', so we do the save/restore
635 ;; by hand.
639 ;; Remove the trailing white-space after indentation because
640 ;; indentation may introduce the whitespace.
646 Legitimate radix values are 8, 10 and 16."
651 "Like `read-char', but do not allow quitting.
652 Also, if the first character read is an octal digit,
653 we read any number of octal digits and return the
654 specified character code. Any nondigit terminates the sequence.
655 If the terminator is RET, it is discarded;
656 any other terminator is used itself as input.
658 The optional argument PROMPT specifies a string to use to prompt the user.
659 The variable `read-quoted-char-radix' controls which radix to use
660 for numeric input."
663 help-event-list)))
667 ;; Don't let C-h or other help chars get the help
668 ;; message--only help function keys. See bug#16617.
672 "Type the special character you want to use,
673 or the octal character code.
674 RET terminates the character code and is discarded;
684 done t))
686 ;; Turn a meta-character into a character with the 0200 bit set.
688 done t))
704 done t))
706 done t)))
708 code))
711 "Read next input character and insert it.
712 This is useful for inserting control characters.
713 With argument, insert ARG copies of the character.
715 If the first character you type after this command is an octal digit,
716 you should type a sequence of octal digits which specify a character code.
717 Any nondigit terminates the sequence. If the terminator is a RET,
718 it is discarded; any other terminator is used itself as input.
719 The variable `read-quoted-char-radix' specifies the radix for this feature;
720 set it to 10 or 16 to use decimal or hex instead of octal.
722 In overwrite mode, this function inserts the character anyway, and
723 does not handle octal digits specially. This means that if you use
724 overwrite as your normal editing mode, you can use this function to
725 insert characters when necessary.
727 In binary overwrite mode, this function does overwrite, and octal
728 digits are interpreted as a character code. This is intended to be
729 useful for editing binary files."
732 ;; Avoid "obsolete" warnings for translation-table-for-input.
739 ;; This used to assume character codes 0240 - 0377 stand for
740 ;; characters in some single-byte character set, and converted them
741 ;; to Emacs characters. But in 23.1 this feature is deprecated
742 ;; in favor of inserting the corresponding Unicode characters.
743 ;; (if (and enable-multibyte-characters
744 ;; (>= char ?\240)
745 ;; (<= char ?\377))
746 ;; (setq char (unibyte-char-to-multibyte char)))
758 "Move forward ARG lines and position at first nonblank character."
764 "Move backward ARG lines and position at first nonblank character."
770 "Move point to the first non-whitespace character on this line."
774 ;; Move back over chars that have whitespace syntax but have the p flag.
778 "Fixup white space between objects around point.
779 Leave one space or none, according to the context."
786 nil
790 "Delete all spaces and tabs around point.
791 If BACKWARD-ONLY is non-nil, only delete them before point."
796 orig-pos
805 "Delete all spaces and tabs around point, leaving one space (or N spaces).
806 If N is negative, delete newlines as well, leaving -N spaces.
807 See also `cycle-spacing'."
812 "Store context used in consecutive calls to `cycle-spacing' command.
813 The first time `cycle-spacing' runs, it saves in this variable:
814 its N argument, the original point position, and the original spacing
818 "Manipulate whitespace around point in a smart way.
819 In interactive use, this function behaves differently in successive
820 consecutive calls.
822 The first call in a sequence acts like `just-one-space'.
823 It deletes all spaces and tabs around point, leaving one space
824 \(or N spaces). N is the prefix argument. If N is negative,
825 it deletes newlines as well, leaving -N spaces.
826 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
828 The second call in a sequence deletes all spaces.
830 The third call in a sequence restores the original whitespace (and point).
832 If MODE is `single-shot', it only performs the first step in the sequence.
833 If MODE is `fast' and the first step would not result in any change
834 \(i.e., there are exactly (abs N) spaces around point),
835 the function goes straight to the second step.
837 Repeatedly calling the function with different values of N starts a
838 new sequence each time."
846 ;; Command run for the first time, single-shot mode or different argument
858 ;; Special handling for case where there was no space at all.
861 ;; If this run causes no change in buffer content, delete all spaces,
862 ;; otherwise delete all excess spaces.
867 ;; Command run for the second time.
871 ;; Command run for the third time.
876 \f
878 "Move point to the beginning of the buffer.
879 With numeric arg N, put point N/10 of the way from the beginning.
880 If the buffer is narrowed, this command uses the beginning of the
881 accessible part of the buffer.
883 If Transient Mark mode is disabled, leave mark at previous
894 ;; Avoid overflow for large buffer sizes!
902 "Move point to the end of the buffer.
903 With numeric arg N, put point N/10 of the way from the end.
904 If the buffer is narrowed, this command uses the end of the
905 accessible part of the buffer.
907 If Transient Mark mode is disabled, leave mark at previous
916 ;; Avoid overflow for large buffer sizes!
921 ;; If we went to a place in the middle of the buffer,
922 ;; adjust it to the beginning of a line.
926 ;; If the end of the buffer is not already on the screen,
927 ;; then scroll specially to put it near, but not at, the bottom.
932 "Whether single-char deletion commands delete an active region.
933 This has an effect only if Transient Mark mode is enabled, and
934 affects `delete-forward-char' and `delete-backward-char', though
935 not `delete-char'.
937 If the value is the symbol `kill', the active region is killed
938 instead of deleted."
951 "Function to get the region's content.
952 Called with one argument DELETE.
953 If DELETE is `delete-only', then only delete the region and the return value
954 is undefined. If DELETE is nil, just return the content as a string.
958 "Delete the previous N characters (following if N is negative).
959 If Transient Mark mode is enabled, the mark is active, and N is 1,
960 delete the text in the region and deactivate the mark instead.
961 To disable this, set option `delete-active-region' to nil.
963 Optional second arg KILLFLAG, if non-nil, means to kill (save in
964 kill ring) instead of delete. Interactively, N is the prefix
965 arg, and KILLFLAG is set if N is explicitly specified.
967 In Overwrite mode, single character backward deletion may replace
968 tabs with spaces so as to back over columns, unless point is at
969 the end of the line."
975 delete-active-region
977 ;; If a region is active, kill or delete it.
981 ;; In Overwrite mode, maybe untabify while deleting
991 ;; Otherwise, do simple deletion.
995 "Delete the following N characters (previous if N is negative).
996 If Transient Mark mode is enabled, the mark is active, and N is 1,
997 delete the text in the region and deactivate the mark instead.
998 To disable this, set variable `delete-active-region' to nil.
1000 Optional second arg KILLFLAG non-nil means to kill (save in kill
1001 ring) instead of delete. Interactively, N is the prefix arg, and
1002 KILLFLAG is set if N was explicitly specified."
1008 delete-active-region
1010 ;; If a region is active, kill or delete it.
1015 ;; Otherwise, do simple deletion.
1019 "Put point at beginning and mark at end of buffer.
1020 If narrowing is in effect, only uses the accessible part of the buffer.
1021 You probably should not use this function in Lisp programs;
1022 it is usually a mistake for a Lisp function to use any subroutine
1023 that uses or sets the mark."
1029 \f
1031 ;; Counting lines, one way or another.
1034 "Go to LINE, counting from line 1 at beginning of buffer.
1035 If called interactively, a numeric prefix argument specifies
1036 LINE; without a numeric prefix argument, read LINE from the
1037 minibuffer.
1039 If optional argument BUFFER is non-nil, switch to that buffer and
1041 as argument, BUFFER is the most recently selected other buffer.
1043 Prior to moving point, this function sets the mark (without
1044 activating it), unless Transient Mark mode is enabled and the
1045 mark is already active.
1047 This function is usually the wrong thing to use in a Lisp program.
1048 What you probably want instead is something like:
1049 (goto-char (point-min))
1050 (forward-line (1- N))
1051 If at all possible, an even better solution is to use char counts
1052 rather than line counts."
1057 ;; Look for a default, a number in the buffer at point.
1067 ;; Decide if we're switching buffers.
1075 ;; Read the argument, offering that number (if any) as default.
1078 buffer))))
1079 ;; Switch to the desired buffer, one way or another.
1084 ;; Leave mark at previous position
1086 ;; Move to the specified line number in that buffer.
1095 "Count the number of words in the region.
1096 If called interactively, print a message reporting the number of
1097 lines, words, and characters in the region (whether or not the
1098 region is active); with prefix ARG, report for the entire buffer
1099 rather than the region.
1101 If called from Lisp, return the number of words between positions
1102 START and END."
1114 "Count words between START and END.
1115 If called interactively, START and END are normally the start and
1116 end of the buffer; but if the region is active, START and END are
1117 the start and end of the region. Print a message reporting the
1118 number of lines, words, and chars.
1120 If called from Lisp, return the number of words between START and
1121 END, without printing any message."
1131 words))
1147 str
1155 "Print the current buffer line number and narrowed line number of point."
1168 "Return number of lines between START and END.
1169 This is usually the number of newlines between them,
1170 but can be one more if START is not equal to END
1171 and the greater of them is not at the start of a line."
1187 done)))
1191 "Return (narrowed) buffer line number at position POS.
1192 If POS is nil, use current buffer location.
1193 Counting starts at (point-min), so the value refers
1194 to the contents of the accessible portion of the buffer."
1204 "Print info on cursor position (on screen and within buffer).
1205 Also describe the character after point, and give its character code
1206 in octal, decimal and hex.
1208 For a non-ASCII multibyte character, also give its encoding in the
1209 buffer's selected coding system if the coding system encodes the
1210 character safely. If the character is encoded into one byte, that
1211 code is shown in hex. If the character is encoded into more than one
1214 In addition, with prefix argument, show details about that character
1215 in *Help* buffer. See also the command `describe-char'."
1220 ;; If the character is one of LRE, LRO, RLE, RLO, it
1221 ;; will start a directional embedding, which could
1222 ;; completely disrupt the rest of the line (e.g., RLO
1223 ;; will display the rest of the line right-to-left).
1224 ;; So we put an invisible PDF character after these
1225 ;; characters, to end the embedding, which eliminates
1226 ;; any effects on the rest of the line.
1228 ;; Strong right-to-left characters cause reordering of
1229 ;; the following numerical characters which show the
1230 ;; codepoint, so append LRM to countermand that.
1240 ;; Avoid overflow from multiplying by 100!
1244 ""
1250 pos total percent beg end col hscroll)
1252 pos total col hscroll))
1254 encoded encoding-msg display-prop under-display)
1261 ;; Check if the character is displayed with some `display'
1262 ;; text property. In that case, set under-display to the
1263 ;; buffer substring covered by that property.
1274 under-display)))
1280 char char char under-display)
1282 char char char under-display display-prop))
1285 char char char
1287 "..."
1291 ;; We show the detailed information about CHAR.
1298 bidi-fixer
1299 encoding-msg pos total percent beg end col hscroll)
1306 bidi-fixer encoding-msg pos total percent col hscroll))))))
1307 \f
1308 ;; Initialize read-expression-map. It is defined at C level.
1312 ;; Might as well bind TAB to completion, since inserting a TAB char is
1313 ;; much too rarely useful.
1316 m))
1319 "Return a Lisp object read using the minibuffer, unevaluated.
1320 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1321 is a string to insert in the minibuffer before reading.
1322 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1323 Such arguments are used as in `read-from-minibuffer'.)"
1324 ;; Used for interactive spec `x'.
1329 "Return value of Lisp expression read using the minibuffer.
1330 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1331 is a string to insert in the minibuffer before reading.
1332 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1333 Such arguments are used as in `read-from-minibuffer'.)"
1334 ;; Used for interactive spec `X'.
1342 "The current default value or list of default values in the minibuffer.
1343 The functions `read-from-minibuffer' and `completing-read' bind
1347 "Value for `print-level' while printing value in `eval-expression'.
1348 A value of nil means no limit."
1354 "Value for `print-length' while printing value in `eval-expression'.
1355 A value of nil means no limit."
1361 "If non-nil set `debug-on-error' to t in `eval-expression'.
1362 If nil, don't change the value of `debug-on-error'."
1368 "Format VALUE as a result of evaluated expression.
1369 Return a formatted string which is displayed in the echo area
1370 in addition to the value printed by prin1 in functions which
1371 display the result of expression evaluation."
1394 read-expression-map t
1397 ;; We define this, rather than making `eval' interactive,
1398 ;; for the sake of completion of names like eval-region, eval-buffer.
1400 "Evaluate EXP and print value in the echo area.
1401 When called interactively, read an Emacs Lisp expression and evaluate it.
1402 Value is also consed on to front of the variable `values'.
1403 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1404 argument) means insert the result into the current buffer instead of
1405 printing it in the echo area.
1407 Normally, this function truncates long output according to the value
1408 of the variables `eval-expression-print-length' and
1409 `eval-expression-print-level'. With a prefix argument of zero,
1410 however, there is no such truncation. Such a prefix argument
1411 also causes integers to be printed in several additional formats
1412 \(octal, hexadecimal, and character).
1414 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1415 minibuffer.
1417 If `eval-expression-debug-on-error' is non-nil, which is the default,
1418 this command arranges for all errors to enter the debugger."
1421 current-prefix-arg))
1426 ;; Bind debug-on-error to something unique so that we can
1427 ;; detect when evalled code changes it.
1431 ;; If evalled code has changed the value of debug-on-error,
1432 ;; propagate that change to the global binding.
1437 eval-expression-print-length))
1439 eval-expression-print-level))
1455 "Prompting with PROMPT, let user edit COMMAND and eval result.
1456 COMMAND is a Lisp expression. Let user edit that expression in
1457 the minibuffer, then read and evaluate the result."
1464 read-expression-map t
1466 ;; If command was added to command-history as a string,
1467 ;; get rid of that. We want only evaluable expressions there.
1471 ;; If command to be redone does not match front of history,
1472 ;; add it to the history.
1478 "Edit and re-evaluate last complex command, or ARGth from last.
1479 A complex command is one which used the minibuffer.
1480 The command is placed in the minibuffer as a Lisp form for editing.
1481 The result is executed, repeating the command as changed.
1482 If the command has been changed or is not the most recent previous
1483 command it is added to the front of the command history.
1484 You can use the minibuffer history commands \
1486 to get different commands to edit and resubmit."
1489 newcmd)
1501 ;; If command was added to command-history as a
1502 ;; string, get rid of that. We want only
1503 ;; evaluable expressions there.
1507 ;; If command to be redone does not match front of history,
1508 ;; add it to the history.
1522 "Read command name to invoke in `execute-extended-command'."
1527 ;; Get a command name at point in the original buffer
1528 ;; to propose it after M-n.
1532 ;; Read a string, completing from and restricting to the set of
1533 ;; all defined commands. Don't provide any initial input.
1534 ;; Save the command read on the extended-command history list.
1545 ;; This isn't strictly correct if `execute-extended-command'
1546 ;; is bound to anything else (e.g. [menu]).
1547 ;; It could use (key-description (this-single-command-keys)),
1548 ;; but actually a prompt other than "M-x" would be confusing,
1549 ;; because "M-x" is a well-known prompt to read a command
1550 ;; and it serves as a shorthand for "Extended command: ".
1555 "Non-nil means show the equivalent key-binding when M-x command has one.
1556 The value can be a length of time to show the message for.
1557 If the value is non-nil and not a number, we wait 2 seconds."
1564 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1565 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1566 "Read a command name, then read the arguments and call the command.
1567 Interactively, to pass a prefix argument to the command you are
1568 invoking, give a prefix argument to `execute-extended-command'.
1569 Noninteractively, the argument PREFIXARG is the prefix argument to
1570 give to the command you invoke."
1572 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1583 ;; Normally `real-this-command' should never be changed, but here we really
1584 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1585 ;; binding" for <cmd>, so the command the user really wanted to run is
1586 ;; `function' and not `execute-extended-command'. The difference is
1587 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1591 ;; If enabled, show which key runs this command.
1593 ;; But first wait, and skip the message if there is input.
1595 ;; If this command displayed something in the echo area;
1596 ;; wait a few seconds, then display our suggestion message.
1606 suggest-key-bindings
1610 ;; BEWARE: Called directly from the C code.
1611 "Execute CMD as an editor command.
1612 CMD must be a symbol that satisfies the `commandp' predicate.
1613 Optional second arg RECORD-FLAG non-nil
1614 means unconditionally put this command in the variable `command-history'.
1615 Otherwise, that is done only if an arg is read using the minibuffer.
1616 The argument KEYS specifies the value to use instead of (this-command-keys)
1617 when reading the arguments; if it is nil, (this-command-keys) is used.
1618 The argument SPECIAL, if non-nil, means that this command is executing
1619 a special event, so ignore the prefix argument and don't clear it."
1627 disabled-command-function)
1628 ;; FIXME: Weird calling convention!
1638 ;; If requested, place the macro in the command history. For
1639 ;; other sorts of commands, call-interactively takes care of this.
1642 ;; Don't keep command history around forever.
1648 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1656 \f
1658 "Default minibuffer history list.
1659 This is used for all minibuffer input
1660 except when an alternate history list is specified.
1662 Maximum length of the history list is determined by the value
1665 "Control whether history list elements are expressions or strings.
1666 If the value of this variable equals current minibuffer depth,
1667 they are expressions; otherwise they are strings.
1668 \(That convention is designed to do the right thing for
1675 "Text that was in this minibuffer before any history commands.
1676 This is nil if there have not yet been any history commands
1685 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1689 "Minibuffer history variables for which matching should ignore case.
1690 If a history variable is a member of this list, then the
1692 commands ignore case when searching it, regardless of `case-fold-search'."
1697 "Find the previous history element that matches REGEXP.
1698 \(Previous history elements refer to earlier actions.)
1699 With prefix argument N, search for Nth previous match.
1700 If N is negative, find the next or Nth next match.
1701 Normally, history elements are matched case-insensitively if
1702 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1703 makes the search case-sensitive.
1704 See also `minibuffer-history-case-insensitive-variables'."
1708 nil
1709 minibuffer-local-map
1710 nil
1711 'minibuffer-history-search-history
1713 ;; Use the last regexp specified, by default, if input is empty.
1718 regexp)
1728 ;; On some systems, ignore case for file names.
1730 minibuffer-history-case-insensitive-variables)
1731 t
1732 ;; Respect the user's setting for case-fold-search:
1733 case-fold-search)
1734 nil))
1735 prevpos
1736 match-string
1737 match-offset
1744 "No later matching history item"
1765 next-matching-history-element))
1769 "Find the next history element that matches REGEXP.
1770 \(The next history element refers to a more recent action.)
1771 With prefix argument N, search for Nth next match.
1772 If N is negative, find the previous or Nth previous match.
1773 Normally, history elements are matched case-insensitively if
1774 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1775 makes the search case-sensitive."
1779 nil
1780 minibuffer-local-map
1781 nil
1782 'minibuffer-history-search-history
1784 ;; Use the last regexp specified, by default, if input is empty.
1789 regexp)
1796 "Function run by `goto-history-element' before consuming default values.
1797 This is useful to dynamically add more elements to the list of default values
1798 when `goto-history-element' reaches the end of this list.
1799 Before calling this function `goto-history-element' sets the variable
1800 `minibuffer-default-add-done' to t, so it will call this function only
1801 once. In special cases, when this function needs to be called more
1802 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1806 "When nil, add more elements to the end of the list of default values.
1807 The value nil causes `goto-history-element' to add more elements to
1808 the list of defaults when it reaches the end of this list. It does
1814 "Return a list of all completions without the default value.
1815 This function is used to add all elements of the completion table to
1816 the end of the list of defaults just after the default value."
1819 minibuffer-completion-table
1820 minibuffer-completion-predicate)))
1826 "Puts element of the minibuffer history in the minibuffer.
1827 The argument NABS specifies the absolute history position."
1841 elt minibuffer-returned-to-present)
1848 "End of defaults; no next item"
1853 previous-history-element))
1865 minibuffer-default)))
1877 elt))
1881 "Puts next element of the minibuffer history in the minibuffer.
1882 With argument N, it uses the Nth following element."
1888 "Puts previous element of the minibuffer history in the minibuffer.
1889 With argument N, it uses the Nth previous element."
1895 "Get next history element which completes the minibuffer before the point.
1896 The contents of the minibuffer after the point are deleted, and replaced
1897 by the new completion."
1903 n)
1904 ;; next-matching-history-element always puts us at (point-min).
1905 ;; Move to the position we were at before changing the buffer contents.
1906 ;; This is still sensible, because the text before point has not changed.
1910 "\
1911 Get previous history element which completes the minibuffer before the point.
1912 The contents of the minibuffer after the point are deleted, and replaced
1913 by the new completion."
1917 ;; For compatibility with the old subr of the same name.
1919 "Return the display width of the minibuffer prompt.
1920 Return 0 if current buffer is not a minibuffer."
1921 ;; Return the width of everything before the field at the end of
1922 ;; the buffer; this should be 0 for normal buffers.
1924 \f
1925 ;; isearch minibuffer history
1932 "Set up a minibuffer for using isearch to search the minibuffer history.
1933 Intended to be added to `minibuffer-setup-hook'."
1945 "Clean up the minibuffer after terminating isearch in the minibuffer."
1950 "Return the proper search function, for isearch in minibuffer history."
1953 ;; Use standard functions to search within minibuffer text
1955 found)
1956 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1957 ;; searching forward. Lazy-highlight calls this lambda with the
1958 ;; bound arg, so skip the minibuffer prompt.
1962 ;; 1. First try searching in the initial minibuffer text
1965 noerror)
1966 ;; 2. If the above search fails, start putting next/prev history
1967 ;; elements in the minibuffer successively, and search the string
1968 ;; in them. Do this only when bound is nil (i.e. not while
1969 ;; lazy-highlighting search strings in the current minibuffer text).
1981 ;; After putting the next/prev history element, search
1982 ;; the string in them again, until next-history-element
1983 ;; or previous-history-element raises an error at the
1984 ;; beginning/end of history.
1987 ;; For backward search, don't search
1988 ;; in the minibuffer prompt
1990 noerror)))
1991 ;; Return point of the new search result
1993 ;; Return nil when next(prev)-history-element fails
1997 "Display the minibuffer history search prompt.
1998 If there are no search errors, this function displays an overlay with
1999 the isearch prompt which replaces the original minibuffer prompt.
2000 Otherwise, it displays the standard isearch message returned from
2001 the function `isearch-message'."
2003 ;; Use standard function `isearch-message' when not in the minibuffer,
2004 ;; or search fails, or has an error (like incomplete regexp).
2005 ;; This function overwrites minibuffer text with isearch message,
2006 ;; so it's possible to see what is wrong in the search string.
2008 ;; Otherwise, put the overlay with the standard isearch prompt over
2009 ;; the initial minibuffer prompt.
2018 ;; And clear any previous isearch message.
2022 "Wrap the minibuffer history search when search fails.
2023 Move point to the first history element for a forward search,
2024 or to the last history element for a backward search."
2025 ;; When `minibuffer-history-isearch-search' fails on reaching the
2026 ;; beginning/end of the history, wrap the search to the first/last
2027 ;; minibuffer history element.
2035 "Save a function restoring the state of minibuffer history search.
2036 Save `minibuffer-history-position' to the additional state parameter
2037 in the search status stack."
2043 "Restore the minibuffer history search state.
2044 Go to the history element by the absolute history position HIST-POS."
2047 \f
2048 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2052 "Table mapping redo records to the corresponding undo one.
2053 A redo record for undo-in-region maps to t.
2063 "Within a run of consecutive undo commands, list remaining to be undone.
2067 "Undo some previous changes.
2068 Repeat this command to undo more changes.
2069 A numeric ARG serves as a repeat count.
2071 In Transient Mark mode when the mark is active, only undo changes within
2073 as an argument limits undo to changes within the current region."
2075 ;; Make last-command indicate for the next command that this was an undo.
2076 ;; That way, another undo will undo more.
2077 ;; If we get to the end of the undo history and get an error,
2078 ;; another undo command will find the undo history empty
2079 ;; and will get another error. To begin undoing the undos,
2080 ;; you must type some other command.
2082 ;; For an indirect buffer, look in the base buffer for the
2083 ;; auto-save data.
2087 message)
2088 ;; If we get an error in undo-start,
2089 ;; the next command should not be a "consecutive undo".
2090 ;; So set `this-command' to something other than `undo'.
2095 ;; If something (a timer or filter?) changed the buffer
2096 ;; since the previous command, don't continue the undo seq.
2100 ;; If the last undo record made was made by undo
2101 ;; it shows nothing else happened in between.
2108 ;; get rid of initial undo boundary
2110 ;; If we got this far, the next command should be a consecutive undo.
2112 ;; Check to see whether we're hitting a redo record, and if
2113 ;; so, ask the user whether she wants to skip the redo/undo pair.
2121 ;; The equiv entry might point to another redo record if we have done
2122 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2130 ;; Record the fact that the just-generated undo records come from an
2131 ;; undo operation--that is, they are redo records.
2132 ;; In the ordinary case (not within a region), map the redo
2133 ;; record to the following undos.
2134 ;; I don't know how to do that in the undo-in-region case.
2136 ;; Strip any leading undo boundaries there might be, like we do
2137 ;; above when checking.
2141 ;; Prevent identity mapping. This can happen if
2142 ;; consecutive nils are erroneously in undo list.
2144 t
2145 pending-undo-list)
2146 undo-equiv-table))
2147 ;; Don't specify a position in the undo record for the undo command.
2148 ;; Instead, undoing this should move point to where the change is.
2167 ;; Record what the current undo list says,
2168 ;; so the next command can tell if the buffer was modified in between.
2172 ;; Display a message announcing success.
2177 "Make BUFFER stop keeping undo information.
2178 No argument or nil as argument means do this for the current buffer."
2184 "Undo some previous changes.
2185 Repeat this command to undo more changes.
2186 A numeric ARG serves as a repeat count.
2187 Contrary to `undo', this will not redo a previous undo."
2192 "Non-nil while performing an undo.
2196 "Undo back N undo-boundaries beyond what was already undone recently.
2197 Call `undo-start' to get ready to undo recent changes,
2198 then call `undo-more' one or more times to undo them."
2203 ;; Note: The following, while pulling elements off
2204 ;; `pending-undo-list' will call primitive change functions which
2205 ;; will push more elements onto `buffer-undo-list'.
2211 "Undo N records from the front of the list LIST.
2212 Return what remains of the list."
2214 ;; This is a good feature, but would make undo-start
2215 ;; unable to do what is expected.
2216 ;;(when (null (car (list)))
2217 ;; ;; If the head of the list is a boundary, it is the boundary
2218 ;; ;; preceding this command. Get rid of it and don't count it.
2219 ;; (setq list (cdr list))))
2222 ;; In a writable buffer, enable undoing read-only text that is
2223 ;; so because of text properties.
2225 ;; Don't let `intangible' properties interfere with undo.
2227 ;; We use oldlist only to check for EQ. ++kfs
2233 ;; Handle an integer by setting point to that value.
2236 ;; Element (t . TIME) records previous modtime.
2237 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2238 ;; UNKNOWN_MODTIME_NSECS.
2240 ;; If this records an obsolete save
2241 ;; (not matching the actual disk file)
2242 ;; then don't mark unmodified.
2250 ;; Element (nil PROP VAL BEG . END) is property change.
2255 ;; Element (BEG . END) means range was inserted.
2257 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2258 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2261 ;; Set point first thing, so that undoing this undo
2262 ;; does not send point back to where it is now.
2265 ;; Element (apply FUN . ARGS) means call FUN to undo.
2269 ;; Long format: (apply DELTA START END FUN . ARGS).
2276 ;; Check that the function did what the entry
2277 ;; said it would do.
2287 ;; Element (STRING . POS) means STRING was deleted.
2293 ;; Check that marker adjustments which were recorded
2294 ;; with the (STRING . POS) record are still valid, ie
2295 ;; the markers haven't moved. We check their validity
2296 ;; before reinserting the string so as we don't need to
2297 ;; mind marker insertion-type.
2305 ;; Insert string and adjust point
2313 ;; Adjust the valid marker adjustments
2317 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2320 next)
2321 ;; Even though these elements are not expected in the undo
2322 ;; list, adjust them to be conservative for the 24.4
2323 ;; release. (Bug#16818)
2330 ;; Make sure an apply entry produces at least one undo entry,
2331 ;; so the test in `undo' for continuing an undo series
2332 ;; will work right.
2337 list)
2339 ;; Deep copy of a list
2341 "Make a copy of undo list LIST."
2347 elt))
2350 "Set `pending-undo-list' to the front of the undo list.
2351 The next call to `undo-more' will undo the most recently made change.
2352 If BEG and END are specified, then only undo elements
2353 that apply to text between BEG and END are used; other undo elements
2354 are ignored. If BEG and END are nil, all undo elements are used."
2360 buffer-undo-list)))
2362 ;; The positions given in elements of the undo list are the positions
2363 ;; as of the time that element was recorded to undo history. In
2364 ;; general, subsequent buffer edits render those positions invalid in
2365 ;; the current buffer, unless adjusted according to the intervening
2366 ;; undo elements.
2367 ;;
2368 ;; Undo in region is a use case that requires adjustments to undo
2369 ;; elements. It must adjust positions of elements in the region based
2370 ;; on newer elements not in the region so as they may be correctly
2371 ;; applied in the current buffer. undo-make-selective-list
2372 ;; accomplishes this with its undo-deltas list of adjustments. An
2373 ;; example undo history from oldest to newest:
2374 ;;
2375 ;; buf pos:
2376 ;; 123456789 buffer-undo-list undo-deltas
2377 ;; --------- ---------------- -----------
2378 ;; aaa (1 . 4) (1 . -3)
2379 ;; aaba (3 . 4) N/A (in region)
2380 ;; ccaaba (1 . 3) (1 . -2)
2381 ;; ccaabaddd (7 . 10) (7 . -3)
2382 ;; ccaabdd ("ad" . 6) (6 . 2)
2383 ;; ccaabaddd (6 . 8) (6 . -2)
2384 ;; | |<-- region: "caab", from 2 to 6
2385 ;;
2386 ;; When the user starts a run of undos in region,
2387 ;; undo-make-selective-list is called to create the full list of in
2388 ;; region elements. Each element is adjusted forward chronologically
2389 ;; through undo-deltas to determine if it is in the region.
2390 ;;
2391 ;; In the above example, the insertion of "b" is (3 . 4) in the
2392 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2393 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2394 ;; . 6) is assessed as in the region and placed in the selective list.
2395 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2396 ;; due to the selected element. The "b" insertion is the only element
2397 ;; fully in the region, so in this example undo-make-selective-list
2398 ;; returns (nil (5 . 6)).
2399 ;;
2400 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2401 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2402 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2403 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2404 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2405 ;;
2406 ;; More interesting is how to adjust the "ddd" insertion due to the
2407 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2408 ;; If the reinsertion was a manual retyping of "ad", then the total
2409 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2410 ;; the reinsertion was due to undo, one might expect the first "d"
2411 ;; character would again be a part of the "ddd" text, meaning its
2412 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2413 ;;
2414 ;; undo-make-selective-list assumes in this situation that "ad" was a
2415 ;; new edit, even if it was inserted because of an undo.
2416 ;; Consequently, if the user undos in region "8 to 10" of the
2417 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2418 ;; "ccaabad", as though the first "d" became detached from the
2419 ;; original "ddd" insertion. This quirk is a FIXME.
2422 "Return a list of undo elements for the region START to END.
2423 The elements come from `buffer-undo-list', but we keep only the
2424 elements inside this region, and discard those outside this
2425 region. The elements' positions are adjusted so as the returned
2426 list can be applied to the current buffer."
2428 ;; A list of position adjusted undo elements in the region.
2430 ;; A list of undo-deltas for out of region undo elements.
2431 undo-deltas
2432 undo-elt)
2440 ;; Don't put two nils together in the list
2444 ;; This is a "was unmodified" element. Keep it
2445 ;; if we have kept everything thus far.
2448 ;; Skip over marker adjustments, instead relying
2449 ;; on finding them after (TEXT . POS) elements
2451 nil)
2454 undo-deltas)))
2459 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2460 ;; kept. primitive-undo may discard them later.
2473 "Determine whether UNDO-ELT falls inside the region START ... END.
2474 If it crosses the edge, we return nil.
2476 Generally this function is not useful for determining
2477 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2478 because markers can be arbitrarily relocated. Instead, pass the
2479 marker adjustment's corresponding (TEXT . POS) element."
2484 t)
2486 nil)
2488 ;; (TEXT . POSITION)
2492 ;; (MARKER . ADJUSTMENT)
2495 ;; (nil PROPERTY VALUE BEG . END)
2500 ;; (BEGIN . END)
2505 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2506 This assumes we have already decided that UNDO-ELT
2507 is not *inside* the region START...END."
2510 ;; (nil PROPERTY VALUE BEG . END)
2515 ;; (BEGIN . END)
2521 "Return adjustment of undo element ELT by the undo DELTAS
2522 list."
2524 ;; POSITION
2527 ;; (BEG . END)
2530 ;; (TEXT . POSITION)
2534 ;; (nil PROPERTY VALUE BEG . END)
2537 ;; (apply DELTA START END FUN . ARGS)
2538 ;; FIXME
2539 ;; All others return same elt
2542 ;; (BEG . END) can adjust to the same positions, commonly when an
2543 ;; insertion was undone and they are out of region, for example:
2544 ;;
2545 ;; buf pos:
2546 ;; 123456789 buffer-undo-list undo-deltas
2547 ;; --------- ---------------- -----------
2548 ;; [...]
2549 ;; abbaa (2 . 4) (2 . -2)
2550 ;; aaa ("bb" . 2) (2 . 2)
2551 ;; [...]
2552 ;;
2553 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2554 ;; undo. Further adjustments to such an element should be the same as
2555 ;; for (TEXT . POSITION) elements. The options are:
2556 ;;
2557 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2558 ;; analogous to marker insertion-type t.
2559 ;;
2560 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2561 ;; marker insertion-type nil.
2562 ;;
2563 ;; There was no strong reason to prefer one or the other, except that
2564 ;; the first is more consistent with prior undo in region behavior.
2566 "Return cons of adjustments to BEG and END by the undo DELTAS
2567 list."
2569 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2574 "Return adjustment of POS by the undo DELTAS list, comparing
2575 with < or <= based on USE-<."
2581 ;; Don't allow pos to become less than the undo-delta
2582 ;; position. This edge case is described in the overview
2583 ;; comments.
2586 ;; Return the first affected buffer position and the delta for an undo element
2587 ;; delta is defined as the change in subsequent buffer positions if we *did*
2588 ;; the undo.
2592 ;; (TEXT . POSITION)
2595 ;; (BEGIN . END)
2602 "If non-nil ask about discarding undo info for the current command.
2603 Normally, Emacs discards the undo info for the current command if
2604 it exceeds `undo-outer-limit'. But if you set this option
2605 non-nil, it asks in the echo area whether to discard the info.
2606 If you answer no, there is a slight risk that Emacs might crash, so
2607 only do it if you really want to undo the command.
2609 This option is mainly intended for debugging. You have to be
2610 careful if you use it for other purposes. Garbage collection is
2611 inhibited while the question is asked, meaning that Emacs might
2612 leak memory. So you should make sure that you do not wait
2613 excessively long before answering the question."
2619 "If non-nil, an extra level of size that's ok in an undo item.
2620 We don't ask the user about truncating the undo list until the
2621 current item gets bigger than this amount.
2626 ;; When the first undo batch in an undo list is longer than
2627 ;; undo-outer-limit, this function gets called to warn the user that
2628 ;; the undo info for the current command was discarded. Garbage
2629 ;; collection is inhibited around the call, so it had better not do a
2630 ;; lot of consing.
2636 ;; Don't ask the question again unless it gets even bigger.
2637 ;; This applies, in particular, if the user quits from the question.
2638 ;; Such a quit quits out of GC, but something else will call GC
2639 ;; again momentarily. It will call this function again,
2640 ;; but we don't want to ask the question again.
2647 t)
2648 nil))
2653 "The undo info was discarded because it exceeded \
2654 `undo-outer-limit'.
2656 This is normal if you executed a command that made a huge change
2657 to the buffer. In that case, to prevent similar problems in the
2658 future, set `undo-outer-limit' to a value that is large enough to
2659 cover the maximum size of normal changes you expect a single
2660 command to make, but not so large that it might exceed the
2661 maximum memory allotted to Emacs.
2663 If you did not execute any such command, the situation is
2664 probably due to a bug and you should report it.
2666 You can disable the popping up of this buffer by adding the entry
2667 \(undo discard-info) to the user option `warning-suppress-types',
2671 t))
2672 \f
2675 ; These are sorted according to the GNU en_US locale.
2718 )
2720 This is used by Shell mode and other parts of Emacs to recognize
2721 password prompts, including prompts in languages other than
2722 English. Different case choices should not be assumed to be
2723 included; callers should bind `case-fold-search' to t."
2729 "History list for some commands that read shell commands.
2731 Maximum length of the history list is determined by the value
2738 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2739 This buffer is used when `shell-command' or `shell-command-on-region'
2740 is run interactively. A value of nil means that output to stderr and
2747 "Return a list of all commands associated with the current file.
2748 This function is used to add all related commands retrieved by `mailcap'
2749 to the end of the list of defaults just after the default value."
2753 minibuffer-default))
2758 commands))
2769 map)
2773 "Read a shell command from the minibuffer.
2774 The arguments are the same as the ones of `read-from-minibuffer',
2775 except READ and KEYMAP are missing and HIST defaults
2776 to `shell-command-history'."
2784 minibuffer-local-shell-command-map
2785 nil
2787 args)))
2790 "What to do when the output buffer is used by another shell command.
2791 This option specifies how to resolve the conflict where a new command
2792 wants to direct its output to the buffer `*Async Shell Command*',
2793 but this buffer is already taken by another running shell command.
2795 The value `confirm-kill-process' is used to ask for confirmation before
2796 killing the already running process and running a new process
2797 in the same buffer, `confirm-new-buffer' for confirmation before running
2798 the command in a new buffer with a name other than the default buffer name,
2799 `new-buffer' for doing the same without confirmation,
2800 `confirm-rename-buffer' for confirmation before renaming the existing
2801 output buffer and running a new command in the default buffer,
2802 `rename-buffer' for doing the same without confirmation."
2804 confirm-kill-process)
2806 confirm-new-buffer)
2808 new-buffer)
2810 confirm-rename-buffer)
2812 rename-buffer))
2817 "Execute string COMMAND asynchronously in background.
2819 Like `shell-command', but adds `&' at the end of COMMAND
2820 to execute it asynchronously.
2822 The output appears in the buffer `*Async Shell Command*'.
2823 That buffer is in shell mode.
2825 You can configure `async-shell-command-buffer' to specify what to do in
2826 case when `*Async Shell Command*' buffer is already taken by another
2827 running shell command. To run COMMAND without displaying the output
2828 in a window you can configure `display-buffer-alist' to use the action
2829 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
2831 In Elisp, you will often be better served by calling `start-process'
2832 directly, since it offers more control and does not impose the use of a
2833 shell (with its need to quote arguments)."
2843 current-prefix-arg
2844 shell-command-default-error-buffer))
2850 "Execute string COMMAND in inferior shell; display output, if any.
2851 With prefix argument, insert the COMMAND's output at point.
2853 If COMMAND ends in `&', execute it asynchronously.
2854 The output appears in the buffer `*Async Shell Command*'.
2855 That buffer is in shell mode. You can also use
2856 `async-shell-command' that automatically adds `&'.
2858 Otherwise, COMMAND is executed synchronously. The output appears in
2859 the buffer `*Shell Command Output*'. If the output is short enough to
2860 display in the echo area (which is determined by the variables
2861 `resize-mini-windows' and `max-mini-window-height'), it is shown
2862 there, but it is nonetheless available in buffer `*Shell Command
2863 Output*' even though that buffer is not automatically displayed.
2865 To specify a coding system for converting non-ASCII characters
2867 before this command.
2869 Noninteractive callers can specify coding systems by binding
2870 `coding-system-for-read' and `coding-system-for-write'.
2872 The optional second argument OUTPUT-BUFFER, if non-nil,
2873 says to put the output in some other buffer.
2874 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2875 If OUTPUT-BUFFER is not a buffer and not nil,
2876 insert output in current buffer. (This cannot be done asynchronously.)
2877 In either case, the buffer is first erased, and the output is
2878 inserted after point (leaving mark after it).
2880 If the command terminates without error, but generates output,
2882 the output can be displayed in the echo area or in its buffer.
2883 If the output is short enough to display in the echo area
2884 \(determined by the variable `max-mini-window-height' if
2885 `resize-mini-windows' is non-nil), it is shown there.
2886 Otherwise,the buffer containing the output is displayed.
2890 of the output.
2892 If there is no output, or if output is inserted in the current buffer,
2893 then `*Shell Command Output*' is deleted.
2895 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2896 or buffer name to which to direct the command's standard error output.
2897 If it is nil, error output is mingled with regular output.
2898 In an interactive call, the variable `shell-command-default-error-buffer'
2899 specifies the value of ERROR-BUFFER.
2901 In Elisp, you will often be better served by calling `call-process' or
2902 `start-process' directly, since it offers more control and does not impose
2903 the use of a shell (with its need to quote arguments)."
2914 current-prefix-arg
2915 shell-command-default-error-buffer))
2916 ;; Look for a handler in case default-directory is a remote file name.
2924 ;; Output goes in current buffer.
2930 temporary-file-directory)))
2931 nil)))
2934 ;; We do not use -f for csh; we will not support broken use of
2935 ;; .cshrcs. Even the BSD csh manual says to use
2936 ;; "if ($?prompt) exit" before things which are not useful
2937 ;; non-interactively. Besides, if someone wants their other
2938 ;; aliases for shell commands then they can still have them.
2942 t)
2943 nil shell-command-switch command)
2950 ;; Do no formatting while reading error file,
2951 ;; because that can run a shell command, and we
2952 ;; don't want that to cause an infinite recursion.
2954 ;; Put point after the inserted errors.
2958 ;; This is like exchange-point-and-mark, but doesn't
2959 ;; activate the mark. It is cleaner to avoid activation,
2960 ;; even though the command loop would deactivate the mark
2961 ;; because we inserted text.
2965 ;; Output goes in a separate buffer.
2966 ;; Preserve the match data in case called from a program.
2969 ;; Command ending with ampersand means asynchronous.
2973 proc)
2974 ;; Remove the ampersand.
2976 ;; Ask the user what to do with already running process.
2981 ;; If will kill a process, query first.
2986 ;; If will create a new buffer, query first.
2992 ;; It will create a new buffer.
2996 ;; If will rename the buffer, query first.
3005 ;; It will rename the buffer.
3012 ;; Setting buffer-read-only to nil doesn't suffice
3013 ;; if some text has a non-nil read-only property,
3014 ;; which comint sometimes adds for prompts.
3020 shell-command-switch command))
3024 ;; Use the comint filter for proper handling of carriage motion
3025 ;; (see `comint-inhibit-carriage-motion'),.
3027 ))
3028 ;; Otherwise, command is executed synchronously.
3030 output-buffer nil error-buffer)))))))
3034 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3035 MESSAGE may be either a string or a buffer.
3037 A buffer is displayed using `display-buffer' if MESSAGE is too long for
3038 the maximum height of the echo area, as defined by `max-mini-window-height'
3039 if `resize-mini-windows' is non-nil.
3041 Returns either the string shown in the echo area, or when a pop-up
3042 buffer is used, the window used to display it.
3044 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3045 name of the buffer used to display it in the case where a pop-up buffer
3046 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3047 string and it is displayed in the echo area, it is not specified whether
3048 the contents are inserted into the buffer anyway.
3050 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
3051 and only used if a buffer is displayed."
3053 ;; Trivial case where we can use the echo area
3057 ;; Trivial case where we can just remove single trailing newline
3060 ;; General case
3063 message
3072 0
3076 (<= lines
3080 max-mini-window-height))
3082 max-mini-window-height)
3086 ;; Don't use the echo area if the output buffer is
3087 ;; already displayed in the selected frame.
3089 ;; Echo area
3095 ;; Buffer
3098 not-this-window frame))))))))
3101 ;; We have a sentinel to prevent insertion of a termination message
3102 ;; in the buffer itself.
3110 &optional output-buffer replace
3111 error-buffer display-error-buffer)
3112 "Execute string COMMAND in inferior shell with region as input.
3113 Normally display output (if any) in temp buffer `*Shell Command Output*';
3114 Prefix arg means replace the region with it. Return the exit code of
3115 COMMAND.
3117 To specify a coding system for converting non-ASCII characters
3119 before this command. By default, the input (from the current buffer)
3120 is encoded using coding-system specified by `process-coding-system-alist',
3121 falling back to `default-process-coding-system' if no match for COMMAND
3122 is found in `process-coding-system-alist'.
3124 Noninteractive callers can specify coding systems by binding
3125 `coding-system-for-read' and `coding-system-for-write'.
3127 If the command generates output, the output may be displayed
3128 in the echo area or in a buffer.
3129 If the output is short enough to display in the echo area
3130 \(determined by the variable `max-mini-window-height' if
3131 `resize-mini-windows' is non-nil), it is shown there.
3132 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3133 The output is available in that buffer in both cases.
3135 If there is output and an error, a message about the error
3136 appears at the end of the output. If there is no output, or if
3137 output is inserted in the current buffer, the buffer `*Shell
3138 Command Output*' is deleted.
3140 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3141 command's output. If the value is a buffer or buffer name,
3142 put the output there. If the value is nil, use the buffer
3143 `*Shell Command Output*'. Any other value, excluding nil,
3144 means to insert the output in the current buffer. In either case,
3145 the output is inserted after point (leaving mark after it).
3147 Optional fifth arg REPLACE, if non-nil, means to insert the
3148 output in place of text from START to END, putting point and mark
3149 around it.
3151 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3152 or buffer name to which to direct the command's standard error
3153 output. If nil, error output is mingled with regular output.
3154 When called interactively, `shell-command-default-error-buffer'
3155 is used for ERROR-BUFFER.
3157 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3158 display the error buffer if there were any errors. When called
3159 interactively, this is t."
3163 ;; Do this before calling region-beginning
3164 ;; and region-end, in case subprocess output
3165 ;; relocates them while we are in the minibuffer.
3167 ;; call-interactively recognizes region-beginning and
3168 ;; region-end specially, leaving them in the history.
3170 string
3171 current-prefix-arg
3172 current-prefix-arg
3173 shell-command-default-error-buffer
3174 t)))
3180 temporary-file-directory)))
3181 nil))
3182 exit-status)
3186 ;; Replace specified region with output from command.
3188 ;; Don't muck with mark unless REPLACE says we should.
3195 t)
3196 nil shell-command-switch command))
3197 ;; It is rude to delete a buffer which the command is not using.
3198 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3199 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3200 ;; (kill-buffer shell-buffer)))
3201 ;; Don't muck with mark unless REPLACE says we should.
3203 ;; No prefix argument: put the output in a temp buffer,
3204 ;; replacing its entire contents.
3209 ;; If the input is the same buffer as the output,
3210 ;; delete everything but the specified region,
3211 ;; then replace that region with the output.
3217 shell-file-name t
3220 t)
3221 nil shell-command-switch
3222 command)))
3223 ;; Clear the output buffer, then run the command with
3224 ;; output there.
3235 buffer)
3236 nil shell-command-switch command)))
3237 ;; Report the output.
3247 ;; There's some output, display it
3249 ;; No output; error?
3256 shell-command-default-error-buffer)
3263 output))
3266 exit-status))
3269 exit-status output))))
3270 ;; Don't kill: there might be useful info in the undo-log.
3271 ;; (kill-buffer buffer)
3272 ))))
3280 ;; Do no formatting while reading error file,
3281 ;; because that can run a shell command, and we
3282 ;; don't want that to cause an infinite recursion.
3284 ;; Put point after the inserted errors.
3289 exit-status))
3292 "Execute shell command COMMAND and return its output as a string."
3295 standard-output
3299 "Process files synchronously in a separate process.
3300 Similar to `call-process', but may invoke a file handler based on
3301 `default-directory'. The current working directory of the
3302 subprocess is `default-directory'.
3304 File names in INFILE and BUFFER are handled normally, but file
3305 names in ARGS should be relative to `default-directory', as they
3306 are passed to the process verbatim. (This is a difference to
3307 `call-process' which does not support file handlers for INFILE
3308 and BUFFER.)
3310 Some file handlers might not support all variants, for example
3311 they might behave as if DISPLAY was nil, regardless of the actual
3312 value passed."
3314 lc stderr-file)
3324 display args)
3330 "Whether a call of `process-file' changes remote files.
3332 By default, this variable is always set to `t', meaning that a
3333 call of `process-file' could potentially change any file on a
3334 remote host. When set to `nil', a file handler could optimize
3335 its behavior with respect to remote file attribute caching.
3337 You should only ever change this variable with a let-binding;
3341 "Start a program in a subprocess. Return the process object for it.
3343 Similar to `start-process', but may invoke a file handler based on
3344 `default-directory'. See Info node `(elisp)Magic File Names'.
3346 This handler ought to run PROGRAM, perhaps on the local host,
3347 perhaps on a remote host that corresponds to `default-directory'.
3348 In the latter case, the local part of `default-directory' becomes
3349 the working directory of the process.
3351 PROGRAM and PROGRAM-ARGS might be file names. They are not
3352 objects of file handler invocation. File handlers might not
3353 support pty association, if PROGRAM is nil."
3357 \f
3358 ;;;; Process menu
3372 map))
3375 "Major mode for listing the processes called by Emacs."
3387 "Kill process at point in a `list-processes' buffer."
3393 "Recompute the list of processes for the Process List buffer.
3394 Also, delete any process that is exited or signaled."
3407 face link
3410 follow-link t
3411 process-buffer ,buf
3412 action process-menu-visit-buffer)
3421 "datagram"
3438 tabulated-list-entries))))))
3444 "Display a list of all processes that are Emacs sub-processes.
3445 If optional argument QUERY-ONLY is non-nil, only processes with
3446 the query-on-exit flag set are listed.
3447 Any process listed as exited or signaled is actually eliminated
3448 after the listing is made.
3449 Optional argument BUFFER specifies a buffer to use, instead of
3451 The return value is always nil.
3453 This function lists only processes that were launched by Emacs. To
3454 see other processes running on the system, use `list-system-processes'."
3466 nil)
3467 \f
3471 ;; For backward compatibility, minus with no modifiers is an ordinary
3472 ;; command if digits have already been entered.
3502 map)
3509 "Begin a numeric argument for the following command.
3514 multiplies the argument by 4 each time.
3516 which is different in effect from any particular numeric argument.
3523 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3524 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3530 arg)))
3534 "Begin a negative numeric argument for the next command.
3543 "Part of the numeric argument for the next command.
3547 last-command-event
3554 ;; Treat -0 as just -, so that -01 will work.
3557 digit))))
3559 \f
3567 "Function to perform the filtering in `filter-buffer-substring'.
3568 The function is called with the same 3 arguments (BEG END DELETE)
3569 that `filter-buffer-substring' received. It should return the
3570 buffer substring between BEG and END, after filtering. If DELETE is
3574 "List of filter functions for `buffer-substring--filter'.
3575 Each function must accept a single argument, a string, and return a string.
3576 The buffer substring is passed to the first function in the list,
3577 and the return value of each function is passed to the next.
3578 As a special convention, point is set to the start of the buffer text
3579 being operated on (i.e., the first argument of `buffer-substring--filter')
3585 "Return the buffer substring between BEG and END, after filtering.
3586 If DELETE is non-nil, delete the text between BEG and END from the buffer.
3588 This calls the function that `filter-buffer-substring-function' specifies
3589 \(passing the same three arguments that it received) to do the work,
3590 and returns whatever it does. The default function does no filtering,
3591 unless a hook has been set.
3593 Use `filter-buffer-substring' instead of `buffer-substring',
3594 `buffer-substring-no-properties', or `delete-and-extract-region' when
3595 you want to allow filtering to take place. For example, major or minor
3596 modes can use `filter-buffer-substring-function' to extract characters
3597 that are special to a buffer, and should not be copied into other buffers."
3601 "Default function to use for `filter-buffer-substring-function'.
3602 Its arguments and return value are as specified for `filter-buffer-substring'.
3603 This respects the wrapper hook `filter-buffer-substring-functions',
3604 and the abnormal hook `buffer-substring-filters'.
3605 No filtering is done unless a hook says to."
3615 string)))
3620 ;;;; Window system cut and paste hooks.
3623 "Function to call to make a killed region available to other programs.
3624 Most window systems provide a facility for cutting and pasting
3625 text between different programs, such as the clipboard on X and
3626 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3628 This variable holds a function that Emacs calls whenever text is
3629 put in the kill ring, to make the new kill available to other
3630 programs. The function takes one argument, TEXT, which is a
3634 "Function to call to get text cut from other programs.
3635 Most window systems provide a facility for cutting and pasting
3636 text between different programs, such as the clipboard on X and
3637 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3639 This variable holds a function that Emacs calls to obtain text
3640 that other programs have provided for pasting. The function is
3641 called with no arguments. If no other program has provided text
3642 to paste, the function should return nil (in which case the
3643 caller, usually `current-kill', should use the top of the Emacs
3644 kill ring). If another program has provided text to paste, the
3645 function should return that text as a string (in which case the
3646 caller should put this string in the kill ring as the latest
3647 kill).
3649 The function may also return a list of strings if the window
3650 system supports multiple selections. The first string will be
3651 used as the pasted text, but the other will be placed in the kill
3652 ring for easy access via `yank-pop'.
3654 Note that the function should return a string only if a program
3655 other than Emacs has provided a string for pasting; if Emacs
3656 provided the most recent string, the function should return nil.
3657 If it is difficult to tell whether Emacs or some other program
3658 provided the current string, it is probably good enough to return
3659 nil if the string is equal (according to `string=') to the last
3661 \f
3664 ;;;; The kill ring data structure.
3667 "List of killed text sequences.
3668 Since the kill ring is supposed to interact nicely with cut-and-paste
3669 facilities offered by window systems, use of this variable should
3670 interact nicely with `interprogram-cut-function' and
3671 `interprogram-paste-function'. The functions `kill-new',
3672 `kill-append', and `current-kill' are supposed to implement this
3673 interaction; you may want to use them instead of manipulating the kill
3677 "Maximum length of kill ring before oldest elements are thrown away."
3685 "Save clipboard strings into kill ring before replacing them.
3686 When one selects something in another program to paste it into Emacs,
3687 but kills something in Emacs before actually pasting it,
3688 this selection is gone unless this variable is non-nil,
3689 in which case the other program's selection is saved in the `kill-ring'
3696 "Do not add a new string to `kill-ring' if it duplicates the last one.
3697 The comparison is done using `equal-including-properties'."
3703 "Make STRING the latest kill in the kill ring.
3704 Set `kill-ring-yank-pointer' to point to it.
3705 If `interprogram-cut-function' is non-nil, apply it to STRING.
3706 Optional second argument REPLACE non-nil means that STRING will replace
3707 the front of the kill ring, rather than being added to the list.
3709 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3710 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3711 STRING.
3713 When the yank handler has a non-nil PARAM element, the original STRING
3714 argument is not used by `insert-for-yank'. However, since Lisp code
3715 may access and use elements from the kill ring directly, the STRING
3718 ;; Due to text properties such as 'yank-handler that
3719 ;; can alter the contents to yank, comparison using
3720 ;; `equal' is unsafe.
3745 ;; It has been argued that this should work similar to `self-insert-command'
3746 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
3748 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
3754 "Append STRING to the end of the latest kill in the kill ring.
3755 If BEFORE-P is non-nil, prepend STRING to the kill.
3756 Also removes the last undo boundary in the current buffer,
3757 depending on `kill-append-merge-undo'.
3758 If `interprogram-cut-function' is set, pass the resulting kill to it."
3766 ;; find the next undo boundary
3770 ;; remove this undo boundary
3775 "Whether rotating the kill ring changes the window system selection.
3776 If non-nil, whenever the kill ring is rotated (usually via the
3777 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3778 to copy the new kill to the window system selection."
3784 "Rotate the yanking point by N places, and then return that kill.
3785 If N is zero and `interprogram-paste-function' is set to a
3786 function that returns a string or a list of strings, and if that
3787 function doesn't return nil, then that string (or list) is added
3788 to the front of the kill ring and the string (or first string in
3789 the list) is returned as the latest kill.
3791 If N is not zero, and if `yank-pop-change-selection' is
3792 non-nil, use `interprogram-cut-function' to transfer the
3793 kill at the new yank point into the window system selection.
3795 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3796 move the yanking point; just return the Nth kill forward."
3799 interprogram-paste-function
3803 ;; Disable the interprogram cut function when we add the new
3804 ;; text to the kill ring, so Emacs doesn't try to own the
3805 ;; selection, with identical text.
3815 kill-ring)))
3820 interprogram-cut-function)
3826 ;;;; Commands for manipulating the kill ring.
3829 "Non-nil means don't signal an error for killing read-only text."
3835 This deletes the text from the buffer and saves it in the kill ring.
3839 If you want to append the killed region to the last killed text,
3842 If the buffer is read-only, Emacs will beep and refrain from deleting
3843 the text, but put the text in the kill ring anyway. This means that
3844 you can use the killing commands to copy text from a read-only buffer.
3846 Lisp programs should use this function for killing text.
3847 (To delete text, use `delete-region'.)
3848 Supply two arguments, character positions indicating the stretch of text
3849 to be killed.
3851 If the previous command was also a kill command,
3852 the text killed this time appends to the text killed last time
3853 to make one entry in the kill ring.
3855 The optional argument REGION if non-nil, indicates that we're not just killing
3856 some text between BEG and END, but we're killing the region."
3857 ;; Pass mark first, then point, because the order matters when
3858 ;; calling `kill-append'.
3867 ;; Add that string to the kill ring, one way or another.
3874 nil)
3876 ;; The code above failed because the buffer, or some of the characters
3877 ;; in the region, are read-only.
3878 ;; We should beep, in case the user just isn't aware of this.
3879 ;; However, there's no harm in putting
3880 ;; the region's text in the kill ring, anyway.
3882 ;; Set this-command now, so it will be set even if we get an error.
3884 ;; This should barf, if appropriate, and give us the correct error.
3887 ;; Signal an error if the buffer is read-only.
3889 ;; If the buffer isn't read-only, the text is.
3892 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3893 ;; to get two copies of the text when the user accidentally types M-w and
3894 ;; then corrects it with the intended C-w.
3896 "Save the region as if killed, but don't kill it.
3897 In Transient Mark mode, deactivate the mark.
3898 If `interprogram-cut-function' is non-nil, also save the text for a window
3899 system cut and paste.
3901 The optional argument REGION if non-nil, indicates that we're not just copying
3902 some text between BEG and END, but we're copying the region.
3904 This command's old key binding has been given to `kill-ring-save'."
3905 ;; Pass mark first, then point, because the order matters when
3906 ;; calling `kill-append'.
3916 nil)
3919 "Save the region as if killed, but don't kill it.
3920 In Transient Mark mode, deactivate the mark.
3921 If `interprogram-cut-function' is non-nil, also save the text for a window
3922 system cut and paste.
3924 If you want to append the killed line to the last killed text,
3927 The optional argument REGION if non-nil, indicates that we're not just copying
3928 some text between BEG and END, but we're copying the region.
3930 This command is similar to `copy-region-as-kill', except that it gives
3931 visual feedback indicating the extent of the region being copied."
3932 ;; Pass mark first, then point, because the order matters when
3933 ;; calling `kill-append'.
3937 ;; This use of called-interactively-p is correct because the code it
3938 ;; controls just gives the user visual feedback.
3943 "Indicate that the region text has been copied interactively.
3944 If the mark is visible in the selected window, blink the cursor
3945 between point and mark if there is currently no active region
3946 highlighting.
3948 If the mark lies outside the selected window, display an
3949 informative message containing a sample of the copied text. The
3950 optional argument MESSAGE-LEN, if non-nil, specifies the length
3951 of this sample text; it defaults to 40."
3954 ;; Inhibit quitting so we can make a quit here
3955 ;; look like a C-g typed as a command.
3958 ;; Swap point-and-mark quickly so as to show the region that
3959 ;; was selected. Don't do it if the region is highlighted.
3962 ;; Swap point and mark.
3966 ;; Swap back.
3969 ;; If user quit, deactivate the mark
3970 ;; as C-g would as a command.
3976 ;; Don't say "killed"; that is misleading.
3983 "Cause following command, if it kills, to add to previous kill.
3984 If the next command kills forward from point, the kill is
3985 appended to the previous killed text. If the command kills
3986 backward, the kill is prepended. Kill commands that act on the
3987 region, such as `kill-region', are regarded as killing forward if
3988 point is after mark, and killing backward if point is before
3989 mark.
3991 If the next command is not a kill command, `append-next-kill' has
3992 no effect.
3994 The argument is used for internal purposes; do not supply one."
3996 ;; We don't use (interactive-p), since that breaks kbd macros.
4002 \f
4003 ;; Yanking.
4008 "List of special text property handling conditions for yanking.
4009 Each element should have the form (PROP . FUN), where PROP is a
4010 property symbol and FUN is a function. When the `yank' command
4011 inserts text into the buffer, it scans the inserted text for
4012 stretches of text that have `eq' values of the text property
4013 PROP; for each such stretch of text, FUN is called with three
4014 arguments: the property's value in that text, and the start and
4015 end positions of the text.
4017 This is done prior to removing the properties specified by
4018 `yank-excluded-properties'."
4021 function))
4024 ;; This is actually used in subr.el but defcustom does not work there.
4027 intangible invisible keymap local-map mouse-face read-only
4028 yank-handler)
4029 "Text properties to discard when yanking.
4030 The value should be a list of text properties to discard or t,
4031 which means to discard all text properties.
4033 See also `yank-handled-properties'."
4040 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4041 Function is called with two parameters, START and END corresponding to
4042 the value of the mark and point; it is guaranteed that START <= END.
4046 "Replace just-yanked stretch of killed text with a different stretch.
4047 This command is allowed only immediately after a `yank' or a `yank-pop'.
4048 At such a time, the region contains a stretch of reinserted
4049 previously-killed text. `yank-pop' deletes that text and inserts in its
4050 place a different stretch of killed text.
4052 With no argument, the previous kill is inserted.
4053 With argument N, insert the Nth previous kill.
4054 If N is negative, this is a more recent kill.
4056 The sequence of kills wraps around, so that after the oldest one
4057 comes the newest one.
4059 When this command inserts killed text into the buffer, it honors
4060 `yank-excluded-properties' and `yank-handler' as described in the
4061 doc string for `insert-for-yank-1', which see."
4075 ;; Set the window start back where it was in the yank command,
4076 ;; if possible.
4079 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4080 ;; It is cleaner to avoid activation, even though the command
4081 ;; loop would deactivate the mark because we inserted text.
4084 nil)
4088 More precisely, reinsert the most recent kill, which is the
4089 stretch of killed text most recently killed OR yanked. Put point
4090 at the end, and set mark at the beginning without activating it.
4092 With argument N, reinsert the Nth most recent kill.
4094 When this command inserts text into the buffer, it honors the
4095 `yank-handled-properties' and `yank-excluded-properties'
4096 variables, and the `yank-handler' text property. See
4097 `insert-for-yank-1' for details.
4102 ;; If we don't get all the way thru, make last-command indicate that
4103 ;; for the following command.
4111 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4112 ;; It is cleaner to avoid activation, even though the command
4113 ;; loop would deactivate the mark because we inserted text.
4116 ;; If we do get all the way thru, make this-command indicate that.
4119 nil)
4122 "Rotate the yanking point in the kill ring.
4123 With ARG, rotate that many kills forward (or backward, if negative)."
4126 \f
4127 ;; Some kill commands.
4129 ;; Internal subroutine of delete-char
4135 ;; Internal subroutine of backward-delete-char
4142 "The method for untabifying when deleting backward.
4143 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4144 `hungry' -- delete all whitespace, both tabs and spaces;
4145 `all' -- delete all whitespace, including tabs, spaces and newlines;
4146 nil -- just delete one character."
4152 "Delete characters backward, changing tabs into spaces.
4153 The exact behavior depends on `backward-delete-char-untabify-method'.
4154 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4155 Interactively, ARG is the prefix arg (default 1)
4156 and KILLP is t if a prefix arg was specified."
4179 arg)))
4180 ;; Avoid warning about delete-backward-char
4184 "Kill up to and including ARGth occurrence of CHAR.
4185 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4186 Goes backward if ARG is negative; error if CHAR not found."
4189 ;; Avoid "obsolete" warnings for translation-table-for-input.
4197 ;; kill-line and its subroutines.
4200 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4205 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4206 With prefix argument ARG, kill that many lines from point.
4207 Negative arguments kill lines backward.
4208 With zero argument, kills the text before point on the current line.
4211 a number counts as a prefix arg.
4213 To kill a whole line, when point is not at the beginning, type \
4216 If `show-trailing-whitespace' is non-nil, this command will just
4217 kill the rest of the current line, even if there are only
4218 nonblanks there.
4220 If option `kill-whole-line' is non-nil, then this command kills the whole line
4221 including its terminating newline, when used at the beginning of a line
4222 with no argument. As a consequence, you can always kill a whole line
4225 If you want to append the killed line to the last killed text,
4228 If the buffer is read-only, Emacs will beep and refrain from deleting
4229 the line, but put the line in the kill ring anyway. This means that
4230 you can use this command to copy text from a read-only buffer.
4231 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4232 even beep.)"
4235 ;; It is better to move point to the other end of the kill
4236 ;; before killing. That way, in a read-only buffer, point
4237 ;; moves across the text that is copied to the kill ring.
4238 ;; The choice has no effect on undo now that undo records
4239 ;; the value of point from before the command was run.
4249 ;; If trailing whitespace is visible,
4250 ;; don't treat it as nothing.
4260 "Kill current line.
4261 With prefix ARG, kill that many lines starting from the current line.
4262 If ARG is negative, kill backward. Also kill the preceding newline.
4264 If ARG is zero, kill current line but exclude the trailing newline."
4275 ;; We need to kill in two steps, because the previous command
4276 ;; could have been a kill command, in which case the text
4277 ;; before point needs to be prepended to the current kill
4278 ;; ring entry and the text after point appended. Also, we
4279 ;; need to use save-excursion to avoid copying the same text
4280 ;; twice to the kill ring in read-only buffers.
4298 "Move forward by ARG lines, ignoring currently invisible newlines only.
4299 If ARG is negative, move backward -ARG lines.
4300 If ARG is zero, move to the beginning of the current line."
4307 ;; If the newline we just skipped is invisible,
4308 ;; don't count it.
4312 prop
4317 ;; If invisible text follows, and it is a number of complete lines,
4318 ;; skip it.
4324 prop
4340 ;; If the newline we just moved to is invisible,
4341 ;; don't count it.
4346 prop
4351 ;; If invisible text follows, and it is a number of complete lines,
4352 ;; skip it.
4358 prop
4369 nil)))
4372 "Move to end of current visible line."
4374 ;; If the following character is currently invisible,
4375 ;; skip all characters with that same `invisible' property value,
4376 ;; then find the next newline.
4383 prop
4392 \f
4394 "Insert after point the contents of BUFFER.
4395 Puts mark after the inserted text.
4396 BUFFER may be a buffer or a buffer name."
4406 t))))
4411 nil)
4414 "Append to specified buffer the text of the region.
4415 It is inserted into that buffer before its point.
4417 When calling from a program, give three arguments:
4418 BUFFER (or buffer name), START and END.
4419 START and END specify the portion of the current buffer to be copied."
4426 point)
4437 "Prepend to specified buffer the text of the region.
4438 It is inserted into that buffer after its point.
4440 When calling from a program, give three arguments:
4441 BUFFER (or buffer name), START and END.
4442 START and END specify the portion of the current buffer to be copied."
4451 "Copy to specified buffer the text of the region.
4452 It is inserted into that buffer, replacing existing text there.
4454 When calling from a program, give three arguments:
4455 BUFFER (or buffer name), START and END.
4456 START and END specify the portion of the current buffer to be copied."
4464 \f
4468 "Hook run when the mark becomes active.
4469 It is also run at the end of a command, if the mark is active and
4476 "Return this buffer's mark value as integer, or nil if never set.
4478 In Transient Mark mode, this function signals an error if
4479 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4480 or the argument FORCE is non-nil, it disregards whether the mark
4481 is active, and returns an integer or nil in the usual way.
4483 If you are using this in an editing command, you are most likely making
4484 a mistake; see the documentation of `set-mark'."
4489 ;; Behind display-selections-p.
4496 "Deactivate the mark.
4497 If Transient Mark mode is disabled, this function normally does
4498 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4500 Deactivating the mark sets `mark-active' to nil, updates the
4501 primary selection according to `select-active-regions', and runs
4502 `deactivate-mark-hook'.
4504 If Transient Mark mode was temporarily enabled, reset the value
4505 of the variable `transient-mark-mode'; if this causes Transient
4506 Mark mode to be disabled, don't change `mark-active' to nil or
4507 run `deactivate-mark-hook'."
4511 select-active-regions)
4514 ;; The var `saved-region-selection', if non-nil, is the text in
4515 ;; the region prior to the last command modifying the buffer.
4516 ;; Set the selection to that, or to the current region.
4520 ;; If another program has acquired the selection, region
4521 ;; deactivation should not clobber it (Bug#11772).
4540 "Activate the mark.
4541 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
4551 "Set this buffer's mark to POS. Don't use this function!
4552 That is to say, don't use this function unless you want
4553 the user to see that the mark has moved, and you want the previous
4554 mark position to be lost.
4556 Normally, when a new mark is set, the old one should go on the stack.
4557 This is why most applications should use `push-mark', not `set-mark'.
4559 Novice Emacs Lisp programmers often try to use the mark for the wrong
4560 purposes. The mark saves a location for the user's convenience.
4561 Most editing commands should not alter the mark.
4562 To remember a location for internal use in the Lisp program,
4563 store it in a Lisp variable. Example:
4565 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4570 ;; Normally we never clear mark-active except in Transient Mark mode.
4571 ;; But when we actually clear out the mark value too, we must
4572 ;; clear mark-active in any mode.
4574 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
4575 ;; it should never be nil if the mark is nil.
4581 If nil, region-aware commands treat empty regions as inactive.
4582 If non-nil, region-aware commands treat the region as active as
4583 long as the mark is active, even if the region is empty.
4585 Region-aware commands are those that act on the region if it is
4586 active and Transient Mark mode is enabled, and on the text near
4587 point otherwise."
4593 "Return t if the region is active and it is appropriate to act on it.
4594 This is used by commands that act specially on the region under
4595 Transient Mark mode.
4597 The return value is t if Transient Mark mode is enabled and the
4598 mark is active; furthermore, if `use-empty-active-region' is nil,
4599 the region must not be empty. Otherwise, the return value is nil.
4601 For some commands, it may be appropriate to ignore the value of
4602 `use-empty-active-region'; in that case, use `region-active-p'."
4607 "Return t if Transient Mark mode is enabled and the mark is active.
4609 Some commands act specially on the region when Transient Mark
4610 mode is enabled. Usually, such commands should use
4611 `use-region-p' instead of this function, because `use-region-p'
4612 also checks the value of `use-empty-active-region'."
4614 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
4615 ;; without the mark being set (e.g. bug#17324). We really should fix
4616 ;; that problem, but in the mean time, let's make sure we don't say the
4617 ;; region is active when there's no mark.
4631 ;; Normal priority so that a large region doesn't hide all the
4632 ;; overlays within it, but high secondary priority so that if it
4633 ;; ends/starts in the middle of a small overlay, that small overlay
4634 ;; won't hide the region's boundaries.
4636 nrol)
4641 rol)))
4654 start end window rol)))
4657 new)))))))
4682 "Maximum size of mark ring. Start discarding off end if gets this big."
4690 "Maximum size of global mark ring. \
4691 Start discarding off end if gets this big."
4696 "Jump to mark, and pop a new position for mark off the ring.
4697 \(Does not affect global mark ring)."
4707 "Set mark at where point is.
4708 If no prefix ARG and mark is already set there, just activate it.
4709 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4721 will pop the mark twice, and
4723 will pop the mark three times.
4731 "Set the mark where point is, or jump to the mark.
4732 Setting the mark also alters the region, which is the text
4733 between point and mark; this is the closest equivalent in
4736 With no prefix argument, set the mark at point, and push the
4737 old mark position on local mark ring. Also push the old mark on
4738 global mark ring, if the previous mark was set in another buffer.
4740 When Transient Mark Mode is off, immediately repeating this
4741 command activates `transient-mark-mode' temporarily.
4744 jump to the mark, and set the mark from
4745 position popped off the local mark ring (this does not affect the global
4747 mark ring (see `pop-global-mark').
4749 If `set-mark-command-repeat-pop' is non-nil, repeating
4751 off the local (or global) mark ring and jumps there.
4754 argument, unconditionally set mark where point is, even if
4755 `set-mark-command-repeat-pop' is non-nil.
4757 Novice Emacs Lisp programmers often try to use the mark for the wrong
4758 purposes. See the documentation of `set-mark' for more information."
4778 arg)
4792 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4793 If the last global mark pushed was not in the current buffer,
4794 also push LOCATION on the global mark ring.
4795 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4797 Novice Emacs Lisp programmers often try to use the mark for the wrong
4798 purposes. See the documentation of `set-mark' for more information.
4800 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4807 ;; Now push the mark on the global mark ring.
4810 ;; The last global mark pushed was in this same buffer.
4811 ;; Don't push another one.
4812 nil
4821 nil)
4824 "Pop off mark ring into the buffer's actual mark.
4825 Does not set point. Does nothing if mark ring is empty."
4837 "Put the mark where point is now, and point where the mark is now.
4838 This command works even when the mark is not active,
4839 and it reactivates the mark.
4841 If Transient Mark mode is on, a prefix ARG deactivates the mark
4842 if it is active, and otherwise avoids reactivating it. If
4843 Transient Mark mode is off, a prefix ARG enables Transient Mark
4844 mode temporarily."
4858 nil))
4861 "When non-nil, shifted motion keys activate the mark momentarily.
4863 While the mark is activated in this way, any shift-translated point
4864 motion key extends the region, and if Transient Mark mode was off, it
4865 is temporarily turned on. Furthermore, the mark will be deactivated
4866 by any subsequent point motion key that was not shift-translated, or
4867 by any action that normally deactivates the mark in Transient Mark mode.
4869 See `this-command-keys-shift-translated' for the meaning of
4870 shift-translation."
4875 "Activate/deactivate mark depending on invocation thru shift translation.
4876 This function is called by `call-interactively' when a command
4877 with a `^' character in its `interactive' spec is invoked, before
4878 running the command itself.
4880 If `shift-select-mode' is enabled and the command was invoked
4881 through shift translation, set the mark and activate the region
4882 temporarily, unless it was already set in this way. See
4883 `this-command-keys-shift-translated' for the meaning of shift
4884 translation.
4886 Otherwise, if the region has been activated temporarily,
4887 deactivate it, and restore the variable `transient-mark-mode' to
4888 its earlier value."
4895 transient-mark-mode)))
4904 "Toggle Transient Mark mode.
4905 With a prefix argument ARG, enable Transient Mark mode if ARG is
4906 positive, and disable it otherwise. If called from Lisp, enable
4907 Transient Mark mode if ARG is omitted or nil.
4909 Transient Mark mode is a global minor mode. When enabled, the
4910 region is highlighted whenever the mark is active. The mark is
4912 operations that set the mark but whose main purpose is something
4918 Many commands change their behavior when Transient Mark mode is
4919 in effect and the mark is active, by acting on the region instead
4920 of their usual default part of the buffer's text. Examples of
4923 To see the documentation of commands which are sensitive to the
4926 :global t
4927 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4931 "Non-nil means it is ok for commands to call `widen' when they want to.
4932 Some commands will do this in order to go to positions outside
4933 the current accessible part of the buffer.
4935 If `widen-automatically' is nil, these commands will do something else
4939 "Whether the currently executing code is performing an essential task.
4940 This variable should be non-nil only when running code which should not
4941 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4942 user for a password when we are simply scanning a set of files in the
4943 background or displaying possible completions before the user even asked
4947 "Pop off global mark ring and jump to the top location."
4949 ;; Pop entries which refer to non-existent buffers.
4967 \f
4969 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4975 "Move cursor vertically down ARG lines.
4976 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4977 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4978 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4979 function will not vscroll.
4981 ARG defaults to 1.
4983 If there is no character in the target line exactly under the current column,
4984 the cursor is positioned after the character in that line which spans this
4985 column, or at the end of the line if it is not long enough.
4986 If there is no line in the buffer after this one, behavior depends on the
4987 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4988 to create a line, and moves the cursor to that line. Otherwise it moves the
4989 cursor to the end of the buffer.
4991 If the variable `line-move-visual' is non-nil, this command moves
4992 by display lines. Otherwise, it moves by buffer lines, without
4993 taking variable-width characters or continued lines into account.
4996 a semipermanent goal column for this command.
4997 Then instead of trying to move exactly vertically (or as close as possible),
4998 this command moves to the specified goal column (or as close as possible).
4999 The goal column is stored in the variable `goal-column', which is nil
5000 when there is no goal column. Note that setting `goal-column'
5001 overrides `line-move-visual' and causes this command to move by buffer
5002 lines rather than by display lines."
5008 ;; When adding a newline, don't expand an abbrev.
5019 nil)
5022 "Move cursor vertically up ARG lines.
5023 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5024 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5025 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5026 function will not vscroll.
5028 ARG defaults to 1.
5030 If there is no character in the target line exactly over the current column,
5031 the cursor is positioned after the character in that line which spans this
5032 column, or at the end of the line if it is not long enough.
5034 If the variable `line-move-visual' is non-nil, this command moves
5035 by display lines. Otherwise, it moves by buffer lines, without
5036 taking variable-width characters or continued lines into account.
5039 a semipermanent goal column for this command.
5040 Then instead of trying to move exactly vertically (or as close as possible),
5041 this command moves to the specified goal column (or as close as possible).
5042 The goal column is stored in the variable `goal-column', which is nil
5043 when there is no goal column. Note that setting `goal-column'
5044 overrides `line-move-visual' and causes this command to move by buffer
5045 lines rather than by display lines."
5056 nil)
5059 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5060 This means moving to the end of each line moved onto.
5061 The beginning of a blank line does not count as the end of a line.
5062 This has no effect when the variable `line-move-visual' is non-nil."
5068 A non-nil setting overrides the variable `line-move-visual', which see."
5075 "Current goal column for vertical motion.
5076 It is the column where point was at the start of the current run
5077 of vertical motion commands.
5079 When moving by visual lines via the function `line-move-visual', it is a cons
5080 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5081 divided by the default column width, and HSCROLL is the number of
5082 columns by which window is scrolled from left margin.
5084 When the `track-eol' feature is doing its job, the value is
5088 "Non-nil means commands that move by lines ignore invisible newlines.
5089 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5090 as if newlines that are invisible didn't exist, and count
5091 only visible newlines. Thus, moving across across 2 newlines
5092 one of which is invisible will be counted as a one-line move.
5093 Also, a non-nil value causes invisible text to be ignored when
5094 counting columns for the purposes of keeping point in the same
5097 Outline mode sets this."
5102 "When non-nil, `line-move' moves point by visual lines.
5103 This movement is based on where the cursor is displayed on the
5104 screen, instead of relying on buffer contents alone. It takes
5105 into account variable-width characters and line continuation.
5106 If nil, `line-move' moves point by logical lines.
5107 A non-nil setting of `goal-column' overrides the value of this variable
5108 and forces movement by logical lines.
5109 A window that is horizontally scrolled also forces movement by logical
5110 lines."
5115 ;; Only used if display-graphic-p.
5119 "Return the height in pixels of the current buffer's default face font."
5123 ;; Avoid calling font-info if the frame's default font was
5124 ;; not changed since the frame was created. That's because
5125 ;; font-info is expensive for some fonts, see bug #14838.
5131 "Return the pixel height of current buffer's default-face text line.
5133 The value includes `line-spacing', if any, defined for the buffer
5134 or the frame."
5147 "Return the number of screen lines in the text area of the selected window.
5149 This is different from `window-text-height' in that this function counts
5150 lines in units of the height of the font used by the default face displayed
5151 in the window, not in units of the frame's default font, and also accounts
5152 for `line-spacing', if any, defined for the window's buffer or frame.
5154 The value is a floating-point number."
5160 ;; Returns non-nil if partial move was done.
5163 ;; Move backward (up).
5164 ;; If already vscrolled, reduce vscroll
5170 ;; Move forward (down).
5183 py vs last-line)
5203 col-row)
5208 ;; VPOS > 0 means the last line is only partially visible.
5209 ;; But if the part that is visible is at least as tall as the
5210 ;; default font, that means the line is actually fully
5211 ;; readable, and something like line-spacing is hidden. So in
5212 ;; that case we accept the last line in the window as still
5213 ;; visible, and consider the margin as starting one line
5214 ;; later.
5222 ;; If last line of window is fully visible, and vscrolling
5223 ;; more would make this line invisible, move forward.
5228 nil)
5229 ;; If cursor is not in the bottom scroll margin, and the
5230 ;; current line is is not too tall, move forward.
5232 vpos
5235 nil)
5236 ;; When already vscrolled, we vscroll some more if we can,
5237 ;; or clear vscroll and move forward at end of tall image.
5242 ;; If cursor just entered the bottom scroll margin, move forward,
5243 ;; but also optionally vscroll one line so redisplay won't recenter.
5247 ;; Don't vscroll if the partially-visible line at window
5248 ;; bottom is not too tall (a.k.a. "just one more text
5249 ;; line"): in that case, we do want redisplay to behave
5250 ;; normally, i.e. recenter or whatever.
5251 ;;
5252 ;; Note: ROWH + RBOT from the value returned by
5253 ;; pos-visible-in-window-p give the total height of the
5254 ;; partially-visible glyph row at the end of the window. As
5255 ;; we are dealing with floats, we disregard sub-pixel
5256 ;; discrepancies between that and DLH.
5260 t)
5261 ;; If there are lines above the last line, scroll-up one line.
5264 t)
5265 ;; Finally, start vscroll.
5270 ;; This is like line-move-1 except that it also performs
5271 ;; vertical scrolling of tall images if appropriate.
5272 ;; That is not really a clean thing to do, since it mixes
5273 ;; scrolling with cursor motion. But so far we don't have
5274 ;; a cleaner solution to the problem of making C-n do something
5275 ;; useful given a tall image.
5277 "Move forward ARG lines.
5278 If NOERROR, don't signal an error if we can't move ARG lines.
5279 TO-END is unused.
5280 TRY-VSCROLL controls whether to vscroll tall lines: if either
5281 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5282 not vscroll."
5286 ;; Only vscroll for single line moves
5288 ;; Under scroll-conservatively, the display engine
5289 ;; does this better.
5291 ;; But don't vscroll in a keyboard macro.
5297 ;; Display-based column are incompatible with goal-column.
5299 ;; When the text in the window is scrolled to the left,
5300 ;; display-based motion doesn't make sense (because each
5301 ;; logical line occupies exactly one screen line).
5303 ;; Likewise when the text _was_ scrolled to the left
5304 ;; when the current run of vertical motion commands
5305 ;; started.
5308 auto-hscroll-mode
5310 (>= temporary-goal-column
5313 ;; If we moved into a tall line, set vscroll to make
5314 ;; scrolling through tall images more smooth.
5318 winh)
5324 nil
5328 ;; Display-based alternative to line-move-1.
5329 ;; Arg says how many lines to move. The value is t if we can move the
5330 ;; specified number of lines.
5332 "Move ARG lines forward.
5333 If NOERROR, don't signal an error if we can't move that many lines."
5336 target-hscroll)
5337 ;; Check if the previous command was a line-motion command, or if
5338 ;; we were called from some other command.
5341 ;; If so, there's no need to reset `temporary-goal-column',
5342 ;; but we may need to hscroll.
5346 ;; Otherwise, we should reset `temporary-goal-column'.
5349 ;; Handle the `overflow-newline-into-fringe' case:
5358 ;; vertical-motion can move more than it was asked to if it moves
5359 ;; across display strings with newlines. We don't want to ring
5360 ;; the bell and announce beginning/end of buffer in that case.
5366 temporary-goal-column))
5367 arg))
5368 arg))
5374 temporary-goal-column))
5375 arg))
5376 arg)))
5379 ;; If the goal column lies on a display string,
5380 ;; `vertical-motion' advances the cursor to the end
5381 ;; of the string. For arg < 0, this can cause the
5382 ;; cursor to get stuck. (Bug#3020).
5386 nil)))))
5388 ;; This is the guts of next-line and previous-line.
5389 ;; Arg says how many lines to move.
5390 ;; The value is t if we can move the specified number of lines.
5392 ;; Don't run any point-motion hooks, and disregard intangibility,
5393 ;; for intermediate positions.
5405 ;; Don't count beg of empty line as end of line
5406 ;; unless we just did explicit end-of-line.
5408 most-positive-fixnum
5412 line-move-ignore-invisible))
5413 ;; Use just newline characters.
5414 ;; Set ARG to 0 if we move as many lines as requested.
5417 ;; This way of moving forward ARG lines
5418 ;; verifies that we have a newline after the last one.
5419 ;; It doesn't get confused by intangible text.
5428 'beginning-of-buffer
5430 nil)))
5431 ;; Move by arg lines, but ignore invisible ones.
5434 ;; If the following character is currently invisible,
5435 ;; skip all characters with that same `invisible' property value.
5438 ;; Move a line.
5439 ;; We don't use `end-of-line', since we want to escape
5440 ;; from field boundaries occurring exactly at point.
5446 ;; If there's no invisibility here, move over the newline.
5455 ;; We avoid vertical-motion when possible
5456 ;; because that has to fontify.
5458 ;; Otherwise move a more sophisticated way.
5465 ;; The logic of this is the same as the loop above,
5466 ;; it just goes in the other direction.
5468 ;; For completely consistency with the forward-motion
5469 ;; case, we should call beginning-of-line here.
5470 ;; However, if point is inside a field and on a
5471 ;; continued line, the call to (vertical-motion -1)
5472 ;; below won't move us back far enough; then we return
5473 ;; to the same column in line-move-finish, and point
5474 ;; gets stuck -- cyd
5492 ;; if our target is the middle of this line.
5497 ;; This is the value the function returns.
5501 ;; If we did not move down as far as desired, at least go
5502 ;; to end of line. Be sure to call point-entered and
5503 ;; point-left-hooks.
5509 ;; If we did not move up as far as desired,
5510 ;; at least go to beginning of line.
5522 ;; Set REPEAT to t to repeat the whole thing.
5529 ;; Compute the end of the line
5530 ;; ignoring effectively invisible newlines.
5532 ;; Like end-of-line but ignores fields.
5539 ;; Move to the desired column.
5542 ;; Corner case: suppose we start out in a field boundary in
5543 ;; the middle of a continued line. When we get to
5544 ;; line-move-finish, point is at the start of a new *screen*
5545 ;; line but the same text line; then line-move-to-column would
5546 ;; move us backwards. Test using C-n with point on the "x" in
5547 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5554 ;; Process intangibility within a line.
5555 ;; With inhibit-point-motion-hooks bound to nil, a call to
5556 ;; goto-char moves point past intangible text.
5558 ;; However, inhibit-point-motion-hooks controls both the
5559 ;; intangibility and the point-entered/point-left hooks. The
5560 ;; following hack avoids calling the point-* hooks
5561 ;; unnecessarily. Note that we move *forward* past intangible
5562 ;; text when the initial and final points are the same.
5567 ;; If intangibility moves us to a different (later) place
5568 ;; in the same line, use that as the destination.
5571 ;; If that position is "too late",
5572 ;; try the previous allowable position.
5573 ;; See if it is ok.
5576 ;; If going forward, don't accept the previous
5577 ;; allowable position if it is before the target line.
5579 ;; If going backward, don't accept the previous
5580 ;; allowable position if it is still after the target line.
5583 ;; As a last resort, use the end of the line.
5586 ;; Now move to the updated destination, processing fields
5587 ;; as well as intangibility.
5591 ;; Ignore field boundaries if the initial and final
5592 ;; positions have the same `field' property, even if the
5593 ;; fields are non-contiguous. This seems to be "nicer"
5594 ;; behavior in many situations.
5597 new
5601 ;; If all this moved us to a different line,
5602 ;; retry everything within that new line.
5604 ;; Repeat the intangibility and field processing.
5608 "Try to find column COL, considering invisibility.
5609 This function works only in certain cases,
5610 because what we really need is for `move-to-column'
5611 and `current-column' to be able to ignore invisible text."
5620 ;; If the following character is currently invisible,
5621 ;; skip all characters with that same `invisible' property value.
5625 ;; Have we advanced to a larger column position?
5627 ;; We have made some progress towards the desired column.
5628 ;; See if we can make any further progress.
5630 ;; Otherwise, go to the place we originally found
5631 ;; and move back over invisible text.
5632 ;; that will get us to the same place on the screen
5633 ;; but with a more reasonable buffer position.
5640 "Move point to end of current line as displayed.
5641 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5642 If point reaches the beginning or end of buffer, it stops there.
5644 To ignore the effects of the `intangible' text or overlay
5645 property, bind `inhibit-point-motion-hooks' to t.
5646 If there is an image in the current line, this function
5647 disregards newlines that are part of the text on which the image
5648 rests."
5658 ;; With bidi reordering, we may not be at bol,
5659 ;; so make sure we are.
5674 ;; If we skipped something intangible and now we're not
5675 ;; really at eol, keep going.
5680 "Move point to beginning of current line as displayed.
5681 \(If there's an image in the line, this disregards newlines
5682 which are part of the text that the image rests on.)
5684 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5685 If point reaches the beginning or end of buffer, it stops there.
5686 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5691 first-vis first-vis-field-value)
5693 ;; Move by lines, if ARG is not 1 (the default).
5698 ;; Move to beginning-of-line, ignoring fields and invisible text.
5704 ;; Now find first visible char in the line.
5709 ;; See if fields would stop us from reaching FIRST-VIS.
5714 ;; If yes, obey them.
5715 first-vis-field-value
5716 ;; Otherwise, move to START with attention to fields.
5717 ;; (It is possible that fields never matter in this case.)
5722 ;; Many people have said they rarely use this feature, and often type
5723 ;; it by accident. Maybe it shouldn't even be on a key.
5728 Those commands will move to this position in the line moved to
5729 rather than trying to keep the same horizontal position.
5730 With a non-nil argument ARG, clears out the goal column
5732 The goal column is stored in the variable `goal-column'."
5739 ;; The older method below can be erroneous if `set-goal-column' is bound
5740 ;; to a sequence containing %
5741 ;;(message (substitute-command-keys
5742 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
5743 ;;goal-column)
5750 )
5751 nil)
5752 \f
5753 ;;; Editing based on visual lines, as opposed to logical lines.
5756 "Move point to end of current visual line.
5757 With argument N not nil or 1, move forward N - 1 visual lines first.
5758 If point reaches the beginning or end of buffer, it stops there.
5759 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5765 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5766 ;; constrain to field boundaries, so we don't either.
5770 "Move point to beginning of current visual line.
5771 With argument N not nil or 1, move forward N - 1 visual lines first.
5772 If point reaches the beginning or end of buffer, it stops there.
5773 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5781 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5785 "Kill the rest of the visual line.
5786 With prefix argument ARG, kill that many visual lines from point.
5787 If ARG is negative, kill visual lines backward.
5788 If ARG is zero, kill the text before point on the current visual
5789 line.
5791 If you want to append the killed line to the last killed text,
5794 If the buffer is read-only, Emacs will beep and refrain from deleting
5795 the line, but put the line in the kill ring anyway. This means that
5796 you can use this command to copy text from a read-only buffer.
5797 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5798 even beep.)"
5800 ;; Like in `kill-line', it's better to move point to the other end
5801 ;; of the kill before killing.
5809 ;; Skip any trailing whitespace at the end of the visual line.
5810 ;; We used to do this only if `show-trailing-whitespace' is
5811 ;; nil, but that's wrong; the correct thing would be to check
5812 ;; whether the trailing whitespace is highlighted. But, it's
5813 ;; OK to just do this unconditionally.
5820 "Move cursor vertically down ARG lines.
5821 This is identical to `next-line', except that it always moves
5822 by logical lines instead of visual lines, ignoring the value of
5823 the variable `line-move-visual'."
5830 "Move cursor vertically up ARG lines.
5831 This is identical to `previous-line', except that it always moves
5832 by logical lines instead of visual lines, ignoring the value of
5833 the variable `line-move-visual'."
5840 "Editing based on visual lines."
5849 ;; These keybindings interfere with xterm function keys. Are
5850 ;; there any other suitable bindings?
5851 ;; (define-key map "\M-[" 'previous-logical-line)
5852 ;; (define-key map "\M-]" 'next-logical-line)
5853 map))
5856 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5857 The value should be a list of the form (LEFT RIGHT), where LEFT
5858 and RIGHT are symbols representing the bitmaps to display, to
5859 indicate wrapped lines, in the left and right fringes respectively.
5860 See also `fringe-indicator-alist'.
5861 The default is not to display fringe indicators for wrapped lines.
5862 This variable does not affect fringe indicators displayed for
5863 other purposes."
5878 'continuation
5885 "Toggle visual line based editing (Visual Line mode).
5886 With a prefix argument ARG, enable Visual Line mode if ARG is
5887 positive, and disable it otherwise. If called from Lisp, enable
5888 the mode if ARG is omitted or nil.
5890 When Visual Line mode is enabled, `word-wrap' is turned on in
5891 this buffer, and simple editing commands are redefined to act on
5892 visual lines, not logical lines. See Info node `Visual Line
5893 Mode' for details."
5894 :keymap visual-line-mode-map
5900 ;; Save the local values of some variables, to be restored if
5901 ;; visual-line-mode is turned off.
5903 truncate-partial-width-windows
5904 word-wrap fringe-indicator-alist))
5907 visual-line--saved-state)))
5911 word-wrap t
5912 fringe-indicator-alist
5914 fringe-indicator-alist)))
5928 visual-line-mode turn-on-visual-line-mode)
5930 \f
5932 "Interchange characters around point, moving forward one character.
5933 With prefix arg ARG, effect is to take character before point
5934 and drag it forward past ARG other characters (backward if ARG negative).
5935 If no argument and at end of line, the previous two chars are exchanged."
5943 "Interchange words around point, leaving point at end of them.
5944 With prefix arg ARG, effect is to take word before or around point
5945 and drag it forward past ARG other words (backward if ARG negative).
5946 If ARG is zero, the words around or after point and around or after mark
5947 are interchanged."
5948 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5954 Does not work on a sexp that point is in the middle of
5955 if it is a list or string."
5959 ;; Here we should try to simulate the behavior of
5960 ;; (cons (progn (forward-sexp x) (point))
5961 ;; (progn (forward-sexp (- x)) (point)))
5962 ;; Except that we don't want to rely on the second forward-sexp
5963 ;; putting us back to where we want to be, since forward-sexp-function
5964 ;; might do funny things like infix-precedence.
5969 ;; Jumping over a symbol. We might be inside it, mind you.
5974 ;; Otherwise, we're between sexps. Take a step back before jumping
5975 ;; to make sure we'll obey the same precedence no matter which direction
5976 ;; we're going.
5981 'skip-syntax-forward
5988 "Exchange current line and previous line, leaving point after both.
5989 With argument ARG, takes previous line and moves it past ARG lines.
5990 With argument 0, interchanges line point is in with line mark is in."
5996 ;; Move forward over ARG lines,
5997 ;; but create newlines if necessary.
6004 arg))
6006 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6007 ;; which seems inconsistent with the ARG /= 0 case.
6008 ;; FIXME document SPECIAL.
6010 "Subroutine to do the work of transposing objects.
6011 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6012 moves forward by units of the given object (e.g. forward-sentence,
6013 forward-paragraph). If ARG is zero, exchanges the current object
6014 with the one containing mark. If ARG is an integer, moves the
6015 current object past ARG following (if ARG is positive) or
6016 preceding (if ARG is negative) objects, leaving point after the
6017 current object."
6022 pos1 pos2)
6050 ;; This sequence of insertions attempts to preserve marker
6051 ;; positions at the start and end of the transposed objects.
6065 \f
6067 "Move backward until encountering the beginning of a word.
6068 With argument ARG, do this that many times.
6069 If ARG is omitted or nil, move point backward one word."
6074 "Set mark ARG words away from point.
6076 move to with the same argument.
6077 Interactively, if this command is repeated
6078 or (in Transient Mark mode) if the mark is active,
6079 it marks the next ARG words after the ones already marked."
6096 nil t))))
6099 "Kill characters forward until encountering the end of a word.
6100 With argument ARG, do this that many times."
6105 "Kill characters backward until encountering the beginning of a word.
6106 With argument ARG, do this that many times."
6111 "Return the symbol or word that point is on (or a nearby one) as a string.
6112 The return value includes no text properties.
6113 If optional arg STRICT is non-nil, return nil unless point is within
6114 or adjacent to a symbol or word. In all cases the value can be nil
6115 if there is no word nearby.
6116 The function, belying its name, normally finds a symbol.
6117 If optional arg REALLY-WORD is non-nil, it finds just a word."
6126 ;; Point is neither within nor adjacent to a word.
6128 ;; Look for preceding word in same line.
6131 ;; No preceding word in same line.
6132 ;; Look for following word in same line.
6141 ;; If we found something nonempty, return it as a string.
6144 \f
6146 "String for filling to insert at front of new line, or nil for none."
6148 string)
6154 "Regexp to match lines which should not be auto-filled."
6156 regexp)
6160 "The default value for `normal-auto-fill-function'.
6161 This is the default auto-fill function, some major modes use a different one.
6162 Returns t if it really did any work."
6172 nil ;; Auto-filling not required
6176 ;; Choose a fill-prefix automatically.
6184 ;; Use auto-indentation rather than a guessed empty prefix.
6190 ;; Determine where to split the line.
6203 ;; See whether the place we found is any good.
6207 ;; There is no use breaking at end of line.
6209 ;; It is futile to split at the end of the prefix
6210 ;; since we would just insert the prefix again.
6212 ;; Don't split right after a comment starter
6213 ;; since we would just make another comment starter.
6218 limit t)
6220 ;; No good place to break => stop trying.
6222 ;; Ok, we have a useful place to break the line. Do it.
6224 ;; If point is at the fill-point, do not `save-excursion'.
6225 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6226 ;; point will end up before it rather than after it.
6234 ;; Now do justification, if required
6239 ;; If making the new line didn't reduce the hpos of
6240 ;; the end of the line, then give up now;
6241 ;; trying again will not help.
6244 ;; Justify last line.
6246 t)))
6249 "Mode-specific function which line breaks and continues a comment.
6250 This function is called during auto-filling when a comment syntax
6251 is defined.
6252 The function should take a single optional argument, which is a flag
6256 "Break line at point and indent.
6257 If a comment syntax is defined, call `comment-indent-new-line'.
6259 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6260 unless optional argument SOFT is non-nil."
6264 ;; Insert the newline before removing empty space so that markers
6265 ;; get preserved better.
6271 ;; Blindly trust a non-adaptive fill-prefix.
6277 ;; If there's an adaptive prefix, use it unless we're inside
6278 ;; a comment and the prefix is not a comment starter.
6282 ;; If we're not inside a comment, just try to indent.
6286 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6290 ;; `functions' and `hooks' are usually unsafe to set, but setting
6291 ;; auto-fill-function to nil in a file-local setting is safe and
6292 ;; can be useful to prevent auto-filling.
6296 "Toggle automatic line breaking (Auto Fill mode).
6297 With a prefix argument ARG, enable Auto Fill mode if ARG is
6298 positive, and disable it otherwise. If called from Lisp, enable
6299 the mode if ARG is omitted or nil.
6301 When Auto Fill mode is enabled, inserting a space at a column
6302 beyond `current-fill-column' automatically breaks the line at a
6303 previous space.
6305 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6306 non-`nil'.
6308 The value of `normal-auto-fill-function' specifies the function to use
6309 for `auto-fill-function' when turning Auto Fill mode on."
6314 ;; This holds a document string used to document auto-fill-mode.
6316 "Automatically break line at a previous space, in insertion of text."
6317 nil)
6320 "Unconditionally turn on Auto Fill mode."
6324 "Unconditionally turn off Auto Fill mode."
6330 "Set `fill-column' to specified argument.
6335 ;; We used to use current-column silently, but C-x f is too easily
6336 ;; typed as a typo for C-x C-f, so we turned it into an error and
6337 ;; now an interactive prompt.
6342 ;; Disallow missing argument; it's probably a typo for C-x C-f.
6346 \f
6348 "Set `selective-display' to ARG; clear it if no arg.
6349 When the value of `selective-display' is a number > 0,
6350 lines whose indentation is >= that value are not displayed.
6351 The variable `selective-display' has a separate value for each buffer."
6371 "Toggle truncating of long lines for the current buffer.
6372 When truncating is off, long lines are folded.
6373 With prefix argument ARG, truncate long lines if ARG is positive,
6374 otherwise fold them. Note that in side-by-side windows, this
6375 command has no effect if `truncate-partial-width-windows' is
6376 non-nil."
6388 nil t)))
6393 "Toggle whether to use word-wrapping for continuation lines.
6394 With prefix argument ARG, wrap continuation lines at word boundaries
6395 if ARG is positive, otherwise wrap them at the right screen edge.
6396 This command toggles the value of `word-wrap'. It has no effect
6397 if long lines are truncated."
6413 "Toggle Overwrite mode.
6414 With a prefix argument ARG, enable Overwrite mode if ARG is
6415 positive, and disable it otherwise. If called from Lisp, enable
6416 the mode if ARG is omitted or nil.
6418 When Overwrite mode is enabled, printing characters typed in
6419 replace existing text on a one-for-one basis, rather than pushing
6420 it to the right. At the end of a line, such characters extend
6421 the line. Before a tab, such characters insert until the tab is
6423 overwrite mode; this is supposed to make it easier to insert
6424 characters when necessary."
6429 "Toggle Binary Overwrite mode.
6430 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6431 is positive, and disable it otherwise. If called from Lisp,
6432 enable the mode if ARG is omitted or nil.
6434 When Binary Overwrite mode is enabled, printing characters typed
6435 in replace existing text. Newlines are not treated specially, so
6436 typing at the end of a line joins the line to the next, with the
6437 typed character between them. Typing before a tab character
6438 simply replaces the tab with the character typed.
6440 ordinary typing characters do.
6442 Note that Binary Overwrite mode is not its own minor mode; it is
6443 a specialization of overwrite mode, entered by setting the
6444 `overwrite-mode' variable to `overwrite-mode-binary'."
6449 "Toggle line number display in the mode line (Line Number mode).
6450 With a prefix argument ARG, enable Line Number mode if ARG is
6451 positive, and disable it otherwise. If called from Lisp, enable
6452 the mode if ARG is omitted or nil.
6454 Line numbers do not appear for very large buffers and buffers
6455 with very long lines; see variables `line-number-display-limit'
6456 and `line-number-display-limit-width'."
6460 "Toggle column number display in the mode line (Column Number mode).
6461 With a prefix argument ARG, enable Column Number mode if ARG is
6462 positive, and disable it otherwise.
6464 If called from Lisp, enable the mode if ARG is omitted or nil."
6468 "Toggle buffer size display in the mode line (Size Indication mode).
6469 With a prefix argument ARG, enable Size Indication mode if ARG is
6470 positive, and disable it otherwise.
6472 If called from Lisp, enable the mode if ARG is omitted or nil."
6476 "Toggle auto-saving in the current buffer (Auto Save mode).
6477 With a prefix argument ARG, enable Auto Save mode if ARG is
6478 positive, and disable it otherwise.
6480 If called from Lisp, enable the mode if ARG is omitted or nil."
6482 ;; If auto-save is off because buffer has shrunk,
6483 ;; then toggling should turn it on.
6491 buffer-file-name)
6493 ;; If -1 was stored here, to temporarily turn off saving,
6494 ;; turn it back on.
6497 \f
6499 "Blinking matching of parens and expressions."
6504 "Non-nil means show matching open-paren when close-paren is inserted.
6505 If t, highlight the paren. If `jump', move cursor to its position."
6513 "Non-nil means show matching open-paren when it is on screen.
6514 If nil, don't show it (but the open-paren can still be shown
6515 when it is off screen).
6517 This variable has no effect if `blink-matching-paren' is nil.
6518 \(In that case, the open-paren is never shown.)
6519 It is also ignored if `show-paren-mode' is enabled."
6524 "If non-nil, maximum distance to search backwards for matching open-paren.
6525 If nil, search stops at the beginning of the accessible portion of the buffer."
6531 "Time in seconds to delay after showing a matching paren."
6536 "If nil, `blink-matching-paren' ignores comments.
6537 More precisely, when looking for the matching parenthesis,
6538 it skips the contents of comments that end before point."
6543 "Return whether or not START...END are matching parens.
6544 END is the current point and START is the blink position.
6545 START might be nil if no matching starter was found.
6546 Returns non-nil if we find there is a mismatch."
6551 ;; For self-matched chars like " and $, we can't know when they're
6552 ;; mismatched or unmatched, so we can only do it for parens.
6557 ;; The cdr might hold a new paren-class info rather than
6558 ;; a matching-char info, in which case the two CDRs
6559 ;; should match.
6563 "Function to check parentheses mismatches.
6564 The function takes two arguments (START and END) where START is the
6565 position just before the opening token and END is the position right after.
6566 START can be nil, if it was not found.
6573 ol)
6577 "Momentarily highlight the beginning of the sexp before point."
6580 blink-matching-paren)
6590 oldpos))
6598 ;; backward-sexp skips backward over prefix chars,
6599 ;; so move back to the matching paren.
6620 ;; Matching open within window, temporarily move to or highlight
6621 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
6622 ;; is non-nil.
6639 ;; Show what precedes the open in its line, if anything.
6644 ;; Show what follows the open in its line, if anything.
6651 ;; Otherwise show the previous nonblank line,
6652 ;; if there is one.
6661 ;; Replace the newline and other whitespace with `...'.
6662 "..."
6664 ;; There is nothing to show except the char itself.
6670 "Function called, if non-nil, whenever a close parenthesis is inserted.
6676 blink-paren-function
6679 ;; Verify an even number of quoting characters precede the close.
6690 ;; Most likely, this hook is nil, so this arg doesn't matter,
6691 ;; but I use it as a reminder that this function usually
6692 ;; likes to be run after others since it does
6693 ;; `sit-for'. That's also the reason it get a `priority' prop
6694 ;; of 100.
6696 \f
6697 ;; This executes C-g typed while Emacs is waiting for a command.
6698 ;; Quitting out of a program does not go through here;
6699 ;; that happens in the QUIT macro at the C code level.
6701 "Signal a `quit' condition.
6702 During execution of Lisp code, this character causes a quit directly.
6703 At top-level, as an editor command, this simply beeps."
6705 ;; Avoid adding the region to the window selection.
6713 ;; Force the next redisplay cycle to remove the "Def" indicator from
6714 ;; all the mode lines.
6728 This command can exit an interactive command such as `query-replace',
6729 can clear out a prefix argument or a region,
6730 can get out of the minibuffer or other recursive edit,
6731 cancel the use of the current buffer (for special-purpose buffers),
6732 or go back to just one window (by deleting all but the selected window)."
6740 nil)
6751 "Play sound stored in FILE.
6752 VOLUME and DEVICE correspond to the keywords of the sound
6753 specification for `play-sound'."
6763 \f
6765 "Your preference for a mail reading package.
6766 This is used by some keybindings which support reading mail.
6767 See also `mail-user-agent' concerning sending mail."
6777 "Your preference for a mail composition package.
6778 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6779 outgoing email message. This variable lets you specify which
6780 mail-sending package you prefer.
6782 Valid values include:
6784 `message-user-agent' -- use the Message package.
6785 See Info node `(message)'.
6786 `sendmail-user-agent' -- use the Mail package.
6787 See Info node `(emacs)Sending Mail'.
6788 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6789 See Info node `(mh-e)'.
6790 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6791 paraphernalia if Gnus is running, particularly
6792 the Gcc: header for archiving.
6794 Additional valid symbols may be available; check with the author of
6795 your package for details. The function should return non-nil if it
6796 succeeds.
6798 See also `read-mail-command' concerning reading mail."
6801 message-user-agent)
6804 sendmail-user-agent)
6807 mh-e-user-agent)
6810 gnus-user-agent)
6816 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6817 If the value of `mail-user-agent' is the default, and the user
6818 appears to have customizations applying to the old default,
6819 `compose-mail' issues a warning."
6825 "If the buffer starts with a mail header, move point to the header's end.
6826 Otherwise, moves to `point-min'.
6827 The end of the header is the start of the next line, if there is one,
6828 else the end of the last line. This function obeys RFC822."
6834 ;; Used by Rmail (e.g., rmail-forward).
6836 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6840 switch-function yank-action send-actions
6841 return-action)
6842 "Start composing a mail message to send.
6843 This uses the user's chosen mail composition package
6844 as selected with the variable `mail-user-agent'.
6845 The optional arguments TO and SUBJECT specify recipients
6846 and the initial Subject field, respectively.
6848 OTHER-HEADERS is an alist specifying additional
6849 header fields. Elements look like (HEADER . VALUE) where both
6850 HEADER and VALUE are strings.
6852 CONTINUE, if non-nil, says to continue editing a message already
6853 being composed. Interactively, CONTINUE is the prefix argument.
6855 SWITCH-FUNCTION, if non-nil, is a function to use to
6856 switch to and display the buffer used for mail composition.
6858 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6859 to insert the raw text of the message being replied to.
6860 It has the form (FUNCTION . ARGS). The user agent will apply
6861 FUNCTION to ARGS, to insert the raw text of the original message.
6862 \(The user agent will also run `mail-citation-hook', *after* the
6863 original text has been inserted in this way.)
6865 SEND-ACTIONS is a list of actions to call when the message is sent.
6866 Each action has the form (FUNCTION . ARGS).
6868 RETURN-ACTION, if non-nil, is an action for returning to the
6869 caller. It has the form (FUNCTION . ARGS). The function is
6870 called after the mail has been sent or put aside, and the mail
6871 buffer buried."
6875 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6876 ;; from sendmail-user-agent to message-user-agent. Some users may
6877 ;; encounter incompatibilities. This hack tries to detect problems
6878 ;; and warn about them.
6883 mail-yank-hooks mail-archive-file-name
6884 mail-default-reply-to mail-mailing-lists
6885 mail-self-blind))
6892 The default mail mode is now Message mode.
6893 You have the following Mail mode variable%s customized:
6895 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6902 yank-action send-actions return-action)))
6905 yank-action send-actions
6906 return-action)
6910 'switch-to-buffer-other-window yank-action send-actions
6911 return-action))
6914 yank-action send-actions
6915 return-action)
6919 'switch-to-buffer-other-frame yank-action send-actions
6920 return-action))
6922 \f
6924 "History of values entered with `set-variable'.
6926 Maximum length of the history list is determined by the value
6930 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6931 VARIABLE should be a user option variable name, a Lisp variable
6932 meant to be customized by users. You should enter VALUE in Lisp syntax,
6933 so if you want VALUE to be a string, you must surround it with doublequotes.
6934 VALUE is used literally, not evaluated.
6936 If VARIABLE has a `variable-interactive' property, that is used as if
6937 it were the arg to `interactive' (which see) to interactively read VALUE.
6939 If VARIABLE has been defined with `defcustom', then the type information
6940 in the definition is used to check that VALUE is valid.
6942 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6947 default-var)
6963 var obsolete)
6966 ;; Use VAR's `variable-interactive' property
6967 ;; as an interactive spec for prompting.
6970 arg))
6972 read-expression-map t
6973 'set-variable-value-history
6982 ;; Match with custom type.
6994 ;; Force a thorough redisplay for the case that the variable
6995 ;; has an effect on the display, like `tab-width' has.
6997 \f
6998 ;; Define the major mode for lists of completions.
7008 (define-key map [right] 'next-completion)
7010 (define-key map [backtab] 'previous-completion)
7011 (define-key map "q" 'quit-window)
7012 (define-key map "z" 'kill-this-buffer)
7013 map)
7014 "Local map for completion list buffers.")
7016 ;; Completion mode is suitable only for specially formatted data.
7017 (put 'completion-list-mode 'mode-class 'special)
7019 (defvar completion-reference-buffer nil
7020 "Record the buffer that was current when the completion list was requested.
7021 This is a local variable in the completion list buffer.
7022 Initial value is nil to avoid some compiler warnings.")
7024 (defvar completion-no-auto-exit nil
7025 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7026 This also applies to other functions such as `choose-completion'.")
7028 (defvar completion-base-position nil
7029 "Position of the base of the text corresponding to the shown completions.
7030 This variable is used in the *Completions* buffers.
7031 Its value is a list of the form (START END) where START is the place
7032 where the completion should be inserted and END (if non-nil) is the end
7033 of the text to replace. If END is nil, point is used instead.")
7035 (defvar completion-list-insert-choice-function #'completion--replace
7036 "Function to use to insert the text chosen in *Completions*.
7037 Called with three arguments (BEG END TEXT), it should replace the text
7038 between BEG and END with TEXT. Expected to be set buffer-locally
7039 in the *Completions* buffer.")
7041 (defvar completion-base-size nil
7042 "Number of chars before point not involved in completion.
7043 This is a local variable in the completion list buffer.
7044 It refers to the chars in the minibuffer if completing in the
7045 minibuffer, or in `completion-reference-buffer' otherwise.
7046 Only characters in the field at point are included.
7048 If nil, Emacs determines which part of the tail end of the
7049 buffer's text is involved in completion by comparing the text
7050 directly.")
7051 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7053 (defun delete-completion-window ()
7054 "Delete the completion list window.
7055 Go to the window from which completion was requested."
7056 (interactive)
7057 (let ((buf completion-reference-buffer))
7058 (if (one-window-p t)
7059 (if (window-dedicated-p) (delete-frame))
7060 (delete-window (selected-window))
7061 (if (get-buffer-window buf)
7062 (select-window (get-buffer-window buf))))))
7064 (defun previous-completion (n)
7065 "Move to the previous item in the completion list."
7066 (interactive "p")
7067 (next-completion (- n)))
7069 (defun next-completion (n)
7070 "Move to the next item in the completion list.
7071 With prefix argument N, move N items (negative N means move backward)."
7072 (interactive "p")
7073 (let ((beg (point-min)) (end (point-max)))
7074 (while (and (> n 0) (not (eobp)))
7075 ;; If in a completion, move to the end of it.
7076 (when (get-text-property (point) 'mouse-face)
7077 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7078 ;; Move to start of next one.
7079 (unless (get-text-property (point) 'mouse-face)
7080 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7081 (setq n (1- n)))
7082 (while (and (< n 0) (not (bobp)))
7083 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7084 ;; If in a completion, move to the start of it.
7085 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7086 (goto-char (previous-single-property-change
7087 (point) 'mouse-face nil beg)))
7088 ;; Move to end of the previous completion.
7089 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7090 (goto-char (previous-single-property-change
7091 (point) 'mouse-face nil beg)))
7092 ;; Move to the start of that one.
7093 (goto-char (previous-single-property-change
7094 (point) 'mouse-face nil beg))
7095 (setq n (1+ n))))))
7097 (defun choose-completion (&optional event)
7098 "Choose the completion at point.
7099 If EVENT, use EVENT's position to determine the starting position."
7100 (interactive (list last-nonmenu-event))
7101 ;; In case this is run via the mouse, give temporary modes such as
7102 ;; isearch a chance to turn off.
7103 (run-hooks 'mouse-leave-buffer-hook)
7104 (with-current-buffer (window-buffer (posn-window (event-start event)))
7105 (let ((buffer completion-reference-buffer)
7106 (base-size completion-base-size)
7107 (base-position completion-base-position)
7108 (insert-function completion-list-insert-choice-function)
7109 (choice
7110 (save-excursion
7111 (goto-char (posn-point (event-start event)))
7112 (let (beg end)
7113 (cond
7114 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7115 (setq end (point) beg (1+ (point))))
7116 ((and (not (bobp))
7117 (get-text-property (1- (point)) 'mouse-face))
7118 (setq end (1- (point)) beg (point)))
7119 (t (error "No completion here")))
7120 (setq beg (previous-single-property-change beg 'mouse-face))
7121 (setq end (or (next-single-property-change end 'mouse-face)
7122 (point-max)))
7123 (buffer-substring-no-properties beg end)))))
7125 (unless (buffer-live-p buffer)
7126 (error "Destination buffer is dead"))
7127 (quit-window nil (posn-window (event-start event)))
7129 (with-current-buffer buffer
7130 (choose-completion-string
7131 choice buffer
7132 (or base-position
7133 (when base-size
7134 ;; Someone's using old completion code that doesn't know
7135 ;; about base-position yet.
7136 (list (+ base-size (field-beginning))))
7137 ;; If all else fails, just guess.
7138 (list (choose-completion-guess-base-position choice)))
7139 insert-function)))))
7141 ;; Delete the longest partial match for STRING
7142 ;; that can be found before POINT.
7143 (defun choose-completion-guess-base-position (string)
7144 (save-excursion
7145 (let ((opoint (point))
7146 len)
7147 ;; Try moving back by the length of the string.
7148 (goto-char (max (- (point) (length string))
7149 (minibuffer-prompt-end)))
7150 ;; See how far back we were actually able to move. That is the
7151 ;; upper bound on how much we can match and delete.
7152 (setq len (- opoint (point)))
7153 (if completion-ignore-case
7154 (setq string (downcase string)))
7155 (while (and (> len 0)
7156 (let ((tail (buffer-substring (point) opoint)))
7157 (if completion-ignore-case
7158 (setq tail (downcase tail)))
7159 (not (string= tail (substring string 0 len)))))
7160 (setq len (1- len))
7161 (forward-char 1))
7162 (point))))
7164 (defun choose-completion-delete-max-match (string)
7165 (declare (obsolete choose-completion-guess-base-position "23.2"))
7166 (delete-region (choose-completion-guess-base-position string) (point)))
7168 (defvar choose-completion-string-functions nil
7169 "Functions that may override the normal insertion of a completion choice.
7170 These functions are called in order with three arguments:
7171 CHOICE - the string to insert in the buffer,
7172 BUFFER - the buffer in which the choice should be inserted,
7173 BASE-POSITION - where to insert the completion.
7175 If a function in the list returns non-nil, that function is supposed
7176 to have inserted the CHOICE in the BUFFER, and possibly exited
7177 the minibuffer; no further functions will be called.
7179 If all functions in the list return nil, that means to use
7180 the default method of inserting the completion in BUFFER.")
7182 (defun choose-completion-string (choice &optional
7183 buffer base-position insert-function)
7184 "Switch to BUFFER and insert the completion choice CHOICE.
7185 BASE-POSITION says where to insert the completion.
7186 INSERT-FUNCTION says how to insert the completion and falls
7187 back on `completion-list-insert-choice-function' when nil."
7189 ;; If BUFFER is the minibuffer, exit the minibuffer
7190 ;; unless it is reading a file name and CHOICE is a directory,
7191 ;; or completion-no-auto-exit is non-nil.
7193 ;; Some older code may call us passing `base-size' instead of
7194 ;; `base-position'. It's difficult to make any use of `base-size',
7195 ;; so we just ignore it.
7196 (unless (consp base-position)
7197 (message "Obsolete `base-size' passed to choose-completion-string")
7198 (setq base-position nil))
7200 (let* ((buffer (or buffer completion-reference-buffer))
7201 (mini-p (minibufferp buffer)))
7202 ;; If BUFFER is a minibuffer, barf unless it's the currently
7203 ;; active minibuffer.
7204 (if (and mini-p
7205 (not (and (active-minibuffer-window)
7206 (equal buffer
7207 (window-buffer (active-minibuffer-window))))))
7208 (error "Minibuffer is not active for completion")
7209 ;; Set buffer so buffer-local choose-completion-string-functions works.
7210 (set-buffer buffer)
7211 (unless (run-hook-with-args-until-success
7212 'choose-completion-string-functions
7213 ;; The fourth arg used to be `mini-p' but was useless
7214 ;; (since minibufferp can be used on the `buffer' arg)
7215 ;; and indeed unused. The last used to be `base-size', so we
7216 ;; keep it to try and avoid breaking old code.
7217 choice buffer base-position nil)
7218 ;; This remove-text-properties should be unnecessary since `choice'
7219 ;; comes from buffer-substring-no-properties.
7220 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7221 ;; Insert the completion into the buffer where it was requested.
7222 (funcall (or insert-function completion-list-insert-choice-function)
7223 (or (car base-position) (point))
7224 (or (cadr base-position) (point))
7225 choice)
7226 ;; Update point in the window that BUFFER is showing in.
7227 (let ((window (get-buffer-window buffer t)))
7228 (set-window-point window (point)))
7229 ;; If completing for the minibuffer, exit it with this choice.
7230 (and (not completion-no-auto-exit)
7231 (minibufferp buffer)
7232 minibuffer-completion-table
7233 ;; If this is reading a file name, and the file name chosen
7234 ;; is a directory, don't exit the minibuffer.
7235 (let* ((result (buffer-substring (field-beginning) (point)))
7236 (bounds
7237 (completion-boundaries result minibuffer-completion-table
7238 minibuffer-completion-predicate
7239 "")))
7240 (if (eq (car bounds) (length result))
7241 ;; The completion chosen leads to a new set of completions
7242 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7243 (let ((mini (active-minibuffer-window)))
7244 (select-window mini)
7245 (when minibuffer-auto-raise
7246 (raise-frame (window-frame mini))))
7247 (exit-minibuffer))))))))
7249 (define-derived-mode completion-list-mode nil "Completion List"
7250 "Major mode for buffers showing lists of possible completions.
7252 to select the completion near point.
7253 Or click to select one with the mouse.
7256 (set (make-local-variable 'completion-base-size) nil))
7258 (defun completion-list-mode-finish ()
7259 "Finish setup of the completions buffer.
7260 Called from `temp-buffer-show-hook'."
7261 (when (eq major-mode 'completion-list-mode)
7262 (setq buffer-read-only t)))
7264 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7267 ;; Variables and faces used in `completion-setup-function'.
7269 (defcustom completion-show-help t
7270 "Non-nil means show help message in *Completions* buffer."
7271 :type 'boolean
7272 :version "22.1"
7273 :group 'completion)
7275 ;; This function goes in completion-setup-hook, so that it is called
7276 ;; after the text of the completion list buffer is written.
7277 (defun completion-setup-function ()
7278 (let* ((mainbuf (current-buffer))
7279 (base-dir
7280 ;; FIXME: This is a bad hack. We try to set the default-directory
7281 ;; in the *Completions* buffer so that the relative file names
7282 ;; displayed there can be treated as valid file names, independently
7283 ;; from the completion context. But this suffers from many problems:
7284 ;; - It's not clear when the completions are file names. With some
7285 ;; completion tables (e.g. bzr revision specs), the listed
7286 ;; completions can mix file names and other things.
7287 ;; - It doesn't pay attention to possible quoting.
7288 ;; - With fancy completion styles, the code below will not always
7289 ;; find the right base directory.
7290 (if minibuffer-completing-file-name
7291 (file-name-as-directory
7292 (expand-file-name
7293 (buffer-substring (minibuffer-prompt-end)
7294 (- (point) (or completion-base-size 0))))))))
7295 (with-current-buffer standard-output
7296 (let ((base-size completion-base-size) ;Read before killing localvars.
7297 (base-position completion-base-position)
7298 (insert-fun completion-list-insert-choice-function))
7299 (completion-list-mode)
7300 (set (make-local-variable 'completion-base-size) base-size)
7301 (set (make-local-variable 'completion-base-position) base-position)
7302 (set (make-local-variable 'completion-list-insert-choice-function)
7303 insert-fun))
7304 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7305 (if base-dir (setq default-directory base-dir))
7306 ;; Maybe insert help string.
7307 (when completion-show-help
7308 (goto-char (point-min))
7309 (if (display-mouse-p)
7310 (insert (substitute-command-keys
7312 (insert (substitute-command-keys
7316 (add-hook 'completion-setup-hook 'completion-setup-function)
7318 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7319 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7321 (defun switch-to-completions ()
7322 "Select the completion list window."
7323 (interactive)
7324 (let ((window (or (get-buffer-window "*Completions*" 0)
7325 ;; Make sure we have a completions window.
7326 (progn (minibuffer-completion-help)
7327 (get-buffer-window "*Completions*" 0)))))
7328 (when window
7329 (select-window window)
7330 ;; In the new buffer, go to the first completion.
7331 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
7332 (when (bobp)
7333 (next-completion 1)))))
7334 \f
7335 ;;; Support keyboard commands to turn on various modifiers.
7337 ;; These functions -- which are not commands -- each add one modifier
7338 ;; to the following event.
7340 (defun event-apply-alt-modifier (_ignore-prompt)
7343 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
7344 (defun event-apply-super-modifier (_ignore-prompt)
7347 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
7348 (defun event-apply-hyper-modifier (_ignore-prompt)
7351 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
7352 (defun event-apply-shift-modifier (_ignore-prompt)
7355 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
7356 (defun event-apply-control-modifier (_ignore-prompt)
7359 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
7360 (defun event-apply-meta-modifier (_ignore-prompt)
7363 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
7365 (defun event-apply-modifier (event symbol lshiftby prefix)
7366 "Apply a modifier flag to event EVENT.
7367 SYMBOL is the name of this modifier, as a symbol.
7368 LSHIFTBY is the numeric value of this modifier, in keyboard events.
7369 PREFIX is the string that represents this modifier in an event type symbol."
7370 (if (numberp event)
7371 (cond ((eq symbol 'control)
7372 (if (and (<= (downcase event) ?z)
7373 (>= (downcase event) ?a))
7374 (- (downcase event) ?a -1)
7375 (if (and (<= (downcase event) ?Z)
7376 (>= (downcase event) ?A))
7377 (- (downcase event) ?A -1)
7378 (logior (lsh 1 lshiftby) event))))
7379 ((eq symbol 'shift)
7380 (if (and (<= (downcase event) ?z)
7381 (>= (downcase event) ?a))
7382 (upcase event)
7383 (logior (lsh 1 lshiftby) event)))
7384 (t
7385 (logior (lsh 1 lshiftby) event)))
7386 (if (memq symbol (event-modifiers event))
7387 event
7388 (let ((event-type (if (symbolp event) event (car event))))
7389 (setq event-type (intern (concat prefix (symbol-name event-type))))
7390 (if (symbolp event)
7391 event-type
7392 (cons event-type (cdr event)))))))
7394 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
7395 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
7396 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
7397 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
7398 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
7399 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
7400 \f
7401 ;;;; Keypad support.
7403 ;; Make the keypad keys act like ordinary typing keys. If people add
7404 ;; bindings for the function key symbols, then those bindings will
7405 ;; override these, so this shouldn't interfere with any existing
7406 ;; bindings.
7408 ;; Also tell read-char how to handle these keys.
7409 (mapc
7410 (lambda (keypad-normal)
7411 (let ((keypad (nth 0 keypad-normal))
7412 (normal (nth 1 keypad-normal)))
7413 (put keypad 'ascii-character normal)
7414 (define-key function-key-map (vector keypad) (vector normal))))
7415 ;; See also kp-keys bound in bindings.el.
7416 '((kp-space ?\s)
7419 (kp-separator ?,)
7420 (kp-equal ?=)
7421 ;; Do the same for various keys that are represented as symbols under
7422 ;; GUIs but naturally correspond to characters.
7423 (backspace 127)
7424 (delete 127)
7427 (clear ?\C-l)
7428 (return ?\C-m)
7429 (escape ?\e)
7430 ))
7431 \f
7432 ;;;;
7433 ;;;; forking a twin copy of a buffer.
7434 ;;;;
7436 (defvar clone-buffer-hook nil
7437 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7439 (defvar clone-indirect-buffer-hook nil
7440 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7442 (defun clone-process (process &optional newname)
7443 "Create a twin copy of PROCESS.
7444 If NEWNAME is nil, it defaults to PROCESS' name;
7445 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7446 If PROCESS is associated with a buffer, the new process will be associated
7447 with the current buffer instead.
7448 Returns nil if PROCESS has already terminated."
7449 (setq newname (or newname (process-name process)))
7451 (setq newname (substring newname 0 (match-beginning 0))))
7452 (when (memq (process-status process) '(run stop open))
7453 (let* ((process-connection-type (process-tty-name process))
7454 (new-process
7455 (if (memq (process-status process) '(open))
7456 (let ((args (process-contact process t)))
7457 (setq args (plist-put args :name newname))
7458 (setq args (plist-put args :buffer
7459 (if (process-buffer process)
7460 (current-buffer))))
7461 (apply 'make-network-process args))
7462 (apply 'start-process newname
7463 (if (process-buffer process) (current-buffer))
7464 (process-command process)))))
7465 (set-process-query-on-exit-flag
7466 new-process (process-query-on-exit-flag process))
7467 (set-process-inherit-coding-system-flag
7468 new-process (process-inherit-coding-system-flag process))
7469 (set-process-filter new-process (process-filter process))
7470 (set-process-sentinel new-process (process-sentinel process))
7471 (set-process-plist new-process (copy-sequence (process-plist process)))
7472 new-process)))
7474 ;; things to maybe add (currently partly covered by `funcall mode'):
7475 ;; - syntax-table
7476 ;; - overlays
7477 (defun clone-buffer (&optional newname display-flag)
7478 "Create and return a twin copy of the current buffer.
7479 Unlike an indirect buffer, the new buffer can be edited
7480 independently of the old one (if it is not read-only).
7481 NEWNAME is the name of the new buffer. It may be modified by
7482 adding or incrementing <N> at the end as necessary to create a
7483 unique buffer name. If nil, it defaults to the name of the
7484 current buffer, with the proper suffix. If DISPLAY-FLAG is
7485 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7486 clone a file-visiting buffer, or a buffer whose major mode symbol
7487 has a non-nil `no-clone' property, results in an error.
7489 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7490 current buffer with appropriate suffix. However, if a prefix
7491 argument is given, then the command prompts for NEWNAME in the
7492 minibuffer.
7494 This runs the normal hook `clone-buffer-hook' in the new buffer
7495 after it has been set up properly in other respects."
7496 (interactive
7497 (progn
7498 (if buffer-file-name
7499 (error "Cannot clone a file-visiting buffer"))
7500 (if (get major-mode 'no-clone)
7501 (error "Cannot clone a buffer in %s mode" mode-name))
7502 (list (if current-prefix-arg
7503 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7504 t)))
7505 (if buffer-file-name
7506 (error "Cannot clone a file-visiting buffer"))
7507 (if (get major-mode 'no-clone)
7508 (error "Cannot clone a buffer in %s mode" mode-name))
7509 (setq newname (or newname (buffer-name)))
7511 (setq newname (substring newname 0 (match-beginning 0))))
7512 (let ((buf (current-buffer))
7513 (ptmin (point-min))
7514 (ptmax (point-max))
7515 (pt (point))
7516 (mk (if mark-active (mark t)))
7517 (modified (buffer-modified-p))
7518 (mode major-mode)
7519 (lvars (buffer-local-variables))
7520 (process (get-buffer-process (current-buffer)))
7521 (new (generate-new-buffer (or newname (buffer-name)))))
7522 (save-restriction
7523 (widen)
7524 (with-current-buffer new
7525 (insert-buffer-substring buf)))
7526 (with-current-buffer new
7527 (narrow-to-region ptmin ptmax)
7528 (goto-char pt)
7529 (if mk (set-mark mk))
7530 (set-buffer-modified-p modified)
7532 ;; Clone the old buffer's process, if any.
7533 (when process (clone-process process))
7535 ;; Now set up the major mode.
7536 (funcall mode)
7538 ;; Set up other local variables.
7539 (mapc (lambda (v)
7540 (condition-case () ;in case var is read-only
7541 (if (symbolp v)
7542 (makunbound v)
7543 (set (make-local-variable (car v)) (cdr v)))
7544 (error nil)))
7545 lvars)
7547 ;; Run any hooks (typically set up by the major mode
7548 ;; for cloning to work properly).
7549 (run-hooks 'clone-buffer-hook))
7550 (if display-flag
7551 ;; Presumably the current buffer is shown in the selected frame, so
7552 ;; we want to display the clone elsewhere.
7553 (let ((same-window-regexps nil)
7554 (same-window-buffer-names))
7555 (pop-to-buffer new)))
7556 new))
7559 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7560 "Create an indirect buffer that is a twin copy of the current buffer.
7562 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7563 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7564 or if not called with a prefix arg, NEWNAME defaults to the current
7565 buffer's name. The name is modified by adding a `<N>' suffix to it
7566 or by incrementing the N in an existing suffix. Trying to clone a
7567 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7568 property results in an error.
7570 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7571 This is always done when called interactively.
7573 Optional third arg NORECORD non-nil means do not put this buffer at the
7574 front of the list of recently selected ones."
7575 (interactive
7576 (progn
7577 (if (get major-mode 'no-clone-indirect)
7578 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7579 (list (if current-prefix-arg
7580 (read-buffer "Name of indirect buffer: " (current-buffer)))
7581 t)))
7582 (if (get major-mode 'no-clone-indirect)
7583 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7584 (setq newname (or newname (buffer-name)))
7586 (setq newname (substring newname 0 (match-beginning 0))))
7587 (let* ((name (generate-new-buffer-name newname))
7588 (buffer (make-indirect-buffer (current-buffer) name t)))
7589 (with-current-buffer buffer
7590 (run-hooks 'clone-indirect-buffer-hook))
7591 (when display-flag
7592 (pop-to-buffer buffer norecord))
7593 buffer))
7596 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7597 "Like `clone-indirect-buffer' but display in another window."
7598 (interactive
7599 (progn
7600 (if (get major-mode 'no-clone-indirect)
7601 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7602 (list (if current-prefix-arg
7603 (read-buffer "Name of indirect buffer: " (current-buffer)))
7604 t)))
7605 (let ((pop-up-windows t))
7606 (clone-indirect-buffer newname display-flag norecord)))
7608 \f
7609 ;;; Handling of Backspace and Delete keys.
7611 (defcustom normal-erase-is-backspace 'maybe
7612 "Set the default behavior of the Delete and Backspace keys.
7614 If set to t, Delete key deletes forward and Backspace key deletes
7615 backward.
7617 If set to nil, both Delete and Backspace keys delete backward.
7619 If set to 'maybe (which is the default), Emacs automatically
7620 selects a behavior. On window systems, the behavior depends on
7621 the keyboard used. If the keyboard has both a Backspace key and
7622 a Delete key, and both are mapped to their usual meanings, the
7623 option's default value is set to t, so that Backspace can be used
7624 to delete backward, and Delete can be used to delete forward.
7626 If not running under a window system, customizing this option
7627 accomplishes a similar effect by mapping C-h, which is usually
7628 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7629 via `keyboard-translate'. The former functionality of C-h is
7630 available on the F1 key. You should probably not use this
7631 setting if you don't have both Backspace, Delete and F1 keys.
7633 Setting this variable with setq doesn't take effect. Programmatically,
7634 call `normal-erase-is-backspace-mode' (which see) instead."
7635 :type '(choice (const :tag "Off" nil)
7636 (const :tag "Maybe" maybe)
7637 (other :tag "On" t))
7638 :group 'editing-basics
7639 :version "21.1"
7640 :set (lambda (symbol value)
7641 ;; The fboundp is because of a problem with :set when
7642 ;; dumping Emacs. It doesn't really matter.
7643 (if (fboundp 'normal-erase-is-backspace-mode)
7644 (normal-erase-is-backspace-mode (or value 0))
7645 (set-default symbol value))))
7647 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7648 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7649 (unless frame (setq frame (selected-frame)))
7650 (with-selected-frame frame
7651 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7652 (normal-erase-is-backspace-mode
7653 (if (if (eq normal-erase-is-backspace 'maybe)
7654 (and (not noninteractive)
7655 (or (memq system-type '(ms-dos windows-nt))
7656 (memq window-system '(w32 ns))
7657 (and (memq window-system '(x))
7658 (fboundp 'x-backspace-delete-keys-p)
7659 (x-backspace-delete-keys-p))
7660 ;; If the terminal Emacs is running on has erase char
7661 ;; set to ^H, use the Backspace key for deleting
7662 ;; backward, and the Delete key for deleting forward.
7663 (and (null window-system)
7664 (eq tty-erase-char ?\^H))))
7665 normal-erase-is-backspace)
7666 1 0)))))
7668 (define-minor-mode normal-erase-is-backspace-mode
7669 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7670 With a prefix argument ARG, enable this feature if ARG is
7671 positive, and disable it otherwise. If called from Lisp, enable
7672 the mode if ARG is omitted or nil.
7674 On window systems, when this mode is on, Delete is mapped to C-d
7675 and Backspace is mapped to DEL; when this mode is off, both
7676 Delete and Backspace are mapped to DEL. (The remapping goes via
7677 `local-function-key-map', so binding Delete or Backspace in the
7678 global or local keymap will override that.)
7680 In addition, on window systems, the bindings of C-Delete, M-Delete,
7681 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7682 the global keymap in accordance with the functionality of Delete and
7683 Backspace. For example, if Delete is remapped to C-d, which deletes
7684 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7685 to DEL, which deletes backward, C-Delete is bound to
7686 `backward-kill-word'.
7688 If not running on a window system, a similar effect is accomplished by
7689 remapping C-h (normally produced by the Backspace key) and DEL via
7690 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7691 to C-d; if it's off, the keys are not remapped.
7693 When not running on a window system, and this mode is turned on, the
7694 former functionality of C-h is available on the F1 key. You should
7695 probably not turn on this mode on a text-only terminal if you don't
7696 have both Backspace, Delete and F1 keys.
7698 See also `normal-erase-is-backspace'."
7699 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7700 . (lambda (v)
7701 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7702 (if v 1 0))))
7703 (let ((enabled (eq 1 (terminal-parameter
7704 nil 'normal-erase-is-backspace))))
7706 (cond ((or (memq window-system '(x w32 ns pc))
7707 (memq system-type '(ms-dos windows-nt)))
7708 (let ((bindings
7709 `(([M-delete] [M-backspace])
7710 ([C-M-delete] [C-M-backspace])
7711 ([?\e C-delete] [?\e C-backspace]))))
7713 (if enabled
7714 (progn
7715 (define-key local-function-key-map [delete] [deletechar])
7716 (define-key local-function-key-map [kp-delete] [deletechar])
7717 (define-key local-function-key-map [backspace] [?\C-?])
7718 (dolist (b bindings)
7719 ;; Not sure if input-decode-map is really right, but
7720 ;; keyboard-translate-table (used below) only works
7721 ;; for integer events, and key-translation-table is
7722 ;; global (like the global-map, used earlier).
7723 (define-key input-decode-map (car b) nil)
7724 (define-key input-decode-map (cadr b) nil)))
7725 (define-key local-function-key-map [delete] [?\C-?])
7726 (define-key local-function-key-map [kp-delete] [?\C-?])
7727 (define-key local-function-key-map [backspace] [?\C-?])
7728 (dolist (b bindings)
7729 (define-key input-decode-map (car b) (cadr b))
7730 (define-key input-decode-map (cadr b) (car b))))))
7731 (t
7732 (if enabled
7733 (progn
7734 (keyboard-translate ?\C-h ?\C-?)
7735 (keyboard-translate ?\C-? ?\C-d))
7736 (keyboard-translate ?\C-h ?\C-h)
7737 (keyboard-translate ?\C-? ?\C-?))))
7739 (if (called-interactively-p 'interactive)
7740 (message "Delete key deletes %s"
7741 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7742 "forward" "backward")))))
7743 \f
7744 (defvar vis-mode-saved-buffer-invisibility-spec nil
7745 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7747 (define-minor-mode read-only-mode
7748 "Change whether the current buffer is read-only.
7749 With prefix argument ARG, make the buffer read-only if ARG is
7750 positive, otherwise make it writable. If buffer is read-only
7751 and `view-read-only' is non-nil, enter view mode.
7753 Do not call this from a Lisp program unless you really intend to
7755 possibly enabling or disabling View mode. Also, note that this
7756 command works by setting the variable `buffer-read-only', which
7757 does not affect read-only regions caused by text properties. To
7758 ignore read-only status in a Lisp program (whether due to text
7759 properties or buffer state), bind `inhibit-read-only' temporarily
7760 to a non-nil value."
7761 :variable buffer-read-only
7762 (cond
7763 ((and (not buffer-read-only) view-mode)
7764 (View-exit-and-edit)
7765 (make-local-variable 'view-read-only)
7766 (setq view-read-only t)) ; Must leave view mode.
7767 ((and buffer-read-only view-read-only
7768 ;; If view-mode is already active, `view-mode-enter' is a nop.
7769 (not view-mode)
7770 (not (eq (get major-mode 'mode-class) 'special)))
7771 (view-mode-enter))))
7773 (define-minor-mode visible-mode
7774 "Toggle making all invisible text temporarily visible (Visible mode).
7775 With a prefix argument ARG, enable Visible mode if ARG is
7776 positive, and disable it otherwise. If called from Lisp, enable
7777 the mode if ARG is omitted or nil.
7779 This mode works by saving the value of `buffer-invisibility-spec'
7780 and setting it to nil."
7781 :lighter " Vis"
7782 :group 'editing-basics
7783 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7784 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7785 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7786 (when visible-mode
7787 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7788 buffer-invisibility-spec)
7789 (setq buffer-invisibility-spec nil)))
7790 \f
7791 (defvar messages-buffer-mode-map
7792 (let ((map (make-sparse-keymap)))
7793 (set-keymap-parent map special-mode-map)
7794 (define-key map "g" nil) ; nothing to revert
7795 map))
7797 (define-derived-mode messages-buffer-mode special-mode "Messages"
7800 (defun messages-buffer ()
7802 If it does not exist, create and it switch it to `messages-buffer-mode'."
7803 (or (get-buffer "*Messages*")
7804 (with-current-buffer (get-buffer-create "*Messages*")
7805 (messages-buffer-mode)
7806 (current-buffer))))
7808 \f
7809 ;; Minibuffer prompt stuff.
7811 ;;(defun minibuffer-prompt-modification (start end)
7812 ;; (error "You cannot modify the prompt"))
7813 ;;
7814 ;;
7815 ;;(defun minibuffer-prompt-insertion (start end)
7816 ;; (let ((inhibit-modification-hooks t))
7817 ;; (delete-region start end)
7818 ;; ;; Discard undo information for the text insertion itself
7819 ;; ;; and for the text deletion.above.
7820 ;; (when (consp buffer-undo-list)
7821 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7822 ;; (message "You cannot modify the prompt")))
7823 ;;
7824 ;;
7825 ;;(setq minibuffer-prompt-properties
7826 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7827 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7829 \f
7830 ;;;; Problematic external packages.
7832 ;; rms says this should be done by specifying symbols that define
7833 ;; versions together with bad values. This is therefore not as
7834 ;; flexible as it could be. See the thread:
7835 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7836 (defconst bad-packages-alist
7837 ;; Not sure exactly which semantic versions have problems.
7838 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7840 "The version of `semantic' loaded does not work in Emacs 22.
7841 It can cause constant high CPU load.
7842 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7843 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7844 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7845 ;; provided the `CUA-mode' feature. Since this is no longer true,
7846 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7847 (CUA-mode t nil
7848 "CUA-mode is now part of the standard GNU Emacs distribution,
7849 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7851 You have loaded an older version of CUA-mode which does not work
7852 correctly with this version of Emacs. You should remove the old
7853 version and use the one distributed with Emacs."))
7854 "Alist of packages known to cause problems in this version of Emacs.
7855 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7856 PACKAGE is either a regular expression to match file names, or a
7857 symbol (a feature name), like for `with-eval-after-load'.
7858 SYMBOL is either the name of a string variable, or `t'. Upon
7859 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7860 warning using STRING as the message.")
7862 (defun bad-package-check (package)
7863 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7864 (condition-case nil
7865 (let* ((list (assoc package bad-packages-alist))
7866 (symbol (nth 1 list)))
7867 (and list
7868 (boundp symbol)
7869 (or (eq symbol t)
7870 (and (stringp (setq symbol (eval symbol)))
7871 (string-match-p (nth 2 list) symbol)))
7872 (display-warning package (nth 3 list) :warning)))
7873 (error nil)))
7875 (dolist (elem bad-packages-alist)
7876 (let ((pkg (car elem)))
7877 (with-eval-after-load pkg
7878 (bad-package-check pkg))))
7880 \f
7881 ;;; Generic dispatcher commands
7883 ;; Macro `define-alternatives' is used to create generic commands.
7884 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
7885 ;; that can have different alternative implementations where choosing
7886 ;; among them is exclusively a matter of user preference.
7888 ;; (define-alternatives COMMAND) creates a new interactive command
7889 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
7890 ;; Typically, the user will not need to customize this variable; packages
7891 ;; wanting to add alternative implementations should use
7892 ;;
7893 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
7895 (defmacro define-alternatives (command &rest customizations)
7896 "Define the new command `COMMAND'.
7898 The argument `COMMAND' should be a symbol.
7900 Running `M-x COMMAND RET' for the first time prompts for which
7901 alternative to use and records the selected command as a custom
7902 variable.
7904 Running `C-u M-x COMMAND RET' prompts again for an alternative
7905 and overwrites the previous choice.
7907 The variable `COMMAND-alternatives' contains an alist with
7908 alternative implementations of COMMAND. `define-alternatives'
7909 does not have any effect until this variable is set.
7911 CUSTOMIZATIONS, if non-nil, should be composed of alternating
7912 `defcustom' keywords and values to add to the declaration of
7913 `COMMAND-alternatives' (typically :group and :version)."
7914 (let* ((command-name (symbol-name command))
7915 (varalt-name (concat command-name "-alternatives"))
7916 (varalt-sym (intern varalt-name))
7917 (varimp-sym (intern (concat command-name "--implementation"))))
7918 `(progn
7920 (defcustom ,varalt-sym nil
7921 ,(format "Alist of alternative implementations for the `%s' command.
7923 Each entry must be a pair (ALTNAME . ALTFUN), where:
7924 ALTNAME - The name shown at user to describe the alternative implementation.
7925 ALTFUN - The function called to implement this alternative."
7926 command-name)
7927 :type '(alist :key-type string :value-type function)
7928 ,@customizations)
7930 (put ',varalt-sym 'definition-name ',command)
7931 (defvar ,varimp-sym nil "Internal use only.")
7933 (defun ,command (&optional arg)
7934 ,(format "Run generic command `%s'.
7935 If used for the first time, or with interactive ARG, ask the user which
7936 implementation to use for `%s'. The variable `%s'
7937 contains the list of implementations currently supported for this command."
7938 command-name command-name varalt-name)
7939 (interactive "P")
7940 (when (or arg (null ,varimp-sym))
7941 (let ((val (completing-read
7942 ,(format "Select implementation for command `%s': "
7943 command-name)
7944 ,varalt-sym nil t)))
7945 (unless (string-equal val "")
7946 (when (null ,varimp-sym)
7947 (message
7948 "Use `C-u M-x %s RET' to select another implementation"
7949 ,command-name)
7950 (sit-for 3))
7951 (customize-save-variable ',varimp-sym
7952 (cdr (assoc-string val ,varalt-sym))))))
7953 (if ,varimp-sym
7954 (call-interactively ,varimp-sym)
7955 (message ,(format "No implementation selected for command `%s'"
7956 command-name)))))))
7958 \f
7960 (provide 'simple)
7962 ;;; simple.el ends here