| blob | c7d3b2e6b0b6f6417f4d011278398bd575c35dd7 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2016 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "Idle time delay before updating various things on the screen.
42 Various Emacs features that update auxiliary information when point moves
43 wait this many seconds after Emacs becomes idle before doing an update."
49 "Killing and yanking commands."
53 "Highlight (un)matching of parens and expressions."
55 \f
56 ;;; next-error support framework
59 "`next-error' support framework."
65 "Face used to highlight next error locus."
70 "Highlighting of locations in selected source buffers.
71 If a number, highlight the locus in `next-error' face for the given time
72 in seconds, or until the next command is executed.
73 If t, highlight the locus until the next command is executed, or until
74 some other locus replaces it.
75 If nil, don't highlight the locus in the source buffer.
76 If `fringe-arrow', indicate the locus by the fringe arrow
77 indefinitely until some other locus replaces it."
86 "Highlighting of locations in `next-error-no-select'.
87 If number, highlight the locus in `next-error' face for given time in seconds.
88 If t, highlight the locus indefinitely until some other locus replaces it.
89 If nil, don't highlight the locus in the source buffer.
90 If `fringe-arrow', indicate the locus by the fringe arrow
91 indefinitely until some other locus replaces it."
100 "Display the line in the visited source file recentered as specified.
101 If non-nil, the value is passed directly to `recenter'."
109 "List of hook functions run by `next-error' after visiting source file."
120 "The most recent `next-error' buffer.
121 A buffer becomes most recent when its compilation, grep, or
126 "Function to use to find the next error in the current buffer.
127 The function is called with 2 parameters:
128 ARG is an integer specifying by how many errors to move.
129 RESET is a boolean which, if non-nil, says to go back to the beginning
130 of the errors before moving.
131 Major modes providing compile-like functionality should set this variable
132 to indicate to `next-error' that this is a candidate buffer and how
137 "Function to use to move to an error locus.
138 It takes two arguments, a buffer position in the error buffer
139 and a buffer position in the error locus buffer.
140 The buffer for the error locus should already be current.
145 &optional avoid-current
146 extra-test-inclusive
147 extra-test-exclusive)
148 "Return non-nil if BUFFER is a `next-error' capable buffer.
149 If AVOID-CURRENT is non-nil, and BUFFER is the current buffer,
150 return nil.
152 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if
153 BUFFER would not normally qualify. If it returns non-nil, BUFFER
154 is considered `next-error' capable, anyway, and the function
155 returns non-nil.
157 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the
158 buffer would normally qualify. If it returns nil, BUFFER is
159 rejected, and the function returns nil."
164 ;; Optionally reject some buffers.
167 t)
168 ;; Optionally accept some other buffers.
173 extra-test-inclusive
174 extra-test-exclusive)
175 "Return a `next-error' capable buffer.
177 If AVOID-CURRENT is non-nil, treat the current buffer
178 as an absolute last resort only.
180 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
181 that normally would not qualify. If it returns t, the buffer
182 in question is treated as usable.
184 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
185 that would normally be considered usable. If it returns nil,
186 that buffer is rejected."
188 ;; 1. If one window on the selected frame displays such buffer, return it.
194 avoid-current
195 extra-test-inclusive extra-test-exclusive)
200 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
203 extra-test-inclusive extra-test-exclusive))
204 next-error-last-buffer)
205 ;; 3. If the current buffer is acceptable, choose it.
207 extra-test-inclusive extra-test-exclusive)
209 ;; 4. Look for any acceptable buffer.
214 extra-test-inclusive extra-test-exclusive)))
217 ;; 5. Use the current buffer as a last resort if it qualifies,
218 ;; even despite AVOID-CURRENT.
221 extra-test-inclusive extra-test-exclusive)
225 ;; 6. Give up.
229 "Visit next `next-error' message and corresponding source code.
231 If all the error messages parsed so far have been processed already,
232 the message buffer is checked for new ones.
234 A prefix ARG specifies how many error messages to move;
235 negative means move back to previous error messages.
237 and start at the first error.
239 The RESET argument specifies that we should restart from the beginning.
242 compilation, grep, or occur buffer. It can also operate on any
244 more generally, on any buffer in Compilation mode or with
245 Compilation Minor mode enabled, or any buffer in which
246 `next-error-function' is bound to an appropriate function.
247 To specify use of a particular buffer for error messages, type
249 in the current frame.
252 runs `next-error-hook' with `run-hooks', and stays with that buffer
253 until you use it in some other buffer which uses Compilation mode
254 or Compilation Minor mode.
256 To control which errors are matched, customize the variable
257 `compilation-error-regexp-alist'."
261 ;; we know here that next-error-function is a valid symbol we can funcall
269 "Visit the source code corresponding to the `next-error' message at point."
271 ;; we know here that next-error-function is a valid symbol we can funcall
282 "Visit previous `next-error' message and corresponding source code.
284 Prefix arg N says how many error messages to move backwards (or
285 forwards, if negative).
292 "Restart at the first error.
293 Visit corresponding source code.
294 With prefix arg N, visit the source code of the Nth error.
300 "Move point to the next error in the `next-error' buffer and highlight match.
301 Prefix arg N says how many error messages to move forwards (or
302 backwards, if negative).
304 select the source buffer."
311 "Move point to the previous error in the `next-error' buffer and highlight match.
312 Prefix arg N says how many error messages to move backwards (or
313 forwards, if negative).
315 select the source buffer."
319 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
323 "Minor mode for compilation, occur and diff modes.
324 With a prefix argument ARG, enable mode if ARG is positive, and
325 disable it otherwise. If called from Lisp, enable mode if ARG is
326 omitted or nil.
327 When turned on, cursor motion in the compilation, grep, occur or diff
328 buffer causes automatic display of the corresponding source code location."
335 ;; Used as a `post-command-hook' by `next-error-follow-mode'
336 ;; for the *Compilation* *grep* and *Occur* buffers.
346 \f
347 ;;;
350 "Major mode not specialized for anything in particular.
351 Other major modes are defined by comparison with this one."
356 ;; Special major modes to view specially formatted data rather than files.
370 map))
374 "Parent major mode from which special major modes should inherit."
377 ;; Making and deleting lines.
380 "Special hook to tell if `self-insert-command' will use the region.
381 It must be called via `run-hook-with-args-until-success' with no arguments.
382 Any `post-self-insert-command' which consumes the region should
383 register a function on this hook so that things like `delete-selection-mode'
390 "Insert a newline, and move to left margin of the new line if it's blank.
391 If option `use-hard-newlines' is non-nil, the newline is marked with the
392 text-property `hard'.
393 With ARG, insert that many newlines.
395 If `electric-indent-mode' is enabled, this indents the final new line
396 that it adds, and reindents the preceding line. To just insert
399 Calls `auto-fill-function' if the current column number is greater
400 than the value of `fill-column' and ARG is nil.
401 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
404 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
405 ;; Set last-command-event to tell self-insert what to insert.
409 ;; Don't auto-fill if we have a numeric argument.
413 ;; Do the rest in post-self-insert-hook, because we want to do it
414 ;; *before* other functions on that hook.
416 ;; We are not going to insert any newlines if arg is
417 ;; non-positive.
420 ;; Mark the newline(s) `hard'.
424 ;; If the newline leaves the previous line blank, and we
425 ;; have a left margin, delete that from the blank line.
433 ;; Indent the line after the newline, except in one case:
434 ;; when we added the newline at the beginning of a line which
435 ;; starts a page.
440 ;; FIXME: For non-interactive uses, many calls actually
441 ;; just want (insert "\n"), so maybe we should do just
442 ;; that, so as to avoid the risk of filling or running
443 ;; abbrevs unexpectedly.
450 ;; We first used let-binding to protect the hook, but that
451 ;; was naive since add-hook affects the symbol-default
452 ;; value of the variable, whereas the let-binding might
453 ;; only protect the buffer-local value.
457 nil)
462 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
468 "Insert a newline and leave point before it.
469 If there is a fill prefix and/or a `left-margin', insert them on
470 the new line if the line would have been blank.
471 With arg N, insert N newlines."
476 ;; Don't expand an abbrev before point.
487 ;; Necessary in case a margin or prefix was inserted.
491 "Split current line, moving portion beyond point vertically down.
492 If the current line starts with `fill-prefix', insert it on the new
493 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
495 When called from Lisp code, ARG may be a prefix string to copy."
500 ;; What prefix should we check for (nil means don't).
504 ;; Does this line start with it?
515 "Join this line to previous and fix up whitespace at join.
516 If there is a fill prefix, delete it from the beginning of this line.
517 With argument, join this line to following line."
524 ;; If the second line started with the fill prefix,
525 ;; delete the prefix.
537 "On blank line, delete all surrounding blank lines, leaving just one.
538 On isolated blank line, delete that one.
539 On nonblank line, delete any immediately following blank lines."
545 ;; Set singleblank if there is just one blank line here.
552 ;; Delete preceding blank lines, and this one too if it's the only one.
561 ;; Delete following blank lines, unless the current line is blank
562 ;; and there are no following blank lines.
571 ;; Handle the special case where point is followed by newline and eob.
572 ;; Delete the line, leaving point at eob.
578 Trailing lines are deleted only if `delete-trailing-whitespace'
579 is called on the entire buffer (rather than an active region)."
585 "Delete trailing whitespace between START and END.
586 If called interactively, START and END are the start/end of the
587 region if the mark is active, or of the buffer's accessible
588 portion if the mark is inactive.
590 This command deletes whitespace characters after the last
591 non-whitespace character in each line between START and END. It
592 does not consider formfeed characters to be whitespace.
594 If this command acts on the entire buffer (i.e. if called
595 interactively with the mark inactive, or called from Lisp with
596 END nil), it also deletes all trailing lines at the end of the
597 buffer if the variable `delete-trailing-lines' is non-nil."
610 ;; Don't delete formfeeds, even if they are considered whitespace.
614 ;; Delete trailing empty lines.
617 delete-trailing-lines
618 ;; Really the end of buffer.
623 ;; Return nil for the benefit of `write-file-functions'.
624 nil)
627 "Insert a newline, then indent according to major mode.
628 Indentation is done using the value of `indent-line-function'.
629 In programming language modes, this is the same as TAB.
630 In some text modes, where TAB inserts a tab, this command indents to the
631 column specified by the function `current-left-margin'."
638 "Reindent current line, insert newline, then indent the new line.
639 Indentation of both lines is done according to the current major mode,
640 which means calling the current value of `indent-line-function'.
641 In programming language modes, this is the same as TAB.
642 In some text modes, where TAB inserts a tab, this indents to the
643 column specified by the function `current-left-margin'."
646 ;; Be careful to insert the newline before indenting the line.
647 ;; Otherwise, the indentation might be wrong.
651 ;; We are at EOL before the call to indent-according-to-mode, and
652 ;; after it we usually are as well, but not always. We tried to
653 ;; address it with `save-excursion' but that uses a normal marker
654 ;; whereas we need `move after insertion', so we do the save/restore
655 ;; by hand.
659 ;; Remove the trailing white-space after indentation because
660 ;; indentation may introduce the whitespace.
666 Legitimate radix values are 8, 10 and 16."
671 "Like `read-char', but do not allow quitting.
672 Also, if the first character read is an octal digit,
673 we read any number of octal digits and return the
674 specified character code. Any nondigit terminates the sequence.
675 If the terminator is RET, it is discarded;
676 any other terminator is used itself as input.
678 The optional argument PROMPT specifies a string to use to prompt the user.
679 The variable `read-quoted-char-radix' controls which radix to use
680 for numeric input."
683 help-event-list)))
687 ;; Don't let C-h or other help chars get the help
688 ;; message--only help function keys. See bug#16617.
692 "Type the special character you want to use,
693 or the octal character code.
694 RET terminates the character code and is discarded;
704 unread-command-events)
705 done t))
707 ;; Turn a meta-character into a character with the 0200 bit set.
709 done t))
725 unread-command-events)
726 done t))
728 done t)))
730 code))
733 "Read next input character and insert it.
734 This is useful for inserting control characters.
735 With argument, insert ARG copies of the character.
737 If the first character you type after this command is an octal digit,
738 you should type a sequence of octal digits which specify a character code.
739 Any nondigit terminates the sequence. If the terminator is a RET,
740 it is discarded; any other terminator is used itself as input.
741 The variable `read-quoted-char-radix' specifies the radix for this feature;
742 set it to 10 or 16 to use decimal or hex instead of octal.
744 In overwrite mode, this function inserts the character anyway, and
745 does not handle octal digits specially. This means that if you use
746 overwrite as your normal editing mode, you can use this function to
747 insert characters when necessary.
749 In binary overwrite mode, this function does overwrite, and octal
750 digits are interpreted as a character code. This is intended to be
751 useful for editing binary files."
754 ;; Avoid "obsolete" warnings for translation-table-for-input.
761 ;; This used to assume character codes 0240 - 0377 stand for
762 ;; characters in some single-byte character set, and converted them
763 ;; to Emacs characters. But in 23.1 this feature is deprecated
764 ;; in favor of inserting the corresponding Unicode characters.
765 ;; (if (and enable-multibyte-characters
766 ;; (>= char ?\240)
767 ;; (<= char ?\377))
768 ;; (setq char (unibyte-char-to-multibyte char)))
780 "Move forward ARG lines and position at first nonblank character."
786 "Move backward ARG lines and position at first nonblank character."
792 "Move point to the first non-whitespace character on this line."
796 ;; Move back over chars that have whitespace syntax but have the p flag.
800 "Fixup white space between objects around point.
801 Leave one space or none, according to the context."
808 nil
812 "Delete all spaces and tabs around point.
813 If BACKWARD-ONLY is non-nil, only delete them before point."
818 orig-pos
827 "Delete all spaces and tabs around point, leaving one space (or N spaces).
828 If N is negative, delete newlines as well, leaving -N spaces.
829 See also `cycle-spacing'."
834 "Store context used in consecutive calls to `cycle-spacing' command.
835 The first time `cycle-spacing' runs, it saves in this variable:
836 its N argument, the original point position, and the original spacing
840 "Manipulate whitespace around point in a smart way.
841 In interactive use, this function behaves differently in successive
842 consecutive calls.
844 The first call in a sequence acts like `just-one-space'.
845 It deletes all spaces and tabs around point, leaving one space
846 \(or N spaces). N is the prefix argument. If N is negative,
847 it deletes newlines as well, leaving -N spaces.
848 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
850 The second call in a sequence deletes all spaces.
852 The third call in a sequence restores the original whitespace (and point).
854 If MODE is `single-shot', it only performs the first step in the sequence.
855 If MODE is `fast' and the first step would not result in any change
856 \(i.e., there are exactly (abs N) spaces around point),
857 the function goes straight to the second step.
859 Repeatedly calling the function with different values of N starts a
860 new sequence each time."
868 ;; Command run for the first time, single-shot mode or different argument
880 ;; Special handling for case where there was no space at all.
883 ;; If this run causes no change in buffer content, delete all spaces,
884 ;; otherwise delete all excess spaces.
889 ;; Command run for the second time.
893 ;; Command run for the third time.
898 \f
900 "Move point to the beginning of the buffer.
901 With numeric arg N, put point N/10 of the way from the beginning.
902 If the buffer is narrowed, this command uses the beginning of the
903 accessible part of the buffer.
906 is supplied, or Transient Mark mode is enabled and the mark is active."
916 ;; Avoid overflow for large buffer sizes!
924 "Move point to the end of the buffer.
925 With numeric arg N, put point N/10 of the way from the end.
926 If the buffer is narrowed, this command uses the end of the
927 accessible part of the buffer.
930 is supplied, or Transient Mark mode is enabled and the mark is active."
938 ;; Avoid overflow for large buffer sizes!
943 ;; If we went to a place in the middle of the buffer,
944 ;; adjust it to the beginning of a line.
948 ;; If the end of the buffer is not already on the screen,
949 ;; then scroll specially to put it near, but not at, the bottom.
954 "Whether single-char deletion commands delete an active region.
955 This has an effect only if Transient Mark mode is enabled, and
956 affects `delete-forward-char' and `delete-backward-char', though
957 not `delete-char'.
959 If the value is the symbol `kill', the active region is killed
960 instead of deleted."
977 "Function to get the region's content.
978 Called with one argument DELETE.
979 If DELETE is `delete-only', then only delete the region and the return value
980 is undefined. If DELETE is nil, just return the content as a string.
981 If DELETE is `bounds', then don't delete, but just return the
982 boundaries of the region as a list of (START . END) positions.
983 If anything else, delete the region and return its content as a string,
994 first nil))))
995 "Function to insert the region's content.
996 Called with one argument LINES.
1000 "Delete the previous N characters (following if N is negative).
1001 If Transient Mark mode is enabled, the mark is active, and N is 1,
1002 delete the text in the region and deactivate the mark instead.
1003 To disable this, set option `delete-active-region' to nil.
1005 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1006 kill ring) instead of delete. Interactively, N is the prefix
1007 arg, and KILLFLAG is set if N is explicitly specified.
1009 When killing, the killed text is filtered by
1010 `filter-buffer-substring' before it is saved in the kill ring, so
1011 the actual saved text might be different from what was killed.
1013 In Overwrite mode, single character backward deletion may replace
1014 tabs with spaces so as to back over columns, unless point is at
1015 the end of the line."
1021 delete-active-region
1023 ;; If a region is active, kill or delete it.
1027 ;; In Overwrite mode, maybe untabify while deleting
1037 ;; Otherwise, do simple deletion.
1041 "Delete the following N characters (previous if N is negative).
1042 If Transient Mark mode is enabled, the mark is active, and N is 1,
1043 delete the text in the region and deactivate the mark instead.
1044 To disable this, set variable `delete-active-region' to nil.
1046 Optional second arg KILLFLAG non-nil means to kill (save in kill
1047 ring) instead of delete. Interactively, N is the prefix arg, and
1048 KILLFLAG is set if N was explicitly specified.
1050 When killing, the killed text is filtered by
1051 `filter-buffer-substring' before it is saved in the kill ring, so
1052 the actual saved text might be different from what was killed."
1058 delete-active-region
1060 ;; If a region is active, kill or delete it.
1065 ;; Otherwise, do simple deletion.
1069 "Put point at beginning and mark at end of buffer.
1070 If narrowing is in effect, only uses the accessible part of the buffer.
1071 You probably should not use this function in Lisp programs;
1072 it is usually a mistake for a Lisp function to use any subroutine
1073 that uses or sets the mark."
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 "If VALUE in an integer, return a specially formatted string.
1423 If VALUE is not an integer, nil is returned.
1424 This function is used by functions like `prin1' that display the
1425 result of expression evaluation."
1444 ;; FIXME: call emacs-lisp-mode?
1451 read-expression-map t
1454 ;; We define this, rather than making `eval' interactive,
1455 ;; for the sake of completion of names like eval-region, eval-buffer.
1457 "Evaluate EXP and print value in the echo area.
1458 When called interactively, read an Emacs Lisp expression and evaluate it.
1459 Value is also consed on to front of the variable `values'.
1460 If the resulting value is an integer, it will be printed in
1461 several additional formats (octal, hexadecimal, and character).
1462 Optional argument INSERT-VALUE non-nil (interactively, with
1463 prefix argument) means insert the result into the current buffer
1464 instead of printing it in the echo area.
1466 Normally, this function truncates long output according to the value
1467 of the variables `eval-expression-print-length' and
1468 `eval-expression-print-level'. With a prefix argument of zero,
1469 however, there is no such truncation.
1471 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1472 minibuffer.
1474 If `eval-expression-debug-on-error' is non-nil, which is the default,
1475 this command arranges for all errors to enter the debugger."
1478 current-prefix-arg))
1483 ;; Bind debug-on-error to something unique so that we can
1484 ;; detect when evalled code changes it.
1488 ;; If evalled code has changed the value of debug-on-error,
1489 ;; propagate that change to the global binding.
1494 eval-expression-print-length))
1496 eval-expression-print-level))
1512 "Prompting with PROMPT, let user edit COMMAND and eval result.
1513 COMMAND is a Lisp expression. Let user edit that expression in
1514 the minibuffer, then read and evaluate the result."
1521 read-expression-map t
1523 ;; If command was added to command-history as a string,
1524 ;; get rid of that. We want only evaluable expressions there.
1528 ;; If command to be redone does not match front of history,
1529 ;; add it to the history.
1535 "Edit and re-evaluate last complex command, or ARGth from last.
1536 A complex command is one which used the minibuffer.
1537 The command is placed in the minibuffer as a Lisp form for editing.
1538 The result is executed, repeating the command as changed.
1539 If the command has been changed or is not the most recent previous
1540 command it is added to the front of the command history.
1541 You can use the minibuffer history commands \
1543 to get different commands to edit and resubmit."
1546 newcmd)
1558 ;; If command was added to command-history as a
1559 ;; string, get rid of that. We want only
1560 ;; evaluable expressions there.
1564 ;; If command to be redone does not match front of history,
1565 ;; add it to the history.
1580 "Read command name to invoke in `execute-extended-command'."
1590 ;; Get a command name at point in the original buffer
1591 ;; to propose it after M-n.
1595 ;; Read a string, completing from and restricting to the set of
1596 ;; all defined commands. Don't provide any initial input.
1597 ;; Save the command read on the extended-command history list.
1608 ;; This isn't strictly correct if `execute-extended-command'
1609 ;; is bound to anything else (e.g. [menu]).
1610 ;; It could use (key-description (this-single-command-keys)),
1611 ;; but actually a prompt other than "M-x" would be confusing,
1612 ;; because "M-x" is a well-known prompt to read a command
1613 ;; and it serves as a shorthand for "Extended command: ".
1618 ;; Exclude obsolete commands from completions.
1623 pred)))
1628 "Non-nil means show the equivalent key-binding when M-x command has one.
1629 The value can be a length of time to show the message for.
1630 If the value is non-nil and not a number, we wait 2 seconds."
1652 binding)
1658 name len)))
1659 ;; Don't show the help message if the binding isn't
1660 ;; significantly shorter than the M-x command the user typed.
1667 binding))
1670 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1671 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1672 "Read a command name, then read the arguments and call the command.
1673 To pass a prefix argument to the command you are
1674 invoking, give a prefix argument to `execute-extended-command'."
1676 ;; FIXME: Remember the actual text typed by the user before completion,
1677 ;; so that we don't later on suggest the same shortening.
1682 execute-extended-command--last-typed)))
1683 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1696 ;; Normally `real-this-command' should never be changed, but here we really
1697 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1698 ;; binding" for <cmd>, so the command the user really wanted to run is
1699 ;; `function' and not `execute-extended-command'. The difference is
1700 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1704 ;; If enabled, show which key runs this command.
1705 ;; But first wait, and skip the message if there is input.
1707 ;; If this command displayed something in the echo area;
1708 ;; wait a few seconds, then display our suggestion message.
1709 ;; FIXME: Wait *after* running post-command-hook!
1710 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1711 ;; find a better answer anyway!
1720 ;; There's no binding for CMD. Let's try and find the shortest
1721 ;; string to use in M-x.
1722 ;; FIXME: Can be slow. Cache it maybe?
1729 function
1734 suggest-key-bindings
1738 ;; BEWARE: Called directly from the C code.
1739 "Execute CMD as an editor command.
1740 CMD must be a symbol that satisfies the `commandp' predicate.
1741 Optional second arg RECORD-FLAG non-nil
1742 means unconditionally put this command in the variable `command-history'.
1743 Otherwise, that is done only if an arg is read using the minibuffer.
1744 The argument KEYS specifies the value to use instead of (this-command-keys)
1745 when reading the arguments; if it is nil, (this-command-keys) is used.
1746 The argument SPECIAL, if non-nil, means that this command is executing
1747 a special event, so ignore the prefix argument and don't clear it."
1750 ;; FIXME: This should probably be done around
1751 ;; pre-command-hook rather than here!
1759 disabled-command-function)
1760 ;; FIXME: Weird calling convention!
1770 ;; If requested, place the macro in the command history. For
1771 ;; other sorts of commands, call-interactively takes care of this.
1774 ;; Don't keep command history around forever.
1780 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1788 \f
1790 "Default minibuffer history list.
1791 This is used for all minibuffer input
1792 except when an alternate history list is specified.
1794 Maximum length of the history list is determined by the value
1797 "Control whether history list elements are expressions or strings.
1798 If the value of this variable equals current minibuffer depth,
1799 they are expressions; otherwise they are strings.
1800 \(That convention is designed to do the right thing for
1807 "Text that was in this minibuffer before any history commands.
1808 This is nil if there have not yet been any history commands
1817 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1822 "Minibuffer history variables for which matching should ignore case.
1823 If a history variable is a member of this list, then the
1825 commands ignore case when searching it, regardless of `case-fold-search'."
1830 "Find the previous history element that matches REGEXP.
1831 \(Previous history elements refer to earlier actions.)
1832 With prefix argument N, search for Nth previous match.
1833 If N is negative, find the next or Nth next match.
1834 Normally, history elements are matched case-insensitively if
1835 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1836 makes the search case-sensitive.
1837 See also `minibuffer-history-case-insensitive-variables'."
1841 nil
1842 minibuffer-local-map
1843 nil
1844 'minibuffer-history-search-history
1846 ;; Use the last regexp specified, by default, if input is empty.
1851 regexp)
1861 ;; On some systems, ignore case for file names.
1863 minibuffer-history-case-insensitive-variables)
1864 t
1865 ;; Respect the user's setting for case-fold-search:
1866 case-fold-search)
1867 nil))
1868 prevpos
1869 match-string
1870 match-offset
1877 "No later matching history item"
1898 next-matching-history-element))
1902 "Find the next history element that matches REGEXP.
1903 \(The next history element refers to a more recent action.)
1904 With prefix argument N, search for Nth next match.
1905 If N is negative, find the previous or Nth previous match.
1906 Normally, history elements are matched case-insensitively if
1907 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1908 makes the search case-sensitive."
1912 nil
1913 minibuffer-local-map
1914 nil
1915 'minibuffer-history-search-history
1917 ;; Use the last regexp specified, by default, if input is empty.
1922 regexp)
1929 "Function run by `goto-history-element' before consuming default values.
1930 This is useful to dynamically add more elements to the list of default values
1931 when `goto-history-element' reaches the end of this list.
1932 Before calling this function `goto-history-element' sets the variable
1933 `minibuffer-default-add-done' to t, so it will call this function only
1934 once. In special cases, when this function needs to be called more
1935 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1939 "When nil, add more elements to the end of the list of default values.
1940 The value nil causes `goto-history-element' to add more elements to
1941 the list of defaults when it reaches the end of this list. It does
1947 "Return a list of all completions without the default value.
1948 This function is used to add all elements of the completion table to
1949 the end of the list of defaults just after the default value."
1952 minibuffer-completion-table
1953 minibuffer-completion-predicate)))
1959 "Puts element of the minibuffer history in the minibuffer.
1960 The argument NABS specifies the absolute history position."
1974 elt minibuffer-returned-to-present)
1981 "End of defaults; no next item"
1988 previous-history-element))
2000 minibuffer-default)))
2012 elt))
2016 "Puts next element of the minibuffer history in the minibuffer.
2017 With argument N, it uses the Nth following element."
2023 "Puts previous element of the minibuffer history in the minibuffer.
2024 With argument N, it uses the Nth previous element."
2030 "Move cursor vertically down ARG lines, or to the next history element.
2031 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2032 next element of the minibuffer history in the minibuffer."
2036 ;; Remember the original goal column of possibly multi-line input
2037 ;; excluding the length of the prompt on the first line.
2047 ;; Restore old position since `line-move-visual' moves point to
2048 ;; the end of the line when it fails to go to the next line.
2051 ;; Reset `temporary-goal-column' because a correct value is not
2052 ;; calculated when `next-line' above fails by bumping against
2053 ;; the bottom of the minibuffer (bug#22544).
2055 ;; Restore the original goal column on the last line
2056 ;; of possibly multi-line input.
2064 "Move cursor vertically up ARG lines, or to the previous history element.
2065 When point moves over the top line of multi-line minibuffer, puts ARGth
2066 previous element of the minibuffer history in the minibuffer."
2070 ;; Remember the original goal column of possibly multi-line input
2071 ;; excluding the length of the prompt on the first line.
2081 ;; Restore old position since `line-move-visual' moves point to
2082 ;; the beginning of the line when it fails to go to the previous line.
2085 ;; Reset `temporary-goal-column' because a correct value is not
2086 ;; calculated when `previous-line' above fails by bumping against
2087 ;; the top of the minibuffer (bug#22544).
2089 ;; Restore the original goal column on the first line
2090 ;; of possibly multi-line input.
2096 ;; Put the cursor at the end of the visual line instead of the
2097 ;; logical line, so the next `previous-line-or-history-element'
2098 ;; would move to the previous history element, not to a possible upper
2099 ;; visual line from the end of logical line in `line-move-visual' mode.
2101 ;; Since `end-of-visual-line' puts the cursor at the beginning
2102 ;; of the next visual line, move it one char back to the end
2103 ;; of the first visual line (bug#22544).
2107 "Get next history element which completes the minibuffer before the point.
2108 The contents of the minibuffer after the point are deleted, and replaced
2109 by the new completion."
2115 n)
2116 ;; next-matching-history-element always puts us at (point-min).
2117 ;; Move to the position we were at before changing the buffer contents.
2118 ;; This is still sensible, because the text before point has not changed.
2122 "\
2123 Get previous history element which completes the minibuffer before the point.
2124 The contents of the minibuffer after the point are deleted, and replaced
2125 by the new completion."
2129 ;; For compatibility with the old subr of the same name.
2131 "Return the display width of the minibuffer prompt.
2132 Return 0 if current buffer is not a minibuffer."
2133 ;; Return the width of everything before the field at the end of
2134 ;; the buffer; this should be 0 for normal buffers.
2136 \f
2137 ;; isearch minibuffer history
2144 "Set up a minibuffer for using isearch to search the minibuffer history.
2145 Intended to be added to `minibuffer-setup-hook'."
2157 "Clean up the minibuffer after terminating isearch in the minibuffer."
2162 "Return the proper search function, for isearch in minibuffer history."
2165 ;; Use standard functions to search within minibuffer text
2167 found)
2168 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2169 ;; searching forward. Lazy-highlight calls this lambda with the
2170 ;; bound arg, so skip the minibuffer prompt.
2174 ;; 1. First try searching in the initial minibuffer text
2177 noerror)
2178 ;; 2. If the above search fails, start putting next/prev history
2179 ;; elements in the minibuffer successively, and search the string
2180 ;; in them. Do this only when bound is nil (i.e. not while
2181 ;; lazy-highlighting search strings in the current minibuffer text).
2193 ;; After putting the next/prev history element, search
2194 ;; the string in them again, until next-history-element
2195 ;; or previous-history-element raises an error at the
2196 ;; beginning/end of history.
2199 ;; For backward search, don't search
2200 ;; in the minibuffer prompt
2202 noerror)))
2203 ;; Return point of the new search result
2205 ;; Return nil when next(prev)-history-element fails
2209 "Display the minibuffer history search prompt.
2210 If there are no search errors, this function displays an overlay with
2211 the isearch prompt which replaces the original minibuffer prompt.
2212 Otherwise, it displays the standard isearch message returned from
2213 the function `isearch-message'."
2215 ;; Use standard function `isearch-message' when not in the minibuffer,
2216 ;; or search fails, or has an error (like incomplete regexp).
2217 ;; This function overwrites minibuffer text with isearch message,
2218 ;; so it's possible to see what is wrong in the search string.
2220 ;; Otherwise, put the overlay with the standard isearch prompt over
2221 ;; the initial minibuffer prompt.
2230 ;; And clear any previous isearch message.
2234 "Wrap the minibuffer history search when search fails.
2235 Move point to the first history element for a forward search,
2236 or to the last history element for a backward search."
2237 ;; When `minibuffer-history-isearch-search' fails on reaching the
2238 ;; beginning/end of the history, wrap the search to the first/last
2239 ;; minibuffer history element.
2247 "Save a function restoring the state of minibuffer history search.
2248 Save `minibuffer-history-position' to the additional state parameter
2249 in the search status stack."
2255 "Restore the minibuffer history search state.
2256 Go to the history element by the absolute history position HIST-POS."
2259 \f
2260 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2264 "Table mapping redo records to the corresponding undo one.
2265 A redo record for undo-in-region maps to t.
2275 "Within a run of consecutive undo commands, list remaining to be undone.
2279 "Undo some previous changes.
2280 Repeat this command to undo more changes.
2281 A numeric ARG serves as a repeat count.
2283 In Transient Mark mode when the mark is active, only undo changes within
2285 as an argument limits undo to changes within the current region."
2287 ;; Make last-command indicate for the next command that this was an undo.
2288 ;; That way, another undo will undo more.
2289 ;; If we get to the end of the undo history and get an error,
2290 ;; another undo command will find the undo history empty
2291 ;; and will get another error. To begin undoing the undos,
2292 ;; you must type some other command.
2294 ;; For an indirect buffer, look in the base buffer for the
2295 ;; auto-save data.
2299 message)
2300 ;; If we get an error in undo-start,
2301 ;; the next command should not be a "consecutive undo".
2302 ;; So set `this-command' to something other than `undo'.
2307 ;; If something (a timer or filter?) changed the buffer
2308 ;; since the previous command, don't continue the undo seq.
2312 ;; If the last undo record made was made by undo
2313 ;; it shows nothing else happened in between.
2320 ;; get rid of initial undo boundary
2322 ;; If we got this far, the next command should be a consecutive undo.
2324 ;; Check to see whether we're hitting a redo record, and if
2325 ;; so, ask the user whether she wants to skip the redo/undo pair.
2333 ;; The equiv entry might point to another redo record if we have done
2334 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2342 ;; Record the fact that the just-generated undo records come from an
2343 ;; undo operation--that is, they are redo records.
2344 ;; In the ordinary case (not within a region), map the redo
2345 ;; record to the following undos.
2346 ;; I don't know how to do that in the undo-in-region case.
2348 ;; Strip any leading undo boundaries there might be, like we do
2349 ;; above when checking.
2353 ;; Prevent identity mapping. This can happen if
2354 ;; consecutive nils are erroneously in undo list.
2356 t
2357 pending-undo-list)
2358 undo-equiv-table))
2359 ;; Don't specify a position in the undo record for the undo command.
2360 ;; Instead, undoing this should move point to where the change is.
2379 ;; Record what the current undo list says,
2380 ;; so the next command can tell if the buffer was modified in between.
2384 ;; Display a message announcing success.
2389 "Make BUFFER stop keeping undo information.
2390 No argument or nil as argument means do this for the current buffer."
2396 "Undo some previous changes.
2397 Repeat this command to undo more changes.
2398 A numeric ARG serves as a repeat count.
2399 Contrary to `undo', this will not redo a previous undo."
2404 "Non-nil while performing an undo.
2408 "Undo back N undo-boundaries beyond what was already undone recently.
2409 Call `undo-start' to get ready to undo recent changes,
2410 then call `undo-more' one or more times to undo them."
2415 ;; Note: The following, while pulling elements off
2416 ;; `pending-undo-list' will call primitive change functions which
2417 ;; will push more elements onto `buffer-undo-list'.
2423 "Undo N records from the front of the list LIST.
2424 Return what remains of the list."
2426 ;; This is a good feature, but would make undo-start
2427 ;; unable to do what is expected.
2428 ;;(when (null (car (list)))
2429 ;; ;; If the head of the list is a boundary, it is the boundary
2430 ;; ;; preceding this command. Get rid of it and don't count it.
2431 ;; (setq list (cdr list))))
2434 ;; In a writable buffer, enable undoing read-only text that is
2435 ;; so because of text properties.
2437 ;; Don't let `intangible' properties interfere with undo.
2439 ;; We use oldlist only to check for EQ. ++kfs
2445 ;; Handle an integer by setting point to that value.
2448 ;; Element (t . TIME) records previous modtime.
2449 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2450 ;; UNKNOWN_MODTIME_NSECS.
2452 ;; If this records an obsolete save
2453 ;; (not matching the actual disk file)
2454 ;; then don't mark unmodified.
2462 ;; Element (nil PROP VAL BEG . END) is property change.
2467 ;; Element (BEG . END) means range was inserted.
2469 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2470 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2473 ;; Set point first thing, so that undoing this undo
2474 ;; does not send point back to where it is now.
2477 ;; Element (apply FUN . ARGS) means call FUN to undo.
2481 ;; Long format: (apply DELTA START END FUN . ARGS).
2488 ;; Check that the function did what the entry
2489 ;; said it would do.
2499 ;; Element (STRING . POS) means STRING was deleted.
2505 ;; Check that marker adjustments which were recorded
2506 ;; with the (STRING . POS) record are still valid, ie
2507 ;; the markers haven't moved. We check their validity
2508 ;; before reinserting the string so as we don't need to
2509 ;; mind marker insertion-type.
2517 ;; Insert string and adjust point
2525 ;; Adjust the valid marker adjustments
2529 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2532 next)
2533 ;; Even though these elements are not expected in the undo
2534 ;; list, adjust them to be conservative for the 24.4
2535 ;; release. (Bug#16818)
2542 ;; Make sure an apply entry produces at least one undo entry,
2543 ;; so the test in `undo' for continuing an undo series
2544 ;; will work right.
2549 list)
2551 ;; Deep copy of a list
2553 "Make a copy of undo list LIST."
2559 elt))
2562 "Set `pending-undo-list' to the front of the undo list.
2563 The next call to `undo-more' will undo the most recently made change.
2564 If BEG and END are specified, then only undo elements
2565 that apply to text between BEG and END are used; other undo elements
2566 are ignored. If BEG and END are nil, all undo elements are used."
2572 buffer-undo-list)))
2574 ;; The positions given in elements of the undo list are the positions
2575 ;; as of the time that element was recorded to undo history. In
2576 ;; general, subsequent buffer edits render those positions invalid in
2577 ;; the current buffer, unless adjusted according to the intervening
2578 ;; undo elements.
2579 ;;
2580 ;; Undo in region is a use case that requires adjustments to undo
2581 ;; elements. It must adjust positions of elements in the region based
2582 ;; on newer elements not in the region so as they may be correctly
2583 ;; applied in the current buffer. undo-make-selective-list
2584 ;; accomplishes this with its undo-deltas list of adjustments. An
2585 ;; example undo history from oldest to newest:
2586 ;;
2587 ;; buf pos:
2588 ;; 123456789 buffer-undo-list undo-deltas
2589 ;; --------- ---------------- -----------
2590 ;; aaa (1 . 4) (1 . -3)
2591 ;; aaba (3 . 4) N/A (in region)
2592 ;; ccaaba (1 . 3) (1 . -2)
2593 ;; ccaabaddd (7 . 10) (7 . -3)
2594 ;; ccaabdd ("ad" . 6) (6 . 2)
2595 ;; ccaabaddd (6 . 8) (6 . -2)
2596 ;; | |<-- region: "caab", from 2 to 6
2597 ;;
2598 ;; When the user starts a run of undos in region,
2599 ;; undo-make-selective-list is called to create the full list of in
2600 ;; region elements. Each element is adjusted forward chronologically
2601 ;; through undo-deltas to determine if it is in the region.
2602 ;;
2603 ;; In the above example, the insertion of "b" is (3 . 4) in the
2604 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2605 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2606 ;; . 6) is assessed as in the region and placed in the selective list.
2607 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2608 ;; due to the selected element. The "b" insertion is the only element
2609 ;; fully in the region, so in this example undo-make-selective-list
2610 ;; returns (nil (5 . 6)).
2611 ;;
2612 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2613 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2614 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2615 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2616 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2617 ;;
2618 ;; More interesting is how to adjust the "ddd" insertion due to the
2619 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2620 ;; If the reinsertion was a manual retyping of "ad", then the total
2621 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2622 ;; the reinsertion was due to undo, one might expect the first "d"
2623 ;; character would again be a part of the "ddd" text, meaning its
2624 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2625 ;;
2626 ;; undo-make-selective-list assumes in this situation that "ad" was a
2627 ;; new edit, even if it was inserted because of an undo.
2628 ;; Consequently, if the user undos in region "8 to 10" of the
2629 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2630 ;; "ccaabad", as though the first "d" became detached from the
2631 ;; original "ddd" insertion. This quirk is a FIXME.
2634 "Return a list of undo elements for the region START to END.
2635 The elements come from `buffer-undo-list', but we keep only the
2636 elements inside this region, and discard those outside this
2637 region. The elements' positions are adjusted so as the returned
2638 list can be applied to the current buffer."
2640 ;; A list of position adjusted undo elements in the region.
2642 ;; A list of undo-deltas for out of region undo elements.
2643 undo-deltas
2644 undo-elt)
2652 ;; Don't put two nils together in the list
2656 ;; This is a "was unmodified" element. Keep it
2657 ;; if we have kept everything thus far.
2660 ;; Skip over marker adjustments, instead relying
2661 ;; on finding them after (TEXT . POS) elements
2663 nil)
2666 undo-deltas)))
2671 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2672 ;; kept. primitive-undo may discard them later.
2685 "Determine whether UNDO-ELT falls inside the region START ... END.
2686 If it crosses the edge, we return nil.
2688 Generally this function is not useful for determining
2689 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2690 because markers can be arbitrarily relocated. Instead, pass the
2691 marker adjustment's corresponding (TEXT . POS) element."
2696 t)
2698 nil)
2700 ;; (TEXT . POSITION)
2704 ;; (MARKER . ADJUSTMENT)
2707 ;; (nil PROPERTY VALUE BEG . END)
2712 ;; (BEGIN . END)
2717 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2718 This assumes we have already decided that UNDO-ELT
2719 is not *inside* the region START...END."
2723 ;; (nil PROPERTY VALUE BEG . END)
2728 ;; (BEGIN . END)
2733 "Return adjustment of undo element ELT by the undo DELTAS
2734 list."
2736 ;; POSITION
2739 ;; (BEG . END)
2742 ;; (TEXT . POSITION)
2746 ;; (nil PROPERTY VALUE BEG . END)
2749 ;; (apply DELTA START END FUN . ARGS)
2750 ;; FIXME
2751 ;; All others return same elt
2754 ;; (BEG . END) can adjust to the same positions, commonly when an
2755 ;; insertion was undone and they are out of region, for example:
2756 ;;
2757 ;; buf pos:
2758 ;; 123456789 buffer-undo-list undo-deltas
2759 ;; --------- ---------------- -----------
2760 ;; [...]
2761 ;; abbaa (2 . 4) (2 . -2)
2762 ;; aaa ("bb" . 2) (2 . 2)
2763 ;; [...]
2764 ;;
2765 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2766 ;; undo. Further adjustments to such an element should be the same as
2767 ;; for (TEXT . POSITION) elements. The options are:
2768 ;;
2769 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2770 ;; analogous to marker insertion-type t.
2771 ;;
2772 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2773 ;; marker insertion-type nil.
2774 ;;
2775 ;; There was no strong reason to prefer one or the other, except that
2776 ;; the first is more consistent with prior undo in region behavior.
2778 "Return cons of adjustments to BEG and END by the undo DELTAS
2779 list."
2781 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2786 "Return adjustment of POS by the undo DELTAS list, comparing
2787 with < or <= based on USE-<."
2793 ;; Don't allow pos to become less than the undo-delta
2794 ;; position. This edge case is described in the overview
2795 ;; comments.
2798 ;; Return the first affected buffer position and the delta for an undo element
2799 ;; delta is defined as the change in subsequent buffer positions if we *did*
2800 ;; the undo.
2804 ;; (TEXT . POSITION)
2807 ;; (BEGIN . END)
2813 ;;; Default undo-boundary addition
2814 ;;
2815 ;; This section adds a new undo-boundary at either after a command is
2816 ;; called or in some cases on a timer called after a change is made in
2817 ;; any buffer.
2819 "Describe the cause of the last undo-boundary.
2821 If `explicit', the last boundary was caused by an explicit call to
2822 `undo-boundary', that is one not called by the code in this
2823 section.
2825 If it is equal to `timer', then the last boundary was inserted
2826 by `undo-auto--boundary-timer'.
2828 If it is equal to `command', then the last boundary was inserted
2829 automatically after a command, that is by the code defined in
2830 this section.
2832 If it is equal to a list, then the last boundary was inserted by
2833 an amalgamating command. The car of the list is the number of
2834 times an amalgamating command has been called, and the cdr are the
2838 "Current timer which will run `undo-auto--boundary-timer' or nil.
2843 "Non-nil if `this-command' should be amalgamated.
2844 This variable is set to nil by `undo-auto--boundaries' and is set
2848 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2852 "Return the number of amalgamating last commands or nil.
2853 Amalgamating commands are, by default, either
2854 `self-insert-command' and `delete-char', but can be any command
2855 that calls `undo-auto-amalgamate'."
2859 "Add an `undo-boundary' to the current buffer if needed.
2860 REASON describes the reason that the boundary is being added; see
2861 `undo-auto--last-boundary' for more information."
2871 undo-auto--undoably-changed-buffers)
2872 cause)))))
2875 "Check recently changed buffers and add a boundary if necessary.
2876 REASON describes the reason that the boundary is being added; see
2877 `undo-last-boundary' for more information."
2885 "Timer which will run `undo--auto-boundary-timer'."
2890 "Ensure that the `undo-auto-boundary-timer' is set."
2896 "List of buffers that have changed recently.
2898 This list is maintained by `undo-auto--undoable-change' and
2899 `undo-auto--boundaries' and can be affected by changes to their
2903 "Add an `undo-boundary' in appropriate buffers."
2908 'amalgamate
2912 "Amalgamate undo if necessary.
2913 This function can be called before an amalgamating command. It
2914 removes the previous `undo-boundary' if a series of such calls
2915 have been made. By default `self-insert-command' and
2916 `delete-char' are the only amalgamating commands, although this
2917 function could be called by any command wishing to have this
2918 behavior."
2923 last-amalgamating-count
2928 ;; Amalgamate all buffers that have changed.
2932 b
2934 ;; The head of `buffer-undo-list' is nil.
2935 ;; `car-safe' doesn't work because
2936 ;; `buffer-undo-list' need not be a list!
2943 ;; This function is called also from one place in fileio.c. We call
2944 ;; this function, rather than undoable-change because it reduces the
2945 ;; number of lisp functions we have to use fboundp for to avoid
2946 ;; bootstrap issues.
2948 "Record `current-buffer' as changed."
2952 "Called after every undoable buffer change."
2955 ;; End auto-boundary section
2958 "If non-nil ask about discarding undo info for the current command.
2959 Normally, Emacs discards the undo info for the current command if
2960 it exceeds `undo-outer-limit'. But if you set this option
2961 non-nil, it asks in the echo area whether to discard the info.
2962 If you answer no, there is a slight risk that Emacs might crash, so
2963 only do it if you really want to undo the command.
2965 This option is mainly intended for debugging. You have to be
2966 careful if you use it for other purposes. Garbage collection is
2967 inhibited while the question is asked, meaning that Emacs might
2968 leak memory. So you should make sure that you do not wait
2969 excessively long before answering the question."
2975 "If non-nil, an extra level of size that's ok in an undo item.
2976 We don't ask the user about truncating the undo list until the
2977 current item gets bigger than this amount.
2982 ;; When the first undo batch in an undo list is longer than
2983 ;; undo-outer-limit, this function gets called to warn the user that
2984 ;; the undo info for the current command was discarded. Garbage
2985 ;; collection is inhibited around the call, so it had better not do a
2986 ;; lot of consing.
2992 ;; Don't ask the question again unless it gets even bigger.
2993 ;; This applies, in particular, if the user quits from the question.
2994 ;; Such a quit quits out of GC, but something else will call GC
2995 ;; again momentarily. It will call this function again,
2996 ;; but we don't want to ask the question again.
3000 "Buffer `%s' undo info is %d bytes long; discard it? "
3004 t)
3005 nil))
3011 "The undo info was discarded because it exceeded \
3012 `undo-outer-limit'.
3014 This is normal if you executed a command that made a huge change
3015 to the buffer. In that case, to prevent similar problems in the
3016 future, set `undo-outer-limit' to a value that is large enough to
3017 cover the maximum size of normal changes you expect a single
3018 command to make, but not so large that it might exceed the
3019 maximum memory allotted to Emacs.
3021 If you did not execute any such command, the situation is
3022 probably due to a bug and you should report it.
3024 You can disable the popping up of this buffer by adding the entry
3025 \(undo discard-info) to the user option `warning-suppress-types',
3029 t))
3030 \f
3033 ; These are sorted according to the GNU en_US locale.
3076 )
3078 This is used by Shell mode and other parts of Emacs to recognize
3079 password prompts, including prompts in languages other than
3080 English. Different case choices should not be assumed to be
3081 included; callers should bind `case-fold-search' to t."
3087 "History list for some commands that read shell commands.
3089 Maximum length of the history list is determined by the value
3096 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3097 This buffer is used when `shell-command' or `shell-command-on-region'
3098 is run interactively. A value of nil means that output to stderr and
3105 "Return a list of all commands associated with the current file.
3106 This function is used to add all related commands retrieved by `mailcap'
3107 to the end of the list of defaults just after the default value."
3111 minibuffer-default))
3116 commands))
3127 map)
3131 "Read a shell command from the minibuffer.
3132 The arguments are the same as the ones of `read-from-minibuffer',
3133 except READ and KEYMAP are missing and HIST defaults
3134 to `shell-command-history'."
3142 minibuffer-local-shell-command-map
3143 nil
3145 args)))
3148 "What to do when the output buffer is used by another shell command.
3149 This option specifies how to resolve the conflict where a new command
3150 wants to direct its output to the buffer `*Async Shell Command*',
3151 but this buffer is already taken by another running shell command.
3153 The value `confirm-kill-process' is used to ask for confirmation before
3154 killing the already running process and running a new process
3155 in the same buffer, `confirm-new-buffer' for confirmation before running
3156 the command in a new buffer with a name other than the default buffer name,
3157 `new-buffer' for doing the same without confirmation,
3158 `confirm-rename-buffer' for confirmation before renaming the existing
3159 output buffer and running a new command in the default buffer,
3160 `rename-buffer' for doing the same without confirmation."
3162 confirm-kill-process)
3164 confirm-new-buffer)
3166 new-buffer)
3168 confirm-rename-buffer)
3170 rename-buffer))
3175 "Execute string COMMAND asynchronously in background.
3177 Like `shell-command', but adds `&' at the end of COMMAND
3178 to execute it asynchronously.
3180 The output appears in the buffer `*Async Shell Command*'.
3181 That buffer is in shell mode.
3183 You can configure `async-shell-command-buffer' to specify what to do in
3184 case when `*Async Shell Command*' buffer is already taken by another
3185 running shell command. To run COMMAND without displaying the output
3186 in a window you can configure `display-buffer-alist' to use the action
3187 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3189 In Elisp, you will often be better served by calling `start-process'
3190 directly, since it offers more control and does not impose the use of a
3191 shell (with its need to quote arguments)."
3201 current-prefix-arg
3202 shell-command-default-error-buffer))
3208 "Execute string COMMAND in inferior shell; display output, if any.
3209 With prefix argument, insert the COMMAND's output at point.
3211 Interactively, prompt for COMMAND in the minibuffer.
3213 If COMMAND ends in `&', execute it asynchronously.
3214 The output appears in the buffer `*Async Shell Command*'.
3215 That buffer is in shell mode. You can also use
3216 `async-shell-command' that automatically adds `&'.
3218 Otherwise, COMMAND is executed synchronously. The output appears in
3219 the buffer `*Shell Command Output*'. If the output is short enough to
3220 display in the echo area (which is determined by the variables
3221 `resize-mini-windows' and `max-mini-window-height'), it is shown
3222 there, but it is nonetheless available in buffer `*Shell Command
3223 Output*' even though that buffer is not automatically displayed.
3225 To specify a coding system for converting non-ASCII characters
3227 before this command.
3229 Noninteractive callers can specify coding systems by binding
3230 `coding-system-for-read' and `coding-system-for-write'.
3232 The optional second argument OUTPUT-BUFFER, if non-nil,
3233 says to put the output in some other buffer.
3234 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
3235 If OUTPUT-BUFFER is not a buffer and not nil,
3236 insert output in current buffer. (This cannot be done asynchronously.)
3237 In either case, the buffer is first erased, and the output is
3238 inserted after point (leaving mark after it).
3240 If the command terminates without error, but generates output,
3242 the output can be displayed in the echo area or in its buffer.
3243 If the output is short enough to display in the echo area
3244 \(determined by the variable `max-mini-window-height' if
3245 `resize-mini-windows' is non-nil), it is shown there.
3246 Otherwise,the buffer containing the output is displayed.
3250 of the output.
3252 If there is no output, or if output is inserted in the current buffer,
3253 then `*Shell Command Output*' is deleted.
3255 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3256 or buffer name to which to direct the command's standard error output.
3257 If it is nil, error output is mingled with regular output.
3258 In an interactive call, the variable `shell-command-default-error-buffer'
3259 specifies the value of ERROR-BUFFER.
3261 In Elisp, you will often be better served by calling `call-process' or
3262 `start-process' directly, since it offers more control and does not impose
3263 the use of a shell (with its need to quote arguments)."
3274 current-prefix-arg
3275 shell-command-default-error-buffer))
3276 ;; Look for a handler in case default-directory is a remote file name.
3284 ;; Output goes in current buffer.
3290 temporary-file-directory)))
3291 nil)))
3294 ;; We do not use -f for csh; we will not support broken use of
3295 ;; .cshrcs. Even the BSD csh manual says to use
3296 ;; "if ($?prompt) exit" before things which are not useful
3297 ;; non-interactively. Besides, if someone wants their other
3298 ;; aliases for shell commands then they can still have them.
3302 t)
3303 nil shell-command-switch command)
3310 ;; Do no formatting while reading error file,
3311 ;; because that can run a shell command, and we
3312 ;; don't want that to cause an infinite recursion.
3314 ;; Put point after the inserted errors.
3318 ;; This is like exchange-point-and-mark, but doesn't
3319 ;; activate the mark. It is cleaner to avoid activation,
3320 ;; even though the command loop would deactivate the mark
3321 ;; because we inserted text.
3325 ;; Output goes in a separate buffer.
3326 ;; Preserve the match data in case called from a program.
3329 ;; Command ending with ampersand means asynchronous.
3333 proc)
3334 ;; Remove the ampersand.
3336 ;; Ask the user what to do with already running process.
3341 ;; If will kill a process, query first.
3346 ;; If will create a new buffer, query first.
3353 ;; It will create a new buffer.
3358 ;; If will rename the buffer, query first.
3367 ;; It will rename the buffer.
3374 ;; Setting buffer-read-only to nil doesn't suffice
3375 ;; if some text has a non-nil read-only property,
3376 ;; which comint sometimes adds for prompts.
3382 shell-command-switch command))
3386 ;; Use the comint filter for proper handling of carriage motion
3387 ;; (see `comint-inhibit-carriage-motion'),.
3389 ))
3390 ;; Otherwise, command is executed synchronously.
3392 output-buffer nil error-buffer)))))))
3395 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3396 MESSAGE may be either a string or a buffer.
3398 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3399 for maximum height of the echo area, as defined by `max-mini-window-height'
3400 if `resize-mini-windows' is non-nil.
3402 Returns either the string shown in the echo area, or when a pop-up
3403 buffer is used, the window used to display it.
3405 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3406 name of the buffer used to display it in the case where a pop-up buffer
3407 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3408 string and it is displayed in the echo area, it is not specified whether
3409 the contents are inserted into the buffer anyway.
3411 Optional arguments ACTION and FRAME are as for `display-buffer',
3412 and are only used if a pop-up buffer is displayed."
3414 ;; Trivial case where we can use the echo area
3418 ;; Trivial case where we can just remove single trailing newline
3421 ;; General case
3424 message
3433 0
3437 (<= lines
3441 max-mini-window-height))
3443 max-mini-window-height)
3447 ;; Don't use the echo area if the output buffer is
3448 ;; already displayed in the selected frame.
3450 ;; Echo area
3456 ;; Buffer
3461 ;; We have a sentinel to prevent insertion of a termination message
3462 ;; in the buffer itself.
3470 &optional output-buffer replace
3471 error-buffer display-error-buffer
3472 region-noncontiguous-p)
3473 "Execute string COMMAND in inferior shell with region as input.
3474 Normally display output (if any) in temp buffer `*Shell Command Output*';
3475 Prefix arg means replace the region with it. Return the exit code of
3476 COMMAND.
3478 To specify a coding system for converting non-ASCII characters
3480 before this command. By default, the input (from the current buffer)
3481 is encoded using coding-system specified by `process-coding-system-alist',
3482 falling back to `default-process-coding-system' if no match for COMMAND
3483 is found in `process-coding-system-alist'.
3485 Noninteractive callers can specify coding systems by binding
3486 `coding-system-for-read' and `coding-system-for-write'.
3488 If the command generates output, the output may be displayed
3489 in the echo area or in a buffer.
3490 If the output is short enough to display in the echo area
3491 \(determined by the variable `max-mini-window-height' if
3492 `resize-mini-windows' is non-nil), it is shown there.
3493 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3494 The output is available in that buffer in both cases.
3496 If there is output and an error, a message about the error
3497 appears at the end of the output. If there is no output, or if
3498 output is inserted in the current buffer, the buffer `*Shell
3499 Command Output*' is deleted.
3501 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3502 command's output. If the value is a buffer or buffer name,
3503 put the output there. If the value is nil, use the buffer
3504 `*Shell Command Output*'. Any other value, excluding nil,
3505 means to insert the output in the current buffer. In either case,
3506 the output is inserted after point (leaving mark after it).
3508 Optional fifth arg REPLACE, if non-nil, means to insert the
3509 output in place of text from START to END, putting point and mark
3510 around it.
3512 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3513 or buffer name to which to direct the command's standard error
3514 output. If nil, error output is mingled with regular output.
3515 When called interactively, `shell-command-default-error-buffer'
3516 is used for ERROR-BUFFER.
3518 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3519 display the error buffer if there were any errors. When called
3520 interactively, this is t."
3524 ;; Do this before calling region-beginning
3525 ;; and region-end, in case subprocess output
3526 ;; relocates them while we are in the minibuffer.
3528 ;; call-interactively recognizes region-beginning and
3529 ;; region-end specially, leaving them in the history.
3531 string
3532 current-prefix-arg
3533 current-prefix-arg
3534 shell-command-default-error-buffer
3535 t
3542 temporary-file-directory)))
3543 nil))
3544 exit-status)
3545 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3548 output)
3552 shell-file-name t t
3553 nil shell-command-switch
3554 command)
3561 ;; Replace specified region with output from command.
3563 ;; Don't muck with mark unless REPLACE says we should.
3570 t)
3571 nil shell-command-switch command))
3572 ;; It is rude to delete a buffer which the command is not using.
3573 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3574 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3575 ;; (kill-buffer shell-buffer)))
3576 ;; Don't muck with mark unless REPLACE says we should.
3578 ;; No prefix argument: put the output in a temp buffer,
3579 ;; replacing its entire contents.
3584 ;; If the input is the same buffer as the output,
3585 ;; delete everything but the specified region,
3586 ;; then replace that region with the output.
3592 shell-file-name t
3595 t)
3596 nil shell-command-switch
3597 command)))
3598 ;; Clear the output buffer, then run the command with
3599 ;; output there.
3610 buffer)
3611 nil shell-command-switch command)))
3612 ;; Report the output.
3622 ;; There's some output, display it
3624 ;; No output; error?
3631 shell-command-default-error-buffer)
3638 output))
3641 exit-status))
3644 exit-status output))))
3645 ;; Don't kill: there might be useful info in the undo-log.
3646 ;; (kill-buffer buffer)
3647 )))))
3655 ;; Do no formatting while reading error file,
3656 ;; because that can run a shell command, and we
3657 ;; don't want that to cause an infinite recursion.
3659 ;; Put point after the inserted errors.
3664 exit-status))
3667 "Execute shell command COMMAND and return its output as a string."
3670 standard-output
3674 "Process files synchronously in a separate process.
3675 Similar to `call-process', but may invoke a file handler based on
3676 `default-directory'. The current working directory of the
3677 subprocess is `default-directory'.
3679 File names in INFILE and BUFFER are handled normally, but file
3680 names in ARGS should be relative to `default-directory', as they
3681 are passed to the process verbatim. (This is a difference to
3682 `call-process' which does not support file handlers for INFILE
3683 and BUFFER.)
3685 Some file handlers might not support all variants, for example
3686 they might behave as if DISPLAY was nil, regardless of the actual
3687 value passed."
3689 lc stderr-file)
3699 display args)
3705 "Whether a call of `process-file' changes remote files.
3707 By default, this variable is always set to t, meaning that a
3708 call of `process-file' could potentially change any file on a
3709 remote host. When set to nil, a file handler could optimize
3710 its behavior with respect to remote file attribute caching.
3712 You should only ever change this variable with a let-binding;
3716 "Start a program in a subprocess. Return the process object for it.
3718 Similar to `start-process', but may invoke a file handler based on
3719 `default-directory'. See Info node `(elisp)Magic File Names'.
3721 This handler ought to run PROGRAM, perhaps on the local host,
3722 perhaps on a remote host that corresponds to `default-directory'.
3723 In the latter case, the local part of `default-directory' becomes
3724 the working directory of the process.
3726 PROGRAM and PROGRAM-ARGS might be file names. They are not
3727 objects of file handler invocation. File handlers might not
3728 support pty association, if PROGRAM is nil."
3732 \f
3733 ;;;; Process menu
3747 map))
3750 "Major mode for listing the processes called by Emacs."
3762 "Kill process at point in a `list-processes' buffer."
3768 "Recompute the list of processes for the Process List buffer.
3769 Also, delete any process that is exited or signaled."
3782 face link
3784 "Visit buffer `%s'"
3786 follow-link t
3787 process-buffer ,buf
3788 action process-menu-visit-buffer)
3797 "datagram"
3814 tabulated-list-entries))))))
3820 "Display a list of all processes that are Emacs sub-processes.
3821 If optional argument QUERY-ONLY is non-nil, only processes with
3822 the query-on-exit flag set are listed.
3823 Any process listed as exited or signaled is actually eliminated
3824 after the listing is made.
3825 Optional argument BUFFER specifies a buffer to use, instead of
3827 The return value is always nil.
3829 This function lists only processes that were launched by Emacs. To
3830 see other processes running on the system, use `list-system-processes'."
3842 nil)
3843 \f
3844 ;;;; Prefix commands
3850 ;; BEWARE: Called directly from C code.
3851 ;; If the return value is non-nil, it means we are in the middle of
3852 ;; a command with prefix, such as a command invoked with prefix-arg.
3854 prefix-command--last-echo
3863 "Abnormal hook which constructs the description of the current prefix state.
3867 "Update state of prefix commands.
3875 "Pass the current prefix command state to the next command.
3876 Should be called by all prefix commands.
3877 Runs `prefix-command-preserve-state-hook'."
3879 ;; If the current command is a prefix command, we don't want the next (real)
3880 ;; command to have `last-command' set to, say, `universal-argument'.
3887 nil)
3889 ;;;;; The main prefix command.
3891 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
3916 ;; For backward compatibility, minus with no modifiers is an ordinary
3917 ;; command if digits have already been entered.
3947 map)
3955 "Begin a numeric argument for the following command.
3960 multiplies the argument by 4 each time.
3962 which is different in effect from any particular numeric argument.
3970 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3971 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3978 arg)))
3982 "Begin a negative numeric argument for the next command.
3992 "Part of the numeric argument for the next command.
3997 last-command-event
4004 ;; Treat -0 as just -, so that -01 will work.
4007 digit))))
4009 \f
4012 "This variable is a wrapper hook around `buffer-substring--filter'.
4018 "Function to perform the filtering in `filter-buffer-substring'.
4019 The function is called with the same 3 arguments (BEG END DELETE)
4020 that `filter-buffer-substring' received. It should return the
4021 buffer substring between BEG and END, after filtering. If DELETE is
4025 "List of filter functions for `buffer-substring--filter'.
4026 Each function must accept a single argument, a string, and return a string.
4027 The buffer substring is passed to the first function in the list,
4028 and the return value of each function is passed to the next.
4029 As a special convention, point is set to the start of the buffer text
4030 being operated on (i.e., the first argument of `buffer-substring--filter')
4036 "Return the buffer substring between BEG and END, after filtering.
4037 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4039 This calls the function that `filter-buffer-substring-function' specifies
4040 \(passing the same three arguments that it received) to do the work,
4041 and returns whatever it does. The default function does no filtering,
4042 unless a hook has been set.
4044 Use `filter-buffer-substring' instead of `buffer-substring',
4045 `buffer-substring-no-properties', or `delete-and-extract-region' when
4046 you want to allow filtering to take place. For example, major or minor
4047 modes can use `filter-buffer-substring-function' to extract characters
4048 that are special to a buffer, and should not be copied into other buffers."
4052 "Default function to use for `filter-buffer-substring-function'.
4053 Its arguments and return value are as specified for `filter-buffer-substring'.
4054 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4055 \(see `with-wrapper-hook' for details about wrapper hooks),
4056 and the abnormal hook `buffer-substring-filters'.
4057 No filtering is done unless a hook says to."
4067 string)))
4072 ;;;; Window system cut and paste hooks.
4075 "Function to call to make a killed region available to other programs.
4076 Most window systems provide a facility for cutting and pasting
4077 text between different programs, such as the clipboard on X and
4078 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4080 This variable holds a function that Emacs calls whenever text is
4081 put in the kill ring, to make the new kill available to other
4082 programs. The function takes one argument, TEXT, which is a
4086 "Function to call to get text cut from other programs.
4087 Most window systems provide a facility for cutting and pasting
4088 text between different programs, such as the clipboard on X and
4089 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4091 This variable holds a function that Emacs calls to obtain text
4092 that other programs have provided for pasting. The function is
4093 called with no arguments. If no other program has provided text
4094 to paste, the function should return nil (in which case the
4095 caller, usually `current-kill', should use the top of the Emacs
4096 kill ring). If another program has provided text to paste, the
4097 function should return that text as a string (in which case the
4098 caller should put this string in the kill ring as the latest
4099 kill).
4101 The function may also return a list of strings if the window
4102 system supports multiple selections. The first string will be
4103 used as the pasted text, but the other will be placed in the kill
4104 ring for easy access via `yank-pop'.
4106 Note that the function should return a string only if a program
4107 other than Emacs has provided a string for pasting; if Emacs
4108 provided the most recent string, the function should return nil.
4109 If it is difficult to tell whether Emacs or some other program
4110 provided the current string, it is probably good enough to return
4111 nil if the string is equal (according to `string=') to the last
4113 \f
4116 ;;;; The kill ring data structure.
4119 "List of killed text sequences.
4120 Since the kill ring is supposed to interact nicely with cut-and-paste
4121 facilities offered by window systems, use of this variable should
4122 interact nicely with `interprogram-cut-function' and
4123 `interprogram-paste-function'. The functions `kill-new',
4124 `kill-append', and `current-kill' are supposed to implement this
4125 interaction; you may want to use them instead of manipulating the kill
4129 "Maximum length of kill ring before oldest elements are thrown away."
4137 "Save clipboard strings into kill ring before replacing them.
4138 When one selects something in another program to paste it into Emacs,
4139 but kills something in Emacs before actually pasting it,
4140 this selection is gone unless this variable is non-nil,
4141 in which case the other program's selection is saved in the `kill-ring'
4148 "Do not add a new string to `kill-ring' if it duplicates the last one.
4149 The comparison is done using `equal-including-properties'."
4155 "Make STRING the latest kill in the kill ring.
4156 Set `kill-ring-yank-pointer' to point to it.
4157 If `interprogram-cut-function' is non-nil, apply it to STRING.
4158 Optional second argument REPLACE non-nil means that STRING will replace
4159 the front of the kill ring, rather than being added to the list.
4161 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4162 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4163 STRING.
4165 When the yank handler has a non-nil PARAM element, the original STRING
4166 argument is not used by `insert-for-yank'. However, since Lisp code
4167 may access and use elements from the kill ring directly, the STRING
4170 ;; Due to text properties such as 'yank-handler that
4171 ;; can alter the contents to yank, comparison using
4172 ;; `equal' is unsafe.
4197 ;; It has been argued that this should work similar to `self-insert-command'
4198 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4200 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4206 "Append STRING to the end of the latest kill in the kill ring.
4207 If BEFORE-P is non-nil, prepend STRING to the kill.
4208 Also removes the last undo boundary in the current buffer,
4209 depending on `kill-append-merge-undo'.
4210 If `interprogram-cut-function' is set, pass the resulting kill to it."
4218 ;; find the next undo boundary
4222 ;; remove this undo boundary
4227 "Whether rotating the kill ring changes the window system selection.
4228 If non-nil, whenever the kill ring is rotated (usually via the
4229 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4230 to copy the new kill to the window system selection."
4236 "Rotate the yanking point by N places, and then return that kill.
4237 If N is zero and `interprogram-paste-function' is set to a
4238 function that returns a string or a list of strings, and if that
4239 function doesn't return nil, then that string (or list) is added
4240 to the front of the kill ring and the string (or first string in
4241 the list) is returned as the latest kill.
4243 If N is not zero, and if `yank-pop-change-selection' is
4244 non-nil, use `interprogram-cut-function' to transfer the
4245 kill at the new yank point into the window system selection.
4247 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4248 move the yanking point; just return the Nth kill forward."
4251 interprogram-paste-function
4255 ;; Disable the interprogram cut function when we add the new
4256 ;; text to the kill ring, so Emacs doesn't try to own the
4257 ;; selection, with identical text.
4267 kill-ring)))
4272 interprogram-cut-function)
4278 ;;;; Commands for manipulating the kill ring.
4281 "Non-nil means don't signal an error for killing read-only text."
4287 This deletes the text from the buffer and saves it in the kill ring.
4291 If you want to append the killed region to the last killed text,
4295 If the previous command was also a kill command,
4296 the text killed this time appends to the text killed last time
4297 to make one entry in the kill ring.
4299 The killed text is filtered by `filter-buffer-substring' before it is
4300 saved in the kill ring, so the actual saved text might be different
4301 from what was killed.
4303 If the buffer is read-only, Emacs will beep and refrain from deleting
4304 the text, but put the text in the kill ring anyway. This means that
4305 you can use the killing commands to copy text from a read-only buffer.
4307 Lisp programs should use this function for killing text.
4308 (To delete text, use `delete-region'.)
4309 Supply two arguments, character positions BEG and END indicating the
4310 stretch of text to be killed. If the optional argument REGION is
4311 non-nil, the function ignores BEG and END, and kills the current
4312 region instead."
4313 ;; Pass mark first, then point, because the order matters when
4314 ;; calling `kill-append'.
4323 ;; Add that string to the kill ring, one way or another.
4330 nil)
4332 ;; The code above failed because the buffer, or some of the characters
4333 ;; in the region, are read-only.
4334 ;; We should beep, in case the user just isn't aware of this.
4335 ;; However, there's no harm in putting
4336 ;; the region's text in the kill ring, anyway.
4338 ;; Set this-command now, so it will be set even if we get an error.
4340 ;; This should barf, if appropriate, and give us the correct error.
4343 ;; Signal an error if the buffer is read-only.
4345 ;; If the buffer isn't read-only, the text is.
4348 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4349 ;; to get two copies of the text when the user accidentally types M-w and
4350 ;; then corrects it with the intended C-w.
4352 "Save the region as if killed, but don't kill it.
4353 In Transient Mark mode, deactivate the mark.
4354 If `interprogram-cut-function' is non-nil, also save the text for a window
4355 system cut and paste.
4357 The copied text is filtered by `filter-buffer-substring' before it is
4358 saved in the kill ring, so the actual saved text might be different
4359 from what was in the buffer.
4361 When called from Lisp, save in the kill ring the stretch of text
4362 between BEG and END, unless the optional argument REGION is
4363 non-nil, in which case ignore BEG and END, and save the current
4364 region instead.
4366 This command's old key binding has been given to `kill-ring-save'."
4367 ;; Pass mark first, then point, because the order matters when
4368 ;; calling `kill-append'.
4378 nil)
4381 "Save the region as if killed, but don't kill it.
4382 In Transient Mark mode, deactivate the mark.
4383 If `interprogram-cut-function' is non-nil, also save the text for a window
4384 system cut and paste.
4386 If you want to append the killed line to the last killed text,
4389 The copied text is filtered by `filter-buffer-substring' before it is
4390 saved in the kill ring, so the actual saved text might be different
4391 from what was in the buffer.
4393 When called from Lisp, save in the kill ring the stretch of text
4394 between BEG and END, unless the optional argument REGION is
4395 non-nil, in which case ignore BEG and END, and save the current
4396 region instead.
4398 This command is similar to `copy-region-as-kill', except that it gives
4399 visual feedback indicating the extent of the region being copied."
4400 ;; Pass mark first, then point, because the order matters when
4401 ;; calling `kill-append'.
4405 ;; This use of called-interactively-p is correct because the code it
4406 ;; controls just gives the user visual feedback.
4411 "Indicate that the region text has been copied interactively.
4412 If the mark is visible in the selected window, blink the cursor
4413 between point and mark if there is currently no active region
4414 highlighting.
4416 If the mark lies outside the selected window, display an
4417 informative message containing a sample of the copied text. The
4418 optional argument MESSAGE-LEN, if non-nil, specifies the length
4419 of this sample text; it defaults to 40."
4422 ;; Inhibit quitting so we can make a quit here
4423 ;; look like a C-g typed as a command.
4426 ;; Swap point-and-mark quickly so as to show the region that
4427 ;; was selected. Don't do it if the region is highlighted.
4430 ;; Swap point and mark.
4434 ;; Swap back.
4437 ;; If user quit, deactivate the mark
4438 ;; as C-g would as a command.
4444 ;; Don't say "killed"; that is misleading.
4451 "Cause following command, if it kills, to add to previous kill.
4452 If the next command kills forward from point, the kill is
4453 appended to the previous killed text. If the command kills
4454 backward, the kill is prepended. Kill commands that act on the
4455 region, such as `kill-region', are regarded as killing forward if
4456 point is after mark, and killing backward if point is before
4457 mark.
4459 If the next command is not a kill command, `append-next-kill' has
4460 no effect.
4462 The argument is used for internal purposes; do not supply one."
4464 ;; We don't use (interactive-p), since that breaks kbd macros.
4478 "A subroutine of `squeeze-bidi-context'.
4479 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4483 lim1)
4490 ;; L and R categories include embedding and
4491 ;; override controls, but we don't want to
4492 ;; replace them, because that might change
4493 ;; the visual order. Likewise with PDF and
4494 ;; isolate controls.
4496 bidi-directional-non-controls-chars
4497 limit)))))
4498 ;; Replace any run of non-RTL characters by a single LRM.
4500 ;; No more characters of CATEGORY, we are done.
4505 ;; Skip directional controls, if any.
4510 "Replace characters between FROM and TO while keeping bidi context.
4512 This function replaces the region of text with as few characters
4513 as possible, while preserving the effect that region will have on
4514 bidirectional display before and after the region."
4518 ;; This is for when they copy text with read-only text
4519 ;; properties.
4523 ;; Replace each run of non-RTL characters with a single LRM.
4525 ;; Replace each run of non-LTR characters with a single RLM. Note
4526 ;; that the \cR category includes both the Arabic Letter (AL) and
4527 ;; R characters; here we ignore the distinction between them,
4528 ;; because that distinction only affects Arabic Number (AN)
4529 ;; characters, which are weak and don't affect the reordering.
4533 "Return buffer text between START and END with its bidi context.
4535 START and END are assumed to belong to the same physical line
4536 of buffer text. This function prepends and appends to the text
4537 between START and END bidi control characters that preserve the
4538 visual order of that text when it is inserted at some other place."
4543 substr para-dir from to)
4550 ;; If we don't have any mixed directional characters in the
4551 ;; entire line, we can just copy the substring without adding
4552 ;; any context.
4567 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4568 ;; (1) force the string to have the same base embedding
4569 ;; direction as the paragraph direction at the source, no matter
4570 ;; what is the paragraph direction at destination; and (2) avoid
4571 ;; affecting the visual order of the surrounding text at
4572 ;; destination if there are characters of different
4573 ;; directionality there.
4578 "Return portion of current buffer between START and END with bidi context.
4580 This function works similar to `buffer-substring', but it prepends and
4581 appends to the text bidi directional control characters necessary to
4582 preserve the visual appearance of the text if it is inserted at another
4583 place. This is useful when the buffer substring includes bidirectional
4584 text and control characters that cause non-trivial reordering on display.
4585 If copied verbatim, such text can have a very different visual appearance,
4586 and can also change the visual appearance of the surrounding text at the
4587 destination of the copy.
4589 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4590 the text properties."
4603 no-properties)))
4607 substr)))
4608 \f
4609 ;; Yanking.
4614 "List of special text property handling conditions for yanking.
4615 Each element should have the form (PROP . FUN), where PROP is a
4616 property symbol and FUN is a function. When the `yank' command
4617 inserts text into the buffer, it scans the inserted text for
4618 stretches of text that have `eq' values of the text property
4619 PROP; for each such stretch of text, FUN is called with three
4620 arguments: the property's value in that text, and the start and
4621 end positions of the text.
4623 This is done prior to removing the properties specified by
4624 `yank-excluded-properties'."
4627 function))
4630 ;; This is actually used in subr.el but defcustom does not work there.
4633 intangible invisible keymap local-map mouse-face read-only
4634 yank-handler)
4635 "Text properties to discard when yanking.
4636 The value should be a list of text properties to discard or t,
4637 which means to discard all text properties.
4639 See also `yank-handled-properties'."
4646 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4647 Function is called with two parameters, START and END corresponding to
4648 the value of the mark and point; it is guaranteed that START <= END.
4652 "Replace just-yanked stretch of killed text with a different stretch.
4653 This command is allowed only immediately after a `yank' or a `yank-pop'.
4654 At such a time, the region contains a stretch of reinserted
4655 previously-killed text. `yank-pop' deletes that text and inserts in its
4656 place a different stretch of killed text.
4658 With no argument, the previous kill is inserted.
4659 With argument N, insert the Nth previous kill.
4660 If N is negative, this is a more recent kill.
4662 The sequence of kills wraps around, so that after the oldest one
4663 comes the newest one.
4665 When this command inserts killed text into the buffer, it honors
4666 `yank-excluded-properties' and `yank-handler' as described in the
4667 doc string for `insert-for-yank-1', which see."
4681 ;; Set the window start back where it was in the yank command,
4682 ;; if possible.
4685 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4686 ;; It is cleaner to avoid activation, even though the command
4687 ;; loop would deactivate the mark because we inserted text.
4690 nil)
4694 More precisely, reinsert the most recent kill, which is the
4695 stretch of killed text most recently killed OR yanked. Put point
4696 at the end, and set mark at the beginning without activating it.
4698 With argument N, reinsert the Nth most recent kill.
4700 When this command inserts text into the buffer, it honors the
4701 `yank-handled-properties' and `yank-excluded-properties'
4702 variables, and the `yank-handler' text property. See
4703 `insert-for-yank-1' for details.
4708 ;; If we don't get all the way thru, make last-command indicate that
4709 ;; for the following command.
4717 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4718 ;; It is cleaner to avoid activation, even though the command
4719 ;; loop would deactivate the mark because we inserted text.
4722 ;; If we do get all the way thru, make this-command indicate that.
4725 nil)
4728 "Rotate the yanking point in the kill ring.
4729 With ARG, rotate that many kills forward (or backward, if negative)."
4732 \f
4733 ;; Some kill commands.
4735 ;; Internal subroutine of delete-char
4741 ;; Internal subroutine of backward-delete-char
4748 "The method for untabifying when deleting backward.
4749 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4750 `hungry' -- delete all whitespace, both tabs and spaces;
4751 `all' -- delete all whitespace, including tabs, spaces and newlines;
4752 nil -- just delete one character."
4758 "Delete characters backward, changing tabs into spaces.
4759 The exact behavior depends on `backward-delete-char-untabify-method'.
4760 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4761 Interactively, ARG is the prefix arg (default 1)
4762 and KILLP is t if a prefix arg was specified."
4785 arg)))
4786 ;; Avoid warning about delete-backward-char
4790 "Kill up to and including ARGth occurrence of CHAR.
4791 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4792 Goes backward if ARG is negative; error if CHAR not found."
4795 ;; Avoid "obsolete" warnings for translation-table-for-input.
4803 ;; kill-line and its subroutines.
4806 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4811 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4812 With prefix argument ARG, kill that many lines from point.
4813 Negative arguments kill lines backward.
4814 With zero argument, kills the text before point on the current line.
4817 a number counts as a prefix arg.
4819 To kill a whole line, when point is not at the beginning, type \
4822 If `show-trailing-whitespace' is non-nil, this command will just
4823 kill the rest of the current line, even if there are only
4824 nonblanks there.
4826 If option `kill-whole-line' is non-nil, then this command kills the whole line
4827 including its terminating newline, when used at the beginning of a line
4828 with no argument. As a consequence, you can always kill a whole line
4831 If you want to append the killed line to the last killed text,
4834 If the buffer is read-only, Emacs will beep and refrain from deleting
4835 the line, but put the line in the kill ring anyway. This means that
4836 you can use this command to copy text from a read-only buffer.
4837 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4838 even beep.)"
4841 ;; It is better to move point to the other end of the kill
4842 ;; before killing. That way, in a read-only buffer, point
4843 ;; moves across the text that is copied to the kill ring.
4844 ;; The choice has no effect on undo now that undo records
4845 ;; the value of point from before the command was run.
4855 ;; If trailing whitespace is visible,
4856 ;; don't treat it as nothing.
4866 "Kill current line.
4867 With prefix ARG, kill that many lines starting from the current line.
4868 If ARG is negative, kill backward. Also kill the preceding newline.
4870 If ARG is zero, kill current line but exclude the trailing newline."
4881 ;; We need to kill in two steps, because the previous command
4882 ;; could have been a kill command, in which case the text
4883 ;; before point needs to be prepended to the current kill
4884 ;; ring entry and the text after point appended. Also, we
4885 ;; need to use save-excursion to avoid copying the same text
4886 ;; twice to the kill ring in read-only buffers.
4904 "Move forward by ARG lines, ignoring currently invisible newlines only.
4905 If ARG is negative, move backward -ARG lines.
4906 If ARG is zero, move to the beginning of the current line."
4913 ;; If the newline we just skipped is invisible,
4914 ;; don't count it.
4918 prop
4923 ;; If invisible text follows, and it is a number of complete lines,
4924 ;; skip it.
4930 prop
4946 ;; If the newline we just moved to is invisible,
4947 ;; don't count it.
4952 prop
4957 ;; If invisible text follows, and it is a number of complete lines,
4958 ;; skip it.
4964 prop
4975 nil)))
4978 "Move to end of current visible line."
4980 ;; If the following character is currently invisible,
4981 ;; skip all characters with that same `invisible' property value,
4982 ;; then find the next newline.
4989 prop
4998 \f
5000 "Insert after point the contents of BUFFER.
5001 Puts mark after the inserted text.
5002 BUFFER may be a buffer or a buffer name."
5012 t))))
5017 nil)
5020 "Append to specified buffer the text of the region.
5021 It is inserted into that buffer before its point.
5023 When calling from a program, give three arguments:
5024 BUFFER (or buffer name), START and END.
5025 START and END specify the portion of the current buffer to be copied."
5032 point)
5043 "Prepend to specified buffer the text of the region.
5044 It is inserted into that buffer after its point.
5046 When calling from a program, give three arguments:
5047 BUFFER (or buffer name), START and END.
5048 START and END specify the portion of the current buffer to be copied."
5057 "Copy to specified buffer the text of the region.
5058 It is inserted into that buffer, replacing existing text there.
5060 When calling from a program, give three arguments:
5061 BUFFER (or buffer name), START and END.
5062 START and END specify the portion of the current buffer to be copied."
5070 \f
5074 "Hook run when the mark becomes active.
5075 It is also run at the end of a command, if the mark is active and
5082 "Return this buffer's mark value as integer, or nil if never set.
5084 In Transient Mark mode, this function signals an error if
5085 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5086 or the argument FORCE is non-nil, it disregards whether the mark
5087 is active, and returns an integer or nil in the usual way.
5089 If you are using this in an editing command, you are most likely making
5090 a mistake; see the documentation of `set-mark'."
5095 ;; Behind display-selections-p.
5098 "Deactivate the mark.
5099 If Transient Mark mode is disabled, this function normally does
5100 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5102 Deactivating the mark sets `mark-active' to nil, updates the
5103 primary selection according to `select-active-regions', and runs
5104 `deactivate-mark-hook'.
5106 If Transient Mark mode was temporarily enabled, reset the value
5107 of the variable `transient-mark-mode'; if this causes Transient
5108 Mark mode to be disabled, don't change `mark-active' to nil or
5109 run `deactivate-mark-hook'."
5113 select-active-regions)
5116 ;; The var `saved-region-selection', if non-nil, is the text in
5117 ;; the region prior to the last command modifying the buffer.
5118 ;; Set the selection to that, or to the current region.
5123 ;; If another program has acquired the selection, region
5124 ;; deactivation should not clobber it (Bug#11772).
5143 "Activate the mark.
5144 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5154 "Set this buffer's mark to POS. Don't use this function!
5155 That is to say, don't use this function unless you want
5156 the user to see that the mark has moved, and you want the previous
5157 mark position to be lost.
5159 Normally, when a new mark is set, the old one should go on the stack.
5160 This is why most applications should use `push-mark', not `set-mark'.
5162 Novice Emacs Lisp programmers often try to use the mark for the wrong
5163 purposes. The mark saves a location for the user's convenience.
5164 Most editing commands should not alter the mark.
5165 To remember a location for internal use in the Lisp program,
5166 store it in a Lisp variable. Example:
5168 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5173 ;; Normally we never clear mark-active except in Transient Mark mode.
5174 ;; But when we actually clear out the mark value too, we must
5175 ;; clear mark-active in any mode.
5177 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5178 ;; it should never be nil if the mark is nil.
5186 mark-active))
5193 ;; Mark marker
5199 ;; Mark active
5202 ;; If mark is active now, and either was not active or was at a
5203 ;; different place, run the activate hook.
5208 ;; If mark has ceased to be active, run deactivate hook.
5213 "Like `save-excursion', but also save and restore the mark state.
5214 This macro does what `save-excursion' did before Emacs 25.1."
5223 If nil, region-aware commands treat the empty region as inactive.
5224 If non-nil, region-aware commands treat the region as active as
5225 long as the mark is active, even if the region is empty.
5227 Region-aware commands are those that act on the region if it is
5228 active and Transient Mark mode is enabled, and on the text near
5229 point otherwise."
5235 "Return t if the region is active and it is appropriate to act on it.
5236 This is used by commands that act specially on the region under
5237 Transient Mark mode.
5239 The return value is t if Transient Mark mode is enabled and the
5240 mark is active; furthermore, if `use-empty-active-region' is nil,
5241 the region must not be empty. Otherwise, the return value is nil.
5243 For some commands, it may be appropriate to ignore the value of
5244 `use-empty-active-region'; in that case, use `region-active-p'."
5249 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5251 Some commands act specially on the region when Transient Mark
5252 mode is enabled. Usually, such commands should use
5253 `use-region-p' instead of this function, because `use-region-p'
5254 also checks the value of `use-empty-active-region'."
5256 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5257 ;; without the mark being set (e.g. bug#17324). We really should fix
5258 ;; that problem, but in the mean time, let's make sure we don't say the
5259 ;; region is active when there's no mark.
5263 "Return non-nil if the region contains several pieces.
5264 An example is a rectangular region handled as a list of
5265 separate contiguous regions for each line."
5278 ;; Normal priority so that a large region doesn't hide all the
5279 ;; overlays within it, but high secondary priority so that if it
5280 ;; ends/starts in the middle of a small overlay, that small overlay
5281 ;; won't hide the region's boundaries.
5283 nrol)
5288 rol)))
5304 start end window rol)))
5307 new))))))
5310 "Hook run just before redisplay.
5311 It is called in each window that is to be redisplayed. It takes one argument,
5312 which is the window that will be redisplayed. When run, the `current-buffer'
5333 "Maximum size of mark ring. Start discarding off end if gets this big."
5341 "Maximum size of global mark ring. \
5342 Start discarding off end if gets this big."
5347 "Jump to mark, and pop a new position for mark off the ring.
5348 \(Does not affect global mark ring)."
5358 "Set mark at where point is.
5359 If no prefix ARG and mark is already set there, just activate it.
5360 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5372 will pop the mark twice, and
5374 will pop the mark three times.
5382 "Set the mark where point is, or jump to the mark.
5383 Setting the mark also alters the region, which is the text
5384 between point and mark; this is the closest equivalent in
5387 With no prefix argument, set the mark at point, and push the
5388 old mark position on local mark ring. Also push the old mark on
5389 global mark ring, if the previous mark was set in another buffer.
5391 When Transient Mark Mode is off, immediately repeating this
5392 command activates `transient-mark-mode' temporarily.
5395 jump to the mark, and set the mark from
5396 position popped off the local mark ring (this does not affect the global
5398 mark ring (see `pop-global-mark').
5400 If `set-mark-command-repeat-pop' is non-nil, repeating
5402 off the local (or global) mark ring and jumps there.
5405 argument, unconditionally set mark where point is, even if
5406 `set-mark-command-repeat-pop' is non-nil.
5408 Novice Emacs Lisp programmers often try to use the mark for the wrong
5409 purposes. See the documentation of `set-mark' for more information."
5429 arg)
5443 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5444 If the last global mark pushed was not in the current buffer,
5445 also push LOCATION on the global mark ring.
5446 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5448 Novice Emacs Lisp programmers often try to use the mark for the wrong
5449 purposes. See the documentation of `set-mark' for more information.
5451 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5458 ;; Now push the mark on the global mark ring.
5461 ;; The last global mark pushed was in this same buffer.
5462 ;; Don't push another one.
5463 nil
5472 nil)
5475 "Pop off mark ring into the buffer's actual mark.
5476 Does not set point. Does nothing if mark ring is empty."
5488 "Put the mark where point is now, and point where the mark is now.
5489 This command works even when the mark is not active,
5490 and it reactivates the mark.
5492 If Transient Mark mode is on, a prefix ARG deactivates the mark
5493 if it is active, and otherwise avoids reactivating it. If
5494 Transient Mark mode is off, a prefix ARG enables Transient Mark
5495 mode temporarily."
5509 nil))
5512 "When non-nil, shifted motion keys activate the mark momentarily.
5514 While the mark is activated in this way, any shift-translated point
5515 motion key extends the region, and if Transient Mark mode was off, it
5516 is temporarily turned on. Furthermore, the mark will be deactivated
5517 by any subsequent point motion key that was not shift-translated, or
5518 by any action that normally deactivates the mark in Transient Mark mode.
5520 See `this-command-keys-shift-translated' for the meaning of
5521 shift-translation."
5526 "Activate/deactivate mark depending on invocation thru shift translation.
5527 This function is called by `call-interactively' when a command
5528 with a `^' character in its `interactive' spec is invoked, before
5529 running the command itself.
5531 If `shift-select-mode' is enabled and the command was invoked
5532 through shift translation, set the mark and activate the region
5533 temporarily, unless it was already set in this way. See
5534 `this-command-keys-shift-translated' for the meaning of shift
5535 translation.
5537 Otherwise, if the region has been activated temporarily,
5538 deactivate it, and restore the variable `transient-mark-mode' to
5539 its earlier value."
5546 transient-mark-mode)))
5555 "Toggle Transient Mark mode.
5556 With a prefix argument ARG, enable Transient Mark mode if ARG is
5557 positive, and disable it otherwise. If called from Lisp, enable
5558 Transient Mark mode if ARG is omitted or nil.
5560 Transient Mark mode is a global minor mode. When enabled, the
5561 region is highlighted with the `region' face whenever the mark
5563 and after certain other operations that set the mark but whose
5564 main purpose is something else--for example, incremental search,
5570 Many commands change their behavior when Transient Mark mode is
5571 in effect and the mark is active, by acting on the region instead
5572 of their usual default part of the buffer's text. Examples of
5575 To see the documentation of commands which are sensitive to the
5578 :global t
5579 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5583 "Non-nil means it is ok for commands to call `widen' when they want to.
5584 Some commands will do this in order to go to positions outside
5585 the current accessible part of the buffer.
5587 If `widen-automatically' is nil, these commands will do something else
5591 "Whether the currently executing code is performing an essential task.
5592 This variable should be non-nil only when running code which should not
5593 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5594 user for a password when we are simply scanning a set of files in the
5595 background or displaying possible completions before the user even asked
5599 "Pop off global mark ring and jump to the top location."
5601 ;; Pop entries which refer to non-existent buffers.
5619 \f
5621 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5627 "Move cursor vertically down ARG lines.
5628 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5629 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5630 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5631 function will not vscroll.
5633 ARG defaults to 1.
5635 If there is no character in the target line exactly under the current column,
5636 the cursor is positioned after the character in that line which spans this
5637 column, or at the end of the line if it is not long enough.
5638 If there is no line in the buffer after this one, behavior depends on the
5639 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5640 to create a line, and moves the cursor to that line. Otherwise it moves the
5641 cursor to the end of the buffer.
5643 If the variable `line-move-visual' is non-nil, this command moves
5644 by display lines. Otherwise, it moves by buffer lines, without
5645 taking variable-width characters or continued lines into account.
5649 a semipermanent goal column for this command.
5650 Then instead of trying to move exactly vertically (or as close as possible),
5651 this command moves to the specified goal column (or as close as possible).
5652 The goal column is stored in the variable `goal-column', which is nil
5653 when there is no goal column. Note that setting `goal-column'
5654 overrides `line-move-visual' and causes this command to move by buffer
5655 lines rather than by display lines."
5661 ;; When adding a newline, don't expand an abbrev.
5672 nil)
5675 "Move cursor vertically up ARG lines.
5676 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5677 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5678 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5679 function will not vscroll.
5681 ARG defaults to 1.
5683 If there is no character in the target line exactly over the current column,
5684 the cursor is positioned after the character in that line which spans this
5685 column, or at the end of the line if it is not long enough.
5687 If the variable `line-move-visual' is non-nil, this command moves
5688 by display lines. Otherwise, it moves by buffer lines, without
5689 taking variable-width characters or continued lines into account.
5693 a semipermanent goal column for this command.
5694 Then instead of trying to move exactly vertically (or as close as possible),
5695 this command moves to the specified goal column (or as close as possible).
5696 The goal column is stored in the variable `goal-column', which is nil
5697 when there is no goal column. Note that setting `goal-column'
5698 overrides `line-move-visual' and causes this command to move by buffer
5699 lines rather than by display lines."
5710 nil)
5713 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5714 This means moving to the end of each line moved onto.
5715 The beginning of a blank line does not count as the end of a line.
5716 This has no effect when the variable `line-move-visual' is non-nil."
5722 A non-nil setting overrides the variable `line-move-visual', which see."
5729 "Current goal column for vertical motion.
5730 It is the column where point was at the start of the current run
5731 of vertical motion commands.
5733 When moving by visual lines via the function `line-move-visual', it is a cons
5734 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5735 divided by the default column width, and HSCROLL is the number of
5736 columns by which window is scrolled from left margin.
5738 When the `track-eol' feature is doing its job, the value is
5742 "Non-nil means commands that move by lines ignore invisible newlines.
5743 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5744 as if newlines that are invisible didn't exist, and count
5745 only visible newlines. Thus, moving across across 2 newlines
5746 one of which is invisible will be counted as a one-line move.
5747 Also, a non-nil value causes invisible text to be ignored when
5748 counting columns for the purposes of keeping point in the same
5751 Outline mode sets this."
5756 "When non-nil, `line-move' moves point by visual lines.
5757 This movement is based on where the cursor is displayed on the
5758 screen, instead of relying on buffer contents alone. It takes
5759 into account variable-width characters and line continuation.
5760 If nil, `line-move' moves point by logical lines.
5761 A non-nil setting of `goal-column' overrides the value of this variable
5762 and forces movement by logical lines.
5763 A window that is horizontally scrolled also forces movement by logical
5764 lines."
5769 ;; Only used if display-graphic-p.
5773 "Return the height in pixels of the current buffer's default face font.
5775 If the default font is remapped (see `face-remapping-alist'), the
5776 function returns the height of the remapped face."
5780 ;; Avoid calling font-info if the frame's default font was
5781 ;; not changed since the frame was created. That's because
5782 ;; font-info is expensive for some fonts, see bug #14838.
5788 "Return the width in pixels of the current buffer's default face font.
5790 If the default font is remapped (see `face-remapping-alist'), the
5791 function returns the width of the remapped face."
5795 ;; Avoid calling font-info if the frame's default font was
5796 ;; not changed since the frame was created. That's because
5797 ;; font-info is expensive for some fonts, see bug #14838.
5802 width
5807 "Return the pixel height of current buffer's default-face text line.
5809 The value includes `line-spacing', if any, defined for the buffer
5810 or the frame."
5823 "Return the number of screen lines in the text area of the selected window.
5825 This is different from `window-text-height' in that this function counts
5826 lines in units of the height of the font used by the default face displayed
5827 in the window, not in units of the frame's default font, and also accounts
5828 for `line-spacing', if any, defined for the window's buffer or frame.
5830 The value is a floating-point number."
5835 ;; Returns non-nil if partial move was done.
5838 ;; Move backward (up).
5839 ;; If already vscrolled, reduce vscroll
5845 ;; Move forward (down).
5858 py vs last-line)
5878 col-row)
5883 ;; VPOS > 0 means the last line is only partially visible.
5884 ;; But if the part that is visible is at least as tall as the
5885 ;; default font, that means the line is actually fully
5886 ;; readable, and something like line-spacing is hidden. So in
5887 ;; that case we accept the last line in the window as still
5888 ;; visible, and consider the margin as starting one line
5889 ;; later.
5897 ;; If last line of window is fully visible, and vscrolling
5898 ;; more would make this line invisible, move forward.
5903 nil)
5904 ;; If cursor is not in the bottom scroll margin, and the
5905 ;; current line is is not too tall, move forward.
5907 vpos
5910 nil)
5911 ;; When already vscrolled, we vscroll some more if we can,
5912 ;; or clear vscroll and move forward at end of tall image.
5917 ;; If cursor just entered the bottom scroll margin, move forward,
5918 ;; but also optionally vscroll one line so redisplay won't recenter.
5922 ;; Don't vscroll if the partially-visible line at window
5923 ;; bottom is not too tall (a.k.a. "just one more text
5924 ;; line"): in that case, we do want redisplay to behave
5925 ;; normally, i.e. recenter or whatever.
5926 ;;
5927 ;; Note: ROWH + RBOT from the value returned by
5928 ;; pos-visible-in-window-p give the total height of the
5929 ;; partially-visible glyph row at the end of the window. As
5930 ;; we are dealing with floats, we disregard sub-pixel
5931 ;; discrepancies between that and DLH.
5935 t)
5936 ;; If there are lines above the last line, scroll-up one line.
5939 t)
5940 ;; Finally, start vscroll.
5945 ;; This is like line-move-1 except that it also performs
5946 ;; vertical scrolling of tall images if appropriate.
5947 ;; That is not really a clean thing to do, since it mixes
5948 ;; scrolling with cursor motion. But so far we don't have
5949 ;; a cleaner solution to the problem of making C-n do something
5950 ;; useful given a tall image.
5952 "Move forward ARG lines.
5953 If NOERROR, don't signal an error if we can't move ARG lines.
5954 TO-END is unused.
5955 TRY-VSCROLL controls whether to vscroll tall lines: if either
5956 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5957 not vscroll."
5961 ;; Only vscroll for single line moves
5963 ;; Under scroll-conservatively, the display engine
5964 ;; does this better.
5966 ;; But don't vscroll in a keyboard macro.
5972 ;; Display-based column are incompatible with goal-column.
5974 ;; When the text in the window is scrolled to the left,
5975 ;; display-based motion doesn't make sense (because each
5976 ;; logical line occupies exactly one screen line).
5978 ;; Likewise when the text _was_ scrolled to the left
5979 ;; when the current run of vertical motion commands
5980 ;; started.
5983 auto-hscroll-mode
5985 (>= temporary-goal-column
5988 ;; If we moved into a tall line, set vscroll to make
5989 ;; scrolling through tall images more smooth.
5993 winh)
5999 nil
6003 ;; Display-based alternative to line-move-1.
6004 ;; Arg says how many lines to move. The value is t if we can move the
6005 ;; specified number of lines.
6007 "Move ARG lines forward.
6008 If NOERROR, don't signal an error if we can't move that many lines."
6011 target-hscroll)
6012 ;; Check if the previous command was a line-motion command, or if
6013 ;; we were called from some other command.
6016 ;; If so, there's no need to reset `temporary-goal-column',
6017 ;; but we may need to hscroll.
6021 ;; Otherwise, we should reset `temporary-goal-column'.
6023 x-pos)
6025 ;; Handle the `overflow-newline-into-fringe' case:
6030 ;; In R2L lines, the X pixel coordinate is measured from the
6031 ;; left edge of the window, but columns are still counted
6032 ;; from the logical-order beginning of the line, i.e. from
6033 ;; the right edge in this case. We need to adjust for that.
6039 hscroll))))))
6042 ;; vertical-motion can move more than it was asked to if it moves
6043 ;; across display strings with newlines. We don't want to ring
6044 ;; the bell and announce beginning/end of buffer in that case.
6050 temporary-goal-column))
6051 arg))
6052 arg))
6058 temporary-goal-column))
6059 arg))
6060 arg)))
6063 ;; If the goal column lies on a display string,
6064 ;; `vertical-motion' advances the cursor to the end
6065 ;; of the string. For arg < 0, this can cause the
6066 ;; cursor to get stuck. (Bug#3020).
6070 nil)))))
6072 ;; This is the guts of next-line and previous-line.
6073 ;; Arg says how many lines to move.
6074 ;; The value is t if we can move the specified number of lines.
6076 ;; Don't run any point-motion hooks, and disregard intangibility,
6077 ;; for intermediate positions.
6089 ;; Don't count beg of empty line as end of line
6090 ;; unless we just did explicit end-of-line.
6092 most-positive-fixnum
6096 line-move-ignore-invisible))
6097 ;; Use just newline characters.
6098 ;; Set ARG to 0 if we move as many lines as requested.
6101 ;; This way of moving forward ARG lines
6102 ;; verifies that we have a newline after the last one.
6103 ;; It doesn't get confused by intangible text.
6112 'beginning-of-buffer
6114 nil)))
6115 ;; Move by arg lines, but ignore invisible ones.
6118 ;; If the following character is currently invisible,
6119 ;; skip all characters with that same `invisible' property value.
6122 ;; Move a line.
6123 ;; We don't use `end-of-line', since we want to escape
6124 ;; from field boundaries occurring exactly at point.
6130 ;; If there's no invisibility here, move over the newline.
6139 ;; We avoid vertical-motion when possible
6140 ;; because that has to fontify.
6142 ;; Otherwise move a more sophisticated way.
6149 ;; The logic of this is the same as the loop above,
6150 ;; it just goes in the other direction.
6152 ;; For completely consistency with the forward-motion
6153 ;; case, we should call beginning-of-line here.
6154 ;; However, if point is inside a field and on a
6155 ;; continued line, the call to (vertical-motion -1)
6156 ;; below won't move us back far enough; then we return
6157 ;; to the same column in line-move-finish, and point
6158 ;; gets stuck -- cyd
6176 ;; if our target is the middle of this line.
6181 ;; This is the value the function returns.
6185 ;; If we did not move down as far as desired, at least go
6186 ;; to end of line. Be sure to call point-entered and
6187 ;; point-left-hooks.
6193 ;; If we did not move up as far as desired,
6194 ;; at least go to beginning of line.
6206 ;; Set REPEAT to t to repeat the whole thing.
6213 ;; Compute the end of the line
6214 ;; ignoring effectively invisible newlines.
6216 ;; Like end-of-line but ignores fields.
6223 ;; Move to the desired column.
6226 ;; Corner case: suppose we start out in a field boundary in
6227 ;; the middle of a continued line. When we get to
6228 ;; line-move-finish, point is at the start of a new *screen*
6229 ;; line but the same text line; then line-move-to-column would
6230 ;; move us backwards. Test using C-n with point on the "x" in
6231 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6238 ;; Process intangibility within a line.
6239 ;; With inhibit-point-motion-hooks bound to nil, a call to
6240 ;; goto-char moves point past intangible text.
6242 ;; However, inhibit-point-motion-hooks controls both the
6243 ;; intangibility and the point-entered/point-left hooks. The
6244 ;; following hack avoids calling the point-* hooks
6245 ;; unnecessarily. Note that we move *forward* past intangible
6246 ;; text when the initial and final points are the same.
6251 ;; If intangibility moves us to a different (later) place
6252 ;; in the same line, use that as the destination.
6255 ;; If that position is "too late",
6256 ;; try the previous allowable position.
6257 ;; See if it is ok.
6260 ;; If going forward, don't accept the previous
6261 ;; allowable position if it is before the target line.
6263 ;; If going backward, don't accept the previous
6264 ;; allowable position if it is still after the target line.
6267 ;; As a last resort, use the end of the line.
6270 ;; Now move to the updated destination, processing fields
6271 ;; as well as intangibility.
6275 ;; Ignore field boundaries if the initial and final
6276 ;; positions have the same `field' property, even if the
6277 ;; fields are non-contiguous. This seems to be "nicer"
6278 ;; behavior in many situations.
6281 new
6285 ;; If all this moved us to a different line,
6286 ;; retry everything within that new line.
6288 ;; Repeat the intangibility and field processing.
6292 "Try to find column COL, considering invisibility.
6293 This function works only in certain cases,
6294 because what we really need is for `move-to-column'
6295 and `current-column' to be able to ignore invisible text."
6304 ;; If the following character is currently invisible,
6305 ;; skip all characters with that same `invisible' property value.
6309 ;; Have we advanced to a larger column position?
6311 ;; We have made some progress towards the desired column.
6312 ;; See if we can make any further progress.
6314 ;; Otherwise, go to the place we originally found
6315 ;; and move back over invisible text.
6316 ;; that will get us to the same place on the screen
6317 ;; but with a more reasonable buffer position.
6320 ;; We want the real line beginning, so it's consistent
6321 ;; with bolp below, otherwise we might infloop.
6328 "Move point to end of current line as displayed.
6329 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6330 If point reaches the beginning or end of buffer, it stops there.
6332 To ignore the effects of the `intangible' text or overlay
6333 property, bind `inhibit-point-motion-hooks' to t.
6334 If there is an image in the current line, this function
6335 disregards newlines that are part of the text on which the image
6336 rests."
6346 ;; With bidi reordering, we may not be at bol,
6347 ;; so make sure we are.
6362 ;; If we skipped something intangible and now we're not
6363 ;; really at eol, keep going.
6368 "Move point to beginning of current line as displayed.
6369 \(If there's an image in the line, this disregards newlines
6370 which are part of the text that the image rests on.)
6372 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6373 If point reaches the beginning or end of buffer, it stops there.
6374 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6379 first-vis first-vis-field-value)
6381 ;; Move by lines, if ARG is not 1 (the default).
6386 ;; Move to beginning-of-line, ignoring fields and invisible text.
6392 ;; Now find first visible char in the line.
6397 ;; See if fields would stop us from reaching FIRST-VIS.
6402 ;; If yes, obey them.
6403 first-vis-field-value
6404 ;; Otherwise, move to START with attention to fields.
6405 ;; (It is possible that fields never matter in this case.)
6410 ;; Many people have said they rarely use this feature, and often type
6411 ;; it by accident. Maybe it shouldn't even be on a key.
6416 Those commands will move to this position in the line moved to
6417 rather than trying to keep the same horizontal position.
6418 With a non-nil argument ARG, clears out the goal column
6420 The goal column is stored in the variable `goal-column'.
6421 This is a buffer-local setting."
6428 ;; The older method below can be erroneous if `set-goal-column' is bound
6429 ;; to a sequence containing %
6430 ;;(message (substitute-command-keys
6431 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6432 ;;goal-column)
6439 )
6440 nil)
6441 \f
6442 ;;; Editing based on visual lines, as opposed to logical lines.
6445 "Move point to end of current visual line.
6446 With argument N not nil or 1, move forward N - 1 visual lines first.
6447 If point reaches the beginning or end of buffer, it stops there.
6448 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6454 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6455 ;; constrain to field boundaries, so we don't either.
6459 "Move point to beginning of current visual line.
6460 With argument N not nil or 1, move forward N - 1 visual lines first.
6461 If point reaches the beginning or end of buffer, it stops there.
6462 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6470 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6474 "Kill the rest of the visual line.
6475 With prefix argument ARG, kill that many visual lines from point.
6476 If ARG is negative, kill visual lines backward.
6477 If ARG is zero, kill the text before point on the current visual
6478 line.
6480 If you want to append the killed line to the last killed text,
6483 If the buffer is read-only, Emacs will beep and refrain from deleting
6484 the line, but put the line in the kill ring anyway. This means that
6485 you can use this command to copy text from a read-only buffer.
6486 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6487 even beep.)"
6489 ;; Like in `kill-line', it's better to move point to the other end
6490 ;; of the kill before killing.
6498 ;; Skip any trailing whitespace at the end of the visual line.
6499 ;; We used to do this only if `show-trailing-whitespace' is
6500 ;; nil, but that's wrong; the correct thing would be to check
6501 ;; whether the trailing whitespace is highlighted. But, it's
6502 ;; OK to just do this unconditionally.
6509 "Move cursor vertically down ARG lines.
6510 This is identical to `next-line', except that it always moves
6511 by logical lines instead of visual lines, ignoring the value of
6512 the variable `line-move-visual'."
6519 "Move cursor vertically up ARG lines.
6520 This is identical to `previous-line', except that it always moves
6521 by logical lines instead of visual lines, ignoring the value of
6522 the variable `line-move-visual'."
6529 "Editing based on visual lines."
6538 ;; These keybindings interfere with xterm function keys. Are
6539 ;; there any other suitable bindings?
6540 ;; (define-key map "\M-[" 'previous-logical-line)
6541 ;; (define-key map "\M-]" 'next-logical-line)
6542 map))
6545 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6546 The value should be a list of the form (LEFT RIGHT), where LEFT
6547 and RIGHT are symbols representing the bitmaps to display, to
6548 indicate wrapped lines, in the left and right fringes respectively.
6549 See also `fringe-indicator-alist'.
6550 The default is not to display fringe indicators for wrapped lines.
6551 This variable does not affect fringe indicators displayed for
6552 other purposes."
6567 'continuation
6574 "Toggle visual line based editing (Visual Line mode).
6575 With a prefix argument ARG, enable Visual Line mode if ARG is
6576 positive, and disable it otherwise. If called from Lisp, enable
6577 the mode if ARG is omitted or nil.
6579 When Visual Line mode is enabled, `word-wrap' is turned on in
6580 this buffer, and simple editing commands are redefined to act on
6581 visual lines, not logical lines. See Info node `Visual Line
6582 Mode' for details."
6583 :keymap visual-line-mode-map
6589 ;; Save the local values of some variables, to be restored if
6590 ;; visual-line-mode is turned off.
6592 truncate-partial-width-windows
6593 word-wrap fringe-indicator-alist))
6596 visual-line--saved-state)))
6600 word-wrap t
6601 fringe-indicator-alist
6603 fringe-indicator-alist)))
6617 visual-line-mode turn-on-visual-line-mode)
6619 \f
6621 "Interchange characters around point, moving forward one character.
6622 With prefix arg ARG, effect is to take character before point
6623 and drag it forward past ARG other characters (backward if ARG negative).
6624 If no argument and at end of line, the previous two chars are exchanged."
6632 "Interchange words around point, leaving point at end of them.
6633 With prefix arg ARG, effect is to take word before or around point
6634 and drag it forward past ARG other words (backward if ARG negative).
6635 If ARG is zero, the words around or after point and around or after mark
6636 are interchanged."
6637 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6643 Does not work on a sexp that point is in the middle of
6644 if it is a list or string."
6648 ;; Here we should try to simulate the behavior of
6649 ;; (cons (progn (forward-sexp x) (point))
6650 ;; (progn (forward-sexp (- x)) (point)))
6651 ;; Except that we don't want to rely on the second forward-sexp
6652 ;; putting us back to where we want to be, since forward-sexp-function
6653 ;; might do funny things like infix-precedence.
6658 ;; Jumping over a symbol. We might be inside it, mind you.
6663 ;; Otherwise, we're between sexps. Take a step back before jumping
6664 ;; to make sure we'll obey the same precedence no matter which direction
6665 ;; we're going.
6670 'skip-syntax-forward
6677 "Exchange current line and previous line, leaving point after both.
6678 With argument ARG, takes previous line and moves it past ARG lines.
6679 With argument 0, interchanges line point is in with line mark is in."
6685 ;; Move forward over ARG lines,
6686 ;; but create newlines if necessary.
6693 arg))
6695 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6696 ;; which seems inconsistent with the ARG /= 0 case.
6697 ;; FIXME document SPECIAL.
6699 "Subroutine to do the work of transposing objects.
6700 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6701 moves forward by units of the given object (e.g. forward-sentence,
6702 forward-paragraph). If ARG is zero, exchanges the current object
6703 with the one containing mark. If ARG is an integer, moves the
6704 current object past ARG following (if ARG is positive) or
6705 preceding (if ARG is negative) objects, leaving point after the
6706 current object."
6711 pos1 pos2)
6740 ;; This sequence of insertions attempts to preserve marker
6741 ;; positions at the start and end of the transposed objects.
6755 \f
6757 "Move backward until encountering the beginning of a word.
6758 With argument ARG, do this that many times.
6759 If ARG is omitted or nil, move point backward one word.
6761 The word boundaries are normally determined by the buffer's syntax
6762 table, but `find-word-boundary-function-table', such as set up
6763 by `subword-mode', can change that. If a Lisp program needs to
6764 move by words determined strictly by the syntax table, it should
6765 use `backward-word-strictly' instead."
6770 "Set mark ARG words away from point.
6772 move to with the same argument.
6773 Interactively, if this command is repeated
6774 or (in Transient Mark mode) if the mark is active,
6775 it marks the next ARG words after the ones already marked."
6792 nil t))))
6795 "Kill characters forward until encountering the end of a word.
6796 With argument ARG, do this that many times."
6801 "Kill characters backward until encountering the beginning of a word.
6802 With argument ARG, do this that many times."
6807 "Return the symbol or word that point is on (or a nearby one) as a string.
6808 The return value includes no text properties.
6809 If optional arg STRICT is non-nil, return nil unless point is within
6810 or adjacent to a symbol or word. In all cases the value can be nil
6811 if there is no word nearby.
6812 The function, belying its name, normally finds a symbol.
6813 If optional arg REALLY-WORD is non-nil, it finds just a word."
6822 ;; Point is neither within nor adjacent to a word.
6824 ;; Look for preceding word in same line.
6827 ;; No preceding word in same line.
6828 ;; Look for following word in same line.
6837 ;; If we found something nonempty, return it as a string.
6840 \f
6842 "String for filling to insert at front of new line, or nil for none."
6844 string)
6850 "Regexp to match lines which should not be auto-filled."
6852 regexp)
6856 "The default value for `normal-auto-fill-function'.
6857 This is the default auto-fill function, some major modes use a different one.
6858 Returns t if it really did any work."
6868 nil ;; Auto-filling not required
6872 ;; Choose a fill-prefix automatically.
6880 ;; Use auto-indentation rather than a guessed empty prefix.
6886 ;; Determine where to split the line.
6899 ;; See whether the place we found is any good.
6903 ;; There is no use breaking at end of line.
6905 ;; It is futile to split at the end of the prefix
6906 ;; since we would just insert the prefix again.
6908 ;; Don't split right after a comment starter
6909 ;; since we would just make another comment starter.
6914 limit t)
6916 ;; No good place to break => stop trying.
6918 ;; Ok, we have a useful place to break the line. Do it.
6920 ;; If point is at the fill-point, do not `save-excursion'.
6921 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6922 ;; point will end up before it rather than after it.
6930 ;; Now do justification, if required
6935 ;; If making the new line didn't reduce the hpos of
6936 ;; the end of the line, then give up now;
6937 ;; trying again will not help.
6940 ;; Justify last line.
6942 t)))
6945 "Mode-specific function which line breaks and continues a comment.
6946 This function is called during auto-filling when a comment syntax
6947 is defined.
6948 The function should take a single optional argument, which is a flag
6952 "Break line at point and indent.
6953 If a comment syntax is defined, call `comment-indent-new-line'.
6955 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6956 unless optional argument SOFT is non-nil."
6960 ;; Insert the newline before removing empty space so that markers
6961 ;; get preserved better.
6967 ;; Blindly trust a non-adaptive fill-prefix.
6973 ;; If there's an adaptive prefix, use it unless we're inside
6974 ;; a comment and the prefix is not a comment starter.
6978 ;; If we're not inside a comment, just try to indent.
6982 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6986 ;; `functions' and `hooks' are usually unsafe to set, but setting
6987 ;; auto-fill-function to nil in a file-local setting is safe and
6988 ;; can be useful to prevent auto-filling.
6992 "Toggle automatic line breaking (Auto Fill mode).
6993 With a prefix argument ARG, enable Auto Fill mode if ARG is
6994 positive, and disable it otherwise. If called from Lisp, enable
6995 the mode if ARG is omitted or nil.
6997 When Auto Fill mode is enabled, inserting a space at a column
6998 beyond `current-fill-column' automatically breaks the line at a
6999 previous space.
7001 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7002 non-nil.
7004 The value of `normal-auto-fill-function' specifies the function to use
7005 for `auto-fill-function' when turning Auto Fill mode on."
7010 ;; This holds a document string used to document auto-fill-mode.
7012 "Automatically break line at a previous space, in insertion of text."
7013 nil)
7016 "Unconditionally turn on Auto Fill mode."
7020 "Unconditionally turn off Auto Fill mode."
7026 "Set `fill-column' to specified argument.
7031 ;; We used to use current-column silently, but C-x f is too easily
7032 ;; typed as a typo for C-x C-f, so we turned it into an error and
7033 ;; now an interactive prompt.
7038 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7042 \f
7044 "Set `selective-display' to ARG; clear it if no arg.
7045 When the value of `selective-display' is a number > 0,
7046 lines whose indentation is >= that value are not displayed.
7047 The variable `selective-display' has a separate value for each buffer."
7067 "Toggle truncating of long lines for the current buffer.
7068 When truncating is off, long lines are folded.
7069 With prefix argument ARG, truncate long lines if ARG is positive,
7070 otherwise fold them. Note that in side-by-side windows, this
7071 command has no effect if `truncate-partial-width-windows' is
7072 non-nil."
7084 nil t)))
7089 "Toggle whether to use word-wrapping for continuation lines.
7090 With prefix argument ARG, wrap continuation lines at word boundaries
7091 if ARG is positive, otherwise wrap them at the right screen edge.
7092 This command toggles the value of `word-wrap'. It has no effect
7093 if long lines are truncated."
7109 "Toggle Overwrite mode.
7110 With a prefix argument ARG, enable Overwrite mode if ARG is
7111 positive, and disable it otherwise. If called from Lisp, enable
7112 the mode if ARG is omitted or nil.
7114 When Overwrite mode is enabled, printing characters typed in
7115 replace existing text on a one-for-one basis, rather than pushing
7116 it to the right. At the end of a line, such characters extend
7117 the line. Before a tab, such characters insert until the tab is
7119 overwrite mode; this is supposed to make it easier to insert
7120 characters when necessary."
7125 "Toggle Binary Overwrite mode.
7126 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7127 is positive, and disable it otherwise. If called from Lisp,
7128 enable the mode if ARG is omitted or nil.
7130 When Binary Overwrite mode is enabled, printing characters typed
7131 in replace existing text. Newlines are not treated specially, so
7132 typing at the end of a line joins the line to the next, with the
7133 typed character between them. Typing before a tab character
7134 simply replaces the tab with the character typed.
7136 ordinary typing characters do.
7138 Note that Binary Overwrite mode is not its own minor mode; it is
7139 a specialization of overwrite mode, entered by setting the
7140 `overwrite-mode' variable to `overwrite-mode-binary'."
7145 "Toggle line number display in the mode line (Line Number mode).
7146 With a prefix argument ARG, enable Line Number mode if ARG is
7147 positive, and disable it otherwise. If called from Lisp, enable
7148 the mode if ARG is omitted or nil.
7150 Line numbers do not appear for very large buffers and buffers
7151 with very long lines; see variables `line-number-display-limit'
7152 and `line-number-display-limit-width'."
7156 "Toggle column number display in the mode line (Column Number mode).
7157 With a prefix argument ARG, enable Column Number mode if ARG is
7158 positive, and disable it otherwise.
7160 If called from Lisp, enable the mode if ARG is omitted or nil."
7164 "Toggle buffer size display in the mode line (Size Indication mode).
7165 With a prefix argument ARG, enable Size Indication mode if ARG is
7166 positive, and disable it otherwise.
7168 If called from Lisp, enable the mode if ARG is omitted or nil."
7172 "Toggle auto-saving in the current buffer (Auto Save mode).
7173 With a prefix argument ARG, enable Auto Save mode if ARG is
7174 positive, and disable it otherwise.
7176 If called from Lisp, enable the mode if ARG is omitted or nil."
7178 ;; If auto-save is off because buffer has shrunk,
7179 ;; then toggling should turn it on.
7187 buffer-file-name)
7189 ;; If -1 was stored here, to temporarily turn off saving,
7190 ;; turn it back on.
7193 \f
7195 "Blinking matching of parens and expressions."
7200 "Non-nil means show matching open-paren when close-paren is inserted.
7201 If t, highlight the paren. If `jump', briefly move cursor to its
7202 position. If `jump-offscreen', move cursor there even if the
7203 position is off screen. With any other non-nil value, the
7204 off-screen position of the opening paren will be shown in the
7205 echo area."
7214 "Non-nil means show matching open-paren when it is on screen.
7215 If nil, don't show it (but the open-paren can still be shown
7216 in the echo area when it is off screen).
7218 This variable has no effect if `blink-matching-paren' is nil.
7219 \(In that case, the open-paren is never shown.)
7220 It is also ignored if `show-paren-mode' is enabled."
7225 "If non-nil, maximum distance to search backwards for matching open-paren.
7226 If nil, search stops at the beginning of the accessible portion of the buffer."
7232 "Time in seconds to delay after showing a matching paren."
7237 "If nil, `blink-matching-paren' ignores comments.
7238 More precisely, when looking for the matching parenthesis,
7239 it skips the contents of comments that end before point."
7244 "Return whether or not START...END are matching parens.
7245 END is the current point and START is the blink position.
7246 START might be nil if no matching starter was found.
7247 Returns non-nil if we find there is a mismatch."
7252 ;; For self-matched chars like " and $, we can't know when they're
7253 ;; mismatched or unmatched, so we can only do it for parens.
7258 ;; The cdr might hold a new paren-class info rather than
7259 ;; a matching-char info, in which case the two CDRs
7260 ;; should match.
7264 "Function to check parentheses mismatches.
7265 The function takes two arguments (START and END) where START is the
7266 position just before the opening token and END is the position right after.
7267 START can be nil, if it was not found.
7274 ol)
7278 "Momentarily highlight the beginning of the sexp before point."
7281 blink-matching-paren)
7291 oldpos))
7299 ;; backward-sexp skips backward over prefix chars,
7300 ;; so move back to the matching paren.
7323 ;; Matching open within window, temporarily move to or highlight
7324 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7325 ;; is non-nil.
7342 ;; Show what precedes the open in its line, if anything.
7347 ;; Show what follows the open in its line, if anything.
7354 ;; Otherwise show the previous nonblank line,
7355 ;; if there is one.
7364 ;; Replace the newline and other whitespace with `...'.
7365 "..."
7367 ;; There is nothing to show except the char itself.
7370 "Matches %s"
7374 "Function called, if non-nil, whenever a close parenthesis is inserted.
7380 blink-paren-function
7383 ;; Verify an even number of quoting characters precede the close.
7384 ;; FIXME: Also check if this parenthesis closes a comment as
7385 ;; can happen in Pascal and SML.
7396 ;; Most likely, this hook is nil, so this arg doesn't matter,
7397 ;; but I use it as a reminder that this function usually
7398 ;; likes to be run after others since it does
7399 ;; `sit-for'. That's also the reason it get a `priority' prop
7400 ;; of 100.
7402 \f
7403 ;; This executes C-g typed while Emacs is waiting for a command.
7404 ;; Quitting out of a program does not go through here;
7405 ;; that happens in the QUIT macro at the C code level.
7407 "Signal a `quit' condition.
7408 During execution of Lisp code, this character causes a quit directly.
7409 At top-level, as an editor command, this simply beeps."
7411 ;; Avoid adding the region to the window selection.
7419 ;; Force the next redisplay cycle to remove the "Def" indicator from
7420 ;; all the mode lines.
7434 This command can exit an interactive command such as `query-replace',
7435 can clear out a prefix argument or a region,
7436 can get out of the minibuffer or other recursive edit,
7437 cancel the use of the current buffer (for special-purpose buffers),
7438 or go back to just one window (by deleting all but the selected window)."
7446 nil)
7457 "Play sound stored in FILE.
7458 VOLUME and DEVICE correspond to the keywords of the sound
7459 specification for `play-sound'."
7469 \f
7471 "Your preference for a mail reading package.
7472 This is used by some keybindings which support reading mail.
7473 See also `mail-user-agent' concerning sending mail."
7483 "Your preference for a mail composition package.
7484 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7485 outgoing email message. This variable lets you specify which
7486 mail-sending package you prefer.
7488 Valid values include:
7490 `message-user-agent' -- use the Message package.
7491 See Info node `(message)'.
7492 `sendmail-user-agent' -- use the Mail package.
7493 See Info node `(emacs)Sending Mail'.
7494 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7495 See Info node `(mh-e)'.
7496 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7497 paraphernalia if Gnus is running, particularly
7498 the Gcc: header for archiving.
7500 Additional valid symbols may be available; check with the author of
7501 your package for details. The function should return non-nil if it
7502 succeeds.
7504 See also `read-mail-command' concerning reading mail."
7507 message-user-agent)
7510 sendmail-user-agent)
7513 mh-e-user-agent)
7516 gnus-user-agent)
7522 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7523 If the value of `mail-user-agent' is the default, and the user
7524 appears to have customizations applying to the old default,
7525 `compose-mail' issues a warning."
7531 "If the buffer starts with a mail header, move point to the header's end.
7532 Otherwise, moves to `point-min'.
7533 The end of the header is the start of the next line, if there is one,
7534 else the end of the last line. This function obeys RFC822."
7540 ;; Used by Rmail (e.g., rmail-forward).
7542 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7546 switch-function yank-action send-actions
7547 return-action)
7548 "Start composing a mail message to send.
7549 This uses the user's chosen mail composition package
7550 as selected with the variable `mail-user-agent'.
7551 The optional arguments TO and SUBJECT specify recipients
7552 and the initial Subject field, respectively.
7554 OTHER-HEADERS is an alist specifying additional
7555 header fields. Elements look like (HEADER . VALUE) where both
7556 HEADER and VALUE are strings.
7558 CONTINUE, if non-nil, says to continue editing a message already
7559 being composed. Interactively, CONTINUE is the prefix argument.
7561 SWITCH-FUNCTION, if non-nil, is a function to use to
7562 switch to and display the buffer used for mail composition.
7564 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7565 to insert the raw text of the message being replied to.
7566 It has the form (FUNCTION . ARGS). The user agent will apply
7567 FUNCTION to ARGS, to insert the raw text of the original message.
7568 \(The user agent will also run `mail-citation-hook', *after* the
7569 original text has been inserted in this way.)
7571 SEND-ACTIONS is a list of actions to call when the message is sent.
7572 Each action has the form (FUNCTION . ARGS).
7574 RETURN-ACTION, if non-nil, is an action for returning to the
7575 caller. It has the form (FUNCTION . ARGS). The function is
7576 called after the mail has been sent or put aside, and the mail
7577 buffer buried."
7581 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7582 ;; from sendmail-user-agent to message-user-agent. Some users may
7583 ;; encounter incompatibilities. This hack tries to detect problems
7584 ;; and warn about them.
7589 mail-yank-hooks mail-archive-file-name
7590 mail-default-reply-to mail-mailing-lists
7591 mail-self-blind))
7598 The default mail mode is now Message mode.
7599 You have the following Mail mode variable%s customized:
7601 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7608 yank-action send-actions return-action)))
7611 yank-action send-actions
7612 return-action)
7616 'switch-to-buffer-other-window yank-action send-actions
7617 return-action))
7620 yank-action send-actions
7621 return-action)
7625 'switch-to-buffer-other-frame yank-action send-actions
7626 return-action))
7628 \f
7630 "History of values entered with `set-variable'.
7632 Maximum length of the history list is determined by the value
7636 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7637 VARIABLE should be a user option variable name, a Lisp variable
7638 meant to be customized by users. You should enter VALUE in Lisp syntax,
7639 so if you want VALUE to be a string, you must surround it with doublequotes.
7640 VALUE is used literally, not evaluated.
7642 If VARIABLE has a `variable-interactive' property, that is used as if
7643 it were the arg to `interactive' (which see) to interactively read VALUE.
7645 If VARIABLE has been defined with `defcustom', then the type information
7646 in the definition is used to check that VALUE is valid.
7648 Note that this function is at heart equivalent to the basic `set' function.
7649 For a variable defined with `defcustom', it does not pay attention to
7650 any :set property that the variable might have (if you want that, use
7653 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7658 default-var)
7674 var obsolete)
7677 ;; Use VAR's `variable-interactive' property
7678 ;; as an interactive spec for prompting.
7681 arg))
7683 read-expression-map t
7684 'set-variable-value-history
7693 ;; Match with custom type.
7705 ;; Force a thorough redisplay for the case that the variable
7706 ;; has an effect on the display, like `tab-width' has.
7708 \f
7709 ;; Define the major mode for lists of completions.
7719 (define-key map [right] 'next-completion)
7721 (define-key map [backtab] 'previous-completion)
7722 (define-key map "q" 'quit-window)
7723 (define-key map "z" 'kill-this-buffer)
7724 map)
7725 "Local map for completion list buffers.")
7727 ;; Completion mode is suitable only for specially formatted data.
7728 (put 'completion-list-mode 'mode-class 'special)
7730 (defvar completion-reference-buffer nil
7731 "Record the buffer that was current when the completion list was requested.
7732 This is a local variable in the completion list buffer.
7733 Initial value is nil to avoid some compiler warnings.")
7735 (defvar completion-no-auto-exit nil
7736 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7737 This also applies to other functions such as `choose-completion'.")
7739 (defvar completion-base-position nil
7740 "Position of the base of the text corresponding to the shown completions.
7741 This variable is used in the *Completions* buffers.
7742 Its value is a list of the form (START END) where START is the place
7743 where the completion should be inserted and END (if non-nil) is the end
7744 of the text to replace. If END is nil, point is used instead.")
7746 (defvar completion-list-insert-choice-function #'completion--replace
7747 "Function to use to insert the text chosen in *Completions*.
7748 Called with three arguments (BEG END TEXT), it should replace the text
7749 between BEG and END with TEXT. Expected to be set buffer-locally
7750 in the *Completions* buffer.")
7752 (defvar completion-base-size nil
7753 "Number of chars before point not involved in completion.
7754 This is a local variable in the completion list buffer.
7755 It refers to the chars in the minibuffer if completing in the
7756 minibuffer, or in `completion-reference-buffer' otherwise.
7757 Only characters in the field at point are included.
7759 If nil, Emacs determines which part of the tail end of the
7760 buffer's text is involved in completion by comparing the text
7761 directly.")
7762 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7764 (defun delete-completion-window ()
7765 "Delete the completion list window.
7766 Go to the window from which completion was requested."
7767 (interactive)
7768 (let ((buf completion-reference-buffer))
7769 (if (one-window-p t)
7770 (if (window-dedicated-p) (delete-frame))
7771 (delete-window (selected-window))
7772 (if (get-buffer-window buf)
7773 (select-window (get-buffer-window buf))))))
7775 (defun previous-completion (n)
7776 "Move to the previous item in the completion list."
7777 (interactive "p")
7778 (next-completion (- n)))
7780 (defun next-completion (n)
7781 "Move to the next item in the completion list.
7782 With prefix argument N, move N items (negative N means move backward)."
7783 (interactive "p")
7784 (let ((beg (point-min)) (end (point-max)))
7785 (while (and (> n 0) (not (eobp)))
7786 ;; If in a completion, move to the end of it.
7787 (when (get-text-property (point) 'mouse-face)
7788 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7789 ;; Move to start of next one.
7790 (unless (get-text-property (point) 'mouse-face)
7791 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7792 (setq n (1- n)))
7793 (while (and (< n 0) (not (bobp)))
7794 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7795 ;; If in a completion, move to the start of it.
7796 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7797 (goto-char (previous-single-property-change
7798 (point) 'mouse-face nil beg)))
7799 ;; Move to end of the previous completion.
7800 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7801 (goto-char (previous-single-property-change
7802 (point) 'mouse-face nil beg)))
7803 ;; Move to the start of that one.
7804 (goto-char (previous-single-property-change
7805 (point) 'mouse-face nil beg))
7806 (setq n (1+ n))))))
7808 (defun choose-completion (&optional event)
7809 "Choose the completion at point.
7810 If EVENT, use EVENT's position to determine the starting position."
7811 (interactive (list last-nonmenu-event))
7812 ;; In case this is run via the mouse, give temporary modes such as
7813 ;; isearch a chance to turn off.
7814 (run-hooks 'mouse-leave-buffer-hook)
7815 (with-current-buffer (window-buffer (posn-window (event-start event)))
7816 (let ((buffer completion-reference-buffer)
7817 (base-size completion-base-size)
7818 (base-position completion-base-position)
7819 (insert-function completion-list-insert-choice-function)
7820 (choice
7821 (save-excursion
7822 (goto-char (posn-point (event-start event)))
7823 (let (beg end)
7824 (cond
7825 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7826 (setq end (point) beg (1+ (point))))
7827 ((and (not (bobp))
7828 (get-text-property (1- (point)) 'mouse-face))
7829 (setq end (1- (point)) beg (point)))
7830 (t (error "No completion here")))
7831 (setq beg (previous-single-property-change beg 'mouse-face))
7832 (setq end (or (next-single-property-change end 'mouse-face)
7833 (point-max)))
7834 (buffer-substring-no-properties beg end)))))
7836 (unless (buffer-live-p buffer)
7837 (error "Destination buffer is dead"))
7838 (quit-window nil (posn-window (event-start event)))
7840 (with-current-buffer buffer
7841 (choose-completion-string
7842 choice buffer
7843 (or base-position
7844 (when base-size
7845 ;; Someone's using old completion code that doesn't know
7846 ;; about base-position yet.
7847 (list (+ base-size (field-beginning))))
7848 ;; If all else fails, just guess.
7849 (list (choose-completion-guess-base-position choice)))
7850 insert-function)))))
7852 ;; Delete the longest partial match for STRING
7853 ;; that can be found before POINT.
7854 (defun choose-completion-guess-base-position (string)
7855 (save-excursion
7856 (let ((opoint (point))
7857 len)
7858 ;; Try moving back by the length of the string.
7859 (goto-char (max (- (point) (length string))
7860 (minibuffer-prompt-end)))
7861 ;; See how far back we were actually able to move. That is the
7862 ;; upper bound on how much we can match and delete.
7863 (setq len (- opoint (point)))
7864 (if completion-ignore-case
7865 (setq string (downcase string)))
7866 (while (and (> len 0)
7867 (let ((tail (buffer-substring (point) opoint)))
7868 (if completion-ignore-case
7869 (setq tail (downcase tail)))
7870 (not (string= tail (substring string 0 len)))))
7871 (setq len (1- len))
7872 (forward-char 1))
7873 (point))))
7875 (defun choose-completion-delete-max-match (string)
7876 (declare (obsolete choose-completion-guess-base-position "23.2"))
7877 (delete-region (choose-completion-guess-base-position string) (point)))
7879 (defvar choose-completion-string-functions nil
7880 "Functions that may override the normal insertion of a completion choice.
7881 These functions are called in order with three arguments:
7882 CHOICE - the string to insert in the buffer,
7883 BUFFER - the buffer in which the choice should be inserted,
7884 BASE-POSITION - where to insert the completion.
7886 If a function in the list returns non-nil, that function is supposed
7887 to have inserted the CHOICE in the BUFFER, and possibly exited
7888 the minibuffer; no further functions will be called.
7890 If all functions in the list return nil, that means to use
7891 the default method of inserting the completion in BUFFER.")
7893 (defun choose-completion-string (choice &optional
7894 buffer base-position insert-function)
7895 "Switch to BUFFER and insert the completion choice CHOICE.
7896 BASE-POSITION says where to insert the completion.
7897 INSERT-FUNCTION says how to insert the completion and falls
7898 back on `completion-list-insert-choice-function' when nil."
7900 ;; If BUFFER is the minibuffer, exit the minibuffer
7901 ;; unless it is reading a file name and CHOICE is a directory,
7902 ;; or completion-no-auto-exit is non-nil.
7904 ;; Some older code may call us passing `base-size' instead of
7905 ;; `base-position'. It's difficult to make any use of `base-size',
7906 ;; so we just ignore it.
7907 (unless (consp base-position)
7908 (message "Obsolete `base-size' passed to choose-completion-string")
7909 (setq base-position nil))
7911 (let* ((buffer (or buffer completion-reference-buffer))
7912 (mini-p (minibufferp buffer)))
7913 ;; If BUFFER is a minibuffer, barf unless it's the currently
7914 ;; active minibuffer.
7915 (if (and mini-p
7916 (not (and (active-minibuffer-window)
7917 (equal buffer
7918 (window-buffer (active-minibuffer-window))))))
7919 (error "Minibuffer is not active for completion")
7920 ;; Set buffer so buffer-local choose-completion-string-functions works.
7921 (set-buffer buffer)
7922 (unless (run-hook-with-args-until-success
7923 'choose-completion-string-functions
7924 ;; The fourth arg used to be `mini-p' but was useless
7925 ;; (since minibufferp can be used on the `buffer' arg)
7926 ;; and indeed unused. The last used to be `base-size', so we
7927 ;; keep it to try and avoid breaking old code.
7928 choice buffer base-position nil)
7929 ;; This remove-text-properties should be unnecessary since `choice'
7930 ;; comes from buffer-substring-no-properties.
7931 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7932 ;; Insert the completion into the buffer where it was requested.
7933 (funcall (or insert-function completion-list-insert-choice-function)
7934 (or (car base-position) (point))
7935 (or (cadr base-position) (point))
7936 choice)
7937 ;; Update point in the window that BUFFER is showing in.
7938 (let ((window (get-buffer-window buffer t)))
7939 (set-window-point window (point)))
7940 ;; If completing for the minibuffer, exit it with this choice.
7941 (and (not completion-no-auto-exit)
7942 (minibufferp buffer)
7943 minibuffer-completion-table
7944 ;; If this is reading a file name, and the file name chosen
7945 ;; is a directory, don't exit the minibuffer.
7946 (let* ((result (buffer-substring (field-beginning) (point)))
7947 (bounds
7948 (completion-boundaries result minibuffer-completion-table
7949 minibuffer-completion-predicate
7950 "")))
7951 (if (eq (car bounds) (length result))
7952 ;; The completion chosen leads to a new set of completions
7953 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7954 (let ((mini (active-minibuffer-window)))
7955 (select-window mini)
7956 (when minibuffer-auto-raise
7957 (raise-frame (window-frame mini))))
7958 (exit-minibuffer))))))))
7960 (define-derived-mode completion-list-mode nil "Completion List"
7961 "Major mode for buffers showing lists of possible completions.
7963 to select the completion near point.
7964 Or click to select one with the mouse.
7967 (set (make-local-variable 'completion-base-size) nil))
7969 (defun completion-list-mode-finish ()
7970 "Finish setup of the completions buffer.
7971 Called from `temp-buffer-show-hook'."
7972 (when (eq major-mode 'completion-list-mode)
7973 (setq buffer-read-only t)))
7975 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7978 ;; Variables and faces used in `completion-setup-function'.
7980 (defcustom completion-show-help t
7981 "Non-nil means show help message in *Completions* buffer."
7982 :type 'boolean
7983 :version "22.1"
7984 :group 'completion)
7986 ;; This function goes in completion-setup-hook, so that it is called
7987 ;; after the text of the completion list buffer is written.
7988 (defun completion-setup-function ()
7989 (let* ((mainbuf (current-buffer))
7990 (base-dir
7991 ;; FIXME: This is a bad hack. We try to set the default-directory
7992 ;; in the *Completions* buffer so that the relative file names
7993 ;; displayed there can be treated as valid file names, independently
7994 ;; from the completion context. But this suffers from many problems:
7995 ;; - It's not clear when the completions are file names. With some
7996 ;; completion tables (e.g. bzr revision specs), the listed
7997 ;; completions can mix file names and other things.
7998 ;; - It doesn't pay attention to possible quoting.
7999 ;; - With fancy completion styles, the code below will not always
8000 ;; find the right base directory.
8001 (if minibuffer-completing-file-name
8002 (file-name-as-directory
8003 (expand-file-name
8004 (buffer-substring (minibuffer-prompt-end)
8005 (- (point) (or completion-base-size 0))))))))
8006 (with-current-buffer standard-output
8007 (let ((base-size completion-base-size) ;Read before killing localvars.
8008 (base-position completion-base-position)
8009 (insert-fun completion-list-insert-choice-function))
8010 (completion-list-mode)
8011 (set (make-local-variable 'completion-base-size) base-size)
8012 (set (make-local-variable 'completion-base-position) base-position)
8013 (set (make-local-variable 'completion-list-insert-choice-function)
8014 insert-fun))
8015 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8016 (if base-dir (setq default-directory base-dir))
8017 ;; Maybe insert help string.
8018 (when completion-show-help
8019 (goto-char (point-min))
8020 (if (display-mouse-p)
8022 (insert (substitute-command-keys
8026 (add-hook 'completion-setup-hook 'completion-setup-function)
8028 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8029 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8031 (defun switch-to-completions ()
8032 "Select the completion list window."
8033 (interactive)
8034 (let ((window (or (get-buffer-window "*Completions*" 0)
8035 ;; Make sure we have a completions window.
8036 (progn (minibuffer-completion-help)
8037 (get-buffer-window "*Completions*" 0)))))
8038 (when window
8039 (select-window window)
8040 ;; In the new buffer, go to the first completion.
8041 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8042 (when (bobp)
8043 (next-completion 1)))))
8044 \f
8045 ;;; Support keyboard commands to turn on various modifiers.
8047 ;; These functions -- which are not commands -- each add one modifier
8048 ;; to the following event.
8050 (defun event-apply-alt-modifier (_ignore-prompt)
8053 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8054 (defun event-apply-super-modifier (_ignore-prompt)
8057 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8058 (defun event-apply-hyper-modifier (_ignore-prompt)
8061 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8062 (defun event-apply-shift-modifier (_ignore-prompt)
8065 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8066 (defun event-apply-control-modifier (_ignore-prompt)
8069 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8070 (defun event-apply-meta-modifier (_ignore-prompt)
8073 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8075 (defun event-apply-modifier (event symbol lshiftby prefix)
8076 "Apply a modifier flag to event EVENT.
8077 SYMBOL is the name of this modifier, as a symbol.
8078 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8079 PREFIX is the string that represents this modifier in an event type symbol."
8080 (if (numberp event)
8081 (cond ((eq symbol 'control)
8082 (if (and (<= (downcase event) ?z)
8083 (>= (downcase event) ?a))
8084 (- (downcase event) ?a -1)
8085 (if (and (<= (downcase event) ?Z)
8086 (>= (downcase event) ?A))
8087 (- (downcase event) ?A -1)
8088 (logior (lsh 1 lshiftby) event))))
8089 ((eq symbol 'shift)
8090 (if (and (<= (downcase event) ?z)
8091 (>= (downcase event) ?a))
8092 (upcase event)
8093 (logior (lsh 1 lshiftby) event)))
8094 (t
8095 (logior (lsh 1 lshiftby) event)))
8096 (if (memq symbol (event-modifiers event))
8097 event
8098 (let ((event-type (if (symbolp event) event (car event))))
8099 (setq event-type (intern (concat prefix (symbol-name event-type))))
8100 (if (symbolp event)
8101 event-type
8102 (cons event-type (cdr event)))))))
8104 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8105 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8106 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8107 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8108 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8109 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8110 \f
8111 ;;;; Keypad support.
8113 ;; Make the keypad keys act like ordinary typing keys. If people add
8114 ;; bindings for the function key symbols, then those bindings will
8115 ;; override these, so this shouldn't interfere with any existing
8116 ;; bindings.
8118 ;; Also tell read-char how to handle these keys.
8119 (mapc
8120 (lambda (keypad-normal)
8121 (let ((keypad (nth 0 keypad-normal))
8122 (normal (nth 1 keypad-normal)))
8123 (put keypad 'ascii-character normal)
8124 (define-key function-key-map (vector keypad) (vector normal))))
8125 ;; See also kp-keys bound in bindings.el.
8126 '((kp-space ?\s)
8129 (kp-separator ?,)
8130 (kp-equal ?=)
8131 ;; Do the same for various keys that are represented as symbols under
8132 ;; GUIs but naturally correspond to characters.
8133 (backspace 127)
8134 (delete 127)
8137 (clear ?\C-l)
8138 (return ?\C-m)
8139 (escape ?\e)
8140 ))
8141 \f
8142 ;;;;
8143 ;;;; forking a twin copy of a buffer.
8144 ;;;;
8146 (defvar clone-buffer-hook nil
8147 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8149 (defvar clone-indirect-buffer-hook nil
8150 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8152 (defun clone-process (process &optional newname)
8153 "Create a twin copy of PROCESS.
8154 If NEWNAME is nil, it defaults to PROCESS' name;
8155 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8156 If PROCESS is associated with a buffer, the new process will be associated
8157 with the current buffer instead.
8158 Returns nil if PROCESS has already terminated."
8159 (setq newname (or newname (process-name process)))
8161 (setq newname (substring newname 0 (match-beginning 0))))
8162 (when (memq (process-status process) '(run stop open))
8163 (let* ((process-connection-type (process-tty-name process))
8164 (new-process
8165 (if (memq (process-status process) '(open))
8166 (let ((args (process-contact process t)))
8167 (setq args (plist-put args :name newname))
8168 (setq args (plist-put args :buffer
8169 (if (process-buffer process)
8170 (current-buffer))))
8171 (apply 'make-network-process args))
8172 (apply 'start-process newname
8173 (if (process-buffer process) (current-buffer))
8174 (process-command process)))))
8175 (set-process-query-on-exit-flag
8176 new-process (process-query-on-exit-flag process))
8177 (set-process-inherit-coding-system-flag
8178 new-process (process-inherit-coding-system-flag process))
8179 (set-process-filter new-process (process-filter process))
8180 (set-process-sentinel new-process (process-sentinel process))
8181 (set-process-plist new-process (copy-sequence (process-plist process)))
8182 new-process)))
8184 ;; things to maybe add (currently partly covered by `funcall mode'):
8185 ;; - syntax-table
8186 ;; - overlays
8187 (defun clone-buffer (&optional newname display-flag)
8188 "Create and return a twin copy of the current buffer.
8189 Unlike an indirect buffer, the new buffer can be edited
8190 independently of the old one (if it is not read-only).
8191 NEWNAME is the name of the new buffer. It may be modified by
8192 adding or incrementing <N> at the end as necessary to create a
8193 unique buffer name. If nil, it defaults to the name of the
8194 current buffer, with the proper suffix. If DISPLAY-FLAG is
8195 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8196 clone a file-visiting buffer, or a buffer whose major mode symbol
8197 has a non-nil `no-clone' property, results in an error.
8199 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8200 current buffer with appropriate suffix. However, if a prefix
8201 argument is given, then the command prompts for NEWNAME in the
8202 minibuffer.
8204 This runs the normal hook `clone-buffer-hook' in the new buffer
8205 after it has been set up properly in other respects."
8206 (interactive
8207 (progn
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 (list (if current-prefix-arg
8213 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8214 t)))
8215 (if buffer-file-name
8216 (error "Cannot clone a file-visiting buffer"))
8217 (if (get major-mode 'no-clone)
8218 (error "Cannot clone a buffer in %s mode" mode-name))
8219 (setq newname (or newname (buffer-name)))
8221 (setq newname (substring newname 0 (match-beginning 0))))
8222 (let ((buf (current-buffer))
8223 (ptmin (point-min))
8224 (ptmax (point-max))
8225 (pt (point))
8226 (mk (if mark-active (mark t)))
8227 (modified (buffer-modified-p))
8228 (mode major-mode)
8229 (lvars (buffer-local-variables))
8230 (process (get-buffer-process (current-buffer)))
8231 (new (generate-new-buffer (or newname (buffer-name)))))
8232 (save-restriction
8233 (widen)
8234 (with-current-buffer new
8235 (insert-buffer-substring buf)))
8236 (with-current-buffer new
8237 (narrow-to-region ptmin ptmax)
8238 (goto-char pt)
8239 (if mk (set-mark mk))
8240 (set-buffer-modified-p modified)
8242 ;; Clone the old buffer's process, if any.
8243 (when process (clone-process process))
8245 ;; Now set up the major mode.
8246 (funcall mode)
8248 ;; Set up other local variables.
8249 (mapc (lambda (v)
8250 (condition-case () ;in case var is read-only
8251 (if (symbolp v)
8252 (makunbound v)
8253 (set (make-local-variable (car v)) (cdr v)))
8254 (error nil)))
8255 lvars)
8257 ;; Run any hooks (typically set up by the major mode
8258 ;; for cloning to work properly).
8259 (run-hooks 'clone-buffer-hook))
8260 (if display-flag
8261 ;; Presumably the current buffer is shown in the selected frame, so
8262 ;; we want to display the clone elsewhere.
8263 (let ((same-window-regexps nil)
8264 (same-window-buffer-names))
8265 (pop-to-buffer new)))
8266 new))
8269 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8270 "Create an indirect buffer that is a twin copy of the current buffer.
8272 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8273 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8274 or if not called with a prefix arg, NEWNAME defaults to the current
8275 buffer's name. The name is modified by adding a `<N>' suffix to it
8276 or by incrementing the N in an existing suffix. Trying to clone a
8277 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8278 property results in an error.
8280 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8281 This is always done when called interactively.
8283 Optional third arg NORECORD non-nil means do not put this buffer at the
8284 front of the list of recently selected ones.
8286 Returns the newly created indirect buffer."
8287 (interactive
8288 (progn
8289 (if (get major-mode 'no-clone-indirect)
8290 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8291 (list (if current-prefix-arg
8292 (read-buffer "Name of indirect buffer: " (current-buffer)))
8293 t)))
8294 (if (get major-mode 'no-clone-indirect)
8295 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8296 (setq newname (or newname (buffer-name)))
8298 (setq newname (substring newname 0 (match-beginning 0))))
8299 (let* ((name (generate-new-buffer-name newname))
8300 (buffer (make-indirect-buffer (current-buffer) name t)))
8301 (with-current-buffer buffer
8302 (run-hooks 'clone-indirect-buffer-hook))
8303 (when display-flag
8304 (pop-to-buffer buffer norecord))
8305 buffer))
8308 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8309 "Like `clone-indirect-buffer' but display in another window."
8310 (interactive
8311 (progn
8312 (if (get major-mode 'no-clone-indirect)
8313 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8314 (list (if current-prefix-arg
8315 (read-buffer "Name of indirect buffer: " (current-buffer)))
8316 t)))
8317 (let ((pop-up-windows t))
8318 (clone-indirect-buffer newname display-flag norecord)))
8320 \f
8321 ;;; Handling of Backspace and Delete keys.
8323 (defcustom normal-erase-is-backspace 'maybe
8324 "Set the default behavior of the Delete and Backspace keys.
8326 If set to t, Delete key deletes forward and Backspace key deletes
8327 backward.
8329 If set to nil, both Delete and Backspace keys delete backward.
8331 If set to `maybe' (which is the default), Emacs automatically
8332 selects a behavior. On window systems, the behavior depends on
8333 the keyboard used. If the keyboard has both a Backspace key and
8334 a Delete key, and both are mapped to their usual meanings, the
8335 option's default value is set to t, so that Backspace can be used
8336 to delete backward, and Delete can be used to delete forward.
8338 If not running under a window system, customizing this option
8339 accomplishes a similar effect by mapping C-h, which is usually
8340 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8341 via `keyboard-translate'. The former functionality of C-h is
8342 available on the F1 key. You should probably not use this
8343 setting if you don't have both Backspace, Delete and F1 keys.
8345 Setting this variable with setq doesn't take effect. Programmatically,
8346 call `normal-erase-is-backspace-mode' (which see) instead."
8347 :type '(choice (const :tag "Off" nil)
8348 (const :tag "Maybe" maybe)
8349 (other :tag "On" t))
8350 :group 'editing-basics
8351 :version "21.1"
8352 :set (lambda (symbol value)
8353 ;; The fboundp is because of a problem with :set when
8354 ;; dumping Emacs. It doesn't really matter.
8355 (if (fboundp 'normal-erase-is-backspace-mode)
8356 (normal-erase-is-backspace-mode (or value 0))
8357 (set-default symbol value))))
8359 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8360 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8361 (unless frame (setq frame (selected-frame)))
8362 (with-selected-frame frame
8363 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8364 (normal-erase-is-backspace-mode
8365 (if (if (eq normal-erase-is-backspace 'maybe)
8366 (and (not noninteractive)
8367 (or (memq system-type '(ms-dos windows-nt))
8368 (memq window-system '(w32 ns))
8369 (and (memq window-system '(x))
8370 (fboundp 'x-backspace-delete-keys-p)
8371 (x-backspace-delete-keys-p))
8372 ;; If the terminal Emacs is running on has erase char
8373 ;; set to ^H, use the Backspace key for deleting
8374 ;; backward, and the Delete key for deleting forward.
8375 (and (null window-system)
8376 (eq tty-erase-char ?\^H))))
8377 normal-erase-is-backspace)
8378 1 0)))))
8380 (define-minor-mode normal-erase-is-backspace-mode
8381 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8382 With a prefix argument ARG, enable this feature if ARG is
8383 positive, and disable it otherwise. If called from Lisp, enable
8384 the mode if ARG is omitted or nil.
8386 On window systems, when this mode is on, Delete is mapped to C-d
8387 and Backspace is mapped to DEL; when this mode is off, both
8388 Delete and Backspace are mapped to DEL. (The remapping goes via
8389 `local-function-key-map', so binding Delete or Backspace in the
8390 global or local keymap will override that.)
8392 In addition, on window systems, the bindings of C-Delete, M-Delete,
8393 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8394 the global keymap in accordance with the functionality of Delete and
8395 Backspace. For example, if Delete is remapped to C-d, which deletes
8396 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8397 to DEL, which deletes backward, C-Delete is bound to
8398 `backward-kill-word'.
8400 If not running on a window system, a similar effect is accomplished by
8401 remapping C-h (normally produced by the Backspace key) and DEL via
8402 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8403 to C-d; if it's off, the keys are not remapped.
8405 When not running on a window system, and this mode is turned on, the
8406 former functionality of C-h is available on the F1 key. You should
8407 probably not turn on this mode on a text-only terminal if you don't
8408 have both Backspace, Delete and F1 keys.
8410 See also `normal-erase-is-backspace'."
8411 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8412 . (lambda (v)
8413 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8414 (if v 1 0))))
8415 (let ((enabled (eq 1 (terminal-parameter
8416 nil 'normal-erase-is-backspace))))
8418 (cond ((or (memq window-system '(x w32 ns pc))
8419 (memq system-type '(ms-dos windows-nt)))
8420 (let ((bindings
8421 `(([M-delete] [M-backspace])
8422 ([C-M-delete] [C-M-backspace])
8423 ([?\e C-delete] [?\e C-backspace]))))
8425 (if enabled
8426 (progn
8427 (define-key local-function-key-map [delete] [deletechar])
8428 (define-key local-function-key-map [kp-delete] [deletechar])
8429 (define-key local-function-key-map [backspace] [?\C-?])
8430 (dolist (b bindings)
8431 ;; Not sure if input-decode-map is really right, but
8432 ;; keyboard-translate-table (used below) only works
8433 ;; for integer events, and key-translation-table is
8434 ;; global (like the global-map, used earlier).
8435 (define-key input-decode-map (car b) nil)
8436 (define-key input-decode-map (cadr b) nil)))
8437 (define-key local-function-key-map [delete] [?\C-?])
8438 (define-key local-function-key-map [kp-delete] [?\C-?])
8439 (define-key local-function-key-map [backspace] [?\C-?])
8440 (dolist (b bindings)
8441 (define-key input-decode-map (car b) (cadr b))
8442 (define-key input-decode-map (cadr b) (car b))))))
8443 (t
8444 (if enabled
8445 (progn
8446 (keyboard-translate ?\C-h ?\C-?)
8447 (keyboard-translate ?\C-? ?\C-d))
8448 (keyboard-translate ?\C-h ?\C-h)
8449 (keyboard-translate ?\C-? ?\C-?))))
8451 (if (called-interactively-p 'interactive)
8452 (message "Delete key deletes %s"
8453 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8454 "forward" "backward")))))
8455 \f
8456 (defvar vis-mode-saved-buffer-invisibility-spec nil
8457 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8459 (define-minor-mode read-only-mode
8460 "Change whether the current buffer is read-only.
8461 With prefix argument ARG, make the buffer read-only if ARG is
8462 positive, otherwise make it writable. If buffer is read-only
8463 and `view-read-only' is non-nil, enter view mode.
8465 Do not call this from a Lisp program unless you really intend to
8467 possibly enabling or disabling View mode. Also, note that this
8468 command works by setting the variable `buffer-read-only', which
8469 does not affect read-only regions caused by text properties. To
8470 ignore read-only status in a Lisp program (whether due to text
8471 properties or buffer state), bind `inhibit-read-only' temporarily
8472 to a non-nil value."
8473 :variable buffer-read-only
8474 (cond
8475 ((and (not buffer-read-only) view-mode)
8476 (View-exit-and-edit)
8477 (make-local-variable 'view-read-only)
8478 (setq view-read-only t)) ; Must leave view mode.
8479 ((and buffer-read-only view-read-only
8480 ;; If view-mode is already active, `view-mode-enter' is a nop.
8481 (not view-mode)
8482 (not (eq (get major-mode 'mode-class) 'special)))
8483 (view-mode-enter))))
8485 (define-minor-mode visible-mode
8486 "Toggle making all invisible text temporarily visible (Visible mode).
8487 With a prefix argument ARG, enable Visible mode if ARG is
8488 positive, and disable it otherwise. If called from Lisp, enable
8489 the mode if ARG is omitted or nil.
8491 This mode works by saving the value of `buffer-invisibility-spec'
8492 and setting it to nil."
8493 :lighter " Vis"
8494 :group 'editing-basics
8495 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8496 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8497 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8498 (when visible-mode
8499 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8500 buffer-invisibility-spec)
8501 (setq buffer-invisibility-spec nil)))
8502 \f
8503 (defvar messages-buffer-mode-map
8504 (let ((map (make-sparse-keymap)))
8505 (set-keymap-parent map special-mode-map)
8506 (define-key map "g" nil) ; nothing to revert
8507 map))
8509 (define-derived-mode messages-buffer-mode special-mode "Messages"
8512 (defun messages-buffer ()
8514 If it does not exist, create and it switch it to `messages-buffer-mode'."
8515 (or (get-buffer "*Messages*")
8516 (with-current-buffer (get-buffer-create "*Messages*")
8517 (messages-buffer-mode)
8518 (current-buffer))))
8520 \f
8521 ;; Minibuffer prompt stuff.
8523 ;;(defun minibuffer-prompt-modification (start end)
8524 ;; (error "You cannot modify the prompt"))
8525 ;;
8526 ;;
8527 ;;(defun minibuffer-prompt-insertion (start end)
8528 ;; (let ((inhibit-modification-hooks t))
8529 ;; (delete-region start end)
8530 ;; ;; Discard undo information for the text insertion itself
8531 ;; ;; and for the text deletion.above.
8532 ;; (when (consp buffer-undo-list)
8533 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8534 ;; (message "You cannot modify the prompt")))
8535 ;;
8536 ;;
8537 ;;(setq minibuffer-prompt-properties
8538 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8539 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8541 \f
8542 ;;;; Problematic external packages.
8544 ;; rms says this should be done by specifying symbols that define
8545 ;; versions together with bad values. This is therefore not as
8546 ;; flexible as it could be. See the thread:
8547 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8548 (defconst bad-packages-alist
8549 ;; Not sure exactly which semantic versions have problems.
8550 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8552 "The version of `semantic' loaded does not work in Emacs 22.
8553 It can cause constant high CPU load.
8554 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8555 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8556 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8557 ;; provided the `CUA-mode' feature. Since this is no longer true,
8558 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8559 (CUA-mode t nil
8560 "CUA-mode is now part of the standard GNU Emacs distribution,
8561 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8563 You have loaded an older version of CUA-mode which does not work
8564 correctly with this version of Emacs. You should remove the old
8565 version and use the one distributed with Emacs."))
8566 "Alist of packages known to cause problems in this version of Emacs.
8567 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8568 PACKAGE is either a regular expression to match file names, or a
8569 symbol (a feature name), like for `with-eval-after-load'.
8570 SYMBOL is either the name of a string variable, or t. Upon
8571 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8572 warning using STRING as the message.")
8574 (defun bad-package-check (package)
8575 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8576 (condition-case nil
8577 (let* ((list (assoc package bad-packages-alist))
8578 (symbol (nth 1 list)))
8579 (and list
8580 (boundp symbol)
8581 (or (eq symbol t)
8582 (and (stringp (setq symbol (eval symbol)))
8583 (string-match-p (nth 2 list) symbol)))
8584 (display-warning package (nth 3 list) :warning)))
8585 (error nil)))
8587 (dolist (elem bad-packages-alist)
8588 (let ((pkg (car elem)))
8589 (with-eval-after-load pkg
8590 (bad-package-check pkg))))
8592 \f
8593 ;;; Generic dispatcher commands
8595 ;; Macro `define-alternatives' is used to create generic commands.
8596 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8597 ;; that can have different alternative implementations where choosing
8598 ;; among them is exclusively a matter of user preference.
8600 ;; (define-alternatives COMMAND) creates a new interactive command
8601 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8602 ;; Typically, the user will not need to customize this variable; packages
8603 ;; wanting to add alternative implementations should use
8604 ;;
8605 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8607 (defmacro define-alternatives (command &rest customizations)
8608 "Define the new command `COMMAND'.
8610 The argument `COMMAND' should be a symbol.
8612 Running `M-x COMMAND RET' for the first time prompts for which
8613 alternative to use and records the selected command as a custom
8614 variable.
8616 Running `C-u M-x COMMAND RET' prompts again for an alternative
8617 and overwrites the previous choice.
8619 The variable `COMMAND-alternatives' contains an alist with
8620 alternative implementations of COMMAND. `define-alternatives'
8621 does not have any effect until this variable is set.
8623 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8624 `defcustom' keywords and values to add to the declaration of
8625 `COMMAND-alternatives' (typically :group and :version)."
8626 (let* ((command-name (symbol-name command))
8627 (varalt-name (concat command-name "-alternatives"))
8628 (varalt-sym (intern varalt-name))
8629 (varimp-sym (intern (concat command-name "--implementation"))))
8630 `(progn
8632 (defcustom ,varalt-sym nil
8633 ,(format "Alist of alternative implementations for the `%s' command.
8635 Each entry must be a pair (ALTNAME . ALTFUN), where:
8636 ALTNAME - The name shown at user to describe the alternative implementation.
8637 ALTFUN - The function called to implement this alternative."
8638 command-name)
8639 :type '(alist :key-type string :value-type function)
8640 ,@customizations)
8642 (put ',varalt-sym 'definition-name ',command)
8643 (defvar ,varimp-sym nil "Internal use only.")
8645 (defun ,command (&optional arg)
8646 ,(format "Run generic command `%s'.
8647 If used for the first time, or with interactive ARG, ask the user which
8648 implementation to use for `%s'. The variable `%s'
8649 contains the list of implementations currently supported for this command."
8650 command-name command-name varalt-name)
8651 (interactive "P")
8652 (when (or arg (null ,varimp-sym))
8653 (let ((val (completing-read
8654 ,(format-message
8655 "Select implementation for command `%s': "
8656 command-name)
8657 ,varalt-sym nil t)))
8658 (unless (string-equal val "")
8659 (when (null ,varimp-sym)
8660 (message
8661 "Use C-u M-x %s RET`to select another implementation"
8662 ,command-name)
8663 (sit-for 3))
8664 (customize-save-variable ',varimp-sym
8665 (cdr (assoc-string val ,varalt-sym))))))
8666 (if ,varimp-sym
8667 (call-interactively ,varimp-sym)
8668 (message "%s" ,(format-message
8669 "No implementation selected for command `%s'"
8670 command-name)))))))
8672 \f
8673 ;;; Functions for changing capitalization that Do What I Mean
8674 (defun upcase-dwim (arg)
8675 "Upcase words in the region, if active; if not, upcase word at point.
8676 If the region is active, this function calls `upcase-region'.
8677 Otherwise, it calls `upcase-word', with prefix argument passed to it
8678 to upcase ARG words."
8679 (interactive "*p")
8680 (if (use-region-p)
8681 (upcase-region (region-beginning) (region-end))
8682 (upcase-word arg)))
8684 (defun downcase-dwim (arg)
8685 "Downcase words in the region, if active; if not, downcase word at point.
8686 If the region is active, this function calls `downcase-region'.
8687 Otherwise, it calls `downcase-word', with prefix argument passed to it
8688 to downcase ARG words."
8689 (interactive "*p")
8690 (if (use-region-p)
8691 (downcase-region (region-beginning) (region-end))
8692 (downcase-word arg)))
8694 (defun capitalize-dwim (arg)
8695 "Capitalize words in the region, if active; if not, capitalize word at point.
8696 If the region is active, this function calls `capitalize-region'.
8697 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8698 to capitalize ARG words."
8699 (interactive "*p")
8700 (if (use-region-p)
8701 (capitalize-region (region-beginning) (region-end))
8702 (capitalize-word arg)))
8704 \f
8706 (provide 'simple)
8708 ;;; simple.el ends here