| blob | e15291a345b50c158ec7e577915bd024f9ab9daa |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2015 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "Idle time delay before updating various things on the screen.
42 Various Emacs features that update auxiliary information when point moves
43 wait this many seconds after Emacs becomes idle before doing an update."
49 "Killing and yanking commands."
53 "Highlight (un)matching of parens and expressions."
55 \f
56 ;;; next-error support framework
59 "`next-error' support framework."
65 "Face used to highlight next error locus."
70 "Highlighting of locations in selected source buffers.
71 If a number, highlight the locus in `next-error' face for the given time
72 in seconds, or until the next command is executed.
73 If t, highlight the locus until the next command is executed, or until
74 some other locus replaces it.
75 If nil, don't highlight the locus in the source buffer.
76 If `fringe-arrow', indicate the locus by the fringe arrow
77 indefinitely until some other locus replaces it."
86 "Highlighting of locations in `next-error-no-select'.
87 If number, highlight the locus in `next-error' face for given time in seconds.
88 If t, highlight the locus indefinitely until some other locus replaces it.
89 If nil, don't highlight the locus in the source buffer.
90 If `fringe-arrow', indicate the locus by the fringe arrow
91 indefinitely until some other locus replaces it."
100 "Display the line in the visited source file recentered as specified.
101 If non-nil, the value is passed directly to `recenter'."
109 "List of hook functions run by `next-error' after visiting source file."
120 "The most recent `next-error' buffer.
121 A buffer becomes most recent when its compilation, grep, or
126 "Function to use to find the next error in the current buffer.
127 The function is called with 2 parameters:
128 ARG is an integer specifying by how many errors to move.
129 RESET is a boolean which, if non-nil, says to go back to the beginning
130 of the errors before moving.
131 Major modes providing compile-like functionality should set this variable
132 to indicate to `next-error' that this is a candidate buffer and how
137 "Function to use to move to an error locus.
138 It takes two arguments, a buffer position in the error buffer
139 and a buffer position in the error locus buffer.
140 The buffer for the error locus should already be current.
145 &optional avoid-current
146 extra-test-inclusive
147 extra-test-exclusive)
148 "Test if BUFFER is a `next-error' capable buffer.
150 If AVOID-CURRENT is non-nil, treat the current buffer
151 as an absolute last resort only.
153 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
154 that normally would not qualify. If it returns t, the buffer
155 in question is treated as usable.
157 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
158 that would normally be considered usable. If it returns nil,
159 that buffer is rejected."
164 ;; Optionally reject some buffers.
167 t)
168 ;; Optionally accept some other buffers.
173 extra-test-inclusive
174 extra-test-exclusive)
175 "Return a `next-error' capable buffer.
177 If AVOID-CURRENT is non-nil, treat the current buffer
178 as an absolute last resort only.
180 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
181 that normally would not qualify. If it returns t, the buffer
182 in question is treated as usable.
184 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
185 that would normally be considered usable. If it returns nil,
186 that buffer is rejected."
188 ;; 1. If one window on the selected frame displays such buffer, return it.
194 avoid-current
195 extra-test-inclusive extra-test-exclusive)
200 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
203 extra-test-inclusive extra-test-exclusive))
204 next-error-last-buffer)
205 ;; 3. If the current buffer is acceptable, choose it.
207 extra-test-inclusive extra-test-exclusive)
209 ;; 4. Look for any acceptable buffer.
214 extra-test-inclusive extra-test-exclusive)))
217 ;; 5. Use the current buffer as a last resort if it qualifies,
218 ;; even despite AVOID-CURRENT.
221 extra-test-inclusive extra-test-exclusive)
225 ;; 6. Give up.
229 "Visit next `next-error' message and corresponding source code.
231 If all the error messages parsed so far have been processed already,
232 the message buffer is checked for new ones.
234 A prefix ARG specifies how many error messages to move;
235 negative means move back to previous error messages.
237 and start at the first error.
239 The RESET argument specifies that we should restart from the beginning.
242 compilation, grep, or occur buffer. It can also operate on any
244 more generally, on any buffer in Compilation mode or with
245 Compilation Minor mode enabled, or any buffer in which
246 `next-error-function' is bound to an appropriate function.
247 To specify use of a particular buffer for error messages, type
249 in the current frame.
252 runs `next-error-hook' with `run-hooks', and stays with that buffer
253 until you use it in some other buffer which uses Compilation mode
254 or Compilation Minor mode.
256 To control which errors are matched, customize the variable
257 `compilation-error-regexp-alist'."
261 ;; we know here that next-error-function is a valid symbol we can funcall
269 "Visit the source code corresponding to the `next-error' message at point."
271 ;; we know here that next-error-function is a valid symbol we can funcall
282 "Visit previous `next-error' message and corresponding source code.
284 Prefix arg N says how many error messages to move backwards (or
285 forwards, if negative).
292 "Restart at the first error.
293 Visit corresponding source code.
294 With prefix arg N, visit the source code of the Nth error.
300 "Move point to the next error in the `next-error' buffer and highlight match.
301 Prefix arg N says how many error messages to move forwards (or
302 backwards, if negative).
304 select the source buffer."
311 "Move point to the previous error in the `next-error' buffer and highlight match.
312 Prefix arg N says how many error messages to move backwards (or
313 forwards, if negative).
315 select the source buffer."
319 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
323 "Minor mode for compilation, occur and diff modes.
324 With a prefix argument ARG, enable mode if ARG is positive, and
325 disable it otherwise. If called from Lisp, enable mode if ARG is
326 omitted or nil.
327 When turned on, cursor motion in the compilation, grep, occur or diff
328 buffer causes automatic display of the corresponding source code location."
335 ;; Used as a `post-command-hook' by `next-error-follow-mode'
336 ;; for the *Compilation* *grep* and *Occur* buffers.
346 \f
347 ;;;
350 "Major mode not specialized for anything in particular.
351 Other major modes are defined by comparison with this one."
356 ;; Special major modes to view specially formatted data rather than files.
370 map))
374 "Parent major mode from which special major modes should inherit."
377 ;; Making and deleting lines.
380 "Special hook to tell if `self-insert-command' will use the region.
381 It must be called via `run-hook-with-args-until-success' with no arguments.
382 Any `post-self-insert-command' which consumes the region should
383 register a function on this hook so that things like `delete-selection-mode'
390 "Insert a newline, and move to left margin of the new line if it's blank.
391 If option `use-hard-newlines' is non-nil, the newline is marked with the
392 text-property `hard'.
393 With ARG, insert that many newlines.
395 If `electric-indent-mode' is enabled, this indents the final new line
396 that it adds, and reindents the preceding line. To just insert
399 Calls `auto-fill-function' if the current column number is greater
400 than the value of `fill-column' and ARG is nil.
401 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
404 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
405 ;; Set last-command-event to tell self-insert what to insert.
409 ;; Don't auto-fill if we have a numeric argument.
412 ;; Do the rest in post-self-insert-hook, because we want to do it
413 ;; *before* other functions on that hook.
416 ;; Mark the newline(s) `hard'.
420 ;; If the newline leaves the previous line blank, and we
421 ;; have a left margin, delete that from the blank line.
429 ;; Indent the line after the newline, except in one case:
430 ;; when we added the newline at the beginning of a line which
431 ;; starts a page.
436 ;; FIXME: For non-interactive uses, many calls actually just want
437 ;; (insert "\n"), so maybe we should do just that, so as to avoid
438 ;; the risk of filling or running abbrevs unexpectedly.
445 ;; We first used let-binding to protect the hook, but that was naive
446 ;; since add-hook affects the symbol-default value of the variable,
447 ;; whereas the let-binding might only protect the buffer-local value.
451 nil)
456 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
462 "Insert a newline and leave point before it.
463 If there is a fill prefix and/or a `left-margin', insert them
464 on the new line if the line would have been blank.
465 With arg N, insert N newlines."
470 ;; Don't expand an abbrev before point.
484 "Split current line, moving portion beyond point vertically down.
485 If the current line starts with `fill-prefix', insert it on the new
486 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
488 When called from Lisp code, ARG may be a prefix string to copy."
493 ;; What prefix should we check for (nil means don't).
497 ;; Does this line start with it?
508 "Join this line to previous and fix up whitespace at join.
509 If there is a fill prefix, delete it from the beginning of this line.
510 With argument, join this line to following line."
517 ;; If the second line started with the fill prefix,
518 ;; delete the prefix.
530 "On blank line, delete all surrounding blank lines, leaving just one.
531 On isolated blank line, delete that one.
532 On nonblank line, delete any immediately following blank lines."
538 ;; Set singleblank if there is just one blank line here.
545 ;; Delete preceding blank lines, and this one too if it's the only one.
554 ;; Delete following blank lines, unless the current line is blank
555 ;; and there are no following blank lines.
564 ;; Handle the special case where point is followed by newline and eob.
565 ;; Delete the line, leaving point at eob.
571 Trailing lines are deleted only if `delete-trailing-whitespace'
572 is called on the entire buffer (rather than an active region)."
578 "Delete trailing whitespace between START and END.
579 If called interactively, START and END are the start/end of the
580 region if the mark is active, or of the buffer's accessible
581 portion if the mark is inactive.
583 This command deletes whitespace characters after the last
584 non-whitespace character in each line between START and END. It
585 does not consider formfeed characters to be whitespace.
587 If this command acts on the entire buffer (i.e. if called
588 interactively with the mark inactive, or called from Lisp with
589 END nil), it also deletes all trailing lines at the end of the
590 buffer if the variable `delete-trailing-lines' is non-nil."
603 ;; Don't delete formfeeds, even if they are considered whitespace.
607 ;; Delete trailing empty lines.
610 delete-trailing-lines
611 ;; Really the end of buffer.
616 ;; Return nil for the benefit of `write-file-functions'.
617 nil)
620 "Insert a newline, then indent according to major mode.
621 Indentation is done using the value of `indent-line-function'.
622 In programming language modes, this is the same as TAB.
623 In some text modes, where TAB inserts a tab, this command indents to the
624 column specified by the function `current-left-margin'."
631 "Reindent current line, insert newline, then indent the new line.
632 Indentation of both lines is done according to the current major mode,
633 which means calling the current value of `indent-line-function'.
634 In programming language modes, this is the same as TAB.
635 In some text modes, where TAB inserts a tab, this indents to the
636 column specified by the function `current-left-margin'."
639 ;; Be careful to insert the newline before indenting the line.
640 ;; Otherwise, the indentation might be wrong.
644 ;; We are at EOL before the call to indent-according-to-mode, and
645 ;; after it we usually are as well, but not always. We tried to
646 ;; address it with `save-excursion' but that uses a normal marker
647 ;; whereas we need `move after insertion', so we do the save/restore
648 ;; by hand.
652 ;; Remove the trailing white-space after indentation because
653 ;; indentation may introduce the whitespace.
659 Legitimate radix values are 8, 10 and 16."
664 "Like `read-char', but do not allow quitting.
665 Also, if the first character read is an octal digit,
666 we read any number of octal digits and return the
667 specified character code. Any nondigit terminates the sequence.
668 If the terminator is RET, it is discarded;
669 any other terminator is used itself as input.
671 The optional argument PROMPT specifies a string to use to prompt the user.
672 The variable `read-quoted-char-radix' controls which radix to use
673 for numeric input."
676 help-event-list)))
680 ;; Don't let C-h or other help chars get the help
681 ;; message--only help function keys. See bug#16617.
685 "Type the special character you want to use,
686 or the octal character code.
687 RET terminates the character code and is discarded;
697 done t))
699 ;; Turn a meta-character into a character with the 0200 bit set.
701 done t))
717 done t))
719 done t)))
721 code))
724 "Read next input character and insert it.
725 This is useful for inserting control characters.
726 With argument, insert ARG copies of the character.
728 If the first character you type after this command is an octal digit,
729 you should type a sequence of octal digits which specify a character code.
730 Any nondigit terminates the sequence. If the terminator is a RET,
731 it is discarded; any other terminator is used itself as input.
732 The variable `read-quoted-char-radix' specifies the radix for this feature;
733 set it to 10 or 16 to use decimal or hex instead of octal.
735 In overwrite mode, this function inserts the character anyway, and
736 does not handle octal digits specially. This means that if you use
737 overwrite as your normal editing mode, you can use this function to
738 insert characters when necessary.
740 In binary overwrite mode, this function does overwrite, and octal
741 digits are interpreted as a character code. This is intended to be
742 useful for editing binary files."
745 ;; Avoid "obsolete" warnings for translation-table-for-input.
752 ;; This used to assume character codes 0240 - 0377 stand for
753 ;; characters in some single-byte character set, and converted them
754 ;; to Emacs characters. But in 23.1 this feature is deprecated
755 ;; in favor of inserting the corresponding Unicode characters.
756 ;; (if (and enable-multibyte-characters
757 ;; (>= char ?\240)
758 ;; (<= char ?\377))
759 ;; (setq char (unibyte-char-to-multibyte char)))
771 "Move forward ARG lines and position at first nonblank character."
777 "Move backward ARG lines and position at first nonblank character."
783 "Move point to the first non-whitespace character on this line."
787 ;; Move back over chars that have whitespace syntax but have the p flag.
791 "Fixup white space between objects around point.
792 Leave one space or none, according to the context."
799 nil
803 "Delete all spaces and tabs around point.
804 If BACKWARD-ONLY is non-nil, only delete them before point."
809 orig-pos
818 "Delete all spaces and tabs around point, leaving one space (or N spaces).
819 If N is negative, delete newlines as well, leaving -N spaces.
820 See also `cycle-spacing'."
825 "Store context used in consecutive calls to `cycle-spacing' command.
826 The first time `cycle-spacing' runs, it saves in this variable:
827 its N argument, the original point position, and the original spacing
831 "Manipulate whitespace around point in a smart way.
832 In interactive use, this function behaves differently in successive
833 consecutive calls.
835 The first call in a sequence acts like `just-one-space'.
836 It deletes all spaces and tabs around point, leaving one space
837 \(or N spaces). N is the prefix argument. If N is negative,
838 it deletes newlines as well, leaving -N spaces.
839 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
841 The second call in a sequence deletes all spaces.
843 The third call in a sequence restores the original whitespace (and point).
845 If MODE is `single-shot', it only performs the first step in the sequence.
846 If MODE is `fast' and the first step would not result in any change
847 \(i.e., there are exactly (abs N) spaces around point),
848 the function goes straight to the second step.
850 Repeatedly calling the function with different values of N starts a
851 new sequence each time."
859 ;; Command run for the first time, single-shot mode or different argument
871 ;; Special handling for case where there was no space at all.
874 ;; If this run causes no change in buffer content, delete all spaces,
875 ;; otherwise delete all excess spaces.
880 ;; Command run for the second time.
884 ;; Command run for the third time.
889 \f
891 "Move point to the beginning of the buffer.
892 With numeric arg N, put point N/10 of the way from the beginning.
893 If the buffer is narrowed, this command uses the beginning of the
894 accessible part of the buffer.
896 If Transient Mark mode is disabled, leave mark at previous
907 ;; Avoid overflow for large buffer sizes!
915 "Move point to the end of the buffer.
916 With numeric arg N, put point N/10 of the way from the end.
917 If the buffer is narrowed, this command uses the end of the
918 accessible part of the buffer.
920 If Transient Mark mode is disabled, leave mark at previous
929 ;; Avoid overflow for large buffer sizes!
934 ;; If we went to a place in the middle of the buffer,
935 ;; adjust it to the beginning of a line.
939 ;; If the end of the buffer is not already on the screen,
940 ;; then scroll specially to put it near, but not at, the bottom.
945 "Whether single-char deletion commands delete an active region.
946 This has an effect only if Transient Mark mode is enabled, and
947 affects `delete-forward-char' and `delete-backward-char', though
948 not `delete-char'.
950 If the value is the symbol `kill', the active region is killed
951 instead of deleted."
964 "Function to get the region's content.
965 Called with one argument DELETE.
966 If DELETE is `delete-only', then only delete the region and the return value
967 is undefined. If DELETE is nil, just return the content as a string.
971 "Delete the previous N characters (following if N is negative).
972 If Transient Mark mode is enabled, the mark is active, and N is 1,
973 delete the text in the region and deactivate the mark instead.
974 To disable this, set option `delete-active-region' to nil.
976 Optional second arg KILLFLAG, if non-nil, means to kill (save in
977 kill ring) instead of delete. Interactively, N is the prefix
978 arg, and KILLFLAG is set if N is explicitly specified.
980 In Overwrite mode, single character backward deletion may replace
981 tabs with spaces so as to back over columns, unless point is at
982 the end of the line."
988 delete-active-region
990 ;; If a region is active, kill or delete it.
994 ;; In Overwrite mode, maybe untabify while deleting
1004 ;; Otherwise, do simple deletion.
1008 "Delete the following N characters (previous if N is negative).
1009 If Transient Mark mode is enabled, the mark is active, and N is 1,
1010 delete the text in the region and deactivate the mark instead.
1011 To disable this, set variable `delete-active-region' to nil.
1013 Optional second arg KILLFLAG non-nil means to kill (save in kill
1014 ring) instead of delete. Interactively, N is the prefix arg, and
1015 KILLFLAG is set if N was explicitly specified."
1021 delete-active-region
1023 ;; If a region is active, kill or delete it.
1028 ;; Otherwise, do simple deletion.
1032 "Put point at beginning and mark at end of buffer.
1033 If narrowing is in effect, only uses the accessible part of the buffer.
1034 You probably should not use this function in Lisp programs;
1035 it is usually a mistake for a Lisp function to use any subroutine
1036 that uses or sets the mark."
1042 \f
1044 ;; Counting lines, one way or another.
1047 "Go to LINE, counting from line 1 at beginning of buffer.
1048 If called interactively, a numeric prefix argument specifies
1049 LINE; without a numeric prefix argument, read LINE from the
1050 minibuffer.
1052 If optional argument BUFFER is non-nil, switch to that buffer and
1054 as argument, BUFFER is the most recently selected other buffer.
1056 Prior to moving point, this function sets the mark (without
1057 activating it), unless Transient Mark mode is enabled and the
1058 mark is already active.
1060 This function is usually the wrong thing to use in a Lisp program.
1061 What you probably want instead is something like:
1062 (goto-char (point-min))
1063 (forward-line (1- N))
1064 If at all possible, an even better solution is to use char counts
1065 rather than line counts."
1070 ;; Look for a default, a number in the buffer at point.
1080 ;; Decide if we're switching buffers.
1088 ;; Read the argument, offering that number (if any) as default.
1091 buffer))))
1092 ;; Switch to the desired buffer, one way or another.
1097 ;; Leave mark at previous position
1099 ;; Move to the specified line number in that buffer.
1108 "Count the number of words in the region.
1109 If called interactively, print a message reporting the number of
1110 lines, words, and characters in the region (whether or not the
1111 region is active); with prefix ARG, report for the entire buffer
1112 rather than the region.
1114 If called from Lisp, return the number of words between positions
1115 START and END."
1127 "Count words between START and END.
1128 If called interactively, START and END are normally the start and
1129 end of the buffer; but if the region is active, START and END are
1130 the start and end of the region. Print a message reporting the
1131 number of lines, words, and chars.
1133 If called from Lisp, return the number of words between START and
1134 END, without printing any message."
1144 words))
1160 str
1168 "Print the current buffer line number and narrowed line number of point."
1181 "Return number of lines between START and END.
1182 This is usually the number of newlines between them,
1183 but can be one more if START is not equal to END
1184 and the greater of them is not at the start of a line."
1200 done)))
1204 "Return (narrowed) buffer line number at position POS.
1205 If POS is nil, use current buffer location.
1206 Counting starts at (point-min), so the value refers
1207 to the contents of the accessible portion of the buffer."
1217 "Print info on cursor position (on screen and within buffer).
1218 Also describe the character after point, and give its character code
1219 in octal, decimal and hex.
1221 For a non-ASCII multibyte character, also give its encoding in the
1222 buffer's selected coding system if the coding system encodes the
1223 character safely. If the character is encoded into one byte, that
1224 code is shown in hex. If the character is encoded into more than one
1227 In addition, with prefix argument, show details about that character
1228 in *Help* buffer. See also the command `describe-char'."
1232 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1233 ;; start a directional embedding, which could completely
1234 ;; disrupt the rest of the line (e.g., RLO will display the
1235 ;; rest of the line right-to-left). So we put an invisible
1236 ;; PDF character after these characters, to end the
1237 ;; embedding, which eliminates any effects on the rest of
1238 ;; the line. For RLE and RLO we also append an invisible
1239 ;; LRM, to avoid reordering the following numerical
1240 ;; characters. For LRI/RLI/FSI we append a PDI.
1247 ;; Strong right-to-left characters cause reordering of
1248 ;; the following numerical characters which show the
1249 ;; codepoint, so append LRM to countermand that.
1259 ;; Avoid overflow from multiplying by 100!
1263 ""
1269 pos total percent beg end col hscroll)
1271 pos total col hscroll))
1273 encoded encoding-msg display-prop under-display)
1280 ;; Check if the character is displayed with some `display'
1281 ;; text property. In that case, set under-display to the
1282 ;; buffer substring covered by that property.
1293 under-display)))
1299 char char char under-display)
1301 char char char under-display display-prop))
1304 char char char
1306 "..."
1310 ;; We show the detailed information about CHAR.
1317 bidi-fixer
1318 encoding-msg pos total percent beg end col hscroll)
1325 bidi-fixer encoding-msg pos total percent col hscroll))))))
1326 \f
1327 ;; Initialize read-expression-map. It is defined at C level.
1331 ;; Might as well bind TAB to completion, since inserting a TAB char is
1332 ;; much too rarely useful.
1335 m))
1338 "Return a Lisp object read using the minibuffer, unevaluated.
1339 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1340 is a string to insert in the minibuffer before reading.
1341 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1342 Such arguments are used as in `read-from-minibuffer'.)"
1343 ;; Used for interactive spec `x'.
1348 "Return value of Lisp expression read using the minibuffer.
1349 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1350 is a string to insert in the minibuffer before reading.
1351 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1352 Such arguments are used as in `read-from-minibuffer'.)"
1353 ;; Used for interactive spec `X'.
1361 "The current default value or list of default values in the minibuffer.
1362 The functions `read-from-minibuffer' and `completing-read' bind
1366 "Value for `print-level' while printing value in `eval-expression'.
1367 A value of nil means no limit."
1373 "Value for `print-length' while printing value in `eval-expression'.
1374 A value of nil means no limit."
1380 "If non-nil set `debug-on-error' to t in `eval-expression'.
1381 If nil, don't change the value of `debug-on-error'."
1387 "Format VALUE as a result of evaluated expression.
1388 Return a formatted string which is displayed in the echo area
1389 in addition to the value printed by prin1 in functions which
1390 display the result of expression evaluation."
1409 ;; FIXME: call emacs-lisp-mode?
1416 read-expression-map t
1419 ;; We define this, rather than making `eval' interactive,
1420 ;; for the sake of completion of names like eval-region, eval-buffer.
1422 "Evaluate EXP and print value in the echo area.
1423 When called interactively, read an Emacs Lisp expression and evaluate it.
1424 Value is also consed on to front of the variable `values'.
1425 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1426 argument) means insert the result into the current buffer instead of
1427 printing it in the echo area.
1429 Normally, this function truncates long output according to the value
1430 of the variables `eval-expression-print-length' and
1431 `eval-expression-print-level'. With a prefix argument of zero,
1432 however, there is no such truncation. Such a prefix argument
1433 also causes integers to be printed in several additional formats
1434 \(octal, hexadecimal, and character).
1436 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1437 minibuffer.
1439 If `eval-expression-debug-on-error' is non-nil, which is the default,
1440 this command arranges for all errors to enter the debugger."
1443 current-prefix-arg))
1448 ;; Bind debug-on-error to something unique so that we can
1449 ;; detect when evalled code changes it.
1453 ;; If evalled code has changed the value of debug-on-error,
1454 ;; propagate that change to the global binding.
1459 eval-expression-print-length))
1461 eval-expression-print-level))
1477 "Prompting with PROMPT, let user edit COMMAND and eval result.
1478 COMMAND is a Lisp expression. Let user edit that expression in
1479 the minibuffer, then read and evaluate the result."
1486 read-expression-map t
1488 ;; If command was added to command-history as a string,
1489 ;; get rid of that. We want only evaluable expressions there.
1493 ;; If command to be redone does not match front of history,
1494 ;; add it to the history.
1500 "Edit and re-evaluate last complex command, or ARGth from last.
1501 A complex command is one which used the minibuffer.
1502 The command is placed in the minibuffer as a Lisp form for editing.
1503 The result is executed, repeating the command as changed.
1504 If the command has been changed or is not the most recent previous
1505 command it is added to the front of the command history.
1506 You can use the minibuffer history commands \
1508 to get different commands to edit and resubmit."
1511 newcmd)
1523 ;; If command was added to command-history as a
1524 ;; string, get rid of that. We want only
1525 ;; evaluable expressions there.
1529 ;; If command to be redone does not match front of history,
1530 ;; add it to the history.
1545 "Read command name to invoke in `execute-extended-command'."
1555 ;; Get a command name at point in the original buffer
1556 ;; to propose it after M-n.
1560 ;; Read a string, completing from and restricting to the set of
1561 ;; all defined commands. Don't provide any initial input.
1562 ;; Save the command read on the extended-command history list.
1573 ;; This isn't strictly correct if `execute-extended-command'
1574 ;; is bound to anything else (e.g. [menu]).
1575 ;; It could use (key-description (this-single-command-keys)),
1576 ;; but actually a prompt other than "M-x" would be confusing,
1577 ;; because "M-x" is a well-known prompt to read a command
1578 ;; and it serves as a shorthand for "Extended command: ".
1583 ;; Exclude obsolete commands from completions.
1588 pred)))
1593 "Non-nil means show the equivalent key-binding when M-x command has one.
1594 The value can be a length of time to show the message for.
1595 If the value is non-nil and not a number, we wait 2 seconds."
1617 binding)
1623 name len)))
1624 ;; Don't show the help message if the binding isn't
1625 ;; significantly shorter than the M-x command the user typed.
1632 binding))
1635 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1636 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1637 "Read a command name, then read the arguments and call the command.
1638 To pass a prefix argument to the command you are
1639 invoking, give a prefix argument to `execute-extended-command'."
1641 ;; FIXME: Remember the actual text typed by the user before completion,
1642 ;; so that we don't later on suggest the same shortening.
1647 execute-extended-command--last-typed)))
1648 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1661 ;; Normally `real-this-command' should never be changed, but here we really
1662 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1663 ;; binding" for <cmd>, so the command the user really wanted to run is
1664 ;; `function' and not `execute-extended-command'. The difference is
1665 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1669 ;; If enabled, show which key runs this command.
1670 ;; But first wait, and skip the message if there is input.
1672 ;; If this command displayed something in the echo area;
1673 ;; wait a few seconds, then display our suggestion message.
1674 ;; FIXME: Wait *after* running post-command-hook!
1675 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1676 ;; find a better answer anyway!
1685 ;; There's no binding for CMD. Let's try and find the shortest
1686 ;; string to use in M-x.
1687 ;; FIXME: Can be slow. Cache it maybe?
1694 function
1699 suggest-key-bindings
1703 ;; BEWARE: Called directly from the C code.
1704 "Execute CMD as an editor command.
1705 CMD must be a symbol that satisfies the `commandp' predicate.
1706 Optional second arg RECORD-FLAG non-nil
1707 means unconditionally put this command in the variable `command-history'.
1708 Otherwise, that is done only if an arg is read using the minibuffer.
1709 The argument KEYS specifies the value to use instead of (this-command-keys)
1710 when reading the arguments; if it is nil, (this-command-keys) is used.
1711 The argument SPECIAL, if non-nil, means that this command is executing
1712 a special event, so ignore the prefix argument and don't clear it."
1720 disabled-command-function)
1721 ;; FIXME: Weird calling convention!
1731 ;; If requested, place the macro in the command history. For
1732 ;; other sorts of commands, call-interactively takes care of this.
1735 ;; Don't keep command history around forever.
1741 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1749 \f
1751 "Default minibuffer history list.
1752 This is used for all minibuffer input
1753 except when an alternate history list is specified.
1755 Maximum length of the history list is determined by the value
1758 "Control whether history list elements are expressions or strings.
1759 If the value of this variable equals current minibuffer depth,
1760 they are expressions; otherwise they are strings.
1761 \(That convention is designed to do the right thing for
1768 "Text that was in this minibuffer before any history commands.
1769 This is nil if there have not yet been any history commands
1778 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1782 "Minibuffer history variables for which matching should ignore case.
1783 If a history variable is a member of this list, then the
1785 commands ignore case when searching it, regardless of `case-fold-search'."
1790 "Find the previous history element that matches REGEXP.
1791 \(Previous history elements refer to earlier actions.)
1792 With prefix argument N, search for Nth previous match.
1793 If N is negative, find the next or Nth next match.
1794 Normally, history elements are matched case-insensitively if
1795 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1796 makes the search case-sensitive.
1797 See also `minibuffer-history-case-insensitive-variables'."
1801 nil
1802 minibuffer-local-map
1803 nil
1804 'minibuffer-history-search-history
1806 ;; Use the last regexp specified, by default, if input is empty.
1811 regexp)
1821 ;; On some systems, ignore case for file names.
1823 minibuffer-history-case-insensitive-variables)
1824 t
1825 ;; Respect the user's setting for case-fold-search:
1826 case-fold-search)
1827 nil))
1828 prevpos
1829 match-string
1830 match-offset
1837 "No later matching history item"
1858 next-matching-history-element))
1862 "Find the next history element that matches REGEXP.
1863 \(The next history element refers to a more recent action.)
1864 With prefix argument N, search for Nth next match.
1865 If N is negative, find the previous or Nth previous match.
1866 Normally, history elements are matched case-insensitively if
1867 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1868 makes the search case-sensitive."
1872 nil
1873 minibuffer-local-map
1874 nil
1875 'minibuffer-history-search-history
1877 ;; Use the last regexp specified, by default, if input is empty.
1882 regexp)
1889 "Function run by `goto-history-element' before consuming default values.
1890 This is useful to dynamically add more elements to the list of default values
1891 when `goto-history-element' reaches the end of this list.
1892 Before calling this function `goto-history-element' sets the variable
1893 `minibuffer-default-add-done' to t, so it will call this function only
1894 once. In special cases, when this function needs to be called more
1895 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1899 "When nil, add more elements to the end of the list of default values.
1900 The value nil causes `goto-history-element' to add more elements to
1901 the list of defaults when it reaches the end of this list. It does
1907 "Return a list of all completions without the default value.
1908 This function is used to add all elements of the completion table to
1909 the end of the list of defaults just after the default value."
1912 minibuffer-completion-table
1913 minibuffer-completion-predicate)))
1919 "Puts element of the minibuffer history in the minibuffer.
1920 The argument NABS specifies the absolute history position."
1934 elt minibuffer-returned-to-present)
1941 "End of defaults; no next item"
1946 previous-history-element))
1958 minibuffer-default)))
1970 elt))
1974 "Puts next element of the minibuffer history in the minibuffer.
1975 With argument N, it uses the Nth following element."
1981 "Puts previous element of the minibuffer history in the minibuffer.
1982 With argument N, it uses the Nth previous element."
1988 "Move cursor vertically down ARG lines, or to the next history element.
1989 When point moves over the bottom line of multi-line minibuffer, puts ARGth
1990 next element of the minibuffer history in the minibuffer."
1998 ;; Restore old position since `line-move-visual' moves point to
1999 ;; the end of the line when it fails to go to the next line.
2004 "Move cursor vertically up ARG lines, or to the previous history element.
2005 When point moves over the top line of multi-line minibuffer, puts ARGth
2006 previous element of the minibuffer history in the minibuffer."
2014 ;; Restore old position since `line-move-visual' moves point to
2015 ;; the beginning of the line when it fails to go to the previous line.
2020 "Get next history element which completes the minibuffer before the point.
2021 The contents of the minibuffer after the point are deleted, and replaced
2022 by the new completion."
2028 n)
2029 ;; next-matching-history-element always puts us at (point-min).
2030 ;; Move to the position we were at before changing the buffer contents.
2031 ;; This is still sensible, because the text before point has not changed.
2035 "\
2036 Get previous history element which completes the minibuffer before the point.
2037 The contents of the minibuffer after the point are deleted, and replaced
2038 by the new completion."
2042 ;; For compatibility with the old subr of the same name.
2044 "Return the display width of the minibuffer prompt.
2045 Return 0 if current buffer is not a minibuffer."
2046 ;; Return the width of everything before the field at the end of
2047 ;; the buffer; this should be 0 for normal buffers.
2049 \f
2050 ;; isearch minibuffer history
2057 "Set up a minibuffer for using isearch to search the minibuffer history.
2058 Intended to be added to `minibuffer-setup-hook'."
2070 "Clean up the minibuffer after terminating isearch in the minibuffer."
2075 "Return the proper search function, for isearch in minibuffer history."
2078 ;; Use standard functions to search within minibuffer text
2080 found)
2081 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2082 ;; searching forward. Lazy-highlight calls this lambda with the
2083 ;; bound arg, so skip the minibuffer prompt.
2087 ;; 1. First try searching in the initial minibuffer text
2090 noerror)
2091 ;; 2. If the above search fails, start putting next/prev history
2092 ;; elements in the minibuffer successively, and search the string
2093 ;; in them. Do this only when bound is nil (i.e. not while
2094 ;; lazy-highlighting search strings in the current minibuffer text).
2106 ;; After putting the next/prev history element, search
2107 ;; the string in them again, until next-history-element
2108 ;; or previous-history-element raises an error at the
2109 ;; beginning/end of history.
2112 ;; For backward search, don't search
2113 ;; in the minibuffer prompt
2115 noerror)))
2116 ;; Return point of the new search result
2118 ;; Return nil when next(prev)-history-element fails
2122 "Display the minibuffer history search prompt.
2123 If there are no search errors, this function displays an overlay with
2124 the isearch prompt which replaces the original minibuffer prompt.
2125 Otherwise, it displays the standard isearch message returned from
2126 the function `isearch-message'."
2128 ;; Use standard function `isearch-message' when not in the minibuffer,
2129 ;; or search fails, or has an error (like incomplete regexp).
2130 ;; This function overwrites minibuffer text with isearch message,
2131 ;; so it's possible to see what is wrong in the search string.
2133 ;; Otherwise, put the overlay with the standard isearch prompt over
2134 ;; the initial minibuffer prompt.
2143 ;; And clear any previous isearch message.
2147 "Wrap the minibuffer history search when search fails.
2148 Move point to the first history element for a forward search,
2149 or to the last history element for a backward search."
2150 ;; When `minibuffer-history-isearch-search' fails on reaching the
2151 ;; beginning/end of the history, wrap the search to the first/last
2152 ;; minibuffer history element.
2160 "Save a function restoring the state of minibuffer history search.
2161 Save `minibuffer-history-position' to the additional state parameter
2162 in the search status stack."
2168 "Restore the minibuffer history search state.
2169 Go to the history element by the absolute history position HIST-POS."
2172 \f
2173 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2177 "Table mapping redo records to the corresponding undo one.
2178 A redo record for undo-in-region maps to t.
2188 "Within a run of consecutive undo commands, list remaining to be undone.
2192 "Undo some previous changes.
2193 Repeat this command to undo more changes.
2194 A numeric ARG serves as a repeat count.
2196 In Transient Mark mode when the mark is active, only undo changes within
2198 as an argument limits undo to changes within the current region."
2200 ;; Make last-command indicate for the next command that this was an undo.
2201 ;; That way, another undo will undo more.
2202 ;; If we get to the end of the undo history and get an error,
2203 ;; another undo command will find the undo history empty
2204 ;; and will get another error. To begin undoing the undos,
2205 ;; you must type some other command.
2207 ;; For an indirect buffer, look in the base buffer for the
2208 ;; auto-save data.
2212 message)
2213 ;; If we get an error in undo-start,
2214 ;; the next command should not be a "consecutive undo".
2215 ;; So set `this-command' to something other than `undo'.
2220 ;; If something (a timer or filter?) changed the buffer
2221 ;; since the previous command, don't continue the undo seq.
2225 ;; If the last undo record made was made by undo
2226 ;; it shows nothing else happened in between.
2233 ;; get rid of initial undo boundary
2235 ;; If we got this far, the next command should be a consecutive undo.
2237 ;; Check to see whether we're hitting a redo record, and if
2238 ;; so, ask the user whether she wants to skip the redo/undo pair.
2246 ;; The equiv entry might point to another redo record if we have done
2247 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2255 ;; Record the fact that the just-generated undo records come from an
2256 ;; undo operation--that is, they are redo records.
2257 ;; In the ordinary case (not within a region), map the redo
2258 ;; record to the following undos.
2259 ;; I don't know how to do that in the undo-in-region case.
2261 ;; Strip any leading undo boundaries there might be, like we do
2262 ;; above when checking.
2266 ;; Prevent identity mapping. This can happen if
2267 ;; consecutive nils are erroneously in undo list.
2269 t
2270 pending-undo-list)
2271 undo-equiv-table))
2272 ;; Don't specify a position in the undo record for the undo command.
2273 ;; Instead, undoing this should move point to where the change is.
2292 ;; Record what the current undo list says,
2293 ;; so the next command can tell if the buffer was modified in between.
2297 ;; Display a message announcing success.
2302 "Make BUFFER stop keeping undo information.
2303 No argument or nil as argument means do this for the current buffer."
2309 "Undo some previous changes.
2310 Repeat this command to undo more changes.
2311 A numeric ARG serves as a repeat count.
2312 Contrary to `undo', this will not redo a previous undo."
2317 "Non-nil while performing an undo.
2321 "Undo back N undo-boundaries beyond what was already undone recently.
2322 Call `undo-start' to get ready to undo recent changes,
2323 then call `undo-more' one or more times to undo them."
2328 ;; Note: The following, while pulling elements off
2329 ;; `pending-undo-list' will call primitive change functions which
2330 ;; will push more elements onto `buffer-undo-list'.
2336 "Undo N records from the front of the list LIST.
2337 Return what remains of the list."
2339 ;; This is a good feature, but would make undo-start
2340 ;; unable to do what is expected.
2341 ;;(when (null (car (list)))
2342 ;; ;; If the head of the list is a boundary, it is the boundary
2343 ;; ;; preceding this command. Get rid of it and don't count it.
2344 ;; (setq list (cdr list))))
2347 ;; In a writable buffer, enable undoing read-only text that is
2348 ;; so because of text properties.
2350 ;; Don't let `intangible' properties interfere with undo.
2352 ;; We use oldlist only to check for EQ. ++kfs
2358 ;; Handle an integer by setting point to that value.
2361 ;; Element (t . TIME) records previous modtime.
2362 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2363 ;; UNKNOWN_MODTIME_NSECS.
2365 ;; If this records an obsolete save
2366 ;; (not matching the actual disk file)
2367 ;; then don't mark unmodified.
2375 ;; Element (nil PROP VAL BEG . END) is property change.
2380 ;; Element (BEG . END) means range was inserted.
2382 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2383 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2386 ;; Set point first thing, so that undoing this undo
2387 ;; does not send point back to where it is now.
2390 ;; Element (apply FUN . ARGS) means call FUN to undo.
2394 ;; Long format: (apply DELTA START END FUN . ARGS).
2401 ;; Check that the function did what the entry
2402 ;; said it would do.
2412 ;; Element (STRING . POS) means STRING was deleted.
2418 ;; Check that marker adjustments which were recorded
2419 ;; with the (STRING . POS) record are still valid, ie
2420 ;; the markers haven't moved. We check their validity
2421 ;; before reinserting the string so as we don't need to
2422 ;; mind marker insertion-type.
2430 ;; Insert string and adjust point
2438 ;; Adjust the valid marker adjustments
2442 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2445 next)
2446 ;; Even though these elements are not expected in the undo
2447 ;; list, adjust them to be conservative for the 24.4
2448 ;; release. (Bug#16818)
2455 ;; Make sure an apply entry produces at least one undo entry,
2456 ;; so the test in `undo' for continuing an undo series
2457 ;; will work right.
2462 list)
2464 ;; Deep copy of a list
2466 "Make a copy of undo list LIST."
2472 elt))
2475 "Set `pending-undo-list' to the front of the undo list.
2476 The next call to `undo-more' will undo the most recently made change.
2477 If BEG and END are specified, then only undo elements
2478 that apply to text between BEG and END are used; other undo elements
2479 are ignored. If BEG and END are nil, all undo elements are used."
2485 buffer-undo-list)))
2487 ;; The positions given in elements of the undo list are the positions
2488 ;; as of the time that element was recorded to undo history. In
2489 ;; general, subsequent buffer edits render those positions invalid in
2490 ;; the current buffer, unless adjusted according to the intervening
2491 ;; undo elements.
2492 ;;
2493 ;; Undo in region is a use case that requires adjustments to undo
2494 ;; elements. It must adjust positions of elements in the region based
2495 ;; on newer elements not in the region so as they may be correctly
2496 ;; applied in the current buffer. undo-make-selective-list
2497 ;; accomplishes this with its undo-deltas list of adjustments. An
2498 ;; example undo history from oldest to newest:
2499 ;;
2500 ;; buf pos:
2501 ;; 123456789 buffer-undo-list undo-deltas
2502 ;; --------- ---------------- -----------
2503 ;; aaa (1 . 4) (1 . -3)
2504 ;; aaba (3 . 4) N/A (in region)
2505 ;; ccaaba (1 . 3) (1 . -2)
2506 ;; ccaabaddd (7 . 10) (7 . -3)
2507 ;; ccaabdd ("ad" . 6) (6 . 2)
2508 ;; ccaabaddd (6 . 8) (6 . -2)
2509 ;; | |<-- region: "caab", from 2 to 6
2510 ;;
2511 ;; When the user starts a run of undos in region,
2512 ;; undo-make-selective-list is called to create the full list of in
2513 ;; region elements. Each element is adjusted forward chronologically
2514 ;; through undo-deltas to determine if it is in the region.
2515 ;;
2516 ;; In the above example, the insertion of "b" is (3 . 4) in the
2517 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2518 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2519 ;; . 6) is assessed as in the region and placed in the selective list.
2520 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2521 ;; due to the selected element. The "b" insertion is the only element
2522 ;; fully in the region, so in this example undo-make-selective-list
2523 ;; returns (nil (5 . 6)).
2524 ;;
2525 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2526 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2527 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2528 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2529 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2530 ;;
2531 ;; More interesting is how to adjust the "ddd" insertion due to the
2532 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2533 ;; If the reinsertion was a manual retyping of "ad", then the total
2534 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2535 ;; the reinsertion was due to undo, one might expect the first "d"
2536 ;; character would again be a part of the "ddd" text, meaning its
2537 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2538 ;;
2539 ;; undo-make-selective-list assumes in this situation that "ad" was a
2540 ;; new edit, even if it was inserted because of an undo.
2541 ;; Consequently, if the user undos in region "8 to 10" of the
2542 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2543 ;; "ccaabad", as though the first "d" became detached from the
2544 ;; original "ddd" insertion. This quirk is a FIXME.
2547 "Return a list of undo elements for the region START to END.
2548 The elements come from `buffer-undo-list', but we keep only the
2549 elements inside this region, and discard those outside this
2550 region. The elements' positions are adjusted so as the returned
2551 list can be applied to the current buffer."
2553 ;; A list of position adjusted undo elements in the region.
2555 ;; A list of undo-deltas for out of region undo elements.
2556 undo-deltas
2557 undo-elt)
2565 ;; Don't put two nils together in the list
2569 ;; This is a "was unmodified" element. Keep it
2570 ;; if we have kept everything thus far.
2573 ;; Skip over marker adjustments, instead relying
2574 ;; on finding them after (TEXT . POS) elements
2576 nil)
2579 undo-deltas)))
2584 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2585 ;; kept. primitive-undo may discard them later.
2598 "Determine whether UNDO-ELT falls inside the region START ... END.
2599 If it crosses the edge, we return nil.
2601 Generally this function is not useful for determining
2602 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2603 because markers can be arbitrarily relocated. Instead, pass the
2604 marker adjustment's corresponding (TEXT . POS) element."
2609 t)
2611 nil)
2613 ;; (TEXT . POSITION)
2617 ;; (MARKER . ADJUSTMENT)
2620 ;; (nil PROPERTY VALUE BEG . END)
2625 ;; (BEGIN . END)
2630 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2631 This assumes we have already decided that UNDO-ELT
2632 is not *inside* the region START...END."
2636 ;; (nil PROPERTY VALUE BEG . END)
2641 ;; (BEGIN . END)
2646 "Return adjustment of undo element ELT by the undo DELTAS
2647 list."
2649 ;; POSITION
2652 ;; (BEG . END)
2655 ;; (TEXT . POSITION)
2659 ;; (nil PROPERTY VALUE BEG . END)
2662 ;; (apply DELTA START END FUN . ARGS)
2663 ;; FIXME
2664 ;; All others return same elt
2667 ;; (BEG . END) can adjust to the same positions, commonly when an
2668 ;; insertion was undone and they are out of region, for example:
2669 ;;
2670 ;; buf pos:
2671 ;; 123456789 buffer-undo-list undo-deltas
2672 ;; --------- ---------------- -----------
2673 ;; [...]
2674 ;; abbaa (2 . 4) (2 . -2)
2675 ;; aaa ("bb" . 2) (2 . 2)
2676 ;; [...]
2677 ;;
2678 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2679 ;; undo. Further adjustments to such an element should be the same as
2680 ;; for (TEXT . POSITION) elements. The options are:
2681 ;;
2682 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2683 ;; analogous to marker insertion-type t.
2684 ;;
2685 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2686 ;; marker insertion-type nil.
2687 ;;
2688 ;; There was no strong reason to prefer one or the other, except that
2689 ;; the first is more consistent with prior undo in region behavior.
2691 "Return cons of adjustments to BEG and END by the undo DELTAS
2692 list."
2694 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2699 "Return adjustment of POS by the undo DELTAS list, comparing
2700 with < or <= based on USE-<."
2706 ;; Don't allow pos to become less than the undo-delta
2707 ;; position. This edge case is described in the overview
2708 ;; comments.
2711 ;; Return the first affected buffer position and the delta for an undo element
2712 ;; delta is defined as the change in subsequent buffer positions if we *did*
2713 ;; the undo.
2717 ;; (TEXT . POSITION)
2720 ;; (BEGIN . END)
2727 "If non-nil ask about discarding undo info for the current command.
2728 Normally, Emacs discards the undo info for the current command if
2729 it exceeds `undo-outer-limit'. But if you set this option
2730 non-nil, it asks in the echo area whether to discard the info.
2731 If you answer no, there is a slight risk that Emacs might crash, so
2732 only do it if you really want to undo the command.
2734 This option is mainly intended for debugging. You have to be
2735 careful if you use it for other purposes. Garbage collection is
2736 inhibited while the question is asked, meaning that Emacs might
2737 leak memory. So you should make sure that you do not wait
2738 excessively long before answering the question."
2744 "If non-nil, an extra level of size that's ok in an undo item.
2745 We don't ask the user about truncating the undo list until the
2746 current item gets bigger than this amount.
2751 ;; When the first undo batch in an undo list is longer than
2752 ;; undo-outer-limit, this function gets called to warn the user that
2753 ;; the undo info for the current command was discarded. Garbage
2754 ;; collection is inhibited around the call, so it had better not do a
2755 ;; lot of consing.
2761 ;; Don't ask the question again unless it gets even bigger.
2762 ;; This applies, in particular, if the user quits from the question.
2763 ;; Such a quit quits out of GC, but something else will call GC
2764 ;; again momentarily. It will call this function again,
2765 ;; but we don't want to ask the question again.
2772 t)
2773 nil))
2778 "The undo info was discarded because it exceeded \
2779 `undo-outer-limit'.
2781 This is normal if you executed a command that made a huge change
2782 to the buffer. In that case, to prevent similar problems in the
2783 future, set `undo-outer-limit' to a value that is large enough to
2784 cover the maximum size of normal changes you expect a single
2785 command to make, but not so large that it might exceed the
2786 maximum memory allotted to Emacs.
2788 If you did not execute any such command, the situation is
2789 probably due to a bug and you should report it.
2791 You can disable the popping up of this buffer by adding the entry
2792 \(undo discard-info) to the user option `warning-suppress-types',
2796 t))
2797 \f
2800 ; These are sorted according to the GNU en_US locale.
2843 )
2845 This is used by Shell mode and other parts of Emacs to recognize
2846 password prompts, including prompts in languages other than
2847 English. Different case choices should not be assumed to be
2848 included; callers should bind `case-fold-search' to t."
2854 "History list for some commands that read shell commands.
2856 Maximum length of the history list is determined by the value
2863 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2864 This buffer is used when `shell-command' or `shell-command-on-region'
2865 is run interactively. A value of nil means that output to stderr and
2872 "Return a list of all commands associated with the current file.
2873 This function is used to add all related commands retrieved by `mailcap'
2874 to the end of the list of defaults just after the default value."
2878 minibuffer-default))
2883 commands))
2894 map)
2898 "Read a shell command from the minibuffer.
2899 The arguments are the same as the ones of `read-from-minibuffer',
2900 except READ and KEYMAP are missing and HIST defaults
2901 to `shell-command-history'."
2909 minibuffer-local-shell-command-map
2910 nil
2912 args)))
2915 "What to do when the output buffer is used by another shell command.
2916 This option specifies how to resolve the conflict where a new command
2917 wants to direct its output to the buffer `*Async Shell Command*',
2918 but this buffer is already taken by another running shell command.
2920 The value `confirm-kill-process' is used to ask for confirmation before
2921 killing the already running process and running a new process
2922 in the same buffer, `confirm-new-buffer' for confirmation before running
2923 the command in a new buffer with a name other than the default buffer name,
2924 `new-buffer' for doing the same without confirmation,
2925 `confirm-rename-buffer' for confirmation before renaming the existing
2926 output buffer and running a new command in the default buffer,
2927 `rename-buffer' for doing the same without confirmation."
2929 confirm-kill-process)
2931 confirm-new-buffer)
2933 new-buffer)
2935 confirm-rename-buffer)
2937 rename-buffer))
2942 "Execute string COMMAND asynchronously in background.
2944 Like `shell-command', but adds `&' at the end of COMMAND
2945 to execute it asynchronously.
2947 The output appears in the buffer `*Async Shell Command*'.
2948 That buffer is in shell mode.
2950 You can configure `async-shell-command-buffer' to specify what to do in
2951 case when `*Async Shell Command*' buffer is already taken by another
2952 running shell command. To run COMMAND without displaying the output
2953 in a window you can configure `display-buffer-alist' to use the action
2954 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
2956 In Elisp, you will often be better served by calling `start-process'
2957 directly, since it offers more control and does not impose the use of a
2958 shell (with its need to quote arguments)."
2968 current-prefix-arg
2969 shell-command-default-error-buffer))
2975 "Execute string COMMAND in inferior shell; display output, if any.
2976 With prefix argument, insert the COMMAND's output at point.
2978 If COMMAND ends in `&', execute it asynchronously.
2979 The output appears in the buffer `*Async Shell Command*'.
2980 That buffer is in shell mode. You can also use
2981 `async-shell-command' that automatically adds `&'.
2983 Otherwise, COMMAND is executed synchronously. The output appears in
2984 the buffer `*Shell Command Output*'. If the output is short enough to
2985 display in the echo area (which is determined by the variables
2986 `resize-mini-windows' and `max-mini-window-height'), it is shown
2987 there, but it is nonetheless available in buffer `*Shell Command
2988 Output*' even though that buffer is not automatically displayed.
2990 To specify a coding system for converting non-ASCII characters
2992 before this command.
2994 Noninteractive callers can specify coding systems by binding
2995 `coding-system-for-read' and `coding-system-for-write'.
2997 The optional second argument OUTPUT-BUFFER, if non-nil,
2998 says to put the output in some other buffer.
2999 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
3000 If OUTPUT-BUFFER is not a buffer and not nil,
3001 insert output in current buffer. (This cannot be done asynchronously.)
3002 In either case, the buffer is first erased, and the output is
3003 inserted after point (leaving mark after it).
3005 If the command terminates without error, but generates output,
3007 the output can be displayed in the echo area or in its buffer.
3008 If the output is short enough to display in the echo area
3009 \(determined by the variable `max-mini-window-height' if
3010 `resize-mini-windows' is non-nil), it is shown there.
3011 Otherwise,the buffer containing the output is displayed.
3015 of the output.
3017 If there is no output, or if output is inserted in the current buffer,
3018 then `*Shell Command Output*' is deleted.
3020 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3021 or buffer name to which to direct the command's standard error output.
3022 If it is nil, error output is mingled with regular output.
3023 In an interactive call, the variable `shell-command-default-error-buffer'
3024 specifies the value of ERROR-BUFFER.
3026 In Elisp, you will often be better served by calling `call-process' or
3027 `start-process' directly, since it offers more control and does not impose
3028 the use of a shell (with its need to quote arguments)."
3039 current-prefix-arg
3040 shell-command-default-error-buffer))
3041 ;; Look for a handler in case default-directory is a remote file name.
3049 ;; Output goes in current buffer.
3055 temporary-file-directory)))
3056 nil)))
3059 ;; We do not use -f for csh; we will not support broken use of
3060 ;; .cshrcs. Even the BSD csh manual says to use
3061 ;; "if ($?prompt) exit" before things which are not useful
3062 ;; non-interactively. Besides, if someone wants their other
3063 ;; aliases for shell commands then they can still have them.
3067 t)
3068 nil shell-command-switch command)
3075 ;; Do no formatting while reading error file,
3076 ;; because that can run a shell command, and we
3077 ;; don't want that to cause an infinite recursion.
3079 ;; Put point after the inserted errors.
3083 ;; This is like exchange-point-and-mark, but doesn't
3084 ;; activate the mark. It is cleaner to avoid activation,
3085 ;; even though the command loop would deactivate the mark
3086 ;; because we inserted text.
3090 ;; Output goes in a separate buffer.
3091 ;; Preserve the match data in case called from a program.
3094 ;; Command ending with ampersand means asynchronous.
3098 proc)
3099 ;; Remove the ampersand.
3101 ;; Ask the user what to do with already running process.
3106 ;; If will kill a process, query first.
3111 ;; If will create a new buffer, query first.
3118 ;; It will create a new buffer.
3123 ;; If will rename the buffer, query first.
3132 ;; It will rename the buffer.
3139 ;; Setting buffer-read-only to nil doesn't suffice
3140 ;; if some text has a non-nil read-only property,
3141 ;; which comint sometimes adds for prompts.
3147 shell-command-switch command))
3151 ;; Use the comint filter for proper handling of carriage motion
3152 ;; (see `comint-inhibit-carriage-motion'),.
3154 ))
3155 ;; Otherwise, command is executed synchronously.
3157 output-buffer nil error-buffer)))))))
3161 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3162 MESSAGE may be either a string or a buffer.
3164 A buffer is displayed using `display-buffer' if MESSAGE is too long for
3165 the maximum height of the echo area, as defined by `max-mini-window-height'
3166 if `resize-mini-windows' is non-nil.
3168 Returns either the string shown in the echo area, or when a pop-up
3169 buffer is used, the window used to display it.
3171 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3172 name of the buffer used to display it in the case where a pop-up buffer
3173 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3174 string and it is displayed in the echo area, it is not specified whether
3175 the contents are inserted into the buffer anyway.
3177 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
3178 and only used if a buffer is displayed."
3180 ;; Trivial case where we can use the echo area
3184 ;; Trivial case where we can just remove single trailing newline
3187 ;; General case
3190 message
3199 0
3203 (<= lines
3207 max-mini-window-height))
3209 max-mini-window-height)
3213 ;; Don't use the echo area if the output buffer is
3214 ;; already displayed in the selected frame.
3216 ;; Echo area
3222 ;; Buffer
3225 not-this-window frame))))))))
3228 ;; We have a sentinel to prevent insertion of a termination message
3229 ;; in the buffer itself.
3237 &optional output-buffer replace
3238 error-buffer display-error-buffer)
3239 "Execute string COMMAND in inferior shell with region as input.
3240 Normally display output (if any) in temp buffer `*Shell Command Output*';
3241 Prefix arg means replace the region with it. Return the exit code of
3242 COMMAND.
3244 To specify a coding system for converting non-ASCII characters
3246 before this command. By default, the input (from the current buffer)
3247 is encoded using coding-system specified by `process-coding-system-alist',
3248 falling back to `default-process-coding-system' if no match for COMMAND
3249 is found in `process-coding-system-alist'.
3251 Noninteractive callers can specify coding systems by binding
3252 `coding-system-for-read' and `coding-system-for-write'.
3254 If the command generates output, the output may be displayed
3255 in the echo area or in a buffer.
3256 If the output is short enough to display in the echo area
3257 \(determined by the variable `max-mini-window-height' if
3258 `resize-mini-windows' is non-nil), it is shown there.
3259 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3260 The output is available in that buffer in both cases.
3262 If there is output and an error, a message about the error
3263 appears at the end of the output. If there is no output, or if
3264 output is inserted in the current buffer, the buffer `*Shell
3265 Command Output*' is deleted.
3267 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3268 command's output. If the value is a buffer or buffer name,
3269 put the output there. If the value is nil, use the buffer
3270 `*Shell Command Output*'. Any other value, excluding nil,
3271 means to insert the output in the current buffer. In either case,
3272 the output is inserted after point (leaving mark after it).
3274 Optional fifth arg REPLACE, if non-nil, means to insert the
3275 output in place of text from START to END, putting point and mark
3276 around it.
3278 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3279 or buffer name to which to direct the command's standard error
3280 output. If nil, error output is mingled with regular output.
3281 When called interactively, `shell-command-default-error-buffer'
3282 is used for ERROR-BUFFER.
3284 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3285 display the error buffer if there were any errors. When called
3286 interactively, this is t."
3290 ;; Do this before calling region-beginning
3291 ;; and region-end, in case subprocess output
3292 ;; relocates them while we are in the minibuffer.
3294 ;; call-interactively recognizes region-beginning and
3295 ;; region-end specially, leaving them in the history.
3297 string
3298 current-prefix-arg
3299 current-prefix-arg
3300 shell-command-default-error-buffer
3301 t)))
3307 temporary-file-directory)))
3308 nil))
3309 exit-status)
3313 ;; Replace specified region with output from command.
3315 ;; Don't muck with mark unless REPLACE says we should.
3322 t)
3323 nil shell-command-switch command))
3324 ;; It is rude to delete a buffer which the command is not using.
3325 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3326 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3327 ;; (kill-buffer shell-buffer)))
3328 ;; Don't muck with mark unless REPLACE says we should.
3330 ;; No prefix argument: put the output in a temp buffer,
3331 ;; replacing its entire contents.
3336 ;; If the input is the same buffer as the output,
3337 ;; delete everything but the specified region,
3338 ;; then replace that region with the output.
3344 shell-file-name t
3347 t)
3348 nil shell-command-switch
3349 command)))
3350 ;; Clear the output buffer, then run the command with
3351 ;; output there.
3362 buffer)
3363 nil shell-command-switch command)))
3364 ;; Report the output.
3374 ;; There's some output, display it
3376 ;; No output; error?
3383 shell-command-default-error-buffer)
3390 output))
3393 exit-status))
3396 exit-status output))))
3397 ;; Don't kill: there might be useful info in the undo-log.
3398 ;; (kill-buffer buffer)
3399 ))))
3407 ;; Do no formatting while reading error file,
3408 ;; because that can run a shell command, and we
3409 ;; don't want that to cause an infinite recursion.
3411 ;; Put point after the inserted errors.
3416 exit-status))
3419 "Execute shell command COMMAND and return its output as a string."
3422 standard-output
3426 "Process files synchronously in a separate process.
3427 Similar to `call-process', but may invoke a file handler based on
3428 `default-directory'. The current working directory of the
3429 subprocess is `default-directory'.
3431 File names in INFILE and BUFFER are handled normally, but file
3432 names in ARGS should be relative to `default-directory', as they
3433 are passed to the process verbatim. (This is a difference to
3434 `call-process' which does not support file handlers for INFILE
3435 and BUFFER.)
3437 Some file handlers might not support all variants, for example
3438 they might behave as if DISPLAY was nil, regardless of the actual
3439 value passed."
3441 lc stderr-file)
3451 display args)
3457 "Whether a call of `process-file' changes remote files.
3459 By default, this variable is always set to `t', meaning that a
3460 call of `process-file' could potentially change any file on a
3461 remote host. When set to `nil', a file handler could optimize
3462 its behavior with respect to remote file attribute caching.
3464 You should only ever change this variable with a let-binding;
3468 "Start a program in a subprocess. Return the process object for it.
3470 Similar to `start-process', but may invoke a file handler based on
3471 `default-directory'. See Info node `(elisp)Magic File Names'.
3473 This handler ought to run PROGRAM, perhaps on the local host,
3474 perhaps on a remote host that corresponds to `default-directory'.
3475 In the latter case, the local part of `default-directory' becomes
3476 the working directory of the process.
3478 PROGRAM and PROGRAM-ARGS might be file names. They are not
3479 objects of file handler invocation. File handlers might not
3480 support pty association, if PROGRAM is nil."
3484 \f
3485 ;;;; Process menu
3499 map))
3502 "Major mode for listing the processes called by Emacs."
3514 "Kill process at point in a `list-processes' buffer."
3520 "Recompute the list of processes for the Process List buffer.
3521 Also, delete any process that is exited or signaled."
3534 face link
3537 follow-link t
3538 process-buffer ,buf
3539 action process-menu-visit-buffer)
3548 "datagram"
3565 tabulated-list-entries))))))
3571 "Display a list of all processes that are Emacs sub-processes.
3572 If optional argument QUERY-ONLY is non-nil, only processes with
3573 the query-on-exit flag set are listed.
3574 Any process listed as exited or signaled is actually eliminated
3575 after the listing is made.
3576 Optional argument BUFFER specifies a buffer to use, instead of
3578 The return value is always nil.
3580 This function lists only processes that were launched by Emacs. To
3581 see other processes running on the system, use `list-system-processes'."
3593 nil)
3594 \f
3598 ;; For backward compatibility, minus with no modifiers is an ordinary
3599 ;; command if digits have already been entered.
3629 map)
3636 "Begin a numeric argument for the following command.
3641 multiplies the argument by 4 each time.
3643 which is different in effect from any particular numeric argument.
3650 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3651 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3657 arg)))
3661 "Begin a negative numeric argument for the next command.
3670 "Part of the numeric argument for the next command.
3674 last-command-event
3681 ;; Treat -0 as just -, so that -01 will work.
3684 digit))))
3686 \f
3694 "Function to perform the filtering in `filter-buffer-substring'.
3695 The function is called with the same 3 arguments (BEG END DELETE)
3696 that `filter-buffer-substring' received. It should return the
3697 buffer substring between BEG and END, after filtering. If DELETE is
3701 "List of filter functions for `buffer-substring--filter'.
3702 Each function must accept a single argument, a string, and return a string.
3703 The buffer substring is passed to the first function in the list,
3704 and the return value of each function is passed to the next.
3705 As a special convention, point is set to the start of the buffer text
3706 being operated on (i.e., the first argument of `buffer-substring--filter')
3712 "Return the buffer substring between BEG and END, after filtering.
3713 If DELETE is non-nil, delete the text between BEG and END from the buffer.
3715 This calls the function that `filter-buffer-substring-function' specifies
3716 \(passing the same three arguments that it received) to do the work,
3717 and returns whatever it does. The default function does no filtering,
3718 unless a hook has been set.
3720 Use `filter-buffer-substring' instead of `buffer-substring',
3721 `buffer-substring-no-properties', or `delete-and-extract-region' when
3722 you want to allow filtering to take place. For example, major or minor
3723 modes can use `filter-buffer-substring-function' to extract characters
3724 that are special to a buffer, and should not be copied into other buffers."
3728 "Default function to use for `filter-buffer-substring-function'.
3729 Its arguments and return value are as specified for `filter-buffer-substring'.
3730 This respects the wrapper hook `filter-buffer-substring-functions',
3731 and the abnormal hook `buffer-substring-filters'.
3732 No filtering is done unless a hook says to."
3742 string)))
3747 ;;;; Window system cut and paste hooks.
3750 "Function to call to make a killed region available to other programs.
3751 Most window systems provide a facility for cutting and pasting
3752 text between different programs, such as the clipboard on X and
3753 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3755 This variable holds a function that Emacs calls whenever text is
3756 put in the kill ring, to make the new kill available to other
3757 programs. The function takes one argument, TEXT, which is a
3761 "Function to call to get text cut from other programs.
3762 Most window systems provide a facility for cutting and pasting
3763 text between different programs, such as the clipboard on X and
3764 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3766 This variable holds a function that Emacs calls to obtain text
3767 that other programs have provided for pasting. The function is
3768 called with no arguments. If no other program has provided text
3769 to paste, the function should return nil (in which case the
3770 caller, usually `current-kill', should use the top of the Emacs
3771 kill ring). If another program has provided text to paste, the
3772 function should return that text as a string (in which case the
3773 caller should put this string in the kill ring as the latest
3774 kill).
3776 The function may also return a list of strings if the window
3777 system supports multiple selections. The first string will be
3778 used as the pasted text, but the other will be placed in the kill
3779 ring for easy access via `yank-pop'.
3781 Note that the function should return a string only if a program
3782 other than Emacs has provided a string for pasting; if Emacs
3783 provided the most recent string, the function should return nil.
3784 If it is difficult to tell whether Emacs or some other program
3785 provided the current string, it is probably good enough to return
3786 nil if the string is equal (according to `string=') to the last
3788 \f
3791 ;;;; The kill ring data structure.
3794 "List of killed text sequences.
3795 Since the kill ring is supposed to interact nicely with cut-and-paste
3796 facilities offered by window systems, use of this variable should
3797 interact nicely with `interprogram-cut-function' and
3798 `interprogram-paste-function'. The functions `kill-new',
3799 `kill-append', and `current-kill' are supposed to implement this
3800 interaction; you may want to use them instead of manipulating the kill
3804 "Maximum length of kill ring before oldest elements are thrown away."
3812 "Save clipboard strings into kill ring before replacing them.
3813 When one selects something in another program to paste it into Emacs,
3814 but kills something in Emacs before actually pasting it,
3815 this selection is gone unless this variable is non-nil,
3816 in which case the other program's selection is saved in the `kill-ring'
3823 "Do not add a new string to `kill-ring' if it duplicates the last one.
3824 The comparison is done using `equal-including-properties'."
3830 "Make STRING the latest kill in the kill ring.
3831 Set `kill-ring-yank-pointer' to point to it.
3832 If `interprogram-cut-function' is non-nil, apply it to STRING.
3833 Optional second argument REPLACE non-nil means that STRING will replace
3834 the front of the kill ring, rather than being added to the list.
3836 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3837 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3838 STRING.
3840 When the yank handler has a non-nil PARAM element, the original STRING
3841 argument is not used by `insert-for-yank'. However, since Lisp code
3842 may access and use elements from the kill ring directly, the STRING
3845 ;; Due to text properties such as 'yank-handler that
3846 ;; can alter the contents to yank, comparison using
3847 ;; `equal' is unsafe.
3872 ;; It has been argued that this should work similar to `self-insert-command'
3873 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
3875 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
3881 "Append STRING to the end of the latest kill in the kill ring.
3882 If BEFORE-P is non-nil, prepend STRING to the kill.
3883 Also removes the last undo boundary in the current buffer,
3884 depending on `kill-append-merge-undo'.
3885 If `interprogram-cut-function' is set, pass the resulting kill to it."
3893 ;; find the next undo boundary
3897 ;; remove this undo boundary
3902 "Whether rotating the kill ring changes the window system selection.
3903 If non-nil, whenever the kill ring is rotated (usually via the
3904 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3905 to copy the new kill to the window system selection."
3911 "Rotate the yanking point by N places, and then return that kill.
3912 If N is zero and `interprogram-paste-function' is set to a
3913 function that returns a string or a list of strings, and if that
3914 function doesn't return nil, then that string (or list) is added
3915 to the front of the kill ring and the string (or first string in
3916 the list) is returned as the latest kill.
3918 If N is not zero, and if `yank-pop-change-selection' is
3919 non-nil, use `interprogram-cut-function' to transfer the
3920 kill at the new yank point into the window system selection.
3922 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3923 move the yanking point; just return the Nth kill forward."
3926 interprogram-paste-function
3930 ;; Disable the interprogram cut function when we add the new
3931 ;; text to the kill ring, so Emacs doesn't try to own the
3932 ;; selection, with identical text.
3942 kill-ring)))
3947 interprogram-cut-function)
3953 ;;;; Commands for manipulating the kill ring.
3956 "Non-nil means don't signal an error for killing read-only text."
3962 This deletes the text from the buffer and saves it in the kill ring.
3966 If you want to append the killed region to the last killed text,
3969 If the buffer is read-only, Emacs will beep and refrain from deleting
3970 the text, but put the text in the kill ring anyway. This means that
3971 you can use the killing commands to copy text from a read-only buffer.
3973 Lisp programs should use this function for killing text.
3974 (To delete text, use `delete-region'.)
3975 Supply two arguments, character positions indicating the stretch of text
3976 to be killed.
3978 If the previous command was also a kill command,
3979 the text killed this time appends to the text killed last time
3980 to make one entry in the kill ring.
3982 The optional argument REGION if non-nil, indicates that we're not just killing
3983 some text between BEG and END, but we're killing the region."
3984 ;; Pass mark first, then point, because the order matters when
3985 ;; calling `kill-append'.
3994 ;; Add that string to the kill ring, one way or another.
4001 nil)
4003 ;; The code above failed because the buffer, or some of the characters
4004 ;; in the region, are read-only.
4005 ;; We should beep, in case the user just isn't aware of this.
4006 ;; However, there's no harm in putting
4007 ;; the region's text in the kill ring, anyway.
4009 ;; Set this-command now, so it will be set even if we get an error.
4011 ;; This should barf, if appropriate, and give us the correct error.
4014 ;; Signal an error if the buffer is read-only.
4016 ;; If the buffer isn't read-only, the text is.
4019 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4020 ;; to get two copies of the text when the user accidentally types M-w and
4021 ;; then corrects it with the intended C-w.
4023 "Save the region as if killed, but don't kill it.
4024 In Transient Mark mode, deactivate the mark.
4025 If `interprogram-cut-function' is non-nil, also save the text for a window
4026 system cut and paste.
4028 The optional argument REGION if non-nil, indicates that we're not just copying
4029 some text between BEG and END, but we're copying the region.
4031 This command's old key binding has been given to `kill-ring-save'."
4032 ;; Pass mark first, then point, because the order matters when
4033 ;; calling `kill-append'.
4043 nil)
4046 "Save the region as if killed, but don't kill it.
4047 In Transient Mark mode, deactivate the mark.
4048 If `interprogram-cut-function' is non-nil, also save the text for a window
4049 system cut and paste.
4051 If you want to append the killed line to the last killed text,
4054 The optional argument REGION if non-nil, indicates that we're not just copying
4055 some text between BEG and END, but we're copying the region.
4057 This command is similar to `copy-region-as-kill', except that it gives
4058 visual feedback indicating the extent of the region being copied."
4059 ;; Pass mark first, then point, because the order matters when
4060 ;; calling `kill-append'.
4064 ;; This use of called-interactively-p is correct because the code it
4065 ;; controls just gives the user visual feedback.
4070 "Indicate that the region text has been copied interactively.
4071 If the mark is visible in the selected window, blink the cursor
4072 between point and mark if there is currently no active region
4073 highlighting.
4075 If the mark lies outside the selected window, display an
4076 informative message containing a sample of the copied text. The
4077 optional argument MESSAGE-LEN, if non-nil, specifies the length
4078 of this sample text; it defaults to 40."
4081 ;; Inhibit quitting so we can make a quit here
4082 ;; look like a C-g typed as a command.
4085 ;; Swap point-and-mark quickly so as to show the region that
4086 ;; was selected. Don't do it if the region is highlighted.
4089 ;; Swap point and mark.
4093 ;; Swap back.
4096 ;; If user quit, deactivate the mark
4097 ;; as C-g would as a command.
4103 ;; Don't say "killed"; that is misleading.
4110 "Cause following command, if it kills, to add to previous kill.
4111 If the next command kills forward from point, the kill is
4112 appended to the previous killed text. If the command kills
4113 backward, the kill is prepended. Kill commands that act on the
4114 region, such as `kill-region', are regarded as killing forward if
4115 point is after mark, and killing backward if point is before
4116 mark.
4118 If the next command is not a kill command, `append-next-kill' has
4119 no effect.
4121 The argument is used for internal purposes; do not supply one."
4123 ;; We don't use (interactive-p), since that breaks kbd macros.
4137 "A subroutine of `squeeze-bidi-context'.
4138 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4142 lim1)
4149 ;; L and R categories include embedding and
4150 ;; override controls, but we don't want to
4151 ;; replace them, because that might change
4152 ;; the visual order. Likewise with PDF and
4153 ;; isolate controls.
4155 bidi-directional-non-controls-chars
4156 limit)))))
4157 ;; Replace any run of non-RTL characters by a single LRM.
4159 ;; No more characters of CATEGORY, we are done.
4164 ;; Skip directional controls, if any.
4169 "Replace characters between FROM and TO while keeping bidi context.
4171 This function replaces the region of text with as few characters
4172 as possible, while preserving the effect that region will have on
4173 bidirectional display before and after the region."
4177 ;; This is for when they copy text with read-only text
4178 ;; properties.
4182 ;; Replace each run of non-RTL characters with a single LRM.
4184 ;; Replace each run of non-LTR characters with a single RLM. Note
4185 ;; that the \cR category includes both the Arabic Letter (AL) and
4186 ;; R characters; here we ignore the distinction between them,
4187 ;; because that distinction only affects Arabic Number (AN)
4188 ;; characters, which are weak and don't affect the reordering.
4192 "Return buffer text between START and END with its bidi context.
4194 START and END are assumed to belong to the same physical line
4195 of buffer text. This function prepends and appends to the text
4196 between START and END bidi control characters that preserve the
4197 visual order of that text when it is inserted at some other place."
4202 substr para-dir from to)
4209 ;; If we don't have any mixed directional characters in the
4210 ;; entire line, we can just copy the substring without adding
4211 ;; any context.
4226 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4227 ;; (1) force the string to have the same base embedding
4228 ;; direction as the paragraph direction at the source, no matter
4229 ;; what is the paragraph direction at destination; and (2) avoid
4230 ;; affecting the visual order of the surrounding text at
4231 ;; destination if there are characters of different
4232 ;; directionality there.
4237 "Return portion of current buffer between START and END with bidi context.
4239 This function works similar to `buffer-substring', but it prepends and
4240 appends to the text bidi directional control characters necessary to
4241 preserve the visual appearance of the text if it is inserted at another
4242 place. This is useful when the buffer substring includes bidirectional
4243 text and control characters that cause non-trivial reordering on display.
4244 If copied verbatim, such text can have a very different visual appearance,
4245 and can also change the visual appearance of the surrounding text at the
4246 destination of the copy.
4248 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4249 the text properties."
4262 no-properties)))
4266 substr)))
4267 \f
4268 ;; Yanking.
4273 "List of special text property handling conditions for yanking.
4274 Each element should have the form (PROP . FUN), where PROP is a
4275 property symbol and FUN is a function. When the `yank' command
4276 inserts text into the buffer, it scans the inserted text for
4277 stretches of text that have `eq' values of the text property
4278 PROP; for each such stretch of text, FUN is called with three
4279 arguments: the property's value in that text, and the start and
4280 end positions of the text.
4282 This is done prior to removing the properties specified by
4283 `yank-excluded-properties'."
4286 function))
4289 ;; This is actually used in subr.el but defcustom does not work there.
4292 intangible invisible keymap local-map mouse-face read-only
4293 yank-handler)
4294 "Text properties to discard when yanking.
4295 The value should be a list of text properties to discard or t,
4296 which means to discard all text properties.
4298 See also `yank-handled-properties'."
4305 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4306 Function is called with two parameters, START and END corresponding to
4307 the value of the mark and point; it is guaranteed that START <= END.
4311 "Replace just-yanked stretch of killed text with a different stretch.
4312 This command is allowed only immediately after a `yank' or a `yank-pop'.
4313 At such a time, the region contains a stretch of reinserted
4314 previously-killed text. `yank-pop' deletes that text and inserts in its
4315 place a different stretch of killed text.
4317 With no argument, the previous kill is inserted.
4318 With argument N, insert the Nth previous kill.
4319 If N is negative, this is a more recent kill.
4321 The sequence of kills wraps around, so that after the oldest one
4322 comes the newest one.
4324 When this command inserts killed text into the buffer, it honors
4325 `yank-excluded-properties' and `yank-handler' as described in the
4326 doc string for `insert-for-yank-1', which see."
4340 ;; Set the window start back where it was in the yank command,
4341 ;; if possible.
4344 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4345 ;; It is cleaner to avoid activation, even though the command
4346 ;; loop would deactivate the mark because we inserted text.
4349 nil)
4353 More precisely, reinsert the most recent kill, which is the
4354 stretch of killed text most recently killed OR yanked. Put point
4355 at the end, and set mark at the beginning without activating it.
4357 With argument N, reinsert the Nth most recent kill.
4359 When this command inserts text into the buffer, it honors the
4360 `yank-handled-properties' and `yank-excluded-properties'
4361 variables, and the `yank-handler' text property. See
4362 `insert-for-yank-1' for details.
4367 ;; If we don't get all the way thru, make last-command indicate that
4368 ;; for the following command.
4376 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4377 ;; It is cleaner to avoid activation, even though the command
4378 ;; loop would deactivate the mark because we inserted text.
4381 ;; If we do get all the way thru, make this-command indicate that.
4384 nil)
4387 "Rotate the yanking point in the kill ring.
4388 With ARG, rotate that many kills forward (or backward, if negative)."
4391 \f
4392 ;; Some kill commands.
4394 ;; Internal subroutine of delete-char
4400 ;; Internal subroutine of backward-delete-char
4407 "The method for untabifying when deleting backward.
4408 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4409 `hungry' -- delete all whitespace, both tabs and spaces;
4410 `all' -- delete all whitespace, including tabs, spaces and newlines;
4411 nil -- just delete one character."
4417 "Delete characters backward, changing tabs into spaces.
4418 The exact behavior depends on `backward-delete-char-untabify-method'.
4419 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4420 Interactively, ARG is the prefix arg (default 1)
4421 and KILLP is t if a prefix arg was specified."
4444 arg)))
4445 ;; Avoid warning about delete-backward-char
4449 "Kill up to and including ARGth occurrence of CHAR.
4450 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4451 Goes backward if ARG is negative; error if CHAR not found."
4454 ;; Avoid "obsolete" warnings for translation-table-for-input.
4462 ;; kill-line and its subroutines.
4465 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4470 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4471 With prefix argument ARG, kill that many lines from point.
4472 Negative arguments kill lines backward.
4473 With zero argument, kills the text before point on the current line.
4476 a number counts as a prefix arg.
4478 To kill a whole line, when point is not at the beginning, type \
4481 If `show-trailing-whitespace' is non-nil, this command will just
4482 kill the rest of the current line, even if there are only
4483 nonblanks there.
4485 If option `kill-whole-line' is non-nil, then this command kills the whole line
4486 including its terminating newline, when used at the beginning of a line
4487 with no argument. As a consequence, you can always kill a whole line
4490 If you want to append the killed line to the last killed text,
4493 If the buffer is read-only, Emacs will beep and refrain from deleting
4494 the line, but put the line in the kill ring anyway. This means that
4495 you can use this command to copy text from a read-only buffer.
4496 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4497 even beep.)"
4500 ;; It is better to move point to the other end of the kill
4501 ;; before killing. That way, in a read-only buffer, point
4502 ;; moves across the text that is copied to the kill ring.
4503 ;; The choice has no effect on undo now that undo records
4504 ;; the value of point from before the command was run.
4514 ;; If trailing whitespace is visible,
4515 ;; don't treat it as nothing.
4525 "Kill current line.
4526 With prefix ARG, kill that many lines starting from the current line.
4527 If ARG is negative, kill backward. Also kill the preceding newline.
4529 If ARG is zero, kill current line but exclude the trailing newline."
4540 ;; We need to kill in two steps, because the previous command
4541 ;; could have been a kill command, in which case the text
4542 ;; before point needs to be prepended to the current kill
4543 ;; ring entry and the text after point appended. Also, we
4544 ;; need to use save-excursion to avoid copying the same text
4545 ;; twice to the kill ring in read-only buffers.
4563 "Move forward by ARG lines, ignoring currently invisible newlines only.
4564 If ARG is negative, move backward -ARG lines.
4565 If ARG is zero, move to the beginning of the current line."
4572 ;; If the newline we just skipped is invisible,
4573 ;; don't count it.
4577 prop
4582 ;; If invisible text follows, and it is a number of complete lines,
4583 ;; skip it.
4589 prop
4605 ;; If the newline we just moved to is invisible,
4606 ;; don't count it.
4611 prop
4616 ;; If invisible text follows, and it is a number of complete lines,
4617 ;; skip it.
4623 prop
4634 nil)))
4637 "Move to end of current visible line."
4639 ;; If the following character is currently invisible,
4640 ;; skip all characters with that same `invisible' property value,
4641 ;; then find the next newline.
4648 prop
4657 \f
4659 "Insert after point the contents of BUFFER.
4660 Puts mark after the inserted text.
4661 BUFFER may be a buffer or a buffer name."
4671 t))))
4676 nil)
4679 "Append to specified buffer the text of the region.
4680 It is inserted into that buffer before its point.
4682 When calling from a program, give three arguments:
4683 BUFFER (or buffer name), START and END.
4684 START and END specify the portion of the current buffer to be copied."
4691 point)
4702 "Prepend to specified buffer the text of the region.
4703 It is inserted into that buffer after its point.
4705 When calling from a program, give three arguments:
4706 BUFFER (or buffer name), START and END.
4707 START and END specify the portion of the current buffer to be copied."
4716 "Copy to specified buffer the text of the region.
4717 It is inserted into that buffer, replacing existing text there.
4719 When calling from a program, give three arguments:
4720 BUFFER (or buffer name), START and END.
4721 START and END specify the portion of the current buffer to be copied."
4729 \f
4733 "Hook run when the mark becomes active.
4734 It is also run at the end of a command, if the mark is active and
4741 "Return this buffer's mark value as integer, or nil if never set.
4743 In Transient Mark mode, this function signals an error if
4744 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4745 or the argument FORCE is non-nil, it disregards whether the mark
4746 is active, and returns an integer or nil in the usual way.
4748 If you are using this in an editing command, you are most likely making
4749 a mistake; see the documentation of `set-mark'."
4754 ;; Behind display-selections-p.
4757 "Deactivate the mark.
4758 If Transient Mark mode is disabled, this function normally does
4759 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4761 Deactivating the mark sets `mark-active' to nil, updates the
4762 primary selection according to `select-active-regions', and runs
4763 `deactivate-mark-hook'.
4765 If Transient Mark mode was temporarily enabled, reset the value
4766 of the variable `transient-mark-mode'; if this causes Transient
4767 Mark mode to be disabled, don't change `mark-active' to nil or
4768 run `deactivate-mark-hook'."
4772 select-active-regions)
4775 ;; The var `saved-region-selection', if non-nil, is the text in
4776 ;; the region prior to the last command modifying the buffer.
4777 ;; Set the selection to that, or to the current region.
4781 ;; If another program has acquired the selection, region
4782 ;; deactivation should not clobber it (Bug#11772).
4801 "Activate the mark.
4802 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
4812 "Set this buffer's mark to POS. Don't use this function!
4813 That is to say, don't use this function unless you want
4814 the user to see that the mark has moved, and you want the previous
4815 mark position to be lost.
4817 Normally, when a new mark is set, the old one should go on the stack.
4818 This is why most applications should use `push-mark', not `set-mark'.
4820 Novice Emacs Lisp programmers often try to use the mark for the wrong
4821 purposes. The mark saves a location for the user's convenience.
4822 Most editing commands should not alter the mark.
4823 To remember a location for internal use in the Lisp program,
4824 store it in a Lisp variable. Example:
4826 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4831 ;; Normally we never clear mark-active except in Transient Mark mode.
4832 ;; But when we actually clear out the mark value too, we must
4833 ;; clear mark-active in any mode.
4835 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
4836 ;; it should never be nil if the mark is nil.
4842 If nil, region-aware commands treat empty regions as inactive.
4843 If non-nil, region-aware commands treat the region as active as
4844 long as the mark is active, even if the region is empty.
4846 Region-aware commands are those that act on the region if it is
4847 active and Transient Mark mode is enabled, and on the text near
4848 point otherwise."
4854 "Return t if the region is active and it is appropriate to act on it.
4855 This is used by commands that act specially on the region under
4856 Transient Mark mode.
4858 The return value is t if Transient Mark mode is enabled and the
4859 mark is active; furthermore, if `use-empty-active-region' is nil,
4860 the region must not be empty. Otherwise, the return value is nil.
4862 For some commands, it may be appropriate to ignore the value of
4863 `use-empty-active-region'; in that case, use `region-active-p'."
4868 "Return t if Transient Mark mode is enabled and the mark is active.
4870 Some commands act specially on the region when Transient Mark
4871 mode is enabled. Usually, such commands should use
4872 `use-region-p' instead of this function, because `use-region-p'
4873 also checks the value of `use-empty-active-region'."
4875 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
4876 ;; without the mark being set (e.g. bug#17324). We really should fix
4877 ;; that problem, but in the mean time, let's make sure we don't say the
4878 ;; region is active when there's no mark.
4892 ;; Normal priority so that a large region doesn't hide all the
4893 ;; overlays within it, but high secondary priority so that if it
4894 ;; ends/starts in the middle of a small overlay, that small overlay
4895 ;; won't hide the region's boundaries.
4897 nrol)
4902 rol)))
4915 start end window rol)))
4918 new)))))))
4943 "Maximum size of mark ring. Start discarding off end if gets this big."
4951 "Maximum size of global mark ring. \
4952 Start discarding off end if gets this big."
4957 "Jump to mark, and pop a new position for mark off the ring.
4958 \(Does not affect global mark ring)."
4968 "Set mark at where point is.
4969 If no prefix ARG and mark is already set there, just activate it.
4970 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4982 will pop the mark twice, and
4984 will pop the mark three times.
4992 "Set the mark where point is, or jump to the mark.
4993 Setting the mark also alters the region, which is the text
4994 between point and mark; this is the closest equivalent in
4997 With no prefix argument, set the mark at point, and push the
4998 old mark position on local mark ring. Also push the old mark on
4999 global mark ring, if the previous mark was set in another buffer.
5001 When Transient Mark Mode is off, immediately repeating this
5002 command activates `transient-mark-mode' temporarily.
5005 jump to the mark, and set the mark from
5006 position popped off the local mark ring (this does not affect the global
5008 mark ring (see `pop-global-mark').
5010 If `set-mark-command-repeat-pop' is non-nil, repeating
5012 off the local (or global) mark ring and jumps there.
5015 argument, unconditionally set mark where point is, even if
5016 `set-mark-command-repeat-pop' is non-nil.
5018 Novice Emacs Lisp programmers often try to use the mark for the wrong
5019 purposes. See the documentation of `set-mark' for more information."
5039 arg)
5053 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5054 If the last global mark pushed was not in the current buffer,
5055 also push LOCATION on the global mark ring.
5056 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5058 Novice Emacs Lisp programmers often try to use the mark for the wrong
5059 purposes. See the documentation of `set-mark' for more information.
5061 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5068 ;; Now push the mark on the global mark ring.
5071 ;; The last global mark pushed was in this same buffer.
5072 ;; Don't push another one.
5073 nil
5082 nil)
5085 "Pop off mark ring into the buffer's actual mark.
5086 Does not set point. Does nothing if mark ring is empty."
5098 "Put the mark where point is now, and point where the mark is now.
5099 This command works even when the mark is not active,
5100 and it reactivates the mark.
5102 If Transient Mark mode is on, a prefix ARG deactivates the mark
5103 if it is active, and otherwise avoids reactivating it. If
5104 Transient Mark mode is off, a prefix ARG enables Transient Mark
5105 mode temporarily."
5119 nil))
5122 "When non-nil, shifted motion keys activate the mark momentarily.
5124 While the mark is activated in this way, any shift-translated point
5125 motion key extends the region, and if Transient Mark mode was off, it
5126 is temporarily turned on. Furthermore, the mark will be deactivated
5127 by any subsequent point motion key that was not shift-translated, or
5128 by any action that normally deactivates the mark in Transient Mark mode.
5130 See `this-command-keys-shift-translated' for the meaning of
5131 shift-translation."
5136 "Activate/deactivate mark depending on invocation thru shift translation.
5137 This function is called by `call-interactively' when a command
5138 with a `^' character in its `interactive' spec is invoked, before
5139 running the command itself.
5141 If `shift-select-mode' is enabled and the command was invoked
5142 through shift translation, set the mark and activate the region
5143 temporarily, unless it was already set in this way. See
5144 `this-command-keys-shift-translated' for the meaning of shift
5145 translation.
5147 Otherwise, if the region has been activated temporarily,
5148 deactivate it, and restore the variable `transient-mark-mode' to
5149 its earlier value."
5156 transient-mark-mode)))
5165 "Toggle Transient Mark mode.
5166 With a prefix argument ARG, enable Transient Mark mode if ARG is
5167 positive, and disable it otherwise. If called from Lisp, enable
5168 Transient Mark mode if ARG is omitted or nil.
5170 Transient Mark mode is a global minor mode. When enabled, the
5171 region is highlighted whenever the mark is active. The mark is
5173 operations that set the mark but whose main purpose is something
5179 Many commands change their behavior when Transient Mark mode is
5180 in effect and the mark is active, by acting on the region instead
5181 of their usual default part of the buffer's text. Examples of
5184 To see the documentation of commands which are sensitive to the
5187 :global t
5188 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5192 "Non-nil means it is ok for commands to call `widen' when they want to.
5193 Some commands will do this in order to go to positions outside
5194 the current accessible part of the buffer.
5196 If `widen-automatically' is nil, these commands will do something else
5200 "Whether the currently executing code is performing an essential task.
5201 This variable should be non-nil only when running code which should not
5202 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5203 user for a password when we are simply scanning a set of files in the
5204 background or displaying possible completions before the user even asked
5208 "Pop off global mark ring and jump to the top location."
5210 ;; Pop entries which refer to non-existent buffers.
5228 \f
5230 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5236 "Move cursor vertically down ARG lines.
5237 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5238 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5239 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5240 function will not vscroll.
5242 ARG defaults to 1.
5244 If there is no character in the target line exactly under the current column,
5245 the cursor is positioned after the character in that line which spans this
5246 column, or at the end of the line if it is not long enough.
5247 If there is no line in the buffer after this one, behavior depends on the
5248 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5249 to create a line, and moves the cursor to that line. Otherwise it moves the
5250 cursor to the end of the buffer.
5252 If the variable `line-move-visual' is non-nil, this command moves
5253 by display lines. Otherwise, it moves by buffer lines, without
5254 taking variable-width characters or continued lines into account.
5257 a semipermanent goal column for this command.
5258 Then instead of trying to move exactly vertically (or as close as possible),
5259 this command moves to the specified goal column (or as close as possible).
5260 The goal column is stored in the variable `goal-column', which is nil
5261 when there is no goal column. Note that setting `goal-column'
5262 overrides `line-move-visual' and causes this command to move by buffer
5263 lines rather than by display lines."
5269 ;; When adding a newline, don't expand an abbrev.
5280 nil)
5283 "Move cursor vertically up ARG lines.
5284 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5285 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5286 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5287 function will not vscroll.
5289 ARG defaults to 1.
5291 If there is no character in the target line exactly over the current column,
5292 the cursor is positioned after the character in that line which spans this
5293 column, or at the end of the line if it is not long enough.
5295 If the variable `line-move-visual' is non-nil, this command moves
5296 by display lines. Otherwise, it moves by buffer lines, without
5297 taking variable-width characters or continued lines into account.
5300 a semipermanent goal column for this command.
5301 Then instead of trying to move exactly vertically (or as close as possible),
5302 this command moves to the specified goal column (or as close as possible).
5303 The goal column is stored in the variable `goal-column', which is nil
5304 when there is no goal column. Note that setting `goal-column'
5305 overrides `line-move-visual' and causes this command to move by buffer
5306 lines rather than by display lines."
5317 nil)
5320 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5321 This means moving to the end of each line moved onto.
5322 The beginning of a blank line does not count as the end of a line.
5323 This has no effect when the variable `line-move-visual' is non-nil."
5329 A non-nil setting overrides the variable `line-move-visual', which see."
5336 "Current goal column for vertical motion.
5337 It is the column where point was at the start of the current run
5338 of vertical motion commands.
5340 When moving by visual lines via the function `line-move-visual', it is a cons
5341 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5342 divided by the default column width, and HSCROLL is the number of
5343 columns by which window is scrolled from left margin.
5345 When the `track-eol' feature is doing its job, the value is
5349 "Non-nil means commands that move by lines ignore invisible newlines.
5350 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5351 as if newlines that are invisible didn't exist, and count
5352 only visible newlines. Thus, moving across across 2 newlines
5353 one of which is invisible will be counted as a one-line move.
5354 Also, a non-nil value causes invisible text to be ignored when
5355 counting columns for the purposes of keeping point in the same
5358 Outline mode sets this."
5363 "When non-nil, `line-move' moves point by visual lines.
5364 This movement is based on where the cursor is displayed on the
5365 screen, instead of relying on buffer contents alone. It takes
5366 into account variable-width characters and line continuation.
5367 If nil, `line-move' moves point by logical lines.
5368 A non-nil setting of `goal-column' overrides the value of this variable
5369 and forces movement by logical lines.
5370 A window that is horizontally scrolled also forces movement by logical
5371 lines."
5376 ;; Only used if display-graphic-p.
5380 "Return the height in pixels of the current buffer's default face font."
5384 ;; Avoid calling font-info if the frame's default font was
5385 ;; not changed since the frame was created. That's because
5386 ;; font-info is expensive for some fonts, see bug #14838.
5392 "Return the pixel height of current buffer's default-face text line.
5394 The value includes `line-spacing', if any, defined for the buffer
5395 or the frame."
5408 "Return the number of screen lines in the text area of the selected window.
5410 This is different from `window-text-height' in that this function counts
5411 lines in units of the height of the font used by the default face displayed
5412 in the window, not in units of the frame's default font, and also accounts
5413 for `line-spacing', if any, defined for the window's buffer or frame.
5415 The value is a floating-point number."
5420 ;; Returns non-nil if partial move was done.
5423 ;; Move backward (up).
5424 ;; If already vscrolled, reduce vscroll
5430 ;; Move forward (down).
5443 py vs last-line)
5463 col-row)
5468 ;; VPOS > 0 means the last line is only partially visible.
5469 ;; But if the part that is visible is at least as tall as the
5470 ;; default font, that means the line is actually fully
5471 ;; readable, and something like line-spacing is hidden. So in
5472 ;; that case we accept the last line in the window as still
5473 ;; visible, and consider the margin as starting one line
5474 ;; later.
5482 ;; If last line of window is fully visible, and vscrolling
5483 ;; more would make this line invisible, move forward.
5488 nil)
5489 ;; If cursor is not in the bottom scroll margin, and the
5490 ;; current line is is not too tall, move forward.
5492 vpos
5495 nil)
5496 ;; When already vscrolled, we vscroll some more if we can,
5497 ;; or clear vscroll and move forward at end of tall image.
5502 ;; If cursor just entered the bottom scroll margin, move forward,
5503 ;; but also optionally vscroll one line so redisplay won't recenter.
5507 ;; Don't vscroll if the partially-visible line at window
5508 ;; bottom is not too tall (a.k.a. "just one more text
5509 ;; line"): in that case, we do want redisplay to behave
5510 ;; normally, i.e. recenter or whatever.
5511 ;;
5512 ;; Note: ROWH + RBOT from the value returned by
5513 ;; pos-visible-in-window-p give the total height of the
5514 ;; partially-visible glyph row at the end of the window. As
5515 ;; we are dealing with floats, we disregard sub-pixel
5516 ;; discrepancies between that and DLH.
5520 t)
5521 ;; If there are lines above the last line, scroll-up one line.
5524 t)
5525 ;; Finally, start vscroll.
5530 ;; This is like line-move-1 except that it also performs
5531 ;; vertical scrolling of tall images if appropriate.
5532 ;; That is not really a clean thing to do, since it mixes
5533 ;; scrolling with cursor motion. But so far we don't have
5534 ;; a cleaner solution to the problem of making C-n do something
5535 ;; useful given a tall image.
5537 "Move forward ARG lines.
5538 If NOERROR, don't signal an error if we can't move ARG lines.
5539 TO-END is unused.
5540 TRY-VSCROLL controls whether to vscroll tall lines: if either
5541 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5542 not vscroll."
5546 ;; Only vscroll for single line moves
5548 ;; Under scroll-conservatively, the display engine
5549 ;; does this better.
5551 ;; But don't vscroll in a keyboard macro.
5557 ;; Display-based column are incompatible with goal-column.
5559 ;; When the text in the window is scrolled to the left,
5560 ;; display-based motion doesn't make sense (because each
5561 ;; logical line occupies exactly one screen line).
5563 ;; Likewise when the text _was_ scrolled to the left
5564 ;; when the current run of vertical motion commands
5565 ;; started.
5568 auto-hscroll-mode
5570 (>= temporary-goal-column
5573 ;; If we moved into a tall line, set vscroll to make
5574 ;; scrolling through tall images more smooth.
5578 winh)
5584 nil
5588 ;; Display-based alternative to line-move-1.
5589 ;; Arg says how many lines to move. The value is t if we can move the
5590 ;; specified number of lines.
5592 "Move ARG lines forward.
5593 If NOERROR, don't signal an error if we can't move that many lines."
5596 target-hscroll)
5597 ;; Check if the previous command was a line-motion command, or if
5598 ;; we were called from some other command.
5601 ;; If so, there's no need to reset `temporary-goal-column',
5602 ;; but we may need to hscroll.
5606 ;; Otherwise, we should reset `temporary-goal-column'.
5609 ;; Handle the `overflow-newline-into-fringe' case:
5616 hscroll))))))
5619 ;; vertical-motion can move more than it was asked to if it moves
5620 ;; across display strings with newlines. We don't want to ring
5621 ;; the bell and announce beginning/end of buffer in that case.
5627 temporary-goal-column))
5628 arg))
5629 arg))
5635 temporary-goal-column))
5636 arg))
5637 arg)))
5640 ;; If the goal column lies on a display string,
5641 ;; `vertical-motion' advances the cursor to the end
5642 ;; of the string. For arg < 0, this can cause the
5643 ;; cursor to get stuck. (Bug#3020).
5647 nil)))))
5649 ;; This is the guts of next-line and previous-line.
5650 ;; Arg says how many lines to move.
5651 ;; The value is t if we can move the specified number of lines.
5653 ;; Don't run any point-motion hooks, and disregard intangibility,
5654 ;; for intermediate positions.
5666 ;; Don't count beg of empty line as end of line
5667 ;; unless we just did explicit end-of-line.
5669 most-positive-fixnum
5673 line-move-ignore-invisible))
5674 ;; Use just newline characters.
5675 ;; Set ARG to 0 if we move as many lines as requested.
5678 ;; This way of moving forward ARG lines
5679 ;; verifies that we have a newline after the last one.
5680 ;; It doesn't get confused by intangible text.
5689 'beginning-of-buffer
5691 nil)))
5692 ;; Move by arg lines, but ignore invisible ones.
5695 ;; If the following character is currently invisible,
5696 ;; skip all characters with that same `invisible' property value.
5699 ;; Move a line.
5700 ;; We don't use `end-of-line', since we want to escape
5701 ;; from field boundaries occurring exactly at point.
5707 ;; If there's no invisibility here, move over the newline.
5716 ;; We avoid vertical-motion when possible
5717 ;; because that has to fontify.
5719 ;; Otherwise move a more sophisticated way.
5726 ;; The logic of this is the same as the loop above,
5727 ;; it just goes in the other direction.
5729 ;; For completely consistency with the forward-motion
5730 ;; case, we should call beginning-of-line here.
5731 ;; However, if point is inside a field and on a
5732 ;; continued line, the call to (vertical-motion -1)
5733 ;; below won't move us back far enough; then we return
5734 ;; to the same column in line-move-finish, and point
5735 ;; gets stuck -- cyd
5753 ;; if our target is the middle of this line.
5758 ;; This is the value the function returns.
5762 ;; If we did not move down as far as desired, at least go
5763 ;; to end of line. Be sure to call point-entered and
5764 ;; point-left-hooks.
5770 ;; If we did not move up as far as desired,
5771 ;; at least go to beginning of line.
5783 ;; Set REPEAT to t to repeat the whole thing.
5790 ;; Compute the end of the line
5791 ;; ignoring effectively invisible newlines.
5793 ;; Like end-of-line but ignores fields.
5800 ;; Move to the desired column.
5803 ;; Corner case: suppose we start out in a field boundary in
5804 ;; the middle of a continued line. When we get to
5805 ;; line-move-finish, point is at the start of a new *screen*
5806 ;; line but the same text line; then line-move-to-column would
5807 ;; move us backwards. Test using C-n with point on the "x" in
5808 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5815 ;; Process intangibility within a line.
5816 ;; With inhibit-point-motion-hooks bound to nil, a call to
5817 ;; goto-char moves point past intangible text.
5819 ;; However, inhibit-point-motion-hooks controls both the
5820 ;; intangibility and the point-entered/point-left hooks. The
5821 ;; following hack avoids calling the point-* hooks
5822 ;; unnecessarily. Note that we move *forward* past intangible
5823 ;; text when the initial and final points are the same.
5828 ;; If intangibility moves us to a different (later) place
5829 ;; in the same line, use that as the destination.
5832 ;; If that position is "too late",
5833 ;; try the previous allowable position.
5834 ;; See if it is ok.
5837 ;; If going forward, don't accept the previous
5838 ;; allowable position if it is before the target line.
5840 ;; If going backward, don't accept the previous
5841 ;; allowable position if it is still after the target line.
5844 ;; As a last resort, use the end of the line.
5847 ;; Now move to the updated destination, processing fields
5848 ;; as well as intangibility.
5852 ;; Ignore field boundaries if the initial and final
5853 ;; positions have the same `field' property, even if the
5854 ;; fields are non-contiguous. This seems to be "nicer"
5855 ;; behavior in many situations.
5858 new
5862 ;; If all this moved us to a different line,
5863 ;; retry everything within that new line.
5865 ;; Repeat the intangibility and field processing.
5869 "Try to find column COL, considering invisibility.
5870 This function works only in certain cases,
5871 because what we really need is for `move-to-column'
5872 and `current-column' to be able to ignore invisible text."
5881 ;; If the following character is currently invisible,
5882 ;; skip all characters with that same `invisible' property value.
5886 ;; Have we advanced to a larger column position?
5888 ;; We have made some progress towards the desired column.
5889 ;; See if we can make any further progress.
5891 ;; Otherwise, go to the place we originally found
5892 ;; and move back over invisible text.
5893 ;; that will get us to the same place on the screen
5894 ;; but with a more reasonable buffer position.
5901 "Move point to end of current line as displayed.
5902 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5903 If point reaches the beginning or end of buffer, it stops there.
5905 To ignore the effects of the `intangible' text or overlay
5906 property, bind `inhibit-point-motion-hooks' to t.
5907 If there is an image in the current line, this function
5908 disregards newlines that are part of the text on which the image
5909 rests."
5919 ;; With bidi reordering, we may not be at bol,
5920 ;; so make sure we are.
5935 ;; If we skipped something intangible and now we're not
5936 ;; really at eol, keep going.
5941 "Move point to beginning of current line as displayed.
5942 \(If there's an image in the line, this disregards newlines
5943 which are part of the text that the image rests on.)
5945 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5946 If point reaches the beginning or end of buffer, it stops there.
5947 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5952 first-vis first-vis-field-value)
5954 ;; Move by lines, if ARG is not 1 (the default).
5959 ;; Move to beginning-of-line, ignoring fields and invisible text.
5965 ;; Now find first visible char in the line.
5970 ;; See if fields would stop us from reaching FIRST-VIS.
5975 ;; If yes, obey them.
5976 first-vis-field-value
5977 ;; Otherwise, move to START with attention to fields.
5978 ;; (It is possible that fields never matter in this case.)
5983 ;; Many people have said they rarely use this feature, and often type
5984 ;; it by accident. Maybe it shouldn't even be on a key.
5989 Those commands will move to this position in the line moved to
5990 rather than trying to keep the same horizontal position.
5991 With a non-nil argument ARG, clears out the goal column
5993 The goal column is stored in the variable `goal-column'."
6000 ;; The older method below can be erroneous if `set-goal-column' is bound
6001 ;; to a sequence containing %
6002 ;;(message (substitute-command-keys
6003 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6004 ;;goal-column)
6011 )
6012 nil)
6013 \f
6014 ;;; Editing based on visual lines, as opposed to logical lines.
6017 "Move point to end of current visual line.
6018 With argument N not nil or 1, move forward N - 1 visual lines first.
6019 If point reaches the beginning or end of buffer, it stops there.
6020 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6026 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6027 ;; constrain to field boundaries, so we don't either.
6031 "Move point to beginning of current visual line.
6032 With argument N not nil or 1, move forward N - 1 visual lines first.
6033 If point reaches the beginning or end of buffer, it stops there.
6034 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6042 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6046 "Kill the rest of the visual line.
6047 With prefix argument ARG, kill that many visual lines from point.
6048 If ARG is negative, kill visual lines backward.
6049 If ARG is zero, kill the text before point on the current visual
6050 line.
6052 If you want to append the killed line to the last killed text,
6055 If the buffer is read-only, Emacs will beep and refrain from deleting
6056 the line, but put the line in the kill ring anyway. This means that
6057 you can use this command to copy text from a read-only buffer.
6058 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6059 even beep.)"
6061 ;; Like in `kill-line', it's better to move point to the other end
6062 ;; of the kill before killing.
6070 ;; Skip any trailing whitespace at the end of the visual line.
6071 ;; We used to do this only if `show-trailing-whitespace' is
6072 ;; nil, but that's wrong; the correct thing would be to check
6073 ;; whether the trailing whitespace is highlighted. But, it's
6074 ;; OK to just do this unconditionally.
6081 "Move cursor vertically down ARG lines.
6082 This is identical to `next-line', except that it always moves
6083 by logical lines instead of visual lines, ignoring the value of
6084 the variable `line-move-visual'."
6091 "Move cursor vertically up ARG lines.
6092 This is identical to `previous-line', except that it always moves
6093 by logical lines instead of visual lines, ignoring the value of
6094 the variable `line-move-visual'."
6101 "Editing based on visual lines."
6110 ;; These keybindings interfere with xterm function keys. Are
6111 ;; there any other suitable bindings?
6112 ;; (define-key map "\M-[" 'previous-logical-line)
6113 ;; (define-key map "\M-]" 'next-logical-line)
6114 map))
6117 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6118 The value should be a list of the form (LEFT RIGHT), where LEFT
6119 and RIGHT are symbols representing the bitmaps to display, to
6120 indicate wrapped lines, in the left and right fringes respectively.
6121 See also `fringe-indicator-alist'.
6122 The default is not to display fringe indicators for wrapped lines.
6123 This variable does not affect fringe indicators displayed for
6124 other purposes."
6139 'continuation
6146 "Toggle visual line based editing (Visual Line mode).
6147 With a prefix argument ARG, enable Visual Line mode if ARG is
6148 positive, and disable it otherwise. If called from Lisp, enable
6149 the mode if ARG is omitted or nil.
6151 When Visual Line mode is enabled, `word-wrap' is turned on in
6152 this buffer, and simple editing commands are redefined to act on
6153 visual lines, not logical lines. See Info node `Visual Line
6154 Mode' for details."
6155 :keymap visual-line-mode-map
6161 ;; Save the local values of some variables, to be restored if
6162 ;; visual-line-mode is turned off.
6164 truncate-partial-width-windows
6165 word-wrap fringe-indicator-alist))
6168 visual-line--saved-state)))
6172 word-wrap t
6173 fringe-indicator-alist
6175 fringe-indicator-alist)))
6189 visual-line-mode turn-on-visual-line-mode)
6191 \f
6193 "Interchange characters around point, moving forward one character.
6194 With prefix arg ARG, effect is to take character before point
6195 and drag it forward past ARG other characters (backward if ARG negative).
6196 If no argument and at end of line, the previous two chars are exchanged."
6204 "Interchange words around point, leaving point at end of them.
6205 With prefix arg ARG, effect is to take word before or around point
6206 and drag it forward past ARG other words (backward if ARG negative).
6207 If ARG is zero, the words around or after point and around or after mark
6208 are interchanged."
6209 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6215 Does not work on a sexp that point is in the middle of
6216 if it is a list or string."
6220 ;; Here we should try to simulate the behavior of
6221 ;; (cons (progn (forward-sexp x) (point))
6222 ;; (progn (forward-sexp (- x)) (point)))
6223 ;; Except that we don't want to rely on the second forward-sexp
6224 ;; putting us back to where we want to be, since forward-sexp-function
6225 ;; might do funny things like infix-precedence.
6230 ;; Jumping over a symbol. We might be inside it, mind you.
6235 ;; Otherwise, we're between sexps. Take a step back before jumping
6236 ;; to make sure we'll obey the same precedence no matter which direction
6237 ;; we're going.
6242 'skip-syntax-forward
6249 "Exchange current line and previous line, leaving point after both.
6250 With argument ARG, takes previous line and moves it past ARG lines.
6251 With argument 0, interchanges line point is in with line mark is in."
6257 ;; Move forward over ARG lines,
6258 ;; but create newlines if necessary.
6265 arg))
6267 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6268 ;; which seems inconsistent with the ARG /= 0 case.
6269 ;; FIXME document SPECIAL.
6271 "Subroutine to do the work of transposing objects.
6272 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6273 moves forward by units of the given object (e.g. forward-sentence,
6274 forward-paragraph). If ARG is zero, exchanges the current object
6275 with the one containing mark. If ARG is an integer, moves the
6276 current object past ARG following (if ARG is positive) or
6277 preceding (if ARG is negative) objects, leaving point after the
6278 current object."
6283 pos1 pos2)
6311 ;; This sequence of insertions attempts to preserve marker
6312 ;; positions at the start and end of the transposed objects.
6326 \f
6328 "Move backward until encountering the beginning of a word.
6329 With argument ARG, do this that many times.
6330 If ARG is omitted or nil, move point backward one word."
6335 "Set mark ARG words away from point.
6337 move to with the same argument.
6338 Interactively, if this command is repeated
6339 or (in Transient Mark mode) if the mark is active,
6340 it marks the next ARG words after the ones already marked."
6357 nil t))))
6360 "Kill characters forward until encountering the end of a word.
6361 With argument ARG, do this that many times."
6366 "Kill characters backward until encountering the beginning of a word.
6367 With argument ARG, do this that many times."
6372 "Return the symbol or word that point is on (or a nearby one) as a string.
6373 The return value includes no text properties.
6374 If optional arg STRICT is non-nil, return nil unless point is within
6375 or adjacent to a symbol or word. In all cases the value can be nil
6376 if there is no word nearby.
6377 The function, belying its name, normally finds a symbol.
6378 If optional arg REALLY-WORD is non-nil, it finds just a word."
6387 ;; Point is neither within nor adjacent to a word.
6389 ;; Look for preceding word in same line.
6392 ;; No preceding word in same line.
6393 ;; Look for following word in same line.
6402 ;; If we found something nonempty, return it as a string.
6405 \f
6407 "String for filling to insert at front of new line, or nil for none."
6409 string)
6415 "Regexp to match lines which should not be auto-filled."
6417 regexp)
6421 "The default value for `normal-auto-fill-function'.
6422 This is the default auto-fill function, some major modes use a different one.
6423 Returns t if it really did any work."
6433 nil ;; Auto-filling not required
6437 ;; Choose a fill-prefix automatically.
6445 ;; Use auto-indentation rather than a guessed empty prefix.
6451 ;; Determine where to split the line.
6464 ;; See whether the place we found is any good.
6468 ;; There is no use breaking at end of line.
6470 ;; It is futile to split at the end of the prefix
6471 ;; since we would just insert the prefix again.
6473 ;; Don't split right after a comment starter
6474 ;; since we would just make another comment starter.
6479 limit t)
6481 ;; No good place to break => stop trying.
6483 ;; Ok, we have a useful place to break the line. Do it.
6485 ;; If point is at the fill-point, do not `save-excursion'.
6486 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6487 ;; point will end up before it rather than after it.
6495 ;; Now do justification, if required
6500 ;; If making the new line didn't reduce the hpos of
6501 ;; the end of the line, then give up now;
6502 ;; trying again will not help.
6505 ;; Justify last line.
6507 t)))
6510 "Mode-specific function which line breaks and continues a comment.
6511 This function is called during auto-filling when a comment syntax
6512 is defined.
6513 The function should take a single optional argument, which is a flag
6517 "Break line at point and indent.
6518 If a comment syntax is defined, call `comment-indent-new-line'.
6520 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6521 unless optional argument SOFT is non-nil."
6525 ;; Insert the newline before removing empty space so that markers
6526 ;; get preserved better.
6532 ;; Blindly trust a non-adaptive fill-prefix.
6538 ;; If there's an adaptive prefix, use it unless we're inside
6539 ;; a comment and the prefix is not a comment starter.
6543 ;; If we're not inside a comment, just try to indent.
6547 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6551 ;; `functions' and `hooks' are usually unsafe to set, but setting
6552 ;; auto-fill-function to nil in a file-local setting is safe and
6553 ;; can be useful to prevent auto-filling.
6557 "Toggle automatic line breaking (Auto Fill mode).
6558 With a prefix argument ARG, enable Auto Fill mode if ARG is
6559 positive, and disable it otherwise. If called from Lisp, enable
6560 the mode if ARG is omitted or nil.
6562 When Auto Fill mode is enabled, inserting a space at a column
6563 beyond `current-fill-column' automatically breaks the line at a
6564 previous space.
6566 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6567 non-`nil'.
6569 The value of `normal-auto-fill-function' specifies the function to use
6570 for `auto-fill-function' when turning Auto Fill mode on."
6575 ;; This holds a document string used to document auto-fill-mode.
6577 "Automatically break line at a previous space, in insertion of text."
6578 nil)
6581 "Unconditionally turn on Auto Fill mode."
6585 "Unconditionally turn off Auto Fill mode."
6591 "Set `fill-column' to specified argument.
6596 ;; We used to use current-column silently, but C-x f is too easily
6597 ;; typed as a typo for C-x C-f, so we turned it into an error and
6598 ;; now an interactive prompt.
6603 ;; Disallow missing argument; it's probably a typo for C-x C-f.
6607 \f
6609 "Set `selective-display' to ARG; clear it if no arg.
6610 When the value of `selective-display' is a number > 0,
6611 lines whose indentation is >= that value are not displayed.
6612 The variable `selective-display' has a separate value for each buffer."
6632 "Toggle truncating of long lines for the current buffer.
6633 When truncating is off, long lines are folded.
6634 With prefix argument ARG, truncate long lines if ARG is positive,
6635 otherwise fold them. Note that in side-by-side windows, this
6636 command has no effect if `truncate-partial-width-windows' is
6637 non-nil."
6649 nil t)))
6654 "Toggle whether to use word-wrapping for continuation lines.
6655 With prefix argument ARG, wrap continuation lines at word boundaries
6656 if ARG is positive, otherwise wrap them at the right screen edge.
6657 This command toggles the value of `word-wrap'. It has no effect
6658 if long lines are truncated."
6674 "Toggle Overwrite mode.
6675 With a prefix argument ARG, enable Overwrite mode if ARG is
6676 positive, and disable it otherwise. If called from Lisp, enable
6677 the mode if ARG is omitted or nil.
6679 When Overwrite mode is enabled, printing characters typed in
6680 replace existing text on a one-for-one basis, rather than pushing
6681 it to the right. At the end of a line, such characters extend
6682 the line. Before a tab, such characters insert until the tab is
6684 overwrite mode; this is supposed to make it easier to insert
6685 characters when necessary."
6690 "Toggle Binary Overwrite mode.
6691 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6692 is positive, and disable it otherwise. If called from Lisp,
6693 enable the mode if ARG is omitted or nil.
6695 When Binary Overwrite mode is enabled, printing characters typed
6696 in replace existing text. Newlines are not treated specially, so
6697 typing at the end of a line joins the line to the next, with the
6698 typed character between them. Typing before a tab character
6699 simply replaces the tab with the character typed.
6701 ordinary typing characters do.
6703 Note that Binary Overwrite mode is not its own minor mode; it is
6704 a specialization of overwrite mode, entered by setting the
6705 `overwrite-mode' variable to `overwrite-mode-binary'."
6710 "Toggle line number display in the mode line (Line Number mode).
6711 With a prefix argument ARG, enable Line Number mode if ARG is
6712 positive, and disable it otherwise. If called from Lisp, enable
6713 the mode if ARG is omitted or nil.
6715 Line numbers do not appear for very large buffers and buffers
6716 with very long lines; see variables `line-number-display-limit'
6717 and `line-number-display-limit-width'."
6721 "Toggle column number display in the mode line (Column Number mode).
6722 With a prefix argument ARG, enable Column Number mode if ARG is
6723 positive, and disable it otherwise.
6725 If called from Lisp, enable the mode if ARG is omitted or nil."
6729 "Toggle buffer size display in the mode line (Size Indication mode).
6730 With a prefix argument ARG, enable Size Indication mode if ARG is
6731 positive, and disable it otherwise.
6733 If called from Lisp, enable the mode if ARG is omitted or nil."
6737 "Toggle auto-saving in the current buffer (Auto Save mode).
6738 With a prefix argument ARG, enable Auto Save mode if ARG is
6739 positive, and disable it otherwise.
6741 If called from Lisp, enable the mode if ARG is omitted or nil."
6743 ;; If auto-save is off because buffer has shrunk,
6744 ;; then toggling should turn it on.
6752 buffer-file-name)
6754 ;; If -1 was stored here, to temporarily turn off saving,
6755 ;; turn it back on.
6758 \f
6760 "Blinking matching of parens and expressions."
6765 "Non-nil means show matching open-paren when close-paren is inserted.
6766 If t, highlight the paren. If `jump', move cursor to its position."
6774 "Non-nil means show matching open-paren when it is on screen.
6775 If nil, don't show it (but the open-paren can still be shown
6776 when it is off screen).
6778 This variable has no effect if `blink-matching-paren' is nil.
6779 \(In that case, the open-paren is never shown.)
6780 It is also ignored if `show-paren-mode' is enabled."
6785 "If non-nil, maximum distance to search backwards for matching open-paren.
6786 If nil, search stops at the beginning of the accessible portion of the buffer."
6792 "Time in seconds to delay after showing a matching paren."
6797 "If nil, `blink-matching-paren' ignores comments.
6798 More precisely, when looking for the matching parenthesis,
6799 it skips the contents of comments that end before point."
6804 "Return whether or not START...END are matching parens.
6805 END is the current point and START is the blink position.
6806 START might be nil if no matching starter was found.
6807 Returns non-nil if we find there is a mismatch."
6812 ;; For self-matched chars like " and $, we can't know when they're
6813 ;; mismatched or unmatched, so we can only do it for parens.
6818 ;; The cdr might hold a new paren-class info rather than
6819 ;; a matching-char info, in which case the two CDRs
6820 ;; should match.
6824 "Function to check parentheses mismatches.
6825 The function takes two arguments (START and END) where START is the
6826 position just before the opening token and END is the position right after.
6827 START can be nil, if it was not found.
6834 ol)
6838 "Momentarily highlight the beginning of the sexp before point."
6841 blink-matching-paren)
6851 oldpos))
6859 ;; backward-sexp skips backward over prefix chars,
6860 ;; so move back to the matching paren.
6881 ;; Matching open within window, temporarily move to or highlight
6882 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
6883 ;; is non-nil.
6900 ;; Show what precedes the open in its line, if anything.
6905 ;; Show what follows the open in its line, if anything.
6912 ;; Otherwise show the previous nonblank line,
6913 ;; if there is one.
6922 ;; Replace the newline and other whitespace with `...'.
6923 "..."
6925 ;; There is nothing to show except the char itself.
6931 "Function called, if non-nil, whenever a close parenthesis is inserted.
6937 blink-paren-function
6940 ;; Verify an even number of quoting characters precede the close.
6951 ;; Most likely, this hook is nil, so this arg doesn't matter,
6952 ;; but I use it as a reminder that this function usually
6953 ;; likes to be run after others since it does
6954 ;; `sit-for'. That's also the reason it get a `priority' prop
6955 ;; of 100.
6957 \f
6958 ;; This executes C-g typed while Emacs is waiting for a command.
6959 ;; Quitting out of a program does not go through here;
6960 ;; that happens in the QUIT macro at the C code level.
6962 "Signal a `quit' condition.
6963 During execution of Lisp code, this character causes a quit directly.
6964 At top-level, as an editor command, this simply beeps."
6966 ;; Avoid adding the region to the window selection.
6974 ;; Force the next redisplay cycle to remove the "Def" indicator from
6975 ;; all the mode lines.
6989 This command can exit an interactive command such as `query-replace',
6990 can clear out a prefix argument or a region,
6991 can get out of the minibuffer or other recursive edit,
6992 cancel the use of the current buffer (for special-purpose buffers),
6993 or go back to just one window (by deleting all but the selected window)."
7001 nil)
7012 "Play sound stored in FILE.
7013 VOLUME and DEVICE correspond to the keywords of the sound
7014 specification for `play-sound'."
7024 \f
7026 "Your preference for a mail reading package.
7027 This is used by some keybindings which support reading mail.
7028 See also `mail-user-agent' concerning sending mail."
7038 "Your preference for a mail composition package.
7039 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7040 outgoing email message. This variable lets you specify which
7041 mail-sending package you prefer.
7043 Valid values include:
7045 `message-user-agent' -- use the Message package.
7046 See Info node `(message)'.
7047 `sendmail-user-agent' -- use the Mail package.
7048 See Info node `(emacs)Sending Mail'.
7049 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7050 See Info node `(mh-e)'.
7051 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7052 paraphernalia if Gnus is running, particularly
7053 the Gcc: header for archiving.
7055 Additional valid symbols may be available; check with the author of
7056 your package for details. The function should return non-nil if it
7057 succeeds.
7059 See also `read-mail-command' concerning reading mail."
7062 message-user-agent)
7065 sendmail-user-agent)
7068 mh-e-user-agent)
7071 gnus-user-agent)
7077 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7078 If the value of `mail-user-agent' is the default, and the user
7079 appears to have customizations applying to the old default,
7080 `compose-mail' issues a warning."
7086 "If the buffer starts with a mail header, move point to the header's end.
7087 Otherwise, moves to `point-min'.
7088 The end of the header is the start of the next line, if there is one,
7089 else the end of the last line. This function obeys RFC822."
7095 ;; Used by Rmail (e.g., rmail-forward).
7097 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7101 switch-function yank-action send-actions
7102 return-action)
7103 "Start composing a mail message to send.
7104 This uses the user's chosen mail composition package
7105 as selected with the variable `mail-user-agent'.
7106 The optional arguments TO and SUBJECT specify recipients
7107 and the initial Subject field, respectively.
7109 OTHER-HEADERS is an alist specifying additional
7110 header fields. Elements look like (HEADER . VALUE) where both
7111 HEADER and VALUE are strings.
7113 CONTINUE, if non-nil, says to continue editing a message already
7114 being composed. Interactively, CONTINUE is the prefix argument.
7116 SWITCH-FUNCTION, if non-nil, is a function to use to
7117 switch to and display the buffer used for mail composition.
7119 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7120 to insert the raw text of the message being replied to.
7121 It has the form (FUNCTION . ARGS). The user agent will apply
7122 FUNCTION to ARGS, to insert the raw text of the original message.
7123 \(The user agent will also run `mail-citation-hook', *after* the
7124 original text has been inserted in this way.)
7126 SEND-ACTIONS is a list of actions to call when the message is sent.
7127 Each action has the form (FUNCTION . ARGS).
7129 RETURN-ACTION, if non-nil, is an action for returning to the
7130 caller. It has the form (FUNCTION . ARGS). The function is
7131 called after the mail has been sent or put aside, and the mail
7132 buffer buried."
7136 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7137 ;; from sendmail-user-agent to message-user-agent. Some users may
7138 ;; encounter incompatibilities. This hack tries to detect problems
7139 ;; and warn about them.
7144 mail-yank-hooks mail-archive-file-name
7145 mail-default-reply-to mail-mailing-lists
7146 mail-self-blind))
7153 The default mail mode is now Message mode.
7154 You have the following Mail mode variable%s customized:
7156 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7163 yank-action send-actions return-action)))
7166 yank-action send-actions
7167 return-action)
7171 'switch-to-buffer-other-window yank-action send-actions
7172 return-action))
7175 yank-action send-actions
7176 return-action)
7180 'switch-to-buffer-other-frame yank-action send-actions
7181 return-action))
7183 \f
7185 "History of values entered with `set-variable'.
7187 Maximum length of the history list is determined by the value
7191 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7192 VARIABLE should be a user option variable name, a Lisp variable
7193 meant to be customized by users. You should enter VALUE in Lisp syntax,
7194 so if you want VALUE to be a string, you must surround it with doublequotes.
7195 VALUE is used literally, not evaluated.
7197 If VARIABLE has a `variable-interactive' property, that is used as if
7198 it were the arg to `interactive' (which see) to interactively read VALUE.
7200 If VARIABLE has been defined with `defcustom', then the type information
7201 in the definition is used to check that VALUE is valid.
7203 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7208 default-var)
7224 var obsolete)
7227 ;; Use VAR's `variable-interactive' property
7228 ;; as an interactive spec for prompting.
7231 arg))
7233 read-expression-map t
7234 'set-variable-value-history
7243 ;; Match with custom type.
7255 ;; Force a thorough redisplay for the case that the variable
7256 ;; has an effect on the display, like `tab-width' has.
7258 \f
7259 ;; Define the major mode for lists of completions.
7269 (define-key map [right] 'next-completion)
7271 (define-key map [backtab] 'previous-completion)
7272 (define-key map "q" 'quit-window)
7273 (define-key map "z" 'kill-this-buffer)
7274 map)
7275 "Local map for completion list buffers.")
7277 ;; Completion mode is suitable only for specially formatted data.
7278 (put 'completion-list-mode 'mode-class 'special)
7280 (defvar completion-reference-buffer nil
7281 "Record the buffer that was current when the completion list was requested.
7282 This is a local variable in the completion list buffer.
7283 Initial value is nil to avoid some compiler warnings.")
7285 (defvar completion-no-auto-exit nil
7286 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7287 This also applies to other functions such as `choose-completion'.")
7289 (defvar completion-base-position nil
7290 "Position of the base of the text corresponding to the shown completions.
7291 This variable is used in the *Completions* buffers.
7292 Its value is a list of the form (START END) where START is the place
7293 where the completion should be inserted and END (if non-nil) is the end
7294 of the text to replace. If END is nil, point is used instead.")
7296 (defvar completion-list-insert-choice-function #'completion--replace
7297 "Function to use to insert the text chosen in *Completions*.
7298 Called with three arguments (BEG END TEXT), it should replace the text
7299 between BEG and END with TEXT. Expected to be set buffer-locally
7300 in the *Completions* buffer.")
7302 (defvar completion-base-size nil
7303 "Number of chars before point not involved in completion.
7304 This is a local variable in the completion list buffer.
7305 It refers to the chars in the minibuffer if completing in the
7306 minibuffer, or in `completion-reference-buffer' otherwise.
7307 Only characters in the field at point are included.
7309 If nil, Emacs determines which part of the tail end of the
7310 buffer's text is involved in completion by comparing the text
7311 directly.")
7312 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7314 (defun delete-completion-window ()
7315 "Delete the completion list window.
7316 Go to the window from which completion was requested."
7317 (interactive)
7318 (let ((buf completion-reference-buffer))
7319 (if (one-window-p t)
7320 (if (window-dedicated-p) (delete-frame))
7321 (delete-window (selected-window))
7322 (if (get-buffer-window buf)
7323 (select-window (get-buffer-window buf))))))
7325 (defun previous-completion (n)
7326 "Move to the previous item in the completion list."
7327 (interactive "p")
7328 (next-completion (- n)))
7330 (defun next-completion (n)
7331 "Move to the next item in the completion list.
7332 With prefix argument N, move N items (negative N means move backward)."
7333 (interactive "p")
7334 (let ((beg (point-min)) (end (point-max)))
7335 (while (and (> n 0) (not (eobp)))
7336 ;; If in a completion, move to the end of it.
7337 (when (get-text-property (point) 'mouse-face)
7338 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7339 ;; Move to start of next one.
7340 (unless (get-text-property (point) 'mouse-face)
7341 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7342 (setq n (1- n)))
7343 (while (and (< n 0) (not (bobp)))
7344 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7345 ;; If in a completion, move to the start of it.
7346 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7347 (goto-char (previous-single-property-change
7348 (point) 'mouse-face nil beg)))
7349 ;; Move to end of the previous completion.
7350 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7351 (goto-char (previous-single-property-change
7352 (point) 'mouse-face nil beg)))
7353 ;; Move to the start of that one.
7354 (goto-char (previous-single-property-change
7355 (point) 'mouse-face nil beg))
7356 (setq n (1+ n))))))
7358 (defun choose-completion (&optional event)
7359 "Choose the completion at point.
7360 If EVENT, use EVENT's position to determine the starting position."
7361 (interactive (list last-nonmenu-event))
7362 ;; In case this is run via the mouse, give temporary modes such as
7363 ;; isearch a chance to turn off.
7364 (run-hooks 'mouse-leave-buffer-hook)
7365 (with-current-buffer (window-buffer (posn-window (event-start event)))
7366 (let ((buffer completion-reference-buffer)
7367 (base-size completion-base-size)
7368 (base-position completion-base-position)
7369 (insert-function completion-list-insert-choice-function)
7370 (choice
7371 (save-excursion
7372 (goto-char (posn-point (event-start event)))
7373 (let (beg end)
7374 (cond
7375 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7376 (setq end (point) beg (1+ (point))))
7377 ((and (not (bobp))
7378 (get-text-property (1- (point)) 'mouse-face))
7379 (setq end (1- (point)) beg (point)))
7380 (t (error "No completion here")))
7381 (setq beg (previous-single-property-change beg 'mouse-face))
7382 (setq end (or (next-single-property-change end 'mouse-face)
7383 (point-max)))
7384 (buffer-substring-no-properties beg end)))))
7386 (unless (buffer-live-p buffer)
7387 (error "Destination buffer is dead"))
7388 (quit-window nil (posn-window (event-start event)))
7390 (with-current-buffer buffer
7391 (choose-completion-string
7392 choice buffer
7393 (or base-position
7394 (when base-size
7395 ;; Someone's using old completion code that doesn't know
7396 ;; about base-position yet.
7397 (list (+ base-size (field-beginning))))
7398 ;; If all else fails, just guess.
7399 (list (choose-completion-guess-base-position choice)))
7400 insert-function)))))
7402 ;; Delete the longest partial match for STRING
7403 ;; that can be found before POINT.
7404 (defun choose-completion-guess-base-position (string)
7405 (save-excursion
7406 (let ((opoint (point))
7407 len)
7408 ;; Try moving back by the length of the string.
7409 (goto-char (max (- (point) (length string))
7410 (minibuffer-prompt-end)))
7411 ;; See how far back we were actually able to move. That is the
7412 ;; upper bound on how much we can match and delete.
7413 (setq len (- opoint (point)))
7414 (if completion-ignore-case
7415 (setq string (downcase string)))
7416 (while (and (> len 0)
7417 (let ((tail (buffer-substring (point) opoint)))
7418 (if completion-ignore-case
7419 (setq tail (downcase tail)))
7420 (not (string= tail (substring string 0 len)))))
7421 (setq len (1- len))
7422 (forward-char 1))
7423 (point))))
7425 (defun choose-completion-delete-max-match (string)
7426 (declare (obsolete choose-completion-guess-base-position "23.2"))
7427 (delete-region (choose-completion-guess-base-position string) (point)))
7429 (defvar choose-completion-string-functions nil
7430 "Functions that may override the normal insertion of a completion choice.
7431 These functions are called in order with three arguments:
7432 CHOICE - the string to insert in the buffer,
7433 BUFFER - the buffer in which the choice should be inserted,
7434 BASE-POSITION - where to insert the completion.
7436 If a function in the list returns non-nil, that function is supposed
7437 to have inserted the CHOICE in the BUFFER, and possibly exited
7438 the minibuffer; no further functions will be called.
7440 If all functions in the list return nil, that means to use
7441 the default method of inserting the completion in BUFFER.")
7443 (defun choose-completion-string (choice &optional
7444 buffer base-position insert-function)
7445 "Switch to BUFFER and insert the completion choice CHOICE.
7446 BASE-POSITION says where to insert the completion.
7447 INSERT-FUNCTION says how to insert the completion and falls
7448 back on `completion-list-insert-choice-function' when nil."
7450 ;; If BUFFER is the minibuffer, exit the minibuffer
7451 ;; unless it is reading a file name and CHOICE is a directory,
7452 ;; or completion-no-auto-exit is non-nil.
7454 ;; Some older code may call us passing `base-size' instead of
7455 ;; `base-position'. It's difficult to make any use of `base-size',
7456 ;; so we just ignore it.
7457 (unless (consp base-position)
7458 (message "Obsolete `base-size' passed to choose-completion-string")
7459 (setq base-position nil))
7461 (let* ((buffer (or buffer completion-reference-buffer))
7462 (mini-p (minibufferp buffer)))
7463 ;; If BUFFER is a minibuffer, barf unless it's the currently
7464 ;; active minibuffer.
7465 (if (and mini-p
7466 (not (and (active-minibuffer-window)
7467 (equal buffer
7468 (window-buffer (active-minibuffer-window))))))
7469 (error "Minibuffer is not active for completion")
7470 ;; Set buffer so buffer-local choose-completion-string-functions works.
7471 (set-buffer buffer)
7472 (unless (run-hook-with-args-until-success
7473 'choose-completion-string-functions
7474 ;; The fourth arg used to be `mini-p' but was useless
7475 ;; (since minibufferp can be used on the `buffer' arg)
7476 ;; and indeed unused. The last used to be `base-size', so we
7477 ;; keep it to try and avoid breaking old code.
7478 choice buffer base-position nil)
7479 ;; This remove-text-properties should be unnecessary since `choice'
7480 ;; comes from buffer-substring-no-properties.
7481 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7482 ;; Insert the completion into the buffer where it was requested.
7483 (funcall (or insert-function completion-list-insert-choice-function)
7484 (or (car base-position) (point))
7485 (or (cadr base-position) (point))
7486 choice)
7487 ;; Update point in the window that BUFFER is showing in.
7488 (let ((window (get-buffer-window buffer t)))
7489 (set-window-point window (point)))
7490 ;; If completing for the minibuffer, exit it with this choice.
7491 (and (not completion-no-auto-exit)
7492 (minibufferp buffer)
7493 minibuffer-completion-table
7494 ;; If this is reading a file name, and the file name chosen
7495 ;; is a directory, don't exit the minibuffer.
7496 (let* ((result (buffer-substring (field-beginning) (point)))
7497 (bounds
7498 (completion-boundaries result minibuffer-completion-table
7499 minibuffer-completion-predicate
7500 "")))
7501 (if (eq (car bounds) (length result))
7502 ;; The completion chosen leads to a new set of completions
7503 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7504 (let ((mini (active-minibuffer-window)))
7505 (select-window mini)
7506 (when minibuffer-auto-raise
7507 (raise-frame (window-frame mini))))
7508 (exit-minibuffer))))))))
7510 (define-derived-mode completion-list-mode nil "Completion List"
7511 "Major mode for buffers showing lists of possible completions.
7513 to select the completion near point.
7514 Or click to select one with the mouse.
7517 (set (make-local-variable 'completion-base-size) nil))
7519 (defun completion-list-mode-finish ()
7520 "Finish setup of the completions buffer.
7521 Called from `temp-buffer-show-hook'."
7522 (when (eq major-mode 'completion-list-mode)
7523 (setq buffer-read-only t)))
7525 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7528 ;; Variables and faces used in `completion-setup-function'.
7530 (defcustom completion-show-help t
7531 "Non-nil means show help message in *Completions* buffer."
7532 :type 'boolean
7533 :version "22.1"
7534 :group 'completion)
7536 ;; This function goes in completion-setup-hook, so that it is called
7537 ;; after the text of the completion list buffer is written.
7538 (defun completion-setup-function ()
7539 (let* ((mainbuf (current-buffer))
7540 (base-dir
7541 ;; FIXME: This is a bad hack. We try to set the default-directory
7542 ;; in the *Completions* buffer so that the relative file names
7543 ;; displayed there can be treated as valid file names, independently
7544 ;; from the completion context. But this suffers from many problems:
7545 ;; - It's not clear when the completions are file names. With some
7546 ;; completion tables (e.g. bzr revision specs), the listed
7547 ;; completions can mix file names and other things.
7548 ;; - It doesn't pay attention to possible quoting.
7549 ;; - With fancy completion styles, the code below will not always
7550 ;; find the right base directory.
7551 (if minibuffer-completing-file-name
7552 (file-name-as-directory
7553 (expand-file-name
7554 (buffer-substring (minibuffer-prompt-end)
7555 (- (point) (or completion-base-size 0))))))))
7556 (with-current-buffer standard-output
7557 (let ((base-size completion-base-size) ;Read before killing localvars.
7558 (base-position completion-base-position)
7559 (insert-fun completion-list-insert-choice-function))
7560 (completion-list-mode)
7561 (set (make-local-variable 'completion-base-size) base-size)
7562 (set (make-local-variable 'completion-base-position) base-position)
7563 (set (make-local-variable 'completion-list-insert-choice-function)
7564 insert-fun))
7565 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7566 (if base-dir (setq default-directory base-dir))
7567 ;; Maybe insert help string.
7568 (when completion-show-help
7569 (goto-char (point-min))
7570 (if (display-mouse-p)
7571 (insert (substitute-command-keys
7573 (insert (substitute-command-keys
7577 (add-hook 'completion-setup-hook 'completion-setup-function)
7579 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7580 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7582 (defun switch-to-completions ()
7583 "Select the completion list window."
7584 (interactive)
7585 (let ((window (or (get-buffer-window "*Completions*" 0)
7586 ;; Make sure we have a completions window.
7587 (progn (minibuffer-completion-help)
7588 (get-buffer-window "*Completions*" 0)))))
7589 (when window
7590 (select-window window)
7591 ;; In the new buffer, go to the first completion.
7592 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
7593 (when (bobp)
7594 (next-completion 1)))))
7595 \f
7596 ;;; Support keyboard commands to turn on various modifiers.
7598 ;; These functions -- which are not commands -- each add one modifier
7599 ;; to the following event.
7601 (defun event-apply-alt-modifier (_ignore-prompt)
7604 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
7605 (defun event-apply-super-modifier (_ignore-prompt)
7608 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
7609 (defun event-apply-hyper-modifier (_ignore-prompt)
7612 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
7613 (defun event-apply-shift-modifier (_ignore-prompt)
7616 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
7617 (defun event-apply-control-modifier (_ignore-prompt)
7620 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
7621 (defun event-apply-meta-modifier (_ignore-prompt)
7624 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
7626 (defun event-apply-modifier (event symbol lshiftby prefix)
7627 "Apply a modifier flag to event EVENT.
7628 SYMBOL is the name of this modifier, as a symbol.
7629 LSHIFTBY is the numeric value of this modifier, in keyboard events.
7630 PREFIX is the string that represents this modifier in an event type symbol."
7631 (if (numberp event)
7632 (cond ((eq symbol 'control)
7633 (if (and (<= (downcase event) ?z)
7634 (>= (downcase event) ?a))
7635 (- (downcase event) ?a -1)
7636 (if (and (<= (downcase event) ?Z)
7637 (>= (downcase event) ?A))
7638 (- (downcase event) ?A -1)
7639 (logior (lsh 1 lshiftby) event))))
7640 ((eq symbol 'shift)
7641 (if (and (<= (downcase event) ?z)
7642 (>= (downcase event) ?a))
7643 (upcase event)
7644 (logior (lsh 1 lshiftby) event)))
7645 (t
7646 (logior (lsh 1 lshiftby) event)))
7647 (if (memq symbol (event-modifiers event))
7648 event
7649 (let ((event-type (if (symbolp event) event (car event))))
7650 (setq event-type (intern (concat prefix (symbol-name event-type))))
7651 (if (symbolp event)
7652 event-type
7653 (cons event-type (cdr event)))))))
7655 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
7656 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
7657 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
7658 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
7659 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
7660 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
7661 \f
7662 ;;;; Keypad support.
7664 ;; Make the keypad keys act like ordinary typing keys. If people add
7665 ;; bindings for the function key symbols, then those bindings will
7666 ;; override these, so this shouldn't interfere with any existing
7667 ;; bindings.
7669 ;; Also tell read-char how to handle these keys.
7670 (mapc
7671 (lambda (keypad-normal)
7672 (let ((keypad (nth 0 keypad-normal))
7673 (normal (nth 1 keypad-normal)))
7674 (put keypad 'ascii-character normal)
7675 (define-key function-key-map (vector keypad) (vector normal))))
7676 ;; See also kp-keys bound in bindings.el.
7677 '((kp-space ?\s)
7680 (kp-separator ?,)
7681 (kp-equal ?=)
7682 ;; Do the same for various keys that are represented as symbols under
7683 ;; GUIs but naturally correspond to characters.
7684 (backspace 127)
7685 (delete 127)
7688 (clear ?\C-l)
7689 (return ?\C-m)
7690 (escape ?\e)
7691 ))
7692 \f
7693 ;;;;
7694 ;;;; forking a twin copy of a buffer.
7695 ;;;;
7697 (defvar clone-buffer-hook nil
7698 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7700 (defvar clone-indirect-buffer-hook nil
7701 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7703 (defun clone-process (process &optional newname)
7704 "Create a twin copy of PROCESS.
7705 If NEWNAME is nil, it defaults to PROCESS' name;
7706 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7707 If PROCESS is associated with a buffer, the new process will be associated
7708 with the current buffer instead.
7709 Returns nil if PROCESS has already terminated."
7710 (setq newname (or newname (process-name process)))
7712 (setq newname (substring newname 0 (match-beginning 0))))
7713 (when (memq (process-status process) '(run stop open))
7714 (let* ((process-connection-type (process-tty-name process))
7715 (new-process
7716 (if (memq (process-status process) '(open))
7717 (let ((args (process-contact process t)))
7718 (setq args (plist-put args :name newname))
7719 (setq args (plist-put args :buffer
7720 (if (process-buffer process)
7721 (current-buffer))))
7722 (apply 'make-network-process args))
7723 (apply 'start-process newname
7724 (if (process-buffer process) (current-buffer))
7725 (process-command process)))))
7726 (set-process-query-on-exit-flag
7727 new-process (process-query-on-exit-flag process))
7728 (set-process-inherit-coding-system-flag
7729 new-process (process-inherit-coding-system-flag process))
7730 (set-process-filter new-process (process-filter process))
7731 (set-process-sentinel new-process (process-sentinel process))
7732 (set-process-plist new-process (copy-sequence (process-plist process)))
7733 new-process)))
7735 ;; things to maybe add (currently partly covered by `funcall mode'):
7736 ;; - syntax-table
7737 ;; - overlays
7738 (defun clone-buffer (&optional newname display-flag)
7739 "Create and return a twin copy of the current buffer.
7740 Unlike an indirect buffer, the new buffer can be edited
7741 independently of the old one (if it is not read-only).
7742 NEWNAME is the name of the new buffer. It may be modified by
7743 adding or incrementing <N> at the end as necessary to create a
7744 unique buffer name. If nil, it defaults to the name of the
7745 current buffer, with the proper suffix. If DISPLAY-FLAG is
7746 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7747 clone a file-visiting buffer, or a buffer whose major mode symbol
7748 has a non-nil `no-clone' property, results in an error.
7750 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7751 current buffer with appropriate suffix. However, if a prefix
7752 argument is given, then the command prompts for NEWNAME in the
7753 minibuffer.
7755 This runs the normal hook `clone-buffer-hook' in the new buffer
7756 after it has been set up properly in other respects."
7757 (interactive
7758 (progn
7759 (if buffer-file-name
7760 (error "Cannot clone a file-visiting buffer"))
7761 (if (get major-mode 'no-clone)
7762 (error "Cannot clone a buffer in %s mode" mode-name))
7763 (list (if current-prefix-arg
7764 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7765 t)))
7766 (if buffer-file-name
7767 (error "Cannot clone a file-visiting buffer"))
7768 (if (get major-mode 'no-clone)
7769 (error "Cannot clone a buffer in %s mode" mode-name))
7770 (setq newname (or newname (buffer-name)))
7772 (setq newname (substring newname 0 (match-beginning 0))))
7773 (let ((buf (current-buffer))
7774 (ptmin (point-min))
7775 (ptmax (point-max))
7776 (pt (point))
7777 (mk (if mark-active (mark t)))
7778 (modified (buffer-modified-p))
7779 (mode major-mode)
7780 (lvars (buffer-local-variables))
7781 (process (get-buffer-process (current-buffer)))
7782 (new (generate-new-buffer (or newname (buffer-name)))))
7783 (save-restriction
7784 (widen)
7785 (with-current-buffer new
7786 (insert-buffer-substring buf)))
7787 (with-current-buffer new
7788 (narrow-to-region ptmin ptmax)
7789 (goto-char pt)
7790 (if mk (set-mark mk))
7791 (set-buffer-modified-p modified)
7793 ;; Clone the old buffer's process, if any.
7794 (when process (clone-process process))
7796 ;; Now set up the major mode.
7797 (funcall mode)
7799 ;; Set up other local variables.
7800 (mapc (lambda (v)
7801 (condition-case () ;in case var is read-only
7802 (if (symbolp v)
7803 (makunbound v)
7804 (set (make-local-variable (car v)) (cdr v)))
7805 (error nil)))
7806 lvars)
7808 ;; Run any hooks (typically set up by the major mode
7809 ;; for cloning to work properly).
7810 (run-hooks 'clone-buffer-hook))
7811 (if display-flag
7812 ;; Presumably the current buffer is shown in the selected frame, so
7813 ;; we want to display the clone elsewhere.
7814 (let ((same-window-regexps nil)
7815 (same-window-buffer-names))
7816 (pop-to-buffer new)))
7817 new))
7820 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7821 "Create an indirect buffer that is a twin copy of the current buffer.
7823 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7824 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7825 or if not called with a prefix arg, NEWNAME defaults to the current
7826 buffer's name. The name is modified by adding a `<N>' suffix to it
7827 or by incrementing the N in an existing suffix. Trying to clone a
7828 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7829 property results in an error.
7831 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7832 This is always done when called interactively.
7834 Optional third arg NORECORD non-nil means do not put this buffer at the
7835 front of the list of recently selected ones.
7837 Returns the newly created indirect buffer."
7838 (interactive
7839 (progn
7840 (if (get major-mode 'no-clone-indirect)
7841 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7842 (list (if current-prefix-arg
7843 (read-buffer "Name of indirect buffer: " (current-buffer)))
7844 t)))
7845 (if (get major-mode 'no-clone-indirect)
7846 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7847 (setq newname (or newname (buffer-name)))
7849 (setq newname (substring newname 0 (match-beginning 0))))
7850 (let* ((name (generate-new-buffer-name newname))
7851 (buffer (make-indirect-buffer (current-buffer) name t)))
7852 (with-current-buffer buffer
7853 (run-hooks 'clone-indirect-buffer-hook))
7854 (when display-flag
7855 (pop-to-buffer buffer norecord))
7856 buffer))
7859 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7860 "Like `clone-indirect-buffer' but display in another window."
7861 (interactive
7862 (progn
7863 (if (get major-mode 'no-clone-indirect)
7864 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7865 (list (if current-prefix-arg
7866 (read-buffer "Name of indirect buffer: " (current-buffer)))
7867 t)))
7868 (let ((pop-up-windows t))
7869 (clone-indirect-buffer newname display-flag norecord)))
7871 \f
7872 ;;; Handling of Backspace and Delete keys.
7874 (defcustom normal-erase-is-backspace 'maybe
7875 "Set the default behavior of the Delete and Backspace keys.
7877 If set to t, Delete key deletes forward and Backspace key deletes
7878 backward.
7880 If set to nil, both Delete and Backspace keys delete backward.
7882 If set to 'maybe (which is the default), Emacs automatically
7883 selects a behavior. On window systems, the behavior depends on
7884 the keyboard used. If the keyboard has both a Backspace key and
7885 a Delete key, and both are mapped to their usual meanings, the
7886 option's default value is set to t, so that Backspace can be used
7887 to delete backward, and Delete can be used to delete forward.
7889 If not running under a window system, customizing this option
7890 accomplishes a similar effect by mapping C-h, which is usually
7891 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7892 via `keyboard-translate'. The former functionality of C-h is
7893 available on the F1 key. You should probably not use this
7894 setting if you don't have both Backspace, Delete and F1 keys.
7896 Setting this variable with setq doesn't take effect. Programmatically,
7897 call `normal-erase-is-backspace-mode' (which see) instead."
7898 :type '(choice (const :tag "Off" nil)
7899 (const :tag "Maybe" maybe)
7900 (other :tag "On" t))
7901 :group 'editing-basics
7902 :version "21.1"
7903 :set (lambda (symbol value)
7904 ;; The fboundp is because of a problem with :set when
7905 ;; dumping Emacs. It doesn't really matter.
7906 (if (fboundp 'normal-erase-is-backspace-mode)
7907 (normal-erase-is-backspace-mode (or value 0))
7908 (set-default symbol value))))
7910 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7911 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7912 (unless frame (setq frame (selected-frame)))
7913 (with-selected-frame frame
7914 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7915 (normal-erase-is-backspace-mode
7916 (if (if (eq normal-erase-is-backspace 'maybe)
7917 (and (not noninteractive)
7918 (or (memq system-type '(ms-dos windows-nt))
7919 (memq window-system '(w32 ns))
7920 (and (memq window-system '(x))
7921 (fboundp 'x-backspace-delete-keys-p)
7922 (x-backspace-delete-keys-p))
7923 ;; If the terminal Emacs is running on has erase char
7924 ;; set to ^H, use the Backspace key for deleting
7925 ;; backward, and the Delete key for deleting forward.
7926 (and (null window-system)
7927 (eq tty-erase-char ?\^H))))
7928 normal-erase-is-backspace)
7929 1 0)))))
7931 (define-minor-mode normal-erase-is-backspace-mode
7932 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7933 With a prefix argument ARG, enable this feature if ARG is
7934 positive, and disable it otherwise. If called from Lisp, enable
7935 the mode if ARG is omitted or nil.
7937 On window systems, when this mode is on, Delete is mapped to C-d
7938 and Backspace is mapped to DEL; when this mode is off, both
7939 Delete and Backspace are mapped to DEL. (The remapping goes via
7940 `local-function-key-map', so binding Delete or Backspace in the
7941 global or local keymap will override that.)
7943 In addition, on window systems, the bindings of C-Delete, M-Delete,
7944 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7945 the global keymap in accordance with the functionality of Delete and
7946 Backspace. For example, if Delete is remapped to C-d, which deletes
7947 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7948 to DEL, which deletes backward, C-Delete is bound to
7949 `backward-kill-word'.
7951 If not running on a window system, a similar effect is accomplished by
7952 remapping C-h (normally produced by the Backspace key) and DEL via
7953 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7954 to C-d; if it's off, the keys are not remapped.
7956 When not running on a window system, and this mode is turned on, the
7957 former functionality of C-h is available on the F1 key. You should
7958 probably not turn on this mode on a text-only terminal if you don't
7959 have both Backspace, Delete and F1 keys.
7961 See also `normal-erase-is-backspace'."
7962 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7963 . (lambda (v)
7964 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7965 (if v 1 0))))
7966 (let ((enabled (eq 1 (terminal-parameter
7967 nil 'normal-erase-is-backspace))))
7969 (cond ((or (memq window-system '(x w32 ns pc))
7970 (memq system-type '(ms-dos windows-nt)))
7971 (let ((bindings
7972 `(([M-delete] [M-backspace])
7973 ([C-M-delete] [C-M-backspace])
7974 ([?\e C-delete] [?\e C-backspace]))))
7976 (if enabled
7977 (progn
7978 (define-key local-function-key-map [delete] [deletechar])
7979 (define-key local-function-key-map [kp-delete] [deletechar])
7980 (define-key local-function-key-map [backspace] [?\C-?])
7981 (dolist (b bindings)
7982 ;; Not sure if input-decode-map is really right, but
7983 ;; keyboard-translate-table (used below) only works
7984 ;; for integer events, and key-translation-table is
7985 ;; global (like the global-map, used earlier).
7986 (define-key input-decode-map (car b) nil)
7987 (define-key input-decode-map (cadr b) nil)))
7988 (define-key local-function-key-map [delete] [?\C-?])
7989 (define-key local-function-key-map [kp-delete] [?\C-?])
7990 (define-key local-function-key-map [backspace] [?\C-?])
7991 (dolist (b bindings)
7992 (define-key input-decode-map (car b) (cadr b))
7993 (define-key input-decode-map (cadr b) (car b))))))
7994 (t
7995 (if enabled
7996 (progn
7997 (keyboard-translate ?\C-h ?\C-?)
7998 (keyboard-translate ?\C-? ?\C-d))
7999 (keyboard-translate ?\C-h ?\C-h)
8000 (keyboard-translate ?\C-? ?\C-?))))
8002 (if (called-interactively-p 'interactive)
8003 (message "Delete key deletes %s"
8004 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8005 "forward" "backward")))))
8006 \f
8007 (defvar vis-mode-saved-buffer-invisibility-spec nil
8008 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8010 (define-minor-mode read-only-mode
8011 "Change whether the current buffer is read-only.
8012 With prefix argument ARG, make the buffer read-only if ARG is
8013 positive, otherwise make it writable. If buffer is read-only
8014 and `view-read-only' is non-nil, enter view mode.
8016 Do not call this from a Lisp program unless you really intend to
8018 possibly enabling or disabling View mode. Also, note that this
8019 command works by setting the variable `buffer-read-only', which
8020 does not affect read-only regions caused by text properties. To
8021 ignore read-only status in a Lisp program (whether due to text
8022 properties or buffer state), bind `inhibit-read-only' temporarily
8023 to a non-nil value."
8024 :variable buffer-read-only
8025 (cond
8026 ((and (not buffer-read-only) view-mode)
8027 (View-exit-and-edit)
8028 (make-local-variable 'view-read-only)
8029 (setq view-read-only t)) ; Must leave view mode.
8030 ((and buffer-read-only view-read-only
8031 ;; If view-mode is already active, `view-mode-enter' is a nop.
8032 (not view-mode)
8033 (not (eq (get major-mode 'mode-class) 'special)))
8034 (view-mode-enter))))
8036 (define-minor-mode visible-mode
8037 "Toggle making all invisible text temporarily visible (Visible mode).
8038 With a prefix argument ARG, enable Visible mode if ARG is
8039 positive, and disable it otherwise. If called from Lisp, enable
8040 the mode if ARG is omitted or nil.
8042 This mode works by saving the value of `buffer-invisibility-spec'
8043 and setting it to nil."
8044 :lighter " Vis"
8045 :group 'editing-basics
8046 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8047 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8048 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8049 (when visible-mode
8050 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8051 buffer-invisibility-spec)
8052 (setq buffer-invisibility-spec nil)))
8053 \f
8054 (defvar messages-buffer-mode-map
8055 (let ((map (make-sparse-keymap)))
8056 (set-keymap-parent map special-mode-map)
8057 (define-key map "g" nil) ; nothing to revert
8058 map))
8060 (define-derived-mode messages-buffer-mode special-mode "Messages"
8063 (defun messages-buffer ()
8065 If it does not exist, create and it switch it to `messages-buffer-mode'."
8066 (or (get-buffer "*Messages*")
8067 (with-current-buffer (get-buffer-create "*Messages*")
8068 (messages-buffer-mode)
8069 (current-buffer))))
8071 \f
8072 ;; Minibuffer prompt stuff.
8074 ;;(defun minibuffer-prompt-modification (start end)
8075 ;; (error "You cannot modify the prompt"))
8076 ;;
8077 ;;
8078 ;;(defun minibuffer-prompt-insertion (start end)
8079 ;; (let ((inhibit-modification-hooks t))
8080 ;; (delete-region start end)
8081 ;; ;; Discard undo information for the text insertion itself
8082 ;; ;; and for the text deletion.above.
8083 ;; (when (consp buffer-undo-list)
8084 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8085 ;; (message "You cannot modify the prompt")))
8086 ;;
8087 ;;
8088 ;;(setq minibuffer-prompt-properties
8089 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8090 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8092 \f
8093 ;;;; Problematic external packages.
8095 ;; rms says this should be done by specifying symbols that define
8096 ;; versions together with bad values. This is therefore not as
8097 ;; flexible as it could be. See the thread:
8098 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8099 (defconst bad-packages-alist
8100 ;; Not sure exactly which semantic versions have problems.
8101 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8103 "The version of `semantic' loaded does not work in Emacs 22.
8104 It can cause constant high CPU load.
8105 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8106 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8107 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8108 ;; provided the `CUA-mode' feature. Since this is no longer true,
8109 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8110 (CUA-mode t nil
8111 "CUA-mode is now part of the standard GNU Emacs distribution,
8112 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8114 You have loaded an older version of CUA-mode which does not work
8115 correctly with this version of Emacs. You should remove the old
8116 version and use the one distributed with Emacs."))
8117 "Alist of packages known to cause problems in this version of Emacs.
8118 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8119 PACKAGE is either a regular expression to match file names, or a
8120 symbol (a feature name), like for `with-eval-after-load'.
8121 SYMBOL is either the name of a string variable, or `t'. Upon
8122 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8123 warning using STRING as the message.")
8125 (defun bad-package-check (package)
8126 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8127 (condition-case nil
8128 (let* ((list (assoc package bad-packages-alist))
8129 (symbol (nth 1 list)))
8130 (and list
8131 (boundp symbol)
8132 (or (eq symbol t)
8133 (and (stringp (setq symbol (eval symbol)))
8134 (string-match-p (nth 2 list) symbol)))
8135 (display-warning package (nth 3 list) :warning)))
8136 (error nil)))
8138 (dolist (elem bad-packages-alist)
8139 (let ((pkg (car elem)))
8140 (with-eval-after-load pkg
8141 (bad-package-check pkg))))
8143 \f
8144 ;;; Generic dispatcher commands
8146 ;; Macro `define-alternatives' is used to create generic commands.
8147 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8148 ;; that can have different alternative implementations where choosing
8149 ;; among them is exclusively a matter of user preference.
8151 ;; (define-alternatives COMMAND) creates a new interactive command
8152 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8153 ;; Typically, the user will not need to customize this variable; packages
8154 ;; wanting to add alternative implementations should use
8155 ;;
8156 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8158 (defmacro define-alternatives (command &rest customizations)
8159 "Define the new command `COMMAND'.
8161 The argument `COMMAND' should be a symbol.
8163 Running `M-x COMMAND RET' for the first time prompts for which
8164 alternative to use and records the selected command as a custom
8165 variable.
8167 Running `C-u M-x COMMAND RET' prompts again for an alternative
8168 and overwrites the previous choice.
8170 The variable `COMMAND-alternatives' contains an alist with
8171 alternative implementations of COMMAND. `define-alternatives'
8172 does not have any effect until this variable is set.
8174 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8175 `defcustom' keywords and values to add to the declaration of
8176 `COMMAND-alternatives' (typically :group and :version)."
8177 (let* ((command-name (symbol-name command))
8178 (varalt-name (concat command-name "-alternatives"))
8179 (varalt-sym (intern varalt-name))
8180 (varimp-sym (intern (concat command-name "--implementation"))))
8181 `(progn
8183 (defcustom ,varalt-sym nil
8184 ,(format "Alist of alternative implementations for the `%s' command.
8186 Each entry must be a pair (ALTNAME . ALTFUN), where:
8187 ALTNAME - The name shown at user to describe the alternative implementation.
8188 ALTFUN - The function called to implement this alternative."
8189 command-name)
8190 :type '(alist :key-type string :value-type function)
8191 ,@customizations)
8193 (put ',varalt-sym 'definition-name ',command)
8194 (defvar ,varimp-sym nil "Internal use only.")
8196 (defun ,command (&optional arg)
8197 ,(format "Run generic command `%s'.
8198 If used for the first time, or with interactive ARG, ask the user which
8199 implementation to use for `%s'. The variable `%s'
8200 contains the list of implementations currently supported for this command."
8201 command-name command-name varalt-name)
8202 (interactive "P")
8203 (when (or arg (null ,varimp-sym))
8204 (let ((val (completing-read
8205 ,(format "Select implementation for command `%s': "
8206 command-name)
8207 ,varalt-sym nil t)))
8208 (unless (string-equal val "")
8209 (when (null ,varimp-sym)
8210 (message
8211 "Use `C-u M-x %s RET' to select another implementation"
8212 ,command-name)
8213 (sit-for 3))
8214 (customize-save-variable ',varimp-sym
8215 (cdr (assoc-string val ,varalt-sym))))))
8216 (if ,varimp-sym
8217 (call-interactively ,varimp-sym)
8218 (message ,(format "No implementation selected for command `%s'"
8219 command-name)))))))
8221 \f
8223 (provide 'simple)
8225 ;;; simple.el ends here