| blob | 971f60067324800c71215e3d36e985ad847a7ba7 |
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 "Test if BUFFER is a `next-error' capable buffer.
150 If AVOID-CURRENT is non-nil, treat the current buffer
151 as an absolute last resort only.
153 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
154 that normally would not qualify. If it returns t, the buffer
155 in question is treated as usable.
157 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
158 that would normally be considered usable. If it returns nil,
159 that buffer is rejected."
164 ;; Optionally reject some buffers.
167 t)
168 ;; Optionally accept some other buffers.
173 extra-test-inclusive
174 extra-test-exclusive)
175 "Return a `next-error' capable buffer.
177 If AVOID-CURRENT is non-nil, treat the current buffer
178 as an absolute last resort only.
180 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
181 that normally would not qualify. If it returns t, the buffer
182 in question is treated as usable.
184 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
185 that would normally be considered usable. If it returns nil,
186 that buffer is rejected."
188 ;; 1. If one window on the selected frame displays such buffer, return it.
194 avoid-current
195 extra-test-inclusive extra-test-exclusive)
200 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
203 extra-test-inclusive extra-test-exclusive))
204 next-error-last-buffer)
205 ;; 3. If the current buffer is acceptable, choose it.
207 extra-test-inclusive extra-test-exclusive)
209 ;; 4. Look for any acceptable buffer.
214 extra-test-inclusive extra-test-exclusive)))
217 ;; 5. Use the current buffer as a last resort if it qualifies,
218 ;; even despite AVOID-CURRENT.
221 extra-test-inclusive extra-test-exclusive)
225 ;; 6. Give up.
229 "Visit next `next-error' message and corresponding source code.
231 If all the error messages parsed so far have been processed already,
232 the message buffer is checked for new ones.
234 A prefix ARG specifies how many error messages to move;
235 negative means move back to previous error messages.
237 and start at the first error.
239 The RESET argument specifies that we should restart from the beginning.
242 compilation, grep, or occur buffer. It can also operate on any
244 more generally, on any buffer in Compilation mode or with
245 Compilation Minor mode enabled, or any buffer in which
246 `next-error-function' is bound to an appropriate function.
247 To specify use of a particular buffer for error messages, type
249 in the current frame.
252 runs `next-error-hook' with `run-hooks', and stays with that buffer
253 until you use it in some other buffer which uses Compilation mode
254 or Compilation Minor mode.
256 To control which errors are matched, customize the variable
257 `compilation-error-regexp-alist'."
261 ;; we know here that next-error-function is a valid symbol we can funcall
269 "Visit the source code corresponding to the `next-error' message at point."
271 ;; we know here that next-error-function is a valid symbol we can funcall
282 "Visit previous `next-error' message and corresponding source code.
284 Prefix arg N says how many error messages to move backwards (or
285 forwards, if negative).
292 "Restart at the first error.
293 Visit corresponding source code.
294 With prefix arg N, visit the source code of the Nth error.
300 "Move point to the next error in the `next-error' buffer and highlight match.
301 Prefix arg N says how many error messages to move forwards (or
302 backwards, if negative).
304 select the source buffer."
311 "Move point to the previous error in the `next-error' buffer and highlight match.
312 Prefix arg N says how many error messages to move backwards (or
313 forwards, if negative).
315 select the source buffer."
319 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
323 "Minor mode for compilation, occur and diff modes.
324 With a prefix argument ARG, enable mode if ARG is positive, and
325 disable it otherwise. If called from Lisp, enable mode if ARG is
326 omitted or nil.
327 When turned on, cursor motion in the compilation, grep, occur or diff
328 buffer causes automatic display of the corresponding source code location."
335 ;; Used as a `post-command-hook' by `next-error-follow-mode'
336 ;; for the *Compilation* *grep* and *Occur* buffers.
346 \f
347 ;;;
350 "Major mode not specialized for anything in particular.
351 Other major modes are defined by comparison with this one."
356 ;; Special major modes to view specially formatted data rather than files.
370 map))
374 "Parent major mode from which special major modes should inherit."
377 ;; Making and deleting lines.
380 "Special hook to tell if `self-insert-command' will use the region.
381 It must be called via `run-hook-with-args-until-success' with no arguments.
382 Any `post-self-insert-command' which consumes the region should
383 register a function on this hook so that things like `delete-selection-mode'
390 "Insert a newline, and move to left margin of the new line if it's blank.
391 If option `use-hard-newlines' is non-nil, the newline is marked with the
392 text-property `hard'.
393 With ARG, insert that many newlines.
395 If `electric-indent-mode' is enabled, this indents the final new line
396 that it adds, and reindents the preceding line. To just insert
399 Calls `auto-fill-function' if the current column number is greater
400 than the value of `fill-column' and ARG is nil.
401 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
404 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
405 ;; Set last-command-event to tell self-insert what to insert.
409 ;; Don't auto-fill if we have a numeric argument.
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."
1079 \f
1081 ;; Counting lines, one way or another.
1084 "Go to LINE, counting from line 1 at beginning of buffer.
1085 If called interactively, a numeric prefix argument specifies
1086 LINE; without a numeric prefix argument, read LINE from the
1087 minibuffer.
1089 If optional argument BUFFER is non-nil, switch to that buffer and
1091 as argument, BUFFER is the most recently selected other buffer.
1093 Prior to moving point, this function sets the mark (without
1094 activating it), unless Transient Mark mode is enabled and the
1095 mark is already active.
1097 This function is usually the wrong thing to use in a Lisp program.
1098 What you probably want instead is something like:
1099 (goto-char (point-min))
1100 (forward-line (1- N))
1101 If at all possible, an even better solution is to use char counts
1102 rather than line counts."
1107 ;; Look for a default, a number in the buffer at point.
1117 ;; Decide if we're switching buffers.
1125 ;; Read the argument, offering that number (if any) as default.
1128 buffer))))
1129 ;; Switch to the desired buffer, one way or another.
1134 ;; Leave mark at previous position
1136 ;; Move to the specified line number in that buffer.
1145 "Count the number of words in the region.
1146 If called interactively, print a message reporting the number of
1147 lines, words, and characters in the region (whether or not the
1148 region is active); with prefix ARG, report for the entire buffer
1149 rather than the region.
1151 If called from Lisp, return the number of words between positions
1152 START and END."
1164 "Count words between START and END.
1165 If called interactively, START and END are normally the start and
1166 end of the buffer; but if the region is active, START and END are
1167 the start and end of the region. Print a message reporting the
1168 number of lines, words, and chars.
1170 If called from Lisp, return the number of words between START and
1171 END, without printing any message."
1181 words))
1197 str
1205 "Print the current buffer line number and narrowed line number of point."
1218 "Return number of lines between START and END.
1219 This is usually the number of newlines between them,
1220 but can be one more if START is not equal to END
1221 and the greater of them is not at the start of a line."
1237 done)))
1241 "Return (narrowed) buffer line number at position POS.
1242 If POS is nil, use current buffer location.
1243 Counting starts at (point-min), so the value refers
1244 to the contents of the accessible portion of the buffer."
1254 "Print info on cursor position (on screen and within buffer).
1255 Also describe the character after point, and give its character code
1256 in octal, decimal and hex.
1258 For a non-ASCII multibyte character, also give its encoding in the
1259 buffer's selected coding system if the coding system encodes the
1260 character safely. If the character is encoded into one byte, that
1261 code is shown in hex. If the character is encoded into more than one
1264 In addition, with prefix argument, show details about that character
1265 in *Help* buffer. See also the command `describe-char'."
1269 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1270 ;; start a directional embedding, which could completely
1271 ;; disrupt the rest of the line (e.g., RLO will display the
1272 ;; rest of the line right-to-left). So we put an invisible
1273 ;; PDF character after these characters, to end the
1274 ;; embedding, which eliminates any effects on the rest of
1275 ;; the line. For RLE and RLO we also append an invisible
1276 ;; LRM, to avoid reordering the following numerical
1277 ;; characters. For LRI/RLI/FSI we append a PDI.
1284 ;; Strong right-to-left characters cause reordering of
1285 ;; the following numerical characters which show the
1286 ;; codepoint, so append LRM to countermand that.
1297 ""
1303 pos total percent beg end col hscroll)
1305 pos total col hscroll))
1307 encoded encoding-msg display-prop under-display)
1314 ;; Check if the character is displayed with some `display'
1315 ;; text property. In that case, set under-display to the
1316 ;; buffer substring covered by that property.
1327 under-display)))
1333 char char char under-display)
1335 char char char under-display display-prop))
1338 char char char
1340 "..."
1344 ;; We show the detailed information about CHAR.
1351 bidi-fixer
1352 encoding-msg pos total percent beg end col hscroll)
1359 bidi-fixer encoding-msg pos total percent col hscroll))))))
1360 \f
1361 ;; Initialize read-expression-map. It is defined at C level.
1365 ;; Might as well bind TAB to completion, since inserting a TAB char is
1366 ;; much too rarely useful.
1369 m))
1372 "Return a Lisp object read using the minibuffer, unevaluated.
1373 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1374 is a string to insert in the minibuffer before reading.
1375 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1376 Such arguments are used as in `read-from-minibuffer'.)"
1377 ;; Used for interactive spec `x'.
1382 "Return value of Lisp expression read using the minibuffer.
1383 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1384 is a string to insert in the minibuffer before reading.
1385 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1386 Such arguments are used as in `read-from-minibuffer'.)"
1387 ;; Used for interactive spec `X'.
1395 "The current default value or list of default values in the minibuffer.
1396 The functions `read-from-minibuffer' and `completing-read' bind
1400 "Value for `print-level' while printing value in `eval-expression'.
1401 A value of nil means no limit."
1407 "Value for `print-length' while printing value in `eval-expression'.
1408 A value of nil means no limit."
1414 "If non-nil set `debug-on-error' to t in `eval-expression'.
1415 If nil, don't change the value of `debug-on-error'."
1421 "Format VALUE as a result of evaluated expression.
1422 Return a formatted string which is displayed in the echo area
1423 in addition to the value printed by prin1 in functions which
1424 display the result of expression evaluation."
1443 ;; FIXME: call emacs-lisp-mode?
1450 read-expression-map t
1453 ;; We define this, rather than making `eval' interactive,
1454 ;; for the sake of completion of names like eval-region, eval-buffer.
1456 "Evaluate EXP and print value in the echo area.
1457 When called interactively, read an Emacs Lisp expression and evaluate it.
1458 Value is also consed on to front of the variable `values'.
1459 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1460 argument) means insert the result into the current buffer instead of
1461 printing it in the echo area.
1463 Normally, this function truncates long output according to the value
1464 of the variables `eval-expression-print-length' and
1465 `eval-expression-print-level'. With a prefix argument of zero,
1466 however, there is no such truncation. Such a prefix argument
1467 also causes integers to be printed in several additional formats
1468 \(octal, hexadecimal, and character).
1470 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1471 minibuffer.
1473 If `eval-expression-debug-on-error' is non-nil, which is the default,
1474 this command arranges for all errors to enter the debugger."
1477 current-prefix-arg))
1482 ;; Bind debug-on-error to something unique so that we can
1483 ;; detect when evalled code changes it.
1487 ;; If evalled code has changed the value of debug-on-error,
1488 ;; propagate that change to the global binding.
1493 eval-expression-print-length))
1495 eval-expression-print-level))
1511 "Prompting with PROMPT, let user edit COMMAND and eval result.
1512 COMMAND is a Lisp expression. Let user edit that expression in
1513 the minibuffer, then read and evaluate the result."
1520 read-expression-map t
1522 ;; If command was added to command-history as a string,
1523 ;; get rid of that. We want only evaluable expressions there.
1527 ;; If command to be redone does not match front of history,
1528 ;; add it to the history.
1534 "Edit and re-evaluate last complex command, or ARGth from last.
1535 A complex command is one which used the minibuffer.
1536 The command is placed in the minibuffer as a Lisp form for editing.
1537 The result is executed, repeating the command as changed.
1538 If the command has been changed or is not the most recent previous
1539 command it is added to the front of the command history.
1540 You can use the minibuffer history commands \
1542 to get different commands to edit and resubmit."
1545 newcmd)
1557 ;; If command was added to command-history as a
1558 ;; string, get rid of that. We want only
1559 ;; evaluable expressions there.
1563 ;; If command to be redone does not match front of history,
1564 ;; add it to the history.
1579 "Read command name to invoke in `execute-extended-command'."
1589 ;; Get a command name at point in the original buffer
1590 ;; to propose it after M-n.
1594 ;; Read a string, completing from and restricting to the set of
1595 ;; all defined commands. Don't provide any initial input.
1596 ;; Save the command read on the extended-command history list.
1607 ;; This isn't strictly correct if `execute-extended-command'
1608 ;; is bound to anything else (e.g. [menu]).
1609 ;; It could use (key-description (this-single-command-keys)),
1610 ;; but actually a prompt other than "M-x" would be confusing,
1611 ;; because "M-x" is a well-known prompt to read a command
1612 ;; and it serves as a shorthand for "Extended command: ".
1617 ;; Exclude obsolete commands from completions.
1622 pred)))
1627 "Non-nil means show the equivalent key-binding when M-x command has one.
1628 The value can be a length of time to show the message for.
1629 If the value is non-nil and not a number, we wait 2 seconds."
1651 binding)
1657 name len)))
1658 ;; Don't show the help message if the binding isn't
1659 ;; significantly shorter than the M-x command the user typed.
1666 binding))
1669 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1670 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1671 "Read a command name, then read the arguments and call the command.
1672 To pass a prefix argument to the command you are
1673 invoking, give a prefix argument to `execute-extended-command'."
1675 ;; FIXME: Remember the actual text typed by the user before completion,
1676 ;; so that we don't later on suggest the same shortening.
1681 execute-extended-command--last-typed)))
1682 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1695 ;; Normally `real-this-command' should never be changed, but here we really
1696 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1697 ;; binding" for <cmd>, so the command the user really wanted to run is
1698 ;; `function' and not `execute-extended-command'. The difference is
1699 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1703 ;; If enabled, show which key runs this command.
1704 ;; But first wait, and skip the message if there is input.
1706 ;; If this command displayed something in the echo area;
1707 ;; wait a few seconds, then display our suggestion message.
1708 ;; FIXME: Wait *after* running post-command-hook!
1709 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1710 ;; find a better answer anyway!
1719 ;; There's no binding for CMD. Let's try and find the shortest
1720 ;; string to use in M-x.
1721 ;; FIXME: Can be slow. Cache it maybe?
1728 function
1733 suggest-key-bindings
1737 ;; BEWARE: Called directly from the C code.
1738 "Execute CMD as an editor command.
1739 CMD must be a symbol that satisfies the `commandp' predicate.
1740 Optional second arg RECORD-FLAG non-nil
1741 means unconditionally put this command in the variable `command-history'.
1742 Otherwise, that is done only if an arg is read using the minibuffer.
1743 The argument KEYS specifies the value to use instead of (this-command-keys)
1744 when reading the arguments; if it is nil, (this-command-keys) is used.
1745 The argument SPECIAL, if non-nil, means that this command is executing
1746 a special event, so ignore the prefix argument and don't clear it."
1749 ;; FIXME: This should probably be done around
1750 ;; pre-command-hook rather than here!
1758 disabled-command-function)
1759 ;; FIXME: Weird calling convention!
1769 ;; If requested, place the macro in the command history. For
1770 ;; other sorts of commands, call-interactively takes care of this.
1773 ;; Don't keep command history around forever.
1779 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1787 \f
1789 "Default minibuffer history list.
1790 This is used for all minibuffer input
1791 except when an alternate history list is specified.
1793 Maximum length of the history list is determined by the value
1796 "Control whether history list elements are expressions or strings.
1797 If the value of this variable equals current minibuffer depth,
1798 they are expressions; otherwise they are strings.
1799 \(That convention is designed to do the right thing for
1806 "Text that was in this minibuffer before any history commands.
1807 This is nil if there have not yet been any history commands
1816 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1821 "Minibuffer history variables for which matching should ignore case.
1822 If a history variable is a member of this list, then the
1824 commands ignore case when searching it, regardless of `case-fold-search'."
1829 "Find the previous history element that matches REGEXP.
1830 \(Previous history elements refer to earlier actions.)
1831 With prefix argument N, search for Nth previous match.
1832 If N is negative, find the next or Nth next match.
1833 Normally, history elements are matched case-insensitively if
1834 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1835 makes the search case-sensitive.
1836 See also `minibuffer-history-case-insensitive-variables'."
1840 nil
1841 minibuffer-local-map
1842 nil
1843 'minibuffer-history-search-history
1845 ;; Use the last regexp specified, by default, if input is empty.
1850 regexp)
1860 ;; On some systems, ignore case for file names.
1862 minibuffer-history-case-insensitive-variables)
1863 t
1864 ;; Respect the user's setting for case-fold-search:
1865 case-fold-search)
1866 nil))
1867 prevpos
1868 match-string
1869 match-offset
1876 "No later matching history item"
1897 next-matching-history-element))
1901 "Find the next history element that matches REGEXP.
1902 \(The next history element refers to a more recent action.)
1903 With prefix argument N, search for Nth next match.
1904 If N is negative, find the previous or Nth previous match.
1905 Normally, history elements are matched case-insensitively if
1906 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1907 makes the search case-sensitive."
1911 nil
1912 minibuffer-local-map
1913 nil
1914 'minibuffer-history-search-history
1916 ;; Use the last regexp specified, by default, if input is empty.
1921 regexp)
1928 "Function run by `goto-history-element' before consuming default values.
1929 This is useful to dynamically add more elements to the list of default values
1930 when `goto-history-element' reaches the end of this list.
1931 Before calling this function `goto-history-element' sets the variable
1932 `minibuffer-default-add-done' to t, so it will call this function only
1933 once. In special cases, when this function needs to be called more
1934 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1938 "When nil, add more elements to the end of the list of default values.
1939 The value nil causes `goto-history-element' to add more elements to
1940 the list of defaults when it reaches the end of this list. It does
1946 "Return a list of all completions without the default value.
1947 This function is used to add all elements of the completion table to
1948 the end of the list of defaults just after the default value."
1951 minibuffer-completion-table
1952 minibuffer-completion-predicate)))
1958 "Puts element of the minibuffer history in the minibuffer.
1959 The argument NABS specifies the absolute history position."
1973 elt minibuffer-returned-to-present)
1980 "End of defaults; no next item"
1987 previous-history-element))
1999 minibuffer-default)))
2011 elt))
2015 "Puts next element of the minibuffer history in the minibuffer.
2016 With argument N, it uses the Nth following element."
2022 "Puts previous element of the minibuffer history in the minibuffer.
2023 With argument N, it uses the Nth previous element."
2029 "Move cursor vertically down ARG lines, or to the next history element.
2030 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2031 next element of the minibuffer history in the minibuffer."
2035 ;; Remember the original goal column of possibly multi-line input
2036 ;; excluding the length of the prompt on the first line.
2046 ;; Restore old position since `line-move-visual' moves point to
2047 ;; the end of the line when it fails to go to the next line.
2050 ;; Reset `temporary-goal-column' because a correct value is not
2051 ;; calculated when `next-line' above fails by bumping against
2052 ;; the bottom of the minibuffer (bug#22544).
2054 ;; Restore the original goal column on the last line
2055 ;; of possibly multi-line input.
2063 "Move cursor vertically up ARG lines, or to the previous history element.
2064 When point moves over the top line of multi-line minibuffer, puts ARGth
2065 previous element of the minibuffer history in the minibuffer."
2069 ;; Remember the original goal column of possibly multi-line input
2070 ;; excluding the length of the prompt on the first line.
2080 ;; Restore old position since `line-move-visual' moves point to
2081 ;; the beginning of the line when it fails to go to the previous line.
2084 ;; Reset `temporary-goal-column' because a correct value is not
2085 ;; calculated when `previous-line' above fails by bumping against
2086 ;; the top of the minibuffer (bug#22544).
2088 ;; Restore the original goal column on the first line
2089 ;; of possibly multi-line input.
2095 ;; Put the cursor at the end of the visual line instead of the
2096 ;; logical line, so the next `previous-line-or-history-element'
2097 ;; would move to the previous history element, not to a possible upper
2098 ;; visual line from the end of logical line in `line-move-visual' mode.
2100 ;; Since `end-of-visual-line' puts the cursor at the beginning
2101 ;; of the next visual line, move it one char back to the end
2102 ;; of the first visual line (bug#22544).
2106 "Get next history element which completes the minibuffer before the point.
2107 The contents of the minibuffer after the point are deleted, and replaced
2108 by the new completion."
2114 n)
2115 ;; next-matching-history-element always puts us at (point-min).
2116 ;; Move to the position we were at before changing the buffer contents.
2117 ;; This is still sensible, because the text before point has not changed.
2121 "\
2122 Get previous history element which completes the minibuffer before the point.
2123 The contents of the minibuffer after the point are deleted, and replaced
2124 by the new completion."
2128 ;; For compatibility with the old subr of the same name.
2130 "Return the display width of the minibuffer prompt.
2131 Return 0 if current buffer is not a minibuffer."
2132 ;; Return the width of everything before the field at the end of
2133 ;; the buffer; this should be 0 for normal buffers.
2135 \f
2136 ;; isearch minibuffer history
2143 "Set up a minibuffer for using isearch to search the minibuffer history.
2144 Intended to be added to `minibuffer-setup-hook'."
2156 "Clean up the minibuffer after terminating isearch in the minibuffer."
2161 "Return the proper search function, for isearch in minibuffer history."
2164 ;; Use standard functions to search within minibuffer text
2166 found)
2167 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2168 ;; searching forward. Lazy-highlight calls this lambda with the
2169 ;; bound arg, so skip the minibuffer prompt.
2173 ;; 1. First try searching in the initial minibuffer text
2176 noerror)
2177 ;; 2. If the above search fails, start putting next/prev history
2178 ;; elements in the minibuffer successively, and search the string
2179 ;; in them. Do this only when bound is nil (i.e. not while
2180 ;; lazy-highlighting search strings in the current minibuffer text).
2192 ;; After putting the next/prev history element, search
2193 ;; the string in them again, until next-history-element
2194 ;; or previous-history-element raises an error at the
2195 ;; beginning/end of history.
2198 ;; For backward search, don't search
2199 ;; in the minibuffer prompt
2201 noerror)))
2202 ;; Return point of the new search result
2204 ;; Return nil when next(prev)-history-element fails
2208 "Display the minibuffer history search prompt.
2209 If there are no search errors, this function displays an overlay with
2210 the isearch prompt which replaces the original minibuffer prompt.
2211 Otherwise, it displays the standard isearch message returned from
2212 the function `isearch-message'."
2214 ;; Use standard function `isearch-message' when not in the minibuffer,
2215 ;; or search fails, or has an error (like incomplete regexp).
2216 ;; This function overwrites minibuffer text with isearch message,
2217 ;; so it's possible to see what is wrong in the search string.
2219 ;; Otherwise, put the overlay with the standard isearch prompt over
2220 ;; the initial minibuffer prompt.
2229 ;; And clear any previous isearch message.
2233 "Wrap the minibuffer history search when search fails.
2234 Move point to the first history element for a forward search,
2235 or to the last history element for a backward search."
2236 ;; When `minibuffer-history-isearch-search' fails on reaching the
2237 ;; beginning/end of the history, wrap the search to the first/last
2238 ;; minibuffer history element.
2246 "Save a function restoring the state of minibuffer history search.
2247 Save `minibuffer-history-position' to the additional state parameter
2248 in the search status stack."
2254 "Restore the minibuffer history search state.
2255 Go to the history element by the absolute history position HIST-POS."
2258 \f
2259 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2263 "Table mapping redo records to the corresponding undo one.
2264 A redo record for undo-in-region maps to t.
2274 "Within a run of consecutive undo commands, list remaining to be undone.
2278 "Undo some previous changes.
2279 Repeat this command to undo more changes.
2280 A numeric ARG serves as a repeat count.
2282 In Transient Mark mode when the mark is active, only undo changes within
2284 as an argument limits undo to changes within the current region."
2286 ;; Make last-command indicate for the next command that this was an undo.
2287 ;; That way, another undo will undo more.
2288 ;; If we get to the end of the undo history and get an error,
2289 ;; another undo command will find the undo history empty
2290 ;; and will get another error. To begin undoing the undos,
2291 ;; you must type some other command.
2293 ;; For an indirect buffer, look in the base buffer for the
2294 ;; auto-save data.
2298 message)
2299 ;; If we get an error in undo-start,
2300 ;; the next command should not be a "consecutive undo".
2301 ;; So set `this-command' to something other than `undo'.
2306 ;; If something (a timer or filter?) changed the buffer
2307 ;; since the previous command, don't continue the undo seq.
2311 ;; If the last undo record made was made by undo
2312 ;; it shows nothing else happened in between.
2319 ;; get rid of initial undo boundary
2321 ;; If we got this far, the next command should be a consecutive undo.
2323 ;; Check to see whether we're hitting a redo record, and if
2324 ;; so, ask the user whether she wants to skip the redo/undo pair.
2332 ;; The equiv entry might point to another redo record if we have done
2333 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2341 ;; Record the fact that the just-generated undo records come from an
2342 ;; undo operation--that is, they are redo records.
2343 ;; In the ordinary case (not within a region), map the redo
2344 ;; record to the following undos.
2345 ;; I don't know how to do that in the undo-in-region case.
2347 ;; Strip any leading undo boundaries there might be, like we do
2348 ;; above when checking.
2352 ;; Prevent identity mapping. This can happen if
2353 ;; consecutive nils are erroneously in undo list.
2355 t
2356 pending-undo-list)
2357 undo-equiv-table))
2358 ;; Don't specify a position in the undo record for the undo command.
2359 ;; Instead, undoing this should move point to where the change is.
2378 ;; Record what the current undo list says,
2379 ;; so the next command can tell if the buffer was modified in between.
2383 ;; Display a message announcing success.
2388 "Make BUFFER stop keeping undo information.
2389 No argument or nil as argument means do this for the current buffer."
2395 "Undo some previous changes.
2396 Repeat this command to undo more changes.
2397 A numeric ARG serves as a repeat count.
2398 Contrary to `undo', this will not redo a previous undo."
2403 "Non-nil while performing an undo.
2407 "Undo back N undo-boundaries beyond what was already undone recently.
2408 Call `undo-start' to get ready to undo recent changes,
2409 then call `undo-more' one or more times to undo them."
2414 ;; Note: The following, while pulling elements off
2415 ;; `pending-undo-list' will call primitive change functions which
2416 ;; will push more elements onto `buffer-undo-list'.
2422 "Undo N records from the front of the list LIST.
2423 Return what remains of the list."
2425 ;; This is a good feature, but would make undo-start
2426 ;; unable to do what is expected.
2427 ;;(when (null (car (list)))
2428 ;; ;; If the head of the list is a boundary, it is the boundary
2429 ;; ;; preceding this command. Get rid of it and don't count it.
2430 ;; (setq list (cdr list))))
2433 ;; In a writable buffer, enable undoing read-only text that is
2434 ;; so because of text properties.
2436 ;; Don't let `intangible' properties interfere with undo.
2438 ;; We use oldlist only to check for EQ. ++kfs
2444 ;; Handle an integer by setting point to that value.
2447 ;; Element (t . TIME) records previous modtime.
2448 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2449 ;; UNKNOWN_MODTIME_NSECS.
2451 ;; If this records an obsolete save
2452 ;; (not matching the actual disk file)
2453 ;; then don't mark unmodified.
2461 ;; Element (nil PROP VAL BEG . END) is property change.
2466 ;; Element (BEG . END) means range was inserted.
2468 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2469 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2472 ;; Set point first thing, so that undoing this undo
2473 ;; does not send point back to where it is now.
2476 ;; Element (apply FUN . ARGS) means call FUN to undo.
2480 ;; Long format: (apply DELTA START END FUN . ARGS).
2487 ;; Check that the function did what the entry
2488 ;; said it would do.
2498 ;; Element (STRING . POS) means STRING was deleted.
2504 ;; Check that marker adjustments which were recorded
2505 ;; with the (STRING . POS) record are still valid, ie
2506 ;; the markers haven't moved. We check their validity
2507 ;; before reinserting the string so as we don't need to
2508 ;; mind marker insertion-type.
2516 ;; Insert string and adjust point
2524 ;; Adjust the valid marker adjustments
2528 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2531 next)
2532 ;; Even though these elements are not expected in the undo
2533 ;; list, adjust them to be conservative for the 24.4
2534 ;; release. (Bug#16818)
2541 ;; Make sure an apply entry produces at least one undo entry,
2542 ;; so the test in `undo' for continuing an undo series
2543 ;; will work right.
2548 list)
2550 ;; Deep copy of a list
2552 "Make a copy of undo list LIST."
2558 elt))
2561 "Set `pending-undo-list' to the front of the undo list.
2562 The next call to `undo-more' will undo the most recently made change.
2563 If BEG and END are specified, then only undo elements
2564 that apply to text between BEG and END are used; other undo elements
2565 are ignored. If BEG and END are nil, all undo elements are used."
2571 buffer-undo-list)))
2573 ;; The positions given in elements of the undo list are the positions
2574 ;; as of the time that element was recorded to undo history. In
2575 ;; general, subsequent buffer edits render those positions invalid in
2576 ;; the current buffer, unless adjusted according to the intervening
2577 ;; undo elements.
2578 ;;
2579 ;; Undo in region is a use case that requires adjustments to undo
2580 ;; elements. It must adjust positions of elements in the region based
2581 ;; on newer elements not in the region so as they may be correctly
2582 ;; applied in the current buffer. undo-make-selective-list
2583 ;; accomplishes this with its undo-deltas list of adjustments. An
2584 ;; example undo history from oldest to newest:
2585 ;;
2586 ;; buf pos:
2587 ;; 123456789 buffer-undo-list undo-deltas
2588 ;; --------- ---------------- -----------
2589 ;; aaa (1 . 4) (1 . -3)
2590 ;; aaba (3 . 4) N/A (in region)
2591 ;; ccaaba (1 . 3) (1 . -2)
2592 ;; ccaabaddd (7 . 10) (7 . -3)
2593 ;; ccaabdd ("ad" . 6) (6 . 2)
2594 ;; ccaabaddd (6 . 8) (6 . -2)
2595 ;; | |<-- region: "caab", from 2 to 6
2596 ;;
2597 ;; When the user starts a run of undos in region,
2598 ;; undo-make-selective-list is called to create the full list of in
2599 ;; region elements. Each element is adjusted forward chronologically
2600 ;; through undo-deltas to determine if it is in the region.
2601 ;;
2602 ;; In the above example, the insertion of "b" is (3 . 4) in the
2603 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2604 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2605 ;; . 6) is assessed as in the region and placed in the selective list.
2606 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2607 ;; due to the selected element. The "b" insertion is the only element
2608 ;; fully in the region, so in this example undo-make-selective-list
2609 ;; returns (nil (5 . 6)).
2610 ;;
2611 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2612 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2613 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2614 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2615 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2616 ;;
2617 ;; More interesting is how to adjust the "ddd" insertion due to the
2618 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2619 ;; If the reinsertion was a manual retyping of "ad", then the total
2620 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2621 ;; the reinsertion was due to undo, one might expect the first "d"
2622 ;; character would again be a part of the "ddd" text, meaning its
2623 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2624 ;;
2625 ;; undo-make-selective-list assumes in this situation that "ad" was a
2626 ;; new edit, even if it was inserted because of an undo.
2627 ;; Consequently, if the user undos in region "8 to 10" of the
2628 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2629 ;; "ccaabad", as though the first "d" became detached from the
2630 ;; original "ddd" insertion. This quirk is a FIXME.
2633 "Return a list of undo elements for the region START to END.
2634 The elements come from `buffer-undo-list', but we keep only the
2635 elements inside this region, and discard those outside this
2636 region. The elements' positions are adjusted so as the returned
2637 list can be applied to the current buffer."
2639 ;; A list of position adjusted undo elements in the region.
2641 ;; A list of undo-deltas for out of region undo elements.
2642 undo-deltas
2643 undo-elt)
2651 ;; Don't put two nils together in the list
2655 ;; This is a "was unmodified" element. Keep it
2656 ;; if we have kept everything thus far.
2659 ;; Skip over marker adjustments, instead relying
2660 ;; on finding them after (TEXT . POS) elements
2662 nil)
2665 undo-deltas)))
2670 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2671 ;; kept. primitive-undo may discard them later.
2684 "Determine whether UNDO-ELT falls inside the region START ... END.
2685 If it crosses the edge, we return nil.
2687 Generally this function is not useful for determining
2688 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2689 because markers can be arbitrarily relocated. Instead, pass the
2690 marker adjustment's corresponding (TEXT . POS) element."
2695 t)
2697 nil)
2699 ;; (TEXT . POSITION)
2703 ;; (MARKER . ADJUSTMENT)
2706 ;; (nil PROPERTY VALUE BEG . END)
2711 ;; (BEGIN . END)
2716 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2717 This assumes we have already decided that UNDO-ELT
2718 is not *inside* the region START...END."
2722 ;; (nil PROPERTY VALUE BEG . END)
2727 ;; (BEGIN . END)
2732 "Return adjustment of undo element ELT by the undo DELTAS
2733 list."
2735 ;; POSITION
2738 ;; (BEG . END)
2741 ;; (TEXT . POSITION)
2745 ;; (nil PROPERTY VALUE BEG . END)
2748 ;; (apply DELTA START END FUN . ARGS)
2749 ;; FIXME
2750 ;; All others return same elt
2753 ;; (BEG . END) can adjust to the same positions, commonly when an
2754 ;; insertion was undone and they are out of region, for example:
2755 ;;
2756 ;; buf pos:
2757 ;; 123456789 buffer-undo-list undo-deltas
2758 ;; --------- ---------------- -----------
2759 ;; [...]
2760 ;; abbaa (2 . 4) (2 . -2)
2761 ;; aaa ("bb" . 2) (2 . 2)
2762 ;; [...]
2763 ;;
2764 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2765 ;; undo. Further adjustments to such an element should be the same as
2766 ;; for (TEXT . POSITION) elements. The options are:
2767 ;;
2768 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2769 ;; analogous to marker insertion-type t.
2770 ;;
2771 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2772 ;; marker insertion-type nil.
2773 ;;
2774 ;; There was no strong reason to prefer one or the other, except that
2775 ;; the first is more consistent with prior undo in region behavior.
2777 "Return cons of adjustments to BEG and END by the undo DELTAS
2778 list."
2780 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2785 "Return adjustment of POS by the undo DELTAS list, comparing
2786 with < or <= based on USE-<."
2792 ;; Don't allow pos to become less than the undo-delta
2793 ;; position. This edge case is described in the overview
2794 ;; comments.
2797 ;; Return the first affected buffer position and the delta for an undo element
2798 ;; delta is defined as the change in subsequent buffer positions if we *did*
2799 ;; the undo.
2803 ;; (TEXT . POSITION)
2806 ;; (BEGIN . END)
2812 ;;; Default undo-boundary addition
2813 ;;
2814 ;; This section adds a new undo-boundary at either after a command is
2815 ;; called or in some cases on a timer called after a change is made in
2816 ;; any buffer.
2818 "Describe the cause of the last undo-boundary.
2820 If `explicit', the last boundary was caused by an explicit call to
2821 `undo-boundary', that is one not called by the code in this
2822 section.
2824 If it is equal to `timer', then the last boundary was inserted
2825 by `undo-auto--boundary-timer'.
2827 If it is equal to `command', then the last boundary was inserted
2828 automatically after a command, that is by the code defined in
2829 this section.
2831 If it is equal to a list, then the last boundary was inserted by
2832 an amalgamating command. The car of the list is the number of
2833 times an amalgamating command has been called, and the cdr are the
2837 "Current timer which will run `undo-auto--boundary-timer' or nil.
2842 "Non-nil if `this-command' should be amalgamated.
2843 This variable is set to nil by `undo-auto--boundaries' and is set
2847 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2851 "Return the number of amalgamating last commands or nil.
2852 Amalgamating commands are, by default, either
2853 `self-insert-command' and `delete-char', but can be any command
2854 that calls `undo-auto-amalgamate'."
2858 "Add an `undo-boundary' to the current buffer if needed.
2859 REASON describes the reason that the boundary is being added; see
2860 `undo-auto--last-boundary' for more information."
2870 undo-auto--undoably-changed-buffers)
2871 cause)))))
2874 "Check recently changed buffers and add a boundary if necessary.
2875 REASON describes the reason that the boundary is being added; see
2876 `undo-last-boundary' for more information."
2884 "Timer which will run `undo--auto-boundary-timer'."
2889 "Ensure that the `undo-auto-boundary-timer' is set."
2895 "List of buffers that have changed recently.
2897 This list is maintained by `undo-auto--undoable-change' and
2898 `undo-auto--boundaries' and can be affected by changes to their
2899 default values.
2904 "Add an `undo-boundary' in appropriate buffers."
2909 'amalgamate
2913 "Amalgamate undo if necessary.
2914 This function can be called before an amalgamating command. It
2915 removes the previous `undo-boundary' if a series of such calls
2916 have been made. By default `self-insert-command' and
2917 `delete-char' are the only amalgamating commands, although this
2918 function could be called by any command wishing to have this
2919 behavior."
2924 last-amalgamating-count
2929 ;; Amalgamate all buffers that have changed.
2933 b
2935 ;; The head of `buffer-undo-list' is nil.
2936 ;; `car-safe' doesn't work because
2937 ;; `buffer-undo-list' need not be a list!
2945 "Called after every undoable buffer change."
2948 ;; End auto-boundary section
2951 "If non-nil ask about discarding undo info for the current command.
2952 Normally, Emacs discards the undo info for the current command if
2953 it exceeds `undo-outer-limit'. But if you set this option
2954 non-nil, it asks in the echo area whether to discard the info.
2955 If you answer no, there is a slight risk that Emacs might crash, so
2956 only do it if you really want to undo the command.
2958 This option is mainly intended for debugging. You have to be
2959 careful if you use it for other purposes. Garbage collection is
2960 inhibited while the question is asked, meaning that Emacs might
2961 leak memory. So you should make sure that you do not wait
2962 excessively long before answering the question."
2968 "If non-nil, an extra level of size that's ok in an undo item.
2969 We don't ask the user about truncating the undo list until the
2970 current item gets bigger than this amount.
2975 ;; When the first undo batch in an undo list is longer than
2976 ;; undo-outer-limit, this function gets called to warn the user that
2977 ;; the undo info for the current command was discarded. Garbage
2978 ;; collection is inhibited around the call, so it had better not do a
2979 ;; lot of consing.
2985 ;; Don't ask the question again unless it gets even bigger.
2986 ;; This applies, in particular, if the user quits from the question.
2987 ;; Such a quit quits out of GC, but something else will call GC
2988 ;; again momentarily. It will call this function again,
2989 ;; but we don't want to ask the question again.
2993 "Buffer `%s' undo info is %d bytes long; discard it? "
2997 t)
2998 nil))
3004 "The undo info was discarded because it exceeded \
3005 `undo-outer-limit'.
3007 This is normal if you executed a command that made a huge change
3008 to the buffer. In that case, to prevent similar problems in the
3009 future, set `undo-outer-limit' to a value that is large enough to
3010 cover the maximum size of normal changes you expect a single
3011 command to make, but not so large that it might exceed the
3012 maximum memory allotted to Emacs.
3014 If you did not execute any such command, the situation is
3015 probably due to a bug and you should report it.
3017 You can disable the popping up of this buffer by adding the entry
3018 \(undo discard-info) to the user option `warning-suppress-types',
3022 t))
3023 \f
3026 ; These are sorted according to the GNU en_US locale.
3069 )
3071 This is used by Shell mode and other parts of Emacs to recognize
3072 password prompts, including prompts in languages other than
3073 English. Different case choices should not be assumed to be
3074 included; callers should bind `case-fold-search' to t."
3080 "History list for some commands that read shell commands.
3082 Maximum length of the history list is determined by the value
3089 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3090 This buffer is used when `shell-command' or `shell-command-on-region'
3091 is run interactively. A value of nil means that output to stderr and
3098 "Return a list of all commands associated with the current file.
3099 This function is used to add all related commands retrieved by `mailcap'
3100 to the end of the list of defaults just after the default value."
3104 minibuffer-default))
3109 commands))
3120 map)
3124 "Read a shell command from the minibuffer.
3125 The arguments are the same as the ones of `read-from-minibuffer',
3126 except READ and KEYMAP are missing and HIST defaults
3127 to `shell-command-history'."
3135 minibuffer-local-shell-command-map
3136 nil
3138 args)))
3141 "What to do when the output buffer is used by another shell command.
3142 This option specifies how to resolve the conflict where a new command
3143 wants to direct its output to the buffer `*Async Shell Command*',
3144 but this buffer is already taken by another running shell command.
3146 The value `confirm-kill-process' is used to ask for confirmation before
3147 killing the already running process and running a new process
3148 in the same buffer, `confirm-new-buffer' for confirmation before running
3149 the command in a new buffer with a name other than the default buffer name,
3150 `new-buffer' for doing the same without confirmation,
3151 `confirm-rename-buffer' for confirmation before renaming the existing
3152 output buffer and running a new command in the default buffer,
3153 `rename-buffer' for doing the same without confirmation."
3155 confirm-kill-process)
3157 confirm-new-buffer)
3159 new-buffer)
3161 confirm-rename-buffer)
3163 rename-buffer))
3168 "Execute string COMMAND asynchronously in background.
3170 Like `shell-command', but adds `&' at the end of COMMAND
3171 to execute it asynchronously.
3173 The output appears in the buffer `*Async Shell Command*'.
3174 That buffer is in shell mode.
3176 You can configure `async-shell-command-buffer' to specify what to do in
3177 case when `*Async Shell Command*' buffer is already taken by another
3178 running shell command. To run COMMAND without displaying the output
3179 in a window you can configure `display-buffer-alist' to use the action
3180 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3182 In Elisp, you will often be better served by calling `start-process'
3183 directly, since it offers more control and does not impose the use of a
3184 shell (with its need to quote arguments)."
3194 current-prefix-arg
3195 shell-command-default-error-buffer))
3201 "Execute string COMMAND in inferior shell; display output, if any.
3202 With prefix argument, insert the COMMAND's output at point.
3204 Interactively, prompt for COMMAND in the minibuffer.
3206 If COMMAND ends in `&', execute it asynchronously.
3207 The output appears in the buffer `*Async Shell Command*'.
3208 That buffer is in shell mode. You can also use
3209 `async-shell-command' that automatically adds `&'.
3211 Otherwise, COMMAND is executed synchronously. The output appears in
3212 the buffer `*Shell Command Output*'. If the output is short enough to
3213 display in the echo area (which is determined by the variables
3214 `resize-mini-windows' and `max-mini-window-height'), it is shown
3215 there, but it is nonetheless available in buffer `*Shell Command
3216 Output*' even though that buffer is not automatically displayed.
3218 To specify a coding system for converting non-ASCII characters
3220 before this command.
3222 Noninteractive callers can specify coding systems by binding
3223 `coding-system-for-read' and `coding-system-for-write'.
3225 The optional second argument OUTPUT-BUFFER, if non-nil,
3226 says to put the output in some other buffer.
3227 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
3228 If OUTPUT-BUFFER is not a buffer and not nil,
3229 insert output in current buffer. (This cannot be done asynchronously.)
3230 In either case, the buffer is first erased, and the output is
3231 inserted after point (leaving mark after it).
3233 If the command terminates without error, but generates output,
3235 the output can be displayed in the echo area or in its buffer.
3236 If the output is short enough to display in the echo area
3237 \(determined by the variable `max-mini-window-height' if
3238 `resize-mini-windows' is non-nil), it is shown there.
3239 Otherwise,the buffer containing the output is displayed.
3243 of the output.
3245 If there is no output, or if output is inserted in the current buffer,
3246 then `*Shell Command Output*' is deleted.
3248 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3249 or buffer name to which to direct the command's standard error output.
3250 If it is nil, error output is mingled with regular output.
3251 In an interactive call, the variable `shell-command-default-error-buffer'
3252 specifies the value of ERROR-BUFFER.
3254 In Elisp, you will often be better served by calling `call-process' or
3255 `start-process' directly, since it offers more control and does not impose
3256 the use of a shell (with its need to quote arguments)."
3267 current-prefix-arg
3268 shell-command-default-error-buffer))
3269 ;; Look for a handler in case default-directory is a remote file name.
3277 ;; Output goes in current buffer.
3283 temporary-file-directory)))
3284 nil)))
3287 ;; We do not use -f for csh; we will not support broken use of
3288 ;; .cshrcs. Even the BSD csh manual says to use
3289 ;; "if ($?prompt) exit" before things which are not useful
3290 ;; non-interactively. Besides, if someone wants their other
3291 ;; aliases for shell commands then they can still have them.
3295 t)
3296 nil shell-command-switch command)
3303 ;; Do no formatting while reading error file,
3304 ;; because that can run a shell command, and we
3305 ;; don't want that to cause an infinite recursion.
3307 ;; Put point after the inserted errors.
3311 ;; This is like exchange-point-and-mark, but doesn't
3312 ;; activate the mark. It is cleaner to avoid activation,
3313 ;; even though the command loop would deactivate the mark
3314 ;; because we inserted text.
3318 ;; Output goes in a separate buffer.
3319 ;; Preserve the match data in case called from a program.
3322 ;; Command ending with ampersand means asynchronous.
3326 proc)
3327 ;; Remove the ampersand.
3329 ;; Ask the user what to do with already running process.
3334 ;; If will kill a process, query first.
3339 ;; If will create a new buffer, query first.
3346 ;; It will create a new buffer.
3351 ;; If will rename the buffer, query first.
3360 ;; It will rename the buffer.
3367 ;; Setting buffer-read-only to nil doesn't suffice
3368 ;; if some text has a non-nil read-only property,
3369 ;; which comint sometimes adds for prompts.
3375 shell-command-switch command))
3379 ;; Use the comint filter for proper handling of carriage motion
3380 ;; (see `comint-inhibit-carriage-motion'),.
3382 ))
3383 ;; Otherwise, command is executed synchronously.
3385 output-buffer nil error-buffer)))))))
3388 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3389 MESSAGE may be either a string or a buffer.
3391 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3392 for maximum height of the echo area, as defined by `max-mini-window-height'
3393 if `resize-mini-windows' is non-nil.
3395 Returns either the string shown in the echo area, or when a pop-up
3396 buffer is used, the window used to display it.
3398 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3399 name of the buffer used to display it in the case where a pop-up buffer
3400 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3401 string and it is displayed in the echo area, it is not specified whether
3402 the contents are inserted into the buffer anyway.
3404 Optional arguments ACTION and FRAME are as for `display-buffer',
3405 and are only used if a pop-up buffer is displayed."
3407 ;; Trivial case where we can use the echo area
3411 ;; Trivial case where we can just remove single trailing newline
3414 ;; General case
3417 message
3426 0
3430 (<= lines
3434 max-mini-window-height))
3436 max-mini-window-height)
3440 ;; Don't use the echo area if the output buffer is
3441 ;; already displayed in the selected frame.
3443 ;; Echo area
3449 ;; Buffer
3454 ;; We have a sentinel to prevent insertion of a termination message
3455 ;; in the buffer itself.
3463 &optional output-buffer replace
3464 error-buffer display-error-buffer
3465 region-noncontiguous-p)
3466 "Execute string COMMAND in inferior shell with region as input.
3467 Normally display output (if any) in temp buffer `*Shell Command Output*';
3468 Prefix arg means replace the region with it. Return the exit code of
3469 COMMAND.
3471 To specify a coding system for converting non-ASCII characters
3473 before this command. By default, the input (from the current buffer)
3474 is encoded using coding-system specified by `process-coding-system-alist',
3475 falling back to `default-process-coding-system' if no match for COMMAND
3476 is found in `process-coding-system-alist'.
3478 Noninteractive callers can specify coding systems by binding
3479 `coding-system-for-read' and `coding-system-for-write'.
3481 If the command generates output, the output may be displayed
3482 in the echo area or in a buffer.
3483 If the output is short enough to display in the echo area
3484 \(determined by the variable `max-mini-window-height' if
3485 `resize-mini-windows' is non-nil), it is shown there.
3486 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3487 The output is available in that buffer in both cases.
3489 If there is output and an error, a message about the error
3490 appears at the end of the output. If there is no output, or if
3491 output is inserted in the current buffer, the buffer `*Shell
3492 Command Output*' is deleted.
3494 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3495 command's output. If the value is a buffer or buffer name,
3496 put the output there. If the value is nil, use the buffer
3497 `*Shell Command Output*'. Any other value, excluding nil,
3498 means to insert the output in the current buffer. In either case,
3499 the output is inserted after point (leaving mark after it).
3501 Optional fifth arg REPLACE, if non-nil, means to insert the
3502 output in place of text from START to END, putting point and mark
3503 around it.
3505 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3506 or buffer name to which to direct the command's standard error
3507 output. If nil, error output is mingled with regular output.
3508 When called interactively, `shell-command-default-error-buffer'
3509 is used for ERROR-BUFFER.
3511 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3512 display the error buffer if there were any errors. When called
3513 interactively, this is t."
3517 ;; Do this before calling region-beginning
3518 ;; and region-end, in case subprocess output
3519 ;; relocates them while we are in the minibuffer.
3521 ;; call-interactively recognizes region-beginning and
3522 ;; region-end specially, leaving them in the history.
3524 string
3525 current-prefix-arg
3526 current-prefix-arg
3527 shell-command-default-error-buffer
3528 t
3535 temporary-file-directory)))
3536 nil))
3537 exit-status)
3538 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3541 output)
3545 shell-file-name t t
3546 nil shell-command-switch
3547 command)
3554 ;; Replace specified region with output from command.
3556 ;; Don't muck with mark unless REPLACE says we should.
3563 t)
3564 nil shell-command-switch command))
3565 ;; It is rude to delete a buffer which the command is not using.
3566 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3567 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3568 ;; (kill-buffer shell-buffer)))
3569 ;; Don't muck with mark unless REPLACE says we should.
3571 ;; No prefix argument: put the output in a temp buffer,
3572 ;; replacing its entire contents.
3577 ;; If the input is the same buffer as the output,
3578 ;; delete everything but the specified region,
3579 ;; then replace that region with the output.
3585 shell-file-name t
3588 t)
3589 nil shell-command-switch
3590 command)))
3591 ;; Clear the output buffer, then run the command with
3592 ;; output there.
3603 buffer)
3604 nil shell-command-switch command)))
3605 ;; Report the output.
3615 ;; There's some output, display it
3617 ;; No output; error?
3624 shell-command-default-error-buffer)
3631 output))
3634 exit-status))
3637 exit-status output))))
3638 ;; Don't kill: there might be useful info in the undo-log.
3639 ;; (kill-buffer buffer)
3640 )))))
3648 ;; Do no formatting while reading error file,
3649 ;; because that can run a shell command, and we
3650 ;; don't want that to cause an infinite recursion.
3652 ;; Put point after the inserted errors.
3657 exit-status))
3660 "Execute shell command COMMAND and return its output as a string."
3663 standard-output
3667 "Process files synchronously in a separate process.
3668 Similar to `call-process', but may invoke a file handler based on
3669 `default-directory'. The current working directory of the
3670 subprocess is `default-directory'.
3672 File names in INFILE and BUFFER are handled normally, but file
3673 names in ARGS should be relative to `default-directory', as they
3674 are passed to the process verbatim. (This is a difference to
3675 `call-process' which does not support file handlers for INFILE
3676 and BUFFER.)
3678 Some file handlers might not support all variants, for example
3679 they might behave as if DISPLAY was nil, regardless of the actual
3680 value passed."
3682 lc stderr-file)
3692 display args)
3698 "Whether a call of `process-file' changes remote files.
3700 By default, this variable is always set to t, meaning that a
3701 call of `process-file' could potentially change any file on a
3702 remote host. When set to nil, a file handler could optimize
3703 its behavior with respect to remote file attribute caching.
3705 You should only ever change this variable with a let-binding;
3709 "Start a program in a subprocess. Return the process object for it.
3711 Similar to `start-process', but may invoke a file handler based on
3712 `default-directory'. See Info node `(elisp)Magic File Names'.
3714 This handler ought to run PROGRAM, perhaps on the local host,
3715 perhaps on a remote host that corresponds to `default-directory'.
3716 In the latter case, the local part of `default-directory' becomes
3717 the working directory of the process.
3719 PROGRAM and PROGRAM-ARGS might be file names. They are not
3720 objects of file handler invocation. File handlers might not
3721 support pty association, if PROGRAM is nil."
3725 \f
3726 ;;;; Process menu
3740 map))
3743 "Major mode for listing the processes called by Emacs."
3755 "Kill process at point in a `list-processes' buffer."
3766 "Recompute the list of processes for the Process List buffer.
3767 Also, delete any process that is exited or signaled."
3780 face link
3782 "Visit buffer `%s'"
3784 follow-link t
3785 process-buffer ,buf
3786 action process-menu-visit-buffer)
3795 "datagram"
3812 tabulated-list-entries))))))
3818 "Display a list of all processes that are Emacs sub-processes.
3819 If optional argument QUERY-ONLY is non-nil, only processes with
3820 the query-on-exit flag set are listed.
3821 Any process listed as exited or signaled is actually eliminated
3822 after the listing is made.
3823 Optional argument BUFFER specifies a buffer to use, instead of
3825 The return value is always nil.
3827 This function lists only processes that were launched by Emacs. To
3828 see other processes running on the system, use `list-system-processes'."
3840 nil)
3841 \f
3842 ;;;; Prefix commands
3848 ;; BEWARE: Called directly from C code.
3849 ;; If the return value is non-nil, it means we are in the middle of
3850 ;; a command with prefix, such as a command invoked with prefix-arg.
3852 prefix-command--last-echo
3861 "Abnormal hook which constructs the description of the current prefix state.
3865 "Update state of prefix commands.
3873 "Pass the current prefix command state to the next command.
3874 Should be called by all prefix commands.
3875 Runs `prefix-command-preserve-state-hook'."
3877 ;; If the current command is a prefix command, we don't want the next (real)
3878 ;; command to have `last-command' set to, say, `universal-argument'.
3885 nil)
3887 ;;;;; The main prefix command.
3889 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
3914 ;; For backward compatibility, minus with no modifiers is an ordinary
3915 ;; command if digits have already been entered.
3945 map)
3953 "Begin a numeric argument for the following command.
3958 multiplies the argument by 4 each time.
3960 which is different in effect from any particular numeric argument.
3968 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3969 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3976 arg)))
3980 "Begin a negative numeric argument for the next command.
3990 "Part of the numeric argument for the next command.
3995 last-command-event
4002 ;; Treat -0 as just -, so that -01 will work.
4005 digit))))
4007 \f
4015 "Function to perform the filtering in `filter-buffer-substring'.
4016 The function is called with the same 3 arguments (BEG END DELETE)
4017 that `filter-buffer-substring' received. It should return the
4018 buffer substring between BEG and END, after filtering. If DELETE is
4022 "List of filter functions for `buffer-substring--filter'.
4023 Each function must accept a single argument, a string, and return a string.
4024 The buffer substring is passed to the first function in the list,
4025 and the return value of each function is passed to the next.
4026 As a special convention, point is set to the start of the buffer text
4027 being operated on (i.e., the first argument of `buffer-substring--filter')
4033 "Return the buffer substring between BEG and END, after filtering.
4034 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4036 This calls the function that `filter-buffer-substring-function' specifies
4037 \(passing the same three arguments that it received) to do the work,
4038 and returns whatever it does. The default function does no filtering,
4039 unless a hook has been set.
4041 Use `filter-buffer-substring' instead of `buffer-substring',
4042 `buffer-substring-no-properties', or `delete-and-extract-region' when
4043 you want to allow filtering to take place. For example, major or minor
4044 modes can use `filter-buffer-substring-function' to extract characters
4045 that are special to a buffer, and should not be copied into other buffers."
4049 "Default function to use for `filter-buffer-substring-function'.
4050 Its arguments and return value are as specified for `filter-buffer-substring'.
4051 This respects the wrapper hook `filter-buffer-substring-functions',
4052 and the abnormal hook `buffer-substring-filters'.
4053 No filtering is done unless a hook says to."
4063 string)))
4068 ;;;; Window system cut and paste hooks.
4071 "Function to call to make a killed region available to other programs.
4072 Most window systems provide a facility for cutting and pasting
4073 text between different programs, such as the clipboard on X and
4074 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4076 This variable holds a function that Emacs calls whenever text is
4077 put in the kill ring, to make the new kill available to other
4078 programs. The function takes one argument, TEXT, which is a
4082 "Function to call to get text cut from other programs.
4083 Most window systems provide a facility for cutting and pasting
4084 text between different programs, such as the clipboard on X and
4085 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4087 This variable holds a function that Emacs calls to obtain text
4088 that other programs have provided for pasting. The function is
4089 called with no arguments. If no other program has provided text
4090 to paste, the function should return nil (in which case the
4091 caller, usually `current-kill', should use the top of the Emacs
4092 kill ring). If another program has provided text to paste, the
4093 function should return that text as a string (in which case the
4094 caller should put this string in the kill ring as the latest
4095 kill).
4097 The function may also return a list of strings if the window
4098 system supports multiple selections. The first string will be
4099 used as the pasted text, but the other will be placed in the kill
4100 ring for easy access via `yank-pop'.
4102 Note that the function should return a string only if a program
4103 other than Emacs has provided a string for pasting; if Emacs
4104 provided the most recent string, the function should return nil.
4105 If it is difficult to tell whether Emacs or some other program
4106 provided the current string, it is probably good enough to return
4107 nil if the string is equal (according to `string=') to the last
4109 \f
4112 ;;;; The kill ring data structure.
4115 "List of killed text sequences.
4116 Since the kill ring is supposed to interact nicely with cut-and-paste
4117 facilities offered by window systems, use of this variable should
4118 interact nicely with `interprogram-cut-function' and
4119 `interprogram-paste-function'. The functions `kill-new',
4120 `kill-append', and `current-kill' are supposed to implement this
4121 interaction; you may want to use them instead of manipulating the kill
4125 "Maximum length of kill ring before oldest elements are thrown away."
4133 "Save clipboard strings into kill ring before replacing them.
4134 When one selects something in another program to paste it into Emacs,
4135 but kills something in Emacs before actually pasting it,
4136 this selection is gone unless this variable is non-nil,
4137 in which case the other program's selection is saved in the `kill-ring'
4144 "Do not add a new string to `kill-ring' if it duplicates the last one.
4145 The comparison is done using `equal-including-properties'."
4151 "Make STRING the latest kill in the kill ring.
4152 Set `kill-ring-yank-pointer' to point to it.
4153 If `interprogram-cut-function' is non-nil, apply it to STRING.
4154 Optional second argument REPLACE non-nil means that STRING will replace
4155 the front of the kill ring, rather than being added to the list.
4157 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4158 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4159 STRING.
4161 When the yank handler has a non-nil PARAM element, the original STRING
4162 argument is not used by `insert-for-yank'. However, since Lisp code
4163 may access and use elements from the kill ring directly, the STRING
4166 ;; Due to text properties such as 'yank-handler that
4167 ;; can alter the contents to yank, comparison using
4168 ;; `equal' is unsafe.
4193 ;; It has been argued that this should work similar to `self-insert-command'
4194 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4196 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4202 "Append STRING to the end of the latest kill in the kill ring.
4203 If BEFORE-P is non-nil, prepend STRING to the kill.
4204 Also removes the last undo boundary in the current buffer,
4205 depending on `kill-append-merge-undo'.
4206 If `interprogram-cut-function' is set, pass the resulting kill to it."
4214 ;; find the next undo boundary
4218 ;; remove this undo boundary
4223 "Whether rotating the kill ring changes the window system selection.
4224 If non-nil, whenever the kill ring is rotated (usually via the
4225 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4226 to copy the new kill to the window system selection."
4232 "Rotate the yanking point by N places, and then return that kill.
4233 If N is zero and `interprogram-paste-function' is set to a
4234 function that returns a string or a list of strings, and if that
4235 function doesn't return nil, then that string (or list) is added
4236 to the front of the kill ring and the string (or first string in
4237 the list) is returned as the latest kill.
4239 If N is not zero, and if `yank-pop-change-selection' is
4240 non-nil, use `interprogram-cut-function' to transfer the
4241 kill at the new yank point into the window system selection.
4243 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4244 move the yanking point; just return the Nth kill forward."
4247 interprogram-paste-function
4251 ;; Disable the interprogram cut function when we add the new
4252 ;; text to the kill ring, so Emacs doesn't try to own the
4253 ;; selection, with identical text.
4263 kill-ring)))
4268 interprogram-cut-function)
4274 ;;;; Commands for manipulating the kill ring.
4277 "Non-nil means don't signal an error for killing read-only text."
4283 This deletes the text from the buffer and saves it in the kill ring.
4287 If you want to append the killed region to the last killed text,
4291 If the previous command was also a kill command,
4292 the text killed this time appends to the text killed last time
4293 to make one entry in the kill ring.
4295 The killed text is filtered by `filter-buffer-substring' before it is
4296 saved in the kill ring, so the actual saved text might be different
4297 from what was killed.
4299 If the buffer is read-only, Emacs will beep and refrain from deleting
4300 the text, but put the text in the kill ring anyway. This means that
4301 you can use the killing commands to copy text from a read-only buffer.
4303 Lisp programs should use this function for killing text.
4304 (To delete text, use `delete-region'.)
4305 Supply two arguments, character positions BEG and END indicating the
4306 stretch of text to be killed. If the optional argument REGION is
4307 non-nil, the function ignores BEG and END, and kills the current
4308 region instead."
4309 ;; Pass mark first, then point, because the order matters when
4310 ;; calling `kill-append'.
4319 ;; Add that string to the kill ring, one way or another.
4326 nil)
4328 ;; The code above failed because the buffer, or some of the characters
4329 ;; in the region, are read-only.
4330 ;; We should beep, in case the user just isn't aware of this.
4331 ;; However, there's no harm in putting
4332 ;; the region's text in the kill ring, anyway.
4334 ;; Set this-command now, so it will be set even if we get an error.
4336 ;; This should barf, if appropriate, and give us the correct error.
4339 ;; Signal an error if the buffer is read-only.
4341 ;; If the buffer isn't read-only, the text is.
4344 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4345 ;; to get two copies of the text when the user accidentally types M-w and
4346 ;; then corrects it with the intended C-w.
4348 "Save the region as if killed, but don't kill it.
4349 In Transient Mark mode, deactivate the mark.
4350 If `interprogram-cut-function' is non-nil, also save the text for a window
4351 system cut and paste.
4353 The copied text is filtered by `filter-buffer-substring' before it is
4354 saved in the kill ring, so the actual saved text might be different
4355 from what was in the buffer.
4357 When called from Lisp, save in the kill ring the stretch of text
4358 between BEG and END, unless the optional argument REGION is
4359 non-nil, in which case ignore BEG and END, and save the current
4360 region instead.
4362 This command's old key binding has been given to `kill-ring-save'."
4363 ;; Pass mark first, then point, because the order matters when
4364 ;; calling `kill-append'.
4374 nil)
4377 "Save the region as if killed, but don't kill it.
4378 In Transient Mark mode, deactivate the mark.
4379 If `interprogram-cut-function' is non-nil, also save the text for a window
4380 system cut and paste.
4382 If you want to append the killed line to the last killed text,
4385 The copied text is filtered by `filter-buffer-substring' before it is
4386 saved in the kill ring, so the actual saved text might be different
4387 from what was in the buffer.
4389 When called from Lisp, save in the kill ring the stretch of text
4390 between BEG and END, unless the optional argument REGION is
4391 non-nil, in which case ignore BEG and END, and save the current
4392 region instead.
4394 This command is similar to `copy-region-as-kill', except that it gives
4395 visual feedback indicating the extent of the region being copied."
4396 ;; Pass mark first, then point, because the order matters when
4397 ;; calling `kill-append'.
4401 ;; This use of called-interactively-p is correct because the code it
4402 ;; controls just gives the user visual feedback.
4407 "Indicate that the region text has been copied interactively.
4408 If the mark is visible in the selected window, blink the cursor
4409 between point and mark if there is currently no active region
4410 highlighting.
4412 If the mark lies outside the selected window, display an
4413 informative message containing a sample of the copied text. The
4414 optional argument MESSAGE-LEN, if non-nil, specifies the length
4415 of this sample text; it defaults to 40."
4418 ;; Inhibit quitting so we can make a quit here
4419 ;; look like a C-g typed as a command.
4422 ;; Swap point-and-mark quickly so as to show the region that
4423 ;; was selected. Don't do it if the region is highlighted.
4426 ;; Swap point and mark.
4430 ;; Swap back.
4433 ;; If user quit, deactivate the mark
4434 ;; as C-g would as a command.
4440 ;; Don't say "killed"; that is misleading.
4447 "Cause following command, if it kills, to add to previous kill.
4448 If the next command kills forward from point, the kill is
4449 appended to the previous killed text. If the command kills
4450 backward, the kill is prepended. Kill commands that act on the
4451 region, such as `kill-region', are regarded as killing forward if
4452 point is after mark, and killing backward if point is before
4453 mark.
4455 If the next command is not a kill command, `append-next-kill' has
4456 no effect.
4458 The argument is used for internal purposes; do not supply one."
4460 ;; We don't use (interactive-p), since that breaks kbd macros.
4474 "A subroutine of `squeeze-bidi-context'.
4475 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4479 lim1)
4486 ;; L and R categories include embedding and
4487 ;; override controls, but we don't want to
4488 ;; replace them, because that might change
4489 ;; the visual order. Likewise with PDF and
4490 ;; isolate controls.
4492 bidi-directional-non-controls-chars
4493 limit)))))
4494 ;; Replace any run of non-RTL characters by a single LRM.
4496 ;; No more characters of CATEGORY, we are done.
4501 ;; Skip directional controls, if any.
4506 "Replace characters between FROM and TO while keeping bidi context.
4508 This function replaces the region of text with as few characters
4509 as possible, while preserving the effect that region will have on
4510 bidirectional display before and after the region."
4514 ;; This is for when they copy text with read-only text
4515 ;; properties.
4519 ;; Replace each run of non-RTL characters with a single LRM.
4521 ;; Replace each run of non-LTR characters with a single RLM. Note
4522 ;; that the \cR category includes both the Arabic Letter (AL) and
4523 ;; R characters; here we ignore the distinction between them,
4524 ;; because that distinction only affects Arabic Number (AN)
4525 ;; characters, which are weak and don't affect the reordering.
4529 "Return buffer text between START and END with its bidi context.
4531 START and END are assumed to belong to the same physical line
4532 of buffer text. This function prepends and appends to the text
4533 between START and END bidi control characters that preserve the
4534 visual order of that text when it is inserted at some other place."
4539 substr para-dir from to)
4546 ;; If we don't have any mixed directional characters in the
4547 ;; entire line, we can just copy the substring without adding
4548 ;; any context.
4563 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4564 ;; (1) force the string to have the same base embedding
4565 ;; direction as the paragraph direction at the source, no matter
4566 ;; what is the paragraph direction at destination; and (2) avoid
4567 ;; affecting the visual order of the surrounding text at
4568 ;; destination if there are characters of different
4569 ;; directionality there.
4574 "Return portion of current buffer between START and END with bidi context.
4576 This function works similar to `buffer-substring', but it prepends and
4577 appends to the text bidi directional control characters necessary to
4578 preserve the visual appearance of the text if it is inserted at another
4579 place. This is useful when the buffer substring includes bidirectional
4580 text and control characters that cause non-trivial reordering on display.
4581 If copied verbatim, such text can have a very different visual appearance,
4582 and can also change the visual appearance of the surrounding text at the
4583 destination of the copy.
4585 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4586 the text properties."
4599 no-properties)))
4603 substr)))
4604 \f
4605 ;; Yanking.
4610 "List of special text property handling conditions for yanking.
4611 Each element should have the form (PROP . FUN), where PROP is a
4612 property symbol and FUN is a function. When the `yank' command
4613 inserts text into the buffer, it scans the inserted text for
4614 stretches of text that have `eq' values of the text property
4615 PROP; for each such stretch of text, FUN is called with three
4616 arguments: the property's value in that text, and the start and
4617 end positions of the text.
4619 This is done prior to removing the properties specified by
4620 `yank-excluded-properties'."
4623 function))
4626 ;; This is actually used in subr.el but defcustom does not work there.
4629 intangible invisible keymap local-map mouse-face read-only
4630 yank-handler)
4631 "Text properties to discard when yanking.
4632 The value should be a list of text properties to discard or t,
4633 which means to discard all text properties.
4635 See also `yank-handled-properties'."
4642 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4643 Function is called with two parameters, START and END corresponding to
4644 the value of the mark and point; it is guaranteed that START <= END.
4648 "Replace just-yanked stretch of killed text with a different stretch.
4649 This command is allowed only immediately after a `yank' or a `yank-pop'.
4650 At such a time, the region contains a stretch of reinserted
4651 previously-killed text. `yank-pop' deletes that text and inserts in its
4652 place a different stretch of killed text.
4654 With no argument, the previous kill is inserted.
4655 With argument N, insert the Nth previous kill.
4656 If N is negative, this is a more recent kill.
4658 The sequence of kills wraps around, so that after the oldest one
4659 comes the newest one.
4661 When this command inserts killed text into the buffer, it honors
4662 `yank-excluded-properties' and `yank-handler' as described in the
4663 doc string for `insert-for-yank-1', which see."
4677 ;; Set the window start back where it was in the yank command,
4678 ;; if possible.
4681 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4682 ;; It is cleaner to avoid activation, even though the command
4683 ;; loop would deactivate the mark because we inserted text.
4686 nil)
4690 More precisely, reinsert the most recent kill, which is the
4691 stretch of killed text most recently killed OR yanked. Put point
4692 at the end, and set mark at the beginning without activating it.
4694 With argument N, reinsert the Nth most recent kill.
4696 When this command inserts text into the buffer, it honors the
4697 `yank-handled-properties' and `yank-excluded-properties'
4698 variables, and the `yank-handler' text property. See
4699 `insert-for-yank-1' for details.
4704 ;; If we don't get all the way thru, make last-command indicate that
4705 ;; for the following command.
4713 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4714 ;; It is cleaner to avoid activation, even though the command
4715 ;; loop would deactivate the mark because we inserted text.
4718 ;; If we do get all the way thru, make this-command indicate that.
4721 nil)
4724 "Rotate the yanking point in the kill ring.
4725 With ARG, rotate that many kills forward (or backward, if negative)."
4728 \f
4729 ;; Some kill commands.
4731 ;; Internal subroutine of delete-char
4737 ;; Internal subroutine of backward-delete-char
4744 "The method for untabifying when deleting backward.
4745 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4746 `hungry' -- delete all whitespace, both tabs and spaces;
4747 `all' -- delete all whitespace, including tabs, spaces and newlines;
4748 nil -- just delete one character."
4754 "Delete characters backward, changing tabs into spaces.
4755 The exact behavior depends on `backward-delete-char-untabify-method'.
4756 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4757 Interactively, ARG is the prefix arg (default 1)
4758 and KILLP is t if a prefix arg was specified."
4781 arg)))
4782 ;; Avoid warning about delete-backward-char
4786 "Kill up to and including ARGth occurrence of CHAR.
4787 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4788 Goes backward if ARG is negative; error if CHAR not found."
4791 ;; Avoid "obsolete" warnings for translation-table-for-input.
4799 ;; kill-line and its subroutines.
4802 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4807 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4808 With prefix argument ARG, kill that many lines from point.
4809 Negative arguments kill lines backward.
4810 With zero argument, kills the text before point on the current line.
4813 a number counts as a prefix arg.
4815 To kill a whole line, when point is not at the beginning, type \
4818 If `show-trailing-whitespace' is non-nil, this command will just
4819 kill the rest of the current line, even if there are only
4820 nonblanks there.
4822 If option `kill-whole-line' is non-nil, then this command kills the whole line
4823 including its terminating newline, when used at the beginning of a line
4824 with no argument. As a consequence, you can always kill a whole line
4827 If you want to append the killed line to the last killed text,
4830 If the buffer is read-only, Emacs will beep and refrain from deleting
4831 the line, but put the line in the kill ring anyway. This means that
4832 you can use this command to copy text from a read-only buffer.
4833 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4834 even beep.)"
4837 ;; It is better to move point to the other end of the kill
4838 ;; before killing. That way, in a read-only buffer, point
4839 ;; moves across the text that is copied to the kill ring.
4840 ;; The choice has no effect on undo now that undo records
4841 ;; the value of point from before the command was run.
4851 ;; If trailing whitespace is visible,
4852 ;; don't treat it as nothing.
4862 "Kill current line.
4863 With prefix ARG, kill that many lines starting from the current line.
4864 If ARG is negative, kill backward. Also kill the preceding newline.
4866 If ARG is zero, kill current line but exclude the trailing newline."
4877 ;; We need to kill in two steps, because the previous command
4878 ;; could have been a kill command, in which case the text
4879 ;; before point needs to be prepended to the current kill
4880 ;; ring entry and the text after point appended. Also, we
4881 ;; need to use save-excursion to avoid copying the same text
4882 ;; twice to the kill ring in read-only buffers.
4900 "Move forward by ARG lines, ignoring currently invisible newlines only.
4901 If ARG is negative, move backward -ARG lines.
4902 If ARG is zero, move to the beginning of the current line."
4909 ;; If the newline we just skipped is invisible,
4910 ;; don't count it.
4914 prop
4919 ;; If invisible text follows, and it is a number of complete lines,
4920 ;; skip it.
4926 prop
4942 ;; If the newline we just moved to is invisible,
4943 ;; don't count it.
4948 prop
4953 ;; If invisible text follows, and it is a number of complete lines,
4954 ;; skip it.
4960 prop
4971 nil)))
4974 "Move to end of current visible line."
4976 ;; If the following character is currently invisible,
4977 ;; skip all characters with that same `invisible' property value,
4978 ;; then find the next newline.
4985 prop
4994 \f
4996 "Insert after point the contents of BUFFER.
4997 Puts mark after the inserted text.
4998 BUFFER may be a buffer or a buffer name."
5008 t))))
5013 nil)
5016 "Append to specified buffer the text of the region.
5017 It is inserted into that buffer before its point.
5019 When calling from a program, give three arguments:
5020 BUFFER (or buffer name), START and END.
5021 START and END specify the portion of the current buffer to be copied."
5028 point)
5039 "Prepend to specified buffer the text of the region.
5040 It is inserted into that buffer after its point.
5042 When calling from a program, give three arguments:
5043 BUFFER (or buffer name), START and END.
5044 START and END specify the portion of the current buffer to be copied."
5053 "Copy to specified buffer the text of the region.
5054 It is inserted into that buffer, replacing existing text there.
5056 When calling from a program, give three arguments:
5057 BUFFER (or buffer name), START and END.
5058 START and END specify the portion of the current buffer to be copied."
5066 \f
5070 "Hook run when the mark becomes active.
5071 It is also run at the end of a command, if the mark is active and
5078 "Return this buffer's mark value as integer, or nil if never set.
5080 In Transient Mark mode, this function signals an error if
5081 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5082 or the argument FORCE is non-nil, it disregards whether the mark
5083 is active, and returns an integer or nil in the usual way.
5085 If you are using this in an editing command, you are most likely making
5086 a mistake; see the documentation of `set-mark'."
5091 ;; Behind display-selections-p.
5094 "Deactivate the mark.
5095 If Transient Mark mode is disabled, this function normally does
5096 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5098 Deactivating the mark sets `mark-active' to nil, updates the
5099 primary selection according to `select-active-regions', and runs
5100 `deactivate-mark-hook'.
5102 If Transient Mark mode was temporarily enabled, reset the value
5103 of the variable `transient-mark-mode'; if this causes Transient
5104 Mark mode to be disabled, don't change `mark-active' to nil or
5105 run `deactivate-mark-hook'."
5109 select-active-regions)
5112 ;; The var `saved-region-selection', if non-nil, is the text in
5113 ;; the region prior to the last command modifying the buffer.
5114 ;; Set the selection to that, or to the current region.
5119 ;; If another program has acquired the selection, region
5120 ;; deactivation should not clobber it (Bug#11772).
5139 "Activate the mark.
5140 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5150 "Set this buffer's mark to POS. Don't use this function!
5151 That is to say, don't use this function unless you want
5152 the user to see that the mark has moved, and you want the previous
5153 mark position to be lost.
5155 Normally, when a new mark is set, the old one should go on the stack.
5156 This is why most applications should use `push-mark', not `set-mark'.
5158 Novice Emacs Lisp programmers often try to use the mark for the wrong
5159 purposes. The mark saves a location for the user's convenience.
5160 Most editing commands should not alter the mark.
5161 To remember a location for internal use in the Lisp program,
5162 store it in a Lisp variable. Example:
5164 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5169 ;; Normally we never clear mark-active except in Transient Mark mode.
5170 ;; But when we actually clear out the mark value too, we must
5171 ;; clear mark-active in any mode.
5173 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5174 ;; it should never be nil if the mark is nil.
5182 mark-active))
5189 ;; Mark marker
5195 ;; Mark active
5198 ;; If mark is active now, and either was not active or was at a
5199 ;; different place, run the activate hook.
5204 ;; If mark has ceased to be active, run deactivate hook.
5209 "Like `save-excursion', but also save and restore the mark state.
5210 This macro does what `save-excursion' did before Emacs 25.1."
5219 If nil, region-aware commands treat empty regions as inactive.
5220 If non-nil, region-aware commands treat the region as active as
5221 long as the mark is active, even if the region is empty.
5223 Region-aware commands are those that act on the region if it is
5224 active and Transient Mark mode is enabled, and on the text near
5225 point otherwise."
5231 "Return t if the region is active and it is appropriate to act on it.
5232 This is used by commands that act specially on the region under
5233 Transient Mark mode.
5235 The return value is t if Transient Mark mode is enabled and the
5236 mark is active; furthermore, if `use-empty-active-region' is nil,
5237 the region must not be empty. Otherwise, the return value is nil.
5239 For some commands, it may be appropriate to ignore the value of
5240 `use-empty-active-region'; in that case, use `region-active-p'."
5245 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5247 Some commands act specially on the region when Transient Mark
5248 mode is enabled. Usually, such commands should use
5249 `use-region-p' instead of this function, because `use-region-p'
5250 also checks the value of `use-empty-active-region'."
5252 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5253 ;; without the mark being set (e.g. bug#17324). We really should fix
5254 ;; that problem, but in the mean time, let's make sure we don't say the
5255 ;; region is active when there's no mark.
5259 "Return non-nil if the region contains several pieces.
5260 An example is a rectangular region handled as a list of
5261 separate contiguous regions for each line."
5274 ;; Normal priority so that a large region doesn't hide all the
5275 ;; overlays within it, but high secondary priority so that if it
5276 ;; ends/starts in the middle of a small overlay, that small overlay
5277 ;; won't hide the region's boundaries.
5279 nrol)
5284 rol)))
5300 start end window rol)))
5303 new))))))
5306 "Hook run just before redisplay.
5307 It is called in each window that is to be redisplayed. It takes one argument,
5308 which is the window that will be redisplayed. When run, the `current-buffer'
5329 "Maximum size of mark ring. Start discarding off end if gets this big."
5337 "Maximum size of global mark ring. \
5338 Start discarding off end if gets this big."
5343 "Jump to mark, and pop a new position for mark off the ring.
5344 \(Does not affect global mark ring)."
5354 "Set mark at where point is.
5355 If no prefix ARG and mark is already set there, just activate it.
5356 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5368 will pop the mark twice, and
5370 will pop the mark three times.
5378 "Set the mark where point is, or jump to the mark.
5379 Setting the mark also alters the region, which is the text
5380 between point and mark; this is the closest equivalent in
5383 With no prefix argument, set the mark at point, and push the
5384 old mark position on local mark ring. Also push the old mark on
5385 global mark ring, if the previous mark was set in another buffer.
5387 When Transient Mark Mode is off, immediately repeating this
5388 command activates `transient-mark-mode' temporarily.
5391 jump to the mark, and set the mark from
5392 position popped off the local mark ring (this does not affect the global
5394 mark ring (see `pop-global-mark').
5396 If `set-mark-command-repeat-pop' is non-nil, repeating
5398 off the local (or global) mark ring and jumps there.
5401 argument, unconditionally set mark where point is, even if
5402 `set-mark-command-repeat-pop' is non-nil.
5404 Novice Emacs Lisp programmers often try to use the mark for the wrong
5405 purposes. See the documentation of `set-mark' for more information."
5425 arg)
5439 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5440 If the last global mark pushed was not in the current buffer,
5441 also push LOCATION on the global mark ring.
5442 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5444 Novice Emacs Lisp programmers often try to use the mark for the wrong
5445 purposes. See the documentation of `set-mark' for more information.
5447 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5454 ;; Now push the mark on the global mark ring.
5457 ;; The last global mark pushed was in this same buffer.
5458 ;; Don't push another one.
5459 nil
5468 nil)
5471 "Pop off mark ring into the buffer's actual mark.
5472 Does not set point. Does nothing if mark ring is empty."
5484 "Put the mark where point is now, and point where the mark is now.
5485 This command works even when the mark is not active,
5486 and it reactivates the mark.
5488 If Transient Mark mode is on, a prefix ARG deactivates the mark
5489 if it is active, and otherwise avoids reactivating it. If
5490 Transient Mark mode is off, a prefix ARG enables Transient Mark
5491 mode temporarily."
5505 nil))
5508 "When non-nil, shifted motion keys activate the mark momentarily.
5510 While the mark is activated in this way, any shift-translated point
5511 motion key extends the region, and if Transient Mark mode was off, it
5512 is temporarily turned on. Furthermore, the mark will be deactivated
5513 by any subsequent point motion key that was not shift-translated, or
5514 by any action that normally deactivates the mark in Transient Mark mode.
5516 See `this-command-keys-shift-translated' for the meaning of
5517 shift-translation."
5522 "Activate/deactivate mark depending on invocation thru shift translation.
5523 This function is called by `call-interactively' when a command
5524 with a `^' character in its `interactive' spec is invoked, before
5525 running the command itself.
5527 If `shift-select-mode' is enabled and the command was invoked
5528 through shift translation, set the mark and activate the region
5529 temporarily, unless it was already set in this way. See
5530 `this-command-keys-shift-translated' for the meaning of shift
5531 translation.
5533 Otherwise, if the region has been activated temporarily,
5534 deactivate it, and restore the variable `transient-mark-mode' to
5535 its earlier value."
5542 transient-mark-mode)))
5551 "Toggle Transient Mark mode.
5552 With a prefix argument ARG, enable Transient Mark mode if ARG is
5553 positive, and disable it otherwise. If called from Lisp, enable
5554 Transient Mark mode if ARG is omitted or nil.
5556 Transient Mark mode is a global minor mode. When enabled, the
5557 region is highlighted with the `region' face whenever the mark
5559 and after certain other operations that set the mark but whose
5560 main purpose is something else--for example, incremental search,
5566 Many commands change their behavior when Transient Mark mode is
5567 in effect and the mark is active, by acting on the region instead
5568 of their usual default part of the buffer's text. Examples of
5571 To see the documentation of commands which are sensitive to the
5574 :global t
5575 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5579 "Non-nil means it is ok for commands to call `widen' when they want to.
5580 Some commands will do this in order to go to positions outside
5581 the current accessible part of the buffer.
5583 If `widen-automatically' is nil, these commands will do something else
5587 "Whether the currently executing code is performing an essential task.
5588 This variable should be non-nil only when running code which should not
5589 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5590 user for a password when we are simply scanning a set of files in the
5591 background or displaying possible completions before the user even asked
5595 "Pop off global mark ring and jump to the top location."
5597 ;; Pop entries which refer to non-existent buffers.
5615 \f
5617 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5623 "Move cursor vertically down ARG lines.
5624 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5625 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5626 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5627 function will not vscroll.
5629 ARG defaults to 1.
5631 If there is no character in the target line exactly under the current column,
5632 the cursor is positioned after the character in that line which spans this
5633 column, or at the end of the line if it is not long enough.
5634 If there is no line in the buffer after this one, behavior depends on the
5635 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5636 to create a line, and moves the cursor to that line. Otherwise it moves the
5637 cursor to the end of the buffer.
5639 If the variable `line-move-visual' is non-nil, this command moves
5640 by display lines. Otherwise, it moves by buffer lines, without
5641 taking variable-width characters or continued lines into account.
5644 a semipermanent goal column for this command.
5645 Then instead of trying to move exactly vertically (or as close as possible),
5646 this command moves to the specified goal column (or as close as possible).
5647 The goal column is stored in the variable `goal-column', which is nil
5648 when there is no goal column. Note that setting `goal-column'
5649 overrides `line-move-visual' and causes this command to move by buffer
5650 lines rather than by display lines."
5656 ;; When adding a newline, don't expand an abbrev.
5667 nil)
5670 "Move cursor vertically up ARG lines.
5671 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5672 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5673 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5674 function will not vscroll.
5676 ARG defaults to 1.
5678 If there is no character in the target line exactly over the current column,
5679 the cursor is positioned after the character in that line which spans this
5680 column, or at the end of the line if it is not long enough.
5682 If the variable `line-move-visual' is non-nil, this command moves
5683 by display lines. Otherwise, it moves by buffer lines, without
5684 taking variable-width characters or continued lines into account.
5687 a semipermanent goal column for this command.
5688 Then instead of trying to move exactly vertically (or as close as possible),
5689 this command moves to the specified goal column (or as close as possible).
5690 The goal column is stored in the variable `goal-column', which is nil
5691 when there is no goal column. Note that setting `goal-column'
5692 overrides `line-move-visual' and causes this command to move by buffer
5693 lines rather than by display lines."
5704 nil)
5707 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5708 This means moving to the end of each line moved onto.
5709 The beginning of a blank line does not count as the end of a line.
5710 This has no effect when the variable `line-move-visual' is non-nil."
5716 A non-nil setting overrides the variable `line-move-visual', which see."
5723 "Current goal column for vertical motion.
5724 It is the column where point was at the start of the current run
5725 of vertical motion commands.
5727 When moving by visual lines via the function `line-move-visual', it is a cons
5728 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5729 divided by the default column width, and HSCROLL is the number of
5730 columns by which window is scrolled from left margin.
5732 When the `track-eol' feature is doing its job, the value is
5736 "Non-nil means commands that move by lines ignore invisible newlines.
5737 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5738 as if newlines that are invisible didn't exist, and count
5739 only visible newlines. Thus, moving across across 2 newlines
5740 one of which is invisible will be counted as a one-line move.
5741 Also, a non-nil value causes invisible text to be ignored when
5742 counting columns for the purposes of keeping point in the same
5745 Outline mode sets this."
5750 "When non-nil, `line-move' moves point by visual lines.
5751 This movement is based on where the cursor is displayed on the
5752 screen, instead of relying on buffer contents alone. It takes
5753 into account variable-width characters and line continuation.
5754 If nil, `line-move' moves point by logical lines.
5755 A non-nil setting of `goal-column' overrides the value of this variable
5756 and forces movement by logical lines.
5757 A window that is horizontally scrolled also forces movement by logical
5758 lines."
5763 ;; Only used if display-graphic-p.
5767 "Return the height in pixels of the current buffer's default face font.
5769 If the default font is remapped (see `face-remapping-alist'), the
5770 function returns the height of the remapped face."
5774 ;; Avoid calling font-info if the frame's default font was
5775 ;; not changed since the frame was created. That's because
5776 ;; font-info is expensive for some fonts, see bug #14838.
5782 "Return the width in pixels of the current buffer's default face font.
5784 If the default font is remapped (see `face-remapping-alist'), the
5785 function returns the width of the remapped face."
5789 ;; Avoid calling font-info if the frame's default font was
5790 ;; not changed since the frame was created. That's because
5791 ;; font-info is expensive for some fonts, see bug #14838.
5796 width
5801 "Return the pixel height of current buffer's default-face text line.
5803 The value includes `line-spacing', if any, defined for the buffer
5804 or the frame."
5817 "Return the number of screen lines in the text area of the selected window.
5819 This is different from `window-text-height' in that this function counts
5820 lines in units of the height of the font used by the default face displayed
5821 in the window, not in units of the frame's default font, and also accounts
5822 for `line-spacing', if any, defined for the window's buffer or frame.
5824 The value is a floating-point number."
5829 ;; Returns non-nil if partial move was done.
5832 ;; Move backward (up).
5833 ;; If already vscrolled, reduce vscroll
5839 ;; Move forward (down).
5852 py vs last-line)
5872 col-row)
5877 ;; VPOS > 0 means the last line is only partially visible.
5878 ;; But if the part that is visible is at least as tall as the
5879 ;; default font, that means the line is actually fully
5880 ;; readable, and something like line-spacing is hidden. So in
5881 ;; that case we accept the last line in the window as still
5882 ;; visible, and consider the margin as starting one line
5883 ;; later.
5891 ;; If last line of window is fully visible, and vscrolling
5892 ;; more would make this line invisible, move forward.
5897 nil)
5898 ;; If cursor is not in the bottom scroll margin, and the
5899 ;; current line is is not too tall, move forward.
5901 vpos
5904 nil)
5905 ;; When already vscrolled, we vscroll some more if we can,
5906 ;; or clear vscroll and move forward at end of tall image.
5911 ;; If cursor just entered the bottom scroll margin, move forward,
5912 ;; but also optionally vscroll one line so redisplay won't recenter.
5916 ;; Don't vscroll if the partially-visible line at window
5917 ;; bottom is not too tall (a.k.a. "just one more text
5918 ;; line"): in that case, we do want redisplay to behave
5919 ;; normally, i.e. recenter or whatever.
5920 ;;
5921 ;; Note: ROWH + RBOT from the value returned by
5922 ;; pos-visible-in-window-p give the total height of the
5923 ;; partially-visible glyph row at the end of the window. As
5924 ;; we are dealing with floats, we disregard sub-pixel
5925 ;; discrepancies between that and DLH.
5929 t)
5930 ;; If there are lines above the last line, scroll-up one line.
5933 t)
5934 ;; Finally, start vscroll.
5939 ;; This is like line-move-1 except that it also performs
5940 ;; vertical scrolling of tall images if appropriate.
5941 ;; That is not really a clean thing to do, since it mixes
5942 ;; scrolling with cursor motion. But so far we don't have
5943 ;; a cleaner solution to the problem of making C-n do something
5944 ;; useful given a tall image.
5946 "Move forward ARG lines.
5947 If NOERROR, don't signal an error if we can't move ARG lines.
5948 TO-END is unused.
5949 TRY-VSCROLL controls whether to vscroll tall lines: if either
5950 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5951 not vscroll."
5955 ;; Only vscroll for single line moves
5957 ;; Under scroll-conservatively, the display engine
5958 ;; does this better.
5960 ;; But don't vscroll in a keyboard macro.
5966 ;; Display-based column are incompatible with goal-column.
5968 ;; When the text in the window is scrolled to the left,
5969 ;; display-based motion doesn't make sense (because each
5970 ;; logical line occupies exactly one screen line).
5972 ;; Likewise when the text _was_ scrolled to the left
5973 ;; when the current run of vertical motion commands
5974 ;; started.
5977 auto-hscroll-mode
5979 (>= temporary-goal-column
5982 ;; If we moved into a tall line, set vscroll to make
5983 ;; scrolling through tall images more smooth.
5987 winh)
5993 nil
5997 ;; Display-based alternative to line-move-1.
5998 ;; Arg says how many lines to move. The value is t if we can move the
5999 ;; specified number of lines.
6001 "Move ARG lines forward.
6002 If NOERROR, don't signal an error if we can't move that many lines."
6005 target-hscroll)
6006 ;; Check if the previous command was a line-motion command, or if
6007 ;; we were called from some other command.
6010 ;; If so, there's no need to reset `temporary-goal-column',
6011 ;; but we may need to hscroll.
6015 ;; Otherwise, we should reset `temporary-goal-column'.
6017 x-pos)
6019 ;; Handle the `overflow-newline-into-fringe' case:
6024 ;; In R2L lines, the X pixel coordinate is measured from the
6025 ;; left edge of the window, but columns are still counted
6026 ;; from the logical-order beginning of the line, i.e. from
6027 ;; the right edge in this case. We need to adjust for that.
6033 hscroll))))))
6036 ;; vertical-motion can move more than it was asked to if it moves
6037 ;; across display strings with newlines. We don't want to ring
6038 ;; the bell and announce beginning/end of buffer in that case.
6044 temporary-goal-column))
6045 arg))
6046 arg))
6052 temporary-goal-column))
6053 arg))
6054 arg)))
6057 ;; If the goal column lies on a display string,
6058 ;; `vertical-motion' advances the cursor to the end
6059 ;; of the string. For arg < 0, this can cause the
6060 ;; cursor to get stuck. (Bug#3020).
6064 nil)))))
6066 ;; This is the guts of next-line and previous-line.
6067 ;; Arg says how many lines to move.
6068 ;; The value is t if we can move the specified number of lines.
6070 ;; Don't run any point-motion hooks, and disregard intangibility,
6071 ;; for intermediate positions.
6083 ;; Don't count beg of empty line as end of line
6084 ;; unless we just did explicit end-of-line.
6086 most-positive-fixnum
6090 line-move-ignore-invisible))
6091 ;; Use just newline characters.
6092 ;; Set ARG to 0 if we move as many lines as requested.
6095 ;; This way of moving forward ARG lines
6096 ;; verifies that we have a newline after the last one.
6097 ;; It doesn't get confused by intangible text.
6106 'beginning-of-buffer
6108 nil)))
6109 ;; Move by arg lines, but ignore invisible ones.
6112 ;; If the following character is currently invisible,
6113 ;; skip all characters with that same `invisible' property value.
6116 ;; Move a line.
6117 ;; We don't use `end-of-line', since we want to escape
6118 ;; from field boundaries occurring exactly at point.
6124 ;; If there's no invisibility here, move over the newline.
6133 ;; We avoid vertical-motion when possible
6134 ;; because that has to fontify.
6136 ;; Otherwise move a more sophisticated way.
6143 ;; The logic of this is the same as the loop above,
6144 ;; it just goes in the other direction.
6146 ;; For completely consistency with the forward-motion
6147 ;; case, we should call beginning-of-line here.
6148 ;; However, if point is inside a field and on a
6149 ;; continued line, the call to (vertical-motion -1)
6150 ;; below won't move us back far enough; then we return
6151 ;; to the same column in line-move-finish, and point
6152 ;; gets stuck -- cyd
6170 ;; if our target is the middle of this line.
6175 ;; This is the value the function returns.
6179 ;; If we did not move down as far as desired, at least go
6180 ;; to end of line. Be sure to call point-entered and
6181 ;; point-left-hooks.
6187 ;; If we did not move up as far as desired,
6188 ;; at least go to beginning of line.
6200 ;; Set REPEAT to t to repeat the whole thing.
6207 ;; Compute the end of the line
6208 ;; ignoring effectively invisible newlines.
6210 ;; Like end-of-line but ignores fields.
6217 ;; Move to the desired column.
6220 ;; Corner case: suppose we start out in a field boundary in
6221 ;; the middle of a continued line. When we get to
6222 ;; line-move-finish, point is at the start of a new *screen*
6223 ;; line but the same text line; then line-move-to-column would
6224 ;; move us backwards. Test using C-n with point on the "x" in
6225 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6232 ;; Process intangibility within a line.
6233 ;; With inhibit-point-motion-hooks bound to nil, a call to
6234 ;; goto-char moves point past intangible text.
6236 ;; However, inhibit-point-motion-hooks controls both the
6237 ;; intangibility and the point-entered/point-left hooks. The
6238 ;; following hack avoids calling the point-* hooks
6239 ;; unnecessarily. Note that we move *forward* past intangible
6240 ;; text when the initial and final points are the same.
6245 ;; If intangibility moves us to a different (later) place
6246 ;; in the same line, use that as the destination.
6249 ;; If that position is "too late",
6250 ;; try the previous allowable position.
6251 ;; See if it is ok.
6254 ;; If going forward, don't accept the previous
6255 ;; allowable position if it is before the target line.
6257 ;; If going backward, don't accept the previous
6258 ;; allowable position if it is still after the target line.
6261 ;; As a last resort, use the end of the line.
6264 ;; Now move to the updated destination, processing fields
6265 ;; as well as intangibility.
6269 ;; Ignore field boundaries if the initial and final
6270 ;; positions have the same `field' property, even if the
6271 ;; fields are non-contiguous. This seems to be "nicer"
6272 ;; behavior in many situations.
6275 new
6279 ;; If all this moved us to a different line,
6280 ;; retry everything within that new line.
6282 ;; Repeat the intangibility and field processing.
6286 "Try to find column COL, considering invisibility.
6287 This function works only in certain cases,
6288 because what we really need is for `move-to-column'
6289 and `current-column' to be able to ignore invisible text."
6298 ;; If the following character is currently invisible,
6299 ;; skip all characters with that same `invisible' property value.
6303 ;; Have we advanced to a larger column position?
6305 ;; We have made some progress towards the desired column.
6306 ;; See if we can make any further progress.
6308 ;; Otherwise, go to the place we originally found
6309 ;; and move back over invisible text.
6310 ;; that will get us to the same place on the screen
6311 ;; but with a more reasonable buffer position.
6314 ;; We want the real line beginning, so it's consistent
6315 ;; with bolp below, otherwise we might infloop.
6322 "Move point to end of current line as displayed.
6323 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6324 If point reaches the beginning or end of buffer, it stops there.
6326 To ignore the effects of the `intangible' text or overlay
6327 property, bind `inhibit-point-motion-hooks' to t.
6328 If there is an image in the current line, this function
6329 disregards newlines that are part of the text on which the image
6330 rests."
6340 ;; With bidi reordering, we may not be at bol,
6341 ;; so make sure we are.
6356 ;; If we skipped something intangible and now we're not
6357 ;; really at eol, keep going.
6362 "Move point to beginning of current line as displayed.
6363 \(If there's an image in the line, this disregards newlines
6364 which are part of the text that the image rests on.)
6366 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6367 If point reaches the beginning or end of buffer, it stops there.
6368 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6373 first-vis first-vis-field-value)
6375 ;; Move by lines, if ARG is not 1 (the default).
6380 ;; Move to beginning-of-line, ignoring fields and invisible text.
6386 ;; Now find first visible char in the line.
6391 ;; See if fields would stop us from reaching FIRST-VIS.
6396 ;; If yes, obey them.
6397 first-vis-field-value
6398 ;; Otherwise, move to START with attention to fields.
6399 ;; (It is possible that fields never matter in this case.)
6404 ;; Many people have said they rarely use this feature, and often type
6405 ;; it by accident. Maybe it shouldn't even be on a key.
6410 Those commands will move to this position in the line moved to
6411 rather than trying to keep the same horizontal position.
6412 With a non-nil argument ARG, clears out the goal column
6414 The goal column is stored in the variable `goal-column'."
6421 ;; The older method below can be erroneous if `set-goal-column' is bound
6422 ;; to a sequence containing %
6423 ;;(message (substitute-command-keys
6424 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6425 ;;goal-column)
6432 )
6433 nil)
6434 \f
6435 ;;; Editing based on visual lines, as opposed to logical lines.
6438 "Move point to end of current visual line.
6439 With argument N not nil or 1, move forward N - 1 visual lines first.
6440 If point reaches the beginning or end of buffer, it stops there.
6441 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6447 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6448 ;; constrain to field boundaries, so we don't either.
6452 "Move point to beginning of current visual line.
6453 With argument N not nil or 1, move forward N - 1 visual lines first.
6454 If point reaches the beginning or end of buffer, it stops there.
6455 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6463 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6467 "Kill the rest of the visual line.
6468 With prefix argument ARG, kill that many visual lines from point.
6469 If ARG is negative, kill visual lines backward.
6470 If ARG is zero, kill the text before point on the current visual
6471 line.
6473 If you want to append the killed line to the last killed text,
6476 If the buffer is read-only, Emacs will beep and refrain from deleting
6477 the line, but put the line in the kill ring anyway. This means that
6478 you can use this command to copy text from a read-only buffer.
6479 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6480 even beep.)"
6482 ;; Like in `kill-line', it's better to move point to the other end
6483 ;; of the kill before killing.
6491 ;; Skip any trailing whitespace at the end of the visual line.
6492 ;; We used to do this only if `show-trailing-whitespace' is
6493 ;; nil, but that's wrong; the correct thing would be to check
6494 ;; whether the trailing whitespace is highlighted. But, it's
6495 ;; OK to just do this unconditionally.
6502 "Move cursor vertically down ARG lines.
6503 This is identical to `next-line', except that it always moves
6504 by logical lines instead of visual lines, ignoring the value of
6505 the variable `line-move-visual'."
6512 "Move cursor vertically up ARG lines.
6513 This is identical to `previous-line', except that it always moves
6514 by logical lines instead of visual lines, ignoring the value of
6515 the variable `line-move-visual'."
6522 "Editing based on visual lines."
6531 ;; These keybindings interfere with xterm function keys. Are
6532 ;; there any other suitable bindings?
6533 ;; (define-key map "\M-[" 'previous-logical-line)
6534 ;; (define-key map "\M-]" 'next-logical-line)
6535 map))
6538 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6539 The value should be a list of the form (LEFT RIGHT), where LEFT
6540 and RIGHT are symbols representing the bitmaps to display, to
6541 indicate wrapped lines, in the left and right fringes respectively.
6542 See also `fringe-indicator-alist'.
6543 The default is not to display fringe indicators for wrapped lines.
6544 This variable does not affect fringe indicators displayed for
6545 other purposes."
6560 'continuation
6567 "Toggle visual line based editing (Visual Line mode).
6568 With a prefix argument ARG, enable Visual Line mode if ARG is
6569 positive, and disable it otherwise. If called from Lisp, enable
6570 the mode if ARG is omitted or nil.
6572 When Visual Line mode is enabled, `word-wrap' is turned on in
6573 this buffer, and simple editing commands are redefined to act on
6574 visual lines, not logical lines. See Info node `Visual Line
6575 Mode' for details."
6576 :keymap visual-line-mode-map
6582 ;; Save the local values of some variables, to be restored if
6583 ;; visual-line-mode is turned off.
6585 truncate-partial-width-windows
6586 word-wrap fringe-indicator-alist))
6589 visual-line--saved-state)))
6593 word-wrap t
6594 fringe-indicator-alist
6596 fringe-indicator-alist)))
6610 visual-line-mode turn-on-visual-line-mode)
6612 \f
6614 "Interchange characters around point, moving forward one character.
6615 With prefix arg ARG, effect is to take character before point
6616 and drag it forward past ARG other characters (backward if ARG negative).
6617 If no argument and at end of line, the previous two chars are exchanged."
6625 "Interchange words around point, leaving point at end of them.
6626 With prefix arg ARG, effect is to take word before or around point
6627 and drag it forward past ARG other words (backward if ARG negative).
6628 If ARG is zero, the words around or after point and around or after mark
6629 are interchanged."
6630 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6636 Does not work on a sexp that point is in the middle of
6637 if it is a list or string."
6641 ;; Here we should try to simulate the behavior of
6642 ;; (cons (progn (forward-sexp x) (point))
6643 ;; (progn (forward-sexp (- x)) (point)))
6644 ;; Except that we don't want to rely on the second forward-sexp
6645 ;; putting us back to where we want to be, since forward-sexp-function
6646 ;; might do funny things like infix-precedence.
6651 ;; Jumping over a symbol. We might be inside it, mind you.
6656 ;; Otherwise, we're between sexps. Take a step back before jumping
6657 ;; to make sure we'll obey the same precedence no matter which direction
6658 ;; we're going.
6663 'skip-syntax-forward
6670 "Exchange current line and previous line, leaving point after both.
6671 With argument ARG, takes previous line and moves it past ARG lines.
6672 With argument 0, interchanges line point is in with line mark is in."
6678 ;; Move forward over ARG lines,
6679 ;; but create newlines if necessary.
6686 arg))
6688 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6689 ;; which seems inconsistent with the ARG /= 0 case.
6690 ;; FIXME document SPECIAL.
6692 "Subroutine to do the work of transposing objects.
6693 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6694 moves forward by units of the given object (e.g. forward-sentence,
6695 forward-paragraph). If ARG is zero, exchanges the current object
6696 with the one containing mark. If ARG is an integer, moves the
6697 current object past ARG following (if ARG is positive) or
6698 preceding (if ARG is negative) objects, leaving point after the
6699 current object."
6704 pos1 pos2)
6733 ;; This sequence of insertions attempts to preserve marker
6734 ;; positions at the start and end of the transposed objects.
6748 \f
6750 "Move backward until encountering the beginning of a word.
6751 With argument ARG, do this that many times.
6752 If ARG is omitted or nil, move point backward one word.
6754 The word boundaries are normally determined by the buffer's syntax
6755 table, but `find-word-boundary-function-table', such as set up
6756 by `subword-mode', can change that. If a Lisp program needs to
6757 move by words determined strictly by the syntax table, it should
6758 use `backward-word-strictly' instead."
6763 "Set mark ARG words away from point.
6765 move to with the same argument.
6766 Interactively, if this command is repeated
6767 or (in Transient Mark mode) if the mark is active,
6768 it marks the next ARG words after the ones already marked."
6785 nil t))))
6788 "Kill characters forward until encountering the end of a word.
6789 With argument ARG, do this that many times."
6794 "Kill characters backward until encountering the beginning of a word.
6795 With argument ARG, do this that many times."
6800 "Return the symbol or word that point is on (or a nearby one) as a string.
6801 The return value includes no text properties.
6802 If optional arg STRICT is non-nil, return nil unless point is within
6803 or adjacent to a symbol or word. In all cases the value can be nil
6804 if there is no word nearby.
6805 The function, belying its name, normally finds a symbol.
6806 If optional arg REALLY-WORD is non-nil, it finds just a word."
6815 ;; Point is neither within nor adjacent to a word.
6817 ;; Look for preceding word in same line.
6820 ;; No preceding word in same line.
6821 ;; Look for following word in same line.
6830 ;; If we found something nonempty, return it as a string.
6833 \f
6835 "String for filling to insert at front of new line, or nil for none."
6837 string)
6843 "Regexp to match lines which should not be auto-filled."
6845 regexp)
6849 "The default value for `normal-auto-fill-function'.
6850 This is the default auto-fill function, some major modes use a different one.
6851 Returns t if it really did any work."
6861 nil ;; Auto-filling not required
6865 ;; Choose a fill-prefix automatically.
6873 ;; Use auto-indentation rather than a guessed empty prefix.
6879 ;; Determine where to split the line.
6892 ;; See whether the place we found is any good.
6896 ;; There is no use breaking at end of line.
6898 ;; It is futile to split at the end of the prefix
6899 ;; since we would just insert the prefix again.
6901 ;; Don't split right after a comment starter
6902 ;; since we would just make another comment starter.
6907 limit t)
6909 ;; No good place to break => stop trying.
6911 ;; Ok, we have a useful place to break the line. Do it.
6913 ;; If point is at the fill-point, do not `save-excursion'.
6914 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6915 ;; point will end up before it rather than after it.
6923 ;; Now do justification, if required
6928 ;; If making the new line didn't reduce the hpos of
6929 ;; the end of the line, then give up now;
6930 ;; trying again will not help.
6933 ;; Justify last line.
6935 t)))
6938 "Mode-specific function which line breaks and continues a comment.
6939 This function is called during auto-filling when a comment syntax
6940 is defined.
6941 The function should take a single optional argument, which is a flag
6945 "Break line at point and indent.
6946 If a comment syntax is defined, call `comment-indent-new-line'.
6948 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6949 unless optional argument SOFT is non-nil."
6953 ;; Insert the newline before removing empty space so that markers
6954 ;; get preserved better.
6960 ;; Blindly trust a non-adaptive fill-prefix.
6966 ;; If there's an adaptive prefix, use it unless we're inside
6967 ;; a comment and the prefix is not a comment starter.
6971 ;; If we're not inside a comment, just try to indent.
6975 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6979 ;; `functions' and `hooks' are usually unsafe to set, but setting
6980 ;; auto-fill-function to nil in a file-local setting is safe and
6981 ;; can be useful to prevent auto-filling.
6985 "Toggle automatic line breaking (Auto Fill mode).
6986 With a prefix argument ARG, enable Auto Fill mode if ARG is
6987 positive, and disable it otherwise. If called from Lisp, enable
6988 the mode if ARG is omitted or nil.
6990 When Auto Fill mode is enabled, inserting a space at a column
6991 beyond `current-fill-column' automatically breaks the line at a
6992 previous space.
6994 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6995 non-nil.
6997 The value of `normal-auto-fill-function' specifies the function to use
6998 for `auto-fill-function' when turning Auto Fill mode on."
7003 ;; This holds a document string used to document auto-fill-mode.
7005 "Automatically break line at a previous space, in insertion of text."
7006 nil)
7009 "Unconditionally turn on Auto Fill mode."
7013 "Unconditionally turn off Auto Fill mode."
7019 "Set `fill-column' to specified argument.
7024 ;; We used to use current-column silently, but C-x f is too easily
7025 ;; typed as a typo for C-x C-f, so we turned it into an error and
7026 ;; now an interactive prompt.
7031 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7035 \f
7037 "Set `selective-display' to ARG; clear it if no arg.
7038 When the value of `selective-display' is a number > 0,
7039 lines whose indentation is >= that value are not displayed.
7040 The variable `selective-display' has a separate value for each buffer."
7060 "Toggle truncating of long lines for the current buffer.
7061 When truncating is off, long lines are folded.
7062 With prefix argument ARG, truncate long lines if ARG is positive,
7063 otherwise fold them. Note that in side-by-side windows, this
7064 command has no effect if `truncate-partial-width-windows' is
7065 non-nil."
7077 nil t)))
7082 "Toggle whether to use word-wrapping for continuation lines.
7083 With prefix argument ARG, wrap continuation lines at word boundaries
7084 if ARG is positive, otherwise wrap them at the right screen edge.
7085 This command toggles the value of `word-wrap'. It has no effect
7086 if long lines are truncated."
7102 "Toggle Overwrite mode.
7103 With a prefix argument ARG, enable Overwrite mode if ARG is
7104 positive, and disable it otherwise. If called from Lisp, enable
7105 the mode if ARG is omitted or nil.
7107 When Overwrite mode is enabled, printing characters typed in
7108 replace existing text on a one-for-one basis, rather than pushing
7109 it to the right. At the end of a line, such characters extend
7110 the line. Before a tab, such characters insert until the tab is
7112 overwrite mode; this is supposed to make it easier to insert
7113 characters when necessary."
7118 "Toggle Binary Overwrite mode.
7119 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7120 is positive, and disable it otherwise. If called from Lisp,
7121 enable the mode if ARG is omitted or nil.
7123 When Binary Overwrite mode is enabled, printing characters typed
7124 in replace existing text. Newlines are not treated specially, so
7125 typing at the end of a line joins the line to the next, with the
7126 typed character between them. Typing before a tab character
7127 simply replaces the tab with the character typed.
7129 ordinary typing characters do.
7131 Note that Binary Overwrite mode is not its own minor mode; it is
7132 a specialization of overwrite mode, entered by setting the
7133 `overwrite-mode' variable to `overwrite-mode-binary'."
7138 "Toggle line number display in the mode line (Line Number mode).
7139 With a prefix argument ARG, enable Line Number mode if ARG is
7140 positive, and disable it otherwise. If called from Lisp, enable
7141 the mode if ARG is omitted or nil.
7143 Line numbers do not appear for very large buffers and buffers
7144 with very long lines; see variables `line-number-display-limit'
7145 and `line-number-display-limit-width'."
7149 "Toggle column number display in the mode line (Column Number mode).
7150 With a prefix argument ARG, enable Column Number mode if ARG is
7151 positive, and disable it otherwise.
7153 If called from Lisp, enable the mode if ARG is omitted or nil."
7157 "Toggle buffer size display in the mode line (Size Indication mode).
7158 With a prefix argument ARG, enable Size Indication mode if ARG is
7159 positive, and disable it otherwise.
7161 If called from Lisp, enable the mode if ARG is omitted or nil."
7165 "Toggle auto-saving in the current buffer (Auto Save mode).
7166 With a prefix argument ARG, enable Auto Save mode if ARG is
7167 positive, and disable it otherwise.
7169 If called from Lisp, enable the mode if ARG is omitted or nil."
7171 ;; If auto-save is off because buffer has shrunk,
7172 ;; then toggling should turn it on.
7180 buffer-file-name)
7182 ;; If -1 was stored here, to temporarily turn off saving,
7183 ;; turn it back on.
7186 \f
7188 "Blinking matching of parens and expressions."
7193 "Non-nil means show matching open-paren when close-paren is inserted.
7194 If t, highlight the paren. If `jump', briefly move cursor to its
7195 position. If `jump-offscreen', move cursor there even if the
7196 position is off screen. With any other non-nil value, the
7197 off-screen position of the opening paren will be shown in the
7198 echo area."
7207 "Non-nil means show matching open-paren when it is on screen.
7208 If nil, don't show it (but the open-paren can still be shown
7209 in the echo area when it is off screen).
7211 This variable has no effect if `blink-matching-paren' is nil.
7212 \(In that case, the open-paren is never shown.)
7213 It is also ignored if `show-paren-mode' is enabled."
7218 "If non-nil, maximum distance to search backwards for matching open-paren.
7219 If nil, search stops at the beginning of the accessible portion of the buffer."
7225 "Time in seconds to delay after showing a matching paren."
7230 "If nil, `blink-matching-paren' ignores comments.
7231 More precisely, when looking for the matching parenthesis,
7232 it skips the contents of comments that end before point."
7237 "Return whether or not START...END are matching parens.
7238 END is the current point and START is the blink position.
7239 START might be nil if no matching starter was found.
7240 Returns non-nil if we find there is a mismatch."
7245 ;; For self-matched chars like " and $, we can't know when they're
7246 ;; mismatched or unmatched, so we can only do it for parens.
7251 ;; The cdr might hold a new paren-class info rather than
7252 ;; a matching-char info, in which case the two CDRs
7253 ;; should match.
7257 "Function to check parentheses mismatches.
7258 The function takes two arguments (START and END) where START is the
7259 position just before the opening token and END is the position right after.
7260 START can be nil, if it was not found.
7267 ol)
7271 "Momentarily highlight the beginning of the sexp before point."
7274 blink-matching-paren)
7284 oldpos))
7292 ;; backward-sexp skips backward over prefix chars,
7293 ;; so move back to the matching paren.
7316 ;; Matching open within window, temporarily move to or highlight
7317 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7318 ;; is non-nil.
7335 ;; Show what precedes the open in its line, if anything.
7340 ;; Show what follows the open in its line, if anything.
7347 ;; Otherwise show the previous nonblank line,
7348 ;; if there is one.
7357 ;; Replace the newline and other whitespace with `...'.
7358 "..."
7360 ;; There is nothing to show except the char itself.
7363 "Matches %s"
7367 "Function called, if non-nil, whenever a close parenthesis is inserted.
7373 blink-paren-function
7376 ;; Verify an even number of quoting characters precede the close.
7377 ;; FIXME: Also check if this parenthesis closes a comment as
7378 ;; can happen in Pascal and SML.
7389 ;; Most likely, this hook is nil, so this arg doesn't matter,
7390 ;; but I use it as a reminder that this function usually
7391 ;; likes to be run after others since it does
7392 ;; `sit-for'. That's also the reason it get a `priority' prop
7393 ;; of 100.
7395 \f
7396 ;; This executes C-g typed while Emacs is waiting for a command.
7397 ;; Quitting out of a program does not go through here;
7398 ;; that happens in the QUIT macro at the C code level.
7400 "Signal a `quit' condition.
7401 During execution of Lisp code, this character causes a quit directly.
7402 At top-level, as an editor command, this simply beeps."
7404 ;; Avoid adding the region to the window selection.
7412 ;; Force the next redisplay cycle to remove the "Def" indicator from
7413 ;; all the mode lines.
7427 This command can exit an interactive command such as `query-replace',
7428 can clear out a prefix argument or a region,
7429 can get out of the minibuffer or other recursive edit,
7430 cancel the use of the current buffer (for special-purpose buffers),
7431 or go back to just one window (by deleting all but the selected window)."
7439 nil)
7450 "Play sound stored in FILE.
7451 VOLUME and DEVICE correspond to the keywords of the sound
7452 specification for `play-sound'."
7462 \f
7464 "Your preference for a mail reading package.
7465 This is used by some keybindings which support reading mail.
7466 See also `mail-user-agent' concerning sending mail."
7476 "Your preference for a mail composition package.
7477 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7478 outgoing email message. This variable lets you specify which
7479 mail-sending package you prefer.
7481 Valid values include:
7483 `message-user-agent' -- use the Message package.
7484 See Info node `(message)'.
7485 `sendmail-user-agent' -- use the Mail package.
7486 See Info node `(emacs)Sending Mail'.
7487 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7488 See Info node `(mh-e)'.
7489 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7490 paraphernalia if Gnus is running, particularly
7491 the Gcc: header for archiving.
7493 Additional valid symbols may be available; check with the author of
7494 your package for details. The function should return non-nil if it
7495 succeeds.
7497 See also `read-mail-command' concerning reading mail."
7500 message-user-agent)
7503 sendmail-user-agent)
7506 mh-e-user-agent)
7509 gnus-user-agent)
7515 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7516 If the value of `mail-user-agent' is the default, and the user
7517 appears to have customizations applying to the old default,
7518 `compose-mail' issues a warning."
7524 "If the buffer starts with a mail header, move point to the header's end.
7525 Otherwise, moves to `point-min'.
7526 The end of the header is the start of the next line, if there is one,
7527 else the end of the last line. This function obeys RFC822."
7533 ;; Used by Rmail (e.g., rmail-forward).
7535 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7539 switch-function yank-action send-actions
7540 return-action)
7541 "Start composing a mail message to send.
7542 This uses the user's chosen mail composition package
7543 as selected with the variable `mail-user-agent'.
7544 The optional arguments TO and SUBJECT specify recipients
7545 and the initial Subject field, respectively.
7547 OTHER-HEADERS is an alist specifying additional
7548 header fields. Elements look like (HEADER . VALUE) where both
7549 HEADER and VALUE are strings.
7551 CONTINUE, if non-nil, says to continue editing a message already
7552 being composed. Interactively, CONTINUE is the prefix argument.
7554 SWITCH-FUNCTION, if non-nil, is a function to use to
7555 switch to and display the buffer used for mail composition.
7557 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7558 to insert the raw text of the message being replied to.
7559 It has the form (FUNCTION . ARGS). The user agent will apply
7560 FUNCTION to ARGS, to insert the raw text of the original message.
7561 \(The user agent will also run `mail-citation-hook', *after* the
7562 original text has been inserted in this way.)
7564 SEND-ACTIONS is a list of actions to call when the message is sent.
7565 Each action has the form (FUNCTION . ARGS).
7567 RETURN-ACTION, if non-nil, is an action for returning to the
7568 caller. It has the form (FUNCTION . ARGS). The function is
7569 called after the mail has been sent or put aside, and the mail
7570 buffer buried."
7574 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7575 ;; from sendmail-user-agent to message-user-agent. Some users may
7576 ;; encounter incompatibilities. This hack tries to detect problems
7577 ;; and warn about them.
7582 mail-yank-hooks mail-archive-file-name
7583 mail-default-reply-to mail-mailing-lists
7584 mail-self-blind))
7591 The default mail mode is now Message mode.
7592 You have the following Mail mode variable%s customized:
7594 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7601 yank-action send-actions return-action)))
7604 yank-action send-actions
7605 return-action)
7609 'switch-to-buffer-other-window yank-action send-actions
7610 return-action))
7613 yank-action send-actions
7614 return-action)
7618 'switch-to-buffer-other-frame yank-action send-actions
7619 return-action))
7621 \f
7623 "History of values entered with `set-variable'.
7625 Maximum length of the history list is determined by the value
7629 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7630 VARIABLE should be a user option variable name, a Lisp variable
7631 meant to be customized by users. You should enter VALUE in Lisp syntax,
7632 so if you want VALUE to be a string, you must surround it with doublequotes.
7633 VALUE is used literally, not evaluated.
7635 If VARIABLE has a `variable-interactive' property, that is used as if
7636 it were the arg to `interactive' (which see) to interactively read VALUE.
7638 If VARIABLE has been defined with `defcustom', then the type information
7639 in the definition is used to check that VALUE is valid.
7641 Note that this function is at heart equivalent to the basic `set' function.
7642 For a variable defined with `defcustom', it does not pay attention to
7643 any :set property that the variable might have (if you want that, use
7646 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7651 default-var)
7667 var obsolete)
7670 ;; Use VAR's `variable-interactive' property
7671 ;; as an interactive spec for prompting.
7674 arg))
7676 read-expression-map t
7677 'set-variable-value-history
7686 ;; Match with custom type.
7698 ;; Force a thorough redisplay for the case that the variable
7699 ;; has an effect on the display, like `tab-width' has.
7701 \f
7702 ;; Define the major mode for lists of completions.
7712 (define-key map [right] 'next-completion)
7714 (define-key map [backtab] 'previous-completion)
7715 (define-key map "q" 'quit-window)
7716 (define-key map "z" 'kill-this-buffer)
7717 map)
7718 "Local map for completion list buffers.")
7720 ;; Completion mode is suitable only for specially formatted data.
7721 (put 'completion-list-mode 'mode-class 'special)
7723 (defvar completion-reference-buffer nil
7724 "Record the buffer that was current when the completion list was requested.
7725 This is a local variable in the completion list buffer.
7726 Initial value is nil to avoid some compiler warnings.")
7728 (defvar completion-no-auto-exit nil
7729 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7730 This also applies to other functions such as `choose-completion'.")
7732 (defvar completion-base-position nil
7733 "Position of the base of the text corresponding to the shown completions.
7734 This variable is used in the *Completions* buffers.
7735 Its value is a list of the form (START END) where START is the place
7736 where the completion should be inserted and END (if non-nil) is the end
7737 of the text to replace. If END is nil, point is used instead.")
7739 (defvar completion-list-insert-choice-function #'completion--replace
7740 "Function to use to insert the text chosen in *Completions*.
7741 Called with three arguments (BEG END TEXT), it should replace the text
7742 between BEG and END with TEXT. Expected to be set buffer-locally
7743 in the *Completions* buffer.")
7745 (defvar completion-base-size nil
7746 "Number of chars before point not involved in completion.
7747 This is a local variable in the completion list buffer.
7748 It refers to the chars in the minibuffer if completing in the
7749 minibuffer, or in `completion-reference-buffer' otherwise.
7750 Only characters in the field at point are included.
7752 If nil, Emacs determines which part of the tail end of the
7753 buffer's text is involved in completion by comparing the text
7754 directly.")
7755 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7757 (defun delete-completion-window ()
7758 "Delete the completion list window.
7759 Go to the window from which completion was requested."
7760 (interactive)
7761 (let ((buf completion-reference-buffer))
7762 (if (one-window-p t)
7763 (if (window-dedicated-p) (delete-frame))
7764 (delete-window (selected-window))
7765 (if (get-buffer-window buf)
7766 (select-window (get-buffer-window buf))))))
7768 (defun previous-completion (n)
7769 "Move to the previous item in the completion list."
7770 (interactive "p")
7771 (next-completion (- n)))
7773 (defun next-completion (n)
7774 "Move to the next item in the completion list.
7775 With prefix argument N, move N items (negative N means move backward)."
7776 (interactive "p")
7777 (let ((beg (point-min)) (end (point-max)))
7778 (while (and (> n 0) (not (eobp)))
7779 ;; If in a completion, move to the end of it.
7780 (when (get-text-property (point) 'mouse-face)
7781 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7782 ;; Move to start of next one.
7783 (unless (get-text-property (point) 'mouse-face)
7784 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7785 (setq n (1- n)))
7786 (while (and (< n 0) (not (bobp)))
7787 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7788 ;; If in a completion, move to the start of it.
7789 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7790 (goto-char (previous-single-property-change
7791 (point) 'mouse-face nil beg)))
7792 ;; Move to end of the previous completion.
7793 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7794 (goto-char (previous-single-property-change
7795 (point) 'mouse-face nil beg)))
7796 ;; Move to the start of that one.
7797 (goto-char (previous-single-property-change
7798 (point) 'mouse-face nil beg))
7799 (setq n (1+ n))))))
7801 (defun choose-completion (&optional event)
7802 "Choose the completion at point.
7803 If EVENT, use EVENT's position to determine the starting position."
7804 (interactive (list last-nonmenu-event))
7805 ;; In case this is run via the mouse, give temporary modes such as
7806 ;; isearch a chance to turn off.
7807 (run-hooks 'mouse-leave-buffer-hook)
7808 (with-current-buffer (window-buffer (posn-window (event-start event)))
7809 (let ((buffer completion-reference-buffer)
7810 (base-size completion-base-size)
7811 (base-position completion-base-position)
7812 (insert-function completion-list-insert-choice-function)
7813 (choice
7814 (save-excursion
7815 (goto-char (posn-point (event-start event)))
7816 (let (beg end)
7817 (cond
7818 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7819 (setq end (point) beg (1+ (point))))
7820 ((and (not (bobp))
7821 (get-text-property (1- (point)) 'mouse-face))
7822 (setq end (1- (point)) beg (point)))
7823 (t (error "No completion here")))
7824 (setq beg (previous-single-property-change beg 'mouse-face))
7825 (setq end (or (next-single-property-change end 'mouse-face)
7826 (point-max)))
7827 (buffer-substring-no-properties beg end)))))
7829 (unless (buffer-live-p buffer)
7830 (error "Destination buffer is dead"))
7831 (quit-window nil (posn-window (event-start event)))
7833 (with-current-buffer buffer
7834 (choose-completion-string
7835 choice buffer
7836 (or base-position
7837 (when base-size
7838 ;; Someone's using old completion code that doesn't know
7839 ;; about base-position yet.
7840 (list (+ base-size (field-beginning))))
7841 ;; If all else fails, just guess.
7842 (list (choose-completion-guess-base-position choice)))
7843 insert-function)))))
7845 ;; Delete the longest partial match for STRING
7846 ;; that can be found before POINT.
7847 (defun choose-completion-guess-base-position (string)
7848 (save-excursion
7849 (let ((opoint (point))
7850 len)
7851 ;; Try moving back by the length of the string.
7852 (goto-char (max (- (point) (length string))
7853 (minibuffer-prompt-end)))
7854 ;; See how far back we were actually able to move. That is the
7855 ;; upper bound on how much we can match and delete.
7856 (setq len (- opoint (point)))
7857 (if completion-ignore-case
7858 (setq string (downcase string)))
7859 (while (and (> len 0)
7860 (let ((tail (buffer-substring (point) opoint)))
7861 (if completion-ignore-case
7862 (setq tail (downcase tail)))
7863 (not (string= tail (substring string 0 len)))))
7864 (setq len (1- len))
7865 (forward-char 1))
7866 (point))))
7868 (defun choose-completion-delete-max-match (string)
7869 (declare (obsolete choose-completion-guess-base-position "23.2"))
7870 (delete-region (choose-completion-guess-base-position string) (point)))
7872 (defvar choose-completion-string-functions nil
7873 "Functions that may override the normal insertion of a completion choice.
7874 These functions are called in order with three arguments:
7875 CHOICE - the string to insert in the buffer,
7876 BUFFER - the buffer in which the choice should be inserted,
7877 BASE-POSITION - where to insert the completion.
7879 If a function in the list returns non-nil, that function is supposed
7880 to have inserted the CHOICE in the BUFFER, and possibly exited
7881 the minibuffer; no further functions will be called.
7883 If all functions in the list return nil, that means to use
7884 the default method of inserting the completion in BUFFER.")
7886 (defun choose-completion-string (choice &optional
7887 buffer base-position insert-function)
7888 "Switch to BUFFER and insert the completion choice CHOICE.
7889 BASE-POSITION says where to insert the completion.
7890 INSERT-FUNCTION says how to insert the completion and falls
7891 back on `completion-list-insert-choice-function' when nil."
7893 ;; If BUFFER is the minibuffer, exit the minibuffer
7894 ;; unless it is reading a file name and CHOICE is a directory,
7895 ;; or completion-no-auto-exit is non-nil.
7897 ;; Some older code may call us passing `base-size' instead of
7898 ;; `base-position'. It's difficult to make any use of `base-size',
7899 ;; so we just ignore it.
7900 (unless (consp base-position)
7901 (message "Obsolete `base-size' passed to choose-completion-string")
7902 (setq base-position nil))
7904 (let* ((buffer (or buffer completion-reference-buffer))
7905 (mini-p (minibufferp buffer)))
7906 ;; If BUFFER is a minibuffer, barf unless it's the currently
7907 ;; active minibuffer.
7908 (if (and mini-p
7909 (not (and (active-minibuffer-window)
7910 (equal buffer
7911 (window-buffer (active-minibuffer-window))))))
7912 (error "Minibuffer is not active for completion")
7913 ;; Set buffer so buffer-local choose-completion-string-functions works.
7914 (set-buffer buffer)
7915 (unless (run-hook-with-args-until-success
7916 'choose-completion-string-functions
7917 ;; The fourth arg used to be `mini-p' but was useless
7918 ;; (since minibufferp can be used on the `buffer' arg)
7919 ;; and indeed unused. The last used to be `base-size', so we
7920 ;; keep it to try and avoid breaking old code.
7921 choice buffer base-position nil)
7922 ;; This remove-text-properties should be unnecessary since `choice'
7923 ;; comes from buffer-substring-no-properties.
7924 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7925 ;; Insert the completion into the buffer where it was requested.
7926 (funcall (or insert-function completion-list-insert-choice-function)
7927 (or (car base-position) (point))
7928 (or (cadr base-position) (point))
7929 choice)
7930 ;; Update point in the window that BUFFER is showing in.
7931 (let ((window (get-buffer-window buffer t)))
7932 (set-window-point window (point)))
7933 ;; If completing for the minibuffer, exit it with this choice.
7934 (and (not completion-no-auto-exit)
7935 (minibufferp buffer)
7936 minibuffer-completion-table
7937 ;; If this is reading a file name, and the file name chosen
7938 ;; is a directory, don't exit the minibuffer.
7939 (let* ((result (buffer-substring (field-beginning) (point)))
7940 (bounds
7941 (completion-boundaries result minibuffer-completion-table
7942 minibuffer-completion-predicate
7943 "")))
7944 (if (eq (car bounds) (length result))
7945 ;; The completion chosen leads to a new set of completions
7946 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7947 (let ((mini (active-minibuffer-window)))
7948 (select-window mini)
7949 (when minibuffer-auto-raise
7950 (raise-frame (window-frame mini))))
7951 (exit-minibuffer))))))))
7953 (define-derived-mode completion-list-mode nil "Completion List"
7954 "Major mode for buffers showing lists of possible completions.
7956 to select the completion near point.
7957 Or click to select one with the mouse.
7960 (set (make-local-variable 'completion-base-size) nil))
7962 (defun completion-list-mode-finish ()
7963 "Finish setup of the completions buffer.
7964 Called from `temp-buffer-show-hook'."
7965 (when (eq major-mode 'completion-list-mode)
7966 (setq buffer-read-only t)))
7968 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7971 ;; Variables and faces used in `completion-setup-function'.
7973 (defcustom completion-show-help t
7974 "Non-nil means show help message in *Completions* buffer."
7975 :type 'boolean
7976 :version "22.1"
7977 :group 'completion)
7979 ;; This function goes in completion-setup-hook, so that it is called
7980 ;; after the text of the completion list buffer is written.
7981 (defun completion-setup-function ()
7982 (let* ((mainbuf (current-buffer))
7983 (base-dir
7984 ;; FIXME: This is a bad hack. We try to set the default-directory
7985 ;; in the *Completions* buffer so that the relative file names
7986 ;; displayed there can be treated as valid file names, independently
7987 ;; from the completion context. But this suffers from many problems:
7988 ;; - It's not clear when the completions are file names. With some
7989 ;; completion tables (e.g. bzr revision specs), the listed
7990 ;; completions can mix file names and other things.
7991 ;; - It doesn't pay attention to possible quoting.
7992 ;; - With fancy completion styles, the code below will not always
7993 ;; find the right base directory.
7994 (if minibuffer-completing-file-name
7995 (file-name-as-directory
7996 (expand-file-name
7997 (buffer-substring (minibuffer-prompt-end)
7998 (- (point) (or completion-base-size 0))))))))
7999 (with-current-buffer standard-output
8000 (let ((base-size completion-base-size) ;Read before killing localvars.
8001 (base-position completion-base-position)
8002 (insert-fun completion-list-insert-choice-function))
8003 (completion-list-mode)
8004 (set (make-local-variable 'completion-base-size) base-size)
8005 (set (make-local-variable 'completion-base-position) base-position)
8006 (set (make-local-variable 'completion-list-insert-choice-function)
8007 insert-fun))
8008 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8009 (if base-dir (setq default-directory base-dir))
8010 ;; Maybe insert help string.
8011 (when completion-show-help
8012 (goto-char (point-min))
8013 (if (display-mouse-p)
8015 (insert (substitute-command-keys
8019 (add-hook 'completion-setup-hook 'completion-setup-function)
8021 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8022 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8024 (defun switch-to-completions ()
8025 "Select the completion list window."
8026 (interactive)
8027 (let ((window (or (get-buffer-window "*Completions*" 0)
8028 ;; Make sure we have a completions window.
8029 (progn (minibuffer-completion-help)
8030 (get-buffer-window "*Completions*" 0)))))
8031 (when window
8032 (select-window window)
8033 ;; In the new buffer, go to the first completion.
8034 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8035 (when (bobp)
8036 (next-completion 1)))))
8037 \f
8038 ;;; Support keyboard commands to turn on various modifiers.
8040 ;; These functions -- which are not commands -- each add one modifier
8041 ;; to the following event.
8043 (defun event-apply-alt-modifier (_ignore-prompt)
8046 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8047 (defun event-apply-super-modifier (_ignore-prompt)
8050 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8051 (defun event-apply-hyper-modifier (_ignore-prompt)
8054 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8055 (defun event-apply-shift-modifier (_ignore-prompt)
8058 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8059 (defun event-apply-control-modifier (_ignore-prompt)
8062 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8063 (defun event-apply-meta-modifier (_ignore-prompt)
8066 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8068 (defun event-apply-modifier (event symbol lshiftby prefix)
8069 "Apply a modifier flag to event EVENT.
8070 SYMBOL is the name of this modifier, as a symbol.
8071 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8072 PREFIX is the string that represents this modifier in an event type symbol."
8073 (if (numberp event)
8074 (cond ((eq symbol 'control)
8075 (if (and (<= (downcase event) ?z)
8076 (>= (downcase event) ?a))
8077 (- (downcase event) ?a -1)
8078 (if (and (<= (downcase event) ?Z)
8079 (>= (downcase event) ?A))
8080 (- (downcase event) ?A -1)
8081 (logior (lsh 1 lshiftby) event))))
8082 ((eq symbol 'shift)
8083 (if (and (<= (downcase event) ?z)
8084 (>= (downcase event) ?a))
8085 (upcase event)
8086 (logior (lsh 1 lshiftby) event)))
8087 (t
8088 (logior (lsh 1 lshiftby) event)))
8089 (if (memq symbol (event-modifiers event))
8090 event
8091 (let ((event-type (if (symbolp event) event (car event))))
8092 (setq event-type (intern (concat prefix (symbol-name event-type))))
8093 (if (symbolp event)
8094 event-type
8095 (cons event-type (cdr event)))))))
8097 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8098 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8099 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8100 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8101 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8102 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8103 \f
8104 ;;;; Keypad support.
8106 ;; Make the keypad keys act like ordinary typing keys. If people add
8107 ;; bindings for the function key symbols, then those bindings will
8108 ;; override these, so this shouldn't interfere with any existing
8109 ;; bindings.
8111 ;; Also tell read-char how to handle these keys.
8112 (mapc
8113 (lambda (keypad-normal)
8114 (let ((keypad (nth 0 keypad-normal))
8115 (normal (nth 1 keypad-normal)))
8116 (put keypad 'ascii-character normal)
8117 (define-key function-key-map (vector keypad) (vector normal))))
8118 ;; See also kp-keys bound in bindings.el.
8119 '((kp-space ?\s)
8122 (kp-separator ?,)
8123 (kp-equal ?=)
8124 ;; Do the same for various keys that are represented as symbols under
8125 ;; GUIs but naturally correspond to characters.
8126 (backspace 127)
8127 (delete 127)
8130 (clear ?\C-l)
8131 (return ?\C-m)
8132 (escape ?\e)
8133 ))
8134 \f
8135 ;;;;
8136 ;;;; forking a twin copy of a buffer.
8137 ;;;;
8139 (defvar clone-buffer-hook nil
8140 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8142 (defvar clone-indirect-buffer-hook nil
8143 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8145 (defun clone-process (process &optional newname)
8146 "Create a twin copy of PROCESS.
8147 If NEWNAME is nil, it defaults to PROCESS' name;
8148 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8149 If PROCESS is associated with a buffer, the new process will be associated
8150 with the current buffer instead.
8151 Returns nil if PROCESS has already terminated."
8152 (setq newname (or newname (process-name process)))
8154 (setq newname (substring newname 0 (match-beginning 0))))
8155 (when (memq (process-status process) '(run stop open))
8156 (let* ((process-connection-type (process-tty-name process))
8157 (new-process
8158 (if (memq (process-status process) '(open))
8159 (let ((args (process-contact process t)))
8160 (setq args (plist-put args :name newname))
8161 (setq args (plist-put args :buffer
8162 (if (process-buffer process)
8163 (current-buffer))))
8164 (apply 'make-network-process args))
8165 (apply 'start-process newname
8166 (if (process-buffer process) (current-buffer))
8167 (process-command process)))))
8168 (set-process-query-on-exit-flag
8169 new-process (process-query-on-exit-flag process))
8170 (set-process-inherit-coding-system-flag
8171 new-process (process-inherit-coding-system-flag process))
8172 (set-process-filter new-process (process-filter process))
8173 (set-process-sentinel new-process (process-sentinel process))
8174 (set-process-plist new-process (copy-sequence (process-plist process)))
8175 new-process)))
8177 ;; things to maybe add (currently partly covered by `funcall mode'):
8178 ;; - syntax-table
8179 ;; - overlays
8180 (defun clone-buffer (&optional newname display-flag)
8181 "Create and return a twin copy of the current buffer.
8182 Unlike an indirect buffer, the new buffer can be edited
8183 independently of the old one (if it is not read-only).
8184 NEWNAME is the name of the new buffer. It may be modified by
8185 adding or incrementing <N> at the end as necessary to create a
8186 unique buffer name. If nil, it defaults to the name of the
8187 current buffer, with the proper suffix. If DISPLAY-FLAG is
8188 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8189 clone a file-visiting buffer, or a buffer whose major mode symbol
8190 has a non-nil `no-clone' property, results in an error.
8192 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8193 current buffer with appropriate suffix. However, if a prefix
8194 argument is given, then the command prompts for NEWNAME in the
8195 minibuffer.
8197 This runs the normal hook `clone-buffer-hook' in the new buffer
8198 after it has been set up properly in other respects."
8199 (interactive
8200 (progn
8201 (if buffer-file-name
8202 (error "Cannot clone a file-visiting buffer"))
8203 (if (get major-mode 'no-clone)
8204 (error "Cannot clone a buffer in %s mode" mode-name))
8205 (list (if current-prefix-arg
8206 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8207 t)))
8208 (if buffer-file-name
8209 (error "Cannot clone a file-visiting buffer"))
8210 (if (get major-mode 'no-clone)
8211 (error "Cannot clone a buffer in %s mode" mode-name))
8212 (setq newname (or newname (buffer-name)))
8214 (setq newname (substring newname 0 (match-beginning 0))))
8215 (let ((buf (current-buffer))
8216 (ptmin (point-min))
8217 (ptmax (point-max))
8218 (pt (point))
8219 (mk (if mark-active (mark t)))
8220 (modified (buffer-modified-p))
8221 (mode major-mode)
8222 (lvars (buffer-local-variables))
8223 (process (get-buffer-process (current-buffer)))
8224 (new (generate-new-buffer (or newname (buffer-name)))))
8225 (save-restriction
8226 (widen)
8227 (with-current-buffer new
8228 (insert-buffer-substring buf)))
8229 (with-current-buffer new
8230 (narrow-to-region ptmin ptmax)
8231 (goto-char pt)
8232 (if mk (set-mark mk))
8233 (set-buffer-modified-p modified)
8235 ;; Clone the old buffer's process, if any.
8236 (when process (clone-process process))
8238 ;; Now set up the major mode.
8239 (funcall mode)
8241 ;; Set up other local variables.
8242 (mapc (lambda (v)
8243 (condition-case () ;in case var is read-only
8244 (if (symbolp v)
8245 (makunbound v)
8246 (set (make-local-variable (car v)) (cdr v)))
8247 (error nil)))
8248 lvars)
8250 ;; Run any hooks (typically set up by the major mode
8251 ;; for cloning to work properly).
8252 (run-hooks 'clone-buffer-hook))
8253 (if display-flag
8254 ;; Presumably the current buffer is shown in the selected frame, so
8255 ;; we want to display the clone elsewhere.
8256 (let ((same-window-regexps nil)
8257 (same-window-buffer-names))
8258 (pop-to-buffer new)))
8259 new))
8262 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8263 "Create an indirect buffer that is a twin copy of the current buffer.
8265 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8266 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8267 or if not called with a prefix arg, NEWNAME defaults to the current
8268 buffer's name. The name is modified by adding a `<N>' suffix to it
8269 or by incrementing the N in an existing suffix. Trying to clone a
8270 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8271 property results in an error.
8273 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8274 This is always done when called interactively.
8276 Optional third arg NORECORD non-nil means do not put this buffer at the
8277 front of the list of recently selected ones.
8279 Returns the newly created indirect buffer."
8280 (interactive
8281 (progn
8282 (if (get major-mode 'no-clone-indirect)
8283 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8284 (list (if current-prefix-arg
8285 (read-buffer "Name of indirect buffer: " (current-buffer)))
8286 t)))
8287 (if (get major-mode 'no-clone-indirect)
8288 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8289 (setq newname (or newname (buffer-name)))
8291 (setq newname (substring newname 0 (match-beginning 0))))
8292 (let* ((name (generate-new-buffer-name newname))
8293 (buffer (make-indirect-buffer (current-buffer) name t)))
8294 (with-current-buffer buffer
8295 (run-hooks 'clone-indirect-buffer-hook))
8296 (when display-flag
8297 (pop-to-buffer buffer norecord))
8298 buffer))
8301 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8302 "Like `clone-indirect-buffer' but display in another window."
8303 (interactive
8304 (progn
8305 (if (get major-mode 'no-clone-indirect)
8306 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8307 (list (if current-prefix-arg
8308 (read-buffer "Name of indirect buffer: " (current-buffer)))
8309 t)))
8310 (let ((pop-up-windows t))
8311 (clone-indirect-buffer newname display-flag norecord)))
8313 \f
8314 ;;; Handling of Backspace and Delete keys.
8316 (defcustom normal-erase-is-backspace 'maybe
8317 "Set the default behavior of the Delete and Backspace keys.
8319 If set to t, Delete key deletes forward and Backspace key deletes
8320 backward.
8322 If set to nil, both Delete and Backspace keys delete backward.
8324 If set to `maybe' (which is the default), Emacs automatically
8325 selects a behavior. On window systems, the behavior depends on
8326 the keyboard used. If the keyboard has both a Backspace key and
8327 a Delete key, and both are mapped to their usual meanings, the
8328 option's default value is set to t, so that Backspace can be used
8329 to delete backward, and Delete can be used to delete forward.
8331 If not running under a window system, customizing this option
8332 accomplishes a similar effect by mapping C-h, which is usually
8333 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8334 via `keyboard-translate'. The former functionality of C-h is
8335 available on the F1 key. You should probably not use this
8336 setting if you don't have both Backspace, Delete and F1 keys.
8338 Setting this variable with setq doesn't take effect. Programmatically,
8339 call `normal-erase-is-backspace-mode' (which see) instead."
8340 :type '(choice (const :tag "Off" nil)
8341 (const :tag "Maybe" maybe)
8342 (other :tag "On" t))
8343 :group 'editing-basics
8344 :version "21.1"
8345 :set (lambda (symbol value)
8346 ;; The fboundp is because of a problem with :set when
8347 ;; dumping Emacs. It doesn't really matter.
8348 (if (fboundp 'normal-erase-is-backspace-mode)
8349 (normal-erase-is-backspace-mode (or value 0))
8350 (set-default symbol value))))
8352 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8353 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8354 (unless frame (setq frame (selected-frame)))
8355 (with-selected-frame frame
8356 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8357 (normal-erase-is-backspace-mode
8358 (if (if (eq normal-erase-is-backspace 'maybe)
8359 (and (not noninteractive)
8360 (or (memq system-type '(ms-dos windows-nt))
8361 (memq window-system '(w32 ns))
8362 (and (memq window-system '(x))
8363 (fboundp 'x-backspace-delete-keys-p)
8364 (x-backspace-delete-keys-p))
8365 ;; If the terminal Emacs is running on has erase char
8366 ;; set to ^H, use the Backspace key for deleting
8367 ;; backward, and the Delete key for deleting forward.
8368 (and (null window-system)
8369 (eq tty-erase-char ?\^H))))
8370 normal-erase-is-backspace)
8371 1 0)))))
8373 (define-minor-mode normal-erase-is-backspace-mode
8374 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8375 With a prefix argument ARG, enable this feature if ARG is
8376 positive, and disable it otherwise. If called from Lisp, enable
8377 the mode if ARG is omitted or nil.
8379 On window systems, when this mode is on, Delete is mapped to C-d
8380 and Backspace is mapped to DEL; when this mode is off, both
8381 Delete and Backspace are mapped to DEL. (The remapping goes via
8382 `local-function-key-map', so binding Delete or Backspace in the
8383 global or local keymap will override that.)
8385 In addition, on window systems, the bindings of C-Delete, M-Delete,
8386 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8387 the global keymap in accordance with the functionality of Delete and
8388 Backspace. For example, if Delete is remapped to C-d, which deletes
8389 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8390 to DEL, which deletes backward, C-Delete is bound to
8391 `backward-kill-word'.
8393 If not running on a window system, a similar effect is accomplished by
8394 remapping C-h (normally produced by the Backspace key) and DEL via
8395 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8396 to C-d; if it's off, the keys are not remapped.
8398 When not running on a window system, and this mode is turned on, the
8399 former functionality of C-h is available on the F1 key. You should
8400 probably not turn on this mode on a text-only terminal if you don't
8401 have both Backspace, Delete and F1 keys.
8403 See also `normal-erase-is-backspace'."
8404 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8405 . (lambda (v)
8406 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8407 (if v 1 0))))
8408 (let ((enabled (eq 1 (terminal-parameter
8409 nil 'normal-erase-is-backspace))))
8411 (cond ((or (memq window-system '(x w32 ns pc))
8412 (memq system-type '(ms-dos windows-nt)))
8413 (let ((bindings
8414 `(([M-delete] [M-backspace])
8415 ([C-M-delete] [C-M-backspace])
8416 ([?\e C-delete] [?\e C-backspace]))))
8418 (if enabled
8419 (progn
8420 (define-key local-function-key-map [delete] [deletechar])
8421 (define-key local-function-key-map [kp-delete] [deletechar])
8422 (define-key local-function-key-map [backspace] [?\C-?])
8423 (dolist (b bindings)
8424 ;; Not sure if input-decode-map is really right, but
8425 ;; keyboard-translate-table (used below) only works
8426 ;; for integer events, and key-translation-table is
8427 ;; global (like the global-map, used earlier).
8428 (define-key input-decode-map (car b) nil)
8429 (define-key input-decode-map (cadr b) nil)))
8430 (define-key local-function-key-map [delete] [?\C-?])
8431 (define-key local-function-key-map [kp-delete] [?\C-?])
8432 (define-key local-function-key-map [backspace] [?\C-?])
8433 (dolist (b bindings)
8434 (define-key input-decode-map (car b) (cadr b))
8435 (define-key input-decode-map (cadr b) (car b))))))
8436 (t
8437 (if enabled
8438 (progn
8439 (keyboard-translate ?\C-h ?\C-?)
8440 (keyboard-translate ?\C-? ?\C-d))
8441 (keyboard-translate ?\C-h ?\C-h)
8442 (keyboard-translate ?\C-? ?\C-?))))
8444 (if (called-interactively-p 'interactive)
8445 (message "Delete key deletes %s"
8446 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8447 "forward" "backward")))))
8448 \f
8449 (defvar vis-mode-saved-buffer-invisibility-spec nil
8450 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8452 (define-minor-mode read-only-mode
8453 "Change whether the current buffer is read-only.
8454 With prefix argument ARG, make the buffer read-only if ARG is
8455 positive, otherwise make it writable. If buffer is read-only
8456 and `view-read-only' is non-nil, enter view mode.
8458 Do not call this from a Lisp program unless you really intend to
8460 possibly enabling or disabling View mode. Also, note that this
8461 command works by setting the variable `buffer-read-only', which
8462 does not affect read-only regions caused by text properties. To
8463 ignore read-only status in a Lisp program (whether due to text
8464 properties or buffer state), bind `inhibit-read-only' temporarily
8465 to a non-nil value."
8466 :variable buffer-read-only
8467 (cond
8468 ((and (not buffer-read-only) view-mode)
8469 (View-exit-and-edit)
8470 (make-local-variable 'view-read-only)
8471 (setq view-read-only t)) ; Must leave view mode.
8472 ((and buffer-read-only view-read-only
8473 ;; If view-mode is already active, `view-mode-enter' is a nop.
8474 (not view-mode)
8475 (not (eq (get major-mode 'mode-class) 'special)))
8476 (view-mode-enter))))
8478 (define-minor-mode visible-mode
8479 "Toggle making all invisible text temporarily visible (Visible mode).
8480 With a prefix argument ARG, enable Visible mode if ARG is
8481 positive, and disable it otherwise. If called from Lisp, enable
8482 the mode if ARG is omitted or nil.
8484 This mode works by saving the value of `buffer-invisibility-spec'
8485 and setting it to nil."
8486 :lighter " Vis"
8487 :group 'editing-basics
8488 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8489 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8490 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8491 (when visible-mode
8492 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8493 buffer-invisibility-spec)
8494 (setq buffer-invisibility-spec nil)))
8495 \f
8496 (defvar messages-buffer-mode-map
8497 (let ((map (make-sparse-keymap)))
8498 (set-keymap-parent map special-mode-map)
8499 (define-key map "g" nil) ; nothing to revert
8500 map))
8502 (define-derived-mode messages-buffer-mode special-mode "Messages"
8505 (defun messages-buffer ()
8507 If it does not exist, create and it switch it to `messages-buffer-mode'."
8508 (or (get-buffer "*Messages*")
8509 (with-current-buffer (get-buffer-create "*Messages*")
8510 (messages-buffer-mode)
8511 (current-buffer))))
8513 \f
8514 ;; Minibuffer prompt stuff.
8516 ;;(defun minibuffer-prompt-modification (start end)
8517 ;; (error "You cannot modify the prompt"))
8518 ;;
8519 ;;
8520 ;;(defun minibuffer-prompt-insertion (start end)
8521 ;; (let ((inhibit-modification-hooks t))
8522 ;; (delete-region start end)
8523 ;; ;; Discard undo information for the text insertion itself
8524 ;; ;; and for the text deletion.above.
8525 ;; (when (consp buffer-undo-list)
8526 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8527 ;; (message "You cannot modify the prompt")))
8528 ;;
8529 ;;
8530 ;;(setq minibuffer-prompt-properties
8531 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8532 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8534 \f
8535 ;;;; Problematic external packages.
8537 ;; rms says this should be done by specifying symbols that define
8538 ;; versions together with bad values. This is therefore not as
8539 ;; flexible as it could be. See the thread:
8540 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8541 (defconst bad-packages-alist
8542 ;; Not sure exactly which semantic versions have problems.
8543 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8545 "The version of `semantic' loaded does not work in Emacs 22.
8546 It can cause constant high CPU load.
8547 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8548 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8549 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8550 ;; provided the `CUA-mode' feature. Since this is no longer true,
8551 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8552 (CUA-mode t nil
8553 "CUA-mode is now part of the standard GNU Emacs distribution,
8554 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8556 You have loaded an older version of CUA-mode which does not work
8557 correctly with this version of Emacs. You should remove the old
8558 version and use the one distributed with Emacs."))
8559 "Alist of packages known to cause problems in this version of Emacs.
8560 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8561 PACKAGE is either a regular expression to match file names, or a
8562 symbol (a feature name), like for `with-eval-after-load'.
8563 SYMBOL is either the name of a string variable, or t. Upon
8564 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8565 warning using STRING as the message.")
8567 (defun bad-package-check (package)
8568 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8569 (condition-case nil
8570 (let* ((list (assoc package bad-packages-alist))
8571 (symbol (nth 1 list)))
8572 (and list
8573 (boundp symbol)
8574 (or (eq symbol t)
8575 (and (stringp (setq symbol (eval symbol)))
8576 (string-match-p (nth 2 list) symbol)))
8577 (display-warning package (nth 3 list) :warning)))
8578 (error nil)))
8580 (dolist (elem bad-packages-alist)
8581 (let ((pkg (car elem)))
8582 (with-eval-after-load pkg
8583 (bad-package-check pkg))))
8585 \f
8586 ;;; Generic dispatcher commands
8588 ;; Macro `define-alternatives' is used to create generic commands.
8589 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8590 ;; that can have different alternative implementations where choosing
8591 ;; among them is exclusively a matter of user preference.
8593 ;; (define-alternatives COMMAND) creates a new interactive command
8594 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8595 ;; Typically, the user will not need to customize this variable; packages
8596 ;; wanting to add alternative implementations should use
8597 ;;
8598 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8600 (defmacro define-alternatives (command &rest customizations)
8601 "Define the new command `COMMAND'.
8603 The argument `COMMAND' should be a symbol.
8605 Running `M-x COMMAND RET' for the first time prompts for which
8606 alternative to use and records the selected command as a custom
8607 variable.
8609 Running `C-u M-x COMMAND RET' prompts again for an alternative
8610 and overwrites the previous choice.
8612 The variable `COMMAND-alternatives' contains an alist with
8613 alternative implementations of COMMAND. `define-alternatives'
8614 does not have any effect until this variable is set.
8616 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8617 `defcustom' keywords and values to add to the declaration of
8618 `COMMAND-alternatives' (typically :group and :version)."
8619 (let* ((command-name (symbol-name command))
8620 (varalt-name (concat command-name "-alternatives"))
8621 (varalt-sym (intern varalt-name))
8622 (varimp-sym (intern (concat command-name "--implementation"))))
8623 `(progn
8625 (defcustom ,varalt-sym nil
8626 ,(format "Alist of alternative implementations for the `%s' command.
8628 Each entry must be a pair (ALTNAME . ALTFUN), where:
8629 ALTNAME - The name shown at user to describe the alternative implementation.
8630 ALTFUN - The function called to implement this alternative."
8631 command-name)
8632 :type '(alist :key-type string :value-type function)
8633 ,@customizations)
8635 (put ',varalt-sym 'definition-name ',command)
8636 (defvar ,varimp-sym nil "Internal use only.")
8638 (defun ,command (&optional arg)
8639 ,(format "Run generic command `%s'.
8640 If used for the first time, or with interactive ARG, ask the user which
8641 implementation to use for `%s'. The variable `%s'
8642 contains the list of implementations currently supported for this command."
8643 command-name command-name varalt-name)
8644 (interactive "P")
8645 (when (or arg (null ,varimp-sym))
8646 (let ((val (completing-read
8647 ,(format-message
8648 "Select implementation for command `%s': "
8649 command-name)
8650 ,varalt-sym nil t)))
8651 (unless (string-equal val "")
8652 (when (null ,varimp-sym)
8653 (message
8654 "Use C-u M-x %s RET`to select another implementation"
8655 ,command-name)
8656 (sit-for 3))
8657 (customize-save-variable ',varimp-sym
8658 (cdr (assoc-string val ,varalt-sym))))))
8659 (if ,varimp-sym
8660 (call-interactively ,varimp-sym)
8661 (message "%s" ,(format-message
8662 "No implementation selected for command `%s'"
8663 command-name)))))))
8665 \f
8666 ;;; Functions for changing capitalization that Do What I Mean
8667 (defun upcase-dwim (arg)
8668 "Upcase words in the region, if active; if not, upcase word at point.
8669 If the region is active, this function calls `upcase-region'.
8670 Otherwise, it calls `upcase-word', with prefix argument passed to it
8671 to upcase ARG words."
8672 (interactive "*p")
8673 (if (use-region-p)
8674 (upcase-region (region-beginning) (region-end))
8675 (upcase-word arg)))
8677 (defun downcase-dwim (arg)
8678 "Downcase words in the region, if active; if not, downcase word at point.
8679 If the region is active, this function calls `downcase-region'.
8680 Otherwise, it calls `downcase-word', with prefix argument passed to it
8681 to downcase ARG words."
8682 (interactive "*p")
8683 (if (use-region-p)
8684 (downcase-region (region-beginning) (region-end))
8685 (downcase-word arg)))
8687 (defun capitalize-dwim (arg)
8688 "Capitalize words in the region, if active; if not, capitalize word at point.
8689 If the region is active, this function calls `capitalize-region'.
8690 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8691 to capitalize ARG words."
8692 (interactive "*p")
8693 (if (use-region-p)
8694 (capitalize-region (region-beginning) (region-end))
8695 (capitalize-word arg)))
8697 \f
8699 (provide 'simple)
8701 ;;; simple.el ends here