| blob | 1a4bcf124db18d6ca10a21969868628b847148ee |
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.
1260 ""
1266 pos total percent beg end col hscroll)
1268 pos total col hscroll))
1270 encoded encoding-msg display-prop under-display)
1277 ;; Check if the character is displayed with some `display'
1278 ;; text property. In that case, set under-display to the
1279 ;; buffer substring covered by that property.
1290 under-display)))
1296 char char char under-display)
1298 char char char under-display display-prop))
1301 char char char
1303 "..."
1307 ;; We show the detailed information about CHAR.
1314 bidi-fixer
1315 encoding-msg pos total percent beg end col hscroll)
1322 bidi-fixer encoding-msg pos total percent col hscroll))))))
1323 \f
1324 ;; Initialize read-expression-map. It is defined at C level.
1328 ;; Might as well bind TAB to completion, since inserting a TAB char is
1329 ;; much too rarely useful.
1332 m))
1335 "Return a Lisp object read using the minibuffer, unevaluated.
1336 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1337 is a string to insert in the minibuffer before reading.
1338 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1339 Such arguments are used as in `read-from-minibuffer'.)"
1340 ;; Used for interactive spec `x'.
1345 "Return value of Lisp expression read using the minibuffer.
1346 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1347 is a string to insert in the minibuffer before reading.
1348 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1349 Such arguments are used as in `read-from-minibuffer'.)"
1350 ;; Used for interactive spec `X'.
1358 "The current default value or list of default values in the minibuffer.
1359 The functions `read-from-minibuffer' and `completing-read' bind
1363 "Value for `print-level' while printing value in `eval-expression'.
1364 A value of nil means no limit."
1370 "Value for `print-length' while printing value in `eval-expression'.
1371 A value of nil means no limit."
1377 "If non-nil set `debug-on-error' to t in `eval-expression'.
1378 If nil, don't change the value of `debug-on-error'."
1384 "Format VALUE as a result of evaluated expression.
1385 Return a formatted string which is displayed in the echo area
1386 in addition to the value printed by prin1 in functions which
1387 display the result of expression evaluation."
1406 ;; FIXME: call emacs-lisp-mode?
1413 read-expression-map t
1416 ;; We define this, rather than making `eval' interactive,
1417 ;; for the sake of completion of names like eval-region, eval-buffer.
1419 "Evaluate EXP and print value in the echo area.
1420 When called interactively, read an Emacs Lisp expression and evaluate it.
1421 Value is also consed on to front of the variable `values'.
1422 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1423 argument) means insert the result into the current buffer instead of
1424 printing it in the echo area.
1426 Normally, this function truncates long output according to the value
1427 of the variables `eval-expression-print-length' and
1428 `eval-expression-print-level'. With a prefix argument of zero,
1429 however, there is no such truncation. Such a prefix argument
1430 also causes integers to be printed in several additional formats
1431 \(octal, hexadecimal, and character).
1433 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1434 minibuffer.
1436 If `eval-expression-debug-on-error' is non-nil, which is the default,
1437 this command arranges for all errors to enter the debugger."
1440 current-prefix-arg))
1445 ;; Bind debug-on-error to something unique so that we can
1446 ;; detect when evalled code changes it.
1450 ;; If evalled code has changed the value of debug-on-error,
1451 ;; propagate that change to the global binding.
1456 eval-expression-print-length))
1458 eval-expression-print-level))
1474 "Prompting with PROMPT, let user edit COMMAND and eval result.
1475 COMMAND is a Lisp expression. Let user edit that expression in
1476 the minibuffer, then read and evaluate the result."
1483 read-expression-map t
1485 ;; If command was added to command-history as a string,
1486 ;; get rid of that. We want only evaluable expressions there.
1490 ;; If command to be redone does not match front of history,
1491 ;; add it to the history.
1497 "Edit and re-evaluate last complex command, or ARGth from last.
1498 A complex command is one which used the minibuffer.
1499 The command is placed in the minibuffer as a Lisp form for editing.
1500 The result is executed, repeating the command as changed.
1501 If the command has been changed or is not the most recent previous
1502 command it is added to the front of the command history.
1503 You can use the minibuffer history commands \
1505 to get different commands to edit and resubmit."
1508 newcmd)
1520 ;; If command was added to command-history as a
1521 ;; string, get rid of that. We want only
1522 ;; evaluable expressions there.
1526 ;; If command to be redone does not match front of history,
1527 ;; add it to the history.
1542 "Read command name to invoke in `execute-extended-command'."
1552 ;; Get a command name at point in the original buffer
1553 ;; to propose it after M-n.
1557 ;; Read a string, completing from and restricting to the set of
1558 ;; all defined commands. Don't provide any initial input.
1559 ;; Save the command read on the extended-command history list.
1570 ;; This isn't strictly correct if `execute-extended-command'
1571 ;; is bound to anything else (e.g. [menu]).
1572 ;; It could use (key-description (this-single-command-keys)),
1573 ;; but actually a prompt other than "M-x" would be confusing,
1574 ;; because "M-x" is a well-known prompt to read a command
1575 ;; and it serves as a shorthand for "Extended command: ".
1580 ;; Exclude obsolete commands from completions.
1585 pred)))
1590 "Non-nil means show the equivalent key-binding when M-x command has one.
1591 The value can be a length of time to show the message for.
1592 If the value is non-nil and not a number, we wait 2 seconds."
1614 binding)
1620 name len)))
1621 ;; Don't show the help message if the binding isn't
1622 ;; significantly shorter than the M-x command the user typed.
1629 binding))
1632 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1633 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1634 "Read a command name, then read the arguments and call the command.
1635 To pass a prefix argument to the command you are
1636 invoking, give a prefix argument to `execute-extended-command'."
1638 ;; FIXME: Remember the actual text typed by the user before completion,
1639 ;; so that we don't later on suggest the same shortening.
1644 execute-extended-command--last-typed)))
1645 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1658 ;; Normally `real-this-command' should never be changed, but here we really
1659 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1660 ;; binding" for <cmd>, so the command the user really wanted to run is
1661 ;; `function' and not `execute-extended-command'. The difference is
1662 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1666 ;; If enabled, show which key runs this command.
1667 ;; But first wait, and skip the message if there is input.
1669 ;; If this command displayed something in the echo area;
1670 ;; wait a few seconds, then display our suggestion message.
1671 ;; FIXME: Wait *after* running post-command-hook!
1672 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1673 ;; find a better answer anyway!
1682 ;; There's no binding for CMD. Let's try and find the shortest
1683 ;; string to use in M-x.
1684 ;; FIXME: Can be slow. Cache it maybe?
1691 function
1696 suggest-key-bindings
1700 ;; BEWARE: Called directly from the C code.
1701 "Execute CMD as an editor command.
1702 CMD must be a symbol that satisfies the `commandp' predicate.
1703 Optional second arg RECORD-FLAG non-nil
1704 means unconditionally put this command in the variable `command-history'.
1705 Otherwise, that is done only if an arg is read using the minibuffer.
1706 The argument KEYS specifies the value to use instead of (this-command-keys)
1707 when reading the arguments; if it is nil, (this-command-keys) is used.
1708 The argument SPECIAL, if non-nil, means that this command is executing
1709 a special event, so ignore the prefix argument and don't clear it."
1717 disabled-command-function)
1718 ;; FIXME: Weird calling convention!
1728 ;; If requested, place the macro in the command history. For
1729 ;; other sorts of commands, call-interactively takes care of this.
1732 ;; Don't keep command history around forever.
1738 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1746 \f
1748 "Default minibuffer history list.
1749 This is used for all minibuffer input
1750 except when an alternate history list is specified.
1752 Maximum length of the history list is determined by the value
1755 "Control whether history list elements are expressions or strings.
1756 If the value of this variable equals current minibuffer depth,
1757 they are expressions; otherwise they are strings.
1758 \(That convention is designed to do the right thing for
1765 "Text that was in this minibuffer before any history commands.
1766 This is nil if there have not yet been any history commands
1775 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1780 "Minibuffer history variables for which matching should ignore case.
1781 If a history variable is a member of this list, then the
1783 commands ignore case when searching it, regardless of `case-fold-search'."
1788 "Find the previous history element that matches REGEXP.
1789 \(Previous history elements refer to earlier actions.)
1790 With prefix argument N, search for Nth previous match.
1791 If N is negative, find the next or Nth next match.
1792 Normally, history elements are matched case-insensitively if
1793 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1794 makes the search case-sensitive.
1795 See also `minibuffer-history-case-insensitive-variables'."
1799 nil
1800 minibuffer-local-map
1801 nil
1802 'minibuffer-history-search-history
1804 ;; Use the last regexp specified, by default, if input is empty.
1809 regexp)
1819 ;; On some systems, ignore case for file names.
1821 minibuffer-history-case-insensitive-variables)
1822 t
1823 ;; Respect the user's setting for case-fold-search:
1824 case-fold-search)
1825 nil))
1826 prevpos
1827 match-string
1828 match-offset
1835 "No later matching history item"
1856 next-matching-history-element))
1860 "Find the next history element that matches REGEXP.
1861 \(The next history element refers to a more recent action.)
1862 With prefix argument N, search for Nth next match.
1863 If N is negative, find the previous or Nth previous match.
1864 Normally, history elements are matched case-insensitively if
1865 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1866 makes the search case-sensitive."
1870 nil
1871 minibuffer-local-map
1872 nil
1873 'minibuffer-history-search-history
1875 ;; Use the last regexp specified, by default, if input is empty.
1880 regexp)
1887 "Function run by `goto-history-element' before consuming default values.
1888 This is useful to dynamically add more elements to the list of default values
1889 when `goto-history-element' reaches the end of this list.
1890 Before calling this function `goto-history-element' sets the variable
1891 `minibuffer-default-add-done' to t, so it will call this function only
1892 once. In special cases, when this function needs to be called more
1893 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1897 "When nil, add more elements to the end of the list of default values.
1898 The value nil causes `goto-history-element' to add more elements to
1899 the list of defaults when it reaches the end of this list. It does
1905 "Return a list of all completions without the default value.
1906 This function is used to add all elements of the completion table to
1907 the end of the list of defaults just after the default value."
1910 minibuffer-completion-table
1911 minibuffer-completion-predicate)))
1917 "Puts element of the minibuffer history in the minibuffer.
1918 The argument NABS specifies the absolute history position."
1932 elt minibuffer-returned-to-present)
1939 "End of defaults; no next item"
1946 previous-history-element))
1958 minibuffer-default)))
1970 elt))
1974 "Puts next element of the minibuffer history in the minibuffer.
1975 With argument N, it uses the Nth following element."
1981 "Puts previous element of the minibuffer history in the minibuffer.
1982 With argument N, it uses the Nth previous element."
1988 "Move cursor vertically down ARG lines, or to the next history element.
1989 When point moves over the bottom line of multi-line minibuffer, puts ARGth
1990 next element of the minibuffer history in the minibuffer."
1994 ;; Remember the original goal column of possibly multi-line input
1995 ;; excluding the length of the prompt on the first line.
2005 ;; Restore old position since `line-move-visual' moves point to
2006 ;; the end of the line when it fails to go to the next line.
2009 ;; Restore the original goal column on the last line
2010 ;; of possibly multi-line input.
2018 "Move cursor vertically up ARG lines, or to the previous history element.
2019 When point moves over the top line of multi-line minibuffer, puts ARGth
2020 previous element of the minibuffer history in the minibuffer."
2024 ;; Remember the original goal column of possibly multi-line input
2025 ;; excluding the length of the prompt on the first line.
2035 ;; Restore old position since `line-move-visual' moves point to
2036 ;; the beginning of the line when it fails to go to the previous line.
2039 ;; Restore the original goal column on the first line
2040 ;; of possibly multi-line input.
2049 "Get next history element which completes the minibuffer before the point.
2050 The contents of the minibuffer after the point are deleted, and replaced
2051 by the new completion."
2057 n)
2058 ;; next-matching-history-element always puts us at (point-min).
2059 ;; Move to the position we were at before changing the buffer contents.
2060 ;; This is still sensible, because the text before point has not changed.
2064 "\
2065 Get previous history element which completes the minibuffer before the point.
2066 The contents of the minibuffer after the point are deleted, and replaced
2067 by the new completion."
2071 ;; For compatibility with the old subr of the same name.
2073 "Return the display width of the minibuffer prompt.
2074 Return 0 if current buffer is not a minibuffer."
2075 ;; Return the width of everything before the field at the end of
2076 ;; the buffer; this should be 0 for normal buffers.
2078 \f
2079 ;; isearch minibuffer history
2086 "Set up a minibuffer for using isearch to search the minibuffer history.
2087 Intended to be added to `minibuffer-setup-hook'."
2099 "Clean up the minibuffer after terminating isearch in the minibuffer."
2104 "Return the proper search function, for isearch in minibuffer history."
2107 ;; Use standard functions to search within minibuffer text
2109 found)
2110 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2111 ;; searching forward. Lazy-highlight calls this lambda with the
2112 ;; bound arg, so skip the minibuffer prompt.
2116 ;; 1. First try searching in the initial minibuffer text
2119 noerror)
2120 ;; 2. If the above search fails, start putting next/prev history
2121 ;; elements in the minibuffer successively, and search the string
2122 ;; in them. Do this only when bound is nil (i.e. not while
2123 ;; lazy-highlighting search strings in the current minibuffer text).
2135 ;; After putting the next/prev history element, search
2136 ;; the string in them again, until next-history-element
2137 ;; or previous-history-element raises an error at the
2138 ;; beginning/end of history.
2141 ;; For backward search, don't search
2142 ;; in the minibuffer prompt
2144 noerror)))
2145 ;; Return point of the new search result
2147 ;; Return nil when next(prev)-history-element fails
2151 "Display the minibuffer history search prompt.
2152 If there are no search errors, this function displays an overlay with
2153 the isearch prompt which replaces the original minibuffer prompt.
2154 Otherwise, it displays the standard isearch message returned from
2155 the function `isearch-message'."
2157 ;; Use standard function `isearch-message' when not in the minibuffer,
2158 ;; or search fails, or has an error (like incomplete regexp).
2159 ;; This function overwrites minibuffer text with isearch message,
2160 ;; so it's possible to see what is wrong in the search string.
2162 ;; Otherwise, put the overlay with the standard isearch prompt over
2163 ;; the initial minibuffer prompt.
2172 ;; And clear any previous isearch message.
2176 "Wrap the minibuffer history search when search fails.
2177 Move point to the first history element for a forward search,
2178 or to the last history element for a backward search."
2179 ;; When `minibuffer-history-isearch-search' fails on reaching the
2180 ;; beginning/end of the history, wrap the search to the first/last
2181 ;; minibuffer history element.
2189 "Save a function restoring the state of minibuffer history search.
2190 Save `minibuffer-history-position' to the additional state parameter
2191 in the search status stack."
2197 "Restore the minibuffer history search state.
2198 Go to the history element by the absolute history position HIST-POS."
2201 \f
2202 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2206 "Table mapping redo records to the corresponding undo one.
2207 A redo record for undo-in-region maps to t.
2217 "Within a run of consecutive undo commands, list remaining to be undone.
2221 "Undo some previous changes.
2222 Repeat this command to undo more changes.
2223 A numeric ARG serves as a repeat count.
2225 In Transient Mark mode when the mark is active, only undo changes within
2227 as an argument limits undo to changes within the current region."
2229 ;; Make last-command indicate for the next command that this was an undo.
2230 ;; That way, another undo will undo more.
2231 ;; If we get to the end of the undo history and get an error,
2232 ;; another undo command will find the undo history empty
2233 ;; and will get another error. To begin undoing the undos,
2234 ;; you must type some other command.
2236 ;; For an indirect buffer, look in the base buffer for the
2237 ;; auto-save data.
2241 message)
2242 ;; If we get an error in undo-start,
2243 ;; the next command should not be a "consecutive undo".
2244 ;; So set `this-command' to something other than `undo'.
2249 ;; If something (a timer or filter?) changed the buffer
2250 ;; since the previous command, don't continue the undo seq.
2254 ;; If the last undo record made was made by undo
2255 ;; it shows nothing else happened in between.
2262 ;; get rid of initial undo boundary
2264 ;; If we got this far, the next command should be a consecutive undo.
2266 ;; Check to see whether we're hitting a redo record, and if
2267 ;; so, ask the user whether she wants to skip the redo/undo pair.
2275 ;; The equiv entry might point to another redo record if we have done
2276 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2284 ;; Record the fact that the just-generated undo records come from an
2285 ;; undo operation--that is, they are redo records.
2286 ;; In the ordinary case (not within a region), map the redo
2287 ;; record to the following undos.
2288 ;; I don't know how to do that in the undo-in-region case.
2290 ;; Strip any leading undo boundaries there might be, like we do
2291 ;; above when checking.
2295 ;; Prevent identity mapping. This can happen if
2296 ;; consecutive nils are erroneously in undo list.
2298 t
2299 pending-undo-list)
2300 undo-equiv-table))
2301 ;; Don't specify a position in the undo record for the undo command.
2302 ;; Instead, undoing this should move point to where the change is.
2321 ;; Record what the current undo list says,
2322 ;; so the next command can tell if the buffer was modified in between.
2326 ;; Display a message announcing success.
2331 "Make BUFFER stop keeping undo information.
2332 No argument or nil as argument means do this for the current buffer."
2338 "Undo some previous changes.
2339 Repeat this command to undo more changes.
2340 A numeric ARG serves as a repeat count.
2341 Contrary to `undo', this will not redo a previous undo."
2346 "Non-nil while performing an undo.
2350 "Undo back N undo-boundaries beyond what was already undone recently.
2351 Call `undo-start' to get ready to undo recent changes,
2352 then call `undo-more' one or more times to undo them."
2357 ;; Note: The following, while pulling elements off
2358 ;; `pending-undo-list' will call primitive change functions which
2359 ;; will push more elements onto `buffer-undo-list'.
2365 "Undo N records from the front of the list LIST.
2366 Return what remains of the list."
2368 ;; This is a good feature, but would make undo-start
2369 ;; unable to do what is expected.
2370 ;;(when (null (car (list)))
2371 ;; ;; If the head of the list is a boundary, it is the boundary
2372 ;; ;; preceding this command. Get rid of it and don't count it.
2373 ;; (setq list (cdr list))))
2376 ;; In a writable buffer, enable undoing read-only text that is
2377 ;; so because of text properties.
2379 ;; Don't let `intangible' properties interfere with undo.
2381 ;; We use oldlist only to check for EQ. ++kfs
2387 ;; Handle an integer by setting point to that value.
2390 ;; Element (t . TIME) records previous modtime.
2391 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2392 ;; UNKNOWN_MODTIME_NSECS.
2394 ;; If this records an obsolete save
2395 ;; (not matching the actual disk file)
2396 ;; then don't mark unmodified.
2404 ;; Element (nil PROP VAL BEG . END) is property change.
2409 ;; Element (BEG . END) means range was inserted.
2411 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2412 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2415 ;; Set point first thing, so that undoing this undo
2416 ;; does not send point back to where it is now.
2419 ;; Element (apply FUN . ARGS) means call FUN to undo.
2423 ;; Long format: (apply DELTA START END FUN . ARGS).
2430 ;; Check that the function did what the entry
2431 ;; said it would do.
2441 ;; Element (STRING . POS) means STRING was deleted.
2447 ;; Check that marker adjustments which were recorded
2448 ;; with the (STRING . POS) record are still valid, ie
2449 ;; the markers haven't moved. We check their validity
2450 ;; before reinserting the string so as we don't need to
2451 ;; mind marker insertion-type.
2459 ;; Insert string and adjust point
2467 ;; Adjust the valid marker adjustments
2471 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2474 next)
2475 ;; Even though these elements are not expected in the undo
2476 ;; list, adjust them to be conservative for the 24.4
2477 ;; release. (Bug#16818)
2484 ;; Make sure an apply entry produces at least one undo entry,
2485 ;; so the test in `undo' for continuing an undo series
2486 ;; will work right.
2491 list)
2493 ;; Deep copy of a list
2495 "Make a copy of undo list LIST."
2501 elt))
2504 "Set `pending-undo-list' to the front of the undo list.
2505 The next call to `undo-more' will undo the most recently made change.
2506 If BEG and END are specified, then only undo elements
2507 that apply to text between BEG and END are used; other undo elements
2508 are ignored. If BEG and END are nil, all undo elements are used."
2514 buffer-undo-list)))
2516 ;; The positions given in elements of the undo list are the positions
2517 ;; as of the time that element was recorded to undo history. In
2518 ;; general, subsequent buffer edits render those positions invalid in
2519 ;; the current buffer, unless adjusted according to the intervening
2520 ;; undo elements.
2521 ;;
2522 ;; Undo in region is a use case that requires adjustments to undo
2523 ;; elements. It must adjust positions of elements in the region based
2524 ;; on newer elements not in the region so as they may be correctly
2525 ;; applied in the current buffer. undo-make-selective-list
2526 ;; accomplishes this with its undo-deltas list of adjustments. An
2527 ;; example undo history from oldest to newest:
2528 ;;
2529 ;; buf pos:
2530 ;; 123456789 buffer-undo-list undo-deltas
2531 ;; --------- ---------------- -----------
2532 ;; aaa (1 . 4) (1 . -3)
2533 ;; aaba (3 . 4) N/A (in region)
2534 ;; ccaaba (1 . 3) (1 . -2)
2535 ;; ccaabaddd (7 . 10) (7 . -3)
2536 ;; ccaabdd ("ad" . 6) (6 . 2)
2537 ;; ccaabaddd (6 . 8) (6 . -2)
2538 ;; | |<-- region: "caab", from 2 to 6
2539 ;;
2540 ;; When the user starts a run of undos in region,
2541 ;; undo-make-selective-list is called to create the full list of in
2542 ;; region elements. Each element is adjusted forward chronologically
2543 ;; through undo-deltas to determine if it is in the region.
2544 ;;
2545 ;; In the above example, the insertion of "b" is (3 . 4) in the
2546 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2547 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2548 ;; . 6) is assessed as in the region and placed in the selective list.
2549 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2550 ;; due to the selected element. The "b" insertion is the only element
2551 ;; fully in the region, so in this example undo-make-selective-list
2552 ;; returns (nil (5 . 6)).
2553 ;;
2554 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2555 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2556 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2557 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2558 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2559 ;;
2560 ;; More interesting is how to adjust the "ddd" insertion due to the
2561 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2562 ;; If the reinsertion was a manual retyping of "ad", then the total
2563 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2564 ;; the reinsertion was due to undo, one might expect the first "d"
2565 ;; character would again be a part of the "ddd" text, meaning its
2566 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2567 ;;
2568 ;; undo-make-selective-list assumes in this situation that "ad" was a
2569 ;; new edit, even if it was inserted because of an undo.
2570 ;; Consequently, if the user undos in region "8 to 10" of the
2571 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2572 ;; "ccaabad", as though the first "d" became detached from the
2573 ;; original "ddd" insertion. This quirk is a FIXME.
2576 "Return a list of undo elements for the region START to END.
2577 The elements come from `buffer-undo-list', but we keep only the
2578 elements inside this region, and discard those outside this
2579 region. The elements' positions are adjusted so as the returned
2580 list can be applied to the current buffer."
2582 ;; A list of position adjusted undo elements in the region.
2584 ;; A list of undo-deltas for out of region undo elements.
2585 undo-deltas
2586 undo-elt)
2594 ;; Don't put two nils together in the list
2598 ;; This is a "was unmodified" element. Keep it
2599 ;; if we have kept everything thus far.
2602 ;; Skip over marker adjustments, instead relying
2603 ;; on finding them after (TEXT . POS) elements
2605 nil)
2608 undo-deltas)))
2613 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2614 ;; kept. primitive-undo may discard them later.
2627 "Determine whether UNDO-ELT falls inside the region START ... END.
2628 If it crosses the edge, we return nil.
2630 Generally this function is not useful for determining
2631 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2632 because markers can be arbitrarily relocated. Instead, pass the
2633 marker adjustment's corresponding (TEXT . POS) element."
2638 t)
2640 nil)
2642 ;; (TEXT . POSITION)
2646 ;; (MARKER . ADJUSTMENT)
2649 ;; (nil PROPERTY VALUE BEG . END)
2654 ;; (BEGIN . END)
2659 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2660 This assumes we have already decided that UNDO-ELT
2661 is not *inside* the region START...END."
2665 ;; (nil PROPERTY VALUE BEG . END)
2670 ;; (BEGIN . END)
2675 "Return adjustment of undo element ELT by the undo DELTAS
2676 list."
2678 ;; POSITION
2681 ;; (BEG . END)
2684 ;; (TEXT . POSITION)
2688 ;; (nil PROPERTY VALUE BEG . END)
2691 ;; (apply DELTA START END FUN . ARGS)
2692 ;; FIXME
2693 ;; All others return same elt
2696 ;; (BEG . END) can adjust to the same positions, commonly when an
2697 ;; insertion was undone and they are out of region, for example:
2698 ;;
2699 ;; buf pos:
2700 ;; 123456789 buffer-undo-list undo-deltas
2701 ;; --------- ---------------- -----------
2702 ;; [...]
2703 ;; abbaa (2 . 4) (2 . -2)
2704 ;; aaa ("bb" . 2) (2 . 2)
2705 ;; [...]
2706 ;;
2707 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2708 ;; undo. Further adjustments to such an element should be the same as
2709 ;; for (TEXT . POSITION) elements. The options are:
2710 ;;
2711 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2712 ;; analogous to marker insertion-type t.
2713 ;;
2714 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2715 ;; marker insertion-type nil.
2716 ;;
2717 ;; There was no strong reason to prefer one or the other, except that
2718 ;; the first is more consistent with prior undo in region behavior.
2720 "Return cons of adjustments to BEG and END by the undo DELTAS
2721 list."
2723 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2728 "Return adjustment of POS by the undo DELTAS list, comparing
2729 with < or <= based on USE-<."
2735 ;; Don't allow pos to become less than the undo-delta
2736 ;; position. This edge case is described in the overview
2737 ;; comments.
2740 ;; Return the first affected buffer position and the delta for an undo element
2741 ;; delta is defined as the change in subsequent buffer positions if we *did*
2742 ;; the undo.
2746 ;; (TEXT . POSITION)
2749 ;; (BEGIN . END)
2756 "If non-nil ask about discarding undo info for the current command.
2757 Normally, Emacs discards the undo info for the current command if
2758 it exceeds `undo-outer-limit'. But if you set this option
2759 non-nil, it asks in the echo area whether to discard the info.
2760 If you answer no, there is a slight risk that Emacs might crash, so
2761 only do it if you really want to undo the command.
2763 This option is mainly intended for debugging. You have to be
2764 careful if you use it for other purposes. Garbage collection is
2765 inhibited while the question is asked, meaning that Emacs might
2766 leak memory. So you should make sure that you do not wait
2767 excessively long before answering the question."
2773 "If non-nil, an extra level of size that's ok in an undo item.
2774 We don't ask the user about truncating the undo list until the
2775 current item gets bigger than this amount.
2780 ;; When the first undo batch in an undo list is longer than
2781 ;; undo-outer-limit, this function gets called to warn the user that
2782 ;; the undo info for the current command was discarded. Garbage
2783 ;; collection is inhibited around the call, so it had better not do a
2784 ;; lot of consing.
2790 ;; Don't ask the question again unless it gets even bigger.
2791 ;; This applies, in particular, if the user quits from the question.
2792 ;; Such a quit quits out of GC, but something else will call GC
2793 ;; again momentarily. It will call this function again,
2794 ;; but we don't want to ask the question again.
2801 t)
2802 nil))
2807 "The undo info was discarded because it exceeded \
2808 `undo-outer-limit'.
2810 This is normal if you executed a command that made a huge change
2811 to the buffer. In that case, to prevent similar problems in the
2812 future, set `undo-outer-limit' to a value that is large enough to
2813 cover the maximum size of normal changes you expect a single
2814 command to make, but not so large that it might exceed the
2815 maximum memory allotted to Emacs.
2817 If you did not execute any such command, the situation is
2818 probably due to a bug and you should report it.
2820 You can disable the popping up of this buffer by adding the entry
2821 \(undo discard-info) to the user option `warning-suppress-types',
2825 t))
2826 \f
2829 ; These are sorted according to the GNU en_US locale.
2872 )
2874 This is used by Shell mode and other parts of Emacs to recognize
2875 password prompts, including prompts in languages other than
2876 English. Different case choices should not be assumed to be
2877 included; callers should bind `case-fold-search' to t."
2883 "History list for some commands that read shell commands.
2885 Maximum length of the history list is determined by the value
2892 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2893 This buffer is used when `shell-command' or `shell-command-on-region'
2894 is run interactively. A value of nil means that output to stderr and
2901 "Return a list of all commands associated with the current file.
2902 This function is used to add all related commands retrieved by `mailcap'
2903 to the end of the list of defaults just after the default value."
2907 minibuffer-default))
2912 commands))
2923 map)
2927 "Read a shell command from the minibuffer.
2928 The arguments are the same as the ones of `read-from-minibuffer',
2929 except READ and KEYMAP are missing and HIST defaults
2930 to `shell-command-history'."
2938 minibuffer-local-shell-command-map
2939 nil
2941 args)))
2944 "What to do when the output buffer is used by another shell command.
2945 This option specifies how to resolve the conflict where a new command
2946 wants to direct its output to the buffer `*Async Shell Command*',
2947 but this buffer is already taken by another running shell command.
2949 The value `confirm-kill-process' is used to ask for confirmation before
2950 killing the already running process and running a new process
2951 in the same buffer, `confirm-new-buffer' for confirmation before running
2952 the command in a new buffer with a name other than the default buffer name,
2953 `new-buffer' for doing the same without confirmation,
2954 `confirm-rename-buffer' for confirmation before renaming the existing
2955 output buffer and running a new command in the default buffer,
2956 `rename-buffer' for doing the same without confirmation."
2958 confirm-kill-process)
2960 confirm-new-buffer)
2962 new-buffer)
2964 confirm-rename-buffer)
2966 rename-buffer))
2971 "Execute string COMMAND asynchronously in background.
2973 Like `shell-command', but adds `&' at the end of COMMAND
2974 to execute it asynchronously.
2976 The output appears in the buffer `*Async Shell Command*'.
2977 That buffer is in shell mode.
2979 You can configure `async-shell-command-buffer' to specify what to do in
2980 case when `*Async Shell Command*' buffer is already taken by another
2981 running shell command. To run COMMAND without displaying the output
2982 in a window you can configure `display-buffer-alist' to use the action
2983 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
2985 In Elisp, you will often be better served by calling `start-process'
2986 directly, since it offers more control and does not impose the use of a
2987 shell (with its need to quote arguments)."
2997 current-prefix-arg
2998 shell-command-default-error-buffer))
3004 "Execute string COMMAND in inferior shell; display output, if any.
3005 With prefix argument, insert the COMMAND's output at point.
3007 If COMMAND ends in `&', execute it asynchronously.
3008 The output appears in the buffer `*Async Shell Command*'.
3009 That buffer is in shell mode. You can also use
3010 `async-shell-command' that automatically adds `&'.
3012 Otherwise, COMMAND is executed synchronously. The output appears in
3013 the buffer `*Shell Command Output*'. If the output is short enough to
3014 display in the echo area (which is determined by the variables
3015 `resize-mini-windows' and `max-mini-window-height'), it is shown
3016 there, but it is nonetheless available in buffer `*Shell Command
3017 Output*' even though that buffer is not automatically displayed.
3019 To specify a coding system for converting non-ASCII characters
3021 before this command.
3023 Noninteractive callers can specify coding systems by binding
3024 `coding-system-for-read' and `coding-system-for-write'.
3026 The optional second argument OUTPUT-BUFFER, if non-nil,
3027 says to put the output in some other buffer.
3028 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
3029 If OUTPUT-BUFFER is not a buffer and not nil,
3030 insert output in current buffer. (This cannot be done asynchronously.)
3031 In either case, the buffer is first erased, and the output is
3032 inserted after point (leaving mark after it).
3034 If the command terminates without error, but generates output,
3036 the output can be displayed in the echo area or in its buffer.
3037 If the output is short enough to display in the echo area
3038 \(determined by the variable `max-mini-window-height' if
3039 `resize-mini-windows' is non-nil), it is shown there.
3040 Otherwise,the buffer containing the output is displayed.
3044 of the output.
3046 If there is no output, or if output is inserted in the current buffer,
3047 then `*Shell Command Output*' is deleted.
3049 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3050 or buffer name to which to direct the command's standard error output.
3051 If it is nil, error output is mingled with regular output.
3052 In an interactive call, the variable `shell-command-default-error-buffer'
3053 specifies the value of ERROR-BUFFER.
3055 In Elisp, you will often be better served by calling `call-process' or
3056 `start-process' directly, since it offers more control and does not impose
3057 the use of a shell (with its need to quote arguments)."
3068 current-prefix-arg
3069 shell-command-default-error-buffer))
3070 ;; Look for a handler in case default-directory is a remote file name.
3078 ;; Output goes in current buffer.
3084 temporary-file-directory)))
3085 nil)))
3088 ;; We do not use -f for csh; we will not support broken use of
3089 ;; .cshrcs. Even the BSD csh manual says to use
3090 ;; "if ($?prompt) exit" before things which are not useful
3091 ;; non-interactively. Besides, if someone wants their other
3092 ;; aliases for shell commands then they can still have them.
3096 t)
3097 nil shell-command-switch command)
3104 ;; Do no formatting while reading error file,
3105 ;; because that can run a shell command, and we
3106 ;; don't want that to cause an infinite recursion.
3108 ;; Put point after the inserted errors.
3112 ;; This is like exchange-point-and-mark, but doesn't
3113 ;; activate the mark. It is cleaner to avoid activation,
3114 ;; even though the command loop would deactivate the mark
3115 ;; because we inserted text.
3119 ;; Output goes in a separate buffer.
3120 ;; Preserve the match data in case called from a program.
3123 ;; Command ending with ampersand means asynchronous.
3127 proc)
3128 ;; Remove the ampersand.
3130 ;; Ask the user what to do with already running process.
3135 ;; If will kill a process, query first.
3140 ;; If will create a new buffer, query first.
3147 ;; It will create a new buffer.
3152 ;; If will rename the buffer, query first.
3161 ;; It will rename the buffer.
3168 ;; Setting buffer-read-only to nil doesn't suffice
3169 ;; if some text has a non-nil read-only property,
3170 ;; which comint sometimes adds for prompts.
3176 shell-command-switch command))
3180 ;; Use the comint filter for proper handling of carriage motion
3181 ;; (see `comint-inhibit-carriage-motion'),.
3183 ))
3184 ;; Otherwise, command is executed synchronously.
3186 output-buffer nil error-buffer)))))))
3190 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3191 MESSAGE may be either a string or a buffer.
3193 A buffer is displayed using `display-buffer' if MESSAGE is too long for
3194 the maximum height of the echo area, as defined by `max-mini-window-height'
3195 if `resize-mini-windows' is non-nil.
3197 Returns either the string shown in the echo area, or when a pop-up
3198 buffer is used, the window used to display it.
3200 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3201 name of the buffer used to display it in the case where a pop-up buffer
3202 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3203 string and it is displayed in the echo area, it is not specified whether
3204 the contents are inserted into the buffer anyway.
3206 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
3207 and only used if a buffer is displayed."
3209 ;; Trivial case where we can use the echo area
3213 ;; Trivial case where we can just remove single trailing newline
3216 ;; General case
3219 message
3228 0
3232 (<= lines
3236 max-mini-window-height))
3238 max-mini-window-height)
3242 ;; Don't use the echo area if the output buffer is
3243 ;; already displayed in the selected frame.
3245 ;; Echo area
3251 ;; Buffer
3254 not-this-window frame))))))))
3257 ;; We have a sentinel to prevent insertion of a termination message
3258 ;; in the buffer itself.
3266 &optional output-buffer replace
3267 error-buffer display-error-buffer)
3268 "Execute string COMMAND in inferior shell with region as input.
3269 Normally display output (if any) in temp buffer `*Shell Command Output*';
3270 Prefix arg means replace the region with it. Return the exit code of
3271 COMMAND.
3273 To specify a coding system for converting non-ASCII characters
3275 before this command. By default, the input (from the current buffer)
3276 is encoded using coding-system specified by `process-coding-system-alist',
3277 falling back to `default-process-coding-system' if no match for COMMAND
3278 is found in `process-coding-system-alist'.
3280 Noninteractive callers can specify coding systems by binding
3281 `coding-system-for-read' and `coding-system-for-write'.
3283 If the command generates output, the output may be displayed
3284 in the echo area or in a buffer.
3285 If the output is short enough to display in the echo area
3286 \(determined by the variable `max-mini-window-height' if
3287 `resize-mini-windows' is non-nil), it is shown there.
3288 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3289 The output is available in that buffer in both cases.
3291 If there is output and an error, a message about the error
3292 appears at the end of the output. If there is no output, or if
3293 output is inserted in the current buffer, the buffer `*Shell
3294 Command Output*' is deleted.
3296 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3297 command's output. If the value is a buffer or buffer name,
3298 put the output there. If the value is nil, use the buffer
3299 `*Shell Command Output*'. Any other value, excluding nil,
3300 means to insert the output in the current buffer. In either case,
3301 the output is inserted after point (leaving mark after it).
3303 Optional fifth arg REPLACE, if non-nil, means to insert the
3304 output in place of text from START to END, putting point and mark
3305 around it.
3307 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3308 or buffer name to which to direct the command's standard error
3309 output. If nil, error output is mingled with regular output.
3310 When called interactively, `shell-command-default-error-buffer'
3311 is used for ERROR-BUFFER.
3313 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3314 display the error buffer if there were any errors. When called
3315 interactively, this is t."
3319 ;; Do this before calling region-beginning
3320 ;; and region-end, in case subprocess output
3321 ;; relocates them while we are in the minibuffer.
3323 ;; call-interactively recognizes region-beginning and
3324 ;; region-end specially, leaving them in the history.
3326 string
3327 current-prefix-arg
3328 current-prefix-arg
3329 shell-command-default-error-buffer
3330 t)))
3336 temporary-file-directory)))
3337 nil))
3338 exit-status)
3342 ;; Replace specified region with output from command.
3344 ;; Don't muck with mark unless REPLACE says we should.
3351 t)
3352 nil shell-command-switch command))
3353 ;; It is rude to delete a buffer which the command is not using.
3354 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3355 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3356 ;; (kill-buffer shell-buffer)))
3357 ;; Don't muck with mark unless REPLACE says we should.
3359 ;; No prefix argument: put the output in a temp buffer,
3360 ;; replacing its entire contents.
3365 ;; If the input is the same buffer as the output,
3366 ;; delete everything but the specified region,
3367 ;; then replace that region with the output.
3373 shell-file-name t
3376 t)
3377 nil shell-command-switch
3378 command)))
3379 ;; Clear the output buffer, then run the command with
3380 ;; output there.
3391 buffer)
3392 nil shell-command-switch command)))
3393 ;; Report the output.
3403 ;; There's some output, display it
3405 ;; No output; error?
3412 shell-command-default-error-buffer)
3419 output))
3422 exit-status))
3425 exit-status output))))
3426 ;; Don't kill: there might be useful info in the undo-log.
3427 ;; (kill-buffer buffer)
3428 ))))
3436 ;; Do no formatting while reading error file,
3437 ;; because that can run a shell command, and we
3438 ;; don't want that to cause an infinite recursion.
3440 ;; Put point after the inserted errors.
3445 exit-status))
3448 "Execute shell command COMMAND and return its output as a string."
3451 standard-output
3455 "Process files synchronously in a separate process.
3456 Similar to `call-process', but may invoke a file handler based on
3457 `default-directory'. The current working directory of the
3458 subprocess is `default-directory'.
3460 File names in INFILE and BUFFER are handled normally, but file
3461 names in ARGS should be relative to `default-directory', as they
3462 are passed to the process verbatim. (This is a difference to
3463 `call-process' which does not support file handlers for INFILE
3464 and BUFFER.)
3466 Some file handlers might not support all variants, for example
3467 they might behave as if DISPLAY was nil, regardless of the actual
3468 value passed."
3470 lc stderr-file)
3480 display args)
3486 "Whether a call of `process-file' changes remote files.
3488 By default, this variable is always set to t, meaning that a
3489 call of `process-file' could potentially change any file on a
3490 remote host. When set to nil, a file handler could optimize
3491 its behavior with respect to remote file attribute caching.
3493 You should only ever change this variable with a let-binding;
3497 "Start a program in a subprocess. Return the process object for it.
3499 Similar to `start-process', but may invoke a file handler based on
3500 `default-directory'. See Info node `(elisp)Magic File Names'.
3502 This handler ought to run PROGRAM, perhaps on the local host,
3503 perhaps on a remote host that corresponds to `default-directory'.
3504 In the latter case, the local part of `default-directory' becomes
3505 the working directory of the process.
3507 PROGRAM and PROGRAM-ARGS might be file names. They are not
3508 objects of file handler invocation. File handlers might not
3509 support pty association, if PROGRAM is nil."
3513 \f
3514 ;;;; Process menu
3528 map))
3531 "Major mode for listing the processes called by Emacs."
3543 "Kill process at point in a `list-processes' buffer."
3549 "Recompute the list of processes for the Process List buffer.
3550 Also, delete any process that is exited or signaled."
3563 face link
3566 follow-link t
3567 process-buffer ,buf
3568 action process-menu-visit-buffer)
3577 "datagram"
3594 tabulated-list-entries))))))
3600 "Display a list of all processes that are Emacs sub-processes.
3601 If optional argument QUERY-ONLY is non-nil, only processes with
3602 the query-on-exit flag set are listed.
3603 Any process listed as exited or signaled is actually eliminated
3604 after the listing is made.
3605 Optional argument BUFFER specifies a buffer to use, instead of
3607 The return value is always nil.
3609 This function lists only processes that were launched by Emacs. To
3610 see other processes running on the system, use `list-system-processes'."
3622 nil)
3623 \f
3627 ;; For backward compatibility, minus with no modifiers is an ordinary
3628 ;; command if digits have already been entered.
3658 map)
3665 "Begin a numeric argument for the following command.
3670 multiplies the argument by 4 each time.
3672 which is different in effect from any particular numeric argument.
3679 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3680 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3686 arg)))
3690 "Begin a negative numeric argument for the next command.
3699 "Part of the numeric argument for the next command.
3703 last-command-event
3710 ;; Treat -0 as just -, so that -01 will work.
3713 digit))))
3715 \f
3723 "Function to perform the filtering in `filter-buffer-substring'.
3724 The function is called with the same 3 arguments (BEG END DELETE)
3725 that `filter-buffer-substring' received. It should return the
3726 buffer substring between BEG and END, after filtering. If DELETE is
3730 "List of filter functions for `buffer-substring--filter'.
3731 Each function must accept a single argument, a string, and return a string.
3732 The buffer substring is passed to the first function in the list,
3733 and the return value of each function is passed to the next.
3734 As a special convention, point is set to the start of the buffer text
3735 being operated on (i.e., the first argument of `buffer-substring--filter')
3741 "Return the buffer substring between BEG and END, after filtering.
3742 If DELETE is non-nil, delete the text between BEG and END from the buffer.
3744 This calls the function that `filter-buffer-substring-function' specifies
3745 \(passing the same three arguments that it received) to do the work,
3746 and returns whatever it does. The default function does no filtering,
3747 unless a hook has been set.
3749 Use `filter-buffer-substring' instead of `buffer-substring',
3750 `buffer-substring-no-properties', or `delete-and-extract-region' when
3751 you want to allow filtering to take place. For example, major or minor
3752 modes can use `filter-buffer-substring-function' to extract characters
3753 that are special to a buffer, and should not be copied into other buffers."
3757 "Default function to use for `filter-buffer-substring-function'.
3758 Its arguments and return value are as specified for `filter-buffer-substring'.
3759 This respects the wrapper hook `filter-buffer-substring-functions',
3760 and the abnormal hook `buffer-substring-filters'.
3761 No filtering is done unless a hook says to."
3771 string)))
3776 ;;;; Window system cut and paste hooks.
3779 "Function to call to make a killed region available to other programs.
3780 Most window systems provide a facility for cutting and pasting
3781 text between different programs, such as the clipboard on X and
3782 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3784 This variable holds a function that Emacs calls whenever text is
3785 put in the kill ring, to make the new kill available to other
3786 programs. The function takes one argument, TEXT, which is a
3790 "Function to call to get text cut from other programs.
3791 Most window systems provide a facility for cutting and pasting
3792 text between different programs, such as the clipboard on X and
3793 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3795 This variable holds a function that Emacs calls to obtain text
3796 that other programs have provided for pasting. The function is
3797 called with no arguments. If no other program has provided text
3798 to paste, the function should return nil (in which case the
3799 caller, usually `current-kill', should use the top of the Emacs
3800 kill ring). If another program has provided text to paste, the
3801 function should return that text as a string (in which case the
3802 caller should put this string in the kill ring as the latest
3803 kill).
3805 The function may also return a list of strings if the window
3806 system supports multiple selections. The first string will be
3807 used as the pasted text, but the other will be placed in the kill
3808 ring for easy access via `yank-pop'.
3810 Note that the function should return a string only if a program
3811 other than Emacs has provided a string for pasting; if Emacs
3812 provided the most recent string, the function should return nil.
3813 If it is difficult to tell whether Emacs or some other program
3814 provided the current string, it is probably good enough to return
3815 nil if the string is equal (according to `string=') to the last
3817 \f
3820 ;;;; The kill ring data structure.
3823 "List of killed text sequences.
3824 Since the kill ring is supposed to interact nicely with cut-and-paste
3825 facilities offered by window systems, use of this variable should
3826 interact nicely with `interprogram-cut-function' and
3827 `interprogram-paste-function'. The functions `kill-new',
3828 `kill-append', and `current-kill' are supposed to implement this
3829 interaction; you may want to use them instead of manipulating the kill
3833 "Maximum length of kill ring before oldest elements are thrown away."
3841 "Save clipboard strings into kill ring before replacing them.
3842 When one selects something in another program to paste it into Emacs,
3843 but kills something in Emacs before actually pasting it,
3844 this selection is gone unless this variable is non-nil,
3845 in which case the other program's selection is saved in the `kill-ring'
3852 "Do not add a new string to `kill-ring' if it duplicates the last one.
3853 The comparison is done using `equal-including-properties'."
3859 "Make STRING the latest kill in the kill ring.
3860 Set `kill-ring-yank-pointer' to point to it.
3861 If `interprogram-cut-function' is non-nil, apply it to STRING.
3862 Optional second argument REPLACE non-nil means that STRING will replace
3863 the front of the kill ring, rather than being added to the list.
3865 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3866 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3867 STRING.
3869 When the yank handler has a non-nil PARAM element, the original STRING
3870 argument is not used by `insert-for-yank'. However, since Lisp code
3871 may access and use elements from the kill ring directly, the STRING
3874 ;; Due to text properties such as 'yank-handler that
3875 ;; can alter the contents to yank, comparison using
3876 ;; `equal' is unsafe.
3901 ;; It has been argued that this should work similar to `self-insert-command'
3902 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
3904 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
3910 "Append STRING to the end of the latest kill in the kill ring.
3911 If BEFORE-P is non-nil, prepend STRING to the kill.
3912 Also removes the last undo boundary in the current buffer,
3913 depending on `kill-append-merge-undo'.
3914 If `interprogram-cut-function' is set, pass the resulting kill to it."
3922 ;; find the next undo boundary
3926 ;; remove this undo boundary
3931 "Whether rotating the kill ring changes the window system selection.
3932 If non-nil, whenever the kill ring is rotated (usually via the
3933 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3934 to copy the new kill to the window system selection."
3940 "Rotate the yanking point by N places, and then return that kill.
3941 If N is zero and `interprogram-paste-function' is set to a
3942 function that returns a string or a list of strings, and if that
3943 function doesn't return nil, then that string (or list) is added
3944 to the front of the kill ring and the string (or first string in
3945 the list) is returned as the latest kill.
3947 If N is not zero, and if `yank-pop-change-selection' is
3948 non-nil, use `interprogram-cut-function' to transfer the
3949 kill at the new yank point into the window system selection.
3951 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3952 move the yanking point; just return the Nth kill forward."
3955 interprogram-paste-function
3959 ;; Disable the interprogram cut function when we add the new
3960 ;; text to the kill ring, so Emacs doesn't try to own the
3961 ;; selection, with identical text.
3971 kill-ring)))
3976 interprogram-cut-function)
3982 ;;;; Commands for manipulating the kill ring.
3985 "Non-nil means don't signal an error for killing read-only text."
3991 This deletes the text from the buffer and saves it in the kill ring.
3995 If you want to append the killed region to the last killed text,
3998 If the buffer is read-only, Emacs will beep and refrain from deleting
3999 the text, but put the text in the kill ring anyway. This means that
4000 you can use the killing commands to copy text from a read-only buffer.
4002 Lisp programs should use this function for killing text.
4003 (To delete text, use `delete-region'.)
4004 Supply two arguments, character positions indicating the stretch of text
4005 to be killed.
4007 If the previous command was also a kill command,
4008 the text killed this time appends to the text killed last time
4009 to make one entry in the kill ring.
4011 The optional argument REGION if non-nil, indicates that we're not just killing
4012 some text between BEG and END, but we're killing the region."
4013 ;; Pass mark first, then point, because the order matters when
4014 ;; calling `kill-append'.
4023 ;; Add that string to the kill ring, one way or another.
4030 nil)
4032 ;; The code above failed because the buffer, or some of the characters
4033 ;; in the region, are read-only.
4034 ;; We should beep, in case the user just isn't aware of this.
4035 ;; However, there's no harm in putting
4036 ;; the region's text in the kill ring, anyway.
4038 ;; Set this-command now, so it will be set even if we get an error.
4040 ;; This should barf, if appropriate, and give us the correct error.
4043 ;; Signal an error if the buffer is read-only.
4045 ;; If the buffer isn't read-only, the text is.
4048 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4049 ;; to get two copies of the text when the user accidentally types M-w and
4050 ;; then corrects it with the intended C-w.
4052 "Save the region as if killed, but don't kill it.
4053 In Transient Mark mode, deactivate the mark.
4054 If `interprogram-cut-function' is non-nil, also save the text for a window
4055 system cut and paste.
4057 The optional argument REGION if non-nil, indicates that we're not just copying
4058 some text between BEG and END, but we're copying the region.
4060 This command's old key binding has been given to `kill-ring-save'."
4061 ;; Pass mark first, then point, because the order matters when
4062 ;; calling `kill-append'.
4072 nil)
4075 "Save the region as if killed, but don't kill it.
4076 In Transient Mark mode, deactivate the mark.
4077 If `interprogram-cut-function' is non-nil, also save the text for a window
4078 system cut and paste.
4080 If you want to append the killed line to the last killed text,
4083 The optional argument REGION if non-nil, indicates that we're not just copying
4084 some text between BEG and END, but we're copying the region.
4086 This command is similar to `copy-region-as-kill', except that it gives
4087 visual feedback indicating the extent of the region being copied."
4088 ;; Pass mark first, then point, because the order matters when
4089 ;; calling `kill-append'.
4093 ;; This use of called-interactively-p is correct because the code it
4094 ;; controls just gives the user visual feedback.
4099 "Indicate that the region text has been copied interactively.
4100 If the mark is visible in the selected window, blink the cursor
4101 between point and mark if there is currently no active region
4102 highlighting.
4104 If the mark lies outside the selected window, display an
4105 informative message containing a sample of the copied text. The
4106 optional argument MESSAGE-LEN, if non-nil, specifies the length
4107 of this sample text; it defaults to 40."
4110 ;; Inhibit quitting so we can make a quit here
4111 ;; look like a C-g typed as a command.
4114 ;; Swap point-and-mark quickly so as to show the region that
4115 ;; was selected. Don't do it if the region is highlighted.
4118 ;; Swap point and mark.
4122 ;; Swap back.
4125 ;; If user quit, deactivate the mark
4126 ;; as C-g would as a command.
4132 ;; Don't say "killed"; that is misleading.
4139 "Cause following command, if it kills, to add to previous kill.
4140 If the next command kills forward from point, the kill is
4141 appended to the previous killed text. If the command kills
4142 backward, the kill is prepended. Kill commands that act on the
4143 region, such as `kill-region', are regarded as killing forward if
4144 point is after mark, and killing backward if point is before
4145 mark.
4147 If the next command is not a kill command, `append-next-kill' has
4148 no effect.
4150 The argument is used for internal purposes; do not supply one."
4152 ;; We don't use (interactive-p), since that breaks kbd macros.
4166 "A subroutine of `squeeze-bidi-context'.
4167 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4171 lim1)
4178 ;; L and R categories include embedding and
4179 ;; override controls, but we don't want to
4180 ;; replace them, because that might change
4181 ;; the visual order. Likewise with PDF and
4182 ;; isolate controls.
4184 bidi-directional-non-controls-chars
4185 limit)))))
4186 ;; Replace any run of non-RTL characters by a single LRM.
4188 ;; No more characters of CATEGORY, we are done.
4193 ;; Skip directional controls, if any.
4198 "Replace characters between FROM and TO while keeping bidi context.
4200 This function replaces the region of text with as few characters
4201 as possible, while preserving the effect that region will have on
4202 bidirectional display before and after the region."
4206 ;; This is for when they copy text with read-only text
4207 ;; properties.
4211 ;; Replace each run of non-RTL characters with a single LRM.
4213 ;; Replace each run of non-LTR characters with a single RLM. Note
4214 ;; that the \cR category includes both the Arabic Letter (AL) and
4215 ;; R characters; here we ignore the distinction between them,
4216 ;; because that distinction only affects Arabic Number (AN)
4217 ;; characters, which are weak and don't affect the reordering.
4221 "Return buffer text between START and END with its bidi context.
4223 START and END are assumed to belong to the same physical line
4224 of buffer text. This function prepends and appends to the text
4225 between START and END bidi control characters that preserve the
4226 visual order of that text when it is inserted at some other place."
4231 substr para-dir from to)
4238 ;; If we don't have any mixed directional characters in the
4239 ;; entire line, we can just copy the substring without adding
4240 ;; any context.
4255 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4256 ;; (1) force the string to have the same base embedding
4257 ;; direction as the paragraph direction at the source, no matter
4258 ;; what is the paragraph direction at destination; and (2) avoid
4259 ;; affecting the visual order of the surrounding text at
4260 ;; destination if there are characters of different
4261 ;; directionality there.
4266 "Return portion of current buffer between START and END with bidi context.
4268 This function works similar to `buffer-substring', but it prepends and
4269 appends to the text bidi directional control characters necessary to
4270 preserve the visual appearance of the text if it is inserted at another
4271 place. This is useful when the buffer substring includes bidirectional
4272 text and control characters that cause non-trivial reordering on display.
4273 If copied verbatim, such text can have a very different visual appearance,
4274 and can also change the visual appearance of the surrounding text at the
4275 destination of the copy.
4277 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4278 the text properties."
4291 no-properties)))
4295 substr)))
4296 \f
4297 ;; Yanking.
4302 "List of special text property handling conditions for yanking.
4303 Each element should have the form (PROP . FUN), where PROP is a
4304 property symbol and FUN is a function. When the `yank' command
4305 inserts text into the buffer, it scans the inserted text for
4306 stretches of text that have `eq' values of the text property
4307 PROP; for each such stretch of text, FUN is called with three
4308 arguments: the property's value in that text, and the start and
4309 end positions of the text.
4311 This is done prior to removing the properties specified by
4312 `yank-excluded-properties'."
4315 function))
4318 ;; This is actually used in subr.el but defcustom does not work there.
4321 intangible invisible keymap local-map mouse-face read-only
4322 yank-handler)
4323 "Text properties to discard when yanking.
4324 The value should be a list of text properties to discard or t,
4325 which means to discard all text properties.
4327 See also `yank-handled-properties'."
4334 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4335 Function is called with two parameters, START and END corresponding to
4336 the value of the mark and point; it is guaranteed that START <= END.
4340 "Replace just-yanked stretch of killed text with a different stretch.
4341 This command is allowed only immediately after a `yank' or a `yank-pop'.
4342 At such a time, the region contains a stretch of reinserted
4343 previously-killed text. `yank-pop' deletes that text and inserts in its
4344 place a different stretch of killed text.
4346 With no argument, the previous kill is inserted.
4347 With argument N, insert the Nth previous kill.
4348 If N is negative, this is a more recent kill.
4350 The sequence of kills wraps around, so that after the oldest one
4351 comes the newest one.
4353 When this command inserts killed text into the buffer, it honors
4354 `yank-excluded-properties' and `yank-handler' as described in the
4355 doc string for `insert-for-yank-1', which see."
4369 ;; Set the window start back where it was in the yank command,
4370 ;; if possible.
4373 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4374 ;; It is cleaner to avoid activation, even though the command
4375 ;; loop would deactivate the mark because we inserted text.
4378 nil)
4382 More precisely, reinsert the most recent kill, which is the
4383 stretch of killed text most recently killed OR yanked. Put point
4384 at the end, and set mark at the beginning without activating it.
4386 With argument N, reinsert the Nth most recent kill.
4388 When this command inserts text into the buffer, it honors the
4389 `yank-handled-properties' and `yank-excluded-properties'
4390 variables, and the `yank-handler' text property. See
4391 `insert-for-yank-1' for details.
4396 ;; If we don't get all the way thru, make last-command indicate that
4397 ;; for the following command.
4405 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4406 ;; It is cleaner to avoid activation, even though the command
4407 ;; loop would deactivate the mark because we inserted text.
4410 ;; If we do get all the way thru, make this-command indicate that.
4413 nil)
4416 "Rotate the yanking point in the kill ring.
4417 With ARG, rotate that many kills forward (or backward, if negative)."
4420 \f
4421 ;; Some kill commands.
4423 ;; Internal subroutine of delete-char
4429 ;; Internal subroutine of backward-delete-char
4436 "The method for untabifying when deleting backward.
4437 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4438 `hungry' -- delete all whitespace, both tabs and spaces;
4439 `all' -- delete all whitespace, including tabs, spaces and newlines;
4440 nil -- just delete one character."
4446 "Delete characters backward, changing tabs into spaces.
4447 The exact behavior depends on `backward-delete-char-untabify-method'.
4448 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4449 Interactively, ARG is the prefix arg (default 1)
4450 and KILLP is t if a prefix arg was specified."
4473 arg)))
4474 ;; Avoid warning about delete-backward-char
4478 "Kill up to and including ARGth occurrence of CHAR.
4479 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4480 Goes backward if ARG is negative; error if CHAR not found."
4483 ;; Avoid "obsolete" warnings for translation-table-for-input.
4491 ;; kill-line and its subroutines.
4494 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4499 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4500 With prefix argument ARG, kill that many lines from point.
4501 Negative arguments kill lines backward.
4502 With zero argument, kills the text before point on the current line.
4505 a number counts as a prefix arg.
4507 To kill a whole line, when point is not at the beginning, type \
4510 If `show-trailing-whitespace' is non-nil, this command will just
4511 kill the rest of the current line, even if there are only
4512 nonblanks there.
4514 If option `kill-whole-line' is non-nil, then this command kills the whole line
4515 including its terminating newline, when used at the beginning of a line
4516 with no argument. As a consequence, you can always kill a whole line
4519 If you want to append the killed line to the last killed text,
4522 If the buffer is read-only, Emacs will beep and refrain from deleting
4523 the line, but put the line in the kill ring anyway. This means that
4524 you can use this command to copy text from a read-only buffer.
4525 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4526 even beep.)"
4529 ;; It is better to move point to the other end of the kill
4530 ;; before killing. That way, in a read-only buffer, point
4531 ;; moves across the text that is copied to the kill ring.
4532 ;; The choice has no effect on undo now that undo records
4533 ;; the value of point from before the command was run.
4543 ;; If trailing whitespace is visible,
4544 ;; don't treat it as nothing.
4554 "Kill current line.
4555 With prefix ARG, kill that many lines starting from the current line.
4556 If ARG is negative, kill backward. Also kill the preceding newline.
4558 If ARG is zero, kill current line but exclude the trailing newline."
4569 ;; We need to kill in two steps, because the previous command
4570 ;; could have been a kill command, in which case the text
4571 ;; before point needs to be prepended to the current kill
4572 ;; ring entry and the text after point appended. Also, we
4573 ;; need to use save-excursion to avoid copying the same text
4574 ;; twice to the kill ring in read-only buffers.
4592 "Move forward by ARG lines, ignoring currently invisible newlines only.
4593 If ARG is negative, move backward -ARG lines.
4594 If ARG is zero, move to the beginning of the current line."
4601 ;; If the newline we just skipped is invisible,
4602 ;; don't count it.
4606 prop
4611 ;; If invisible text follows, and it is a number of complete lines,
4612 ;; skip it.
4618 prop
4634 ;; If the newline we just moved to is invisible,
4635 ;; don't count it.
4640 prop
4645 ;; If invisible text follows, and it is a number of complete lines,
4646 ;; skip it.
4652 prop
4663 nil)))
4666 "Move to end of current visible line."
4668 ;; If the following character is currently invisible,
4669 ;; skip all characters with that same `invisible' property value,
4670 ;; then find the next newline.
4677 prop
4686 \f
4688 "Insert after point the contents of BUFFER.
4689 Puts mark after the inserted text.
4690 BUFFER may be a buffer or a buffer name."
4700 t))))
4705 nil)
4708 "Append to specified buffer the text of the region.
4709 It is inserted into that buffer before its point.
4711 When calling from a program, give three arguments:
4712 BUFFER (or buffer name), START and END.
4713 START and END specify the portion of the current buffer to be copied."
4720 point)
4731 "Prepend to specified buffer the text of the region.
4732 It is inserted into that buffer after its point.
4734 When calling from a program, give three arguments:
4735 BUFFER (or buffer name), START and END.
4736 START and END specify the portion of the current buffer to be copied."
4745 "Copy to specified buffer the text of the region.
4746 It is inserted into that buffer, replacing existing text there.
4748 When calling from a program, give three arguments:
4749 BUFFER (or buffer name), START and END.
4750 START and END specify the portion of the current buffer to be copied."
4758 \f
4762 "Hook run when the mark becomes active.
4763 It is also run at the end of a command, if the mark is active and
4770 "Return this buffer's mark value as integer, or nil if never set.
4772 In Transient Mark mode, this function signals an error if
4773 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4774 or the argument FORCE is non-nil, it disregards whether the mark
4775 is active, and returns an integer or nil in the usual way.
4777 If you are using this in an editing command, you are most likely making
4778 a mistake; see the documentation of `set-mark'."
4783 ;; Behind display-selections-p.
4786 "Deactivate the mark.
4787 If Transient Mark mode is disabled, this function normally does
4788 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4790 Deactivating the mark sets `mark-active' to nil, updates the
4791 primary selection according to `select-active-regions', and runs
4792 `deactivate-mark-hook'.
4794 If Transient Mark mode was temporarily enabled, reset the value
4795 of the variable `transient-mark-mode'; if this causes Transient
4796 Mark mode to be disabled, don't change `mark-active' to nil or
4797 run `deactivate-mark-hook'."
4801 select-active-regions)
4804 ;; The var `saved-region-selection', if non-nil, is the text in
4805 ;; the region prior to the last command modifying the buffer.
4806 ;; Set the selection to that, or to the current region.
4811 ;; If another program has acquired the selection, region
4812 ;; deactivation should not clobber it (Bug#11772).
4831 "Activate the mark.
4832 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
4842 "Set this buffer's mark to POS. Don't use this function!
4843 That is to say, don't use this function unless you want
4844 the user to see that the mark has moved, and you want the previous
4845 mark position to be lost.
4847 Normally, when a new mark is set, the old one should go on the stack.
4848 This is why most applications should use `push-mark', not `set-mark'.
4850 Novice Emacs Lisp programmers often try to use the mark for the wrong
4851 purposes. The mark saves a location for the user's convenience.
4852 Most editing commands should not alter the mark.
4853 To remember a location for internal use in the Lisp program,
4854 store it in a Lisp variable. Example:
4856 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4861 ;; Normally we never clear mark-active except in Transient Mark mode.
4862 ;; But when we actually clear out the mark value too, we must
4863 ;; clear mark-active in any mode.
4865 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
4866 ;; it should never be nil if the mark is nil.
4874 mark-active))
4881 ;; Mark marker
4887 ;; Mark active
4890 ;; If mark is active now, and either was not active or was at a
4891 ;; different place, run the activate hook.
4896 ;; If mark has ceased to be active, run deactivate hook.
4901 "Like `save-excursion', but also save and restore the mark state.
4902 This macro does what `save-excursion' did before Emacs 25.1."
4911 If nil, region-aware commands treat empty regions as inactive.
4912 If non-nil, region-aware commands treat the region as active as
4913 long as the mark is active, even if the region is empty.
4915 Region-aware commands are those that act on the region if it is
4916 active and Transient Mark mode is enabled, and on the text near
4917 point otherwise."
4923 "Return t if the region is active and it is appropriate to act on it.
4924 This is used by commands that act specially on the region under
4925 Transient Mark mode.
4927 The return value is t if Transient Mark mode is enabled and the
4928 mark is active; furthermore, if `use-empty-active-region' is nil,
4929 the region must not be empty. Otherwise, the return value is nil.
4931 For some commands, it may be appropriate to ignore the value of
4932 `use-empty-active-region'; in that case, use `region-active-p'."
4937 "Return non-nil if Transient Mark mode is enabled and the mark is active.
4939 Some commands act specially on the region when Transient Mark
4940 mode is enabled. Usually, such commands should use
4941 `use-region-p' instead of this function, because `use-region-p'
4942 also checks the value of `use-empty-active-region'."
4944 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
4945 ;; without the mark being set (e.g. bug#17324). We really should fix
4946 ;; that problem, but in the mean time, let's make sure we don't say the
4947 ;; region is active when there's no mark.
4961 ;; Normal priority so that a large region doesn't hide all the
4962 ;; overlays within it, but high secondary priority so that if it
4963 ;; ends/starts in the middle of a small overlay, that small overlay
4964 ;; won't hide the region's boundaries.
4966 nrol)
4971 rol)))
4987 start end window rol)))
4990 new))))))
4993 "Hook run just before redisplay.
4994 It is called in each window that is to be redisplayed. It takes one argument,
4995 which is the window that will be redisplayed. When run, the `current-buffer'
5016 "Maximum size of mark ring. Start discarding off end if gets this big."
5024 "Maximum size of global mark ring. \
5025 Start discarding off end if gets this big."
5030 "Jump to mark, and pop a new position for mark off the ring.
5031 \(Does not affect global mark ring)."
5041 "Set mark at where point is.
5042 If no prefix ARG and mark is already set there, just activate it.
5043 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5055 will pop the mark twice, and
5057 will pop the mark three times.
5065 "Set the mark where point is, or jump to the mark.
5066 Setting the mark also alters the region, which is the text
5067 between point and mark; this is the closest equivalent in
5070 With no prefix argument, set the mark at point, and push the
5071 old mark position on local mark ring. Also push the old mark on
5072 global mark ring, if the previous mark was set in another buffer.
5074 When Transient Mark Mode is off, immediately repeating this
5075 command activates `transient-mark-mode' temporarily.
5078 jump to the mark, and set the mark from
5079 position popped off the local mark ring (this does not affect the global
5081 mark ring (see `pop-global-mark').
5083 If `set-mark-command-repeat-pop' is non-nil, repeating
5085 off the local (or global) mark ring and jumps there.
5088 argument, unconditionally set mark where point is, even if
5089 `set-mark-command-repeat-pop' is non-nil.
5091 Novice Emacs Lisp programmers often try to use the mark for the wrong
5092 purposes. See the documentation of `set-mark' for more information."
5112 arg)
5126 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5127 If the last global mark pushed was not in the current buffer,
5128 also push LOCATION on the global mark ring.
5129 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5131 Novice Emacs Lisp programmers often try to use the mark for the wrong
5132 purposes. See the documentation of `set-mark' for more information.
5134 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5141 ;; Now push the mark on the global mark ring.
5144 ;; The last global mark pushed was in this same buffer.
5145 ;; Don't push another one.
5146 nil
5155 nil)
5158 "Pop off mark ring into the buffer's actual mark.
5159 Does not set point. Does nothing if mark ring is empty."
5171 "Put the mark where point is now, and point where the mark is now.
5172 This command works even when the mark is not active,
5173 and it reactivates the mark.
5175 If Transient Mark mode is on, a prefix ARG deactivates the mark
5176 if it is active, and otherwise avoids reactivating it. If
5177 Transient Mark mode is off, a prefix ARG enables Transient Mark
5178 mode temporarily."
5192 nil))
5195 "When non-nil, shifted motion keys activate the mark momentarily.
5197 While the mark is activated in this way, any shift-translated point
5198 motion key extends the region, and if Transient Mark mode was off, it
5199 is temporarily turned on. Furthermore, the mark will be deactivated
5200 by any subsequent point motion key that was not shift-translated, or
5201 by any action that normally deactivates the mark in Transient Mark mode.
5203 See `this-command-keys-shift-translated' for the meaning of
5204 shift-translation."
5209 "Activate/deactivate mark depending on invocation thru shift translation.
5210 This function is called by `call-interactively' when a command
5211 with a `^' character in its `interactive' spec is invoked, before
5212 running the command itself.
5214 If `shift-select-mode' is enabled and the command was invoked
5215 through shift translation, set the mark and activate the region
5216 temporarily, unless it was already set in this way. See
5217 `this-command-keys-shift-translated' for the meaning of shift
5218 translation.
5220 Otherwise, if the region has been activated temporarily,
5221 deactivate it, and restore the variable `transient-mark-mode' to
5222 its earlier value."
5229 transient-mark-mode)))
5238 "Toggle Transient Mark mode.
5239 With a prefix argument ARG, enable Transient Mark mode if ARG is
5240 positive, and disable it otherwise. If called from Lisp, enable
5241 Transient Mark mode if ARG is omitted or nil.
5243 Transient Mark mode is a global minor mode. When enabled, the
5244 region is highlighted with the `region' face whenever the mark
5246 and after certain other operations that set the mark but whose
5247 main purpose is something else--for example, incremental search,
5253 Many commands change their behavior when Transient Mark mode is
5254 in effect and the mark is active, by acting on the region instead
5255 of their usual default part of the buffer's text. Examples of
5258 To see the documentation of commands which are sensitive to the
5261 :global t
5262 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5266 "Non-nil means it is ok for commands to call `widen' when they want to.
5267 Some commands will do this in order to go to positions outside
5268 the current accessible part of the buffer.
5270 If `widen-automatically' is nil, these commands will do something else
5274 "Whether the currently executing code is performing an essential task.
5275 This variable should be non-nil only when running code which should not
5276 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5277 user for a password when we are simply scanning a set of files in the
5278 background or displaying possible completions before the user even asked
5282 "Pop off global mark ring and jump to the top location."
5284 ;; Pop entries which refer to non-existent buffers.
5302 \f
5304 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5310 "Move cursor vertically down ARG lines.
5311 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5312 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5313 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5314 function will not vscroll.
5316 ARG defaults to 1.
5318 If there is no character in the target line exactly under the current column,
5319 the cursor is positioned after the character in that line which spans this
5320 column, or at the end of the line if it is not long enough.
5321 If there is no line in the buffer after this one, behavior depends on the
5322 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5323 to create a line, and moves the cursor to that line. Otherwise it moves the
5324 cursor to the end of the buffer.
5326 If the variable `line-move-visual' is non-nil, this command moves
5327 by display lines. Otherwise, it moves by buffer lines, without
5328 taking variable-width characters or continued lines into account.
5331 a semipermanent goal column for this command.
5332 Then instead of trying to move exactly vertically (or as close as possible),
5333 this command moves to the specified goal column (or as close as possible).
5334 The goal column is stored in the variable `goal-column', which is nil
5335 when there is no goal column. Note that setting `goal-column'
5336 overrides `line-move-visual' and causes this command to move by buffer
5337 lines rather than by display lines."
5343 ;; When adding a newline, don't expand an abbrev.
5354 nil)
5357 "Move cursor vertically up ARG lines.
5358 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5359 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5360 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5361 function will not vscroll.
5363 ARG defaults to 1.
5365 If there is no character in the target line exactly over the current column,
5366 the cursor is positioned after the character in that line which spans this
5367 column, or at the end of the line if it is not long enough.
5369 If the variable `line-move-visual' is non-nil, this command moves
5370 by display lines. Otherwise, it moves by buffer lines, without
5371 taking variable-width characters or continued lines into account.
5374 a semipermanent goal column for this command.
5375 Then instead of trying to move exactly vertically (or as close as possible),
5376 this command moves to the specified goal column (or as close as possible).
5377 The goal column is stored in the variable `goal-column', which is nil
5378 when there is no goal column. Note that setting `goal-column'
5379 overrides `line-move-visual' and causes this command to move by buffer
5380 lines rather than by display lines."
5391 nil)
5394 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5395 This means moving to the end of each line moved onto.
5396 The beginning of a blank line does not count as the end of a line.
5397 This has no effect when the variable `line-move-visual' is non-nil."
5403 A non-nil setting overrides the variable `line-move-visual', which see."
5410 "Current goal column for vertical motion.
5411 It is the column where point was at the start of the current run
5412 of vertical motion commands.
5414 When moving by visual lines via the function `line-move-visual', it is a cons
5415 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5416 divided by the default column width, and HSCROLL is the number of
5417 columns by which window is scrolled from left margin.
5419 When the `track-eol' feature is doing its job, the value is
5423 "Non-nil means commands that move by lines ignore invisible newlines.
5424 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5425 as if newlines that are invisible didn't exist, and count
5426 only visible newlines. Thus, moving across across 2 newlines
5427 one of which is invisible will be counted as a one-line move.
5428 Also, a non-nil value causes invisible text to be ignored when
5429 counting columns for the purposes of keeping point in the same
5432 Outline mode sets this."
5437 "When non-nil, `line-move' moves point by visual lines.
5438 This movement is based on where the cursor is displayed on the
5439 screen, instead of relying on buffer contents alone. It takes
5440 into account variable-width characters and line continuation.
5441 If nil, `line-move' moves point by logical lines.
5442 A non-nil setting of `goal-column' overrides the value of this variable
5443 and forces movement by logical lines.
5444 A window that is horizontally scrolled also forces movement by logical
5445 lines."
5450 ;; Only used if display-graphic-p.
5454 "Return the height in pixels of the current buffer's default face font.
5456 If the default font is remapped (see `face-remapping-alist'), the
5457 function returns the height of the remapped face."
5461 ;; Avoid calling font-info if the frame's default font was
5462 ;; not changed since the frame was created. That's because
5463 ;; font-info is expensive for some fonts, see bug #14838.
5469 "Return the width in pixels of the current buffer's default face font.
5471 If the default font is remapped (see `face-remapping-alist'), the
5472 function returns the width of the remapped face."
5476 ;; Avoid calling font-info if the frame's default font was
5477 ;; not changed since the frame was created. That's because
5478 ;; font-info is expensive for some fonts, see bug #14838.
5483 width
5488 "Return the pixel height of current buffer's default-face text line.
5490 The value includes `line-spacing', if any, defined for the buffer
5491 or the frame."
5504 "Return the number of screen lines in the text area of the selected window.
5506 This is different from `window-text-height' in that this function counts
5507 lines in units of the height of the font used by the default face displayed
5508 in the window, not in units of the frame's default font, and also accounts
5509 for `line-spacing', if any, defined for the window's buffer or frame.
5511 The value is a floating-point number."
5516 ;; Returns non-nil if partial move was done.
5519 ;; Move backward (up).
5520 ;; If already vscrolled, reduce vscroll
5526 ;; Move forward (down).
5539 py vs last-line)
5559 col-row)
5564 ;; VPOS > 0 means the last line is only partially visible.
5565 ;; But if the part that is visible is at least as tall as the
5566 ;; default font, that means the line is actually fully
5567 ;; readable, and something like line-spacing is hidden. So in
5568 ;; that case we accept the last line in the window as still
5569 ;; visible, and consider the margin as starting one line
5570 ;; later.
5578 ;; If last line of window is fully visible, and vscrolling
5579 ;; more would make this line invisible, move forward.
5584 nil)
5585 ;; If cursor is not in the bottom scroll margin, and the
5586 ;; current line is is not too tall, move forward.
5588 vpos
5591 nil)
5592 ;; When already vscrolled, we vscroll some more if we can,
5593 ;; or clear vscroll and move forward at end of tall image.
5598 ;; If cursor just entered the bottom scroll margin, move forward,
5599 ;; but also optionally vscroll one line so redisplay won't recenter.
5603 ;; Don't vscroll if the partially-visible line at window
5604 ;; bottom is not too tall (a.k.a. "just one more text
5605 ;; line"): in that case, we do want redisplay to behave
5606 ;; normally, i.e. recenter or whatever.
5607 ;;
5608 ;; Note: ROWH + RBOT from the value returned by
5609 ;; pos-visible-in-window-p give the total height of the
5610 ;; partially-visible glyph row at the end of the window. As
5611 ;; we are dealing with floats, we disregard sub-pixel
5612 ;; discrepancies between that and DLH.
5616 t)
5617 ;; If there are lines above the last line, scroll-up one line.
5620 t)
5621 ;; Finally, start vscroll.
5626 ;; This is like line-move-1 except that it also performs
5627 ;; vertical scrolling of tall images if appropriate.
5628 ;; That is not really a clean thing to do, since it mixes
5629 ;; scrolling with cursor motion. But so far we don't have
5630 ;; a cleaner solution to the problem of making C-n do something
5631 ;; useful given a tall image.
5633 "Move forward ARG lines.
5634 If NOERROR, don't signal an error if we can't move ARG lines.
5635 TO-END is unused.
5636 TRY-VSCROLL controls whether to vscroll tall lines: if either
5637 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5638 not vscroll."
5642 ;; Only vscroll for single line moves
5644 ;; Under scroll-conservatively, the display engine
5645 ;; does this better.
5647 ;; But don't vscroll in a keyboard macro.
5653 ;; Display-based column are incompatible with goal-column.
5655 ;; When the text in the window is scrolled to the left,
5656 ;; display-based motion doesn't make sense (because each
5657 ;; logical line occupies exactly one screen line).
5659 ;; Likewise when the text _was_ scrolled to the left
5660 ;; when the current run of vertical motion commands
5661 ;; started.
5664 auto-hscroll-mode
5666 (>= temporary-goal-column
5669 ;; If we moved into a tall line, set vscroll to make
5670 ;; scrolling through tall images more smooth.
5674 winh)
5680 nil
5684 ;; Display-based alternative to line-move-1.
5685 ;; Arg says how many lines to move. The value is t if we can move the
5686 ;; specified number of lines.
5688 "Move ARG lines forward.
5689 If NOERROR, don't signal an error if we can't move that many lines."
5692 target-hscroll)
5693 ;; Check if the previous command was a line-motion command, or if
5694 ;; we were called from some other command.
5697 ;; If so, there's no need to reset `temporary-goal-column',
5698 ;; but we may need to hscroll.
5702 ;; Otherwise, we should reset `temporary-goal-column'.
5704 x-pos)
5706 ;; Handle the `overflow-newline-into-fringe' case:
5711 ;; In R2L lines, the X pixel coordinate is measured from the
5712 ;; left edge of the window, but columns are still counted
5713 ;; from the logical-order beginning of the line, i.e. from
5714 ;; the right edge in this case. We need to adjust for that.
5720 hscroll))))))
5723 ;; vertical-motion can move more than it was asked to if it moves
5724 ;; across display strings with newlines. We don't want to ring
5725 ;; the bell and announce beginning/end of buffer in that case.
5731 temporary-goal-column))
5732 arg))
5733 arg))
5739 temporary-goal-column))
5740 arg))
5741 arg)))
5744 ;; If the goal column lies on a display string,
5745 ;; `vertical-motion' advances the cursor to the end
5746 ;; of the string. For arg < 0, this can cause the
5747 ;; cursor to get stuck. (Bug#3020).
5751 nil)))))
5753 ;; This is the guts of next-line and previous-line.
5754 ;; Arg says how many lines to move.
5755 ;; The value is t if we can move the specified number of lines.
5757 ;; Don't run any point-motion hooks, and disregard intangibility,
5758 ;; for intermediate positions.
5770 ;; Don't count beg of empty line as end of line
5771 ;; unless we just did explicit end-of-line.
5773 most-positive-fixnum
5777 line-move-ignore-invisible))
5778 ;; Use just newline characters.
5779 ;; Set ARG to 0 if we move as many lines as requested.
5782 ;; This way of moving forward ARG lines
5783 ;; verifies that we have a newline after the last one.
5784 ;; It doesn't get confused by intangible text.
5793 'beginning-of-buffer
5795 nil)))
5796 ;; Move by arg lines, but ignore invisible ones.
5799 ;; If the following character is currently invisible,
5800 ;; skip all characters with that same `invisible' property value.
5803 ;; Move a line.
5804 ;; We don't use `end-of-line', since we want to escape
5805 ;; from field boundaries occurring exactly at point.
5811 ;; If there's no invisibility here, move over the newline.
5820 ;; We avoid vertical-motion when possible
5821 ;; because that has to fontify.
5823 ;; Otherwise move a more sophisticated way.
5830 ;; The logic of this is the same as the loop above,
5831 ;; it just goes in the other direction.
5833 ;; For completely consistency with the forward-motion
5834 ;; case, we should call beginning-of-line here.
5835 ;; However, if point is inside a field and on a
5836 ;; continued line, the call to (vertical-motion -1)
5837 ;; below won't move us back far enough; then we return
5838 ;; to the same column in line-move-finish, and point
5839 ;; gets stuck -- cyd
5857 ;; if our target is the middle of this line.
5862 ;; This is the value the function returns.
5866 ;; If we did not move down as far as desired, at least go
5867 ;; to end of line. Be sure to call point-entered and
5868 ;; point-left-hooks.
5874 ;; If we did not move up as far as desired,
5875 ;; at least go to beginning of line.
5887 ;; Set REPEAT to t to repeat the whole thing.
5894 ;; Compute the end of the line
5895 ;; ignoring effectively invisible newlines.
5897 ;; Like end-of-line but ignores fields.
5904 ;; Move to the desired column.
5907 ;; Corner case: suppose we start out in a field boundary in
5908 ;; the middle of a continued line. When we get to
5909 ;; line-move-finish, point is at the start of a new *screen*
5910 ;; line but the same text line; then line-move-to-column would
5911 ;; move us backwards. Test using C-n with point on the "x" in
5912 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5919 ;; Process intangibility within a line.
5920 ;; With inhibit-point-motion-hooks bound to nil, a call to
5921 ;; goto-char moves point past intangible text.
5923 ;; However, inhibit-point-motion-hooks controls both the
5924 ;; intangibility and the point-entered/point-left hooks. The
5925 ;; following hack avoids calling the point-* hooks
5926 ;; unnecessarily. Note that we move *forward* past intangible
5927 ;; text when the initial and final points are the same.
5932 ;; If intangibility moves us to a different (later) place
5933 ;; in the same line, use that as the destination.
5936 ;; If that position is "too late",
5937 ;; try the previous allowable position.
5938 ;; See if it is ok.
5941 ;; If going forward, don't accept the previous
5942 ;; allowable position if it is before the target line.
5944 ;; If going backward, don't accept the previous
5945 ;; allowable position if it is still after the target line.
5948 ;; As a last resort, use the end of the line.
5951 ;; Now move to the updated destination, processing fields
5952 ;; as well as intangibility.
5956 ;; Ignore field boundaries if the initial and final
5957 ;; positions have the same `field' property, even if the
5958 ;; fields are non-contiguous. This seems to be "nicer"
5959 ;; behavior in many situations.
5962 new
5966 ;; If all this moved us to a different line,
5967 ;; retry everything within that new line.
5969 ;; Repeat the intangibility and field processing.
5973 "Try to find column COL, considering invisibility.
5974 This function works only in certain cases,
5975 because what we really need is for `move-to-column'
5976 and `current-column' to be able to ignore invisible text."
5985 ;; If the following character is currently invisible,
5986 ;; skip all characters with that same `invisible' property value.
5990 ;; Have we advanced to a larger column position?
5992 ;; We have made some progress towards the desired column.
5993 ;; See if we can make any further progress.
5995 ;; Otherwise, go to the place we originally found
5996 ;; and move back over invisible text.
5997 ;; that will get us to the same place on the screen
5998 ;; but with a more reasonable buffer position.
6001 ;; We want the real line beginning, so it's consistent
6002 ;; with bolp below, otherwise we might infloop.
6009 "Move point to end of current line as displayed.
6010 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6011 If point reaches the beginning or end of buffer, it stops there.
6013 To ignore the effects of the `intangible' text or overlay
6014 property, bind `inhibit-point-motion-hooks' to t.
6015 If there is an image in the current line, this function
6016 disregards newlines that are part of the text on which the image
6017 rests."
6027 ;; With bidi reordering, we may not be at bol,
6028 ;; so make sure we are.
6043 ;; If we skipped something intangible and now we're not
6044 ;; really at eol, keep going.
6049 "Move point to beginning of current line as displayed.
6050 \(If there's an image in the line, this disregards newlines
6051 which are part of the text that the image rests on.)
6053 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6054 If point reaches the beginning or end of buffer, it stops there.
6055 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6060 first-vis first-vis-field-value)
6062 ;; Move by lines, if ARG is not 1 (the default).
6067 ;; Move to beginning-of-line, ignoring fields and invisible text.
6073 ;; Now find first visible char in the line.
6078 ;; See if fields would stop us from reaching FIRST-VIS.
6083 ;; If yes, obey them.
6084 first-vis-field-value
6085 ;; Otherwise, move to START with attention to fields.
6086 ;; (It is possible that fields never matter in this case.)
6091 ;; Many people have said they rarely use this feature, and often type
6092 ;; it by accident. Maybe it shouldn't even be on a key.
6097 Those commands will move to this position in the line moved to
6098 rather than trying to keep the same horizontal position.
6099 With a non-nil argument ARG, clears out the goal column
6101 The goal column is stored in the variable `goal-column'."
6108 ;; The older method below can be erroneous if `set-goal-column' is bound
6109 ;; to a sequence containing %
6110 ;;(message (substitute-command-keys
6111 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6112 ;;goal-column)
6119 )
6120 nil)
6121 \f
6122 ;;; Editing based on visual lines, as opposed to logical lines.
6125 "Move point to end of current visual line.
6126 With argument N not nil or 1, move forward N - 1 visual lines first.
6127 If point reaches the beginning or end of buffer, it stops there.
6128 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6134 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6135 ;; constrain to field boundaries, so we don't either.
6139 "Move point to beginning of current visual line.
6140 With argument N not nil or 1, move forward N - 1 visual lines first.
6141 If point reaches the beginning or end of buffer, it stops there.
6142 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6150 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6154 "Kill the rest of the visual line.
6155 With prefix argument ARG, kill that many visual lines from point.
6156 If ARG is negative, kill visual lines backward.
6157 If ARG is zero, kill the text before point on the current visual
6158 line.
6160 If you want to append the killed line to the last killed text,
6163 If the buffer is read-only, Emacs will beep and refrain from deleting
6164 the line, but put the line in the kill ring anyway. This means that
6165 you can use this command to copy text from a read-only buffer.
6166 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6167 even beep.)"
6169 ;; Like in `kill-line', it's better to move point to the other end
6170 ;; of the kill before killing.
6178 ;; Skip any trailing whitespace at the end of the visual line.
6179 ;; We used to do this only if `show-trailing-whitespace' is
6180 ;; nil, but that's wrong; the correct thing would be to check
6181 ;; whether the trailing whitespace is highlighted. But, it's
6182 ;; OK to just do this unconditionally.
6189 "Move cursor vertically down ARG lines.
6190 This is identical to `next-line', except that it always moves
6191 by logical lines instead of visual lines, ignoring the value of
6192 the variable `line-move-visual'."
6199 "Move cursor vertically up ARG lines.
6200 This is identical to `previous-line', except that it always moves
6201 by logical lines instead of visual lines, ignoring the value of
6202 the variable `line-move-visual'."
6209 "Editing based on visual lines."
6218 ;; These keybindings interfere with xterm function keys. Are
6219 ;; there any other suitable bindings?
6220 ;; (define-key map "\M-[" 'previous-logical-line)
6221 ;; (define-key map "\M-]" 'next-logical-line)
6222 map))
6225 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6226 The value should be a list of the form (LEFT RIGHT), where LEFT
6227 and RIGHT are symbols representing the bitmaps to display, to
6228 indicate wrapped lines, in the left and right fringes respectively.
6229 See also `fringe-indicator-alist'.
6230 The default is not to display fringe indicators for wrapped lines.
6231 This variable does not affect fringe indicators displayed for
6232 other purposes."
6247 'continuation
6254 "Toggle visual line based editing (Visual Line mode).
6255 With a prefix argument ARG, enable Visual Line mode if ARG is
6256 positive, and disable it otherwise. If called from Lisp, enable
6257 the mode if ARG is omitted or nil.
6259 When Visual Line mode is enabled, `word-wrap' is turned on in
6260 this buffer, and simple editing commands are redefined to act on
6261 visual lines, not logical lines. See Info node `Visual Line
6262 Mode' for details."
6263 :keymap visual-line-mode-map
6269 ;; Save the local values of some variables, to be restored if
6270 ;; visual-line-mode is turned off.
6272 truncate-partial-width-windows
6273 word-wrap fringe-indicator-alist))
6276 visual-line--saved-state)))
6280 word-wrap t
6281 fringe-indicator-alist
6283 fringe-indicator-alist)))
6297 visual-line-mode turn-on-visual-line-mode)
6299 \f
6301 "Interchange characters around point, moving forward one character.
6302 With prefix arg ARG, effect is to take character before point
6303 and drag it forward past ARG other characters (backward if ARG negative).
6304 If no argument and at end of line, the previous two chars are exchanged."
6312 "Interchange words around point, leaving point at end of them.
6313 With prefix arg ARG, effect is to take word before or around point
6314 and drag it forward past ARG other words (backward if ARG negative).
6315 If ARG is zero, the words around or after point and around or after mark
6316 are interchanged."
6317 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6323 Does not work on a sexp that point is in the middle of
6324 if it is a list or string."
6328 ;; Here we should try to simulate the behavior of
6329 ;; (cons (progn (forward-sexp x) (point))
6330 ;; (progn (forward-sexp (- x)) (point)))
6331 ;; Except that we don't want to rely on the second forward-sexp
6332 ;; putting us back to where we want to be, since forward-sexp-function
6333 ;; might do funny things like infix-precedence.
6338 ;; Jumping over a symbol. We might be inside it, mind you.
6343 ;; Otherwise, we're between sexps. Take a step back before jumping
6344 ;; to make sure we'll obey the same precedence no matter which direction
6345 ;; we're going.
6350 'skip-syntax-forward
6357 "Exchange current line and previous line, leaving point after both.
6358 With argument ARG, takes previous line and moves it past ARG lines.
6359 With argument 0, interchanges line point is in with line mark is in."
6365 ;; Move forward over ARG lines,
6366 ;; but create newlines if necessary.
6373 arg))
6375 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6376 ;; which seems inconsistent with the ARG /= 0 case.
6377 ;; FIXME document SPECIAL.
6379 "Subroutine to do the work of transposing objects.
6380 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6381 moves forward by units of the given object (e.g. forward-sentence,
6382 forward-paragraph). If ARG is zero, exchanges the current object
6383 with the one containing mark. If ARG is an integer, moves the
6384 current object past ARG following (if ARG is positive) or
6385 preceding (if ARG is negative) objects, leaving point after the
6386 current object."
6391 pos1 pos2)
6419 ;; This sequence of insertions attempts to preserve marker
6420 ;; positions at the start and end of the transposed objects.
6434 \f
6436 "Move backward until encountering the beginning of a word.
6437 With argument ARG, do this that many times.
6438 If ARG is omitted or nil, move point backward one word."
6443 "Set mark ARG words away from point.
6445 move to with the same argument.
6446 Interactively, if this command is repeated
6447 or (in Transient Mark mode) if the mark is active,
6448 it marks the next ARG words after the ones already marked."
6465 nil t))))
6468 "Kill characters forward until encountering the end of a word.
6469 With argument ARG, do this that many times."
6474 "Kill characters backward until encountering the beginning of a word.
6475 With argument ARG, do this that many times."
6480 "Return the symbol or word that point is on (or a nearby one) as a string.
6481 The return value includes no text properties.
6482 If optional arg STRICT is non-nil, return nil unless point is within
6483 or adjacent to a symbol or word. In all cases the value can be nil
6484 if there is no word nearby.
6485 The function, belying its name, normally finds a symbol.
6486 If optional arg REALLY-WORD is non-nil, it finds just a word."
6495 ;; Point is neither within nor adjacent to a word.
6497 ;; Look for preceding word in same line.
6500 ;; No preceding word in same line.
6501 ;; Look for following word in same line.
6510 ;; If we found something nonempty, return it as a string.
6513 \f
6515 "String for filling to insert at front of new line, or nil for none."
6517 string)
6523 "Regexp to match lines which should not be auto-filled."
6525 regexp)
6529 "The default value for `normal-auto-fill-function'.
6530 This is the default auto-fill function, some major modes use a different one.
6531 Returns t if it really did any work."
6541 nil ;; Auto-filling not required
6545 ;; Choose a fill-prefix automatically.
6553 ;; Use auto-indentation rather than a guessed empty prefix.
6559 ;; Determine where to split the line.
6572 ;; See whether the place we found is any good.
6576 ;; There is no use breaking at end of line.
6578 ;; It is futile to split at the end of the prefix
6579 ;; since we would just insert the prefix again.
6581 ;; Don't split right after a comment starter
6582 ;; since we would just make another comment starter.
6587 limit t)
6589 ;; No good place to break => stop trying.
6591 ;; Ok, we have a useful place to break the line. Do it.
6593 ;; If point is at the fill-point, do not `save-excursion'.
6594 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6595 ;; point will end up before it rather than after it.
6603 ;; Now do justification, if required
6608 ;; If making the new line didn't reduce the hpos of
6609 ;; the end of the line, then give up now;
6610 ;; trying again will not help.
6613 ;; Justify last line.
6615 t)))
6618 "Mode-specific function which line breaks and continues a comment.
6619 This function is called during auto-filling when a comment syntax
6620 is defined.
6621 The function should take a single optional argument, which is a flag
6625 "Break line at point and indent.
6626 If a comment syntax is defined, call `comment-indent-new-line'.
6628 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6629 unless optional argument SOFT is non-nil."
6633 ;; Insert the newline before removing empty space so that markers
6634 ;; get preserved better.
6640 ;; Blindly trust a non-adaptive fill-prefix.
6646 ;; If there's an adaptive prefix, use it unless we're inside
6647 ;; a comment and the prefix is not a comment starter.
6651 ;; If we're not inside a comment, just try to indent.
6655 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6659 ;; `functions' and `hooks' are usually unsafe to set, but setting
6660 ;; auto-fill-function to nil in a file-local setting is safe and
6661 ;; can be useful to prevent auto-filling.
6665 "Toggle automatic line breaking (Auto Fill mode).
6666 With a prefix argument ARG, enable Auto Fill mode if ARG is
6667 positive, and disable it otherwise. If called from Lisp, enable
6668 the mode if ARG is omitted or nil.
6670 When Auto Fill mode is enabled, inserting a space at a column
6671 beyond `current-fill-column' automatically breaks the line at a
6672 previous space.
6674 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6675 non-nil.
6677 The value of `normal-auto-fill-function' specifies the function to use
6678 for `auto-fill-function' when turning Auto Fill mode on."
6683 ;; This holds a document string used to document auto-fill-mode.
6685 "Automatically break line at a previous space, in insertion of text."
6686 nil)
6689 "Unconditionally turn on Auto Fill mode."
6693 "Unconditionally turn off Auto Fill mode."
6699 "Set `fill-column' to specified argument.
6704 ;; We used to use current-column silently, but C-x f is too easily
6705 ;; typed as a typo for C-x C-f, so we turned it into an error and
6706 ;; now an interactive prompt.
6711 ;; Disallow missing argument; it's probably a typo for C-x C-f.
6715 \f
6717 "Set `selective-display' to ARG; clear it if no arg.
6718 When the value of `selective-display' is a number > 0,
6719 lines whose indentation is >= that value are not displayed.
6720 The variable `selective-display' has a separate value for each buffer."
6740 "Toggle truncating of long lines for the current buffer.
6741 When truncating is off, long lines are folded.
6742 With prefix argument ARG, truncate long lines if ARG is positive,
6743 otherwise fold them. Note that in side-by-side windows, this
6744 command has no effect if `truncate-partial-width-windows' is
6745 non-nil."
6757 nil t)))
6762 "Toggle whether to use word-wrapping for continuation lines.
6763 With prefix argument ARG, wrap continuation lines at word boundaries
6764 if ARG is positive, otherwise wrap them at the right screen edge.
6765 This command toggles the value of `word-wrap'. It has no effect
6766 if long lines are truncated."
6782 "Toggle Overwrite mode.
6783 With a prefix argument ARG, enable Overwrite mode if ARG is
6784 positive, and disable it otherwise. If called from Lisp, enable
6785 the mode if ARG is omitted or nil.
6787 When Overwrite mode is enabled, printing characters typed in
6788 replace existing text on a one-for-one basis, rather than pushing
6789 it to the right. At the end of a line, such characters extend
6790 the line. Before a tab, such characters insert until the tab is
6792 overwrite mode; this is supposed to make it easier to insert
6793 characters when necessary."
6798 "Toggle Binary Overwrite mode.
6799 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6800 is positive, and disable it otherwise. If called from Lisp,
6801 enable the mode if ARG is omitted or nil.
6803 When Binary Overwrite mode is enabled, printing characters typed
6804 in replace existing text. Newlines are not treated specially, so
6805 typing at the end of a line joins the line to the next, with the
6806 typed character between them. Typing before a tab character
6807 simply replaces the tab with the character typed.
6809 ordinary typing characters do.
6811 Note that Binary Overwrite mode is not its own minor mode; it is
6812 a specialization of overwrite mode, entered by setting the
6813 `overwrite-mode' variable to `overwrite-mode-binary'."
6818 "Toggle line number display in the mode line (Line Number mode).
6819 With a prefix argument ARG, enable Line Number mode if ARG is
6820 positive, and disable it otherwise. If called from Lisp, enable
6821 the mode if ARG is omitted or nil.
6823 Line numbers do not appear for very large buffers and buffers
6824 with very long lines; see variables `line-number-display-limit'
6825 and `line-number-display-limit-width'."
6829 "Toggle column number display in the mode line (Column Number mode).
6830 With a prefix argument ARG, enable Column Number mode if ARG is
6831 positive, and disable it otherwise.
6833 If called from Lisp, enable the mode if ARG is omitted or nil."
6837 "Toggle buffer size display in the mode line (Size Indication mode).
6838 With a prefix argument ARG, enable Size Indication mode if ARG is
6839 positive, and disable it otherwise.
6841 If called from Lisp, enable the mode if ARG is omitted or nil."
6845 "Toggle auto-saving in the current buffer (Auto Save mode).
6846 With a prefix argument ARG, enable Auto Save mode if ARG is
6847 positive, and disable it otherwise.
6849 If called from Lisp, enable the mode if ARG is omitted or nil."
6851 ;; If auto-save is off because buffer has shrunk,
6852 ;; then toggling should turn it on.
6860 buffer-file-name)
6862 ;; If -1 was stored here, to temporarily turn off saving,
6863 ;; turn it back on.
6866 \f
6868 "Blinking matching of parens and expressions."
6873 "Non-nil means show matching open-paren when close-paren is inserted.
6874 If t, highlight the paren. If `jump', move cursor to its position."
6882 "Non-nil means show matching open-paren when it is on screen.
6883 If nil, don't show it (but the open-paren can still be shown
6884 when it is off screen).
6886 This variable has no effect if `blink-matching-paren' is nil.
6887 \(In that case, the open-paren is never shown.)
6888 It is also ignored if `show-paren-mode' is enabled."
6893 "If non-nil, maximum distance to search backwards for matching open-paren.
6894 If nil, search stops at the beginning of the accessible portion of the buffer."
6900 "Time in seconds to delay after showing a matching paren."
6905 "If nil, `blink-matching-paren' ignores comments.
6906 More precisely, when looking for the matching parenthesis,
6907 it skips the contents of comments that end before point."
6912 "Return whether or not START...END are matching parens.
6913 END is the current point and START is the blink position.
6914 START might be nil if no matching starter was found.
6915 Returns non-nil if we find there is a mismatch."
6920 ;; For self-matched chars like " and $, we can't know when they're
6921 ;; mismatched or unmatched, so we can only do it for parens.
6926 ;; The cdr might hold a new paren-class info rather than
6927 ;; a matching-char info, in which case the two CDRs
6928 ;; should match.
6932 "Function to check parentheses mismatches.
6933 The function takes two arguments (START and END) where START is the
6934 position just before the opening token and END is the position right after.
6935 START can be nil, if it was not found.
6942 ol)
6946 "Momentarily highlight the beginning of the sexp before point."
6949 blink-matching-paren)
6959 oldpos))
6967 ;; backward-sexp skips backward over prefix chars,
6968 ;; so move back to the matching paren.
6989 ;; Matching open within window, temporarily move to or highlight
6990 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
6991 ;; is non-nil.
7008 ;; Show what precedes the open in its line, if anything.
7013 ;; Show what follows the open in its line, if anything.
7020 ;; Otherwise show the previous nonblank line,
7021 ;; if there is one.
7030 ;; Replace the newline and other whitespace with `...'.
7031 "..."
7033 ;; There is nothing to show except the char itself.
7036 "Matches %s"
7040 "Function called, if non-nil, whenever a close parenthesis is inserted.
7046 blink-paren-function
7049 ;; Verify an even number of quoting characters precede the close.
7050 ;; FIXME: Also check if this parenthesis closes a comment as
7051 ;; can happen in Pascal and SML.
7062 ;; Most likely, this hook is nil, so this arg doesn't matter,
7063 ;; but I use it as a reminder that this function usually
7064 ;; likes to be run after others since it does
7065 ;; `sit-for'. That's also the reason it get a `priority' prop
7066 ;; of 100.
7068 \f
7069 ;; This executes C-g typed while Emacs is waiting for a command.
7070 ;; Quitting out of a program does not go through here;
7071 ;; that happens in the QUIT macro at the C code level.
7073 "Signal a `quit' condition.
7074 During execution of Lisp code, this character causes a quit directly.
7075 At top-level, as an editor command, this simply beeps."
7077 ;; Avoid adding the region to the window selection.
7085 ;; Force the next redisplay cycle to remove the "Def" indicator from
7086 ;; all the mode lines.
7100 This command can exit an interactive command such as `query-replace',
7101 can clear out a prefix argument or a region,
7102 can get out of the minibuffer or other recursive edit,
7103 cancel the use of the current buffer (for special-purpose buffers),
7104 or go back to just one window (by deleting all but the selected window)."
7112 nil)
7123 "Play sound stored in FILE.
7124 VOLUME and DEVICE correspond to the keywords of the sound
7125 specification for `play-sound'."
7135 \f
7137 "Your preference for a mail reading package.
7138 This is used by some keybindings which support reading mail.
7139 See also `mail-user-agent' concerning sending mail."
7149 "Your preference for a mail composition package.
7150 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7151 outgoing email message. This variable lets you specify which
7152 mail-sending package you prefer.
7154 Valid values include:
7156 `message-user-agent' -- use the Message package.
7157 See Info node `(message)'.
7158 `sendmail-user-agent' -- use the Mail package.
7159 See Info node `(emacs)Sending Mail'.
7160 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7161 See Info node `(mh-e)'.
7162 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7163 paraphernalia if Gnus is running, particularly
7164 the Gcc: header for archiving.
7166 Additional valid symbols may be available; check with the author of
7167 your package for details. The function should return non-nil if it
7168 succeeds.
7170 See also `read-mail-command' concerning reading mail."
7173 message-user-agent)
7176 sendmail-user-agent)
7179 mh-e-user-agent)
7182 gnus-user-agent)
7188 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7189 If the value of `mail-user-agent' is the default, and the user
7190 appears to have customizations applying to the old default,
7191 `compose-mail' issues a warning."
7197 "If the buffer starts with a mail header, move point to the header's end.
7198 Otherwise, moves to `point-min'.
7199 The end of the header is the start of the next line, if there is one,
7200 else the end of the last line. This function obeys RFC822."
7206 ;; Used by Rmail (e.g., rmail-forward).
7208 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7212 switch-function yank-action send-actions
7213 return-action)
7214 "Start composing a mail message to send.
7215 This uses the user's chosen mail composition package
7216 as selected with the variable `mail-user-agent'.
7217 The optional arguments TO and SUBJECT specify recipients
7218 and the initial Subject field, respectively.
7220 OTHER-HEADERS is an alist specifying additional
7221 header fields. Elements look like (HEADER . VALUE) where both
7222 HEADER and VALUE are strings.
7224 CONTINUE, if non-nil, says to continue editing a message already
7225 being composed. Interactively, CONTINUE is the prefix argument.
7227 SWITCH-FUNCTION, if non-nil, is a function to use to
7228 switch to and display the buffer used for mail composition.
7230 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7231 to insert the raw text of the message being replied to.
7232 It has the form (FUNCTION . ARGS). The user agent will apply
7233 FUNCTION to ARGS, to insert the raw text of the original message.
7234 \(The user agent will also run `mail-citation-hook', *after* the
7235 original text has been inserted in this way.)
7237 SEND-ACTIONS is a list of actions to call when the message is sent.
7238 Each action has the form (FUNCTION . ARGS).
7240 RETURN-ACTION, if non-nil, is an action for returning to the
7241 caller. It has the form (FUNCTION . ARGS). The function is
7242 called after the mail has been sent or put aside, and the mail
7243 buffer buried."
7247 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7248 ;; from sendmail-user-agent to message-user-agent. Some users may
7249 ;; encounter incompatibilities. This hack tries to detect problems
7250 ;; and warn about them.
7255 mail-yank-hooks mail-archive-file-name
7256 mail-default-reply-to mail-mailing-lists
7257 mail-self-blind))
7264 The default mail mode is now Message mode.
7265 You have the following Mail mode variable%s customized:
7267 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7274 yank-action send-actions return-action)))
7277 yank-action send-actions
7278 return-action)
7282 'switch-to-buffer-other-window yank-action send-actions
7283 return-action))
7286 yank-action send-actions
7287 return-action)
7291 'switch-to-buffer-other-frame yank-action send-actions
7292 return-action))
7294 \f
7296 "History of values entered with `set-variable'.
7298 Maximum length of the history list is determined by the value
7302 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7303 VARIABLE should be a user option variable name, a Lisp variable
7304 meant to be customized by users. You should enter VALUE in Lisp syntax,
7305 so if you want VALUE to be a string, you must surround it with doublequotes.
7306 VALUE is used literally, not evaluated.
7308 If VARIABLE has a `variable-interactive' property, that is used as if
7309 it were the arg to `interactive' (which see) to interactively read VALUE.
7311 If VARIABLE has been defined with `defcustom', then the type information
7312 in the definition is used to check that VALUE is valid.
7314 Note that this function is at heart equivalent to the basic `set' function.
7315 For a variable defined with `defcustom', it does not pay attention to
7316 any :set property that the variable might have (if you want that, use
7319 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7324 default-var)
7340 var obsolete)
7343 ;; Use VAR's `variable-interactive' property
7344 ;; as an interactive spec for prompting.
7347 arg))
7349 read-expression-map t
7350 'set-variable-value-history
7359 ;; Match with custom type.
7371 ;; Force a thorough redisplay for the case that the variable
7372 ;; has an effect on the display, like `tab-width' has.
7374 \f
7375 ;; Define the major mode for lists of completions.
7385 (define-key map [right] 'next-completion)
7387 (define-key map [backtab] 'previous-completion)
7388 (define-key map "q" 'quit-window)
7389 (define-key map "z" 'kill-this-buffer)
7390 map)
7391 "Local map for completion list buffers.")
7393 ;; Completion mode is suitable only for specially formatted data.
7394 (put 'completion-list-mode 'mode-class 'special)
7396 (defvar completion-reference-buffer nil
7397 "Record the buffer that was current when the completion list was requested.
7398 This is a local variable in the completion list buffer.
7399 Initial value is nil to avoid some compiler warnings.")
7401 (defvar completion-no-auto-exit nil
7402 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7403 This also applies to other functions such as `choose-completion'.")
7405 (defvar completion-base-position nil
7406 "Position of the base of the text corresponding to the shown completions.
7407 This variable is used in the *Completions* buffers.
7408 Its value is a list of the form (START END) where START is the place
7409 where the completion should be inserted and END (if non-nil) is the end
7410 of the text to replace. If END is nil, point is used instead.")
7412 (defvar completion-list-insert-choice-function #'completion--replace
7413 "Function to use to insert the text chosen in *Completions*.
7414 Called with three arguments (BEG END TEXT), it should replace the text
7415 between BEG and END with TEXT. Expected to be set buffer-locally
7416 in the *Completions* buffer.")
7418 (defvar completion-base-size nil
7419 "Number of chars before point not involved in completion.
7420 This is a local variable in the completion list buffer.
7421 It refers to the chars in the minibuffer if completing in the
7422 minibuffer, or in `completion-reference-buffer' otherwise.
7423 Only characters in the field at point are included.
7425 If nil, Emacs determines which part of the tail end of the
7426 buffer's text is involved in completion by comparing the text
7427 directly.")
7428 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7430 (defun delete-completion-window ()
7431 "Delete the completion list window.
7432 Go to the window from which completion was requested."
7433 (interactive)
7434 (let ((buf completion-reference-buffer))
7435 (if (one-window-p t)
7436 (if (window-dedicated-p) (delete-frame))
7437 (delete-window (selected-window))
7438 (if (get-buffer-window buf)
7439 (select-window (get-buffer-window buf))))))
7441 (defun previous-completion (n)
7442 "Move to the previous item in the completion list."
7443 (interactive "p")
7444 (next-completion (- n)))
7446 (defun next-completion (n)
7447 "Move to the next item in the completion list.
7448 With prefix argument N, move N items (negative N means move backward)."
7449 (interactive "p")
7450 (let ((beg (point-min)) (end (point-max)))
7451 (while (and (> n 0) (not (eobp)))
7452 ;; If in a completion, move to the end of it.
7453 (when (get-text-property (point) 'mouse-face)
7454 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7455 ;; Move to start of next one.
7456 (unless (get-text-property (point) 'mouse-face)
7457 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7458 (setq n (1- n)))
7459 (while (and (< n 0) (not (bobp)))
7460 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7461 ;; If in a completion, move to the start of it.
7462 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7463 (goto-char (previous-single-property-change
7464 (point) 'mouse-face nil beg)))
7465 ;; Move to end of the previous completion.
7466 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7467 (goto-char (previous-single-property-change
7468 (point) 'mouse-face nil beg)))
7469 ;; Move to the start of that one.
7470 (goto-char (previous-single-property-change
7471 (point) 'mouse-face nil beg))
7472 (setq n (1+ n))))))
7474 (defun choose-completion (&optional event)
7475 "Choose the completion at point.
7476 If EVENT, use EVENT's position to determine the starting position."
7477 (interactive (list last-nonmenu-event))
7478 ;; In case this is run via the mouse, give temporary modes such as
7479 ;; isearch a chance to turn off.
7480 (run-hooks 'mouse-leave-buffer-hook)
7481 (with-current-buffer (window-buffer (posn-window (event-start event)))
7482 (let ((buffer completion-reference-buffer)
7483 (base-size completion-base-size)
7484 (base-position completion-base-position)
7485 (insert-function completion-list-insert-choice-function)
7486 (choice
7487 (save-excursion
7488 (goto-char (posn-point (event-start event)))
7489 (let (beg end)
7490 (cond
7491 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7492 (setq end (point) beg (1+ (point))))
7493 ((and (not (bobp))
7494 (get-text-property (1- (point)) 'mouse-face))
7495 (setq end (1- (point)) beg (point)))
7496 (t (error "No completion here")))
7497 (setq beg (previous-single-property-change beg 'mouse-face))
7498 (setq end (or (next-single-property-change end 'mouse-face)
7499 (point-max)))
7500 (buffer-substring-no-properties beg end)))))
7502 (unless (buffer-live-p buffer)
7503 (error "Destination buffer is dead"))
7504 (quit-window nil (posn-window (event-start event)))
7506 (with-current-buffer buffer
7507 (choose-completion-string
7508 choice buffer
7509 (or base-position
7510 (when base-size
7511 ;; Someone's using old completion code that doesn't know
7512 ;; about base-position yet.
7513 (list (+ base-size (field-beginning))))
7514 ;; If all else fails, just guess.
7515 (list (choose-completion-guess-base-position choice)))
7516 insert-function)))))
7518 ;; Delete the longest partial match for STRING
7519 ;; that can be found before POINT.
7520 (defun choose-completion-guess-base-position (string)
7521 (save-excursion
7522 (let ((opoint (point))
7523 len)
7524 ;; Try moving back by the length of the string.
7525 (goto-char (max (- (point) (length string))
7526 (minibuffer-prompt-end)))
7527 ;; See how far back we were actually able to move. That is the
7528 ;; upper bound on how much we can match and delete.
7529 (setq len (- opoint (point)))
7530 (if completion-ignore-case
7531 (setq string (downcase string)))
7532 (while (and (> len 0)
7533 (let ((tail (buffer-substring (point) opoint)))
7534 (if completion-ignore-case
7535 (setq tail (downcase tail)))
7536 (not (string= tail (substring string 0 len)))))
7537 (setq len (1- len))
7538 (forward-char 1))
7539 (point))))
7541 (defun choose-completion-delete-max-match (string)
7542 (declare (obsolete choose-completion-guess-base-position "23.2"))
7543 (delete-region (choose-completion-guess-base-position string) (point)))
7545 (defvar choose-completion-string-functions nil
7546 "Functions that may override the normal insertion of a completion choice.
7547 These functions are called in order with three arguments:
7548 CHOICE - the string to insert in the buffer,
7549 BUFFER - the buffer in which the choice should be inserted,
7550 BASE-POSITION - where to insert the completion.
7552 If a function in the list returns non-nil, that function is supposed
7553 to have inserted the CHOICE in the BUFFER, and possibly exited
7554 the minibuffer; no further functions will be called.
7556 If all functions in the list return nil, that means to use
7557 the default method of inserting the completion in BUFFER.")
7559 (defun choose-completion-string (choice &optional
7560 buffer base-position insert-function)
7561 "Switch to BUFFER and insert the completion choice CHOICE.
7562 BASE-POSITION says where to insert the completion.
7563 INSERT-FUNCTION says how to insert the completion and falls
7564 back on `completion-list-insert-choice-function' when nil."
7566 ;; If BUFFER is the minibuffer, exit the minibuffer
7567 ;; unless it is reading a file name and CHOICE is a directory,
7568 ;; or completion-no-auto-exit is non-nil.
7570 ;; Some older code may call us passing `base-size' instead of
7571 ;; `base-position'. It's difficult to make any use of `base-size',
7572 ;; so we just ignore it.
7573 (unless (consp base-position)
7574 (message "Obsolete `base-size' passed to choose-completion-string")
7575 (setq base-position nil))
7577 (let* ((buffer (or buffer completion-reference-buffer))
7578 (mini-p (minibufferp buffer)))
7579 ;; If BUFFER is a minibuffer, barf unless it's the currently
7580 ;; active minibuffer.
7581 (if (and mini-p
7582 (not (and (active-minibuffer-window)
7583 (equal buffer
7584 (window-buffer (active-minibuffer-window))))))
7585 (error "Minibuffer is not active for completion")
7586 ;; Set buffer so buffer-local choose-completion-string-functions works.
7587 (set-buffer buffer)
7588 (unless (run-hook-with-args-until-success
7589 'choose-completion-string-functions
7590 ;; The fourth arg used to be `mini-p' but was useless
7591 ;; (since minibufferp can be used on the `buffer' arg)
7592 ;; and indeed unused. The last used to be `base-size', so we
7593 ;; keep it to try and avoid breaking old code.
7594 choice buffer base-position nil)
7595 ;; This remove-text-properties should be unnecessary since `choice'
7596 ;; comes from buffer-substring-no-properties.
7597 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7598 ;; Insert the completion into the buffer where it was requested.
7599 (funcall (or insert-function completion-list-insert-choice-function)
7600 (or (car base-position) (point))
7601 (or (cadr base-position) (point))
7602 choice)
7603 ;; Update point in the window that BUFFER is showing in.
7604 (let ((window (get-buffer-window buffer t)))
7605 (set-window-point window (point)))
7606 ;; If completing for the minibuffer, exit it with this choice.
7607 (and (not completion-no-auto-exit)
7608 (minibufferp buffer)
7609 minibuffer-completion-table
7610 ;; If this is reading a file name, and the file name chosen
7611 ;; is a directory, don't exit the minibuffer.
7612 (let* ((result (buffer-substring (field-beginning) (point)))
7613 (bounds
7614 (completion-boundaries result minibuffer-completion-table
7615 minibuffer-completion-predicate
7616 "")))
7617 (if (eq (car bounds) (length result))
7618 ;; The completion chosen leads to a new set of completions
7619 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7620 (let ((mini (active-minibuffer-window)))
7621 (select-window mini)
7622 (when minibuffer-auto-raise
7623 (raise-frame (window-frame mini))))
7624 (exit-minibuffer))))))))
7626 (define-derived-mode completion-list-mode nil "Completion List"
7627 "Major mode for buffers showing lists of possible completions.
7629 to select the completion near point.
7630 Or click to select one with the mouse.
7633 (set (make-local-variable 'completion-base-size) nil))
7635 (defun completion-list-mode-finish ()
7636 "Finish setup of the completions buffer.
7637 Called from `temp-buffer-show-hook'."
7638 (when (eq major-mode 'completion-list-mode)
7639 (setq buffer-read-only t)))
7641 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7644 ;; Variables and faces used in `completion-setup-function'.
7646 (defcustom completion-show-help t
7647 "Non-nil means show help message in *Completions* buffer."
7648 :type 'boolean
7649 :version "22.1"
7650 :group 'completion)
7652 ;; This function goes in completion-setup-hook, so that it is called
7653 ;; after the text of the completion list buffer is written.
7654 (defun completion-setup-function ()
7655 (let* ((mainbuf (current-buffer))
7656 (base-dir
7657 ;; FIXME: This is a bad hack. We try to set the default-directory
7658 ;; in the *Completions* buffer so that the relative file names
7659 ;; displayed there can be treated as valid file names, independently
7660 ;; from the completion context. But this suffers from many problems:
7661 ;; - It's not clear when the completions are file names. With some
7662 ;; completion tables (e.g. bzr revision specs), the listed
7663 ;; completions can mix file names and other things.
7664 ;; - It doesn't pay attention to possible quoting.
7665 ;; - With fancy completion styles, the code below will not always
7666 ;; find the right base directory.
7667 (if minibuffer-completing-file-name
7668 (file-name-as-directory
7669 (expand-file-name
7670 (buffer-substring (minibuffer-prompt-end)
7671 (- (point) (or completion-base-size 0))))))))
7672 (with-current-buffer standard-output
7673 (let ((base-size completion-base-size) ;Read before killing localvars.
7674 (base-position completion-base-position)
7675 (insert-fun completion-list-insert-choice-function))
7676 (completion-list-mode)
7677 (set (make-local-variable 'completion-base-size) base-size)
7678 (set (make-local-variable 'completion-base-position) base-position)
7679 (set (make-local-variable 'completion-list-insert-choice-function)
7680 insert-fun))
7681 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7682 (if base-dir (setq default-directory base-dir))
7683 ;; Maybe insert help string.
7684 (when completion-show-help
7685 (goto-char (point-min))
7686 (if (display-mouse-p)
7687 (insert (substitute-command-keys
7689 (insert (substitute-command-keys
7693 (add-hook 'completion-setup-hook 'completion-setup-function)
7695 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7696 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7698 (defun switch-to-completions ()
7699 "Select the completion list window."
7700 (interactive)
7701 (let ((window (or (get-buffer-window "*Completions*" 0)
7702 ;; Make sure we have a completions window.
7703 (progn (minibuffer-completion-help)
7704 (get-buffer-window "*Completions*" 0)))))
7705 (when window
7706 (select-window window)
7707 ;; In the new buffer, go to the first completion.
7708 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
7709 (when (bobp)
7710 (next-completion 1)))))
7711 \f
7712 ;;; Support keyboard commands to turn on various modifiers.
7714 ;; These functions -- which are not commands -- each add one modifier
7715 ;; to the following event.
7717 (defun event-apply-alt-modifier (_ignore-prompt)
7720 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
7721 (defun event-apply-super-modifier (_ignore-prompt)
7724 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
7725 (defun event-apply-hyper-modifier (_ignore-prompt)
7728 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
7729 (defun event-apply-shift-modifier (_ignore-prompt)
7732 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
7733 (defun event-apply-control-modifier (_ignore-prompt)
7736 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
7737 (defun event-apply-meta-modifier (_ignore-prompt)
7740 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
7742 (defun event-apply-modifier (event symbol lshiftby prefix)
7743 "Apply a modifier flag to event EVENT.
7744 SYMBOL is the name of this modifier, as a symbol.
7745 LSHIFTBY is the numeric value of this modifier, in keyboard events.
7746 PREFIX is the string that represents this modifier in an event type symbol."
7747 (if (numberp event)
7748 (cond ((eq symbol 'control)
7749 (if (and (<= (downcase event) ?z)
7750 (>= (downcase event) ?a))
7751 (- (downcase event) ?a -1)
7752 (if (and (<= (downcase event) ?Z)
7753 (>= (downcase event) ?A))
7754 (- (downcase event) ?A -1)
7755 (logior (lsh 1 lshiftby) event))))
7756 ((eq symbol 'shift)
7757 (if (and (<= (downcase event) ?z)
7758 (>= (downcase event) ?a))
7759 (upcase event)
7760 (logior (lsh 1 lshiftby) event)))
7761 (t
7762 (logior (lsh 1 lshiftby) event)))
7763 (if (memq symbol (event-modifiers event))
7764 event
7765 (let ((event-type (if (symbolp event) event (car event))))
7766 (setq event-type (intern (concat prefix (symbol-name event-type))))
7767 (if (symbolp event)
7768 event-type
7769 (cons event-type (cdr event)))))))
7771 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
7772 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
7773 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
7774 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
7775 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
7776 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
7777 \f
7778 ;;;; Keypad support.
7780 ;; Make the keypad keys act like ordinary typing keys. If people add
7781 ;; bindings for the function key symbols, then those bindings will
7782 ;; override these, so this shouldn't interfere with any existing
7783 ;; bindings.
7785 ;; Also tell read-char how to handle these keys.
7786 (mapc
7787 (lambda (keypad-normal)
7788 (let ((keypad (nth 0 keypad-normal))
7789 (normal (nth 1 keypad-normal)))
7790 (put keypad 'ascii-character normal)
7791 (define-key function-key-map (vector keypad) (vector normal))))
7792 ;; See also kp-keys bound in bindings.el.
7793 '((kp-space ?\s)
7796 (kp-separator ?,)
7797 (kp-equal ?=)
7798 ;; Do the same for various keys that are represented as symbols under
7799 ;; GUIs but naturally correspond to characters.
7800 (backspace 127)
7801 (delete 127)
7804 (clear ?\C-l)
7805 (return ?\C-m)
7806 (escape ?\e)
7807 ))
7808 \f
7809 ;;;;
7810 ;;;; forking a twin copy of a buffer.
7811 ;;;;
7813 (defvar clone-buffer-hook nil
7814 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7816 (defvar clone-indirect-buffer-hook nil
7817 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7819 (defun clone-process (process &optional newname)
7820 "Create a twin copy of PROCESS.
7821 If NEWNAME is nil, it defaults to PROCESS' name;
7822 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7823 If PROCESS is associated with a buffer, the new process will be associated
7824 with the current buffer instead.
7825 Returns nil if PROCESS has already terminated."
7826 (setq newname (or newname (process-name process)))
7828 (setq newname (substring newname 0 (match-beginning 0))))
7829 (when (memq (process-status process) '(run stop open))
7830 (let* ((process-connection-type (process-tty-name process))
7831 (new-process
7832 (if (memq (process-status process) '(open))
7833 (let ((args (process-contact process t)))
7834 (setq args (plist-put args :name newname))
7835 (setq args (plist-put args :buffer
7836 (if (process-buffer process)
7837 (current-buffer))))
7838 (apply 'make-network-process args))
7839 (apply 'start-process newname
7840 (if (process-buffer process) (current-buffer))
7841 (process-command process)))))
7842 (set-process-query-on-exit-flag
7843 new-process (process-query-on-exit-flag process))
7844 (set-process-inherit-coding-system-flag
7845 new-process (process-inherit-coding-system-flag process))
7846 (set-process-filter new-process (process-filter process))
7847 (set-process-sentinel new-process (process-sentinel process))
7848 (set-process-plist new-process (copy-sequence (process-plist process)))
7849 new-process)))
7851 ;; things to maybe add (currently partly covered by `funcall mode'):
7852 ;; - syntax-table
7853 ;; - overlays
7854 (defun clone-buffer (&optional newname display-flag)
7855 "Create and return a twin copy of the current buffer.
7856 Unlike an indirect buffer, the new buffer can be edited
7857 independently of the old one (if it is not read-only).
7858 NEWNAME is the name of the new buffer. It may be modified by
7859 adding or incrementing <N> at the end as necessary to create a
7860 unique buffer name. If nil, it defaults to the name of the
7861 current buffer, with the proper suffix. If DISPLAY-FLAG is
7862 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7863 clone a file-visiting buffer, or a buffer whose major mode symbol
7864 has a non-nil `no-clone' property, results in an error.
7866 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7867 current buffer with appropriate suffix. However, if a prefix
7868 argument is given, then the command prompts for NEWNAME in the
7869 minibuffer.
7871 This runs the normal hook `clone-buffer-hook' in the new buffer
7872 after it has been set up properly in other respects."
7873 (interactive
7874 (progn
7875 (if buffer-file-name
7876 (error "Cannot clone a file-visiting buffer"))
7877 (if (get major-mode 'no-clone)
7878 (error "Cannot clone a buffer in %s mode" mode-name))
7879 (list (if current-prefix-arg
7880 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7881 t)))
7882 (if buffer-file-name
7883 (error "Cannot clone a file-visiting buffer"))
7884 (if (get major-mode 'no-clone)
7885 (error "Cannot clone a buffer in %s mode" mode-name))
7886 (setq newname (or newname (buffer-name)))
7888 (setq newname (substring newname 0 (match-beginning 0))))
7889 (let ((buf (current-buffer))
7890 (ptmin (point-min))
7891 (ptmax (point-max))
7892 (pt (point))
7893 (mk (if mark-active (mark t)))
7894 (modified (buffer-modified-p))
7895 (mode major-mode)
7896 (lvars (buffer-local-variables))
7897 (process (get-buffer-process (current-buffer)))
7898 (new (generate-new-buffer (or newname (buffer-name)))))
7899 (save-restriction
7900 (widen)
7901 (with-current-buffer new
7902 (insert-buffer-substring buf)))
7903 (with-current-buffer new
7904 (narrow-to-region ptmin ptmax)
7905 (goto-char pt)
7906 (if mk (set-mark mk))
7907 (set-buffer-modified-p modified)
7909 ;; Clone the old buffer's process, if any.
7910 (when process (clone-process process))
7912 ;; Now set up the major mode.
7913 (funcall mode)
7915 ;; Set up other local variables.
7916 (mapc (lambda (v)
7917 (condition-case () ;in case var is read-only
7918 (if (symbolp v)
7919 (makunbound v)
7920 (set (make-local-variable (car v)) (cdr v)))
7921 (error nil)))
7922 lvars)
7924 ;; Run any hooks (typically set up by the major mode
7925 ;; for cloning to work properly).
7926 (run-hooks 'clone-buffer-hook))
7927 (if display-flag
7928 ;; Presumably the current buffer is shown in the selected frame, so
7929 ;; we want to display the clone elsewhere.
7930 (let ((same-window-regexps nil)
7931 (same-window-buffer-names))
7932 (pop-to-buffer new)))
7933 new))
7936 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7937 "Create an indirect buffer that is a twin copy of the current buffer.
7939 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7940 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7941 or if not called with a prefix arg, NEWNAME defaults to the current
7942 buffer's name. The name is modified by adding a `<N>' suffix to it
7943 or by incrementing the N in an existing suffix. Trying to clone a
7944 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7945 property results in an error.
7947 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7948 This is always done when called interactively.
7950 Optional third arg NORECORD non-nil means do not put this buffer at the
7951 front of the list of recently selected ones.
7953 Returns the newly created indirect buffer."
7954 (interactive
7955 (progn
7956 (if (get major-mode 'no-clone-indirect)
7957 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7958 (list (if current-prefix-arg
7959 (read-buffer "Name of indirect buffer: " (current-buffer)))
7960 t)))
7961 (if (get major-mode 'no-clone-indirect)
7962 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7963 (setq newname (or newname (buffer-name)))
7965 (setq newname (substring newname 0 (match-beginning 0))))
7966 (let* ((name (generate-new-buffer-name newname))
7967 (buffer (make-indirect-buffer (current-buffer) name t)))
7968 (with-current-buffer buffer
7969 (run-hooks 'clone-indirect-buffer-hook))
7970 (when display-flag
7971 (pop-to-buffer buffer norecord))
7972 buffer))
7975 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7976 "Like `clone-indirect-buffer' but display in another window."
7977 (interactive
7978 (progn
7979 (if (get major-mode 'no-clone-indirect)
7980 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7981 (list (if current-prefix-arg
7982 (read-buffer "Name of indirect buffer: " (current-buffer)))
7983 t)))
7984 (let ((pop-up-windows t))
7985 (clone-indirect-buffer newname display-flag norecord)))
7987 \f
7988 ;;; Handling of Backspace and Delete keys.
7990 (defcustom normal-erase-is-backspace 'maybe
7991 "Set the default behavior of the Delete and Backspace keys.
7993 If set to t, Delete key deletes forward and Backspace key deletes
7994 backward.
7996 If set to nil, both Delete and Backspace keys delete backward.
7998 If set to 'maybe (which is the default), Emacs automatically
7999 selects a behavior. On window systems, the behavior depends on
8000 the keyboard used. If the keyboard has both a Backspace key and
8001 a Delete key, and both are mapped to their usual meanings, the
8002 option's default value is set to t, so that Backspace can be used
8003 to delete backward, and Delete can be used to delete forward.
8005 If not running under a window system, customizing this option
8006 accomplishes a similar effect by mapping C-h, which is usually
8007 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8008 via `keyboard-translate'. The former functionality of C-h is
8009 available on the F1 key. You should probably not use this
8010 setting if you don't have both Backspace, Delete and F1 keys.
8012 Setting this variable with setq doesn't take effect. Programmatically,
8013 call `normal-erase-is-backspace-mode' (which see) instead."
8014 :type '(choice (const :tag "Off" nil)
8015 (const :tag "Maybe" maybe)
8016 (other :tag "On" t))
8017 :group 'editing-basics
8018 :version "21.1"
8019 :set (lambda (symbol value)
8020 ;; The fboundp is because of a problem with :set when
8021 ;; dumping Emacs. It doesn't really matter.
8022 (if (fboundp 'normal-erase-is-backspace-mode)
8023 (normal-erase-is-backspace-mode (or value 0))
8024 (set-default symbol value))))
8026 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8027 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8028 (unless frame (setq frame (selected-frame)))
8029 (with-selected-frame frame
8030 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8031 (normal-erase-is-backspace-mode
8032 (if (if (eq normal-erase-is-backspace 'maybe)
8033 (and (not noninteractive)
8034 (or (memq system-type '(ms-dos windows-nt))
8035 (memq window-system '(w32 ns))
8036 (and (memq window-system '(x))
8037 (fboundp 'x-backspace-delete-keys-p)
8038 (x-backspace-delete-keys-p))
8039 ;; If the terminal Emacs is running on has erase char
8040 ;; set to ^H, use the Backspace key for deleting
8041 ;; backward, and the Delete key for deleting forward.
8042 (and (null window-system)
8043 (eq tty-erase-char ?\^H))))
8044 normal-erase-is-backspace)
8045 1 0)))))
8047 (define-minor-mode normal-erase-is-backspace-mode
8048 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8049 With a prefix argument ARG, enable this feature if ARG is
8050 positive, and disable it otherwise. If called from Lisp, enable
8051 the mode if ARG is omitted or nil.
8053 On window systems, when this mode is on, Delete is mapped to C-d
8054 and Backspace is mapped to DEL; when this mode is off, both
8055 Delete and Backspace are mapped to DEL. (The remapping goes via
8056 `local-function-key-map', so binding Delete or Backspace in the
8057 global or local keymap will override that.)
8059 In addition, on window systems, the bindings of C-Delete, M-Delete,
8060 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8061 the global keymap in accordance with the functionality of Delete and
8062 Backspace. For example, if Delete is remapped to C-d, which deletes
8063 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8064 to DEL, which deletes backward, C-Delete is bound to
8065 `backward-kill-word'.
8067 If not running on a window system, a similar effect is accomplished by
8068 remapping C-h (normally produced by the Backspace key) and DEL via
8069 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8070 to C-d; if it's off, the keys are not remapped.
8072 When not running on a window system, and this mode is turned on, the
8073 former functionality of C-h is available on the F1 key. You should
8074 probably not turn on this mode on a text-only terminal if you don't
8075 have both Backspace, Delete and F1 keys.
8077 See also `normal-erase-is-backspace'."
8078 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8079 . (lambda (v)
8080 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8081 (if v 1 0))))
8082 (let ((enabled (eq 1 (terminal-parameter
8083 nil 'normal-erase-is-backspace))))
8085 (cond ((or (memq window-system '(x w32 ns pc))
8086 (memq system-type '(ms-dos windows-nt)))
8087 (let ((bindings
8088 `(([M-delete] [M-backspace])
8089 ([C-M-delete] [C-M-backspace])
8090 ([?\e C-delete] [?\e C-backspace]))))
8092 (if enabled
8093 (progn
8094 (define-key local-function-key-map [delete] [deletechar])
8095 (define-key local-function-key-map [kp-delete] [deletechar])
8096 (define-key local-function-key-map [backspace] [?\C-?])
8097 (dolist (b bindings)
8098 ;; Not sure if input-decode-map is really right, but
8099 ;; keyboard-translate-table (used below) only works
8100 ;; for integer events, and key-translation-table is
8101 ;; global (like the global-map, used earlier).
8102 (define-key input-decode-map (car b) nil)
8103 (define-key input-decode-map (cadr b) nil)))
8104 (define-key local-function-key-map [delete] [?\C-?])
8105 (define-key local-function-key-map [kp-delete] [?\C-?])
8106 (define-key local-function-key-map [backspace] [?\C-?])
8107 (dolist (b bindings)
8108 (define-key input-decode-map (car b) (cadr b))
8109 (define-key input-decode-map (cadr b) (car b))))))
8110 (t
8111 (if enabled
8112 (progn
8113 (keyboard-translate ?\C-h ?\C-?)
8114 (keyboard-translate ?\C-? ?\C-d))
8115 (keyboard-translate ?\C-h ?\C-h)
8116 (keyboard-translate ?\C-? ?\C-?))))
8118 (if (called-interactively-p 'interactive)
8119 (message "Delete key deletes %s"
8120 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8121 "forward" "backward")))))
8122 \f
8123 (defvar vis-mode-saved-buffer-invisibility-spec nil
8124 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8126 (define-minor-mode read-only-mode
8127 "Change whether the current buffer is read-only.
8128 With prefix argument ARG, make the buffer read-only if ARG is
8129 positive, otherwise make it writable. If buffer is read-only
8130 and `view-read-only' is non-nil, enter view mode.
8132 Do not call this from a Lisp program unless you really intend to
8134 possibly enabling or disabling View mode. Also, note that this
8135 command works by setting the variable `buffer-read-only', which
8136 does not affect read-only regions caused by text properties. To
8137 ignore read-only status in a Lisp program (whether due to text
8138 properties or buffer state), bind `inhibit-read-only' temporarily
8139 to a non-nil value."
8140 :variable buffer-read-only
8141 (cond
8142 ((and (not buffer-read-only) view-mode)
8143 (View-exit-and-edit)
8144 (make-local-variable 'view-read-only)
8145 (setq view-read-only t)) ; Must leave view mode.
8146 ((and buffer-read-only view-read-only
8147 ;; If view-mode is already active, `view-mode-enter' is a nop.
8148 (not view-mode)
8149 (not (eq (get major-mode 'mode-class) 'special)))
8150 (view-mode-enter))))
8152 (define-minor-mode visible-mode
8153 "Toggle making all invisible text temporarily visible (Visible mode).
8154 With a prefix argument ARG, enable Visible mode if ARG is
8155 positive, and disable it otherwise. If called from Lisp, enable
8156 the mode if ARG is omitted or nil.
8158 This mode works by saving the value of `buffer-invisibility-spec'
8159 and setting it to nil."
8160 :lighter " Vis"
8161 :group 'editing-basics
8162 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8163 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8164 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8165 (when visible-mode
8166 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8167 buffer-invisibility-spec)
8168 (setq buffer-invisibility-spec nil)))
8169 \f
8170 (defvar messages-buffer-mode-map
8171 (let ((map (make-sparse-keymap)))
8172 (set-keymap-parent map special-mode-map)
8173 (define-key map "g" nil) ; nothing to revert
8174 map))
8176 (define-derived-mode messages-buffer-mode special-mode "Messages"
8179 (defun messages-buffer ()
8181 If it does not exist, create and it switch it to `messages-buffer-mode'."
8182 (or (get-buffer "*Messages*")
8183 (with-current-buffer (get-buffer-create "*Messages*")
8184 (messages-buffer-mode)
8185 (current-buffer))))
8187 \f
8188 ;; Minibuffer prompt stuff.
8190 ;;(defun minibuffer-prompt-modification (start end)
8191 ;; (error "You cannot modify the prompt"))
8192 ;;
8193 ;;
8194 ;;(defun minibuffer-prompt-insertion (start end)
8195 ;; (let ((inhibit-modification-hooks t))
8196 ;; (delete-region start end)
8197 ;; ;; Discard undo information for the text insertion itself
8198 ;; ;; and for the text deletion.above.
8199 ;; (when (consp buffer-undo-list)
8200 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8201 ;; (message "You cannot modify the prompt")))
8202 ;;
8203 ;;
8204 ;;(setq minibuffer-prompt-properties
8205 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8206 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8208 \f
8209 ;;;; Problematic external packages.
8211 ;; rms says this should be done by specifying symbols that define
8212 ;; versions together with bad values. This is therefore not as
8213 ;; flexible as it could be. See the thread:
8214 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8215 (defconst bad-packages-alist
8216 ;; Not sure exactly which semantic versions have problems.
8217 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8219 "The version of `semantic' loaded does not work in Emacs 22.
8220 It can cause constant high CPU load.
8221 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8222 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8223 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8224 ;; provided the `CUA-mode' feature. Since this is no longer true,
8225 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8226 (CUA-mode t nil
8227 "CUA-mode is now part of the standard GNU Emacs distribution,
8228 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8230 You have loaded an older version of CUA-mode which does not work
8231 correctly with this version of Emacs. You should remove the old
8232 version and use the one distributed with Emacs."))
8233 "Alist of packages known to cause problems in this version of Emacs.
8234 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8235 PACKAGE is either a regular expression to match file names, or a
8236 symbol (a feature name), like for `with-eval-after-load'.
8237 SYMBOL is either the name of a string variable, or t. Upon
8238 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8239 warning using STRING as the message.")
8241 (defun bad-package-check (package)
8242 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8243 (condition-case nil
8244 (let* ((list (assoc package bad-packages-alist))
8245 (symbol (nth 1 list)))
8246 (and list
8247 (boundp symbol)
8248 (or (eq symbol t)
8249 (and (stringp (setq symbol (eval symbol)))
8250 (string-match-p (nth 2 list) symbol)))
8251 (display-warning package (nth 3 list) :warning)))
8252 (error nil)))
8254 (dolist (elem bad-packages-alist)
8255 (let ((pkg (car elem)))
8256 (with-eval-after-load pkg
8257 (bad-package-check pkg))))
8259 \f
8260 ;;; Generic dispatcher commands
8262 ;; Macro `define-alternatives' is used to create generic commands.
8263 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8264 ;; that can have different alternative implementations where choosing
8265 ;; among them is exclusively a matter of user preference.
8267 ;; (define-alternatives COMMAND) creates a new interactive command
8268 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8269 ;; Typically, the user will not need to customize this variable; packages
8270 ;; wanting to add alternative implementations should use
8271 ;;
8272 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8274 (defmacro define-alternatives (command &rest customizations)
8275 "Define the new command `COMMAND'.
8277 The argument `COMMAND' should be a symbol.
8279 Running `M-x COMMAND RET' for the first time prompts for which
8280 alternative to use and records the selected command as a custom
8281 variable.
8283 Running `C-u M-x COMMAND RET' prompts again for an alternative
8284 and overwrites the previous choice.
8286 The variable `COMMAND-alternatives' contains an alist with
8287 alternative implementations of COMMAND. `define-alternatives'
8288 does not have any effect until this variable is set.
8290 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8291 `defcustom' keywords and values to add to the declaration of
8292 `COMMAND-alternatives' (typically :group and :version)."
8293 (let* ((command-name (symbol-name command))
8294 (varalt-name (concat command-name "-alternatives"))
8295 (varalt-sym (intern varalt-name))
8296 (varimp-sym (intern (concat command-name "--implementation"))))
8297 `(progn
8299 (defcustom ,varalt-sym nil
8300 ,(format "Alist of alternative implementations for the `%s' command.
8302 Each entry must be a pair (ALTNAME . ALTFUN), where:
8303 ALTNAME - The name shown at user to describe the alternative implementation.
8304 ALTFUN - The function called to implement this alternative."
8305 command-name)
8306 :type '(alist :key-type string :value-type function)
8307 ,@customizations)
8309 (put ',varalt-sym 'definition-name ',command)
8310 (defvar ,varimp-sym nil "Internal use only.")
8312 (defun ,command (&optional arg)
8313 ,(format "Run generic command `%s'.
8314 If used for the first time, or with interactive ARG, ask the user which
8315 implementation to use for `%s'. The variable `%s'
8316 contains the list of implementations currently supported for this command."
8317 command-name command-name varalt-name)
8318 (interactive "P")
8319 (when (or arg (null ,varimp-sym))
8320 (let ((val (completing-read
8321 ,(format "Select implementation for command `%s': "
8322 command-name)
8323 ,varalt-sym nil t)))
8324 (unless (string-equal val "")
8325 (when (null ,varimp-sym)
8326 (message
8327 "Use `C-u M-x %s RET' to select another implementation"
8328 ,command-name)
8329 (sit-for 3))
8330 (customize-save-variable ',varimp-sym
8331 (cdr (assoc-string val ,varalt-sym))))))
8332 (if ,varimp-sym
8333 (call-interactively ,varimp-sym)
8334 (message ,(format "No implementation selected for command `%s'"
8335 command-name)))))))
8337 \f
8339 (provide 'simple)
8341 ;;; simple.el ends here