| blob | 21e0cf14c80e2ffc853222ae6af8055a78a92dc6 |
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.
378 "Special hook to tell if `self-insert-command' will use the region.
379 It must be called via `run-hook-with-args-until-success' with no arguments.
380 Any `post-self-insert-command' which consumes the region should
381 register a function on this hook so that things like `delete-selection-mode'
388 "Insert a newline, and move to left margin of the new line if it's blank.
389 If option `use-hard-newlines' is non-nil, the newline is marked with the
390 text-property `hard'.
391 With ARG, insert that many newlines.
393 If `electric-indent-mode' is enabled, this indents the final new line
394 that it adds, and reindents the preceding line. To just insert
397 Calls `auto-fill-function' if the current column number is greater
398 than the value of `fill-column' and ARG is nil.
399 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
402 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
403 ;; Set last-command-event to tell self-insert what to insert.
407 ;; Don't auto-fill if we have a numeric argument.
410 ;; Do the rest in post-self-insert-hook, because we want to do it
411 ;; *before* other functions on that hook.
413 ;; Mark the newline(s) `hard'.
417 ;; If the newline leaves the previous line blank, and we
418 ;; have a left margin, delete that from the blank line.
426 ;; Indent the line after the newline, except in one case:
427 ;; when we added the newline at the beginning of a line which
428 ;; starts a page.
432 ;; FIXME: For non-interactive uses, many calls actually just want
433 ;; (insert "\n"), so maybe we should do just that, so as to avoid
434 ;; the risk of filling or running abbrevs unexpectedly.
441 ;; We first used let-binding to protect the hook, but that was naive
442 ;; since add-hook affects the symbol-default value of the variable,
443 ;; whereas the let-binding might only protect the buffer-local value.
445 nil)
450 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
456 "Insert a newline and leave point before it.
457 If there is a fill prefix and/or a `left-margin', insert them
458 on the new line if the line would have been blank.
459 With arg N, insert N newlines."
464 ;; Don't expand an abbrev before point.
478 "Split current line, moving portion beyond point vertically down.
479 If the current line starts with `fill-prefix', insert it on the new
480 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
482 When called from Lisp code, ARG may be a prefix string to copy."
487 ;; What prefix should we check for (nil means don't).
491 ;; Does this line start with it?
502 "Join this line to previous and fix up whitespace at join.
503 If there is a fill prefix, delete it from the beginning of this line.
504 With argument, join this line to following line."
511 ;; If the second line started with the fill prefix,
512 ;; delete the prefix.
524 "On blank line, delete all surrounding blank lines, leaving just one.
525 On isolated blank line, delete that one.
526 On nonblank line, delete any immediately following blank lines."
532 ;; Set singleblank if there is just one blank line here.
539 ;; Delete preceding blank lines, and this one too if it's the only one.
548 ;; Delete following blank lines, unless the current line is blank
549 ;; and there are no following blank lines.
558 ;; Handle the special case where point is followed by newline and eob.
559 ;; Delete the line, leaving point at eob.
565 Trailing lines are deleted only if `delete-trailing-whitespace'
566 is called on the entire buffer (rather than an active region)."
572 "Delete trailing whitespace between START and END.
573 If called interactively, START and END are the start/end of the
574 region if the mark is active, or of the buffer's accessible
575 portion if the mark is inactive.
577 This command deletes whitespace characters after the last
578 non-whitespace character in each line between START and END. It
579 does not consider formfeed characters to be whitespace.
581 If this command acts on the entire buffer (i.e. if called
582 interactively with the mark inactive, or called from Lisp with
583 END nil), it also deletes all trailing lines at the end of the
584 buffer if the variable `delete-trailing-lines' is non-nil."
597 ;; Don't delete formfeeds, even if they are considered whitespace.
601 ;; Delete trailing empty lines.
604 delete-trailing-lines
605 ;; Really the end of buffer.
610 ;; Return nil for the benefit of `write-file-functions'.
611 nil)
614 "Insert a newline, then indent according to major mode.
615 Indentation is done using the value of `indent-line-function'.
616 In programming language modes, this is the same as TAB.
617 In some text modes, where TAB inserts a tab, this command indents to the
618 column specified by the function `current-left-margin'."
625 "Reindent current line, insert newline, then indent the new line.
626 Indentation of both lines is done according to the current major mode,
627 which means calling the current value of `indent-line-function'.
628 In programming language modes, this is the same as TAB.
629 In some text modes, where TAB inserts a tab, this indents to the
630 column specified by the function `current-left-margin'."
633 ;; Be careful to insert the newline before indenting the line.
634 ;; Otherwise, the indentation might be wrong.
638 ;; We are at EOL before the call to indent-according-to-mode, and
639 ;; after it we usually are as well, but not always. We tried to
640 ;; address it with `save-excursion' but that uses a normal marker
641 ;; whereas we need `move after insertion', so we do the save/restore
642 ;; by hand.
646 ;; Remove the trailing white-space after indentation because
647 ;; indentation may introduce the whitespace.
653 Legitimate radix values are 8, 10 and 16."
658 "Like `read-char', but do not allow quitting.
659 Also, if the first character read is an octal digit,
660 we read any number of octal digits and return the
661 specified character code. Any nondigit terminates the sequence.
662 If the terminator is RET, it is discarded;
663 any other terminator is used itself as input.
665 The optional argument PROMPT specifies a string to use to prompt the user.
666 The variable `read-quoted-char-radix' controls which radix to use
667 for numeric input."
670 help-event-list)))
674 ;; Don't let C-h or other help chars get the help
675 ;; message--only help function keys. See bug#16617.
679 "Type the special character you want to use,
680 or the octal character code.
681 RET terminates the character code and is discarded;
691 done t))
693 ;; Turn a meta-character into a character with the 0200 bit set.
695 done t))
711 done t))
713 done t)))
715 code))
718 "Read next input character and insert it.
719 This is useful for inserting control characters.
720 With argument, insert ARG copies of the character.
722 If the first character you type after this command is an octal digit,
723 you should type a sequence of octal digits which specify a character code.
724 Any nondigit terminates the sequence. If the terminator is a RET,
725 it is discarded; any other terminator is used itself as input.
726 The variable `read-quoted-char-radix' specifies the radix for this feature;
727 set it to 10 or 16 to use decimal or hex instead of octal.
729 In overwrite mode, this function inserts the character anyway, and
730 does not handle octal digits specially. This means that if you use
731 overwrite as your normal editing mode, you can use this function to
732 insert characters when necessary.
734 In binary overwrite mode, this function does overwrite, and octal
735 digits are interpreted as a character code. This is intended to be
736 useful for editing binary files."
739 ;; Avoid "obsolete" warnings for translation-table-for-input.
746 ;; This used to assume character codes 0240 - 0377 stand for
747 ;; characters in some single-byte character set, and converted them
748 ;; to Emacs characters. But in 23.1 this feature is deprecated
749 ;; in favor of inserting the corresponding Unicode characters.
750 ;; (if (and enable-multibyte-characters
751 ;; (>= char ?\240)
752 ;; (<= char ?\377))
753 ;; (setq char (unibyte-char-to-multibyte char)))
765 "Move forward ARG lines and position at first nonblank character."
771 "Move backward ARG lines and position at first nonblank character."
777 "Move point to the first non-whitespace character on this line."
781 ;; Move back over chars that have whitespace syntax but have the p flag.
785 "Fixup white space between objects around point.
786 Leave one space or none, according to the context."
793 nil
797 "Delete all spaces and tabs around point.
798 If BACKWARD-ONLY is non-nil, only delete them before point."
803 orig-pos
812 "Delete all spaces and tabs around point, leaving one space (or N spaces).
813 If N is negative, delete newlines as well, leaving -N spaces.
814 See also `cycle-spacing'."
819 "Store context used in consecutive calls to `cycle-spacing' command.
820 The first time `cycle-spacing' runs, it saves in this variable:
821 its N argument, the original point position, and the original spacing
825 "Manipulate whitespace around point in a smart way.
826 In interactive use, this function behaves differently in successive
827 consecutive calls.
829 The first call in a sequence acts like `just-one-space'.
830 It deletes all spaces and tabs around point, leaving one space
831 \(or N spaces). N is the prefix argument. If N is negative,
832 it deletes newlines as well, leaving -N spaces.
833 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
835 The second call in a sequence deletes all spaces.
837 The third call in a sequence restores the original whitespace (and point).
839 If MODE is `single-shot', it only performs the first step in the sequence.
840 If MODE is `fast' and the first step would not result in any change
841 \(i.e., there are exactly (abs N) spaces around point),
842 the function goes straight to the second step.
844 Repeatedly calling the function with different values of N starts a
845 new sequence each time."
853 ;; Command run for the first time, single-shot mode or different argument
865 ;; Special handling for case where there was no space at all.
868 ;; If this run causes no change in buffer content, delete all spaces,
869 ;; otherwise delete all excess spaces.
874 ;; Command run for the second time.
878 ;; Command run for the third time.
883 \f
885 "Move point to the beginning of the buffer.
886 With numeric arg N, put point N/10 of the way from the beginning.
887 If the buffer is narrowed, this command uses the beginning of the
888 accessible part of the buffer.
890 If Transient Mark mode is disabled, leave mark at previous
901 ;; Avoid overflow for large buffer sizes!
909 "Move point to the end of the buffer.
910 With numeric arg N, put point N/10 of the way from the end.
911 If the buffer is narrowed, this command uses the end of the
912 accessible part of the buffer.
914 If Transient Mark mode is disabled, leave mark at previous
923 ;; Avoid overflow for large buffer sizes!
928 ;; If we went to a place in the middle of the buffer,
929 ;; adjust it to the beginning of a line.
933 ;; If the end of the buffer is not already on the screen,
934 ;; then scroll specially to put it near, but not at, the bottom.
939 "Whether single-char deletion commands delete an active region.
940 This has an effect only if Transient Mark mode is enabled, and
941 affects `delete-forward-char' and `delete-backward-char', though
942 not `delete-char'.
944 If the value is the symbol `kill', the active region is killed
945 instead of deleted."
958 "Function to get the region's content.
959 Called with one argument DELETE.
960 If DELETE is `delete-only', then only delete the region and the return value
961 is undefined. If DELETE is nil, just return the content as a string.
965 "Delete the previous N characters (following if N is negative).
966 If Transient Mark mode is enabled, the mark is active, and N is 1,
967 delete the text in the region and deactivate the mark instead.
968 To disable this, set option `delete-active-region' to nil.
970 Optional second arg KILLFLAG, if non-nil, means to kill (save in
971 kill ring) instead of delete. Interactively, N is the prefix
972 arg, and KILLFLAG is set if N is explicitly specified.
974 In Overwrite mode, single character backward deletion may replace
975 tabs with spaces so as to back over columns, unless point is at
976 the end of the line."
982 delete-active-region
984 ;; If a region is active, kill or delete it.
988 ;; In Overwrite mode, maybe untabify while deleting
998 ;; Otherwise, do simple deletion.
1002 "Delete the following N characters (previous if N is negative).
1003 If Transient Mark mode is enabled, the mark is active, and N is 1,
1004 delete the text in the region and deactivate the mark instead.
1005 To disable this, set variable `delete-active-region' to nil.
1007 Optional second arg KILLFLAG non-nil means to kill (save in kill
1008 ring) instead of delete. Interactively, N is the prefix arg, and
1009 KILLFLAG is set if N was explicitly specified."
1015 delete-active-region
1017 ;; If a region is active, kill or delete it.
1022 ;; Otherwise, do simple deletion.
1026 "Put point at beginning and mark at end of buffer.
1027 If narrowing is in effect, only uses the accessible part of the buffer.
1028 You probably should not use this function in Lisp programs;
1029 it is usually a mistake for a Lisp function to use any subroutine
1030 that uses or sets the mark."
1036 \f
1038 ;; Counting lines, one way or another.
1041 "Go to LINE, counting from line 1 at beginning of buffer.
1042 If called interactively, a numeric prefix argument specifies
1043 LINE; without a numeric prefix argument, read LINE from the
1044 minibuffer.
1046 If optional argument BUFFER is non-nil, switch to that buffer and
1048 as argument, BUFFER is the most recently selected other buffer.
1050 Prior to moving point, this function sets the mark (without
1051 activating it), unless Transient Mark mode is enabled and the
1052 mark is already active.
1054 This function is usually the wrong thing to use in a Lisp program.
1055 What you probably want instead is something like:
1056 (goto-char (point-min))
1057 (forward-line (1- N))
1058 If at all possible, an even better solution is to use char counts
1059 rather than line counts."
1064 ;; Look for a default, a number in the buffer at point.
1074 ;; Decide if we're switching buffers.
1082 ;; Read the argument, offering that number (if any) as default.
1085 buffer))))
1086 ;; Switch to the desired buffer, one way or another.
1091 ;; Leave mark at previous position
1093 ;; Move to the specified line number in that buffer.
1102 "Count the number of words in the region.
1103 If called interactively, print a message reporting the number of
1104 lines, words, and characters in the region (whether or not the
1105 region is active); with prefix ARG, report for the entire buffer
1106 rather than the region.
1108 If called from Lisp, return the number of words between positions
1109 START and END."
1121 "Count words between START and END.
1122 If called interactively, START and END are normally the start and
1123 end of the buffer; but if the region is active, START and END are
1124 the start and end of the region. Print a message reporting the
1125 number of lines, words, and chars.
1127 If called from Lisp, return the number of words between START and
1128 END, without printing any message."
1138 words))
1154 str
1162 "Print the current buffer line number and narrowed line number of point."
1175 "Return number of lines between START and END.
1176 This is usually the number of newlines between them,
1177 but can be one more if START is not equal to END
1178 and the greater of them is not at the start of a line."
1194 done)))
1198 "Return (narrowed) buffer line number at position POS.
1199 If POS is nil, use current buffer location.
1200 Counting starts at (point-min), so the value refers
1201 to the contents of the accessible portion of the buffer."
1211 "Print info on cursor position (on screen and within buffer).
1212 Also describe the character after point, and give its character code
1213 in octal, decimal and hex.
1215 For a non-ASCII multibyte character, also give its encoding in the
1216 buffer's selected coding system if the coding system encodes the
1217 character safely. If the character is encoded into one byte, that
1218 code is shown in hex. If the character is encoded into more than one
1221 In addition, with prefix argument, show details about that character
1222 in *Help* buffer. See also the command `describe-char'."
1226 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1227 ;; start a directional embedding, which could completely
1228 ;; disrupt the rest of the line (e.g., RLO will display the
1229 ;; rest of the line right-to-left). So we put an invisible
1230 ;; PDF character after these characters, to end the
1231 ;; embedding, which eliminates any effects on the rest of
1232 ;; the line. For RLE and RLO we also append an invisible
1233 ;; LRM, to avoid reordering the following numerical
1234 ;; characters. For LRI/RLI/FSI we append a PDI.
1241 ;; Strong right-to-left characters cause reordering of
1242 ;; the following numerical characters which show the
1243 ;; codepoint, so append LRM to countermand that.
1253 ;; Avoid overflow from multiplying by 100!
1257 ""
1263 pos total percent beg end col hscroll)
1265 pos total col hscroll))
1267 encoded encoding-msg display-prop under-display)
1274 ;; Check if the character is displayed with some `display'
1275 ;; text property. In that case, set under-display to the
1276 ;; buffer substring covered by that property.
1287 under-display)))
1293 char char char under-display)
1295 char char char under-display display-prop))
1298 char char char
1300 "..."
1304 ;; We show the detailed information about CHAR.
1311 bidi-fixer
1312 encoding-msg pos total percent beg end col hscroll)
1319 bidi-fixer encoding-msg pos total percent col hscroll))))))
1320 \f
1321 ;; Initialize read-expression-map. It is defined at C level.
1325 ;; Might as well bind TAB to completion, since inserting a TAB char is
1326 ;; much too rarely useful.
1329 m))
1332 "Return a Lisp object read using the minibuffer, unevaluated.
1333 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1334 is a string to insert in the minibuffer before reading.
1335 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1336 Such arguments are used as in `read-from-minibuffer'.)"
1337 ;; Used for interactive spec `x'.
1342 "Return value of Lisp expression read using the minibuffer.
1343 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1344 is a string to insert in the minibuffer before reading.
1345 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1346 Such arguments are used as in `read-from-minibuffer'.)"
1347 ;; Used for interactive spec `X'.
1355 "The current default value or list of default values in the minibuffer.
1356 The functions `read-from-minibuffer' and `completing-read' bind
1360 "Value for `print-level' while printing value in `eval-expression'.
1361 A value of nil means no limit."
1367 "Value for `print-length' while printing value in `eval-expression'.
1368 A value of nil means no limit."
1374 "If non-nil set `debug-on-error' to t in `eval-expression'.
1375 If nil, don't change the value of `debug-on-error'."
1381 "Format VALUE as a result of evaluated expression.
1382 Return a formatted string which is displayed in the echo area
1383 in addition to the value printed by prin1 in functions which
1384 display the result of expression evaluation."
1403 ;; FIXME: call emacs-lisp-mode?
1410 read-expression-map t
1413 ;; We define this, rather than making `eval' interactive,
1414 ;; for the sake of completion of names like eval-region, eval-buffer.
1416 "Evaluate EXP and print value in the echo area.
1417 When called interactively, read an Emacs Lisp expression and evaluate it.
1418 Value is also consed on to front of the variable `values'.
1419 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1420 argument) means insert the result into the current buffer instead of
1421 printing it in the echo area.
1423 Normally, this function truncates long output according to the value
1424 of the variables `eval-expression-print-length' and
1425 `eval-expression-print-level'. With a prefix argument of zero,
1426 however, there is no such truncation. Such a prefix argument
1427 also causes integers to be printed in several additional formats
1428 \(octal, hexadecimal, and character).
1430 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1431 minibuffer.
1433 If `eval-expression-debug-on-error' is non-nil, which is the default,
1434 this command arranges for all errors to enter the debugger."
1437 current-prefix-arg))
1442 ;; Bind debug-on-error to something unique so that we can
1443 ;; detect when evalled code changes it.
1447 ;; If evalled code has changed the value of debug-on-error,
1448 ;; propagate that change to the global binding.
1453 eval-expression-print-length))
1455 eval-expression-print-level))
1471 "Prompting with PROMPT, let user edit COMMAND and eval result.
1472 COMMAND is a Lisp expression. Let user edit that expression in
1473 the minibuffer, then read and evaluate the result."
1480 read-expression-map t
1482 ;; If command was added to command-history as a string,
1483 ;; get rid of that. We want only evaluable expressions there.
1487 ;; If command to be redone does not match front of history,
1488 ;; add it to the history.
1494 "Edit and re-evaluate last complex command, or ARGth from last.
1495 A complex command is one which used the minibuffer.
1496 The command is placed in the minibuffer as a Lisp form for editing.
1497 The result is executed, repeating the command as changed.
1498 If the command has been changed or is not the most recent previous
1499 command it is added to the front of the command history.
1500 You can use the minibuffer history commands \
1502 to get different commands to edit and resubmit."
1505 newcmd)
1517 ;; If command was added to command-history as a
1518 ;; string, get rid of that. We want only
1519 ;; evaluable expressions there.
1523 ;; If command to be redone does not match front of history,
1524 ;; add it to the history.
1538 "Read command name to invoke in `execute-extended-command'."
1543 ;; Get a command name at point in the original buffer
1544 ;; to propose it after M-n.
1548 ;; Read a string, completing from and restricting to the set of
1549 ;; all defined commands. Don't provide any initial input.
1550 ;; Save the command read on the extended-command history list.
1561 ;; This isn't strictly correct if `execute-extended-command'
1562 ;; is bound to anything else (e.g. [menu]).
1563 ;; It could use (key-description (this-single-command-keys)),
1564 ;; but actually a prompt other than "M-x" would be confusing,
1565 ;; because "M-x" is a well-known prompt to read a command
1566 ;; and it serves as a shorthand for "Extended command: ".
1571 "Non-nil means show the equivalent key-binding when M-x command has one.
1572 The value can be a length of time to show the message for.
1573 If the value is non-nil and not a number, we wait 2 seconds."
1580 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1581 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1582 "Read a command name, then read the arguments and call the command.
1583 Interactively, to pass a prefix argument to the command you are
1584 invoking, give a prefix argument to `execute-extended-command'.
1585 Noninteractively, the argument PREFIXARG is the prefix argument to
1586 give to the command you invoke."
1588 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1599 ;; Normally `real-this-command' should never be changed, but here we really
1600 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1601 ;; binding" for <cmd>, so the command the user really wanted to run is
1602 ;; `function' and not `execute-extended-command'. The difference is
1603 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1607 ;; If enabled, show which key runs this command.
1609 ;; But first wait, and skip the message if there is input.
1611 ;; If this command displayed something in the echo area;
1612 ;; wait a few seconds, then display our suggestion message.
1622 suggest-key-bindings
1626 ;; BEWARE: Called directly from the C code.
1627 "Execute CMD as an editor command.
1628 CMD must be a symbol that satisfies the `commandp' predicate.
1629 Optional second arg RECORD-FLAG non-nil
1630 means unconditionally put this command in the variable `command-history'.
1631 Otherwise, that is done only if an arg is read using the minibuffer.
1632 The argument KEYS specifies the value to use instead of (this-command-keys)
1633 when reading the arguments; if it is nil, (this-command-keys) is used.
1634 The argument SPECIAL, if non-nil, means that this command is executing
1635 a special event, so ignore the prefix argument and don't clear it."
1643 disabled-command-function)
1644 ;; FIXME: Weird calling convention!
1654 ;; If requested, place the macro in the command history. For
1655 ;; other sorts of commands, call-interactively takes care of this.
1658 ;; Don't keep command history around forever.
1664 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1672 \f
1674 "Default minibuffer history list.
1675 This is used for all minibuffer input
1676 except when an alternate history list is specified.
1678 Maximum length of the history list is determined by the value
1681 "Control whether history list elements are expressions or strings.
1682 If the value of this variable equals current minibuffer depth,
1683 they are expressions; otherwise they are strings.
1684 \(That convention is designed to do the right thing for
1691 "Text that was in this minibuffer before any history commands.
1692 This is nil if there have not yet been any history commands
1701 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1705 "Minibuffer history variables for which matching should ignore case.
1706 If a history variable is a member of this list, then the
1708 commands ignore case when searching it, regardless of `case-fold-search'."
1713 "Find the previous history element that matches REGEXP.
1714 \(Previous history elements refer to earlier actions.)
1715 With prefix argument N, search for Nth previous match.
1716 If N is negative, find the next or Nth next match.
1717 Normally, history elements are matched case-insensitively if
1718 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1719 makes the search case-sensitive.
1720 See also `minibuffer-history-case-insensitive-variables'."
1724 nil
1725 minibuffer-local-map
1726 nil
1727 'minibuffer-history-search-history
1729 ;; Use the last regexp specified, by default, if input is empty.
1734 regexp)
1744 ;; On some systems, ignore case for file names.
1746 minibuffer-history-case-insensitive-variables)
1747 t
1748 ;; Respect the user's setting for case-fold-search:
1749 case-fold-search)
1750 nil))
1751 prevpos
1752 match-string
1753 match-offset
1760 "No later matching history item"
1781 next-matching-history-element))
1785 "Find the next history element that matches REGEXP.
1786 \(The next history element refers to a more recent action.)
1787 With prefix argument N, search for Nth next match.
1788 If N is negative, find the previous or Nth previous match.
1789 Normally, history elements are matched case-insensitively if
1790 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1791 makes the search case-sensitive."
1795 nil
1796 minibuffer-local-map
1797 nil
1798 'minibuffer-history-search-history
1800 ;; Use the last regexp specified, by default, if input is empty.
1805 regexp)
1812 "Function run by `goto-history-element' before consuming default values.
1813 This is useful to dynamically add more elements to the list of default values
1814 when `goto-history-element' reaches the end of this list.
1815 Before calling this function `goto-history-element' sets the variable
1816 `minibuffer-default-add-done' to t, so it will call this function only
1817 once. In special cases, when this function needs to be called more
1818 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1822 "When nil, add more elements to the end of the list of default values.
1823 The value nil causes `goto-history-element' to add more elements to
1824 the list of defaults when it reaches the end of this list. It does
1830 "Return a list of all completions without the default value.
1831 This function is used to add all elements of the completion table to
1832 the end of the list of defaults just after the default value."
1835 minibuffer-completion-table
1836 minibuffer-completion-predicate)))
1842 "Puts element of the minibuffer history in the minibuffer.
1843 The argument NABS specifies the absolute history position."
1857 elt minibuffer-returned-to-present)
1864 "End of defaults; no next item"
1869 previous-history-element))
1881 minibuffer-default)))
1893 elt))
1897 "Puts next element of the minibuffer history in the minibuffer.
1898 With argument N, it uses the Nth following element."
1904 "Puts previous element of the minibuffer history in the minibuffer.
1905 With argument N, it uses the Nth previous element."
1911 "Get next 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."
1919 n)
1920 ;; next-matching-history-element always puts us at (point-min).
1921 ;; Move to the position we were at before changing the buffer contents.
1922 ;; This is still sensible, because the text before point has not changed.
1926 "\
1927 Get previous history element which completes the minibuffer before the point.
1928 The contents of the minibuffer after the point are deleted, and replaced
1929 by the new completion."
1933 ;; For compatibility with the old subr of the same name.
1935 "Return the display width of the minibuffer prompt.
1936 Return 0 if current buffer is not a minibuffer."
1937 ;; Return the width of everything before the field at the end of
1938 ;; the buffer; this should be 0 for normal buffers.
1940 \f
1941 ;; isearch minibuffer history
1948 "Set up a minibuffer for using isearch to search the minibuffer history.
1949 Intended to be added to `minibuffer-setup-hook'."
1961 "Clean up the minibuffer after terminating isearch in the minibuffer."
1966 "Return the proper search function, for isearch in minibuffer history."
1969 ;; Use standard functions to search within minibuffer text
1971 found)
1972 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1973 ;; searching forward. Lazy-highlight calls this lambda with the
1974 ;; bound arg, so skip the minibuffer prompt.
1978 ;; 1. First try searching in the initial minibuffer text
1981 noerror)
1982 ;; 2. If the above search fails, start putting next/prev history
1983 ;; elements in the minibuffer successively, and search the string
1984 ;; in them. Do this only when bound is nil (i.e. not while
1985 ;; lazy-highlighting search strings in the current minibuffer text).
1997 ;; After putting the next/prev history element, search
1998 ;; the string in them again, until next-history-element
1999 ;; or previous-history-element raises an error at the
2000 ;; beginning/end of history.
2003 ;; For backward search, don't search
2004 ;; in the minibuffer prompt
2006 noerror)))
2007 ;; Return point of the new search result
2009 ;; Return nil when next(prev)-history-element fails
2013 "Display the minibuffer history search prompt.
2014 If there are no search errors, this function displays an overlay with
2015 the isearch prompt which replaces the original minibuffer prompt.
2016 Otherwise, it displays the standard isearch message returned from
2017 the function `isearch-message'."
2019 ;; Use standard function `isearch-message' when not in the minibuffer,
2020 ;; or search fails, or has an error (like incomplete regexp).
2021 ;; This function overwrites minibuffer text with isearch message,
2022 ;; so it's possible to see what is wrong in the search string.
2024 ;; Otherwise, put the overlay with the standard isearch prompt over
2025 ;; the initial minibuffer prompt.
2034 ;; And clear any previous isearch message.
2038 "Wrap the minibuffer history search when search fails.
2039 Move point to the first history element for a forward search,
2040 or to the last history element for a backward search."
2041 ;; When `minibuffer-history-isearch-search' fails on reaching the
2042 ;; beginning/end of the history, wrap the search to the first/last
2043 ;; minibuffer history element.
2051 "Save a function restoring the state of minibuffer history search.
2052 Save `minibuffer-history-position' to the additional state parameter
2053 in the search status stack."
2059 "Restore the minibuffer history search state.
2060 Go to the history element by the absolute history position HIST-POS."
2063 \f
2064 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2068 "Table mapping redo records to the corresponding undo one.
2069 A redo record for undo-in-region maps to t.
2079 "Within a run of consecutive undo commands, list remaining to be undone.
2083 "Undo some previous changes.
2084 Repeat this command to undo more changes.
2085 A numeric ARG serves as a repeat count.
2087 In Transient Mark mode when the mark is active, only undo changes within
2089 as an argument limits undo to changes within the current region."
2091 ;; Make last-command indicate for the next command that this was an undo.
2092 ;; That way, another undo will undo more.
2093 ;; If we get to the end of the undo history and get an error,
2094 ;; another undo command will find the undo history empty
2095 ;; and will get another error. To begin undoing the undos,
2096 ;; you must type some other command.
2098 ;; For an indirect buffer, look in the base buffer for the
2099 ;; auto-save data.
2103 message)
2104 ;; If we get an error in undo-start,
2105 ;; the next command should not be a "consecutive undo".
2106 ;; So set `this-command' to something other than `undo'.
2111 ;; If something (a timer or filter?) changed the buffer
2112 ;; since the previous command, don't continue the undo seq.
2116 ;; If the last undo record made was made by undo
2117 ;; it shows nothing else happened in between.
2124 ;; get rid of initial undo boundary
2126 ;; If we got this far, the next command should be a consecutive undo.
2128 ;; Check to see whether we're hitting a redo record, and if
2129 ;; so, ask the user whether she wants to skip the redo/undo pair.
2137 ;; The equiv entry might point to another redo record if we have done
2138 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2146 ;; Record the fact that the just-generated undo records come from an
2147 ;; undo operation--that is, they are redo records.
2148 ;; In the ordinary case (not within a region), map the redo
2149 ;; record to the following undos.
2150 ;; I don't know how to do that in the undo-in-region case.
2152 ;; Strip any leading undo boundaries there might be, like we do
2153 ;; above when checking.
2157 ;; Prevent identity mapping. This can happen if
2158 ;; consecutive nils are erroneously in undo list.
2160 t
2161 pending-undo-list)
2162 undo-equiv-table))
2163 ;; Don't specify a position in the undo record for the undo command.
2164 ;; Instead, undoing this should move point to where the change is.
2183 ;; Record what the current undo list says,
2184 ;; so the next command can tell if the buffer was modified in between.
2188 ;; Display a message announcing success.
2193 "Make BUFFER stop keeping undo information.
2194 No argument or nil as argument means do this for the current buffer."
2200 "Undo some previous changes.
2201 Repeat this command to undo more changes.
2202 A numeric ARG serves as a repeat count.
2203 Contrary to `undo', this will not redo a previous undo."
2208 "Non-nil while performing an undo.
2212 "Undo back N undo-boundaries beyond what was already undone recently.
2213 Call `undo-start' to get ready to undo recent changes,
2214 then call `undo-more' one or more times to undo them."
2219 ;; Note: The following, while pulling elements off
2220 ;; `pending-undo-list' will call primitive change functions which
2221 ;; will push more elements onto `buffer-undo-list'.
2227 "Undo N records from the front of the list LIST.
2228 Return what remains of the list."
2230 ;; This is a good feature, but would make undo-start
2231 ;; unable to do what is expected.
2232 ;;(when (null (car (list)))
2233 ;; ;; If the head of the list is a boundary, it is the boundary
2234 ;; ;; preceding this command. Get rid of it and don't count it.
2235 ;; (setq list (cdr list))))
2238 ;; In a writable buffer, enable undoing read-only text that is
2239 ;; so because of text properties.
2241 ;; Don't let `intangible' properties interfere with undo.
2243 ;; We use oldlist only to check for EQ. ++kfs
2249 ;; Handle an integer by setting point to that value.
2252 ;; Element (t . TIME) records previous modtime.
2253 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2254 ;; UNKNOWN_MODTIME_NSECS.
2256 ;; If this records an obsolete save
2257 ;; (not matching the actual disk file)
2258 ;; then don't mark unmodified.
2266 ;; Element (nil PROP VAL BEG . END) is property change.
2271 ;; Element (BEG . END) means range was inserted.
2273 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2274 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2277 ;; Set point first thing, so that undoing this undo
2278 ;; does not send point back to where it is now.
2281 ;; Element (apply FUN . ARGS) means call FUN to undo.
2285 ;; Long format: (apply DELTA START END FUN . ARGS).
2292 ;; Check that the function did what the entry
2293 ;; said it would do.
2303 ;; Element (STRING . POS) means STRING was deleted.
2309 ;; Check that marker adjustments which were recorded
2310 ;; with the (STRING . POS) record are still valid, ie
2311 ;; the markers haven't moved. We check their validity
2312 ;; before reinserting the string so as we don't need to
2313 ;; mind marker insertion-type.
2321 ;; Insert string and adjust point
2329 ;; Adjust the valid marker adjustments
2333 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2336 next)
2337 ;; Even though these elements are not expected in the undo
2338 ;; list, adjust them to be conservative for the 24.4
2339 ;; release. (Bug#16818)
2346 ;; Make sure an apply entry produces at least one undo entry,
2347 ;; so the test in `undo' for continuing an undo series
2348 ;; will work right.
2353 list)
2355 ;; Deep copy of a list
2357 "Make a copy of undo list LIST."
2363 elt))
2366 "Set `pending-undo-list' to the front of the undo list.
2367 The next call to `undo-more' will undo the most recently made change.
2368 If BEG and END are specified, then only undo elements
2369 that apply to text between BEG and END are used; other undo elements
2370 are ignored. If BEG and END are nil, all undo elements are used."
2376 buffer-undo-list)))
2378 ;; The positions given in elements of the undo list are the positions
2379 ;; as of the time that element was recorded to undo history. In
2380 ;; general, subsequent buffer edits render those positions invalid in
2381 ;; the current buffer, unless adjusted according to the intervening
2382 ;; undo elements.
2383 ;;
2384 ;; Undo in region is a use case that requires adjustments to undo
2385 ;; elements. It must adjust positions of elements in the region based
2386 ;; on newer elements not in the region so as they may be correctly
2387 ;; applied in the current buffer. undo-make-selective-list
2388 ;; accomplishes this with its undo-deltas list of adjustments. An
2389 ;; example undo history from oldest to newest:
2390 ;;
2391 ;; buf pos:
2392 ;; 123456789 buffer-undo-list undo-deltas
2393 ;; --------- ---------------- -----------
2394 ;; aaa (1 . 4) (1 . -3)
2395 ;; aaba (3 . 4) N/A (in region)
2396 ;; ccaaba (1 . 3) (1 . -2)
2397 ;; ccaabaddd (7 . 10) (7 . -3)
2398 ;; ccaabdd ("ad" . 6) (6 . 2)
2399 ;; ccaabaddd (6 . 8) (6 . -2)
2400 ;; | |<-- region: "caab", from 2 to 6
2401 ;;
2402 ;; When the user starts a run of undos in region,
2403 ;; undo-make-selective-list is called to create the full list of in
2404 ;; region elements. Each element is adjusted forward chronologically
2405 ;; through undo-deltas to determine if it is in the region.
2406 ;;
2407 ;; In the above example, the insertion of "b" is (3 . 4) in the
2408 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2409 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2410 ;; . 6) is assessed as in the region and placed in the selective list.
2411 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2412 ;; due to the selected element. The "b" insertion is the only element
2413 ;; fully in the region, so in this example undo-make-selective-list
2414 ;; returns (nil (5 . 6)).
2415 ;;
2416 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2417 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2418 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2419 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2420 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2421 ;;
2422 ;; More interesting is how to adjust the "ddd" insertion due to the
2423 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2424 ;; If the reinsertion was a manual retyping of "ad", then the total
2425 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2426 ;; the reinsertion was due to undo, one might expect the first "d"
2427 ;; character would again be a part of the "ddd" text, meaning its
2428 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2429 ;;
2430 ;; undo-make-selective-list assumes in this situation that "ad" was a
2431 ;; new edit, even if it was inserted because of an undo.
2432 ;; Consequently, if the user undos in region "8 to 10" of the
2433 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2434 ;; "ccaabad", as though the first "d" became detached from the
2435 ;; original "ddd" insertion. This quirk is a FIXME.
2438 "Return a list of undo elements for the region START to END.
2439 The elements come from `buffer-undo-list', but we keep only the
2440 elements inside this region, and discard those outside this
2441 region. The elements' positions are adjusted so as the returned
2442 list can be applied to the current buffer."
2444 ;; A list of position adjusted undo elements in the region.
2446 ;; A list of undo-deltas for out of region undo elements.
2447 undo-deltas
2448 undo-elt)
2456 ;; Don't put two nils together in the list
2460 ;; This is a "was unmodified" element. Keep it
2461 ;; if we have kept everything thus far.
2464 ;; Skip over marker adjustments, instead relying
2465 ;; on finding them after (TEXT . POS) elements
2467 nil)
2470 undo-deltas)))
2475 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2476 ;; kept. primitive-undo may discard them later.
2489 "Determine whether UNDO-ELT falls inside the region START ... END.
2490 If it crosses the edge, we return nil.
2492 Generally this function is not useful for determining
2493 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2494 because markers can be arbitrarily relocated. Instead, pass the
2495 marker adjustment's corresponding (TEXT . POS) element."
2500 t)
2502 nil)
2504 ;; (TEXT . POSITION)
2508 ;; (MARKER . ADJUSTMENT)
2511 ;; (nil PROPERTY VALUE BEG . END)
2516 ;; (BEGIN . END)
2521 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2522 This assumes we have already decided that UNDO-ELT
2523 is not *inside* the region START...END."
2527 ;; (nil PROPERTY VALUE BEG . END)
2532 ;; (BEGIN . END)
2537 "Return adjustment of undo element ELT by the undo DELTAS
2538 list."
2540 ;; POSITION
2543 ;; (BEG . END)
2546 ;; (TEXT . POSITION)
2550 ;; (nil PROPERTY VALUE BEG . END)
2553 ;; (apply DELTA START END FUN . ARGS)
2554 ;; FIXME
2555 ;; All others return same elt
2558 ;; (BEG . END) can adjust to the same positions, commonly when an
2559 ;; insertion was undone and they are out of region, for example:
2560 ;;
2561 ;; buf pos:
2562 ;; 123456789 buffer-undo-list undo-deltas
2563 ;; --------- ---------------- -----------
2564 ;; [...]
2565 ;; abbaa (2 . 4) (2 . -2)
2566 ;; aaa ("bb" . 2) (2 . 2)
2567 ;; [...]
2568 ;;
2569 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2570 ;; undo. Further adjustments to such an element should be the same as
2571 ;; for (TEXT . POSITION) elements. The options are:
2572 ;;
2573 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2574 ;; analogous to marker insertion-type t.
2575 ;;
2576 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2577 ;; marker insertion-type nil.
2578 ;;
2579 ;; There was no strong reason to prefer one or the other, except that
2580 ;; the first is more consistent with prior undo in region behavior.
2582 "Return cons of adjustments to BEG and END by the undo DELTAS
2583 list."
2585 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2590 "Return adjustment of POS by the undo DELTAS list, comparing
2591 with < or <= based on USE-<."
2597 ;; Don't allow pos to become less than the undo-delta
2598 ;; position. This edge case is described in the overview
2599 ;; comments.
2602 ;; Return the first affected buffer position and the delta for an undo element
2603 ;; delta is defined as the change in subsequent buffer positions if we *did*
2604 ;; the undo.
2608 ;; (TEXT . POSITION)
2611 ;; (BEGIN . END)
2618 "If non-nil ask about discarding undo info for the current command.
2619 Normally, Emacs discards the undo info for the current command if
2620 it exceeds `undo-outer-limit'. But if you set this option
2621 non-nil, it asks in the echo area whether to discard the info.
2622 If you answer no, there is a slight risk that Emacs might crash, so
2623 only do it if you really want to undo the command.
2625 This option is mainly intended for debugging. You have to be
2626 careful if you use it for other purposes. Garbage collection is
2627 inhibited while the question is asked, meaning that Emacs might
2628 leak memory. So you should make sure that you do not wait
2629 excessively long before answering the question."
2635 "If non-nil, an extra level of size that's ok in an undo item.
2636 We don't ask the user about truncating the undo list until the
2637 current item gets bigger than this amount.
2642 ;; When the first undo batch in an undo list is longer than
2643 ;; undo-outer-limit, this function gets called to warn the user that
2644 ;; the undo info for the current command was discarded. Garbage
2645 ;; collection is inhibited around the call, so it had better not do a
2646 ;; lot of consing.
2652 ;; Don't ask the question again unless it gets even bigger.
2653 ;; This applies, in particular, if the user quits from the question.
2654 ;; Such a quit quits out of GC, but something else will call GC
2655 ;; again momentarily. It will call this function again,
2656 ;; but we don't want to ask the question again.
2663 t)
2664 nil))
2669 "The undo info was discarded because it exceeded \
2670 `undo-outer-limit'.
2672 This is normal if you executed a command that made a huge change
2673 to the buffer. In that case, to prevent similar problems in the
2674 future, set `undo-outer-limit' to a value that is large enough to
2675 cover the maximum size of normal changes you expect a single
2676 command to make, but not so large that it might exceed the
2677 maximum memory allotted to Emacs.
2679 If you did not execute any such command, the situation is
2680 probably due to a bug and you should report it.
2682 You can disable the popping up of this buffer by adding the entry
2683 \(undo discard-info) to the user option `warning-suppress-types',
2687 t))
2688 \f
2691 ; These are sorted according to the GNU en_US locale.
2734 )
2736 This is used by Shell mode and other parts of Emacs to recognize
2737 password prompts, including prompts in languages other than
2738 English. Different case choices should not be assumed to be
2739 included; callers should bind `case-fold-search' to t."
2745 "History list for some commands that read shell commands.
2747 Maximum length of the history list is determined by the value
2754 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2755 This buffer is used when `shell-command' or `shell-command-on-region'
2756 is run interactively. A value of nil means that output to stderr and
2763 "Return a list of all commands associated with the current file.
2764 This function is used to add all related commands retrieved by `mailcap'
2765 to the end of the list of defaults just after the default value."
2769 minibuffer-default))
2774 commands))
2785 map)
2789 "Read a shell command from the minibuffer.
2790 The arguments are the same as the ones of `read-from-minibuffer',
2791 except READ and KEYMAP are missing and HIST defaults
2792 to `shell-command-history'."
2800 minibuffer-local-shell-command-map
2801 nil
2803 args)))
2806 "What to do when the output buffer is used by another shell command.
2807 This option specifies how to resolve the conflict where a new command
2808 wants to direct its output to the buffer `*Async Shell Command*',
2809 but this buffer is already taken by another running shell command.
2811 The value `confirm-kill-process' is used to ask for confirmation before
2812 killing the already running process and running a new process
2813 in the same buffer, `confirm-new-buffer' for confirmation before running
2814 the command in a new buffer with a name other than the default buffer name,
2815 `new-buffer' for doing the same without confirmation,
2816 `confirm-rename-buffer' for confirmation before renaming the existing
2817 output buffer and running a new command in the default buffer,
2818 `rename-buffer' for doing the same without confirmation."
2820 confirm-kill-process)
2822 confirm-new-buffer)
2824 new-buffer)
2826 confirm-rename-buffer)
2828 rename-buffer))
2833 "Execute string COMMAND asynchronously in background.
2835 Like `shell-command', but adds `&' at the end of COMMAND
2836 to execute it asynchronously.
2838 The output appears in the buffer `*Async Shell Command*'.
2839 That buffer is in shell mode.
2841 You can configure `async-shell-command-buffer' to specify what to do in
2842 case when `*Async Shell Command*' buffer is already taken by another
2843 running shell command. To run COMMAND without displaying the output
2844 in a window you can configure `display-buffer-alist' to use the action
2845 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
2847 In Elisp, you will often be better served by calling `start-process'
2848 directly, since it offers more control and does not impose the use of a
2849 shell (with its need to quote arguments)."
2859 current-prefix-arg
2860 shell-command-default-error-buffer))
2866 "Execute string COMMAND in inferior shell; display output, if any.
2867 With prefix argument, insert the COMMAND's output at point.
2869 If COMMAND ends in `&', execute it asynchronously.
2870 The output appears in the buffer `*Async Shell Command*'.
2871 That buffer is in shell mode. You can also use
2872 `async-shell-command' that automatically adds `&'.
2874 Otherwise, COMMAND is executed synchronously. The output appears in
2875 the buffer `*Shell Command Output*'. If the output is short enough to
2876 display in the echo area (which is determined by the variables
2877 `resize-mini-windows' and `max-mini-window-height'), it is shown
2878 there, but it is nonetheless available in buffer `*Shell Command
2879 Output*' even though that buffer is not automatically displayed.
2881 To specify a coding system for converting non-ASCII characters
2883 before this command.
2885 Noninteractive callers can specify coding systems by binding
2886 `coding-system-for-read' and `coding-system-for-write'.
2888 The optional second argument OUTPUT-BUFFER, if non-nil,
2889 says to put the output in some other buffer.
2890 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2891 If OUTPUT-BUFFER is not a buffer and not nil,
2892 insert output in current buffer. (This cannot be done asynchronously.)
2893 In either case, the buffer is first erased, and the output is
2894 inserted after point (leaving mark after it).
2896 If the command terminates without error, but generates output,
2898 the output can be displayed in the echo area or in its buffer.
2899 If the output is short enough to display in the echo area
2900 \(determined by the variable `max-mini-window-height' if
2901 `resize-mini-windows' is non-nil), it is shown there.
2902 Otherwise,the buffer containing the output is displayed.
2906 of the output.
2908 If there is no output, or if output is inserted in the current buffer,
2909 then `*Shell Command Output*' is deleted.
2911 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2912 or buffer name to which to direct the command's standard error output.
2913 If it is nil, error output is mingled with regular output.
2914 In an interactive call, the variable `shell-command-default-error-buffer'
2915 specifies the value of ERROR-BUFFER.
2917 In Elisp, you will often be better served by calling `call-process' or
2918 `start-process' directly, since it offers more control and does not impose
2919 the use of a shell (with its need to quote arguments)."
2930 current-prefix-arg
2931 shell-command-default-error-buffer))
2932 ;; Look for a handler in case default-directory is a remote file name.
2940 ;; Output goes in current buffer.
2946 temporary-file-directory)))
2947 nil)))
2950 ;; We do not use -f for csh; we will not support broken use of
2951 ;; .cshrcs. Even the BSD csh manual says to use
2952 ;; "if ($?prompt) exit" before things which are not useful
2953 ;; non-interactively. Besides, if someone wants their other
2954 ;; aliases for shell commands then they can still have them.
2958 t)
2959 nil shell-command-switch command)
2966 ;; Do no formatting while reading error file,
2967 ;; because that can run a shell command, and we
2968 ;; don't want that to cause an infinite recursion.
2970 ;; Put point after the inserted errors.
2974 ;; This is like exchange-point-and-mark, but doesn't
2975 ;; activate the mark. It is cleaner to avoid activation,
2976 ;; even though the command loop would deactivate the mark
2977 ;; because we inserted text.
2981 ;; Output goes in a separate buffer.
2982 ;; Preserve the match data in case called from a program.
2985 ;; Command ending with ampersand means asynchronous.
2989 proc)
2990 ;; Remove the ampersand.
2992 ;; Ask the user what to do with already running process.
2997 ;; If will kill a process, query first.
3002 ;; If will create a new buffer, query first.
3008 ;; It will create a new buffer.
3012 ;; If will rename the buffer, query first.
3021 ;; It will rename the buffer.
3028 ;; Setting buffer-read-only to nil doesn't suffice
3029 ;; if some text has a non-nil read-only property,
3030 ;; which comint sometimes adds for prompts.
3036 shell-command-switch command))
3040 ;; Use the comint filter for proper handling of carriage motion
3041 ;; (see `comint-inhibit-carriage-motion'),.
3043 ))
3044 ;; Otherwise, command is executed synchronously.
3046 output-buffer nil error-buffer)))))))
3050 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3051 MESSAGE may be either a string or a buffer.
3053 A buffer is displayed using `display-buffer' if MESSAGE is too long for
3054 the maximum height of the echo area, as defined by `max-mini-window-height'
3055 if `resize-mini-windows' is non-nil.
3057 Returns either the string shown in the echo area, or when a pop-up
3058 buffer is used, the window used to display it.
3060 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3061 name of the buffer used to display it in the case where a pop-up buffer
3062 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3063 string and it is displayed in the echo area, it is not specified whether
3064 the contents are inserted into the buffer anyway.
3066 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
3067 and only used if a buffer is displayed."
3069 ;; Trivial case where we can use the echo area
3073 ;; Trivial case where we can just remove single trailing newline
3076 ;; General case
3079 message
3088 0
3092 (<= lines
3096 max-mini-window-height))
3098 max-mini-window-height)
3102 ;; Don't use the echo area if the output buffer is
3103 ;; already displayed in the selected frame.
3105 ;; Echo area
3111 ;; Buffer
3114 not-this-window frame))))))))
3117 ;; We have a sentinel to prevent insertion of a termination message
3118 ;; in the buffer itself.
3126 &optional output-buffer replace
3127 error-buffer display-error-buffer)
3128 "Execute string COMMAND in inferior shell with region as input.
3129 Normally display output (if any) in temp buffer `*Shell Command Output*';
3130 Prefix arg means replace the region with it. Return the exit code of
3131 COMMAND.
3133 To specify a coding system for converting non-ASCII characters
3135 before this command. By default, the input (from the current buffer)
3136 is encoded using coding-system specified by `process-coding-system-alist',
3137 falling back to `default-process-coding-system' if no match for COMMAND
3138 is found in `process-coding-system-alist'.
3140 Noninteractive callers can specify coding systems by binding
3141 `coding-system-for-read' and `coding-system-for-write'.
3143 If the command generates output, the output may be displayed
3144 in the echo area or in a buffer.
3145 If the output is short enough to display in the echo area
3146 \(determined by the variable `max-mini-window-height' if
3147 `resize-mini-windows' is non-nil), it is shown there.
3148 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3149 The output is available in that buffer in both cases.
3151 If there is output and an error, a message about the error
3152 appears at the end of the output. If there is no output, or if
3153 output is inserted in the current buffer, the buffer `*Shell
3154 Command Output*' is deleted.
3156 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3157 command's output. If the value is a buffer or buffer name,
3158 put the output there. If the value is nil, use the buffer
3159 `*Shell Command Output*'. Any other value, excluding nil,
3160 means to insert the output in the current buffer. In either case,
3161 the output is inserted after point (leaving mark after it).
3163 Optional fifth arg REPLACE, if non-nil, means to insert the
3164 output in place of text from START to END, putting point and mark
3165 around it.
3167 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3168 or buffer name to which to direct the command's standard error
3169 output. If nil, error output is mingled with regular output.
3170 When called interactively, `shell-command-default-error-buffer'
3171 is used for ERROR-BUFFER.
3173 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3174 display the error buffer if there were any errors. When called
3175 interactively, this is t."
3179 ;; Do this before calling region-beginning
3180 ;; and region-end, in case subprocess output
3181 ;; relocates them while we are in the minibuffer.
3183 ;; call-interactively recognizes region-beginning and
3184 ;; region-end specially, leaving them in the history.
3186 string
3187 current-prefix-arg
3188 current-prefix-arg
3189 shell-command-default-error-buffer
3190 t)))
3196 temporary-file-directory)))
3197 nil))
3198 exit-status)
3202 ;; Replace specified region with output from command.
3204 ;; Don't muck with mark unless REPLACE says we should.
3211 t)
3212 nil shell-command-switch command))
3213 ;; It is rude to delete a buffer which the command is not using.
3214 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3215 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3216 ;; (kill-buffer shell-buffer)))
3217 ;; Don't muck with mark unless REPLACE says we should.
3219 ;; No prefix argument: put the output in a temp buffer,
3220 ;; replacing its entire contents.
3225 ;; If the input is the same buffer as the output,
3226 ;; delete everything but the specified region,
3227 ;; then replace that region with the output.
3233 shell-file-name t
3236 t)
3237 nil shell-command-switch
3238 command)))
3239 ;; Clear the output buffer, then run the command with
3240 ;; output there.
3251 buffer)
3252 nil shell-command-switch command)))
3253 ;; Report the output.
3263 ;; There's some output, display it
3265 ;; No output; error?
3272 shell-command-default-error-buffer)
3279 output))
3282 exit-status))
3285 exit-status output))))
3286 ;; Don't kill: there might be useful info in the undo-log.
3287 ;; (kill-buffer buffer)
3288 ))))
3296 ;; Do no formatting while reading error file,
3297 ;; because that can run a shell command, and we
3298 ;; don't want that to cause an infinite recursion.
3300 ;; Put point after the inserted errors.
3305 exit-status))
3308 "Execute shell command COMMAND and return its output as a string."
3311 standard-output
3315 "Process files synchronously in a separate process.
3316 Similar to `call-process', but may invoke a file handler based on
3317 `default-directory'. The current working directory of the
3318 subprocess is `default-directory'.
3320 File names in INFILE and BUFFER are handled normally, but file
3321 names in ARGS should be relative to `default-directory', as they
3322 are passed to the process verbatim. (This is a difference to
3323 `call-process' which does not support file handlers for INFILE
3324 and BUFFER.)
3326 Some file handlers might not support all variants, for example
3327 they might behave as if DISPLAY was nil, regardless of the actual
3328 value passed."
3330 lc stderr-file)
3340 display args)
3346 "Whether a call of `process-file' changes remote files.
3348 By default, this variable is always set to `t', meaning that a
3349 call of `process-file' could potentially change any file on a
3350 remote host. When set to `nil', a file handler could optimize
3351 its behavior with respect to remote file attribute caching.
3353 You should only ever change this variable with a let-binding;
3357 "Start a program in a subprocess. Return the process object for it.
3359 Similar to `start-process', but may invoke a file handler based on
3360 `default-directory'. See Info node `(elisp)Magic File Names'.
3362 This handler ought to run PROGRAM, perhaps on the local host,
3363 perhaps on a remote host that corresponds to `default-directory'.
3364 In the latter case, the local part of `default-directory' becomes
3365 the working directory of the process.
3367 PROGRAM and PROGRAM-ARGS might be file names. They are not
3368 objects of file handler invocation. File handlers might not
3369 support pty association, if PROGRAM is nil."
3373 \f
3374 ;;;; Process menu
3388 map))
3391 "Major mode for listing the processes called by Emacs."
3403 "Kill process at point in a `list-processes' buffer."
3409 "Recompute the list of processes for the Process List buffer.
3410 Also, delete any process that is exited or signaled."
3423 face link
3426 follow-link t
3427 process-buffer ,buf
3428 action process-menu-visit-buffer)
3437 "datagram"
3454 tabulated-list-entries))))))
3460 "Display a list of all processes that are Emacs sub-processes.
3461 If optional argument QUERY-ONLY is non-nil, only processes with
3462 the query-on-exit flag set are listed.
3463 Any process listed as exited or signaled is actually eliminated
3464 after the listing is made.
3465 Optional argument BUFFER specifies a buffer to use, instead of
3467 The return value is always nil.
3469 This function lists only processes that were launched by Emacs. To
3470 see other processes running on the system, use `list-system-processes'."
3482 nil)
3483 \f
3487 ;; For backward compatibility, minus with no modifiers is an ordinary
3488 ;; command if digits have already been entered.
3518 map)
3525 "Begin a numeric argument for the following command.
3530 multiplies the argument by 4 each time.
3532 which is different in effect from any particular numeric argument.
3539 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3540 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3546 arg)))
3550 "Begin a negative numeric argument for the next command.
3559 "Part of the numeric argument for the next command.
3563 last-command-event
3570 ;; Treat -0 as just -, so that -01 will work.
3573 digit))))
3575 \f
3583 "Function to perform the filtering in `filter-buffer-substring'.
3584 The function is called with the same 3 arguments (BEG END DELETE)
3585 that `filter-buffer-substring' received. It should return the
3586 buffer substring between BEG and END, after filtering. If DELETE is
3590 "List of filter functions for `buffer-substring--filter'.
3591 Each function must accept a single argument, a string, and return a string.
3592 The buffer substring is passed to the first function in the list,
3593 and the return value of each function is passed to the next.
3594 As a special convention, point is set to the start of the buffer text
3595 being operated on (i.e., the first argument of `buffer-substring--filter')
3601 "Return the buffer substring between BEG and END, after filtering.
3602 If DELETE is non-nil, delete the text between BEG and END from the buffer.
3604 This calls the function that `filter-buffer-substring-function' specifies
3605 \(passing the same three arguments that it received) to do the work,
3606 and returns whatever it does. The default function does no filtering,
3607 unless a hook has been set.
3609 Use `filter-buffer-substring' instead of `buffer-substring',
3610 `buffer-substring-no-properties', or `delete-and-extract-region' when
3611 you want to allow filtering to take place. For example, major or minor
3612 modes can use `filter-buffer-substring-function' to extract characters
3613 that are special to a buffer, and should not be copied into other buffers."
3617 "Default function to use for `filter-buffer-substring-function'.
3618 Its arguments and return value are as specified for `filter-buffer-substring'.
3619 This respects the wrapper hook `filter-buffer-substring-functions',
3620 and the abnormal hook `buffer-substring-filters'.
3621 No filtering is done unless a hook says to."
3631 string)))
3636 ;;;; Window system cut and paste hooks.
3639 "Function to call to make a killed region available to other programs.
3640 Most window systems provide a facility for cutting and pasting
3641 text between different programs, such as the clipboard on X and
3642 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3644 This variable holds a function that Emacs calls whenever text is
3645 put in the kill ring, to make the new kill available to other
3646 programs. The function takes one argument, TEXT, which is a
3650 "Function to call to get text cut from other programs.
3651 Most window systems provide a facility for cutting and pasting
3652 text between different programs, such as the clipboard on X and
3653 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3655 This variable holds a function that Emacs calls to obtain text
3656 that other programs have provided for pasting. The function is
3657 called with no arguments. If no other program has provided text
3658 to paste, the function should return nil (in which case the
3659 caller, usually `current-kill', should use the top of the Emacs
3660 kill ring). If another program has provided text to paste, the
3661 function should return that text as a string (in which case the
3662 caller should put this string in the kill ring as the latest
3663 kill).
3665 The function may also return a list of strings if the window
3666 system supports multiple selections. The first string will be
3667 used as the pasted text, but the other will be placed in the kill
3668 ring for easy access via `yank-pop'.
3670 Note that the function should return a string only if a program
3671 other than Emacs has provided a string for pasting; if Emacs
3672 provided the most recent string, the function should return nil.
3673 If it is difficult to tell whether Emacs or some other program
3674 provided the current string, it is probably good enough to return
3675 nil if the string is equal (according to `string=') to the last
3677 \f
3680 ;;;; The kill ring data structure.
3683 "List of killed text sequences.
3684 Since the kill ring is supposed to interact nicely with cut-and-paste
3685 facilities offered by window systems, use of this variable should
3686 interact nicely with `interprogram-cut-function' and
3687 `interprogram-paste-function'. The functions `kill-new',
3688 `kill-append', and `current-kill' are supposed to implement this
3689 interaction; you may want to use them instead of manipulating the kill
3693 "Maximum length of kill ring before oldest elements are thrown away."
3701 "Save clipboard strings into kill ring before replacing them.
3702 When one selects something in another program to paste it into Emacs,
3703 but kills something in Emacs before actually pasting it,
3704 this selection is gone unless this variable is non-nil,
3705 in which case the other program's selection is saved in the `kill-ring'
3712 "Do not add a new string to `kill-ring' if it duplicates the last one.
3713 The comparison is done using `equal-including-properties'."
3719 "Make STRING the latest kill in the kill ring.
3720 Set `kill-ring-yank-pointer' to point to it.
3721 If `interprogram-cut-function' is non-nil, apply it to STRING.
3722 Optional second argument REPLACE non-nil means that STRING will replace
3723 the front of the kill ring, rather than being added to the list.
3725 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3726 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3727 STRING.
3729 When the yank handler has a non-nil PARAM element, the original STRING
3730 argument is not used by `insert-for-yank'. However, since Lisp code
3731 may access and use elements from the kill ring directly, the STRING
3734 ;; Due to text properties such as 'yank-handler that
3735 ;; can alter the contents to yank, comparison using
3736 ;; `equal' is unsafe.
3761 ;; It has been argued that this should work similar to `self-insert-command'
3762 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
3764 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
3770 "Append STRING to the end of the latest kill in the kill ring.
3771 If BEFORE-P is non-nil, prepend STRING to the kill.
3772 Also removes the last undo boundary in the current buffer,
3773 depending on `kill-append-merge-undo'.
3774 If `interprogram-cut-function' is set, pass the resulting kill to it."
3782 ;; find the next undo boundary
3786 ;; remove this undo boundary
3791 "Whether rotating the kill ring changes the window system selection.
3792 If non-nil, whenever the kill ring is rotated (usually via the
3793 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3794 to copy the new kill to the window system selection."
3800 "Rotate the yanking point by N places, and then return that kill.
3801 If N is zero and `interprogram-paste-function' is set to a
3802 function that returns a string or a list of strings, and if that
3803 function doesn't return nil, then that string (or list) is added
3804 to the front of the kill ring and the string (or first string in
3805 the list) is returned as the latest kill.
3807 If N is not zero, and if `yank-pop-change-selection' is
3808 non-nil, use `interprogram-cut-function' to transfer the
3809 kill at the new yank point into the window system selection.
3811 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3812 move the yanking point; just return the Nth kill forward."
3815 interprogram-paste-function
3819 ;; Disable the interprogram cut function when we add the new
3820 ;; text to the kill ring, so Emacs doesn't try to own the
3821 ;; selection, with identical text.
3831 kill-ring)))
3836 interprogram-cut-function)
3842 ;;;; Commands for manipulating the kill ring.
3845 "Non-nil means don't signal an error for killing read-only text."
3851 This deletes the text from the buffer and saves it in the kill ring.
3855 If you want to append the killed region to the last killed text,
3858 If the buffer is read-only, Emacs will beep and refrain from deleting
3859 the text, but put the text in the kill ring anyway. This means that
3860 you can use the killing commands to copy text from a read-only buffer.
3862 Lisp programs should use this function for killing text.
3863 (To delete text, use `delete-region'.)
3864 Supply two arguments, character positions indicating the stretch of text
3865 to be killed.
3867 If the previous command was also a kill command,
3868 the text killed this time appends to the text killed last time
3869 to make one entry in the kill ring.
3871 The optional argument REGION if non-nil, indicates that we're not just killing
3872 some text between BEG and END, but we're killing the region."
3873 ;; Pass mark first, then point, because the order matters when
3874 ;; calling `kill-append'.
3883 ;; Add that string to the kill ring, one way or another.
3890 nil)
3892 ;; The code above failed because the buffer, or some of the characters
3893 ;; in the region, are read-only.
3894 ;; We should beep, in case the user just isn't aware of this.
3895 ;; However, there's no harm in putting
3896 ;; the region's text in the kill ring, anyway.
3898 ;; Set this-command now, so it will be set even if we get an error.
3900 ;; This should barf, if appropriate, and give us the correct error.
3903 ;; Signal an error if the buffer is read-only.
3905 ;; If the buffer isn't read-only, the text is.
3908 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3909 ;; to get two copies of the text when the user accidentally types M-w and
3910 ;; then corrects it with the intended C-w.
3912 "Save the region as if killed, but don't kill it.
3913 In Transient Mark mode, deactivate the mark.
3914 If `interprogram-cut-function' is non-nil, also save the text for a window
3915 system cut and paste.
3917 The optional argument REGION if non-nil, indicates that we're not just copying
3918 some text between BEG and END, but we're copying the region.
3920 This command's old key binding has been given to `kill-ring-save'."
3921 ;; Pass mark first, then point, because the order matters when
3922 ;; calling `kill-append'.
3932 nil)
3935 "Save the region as if killed, but don't kill it.
3936 In Transient Mark mode, deactivate the mark.
3937 If `interprogram-cut-function' is non-nil, also save the text for a window
3938 system cut and paste.
3940 If you want to append the killed line to the last killed text,
3943 The optional argument REGION if non-nil, indicates that we're not just copying
3944 some text between BEG and END, but we're copying the region.
3946 This command is similar to `copy-region-as-kill', except that it gives
3947 visual feedback indicating the extent of the region being copied."
3948 ;; Pass mark first, then point, because the order matters when
3949 ;; calling `kill-append'.
3953 ;; This use of called-interactively-p is correct because the code it
3954 ;; controls just gives the user visual feedback.
3959 "Indicate that the region text has been copied interactively.
3960 If the mark is visible in the selected window, blink the cursor
3961 between point and mark if there is currently no active region
3962 highlighting.
3964 If the mark lies outside the selected window, display an
3965 informative message containing a sample of the copied text. The
3966 optional argument MESSAGE-LEN, if non-nil, specifies the length
3967 of this sample text; it defaults to 40."
3970 ;; Inhibit quitting so we can make a quit here
3971 ;; look like a C-g typed as a command.
3974 ;; Swap point-and-mark quickly so as to show the region that
3975 ;; was selected. Don't do it if the region is highlighted.
3978 ;; Swap point and mark.
3982 ;; Swap back.
3985 ;; If user quit, deactivate the mark
3986 ;; as C-g would as a command.
3992 ;; Don't say "killed"; that is misleading.
3999 "Cause following command, if it kills, to add to previous kill.
4000 If the next command kills forward from point, the kill is
4001 appended to the previous killed text. If the command kills
4002 backward, the kill is prepended. Kill commands that act on the
4003 region, such as `kill-region', are regarded as killing forward if
4004 point is after mark, and killing backward if point is before
4005 mark.
4007 If the next command is not a kill command, `append-next-kill' has
4008 no effect.
4010 The argument is used for internal purposes; do not supply one."
4012 ;; We don't use (interactive-p), since that breaks kbd macros.
4018 \f
4019 ;; Yanking.
4024 "List of special text property handling conditions for yanking.
4025 Each element should have the form (PROP . FUN), where PROP is a
4026 property symbol and FUN is a function. When the `yank' command
4027 inserts text into the buffer, it scans the inserted text for
4028 stretches of text that have `eq' values of the text property
4029 PROP; for each such stretch of text, FUN is called with three
4030 arguments: the property's value in that text, and the start and
4031 end positions of the text.
4033 This is done prior to removing the properties specified by
4034 `yank-excluded-properties'."
4037 function))
4040 ;; This is actually used in subr.el but defcustom does not work there.
4043 intangible invisible keymap local-map mouse-face read-only
4044 yank-handler)
4045 "Text properties to discard when yanking.
4046 The value should be a list of text properties to discard or t,
4047 which means to discard all text properties.
4049 See also `yank-handled-properties'."
4056 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4057 Function is called with two parameters, START and END corresponding to
4058 the value of the mark and point; it is guaranteed that START <= END.
4062 "Replace just-yanked stretch of killed text with a different stretch.
4063 This command is allowed only immediately after a `yank' or a `yank-pop'.
4064 At such a time, the region contains a stretch of reinserted
4065 previously-killed text. `yank-pop' deletes that text and inserts in its
4066 place a different stretch of killed text.
4068 With no argument, the previous kill is inserted.
4069 With argument N, insert the Nth previous kill.
4070 If N is negative, this is a more recent kill.
4072 The sequence of kills wraps around, so that after the oldest one
4073 comes the newest one.
4075 When this command inserts killed text into the buffer, it honors
4076 `yank-excluded-properties' and `yank-handler' as described in the
4077 doc string for `insert-for-yank-1', which see."
4091 ;; Set the window start back where it was in the yank command,
4092 ;; if possible.
4095 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4096 ;; It is cleaner to avoid activation, even though the command
4097 ;; loop would deactivate the mark because we inserted text.
4100 nil)
4104 More precisely, reinsert the most recent kill, which is the
4105 stretch of killed text most recently killed OR yanked. Put point
4106 at the end, and set mark at the beginning without activating it.
4108 With argument N, reinsert the Nth most recent kill.
4110 When this command inserts text into the buffer, it honors the
4111 `yank-handled-properties' and `yank-excluded-properties'
4112 variables, and the `yank-handler' text property. See
4113 `insert-for-yank-1' for details.
4118 ;; If we don't get all the way thru, make last-command indicate that
4119 ;; for the following command.
4127 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4128 ;; It is cleaner to avoid activation, even though the command
4129 ;; loop would deactivate the mark because we inserted text.
4132 ;; If we do get all the way thru, make this-command indicate that.
4135 nil)
4138 "Rotate the yanking point in the kill ring.
4139 With ARG, rotate that many kills forward (or backward, if negative)."
4142 \f
4143 ;; Some kill commands.
4145 ;; Internal subroutine of delete-char
4151 ;; Internal subroutine of backward-delete-char
4158 "The method for untabifying when deleting backward.
4159 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4160 `hungry' -- delete all whitespace, both tabs and spaces;
4161 `all' -- delete all whitespace, including tabs, spaces and newlines;
4162 nil -- just delete one character."
4168 "Delete characters backward, changing tabs into spaces.
4169 The exact behavior depends on `backward-delete-char-untabify-method'.
4170 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4171 Interactively, ARG is the prefix arg (default 1)
4172 and KILLP is t if a prefix arg was specified."
4195 arg)))
4196 ;; Avoid warning about delete-backward-char
4200 "Kill up to and including ARGth occurrence of CHAR.
4201 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4202 Goes backward if ARG is negative; error if CHAR not found."
4205 ;; Avoid "obsolete" warnings for translation-table-for-input.
4213 ;; kill-line and its subroutines.
4216 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4221 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4222 With prefix argument ARG, kill that many lines from point.
4223 Negative arguments kill lines backward.
4224 With zero argument, kills the text before point on the current line.
4227 a number counts as a prefix arg.
4229 To kill a whole line, when point is not at the beginning, type \
4232 If `show-trailing-whitespace' is non-nil, this command will just
4233 kill the rest of the current line, even if there are only
4234 nonblanks there.
4236 If option `kill-whole-line' is non-nil, then this command kills the whole line
4237 including its terminating newline, when used at the beginning of a line
4238 with no argument. As a consequence, you can always kill a whole line
4241 If you want to append the killed line to the last killed text,
4244 If the buffer is read-only, Emacs will beep and refrain from deleting
4245 the line, but put the line in the kill ring anyway. This means that
4246 you can use this command to copy text from a read-only buffer.
4247 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4248 even beep.)"
4251 ;; It is better to move point to the other end of the kill
4252 ;; before killing. That way, in a read-only buffer, point
4253 ;; moves across the text that is copied to the kill ring.
4254 ;; The choice has no effect on undo now that undo records
4255 ;; the value of point from before the command was run.
4265 ;; If trailing whitespace is visible,
4266 ;; don't treat it as nothing.
4276 "Kill current line.
4277 With prefix ARG, kill that many lines starting from the current line.
4278 If ARG is negative, kill backward. Also kill the preceding newline.
4280 If ARG is zero, kill current line but exclude the trailing newline."
4291 ;; We need to kill in two steps, because the previous command
4292 ;; could have been a kill command, in which case the text
4293 ;; before point needs to be prepended to the current kill
4294 ;; ring entry and the text after point appended. Also, we
4295 ;; need to use save-excursion to avoid copying the same text
4296 ;; twice to the kill ring in read-only buffers.
4314 "Move forward by ARG lines, ignoring currently invisible newlines only.
4315 If ARG is negative, move backward -ARG lines.
4316 If ARG is zero, move to the beginning of the current line."
4323 ;; If the newline we just skipped is invisible,
4324 ;; don't count it.
4328 prop
4333 ;; If invisible text follows, and it is a number of complete lines,
4334 ;; skip it.
4340 prop
4356 ;; If the newline we just moved to is invisible,
4357 ;; don't count it.
4362 prop
4367 ;; If invisible text follows, and it is a number of complete lines,
4368 ;; skip it.
4374 prop
4385 nil)))
4388 "Move to end of current visible line."
4390 ;; If the following character is currently invisible,
4391 ;; skip all characters with that same `invisible' property value,
4392 ;; then find the next newline.
4399 prop
4408 \f
4410 "Insert after point the contents of BUFFER.
4411 Puts mark after the inserted text.
4412 BUFFER may be a buffer or a buffer name."
4422 t))))
4427 nil)
4430 "Append to specified buffer the text of the region.
4431 It is inserted into that buffer before its point.
4433 When calling from a program, give three arguments:
4434 BUFFER (or buffer name), START and END.
4435 START and END specify the portion of the current buffer to be copied."
4442 point)
4453 "Prepend to specified buffer the text of the region.
4454 It is inserted into that buffer after its point.
4456 When calling from a program, give three arguments:
4457 BUFFER (or buffer name), START and END.
4458 START and END specify the portion of the current buffer to be copied."
4467 "Copy to specified buffer the text of the region.
4468 It is inserted into that buffer, replacing existing text there.
4470 When calling from a program, give three arguments:
4471 BUFFER (or buffer name), START and END.
4472 START and END specify the portion of the current buffer to be copied."
4480 \f
4484 "Hook run when the mark becomes active.
4485 It is also run at the end of a command, if the mark is active and
4492 "Return this buffer's mark value as integer, or nil if never set.
4494 In Transient Mark mode, this function signals an error if
4495 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4496 or the argument FORCE is non-nil, it disregards whether the mark
4497 is active, and returns an integer or nil in the usual way.
4499 If you are using this in an editing command, you are most likely making
4500 a mistake; see the documentation of `set-mark'."
4505 ;; Behind display-selections-p.
4508 "Deactivate the mark.
4509 If Transient Mark mode is disabled, this function normally does
4510 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4512 Deactivating the mark sets `mark-active' to nil, updates the
4513 primary selection according to `select-active-regions', and runs
4514 `deactivate-mark-hook'.
4516 If Transient Mark mode was temporarily enabled, reset the value
4517 of the variable `transient-mark-mode'; if this causes Transient
4518 Mark mode to be disabled, don't change `mark-active' to nil or
4519 run `deactivate-mark-hook'."
4523 select-active-regions)
4526 ;; The var `saved-region-selection', if non-nil, is the text in
4527 ;; the region prior to the last command modifying the buffer.
4528 ;; Set the selection to that, or to the current region.
4532 ;; If another program has acquired the selection, region
4533 ;; deactivation should not clobber it (Bug#11772).
4552 "Activate the mark.
4553 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
4563 "Set this buffer's mark to POS. Don't use this function!
4564 That is to say, don't use this function unless you want
4565 the user to see that the mark has moved, and you want the previous
4566 mark position to be lost.
4568 Normally, when a new mark is set, the old one should go on the stack.
4569 This is why most applications should use `push-mark', not `set-mark'.
4571 Novice Emacs Lisp programmers often try to use the mark for the wrong
4572 purposes. The mark saves a location for the user's convenience.
4573 Most editing commands should not alter the mark.
4574 To remember a location for internal use in the Lisp program,
4575 store it in a Lisp variable. Example:
4577 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4582 ;; Normally we never clear mark-active except in Transient Mark mode.
4583 ;; But when we actually clear out the mark value too, we must
4584 ;; clear mark-active in any mode.
4586 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
4587 ;; it should never be nil if the mark is nil.
4593 If nil, region-aware commands treat empty regions as inactive.
4594 If non-nil, region-aware commands treat the region as active as
4595 long as the mark is active, even if the region is empty.
4597 Region-aware commands are those that act on the region if it is
4598 active and Transient Mark mode is enabled, and on the text near
4599 point otherwise."
4605 "Return t if the region is active and it is appropriate to act on it.
4606 This is used by commands that act specially on the region under
4607 Transient Mark mode.
4609 The return value is t if Transient Mark mode is enabled and the
4610 mark is active; furthermore, if `use-empty-active-region' is nil,
4611 the region must not be empty. Otherwise, the return value is nil.
4613 For some commands, it may be appropriate to ignore the value of
4614 `use-empty-active-region'; in that case, use `region-active-p'."
4619 "Return t if Transient Mark mode is enabled and the mark is active.
4621 Some commands act specially on the region when Transient Mark
4622 mode is enabled. Usually, such commands should use
4623 `use-region-p' instead of this function, because `use-region-p'
4624 also checks the value of `use-empty-active-region'."
4626 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
4627 ;; without the mark being set (e.g. bug#17324). We really should fix
4628 ;; that problem, but in the mean time, let's make sure we don't say the
4629 ;; region is active when there's no mark.
4643 ;; Normal priority so that a large region doesn't hide all the
4644 ;; overlays within it, but high secondary priority so that if it
4645 ;; ends/starts in the middle of a small overlay, that small overlay
4646 ;; won't hide the region's boundaries.
4648 nrol)
4653 rol)))
4666 start end window rol)))
4669 new)))))))
4694 "Maximum size of mark ring. Start discarding off end if gets this big."
4702 "Maximum size of global mark ring. \
4703 Start discarding off end if gets this big."
4708 "Jump to mark, and pop a new position for mark off the ring.
4709 \(Does not affect global mark ring)."
4719 "Set mark at where point is.
4720 If no prefix ARG and mark is already set there, just activate it.
4721 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4733 will pop the mark twice, and
4735 will pop the mark three times.
4743 "Set the mark where point is, or jump to the mark.
4744 Setting the mark also alters the region, which is the text
4745 between point and mark; this is the closest equivalent in
4748 With no prefix argument, set the mark at point, and push the
4749 old mark position on local mark ring. Also push the old mark on
4750 global mark ring, if the previous mark was set in another buffer.
4752 When Transient Mark Mode is off, immediately repeating this
4753 command activates `transient-mark-mode' temporarily.
4756 jump to the mark, and set the mark from
4757 position popped off the local mark ring (this does not affect the global
4759 mark ring (see `pop-global-mark').
4761 If `set-mark-command-repeat-pop' is non-nil, repeating
4763 off the local (or global) mark ring and jumps there.
4766 argument, unconditionally set mark where point is, even if
4767 `set-mark-command-repeat-pop' is non-nil.
4769 Novice Emacs Lisp programmers often try to use the mark for the wrong
4770 purposes. See the documentation of `set-mark' for more information."
4790 arg)
4804 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4805 If the last global mark pushed was not in the current buffer,
4806 also push LOCATION on the global mark ring.
4807 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4809 Novice Emacs Lisp programmers often try to use the mark for the wrong
4810 purposes. See the documentation of `set-mark' for more information.
4812 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4819 ;; Now push the mark on the global mark ring.
4822 ;; The last global mark pushed was in this same buffer.
4823 ;; Don't push another one.
4824 nil
4833 nil)
4836 "Pop off mark ring into the buffer's actual mark.
4837 Does not set point. Does nothing if mark ring is empty."
4849 "Put the mark where point is now, and point where the mark is now.
4850 This command works even when the mark is not active,
4851 and it reactivates the mark.
4853 If Transient Mark mode is on, a prefix ARG deactivates the mark
4854 if it is active, and otherwise avoids reactivating it. If
4855 Transient Mark mode is off, a prefix ARG enables Transient Mark
4856 mode temporarily."
4870 nil))
4873 "When non-nil, shifted motion keys activate the mark momentarily.
4875 While the mark is activated in this way, any shift-translated point
4876 motion key extends the region, and if Transient Mark mode was off, it
4877 is temporarily turned on. Furthermore, the mark will be deactivated
4878 by any subsequent point motion key that was not shift-translated, or
4879 by any action that normally deactivates the mark in Transient Mark mode.
4881 See `this-command-keys-shift-translated' for the meaning of
4882 shift-translation."
4887 "Activate/deactivate mark depending on invocation thru shift translation.
4888 This function is called by `call-interactively' when a command
4889 with a `^' character in its `interactive' spec is invoked, before
4890 running the command itself.
4892 If `shift-select-mode' is enabled and the command was invoked
4893 through shift translation, set the mark and activate the region
4894 temporarily, unless it was already set in this way. See
4895 `this-command-keys-shift-translated' for the meaning of shift
4896 translation.
4898 Otherwise, if the region has been activated temporarily,
4899 deactivate it, and restore the variable `transient-mark-mode' to
4900 its earlier value."
4907 transient-mark-mode)))
4916 "Toggle Transient Mark mode.
4917 With a prefix argument ARG, enable Transient Mark mode if ARG is
4918 positive, and disable it otherwise. If called from Lisp, enable
4919 Transient Mark mode if ARG is omitted or nil.
4921 Transient Mark mode is a global minor mode. When enabled, the
4922 region is highlighted whenever the mark is active. The mark is
4924 operations that set the mark but whose main purpose is something
4930 Many commands change their behavior when Transient Mark mode is
4931 in effect and the mark is active, by acting on the region instead
4932 of their usual default part of the buffer's text. Examples of
4935 To see the documentation of commands which are sensitive to the
4938 :global t
4939 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4943 "Non-nil means it is ok for commands to call `widen' when they want to.
4944 Some commands will do this in order to go to positions outside
4945 the current accessible part of the buffer.
4947 If `widen-automatically' is nil, these commands will do something else
4951 "Whether the currently executing code is performing an essential task.
4952 This variable should be non-nil only when running code which should not
4953 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4954 user for a password when we are simply scanning a set of files in the
4955 background or displaying possible completions before the user even asked
4959 "Pop off global mark ring and jump to the top location."
4961 ;; Pop entries which refer to non-existent buffers.
4979 \f
4981 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4987 "Move cursor vertically down ARG lines.
4988 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4989 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4990 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4991 function will not vscroll.
4993 ARG defaults to 1.
4995 If there is no character in the target line exactly under the current column,
4996 the cursor is positioned after the character in that line which spans this
4997 column, or at the end of the line if it is not long enough.
4998 If there is no line in the buffer after this one, behavior depends on the
4999 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5000 to create a line, and moves the cursor to that line. Otherwise it moves the
5001 cursor to the end of the buffer.
5003 If the variable `line-move-visual' is non-nil, this command moves
5004 by display lines. Otherwise, it moves by buffer lines, without
5005 taking variable-width characters or continued lines into account.
5008 a semipermanent goal column for this command.
5009 Then instead of trying to move exactly vertically (or as close as possible),
5010 this command moves to the specified goal column (or as close as possible).
5011 The goal column is stored in the variable `goal-column', which is nil
5012 when there is no goal column. Note that setting `goal-column'
5013 overrides `line-move-visual' and causes this command to move by buffer
5014 lines rather than by display lines."
5020 ;; When adding a newline, don't expand an abbrev.
5031 nil)
5034 "Move cursor vertically up ARG lines.
5035 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5036 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5037 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5038 function will not vscroll.
5040 ARG defaults to 1.
5042 If there is no character in the target line exactly over the current column,
5043 the cursor is positioned after the character in that line which spans this
5044 column, or at the end of the line if it is not long enough.
5046 If the variable `line-move-visual' is non-nil, this command moves
5047 by display lines. Otherwise, it moves by buffer lines, without
5048 taking variable-width characters or continued lines into account.
5051 a semipermanent goal column for this command.
5052 Then instead of trying to move exactly vertically (or as close as possible),
5053 this command moves to the specified goal column (or as close as possible).
5054 The goal column is stored in the variable `goal-column', which is nil
5055 when there is no goal column. Note that setting `goal-column'
5056 overrides `line-move-visual' and causes this command to move by buffer
5057 lines rather than by display lines."
5068 nil)
5071 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5072 This means moving to the end of each line moved onto.
5073 The beginning of a blank line does not count as the end of a line.
5074 This has no effect when the variable `line-move-visual' is non-nil."
5080 A non-nil setting overrides the variable `line-move-visual', which see."
5087 "Current goal column for vertical motion.
5088 It is the column where point was at the start of the current run
5089 of vertical motion commands.
5091 When moving by visual lines via the function `line-move-visual', it is a cons
5092 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5093 divided by the default column width, and HSCROLL is the number of
5094 columns by which window is scrolled from left margin.
5096 When the `track-eol' feature is doing its job, the value is
5100 "Non-nil means commands that move by lines ignore invisible newlines.
5101 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5102 as if newlines that are invisible didn't exist, and count
5103 only visible newlines. Thus, moving across across 2 newlines
5104 one of which is invisible will be counted as a one-line move.
5105 Also, a non-nil value causes invisible text to be ignored when
5106 counting columns for the purposes of keeping point in the same
5109 Outline mode sets this."
5114 "When non-nil, `line-move' moves point by visual lines.
5115 This movement is based on where the cursor is displayed on the
5116 screen, instead of relying on buffer contents alone. It takes
5117 into account variable-width characters and line continuation.
5118 If nil, `line-move' moves point by logical lines.
5119 A non-nil setting of `goal-column' overrides the value of this variable
5120 and forces movement by logical lines.
5121 A window that is horizontally scrolled also forces movement by logical
5122 lines."
5127 ;; Only used if display-graphic-p.
5131 "Return the height in pixels of the current buffer's default face font."
5135 ;; Avoid calling font-info if the frame's default font was
5136 ;; not changed since the frame was created. That's because
5137 ;; font-info is expensive for some fonts, see bug #14838.
5143 "Return the pixel height of current buffer's default-face text line.
5145 The value includes `line-spacing', if any, defined for the buffer
5146 or the frame."
5159 "Return the number of screen lines in the text area of the selected window.
5161 This is different from `window-text-height' in that this function counts
5162 lines in units of the height of the font used by the default face displayed
5163 in the window, not in units of the frame's default font, and also accounts
5164 for `line-spacing', if any, defined for the window's buffer or frame.
5166 The value is a floating-point number."
5171 ;; Returns non-nil if partial move was done.
5174 ;; Move backward (up).
5175 ;; If already vscrolled, reduce vscroll
5181 ;; Move forward (down).
5194 py vs last-line)
5214 col-row)
5219 ;; VPOS > 0 means the last line is only partially visible.
5220 ;; But if the part that is visible is at least as tall as the
5221 ;; default font, that means the line is actually fully
5222 ;; readable, and something like line-spacing is hidden. So in
5223 ;; that case we accept the last line in the window as still
5224 ;; visible, and consider the margin as starting one line
5225 ;; later.
5233 ;; If last line of window is fully visible, and vscrolling
5234 ;; more would make this line invisible, move forward.
5239 nil)
5240 ;; If cursor is not in the bottom scroll margin, and the
5241 ;; current line is is not too tall, move forward.
5243 vpos
5246 nil)
5247 ;; When already vscrolled, we vscroll some more if we can,
5248 ;; or clear vscroll and move forward at end of tall image.
5253 ;; If cursor just entered the bottom scroll margin, move forward,
5254 ;; but also optionally vscroll one line so redisplay won't recenter.
5258 ;; Don't vscroll if the partially-visible line at window
5259 ;; bottom is not too tall (a.k.a. "just one more text
5260 ;; line"): in that case, we do want redisplay to behave
5261 ;; normally, i.e. recenter or whatever.
5262 ;;
5263 ;; Note: ROWH + RBOT from the value returned by
5264 ;; pos-visible-in-window-p give the total height of the
5265 ;; partially-visible glyph row at the end of the window. As
5266 ;; we are dealing with floats, we disregard sub-pixel
5267 ;; discrepancies between that and DLH.
5271 t)
5272 ;; If there are lines above the last line, scroll-up one line.
5275 t)
5276 ;; Finally, start vscroll.
5281 ;; This is like line-move-1 except that it also performs
5282 ;; vertical scrolling of tall images if appropriate.
5283 ;; That is not really a clean thing to do, since it mixes
5284 ;; scrolling with cursor motion. But so far we don't have
5285 ;; a cleaner solution to the problem of making C-n do something
5286 ;; useful given a tall image.
5288 "Move forward ARG lines.
5289 If NOERROR, don't signal an error if we can't move ARG lines.
5290 TO-END is unused.
5291 TRY-VSCROLL controls whether to vscroll tall lines: if either
5292 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5293 not vscroll."
5297 ;; Only vscroll for single line moves
5299 ;; Under scroll-conservatively, the display engine
5300 ;; does this better.
5302 ;; But don't vscroll in a keyboard macro.
5308 ;; Display-based column are incompatible with goal-column.
5310 ;; When the text in the window is scrolled to the left,
5311 ;; display-based motion doesn't make sense (because each
5312 ;; logical line occupies exactly one screen line).
5314 ;; Likewise when the text _was_ scrolled to the left
5315 ;; when the current run of vertical motion commands
5316 ;; started.
5319 auto-hscroll-mode
5321 (>= temporary-goal-column
5324 ;; If we moved into a tall line, set vscroll to make
5325 ;; scrolling through tall images more smooth.
5329 winh)
5335 nil
5339 ;; Display-based alternative to line-move-1.
5340 ;; Arg says how many lines to move. The value is t if we can move the
5341 ;; specified number of lines.
5343 "Move ARG lines forward.
5344 If NOERROR, don't signal an error if we can't move that many lines."
5347 target-hscroll)
5348 ;; Check if the previous command was a line-motion command, or if
5349 ;; we were called from some other command.
5352 ;; If so, there's no need to reset `temporary-goal-column',
5353 ;; but we may need to hscroll.
5357 ;; Otherwise, we should reset `temporary-goal-column'.
5360 ;; Handle the `overflow-newline-into-fringe' case:
5369 ;; vertical-motion can move more than it was asked to if it moves
5370 ;; across display strings with newlines. We don't want to ring
5371 ;; the bell and announce beginning/end of buffer in that case.
5377 temporary-goal-column))
5378 arg))
5379 arg))
5385 temporary-goal-column))
5386 arg))
5387 arg)))
5390 ;; If the goal column lies on a display string,
5391 ;; `vertical-motion' advances the cursor to the end
5392 ;; of the string. For arg < 0, this can cause the
5393 ;; cursor to get stuck. (Bug#3020).
5397 nil)))))
5399 ;; This is the guts of next-line and previous-line.
5400 ;; Arg says how many lines to move.
5401 ;; The value is t if we can move the specified number of lines.
5403 ;; Don't run any point-motion hooks, and disregard intangibility,
5404 ;; for intermediate positions.
5416 ;; Don't count beg of empty line as end of line
5417 ;; unless we just did explicit end-of-line.
5419 most-positive-fixnum
5423 line-move-ignore-invisible))
5424 ;; Use just newline characters.
5425 ;; Set ARG to 0 if we move as many lines as requested.
5428 ;; This way of moving forward ARG lines
5429 ;; verifies that we have a newline after the last one.
5430 ;; It doesn't get confused by intangible text.
5439 'beginning-of-buffer
5441 nil)))
5442 ;; Move by arg lines, but ignore invisible ones.
5445 ;; If the following character is currently invisible,
5446 ;; skip all characters with that same `invisible' property value.
5449 ;; Move a line.
5450 ;; We don't use `end-of-line', since we want to escape
5451 ;; from field boundaries occurring exactly at point.
5457 ;; If there's no invisibility here, move over the newline.
5466 ;; We avoid vertical-motion when possible
5467 ;; because that has to fontify.
5469 ;; Otherwise move a more sophisticated way.
5476 ;; The logic of this is the same as the loop above,
5477 ;; it just goes in the other direction.
5479 ;; For completely consistency with the forward-motion
5480 ;; case, we should call beginning-of-line here.
5481 ;; However, if point is inside a field and on a
5482 ;; continued line, the call to (vertical-motion -1)
5483 ;; below won't move us back far enough; then we return
5484 ;; to the same column in line-move-finish, and point
5485 ;; gets stuck -- cyd
5503 ;; if our target is the middle of this line.
5508 ;; This is the value the function returns.
5512 ;; If we did not move down as far as desired, at least go
5513 ;; to end of line. Be sure to call point-entered and
5514 ;; point-left-hooks.
5520 ;; If we did not move up as far as desired,
5521 ;; at least go to beginning of line.
5533 ;; Set REPEAT to t to repeat the whole thing.
5540 ;; Compute the end of the line
5541 ;; ignoring effectively invisible newlines.
5543 ;; Like end-of-line but ignores fields.
5550 ;; Move to the desired column.
5553 ;; Corner case: suppose we start out in a field boundary in
5554 ;; the middle of a continued line. When we get to
5555 ;; line-move-finish, point is at the start of a new *screen*
5556 ;; line but the same text line; then line-move-to-column would
5557 ;; move us backwards. Test using C-n with point on the "x" in
5558 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5565 ;; Process intangibility within a line.
5566 ;; With inhibit-point-motion-hooks bound to nil, a call to
5567 ;; goto-char moves point past intangible text.
5569 ;; However, inhibit-point-motion-hooks controls both the
5570 ;; intangibility and the point-entered/point-left hooks. The
5571 ;; following hack avoids calling the point-* hooks
5572 ;; unnecessarily. Note that we move *forward* past intangible
5573 ;; text when the initial and final points are the same.
5578 ;; If intangibility moves us to a different (later) place
5579 ;; in the same line, use that as the destination.
5582 ;; If that position is "too late",
5583 ;; try the previous allowable position.
5584 ;; See if it is ok.
5587 ;; If going forward, don't accept the previous
5588 ;; allowable position if it is before the target line.
5590 ;; If going backward, don't accept the previous
5591 ;; allowable position if it is still after the target line.
5594 ;; As a last resort, use the end of the line.
5597 ;; Now move to the updated destination, processing fields
5598 ;; as well as intangibility.
5602 ;; Ignore field boundaries if the initial and final
5603 ;; positions have the same `field' property, even if the
5604 ;; fields are non-contiguous. This seems to be "nicer"
5605 ;; behavior in many situations.
5608 new
5612 ;; If all this moved us to a different line,
5613 ;; retry everything within that new line.
5615 ;; Repeat the intangibility and field processing.
5619 "Try to find column COL, considering invisibility.
5620 This function works only in certain cases,
5621 because what we really need is for `move-to-column'
5622 and `current-column' to be able to ignore invisible text."
5631 ;; If the following character is currently invisible,
5632 ;; skip all characters with that same `invisible' property value.
5636 ;; Have we advanced to a larger column position?
5638 ;; We have made some progress towards the desired column.
5639 ;; See if we can make any further progress.
5641 ;; Otherwise, go to the place we originally found
5642 ;; and move back over invisible text.
5643 ;; that will get us to the same place on the screen
5644 ;; but with a more reasonable buffer position.
5651 "Move point to end of current line as displayed.
5652 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5653 If point reaches the beginning or end of buffer, it stops there.
5655 To ignore the effects of the `intangible' text or overlay
5656 property, bind `inhibit-point-motion-hooks' to t.
5657 If there is an image in the current line, this function
5658 disregards newlines that are part of the text on which the image
5659 rests."
5669 ;; With bidi reordering, we may not be at bol,
5670 ;; so make sure we are.
5685 ;; If we skipped something intangible and now we're not
5686 ;; really at eol, keep going.
5691 "Move point to beginning of current line as displayed.
5692 \(If there's an image in the line, this disregards newlines
5693 which are part of the text that the image rests on.)
5695 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5696 If point reaches the beginning or end of buffer, it stops there.
5697 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5702 first-vis first-vis-field-value)
5704 ;; Move by lines, if ARG is not 1 (the default).
5709 ;; Move to beginning-of-line, ignoring fields and invisible text.
5715 ;; Now find first visible char in the line.
5720 ;; See if fields would stop us from reaching FIRST-VIS.
5725 ;; If yes, obey them.
5726 first-vis-field-value
5727 ;; Otherwise, move to START with attention to fields.
5728 ;; (It is possible that fields never matter in this case.)
5733 ;; Many people have said they rarely use this feature, and often type
5734 ;; it by accident. Maybe it shouldn't even be on a key.
5739 Those commands will move to this position in the line moved to
5740 rather than trying to keep the same horizontal position.
5741 With a non-nil argument ARG, clears out the goal column
5743 The goal column is stored in the variable `goal-column'."
5750 ;; The older method below can be erroneous if `set-goal-column' is bound
5751 ;; to a sequence containing %
5752 ;;(message (substitute-command-keys
5753 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
5754 ;;goal-column)
5761 )
5762 nil)
5763 \f
5764 ;;; Editing based on visual lines, as opposed to logical lines.
5767 "Move point to end of current visual line.
5768 With argument N not nil or 1, move forward N - 1 visual lines first.
5769 If point reaches the beginning or end of buffer, it stops there.
5770 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5776 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5777 ;; constrain to field boundaries, so we don't either.
5781 "Move point to beginning of current visual line.
5782 With argument N not nil or 1, move forward N - 1 visual lines first.
5783 If point reaches the beginning or end of buffer, it stops there.
5784 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5792 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5796 "Kill the rest of the visual line.
5797 With prefix argument ARG, kill that many visual lines from point.
5798 If ARG is negative, kill visual lines backward.
5799 If ARG is zero, kill the text before point on the current visual
5800 line.
5802 If you want to append the killed line to the last killed text,
5805 If the buffer is read-only, Emacs will beep and refrain from deleting
5806 the line, but put the line in the kill ring anyway. This means that
5807 you can use this command to copy text from a read-only buffer.
5808 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5809 even beep.)"
5811 ;; Like in `kill-line', it's better to move point to the other end
5812 ;; of the kill before killing.
5820 ;; Skip any trailing whitespace at the end of the visual line.
5821 ;; We used to do this only if `show-trailing-whitespace' is
5822 ;; nil, but that's wrong; the correct thing would be to check
5823 ;; whether the trailing whitespace is highlighted. But, it's
5824 ;; OK to just do this unconditionally.
5831 "Move cursor vertically down ARG lines.
5832 This is identical to `next-line', except that it always moves
5833 by logical lines instead of visual lines, ignoring the value of
5834 the variable `line-move-visual'."
5841 "Move cursor vertically up ARG lines.
5842 This is identical to `previous-line', except that it always moves
5843 by logical lines instead of visual lines, ignoring the value of
5844 the variable `line-move-visual'."
5851 "Editing based on visual lines."
5860 ;; These keybindings interfere with xterm function keys. Are
5861 ;; there any other suitable bindings?
5862 ;; (define-key map "\M-[" 'previous-logical-line)
5863 ;; (define-key map "\M-]" 'next-logical-line)
5864 map))
5867 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5868 The value should be a list of the form (LEFT RIGHT), where LEFT
5869 and RIGHT are symbols representing the bitmaps to display, to
5870 indicate wrapped lines, in the left and right fringes respectively.
5871 See also `fringe-indicator-alist'.
5872 The default is not to display fringe indicators for wrapped lines.
5873 This variable does not affect fringe indicators displayed for
5874 other purposes."
5889 'continuation
5896 "Toggle visual line based editing (Visual Line mode).
5897 With a prefix argument ARG, enable Visual Line mode if ARG is
5898 positive, and disable it otherwise. If called from Lisp, enable
5899 the mode if ARG is omitted or nil.
5901 When Visual Line mode is enabled, `word-wrap' is turned on in
5902 this buffer, and simple editing commands are redefined to act on
5903 visual lines, not logical lines. See Info node `Visual Line
5904 Mode' for details."
5905 :keymap visual-line-mode-map
5911 ;; Save the local values of some variables, to be restored if
5912 ;; visual-line-mode is turned off.
5914 truncate-partial-width-windows
5915 word-wrap fringe-indicator-alist))
5918 visual-line--saved-state)))
5922 word-wrap t
5923 fringe-indicator-alist
5925 fringe-indicator-alist)))
5939 visual-line-mode turn-on-visual-line-mode)
5941 \f
5943 "Interchange characters around point, moving forward one character.
5944 With prefix arg ARG, effect is to take character before point
5945 and drag it forward past ARG other characters (backward if ARG negative).
5946 If no argument and at end of line, the previous two chars are exchanged."
5954 "Interchange words around point, leaving point at end of them.
5955 With prefix arg ARG, effect is to take word before or around point
5956 and drag it forward past ARG other words (backward if ARG negative).
5957 If ARG is zero, the words around or after point and around or after mark
5958 are interchanged."
5959 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5965 Does not work on a sexp that point is in the middle of
5966 if it is a list or string."
5970 ;; Here we should try to simulate the behavior of
5971 ;; (cons (progn (forward-sexp x) (point))
5972 ;; (progn (forward-sexp (- x)) (point)))
5973 ;; Except that we don't want to rely on the second forward-sexp
5974 ;; putting us back to where we want to be, since forward-sexp-function
5975 ;; might do funny things like infix-precedence.
5980 ;; Jumping over a symbol. We might be inside it, mind you.
5985 ;; Otherwise, we're between sexps. Take a step back before jumping
5986 ;; to make sure we'll obey the same precedence no matter which direction
5987 ;; we're going.
5992 'skip-syntax-forward
5999 "Exchange current line and previous line, leaving point after both.
6000 With argument ARG, takes previous line and moves it past ARG lines.
6001 With argument 0, interchanges line point is in with line mark is in."
6007 ;; Move forward over ARG lines,
6008 ;; but create newlines if necessary.
6015 arg))
6017 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6018 ;; which seems inconsistent with the ARG /= 0 case.
6019 ;; FIXME document SPECIAL.
6021 "Subroutine to do the work of transposing objects.
6022 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6023 moves forward by units of the given object (e.g. forward-sentence,
6024 forward-paragraph). If ARG is zero, exchanges the current object
6025 with the one containing mark. If ARG is an integer, moves the
6026 current object past ARG following (if ARG is positive) or
6027 preceding (if ARG is negative) objects, leaving point after the
6028 current object."
6033 pos1 pos2)
6061 ;; This sequence of insertions attempts to preserve marker
6062 ;; positions at the start and end of the transposed objects.
6076 \f
6078 "Move backward until encountering the beginning of a word.
6079 With argument ARG, do this that many times.
6080 If ARG is omitted or nil, move point backward one word."
6085 "Set mark ARG words away from point.
6087 move to with the same argument.
6088 Interactively, if this command is repeated
6089 or (in Transient Mark mode) if the mark is active,
6090 it marks the next ARG words after the ones already marked."
6107 nil t))))
6110 "Kill characters forward until encountering the end of a word.
6111 With argument ARG, do this that many times."
6116 "Kill characters backward until encountering the beginning of a word.
6117 With argument ARG, do this that many times."
6122 "Return the symbol or word that point is on (or a nearby one) as a string.
6123 The return value includes no text properties.
6124 If optional arg STRICT is non-nil, return nil unless point is within
6125 or adjacent to a symbol or word. In all cases the value can be nil
6126 if there is no word nearby.
6127 The function, belying its name, normally finds a symbol.
6128 If optional arg REALLY-WORD is non-nil, it finds just a word."
6137 ;; Point is neither within nor adjacent to a word.
6139 ;; Look for preceding word in same line.
6142 ;; No preceding word in same line.
6143 ;; Look for following word in same line.
6152 ;; If we found something nonempty, return it as a string.
6155 \f
6157 "String for filling to insert at front of new line, or nil for none."
6159 string)
6165 "Regexp to match lines which should not be auto-filled."
6167 regexp)
6171 "The default value for `normal-auto-fill-function'.
6172 This is the default auto-fill function, some major modes use a different one.
6173 Returns t if it really did any work."
6183 nil ;; Auto-filling not required
6187 ;; Choose a fill-prefix automatically.
6195 ;; Use auto-indentation rather than a guessed empty prefix.
6201 ;; Determine where to split the line.
6214 ;; See whether the place we found is any good.
6218 ;; There is no use breaking at end of line.
6220 ;; It is futile to split at the end of the prefix
6221 ;; since we would just insert the prefix again.
6223 ;; Don't split right after a comment starter
6224 ;; since we would just make another comment starter.
6229 limit t)
6231 ;; No good place to break => stop trying.
6233 ;; Ok, we have a useful place to break the line. Do it.
6235 ;; If point is at the fill-point, do not `save-excursion'.
6236 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6237 ;; point will end up before it rather than after it.
6245 ;; Now do justification, if required
6250 ;; If making the new line didn't reduce the hpos of
6251 ;; the end of the line, then give up now;
6252 ;; trying again will not help.
6255 ;; Justify last line.
6257 t)))
6260 "Mode-specific function which line breaks and continues a comment.
6261 This function is called during auto-filling when a comment syntax
6262 is defined.
6263 The function should take a single optional argument, which is a flag
6267 "Break line at point and indent.
6268 If a comment syntax is defined, call `comment-indent-new-line'.
6270 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6271 unless optional argument SOFT is non-nil."
6275 ;; Insert the newline before removing empty space so that markers
6276 ;; get preserved better.
6282 ;; Blindly trust a non-adaptive fill-prefix.
6288 ;; If there's an adaptive prefix, use it unless we're inside
6289 ;; a comment and the prefix is not a comment starter.
6293 ;; If we're not inside a comment, just try to indent.
6297 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6301 ;; `functions' and `hooks' are usually unsafe to set, but setting
6302 ;; auto-fill-function to nil in a file-local setting is safe and
6303 ;; can be useful to prevent auto-filling.
6307 "Toggle automatic line breaking (Auto Fill mode).
6308 With a prefix argument ARG, enable Auto Fill mode if ARG is
6309 positive, and disable it otherwise. If called from Lisp, enable
6310 the mode if ARG is omitted or nil.
6312 When Auto Fill mode is enabled, inserting a space at a column
6313 beyond `current-fill-column' automatically breaks the line at a
6314 previous space.
6316 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6317 non-`nil'.
6319 The value of `normal-auto-fill-function' specifies the function to use
6320 for `auto-fill-function' when turning Auto Fill mode on."
6325 ;; This holds a document string used to document auto-fill-mode.
6327 "Automatically break line at a previous space, in insertion of text."
6328 nil)
6331 "Unconditionally turn on Auto Fill mode."
6335 "Unconditionally turn off Auto Fill mode."
6341 "Set `fill-column' to specified argument.
6346 ;; We used to use current-column silently, but C-x f is too easily
6347 ;; typed as a typo for C-x C-f, so we turned it into an error and
6348 ;; now an interactive prompt.
6353 ;; Disallow missing argument; it's probably a typo for C-x C-f.
6357 \f
6359 "Set `selective-display' to ARG; clear it if no arg.
6360 When the value of `selective-display' is a number > 0,
6361 lines whose indentation is >= that value are not displayed.
6362 The variable `selective-display' has a separate value for each buffer."
6382 "Toggle truncating of long lines for the current buffer.
6383 When truncating is off, long lines are folded.
6384 With prefix argument ARG, truncate long lines if ARG is positive,
6385 otherwise fold them. Note that in side-by-side windows, this
6386 command has no effect if `truncate-partial-width-windows' is
6387 non-nil."
6399 nil t)))
6404 "Toggle whether to use word-wrapping for continuation lines.
6405 With prefix argument ARG, wrap continuation lines at word boundaries
6406 if ARG is positive, otherwise wrap them at the right screen edge.
6407 This command toggles the value of `word-wrap'. It has no effect
6408 if long lines are truncated."
6424 "Toggle Overwrite mode.
6425 With a prefix argument ARG, enable Overwrite mode if ARG is
6426 positive, and disable it otherwise. If called from Lisp, enable
6427 the mode if ARG is omitted or nil.
6429 When Overwrite mode is enabled, printing characters typed in
6430 replace existing text on a one-for-one basis, rather than pushing
6431 it to the right. At the end of a line, such characters extend
6432 the line. Before a tab, such characters insert until the tab is
6434 overwrite mode; this is supposed to make it easier to insert
6435 characters when necessary."
6440 "Toggle Binary Overwrite mode.
6441 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6442 is positive, and disable it otherwise. If called from Lisp,
6443 enable the mode if ARG is omitted or nil.
6445 When Binary Overwrite mode is enabled, printing characters typed
6446 in replace existing text. Newlines are not treated specially, so
6447 typing at the end of a line joins the line to the next, with the
6448 typed character between them. Typing before a tab character
6449 simply replaces the tab with the character typed.
6451 ordinary typing characters do.
6453 Note that Binary Overwrite mode is not its own minor mode; it is
6454 a specialization of overwrite mode, entered by setting the
6455 `overwrite-mode' variable to `overwrite-mode-binary'."
6460 "Toggle line number display in the mode line (Line Number mode).
6461 With a prefix argument ARG, enable Line Number mode if ARG is
6462 positive, and disable it otherwise. If called from Lisp, enable
6463 the mode if ARG is omitted or nil.
6465 Line numbers do not appear for very large buffers and buffers
6466 with very long lines; see variables `line-number-display-limit'
6467 and `line-number-display-limit-width'."
6471 "Toggle column number display in the mode line (Column Number mode).
6472 With a prefix argument ARG, enable Column Number mode if ARG is
6473 positive, and disable it otherwise.
6475 If called from Lisp, enable the mode if ARG is omitted or nil."
6479 "Toggle buffer size display in the mode line (Size Indication mode).
6480 With a prefix argument ARG, enable Size Indication mode if ARG is
6481 positive, and disable it otherwise.
6483 If called from Lisp, enable the mode if ARG is omitted or nil."
6487 "Toggle auto-saving in the current buffer (Auto Save mode).
6488 With a prefix argument ARG, enable Auto Save mode if ARG is
6489 positive, and disable it otherwise.
6491 If called from Lisp, enable the mode if ARG is omitted or nil."
6493 ;; If auto-save is off because buffer has shrunk,
6494 ;; then toggling should turn it on.
6502 buffer-file-name)
6504 ;; If -1 was stored here, to temporarily turn off saving,
6505 ;; turn it back on.
6508 \f
6510 "Blinking matching of parens and expressions."
6515 "Non-nil means show matching open-paren when close-paren is inserted.
6516 If t, highlight the paren. If `jump', move cursor to its position."
6524 "Non-nil means show matching open-paren when it is on screen.
6525 If nil, don't show it (but the open-paren can still be shown
6526 when it is off screen).
6528 This variable has no effect if `blink-matching-paren' is nil.
6529 \(In that case, the open-paren is never shown.)
6530 It is also ignored if `show-paren-mode' is enabled."
6535 "If non-nil, maximum distance to search backwards for matching open-paren.
6536 If nil, search stops at the beginning of the accessible portion of the buffer."
6542 "Time in seconds to delay after showing a matching paren."
6547 "If nil, `blink-matching-paren' ignores comments.
6548 More precisely, when looking for the matching parenthesis,
6549 it skips the contents of comments that end before point."
6554 "Return whether or not START...END are matching parens.
6555 END is the current point and START is the blink position.
6556 START might be nil if no matching starter was found.
6557 Returns non-nil if we find there is a mismatch."
6562 ;; For self-matched chars like " and $, we can't know when they're
6563 ;; mismatched or unmatched, so we can only do it for parens.
6568 ;; The cdr might hold a new paren-class info rather than
6569 ;; a matching-char info, in which case the two CDRs
6570 ;; should match.
6574 "Function to check parentheses mismatches.
6575 The function takes two arguments (START and END) where START is the
6576 position just before the opening token and END is the position right after.
6577 START can be nil, if it was not found.
6584 ol)
6588 "Momentarily highlight the beginning of the sexp before point."
6591 blink-matching-paren)
6601 oldpos))
6609 ;; backward-sexp skips backward over prefix chars,
6610 ;; so move back to the matching paren.
6631 ;; Matching open within window, temporarily move to or highlight
6632 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
6633 ;; is non-nil.
6650 ;; Show what precedes the open in its line, if anything.
6655 ;; Show what follows the open in its line, if anything.
6662 ;; Otherwise show the previous nonblank line,
6663 ;; if there is one.
6672 ;; Replace the newline and other whitespace with `...'.
6673 "..."
6675 ;; There is nothing to show except the char itself.
6681 "Function called, if non-nil, whenever a close parenthesis is inserted.
6687 blink-paren-function
6690 ;; Verify an even number of quoting characters precede the close.
6701 ;; Most likely, this hook is nil, so this arg doesn't matter,
6702 ;; but I use it as a reminder that this function usually
6703 ;; likes to be run after others since it does
6704 ;; `sit-for'. That's also the reason it get a `priority' prop
6705 ;; of 100.
6707 \f
6708 ;; This executes C-g typed while Emacs is waiting for a command.
6709 ;; Quitting out of a program does not go through here;
6710 ;; that happens in the QUIT macro at the C code level.
6712 "Signal a `quit' condition.
6713 During execution of Lisp code, this character causes a quit directly.
6714 At top-level, as an editor command, this simply beeps."
6716 ;; Avoid adding the region to the window selection.
6724 ;; Force the next redisplay cycle to remove the "Def" indicator from
6725 ;; all the mode lines.
6739 This command can exit an interactive command such as `query-replace',
6740 can clear out a prefix argument or a region,
6741 can get out of the minibuffer or other recursive edit,
6742 cancel the use of the current buffer (for special-purpose buffers),
6743 or go back to just one window (by deleting all but the selected window)."
6751 nil)
6762 "Play sound stored in FILE.
6763 VOLUME and DEVICE correspond to the keywords of the sound
6764 specification for `play-sound'."
6774 \f
6776 "Your preference for a mail reading package.
6777 This is used by some keybindings which support reading mail.
6778 See also `mail-user-agent' concerning sending mail."
6788 "Your preference for a mail composition package.
6789 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6790 outgoing email message. This variable lets you specify which
6791 mail-sending package you prefer.
6793 Valid values include:
6795 `message-user-agent' -- use the Message package.
6796 See Info node `(message)'.
6797 `sendmail-user-agent' -- use the Mail package.
6798 See Info node `(emacs)Sending Mail'.
6799 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6800 See Info node `(mh-e)'.
6801 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6802 paraphernalia if Gnus is running, particularly
6803 the Gcc: header for archiving.
6805 Additional valid symbols may be available; check with the author of
6806 your package for details. The function should return non-nil if it
6807 succeeds.
6809 See also `read-mail-command' concerning reading mail."
6812 message-user-agent)
6815 sendmail-user-agent)
6818 mh-e-user-agent)
6821 gnus-user-agent)
6827 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6828 If the value of `mail-user-agent' is the default, and the user
6829 appears to have customizations applying to the old default,
6830 `compose-mail' issues a warning."
6836 "If the buffer starts with a mail header, move point to the header's end.
6837 Otherwise, moves to `point-min'.
6838 The end of the header is the start of the next line, if there is one,
6839 else the end of the last line. This function obeys RFC822."
6845 ;; Used by Rmail (e.g., rmail-forward).
6847 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6851 switch-function yank-action send-actions
6852 return-action)
6853 "Start composing a mail message to send.
6854 This uses the user's chosen mail composition package
6855 as selected with the variable `mail-user-agent'.
6856 The optional arguments TO and SUBJECT specify recipients
6857 and the initial Subject field, respectively.
6859 OTHER-HEADERS is an alist specifying additional
6860 header fields. Elements look like (HEADER . VALUE) where both
6861 HEADER and VALUE are strings.
6863 CONTINUE, if non-nil, says to continue editing a message already
6864 being composed. Interactively, CONTINUE is the prefix argument.
6866 SWITCH-FUNCTION, if non-nil, is a function to use to
6867 switch to and display the buffer used for mail composition.
6869 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6870 to insert the raw text of the message being replied to.
6871 It has the form (FUNCTION . ARGS). The user agent will apply
6872 FUNCTION to ARGS, to insert the raw text of the original message.
6873 \(The user agent will also run `mail-citation-hook', *after* the
6874 original text has been inserted in this way.)
6876 SEND-ACTIONS is a list of actions to call when the message is sent.
6877 Each action has the form (FUNCTION . ARGS).
6879 RETURN-ACTION, if non-nil, is an action for returning to the
6880 caller. It has the form (FUNCTION . ARGS). The function is
6881 called after the mail has been sent or put aside, and the mail
6882 buffer buried."
6886 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6887 ;; from sendmail-user-agent to message-user-agent. Some users may
6888 ;; encounter incompatibilities. This hack tries to detect problems
6889 ;; and warn about them.
6894 mail-yank-hooks mail-archive-file-name
6895 mail-default-reply-to mail-mailing-lists
6896 mail-self-blind))
6903 The default mail mode is now Message mode.
6904 You have the following Mail mode variable%s customized:
6906 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6913 yank-action send-actions return-action)))
6916 yank-action send-actions
6917 return-action)
6921 'switch-to-buffer-other-window yank-action send-actions
6922 return-action))
6925 yank-action send-actions
6926 return-action)
6930 'switch-to-buffer-other-frame yank-action send-actions
6931 return-action))
6933 \f
6935 "History of values entered with `set-variable'.
6937 Maximum length of the history list is determined by the value
6941 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6942 VARIABLE should be a user option variable name, a Lisp variable
6943 meant to be customized by users. You should enter VALUE in Lisp syntax,
6944 so if you want VALUE to be a string, you must surround it with doublequotes.
6945 VALUE is used literally, not evaluated.
6947 If VARIABLE has a `variable-interactive' property, that is used as if
6948 it were the arg to `interactive' (which see) to interactively read VALUE.
6950 If VARIABLE has been defined with `defcustom', then the type information
6951 in the definition is used to check that VALUE is valid.
6953 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6958 default-var)
6974 var obsolete)
6977 ;; Use VAR's `variable-interactive' property
6978 ;; as an interactive spec for prompting.
6981 arg))
6983 read-expression-map t
6984 'set-variable-value-history
6993 ;; Match with custom type.
7005 ;; Force a thorough redisplay for the case that the variable
7006 ;; has an effect on the display, like `tab-width' has.
7008 \f
7009 ;; Define the major mode for lists of completions.
7019 (define-key map [right] 'next-completion)
7021 (define-key map [backtab] 'previous-completion)
7022 (define-key map "q" 'quit-window)
7023 (define-key map "z" 'kill-this-buffer)
7024 map)
7025 "Local map for completion list buffers.")
7027 ;; Completion mode is suitable only for specially formatted data.
7028 (put 'completion-list-mode 'mode-class 'special)
7030 (defvar completion-reference-buffer nil
7031 "Record the buffer that was current when the completion list was requested.
7032 This is a local variable in the completion list buffer.
7033 Initial value is nil to avoid some compiler warnings.")
7035 (defvar completion-no-auto-exit nil
7036 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7037 This also applies to other functions such as `choose-completion'.")
7039 (defvar completion-base-position nil
7040 "Position of the base of the text corresponding to the shown completions.
7041 This variable is used in the *Completions* buffers.
7042 Its value is a list of the form (START END) where START is the place
7043 where the completion should be inserted and END (if non-nil) is the end
7044 of the text to replace. If END is nil, point is used instead.")
7046 (defvar completion-list-insert-choice-function #'completion--replace
7047 "Function to use to insert the text chosen in *Completions*.
7048 Called with three arguments (BEG END TEXT), it should replace the text
7049 between BEG and END with TEXT. Expected to be set buffer-locally
7050 in the *Completions* buffer.")
7052 (defvar completion-base-size nil
7053 "Number of chars before point not involved in completion.
7054 This is a local variable in the completion list buffer.
7055 It refers to the chars in the minibuffer if completing in the
7056 minibuffer, or in `completion-reference-buffer' otherwise.
7057 Only characters in the field at point are included.
7059 If nil, Emacs determines which part of the tail end of the
7060 buffer's text is involved in completion by comparing the text
7061 directly.")
7062 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7064 (defun delete-completion-window ()
7065 "Delete the completion list window.
7066 Go to the window from which completion was requested."
7067 (interactive)
7068 (let ((buf completion-reference-buffer))
7069 (if (one-window-p t)
7070 (if (window-dedicated-p) (delete-frame))
7071 (delete-window (selected-window))
7072 (if (get-buffer-window buf)
7073 (select-window (get-buffer-window buf))))))
7075 (defun previous-completion (n)
7076 "Move to the previous item in the completion list."
7077 (interactive "p")
7078 (next-completion (- n)))
7080 (defun next-completion (n)
7081 "Move to the next item in the completion list.
7082 With prefix argument N, move N items (negative N means move backward)."
7083 (interactive "p")
7084 (let ((beg (point-min)) (end (point-max)))
7085 (while (and (> n 0) (not (eobp)))
7086 ;; If in a completion, move to the end of it.
7087 (when (get-text-property (point) 'mouse-face)
7088 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7089 ;; Move to start of next one.
7090 (unless (get-text-property (point) 'mouse-face)
7091 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7092 (setq n (1- n)))
7093 (while (and (< n 0) (not (bobp)))
7094 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7095 ;; If in a completion, move to the start of it.
7096 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7097 (goto-char (previous-single-property-change
7098 (point) 'mouse-face nil beg)))
7099 ;; Move to end of the previous completion.
7100 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7101 (goto-char (previous-single-property-change
7102 (point) 'mouse-face nil beg)))
7103 ;; Move to the start of that one.
7104 (goto-char (previous-single-property-change
7105 (point) 'mouse-face nil beg))
7106 (setq n (1+ n))))))
7108 (defun choose-completion (&optional event)
7109 "Choose the completion at point.
7110 If EVENT, use EVENT's position to determine the starting position."
7111 (interactive (list last-nonmenu-event))
7112 ;; In case this is run via the mouse, give temporary modes such as
7113 ;; isearch a chance to turn off.
7114 (run-hooks 'mouse-leave-buffer-hook)
7115 (with-current-buffer (window-buffer (posn-window (event-start event)))
7116 (let ((buffer completion-reference-buffer)
7117 (base-size completion-base-size)
7118 (base-position completion-base-position)
7119 (insert-function completion-list-insert-choice-function)
7120 (choice
7121 (save-excursion
7122 (goto-char (posn-point (event-start event)))
7123 (let (beg end)
7124 (cond
7125 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7126 (setq end (point) beg (1+ (point))))
7127 ((and (not (bobp))
7128 (get-text-property (1- (point)) 'mouse-face))
7129 (setq end (1- (point)) beg (point)))
7130 (t (error "No completion here")))
7131 (setq beg (previous-single-property-change beg 'mouse-face))
7132 (setq end (or (next-single-property-change end 'mouse-face)
7133 (point-max)))
7134 (buffer-substring-no-properties beg end)))))
7136 (unless (buffer-live-p buffer)
7137 (error "Destination buffer is dead"))
7138 (quit-window nil (posn-window (event-start event)))
7140 (with-current-buffer buffer
7141 (choose-completion-string
7142 choice buffer
7143 (or base-position
7144 (when base-size
7145 ;; Someone's using old completion code that doesn't know
7146 ;; about base-position yet.
7147 (list (+ base-size (field-beginning))))
7148 ;; If all else fails, just guess.
7149 (list (choose-completion-guess-base-position choice)))
7150 insert-function)))))
7152 ;; Delete the longest partial match for STRING
7153 ;; that can be found before POINT.
7154 (defun choose-completion-guess-base-position (string)
7155 (save-excursion
7156 (let ((opoint (point))
7157 len)
7158 ;; Try moving back by the length of the string.
7159 (goto-char (max (- (point) (length string))
7160 (minibuffer-prompt-end)))
7161 ;; See how far back we were actually able to move. That is the
7162 ;; upper bound on how much we can match and delete.
7163 (setq len (- opoint (point)))
7164 (if completion-ignore-case
7165 (setq string (downcase string)))
7166 (while (and (> len 0)
7167 (let ((tail (buffer-substring (point) opoint)))
7168 (if completion-ignore-case
7169 (setq tail (downcase tail)))
7170 (not (string= tail (substring string 0 len)))))
7171 (setq len (1- len))
7172 (forward-char 1))
7173 (point))))
7175 (defun choose-completion-delete-max-match (string)
7176 (declare (obsolete choose-completion-guess-base-position "23.2"))
7177 (delete-region (choose-completion-guess-base-position string) (point)))
7179 (defvar choose-completion-string-functions nil
7180 "Functions that may override the normal insertion of a completion choice.
7181 These functions are called in order with three arguments:
7182 CHOICE - the string to insert in the buffer,
7183 BUFFER - the buffer in which the choice should be inserted,
7184 BASE-POSITION - where to insert the completion.
7186 If a function in the list returns non-nil, that function is supposed
7187 to have inserted the CHOICE in the BUFFER, and possibly exited
7188 the minibuffer; no further functions will be called.
7190 If all functions in the list return nil, that means to use
7191 the default method of inserting the completion in BUFFER.")
7193 (defun choose-completion-string (choice &optional
7194 buffer base-position insert-function)
7195 "Switch to BUFFER and insert the completion choice CHOICE.
7196 BASE-POSITION says where to insert the completion.
7197 INSERT-FUNCTION says how to insert the completion and falls
7198 back on `completion-list-insert-choice-function' when nil."
7200 ;; If BUFFER is the minibuffer, exit the minibuffer
7201 ;; unless it is reading a file name and CHOICE is a directory,
7202 ;; or completion-no-auto-exit is non-nil.
7204 ;; Some older code may call us passing `base-size' instead of
7205 ;; `base-position'. It's difficult to make any use of `base-size',
7206 ;; so we just ignore it.
7207 (unless (consp base-position)
7208 (message "Obsolete `base-size' passed to choose-completion-string")
7209 (setq base-position nil))
7211 (let* ((buffer (or buffer completion-reference-buffer))
7212 (mini-p (minibufferp buffer)))
7213 ;; If BUFFER is a minibuffer, barf unless it's the currently
7214 ;; active minibuffer.
7215 (if (and mini-p
7216 (not (and (active-minibuffer-window)
7217 (equal buffer
7218 (window-buffer (active-minibuffer-window))))))
7219 (error "Minibuffer is not active for completion")
7220 ;; Set buffer so buffer-local choose-completion-string-functions works.
7221 (set-buffer buffer)
7222 (unless (run-hook-with-args-until-success
7223 'choose-completion-string-functions
7224 ;; The fourth arg used to be `mini-p' but was useless
7225 ;; (since minibufferp can be used on the `buffer' arg)
7226 ;; and indeed unused. The last used to be `base-size', so we
7227 ;; keep it to try and avoid breaking old code.
7228 choice buffer base-position nil)
7229 ;; This remove-text-properties should be unnecessary since `choice'
7230 ;; comes from buffer-substring-no-properties.
7231 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7232 ;; Insert the completion into the buffer where it was requested.
7233 (funcall (or insert-function completion-list-insert-choice-function)
7234 (or (car base-position) (point))
7235 (or (cadr base-position) (point))
7236 choice)
7237 ;; Update point in the window that BUFFER is showing in.
7238 (let ((window (get-buffer-window buffer t)))
7239 (set-window-point window (point)))
7240 ;; If completing for the minibuffer, exit it with this choice.
7241 (and (not completion-no-auto-exit)
7242 (minibufferp buffer)
7243 minibuffer-completion-table
7244 ;; If this is reading a file name, and the file name chosen
7245 ;; is a directory, don't exit the minibuffer.
7246 (let* ((result (buffer-substring (field-beginning) (point)))
7247 (bounds
7248 (completion-boundaries result minibuffer-completion-table
7249 minibuffer-completion-predicate
7250 "")))
7251 (if (eq (car bounds) (length result))
7252 ;; The completion chosen leads to a new set of completions
7253 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7254 (let ((mini (active-minibuffer-window)))
7255 (select-window mini)
7256 (when minibuffer-auto-raise
7257 (raise-frame (window-frame mini))))
7258 (exit-minibuffer))))))))
7260 (define-derived-mode completion-list-mode nil "Completion List"
7261 "Major mode for buffers showing lists of possible completions.
7263 to select the completion near point.
7264 Or click to select one with the mouse.
7267 (set (make-local-variable 'completion-base-size) nil))
7269 (defun completion-list-mode-finish ()
7270 "Finish setup of the completions buffer.
7271 Called from `temp-buffer-show-hook'."
7272 (when (eq major-mode 'completion-list-mode)
7273 (setq buffer-read-only t)))
7275 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7278 ;; Variables and faces used in `completion-setup-function'.
7280 (defcustom completion-show-help t
7281 "Non-nil means show help message in *Completions* buffer."
7282 :type 'boolean
7283 :version "22.1"
7284 :group 'completion)
7286 ;; This function goes in completion-setup-hook, so that it is called
7287 ;; after the text of the completion list buffer is written.
7288 (defun completion-setup-function ()
7289 (let* ((mainbuf (current-buffer))
7290 (base-dir
7291 ;; FIXME: This is a bad hack. We try to set the default-directory
7292 ;; in the *Completions* buffer so that the relative file names
7293 ;; displayed there can be treated as valid file names, independently
7294 ;; from the completion context. But this suffers from many problems:
7295 ;; - It's not clear when the completions are file names. With some
7296 ;; completion tables (e.g. bzr revision specs), the listed
7297 ;; completions can mix file names and other things.
7298 ;; - It doesn't pay attention to possible quoting.
7299 ;; - With fancy completion styles, the code below will not always
7300 ;; find the right base directory.
7301 (if minibuffer-completing-file-name
7302 (file-name-as-directory
7303 (expand-file-name
7304 (buffer-substring (minibuffer-prompt-end)
7305 (- (point) (or completion-base-size 0))))))))
7306 (with-current-buffer standard-output
7307 (let ((base-size completion-base-size) ;Read before killing localvars.
7308 (base-position completion-base-position)
7309 (insert-fun completion-list-insert-choice-function))
7310 (completion-list-mode)
7311 (set (make-local-variable 'completion-base-size) base-size)
7312 (set (make-local-variable 'completion-base-position) base-position)
7313 (set (make-local-variable 'completion-list-insert-choice-function)
7314 insert-fun))
7315 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7316 (if base-dir (setq default-directory base-dir))
7317 ;; Maybe insert help string.
7318 (when completion-show-help
7319 (goto-char (point-min))
7320 (if (display-mouse-p)
7321 (insert (substitute-command-keys
7323 (insert (substitute-command-keys
7327 (add-hook 'completion-setup-hook 'completion-setup-function)
7329 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7330 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7332 (defun switch-to-completions ()
7333 "Select the completion list window."
7334 (interactive)
7335 (let ((window (or (get-buffer-window "*Completions*" 0)
7336 ;; Make sure we have a completions window.
7337 (progn (minibuffer-completion-help)
7338 (get-buffer-window "*Completions*" 0)))))
7339 (when window
7340 (select-window window)
7341 ;; In the new buffer, go to the first completion.
7342 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
7343 (when (bobp)
7344 (next-completion 1)))))
7345 \f
7346 ;;; Support keyboard commands to turn on various modifiers.
7348 ;; These functions -- which are not commands -- each add one modifier
7349 ;; to the following event.
7351 (defun event-apply-alt-modifier (_ignore-prompt)
7354 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
7355 (defun event-apply-super-modifier (_ignore-prompt)
7358 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
7359 (defun event-apply-hyper-modifier (_ignore-prompt)
7362 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
7363 (defun event-apply-shift-modifier (_ignore-prompt)
7366 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
7367 (defun event-apply-control-modifier (_ignore-prompt)
7370 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
7371 (defun event-apply-meta-modifier (_ignore-prompt)
7374 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
7376 (defun event-apply-modifier (event symbol lshiftby prefix)
7377 "Apply a modifier flag to event EVENT.
7378 SYMBOL is the name of this modifier, as a symbol.
7379 LSHIFTBY is the numeric value of this modifier, in keyboard events.
7380 PREFIX is the string that represents this modifier in an event type symbol."
7381 (if (numberp event)
7382 (cond ((eq symbol 'control)
7383 (if (and (<= (downcase event) ?z)
7384 (>= (downcase event) ?a))
7385 (- (downcase event) ?a -1)
7386 (if (and (<= (downcase event) ?Z)
7387 (>= (downcase event) ?A))
7388 (- (downcase event) ?A -1)
7389 (logior (lsh 1 lshiftby) event))))
7390 ((eq symbol 'shift)
7391 (if (and (<= (downcase event) ?z)
7392 (>= (downcase event) ?a))
7393 (upcase event)
7394 (logior (lsh 1 lshiftby) event)))
7395 (t
7396 (logior (lsh 1 lshiftby) event)))
7397 (if (memq symbol (event-modifiers event))
7398 event
7399 (let ((event-type (if (symbolp event) event (car event))))
7400 (setq event-type (intern (concat prefix (symbol-name event-type))))
7401 (if (symbolp event)
7402 event-type
7403 (cons event-type (cdr event)))))))
7405 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
7406 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
7407 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
7408 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
7409 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
7410 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
7411 \f
7412 ;;;; Keypad support.
7414 ;; Make the keypad keys act like ordinary typing keys. If people add
7415 ;; bindings for the function key symbols, then those bindings will
7416 ;; override these, so this shouldn't interfere with any existing
7417 ;; bindings.
7419 ;; Also tell read-char how to handle these keys.
7420 (mapc
7421 (lambda (keypad-normal)
7422 (let ((keypad (nth 0 keypad-normal))
7423 (normal (nth 1 keypad-normal)))
7424 (put keypad 'ascii-character normal)
7425 (define-key function-key-map (vector keypad) (vector normal))))
7426 ;; See also kp-keys bound in bindings.el.
7427 '((kp-space ?\s)
7430 (kp-separator ?,)
7431 (kp-equal ?=)
7432 ;; Do the same for various keys that are represented as symbols under
7433 ;; GUIs but naturally correspond to characters.
7434 (backspace 127)
7435 (delete 127)
7438 (clear ?\C-l)
7439 (return ?\C-m)
7440 (escape ?\e)
7441 ))
7442 \f
7443 ;;;;
7444 ;;;; forking a twin copy of a buffer.
7445 ;;;;
7447 (defvar clone-buffer-hook nil
7448 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7450 (defvar clone-indirect-buffer-hook nil
7451 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7453 (defun clone-process (process &optional newname)
7454 "Create a twin copy of PROCESS.
7455 If NEWNAME is nil, it defaults to PROCESS' name;
7456 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7457 If PROCESS is associated with a buffer, the new process will be associated
7458 with the current buffer instead.
7459 Returns nil if PROCESS has already terminated."
7460 (setq newname (or newname (process-name process)))
7462 (setq newname (substring newname 0 (match-beginning 0))))
7463 (when (memq (process-status process) '(run stop open))
7464 (let* ((process-connection-type (process-tty-name process))
7465 (new-process
7466 (if (memq (process-status process) '(open))
7467 (let ((args (process-contact process t)))
7468 (setq args (plist-put args :name newname))
7469 (setq args (plist-put args :buffer
7470 (if (process-buffer process)
7471 (current-buffer))))
7472 (apply 'make-network-process args))
7473 (apply 'start-process newname
7474 (if (process-buffer process) (current-buffer))
7475 (process-command process)))))
7476 (set-process-query-on-exit-flag
7477 new-process (process-query-on-exit-flag process))
7478 (set-process-inherit-coding-system-flag
7479 new-process (process-inherit-coding-system-flag process))
7480 (set-process-filter new-process (process-filter process))
7481 (set-process-sentinel new-process (process-sentinel process))
7482 (set-process-plist new-process (copy-sequence (process-plist process)))
7483 new-process)))
7485 ;; things to maybe add (currently partly covered by `funcall mode'):
7486 ;; - syntax-table
7487 ;; - overlays
7488 (defun clone-buffer (&optional newname display-flag)
7489 "Create and return a twin copy of the current buffer.
7490 Unlike an indirect buffer, the new buffer can be edited
7491 independently of the old one (if it is not read-only).
7492 NEWNAME is the name of the new buffer. It may be modified by
7493 adding or incrementing <N> at the end as necessary to create a
7494 unique buffer name. If nil, it defaults to the name of the
7495 current buffer, with the proper suffix. If DISPLAY-FLAG is
7496 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7497 clone a file-visiting buffer, or a buffer whose major mode symbol
7498 has a non-nil `no-clone' property, results in an error.
7500 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7501 current buffer with appropriate suffix. However, if a prefix
7502 argument is given, then the command prompts for NEWNAME in the
7503 minibuffer.
7505 This runs the normal hook `clone-buffer-hook' in the new buffer
7506 after it has been set up properly in other respects."
7507 (interactive
7508 (progn
7509 (if buffer-file-name
7510 (error "Cannot clone a file-visiting buffer"))
7511 (if (get major-mode 'no-clone)
7512 (error "Cannot clone a buffer in %s mode" mode-name))
7513 (list (if current-prefix-arg
7514 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7515 t)))
7516 (if buffer-file-name
7517 (error "Cannot clone a file-visiting buffer"))
7518 (if (get major-mode 'no-clone)
7519 (error "Cannot clone a buffer in %s mode" mode-name))
7520 (setq newname (or newname (buffer-name)))
7522 (setq newname (substring newname 0 (match-beginning 0))))
7523 (let ((buf (current-buffer))
7524 (ptmin (point-min))
7525 (ptmax (point-max))
7526 (pt (point))
7527 (mk (if mark-active (mark t)))
7528 (modified (buffer-modified-p))
7529 (mode major-mode)
7530 (lvars (buffer-local-variables))
7531 (process (get-buffer-process (current-buffer)))
7532 (new (generate-new-buffer (or newname (buffer-name)))))
7533 (save-restriction
7534 (widen)
7535 (with-current-buffer new
7536 (insert-buffer-substring buf)))
7537 (with-current-buffer new
7538 (narrow-to-region ptmin ptmax)
7539 (goto-char pt)
7540 (if mk (set-mark mk))
7541 (set-buffer-modified-p modified)
7543 ;; Clone the old buffer's process, if any.
7544 (when process (clone-process process))
7546 ;; Now set up the major mode.
7547 (funcall mode)
7549 ;; Set up other local variables.
7550 (mapc (lambda (v)
7551 (condition-case () ;in case var is read-only
7552 (if (symbolp v)
7553 (makunbound v)
7554 (set (make-local-variable (car v)) (cdr v)))
7555 (error nil)))
7556 lvars)
7558 ;; Run any hooks (typically set up by the major mode
7559 ;; for cloning to work properly).
7560 (run-hooks 'clone-buffer-hook))
7561 (if display-flag
7562 ;; Presumably the current buffer is shown in the selected frame, so
7563 ;; we want to display the clone elsewhere.
7564 (let ((same-window-regexps nil)
7565 (same-window-buffer-names))
7566 (pop-to-buffer new)))
7567 new))
7570 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7571 "Create an indirect buffer that is a twin copy of the current buffer.
7573 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7574 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7575 or if not called with a prefix arg, NEWNAME defaults to the current
7576 buffer's name. The name is modified by adding a `<N>' suffix to it
7577 or by incrementing the N in an existing suffix. Trying to clone a
7578 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7579 property results in an error.
7581 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7582 This is always done when called interactively.
7584 Optional third arg NORECORD non-nil means do not put this buffer at the
7585 front of the list of recently selected ones.
7587 Returns the newly created indirect buffer."
7588 (interactive
7589 (progn
7590 (if (get major-mode 'no-clone-indirect)
7591 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7592 (list (if current-prefix-arg
7593 (read-buffer "Name of indirect buffer: " (current-buffer)))
7594 t)))
7595 (if (get major-mode 'no-clone-indirect)
7596 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7597 (setq newname (or newname (buffer-name)))
7599 (setq newname (substring newname 0 (match-beginning 0))))
7600 (let* ((name (generate-new-buffer-name newname))
7601 (buffer (make-indirect-buffer (current-buffer) name t)))
7602 (with-current-buffer buffer
7603 (run-hooks 'clone-indirect-buffer-hook))
7604 (when display-flag
7605 (pop-to-buffer buffer norecord))
7606 buffer))
7609 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7610 "Like `clone-indirect-buffer' but display in another window."
7611 (interactive
7612 (progn
7613 (if (get major-mode 'no-clone-indirect)
7614 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7615 (list (if current-prefix-arg
7616 (read-buffer "Name of indirect buffer: " (current-buffer)))
7617 t)))
7618 (let ((pop-up-windows t))
7619 (clone-indirect-buffer newname display-flag norecord)))
7621 \f
7622 ;;; Handling of Backspace and Delete keys.
7624 (defcustom normal-erase-is-backspace 'maybe
7625 "Set the default behavior of the Delete and Backspace keys.
7627 If set to t, Delete key deletes forward and Backspace key deletes
7628 backward.
7630 If set to nil, both Delete and Backspace keys delete backward.
7632 If set to 'maybe (which is the default), Emacs automatically
7633 selects a behavior. On window systems, the behavior depends on
7634 the keyboard used. If the keyboard has both a Backspace key and
7635 a Delete key, and both are mapped to their usual meanings, the
7636 option's default value is set to t, so that Backspace can be used
7637 to delete backward, and Delete can be used to delete forward.
7639 If not running under a window system, customizing this option
7640 accomplishes a similar effect by mapping C-h, which is usually
7641 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7642 via `keyboard-translate'. The former functionality of C-h is
7643 available on the F1 key. You should probably not use this
7644 setting if you don't have both Backspace, Delete and F1 keys.
7646 Setting this variable with setq doesn't take effect. Programmatically,
7647 call `normal-erase-is-backspace-mode' (which see) instead."
7648 :type '(choice (const :tag "Off" nil)
7649 (const :tag "Maybe" maybe)
7650 (other :tag "On" t))
7651 :group 'editing-basics
7652 :version "21.1"
7653 :set (lambda (symbol value)
7654 ;; The fboundp is because of a problem with :set when
7655 ;; dumping Emacs. It doesn't really matter.
7656 (if (fboundp 'normal-erase-is-backspace-mode)
7657 (normal-erase-is-backspace-mode (or value 0))
7658 (set-default symbol value))))
7660 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7661 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7662 (unless frame (setq frame (selected-frame)))
7663 (with-selected-frame frame
7664 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7665 (normal-erase-is-backspace-mode
7666 (if (if (eq normal-erase-is-backspace 'maybe)
7667 (and (not noninteractive)
7668 (or (memq system-type '(ms-dos windows-nt))
7669 (memq window-system '(w32 ns))
7670 (and (memq window-system '(x))
7671 (fboundp 'x-backspace-delete-keys-p)
7672 (x-backspace-delete-keys-p))
7673 ;; If the terminal Emacs is running on has erase char
7674 ;; set to ^H, use the Backspace key for deleting
7675 ;; backward, and the Delete key for deleting forward.
7676 (and (null window-system)
7677 (eq tty-erase-char ?\^H))))
7678 normal-erase-is-backspace)
7679 1 0)))))
7681 (define-minor-mode normal-erase-is-backspace-mode
7682 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7683 With a prefix argument ARG, enable this feature if ARG is
7684 positive, and disable it otherwise. If called from Lisp, enable
7685 the mode if ARG is omitted or nil.
7687 On window systems, when this mode is on, Delete is mapped to C-d
7688 and Backspace is mapped to DEL; when this mode is off, both
7689 Delete and Backspace are mapped to DEL. (The remapping goes via
7690 `local-function-key-map', so binding Delete or Backspace in the
7691 global or local keymap will override that.)
7693 In addition, on window systems, the bindings of C-Delete, M-Delete,
7694 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7695 the global keymap in accordance with the functionality of Delete and
7696 Backspace. For example, if Delete is remapped to C-d, which deletes
7697 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7698 to DEL, which deletes backward, C-Delete is bound to
7699 `backward-kill-word'.
7701 If not running on a window system, a similar effect is accomplished by
7702 remapping C-h (normally produced by the Backspace key) and DEL via
7703 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7704 to C-d; if it's off, the keys are not remapped.
7706 When not running on a window system, and this mode is turned on, the
7707 former functionality of C-h is available on the F1 key. You should
7708 probably not turn on this mode on a text-only terminal if you don't
7709 have both Backspace, Delete and F1 keys.
7711 See also `normal-erase-is-backspace'."
7712 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7713 . (lambda (v)
7714 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7715 (if v 1 0))))
7716 (let ((enabled (eq 1 (terminal-parameter
7717 nil 'normal-erase-is-backspace))))
7719 (cond ((or (memq window-system '(x w32 ns pc))
7720 (memq system-type '(ms-dos windows-nt)))
7721 (let ((bindings
7722 `(([M-delete] [M-backspace])
7723 ([C-M-delete] [C-M-backspace])
7724 ([?\e C-delete] [?\e C-backspace]))))
7726 (if enabled
7727 (progn
7728 (define-key local-function-key-map [delete] [deletechar])
7729 (define-key local-function-key-map [kp-delete] [deletechar])
7730 (define-key local-function-key-map [backspace] [?\C-?])
7731 (dolist (b bindings)
7732 ;; Not sure if input-decode-map is really right, but
7733 ;; keyboard-translate-table (used below) only works
7734 ;; for integer events, and key-translation-table is
7735 ;; global (like the global-map, used earlier).
7736 (define-key input-decode-map (car b) nil)
7737 (define-key input-decode-map (cadr b) nil)))
7738 (define-key local-function-key-map [delete] [?\C-?])
7739 (define-key local-function-key-map [kp-delete] [?\C-?])
7740 (define-key local-function-key-map [backspace] [?\C-?])
7741 (dolist (b bindings)
7742 (define-key input-decode-map (car b) (cadr b))
7743 (define-key input-decode-map (cadr b) (car b))))))
7744 (t
7745 (if enabled
7746 (progn
7747 (keyboard-translate ?\C-h ?\C-?)
7748 (keyboard-translate ?\C-? ?\C-d))
7749 (keyboard-translate ?\C-h ?\C-h)
7750 (keyboard-translate ?\C-? ?\C-?))))
7752 (if (called-interactively-p 'interactive)
7753 (message "Delete key deletes %s"
7754 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7755 "forward" "backward")))))
7756 \f
7757 (defvar vis-mode-saved-buffer-invisibility-spec nil
7758 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7760 (define-minor-mode read-only-mode
7761 "Change whether the current buffer is read-only.
7762 With prefix argument ARG, make the buffer read-only if ARG is
7763 positive, otherwise make it writable. If buffer is read-only
7764 and `view-read-only' is non-nil, enter view mode.
7766 Do not call this from a Lisp program unless you really intend to
7768 possibly enabling or disabling View mode. Also, note that this
7769 command works by setting the variable `buffer-read-only', which
7770 does not affect read-only regions caused by text properties. To
7771 ignore read-only status in a Lisp program (whether due to text
7772 properties or buffer state), bind `inhibit-read-only' temporarily
7773 to a non-nil value."
7774 :variable buffer-read-only
7775 (cond
7776 ((and (not buffer-read-only) view-mode)
7777 (View-exit-and-edit)
7778 (make-local-variable 'view-read-only)
7779 (setq view-read-only t)) ; Must leave view mode.
7780 ((and buffer-read-only view-read-only
7781 ;; If view-mode is already active, `view-mode-enter' is a nop.
7782 (not view-mode)
7783 (not (eq (get major-mode 'mode-class) 'special)))
7784 (view-mode-enter))))
7786 (define-minor-mode visible-mode
7787 "Toggle making all invisible text temporarily visible (Visible mode).
7788 With a prefix argument ARG, enable Visible mode if ARG is
7789 positive, and disable it otherwise. If called from Lisp, enable
7790 the mode if ARG is omitted or nil.
7792 This mode works by saving the value of `buffer-invisibility-spec'
7793 and setting it to nil."
7794 :lighter " Vis"
7795 :group 'editing-basics
7796 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7797 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7798 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7799 (when visible-mode
7800 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7801 buffer-invisibility-spec)
7802 (setq buffer-invisibility-spec nil)))
7803 \f
7804 (defvar messages-buffer-mode-map
7805 (let ((map (make-sparse-keymap)))
7806 (set-keymap-parent map special-mode-map)
7807 (define-key map "g" nil) ; nothing to revert
7808 map))
7810 (define-derived-mode messages-buffer-mode special-mode "Messages"
7813 (defun messages-buffer ()
7815 If it does not exist, create and it switch it to `messages-buffer-mode'."
7816 (or (get-buffer "*Messages*")
7817 (with-current-buffer (get-buffer-create "*Messages*")
7818 (messages-buffer-mode)
7819 (current-buffer))))
7821 \f
7822 ;; Minibuffer prompt stuff.
7824 ;;(defun minibuffer-prompt-modification (start end)
7825 ;; (error "You cannot modify the prompt"))
7826 ;;
7827 ;;
7828 ;;(defun minibuffer-prompt-insertion (start end)
7829 ;; (let ((inhibit-modification-hooks t))
7830 ;; (delete-region start end)
7831 ;; ;; Discard undo information for the text insertion itself
7832 ;; ;; and for the text deletion.above.
7833 ;; (when (consp buffer-undo-list)
7834 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7835 ;; (message "You cannot modify the prompt")))
7836 ;;
7837 ;;
7838 ;;(setq minibuffer-prompt-properties
7839 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7840 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7842 \f
7843 ;;;; Problematic external packages.
7845 ;; rms says this should be done by specifying symbols that define
7846 ;; versions together with bad values. This is therefore not as
7847 ;; flexible as it could be. See the thread:
7848 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7849 (defconst bad-packages-alist
7850 ;; Not sure exactly which semantic versions have problems.
7851 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7853 "The version of `semantic' loaded does not work in Emacs 22.
7854 It can cause constant high CPU load.
7855 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7856 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7857 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7858 ;; provided the `CUA-mode' feature. Since this is no longer true,
7859 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7860 (CUA-mode t nil
7861 "CUA-mode is now part of the standard GNU Emacs distribution,
7862 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7864 You have loaded an older version of CUA-mode which does not work
7865 correctly with this version of Emacs. You should remove the old
7866 version and use the one distributed with Emacs."))
7867 "Alist of packages known to cause problems in this version of Emacs.
7868 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7869 PACKAGE is either a regular expression to match file names, or a
7870 symbol (a feature name), like for `with-eval-after-load'.
7871 SYMBOL is either the name of a string variable, or `t'. Upon
7872 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7873 warning using STRING as the message.")
7875 (defun bad-package-check (package)
7876 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7877 (condition-case nil
7878 (let* ((list (assoc package bad-packages-alist))
7879 (symbol (nth 1 list)))
7880 (and list
7881 (boundp symbol)
7882 (or (eq symbol t)
7883 (and (stringp (setq symbol (eval symbol)))
7884 (string-match-p (nth 2 list) symbol)))
7885 (display-warning package (nth 3 list) :warning)))
7886 (error nil)))
7888 (dolist (elem bad-packages-alist)
7889 (let ((pkg (car elem)))
7890 (with-eval-after-load pkg
7891 (bad-package-check pkg))))
7893 \f
7894 ;;; Generic dispatcher commands
7896 ;; Macro `define-alternatives' is used to create generic commands.
7897 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
7898 ;; that can have different alternative implementations where choosing
7899 ;; among them is exclusively a matter of user preference.
7901 ;; (define-alternatives COMMAND) creates a new interactive command
7902 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
7903 ;; Typically, the user will not need to customize this variable; packages
7904 ;; wanting to add alternative implementations should use
7905 ;;
7906 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
7908 (defmacro define-alternatives (command &rest customizations)
7909 "Define the new command `COMMAND'.
7911 The argument `COMMAND' should be a symbol.
7913 Running `M-x COMMAND RET' for the first time prompts for which
7914 alternative to use and records the selected command as a custom
7915 variable.
7917 Running `C-u M-x COMMAND RET' prompts again for an alternative
7918 and overwrites the previous choice.
7920 The variable `COMMAND-alternatives' contains an alist with
7921 alternative implementations of COMMAND. `define-alternatives'
7922 does not have any effect until this variable is set.
7924 CUSTOMIZATIONS, if non-nil, should be composed of alternating
7925 `defcustom' keywords and values to add to the declaration of
7926 `COMMAND-alternatives' (typically :group and :version)."
7927 (let* ((command-name (symbol-name command))
7928 (varalt-name (concat command-name "-alternatives"))
7929 (varalt-sym (intern varalt-name))
7930 (varimp-sym (intern (concat command-name "--implementation"))))
7931 `(progn
7933 (defcustom ,varalt-sym nil
7934 ,(format "Alist of alternative implementations for the `%s' command.
7936 Each entry must be a pair (ALTNAME . ALTFUN), where:
7937 ALTNAME - The name shown at user to describe the alternative implementation.
7938 ALTFUN - The function called to implement this alternative."
7939 command-name)
7940 :type '(alist :key-type string :value-type function)
7941 ,@customizations)
7943 (put ',varalt-sym 'definition-name ',command)
7944 (defvar ,varimp-sym nil "Internal use only.")
7946 (defun ,command (&optional arg)
7947 ,(format "Run generic command `%s'.
7948 If used for the first time, or with interactive ARG, ask the user which
7949 implementation to use for `%s'. The variable `%s'
7950 contains the list of implementations currently supported for this command."
7951 command-name command-name varalt-name)
7952 (interactive "P")
7953 (when (or arg (null ,varimp-sym))
7954 (let ((val (completing-read
7955 ,(format "Select implementation for command `%s': "
7956 command-name)
7957 ,varalt-sym nil t)))
7958 (unless (string-equal val "")
7959 (when (null ,varimp-sym)
7960 (message
7961 "Use `C-u M-x %s RET' to select another implementation"
7962 ,command-name)
7963 (sit-for 3))
7964 (customize-save-variable ',varimp-sym
7965 (cdr (assoc-string val ,varalt-sym))))))
7966 (if ,varimp-sym
7967 (call-interactively ,varimp-sym)
7968 (message ,(format "No implementation selected for command `%s'"
7969 command-name)))))))
7971 \f
7973 (provide 'simple)
7975 ;;; simple.el ends here