| blob | 9483170a0b6d6df693692fda11c43abf83b7459d |
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'."
283 ;; we know here that next-error-function is a valid symbol we can funcall
291 "Visit the source code corresponding to the `next-error' message at point."
293 ;; we know here that next-error-function is a valid symbol we can funcall
304 "Visit previous `next-error' message and corresponding source code.
306 Prefix arg N says how many error messages to move backwards (or
307 forwards, if negative).
314 "Restart at the first error.
315 Visit corresponding source code.
316 With prefix arg N, visit the source code of the Nth error.
322 "Move point to the next error in the `next-error' buffer and highlight match.
323 Prefix arg N says how many error messages to move forwards (or
324 backwards, if negative).
326 select the source buffer."
333 "Move point to the previous error in the `next-error' buffer and highlight match.
334 Prefix arg N says how many error messages to move backwards (or
335 forwards, if negative).
337 select the source buffer."
341 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
345 "Minor mode for compilation, occur and diff modes.
346 With a prefix argument ARG, enable mode if ARG is positive, and
347 disable it otherwise. If called from Lisp, enable mode if ARG is
348 omitted or nil.
349 When turned on, cursor motion in the compilation, grep, occur or diff
350 buffer causes automatic display of the corresponding source code location."
357 ;; Used as a `post-command-hook' by `next-error-follow-mode'
358 ;; for the *Compilation* *grep* and *Occur* buffers.
368 \f
369 ;;;
372 "Major mode not specialized for anything in particular.
373 Other major modes are defined by comparison with this one."
378 ;; Special major modes to view specially formatted data rather than files.
392 map))
396 "Parent major mode from which special major modes should inherit."
399 ;; Making and deleting lines.
402 "Special hook to tell if `self-insert-command' will use the region.
403 It must be called via `run-hook-with-args-until-success' with no arguments.
405 If any function on this hook returns a non-nil value, `delete-selection-mode'
406 will act on that value (see `delete-selection-helper'), and will
407 usually delete the region. If all the functions on this hook return
408 nil, it is an indiction that `self-insert-command' needs the region
409 untouched by `delete-selection-mode', and will itself do whatever is
410 appropriate with the region.
411 Any function on `post-self-insert-hook' which act on the region should
412 add a function to this hook so that `delete-selection-mode' could
413 refrain from deleting the region before `post-self-insert-hook'
414 functions are called.
421 "Insert a newline, and move to left margin of the new line if it's blank.
422 If option `use-hard-newlines' is non-nil, the newline is marked with the
423 text-property `hard'.
424 With ARG, insert that many newlines.
426 If `electric-indent-mode' is enabled, this indents the final new line
427 that it adds, and reindents the preceding line. To just insert
430 Calls `auto-fill-function' if the current column number is greater
431 than the value of `fill-column' and ARG is nil.
432 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
435 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
436 ;; Set last-command-event to tell self-insert what to insert.
440 ;; Don't auto-fill if we have a numeric argument.
444 ;; Do the rest in post-self-insert-hook, because we want to do it
445 ;; *before* other functions on that hook.
447 ;; Mark the newline(s) `hard'.
451 ;; If the newline leaves the previous line blank, and we
452 ;; have a left margin, delete that from the blank line.
460 ;; Indent the line after the newline, except in one case:
461 ;; when we added the newline at the beginning of a line which
462 ;; starts a page.
466 ;; FIXME: For non-interactive uses, many calls actually
467 ;; just want (insert "\n"), so maybe we should do just
468 ;; that, so as to avoid the risk of filling or running
469 ;; abbrevs unexpectedly.
476 ;; We first used let-binding to protect the hook, but that
477 ;; was naive since add-hook affects the symbol-default
478 ;; value of the variable, whereas the let-binding might
479 ;; only protect the buffer-local value.
481 nil)
486 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
492 "Insert a newline and leave point before it.
493 If there is a fill prefix and/or a `left-margin', insert them on
494 the new line if the line would have been blank.
495 With arg N, insert N newlines."
500 ;; Don't expand an abbrev before point.
511 ;; Necessary in case a margin or prefix was inserted.
515 "Split current line, moving portion beyond point vertically down.
516 If the current line starts with `fill-prefix', insert it on the new
517 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
519 When called from Lisp code, ARG may be a prefix string to copy."
524 ;; What prefix should we check for (nil means don't).
528 ;; Does this line start with it?
539 "Join this line to previous and fix up whitespace at join.
540 If there is a fill prefix, delete it from the beginning of this line.
541 With argument, join this line to following line."
548 ;; If the second line started with the fill prefix,
549 ;; delete the prefix.
561 "On blank line, delete all surrounding blank lines, leaving just one.
562 On isolated blank line, delete that one.
563 On nonblank line, delete any immediately following blank lines."
569 ;; Set singleblank if there is just one blank line here.
576 ;; Delete preceding blank lines, and this one too if it's the only one.
585 ;; Delete following blank lines, unless the current line is blank
586 ;; and there are no following blank lines.
595 ;; Handle the special case where point is followed by newline and eob.
596 ;; Delete the line, leaving point at eob.
602 Trailing lines are deleted only if `delete-trailing-whitespace'
603 is called on the entire buffer (rather than an active region)."
609 "Return non-nil if the region contains no read-only text."
614 "Delete trailing whitespace between START and END.
615 If called interactively, START and END are the start/end of the
616 region if the mark is active, or of the buffer's accessible
617 portion if the mark is inactive.
619 This command deletes whitespace characters after the last
620 non-whitespace character in each line between START and END. It
621 does not consider formfeed characters to be whitespace.
623 If this command acts on the entire buffer (i.e. if called
624 interactively with the mark inactive, or called from Lisp with
625 END nil), it also deletes all trailing lines at the end of the
626 buffer if the variable `delete-trailing-lines' is non-nil."
637 ;; Don't delete formfeeds, even if they are considered whitespace.
646 ;; Delete trailing empty lines.
648 ;; Really the end of buffer.
653 ;; Return nil for the benefit of `write-file-functions'.
654 nil)
657 "Insert a newline, then indent according to major mode.
658 Indentation is done using the value of `indent-line-function'.
659 In programming language modes, this is the same as TAB.
660 In some text modes, where TAB inserts a tab, this command indents to the
661 column specified by the function `current-left-margin'."
668 "Reindent current line, insert newline, then indent the new line.
669 Indentation of both lines is done according to the current major mode,
670 which means calling the current value of `indent-line-function'.
671 In programming language modes, this is the same as TAB.
672 In some text modes, where TAB inserts a tab, this indents to the
673 column specified by the function `current-left-margin'."
676 ;; Be careful to insert the newline before indenting the line.
677 ;; Otherwise, the indentation might be wrong.
681 ;; We are at EOL before the call to indent-according-to-mode, and
682 ;; after it we usually are as well, but not always. We tried to
683 ;; address it with `save-excursion' but that uses a normal marker
684 ;; whereas we need `move after insertion', so we do the save/restore
685 ;; by hand.
689 ;; Remove the trailing white-space after indentation because
690 ;; indentation may introduce the whitespace.
696 Legitimate radix values are 8, 10 and 16."
701 "Like `read-char', but do not allow quitting.
702 Also, if the first character read is an octal digit,
703 we read any number of octal digits and return the
704 specified character code. Any nondigit terminates the sequence.
705 If the terminator is RET, it is discarded;
706 any other terminator is used itself as input.
708 The optional argument PROMPT specifies a string to use to prompt the user.
709 The variable `read-quoted-char-radix' controls which radix to use
710 for numeric input."
713 help-event-list)))
717 ;; Don't let C-h or other help chars get the help
718 ;; message--only help function keys. See bug#16617.
722 "Type the special character you want to use,
723 or the octal character code.
724 RET terminates the character code and is discarded;
728 ;; Translate TAB key into control-I ASCII character, and so on.
729 ;; Note: `read-char' does it using the `ascii-character' property.
730 ;; We tried using read-key instead, but that disables the keystroke
731 ;; echo produced by 'C-q', see bug#24635.
735 char)))
741 done t))
743 ;; Turn a meta-character into a character with the 0200 bit set.
745 done t))
760 done t))
762 done t)))
764 code))
767 "Read next input character and insert it.
768 This is useful for inserting control characters.
769 With argument, insert ARG copies of the character.
771 If the first character you type after this command is an octal digit,
772 you should type a sequence of octal digits which specify a character code.
773 Any nondigit terminates the sequence. If the terminator is a RET,
774 it is discarded; any other terminator is used itself as input.
775 The variable `read-quoted-char-radix' specifies the radix for this feature;
776 set it to 10 or 16 to use decimal or hex instead of octal.
778 In overwrite mode, this function inserts the character anyway, and
779 does not handle octal digits specially. This means that if you use
780 overwrite as your normal editing mode, you can use this function to
781 insert characters when necessary.
783 In binary overwrite mode, this function does overwrite, and octal
784 digits are interpreted as a character code. This is intended to be
785 useful for editing binary files."
788 ;; Avoid "obsolete" warnings for translation-table-for-input.
795 ;; This used to assume character codes 0240 - 0377 stand for
796 ;; characters in some single-byte character set, and converted them
797 ;; to Emacs characters. But in 23.1 this feature is deprecated
798 ;; in favor of inserting the corresponding Unicode characters.
799 ;; (if (and enable-multibyte-characters
800 ;; (>= char ?\240)
801 ;; (<= char ?\377))
802 ;; (setq char (unibyte-char-to-multibyte char)))
814 "Move forward ARG lines and position at first nonblank character."
820 "Move backward ARG lines and position at first nonblank character."
826 "Move point to the first non-whitespace character on this line."
830 ;; Move back over chars that have whitespace syntax but have the p flag.
834 "Fixup white space between objects around point.
835 Leave one space or none, according to the context."
842 nil
846 "Delete all spaces and tabs around point.
847 If BACKWARD-ONLY is non-nil, only delete them before point."
852 orig-pos
861 "Delete all spaces and tabs around point, leaving one space (or N spaces).
862 If N is negative, delete newlines as well, leaving -N spaces.
863 See also `cycle-spacing'."
868 "Store context used in consecutive calls to `cycle-spacing' command.
869 The first time `cycle-spacing' runs, it saves in this variable:
870 its N argument, the original point position, and the original spacing
874 "Manipulate whitespace around point in a smart way.
875 In interactive use, this function behaves differently in successive
876 consecutive calls.
878 The first call in a sequence acts like `just-one-space'.
879 It deletes all spaces and tabs around point, leaving one space
880 \(or N spaces). N is the prefix argument. If N is negative,
881 it deletes newlines as well, leaving -N spaces.
882 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
884 The second call in a sequence deletes all spaces.
886 The third call in a sequence restores the original whitespace (and point).
888 If MODE is `single-shot', it only performs the first step in the sequence.
889 If MODE is `fast' and the first step would not result in any change
890 \(i.e., there are exactly (abs N) spaces around point),
891 the function goes straight to the second step.
893 Repeatedly calling the function with different values of N starts a
894 new sequence each time."
902 ;; Command run for the first time, single-shot mode or different argument
914 ;; Special handling for case where there was no space at all.
917 ;; If this run causes no change in buffer content, delete all spaces,
918 ;; otherwise delete all excess spaces.
923 ;; Command run for the second time.
927 ;; Command run for the third time.
932 \f
934 "Move point to the beginning of the buffer.
935 With numeric arg N, put point N/10 of the way from the beginning.
936 If the buffer is narrowed, this command uses the beginning of the
937 accessible part of the buffer.
940 is supplied, or Transient Mark mode is enabled and the mark is active."
950 ;; Avoid overflow for large buffer sizes!
958 "Move point to the end of the buffer.
959 With numeric arg N, put point N/10 of the way from the end.
960 If the buffer is narrowed, this command uses the end of the
961 accessible part of the buffer.
964 is supplied, or Transient Mark mode is enabled and the mark is active."
972 ;; Avoid overflow for large buffer sizes!
977 ;; If we went to a place in the middle of the buffer,
978 ;; adjust it to the beginning of a line.
982 ;; If the end of the buffer is not already on the screen,
983 ;; then scroll specially to put it near, but not at, the bottom.
988 "Whether single-char deletion commands delete an active region.
989 This has an effect only if Transient Mark mode is enabled, and
990 affects `delete-forward-char' and `delete-backward-char', though
991 not `delete-char'.
993 If the value is the symbol `kill', the active region is killed
994 instead of deleted."
1011 "Function to get the region's content.
1012 Called with one argument METHOD which can be:
1013 - nil: return the content as a string.
1014 - `delete-only': delete the region; the return value is undefined.
1015 - `bounds': return the boundaries of the region as a list of cons
1016 cells of the form (START . END).
1017 - anything else: delete the region and return its content
1018 as a string, after filtering it with `filter-buffer-substring', which
1029 first nil))))
1030 "Function to insert the region's content.
1031 Called with one argument LINES.
1035 "Delete the previous N characters (following if N is negative).
1036 If Transient Mark mode is enabled, the mark is active, and N is 1,
1037 delete the text in the region and deactivate the mark instead.
1038 To disable this, set option `delete-active-region' to nil.
1040 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1041 kill ring) instead of delete. Interactively, N is the prefix
1042 arg, and KILLFLAG is set if N is explicitly specified.
1044 When killing, the killed text is filtered by
1045 `filter-buffer-substring' before it is saved in the kill ring, so
1046 the actual saved text might be different from what was killed.
1048 In Overwrite mode, single character backward deletion may replace
1049 tabs with spaces so as to back over columns, unless point is at
1050 the end of the line."
1056 delete-active-region
1058 ;; If a region is active, kill or delete it.
1062 ;; In Overwrite mode, maybe untabify while deleting
1072 ;; Otherwise, do simple deletion.
1076 "Delete the following N characters (previous if N is negative).
1077 If Transient Mark mode is enabled, the mark is active, and N is 1,
1078 delete the text in the region and deactivate the mark instead.
1079 To disable this, set variable `delete-active-region' to nil.
1081 Optional second arg KILLFLAG non-nil means to kill (save in kill
1082 ring) instead of delete. Interactively, N is the prefix arg, and
1083 KILLFLAG is set if N was explicitly specified.
1085 When killing, the killed text is filtered by
1086 `filter-buffer-substring' before it is saved in the kill ring, so
1087 the actual saved text might be different from what was killed."
1093 delete-active-region
1095 ;; If a region is active, kill or delete it.
1100 ;; Otherwise, do simple deletion.
1104 "Put point at beginning and mark at end of buffer.
1105 If narrowing is in effect, only uses the accessible part of the buffer.
1106 You probably should not use this function in Lisp programs;
1107 it is usually a mistake for a Lisp function to use any subroutine
1108 that uses or sets the mark."
1113 ;; This is really `point-min' in most cases, but if we're in the
1114 ;; minibuffer, this is at the end of the prompt.
1116 \f
1118 ;; Counting lines, one way or another.
1121 "Go to LINE, counting from line 1 at beginning of buffer.
1122 If called interactively, a numeric prefix argument specifies
1123 LINE; without a numeric prefix argument, read LINE from the
1124 minibuffer.
1126 If optional argument BUFFER is non-nil, switch to that buffer and
1128 as argument, BUFFER is the most recently selected other buffer.
1130 Prior to moving point, this function sets the mark (without
1131 activating it), unless Transient Mark mode is enabled and the
1132 mark is already active.
1134 This function is usually the wrong thing to use in a Lisp program.
1135 What you probably want instead is something like:
1136 (goto-char (point-min))
1137 (forward-line (1- N))
1138 If at all possible, an even better solution is to use char counts
1139 rather than line counts."
1144 ;; Look for a default, a number in the buffer at point.
1154 ;; Decide if we're switching buffers.
1162 ;; Read the argument, offering that number (if any) as default.
1165 buffer))))
1166 ;; Switch to the desired buffer, one way or another.
1171 ;; Leave mark at previous position
1173 ;; Move to the specified line number in that buffer.
1182 "Count the number of words in the region.
1183 If called interactively, print a message reporting the number of
1184 lines, words, and characters in the region (whether or not the
1185 region is active); with prefix ARG, report for the entire buffer
1186 rather than the region.
1188 If called from Lisp, return the number of words between positions
1189 START and END."
1201 "Count words between START and END.
1202 If called interactively, START and END are normally the start and
1203 end of the buffer; but if the region is active, START and END are
1204 the start and end of the region. Print a message reporting the
1205 number of lines, words, and chars.
1207 If called from Lisp, return the number of words between START and
1208 END, without printing any message."
1218 words))
1234 str
1242 "Print the current buffer line number and narrowed line number of point."
1255 "Return number of lines between START and END.
1256 This is usually the number of newlines between them,
1257 but can be one more if START is not equal to END
1258 and the greater of them is not at the start of a line."
1274 done)))
1278 "Return buffer line number at position POS.
1279 If POS is nil, use current buffer location.
1281 If ABSOLUTE is nil, the default, counting starts
1282 at (point-min), so the value refers to the contents of the
1283 accessible portion of the (potentially narrowed) buffer. If
1284 ABSOLUTE is non-nil, ignore any narrowing and return the
1285 absolute line number."
1298 "Print info on cursor position (on screen and within buffer).
1299 Also describe the character after point, and give its character code
1300 in octal, decimal and hex.
1302 For a non-ASCII multibyte character, also give its encoding in the
1303 buffer's selected coding system if the coding system encodes the
1304 character safely. If the character is encoded into one byte, that
1305 code is shown in hex. If the character is encoded into more than one
1308 In addition, with prefix argument, show details about that character
1309 in *Help* buffer. See also the command `describe-char'."
1313 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1314 ;; start a directional embedding, which could completely
1315 ;; disrupt the rest of the line (e.g., RLO will display the
1316 ;; rest of the line right-to-left). So we put an invisible
1317 ;; PDF character after these characters, to end the
1318 ;; embedding, which eliminates any effects on the rest of
1319 ;; the line. For RLE and RLO we also append an invisible
1320 ;; LRM, to avoid reordering the following numerical
1321 ;; characters. For LRI/RLI/FSI we append a PDI.
1328 ;; Strong right-to-left characters cause reordering of
1329 ;; the following numerical characters which show the
1330 ;; codepoint, so append LRM to countermand that.
1341 ""
1347 pos total percent beg end col hscroll)
1349 pos total col hscroll))
1351 encoded encoding-msg display-prop under-display)
1358 ;; Check if the character is displayed with some `display'
1359 ;; text property. In that case, set under-display to the
1360 ;; buffer substring covered by that property.
1371 under-display)))
1377 char char char under-display)
1379 char char char under-display display-prop))
1382 char char char
1384 "..."
1388 ;; We show the detailed information about CHAR.
1395 bidi-fixer
1396 encoding-msg pos total percent beg end col hscroll)
1403 bidi-fixer encoding-msg pos total percent col hscroll))))))
1404 \f
1405 ;; Initialize read-expression-map. It is defined at C level.
1409 ;; Might as well bind TAB to completion, since inserting a TAB char is
1410 ;; much too rarely useful.
1413 m))
1416 "Return a Lisp object read using the minibuffer, unevaluated.
1417 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1418 is a string to insert in the minibuffer before reading.
1419 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1420 Such arguments are used as in `read-from-minibuffer'.)"
1421 ;; Used for interactive spec `x'.
1426 "Return value of Lisp expression read using the minibuffer.
1427 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1428 is a string to insert in the minibuffer before reading.
1429 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1430 Such arguments are used as in `read-from-minibuffer'.)"
1431 ;; Used for interactive spec `X'.
1439 "The current default value or list of default values in the minibuffer.
1440 The functions `read-from-minibuffer' and `completing-read' bind
1444 "Value for `print-level' while printing value in `eval-expression'.
1445 A value of nil means no limit."
1451 "Value for `print-length' while printing value in `eval-expression'.
1452 A value of nil means no limit."
1458 "If non-nil set `debug-on-error' to t in `eval-expression'.
1459 If nil, don't change the value of `debug-on-error'."
1465 "The largest integer that will be displayed as a character.
1466 This affects printing by `eval-expression' (via
1467 `eval-expression-print-format')."
1473 "If VALUE in an integer, return a specially formatted string.
1475 If VALUE is not an integer, nil is returned.
1476 This function is used by commands like `eval-expression' that
1477 display the result of expression evaluation."
1495 ;; FIXME: call emacs-lisp-mode?
1503 read-expression-map t
1507 "Get arguments for commands that print an expression result.
1508 Returns a list (INSERT-VALUE NO-TRUNCATE CHAR-PRINT-LIMIT)
1509 based on PREFIX-ARG. This function determines the interpretation
1510 of the prefix argument for `eval-expression' and
1511 `eval-last-sexp'."
1519 ;; We define this, rather than making `eval' interactive,
1520 ;; for the sake of completion of names like eval-region, eval-buffer.
1522 "Evaluate EXP and print value in the echo area.
1523 When called interactively, read an Emacs Lisp expression and
1524 evaluate it. Value is also consed on to front of the variable
1525 `values'. Optional argument INSERT-VALUE non-nil (interactively,
1526 with a non `-' prefix argument) means insert the result into the
1527 current buffer instead of printing it in the echo area.
1529 Normally, this function truncates long output according to the
1530 value of the variables `eval-expression-print-length' and
1531 `eval-expression-print-level'. When NO-TRUNCATE is
1532 non-nil (interactively, with a prefix argument of zero), however,
1533 there is no such truncation.
1535 If the resulting value is an integer, and CHAR-PRINT-LIMIT is
1536 non-nil (interactively, unless given a positive prefix argument)
1537 it will be printed in several additional formats (octal,
1538 hexadecimal, and character). The character format is only used
1539 if the value is below CHAR-PRINT-LIMIT (interactively, if the
1540 prefix argument is -1 or the value is below
1541 `eval-expression-print-maximum-character').
1543 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1544 minibuffer.
1546 If `eval-expression-debug-on-error' is non-nil, which is the default,
1547 this command arranges for all errors to enter the debugger."
1555 ;; Bind debug-on-error to something unique so that we can
1556 ;; detect when evalled code changes it.
1560 ;; If evalled code has changed the value of debug-on-error,
1561 ;; propagate that change to the global binding.
1577 "Prompting with PROMPT, let user edit COMMAND and eval result.
1578 COMMAND is a Lisp expression. Let user edit that expression in
1579 the minibuffer, then read and evaluate the result."
1586 read-expression-map t
1588 ;; If command was added to command-history as a string,
1589 ;; get rid of that. We want only evaluable expressions there.
1593 ;; If command to be redone does not match front of history,
1594 ;; add it to the history.
1600 "Edit and re-evaluate last complex command, or ARGth from last.
1601 A complex command is one which used the minibuffer.
1602 The command is placed in the minibuffer as a Lisp form for editing.
1603 The result is executed, repeating the command as changed.
1604 If the command has been changed or is not the most recent previous
1605 command it is added to the front of the command history.
1606 You can use the minibuffer history commands \
1608 to get different commands to edit and resubmit."
1611 newcmd)
1623 ;; If command was added to command-history as a
1624 ;; string, get rid of that. We want only
1625 ;; evaluable expressions there.
1629 ;; If command to be redone does not match front of history,
1630 ;; add it to the history.
1645 "Read command name to invoke in `execute-extended-command'."
1655 ;; Get a command name at point in the original buffer
1656 ;; to propose it after M-n.
1660 ;; Read a string, completing from and restricting to the set of
1661 ;; all defined commands. Don't provide any initial input.
1662 ;; Save the command read on the extended-command history list.
1673 ;; This isn't strictly correct if `execute-extended-command'
1674 ;; is bound to anything else (e.g. [menu]).
1675 ;; It could use (key-description (this-single-command-keys)),
1676 ;; but actually a prompt other than "M-x" would be confusing,
1677 ;; because "M-x" is a well-known prompt to read a command
1678 ;; and it serves as a shorthand for "Extended command: ".
1683 ;; Exclude obsolete commands from completions.
1688 pred)))
1693 "Non-nil means show the equivalent key-binding when M-x command has one.
1694 The value can be a length of time to show the message for.
1695 If the value is non-nil and not a number, we wait 2 seconds."
1702 "If non-nil, show a shorter M-x invocation when there is one."
1723 binding)
1729 name len)))
1730 ;; Don't show the help message if the binding isn't
1731 ;; significantly shorter than the M-x command the user typed.
1739 binding))
1742 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1743 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1744 "Read a command name, then read the arguments and call the command.
1745 To pass a prefix argument to the command you are
1746 invoking, give a prefix argument to `execute-extended-command'."
1748 ;; FIXME: Remember the actual text typed by the user before completion,
1749 ;; so that we don't later on suggest the same shortening.
1754 execute-extended-command--last-typed)))
1755 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1767 ;; Some features, such as novice.el, rely on this-command-keys
1768 ;; including M-x COMMAND-NAME RET.
1771 ;; Normally `real-this-command' should never be changed, but here we really
1772 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1773 ;; binding" for <cmd>, so the command the user really wanted to run is
1774 ;; `function' and not `execute-extended-command'. The difference is
1775 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1779 ;; If enabled, show which key runs this command.
1780 ;; But first wait, and skip the message if there is input.
1782 ;; If this command displayed something in the echo area;
1783 ;; wait a few seconds, then display our suggestion message.
1784 ;; FIXME: Wait *after* running post-command-hook!
1785 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1786 ;; find a better answer anyway!
1796 ;; There's no binding for CMD. Let's try and find the shortest
1797 ;; string to use in M-x.
1798 ;; FIXME: Can be slow. Cache it maybe?
1805 function
1810 suggest-key-bindings
1814 ;; BEWARE: Called directly from the C code.
1815 "Execute CMD as an editor command.
1816 CMD must be a symbol that satisfies the `commandp' predicate.
1817 Optional second arg RECORD-FLAG non-nil
1818 means unconditionally put this command in the variable `command-history'.
1819 Otherwise, that is done only if an arg is read using the minibuffer.
1820 The argument KEYS specifies the value to use instead of (this-command-keys)
1821 when reading the arguments; if it is nil, (this-command-keys) is used.
1822 The argument SPECIAL, if non-nil, means that this command is executing
1823 a special event, so ignore the prefix argument and don't clear it."
1826 ;; FIXME: This should probably be done around
1827 ;; pre-command-hook rather than here!
1835 disabled-command-function)
1836 ;; FIXME: Weird calling convention!
1846 ;; If requested, place the macro in the command history. For
1847 ;; other sorts of commands, call-interactively takes care of this.
1850 ;; Don't keep command history around forever.
1856 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1864 \f
1866 "Default minibuffer history list.
1867 This is used for all minibuffer input
1868 except when an alternate history list is specified.
1870 Maximum length of the history list is determined by the value
1873 "Control whether history list elements are expressions or strings.
1874 If the value of this variable equals current minibuffer depth,
1875 they are expressions; otherwise they are strings.
1876 \(That convention is designed to do the right thing for
1883 "Text that was in this minibuffer before any history commands.
1884 This is nil if there have not yet been any history commands
1893 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1898 "Minibuffer history variables for which matching should ignore case.
1899 If a history variable is a member of this list, then the
1901 commands ignore case when searching it, regardless of `case-fold-search'."
1906 "Find the previous history element that matches REGEXP.
1907 \(Previous history elements refer to earlier actions.)
1908 With prefix argument N, search for Nth previous match.
1909 If N is negative, find the next or Nth next match.
1910 Normally, history elements are matched case-insensitively if
1911 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1912 makes the search case-sensitive.
1913 See also `minibuffer-history-case-insensitive-variables'."
1917 nil
1918 minibuffer-local-map
1919 nil
1920 'minibuffer-history-search-history
1922 ;; Use the last regexp specified, by default, if input is empty.
1927 regexp)
1937 ;; On some systems, ignore case for file names.
1939 minibuffer-history-case-insensitive-variables)
1940 t
1941 ;; Respect the user's setting for case-fold-search:
1942 case-fold-search)
1943 nil))
1944 prevpos
1945 match-string
1946 match-offset
1953 "No later matching history item"
1974 next-matching-history-element))
1978 "Find the next history element that matches REGEXP.
1979 \(The next history element refers to a more recent action.)
1980 With prefix argument N, search for Nth next match.
1981 If N is negative, find the previous or Nth previous match.
1982 Normally, history elements are matched case-insensitively if
1983 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1984 makes the search case-sensitive."
1988 nil
1989 minibuffer-local-map
1990 nil
1991 'minibuffer-history-search-history
1993 ;; Use the last regexp specified, by default, if input is empty.
1998 regexp)
2005 "Function run by `goto-history-element' before consuming default values.
2006 This is useful to dynamically add more elements to the list of default values
2007 when `goto-history-element' reaches the end of this list.
2008 Before calling this function `goto-history-element' sets the variable
2009 `minibuffer-default-add-done' to t, so it will call this function only
2010 once. In special cases, when this function needs to be called more
2011 than once, it can set `minibuffer-default-add-done' to nil explicitly,
2015 "When nil, add more elements to the end of the list of default values.
2016 The value nil causes `goto-history-element' to add more elements to
2017 the list of defaults when it reaches the end of this list. It does
2023 "Return a list of all completions without the default value.
2024 This function is used to add all elements of the completion table to
2025 the end of the list of defaults just after the default value."
2028 minibuffer-completion-table
2029 minibuffer-completion-predicate)))
2035 "Puts element of the minibuffer history in the minibuffer.
2036 The argument NABS specifies the absolute history position."
2050 elt minibuffer-returned-to-present)
2057 "End of defaults; no next item"
2064 previous-history-element))
2076 minibuffer-default)))
2088 elt))
2092 "Puts next element of the minibuffer history in the minibuffer.
2093 With argument N, it uses the Nth following element."
2099 "Puts previous element of the minibuffer history in the minibuffer.
2100 With argument N, it uses the Nth previous element."
2106 "Move cursor vertically down ARG lines, or to the next history element.
2107 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2108 next element of the minibuffer history in the minibuffer."
2112 ;; Don't add newlines if they have the mode enabled globally.
2114 ;; Remember the original goal column of possibly multi-line input
2115 ;; excluding the length of the prompt on the first line.
2125 ;; Restore old position since `line-move-visual' moves point to
2126 ;; the end of the line when it fails to go to the next line.
2129 ;; Reset `temporary-goal-column' because a correct value is not
2130 ;; calculated when `next-line' above fails by bumping against
2131 ;; the bottom of the minibuffer (bug#22544).
2133 ;; Restore the original goal column on the last line
2134 ;; of possibly multi-line input.
2142 "Move cursor vertically up ARG lines, or to the previous history element.
2143 When point moves over the top line of multi-line minibuffer, puts ARGth
2144 previous element of the minibuffer history in the minibuffer."
2148 ;; Remember the original goal column of possibly multi-line input
2149 ;; excluding the length of the prompt on the first line.
2159 ;; Restore old position since `line-move-visual' moves point to
2160 ;; the beginning of the line when it fails to go to the previous line.
2163 ;; Reset `temporary-goal-column' because a correct value is not
2164 ;; calculated when `previous-line' above fails by bumping against
2165 ;; the top of the minibuffer (bug#22544).
2167 ;; Restore the original goal column on the first line
2168 ;; of possibly multi-line input.
2174 ;; Put the cursor at the end of the visual line instead of the
2175 ;; logical line, so the next `previous-line-or-history-element'
2176 ;; would move to the previous history element, not to a possible upper
2177 ;; visual line from the end of logical line in `line-move-visual' mode.
2179 ;; Since `end-of-visual-line' puts the cursor at the beginning
2180 ;; of the next visual line, move it one char back to the end
2181 ;; of the first visual line (bug#22544).
2185 "Get next history element which completes the minibuffer before the point.
2186 The contents of the minibuffer after the point are deleted, and replaced
2187 by the new completion."
2193 n)
2194 ;; next-matching-history-element always puts us at (point-min).
2195 ;; Move to the position we were at before changing the buffer contents.
2196 ;; This is still sensible, because the text before point has not changed.
2200 "\
2201 Get previous history element which completes the minibuffer before the point.
2202 The contents of the minibuffer after the point are deleted, and replaced
2203 by the new completion."
2207 ;; For compatibility with the old subr of the same name.
2209 "Return the display width of the minibuffer prompt.
2210 Return 0 if current buffer is not a minibuffer."
2211 ;; Return the width of everything before the field at the end of
2212 ;; the buffer; this should be 0 for normal buffers.
2214 \f
2215 ;; isearch minibuffer history
2222 "Set up a minibuffer for using isearch to search the minibuffer history.
2223 Intended to be added to `minibuffer-setup-hook'."
2235 "Clean up the minibuffer after terminating isearch in the minibuffer."
2240 "Return the proper search function, for isearch in minibuffer history."
2243 ;; Use standard functions to search within minibuffer text
2245 found)
2246 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2247 ;; searching forward. Lazy-highlight calls this lambda with the
2248 ;; bound arg, so skip the minibuffer prompt.
2252 ;; 1. First try searching in the initial minibuffer text
2255 noerror)
2256 ;; 2. If the above search fails, start putting next/prev history
2257 ;; elements in the minibuffer successively, and search the string
2258 ;; in them. Do this only when bound is nil (i.e. not while
2259 ;; lazy-highlighting search strings in the current minibuffer text).
2271 ;; After putting the next/prev history element, search
2272 ;; the string in them again, until next-history-element
2273 ;; or previous-history-element raises an error at the
2274 ;; beginning/end of history.
2277 ;; For backward search, don't search
2278 ;; in the minibuffer prompt
2280 noerror)))
2281 ;; Return point of the new search result
2283 ;; Return nil when next(prev)-history-element fails
2287 "Display the minibuffer history search prompt.
2288 If there are no search errors, this function displays an overlay with
2289 the isearch prompt which replaces the original minibuffer prompt.
2290 Otherwise, it displays the standard isearch message returned from
2291 the function `isearch-message'."
2293 ;; Use standard function `isearch-message' when not in the minibuffer,
2294 ;; or search fails, or has an error (like incomplete regexp).
2295 ;; This function overwrites minibuffer text with isearch message,
2296 ;; so it's possible to see what is wrong in the search string.
2298 ;; Otherwise, put the overlay with the standard isearch prompt over
2299 ;; the initial minibuffer prompt.
2308 ;; And clear any previous isearch message.
2312 "Wrap the minibuffer history search when search fails.
2313 Move point to the first history element for a forward search,
2314 or to the last history element for a backward search."
2315 ;; When `minibuffer-history-isearch-search' fails on reaching the
2316 ;; beginning/end of the history, wrap the search to the first/last
2317 ;; minibuffer history element.
2325 "Save a function restoring the state of minibuffer history search.
2326 Save `minibuffer-history-position' to the additional state parameter
2327 in the search status stack."
2333 "Restore the minibuffer history search state.
2334 Go to the history element by the absolute history position HIST-POS."
2337 \f
2338 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2342 "Table mapping redo records to the corresponding undo one.
2343 A redo record for undo-in-region maps to t.
2353 "Within a run of consecutive undo commands, list remaining to be undone.
2357 "Undo some previous changes.
2358 Repeat this command to undo more changes.
2359 A numeric ARG serves as a repeat count.
2361 In Transient Mark mode when the mark is active, only undo changes within
2363 as an argument limits undo to changes within the current region."
2365 ;; Make last-command indicate for the next command that this was an undo.
2366 ;; That way, another undo will undo more.
2367 ;; If we get to the end of the undo history and get an error,
2368 ;; another undo command will find the undo history empty
2369 ;; and will get another error. To begin undoing the undos,
2370 ;; you must type some other command.
2372 ;; For an indirect buffer, look in the base buffer for the
2373 ;; auto-save data.
2377 message)
2378 ;; If we get an error in undo-start,
2379 ;; the next command should not be a "consecutive undo".
2380 ;; So set `this-command' to something other than `undo'.
2385 ;; If something (a timer or filter?) changed the buffer
2386 ;; since the previous command, don't continue the undo seq.
2390 ;; If the last undo record made was made by undo
2391 ;; it shows nothing else happened in between.
2398 ;; get rid of initial undo boundary
2400 ;; If we got this far, the next command should be a consecutive undo.
2402 ;; Check to see whether we're hitting a redo record, and if
2403 ;; so, ask the user whether she wants to skip the redo/undo pair.
2411 ;; The equiv entry might point to another redo record if we have done
2412 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2420 ;; Record the fact that the just-generated undo records come from an
2421 ;; undo operation--that is, they are redo records.
2422 ;; In the ordinary case (not within a region), map the redo
2423 ;; record to the following undos.
2424 ;; I don't know how to do that in the undo-in-region case.
2426 ;; Strip any leading undo boundaries there might be, like we do
2427 ;; above when checking.
2431 ;; Prevent identity mapping. This can happen if
2432 ;; consecutive nils are erroneously in undo list.
2434 t
2435 pending-undo-list)
2436 undo-equiv-table))
2437 ;; Don't specify a position in the undo record for the undo command.
2438 ;; Instead, undoing this should move point to where the change is.
2457 ;; Record what the current undo list says,
2458 ;; so the next command can tell if the buffer was modified in between.
2462 ;; Display a message announcing success.
2467 "Make BUFFER stop keeping undo information.
2468 No argument or nil as argument means do this for the current buffer."
2474 "Undo some previous changes.
2475 Repeat this command to undo more changes.
2476 A numeric ARG serves as a repeat count.
2477 Contrary to `undo', this will not redo a previous undo."
2482 "Non-nil while performing an undo.
2486 "Undo back N undo-boundaries beyond what was already undone recently.
2487 Call `undo-start' to get ready to undo recent changes,
2488 then call `undo-more' one or more times to undo them."
2493 ;; Note: The following, while pulling elements off
2494 ;; `pending-undo-list' will call primitive change functions which
2495 ;; will push more elements onto `buffer-undo-list'.
2501 "Undo N records from the front of the list LIST.
2502 Return what remains of the list."
2504 ;; This is a good feature, but would make undo-start
2505 ;; unable to do what is expected.
2506 ;;(when (null (car (list)))
2507 ;; ;; If the head of the list is a boundary, it is the boundary
2508 ;; ;; preceding this command. Get rid of it and don't count it.
2509 ;; (setq list (cdr list))))
2512 ;; In a writable buffer, enable undoing read-only text that is
2513 ;; so because of text properties.
2515 ;; Don't let `intangible' properties interfere with undo.
2517 ;; We use oldlist only to check for EQ. ++kfs
2523 ;; Handle an integer by setting point to that value.
2526 ;; Element (t . TIME) records previous modtime.
2527 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2528 ;; UNKNOWN_MODTIME_NSECS.
2530 ;; If this records an obsolete save
2531 ;; (not matching the actual disk file)
2532 ;; then don't mark unmodified.
2540 ;; Element (nil PROP VAL BEG . END) is property change.
2545 ;; Element (BEG . END) means range was inserted.
2547 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2548 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2551 ;; Set point first thing, so that undoing this undo
2552 ;; does not send point back to where it is now.
2555 ;; Element (apply FUN . ARGS) means call FUN to undo.
2559 ;; Long format: (apply DELTA START END FUN . ARGS).
2566 ;; Check that the function did what the entry
2567 ;; said it would do.
2577 ;; Element (STRING . POS) means STRING was deleted.
2583 ;; Check that marker adjustments which were recorded
2584 ;; with the (STRING . POS) record are still valid, ie
2585 ;; the markers haven't moved. We check their validity
2586 ;; before reinserting the string so as we don't need to
2587 ;; mind marker insertion-type.
2595 ;; Insert string and adjust point
2603 ;; Adjust the valid marker adjustments
2605 ;; Insert might have invalidated some of the markers
2606 ;; via modification hooks. Update only the currently
2607 ;; valid ones (bug#25599).
2611 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2614 next)
2615 ;; Even though these elements are not expected in the undo
2616 ;; list, adjust them to be conservative for the 24.4
2617 ;; release. (Bug#16818)
2624 ;; Make sure an apply entry produces at least one undo entry,
2625 ;; so the test in `undo' for continuing an undo series
2626 ;; will work right.
2631 list)
2633 ;; Deep copy of a list
2635 "Make a copy of undo list LIST."
2641 elt))
2644 "Set `pending-undo-list' to the front of the undo list.
2645 The next call to `undo-more' will undo the most recently made change.
2646 If BEG and END are specified, then only undo elements
2647 that apply to text between BEG and END are used; other undo elements
2648 are ignored. If BEG and END are nil, all undo elements are used."
2654 buffer-undo-list)))
2656 ;; The positions given in elements of the undo list are the positions
2657 ;; as of the time that element was recorded to undo history. In
2658 ;; general, subsequent buffer edits render those positions invalid in
2659 ;; the current buffer, unless adjusted according to the intervening
2660 ;; undo elements.
2661 ;;
2662 ;; Undo in region is a use case that requires adjustments to undo
2663 ;; elements. It must adjust positions of elements in the region based
2664 ;; on newer elements not in the region so as they may be correctly
2665 ;; applied in the current buffer. undo-make-selective-list
2666 ;; accomplishes this with its undo-deltas list of adjustments. An
2667 ;; example undo history from oldest to newest:
2668 ;;
2669 ;; buf pos:
2670 ;; 123456789 buffer-undo-list undo-deltas
2671 ;; --------- ---------------- -----------
2672 ;; aaa (1 . 4) (1 . -3)
2673 ;; aaba (3 . 4) N/A (in region)
2674 ;; ccaaba (1 . 3) (1 . -2)
2675 ;; ccaabaddd (7 . 10) (7 . -3)
2676 ;; ccaabdd ("ad" . 6) (6 . 2)
2677 ;; ccaabaddd (6 . 8) (6 . -2)
2678 ;; | |<-- region: "caab", from 2 to 6
2679 ;;
2680 ;; When the user starts a run of undos in region,
2681 ;; undo-make-selective-list is called to create the full list of in
2682 ;; region elements. Each element is adjusted forward chronologically
2683 ;; through undo-deltas to determine if it is in the region.
2684 ;;
2685 ;; In the above example, the insertion of "b" is (3 . 4) in the
2686 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2687 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2688 ;; . 6) is assessed as in the region and placed in the selective list.
2689 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2690 ;; due to the selected element. The "b" insertion is the only element
2691 ;; fully in the region, so in this example undo-make-selective-list
2692 ;; returns (nil (5 . 6)).
2693 ;;
2694 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2695 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2696 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2697 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2698 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2699 ;;
2700 ;; More interesting is how to adjust the "ddd" insertion due to the
2701 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2702 ;; If the reinsertion was a manual retyping of "ad", then the total
2703 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2704 ;; the reinsertion was due to undo, one might expect the first "d"
2705 ;; character would again be a part of the "ddd" text, meaning its
2706 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2707 ;;
2708 ;; undo-make-selective-list assumes in this situation that "ad" was a
2709 ;; new edit, even if it was inserted because of an undo.
2710 ;; Consequently, if the user undos in region "8 to 10" of the
2711 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2712 ;; "ccaabad", as though the first "d" became detached from the
2713 ;; original "ddd" insertion. This quirk is a FIXME.
2716 "Return a list of undo elements for the region START to END.
2717 The elements come from `buffer-undo-list', but we keep only the
2718 elements inside this region, and discard those outside this
2719 region. The elements' positions are adjusted so as the returned
2720 list can be applied to the current buffer."
2722 ;; A list of position adjusted undo elements in the region.
2724 ;; A list of undo-deltas for out of region undo elements.
2725 undo-deltas
2726 undo-elt)
2734 ;; Don't put two nils together in the list
2738 ;; This is a "was unmodified" element. Keep it
2739 ;; if we have kept everything thus far.
2742 ;; Skip over marker adjustments, instead relying
2743 ;; on finding them after (TEXT . POS) elements
2745 nil)
2748 undo-deltas)))
2753 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2754 ;; kept. primitive-undo may discard them later.
2767 "Determine whether UNDO-ELT falls inside the region START ... END.
2768 If it crosses the edge, we return nil.
2770 Generally this function is not useful for determining
2771 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2772 because markers can be arbitrarily relocated. Instead, pass the
2773 marker adjustment's corresponding (TEXT . POS) element."
2778 t)
2780 nil)
2782 ;; (TEXT . POSITION)
2786 ;; (MARKER . ADJUSTMENT)
2789 ;; (nil PROPERTY VALUE BEG . END)
2794 ;; (BEGIN . END)
2799 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2800 This assumes we have already decided that UNDO-ELT
2801 is not *inside* the region START...END."
2805 ;; (nil PROPERTY VALUE BEG . END)
2810 ;; (BEGIN . END)
2815 "Return adjustment of undo element ELT by the undo DELTAS
2816 list."
2818 ;; POSITION
2821 ;; (BEG . END)
2824 ;; (TEXT . POSITION)
2828 ;; (nil PROPERTY VALUE BEG . END)
2831 ;; (apply DELTA START END FUN . ARGS)
2832 ;; FIXME
2833 ;; All others return same elt
2836 ;; (BEG . END) can adjust to the same positions, commonly when an
2837 ;; insertion was undone and they are out of region, for example:
2838 ;;
2839 ;; buf pos:
2840 ;; 123456789 buffer-undo-list undo-deltas
2841 ;; --------- ---------------- -----------
2842 ;; [...]
2843 ;; abbaa (2 . 4) (2 . -2)
2844 ;; aaa ("bb" . 2) (2 . 2)
2845 ;; [...]
2846 ;;
2847 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2848 ;; undo. Further adjustments to such an element should be the same as
2849 ;; for (TEXT . POSITION) elements. The options are:
2850 ;;
2851 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2852 ;; analogous to marker insertion-type t.
2853 ;;
2854 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2855 ;; marker insertion-type nil.
2856 ;;
2857 ;; There was no strong reason to prefer one or the other, except that
2858 ;; the first is more consistent with prior undo in region behavior.
2860 "Return cons of adjustments to BEG and END by the undo DELTAS
2861 list."
2863 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2868 "Return adjustment of POS by the undo DELTAS list, comparing
2869 with < or <= based on USE-<."
2875 ;; Don't allow pos to become less than the undo-delta
2876 ;; position. This edge case is described in the overview
2877 ;; comments.
2880 ;; Return the first affected buffer position and the delta for an undo element
2881 ;; delta is defined as the change in subsequent buffer positions if we *did*
2882 ;; the undo.
2886 ;; (TEXT . POSITION)
2889 ;; (BEGIN . END)
2895 ;;; Default undo-boundary addition
2896 ;;
2897 ;; This section adds a new undo-boundary at either after a command is
2898 ;; called or in some cases on a timer called after a change is made in
2899 ;; any buffer.
2901 "Describe the cause of the last undo-boundary.
2903 If `explicit', the last boundary was caused by an explicit call to
2904 `undo-boundary', that is one not called by the code in this
2905 section.
2907 If it is equal to `timer', then the last boundary was inserted
2908 by `undo-auto--boundary-timer'.
2910 If it is equal to `command', then the last boundary was inserted
2911 automatically after a command, that is by the code defined in
2912 this section.
2914 If it is equal to a list, then the last boundary was inserted by
2915 an amalgamating command. The car of the list is the number of
2916 times an amalgamating command has been called, and the cdr are the
2920 "Current timer which will run `undo-auto--boundary-timer' or nil.
2925 "Non-nil if `this-command' should be amalgamated.
2926 This variable is set to nil by `undo-auto--boundaries' and is set
2930 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2934 "Return the number of amalgamating last commands or nil.
2935 Amalgamating commands are, by default, either
2936 `self-insert-command' and `delete-char', but can be any command
2937 that calls `undo-auto-amalgamate'."
2941 "Add an `undo-boundary' to the current buffer if needed.
2942 REASON describes the reason that the boundary is being added; see
2943 `undo-auto--last-boundary' for more information."
2953 undo-auto--undoably-changed-buffers)
2954 cause)))))
2957 "Check recently changed buffers and add a boundary if necessary.
2958 REASON describes the reason that the boundary is being added; see
2959 `undo-last-boundary' for more information."
2960 ;; (Bug #23785) All commands should ensure that there is an undo
2961 ;; boundary whether they have changed the current buffer or not.
2971 "Timer function run by `undo-auto-current-boundary-timer'."
2976 "Ensure that the `undo-auto-current-boundary-timer' is set."
2982 "List of buffers that have changed recently.
2984 This list is maintained by `undo-auto--undoable-change' and
2985 `undo-auto--boundaries' and can be affected by changes to their
2989 "Add an `undo-boundary' in appropriate buffers."
2994 'amalgamate
2998 "Amalgamate undo if necessary.
2999 This function can be called before an amalgamating command. It
3000 removes the previous `undo-boundary' if a series of such calls
3001 have been made. By default `self-insert-command' and
3002 `delete-char' are the only amalgamating commands, although this
3003 function could be called by any command wishing to have this
3004 behavior."
3009 last-amalgamating-count
3014 ;; Amalgamate all buffers that have changed.
3018 b
3020 ;; The head of `buffer-undo-list' is nil.
3021 ;; `car-safe' doesn't work because
3022 ;; `buffer-undo-list' need not be a list!
3030 "Called after every undoable buffer change."
3033 ;; End auto-boundary section
3036 "Amalgamate changes in change-group since HANDLE.
3037 Remove all undo boundaries between the state of HANDLE and now.
3038 HANDLE is as returned by `prepare-change-group'."
3047 ;; Temporarily truncate the undo log at ELT.
3052 ;; `elt' is still in the log: normal case.
3054 ;; `elt' is not in the log any more, but that's because
3055 ;; the log is "all new", so we should remove all
3056 ;; boundaries from it.
3060 buffer-undo-list
3061 ;; Preserve the undo-boundaries at either ends of the
3062 ;; change-groups.
3064 ;; Reset the modified cons cell ELT to its original content.
3071 "If non-nil ask about discarding undo info for the current command.
3072 Normally, Emacs discards the undo info for the current command if
3073 it exceeds `undo-outer-limit'. But if you set this option
3074 non-nil, it asks in the echo area whether to discard the info.
3075 If you answer no, there is a slight risk that Emacs might crash, so
3076 only do it if you really want to undo the command.
3078 This option is mainly intended for debugging. You have to be
3079 careful if you use it for other purposes. Garbage collection is
3080 inhibited while the question is asked, meaning that Emacs might
3081 leak memory. So you should make sure that you do not wait
3082 excessively long before answering the question."
3088 "If non-nil, an extra level of size that's ok in an undo item.
3089 We don't ask the user about truncating the undo list until the
3090 current item gets bigger than this amount.
3095 ;; When the first undo batch in an undo list is longer than
3096 ;; undo-outer-limit, this function gets called to warn the user that
3097 ;; the undo info for the current command was discarded. Garbage
3098 ;; collection is inhibited around the call, so it had better not do a
3099 ;; lot of consing.
3105 ;; Don't ask the question again unless it gets even bigger.
3106 ;; This applies, in particular, if the user quits from the question.
3107 ;; Such a quit quits out of GC, but something else will call GC
3108 ;; again momentarily. It will call this function again,
3109 ;; but we don't want to ask the question again.
3113 "Buffer `%s' undo info is %d bytes long; discard it? "
3117 t)
3118 nil))
3124 "The undo info was discarded because it exceeded \
3125 `undo-outer-limit'.
3127 This is normal if you executed a command that made a huge change
3128 to the buffer. In that case, to prevent similar problems in the
3129 future, set `undo-outer-limit' to a value that is large enough to
3130 cover the maximum size of normal changes you expect a single
3131 command to make, but not so large that it might exceed the
3132 maximum memory allotted to Emacs.
3134 If you did not execute any such command, the situation is
3135 probably due to a bug and you should report it.
3137 You can disable the popping up of this buffer by adding the entry
3138 \(undo discard-info) to the user option `warning-suppress-types',
3142 t))
3143 \f
3146 ; These are sorted according to the GNU en_US locale.
3189 )
3191 This is used by Shell mode and other parts of Emacs to recognize
3192 password prompts, including prompts in languages other than
3193 English. Different case choices should not be assumed to be
3194 included; callers should bind `case-fold-search' to t."
3200 "History list for some commands that read shell commands.
3202 Maximum length of the history list is determined by the value
3209 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3210 This buffer is used when `shell-command' or `shell-command-on-region'
3211 is run interactively. A value of nil means that output to stderr and
3218 "Return a list of all commands associated with the current file.
3219 This function is used to add all related commands retrieved by `mailcap'
3220 to the end of the list of defaults just after the default value."
3224 minibuffer-default))
3229 commands))
3240 map)
3244 "Read a shell command from the minibuffer.
3245 The arguments are the same as the ones of `read-from-minibuffer',
3246 except READ and KEYMAP are missing and HIST defaults
3247 to `shell-command-history'."
3255 minibuffer-local-shell-command-map
3256 nil
3258 args)))
3261 "What to do when the output buffer is used by another shell command.
3262 This option specifies how to resolve the conflict where a new command
3263 wants to direct its output to the buffer `*Async Shell Command*',
3264 but this buffer is already taken by another running shell command.
3266 The value `confirm-kill-process' is used to ask for confirmation before
3267 killing the already running process and running a new process
3268 in the same buffer, `confirm-new-buffer' for confirmation before running
3269 the command in a new buffer with a name other than the default buffer name,
3270 `new-buffer' for doing the same without confirmation,
3271 `confirm-rename-buffer' for confirmation before renaming the existing
3272 output buffer and running a new command in the default buffer,
3273 `rename-buffer' for doing the same without confirmation."
3275 confirm-kill-process)
3277 confirm-new-buffer)
3279 new-buffer)
3281 confirm-rename-buffer)
3283 rename-buffer))
3288 "Whether to display the command buffer immediately.
3289 If t, display the buffer immediately; if nil, wait until there
3290 is output."
3292 t)
3294 nil))
3299 "Store a buffer position or erase the buffer.
3300 See `shell-command-dont-erase-buffer'."
3302 pos)
3304 ;; Setting buffer-read-only to nil doesn't suffice
3305 ;; if some text has a non-nil read-only property,
3306 ;; which comint sometimes adds for prompts.
3316 shell-command-saved-pos))))
3319 "Set point in BUFFER after command complete.
3320 BUFFER is the output buffer of the command; if nil, then defaults
3321 to the current BUFFER.
3322 Set point to the `cdr' of the element in `shell-command-saved-pos'
3323 whose `car' is BUFFER."
3335 ;; Set point in the window displaying buf, if any; otherwise
3336 ;; display buf temporary in selected frame and set the point.
3341 buf
3346 "Execute string COMMAND asynchronously in background.
3348 Like `shell-command', but adds `&' at the end of COMMAND
3349 to execute it asynchronously.
3351 The output appears in the buffer `*Async Shell Command*'.
3352 That buffer is in shell mode.
3354 You can configure `async-shell-command-buffer' to specify what to do
3355 when the `*Async Shell Command*' buffer is already taken by another
3356 running shell command. To run COMMAND without displaying the output
3357 in a window you can configure `display-buffer-alist' to use the action
3358 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3360 In Elisp, you will often be better served by calling `start-process'
3361 directly, since it offers more control and does not impose the use of
3362 a shell (with its need to quote arguments)."
3372 current-prefix-arg
3373 shell-command-default-error-buffer))
3379 "Execute string COMMAND in inferior shell; display output, if any.
3380 With prefix argument, insert the COMMAND's output at point.
3382 Interactively, prompt for COMMAND in the minibuffer.
3384 If COMMAND ends in `&', execute it asynchronously.
3385 The output appears in the buffer `*Async Shell Command*'.
3386 That buffer is in shell mode. You can also use
3387 `async-shell-command' that automatically adds `&'.
3389 Otherwise, COMMAND is executed synchronously. The output appears in
3390 the buffer `*Shell Command Output*'. If the output is short enough to
3391 display in the echo area (which is determined by the variables
3392 `resize-mini-windows' and `max-mini-window-height'), it is shown
3393 there, but it is nonetheless available in buffer `*Shell Command
3394 Output*' even though that buffer is not automatically displayed.
3396 To specify a coding system for converting non-ASCII characters
3398 before this command.
3400 Noninteractive callers can specify coding systems by binding
3401 `coding-system-for-read' and `coding-system-for-write'.
3403 The optional second argument OUTPUT-BUFFER, if non-nil,
3404 says to put the output in some other buffer.
3405 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3406 and insert the output there; a non-nil value of
3407 `shell-command-dont-erase-buffer' prevents the buffer from being
3408 erased. If OUTPUT-BUFFER is not a buffer and not nil, insert the
3409 output in current buffer after point leaving mark after it. This
3410 cannot be done asynchronously.
3412 If the command terminates without error, but generates output,
3414 the output can be displayed in the echo area or in its buffer.
3415 If the output is short enough to display in the echo area
3416 \(determined by the variable `max-mini-window-height' if
3417 `resize-mini-windows' is non-nil), it is shown there.
3418 Otherwise, the buffer containing the output is displayed.
3422 of the output.
3424 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3425 or buffer name to which to direct the command's standard error output.
3426 If it is nil, error output is mingled with regular output.
3427 In an interactive call, the variable `shell-command-default-error-buffer'
3428 specifies the value of ERROR-BUFFER.
3430 In Elisp, you will often be better served by calling `call-process' or
3431 `start-process' directly, since they offer more control and do not
3432 impose the use of a shell (with its need to quote arguments)."
3443 current-prefix-arg
3444 shell-command-default-error-buffer))
3445 ;; Look for a handler in case default-directory is a remote file name.
3453 ;; Output goes in current buffer.
3459 temporary-file-directory)))
3460 nil)))
3463 ;; We do not use -f for csh; we will not support broken use of
3464 ;; .cshrcs. Even the BSD csh manual says to use
3465 ;; "if ($?prompt) exit" before things which are not useful
3466 ;; non-interactively. Besides, if someone wants their other
3467 ;; aliases for shell commands then they can still have them.
3471 t)
3472 nil shell-command-switch command)
3479 ;; Do no formatting while reading error file,
3480 ;; because that can run a shell command, and we
3481 ;; don't want that to cause an infinite recursion.
3483 ;; Put point after the inserted errors.
3487 ;; This is like exchange-point-and-mark, but doesn't
3488 ;; activate the mark. It is cleaner to avoid activation,
3489 ;; even though the command loop would deactivate the mark
3490 ;; because we inserted text.
3494 ;; Output goes in a separate buffer.
3495 ;; Preserve the match data in case called from a program.
3496 ;; FIXME: It'd be ridiculous for an Elisp function to call
3497 ;; shell-command and assume that it won't mess the match-data!
3500 ;; Command ending with ampersand means asynchronous.
3505 proc)
3506 ;; Remove the ampersand.
3508 ;; Ask the user what to do with already running process.
3513 ;; If will kill a process, query first.
3518 ;; If will create a new buffer, query first.
3523 ;; It will create a new buffer.
3526 ;; If will rename the buffer, query first.
3534 ;; It will rename the buffer.
3542 shell-command-switch command))
3546 ;; Use the comint filter for proper handling of
3547 ;; carriage motion (see comint-inhibit-carriage-motion).
3550 ;; Display buffer immediately.
3552 ;; Defer displaying buffer until first process output.
3553 ;; Use disposable named advice so that the buffer is
3554 ;; displayed at most once per process lifetime.
3561 nonce)
3564 ;; Otherwise, command is executed synchronously.
3566 output-buffer nil error-buffer)))))))
3569 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3570 MESSAGE may be either a string or a buffer.
3572 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3573 for maximum height of the echo area, as defined by `max-mini-window-height'
3574 if `resize-mini-windows' is non-nil.
3576 Returns either the string shown in the echo area, or when a pop-up
3577 buffer is used, the window used to display it.
3579 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3580 name of the buffer used to display it in the case where a pop-up buffer
3581 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3582 string and it is displayed in the echo area, it is not specified whether
3583 the contents are inserted into the buffer anyway.
3585 Optional arguments ACTION and FRAME are as for `display-buffer',
3586 and are only used if a pop-up buffer is displayed."
3588 ;; Trivial case where we can use the echo area
3592 ;; Trivial case where we can just remove single trailing newline
3595 ;; General case
3598 message
3607 0
3611 (<= lines
3615 max-mini-window-height))
3617 max-mini-window-height)
3621 ;; Don't use the echo area if the output buffer is
3622 ;; already displayed in the selected frame.
3624 ;; Echo area
3630 ;; Buffer
3635 ;; We have a sentinel to prevent insertion of a termination message
3636 ;; in the buffer itself, and to set the point in the buffer when
3637 ;; `shell-command-dont-erase-buffer' is non-nil.
3646 &optional output-buffer replace
3647 error-buffer display-error-buffer
3648 region-noncontiguous-p)
3649 "Execute string COMMAND in inferior shell with region as input.
3650 Normally display output (if any) in temp buffer `*Shell Command Output*';
3651 Prefix arg means replace the region with it. Return the exit code of
3652 COMMAND.
3654 To specify a coding system for converting non-ASCII characters
3656 before this command. By default, the input (from the current buffer)
3657 is encoded using coding-system specified by `process-coding-system-alist',
3658 falling back to `default-process-coding-system' if no match for COMMAND
3659 is found in `process-coding-system-alist'.
3661 Noninteractive callers can specify coding systems by binding
3662 `coding-system-for-read' and `coding-system-for-write'.
3664 If the command generates output, the output may be displayed
3665 in the echo area or in a buffer.
3666 If the output is short enough to display in the echo area
3667 \(determined by the variable `max-mini-window-height' if
3668 `resize-mini-windows' is non-nil), it is shown there.
3669 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3670 The output is available in that buffer in both cases.
3672 If there is output and an error, a message about the error
3673 appears at the end of the output.
3675 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3676 command's output. If the value is a buffer or buffer name,
3677 erase that buffer and insert the output there; a non-nil value of
3678 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3679 If the value is nil, use the buffer `*Shell Command Output*'.
3680 Any other non-nil value means to insert the output in the
3681 current buffer after START.
3683 Optional fifth arg REPLACE, if non-nil, means to insert the
3684 output in place of text from START to END, putting point and mark
3685 around it.
3687 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3688 or buffer name to which to direct the command's standard error
3689 output. If nil, error output is mingled with regular output.
3690 When called interactively, `shell-command-default-error-buffer'
3691 is used for ERROR-BUFFER.
3693 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3694 display the error buffer if there were any errors. When called
3695 interactively, this is t."
3699 ;; Do this before calling region-beginning
3700 ;; and region-end, in case subprocess output
3701 ;; relocates them while we are in the minibuffer.
3703 ;; call-interactively recognizes region-beginning and
3704 ;; region-end specially, leaving them in the history.
3706 string
3707 current-prefix-arg
3708 current-prefix-arg
3709 shell-command-default-error-buffer
3710 t
3717 temporary-file-directory)))
3718 nil))
3719 exit-status)
3720 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3723 output)
3727 shell-file-name t t
3728 nil shell-command-switch
3729 command)
3736 ;; Replace specified region with output from command.
3738 ;; Don't muck with mark unless REPLACE says we should.
3745 t)))
3746 ;; It is rude to delete a buffer which the command is not using.
3747 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3748 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3749 ;; (kill-buffer shell-buffer)))
3750 ;; Don't muck with mark unless REPLACE says we should.
3752 ;; No prefix argument: put the output in a temp buffer,
3753 ;; replacing its entire contents.
3761 ;; If the input is the same buffer as the output,
3762 ;; delete everything but the specified region,
3763 ;; then replace that region with the output.
3769 shell-file-name t
3772 t)
3773 nil shell-command-switch
3774 command)))
3775 ;; Clear the output buffer, then run the command with
3776 ;; output there.
3786 buffer))))
3787 ;; Report the output.
3797 ;; There's some output, display it
3801 ;; No output; error?
3808 shell-command-default-error-buffer)
3815 output))
3818 exit-status))
3821 exit-status output))))
3822 ;; Don't kill: there might be useful info in the undo-log.
3823 ;; (kill-buffer buffer)
3824 )))))
3832 ;; Do no formatting while reading error file,
3833 ;; because that can run a shell command, and we
3834 ;; don't want that to cause an infinite recursion.
3836 ;; Put point after the inserted errors.
3841 exit-status))
3844 "Execute shell command COMMAND and return its output as a string."
3847 standard-output
3851 "Process files synchronously in a separate process.
3852 Similar to `call-process', but may invoke a file handler based on
3853 `default-directory'. The current working directory of the
3854 subprocess is `default-directory'.
3856 File names in INFILE and BUFFER are handled normally, but file
3857 names in ARGS should be relative to `default-directory', as they
3858 are passed to the process verbatim. (This is a difference to
3859 `call-process' which does not support file handlers for INFILE
3860 and BUFFER.)
3862 Some file handlers might not support all variants, for example
3863 they might behave as if DISPLAY was nil, regardless of the actual
3864 value passed."
3866 lc stderr-file)
3876 display args)
3882 "Whether a call of `process-file' changes remote files.
3884 By default, this variable is always set to t, meaning that a
3885 call of `process-file' could potentially change any file on a
3886 remote host. When set to nil, a file handler could optimize
3887 its behavior with respect to remote file attribute caching.
3889 You should only ever change this variable with a let-binding;
3893 "Start a program in a subprocess. Return the process object for it.
3895 Similar to `start-process', but may invoke a file handler based on
3896 `default-directory'. See Info node `(elisp)Magic File Names'.
3898 This handler ought to run PROGRAM, perhaps on the local host,
3899 perhaps on a remote host that corresponds to `default-directory'.
3900 In the latter case, the local part of `default-directory' becomes
3901 the working directory of the process.
3903 PROGRAM and PROGRAM-ARGS might be file names. They are not
3904 objects of file handler invocation. File handlers might not
3905 support pty association, if PROGRAM is nil."
3909 \f
3910 ;;;; Process menu
3924 map))
3927 "Major mode for listing the processes called by Emacs."
3939 "Kill process at point in a `list-processes' buffer."
3950 "Recompute the list of processes for the Process List buffer.
3951 Also, delete any process that is exited or signaled."
3965 face link
3967 "Visit buffer `%s'"
3969 follow-link t
3970 process-buffer ,buf
3971 action process-menu-visit-buffer)
3980 "datagram"
3997 tabulated-list-entries)))))
4004 "Display a list of all processes that are Emacs sub-processes.
4005 If optional argument QUERY-ONLY is non-nil, only processes with
4006 the query-on-exit flag set are listed.
4007 Any process listed as exited or signaled is actually eliminated
4008 after the listing is made.
4009 Optional argument BUFFER specifies a buffer to use, instead of
4011 The return value is always nil.
4013 This function lists only processes that were launched by Emacs. To
4014 see other processes running on the system, use `list-system-processes'."
4026 nil)
4027 \f
4028 ;;;; Prefix commands
4034 ;; BEWARE: Called directly from C code.
4035 ;; If the return value is non-nil, it means we are in the middle of
4036 ;; a command with prefix, such as a command invoked with prefix-arg.
4038 prefix-command--last-echo
4047 "Abnormal hook which constructs the description of the current prefix state.
4051 "Update state of prefix commands.
4059 "Pass the current prefix command state to the next command.
4060 Should be called by all prefix commands.
4061 Runs `prefix-command-preserve-state-hook'."
4063 ;; If the current command is a prefix command, we don't want the next (real)
4064 ;; command to have `last-command' set to, say, `universal-argument'.
4071 nil)
4073 ;;;;; The main prefix command.
4075 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
4100 ;; For backward compatibility, minus with no modifiers is an ordinary
4101 ;; command if digits have already been entered.
4131 map)
4139 "Begin a numeric argument for the following command.
4144 multiplies the argument by 4 each time.
4146 which is different in effect from any particular numeric argument.
4154 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
4155 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
4162 arg)))
4166 "Begin a negative numeric argument for the next command.
4176 "Part of the numeric argument for the next command.
4181 last-command-event
4188 ;; Treat -0 as just -, so that -01 will work.
4191 digit))))
4193 \f
4196 "This variable is a wrapper hook around `buffer-substring--filter'.
4202 "Function to perform the filtering in `filter-buffer-substring'.
4203 The function is called with the same 3 arguments (BEG END DELETE)
4204 that `filter-buffer-substring' received. It should return the
4205 buffer substring between BEG and END, after filtering. If DELETE is
4209 "List of filter functions for `buffer-substring--filter'.
4210 Each function must accept a single argument, a string, and return a string.
4211 The buffer substring is passed to the first function in the list,
4212 and the return value of each function is passed to the next.
4213 As a special convention, point is set to the start of the buffer text
4214 being operated on (i.e., the first argument of `buffer-substring--filter')
4220 "Return the buffer substring between BEG and END, after filtering.
4221 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4223 This calls the function that `filter-buffer-substring-function' specifies
4224 \(passing the same three arguments that it received) to do the work,
4225 and returns whatever it does. The default function does no filtering,
4226 unless a hook has been set.
4228 Use `filter-buffer-substring' instead of `buffer-substring',
4229 `buffer-substring-no-properties', or `delete-and-extract-region' when
4230 you want to allow filtering to take place. For example, major or minor
4231 modes can use `filter-buffer-substring-function' to extract characters
4232 that are special to a buffer, and should not be copied into other buffers."
4236 "Default function to use for `filter-buffer-substring-function'.
4237 Its arguments and return value are as specified for `filter-buffer-substring'.
4238 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4239 \(see `with-wrapper-hook' for details about wrapper hooks),
4240 and the abnormal hook `buffer-substring-filters'.
4241 No filtering is done unless a hook says to."
4252 string)))
4257 ;;;; Window system cut and paste hooks.
4260 "Function to call to make a killed region available to other programs.
4261 Most window systems provide a facility for cutting and pasting
4262 text between different programs, such as the clipboard on X and
4263 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4265 This variable holds a function that Emacs calls whenever text is
4266 put in the kill ring, to make the new kill available to other
4267 programs. The function takes one argument, TEXT, which is a
4271 "Function to call to get text cut from other programs.
4272 Most window systems provide a facility for cutting and pasting
4273 text between different programs, such as the clipboard on X and
4274 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4276 This variable holds a function that Emacs calls to obtain text
4277 that other programs have provided for pasting. The function is
4278 called with no arguments. If no other program has provided text
4279 to paste, the function should return nil (in which case the
4280 caller, usually `current-kill', should use the top of the Emacs
4281 kill ring). If another program has provided text to paste, the
4282 function should return that text as a string (in which case the
4283 caller should put this string in the kill ring as the latest
4284 kill).
4286 The function may also return a list of strings if the window
4287 system supports multiple selections. The first string will be
4288 used as the pasted text, but the other will be placed in the kill
4289 ring for easy access via `yank-pop'.
4291 Note that the function should return a string only if a program
4292 other than Emacs has provided a string for pasting; if Emacs
4293 provided the most recent string, the function should return nil.
4294 If it is difficult to tell whether Emacs or some other program
4295 provided the current string, it is probably good enough to return
4296 nil if the string is equal (according to `string=') to the last
4298 \f
4301 ;;;; The kill ring data structure.
4304 "List of killed text sequences.
4305 Since the kill ring is supposed to interact nicely with cut-and-paste
4306 facilities offered by window systems, use of this variable should
4307 interact nicely with `interprogram-cut-function' and
4308 `interprogram-paste-function'. The functions `kill-new',
4309 `kill-append', and `current-kill' are supposed to implement this
4310 interaction; you may want to use them instead of manipulating the kill
4314 "Maximum length of kill ring before oldest elements are thrown away."
4322 "Save existing clipboard text into kill ring before replacing it.
4323 A non-nil value ensures that Emacs kill operations do not
4324 irrevocably overwrite existing clipboard text by saving it to the
4325 `kill-ring' prior to the kill. Such text can subsequently be
4332 "Do not add a new string to `kill-ring' if it duplicates the last one.
4333 The comparison is done using `equal-including-properties'."
4339 "Make STRING the latest kill in the kill ring.
4340 Set `kill-ring-yank-pointer' to point to it.
4341 If `interprogram-cut-function' is non-nil, apply it to STRING.
4342 Optional second argument REPLACE non-nil means that STRING will replace
4343 the front of the kill ring, rather than being added to the list.
4345 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4346 are non-nil, save the interprogram paste string(s) into `kill-ring' before
4347 STRING.
4349 When the yank handler has a non-nil PARAM element, the original STRING
4350 argument is not used by `insert-for-yank'. However, since Lisp code
4351 may access and use elements from the kill ring directly, the STRING
4354 ;; Due to text properties such as 'yank-handler that
4355 ;; can alter the contents to yank, comparison using
4356 ;; `equal' is unsafe.
4381 ;; It has been argued that this should work like `self-insert-command'
4382 ;; which merges insertions in `buffer-undo-list' in groups of 20
4383 ;; (hard-coded in `undo-auto-amalgamate').
4385 "Amalgamate appending kills with the last kill for undo.
4386 When non-nil, appending or prepending text to the last kill makes
4393 "Append STRING to the end of the latest kill in the kill ring.
4394 If BEFORE-P is non-nil, prepend STRING to the kill instead.
4395 If `interprogram-cut-function' is non-nil, call it with the
4396 resulting kill.
4397 If `kill-append-merge-undo' is non-nil, remove the last undo
4398 boundary in the current buffer."
4406 ;; find the next undo boundary
4410 ;; remove this undo boundary
4415 "Whether rotating the kill ring changes the window system selection.
4416 If non-nil, whenever the kill ring is rotated (usually via the
4417 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4418 to copy the new kill to the window system selection."
4424 "Rotate the yanking point by N places, and then return that kill.
4425 If N is zero and `interprogram-paste-function' is set to a
4426 function that returns a string or a list of strings, and if that
4427 function doesn't return nil, then that string (or list) is added
4428 to the front of the kill ring and the string (or first string in
4429 the list) is returned as the latest kill.
4431 If N is not zero, and if `yank-pop-change-selection' is
4432 non-nil, use `interprogram-cut-function' to transfer the
4433 kill at the new yank point into the window system selection.
4435 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4436 move the yanking point; just return the Nth kill forward."
4439 interprogram-paste-function
4443 ;; Disable the interprogram cut function when we add the new
4444 ;; text to the kill ring, so Emacs doesn't try to own the
4445 ;; selection, with identical text.
4455 kill-ring)))
4460 interprogram-cut-function)
4466 ;;;; Commands for manipulating the kill ring.
4469 "Non-nil means don't signal an error for killing read-only text."
4475 This deletes the text from the buffer and saves it in the kill ring.
4479 If you want to append the killed region to the last killed text,
4483 If the previous command was also a kill command,
4484 the text killed this time appends to the text killed last time
4485 to make one entry in the kill ring.
4487 The killed text is filtered by `filter-buffer-substring' before it is
4488 saved in the kill ring, so the actual saved text might be different
4489 from what was killed.
4491 If the buffer is read-only, Emacs will beep and refrain from deleting
4492 the text, but put the text in the kill ring anyway. This means that
4493 you can use the killing commands to copy text from a read-only buffer.
4495 Lisp programs should use this function for killing text.
4496 (To delete text, use `delete-region'.)
4497 Supply two arguments, character positions BEG and END indicating the
4498 stretch of text to be killed. If the optional argument REGION is
4499 non-nil, the function ignores BEG and END, and kills the current
4500 region instead."
4501 ;; Pass mark first, then point, because the order matters when
4502 ;; calling `kill-append'.
4511 ;; Add that string to the kill ring, one way or another.
4518 nil)
4520 ;; The code above failed because the buffer, or some of the characters
4521 ;; in the region, are read-only.
4522 ;; We should beep, in case the user just isn't aware of this.
4523 ;; However, there's no harm in putting
4524 ;; the region's text in the kill ring, anyway.
4526 ;; Set this-command now, so it will be set even if we get an error.
4528 ;; This should barf, if appropriate, and give us the correct error.
4531 ;; Signal an error if the buffer is read-only.
4533 ;; If the buffer isn't read-only, the text is.
4536 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4537 ;; to get two copies of the text when the user accidentally types M-w and
4538 ;; then corrects it with the intended C-w.
4540 "Save the region as if killed, but don't kill it.
4541 In Transient Mark mode, deactivate the mark.
4542 If `interprogram-cut-function' is non-nil, also save the text for a window
4543 system cut and paste.
4545 The copied text is filtered by `filter-buffer-substring' before it is
4546 saved in the kill ring, so the actual saved text might be different
4547 from what was in the buffer.
4549 When called from Lisp, save in the kill ring the stretch of text
4550 between BEG and END, unless the optional argument REGION is
4551 non-nil, in which case ignore BEG and END, and save the current
4552 region instead.
4554 This command's old key binding has been given to `kill-ring-save'."
4555 ;; Pass mark first, then point, because the order matters when
4556 ;; calling `kill-append'.
4566 nil)
4569 "Save the region as if killed, but don't kill it.
4570 In Transient Mark mode, deactivate the mark.
4571 If `interprogram-cut-function' is non-nil, also save the text for a window
4572 system cut and paste.
4574 If you want to append the killed line to the last killed text,
4577 The copied text is filtered by `filter-buffer-substring' before it is
4578 saved in the kill ring, so the actual saved text might be different
4579 from what was in the buffer.
4581 When called from Lisp, save in the kill ring the stretch of text
4582 between BEG and END, unless the optional argument REGION is
4583 non-nil, in which case ignore BEG and END, and save the current
4584 region instead.
4586 This command is similar to `copy-region-as-kill', except that it gives
4587 visual feedback indicating the extent of the region being copied."
4588 ;; Pass mark first, then point, because the order matters when
4589 ;; calling `kill-append'.
4593 ;; This use of called-interactively-p is correct because the code it
4594 ;; controls just gives the user visual feedback.
4599 "Indicate that the region text has been copied interactively.
4600 If the mark is visible in the selected window, blink the cursor
4601 between point and mark if there is currently no active region
4602 highlighting.
4604 If the mark lies outside the selected window, display an
4605 informative message containing a sample of the copied text. The
4606 optional argument MESSAGE-LEN, if non-nil, specifies the length
4607 of this sample text; it defaults to 40."
4610 ;; Inhibit quitting so we can make a quit here
4611 ;; look like a C-g typed as a command.
4614 ;; Swap point-and-mark quickly so as to show the region that
4615 ;; was selected. Don't do it if the region is highlighted.
4618 ;; Swap point and mark.
4622 ;; Swap back.
4625 ;; If user quit, deactivate the mark
4626 ;; as C-g would as a command.
4632 ;; Don't say "killed"; that is misleading.
4639 "Cause following command, if it kills, to add to previous kill.
4640 If the next command kills forward from point, the kill is
4641 appended to the previous killed text. If the command kills
4642 backward, the kill is prepended. Kill commands that act on the
4643 region, such as `kill-region', are regarded as killing forward if
4644 point is after mark, and killing backward if point is before
4645 mark.
4647 If the next command is not a kill command, `append-next-kill' has
4648 no effect.
4650 The argument is used for internal purposes; do not supply one."
4652 ;; We don't use (interactive-p), since that breaks kbd macros.
4666 "A subroutine of `squeeze-bidi-context'.
4667 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4671 lim1)
4678 ;; L and R categories include embedding and
4679 ;; override controls, but we don't want to
4680 ;; replace them, because that might change
4681 ;; the visual order. Likewise with PDF and
4682 ;; isolate controls.
4684 bidi-directional-non-controls-chars
4685 limit)))))
4686 ;; Replace any run of non-RTL characters by a single LRM.
4688 ;; No more characters of CATEGORY, we are done.
4693 ;; Skip directional controls, if any.
4698 "Replace characters between FROM and TO while keeping bidi context.
4700 This function replaces the region of text with as few characters
4701 as possible, while preserving the effect that region will have on
4702 bidirectional display before and after the region."
4706 ;; This is for when they copy text with read-only text
4707 ;; properties.
4711 ;; Replace each run of non-RTL characters with a single LRM.
4713 ;; Replace each run of non-LTR characters with a single RLM. Note
4714 ;; that the \cR category includes both the Arabic Letter (AL) and
4715 ;; R characters; here we ignore the distinction between them,
4716 ;; because that distinction only affects Arabic Number (AN)
4717 ;; characters, which are weak and don't affect the reordering.
4721 "Return buffer text between START and END with its bidi context.
4723 START and END are assumed to belong to the same physical line
4724 of buffer text. This function prepends and appends to the text
4725 between START and END bidi control characters that preserve the
4726 visual order of that text when it is inserted at some other place."
4731 substr para-dir from to)
4738 ;; If we don't have any mixed directional characters in the
4739 ;; entire line, we can just copy the substring without adding
4740 ;; any context.
4755 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4756 ;; (1) force the string to have the same base embedding
4757 ;; direction as the paragraph direction at the source, no matter
4758 ;; what is the paragraph direction at destination; and (2) avoid
4759 ;; affecting the visual order of the surrounding text at
4760 ;; destination if there are characters of different
4761 ;; directionality there.
4766 "Return portion of current buffer between START and END with bidi context.
4768 This function works similar to `buffer-substring', but it prepends and
4769 appends to the text bidi directional control characters necessary to
4770 preserve the visual appearance of the text if it is inserted at another
4771 place. This is useful when the buffer substring includes bidirectional
4772 text and control characters that cause non-trivial reordering on display.
4773 If copied verbatim, such text can have a very different visual appearance,
4774 and can also change the visual appearance of the surrounding text at the
4775 destination of the copy.
4777 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4778 the text properties."
4791 no-properties)))
4795 substr)))
4796 \f
4797 ;; Yanking.
4802 "List of special text property handling conditions for yanking.
4803 Each element should have the form (PROP . FUN), where PROP is a
4804 property symbol and FUN is a function. When the `yank' command
4805 inserts text into the buffer, it scans the inserted text for
4806 stretches of text that have `eq' values of the text property
4807 PROP; for each such stretch of text, FUN is called with three
4808 arguments: the property's value in that text, and the start and
4809 end positions of the text.
4811 This is done prior to removing the properties specified by
4812 `yank-excluded-properties'."
4815 function))
4818 ;; This is actually used in subr.el but defcustom does not work there.
4821 intangible invisible keymap local-map mouse-face read-only
4822 yank-handler)
4823 "Text properties to discard when yanking.
4824 The value should be a list of text properties to discard or t,
4825 which means to discard all text properties.
4827 See also `yank-handled-properties'."
4834 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4835 Function is called with two parameters, START and END corresponding to
4836 the value of the mark and point; it is guaranteed that START <= END.
4840 "Replace just-yanked stretch of killed text with a different stretch.
4841 This command is allowed only immediately after a `yank' or a `yank-pop'.
4842 At such a time, the region contains a stretch of reinserted
4843 previously-killed text. `yank-pop' deletes that text and inserts in its
4844 place a different stretch of killed text.
4846 With no argument, the previous kill is inserted.
4847 With argument N, insert the Nth previous kill.
4848 If N is negative, this is a more recent kill.
4850 The sequence of kills wraps around, so that after the oldest one
4851 comes the newest one.
4853 This command honors the `yank-handled-properties' and
4854 `yank-excluded-properties' variables, and the `yank-handler' text
4855 property, in the way that `yank' does."
4869 ;; Set the window start back where it was in the yank command,
4870 ;; if possible.
4873 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4874 ;; It is cleaner to avoid activation, even though the command
4875 ;; loop would deactivate the mark because we inserted text.
4878 nil)
4882 More precisely, reinsert the most recent kill, which is the
4883 stretch of killed text most recently killed OR yanked. Put point
4884 at the end, and set mark at the beginning without activating it.
4886 With argument N, reinsert the Nth most recent kill.
4888 This command honors the `yank-handled-properties' and
4889 `yank-excluded-properties' variables, and the `yank-handler' text
4890 property, as described below.
4892 Properties listed in `yank-handled-properties' are processed,
4893 then those listed in `yank-excluded-properties' are discarded.
4895 If STRING has a non-nil `yank-handler' property anywhere, the
4896 normal insert behavior is altered, and instead, for each contiguous
4897 segment of STRING that has a given value of the `yank-handler'
4898 property, that value is used as follows:
4900 The value of a `yank-handler' property must be a list of one to four
4901 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
4902 FUNCTION, if non-nil, should be a function of one argument (the
4903 object to insert); FUNCTION is called instead of `insert'.
4904 PARAM, if present and non-nil, is passed to FUNCTION (to be handled
4905 in whatever way is appropriate; e.g. if FUNCTION is `yank-rectangle',
4906 PARAM may be a list of strings to insert as a rectangle). If PARAM
4907 is nil, then the current segment of STRING is used.
4908 If NOEXCLUDE is present and non-nil, the normal removal of
4909 `yank-excluded-properties' is not performed; instead FUNCTION is
4910 responsible for the removal. This may be necessary if FUNCTION
4911 adjusts point before or after inserting the object.
4912 UNDO, if present and non-nil, should be a function to be called
4913 by `yank-pop' to undo the insertion of the current PARAM. It is
4914 given two arguments, the start and end of the region. FUNCTION
4915 may set `yank-undo-function' to override UNDO.
4920 ;; If we don't get all the way thru, make last-command indicate that
4921 ;; for the following command.
4929 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4930 ;; It is cleaner to avoid activation, even though the command
4931 ;; loop would deactivate the mark because we inserted text.
4934 ;; If we do get all the way thru, make this-command indicate that.
4937 nil)
4940 "Rotate the yanking point in the kill ring.
4941 With ARG, rotate that many kills forward (or backward, if negative)."
4944 \f
4945 ;; Some kill commands.
4947 ;; Internal subroutine of delete-char
4953 ;; Internal subroutine of backward-delete-char
4960 "The method for untabifying when deleting backward.
4961 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4962 `hungry' -- delete all whitespace, both tabs and spaces;
4963 `all' -- delete all whitespace, including tabs, spaces and newlines;
4964 nil -- just delete one character."
4970 "Delete characters backward, changing tabs into spaces.
4971 The exact behavior depends on `backward-delete-char-untabify-method'.
4972 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4973 Interactively, ARG is the prefix arg (default 1)
4974 and KILLP is t if a prefix arg was specified."
4997 arg)))
4998 ;; Avoid warning about delete-backward-char
5002 "Kill up to and including ARGth occurrence of CHAR.
5003 Case is ignored if `case-fold-search' is non-nil in the current buffer.
5004 Goes backward if ARG is negative; error if CHAR not found."
5007 ;; Avoid "obsolete" warnings for translation-table-for-input.
5015 ;; kill-line and its subroutines.
5018 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
5023 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
5024 With prefix argument ARG, kill that many lines from point.
5025 Negative arguments kill lines backward.
5026 With zero argument, kills the text before point on the current line.
5029 a number counts as a prefix arg.
5031 To kill a whole line, when point is not at the beginning, type \
5034 If `show-trailing-whitespace' is non-nil, this command will just
5035 kill the rest of the current line, even if there are no nonblanks
5036 there.
5038 If option `kill-whole-line' is non-nil, then this command kills the whole line
5039 including its terminating newline, when used at the beginning of a line
5040 with no argument. As a consequence, you can always kill a whole line
5043 If you want to append the killed line to the last killed text,
5046 If the buffer is read-only, Emacs will beep and refrain from deleting
5047 the line, but put the line in the kill ring anyway. This means that
5048 you can use this command to copy text from a read-only buffer.
5049 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5050 even beep.)"
5053 ;; It is better to move point to the other end of the kill
5054 ;; before killing. That way, in a read-only buffer, point
5055 ;; moves across the text that is copied to the kill ring.
5056 ;; The choice has no effect on undo now that undo records
5057 ;; the value of point from before the command was run.
5067 ;; If trailing whitespace is visible,
5068 ;; don't treat it as nothing.
5078 "Kill current line.
5079 With prefix ARG, kill that many lines starting from the current line.
5080 If ARG is negative, kill backward. Also kill the preceding newline.
5082 If ARG is zero, kill current line but exclude the trailing newline."
5093 ;; We need to kill in two steps, because the previous command
5094 ;; could have been a kill command, in which case the text
5095 ;; before point needs to be prepended to the current kill
5096 ;; ring entry and the text after point appended. Also, we
5097 ;; need to use save-excursion to avoid copying the same text
5098 ;; twice to the kill ring in read-only buffers.
5116 "Move forward by ARG lines, ignoring currently invisible newlines only.
5117 If ARG is negative, move backward -ARG lines.
5118 If ARG is zero, move to the beginning of the current line."
5125 ;; If the newline we just skipped is invisible,
5126 ;; don't count it.
5130 prop
5135 ;; If invisible text follows, and it is a number of complete lines,
5136 ;; skip it.
5142 prop
5158 ;; If the newline we just moved to is invisible,
5159 ;; don't count it.
5164 prop
5169 ;; If invisible text follows, and it is a number of complete lines,
5170 ;; skip it.
5176 prop
5187 nil)))
5190 "Move to end of current visible line."
5192 ;; If the following character is currently invisible,
5193 ;; skip all characters with that same `invisible' property value,
5194 ;; then find the next newline.
5201 prop
5212 "Kill the current buffer.
5213 When called in the minibuffer, get out of the minibuffer
5214 using `abort-recursive-edit'.
5216 This is like `kill-this-buffer', but it doesn't have to be invoked
5217 via the menu bar, and pays no attention to the menu-bar's frame."
5225 \f
5227 "Insert after point the contents of BUFFER.
5228 Puts mark after the inserted text.
5229 BUFFER may be a buffer or a buffer name."
5239 t))))
5244 nil)
5247 "Append to specified buffer the text of the region.
5248 It is inserted into that buffer before its point.
5250 When calling from a program, give three arguments:
5251 BUFFER (or buffer name), START and END.
5252 START and END specify the portion of the current buffer to be copied."
5259 point)
5270 "Prepend to specified buffer the text of the region.
5271 It is inserted into that buffer after its point.
5273 When calling from a program, give three arguments:
5274 BUFFER (or buffer name), START and END.
5275 START and END specify the portion of the current buffer to be copied."
5284 "Copy to specified buffer the text of the region.
5285 It is inserted into that buffer, replacing existing text there.
5287 When calling from a program, give three arguments:
5288 BUFFER (or buffer name), START and END.
5289 START and END specify the portion of the current buffer to be copied."
5297 \f
5301 "Hook run when the mark becomes active.
5302 It is also run at the end of a command, if the mark is active and
5309 "Return this buffer's mark value as integer, or nil if never set.
5311 In Transient Mark mode, this function signals an error if
5312 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5313 or the argument FORCE is non-nil, it disregards whether the mark
5314 is active, and returns an integer or nil in the usual way.
5316 If you are using this in an editing command, you are most likely making
5317 a mistake; see the documentation of `set-mark'."
5322 ;; Behind display-selections-p.
5325 "Deactivate the mark.
5326 If Transient Mark mode is disabled, this function normally does
5327 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5329 Deactivating the mark sets `mark-active' to nil, updates the
5330 primary selection according to `select-active-regions', and runs
5331 `deactivate-mark-hook'.
5333 If Transient Mark mode was temporarily enabled, reset the value
5334 of the variable `transient-mark-mode'; if this causes Transient
5335 Mark mode to be disabled, don't change `mark-active' to nil or
5336 run `deactivate-mark-hook'."
5340 select-active-regions)
5343 ;; The var `saved-region-selection', if non-nil, is the text in
5344 ;; the region prior to the last command modifying the buffer.
5345 ;; Set the selection to that, or to the current region.
5350 ;; If another program has acquired the selection, region
5351 ;; deactivation should not clobber it (Bug#11772).
5370 "Activate the mark.
5371 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5381 "Set this buffer's mark to POS. Don't use this function!
5382 That is to say, don't use this function unless you want
5383 the user to see that the mark has moved, and you want the previous
5384 mark position to be lost.
5386 Normally, when a new mark is set, the old one should go on the stack.
5387 This is why most applications should use `push-mark', not `set-mark'.
5389 Novice Emacs Lisp programmers often try to use the mark for the wrong
5390 purposes. The mark saves a location for the user's convenience.
5391 Most editing commands should not alter the mark.
5392 To remember a location for internal use in the Lisp program,
5393 store it in a Lisp variable. Example:
5395 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5400 ;; Normally we never clear mark-active except in Transient Mark mode.
5401 ;; But when we actually clear out the mark value too, we must
5402 ;; clear mark-active in any mode.
5404 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5405 ;; it should never be nil if the mark is nil.
5413 mark-active))
5420 ;; Mark marker
5426 ;; Mark active
5429 ;; If mark is active now, and either was not active or was at a
5430 ;; different place, run the activate hook.
5435 ;; If mark has ceased to be active, run deactivate hook.
5440 "Like `save-excursion', but also save and restore the mark state.
5441 This macro does what `save-excursion' did before Emacs 25.1."
5451 If nil, region-aware commands treat the empty region as inactive.
5452 If non-nil, region-aware commands treat the region as active as
5453 long as the mark is active, even if the region is empty.
5455 Region-aware commands are those that act on the region if it is
5456 active and Transient Mark mode is enabled, and on the text near
5457 point otherwise."
5463 "Return t if the region is active and it is appropriate to act on it.
5464 This is used by commands that act specially on the region under
5465 Transient Mark mode.
5467 The return value is t if Transient Mark mode is enabled and the
5468 mark is active; furthermore, if `use-empty-active-region' is nil,
5469 the region must not be empty. Otherwise, the return value is nil.
5471 For some commands, it may be appropriate to ignore the value of
5472 `use-empty-active-region'; in that case, use `region-active-p'."
5477 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5479 Some commands act specially on the region when Transient Mark
5480 mode is enabled. Usually, such commands should use
5481 `use-region-p' instead of this function, because `use-region-p'
5482 also checks the value of `use-empty-active-region'."
5484 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5485 ;; without the mark being set (e.g. bug#17324). We really should fix
5486 ;; that problem, but in the mean time, let's make sure we don't say the
5487 ;; region is active when there's no mark.
5491 "Return the boundaries of the region as a pair of positions.
5492 Value is a list of cons cells of the form (START . END)."
5496 "Return non-nil if the region contains several pieces.
5497 An example is a rectangular region handled as a list of
5498 separate contiguous regions for each line."
5511 ;; Normal priority so that a large region doesn't hide all the
5512 ;; overlays within it, but high secondary priority so that if it
5513 ;; ends/starts in the middle of a small overlay, that small overlay
5514 ;; won't hide the region's boundaries.
5516 nrol)
5521 rol)))
5537 start end window rol)))
5540 new))))))
5543 "Hook run just before redisplay.
5544 It is called in each window that is to be redisplayed. It takes one argument,
5545 which is the window that will be redisplayed. When run, the `current-buffer'
5566 "Maximum size of mark ring. Start discarding off end if gets this big."
5574 "Maximum size of global mark ring. \
5575 Start discarding off end if gets this big."
5580 "Jump to mark, and pop a new position for mark off the ring.
5581 \(Does not affect global mark ring)."
5591 "Set mark at where point is.
5592 If no prefix ARG and mark is already set there, just activate it.
5593 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5605 will pop the mark twice, and
5607 will pop the mark three times.
5615 "Set the mark where point is, and activate it; or jump to the mark.
5616 Setting the mark also alters the region, which is the text
5617 between point and mark; this is the closest equivalent in
5620 With no prefix argument, set the mark at point, and push the
5621 old mark position on local mark ring. Also push the new mark on
5622 global mark ring, if the previous mark was set in another buffer.
5624 When Transient Mark Mode is off, immediately repeating this
5625 command activates `transient-mark-mode' temporarily.
5628 jump to the mark, and set the mark from
5629 position popped off the local mark ring (this does not affect the global
5631 mark ring (see `pop-global-mark').
5633 If `set-mark-command-repeat-pop' is non-nil, repeating
5635 off the local (or global) mark ring and jumps there.
5638 argument, unconditionally set mark where point is, even if
5639 `set-mark-command-repeat-pop' is non-nil.
5641 Novice Emacs Lisp programmers often try to use the mark for the wrong
5642 purposes. See the documentation of `set-mark' for more information."
5662 arg)
5676 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5677 If the last global mark pushed was not in the current buffer,
5678 also push LOCATION on the global mark ring.
5679 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5681 Novice Emacs Lisp programmers often try to use the mark for the wrong
5682 purposes. See the documentation of `set-mark' for more information.
5684 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5691 ;; Now push the mark on the global mark ring.
5694 ;; The last global mark pushed was in this same buffer.
5695 ;; Don't push another one.
5696 nil
5705 nil)
5708 "Pop off mark ring into the buffer's actual mark.
5709 Does not set point. Does nothing if mark ring is empty."
5721 "Put the mark where point is now, and point where the mark is now.
5722 This command works even when the mark is not active,
5723 and it reactivates the mark.
5725 If Transient Mark mode is on, a prefix ARG deactivates the mark
5726 if it is active, and otherwise avoids reactivating it. If
5727 Transient Mark mode is off, a prefix ARG enables Transient Mark
5728 mode temporarily."
5742 nil))
5745 "When non-nil, shifted motion keys activate the mark momentarily.
5747 While the mark is activated in this way, any shift-translated point
5748 motion key extends the region, and if Transient Mark mode was off, it
5749 is temporarily turned on. Furthermore, the mark will be deactivated
5750 by any subsequent point motion key that was not shift-translated, or
5751 by any action that normally deactivates the mark in Transient Mark mode.
5753 See `this-command-keys-shift-translated' for the meaning of
5754 shift-translation."
5759 "Activate/deactivate mark depending on invocation thru shift translation.
5760 This function is called by `call-interactively' when a command
5761 with a `^' character in its `interactive' spec is invoked, before
5762 running the command itself.
5764 If `shift-select-mode' is enabled and the command was invoked
5765 through shift translation, set the mark and activate the region
5766 temporarily, unless it was already set in this way. See
5767 `this-command-keys-shift-translated' for the meaning of shift
5768 translation.
5770 Otherwise, if the region has been activated temporarily,
5771 deactivate it, and restore the variable `transient-mark-mode' to
5772 its earlier value."
5779 transient-mark-mode)))
5788 "Toggle Transient Mark mode.
5789 With a prefix argument ARG, enable Transient Mark mode if ARG is
5790 positive, and disable it otherwise. If called from Lisp, enable
5791 Transient Mark mode if ARG is omitted or nil.
5793 Transient Mark mode is a global minor mode. When enabled, the
5794 region is highlighted with the `region' face whenever the mark
5796 and after certain other operations that set the mark but whose
5797 main purpose is something else--for example, incremental search,
5803 Many commands change their behavior when Transient Mark mode is
5804 in effect and the mark is active, by acting on the region instead
5805 of their usual default part of the buffer's text. Examples of
5808 To see the documentation of commands which are sensitive to the
5811 :global t
5812 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5816 "Non-nil means it is ok for commands to call `widen' when they want to.
5817 Some commands will do this in order to go to positions outside
5818 the current accessible part of the buffer.
5820 If `widen-automatically' is nil, these commands will do something else
5824 "Whether the currently executing code is performing an essential task.
5825 This variable should be non-nil only when running code which should not
5826 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5827 user for a password when we are simply scanning a set of files in the
5828 background or displaying possible completions before the user even asked
5832 "Pop off global mark ring and jump to the top location."
5834 ;; Pop entries which refer to non-existent buffers.
5852 \f
5854 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5860 "Move cursor vertically down ARG lines.
5861 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5862 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5863 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5864 function will not vscroll.
5866 ARG defaults to 1.
5868 If there is no character in the target line exactly under the current column,
5869 the cursor is positioned after the character in that line which spans this
5870 column, or at the end of the line if it is not long enough.
5871 If there is no line in the buffer after this one, behavior depends on the
5872 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5873 to create a line, and moves the cursor to that line. Otherwise it moves the
5874 cursor to the end of the buffer.
5876 If the variable `line-move-visual' is non-nil, this command moves
5877 by display lines. Otherwise, it moves by buffer lines, without
5878 taking variable-width characters or continued lines into account.
5882 a semipermanent goal column for this command.
5883 Then instead of trying to move exactly vertically (or as close as possible),
5884 this command moves to the specified goal column (or as close as possible).
5885 The goal column is stored in the variable `goal-column', which is nil
5886 when there is no goal column. Note that setting `goal-column'
5887 overrides `line-move-visual' and causes this command to move by buffer
5888 lines rather than by display lines."
5894 ;; When adding a newline, don't expand an abbrev.
5905 nil)
5908 "Move cursor vertically up ARG lines.
5909 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5910 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5911 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5912 function will not vscroll.
5914 ARG defaults to 1.
5916 If there is no character in the target line exactly over the current column,
5917 the cursor is positioned after the character in that line which spans this
5918 column, or at the end of the line if it is not long enough.
5920 If the variable `line-move-visual' is non-nil, this command moves
5921 by display lines. Otherwise, it moves by buffer lines, without
5922 taking variable-width characters or continued lines into account.
5926 a semipermanent goal column for this command.
5927 Then instead of trying to move exactly vertically (or as close as possible),
5928 this command moves to the specified goal column (or as close as possible).
5929 The goal column is stored in the variable `goal-column', which is nil
5930 when there is no goal column. Note that setting `goal-column'
5931 overrides `line-move-visual' and causes this command to move by buffer
5932 lines rather than by display lines."
5943 nil)
5946 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5947 This means moving to the end of each line moved onto.
5948 The beginning of a blank line does not count as the end of a line.
5949 This has no effect when the variable `line-move-visual' is non-nil."
5955 A non-nil setting overrides the variable `line-move-visual', which see."
5962 "Current goal column for vertical motion.
5963 It is the column where point was at the start of the current run
5964 of vertical motion commands.
5966 When moving by visual lines via the function `line-move-visual', it is a cons
5967 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5968 divided by the default column width, and HSCROLL is the number of
5969 columns by which window is scrolled from left margin.
5971 When the `track-eol' feature is doing its job, the value is
5975 "Last value of width used for displaying line numbers.
5979 "Non-nil means commands that move by lines ignore invisible newlines.
5980 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5981 as if newlines that are invisible didn't exist, and count
5982 only visible newlines. Thus, moving across 2 newlines
5983 one of which is invisible will be counted as a one-line move.
5984 Also, a non-nil value causes invisible text to be ignored when
5985 counting columns for the purposes of keeping point in the same
5988 Outline mode sets this."
5993 "When non-nil, `line-move' moves point by visual lines.
5994 This movement is based on where the cursor is displayed on the
5995 screen, instead of relying on buffer contents alone. It takes
5996 into account variable-width characters and line continuation.
5997 If nil, `line-move' moves point by logical lines.
5998 A non-nil setting of `goal-column' overrides the value of this variable
5999 and forces movement by logical lines.
6000 A window that is horizontally scrolled also forces movement by logical
6001 lines."
6006 ;; Only used if display-graphic-p.
6010 "Return the height in pixels of the current buffer's default face font.
6012 If the default font is remapped (see `face-remapping-alist'), the
6013 function returns the height of the remapped face."
6017 ;; Avoid calling font-info if the frame's default font was
6018 ;; not changed since the frame was created. That's because
6019 ;; font-info is expensive for some fonts, see bug #14838.
6025 "Return the width in pixels of the current buffer's default face font.
6027 If the default font is remapped (see `face-remapping-alist'), the
6028 function returns the width of the remapped face."
6032 ;; Avoid calling font-info if the frame's default font was
6033 ;; not changed since the frame was created. That's because
6034 ;; font-info is expensive for some fonts, see bug #14838.
6039 width
6044 "Return the pixel height of current buffer's default-face text line.
6046 The value includes `line-spacing', if any, defined for the buffer
6047 or the frame."
6060 "Return the number of screen lines in the text area of the selected window.
6062 This is different from `window-text-height' in that this function counts
6063 lines in units of the height of the font used by the default face displayed
6064 in the window, not in units of the frame's default font, and also accounts
6065 for `line-spacing', if any, defined for the window's buffer or frame.
6067 The value is a floating-point number."
6072 ;; Returns non-nil if partial move was done.
6075 ;; Move backward (up).
6076 ;; If already vscrolled, reduce vscroll
6082 ;; Move forward (down).
6095 py vs last-line)
6115 col-row)
6120 ;; VPOS > 0 means the last line is only partially visible.
6121 ;; But if the part that is visible is at least as tall as the
6122 ;; default font, that means the line is actually fully
6123 ;; readable, and something like line-spacing is hidden. So in
6124 ;; that case we accept the last line in the window as still
6125 ;; visible, and consider the margin as starting one line
6126 ;; later.
6134 ;; If last line of window is fully visible, and vscrolling
6135 ;; more would make this line invisible, move forward.
6140 nil)
6141 ;; If cursor is not in the bottom scroll margin, and the
6142 ;; current line is not too tall, move forward.
6144 vpos
6147 nil)
6148 ;; When already vscrolled, we vscroll some more if we can,
6149 ;; or clear vscroll and move forward at end of tall image.
6154 ;; If cursor just entered the bottom scroll margin, move forward,
6155 ;; but also optionally vscroll one line so redisplay won't recenter.
6159 ;; Don't vscroll if the partially-visible line at window
6160 ;; bottom is not too tall (a.k.a. "just one more text
6161 ;; line"): in that case, we do want redisplay to behave
6162 ;; normally, i.e. recenter or whatever.
6163 ;;
6164 ;; Note: ROWH + RBOT from the value returned by
6165 ;; pos-visible-in-window-p give the total height of the
6166 ;; partially-visible glyph row at the end of the window. As
6167 ;; we are dealing with floats, we disregard sub-pixel
6168 ;; discrepancies between that and DLH.
6172 t)
6173 ;; If there are lines above the last line, scroll-up one line.
6176 t)
6177 ;; Finally, start vscroll.
6182 ;; This is like line-move-1 except that it also performs
6183 ;; vertical scrolling of tall images if appropriate.
6184 ;; That is not really a clean thing to do, since it mixes
6185 ;; scrolling with cursor motion. But so far we don't have
6186 ;; a cleaner solution to the problem of making C-n do something
6187 ;; useful given a tall image.
6189 "Move forward ARG lines.
6190 If NOERROR, don't signal an error if we can't move ARG lines.
6191 TO-END is unused.
6192 TRY-VSCROLL controls whether to vscroll tall lines: if either
6193 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6194 not vscroll."
6198 ;; Only vscroll for single line moves
6200 ;; Under scroll-conservatively, the display engine
6201 ;; does this better.
6203 ;; But don't vscroll in a keyboard macro.
6209 ;; Display-based column are incompatible with goal-column.
6211 ;; When the text in the window is scrolled to the left,
6212 ;; display-based motion doesn't make sense (because each
6213 ;; logical line occupies exactly one screen line).
6215 ;; Likewise when the text _was_ scrolled to the left
6216 ;; when the current run of vertical motion commands
6217 ;; started.
6220 auto-hscroll-mode
6222 (>= temporary-goal-column
6225 ;; If we moved into a tall line, set vscroll to make
6226 ;; scrolling through tall images more smooth.
6230 winh)
6236 nil
6240 ;; Display-based alternative to line-move-1.
6241 ;; Arg says how many lines to move. The value is t if we can move the
6242 ;; specified number of lines.
6244 "Move ARG lines forward.
6245 If NOERROR, don't signal an error if we can't move that many lines."
6249 target-hscroll)
6250 ;; Check if the previous command was a line-motion command, or if
6251 ;; we were called from some other command.
6254 ;; If so, there's no need to reset `temporary-goal-column',
6255 ;; but we may need to hscroll.
6260 ;; Update the COLUMN part of temporary-goal-column if the
6261 ;; line-number display changed its width since the last
6262 ;; time.
6269 ;; Otherwise, we should reset `temporary-goal-column'.
6271 x-pos)
6273 ;; Handle the `overflow-newline-into-fringe' case
6274 ;; (left-fringe is for the R2L case):
6279 ;; In R2L lines, the X pixel coordinate is measured from the
6280 ;; left edge of the window, but columns are still counted
6281 ;; from the logical-order beginning of the line, i.e. from
6282 ;; the right edge in this case. We need to adjust for that.
6288 hscroll)))
6290 ;; When we move beyond the first/last character visible in
6291 ;; the window, posn-at-point will return nil, so we need to
6292 ;; approximate the goal column as below.
6297 ;; vertical-motion can move more than it was asked to if it moves
6298 ;; across display strings with newlines. We don't want to ring
6299 ;; the bell and announce beginning/end of buffer in that case.
6305 temporary-goal-column))
6306 arg))
6307 arg))
6313 temporary-goal-column))
6314 arg))
6315 arg)))
6318 ;; If the goal column lies on a display string,
6319 ;; `vertical-motion' advances the cursor to the end
6320 ;; of the string. For arg < 0, this can cause the
6321 ;; cursor to get stuck. (Bug#3020).
6325 nil)))))
6327 ;; This is the guts of next-line and previous-line.
6328 ;; Arg says how many lines to move.
6329 ;; The value is t if we can move the specified number of lines.
6331 ;; Don't run any point-motion hooks, and disregard intangibility,
6332 ;; for intermediate positions.
6344 ;; Don't count beg of empty line as end of line
6345 ;; unless we just did explicit end-of-line.
6347 most-positive-fixnum
6351 line-move-ignore-invisible))
6352 ;; Use just newline characters.
6353 ;; Set ARG to 0 if we move as many lines as requested.
6356 ;; This way of moving forward ARG lines
6357 ;; verifies that we have a newline after the last one.
6358 ;; It doesn't get confused by intangible text.
6367 'beginning-of-buffer
6369 nil)))
6370 ;; Move by arg lines, but ignore invisible ones.
6373 ;; If the following character is currently invisible,
6374 ;; skip all characters with that same `invisible' property value.
6377 ;; Move a line.
6378 ;; We don't use `end-of-line', since we want to escape
6379 ;; from field boundaries occurring exactly at point.
6385 ;; If there's no invisibility here, move over the newline.
6394 ;; We avoid vertical-motion when possible
6395 ;; because that has to fontify.
6397 ;; Otherwise move a more sophisticated way.
6404 ;; The logic of this is the same as the loop above,
6405 ;; it just goes in the other direction.
6407 ;; For completely consistency with the forward-motion
6408 ;; case, we should call beginning-of-line here.
6409 ;; However, if point is inside a field and on a
6410 ;; continued line, the call to (vertical-motion -1)
6411 ;; below won't move us back far enough; then we return
6412 ;; to the same column in line-move-finish, and point
6413 ;; gets stuck -- cyd
6431 ;; if our target is the middle of this line.
6436 ;; This is the value the function returns.
6440 ;; If we did not move down as far as desired, at least go
6441 ;; to end of line. Be sure to call point-entered and
6442 ;; point-left-hooks.
6448 ;; If we did not move up as far as desired,
6449 ;; at least go to beginning of line.
6461 ;; Set REPEAT to t to repeat the whole thing.
6468 ;; Compute the end of the line
6469 ;; ignoring effectively invisible newlines.
6471 ;; Like end-of-line but ignores fields.
6478 ;; Move to the desired column.
6481 ;; Under line-move-visual, goal-column should be
6482 ;; interpreted in units of the frame's canonical character
6483 ;; width, which is exactly what vertical-motion does.
6487 ;; Corner case: suppose we start out in a field boundary in
6488 ;; the middle of a continued line. When we get to
6489 ;; line-move-finish, point is at the start of a new *screen*
6490 ;; line but the same text line; then line-move-to-column would
6491 ;; move us backwards. Test using C-n with point on the "x" in
6492 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6499 ;; Process intangibility within a line.
6500 ;; With inhibit-point-motion-hooks bound to nil, a call to
6501 ;; goto-char moves point past intangible text.
6503 ;; However, inhibit-point-motion-hooks controls both the
6504 ;; intangibility and the point-entered/point-left hooks. The
6505 ;; following hack avoids calling the point-* hooks
6506 ;; unnecessarily. Note that we move *forward* past intangible
6507 ;; text when the initial and final points are the same.
6512 ;; If intangibility moves us to a different (later) place
6513 ;; in the same line, use that as the destination.
6516 ;; If that position is "too late",
6517 ;; try the previous allowable position.
6518 ;; See if it is ok.
6521 ;; If going forward, don't accept the previous
6522 ;; allowable position if it is before the target line.
6524 ;; If going backward, don't accept the previous
6525 ;; allowable position if it is still after the target line.
6528 ;; As a last resort, use the end of the line.
6531 ;; Now move to the updated destination, processing fields
6532 ;; as well as intangibility.
6536 ;; Ignore field boundaries if the initial and final
6537 ;; positions have the same `field' property, even if the
6538 ;; fields are non-contiguous. This seems to be "nicer"
6539 ;; behavior in many situations.
6542 new
6546 ;; If all this moved us to a different line,
6547 ;; retry everything within that new line.
6549 ;; Repeat the intangibility and field processing.
6553 "Try to find column COL, considering invisibility.
6554 This function works only in certain cases,
6555 because what we really need is for `move-to-column'
6556 and `current-column' to be able to ignore invisible text."
6565 ;; If the following character is currently invisible,
6566 ;; skip all characters with that same `invisible' property value.
6570 ;; Have we advanced to a larger column position?
6572 ;; We have made some progress towards the desired column.
6573 ;; See if we can make any further progress.
6575 ;; Otherwise, go to the place we originally found
6576 ;; and move back over invisible text.
6577 ;; that will get us to the same place on the screen
6578 ;; but with a more reasonable buffer position.
6581 ;; We want the real line beginning, so it's consistent
6582 ;; with bolp below, otherwise we might infloop.
6589 "Move point to end of current line as displayed.
6590 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6591 If point reaches the beginning or end of buffer, it stops there.
6593 To ignore the effects of the `intangible' text or overlay
6594 property, bind `inhibit-point-motion-hooks' to t.
6595 If there is an image in the current line, this function
6596 disregards newlines that are part of the text on which the image
6597 rests."
6607 ;; With bidi reordering, we may not be at bol,
6608 ;; so make sure we are.
6623 ;; If we skipped something intangible and now we're not
6624 ;; really at eol, keep going.
6629 "Move point to beginning of current line as displayed.
6630 \(If there's an image in the line, this disregards newlines
6631 which are part of the text that the image rests on.)
6633 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6634 If point reaches the beginning or end of buffer, it stops there.
6635 \(But if the buffer doesn't end in a newline, it stops at the
6636 beginning of the last line.)
6637 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6642 first-vis first-vis-field-value)
6644 ;; Move by lines, if ARG is not 1 (the default).
6649 ;; Move to beginning-of-line, ignoring fields and invisible text.
6655 ;; Now find first visible char in the line.
6660 ;; See if fields would stop us from reaching FIRST-VIS.
6665 ;; If yes, obey them.
6666 first-vis-field-value
6667 ;; Otherwise, move to START with attention to fields.
6668 ;; (It is possible that fields never matter in this case.)
6673 ;; Many people have said they rarely use this feature, and often type
6674 ;; it by accident. Maybe it shouldn't even be on a key.
6679 Those commands will move to this position in the line moved to
6680 rather than trying to keep the same horizontal position.
6681 With a non-nil argument ARG, clears out the goal column
6683 The goal column is stored in the variable `goal-column'.
6684 This is a buffer-local setting."
6691 ;; The older method below can be erroneous if `set-goal-column' is bound
6692 ;; to a sequence containing %
6693 ;;(message (substitute-command-keys
6694 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6695 ;;goal-column)
6702 )
6703 nil)
6704 \f
6705 ;;; Editing based on visual lines, as opposed to logical lines.
6708 "Move point to end of current visual line.
6709 With argument N not nil or 1, move forward N - 1 visual lines first.
6710 If point reaches the beginning or end of buffer, it stops there.
6711 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6717 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6718 ;; constrain to field boundaries, so we don't either.
6722 "Move point to beginning of current visual line.
6723 With argument N not nil or 1, move forward N - 1 visual lines first.
6724 If point reaches the beginning or end of buffer, it stops there.
6725 \(But if the buffer doesn't end in a newline, it stops at the
6726 beginning of the last visual line.)
6727 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6735 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6739 "Kill the rest of the visual line.
6740 With prefix argument ARG, kill that many visual lines from point.
6741 If ARG is negative, kill visual lines backward.
6742 If ARG is zero, kill the text before point on the current visual
6743 line.
6745 If you want to append the killed line to the last killed text,
6748 If the buffer is read-only, Emacs will beep and refrain from deleting
6749 the line, but put the line in the kill ring anyway. This means that
6750 you can use this command to copy text from a read-only buffer.
6751 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6752 even beep.)"
6754 ;; Like in `kill-line', it's better to move point to the other end
6755 ;; of the kill before killing.
6763 ;; Skip any trailing whitespace at the end of the visual line.
6764 ;; We used to do this only if `show-trailing-whitespace' is
6765 ;; nil, but that's wrong; the correct thing would be to check
6766 ;; whether the trailing whitespace is highlighted. But, it's
6767 ;; OK to just do this unconditionally.
6774 "Move cursor vertically down ARG lines.
6775 This is identical to `next-line', except that it always moves
6776 by logical lines instead of visual lines, ignoring the value of
6777 the variable `line-move-visual'."
6784 "Move cursor vertically up ARG lines.
6785 This is identical to `previous-line', except that it always moves
6786 by logical lines instead of visual lines, ignoring the value of
6787 the variable `line-move-visual'."
6794 "Editing based on visual lines."
6803 ;; These keybindings interfere with xterm function keys. Are
6804 ;; there any other suitable bindings?
6805 ;; (define-key map "\M-[" 'previous-logical-line)
6806 ;; (define-key map "\M-]" 'next-logical-line)
6807 map))
6810 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6811 The value should be a list of the form (LEFT RIGHT), where LEFT
6812 and RIGHT are symbols representing the bitmaps to display, to
6813 indicate wrapped lines, in the left and right fringes respectively.
6814 See also `fringe-indicator-alist'.
6815 The default is not to display fringe indicators for wrapped lines.
6816 This variable does not affect fringe indicators displayed for
6817 other purposes."
6832 'continuation
6839 "Toggle visual line based editing (Visual Line mode) in the current buffer.
6840 Interactively, with a prefix argument, enable
6841 Visual Line mode if the prefix argument is positive,
6842 and disable it otherwise. If called from Lisp, toggle
6843 the mode if ARG is `toggle', disable the mode if ARG is
6844 a non-positive integer, and enable the mode otherwise
6845 \(including if ARG is omitted or nil or a positive integer).
6847 When Visual Line mode is enabled, `word-wrap' is turned on in
6848 this buffer, and simple editing commands are redefined to act on
6849 visual lines, not logical lines. See Info node `Visual Line
6850 Mode' for details."
6851 :keymap visual-line-mode-map
6857 ;; Save the local values of some variables, to be restored if
6858 ;; visual-line-mode is turned off.
6860 truncate-partial-width-windows
6861 word-wrap fringe-indicator-alist))
6864 visual-line--saved-state)))
6868 word-wrap t
6869 fringe-indicator-alist
6871 fringe-indicator-alist)))
6885 visual-line-mode turn-on-visual-line-mode)
6887 \f
6889 "Interchange characters around point, moving forward one character.
6890 With prefix arg ARG, effect is to take character before point
6891 and drag it forward past ARG other characters (backward if ARG negative).
6892 If no argument and at end of line, the previous two chars are exchanged."
6900 "Interchange words around point, leaving point at end of them.
6901 With prefix arg ARG, effect is to take word before or around point
6902 and drag it forward past ARG other words (backward if ARG negative).
6903 If ARG is zero, the words around or after point and around or after mark
6904 are interchanged."
6905 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6911 Unlike `transpose-words', point must be between the two sexps and not
6912 in the middle of a sexp to be transposed.
6913 With non-zero prefix arg ARG, effect is to take the sexp before point
6914 and drag it forward past ARG other sexps (backward if ARG is negative).
6915 If ARG is zero, the sexps ending at or after point and at or after mark
6916 are interchanged."
6920 ;; Here we should try to simulate the behavior of
6921 ;; (cons (progn (forward-sexp x) (point))
6922 ;; (progn (forward-sexp (- x)) (point)))
6923 ;; Except that we don't want to rely on the second forward-sexp
6924 ;; putting us back to where we want to be, since forward-sexp-function
6925 ;; might do funny things like infix-precedence.
6930 ;; Jumping over a symbol. We might be inside it, mind you.
6935 ;; Otherwise, we're between sexps. Take a step back before jumping
6936 ;; to make sure we'll obey the same precedence no matter which direction
6937 ;; we're going.
6942 'skip-syntax-forward
6949 "Exchange current line and previous line, leaving point after both.
6950 With argument ARG, takes previous line and moves it past ARG lines.
6951 With argument 0, interchanges line point is in with line mark is in."
6957 ;; Move forward over ARG lines,
6958 ;; but create newlines if necessary.
6965 arg))
6967 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6968 ;; which seems inconsistent with the ARG /= 0 case.
6969 ;; FIXME document SPECIAL.
6971 "Subroutine to do the work of transposing objects.
6972 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6973 moves forward by units of the given object (e.g. forward-sentence,
6974 forward-paragraph). If ARG is zero, exchanges the current object
6975 with the one containing mark. If ARG is an integer, moves the
6976 current object past ARG following (if ARG is positive) or
6977 preceding (if ARG is negative) objects, leaving point after the
6978 current object."
6983 pos1 pos2)
7012 ;; This sequence of insertions attempts to preserve marker
7013 ;; positions at the start and end of the transposed objects.
7027 \f
7029 "Move backward until encountering the beginning of a word.
7030 With argument ARG, do this that many times.
7031 If ARG is omitted or nil, move point backward one word.
7033 The word boundaries are normally determined by the buffer's
7034 syntax table and character script (according to
7035 `char-script-table'), but `find-word-boundary-function-table',
7036 such as set up by `subword-mode', can change that. If a Lisp
7037 program needs to move by words determined strictly by the syntax
7038 table, it should use `backward-word-strictly' instead. See Info
7039 node `(elisp) Word Motion' for details."
7044 "Set mark ARG words away from point.
7046 move to with the same argument.
7047 Interactively, if this command is repeated
7048 or (in Transient Mark mode) if the mark is active,
7049 it marks the next ARG words after the ones already marked."
7066 nil t))))
7069 "Kill characters forward until encountering the end of a word.
7070 With argument ARG, do this that many times."
7075 "Kill characters backward until encountering the beginning of a word.
7076 With argument ARG, do this that many times."
7081 "Return the word at or near point, as a string.
7082 The return value includes no text properties.
7084 If optional arg STRICT is non-nil, return nil unless point is
7085 within or adjacent to a word, otherwise look for a word within
7086 point's line. If there is no word anywhere on point's line, the
7087 value is nil regardless of STRICT.
7089 By default, this function treats as a single word any sequence of
7090 characters that have either word or symbol syntax. If optional
7091 arg REALLY-WORD is non-nil, only characters of word syntax can
7092 constitute a word."
7101 ;; Point is neither within nor adjacent to a word.
7103 ;; Look for preceding word in same line.
7106 ;; No preceding word in same line.
7107 ;; Look for following word in same line.
7116 ;; If we found something nonempty, return it as a string.
7119 \f
7121 "String for filling to insert at front of new line, or nil for none."
7123 string)
7129 "Regexp to match lines which should not be auto-filled."
7131 regexp)
7135 "The default value for `normal-auto-fill-function'.
7136 This is the default auto-fill function, some major modes use a different one.
7137 Returns t if it really did any work."
7147 nil ;; Auto-filling not required
7151 ;; Choose a fill-prefix automatically.
7159 ;; Use auto-indentation rather than a guessed empty prefix.
7165 ;; Determine where to split the line.
7169 ;; Don't split earlier in the line than the length of the
7170 ;; fill prefix, since the resulting line would be longer.
7178 ;; See whether the place we found is any good.
7182 ;; There is no use breaking at end of line.
7184 ;; Don't split right after a comment starter
7185 ;; since we would just make another comment starter.
7190 limit t)
7192 ;; No good place to break => stop trying.
7194 ;; Ok, we have a useful place to break the line. Do it.
7196 ;; If point is at the fill-point, do not `save-excursion'.
7197 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7198 ;; point will end up before it rather than after it.
7206 ;; Now do justification, if required
7211 ;; If making the new line didn't reduce the hpos of
7212 ;; the end of the line, then give up now;
7213 ;; trying again will not help.
7216 ;; Justify last line.
7218 t)))
7221 "Mode-specific function which line breaks and continues a comment.
7222 This function is called during auto-filling when a comment syntax
7223 is defined.
7224 The function should take a single optional argument, which is a flag
7228 "Break line at point and indent.
7229 If a comment syntax is defined, call `comment-indent-new-line'.
7231 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7232 unless optional argument SOFT is non-nil."
7236 ;; Insert the newline before removing empty space so that markers
7237 ;; get preserved better.
7243 ;; Blindly trust a non-adaptive fill-prefix.
7249 ;; If there's an adaptive prefix, use it unless we're inside
7250 ;; a comment and the prefix is not a comment starter.
7254 ;; If we're not inside a comment, just try to indent.
7258 "The function called by `self-insert-command' to perform auto-filling."
7265 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7269 ;; `functions' and `hooks' are usually unsafe to set, but setting
7270 ;; auto-fill-function to nil in a file-local setting is safe and
7271 ;; can be useful to prevent auto-filling.
7275 "Toggle automatic line breaking (Auto Fill mode).
7276 Interactively, with a prefix argument, enable
7277 Auto Fill mode if the prefix argument is positive,
7278 and disable it otherwise. If called from Lisp, toggle
7279 the mode if ARG is `toggle', disable the mode if ARG is
7280 a non-positive integer, and enable the mode otherwise
7281 \(including if ARG is omitted or nil or a positive integer).
7283 When Auto Fill mode is enabled, inserting a space at a column
7284 beyond `current-fill-column' automatically breaks the line at a
7285 previous space.
7287 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7288 non-nil.
7290 The value of `normal-auto-fill-function' specifies the function to use
7291 for `auto-fill-function' when turning Auto Fill mode on."
7296 ;; This holds a document string used to document auto-fill-mode.
7298 "Automatically break line at a previous space, in insertion of text."
7299 nil)
7302 "Unconditionally turn on Auto Fill mode."
7306 "Unconditionally turn off Auto Fill mode."
7312 "Set `fill-column' to specified argument.
7317 ;; We used to use current-column silently, but C-x f is too easily
7318 ;; typed as a typo for C-x C-f, so we turned it into an error and
7319 ;; now an interactive prompt.
7324 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7328 \f
7330 "Set `selective-display' to ARG; clear it if no arg.
7331 When the value of `selective-display' is a number > 0,
7332 lines whose indentation is >= that value are not displayed.
7333 The variable `selective-display' has a separate value for each buffer."
7353 "Toggle truncating of long lines for the current buffer.
7354 When truncating is off, long lines are folded.
7355 With prefix argument ARG, truncate long lines if ARG is positive,
7356 otherwise fold them. Note that in side-by-side windows, this
7357 command has no effect if `truncate-partial-width-windows' is
7358 non-nil."
7370 nil t)))
7375 "Toggle whether to use word-wrapping for continuation lines.
7376 With prefix argument ARG, wrap continuation lines at word boundaries
7377 if ARG is positive, otherwise wrap them at the right screen edge.
7378 This command toggles the value of `word-wrap'. It has no effect
7379 if long lines are truncated."
7395 "Toggle Overwrite mode.
7396 With a prefix argument ARG, enable Overwrite mode if ARG is
7397 positive, and disable it otherwise. If called from Lisp, enable
7398 the mode if ARG is omitted or nil.
7400 When Overwrite mode is enabled, printing characters typed in
7401 replace existing text on a one-for-one basis, rather than pushing
7402 it to the right. At the end of a line, such characters extend
7403 the line. Before a tab, such characters insert until the tab is
7405 overwrite mode; this is supposed to make it easier to insert
7406 characters when necessary."
7411 "Toggle Binary Overwrite mode.
7412 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7413 is positive, and disable it otherwise. If called from Lisp,
7414 enable the mode if ARG is omitted or nil.
7416 When Binary Overwrite mode is enabled, printing characters typed
7417 in replace existing text. Newlines are not treated specially, so
7418 typing at the end of a line joins the line to the next, with the
7419 typed character between them. Typing before a tab character
7420 simply replaces the tab with the character typed.
7422 ordinary typing characters do.
7424 Note that Binary Overwrite mode is not its own minor mode; it is
7425 a specialization of overwrite mode, entered by setting the
7426 `overwrite-mode' variable to `overwrite-mode-binary'."
7431 "Toggle line number display in the mode line (Line Number mode).
7432 With a prefix argument ARG, enable Line Number mode if ARG is
7433 positive, and disable it otherwise. If called from Lisp, enable
7434 the mode if ARG is omitted or nil.
7436 Line numbers do not appear for very large buffers and buffers
7437 with very long lines; see variables `line-number-display-limit'
7438 and `line-number-display-limit-width'."
7442 "Toggle column number display in the mode line (Column Number mode).
7443 With a prefix argument ARG, enable Column Number mode if ARG is
7444 positive, and disable it otherwise.
7446 If called from Lisp, enable the mode if ARG is omitted or nil."
7450 "Toggle buffer size display in the mode line (Size Indication mode).
7451 With a prefix argument ARG, enable Size Indication mode if ARG is
7452 positive, and disable it otherwise.
7454 If called from Lisp, enable the mode if ARG is omitted or nil."
7458 "Toggle auto-saving in the current buffer (Auto Save mode).
7459 With a prefix argument ARG, enable Auto Save mode if ARG is
7460 positive, and disable it otherwise.
7462 If called from Lisp, enable the mode if ARG is omitted or nil."
7464 ;; If auto-save is off because buffer has shrunk,
7465 ;; then toggling should turn it on.
7473 buffer-file-name)
7475 ;; If -1 was stored here, to temporarily turn off saving,
7476 ;; turn it back on.
7479 \f
7481 "Blinking matching of parens and expressions."
7486 "Non-nil means show matching open-paren when close-paren is inserted.
7487 If t, highlight the paren. If `jump', briefly move cursor to its
7488 position. If `jump-offscreen', move cursor there even if the
7489 position is off screen. With any other non-nil value, the
7490 off-screen position of the opening paren will be shown in the
7491 echo area."
7500 "Non-nil means show matching open-paren when it is on screen.
7501 If nil, don't show it (but the open-paren can still be shown
7502 in the echo area when it is off screen).
7504 This variable has no effect if `blink-matching-paren' is nil.
7505 \(In that case, the open-paren is never shown.)
7506 It is also ignored if `show-paren-mode' is enabled."
7511 "If non-nil, maximum distance to search backwards for matching open-paren.
7512 If nil, search stops at the beginning of the accessible portion of the buffer."
7518 "Time in seconds to delay after showing a matching paren."
7523 "If nil, `blink-matching-paren' ignores comments.
7524 More precisely, when looking for the matching parenthesis,
7525 it skips the contents of comments that end before point."
7530 "Return whether or not START...END are matching parens.
7531 END is the current point and START is the blink position.
7532 START might be nil if no matching starter was found.
7533 Returns non-nil if we find there is a mismatch."
7538 ;; For self-matched chars like " and $, we can't know when they're
7539 ;; mismatched or unmatched, so we can only do it for parens.
7544 ;; The cdr might hold a new paren-class info rather than
7545 ;; a matching-char info, in which case the two CDRs
7546 ;; should match.
7550 "Function to check parentheses mismatches.
7551 The function takes two arguments (START and END) where START is the
7552 position just before the opening token and END is the position right after.
7553 START can be nil, if it was not found.
7560 ol)
7564 "Momentarily highlight the beginning of the sexp before point."
7567 blink-matching-paren)
7577 oldpos))
7585 ;; backward-sexp skips backward over prefix chars,
7586 ;; so move back to the matching paren.
7609 ;; Matching open within window, temporarily move to or highlight
7610 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7611 ;; is non-nil.
7628 ;; Show what precedes the open in its line, if anything.
7633 ;; Show what follows the open in its line, if anything.
7640 ;; Otherwise show the previous nonblank line,
7641 ;; if there is one.
7650 ;; Replace the newline and other whitespace with `...'.
7651 "..."
7653 ;; There is nothing to show except the char itself.
7656 "Matches %s"
7660 "Function called, if non-nil, whenever a close parenthesis is inserted.
7666 blink-paren-function
7669 ;; Verify an even number of quoting characters precede the close.
7670 ;; FIXME: Also check if this parenthesis closes a comment as
7671 ;; can happen in Pascal and SML.
7682 ;; Most likely, this hook is nil, so this arg doesn't matter,
7683 ;; but I use it as a reminder that this function usually
7684 ;; likes to be run after others since it does
7685 ;; `sit-for'. That's also the reason it get a `priority' prop
7686 ;; of 100.
7688 \f
7689 ;; This executes C-g typed while Emacs is waiting for a command.
7690 ;; Quitting out of a program does not go through here;
7691 ;; that happens in the maybe_quit function at the C code level.
7693 "Signal a `quit' condition.
7694 During execution of Lisp code, this character causes a quit directly.
7695 At top-level, as an editor command, this simply beeps."
7697 ;; Avoid adding the region to the window selection.
7705 ;; Force the next redisplay cycle to remove the "Def" indicator from
7706 ;; all the mode lines.
7720 This command can exit an interactive command such as `query-replace',
7721 can clear out a prefix argument or a region,
7722 can get out of the minibuffer or other recursive edit,
7723 cancel the use of the current buffer (for special-purpose buffers),
7724 or go back to just one window (by deleting all but the selected window)."
7732 nil)
7743 "Play sound stored in FILE.
7744 VOLUME and DEVICE correspond to the keywords of the sound
7745 specification for `play-sound'."
7755 \f
7757 "Your preference for a mail reading package.
7758 This is used by some keybindings which support reading mail.
7759 See also `mail-user-agent' concerning sending mail."
7769 "Your preference for a mail composition package.
7770 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7771 outgoing email message. This variable lets you specify which
7772 mail-sending package you prefer.
7774 Valid values include:
7776 `message-user-agent' -- use the Message package.
7777 See Info node `(message)'.
7778 `sendmail-user-agent' -- use the Mail package.
7779 See Info node `(emacs)Sending Mail'.
7780 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7781 See Info node `(mh-e)'.
7782 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7783 paraphernalia if Gnus is running, particularly
7784 the Gcc: header for archiving.
7786 Additional valid symbols may be available; check with the author of
7787 your package for details. The function should return non-nil if it
7788 succeeds.
7790 See also `read-mail-command' concerning reading mail."
7793 message-user-agent)
7796 sendmail-user-agent)
7799 mh-e-user-agent)
7802 gnus-user-agent)
7808 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7809 If the value of `mail-user-agent' is the default, and the user
7810 appears to have customizations applying to the old default,
7811 `compose-mail' issues a warning."
7817 "If the buffer starts with a mail header, move point to the header's end.
7818 Otherwise, moves to `point-min'.
7819 The end of the header is the start of the next line, if there is one,
7820 else the end of the last line. This function obeys RFC822."
7826 ;; Used by Rmail (e.g., rmail-forward).
7828 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7832 switch-function yank-action send-actions
7833 return-action)
7834 "Start composing a mail message to send.
7835 This uses the user's chosen mail composition package
7836 as selected with the variable `mail-user-agent'.
7837 The optional arguments TO and SUBJECT specify recipients
7838 and the initial Subject field, respectively.
7840 OTHER-HEADERS is an alist specifying additional
7841 header fields. Elements look like (HEADER . VALUE) where both
7842 HEADER and VALUE are strings.
7844 CONTINUE, if non-nil, says to continue editing a message already
7845 being composed. Interactively, CONTINUE is the prefix argument.
7847 SWITCH-FUNCTION, if non-nil, is a function to use to
7848 switch to and display the buffer used for mail composition.
7850 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7851 to insert the raw text of the message being replied to.
7852 It has the form (FUNCTION . ARGS). The user agent will apply
7853 FUNCTION to ARGS, to insert the raw text of the original message.
7854 \(The user agent will also run `mail-citation-hook', *after* the
7855 original text has been inserted in this way.)
7857 SEND-ACTIONS is a list of actions to call when the message is sent.
7858 Each action has the form (FUNCTION . ARGS).
7860 RETURN-ACTION, if non-nil, is an action for returning to the
7861 caller. It has the form (FUNCTION . ARGS). The function is
7862 called after the mail has been sent or put aside, and the mail
7863 buffer buried."
7867 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7868 ;; from sendmail-user-agent to message-user-agent. Some users may
7869 ;; encounter incompatibilities. This hack tries to detect problems
7870 ;; and warn about them.
7875 mail-yank-hooks mail-archive-file-name
7876 mail-default-reply-to mail-mailing-lists
7877 mail-self-blind))
7884 The default mail mode is now Message mode.
7885 You have the following Mail mode variable%s customized:
7887 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7894 yank-action send-actions return-action)))
7897 yank-action send-actions
7898 return-action)
7902 'switch-to-buffer-other-window yank-action send-actions
7903 return-action))
7906 yank-action send-actions
7907 return-action)
7911 'switch-to-buffer-other-frame yank-action send-actions
7912 return-action))
7914 \f
7916 "History of values entered with `set-variable'.
7918 Maximum length of the history list is determined by the value
7922 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7923 VARIABLE should be a user option variable name, a Lisp variable
7924 meant to be customized by users. You should enter VALUE in Lisp syntax,
7925 so if you want VALUE to be a string, you must surround it with doublequotes.
7926 VALUE is used literally, not evaluated.
7928 If VARIABLE has a `variable-interactive' property, that is used as if
7929 it were the arg to `interactive' (which see) to interactively read VALUE.
7931 If VARIABLE has been defined with `defcustom', then the type information
7932 in the definition is used to check that VALUE is valid.
7934 Note that this function is at heart equivalent to the basic `set' function.
7935 For a variable defined with `defcustom', it does not pay attention to
7936 any :set property that the variable might have (if you want that, use
7939 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7944 default-var)
7960 var obsolete)
7963 ;; Use VAR's `variable-interactive' property
7964 ;; as an interactive spec for prompting.
7967 arg))
7969 read-expression-map t
7970 'set-variable-value-history
7979 ;; Match with custom type.
7991 ;; Force a thorough redisplay for the case that the variable
7992 ;; has an effect on the display, like `tab-width' has.
7994 \f
7995 ;; Define the major mode for lists of completions.
8005 (define-key map [right] 'next-completion)
8007 (define-key map [backtab] 'previous-completion)
8008 (define-key map "q" 'quit-window)
8009 (define-key map "z" 'kill-current-buffer)
8010 map)
8011 "Local map for completion list buffers.")
8013 ;; Completion mode is suitable only for specially formatted data.
8014 (put 'completion-list-mode 'mode-class 'special)
8016 (defvar completion-reference-buffer nil
8017 "Record the buffer that was current when the completion list was requested.
8018 This is a local variable in the completion list buffer.
8019 Initial value is nil to avoid some compiler warnings.")
8021 (defvar completion-no-auto-exit nil
8022 "Non-nil means `choose-completion-string' should never exit the minibuffer.
8023 This also applies to other functions such as `choose-completion'.")
8025 (defvar completion-base-position nil
8026 "Position of the base of the text corresponding to the shown completions.
8027 This variable is used in the *Completions* buffers.
8028 Its value is a list of the form (START END) where START is the place
8029 where the completion should be inserted and END (if non-nil) is the end
8030 of the text to replace. If END is nil, point is used instead.")
8032 (defvar completion-list-insert-choice-function #'completion--replace
8033 "Function to use to insert the text chosen in *Completions*.
8034 Called with three arguments (BEG END TEXT), it should replace the text
8035 between BEG and END with TEXT. Expected to be set buffer-locally
8036 in the *Completions* buffer.")
8038 (defvar completion-base-size nil
8039 "Number of chars before point not involved in completion.
8040 This is a local variable in the completion list buffer.
8041 It refers to the chars in the minibuffer if completing in the
8042 minibuffer, or in `completion-reference-buffer' otherwise.
8043 Only characters in the field at point are included.
8045 If nil, Emacs determines which part of the tail end of the
8046 buffer's text is involved in completion by comparing the text
8047 directly.")
8048 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
8050 (defun delete-completion-window ()
8051 "Delete the completion list window.
8052 Go to the window from which completion was requested."
8053 (interactive)
8054 (let ((buf completion-reference-buffer))
8055 (if (one-window-p t)
8056 (if (window-dedicated-p) (delete-frame))
8057 (delete-window (selected-window))
8058 (if (get-buffer-window buf)
8059 (select-window (get-buffer-window buf))))))
8061 (defun previous-completion (n)
8062 "Move to the previous item in the completion list."
8063 (interactive "p")
8064 (next-completion (- n)))
8066 (defun next-completion (n)
8067 "Move to the next item in the completion list.
8068 With prefix argument N, move N items (negative N means move backward)."
8069 (interactive "p")
8070 (let ((beg (point-min)) (end (point-max)))
8071 (while (and (> n 0) (not (eobp)))
8072 ;; If in a completion, move to the end of it.
8073 (when (get-text-property (point) 'mouse-face)
8074 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8075 ;; Move to start of next one.
8076 (unless (get-text-property (point) 'mouse-face)
8077 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8078 (setq n (1- n)))
8079 (while (and (< n 0) (not (bobp)))
8080 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
8081 ;; If in a completion, move to the start of it.
8082 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
8083 (goto-char (previous-single-property-change
8084 (point) 'mouse-face nil beg)))
8085 ;; Move to end of the previous completion.
8086 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
8087 (goto-char (previous-single-property-change
8088 (point) 'mouse-face nil beg)))
8089 ;; Move to the start of that one.
8090 (goto-char (previous-single-property-change
8091 (point) 'mouse-face nil beg))
8092 (setq n (1+ n))))))
8094 (defun choose-completion (&optional event)
8095 "Choose the completion at point.
8096 If EVENT, use EVENT's position to determine the starting position."
8097 (interactive (list last-nonmenu-event))
8098 ;; In case this is run via the mouse, give temporary modes such as
8099 ;; isearch a chance to turn off.
8100 (run-hooks 'mouse-leave-buffer-hook)
8101 (with-current-buffer (window-buffer (posn-window (event-start event)))
8102 (let ((buffer completion-reference-buffer)
8103 (base-size completion-base-size)
8104 (base-position completion-base-position)
8105 (insert-function completion-list-insert-choice-function)
8106 (choice
8107 (save-excursion
8108 (goto-char (posn-point (event-start event)))
8109 (let (beg end)
8110 (cond
8111 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
8112 (setq end (point) beg (1+ (point))))
8113 ((and (not (bobp))
8114 (get-text-property (1- (point)) 'mouse-face))
8115 (setq end (1- (point)) beg (point)))
8116 (t (error "No completion here")))
8117 (setq beg (previous-single-property-change beg 'mouse-face))
8118 (setq end (or (next-single-property-change end 'mouse-face)
8119 (point-max)))
8120 (buffer-substring-no-properties beg end)))))
8122 (unless (buffer-live-p buffer)
8123 (error "Destination buffer is dead"))
8124 (quit-window nil (posn-window (event-start event)))
8126 (with-current-buffer buffer
8127 (choose-completion-string
8128 choice buffer
8129 (or base-position
8130 (when base-size
8131 ;; Someone's using old completion code that doesn't know
8132 ;; about base-position yet.
8133 (list (+ base-size (field-beginning))))
8134 ;; If all else fails, just guess.
8135 (list (choose-completion-guess-base-position choice)))
8136 insert-function)))))
8138 ;; Delete the longest partial match for STRING
8139 ;; that can be found before POINT.
8140 (defun choose-completion-guess-base-position (string)
8141 (save-excursion
8142 (let ((opoint (point))
8143 len)
8144 ;; Try moving back by the length of the string.
8145 (goto-char (max (- (point) (length string))
8146 (minibuffer-prompt-end)))
8147 ;; See how far back we were actually able to move. That is the
8148 ;; upper bound on how much we can match and delete.
8149 (setq len (- opoint (point)))
8150 (if completion-ignore-case
8151 (setq string (downcase string)))
8152 (while (and (> len 0)
8153 (let ((tail (buffer-substring (point) opoint)))
8154 (if completion-ignore-case
8155 (setq tail (downcase tail)))
8156 (not (string= tail (substring string 0 len)))))
8157 (setq len (1- len))
8158 (forward-char 1))
8159 (point))))
8161 (defun choose-completion-delete-max-match (string)
8162 (declare (obsolete choose-completion-guess-base-position "23.2"))
8163 (delete-region (choose-completion-guess-base-position string) (point)))
8165 (defvar choose-completion-string-functions nil
8166 "Functions that may override the normal insertion of a completion choice.
8167 These functions are called in order with three arguments:
8168 CHOICE - the string to insert in the buffer,
8169 BUFFER - the buffer in which the choice should be inserted,
8170 BASE-POSITION - where to insert the completion.
8172 If a function in the list returns non-nil, that function is supposed
8173 to have inserted the CHOICE in the BUFFER, and possibly exited
8174 the minibuffer; no further functions will be called.
8176 If all functions in the list return nil, that means to use
8177 the default method of inserting the completion in BUFFER.")
8179 (defun choose-completion-string (choice &optional
8180 buffer base-position insert-function)
8181 "Switch to BUFFER and insert the completion choice CHOICE.
8182 BASE-POSITION says where to insert the completion.
8183 INSERT-FUNCTION says how to insert the completion and falls
8184 back on `completion-list-insert-choice-function' when nil."
8186 ;; If BUFFER is the minibuffer, exit the minibuffer
8187 ;; unless it is reading a file name and CHOICE is a directory,
8188 ;; or completion-no-auto-exit is non-nil.
8190 ;; Some older code may call us passing `base-size' instead of
8191 ;; `base-position'. It's difficult to make any use of `base-size',
8192 ;; so we just ignore it.
8193 (unless (consp base-position)
8194 (message "Obsolete `base-size' passed to choose-completion-string")
8195 (setq base-position nil))
8197 (let* ((buffer (or buffer completion-reference-buffer))
8198 (mini-p (minibufferp buffer)))
8199 ;; If BUFFER is a minibuffer, barf unless it's the currently
8200 ;; active minibuffer.
8201 (if (and mini-p
8202 (not (and (active-minibuffer-window)
8203 (equal buffer
8204 (window-buffer (active-minibuffer-window))))))
8205 (error "Minibuffer is not active for completion")
8206 ;; Set buffer so buffer-local choose-completion-string-functions works.
8207 (set-buffer buffer)
8208 (unless (run-hook-with-args-until-success
8209 'choose-completion-string-functions
8210 ;; The fourth arg used to be `mini-p' but was useless
8211 ;; (since minibufferp can be used on the `buffer' arg)
8212 ;; and indeed unused. The last used to be `base-size', so we
8213 ;; keep it to try and avoid breaking old code.
8214 choice buffer base-position nil)
8215 ;; This remove-text-properties should be unnecessary since `choice'
8216 ;; comes from buffer-substring-no-properties.
8217 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8218 ;; Insert the completion into the buffer where it was requested.
8219 (funcall (or insert-function completion-list-insert-choice-function)
8220 (or (car base-position) (point))
8221 (or (cadr base-position) (point))
8222 choice)
8223 ;; Update point in the window that BUFFER is showing in.
8224 (let ((window (get-buffer-window buffer t)))
8225 (set-window-point window (point)))
8226 ;; If completing for the minibuffer, exit it with this choice.
8227 (and (not completion-no-auto-exit)
8228 (minibufferp buffer)
8229 minibuffer-completion-table
8230 ;; If this is reading a file name, and the file name chosen
8231 ;; is a directory, don't exit the minibuffer.
8232 (let* ((result (buffer-substring (field-beginning) (point)))
8233 (bounds
8234 (completion-boundaries result minibuffer-completion-table
8235 minibuffer-completion-predicate
8236 "")))
8237 (if (eq (car bounds) (length result))
8238 ;; The completion chosen leads to a new set of completions
8239 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8240 (let ((mini (active-minibuffer-window)))
8241 (select-window mini)
8242 (when minibuffer-auto-raise
8243 (raise-frame (window-frame mini))))
8244 (exit-minibuffer))))))))
8246 (define-derived-mode completion-list-mode nil "Completion List"
8247 "Major mode for buffers showing lists of possible completions.
8249 to select the completion near point.
8250 Or click to select one with the mouse.
8253 (set (make-local-variable 'completion-base-size) nil))
8255 (defun completion-list-mode-finish ()
8256 "Finish setup of the completions buffer.
8257 Called from `temp-buffer-show-hook'."
8258 (when (eq major-mode 'completion-list-mode)
8259 (setq buffer-read-only t)))
8261 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8264 ;; Variables and faces used in `completion-setup-function'.
8266 (defcustom completion-show-help t
8267 "Non-nil means show help message in *Completions* buffer."
8268 :type 'boolean
8269 :version "22.1"
8270 :group 'completion)
8272 ;; This function goes in completion-setup-hook, so that it is called
8273 ;; after the text of the completion list buffer is written.
8274 (defun completion-setup-function ()
8275 (let* ((mainbuf (current-buffer))
8276 (base-dir
8277 ;; FIXME: This is a bad hack. We try to set the default-directory
8278 ;; in the *Completions* buffer so that the relative file names
8279 ;; displayed there can be treated as valid file names, independently
8280 ;; from the completion context. But this suffers from many problems:
8281 ;; - It's not clear when the completions are file names. With some
8282 ;; completion tables (e.g. bzr revision specs), the listed
8283 ;; completions can mix file names and other things.
8284 ;; - It doesn't pay attention to possible quoting.
8285 ;; - With fancy completion styles, the code below will not always
8286 ;; find the right base directory.
8287 (if minibuffer-completing-file-name
8288 (file-name-as-directory
8289 (expand-file-name
8290 (buffer-substring (minibuffer-prompt-end)
8291 (- (point) (or completion-base-size 0))))))))
8292 (with-current-buffer standard-output
8293 (let ((base-size completion-base-size) ;Read before killing localvars.
8294 (base-position completion-base-position)
8295 (insert-fun completion-list-insert-choice-function))
8296 (completion-list-mode)
8297 (set (make-local-variable 'completion-base-size) base-size)
8298 (set (make-local-variable 'completion-base-position) base-position)
8299 (set (make-local-variable 'completion-list-insert-choice-function)
8300 insert-fun))
8301 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8302 (if base-dir (setq default-directory base-dir))
8303 ;; Maybe insert help string.
8304 (when completion-show-help
8305 (goto-char (point-min))
8306 (if (display-mouse-p)
8308 (insert (substitute-command-keys
8312 (add-hook 'completion-setup-hook 'completion-setup-function)
8314 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8315 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8317 (defun switch-to-completions ()
8318 "Select the completion list window."
8319 (interactive)
8320 (let ((window (or (get-buffer-window "*Completions*" 0)
8321 ;; Make sure we have a completions window.
8322 (progn (minibuffer-completion-help)
8323 (get-buffer-window "*Completions*" 0)))))
8324 (when window
8325 (select-window window)
8326 ;; In the new buffer, go to the first completion.
8327 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8328 (when (bobp)
8329 (next-completion 1)))))
8330 \f
8331 ;;; Support keyboard commands to turn on various modifiers.
8333 ;; These functions -- which are not commands -- each add one modifier
8334 ;; to the following event.
8336 (defun event-apply-alt-modifier (_ignore-prompt)
8339 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8340 (defun event-apply-super-modifier (_ignore-prompt)
8343 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8344 (defun event-apply-hyper-modifier (_ignore-prompt)
8347 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8348 (defun event-apply-shift-modifier (_ignore-prompt)
8351 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8352 (defun event-apply-control-modifier (_ignore-prompt)
8355 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8356 (defun event-apply-meta-modifier (_ignore-prompt)
8359 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8361 (defun event-apply-modifier (event symbol lshiftby prefix)
8362 "Apply a modifier flag to event EVENT.
8363 SYMBOL is the name of this modifier, as a symbol.
8364 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8365 PREFIX is the string that represents this modifier in an event type symbol."
8366 (if (numberp event)
8367 (cond ((eq symbol 'control)
8368 (if (and (<= (downcase event) ?z)
8369 (>= (downcase event) ?a))
8370 (- (downcase event) ?a -1)
8371 (if (and (<= (downcase event) ?Z)
8372 (>= (downcase event) ?A))
8373 (- (downcase event) ?A -1)
8374 (logior (lsh 1 lshiftby) event))))
8375 ((eq symbol 'shift)
8376 (if (and (<= (downcase event) ?z)
8377 (>= (downcase event) ?a))
8378 (upcase event)
8379 (logior (lsh 1 lshiftby) event)))
8380 (t
8381 (logior (lsh 1 lshiftby) event)))
8382 (if (memq symbol (event-modifiers event))
8383 event
8384 (let ((event-type (if (symbolp event) event (car event))))
8385 (setq event-type (intern (concat prefix (symbol-name event-type))))
8386 (if (symbolp event)
8387 event-type
8388 (cons event-type (cdr event)))))))
8390 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8391 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8392 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8393 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8394 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8395 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8396 \f
8397 ;;;; Keypad support.
8399 ;; Make the keypad keys act like ordinary typing keys. If people add
8400 ;; bindings for the function key symbols, then those bindings will
8401 ;; override these, so this shouldn't interfere with any existing
8402 ;; bindings.
8404 ;; Also tell read-char how to handle these keys.
8405 (mapc
8406 (lambda (keypad-normal)
8407 (let ((keypad (nth 0 keypad-normal))
8408 (normal (nth 1 keypad-normal)))
8409 (put keypad 'ascii-character normal)
8410 (define-key function-key-map (vector keypad) (vector normal))))
8411 ;; See also kp-keys bound in bindings.el.
8412 '((kp-space ?\s)
8415 (kp-separator ?,)
8416 (kp-equal ?=)
8417 ;; Do the same for various keys that are represented as symbols under
8418 ;; GUIs but naturally correspond to characters.
8419 (backspace 127)
8420 (delete 127)
8423 (clear ?\C-l)
8424 (return ?\C-m)
8425 (escape ?\e)
8426 ))
8427 \f
8428 ;;;;
8429 ;;;; forking a twin copy of a buffer.
8430 ;;;;
8432 (defvar clone-buffer-hook nil
8433 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8435 (defvar clone-indirect-buffer-hook nil
8436 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8438 (defun clone-process (process &optional newname)
8439 "Create a twin copy of PROCESS.
8440 If NEWNAME is nil, it defaults to PROCESS' name;
8441 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8442 If PROCESS is associated with a buffer, the new process will be associated
8443 with the current buffer instead.
8444 Returns nil if PROCESS has already terminated."
8445 (setq newname (or newname (process-name process)))
8447 (setq newname (substring newname 0 (match-beginning 0))))
8448 (when (memq (process-status process) '(run stop open))
8449 (let* ((process-connection-type (process-tty-name process))
8450 (new-process
8451 (if (memq (process-status process) '(open))
8452 (let ((args (process-contact process t)))
8453 (setq args (plist-put args :name newname))
8454 (setq args (plist-put args :buffer
8455 (if (process-buffer process)
8456 (current-buffer))))
8457 (apply 'make-network-process args))
8458 (apply 'start-process newname
8459 (if (process-buffer process) (current-buffer))
8460 (process-command process)))))
8461 (set-process-query-on-exit-flag
8462 new-process (process-query-on-exit-flag process))
8463 (set-process-inherit-coding-system-flag
8464 new-process (process-inherit-coding-system-flag process))
8465 (set-process-filter new-process (process-filter process))
8466 (set-process-sentinel new-process (process-sentinel process))
8467 (set-process-plist new-process (copy-sequence (process-plist process)))
8468 new-process)))
8470 ;; things to maybe add (currently partly covered by `funcall mode'):
8471 ;; - syntax-table
8472 ;; - overlays
8473 (defun clone-buffer (&optional newname display-flag)
8474 "Create and return a twin copy of the current buffer.
8475 Unlike an indirect buffer, the new buffer can be edited
8476 independently of the old one (if it is not read-only).
8477 NEWNAME is the name of the new buffer. It may be modified by
8478 adding or incrementing <N> at the end as necessary to create a
8479 unique buffer name. If nil, it defaults to the name of the
8480 current buffer, with the proper suffix. If DISPLAY-FLAG is
8481 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8482 clone a file-visiting buffer, or a buffer whose major mode symbol
8483 has a non-nil `no-clone' property, results in an error.
8485 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8486 current buffer with appropriate suffix. However, if a prefix
8487 argument is given, then the command prompts for NEWNAME in the
8488 minibuffer.
8490 This runs the normal hook `clone-buffer-hook' in the new buffer
8491 after it has been set up properly in other respects."
8492 (interactive
8493 (progn
8494 (if buffer-file-name
8495 (error "Cannot clone a file-visiting buffer"))
8496 (if (get major-mode 'no-clone)
8497 (error "Cannot clone a buffer in %s mode" mode-name))
8498 (list (if current-prefix-arg
8499 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8500 t)))
8501 (if buffer-file-name
8502 (error "Cannot clone a file-visiting buffer"))
8503 (if (get major-mode 'no-clone)
8504 (error "Cannot clone a buffer in %s mode" mode-name))
8505 (setq newname (or newname (buffer-name)))
8507 (setq newname (substring newname 0 (match-beginning 0))))
8508 (let ((buf (current-buffer))
8509 (ptmin (point-min))
8510 (ptmax (point-max))
8511 (pt (point))
8512 (mk (if mark-active (mark t)))
8513 (modified (buffer-modified-p))
8514 (mode major-mode)
8515 (lvars (buffer-local-variables))
8516 (process (get-buffer-process (current-buffer)))
8517 (new (generate-new-buffer (or newname (buffer-name)))))
8518 (save-restriction
8519 (widen)
8520 (with-current-buffer new
8521 (insert-buffer-substring buf)))
8522 (with-current-buffer new
8523 (narrow-to-region ptmin ptmax)
8524 (goto-char pt)
8525 (if mk (set-mark mk))
8526 (set-buffer-modified-p modified)
8528 ;; Clone the old buffer's process, if any.
8529 (when process (clone-process process))
8531 ;; Now set up the major mode.
8532 (funcall mode)
8534 ;; Set up other local variables.
8535 (mapc (lambda (v)
8536 (condition-case () ;in case var is read-only
8537 (if (symbolp v)
8538 (makunbound v)
8539 (set (make-local-variable (car v)) (cdr v)))
8540 (error nil)))
8541 lvars)
8543 ;; Run any hooks (typically set up by the major mode
8544 ;; for cloning to work properly).
8545 (run-hooks 'clone-buffer-hook))
8546 (if display-flag
8547 ;; Presumably the current buffer is shown in the selected frame, so
8548 ;; we want to display the clone elsewhere.
8549 (let ((same-window-regexps nil)
8550 (same-window-buffer-names))
8551 (pop-to-buffer new)))
8552 new))
8555 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8556 "Create an indirect buffer that is a twin copy of the current buffer.
8558 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8559 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8560 or if not called with a prefix arg, NEWNAME defaults to the current
8561 buffer's name. The name is modified by adding a `<N>' suffix to it
8562 or by incrementing the N in an existing suffix. Trying to clone a
8563 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8564 property results in an error.
8566 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8567 This is always done when called interactively.
8569 Optional third arg NORECORD non-nil means do not put this buffer at the
8570 front of the list of recently selected ones.
8572 Returns the newly created indirect buffer."
8573 (interactive
8574 (progn
8575 (if (get major-mode 'no-clone-indirect)
8576 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8577 (list (if current-prefix-arg
8578 (read-buffer "Name of indirect buffer: " (current-buffer)))
8579 t)))
8580 (if (get major-mode 'no-clone-indirect)
8581 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8582 (setq newname (or newname (buffer-name)))
8584 (setq newname (substring newname 0 (match-beginning 0))))
8585 (let* ((name (generate-new-buffer-name newname))
8586 (buffer (make-indirect-buffer (current-buffer) name t)))
8587 (with-current-buffer buffer
8588 (run-hooks 'clone-indirect-buffer-hook))
8589 (when display-flag
8590 (pop-to-buffer buffer nil norecord))
8591 buffer))
8594 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8595 "Like `clone-indirect-buffer' but display in another window."
8596 (interactive
8597 (progn
8598 (if (get major-mode 'no-clone-indirect)
8599 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8600 (list (if current-prefix-arg
8601 (read-buffer "Name of indirect buffer: " (current-buffer)))
8602 t)))
8603 (let ((pop-up-windows t))
8604 (clone-indirect-buffer newname display-flag norecord)))
8606 \f
8607 ;;; Handling of Backspace and Delete keys.
8609 (defcustom normal-erase-is-backspace 'maybe
8610 "Set the default behavior of the Delete and Backspace keys.
8612 If set to t, Delete key deletes forward and Backspace key deletes
8613 backward.
8615 If set to nil, both Delete and Backspace keys delete backward.
8617 If set to `maybe' (which is the default), Emacs automatically
8618 selects a behavior. On window systems, the behavior depends on
8619 the keyboard used. If the keyboard has both a Backspace key and
8620 a Delete key, and both are mapped to their usual meanings, the
8621 option's default value is set to t, so that Backspace can be used
8622 to delete backward, and Delete can be used to delete forward.
8624 If not running under a window system, customizing this option
8625 accomplishes a similar effect by mapping C-h, which is usually
8626 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8627 via `keyboard-translate'. The former functionality of C-h is
8628 available on the F1 key. You should probably not use this
8629 setting if you don't have both Backspace, Delete and F1 keys.
8631 Setting this variable with setq doesn't take effect. Programmatically,
8632 call `normal-erase-is-backspace-mode' (which see) instead."
8633 :type '(choice (const :tag "Off" nil)
8634 (const :tag "Maybe" maybe)
8635 (other :tag "On" t))
8636 :group 'editing-basics
8637 :version "21.1"
8638 :set (lambda (symbol value)
8639 ;; The fboundp is because of a problem with :set when
8640 ;; dumping Emacs. It doesn't really matter.
8641 (if (fboundp 'normal-erase-is-backspace-mode)
8642 (normal-erase-is-backspace-mode (or value 0))
8643 (set-default symbol value))))
8645 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8646 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8647 (unless frame (setq frame (selected-frame)))
8648 (with-selected-frame frame
8649 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8650 (normal-erase-is-backspace-mode
8651 (if (if (eq normal-erase-is-backspace 'maybe)
8652 (and (not noninteractive)
8653 (or (memq system-type '(ms-dos windows-nt))
8654 (memq window-system '(w32 ns))
8655 (and (memq window-system '(x))
8656 (fboundp 'x-backspace-delete-keys-p)
8657 (x-backspace-delete-keys-p))
8658 ;; If the terminal Emacs is running on has erase char
8659 ;; set to ^H, use the Backspace key for deleting
8660 ;; backward, and the Delete key for deleting forward.
8661 (and (null window-system)
8662 (eq tty-erase-char ?\^H))))
8663 normal-erase-is-backspace)
8664 1 0)))))
8666 (define-minor-mode normal-erase-is-backspace-mode
8667 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8668 With a prefix argument ARG, enable this feature if ARG is
8669 positive, and disable it otherwise. If called from Lisp, enable
8670 the mode if ARG is omitted or nil.
8672 On window systems, when this mode is on, Delete is mapped to C-d
8673 and Backspace is mapped to DEL; when this mode is off, both
8674 Delete and Backspace are mapped to DEL. (The remapping goes via
8675 `local-function-key-map', so binding Delete or Backspace in the
8676 global or local keymap will override that.)
8678 In addition, on window systems, the bindings of C-Delete, M-Delete,
8679 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8680 the global keymap in accordance with the functionality of Delete and
8681 Backspace. For example, if Delete is remapped to C-d, which deletes
8682 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8683 to DEL, which deletes backward, C-Delete is bound to
8684 `backward-kill-word'.
8686 If not running on a window system, a similar effect is accomplished by
8687 remapping C-h (normally produced by the Backspace key) and DEL via
8688 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8689 to C-d; if it's off, the keys are not remapped.
8691 When not running on a window system, and this mode is turned on, the
8692 former functionality of C-h is available on the F1 key. You should
8693 probably not turn on this mode on a text-only terminal if you don't
8694 have both Backspace, Delete and F1 keys.
8696 See also `normal-erase-is-backspace'."
8697 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8698 . (lambda (v)
8699 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8700 (if v 1 0))))
8701 (let ((enabled (eq 1 (terminal-parameter
8702 nil 'normal-erase-is-backspace))))
8704 (cond ((or (memq window-system '(x w32 ns pc))
8705 (memq system-type '(ms-dos windows-nt)))
8706 (let ((bindings
8707 `(([M-delete] [M-backspace])
8708 ([C-M-delete] [C-M-backspace])
8709 ([?\e C-delete] [?\e C-backspace]))))
8711 (if enabled
8712 (progn
8713 (define-key local-function-key-map [delete] [deletechar])
8714 (define-key local-function-key-map [kp-delete] [deletechar])
8715 (define-key local-function-key-map [backspace] [?\C-?])
8716 (dolist (b bindings)
8717 ;; Not sure if input-decode-map is really right, but
8718 ;; keyboard-translate-table (used below) only works
8719 ;; for integer events, and key-translation-table is
8720 ;; global (like the global-map, used earlier).
8721 (define-key input-decode-map (car b) nil)
8722 (define-key input-decode-map (cadr b) nil)))
8723 (define-key local-function-key-map [delete] [?\C-?])
8724 (define-key local-function-key-map [kp-delete] [?\C-?])
8725 (define-key local-function-key-map [backspace] [?\C-?])
8726 (dolist (b bindings)
8727 (define-key input-decode-map (car b) (cadr b))
8728 (define-key input-decode-map (cadr b) (car b))))))
8729 (t
8730 (if enabled
8731 (progn
8732 (keyboard-translate ?\C-h ?\C-?)
8733 (keyboard-translate ?\C-? ?\C-d))
8734 (keyboard-translate ?\C-h ?\C-h)
8735 (keyboard-translate ?\C-? ?\C-?))))
8737 (if (called-interactively-p 'interactive)
8738 (message "Delete key deletes %s"
8739 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8740 "forward" "backward")))))
8741 \f
8742 (defvar vis-mode-saved-buffer-invisibility-spec nil
8743 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8745 (define-minor-mode read-only-mode
8746 "Change whether the current buffer is read-only.
8747 With prefix argument ARG, make the buffer read-only if ARG is
8748 positive, otherwise make it writable. If buffer is read-only
8749 and `view-read-only' is non-nil, enter view mode.
8751 Do not call this from a Lisp program unless you really intend to
8753 possibly enabling or disabling View mode. Also, note that this
8754 command works by setting the variable `buffer-read-only', which
8755 does not affect read-only regions caused by text properties. To
8756 ignore read-only status in a Lisp program (whether due to text
8757 properties or buffer state), bind `inhibit-read-only' temporarily
8758 to a non-nil value."
8759 :variable buffer-read-only
8760 (cond
8761 ((and (not buffer-read-only) view-mode)
8762 (View-exit-and-edit)
8763 (make-local-variable 'view-read-only)
8764 (setq view-read-only t)) ; Must leave view mode.
8765 ((and buffer-read-only view-read-only
8766 ;; If view-mode is already active, `view-mode-enter' is a nop.
8767 (not view-mode)
8768 (not (eq (get major-mode 'mode-class) 'special)))
8769 (view-mode-enter))))
8771 (define-minor-mode visible-mode
8772 "Toggle making all invisible text temporarily visible (Visible mode).
8773 With a prefix argument ARG, enable Visible mode if ARG is
8774 positive, and disable it otherwise. If called from Lisp, enable
8775 the mode if ARG is omitted or nil.
8777 This mode works by saving the value of `buffer-invisibility-spec'
8778 and setting it to nil."
8779 :lighter " Vis"
8780 :group 'editing-basics
8781 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8782 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8783 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8784 (when visible-mode
8785 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8786 buffer-invisibility-spec)
8787 (setq buffer-invisibility-spec nil)))
8788 \f
8789 (defvar messages-buffer-mode-map
8790 (let ((map (make-sparse-keymap)))
8791 (set-keymap-parent map special-mode-map)
8792 (define-key map "g" nil) ; nothing to revert
8793 map))
8795 (define-derived-mode messages-buffer-mode special-mode "Messages"
8798 (defun messages-buffer ()
8800 If it does not exist, create and it switch it to `messages-buffer-mode'."
8801 (or (get-buffer "*Messages*")
8802 (with-current-buffer (get-buffer-create "*Messages*")
8803 (messages-buffer-mode)
8804 (current-buffer))))
8806 \f
8807 ;; Minibuffer prompt stuff.
8809 ;;(defun minibuffer-prompt-modification (start end)
8810 ;; (error "You cannot modify the prompt"))
8811 ;;
8812 ;;
8813 ;;(defun minibuffer-prompt-insertion (start end)
8814 ;; (let ((inhibit-modification-hooks t))
8815 ;; (delete-region start end)
8816 ;; ;; Discard undo information for the text insertion itself
8817 ;; ;; and for the text deletion.above.
8818 ;; (when (consp buffer-undo-list)
8819 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8820 ;; (message "You cannot modify the prompt")))
8821 ;;
8822 ;;
8823 ;;(setq minibuffer-prompt-properties
8824 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8825 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8827 \f
8828 ;;;; Problematic external packages.
8830 ;; rms says this should be done by specifying symbols that define
8831 ;; versions together with bad values. This is therefore not as
8832 ;; flexible as it could be. See the thread:
8833 ;; https://lists.gnu.org/r/emacs-devel/2007-08/msg00300.html
8834 (defconst bad-packages-alist
8835 ;; Not sure exactly which semantic versions have problems.
8836 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8838 "The version of `semantic' loaded does not work in Emacs 22.
8839 It can cause constant high CPU load.
8840 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8841 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8842 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8843 ;; provided the `CUA-mode' feature. Since this is no longer true,
8844 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8845 (CUA-mode t nil
8846 "CUA-mode is now part of the standard GNU Emacs distribution,
8847 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8849 You have loaded an older version of CUA-mode which does not work
8850 correctly with this version of Emacs. You should remove the old
8851 version and use the one distributed with Emacs."))
8852 "Alist of packages known to cause problems in this version of Emacs.
8853 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8854 PACKAGE is either a regular expression to match file names, or a
8855 symbol (a feature name), like for `with-eval-after-load'.
8856 SYMBOL is either the name of a string variable, or t. Upon
8857 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8858 warning using STRING as the message.")
8860 (defun bad-package-check (package)
8861 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8862 (condition-case nil
8863 (let* ((list (assoc package bad-packages-alist))
8864 (symbol (nth 1 list)))
8865 (and list
8866 (boundp symbol)
8867 (or (eq symbol t)
8868 (and (stringp (setq symbol (eval symbol)))
8869 (string-match-p (nth 2 list) symbol)))
8870 (display-warning package (nth 3 list) :warning)))
8871 (error nil)))
8873 (dolist (elem bad-packages-alist)
8874 (let ((pkg (car elem)))
8875 (with-eval-after-load pkg
8876 (bad-package-check pkg))))
8878 \f
8879 ;;; Generic dispatcher commands
8881 ;; Macro `define-alternatives' is used to create generic commands.
8882 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8883 ;; that can have different alternative implementations where choosing
8884 ;; among them is exclusively a matter of user preference.
8886 ;; (define-alternatives COMMAND) creates a new interactive command
8887 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8888 ;; Typically, the user will not need to customize this variable; packages
8889 ;; wanting to add alternative implementations should use
8890 ;;
8891 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8893 (defmacro define-alternatives (command &rest customizations)
8894 "Define the new command `COMMAND'.
8896 The argument `COMMAND' should be a symbol.
8898 Running `M-x COMMAND RET' for the first time prompts for which
8899 alternative to use and records the selected command as a custom
8900 variable.
8902 Running `C-u M-x COMMAND RET' prompts again for an alternative
8903 and overwrites the previous choice.
8905 The variable `COMMAND-alternatives' contains an alist with
8906 alternative implementations of COMMAND. `define-alternatives'
8907 does not have any effect until this variable is set.
8909 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8910 `defcustom' keywords and values to add to the declaration of
8911 `COMMAND-alternatives' (typically :group and :version)."
8912 (let* ((command-name (symbol-name command))
8913 (varalt-name (concat command-name "-alternatives"))
8914 (varalt-sym (intern varalt-name))
8915 (varimp-sym (intern (concat command-name "--implementation"))))
8916 `(progn
8918 (defcustom ,varalt-sym nil
8919 ,(format "Alist of alternative implementations for the `%s' command.
8921 Each entry must be a pair (ALTNAME . ALTFUN), where:
8922 ALTNAME - The name shown at user to describe the alternative implementation.
8923 ALTFUN - The function called to implement this alternative."
8924 command-name)
8925 :type '(alist :key-type string :value-type function)
8926 ,@customizations)
8928 (put ',varalt-sym 'definition-name ',command)
8929 (defvar ,varimp-sym nil "Internal use only.")
8931 (defun ,command (&optional arg)
8932 ,(format "Run generic command `%s'.
8933 If used for the first time, or with interactive ARG, ask the user which
8934 implementation to use for `%s'. The variable `%s'
8935 contains the list of implementations currently supported for this command."
8936 command-name command-name varalt-name)
8937 (interactive "P")
8938 (when (or arg (null ,varimp-sym))
8939 (let ((val (completing-read
8940 ,(format-message
8941 "Select implementation for command `%s': "
8942 command-name)
8943 ,varalt-sym nil t)))
8944 (unless (string-equal val "")
8945 (when (null ,varimp-sym)
8946 (message
8947 "Use C-u M-x %s RET`to select another implementation"
8948 ,command-name)
8949 (sit-for 3))
8950 (customize-save-variable ',varimp-sym
8951 (cdr (assoc-string val ,varalt-sym))))))
8952 (if ,varimp-sym
8953 (call-interactively ,varimp-sym)
8954 (message "%s" ,(format-message
8955 "No implementation selected for command `%s'"
8956 command-name)))))))
8958 \f
8959 ;;; Functions for changing capitalization that Do What I Mean
8960 (defun upcase-dwim (arg)
8961 "Upcase words in the region, if active; if not, upcase word at point.
8962 If the region is active, this function calls `upcase-region'.
8963 Otherwise, it calls `upcase-word', with prefix argument passed to it
8964 to upcase ARG words."
8965 (interactive "*p")
8966 (if (use-region-p)
8967 (upcase-region (region-beginning) (region-end))
8968 (upcase-word arg)))
8970 (defun downcase-dwim (arg)
8971 "Downcase words in the region, if active; if not, downcase word at point.
8972 If the region is active, this function calls `downcase-region'.
8973 Otherwise, it calls `downcase-word', with prefix argument passed to it
8974 to downcase ARG words."
8975 (interactive "*p")
8976 (if (use-region-p)
8977 (downcase-region (region-beginning) (region-end))
8978 (downcase-word arg)))
8980 (defun capitalize-dwim (arg)
8981 "Capitalize words in the region, if active; if not, capitalize word at point.
8982 If the region is active, this function calls `capitalize-region'.
8983 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8984 to capitalize ARG words."
8985 (interactive "*p")
8986 (if (use-region-p)
8987 (capitalize-region (region-beginning) (region-end))
8988 (capitalize-word arg)))
8990 \f
8992 (provide 'simple)
8994 ;;; simple.el ends here