| blob | 2101cfe83337d09b7e26b07b4a9fcdcf1cd81b8a |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2018 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 <https://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
127 "Function to use to find the next error in the current buffer.
128 The function is called with 2 parameters:
129 ARG is an integer specifying by how many errors to move.
130 RESET is a boolean which, if non-nil, says to go back to the beginning
131 of the errors before moving.
132 Major modes providing compile-like functionality should set this variable
133 to indicate to `next-error' that this is a candidate buffer and how
138 "Function to use to move to an error locus.
139 It takes two arguments, a buffer position in the error buffer
140 and a buffer position in the error locus buffer.
141 The buffer for the error locus should already be current.
146 &optional avoid-current
147 extra-test-inclusive
148 extra-test-exclusive)
149 "Return non-nil if BUFFER is a `next-error' capable buffer.
150 If AVOID-CURRENT is non-nil, and BUFFER is the current buffer,
151 return nil.
153 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if
154 BUFFER would not normally qualify. If it returns non-nil, BUFFER
155 is considered `next-error' capable, anyway, and the function
156 returns non-nil.
158 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the
159 buffer would normally qualify. If it returns nil, BUFFER is
160 rejected, and the function returns nil."
165 ;; Optionally reject some buffers.
168 t)
169 ;; Optionally accept some other buffers.
174 "Function called to find a `next-error' capable buffer."
176 next-error-buffer-on-selected-frame)
183 extra-test-inclusive
184 extra-test-exclusive)
185 "Return a single visible next-error buffer on the selected frame."
191 avoid-current
192 extra-test-inclusive extra-test-exclusive)
199 extra-test-inclusive
200 extra-test-exclusive)
201 "Return a `next-error' capable buffer.
203 If AVOID-CURRENT is non-nil, treat the current buffer
204 as an absolute last resort only.
206 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
207 that normally would not qualify. If it returns t, the buffer
208 in question is treated as usable.
210 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
211 that would normally be considered usable. If it returns nil,
212 that buffer is rejected."
214 ;; 1. If a customizable function returns a buffer, use it.
217 extra-test-inclusive
218 extra-test-exclusive))
219 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
222 extra-test-inclusive extra-test-exclusive))
223 next-error-last-buffer)
224 ;; 3. If the current buffer is acceptable, choose it.
226 extra-test-inclusive extra-test-exclusive)
228 ;; 4. Look for any acceptable buffer.
233 extra-test-inclusive extra-test-exclusive)))
236 ;; 5. Use the current buffer as a last resort if it qualifies,
237 ;; even despite AVOID-CURRENT.
240 extra-test-inclusive extra-test-exclusive)
244 ;; 6. Give up.
248 "Visit next `next-error' message and corresponding source code.
250 If all the error messages parsed so far have been processed already,
251 the message buffer is checked for new ones.
253 A prefix ARG specifies how many error messages to move;
254 negative means move back to previous error messages.
256 and start at the first error.
258 The RESET argument specifies that we should restart from the beginning.
261 compilation, grep, or occur buffer. It can also operate on any
263 more generally, on any buffer in Compilation mode or with
264 Compilation Minor mode enabled, or any buffer in which
265 `next-error-function' is bound to an appropriate function.
266 To specify use of a particular buffer for error messages, type
268 in the current frame.
271 runs `next-error-hook' with `run-hooks', and stays with that buffer
272 until you use it in some other buffer which uses Compilation mode
273 or Compilation Minor mode.
275 To control which errors are matched, customize the variable
276 `compilation-error-regexp-alist'."
281 ;; We know here that next-error-function is a valid symbol we can funcall
283 ;; Allow next-error to be used from the next-error capable buffer.
286 ;; Override possible change of next-error-last-buffer in next-error-function
296 next-error-last-buffer)
300 "Visit the source code corresponding to the `next-error' message at point."
302 ;; We know here that next-error-function is a valid symbol we can funcall
304 ;; Allow next-error to be used from the next-error capable buffer.
307 ;; Override possible change of next-error-last-buffer in next-error-function
316 "Select a `next-error' capable buffer and set it as the last used."
328 "Visit previous `next-error' message and corresponding source code.
330 Prefix arg N says how many error messages to move backwards (or
331 forwards, if negative).
338 "Restart at the first error.
339 Visit corresponding source code.
340 With prefix arg N, visit the source code of the Nth error.
346 "Move point to the next error in the `next-error' buffer and highlight match.
347 Prefix arg N says how many error messages to move forwards (or
348 backwards, if negative).
350 select the source buffer."
357 "Move point to the previous error in the `next-error' buffer and highlight match.
358 Prefix arg N says how many error messages to move backwards (or
359 forwards, if negative).
361 select the source buffer."
365 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
369 "Minor mode for compilation, occur and diff modes.
370 With a prefix argument ARG, enable mode if ARG is positive, and
371 disable it otherwise. If called from Lisp, enable mode if ARG is
372 omitted or nil.
373 When turned on, cursor motion in the compilation, grep, occur or diff
374 buffer causes automatic display of the corresponding source code location."
381 ;; Used as a `post-command-hook' by `next-error-follow-mode'
382 ;; for the *Compilation* *grep* and *Occur* buffers.
392 \f
393 ;;;
396 "Major mode not specialized for anything in particular.
397 Other major modes are defined by comparison with this one."
402 ;; Special major modes to view specially formatted data rather than files.
416 map))
420 "Parent major mode from which special major modes should inherit."
423 ;; Making and deleting lines.
426 "Special hook to tell if `self-insert-command' will use the region.
427 It must be called via `run-hook-with-args-until-success' with no arguments.
429 If any function on this hook returns a non-nil value, `delete-selection-mode'
430 will act on that value (see `delete-selection-helper'), and will
431 usually delete the region. If all the functions on this hook return
432 nil, it is an indiction that `self-insert-command' needs the region
433 untouched by `delete-selection-mode', and will itself do whatever is
434 appropriate with the region.
435 Any function on `post-self-insert-hook' which act on the region should
436 add a function to this hook so that `delete-selection-mode' could
437 refrain from deleting the region before `post-self-insert-hook'
438 functions are called.
445 "Insert a newline, and move to left margin of the new line if it's blank.
446 If option `use-hard-newlines' is non-nil, the newline is marked with the
447 text-property `hard'.
448 With ARG, insert that many newlines.
450 If `electric-indent-mode' is enabled, this indents the final new line
451 that it adds, and reindents the preceding line. To just insert
454 Calls `auto-fill-function' if the current column number is greater
455 than the value of `fill-column' and ARG is nil.
456 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
459 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
460 ;; Set last-command-event to tell self-insert what to insert.
464 ;; Don't auto-fill if we have a numeric argument.
468 ;; Do the rest in post-self-insert-hook, because we want to do it
469 ;; *before* other functions on that hook.
471 ;; Mark the newline(s) `hard'.
475 ;; If the newline leaves the previous line blank, and we
476 ;; have a left margin, delete that from the blank line.
484 ;; Indent the line after the newline, except in one case:
485 ;; when we added the newline at the beginning of a line which
486 ;; starts a page.
490 ;; FIXME: For non-interactive uses, many calls actually
491 ;; just want (insert "\n"), so maybe we should do just
492 ;; that, so as to avoid the risk of filling or running
493 ;; abbrevs unexpectedly.
500 ;; We first used let-binding to protect the hook, but that
501 ;; was naive since add-hook affects the symbol-default
502 ;; value of the variable, whereas the let-binding might
503 ;; only protect the buffer-local value.
505 nil)
510 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
516 "Insert a newline and leave point before it.
517 If there is a fill prefix and/or a `left-margin', insert them on
518 the new line if the line would have been blank.
519 With arg N, insert N newlines."
524 ;; Don't expand an abbrev before point.
535 ;; Necessary in case a margin or prefix was inserted.
539 "Split current line, moving portion beyond point vertically down.
540 If the current line starts with `fill-prefix', insert it on the new
541 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
543 When called from Lisp code, ARG may be a prefix string to copy."
548 ;; What prefix should we check for (nil means don't).
552 ;; Does this line start with it?
563 "Join this line to previous and fix up whitespace at join.
564 If there is a fill prefix, delete it from the beginning of this line.
565 With argument, join this line to following line."
572 ;; If the second line started with the fill prefix,
573 ;; delete the prefix.
585 "On blank line, delete all surrounding blank lines, leaving just one.
586 On isolated blank line, delete that one.
587 On nonblank line, delete any immediately following blank lines."
593 ;; Set singleblank if there is just one blank line here.
600 ;; Delete preceding blank lines, and this one too if it's the only one.
609 ;; Delete following blank lines, unless the current line is blank
610 ;; and there are no following blank lines.
619 ;; Handle the special case where point is followed by newline and eob.
620 ;; Delete the line, leaving point at eob.
626 Trailing lines are deleted only if `delete-trailing-whitespace'
627 is called on the entire buffer (rather than an active region)."
633 "Return non-nil if the region contains no read-only text."
638 "Delete trailing whitespace between START and END.
639 If called interactively, START and END are the start/end of the
640 region if the mark is active, or of the buffer's accessible
641 portion if the mark is inactive.
643 This command deletes whitespace characters after the last
644 non-whitespace character in each line between START and END. It
645 does not consider formfeed characters to be whitespace.
647 If this command acts on the entire buffer (i.e. if called
648 interactively with the mark inactive, or called from Lisp with
649 END nil), it also deletes all trailing lines at the end of the
650 buffer if the variable `delete-trailing-lines' is non-nil."
661 ;; Don't delete formfeeds, even if they are considered whitespace.
670 ;; Delete trailing empty lines.
672 ;; Really the end of buffer.
677 ;; Return nil for the benefit of `write-file-functions'.
678 nil)
681 "Insert a newline, then indent according to major mode.
682 Indentation is done using the value of `indent-line-function'.
683 In programming language modes, this is the same as TAB.
684 In some text modes, where TAB inserts a tab, this command indents to the
685 column specified by the function `current-left-margin'."
692 "Reindent current line, insert newline, then indent the new line.
693 Indentation of both lines is done according to the current major mode,
694 which means calling the current value of `indent-line-function'.
695 In programming language modes, this is the same as TAB.
696 In some text modes, where TAB inserts a tab, this indents to the
697 column specified by the function `current-left-margin'."
700 ;; Be careful to insert the newline before indenting the line.
701 ;; Otherwise, the indentation might be wrong.
705 ;; We are at EOL before the call to indent-according-to-mode, and
706 ;; after it we usually are as well, but not always. We tried to
707 ;; address it with `save-excursion' but that uses a normal marker
708 ;; whereas we need `move after insertion', so we do the save/restore
709 ;; by hand.
713 ;; Remove the trailing white-space after indentation because
714 ;; indentation may introduce the whitespace.
720 Legitimate radix values are 8, 10 and 16."
725 "Like `read-char', but do not allow quitting.
726 Also, if the first character read is an octal digit,
727 we read any number of octal digits and return the
728 specified character code. Any nondigit terminates the sequence.
729 If the terminator is RET, it is discarded;
730 any other terminator is used itself as input.
732 The optional argument PROMPT specifies a string to use to prompt the user.
733 The variable `read-quoted-char-radix' controls which radix to use
734 for numeric input."
737 help-event-list)))
741 ;; Don't let C-h or other help chars get the help
742 ;; message--only help function keys. See bug#16617.
746 "Type the special character you want to use,
747 or the octal character code.
748 RET terminates the character code and is discarded;
752 ;; Translate TAB key into control-I ASCII character, and so on.
753 ;; Note: `read-char' does it using the `ascii-character' property.
754 ;; We tried using read-key instead, but that disables the keystroke
755 ;; echo produced by 'C-q', see bug#24635.
759 char)))
765 done t))
767 ;; Turn a meta-character into a character with the 0200 bit set.
769 done t))
784 done t))
786 done t)))
788 code))
791 "Read next input character and insert it.
792 This is useful for inserting control characters.
793 With argument, insert ARG copies of the character.
795 If the first character you type after this command is an octal digit,
796 you should type a sequence of octal digits which specify a character code.
797 Any nondigit terminates the sequence. If the terminator is a RET,
798 it is discarded; any other terminator is used itself as input.
799 The variable `read-quoted-char-radix' specifies the radix for this feature;
800 set it to 10 or 16 to use decimal or hex instead of octal.
802 In overwrite mode, this function inserts the character anyway, and
803 does not handle octal digits specially. This means that if you use
804 overwrite as your normal editing mode, you can use this function to
805 insert characters when necessary.
807 In binary overwrite mode, this function does overwrite, and octal
808 digits are interpreted as a character code. This is intended to be
809 useful for editing binary files."
812 ;; Avoid "obsolete" warnings for translation-table-for-input.
819 ;; This used to assume character codes 0240 - 0377 stand for
820 ;; characters in some single-byte character set, and converted them
821 ;; to Emacs characters. But in 23.1 this feature is deprecated
822 ;; in favor of inserting the corresponding Unicode characters.
823 ;; (if (and enable-multibyte-characters
824 ;; (>= char ?\240)
825 ;; (<= char ?\377))
826 ;; (setq char (unibyte-char-to-multibyte char)))
838 "Move forward ARG lines and position at first nonblank character."
844 "Move backward ARG lines and position at first nonblank character."
850 "Move point to the first non-whitespace character on this line."
854 ;; Move back over chars that have whitespace syntax but have the p flag.
858 "Fixup white space between objects around point.
859 Leave one space or none, according to the context."
866 nil
870 "Delete all spaces and tabs around point.
871 If BACKWARD-ONLY is non-nil, only delete them before point."
876 orig-pos
885 "Delete all spaces and tabs around point, leaving one space (or N spaces).
886 If N is negative, delete newlines as well, leaving -N spaces.
887 See also `cycle-spacing'."
892 "Store context used in consecutive calls to `cycle-spacing' command.
893 The first time `cycle-spacing' runs, it saves in this variable:
894 its N argument, the original point position, and the original spacing
898 "Manipulate whitespace around point in a smart way.
899 In interactive use, this function behaves differently in successive
900 consecutive calls.
902 The first call in a sequence acts like `just-one-space'.
903 It deletes all spaces and tabs around point, leaving one space
904 \(or N spaces). N is the prefix argument. If N is negative,
905 it deletes newlines as well, leaving -N spaces.
906 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
908 The second call in a sequence deletes all spaces.
910 The third call in a sequence restores the original whitespace (and point).
912 If MODE is `single-shot', it only performs the first step in the sequence.
913 If MODE is `fast' and the first step would not result in any change
914 \(i.e., there are exactly (abs N) spaces around point),
915 the function goes straight to the second step.
917 Repeatedly calling the function with different values of N starts a
918 new sequence each time."
926 ;; Command run for the first time, single-shot mode or different argument
938 ;; Special handling for case where there was no space at all.
941 ;; If this run causes no change in buffer content, delete all spaces,
942 ;; otherwise delete all excess spaces.
947 ;; Command run for the second time.
951 ;; Command run for the third time.
956 \f
958 "Move point to the beginning of the buffer.
959 With numeric arg N, put point N/10 of the way from the beginning.
960 If the buffer is narrowed, this command uses the beginning of the
961 accessible part of the buffer.
964 is supplied, or Transient Mark mode is enabled and the mark is active."
974 ;; Avoid overflow for large buffer sizes!
982 "Move point to the end of the buffer.
983 With numeric arg N, put point N/10 of the way from the end.
984 If the buffer is narrowed, this command uses the end of the
985 accessible part of the buffer.
988 is supplied, or Transient Mark mode is enabled and the mark is active."
996 ;; Avoid overflow for large buffer sizes!
1001 ;; If we went to a place in the middle of the buffer,
1002 ;; adjust it to the beginning of a line.
1006 ;; If the end of the buffer is not already on the screen,
1007 ;; then scroll specially to put it near, but not at, the bottom.
1012 "Whether single-char deletion commands delete an active region.
1013 This has an effect only if Transient Mark mode is enabled, and
1014 affects `delete-forward-char' and `delete-backward-char', though
1015 not `delete-char'.
1017 If the value is the symbol `kill', the active region is killed
1018 instead of deleted."
1035 "Function to get the region's content.
1036 Called with one argument METHOD.
1037 If METHOD is `delete-only', then delete the region; the return value
1038 is undefined. If METHOD is nil, then return the content as a string.
1039 If METHOD is `bounds', then return the boundaries of the region
1040 as a list of cons cells of the form (START . END).
1041 If METHOD is anything else, delete the region and return its content
1042 as a string, after filtering it with `filter-buffer-substring', which
1053 first nil))))
1054 "Function to insert the region's content.
1055 Called with one argument LINES.
1059 "Delete the previous N characters (following if N is negative).
1060 If Transient Mark mode is enabled, the mark is active, and N is 1,
1061 delete the text in the region and deactivate the mark instead.
1062 To disable this, set option `delete-active-region' to nil.
1064 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1065 kill ring) instead of delete. Interactively, N is the prefix
1066 arg, and KILLFLAG is set if N is explicitly specified.
1068 When killing, the killed text is filtered by
1069 `filter-buffer-substring' before it is saved in the kill ring, so
1070 the actual saved text might be different from what was killed.
1072 In Overwrite mode, single character backward deletion may replace
1073 tabs with spaces so as to back over columns, unless point is at
1074 the end of the line."
1080 delete-active-region
1082 ;; If a region is active, kill or delete it.
1086 ;; In Overwrite mode, maybe untabify while deleting
1096 ;; Otherwise, do simple deletion.
1100 "Delete the following N characters (previous if N is negative).
1101 If Transient Mark mode is enabled, the mark is active, and N is 1,
1102 delete the text in the region and deactivate the mark instead.
1103 To disable this, set variable `delete-active-region' to nil.
1105 Optional second arg KILLFLAG non-nil means to kill (save in kill
1106 ring) instead of delete. Interactively, N is the prefix arg, and
1107 KILLFLAG is set if N was explicitly specified.
1109 When killing, the killed text is filtered by
1110 `filter-buffer-substring' before it is saved in the kill ring, so
1111 the actual saved text might be different from what was killed."
1117 delete-active-region
1119 ;; If a region is active, kill or delete it.
1124 ;; Otherwise, do simple deletion.
1128 "Put point at beginning and mark at end of buffer.
1129 If narrowing is in effect, only uses the accessible part of the buffer.
1130 You probably should not use this function in Lisp programs;
1131 it is usually a mistake for a Lisp function to use any subroutine
1132 that uses or sets the mark."
1137 ;; This is really `point-min' in most cases, but if we're in the
1138 ;; minibuffer, this is at the end of the prompt.
1140 \f
1142 ;; Counting lines, one way or another.
1145 "Go to LINE, counting from line 1 at beginning of buffer.
1146 If called interactively, a numeric prefix argument specifies
1147 LINE; without a numeric prefix argument, read LINE from the
1148 minibuffer.
1150 If optional argument BUFFER is non-nil, switch to that buffer and
1152 as argument, BUFFER is the most recently selected other buffer.
1154 Prior to moving point, this function sets the mark (without
1155 activating it), unless Transient Mark mode is enabled and the
1156 mark is already active.
1158 This function is usually the wrong thing to use in a Lisp program.
1159 What you probably want instead is something like:
1160 (goto-char (point-min))
1161 (forward-line (1- N))
1162 If at all possible, an even better solution is to use char counts
1163 rather than line counts."
1168 ;; Look for a default, a number in the buffer at point.
1178 ;; Decide if we're switching buffers.
1186 ;; Read the argument, offering that number (if any) as default.
1189 buffer))))
1190 ;; Switch to the desired buffer, one way or another.
1195 ;; Leave mark at previous position
1197 ;; Move to the specified line number in that buffer.
1206 "Count the number of words in the region.
1207 If called interactively, print a message reporting the number of
1208 lines, words, and characters in the region (whether or not the
1209 region is active); with prefix ARG, report for the entire buffer
1210 rather than the region.
1212 If called from Lisp, return the number of words between positions
1213 START and END."
1225 "Count words between START and END.
1226 If called interactively, START and END are normally the start and
1227 end of the buffer; but if the region is active, START and END are
1228 the start and end of the region. Print a message reporting the
1229 number of lines, words, and chars.
1231 If called from Lisp, return the number of words between START and
1232 END, without printing any message."
1242 words))
1258 str
1266 "Print the current buffer line number and narrowed line number of point."
1279 "Return number of lines between START and END.
1280 This is usually the number of newlines between them,
1281 but can be one more if START is not equal to END
1282 and the greater of them is not at the start of a line."
1298 done)))
1302 "Return buffer line number at position POS.
1303 If POS is nil, use current buffer location.
1305 If ABSOLUTE is nil, the default, counting starts
1306 at (point-min), so the value refers to the contents of the
1307 accessible portion of the (potentially narrowed) buffer. If
1308 ABSOLUTE is non-nil, ignore any narrowing and return the
1309 absolute line number."
1322 "Print info on cursor position (on screen and within buffer).
1323 Also describe the character after point, and give its character code
1324 in octal, decimal and hex.
1326 For a non-ASCII multibyte character, also give its encoding in the
1327 buffer's selected coding system if the coding system encodes the
1328 character safely. If the character is encoded into one byte, that
1329 code is shown in hex. If the character is encoded into more than one
1332 In addition, with prefix argument, show details about that character
1333 in *Help* buffer. See also the command `describe-char'."
1337 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1338 ;; start a directional embedding, which could completely
1339 ;; disrupt the rest of the line (e.g., RLO will display the
1340 ;; rest of the line right-to-left). So we put an invisible
1341 ;; PDF character after these characters, to end the
1342 ;; embedding, which eliminates any effects on the rest of
1343 ;; the line. For RLE and RLO we also append an invisible
1344 ;; LRM, to avoid reordering the following numerical
1345 ;; characters. For LRI/RLI/FSI we append a PDI.
1352 ;; Strong right-to-left characters cause reordering of
1353 ;; the following numerical characters which show the
1354 ;; codepoint, so append LRM to countermand that.
1365 ""
1371 pos total percent beg end col hscroll)
1373 pos total col hscroll))
1375 encoded encoding-msg display-prop under-display)
1382 ;; Check if the character is displayed with some `display'
1383 ;; text property. In that case, set under-display to the
1384 ;; buffer substring covered by that property.
1395 under-display)))
1401 char char char under-display)
1403 char char char under-display display-prop))
1406 char char char
1408 "..."
1412 ;; We show the detailed information about CHAR.
1419 bidi-fixer
1420 encoding-msg pos total percent beg end col hscroll)
1427 bidi-fixer encoding-msg pos total percent col hscroll))))))
1428 \f
1429 ;; Initialize read-expression-map. It is defined at C level.
1433 ;; Might as well bind TAB to completion, since inserting a TAB char is
1434 ;; much too rarely useful.
1437 m))
1440 "Return a Lisp object read using the minibuffer, unevaluated.
1441 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1442 is a string to insert in the minibuffer before reading.
1443 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1444 Such arguments are used as in `read-from-minibuffer'.)"
1445 ;; Used for interactive spec `x'.
1450 "Return value of Lisp expression read using the minibuffer.
1451 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1452 is a string to insert in the minibuffer before reading.
1453 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1454 Such arguments are used as in `read-from-minibuffer'.)"
1455 ;; Used for interactive spec `X'.
1463 "The current default value or list of default values in the minibuffer.
1464 The functions `read-from-minibuffer' and `completing-read' bind
1468 "Value for `print-level' while printing value in `eval-expression'.
1469 A value of nil means no limit."
1475 "Value for `print-length' while printing value in `eval-expression'.
1476 A value of nil means no limit."
1482 "If non-nil set `debug-on-error' to t in `eval-expression'.
1483 If nil, don't change the value of `debug-on-error'."
1489 "The largest integer that will be displayed as a character.
1490 This affects printing by `eval-expression' (via
1491 `eval-expression-print-format')."
1497 "If VALUE in an integer, return a specially formatted string.
1499 If VALUE is not an integer, nil is returned.
1500 This function is used by commands like `eval-expression' that
1501 display the result of expression evaluation."
1519 ;; FIXME: call emacs-lisp-mode?
1527 read-expression-map t
1531 "Get arguments for commands that print an expression result.
1532 Returns a list (INSERT-VALUE NO-TRUNCATE CHAR-PRINT-LIMIT)
1533 based on PREFIX-ARG. This function determines the interpretation
1534 of the prefix argument for `eval-expression' and
1535 `eval-last-sexp'."
1543 ;; We define this, rather than making `eval' interactive,
1544 ;; for the sake of completion of names like eval-region, eval-buffer.
1546 "Evaluate EXP and print value in the echo area.
1547 When called interactively, read an Emacs Lisp expression and
1548 evaluate it. Value is also consed on to front of the variable
1549 `values'. Optional argument INSERT-VALUE non-nil (interactively,
1550 with a non `-' prefix argument) means insert the result into the
1551 current buffer instead of printing it in the echo area.
1553 Normally, this function truncates long output according to the
1554 value of the variables `eval-expression-print-length' and
1555 `eval-expression-print-level'. When NO-TRUNCATE is
1556 non-nil (interactively, with a prefix argument of zero), however,
1557 there is no such truncation.
1559 If the resulting value is an integer, and CHAR-PRINT-LIMIT is
1560 non-nil (interactively, unless given a positive prefix argument)
1561 it will be printed in several additional formats (octal,
1562 hexadecimal, and character). The character format is only used
1563 if the value is below CHAR-PRINT-LIMIT (interactively, if the
1564 prefix argument is -1 or the value is below
1565 `eval-expression-print-maximum-character').
1567 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1568 minibuffer.
1570 If `eval-expression-debug-on-error' is non-nil, which is the default,
1571 this command arranges for all errors to enter the debugger."
1579 ;; Bind debug-on-error to something unique so that we can
1580 ;; detect when evalled code changes it.
1584 ;; If evalled code has changed the value of debug-on-error,
1585 ;; propagate that change to the global binding.
1601 "Prompting with PROMPT, let user edit COMMAND and eval result.
1602 COMMAND is a Lisp expression. Let user edit that expression in
1603 the minibuffer, then read and evaluate the result."
1610 read-expression-map t
1612 ;; If command was added to command-history as a string,
1613 ;; get rid of that. We want only evaluable expressions there.
1617 ;; If command to be redone does not match front of history,
1618 ;; add it to the history.
1624 "Edit and re-evaluate last complex command, or ARGth from last.
1625 A complex command is one which used the minibuffer.
1626 The command is placed in the minibuffer as a Lisp form for editing.
1627 The result is executed, repeating the command as changed.
1628 If the command has been changed or is not the most recent previous
1629 command it is added to the front of the command history.
1630 You can use the minibuffer history commands \
1632 to get different commands to edit and resubmit."
1635 newcmd)
1647 ;; If command was added to command-history as a
1648 ;; string, get rid of that. We want only
1649 ;; evaluable expressions there.
1653 ;; If command to be redone does not match front of history,
1654 ;; add it to the history.
1669 "Read command name to invoke in `execute-extended-command'."
1679 ;; Get a command name at point in the original buffer
1680 ;; to propose it after M-n.
1684 ;; Read a string, completing from and restricting to the set of
1685 ;; all defined commands. Don't provide any initial input.
1686 ;; Save the command read on the extended-command history list.
1697 ;; This isn't strictly correct if `execute-extended-command'
1698 ;; is bound to anything else (e.g. [menu]).
1699 ;; It could use (key-description (this-single-command-keys)),
1700 ;; but actually a prompt other than "M-x" would be confusing,
1701 ;; because "M-x" is a well-known prompt to read a command
1702 ;; and it serves as a shorthand for "Extended command: ".
1707 ;; Exclude obsolete commands from completions.
1712 pred)))
1717 "Non-nil means show the equivalent key-binding when M-x command has one.
1718 The value can be a length of time to show the message for.
1719 If the value is non-nil and not a number, we wait 2 seconds."
1726 "If non-nil, show a shorter M-x invocation when there is one."
1747 binding)
1753 name len)))
1754 ;; Don't show the help message if the binding isn't
1755 ;; significantly shorter than the M-x command the user typed.
1763 binding))
1766 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1767 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1768 "Read a command name, then read the arguments and call the command.
1769 To pass a prefix argument to the command you are
1770 invoking, give a prefix argument to `execute-extended-command'."
1772 ;; FIXME: Remember the actual text typed by the user before completion,
1773 ;; so that we don't later on suggest the same shortening.
1778 execute-extended-command--last-typed)))
1779 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1791 ;; Some features, such as novice.el, rely on this-command-keys
1792 ;; including M-x COMMAND-NAME RET.
1795 ;; Normally `real-this-command' should never be changed, but here we really
1796 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1797 ;; binding" for <cmd>, so the command the user really wanted to run is
1798 ;; `function' and not `execute-extended-command'. The difference is
1799 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1803 ;; If enabled, show which key runs this command.
1804 ;; But first wait, and skip the message if there is input.
1806 ;; If this command displayed something in the echo area;
1807 ;; wait a few seconds, then display our suggestion message.
1808 ;; FIXME: Wait *after* running post-command-hook!
1809 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1810 ;; find a better answer anyway!
1820 ;; There's no binding for CMD. Let's try and find the shortest
1821 ;; string to use in M-x.
1822 ;; FIXME: Can be slow. Cache it maybe?
1829 function
1834 suggest-key-bindings
1838 ;; BEWARE: Called directly from the C code.
1839 "Execute CMD as an editor command.
1840 CMD must be a symbol that satisfies the `commandp' predicate.
1841 Optional second arg RECORD-FLAG non-nil
1842 means unconditionally put this command in the variable `command-history'.
1843 Otherwise, that is done only if an arg is read using the minibuffer.
1844 The argument KEYS specifies the value to use instead of (this-command-keys)
1845 when reading the arguments; if it is nil, (this-command-keys) is used.
1846 The argument SPECIAL, if non-nil, means that this command is executing
1847 a special event, so ignore the prefix argument and don't clear it."
1850 ;; FIXME: This should probably be done around
1851 ;; pre-command-hook rather than here!
1859 disabled-command-function)
1860 ;; FIXME: Weird calling convention!
1870 ;; If requested, place the macro in the command history. For
1871 ;; other sorts of commands, call-interactively takes care of this.
1874 ;; Don't keep command history around forever.
1880 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1888 \f
1890 "Default minibuffer history list.
1891 This is used for all minibuffer input
1892 except when an alternate history list is specified.
1894 Maximum length of the history list is determined by the value
1897 "Control whether history list elements are expressions or strings.
1898 If the value of this variable equals current minibuffer depth,
1899 they are expressions; otherwise they are strings.
1900 \(That convention is designed to do the right thing for
1907 "Text that was in this minibuffer before any history commands.
1908 This is nil if there have not yet been any history commands
1917 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1922 "Minibuffer history variables for which matching should ignore case.
1923 If a history variable is a member of this list, then the
1925 commands ignore case when searching it, regardless of `case-fold-search'."
1930 "Find the previous history element that matches REGEXP.
1931 \(Previous history elements refer to earlier actions.)
1932 With prefix argument N, search for Nth previous match.
1933 If N is negative, find the next or Nth next match.
1934 Normally, history elements are matched case-insensitively if
1935 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1936 makes the search case-sensitive.
1937 See also `minibuffer-history-case-insensitive-variables'."
1941 nil
1942 minibuffer-local-map
1943 nil
1944 'minibuffer-history-search-history
1946 ;; Use the last regexp specified, by default, if input is empty.
1951 regexp)
1961 ;; On some systems, ignore case for file names.
1963 minibuffer-history-case-insensitive-variables)
1964 t
1965 ;; Respect the user's setting for case-fold-search:
1966 case-fold-search)
1967 nil))
1968 prevpos
1969 match-string
1970 match-offset
1977 "No later matching history item"
1998 next-matching-history-element))
2002 "Find the next history element that matches REGEXP.
2003 \(The next history element refers to a more recent action.)
2004 With prefix argument N, search for Nth next match.
2005 If N is negative, find the previous or Nth previous match.
2006 Normally, history elements are matched case-insensitively if
2007 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
2008 makes the search case-sensitive."
2012 nil
2013 minibuffer-local-map
2014 nil
2015 'minibuffer-history-search-history
2017 ;; Use the last regexp specified, by default, if input is empty.
2022 regexp)
2029 "Function run by `goto-history-element' before consuming default values.
2030 This is useful to dynamically add more elements to the list of default values
2031 when `goto-history-element' reaches the end of this list.
2032 Before calling this function `goto-history-element' sets the variable
2033 `minibuffer-default-add-done' to t, so it will call this function only
2034 once. In special cases, when this function needs to be called more
2035 than once, it can set `minibuffer-default-add-done' to nil explicitly,
2039 "When nil, add more elements to the end of the list of default values.
2040 The value nil causes `goto-history-element' to add more elements to
2041 the list of defaults when it reaches the end of this list. It does
2047 "Return a list of all completions without the default value.
2048 This function is used to add all elements of the completion table to
2049 the end of the list of defaults just after the default value."
2052 minibuffer-completion-table
2053 minibuffer-completion-predicate)))
2059 "Puts element of the minibuffer history in the minibuffer.
2060 The argument NABS specifies the absolute history position."
2074 elt minibuffer-returned-to-present)
2081 "End of defaults; no next item"
2088 previous-history-element))
2100 minibuffer-default)))
2112 elt))
2116 "Puts next element of the minibuffer history in the minibuffer.
2117 With argument N, it uses the Nth following element."
2123 "Puts previous element of the minibuffer history in the minibuffer.
2124 With argument N, it uses the Nth previous element."
2130 "Move cursor vertically down ARG lines, or to the next history element.
2131 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2132 next element of the minibuffer history in the minibuffer."
2136 ;; Don't add newlines if they have the mode enabled globally.
2138 ;; Remember the original goal column of possibly multi-line input
2139 ;; excluding the length of the prompt on the first line.
2149 ;; Restore old position since `line-move-visual' moves point to
2150 ;; the end of the line when it fails to go to the next line.
2153 ;; Reset `temporary-goal-column' because a correct value is not
2154 ;; calculated when `next-line' above fails by bumping against
2155 ;; the bottom of the minibuffer (bug#22544).
2157 ;; Restore the original goal column on the last line
2158 ;; of possibly multi-line input.
2166 "Move cursor vertically up ARG lines, or to the previous history element.
2167 When point moves over the top line of multi-line minibuffer, puts ARGth
2168 previous element of the minibuffer history in the minibuffer."
2172 ;; Remember the original goal column of possibly multi-line input
2173 ;; excluding the length of the prompt on the first line.
2183 ;; Restore old position since `line-move-visual' moves point to
2184 ;; the beginning of the line when it fails to go to the previous line.
2187 ;; Reset `temporary-goal-column' because a correct value is not
2188 ;; calculated when `previous-line' above fails by bumping against
2189 ;; the top of the minibuffer (bug#22544).
2191 ;; Restore the original goal column on the first line
2192 ;; of possibly multi-line input.
2198 ;; Put the cursor at the end of the visual line instead of the
2199 ;; logical line, so the next `previous-line-or-history-element'
2200 ;; would move to the previous history element, not to a possible upper
2201 ;; visual line from the end of logical line in `line-move-visual' mode.
2203 ;; Since `end-of-visual-line' puts the cursor at the beginning
2204 ;; of the next visual line, move it one char back to the end
2205 ;; of the first visual line (bug#22544).
2209 "Get next history element which completes the minibuffer before the point.
2210 The contents of the minibuffer after the point are deleted, and replaced
2211 by the new completion."
2217 n)
2218 ;; next-matching-history-element always puts us at (point-min).
2219 ;; Move to the position we were at before changing the buffer contents.
2220 ;; This is still sensible, because the text before point has not changed.
2224 "\
2225 Get previous history element which completes the minibuffer before the point.
2226 The contents of the minibuffer after the point are deleted, and replaced
2227 by the new completion."
2231 ;; For compatibility with the old subr of the same name.
2233 "Return the display width of the minibuffer prompt.
2234 Return 0 if current buffer is not a minibuffer."
2235 ;; Return the width of everything before the field at the end of
2236 ;; the buffer; this should be 0 for normal buffers.
2238 \f
2239 ;; isearch minibuffer history
2246 "Set up a minibuffer for using isearch to search the minibuffer history.
2247 Intended to be added to `minibuffer-setup-hook'."
2259 "Clean up the minibuffer after terminating isearch in the minibuffer."
2264 "Return the proper search function, for isearch in minibuffer history."
2267 ;; Use standard functions to search within minibuffer text
2269 found)
2270 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2271 ;; searching forward. Lazy-highlight calls this lambda with the
2272 ;; bound arg, so skip the minibuffer prompt.
2276 ;; 1. First try searching in the initial minibuffer text
2279 noerror)
2280 ;; 2. If the above search fails, start putting next/prev history
2281 ;; elements in the minibuffer successively, and search the string
2282 ;; in them. Do this only when bound is nil (i.e. not while
2283 ;; lazy-highlighting search strings in the current minibuffer text).
2295 ;; After putting the next/prev history element, search
2296 ;; the string in them again, until next-history-element
2297 ;; or previous-history-element raises an error at the
2298 ;; beginning/end of history.
2301 ;; For backward search, don't search
2302 ;; in the minibuffer prompt
2304 noerror)))
2305 ;; Return point of the new search result
2307 ;; Return nil when next(prev)-history-element fails
2311 "Display the minibuffer history search prompt.
2312 If there are no search errors, this function displays an overlay with
2313 the isearch prompt which replaces the original minibuffer prompt.
2314 Otherwise, it displays the standard isearch message returned from
2315 the function `isearch-message'."
2317 ;; Use standard function `isearch-message' when not in the minibuffer,
2318 ;; or search fails, or has an error (like incomplete regexp).
2319 ;; This function overwrites minibuffer text with isearch message,
2320 ;; so it's possible to see what is wrong in the search string.
2322 ;; Otherwise, put the overlay with the standard isearch prompt over
2323 ;; the initial minibuffer prompt.
2332 ;; And clear any previous isearch message.
2336 "Wrap the minibuffer history search when search fails.
2337 Move point to the first history element for a forward search,
2338 or to the last history element for a backward search."
2339 ;; When `minibuffer-history-isearch-search' fails on reaching the
2340 ;; beginning/end of the history, wrap the search to the first/last
2341 ;; minibuffer history element.
2349 "Save a function restoring the state of minibuffer history search.
2350 Save `minibuffer-history-position' to the additional state parameter
2351 in the search status stack."
2357 "Restore the minibuffer history search state.
2358 Go to the history element by the absolute history position HIST-POS."
2361 \f
2362 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2366 "Table mapping redo records to the corresponding undo one.
2367 A redo record for undo-in-region maps to t.
2377 "Within a run of consecutive undo commands, list remaining to be undone.
2381 "Undo some previous changes.
2382 Repeat this command to undo more changes.
2383 A numeric ARG serves as a repeat count.
2385 In Transient Mark mode when the mark is active, only undo changes within
2387 as an argument limits undo to changes within the current region."
2389 ;; Make last-command indicate for the next command that this was an undo.
2390 ;; That way, another undo will undo more.
2391 ;; If we get to the end of the undo history and get an error,
2392 ;; another undo command will find the undo history empty
2393 ;; and will get another error. To begin undoing the undos,
2394 ;; you must type some other command.
2396 ;; For an indirect buffer, look in the base buffer for the
2397 ;; auto-save data.
2401 message)
2402 ;; If we get an error in undo-start,
2403 ;; the next command should not be a "consecutive undo".
2404 ;; So set `this-command' to something other than `undo'.
2409 ;; If something (a timer or filter?) changed the buffer
2410 ;; since the previous command, don't continue the undo seq.
2414 ;; If the last undo record made was made by undo
2415 ;; it shows nothing else happened in between.
2422 ;; get rid of initial undo boundary
2424 ;; If we got this far, the next command should be a consecutive undo.
2426 ;; Check to see whether we're hitting a redo record, and if
2427 ;; so, ask the user whether she wants to skip the redo/undo pair.
2435 ;; The equiv entry might point to another redo record if we have done
2436 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2444 ;; Record the fact that the just-generated undo records come from an
2445 ;; undo operation--that is, they are redo records.
2446 ;; In the ordinary case (not within a region), map the redo
2447 ;; record to the following undos.
2448 ;; I don't know how to do that in the undo-in-region case.
2450 ;; Strip any leading undo boundaries there might be, like we do
2451 ;; above when checking.
2455 ;; Prevent identity mapping. This can happen if
2456 ;; consecutive nils are erroneously in undo list.
2458 t
2459 pending-undo-list)
2460 undo-equiv-table))
2461 ;; Don't specify a position in the undo record for the undo command.
2462 ;; Instead, undoing this should move point to where the change is.
2481 ;; Record what the current undo list says,
2482 ;; so the next command can tell if the buffer was modified in between.
2486 ;; Display a message announcing success.
2491 "Make BUFFER stop keeping undo information.
2492 No argument or nil as argument means do this for the current buffer."
2498 "Undo some previous changes.
2499 Repeat this command to undo more changes.
2500 A numeric ARG serves as a repeat count.
2501 Contrary to `undo', this will not redo a previous undo."
2506 "Non-nil while performing an undo.
2510 "Undo back N undo-boundaries beyond what was already undone recently.
2511 Call `undo-start' to get ready to undo recent changes,
2512 then call `undo-more' one or more times to undo them."
2517 ;; Note: The following, while pulling elements off
2518 ;; `pending-undo-list' will call primitive change functions which
2519 ;; will push more elements onto `buffer-undo-list'.
2525 "Undo N records from the front of the list LIST.
2526 Return what remains of the list."
2528 ;; This is a good feature, but would make undo-start
2529 ;; unable to do what is expected.
2530 ;;(when (null (car (list)))
2531 ;; ;; If the head of the list is a boundary, it is the boundary
2532 ;; ;; preceding this command. Get rid of it and don't count it.
2533 ;; (setq list (cdr list))))
2536 ;; In a writable buffer, enable undoing read-only text that is
2537 ;; so because of text properties.
2539 ;; Don't let `intangible' properties interfere with undo.
2541 ;; We use oldlist only to check for EQ. ++kfs
2547 ;; Handle an integer by setting point to that value.
2550 ;; Element (t . TIME) records previous modtime.
2551 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2552 ;; UNKNOWN_MODTIME_NSECS.
2554 ;; If this records an obsolete save
2555 ;; (not matching the actual disk file)
2556 ;; then don't mark unmodified.
2564 ;; Element (nil PROP VAL BEG . END) is property change.
2569 ;; Element (BEG . END) means range was inserted.
2571 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2572 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2575 ;; Set point first thing, so that undoing this undo
2576 ;; does not send point back to where it is now.
2579 ;; Element (apply FUN . ARGS) means call FUN to undo.
2583 ;; Long format: (apply DELTA START END FUN . ARGS).
2590 ;; Check that the function did what the entry
2591 ;; said it would do.
2601 ;; Element (STRING . POS) means STRING was deleted.
2607 ;; Check that marker adjustments which were recorded
2608 ;; with the (STRING . POS) record are still valid, ie
2609 ;; the markers haven't moved. We check their validity
2610 ;; before reinserting the string so as we don't need to
2611 ;; mind marker insertion-type.
2619 ;; Insert string and adjust point
2627 ;; Adjust the valid marker adjustments
2629 ;; Insert might have invalidated some of the markers
2630 ;; via modification hooks. Update only the currently
2631 ;; valid ones (bug#25599).
2635 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2638 next)
2639 ;; Even though these elements are not expected in the undo
2640 ;; list, adjust them to be conservative for the 24.4
2641 ;; release. (Bug#16818)
2648 ;; Make sure an apply entry produces at least one undo entry,
2649 ;; so the test in `undo' for continuing an undo series
2650 ;; will work right.
2655 list)
2657 ;; Deep copy of a list
2659 "Make a copy of undo list LIST."
2665 elt))
2668 "Set `pending-undo-list' to the front of the undo list.
2669 The next call to `undo-more' will undo the most recently made change.
2670 If BEG and END are specified, then only undo elements
2671 that apply to text between BEG and END are used; other undo elements
2672 are ignored. If BEG and END are nil, all undo elements are used."
2678 buffer-undo-list)))
2680 ;; The positions given in elements of the undo list are the positions
2681 ;; as of the time that element was recorded to undo history. In
2682 ;; general, subsequent buffer edits render those positions invalid in
2683 ;; the current buffer, unless adjusted according to the intervening
2684 ;; undo elements.
2685 ;;
2686 ;; Undo in region is a use case that requires adjustments to undo
2687 ;; elements. It must adjust positions of elements in the region based
2688 ;; on newer elements not in the region so as they may be correctly
2689 ;; applied in the current buffer. undo-make-selective-list
2690 ;; accomplishes this with its undo-deltas list of adjustments. An
2691 ;; example undo history from oldest to newest:
2692 ;;
2693 ;; buf pos:
2694 ;; 123456789 buffer-undo-list undo-deltas
2695 ;; --------- ---------------- -----------
2696 ;; aaa (1 . 4) (1 . -3)
2697 ;; aaba (3 . 4) N/A (in region)
2698 ;; ccaaba (1 . 3) (1 . -2)
2699 ;; ccaabaddd (7 . 10) (7 . -3)
2700 ;; ccaabdd ("ad" . 6) (6 . 2)
2701 ;; ccaabaddd (6 . 8) (6 . -2)
2702 ;; | |<-- region: "caab", from 2 to 6
2703 ;;
2704 ;; When the user starts a run of undos in region,
2705 ;; undo-make-selective-list is called to create the full list of in
2706 ;; region elements. Each element is adjusted forward chronologically
2707 ;; through undo-deltas to determine if it is in the region.
2708 ;;
2709 ;; In the above example, the insertion of "b" is (3 . 4) in the
2710 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2711 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2712 ;; . 6) is assessed as in the region and placed in the selective list.
2713 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2714 ;; due to the selected element. The "b" insertion is the only element
2715 ;; fully in the region, so in this example undo-make-selective-list
2716 ;; returns (nil (5 . 6)).
2717 ;;
2718 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2719 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2720 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2721 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2722 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2723 ;;
2724 ;; More interesting is how to adjust the "ddd" insertion due to the
2725 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2726 ;; If the reinsertion was a manual retyping of "ad", then the total
2727 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2728 ;; the reinsertion was due to undo, one might expect the first "d"
2729 ;; character would again be a part of the "ddd" text, meaning its
2730 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2731 ;;
2732 ;; undo-make-selective-list assumes in this situation that "ad" was a
2733 ;; new edit, even if it was inserted because of an undo.
2734 ;; Consequently, if the user undos in region "8 to 10" of the
2735 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2736 ;; "ccaabad", as though the first "d" became detached from the
2737 ;; original "ddd" insertion. This quirk is a FIXME.
2740 "Return a list of undo elements for the region START to END.
2741 The elements come from `buffer-undo-list', but we keep only the
2742 elements inside this region, and discard those outside this
2743 region. The elements' positions are adjusted so as the returned
2744 list can be applied to the current buffer."
2746 ;; A list of position adjusted undo elements in the region.
2748 ;; A list of undo-deltas for out of region undo elements.
2749 undo-deltas
2750 undo-elt)
2758 ;; Don't put two nils together in the list
2762 ;; This is a "was unmodified" element. Keep it
2763 ;; if we have kept everything thus far.
2766 ;; Skip over marker adjustments, instead relying
2767 ;; on finding them after (TEXT . POS) elements
2769 nil)
2772 undo-deltas)))
2777 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2778 ;; kept. primitive-undo may discard them later.
2791 "Determine whether UNDO-ELT falls inside the region START ... END.
2792 If it crosses the edge, we return nil.
2794 Generally this function is not useful for determining
2795 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2796 because markers can be arbitrarily relocated. Instead, pass the
2797 marker adjustment's corresponding (TEXT . POS) element."
2802 t)
2804 nil)
2806 ;; (TEXT . POSITION)
2810 ;; (MARKER . ADJUSTMENT)
2813 ;; (nil PROPERTY VALUE BEG . END)
2818 ;; (BEGIN . END)
2823 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2824 This assumes we have already decided that UNDO-ELT
2825 is not *inside* the region START...END."
2829 ;; (nil PROPERTY VALUE BEG . END)
2834 ;; (BEGIN . END)
2839 "Return adjustment of undo element ELT by the undo DELTAS
2840 list."
2842 ;; POSITION
2845 ;; (BEG . END)
2848 ;; (TEXT . POSITION)
2852 ;; (nil PROPERTY VALUE BEG . END)
2855 ;; (apply DELTA START END FUN . ARGS)
2856 ;; FIXME
2857 ;; All others return same elt
2860 ;; (BEG . END) can adjust to the same positions, commonly when an
2861 ;; insertion was undone and they are out of region, for example:
2862 ;;
2863 ;; buf pos:
2864 ;; 123456789 buffer-undo-list undo-deltas
2865 ;; --------- ---------------- -----------
2866 ;; [...]
2867 ;; abbaa (2 . 4) (2 . -2)
2868 ;; aaa ("bb" . 2) (2 . 2)
2869 ;; [...]
2870 ;;
2871 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2872 ;; undo. Further adjustments to such an element should be the same as
2873 ;; for (TEXT . POSITION) elements. The options are:
2874 ;;
2875 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2876 ;; analogous to marker insertion-type t.
2877 ;;
2878 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2879 ;; marker insertion-type nil.
2880 ;;
2881 ;; There was no strong reason to prefer one or the other, except that
2882 ;; the first is more consistent with prior undo in region behavior.
2884 "Return cons of adjustments to BEG and END by the undo DELTAS
2885 list."
2887 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2892 "Return adjustment of POS by the undo DELTAS list, comparing
2893 with < or <= based on USE-<."
2899 ;; Don't allow pos to become less than the undo-delta
2900 ;; position. This edge case is described in the overview
2901 ;; comments.
2904 ;; Return the first affected buffer position and the delta for an undo element
2905 ;; delta is defined as the change in subsequent buffer positions if we *did*
2906 ;; the undo.
2910 ;; (TEXT . POSITION)
2913 ;; (BEGIN . END)
2919 ;;; Default undo-boundary addition
2920 ;;
2921 ;; This section adds a new undo-boundary at either after a command is
2922 ;; called or in some cases on a timer called after a change is made in
2923 ;; any buffer.
2925 "Describe the cause of the last undo-boundary.
2927 If `explicit', the last boundary was caused by an explicit call to
2928 `undo-boundary', that is one not called by the code in this
2929 section.
2931 If it is equal to `timer', then the last boundary was inserted
2932 by `undo-auto--boundary-timer'.
2934 If it is equal to `command', then the last boundary was inserted
2935 automatically after a command, that is by the code defined in
2936 this section.
2938 If it is equal to a list, then the last boundary was inserted by
2939 an amalgamating command. The car of the list is the number of
2940 times an amalgamating command has been called, and the cdr are the
2944 "Current timer which will run `undo-auto--boundary-timer' or nil.
2949 "Non-nil if `this-command' should be amalgamated.
2950 This variable is set to nil by `undo-auto--boundaries' and is set
2954 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2958 "Return the number of amalgamating last commands or nil.
2959 Amalgamating commands are, by default, either
2960 `self-insert-command' and `delete-char', but can be any command
2961 that calls `undo-auto-amalgamate'."
2965 "Add an `undo-boundary' to the current buffer if needed.
2966 REASON describes the reason that the boundary is being added; see
2967 `undo-auto--last-boundary' for more information."
2977 undo-auto--undoably-changed-buffers)
2978 cause)))))
2981 "Check recently changed buffers and add a boundary if necessary.
2982 REASON describes the reason that the boundary is being added; see
2983 `undo-last-boundary' for more information."
2984 ;; (Bug #23785) All commands should ensure that there is an undo
2985 ;; boundary whether they have changed the current buffer or not.
2995 "Timer which will run `undo--auto-boundary-timer'."
3000 "Ensure that the `undo-auto-boundary-timer' is set."
3006 "List of buffers that have changed recently.
3008 This list is maintained by `undo-auto--undoable-change' and
3009 `undo-auto--boundaries' and can be affected by changes to their
3013 "Add an `undo-boundary' in appropriate buffers."
3018 'amalgamate
3022 "Amalgamate undo if necessary.
3023 This function can be called before an amalgamating command. It
3024 removes the previous `undo-boundary' if a series of such calls
3025 have been made. By default `self-insert-command' and
3026 `delete-char' are the only amalgamating commands, although this
3027 function could be called by any command wishing to have this
3028 behavior."
3033 last-amalgamating-count
3038 ;; Amalgamate all buffers that have changed.
3042 b
3044 ;; The head of `buffer-undo-list' is nil.
3045 ;; `car-safe' doesn't work because
3046 ;; `buffer-undo-list' need not be a list!
3054 "Called after every undoable buffer change."
3057 ;; End auto-boundary section
3060 "Amalgamate changes in change-group since HANDLE.
3061 Remove all undo boundaries between the state of HANDLE and now.
3062 HANDLE is as returned by `prepare-change-group'."
3071 ;; Temporarily truncate the undo log at ELT.
3076 ;; `elt' is still in the log: normal case.
3078 ;; `elt' is not in the log any more, but that's because
3079 ;; the log is "all new", so we should remove all
3080 ;; boundaries from it.
3084 buffer-undo-list
3085 ;; Preserve the undo-boundaries at either ends of the
3086 ;; change-groups.
3088 ;; Reset the modified cons cell ELT to its original content.
3095 "If non-nil ask about discarding undo info for the current command.
3096 Normally, Emacs discards the undo info for the current command if
3097 it exceeds `undo-outer-limit'. But if you set this option
3098 non-nil, it asks in the echo area whether to discard the info.
3099 If you answer no, there is a slight risk that Emacs might crash, so
3100 only do it if you really want to undo the command.
3102 This option is mainly intended for debugging. You have to be
3103 careful if you use it for other purposes. Garbage collection is
3104 inhibited while the question is asked, meaning that Emacs might
3105 leak memory. So you should make sure that you do not wait
3106 excessively long before answering the question."
3112 "If non-nil, an extra level of size that's ok in an undo item.
3113 We don't ask the user about truncating the undo list until the
3114 current item gets bigger than this amount.
3119 ;; When the first undo batch in an undo list is longer than
3120 ;; undo-outer-limit, this function gets called to warn the user that
3121 ;; the undo info for the current command was discarded. Garbage
3122 ;; collection is inhibited around the call, so it had better not do a
3123 ;; lot of consing.
3129 ;; Don't ask the question again unless it gets even bigger.
3130 ;; This applies, in particular, if the user quits from the question.
3131 ;; Such a quit quits out of GC, but something else will call GC
3132 ;; again momentarily. It will call this function again,
3133 ;; but we don't want to ask the question again.
3137 "Buffer `%s' undo info is %d bytes long; discard it? "
3141 t)
3142 nil))
3148 "The undo info was discarded because it exceeded \
3149 `undo-outer-limit'.
3151 This is normal if you executed a command that made a huge change
3152 to the buffer. In that case, to prevent similar problems in the
3153 future, set `undo-outer-limit' to a value that is large enough to
3154 cover the maximum size of normal changes you expect a single
3155 command to make, but not so large that it might exceed the
3156 maximum memory allotted to Emacs.
3158 If you did not execute any such command, the situation is
3159 probably due to a bug and you should report it.
3161 You can disable the popping up of this buffer by adding the entry
3162 \(undo discard-info) to the user option `warning-suppress-types',
3166 t))
3167 \f
3170 ; These are sorted according to the GNU en_US locale.
3213 )
3215 This is used by Shell mode and other parts of Emacs to recognize
3216 password prompts, including prompts in languages other than
3217 English. Different case choices should not be assumed to be
3218 included; callers should bind `case-fold-search' to t."
3224 "History list for some commands that read shell commands.
3226 Maximum length of the history list is determined by the value
3233 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3234 This buffer is used when `shell-command' or `shell-command-on-region'
3235 is run interactively. A value of nil means that output to stderr and
3242 "Return a list of all commands associated with the current file.
3243 This function is used to add all related commands retrieved by `mailcap'
3244 to the end of the list of defaults just after the default value."
3248 minibuffer-default))
3253 commands))
3264 map)
3268 "Read a shell command from the minibuffer.
3269 The arguments are the same as the ones of `read-from-minibuffer',
3270 except READ and KEYMAP are missing and HIST defaults
3271 to `shell-command-history'."
3279 minibuffer-local-shell-command-map
3280 nil
3282 args)))
3285 "What to do when the output buffer is used by another shell command.
3286 This option specifies how to resolve the conflict where a new command
3287 wants to direct its output to the buffer `*Async Shell Command*',
3288 but this buffer is already taken by another running shell command.
3290 The value `confirm-kill-process' is used to ask for confirmation before
3291 killing the already running process and running a new process
3292 in the same buffer, `confirm-new-buffer' for confirmation before running
3293 the command in a new buffer with a name other than the default buffer name,
3294 `new-buffer' for doing the same without confirmation,
3295 `confirm-rename-buffer' for confirmation before renaming the existing
3296 output buffer and running a new command in the default buffer,
3297 `rename-buffer' for doing the same without confirmation."
3299 confirm-kill-process)
3301 confirm-new-buffer)
3303 new-buffer)
3305 confirm-rename-buffer)
3307 rename-buffer))
3312 "Whether to display the command buffer immediately.
3313 If t, display the buffer immediately; if nil, wait until there
3314 is output."
3316 t)
3318 nil))
3323 "If non-nil, output buffer is not erased between shell commands.
3324 Also, a non-nil value sets the point in the output buffer
3325 once the command completes.
3326 The value `beg-last-out' sets point at the beginning of the output,
3327 `end-last-out' sets point at the end of the buffer, `save-point'
3328 restores the buffer position before the command."
3338 "Record of point positions in output buffers after command completion.
3339 The value is an alist whose elements are of the form (BUFFER . POS),
3340 where BUFFER is the output buffer, and POS is the point position
3341 in BUFFER once the command finishes.
3345 "Store a buffer position or erase the buffer.
3346 See `shell-command-dont-erase-buffer'."
3348 pos)
3350 ;; Setting buffer-read-only to nil doesn't suffice
3351 ;; if some text has a non-nil read-only property,
3352 ;; which comint sometimes adds for prompts.
3362 shell-command-saved-pos))))
3365 "Set point in BUFFER after command complete.
3366 BUFFER is the output buffer of the command; if nil, then defaults
3367 to the current BUFFER.
3368 Set point to the `cdr' of the element in `shell-command-saved-pos'
3369 whose `car' is BUFFER."
3381 ;; Set point in the window displaying buf, if any; otherwise
3382 ;; display buf temporary in selected frame and set the point.
3387 buf
3392 "Execute string COMMAND asynchronously in background.
3394 Like `shell-command', but adds `&' at the end of COMMAND
3395 to execute it asynchronously.
3397 The output appears in the buffer `*Async Shell Command*'.
3398 That buffer is in shell mode.
3400 You can configure `async-shell-command-buffer' to specify what to do
3401 when the `*Async Shell Command*' buffer is already taken by another
3402 running shell command. To run COMMAND without displaying the output
3403 in a window you can configure `display-buffer-alist' to use the action
3404 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3406 In Elisp, you will often be better served by calling `start-process'
3407 directly, since it offers more control and does not impose the use of
3408 a shell (with its need to quote arguments)."
3418 current-prefix-arg
3419 shell-command-default-error-buffer))
3425 "Execute string COMMAND in inferior shell; display output, if any.
3426 With prefix argument, insert the COMMAND's output at point.
3428 Interactively, prompt for COMMAND in the minibuffer.
3430 If COMMAND ends in `&', execute it asynchronously.
3431 The output appears in the buffer `*Async Shell Command*'.
3432 That buffer is in shell mode. You can also use
3433 `async-shell-command' that automatically adds `&'.
3435 Otherwise, COMMAND is executed synchronously. The output appears in
3436 the buffer `*Shell Command Output*'. If the output is short enough to
3437 display in the echo area (which is determined by the variables
3438 `resize-mini-windows' and `max-mini-window-height'), it is shown
3439 there, but it is nonetheless available in buffer `*Shell Command
3440 Output*' even though that buffer is not automatically displayed.
3442 To specify a coding system for converting non-ASCII characters
3444 before this command.
3446 Noninteractive callers can specify coding systems by binding
3447 `coding-system-for-read' and `coding-system-for-write'.
3449 The optional second argument OUTPUT-BUFFER, if non-nil,
3450 says to put the output in some other buffer.
3451 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3452 and insert the output there; a non-nil value of
3453 `shell-command-dont-erase-buffer' prevents the buffer from being
3454 erased. If OUTPUT-BUFFER is not a buffer and not nil, insert the
3455 output in current buffer after point leaving mark after it. This
3456 cannot be done asynchronously.
3458 If the command terminates without error, but generates output,
3460 the output can be displayed in the echo area or in its buffer.
3461 If the output is short enough to display in the echo area
3462 \(determined by the variable `max-mini-window-height' if
3463 `resize-mini-windows' is non-nil), it is shown there.
3464 Otherwise, the buffer containing the output is displayed.
3468 of the output.
3470 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3471 or buffer name to which to direct the command's standard error output.
3472 If it is nil, error output is mingled with regular output.
3473 In an interactive call, the variable `shell-command-default-error-buffer'
3474 specifies the value of ERROR-BUFFER.
3476 In Elisp, you will often be better served by calling `call-process' or
3477 `start-process' directly, since they offer more control and do not
3478 impose the use of a shell (with its need to quote arguments)."
3489 current-prefix-arg
3490 shell-command-default-error-buffer))
3491 ;; Look for a handler in case default-directory is a remote file name.
3499 ;; Output goes in current buffer.
3505 temporary-file-directory)))
3506 nil)))
3509 ;; We do not use -f for csh; we will not support broken use of
3510 ;; .cshrcs. Even the BSD csh manual says to use
3511 ;; "if ($?prompt) exit" before things which are not useful
3512 ;; non-interactively. Besides, if someone wants their other
3513 ;; aliases for shell commands then they can still have them.
3517 t)
3518 nil shell-command-switch command)
3525 ;; Do no formatting while reading error file,
3526 ;; because that can run a shell command, and we
3527 ;; don't want that to cause an infinite recursion.
3529 ;; Put point after the inserted errors.
3533 ;; This is like exchange-point-and-mark, but doesn't
3534 ;; activate the mark. It is cleaner to avoid activation,
3535 ;; even though the command loop would deactivate the mark
3536 ;; because we inserted text.
3540 ;; Output goes in a separate buffer.
3541 ;; Preserve the match data in case called from a program.
3542 ;; FIXME: It'd be ridiculous for an Elisp function to call
3543 ;; shell-command and assume that it won't mess the match-data!
3546 ;; Command ending with ampersand means asynchronous.
3551 proc)
3552 ;; Remove the ampersand.
3554 ;; Ask the user what to do with already running process.
3559 ;; If will kill a process, query first.
3564 ;; If will create a new buffer, query first.
3569 ;; It will create a new buffer.
3572 ;; If will rename the buffer, query first.
3580 ;; It will rename the buffer.
3588 shell-command-switch command))
3592 ;; Use the comint filter for proper handling of
3593 ;; carriage motion (see comint-inhibit-carriage-motion).
3596 ;; Display buffer immediately.
3598 ;; Defer displaying buffer until first process output.
3599 ;; Use disposable named advice so that the buffer is
3600 ;; displayed at most once per process lifetime.
3607 nonce)
3610 ;; Otherwise, command is executed synchronously.
3612 output-buffer nil error-buffer)))))))
3615 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3616 MESSAGE may be either a string or a buffer.
3618 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3619 for maximum height of the echo area, as defined by `max-mini-window-height'
3620 if `resize-mini-windows' is non-nil.
3622 Returns either the string shown in the echo area, or when a pop-up
3623 buffer is used, the window used to display it.
3625 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3626 name of the buffer used to display it in the case where a pop-up buffer
3627 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3628 string and it is displayed in the echo area, it is not specified whether
3629 the contents are inserted into the buffer anyway.
3631 Optional arguments ACTION and FRAME are as for `display-buffer',
3632 and are only used if a pop-up buffer is displayed."
3634 ;; Trivial case where we can use the echo area
3638 ;; Trivial case where we can just remove single trailing newline
3641 ;; General case
3644 message
3653 0
3657 (<= lines
3661 max-mini-window-height))
3663 max-mini-window-height)
3667 ;; Don't use the echo area if the output buffer is
3668 ;; already displayed in the selected frame.
3670 ;; Echo area
3676 ;; Buffer
3681 ;; We have a sentinel to prevent insertion of a termination message
3682 ;; in the buffer itself, and to set the point in the buffer when
3683 ;; `shell-command-dont-erase-buffer' is non-nil.
3692 &optional output-buffer replace
3693 error-buffer display-error-buffer
3694 region-noncontiguous-p)
3695 "Execute string COMMAND in inferior shell with region as input.
3696 Normally display output (if any) in temp buffer `*Shell Command Output*';
3697 Prefix arg means replace the region with it. Return the exit code of
3698 COMMAND.
3700 To specify a coding system for converting non-ASCII characters
3702 before this command. By default, the input (from the current buffer)
3703 is encoded using coding-system specified by `process-coding-system-alist',
3704 falling back to `default-process-coding-system' if no match for COMMAND
3705 is found in `process-coding-system-alist'.
3707 Noninteractive callers can specify coding systems by binding
3708 `coding-system-for-read' and `coding-system-for-write'.
3710 If the command generates output, the output may be displayed
3711 in the echo area or in a buffer.
3712 If the output is short enough to display in the echo area
3713 \(determined by the variable `max-mini-window-height' if
3714 `resize-mini-windows' is non-nil), it is shown there.
3715 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3716 The output is available in that buffer in both cases.
3718 If there is output and an error, a message about the error
3719 appears at the end of the output.
3721 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3722 command's output. If the value is a buffer or buffer name,
3723 erase that buffer and insert the output there; a non-nil value of
3724 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3725 If the value is nil, use the buffer `*Shell Command Output*'.
3726 Any other non-nil value means to insert the output in the
3727 current buffer after START.
3729 Optional fifth arg REPLACE, if non-nil, means to insert the
3730 output in place of text from START to END, putting point and mark
3731 around it.
3733 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3734 or buffer name to which to direct the command's standard error
3735 output. If nil, error output is mingled with regular output.
3736 When called interactively, `shell-command-default-error-buffer'
3737 is used for ERROR-BUFFER.
3739 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3740 display the error buffer if there were any errors. When called
3741 interactively, this is t."
3745 ;; Do this before calling region-beginning
3746 ;; and region-end, in case subprocess output
3747 ;; relocates them while we are in the minibuffer.
3749 ;; call-interactively recognizes region-beginning and
3750 ;; region-end specially, leaving them in the history.
3752 string
3753 current-prefix-arg
3754 current-prefix-arg
3755 shell-command-default-error-buffer
3756 t
3763 temporary-file-directory)))
3764 nil))
3765 exit-status)
3766 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3769 output)
3773 shell-file-name t t
3774 nil shell-command-switch
3775 command)
3782 ;; Replace specified region with output from command.
3784 ;; Don't muck with mark unless REPLACE says we should.
3791 t)))
3792 ;; It is rude to delete a buffer which the command is not using.
3793 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3794 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3795 ;; (kill-buffer shell-buffer)))
3796 ;; Don't muck with mark unless REPLACE says we should.
3798 ;; No prefix argument: put the output in a temp buffer,
3799 ;; replacing its entire contents.
3807 ;; If the input is the same buffer as the output,
3808 ;; delete everything but the specified region,
3809 ;; then replace that region with the output.
3815 shell-file-name t
3818 t)
3819 nil shell-command-switch
3820 command)))
3821 ;; Clear the output buffer, then run the command with
3822 ;; output there.
3832 buffer))))
3833 ;; Report the output.
3843 ;; There's some output, display it
3847 ;; No output; error?
3854 shell-command-default-error-buffer)
3861 output))
3864 exit-status))
3867 exit-status output))))
3868 ;; Don't kill: there might be useful info in the undo-log.
3869 ;; (kill-buffer buffer)
3870 )))))
3878 ;; Do no formatting while reading error file,
3879 ;; because that can run a shell command, and we
3880 ;; don't want that to cause an infinite recursion.
3882 ;; Put point after the inserted errors.
3887 exit-status))
3890 "Execute shell command COMMAND and return its output as a string."
3893 standard-output
3897 "Process files synchronously in a separate process.
3898 Similar to `call-process', but may invoke a file handler based on
3899 `default-directory'. The current working directory of the
3900 subprocess is `default-directory'.
3902 File names in INFILE and BUFFER are handled normally, but file
3903 names in ARGS should be relative to `default-directory', as they
3904 are passed to the process verbatim. (This is a difference to
3905 `call-process' which does not support file handlers for INFILE
3906 and BUFFER.)
3908 Some file handlers might not support all variants, for example
3909 they might behave as if DISPLAY was nil, regardless of the actual
3910 value passed."
3912 lc stderr-file)
3922 display args)
3928 "Whether a call of `process-file' changes remote files.
3930 By default, this variable is always set to t, meaning that a
3931 call of `process-file' could potentially change any file on a
3932 remote host. When set to nil, a file handler could optimize
3933 its behavior with respect to remote file attribute caching.
3935 You should only ever change this variable with a let-binding;
3939 "Start a program in a subprocess. Return the process object for it.
3941 Similar to `start-process', but may invoke a file handler based on
3942 `default-directory'. See Info node `(elisp)Magic File Names'.
3944 This handler ought to run PROGRAM, perhaps on the local host,
3945 perhaps on a remote host that corresponds to `default-directory'.
3946 In the latter case, the local part of `default-directory' becomes
3947 the working directory of the process.
3949 PROGRAM and PROGRAM-ARGS might be file names. They are not
3950 objects of file handler invocation. File handlers might not
3951 support pty association, if PROGRAM is nil."
3955 \f
3956 ;;;; Process menu
3970 map))
3973 "Major mode for listing the processes called by Emacs."
3977 ;; 25 is the length of the long standard buffer
3978 ;; name "*Async Shell Command*<10>" (bug#30016)
3987 "Kill process at point in a `list-processes' buffer."
3998 "Recompute the list of processes for the Process List buffer.
3999 Also, delete any process that is exited or signaled."
4013 face link
4015 "Visit buffer `%s'"
4017 follow-link t
4018 process-buffer ,buf
4019 action process-menu-visit-buffer)
4028 "datagram"
4045 tabulated-list-entries)))))
4052 "Display a list of all processes that are Emacs sub-processes.
4053 If optional argument QUERY-ONLY is non-nil, only processes with
4054 the query-on-exit flag set are listed.
4055 Any process listed as exited or signaled is actually eliminated
4056 after the listing is made.
4057 Optional argument BUFFER specifies a buffer to use, instead of
4059 The return value is always nil.
4061 This function lists only processes that were launched by Emacs. To
4062 see other processes running on the system, use `list-system-processes'."
4074 nil)
4075 \f
4076 ;;;; Prefix commands
4082 ;; BEWARE: Called directly from C code.
4083 ;; If the return value is non-nil, it means we are in the middle of
4084 ;; a command with prefix, such as a command invoked with prefix-arg.
4086 prefix-command--last-echo
4095 "Abnormal hook which constructs the description of the current prefix state.
4099 "Update state of prefix commands.
4107 "Pass the current prefix command state to the next command.
4108 Should be called by all prefix commands.
4109 Runs `prefix-command-preserve-state-hook'."
4111 ;; If the current command is a prefix command, we don't want the next (real)
4112 ;; command to have `last-command' set to, say, `universal-argument'.
4119 nil)
4121 ;;;;; The main prefix command.
4123 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
4148 ;; For backward compatibility, minus with no modifiers is an ordinary
4149 ;; command if digits have already been entered.
4179 map)
4187 "Begin a numeric argument for the following command.
4192 multiplies the argument by 4 each time.
4194 which is different in effect from any particular numeric argument.
4202 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
4203 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
4210 arg)))
4214 "Begin a negative numeric argument for the next command.
4224 "Part of the numeric argument for the next command.
4229 last-command-event
4236 ;; Treat -0 as just -, so that -01 will work.
4239 digit))))
4241 \f
4244 "This variable is a wrapper hook around `buffer-substring--filter'.
4250 "Function to perform the filtering in `filter-buffer-substring'.
4251 The function is called with the same 3 arguments (BEG END DELETE)
4252 that `filter-buffer-substring' received. It should return the
4253 buffer substring between BEG and END, after filtering. If DELETE is
4257 "List of filter functions for `buffer-substring--filter'.
4258 Each function must accept a single argument, a string, and return a string.
4259 The buffer substring is passed to the first function in the list,
4260 and the return value of each function is passed to the next.
4261 As a special convention, point is set to the start of the buffer text
4262 being operated on (i.e., the first argument of `buffer-substring--filter')
4268 "Return the buffer substring between BEG and END, after filtering.
4269 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4271 This calls the function that `filter-buffer-substring-function' specifies
4272 \(passing the same three arguments that it received) to do the work,
4273 and returns whatever it does. The default function does no filtering,
4274 unless a hook has been set.
4276 Use `filter-buffer-substring' instead of `buffer-substring',
4277 `buffer-substring-no-properties', or `delete-and-extract-region' when
4278 you want to allow filtering to take place. For example, major or minor
4279 modes can use `filter-buffer-substring-function' to extract characters
4280 that are special to a buffer, and should not be copied into other buffers."
4284 "Default function to use for `filter-buffer-substring-function'.
4285 Its arguments and return value are as specified for `filter-buffer-substring'.
4286 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4287 \(see `with-wrapper-hook' for details about wrapper hooks),
4288 and the abnormal hook `buffer-substring-filters'.
4289 No filtering is done unless a hook says to."
4300 string)))
4305 ;;;; Window system cut and paste hooks.
4308 "Function to call to make a killed region available to other programs.
4309 Most window systems provide a facility for cutting and pasting
4310 text between different programs, such as the clipboard on X and
4311 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4313 This variable holds a function that Emacs calls whenever text is
4314 put in the kill ring, to make the new kill available to other
4315 programs. The function takes one argument, TEXT, which is a
4319 "Function to call to get text cut from other programs.
4320 Most window systems provide a facility for cutting and pasting
4321 text between different programs, such as the clipboard on X and
4322 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4324 This variable holds a function that Emacs calls to obtain text
4325 that other programs have provided for pasting. The function is
4326 called with no arguments. If no other program has provided text
4327 to paste, the function should return nil (in which case the
4328 caller, usually `current-kill', should use the top of the Emacs
4329 kill ring). If another program has provided text to paste, the
4330 function should return that text as a string (in which case the
4331 caller should put this string in the kill ring as the latest
4332 kill).
4334 The function may also return a list of strings if the window
4335 system supports multiple selections. The first string will be
4336 used as the pasted text, but the other will be placed in the kill
4337 ring for easy access via `yank-pop'.
4339 Note that the function should return a string only if a program
4340 other than Emacs has provided a string for pasting; if Emacs
4341 provided the most recent string, the function should return nil.
4342 If it is difficult to tell whether Emacs or some other program
4343 provided the current string, it is probably good enough to return
4344 nil if the string is equal (according to `string=') to the last
4346 \f
4349 ;;;; The kill ring data structure.
4352 "List of killed text sequences.
4353 Since the kill ring is supposed to interact nicely with cut-and-paste
4354 facilities offered by window systems, use of this variable should
4355 interact nicely with `interprogram-cut-function' and
4356 `interprogram-paste-function'. The functions `kill-new',
4357 `kill-append', and `current-kill' are supposed to implement this
4358 interaction; you may want to use them instead of manipulating the kill
4362 "Maximum length of kill ring before oldest elements are thrown away."
4370 "Save clipboard strings into kill ring before replacing them.
4371 When one selects something in another program to paste it into Emacs,
4372 but kills something in Emacs before actually pasting it,
4373 this selection is gone unless this variable is non-nil,
4374 in which case the other program's selection is saved in the `kill-ring'
4381 "Do not add a new string to `kill-ring' if it duplicates the last one.
4382 The comparison is done using `equal-including-properties'."
4388 "Make STRING the latest kill in the kill ring.
4389 Set `kill-ring-yank-pointer' to point to it.
4390 If `interprogram-cut-function' is non-nil, apply it to STRING.
4391 Optional second argument REPLACE non-nil means that STRING will replace
4392 the front of the kill ring, rather than being added to the list.
4394 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4395 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4396 STRING.
4398 When the yank handler has a non-nil PARAM element, the original STRING
4399 argument is not used by `insert-for-yank'. However, since Lisp code
4400 may access and use elements from the kill ring directly, the STRING
4403 ;; Due to text properties such as 'yank-handler that
4404 ;; can alter the contents to yank, comparison using
4405 ;; `equal' is unsafe.
4430 ;; It has been argued that this should work similar to `self-insert-command'
4431 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4433 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4439 "Append STRING to the end of the latest kill in the kill ring.
4440 If BEFORE-P is non-nil, prepend STRING to the kill.
4441 Also removes the last undo boundary in the current buffer,
4442 depending on `kill-append-merge-undo'.
4443 If `interprogram-cut-function' is set, pass the resulting kill to it."
4451 ;; find the next undo boundary
4455 ;; remove this undo boundary
4460 "Whether rotating the kill ring changes the window system selection.
4461 If non-nil, whenever the kill ring is rotated (usually via the
4462 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4463 to copy the new kill to the window system selection."
4469 "Rotate the yanking point by N places, and then return that kill.
4470 If N is zero and `interprogram-paste-function' is set to a
4471 function that returns a string or a list of strings, and if that
4472 function doesn't return nil, then that string (or list) is added
4473 to the front of the kill ring and the string (or first string in
4474 the list) is returned as the latest kill.
4476 If N is not zero, and if `yank-pop-change-selection' is
4477 non-nil, use `interprogram-cut-function' to transfer the
4478 kill at the new yank point into the window system selection.
4480 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4481 move the yanking point; just return the Nth kill forward."
4484 interprogram-paste-function
4488 ;; Disable the interprogram cut function when we add the new
4489 ;; text to the kill ring, so Emacs doesn't try to own the
4490 ;; selection, with identical text.
4500 kill-ring)))
4505 interprogram-cut-function)
4511 ;;;; Commands for manipulating the kill ring.
4514 "Non-nil means don't signal an error for killing read-only text."
4520 This deletes the text from the buffer and saves it in the kill ring.
4524 If you want to append the killed region to the last killed text,
4528 If the previous command was also a kill command,
4529 the text killed this time appends to the text killed last time
4530 to make one entry in the kill ring.
4532 The killed text is filtered by `filter-buffer-substring' before it is
4533 saved in the kill ring, so the actual saved text might be different
4534 from what was killed.
4536 If the buffer is read-only, Emacs will beep and refrain from deleting
4537 the text, but put the text in the kill ring anyway. This means that
4538 you can use the killing commands to copy text from a read-only buffer.
4540 Lisp programs should use this function for killing text.
4541 (To delete text, use `delete-region'.)
4542 Supply two arguments, character positions BEG and END indicating the
4543 stretch of text to be killed. If the optional argument REGION is
4544 non-nil, the function ignores BEG and END, and kills the current
4545 region instead."
4546 ;; Pass mark first, then point, because the order matters when
4547 ;; calling `kill-append'.
4556 ;; Add that string to the kill ring, one way or another.
4563 nil)
4565 ;; The code above failed because the buffer, or some of the characters
4566 ;; in the region, are read-only.
4567 ;; We should beep, in case the user just isn't aware of this.
4568 ;; However, there's no harm in putting
4569 ;; the region's text in the kill ring, anyway.
4571 ;; Set this-command now, so it will be set even if we get an error.
4573 ;; This should barf, if appropriate, and give us the correct error.
4576 ;; Signal an error if the buffer is read-only.
4578 ;; If the buffer isn't read-only, the text is.
4581 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4582 ;; to get two copies of the text when the user accidentally types M-w and
4583 ;; then corrects it with the intended C-w.
4585 "Save the region as if killed, but don't kill it.
4586 In Transient Mark mode, deactivate the mark.
4587 If `interprogram-cut-function' is non-nil, also save the text for a window
4588 system cut and paste.
4590 The copied text is filtered by `filter-buffer-substring' before it is
4591 saved in the kill ring, so the actual saved text might be different
4592 from what was in the buffer.
4594 When called from Lisp, save in the kill ring the stretch of text
4595 between BEG and END, unless the optional argument REGION is
4596 non-nil, in which case ignore BEG and END, and save the current
4597 region instead.
4599 This command's old key binding has been given to `kill-ring-save'."
4600 ;; Pass mark first, then point, because the order matters when
4601 ;; calling `kill-append'.
4611 nil)
4614 "Save the region as if killed, but don't kill it.
4615 In Transient Mark mode, deactivate the mark.
4616 If `interprogram-cut-function' is non-nil, also save the text for a window
4617 system cut and paste.
4619 If you want to append the killed line to the last killed text,
4622 The copied text is filtered by `filter-buffer-substring' before it is
4623 saved in the kill ring, so the actual saved text might be different
4624 from what was in the buffer.
4626 When called from Lisp, save in the kill ring the stretch of text
4627 between BEG and END, unless the optional argument REGION is
4628 non-nil, in which case ignore BEG and END, and save the current
4629 region instead.
4631 This command is similar to `copy-region-as-kill', except that it gives
4632 visual feedback indicating the extent of the region being copied."
4633 ;; Pass mark first, then point, because the order matters when
4634 ;; calling `kill-append'.
4638 ;; This use of called-interactively-p is correct because the code it
4639 ;; controls just gives the user visual feedback.
4644 "Indicate that the region text has been copied interactively.
4645 If the mark is visible in the selected window, blink the cursor
4646 between point and mark if there is currently no active region
4647 highlighting.
4649 If the mark lies outside the selected window, display an
4650 informative message containing a sample of the copied text. The
4651 optional argument MESSAGE-LEN, if non-nil, specifies the length
4652 of this sample text; it defaults to 40."
4655 ;; Inhibit quitting so we can make a quit here
4656 ;; look like a C-g typed as a command.
4659 ;; Swap point-and-mark quickly so as to show the region that
4660 ;; was selected. Don't do it if the region is highlighted.
4663 ;; Swap point and mark.
4667 ;; Swap back.
4670 ;; If user quit, deactivate the mark
4671 ;; as C-g would as a command.
4677 ;; Don't say "killed"; that is misleading.
4684 "Cause following command, if it kills, to add to previous kill.
4685 If the next command kills forward from point, the kill is
4686 appended to the previous killed text. If the command kills
4687 backward, the kill is prepended. Kill commands that act on the
4688 region, such as `kill-region', are regarded as killing forward if
4689 point is after mark, and killing backward if point is before
4690 mark.
4692 If the next command is not a kill command, `append-next-kill' has
4693 no effect.
4695 The argument is used for internal purposes; do not supply one."
4697 ;; We don't use (interactive-p), since that breaks kbd macros.
4711 "A subroutine of `squeeze-bidi-context'.
4712 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4716 lim1)
4723 ;; L and R categories include embedding and
4724 ;; override controls, but we don't want to
4725 ;; replace them, because that might change
4726 ;; the visual order. Likewise with PDF and
4727 ;; isolate controls.
4729 bidi-directional-non-controls-chars
4730 limit)))))
4731 ;; Replace any run of non-RTL characters by a single LRM.
4733 ;; No more characters of CATEGORY, we are done.
4738 ;; Skip directional controls, if any.
4743 "Replace characters between FROM and TO while keeping bidi context.
4745 This function replaces the region of text with as few characters
4746 as possible, while preserving the effect that region will have on
4747 bidirectional display before and after the region."
4751 ;; This is for when they copy text with read-only text
4752 ;; properties.
4756 ;; Replace each run of non-RTL characters with a single LRM.
4758 ;; Replace each run of non-LTR characters with a single RLM. Note
4759 ;; that the \cR category includes both the Arabic Letter (AL) and
4760 ;; R characters; here we ignore the distinction between them,
4761 ;; because that distinction only affects Arabic Number (AN)
4762 ;; characters, which are weak and don't affect the reordering.
4766 "Return buffer text between START and END with its bidi context.
4768 START and END are assumed to belong to the same physical line
4769 of buffer text. This function prepends and appends to the text
4770 between START and END bidi control characters that preserve the
4771 visual order of that text when it is inserted at some other place."
4776 substr para-dir from to)
4783 ;; If we don't have any mixed directional characters in the
4784 ;; entire line, we can just copy the substring without adding
4785 ;; any context.
4800 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4801 ;; (1) force the string to have the same base embedding
4802 ;; direction as the paragraph direction at the source, no matter
4803 ;; what is the paragraph direction at destination; and (2) avoid
4804 ;; affecting the visual order of the surrounding text at
4805 ;; destination if there are characters of different
4806 ;; directionality there.
4811 "Return portion of current buffer between START and END with bidi context.
4813 This function works similar to `buffer-substring', but it prepends and
4814 appends to the text bidi directional control characters necessary to
4815 preserve the visual appearance of the text if it is inserted at another
4816 place. This is useful when the buffer substring includes bidirectional
4817 text and control characters that cause non-trivial reordering on display.
4818 If copied verbatim, such text can have a very different visual appearance,
4819 and can also change the visual appearance of the surrounding text at the
4820 destination of the copy.
4822 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4823 the text properties."
4836 no-properties)))
4840 substr)))
4841 \f
4842 ;; Yanking.
4847 "List of special text property handling conditions for yanking.
4848 Each element should have the form (PROP . FUN), where PROP is a
4849 property symbol and FUN is a function. When the `yank' command
4850 inserts text into the buffer, it scans the inserted text for
4851 stretches of text that have `eq' values of the text property
4852 PROP; for each such stretch of text, FUN is called with three
4853 arguments: the property's value in that text, and the start and
4854 end positions of the text.
4856 This is done prior to removing the properties specified by
4857 `yank-excluded-properties'."
4860 function))
4863 ;; This is actually used in subr.el but defcustom does not work there.
4866 intangible invisible keymap local-map mouse-face read-only
4867 yank-handler)
4868 "Text properties to discard when yanking.
4869 The value should be a list of text properties to discard or t,
4870 which means to discard all text properties.
4872 See also `yank-handled-properties'."
4879 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4880 Function is called with two parameters, START and END corresponding to
4881 the value of the mark and point; it is guaranteed that START <= END.
4885 "Replace just-yanked stretch of killed text with a different stretch.
4886 This command is allowed only immediately after a `yank' or a `yank-pop'.
4887 At such a time, the region contains a stretch of reinserted
4888 previously-killed text. `yank-pop' deletes that text and inserts in its
4889 place a different stretch of killed text.
4891 With no argument, the previous kill is inserted.
4892 With argument N, insert the Nth previous kill.
4893 If N is negative, this is a more recent kill.
4895 The sequence of kills wraps around, so that after the oldest one
4896 comes the newest one.
4898 This command honors the `yank-handled-properties' and
4899 `yank-excluded-properties' variables, and the `yank-handler' text
4900 property, in the way that `yank' does."
4914 ;; Set the window start back where it was in the yank command,
4915 ;; if possible.
4918 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4919 ;; It is cleaner to avoid activation, even though the command
4920 ;; loop would deactivate the mark because we inserted text.
4923 nil)
4927 More precisely, reinsert the most recent kill, which is the
4928 stretch of killed text most recently killed OR yanked. Put point
4929 at the end, and set mark at the beginning without activating it.
4931 With argument N, reinsert the Nth most recent kill.
4933 This command honors the `yank-handled-properties' and
4934 `yank-excluded-properties' variables, and the `yank-handler' text
4935 property, as described below.
4937 Properties listed in `yank-handled-properties' are processed,
4938 then those listed in `yank-excluded-properties' are discarded.
4940 If STRING has a non-nil `yank-handler' property anywhere, the
4941 normal insert behavior is altered, and instead, for each contiguous
4942 segment of STRING that has a given value of the `yank-handler'
4943 property, that value is used as follows:
4945 The value of a `yank-handler' property must be a list of one to four
4946 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
4947 FUNCTION, if non-nil, should be a function of one argument (the
4948 object to insert); FUNCTION is called instead of `insert'.
4949 PARAM, if present and non-nil, is passed to FUNCTION (to be handled
4950 in whatever way is appropriate; e.g. if FUNCTION is `yank-rectangle',
4951 PARAM may be a list of strings to insert as a rectangle). If PARAM
4952 is nil, then the current segment of STRING is used.
4953 If NOEXCLUDE is present and non-nil, the normal removal of
4954 `yank-excluded-properties' is not performed; instead FUNCTION is
4955 responsible for the removal. This may be necessary if FUNCTION
4956 adjusts point before or after inserting the object.
4957 UNDO, if present and non-nil, should be a function to be called
4958 by `yank-pop' to undo the insertion of the current PARAM. It is
4959 given two arguments, the start and end of the region. FUNCTION
4960 may set `yank-undo-function' to override UNDO.
4965 ;; If we don't get all the way thru, make last-command indicate that
4966 ;; for the following command.
4974 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4975 ;; It is cleaner to avoid activation, even though the command
4976 ;; loop would deactivate the mark because we inserted text.
4979 ;; If we do get all the way thru, make this-command indicate that.
4982 nil)
4985 "Rotate the yanking point in the kill ring.
4986 With ARG, rotate that many kills forward (or backward, if negative)."
4989 \f
4990 ;; Some kill commands.
4992 ;; Internal subroutine of delete-char
4998 ;; Internal subroutine of backward-delete-char
5005 "The method for untabifying when deleting backward.
5006 Can be `untabify' -- turn a tab to many spaces, then delete one space;
5007 `hungry' -- delete all whitespace, both tabs and spaces;
5008 `all' -- delete all whitespace, including tabs, spaces and newlines;
5009 nil -- just delete one character."
5015 "Delete characters backward, changing tabs into spaces.
5016 The exact behavior depends on `backward-delete-char-untabify-method'.
5017 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
5018 Interactively, ARG is the prefix arg (default 1)
5019 and KILLP is t if a prefix arg was specified."
5042 arg)))
5043 ;; Avoid warning about delete-backward-char
5047 "Kill up to and including ARGth occurrence of CHAR.
5048 Case is ignored if `case-fold-search' is non-nil in the current buffer.
5049 Goes backward if ARG is negative; error if CHAR not found."
5052 ;; Avoid "obsolete" warnings for translation-table-for-input.
5060 ;; kill-line and its subroutines.
5063 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
5068 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
5069 With prefix argument ARG, kill that many lines from point.
5070 Negative arguments kill lines backward.
5071 With zero argument, kills the text before point on the current line.
5074 a number counts as a prefix arg.
5076 To kill a whole line, when point is not at the beginning, type \
5079 If `show-trailing-whitespace' is non-nil, this command will just
5080 kill the rest of the current line, even if there are no nonblanks
5081 there.
5083 If option `kill-whole-line' is non-nil, then this command kills the whole line
5084 including its terminating newline, when used at the beginning of a line
5085 with no argument. As a consequence, you can always kill a whole line
5088 If you want to append the killed line to the last killed text,
5091 If the buffer is read-only, Emacs will beep and refrain from deleting
5092 the line, but put the line in the kill ring anyway. This means that
5093 you can use this command to copy text from a read-only buffer.
5094 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5095 even beep.)"
5098 ;; It is better to move point to the other end of the kill
5099 ;; before killing. That way, in a read-only buffer, point
5100 ;; moves across the text that is copied to the kill ring.
5101 ;; The choice has no effect on undo now that undo records
5102 ;; the value of point from before the command was run.
5112 ;; If trailing whitespace is visible,
5113 ;; don't treat it as nothing.
5123 "Kill current line.
5124 With prefix ARG, kill that many lines starting from the current line.
5125 If ARG is negative, kill backward. Also kill the preceding newline.
5127 If ARG is zero, kill current line but exclude the trailing newline."
5138 ;; We need to kill in two steps, because the previous command
5139 ;; could have been a kill command, in which case the text
5140 ;; before point needs to be prepended to the current kill
5141 ;; ring entry and the text after point appended. Also, we
5142 ;; need to use save-excursion to avoid copying the same text
5143 ;; twice to the kill ring in read-only buffers.
5161 "Move forward by ARG lines, ignoring currently invisible newlines only.
5162 If ARG is negative, move backward -ARG lines.
5163 If ARG is zero, move to the beginning of the current line."
5170 ;; If the newline we just skipped is invisible,
5171 ;; don't count it.
5175 prop
5180 ;; If invisible text follows, and it is a number of complete lines,
5181 ;; skip it.
5187 prop
5203 ;; If the newline we just moved to is invisible,
5204 ;; don't count it.
5209 prop
5214 ;; If invisible text follows, and it is a number of complete lines,
5215 ;; skip it.
5221 prop
5232 nil)))
5235 "Move to end of current visible line."
5237 ;; If the following character is currently invisible,
5238 ;; skip all characters with that same `invisible' property value,
5239 ;; then find the next newline.
5246 prop
5257 "Kill the current buffer.
5258 When called in the minibuffer, get out of the minibuffer
5259 using `abort-recursive-edit'.
5261 This is like `kill-this-buffer', but it doesn't have to be invoked
5262 via the menu bar, and pays no attention to the menu-bar's frame."
5270 \f
5272 "Insert after point the contents of BUFFER.
5273 Puts mark after the inserted text.
5274 BUFFER may be a buffer or a buffer name."
5284 t))))
5289 nil)
5292 "Append to specified buffer the text of the region.
5293 It is inserted into that buffer before its point.
5295 When calling from a program, give three arguments:
5296 BUFFER (or buffer name), START and END.
5297 START and END specify the portion of the current buffer to be copied."
5304 point)
5315 "Prepend to specified buffer the text of the region.
5316 It is inserted into that buffer after its point.
5318 When calling from a program, give three arguments:
5319 BUFFER (or buffer name), START and END.
5320 START and END specify the portion of the current buffer to be copied."
5329 "Copy to specified buffer the text of the region.
5330 It is inserted into that buffer, replacing existing text there.
5332 When calling from a program, give three arguments:
5333 BUFFER (or buffer name), START and END.
5334 START and END specify the portion of the current buffer to be copied."
5342 \f
5346 "Hook run when the mark becomes active.
5347 It is also run at the end of a command, if the mark is active and
5354 "Return this buffer's mark value as integer, or nil if never set.
5356 In Transient Mark mode, this function signals an error if
5357 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5358 or the argument FORCE is non-nil, it disregards whether the mark
5359 is active, and returns an integer or nil in the usual way.
5361 If you are using this in an editing command, you are most likely making
5362 a mistake; see the documentation of `set-mark'."
5367 ;; Behind display-selections-p.
5370 "Deactivate the mark.
5371 If Transient Mark mode is disabled, this function normally does
5372 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5374 Deactivating the mark sets `mark-active' to nil, updates the
5375 primary selection according to `select-active-regions', and runs
5376 `deactivate-mark-hook'.
5378 If Transient Mark mode was temporarily enabled, reset the value
5379 of the variable `transient-mark-mode'; if this causes Transient
5380 Mark mode to be disabled, don't change `mark-active' to nil or
5381 run `deactivate-mark-hook'."
5385 select-active-regions)
5388 ;; The var `saved-region-selection', if non-nil, is the text in
5389 ;; the region prior to the last command modifying the buffer.
5390 ;; Set the selection to that, or to the current region.
5395 ;; If another program has acquired the selection, region
5396 ;; deactivation should not clobber it (Bug#11772).
5415 "Activate the mark.
5416 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5426 "Set this buffer's mark to POS. Don't use this function!
5427 That is to say, don't use this function unless you want
5428 the user to see that the mark has moved, and you want the previous
5429 mark position to be lost.
5431 Normally, when a new mark is set, the old one should go on the stack.
5432 This is why most applications should use `push-mark', not `set-mark'.
5434 Novice Emacs Lisp programmers often try to use the mark for the wrong
5435 purposes. The mark saves a location for the user's convenience.
5436 Most editing commands should not alter the mark.
5437 To remember a location for internal use in the Lisp program,
5438 store it in a Lisp variable. Example:
5440 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5445 ;; Normally we never clear mark-active except in Transient Mark mode.
5446 ;; But when we actually clear out the mark value too, we must
5447 ;; clear mark-active in any mode.
5449 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5450 ;; it should never be nil if the mark is nil.
5458 mark-active))
5465 ;; Mark marker
5471 ;; Mark active
5474 ;; If mark is active now, and either was not active or was at a
5475 ;; different place, run the activate hook.
5480 ;; If mark has ceased to be active, run deactivate hook.
5485 "Like `save-excursion', but also save and restore the mark state.
5486 This macro does what `save-excursion' did before Emacs 25.1."
5496 If nil, region-aware commands treat the empty region as inactive.
5497 If non-nil, region-aware commands treat the region as active as
5498 long as the mark is active, even if the region is empty.
5500 Region-aware commands are those that act on the region if it is
5501 active and Transient Mark mode is enabled, and on the text near
5502 point otherwise."
5508 "Return t if the region is active and it is appropriate to act on it.
5509 This is used by commands that act specially on the region under
5510 Transient Mark mode.
5512 The return value is t if Transient Mark mode is enabled and the
5513 mark is active; furthermore, if `use-empty-active-region' is nil,
5514 the region must not be empty. Otherwise, the return value is nil.
5516 For some commands, it may be appropriate to ignore the value of
5517 `use-empty-active-region'; in that case, use `region-active-p'."
5522 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5524 Some commands act specially on the region when Transient Mark
5525 mode is enabled. Usually, such commands should use
5526 `use-region-p' instead of this function, because `use-region-p'
5527 also checks the value of `use-empty-active-region'."
5529 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5530 ;; without the mark being set (e.g. bug#17324). We really should fix
5531 ;; that problem, but in the mean time, let's make sure we don't say the
5532 ;; region is active when there's no mark.
5536 "Return the boundaries of the region as a pair of positions.
5537 Value is a list of cons cells of the form (START . END)."
5541 "Return non-nil if the region contains several pieces.
5542 An example is a rectangular region handled as a list of
5543 separate contiguous regions for each line."
5556 ;; Normal priority so that a large region doesn't hide all the
5557 ;; overlays within it, but high secondary priority so that if it
5558 ;; ends/starts in the middle of a small overlay, that small overlay
5559 ;; won't hide the region's boundaries.
5561 nrol)
5566 rol)))
5582 start end window rol)))
5585 new))))))
5588 "Hook run just before redisplay.
5589 It is called in each window that is to be redisplayed. It takes one argument,
5590 which is the window that will be redisplayed. When run, the `current-buffer'
5611 "Maximum size of mark ring. Start discarding off end if gets this big."
5619 "Maximum size of global mark ring. \
5620 Start discarding off end if gets this big."
5625 "Jump to mark, and pop a new position for mark off the ring.
5626 \(Does not affect global mark ring)."
5636 "Set mark at where point is.
5637 If no prefix ARG and mark is already set there, just activate it.
5638 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5650 will pop the mark twice, and
5652 will pop the mark three times.
5660 "Set the mark where point is, and activate it; or jump to the mark.
5661 Setting the mark also alters the region, which is the text
5662 between point and mark; this is the closest equivalent in
5665 With no prefix argument, set the mark at point, and push the
5666 old mark position on local mark ring. Also push the new mark on
5667 global mark ring, if the previous mark was set in another buffer.
5669 When Transient Mark Mode is off, immediately repeating this
5670 command activates `transient-mark-mode' temporarily.
5673 jump to the mark, and set the mark from
5674 position popped off the local mark ring (this does not affect the global
5676 mark ring (see `pop-global-mark').
5678 If `set-mark-command-repeat-pop' is non-nil, repeating
5680 off the local (or global) mark ring and jumps there.
5683 argument, unconditionally set mark where point is, even if
5684 `set-mark-command-repeat-pop' is non-nil.
5686 Novice Emacs Lisp programmers often try to use the mark for the wrong
5687 purposes. See the documentation of `set-mark' for more information."
5707 arg)
5721 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5722 If the last global mark pushed was not in the current buffer,
5723 also push LOCATION on the global mark ring.
5724 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5726 Novice Emacs Lisp programmers often try to use the mark for the wrong
5727 purposes. See the documentation of `set-mark' for more information.
5729 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5736 ;; Now push the mark on the global mark ring.
5739 ;; The last global mark pushed was in this same buffer.
5740 ;; Don't push another one.
5741 nil
5750 nil)
5753 "Pop off mark ring into the buffer's actual mark.
5754 Does not set point. Does nothing if mark ring is empty."
5766 "Put the mark where point is now, and point where the mark is now.
5767 This command works even when the mark is not active,
5768 and it reactivates the mark.
5770 If Transient Mark mode is on, a prefix ARG deactivates the mark
5771 if it is active, and otherwise avoids reactivating it. If
5772 Transient Mark mode is off, a prefix ARG enables Transient Mark
5773 mode temporarily."
5787 nil))
5790 "When non-nil, shifted motion keys activate the mark momentarily.
5792 While the mark is activated in this way, any shift-translated point
5793 motion key extends the region, and if Transient Mark mode was off, it
5794 is temporarily turned on. Furthermore, the mark will be deactivated
5795 by any subsequent point motion key that was not shift-translated, or
5796 by any action that normally deactivates the mark in Transient Mark mode.
5798 See `this-command-keys-shift-translated' for the meaning of
5799 shift-translation."
5804 "Activate/deactivate mark depending on invocation thru shift translation.
5805 This function is called by `call-interactively' when a command
5806 with a `^' character in its `interactive' spec is invoked, before
5807 running the command itself.
5809 If `shift-select-mode' is enabled and the command was invoked
5810 through shift translation, set the mark and activate the region
5811 temporarily, unless it was already set in this way. See
5812 `this-command-keys-shift-translated' for the meaning of shift
5813 translation.
5815 Otherwise, if the region has been activated temporarily,
5816 deactivate it, and restore the variable `transient-mark-mode' to
5817 its earlier value."
5824 transient-mark-mode)))
5833 "Toggle Transient Mark mode.
5834 With a prefix argument ARG, enable Transient Mark mode if ARG is
5835 positive, and disable it otherwise. If called from Lisp, enable
5836 Transient Mark mode if ARG is omitted or nil.
5838 Transient Mark mode is a global minor mode. When enabled, the
5839 region is highlighted with the `region' face whenever the mark
5841 and after certain other operations that set the mark but whose
5842 main purpose is something else--for example, incremental search,
5848 Many commands change their behavior when Transient Mark mode is
5849 in effect and the mark is active, by acting on the region instead
5850 of their usual default part of the buffer's text. Examples of
5853 To see the documentation of commands which are sensitive to the
5856 :global t
5857 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5861 "Non-nil means it is ok for commands to call `widen' when they want to.
5862 Some commands will do this in order to go to positions outside
5863 the current accessible part of the buffer.
5865 If `widen-automatically' is nil, these commands will do something else
5869 "Whether the currently executing code is performing an essential task.
5870 This variable should be non-nil only when running code which should not
5871 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5872 user for a password when we are simply scanning a set of files in the
5873 background or displaying possible completions before the user even asked
5877 "Pop off global mark ring and jump to the top location."
5879 ;; Pop entries which refer to non-existent buffers.
5897 \f
5899 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5905 "Move cursor vertically down ARG lines.
5906 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5907 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5908 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5909 function will not vscroll.
5911 ARG defaults to 1.
5913 If there is no character in the target line exactly under the current column,
5914 the cursor is positioned after the character in that line which spans this
5915 column, or at the end of the line if it is not long enough.
5916 If there is no line in the buffer after this one, behavior depends on the
5917 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5918 to create a line, and moves the cursor to that line. Otherwise it moves the
5919 cursor to the end of the buffer.
5921 If the variable `line-move-visual' is non-nil, this command moves
5922 by display lines. Otherwise, it moves by buffer lines, without
5923 taking variable-width characters or continued lines into account.
5927 a semipermanent goal column for this command.
5928 Then instead of trying to move exactly vertically (or as close as possible),
5929 this command moves to the specified goal column (or as close as possible).
5930 The goal column is stored in the variable `goal-column', which is nil
5931 when there is no goal column. Note that setting `goal-column'
5932 overrides `line-move-visual' and causes this command to move by buffer
5933 lines rather than by display lines."
5939 ;; When adding a newline, don't expand an abbrev.
5950 nil)
5953 "Move cursor vertically up ARG lines.
5954 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5955 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5956 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5957 function will not vscroll.
5959 ARG defaults to 1.
5961 If there is no character in the target line exactly over the current column,
5962 the cursor is positioned after the character in that line which spans this
5963 column, or at the end of the line if it is not long enough.
5965 If the variable `line-move-visual' is non-nil, this command moves
5966 by display lines. Otherwise, it moves by buffer lines, without
5967 taking variable-width characters or continued lines into account.
5971 a semipermanent goal column for this command.
5972 Then instead of trying to move exactly vertically (or as close as possible),
5973 this command moves to the specified goal column (or as close as possible).
5974 The goal column is stored in the variable `goal-column', which is nil
5975 when there is no goal column. Note that setting `goal-column'
5976 overrides `line-move-visual' and causes this command to move by buffer
5977 lines rather than by display lines."
5988 nil)
5991 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5992 This means moving to the end of each line moved onto.
5993 The beginning of a blank line does not count as the end of a line.
5994 This has no effect when the variable `line-move-visual' is non-nil."
6000 A non-nil setting overrides the variable `line-move-visual', which see."
6007 "Current goal column for vertical motion.
6008 It is the column where point was at the start of the current run
6009 of vertical motion commands.
6011 When moving by visual lines via the function `line-move-visual', it is a cons
6012 cell (COL . HSCROLL), where COL is the x-position, in pixels,
6013 divided by the default column width, and HSCROLL is the number of
6014 columns by which window is scrolled from left margin.
6016 When the `track-eol' feature is doing its job, the value is
6020 "Last value of width used for displaying line numbers.
6024 "Non-nil means commands that move by lines ignore invisible newlines.
6025 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
6026 as if newlines that are invisible didn't exist, and count
6027 only visible newlines. Thus, moving across 2 newlines
6028 one of which is invisible will be counted as a one-line move.
6029 Also, a non-nil value causes invisible text to be ignored when
6030 counting columns for the purposes of keeping point in the same
6033 Outline mode sets this."
6038 "When non-nil, `line-move' moves point by visual lines.
6039 This movement is based on where the cursor is displayed on the
6040 screen, instead of relying on buffer contents alone. It takes
6041 into account variable-width characters and line continuation.
6042 If nil, `line-move' moves point by logical lines.
6043 A non-nil setting of `goal-column' overrides the value of this variable
6044 and forces movement by logical lines.
6045 A window that is horizontally scrolled also forces movement by logical
6046 lines."
6051 ;; Only used if display-graphic-p.
6055 "Return the height in pixels of the current buffer's default face font.
6057 If the default font is remapped (see `face-remapping-alist'), the
6058 function returns the height of the remapped face."
6062 ;; Avoid calling font-info if the frame's default font was
6063 ;; not changed since the frame was created. That's because
6064 ;; font-info is expensive for some fonts, see bug #14838.
6070 "Return the width in pixels of the current buffer's default face font.
6072 If the default font is remapped (see `face-remapping-alist'), the
6073 function returns the width of the remapped face."
6077 ;; Avoid calling font-info if the frame's default font was
6078 ;; not changed since the frame was created. That's because
6079 ;; font-info is expensive for some fonts, see bug #14838.
6084 width
6089 "Return the pixel height of current buffer's default-face text line.
6091 The value includes `line-spacing', if any, defined for the buffer
6092 or the frame."
6105 "Return the number of screen lines in the text area of the selected window.
6107 This is different from `window-text-height' in that this function counts
6108 lines in units of the height of the font used by the default face displayed
6109 in the window, not in units of the frame's default font, and also accounts
6110 for `line-spacing', if any, defined for the window's buffer or frame.
6112 The value is a floating-point number."
6117 ;; Returns non-nil if partial move was done.
6120 ;; Move backward (up).
6121 ;; If already vscrolled, reduce vscroll
6127 ;; Move forward (down).
6140 py vs last-line)
6160 col-row)
6165 ;; VPOS > 0 means the last line is only partially visible.
6166 ;; But if the part that is visible is at least as tall as the
6167 ;; default font, that means the line is actually fully
6168 ;; readable, and something like line-spacing is hidden. So in
6169 ;; that case we accept the last line in the window as still
6170 ;; visible, and consider the margin as starting one line
6171 ;; later.
6179 ;; If last line of window is fully visible, and vscrolling
6180 ;; more would make this line invisible, move forward.
6185 nil)
6186 ;; If cursor is not in the bottom scroll margin, and the
6187 ;; current line is not too tall, move forward.
6189 vpos
6192 nil)
6193 ;; When already vscrolled, we vscroll some more if we can,
6194 ;; or clear vscroll and move forward at end of tall image.
6199 ;; If cursor just entered the bottom scroll margin, move forward,
6200 ;; but also optionally vscroll one line so redisplay won't recenter.
6204 ;; Don't vscroll if the partially-visible line at window
6205 ;; bottom is not too tall (a.k.a. "just one more text
6206 ;; line"): in that case, we do want redisplay to behave
6207 ;; normally, i.e. recenter or whatever.
6208 ;;
6209 ;; Note: ROWH + RBOT from the value returned by
6210 ;; pos-visible-in-window-p give the total height of the
6211 ;; partially-visible glyph row at the end of the window. As
6212 ;; we are dealing with floats, we disregard sub-pixel
6213 ;; discrepancies between that and DLH.
6217 t)
6218 ;; If there are lines above the last line, scroll-up one line.
6221 t)
6222 ;; Finally, start vscroll.
6227 ;; This is like line-move-1 except that it also performs
6228 ;; vertical scrolling of tall images if appropriate.
6229 ;; That is not really a clean thing to do, since it mixes
6230 ;; scrolling with cursor motion. But so far we don't have
6231 ;; a cleaner solution to the problem of making C-n do something
6232 ;; useful given a tall image.
6234 "Move forward ARG lines.
6235 If NOERROR, don't signal an error if we can't move ARG lines.
6236 TO-END is unused.
6237 TRY-VSCROLL controls whether to vscroll tall lines: if either
6238 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6239 not vscroll."
6243 ;; Only vscroll for single line moves
6245 ;; Under scroll-conservatively, the display engine
6246 ;; does this better.
6248 ;; But don't vscroll in a keyboard macro.
6254 ;; Display-based column are incompatible with goal-column.
6256 ;; When the text in the window is scrolled to the left,
6257 ;; display-based motion doesn't make sense (because each
6258 ;; logical line occupies exactly one screen line).
6260 ;; Likewise when the text _was_ scrolled to the left
6261 ;; when the current run of vertical motion commands
6262 ;; started.
6265 auto-hscroll-mode
6267 (>= temporary-goal-column
6270 ;; If we moved into a tall line, set vscroll to make
6271 ;; scrolling through tall images more smooth.
6275 winh)
6281 nil
6285 ;; Display-based alternative to line-move-1.
6286 ;; Arg says how many lines to move. The value is t if we can move the
6287 ;; specified number of lines.
6289 "Move ARG lines forward.
6290 If NOERROR, don't signal an error if we can't move that many lines."
6294 target-hscroll)
6295 ;; Check if the previous command was a line-motion command, or if
6296 ;; we were called from some other command.
6299 ;; If so, there's no need to reset `temporary-goal-column',
6300 ;; but we may need to hscroll.
6305 ;; Update the COLUMN part of temporary-goal-column if the
6306 ;; line-number display changed its width since the last
6307 ;; time.
6314 ;; Otherwise, we should reset `temporary-goal-column'.
6316 x-pos)
6318 ;; Handle the `overflow-newline-into-fringe' case
6319 ;; (left-fringe is for the R2L case):
6324 ;; In R2L lines, the X pixel coordinate is measured from the
6325 ;; left edge of the window, but columns are still counted
6326 ;; from the logical-order beginning of the line, i.e. from
6327 ;; the right edge in this case. We need to adjust for that.
6333 hscroll)))
6335 ;; When we move beyond the first/last character visible in
6336 ;; the window, posn-at-point will return nil, so we need to
6337 ;; approximate the goal column as below.
6342 ;; vertical-motion can move more than it was asked to if it moves
6343 ;; across display strings with newlines. We don't want to ring
6344 ;; the bell and announce beginning/end of buffer in that case.
6350 temporary-goal-column))
6351 arg))
6352 arg))
6358 temporary-goal-column))
6359 arg))
6360 arg)))
6363 ;; If the goal column lies on a display string,
6364 ;; `vertical-motion' advances the cursor to the end
6365 ;; of the string. For arg < 0, this can cause the
6366 ;; cursor to get stuck. (Bug#3020).
6370 nil)))))
6372 ;; This is the guts of next-line and previous-line.
6373 ;; Arg says how many lines to move.
6374 ;; The value is t if we can move the specified number of lines.
6376 ;; Don't run any point-motion hooks, and disregard intangibility,
6377 ;; for intermediate positions.
6389 ;; Don't count beg of empty line as end of line
6390 ;; unless we just did explicit end-of-line.
6392 most-positive-fixnum
6396 line-move-ignore-invisible))
6397 ;; Use just newline characters.
6398 ;; Set ARG to 0 if we move as many lines as requested.
6401 ;; This way of moving forward ARG lines
6402 ;; verifies that we have a newline after the last one.
6403 ;; It doesn't get confused by intangible text.
6412 'beginning-of-buffer
6414 nil)))
6415 ;; Move by arg lines, but ignore invisible ones.
6418 ;; If the following character is currently invisible,
6419 ;; skip all characters with that same `invisible' property value.
6422 ;; Move a line.
6423 ;; We don't use `end-of-line', since we want to escape
6424 ;; from field boundaries occurring exactly at point.
6430 ;; If there's no invisibility here, move over the newline.
6439 ;; We avoid vertical-motion when possible
6440 ;; because that has to fontify.
6442 ;; Otherwise move a more sophisticated way.
6449 ;; The logic of this is the same as the loop above,
6450 ;; it just goes in the other direction.
6452 ;; For completely consistency with the forward-motion
6453 ;; case, we should call beginning-of-line here.
6454 ;; However, if point is inside a field and on a
6455 ;; continued line, the call to (vertical-motion -1)
6456 ;; below won't move us back far enough; then we return
6457 ;; to the same column in line-move-finish, and point
6458 ;; gets stuck -- cyd
6476 ;; if our target is the middle of this line.
6481 ;; This is the value the function returns.
6485 ;; If we did not move down as far as desired, at least go
6486 ;; to end of line. Be sure to call point-entered and
6487 ;; point-left-hooks.
6493 ;; If we did not move up as far as desired,
6494 ;; at least go to beginning of line.
6506 ;; Set REPEAT to t to repeat the whole thing.
6513 ;; Compute the end of the line
6514 ;; ignoring effectively invisible newlines.
6516 ;; Like end-of-line but ignores fields.
6523 ;; Move to the desired column.
6526 ;; Under line-move-visual, goal-column should be
6527 ;; interpreted in units of the frame's canonical character
6528 ;; width, which is exactly what vertical-motion does.
6532 ;; Corner case: suppose we start out in a field boundary in
6533 ;; the middle of a continued line. When we get to
6534 ;; line-move-finish, point is at the start of a new *screen*
6535 ;; line but the same text line; then line-move-to-column would
6536 ;; move us backwards. Test using C-n with point on the "x" in
6537 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6544 ;; Process intangibility within a line.
6545 ;; With inhibit-point-motion-hooks bound to nil, a call to
6546 ;; goto-char moves point past intangible text.
6548 ;; However, inhibit-point-motion-hooks controls both the
6549 ;; intangibility and the point-entered/point-left hooks. The
6550 ;; following hack avoids calling the point-* hooks
6551 ;; unnecessarily. Note that we move *forward* past intangible
6552 ;; text when the initial and final points are the same.
6557 ;; If intangibility moves us to a different (later) place
6558 ;; in the same line, use that as the destination.
6561 ;; If that position is "too late",
6562 ;; try the previous allowable position.
6563 ;; See if it is ok.
6566 ;; If going forward, don't accept the previous
6567 ;; allowable position if it is before the target line.
6569 ;; If going backward, don't accept the previous
6570 ;; allowable position if it is still after the target line.
6573 ;; As a last resort, use the end of the line.
6576 ;; Now move to the updated destination, processing fields
6577 ;; as well as intangibility.
6581 ;; Ignore field boundaries if the initial and final
6582 ;; positions have the same `field' property, even if the
6583 ;; fields are non-contiguous. This seems to be "nicer"
6584 ;; behavior in many situations.
6587 new
6591 ;; If all this moved us to a different line,
6592 ;; retry everything within that new line.
6594 ;; Repeat the intangibility and field processing.
6598 "Try to find column COL, considering invisibility.
6599 This function works only in certain cases,
6600 because what we really need is for `move-to-column'
6601 and `current-column' to be able to ignore invisible text."
6610 ;; If the following character is currently invisible,
6611 ;; skip all characters with that same `invisible' property value.
6615 ;; Have we advanced to a larger column position?
6617 ;; We have made some progress towards the desired column.
6618 ;; See if we can make any further progress.
6620 ;; Otherwise, go to the place we originally found
6621 ;; and move back over invisible text.
6622 ;; that will get us to the same place on the screen
6623 ;; but with a more reasonable buffer position.
6626 ;; We want the real line beginning, so it's consistent
6627 ;; with bolp below, otherwise we might infloop.
6634 "Move point to end of current line as displayed.
6635 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6636 If point reaches the beginning or end of buffer, it stops there.
6638 To ignore the effects of the `intangible' text or overlay
6639 property, bind `inhibit-point-motion-hooks' to t.
6640 If there is an image in the current line, this function
6641 disregards newlines that are part of the text on which the image
6642 rests."
6652 ;; With bidi reordering, we may not be at bol,
6653 ;; so make sure we are.
6668 ;; If we skipped something intangible and now we're not
6669 ;; really at eol, keep going.
6674 "Move point to beginning of current line as displayed.
6675 \(If there's an image in the line, this disregards newlines
6676 which are part of the text that the image rests on.)
6678 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6679 If point reaches the beginning or end of buffer, it stops there.
6680 \(But if the buffer doesn't end in a newline, it stops at the
6681 beginning of the last line.)
6682 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6687 first-vis first-vis-field-value)
6689 ;; Move by lines, if ARG is not 1 (the default).
6694 ;; Move to beginning-of-line, ignoring fields and invisible text.
6700 ;; Now find first visible char in the line.
6705 ;; See if fields would stop us from reaching FIRST-VIS.
6710 ;; If yes, obey them.
6711 first-vis-field-value
6712 ;; Otherwise, move to START with attention to fields.
6713 ;; (It is possible that fields never matter in this case.)
6718 ;; Many people have said they rarely use this feature, and often type
6719 ;; it by accident. Maybe it shouldn't even be on a key.
6724 Those commands will move to this position in the line moved to
6725 rather than trying to keep the same horizontal position.
6726 With a non-nil argument ARG, clears out the goal column
6728 The goal column is stored in the variable `goal-column'.
6729 This is a buffer-local setting."
6736 ;; The older method below can be erroneous if `set-goal-column' is bound
6737 ;; to a sequence containing %
6738 ;;(message (substitute-command-keys
6739 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6740 ;;goal-column)
6747 )
6748 nil)
6749 \f
6750 ;;; Editing based on visual lines, as opposed to logical lines.
6753 "Move point to end of current visual line.
6754 With argument N not nil or 1, move forward N - 1 visual lines first.
6755 If point reaches the beginning or end of buffer, it stops there.
6756 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6762 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6763 ;; constrain to field boundaries, so we don't either.
6767 "Move point to beginning of current visual line.
6768 With argument N not nil or 1, move forward N - 1 visual lines first.
6769 If point reaches the beginning or end of buffer, it stops there.
6770 \(But if the buffer doesn't end in a newline, it stops at the
6771 beginning of the last visual line.)
6772 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6780 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6784 "Kill the rest of the visual line.
6785 With prefix argument ARG, kill that many visual lines from point.
6786 If ARG is negative, kill visual lines backward.
6787 If ARG is zero, kill the text before point on the current visual
6788 line.
6790 If you want to append the killed line to the last killed text,
6793 If the buffer is read-only, Emacs will beep and refrain from deleting
6794 the line, but put the line in the kill ring anyway. This means that
6795 you can use this command to copy text from a read-only buffer.
6796 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6797 even beep.)"
6799 ;; Like in `kill-line', it's better to move point to the other end
6800 ;; of the kill before killing.
6808 ;; Skip any trailing whitespace at the end of the visual line.
6809 ;; We used to do this only if `show-trailing-whitespace' is
6810 ;; nil, but that's wrong; the correct thing would be to check
6811 ;; whether the trailing whitespace is highlighted. But, it's
6812 ;; OK to just do this unconditionally.
6819 "Move cursor vertically down ARG lines.
6820 This is identical to `next-line', except that it always moves
6821 by logical lines instead of visual lines, ignoring the value of
6822 the variable `line-move-visual'."
6829 "Move cursor vertically up ARG lines.
6830 This is identical to `previous-line', except that it always moves
6831 by logical lines instead of visual lines, ignoring the value of
6832 the variable `line-move-visual'."
6839 "Editing based on visual lines."
6848 ;; These keybindings interfere with xterm function keys. Are
6849 ;; there any other suitable bindings?
6850 ;; (define-key map "\M-[" 'previous-logical-line)
6851 ;; (define-key map "\M-]" 'next-logical-line)
6852 map))
6855 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6856 The value should be a list of the form (LEFT RIGHT), where LEFT
6857 and RIGHT are symbols representing the bitmaps to display, to
6858 indicate wrapped lines, in the left and right fringes respectively.
6859 See also `fringe-indicator-alist'.
6860 The default is not to display fringe indicators for wrapped lines.
6861 This variable does not affect fringe indicators displayed for
6862 other purposes."
6877 'continuation
6884 "Toggle visual line based editing (Visual Line mode) in the current buffer.
6885 Interactively, with a prefix argument, enable
6886 Visual Line mode if the prefix argument is positive,
6887 and disable it otherwise. If called from Lisp, toggle
6888 the mode if ARG is `toggle', disable the mode if ARG is
6889 a non-positive integer, and enable the mode otherwise
6890 \(including if ARG is omitted or nil or a positive integer).
6892 When Visual Line mode is enabled, `word-wrap' is turned on in
6893 this buffer, and simple editing commands are redefined to act on
6894 visual lines, not logical lines. See Info node `Visual Line
6895 Mode' for details."
6896 :keymap visual-line-mode-map
6902 ;; Save the local values of some variables, to be restored if
6903 ;; visual-line-mode is turned off.
6905 truncate-partial-width-windows
6906 word-wrap fringe-indicator-alist))
6909 visual-line--saved-state)))
6913 word-wrap t
6914 fringe-indicator-alist
6916 fringe-indicator-alist)))
6930 visual-line-mode turn-on-visual-line-mode)
6932 \f
6934 "Interchange characters around point, moving forward one character.
6935 With prefix arg ARG, effect is to take character before point
6936 and drag it forward past ARG other characters (backward if ARG negative).
6937 If no argument and at end of line, the previous two chars are exchanged."
6945 "Interchange words around point, leaving point at end of them.
6946 With prefix arg ARG, effect is to take word before or around point
6947 and drag it forward past ARG other words (backward if ARG negative).
6948 If ARG is zero, the words around or after point and around or after mark
6949 are interchanged."
6950 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6956 Unlike `transpose-words', point must be between the two sexps and not
6957 in the middle of a sexp to be transposed.
6958 With non-zero prefix arg ARG, effect is to take the sexp before point
6959 and drag it forward past ARG other sexps (backward if ARG is negative).
6960 If ARG is zero, the sexps ending at or after point and at or after mark
6961 are interchanged."
6965 ;; Here we should try to simulate the behavior of
6966 ;; (cons (progn (forward-sexp x) (point))
6967 ;; (progn (forward-sexp (- x)) (point)))
6968 ;; Except that we don't want to rely on the second forward-sexp
6969 ;; putting us back to where we want to be, since forward-sexp-function
6970 ;; might do funny things like infix-precedence.
6975 ;; Jumping over a symbol. We might be inside it, mind you.
6980 ;; Otherwise, we're between sexps. Take a step back before jumping
6981 ;; to make sure we'll obey the same precedence no matter which direction
6982 ;; we're going.
6987 'skip-syntax-forward
6994 "Exchange current line and previous line, leaving point after both.
6995 With argument ARG, takes previous line and moves it past ARG lines.
6996 With argument 0, interchanges line point is in with line mark is in."
7002 ;; Move forward over ARG lines,
7003 ;; but create newlines if necessary.
7010 arg))
7012 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
7013 ;; which seems inconsistent with the ARG /= 0 case.
7014 ;; FIXME document SPECIAL.
7016 "Subroutine to do the work of transposing objects.
7017 Works for lines, sentences, paragraphs, etc. MOVER is a function that
7018 moves forward by units of the given object (e.g. forward-sentence,
7019 forward-paragraph). If ARG is zero, exchanges the current object
7020 with the one containing mark. If ARG is an integer, moves the
7021 current object past ARG following (if ARG is positive) or
7022 preceding (if ARG is negative) objects, leaving point after the
7023 current object."
7028 pos1 pos2)
7057 ;; This sequence of insertions attempts to preserve marker
7058 ;; positions at the start and end of the transposed objects.
7072 \f
7074 "Move backward until encountering the beginning of a word.
7075 With argument ARG, do this that many times.
7076 If ARG is omitted or nil, move point backward one word.
7078 The word boundaries are normally determined by the buffer's syntax
7079 table, but `find-word-boundary-function-table', such as set up
7080 by `subword-mode', can change that. If a Lisp program needs to
7081 move by words determined strictly by the syntax table, it should
7082 use `backward-word-strictly' instead."
7087 "Set mark ARG words away from point.
7089 move to with the same argument.
7090 Interactively, if this command is repeated
7091 or (in Transient Mark mode) if the mark is active,
7092 it marks the next ARG words after the ones already marked."
7109 nil t))))
7112 "Kill characters forward until encountering the end of a word.
7113 With argument ARG, do this that many times."
7118 "Kill characters backward until encountering the beginning of a word.
7119 With argument ARG, do this that many times."
7124 "Return the word at or near point, as a string.
7125 The return value includes no text properties.
7127 If optional arg STRICT is non-nil, return nil unless point is
7128 within or adjacent to a word, otherwise look for a word within
7129 point's line. If there is no word anywhere on point's line, the
7130 value is nil regardless of STRICT.
7132 By default, this function treats as a single word any sequence of
7133 characters that have either word or symbol syntax. If optional
7134 arg REALLY-WORD is non-nil, only characters of word syntax can
7135 constitute a word."
7144 ;; Point is neither within nor adjacent to a word.
7146 ;; Look for preceding word in same line.
7149 ;; No preceding word in same line.
7150 ;; Look for following word in same line.
7159 ;; If we found something nonempty, return it as a string.
7162 \f
7164 "String for filling to insert at front of new line, or nil for none."
7166 string)
7172 "Regexp to match lines which should not be auto-filled."
7174 regexp)
7178 "The default value for `normal-auto-fill-function'.
7179 This is the default auto-fill function, some major modes use a different one.
7180 Returns t if it really did any work."
7190 nil ;; Auto-filling not required
7194 ;; Choose a fill-prefix automatically.
7202 ;; Use auto-indentation rather than a guessed empty prefix.
7208 ;; Determine where to split the line.
7212 ;; Don't split earlier in the line than the length of the
7213 ;; fill prefix, since the resulting line would be longer.
7221 ;; See whether the place we found is any good.
7225 ;; There is no use breaking at end of line.
7227 ;; Don't split right after a comment starter
7228 ;; since we would just make another comment starter.
7233 limit t)
7235 ;; No good place to break => stop trying.
7237 ;; Ok, we have a useful place to break the line. Do it.
7239 ;; If point is at the fill-point, do not `save-excursion'.
7240 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7241 ;; point will end up before it rather than after it.
7249 ;; Now do justification, if required
7254 ;; If making the new line didn't reduce the hpos of
7255 ;; the end of the line, then give up now;
7256 ;; trying again will not help.
7259 ;; Justify last line.
7261 t)))
7264 "Mode-specific function which line breaks and continues a comment.
7265 This function is called during auto-filling when a comment syntax
7266 is defined.
7267 The function should take a single optional argument, which is a flag
7271 "Break line at point and indent.
7272 If a comment syntax is defined, call `comment-indent-new-line'.
7274 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7275 unless optional argument SOFT is non-nil."
7279 ;; Insert the newline before removing empty space so that markers
7280 ;; get preserved better.
7286 ;; Blindly trust a non-adaptive fill-prefix.
7292 ;; If there's an adaptive prefix, use it unless we're inside
7293 ;; a comment and the prefix is not a comment starter.
7297 ;; If we're not inside a comment, just try to indent.
7301 "The function called by `self-insert-command' to perform auto-filling."
7308 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7312 ;; `functions' and `hooks' are usually unsafe to set, but setting
7313 ;; auto-fill-function to nil in a file-local setting is safe and
7314 ;; can be useful to prevent auto-filling.
7318 "Toggle automatic line breaking (Auto Fill mode).
7319 Interactively, with a prefix argument, enable
7320 Auto Fill mode if the prefix argument is positive,
7321 and disable it otherwise. If called from Lisp, toggle
7322 the mode if ARG is `toggle', disable the mode if ARG is
7323 a non-positive integer, and enable the mode otherwise
7324 \(including if ARG is omitted or nil or a positive integer).
7326 When Auto Fill mode is enabled, inserting a space at a column
7327 beyond `current-fill-column' automatically breaks the line at a
7328 previous space.
7330 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7331 non-nil.
7333 The value of `normal-auto-fill-function' specifies the function to use
7334 for `auto-fill-function' when turning Auto Fill mode on."
7339 ;; This holds a document string used to document auto-fill-mode.
7341 "Automatically break line at a previous space, in insertion of text."
7342 nil)
7345 "Unconditionally turn on Auto Fill mode."
7349 "Unconditionally turn off Auto Fill mode."
7355 "Set `fill-column' to specified argument.
7360 ;; We used to use current-column silently, but C-x f is too easily
7361 ;; typed as a typo for C-x C-f, so we turned it into an error and
7362 ;; now an interactive prompt.
7367 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7371 \f
7373 "Set `selective-display' to ARG; clear it if no arg.
7374 When the value of `selective-display' is a number > 0,
7375 lines whose indentation is >= that value are not displayed.
7376 The variable `selective-display' has a separate value for each buffer."
7396 "Toggle truncating of long lines for the current buffer.
7397 When truncating is off, long lines are folded.
7398 With prefix argument ARG, truncate long lines if ARG is positive,
7399 otherwise fold them. Note that in side-by-side windows, this
7400 command has no effect if `truncate-partial-width-windows' is
7401 non-nil."
7413 nil t)))
7418 "Toggle whether to use word-wrapping for continuation lines.
7419 With prefix argument ARG, wrap continuation lines at word boundaries
7420 if ARG is positive, otherwise wrap them at the right screen edge.
7421 This command toggles the value of `word-wrap'. It has no effect
7422 if long lines are truncated."
7438 "Toggle Overwrite mode.
7439 With a prefix argument ARG, enable Overwrite mode if ARG is
7440 positive, and disable it otherwise. If called from Lisp, enable
7441 the mode if ARG is omitted or nil.
7443 When Overwrite mode is enabled, printing characters typed in
7444 replace existing text on a one-for-one basis, rather than pushing
7445 it to the right. At the end of a line, such characters extend
7446 the line. Before a tab, such characters insert until the tab is
7448 overwrite mode; this is supposed to make it easier to insert
7449 characters when necessary."
7454 "Toggle Binary Overwrite mode.
7455 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7456 is positive, and disable it otherwise. If called from Lisp,
7457 enable the mode if ARG is omitted or nil.
7459 When Binary Overwrite mode is enabled, printing characters typed
7460 in replace existing text. Newlines are not treated specially, so
7461 typing at the end of a line joins the line to the next, with the
7462 typed character between them. Typing before a tab character
7463 simply replaces the tab with the character typed.
7465 ordinary typing characters do.
7467 Note that Binary Overwrite mode is not its own minor mode; it is
7468 a specialization of overwrite mode, entered by setting the
7469 `overwrite-mode' variable to `overwrite-mode-binary'."
7474 "Toggle line number display in the mode line (Line Number mode).
7475 With a prefix argument ARG, enable Line Number mode if ARG is
7476 positive, and disable it otherwise. If called from Lisp, enable
7477 the mode if ARG is omitted or nil.
7479 Line numbers do not appear for very large buffers and buffers
7480 with very long lines; see variables `line-number-display-limit'
7481 and `line-number-display-limit-width'."
7485 "Toggle column number display in the mode line (Column Number mode).
7486 With a prefix argument ARG, enable Column Number mode if ARG is
7487 positive, and disable it otherwise.
7489 If called from Lisp, enable the mode if ARG is omitted or nil."
7493 "Toggle buffer size display in the mode line (Size Indication mode).
7494 With a prefix argument ARG, enable Size Indication mode if ARG is
7495 positive, and disable it otherwise.
7497 If called from Lisp, enable the mode if ARG is omitted or nil."
7501 "Toggle auto-saving in the current buffer (Auto Save mode).
7502 With a prefix argument ARG, enable Auto Save mode if ARG is
7503 positive, and disable it otherwise.
7505 If called from Lisp, enable the mode if ARG is omitted or nil."
7507 ;; If auto-save is off because buffer has shrunk,
7508 ;; then toggling should turn it on.
7516 buffer-file-name)
7518 ;; If -1 was stored here, to temporarily turn off saving,
7519 ;; turn it back on.
7522 \f
7524 "Blinking matching of parens and expressions."
7529 "Non-nil means show matching open-paren when close-paren is inserted.
7530 If t, highlight the paren. If `jump', briefly move cursor to its
7531 position. If `jump-offscreen', move cursor there even if the
7532 position is off screen. With any other non-nil value, the
7533 off-screen position of the opening paren will be shown in the
7534 echo area."
7543 "Non-nil means show matching open-paren when it is on screen.
7544 If nil, don't show it (but the open-paren can still be shown
7545 in the echo area when it is off screen).
7547 This variable has no effect if `blink-matching-paren' is nil.
7548 \(In that case, the open-paren is never shown.)
7549 It is also ignored if `show-paren-mode' is enabled."
7554 "If non-nil, maximum distance to search backwards for matching open-paren.
7555 If nil, search stops at the beginning of the accessible portion of the buffer."
7561 "Time in seconds to delay after showing a matching paren."
7566 "If nil, `blink-matching-paren' ignores comments.
7567 More precisely, when looking for the matching parenthesis,
7568 it skips the contents of comments that end before point."
7573 "Return whether or not START...END are matching parens.
7574 END is the current point and START is the blink position.
7575 START might be nil if no matching starter was found.
7576 Returns non-nil if we find there is a mismatch."
7581 ;; For self-matched chars like " and $, we can't know when they're
7582 ;; mismatched or unmatched, so we can only do it for parens.
7587 ;; The cdr might hold a new paren-class info rather than
7588 ;; a matching-char info, in which case the two CDRs
7589 ;; should match.
7593 "Function to check parentheses mismatches.
7594 The function takes two arguments (START and END) where START is the
7595 position just before the opening token and END is the position right after.
7596 START can be nil, if it was not found.
7603 ol)
7607 "Momentarily highlight the beginning of the sexp before point."
7610 blink-matching-paren)
7620 oldpos))
7628 ;; backward-sexp skips backward over prefix chars,
7629 ;; so move back to the matching paren.
7652 ;; Matching open within window, temporarily move to or highlight
7653 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7654 ;; is non-nil.
7671 ;; Show what precedes the open in its line, if anything.
7676 ;; Show what follows the open in its line, if anything.
7683 ;; Otherwise show the previous nonblank line,
7684 ;; if there is one.
7693 ;; Replace the newline and other whitespace with `...'.
7694 "..."
7696 ;; There is nothing to show except the char itself.
7699 "Matches %s"
7703 "Function called, if non-nil, whenever a close parenthesis is inserted.
7709 blink-paren-function
7712 ;; Verify an even number of quoting characters precede the close.
7713 ;; FIXME: Also check if this parenthesis closes a comment as
7714 ;; can happen in Pascal and SML.
7725 ;; Most likely, this hook is nil, so this arg doesn't matter,
7726 ;; but I use it as a reminder that this function usually
7727 ;; likes to be run after others since it does
7728 ;; `sit-for'. That's also the reason it get a `priority' prop
7729 ;; of 100.
7731 \f
7732 ;; This executes C-g typed while Emacs is waiting for a command.
7733 ;; Quitting out of a program does not go through here;
7734 ;; that happens in the maybe_quit function at the C code level.
7736 "Signal a `quit' condition.
7737 During execution of Lisp code, this character causes a quit directly.
7738 At top-level, as an editor command, this simply beeps."
7740 ;; Avoid adding the region to the window selection.
7748 ;; Force the next redisplay cycle to remove the "Def" indicator from
7749 ;; all the mode lines.
7763 This command can exit an interactive command such as `query-replace',
7764 can clear out a prefix argument or a region,
7765 can get out of the minibuffer or other recursive edit,
7766 cancel the use of the current buffer (for special-purpose buffers),
7767 or go back to just one window (by deleting all but the selected window)."
7775 nil)
7786 "Play sound stored in FILE.
7787 VOLUME and DEVICE correspond to the keywords of the sound
7788 specification for `play-sound'."
7798 \f
7800 "Your preference for a mail reading package.
7801 This is used by some keybindings which support reading mail.
7802 See also `mail-user-agent' concerning sending mail."
7812 "Your preference for a mail composition package.
7813 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7814 outgoing email message. This variable lets you specify which
7815 mail-sending package you prefer.
7817 Valid values include:
7819 `message-user-agent' -- use the Message package.
7820 See Info node `(message)'.
7821 `sendmail-user-agent' -- use the Mail package.
7822 See Info node `(emacs)Sending Mail'.
7823 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7824 See Info node `(mh-e)'.
7825 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7826 paraphernalia if Gnus is running, particularly
7827 the Gcc: header for archiving.
7829 Additional valid symbols may be available; check with the author of
7830 your package for details. The function should return non-nil if it
7831 succeeds.
7833 See also `read-mail-command' concerning reading mail."
7836 message-user-agent)
7839 sendmail-user-agent)
7842 mh-e-user-agent)
7845 gnus-user-agent)
7851 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7852 If the value of `mail-user-agent' is the default, and the user
7853 appears to have customizations applying to the old default,
7854 `compose-mail' issues a warning."
7860 "If the buffer starts with a mail header, move point to the header's end.
7861 Otherwise, moves to `point-min'.
7862 The end of the header is the start of the next line, if there is one,
7863 else the end of the last line. This function obeys RFC822."
7869 ;; Used by Rmail (e.g., rmail-forward).
7871 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7875 switch-function yank-action send-actions
7876 return-action)
7877 "Start composing a mail message to send.
7878 This uses the user's chosen mail composition package
7879 as selected with the variable `mail-user-agent'.
7880 The optional arguments TO and SUBJECT specify recipients
7881 and the initial Subject field, respectively.
7883 OTHER-HEADERS is an alist specifying additional
7884 header fields. Elements look like (HEADER . VALUE) where both
7885 HEADER and VALUE are strings.
7887 CONTINUE, if non-nil, says to continue editing a message already
7888 being composed. Interactively, CONTINUE is the prefix argument.
7890 SWITCH-FUNCTION, if non-nil, is a function to use to
7891 switch to and display the buffer used for mail composition.
7893 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7894 to insert the raw text of the message being replied to.
7895 It has the form (FUNCTION . ARGS). The user agent will apply
7896 FUNCTION to ARGS, to insert the raw text of the original message.
7897 \(The user agent will also run `mail-citation-hook', *after* the
7898 original text has been inserted in this way.)
7900 SEND-ACTIONS is a list of actions to call when the message is sent.
7901 Each action has the form (FUNCTION . ARGS).
7903 RETURN-ACTION, if non-nil, is an action for returning to the
7904 caller. It has the form (FUNCTION . ARGS). The function is
7905 called after the mail has been sent or put aside, and the mail
7906 buffer buried."
7910 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7911 ;; from sendmail-user-agent to message-user-agent. Some users may
7912 ;; encounter incompatibilities. This hack tries to detect problems
7913 ;; and warn about them.
7918 mail-citation-hook mail-archive-file-name
7919 mail-default-reply-to mail-mailing-lists
7920 mail-self-blind))
7927 The default mail mode is now Message mode.
7928 You have the following Mail mode variable%s customized:
7930 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7937 yank-action send-actions return-action)))
7940 yank-action send-actions
7941 return-action)
7945 'switch-to-buffer-other-window yank-action send-actions
7946 return-action))
7949 yank-action send-actions
7950 return-action)
7954 'switch-to-buffer-other-frame yank-action send-actions
7955 return-action))
7957 \f
7959 "History of values entered with `set-variable'.
7961 Maximum length of the history list is determined by the value
7965 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7966 VARIABLE should be a user option variable name, a Lisp variable
7967 meant to be customized by users. You should enter VALUE in Lisp syntax,
7968 so if you want VALUE to be a string, you must surround it with doublequotes.
7969 VALUE is used literally, not evaluated.
7971 If VARIABLE has a `variable-interactive' property, that is used as if
7972 it were the arg to `interactive' (which see) to interactively read VALUE.
7974 If VARIABLE has been defined with `defcustom', then the type information
7975 in the definition is used to check that VALUE is valid.
7977 Note that this function is at heart equivalent to the basic `set' function.
7978 For a variable defined with `defcustom', it does not pay attention to
7979 any :set property that the variable might have (if you want that, use
7982 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7987 default-var)
8003 var obsolete)
8006 ;; Use VAR's `variable-interactive' property
8007 ;; as an interactive spec for prompting.
8010 arg))
8012 read-expression-map t
8013 'set-variable-value-history
8022 ;; Match with custom type.
8034 ;; Force a thorough redisplay for the case that the variable
8035 ;; has an effect on the display, like `tab-width' has.
8037 \f
8038 ;; Define the major mode for lists of completions.
8048 (define-key map [right] 'next-completion)
8050 (define-key map [backtab] 'previous-completion)
8051 (define-key map "q" 'quit-window)
8052 (define-key map "z" 'kill-current-buffer)
8053 map)
8054 "Local map for completion list buffers.")
8056 ;; Completion mode is suitable only for specially formatted data.
8057 (put 'completion-list-mode 'mode-class 'special)
8059 (defvar completion-reference-buffer nil
8060 "Record the buffer that was current when the completion list was requested.
8061 This is a local variable in the completion list buffer.
8062 Initial value is nil to avoid some compiler warnings.")
8064 (defvar completion-no-auto-exit nil
8065 "Non-nil means `choose-completion-string' should never exit the minibuffer.
8066 This also applies to other functions such as `choose-completion'.")
8068 (defvar completion-base-position nil
8069 "Position of the base of the text corresponding to the shown completions.
8070 This variable is used in the *Completions* buffers.
8071 Its value is a list of the form (START END) where START is the place
8072 where the completion should be inserted and END (if non-nil) is the end
8073 of the text to replace. If END is nil, point is used instead.")
8075 (defvar completion-list-insert-choice-function #'completion--replace
8076 "Function to use to insert the text chosen in *Completions*.
8077 Called with three arguments (BEG END TEXT), it should replace the text
8078 between BEG and END with TEXT. Expected to be set buffer-locally
8079 in the *Completions* buffer.")
8081 (defvar completion-base-size nil
8082 "Number of chars before point not involved in completion.
8083 This is a local variable in the completion list buffer.
8084 It refers to the chars in the minibuffer if completing in the
8085 minibuffer, or in `completion-reference-buffer' otherwise.
8086 Only characters in the field at point are included.
8088 If nil, Emacs determines which part of the tail end of the
8089 buffer's text is involved in completion by comparing the text
8090 directly.")
8091 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
8093 (defun delete-completion-window ()
8094 "Delete the completion list window.
8095 Go to the window from which completion was requested."
8096 (interactive)
8097 (let ((buf completion-reference-buffer))
8098 (if (one-window-p t)
8099 (if (window-dedicated-p) (delete-frame))
8100 (delete-window (selected-window))
8101 (if (get-buffer-window buf)
8102 (select-window (get-buffer-window buf))))))
8104 (defun previous-completion (n)
8105 "Move to the previous item in the completion list."
8106 (interactive "p")
8107 (next-completion (- n)))
8109 (defun next-completion (n)
8110 "Move to the next item in the completion list.
8111 With prefix argument N, move N items (negative N means move backward)."
8112 (interactive "p")
8113 (let ((beg (point-min)) (end (point-max)))
8114 (while (and (> n 0) (not (eobp)))
8115 ;; If in a completion, move to the end of it.
8116 (when (get-text-property (point) 'mouse-face)
8117 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8118 ;; Move to start of next one.
8119 (unless (get-text-property (point) 'mouse-face)
8120 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8121 (setq n (1- n)))
8122 (while (and (< n 0) (not (bobp)))
8123 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
8124 ;; If in a completion, move to the start of it.
8125 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
8126 (goto-char (previous-single-property-change
8127 (point) 'mouse-face nil beg)))
8128 ;; Move to end of the previous completion.
8129 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
8130 (goto-char (previous-single-property-change
8131 (point) 'mouse-face nil beg)))
8132 ;; Move to the start of that one.
8133 (goto-char (previous-single-property-change
8134 (point) 'mouse-face nil beg))
8135 (setq n (1+ n))))))
8137 (defun choose-completion (&optional event)
8138 "Choose the completion at point.
8139 If EVENT, use EVENT's position to determine the starting position."
8140 (interactive (list last-nonmenu-event))
8141 ;; In case this is run via the mouse, give temporary modes such as
8142 ;; isearch a chance to turn off.
8143 (run-hooks 'mouse-leave-buffer-hook)
8144 (with-current-buffer (window-buffer (posn-window (event-start event)))
8145 (let ((buffer completion-reference-buffer)
8146 (base-size completion-base-size)
8147 (base-position completion-base-position)
8148 (insert-function completion-list-insert-choice-function)
8149 (choice
8150 (save-excursion
8151 (goto-char (posn-point (event-start event)))
8152 (let (beg end)
8153 (cond
8154 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
8155 (setq end (point) beg (1+ (point))))
8156 ((and (not (bobp))
8157 (get-text-property (1- (point)) 'mouse-face))
8158 (setq end (1- (point)) beg (point)))
8159 (t (error "No completion here")))
8160 (setq beg (previous-single-property-change beg 'mouse-face))
8161 (setq end (or (next-single-property-change end 'mouse-face)
8162 (point-max)))
8163 (buffer-substring-no-properties beg end)))))
8165 (unless (buffer-live-p buffer)
8166 (error "Destination buffer is dead"))
8167 (quit-window nil (posn-window (event-start event)))
8169 (with-current-buffer buffer
8170 (choose-completion-string
8171 choice buffer
8172 (or base-position
8173 (when base-size
8174 ;; Someone's using old completion code that doesn't know
8175 ;; about base-position yet.
8176 (list (+ base-size (field-beginning))))
8177 ;; If all else fails, just guess.
8178 (list (choose-completion-guess-base-position choice)))
8179 insert-function)))))
8181 ;; Delete the longest partial match for STRING
8182 ;; that can be found before POINT.
8183 (defun choose-completion-guess-base-position (string)
8184 (save-excursion
8185 (let ((opoint (point))
8186 len)
8187 ;; Try moving back by the length of the string.
8188 (goto-char (max (- (point) (length string))
8189 (minibuffer-prompt-end)))
8190 ;; See how far back we were actually able to move. That is the
8191 ;; upper bound on how much we can match and delete.
8192 (setq len (- opoint (point)))
8193 (if completion-ignore-case
8194 (setq string (downcase string)))
8195 (while (and (> len 0)
8196 (let ((tail (buffer-substring (point) opoint)))
8197 (if completion-ignore-case
8198 (setq tail (downcase tail)))
8199 (not (string= tail (substring string 0 len)))))
8200 (setq len (1- len))
8201 (forward-char 1))
8202 (point))))
8204 (defun choose-completion-delete-max-match (string)
8205 (declare (obsolete choose-completion-guess-base-position "23.2"))
8206 (delete-region (choose-completion-guess-base-position string) (point)))
8208 (defvar choose-completion-string-functions nil
8209 "Functions that may override the normal insertion of a completion choice.
8210 These functions are called in order with three arguments:
8211 CHOICE - the string to insert in the buffer,
8212 BUFFER - the buffer in which the choice should be inserted,
8213 BASE-POSITION - where to insert the completion.
8215 If a function in the list returns non-nil, that function is supposed
8216 to have inserted the CHOICE in the BUFFER, and possibly exited
8217 the minibuffer; no further functions will be called.
8219 If all functions in the list return nil, that means to use
8220 the default method of inserting the completion in BUFFER.")
8222 (defun choose-completion-string (choice &optional
8223 buffer base-position insert-function)
8224 "Switch to BUFFER and insert the completion choice CHOICE.
8225 BASE-POSITION says where to insert the completion.
8226 INSERT-FUNCTION says how to insert the completion and falls
8227 back on `completion-list-insert-choice-function' when nil."
8229 ;; If BUFFER is the minibuffer, exit the minibuffer
8230 ;; unless it is reading a file name and CHOICE is a directory,
8231 ;; or completion-no-auto-exit is non-nil.
8233 ;; Some older code may call us passing `base-size' instead of
8234 ;; `base-position'. It's difficult to make any use of `base-size',
8235 ;; so we just ignore it.
8236 (unless (consp base-position)
8237 (message "Obsolete `base-size' passed to choose-completion-string")
8238 (setq base-position nil))
8240 (let* ((buffer (or buffer completion-reference-buffer))
8241 (mini-p (minibufferp buffer)))
8242 ;; If BUFFER is a minibuffer, barf unless it's the currently
8243 ;; active minibuffer.
8244 (if (and mini-p
8245 (not (and (active-minibuffer-window)
8246 (equal buffer
8247 (window-buffer (active-minibuffer-window))))))
8248 (error "Minibuffer is not active for completion")
8249 ;; Set buffer so buffer-local choose-completion-string-functions works.
8250 (set-buffer buffer)
8251 (unless (run-hook-with-args-until-success
8252 'choose-completion-string-functions
8253 ;; The fourth arg used to be `mini-p' but was useless
8254 ;; (since minibufferp can be used on the `buffer' arg)
8255 ;; and indeed unused. The last used to be `base-size', so we
8256 ;; keep it to try and avoid breaking old code.
8257 choice buffer base-position nil)
8258 ;; This remove-text-properties should be unnecessary since `choice'
8259 ;; comes from buffer-substring-no-properties.
8260 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8261 ;; Insert the completion into the buffer where it was requested.
8262 (funcall (or insert-function completion-list-insert-choice-function)
8263 (or (car base-position) (point))
8264 (or (cadr base-position) (point))
8265 choice)
8266 ;; Update point in the window that BUFFER is showing in.
8267 (let ((window (get-buffer-window buffer t)))
8268 (set-window-point window (point)))
8269 ;; If completing for the minibuffer, exit it with this choice.
8270 (and (not completion-no-auto-exit)
8271 (minibufferp buffer)
8272 minibuffer-completion-table
8273 ;; If this is reading a file name, and the file name chosen
8274 ;; is a directory, don't exit the minibuffer.
8275 (let* ((result (buffer-substring (field-beginning) (point)))
8276 (bounds
8277 (completion-boundaries result minibuffer-completion-table
8278 minibuffer-completion-predicate
8279 "")))
8280 (if (eq (car bounds) (length result))
8281 ;; The completion chosen leads to a new set of completions
8282 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8283 (let ((mini (active-minibuffer-window)))
8284 (select-window mini)
8285 (when minibuffer-auto-raise
8286 (raise-frame (window-frame mini))))
8287 (exit-minibuffer))))))))
8289 (define-derived-mode completion-list-mode nil "Completion List"
8290 "Major mode for buffers showing lists of possible completions.
8292 to select the completion near point.
8293 Or click to select one with the mouse.
8296 (set (make-local-variable 'completion-base-size) nil))
8298 (defun completion-list-mode-finish ()
8299 "Finish setup of the completions buffer.
8300 Called from `temp-buffer-show-hook'."
8301 (when (eq major-mode 'completion-list-mode)
8302 (setq buffer-read-only t)))
8304 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8307 ;; Variables and faces used in `completion-setup-function'.
8309 (defcustom completion-show-help t
8310 "Non-nil means show help message in *Completions* buffer."
8311 :type 'boolean
8312 :version "22.1"
8313 :group 'completion)
8315 ;; This function goes in completion-setup-hook, so that it is called
8316 ;; after the text of the completion list buffer is written.
8317 (defun completion-setup-function ()
8318 (let* ((mainbuf (current-buffer))
8319 (base-dir
8320 ;; FIXME: This is a bad hack. We try to set the default-directory
8321 ;; in the *Completions* buffer so that the relative file names
8322 ;; displayed there can be treated as valid file names, independently
8323 ;; from the completion context. But this suffers from many problems:
8324 ;; - It's not clear when the completions are file names. With some
8325 ;; completion tables (e.g. bzr revision specs), the listed
8326 ;; completions can mix file names and other things.
8327 ;; - It doesn't pay attention to possible quoting.
8328 ;; - With fancy completion styles, the code below will not always
8329 ;; find the right base directory.
8330 (if minibuffer-completing-file-name
8331 (file-name-as-directory
8332 (expand-file-name
8333 (buffer-substring (minibuffer-prompt-end)
8334 (- (point) (or completion-base-size 0))))))))
8335 (with-current-buffer standard-output
8336 (let ((base-size completion-base-size) ;Read before killing localvars.
8337 (base-position completion-base-position)
8338 (insert-fun completion-list-insert-choice-function))
8339 (completion-list-mode)
8340 (set (make-local-variable 'completion-base-size) base-size)
8341 (set (make-local-variable 'completion-base-position) base-position)
8342 (set (make-local-variable 'completion-list-insert-choice-function)
8343 insert-fun))
8344 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8345 (if base-dir (setq default-directory base-dir))
8346 ;; Maybe insert help string.
8347 (when completion-show-help
8348 (goto-char (point-min))
8349 (if (display-mouse-p)
8351 (insert (substitute-command-keys
8355 (add-hook 'completion-setup-hook 'completion-setup-function)
8357 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8358 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8360 (defun switch-to-completions ()
8361 "Select the completion list window."
8362 (interactive)
8363 (let ((window (or (get-buffer-window "*Completions*" 0)
8364 ;; Make sure we have a completions window.
8365 (progn (minibuffer-completion-help)
8366 (get-buffer-window "*Completions*" 0)))))
8367 (when window
8368 (select-window window)
8369 ;; In the new buffer, go to the first completion.
8370 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8371 (when (bobp)
8372 (next-completion 1)))))
8373 \f
8374 ;;; Support keyboard commands to turn on various modifiers.
8376 ;; These functions -- which are not commands -- each add one modifier
8377 ;; to the following event.
8379 (defun event-apply-alt-modifier (_ignore-prompt)
8382 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8383 (defun event-apply-super-modifier (_ignore-prompt)
8386 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8387 (defun event-apply-hyper-modifier (_ignore-prompt)
8390 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8391 (defun event-apply-shift-modifier (_ignore-prompt)
8394 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8395 (defun event-apply-control-modifier (_ignore-prompt)
8398 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8399 (defun event-apply-meta-modifier (_ignore-prompt)
8402 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8404 (defun event-apply-modifier (event symbol lshiftby prefix)
8405 "Apply a modifier flag to event EVENT.
8406 SYMBOL is the name of this modifier, as a symbol.
8407 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8408 PREFIX is the string that represents this modifier in an event type symbol."
8409 (if (numberp event)
8410 (cond ((eq symbol 'control)
8411 (if (and (<= (downcase event) ?z)
8412 (>= (downcase event) ?a))
8413 (- (downcase event) ?a -1)
8414 (if (and (<= (downcase event) ?Z)
8415 (>= (downcase event) ?A))
8416 (- (downcase event) ?A -1)
8417 (logior (lsh 1 lshiftby) event))))
8418 ((eq symbol 'shift)
8419 (if (and (<= (downcase event) ?z)
8420 (>= (downcase event) ?a))
8421 (upcase event)
8422 (logior (lsh 1 lshiftby) event)))
8423 (t
8424 (logior (lsh 1 lshiftby) event)))
8425 (if (memq symbol (event-modifiers event))
8426 event
8427 (let ((event-type (if (symbolp event) event (car event))))
8428 (setq event-type (intern (concat prefix (symbol-name event-type))))
8429 (if (symbolp event)
8430 event-type
8431 (cons event-type (cdr event)))))))
8433 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8434 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8435 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8436 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8437 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8438 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8439 \f
8440 ;;;; Keypad support.
8442 ;; Make the keypad keys act like ordinary typing keys. If people add
8443 ;; bindings for the function key symbols, then those bindings will
8444 ;; override these, so this shouldn't interfere with any existing
8445 ;; bindings.
8447 ;; Also tell read-char how to handle these keys.
8448 (mapc
8449 (lambda (keypad-normal)
8450 (let ((keypad (nth 0 keypad-normal))
8451 (normal (nth 1 keypad-normal)))
8452 (put keypad 'ascii-character normal)
8453 (define-key function-key-map (vector keypad) (vector normal))))
8454 ;; See also kp-keys bound in bindings.el.
8455 '((kp-space ?\s)
8458 (kp-separator ?,)
8459 (kp-equal ?=)
8460 ;; Do the same for various keys that are represented as symbols under
8461 ;; GUIs but naturally correspond to characters.
8462 (backspace 127)
8463 (delete 127)
8466 (clear ?\C-l)
8467 (return ?\C-m)
8468 (escape ?\e)
8469 ))
8470 \f
8471 ;;;;
8472 ;;;; forking a twin copy of a buffer.
8473 ;;;;
8475 (defvar clone-buffer-hook nil
8476 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8478 (defvar clone-indirect-buffer-hook nil
8479 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8481 (defun clone-process (process &optional newname)
8482 "Create a twin copy of PROCESS.
8483 If NEWNAME is nil, it defaults to PROCESS' name;
8484 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8485 If PROCESS is associated with a buffer, the new process will be associated
8486 with the current buffer instead.
8487 Returns nil if PROCESS has already terminated."
8488 (setq newname (or newname (process-name process)))
8490 (setq newname (substring newname 0 (match-beginning 0))))
8491 (when (memq (process-status process) '(run stop open))
8492 (let* ((process-connection-type (process-tty-name process))
8493 (new-process
8494 (if (memq (process-status process) '(open))
8495 (let ((args (process-contact process t)))
8496 (setq args (plist-put args :name newname))
8497 (setq args (plist-put args :buffer
8498 (if (process-buffer process)
8499 (current-buffer))))
8500 (apply 'make-network-process args))
8501 (apply 'start-process newname
8502 (if (process-buffer process) (current-buffer))
8503 (process-command process)))))
8504 (set-process-query-on-exit-flag
8505 new-process (process-query-on-exit-flag process))
8506 (set-process-inherit-coding-system-flag
8507 new-process (process-inherit-coding-system-flag process))
8508 (set-process-filter new-process (process-filter process))
8509 (set-process-sentinel new-process (process-sentinel process))
8510 (set-process-plist new-process (copy-sequence (process-plist process)))
8511 new-process)))
8513 ;; things to maybe add (currently partly covered by `funcall mode'):
8514 ;; - syntax-table
8515 ;; - overlays
8516 (defun clone-buffer (&optional newname display-flag)
8517 "Create and return a twin copy of the current buffer.
8518 Unlike an indirect buffer, the new buffer can be edited
8519 independently of the old one (if it is not read-only).
8520 NEWNAME is the name of the new buffer. It may be modified by
8521 adding or incrementing <N> at the end as necessary to create a
8522 unique buffer name. If nil, it defaults to the name of the
8523 current buffer, with the proper suffix. If DISPLAY-FLAG is
8524 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8525 clone a file-visiting buffer, or a buffer whose major mode symbol
8526 has a non-nil `no-clone' property, results in an error.
8528 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8529 current buffer with appropriate suffix. However, if a prefix
8530 argument is given, then the command prompts for NEWNAME in the
8531 minibuffer.
8533 This runs the normal hook `clone-buffer-hook' in the new buffer
8534 after it has been set up properly in other respects."
8535 (interactive
8536 (progn
8537 (if buffer-file-name
8538 (error "Cannot clone a file-visiting buffer"))
8539 (if (get major-mode 'no-clone)
8540 (error "Cannot clone a buffer in %s mode" mode-name))
8541 (list (if current-prefix-arg
8542 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8543 t)))
8544 (if buffer-file-name
8545 (error "Cannot clone a file-visiting buffer"))
8546 (if (get major-mode 'no-clone)
8547 (error "Cannot clone a buffer in %s mode" mode-name))
8548 (setq newname (or newname (buffer-name)))
8550 (setq newname (substring newname 0 (match-beginning 0))))
8551 (let ((buf (current-buffer))
8552 (ptmin (point-min))
8553 (ptmax (point-max))
8554 (pt (point))
8555 (mk (if mark-active (mark t)))
8556 (modified (buffer-modified-p))
8557 (mode major-mode)
8558 (lvars (buffer-local-variables))
8559 (process (get-buffer-process (current-buffer)))
8560 (new (generate-new-buffer (or newname (buffer-name)))))
8561 (save-restriction
8562 (widen)
8563 (with-current-buffer new
8564 (insert-buffer-substring buf)))
8565 (with-current-buffer new
8566 (narrow-to-region ptmin ptmax)
8567 (goto-char pt)
8568 (if mk (set-mark mk))
8569 (set-buffer-modified-p modified)
8571 ;; Clone the old buffer's process, if any.
8572 (when process (clone-process process))
8574 ;; Now set up the major mode.
8575 (funcall mode)
8577 ;; Set up other local variables.
8578 (mapc (lambda (v)
8579 (condition-case ()
8580 (if (symbolp v)
8581 (makunbound v)
8582 (set (make-local-variable (car v)) (cdr v)))
8583 (setting-constant nil))) ;E.g. for enable-multibyte-characters.
8584 lvars)
8586 (setq mark-ring (mapcar (lambda (mk) (copy-marker (marker-position mk)))
8587 mark-ring))
8589 ;; Run any hooks (typically set up by the major mode
8590 ;; for cloning to work properly).
8591 (run-hooks 'clone-buffer-hook))
8592 (if display-flag
8593 ;; Presumably the current buffer is shown in the selected frame, so
8594 ;; we want to display the clone elsewhere.
8595 (let ((same-window-regexps nil)
8596 (same-window-buffer-names))
8597 (pop-to-buffer new)))
8598 new))
8601 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8602 "Create an indirect buffer that is a twin copy of the current buffer.
8604 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8605 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8606 or if not called with a prefix arg, NEWNAME defaults to the current
8607 buffer's name. The name is modified by adding a `<N>' suffix to it
8608 or by incrementing the N in an existing suffix. Trying to clone a
8609 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8610 property results in an error.
8612 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8613 This is always done when called interactively.
8615 Optional third arg NORECORD non-nil means do not put this buffer at the
8616 front of the list of recently selected ones.
8618 Returns the newly created indirect buffer."
8619 (interactive
8620 (progn
8621 (if (get major-mode 'no-clone-indirect)
8622 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8623 (list (if current-prefix-arg
8624 (read-buffer "Name of indirect buffer: " (current-buffer)))
8625 t)))
8626 (if (get major-mode 'no-clone-indirect)
8627 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8628 (setq newname (or newname (buffer-name)))
8630 (setq newname (substring newname 0 (match-beginning 0))))
8631 (let* ((name (generate-new-buffer-name newname))
8632 (buffer (make-indirect-buffer (current-buffer) name t)))
8633 (with-current-buffer buffer
8634 (run-hooks 'clone-indirect-buffer-hook))
8635 (when display-flag
8636 (pop-to-buffer buffer nil norecord))
8637 buffer))
8640 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8641 "Like `clone-indirect-buffer' but display in another window."
8642 (interactive
8643 (progn
8644 (if (get major-mode 'no-clone-indirect)
8645 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8646 (list (if current-prefix-arg
8647 (read-buffer "Name of indirect buffer: " (current-buffer)))
8648 t)))
8649 (let ((pop-up-windows t))
8650 (clone-indirect-buffer newname display-flag norecord)))
8652 \f
8653 ;;; Handling of Backspace and Delete keys.
8655 (defcustom normal-erase-is-backspace 'maybe
8656 "Set the default behavior of the Delete and Backspace keys.
8658 If set to t, Delete key deletes forward and Backspace key deletes
8659 backward.
8661 If set to nil, both Delete and Backspace keys delete backward.
8663 If set to `maybe' (which is the default), Emacs automatically
8664 selects a behavior. On window systems, the behavior depends on
8665 the keyboard used. If the keyboard has both a Backspace key and
8666 a Delete key, and both are mapped to their usual meanings, the
8667 option's default value is set to t, so that Backspace can be used
8668 to delete backward, and Delete can be used to delete forward.
8670 If not running under a window system, customizing this option
8671 accomplishes a similar effect by mapping C-h, which is usually
8672 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8673 via `keyboard-translate'. The former functionality of C-h is
8674 available on the F1 key. You should probably not use this
8675 setting if you don't have both Backspace, Delete and F1 keys.
8677 Setting this variable with setq doesn't take effect. Programmatically,
8678 call `normal-erase-is-backspace-mode' (which see) instead."
8679 :type '(choice (const :tag "Off" nil)
8680 (const :tag "Maybe" maybe)
8681 (other :tag "On" t))
8682 :group 'editing-basics
8683 :version "21.1"
8684 :set (lambda (symbol value)
8685 ;; The fboundp is because of a problem with :set when
8686 ;; dumping Emacs. It doesn't really matter.
8687 (if (fboundp 'normal-erase-is-backspace-mode)
8688 (normal-erase-is-backspace-mode (or value 0))
8689 (set-default symbol value))))
8691 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8692 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8693 (unless frame (setq frame (selected-frame)))
8694 (with-selected-frame frame
8695 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8696 (normal-erase-is-backspace-mode
8697 (if (if (eq normal-erase-is-backspace 'maybe)
8698 (and (not noninteractive)
8699 (or (memq system-type '(ms-dos windows-nt))
8700 (memq window-system '(w32 ns))
8701 (and (memq window-system '(x))
8702 (fboundp 'x-backspace-delete-keys-p)
8703 (x-backspace-delete-keys-p))
8704 ;; If the terminal Emacs is running on has erase char
8705 ;; set to ^H, use the Backspace key for deleting
8706 ;; backward, and the Delete key for deleting forward.
8707 (and (null window-system)
8708 (eq tty-erase-char ?\^H))))
8709 normal-erase-is-backspace)
8710 1 0)))))
8712 (define-minor-mode normal-erase-is-backspace-mode
8713 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8714 With a prefix argument ARG, enable this feature if ARG is
8715 positive, and disable it otherwise. If called from Lisp, enable
8716 the mode if ARG is omitted or nil.
8718 On window systems, when this mode is on, Delete is mapped to C-d
8719 and Backspace is mapped to DEL; when this mode is off, both
8720 Delete and Backspace are mapped to DEL. (The remapping goes via
8721 `local-function-key-map', so binding Delete or Backspace in the
8722 global or local keymap will override that.)
8724 In addition, on window systems, the bindings of C-Delete, M-Delete,
8725 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8726 the global keymap in accordance with the functionality of Delete and
8727 Backspace. For example, if Delete is remapped to C-d, which deletes
8728 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8729 to DEL, which deletes backward, C-Delete is bound to
8730 `backward-kill-word'.
8732 If not running on a window system, a similar effect is accomplished by
8733 remapping C-h (normally produced by the Backspace key) and DEL via
8734 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8735 to C-d; if it's off, the keys are not remapped.
8737 When not running on a window system, and this mode is turned on, the
8738 former functionality of C-h is available on the F1 key. You should
8739 probably not turn on this mode on a text-only terminal if you don't
8740 have both Backspace, Delete and F1 keys.
8742 See also `normal-erase-is-backspace'."
8743 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8744 . (lambda (v)
8745 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8746 (if v 1 0))))
8747 (let ((enabled (eq 1 (terminal-parameter
8748 nil 'normal-erase-is-backspace))))
8750 (cond ((or (memq window-system '(x w32 ns pc))
8751 (memq system-type '(ms-dos windows-nt)))
8752 (let ((bindings
8753 `(([M-delete] [M-backspace])
8754 ([C-M-delete] [C-M-backspace])
8755 ([?\e C-delete] [?\e C-backspace]))))
8757 (if enabled
8758 (progn
8759 (define-key local-function-key-map [delete] [deletechar])
8760 (define-key local-function-key-map [kp-delete] [deletechar])
8761 (define-key local-function-key-map [backspace] [?\C-?])
8762 (dolist (b bindings)
8763 ;; Not sure if input-decode-map is really right, but
8764 ;; keyboard-translate-table (used below) only works
8765 ;; for integer events, and key-translation-table is
8766 ;; global (like the global-map, used earlier).
8767 (define-key input-decode-map (car b) nil)
8768 (define-key input-decode-map (cadr b) nil)))
8769 (define-key local-function-key-map [delete] [?\C-?])
8770 (define-key local-function-key-map [kp-delete] [?\C-?])
8771 (define-key local-function-key-map [backspace] [?\C-?])
8772 (dolist (b bindings)
8773 (define-key input-decode-map (car b) (cadr b))
8774 (define-key input-decode-map (cadr b) (car b))))))
8775 (t
8776 (if enabled
8777 (progn
8778 (keyboard-translate ?\C-h ?\C-?)
8779 (keyboard-translate ?\C-? ?\C-d))
8780 (keyboard-translate ?\C-h ?\C-h)
8781 (keyboard-translate ?\C-? ?\C-?))))
8783 (if (called-interactively-p 'interactive)
8784 (message "Delete key deletes %s"
8785 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8786 "forward" "backward")))))
8787 \f
8788 (defvar vis-mode-saved-buffer-invisibility-spec nil
8789 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8791 (define-minor-mode read-only-mode
8792 "Change whether the current buffer is read-only.
8793 With prefix argument ARG, make the buffer read-only if ARG is
8794 positive, otherwise make it writable. If buffer is read-only
8795 and `view-read-only' is non-nil, enter view mode.
8797 Do not call this from a Lisp program unless you really intend to
8799 possibly enabling or disabling View mode. Also, note that this
8800 command works by setting the variable `buffer-read-only', which
8801 does not affect read-only regions caused by text properties. To
8802 ignore read-only status in a Lisp program (whether due to text
8803 properties or buffer state), bind `inhibit-read-only' temporarily
8804 to a non-nil value."
8805 :variable buffer-read-only
8806 (cond
8807 ((and (not buffer-read-only) view-mode)
8808 (View-exit-and-edit)
8809 (make-local-variable 'view-read-only)
8810 (setq view-read-only t)) ; Must leave view mode.
8811 ((and buffer-read-only view-read-only
8812 ;; If view-mode is already active, `view-mode-enter' is a nop.
8813 (not view-mode)
8814 (not (eq (get major-mode 'mode-class) 'special)))
8815 (view-mode-enter))))
8817 (define-minor-mode visible-mode
8818 "Toggle making all invisible text temporarily visible (Visible mode).
8819 With a prefix argument ARG, enable Visible mode if ARG is
8820 positive, and disable it otherwise. If called from Lisp, enable
8821 the mode if ARG is omitted or nil.
8823 This mode works by saving the value of `buffer-invisibility-spec'
8824 and setting it to nil."
8825 :lighter " Vis"
8826 :group 'editing-basics
8827 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8828 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8829 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8830 (when visible-mode
8831 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8832 buffer-invisibility-spec)
8833 (setq buffer-invisibility-spec nil)))
8834 \f
8835 (defvar messages-buffer-mode-map
8836 (let ((map (make-sparse-keymap)))
8837 (set-keymap-parent map special-mode-map)
8838 (define-key map "g" nil) ; nothing to revert
8839 map))
8841 (define-derived-mode messages-buffer-mode special-mode "Messages"
8844 (defun messages-buffer ()
8846 If it does not exist, create and it switch it to `messages-buffer-mode'."
8847 (or (get-buffer "*Messages*")
8848 (with-current-buffer (get-buffer-create "*Messages*")
8849 (messages-buffer-mode)
8850 (current-buffer))))
8852 \f
8853 ;; Minibuffer prompt stuff.
8855 ;;(defun minibuffer-prompt-modification (start end)
8856 ;; (error "You cannot modify the prompt"))
8857 ;;
8858 ;;
8859 ;;(defun minibuffer-prompt-insertion (start end)
8860 ;; (let ((inhibit-modification-hooks t))
8861 ;; (delete-region start end)
8862 ;; ;; Discard undo information for the text insertion itself
8863 ;; ;; and for the text deletion.above.
8864 ;; (when (consp buffer-undo-list)
8865 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8866 ;; (message "You cannot modify the prompt")))
8867 ;;
8868 ;;
8869 ;;(setq minibuffer-prompt-properties
8870 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8871 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8873 \f
8874 ;;;; Problematic external packages.
8876 ;; rms says this should be done by specifying symbols that define
8877 ;; versions together with bad values. This is therefore not as
8878 ;; flexible as it could be. See the thread:
8879 ;; https://lists.gnu.org/r/emacs-devel/2007-08/msg00300.html
8880 (defconst bad-packages-alist
8881 ;; Not sure exactly which semantic versions have problems.
8882 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8884 "The version of `semantic' loaded does not work in Emacs 22.
8885 It can cause constant high CPU load.
8886 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8887 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8888 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8889 ;; provided the `CUA-mode' feature. Since this is no longer true,
8890 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8891 (CUA-mode t nil
8892 "CUA-mode is now part of the standard GNU Emacs distribution,
8893 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8895 You have loaded an older version of CUA-mode which does not work
8896 correctly with this version of Emacs. You should remove the old
8897 version and use the one distributed with Emacs."))
8898 "Alist of packages known to cause problems in this version of Emacs.
8899 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8900 PACKAGE is either a regular expression to match file names, or a
8901 symbol (a feature name), like for `with-eval-after-load'.
8902 SYMBOL is either the name of a string variable, or t. Upon
8903 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8904 warning using STRING as the message.")
8906 (defun bad-package-check (package)
8907 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8908 (condition-case nil
8909 (let* ((list (assoc package bad-packages-alist))
8910 (symbol (nth 1 list)))
8911 (and list
8912 (boundp symbol)
8913 (or (eq symbol t)
8914 (and (stringp (setq symbol (eval symbol)))
8915 (string-match-p (nth 2 list) symbol)))
8916 (display-warning package (nth 3 list) :warning)))
8917 (error nil)))
8919 (dolist (elem bad-packages-alist)
8920 (let ((pkg (car elem)))
8921 (with-eval-after-load pkg
8922 (bad-package-check pkg))))
8924 \f
8925 ;;; Generic dispatcher commands
8927 ;; Macro `define-alternatives' is used to create generic commands.
8928 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8929 ;; that can have different alternative implementations where choosing
8930 ;; among them is exclusively a matter of user preference.
8932 ;; (define-alternatives COMMAND) creates a new interactive command
8933 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8934 ;; Typically, the user will not need to customize this variable; packages
8935 ;; wanting to add alternative implementations should use
8936 ;;
8937 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8939 (defmacro define-alternatives (command &rest customizations)
8940 "Define the new command `COMMAND'.
8942 The argument `COMMAND' should be a symbol.
8944 Running `M-x COMMAND RET' for the first time prompts for which
8945 alternative to use and records the selected command as a custom
8946 variable.
8948 Running `C-u M-x COMMAND RET' prompts again for an alternative
8949 and overwrites the previous choice.
8951 The variable `COMMAND-alternatives' contains an alist with
8952 alternative implementations of COMMAND. `define-alternatives'
8953 does not have any effect until this variable is set.
8955 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8956 `defcustom' keywords and values to add to the declaration of
8957 `COMMAND-alternatives' (typically :group and :version)."
8958 (let* ((command-name (symbol-name command))
8959 (varalt-name (concat command-name "-alternatives"))
8960 (varalt-sym (intern varalt-name))
8961 (varimp-sym (intern (concat command-name "--implementation"))))
8962 `(progn
8964 (defcustom ,varalt-sym nil
8965 ,(format "Alist of alternative implementations for the `%s' command.
8967 Each entry must be a pair (ALTNAME . ALTFUN), where:
8968 ALTNAME - The name shown at user to describe the alternative implementation.
8969 ALTFUN - The function called to implement this alternative."
8970 command-name)
8971 :type '(alist :key-type string :value-type function)
8972 ,@customizations)
8974 (put ',varalt-sym 'definition-name ',command)
8975 (defvar ,varimp-sym nil "Internal use only.")
8977 (defun ,command (&optional arg)
8978 ,(format "Run generic command `%s'.
8979 If used for the first time, or with interactive ARG, ask the user which
8980 implementation to use for `%s'. The variable `%s'
8981 contains the list of implementations currently supported for this command."
8982 command-name command-name varalt-name)
8983 (interactive "P")
8984 (when (or arg (null ,varimp-sym))
8985 (let ((val (completing-read
8986 ,(format-message
8987 "Select implementation for command `%s': "
8988 command-name)
8989 ,varalt-sym nil t)))
8990 (unless (string-equal val "")
8991 (when (null ,varimp-sym)
8992 (message
8993 "Use C-u M-x %s RET`to select another implementation"
8994 ,command-name)
8995 (sit-for 3))
8996 (customize-save-variable ',varimp-sym
8997 (cdr (assoc-string val ,varalt-sym))))))
8998 (if ,varimp-sym
8999 (call-interactively ,varimp-sym)
9000 (message "%s" ,(format-message
9001 "No implementation selected for command `%s'"
9002 command-name)))))))
9004 \f
9005 ;;; Functions for changing capitalization that Do What I Mean
9006 (defun upcase-dwim (arg)
9007 "Upcase words in the region, if active; if not, upcase word at point.
9008 If the region is active, this function calls `upcase-region'.
9009 Otherwise, it calls `upcase-word', with prefix argument passed to it
9010 to upcase ARG words."
9011 (interactive "*p")
9012 (if (use-region-p)
9013 (upcase-region (region-beginning) (region-end) (region-noncontiguous-p))
9014 (upcase-word arg)))
9016 (defun downcase-dwim (arg)
9017 "Downcase words in the region, if active; if not, downcase word at point.
9018 If the region is active, this function calls `downcase-region'.
9019 Otherwise, it calls `downcase-word', with prefix argument passed to it
9020 to downcase ARG words."
9021 (interactive "*p")
9022 (if (use-region-p)
9023 (downcase-region (region-beginning) (region-end) (region-noncontiguous-p))
9024 (downcase-word arg)))
9026 (defun capitalize-dwim (arg)
9027 "Capitalize words in the region, if active; if not, capitalize word at point.
9028 If the region is active, this function calls `capitalize-region'.
9029 Otherwise, it calls `capitalize-word', with prefix argument passed to it
9030 to capitalize ARG words."
9031 (interactive "*p")
9032 (if (use-region-p)
9033 (capitalize-region (region-beginning) (region-end))
9034 (capitalize-word arg)))
9036 \f
9038 (provide 'simple)
9040 ;;; simple.el ends here