| blob | e51bc132a6b93510a422b62008b246751ac14695 |
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 "If non-nil, output buffer is not erased between shell commands.
42 Also, a non-nil value sets the point in the output buffer
43 once the command completes.
44 The value `beg-last-out' sets point at the beginning of the output,
45 `end-last-out' sets point at the end of the buffer, `save-point'
46 restores the buffer position before the command."
56 "Record of point positions in output buffers after command completion.
57 The value is an alist whose elements are of the form (BUFFER . POS),
58 where BUFFER is the output buffer, and POS is the point position
59 in BUFFER once the command finishes.
63 "Idle time delay before updating various things on the screen.
64 Various Emacs features that update auxiliary information when point moves
65 wait this many seconds after Emacs becomes idle before doing an update."
71 "Killing and yanking commands."
75 "Highlight (un)matching of parens and expressions."
77 \f
78 ;;; next-error support framework
81 "`next-error' support framework."
87 "Face used to highlight next error locus."
92 "Highlighting of locations in selected source buffers.
93 If a number, highlight the locus in `next-error' face for the given time
94 in seconds, or until the next command is executed.
95 If t, highlight the locus until the next command is executed, or until
96 some other locus replaces it.
97 If nil, don't highlight the locus in the source buffer.
98 If `fringe-arrow', indicate the locus by the fringe arrow
99 indefinitely until some other locus replaces it."
108 "Highlighting of locations in `next-error-no-select'.
109 If number, highlight the locus in `next-error' face for given time in seconds.
110 If t, highlight the locus indefinitely until some other locus replaces it.
111 If nil, don't highlight the locus in the source buffer.
112 If `fringe-arrow', indicate the locus by the fringe arrow
113 indefinitely until some other locus replaces it."
122 "Display the line in the visited source file recentered as specified.
123 If non-nil, the value is passed directly to `recenter'."
131 "List of hook functions run by `next-error' after visiting source file."
142 "The most recent `next-error' buffer.
143 A buffer becomes most recent when its compilation, grep, or
148 "Function to use to find the next error in the current buffer.
149 The function is called with 2 parameters:
150 ARG is an integer specifying by how many errors to move.
151 RESET is a boolean which, if non-nil, says to go back to the beginning
152 of the errors before moving.
153 Major modes providing compile-like functionality should set this variable
154 to indicate to `next-error' that this is a candidate buffer and how
159 "Function to use to move to an error locus.
160 It takes two arguments, a buffer position in the error buffer
161 and a buffer position in the error locus buffer.
162 The buffer for the error locus should already be current.
167 &optional avoid-current
168 extra-test-inclusive
169 extra-test-exclusive)
170 "Return non-nil if BUFFER is a `next-error' capable buffer.
171 If AVOID-CURRENT is non-nil, and BUFFER is the current buffer,
172 return nil.
174 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if
175 BUFFER would not normally qualify. If it returns non-nil, BUFFER
176 is considered `next-error' capable, anyway, and the function
177 returns non-nil.
179 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the
180 buffer would normally qualify. If it returns nil, BUFFER is
181 rejected, and the function returns nil."
186 ;; Optionally reject some buffers.
189 t)
190 ;; Optionally accept some other buffers.
195 extra-test-inclusive
196 extra-test-exclusive)
197 "Return a `next-error' capable buffer.
199 If AVOID-CURRENT is non-nil, treat the current buffer
200 as an absolute last resort only.
202 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
203 that normally would not qualify. If it returns t, the buffer
204 in question is treated as usable.
206 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
207 that would normally be considered usable. If it returns nil,
208 that buffer is rejected."
210 ;; 1. If one window on the selected frame displays such buffer, return it.
216 avoid-current
217 extra-test-inclusive extra-test-exclusive)
222 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
225 extra-test-inclusive extra-test-exclusive))
226 next-error-last-buffer)
227 ;; 3. If the current buffer is acceptable, choose it.
229 extra-test-inclusive extra-test-exclusive)
231 ;; 4. Look for any acceptable buffer.
236 extra-test-inclusive extra-test-exclusive)))
239 ;; 5. Use the current buffer as a last resort if it qualifies,
240 ;; even despite AVOID-CURRENT.
243 extra-test-inclusive extra-test-exclusive)
247 ;; 6. Give up.
251 "Visit next `next-error' message and corresponding source code.
253 If all the error messages parsed so far have been processed already,
254 the message buffer is checked for new ones.
256 A prefix ARG specifies how many error messages to move;
257 negative means move back to previous error messages.
259 and start at the first error.
261 The RESET argument specifies that we should restart from the beginning.
264 compilation, grep, or occur buffer. It can also operate on any
266 more generally, on any buffer in Compilation mode or with
267 Compilation Minor mode enabled, or any buffer in which
268 `next-error-function' is bound to an appropriate function.
269 To specify use of a particular buffer for error messages, type
271 in the current frame.
274 runs `next-error-hook' with `run-hooks', and stays with that buffer
275 until you use it in some other buffer which uses Compilation mode
276 or Compilation Minor mode.
278 To control which errors are matched, customize the variable
279 `compilation-error-regexp-alist'."
284 ;; We know here that next-error-function is a valid symbol we can funcall
287 ;; Override possible change of next-error-last-buffer in next-error-function
294 "Visit the source code corresponding to the `next-error' message at point."
296 ;; We know here that next-error-function is a valid symbol we can funcall
299 ;; Override possible change of next-error-last-buffer in next-error-function
309 "Visit previous `next-error' message and corresponding source code.
311 Prefix arg N says how many error messages to move backwards (or
312 forwards, if negative).
319 "Restart at the first error.
320 Visit corresponding source code.
321 With prefix arg N, visit the source code of the Nth error.
327 "Move point to the next error in the `next-error' buffer and highlight match.
328 Prefix arg N says how many error messages to move forwards (or
329 backwards, if negative).
331 select the source buffer."
338 "Move point to the previous error in the `next-error' buffer and highlight match.
339 Prefix arg N says how many error messages to move backwards (or
340 forwards, if negative).
342 select the source buffer."
346 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
350 "Minor mode for compilation, occur and diff modes.
351 With a prefix argument ARG, enable mode if ARG is positive, and
352 disable it otherwise. If called from Lisp, enable mode if ARG is
353 omitted or nil.
354 When turned on, cursor motion in the compilation, grep, occur or diff
355 buffer causes automatic display of the corresponding source code location."
362 ;; Used as a `post-command-hook' by `next-error-follow-mode'
363 ;; for the *Compilation* *grep* and *Occur* buffers.
373 \f
374 ;;;
377 "Major mode not specialized for anything in particular.
378 Other major modes are defined by comparison with this one."
383 ;; Special major modes to view specially formatted data rather than files.
397 map))
401 "Parent major mode from which special major modes should inherit."
404 ;; Making and deleting lines.
407 "Special hook to tell if `self-insert-command' will use the region.
408 It must be called via `run-hook-with-args-until-success' with no arguments.
410 If any function on this hook returns a non-nil value, `delete-selection-mode'
411 will act on that value (see `delete-selection-helper'), and will
412 usually delete the region. If all the functions on this hook return
413 nil, it is an indiction that `self-insert-command' needs the region
414 untouched by `delete-selection-mode', and will itself do whatever is
415 appropriate with the region.
416 Any function on `post-self-insert-hook' which act on the region should
417 add a function to this hook so that `delete-selection-mode' could
418 refrain from deleting the region before `post-self-insert-hook'
419 functions are called.
426 "Insert a newline, and move to left margin of the new line if it's blank.
427 If option `use-hard-newlines' is non-nil, the newline is marked with the
428 text-property `hard'.
429 With ARG, insert that many newlines.
431 If `electric-indent-mode' is enabled, this indents the final new line
432 that it adds, and reindents the preceding line. To just insert
435 Calls `auto-fill-function' if the current column number is greater
436 than the value of `fill-column' and ARG is nil.
437 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
440 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
441 ;; Set last-command-event to tell self-insert what to insert.
445 ;; Don't auto-fill if we have a numeric argument.
449 ;; Do the rest in post-self-insert-hook, because we want to do it
450 ;; *before* other functions on that hook.
452 ;; Mark the newline(s) `hard'.
456 ;; If the newline leaves the previous line blank, and we
457 ;; have a left margin, delete that from the blank line.
465 ;; Indent the line after the newline, except in one case:
466 ;; when we added the newline at the beginning of a line which
467 ;; starts a page.
471 ;; FIXME: For non-interactive uses, many calls actually
472 ;; just want (insert "\n"), so maybe we should do just
473 ;; that, so as to avoid the risk of filling or running
474 ;; abbrevs unexpectedly.
481 ;; We first used let-binding to protect the hook, but that
482 ;; was naive since add-hook affects the symbol-default
483 ;; value of the variable, whereas the let-binding might
484 ;; only protect the buffer-local value.
486 nil)
491 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
497 "Insert a newline and leave point before it.
498 If there is a fill prefix and/or a `left-margin', insert them on
499 the new line if the line would have been blank.
500 With arg N, insert N newlines."
505 ;; Don't expand an abbrev before point.
516 ;; Necessary in case a margin or prefix was inserted.
520 "Split current line, moving portion beyond point vertically down.
521 If the current line starts with `fill-prefix', insert it on the new
522 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
524 When called from Lisp code, ARG may be a prefix string to copy."
529 ;; What prefix should we check for (nil means don't).
533 ;; Does this line start with it?
544 "Join this line to previous and fix up whitespace at join.
545 If there is a fill prefix, delete it from the beginning of this line.
546 With argument, join this line to following line."
553 ;; If the second line started with the fill prefix,
554 ;; delete the prefix.
566 "On blank line, delete all surrounding blank lines, leaving just one.
567 On isolated blank line, delete that one.
568 On nonblank line, delete any immediately following blank lines."
574 ;; Set singleblank if there is just one blank line here.
581 ;; Delete preceding blank lines, and this one too if it's the only one.
590 ;; Delete following blank lines, unless the current line is blank
591 ;; and there are no following blank lines.
600 ;; Handle the special case where point is followed by newline and eob.
601 ;; Delete the line, leaving point at eob.
607 Trailing lines are deleted only if `delete-trailing-whitespace'
608 is called on the entire buffer (rather than an active region)."
614 "Return non-nil if the region contains no read-only text."
619 "Delete trailing whitespace between START and END.
620 If called interactively, START and END are the start/end of the
621 region if the mark is active, or of the buffer's accessible
622 portion if the mark is inactive.
624 This command deletes whitespace characters after the last
625 non-whitespace character in each line between START and END. It
626 does not consider formfeed characters to be whitespace.
628 If this command acts on the entire buffer (i.e. if called
629 interactively with the mark inactive, or called from Lisp with
630 END nil), it also deletes all trailing lines at the end of the
631 buffer if the variable `delete-trailing-lines' is non-nil."
642 ;; Don't delete formfeeds, even if they are considered whitespace.
651 ;; Delete trailing empty lines.
653 ;; Really the end of buffer.
658 ;; Return nil for the benefit of `write-file-functions'.
659 nil)
662 "Insert a newline, then indent according to major mode.
663 Indentation is done using the value of `indent-line-function'.
664 In programming language modes, this is the same as TAB.
665 In some text modes, where TAB inserts a tab, this command indents to the
666 column specified by the function `current-left-margin'."
673 "Reindent current line, insert newline, then indent the new line.
674 Indentation of both lines is done according to the current major mode,
675 which means calling the current value of `indent-line-function'.
676 In programming language modes, this is the same as TAB.
677 In some text modes, where TAB inserts a tab, this indents to the
678 column specified by the function `current-left-margin'."
681 ;; Be careful to insert the newline before indenting the line.
682 ;; Otherwise, the indentation might be wrong.
686 ;; We are at EOL before the call to indent-according-to-mode, and
687 ;; after it we usually are as well, but not always. We tried to
688 ;; address it with `save-excursion' but that uses a normal marker
689 ;; whereas we need `move after insertion', so we do the save/restore
690 ;; by hand.
694 ;; Remove the trailing white-space after indentation because
695 ;; indentation may introduce the whitespace.
701 Legitimate radix values are 8, 10 and 16."
706 "Like `read-char', but do not allow quitting.
707 Also, if the first character read is an octal digit,
708 we read any number of octal digits and return the
709 specified character code. Any nondigit terminates the sequence.
710 If the terminator is RET, it is discarded;
711 any other terminator is used itself as input.
713 The optional argument PROMPT specifies a string to use to prompt the user.
714 The variable `read-quoted-char-radix' controls which radix to use
715 for numeric input."
718 help-event-list)))
722 ;; Don't let C-h or other help chars get the help
723 ;; message--only help function keys. See bug#16617.
727 "Type the special character you want to use,
728 or the octal character code.
729 RET terminates the character code and is discarded;
733 ;; Translate TAB key into control-I ASCII character, and so on.
734 ;; Note: `read-char' does it using the `ascii-character' property.
735 ;; We tried using read-key instead, but that disables the keystroke
736 ;; echo produced by 'C-q', see bug#24635.
740 char)))
746 done t))
748 ;; Turn a meta-character into a character with the 0200 bit set.
750 done t))
765 done t))
767 done t)))
769 code))
772 "Read next input character and insert it.
773 This is useful for inserting control characters.
774 With argument, insert ARG copies of the character.
776 If the first character you type after this command is an octal digit,
777 you should type a sequence of octal digits which specify a character code.
778 Any nondigit terminates the sequence. If the terminator is a RET,
779 it is discarded; any other terminator is used itself as input.
780 The variable `read-quoted-char-radix' specifies the radix for this feature;
781 set it to 10 or 16 to use decimal or hex instead of octal.
783 In overwrite mode, this function inserts the character anyway, and
784 does not handle octal digits specially. This means that if you use
785 overwrite as your normal editing mode, you can use this function to
786 insert characters when necessary.
788 In binary overwrite mode, this function does overwrite, and octal
789 digits are interpreted as a character code. This is intended to be
790 useful for editing binary files."
793 ;; Avoid "obsolete" warnings for translation-table-for-input.
800 ;; This used to assume character codes 0240 - 0377 stand for
801 ;; characters in some single-byte character set, and converted them
802 ;; to Emacs characters. But in 23.1 this feature is deprecated
803 ;; in favor of inserting the corresponding Unicode characters.
804 ;; (if (and enable-multibyte-characters
805 ;; (>= char ?\240)
806 ;; (<= char ?\377))
807 ;; (setq char (unibyte-char-to-multibyte char)))
819 "Move forward ARG lines and position at first nonblank character."
825 "Move backward ARG lines and position at first nonblank character."
831 "Move point to the first non-whitespace character on this line."
835 ;; Move back over chars that have whitespace syntax but have the p flag.
839 "Fixup white space between objects around point.
840 Leave one space or none, according to the context."
847 nil
851 "Delete all spaces and tabs around point.
852 If BACKWARD-ONLY is non-nil, only delete them before point."
857 orig-pos
866 "Delete all spaces and tabs around point, leaving one space (or N spaces).
867 If N is negative, delete newlines as well, leaving -N spaces.
868 See also `cycle-spacing'."
873 "Store context used in consecutive calls to `cycle-spacing' command.
874 The first time `cycle-spacing' runs, it saves in this variable:
875 its N argument, the original point position, and the original spacing
879 "Manipulate whitespace around point in a smart way.
880 In interactive use, this function behaves differently in successive
881 consecutive calls.
883 The first call in a sequence acts like `just-one-space'.
884 It deletes all spaces and tabs around point, leaving one space
885 \(or N spaces). N is the prefix argument. If N is negative,
886 it deletes newlines as well, leaving -N spaces.
887 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
889 The second call in a sequence deletes all spaces.
891 The third call in a sequence restores the original whitespace (and point).
893 If MODE is `single-shot', it only performs the first step in the sequence.
894 If MODE is `fast' and the first step would not result in any change
895 \(i.e., there are exactly (abs N) spaces around point),
896 the function goes straight to the second step.
898 Repeatedly calling the function with different values of N starts a
899 new sequence each time."
907 ;; Command run for the first time, single-shot mode or different argument
919 ;; Special handling for case where there was no space at all.
922 ;; If this run causes no change in buffer content, delete all spaces,
923 ;; otherwise delete all excess spaces.
928 ;; Command run for the second time.
932 ;; Command run for the third time.
937 \f
939 "Move point to the beginning of the buffer.
940 With numeric arg N, put point N/10 of the way from the beginning.
941 If the buffer is narrowed, this command uses the beginning of the
942 accessible part of the buffer.
945 is supplied, or Transient Mark mode is enabled and the mark is active."
955 ;; Avoid overflow for large buffer sizes!
963 "Move point to the end of the buffer.
964 With numeric arg N, put point N/10 of the way from the end.
965 If the buffer is narrowed, this command uses the end of the
966 accessible part of the buffer.
969 is supplied, or Transient Mark mode is enabled and the mark is active."
977 ;; Avoid overflow for large buffer sizes!
982 ;; If we went to a place in the middle of the buffer,
983 ;; adjust it to the beginning of a line.
987 ;; If the end of the buffer is not already on the screen,
988 ;; then scroll specially to put it near, but not at, the bottom.
993 "Whether single-char deletion commands delete an active region.
994 This has an effect only if Transient Mark mode is enabled, and
995 affects `delete-forward-char' and `delete-backward-char', though
996 not `delete-char'.
998 If the value is the symbol `kill', the active region is killed
999 instead of deleted."
1016 "Function to get the region's content.
1017 Called with one argument METHOD.
1018 If METHOD is `delete-only', then delete the region; the return value
1019 is undefined. If METHOD is nil, then return the content as a string.
1020 If METHOD is `bounds', then return the boundaries of the region
1021 as a list of cons cells of the form (START . END).
1022 If METHOD is anything else, delete the region and return its content
1023 as a string, after filtering it with `filter-buffer-substring', which
1034 first nil))))
1035 "Function to insert the region's content.
1036 Called with one argument LINES.
1040 "Delete the previous N characters (following if N is negative).
1041 If Transient Mark mode is enabled, the mark is active, and N is 1,
1042 delete the text in the region and deactivate the mark instead.
1043 To disable this, set option `delete-active-region' to nil.
1045 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1046 kill ring) instead of delete. Interactively, N is the prefix
1047 arg, and KILLFLAG is set if N is explicitly specified.
1049 When killing, the killed text is filtered by
1050 `filter-buffer-substring' before it is saved in the kill ring, so
1051 the actual saved text might be different from what was killed.
1053 In Overwrite mode, single character backward deletion may replace
1054 tabs with spaces so as to back over columns, unless point is at
1055 the end of the line."
1061 delete-active-region
1063 ;; If a region is active, kill or delete it.
1067 ;; In Overwrite mode, maybe untabify while deleting
1077 ;; Otherwise, do simple deletion.
1081 "Delete the following N characters (previous if N is negative).
1082 If Transient Mark mode is enabled, the mark is active, and N is 1,
1083 delete the text in the region and deactivate the mark instead.
1084 To disable this, set variable `delete-active-region' to nil.
1086 Optional second arg KILLFLAG non-nil means to kill (save in kill
1087 ring) instead of delete. Interactively, N is the prefix arg, and
1088 KILLFLAG is set if N was explicitly specified.
1090 When killing, the killed text is filtered by
1091 `filter-buffer-substring' before it is saved in the kill ring, so
1092 the actual saved text might be different from what was killed."
1098 delete-active-region
1100 ;; If a region is active, kill or delete it.
1105 ;; Otherwise, do simple deletion.
1109 "Put point at beginning and mark at end of buffer.
1110 If narrowing is in effect, only uses the accessible part of the buffer.
1111 You probably should not use this function in Lisp programs;
1112 it is usually a mistake for a Lisp function to use any subroutine
1113 that uses or sets the mark."
1118 ;; This is really `point-min' in most cases, but if we're in the
1119 ;; minibuffer, this is at the end of the prompt.
1121 \f
1123 ;; Counting lines, one way or another.
1126 "Go to LINE, counting from line 1 at beginning of buffer.
1127 If called interactively, a numeric prefix argument specifies
1128 LINE; without a numeric prefix argument, read LINE from the
1129 minibuffer.
1131 If optional argument BUFFER is non-nil, switch to that buffer and
1133 as argument, BUFFER is the most recently selected other buffer.
1135 Prior to moving point, this function sets the mark (without
1136 activating it), unless Transient Mark mode is enabled and the
1137 mark is already active.
1139 This function is usually the wrong thing to use in a Lisp program.
1140 What you probably want instead is something like:
1141 (goto-char (point-min))
1142 (forward-line (1- N))
1143 If at all possible, an even better solution is to use char counts
1144 rather than line counts."
1149 ;; Look for a default, a number in the buffer at point.
1159 ;; Decide if we're switching buffers.
1167 ;; Read the argument, offering that number (if any) as default.
1170 buffer))))
1171 ;; Switch to the desired buffer, one way or another.
1176 ;; Leave mark at previous position
1178 ;; Move to the specified line number in that buffer.
1187 "Count the number of words in the region.
1188 If called interactively, print a message reporting the number of
1189 lines, words, and characters in the region (whether or not the
1190 region is active); with prefix ARG, report for the entire buffer
1191 rather than the region.
1193 If called from Lisp, return the number of words between positions
1194 START and END."
1206 "Count words between START and END.
1207 If called interactively, START and END are normally the start and
1208 end of the buffer; but if the region is active, START and END are
1209 the start and end of the region. Print a message reporting the
1210 number of lines, words, and chars.
1212 If called from Lisp, return the number of words between START and
1213 END, without printing any message."
1223 words))
1239 str
1247 "Print the current buffer line number and narrowed line number of point."
1260 "Return number of lines between START and END.
1261 This is usually the number of newlines between them,
1262 but can be one more if START is not equal to END
1263 and the greater of them is not at the start of a line."
1279 done)))
1283 "Return buffer line number at position POS.
1284 If POS is nil, use current buffer location.
1286 If ABSOLUTE is nil, the default, counting starts
1287 at (point-min), so the value refers to the contents of the
1288 accessible portion of the (potentially narrowed) buffer. If
1289 ABSOLUTE is non-nil, ignore any narrowing and return the
1290 absolute line number."
1303 "Print info on cursor position (on screen and within buffer).
1304 Also describe the character after point, and give its character code
1305 in octal, decimal and hex.
1307 For a non-ASCII multibyte character, also give its encoding in the
1308 buffer's selected coding system if the coding system encodes the
1309 character safely. If the character is encoded into one byte, that
1310 code is shown in hex. If the character is encoded into more than one
1313 In addition, with prefix argument, show details about that character
1314 in *Help* buffer. See also the command `describe-char'."
1318 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1319 ;; start a directional embedding, which could completely
1320 ;; disrupt the rest of the line (e.g., RLO will display the
1321 ;; rest of the line right-to-left). So we put an invisible
1322 ;; PDF character after these characters, to end the
1323 ;; embedding, which eliminates any effects on the rest of
1324 ;; the line. For RLE and RLO we also append an invisible
1325 ;; LRM, to avoid reordering the following numerical
1326 ;; characters. For LRI/RLI/FSI we append a PDI.
1333 ;; Strong right-to-left characters cause reordering of
1334 ;; the following numerical characters which show the
1335 ;; codepoint, so append LRM to countermand that.
1346 ""
1352 pos total percent beg end col hscroll)
1354 pos total col hscroll))
1356 encoded encoding-msg display-prop under-display)
1363 ;; Check if the character is displayed with some `display'
1364 ;; text property. In that case, set under-display to the
1365 ;; buffer substring covered by that property.
1376 under-display)))
1382 char char char under-display)
1384 char char char under-display display-prop))
1387 char char char
1389 "..."
1393 ;; We show the detailed information about CHAR.
1400 bidi-fixer
1401 encoding-msg pos total percent beg end col hscroll)
1408 bidi-fixer encoding-msg pos total percent col hscroll))))))
1409 \f
1410 ;; Initialize read-expression-map. It is defined at C level.
1414 ;; Might as well bind TAB to completion, since inserting a TAB char is
1415 ;; much too rarely useful.
1418 m))
1421 "Return a Lisp object read using the minibuffer, unevaluated.
1422 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1423 is a string to insert in the minibuffer before reading.
1424 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1425 Such arguments are used as in `read-from-minibuffer'.)"
1426 ;; Used for interactive spec `x'.
1431 "Return value of Lisp expression read using the minibuffer.
1432 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1433 is a string to insert in the minibuffer before reading.
1434 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1435 Such arguments are used as in `read-from-minibuffer'.)"
1436 ;; Used for interactive spec `X'.
1444 "The current default value or list of default values in the minibuffer.
1445 The functions `read-from-minibuffer' and `completing-read' bind
1449 "Value for `print-level' while printing value in `eval-expression'.
1450 A value of nil means no limit."
1456 "Value for `print-length' while printing value in `eval-expression'.
1457 A value of nil means no limit."
1463 "If non-nil set `debug-on-error' to t in `eval-expression'.
1464 If nil, don't change the value of `debug-on-error'."
1470 "The largest integer that will be displayed as a character.
1471 This affects printing by `eval-expression' (via
1472 `eval-expression-print-format')."
1478 "If VALUE in an integer, return a specially formatted string.
1480 If VALUE is not an integer, nil is returned.
1481 This function is used by commands like `eval-expression' that
1482 display the result of expression evaluation."
1500 ;; FIXME: call emacs-lisp-mode?
1508 read-expression-map t
1512 "Get arguments for commands that print an expression result.
1513 Returns a list (INSERT-VALUE NO-TRUNCATE CHAR-PRINT-LIMIT)
1514 based on PREFIX-ARG. This function determines the interpretation
1515 of the prefix argument for `eval-expression' and
1516 `eval-last-sexp'."
1524 ;; We define this, rather than making `eval' interactive,
1525 ;; for the sake of completion of names like eval-region, eval-buffer.
1527 "Evaluate EXP and print value in the echo area.
1528 When called interactively, read an Emacs Lisp expression and
1529 evaluate it. Value is also consed on to front of the variable
1530 `values'. Optional argument INSERT-VALUE non-nil (interactively,
1531 with a non `-' prefix argument) means insert the result into the
1532 current buffer instead of printing it in the echo area.
1534 Normally, this function truncates long output according to the
1535 value of the variables `eval-expression-print-length' and
1536 `eval-expression-print-level'. When NO-TRUNCATE is
1537 non-nil (interactively, with a prefix argument of zero), however,
1538 there is no such truncation.
1540 If the resulting value is an integer, and CHAR-PRINT-LIMIT is
1541 non-nil (interactively, unless given a positive prefix argument)
1542 it will be printed in several additional formats (octal,
1543 hexadecimal, and character). The character format is only used
1544 if the value is below CHAR-PRINT-LIMIT (interactively, if the
1545 prefix argument is -1 or the value is below
1546 `eval-expression-print-maximum-character').
1548 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1549 minibuffer.
1551 If `eval-expression-debug-on-error' is non-nil, which is the default,
1552 this command arranges for all errors to enter the debugger."
1560 ;; Bind debug-on-error to something unique so that we can
1561 ;; detect when evalled code changes it.
1565 ;; If evalled code has changed the value of debug-on-error,
1566 ;; propagate that change to the global binding.
1582 "Prompting with PROMPT, let user edit COMMAND and eval result.
1583 COMMAND is a Lisp expression. Let user edit that expression in
1584 the minibuffer, then read and evaluate the result."
1591 read-expression-map t
1593 ;; If command was added to command-history as a string,
1594 ;; get rid of that. We want only evaluable expressions there.
1598 ;; If command to be redone does not match front of history,
1599 ;; add it to the history.
1605 "Edit and re-evaluate last complex command, or ARGth from last.
1606 A complex command is one which used the minibuffer.
1607 The command is placed in the minibuffer as a Lisp form for editing.
1608 The result is executed, repeating the command as changed.
1609 If the command has been changed or is not the most recent previous
1610 command it is added to the front of the command history.
1611 You can use the minibuffer history commands \
1613 to get different commands to edit and resubmit."
1616 newcmd)
1628 ;; If command was added to command-history as a
1629 ;; string, get rid of that. We want only
1630 ;; evaluable expressions there.
1634 ;; If command to be redone does not match front of history,
1635 ;; add it to the history.
1650 "Read command name to invoke in `execute-extended-command'."
1660 ;; Get a command name at point in the original buffer
1661 ;; to propose it after M-n.
1665 ;; Read a string, completing from and restricting to the set of
1666 ;; all defined commands. Don't provide any initial input.
1667 ;; Save the command read on the extended-command history list.
1678 ;; This isn't strictly correct if `execute-extended-command'
1679 ;; is bound to anything else (e.g. [menu]).
1680 ;; It could use (key-description (this-single-command-keys)),
1681 ;; but actually a prompt other than "M-x" would be confusing,
1682 ;; because "M-x" is a well-known prompt to read a command
1683 ;; and it serves as a shorthand for "Extended command: ".
1688 ;; Exclude obsolete commands from completions.
1693 pred)))
1698 "Non-nil means show the equivalent key-binding when M-x command has one.
1699 The value can be a length of time to show the message for.
1700 If the value is non-nil and not a number, we wait 2 seconds."
1707 "If non-nil, show a shorter M-x invocation when there is one."
1728 binding)
1734 name len)))
1735 ;; Don't show the help message if the binding isn't
1736 ;; significantly shorter than the M-x command the user typed.
1744 binding))
1747 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1748 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1749 "Read a command name, then read the arguments and call the command.
1750 To pass a prefix argument to the command you are
1751 invoking, give a prefix argument to `execute-extended-command'."
1753 ;; FIXME: Remember the actual text typed by the user before completion,
1754 ;; so that we don't later on suggest the same shortening.
1759 execute-extended-command--last-typed)))
1760 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1772 ;; Some features, such as novice.el, rely on this-command-keys
1773 ;; including M-x COMMAND-NAME RET.
1776 ;; Normally `real-this-command' should never be changed, but here we really
1777 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1778 ;; binding" for <cmd>, so the command the user really wanted to run is
1779 ;; `function' and not `execute-extended-command'. The difference is
1780 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1784 ;; If enabled, show which key runs this command.
1785 ;; But first wait, and skip the message if there is input.
1787 ;; If this command displayed something in the echo area;
1788 ;; wait a few seconds, then display our suggestion message.
1789 ;; FIXME: Wait *after* running post-command-hook!
1790 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1791 ;; find a better answer anyway!
1801 ;; There's no binding for CMD. Let's try and find the shortest
1802 ;; string to use in M-x.
1803 ;; FIXME: Can be slow. Cache it maybe?
1810 function
1815 suggest-key-bindings
1819 ;; BEWARE: Called directly from the C code.
1820 "Execute CMD as an editor command.
1821 CMD must be a symbol that satisfies the `commandp' predicate.
1822 Optional second arg RECORD-FLAG non-nil
1823 means unconditionally put this command in the variable `command-history'.
1824 Otherwise, that is done only if an arg is read using the minibuffer.
1825 The argument KEYS specifies the value to use instead of (this-command-keys)
1826 when reading the arguments; if it is nil, (this-command-keys) is used.
1827 The argument SPECIAL, if non-nil, means that this command is executing
1828 a special event, so ignore the prefix argument and don't clear it."
1831 ;; FIXME: This should probably be done around
1832 ;; pre-command-hook rather than here!
1840 disabled-command-function)
1841 ;; FIXME: Weird calling convention!
1851 ;; If requested, place the macro in the command history. For
1852 ;; other sorts of commands, call-interactively takes care of this.
1855 ;; Don't keep command history around forever.
1861 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1869 \f
1871 "Default minibuffer history list.
1872 This is used for all minibuffer input
1873 except when an alternate history list is specified.
1875 Maximum length of the history list is determined by the value
1878 "Control whether history list elements are expressions or strings.
1879 If the value of this variable equals current minibuffer depth,
1880 they are expressions; otherwise they are strings.
1881 \(That convention is designed to do the right thing for
1888 "Text that was in this minibuffer before any history commands.
1889 This is nil if there have not yet been any history commands
1898 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1903 "Minibuffer history variables for which matching should ignore case.
1904 If a history variable is a member of this list, then the
1906 commands ignore case when searching it, regardless of `case-fold-search'."
1911 "Find the previous history element that matches REGEXP.
1912 \(Previous history elements refer to earlier actions.)
1913 With prefix argument N, search for Nth previous match.
1914 If N is negative, find the next or Nth next match.
1915 Normally, history elements are matched case-insensitively if
1916 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1917 makes the search case-sensitive.
1918 See also `minibuffer-history-case-insensitive-variables'."
1922 nil
1923 minibuffer-local-map
1924 nil
1925 'minibuffer-history-search-history
1927 ;; Use the last regexp specified, by default, if input is empty.
1932 regexp)
1942 ;; On some systems, ignore case for file names.
1944 minibuffer-history-case-insensitive-variables)
1945 t
1946 ;; Respect the user's setting for case-fold-search:
1947 case-fold-search)
1948 nil))
1949 prevpos
1950 match-string
1951 match-offset
1958 "No later matching history item"
1979 next-matching-history-element))
1983 "Find the next history element that matches REGEXP.
1984 \(The next history element refers to a more recent action.)
1985 With prefix argument N, search for Nth next match.
1986 If N is negative, find the previous or Nth previous match.
1987 Normally, history elements are matched case-insensitively if
1988 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1989 makes the search case-sensitive."
1993 nil
1994 minibuffer-local-map
1995 nil
1996 'minibuffer-history-search-history
1998 ;; Use the last regexp specified, by default, if input is empty.
2003 regexp)
2010 "Function run by `goto-history-element' before consuming default values.
2011 This is useful to dynamically add more elements to the list of default values
2012 when `goto-history-element' reaches the end of this list.
2013 Before calling this function `goto-history-element' sets the variable
2014 `minibuffer-default-add-done' to t, so it will call this function only
2015 once. In special cases, when this function needs to be called more
2016 than once, it can set `minibuffer-default-add-done' to nil explicitly,
2020 "When nil, add more elements to the end of the list of default values.
2021 The value nil causes `goto-history-element' to add more elements to
2022 the list of defaults when it reaches the end of this list. It does
2028 "Return a list of all completions without the default value.
2029 This function is used to add all elements of the completion table to
2030 the end of the list of defaults just after the default value."
2033 minibuffer-completion-table
2034 minibuffer-completion-predicate)))
2040 "Puts element of the minibuffer history in the minibuffer.
2041 The argument NABS specifies the absolute history position."
2055 elt minibuffer-returned-to-present)
2062 "End of defaults; no next item"
2069 previous-history-element))
2081 minibuffer-default)))
2093 elt))
2097 "Puts next element of the minibuffer history in the minibuffer.
2098 With argument N, it uses the Nth following element."
2104 "Puts previous element of the minibuffer history in the minibuffer.
2105 With argument N, it uses the Nth previous element."
2111 "Move cursor vertically down ARG lines, or to the next history element.
2112 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2113 next element of the minibuffer history in the minibuffer."
2117 ;; Don't add newlines if they have the mode enabled globally.
2119 ;; Remember the original goal column of possibly multi-line input
2120 ;; excluding the length of the prompt on the first line.
2130 ;; Restore old position since `line-move-visual' moves point to
2131 ;; the end of the line when it fails to go to the next line.
2134 ;; Reset `temporary-goal-column' because a correct value is not
2135 ;; calculated when `next-line' above fails by bumping against
2136 ;; the bottom of the minibuffer (bug#22544).
2138 ;; Restore the original goal column on the last line
2139 ;; of possibly multi-line input.
2147 "Move cursor vertically up ARG lines, or to the previous history element.
2148 When point moves over the top line of multi-line minibuffer, puts ARGth
2149 previous element of the minibuffer history in the minibuffer."
2153 ;; Remember the original goal column of possibly multi-line input
2154 ;; excluding the length of the prompt on the first line.
2164 ;; Restore old position since `line-move-visual' moves point to
2165 ;; the beginning of the line when it fails to go to the previous line.
2168 ;; Reset `temporary-goal-column' because a correct value is not
2169 ;; calculated when `previous-line' above fails by bumping against
2170 ;; the top of the minibuffer (bug#22544).
2172 ;; Restore the original goal column on the first line
2173 ;; of possibly multi-line input.
2179 ;; Put the cursor at the end of the visual line instead of the
2180 ;; logical line, so the next `previous-line-or-history-element'
2181 ;; would move to the previous history element, not to a possible upper
2182 ;; visual line from the end of logical line in `line-move-visual' mode.
2184 ;; Since `end-of-visual-line' puts the cursor at the beginning
2185 ;; of the next visual line, move it one char back to the end
2186 ;; of the first visual line (bug#22544).
2190 "Get next history element which completes the minibuffer before the point.
2191 The contents of the minibuffer after the point are deleted, and replaced
2192 by the new completion."
2198 n)
2199 ;; next-matching-history-element always puts us at (point-min).
2200 ;; Move to the position we were at before changing the buffer contents.
2201 ;; This is still sensible, because the text before point has not changed.
2205 "\
2206 Get previous history element which completes the minibuffer before the point.
2207 The contents of the minibuffer after the point are deleted, and replaced
2208 by the new completion."
2212 ;; For compatibility with the old subr of the same name.
2214 "Return the display width of the minibuffer prompt.
2215 Return 0 if current buffer is not a minibuffer."
2216 ;; Return the width of everything before the field at the end of
2217 ;; the buffer; this should be 0 for normal buffers.
2219 \f
2220 ;; isearch minibuffer history
2227 "Set up a minibuffer for using isearch to search the minibuffer history.
2228 Intended to be added to `minibuffer-setup-hook'."
2240 "Clean up the minibuffer after terminating isearch in the minibuffer."
2245 "Return the proper search function, for isearch in minibuffer history."
2248 ;; Use standard functions to search within minibuffer text
2250 found)
2251 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2252 ;; searching forward. Lazy-highlight calls this lambda with the
2253 ;; bound arg, so skip the minibuffer prompt.
2257 ;; 1. First try searching in the initial minibuffer text
2260 noerror)
2261 ;; 2. If the above search fails, start putting next/prev history
2262 ;; elements in the minibuffer successively, and search the string
2263 ;; in them. Do this only when bound is nil (i.e. not while
2264 ;; lazy-highlighting search strings in the current minibuffer text).
2276 ;; After putting the next/prev history element, search
2277 ;; the string in them again, until next-history-element
2278 ;; or previous-history-element raises an error at the
2279 ;; beginning/end of history.
2282 ;; For backward search, don't search
2283 ;; in the minibuffer prompt
2285 noerror)))
2286 ;; Return point of the new search result
2288 ;; Return nil when next(prev)-history-element fails
2292 "Display the minibuffer history search prompt.
2293 If there are no search errors, this function displays an overlay with
2294 the isearch prompt which replaces the original minibuffer prompt.
2295 Otherwise, it displays the standard isearch message returned from
2296 the function `isearch-message'."
2298 ;; Use standard function `isearch-message' when not in the minibuffer,
2299 ;; or search fails, or has an error (like incomplete regexp).
2300 ;; This function overwrites minibuffer text with isearch message,
2301 ;; so it's possible to see what is wrong in the search string.
2303 ;; Otherwise, put the overlay with the standard isearch prompt over
2304 ;; the initial minibuffer prompt.
2313 ;; And clear any previous isearch message.
2317 "Wrap the minibuffer history search when search fails.
2318 Move point to the first history element for a forward search,
2319 or to the last history element for a backward search."
2320 ;; When `minibuffer-history-isearch-search' fails on reaching the
2321 ;; beginning/end of the history, wrap the search to the first/last
2322 ;; minibuffer history element.
2330 "Save a function restoring the state of minibuffer history search.
2331 Save `minibuffer-history-position' to the additional state parameter
2332 in the search status stack."
2338 "Restore the minibuffer history search state.
2339 Go to the history element by the absolute history position HIST-POS."
2342 \f
2343 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2347 "Table mapping redo records to the corresponding undo one.
2348 A redo record for undo-in-region maps to t.
2358 "Within a run of consecutive undo commands, list remaining to be undone.
2362 "Undo some previous changes.
2363 Repeat this command to undo more changes.
2364 A numeric ARG serves as a repeat count.
2366 In Transient Mark mode when the mark is active, only undo changes within
2368 as an argument limits undo to changes within the current region."
2370 ;; Make last-command indicate for the next command that this was an undo.
2371 ;; That way, another undo will undo more.
2372 ;; If we get to the end of the undo history and get an error,
2373 ;; another undo command will find the undo history empty
2374 ;; and will get another error. To begin undoing the undos,
2375 ;; you must type some other command.
2377 ;; For an indirect buffer, look in the base buffer for the
2378 ;; auto-save data.
2382 message)
2383 ;; If we get an error in undo-start,
2384 ;; the next command should not be a "consecutive undo".
2385 ;; So set `this-command' to something other than `undo'.
2390 ;; If something (a timer or filter?) changed the buffer
2391 ;; since the previous command, don't continue the undo seq.
2395 ;; If the last undo record made was made by undo
2396 ;; it shows nothing else happened in between.
2403 ;; get rid of initial undo boundary
2405 ;; If we got this far, the next command should be a consecutive undo.
2407 ;; Check to see whether we're hitting a redo record, and if
2408 ;; so, ask the user whether she wants to skip the redo/undo pair.
2416 ;; The equiv entry might point to another redo record if we have done
2417 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2425 ;; Record the fact that the just-generated undo records come from an
2426 ;; undo operation--that is, they are redo records.
2427 ;; In the ordinary case (not within a region), map the redo
2428 ;; record to the following undos.
2429 ;; I don't know how to do that in the undo-in-region case.
2431 ;; Strip any leading undo boundaries there might be, like we do
2432 ;; above when checking.
2436 ;; Prevent identity mapping. This can happen if
2437 ;; consecutive nils are erroneously in undo list.
2439 t
2440 pending-undo-list)
2441 undo-equiv-table))
2442 ;; Don't specify a position in the undo record for the undo command.
2443 ;; Instead, undoing this should move point to where the change is.
2462 ;; Record what the current undo list says,
2463 ;; so the next command can tell if the buffer was modified in between.
2467 ;; Display a message announcing success.
2472 "Make BUFFER stop keeping undo information.
2473 No argument or nil as argument means do this for the current buffer."
2479 "Undo some previous changes.
2480 Repeat this command to undo more changes.
2481 A numeric ARG serves as a repeat count.
2482 Contrary to `undo', this will not redo a previous undo."
2487 "Non-nil while performing an undo.
2491 "Undo back N undo-boundaries beyond what was already undone recently.
2492 Call `undo-start' to get ready to undo recent changes,
2493 then call `undo-more' one or more times to undo them."
2498 ;; Note: The following, while pulling elements off
2499 ;; `pending-undo-list' will call primitive change functions which
2500 ;; will push more elements onto `buffer-undo-list'.
2506 "Undo N records from the front of the list LIST.
2507 Return what remains of the list."
2509 ;; This is a good feature, but would make undo-start
2510 ;; unable to do what is expected.
2511 ;;(when (null (car (list)))
2512 ;; ;; If the head of the list is a boundary, it is the boundary
2513 ;; ;; preceding this command. Get rid of it and don't count it.
2514 ;; (setq list (cdr list))))
2517 ;; In a writable buffer, enable undoing read-only text that is
2518 ;; so because of text properties.
2520 ;; Don't let `intangible' properties interfere with undo.
2522 ;; We use oldlist only to check for EQ. ++kfs
2528 ;; Handle an integer by setting point to that value.
2531 ;; Element (t . TIME) records previous modtime.
2532 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2533 ;; UNKNOWN_MODTIME_NSECS.
2535 ;; If this records an obsolete save
2536 ;; (not matching the actual disk file)
2537 ;; then don't mark unmodified.
2545 ;; Element (nil PROP VAL BEG . END) is property change.
2550 ;; Element (BEG . END) means range was inserted.
2552 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2553 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2556 ;; Set point first thing, so that undoing this undo
2557 ;; does not send point back to where it is now.
2560 ;; Element (apply FUN . ARGS) means call FUN to undo.
2564 ;; Long format: (apply DELTA START END FUN . ARGS).
2571 ;; Check that the function did what the entry
2572 ;; said it would do.
2582 ;; Element (STRING . POS) means STRING was deleted.
2588 ;; Check that marker adjustments which were recorded
2589 ;; with the (STRING . POS) record are still valid, ie
2590 ;; the markers haven't moved. We check their validity
2591 ;; before reinserting the string so as we don't need to
2592 ;; mind marker insertion-type.
2600 ;; Insert string and adjust point
2608 ;; Adjust the valid marker adjustments
2610 ;; Insert might have invalidated some of the markers
2611 ;; via modification hooks. Update only the currently
2612 ;; valid ones (bug#25599).
2616 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2619 next)
2620 ;; Even though these elements are not expected in the undo
2621 ;; list, adjust them to be conservative for the 24.4
2622 ;; release. (Bug#16818)
2629 ;; Make sure an apply entry produces at least one undo entry,
2630 ;; so the test in `undo' for continuing an undo series
2631 ;; will work right.
2636 list)
2638 ;; Deep copy of a list
2640 "Make a copy of undo list LIST."
2646 elt))
2649 "Set `pending-undo-list' to the front of the undo list.
2650 The next call to `undo-more' will undo the most recently made change.
2651 If BEG and END are specified, then only undo elements
2652 that apply to text between BEG and END are used; other undo elements
2653 are ignored. If BEG and END are nil, all undo elements are used."
2659 buffer-undo-list)))
2661 ;; The positions given in elements of the undo list are the positions
2662 ;; as of the time that element was recorded to undo history. In
2663 ;; general, subsequent buffer edits render those positions invalid in
2664 ;; the current buffer, unless adjusted according to the intervening
2665 ;; undo elements.
2666 ;;
2667 ;; Undo in region is a use case that requires adjustments to undo
2668 ;; elements. It must adjust positions of elements in the region based
2669 ;; on newer elements not in the region so as they may be correctly
2670 ;; applied in the current buffer. undo-make-selective-list
2671 ;; accomplishes this with its undo-deltas list of adjustments. An
2672 ;; example undo history from oldest to newest:
2673 ;;
2674 ;; buf pos:
2675 ;; 123456789 buffer-undo-list undo-deltas
2676 ;; --------- ---------------- -----------
2677 ;; aaa (1 . 4) (1 . -3)
2678 ;; aaba (3 . 4) N/A (in region)
2679 ;; ccaaba (1 . 3) (1 . -2)
2680 ;; ccaabaddd (7 . 10) (7 . -3)
2681 ;; ccaabdd ("ad" . 6) (6 . 2)
2682 ;; ccaabaddd (6 . 8) (6 . -2)
2683 ;; | |<-- region: "caab", from 2 to 6
2684 ;;
2685 ;; When the user starts a run of undos in region,
2686 ;; undo-make-selective-list is called to create the full list of in
2687 ;; region elements. Each element is adjusted forward chronologically
2688 ;; through undo-deltas to determine if it is in the region.
2689 ;;
2690 ;; In the above example, the insertion of "b" is (3 . 4) in the
2691 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2692 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2693 ;; . 6) is assessed as in the region and placed in the selective list.
2694 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2695 ;; due to the selected element. The "b" insertion is the only element
2696 ;; fully in the region, so in this example undo-make-selective-list
2697 ;; returns (nil (5 . 6)).
2698 ;;
2699 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2700 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2701 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2702 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2703 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2704 ;;
2705 ;; More interesting is how to adjust the "ddd" insertion due to the
2706 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2707 ;; If the reinsertion was a manual retyping of "ad", then the total
2708 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2709 ;; the reinsertion was due to undo, one might expect the first "d"
2710 ;; character would again be a part of the "ddd" text, meaning its
2711 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2712 ;;
2713 ;; undo-make-selective-list assumes in this situation that "ad" was a
2714 ;; new edit, even if it was inserted because of an undo.
2715 ;; Consequently, if the user undos in region "8 to 10" of the
2716 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2717 ;; "ccaabad", as though the first "d" became detached from the
2718 ;; original "ddd" insertion. This quirk is a FIXME.
2721 "Return a list of undo elements for the region START to END.
2722 The elements come from `buffer-undo-list', but we keep only the
2723 elements inside this region, and discard those outside this
2724 region. The elements' positions are adjusted so as the returned
2725 list can be applied to the current buffer."
2727 ;; A list of position adjusted undo elements in the region.
2729 ;; A list of undo-deltas for out of region undo elements.
2730 undo-deltas
2731 undo-elt)
2739 ;; Don't put two nils together in the list
2743 ;; This is a "was unmodified" element. Keep it
2744 ;; if we have kept everything thus far.
2747 ;; Skip over marker adjustments, instead relying
2748 ;; on finding them after (TEXT . POS) elements
2750 nil)
2753 undo-deltas)))
2758 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2759 ;; kept. primitive-undo may discard them later.
2772 "Determine whether UNDO-ELT falls inside the region START ... END.
2773 If it crosses the edge, we return nil.
2775 Generally this function is not useful for determining
2776 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2777 because markers can be arbitrarily relocated. Instead, pass the
2778 marker adjustment's corresponding (TEXT . POS) element."
2783 t)
2785 nil)
2787 ;; (TEXT . POSITION)
2791 ;; (MARKER . ADJUSTMENT)
2794 ;; (nil PROPERTY VALUE BEG . END)
2799 ;; (BEGIN . END)
2804 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2805 This assumes we have already decided that UNDO-ELT
2806 is not *inside* the region START...END."
2810 ;; (nil PROPERTY VALUE BEG . END)
2815 ;; (BEGIN . END)
2820 "Return adjustment of undo element ELT by the undo DELTAS
2821 list."
2823 ;; POSITION
2826 ;; (BEG . END)
2829 ;; (TEXT . POSITION)
2833 ;; (nil PROPERTY VALUE BEG . END)
2836 ;; (apply DELTA START END FUN . ARGS)
2837 ;; FIXME
2838 ;; All others return same elt
2841 ;; (BEG . END) can adjust to the same positions, commonly when an
2842 ;; insertion was undone and they are out of region, for example:
2843 ;;
2844 ;; buf pos:
2845 ;; 123456789 buffer-undo-list undo-deltas
2846 ;; --------- ---------------- -----------
2847 ;; [...]
2848 ;; abbaa (2 . 4) (2 . -2)
2849 ;; aaa ("bb" . 2) (2 . 2)
2850 ;; [...]
2851 ;;
2852 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2853 ;; undo. Further adjustments to such an element should be the same as
2854 ;; for (TEXT . POSITION) elements. The options are:
2855 ;;
2856 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2857 ;; analogous to marker insertion-type t.
2858 ;;
2859 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2860 ;; marker insertion-type nil.
2861 ;;
2862 ;; There was no strong reason to prefer one or the other, except that
2863 ;; the first is more consistent with prior undo in region behavior.
2865 "Return cons of adjustments to BEG and END by the undo DELTAS
2866 list."
2868 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2873 "Return adjustment of POS by the undo DELTAS list, comparing
2874 with < or <= based on USE-<."
2880 ;; Don't allow pos to become less than the undo-delta
2881 ;; position. This edge case is described in the overview
2882 ;; comments.
2885 ;; Return the first affected buffer position and the delta for an undo element
2886 ;; delta is defined as the change in subsequent buffer positions if we *did*
2887 ;; the undo.
2891 ;; (TEXT . POSITION)
2894 ;; (BEGIN . END)
2900 ;;; Default undo-boundary addition
2901 ;;
2902 ;; This section adds a new undo-boundary at either after a command is
2903 ;; called or in some cases on a timer called after a change is made in
2904 ;; any buffer.
2906 "Describe the cause of the last undo-boundary.
2908 If `explicit', the last boundary was caused by an explicit call to
2909 `undo-boundary', that is one not called by the code in this
2910 section.
2912 If it is equal to `timer', then the last boundary was inserted
2913 by `undo-auto--boundary-timer'.
2915 If it is equal to `command', then the last boundary was inserted
2916 automatically after a command, that is by the code defined in
2917 this section.
2919 If it is equal to a list, then the last boundary was inserted by
2920 an amalgamating command. The car of the list is the number of
2921 times an amalgamating command has been called, and the cdr are the
2925 "Current timer which will run `undo-auto--boundary-timer' or nil.
2930 "Non-nil if `this-command' should be amalgamated.
2931 This variable is set to nil by `undo-auto--boundaries' and is set
2935 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2939 "Return the number of amalgamating last commands or nil.
2940 Amalgamating commands are, by default, either
2941 `self-insert-command' and `delete-char', but can be any command
2942 that calls `undo-auto-amalgamate'."
2946 "Add an `undo-boundary' to the current buffer if needed.
2947 REASON describes the reason that the boundary is being added; see
2948 `undo-auto--last-boundary' for more information."
2958 undo-auto--undoably-changed-buffers)
2959 cause)))))
2962 "Check recently changed buffers and add a boundary if necessary.
2963 REASON describes the reason that the boundary is being added; see
2964 `undo-last-boundary' for more information."
2965 ;; (Bug #23785) All commands should ensure that there is an undo
2966 ;; boundary whether they have changed the current buffer or not.
2976 "Timer which will run `undo--auto-boundary-timer'."
2981 "Ensure that the `undo-auto-boundary-timer' is set."
2987 "List of buffers that have changed recently.
2989 This list is maintained by `undo-auto--undoable-change' and
2990 `undo-auto--boundaries' and can be affected by changes to their
2994 "Add an `undo-boundary' in appropriate buffers."
2999 'amalgamate
3003 "Amalgamate undo if necessary.
3004 This function can be called before an amalgamating command. It
3005 removes the previous `undo-boundary' if a series of such calls
3006 have been made. By default `self-insert-command' and
3007 `delete-char' are the only amalgamating commands, although this
3008 function could be called by any command wishing to have this
3009 behavior."
3014 last-amalgamating-count
3019 ;; Amalgamate all buffers that have changed.
3023 b
3025 ;; The head of `buffer-undo-list' is nil.
3026 ;; `car-safe' doesn't work because
3027 ;; `buffer-undo-list' need not be a list!
3035 "Called after every undoable buffer change."
3038 ;; End auto-boundary section
3041 "Amalgamate changes in change-group since HANDLE.
3042 Remove all undo boundaries between the state of HANDLE and now.
3043 HANDLE is as returned by `prepare-change-group'."
3052 ;; Temporarily truncate the undo log at ELT.
3057 ;; `elt' is still in the log: normal case.
3059 ;; `elt' is not in the log any more, but that's because
3060 ;; the log is "all new", so we should remove all
3061 ;; boundaries from it.
3065 buffer-undo-list
3066 ;; Preserve the undo-boundaries at either ends of the
3067 ;; change-groups.
3069 ;; Reset the modified cons cell ELT to its original content.
3076 "If non-nil ask about discarding undo info for the current command.
3077 Normally, Emacs discards the undo info for the current command if
3078 it exceeds `undo-outer-limit'. But if you set this option
3079 non-nil, it asks in the echo area whether to discard the info.
3080 If you answer no, there is a slight risk that Emacs might crash, so
3081 only do it if you really want to undo the command.
3083 This option is mainly intended for debugging. You have to be
3084 careful if you use it for other purposes. Garbage collection is
3085 inhibited while the question is asked, meaning that Emacs might
3086 leak memory. So you should make sure that you do not wait
3087 excessively long before answering the question."
3093 "If non-nil, an extra level of size that's ok in an undo item.
3094 We don't ask the user about truncating the undo list until the
3095 current item gets bigger than this amount.
3100 ;; When the first undo batch in an undo list is longer than
3101 ;; undo-outer-limit, this function gets called to warn the user that
3102 ;; the undo info for the current command was discarded. Garbage
3103 ;; collection is inhibited around the call, so it had better not do a
3104 ;; lot of consing.
3110 ;; Don't ask the question again unless it gets even bigger.
3111 ;; This applies, in particular, if the user quits from the question.
3112 ;; Such a quit quits out of GC, but something else will call GC
3113 ;; again momentarily. It will call this function again,
3114 ;; but we don't want to ask the question again.
3118 "Buffer `%s' undo info is %d bytes long; discard it? "
3122 t)
3123 nil))
3129 "The undo info was discarded because it exceeded \
3130 `undo-outer-limit'.
3132 This is normal if you executed a command that made a huge change
3133 to the buffer. In that case, to prevent similar problems in the
3134 future, set `undo-outer-limit' to a value that is large enough to
3135 cover the maximum size of normal changes you expect a single
3136 command to make, but not so large that it might exceed the
3137 maximum memory allotted to Emacs.
3139 If you did not execute any such command, the situation is
3140 probably due to a bug and you should report it.
3142 You can disable the popping up of this buffer by adding the entry
3143 \(undo discard-info) to the user option `warning-suppress-types',
3147 t))
3148 \f
3151 ; These are sorted according to the GNU en_US locale.
3194 )
3196 This is used by Shell mode and other parts of Emacs to recognize
3197 password prompts, including prompts in languages other than
3198 English. Different case choices should not be assumed to be
3199 included; callers should bind `case-fold-search' to t."
3205 "History list for some commands that read shell commands.
3207 Maximum length of the history list is determined by the value
3214 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3215 This buffer is used when `shell-command' or `shell-command-on-region'
3216 is run interactively. A value of nil means that output to stderr and
3223 "Return a list of all commands associated with the current file.
3224 This function is used to add all related commands retrieved by `mailcap'
3225 to the end of the list of defaults just after the default value."
3229 minibuffer-default))
3234 commands))
3245 map)
3249 "Read a shell command from the minibuffer.
3250 The arguments are the same as the ones of `read-from-minibuffer',
3251 except READ and KEYMAP are missing and HIST defaults
3252 to `shell-command-history'."
3260 minibuffer-local-shell-command-map
3261 nil
3263 args)))
3266 "What to do when the output buffer is used by another shell command.
3267 This option specifies how to resolve the conflict where a new command
3268 wants to direct its output to the buffer `*Async Shell Command*',
3269 but this buffer is already taken by another running shell command.
3271 The value `confirm-kill-process' is used to ask for confirmation before
3272 killing the already running process and running a new process
3273 in the same buffer, `confirm-new-buffer' for confirmation before running
3274 the command in a new buffer with a name other than the default buffer name,
3275 `new-buffer' for doing the same without confirmation,
3276 `confirm-rename-buffer' for confirmation before renaming the existing
3277 output buffer and running a new command in the default buffer,
3278 `rename-buffer' for doing the same without confirmation."
3280 confirm-kill-process)
3282 confirm-new-buffer)
3284 new-buffer)
3286 confirm-rename-buffer)
3288 rename-buffer))
3293 "Whether to display the command buffer immediately.
3294 If t, display the buffer immediately; if nil, wait until there
3295 is output."
3297 t)
3299 nil))
3304 "Store a buffer position or erase the buffer.
3305 See `shell-command-dont-erase-buffer'."
3307 pos)
3309 ;; Setting buffer-read-only to nil doesn't suffice
3310 ;; if some text has a non-nil read-only property,
3311 ;; which comint sometimes adds for prompts.
3321 shell-command-saved-pos))))
3324 "Set point in BUFFER after command complete.
3325 BUFFER is the output buffer of the command; if nil, then defaults
3326 to the current BUFFER.
3327 Set point to the `cdr' of the element in `shell-command-saved-pos'
3328 whose `car' is BUFFER."
3340 ;; Set point in the window displaying buf, if any; otherwise
3341 ;; display buf temporary in selected frame and set the point.
3346 buf
3351 "Execute string COMMAND asynchronously in background.
3353 Like `shell-command', but adds `&' at the end of COMMAND
3354 to execute it asynchronously.
3356 The output appears in the buffer `*Async Shell Command*'.
3357 That buffer is in shell mode.
3359 You can configure `async-shell-command-buffer' to specify what to do in
3360 case when `*Async Shell Command*' buffer is already taken by another
3361 running shell command. To run COMMAND without displaying the output
3362 in a window you can configure `display-buffer-alist' to use the action
3363 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3365 In Elisp, you will often be better served by calling `start-process'
3366 directly, since it offers more control and does not impose the use of a
3367 shell (with its need to quote arguments)."
3377 current-prefix-arg
3378 shell-command-default-error-buffer))
3384 "Execute string COMMAND in inferior shell; display output, if any.
3385 With prefix argument, insert the COMMAND's output at point.
3387 Interactively, prompt for COMMAND in the minibuffer.
3389 If COMMAND ends in `&', execute it asynchronously.
3390 The output appears in the buffer `*Async Shell Command*'.
3391 That buffer is in shell mode. You can also use
3392 `async-shell-command' that automatically adds `&'.
3394 Otherwise, COMMAND is executed synchronously. The output appears in
3395 the buffer `*Shell Command Output*'. If the output is short enough to
3396 display in the echo area (which is determined by the variables
3397 `resize-mini-windows' and `max-mini-window-height'), it is shown
3398 there, but it is nonetheless available in buffer `*Shell Command
3399 Output*' even though that buffer is not automatically displayed.
3401 To specify a coding system for converting non-ASCII characters
3403 before this command.
3405 Noninteractive callers can specify coding systems by binding
3406 `coding-system-for-read' and `coding-system-for-write'.
3408 The optional second argument OUTPUT-BUFFER, if non-nil,
3409 says to put the output in some other buffer.
3410 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3411 and insert the output there; a non-nil value of
3412 `shell-command-dont-erase-buffer' prevents the buffer from being
3413 erased. If OUTPUT-BUFFER is not a buffer and not nil, insert the
3414 output in current buffer after point leaving mark after it. This
3415 cannot be done asynchronously.
3417 If the command terminates without error, but generates output,
3419 the output can be displayed in the echo area or in its buffer.
3420 If the output is short enough to display in the echo area
3421 \(determined by the variable `max-mini-window-height' if
3422 `resize-mini-windows' is non-nil), it is shown there.
3423 Otherwise, the buffer containing the output is displayed.
3427 of the output.
3429 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3430 or buffer name to which to direct the command's standard error output.
3431 If it is nil, error output is mingled with regular output.
3432 In an interactive call, the variable `shell-command-default-error-buffer'
3433 specifies the value of ERROR-BUFFER.
3435 In Elisp, you will often be better served by calling `call-process' or
3436 `start-process' directly, since it offers more control and does not impose
3437 the use of a shell (with its need to quote arguments)."
3448 current-prefix-arg
3449 shell-command-default-error-buffer))
3450 ;; Look for a handler in case default-directory is a remote file name.
3458 ;; Output goes in current buffer.
3464 temporary-file-directory)))
3465 nil)))
3468 ;; We do not use -f for csh; we will not support broken use of
3469 ;; .cshrcs. Even the BSD csh manual says to use
3470 ;; "if ($?prompt) exit" before things which are not useful
3471 ;; non-interactively. Besides, if someone wants their other
3472 ;; aliases for shell commands then they can still have them.
3476 t)
3477 nil shell-command-switch command)
3484 ;; Do no formatting while reading error file,
3485 ;; because that can run a shell command, and we
3486 ;; don't want that to cause an infinite recursion.
3488 ;; Put point after the inserted errors.
3492 ;; This is like exchange-point-and-mark, but doesn't
3493 ;; activate the mark. It is cleaner to avoid activation,
3494 ;; even though the command loop would deactivate the mark
3495 ;; because we inserted text.
3499 ;; Output goes in a separate buffer.
3500 ;; Preserve the match data in case called from a program.
3501 ;; FIXME: It'd be ridiculous for an Elisp function to call
3502 ;; shell-command and assume that it won't mess the match-data!
3505 ;; Command ending with ampersand means asynchronous.
3510 proc)
3511 ;; Remove the ampersand.
3513 ;; Ask the user what to do with already running process.
3518 ;; If will kill a process, query first.
3523 ;; If will create a new buffer, query first.
3528 ;; It will create a new buffer.
3531 ;; If will rename the buffer, query first.
3539 ;; It will rename the buffer.
3547 shell-command-switch command))
3551 ;; Use the comint filter for proper handling of
3552 ;; carriage motion (see comint-inhibit-carriage-motion).
3561 bname))
3563 ;; Otherwise, command is executed synchronously.
3565 output-buffer nil error-buffer)))))))
3568 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3569 MESSAGE may be either a string or a buffer.
3571 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3572 for maximum height of the echo area, as defined by `max-mini-window-height'
3573 if `resize-mini-windows' is non-nil.
3575 Returns either the string shown in the echo area, or when a pop-up
3576 buffer is used, the window used to display it.
3578 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3579 name of the buffer used to display it in the case where a pop-up buffer
3580 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3581 string and it is displayed in the echo area, it is not specified whether
3582 the contents are inserted into the buffer anyway.
3584 Optional arguments ACTION and FRAME are as for `display-buffer',
3585 and are only used if a pop-up buffer is displayed."
3587 ;; Trivial case where we can use the echo area
3591 ;; Trivial case where we can just remove single trailing newline
3594 ;; General case
3597 message
3606 0
3610 (<= lines
3614 max-mini-window-height))
3616 max-mini-window-height)
3620 ;; Don't use the echo area if the output buffer is
3621 ;; already displayed in the selected frame.
3623 ;; Echo area
3629 ;; Buffer
3634 ;; We have a sentinel to prevent insertion of a termination message
3635 ;; in the buffer itself, and to set the point in the buffer when
3636 ;; `shell-command-dont-erase-buffer' is non-nil.
3645 &optional output-buffer replace
3646 error-buffer display-error-buffer
3647 region-noncontiguous-p)
3648 "Execute string COMMAND in inferior shell with region as input.
3649 Normally display output (if any) in temp buffer `*Shell Command Output*';
3650 Prefix arg means replace the region with it. Return the exit code of
3651 COMMAND.
3653 To specify a coding system for converting non-ASCII characters
3655 before this command. By default, the input (from the current buffer)
3656 is encoded using coding-system specified by `process-coding-system-alist',
3657 falling back to `default-process-coding-system' if no match for COMMAND
3658 is found in `process-coding-system-alist'.
3660 Noninteractive callers can specify coding systems by binding
3661 `coding-system-for-read' and `coding-system-for-write'.
3663 If the command generates output, the output may be displayed
3664 in the echo area or in a buffer.
3665 If the output is short enough to display in the echo area
3666 \(determined by the variable `max-mini-window-height' if
3667 `resize-mini-windows' is non-nil), it is shown there.
3668 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3669 The output is available in that buffer in both cases.
3671 If there is output and an error, a message about the error
3672 appears at the end of the output.
3674 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3675 command's output. If the value is a buffer or buffer name,
3676 erase that buffer and insert the output there; a non-nil value of
3677 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3678 If the value is nil, use the buffer `*Shell Command Output*'.
3679 Any other non-nil value means to insert the output in the
3680 current buffer after START.
3682 Optional fifth arg REPLACE, if non-nil, means to insert the
3683 output in place of text from START to END, putting point and mark
3684 around it.
3686 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3687 or buffer name to which to direct the command's standard error
3688 output. If nil, error output is mingled with regular output.
3689 When called interactively, `shell-command-default-error-buffer'
3690 is used for ERROR-BUFFER.
3692 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3693 display the error buffer if there were any errors. When called
3694 interactively, this is t."
3698 ;; Do this before calling region-beginning
3699 ;; and region-end, in case subprocess output
3700 ;; relocates them while we are in the minibuffer.
3702 ;; call-interactively recognizes region-beginning and
3703 ;; region-end specially, leaving them in the history.
3705 string
3706 current-prefix-arg
3707 current-prefix-arg
3708 shell-command-default-error-buffer
3709 t
3716 temporary-file-directory)))
3717 nil))
3718 exit-status)
3719 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3722 output)
3726 shell-file-name t t
3727 nil shell-command-switch
3728 command)
3735 ;; Replace specified region with output from command.
3737 ;; Don't muck with mark unless REPLACE says we should.
3744 t)))
3745 ;; It is rude to delete a buffer which the command is not using.
3746 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3747 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3748 ;; (kill-buffer shell-buffer)))
3749 ;; Don't muck with mark unless REPLACE says we should.
3751 ;; No prefix argument: put the output in a temp buffer,
3752 ;; replacing its entire contents.
3760 ;; If the input is the same buffer as the output,
3761 ;; delete everything but the specified region,
3762 ;; then replace that region with the output.
3768 shell-file-name t
3771 t)
3772 nil shell-command-switch
3773 command)))
3774 ;; Clear the output buffer, then run the command with
3775 ;; output there.
3785 buffer))))
3786 ;; Report the output.
3796 ;; There's some output, display it
3800 ;; No output; error?
3807 shell-command-default-error-buffer)
3814 output))
3817 exit-status))
3820 exit-status output))))
3821 ;; Don't kill: there might be useful info in the undo-log.
3822 ;; (kill-buffer buffer)
3823 )))))
3831 ;; Do no formatting while reading error file,
3832 ;; because that can run a shell command, and we
3833 ;; don't want that to cause an infinite recursion.
3835 ;; Put point after the inserted errors.
3840 exit-status))
3843 "Execute shell command COMMAND and return its output as a string."
3846 standard-output
3850 "Process files synchronously in a separate process.
3851 Similar to `call-process', but may invoke a file handler based on
3852 `default-directory'. The current working directory of the
3853 subprocess is `default-directory'.
3855 File names in INFILE and BUFFER are handled normally, but file
3856 names in ARGS should be relative to `default-directory', as they
3857 are passed to the process verbatim. (This is a difference to
3858 `call-process' which does not support file handlers for INFILE
3859 and BUFFER.)
3861 Some file handlers might not support all variants, for example
3862 they might behave as if DISPLAY was nil, regardless of the actual
3863 value passed."
3865 lc stderr-file)
3875 display args)
3881 "Whether a call of `process-file' changes remote files.
3883 By default, this variable is always set to t, meaning that a
3884 call of `process-file' could potentially change any file on a
3885 remote host. When set to nil, a file handler could optimize
3886 its behavior with respect to remote file attribute caching.
3888 You should only ever change this variable with a let-binding;
3892 "Start a program in a subprocess. Return the process object for it.
3894 Similar to `start-process', but may invoke a file handler based on
3895 `default-directory'. See Info node `(elisp)Magic File Names'.
3897 This handler ought to run PROGRAM, perhaps on the local host,
3898 perhaps on a remote host that corresponds to `default-directory'.
3899 In the latter case, the local part of `default-directory' becomes
3900 the working directory of the process.
3902 PROGRAM and PROGRAM-ARGS might be file names. They are not
3903 objects of file handler invocation. File handlers might not
3904 support pty association, if PROGRAM is nil."
3908 \f
3909 ;;;; Process menu
3923 map))
3926 "Major mode for listing the processes called by Emacs."
3930 ;; 25 is the length of the long standard buffer
3931 ;; name "*Async Shell Command*<10>" (bug#30016)
3940 "Kill process at point in a `list-processes' buffer."
3951 "Recompute the list of processes for the Process List buffer.
3952 Also, delete any process that is exited or signaled."
3966 face link
3968 "Visit buffer `%s'"
3970 follow-link t
3971 process-buffer ,buf
3972 action process-menu-visit-buffer)
3981 "datagram"
3998 tabulated-list-entries)))))
4005 "Display a list of all processes that are Emacs sub-processes.
4006 If optional argument QUERY-ONLY is non-nil, only processes with
4007 the query-on-exit flag set are listed.
4008 Any process listed as exited or signaled is actually eliminated
4009 after the listing is made.
4010 Optional argument BUFFER specifies a buffer to use, instead of
4012 The return value is always nil.
4014 This function lists only processes that were launched by Emacs. To
4015 see other processes running on the system, use `list-system-processes'."
4027 nil)
4028 \f
4029 ;;;; Prefix commands
4035 ;; BEWARE: Called directly from C code.
4036 ;; If the return value is non-nil, it means we are in the middle of
4037 ;; a command with prefix, such as a command invoked with prefix-arg.
4039 prefix-command--last-echo
4048 "Abnormal hook which constructs the description of the current prefix state.
4052 "Update state of prefix commands.
4060 "Pass the current prefix command state to the next command.
4061 Should be called by all prefix commands.
4062 Runs `prefix-command-preserve-state-hook'."
4064 ;; If the current command is a prefix command, we don't want the next (real)
4065 ;; command to have `last-command' set to, say, `universal-argument'.
4072 nil)
4074 ;;;;; The main prefix command.
4076 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
4101 ;; For backward compatibility, minus with no modifiers is an ordinary
4102 ;; command if digits have already been entered.
4132 map)
4140 "Begin a numeric argument for the following command.
4145 multiplies the argument by 4 each time.
4147 which is different in effect from any particular numeric argument.
4155 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
4156 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
4163 arg)))
4167 "Begin a negative numeric argument for the next command.
4177 "Part of the numeric argument for the next command.
4182 last-command-event
4189 ;; Treat -0 as just -, so that -01 will work.
4192 digit))))
4194 \f
4197 "This variable is a wrapper hook around `buffer-substring--filter'.
4203 "Function to perform the filtering in `filter-buffer-substring'.
4204 The function is called with the same 3 arguments (BEG END DELETE)
4205 that `filter-buffer-substring' received. It should return the
4206 buffer substring between BEG and END, after filtering. If DELETE is
4210 "List of filter functions for `buffer-substring--filter'.
4211 Each function must accept a single argument, a string, and return a string.
4212 The buffer substring is passed to the first function in the list,
4213 and the return value of each function is passed to the next.
4214 As a special convention, point is set to the start of the buffer text
4215 being operated on (i.e., the first argument of `buffer-substring--filter')
4221 "Return the buffer substring between BEG and END, after filtering.
4222 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4224 This calls the function that `filter-buffer-substring-function' specifies
4225 \(passing the same three arguments that it received) to do the work,
4226 and returns whatever it does. The default function does no filtering,
4227 unless a hook has been set.
4229 Use `filter-buffer-substring' instead of `buffer-substring',
4230 `buffer-substring-no-properties', or `delete-and-extract-region' when
4231 you want to allow filtering to take place. For example, major or minor
4232 modes can use `filter-buffer-substring-function' to extract characters
4233 that are special to a buffer, and should not be copied into other buffers."
4237 "Default function to use for `filter-buffer-substring-function'.
4238 Its arguments and return value are as specified for `filter-buffer-substring'.
4239 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4240 \(see `with-wrapper-hook' for details about wrapper hooks),
4241 and the abnormal hook `buffer-substring-filters'.
4242 No filtering is done unless a hook says to."
4253 string)))
4258 ;;;; Window system cut and paste hooks.
4261 "Function to call to make a killed region available to other programs.
4262 Most window systems provide a facility for cutting and pasting
4263 text between different programs, such as the clipboard on X and
4264 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4266 This variable holds a function that Emacs calls whenever text is
4267 put in the kill ring, to make the new kill available to other
4268 programs. The function takes one argument, TEXT, which is a
4272 "Function to call to get text cut from other programs.
4273 Most window systems provide a facility for cutting and pasting
4274 text between different programs, such as the clipboard on X and
4275 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4277 This variable holds a function that Emacs calls to obtain text
4278 that other programs have provided for pasting. The function is
4279 called with no arguments. If no other program has provided text
4280 to paste, the function should return nil (in which case the
4281 caller, usually `current-kill', should use the top of the Emacs
4282 kill ring). If another program has provided text to paste, the
4283 function should return that text as a string (in which case the
4284 caller should put this string in the kill ring as the latest
4285 kill).
4287 The function may also return a list of strings if the window
4288 system supports multiple selections. The first string will be
4289 used as the pasted text, but the other will be placed in the kill
4290 ring for easy access via `yank-pop'.
4292 Note that the function should return a string only if a program
4293 other than Emacs has provided a string for pasting; if Emacs
4294 provided the most recent string, the function should return nil.
4295 If it is difficult to tell whether Emacs or some other program
4296 provided the current string, it is probably good enough to return
4297 nil if the string is equal (according to `string=') to the last
4299 \f
4302 ;;;; The kill ring data structure.
4305 "List of killed text sequences.
4306 Since the kill ring is supposed to interact nicely with cut-and-paste
4307 facilities offered by window systems, use of this variable should
4308 interact nicely with `interprogram-cut-function' and
4309 `interprogram-paste-function'. The functions `kill-new',
4310 `kill-append', and `current-kill' are supposed to implement this
4311 interaction; you may want to use them instead of manipulating the kill
4315 "Maximum length of kill ring before oldest elements are thrown away."
4323 "Save clipboard strings into kill ring before replacing them.
4324 When one selects something in another program to paste it into Emacs,
4325 but kills something in Emacs before actually pasting it,
4326 this selection is gone unless this variable is non-nil,
4327 in which case the other program's selection is saved in the `kill-ring'
4334 "Do not add a new string to `kill-ring' if it duplicates the last one.
4335 The comparison is done using `equal-including-properties'."
4341 "Make STRING the latest kill in the kill ring.
4342 Set `kill-ring-yank-pointer' to point to it.
4343 If `interprogram-cut-function' is non-nil, apply it to STRING.
4344 Optional second argument REPLACE non-nil means that STRING will replace
4345 the front of the kill ring, rather than being added to the list.
4347 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4348 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4349 STRING.
4351 When the yank handler has a non-nil PARAM element, the original STRING
4352 argument is not used by `insert-for-yank'. However, since Lisp code
4353 may access and use elements from the kill ring directly, the STRING
4356 ;; Due to text properties such as 'yank-handler that
4357 ;; can alter the contents to yank, comparison using
4358 ;; `equal' is unsafe.
4383 ;; It has been argued that this should work similar to `self-insert-command'
4384 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4386 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4392 "Append STRING to the end of the latest kill in the kill ring.
4393 If BEFORE-P is non-nil, prepend STRING to the kill.
4394 Also removes the last undo boundary in the current buffer,
4395 depending on `kill-append-merge-undo'.
4396 If `interprogram-cut-function' is set, pass the resulting kill to it."
4404 ;; find the next undo boundary
4408 ;; remove this undo boundary
4413 "Whether rotating the kill ring changes the window system selection.
4414 If non-nil, whenever the kill ring is rotated (usually via the
4415 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4416 to copy the new kill to the window system selection."
4422 "Rotate the yanking point by N places, and then return that kill.
4423 If N is zero and `interprogram-paste-function' is set to a
4424 function that returns a string or a list of strings, and if that
4425 function doesn't return nil, then that string (or list) is added
4426 to the front of the kill ring and the string (or first string in
4427 the list) is returned as the latest kill.
4429 If N is not zero, and if `yank-pop-change-selection' is
4430 non-nil, use `interprogram-cut-function' to transfer the
4431 kill at the new yank point into the window system selection.
4433 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4434 move the yanking point; just return the Nth kill forward."
4437 interprogram-paste-function
4441 ;; Disable the interprogram cut function when we add the new
4442 ;; text to the kill ring, so Emacs doesn't try to own the
4443 ;; selection, with identical text.
4453 kill-ring)))
4458 interprogram-cut-function)
4464 ;;;; Commands for manipulating the kill ring.
4467 "Non-nil means don't signal an error for killing read-only text."
4473 This deletes the text from the buffer and saves it in the kill ring.
4477 If you want to append the killed region to the last killed text,
4481 If the previous command was also a kill command,
4482 the text killed this time appends to the text killed last time
4483 to make one entry in the kill ring.
4485 The killed text is filtered by `filter-buffer-substring' before it is
4486 saved in the kill ring, so the actual saved text might be different
4487 from what was killed.
4489 If the buffer is read-only, Emacs will beep and refrain from deleting
4490 the text, but put the text in the kill ring anyway. This means that
4491 you can use the killing commands to copy text from a read-only buffer.
4493 Lisp programs should use this function for killing text.
4494 (To delete text, use `delete-region'.)
4495 Supply two arguments, character positions BEG and END indicating the
4496 stretch of text to be killed. If the optional argument REGION is
4497 non-nil, the function ignores BEG and END, and kills the current
4498 region instead."
4499 ;; Pass mark first, then point, because the order matters when
4500 ;; calling `kill-append'.
4509 ;; Add that string to the kill ring, one way or another.
4516 nil)
4518 ;; The code above failed because the buffer, or some of the characters
4519 ;; in the region, are read-only.
4520 ;; We should beep, in case the user just isn't aware of this.
4521 ;; However, there's no harm in putting
4522 ;; the region's text in the kill ring, anyway.
4524 ;; Set this-command now, so it will be set even if we get an error.
4526 ;; This should barf, if appropriate, and give us the correct error.
4529 ;; Signal an error if the buffer is read-only.
4531 ;; If the buffer isn't read-only, the text is.
4534 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4535 ;; to get two copies of the text when the user accidentally types M-w and
4536 ;; then corrects it with the intended C-w.
4538 "Save the region as if killed, but don't kill it.
4539 In Transient Mark mode, deactivate the mark.
4540 If `interprogram-cut-function' is non-nil, also save the text for a window
4541 system cut and paste.
4543 The copied text is filtered by `filter-buffer-substring' before it is
4544 saved in the kill ring, so the actual saved text might be different
4545 from what was in the buffer.
4547 When called from Lisp, save in the kill ring the stretch of text
4548 between BEG and END, unless the optional argument REGION is
4549 non-nil, in which case ignore BEG and END, and save the current
4550 region instead.
4552 This command's old key binding has been given to `kill-ring-save'."
4553 ;; Pass mark first, then point, because the order matters when
4554 ;; calling `kill-append'.
4564 nil)
4567 "Save the region as if killed, but don't kill it.
4568 In Transient Mark mode, deactivate the mark.
4569 If `interprogram-cut-function' is non-nil, also save the text for a window
4570 system cut and paste.
4572 If you want to append the killed line to the last killed text,
4575 The copied text is filtered by `filter-buffer-substring' before it is
4576 saved in the kill ring, so the actual saved text might be different
4577 from what was in the buffer.
4579 When called from Lisp, save in the kill ring the stretch of text
4580 between BEG and END, unless the optional argument REGION is
4581 non-nil, in which case ignore BEG and END, and save the current
4582 region instead.
4584 This command is similar to `copy-region-as-kill', except that it gives
4585 visual feedback indicating the extent of the region being copied."
4586 ;; Pass mark first, then point, because the order matters when
4587 ;; calling `kill-append'.
4591 ;; This use of called-interactively-p is correct because the code it
4592 ;; controls just gives the user visual feedback.
4597 "Indicate that the region text has been copied interactively.
4598 If the mark is visible in the selected window, blink the cursor
4599 between point and mark if there is currently no active region
4600 highlighting.
4602 If the mark lies outside the selected window, display an
4603 informative message containing a sample of the copied text. The
4604 optional argument MESSAGE-LEN, if non-nil, specifies the length
4605 of this sample text; it defaults to 40."
4608 ;; Inhibit quitting so we can make a quit here
4609 ;; look like a C-g typed as a command.
4612 ;; Swap point-and-mark quickly so as to show the region that
4613 ;; was selected. Don't do it if the region is highlighted.
4616 ;; Swap point and mark.
4620 ;; Swap back.
4623 ;; If user quit, deactivate the mark
4624 ;; as C-g would as a command.
4630 ;; Don't say "killed"; that is misleading.
4637 "Cause following command, if it kills, to add to previous kill.
4638 If the next command kills forward from point, the kill is
4639 appended to the previous killed text. If the command kills
4640 backward, the kill is prepended. Kill commands that act on the
4641 region, such as `kill-region', are regarded as killing forward if
4642 point is after mark, and killing backward if point is before
4643 mark.
4645 If the next command is not a kill command, `append-next-kill' has
4646 no effect.
4648 The argument is used for internal purposes; do not supply one."
4650 ;; We don't use (interactive-p), since that breaks kbd macros.
4664 "A subroutine of `squeeze-bidi-context'.
4665 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4669 lim1)
4676 ;; L and R categories include embedding and
4677 ;; override controls, but we don't want to
4678 ;; replace them, because that might change
4679 ;; the visual order. Likewise with PDF and
4680 ;; isolate controls.
4682 bidi-directional-non-controls-chars
4683 limit)))))
4684 ;; Replace any run of non-RTL characters by a single LRM.
4686 ;; No more characters of CATEGORY, we are done.
4691 ;; Skip directional controls, if any.
4696 "Replace characters between FROM and TO while keeping bidi context.
4698 This function replaces the region of text with as few characters
4699 as possible, while preserving the effect that region will have on
4700 bidirectional display before and after the region."
4704 ;; This is for when they copy text with read-only text
4705 ;; properties.
4709 ;; Replace each run of non-RTL characters with a single LRM.
4711 ;; Replace each run of non-LTR characters with a single RLM. Note
4712 ;; that the \cR category includes both the Arabic Letter (AL) and
4713 ;; R characters; here we ignore the distinction between them,
4714 ;; because that distinction only affects Arabic Number (AN)
4715 ;; characters, which are weak and don't affect the reordering.
4719 "Return buffer text between START and END with its bidi context.
4721 START and END are assumed to belong to the same physical line
4722 of buffer text. This function prepends and appends to the text
4723 between START and END bidi control characters that preserve the
4724 visual order of that text when it is inserted at some other place."
4729 substr para-dir from to)
4736 ;; If we don't have any mixed directional characters in the
4737 ;; entire line, we can just copy the substring without adding
4738 ;; any context.
4753 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4754 ;; (1) force the string to have the same base embedding
4755 ;; direction as the paragraph direction at the source, no matter
4756 ;; what is the paragraph direction at destination; and (2) avoid
4757 ;; affecting the visual order of the surrounding text at
4758 ;; destination if there are characters of different
4759 ;; directionality there.
4764 "Return portion of current buffer between START and END with bidi context.
4766 This function works similar to `buffer-substring', but it prepends and
4767 appends to the text bidi directional control characters necessary to
4768 preserve the visual appearance of the text if it is inserted at another
4769 place. This is useful when the buffer substring includes bidirectional
4770 text and control characters that cause non-trivial reordering on display.
4771 If copied verbatim, such text can have a very different visual appearance,
4772 and can also change the visual appearance of the surrounding text at the
4773 destination of the copy.
4775 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4776 the text properties."
4789 no-properties)))
4793 substr)))
4794 \f
4795 ;; Yanking.
4800 "List of special text property handling conditions for yanking.
4801 Each element should have the form (PROP . FUN), where PROP is a
4802 property symbol and FUN is a function. When the `yank' command
4803 inserts text into the buffer, it scans the inserted text for
4804 stretches of text that have `eq' values of the text property
4805 PROP; for each such stretch of text, FUN is called with three
4806 arguments: the property's value in that text, and the start and
4807 end positions of the text.
4809 This is done prior to removing the properties specified by
4810 `yank-excluded-properties'."
4813 function))
4816 ;; This is actually used in subr.el but defcustom does not work there.
4819 intangible invisible keymap local-map mouse-face read-only
4820 yank-handler)
4821 "Text properties to discard when yanking.
4822 The value should be a list of text properties to discard or t,
4823 which means to discard all text properties.
4825 See also `yank-handled-properties'."
4832 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4833 Function is called with two parameters, START and END corresponding to
4834 the value of the mark and point; it is guaranteed that START <= END.
4838 "Replace just-yanked stretch of killed text with a different stretch.
4839 This command is allowed only immediately after a `yank' or a `yank-pop'.
4840 At such a time, the region contains a stretch of reinserted
4841 previously-killed text. `yank-pop' deletes that text and inserts in its
4842 place a different stretch of killed text.
4844 With no argument, the previous kill is inserted.
4845 With argument N, insert the Nth previous kill.
4846 If N is negative, this is a more recent kill.
4848 The sequence of kills wraps around, so that after the oldest one
4849 comes the newest one.
4851 This command honors the `yank-handled-properties' and
4852 `yank-excluded-properties' variables, and the `yank-handler' text
4853 property, in the way that `yank' does."
4867 ;; Set the window start back where it was in the yank command,
4868 ;; if possible.
4871 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4872 ;; It is cleaner to avoid activation, even though the command
4873 ;; loop would deactivate the mark because we inserted text.
4876 nil)
4880 More precisely, reinsert the most recent kill, which is the
4881 stretch of killed text most recently killed OR yanked. Put point
4882 at the end, and set mark at the beginning without activating it.
4884 With argument N, reinsert the Nth most recent kill.
4886 This command honors the `yank-handled-properties' and
4887 `yank-excluded-properties' variables, and the `yank-handler' text
4888 property, as described below.
4890 Properties listed in `yank-handled-properties' are processed,
4891 then those listed in `yank-excluded-properties' are discarded.
4893 If STRING has a non-nil `yank-handler' property anywhere, the
4894 normal insert behavior is altered, and instead, for each contiguous
4895 segment of STRING that has a given value of the `yank-handler'
4896 property, that value is used as follows:
4898 The value of a `yank-handler' property must be a list of one to four
4899 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
4900 FUNCTION, if non-nil, should be a function of one argument (the
4901 object to insert); FUNCTION is called instead of `insert'.
4902 PARAM, if present and non-nil, is passed to FUNCTION (to be handled
4903 in whatever way is appropriate; e.g. if FUNCTION is `yank-rectangle',
4904 PARAM may be a list of strings to insert as a rectangle). If PARAM
4905 is nil, then the current segment of STRING is used.
4906 If NOEXCLUDE is present and non-nil, the normal removal of
4907 `yank-excluded-properties' is not performed; instead FUNCTION is
4908 responsible for the removal. This may be necessary if FUNCTION
4909 adjusts point before or after inserting the object.
4910 UNDO, if present and non-nil, should be a function to be called
4911 by `yank-pop' to undo the insertion of the current PARAM. It is
4912 given two arguments, the start and end of the region. FUNCTION
4913 may set `yank-undo-function' to override UNDO.
4918 ;; If we don't get all the way thru, make last-command indicate that
4919 ;; for the following command.
4927 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4928 ;; It is cleaner to avoid activation, even though the command
4929 ;; loop would deactivate the mark because we inserted text.
4932 ;; If we do get all the way thru, make this-command indicate that.
4935 nil)
4938 "Rotate the yanking point in the kill ring.
4939 With ARG, rotate that many kills forward (or backward, if negative)."
4942 \f
4943 ;; Some kill commands.
4945 ;; Internal subroutine of delete-char
4951 ;; Internal subroutine of backward-delete-char
4958 "The method for untabifying when deleting backward.
4959 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4960 `hungry' -- delete all whitespace, both tabs and spaces;
4961 `all' -- delete all whitespace, including tabs, spaces and newlines;
4962 nil -- just delete one character."
4968 "Delete characters backward, changing tabs into spaces.
4969 The exact behavior depends on `backward-delete-char-untabify-method'.
4970 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4971 Interactively, ARG is the prefix arg (default 1)
4972 and KILLP is t if a prefix arg was specified."
4995 arg)))
4996 ;; Avoid warning about delete-backward-char
5000 "Kill up to and including ARGth occurrence of CHAR.
5001 Case is ignored if `case-fold-search' is non-nil in the current buffer.
5002 Goes backward if ARG is negative; error if CHAR not found."
5005 ;; Avoid "obsolete" warnings for translation-table-for-input.
5013 ;; kill-line and its subroutines.
5016 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
5021 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
5022 With prefix argument ARG, kill that many lines from point.
5023 Negative arguments kill lines backward.
5024 With zero argument, kills the text before point on the current line.
5027 a number counts as a prefix arg.
5029 To kill a whole line, when point is not at the beginning, type \
5032 If `show-trailing-whitespace' is non-nil, this command will just
5033 kill the rest of the current line, even if there are no nonblanks
5034 there.
5036 If option `kill-whole-line' is non-nil, then this command kills the whole line
5037 including its terminating newline, when used at the beginning of a line
5038 with no argument. As a consequence, you can always kill a whole line
5041 If you want to append the killed line to the last killed text,
5044 If the buffer is read-only, Emacs will beep and refrain from deleting
5045 the line, but put the line in the kill ring anyway. This means that
5046 you can use this command to copy text from a read-only buffer.
5047 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5048 even beep.)"
5051 ;; It is better to move point to the other end of the kill
5052 ;; before killing. That way, in a read-only buffer, point
5053 ;; moves across the text that is copied to the kill ring.
5054 ;; The choice has no effect on undo now that undo records
5055 ;; the value of point from before the command was run.
5065 ;; If trailing whitespace is visible,
5066 ;; don't treat it as nothing.
5076 "Kill current line.
5077 With prefix ARG, kill that many lines starting from the current line.
5078 If ARG is negative, kill backward. Also kill the preceding newline.
5080 If ARG is zero, kill current line but exclude the trailing newline."
5091 ;; We need to kill in two steps, because the previous command
5092 ;; could have been a kill command, in which case the text
5093 ;; before point needs to be prepended to the current kill
5094 ;; ring entry and the text after point appended. Also, we
5095 ;; need to use save-excursion to avoid copying the same text
5096 ;; twice to the kill ring in read-only buffers.
5114 "Move forward by ARG lines, ignoring currently invisible newlines only.
5115 If ARG is negative, move backward -ARG lines.
5116 If ARG is zero, move to the beginning of the current line."
5123 ;; If the newline we just skipped is invisible,
5124 ;; don't count it.
5128 prop
5133 ;; If invisible text follows, and it is a number of complete lines,
5134 ;; skip it.
5140 prop
5156 ;; If the newline we just moved to is invisible,
5157 ;; don't count it.
5162 prop
5167 ;; If invisible text follows, and it is a number of complete lines,
5168 ;; skip it.
5174 prop
5185 nil)))
5188 "Move to end of current visible line."
5190 ;; If the following character is currently invisible,
5191 ;; skip all characters with that same `invisible' property value,
5192 ;; then find the next newline.
5199 prop
5210 "Kill the current buffer.
5211 When called in the minibuffer, get out of the minibuffer
5212 using `abort-recursive-edit'.
5214 This is like `kill-this-buffer', but it doesn't have to be invoked
5215 via the menu bar, and pays no attention to the menu-bar's frame."
5223 \f
5225 "Insert after point the contents of BUFFER.
5226 Puts mark after the inserted text.
5227 BUFFER may be a buffer or a buffer name."
5237 t))))
5242 nil)
5245 "Append to specified buffer the text of the region.
5246 It is inserted into that buffer before its point.
5248 When calling from a program, give three arguments:
5249 BUFFER (or buffer name), START and END.
5250 START and END specify the portion of the current buffer to be copied."
5257 point)
5268 "Prepend to specified buffer the text of the region.
5269 It is inserted into that buffer after its point.
5271 When calling from a program, give three arguments:
5272 BUFFER (or buffer name), START and END.
5273 START and END specify the portion of the current buffer to be copied."
5282 "Copy to specified buffer the text of the region.
5283 It is inserted into that buffer, replacing existing text there.
5285 When calling from a program, give three arguments:
5286 BUFFER (or buffer name), START and END.
5287 START and END specify the portion of the current buffer to be copied."
5295 \f
5299 "Hook run when the mark becomes active.
5300 It is also run at the end of a command, if the mark is active and
5307 "Return this buffer's mark value as integer, or nil if never set.
5309 In Transient Mark mode, this function signals an error if
5310 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5311 or the argument FORCE is non-nil, it disregards whether the mark
5312 is active, and returns an integer or nil in the usual way.
5314 If you are using this in an editing command, you are most likely making
5315 a mistake; see the documentation of `set-mark'."
5320 ;; Behind display-selections-p.
5323 "Deactivate the mark.
5324 If Transient Mark mode is disabled, this function normally does
5325 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5327 Deactivating the mark sets `mark-active' to nil, updates the
5328 primary selection according to `select-active-regions', and runs
5329 `deactivate-mark-hook'.
5331 If Transient Mark mode was temporarily enabled, reset the value
5332 of the variable `transient-mark-mode'; if this causes Transient
5333 Mark mode to be disabled, don't change `mark-active' to nil or
5334 run `deactivate-mark-hook'."
5338 select-active-regions)
5341 ;; The var `saved-region-selection', if non-nil, is the text in
5342 ;; the region prior to the last command modifying the buffer.
5343 ;; Set the selection to that, or to the current region.
5348 ;; If another program has acquired the selection, region
5349 ;; deactivation should not clobber it (Bug#11772).
5368 "Activate the mark.
5369 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5379 "Set this buffer's mark to POS. Don't use this function!
5380 That is to say, don't use this function unless you want
5381 the user to see that the mark has moved, and you want the previous
5382 mark position to be lost.
5384 Normally, when a new mark is set, the old one should go on the stack.
5385 This is why most applications should use `push-mark', not `set-mark'.
5387 Novice Emacs Lisp programmers often try to use the mark for the wrong
5388 purposes. The mark saves a location for the user's convenience.
5389 Most editing commands should not alter the mark.
5390 To remember a location for internal use in the Lisp program,
5391 store it in a Lisp variable. Example:
5393 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5398 ;; Normally we never clear mark-active except in Transient Mark mode.
5399 ;; But when we actually clear out the mark value too, we must
5400 ;; clear mark-active in any mode.
5402 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5403 ;; it should never be nil if the mark is nil.
5411 mark-active))
5418 ;; Mark marker
5424 ;; Mark active
5427 ;; If mark is active now, and either was not active or was at a
5428 ;; different place, run the activate hook.
5433 ;; If mark has ceased to be active, run deactivate hook.
5438 "Like `save-excursion', but also save and restore the mark state.
5439 This macro does what `save-excursion' did before Emacs 25.1."
5449 If nil, region-aware commands treat the empty region as inactive.
5450 If non-nil, region-aware commands treat the region as active as
5451 long as the mark is active, even if the region is empty.
5453 Region-aware commands are those that act on the region if it is
5454 active and Transient Mark mode is enabled, and on the text near
5455 point otherwise."
5461 "Return t if the region is active and it is appropriate to act on it.
5462 This is used by commands that act specially on the region under
5463 Transient Mark mode.
5465 The return value is t if Transient Mark mode is enabled and the
5466 mark is active; furthermore, if `use-empty-active-region' is nil,
5467 the region must not be empty. Otherwise, the return value is nil.
5469 For some commands, it may be appropriate to ignore the value of
5470 `use-empty-active-region'; in that case, use `region-active-p'."
5475 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5477 Some commands act specially on the region when Transient Mark
5478 mode is enabled. Usually, such commands should use
5479 `use-region-p' instead of this function, because `use-region-p'
5480 also checks the value of `use-empty-active-region'."
5482 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5483 ;; without the mark being set (e.g. bug#17324). We really should fix
5484 ;; that problem, but in the mean time, let's make sure we don't say the
5485 ;; region is active when there's no mark.
5489 "Return the boundaries of the region as a pair of positions.
5490 Value is a list of cons cells of the form (START . END)."
5494 "Return non-nil if the region contains several pieces.
5495 An example is a rectangular region handled as a list of
5496 separate contiguous regions for each line."
5509 ;; Normal priority so that a large region doesn't hide all the
5510 ;; overlays within it, but high secondary priority so that if it
5511 ;; ends/starts in the middle of a small overlay, that small overlay
5512 ;; won't hide the region's boundaries.
5514 nrol)
5519 rol)))
5535 start end window rol)))
5538 new))))))
5541 "Hook run just before redisplay.
5542 It is called in each window that is to be redisplayed. It takes one argument,
5543 which is the window that will be redisplayed. When run, the `current-buffer'
5564 "Maximum size of mark ring. Start discarding off end if gets this big."
5572 "Maximum size of global mark ring. \
5573 Start discarding off end if gets this big."
5578 "Jump to mark, and pop a new position for mark off the ring.
5579 \(Does not affect global mark ring)."
5589 "Set mark at where point is.
5590 If no prefix ARG and mark is already set there, just activate it.
5591 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5603 will pop the mark twice, and
5605 will pop the mark three times.
5613 "Set the mark where point is, and activate it; or jump to the mark.
5614 Setting the mark also alters the region, which is the text
5615 between point and mark; this is the closest equivalent in
5618 With no prefix argument, set the mark at point, and push the
5619 old mark position on local mark ring. Also push the new mark on
5620 global mark ring, if the previous mark was set in another buffer.
5622 When Transient Mark Mode is off, immediately repeating this
5623 command activates `transient-mark-mode' temporarily.
5626 jump to the mark, and set the mark from
5627 position popped off the local mark ring (this does not affect the global
5629 mark ring (see `pop-global-mark').
5631 If `set-mark-command-repeat-pop' is non-nil, repeating
5633 off the local (or global) mark ring and jumps there.
5636 argument, unconditionally set mark where point is, even if
5637 `set-mark-command-repeat-pop' is non-nil.
5639 Novice Emacs Lisp programmers often try to use the mark for the wrong
5640 purposes. See the documentation of `set-mark' for more information."
5660 arg)
5674 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5675 If the last global mark pushed was not in the current buffer,
5676 also push LOCATION on the global mark ring.
5677 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5679 Novice Emacs Lisp programmers often try to use the mark for the wrong
5680 purposes. See the documentation of `set-mark' for more information.
5682 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5689 ;; Now push the mark on the global mark ring.
5692 ;; The last global mark pushed was in this same buffer.
5693 ;; Don't push another one.
5694 nil
5703 nil)
5706 "Pop off mark ring into the buffer's actual mark.
5707 Does not set point. Does nothing if mark ring is empty."
5719 "Put the mark where point is now, and point where the mark is now.
5720 This command works even when the mark is not active,
5721 and it reactivates the mark.
5723 If Transient Mark mode is on, a prefix ARG deactivates the mark
5724 if it is active, and otherwise avoids reactivating it. If
5725 Transient Mark mode is off, a prefix ARG enables Transient Mark
5726 mode temporarily."
5740 nil))
5743 "When non-nil, shifted motion keys activate the mark momentarily.
5745 While the mark is activated in this way, any shift-translated point
5746 motion key extends the region, and if Transient Mark mode was off, it
5747 is temporarily turned on. Furthermore, the mark will be deactivated
5748 by any subsequent point motion key that was not shift-translated, or
5749 by any action that normally deactivates the mark in Transient Mark mode.
5751 See `this-command-keys-shift-translated' for the meaning of
5752 shift-translation."
5757 "Activate/deactivate mark depending on invocation thru shift translation.
5758 This function is called by `call-interactively' when a command
5759 with a `^' character in its `interactive' spec is invoked, before
5760 running the command itself.
5762 If `shift-select-mode' is enabled and the command was invoked
5763 through shift translation, set the mark and activate the region
5764 temporarily, unless it was already set in this way. See
5765 `this-command-keys-shift-translated' for the meaning of shift
5766 translation.
5768 Otherwise, if the region has been activated temporarily,
5769 deactivate it, and restore the variable `transient-mark-mode' to
5770 its earlier value."
5777 transient-mark-mode)))
5786 "Toggle Transient Mark mode.
5787 With a prefix argument ARG, enable Transient Mark mode if ARG is
5788 positive, and disable it otherwise. If called from Lisp, enable
5789 Transient Mark mode if ARG is omitted or nil.
5791 Transient Mark mode is a global minor mode. When enabled, the
5792 region is highlighted with the `region' face whenever the mark
5794 and after certain other operations that set the mark but whose
5795 main purpose is something else--for example, incremental search,
5801 Many commands change their behavior when Transient Mark mode is
5802 in effect and the mark is active, by acting on the region instead
5803 of their usual default part of the buffer's text. Examples of
5806 To see the documentation of commands which are sensitive to the
5809 :global t
5810 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5814 "Non-nil means it is ok for commands to call `widen' when they want to.
5815 Some commands will do this in order to go to positions outside
5816 the current accessible part of the buffer.
5818 If `widen-automatically' is nil, these commands will do something else
5822 "Whether the currently executing code is performing an essential task.
5823 This variable should be non-nil only when running code which should not
5824 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5825 user for a password when we are simply scanning a set of files in the
5826 background or displaying possible completions before the user even asked
5830 "Pop off global mark ring and jump to the top location."
5832 ;; Pop entries which refer to non-existent buffers.
5850 \f
5852 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5858 "Move cursor vertically down ARG lines.
5859 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5860 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5861 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5862 function will not vscroll.
5864 ARG defaults to 1.
5866 If there is no character in the target line exactly under the current column,
5867 the cursor is positioned after the character in that line which spans this
5868 column, or at the end of the line if it is not long enough.
5869 If there is no line in the buffer after this one, behavior depends on the
5870 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5871 to create a line, and moves the cursor to that line. Otherwise it moves the
5872 cursor to the end of the buffer.
5874 If the variable `line-move-visual' is non-nil, this command moves
5875 by display lines. Otherwise, it moves by buffer lines, without
5876 taking variable-width characters or continued lines into account.
5880 a semipermanent goal column for this command.
5881 Then instead of trying to move exactly vertically (or as close as possible),
5882 this command moves to the specified goal column (or as close as possible).
5883 The goal column is stored in the variable `goal-column', which is nil
5884 when there is no goal column. Note that setting `goal-column'
5885 overrides `line-move-visual' and causes this command to move by buffer
5886 lines rather than by display lines."
5892 ;; When adding a newline, don't expand an abbrev.
5903 nil)
5906 "Move cursor vertically up ARG lines.
5907 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5908 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5909 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5910 function will not vscroll.
5912 ARG defaults to 1.
5914 If there is no character in the target line exactly over the current column,
5915 the cursor is positioned after the character in that line which spans this
5916 column, or at the end of the line if it is not long enough.
5918 If the variable `line-move-visual' is non-nil, this command moves
5919 by display lines. Otherwise, it moves by buffer lines, without
5920 taking variable-width characters or continued lines into account.
5924 a semipermanent goal column for this command.
5925 Then instead of trying to move exactly vertically (or as close as possible),
5926 this command moves to the specified goal column (or as close as possible).
5927 The goal column is stored in the variable `goal-column', which is nil
5928 when there is no goal column. Note that setting `goal-column'
5929 overrides `line-move-visual' and causes this command to move by buffer
5930 lines rather than by display lines."
5941 nil)
5944 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5945 This means moving to the end of each line moved onto.
5946 The beginning of a blank line does not count as the end of a line.
5947 This has no effect when the variable `line-move-visual' is non-nil."
5953 A non-nil setting overrides the variable `line-move-visual', which see."
5960 "Current goal column for vertical motion.
5961 It is the column where point was at the start of the current run
5962 of vertical motion commands.
5964 When moving by visual lines via the function `line-move-visual', it is a cons
5965 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5966 divided by the default column width, and HSCROLL is the number of
5967 columns by which window is scrolled from left margin.
5969 When the `track-eol' feature is doing its job, the value is
5973 "Last value of width used for displaying line numbers.
5977 "Non-nil means commands that move by lines ignore invisible newlines.
5978 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5979 as if newlines that are invisible didn't exist, and count
5980 only visible newlines. Thus, moving across 2 newlines
5981 one of which is invisible will be counted as a one-line move.
5982 Also, a non-nil value causes invisible text to be ignored when
5983 counting columns for the purposes of keeping point in the same
5986 Outline mode sets this."
5991 "When non-nil, `line-move' moves point by visual lines.
5992 This movement is based on where the cursor is displayed on the
5993 screen, instead of relying on buffer contents alone. It takes
5994 into account variable-width characters and line continuation.
5995 If nil, `line-move' moves point by logical lines.
5996 A non-nil setting of `goal-column' overrides the value of this variable
5997 and forces movement by logical lines.
5998 A window that is horizontally scrolled also forces movement by logical
5999 lines."
6004 ;; Only used if display-graphic-p.
6008 "Return the height in pixels of the current buffer's default face font.
6010 If the default font is remapped (see `face-remapping-alist'), the
6011 function returns the height of the remapped face."
6015 ;; Avoid calling font-info if the frame's default font was
6016 ;; not changed since the frame was created. That's because
6017 ;; font-info is expensive for some fonts, see bug #14838.
6023 "Return the width in pixels of the current buffer's default face font.
6025 If the default font is remapped (see `face-remapping-alist'), the
6026 function returns the width of the remapped face."
6030 ;; Avoid calling font-info if the frame's default font was
6031 ;; not changed since the frame was created. That's because
6032 ;; font-info is expensive for some fonts, see bug #14838.
6037 width
6042 "Return the pixel height of current buffer's default-face text line.
6044 The value includes `line-spacing', if any, defined for the buffer
6045 or the frame."
6058 "Return the number of screen lines in the text area of the selected window.
6060 This is different from `window-text-height' in that this function counts
6061 lines in units of the height of the font used by the default face displayed
6062 in the window, not in units of the frame's default font, and also accounts
6063 for `line-spacing', if any, defined for the window's buffer or frame.
6065 The value is a floating-point number."
6070 ;; Returns non-nil if partial move was done.
6073 ;; Move backward (up).
6074 ;; If already vscrolled, reduce vscroll
6080 ;; Move forward (down).
6093 py vs last-line)
6113 col-row)
6118 ;; VPOS > 0 means the last line is only partially visible.
6119 ;; But if the part that is visible is at least as tall as the
6120 ;; default font, that means the line is actually fully
6121 ;; readable, and something like line-spacing is hidden. So in
6122 ;; that case we accept the last line in the window as still
6123 ;; visible, and consider the margin as starting one line
6124 ;; later.
6132 ;; If last line of window is fully visible, and vscrolling
6133 ;; more would make this line invisible, move forward.
6138 nil)
6139 ;; If cursor is not in the bottom scroll margin, and the
6140 ;; current line is not too tall, move forward.
6142 vpos
6145 nil)
6146 ;; When already vscrolled, we vscroll some more if we can,
6147 ;; or clear vscroll and move forward at end of tall image.
6152 ;; If cursor just entered the bottom scroll margin, move forward,
6153 ;; but also optionally vscroll one line so redisplay won't recenter.
6157 ;; Don't vscroll if the partially-visible line at window
6158 ;; bottom is not too tall (a.k.a. "just one more text
6159 ;; line"): in that case, we do want redisplay to behave
6160 ;; normally, i.e. recenter or whatever.
6161 ;;
6162 ;; Note: ROWH + RBOT from the value returned by
6163 ;; pos-visible-in-window-p give the total height of the
6164 ;; partially-visible glyph row at the end of the window. As
6165 ;; we are dealing with floats, we disregard sub-pixel
6166 ;; discrepancies between that and DLH.
6170 t)
6171 ;; If there are lines above the last line, scroll-up one line.
6174 t)
6175 ;; Finally, start vscroll.
6180 ;; This is like line-move-1 except that it also performs
6181 ;; vertical scrolling of tall images if appropriate.
6182 ;; That is not really a clean thing to do, since it mixes
6183 ;; scrolling with cursor motion. But so far we don't have
6184 ;; a cleaner solution to the problem of making C-n do something
6185 ;; useful given a tall image.
6187 "Move forward ARG lines.
6188 If NOERROR, don't signal an error if we can't move ARG lines.
6189 TO-END is unused.
6190 TRY-VSCROLL controls whether to vscroll tall lines: if either
6191 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6192 not vscroll."
6196 ;; Only vscroll for single line moves
6198 ;; Under scroll-conservatively, the display engine
6199 ;; does this better.
6201 ;; But don't vscroll in a keyboard macro.
6207 ;; Display-based column are incompatible with goal-column.
6209 ;; When the text in the window is scrolled to the left,
6210 ;; display-based motion doesn't make sense (because each
6211 ;; logical line occupies exactly one screen line).
6213 ;; Likewise when the text _was_ scrolled to the left
6214 ;; when the current run of vertical motion commands
6215 ;; started.
6218 auto-hscroll-mode
6220 (>= temporary-goal-column
6223 ;; If we moved into a tall line, set vscroll to make
6224 ;; scrolling through tall images more smooth.
6228 winh)
6234 nil
6238 ;; Display-based alternative to line-move-1.
6239 ;; Arg says how many lines to move. The value is t if we can move the
6240 ;; specified number of lines.
6242 "Move ARG lines forward.
6243 If NOERROR, don't signal an error if we can't move that many lines."
6247 target-hscroll)
6248 ;; Check if the previous command was a line-motion command, or if
6249 ;; we were called from some other command.
6252 ;; If so, there's no need to reset `temporary-goal-column',
6253 ;; but we may need to hscroll.
6258 ;; Update the COLUMN part of temporary-goal-column if the
6259 ;; line-number display changed its width since the last
6260 ;; time.
6267 ;; Otherwise, we should reset `temporary-goal-column'.
6269 x-pos)
6271 ;; Handle the `overflow-newline-into-fringe' case
6272 ;; (left-fringe is for the R2L case):
6277 ;; In R2L lines, the X pixel coordinate is measured from the
6278 ;; left edge of the window, but columns are still counted
6279 ;; from the logical-order beginning of the line, i.e. from
6280 ;; the right edge in this case. We need to adjust for that.
6286 hscroll)))
6288 ;; When we move beyond the first/last character visible in
6289 ;; the window, posn-at-point will return nil, so we need to
6290 ;; approximate the goal column as below.
6295 ;; vertical-motion can move more than it was asked to if it moves
6296 ;; across display strings with newlines. We don't want to ring
6297 ;; the bell and announce beginning/end of buffer in that case.
6303 temporary-goal-column))
6304 arg))
6305 arg))
6311 temporary-goal-column))
6312 arg))
6313 arg)))
6316 ;; If the goal column lies on a display string,
6317 ;; `vertical-motion' advances the cursor to the end
6318 ;; of the string. For arg < 0, this can cause the
6319 ;; cursor to get stuck. (Bug#3020).
6323 nil)))))
6325 ;; This is the guts of next-line and previous-line.
6326 ;; Arg says how many lines to move.
6327 ;; The value is t if we can move the specified number of lines.
6329 ;; Don't run any point-motion hooks, and disregard intangibility,
6330 ;; for intermediate positions.
6342 ;; Don't count beg of empty line as end of line
6343 ;; unless we just did explicit end-of-line.
6345 most-positive-fixnum
6349 line-move-ignore-invisible))
6350 ;; Use just newline characters.
6351 ;; Set ARG to 0 if we move as many lines as requested.
6354 ;; This way of moving forward ARG lines
6355 ;; verifies that we have a newline after the last one.
6356 ;; It doesn't get confused by intangible text.
6365 'beginning-of-buffer
6367 nil)))
6368 ;; Move by arg lines, but ignore invisible ones.
6371 ;; If the following character is currently invisible,
6372 ;; skip all characters with that same `invisible' property value.
6375 ;; Move a line.
6376 ;; We don't use `end-of-line', since we want to escape
6377 ;; from field boundaries occurring exactly at point.
6383 ;; If there's no invisibility here, move over the newline.
6392 ;; We avoid vertical-motion when possible
6393 ;; because that has to fontify.
6395 ;; Otherwise move a more sophisticated way.
6402 ;; The logic of this is the same as the loop above,
6403 ;; it just goes in the other direction.
6405 ;; For completely consistency with the forward-motion
6406 ;; case, we should call beginning-of-line here.
6407 ;; However, if point is inside a field and on a
6408 ;; continued line, the call to (vertical-motion -1)
6409 ;; below won't move us back far enough; then we return
6410 ;; to the same column in line-move-finish, and point
6411 ;; gets stuck -- cyd
6429 ;; if our target is the middle of this line.
6434 ;; This is the value the function returns.
6438 ;; If we did not move down as far as desired, at least go
6439 ;; to end of line. Be sure to call point-entered and
6440 ;; point-left-hooks.
6446 ;; If we did not move up as far as desired,
6447 ;; at least go to beginning of line.
6459 ;; Set REPEAT to t to repeat the whole thing.
6466 ;; Compute the end of the line
6467 ;; ignoring effectively invisible newlines.
6469 ;; Like end-of-line but ignores fields.
6476 ;; Move to the desired column.
6479 ;; Under line-move-visual, goal-column should be
6480 ;; interpreted in units of the frame's canonical character
6481 ;; width, which is exactly what vertical-motion does.
6485 ;; Corner case: suppose we start out in a field boundary in
6486 ;; the middle of a continued line. When we get to
6487 ;; line-move-finish, point is at the start of a new *screen*
6488 ;; line but the same text line; then line-move-to-column would
6489 ;; move us backwards. Test using C-n with point on the "x" in
6490 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6497 ;; Process intangibility within a line.
6498 ;; With inhibit-point-motion-hooks bound to nil, a call to
6499 ;; goto-char moves point past intangible text.
6501 ;; However, inhibit-point-motion-hooks controls both the
6502 ;; intangibility and the point-entered/point-left hooks. The
6503 ;; following hack avoids calling the point-* hooks
6504 ;; unnecessarily. Note that we move *forward* past intangible
6505 ;; text when the initial and final points are the same.
6510 ;; If intangibility moves us to a different (later) place
6511 ;; in the same line, use that as the destination.
6514 ;; If that position is "too late",
6515 ;; try the previous allowable position.
6516 ;; See if it is ok.
6519 ;; If going forward, don't accept the previous
6520 ;; allowable position if it is before the target line.
6522 ;; If going backward, don't accept the previous
6523 ;; allowable position if it is still after the target line.
6526 ;; As a last resort, use the end of the line.
6529 ;; Now move to the updated destination, processing fields
6530 ;; as well as intangibility.
6534 ;; Ignore field boundaries if the initial and final
6535 ;; positions have the same `field' property, even if the
6536 ;; fields are non-contiguous. This seems to be "nicer"
6537 ;; behavior in many situations.
6540 new
6544 ;; If all this moved us to a different line,
6545 ;; retry everything within that new line.
6547 ;; Repeat the intangibility and field processing.
6551 "Try to find column COL, considering invisibility.
6552 This function works only in certain cases,
6553 because what we really need is for `move-to-column'
6554 and `current-column' to be able to ignore invisible text."
6563 ;; If the following character is currently invisible,
6564 ;; skip all characters with that same `invisible' property value.
6568 ;; Have we advanced to a larger column position?
6570 ;; We have made some progress towards the desired column.
6571 ;; See if we can make any further progress.
6573 ;; Otherwise, go to the place we originally found
6574 ;; and move back over invisible text.
6575 ;; that will get us to the same place on the screen
6576 ;; but with a more reasonable buffer position.
6579 ;; We want the real line beginning, so it's consistent
6580 ;; with bolp below, otherwise we might infloop.
6587 "Move point to end of current line as displayed.
6588 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6589 If point reaches the beginning or end of buffer, it stops there.
6591 To ignore the effects of the `intangible' text or overlay
6592 property, bind `inhibit-point-motion-hooks' to t.
6593 If there is an image in the current line, this function
6594 disregards newlines that are part of the text on which the image
6595 rests."
6605 ;; With bidi reordering, we may not be at bol,
6606 ;; so make sure we are.
6621 ;; If we skipped something intangible and now we're not
6622 ;; really at eol, keep going.
6627 "Move point to beginning of current line as displayed.
6628 \(If there's an image in the line, this disregards newlines
6629 which are part of the text that the image rests on.)
6631 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6632 If point reaches the beginning or end of buffer, it stops there.
6633 \(But if the buffer doesn't end in a newline, it stops at the
6634 beginning of the last line.)
6635 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6640 first-vis first-vis-field-value)
6642 ;; Move by lines, if ARG is not 1 (the default).
6647 ;; Move to beginning-of-line, ignoring fields and invisible text.
6653 ;; Now find first visible char in the line.
6658 ;; See if fields would stop us from reaching FIRST-VIS.
6663 ;; If yes, obey them.
6664 first-vis-field-value
6665 ;; Otherwise, move to START with attention to fields.
6666 ;; (It is possible that fields never matter in this case.)
6671 ;; Many people have said they rarely use this feature, and often type
6672 ;; it by accident. Maybe it shouldn't even be on a key.
6677 Those commands will move to this position in the line moved to
6678 rather than trying to keep the same horizontal position.
6679 With a non-nil argument ARG, clears out the goal column
6681 The goal column is stored in the variable `goal-column'.
6682 This is a buffer-local setting."
6689 ;; The older method below can be erroneous if `set-goal-column' is bound
6690 ;; to a sequence containing %
6691 ;;(message (substitute-command-keys
6692 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6693 ;;goal-column)
6700 )
6701 nil)
6702 \f
6703 ;;; Editing based on visual lines, as opposed to logical lines.
6706 "Move point to end of current visual line.
6707 With argument N not nil or 1, move forward N - 1 visual lines first.
6708 If point reaches the beginning or end of buffer, it stops there.
6709 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6715 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6716 ;; constrain to field boundaries, so we don't either.
6720 "Move point to beginning of current visual line.
6721 With argument N not nil or 1, move forward N - 1 visual lines first.
6722 If point reaches the beginning or end of buffer, it stops there.
6723 \(But if the buffer doesn't end in a newline, it stops at the
6724 beginning of the last visual line.)
6725 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6733 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6737 "Kill the rest of the visual line.
6738 With prefix argument ARG, kill that many visual lines from point.
6739 If ARG is negative, kill visual lines backward.
6740 If ARG is zero, kill the text before point on the current visual
6741 line.
6743 If you want to append the killed line to the last killed text,
6746 If the buffer is read-only, Emacs will beep and refrain from deleting
6747 the line, but put the line in the kill ring anyway. This means that
6748 you can use this command to copy text from a read-only buffer.
6749 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6750 even beep.)"
6752 ;; Like in `kill-line', it's better to move point to the other end
6753 ;; of the kill before killing.
6761 ;; Skip any trailing whitespace at the end of the visual line.
6762 ;; We used to do this only if `show-trailing-whitespace' is
6763 ;; nil, but that's wrong; the correct thing would be to check
6764 ;; whether the trailing whitespace is highlighted. But, it's
6765 ;; OK to just do this unconditionally.
6772 "Move cursor vertically down ARG lines.
6773 This is identical to `next-line', except that it always moves
6774 by logical lines instead of visual lines, ignoring the value of
6775 the variable `line-move-visual'."
6782 "Move cursor vertically up ARG lines.
6783 This is identical to `previous-line', except that it always moves
6784 by logical lines instead of visual lines, ignoring the value of
6785 the variable `line-move-visual'."
6792 "Editing based on visual lines."
6801 ;; These keybindings interfere with xterm function keys. Are
6802 ;; there any other suitable bindings?
6803 ;; (define-key map "\M-[" 'previous-logical-line)
6804 ;; (define-key map "\M-]" 'next-logical-line)
6805 map))
6808 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6809 The value should be a list of the form (LEFT RIGHT), where LEFT
6810 and RIGHT are symbols representing the bitmaps to display, to
6811 indicate wrapped lines, in the left and right fringes respectively.
6812 See also `fringe-indicator-alist'.
6813 The default is not to display fringe indicators for wrapped lines.
6814 This variable does not affect fringe indicators displayed for
6815 other purposes."
6830 'continuation
6837 "Toggle visual line based editing (Visual Line mode) in the current buffer.
6838 Interactively, with a prefix argument, enable
6839 Visual Line mode if the prefix argument is positive,
6840 and disable it otherwise. If called from Lisp, toggle
6841 the mode if ARG is `toggle', disable the mode if ARG is
6842 a non-positive integer, and enable the mode otherwise
6843 \(including if ARG is omitted or nil or a positive integer).
6845 When Visual Line mode is enabled, `word-wrap' is turned on in
6846 this buffer, and simple editing commands are redefined to act on
6847 visual lines, not logical lines. See Info node `Visual Line
6848 Mode' for details."
6849 :keymap visual-line-mode-map
6855 ;; Save the local values of some variables, to be restored if
6856 ;; visual-line-mode is turned off.
6858 truncate-partial-width-windows
6859 word-wrap fringe-indicator-alist))
6862 visual-line--saved-state)))
6866 word-wrap t
6867 fringe-indicator-alist
6869 fringe-indicator-alist)))
6883 visual-line-mode turn-on-visual-line-mode)
6885 \f
6887 "Interchange characters around point, moving forward one character.
6888 With prefix arg ARG, effect is to take character before point
6889 and drag it forward past ARG other characters (backward if ARG negative).
6890 If no argument and at end of line, the previous two chars are exchanged."
6898 "Interchange words around point, leaving point at end of them.
6899 With prefix arg ARG, effect is to take word before or around point
6900 and drag it forward past ARG other words (backward if ARG negative).
6901 If ARG is zero, the words around or after point and around or after mark
6902 are interchanged."
6903 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6909 Unlike `transpose-words', point must be between the two sexps and not
6910 in the middle of a sexp to be transposed.
6911 With non-zero prefix arg ARG, effect is to take the sexp before point
6912 and drag it forward past ARG other sexps (backward if ARG is negative).
6913 If ARG is zero, the sexps ending at or after point and at or after mark
6914 are interchanged."
6918 ;; Here we should try to simulate the behavior of
6919 ;; (cons (progn (forward-sexp x) (point))
6920 ;; (progn (forward-sexp (- x)) (point)))
6921 ;; Except that we don't want to rely on the second forward-sexp
6922 ;; putting us back to where we want to be, since forward-sexp-function
6923 ;; might do funny things like infix-precedence.
6928 ;; Jumping over a symbol. We might be inside it, mind you.
6933 ;; Otherwise, we're between sexps. Take a step back before jumping
6934 ;; to make sure we'll obey the same precedence no matter which direction
6935 ;; we're going.
6940 'skip-syntax-forward
6947 "Exchange current line and previous line, leaving point after both.
6948 With argument ARG, takes previous line and moves it past ARG lines.
6949 With argument 0, interchanges line point is in with line mark is in."
6955 ;; Move forward over ARG lines,
6956 ;; but create newlines if necessary.
6963 arg))
6965 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6966 ;; which seems inconsistent with the ARG /= 0 case.
6967 ;; FIXME document SPECIAL.
6969 "Subroutine to do the work of transposing objects.
6970 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6971 moves forward by units of the given object (e.g. forward-sentence,
6972 forward-paragraph). If ARG is zero, exchanges the current object
6973 with the one containing mark. If ARG is an integer, moves the
6974 current object past ARG following (if ARG is positive) or
6975 preceding (if ARG is negative) objects, leaving point after the
6976 current object."
6981 pos1 pos2)
7010 ;; This sequence of insertions attempts to preserve marker
7011 ;; positions at the start and end of the transposed objects.
7025 \f
7027 "Move backward until encountering the beginning of a word.
7028 With argument ARG, do this that many times.
7029 If ARG is omitted or nil, move point backward one word.
7031 The word boundaries are normally determined by the buffer's syntax
7032 table, but `find-word-boundary-function-table', such as set up
7033 by `subword-mode', can change that. If a Lisp program needs to
7034 move by words determined strictly by the syntax table, it should
7035 use `backward-word-strictly' instead."
7040 "Set mark ARG words away from point.
7042 move to with the same argument.
7043 Interactively, if this command is repeated
7044 or (in Transient Mark mode) if the mark is active,
7045 it marks the next ARG words after the ones already marked."
7062 nil t))))
7065 "Kill characters forward until encountering the end of a word.
7066 With argument ARG, do this that many times."
7071 "Kill characters backward until encountering the beginning of a word.
7072 With argument ARG, do this that many times."
7077 "Return the word at or near point, as a string.
7078 The return value includes no text properties.
7080 If optional arg STRICT is non-nil, return nil unless point is
7081 within or adjacent to a word, otherwise look for a word within
7082 point's line. If there is no word anywhere on point's line, the
7083 value is nil regardless of STRICT.
7085 By default, this function treats as a single word any sequence of
7086 characters that have either word or symbol syntax. If optional
7087 arg REALLY-WORD is non-nil, only characters of word syntax can
7088 constitute a word."
7097 ;; Point is neither within nor adjacent to a word.
7099 ;; Look for preceding word in same line.
7102 ;; No preceding word in same line.
7103 ;; Look for following word in same line.
7112 ;; If we found something nonempty, return it as a string.
7115 \f
7117 "String for filling to insert at front of new line, or nil for none."
7119 string)
7125 "Regexp to match lines which should not be auto-filled."
7127 regexp)
7131 "The default value for `normal-auto-fill-function'.
7132 This is the default auto-fill function, some major modes use a different one.
7133 Returns t if it really did any work."
7143 nil ;; Auto-filling not required
7147 ;; Choose a fill-prefix automatically.
7155 ;; Use auto-indentation rather than a guessed empty prefix.
7161 ;; Determine where to split the line.
7165 ;; Don't split earlier in the line than the length of the
7166 ;; fill prefix, since the resulting line would be longer.
7174 ;; See whether the place we found is any good.
7178 ;; There is no use breaking at end of line.
7180 ;; Don't split right after a comment starter
7181 ;; since we would just make another comment starter.
7186 limit t)
7188 ;; No good place to break => stop trying.
7190 ;; Ok, we have a useful place to break the line. Do it.
7192 ;; If point is at the fill-point, do not `save-excursion'.
7193 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7194 ;; point will end up before it rather than after it.
7202 ;; Now do justification, if required
7207 ;; If making the new line didn't reduce the hpos of
7208 ;; the end of the line, then give up now;
7209 ;; trying again will not help.
7212 ;; Justify last line.
7214 t)))
7217 "Mode-specific function which line breaks and continues a comment.
7218 This function is called during auto-filling when a comment syntax
7219 is defined.
7220 The function should take a single optional argument, which is a flag
7224 "Break line at point and indent.
7225 If a comment syntax is defined, call `comment-indent-new-line'.
7227 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7228 unless optional argument SOFT is non-nil."
7232 ;; Insert the newline before removing empty space so that markers
7233 ;; get preserved better.
7239 ;; Blindly trust a non-adaptive fill-prefix.
7245 ;; If there's an adaptive prefix, use it unless we're inside
7246 ;; a comment and the prefix is not a comment starter.
7250 ;; If we're not inside a comment, just try to indent.
7254 "The function called by `self-insert-command' to perform auto-filling."
7261 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7265 ;; `functions' and `hooks' are usually unsafe to set, but setting
7266 ;; auto-fill-function to nil in a file-local setting is safe and
7267 ;; can be useful to prevent auto-filling.
7271 "Toggle automatic line breaking (Auto Fill mode).
7272 Interactively, with a prefix argument, enable
7273 Auto Fill mode if the prefix argument is positive,
7274 and disable it otherwise. If called from Lisp, toggle
7275 the mode if ARG is `toggle', disable the mode if ARG is
7276 a non-positive integer, and enable the mode otherwise
7277 \(including if ARG is omitted or nil or a positive integer).
7279 When Auto Fill mode is enabled, inserting a space at a column
7280 beyond `current-fill-column' automatically breaks the line at a
7281 previous space.
7283 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7284 non-nil.
7286 The value of `normal-auto-fill-function' specifies the function to use
7287 for `auto-fill-function' when turning Auto Fill mode on."
7292 ;; This holds a document string used to document auto-fill-mode.
7294 "Automatically break line at a previous space, in insertion of text."
7295 nil)
7298 "Unconditionally turn on Auto Fill mode."
7302 "Unconditionally turn off Auto Fill mode."
7308 "Set `fill-column' to specified argument.
7313 ;; We used to use current-column silently, but C-x f is too easily
7314 ;; typed as a typo for C-x C-f, so we turned it into an error and
7315 ;; now an interactive prompt.
7320 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7324 \f
7326 "Set `selective-display' to ARG; clear it if no arg.
7327 When the value of `selective-display' is a number > 0,
7328 lines whose indentation is >= that value are not displayed.
7329 The variable `selective-display' has a separate value for each buffer."
7349 "Toggle truncating of long lines for the current buffer.
7350 When truncating is off, long lines are folded.
7351 With prefix argument ARG, truncate long lines if ARG is positive,
7352 otherwise fold them. Note that in side-by-side windows, this
7353 command has no effect if `truncate-partial-width-windows' is
7354 non-nil."
7366 nil t)))
7371 "Toggle whether to use word-wrapping for continuation lines.
7372 With prefix argument ARG, wrap continuation lines at word boundaries
7373 if ARG is positive, otherwise wrap them at the right screen edge.
7374 This command toggles the value of `word-wrap'. It has no effect
7375 if long lines are truncated."
7391 "Toggle Overwrite mode.
7392 With a prefix argument ARG, enable Overwrite mode if ARG is
7393 positive, and disable it otherwise. If called from Lisp, enable
7394 the mode if ARG is omitted or nil.
7396 When Overwrite mode is enabled, printing characters typed in
7397 replace existing text on a one-for-one basis, rather than pushing
7398 it to the right. At the end of a line, such characters extend
7399 the line. Before a tab, such characters insert until the tab is
7401 overwrite mode; this is supposed to make it easier to insert
7402 characters when necessary."
7407 "Toggle Binary Overwrite mode.
7408 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7409 is positive, and disable it otherwise. If called from Lisp,
7410 enable the mode if ARG is omitted or nil.
7412 When Binary Overwrite mode is enabled, printing characters typed
7413 in replace existing text. Newlines are not treated specially, so
7414 typing at the end of a line joins the line to the next, with the
7415 typed character between them. Typing before a tab character
7416 simply replaces the tab with the character typed.
7418 ordinary typing characters do.
7420 Note that Binary Overwrite mode is not its own minor mode; it is
7421 a specialization of overwrite mode, entered by setting the
7422 `overwrite-mode' variable to `overwrite-mode-binary'."
7427 "Toggle line number display in the mode line (Line Number mode).
7428 With a prefix argument ARG, enable Line Number mode if ARG is
7429 positive, and disable it otherwise. If called from Lisp, enable
7430 the mode if ARG is omitted or nil.
7432 Line numbers do not appear for very large buffers and buffers
7433 with very long lines; see variables `line-number-display-limit'
7434 and `line-number-display-limit-width'."
7438 "Toggle column number display in the mode line (Column Number mode).
7439 With a prefix argument ARG, enable Column Number mode if ARG is
7440 positive, and disable it otherwise.
7442 If called from Lisp, enable the mode if ARG is omitted or nil."
7446 "Toggle buffer size display in the mode line (Size Indication mode).
7447 With a prefix argument ARG, enable Size Indication mode if ARG is
7448 positive, and disable it otherwise.
7450 If called from Lisp, enable the mode if ARG is omitted or nil."
7454 "Toggle auto-saving in the current buffer (Auto Save mode).
7455 With a prefix argument ARG, enable Auto Save mode if ARG is
7456 positive, and disable it otherwise.
7458 If called from Lisp, enable the mode if ARG is omitted or nil."
7460 ;; If auto-save is off because buffer has shrunk,
7461 ;; then toggling should turn it on.
7469 buffer-file-name)
7471 ;; If -1 was stored here, to temporarily turn off saving,
7472 ;; turn it back on.
7475 \f
7477 "Blinking matching of parens and expressions."
7482 "Non-nil means show matching open-paren when close-paren is inserted.
7483 If t, highlight the paren. If `jump', briefly move cursor to its
7484 position. If `jump-offscreen', move cursor there even if the
7485 position is off screen. With any other non-nil value, the
7486 off-screen position of the opening paren will be shown in the
7487 echo area."
7496 "Non-nil means show matching open-paren when it is on screen.
7497 If nil, don't show it (but the open-paren can still be shown
7498 in the echo area when it is off screen).
7500 This variable has no effect if `blink-matching-paren' is nil.
7501 \(In that case, the open-paren is never shown.)
7502 It is also ignored if `show-paren-mode' is enabled."
7507 "If non-nil, maximum distance to search backwards for matching open-paren.
7508 If nil, search stops at the beginning of the accessible portion of the buffer."
7514 "Time in seconds to delay after showing a matching paren."
7519 "If nil, `blink-matching-paren' ignores comments.
7520 More precisely, when looking for the matching parenthesis,
7521 it skips the contents of comments that end before point."
7526 "Return whether or not START...END are matching parens.
7527 END is the current point and START is the blink position.
7528 START might be nil if no matching starter was found.
7529 Returns non-nil if we find there is a mismatch."
7534 ;; For self-matched chars like " and $, we can't know when they're
7535 ;; mismatched or unmatched, so we can only do it for parens.
7540 ;; The cdr might hold a new paren-class info rather than
7541 ;; a matching-char info, in which case the two CDRs
7542 ;; should match.
7546 "Function to check parentheses mismatches.
7547 The function takes two arguments (START and END) where START is the
7548 position just before the opening token and END is the position right after.
7549 START can be nil, if it was not found.
7556 ol)
7560 "Momentarily highlight the beginning of the sexp before point."
7563 blink-matching-paren)
7573 oldpos))
7581 ;; backward-sexp skips backward over prefix chars,
7582 ;; so move back to the matching paren.
7605 ;; Matching open within window, temporarily move to or highlight
7606 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7607 ;; is non-nil.
7624 ;; Show what precedes the open in its line, if anything.
7629 ;; Show what follows the open in its line, if anything.
7636 ;; Otherwise show the previous nonblank line,
7637 ;; if there is one.
7646 ;; Replace the newline and other whitespace with `...'.
7647 "..."
7649 ;; There is nothing to show except the char itself.
7652 "Matches %s"
7656 "Function called, if non-nil, whenever a close parenthesis is inserted.
7662 blink-paren-function
7665 ;; Verify an even number of quoting characters precede the close.
7666 ;; FIXME: Also check if this parenthesis closes a comment as
7667 ;; can happen in Pascal and SML.
7678 ;; Most likely, this hook is nil, so this arg doesn't matter,
7679 ;; but I use it as a reminder that this function usually
7680 ;; likes to be run after others since it does
7681 ;; `sit-for'. That's also the reason it get a `priority' prop
7682 ;; of 100.
7684 \f
7685 ;; This executes C-g typed while Emacs is waiting for a command.
7686 ;; Quitting out of a program does not go through here;
7687 ;; that happens in the maybe_quit function at the C code level.
7689 "Signal a `quit' condition.
7690 During execution of Lisp code, this character causes a quit directly.
7691 At top-level, as an editor command, this simply beeps."
7693 ;; Avoid adding the region to the window selection.
7701 ;; Force the next redisplay cycle to remove the "Def" indicator from
7702 ;; all the mode lines.
7716 This command can exit an interactive command such as `query-replace',
7717 can clear out a prefix argument or a region,
7718 can get out of the minibuffer or other recursive edit,
7719 cancel the use of the current buffer (for special-purpose buffers),
7720 or go back to just one window (by deleting all but the selected window)."
7728 nil)
7739 "Play sound stored in FILE.
7740 VOLUME and DEVICE correspond to the keywords of the sound
7741 specification for `play-sound'."
7751 \f
7753 "Your preference for a mail reading package.
7754 This is used by some keybindings which support reading mail.
7755 See also `mail-user-agent' concerning sending mail."
7765 "Your preference for a mail composition package.
7766 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7767 outgoing email message. This variable lets you specify which
7768 mail-sending package you prefer.
7770 Valid values include:
7772 `message-user-agent' -- use the Message package.
7773 See Info node `(message)'.
7774 `sendmail-user-agent' -- use the Mail package.
7775 See Info node `(emacs)Sending Mail'.
7776 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7777 See Info node `(mh-e)'.
7778 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7779 paraphernalia if Gnus is running, particularly
7780 the Gcc: header for archiving.
7782 Additional valid symbols may be available; check with the author of
7783 your package for details. The function should return non-nil if it
7784 succeeds.
7786 See also `read-mail-command' concerning reading mail."
7789 message-user-agent)
7792 sendmail-user-agent)
7795 mh-e-user-agent)
7798 gnus-user-agent)
7804 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7805 If the value of `mail-user-agent' is the default, and the user
7806 appears to have customizations applying to the old default,
7807 `compose-mail' issues a warning."
7813 "If the buffer starts with a mail header, move point to the header's end.
7814 Otherwise, moves to `point-min'.
7815 The end of the header is the start of the next line, if there is one,
7816 else the end of the last line. This function obeys RFC822."
7822 ;; Used by Rmail (e.g., rmail-forward).
7824 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7828 switch-function yank-action send-actions
7829 return-action)
7830 "Start composing a mail message to send.
7831 This uses the user's chosen mail composition package
7832 as selected with the variable `mail-user-agent'.
7833 The optional arguments TO and SUBJECT specify recipients
7834 and the initial Subject field, respectively.
7836 OTHER-HEADERS is an alist specifying additional
7837 header fields. Elements look like (HEADER . VALUE) where both
7838 HEADER and VALUE are strings.
7840 CONTINUE, if non-nil, says to continue editing a message already
7841 being composed. Interactively, CONTINUE is the prefix argument.
7843 SWITCH-FUNCTION, if non-nil, is a function to use to
7844 switch to and display the buffer used for mail composition.
7846 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7847 to insert the raw text of the message being replied to.
7848 It has the form (FUNCTION . ARGS). The user agent will apply
7849 FUNCTION to ARGS, to insert the raw text of the original message.
7850 \(The user agent will also run `mail-citation-hook', *after* the
7851 original text has been inserted in this way.)
7853 SEND-ACTIONS is a list of actions to call when the message is sent.
7854 Each action has the form (FUNCTION . ARGS).
7856 RETURN-ACTION, if non-nil, is an action for returning to the
7857 caller. It has the form (FUNCTION . ARGS). The function is
7858 called after the mail has been sent or put aside, and the mail
7859 buffer buried."
7863 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7864 ;; from sendmail-user-agent to message-user-agent. Some users may
7865 ;; encounter incompatibilities. This hack tries to detect problems
7866 ;; and warn about them.
7871 mail-citation-hook mail-archive-file-name
7872 mail-default-reply-to mail-mailing-lists
7873 mail-self-blind))
7880 The default mail mode is now Message mode.
7881 You have the following Mail mode variable%s customized:
7883 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7890 yank-action send-actions return-action)))
7893 yank-action send-actions
7894 return-action)
7898 'switch-to-buffer-other-window yank-action send-actions
7899 return-action))
7902 yank-action send-actions
7903 return-action)
7907 'switch-to-buffer-other-frame yank-action send-actions
7908 return-action))
7910 \f
7912 "History of values entered with `set-variable'.
7914 Maximum length of the history list is determined by the value
7918 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7919 VARIABLE should be a user option variable name, a Lisp variable
7920 meant to be customized by users. You should enter VALUE in Lisp syntax,
7921 so if you want VALUE to be a string, you must surround it with doublequotes.
7922 VALUE is used literally, not evaluated.
7924 If VARIABLE has a `variable-interactive' property, that is used as if
7925 it were the arg to `interactive' (which see) to interactively read VALUE.
7927 If VARIABLE has been defined with `defcustom', then the type information
7928 in the definition is used to check that VALUE is valid.
7930 Note that this function is at heart equivalent to the basic `set' function.
7931 For a variable defined with `defcustom', it does not pay attention to
7932 any :set property that the variable might have (if you want that, use
7935 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7940 default-var)
7956 var obsolete)
7959 ;; Use VAR's `variable-interactive' property
7960 ;; as an interactive spec for prompting.
7963 arg))
7965 read-expression-map t
7966 'set-variable-value-history
7975 ;; Match with custom type.
7987 ;; Force a thorough redisplay for the case that the variable
7988 ;; has an effect on the display, like `tab-width' has.
7990 \f
7991 ;; Define the major mode for lists of completions.
8001 (define-key map [right] 'next-completion)
8003 (define-key map [backtab] 'previous-completion)
8004 (define-key map "q" 'quit-window)
8005 (define-key map "z" 'kill-current-buffer)
8006 map)
8007 "Local map for completion list buffers.")
8009 ;; Completion mode is suitable only for specially formatted data.
8010 (put 'completion-list-mode 'mode-class 'special)
8012 (defvar completion-reference-buffer nil
8013 "Record the buffer that was current when the completion list was requested.
8014 This is a local variable in the completion list buffer.
8015 Initial value is nil to avoid some compiler warnings.")
8017 (defvar completion-no-auto-exit nil
8018 "Non-nil means `choose-completion-string' should never exit the minibuffer.
8019 This also applies to other functions such as `choose-completion'.")
8021 (defvar completion-base-position nil
8022 "Position of the base of the text corresponding to the shown completions.
8023 This variable is used in the *Completions* buffers.
8024 Its value is a list of the form (START END) where START is the place
8025 where the completion should be inserted and END (if non-nil) is the end
8026 of the text to replace. If END is nil, point is used instead.")
8028 (defvar completion-list-insert-choice-function #'completion--replace
8029 "Function to use to insert the text chosen in *Completions*.
8030 Called with three arguments (BEG END TEXT), it should replace the text
8031 between BEG and END with TEXT. Expected to be set buffer-locally
8032 in the *Completions* buffer.")
8034 (defvar completion-base-size nil
8035 "Number of chars before point not involved in completion.
8036 This is a local variable in the completion list buffer.
8037 It refers to the chars in the minibuffer if completing in the
8038 minibuffer, or in `completion-reference-buffer' otherwise.
8039 Only characters in the field at point are included.
8041 If nil, Emacs determines which part of the tail end of the
8042 buffer's text is involved in completion by comparing the text
8043 directly.")
8044 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
8046 (defun delete-completion-window ()
8047 "Delete the completion list window.
8048 Go to the window from which completion was requested."
8049 (interactive)
8050 (let ((buf completion-reference-buffer))
8051 (if (one-window-p t)
8052 (if (window-dedicated-p) (delete-frame))
8053 (delete-window (selected-window))
8054 (if (get-buffer-window buf)
8055 (select-window (get-buffer-window buf))))))
8057 (defun previous-completion (n)
8058 "Move to the previous item in the completion list."
8059 (interactive "p")
8060 (next-completion (- n)))
8062 (defun next-completion (n)
8063 "Move to the next item in the completion list.
8064 With prefix argument N, move N items (negative N means move backward)."
8065 (interactive "p")
8066 (let ((beg (point-min)) (end (point-max)))
8067 (while (and (> n 0) (not (eobp)))
8068 ;; If in a completion, move to the end of it.
8069 (when (get-text-property (point) 'mouse-face)
8070 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8071 ;; Move to start of next one.
8072 (unless (get-text-property (point) 'mouse-face)
8073 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8074 (setq n (1- n)))
8075 (while (and (< n 0) (not (bobp)))
8076 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
8077 ;; If in a completion, move to the start of it.
8078 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
8079 (goto-char (previous-single-property-change
8080 (point) 'mouse-face nil beg)))
8081 ;; Move to end of the previous completion.
8082 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
8083 (goto-char (previous-single-property-change
8084 (point) 'mouse-face nil beg)))
8085 ;; Move to the start of that one.
8086 (goto-char (previous-single-property-change
8087 (point) 'mouse-face nil beg))
8088 (setq n (1+ n))))))
8090 (defun choose-completion (&optional event)
8091 "Choose the completion at point.
8092 If EVENT, use EVENT's position to determine the starting position."
8093 (interactive (list last-nonmenu-event))
8094 ;; In case this is run via the mouse, give temporary modes such as
8095 ;; isearch a chance to turn off.
8096 (run-hooks 'mouse-leave-buffer-hook)
8097 (with-current-buffer (window-buffer (posn-window (event-start event)))
8098 (let ((buffer completion-reference-buffer)
8099 (base-size completion-base-size)
8100 (base-position completion-base-position)
8101 (insert-function completion-list-insert-choice-function)
8102 (choice
8103 (save-excursion
8104 (goto-char (posn-point (event-start event)))
8105 (let (beg end)
8106 (cond
8107 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
8108 (setq end (point) beg (1+ (point))))
8109 ((and (not (bobp))
8110 (get-text-property (1- (point)) 'mouse-face))
8111 (setq end (1- (point)) beg (point)))
8112 (t (error "No completion here")))
8113 (setq beg (previous-single-property-change beg 'mouse-face))
8114 (setq end (or (next-single-property-change end 'mouse-face)
8115 (point-max)))
8116 (buffer-substring-no-properties beg end)))))
8118 (unless (buffer-live-p buffer)
8119 (error "Destination buffer is dead"))
8120 (quit-window nil (posn-window (event-start event)))
8122 (with-current-buffer buffer
8123 (choose-completion-string
8124 choice buffer
8125 (or base-position
8126 (when base-size
8127 ;; Someone's using old completion code that doesn't know
8128 ;; about base-position yet.
8129 (list (+ base-size (field-beginning))))
8130 ;; If all else fails, just guess.
8131 (list (choose-completion-guess-base-position choice)))
8132 insert-function)))))
8134 ;; Delete the longest partial match for STRING
8135 ;; that can be found before POINT.
8136 (defun choose-completion-guess-base-position (string)
8137 (save-excursion
8138 (let ((opoint (point))
8139 len)
8140 ;; Try moving back by the length of the string.
8141 (goto-char (max (- (point) (length string))
8142 (minibuffer-prompt-end)))
8143 ;; See how far back we were actually able to move. That is the
8144 ;; upper bound on how much we can match and delete.
8145 (setq len (- opoint (point)))
8146 (if completion-ignore-case
8147 (setq string (downcase string)))
8148 (while (and (> len 0)
8149 (let ((tail (buffer-substring (point) opoint)))
8150 (if completion-ignore-case
8151 (setq tail (downcase tail)))
8152 (not (string= tail (substring string 0 len)))))
8153 (setq len (1- len))
8154 (forward-char 1))
8155 (point))))
8157 (defun choose-completion-delete-max-match (string)
8158 (declare (obsolete choose-completion-guess-base-position "23.2"))
8159 (delete-region (choose-completion-guess-base-position string) (point)))
8161 (defvar choose-completion-string-functions nil
8162 "Functions that may override the normal insertion of a completion choice.
8163 These functions are called in order with three arguments:
8164 CHOICE - the string to insert in the buffer,
8165 BUFFER - the buffer in which the choice should be inserted,
8166 BASE-POSITION - where to insert the completion.
8168 If a function in the list returns non-nil, that function is supposed
8169 to have inserted the CHOICE in the BUFFER, and possibly exited
8170 the minibuffer; no further functions will be called.
8172 If all functions in the list return nil, that means to use
8173 the default method of inserting the completion in BUFFER.")
8175 (defun choose-completion-string (choice &optional
8176 buffer base-position insert-function)
8177 "Switch to BUFFER and insert the completion choice CHOICE.
8178 BASE-POSITION says where to insert the completion.
8179 INSERT-FUNCTION says how to insert the completion and falls
8180 back on `completion-list-insert-choice-function' when nil."
8182 ;; If BUFFER is the minibuffer, exit the minibuffer
8183 ;; unless it is reading a file name and CHOICE is a directory,
8184 ;; or completion-no-auto-exit is non-nil.
8186 ;; Some older code may call us passing `base-size' instead of
8187 ;; `base-position'. It's difficult to make any use of `base-size',
8188 ;; so we just ignore it.
8189 (unless (consp base-position)
8190 (message "Obsolete `base-size' passed to choose-completion-string")
8191 (setq base-position nil))
8193 (let* ((buffer (or buffer completion-reference-buffer))
8194 (mini-p (minibufferp buffer)))
8195 ;; If BUFFER is a minibuffer, barf unless it's the currently
8196 ;; active minibuffer.
8197 (if (and mini-p
8198 (not (and (active-minibuffer-window)
8199 (equal buffer
8200 (window-buffer (active-minibuffer-window))))))
8201 (error "Minibuffer is not active for completion")
8202 ;; Set buffer so buffer-local choose-completion-string-functions works.
8203 (set-buffer buffer)
8204 (unless (run-hook-with-args-until-success
8205 'choose-completion-string-functions
8206 ;; The fourth arg used to be `mini-p' but was useless
8207 ;; (since minibufferp can be used on the `buffer' arg)
8208 ;; and indeed unused. The last used to be `base-size', so we
8209 ;; keep it to try and avoid breaking old code.
8210 choice buffer base-position nil)
8211 ;; This remove-text-properties should be unnecessary since `choice'
8212 ;; comes from buffer-substring-no-properties.
8213 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8214 ;; Insert the completion into the buffer where it was requested.
8215 (funcall (or insert-function completion-list-insert-choice-function)
8216 (or (car base-position) (point))
8217 (or (cadr base-position) (point))
8218 choice)
8219 ;; Update point in the window that BUFFER is showing in.
8220 (let ((window (get-buffer-window buffer t)))
8221 (set-window-point window (point)))
8222 ;; If completing for the minibuffer, exit it with this choice.
8223 (and (not completion-no-auto-exit)
8224 (minibufferp buffer)
8225 minibuffer-completion-table
8226 ;; If this is reading a file name, and the file name chosen
8227 ;; is a directory, don't exit the minibuffer.
8228 (let* ((result (buffer-substring (field-beginning) (point)))
8229 (bounds
8230 (completion-boundaries result minibuffer-completion-table
8231 minibuffer-completion-predicate
8232 "")))
8233 (if (eq (car bounds) (length result))
8234 ;; The completion chosen leads to a new set of completions
8235 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8236 (let ((mini (active-minibuffer-window)))
8237 (select-window mini)
8238 (when minibuffer-auto-raise
8239 (raise-frame (window-frame mini))))
8240 (exit-minibuffer))))))))
8242 (define-derived-mode completion-list-mode nil "Completion List"
8243 "Major mode for buffers showing lists of possible completions.
8245 to select the completion near point.
8246 Or click to select one with the mouse.
8249 (set (make-local-variable 'completion-base-size) nil))
8251 (defun completion-list-mode-finish ()
8252 "Finish setup of the completions buffer.
8253 Called from `temp-buffer-show-hook'."
8254 (when (eq major-mode 'completion-list-mode)
8255 (setq buffer-read-only t)))
8257 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8260 ;; Variables and faces used in `completion-setup-function'.
8262 (defcustom completion-show-help t
8263 "Non-nil means show help message in *Completions* buffer."
8264 :type 'boolean
8265 :version "22.1"
8266 :group 'completion)
8268 ;; This function goes in completion-setup-hook, so that it is called
8269 ;; after the text of the completion list buffer is written.
8270 (defun completion-setup-function ()
8271 (let* ((mainbuf (current-buffer))
8272 (base-dir
8273 ;; FIXME: This is a bad hack. We try to set the default-directory
8274 ;; in the *Completions* buffer so that the relative file names
8275 ;; displayed there can be treated as valid file names, independently
8276 ;; from the completion context. But this suffers from many problems:
8277 ;; - It's not clear when the completions are file names. With some
8278 ;; completion tables (e.g. bzr revision specs), the listed
8279 ;; completions can mix file names and other things.
8280 ;; - It doesn't pay attention to possible quoting.
8281 ;; - With fancy completion styles, the code below will not always
8282 ;; find the right base directory.
8283 (if minibuffer-completing-file-name
8284 (file-name-as-directory
8285 (expand-file-name
8286 (buffer-substring (minibuffer-prompt-end)
8287 (- (point) (or completion-base-size 0))))))))
8288 (with-current-buffer standard-output
8289 (let ((base-size completion-base-size) ;Read before killing localvars.
8290 (base-position completion-base-position)
8291 (insert-fun completion-list-insert-choice-function))
8292 (completion-list-mode)
8293 (set (make-local-variable 'completion-base-size) base-size)
8294 (set (make-local-variable 'completion-base-position) base-position)
8295 (set (make-local-variable 'completion-list-insert-choice-function)
8296 insert-fun))
8297 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8298 (if base-dir (setq default-directory base-dir))
8299 ;; Maybe insert help string.
8300 (when completion-show-help
8301 (goto-char (point-min))
8302 (if (display-mouse-p)
8304 (insert (substitute-command-keys
8308 (add-hook 'completion-setup-hook 'completion-setup-function)
8310 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8311 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8313 (defun switch-to-completions ()
8314 "Select the completion list window."
8315 (interactive)
8316 (let ((window (or (get-buffer-window "*Completions*" 0)
8317 ;; Make sure we have a completions window.
8318 (progn (minibuffer-completion-help)
8319 (get-buffer-window "*Completions*" 0)))))
8320 (when window
8321 (select-window window)
8322 ;; In the new buffer, go to the first completion.
8323 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8324 (when (bobp)
8325 (next-completion 1)))))
8326 \f
8327 ;;; Support keyboard commands to turn on various modifiers.
8329 ;; These functions -- which are not commands -- each add one modifier
8330 ;; to the following event.
8332 (defun event-apply-alt-modifier (_ignore-prompt)
8335 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8336 (defun event-apply-super-modifier (_ignore-prompt)
8339 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8340 (defun event-apply-hyper-modifier (_ignore-prompt)
8343 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8344 (defun event-apply-shift-modifier (_ignore-prompt)
8347 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8348 (defun event-apply-control-modifier (_ignore-prompt)
8351 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8352 (defun event-apply-meta-modifier (_ignore-prompt)
8355 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8357 (defun event-apply-modifier (event symbol lshiftby prefix)
8358 "Apply a modifier flag to event EVENT.
8359 SYMBOL is the name of this modifier, as a symbol.
8360 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8361 PREFIX is the string that represents this modifier in an event type symbol."
8362 (if (numberp event)
8363 (cond ((eq symbol 'control)
8364 (if (and (<= (downcase event) ?z)
8365 (>= (downcase event) ?a))
8366 (- (downcase event) ?a -1)
8367 (if (and (<= (downcase event) ?Z)
8368 (>= (downcase event) ?A))
8369 (- (downcase event) ?A -1)
8370 (logior (lsh 1 lshiftby) event))))
8371 ((eq symbol 'shift)
8372 (if (and (<= (downcase event) ?z)
8373 (>= (downcase event) ?a))
8374 (upcase event)
8375 (logior (lsh 1 lshiftby) event)))
8376 (t
8377 (logior (lsh 1 lshiftby) event)))
8378 (if (memq symbol (event-modifiers event))
8379 event
8380 (let ((event-type (if (symbolp event) event (car event))))
8381 (setq event-type (intern (concat prefix (symbol-name event-type))))
8382 (if (symbolp event)
8383 event-type
8384 (cons event-type (cdr event)))))))
8386 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8387 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8388 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8389 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8390 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8391 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8392 \f
8393 ;;;; Keypad support.
8395 ;; Make the keypad keys act like ordinary typing keys. If people add
8396 ;; bindings for the function key symbols, then those bindings will
8397 ;; override these, so this shouldn't interfere with any existing
8398 ;; bindings.
8400 ;; Also tell read-char how to handle these keys.
8401 (mapc
8402 (lambda (keypad-normal)
8403 (let ((keypad (nth 0 keypad-normal))
8404 (normal (nth 1 keypad-normal)))
8405 (put keypad 'ascii-character normal)
8406 (define-key function-key-map (vector keypad) (vector normal))))
8407 ;; See also kp-keys bound in bindings.el.
8408 '((kp-space ?\s)
8411 (kp-separator ?,)
8412 (kp-equal ?=)
8413 ;; Do the same for various keys that are represented as symbols under
8414 ;; GUIs but naturally correspond to characters.
8415 (backspace 127)
8416 (delete 127)
8419 (clear ?\C-l)
8420 (return ?\C-m)
8421 (escape ?\e)
8422 ))
8423 \f
8424 ;;;;
8425 ;;;; forking a twin copy of a buffer.
8426 ;;;;
8428 (defvar clone-buffer-hook nil
8429 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8431 (defvar clone-indirect-buffer-hook nil
8432 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8434 (defun clone-process (process &optional newname)
8435 "Create a twin copy of PROCESS.
8436 If NEWNAME is nil, it defaults to PROCESS' name;
8437 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8438 If PROCESS is associated with a buffer, the new process will be associated
8439 with the current buffer instead.
8440 Returns nil if PROCESS has already terminated."
8441 (setq newname (or newname (process-name process)))
8443 (setq newname (substring newname 0 (match-beginning 0))))
8444 (when (memq (process-status process) '(run stop open))
8445 (let* ((process-connection-type (process-tty-name process))
8446 (new-process
8447 (if (memq (process-status process) '(open))
8448 (let ((args (process-contact process t)))
8449 (setq args (plist-put args :name newname))
8450 (setq args (plist-put args :buffer
8451 (if (process-buffer process)
8452 (current-buffer))))
8453 (apply 'make-network-process args))
8454 (apply 'start-process newname
8455 (if (process-buffer process) (current-buffer))
8456 (process-command process)))))
8457 (set-process-query-on-exit-flag
8458 new-process (process-query-on-exit-flag process))
8459 (set-process-inherit-coding-system-flag
8460 new-process (process-inherit-coding-system-flag process))
8461 (set-process-filter new-process (process-filter process))
8462 (set-process-sentinel new-process (process-sentinel process))
8463 (set-process-plist new-process (copy-sequence (process-plist process)))
8464 new-process)))
8466 ;; things to maybe add (currently partly covered by `funcall mode'):
8467 ;; - syntax-table
8468 ;; - overlays
8469 (defun clone-buffer (&optional newname display-flag)
8470 "Create and return a twin copy of the current buffer.
8471 Unlike an indirect buffer, the new buffer can be edited
8472 independently of the old one (if it is not read-only).
8473 NEWNAME is the name of the new buffer. It may be modified by
8474 adding or incrementing <N> at the end as necessary to create a
8475 unique buffer name. If nil, it defaults to the name of the
8476 current buffer, with the proper suffix. If DISPLAY-FLAG is
8477 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8478 clone a file-visiting buffer, or a buffer whose major mode symbol
8479 has a non-nil `no-clone' property, results in an error.
8481 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8482 current buffer with appropriate suffix. However, if a prefix
8483 argument is given, then the command prompts for NEWNAME in the
8484 minibuffer.
8486 This runs the normal hook `clone-buffer-hook' in the new buffer
8487 after it has been set up properly in other respects."
8488 (interactive
8489 (progn
8490 (if buffer-file-name
8491 (error "Cannot clone a file-visiting buffer"))
8492 (if (get major-mode 'no-clone)
8493 (error "Cannot clone a buffer in %s mode" mode-name))
8494 (list (if current-prefix-arg
8495 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8496 t)))
8497 (if buffer-file-name
8498 (error "Cannot clone a file-visiting buffer"))
8499 (if (get major-mode 'no-clone)
8500 (error "Cannot clone a buffer in %s mode" mode-name))
8501 (setq newname (or newname (buffer-name)))
8503 (setq newname (substring newname 0 (match-beginning 0))))
8504 (let ((buf (current-buffer))
8505 (ptmin (point-min))
8506 (ptmax (point-max))
8507 (pt (point))
8508 (mk (if mark-active (mark t)))
8509 (modified (buffer-modified-p))
8510 (mode major-mode)
8511 (lvars (buffer-local-variables))
8512 (process (get-buffer-process (current-buffer)))
8513 (new (generate-new-buffer (or newname (buffer-name)))))
8514 (save-restriction
8515 (widen)
8516 (with-current-buffer new
8517 (insert-buffer-substring buf)))
8518 (with-current-buffer new
8519 (narrow-to-region ptmin ptmax)
8520 (goto-char pt)
8521 (if mk (set-mark mk))
8522 (set-buffer-modified-p modified)
8524 ;; Clone the old buffer's process, if any.
8525 (when process (clone-process process))
8527 ;; Now set up the major mode.
8528 (funcall mode)
8530 ;; Set up other local variables.
8531 (mapc (lambda (v)
8532 (condition-case ()
8533 (if (symbolp v)
8534 (makunbound v)
8535 (set (make-local-variable (car v)) (cdr v)))
8536 (setting-constant nil))) ;E.g. for enable-multibyte-characters.
8537 lvars)
8539 (setq mark-ring (mapcar (lambda (mk) (copy-marker (marker-position mk)))
8540 mark-ring))
8542 ;; Run any hooks (typically set up by the major mode
8543 ;; for cloning to work properly).
8544 (run-hooks 'clone-buffer-hook))
8545 (if display-flag
8546 ;; Presumably the current buffer is shown in the selected frame, so
8547 ;; we want to display the clone elsewhere.
8548 (let ((same-window-regexps nil)
8549 (same-window-buffer-names))
8550 (pop-to-buffer new)))
8551 new))
8554 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8555 "Create an indirect buffer that is a twin copy of the current buffer.
8557 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8558 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8559 or if not called with a prefix arg, NEWNAME defaults to the current
8560 buffer's name. The name is modified by adding a `<N>' suffix to it
8561 or by incrementing the N in an existing suffix. Trying to clone a
8562 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8563 property results in an error.
8565 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8566 This is always done when called interactively.
8568 Optional third arg NORECORD non-nil means do not put this buffer at the
8569 front of the list of recently selected ones.
8571 Returns the newly created indirect buffer."
8572 (interactive
8573 (progn
8574 (if (get major-mode 'no-clone-indirect)
8575 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8576 (list (if current-prefix-arg
8577 (read-buffer "Name of indirect buffer: " (current-buffer)))
8578 t)))
8579 (if (get major-mode 'no-clone-indirect)
8580 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8581 (setq newname (or newname (buffer-name)))
8583 (setq newname (substring newname 0 (match-beginning 0))))
8584 (let* ((name (generate-new-buffer-name newname))
8585 (buffer (make-indirect-buffer (current-buffer) name t)))
8586 (with-current-buffer buffer
8587 (run-hooks 'clone-indirect-buffer-hook))
8588 (when display-flag
8589 (pop-to-buffer buffer nil norecord))
8590 buffer))
8593 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8594 "Like `clone-indirect-buffer' but display in another window."
8595 (interactive
8596 (progn
8597 (if (get major-mode 'no-clone-indirect)
8598 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8599 (list (if current-prefix-arg
8600 (read-buffer "Name of indirect buffer: " (current-buffer)))
8601 t)))
8602 (let ((pop-up-windows t))
8603 (clone-indirect-buffer newname display-flag norecord)))
8605 \f
8606 ;;; Handling of Backspace and Delete keys.
8608 (defcustom normal-erase-is-backspace 'maybe
8609 "Set the default behavior of the Delete and Backspace keys.
8611 If set to t, Delete key deletes forward and Backspace key deletes
8612 backward.
8614 If set to nil, both Delete and Backspace keys delete backward.
8616 If set to `maybe' (which is the default), Emacs automatically
8617 selects a behavior. On window systems, the behavior depends on
8618 the keyboard used. If the keyboard has both a Backspace key and
8619 a Delete key, and both are mapped to their usual meanings, the
8620 option's default value is set to t, so that Backspace can be used
8621 to delete backward, and Delete can be used to delete forward.
8623 If not running under a window system, customizing this option
8624 accomplishes a similar effect by mapping C-h, which is usually
8625 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8626 via `keyboard-translate'. The former functionality of C-h is
8627 available on the F1 key. You should probably not use this
8628 setting if you don't have both Backspace, Delete and F1 keys.
8630 Setting this variable with setq doesn't take effect. Programmatically,
8631 call `normal-erase-is-backspace-mode' (which see) instead."
8632 :type '(choice (const :tag "Off" nil)
8633 (const :tag "Maybe" maybe)
8634 (other :tag "On" t))
8635 :group 'editing-basics
8636 :version "21.1"
8637 :set (lambda (symbol value)
8638 ;; The fboundp is because of a problem with :set when
8639 ;; dumping Emacs. It doesn't really matter.
8640 (if (fboundp 'normal-erase-is-backspace-mode)
8641 (normal-erase-is-backspace-mode (or value 0))
8642 (set-default symbol value))))
8644 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8645 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8646 (unless frame (setq frame (selected-frame)))
8647 (with-selected-frame frame
8648 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8649 (normal-erase-is-backspace-mode
8650 (if (if (eq normal-erase-is-backspace 'maybe)
8651 (and (not noninteractive)
8652 (or (memq system-type '(ms-dos windows-nt))
8653 (memq window-system '(w32 ns))
8654 (and (memq window-system '(x))
8655 (fboundp 'x-backspace-delete-keys-p)
8656 (x-backspace-delete-keys-p))
8657 ;; If the terminal Emacs is running on has erase char
8658 ;; set to ^H, use the Backspace key for deleting
8659 ;; backward, and the Delete key for deleting forward.
8660 (and (null window-system)
8661 (eq tty-erase-char ?\^H))))
8662 normal-erase-is-backspace)
8663 1 0)))))
8665 (define-minor-mode normal-erase-is-backspace-mode
8666 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8667 With a prefix argument ARG, enable this feature if ARG is
8668 positive, and disable it otherwise. If called from Lisp, enable
8669 the mode if ARG is omitted or nil.
8671 On window systems, when this mode is on, Delete is mapped to C-d
8672 and Backspace is mapped to DEL; when this mode is off, both
8673 Delete and Backspace are mapped to DEL. (The remapping goes via
8674 `local-function-key-map', so binding Delete or Backspace in the
8675 global or local keymap will override that.)
8677 In addition, on window systems, the bindings of C-Delete, M-Delete,
8678 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8679 the global keymap in accordance with the functionality of Delete and
8680 Backspace. For example, if Delete is remapped to C-d, which deletes
8681 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8682 to DEL, which deletes backward, C-Delete is bound to
8683 `backward-kill-word'.
8685 If not running on a window system, a similar effect is accomplished by
8686 remapping C-h (normally produced by the Backspace key) and DEL via
8687 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8688 to C-d; if it's off, the keys are not remapped.
8690 When not running on a window system, and this mode is turned on, the
8691 former functionality of C-h is available on the F1 key. You should
8692 probably not turn on this mode on a text-only terminal if you don't
8693 have both Backspace, Delete and F1 keys.
8695 See also `normal-erase-is-backspace'."
8696 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8697 . (lambda (v)
8698 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8699 (if v 1 0))))
8700 (let ((enabled (eq 1 (terminal-parameter
8701 nil 'normal-erase-is-backspace))))
8703 (cond ((or (memq window-system '(x w32 ns pc))
8704 (memq system-type '(ms-dos windows-nt)))
8705 (let ((bindings
8706 `(([M-delete] [M-backspace])
8707 ([C-M-delete] [C-M-backspace])
8708 ([?\e C-delete] [?\e C-backspace]))))
8710 (if enabled
8711 (progn
8712 (define-key local-function-key-map [delete] [deletechar])
8713 (define-key local-function-key-map [kp-delete] [deletechar])
8714 (define-key local-function-key-map [backspace] [?\C-?])
8715 (dolist (b bindings)
8716 ;; Not sure if input-decode-map is really right, but
8717 ;; keyboard-translate-table (used below) only works
8718 ;; for integer events, and key-translation-table is
8719 ;; global (like the global-map, used earlier).
8720 (define-key input-decode-map (car b) nil)
8721 (define-key input-decode-map (cadr b) nil)))
8722 (define-key local-function-key-map [delete] [?\C-?])
8723 (define-key local-function-key-map [kp-delete] [?\C-?])
8724 (define-key local-function-key-map [backspace] [?\C-?])
8725 (dolist (b bindings)
8726 (define-key input-decode-map (car b) (cadr b))
8727 (define-key input-decode-map (cadr b) (car b))))))
8728 (t
8729 (if enabled
8730 (progn
8731 (keyboard-translate ?\C-h ?\C-?)
8732 (keyboard-translate ?\C-? ?\C-d))
8733 (keyboard-translate ?\C-h ?\C-h)
8734 (keyboard-translate ?\C-? ?\C-?))))
8736 (if (called-interactively-p 'interactive)
8737 (message "Delete key deletes %s"
8738 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8739 "forward" "backward")))))
8740 \f
8741 (defvar vis-mode-saved-buffer-invisibility-spec nil
8742 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8744 (define-minor-mode read-only-mode
8745 "Change whether the current buffer is read-only.
8746 With prefix argument ARG, make the buffer read-only if ARG is
8747 positive, otherwise make it writable. If buffer is read-only
8748 and `view-read-only' is non-nil, enter view mode.
8750 Do not call this from a Lisp program unless you really intend to
8752 possibly enabling or disabling View mode. Also, note that this
8753 command works by setting the variable `buffer-read-only', which
8754 does not affect read-only regions caused by text properties. To
8755 ignore read-only status in a Lisp program (whether due to text
8756 properties or buffer state), bind `inhibit-read-only' temporarily
8757 to a non-nil value."
8758 :variable buffer-read-only
8759 (cond
8760 ((and (not buffer-read-only) view-mode)
8761 (View-exit-and-edit)
8762 (make-local-variable 'view-read-only)
8763 (setq view-read-only t)) ; Must leave view mode.
8764 ((and buffer-read-only view-read-only
8765 ;; If view-mode is already active, `view-mode-enter' is a nop.
8766 (not view-mode)
8767 (not (eq (get major-mode 'mode-class) 'special)))
8768 (view-mode-enter))))
8770 (define-minor-mode visible-mode
8771 "Toggle making all invisible text temporarily visible (Visible mode).
8772 With a prefix argument ARG, enable Visible mode if ARG is
8773 positive, and disable it otherwise. If called from Lisp, enable
8774 the mode if ARG is omitted or nil.
8776 This mode works by saving the value of `buffer-invisibility-spec'
8777 and setting it to nil."
8778 :lighter " Vis"
8779 :group 'editing-basics
8780 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8781 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8782 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8783 (when visible-mode
8784 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8785 buffer-invisibility-spec)
8786 (setq buffer-invisibility-spec nil)))
8787 \f
8788 (defvar messages-buffer-mode-map
8789 (let ((map (make-sparse-keymap)))
8790 (set-keymap-parent map special-mode-map)
8791 (define-key map "g" nil) ; nothing to revert
8792 map))
8794 (define-derived-mode messages-buffer-mode special-mode "Messages"
8797 (defun messages-buffer ()
8799 If it does not exist, create and it switch it to `messages-buffer-mode'."
8800 (or (get-buffer "*Messages*")
8801 (with-current-buffer (get-buffer-create "*Messages*")
8802 (messages-buffer-mode)
8803 (current-buffer))))
8805 \f
8806 ;; Minibuffer prompt stuff.
8808 ;;(defun minibuffer-prompt-modification (start end)
8809 ;; (error "You cannot modify the prompt"))
8810 ;;
8811 ;;
8812 ;;(defun minibuffer-prompt-insertion (start end)
8813 ;; (let ((inhibit-modification-hooks t))
8814 ;; (delete-region start end)
8815 ;; ;; Discard undo information for the text insertion itself
8816 ;; ;; and for the text deletion.above.
8817 ;; (when (consp buffer-undo-list)
8818 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8819 ;; (message "You cannot modify the prompt")))
8820 ;;
8821 ;;
8822 ;;(setq minibuffer-prompt-properties
8823 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8824 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8826 \f
8827 ;;;; Problematic external packages.
8829 ;; rms says this should be done by specifying symbols that define
8830 ;; versions together with bad values. This is therefore not as
8831 ;; flexible as it could be. See the thread:
8832 ;; https://lists.gnu.org/r/emacs-devel/2007-08/msg00300.html
8833 (defconst bad-packages-alist
8834 ;; Not sure exactly which semantic versions have problems.
8835 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8837 "The version of `semantic' loaded does not work in Emacs 22.
8838 It can cause constant high CPU load.
8839 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8840 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8841 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8842 ;; provided the `CUA-mode' feature. Since this is no longer true,
8843 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8844 (CUA-mode t nil
8845 "CUA-mode is now part of the standard GNU Emacs distribution,
8846 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8848 You have loaded an older version of CUA-mode which does not work
8849 correctly with this version of Emacs. You should remove the old
8850 version and use the one distributed with Emacs."))
8851 "Alist of packages known to cause problems in this version of Emacs.
8852 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8853 PACKAGE is either a regular expression to match file names, or a
8854 symbol (a feature name), like for `with-eval-after-load'.
8855 SYMBOL is either the name of a string variable, or t. Upon
8856 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8857 warning using STRING as the message.")
8859 (defun bad-package-check (package)
8860 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8861 (condition-case nil
8862 (let* ((list (assoc package bad-packages-alist))
8863 (symbol (nth 1 list)))
8864 (and list
8865 (boundp symbol)
8866 (or (eq symbol t)
8867 (and (stringp (setq symbol (eval symbol)))
8868 (string-match-p (nth 2 list) symbol)))
8869 (display-warning package (nth 3 list) :warning)))
8870 (error nil)))
8872 (dolist (elem bad-packages-alist)
8873 (let ((pkg (car elem)))
8874 (with-eval-after-load pkg
8875 (bad-package-check pkg))))
8877 \f
8878 ;;; Generic dispatcher commands
8880 ;; Macro `define-alternatives' is used to create generic commands.
8881 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8882 ;; that can have different alternative implementations where choosing
8883 ;; among them is exclusively a matter of user preference.
8885 ;; (define-alternatives COMMAND) creates a new interactive command
8886 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8887 ;; Typically, the user will not need to customize this variable; packages
8888 ;; wanting to add alternative implementations should use
8889 ;;
8890 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8892 (defmacro define-alternatives (command &rest customizations)
8893 "Define the new command `COMMAND'.
8895 The argument `COMMAND' should be a symbol.
8897 Running `M-x COMMAND RET' for the first time prompts for which
8898 alternative to use and records the selected command as a custom
8899 variable.
8901 Running `C-u M-x COMMAND RET' prompts again for an alternative
8902 and overwrites the previous choice.
8904 The variable `COMMAND-alternatives' contains an alist with
8905 alternative implementations of COMMAND. `define-alternatives'
8906 does not have any effect until this variable is set.
8908 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8909 `defcustom' keywords and values to add to the declaration of
8910 `COMMAND-alternatives' (typically :group and :version)."
8911 (let* ((command-name (symbol-name command))
8912 (varalt-name (concat command-name "-alternatives"))
8913 (varalt-sym (intern varalt-name))
8914 (varimp-sym (intern (concat command-name "--implementation"))))
8915 `(progn
8917 (defcustom ,varalt-sym nil
8918 ,(format "Alist of alternative implementations for the `%s' command.
8920 Each entry must be a pair (ALTNAME . ALTFUN), where:
8921 ALTNAME - The name shown at user to describe the alternative implementation.
8922 ALTFUN - The function called to implement this alternative."
8923 command-name)
8924 :type '(alist :key-type string :value-type function)
8925 ,@customizations)
8927 (put ',varalt-sym 'definition-name ',command)
8928 (defvar ,varimp-sym nil "Internal use only.")
8930 (defun ,command (&optional arg)
8931 ,(format "Run generic command `%s'.
8932 If used for the first time, or with interactive ARG, ask the user which
8933 implementation to use for `%s'. The variable `%s'
8934 contains the list of implementations currently supported for this command."
8935 command-name command-name varalt-name)
8936 (interactive "P")
8937 (when (or arg (null ,varimp-sym))
8938 (let ((val (completing-read
8939 ,(format-message
8940 "Select implementation for command `%s': "
8941 command-name)
8942 ,varalt-sym nil t)))
8943 (unless (string-equal val "")
8944 (when (null ,varimp-sym)
8945 (message
8946 "Use C-u M-x %s RET`to select another implementation"
8947 ,command-name)
8948 (sit-for 3))
8949 (customize-save-variable ',varimp-sym
8950 (cdr (assoc-string val ,varalt-sym))))))
8951 (if ,varimp-sym
8952 (call-interactively ,varimp-sym)
8953 (message "%s" ,(format-message
8954 "No implementation selected for command `%s'"
8955 command-name)))))))
8957 \f
8958 ;;; Functions for changing capitalization that Do What I Mean
8959 (defun upcase-dwim (arg)
8960 "Upcase words in the region, if active; if not, upcase word at point.
8961 If the region is active, this function calls `upcase-region'.
8962 Otherwise, it calls `upcase-word', with prefix argument passed to it
8963 to upcase ARG words."
8964 (interactive "*p")
8965 (if (use-region-p)
8966 (upcase-region (region-beginning) (region-end))
8967 (upcase-word arg)))
8969 (defun downcase-dwim (arg)
8970 "Downcase words in the region, if active; if not, downcase word at point.
8971 If the region is active, this function calls `downcase-region'.
8972 Otherwise, it calls `downcase-word', with prefix argument passed to it
8973 to downcase ARG words."
8974 (interactive "*p")
8975 (if (use-region-p)
8976 (downcase-region (region-beginning) (region-end))
8977 (downcase-word arg)))
8979 (defun capitalize-dwim (arg)
8980 "Capitalize words in the region, if active; if not, capitalize word at point.
8981 If the region is active, this function calls `capitalize-region'.
8982 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8983 to capitalize ARG words."
8984 (interactive "*p")
8985 (if (use-region-p)
8986 (capitalize-region (region-beginning) (region-end))
8987 (capitalize-word arg)))
8989 \f
8991 (provide 'simple)
8993 ;;; simple.el ends here