| blob | 31efe3896d4d7eb068dbfeeb8c8ea53bbb5f1900 |
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."
1783 "Minibuffer history variables for which matching should ignore case.
1784 If a history variable is a member of this list, then the
1786 commands ignore case when searching it, regardless of `case-fold-search'."
1791 "Find the previous history element that matches REGEXP.
1792 \(Previous history elements refer to earlier actions.)
1793 With prefix argument N, search for Nth previous match.
1794 If N is negative, find the next or Nth next match.
1795 Normally, history elements are matched case-insensitively if
1796 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1797 makes the search case-sensitive.
1798 See also `minibuffer-history-case-insensitive-variables'."
1802 nil
1803 minibuffer-local-map
1804 nil
1805 'minibuffer-history-search-history
1807 ;; Use the last regexp specified, by default, if input is empty.
1812 regexp)
1822 ;; On some systems, ignore case for file names.
1824 minibuffer-history-case-insensitive-variables)
1825 t
1826 ;; Respect the user's setting for case-fold-search:
1827 case-fold-search)
1828 nil))
1829 prevpos
1830 match-string
1831 match-offset
1838 "No later matching history item"
1859 next-matching-history-element))
1863 "Find the next history element that matches REGEXP.
1864 \(The next history element refers to a more recent action.)
1865 With prefix argument N, search for Nth next match.
1866 If N is negative, find the previous or Nth previous match.
1867 Normally, history elements are matched case-insensitively if
1868 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1869 makes the search case-sensitive."
1873 nil
1874 minibuffer-local-map
1875 nil
1876 'minibuffer-history-search-history
1878 ;; Use the last regexp specified, by default, if input is empty.
1883 regexp)
1890 "Function run by `goto-history-element' before consuming default values.
1891 This is useful to dynamically add more elements to the list of default values
1892 when `goto-history-element' reaches the end of this list.
1893 Before calling this function `goto-history-element' sets the variable
1894 `minibuffer-default-add-done' to t, so it will call this function only
1895 once. In special cases, when this function needs to be called more
1896 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1900 "When nil, add more elements to the end of the list of default values.
1901 The value nil causes `goto-history-element' to add more elements to
1902 the list of defaults when it reaches the end of this list. It does
1908 "Return a list of all completions without the default value.
1909 This function is used to add all elements of the completion table to
1910 the end of the list of defaults just after the default value."
1913 minibuffer-completion-table
1914 minibuffer-completion-predicate)))
1920 "Puts element of the minibuffer history in the minibuffer.
1921 The argument NABS specifies the absolute history position."
1935 elt minibuffer-returned-to-present)
1942 "End of defaults; no next item"
1949 previous-history-element))
1961 minibuffer-default)))
1973 elt))
1977 "Puts next element of the minibuffer history in the minibuffer.
1978 With argument N, it uses the Nth following element."
1984 "Puts previous element of the minibuffer history in the minibuffer.
1985 With argument N, it uses the Nth previous element."
1991 "Move cursor vertically down ARG lines, or to the next history element.
1992 When point moves over the bottom line of multi-line minibuffer, puts ARGth
1993 next element of the minibuffer history in the minibuffer."
1997 ;; Remember the original goal column of possibly multi-line input
1998 ;; excluding the length of the prompt on the first line.
2008 ;; Restore old position since `line-move-visual' moves point to
2009 ;; the end of the line when it fails to go to the next line.
2012 ;; Restore the original goal column on the last line
2013 ;; of possibly multi-line input.
2021 "Move cursor vertically up ARG lines, or to the previous history element.
2022 When point moves over the top line of multi-line minibuffer, puts ARGth
2023 previous element of the minibuffer history in the minibuffer."
2027 ;; Remember the original goal column of possibly multi-line input
2028 ;; excluding the length of the prompt on the first line.
2038 ;; Restore old position since `line-move-visual' moves point to
2039 ;; the beginning of the line when it fails to go to the previous line.
2042 ;; Restore the original goal column on the first line
2043 ;; of possibly multi-line input.
2052 "Get next history element which completes the minibuffer before the point.
2053 The contents of the minibuffer after the point are deleted, and replaced
2054 by the new completion."
2060 n)
2061 ;; next-matching-history-element always puts us at (point-min).
2062 ;; Move to the position we were at before changing the buffer contents.
2063 ;; This is still sensible, because the text before point has not changed.
2067 "\
2068 Get previous history element which completes the minibuffer before the point.
2069 The contents of the minibuffer after the point are deleted, and replaced
2070 by the new completion."
2074 ;; For compatibility with the old subr of the same name.
2076 "Return the display width of the minibuffer prompt.
2077 Return 0 if current buffer is not a minibuffer."
2078 ;; Return the width of everything before the field at the end of
2079 ;; the buffer; this should be 0 for normal buffers.
2081 \f
2082 ;; isearch minibuffer history
2089 "Set up a minibuffer for using isearch to search the minibuffer history.
2090 Intended to be added to `minibuffer-setup-hook'."
2102 "Clean up the minibuffer after terminating isearch in the minibuffer."
2107 "Return the proper search function, for isearch in minibuffer history."
2110 ;; Use standard functions to search within minibuffer text
2112 found)
2113 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2114 ;; searching forward. Lazy-highlight calls this lambda with the
2115 ;; bound arg, so skip the minibuffer prompt.
2119 ;; 1. First try searching in the initial minibuffer text
2122 noerror)
2123 ;; 2. If the above search fails, start putting next/prev history
2124 ;; elements in the minibuffer successively, and search the string
2125 ;; in them. Do this only when bound is nil (i.e. not while
2126 ;; lazy-highlighting search strings in the current minibuffer text).
2138 ;; After putting the next/prev history element, search
2139 ;; the string in them again, until next-history-element
2140 ;; or previous-history-element raises an error at the
2141 ;; beginning/end of history.
2144 ;; For backward search, don't search
2145 ;; in the minibuffer prompt
2147 noerror)))
2148 ;; Return point of the new search result
2150 ;; Return nil when next(prev)-history-element fails
2154 "Display the minibuffer history search prompt.
2155 If there are no search errors, this function displays an overlay with
2156 the isearch prompt which replaces the original minibuffer prompt.
2157 Otherwise, it displays the standard isearch message returned from
2158 the function `isearch-message'."
2160 ;; Use standard function `isearch-message' when not in the minibuffer,
2161 ;; or search fails, or has an error (like incomplete regexp).
2162 ;; This function overwrites minibuffer text with isearch message,
2163 ;; so it's possible to see what is wrong in the search string.
2165 ;; Otherwise, put the overlay with the standard isearch prompt over
2166 ;; the initial minibuffer prompt.
2175 ;; And clear any previous isearch message.
2179 "Wrap the minibuffer history search when search fails.
2180 Move point to the first history element for a forward search,
2181 or to the last history element for a backward search."
2182 ;; When `minibuffer-history-isearch-search' fails on reaching the
2183 ;; beginning/end of the history, wrap the search to the first/last
2184 ;; minibuffer history element.
2192 "Save a function restoring the state of minibuffer history search.
2193 Save `minibuffer-history-position' to the additional state parameter
2194 in the search status stack."
2200 "Restore the minibuffer history search state.
2201 Go to the history element by the absolute history position HIST-POS."
2204 \f
2205 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2209 "Table mapping redo records to the corresponding undo one.
2210 A redo record for undo-in-region maps to t.
2220 "Within a run of consecutive undo commands, list remaining to be undone.
2224 "Undo some previous changes.
2225 Repeat this command to undo more changes.
2226 A numeric ARG serves as a repeat count.
2228 In Transient Mark mode when the mark is active, only undo changes within
2230 as an argument limits undo to changes within the current region."
2232 ;; Make last-command indicate for the next command that this was an undo.
2233 ;; That way, another undo will undo more.
2234 ;; If we get to the end of the undo history and get an error,
2235 ;; another undo command will find the undo history empty
2236 ;; and will get another error. To begin undoing the undos,
2237 ;; you must type some other command.
2239 ;; For an indirect buffer, look in the base buffer for the
2240 ;; auto-save data.
2244 message)
2245 ;; If we get an error in undo-start,
2246 ;; the next command should not be a "consecutive undo".
2247 ;; So set `this-command' to something other than `undo'.
2252 ;; If something (a timer or filter?) changed the buffer
2253 ;; since the previous command, don't continue the undo seq.
2257 ;; If the last undo record made was made by undo
2258 ;; it shows nothing else happened in between.
2265 ;; get rid of initial undo boundary
2267 ;; If we got this far, the next command should be a consecutive undo.
2269 ;; Check to see whether we're hitting a redo record, and if
2270 ;; so, ask the user whether she wants to skip the redo/undo pair.
2278 ;; The equiv entry might point to another redo record if we have done
2279 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2287 ;; Record the fact that the just-generated undo records come from an
2288 ;; undo operation--that is, they are redo records.
2289 ;; In the ordinary case (not within a region), map the redo
2290 ;; record to the following undos.
2291 ;; I don't know how to do that in the undo-in-region case.
2293 ;; Strip any leading undo boundaries there might be, like we do
2294 ;; above when checking.
2298 ;; Prevent identity mapping. This can happen if
2299 ;; consecutive nils are erroneously in undo list.
2301 t
2302 pending-undo-list)
2303 undo-equiv-table))
2304 ;; Don't specify a position in the undo record for the undo command.
2305 ;; Instead, undoing this should move point to where the change is.
2324 ;; Record what the current undo list says,
2325 ;; so the next command can tell if the buffer was modified in between.
2329 ;; Display a message announcing success.
2334 "Make BUFFER stop keeping undo information.
2335 No argument or nil as argument means do this for the current buffer."
2341 "Undo some previous changes.
2342 Repeat this command to undo more changes.
2343 A numeric ARG serves as a repeat count.
2344 Contrary to `undo', this will not redo a previous undo."
2349 "Non-nil while performing an undo.
2353 "Undo back N undo-boundaries beyond what was already undone recently.
2354 Call `undo-start' to get ready to undo recent changes,
2355 then call `undo-more' one or more times to undo them."
2360 ;; Note: The following, while pulling elements off
2361 ;; `pending-undo-list' will call primitive change functions which
2362 ;; will push more elements onto `buffer-undo-list'.
2368 "Undo N records from the front of the list LIST.
2369 Return what remains of the list."
2371 ;; This is a good feature, but would make undo-start
2372 ;; unable to do what is expected.
2373 ;;(when (null (car (list)))
2374 ;; ;; If the head of the list is a boundary, it is the boundary
2375 ;; ;; preceding this command. Get rid of it and don't count it.
2376 ;; (setq list (cdr list))))
2379 ;; In a writable buffer, enable undoing read-only text that is
2380 ;; so because of text properties.
2382 ;; Don't let `intangible' properties interfere with undo.
2384 ;; We use oldlist only to check for EQ. ++kfs
2390 ;; Handle an integer by setting point to that value.
2393 ;; Element (t . TIME) records previous modtime.
2394 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2395 ;; UNKNOWN_MODTIME_NSECS.
2397 ;; If this records an obsolete save
2398 ;; (not matching the actual disk file)
2399 ;; then don't mark unmodified.
2407 ;; Element (nil PROP VAL BEG . END) is property change.
2412 ;; Element (BEG . END) means range was inserted.
2414 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2415 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2418 ;; Set point first thing, so that undoing this undo
2419 ;; does not send point back to where it is now.
2422 ;; Element (apply FUN . ARGS) means call FUN to undo.
2426 ;; Long format: (apply DELTA START END FUN . ARGS).
2433 ;; Check that the function did what the entry
2434 ;; said it would do.
2444 ;; Element (STRING . POS) means STRING was deleted.
2450 ;; Check that marker adjustments which were recorded
2451 ;; with the (STRING . POS) record are still valid, ie
2452 ;; the markers haven't moved. We check their validity
2453 ;; before reinserting the string so as we don't need to
2454 ;; mind marker insertion-type.
2462 ;; Insert string and adjust point
2470 ;; Adjust the valid marker adjustments
2474 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2477 next)
2478 ;; Even though these elements are not expected in the undo
2479 ;; list, adjust them to be conservative for the 24.4
2480 ;; release. (Bug#16818)
2487 ;; Make sure an apply entry produces at least one undo entry,
2488 ;; so the test in `undo' for continuing an undo series
2489 ;; will work right.
2494 list)
2496 ;; Deep copy of a list
2498 "Make a copy of undo list LIST."
2504 elt))
2507 "Set `pending-undo-list' to the front of the undo list.
2508 The next call to `undo-more' will undo the most recently made change.
2509 If BEG and END are specified, then only undo elements
2510 that apply to text between BEG and END are used; other undo elements
2511 are ignored. If BEG and END are nil, all undo elements are used."
2517 buffer-undo-list)))
2519 ;; The positions given in elements of the undo list are the positions
2520 ;; as of the time that element was recorded to undo history. In
2521 ;; general, subsequent buffer edits render those positions invalid in
2522 ;; the current buffer, unless adjusted according to the intervening
2523 ;; undo elements.
2524 ;;
2525 ;; Undo in region is a use case that requires adjustments to undo
2526 ;; elements. It must adjust positions of elements in the region based
2527 ;; on newer elements not in the region so as they may be correctly
2528 ;; applied in the current buffer. undo-make-selective-list
2529 ;; accomplishes this with its undo-deltas list of adjustments. An
2530 ;; example undo history from oldest to newest:
2531 ;;
2532 ;; buf pos:
2533 ;; 123456789 buffer-undo-list undo-deltas
2534 ;; --------- ---------------- -----------
2535 ;; aaa (1 . 4) (1 . -3)
2536 ;; aaba (3 . 4) N/A (in region)
2537 ;; ccaaba (1 . 3) (1 . -2)
2538 ;; ccaabaddd (7 . 10) (7 . -3)
2539 ;; ccaabdd ("ad" . 6) (6 . 2)
2540 ;; ccaabaddd (6 . 8) (6 . -2)
2541 ;; | |<-- region: "caab", from 2 to 6
2542 ;;
2543 ;; When the user starts a run of undos in region,
2544 ;; undo-make-selective-list is called to create the full list of in
2545 ;; region elements. Each element is adjusted forward chronologically
2546 ;; through undo-deltas to determine if it is in the region.
2547 ;;
2548 ;; In the above example, the insertion of "b" is (3 . 4) in the
2549 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2550 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2551 ;; . 6) is assessed as in the region and placed in the selective list.
2552 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2553 ;; due to the selected element. The "b" insertion is the only element
2554 ;; fully in the region, so in this example undo-make-selective-list
2555 ;; returns (nil (5 . 6)).
2556 ;;
2557 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2558 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2559 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2560 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2561 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2562 ;;
2563 ;; More interesting is how to adjust the "ddd" insertion due to the
2564 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2565 ;; If the reinsertion was a manual retyping of "ad", then the total
2566 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2567 ;; the reinsertion was due to undo, one might expect the first "d"
2568 ;; character would again be a part of the "ddd" text, meaning its
2569 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2570 ;;
2571 ;; undo-make-selective-list assumes in this situation that "ad" was a
2572 ;; new edit, even if it was inserted because of an undo.
2573 ;; Consequently, if the user undos in region "8 to 10" of the
2574 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2575 ;; "ccaabad", as though the first "d" became detached from the
2576 ;; original "ddd" insertion. This quirk is a FIXME.
2579 "Return a list of undo elements for the region START to END.
2580 The elements come from `buffer-undo-list', but we keep only the
2581 elements inside this region, and discard those outside this
2582 region. The elements' positions are adjusted so as the returned
2583 list can be applied to the current buffer."
2585 ;; A list of position adjusted undo elements in the region.
2587 ;; A list of undo-deltas for out of region undo elements.
2588 undo-deltas
2589 undo-elt)
2597 ;; Don't put two nils together in the list
2601 ;; This is a "was unmodified" element. Keep it
2602 ;; if we have kept everything thus far.
2605 ;; Skip over marker adjustments, instead relying
2606 ;; on finding them after (TEXT . POS) elements
2608 nil)
2611 undo-deltas)))
2616 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2617 ;; kept. primitive-undo may discard them later.
2630 "Determine whether UNDO-ELT falls inside the region START ... END.
2631 If it crosses the edge, we return nil.
2633 Generally this function is not useful for determining
2634 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2635 because markers can be arbitrarily relocated. Instead, pass the
2636 marker adjustment's corresponding (TEXT . POS) element."
2641 t)
2643 nil)
2645 ;; (TEXT . POSITION)
2649 ;; (MARKER . ADJUSTMENT)
2652 ;; (nil PROPERTY VALUE BEG . END)
2657 ;; (BEGIN . END)
2662 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2663 This assumes we have already decided that UNDO-ELT
2664 is not *inside* the region START...END."
2668 ;; (nil PROPERTY VALUE BEG . END)
2673 ;; (BEGIN . END)
2678 "Return adjustment of undo element ELT by the undo DELTAS
2679 list."
2681 ;; POSITION
2684 ;; (BEG . END)
2687 ;; (TEXT . POSITION)
2691 ;; (nil PROPERTY VALUE BEG . END)
2694 ;; (apply DELTA START END FUN . ARGS)
2695 ;; FIXME
2696 ;; All others return same elt
2699 ;; (BEG . END) can adjust to the same positions, commonly when an
2700 ;; insertion was undone and they are out of region, for example:
2701 ;;
2702 ;; buf pos:
2703 ;; 123456789 buffer-undo-list undo-deltas
2704 ;; --------- ---------------- -----------
2705 ;; [...]
2706 ;; abbaa (2 . 4) (2 . -2)
2707 ;; aaa ("bb" . 2) (2 . 2)
2708 ;; [...]
2709 ;;
2710 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2711 ;; undo. Further adjustments to such an element should be the same as
2712 ;; for (TEXT . POSITION) elements. The options are:
2713 ;;
2714 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2715 ;; analogous to marker insertion-type t.
2716 ;;
2717 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2718 ;; marker insertion-type nil.
2719 ;;
2720 ;; There was no strong reason to prefer one or the other, except that
2721 ;; the first is more consistent with prior undo in region behavior.
2723 "Return cons of adjustments to BEG and END by the undo DELTAS
2724 list."
2726 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2731 "Return adjustment of POS by the undo DELTAS list, comparing
2732 with < or <= based on USE-<."
2738 ;; Don't allow pos to become less than the undo-delta
2739 ;; position. This edge case is described in the overview
2740 ;; comments.
2743 ;; Return the first affected buffer position and the delta for an undo element
2744 ;; delta is defined as the change in subsequent buffer positions if we *did*
2745 ;; the undo.
2749 ;; (TEXT . POSITION)
2752 ;; (BEGIN . END)
2759 "If non-nil ask about discarding undo info for the current command.
2760 Normally, Emacs discards the undo info for the current command if
2761 it exceeds `undo-outer-limit'. But if you set this option
2762 non-nil, it asks in the echo area whether to discard the info.
2763 If you answer no, there is a slight risk that Emacs might crash, so
2764 only do it if you really want to undo the command.
2766 This option is mainly intended for debugging. You have to be
2767 careful if you use it for other purposes. Garbage collection is
2768 inhibited while the question is asked, meaning that Emacs might
2769 leak memory. So you should make sure that you do not wait
2770 excessively long before answering the question."
2776 "If non-nil, an extra level of size that's ok in an undo item.
2777 We don't ask the user about truncating the undo list until the
2778 current item gets bigger than this amount.
2783 ;; When the first undo batch in an undo list is longer than
2784 ;; undo-outer-limit, this function gets called to warn the user that
2785 ;; the undo info for the current command was discarded. Garbage
2786 ;; collection is inhibited around the call, so it had better not do a
2787 ;; lot of consing.
2793 ;; Don't ask the question again unless it gets even bigger.
2794 ;; This applies, in particular, if the user quits from the question.
2795 ;; Such a quit quits out of GC, but something else will call GC
2796 ;; again momentarily. It will call this function again,
2797 ;; but we don't want to ask the question again.
2804 t)
2805 nil))
2810 "The undo info was discarded because it exceeded \
2811 `undo-outer-limit'.
2813 This is normal if you executed a command that made a huge change
2814 to the buffer. In that case, to prevent similar problems in the
2815 future, set `undo-outer-limit' to a value that is large enough to
2816 cover the maximum size of normal changes you expect a single
2817 command to make, but not so large that it might exceed the
2818 maximum memory allotted to Emacs.
2820 If you did not execute any such command, the situation is
2821 probably due to a bug and you should report it.
2823 You can disable the popping up of this buffer by adding the entry
2824 \(undo discard-info) to the user option `warning-suppress-types',
2828 t))
2829 \f
2832 ; These are sorted according to the GNU en_US locale.
2875 )
2877 This is used by Shell mode and other parts of Emacs to recognize
2878 password prompts, including prompts in languages other than
2879 English. Different case choices should not be assumed to be
2880 included; callers should bind `case-fold-search' to t."
2886 "History list for some commands that read shell commands.
2888 Maximum length of the history list is determined by the value
2895 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2896 This buffer is used when `shell-command' or `shell-command-on-region'
2897 is run interactively. A value of nil means that output to stderr and
2904 "Return a list of all commands associated with the current file.
2905 This function is used to add all related commands retrieved by `mailcap'
2906 to the end of the list of defaults just after the default value."
2910 minibuffer-default))
2915 commands))
2926 map)
2930 "Read a shell command from the minibuffer.
2931 The arguments are the same as the ones of `read-from-minibuffer',
2932 except READ and KEYMAP are missing and HIST defaults
2933 to `shell-command-history'."
2941 minibuffer-local-shell-command-map
2942 nil
2944 args)))
2947 "What to do when the output buffer is used by another shell command.
2948 This option specifies how to resolve the conflict where a new command
2949 wants to direct its output to the buffer `*Async Shell Command*',
2950 but this buffer is already taken by another running shell command.
2952 The value `confirm-kill-process' is used to ask for confirmation before
2953 killing the already running process and running a new process
2954 in the same buffer, `confirm-new-buffer' for confirmation before running
2955 the command in a new buffer with a name other than the default buffer name,
2956 `new-buffer' for doing the same without confirmation,
2957 `confirm-rename-buffer' for confirmation before renaming the existing
2958 output buffer and running a new command in the default buffer,
2959 `rename-buffer' for doing the same without confirmation."
2961 confirm-kill-process)
2963 confirm-new-buffer)
2965 new-buffer)
2967 confirm-rename-buffer)
2969 rename-buffer))
2974 "Execute string COMMAND asynchronously in background.
2976 Like `shell-command', but adds `&' at the end of COMMAND
2977 to execute it asynchronously.
2979 The output appears in the buffer `*Async Shell Command*'.
2980 That buffer is in shell mode.
2982 You can configure `async-shell-command-buffer' to specify what to do in
2983 case when `*Async Shell Command*' buffer is already taken by another
2984 running shell command. To run COMMAND without displaying the output
2985 in a window you can configure `display-buffer-alist' to use the action
2986 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
2988 In Elisp, you will often be better served by calling `start-process'
2989 directly, since it offers more control and does not impose the use of a
2990 shell (with its need to quote arguments)."
3000 current-prefix-arg
3001 shell-command-default-error-buffer))
3007 "Execute string COMMAND in inferior shell; display output, if any.
3008 With prefix argument, insert the COMMAND's output at point.
3010 If COMMAND ends in `&', execute it asynchronously.
3011 The output appears in the buffer `*Async Shell Command*'.
3012 That buffer is in shell mode. You can also use
3013 `async-shell-command' that automatically adds `&'.
3015 Otherwise, COMMAND is executed synchronously. The output appears in
3016 the buffer `*Shell Command Output*'. If the output is short enough to
3017 display in the echo area (which is determined by the variables
3018 `resize-mini-windows' and `max-mini-window-height'), it is shown
3019 there, but it is nonetheless available in buffer `*Shell Command
3020 Output*' even though that buffer is not automatically displayed.
3022 To specify a coding system for converting non-ASCII characters
3024 before this command.
3026 Noninteractive callers can specify coding systems by binding
3027 `coding-system-for-read' and `coding-system-for-write'.
3029 The optional second argument OUTPUT-BUFFER, if non-nil,
3030 says to put the output in some other buffer.
3031 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
3032 If OUTPUT-BUFFER is not a buffer and not nil,
3033 insert output in current buffer. (This cannot be done asynchronously.)
3034 In either case, the buffer is first erased, and the output is
3035 inserted after point (leaving mark after it).
3037 If the command terminates without error, but generates output,
3039 the output can be displayed in the echo area or in its buffer.
3040 If the output is short enough to display in the echo area
3041 \(determined by the variable `max-mini-window-height' if
3042 `resize-mini-windows' is non-nil), it is shown there.
3043 Otherwise,the buffer containing the output is displayed.
3047 of the output.
3049 If there is no output, or if output is inserted in the current buffer,
3050 then `*Shell Command Output*' is deleted.
3052 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3053 or buffer name to which to direct the command's standard error output.
3054 If it is nil, error output is mingled with regular output.
3055 In an interactive call, the variable `shell-command-default-error-buffer'
3056 specifies the value of ERROR-BUFFER.
3058 In Elisp, you will often be better served by calling `call-process' or
3059 `start-process' directly, since it offers more control and does not impose
3060 the use of a shell (with its need to quote arguments)."
3071 current-prefix-arg
3072 shell-command-default-error-buffer))
3073 ;; Look for a handler in case default-directory is a remote file name.
3081 ;; Output goes in current buffer.
3087 temporary-file-directory)))
3088 nil)))
3091 ;; We do not use -f for csh; we will not support broken use of
3092 ;; .cshrcs. Even the BSD csh manual says to use
3093 ;; "if ($?prompt) exit" before things which are not useful
3094 ;; non-interactively. Besides, if someone wants their other
3095 ;; aliases for shell commands then they can still have them.
3099 t)
3100 nil shell-command-switch command)
3107 ;; Do no formatting while reading error file,
3108 ;; because that can run a shell command, and we
3109 ;; don't want that to cause an infinite recursion.
3111 ;; Put point after the inserted errors.
3115 ;; This is like exchange-point-and-mark, but doesn't
3116 ;; activate the mark. It is cleaner to avoid activation,
3117 ;; even though the command loop would deactivate the mark
3118 ;; because we inserted text.
3122 ;; Output goes in a separate buffer.
3123 ;; Preserve the match data in case called from a program.
3126 ;; Command ending with ampersand means asynchronous.
3130 proc)
3131 ;; Remove the ampersand.
3133 ;; Ask the user what to do with already running process.
3138 ;; If will kill a process, query first.
3143 ;; If will create a new buffer, query first.
3150 ;; It will create a new buffer.
3155 ;; If will rename the buffer, query first.
3164 ;; It will rename the buffer.
3171 ;; Setting buffer-read-only to nil doesn't suffice
3172 ;; if some text has a non-nil read-only property,
3173 ;; which comint sometimes adds for prompts.
3179 shell-command-switch command))
3183 ;; Use the comint filter for proper handling of carriage motion
3184 ;; (see `comint-inhibit-carriage-motion'),.
3186 ))
3187 ;; Otherwise, command is executed synchronously.
3189 output-buffer nil error-buffer)))))))
3193 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3194 MESSAGE may be either a string or a buffer.
3196 A buffer is displayed using `display-buffer' if MESSAGE is too long for
3197 the maximum height of the echo area, as defined by `max-mini-window-height'
3198 if `resize-mini-windows' is non-nil.
3200 Returns either the string shown in the echo area, or when a pop-up
3201 buffer is used, the window used to display it.
3203 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3204 name of the buffer used to display it in the case where a pop-up buffer
3205 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3206 string and it is displayed in the echo area, it is not specified whether
3207 the contents are inserted into the buffer anyway.
3209 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
3210 and only used if a buffer is displayed."
3212 ;; Trivial case where we can use the echo area
3216 ;; Trivial case where we can just remove single trailing newline
3219 ;; General case
3222 message
3231 0
3235 (<= lines
3239 max-mini-window-height))
3241 max-mini-window-height)
3245 ;; Don't use the echo area if the output buffer is
3246 ;; already displayed in the selected frame.
3248 ;; Echo area
3254 ;; Buffer
3257 not-this-window frame))))))))
3260 ;; We have a sentinel to prevent insertion of a termination message
3261 ;; in the buffer itself.
3269 &optional output-buffer replace
3270 error-buffer display-error-buffer)
3271 "Execute string COMMAND in inferior shell with region as input.
3272 Normally display output (if any) in temp buffer `*Shell Command Output*';
3273 Prefix arg means replace the region with it. Return the exit code of
3274 COMMAND.
3276 To specify a coding system for converting non-ASCII characters
3278 before this command. By default, the input (from the current buffer)
3279 is encoded using coding-system specified by `process-coding-system-alist',
3280 falling back to `default-process-coding-system' if no match for COMMAND
3281 is found in `process-coding-system-alist'.
3283 Noninteractive callers can specify coding systems by binding
3284 `coding-system-for-read' and `coding-system-for-write'.
3286 If the command generates output, the output may be displayed
3287 in the echo area or in a buffer.
3288 If the output is short enough to display in the echo area
3289 \(determined by the variable `max-mini-window-height' if
3290 `resize-mini-windows' is non-nil), it is shown there.
3291 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3292 The output is available in that buffer in both cases.
3294 If there is output and an error, a message about the error
3295 appears at the end of the output. If there is no output, or if
3296 output is inserted in the current buffer, the buffer `*Shell
3297 Command Output*' is deleted.
3299 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3300 command's output. If the value is a buffer or buffer name,
3301 put the output there. If the value is nil, use the buffer
3302 `*Shell Command Output*'. Any other value, excluding nil,
3303 means to insert the output in the current buffer. In either case,
3304 the output is inserted after point (leaving mark after it).
3306 Optional fifth arg REPLACE, if non-nil, means to insert the
3307 output in place of text from START to END, putting point and mark
3308 around it.
3310 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3311 or buffer name to which to direct the command's standard error
3312 output. If nil, error output is mingled with regular output.
3313 When called interactively, `shell-command-default-error-buffer'
3314 is used for ERROR-BUFFER.
3316 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3317 display the error buffer if there were any errors. When called
3318 interactively, this is t."
3322 ;; Do this before calling region-beginning
3323 ;; and region-end, in case subprocess output
3324 ;; relocates them while we are in the minibuffer.
3326 ;; call-interactively recognizes region-beginning and
3327 ;; region-end specially, leaving them in the history.
3329 string
3330 current-prefix-arg
3331 current-prefix-arg
3332 shell-command-default-error-buffer
3333 t)))
3339 temporary-file-directory)))
3340 nil))
3341 exit-status)
3345 ;; Replace specified region with output from command.
3347 ;; Don't muck with mark unless REPLACE says we should.
3354 t)
3355 nil shell-command-switch command))
3356 ;; It is rude to delete a buffer which the command is not using.
3357 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3358 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3359 ;; (kill-buffer shell-buffer)))
3360 ;; Don't muck with mark unless REPLACE says we should.
3362 ;; No prefix argument: put the output in a temp buffer,
3363 ;; replacing its entire contents.
3368 ;; If the input is the same buffer as the output,
3369 ;; delete everything but the specified region,
3370 ;; then replace that region with the output.
3376 shell-file-name t
3379 t)
3380 nil shell-command-switch
3381 command)))
3382 ;; Clear the output buffer, then run the command with
3383 ;; output there.
3394 buffer)
3395 nil shell-command-switch command)))
3396 ;; Report the output.
3406 ;; There's some output, display it
3408 ;; No output; error?
3415 shell-command-default-error-buffer)
3422 output))
3425 exit-status))
3428 exit-status output))))
3429 ;; Don't kill: there might be useful info in the undo-log.
3430 ;; (kill-buffer buffer)
3431 ))))
3439 ;; Do no formatting while reading error file,
3440 ;; because that can run a shell command, and we
3441 ;; don't want that to cause an infinite recursion.
3443 ;; Put point after the inserted errors.
3448 exit-status))
3451 "Execute shell command COMMAND and return its output as a string."
3454 standard-output
3458 "Process files synchronously in a separate process.
3459 Similar to `call-process', but may invoke a file handler based on
3460 `default-directory'. The current working directory of the
3461 subprocess is `default-directory'.
3463 File names in INFILE and BUFFER are handled normally, but file
3464 names in ARGS should be relative to `default-directory', as they
3465 are passed to the process verbatim. (This is a difference to
3466 `call-process' which does not support file handlers for INFILE
3467 and BUFFER.)
3469 Some file handlers might not support all variants, for example
3470 they might behave as if DISPLAY was nil, regardless of the actual
3471 value passed."
3473 lc stderr-file)
3483 display args)
3489 "Whether a call of `process-file' changes remote files.
3491 By default, this variable is always set to `t', meaning that a
3492 call of `process-file' could potentially change any file on a
3493 remote host. When set to `nil', a file handler could optimize
3494 its behavior with respect to remote file attribute caching.
3496 You should only ever change this variable with a let-binding;
3500 "Start a program in a subprocess. Return the process object for it.
3502 Similar to `start-process', but may invoke a file handler based on
3503 `default-directory'. See Info node `(elisp)Magic File Names'.
3505 This handler ought to run PROGRAM, perhaps on the local host,
3506 perhaps on a remote host that corresponds to `default-directory'.
3507 In the latter case, the local part of `default-directory' becomes
3508 the working directory of the process.
3510 PROGRAM and PROGRAM-ARGS might be file names. They are not
3511 objects of file handler invocation. File handlers might not
3512 support pty association, if PROGRAM is nil."
3516 \f
3517 ;;;; Process menu
3531 map))
3534 "Major mode for listing the processes called by Emacs."
3546 "Kill process at point in a `list-processes' buffer."
3552 "Recompute the list of processes for the Process List buffer.
3553 Also, delete any process that is exited or signaled."
3566 face link
3569 follow-link t
3570 process-buffer ,buf
3571 action process-menu-visit-buffer)
3580 "datagram"
3597 tabulated-list-entries))))))
3603 "Display a list of all processes that are Emacs sub-processes.
3604 If optional argument QUERY-ONLY is non-nil, only processes with
3605 the query-on-exit flag set are listed.
3606 Any process listed as exited or signaled is actually eliminated
3607 after the listing is made.
3608 Optional argument BUFFER specifies a buffer to use, instead of
3610 The return value is always nil.
3612 This function lists only processes that were launched by Emacs. To
3613 see other processes running on the system, use `list-system-processes'."
3625 nil)
3626 \f
3630 ;; For backward compatibility, minus with no modifiers is an ordinary
3631 ;; command if digits have already been entered.
3661 map)
3668 "Begin a numeric argument for the following command.
3673 multiplies the argument by 4 each time.
3675 which is different in effect from any particular numeric argument.
3682 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3683 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3689 arg)))
3693 "Begin a negative numeric argument for the next command.
3702 "Part of the numeric argument for the next command.
3706 last-command-event
3713 ;; Treat -0 as just -, so that -01 will work.
3716 digit))))
3718 \f
3726 "Function to perform the filtering in `filter-buffer-substring'.
3727 The function is called with the same 3 arguments (BEG END DELETE)
3728 that `filter-buffer-substring' received. It should return the
3729 buffer substring between BEG and END, after filtering. If DELETE is
3733 "List of filter functions for `buffer-substring--filter'.
3734 Each function must accept a single argument, a string, and return a string.
3735 The buffer substring is passed to the first function in the list,
3736 and the return value of each function is passed to the next.
3737 As a special convention, point is set to the start of the buffer text
3738 being operated on (i.e., the first argument of `buffer-substring--filter')
3744 "Return the buffer substring between BEG and END, after filtering.
3745 If DELETE is non-nil, delete the text between BEG and END from the buffer.
3747 This calls the function that `filter-buffer-substring-function' specifies
3748 \(passing the same three arguments that it received) to do the work,
3749 and returns whatever it does. The default function does no filtering,
3750 unless a hook has been set.
3752 Use `filter-buffer-substring' instead of `buffer-substring',
3753 `buffer-substring-no-properties', or `delete-and-extract-region' when
3754 you want to allow filtering to take place. For example, major or minor
3755 modes can use `filter-buffer-substring-function' to extract characters
3756 that are special to a buffer, and should not be copied into other buffers."
3760 "Default function to use for `filter-buffer-substring-function'.
3761 Its arguments and return value are as specified for `filter-buffer-substring'.
3762 This respects the wrapper hook `filter-buffer-substring-functions',
3763 and the abnormal hook `buffer-substring-filters'.
3764 No filtering is done unless a hook says to."
3774 string)))
3779 ;;;; Window system cut and paste hooks.
3782 "Function to call to make a killed region available to other programs.
3783 Most window systems provide a facility for cutting and pasting
3784 text between different programs, such as the clipboard on X and
3785 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3787 This variable holds a function that Emacs calls whenever text is
3788 put in the kill ring, to make the new kill available to other
3789 programs. The function takes one argument, TEXT, which is a
3793 "Function to call to get text cut from other programs.
3794 Most window systems provide a facility for cutting and pasting
3795 text between different programs, such as the clipboard on X and
3796 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3798 This variable holds a function that Emacs calls to obtain text
3799 that other programs have provided for pasting. The function is
3800 called with no arguments. If no other program has provided text
3801 to paste, the function should return nil (in which case the
3802 caller, usually `current-kill', should use the top of the Emacs
3803 kill ring). If another program has provided text to paste, the
3804 function should return that text as a string (in which case the
3805 caller should put this string in the kill ring as the latest
3806 kill).
3808 The function may also return a list of strings if the window
3809 system supports multiple selections. The first string will be
3810 used as the pasted text, but the other will be placed in the kill
3811 ring for easy access via `yank-pop'.
3813 Note that the function should return a string only if a program
3814 other than Emacs has provided a string for pasting; if Emacs
3815 provided the most recent string, the function should return nil.
3816 If it is difficult to tell whether Emacs or some other program
3817 provided the current string, it is probably good enough to return
3818 nil if the string is equal (according to `string=') to the last
3820 \f
3823 ;;;; The kill ring data structure.
3826 "List of killed text sequences.
3827 Since the kill ring is supposed to interact nicely with cut-and-paste
3828 facilities offered by window systems, use of this variable should
3829 interact nicely with `interprogram-cut-function' and
3830 `interprogram-paste-function'. The functions `kill-new',
3831 `kill-append', and `current-kill' are supposed to implement this
3832 interaction; you may want to use them instead of manipulating the kill
3836 "Maximum length of kill ring before oldest elements are thrown away."
3844 "Save clipboard strings into kill ring before replacing them.
3845 When one selects something in another program to paste it into Emacs,
3846 but kills something in Emacs before actually pasting it,
3847 this selection is gone unless this variable is non-nil,
3848 in which case the other program's selection is saved in the `kill-ring'
3855 "Do not add a new string to `kill-ring' if it duplicates the last one.
3856 The comparison is done using `equal-including-properties'."
3862 "Make STRING the latest kill in the kill ring.
3863 Set `kill-ring-yank-pointer' to point to it.
3864 If `interprogram-cut-function' is non-nil, apply it to STRING.
3865 Optional second argument REPLACE non-nil means that STRING will replace
3866 the front of the kill ring, rather than being added to the list.
3868 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3869 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3870 STRING.
3872 When the yank handler has a non-nil PARAM element, the original STRING
3873 argument is not used by `insert-for-yank'. However, since Lisp code
3874 may access and use elements from the kill ring directly, the STRING
3877 ;; Due to text properties such as 'yank-handler that
3878 ;; can alter the contents to yank, comparison using
3879 ;; `equal' is unsafe.
3904 ;; It has been argued that this should work similar to `self-insert-command'
3905 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
3907 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
3913 "Append STRING to the end of the latest kill in the kill ring.
3914 If BEFORE-P is non-nil, prepend STRING to the kill.
3915 Also removes the last undo boundary in the current buffer,
3916 depending on `kill-append-merge-undo'.
3917 If `interprogram-cut-function' is set, pass the resulting kill to it."
3925 ;; find the next undo boundary
3929 ;; remove this undo boundary
3934 "Whether rotating the kill ring changes the window system selection.
3935 If non-nil, whenever the kill ring is rotated (usually via the
3936 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3937 to copy the new kill to the window system selection."
3943 "Rotate the yanking point by N places, and then return that kill.
3944 If N is zero and `interprogram-paste-function' is set to a
3945 function that returns a string or a list of strings, and if that
3946 function doesn't return nil, then that string (or list) is added
3947 to the front of the kill ring and the string (or first string in
3948 the list) is returned as the latest kill.
3950 If N is not zero, and if `yank-pop-change-selection' is
3951 non-nil, use `interprogram-cut-function' to transfer the
3952 kill at the new yank point into the window system selection.
3954 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3955 move the yanking point; just return the Nth kill forward."
3958 interprogram-paste-function
3962 ;; Disable the interprogram cut function when we add the new
3963 ;; text to the kill ring, so Emacs doesn't try to own the
3964 ;; selection, with identical text.
3974 kill-ring)))
3979 interprogram-cut-function)
3985 ;;;; Commands for manipulating the kill ring.
3988 "Non-nil means don't signal an error for killing read-only text."
3994 This deletes the text from the buffer and saves it in the kill ring.
3998 If you want to append the killed region to the last killed text,
4001 If the buffer is read-only, Emacs will beep and refrain from deleting
4002 the text, but put the text in the kill ring anyway. This means that
4003 you can use the killing commands to copy text from a read-only buffer.
4005 Lisp programs should use this function for killing text.
4006 (To delete text, use `delete-region'.)
4007 Supply two arguments, character positions indicating the stretch of text
4008 to be killed.
4010 If the previous command was also a kill command,
4011 the text killed this time appends to the text killed last time
4012 to make one entry in the kill ring.
4014 The optional argument REGION if non-nil, indicates that we're not just killing
4015 some text between BEG and END, but we're killing the region."
4016 ;; Pass mark first, then point, because the order matters when
4017 ;; calling `kill-append'.
4026 ;; Add that string to the kill ring, one way or another.
4033 nil)
4035 ;; The code above failed because the buffer, or some of the characters
4036 ;; in the region, are read-only.
4037 ;; We should beep, in case the user just isn't aware of this.
4038 ;; However, there's no harm in putting
4039 ;; the region's text in the kill ring, anyway.
4041 ;; Set this-command now, so it will be set even if we get an error.
4043 ;; This should barf, if appropriate, and give us the correct error.
4046 ;; Signal an error if the buffer is read-only.
4048 ;; If the buffer isn't read-only, the text is.
4051 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4052 ;; to get two copies of the text when the user accidentally types M-w and
4053 ;; then corrects it with the intended C-w.
4055 "Save the region as if killed, but don't kill it.
4056 In Transient Mark mode, deactivate the mark.
4057 If `interprogram-cut-function' is non-nil, also save the text for a window
4058 system cut and paste.
4060 The optional argument REGION if non-nil, indicates that we're not just copying
4061 some text between BEG and END, but we're copying the region.
4063 This command's old key binding has been given to `kill-ring-save'."
4064 ;; Pass mark first, then point, because the order matters when
4065 ;; calling `kill-append'.
4075 nil)
4078 "Save the region as if killed, but don't kill it.
4079 In Transient Mark mode, deactivate the mark.
4080 If `interprogram-cut-function' is non-nil, also save the text for a window
4081 system cut and paste.
4083 If you want to append the killed line to the last killed text,
4086 The optional argument REGION if non-nil, indicates that we're not just copying
4087 some text between BEG and END, but we're copying the region.
4089 This command is similar to `copy-region-as-kill', except that it gives
4090 visual feedback indicating the extent of the region being copied."
4091 ;; Pass mark first, then point, because the order matters when
4092 ;; calling `kill-append'.
4096 ;; This use of called-interactively-p is correct because the code it
4097 ;; controls just gives the user visual feedback.
4102 "Indicate that the region text has been copied interactively.
4103 If the mark is visible in the selected window, blink the cursor
4104 between point and mark if there is currently no active region
4105 highlighting.
4107 If the mark lies outside the selected window, display an
4108 informative message containing a sample of the copied text. The
4109 optional argument MESSAGE-LEN, if non-nil, specifies the length
4110 of this sample text; it defaults to 40."
4113 ;; Inhibit quitting so we can make a quit here
4114 ;; look like a C-g typed as a command.
4117 ;; Swap point-and-mark quickly so as to show the region that
4118 ;; was selected. Don't do it if the region is highlighted.
4121 ;; Swap point and mark.
4125 ;; Swap back.
4128 ;; If user quit, deactivate the mark
4129 ;; as C-g would as a command.
4135 ;; Don't say "killed"; that is misleading.
4142 "Cause following command, if it kills, to add to previous kill.
4143 If the next command kills forward from point, the kill is
4144 appended to the previous killed text. If the command kills
4145 backward, the kill is prepended. Kill commands that act on the
4146 region, such as `kill-region', are regarded as killing forward if
4147 point is after mark, and killing backward if point is before
4148 mark.
4150 If the next command is not a kill command, `append-next-kill' has
4151 no effect.
4153 The argument is used for internal purposes; do not supply one."
4155 ;; We don't use (interactive-p), since that breaks kbd macros.
4169 "A subroutine of `squeeze-bidi-context'.
4170 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4174 lim1)
4181 ;; L and R categories include embedding and
4182 ;; override controls, but we don't want to
4183 ;; replace them, because that might change
4184 ;; the visual order. Likewise with PDF and
4185 ;; isolate controls.
4187 bidi-directional-non-controls-chars
4188 limit)))))
4189 ;; Replace any run of non-RTL characters by a single LRM.
4191 ;; No more characters of CATEGORY, we are done.
4196 ;; Skip directional controls, if any.
4201 "Replace characters between FROM and TO while keeping bidi context.
4203 This function replaces the region of text with as few characters
4204 as possible, while preserving the effect that region will have on
4205 bidirectional display before and after the region."
4209 ;; This is for when they copy text with read-only text
4210 ;; properties.
4214 ;; Replace each run of non-RTL characters with a single LRM.
4216 ;; Replace each run of non-LTR characters with a single RLM. Note
4217 ;; that the \cR category includes both the Arabic Letter (AL) and
4218 ;; R characters; here we ignore the distinction between them,
4219 ;; because that distinction only affects Arabic Number (AN)
4220 ;; characters, which are weak and don't affect the reordering.
4224 "Return buffer text between START and END with its bidi context.
4226 START and END are assumed to belong to the same physical line
4227 of buffer text. This function prepends and appends to the text
4228 between START and END bidi control characters that preserve the
4229 visual order of that text when it is inserted at some other place."
4234 substr para-dir from to)
4241 ;; If we don't have any mixed directional characters in the
4242 ;; entire line, we can just copy the substring without adding
4243 ;; any context.
4258 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4259 ;; (1) force the string to have the same base embedding
4260 ;; direction as the paragraph direction at the source, no matter
4261 ;; what is the paragraph direction at destination; and (2) avoid
4262 ;; affecting the visual order of the surrounding text at
4263 ;; destination if there are characters of different
4264 ;; directionality there.
4269 "Return portion of current buffer between START and END with bidi context.
4271 This function works similar to `buffer-substring', but it prepends and
4272 appends to the text bidi directional control characters necessary to
4273 preserve the visual appearance of the text if it is inserted at another
4274 place. This is useful when the buffer substring includes bidirectional
4275 text and control characters that cause non-trivial reordering on display.
4276 If copied verbatim, such text can have a very different visual appearance,
4277 and can also change the visual appearance of the surrounding text at the
4278 destination of the copy.
4280 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4281 the text properties."
4294 no-properties)))
4298 substr)))
4299 \f
4300 ;; Yanking.
4305 "List of special text property handling conditions for yanking.
4306 Each element should have the form (PROP . FUN), where PROP is a
4307 property symbol and FUN is a function. When the `yank' command
4308 inserts text into the buffer, it scans the inserted text for
4309 stretches of text that have `eq' values of the text property
4310 PROP; for each such stretch of text, FUN is called with three
4311 arguments: the property's value in that text, and the start and
4312 end positions of the text.
4314 This is done prior to removing the properties specified by
4315 `yank-excluded-properties'."
4318 function))
4321 ;; This is actually used in subr.el but defcustom does not work there.
4324 intangible invisible keymap local-map mouse-face read-only
4325 yank-handler)
4326 "Text properties to discard when yanking.
4327 The value should be a list of text properties to discard or t,
4328 which means to discard all text properties.
4330 See also `yank-handled-properties'."
4337 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4338 Function is called with two parameters, START and END corresponding to
4339 the value of the mark and point; it is guaranteed that START <= END.
4343 "Replace just-yanked stretch of killed text with a different stretch.
4344 This command is allowed only immediately after a `yank' or a `yank-pop'.
4345 At such a time, the region contains a stretch of reinserted
4346 previously-killed text. `yank-pop' deletes that text and inserts in its
4347 place a different stretch of killed text.
4349 With no argument, the previous kill is inserted.
4350 With argument N, insert the Nth previous kill.
4351 If N is negative, this is a more recent kill.
4353 The sequence of kills wraps around, so that after the oldest one
4354 comes the newest one.
4356 When this command inserts killed text into the buffer, it honors
4357 `yank-excluded-properties' and `yank-handler' as described in the
4358 doc string for `insert-for-yank-1', which see."
4372 ;; Set the window start back where it was in the yank command,
4373 ;; if possible.
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 nil)
4385 More precisely, reinsert the most recent kill, which is the
4386 stretch of killed text most recently killed OR yanked. Put point
4387 at the end, and set mark at the beginning without activating it.
4389 With argument N, reinsert the Nth most recent kill.
4391 When this command inserts text into the buffer, it honors the
4392 `yank-handled-properties' and `yank-excluded-properties'
4393 variables, and the `yank-handler' text property. See
4394 `insert-for-yank-1' for details.
4399 ;; If we don't get all the way thru, make last-command indicate that
4400 ;; for the following command.
4408 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4409 ;; It is cleaner to avoid activation, even though the command
4410 ;; loop would deactivate the mark because we inserted text.
4413 ;; If we do get all the way thru, make this-command indicate that.
4416 nil)
4419 "Rotate the yanking point in the kill ring.
4420 With ARG, rotate that many kills forward (or backward, if negative)."
4423 \f
4424 ;; Some kill commands.
4426 ;; Internal subroutine of delete-char
4432 ;; Internal subroutine of backward-delete-char
4439 "The method for untabifying when deleting backward.
4440 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4441 `hungry' -- delete all whitespace, both tabs and spaces;
4442 `all' -- delete all whitespace, including tabs, spaces and newlines;
4443 nil -- just delete one character."
4449 "Delete characters backward, changing tabs into spaces.
4450 The exact behavior depends on `backward-delete-char-untabify-method'.
4451 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4452 Interactively, ARG is the prefix arg (default 1)
4453 and KILLP is t if a prefix arg was specified."
4476 arg)))
4477 ;; Avoid warning about delete-backward-char
4481 "Kill up to and including ARGth occurrence of CHAR.
4482 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4483 Goes backward if ARG is negative; error if CHAR not found."
4486 ;; Avoid "obsolete" warnings for translation-table-for-input.
4494 ;; kill-line and its subroutines.
4497 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4502 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4503 With prefix argument ARG, kill that many lines from point.
4504 Negative arguments kill lines backward.
4505 With zero argument, kills the text before point on the current line.
4508 a number counts as a prefix arg.
4510 To kill a whole line, when point is not at the beginning, type \
4513 If `show-trailing-whitespace' is non-nil, this command will just
4514 kill the rest of the current line, even if there are only
4515 nonblanks there.
4517 If option `kill-whole-line' is non-nil, then this command kills the whole line
4518 including its terminating newline, when used at the beginning of a line
4519 with no argument. As a consequence, you can always kill a whole line
4522 If you want to append the killed line to the last killed text,
4525 If the buffer is read-only, Emacs will beep and refrain from deleting
4526 the line, but put the line in the kill ring anyway. This means that
4527 you can use this command to copy text from a read-only buffer.
4528 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4529 even beep.)"
4532 ;; It is better to move point to the other end of the kill
4533 ;; before killing. That way, in a read-only buffer, point
4534 ;; moves across the text that is copied to the kill ring.
4535 ;; The choice has no effect on undo now that undo records
4536 ;; the value of point from before the command was run.
4546 ;; If trailing whitespace is visible,
4547 ;; don't treat it as nothing.
4557 "Kill current line.
4558 With prefix ARG, kill that many lines starting from the current line.
4559 If ARG is negative, kill backward. Also kill the preceding newline.
4561 If ARG is zero, kill current line but exclude the trailing newline."
4572 ;; We need to kill in two steps, because the previous command
4573 ;; could have been a kill command, in which case the text
4574 ;; before point needs to be prepended to the current kill
4575 ;; ring entry and the text after point appended. Also, we
4576 ;; need to use save-excursion to avoid copying the same text
4577 ;; twice to the kill ring in read-only buffers.
4595 "Move forward by ARG lines, ignoring currently invisible newlines only.
4596 If ARG is negative, move backward -ARG lines.
4597 If ARG is zero, move to the beginning of the current line."
4604 ;; If the newline we just skipped is invisible,
4605 ;; don't count it.
4609 prop
4614 ;; If invisible text follows, and it is a number of complete lines,
4615 ;; skip it.
4621 prop
4637 ;; If the newline we just moved to is invisible,
4638 ;; don't count it.
4643 prop
4648 ;; If invisible text follows, and it is a number of complete lines,
4649 ;; skip it.
4655 prop
4666 nil)))
4669 "Move to end of current visible line."
4671 ;; If the following character is currently invisible,
4672 ;; skip all characters with that same `invisible' property value,
4673 ;; then find the next newline.
4680 prop
4689 \f
4691 "Insert after point the contents of BUFFER.
4692 Puts mark after the inserted text.
4693 BUFFER may be a buffer or a buffer name."
4703 t))))
4708 nil)
4711 "Append to specified buffer the text of the region.
4712 It is inserted into that buffer before its point.
4714 When calling from a program, give three arguments:
4715 BUFFER (or buffer name), START and END.
4716 START and END specify the portion of the current buffer to be copied."
4723 point)
4734 "Prepend to specified buffer the text of the region.
4735 It is inserted into that buffer after its point.
4737 When calling from a program, give three arguments:
4738 BUFFER (or buffer name), START and END.
4739 START and END specify the portion of the current buffer to be copied."
4748 "Copy to specified buffer the text of the region.
4749 It is inserted into that buffer, replacing existing text there.
4751 When calling from a program, give three arguments:
4752 BUFFER (or buffer name), START and END.
4753 START and END specify the portion of the current buffer to be copied."
4761 \f
4765 "Hook run when the mark becomes active.
4766 It is also run at the end of a command, if the mark is active and
4773 "Return this buffer's mark value as integer, or nil if never set.
4775 In Transient Mark mode, this function signals an error if
4776 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4777 or the argument FORCE is non-nil, it disregards whether the mark
4778 is active, and returns an integer or nil in the usual way.
4780 If you are using this in an editing command, you are most likely making
4781 a mistake; see the documentation of `set-mark'."
4786 ;; Behind display-selections-p.
4789 "Deactivate the mark.
4790 If Transient Mark mode is disabled, this function normally does
4791 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4793 Deactivating the mark sets `mark-active' to nil, updates the
4794 primary selection according to `select-active-regions', and runs
4795 `deactivate-mark-hook'.
4797 If Transient Mark mode was temporarily enabled, reset the value
4798 of the variable `transient-mark-mode'; if this causes Transient
4799 Mark mode to be disabled, don't change `mark-active' to nil or
4800 run `deactivate-mark-hook'."
4804 select-active-regions)
4807 ;; The var `saved-region-selection', if non-nil, is the text in
4808 ;; the region prior to the last command modifying the buffer.
4809 ;; Set the selection to that, or to the current region.
4814 ;; If another program has acquired the selection, region
4815 ;; deactivation should not clobber it (Bug#11772).
4834 "Activate the mark.
4835 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
4845 "Set this buffer's mark to POS. Don't use this function!
4846 That is to say, don't use this function unless you want
4847 the user to see that the mark has moved, and you want the previous
4848 mark position to be lost.
4850 Normally, when a new mark is set, the old one should go on the stack.
4851 This is why most applications should use `push-mark', not `set-mark'.
4853 Novice Emacs Lisp programmers often try to use the mark for the wrong
4854 purposes. The mark saves a location for the user's convenience.
4855 Most editing commands should not alter the mark.
4856 To remember a location for internal use in the Lisp program,
4857 store it in a Lisp variable. Example:
4859 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4864 ;; Normally we never clear mark-active except in Transient Mark mode.
4865 ;; But when we actually clear out the mark value too, we must
4866 ;; clear mark-active in any mode.
4868 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
4869 ;; it should never be nil if the mark is nil.
4875 If nil, region-aware commands treat empty regions as inactive.
4876 If non-nil, region-aware commands treat the region as active as
4877 long as the mark is active, even if the region is empty.
4879 Region-aware commands are those that act on the region if it is
4880 active and Transient Mark mode is enabled, and on the text near
4881 point otherwise."
4887 "Return t if the region is active and it is appropriate to act on it.
4888 This is used by commands that act specially on the region under
4889 Transient Mark mode.
4891 The return value is t if Transient Mark mode is enabled and the
4892 mark is active; furthermore, if `use-empty-active-region' is nil,
4893 the region must not be empty. Otherwise, the return value is nil.
4895 For some commands, it may be appropriate to ignore the value of
4896 `use-empty-active-region'; in that case, use `region-active-p'."
4901 "Return non-nil if Transient Mark mode is enabled and the mark is active.
4903 Some commands act specially on the region when Transient Mark
4904 mode is enabled. Usually, such commands should use
4905 `use-region-p' instead of this function, because `use-region-p'
4906 also checks the value of `use-empty-active-region'."
4908 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
4909 ;; without the mark being set (e.g. bug#17324). We really should fix
4910 ;; that problem, but in the mean time, let's make sure we don't say the
4911 ;; region is active when there's no mark.
4925 ;; Normal priority so that a large region doesn't hide all the
4926 ;; overlays within it, but high secondary priority so that if it
4927 ;; ends/starts in the middle of a small overlay, that small overlay
4928 ;; won't hide the region's boundaries.
4930 nrol)
4935 rol)))
4951 start end window rol)))
4954 new))))))
4957 "Hook run just before redisplay.
4958 It is called in each window that is to be redisplayed. It takes one argument,
4959 which is the window that will be redisplayed. When run, the `current-buffer'
4980 "Maximum size of mark ring. Start discarding off end if gets this big."
4988 "Maximum size of global mark ring. \
4989 Start discarding off end if gets this big."
4994 "Jump to mark, and pop a new position for mark off the ring.
4995 \(Does not affect global mark ring)."
5005 "Set mark at where point is.
5006 If no prefix ARG and mark is already set there, just activate it.
5007 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5019 will pop the mark twice, and
5021 will pop the mark three times.
5029 "Set the mark where point is, or jump to the mark.
5030 Setting the mark also alters the region, which is the text
5031 between point and mark; this is the closest equivalent in
5034 With no prefix argument, set the mark at point, and push the
5035 old mark position on local mark ring. Also push the old mark on
5036 global mark ring, if the previous mark was set in another buffer.
5038 When Transient Mark Mode is off, immediately repeating this
5039 command activates `transient-mark-mode' temporarily.
5042 jump to the mark, and set the mark from
5043 position popped off the local mark ring (this does not affect the global
5045 mark ring (see `pop-global-mark').
5047 If `set-mark-command-repeat-pop' is non-nil, repeating
5049 off the local (or global) mark ring and jumps there.
5052 argument, unconditionally set mark where point is, even if
5053 `set-mark-command-repeat-pop' is non-nil.
5055 Novice Emacs Lisp programmers often try to use the mark for the wrong
5056 purposes. See the documentation of `set-mark' for more information."
5076 arg)
5090 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5091 If the last global mark pushed was not in the current buffer,
5092 also push LOCATION on the global mark ring.
5093 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5095 Novice Emacs Lisp programmers often try to use the mark for the wrong
5096 purposes. See the documentation of `set-mark' for more information.
5098 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5105 ;; Now push the mark on the global mark ring.
5108 ;; The last global mark pushed was in this same buffer.
5109 ;; Don't push another one.
5110 nil
5119 nil)
5122 "Pop off mark ring into the buffer's actual mark.
5123 Does not set point. Does nothing if mark ring is empty."
5135 "Put the mark where point is now, and point where the mark is now.
5136 This command works even when the mark is not active,
5137 and it reactivates the mark.
5139 If Transient Mark mode is on, a prefix ARG deactivates the mark
5140 if it is active, and otherwise avoids reactivating it. If
5141 Transient Mark mode is off, a prefix ARG enables Transient Mark
5142 mode temporarily."
5156 nil))
5159 "When non-nil, shifted motion keys activate the mark momentarily.
5161 While the mark is activated in this way, any shift-translated point
5162 motion key extends the region, and if Transient Mark mode was off, it
5163 is temporarily turned on. Furthermore, the mark will be deactivated
5164 by any subsequent point motion key that was not shift-translated, or
5165 by any action that normally deactivates the mark in Transient Mark mode.
5167 See `this-command-keys-shift-translated' for the meaning of
5168 shift-translation."
5173 "Activate/deactivate mark depending on invocation thru shift translation.
5174 This function is called by `call-interactively' when a command
5175 with a `^' character in its `interactive' spec is invoked, before
5176 running the command itself.
5178 If `shift-select-mode' is enabled and the command was invoked
5179 through shift translation, set the mark and activate the region
5180 temporarily, unless it was already set in this way. See
5181 `this-command-keys-shift-translated' for the meaning of shift
5182 translation.
5184 Otherwise, if the region has been activated temporarily,
5185 deactivate it, and restore the variable `transient-mark-mode' to
5186 its earlier value."
5193 transient-mark-mode)))
5202 "Toggle Transient Mark mode.
5203 With a prefix argument ARG, enable Transient Mark mode if ARG is
5204 positive, and disable it otherwise. If called from Lisp, enable
5205 Transient Mark mode if ARG is omitted or nil.
5207 Transient Mark mode is a global minor mode. When enabled, the
5208 region is highlighted with the `region' face whenever the mark
5210 and after certain other operations that set the mark but whose
5211 main purpose is something else--for example, incremental search,
5217 Many commands change their behavior when Transient Mark mode is
5218 in effect and the mark is active, by acting on the region instead
5219 of their usual default part of the buffer's text. Examples of
5222 To see the documentation of commands which are sensitive to the
5225 :global t
5226 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5230 "Non-nil means it is ok for commands to call `widen' when they want to.
5231 Some commands will do this in order to go to positions outside
5232 the current accessible part of the buffer.
5234 If `widen-automatically' is nil, these commands will do something else
5238 "Whether the currently executing code is performing an essential task.
5239 This variable should be non-nil only when running code which should not
5240 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5241 user for a password when we are simply scanning a set of files in the
5242 background or displaying possible completions before the user even asked
5246 "Pop off global mark ring and jump to the top location."
5248 ;; Pop entries which refer to non-existent buffers.
5266 \f
5268 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5274 "Move cursor vertically down ARG lines.
5275 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5276 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5277 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5278 function will not vscroll.
5280 ARG defaults to 1.
5282 If there is no character in the target line exactly under the current column,
5283 the cursor is positioned after the character in that line which spans this
5284 column, or at the end of the line if it is not long enough.
5285 If there is no line in the buffer after this one, behavior depends on the
5286 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5287 to create a line, and moves the cursor to that line. Otherwise it moves the
5288 cursor to the end of the buffer.
5290 If the variable `line-move-visual' is non-nil, this command moves
5291 by display lines. Otherwise, it moves by buffer lines, without
5292 taking variable-width characters or continued lines into account.
5295 a semipermanent goal column for this command.
5296 Then instead of trying to move exactly vertically (or as close as possible),
5297 this command moves to the specified goal column (or as close as possible).
5298 The goal column is stored in the variable `goal-column', which is nil
5299 when there is no goal column. Note that setting `goal-column'
5300 overrides `line-move-visual' and causes this command to move by buffer
5301 lines rather than by display lines."
5307 ;; When adding a newline, don't expand an abbrev.
5318 nil)
5321 "Move cursor vertically up ARG lines.
5322 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5323 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5324 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5325 function will not vscroll.
5327 ARG defaults to 1.
5329 If there is no character in the target line exactly over the current column,
5330 the cursor is positioned after the character in that line which spans this
5331 column, or at the end of the line if it is not long enough.
5333 If the variable `line-move-visual' is non-nil, this command moves
5334 by display lines. Otherwise, it moves by buffer lines, without
5335 taking variable-width characters or continued lines into account.
5338 a semipermanent goal column for this command.
5339 Then instead of trying to move exactly vertically (or as close as possible),
5340 this command moves to the specified goal column (or as close as possible).
5341 The goal column is stored in the variable `goal-column', which is nil
5342 when there is no goal column. Note that setting `goal-column'
5343 overrides `line-move-visual' and causes this command to move by buffer
5344 lines rather than by display lines."
5355 nil)
5358 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5359 This means moving to the end of each line moved onto.
5360 The beginning of a blank line does not count as the end of a line.
5361 This has no effect when the variable `line-move-visual' is non-nil."
5367 A non-nil setting overrides the variable `line-move-visual', which see."
5374 "Current goal column for vertical motion.
5375 It is the column where point was at the start of the current run
5376 of vertical motion commands.
5378 When moving by visual lines via the function `line-move-visual', it is a cons
5379 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5380 divided by the default column width, and HSCROLL is the number of
5381 columns by which window is scrolled from left margin.
5383 When the `track-eol' feature is doing its job, the value is
5387 "Non-nil means commands that move by lines ignore invisible newlines.
5388 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5389 as if newlines that are invisible didn't exist, and count
5390 only visible newlines. Thus, moving across across 2 newlines
5391 one of which is invisible will be counted as a one-line move.
5392 Also, a non-nil value causes invisible text to be ignored when
5393 counting columns for the purposes of keeping point in the same
5396 Outline mode sets this."
5401 "When non-nil, `line-move' moves point by visual lines.
5402 This movement is based on where the cursor is displayed on the
5403 screen, instead of relying on buffer contents alone. It takes
5404 into account variable-width characters and line continuation.
5405 If nil, `line-move' moves point by logical lines.
5406 A non-nil setting of `goal-column' overrides the value of this variable
5407 and forces movement by logical lines.
5408 A window that is horizontally scrolled also forces movement by logical
5409 lines."
5414 ;; Only used if display-graphic-p.
5418 "Return the height in pixels of the current buffer's default face font.
5420 If the default font is remapped (see `face-remapping-alist'), the
5421 function returns the height of the remapped face."
5425 ;; Avoid calling font-info if the frame's default font was
5426 ;; not changed since the frame was created. That's because
5427 ;; font-info is expensive for some fonts, see bug #14838.
5433 "Return the width in pixels of the current buffer's default face font.
5435 If the default font is remapped (see `face-remapping-alist'), the
5436 function returns the width of the remapped face."
5440 ;; Avoid calling font-info if the frame's default font was
5441 ;; not changed since the frame was created. That's because
5442 ;; font-info is expensive for some fonts, see bug #14838.
5447 width
5452 "Return the pixel height of current buffer's default-face text line.
5454 The value includes `line-spacing', if any, defined for the buffer
5455 or the frame."
5468 "Return the number of screen lines in the text area of the selected window.
5470 This is different from `window-text-height' in that this function counts
5471 lines in units of the height of the font used by the default face displayed
5472 in the window, not in units of the frame's default font, and also accounts
5473 for `line-spacing', if any, defined for the window's buffer or frame.
5475 The value is a floating-point number."
5480 ;; Returns non-nil if partial move was done.
5483 ;; Move backward (up).
5484 ;; If already vscrolled, reduce vscroll
5490 ;; Move forward (down).
5503 py vs last-line)
5523 col-row)
5528 ;; VPOS > 0 means the last line is only partially visible.
5529 ;; But if the part that is visible is at least as tall as the
5530 ;; default font, that means the line is actually fully
5531 ;; readable, and something like line-spacing is hidden. So in
5532 ;; that case we accept the last line in the window as still
5533 ;; visible, and consider the margin as starting one line
5534 ;; later.
5542 ;; If last line of window is fully visible, and vscrolling
5543 ;; more would make this line invisible, move forward.
5548 nil)
5549 ;; If cursor is not in the bottom scroll margin, and the
5550 ;; current line is is not too tall, move forward.
5552 vpos
5555 nil)
5556 ;; When already vscrolled, we vscroll some more if we can,
5557 ;; or clear vscroll and move forward at end of tall image.
5562 ;; If cursor just entered the bottom scroll margin, move forward,
5563 ;; but also optionally vscroll one line so redisplay won't recenter.
5567 ;; Don't vscroll if the partially-visible line at window
5568 ;; bottom is not too tall (a.k.a. "just one more text
5569 ;; line"): in that case, we do want redisplay to behave
5570 ;; normally, i.e. recenter or whatever.
5571 ;;
5572 ;; Note: ROWH + RBOT from the value returned by
5573 ;; pos-visible-in-window-p give the total height of the
5574 ;; partially-visible glyph row at the end of the window. As
5575 ;; we are dealing with floats, we disregard sub-pixel
5576 ;; discrepancies between that and DLH.
5580 t)
5581 ;; If there are lines above the last line, scroll-up one line.
5584 t)
5585 ;; Finally, start vscroll.
5590 ;; This is like line-move-1 except that it also performs
5591 ;; vertical scrolling of tall images if appropriate.
5592 ;; That is not really a clean thing to do, since it mixes
5593 ;; scrolling with cursor motion. But so far we don't have
5594 ;; a cleaner solution to the problem of making C-n do something
5595 ;; useful given a tall image.
5597 "Move forward ARG lines.
5598 If NOERROR, don't signal an error if we can't move ARG lines.
5599 TO-END is unused.
5600 TRY-VSCROLL controls whether to vscroll tall lines: if either
5601 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5602 not vscroll."
5606 ;; Only vscroll for single line moves
5608 ;; Under scroll-conservatively, the display engine
5609 ;; does this better.
5611 ;; But don't vscroll in a keyboard macro.
5617 ;; Display-based column are incompatible with goal-column.
5619 ;; When the text in the window is scrolled to the left,
5620 ;; display-based motion doesn't make sense (because each
5621 ;; logical line occupies exactly one screen line).
5623 ;; Likewise when the text _was_ scrolled to the left
5624 ;; when the current run of vertical motion commands
5625 ;; started.
5628 auto-hscroll-mode
5630 (>= temporary-goal-column
5633 ;; If we moved into a tall line, set vscroll to make
5634 ;; scrolling through tall images more smooth.
5638 winh)
5644 nil
5648 ;; Display-based alternative to line-move-1.
5649 ;; Arg says how many lines to move. The value is t if we can move the
5650 ;; specified number of lines.
5652 "Move ARG lines forward.
5653 If NOERROR, don't signal an error if we can't move that many lines."
5656 target-hscroll)
5657 ;; Check if the previous command was a line-motion command, or if
5658 ;; we were called from some other command.
5661 ;; If so, there's no need to reset `temporary-goal-column',
5662 ;; but we may need to hscroll.
5666 ;; Otherwise, we should reset `temporary-goal-column'.
5668 x-pos)
5670 ;; Handle the `overflow-newline-into-fringe' case:
5675 ;; In R2L lines, the X pixel coordinate is measured from the
5676 ;; left edge of the window, but columns are still counted
5677 ;; from the logical-order beginning of the line, i.e. from
5678 ;; the right edge in this case. We need to adjust for that.
5684 hscroll))))))
5687 ;; vertical-motion can move more than it was asked to if it moves
5688 ;; across display strings with newlines. We don't want to ring
5689 ;; the bell and announce beginning/end of buffer in that case.
5695 temporary-goal-column))
5696 arg))
5697 arg))
5703 temporary-goal-column))
5704 arg))
5705 arg)))
5708 ;; If the goal column lies on a display string,
5709 ;; `vertical-motion' advances the cursor to the end
5710 ;; of the string. For arg < 0, this can cause the
5711 ;; cursor to get stuck. (Bug#3020).
5715 nil)))))
5717 ;; This is the guts of next-line and previous-line.
5718 ;; Arg says how many lines to move.
5719 ;; The value is t if we can move the specified number of lines.
5721 ;; Don't run any point-motion hooks, and disregard intangibility,
5722 ;; for intermediate positions.
5734 ;; Don't count beg of empty line as end of line
5735 ;; unless we just did explicit end-of-line.
5737 most-positive-fixnum
5741 line-move-ignore-invisible))
5742 ;; Use just newline characters.
5743 ;; Set ARG to 0 if we move as many lines as requested.
5746 ;; This way of moving forward ARG lines
5747 ;; verifies that we have a newline after the last one.
5748 ;; It doesn't get confused by intangible text.
5757 'beginning-of-buffer
5759 nil)))
5760 ;; Move by arg lines, but ignore invisible ones.
5763 ;; If the following character is currently invisible,
5764 ;; skip all characters with that same `invisible' property value.
5767 ;; Move a line.
5768 ;; We don't use `end-of-line', since we want to escape
5769 ;; from field boundaries occurring exactly at point.
5775 ;; If there's no invisibility here, move over the newline.
5784 ;; We avoid vertical-motion when possible
5785 ;; because that has to fontify.
5787 ;; Otherwise move a more sophisticated way.
5794 ;; The logic of this is the same as the loop above,
5795 ;; it just goes in the other direction.
5797 ;; For completely consistency with the forward-motion
5798 ;; case, we should call beginning-of-line here.
5799 ;; However, if point is inside a field and on a
5800 ;; continued line, the call to (vertical-motion -1)
5801 ;; below won't move us back far enough; then we return
5802 ;; to the same column in line-move-finish, and point
5803 ;; gets stuck -- cyd
5821 ;; if our target is the middle of this line.
5826 ;; This is the value the function returns.
5830 ;; If we did not move down as far as desired, at least go
5831 ;; to end of line. Be sure to call point-entered and
5832 ;; point-left-hooks.
5838 ;; If we did not move up as far as desired,
5839 ;; at least go to beginning of line.
5851 ;; Set REPEAT to t to repeat the whole thing.
5858 ;; Compute the end of the line
5859 ;; ignoring effectively invisible newlines.
5861 ;; Like end-of-line but ignores fields.
5868 ;; Move to the desired column.
5871 ;; Corner case: suppose we start out in a field boundary in
5872 ;; the middle of a continued line. When we get to
5873 ;; line-move-finish, point is at the start of a new *screen*
5874 ;; line but the same text line; then line-move-to-column would
5875 ;; move us backwards. Test using C-n with point on the "x" in
5876 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5883 ;; Process intangibility within a line.
5884 ;; With inhibit-point-motion-hooks bound to nil, a call to
5885 ;; goto-char moves point past intangible text.
5887 ;; However, inhibit-point-motion-hooks controls both the
5888 ;; intangibility and the point-entered/point-left hooks. The
5889 ;; following hack avoids calling the point-* hooks
5890 ;; unnecessarily. Note that we move *forward* past intangible
5891 ;; text when the initial and final points are the same.
5896 ;; If intangibility moves us to a different (later) place
5897 ;; in the same line, use that as the destination.
5900 ;; If that position is "too late",
5901 ;; try the previous allowable position.
5902 ;; See if it is ok.
5905 ;; If going forward, don't accept the previous
5906 ;; allowable position if it is before the target line.
5908 ;; If going backward, don't accept the previous
5909 ;; allowable position if it is still after the target line.
5912 ;; As a last resort, use the end of the line.
5915 ;; Now move to the updated destination, processing fields
5916 ;; as well as intangibility.
5920 ;; Ignore field boundaries if the initial and final
5921 ;; positions have the same `field' property, even if the
5922 ;; fields are non-contiguous. This seems to be "nicer"
5923 ;; behavior in many situations.
5926 new
5930 ;; If all this moved us to a different line,
5931 ;; retry everything within that new line.
5933 ;; Repeat the intangibility and field processing.
5937 "Try to find column COL, considering invisibility.
5938 This function works only in certain cases,
5939 because what we really need is for `move-to-column'
5940 and `current-column' to be able to ignore invisible text."
5949 ;; If the following character is currently invisible,
5950 ;; skip all characters with that same `invisible' property value.
5954 ;; Have we advanced to a larger column position?
5956 ;; We have made some progress towards the desired column.
5957 ;; See if we can make any further progress.
5959 ;; Otherwise, go to the place we originally found
5960 ;; and move back over invisible text.
5961 ;; that will get us to the same place on the screen
5962 ;; but with a more reasonable buffer position.
5969 "Move point to end of current line as displayed.
5970 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5971 If point reaches the beginning or end of buffer, it stops there.
5973 To ignore the effects of the `intangible' text or overlay
5974 property, bind `inhibit-point-motion-hooks' to t.
5975 If there is an image in the current line, this function
5976 disregards newlines that are part of the text on which the image
5977 rests."
5987 ;; With bidi reordering, we may not be at bol,
5988 ;; so make sure we are.
6003 ;; If we skipped something intangible and now we're not
6004 ;; really at eol, keep going.
6009 "Move point to beginning of current line as displayed.
6010 \(If there's an image in the line, this disregards newlines
6011 which are part of the text that the image rests on.)
6013 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6014 If point reaches the beginning or end of buffer, it stops there.
6015 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6020 first-vis first-vis-field-value)
6022 ;; Move by lines, if ARG is not 1 (the default).
6027 ;; Move to beginning-of-line, ignoring fields and invisible text.
6033 ;; Now find first visible char in the line.
6038 ;; See if fields would stop us from reaching FIRST-VIS.
6043 ;; If yes, obey them.
6044 first-vis-field-value
6045 ;; Otherwise, move to START with attention to fields.
6046 ;; (It is possible that fields never matter in this case.)
6051 ;; Many people have said they rarely use this feature, and often type
6052 ;; it by accident. Maybe it shouldn't even be on a key.
6057 Those commands will move to this position in the line moved to
6058 rather than trying to keep the same horizontal position.
6059 With a non-nil argument ARG, clears out the goal column
6061 The goal column is stored in the variable `goal-column'."
6068 ;; The older method below can be erroneous if `set-goal-column' is bound
6069 ;; to a sequence containing %
6070 ;;(message (substitute-command-keys
6071 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6072 ;;goal-column)
6079 )
6080 nil)
6081 \f
6082 ;;; Editing based on visual lines, as opposed to logical lines.
6085 "Move point to end of current visual line.
6086 With argument N not nil or 1, move forward N - 1 visual lines first.
6087 If point reaches the beginning or end of buffer, it stops there.
6088 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6094 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6095 ;; constrain to field boundaries, so we don't either.
6099 "Move point to beginning of current visual line.
6100 With argument N not nil or 1, move forward N - 1 visual lines first.
6101 If point reaches the beginning or end of buffer, it stops there.
6102 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6110 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6114 "Kill the rest of the visual line.
6115 With prefix argument ARG, kill that many visual lines from point.
6116 If ARG is negative, kill visual lines backward.
6117 If ARG is zero, kill the text before point on the current visual
6118 line.
6120 If you want to append the killed line to the last killed text,
6123 If the buffer is read-only, Emacs will beep and refrain from deleting
6124 the line, but put the line in the kill ring anyway. This means that
6125 you can use this command to copy text from a read-only buffer.
6126 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6127 even beep.)"
6129 ;; Like in `kill-line', it's better to move point to the other end
6130 ;; of the kill before killing.
6138 ;; Skip any trailing whitespace at the end of the visual line.
6139 ;; We used to do this only if `show-trailing-whitespace' is
6140 ;; nil, but that's wrong; the correct thing would be to check
6141 ;; whether the trailing whitespace is highlighted. But, it's
6142 ;; OK to just do this unconditionally.
6149 "Move cursor vertically down ARG lines.
6150 This is identical to `next-line', except that it always moves
6151 by logical lines instead of visual lines, ignoring the value of
6152 the variable `line-move-visual'."
6159 "Move cursor vertically up ARG lines.
6160 This is identical to `previous-line', except that it always moves
6161 by logical lines instead of visual lines, ignoring the value of
6162 the variable `line-move-visual'."
6169 "Editing based on visual lines."
6178 ;; These keybindings interfere with xterm function keys. Are
6179 ;; there any other suitable bindings?
6180 ;; (define-key map "\M-[" 'previous-logical-line)
6181 ;; (define-key map "\M-]" 'next-logical-line)
6182 map))
6185 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6186 The value should be a list of the form (LEFT RIGHT), where LEFT
6187 and RIGHT are symbols representing the bitmaps to display, to
6188 indicate wrapped lines, in the left and right fringes respectively.
6189 See also `fringe-indicator-alist'.
6190 The default is not to display fringe indicators for wrapped lines.
6191 This variable does not affect fringe indicators displayed for
6192 other purposes."
6207 'continuation
6214 "Toggle visual line based editing (Visual Line mode).
6215 With a prefix argument ARG, enable Visual Line mode if ARG is
6216 positive, and disable it otherwise. If called from Lisp, enable
6217 the mode if ARG is omitted or nil.
6219 When Visual Line mode is enabled, `word-wrap' is turned on in
6220 this buffer, and simple editing commands are redefined to act on
6221 visual lines, not logical lines. See Info node `Visual Line
6222 Mode' for details."
6223 :keymap visual-line-mode-map
6229 ;; Save the local values of some variables, to be restored if
6230 ;; visual-line-mode is turned off.
6232 truncate-partial-width-windows
6233 word-wrap fringe-indicator-alist))
6236 visual-line--saved-state)))
6240 word-wrap t
6241 fringe-indicator-alist
6243 fringe-indicator-alist)))
6257 visual-line-mode turn-on-visual-line-mode)
6259 \f
6261 "Interchange characters around point, moving forward one character.
6262 With prefix arg ARG, effect is to take character before point
6263 and drag it forward past ARG other characters (backward if ARG negative).
6264 If no argument and at end of line, the previous two chars are exchanged."
6272 "Interchange words around point, leaving point at end of them.
6273 With prefix arg ARG, effect is to take word before or around point
6274 and drag it forward past ARG other words (backward if ARG negative).
6275 If ARG is zero, the words around or after point and around or after mark
6276 are interchanged."
6277 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6283 Does not work on a sexp that point is in the middle of
6284 if it is a list or string."
6288 ;; Here we should try to simulate the behavior of
6289 ;; (cons (progn (forward-sexp x) (point))
6290 ;; (progn (forward-sexp (- x)) (point)))
6291 ;; Except that we don't want to rely on the second forward-sexp
6292 ;; putting us back to where we want to be, since forward-sexp-function
6293 ;; might do funny things like infix-precedence.
6298 ;; Jumping over a symbol. We might be inside it, mind you.
6303 ;; Otherwise, we're between sexps. Take a step back before jumping
6304 ;; to make sure we'll obey the same precedence no matter which direction
6305 ;; we're going.
6310 'skip-syntax-forward
6317 "Exchange current line and previous line, leaving point after both.
6318 With argument ARG, takes previous line and moves it past ARG lines.
6319 With argument 0, interchanges line point is in with line mark is in."
6325 ;; Move forward over ARG lines,
6326 ;; but create newlines if necessary.
6333 arg))
6335 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6336 ;; which seems inconsistent with the ARG /= 0 case.
6337 ;; FIXME document SPECIAL.
6339 "Subroutine to do the work of transposing objects.
6340 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6341 moves forward by units of the given object (e.g. forward-sentence,
6342 forward-paragraph). If ARG is zero, exchanges the current object
6343 with the one containing mark. If ARG is an integer, moves the
6344 current object past ARG following (if ARG is positive) or
6345 preceding (if ARG is negative) objects, leaving point after the
6346 current object."
6351 pos1 pos2)
6379 ;; This sequence of insertions attempts to preserve marker
6380 ;; positions at the start and end of the transposed objects.
6394 \f
6396 "Move backward until encountering the beginning of a word.
6397 With argument ARG, do this that many times.
6398 If ARG is omitted or nil, move point backward one word."
6403 "Set mark ARG words away from point.
6405 move to with the same argument.
6406 Interactively, if this command is repeated
6407 or (in Transient Mark mode) if the mark is active,
6408 it marks the next ARG words after the ones already marked."
6425 nil t))))
6428 "Kill characters forward until encountering the end of a word.
6429 With argument ARG, do this that many times."
6434 "Kill characters backward until encountering the beginning of a word.
6435 With argument ARG, do this that many times."
6440 "Return the symbol or word that point is on (or a nearby one) as a string.
6441 The return value includes no text properties.
6442 If optional arg STRICT is non-nil, return nil unless point is within
6443 or adjacent to a symbol or word. In all cases the value can be nil
6444 if there is no word nearby.
6445 The function, belying its name, normally finds a symbol.
6446 If optional arg REALLY-WORD is non-nil, it finds just a word."
6455 ;; Point is neither within nor adjacent to a word.
6457 ;; Look for preceding word in same line.
6460 ;; No preceding word in same line.
6461 ;; Look for following word in same line.
6470 ;; If we found something nonempty, return it as a string.
6473 \f
6475 "String for filling to insert at front of new line, or nil for none."
6477 string)
6483 "Regexp to match lines which should not be auto-filled."
6485 regexp)
6489 "The default value for `normal-auto-fill-function'.
6490 This is the default auto-fill function, some major modes use a different one.
6491 Returns t if it really did any work."
6501 nil ;; Auto-filling not required
6505 ;; Choose a fill-prefix automatically.
6513 ;; Use auto-indentation rather than a guessed empty prefix.
6519 ;; Determine where to split the line.
6532 ;; See whether the place we found is any good.
6536 ;; There is no use breaking at end of line.
6538 ;; It is futile to split at the end of the prefix
6539 ;; since we would just insert the prefix again.
6541 ;; Don't split right after a comment starter
6542 ;; since we would just make another comment starter.
6547 limit t)
6549 ;; No good place to break => stop trying.
6551 ;; Ok, we have a useful place to break the line. Do it.
6553 ;; If point is at the fill-point, do not `save-excursion'.
6554 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6555 ;; point will end up before it rather than after it.
6563 ;; Now do justification, if required
6568 ;; If making the new line didn't reduce the hpos of
6569 ;; the end of the line, then give up now;
6570 ;; trying again will not help.
6573 ;; Justify last line.
6575 t)))
6578 "Mode-specific function which line breaks and continues a comment.
6579 This function is called during auto-filling when a comment syntax
6580 is defined.
6581 The function should take a single optional argument, which is a flag
6585 "Break line at point and indent.
6586 If a comment syntax is defined, call `comment-indent-new-line'.
6588 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6589 unless optional argument SOFT is non-nil."
6593 ;; Insert the newline before removing empty space so that markers
6594 ;; get preserved better.
6600 ;; Blindly trust a non-adaptive fill-prefix.
6606 ;; If there's an adaptive prefix, use it unless we're inside
6607 ;; a comment and the prefix is not a comment starter.
6611 ;; If we're not inside a comment, just try to indent.
6615 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6619 ;; `functions' and `hooks' are usually unsafe to set, but setting
6620 ;; auto-fill-function to nil in a file-local setting is safe and
6621 ;; can be useful to prevent auto-filling.
6625 "Toggle automatic line breaking (Auto Fill mode).
6626 With a prefix argument ARG, enable Auto Fill mode if ARG is
6627 positive, and disable it otherwise. If called from Lisp, enable
6628 the mode if ARG is omitted or nil.
6630 When Auto Fill mode is enabled, inserting a space at a column
6631 beyond `current-fill-column' automatically breaks the line at a
6632 previous space.
6634 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6635 non-`nil'.
6637 The value of `normal-auto-fill-function' specifies the function to use
6638 for `auto-fill-function' when turning Auto Fill mode on."
6643 ;; This holds a document string used to document auto-fill-mode.
6645 "Automatically break line at a previous space, in insertion of text."
6646 nil)
6649 "Unconditionally turn on Auto Fill mode."
6653 "Unconditionally turn off Auto Fill mode."
6659 "Set `fill-column' to specified argument.
6664 ;; We used to use current-column silently, but C-x f is too easily
6665 ;; typed as a typo for C-x C-f, so we turned it into an error and
6666 ;; now an interactive prompt.
6671 ;; Disallow missing argument; it's probably a typo for C-x C-f.
6675 \f
6677 "Set `selective-display' to ARG; clear it if no arg.
6678 When the value of `selective-display' is a number > 0,
6679 lines whose indentation is >= that value are not displayed.
6680 The variable `selective-display' has a separate value for each buffer."
6700 "Toggle truncating of long lines for the current buffer.
6701 When truncating is off, long lines are folded.
6702 With prefix argument ARG, truncate long lines if ARG is positive,
6703 otherwise fold them. Note that in side-by-side windows, this
6704 command has no effect if `truncate-partial-width-windows' is
6705 non-nil."
6717 nil t)))
6722 "Toggle whether to use word-wrapping for continuation lines.
6723 With prefix argument ARG, wrap continuation lines at word boundaries
6724 if ARG is positive, otherwise wrap them at the right screen edge.
6725 This command toggles the value of `word-wrap'. It has no effect
6726 if long lines are truncated."
6742 "Toggle Overwrite mode.
6743 With a prefix argument ARG, enable Overwrite mode if ARG is
6744 positive, and disable it otherwise. If called from Lisp, enable
6745 the mode if ARG is omitted or nil.
6747 When Overwrite mode is enabled, printing characters typed in
6748 replace existing text on a one-for-one basis, rather than pushing
6749 it to the right. At the end of a line, such characters extend
6750 the line. Before a tab, such characters insert until the tab is
6752 overwrite mode; this is supposed to make it easier to insert
6753 characters when necessary."
6758 "Toggle Binary Overwrite mode.
6759 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6760 is positive, and disable it otherwise. If called from Lisp,
6761 enable the mode if ARG is omitted or nil.
6763 When Binary Overwrite mode is enabled, printing characters typed
6764 in replace existing text. Newlines are not treated specially, so
6765 typing at the end of a line joins the line to the next, with the
6766 typed character between them. Typing before a tab character
6767 simply replaces the tab with the character typed.
6769 ordinary typing characters do.
6771 Note that Binary Overwrite mode is not its own minor mode; it is
6772 a specialization of overwrite mode, entered by setting the
6773 `overwrite-mode' variable to `overwrite-mode-binary'."
6778 "Toggle line number display in the mode line (Line Number mode).
6779 With a prefix argument ARG, enable Line Number mode if ARG is
6780 positive, and disable it otherwise. If called from Lisp, enable
6781 the mode if ARG is omitted or nil.
6783 Line numbers do not appear for very large buffers and buffers
6784 with very long lines; see variables `line-number-display-limit'
6785 and `line-number-display-limit-width'."
6789 "Toggle column number display in the mode line (Column Number mode).
6790 With a prefix argument ARG, enable Column Number mode if ARG is
6791 positive, and disable it otherwise.
6793 If called from Lisp, enable the mode if ARG is omitted or nil."
6797 "Toggle buffer size display in the mode line (Size Indication mode).
6798 With a prefix argument ARG, enable Size Indication mode if ARG is
6799 positive, and disable it otherwise.
6801 If called from Lisp, enable the mode if ARG is omitted or nil."
6805 "Toggle auto-saving in the current buffer (Auto Save mode).
6806 With a prefix argument ARG, enable Auto Save mode if ARG is
6807 positive, and disable it otherwise.
6809 If called from Lisp, enable the mode if ARG is omitted or nil."
6811 ;; If auto-save is off because buffer has shrunk,
6812 ;; then toggling should turn it on.
6820 buffer-file-name)
6822 ;; If -1 was stored here, to temporarily turn off saving,
6823 ;; turn it back on.
6826 \f
6828 "Blinking matching of parens and expressions."
6833 "Non-nil means show matching open-paren when close-paren is inserted.
6834 If t, highlight the paren. If `jump', move cursor to its position."
6842 "Non-nil means show matching open-paren when it is on screen.
6843 If nil, don't show it (but the open-paren can still be shown
6844 when it is off screen).
6846 This variable has no effect if `blink-matching-paren' is nil.
6847 \(In that case, the open-paren is never shown.)
6848 It is also ignored if `show-paren-mode' is enabled."
6853 "If non-nil, maximum distance to search backwards for matching open-paren.
6854 If nil, search stops at the beginning of the accessible portion of the buffer."
6860 "Time in seconds to delay after showing a matching paren."
6865 "If nil, `blink-matching-paren' ignores comments.
6866 More precisely, when looking for the matching parenthesis,
6867 it skips the contents of comments that end before point."
6872 "Return whether or not START...END are matching parens.
6873 END is the current point and START is the blink position.
6874 START might be nil if no matching starter was found.
6875 Returns non-nil if we find there is a mismatch."
6880 ;; For self-matched chars like " and $, we can't know when they're
6881 ;; mismatched or unmatched, so we can only do it for parens.
6886 ;; The cdr might hold a new paren-class info rather than
6887 ;; a matching-char info, in which case the two CDRs
6888 ;; should match.
6892 "Function to check parentheses mismatches.
6893 The function takes two arguments (START and END) where START is the
6894 position just before the opening token and END is the position right after.
6895 START can be nil, if it was not found.
6902 ol)
6906 "Momentarily highlight the beginning of the sexp before point."
6909 blink-matching-paren)
6919 oldpos))
6927 ;; backward-sexp skips backward over prefix chars,
6928 ;; so move back to the matching paren.
6949 ;; Matching open within window, temporarily move to or highlight
6950 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
6951 ;; is non-nil.
6968 ;; Show what precedes the open in its line, if anything.
6973 ;; Show what follows the open in its line, if anything.
6980 ;; Otherwise show the previous nonblank line,
6981 ;; if there is one.
6990 ;; Replace the newline and other whitespace with `...'.
6991 "..."
6993 ;; There is nothing to show except the char itself.
6996 "Matches %s"
7000 "Function called, if non-nil, whenever a close parenthesis is inserted.
7006 blink-paren-function
7009 ;; Verify an even number of quoting characters precede the close.
7010 ;; FIXME: Also check if this parenthesis closes a comment as
7011 ;; can happen in Pascal and SML.
7022 ;; Most likely, this hook is nil, so this arg doesn't matter,
7023 ;; but I use it as a reminder that this function usually
7024 ;; likes to be run after others since it does
7025 ;; `sit-for'. That's also the reason it get a `priority' prop
7026 ;; of 100.
7028 \f
7029 ;; This executes C-g typed while Emacs is waiting for a command.
7030 ;; Quitting out of a program does not go through here;
7031 ;; that happens in the QUIT macro at the C code level.
7033 "Signal a `quit' condition.
7034 During execution of Lisp code, this character causes a quit directly.
7035 At top-level, as an editor command, this simply beeps."
7037 ;; Avoid adding the region to the window selection.
7045 ;; Force the next redisplay cycle to remove the "Def" indicator from
7046 ;; all the mode lines.
7060 This command can exit an interactive command such as `query-replace',
7061 can clear out a prefix argument or a region,
7062 can get out of the minibuffer or other recursive edit,
7063 cancel the use of the current buffer (for special-purpose buffers),
7064 or go back to just one window (by deleting all but the selected window)."
7072 nil)
7083 "Play sound stored in FILE.
7084 VOLUME and DEVICE correspond to the keywords of the sound
7085 specification for `play-sound'."
7095 \f
7097 "Your preference for a mail reading package.
7098 This is used by some keybindings which support reading mail.
7099 See also `mail-user-agent' concerning sending mail."
7109 "Your preference for a mail composition package.
7110 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7111 outgoing email message. This variable lets you specify which
7112 mail-sending package you prefer.
7114 Valid values include:
7116 `message-user-agent' -- use the Message package.
7117 See Info node `(message)'.
7118 `sendmail-user-agent' -- use the Mail package.
7119 See Info node `(emacs)Sending Mail'.
7120 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7121 See Info node `(mh-e)'.
7122 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7123 paraphernalia if Gnus is running, particularly
7124 the Gcc: header for archiving.
7126 Additional valid symbols may be available; check with the author of
7127 your package for details. The function should return non-nil if it
7128 succeeds.
7130 See also `read-mail-command' concerning reading mail."
7133 message-user-agent)
7136 sendmail-user-agent)
7139 mh-e-user-agent)
7142 gnus-user-agent)
7148 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7149 If the value of `mail-user-agent' is the default, and the user
7150 appears to have customizations applying to the old default,
7151 `compose-mail' issues a warning."
7157 "If the buffer starts with a mail header, move point to the header's end.
7158 Otherwise, moves to `point-min'.
7159 The end of the header is the start of the next line, if there is one,
7160 else the end of the last line. This function obeys RFC822."
7166 ;; Used by Rmail (e.g., rmail-forward).
7168 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7172 switch-function yank-action send-actions
7173 return-action)
7174 "Start composing a mail message to send.
7175 This uses the user's chosen mail composition package
7176 as selected with the variable `mail-user-agent'.
7177 The optional arguments TO and SUBJECT specify recipients
7178 and the initial Subject field, respectively.
7180 OTHER-HEADERS is an alist specifying additional
7181 header fields. Elements look like (HEADER . VALUE) where both
7182 HEADER and VALUE are strings.
7184 CONTINUE, if non-nil, says to continue editing a message already
7185 being composed. Interactively, CONTINUE is the prefix argument.
7187 SWITCH-FUNCTION, if non-nil, is a function to use to
7188 switch to and display the buffer used for mail composition.
7190 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7191 to insert the raw text of the message being replied to.
7192 It has the form (FUNCTION . ARGS). The user agent will apply
7193 FUNCTION to ARGS, to insert the raw text of the original message.
7194 \(The user agent will also run `mail-citation-hook', *after* the
7195 original text has been inserted in this way.)
7197 SEND-ACTIONS is a list of actions to call when the message is sent.
7198 Each action has the form (FUNCTION . ARGS).
7200 RETURN-ACTION, if non-nil, is an action for returning to the
7201 caller. It has the form (FUNCTION . ARGS). The function is
7202 called after the mail has been sent or put aside, and the mail
7203 buffer buried."
7207 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7208 ;; from sendmail-user-agent to message-user-agent. Some users may
7209 ;; encounter incompatibilities. This hack tries to detect problems
7210 ;; and warn about them.
7215 mail-yank-hooks mail-archive-file-name
7216 mail-default-reply-to mail-mailing-lists
7217 mail-self-blind))
7224 The default mail mode is now Message mode.
7225 You have the following Mail mode variable%s customized:
7227 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7234 yank-action send-actions return-action)))
7237 yank-action send-actions
7238 return-action)
7242 'switch-to-buffer-other-window yank-action send-actions
7243 return-action))
7246 yank-action send-actions
7247 return-action)
7251 'switch-to-buffer-other-frame yank-action send-actions
7252 return-action))
7254 \f
7256 "History of values entered with `set-variable'.
7258 Maximum length of the history list is determined by the value
7262 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7263 VARIABLE should be a user option variable name, a Lisp variable
7264 meant to be customized by users. You should enter VALUE in Lisp syntax,
7265 so if you want VALUE to be a string, you must surround it with doublequotes.
7266 VALUE is used literally, not evaluated.
7268 If VARIABLE has a `variable-interactive' property, that is used as if
7269 it were the arg to `interactive' (which see) to interactively read VALUE.
7271 If VARIABLE has been defined with `defcustom', then the type information
7272 in the definition is used to check that VALUE is valid.
7274 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7279 default-var)
7295 var obsolete)
7298 ;; Use VAR's `variable-interactive' property
7299 ;; as an interactive spec for prompting.
7302 arg))
7304 read-expression-map t
7305 'set-variable-value-history
7314 ;; Match with custom type.
7326 ;; Force a thorough redisplay for the case that the variable
7327 ;; has an effect on the display, like `tab-width' has.
7329 \f
7330 ;; Define the major mode for lists of completions.
7340 (define-key map [right] 'next-completion)
7342 (define-key map [backtab] 'previous-completion)
7343 (define-key map "q" 'quit-window)
7344 (define-key map "z" 'kill-this-buffer)
7345 map)
7346 "Local map for completion list buffers.")
7348 ;; Completion mode is suitable only for specially formatted data.
7349 (put 'completion-list-mode 'mode-class 'special)
7351 (defvar completion-reference-buffer nil
7352 "Record the buffer that was current when the completion list was requested.
7353 This is a local variable in the completion list buffer.
7354 Initial value is nil to avoid some compiler warnings.")
7356 (defvar completion-no-auto-exit nil
7357 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7358 This also applies to other functions such as `choose-completion'.")
7360 (defvar completion-base-position nil
7361 "Position of the base of the text corresponding to the shown completions.
7362 This variable is used in the *Completions* buffers.
7363 Its value is a list of the form (START END) where START is the place
7364 where the completion should be inserted and END (if non-nil) is the end
7365 of the text to replace. If END is nil, point is used instead.")
7367 (defvar completion-list-insert-choice-function #'completion--replace
7368 "Function to use to insert the text chosen in *Completions*.
7369 Called with three arguments (BEG END TEXT), it should replace the text
7370 between BEG and END with TEXT. Expected to be set buffer-locally
7371 in the *Completions* buffer.")
7373 (defvar completion-base-size nil
7374 "Number of chars before point not involved in completion.
7375 This is a local variable in the completion list buffer.
7376 It refers to the chars in the minibuffer if completing in the
7377 minibuffer, or in `completion-reference-buffer' otherwise.
7378 Only characters in the field at point are included.
7380 If nil, Emacs determines which part of the tail end of the
7381 buffer's text is involved in completion by comparing the text
7382 directly.")
7383 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7385 (defun delete-completion-window ()
7386 "Delete the completion list window.
7387 Go to the window from which completion was requested."
7388 (interactive)
7389 (let ((buf completion-reference-buffer))
7390 (if (one-window-p t)
7391 (if (window-dedicated-p) (delete-frame))
7392 (delete-window (selected-window))
7393 (if (get-buffer-window buf)
7394 (select-window (get-buffer-window buf))))))
7396 (defun previous-completion (n)
7397 "Move to the previous item in the completion list."
7398 (interactive "p")
7399 (next-completion (- n)))
7401 (defun next-completion (n)
7402 "Move to the next item in the completion list.
7403 With prefix argument N, move N items (negative N means move backward)."
7404 (interactive "p")
7405 (let ((beg (point-min)) (end (point-max)))
7406 (while (and (> n 0) (not (eobp)))
7407 ;; If in a completion, move to the end of it.
7408 (when (get-text-property (point) 'mouse-face)
7409 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7410 ;; Move to start of next one.
7411 (unless (get-text-property (point) 'mouse-face)
7412 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7413 (setq n (1- n)))
7414 (while (and (< n 0) (not (bobp)))
7415 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7416 ;; If in a completion, move to the start of it.
7417 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7418 (goto-char (previous-single-property-change
7419 (point) 'mouse-face nil beg)))
7420 ;; Move to end of the previous completion.
7421 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7422 (goto-char (previous-single-property-change
7423 (point) 'mouse-face nil beg)))
7424 ;; Move to the start of that one.
7425 (goto-char (previous-single-property-change
7426 (point) 'mouse-face nil beg))
7427 (setq n (1+ n))))))
7429 (defun choose-completion (&optional event)
7430 "Choose the completion at point.
7431 If EVENT, use EVENT's position to determine the starting position."
7432 (interactive (list last-nonmenu-event))
7433 ;; In case this is run via the mouse, give temporary modes such as
7434 ;; isearch a chance to turn off.
7435 (run-hooks 'mouse-leave-buffer-hook)
7436 (with-current-buffer (window-buffer (posn-window (event-start event)))
7437 (let ((buffer completion-reference-buffer)
7438 (base-size completion-base-size)
7439 (base-position completion-base-position)
7440 (insert-function completion-list-insert-choice-function)
7441 (choice
7442 (save-excursion
7443 (goto-char (posn-point (event-start event)))
7444 (let (beg end)
7445 (cond
7446 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7447 (setq end (point) beg (1+ (point))))
7448 ((and (not (bobp))
7449 (get-text-property (1- (point)) 'mouse-face))
7450 (setq end (1- (point)) beg (point)))
7451 (t (error "No completion here")))
7452 (setq beg (previous-single-property-change beg 'mouse-face))
7453 (setq end (or (next-single-property-change end 'mouse-face)
7454 (point-max)))
7455 (buffer-substring-no-properties beg end)))))
7457 (unless (buffer-live-p buffer)
7458 (error "Destination buffer is dead"))
7459 (quit-window nil (posn-window (event-start event)))
7461 (with-current-buffer buffer
7462 (choose-completion-string
7463 choice buffer
7464 (or base-position
7465 (when base-size
7466 ;; Someone's using old completion code that doesn't know
7467 ;; about base-position yet.
7468 (list (+ base-size (field-beginning))))
7469 ;; If all else fails, just guess.
7470 (list (choose-completion-guess-base-position choice)))
7471 insert-function)))))
7473 ;; Delete the longest partial match for STRING
7474 ;; that can be found before POINT.
7475 (defun choose-completion-guess-base-position (string)
7476 (save-excursion
7477 (let ((opoint (point))
7478 len)
7479 ;; Try moving back by the length of the string.
7480 (goto-char (max (- (point) (length string))
7481 (minibuffer-prompt-end)))
7482 ;; See how far back we were actually able to move. That is the
7483 ;; upper bound on how much we can match and delete.
7484 (setq len (- opoint (point)))
7485 (if completion-ignore-case
7486 (setq string (downcase string)))
7487 (while (and (> len 0)
7488 (let ((tail (buffer-substring (point) opoint)))
7489 (if completion-ignore-case
7490 (setq tail (downcase tail)))
7491 (not (string= tail (substring string 0 len)))))
7492 (setq len (1- len))
7493 (forward-char 1))
7494 (point))))
7496 (defun choose-completion-delete-max-match (string)
7497 (declare (obsolete choose-completion-guess-base-position "23.2"))
7498 (delete-region (choose-completion-guess-base-position string) (point)))
7500 (defvar choose-completion-string-functions nil
7501 "Functions that may override the normal insertion of a completion choice.
7502 These functions are called in order with three arguments:
7503 CHOICE - the string to insert in the buffer,
7504 BUFFER - the buffer in which the choice should be inserted,
7505 BASE-POSITION - where to insert the completion.
7507 If a function in the list returns non-nil, that function is supposed
7508 to have inserted the CHOICE in the BUFFER, and possibly exited
7509 the minibuffer; no further functions will be called.
7511 If all functions in the list return nil, that means to use
7512 the default method of inserting the completion in BUFFER.")
7514 (defun choose-completion-string (choice &optional
7515 buffer base-position insert-function)
7516 "Switch to BUFFER and insert the completion choice CHOICE.
7517 BASE-POSITION says where to insert the completion.
7518 INSERT-FUNCTION says how to insert the completion and falls
7519 back on `completion-list-insert-choice-function' when nil."
7521 ;; If BUFFER is the minibuffer, exit the minibuffer
7522 ;; unless it is reading a file name and CHOICE is a directory,
7523 ;; or completion-no-auto-exit is non-nil.
7525 ;; Some older code may call us passing `base-size' instead of
7526 ;; `base-position'. It's difficult to make any use of `base-size',
7527 ;; so we just ignore it.
7528 (unless (consp base-position)
7529 (message "Obsolete `base-size' passed to choose-completion-string")
7530 (setq base-position nil))
7532 (let* ((buffer (or buffer completion-reference-buffer))
7533 (mini-p (minibufferp buffer)))
7534 ;; If BUFFER is a minibuffer, barf unless it's the currently
7535 ;; active minibuffer.
7536 (if (and mini-p
7537 (not (and (active-minibuffer-window)
7538 (equal buffer
7539 (window-buffer (active-minibuffer-window))))))
7540 (error "Minibuffer is not active for completion")
7541 ;; Set buffer so buffer-local choose-completion-string-functions works.
7542 (set-buffer buffer)
7543 (unless (run-hook-with-args-until-success
7544 'choose-completion-string-functions
7545 ;; The fourth arg used to be `mini-p' but was useless
7546 ;; (since minibufferp can be used on the `buffer' arg)
7547 ;; and indeed unused. The last used to be `base-size', so we
7548 ;; keep it to try and avoid breaking old code.
7549 choice buffer base-position nil)
7550 ;; This remove-text-properties should be unnecessary since `choice'
7551 ;; comes from buffer-substring-no-properties.
7552 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7553 ;; Insert the completion into the buffer where it was requested.
7554 (funcall (or insert-function completion-list-insert-choice-function)
7555 (or (car base-position) (point))
7556 (or (cadr base-position) (point))
7557 choice)
7558 ;; Update point in the window that BUFFER is showing in.
7559 (let ((window (get-buffer-window buffer t)))
7560 (set-window-point window (point)))
7561 ;; If completing for the minibuffer, exit it with this choice.
7562 (and (not completion-no-auto-exit)
7563 (minibufferp buffer)
7564 minibuffer-completion-table
7565 ;; If this is reading a file name, and the file name chosen
7566 ;; is a directory, don't exit the minibuffer.
7567 (let* ((result (buffer-substring (field-beginning) (point)))
7568 (bounds
7569 (completion-boundaries result minibuffer-completion-table
7570 minibuffer-completion-predicate
7571 "")))
7572 (if (eq (car bounds) (length result))
7573 ;; The completion chosen leads to a new set of completions
7574 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7575 (let ((mini (active-minibuffer-window)))
7576 (select-window mini)
7577 (when minibuffer-auto-raise
7578 (raise-frame (window-frame mini))))
7579 (exit-minibuffer))))))))
7581 (define-derived-mode completion-list-mode nil "Completion List"
7582 "Major mode for buffers showing lists of possible completions.
7584 to select the completion near point.
7585 Or click to select one with the mouse.
7588 (set (make-local-variable 'completion-base-size) nil))
7590 (defun completion-list-mode-finish ()
7591 "Finish setup of the completions buffer.
7592 Called from `temp-buffer-show-hook'."
7593 (when (eq major-mode 'completion-list-mode)
7594 (setq buffer-read-only t)))
7596 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7599 ;; Variables and faces used in `completion-setup-function'.
7601 (defcustom completion-show-help t
7602 "Non-nil means show help message in *Completions* buffer."
7603 :type 'boolean
7604 :version "22.1"
7605 :group 'completion)
7607 ;; This function goes in completion-setup-hook, so that it is called
7608 ;; after the text of the completion list buffer is written.
7609 (defun completion-setup-function ()
7610 (let* ((mainbuf (current-buffer))
7611 (base-dir
7612 ;; FIXME: This is a bad hack. We try to set the default-directory
7613 ;; in the *Completions* buffer so that the relative file names
7614 ;; displayed there can be treated as valid file names, independently
7615 ;; from the completion context. But this suffers from many problems:
7616 ;; - It's not clear when the completions are file names. With some
7617 ;; completion tables (e.g. bzr revision specs), the listed
7618 ;; completions can mix file names and other things.
7619 ;; - It doesn't pay attention to possible quoting.
7620 ;; - With fancy completion styles, the code below will not always
7621 ;; find the right base directory.
7622 (if minibuffer-completing-file-name
7623 (file-name-as-directory
7624 (expand-file-name
7625 (buffer-substring (minibuffer-prompt-end)
7626 (- (point) (or completion-base-size 0))))))))
7627 (with-current-buffer standard-output
7628 (let ((base-size completion-base-size) ;Read before killing localvars.
7629 (base-position completion-base-position)
7630 (insert-fun completion-list-insert-choice-function))
7631 (completion-list-mode)
7632 (set (make-local-variable 'completion-base-size) base-size)
7633 (set (make-local-variable 'completion-base-position) base-position)
7634 (set (make-local-variable 'completion-list-insert-choice-function)
7635 insert-fun))
7636 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7637 (if base-dir (setq default-directory base-dir))
7638 ;; Maybe insert help string.
7639 (when completion-show-help
7640 (goto-char (point-min))
7641 (if (display-mouse-p)
7642 (insert (substitute-command-keys
7644 (insert (substitute-command-keys
7648 (add-hook 'completion-setup-hook 'completion-setup-function)
7650 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7651 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7653 (defun switch-to-completions ()
7654 "Select the completion list window."
7655 (interactive)
7656 (let ((window (or (get-buffer-window "*Completions*" 0)
7657 ;; Make sure we have a completions window.
7658 (progn (minibuffer-completion-help)
7659 (get-buffer-window "*Completions*" 0)))))
7660 (when window
7661 (select-window window)
7662 ;; In the new buffer, go to the first completion.
7663 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
7664 (when (bobp)
7665 (next-completion 1)))))
7666 \f
7667 ;;; Support keyboard commands to turn on various modifiers.
7669 ;; These functions -- which are not commands -- each add one modifier
7670 ;; to the following event.
7672 (defun event-apply-alt-modifier (_ignore-prompt)
7675 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
7676 (defun event-apply-super-modifier (_ignore-prompt)
7679 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
7680 (defun event-apply-hyper-modifier (_ignore-prompt)
7683 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
7684 (defun event-apply-shift-modifier (_ignore-prompt)
7687 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
7688 (defun event-apply-control-modifier (_ignore-prompt)
7691 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
7692 (defun event-apply-meta-modifier (_ignore-prompt)
7695 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
7697 (defun event-apply-modifier (event symbol lshiftby prefix)
7698 "Apply a modifier flag to event EVENT.
7699 SYMBOL is the name of this modifier, as a symbol.
7700 LSHIFTBY is the numeric value of this modifier, in keyboard events.
7701 PREFIX is the string that represents this modifier in an event type symbol."
7702 (if (numberp event)
7703 (cond ((eq symbol 'control)
7704 (if (and (<= (downcase event) ?z)
7705 (>= (downcase event) ?a))
7706 (- (downcase event) ?a -1)
7707 (if (and (<= (downcase event) ?Z)
7708 (>= (downcase event) ?A))
7709 (- (downcase event) ?A -1)
7710 (logior (lsh 1 lshiftby) event))))
7711 ((eq symbol 'shift)
7712 (if (and (<= (downcase event) ?z)
7713 (>= (downcase event) ?a))
7714 (upcase event)
7715 (logior (lsh 1 lshiftby) event)))
7716 (t
7717 (logior (lsh 1 lshiftby) event)))
7718 (if (memq symbol (event-modifiers event))
7719 event
7720 (let ((event-type (if (symbolp event) event (car event))))
7721 (setq event-type (intern (concat prefix (symbol-name event-type))))
7722 (if (symbolp event)
7723 event-type
7724 (cons event-type (cdr event)))))))
7726 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
7727 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
7728 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
7729 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
7730 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
7731 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
7732 \f
7733 ;;;; Keypad support.
7735 ;; Make the keypad keys act like ordinary typing keys. If people add
7736 ;; bindings for the function key symbols, then those bindings will
7737 ;; override these, so this shouldn't interfere with any existing
7738 ;; bindings.
7740 ;; Also tell read-char how to handle these keys.
7741 (mapc
7742 (lambda (keypad-normal)
7743 (let ((keypad (nth 0 keypad-normal))
7744 (normal (nth 1 keypad-normal)))
7745 (put keypad 'ascii-character normal)
7746 (define-key function-key-map (vector keypad) (vector normal))))
7747 ;; See also kp-keys bound in bindings.el.
7748 '((kp-space ?\s)
7751 (kp-separator ?,)
7752 (kp-equal ?=)
7753 ;; Do the same for various keys that are represented as symbols under
7754 ;; GUIs but naturally correspond to characters.
7755 (backspace 127)
7756 (delete 127)
7759 (clear ?\C-l)
7760 (return ?\C-m)
7761 (escape ?\e)
7762 ))
7763 \f
7764 ;;;;
7765 ;;;; forking a twin copy of a buffer.
7766 ;;;;
7768 (defvar clone-buffer-hook nil
7769 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7771 (defvar clone-indirect-buffer-hook nil
7772 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7774 (defun clone-process (process &optional newname)
7775 "Create a twin copy of PROCESS.
7776 If NEWNAME is nil, it defaults to PROCESS' name;
7777 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7778 If PROCESS is associated with a buffer, the new process will be associated
7779 with the current buffer instead.
7780 Returns nil if PROCESS has already terminated."
7781 (setq newname (or newname (process-name process)))
7783 (setq newname (substring newname 0 (match-beginning 0))))
7784 (when (memq (process-status process) '(run stop open))
7785 (let* ((process-connection-type (process-tty-name process))
7786 (new-process
7787 (if (memq (process-status process) '(open))
7788 (let ((args (process-contact process t)))
7789 (setq args (plist-put args :name newname))
7790 (setq args (plist-put args :buffer
7791 (if (process-buffer process)
7792 (current-buffer))))
7793 (apply 'make-network-process args))
7794 (apply 'start-process newname
7795 (if (process-buffer process) (current-buffer))
7796 (process-command process)))))
7797 (set-process-query-on-exit-flag
7798 new-process (process-query-on-exit-flag process))
7799 (set-process-inherit-coding-system-flag
7800 new-process (process-inherit-coding-system-flag process))
7801 (set-process-filter new-process (process-filter process))
7802 (set-process-sentinel new-process (process-sentinel process))
7803 (set-process-plist new-process (copy-sequence (process-plist process)))
7804 new-process)))
7806 ;; things to maybe add (currently partly covered by `funcall mode'):
7807 ;; - syntax-table
7808 ;; - overlays
7809 (defun clone-buffer (&optional newname display-flag)
7810 "Create and return a twin copy of the current buffer.
7811 Unlike an indirect buffer, the new buffer can be edited
7812 independently of the old one (if it is not read-only).
7813 NEWNAME is the name of the new buffer. It may be modified by
7814 adding or incrementing <N> at the end as necessary to create a
7815 unique buffer name. If nil, it defaults to the name of the
7816 current buffer, with the proper suffix. If DISPLAY-FLAG is
7817 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7818 clone a file-visiting buffer, or a buffer whose major mode symbol
7819 has a non-nil `no-clone' property, results in an error.
7821 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7822 current buffer with appropriate suffix. However, if a prefix
7823 argument is given, then the command prompts for NEWNAME in the
7824 minibuffer.
7826 This runs the normal hook `clone-buffer-hook' in the new buffer
7827 after it has been set up properly in other respects."
7828 (interactive
7829 (progn
7830 (if buffer-file-name
7831 (error "Cannot clone a file-visiting buffer"))
7832 (if (get major-mode 'no-clone)
7833 (error "Cannot clone a buffer in %s mode" mode-name))
7834 (list (if current-prefix-arg
7835 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7836 t)))
7837 (if buffer-file-name
7838 (error "Cannot clone a file-visiting buffer"))
7839 (if (get major-mode 'no-clone)
7840 (error "Cannot clone a buffer in %s mode" mode-name))
7841 (setq newname (or newname (buffer-name)))
7843 (setq newname (substring newname 0 (match-beginning 0))))
7844 (let ((buf (current-buffer))
7845 (ptmin (point-min))
7846 (ptmax (point-max))
7847 (pt (point))
7848 (mk (if mark-active (mark t)))
7849 (modified (buffer-modified-p))
7850 (mode major-mode)
7851 (lvars (buffer-local-variables))
7852 (process (get-buffer-process (current-buffer)))
7853 (new (generate-new-buffer (or newname (buffer-name)))))
7854 (save-restriction
7855 (widen)
7856 (with-current-buffer new
7857 (insert-buffer-substring buf)))
7858 (with-current-buffer new
7859 (narrow-to-region ptmin ptmax)
7860 (goto-char pt)
7861 (if mk (set-mark mk))
7862 (set-buffer-modified-p modified)
7864 ;; Clone the old buffer's process, if any.
7865 (when process (clone-process process))
7867 ;; Now set up the major mode.
7868 (funcall mode)
7870 ;; Set up other local variables.
7871 (mapc (lambda (v)
7872 (condition-case () ;in case var is read-only
7873 (if (symbolp v)
7874 (makunbound v)
7875 (set (make-local-variable (car v)) (cdr v)))
7876 (error nil)))
7877 lvars)
7879 ;; Run any hooks (typically set up by the major mode
7880 ;; for cloning to work properly).
7881 (run-hooks 'clone-buffer-hook))
7882 (if display-flag
7883 ;; Presumably the current buffer is shown in the selected frame, so
7884 ;; we want to display the clone elsewhere.
7885 (let ((same-window-regexps nil)
7886 (same-window-buffer-names))
7887 (pop-to-buffer new)))
7888 new))
7891 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7892 "Create an indirect buffer that is a twin copy of the current buffer.
7894 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7895 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7896 or if not called with a prefix arg, NEWNAME defaults to the current
7897 buffer's name. The name is modified by adding a `<N>' suffix to it
7898 or by incrementing the N in an existing suffix. Trying to clone a
7899 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7900 property results in an error.
7902 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7903 This is always done when called interactively.
7905 Optional third arg NORECORD non-nil means do not put this buffer at the
7906 front of the list of recently selected ones.
7908 Returns the newly created indirect buffer."
7909 (interactive
7910 (progn
7911 (if (get major-mode 'no-clone-indirect)
7912 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7913 (list (if current-prefix-arg
7914 (read-buffer "Name of indirect buffer: " (current-buffer)))
7915 t)))
7916 (if (get major-mode 'no-clone-indirect)
7917 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7918 (setq newname (or newname (buffer-name)))
7920 (setq newname (substring newname 0 (match-beginning 0))))
7921 (let* ((name (generate-new-buffer-name newname))
7922 (buffer (make-indirect-buffer (current-buffer) name t)))
7923 (with-current-buffer buffer
7924 (run-hooks 'clone-indirect-buffer-hook))
7925 (when display-flag
7926 (pop-to-buffer buffer norecord))
7927 buffer))
7930 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7931 "Like `clone-indirect-buffer' but display in another window."
7932 (interactive
7933 (progn
7934 (if (get major-mode 'no-clone-indirect)
7935 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7936 (list (if current-prefix-arg
7937 (read-buffer "Name of indirect buffer: " (current-buffer)))
7938 t)))
7939 (let ((pop-up-windows t))
7940 (clone-indirect-buffer newname display-flag norecord)))
7942 \f
7943 ;;; Handling of Backspace and Delete keys.
7945 (defcustom normal-erase-is-backspace 'maybe
7946 "Set the default behavior of the Delete and Backspace keys.
7948 If set to t, Delete key deletes forward and Backspace key deletes
7949 backward.
7951 If set to nil, both Delete and Backspace keys delete backward.
7953 If set to 'maybe (which is the default), Emacs automatically
7954 selects a behavior. On window systems, the behavior depends on
7955 the keyboard used. If the keyboard has both a Backspace key and
7956 a Delete key, and both are mapped to their usual meanings, the
7957 option's default value is set to t, so that Backspace can be used
7958 to delete backward, and Delete can be used to delete forward.
7960 If not running under a window system, customizing this option
7961 accomplishes a similar effect by mapping C-h, which is usually
7962 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7963 via `keyboard-translate'. The former functionality of C-h is
7964 available on the F1 key. You should probably not use this
7965 setting if you don't have both Backspace, Delete and F1 keys.
7967 Setting this variable with setq doesn't take effect. Programmatically,
7968 call `normal-erase-is-backspace-mode' (which see) instead."
7969 :type '(choice (const :tag "Off" nil)
7970 (const :tag "Maybe" maybe)
7971 (other :tag "On" t))
7972 :group 'editing-basics
7973 :version "21.1"
7974 :set (lambda (symbol value)
7975 ;; The fboundp is because of a problem with :set when
7976 ;; dumping Emacs. It doesn't really matter.
7977 (if (fboundp 'normal-erase-is-backspace-mode)
7978 (normal-erase-is-backspace-mode (or value 0))
7979 (set-default symbol value))))
7981 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7982 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7983 (unless frame (setq frame (selected-frame)))
7984 (with-selected-frame frame
7985 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7986 (normal-erase-is-backspace-mode
7987 (if (if (eq normal-erase-is-backspace 'maybe)
7988 (and (not noninteractive)
7989 (or (memq system-type '(ms-dos windows-nt))
7990 (memq window-system '(w32 ns))
7991 (and (memq window-system '(x))
7992 (fboundp 'x-backspace-delete-keys-p)
7993 (x-backspace-delete-keys-p))
7994 ;; If the terminal Emacs is running on has erase char
7995 ;; set to ^H, use the Backspace key for deleting
7996 ;; backward, and the Delete key for deleting forward.
7997 (and (null window-system)
7998 (eq tty-erase-char ?\^H))))
7999 normal-erase-is-backspace)
8000 1 0)))))
8002 (define-minor-mode normal-erase-is-backspace-mode
8003 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8004 With a prefix argument ARG, enable this feature if ARG is
8005 positive, and disable it otherwise. If called from Lisp, enable
8006 the mode if ARG is omitted or nil.
8008 On window systems, when this mode is on, Delete is mapped to C-d
8009 and Backspace is mapped to DEL; when this mode is off, both
8010 Delete and Backspace are mapped to DEL. (The remapping goes via
8011 `local-function-key-map', so binding Delete or Backspace in the
8012 global or local keymap will override that.)
8014 In addition, on window systems, the bindings of C-Delete, M-Delete,
8015 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8016 the global keymap in accordance with the functionality of Delete and
8017 Backspace. For example, if Delete is remapped to C-d, which deletes
8018 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8019 to DEL, which deletes backward, C-Delete is bound to
8020 `backward-kill-word'.
8022 If not running on a window system, a similar effect is accomplished by
8023 remapping C-h (normally produced by the Backspace key) and DEL via
8024 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8025 to C-d; if it's off, the keys are not remapped.
8027 When not running on a window system, and this mode is turned on, the
8028 former functionality of C-h is available on the F1 key. You should
8029 probably not turn on this mode on a text-only terminal if you don't
8030 have both Backspace, Delete and F1 keys.
8032 See also `normal-erase-is-backspace'."
8033 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8034 . (lambda (v)
8035 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8036 (if v 1 0))))
8037 (let ((enabled (eq 1 (terminal-parameter
8038 nil 'normal-erase-is-backspace))))
8040 (cond ((or (memq window-system '(x w32 ns pc))
8041 (memq system-type '(ms-dos windows-nt)))
8042 (let ((bindings
8043 `(([M-delete] [M-backspace])
8044 ([C-M-delete] [C-M-backspace])
8045 ([?\e C-delete] [?\e C-backspace]))))
8047 (if enabled
8048 (progn
8049 (define-key local-function-key-map [delete] [deletechar])
8050 (define-key local-function-key-map [kp-delete] [deletechar])
8051 (define-key local-function-key-map [backspace] [?\C-?])
8052 (dolist (b bindings)
8053 ;; Not sure if input-decode-map is really right, but
8054 ;; keyboard-translate-table (used below) only works
8055 ;; for integer events, and key-translation-table is
8056 ;; global (like the global-map, used earlier).
8057 (define-key input-decode-map (car b) nil)
8058 (define-key input-decode-map (cadr b) nil)))
8059 (define-key local-function-key-map [delete] [?\C-?])
8060 (define-key local-function-key-map [kp-delete] [?\C-?])
8061 (define-key local-function-key-map [backspace] [?\C-?])
8062 (dolist (b bindings)
8063 (define-key input-decode-map (car b) (cadr b))
8064 (define-key input-decode-map (cadr b) (car b))))))
8065 (t
8066 (if enabled
8067 (progn
8068 (keyboard-translate ?\C-h ?\C-?)
8069 (keyboard-translate ?\C-? ?\C-d))
8070 (keyboard-translate ?\C-h ?\C-h)
8071 (keyboard-translate ?\C-? ?\C-?))))
8073 (if (called-interactively-p 'interactive)
8074 (message "Delete key deletes %s"
8075 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8076 "forward" "backward")))))
8077 \f
8078 (defvar vis-mode-saved-buffer-invisibility-spec nil
8079 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8081 (define-minor-mode read-only-mode
8082 "Change whether the current buffer is read-only.
8083 With prefix argument ARG, make the buffer read-only if ARG is
8084 positive, otherwise make it writable. If buffer is read-only
8085 and `view-read-only' is non-nil, enter view mode.
8087 Do not call this from a Lisp program unless you really intend to
8089 possibly enabling or disabling View mode. Also, note that this
8090 command works by setting the variable `buffer-read-only', which
8091 does not affect read-only regions caused by text properties. To
8092 ignore read-only status in a Lisp program (whether due to text
8093 properties or buffer state), bind `inhibit-read-only' temporarily
8094 to a non-nil value."
8095 :variable buffer-read-only
8096 (cond
8097 ((and (not buffer-read-only) view-mode)
8098 (View-exit-and-edit)
8099 (make-local-variable 'view-read-only)
8100 (setq view-read-only t)) ; Must leave view mode.
8101 ((and buffer-read-only view-read-only
8102 ;; If view-mode is already active, `view-mode-enter' is a nop.
8103 (not view-mode)
8104 (not (eq (get major-mode 'mode-class) 'special)))
8105 (view-mode-enter))))
8107 (define-minor-mode visible-mode
8108 "Toggle making all invisible text temporarily visible (Visible mode).
8109 With a prefix argument ARG, enable Visible mode if ARG is
8110 positive, and disable it otherwise. If called from Lisp, enable
8111 the mode if ARG is omitted or nil.
8113 This mode works by saving the value of `buffer-invisibility-spec'
8114 and setting it to nil."
8115 :lighter " Vis"
8116 :group 'editing-basics
8117 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8118 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8119 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8120 (when visible-mode
8121 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8122 buffer-invisibility-spec)
8123 (setq buffer-invisibility-spec nil)))
8124 \f
8125 (defvar messages-buffer-mode-map
8126 (let ((map (make-sparse-keymap)))
8127 (set-keymap-parent map special-mode-map)
8128 (define-key map "g" nil) ; nothing to revert
8129 map))
8131 (define-derived-mode messages-buffer-mode special-mode "Messages"
8134 (defun messages-buffer ()
8136 If it does not exist, create and it switch it to `messages-buffer-mode'."
8137 (or (get-buffer "*Messages*")
8138 (with-current-buffer (get-buffer-create "*Messages*")
8139 (messages-buffer-mode)
8140 (current-buffer))))
8142 \f
8143 ;; Minibuffer prompt stuff.
8145 ;;(defun minibuffer-prompt-modification (start end)
8146 ;; (error "You cannot modify the prompt"))
8147 ;;
8148 ;;
8149 ;;(defun minibuffer-prompt-insertion (start end)
8150 ;; (let ((inhibit-modification-hooks t))
8151 ;; (delete-region start end)
8152 ;; ;; Discard undo information for the text insertion itself
8153 ;; ;; and for the text deletion.above.
8154 ;; (when (consp buffer-undo-list)
8155 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8156 ;; (message "You cannot modify the prompt")))
8157 ;;
8158 ;;
8159 ;;(setq minibuffer-prompt-properties
8160 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8161 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8163 \f
8164 ;;;; Problematic external packages.
8166 ;; rms says this should be done by specifying symbols that define
8167 ;; versions together with bad values. This is therefore not as
8168 ;; flexible as it could be. See the thread:
8169 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8170 (defconst bad-packages-alist
8171 ;; Not sure exactly which semantic versions have problems.
8172 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8174 "The version of `semantic' loaded does not work in Emacs 22.
8175 It can cause constant high CPU load.
8176 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8177 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8178 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8179 ;; provided the `CUA-mode' feature. Since this is no longer true,
8180 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8181 (CUA-mode t nil
8182 "CUA-mode is now part of the standard GNU Emacs distribution,
8183 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8185 You have loaded an older version of CUA-mode which does not work
8186 correctly with this version of Emacs. You should remove the old
8187 version and use the one distributed with Emacs."))
8188 "Alist of packages known to cause problems in this version of Emacs.
8189 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8190 PACKAGE is either a regular expression to match file names, or a
8191 symbol (a feature name), like for `with-eval-after-load'.
8192 SYMBOL is either the name of a string variable, or `t'. Upon
8193 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8194 warning using STRING as the message.")
8196 (defun bad-package-check (package)
8197 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8198 (condition-case nil
8199 (let* ((list (assoc package bad-packages-alist))
8200 (symbol (nth 1 list)))
8201 (and list
8202 (boundp symbol)
8203 (or (eq symbol t)
8204 (and (stringp (setq symbol (eval symbol)))
8205 (string-match-p (nth 2 list) symbol)))
8206 (display-warning package (nth 3 list) :warning)))
8207 (error nil)))
8209 (dolist (elem bad-packages-alist)
8210 (let ((pkg (car elem)))
8211 (with-eval-after-load pkg
8212 (bad-package-check pkg))))
8214 \f
8215 ;;; Generic dispatcher commands
8217 ;; Macro `define-alternatives' is used to create generic commands.
8218 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8219 ;; that can have different alternative implementations where choosing
8220 ;; among them is exclusively a matter of user preference.
8222 ;; (define-alternatives COMMAND) creates a new interactive command
8223 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8224 ;; Typically, the user will not need to customize this variable; packages
8225 ;; wanting to add alternative implementations should use
8226 ;;
8227 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8229 (defmacro define-alternatives (command &rest customizations)
8230 "Define the new command `COMMAND'.
8232 The argument `COMMAND' should be a symbol.
8234 Running `M-x COMMAND RET' for the first time prompts for which
8235 alternative to use and records the selected command as a custom
8236 variable.
8238 Running `C-u M-x COMMAND RET' prompts again for an alternative
8239 and overwrites the previous choice.
8241 The variable `COMMAND-alternatives' contains an alist with
8242 alternative implementations of COMMAND. `define-alternatives'
8243 does not have any effect until this variable is set.
8245 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8246 `defcustom' keywords and values to add to the declaration of
8247 `COMMAND-alternatives' (typically :group and :version)."
8248 (let* ((command-name (symbol-name command))
8249 (varalt-name (concat command-name "-alternatives"))
8250 (varalt-sym (intern varalt-name))
8251 (varimp-sym (intern (concat command-name "--implementation"))))
8252 `(progn
8254 (defcustom ,varalt-sym nil
8255 ,(format "Alist of alternative implementations for the `%s' command.
8257 Each entry must be a pair (ALTNAME . ALTFUN), where:
8258 ALTNAME - The name shown at user to describe the alternative implementation.
8259 ALTFUN - The function called to implement this alternative."
8260 command-name)
8261 :type '(alist :key-type string :value-type function)
8262 ,@customizations)
8264 (put ',varalt-sym 'definition-name ',command)
8265 (defvar ,varimp-sym nil "Internal use only.")
8267 (defun ,command (&optional arg)
8268 ,(format "Run generic command `%s'.
8269 If used for the first time, or with interactive ARG, ask the user which
8270 implementation to use for `%s'. The variable `%s'
8271 contains the list of implementations currently supported for this command."
8272 command-name command-name varalt-name)
8273 (interactive "P")
8274 (when (or arg (null ,varimp-sym))
8275 (let ((val (completing-read
8276 ,(format "Select implementation for command `%s': "
8277 command-name)
8278 ,varalt-sym nil t)))
8279 (unless (string-equal val "")
8280 (when (null ,varimp-sym)
8281 (message
8282 "Use `C-u M-x %s RET' to select another implementation"
8283 ,command-name)
8284 (sit-for 3))
8285 (customize-save-variable ',varimp-sym
8286 (cdr (assoc-string val ,varalt-sym))))))
8287 (if ,varimp-sym
8288 (call-interactively ,varimp-sym)
8289 (message ,(format "No implementation selected for command `%s'"
8290 command-name)))))))
8292 \f
8294 (provide 'simple)
8296 ;;; simple.el ends here