| blob | 3d25ec19ab26e616af67280f2690d2ed14168047 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2016 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 "Return non-nil if BUFFER is a `next-error' capable buffer.
149 If AVOID-CURRENT is non-nil, and BUFFER is the current buffer,
150 return nil.
152 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if
153 BUFFER would not normally qualify. If it returns non-nil, BUFFER
154 is considered `next-error' capable, anyway, and the function
155 returns non-nil.
157 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the
158 buffer would normally qualify. If it returns nil, BUFFER is
159 rejected, and the function returns nil."
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.
413 ;; Do the rest in post-self-insert-hook, because we want to do it
414 ;; *before* other functions on that hook.
416 ;; We are not going to insert any newlines if arg is
417 ;; non-positive.
420 ;; Mark the newline(s) `hard'.
424 ;; If the newline leaves the previous line blank, and we
425 ;; have a left margin, delete that from the blank line.
433 ;; Indent the line after the newline, except in one case:
434 ;; when we added the newline at the beginning of a line which
435 ;; starts a page.
440 ;; FIXME: For non-interactive uses, many calls actually
441 ;; just want (insert "\n"), so maybe we should do just
442 ;; that, so as to avoid the risk of filling or running
443 ;; abbrevs unexpectedly.
450 ;; We first used let-binding to protect the hook, but that
451 ;; was naive since add-hook affects the symbol-default
452 ;; value of the variable, whereas the let-binding might
453 ;; only protect the buffer-local value.
457 nil)
462 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
468 "Insert a newline and leave point before it.
469 If there is a fill prefix and/or a `left-margin', insert them on
470 the new line if the line would have been blank.
471 With arg N, insert N newlines."
476 ;; Don't expand an abbrev before point.
487 ;; Necessary in case a margin or prefix was inserted.
491 "Split current line, moving portion beyond point vertically down.
492 If the current line starts with `fill-prefix', insert it on the new
493 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
495 When called from Lisp code, ARG may be a prefix string to copy."
500 ;; What prefix should we check for (nil means don't).
504 ;; Does this line start with it?
515 "Join this line to previous and fix up whitespace at join.
516 If there is a fill prefix, delete it from the beginning of this line.
517 With argument, join this line to following line."
524 ;; If the second line started with the fill prefix,
525 ;; delete the prefix.
537 "On blank line, delete all surrounding blank lines, leaving just one.
538 On isolated blank line, delete that one.
539 On nonblank line, delete any immediately following blank lines."
545 ;; Set singleblank if there is just one blank line here.
552 ;; Delete preceding blank lines, and this one too if it's the only one.
561 ;; Delete following blank lines, unless the current line is blank
562 ;; and there are no following blank lines.
571 ;; Handle the special case where point is followed by newline and eob.
572 ;; Delete the line, leaving point at eob.
578 Trailing lines are deleted only if `delete-trailing-whitespace'
579 is called on the entire buffer (rather than an active region)."
585 "Delete trailing whitespace between START and END.
586 If called interactively, START and END are the start/end of the
587 region if the mark is active, or of the buffer's accessible
588 portion if the mark is inactive.
590 This command deletes whitespace characters after the last
591 non-whitespace character in each line between START and END. It
592 does not consider formfeed characters to be whitespace.
594 If this command acts on the entire buffer (i.e. if called
595 interactively with the mark inactive, or called from Lisp with
596 END nil), it also deletes all trailing lines at the end of the
597 buffer if the variable `delete-trailing-lines' is non-nil."
610 ;; Don't delete formfeeds, even if they are considered whitespace.
614 ;; Delete trailing empty lines.
617 delete-trailing-lines
618 ;; Really the end of buffer.
623 ;; Return nil for the benefit of `write-file-functions'.
624 nil)
627 "Insert a newline, then indent according to major mode.
628 Indentation is done using the value of `indent-line-function'.
629 In programming language modes, this is the same as TAB.
630 In some text modes, where TAB inserts a tab, this command indents to the
631 column specified by the function `current-left-margin'."
638 "Reindent current line, insert newline, then indent the new line.
639 Indentation of both lines is done according to the current major mode,
640 which means calling the current value of `indent-line-function'.
641 In programming language modes, this is the same as TAB.
642 In some text modes, where TAB inserts a tab, this indents to the
643 column specified by the function `current-left-margin'."
646 ;; Be careful to insert the newline before indenting the line.
647 ;; Otherwise, the indentation might be wrong.
651 ;; We are at EOL before the call to indent-according-to-mode, and
652 ;; after it we usually are as well, but not always. We tried to
653 ;; address it with `save-excursion' but that uses a normal marker
654 ;; whereas we need `move after insertion', so we do the save/restore
655 ;; by hand.
659 ;; Remove the trailing white-space after indentation because
660 ;; indentation may introduce the whitespace.
666 Legitimate radix values are 8, 10 and 16."
671 "Like `read-char', but do not allow quitting.
672 Also, if the first character read is an octal digit,
673 we read any number of octal digits and return the
674 specified character code. Any nondigit terminates the sequence.
675 If the terminator is RET, it is discarded;
676 any other terminator is used itself as input.
678 The optional argument PROMPT specifies a string to use to prompt the user.
679 The variable `read-quoted-char-radix' controls which radix to use
680 for numeric input."
683 help-event-list)))
687 ;; Don't let C-h or other help chars get the help
688 ;; message--only help function keys. See bug#16617.
692 "Type the special character you want to use,
693 or the octal character code.
694 RET terminates the character code and is discarded;
704 unread-command-events)
705 done t))
707 ;; Turn a meta-character into a character with the 0200 bit set.
709 done t))
725 unread-command-events)
726 done t))
728 done t)))
730 code))
733 "Read next input character and insert it.
734 This is useful for inserting control characters.
735 With argument, insert ARG copies of the character.
737 If the first character you type after this command is an octal digit,
738 you should type a sequence of octal digits which specify a character code.
739 Any nondigit terminates the sequence. If the terminator is a RET,
740 it is discarded; any other terminator is used itself as input.
741 The variable `read-quoted-char-radix' specifies the radix for this feature;
742 set it to 10 or 16 to use decimal or hex instead of octal.
744 In overwrite mode, this function inserts the character anyway, and
745 does not handle octal digits specially. This means that if you use
746 overwrite as your normal editing mode, you can use this function to
747 insert characters when necessary.
749 In binary overwrite mode, this function does overwrite, and octal
750 digits are interpreted as a character code. This is intended to be
751 useful for editing binary files."
754 ;; Avoid "obsolete" warnings for translation-table-for-input.
761 ;; This used to assume character codes 0240 - 0377 stand for
762 ;; characters in some single-byte character set, and converted them
763 ;; to Emacs characters. But in 23.1 this feature is deprecated
764 ;; in favor of inserting the corresponding Unicode characters.
765 ;; (if (and enable-multibyte-characters
766 ;; (>= char ?\240)
767 ;; (<= char ?\377))
768 ;; (setq char (unibyte-char-to-multibyte char)))
780 "Move forward ARG lines and position at first nonblank character."
786 "Move backward ARG lines and position at first nonblank character."
792 "Move point to the first non-whitespace character on this line."
796 ;; Move back over chars that have whitespace syntax but have the p flag.
800 "Fixup white space between objects around point.
801 Leave one space or none, according to the context."
808 nil
812 "Delete all spaces and tabs around point.
813 If BACKWARD-ONLY is non-nil, only delete them before point."
818 orig-pos
827 "Delete all spaces and tabs around point, leaving one space (or N spaces).
828 If N is negative, delete newlines as well, leaving -N spaces.
829 See also `cycle-spacing'."
834 "Store context used in consecutive calls to `cycle-spacing' command.
835 The first time `cycle-spacing' runs, it saves in this variable:
836 its N argument, the original point position, and the original spacing
840 "Manipulate whitespace around point in a smart way.
841 In interactive use, this function behaves differently in successive
842 consecutive calls.
844 The first call in a sequence acts like `just-one-space'.
845 It deletes all spaces and tabs around point, leaving one space
846 \(or N spaces). N is the prefix argument. If N is negative,
847 it deletes newlines as well, leaving -N spaces.
848 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
850 The second call in a sequence deletes all spaces.
852 The third call in a sequence restores the original whitespace (and point).
854 If MODE is `single-shot', it only performs the first step in the sequence.
855 If MODE is `fast' and the first step would not result in any change
856 \(i.e., there are exactly (abs N) spaces around point),
857 the function goes straight to the second step.
859 Repeatedly calling the function with different values of N starts a
860 new sequence each time."
868 ;; Command run for the first time, single-shot mode or different argument
880 ;; Special handling for case where there was no space at all.
883 ;; If this run causes no change in buffer content, delete all spaces,
884 ;; otherwise delete all excess spaces.
889 ;; Command run for the second time.
893 ;; Command run for the third time.
898 \f
900 "Move point to the beginning of the buffer.
901 With numeric arg N, put point N/10 of the way from the beginning.
902 If the buffer is narrowed, this command uses the beginning of the
903 accessible part of the buffer.
906 is supplied, or Transient Mark mode is enabled and the mark is active."
916 ;; Avoid overflow for large buffer sizes!
924 "Move point to the end of the buffer.
925 With numeric arg N, put point N/10 of the way from the end.
926 If the buffer is narrowed, this command uses the end of the
927 accessible part of the buffer.
930 is supplied, or Transient Mark mode is enabled and the mark is active."
938 ;; Avoid overflow for large buffer sizes!
943 ;; If we went to a place in the middle of the buffer,
944 ;; adjust it to the beginning of a line.
948 ;; If the end of the buffer is not already on the screen,
949 ;; then scroll specially to put it near, but not at, the bottom.
954 "Whether single-char deletion commands delete an active region.
955 This has an effect only if Transient Mark mode is enabled, and
956 affects `delete-forward-char' and `delete-backward-char', though
957 not `delete-char'.
959 If the value is the symbol `kill', the active region is killed
960 instead of deleted."
977 "Function to get the region's content.
978 Called with one argument DELETE.
979 If DELETE is `delete-only', then only delete the region and the return value
980 is undefined. If DELETE is nil, just return the content as a string.
981 If DELETE is `bounds', then don't delete, but just return the
982 boundaries of the region as a list of (START . END) positions.
983 If anything else, delete the region and return its content as a string,
994 first nil))))
995 "Function to insert the region's content.
996 Called with one argument LINES.
1000 "Delete the previous N characters (following if N is negative).
1001 If Transient Mark mode is enabled, the mark is active, and N is 1,
1002 delete the text in the region and deactivate the mark instead.
1003 To disable this, set option `delete-active-region' to nil.
1005 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1006 kill ring) instead of delete. Interactively, N is the prefix
1007 arg, and KILLFLAG is set if N is explicitly specified.
1009 When killing, the killed text is filtered by
1010 `filter-buffer-substring' before it is saved in the kill ring, so
1011 the actual saved text might be different from what was killed.
1013 In Overwrite mode, single character backward deletion may replace
1014 tabs with spaces so as to back over columns, unless point is at
1015 the end of the line."
1021 delete-active-region
1023 ;; If a region is active, kill or delete it.
1027 ;; In Overwrite mode, maybe untabify while deleting
1037 ;; Otherwise, do simple deletion.
1041 "Delete the following N characters (previous if N is negative).
1042 If Transient Mark mode is enabled, the mark is active, and N is 1,
1043 delete the text in the region and deactivate the mark instead.
1044 To disable this, set variable `delete-active-region' to nil.
1046 Optional second arg KILLFLAG non-nil means to kill (save in kill
1047 ring) instead of delete. Interactively, N is the prefix arg, and
1048 KILLFLAG is set if N was explicitly specified.
1050 When killing, the killed text is filtered by
1051 `filter-buffer-substring' before it is saved in the kill ring, so
1052 the actual saved text might be different from what was killed."
1058 delete-active-region
1060 ;; If a region is active, kill or delete it.
1065 ;; Otherwise, do simple deletion.
1069 "Put point at beginning and mark at end of buffer.
1070 If narrowing is in effect, only uses the accessible part of the buffer.
1071 You probably should not use this function in Lisp programs;
1072 it is usually a mistake for a Lisp function to use any subroutine
1073 that uses or sets the mark."
1078 ;; This is really `point-min' in most cases, but if we're in the
1079 ;; minibuffer, this is at the end of the prompt.
1081 \f
1083 ;; Counting lines, one way or another.
1086 "Go to LINE, counting from line 1 at beginning of buffer.
1087 If called interactively, a numeric prefix argument specifies
1088 LINE; without a numeric prefix argument, read LINE from the
1089 minibuffer.
1091 If optional argument BUFFER is non-nil, switch to that buffer and
1093 as argument, BUFFER is the most recently selected other buffer.
1095 Prior to moving point, this function sets the mark (without
1096 activating it), unless Transient Mark mode is enabled and the
1097 mark is already active.
1099 This function is usually the wrong thing to use in a Lisp program.
1100 What you probably want instead is something like:
1101 (goto-char (point-min))
1102 (forward-line (1- N))
1103 If at all possible, an even better solution is to use char counts
1104 rather than line counts."
1109 ;; Look for a default, a number in the buffer at point.
1119 ;; Decide if we're switching buffers.
1127 ;; Read the argument, offering that number (if any) as default.
1130 buffer))))
1131 ;; Switch to the desired buffer, one way or another.
1136 ;; Leave mark at previous position
1138 ;; Move to the specified line number in that buffer.
1147 "Count the number of words in the region.
1148 If called interactively, print a message reporting the number of
1149 lines, words, and characters in the region (whether or not the
1150 region is active); with prefix ARG, report for the entire buffer
1151 rather than the region.
1153 If called from Lisp, return the number of words between positions
1154 START and END."
1166 "Count words between START and END.
1167 If called interactively, START and END are normally the start and
1168 end of the buffer; but if the region is active, START and END are
1169 the start and end of the region. Print a message reporting the
1170 number of lines, words, and chars.
1172 If called from Lisp, return the number of words between START and
1173 END, without printing any message."
1183 words))
1199 str
1207 "Print the current buffer line number and narrowed line number of point."
1220 "Return number of lines between START and END.
1221 This is usually the number of newlines between them,
1222 but can be one more if START is not equal to END
1223 and the greater of them is not at the start of a line."
1239 done)))
1243 "Return (narrowed) buffer line number at position POS.
1244 If POS is nil, use current buffer location.
1245 Counting starts at (point-min), so the value refers
1246 to the contents of the accessible portion of the buffer."
1256 "Print info on cursor position (on screen and within buffer).
1257 Also describe the character after point, and give its character code
1258 in octal, decimal and hex.
1260 For a non-ASCII multibyte character, also give its encoding in the
1261 buffer's selected coding system if the coding system encodes the
1262 character safely. If the character is encoded into one byte, that
1263 code is shown in hex. If the character is encoded into more than one
1266 In addition, with prefix argument, show details about that character
1267 in *Help* buffer. See also the command `describe-char'."
1271 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1272 ;; start a directional embedding, which could completely
1273 ;; disrupt the rest of the line (e.g., RLO will display the
1274 ;; rest of the line right-to-left). So we put an invisible
1275 ;; PDF character after these characters, to end the
1276 ;; embedding, which eliminates any effects on the rest of
1277 ;; the line. For RLE and RLO we also append an invisible
1278 ;; LRM, to avoid reordering the following numerical
1279 ;; characters. For LRI/RLI/FSI we append a PDI.
1286 ;; Strong right-to-left characters cause reordering of
1287 ;; the following numerical characters which show the
1288 ;; codepoint, so append LRM to countermand that.
1299 ""
1305 pos total percent beg end col hscroll)
1307 pos total col hscroll))
1309 encoded encoding-msg display-prop under-display)
1316 ;; Check if the character is displayed with some `display'
1317 ;; text property. In that case, set under-display to the
1318 ;; buffer substring covered by that property.
1329 under-display)))
1335 char char char under-display)
1337 char char char under-display display-prop))
1340 char char char
1342 "..."
1346 ;; We show the detailed information about CHAR.
1353 bidi-fixer
1354 encoding-msg pos total percent beg end col hscroll)
1361 bidi-fixer encoding-msg pos total percent col hscroll))))))
1362 \f
1363 ;; Initialize read-expression-map. It is defined at C level.
1367 ;; Might as well bind TAB to completion, since inserting a TAB char is
1368 ;; much too rarely useful.
1371 m))
1374 "Return a Lisp object read using the minibuffer, unevaluated.
1375 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1376 is a string to insert in the minibuffer before reading.
1377 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1378 Such arguments are used as in `read-from-minibuffer'.)"
1379 ;; Used for interactive spec `x'.
1384 "Return value of Lisp expression read using the minibuffer.
1385 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1386 is a string to insert in the minibuffer before reading.
1387 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1388 Such arguments are used as in `read-from-minibuffer'.)"
1389 ;; Used for interactive spec `X'.
1397 "The current default value or list of default values in the minibuffer.
1398 The functions `read-from-minibuffer' and `completing-read' bind
1402 "Value for `print-level' while printing value in `eval-expression'.
1403 A value of nil means no limit."
1409 "Value for `print-length' while printing value in `eval-expression'.
1410 A value of nil means no limit."
1416 "If non-nil set `debug-on-error' to t in `eval-expression'.
1417 If nil, don't change the value of `debug-on-error'."
1423 "If VALUE in an integer, return a specially formatted string.
1425 If VALUE is not an integer, nil is returned.
1426 This function is used by functions like `prin1' that display the
1427 result of expression evaluation."
1446 ;; FIXME: call emacs-lisp-mode?
1453 read-expression-map t
1456 ;; We define this, rather than making `eval' interactive,
1457 ;; for the sake of completion of names like eval-region, eval-buffer.
1459 "Evaluate EXP and print value in the echo area.
1460 When called interactively, read an Emacs Lisp expression and evaluate it.
1461 Value is also consed on to front of the variable `values'.
1462 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1463 argument) means insert the result into the current buffer instead of
1464 printing it in the echo area.
1466 Normally, this function truncates long output according to the value
1467 of the variables `eval-expression-print-length' and
1468 `eval-expression-print-level'. With a prefix argument of zero,
1469 however, there is no such truncation. Such a prefix argument
1470 also causes integers to be printed in several additional formats
1471 \(octal, hexadecimal, and character).
1473 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1474 minibuffer.
1476 If `eval-expression-debug-on-error' is non-nil, which is the default,
1477 this command arranges for all errors to enter the debugger."
1480 current-prefix-arg))
1485 ;; Bind debug-on-error to something unique so that we can
1486 ;; detect when evalled code changes it.
1490 ;; If evalled code has changed the value of debug-on-error,
1491 ;; propagate that change to the global binding.
1496 eval-expression-print-length))
1498 eval-expression-print-level))
1514 "Prompting with PROMPT, let user edit COMMAND and eval result.
1515 COMMAND is a Lisp expression. Let user edit that expression in
1516 the minibuffer, then read and evaluate the result."
1523 read-expression-map t
1525 ;; If command was added to command-history as a string,
1526 ;; get rid of that. We want only evaluable expressions there.
1530 ;; If command to be redone does not match front of history,
1531 ;; add it to the history.
1537 "Edit and re-evaluate last complex command, or ARGth from last.
1538 A complex command is one which used the minibuffer.
1539 The command is placed in the minibuffer as a Lisp form for editing.
1540 The result is executed, repeating the command as changed.
1541 If the command has been changed or is not the most recent previous
1542 command it is added to the front of the command history.
1543 You can use the minibuffer history commands \
1545 to get different commands to edit and resubmit."
1548 newcmd)
1560 ;; If command was added to command-history as a
1561 ;; string, get rid of that. We want only
1562 ;; evaluable expressions there.
1566 ;; If command to be redone does not match front of history,
1567 ;; add it to the history.
1582 "Read command name to invoke in `execute-extended-command'."
1592 ;; Get a command name at point in the original buffer
1593 ;; to propose it after M-n.
1597 ;; Read a string, completing from and restricting to the set of
1598 ;; all defined commands. Don't provide any initial input.
1599 ;; Save the command read on the extended-command history list.
1610 ;; This isn't strictly correct if `execute-extended-command'
1611 ;; is bound to anything else (e.g. [menu]).
1612 ;; It could use (key-description (this-single-command-keys)),
1613 ;; but actually a prompt other than "M-x" would be confusing,
1614 ;; because "M-x" is a well-known prompt to read a command
1615 ;; and it serves as a shorthand for "Extended command: ".
1620 ;; Exclude obsolete commands from completions.
1625 pred)))
1630 "Non-nil means show the equivalent key-binding when M-x command has one.
1631 The value can be a length of time to show the message for.
1632 If the value is non-nil and not a number, we wait 2 seconds."
1639 "If non-nil, show a shorter M-x invocation when there is one."
1660 binding)
1666 name len)))
1667 ;; Don't show the help message if the binding isn't
1668 ;; significantly shorter than the M-x command the user typed.
1675 binding))
1678 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1679 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1680 "Read a command name, then read the arguments and call the command.
1681 To pass a prefix argument to the command you are
1682 invoking, give a prefix argument to `execute-extended-command'."
1684 ;; FIXME: Remember the actual text typed by the user before completion,
1685 ;; so that we don't later on suggest the same shortening.
1690 execute-extended-command--last-typed)))
1691 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1704 ;; Normally `real-this-command' should never be changed, but here we really
1705 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1706 ;; binding" for <cmd>, so the command the user really wanted to run is
1707 ;; `function' and not `execute-extended-command'. The difference is
1708 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1712 ;; If enabled, show which key runs this command.
1713 ;; But first wait, and skip the message if there is input.
1715 ;; If this command displayed something in the echo area;
1716 ;; wait a few seconds, then display our suggestion message.
1717 ;; FIXME: Wait *after* running post-command-hook!
1718 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1719 ;; find a better answer anyway!
1729 ;; There's no binding for CMD. Let's try and find the shortest
1730 ;; string to use in M-x.
1731 ;; FIXME: Can be slow. Cache it maybe?
1738 function
1743 suggest-key-bindings
1747 ;; BEWARE: Called directly from the C code.
1748 "Execute CMD as an editor command.
1749 CMD must be a symbol that satisfies the `commandp' predicate.
1750 Optional second arg RECORD-FLAG non-nil
1751 means unconditionally put this command in the variable `command-history'.
1752 Otherwise, that is done only if an arg is read using the minibuffer.
1753 The argument KEYS specifies the value to use instead of (this-command-keys)
1754 when reading the arguments; if it is nil, (this-command-keys) is used.
1755 The argument SPECIAL, if non-nil, means that this command is executing
1756 a special event, so ignore the prefix argument and don't clear it."
1759 ;; FIXME: This should probably be done around
1760 ;; pre-command-hook rather than here!
1768 disabled-command-function)
1769 ;; FIXME: Weird calling convention!
1779 ;; If requested, place the macro in the command history. For
1780 ;; other sorts of commands, call-interactively takes care of this.
1783 ;; Don't keep command history around forever.
1789 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1797 \f
1799 "Default minibuffer history list.
1800 This is used for all minibuffer input
1801 except when an alternate history list is specified.
1803 Maximum length of the history list is determined by the value
1806 "Control whether history list elements are expressions or strings.
1807 If the value of this variable equals current minibuffer depth,
1808 they are expressions; otherwise they are strings.
1809 \(That convention is designed to do the right thing for
1816 "Text that was in this minibuffer before any history commands.
1817 This is nil if there have not yet been any history commands
1826 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1831 "Minibuffer history variables for which matching should ignore case.
1832 If a history variable is a member of this list, then the
1834 commands ignore case when searching it, regardless of `case-fold-search'."
1839 "Find the previous history element that matches REGEXP.
1840 \(Previous history elements refer to earlier actions.)
1841 With prefix argument N, search for Nth previous match.
1842 If N is negative, find the next or Nth next match.
1843 Normally, history elements are matched case-insensitively if
1844 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1845 makes the search case-sensitive.
1846 See also `minibuffer-history-case-insensitive-variables'."
1850 nil
1851 minibuffer-local-map
1852 nil
1853 'minibuffer-history-search-history
1855 ;; Use the last regexp specified, by default, if input is empty.
1860 regexp)
1870 ;; On some systems, ignore case for file names.
1872 minibuffer-history-case-insensitive-variables)
1873 t
1874 ;; Respect the user's setting for case-fold-search:
1875 case-fold-search)
1876 nil))
1877 prevpos
1878 match-string
1879 match-offset
1886 "No later matching history item"
1907 next-matching-history-element))
1911 "Find the next history element that matches REGEXP.
1912 \(The next history element refers to a more recent action.)
1913 With prefix argument N, search for Nth next match.
1914 If N is negative, find the previous or Nth previous match.
1915 Normally, history elements are matched case-insensitively if
1916 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1917 makes the search case-sensitive."
1921 nil
1922 minibuffer-local-map
1923 nil
1924 'minibuffer-history-search-history
1926 ;; Use the last regexp specified, by default, if input is empty.
1931 regexp)
1938 "Function run by `goto-history-element' before consuming default values.
1939 This is useful to dynamically add more elements to the list of default values
1940 when `goto-history-element' reaches the end of this list.
1941 Before calling this function `goto-history-element' sets the variable
1942 `minibuffer-default-add-done' to t, so it will call this function only
1943 once. In special cases, when this function needs to be called more
1944 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1948 "When nil, add more elements to the end of the list of default values.
1949 The value nil causes `goto-history-element' to add more elements to
1950 the list of defaults when it reaches the end of this list. It does
1956 "Return a list of all completions without the default value.
1957 This function is used to add all elements of the completion table to
1958 the end of the list of defaults just after the default value."
1961 minibuffer-completion-table
1962 minibuffer-completion-predicate)))
1968 "Puts element of the minibuffer history in the minibuffer.
1969 The argument NABS specifies the absolute history position."
1983 elt minibuffer-returned-to-present)
1990 "End of defaults; no next item"
1997 previous-history-element))
2009 minibuffer-default)))
2021 elt))
2025 "Puts next element of the minibuffer history in the minibuffer.
2026 With argument N, it uses the Nth following element."
2032 "Puts previous element of the minibuffer history in the minibuffer.
2033 With argument N, it uses the Nth previous element."
2039 "Move cursor vertically down ARG lines, or to the next history element.
2040 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2041 next element of the minibuffer history in the minibuffer."
2045 ;; Remember the original goal column of possibly multi-line input
2046 ;; excluding the length of the prompt on the first line.
2056 ;; Restore old position since `line-move-visual' moves point to
2057 ;; the end of the line when it fails to go to the next line.
2060 ;; Reset `temporary-goal-column' because a correct value is not
2061 ;; calculated when `next-line' above fails by bumping against
2062 ;; the bottom of the minibuffer (bug#22544).
2064 ;; Restore the original goal column on the last line
2065 ;; of possibly multi-line input.
2073 "Move cursor vertically up ARG lines, or to the previous history element.
2074 When point moves over the top line of multi-line minibuffer, puts ARGth
2075 previous element of the minibuffer history in the minibuffer."
2079 ;; Remember the original goal column of possibly multi-line input
2080 ;; excluding the length of the prompt on the first line.
2090 ;; Restore old position since `line-move-visual' moves point to
2091 ;; the beginning of the line when it fails to go to the previous line.
2094 ;; Reset `temporary-goal-column' because a correct value is not
2095 ;; calculated when `previous-line' above fails by bumping against
2096 ;; the top of the minibuffer (bug#22544).
2098 ;; Restore the original goal column on the first line
2099 ;; of possibly multi-line input.
2105 ;; Put the cursor at the end of the visual line instead of the
2106 ;; logical line, so the next `previous-line-or-history-element'
2107 ;; would move to the previous history element, not to a possible upper
2108 ;; visual line from the end of logical line in `line-move-visual' mode.
2110 ;; Since `end-of-visual-line' puts the cursor at the beginning
2111 ;; of the next visual line, move it one char back to the end
2112 ;; of the first visual line (bug#22544).
2116 "Get next history element which completes the minibuffer before the point.
2117 The contents of the minibuffer after the point are deleted, and replaced
2118 by the new completion."
2124 n)
2125 ;; next-matching-history-element always puts us at (point-min).
2126 ;; Move to the position we were at before changing the buffer contents.
2127 ;; This is still sensible, because the text before point has not changed.
2131 "\
2132 Get previous history element which completes the minibuffer before the point.
2133 The contents of the minibuffer after the point are deleted, and replaced
2134 by the new completion."
2138 ;; For compatibility with the old subr of the same name.
2140 "Return the display width of the minibuffer prompt.
2141 Return 0 if current buffer is not a minibuffer."
2142 ;; Return the width of everything before the field at the end of
2143 ;; the buffer; this should be 0 for normal buffers.
2145 \f
2146 ;; isearch minibuffer history
2153 "Set up a minibuffer for using isearch to search the minibuffer history.
2154 Intended to be added to `minibuffer-setup-hook'."
2166 "Clean up the minibuffer after terminating isearch in the minibuffer."
2171 "Return the proper search function, for isearch in minibuffer history."
2174 ;; Use standard functions to search within minibuffer text
2176 found)
2177 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2178 ;; searching forward. Lazy-highlight calls this lambda with the
2179 ;; bound arg, so skip the minibuffer prompt.
2183 ;; 1. First try searching in the initial minibuffer text
2186 noerror)
2187 ;; 2. If the above search fails, start putting next/prev history
2188 ;; elements in the minibuffer successively, and search the string
2189 ;; in them. Do this only when bound is nil (i.e. not while
2190 ;; lazy-highlighting search strings in the current minibuffer text).
2202 ;; After putting the next/prev history element, search
2203 ;; the string in them again, until next-history-element
2204 ;; or previous-history-element raises an error at the
2205 ;; beginning/end of history.
2208 ;; For backward search, don't search
2209 ;; in the minibuffer prompt
2211 noerror)))
2212 ;; Return point of the new search result
2214 ;; Return nil when next(prev)-history-element fails
2218 "Display the minibuffer history search prompt.
2219 If there are no search errors, this function displays an overlay with
2220 the isearch prompt which replaces the original minibuffer prompt.
2221 Otherwise, it displays the standard isearch message returned from
2222 the function `isearch-message'."
2224 ;; Use standard function `isearch-message' when not in the minibuffer,
2225 ;; or search fails, or has an error (like incomplete regexp).
2226 ;; This function overwrites minibuffer text with isearch message,
2227 ;; so it's possible to see what is wrong in the search string.
2229 ;; Otherwise, put the overlay with the standard isearch prompt over
2230 ;; the initial minibuffer prompt.
2239 ;; And clear any previous isearch message.
2243 "Wrap the minibuffer history search when search fails.
2244 Move point to the first history element for a forward search,
2245 or to the last history element for a backward search."
2246 ;; When `minibuffer-history-isearch-search' fails on reaching the
2247 ;; beginning/end of the history, wrap the search to the first/last
2248 ;; minibuffer history element.
2256 "Save a function restoring the state of minibuffer history search.
2257 Save `minibuffer-history-position' to the additional state parameter
2258 in the search status stack."
2264 "Restore the minibuffer history search state.
2265 Go to the history element by the absolute history position HIST-POS."
2268 \f
2269 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2273 "Table mapping redo records to the corresponding undo one.
2274 A redo record for undo-in-region maps to t.
2284 "Within a run of consecutive undo commands, list remaining to be undone.
2288 "Undo some previous changes.
2289 Repeat this command to undo more changes.
2290 A numeric ARG serves as a repeat count.
2292 In Transient Mark mode when the mark is active, only undo changes within
2294 as an argument limits undo to changes within the current region."
2296 ;; Make last-command indicate for the next command that this was an undo.
2297 ;; That way, another undo will undo more.
2298 ;; If we get to the end of the undo history and get an error,
2299 ;; another undo command will find the undo history empty
2300 ;; and will get another error. To begin undoing the undos,
2301 ;; you must type some other command.
2303 ;; For an indirect buffer, look in the base buffer for the
2304 ;; auto-save data.
2308 message)
2309 ;; If we get an error in undo-start,
2310 ;; the next command should not be a "consecutive undo".
2311 ;; So set `this-command' to something other than `undo'.
2316 ;; If something (a timer or filter?) changed the buffer
2317 ;; since the previous command, don't continue the undo seq.
2321 ;; If the last undo record made was made by undo
2322 ;; it shows nothing else happened in between.
2329 ;; get rid of initial undo boundary
2331 ;; If we got this far, the next command should be a consecutive undo.
2333 ;; Check to see whether we're hitting a redo record, and if
2334 ;; so, ask the user whether she wants to skip the redo/undo pair.
2342 ;; The equiv entry might point to another redo record if we have done
2343 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2351 ;; Record the fact that the just-generated undo records come from an
2352 ;; undo operation--that is, they are redo records.
2353 ;; In the ordinary case (not within a region), map the redo
2354 ;; record to the following undos.
2355 ;; I don't know how to do that in the undo-in-region case.
2357 ;; Strip any leading undo boundaries there might be, like we do
2358 ;; above when checking.
2362 ;; Prevent identity mapping. This can happen if
2363 ;; consecutive nils are erroneously in undo list.
2365 t
2366 pending-undo-list)
2367 undo-equiv-table))
2368 ;; Don't specify a position in the undo record for the undo command.
2369 ;; Instead, undoing this should move point to where the change is.
2388 ;; Record what the current undo list says,
2389 ;; so the next command can tell if the buffer was modified in between.
2393 ;; Display a message announcing success.
2398 "Make BUFFER stop keeping undo information.
2399 No argument or nil as argument means do this for the current buffer."
2405 "Undo some previous changes.
2406 Repeat this command to undo more changes.
2407 A numeric ARG serves as a repeat count.
2408 Contrary to `undo', this will not redo a previous undo."
2413 "Non-nil while performing an undo.
2417 "Undo back N undo-boundaries beyond what was already undone recently.
2418 Call `undo-start' to get ready to undo recent changes,
2419 then call `undo-more' one or more times to undo them."
2424 ;; Note: The following, while pulling elements off
2425 ;; `pending-undo-list' will call primitive change functions which
2426 ;; will push more elements onto `buffer-undo-list'.
2432 "Undo N records from the front of the list LIST.
2433 Return what remains of the list."
2435 ;; This is a good feature, but would make undo-start
2436 ;; unable to do what is expected.
2437 ;;(when (null (car (list)))
2438 ;; ;; If the head of the list is a boundary, it is the boundary
2439 ;; ;; preceding this command. Get rid of it and don't count it.
2440 ;; (setq list (cdr list))))
2443 ;; In a writable buffer, enable undoing read-only text that is
2444 ;; so because of text properties.
2446 ;; Don't let `intangible' properties interfere with undo.
2448 ;; We use oldlist only to check for EQ. ++kfs
2454 ;; Handle an integer by setting point to that value.
2457 ;; Element (t . TIME) records previous modtime.
2458 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2459 ;; UNKNOWN_MODTIME_NSECS.
2461 ;; If this records an obsolete save
2462 ;; (not matching the actual disk file)
2463 ;; then don't mark unmodified.
2471 ;; Element (nil PROP VAL BEG . END) is property change.
2476 ;; Element (BEG . END) means range was inserted.
2478 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2479 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2482 ;; Set point first thing, so that undoing this undo
2483 ;; does not send point back to where it is now.
2486 ;; Element (apply FUN . ARGS) means call FUN to undo.
2490 ;; Long format: (apply DELTA START END FUN . ARGS).
2497 ;; Check that the function did what the entry
2498 ;; said it would do.
2508 ;; Element (STRING . POS) means STRING was deleted.
2514 ;; Check that marker adjustments which were recorded
2515 ;; with the (STRING . POS) record are still valid, ie
2516 ;; the markers haven't moved. We check their validity
2517 ;; before reinserting the string so as we don't need to
2518 ;; mind marker insertion-type.
2526 ;; Insert string and adjust point
2534 ;; Adjust the valid marker adjustments
2538 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2541 next)
2542 ;; Even though these elements are not expected in the undo
2543 ;; list, adjust them to be conservative for the 24.4
2544 ;; release. (Bug#16818)
2551 ;; Make sure an apply entry produces at least one undo entry,
2552 ;; so the test in `undo' for continuing an undo series
2553 ;; will work right.
2558 list)
2560 ;; Deep copy of a list
2562 "Make a copy of undo list LIST."
2568 elt))
2571 "Set `pending-undo-list' to the front of the undo list.
2572 The next call to `undo-more' will undo the most recently made change.
2573 If BEG and END are specified, then only undo elements
2574 that apply to text between BEG and END are used; other undo elements
2575 are ignored. If BEG and END are nil, all undo elements are used."
2581 buffer-undo-list)))
2583 ;; The positions given in elements of the undo list are the positions
2584 ;; as of the time that element was recorded to undo history. In
2585 ;; general, subsequent buffer edits render those positions invalid in
2586 ;; the current buffer, unless adjusted according to the intervening
2587 ;; undo elements.
2588 ;;
2589 ;; Undo in region is a use case that requires adjustments to undo
2590 ;; elements. It must adjust positions of elements in the region based
2591 ;; on newer elements not in the region so as they may be correctly
2592 ;; applied in the current buffer. undo-make-selective-list
2593 ;; accomplishes this with its undo-deltas list of adjustments. An
2594 ;; example undo history from oldest to newest:
2595 ;;
2596 ;; buf pos:
2597 ;; 123456789 buffer-undo-list undo-deltas
2598 ;; --------- ---------------- -----------
2599 ;; aaa (1 . 4) (1 . -3)
2600 ;; aaba (3 . 4) N/A (in region)
2601 ;; ccaaba (1 . 3) (1 . -2)
2602 ;; ccaabaddd (7 . 10) (7 . -3)
2603 ;; ccaabdd ("ad" . 6) (6 . 2)
2604 ;; ccaabaddd (6 . 8) (6 . -2)
2605 ;; | |<-- region: "caab", from 2 to 6
2606 ;;
2607 ;; When the user starts a run of undos in region,
2608 ;; undo-make-selective-list is called to create the full list of in
2609 ;; region elements. Each element is adjusted forward chronologically
2610 ;; through undo-deltas to determine if it is in the region.
2611 ;;
2612 ;; In the above example, the insertion of "b" is (3 . 4) in the
2613 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2614 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2615 ;; . 6) is assessed as in the region and placed in the selective list.
2616 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2617 ;; due to the selected element. The "b" insertion is the only element
2618 ;; fully in the region, so in this example undo-make-selective-list
2619 ;; returns (nil (5 . 6)).
2620 ;;
2621 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2622 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2623 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2624 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2625 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2626 ;;
2627 ;; More interesting is how to adjust the "ddd" insertion due to the
2628 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2629 ;; If the reinsertion was a manual retyping of "ad", then the total
2630 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2631 ;; the reinsertion was due to undo, one might expect the first "d"
2632 ;; character would again be a part of the "ddd" text, meaning its
2633 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2634 ;;
2635 ;; undo-make-selective-list assumes in this situation that "ad" was a
2636 ;; new edit, even if it was inserted because of an undo.
2637 ;; Consequently, if the user undos in region "8 to 10" of the
2638 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2639 ;; "ccaabad", as though the first "d" became detached from the
2640 ;; original "ddd" insertion. This quirk is a FIXME.
2643 "Return a list of undo elements for the region START to END.
2644 The elements come from `buffer-undo-list', but we keep only the
2645 elements inside this region, and discard those outside this
2646 region. The elements' positions are adjusted so as the returned
2647 list can be applied to the current buffer."
2649 ;; A list of position adjusted undo elements in the region.
2651 ;; A list of undo-deltas for out of region undo elements.
2652 undo-deltas
2653 undo-elt)
2661 ;; Don't put two nils together in the list
2665 ;; This is a "was unmodified" element. Keep it
2666 ;; if we have kept everything thus far.
2669 ;; Skip over marker adjustments, instead relying
2670 ;; on finding them after (TEXT . POS) elements
2672 nil)
2675 undo-deltas)))
2680 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2681 ;; kept. primitive-undo may discard them later.
2694 "Determine whether UNDO-ELT falls inside the region START ... END.
2695 If it crosses the edge, we return nil.
2697 Generally this function is not useful for determining
2698 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2699 because markers can be arbitrarily relocated. Instead, pass the
2700 marker adjustment's corresponding (TEXT . POS) element."
2705 t)
2707 nil)
2709 ;; (TEXT . POSITION)
2713 ;; (MARKER . ADJUSTMENT)
2716 ;; (nil PROPERTY VALUE BEG . END)
2721 ;; (BEGIN . END)
2726 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2727 This assumes we have already decided that UNDO-ELT
2728 is not *inside* the region START...END."
2732 ;; (nil PROPERTY VALUE BEG . END)
2737 ;; (BEGIN . END)
2742 "Return adjustment of undo element ELT by the undo DELTAS
2743 list."
2745 ;; POSITION
2748 ;; (BEG . END)
2751 ;; (TEXT . POSITION)
2755 ;; (nil PROPERTY VALUE BEG . END)
2758 ;; (apply DELTA START END FUN . ARGS)
2759 ;; FIXME
2760 ;; All others return same elt
2763 ;; (BEG . END) can adjust to the same positions, commonly when an
2764 ;; insertion was undone and they are out of region, for example:
2765 ;;
2766 ;; buf pos:
2767 ;; 123456789 buffer-undo-list undo-deltas
2768 ;; --------- ---------------- -----------
2769 ;; [...]
2770 ;; abbaa (2 . 4) (2 . -2)
2771 ;; aaa ("bb" . 2) (2 . 2)
2772 ;; [...]
2773 ;;
2774 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2775 ;; undo. Further adjustments to such an element should be the same as
2776 ;; for (TEXT . POSITION) elements. The options are:
2777 ;;
2778 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2779 ;; analogous to marker insertion-type t.
2780 ;;
2781 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2782 ;; marker insertion-type nil.
2783 ;;
2784 ;; There was no strong reason to prefer one or the other, except that
2785 ;; the first is more consistent with prior undo in region behavior.
2787 "Return cons of adjustments to BEG and END by the undo DELTAS
2788 list."
2790 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2795 "Return adjustment of POS by the undo DELTAS list, comparing
2796 with < or <= based on USE-<."
2802 ;; Don't allow pos to become less than the undo-delta
2803 ;; position. This edge case is described in the overview
2804 ;; comments.
2807 ;; Return the first affected buffer position and the delta for an undo element
2808 ;; delta is defined as the change in subsequent buffer positions if we *did*
2809 ;; the undo.
2813 ;; (TEXT . POSITION)
2816 ;; (BEGIN . END)
2822 ;;; Default undo-boundary addition
2823 ;;
2824 ;; This section adds a new undo-boundary at either after a command is
2825 ;; called or in some cases on a timer called after a change is made in
2826 ;; any buffer.
2828 "Describe the cause of the last undo-boundary.
2830 If `explicit', the last boundary was caused by an explicit call to
2831 `undo-boundary', that is one not called by the code in this
2832 section.
2834 If it is equal to `timer', then the last boundary was inserted
2835 by `undo-auto--boundary-timer'.
2837 If it is equal to `command', then the last boundary was inserted
2838 automatically after a command, that is by the code defined in
2839 this section.
2841 If it is equal to a list, then the last boundary was inserted by
2842 an amalgamating command. The car of the list is the number of
2843 times an amalgamating command has been called, and the cdr are the
2847 "Current timer which will run `undo-auto--boundary-timer' or nil.
2852 "Disable the automatic addition of boundaries.
2854 If set to non-nil, `undo-boundary' will not be called
2855 automatically in a buffer either at the end of a command, or as a
2856 result of `undo-auto-current-boundary-timer'.
2858 When this is set to non-nil, it is important to ensure that
2859 `undo-boundary' is called frequently enough. Failure to do so
2860 will result in user-visible warnings that the situation is
2864 "Non-nil if `this-command' should be amalgamated.
2865 This variable is set to nil by `undo-auto--boundaries' and is set
2869 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2873 "Return the number of amalgamating last commands or nil.
2874 Amalgamating commands are, by default, either
2875 `self-insert-command' and `delete-char', but can be any command
2876 that calls `undo-auto-amalgamate'."
2880 "Add an `undo-boundary' to the current buffer if needed.
2881 REASON describes the reason that the boundary is being added; see
2882 `undo-auto--last-boundary' for more information."
2892 undo-auto--undoably-changed-buffers)
2893 cause)))))
2896 "Check recently changed buffers and add a boundary if necessary.
2897 REASON describes the reason that the boundary is being added; see
2898 `undo-last-boundary' for more information."
2907 "Timer which will run `undo--auto-boundary-timer'."
2912 "Ensure that the `undo-auto-boundary-timer' is set."
2918 "List of buffers that have changed recently.
2920 This list is maintained by `undo-auto--undoable-change' and
2921 `undo-auto--boundaries' and can be affected by changes to their
2922 default values.
2927 "Add an `undo-boundary' in appropriate buffers."
2932 'amalgamate
2936 "Amalgamate undo if necessary.
2937 This function can be called before an amalgamating command. It
2938 removes the previous `undo-boundary' if a series of such calls
2939 have been made. By default `self-insert-command' and
2940 `delete-char' are the only amalgamating commands, although this
2941 function could be called by any command wishing to have this
2942 behavior."
2947 last-amalgamating-count
2952 ;; Amalgamate all buffers that have changed.
2956 b
2958 ;; The head of `buffer-undo-list' is nil.
2959 ;; `car-safe' doesn't work because
2960 ;; `buffer-undo-list' need not be a list!
2968 "Called after every undoable buffer change."
2971 ;; End auto-boundary section
2974 "If non-nil ask about discarding undo info for the current command.
2975 Normally, Emacs discards the undo info for the current command if
2976 it exceeds `undo-outer-limit'. But if you set this option
2977 non-nil, it asks in the echo area whether to discard the info.
2978 If you answer no, there is a slight risk that Emacs might crash, so
2979 only do it if you really want to undo the command.
2981 This option is mainly intended for debugging. You have to be
2982 careful if you use it for other purposes. Garbage collection is
2983 inhibited while the question is asked, meaning that Emacs might
2984 leak memory. So you should make sure that you do not wait
2985 excessively long before answering the question."
2991 "If non-nil, an extra level of size that's ok in an undo item.
2992 We don't ask the user about truncating the undo list until the
2993 current item gets bigger than this amount.
2998 ;; When the first undo batch in an undo list is longer than
2999 ;; undo-outer-limit, this function gets called to warn the user that
3000 ;; the undo info for the current command was discarded. Garbage
3001 ;; collection is inhibited around the call, so it had better not do a
3002 ;; lot of consing.
3008 ;; Don't ask the question again unless it gets even bigger.
3009 ;; This applies, in particular, if the user quits from the question.
3010 ;; Such a quit quits out of GC, but something else will call GC
3011 ;; again momentarily. It will call this function again,
3012 ;; but we don't want to ask the question again.
3016 "Buffer `%s' undo info is %d bytes long; discard it? "
3020 t)
3021 nil))
3027 "The undo info was discarded because it exceeded \
3028 `undo-outer-limit'.
3030 This is normal if you executed a command that made a huge change
3031 to the buffer. In that case, to prevent similar problems in the
3032 future, set `undo-outer-limit' to a value that is large enough to
3033 cover the maximum size of normal changes you expect a single
3034 command to make, but not so large that it might exceed the
3035 maximum memory allotted to Emacs.
3037 If you did not execute any such command, the situation is
3038 probably due to a bug and you should report it.
3040 You can disable the popping up of this buffer by adding the entry
3041 \(undo discard-info) to the user option `warning-suppress-types',
3045 t))
3046 \f
3049 ; These are sorted according to the GNU en_US locale.
3092 )
3094 This is used by Shell mode and other parts of Emacs to recognize
3095 password prompts, including prompts in languages other than
3096 English. Different case choices should not be assumed to be
3097 included; callers should bind `case-fold-search' to t."
3103 "History list for some commands that read shell commands.
3105 Maximum length of the history list is determined by the value
3112 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3113 This buffer is used when `shell-command' or `shell-command-on-region'
3114 is run interactively. A value of nil means that output to stderr and
3121 "Return a list of all commands associated with the current file.
3122 This function is used to add all related commands retrieved by `mailcap'
3123 to the end of the list of defaults just after the default value."
3127 minibuffer-default))
3132 commands))
3143 map)
3147 "Read a shell command from the minibuffer.
3148 The arguments are the same as the ones of `read-from-minibuffer',
3149 except READ and KEYMAP are missing and HIST defaults
3150 to `shell-command-history'."
3158 minibuffer-local-shell-command-map
3159 nil
3161 args)))
3164 "What to do when the output buffer is used by another shell command.
3165 This option specifies how to resolve the conflict where a new command
3166 wants to direct its output to the buffer `*Async Shell Command*',
3167 but this buffer is already taken by another running shell command.
3169 The value `confirm-kill-process' is used to ask for confirmation before
3170 killing the already running process and running a new process
3171 in the same buffer, `confirm-new-buffer' for confirmation before running
3172 the command in a new buffer with a name other than the default buffer name,
3173 `new-buffer' for doing the same without confirmation,
3174 `confirm-rename-buffer' for confirmation before renaming the existing
3175 output buffer and running a new command in the default buffer,
3176 `rename-buffer' for doing the same without confirmation."
3178 confirm-kill-process)
3180 confirm-new-buffer)
3182 new-buffer)
3184 confirm-rename-buffer)
3186 rename-buffer))
3191 "Execute string COMMAND asynchronously in background.
3193 Like `shell-command', but adds `&' at the end of COMMAND
3194 to execute it asynchronously.
3196 The output appears in the buffer `*Async Shell Command*'.
3197 That buffer is in shell mode.
3199 You can configure `async-shell-command-buffer' to specify what to do in
3200 case when `*Async Shell Command*' buffer is already taken by another
3201 running shell command. To run COMMAND without displaying the output
3202 in a window you can configure `display-buffer-alist' to use the action
3203 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3205 In Elisp, you will often be better served by calling `start-process'
3206 directly, since it offers more control and does not impose the use of a
3207 shell (with its need to quote arguments)."
3217 current-prefix-arg
3218 shell-command-default-error-buffer))
3224 "Execute string COMMAND in inferior shell; display output, if any.
3225 With prefix argument, insert the COMMAND's output at point.
3227 Interactively, prompt for COMMAND in the minibuffer.
3229 If COMMAND ends in `&', execute it asynchronously.
3230 The output appears in the buffer `*Async Shell Command*'.
3231 That buffer is in shell mode. You can also use
3232 `async-shell-command' that automatically adds `&'.
3234 Otherwise, COMMAND is executed synchronously. The output appears in
3235 the buffer `*Shell Command Output*'. If the output is short enough to
3236 display in the echo area (which is determined by the variables
3237 `resize-mini-windows' and `max-mini-window-height'), it is shown
3238 there, but it is nonetheless available in buffer `*Shell Command
3239 Output*' even though that buffer is not automatically displayed.
3241 To specify a coding system for converting non-ASCII characters
3243 before this command.
3245 Noninteractive callers can specify coding systems by binding
3246 `coding-system-for-read' and `coding-system-for-write'.
3248 The optional second argument OUTPUT-BUFFER, if non-nil,
3249 says to put the output in some other buffer.
3250 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
3251 If OUTPUT-BUFFER is not a buffer and not nil,
3252 insert output in current buffer. (This cannot be done asynchronously.)
3253 In either case, the buffer is first erased, and the output is
3254 inserted after point (leaving mark after it).
3256 If the command terminates without error, but generates output,
3258 the output can be displayed in the echo area or in its buffer.
3259 If the output is short enough to display in the echo area
3260 \(determined by the variable `max-mini-window-height' if
3261 `resize-mini-windows' is non-nil), it is shown there.
3262 Otherwise,the buffer containing the output is displayed.
3266 of the output.
3268 If there is no output, or if output is inserted in the current buffer,
3269 then `*Shell Command Output*' is deleted.
3271 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3272 or buffer name to which to direct the command's standard error output.
3273 If it is nil, error output is mingled with regular output.
3274 In an interactive call, the variable `shell-command-default-error-buffer'
3275 specifies the value of ERROR-BUFFER.
3277 In Elisp, you will often be better served by calling `call-process' or
3278 `start-process' directly, since it offers more control and does not impose
3279 the use of a shell (with its need to quote arguments)."
3290 current-prefix-arg
3291 shell-command-default-error-buffer))
3292 ;; Look for a handler in case default-directory is a remote file name.
3300 ;; Output goes in current buffer.
3306 temporary-file-directory)))
3307 nil)))
3310 ;; We do not use -f for csh; we will not support broken use of
3311 ;; .cshrcs. Even the BSD csh manual says to use
3312 ;; "if ($?prompt) exit" before things which are not useful
3313 ;; non-interactively. Besides, if someone wants their other
3314 ;; aliases for shell commands then they can still have them.
3318 t)
3319 nil shell-command-switch command)
3326 ;; Do no formatting while reading error file,
3327 ;; because that can run a shell command, and we
3328 ;; don't want that to cause an infinite recursion.
3330 ;; Put point after the inserted errors.
3334 ;; This is like exchange-point-and-mark, but doesn't
3335 ;; activate the mark. It is cleaner to avoid activation,
3336 ;; even though the command loop would deactivate the mark
3337 ;; because we inserted text.
3341 ;; Output goes in a separate buffer.
3342 ;; Preserve the match data in case called from a program.
3345 ;; Command ending with ampersand means asynchronous.
3349 proc)
3350 ;; Remove the ampersand.
3352 ;; Ask the user what to do with already running process.
3357 ;; If will kill a process, query first.
3362 ;; If will create a new buffer, query first.
3369 ;; It will create a new buffer.
3374 ;; If will rename the buffer, query first.
3383 ;; It will rename the buffer.
3390 ;; Setting buffer-read-only to nil doesn't suffice
3391 ;; if some text has a non-nil read-only property,
3392 ;; which comint sometimes adds for prompts.
3398 shell-command-switch command))
3402 ;; Use the comint filter for proper handling of carriage motion
3403 ;; (see `comint-inhibit-carriage-motion'),.
3405 ))
3406 ;; Otherwise, command is executed synchronously.
3408 output-buffer nil error-buffer)))))))
3411 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3412 MESSAGE may be either a string or a buffer.
3414 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3415 for maximum height of the echo area, as defined by `max-mini-window-height'
3416 if `resize-mini-windows' is non-nil.
3418 Returns either the string shown in the echo area, or when a pop-up
3419 buffer is used, the window used to display it.
3421 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3422 name of the buffer used to display it in the case where a pop-up buffer
3423 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3424 string and it is displayed in the echo area, it is not specified whether
3425 the contents are inserted into the buffer anyway.
3427 Optional arguments ACTION and FRAME are as for `display-buffer',
3428 and are only used if a pop-up buffer is displayed."
3430 ;; Trivial case where we can use the echo area
3434 ;; Trivial case where we can just remove single trailing newline
3437 ;; General case
3440 message
3449 0
3453 (<= lines
3457 max-mini-window-height))
3459 max-mini-window-height)
3463 ;; Don't use the echo area if the output buffer is
3464 ;; already displayed in the selected frame.
3466 ;; Echo area
3472 ;; Buffer
3477 ;; We have a sentinel to prevent insertion of a termination message
3478 ;; in the buffer itself.
3486 &optional output-buffer replace
3487 error-buffer display-error-buffer
3488 region-noncontiguous-p)
3489 "Execute string COMMAND in inferior shell with region as input.
3490 Normally display output (if any) in temp buffer `*Shell Command Output*';
3491 Prefix arg means replace the region with it. Return the exit code of
3492 COMMAND.
3494 To specify a coding system for converting non-ASCII characters
3496 before this command. By default, the input (from the current buffer)
3497 is encoded using coding-system specified by `process-coding-system-alist',
3498 falling back to `default-process-coding-system' if no match for COMMAND
3499 is found in `process-coding-system-alist'.
3501 Noninteractive callers can specify coding systems by binding
3502 `coding-system-for-read' and `coding-system-for-write'.
3504 If the command generates output, the output may be displayed
3505 in the echo area or in a buffer.
3506 If the output is short enough to display in the echo area
3507 \(determined by the variable `max-mini-window-height' if
3508 `resize-mini-windows' is non-nil), it is shown there.
3509 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3510 The output is available in that buffer in both cases.
3512 If there is output and an error, a message about the error
3513 appears at the end of the output. If there is no output, or if
3514 output is inserted in the current buffer, the buffer `*Shell
3515 Command Output*' is deleted.
3517 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3518 command's output. If the value is a buffer or buffer name,
3519 put the output there. If the value is nil, use the buffer
3520 `*Shell Command Output*'. Any other value, excluding nil,
3521 means to insert the output in the current buffer. In either case,
3522 the output is inserted after point (leaving mark after it).
3524 Optional fifth arg REPLACE, if non-nil, means to insert the
3525 output in place of text from START to END, putting point and mark
3526 around it.
3528 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3529 or buffer name to which to direct the command's standard error
3530 output. If nil, error output is mingled with regular output.
3531 When called interactively, `shell-command-default-error-buffer'
3532 is used for ERROR-BUFFER.
3534 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3535 display the error buffer if there were any errors. When called
3536 interactively, this is t."
3540 ;; Do this before calling region-beginning
3541 ;; and region-end, in case subprocess output
3542 ;; relocates them while we are in the minibuffer.
3544 ;; call-interactively recognizes region-beginning and
3545 ;; region-end specially, leaving them in the history.
3547 string
3548 current-prefix-arg
3549 current-prefix-arg
3550 shell-command-default-error-buffer
3551 t
3558 temporary-file-directory)))
3559 nil))
3560 exit-status)
3561 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3564 output)
3568 shell-file-name t t
3569 nil shell-command-switch
3570 command)
3577 ;; Replace specified region with output from command.
3579 ;; Don't muck with mark unless REPLACE says we should.
3586 t)
3587 nil shell-command-switch command))
3588 ;; It is rude to delete a buffer which the command is not using.
3589 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3590 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3591 ;; (kill-buffer shell-buffer)))
3592 ;; Don't muck with mark unless REPLACE says we should.
3594 ;; No prefix argument: put the output in a temp buffer,
3595 ;; replacing its entire contents.
3600 ;; If the input is the same buffer as the output,
3601 ;; delete everything but the specified region,
3602 ;; then replace that region with the output.
3608 shell-file-name t
3611 t)
3612 nil shell-command-switch
3613 command)))
3614 ;; Clear the output buffer, then run the command with
3615 ;; output there.
3626 buffer)
3627 nil shell-command-switch command)))
3628 ;; Report the output.
3638 ;; There's some output, display it
3640 ;; No output; error?
3647 shell-command-default-error-buffer)
3654 output))
3657 exit-status))
3660 exit-status output))))
3661 ;; Don't kill: there might be useful info in the undo-log.
3662 ;; (kill-buffer buffer)
3663 )))))
3671 ;; Do no formatting while reading error file,
3672 ;; because that can run a shell command, and we
3673 ;; don't want that to cause an infinite recursion.
3675 ;; Put point after the inserted errors.
3680 exit-status))
3683 "Execute shell command COMMAND and return its output as a string."
3686 standard-output
3690 "Process files synchronously in a separate process.
3691 Similar to `call-process', but may invoke a file handler based on
3692 `default-directory'. The current working directory of the
3693 subprocess is `default-directory'.
3695 File names in INFILE and BUFFER are handled normally, but file
3696 names in ARGS should be relative to `default-directory', as they
3697 are passed to the process verbatim. (This is a difference to
3698 `call-process' which does not support file handlers for INFILE
3699 and BUFFER.)
3701 Some file handlers might not support all variants, for example
3702 they might behave as if DISPLAY was nil, regardless of the actual
3703 value passed."
3705 lc stderr-file)
3715 display args)
3721 "Whether a call of `process-file' changes remote files.
3723 By default, this variable is always set to t, meaning that a
3724 call of `process-file' could potentially change any file on a
3725 remote host. When set to nil, a file handler could optimize
3726 its behavior with respect to remote file attribute caching.
3728 You should only ever change this variable with a let-binding;
3732 "Start a program in a subprocess. Return the process object for it.
3734 Similar to `start-process', but may invoke a file handler based on
3735 `default-directory'. See Info node `(elisp)Magic File Names'.
3737 This handler ought to run PROGRAM, perhaps on the local host,
3738 perhaps on a remote host that corresponds to `default-directory'.
3739 In the latter case, the local part of `default-directory' becomes
3740 the working directory of the process.
3742 PROGRAM and PROGRAM-ARGS might be file names. They are not
3743 objects of file handler invocation. File handlers might not
3744 support pty association, if PROGRAM is nil."
3748 \f
3749 ;;;; Process menu
3763 map))
3766 "Major mode for listing the processes called by Emacs."
3778 "Kill process at point in a `list-processes' buffer."
3789 "Recompute the list of processes for the Process List buffer.
3790 Also, delete any process that is exited or signaled."
3803 face link
3805 "Visit buffer `%s'"
3807 follow-link t
3808 process-buffer ,buf
3809 action process-menu-visit-buffer)
3818 "datagram"
3835 tabulated-list-entries))))))
3841 "Display a list of all processes that are Emacs sub-processes.
3842 If optional argument QUERY-ONLY is non-nil, only processes with
3843 the query-on-exit flag set are listed.
3844 Any process listed as exited or signaled is actually eliminated
3845 after the listing is made.
3846 Optional argument BUFFER specifies a buffer to use, instead of
3848 The return value is always nil.
3850 This function lists only processes that were launched by Emacs. To
3851 see other processes running on the system, use `list-system-processes'."
3863 nil)
3864 \f
3865 ;;;; Prefix commands
3871 ;; BEWARE: Called directly from C code.
3872 ;; If the return value is non-nil, it means we are in the middle of
3873 ;; a command with prefix, such as a command invoked with prefix-arg.
3875 prefix-command--last-echo
3884 "Abnormal hook which constructs the description of the current prefix state.
3888 "Update state of prefix commands.
3896 "Pass the current prefix command state to the next command.
3897 Should be called by all prefix commands.
3898 Runs `prefix-command-preserve-state-hook'."
3900 ;; If the current command is a prefix command, we don't want the next (real)
3901 ;; command to have `last-command' set to, say, `universal-argument'.
3908 nil)
3910 ;;;;; The main prefix command.
3912 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
3937 ;; For backward compatibility, minus with no modifiers is an ordinary
3938 ;; command if digits have already been entered.
3968 map)
3976 "Begin a numeric argument for the following command.
3981 multiplies the argument by 4 each time.
3983 which is different in effect from any particular numeric argument.
3991 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3992 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3999 arg)))
4003 "Begin a negative numeric argument for the next command.
4013 "Part of the numeric argument for the next command.
4018 last-command-event
4025 ;; Treat -0 as just -, so that -01 will work.
4028 digit))))
4030 \f
4038 "Function to perform the filtering in `filter-buffer-substring'.
4039 The function is called with the same 3 arguments (BEG END DELETE)
4040 that `filter-buffer-substring' received. It should return the
4041 buffer substring between BEG and END, after filtering. If DELETE is
4045 "List of filter functions for `buffer-substring--filter'.
4046 Each function must accept a single argument, a string, and return a string.
4047 The buffer substring is passed to the first function in the list,
4048 and the return value of each function is passed to the next.
4049 As a special convention, point is set to the start of the buffer text
4050 being operated on (i.e., the first argument of `buffer-substring--filter')
4056 "Return the buffer substring between BEG and END, after filtering.
4057 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4059 This calls the function that `filter-buffer-substring-function' specifies
4060 \(passing the same three arguments that it received) to do the work,
4061 and returns whatever it does. The default function does no filtering,
4062 unless a hook has been set.
4064 Use `filter-buffer-substring' instead of `buffer-substring',
4065 `buffer-substring-no-properties', or `delete-and-extract-region' when
4066 you want to allow filtering to take place. For example, major or minor
4067 modes can use `filter-buffer-substring-function' to extract characters
4068 that are special to a buffer, and should not be copied into other buffers."
4072 "Default function to use for `filter-buffer-substring-function'.
4073 Its arguments and return value are as specified for `filter-buffer-substring'.
4074 This respects the wrapper hook `filter-buffer-substring-functions',
4075 and the abnormal hook `buffer-substring-filters'.
4076 No filtering is done unless a hook says to."
4087 string)))
4092 ;;;; Window system cut and paste hooks.
4095 "Function to call to make a killed region available to other programs.
4096 Most window systems provide a facility for cutting and pasting
4097 text between different programs, such as the clipboard on X and
4098 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4100 This variable holds a function that Emacs calls whenever text is
4101 put in the kill ring, to make the new kill available to other
4102 programs. The function takes one argument, TEXT, which is a
4106 "Function to call to get text cut from other programs.
4107 Most window systems provide a facility for cutting and pasting
4108 text between different programs, such as the clipboard on X and
4109 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4111 This variable holds a function that Emacs calls to obtain text
4112 that other programs have provided for pasting. The function is
4113 called with no arguments. If no other program has provided text
4114 to paste, the function should return nil (in which case the
4115 caller, usually `current-kill', should use the top of the Emacs
4116 kill ring). If another program has provided text to paste, the
4117 function should return that text as a string (in which case the
4118 caller should put this string in the kill ring as the latest
4119 kill).
4121 The function may also return a list of strings if the window
4122 system supports multiple selections. The first string will be
4123 used as the pasted text, but the other will be placed in the kill
4124 ring for easy access via `yank-pop'.
4126 Note that the function should return a string only if a program
4127 other than Emacs has provided a string for pasting; if Emacs
4128 provided the most recent string, the function should return nil.
4129 If it is difficult to tell whether Emacs or some other program
4130 provided the current string, it is probably good enough to return
4131 nil if the string is equal (according to `string=') to the last
4133 \f
4136 ;;;; The kill ring data structure.
4139 "List of killed text sequences.
4140 Since the kill ring is supposed to interact nicely with cut-and-paste
4141 facilities offered by window systems, use of this variable should
4142 interact nicely with `interprogram-cut-function' and
4143 `interprogram-paste-function'. The functions `kill-new',
4144 `kill-append', and `current-kill' are supposed to implement this
4145 interaction; you may want to use them instead of manipulating the kill
4149 "Maximum length of kill ring before oldest elements are thrown away."
4157 "Save clipboard strings into kill ring before replacing them.
4158 When one selects something in another program to paste it into Emacs,
4159 but kills something in Emacs before actually pasting it,
4160 this selection is gone unless this variable is non-nil,
4161 in which case the other program's selection is saved in the `kill-ring'
4168 "Do not add a new string to `kill-ring' if it duplicates the last one.
4169 The comparison is done using `equal-including-properties'."
4175 "Make STRING the latest kill in the kill ring.
4176 Set `kill-ring-yank-pointer' to point to it.
4177 If `interprogram-cut-function' is non-nil, apply it to STRING.
4178 Optional second argument REPLACE non-nil means that STRING will replace
4179 the front of the kill ring, rather than being added to the list.
4181 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4182 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4183 STRING.
4185 When the yank handler has a non-nil PARAM element, the original STRING
4186 argument is not used by `insert-for-yank'. However, since Lisp code
4187 may access and use elements from the kill ring directly, the STRING
4190 ;; Due to text properties such as 'yank-handler that
4191 ;; can alter the contents to yank, comparison using
4192 ;; `equal' is unsafe.
4217 ;; It has been argued that this should work similar to `self-insert-command'
4218 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4220 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4226 "Append STRING to the end of the latest kill in the kill ring.
4227 If BEFORE-P is non-nil, prepend STRING to the kill.
4228 Also removes the last undo boundary in the current buffer,
4229 depending on `kill-append-merge-undo'.
4230 If `interprogram-cut-function' is set, pass the resulting kill to it."
4238 ;; find the next undo boundary
4242 ;; remove this undo boundary
4247 "Whether rotating the kill ring changes the window system selection.
4248 If non-nil, whenever the kill ring is rotated (usually via the
4249 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4250 to copy the new kill to the window system selection."
4256 "Rotate the yanking point by N places, and then return that kill.
4257 If N is zero and `interprogram-paste-function' is set to a
4258 function that returns a string or a list of strings, and if that
4259 function doesn't return nil, then that string (or list) is added
4260 to the front of the kill ring and the string (or first string in
4261 the list) is returned as the latest kill.
4263 If N is not zero, and if `yank-pop-change-selection' is
4264 non-nil, use `interprogram-cut-function' to transfer the
4265 kill at the new yank point into the window system selection.
4267 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4268 move the yanking point; just return the Nth kill forward."
4271 interprogram-paste-function
4275 ;; Disable the interprogram cut function when we add the new
4276 ;; text to the kill ring, so Emacs doesn't try to own the
4277 ;; selection, with identical text.
4287 kill-ring)))
4292 interprogram-cut-function)
4298 ;;;; Commands for manipulating the kill ring.
4301 "Non-nil means don't signal an error for killing read-only text."
4307 This deletes the text from the buffer and saves it in the kill ring.
4311 If you want to append the killed region to the last killed text,
4315 If the previous command was also a kill command,
4316 the text killed this time appends to the text killed last time
4317 to make one entry in the kill ring.
4319 The killed text is filtered by `filter-buffer-substring' before it is
4320 saved in the kill ring, so the actual saved text might be different
4321 from what was killed.
4323 If the buffer is read-only, Emacs will beep and refrain from deleting
4324 the text, but put the text in the kill ring anyway. This means that
4325 you can use the killing commands to copy text from a read-only buffer.
4327 Lisp programs should use this function for killing text.
4328 (To delete text, use `delete-region'.)
4329 Supply two arguments, character positions BEG and END indicating the
4330 stretch of text to be killed. If the optional argument REGION is
4331 non-nil, the function ignores BEG and END, and kills the current
4332 region instead."
4333 ;; Pass mark first, then point, because the order matters when
4334 ;; calling `kill-append'.
4343 ;; Add that string to the kill ring, one way or another.
4350 nil)
4352 ;; The code above failed because the buffer, or some of the characters
4353 ;; in the region, are read-only.
4354 ;; We should beep, in case the user just isn't aware of this.
4355 ;; However, there's no harm in putting
4356 ;; the region's text in the kill ring, anyway.
4358 ;; Set this-command now, so it will be set even if we get an error.
4360 ;; This should barf, if appropriate, and give us the correct error.
4363 ;; Signal an error if the buffer is read-only.
4365 ;; If the buffer isn't read-only, the text is.
4368 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4369 ;; to get two copies of the text when the user accidentally types M-w and
4370 ;; then corrects it with the intended C-w.
4372 "Save the region as if killed, but don't kill it.
4373 In Transient Mark mode, deactivate the mark.
4374 If `interprogram-cut-function' is non-nil, also save the text for a window
4375 system cut and paste.
4377 The copied text is filtered by `filter-buffer-substring' before it is
4378 saved in the kill ring, so the actual saved text might be different
4379 from what was in the buffer.
4381 When called from Lisp, save in the kill ring the stretch of text
4382 between BEG and END, unless the optional argument REGION is
4383 non-nil, in which case ignore BEG and END, and save the current
4384 region instead.
4386 This command's old key binding has been given to `kill-ring-save'."
4387 ;; Pass mark first, then point, because the order matters when
4388 ;; calling `kill-append'.
4398 nil)
4401 "Save the region as if killed, but don't kill it.
4402 In Transient Mark mode, deactivate the mark.
4403 If `interprogram-cut-function' is non-nil, also save the text for a window
4404 system cut and paste.
4406 If you want to append the killed line to the last killed text,
4409 The copied text is filtered by `filter-buffer-substring' before it is
4410 saved in the kill ring, so the actual saved text might be different
4411 from what was in the buffer.
4413 When called from Lisp, save in the kill ring the stretch of text
4414 between BEG and END, unless the optional argument REGION is
4415 non-nil, in which case ignore BEG and END, and save the current
4416 region instead.
4418 This command is similar to `copy-region-as-kill', except that it gives
4419 visual feedback indicating the extent of the region being copied."
4420 ;; Pass mark first, then point, because the order matters when
4421 ;; calling `kill-append'.
4425 ;; This use of called-interactively-p is correct because the code it
4426 ;; controls just gives the user visual feedback.
4431 "Indicate that the region text has been copied interactively.
4432 If the mark is visible in the selected window, blink the cursor
4433 between point and mark if there is currently no active region
4434 highlighting.
4436 If the mark lies outside the selected window, display an
4437 informative message containing a sample of the copied text. The
4438 optional argument MESSAGE-LEN, if non-nil, specifies the length
4439 of this sample text; it defaults to 40."
4442 ;; Inhibit quitting so we can make a quit here
4443 ;; look like a C-g typed as a command.
4446 ;; Swap point-and-mark quickly so as to show the region that
4447 ;; was selected. Don't do it if the region is highlighted.
4450 ;; Swap point and mark.
4454 ;; Swap back.
4457 ;; If user quit, deactivate the mark
4458 ;; as C-g would as a command.
4464 ;; Don't say "killed"; that is misleading.
4471 "Cause following command, if it kills, to add to previous kill.
4472 If the next command kills forward from point, the kill is
4473 appended to the previous killed text. If the command kills
4474 backward, the kill is prepended. Kill commands that act on the
4475 region, such as `kill-region', are regarded as killing forward if
4476 point is after mark, and killing backward if point is before
4477 mark.
4479 If the next command is not a kill command, `append-next-kill' has
4480 no effect.
4482 The argument is used for internal purposes; do not supply one."
4484 ;; We don't use (interactive-p), since that breaks kbd macros.
4498 "A subroutine of `squeeze-bidi-context'.
4499 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4503 lim1)
4510 ;; L and R categories include embedding and
4511 ;; override controls, but we don't want to
4512 ;; replace them, because that might change
4513 ;; the visual order. Likewise with PDF and
4514 ;; isolate controls.
4516 bidi-directional-non-controls-chars
4517 limit)))))
4518 ;; Replace any run of non-RTL characters by a single LRM.
4520 ;; No more characters of CATEGORY, we are done.
4525 ;; Skip directional controls, if any.
4530 "Replace characters between FROM and TO while keeping bidi context.
4532 This function replaces the region of text with as few characters
4533 as possible, while preserving the effect that region will have on
4534 bidirectional display before and after the region."
4538 ;; This is for when they copy text with read-only text
4539 ;; properties.
4543 ;; Replace each run of non-RTL characters with a single LRM.
4545 ;; Replace each run of non-LTR characters with a single RLM. Note
4546 ;; that the \cR category includes both the Arabic Letter (AL) and
4547 ;; R characters; here we ignore the distinction between them,
4548 ;; because that distinction only affects Arabic Number (AN)
4549 ;; characters, which are weak and don't affect the reordering.
4553 "Return buffer text between START and END with its bidi context.
4555 START and END are assumed to belong to the same physical line
4556 of buffer text. This function prepends and appends to the text
4557 between START and END bidi control characters that preserve the
4558 visual order of that text when it is inserted at some other place."
4563 substr para-dir from to)
4570 ;; If we don't have any mixed directional characters in the
4571 ;; entire line, we can just copy the substring without adding
4572 ;; any context.
4587 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4588 ;; (1) force the string to have the same base embedding
4589 ;; direction as the paragraph direction at the source, no matter
4590 ;; what is the paragraph direction at destination; and (2) avoid
4591 ;; affecting the visual order of the surrounding text at
4592 ;; destination if there are characters of different
4593 ;; directionality there.
4598 "Return portion of current buffer between START and END with bidi context.
4600 This function works similar to `buffer-substring', but it prepends and
4601 appends to the text bidi directional control characters necessary to
4602 preserve the visual appearance of the text if it is inserted at another
4603 place. This is useful when the buffer substring includes bidirectional
4604 text and control characters that cause non-trivial reordering on display.
4605 If copied verbatim, such text can have a very different visual appearance,
4606 and can also change the visual appearance of the surrounding text at the
4607 destination of the copy.
4609 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4610 the text properties."
4623 no-properties)))
4627 substr)))
4628 \f
4629 ;; Yanking.
4634 "List of special text property handling conditions for yanking.
4635 Each element should have the form (PROP . FUN), where PROP is a
4636 property symbol and FUN is a function. When the `yank' command
4637 inserts text into the buffer, it scans the inserted text for
4638 stretches of text that have `eq' values of the text property
4639 PROP; for each such stretch of text, FUN is called with three
4640 arguments: the property's value in that text, and the start and
4641 end positions of the text.
4643 This is done prior to removing the properties specified by
4644 `yank-excluded-properties'."
4647 function))
4650 ;; This is actually used in subr.el but defcustom does not work there.
4653 intangible invisible keymap local-map mouse-face read-only
4654 yank-handler)
4655 "Text properties to discard when yanking.
4656 The value should be a list of text properties to discard or t,
4657 which means to discard all text properties.
4659 See also `yank-handled-properties'."
4666 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4667 Function is called with two parameters, START and END corresponding to
4668 the value of the mark and point; it is guaranteed that START <= END.
4672 "Replace just-yanked stretch of killed text with a different stretch.
4673 This command is allowed only immediately after a `yank' or a `yank-pop'.
4674 At such a time, the region contains a stretch of reinserted
4675 previously-killed text. `yank-pop' deletes that text and inserts in its
4676 place a different stretch of killed text.
4678 With no argument, the previous kill is inserted.
4679 With argument N, insert the Nth previous kill.
4680 If N is negative, this is a more recent kill.
4682 The sequence of kills wraps around, so that after the oldest one
4683 comes the newest one.
4685 When this command inserts killed text into the buffer, it honors
4686 `yank-excluded-properties' and `yank-handler' as described in the
4687 doc string for `insert-for-yank-1', which see."
4701 ;; Set the window start back where it was in the yank command,
4702 ;; if possible.
4705 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4706 ;; It is cleaner to avoid activation, even though the command
4707 ;; loop would deactivate the mark because we inserted text.
4710 nil)
4714 More precisely, reinsert the most recent kill, which is the
4715 stretch of killed text most recently killed OR yanked. Put point
4716 at the end, and set mark at the beginning without activating it.
4718 With argument N, reinsert the Nth most recent kill.
4720 When this command inserts text into the buffer, it honors the
4721 `yank-handled-properties' and `yank-excluded-properties'
4722 variables, and the `yank-handler' text property. See
4723 `insert-for-yank-1' for details.
4728 ;; If we don't get all the way thru, make last-command indicate that
4729 ;; for the following command.
4737 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4738 ;; It is cleaner to avoid activation, even though the command
4739 ;; loop would deactivate the mark because we inserted text.
4742 ;; If we do get all the way thru, make this-command indicate that.
4745 nil)
4748 "Rotate the yanking point in the kill ring.
4749 With ARG, rotate that many kills forward (or backward, if negative)."
4752 \f
4753 ;; Some kill commands.
4755 ;; Internal subroutine of delete-char
4761 ;; Internal subroutine of backward-delete-char
4768 "The method for untabifying when deleting backward.
4769 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4770 `hungry' -- delete all whitespace, both tabs and spaces;
4771 `all' -- delete all whitespace, including tabs, spaces and newlines;
4772 nil -- just delete one character."
4778 "Delete characters backward, changing tabs into spaces.
4779 The exact behavior depends on `backward-delete-char-untabify-method'.
4780 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4781 Interactively, ARG is the prefix arg (default 1)
4782 and KILLP is t if a prefix arg was specified."
4805 arg)))
4806 ;; Avoid warning about delete-backward-char
4810 "Kill up to and including ARGth occurrence of CHAR.
4811 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4812 Goes backward if ARG is negative; error if CHAR not found."
4815 ;; Avoid "obsolete" warnings for translation-table-for-input.
4823 ;; kill-line and its subroutines.
4826 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4831 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4832 With prefix argument ARG, kill that many lines from point.
4833 Negative arguments kill lines backward.
4834 With zero argument, kills the text before point on the current line.
4837 a number counts as a prefix arg.
4839 To kill a whole line, when point is not at the beginning, type \
4842 If `show-trailing-whitespace' is non-nil, this command will just
4843 kill the rest of the current line, even if there are only
4844 nonblanks there.
4846 If option `kill-whole-line' is non-nil, then this command kills the whole line
4847 including its terminating newline, when used at the beginning of a line
4848 with no argument. As a consequence, you can always kill a whole line
4851 If you want to append the killed line to the last killed text,
4854 If the buffer is read-only, Emacs will beep and refrain from deleting
4855 the line, but put the line in the kill ring anyway. This means that
4856 you can use this command to copy text from a read-only buffer.
4857 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4858 even beep.)"
4861 ;; It is better to move point to the other end of the kill
4862 ;; before killing. That way, in a read-only buffer, point
4863 ;; moves across the text that is copied to the kill ring.
4864 ;; The choice has no effect on undo now that undo records
4865 ;; the value of point from before the command was run.
4875 ;; If trailing whitespace is visible,
4876 ;; don't treat it as nothing.
4886 "Kill current line.
4887 With prefix ARG, kill that many lines starting from the current line.
4888 If ARG is negative, kill backward. Also kill the preceding newline.
4890 If ARG is zero, kill current line but exclude the trailing newline."
4901 ;; We need to kill in two steps, because the previous command
4902 ;; could have been a kill command, in which case the text
4903 ;; before point needs to be prepended to the current kill
4904 ;; ring entry and the text after point appended. Also, we
4905 ;; need to use save-excursion to avoid copying the same text
4906 ;; twice to the kill ring in read-only buffers.
4924 "Move forward by ARG lines, ignoring currently invisible newlines only.
4925 If ARG is negative, move backward -ARG lines.
4926 If ARG is zero, move to the beginning of the current line."
4933 ;; If the newline we just skipped is invisible,
4934 ;; don't count it.
4938 prop
4943 ;; If invisible text follows, and it is a number of complete lines,
4944 ;; skip it.
4950 prop
4966 ;; If the newline we just moved to is invisible,
4967 ;; don't count it.
4972 prop
4977 ;; If invisible text follows, and it is a number of complete lines,
4978 ;; skip it.
4984 prop
4995 nil)))
4998 "Move to end of current visible line."
5000 ;; If the following character is currently invisible,
5001 ;; skip all characters with that same `invisible' property value,
5002 ;; then find the next newline.
5009 prop
5018 \f
5020 "Insert after point the contents of BUFFER.
5021 Puts mark after the inserted text.
5022 BUFFER may be a buffer or a buffer name."
5032 t))))
5037 nil)
5040 "Append to specified buffer the text of the region.
5041 It is inserted into that buffer before its point.
5043 When calling from a program, give three arguments:
5044 BUFFER (or buffer name), START and END.
5045 START and END specify the portion of the current buffer to be copied."
5052 point)
5063 "Prepend to specified buffer the text of the region.
5064 It is inserted into that buffer after its point.
5066 When calling from a program, give three arguments:
5067 BUFFER (or buffer name), START and END.
5068 START and END specify the portion of the current buffer to be copied."
5077 "Copy to specified buffer the text of the region.
5078 It is inserted into that buffer, replacing existing text there.
5080 When calling from a program, give three arguments:
5081 BUFFER (or buffer name), START and END.
5082 START and END specify the portion of the current buffer to be copied."
5090 \f
5094 "Hook run when the mark becomes active.
5095 It is also run at the end of a command, if the mark is active and
5102 "Return this buffer's mark value as integer, or nil if never set.
5104 In Transient Mark mode, this function signals an error if
5105 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5106 or the argument FORCE is non-nil, it disregards whether the mark
5107 is active, and returns an integer or nil in the usual way.
5109 If you are using this in an editing command, you are most likely making
5110 a mistake; see the documentation of `set-mark'."
5115 ;; Behind display-selections-p.
5118 "Deactivate the mark.
5119 If Transient Mark mode is disabled, this function normally does
5120 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5122 Deactivating the mark sets `mark-active' to nil, updates the
5123 primary selection according to `select-active-regions', and runs
5124 `deactivate-mark-hook'.
5126 If Transient Mark mode was temporarily enabled, reset the value
5127 of the variable `transient-mark-mode'; if this causes Transient
5128 Mark mode to be disabled, don't change `mark-active' to nil or
5129 run `deactivate-mark-hook'."
5133 select-active-regions)
5136 ;; The var `saved-region-selection', if non-nil, is the text in
5137 ;; the region prior to the last command modifying the buffer.
5138 ;; Set the selection to that, or to the current region.
5143 ;; If another program has acquired the selection, region
5144 ;; deactivation should not clobber it (Bug#11772).
5163 "Activate the mark.
5164 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5174 "Set this buffer's mark to POS. Don't use this function!
5175 That is to say, don't use this function unless you want
5176 the user to see that the mark has moved, and you want the previous
5177 mark position to be lost.
5179 Normally, when a new mark is set, the old one should go on the stack.
5180 This is why most applications should use `push-mark', not `set-mark'.
5182 Novice Emacs Lisp programmers often try to use the mark for the wrong
5183 purposes. The mark saves a location for the user's convenience.
5184 Most editing commands should not alter the mark.
5185 To remember a location for internal use in the Lisp program,
5186 store it in a Lisp variable. Example:
5188 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5193 ;; Normally we never clear mark-active except in Transient Mark mode.
5194 ;; But when we actually clear out the mark value too, we must
5195 ;; clear mark-active in any mode.
5197 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5198 ;; it should never be nil if the mark is nil.
5206 mark-active))
5213 ;; Mark marker
5219 ;; Mark active
5222 ;; If mark is active now, and either was not active or was at a
5223 ;; different place, run the activate hook.
5228 ;; If mark has ceased to be active, run deactivate hook.
5233 "Like `save-excursion', but also save and restore the mark state.
5234 This macro does what `save-excursion' did before Emacs 25.1."
5243 If nil, region-aware commands treat the empty region as inactive.
5244 If non-nil, region-aware commands treat the region as active as
5245 long as the mark is active, even if the region is empty.
5247 Region-aware commands are those that act on the region if it is
5248 active and Transient Mark mode is enabled, and on the text near
5249 point otherwise."
5255 "Return t if the region is active and it is appropriate to act on it.
5256 This is used by commands that act specially on the region under
5257 Transient Mark mode.
5259 The return value is t if Transient Mark mode is enabled and the
5260 mark is active; furthermore, if `use-empty-active-region' is nil,
5261 the region must not be empty. Otherwise, the return value is nil.
5263 For some commands, it may be appropriate to ignore the value of
5264 `use-empty-active-region'; in that case, use `region-active-p'."
5269 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5271 Some commands act specially on the region when Transient Mark
5272 mode is enabled. Usually, such commands should use
5273 `use-region-p' instead of this function, because `use-region-p'
5274 also checks the value of `use-empty-active-region'."
5276 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5277 ;; without the mark being set (e.g. bug#17324). We really should fix
5278 ;; that problem, but in the mean time, let's make sure we don't say the
5279 ;; region is active when there's no mark.
5283 "Return non-nil if the region contains several pieces.
5284 An example is a rectangular region handled as a list of
5285 separate contiguous regions for each line."
5298 ;; Normal priority so that a large region doesn't hide all the
5299 ;; overlays within it, but high secondary priority so that if it
5300 ;; ends/starts in the middle of a small overlay, that small overlay
5301 ;; won't hide the region's boundaries.
5303 nrol)
5308 rol)))
5324 start end window rol)))
5327 new))))))
5330 "Hook run just before redisplay.
5331 It is called in each window that is to be redisplayed. It takes one argument,
5332 which is the window that will be redisplayed. When run, the `current-buffer'
5353 "Maximum size of mark ring. Start discarding off end if gets this big."
5361 "Maximum size of global mark ring. \
5362 Start discarding off end if gets this big."
5367 "Jump to mark, and pop a new position for mark off the ring.
5368 \(Does not affect global mark ring)."
5378 "Set mark at where point is.
5379 If no prefix ARG and mark is already set there, just activate it.
5380 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5392 will pop the mark twice, and
5394 will pop the mark three times.
5402 "Set the mark where point is, or jump to the mark.
5403 Setting the mark also alters the region, which is the text
5404 between point and mark; this is the closest equivalent in
5407 With no prefix argument, set the mark at point, and push the
5408 old mark position on local mark ring. Also push the old mark on
5409 global mark ring, if the previous mark was set in another buffer.
5411 When Transient Mark Mode is off, immediately repeating this
5412 command activates `transient-mark-mode' temporarily.
5415 jump to the mark, and set the mark from
5416 position popped off the local mark ring (this does not affect the global
5418 mark ring (see `pop-global-mark').
5420 If `set-mark-command-repeat-pop' is non-nil, repeating
5422 off the local (or global) mark ring and jumps there.
5425 argument, unconditionally set mark where point is, even if
5426 `set-mark-command-repeat-pop' is non-nil.
5428 Novice Emacs Lisp programmers often try to use the mark for the wrong
5429 purposes. See the documentation of `set-mark' for more information."
5449 arg)
5463 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5464 If the last global mark pushed was not in the current buffer,
5465 also push LOCATION on the global mark ring.
5466 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5468 Novice Emacs Lisp programmers often try to use the mark for the wrong
5469 purposes. See the documentation of `set-mark' for more information.
5471 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5478 ;; Now push the mark on the global mark ring.
5481 ;; The last global mark pushed was in this same buffer.
5482 ;; Don't push another one.
5483 nil
5492 nil)
5495 "Pop off mark ring into the buffer's actual mark.
5496 Does not set point. Does nothing if mark ring is empty."
5508 "Put the mark where point is now, and point where the mark is now.
5509 This command works even when the mark is not active,
5510 and it reactivates the mark.
5512 If Transient Mark mode is on, a prefix ARG deactivates the mark
5513 if it is active, and otherwise avoids reactivating it. If
5514 Transient Mark mode is off, a prefix ARG enables Transient Mark
5515 mode temporarily."
5529 nil))
5532 "When non-nil, shifted motion keys activate the mark momentarily.
5534 While the mark is activated in this way, any shift-translated point
5535 motion key extends the region, and if Transient Mark mode was off, it
5536 is temporarily turned on. Furthermore, the mark will be deactivated
5537 by any subsequent point motion key that was not shift-translated, or
5538 by any action that normally deactivates the mark in Transient Mark mode.
5540 See `this-command-keys-shift-translated' for the meaning of
5541 shift-translation."
5546 "Activate/deactivate mark depending on invocation thru shift translation.
5547 This function is called by `call-interactively' when a command
5548 with a `^' character in its `interactive' spec is invoked, before
5549 running the command itself.
5551 If `shift-select-mode' is enabled and the command was invoked
5552 through shift translation, set the mark and activate the region
5553 temporarily, unless it was already set in this way. See
5554 `this-command-keys-shift-translated' for the meaning of shift
5555 translation.
5557 Otherwise, if the region has been activated temporarily,
5558 deactivate it, and restore the variable `transient-mark-mode' to
5559 its earlier value."
5566 transient-mark-mode)))
5575 "Toggle Transient Mark mode.
5576 With a prefix argument ARG, enable Transient Mark mode if ARG is
5577 positive, and disable it otherwise. If called from Lisp, enable
5578 Transient Mark mode if ARG is omitted or nil.
5580 Transient Mark mode is a global minor mode. When enabled, the
5581 region is highlighted with the `region' face whenever the mark
5583 and after certain other operations that set the mark but whose
5584 main purpose is something else--for example, incremental search,
5590 Many commands change their behavior when Transient Mark mode is
5591 in effect and the mark is active, by acting on the region instead
5592 of their usual default part of the buffer's text. Examples of
5595 To see the documentation of commands which are sensitive to the
5598 :global t
5599 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5603 "Non-nil means it is ok for commands to call `widen' when they want to.
5604 Some commands will do this in order to go to positions outside
5605 the current accessible part of the buffer.
5607 If `widen-automatically' is nil, these commands will do something else
5611 "Whether the currently executing code is performing an essential task.
5612 This variable should be non-nil only when running code which should not
5613 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5614 user for a password when we are simply scanning a set of files in the
5615 background or displaying possible completions before the user even asked
5619 "Pop off global mark ring and jump to the top location."
5621 ;; Pop entries which refer to non-existent buffers.
5639 \f
5641 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5647 "Move cursor vertically down ARG lines.
5648 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5649 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5650 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5651 function will not vscroll.
5653 ARG defaults to 1.
5655 If there is no character in the target line exactly under the current column,
5656 the cursor is positioned after the character in that line which spans this
5657 column, or at the end of the line if it is not long enough.
5658 If there is no line in the buffer after this one, behavior depends on the
5659 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5660 to create a line, and moves the cursor to that line. Otherwise it moves the
5661 cursor to the end of the buffer.
5663 If the variable `line-move-visual' is non-nil, this command moves
5664 by display lines. Otherwise, it moves by buffer lines, without
5665 taking variable-width characters or continued lines into account.
5668 a semipermanent goal column for this command.
5669 Then instead of trying to move exactly vertically (or as close as possible),
5670 this command moves to the specified goal column (or as close as possible).
5671 The goal column is stored in the variable `goal-column', which is nil
5672 when there is no goal column. Note that setting `goal-column'
5673 overrides `line-move-visual' and causes this command to move by buffer
5674 lines rather than by display lines."
5680 ;; When adding a newline, don't expand an abbrev.
5691 nil)
5694 "Move cursor vertically up ARG lines.
5695 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5696 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5697 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5698 function will not vscroll.
5700 ARG defaults to 1.
5702 If there is no character in the target line exactly over the current column,
5703 the cursor is positioned after the character in that line which spans this
5704 column, or at the end of the line if it is not long enough.
5706 If the variable `line-move-visual' is non-nil, this command moves
5707 by display lines. Otherwise, it moves by buffer lines, without
5708 taking variable-width characters or continued lines into account.
5711 a semipermanent goal column for this command.
5712 Then instead of trying to move exactly vertically (or as close as possible),
5713 this command moves to the specified goal column (or as close as possible).
5714 The goal column is stored in the variable `goal-column', which is nil
5715 when there is no goal column. Note that setting `goal-column'
5716 overrides `line-move-visual' and causes this command to move by buffer
5717 lines rather than by display lines."
5728 nil)
5731 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5732 This means moving to the end of each line moved onto.
5733 The beginning of a blank line does not count as the end of a line.
5734 This has no effect when the variable `line-move-visual' is non-nil."
5740 A non-nil setting overrides the variable `line-move-visual', which see."
5747 "Current goal column for vertical motion.
5748 It is the column where point was at the start of the current run
5749 of vertical motion commands.
5751 When moving by visual lines via the function `line-move-visual', it is a cons
5752 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5753 divided by the default column width, and HSCROLL is the number of
5754 columns by which window is scrolled from left margin.
5756 When the `track-eol' feature is doing its job, the value is
5760 "Non-nil means commands that move by lines ignore invisible newlines.
5761 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5762 as if newlines that are invisible didn't exist, and count
5763 only visible newlines. Thus, moving across across 2 newlines
5764 one of which is invisible will be counted as a one-line move.
5765 Also, a non-nil value causes invisible text to be ignored when
5766 counting columns for the purposes of keeping point in the same
5769 Outline mode sets this."
5774 "When non-nil, `line-move' moves point by visual lines.
5775 This movement is based on where the cursor is displayed on the
5776 screen, instead of relying on buffer contents alone. It takes
5777 into account variable-width characters and line continuation.
5778 If nil, `line-move' moves point by logical lines.
5779 A non-nil setting of `goal-column' overrides the value of this variable
5780 and forces movement by logical lines.
5781 A window that is horizontally scrolled also forces movement by logical
5782 lines."
5787 ;; Only used if display-graphic-p.
5791 "Return the height in pixels of the current buffer's default face font.
5793 If the default font is remapped (see `face-remapping-alist'), the
5794 function returns the height of the remapped face."
5798 ;; Avoid calling font-info if the frame's default font was
5799 ;; not changed since the frame was created. That's because
5800 ;; font-info is expensive for some fonts, see bug #14838.
5806 "Return the width in pixels of the current buffer's default face font.
5808 If the default font is remapped (see `face-remapping-alist'), the
5809 function returns the width of the remapped face."
5813 ;; Avoid calling font-info if the frame's default font was
5814 ;; not changed since the frame was created. That's because
5815 ;; font-info is expensive for some fonts, see bug #14838.
5820 width
5825 "Return the pixel height of current buffer's default-face text line.
5827 The value includes `line-spacing', if any, defined for the buffer
5828 or the frame."
5841 "Return the number of screen lines in the text area of the selected window.
5843 This is different from `window-text-height' in that this function counts
5844 lines in units of the height of the font used by the default face displayed
5845 in the window, not in units of the frame's default font, and also accounts
5846 for `line-spacing', if any, defined for the window's buffer or frame.
5848 The value is a floating-point number."
5853 ;; Returns non-nil if partial move was done.
5856 ;; Move backward (up).
5857 ;; If already vscrolled, reduce vscroll
5863 ;; Move forward (down).
5876 py vs last-line)
5896 col-row)
5901 ;; VPOS > 0 means the last line is only partially visible.
5902 ;; But if the part that is visible is at least as tall as the
5903 ;; default font, that means the line is actually fully
5904 ;; readable, and something like line-spacing is hidden. So in
5905 ;; that case we accept the last line in the window as still
5906 ;; visible, and consider the margin as starting one line
5907 ;; later.
5915 ;; If last line of window is fully visible, and vscrolling
5916 ;; more would make this line invisible, move forward.
5921 nil)
5922 ;; If cursor is not in the bottom scroll margin, and the
5923 ;; current line is is not too tall, move forward.
5925 vpos
5928 nil)
5929 ;; When already vscrolled, we vscroll some more if we can,
5930 ;; or clear vscroll and move forward at end of tall image.
5935 ;; If cursor just entered the bottom scroll margin, move forward,
5936 ;; but also optionally vscroll one line so redisplay won't recenter.
5940 ;; Don't vscroll if the partially-visible line at window
5941 ;; bottom is not too tall (a.k.a. "just one more text
5942 ;; line"): in that case, we do want redisplay to behave
5943 ;; normally, i.e. recenter or whatever.
5944 ;;
5945 ;; Note: ROWH + RBOT from the value returned by
5946 ;; pos-visible-in-window-p give the total height of the
5947 ;; partially-visible glyph row at the end of the window. As
5948 ;; we are dealing with floats, we disregard sub-pixel
5949 ;; discrepancies between that and DLH.
5953 t)
5954 ;; If there are lines above the last line, scroll-up one line.
5957 t)
5958 ;; Finally, start vscroll.
5963 ;; This is like line-move-1 except that it also performs
5964 ;; vertical scrolling of tall images if appropriate.
5965 ;; That is not really a clean thing to do, since it mixes
5966 ;; scrolling with cursor motion. But so far we don't have
5967 ;; a cleaner solution to the problem of making C-n do something
5968 ;; useful given a tall image.
5970 "Move forward ARG lines.
5971 If NOERROR, don't signal an error if we can't move ARG lines.
5972 TO-END is unused.
5973 TRY-VSCROLL controls whether to vscroll tall lines: if either
5974 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5975 not vscroll."
5979 ;; Only vscroll for single line moves
5981 ;; Under scroll-conservatively, the display engine
5982 ;; does this better.
5984 ;; But don't vscroll in a keyboard macro.
5990 ;; Display-based column are incompatible with goal-column.
5992 ;; When the text in the window is scrolled to the left,
5993 ;; display-based motion doesn't make sense (because each
5994 ;; logical line occupies exactly one screen line).
5996 ;; Likewise when the text _was_ scrolled to the left
5997 ;; when the current run of vertical motion commands
5998 ;; started.
6001 auto-hscroll-mode
6003 (>= temporary-goal-column
6006 ;; If we moved into a tall line, set vscroll to make
6007 ;; scrolling through tall images more smooth.
6011 winh)
6017 nil
6021 ;; Display-based alternative to line-move-1.
6022 ;; Arg says how many lines to move. The value is t if we can move the
6023 ;; specified number of lines.
6025 "Move ARG lines forward.
6026 If NOERROR, don't signal an error if we can't move that many lines."
6029 target-hscroll)
6030 ;; Check if the previous command was a line-motion command, or if
6031 ;; we were called from some other command.
6034 ;; If so, there's no need to reset `temporary-goal-column',
6035 ;; but we may need to hscroll.
6039 ;; Otherwise, we should reset `temporary-goal-column'.
6041 x-pos)
6043 ;; Handle the `overflow-newline-into-fringe' case:
6048 ;; In R2L lines, the X pixel coordinate is measured from the
6049 ;; left edge of the window, but columns are still counted
6050 ;; from the logical-order beginning of the line, i.e. from
6051 ;; the right edge in this case. We need to adjust for that.
6057 hscroll)))
6059 ;; When we move beyond the first/last character visible in
6060 ;; the window, posn-at-point will return nil, so we need to
6061 ;; approximate the goal column as below.
6066 ;; vertical-motion can move more than it was asked to if it moves
6067 ;; across display strings with newlines. We don't want to ring
6068 ;; the bell and announce beginning/end of buffer in that case.
6074 temporary-goal-column))
6075 arg))
6076 arg))
6082 temporary-goal-column))
6083 arg))
6084 arg)))
6087 ;; If the goal column lies on a display string,
6088 ;; `vertical-motion' advances the cursor to the end
6089 ;; of the string. For arg < 0, this can cause the
6090 ;; cursor to get stuck. (Bug#3020).
6094 nil)))))
6096 ;; This is the guts of next-line and previous-line.
6097 ;; Arg says how many lines to move.
6098 ;; The value is t if we can move the specified number of lines.
6100 ;; Don't run any point-motion hooks, and disregard intangibility,
6101 ;; for intermediate positions.
6113 ;; Don't count beg of empty line as end of line
6114 ;; unless we just did explicit end-of-line.
6116 most-positive-fixnum
6120 line-move-ignore-invisible))
6121 ;; Use just newline characters.
6122 ;; Set ARG to 0 if we move as many lines as requested.
6125 ;; This way of moving forward ARG lines
6126 ;; verifies that we have a newline after the last one.
6127 ;; It doesn't get confused by intangible text.
6136 'beginning-of-buffer
6138 nil)))
6139 ;; Move by arg lines, but ignore invisible ones.
6142 ;; If the following character is currently invisible,
6143 ;; skip all characters with that same `invisible' property value.
6146 ;; Move a line.
6147 ;; We don't use `end-of-line', since we want to escape
6148 ;; from field boundaries occurring exactly at point.
6154 ;; If there's no invisibility here, move over the newline.
6163 ;; We avoid vertical-motion when possible
6164 ;; because that has to fontify.
6166 ;; Otherwise move a more sophisticated way.
6173 ;; The logic of this is the same as the loop above,
6174 ;; it just goes in the other direction.
6176 ;; For completely consistency with the forward-motion
6177 ;; case, we should call beginning-of-line here.
6178 ;; However, if point is inside a field and on a
6179 ;; continued line, the call to (vertical-motion -1)
6180 ;; below won't move us back far enough; then we return
6181 ;; to the same column in line-move-finish, and point
6182 ;; gets stuck -- cyd
6200 ;; if our target is the middle of this line.
6205 ;; This is the value the function returns.
6209 ;; If we did not move down as far as desired, at least go
6210 ;; to end of line. Be sure to call point-entered and
6211 ;; point-left-hooks.
6217 ;; If we did not move up as far as desired,
6218 ;; at least go to beginning of line.
6230 ;; Set REPEAT to t to repeat the whole thing.
6237 ;; Compute the end of the line
6238 ;; ignoring effectively invisible newlines.
6240 ;; Like end-of-line but ignores fields.
6247 ;; Move to the desired column.
6250 ;; Corner case: suppose we start out in a field boundary in
6251 ;; the middle of a continued line. When we get to
6252 ;; line-move-finish, point is at the start of a new *screen*
6253 ;; line but the same text line; then line-move-to-column would
6254 ;; move us backwards. Test using C-n with point on the "x" in
6255 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6262 ;; Process intangibility within a line.
6263 ;; With inhibit-point-motion-hooks bound to nil, a call to
6264 ;; goto-char moves point past intangible text.
6266 ;; However, inhibit-point-motion-hooks controls both the
6267 ;; intangibility and the point-entered/point-left hooks. The
6268 ;; following hack avoids calling the point-* hooks
6269 ;; unnecessarily. Note that we move *forward* past intangible
6270 ;; text when the initial and final points are the same.
6275 ;; If intangibility moves us to a different (later) place
6276 ;; in the same line, use that as the destination.
6279 ;; If that position is "too late",
6280 ;; try the previous allowable position.
6281 ;; See if it is ok.
6284 ;; If going forward, don't accept the previous
6285 ;; allowable position if it is before the target line.
6287 ;; If going backward, don't accept the previous
6288 ;; allowable position if it is still after the target line.
6291 ;; As a last resort, use the end of the line.
6294 ;; Now move to the updated destination, processing fields
6295 ;; as well as intangibility.
6299 ;; Ignore field boundaries if the initial and final
6300 ;; positions have the same `field' property, even if the
6301 ;; fields are non-contiguous. This seems to be "nicer"
6302 ;; behavior in many situations.
6305 new
6309 ;; If all this moved us to a different line,
6310 ;; retry everything within that new line.
6312 ;; Repeat the intangibility and field processing.
6316 "Try to find column COL, considering invisibility.
6317 This function works only in certain cases,
6318 because what we really need is for `move-to-column'
6319 and `current-column' to be able to ignore invisible text."
6328 ;; If the following character is currently invisible,
6329 ;; skip all characters with that same `invisible' property value.
6333 ;; Have we advanced to a larger column position?
6335 ;; We have made some progress towards the desired column.
6336 ;; See if we can make any further progress.
6338 ;; Otherwise, go to the place we originally found
6339 ;; and move back over invisible text.
6340 ;; that will get us to the same place on the screen
6341 ;; but with a more reasonable buffer position.
6344 ;; We want the real line beginning, so it's consistent
6345 ;; with bolp below, otherwise we might infloop.
6352 "Move point to end of current line as displayed.
6353 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6354 If point reaches the beginning or end of buffer, it stops there.
6356 To ignore the effects of the `intangible' text or overlay
6357 property, bind `inhibit-point-motion-hooks' to t.
6358 If there is an image in the current line, this function
6359 disregards newlines that are part of the text on which the image
6360 rests."
6370 ;; With bidi reordering, we may not be at bol,
6371 ;; so make sure we are.
6386 ;; If we skipped something intangible and now we're not
6387 ;; really at eol, keep going.
6392 "Move point to beginning of current line as displayed.
6393 \(If there's an image in the line, this disregards newlines
6394 which are part of the text that the image rests on.)
6396 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6397 If point reaches the beginning or end of buffer, it stops there.
6398 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6403 first-vis first-vis-field-value)
6405 ;; Move by lines, if ARG is not 1 (the default).
6410 ;; Move to beginning-of-line, ignoring fields and invisible text.
6416 ;; Now find first visible char in the line.
6421 ;; See if fields would stop us from reaching FIRST-VIS.
6426 ;; If yes, obey them.
6427 first-vis-field-value
6428 ;; Otherwise, move to START with attention to fields.
6429 ;; (It is possible that fields never matter in this case.)
6434 ;; Many people have said they rarely use this feature, and often type
6435 ;; it by accident. Maybe it shouldn't even be on a key.
6440 Those commands will move to this position in the line moved to
6441 rather than trying to keep the same horizontal position.
6442 With a non-nil argument ARG, clears out the goal column
6444 The goal column is stored in the variable `goal-column'.
6445 This is a buffer-local setting."
6452 ;; The older method below can be erroneous if `set-goal-column' is bound
6453 ;; to a sequence containing %
6454 ;;(message (substitute-command-keys
6455 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6456 ;;goal-column)
6463 )
6464 nil)
6465 \f
6466 ;;; Editing based on visual lines, as opposed to logical lines.
6469 "Move point to end of current visual line.
6470 With argument N not nil or 1, move forward N - 1 visual lines first.
6471 If point reaches the beginning or end of buffer, it stops there.
6472 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6478 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6479 ;; constrain to field boundaries, so we don't either.
6483 "Move point to beginning of current visual line.
6484 With argument N not nil or 1, move forward N - 1 visual lines first.
6485 If point reaches the beginning or end of buffer, it stops there.
6486 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6494 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6498 "Kill the rest of the visual line.
6499 With prefix argument ARG, kill that many visual lines from point.
6500 If ARG is negative, kill visual lines backward.
6501 If ARG is zero, kill the text before point on the current visual
6502 line.
6504 If you want to append the killed line to the last killed text,
6507 If the buffer is read-only, Emacs will beep and refrain from deleting
6508 the line, but put the line in the kill ring anyway. This means that
6509 you can use this command to copy text from a read-only buffer.
6510 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6511 even beep.)"
6513 ;; Like in `kill-line', it's better to move point to the other end
6514 ;; of the kill before killing.
6522 ;; Skip any trailing whitespace at the end of the visual line.
6523 ;; We used to do this only if `show-trailing-whitespace' is
6524 ;; nil, but that's wrong; the correct thing would be to check
6525 ;; whether the trailing whitespace is highlighted. But, it's
6526 ;; OK to just do this unconditionally.
6533 "Move cursor vertically down ARG lines.
6534 This is identical to `next-line', except that it always moves
6535 by logical lines instead of visual lines, ignoring the value of
6536 the variable `line-move-visual'."
6543 "Move cursor vertically up ARG lines.
6544 This is identical to `previous-line', except that it always moves
6545 by logical lines instead of visual lines, ignoring the value of
6546 the variable `line-move-visual'."
6553 "Editing based on visual lines."
6562 ;; These keybindings interfere with xterm function keys. Are
6563 ;; there any other suitable bindings?
6564 ;; (define-key map "\M-[" 'previous-logical-line)
6565 ;; (define-key map "\M-]" 'next-logical-line)
6566 map))
6569 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6570 The value should be a list of the form (LEFT RIGHT), where LEFT
6571 and RIGHT are symbols representing the bitmaps to display, to
6572 indicate wrapped lines, in the left and right fringes respectively.
6573 See also `fringe-indicator-alist'.
6574 The default is not to display fringe indicators for wrapped lines.
6575 This variable does not affect fringe indicators displayed for
6576 other purposes."
6591 'continuation
6598 "Toggle visual line based editing (Visual Line mode).
6599 With a prefix argument ARG, enable Visual Line mode if ARG is
6600 positive, and disable it otherwise. If called from Lisp, enable
6601 the mode if ARG is omitted or nil.
6603 When Visual Line mode is enabled, `word-wrap' is turned on in
6604 this buffer, and simple editing commands are redefined to act on
6605 visual lines, not logical lines. See Info node `Visual Line
6606 Mode' for details."
6607 :keymap visual-line-mode-map
6613 ;; Save the local values of some variables, to be restored if
6614 ;; visual-line-mode is turned off.
6616 truncate-partial-width-windows
6617 word-wrap fringe-indicator-alist))
6620 visual-line--saved-state)))
6624 word-wrap t
6625 fringe-indicator-alist
6627 fringe-indicator-alist)))
6641 visual-line-mode turn-on-visual-line-mode)
6643 \f
6645 "Interchange characters around point, moving forward one character.
6646 With prefix arg ARG, effect is to take character before point
6647 and drag it forward past ARG other characters (backward if ARG negative).
6648 If no argument and at end of line, the previous two chars are exchanged."
6656 "Interchange words around point, leaving point at end of them.
6657 With prefix arg ARG, effect is to take word before or around point
6658 and drag it forward past ARG other words (backward if ARG negative).
6659 If ARG is zero, the words around or after point and around or after mark
6660 are interchanged."
6661 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6667 Does not work on a sexp that point is in the middle of
6668 if it is a list or string."
6672 ;; Here we should try to simulate the behavior of
6673 ;; (cons (progn (forward-sexp x) (point))
6674 ;; (progn (forward-sexp (- x)) (point)))
6675 ;; Except that we don't want to rely on the second forward-sexp
6676 ;; putting us back to where we want to be, since forward-sexp-function
6677 ;; might do funny things like infix-precedence.
6682 ;; Jumping over a symbol. We might be inside it, mind you.
6687 ;; Otherwise, we're between sexps. Take a step back before jumping
6688 ;; to make sure we'll obey the same precedence no matter which direction
6689 ;; we're going.
6694 'skip-syntax-forward
6701 "Exchange current line and previous line, leaving point after both.
6702 With argument ARG, takes previous line and moves it past ARG lines.
6703 With argument 0, interchanges line point is in with line mark is in."
6709 ;; Move forward over ARG lines,
6710 ;; but create newlines if necessary.
6717 arg))
6719 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6720 ;; which seems inconsistent with the ARG /= 0 case.
6721 ;; FIXME document SPECIAL.
6723 "Subroutine to do the work of transposing objects.
6724 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6725 moves forward by units of the given object (e.g. forward-sentence,
6726 forward-paragraph). If ARG is zero, exchanges the current object
6727 with the one containing mark. If ARG is an integer, moves the
6728 current object past ARG following (if ARG is positive) or
6729 preceding (if ARG is negative) objects, leaving point after the
6730 current object."
6735 pos1 pos2)
6764 ;; This sequence of insertions attempts to preserve marker
6765 ;; positions at the start and end of the transposed objects.
6779 \f
6781 "Move backward until encountering the beginning of a word.
6782 With argument ARG, do this that many times.
6783 If ARG is omitted or nil, move point backward one word.
6785 The word boundaries are normally determined by the buffer's syntax
6786 table, but `find-word-boundary-function-table', such as set up
6787 by `subword-mode', can change that. If a Lisp program needs to
6788 move by words determined strictly by the syntax table, it should
6789 use `backward-word-strictly' instead."
6794 "Set mark ARG words away from point.
6796 move to with the same argument.
6797 Interactively, if this command is repeated
6798 or (in Transient Mark mode) if the mark is active,
6799 it marks the next ARG words after the ones already marked."
6816 nil t))))
6819 "Kill characters forward until encountering the end of a word.
6820 With argument ARG, do this that many times."
6825 "Kill characters backward until encountering the beginning of a word.
6826 With argument ARG, do this that many times."
6831 "Return the symbol or word that point is on (or a nearby one) as a string.
6832 The return value includes no text properties.
6833 If optional arg STRICT is non-nil, return nil unless point is within
6834 or adjacent to a symbol or word. In all cases the value can be nil
6835 if there is no word nearby.
6836 The function, belying its name, normally finds a symbol.
6837 If optional arg REALLY-WORD is non-nil, it finds just a word."
6846 ;; Point is neither within nor adjacent to a word.
6848 ;; Look for preceding word in same line.
6851 ;; No preceding word in same line.
6852 ;; Look for following word in same line.
6861 ;; If we found something nonempty, return it as a string.
6864 \f
6866 "String for filling to insert at front of new line, or nil for none."
6868 string)
6874 "Regexp to match lines which should not be auto-filled."
6876 regexp)
6880 "The default value for `normal-auto-fill-function'.
6881 This is the default auto-fill function, some major modes use a different one.
6882 Returns t if it really did any work."
6892 nil ;; Auto-filling not required
6896 ;; Choose a fill-prefix automatically.
6904 ;; Use auto-indentation rather than a guessed empty prefix.
6910 ;; Determine where to split the line.
6923 ;; See whether the place we found is any good.
6927 ;; There is no use breaking at end of line.
6929 ;; It is futile to split at the end of the prefix
6930 ;; since we would just insert the prefix again.
6932 ;; Don't split right after a comment starter
6933 ;; since we would just make another comment starter.
6938 limit t)
6940 ;; No good place to break => stop trying.
6942 ;; Ok, we have a useful place to break the line. Do it.
6944 ;; If point is at the fill-point, do not `save-excursion'.
6945 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6946 ;; point will end up before it rather than after it.
6954 ;; Now do justification, if required
6959 ;; If making the new line didn't reduce the hpos of
6960 ;; the end of the line, then give up now;
6961 ;; trying again will not help.
6964 ;; Justify last line.
6966 t)))
6969 "Mode-specific function which line breaks and continues a comment.
6970 This function is called during auto-filling when a comment syntax
6971 is defined.
6972 The function should take a single optional argument, which is a flag
6976 "Break line at point and indent.
6977 If a comment syntax is defined, call `comment-indent-new-line'.
6979 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6980 unless optional argument SOFT is non-nil."
6984 ;; Insert the newline before removing empty space so that markers
6985 ;; get preserved better.
6991 ;; Blindly trust a non-adaptive fill-prefix.
6997 ;; If there's an adaptive prefix, use it unless we're inside
6998 ;; a comment and the prefix is not a comment starter.
7002 ;; If we're not inside a comment, just try to indent.
7006 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7010 ;; `functions' and `hooks' are usually unsafe to set, but setting
7011 ;; auto-fill-function to nil in a file-local setting is safe and
7012 ;; can be useful to prevent auto-filling.
7016 "Toggle automatic line breaking (Auto Fill mode).
7017 With a prefix argument ARG, enable Auto Fill mode if ARG is
7018 positive, and disable it otherwise. If called from Lisp, enable
7019 the mode if ARG is omitted or nil.
7021 When Auto Fill mode is enabled, inserting a space at a column
7022 beyond `current-fill-column' automatically breaks the line at a
7023 previous space.
7025 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7026 non-nil.
7028 The value of `normal-auto-fill-function' specifies the function to use
7029 for `auto-fill-function' when turning Auto Fill mode on."
7034 ;; This holds a document string used to document auto-fill-mode.
7036 "Automatically break line at a previous space, in insertion of text."
7037 nil)
7040 "Unconditionally turn on Auto Fill mode."
7044 "Unconditionally turn off Auto Fill mode."
7050 "Set `fill-column' to specified argument.
7055 ;; We used to use current-column silently, but C-x f is too easily
7056 ;; typed as a typo for C-x C-f, so we turned it into an error and
7057 ;; now an interactive prompt.
7062 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7066 \f
7068 "Set `selective-display' to ARG; clear it if no arg.
7069 When the value of `selective-display' is a number > 0,
7070 lines whose indentation is >= that value are not displayed.
7071 The variable `selective-display' has a separate value for each buffer."
7091 "Toggle truncating of long lines for the current buffer.
7092 When truncating is off, long lines are folded.
7093 With prefix argument ARG, truncate long lines if ARG is positive,
7094 otherwise fold them. Note that in side-by-side windows, this
7095 command has no effect if `truncate-partial-width-windows' is
7096 non-nil."
7108 nil t)))
7113 "Toggle whether to use word-wrapping for continuation lines.
7114 With prefix argument ARG, wrap continuation lines at word boundaries
7115 if ARG is positive, otherwise wrap them at the right screen edge.
7116 This command toggles the value of `word-wrap'. It has no effect
7117 if long lines are truncated."
7133 "Toggle Overwrite mode.
7134 With a prefix argument ARG, enable Overwrite mode if ARG is
7135 positive, and disable it otherwise. If called from Lisp, enable
7136 the mode if ARG is omitted or nil.
7138 When Overwrite mode is enabled, printing characters typed in
7139 replace existing text on a one-for-one basis, rather than pushing
7140 it to the right. At the end of a line, such characters extend
7141 the line. Before a tab, such characters insert until the tab is
7143 overwrite mode; this is supposed to make it easier to insert
7144 characters when necessary."
7149 "Toggle Binary Overwrite mode.
7150 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7151 is positive, and disable it otherwise. If called from Lisp,
7152 enable the mode if ARG is omitted or nil.
7154 When Binary Overwrite mode is enabled, printing characters typed
7155 in replace existing text. Newlines are not treated specially, so
7156 typing at the end of a line joins the line to the next, with the
7157 typed character between them. Typing before a tab character
7158 simply replaces the tab with the character typed.
7160 ordinary typing characters do.
7162 Note that Binary Overwrite mode is not its own minor mode; it is
7163 a specialization of overwrite mode, entered by setting the
7164 `overwrite-mode' variable to `overwrite-mode-binary'."
7169 "Toggle line number display in the mode line (Line Number mode).
7170 With a prefix argument ARG, enable Line Number mode if ARG is
7171 positive, and disable it otherwise. If called from Lisp, enable
7172 the mode if ARG is omitted or nil.
7174 Line numbers do not appear for very large buffers and buffers
7175 with very long lines; see variables `line-number-display-limit'
7176 and `line-number-display-limit-width'."
7180 "Toggle column number display in the mode line (Column Number mode).
7181 With a prefix argument ARG, enable Column Number mode if ARG is
7182 positive, and disable it otherwise.
7184 If called from Lisp, enable the mode if ARG is omitted or nil."
7188 "Toggle buffer size display in the mode line (Size Indication mode).
7189 With a prefix argument ARG, enable Size Indication mode if ARG is
7190 positive, and disable it otherwise.
7192 If called from Lisp, enable the mode if ARG is omitted or nil."
7196 "Toggle auto-saving in the current buffer (Auto Save mode).
7197 With a prefix argument ARG, enable Auto Save mode if ARG is
7198 positive, and disable it otherwise.
7200 If called from Lisp, enable the mode if ARG is omitted or nil."
7202 ;; If auto-save is off because buffer has shrunk,
7203 ;; then toggling should turn it on.
7211 buffer-file-name)
7213 ;; If -1 was stored here, to temporarily turn off saving,
7214 ;; turn it back on.
7217 \f
7219 "Blinking matching of parens and expressions."
7224 "Non-nil means show matching open-paren when close-paren is inserted.
7225 If t, highlight the paren. If `jump', briefly move cursor to its
7226 position. If `jump-offscreen', move cursor there even if the
7227 position is off screen. With any other non-nil value, the
7228 off-screen position of the opening paren will be shown in the
7229 echo area."
7238 "Non-nil means show matching open-paren when it is on screen.
7239 If nil, don't show it (but the open-paren can still be shown
7240 in the echo area when it is off screen).
7242 This variable has no effect if `blink-matching-paren' is nil.
7243 \(In that case, the open-paren is never shown.)
7244 It is also ignored if `show-paren-mode' is enabled."
7249 "If non-nil, maximum distance to search backwards for matching open-paren.
7250 If nil, search stops at the beginning of the accessible portion of the buffer."
7256 "Time in seconds to delay after showing a matching paren."
7261 "If nil, `blink-matching-paren' ignores comments.
7262 More precisely, when looking for the matching parenthesis,
7263 it skips the contents of comments that end before point."
7268 "Return whether or not START...END are matching parens.
7269 END is the current point and START is the blink position.
7270 START might be nil if no matching starter was found.
7271 Returns non-nil if we find there is a mismatch."
7276 ;; For self-matched chars like " and $, we can't know when they're
7277 ;; mismatched or unmatched, so we can only do it for parens.
7282 ;; The cdr might hold a new paren-class info rather than
7283 ;; a matching-char info, in which case the two CDRs
7284 ;; should match.
7288 "Function to check parentheses mismatches.
7289 The function takes two arguments (START and END) where START is the
7290 position just before the opening token and END is the position right after.
7291 START can be nil, if it was not found.
7298 ol)
7302 "Momentarily highlight the beginning of the sexp before point."
7305 blink-matching-paren)
7315 oldpos))
7323 ;; backward-sexp skips backward over prefix chars,
7324 ;; so move back to the matching paren.
7347 ;; Matching open within window, temporarily move to or highlight
7348 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7349 ;; is non-nil.
7366 ;; Show what precedes the open in its line, if anything.
7371 ;; Show what follows the open in its line, if anything.
7378 ;; Otherwise show the previous nonblank line,
7379 ;; if there is one.
7388 ;; Replace the newline and other whitespace with `...'.
7389 "..."
7391 ;; There is nothing to show except the char itself.
7394 "Matches %s"
7398 "Function called, if non-nil, whenever a close parenthesis is inserted.
7404 blink-paren-function
7407 ;; Verify an even number of quoting characters precede the close.
7408 ;; FIXME: Also check if this parenthesis closes a comment as
7409 ;; can happen in Pascal and SML.
7420 ;; Most likely, this hook is nil, so this arg doesn't matter,
7421 ;; but I use it as a reminder that this function usually
7422 ;; likes to be run after others since it does
7423 ;; `sit-for'. That's also the reason it get a `priority' prop
7424 ;; of 100.
7426 \f
7427 ;; This executes C-g typed while Emacs is waiting for a command.
7428 ;; Quitting out of a program does not go through here;
7429 ;; that happens in the QUIT macro at the C code level.
7431 "Signal a `quit' condition.
7432 During execution of Lisp code, this character causes a quit directly.
7433 At top-level, as an editor command, this simply beeps."
7435 ;; Avoid adding the region to the window selection.
7443 ;; Force the next redisplay cycle to remove the "Def" indicator from
7444 ;; all the mode lines.
7458 This command can exit an interactive command such as `query-replace',
7459 can clear out a prefix argument or a region,
7460 can get out of the minibuffer or other recursive edit,
7461 cancel the use of the current buffer (for special-purpose buffers),
7462 or go back to just one window (by deleting all but the selected window)."
7470 nil)
7481 "Play sound stored in FILE.
7482 VOLUME and DEVICE correspond to the keywords of the sound
7483 specification for `play-sound'."
7493 \f
7495 "Your preference for a mail reading package.
7496 This is used by some keybindings which support reading mail.
7497 See also `mail-user-agent' concerning sending mail."
7507 "Your preference for a mail composition package.
7508 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7509 outgoing email message. This variable lets you specify which
7510 mail-sending package you prefer.
7512 Valid values include:
7514 `message-user-agent' -- use the Message package.
7515 See Info node `(message)'.
7516 `sendmail-user-agent' -- use the Mail package.
7517 See Info node `(emacs)Sending Mail'.
7518 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7519 See Info node `(mh-e)'.
7520 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7521 paraphernalia if Gnus is running, particularly
7522 the Gcc: header for archiving.
7524 Additional valid symbols may be available; check with the author of
7525 your package for details. The function should return non-nil if it
7526 succeeds.
7528 See also `read-mail-command' concerning reading mail."
7531 message-user-agent)
7534 sendmail-user-agent)
7537 mh-e-user-agent)
7540 gnus-user-agent)
7546 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7547 If the value of `mail-user-agent' is the default, and the user
7548 appears to have customizations applying to the old default,
7549 `compose-mail' issues a warning."
7555 "If the buffer starts with a mail header, move point to the header's end.
7556 Otherwise, moves to `point-min'.
7557 The end of the header is the start of the next line, if there is one,
7558 else the end of the last line. This function obeys RFC822."
7564 ;; Used by Rmail (e.g., rmail-forward).
7566 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7570 switch-function yank-action send-actions
7571 return-action)
7572 "Start composing a mail message to send.
7573 This uses the user's chosen mail composition package
7574 as selected with the variable `mail-user-agent'.
7575 The optional arguments TO and SUBJECT specify recipients
7576 and the initial Subject field, respectively.
7578 OTHER-HEADERS is an alist specifying additional
7579 header fields. Elements look like (HEADER . VALUE) where both
7580 HEADER and VALUE are strings.
7582 CONTINUE, if non-nil, says to continue editing a message already
7583 being composed. Interactively, CONTINUE is the prefix argument.
7585 SWITCH-FUNCTION, if non-nil, is a function to use to
7586 switch to and display the buffer used for mail composition.
7588 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7589 to insert the raw text of the message being replied to.
7590 It has the form (FUNCTION . ARGS). The user agent will apply
7591 FUNCTION to ARGS, to insert the raw text of the original message.
7592 \(The user agent will also run `mail-citation-hook', *after* the
7593 original text has been inserted in this way.)
7595 SEND-ACTIONS is a list of actions to call when the message is sent.
7596 Each action has the form (FUNCTION . ARGS).
7598 RETURN-ACTION, if non-nil, is an action for returning to the
7599 caller. It has the form (FUNCTION . ARGS). The function is
7600 called after the mail has been sent or put aside, and the mail
7601 buffer buried."
7605 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7606 ;; from sendmail-user-agent to message-user-agent. Some users may
7607 ;; encounter incompatibilities. This hack tries to detect problems
7608 ;; and warn about them.
7613 mail-yank-hooks mail-archive-file-name
7614 mail-default-reply-to mail-mailing-lists
7615 mail-self-blind))
7622 The default mail mode is now Message mode.
7623 You have the following Mail mode variable%s customized:
7625 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7632 yank-action send-actions return-action)))
7635 yank-action send-actions
7636 return-action)
7640 'switch-to-buffer-other-window yank-action send-actions
7641 return-action))
7644 yank-action send-actions
7645 return-action)
7649 'switch-to-buffer-other-frame yank-action send-actions
7650 return-action))
7652 \f
7654 "History of values entered with `set-variable'.
7656 Maximum length of the history list is determined by the value
7660 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7661 VARIABLE should be a user option variable name, a Lisp variable
7662 meant to be customized by users. You should enter VALUE in Lisp syntax,
7663 so if you want VALUE to be a string, you must surround it with doublequotes.
7664 VALUE is used literally, not evaluated.
7666 If VARIABLE has a `variable-interactive' property, that is used as if
7667 it were the arg to `interactive' (which see) to interactively read VALUE.
7669 If VARIABLE has been defined with `defcustom', then the type information
7670 in the definition is used to check that VALUE is valid.
7672 Note that this function is at heart equivalent to the basic `set' function.
7673 For a variable defined with `defcustom', it does not pay attention to
7674 any :set property that the variable might have (if you want that, use
7677 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7682 default-var)
7698 var obsolete)
7701 ;; Use VAR's `variable-interactive' property
7702 ;; as an interactive spec for prompting.
7705 arg))
7707 read-expression-map t
7708 'set-variable-value-history
7717 ;; Match with custom type.
7729 ;; Force a thorough redisplay for the case that the variable
7730 ;; has an effect on the display, like `tab-width' has.
7732 \f
7733 ;; Define the major mode for lists of completions.
7743 (define-key map [right] 'next-completion)
7745 (define-key map [backtab] 'previous-completion)
7746 (define-key map "q" 'quit-window)
7747 (define-key map "z" 'kill-this-buffer)
7748 map)
7749 "Local map for completion list buffers.")
7751 ;; Completion mode is suitable only for specially formatted data.
7752 (put 'completion-list-mode 'mode-class 'special)
7754 (defvar completion-reference-buffer nil
7755 "Record the buffer that was current when the completion list was requested.
7756 This is a local variable in the completion list buffer.
7757 Initial value is nil to avoid some compiler warnings.")
7759 (defvar completion-no-auto-exit nil
7760 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7761 This also applies to other functions such as `choose-completion'.")
7763 (defvar completion-base-position nil
7764 "Position of the base of the text corresponding to the shown completions.
7765 This variable is used in the *Completions* buffers.
7766 Its value is a list of the form (START END) where START is the place
7767 where the completion should be inserted and END (if non-nil) is the end
7768 of the text to replace. If END is nil, point is used instead.")
7770 (defvar completion-list-insert-choice-function #'completion--replace
7771 "Function to use to insert the text chosen in *Completions*.
7772 Called with three arguments (BEG END TEXT), it should replace the text
7773 between BEG and END with TEXT. Expected to be set buffer-locally
7774 in the *Completions* buffer.")
7776 (defvar completion-base-size nil
7777 "Number of chars before point not involved in completion.
7778 This is a local variable in the completion list buffer.
7779 It refers to the chars in the minibuffer if completing in the
7780 minibuffer, or in `completion-reference-buffer' otherwise.
7781 Only characters in the field at point are included.
7783 If nil, Emacs determines which part of the tail end of the
7784 buffer's text is involved in completion by comparing the text
7785 directly.")
7786 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7788 (defun delete-completion-window ()
7789 "Delete the completion list window.
7790 Go to the window from which completion was requested."
7791 (interactive)
7792 (let ((buf completion-reference-buffer))
7793 (if (one-window-p t)
7794 (if (window-dedicated-p) (delete-frame))
7795 (delete-window (selected-window))
7796 (if (get-buffer-window buf)
7797 (select-window (get-buffer-window buf))))))
7799 (defun previous-completion (n)
7800 "Move to the previous item in the completion list."
7801 (interactive "p")
7802 (next-completion (- n)))
7804 (defun next-completion (n)
7805 "Move to the next item in the completion list.
7806 With prefix argument N, move N items (negative N means move backward)."
7807 (interactive "p")
7808 (let ((beg (point-min)) (end (point-max)))
7809 (while (and (> n 0) (not (eobp)))
7810 ;; If in a completion, move to the end of it.
7811 (when (get-text-property (point) 'mouse-face)
7812 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7813 ;; Move to start of next one.
7814 (unless (get-text-property (point) 'mouse-face)
7815 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7816 (setq n (1- n)))
7817 (while (and (< n 0) (not (bobp)))
7818 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7819 ;; If in a completion, move to the start of it.
7820 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7821 (goto-char (previous-single-property-change
7822 (point) 'mouse-face nil beg)))
7823 ;; Move to end of the previous completion.
7824 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7825 (goto-char (previous-single-property-change
7826 (point) 'mouse-face nil beg)))
7827 ;; Move to the start of that one.
7828 (goto-char (previous-single-property-change
7829 (point) 'mouse-face nil beg))
7830 (setq n (1+ n))))))
7832 (defun choose-completion (&optional event)
7833 "Choose the completion at point.
7834 If EVENT, use EVENT's position to determine the starting position."
7835 (interactive (list last-nonmenu-event))
7836 ;; In case this is run via the mouse, give temporary modes such as
7837 ;; isearch a chance to turn off.
7838 (run-hooks 'mouse-leave-buffer-hook)
7839 (with-current-buffer (window-buffer (posn-window (event-start event)))
7840 (let ((buffer completion-reference-buffer)
7841 (base-size completion-base-size)
7842 (base-position completion-base-position)
7843 (insert-function completion-list-insert-choice-function)
7844 (choice
7845 (save-excursion
7846 (goto-char (posn-point (event-start event)))
7847 (let (beg end)
7848 (cond
7849 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7850 (setq end (point) beg (1+ (point))))
7851 ((and (not (bobp))
7852 (get-text-property (1- (point)) 'mouse-face))
7853 (setq end (1- (point)) beg (point)))
7854 (t (error "No completion here")))
7855 (setq beg (previous-single-property-change beg 'mouse-face))
7856 (setq end (or (next-single-property-change end 'mouse-face)
7857 (point-max)))
7858 (buffer-substring-no-properties beg end)))))
7860 (unless (buffer-live-p buffer)
7861 (error "Destination buffer is dead"))
7862 (quit-window nil (posn-window (event-start event)))
7864 (with-current-buffer buffer
7865 (choose-completion-string
7866 choice buffer
7867 (or base-position
7868 (when base-size
7869 ;; Someone's using old completion code that doesn't know
7870 ;; about base-position yet.
7871 (list (+ base-size (field-beginning))))
7872 ;; If all else fails, just guess.
7873 (list (choose-completion-guess-base-position choice)))
7874 insert-function)))))
7876 ;; Delete the longest partial match for STRING
7877 ;; that can be found before POINT.
7878 (defun choose-completion-guess-base-position (string)
7879 (save-excursion
7880 (let ((opoint (point))
7881 len)
7882 ;; Try moving back by the length of the string.
7883 (goto-char (max (- (point) (length string))
7884 (minibuffer-prompt-end)))
7885 ;; See how far back we were actually able to move. That is the
7886 ;; upper bound on how much we can match and delete.
7887 (setq len (- opoint (point)))
7888 (if completion-ignore-case
7889 (setq string (downcase string)))
7890 (while (and (> len 0)
7891 (let ((tail (buffer-substring (point) opoint)))
7892 (if completion-ignore-case
7893 (setq tail (downcase tail)))
7894 (not (string= tail (substring string 0 len)))))
7895 (setq len (1- len))
7896 (forward-char 1))
7897 (point))))
7899 (defun choose-completion-delete-max-match (string)
7900 (declare (obsolete choose-completion-guess-base-position "23.2"))
7901 (delete-region (choose-completion-guess-base-position string) (point)))
7903 (defvar choose-completion-string-functions nil
7904 "Functions that may override the normal insertion of a completion choice.
7905 These functions are called in order with three arguments:
7906 CHOICE - the string to insert in the buffer,
7907 BUFFER - the buffer in which the choice should be inserted,
7908 BASE-POSITION - where to insert the completion.
7910 If a function in the list returns non-nil, that function is supposed
7911 to have inserted the CHOICE in the BUFFER, and possibly exited
7912 the minibuffer; no further functions will be called.
7914 If all functions in the list return nil, that means to use
7915 the default method of inserting the completion in BUFFER.")
7917 (defun choose-completion-string (choice &optional
7918 buffer base-position insert-function)
7919 "Switch to BUFFER and insert the completion choice CHOICE.
7920 BASE-POSITION says where to insert the completion.
7921 INSERT-FUNCTION says how to insert the completion and falls
7922 back on `completion-list-insert-choice-function' when nil."
7924 ;; If BUFFER is the minibuffer, exit the minibuffer
7925 ;; unless it is reading a file name and CHOICE is a directory,
7926 ;; or completion-no-auto-exit is non-nil.
7928 ;; Some older code may call us passing `base-size' instead of
7929 ;; `base-position'. It's difficult to make any use of `base-size',
7930 ;; so we just ignore it.
7931 (unless (consp base-position)
7932 (message "Obsolete `base-size' passed to choose-completion-string")
7933 (setq base-position nil))
7935 (let* ((buffer (or buffer completion-reference-buffer))
7936 (mini-p (minibufferp buffer)))
7937 ;; If BUFFER is a minibuffer, barf unless it's the currently
7938 ;; active minibuffer.
7939 (if (and mini-p
7940 (not (and (active-minibuffer-window)
7941 (equal buffer
7942 (window-buffer (active-minibuffer-window))))))
7943 (error "Minibuffer is not active for completion")
7944 ;; Set buffer so buffer-local choose-completion-string-functions works.
7945 (set-buffer buffer)
7946 (unless (run-hook-with-args-until-success
7947 'choose-completion-string-functions
7948 ;; The fourth arg used to be `mini-p' but was useless
7949 ;; (since minibufferp can be used on the `buffer' arg)
7950 ;; and indeed unused. The last used to be `base-size', so we
7951 ;; keep it to try and avoid breaking old code.
7952 choice buffer base-position nil)
7953 ;; This remove-text-properties should be unnecessary since `choice'
7954 ;; comes from buffer-substring-no-properties.
7955 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7956 ;; Insert the completion into the buffer where it was requested.
7957 (funcall (or insert-function completion-list-insert-choice-function)
7958 (or (car base-position) (point))
7959 (or (cadr base-position) (point))
7960 choice)
7961 ;; Update point in the window that BUFFER is showing in.
7962 (let ((window (get-buffer-window buffer t)))
7963 (set-window-point window (point)))
7964 ;; If completing for the minibuffer, exit it with this choice.
7965 (and (not completion-no-auto-exit)
7966 (minibufferp buffer)
7967 minibuffer-completion-table
7968 ;; If this is reading a file name, and the file name chosen
7969 ;; is a directory, don't exit the minibuffer.
7970 (let* ((result (buffer-substring (field-beginning) (point)))
7971 (bounds
7972 (completion-boundaries result minibuffer-completion-table
7973 minibuffer-completion-predicate
7974 "")))
7975 (if (eq (car bounds) (length result))
7976 ;; The completion chosen leads to a new set of completions
7977 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7978 (let ((mini (active-minibuffer-window)))
7979 (select-window mini)
7980 (when minibuffer-auto-raise
7981 (raise-frame (window-frame mini))))
7982 (exit-minibuffer))))))))
7984 (define-derived-mode completion-list-mode nil "Completion List"
7985 "Major mode for buffers showing lists of possible completions.
7987 to select the completion near point.
7988 Or click to select one with the mouse.
7991 (set (make-local-variable 'completion-base-size) nil))
7993 (defun completion-list-mode-finish ()
7994 "Finish setup of the completions buffer.
7995 Called from `temp-buffer-show-hook'."
7996 (when (eq major-mode 'completion-list-mode)
7997 (setq buffer-read-only t)))
7999 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8002 ;; Variables and faces used in `completion-setup-function'.
8004 (defcustom completion-show-help t
8005 "Non-nil means show help message in *Completions* buffer."
8006 :type 'boolean
8007 :version "22.1"
8008 :group 'completion)
8010 ;; This function goes in completion-setup-hook, so that it is called
8011 ;; after the text of the completion list buffer is written.
8012 (defun completion-setup-function ()
8013 (let* ((mainbuf (current-buffer))
8014 (base-dir
8015 ;; FIXME: This is a bad hack. We try to set the default-directory
8016 ;; in the *Completions* buffer so that the relative file names
8017 ;; displayed there can be treated as valid file names, independently
8018 ;; from the completion context. But this suffers from many problems:
8019 ;; - It's not clear when the completions are file names. With some
8020 ;; completion tables (e.g. bzr revision specs), the listed
8021 ;; completions can mix file names and other things.
8022 ;; - It doesn't pay attention to possible quoting.
8023 ;; - With fancy completion styles, the code below will not always
8024 ;; find the right base directory.
8025 (if minibuffer-completing-file-name
8026 (file-name-as-directory
8027 (expand-file-name
8028 (buffer-substring (minibuffer-prompt-end)
8029 (- (point) (or completion-base-size 0))))))))
8030 (with-current-buffer standard-output
8031 (let ((base-size completion-base-size) ;Read before killing localvars.
8032 (base-position completion-base-position)
8033 (insert-fun completion-list-insert-choice-function))
8034 (completion-list-mode)
8035 (set (make-local-variable 'completion-base-size) base-size)
8036 (set (make-local-variable 'completion-base-position) base-position)
8037 (set (make-local-variable 'completion-list-insert-choice-function)
8038 insert-fun))
8039 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8040 (if base-dir (setq default-directory base-dir))
8041 ;; Maybe insert help string.
8042 (when completion-show-help
8043 (goto-char (point-min))
8044 (if (display-mouse-p)
8046 (insert (substitute-command-keys
8050 (add-hook 'completion-setup-hook 'completion-setup-function)
8052 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8053 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8055 (defun switch-to-completions ()
8056 "Select the completion list window."
8057 (interactive)
8058 (let ((window (or (get-buffer-window "*Completions*" 0)
8059 ;; Make sure we have a completions window.
8060 (progn (minibuffer-completion-help)
8061 (get-buffer-window "*Completions*" 0)))))
8062 (when window
8063 (select-window window)
8064 ;; In the new buffer, go to the first completion.
8065 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8066 (when (bobp)
8067 (next-completion 1)))))
8068 \f
8069 ;;; Support keyboard commands to turn on various modifiers.
8071 ;; These functions -- which are not commands -- each add one modifier
8072 ;; to the following event.
8074 (defun event-apply-alt-modifier (_ignore-prompt)
8077 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8078 (defun event-apply-super-modifier (_ignore-prompt)
8081 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8082 (defun event-apply-hyper-modifier (_ignore-prompt)
8085 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8086 (defun event-apply-shift-modifier (_ignore-prompt)
8089 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8090 (defun event-apply-control-modifier (_ignore-prompt)
8093 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8094 (defun event-apply-meta-modifier (_ignore-prompt)
8097 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8099 (defun event-apply-modifier (event symbol lshiftby prefix)
8100 "Apply a modifier flag to event EVENT.
8101 SYMBOL is the name of this modifier, as a symbol.
8102 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8103 PREFIX is the string that represents this modifier in an event type symbol."
8104 (if (numberp event)
8105 (cond ((eq symbol 'control)
8106 (if (and (<= (downcase event) ?z)
8107 (>= (downcase event) ?a))
8108 (- (downcase event) ?a -1)
8109 (if (and (<= (downcase event) ?Z)
8110 (>= (downcase event) ?A))
8111 (- (downcase event) ?A -1)
8112 (logior (lsh 1 lshiftby) event))))
8113 ((eq symbol 'shift)
8114 (if (and (<= (downcase event) ?z)
8115 (>= (downcase event) ?a))
8116 (upcase event)
8117 (logior (lsh 1 lshiftby) event)))
8118 (t
8119 (logior (lsh 1 lshiftby) event)))
8120 (if (memq symbol (event-modifiers event))
8121 event
8122 (let ((event-type (if (symbolp event) event (car event))))
8123 (setq event-type (intern (concat prefix (symbol-name event-type))))
8124 (if (symbolp event)
8125 event-type
8126 (cons event-type (cdr event)))))))
8128 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8129 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8130 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8131 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8132 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8133 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8134 \f
8135 ;;;; Keypad support.
8137 ;; Make the keypad keys act like ordinary typing keys. If people add
8138 ;; bindings for the function key symbols, then those bindings will
8139 ;; override these, so this shouldn't interfere with any existing
8140 ;; bindings.
8142 ;; Also tell read-char how to handle these keys.
8143 (mapc
8144 (lambda (keypad-normal)
8145 (let ((keypad (nth 0 keypad-normal))
8146 (normal (nth 1 keypad-normal)))
8147 (put keypad 'ascii-character normal)
8148 (define-key function-key-map (vector keypad) (vector normal))))
8149 ;; See also kp-keys bound in bindings.el.
8150 '((kp-space ?\s)
8153 (kp-separator ?,)
8154 (kp-equal ?=)
8155 ;; Do the same for various keys that are represented as symbols under
8156 ;; GUIs but naturally correspond to characters.
8157 (backspace 127)
8158 (delete 127)
8161 (clear ?\C-l)
8162 (return ?\C-m)
8163 (escape ?\e)
8164 ))
8165 \f
8166 ;;;;
8167 ;;;; forking a twin copy of a buffer.
8168 ;;;;
8170 (defvar clone-buffer-hook nil
8171 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8173 (defvar clone-indirect-buffer-hook nil
8174 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8176 (defun clone-process (process &optional newname)
8177 "Create a twin copy of PROCESS.
8178 If NEWNAME is nil, it defaults to PROCESS' name;
8179 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8180 If PROCESS is associated with a buffer, the new process will be associated
8181 with the current buffer instead.
8182 Returns nil if PROCESS has already terminated."
8183 (setq newname (or newname (process-name process)))
8185 (setq newname (substring newname 0 (match-beginning 0))))
8186 (when (memq (process-status process) '(run stop open))
8187 (let* ((process-connection-type (process-tty-name process))
8188 (new-process
8189 (if (memq (process-status process) '(open))
8190 (let ((args (process-contact process t)))
8191 (setq args (plist-put args :name newname))
8192 (setq args (plist-put args :buffer
8193 (if (process-buffer process)
8194 (current-buffer))))
8195 (apply 'make-network-process args))
8196 (apply 'start-process newname
8197 (if (process-buffer process) (current-buffer))
8198 (process-command process)))))
8199 (set-process-query-on-exit-flag
8200 new-process (process-query-on-exit-flag process))
8201 (set-process-inherit-coding-system-flag
8202 new-process (process-inherit-coding-system-flag process))
8203 (set-process-filter new-process (process-filter process))
8204 (set-process-sentinel new-process (process-sentinel process))
8205 (set-process-plist new-process (copy-sequence (process-plist process)))
8206 new-process)))
8208 ;; things to maybe add (currently partly covered by `funcall mode'):
8209 ;; - syntax-table
8210 ;; - overlays
8211 (defun clone-buffer (&optional newname display-flag)
8212 "Create and return a twin copy of the current buffer.
8213 Unlike an indirect buffer, the new buffer can be edited
8214 independently of the old one (if it is not read-only).
8215 NEWNAME is the name of the new buffer. It may be modified by
8216 adding or incrementing <N> at the end as necessary to create a
8217 unique buffer name. If nil, it defaults to the name of the
8218 current buffer, with the proper suffix. If DISPLAY-FLAG is
8219 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8220 clone a file-visiting buffer, or a buffer whose major mode symbol
8221 has a non-nil `no-clone' property, results in an error.
8223 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8224 current buffer with appropriate suffix. However, if a prefix
8225 argument is given, then the command prompts for NEWNAME in the
8226 minibuffer.
8228 This runs the normal hook `clone-buffer-hook' in the new buffer
8229 after it has been set up properly in other respects."
8230 (interactive
8231 (progn
8232 (if buffer-file-name
8233 (error "Cannot clone a file-visiting buffer"))
8234 (if (get major-mode 'no-clone)
8235 (error "Cannot clone a buffer in %s mode" mode-name))
8236 (list (if current-prefix-arg
8237 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8238 t)))
8239 (if buffer-file-name
8240 (error "Cannot clone a file-visiting buffer"))
8241 (if (get major-mode 'no-clone)
8242 (error "Cannot clone a buffer in %s mode" mode-name))
8243 (setq newname (or newname (buffer-name)))
8245 (setq newname (substring newname 0 (match-beginning 0))))
8246 (let ((buf (current-buffer))
8247 (ptmin (point-min))
8248 (ptmax (point-max))
8249 (pt (point))
8250 (mk (if mark-active (mark t)))
8251 (modified (buffer-modified-p))
8252 (mode major-mode)
8253 (lvars (buffer-local-variables))
8254 (process (get-buffer-process (current-buffer)))
8255 (new (generate-new-buffer (or newname (buffer-name)))))
8256 (save-restriction
8257 (widen)
8258 (with-current-buffer new
8259 (insert-buffer-substring buf)))
8260 (with-current-buffer new
8261 (narrow-to-region ptmin ptmax)
8262 (goto-char pt)
8263 (if mk (set-mark mk))
8264 (set-buffer-modified-p modified)
8266 ;; Clone the old buffer's process, if any.
8267 (when process (clone-process process))
8269 ;; Now set up the major mode.
8270 (funcall mode)
8272 ;; Set up other local variables.
8273 (mapc (lambda (v)
8274 (condition-case () ;in case var is read-only
8275 (if (symbolp v)
8276 (makunbound v)
8277 (set (make-local-variable (car v)) (cdr v)))
8278 (error nil)))
8279 lvars)
8281 ;; Run any hooks (typically set up by the major mode
8282 ;; for cloning to work properly).
8283 (run-hooks 'clone-buffer-hook))
8284 (if display-flag
8285 ;; Presumably the current buffer is shown in the selected frame, so
8286 ;; we want to display the clone elsewhere.
8287 (let ((same-window-regexps nil)
8288 (same-window-buffer-names))
8289 (pop-to-buffer new)))
8290 new))
8293 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8294 "Create an indirect buffer that is a twin copy of the current buffer.
8296 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8297 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8298 or if not called with a prefix arg, NEWNAME defaults to the current
8299 buffer's name. The name is modified by adding a `<N>' suffix to it
8300 or by incrementing the N in an existing suffix. Trying to clone a
8301 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8302 property results in an error.
8304 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8305 This is always done when called interactively.
8307 Optional third arg NORECORD non-nil means do not put this buffer at the
8308 front of the list of recently selected ones.
8310 Returns the newly created indirect buffer."
8311 (interactive
8312 (progn
8313 (if (get major-mode 'no-clone-indirect)
8314 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8315 (list (if current-prefix-arg
8316 (read-buffer "Name of indirect buffer: " (current-buffer)))
8317 t)))
8318 (if (get major-mode 'no-clone-indirect)
8319 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8320 (setq newname (or newname (buffer-name)))
8322 (setq newname (substring newname 0 (match-beginning 0))))
8323 (let* ((name (generate-new-buffer-name newname))
8324 (buffer (make-indirect-buffer (current-buffer) name t)))
8325 (with-current-buffer buffer
8326 (run-hooks 'clone-indirect-buffer-hook))
8327 (when display-flag
8328 (pop-to-buffer buffer norecord))
8329 buffer))
8332 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8333 "Like `clone-indirect-buffer' but display in another window."
8334 (interactive
8335 (progn
8336 (if (get major-mode 'no-clone-indirect)
8337 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8338 (list (if current-prefix-arg
8339 (read-buffer "Name of indirect buffer: " (current-buffer)))
8340 t)))
8341 (let ((pop-up-windows t))
8342 (clone-indirect-buffer newname display-flag norecord)))
8344 \f
8345 ;;; Handling of Backspace and Delete keys.
8347 (defcustom normal-erase-is-backspace 'maybe
8348 "Set the default behavior of the Delete and Backspace keys.
8350 If set to t, Delete key deletes forward and Backspace key deletes
8351 backward.
8353 If set to nil, both Delete and Backspace keys delete backward.
8355 If set to `maybe' (which is the default), Emacs automatically
8356 selects a behavior. On window systems, the behavior depends on
8357 the keyboard used. If the keyboard has both a Backspace key and
8358 a Delete key, and both are mapped to their usual meanings, the
8359 option's default value is set to t, so that Backspace can be used
8360 to delete backward, and Delete can be used to delete forward.
8362 If not running under a window system, customizing this option
8363 accomplishes a similar effect by mapping C-h, which is usually
8364 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8365 via `keyboard-translate'. The former functionality of C-h is
8366 available on the F1 key. You should probably not use this
8367 setting if you don't have both Backspace, Delete and F1 keys.
8369 Setting this variable with setq doesn't take effect. Programmatically,
8370 call `normal-erase-is-backspace-mode' (which see) instead."
8371 :type '(choice (const :tag "Off" nil)
8372 (const :tag "Maybe" maybe)
8373 (other :tag "On" t))
8374 :group 'editing-basics
8375 :version "21.1"
8376 :set (lambda (symbol value)
8377 ;; The fboundp is because of a problem with :set when
8378 ;; dumping Emacs. It doesn't really matter.
8379 (if (fboundp 'normal-erase-is-backspace-mode)
8380 (normal-erase-is-backspace-mode (or value 0))
8381 (set-default symbol value))))
8383 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8384 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8385 (unless frame (setq frame (selected-frame)))
8386 (with-selected-frame frame
8387 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8388 (normal-erase-is-backspace-mode
8389 (if (if (eq normal-erase-is-backspace 'maybe)
8390 (and (not noninteractive)
8391 (or (memq system-type '(ms-dos windows-nt))
8392 (memq window-system '(w32 ns))
8393 (and (memq window-system '(x))
8394 (fboundp 'x-backspace-delete-keys-p)
8395 (x-backspace-delete-keys-p))
8396 ;; If the terminal Emacs is running on has erase char
8397 ;; set to ^H, use the Backspace key for deleting
8398 ;; backward, and the Delete key for deleting forward.
8399 (and (null window-system)
8400 (eq tty-erase-char ?\^H))))
8401 normal-erase-is-backspace)
8402 1 0)))))
8404 (define-minor-mode normal-erase-is-backspace-mode
8405 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8406 With a prefix argument ARG, enable this feature if ARG is
8407 positive, and disable it otherwise. If called from Lisp, enable
8408 the mode if ARG is omitted or nil.
8410 On window systems, when this mode is on, Delete is mapped to C-d
8411 and Backspace is mapped to DEL; when this mode is off, both
8412 Delete and Backspace are mapped to DEL. (The remapping goes via
8413 `local-function-key-map', so binding Delete or Backspace in the
8414 global or local keymap will override that.)
8416 In addition, on window systems, the bindings of C-Delete, M-Delete,
8417 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8418 the global keymap in accordance with the functionality of Delete and
8419 Backspace. For example, if Delete is remapped to C-d, which deletes
8420 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8421 to DEL, which deletes backward, C-Delete is bound to
8422 `backward-kill-word'.
8424 If not running on a window system, a similar effect is accomplished by
8425 remapping C-h (normally produced by the Backspace key) and DEL via
8426 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8427 to C-d; if it's off, the keys are not remapped.
8429 When not running on a window system, and this mode is turned on, the
8430 former functionality of C-h is available on the F1 key. You should
8431 probably not turn on this mode on a text-only terminal if you don't
8432 have both Backspace, Delete and F1 keys.
8434 See also `normal-erase-is-backspace'."
8435 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8436 . (lambda (v)
8437 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8438 (if v 1 0))))
8439 (let ((enabled (eq 1 (terminal-parameter
8440 nil 'normal-erase-is-backspace))))
8442 (cond ((or (memq window-system '(x w32 ns pc))
8443 (memq system-type '(ms-dos windows-nt)))
8444 (let ((bindings
8445 `(([M-delete] [M-backspace])
8446 ([C-M-delete] [C-M-backspace])
8447 ([?\e C-delete] [?\e C-backspace]))))
8449 (if enabled
8450 (progn
8451 (define-key local-function-key-map [delete] [deletechar])
8452 (define-key local-function-key-map [kp-delete] [deletechar])
8453 (define-key local-function-key-map [backspace] [?\C-?])
8454 (dolist (b bindings)
8455 ;; Not sure if input-decode-map is really right, but
8456 ;; keyboard-translate-table (used below) only works
8457 ;; for integer events, and key-translation-table is
8458 ;; global (like the global-map, used earlier).
8459 (define-key input-decode-map (car b) nil)
8460 (define-key input-decode-map (cadr b) nil)))
8461 (define-key local-function-key-map [delete] [?\C-?])
8462 (define-key local-function-key-map [kp-delete] [?\C-?])
8463 (define-key local-function-key-map [backspace] [?\C-?])
8464 (dolist (b bindings)
8465 (define-key input-decode-map (car b) (cadr b))
8466 (define-key input-decode-map (cadr b) (car b))))))
8467 (t
8468 (if enabled
8469 (progn
8470 (keyboard-translate ?\C-h ?\C-?)
8471 (keyboard-translate ?\C-? ?\C-d))
8472 (keyboard-translate ?\C-h ?\C-h)
8473 (keyboard-translate ?\C-? ?\C-?))))
8475 (if (called-interactively-p 'interactive)
8476 (message "Delete key deletes %s"
8477 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8478 "forward" "backward")))))
8479 \f
8480 (defvar vis-mode-saved-buffer-invisibility-spec nil
8481 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8483 (define-minor-mode read-only-mode
8484 "Change whether the current buffer is read-only.
8485 With prefix argument ARG, make the buffer read-only if ARG is
8486 positive, otherwise make it writable. If buffer is read-only
8487 and `view-read-only' is non-nil, enter view mode.
8489 Do not call this from a Lisp program unless you really intend to
8491 possibly enabling or disabling View mode. Also, note that this
8492 command works by setting the variable `buffer-read-only', which
8493 does not affect read-only regions caused by text properties. To
8494 ignore read-only status in a Lisp program (whether due to text
8495 properties or buffer state), bind `inhibit-read-only' temporarily
8496 to a non-nil value."
8497 :variable buffer-read-only
8498 (cond
8499 ((and (not buffer-read-only) view-mode)
8500 (View-exit-and-edit)
8501 (make-local-variable 'view-read-only)
8502 (setq view-read-only t)) ; Must leave view mode.
8503 ((and buffer-read-only view-read-only
8504 ;; If view-mode is already active, `view-mode-enter' is a nop.
8505 (not view-mode)
8506 (not (eq (get major-mode 'mode-class) 'special)))
8507 (view-mode-enter))))
8509 (define-minor-mode visible-mode
8510 "Toggle making all invisible text temporarily visible (Visible mode).
8511 With a prefix argument ARG, enable Visible mode if ARG is
8512 positive, and disable it otherwise. If called from Lisp, enable
8513 the mode if ARG is omitted or nil.
8515 This mode works by saving the value of `buffer-invisibility-spec'
8516 and setting it to nil."
8517 :lighter " Vis"
8518 :group 'editing-basics
8519 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8520 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8521 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8522 (when visible-mode
8523 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8524 buffer-invisibility-spec)
8525 (setq buffer-invisibility-spec nil)))
8526 \f
8527 (defvar messages-buffer-mode-map
8528 (let ((map (make-sparse-keymap)))
8529 (set-keymap-parent map special-mode-map)
8530 (define-key map "g" nil) ; nothing to revert
8531 map))
8533 (define-derived-mode messages-buffer-mode special-mode "Messages"
8536 (defun messages-buffer ()
8538 If it does not exist, create and it switch it to `messages-buffer-mode'."
8539 (or (get-buffer "*Messages*")
8540 (with-current-buffer (get-buffer-create "*Messages*")
8541 (messages-buffer-mode)
8542 (current-buffer))))
8544 \f
8545 ;; Minibuffer prompt stuff.
8547 ;;(defun minibuffer-prompt-modification (start end)
8548 ;; (error "You cannot modify the prompt"))
8549 ;;
8550 ;;
8551 ;;(defun minibuffer-prompt-insertion (start end)
8552 ;; (let ((inhibit-modification-hooks t))
8553 ;; (delete-region start end)
8554 ;; ;; Discard undo information for the text insertion itself
8555 ;; ;; and for the text deletion.above.
8556 ;; (when (consp buffer-undo-list)
8557 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8558 ;; (message "You cannot modify the prompt")))
8559 ;;
8560 ;;
8561 ;;(setq minibuffer-prompt-properties
8562 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8563 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8565 \f
8566 ;;;; Problematic external packages.
8568 ;; rms says this should be done by specifying symbols that define
8569 ;; versions together with bad values. This is therefore not as
8570 ;; flexible as it could be. See the thread:
8571 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8572 (defconst bad-packages-alist
8573 ;; Not sure exactly which semantic versions have problems.
8574 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8576 "The version of `semantic' loaded does not work in Emacs 22.
8577 It can cause constant high CPU load.
8578 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8579 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8580 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8581 ;; provided the `CUA-mode' feature. Since this is no longer true,
8582 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8583 (CUA-mode t nil
8584 "CUA-mode is now part of the standard GNU Emacs distribution,
8585 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8587 You have loaded an older version of CUA-mode which does not work
8588 correctly with this version of Emacs. You should remove the old
8589 version and use the one distributed with Emacs."))
8590 "Alist of packages known to cause problems in this version of Emacs.
8591 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8592 PACKAGE is either a regular expression to match file names, or a
8593 symbol (a feature name), like for `with-eval-after-load'.
8594 SYMBOL is either the name of a string variable, or t. Upon
8595 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8596 warning using STRING as the message.")
8598 (defun bad-package-check (package)
8599 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8600 (condition-case nil
8601 (let* ((list (assoc package bad-packages-alist))
8602 (symbol (nth 1 list)))
8603 (and list
8604 (boundp symbol)
8605 (or (eq symbol t)
8606 (and (stringp (setq symbol (eval symbol)))
8607 (string-match-p (nth 2 list) symbol)))
8608 (display-warning package (nth 3 list) :warning)))
8609 (error nil)))
8611 (dolist (elem bad-packages-alist)
8612 (let ((pkg (car elem)))
8613 (with-eval-after-load pkg
8614 (bad-package-check pkg))))
8616 \f
8617 ;;; Generic dispatcher commands
8619 ;; Macro `define-alternatives' is used to create generic commands.
8620 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8621 ;; that can have different alternative implementations where choosing
8622 ;; among them is exclusively a matter of user preference.
8624 ;; (define-alternatives COMMAND) creates a new interactive command
8625 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8626 ;; Typically, the user will not need to customize this variable; packages
8627 ;; wanting to add alternative implementations should use
8628 ;;
8629 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8631 (defmacro define-alternatives (command &rest customizations)
8632 "Define the new command `COMMAND'.
8634 The argument `COMMAND' should be a symbol.
8636 Running `M-x COMMAND RET' for the first time prompts for which
8637 alternative to use and records the selected command as a custom
8638 variable.
8640 Running `C-u M-x COMMAND RET' prompts again for an alternative
8641 and overwrites the previous choice.
8643 The variable `COMMAND-alternatives' contains an alist with
8644 alternative implementations of COMMAND. `define-alternatives'
8645 does not have any effect until this variable is set.
8647 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8648 `defcustom' keywords and values to add to the declaration of
8649 `COMMAND-alternatives' (typically :group and :version)."
8650 (let* ((command-name (symbol-name command))
8651 (varalt-name (concat command-name "-alternatives"))
8652 (varalt-sym (intern varalt-name))
8653 (varimp-sym (intern (concat command-name "--implementation"))))
8654 `(progn
8656 (defcustom ,varalt-sym nil
8657 ,(format "Alist of alternative implementations for the `%s' command.
8659 Each entry must be a pair (ALTNAME . ALTFUN), where:
8660 ALTNAME - The name shown at user to describe the alternative implementation.
8661 ALTFUN - The function called to implement this alternative."
8662 command-name)
8663 :type '(alist :key-type string :value-type function)
8664 ,@customizations)
8666 (put ',varalt-sym 'definition-name ',command)
8667 (defvar ,varimp-sym nil "Internal use only.")
8669 (defun ,command (&optional arg)
8670 ,(format "Run generic command `%s'.
8671 If used for the first time, or with interactive ARG, ask the user which
8672 implementation to use for `%s'. The variable `%s'
8673 contains the list of implementations currently supported for this command."
8674 command-name command-name varalt-name)
8675 (interactive "P")
8676 (when (or arg (null ,varimp-sym))
8677 (let ((val (completing-read
8678 ,(format-message
8679 "Select implementation for command `%s': "
8680 command-name)
8681 ,varalt-sym nil t)))
8682 (unless (string-equal val "")
8683 (when (null ,varimp-sym)
8684 (message
8685 "Use C-u M-x %s RET`to select another implementation"
8686 ,command-name)
8687 (sit-for 3))
8688 (customize-save-variable ',varimp-sym
8689 (cdr (assoc-string val ,varalt-sym))))))
8690 (if ,varimp-sym
8691 (call-interactively ,varimp-sym)
8692 (message "%s" ,(format-message
8693 "No implementation selected for command `%s'"
8694 command-name)))))))
8696 \f
8697 ;;; Functions for changing capitalization that Do What I Mean
8698 (defun upcase-dwim (arg)
8699 "Upcase words in the region, if active; if not, upcase word at point.
8700 If the region is active, this function calls `upcase-region'.
8701 Otherwise, it calls `upcase-word', with prefix argument passed to it
8702 to upcase ARG words."
8703 (interactive "*p")
8704 (if (use-region-p)
8705 (upcase-region (region-beginning) (region-end))
8706 (upcase-word arg)))
8708 (defun downcase-dwim (arg)
8709 "Downcase words in the region, if active; if not, downcase word at point.
8710 If the region is active, this function calls `downcase-region'.
8711 Otherwise, it calls `downcase-word', with prefix argument passed to it
8712 to downcase ARG words."
8713 (interactive "*p")
8714 (if (use-region-p)
8715 (downcase-region (region-beginning) (region-end))
8716 (downcase-word arg)))
8718 (defun capitalize-dwim (arg)
8719 "Capitalize words in the region, if active; if not, capitalize word at point.
8720 If the region is active, this function calls `capitalize-region'.
8721 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8722 to capitalize ARG words."
8723 (interactive "*p")
8724 (if (use-region-p)
8725 (capitalize-region (region-beginning) (region-end))
8726 (capitalize-word arg)))
8728 \f
8730 (provide 'simple)
8732 ;;; simple.el ends here