| blob | fa93cf87c7aa3f3030d39c261a93920e87bce708 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2018 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "Idle time delay before updating various things on the screen.
42 Various Emacs features that update auxiliary information when point moves
43 wait this many seconds after Emacs becomes idle before doing an update."
49 "Killing and yanking commands."
53 "Highlight (un)matching of parens and expressions."
55 \f
56 ;;; next-error support framework
59 "`next-error' support framework."
65 "Face used to highlight next error locus."
70 "Highlighting of locations in selected source buffers.
71 If a number, highlight the locus in `next-error' face for the given time
72 in seconds, or until the next command is executed.
73 If t, highlight the locus until the next command is executed, or until
74 some other locus replaces it.
75 If nil, don't highlight the locus in the source buffer.
76 If `fringe-arrow', indicate the locus by the fringe arrow
77 indefinitely until some other locus replaces it."
86 "Highlighting of locations in `next-error-no-select'.
87 If number, highlight the locus in `next-error' face for given time in seconds.
88 If t, highlight the locus indefinitely until some other locus replaces it.
89 If nil, don't highlight the locus in the source buffer.
90 If `fringe-arrow', indicate the locus by the fringe arrow
91 indefinitely until some other locus replaces it."
100 "Display the line in the visited source file recentered as specified.
101 If non-nil, the value is passed directly to `recenter'."
109 "List of hook functions run by `next-error' after visiting source file."
120 "The most recent `next-error' buffer.
121 A buffer becomes most recent when its compilation, grep, or
125 ;; next-error-last-buffer is made buffer-local to keep the reference
126 ;; to the parent buffer used to navigate to the current buffer, so the
127 ;; next call of next-buffer will use the same parent buffer to
128 ;; continue navigation from it.
132 "Function to use to find the next error in the current buffer.
133 The function is called with 2 parameters:
134 ARG is an integer specifying by how many errors to move.
135 RESET is a boolean which, if non-nil, says to go back to the beginning
136 of the errors before moving.
137 Major modes providing compile-like functionality should set this variable
138 to indicate to `next-error' that this is a candidate buffer and how
143 "Function to use to move to an error locus.
144 It takes two arguments, a buffer position in the error buffer
145 and a buffer position in the error locus buffer.
146 The buffer for the error locus should already be current.
151 &optional avoid-current
152 extra-test-inclusive
153 extra-test-exclusive)
154 "Return non-nil if BUFFER is a `next-error' capable buffer.
155 If AVOID-CURRENT is non-nil, and BUFFER is the current buffer,
156 return nil.
158 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if
159 BUFFER would not normally qualify. If it returns non-nil, BUFFER
160 is considered `next-error' capable, anyway, and the function
161 returns non-nil.
163 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the
164 buffer would normally qualify. If it returns nil, BUFFER is
165 rejected, and the function returns nil."
170 ;; Optionally reject some buffers.
173 t)
174 ;; Optionally accept some other buffers.
179 "Function called to find a `next-error' capable buffer."
181 next-error-buffer-on-selected-frame)
188 extra-test-inclusive
189 extra-test-exclusive)
190 "Return a single visible next-error buffer on the selected frame."
196 avoid-current
197 extra-test-inclusive extra-test-exclusive)
204 extra-test-inclusive
205 extra-test-exclusive)
206 "Return a `next-error' capable buffer.
208 If AVOID-CURRENT is non-nil, treat the current buffer
209 as an absolute last resort only.
211 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
212 that normally would not qualify. If it returns t, the buffer
213 in question is treated as usable.
215 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
216 that would normally be considered usable. If it returns nil,
217 that buffer is rejected."
219 ;; 1. If a customizable function returns a buffer, use it.
221 extra-test-inclusive
222 extra-test-exclusive)
223 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
226 extra-test-inclusive extra-test-exclusive))
227 next-error-last-buffer)
228 ;; 3. If the current buffer is acceptable, choose it.
230 extra-test-inclusive extra-test-exclusive)
232 ;; 4. Look for any acceptable buffer.
237 extra-test-inclusive extra-test-exclusive)))
240 ;; 5. Use the current buffer as a last resort if it qualifies,
241 ;; even despite AVOID-CURRENT.
244 extra-test-inclusive extra-test-exclusive)
248 ;; 6. Give up.
252 "Visit next `next-error' message and corresponding source code.
254 If all the error messages parsed so far have been processed already,
255 the message buffer is checked for new ones.
257 A prefix ARG specifies how many error messages to move;
258 negative means move back to previous error messages.
260 and start at the first error.
262 The RESET argument specifies that we should restart from the beginning.
265 compilation, grep, or occur buffer. It can also operate on any
267 more generally, on any buffer in Compilation mode or with
268 Compilation Minor mode enabled, or any buffer in which
269 `next-error-function' is bound to an appropriate function.
270 To specify use of a particular buffer for error messages, type
272 in the current frame.
275 runs `next-error-hook' with `run-hooks', and stays with that buffer
276 until you use it in some other buffer which uses Compilation mode
277 or Compilation Minor mode.
279 To control which errors are matched, customize the variable
280 `compilation-error-regexp-alist'."
285 ;; We know here that next-error-function is a valid symbol we can funcall
287 ;; Allow next-error to be used from the next-error capable buffer.
290 ;; Override possible change of next-error-last-buffer in next-error-function
300 next-error-last-buffer)
304 "Visit the source code corresponding to the `next-error' message at point."
306 ;; We know here that next-error-function is a valid symbol we can funcall
308 ;; Allow next-error to be used from the next-error capable buffer.
311 ;; Override possible change of next-error-last-buffer in next-error-function
320 "Select a `next-error' capable buffer and set it as the last used."
332 "Visit previous `next-error' message and corresponding source code.
334 Prefix arg N says how many error messages to move backwards (or
335 forwards, if negative).
342 "Restart at the first error.
343 Visit corresponding source code.
344 With prefix arg N, visit the source code of the Nth error.
350 "Move point to the next error in the `next-error' buffer and highlight match.
351 Prefix arg N says how many error messages to move forwards (or
352 backwards, if negative).
354 select the source buffer."
361 "Move point to the previous error in the `next-error' buffer and highlight match.
362 Prefix arg N says how many error messages to move backwards (or
363 forwards, if negative).
365 select the source buffer."
369 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
373 "Minor mode for compilation, occur and diff modes.
374 With a prefix argument ARG, enable mode if ARG is positive, and
375 disable it otherwise. If called from Lisp, enable mode if ARG is
376 omitted or nil.
377 When turned on, cursor motion in the compilation, grep, occur or diff
378 buffer causes automatic display of the corresponding source code location."
385 ;; Used as a `post-command-hook' by `next-error-follow-mode'
386 ;; for the *Compilation* *grep* and *Occur* buffers.
396 \f
397 ;;;
400 "Major mode not specialized for anything in particular.
401 Other major modes are defined by comparison with this one."
406 ;; Special major modes to view specially formatted data rather than files.
420 map))
424 "Parent major mode from which special major modes should inherit."
427 ;; Making and deleting lines.
430 "Special hook to tell if `self-insert-command' will use the region.
431 It must be called via `run-hook-with-args-until-success' with no arguments.
433 If any function on this hook returns a non-nil value, `delete-selection-mode'
434 will act on that value (see `delete-selection-helper'), and will
435 usually delete the region. If all the functions on this hook return
436 nil, it is an indiction that `self-insert-command' needs the region
437 untouched by `delete-selection-mode', and will itself do whatever is
438 appropriate with the region.
439 Any function on `post-self-insert-hook' which act on the region should
440 add a function to this hook so that `delete-selection-mode' could
441 refrain from deleting the region before `post-self-insert-hook'
442 functions are called.
449 "Insert a newline, and move to left margin of the new line if it's blank.
450 If option `use-hard-newlines' is non-nil, the newline is marked with the
451 text-property `hard'.
452 With ARG, insert that many newlines.
454 If `electric-indent-mode' is enabled, this indents the final new line
455 that it adds, and reindents the preceding line. To just insert
458 Calls `auto-fill-function' if the current column number is greater
459 than the value of `fill-column' and ARG is nil.
460 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
463 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
464 ;; Set last-command-event to tell self-insert what to insert.
468 ;; Don't auto-fill if we have a numeric argument.
472 ;; Do the rest in post-self-insert-hook, because we want to do it
473 ;; *before* other functions on that hook.
475 ;; Mark the newline(s) `hard'.
479 ;; If the newline leaves the previous line blank, and we
480 ;; have a left margin, delete that from the blank line.
488 ;; Indent the line after the newline, except in one case:
489 ;; when we added the newline at the beginning of a line which
490 ;; starts a page.
494 ;; FIXME: For non-interactive uses, many calls actually
495 ;; just want (insert "\n"), so maybe we should do just
496 ;; that, so as to avoid the risk of filling or running
497 ;; abbrevs unexpectedly.
504 ;; We first used let-binding to protect the hook, but that
505 ;; was naive since add-hook affects the symbol-default
506 ;; value of the variable, whereas the let-binding might
507 ;; only protect the buffer-local value.
509 nil)
514 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
520 "Insert a newline and leave point before it.
521 If there is a fill prefix and/or a `left-margin', insert them on
522 the new line if the line would have been blank.
523 With arg N, insert N newlines."
528 ;; Don't expand an abbrev before point.
539 ;; Necessary in case a margin or prefix was inserted.
543 "Split current line, moving portion beyond point vertically down.
544 If the current line starts with `fill-prefix', insert it on the new
545 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
547 When called from Lisp code, ARG may be a prefix string to copy."
552 ;; What prefix should we check for (nil means don't).
556 ;; Does this line start with it?
567 "Join this line to previous and fix up whitespace at join.
568 If there is a fill prefix, delete it from the beginning of this line.
569 With argument, join this line to following line."
576 ;; If the second line started with the fill prefix,
577 ;; delete the prefix.
589 "On blank line, delete all surrounding blank lines, leaving just one.
590 On isolated blank line, delete that one.
591 On nonblank line, delete any immediately following blank lines."
597 ;; Set singleblank if there is just one blank line here.
604 ;; Delete preceding blank lines, and this one too if it's the only one.
613 ;; Delete following blank lines, unless the current line is blank
614 ;; and there are no following blank lines.
623 ;; Handle the special case where point is followed by newline and eob.
624 ;; Delete the line, leaving point at eob.
630 Trailing lines are deleted only if `delete-trailing-whitespace'
631 is called on the entire buffer (rather than an active region)."
637 "Return non-nil if the region contains no read-only text."
642 "Delete trailing whitespace between START and END.
643 If called interactively, START and END are the start/end of the
644 region if the mark is active, or of the buffer's accessible
645 portion if the mark is inactive.
647 This command deletes whitespace characters after the last
648 non-whitespace character in each line between START and END. It
649 does not consider formfeed characters to be whitespace.
651 If this command acts on the entire buffer (i.e. if called
652 interactively with the mark inactive, or called from Lisp with
653 END nil), it also deletes all trailing lines at the end of the
654 buffer if the variable `delete-trailing-lines' is non-nil."
665 ;; Don't delete formfeeds, even if they are considered whitespace.
674 ;; Delete trailing empty lines.
676 ;; Really the end of buffer.
681 ;; Return nil for the benefit of `write-file-functions'.
682 nil)
685 "Insert a newline, then indent according to major mode.
686 Indentation is done using the value of `indent-line-function'.
687 In programming language modes, this is the same as TAB.
688 In some text modes, where TAB inserts a tab, this command indents to the
689 column specified by the function `current-left-margin'."
696 "Reindent current line, insert newline, then indent the new line.
697 Indentation of both lines is done according to the current major mode,
698 which means calling the current value of `indent-line-function'.
699 In programming language modes, this is the same as TAB.
700 In some text modes, where TAB inserts a tab, this indents to the
701 column specified by the function `current-left-margin'."
704 ;; Be careful to insert the newline before indenting the line.
705 ;; Otherwise, the indentation might be wrong.
709 ;; We are at EOL before the call to indent-according-to-mode, and
710 ;; after it we usually are as well, but not always. We tried to
711 ;; address it with `save-excursion' but that uses a normal marker
712 ;; whereas we need `move after insertion', so we do the save/restore
713 ;; by hand.
717 ;; Remove the trailing white-space after indentation because
718 ;; indentation may introduce the whitespace.
724 Legitimate radix values are 8, 10 and 16."
729 "Like `read-char', but do not allow quitting.
730 Also, if the first character read is an octal digit,
731 we read any number of octal digits and return the
732 specified character code. Any nondigit terminates the sequence.
733 If the terminator is RET, it is discarded;
734 any other terminator is used itself as input.
736 The optional argument PROMPT specifies a string to use to prompt the user.
737 The variable `read-quoted-char-radix' controls which radix to use
738 for numeric input."
741 help-event-list)))
745 ;; Don't let C-h or other help chars get the help
746 ;; message--only help function keys. See bug#16617.
750 "Type the special character you want to use,
751 or the octal character code.
752 RET terminates the character code and is discarded;
756 ;; Translate TAB key into control-I ASCII character, and so on.
757 ;; Note: `read-char' does it using the `ascii-character' property.
758 ;; We tried using read-key instead, but that disables the keystroke
759 ;; echo produced by 'C-q', see bug#24635.
763 char)))
769 done t))
771 ;; Turn a meta-character into a character with the 0200 bit set.
773 done t))
788 done t))
790 done t)))
792 code))
795 "Read next input character and insert it.
796 This is useful for inserting control characters.
797 With argument, insert ARG copies of the character.
799 If the first character you type after this command is an octal digit,
800 you should type a sequence of octal digits which specify a character code.
801 Any nondigit terminates the sequence. If the terminator is a RET,
802 it is discarded; any other terminator is used itself as input.
803 The variable `read-quoted-char-radix' specifies the radix for this feature;
804 set it to 10 or 16 to use decimal or hex instead of octal.
806 In overwrite mode, this function inserts the character anyway, and
807 does not handle octal digits specially. This means that if you use
808 overwrite as your normal editing mode, you can use this function to
809 insert characters when necessary.
811 In binary overwrite mode, this function does overwrite, and octal
812 digits are interpreted as a character code. This is intended to be
813 useful for editing binary files."
816 ;; Avoid "obsolete" warnings for translation-table-for-input.
823 ;; This used to assume character codes 0240 - 0377 stand for
824 ;; characters in some single-byte character set, and converted them
825 ;; to Emacs characters. But in 23.1 this feature is deprecated
826 ;; in favor of inserting the corresponding Unicode characters.
827 ;; (if (and enable-multibyte-characters
828 ;; (>= char ?\240)
829 ;; (<= char ?\377))
830 ;; (setq char (unibyte-char-to-multibyte char)))
842 "Move forward ARG lines and position at first nonblank character."
848 "Move backward ARG lines and position at first nonblank character."
854 "Move point to the first non-whitespace character on this line."
858 ;; Move back over chars that have whitespace syntax but have the p flag.
862 "Fixup white space between objects around point.
863 Leave one space or none, according to the context."
870 nil
874 "Delete all spaces and tabs around point.
875 If BACKWARD-ONLY is non-nil, only delete them before point."
880 orig-pos
889 "Delete all spaces and tabs around point, leaving one space (or N spaces).
890 If N is negative, delete newlines as well, leaving -N spaces.
891 See also `cycle-spacing'."
896 "Store context used in consecutive calls to `cycle-spacing' command.
897 The first time `cycle-spacing' runs, it saves in this variable:
898 its N argument, the original point position, and the original spacing
902 "Manipulate whitespace around point in a smart way.
903 In interactive use, this function behaves differently in successive
904 consecutive calls.
906 The first call in a sequence acts like `just-one-space'.
907 It deletes all spaces and tabs around point, leaving one space
908 \(or N spaces). N is the prefix argument. If N is negative,
909 it deletes newlines as well, leaving -N spaces.
910 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
912 The second call in a sequence deletes all spaces.
914 The third call in a sequence restores the original whitespace (and point).
916 If MODE is `single-shot', it only performs the first step in the sequence.
917 If MODE is `fast' and the first step would not result in any change
918 \(i.e., there are exactly (abs N) spaces around point),
919 the function goes straight to the second step.
921 Repeatedly calling the function with different values of N starts a
922 new sequence each time."
930 ;; Command run for the first time, single-shot mode or different argument
942 ;; Special handling for case where there was no space at all.
945 ;; If this run causes no change in buffer content, delete all spaces,
946 ;; otherwise delete all excess spaces.
951 ;; Command run for the second time.
955 ;; Command run for the third time.
960 \f
962 "Move point to the beginning of the buffer.
963 With numeric arg N, put point N/10 of the way from the beginning.
964 If the buffer is narrowed, this command uses the beginning of the
965 accessible part of the buffer.
968 is supplied, or Transient Mark mode is enabled and the mark is active."
978 ;; Avoid overflow for large buffer sizes!
986 "Move point to the end of the buffer.
987 With numeric arg N, put point N/10 of the way from the end.
988 If the buffer is narrowed, this command uses the end of the
989 accessible part of the buffer.
992 is supplied, or Transient Mark mode is enabled and the mark is active."
1000 ;; Avoid overflow for large buffer sizes!
1005 ;; If we went to a place in the middle of the buffer,
1006 ;; adjust it to the beginning of a line.
1010 ;; If the end of the buffer is not already on the screen,
1011 ;; then scroll specially to put it near, but not at, the bottom.
1016 "Whether single-char deletion commands delete an active region.
1017 This has an effect only if Transient Mark mode is enabled, and
1018 affects `delete-forward-char' and `delete-backward-char', though
1019 not `delete-char'.
1021 If the value is the symbol `kill', the active region is killed
1022 instead of deleted."
1039 "Function to get the region's content.
1040 Called with one argument METHOD.
1041 If METHOD is `delete-only', then delete the region; the return value
1042 is undefined. If METHOD is nil, then return the content as a string.
1043 If METHOD is `bounds', then return the boundaries of the region
1044 as a list of cons cells of the form (START . END).
1045 If METHOD is anything else, delete the region and return its content
1046 as a string, after filtering it with `filter-buffer-substring', which
1057 first nil))))
1058 "Function to insert the region's content.
1059 Called with one argument LINES.
1063 "Delete the previous N characters (following if N is negative).
1064 If Transient Mark mode is enabled, the mark is active, and N is 1,
1065 delete the text in the region and deactivate the mark instead.
1066 To disable this, set option `delete-active-region' to nil.
1068 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1069 kill ring) instead of delete. Interactively, N is the prefix
1070 arg, and KILLFLAG is set if N is explicitly specified.
1072 When killing, the killed text is filtered by
1073 `filter-buffer-substring' before it is saved in the kill ring, so
1074 the actual saved text might be different from what was killed.
1076 In Overwrite mode, single character backward deletion may replace
1077 tabs with spaces so as to back over columns, unless point is at
1078 the end of the line."
1084 delete-active-region
1086 ;; If a region is active, kill or delete it.
1090 ;; In Overwrite mode, maybe untabify while deleting
1100 ;; Otherwise, do simple deletion.
1104 "Delete the following N characters (previous if N is negative).
1105 If Transient Mark mode is enabled, the mark is active, and N is 1,
1106 delete the text in the region and deactivate the mark instead.
1107 To disable this, set variable `delete-active-region' to nil.
1109 Optional second arg KILLFLAG non-nil means to kill (save in kill
1110 ring) instead of delete. Interactively, N is the prefix arg, and
1111 KILLFLAG is set if N was explicitly specified.
1113 When killing, the killed text is filtered by
1114 `filter-buffer-substring' before it is saved in the kill ring, so
1115 the actual saved text might be different from what was killed."
1121 delete-active-region
1123 ;; If a region is active, kill or delete it.
1128 ;; Otherwise, do simple deletion.
1132 "Put point at beginning and mark at end of buffer.
1133 Also push mark at point before pushing mark at end of buffer.
1134 If narrowing is in effect, only uses the accessible part of the buffer.
1135 You probably should not use this function in Lisp programs;
1136 it is usually a mistake for a Lisp function to use any subroutine
1137 that uses or sets the mark."
1142 ;; This is really `point-min' in most cases, but if we're in the
1143 ;; minibuffer, this is at the end of the prompt.
1145 \f
1147 ;; Counting lines, one way or another.
1150 "Go to LINE, counting from line 1 at beginning of buffer.
1151 If called interactively, a numeric prefix argument specifies
1152 LINE; without a numeric prefix argument, read LINE from the
1153 minibuffer.
1155 If optional argument BUFFER is non-nil, switch to that buffer and
1157 as argument, BUFFER is the most recently selected other buffer.
1159 Prior to moving point, this function sets the mark (without
1160 activating it), unless Transient Mark mode is enabled and the
1161 mark is already active.
1163 This function is usually the wrong thing to use in a Lisp program.
1164 What you probably want instead is something like:
1165 (goto-char (point-min))
1166 (forward-line (1- N))
1167 If at all possible, an even better solution is to use char counts
1168 rather than line counts."
1173 ;; Look for a default, a number in the buffer at point.
1183 ;; Decide if we're switching buffers.
1191 ;; Read the argument, offering that number (if any) as default.
1194 buffer))))
1195 ;; Switch to the desired buffer, one way or another.
1200 ;; Leave mark at previous position
1202 ;; Move to the specified line number in that buffer.
1211 "Count the number of words in the region.
1212 If called interactively, print a message reporting the number of
1213 lines, words, and characters in the region (whether or not the
1214 region is active); with prefix ARG, report for the entire buffer
1215 rather than the region.
1217 If called from Lisp, return the number of words between positions
1218 START and END."
1230 "Count words between START and END.
1231 If called interactively, START and END are normally the start and
1232 end of the buffer; but if the region is active, START and END are
1233 the start and end of the region. Print a message reporting the
1234 number of lines, words, and chars.
1236 If called from Lisp, return the number of words between START and
1237 END, without printing any message."
1247 words))
1263 str
1271 "Print the current buffer line number and narrowed line number of point."
1284 "Return number of lines between START and END.
1285 This is usually the number of newlines between them,
1286 but can be one more if START is not equal to END
1287 and the greater of them is not at the start of a line."
1303 done)))
1307 "Return buffer line number at position POS.
1308 If POS is nil, use current buffer location.
1310 If ABSOLUTE is nil, the default, counting starts
1311 at (point-min), so the value refers to the contents of the
1312 accessible portion of the (potentially narrowed) buffer. If
1313 ABSOLUTE is non-nil, ignore any narrowing and return the
1314 absolute line number."
1327 "Print info on cursor position (on screen and within buffer).
1328 Also describe the character after point, and give its character code
1329 in octal, decimal and hex.
1331 For a non-ASCII multibyte character, also give its encoding in the
1332 buffer's selected coding system if the coding system encodes the
1333 character safely. If the character is encoded into one byte, that
1334 code is shown in hex. If the character is encoded into more than one
1337 In addition, with prefix argument, show details about that character
1338 in *Help* buffer. See also the command `describe-char'."
1342 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1343 ;; start a directional embedding, which could completely
1344 ;; disrupt the rest of the line (e.g., RLO will display the
1345 ;; rest of the line right-to-left). So we put an invisible
1346 ;; PDF character after these characters, to end the
1347 ;; embedding, which eliminates any effects on the rest of
1348 ;; the line. For RLE and RLO we also append an invisible
1349 ;; LRM, to avoid reordering the following numerical
1350 ;; characters. For LRI/RLI/FSI we append a PDI.
1357 ;; Strong right-to-left characters cause reordering of
1358 ;; the following numerical characters which show the
1359 ;; codepoint, so append LRM to countermand that.
1370 ""
1376 pos total percent beg end col hscroll)
1378 pos total col hscroll))
1380 encoded encoding-msg display-prop under-display)
1387 ;; Check if the character is displayed with some `display'
1388 ;; text property. In that case, set under-display to the
1389 ;; buffer substring covered by that property.
1400 under-display)))
1406 char char char under-display)
1408 char char char under-display display-prop))
1411 char char char
1413 "..."
1417 ;; We show the detailed information about CHAR.
1424 bidi-fixer
1425 encoding-msg pos total percent beg end col hscroll)
1432 bidi-fixer encoding-msg pos total percent col hscroll))))))
1433 \f
1434 ;; Initialize read-expression-map. It is defined at C level.
1438 ;; Might as well bind TAB to completion, since inserting a TAB char is
1439 ;; much too rarely useful.
1442 m))
1445 "Return a Lisp object read using the minibuffer, unevaluated.
1446 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1447 is a string to insert in the minibuffer before reading.
1448 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1449 Such arguments are used as in `read-from-minibuffer'.)"
1450 ;; Used for interactive spec `x'.
1455 "Return value of Lisp expression read using the minibuffer.
1456 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1457 is a string to insert in the minibuffer before reading.
1458 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1459 Such arguments are used as in `read-from-minibuffer'.)"
1460 ;; Used for interactive spec `X'.
1468 "The current default value or list of default values in the minibuffer.
1469 The functions `read-from-minibuffer' and `completing-read' bind
1473 "Value for `print-level' while printing value in `eval-expression'.
1474 A value of nil means no limit."
1480 "Value for `print-length' while printing value in `eval-expression'.
1481 A value of nil means no limit."
1487 "If non-nil set `debug-on-error' to t in `eval-expression'.
1488 If nil, don't change the value of `debug-on-error'."
1494 "The largest integer that will be displayed as a character.
1495 This affects printing by `eval-expression' (via
1496 `eval-expression-print-format')."
1502 "If VALUE in an integer, return a specially formatted string.
1504 If VALUE is not an integer, nil is returned.
1505 This function is used by commands like `eval-expression' that
1506 display the result of expression evaluation."
1524 ;; FIXME: call emacs-lisp-mode?
1532 read-expression-map t
1536 "Get arguments for commands that print an expression result.
1537 Returns a list (INSERT-VALUE NO-TRUNCATE CHAR-PRINT-LIMIT)
1538 based on PREFIX-ARG. This function determines the interpretation
1539 of the prefix argument for `eval-expression' and
1540 `eval-last-sexp'."
1548 ;; We define this, rather than making `eval' interactive,
1549 ;; for the sake of completion of names like eval-region, eval-buffer.
1551 "Evaluate EXP and print value in the echo area.
1552 When called interactively, read an Emacs Lisp expression and
1553 evaluate it. Value is also consed on to front of the variable
1554 `values'. Optional argument INSERT-VALUE non-nil (interactively,
1555 with a non `-' prefix argument) means insert the result into the
1556 current buffer instead of printing it in the echo area.
1558 Normally, this function truncates long output according to the
1559 value of the variables `eval-expression-print-length' and
1560 `eval-expression-print-level'. When NO-TRUNCATE is
1561 non-nil (interactively, with a prefix argument of zero), however,
1562 there is no such truncation.
1564 If the resulting value is an integer, and CHAR-PRINT-LIMIT is
1565 non-nil (interactively, unless given a positive prefix argument)
1566 it will be printed in several additional formats (octal,
1567 hexadecimal, and character). The character format is only used
1568 if the value is below CHAR-PRINT-LIMIT (interactively, if the
1569 prefix argument is -1 or the value is below
1570 `eval-expression-print-maximum-character').
1572 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1573 minibuffer.
1575 If `eval-expression-debug-on-error' is non-nil, which is the default,
1576 this command arranges for all errors to enter the debugger."
1584 ;; Bind debug-on-error to something unique so that we can
1585 ;; detect when evalled code changes it.
1589 ;; If evalled code has changed the value of debug-on-error,
1590 ;; propagate that change to the global binding.
1606 "Prompting with PROMPT, let user edit COMMAND and eval result.
1607 COMMAND is a Lisp expression. Let user edit that expression in
1608 the minibuffer, then read and evaluate the result."
1615 read-expression-map t
1617 ;; If command was added to command-history as a string,
1618 ;; get rid of that. We want only evaluable expressions there.
1622 ;; If command to be redone does not match front of history,
1623 ;; add it to the history.
1629 "Edit and re-evaluate last complex command, or ARGth from last.
1630 A complex command is one which used the minibuffer.
1631 The command is placed in the minibuffer as a Lisp form for editing.
1632 The result is executed, repeating the command as changed.
1633 If the command has been changed or is not the most recent previous
1634 command it is added to the front of the command history.
1635 You can use the minibuffer history commands \
1637 to get different commands to edit and resubmit."
1640 newcmd)
1652 ;; If command was added to command-history as a
1653 ;; string, get rid of that. We want only
1654 ;; evaluable expressions there.
1658 ;; If command to be redone does not match front of history,
1659 ;; add it to the history.
1674 "Read command name to invoke in `execute-extended-command'."
1684 ;; Get a command name at point in the original buffer
1685 ;; to propose it after M-n.
1689 ;; Read a string, completing from and restricting to the set of
1690 ;; all defined commands. Don't provide any initial input.
1691 ;; Save the command read on the extended-command history list.
1702 ;; This isn't strictly correct if `execute-extended-command'
1703 ;; is bound to anything else (e.g. [menu]).
1704 ;; It could use (key-description (this-single-command-keys)),
1705 ;; but actually a prompt other than "M-x" would be confusing,
1706 ;; because "M-x" is a well-known prompt to read a command
1707 ;; and it serves as a shorthand for "Extended command: ".
1712 ;; Exclude obsolete commands from completions.
1717 pred)))
1722 "Non-nil means show the equivalent key-binding when M-x command has one.
1723 The value can be a length of time to show the message for.
1724 If the value is non-nil and not a number, we wait 2 seconds."
1731 "If non-nil, show a shorter M-x invocation when there is one."
1752 binding)
1758 name len)))
1759 ;; Don't show the help message if the binding isn't
1760 ;; significantly shorter than the M-x command the user typed.
1768 binding))
1771 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1772 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1773 "Read a command name, then read the arguments and call the command.
1774 To pass a prefix argument to the command you are
1775 invoking, give a prefix argument to `execute-extended-command'."
1777 ;; FIXME: Remember the actual text typed by the user before completion,
1778 ;; so that we don't later on suggest the same shortening.
1783 execute-extended-command--last-typed)))
1784 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1796 ;; Some features, such as novice.el, rely on this-command-keys
1797 ;; including M-x COMMAND-NAME RET.
1800 ;; Normally `real-this-command' should never be changed, but here we really
1801 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1802 ;; binding" for <cmd>, so the command the user really wanted to run is
1803 ;; `function' and not `execute-extended-command'. The difference is
1804 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1808 ;; If enabled, show which key runs this command.
1809 ;; But first wait, and skip the message if there is input.
1811 ;; If this command displayed something in the echo area;
1812 ;; wait a few seconds, then display our suggestion message.
1813 ;; FIXME: Wait *after* running post-command-hook!
1814 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1815 ;; find a better answer anyway!
1825 ;; There's no binding for CMD. Let's try and find the shortest
1826 ;; string to use in M-x.
1827 ;; FIXME: Can be slow. Cache it maybe?
1834 function
1839 suggest-key-bindings
1843 ;; BEWARE: Called directly from the C code.
1844 "Execute CMD as an editor command.
1845 CMD must be a symbol that satisfies the `commandp' predicate.
1846 Optional second arg RECORD-FLAG non-nil
1847 means unconditionally put this command in the variable `command-history'.
1848 Otherwise, that is done only if an arg is read using the minibuffer.
1849 The argument KEYS specifies the value to use instead of (this-command-keys)
1850 when reading the arguments; if it is nil, (this-command-keys) is used.
1851 The argument SPECIAL, if non-nil, means that this command is executing
1852 a special event, so ignore the prefix argument and don't clear it."
1855 ;; FIXME: This should probably be done around
1856 ;; pre-command-hook rather than here!
1864 disabled-command-function)
1865 ;; FIXME: Weird calling convention!
1875 ;; If requested, place the macro in the command history. For
1876 ;; other sorts of commands, call-interactively takes care of this.
1879 ;; Don't keep command history around forever.
1885 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1893 \f
1895 "Default minibuffer history list.
1896 This is used for all minibuffer input
1897 except when an alternate history list is specified.
1899 Maximum length of the history list is determined by the value
1902 "Control whether history list elements are expressions or strings.
1903 If the value of this variable equals current minibuffer depth,
1904 they are expressions; otherwise they are strings.
1905 \(That convention is designed to do the right thing for
1912 "Text that was in this minibuffer before any history commands.
1913 This is nil if there have not yet been any history commands
1922 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1927 "Minibuffer history variables for which matching should ignore case.
1928 If a history variable is a member of this list, then the
1930 commands ignore case when searching it, regardless of `case-fold-search'."
1935 "Find the previous history element that matches REGEXP.
1936 \(Previous history elements refer to earlier actions.)
1937 With prefix argument N, search for Nth previous match.
1938 If N is negative, find the next or Nth next match.
1939 Normally, history elements are matched case-insensitively if
1940 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1941 makes the search case-sensitive.
1942 See also `minibuffer-history-case-insensitive-variables'."
1946 nil
1947 minibuffer-local-map
1948 nil
1949 'minibuffer-history-search-history
1951 ;; Use the last regexp specified, by default, if input is empty.
1956 regexp)
1966 ;; On some systems, ignore case for file names.
1968 minibuffer-history-case-insensitive-variables)
1969 t
1970 ;; Respect the user's setting for case-fold-search:
1971 case-fold-search)
1972 nil))
1973 prevpos
1974 match-string
1975 match-offset
1982 "No later matching history item"
2003 next-matching-history-element))
2007 "Find the next history element that matches REGEXP.
2008 \(The next history element refers to a more recent action.)
2009 With prefix argument N, search for Nth next match.
2010 If N is negative, find the previous or Nth previous match.
2011 Normally, history elements are matched case-insensitively if
2012 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
2013 makes the search case-sensitive."
2017 nil
2018 minibuffer-local-map
2019 nil
2020 'minibuffer-history-search-history
2022 ;; Use the last regexp specified, by default, if input is empty.
2027 regexp)
2034 "Function run by `goto-history-element' before consuming default values.
2035 This is useful to dynamically add more elements to the list of default values
2036 when `goto-history-element' reaches the end of this list.
2037 Before calling this function `goto-history-element' sets the variable
2038 `minibuffer-default-add-done' to t, so it will call this function only
2039 once. In special cases, when this function needs to be called more
2040 than once, it can set `minibuffer-default-add-done' to nil explicitly,
2044 "When nil, add more elements to the end of the list of default values.
2045 The value nil causes `goto-history-element' to add more elements to
2046 the list of defaults when it reaches the end of this list. It does
2052 "Return a list of all completions without the default value.
2053 This function is used to add all elements of the completion table to
2054 the end of the list of defaults just after the default value."
2057 minibuffer-completion-table
2058 minibuffer-completion-predicate)))
2064 "Puts element of the minibuffer history in the minibuffer.
2065 The argument NABS specifies the absolute history position."
2079 elt minibuffer-returned-to-present)
2086 "End of defaults; no next item"
2093 previous-history-element))
2105 minibuffer-default)))
2117 elt))
2121 "Puts next element of the minibuffer history in the minibuffer.
2122 With argument N, it uses the Nth following element."
2128 "Puts previous element of the minibuffer history in the minibuffer.
2129 With argument N, it uses the Nth previous element."
2135 "Move cursor vertically down ARG lines, or to the next history element.
2136 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2137 next element of the minibuffer history in the minibuffer."
2141 ;; Don't add newlines if they have the mode enabled globally.
2143 ;; Remember the original goal column of possibly multi-line input
2144 ;; excluding the length of the prompt on the first line.
2154 ;; Restore old position since `line-move-visual' moves point to
2155 ;; the end of the line when it fails to go to the next line.
2158 ;; Reset `temporary-goal-column' because a correct value is not
2159 ;; calculated when `next-line' above fails by bumping against
2160 ;; the bottom of the minibuffer (bug#22544).
2162 ;; Restore the original goal column on the last line
2163 ;; of possibly multi-line input.
2171 "Move cursor vertically up ARG lines, or to the previous history element.
2172 When point moves over the top line of multi-line minibuffer, puts ARGth
2173 previous element of the minibuffer history in the minibuffer."
2177 ;; Remember the original goal column of possibly multi-line input
2178 ;; excluding the length of the prompt on the first line.
2188 ;; Restore old position since `line-move-visual' moves point to
2189 ;; the beginning of the line when it fails to go to the previous line.
2192 ;; Reset `temporary-goal-column' because a correct value is not
2193 ;; calculated when `previous-line' above fails by bumping against
2194 ;; the top of the minibuffer (bug#22544).
2196 ;; Restore the original goal column on the first line
2197 ;; of possibly multi-line input.
2203 ;; Put the cursor at the end of the visual line instead of the
2204 ;; logical line, so the next `previous-line-or-history-element'
2205 ;; would move to the previous history element, not to a possible upper
2206 ;; visual line from the end of logical line in `line-move-visual' mode.
2208 ;; Since `end-of-visual-line' puts the cursor at the beginning
2209 ;; of the next visual line, move it one char back to the end
2210 ;; of the first visual line (bug#22544).
2214 "Get next history element which completes the minibuffer before the point.
2215 The contents of the minibuffer after the point are deleted, and replaced
2216 by the new completion."
2222 n)
2223 ;; next-matching-history-element always puts us at (point-min).
2224 ;; Move to the position we were at before changing the buffer contents.
2225 ;; This is still sensible, because the text before point has not changed.
2229 "\
2230 Get previous history element which completes the minibuffer before the point.
2231 The contents of the minibuffer after the point are deleted, and replaced
2232 by the new completion."
2236 ;; For compatibility with the old subr of the same name.
2238 "Return the display width of the minibuffer prompt.
2239 Return 0 if current buffer is not a minibuffer."
2240 ;; Return the width of everything before the field at the end of
2241 ;; the buffer; this should be 0 for normal buffers.
2243 \f
2244 ;; isearch minibuffer history
2251 "Set up a minibuffer for using isearch to search the minibuffer history.
2252 Intended to be added to `minibuffer-setup-hook'."
2264 "Clean up the minibuffer after terminating isearch in the minibuffer."
2269 "Return the proper search function, for isearch in minibuffer history."
2272 ;; Use standard functions to search within minibuffer text
2274 found)
2275 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2276 ;; searching forward. Lazy-highlight calls this lambda with the
2277 ;; bound arg, so skip the minibuffer prompt.
2281 ;; 1. First try searching in the initial minibuffer text
2284 noerror)
2285 ;; 2. If the above search fails, start putting next/prev history
2286 ;; elements in the minibuffer successively, and search the string
2287 ;; in them. Do this only when bound is nil (i.e. not while
2288 ;; lazy-highlighting search strings in the current minibuffer text).
2300 ;; After putting the next/prev history element, search
2301 ;; the string in them again, until next-history-element
2302 ;; or previous-history-element raises an error at the
2303 ;; beginning/end of history.
2306 ;; For backward search, don't search
2307 ;; in the minibuffer prompt
2309 noerror)))
2310 ;; Return point of the new search result
2312 ;; Return nil when next(prev)-history-element fails
2316 "Display the minibuffer history search prompt.
2317 If there are no search errors, this function displays an overlay with
2318 the isearch prompt which replaces the original minibuffer prompt.
2319 Otherwise, it displays the standard isearch message returned from
2320 the function `isearch-message'."
2322 ;; Use standard function `isearch-message' when not in the minibuffer,
2323 ;; or search fails, or has an error (like incomplete regexp).
2324 ;; This function overwrites minibuffer text with isearch message,
2325 ;; so it's possible to see what is wrong in the search string.
2327 ;; Otherwise, put the overlay with the standard isearch prompt over
2328 ;; the initial minibuffer prompt.
2337 ;; And clear any previous isearch message.
2341 "Wrap the minibuffer history search when search fails.
2342 Move point to the first history element for a forward search,
2343 or to the last history element for a backward search."
2344 ;; When `minibuffer-history-isearch-search' fails on reaching the
2345 ;; beginning/end of the history, wrap the search to the first/last
2346 ;; minibuffer history element.
2354 "Save a function restoring the state of minibuffer history search.
2355 Save `minibuffer-history-position' to the additional state parameter
2356 in the search status stack."
2362 "Restore the minibuffer history search state.
2363 Go to the history element by the absolute history position HIST-POS."
2366 \f
2367 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2371 "Table mapping redo records to the corresponding undo one.
2372 A redo record for undo-in-region maps to t.
2382 "Within a run of consecutive undo commands, list remaining to be undone.
2386 "Undo some previous changes.
2387 Repeat this command to undo more changes.
2388 A numeric ARG serves as a repeat count.
2390 In Transient Mark mode when the mark is active, only undo changes within
2392 as an argument limits undo to changes within the current region."
2394 ;; Make last-command indicate for the next command that this was an undo.
2395 ;; That way, another undo will undo more.
2396 ;; If we get to the end of the undo history and get an error,
2397 ;; another undo command will find the undo history empty
2398 ;; and will get another error. To begin undoing the undos,
2399 ;; you must type some other command.
2401 ;; For an indirect buffer, look in the base buffer for the
2402 ;; auto-save data.
2406 message)
2407 ;; If we get an error in undo-start,
2408 ;; the next command should not be a "consecutive undo".
2409 ;; So set `this-command' to something other than `undo'.
2414 ;; If something (a timer or filter?) changed the buffer
2415 ;; since the previous command, don't continue the undo seq.
2419 ;; If the last undo record made was made by undo
2420 ;; it shows nothing else happened in between.
2427 ;; get rid of initial undo boundary
2429 ;; If we got this far, the next command should be a consecutive undo.
2431 ;; Check to see whether we're hitting a redo record, and if
2432 ;; so, ask the user whether she wants to skip the redo/undo pair.
2440 ;; The equiv entry might point to another redo record if we have done
2441 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2449 ;; Record the fact that the just-generated undo records come from an
2450 ;; undo operation--that is, they are redo records.
2451 ;; In the ordinary case (not within a region), map the redo
2452 ;; record to the following undos.
2453 ;; I don't know how to do that in the undo-in-region case.
2455 ;; Strip any leading undo boundaries there might be, like we do
2456 ;; above when checking.
2460 ;; Prevent identity mapping. This can happen if
2461 ;; consecutive nils are erroneously in undo list.
2463 t
2464 pending-undo-list)
2465 undo-equiv-table))
2466 ;; Don't specify a position in the undo record for the undo command.
2467 ;; Instead, undoing this should move point to where the change is.
2486 ;; Record what the current undo list says,
2487 ;; so the next command can tell if the buffer was modified in between.
2491 ;; Display a message announcing success.
2496 "Make BUFFER stop keeping undo information.
2497 No argument or nil as argument means do this for the current buffer."
2503 "Undo some previous changes.
2504 Repeat this command to undo more changes.
2505 A numeric ARG serves as a repeat count.
2506 Contrary to `undo', this will not redo a previous undo."
2511 "Non-nil while performing an undo.
2515 "Undo back N undo-boundaries beyond what was already undone recently.
2516 Call `undo-start' to get ready to undo recent changes,
2517 then call `undo-more' one or more times to undo them."
2522 ;; Note: The following, while pulling elements off
2523 ;; `pending-undo-list' will call primitive change functions which
2524 ;; will push more elements onto `buffer-undo-list'.
2530 "Undo N records from the front of the list LIST.
2531 Return what remains of the list."
2533 ;; This is a good feature, but would make undo-start
2534 ;; unable to do what is expected.
2535 ;;(when (null (car (list)))
2536 ;; ;; If the head of the list is a boundary, it is the boundary
2537 ;; ;; preceding this command. Get rid of it and don't count it.
2538 ;; (setq list (cdr list))))
2541 ;; In a writable buffer, enable undoing read-only text that is
2542 ;; so because of text properties.
2544 ;; Don't let `intangible' properties interfere with undo.
2546 ;; We use oldlist only to check for EQ. ++kfs
2552 ;; Handle an integer by setting point to that value.
2555 ;; Element (t . TIME) records previous modtime.
2556 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2557 ;; UNKNOWN_MODTIME_NSECS.
2559 ;; If this records an obsolete save
2560 ;; (not matching the actual disk file)
2561 ;; then don't mark unmodified.
2569 ;; Element (nil PROP VAL BEG . END) is property change.
2574 ;; Element (BEG . END) means range was inserted.
2576 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2577 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2580 ;; Set point first thing, so that undoing this undo
2581 ;; does not send point back to where it is now.
2584 ;; Element (apply FUN . ARGS) means call FUN to undo.
2588 ;; Long format: (apply DELTA START END FUN . ARGS).
2595 ;; Check that the function did what the entry
2596 ;; said it would do.
2606 ;; Element (STRING . POS) means STRING was deleted.
2612 ;; Check that marker adjustments which were recorded
2613 ;; with the (STRING . POS) record are still valid, ie
2614 ;; the markers haven't moved. We check their validity
2615 ;; before reinserting the string so as we don't need to
2616 ;; mind marker insertion-type.
2624 ;; Insert string and adjust point
2632 ;; Adjust the valid marker adjustments
2634 ;; Insert might have invalidated some of the markers
2635 ;; via modification hooks. Update only the currently
2636 ;; valid ones (bug#25599).
2640 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2643 next)
2644 ;; Even though these elements are not expected in the undo
2645 ;; list, adjust them to be conservative for the 24.4
2646 ;; release. (Bug#16818)
2653 ;; Make sure an apply entry produces at least one undo entry,
2654 ;; so the test in `undo' for continuing an undo series
2655 ;; will work right.
2660 list)
2662 ;; Deep copy of a list
2664 "Make a copy of undo list LIST."
2670 elt))
2673 "Set `pending-undo-list' to the front of the undo list.
2674 The next call to `undo-more' will undo the most recently made change.
2675 If BEG and END are specified, then only undo elements
2676 that apply to text between BEG and END are used; other undo elements
2677 are ignored. If BEG and END are nil, all undo elements are used."
2683 buffer-undo-list)))
2685 ;; The positions given in elements of the undo list are the positions
2686 ;; as of the time that element was recorded to undo history. In
2687 ;; general, subsequent buffer edits render those positions invalid in
2688 ;; the current buffer, unless adjusted according to the intervening
2689 ;; undo elements.
2690 ;;
2691 ;; Undo in region is a use case that requires adjustments to undo
2692 ;; elements. It must adjust positions of elements in the region based
2693 ;; on newer elements not in the region so as they may be correctly
2694 ;; applied in the current buffer. undo-make-selective-list
2695 ;; accomplishes this with its undo-deltas list of adjustments. An
2696 ;; example undo history from oldest to newest:
2697 ;;
2698 ;; buf pos:
2699 ;; 123456789 buffer-undo-list undo-deltas
2700 ;; --------- ---------------- -----------
2701 ;; aaa (1 . 4) (1 . -3)
2702 ;; aaba (3 . 4) N/A (in region)
2703 ;; ccaaba (1 . 3) (1 . -2)
2704 ;; ccaabaddd (7 . 10) (7 . -3)
2705 ;; ccaabdd ("ad" . 6) (6 . 2)
2706 ;; ccaabaddd (6 . 8) (6 . -2)
2707 ;; | |<-- region: "caab", from 2 to 6
2708 ;;
2709 ;; When the user starts a run of undos in region,
2710 ;; undo-make-selective-list is called to create the full list of in
2711 ;; region elements. Each element is adjusted forward chronologically
2712 ;; through undo-deltas to determine if it is in the region.
2713 ;;
2714 ;; In the above example, the insertion of "b" is (3 . 4) in the
2715 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2716 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2717 ;; . 6) is assessed as in the region and placed in the selective list.
2718 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2719 ;; due to the selected element. The "b" insertion is the only element
2720 ;; fully in the region, so in this example undo-make-selective-list
2721 ;; returns (nil (5 . 6)).
2722 ;;
2723 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2724 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2725 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2726 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2727 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2728 ;;
2729 ;; More interesting is how to adjust the "ddd" insertion due to the
2730 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2731 ;; If the reinsertion was a manual retyping of "ad", then the total
2732 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2733 ;; the reinsertion was due to undo, one might expect the first "d"
2734 ;; character would again be a part of the "ddd" text, meaning its
2735 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2736 ;;
2737 ;; undo-make-selective-list assumes in this situation that "ad" was a
2738 ;; new edit, even if it was inserted because of an undo.
2739 ;; Consequently, if the user undos in region "8 to 10" of the
2740 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2741 ;; "ccaabad", as though the first "d" became detached from the
2742 ;; original "ddd" insertion. This quirk is a FIXME.
2745 "Return a list of undo elements for the region START to END.
2746 The elements come from `buffer-undo-list', but we keep only the
2747 elements inside this region, and discard those outside this
2748 region. The elements' positions are adjusted so as the returned
2749 list can be applied to the current buffer."
2751 ;; A list of position adjusted undo elements in the region.
2753 ;; A list of undo-deltas for out of region undo elements.
2754 undo-deltas
2755 undo-elt)
2763 ;; Don't put two nils together in the list
2767 ;; This is a "was unmodified" element. Keep it
2768 ;; if we have kept everything thus far.
2771 ;; Skip over marker adjustments, instead relying
2772 ;; on finding them after (TEXT . POS) elements
2774 nil)
2777 undo-deltas)))
2782 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2783 ;; kept. primitive-undo may discard them later.
2796 "Determine whether UNDO-ELT falls inside the region START ... END.
2797 If it crosses the edge, we return nil.
2799 Generally this function is not useful for determining
2800 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2801 because markers can be arbitrarily relocated. Instead, pass the
2802 marker adjustment's corresponding (TEXT . POS) element."
2807 t)
2809 nil)
2811 ;; (TEXT . POSITION)
2815 ;; (MARKER . ADJUSTMENT)
2818 ;; (nil PROPERTY VALUE BEG . END)
2823 ;; (BEGIN . END)
2828 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2829 This assumes we have already decided that UNDO-ELT
2830 is not *inside* the region START...END."
2834 ;; (nil PROPERTY VALUE BEG . END)
2839 ;; (BEGIN . END)
2844 "Return adjustment of undo element ELT by the undo DELTAS
2845 list."
2847 ;; POSITION
2850 ;; (BEG . END)
2853 ;; (TEXT . POSITION)
2857 ;; (nil PROPERTY VALUE BEG . END)
2860 ;; (apply DELTA START END FUN . ARGS)
2861 ;; FIXME
2862 ;; All others return same elt
2865 ;; (BEG . END) can adjust to the same positions, commonly when an
2866 ;; insertion was undone and they are out of region, for example:
2867 ;;
2868 ;; buf pos:
2869 ;; 123456789 buffer-undo-list undo-deltas
2870 ;; --------- ---------------- -----------
2871 ;; [...]
2872 ;; abbaa (2 . 4) (2 . -2)
2873 ;; aaa ("bb" . 2) (2 . 2)
2874 ;; [...]
2875 ;;
2876 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2877 ;; undo. Further adjustments to such an element should be the same as
2878 ;; for (TEXT . POSITION) elements. The options are:
2879 ;;
2880 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2881 ;; analogous to marker insertion-type t.
2882 ;;
2883 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2884 ;; marker insertion-type nil.
2885 ;;
2886 ;; There was no strong reason to prefer one or the other, except that
2887 ;; the first is more consistent with prior undo in region behavior.
2889 "Return cons of adjustments to BEG and END by the undo DELTAS
2890 list."
2892 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2897 "Return adjustment of POS by the undo DELTAS list, comparing
2898 with < or <= based on USE-<."
2904 ;; Don't allow pos to become less than the undo-delta
2905 ;; position. This edge case is described in the overview
2906 ;; comments.
2909 ;; Return the first affected buffer position and the delta for an undo element
2910 ;; delta is defined as the change in subsequent buffer positions if we *did*
2911 ;; the undo.
2915 ;; (TEXT . POSITION)
2918 ;; (BEGIN . END)
2924 ;;; Default undo-boundary addition
2925 ;;
2926 ;; This section adds a new undo-boundary at either after a command is
2927 ;; called or in some cases on a timer called after a change is made in
2928 ;; any buffer.
2930 "Describe the cause of the last undo-boundary.
2932 If `explicit', the last boundary was caused by an explicit call to
2933 `undo-boundary', that is one not called by the code in this
2934 section.
2936 If it is equal to `timer', then the last boundary was inserted
2937 by `undo-auto--boundary-timer'.
2939 If it is equal to `command', then the last boundary was inserted
2940 automatically after a command, that is by the code defined in
2941 this section.
2943 If it is equal to a list, then the last boundary was inserted by
2944 an amalgamating command. The car of the list is the number of
2945 times an amalgamating command has been called, and the cdr are the
2949 "Current timer which will run `undo-auto--boundary-timer' or nil.
2954 "Non-nil if `this-command' should be amalgamated.
2955 This variable is set to nil by `undo-auto--boundaries' and is set
2959 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2963 "Return the number of amalgamating last commands or nil.
2964 Amalgamating commands are, by default, either
2965 `self-insert-command' and `delete-char', but can be any command
2966 that calls `undo-auto-amalgamate'."
2970 "Add an `undo-boundary' to the current buffer if needed.
2971 REASON describes the reason that the boundary is being added; see
2972 `undo-auto--last-boundary' for more information."
2982 undo-auto--undoably-changed-buffers)
2983 cause)))))
2986 "Check recently changed buffers and add a boundary if necessary.
2987 REASON describes the reason that the boundary is being added; see
2988 `undo-last-boundary' for more information."
2989 ;; (Bug #23785) All commands should ensure that there is an undo
2990 ;; boundary whether they have changed the current buffer or not.
3000 "Timer which will run `undo--auto-boundary-timer'."
3005 "Ensure that the `undo-auto-boundary-timer' is set."
3011 "List of buffers that have changed recently.
3013 This list is maintained by `undo-auto--undoable-change' and
3014 `undo-auto--boundaries' and can be affected by changes to their
3018 "Add an `undo-boundary' in appropriate buffers."
3023 'amalgamate
3027 "Amalgamate undo if necessary.
3028 This function can be called before an amalgamating command. It
3029 removes the previous `undo-boundary' if a series of such calls
3030 have been made. By default `self-insert-command' and
3031 `delete-char' are the only amalgamating commands, although this
3032 function could be called by any command wishing to have this
3033 behavior."
3038 last-amalgamating-count
3043 ;; Amalgamate all buffers that have changed.
3047 b
3049 ;; The head of `buffer-undo-list' is nil.
3050 ;; `car-safe' doesn't work because
3051 ;; `buffer-undo-list' need not be a list!
3059 "Called after every undoable buffer change."
3062 ;; End auto-boundary section
3065 "Amalgamate changes in change-group since HANDLE.
3066 Remove all undo boundaries between the state of HANDLE and now.
3067 HANDLE is as returned by `prepare-change-group'."
3076 ;; Temporarily truncate the undo log at ELT.
3081 ;; `elt' is still in the log: normal case.
3083 ;; `elt' is not in the log any more, but that's because
3084 ;; the log is "all new", so we should remove all
3085 ;; boundaries from it.
3089 buffer-undo-list
3090 ;; Preserve the undo-boundaries at either ends of the
3091 ;; change-groups.
3093 ;; Reset the modified cons cell ELT to its original content.
3100 "If non-nil ask about discarding undo info for the current command.
3101 Normally, Emacs discards the undo info for the current command if
3102 it exceeds `undo-outer-limit'. But if you set this option
3103 non-nil, it asks in the echo area whether to discard the info.
3104 If you answer no, there is a slight risk that Emacs might crash, so
3105 only do it if you really want to undo the command.
3107 This option is mainly intended for debugging. You have to be
3108 careful if you use it for other purposes. Garbage collection is
3109 inhibited while the question is asked, meaning that Emacs might
3110 leak memory. So you should make sure that you do not wait
3111 excessively long before answering the question."
3117 "If non-nil, an extra level of size that's ok in an undo item.
3118 We don't ask the user about truncating the undo list until the
3119 current item gets bigger than this amount.
3124 ;; When the first undo batch in an undo list is longer than
3125 ;; undo-outer-limit, this function gets called to warn the user that
3126 ;; the undo info for the current command was discarded. Garbage
3127 ;; collection is inhibited around the call, so it had better not do a
3128 ;; lot of consing.
3134 ;; Don't ask the question again unless it gets even bigger.
3135 ;; This applies, in particular, if the user quits from the question.
3136 ;; Such a quit quits out of GC, but something else will call GC
3137 ;; again momentarily. It will call this function again,
3138 ;; but we don't want to ask the question again.
3142 "Buffer `%s' undo info is %d bytes long; discard it? "
3146 t)
3147 nil))
3153 "The undo info was discarded because it exceeded \
3154 `undo-outer-limit'.
3156 This is normal if you executed a command that made a huge change
3157 to the buffer. In that case, to prevent similar problems in the
3158 future, set `undo-outer-limit' to a value that is large enough to
3159 cover the maximum size of normal changes you expect a single
3160 command to make, but not so large that it might exceed the
3161 maximum memory allotted to Emacs.
3163 If you did not execute any such command, the situation is
3164 probably due to a bug and you should report it.
3166 You can disable the popping up of this buffer by adding the entry
3167 \(undo discard-info) to the user option `warning-suppress-types',
3171 t))
3172 \f
3175 ; These are sorted according to the GNU en_US locale.
3218 )
3220 This is used by Shell mode and other parts of Emacs to recognize
3221 password prompts, including prompts in languages other than
3222 English. Different case choices should not be assumed to be
3223 included; callers should bind `case-fold-search' to t."
3229 "History list for some commands that read shell commands.
3231 Maximum length of the history list is determined by the value
3238 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3239 This buffer is used when `shell-command' or `shell-command-on-region'
3240 is run interactively. A value of nil means that output to stderr and
3247 "Return a list of all commands associated with the current file.
3248 This function is used to add all related commands retrieved by `mailcap'
3249 to the end of the list of defaults just after the default value."
3253 minibuffer-default))
3258 commands))
3269 map)
3273 "Read a shell command from the minibuffer.
3274 The arguments are the same as the ones of `read-from-minibuffer',
3275 except READ and KEYMAP are missing and HIST defaults
3276 to `shell-command-history'."
3284 minibuffer-local-shell-command-map
3285 nil
3287 args)))
3290 "What to do when the output buffer is used by another shell command.
3291 This option specifies how to resolve the conflict where a new command
3292 wants to direct its output to the buffer `*Async Shell Command*',
3293 but this buffer is already taken by another running shell command.
3295 The value `confirm-kill-process' is used to ask for confirmation before
3296 killing the already running process and running a new process
3297 in the same buffer, `confirm-new-buffer' for confirmation before running
3298 the command in a new buffer with a name other than the default buffer name,
3299 `new-buffer' for doing the same without confirmation,
3300 `confirm-rename-buffer' for confirmation before renaming the existing
3301 output buffer and running a new command in the default buffer,
3302 `rename-buffer' for doing the same without confirmation."
3304 confirm-kill-process)
3306 confirm-new-buffer)
3308 new-buffer)
3310 confirm-rename-buffer)
3312 rename-buffer))
3317 "Whether to display the command buffer immediately.
3318 If t, display the buffer immediately; if nil, wait until there
3319 is output."
3321 t)
3323 nil))
3328 "If non-nil, output buffer is not erased between shell commands.
3329 Also, a non-nil value sets the point in the output buffer
3330 once the command completes.
3331 The value `beg-last-out' sets point at the beginning of the output,
3332 `end-last-out' sets point at the end of the buffer, `save-point'
3333 restores the buffer position before the command."
3343 "Record of point positions in output buffers after command completion.
3344 The value is an alist whose elements are of the form (BUFFER . POS),
3345 where BUFFER is the output buffer, and POS is the point position
3346 in BUFFER once the command finishes.
3350 "Store a buffer position or erase the buffer.
3351 See `shell-command-dont-erase-buffer'."
3353 pos)
3355 ;; Setting buffer-read-only to nil doesn't suffice
3356 ;; if some text has a non-nil read-only property,
3357 ;; which comint sometimes adds for prompts.
3367 shell-command-saved-pos))))
3370 "Set point in BUFFER after command complete.
3371 BUFFER is the output buffer of the command; if nil, then defaults
3372 to the current BUFFER.
3373 Set point to the `cdr' of the element in `shell-command-saved-pos'
3374 whose `car' is BUFFER."
3386 ;; Set point in the window displaying buf, if any; otherwise
3387 ;; display buf temporary in selected frame and set the point.
3392 buf
3397 "Execute string COMMAND asynchronously in background.
3399 Like `shell-command', but adds `&' at the end of COMMAND
3400 to execute it asynchronously.
3402 The output appears in the buffer `*Async Shell Command*'.
3403 That buffer is in shell mode.
3405 You can configure `async-shell-command-buffer' to specify what to do
3406 when the `*Async Shell Command*' buffer is already taken by another
3407 running shell command. To run COMMAND without displaying the output
3408 in a window you can configure `display-buffer-alist' to use the action
3409 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3411 In Elisp, you will often be better served by calling `start-process'
3412 directly, since it offers more control and does not impose the use of
3413 a shell (with its need to quote arguments)."
3423 current-prefix-arg
3424 shell-command-default-error-buffer))
3430 "Execute string COMMAND in inferior shell; display output, if any.
3431 With prefix argument, insert the COMMAND's output at point.
3433 Interactively, prompt for COMMAND in the minibuffer.
3435 If COMMAND ends in `&', execute it asynchronously.
3436 The output appears in the buffer `*Async Shell Command*'.
3437 That buffer is in shell mode. You can also use
3438 `async-shell-command' that automatically adds `&'.
3440 Otherwise, COMMAND is executed synchronously. The output appears in
3441 the buffer `*Shell Command Output*'. If the output is short enough to
3442 display in the echo area (which is determined by the variables
3443 `resize-mini-windows' and `max-mini-window-height'), it is shown
3444 there, but it is nonetheless available in buffer `*Shell Command
3445 Output*' even though that buffer is not automatically displayed.
3447 To specify a coding system for converting non-ASCII characters
3449 before this command.
3451 Noninteractive callers can specify coding systems by binding
3452 `coding-system-for-read' and `coding-system-for-write'.
3454 The optional second argument OUTPUT-BUFFER, if non-nil,
3455 says to put the output in some other buffer.
3456 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3457 and insert the output there; a non-nil value of
3458 `shell-command-dont-erase-buffer' prevents the buffer from being
3459 erased. If OUTPUT-BUFFER is not a buffer and not nil, insert the
3460 output in current buffer after point leaving mark after it. This
3461 cannot be done asynchronously.
3463 If the command terminates without error, but generates output,
3465 the output can be displayed in the echo area or in its buffer.
3466 If the output is short enough to display in the echo area
3467 \(determined by the variable `max-mini-window-height' if
3468 `resize-mini-windows' is non-nil), it is shown there.
3469 Otherwise, the buffer containing the output is displayed.
3473 of the output.
3475 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3476 or buffer name to which to direct the command's standard error output.
3477 If it is nil, error output is mingled with regular output.
3478 In an interactive call, the variable `shell-command-default-error-buffer'
3479 specifies the value of ERROR-BUFFER.
3481 In Elisp, you will often be better served by calling `call-process' or
3482 `start-process' directly, since they offer more control and do not
3483 impose the use of a shell (with its need to quote arguments)."
3494 current-prefix-arg
3495 shell-command-default-error-buffer))
3496 ;; Look for a handler in case default-directory is a remote file name.
3504 ;; Output goes in current buffer.
3510 temporary-file-directory)))
3511 nil)))
3514 ;; We do not use -f for csh; we will not support broken use of
3515 ;; .cshrcs. Even the BSD csh manual says to use
3516 ;; "if ($?prompt) exit" before things which are not useful
3517 ;; non-interactively. Besides, if someone wants their other
3518 ;; aliases for shell commands then they can still have them.
3522 t)
3523 nil shell-command-switch command)
3530 ;; Do no formatting while reading error file,
3531 ;; because that can run a shell command, and we
3532 ;; don't want that to cause an infinite recursion.
3534 ;; Put point after the inserted errors.
3538 ;; This is like exchange-point-and-mark, but doesn't
3539 ;; activate the mark. It is cleaner to avoid activation,
3540 ;; even though the command loop would deactivate the mark
3541 ;; because we inserted text.
3545 ;; Output goes in a separate buffer.
3546 ;; Preserve the match data in case called from a program.
3547 ;; FIXME: It'd be ridiculous for an Elisp function to call
3548 ;; shell-command and assume that it won't mess the match-data!
3551 ;; Command ending with ampersand means asynchronous.
3556 proc)
3557 ;; Remove the ampersand.
3559 ;; Ask the user what to do with already running process.
3564 ;; If will kill a process, query first.
3569 ;; If will create a new buffer, query first.
3574 ;; It will create a new buffer.
3577 ;; If will rename the buffer, query first.
3585 ;; It will rename the buffer.
3593 shell-command-switch command))
3597 ;; Use the comint filter for proper handling of
3598 ;; carriage motion (see comint-inhibit-carriage-motion).
3601 ;; Display buffer immediately.
3603 ;; Defer displaying buffer until first process output.
3604 ;; Use disposable named advice so that the buffer is
3605 ;; displayed at most once per process lifetime.
3612 nonce)
3615 ;; Otherwise, command is executed synchronously.
3617 output-buffer nil error-buffer)))))))
3620 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3621 MESSAGE may be either a string or a buffer.
3623 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3624 for maximum height of the echo area, as defined by `max-mini-window-height'
3625 if `resize-mini-windows' is non-nil.
3627 Returns either the string shown in the echo area, or when a pop-up
3628 buffer is used, the window used to display it.
3630 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3631 name of the buffer used to display it in the case where a pop-up buffer
3632 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3633 string and it is displayed in the echo area, it is not specified whether
3634 the contents are inserted into the buffer anyway.
3636 Optional arguments ACTION and FRAME are as for `display-buffer',
3637 and are only used if a pop-up buffer is displayed."
3639 ;; Trivial case where we can use the echo area
3643 ;; Trivial case where we can just remove single trailing newline
3646 ;; General case
3649 message
3658 0
3662 (<= lines
3666 max-mini-window-height))
3668 max-mini-window-height)
3672 ;; Don't use the echo area if the output buffer is
3673 ;; already displayed in the selected frame.
3675 ;; Echo area
3681 ;; Buffer
3686 ;; We have a sentinel to prevent insertion of a termination message
3687 ;; in the buffer itself, and to set the point in the buffer when
3688 ;; `shell-command-dont-erase-buffer' is non-nil.
3697 &optional output-buffer replace
3698 error-buffer display-error-buffer
3699 region-noncontiguous-p)
3700 "Execute string COMMAND in inferior shell with region as input.
3701 Normally display output (if any) in temp buffer `*Shell Command Output*';
3702 Prefix arg means replace the region with it. Return the exit code of
3703 COMMAND.
3705 To specify a coding system for converting non-ASCII characters
3707 before this command. By default, the input (from the current buffer)
3708 is encoded using coding-system specified by `process-coding-system-alist',
3709 falling back to `default-process-coding-system' if no match for COMMAND
3710 is found in `process-coding-system-alist'.
3712 Noninteractive callers can specify coding systems by binding
3713 `coding-system-for-read' and `coding-system-for-write'.
3715 If the command generates output, the output may be displayed
3716 in the echo area or in a buffer.
3717 If the output is short enough to display in the echo area
3718 \(determined by the variable `max-mini-window-height' if
3719 `resize-mini-windows' is non-nil), it is shown there.
3720 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3721 The output is available in that buffer in both cases.
3723 If there is output and an error, a message about the error
3724 appears at the end of the output.
3726 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3727 command's output. If the value is a buffer or buffer name,
3728 erase that buffer and insert the output there; a non-nil value of
3729 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3730 If the value is nil, use the buffer `*Shell Command Output*'.
3731 Any other non-nil value means to insert the output in the
3732 current buffer after START.
3734 Optional fifth arg REPLACE, if non-nil, means to insert the
3735 output in place of text from START to END, putting point and mark
3736 around it.
3738 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3739 or buffer name to which to direct the command's standard error
3740 output. If nil, error output is mingled with regular output.
3741 When called interactively, `shell-command-default-error-buffer'
3742 is used for ERROR-BUFFER.
3744 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3745 display the error buffer if there were any errors. When called
3746 interactively, this is t."
3750 ;; Do this before calling region-beginning
3751 ;; and region-end, in case subprocess output
3752 ;; relocates them while we are in the minibuffer.
3754 ;; call-interactively recognizes region-beginning and
3755 ;; region-end specially, leaving them in the history.
3757 string
3758 current-prefix-arg
3759 current-prefix-arg
3760 shell-command-default-error-buffer
3761 t
3768 temporary-file-directory)))
3769 nil))
3770 exit-status)
3771 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3774 output)
3778 shell-file-name t t
3779 nil shell-command-switch
3780 command)
3787 ;; Replace specified region with output from command.
3789 ;; Don't muck with mark unless REPLACE says we should.
3796 t)))
3797 ;; It is rude to delete a buffer which the command is not using.
3798 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3799 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3800 ;; (kill-buffer shell-buffer)))
3801 ;; Don't muck with mark unless REPLACE says we should.
3803 ;; No prefix argument: put the output in a temp buffer,
3804 ;; replacing its entire contents.
3812 ;; If the input is the same buffer as the output,
3813 ;; delete everything but the specified region,
3814 ;; then replace that region with the output.
3820 shell-file-name t
3823 t)
3824 nil shell-command-switch
3825 command)))
3826 ;; Clear the output buffer, then run the command with
3827 ;; output there.
3837 buffer))))
3838 ;; Report the output.
3848 ;; There's some output, display it
3852 ;; No output; error?
3859 shell-command-default-error-buffer)
3866 output))
3869 exit-status))
3872 exit-status output))))
3873 ;; Don't kill: there might be useful info in the undo-log.
3874 ;; (kill-buffer buffer)
3875 )))))
3883 ;; Do no formatting while reading error file,
3884 ;; because that can run a shell command, and we
3885 ;; don't want that to cause an infinite recursion.
3887 ;; Put point after the inserted errors.
3892 exit-status))
3895 "Execute shell command COMMAND and return its output as a string."
3898 standard-output
3902 "Process files synchronously in a separate process.
3903 Similar to `call-process', but may invoke a file handler based on
3904 `default-directory'. The current working directory of the
3905 subprocess is `default-directory'.
3907 File names in INFILE and BUFFER are handled normally, but file
3908 names in ARGS should be relative to `default-directory', as they
3909 are passed to the process verbatim. (This is a difference to
3910 `call-process' which does not support file handlers for INFILE
3911 and BUFFER.)
3913 Some file handlers might not support all variants, for example
3914 they might behave as if DISPLAY was nil, regardless of the actual
3915 value passed."
3917 lc stderr-file)
3927 display args)
3933 "Whether a call of `process-file' changes remote files.
3935 By default, this variable is always set to t, meaning that a
3936 call of `process-file' could potentially change any file on a
3937 remote host. When set to nil, a file handler could optimize
3938 its behavior with respect to remote file attribute caching.
3940 You should only ever change this variable with a let-binding;
3944 "Start a program in a subprocess. Return the process object for it.
3946 Similar to `start-process', but may invoke a file handler based on
3947 `default-directory'. See Info node `(elisp)Magic File Names'.
3949 This handler ought to run PROGRAM, perhaps on the local host,
3950 perhaps on a remote host that corresponds to `default-directory'.
3951 In the latter case, the local part of `default-directory' becomes
3952 the working directory of the process.
3954 PROGRAM and PROGRAM-ARGS might be file names. They are not
3955 objects of file handler invocation. File handlers might not
3956 support pty association, if PROGRAM is nil."
3960 \f
3961 ;;;; Process menu
3975 map))
3978 "Major mode for listing the processes called by Emacs."
3982 ;; 25 is the length of the long standard buffer
3983 ;; name "*Async Shell Command*<10>" (bug#30016)
3992 "Kill process at point in a `list-processes' buffer."
4003 "Recompute the list of processes for the Process List buffer.
4004 Also, delete any process that is exited or signaled."
4018 face link
4020 "Visit buffer `%s'"
4022 follow-link t
4023 process-buffer ,buf
4024 action process-menu-visit-buffer)
4033 "datagram"
4050 tabulated-list-entries)))))
4057 "Display a list of all processes that are Emacs sub-processes.
4058 If optional argument QUERY-ONLY is non-nil, only processes with
4059 the query-on-exit flag set are listed.
4060 Any process listed as exited or signaled is actually eliminated
4061 after the listing is made.
4062 Optional argument BUFFER specifies a buffer to use, instead of
4064 The return value is always nil.
4066 This function lists only processes that were launched by Emacs. To
4067 see other processes running on the system, use `list-system-processes'."
4079 nil)
4080 \f
4081 ;;;; Prefix commands
4087 ;; BEWARE: Called directly from C code.
4088 ;; If the return value is non-nil, it means we are in the middle of
4089 ;; a command with prefix, such as a command invoked with prefix-arg.
4091 prefix-command--last-echo
4100 "Abnormal hook which constructs the description of the current prefix state.
4104 "Update state of prefix commands.
4112 "Pass the current prefix command state to the next command.
4113 Should be called by all prefix commands.
4114 Runs `prefix-command-preserve-state-hook'."
4116 ;; If the current command is a prefix command, we don't want the next (real)
4117 ;; command to have `last-command' set to, say, `universal-argument'.
4124 nil)
4126 ;;;;; The main prefix command.
4128 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
4153 ;; For backward compatibility, minus with no modifiers is an ordinary
4154 ;; command if digits have already been entered.
4184 map)
4192 "Begin a numeric argument for the following command.
4197 multiplies the argument by 4 each time.
4199 which is different in effect from any particular numeric argument.
4207 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
4208 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
4215 arg)))
4219 "Begin a negative numeric argument for the next command.
4229 "Part of the numeric argument for the next command.
4234 last-command-event
4241 ;; Treat -0 as just -, so that -01 will work.
4244 digit))))
4246 \f
4249 "This variable is a wrapper hook around `buffer-substring--filter'.
4255 "Function to perform the filtering in `filter-buffer-substring'.
4256 The function is called with the same 3 arguments (BEG END DELETE)
4257 that `filter-buffer-substring' received. It should return the
4258 buffer substring between BEG and END, after filtering. If DELETE is
4262 "List of filter functions for `buffer-substring--filter'.
4263 Each function must accept a single argument, a string, and return a string.
4264 The buffer substring is passed to the first function in the list,
4265 and the return value of each function is passed to the next.
4266 As a special convention, point is set to the start of the buffer text
4267 being operated on (i.e., the first argument of `buffer-substring--filter')
4273 "Return the buffer substring between BEG and END, after filtering.
4274 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4276 This calls the function that `filter-buffer-substring-function' specifies
4277 \(passing the same three arguments that it received) to do the work,
4278 and returns whatever it does. The default function does no filtering,
4279 unless a hook has been set.
4281 Use `filter-buffer-substring' instead of `buffer-substring',
4282 `buffer-substring-no-properties', or `delete-and-extract-region' when
4283 you want to allow filtering to take place. For example, major or minor
4284 modes can use `filter-buffer-substring-function' to extract characters
4285 that are special to a buffer, and should not be copied into other buffers."
4289 "Default function to use for `filter-buffer-substring-function'.
4290 Its arguments and return value are as specified for `filter-buffer-substring'.
4291 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4292 \(see `with-wrapper-hook' for details about wrapper hooks),
4293 and the abnormal hook `buffer-substring-filters'.
4294 No filtering is done unless a hook says to."
4305 string)))
4310 ;;;; Window system cut and paste hooks.
4313 "Function to call to make a killed region available to other programs.
4314 Most window systems provide a facility for cutting and pasting
4315 text between different programs, such as the clipboard on X and
4316 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4318 This variable holds a function that Emacs calls whenever text is
4319 put in the kill ring, to make the new kill available to other
4320 programs. The function takes one argument, TEXT, which is a
4324 "Function to call to get text cut from other programs.
4325 Most window systems provide a facility for cutting and pasting
4326 text between different programs, such as the clipboard on X and
4327 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4329 This variable holds a function that Emacs calls to obtain text
4330 that other programs have provided for pasting. The function is
4331 called with no arguments. If no other program has provided text
4332 to paste, the function should return nil (in which case the
4333 caller, usually `current-kill', should use the top of the Emacs
4334 kill ring). If another program has provided text to paste, the
4335 function should return that text as a string (in which case the
4336 caller should put this string in the kill ring as the latest
4337 kill).
4339 The function may also return a list of strings if the window
4340 system supports multiple selections. The first string will be
4341 used as the pasted text, but the other will be placed in the kill
4342 ring for easy access via `yank-pop'.
4344 Note that the function should return a string only if a program
4345 other than Emacs has provided a string for pasting; if Emacs
4346 provided the most recent string, the function should return nil.
4347 If it is difficult to tell whether Emacs or some other program
4348 provided the current string, it is probably good enough to return
4349 nil if the string is equal (according to `string=') to the last
4351 \f
4354 ;;;; The kill ring data structure.
4357 "List of killed text sequences.
4358 Since the kill ring is supposed to interact nicely with cut-and-paste
4359 facilities offered by window systems, use of this variable should
4360 interact nicely with `interprogram-cut-function' and
4361 `interprogram-paste-function'. The functions `kill-new',
4362 `kill-append', and `current-kill' are supposed to implement this
4363 interaction; you may want to use them instead of manipulating the kill
4367 "Maximum length of kill ring before oldest elements are thrown away."
4375 "Save clipboard strings into kill ring before replacing them.
4376 When one selects something in another program to paste it into Emacs,
4377 but kills something in Emacs before actually pasting it,
4378 this selection is gone unless this variable is non-nil,
4379 in which case the other program's selection is saved in the `kill-ring'
4386 "Do not add a new string to `kill-ring' if it duplicates the last one.
4387 The comparison is done using `equal-including-properties'."
4393 "Make STRING the latest kill in the kill ring.
4394 Set `kill-ring-yank-pointer' to point to it.
4395 If `interprogram-cut-function' is non-nil, apply it to STRING.
4396 Optional second argument REPLACE non-nil means that STRING will replace
4397 the front of the kill ring, rather than being added to the list.
4399 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4400 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4401 STRING.
4403 When the yank handler has a non-nil PARAM element, the original STRING
4404 argument is not used by `insert-for-yank'. However, since Lisp code
4405 may access and use elements from the kill ring directly, the STRING
4408 ;; Due to text properties such as 'yank-handler that
4409 ;; can alter the contents to yank, comparison using
4410 ;; `equal' is unsafe.
4435 ;; It has been argued that this should work similar to `self-insert-command'
4436 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4438 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4444 "Append STRING to the end of the latest kill in the kill ring.
4445 If BEFORE-P is non-nil, prepend STRING to the kill.
4446 Also removes the last undo boundary in the current buffer,
4447 depending on `kill-append-merge-undo'.
4448 If `interprogram-cut-function' is set, pass the resulting kill to it."
4456 ;; find the next undo boundary
4460 ;; remove this undo boundary
4465 "Whether rotating the kill ring changes the window system selection.
4466 If non-nil, whenever the kill ring is rotated (usually via the
4467 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4468 to copy the new kill to the window system selection."
4474 "Rotate the yanking point by N places, and then return that kill.
4475 If N is zero and `interprogram-paste-function' is set to a
4476 function that returns a string or a list of strings, and if that
4477 function doesn't return nil, then that string (or list) is added
4478 to the front of the kill ring and the string (or first string in
4479 the list) is returned as the latest kill.
4481 If N is not zero, and if `yank-pop-change-selection' is
4482 non-nil, use `interprogram-cut-function' to transfer the
4483 kill at the new yank point into the window system selection.
4485 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4486 move the yanking point; just return the Nth kill forward."
4489 interprogram-paste-function
4493 ;; Disable the interprogram cut function when we add the new
4494 ;; text to the kill ring, so Emacs doesn't try to own the
4495 ;; selection, with identical text.
4505 kill-ring)))
4510 interprogram-cut-function)
4516 ;;;; Commands for manipulating the kill ring.
4519 "Non-nil means don't signal an error for killing read-only text."
4525 This deletes the text from the buffer and saves it in the kill ring.
4529 If you want to append the killed region to the last killed text,
4533 If the previous command was also a kill command,
4534 the text killed this time appends to the text killed last time
4535 to make one entry in the kill ring.
4537 The killed text is filtered by `filter-buffer-substring' before it is
4538 saved in the kill ring, so the actual saved text might be different
4539 from what was killed.
4541 If the buffer is read-only, Emacs will beep and refrain from deleting
4542 the text, but put the text in the kill ring anyway. This means that
4543 you can use the killing commands to copy text from a read-only buffer.
4545 Lisp programs should use this function for killing text.
4546 (To delete text, use `delete-region'.)
4547 Supply two arguments, character positions BEG and END indicating the
4548 stretch of text to be killed. If the optional argument REGION is
4549 non-nil, the function ignores BEG and END, and kills the current
4550 region instead."
4551 ;; Pass mark first, then point, because the order matters when
4552 ;; calling `kill-append'.
4561 ;; Add that string to the kill ring, one way or another.
4568 nil)
4570 ;; The code above failed because the buffer, or some of the characters
4571 ;; in the region, are read-only.
4572 ;; We should beep, in case the user just isn't aware of this.
4573 ;; However, there's no harm in putting
4574 ;; the region's text in the kill ring, anyway.
4576 ;; Set this-command now, so it will be set even if we get an error.
4578 ;; This should barf, if appropriate, and give us the correct error.
4581 ;; Signal an error if the buffer is read-only.
4583 ;; If the buffer isn't read-only, the text is.
4586 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4587 ;; to get two copies of the text when the user accidentally types M-w and
4588 ;; then corrects it with the intended C-w.
4590 "Save the region as if killed, but don't kill it.
4591 In Transient Mark mode, deactivate the mark.
4592 If `interprogram-cut-function' is non-nil, also save the text for a window
4593 system cut and paste.
4595 The copied text is filtered by `filter-buffer-substring' before it is
4596 saved in the kill ring, so the actual saved text might be different
4597 from what was in the buffer.
4599 When called from Lisp, save in the kill ring the stretch of text
4600 between BEG and END, unless the optional argument REGION is
4601 non-nil, in which case ignore BEG and END, and save the current
4602 region instead.
4604 This command's old key binding has been given to `kill-ring-save'."
4605 ;; Pass mark first, then point, because the order matters when
4606 ;; calling `kill-append'.
4616 nil)
4619 "Save the region as if killed, but don't kill it.
4620 In Transient Mark mode, deactivate the mark.
4621 If `interprogram-cut-function' is non-nil, also save the text for a window
4622 system cut and paste.
4624 If you want to append the killed line to the last killed text,
4627 The copied text is filtered by `filter-buffer-substring' before it is
4628 saved in the kill ring, so the actual saved text might be different
4629 from what was in the buffer.
4631 When called from Lisp, save in the kill ring the stretch of text
4632 between BEG and END, unless the optional argument REGION is
4633 non-nil, in which case ignore BEG and END, and save the current
4634 region instead.
4636 This command is similar to `copy-region-as-kill', except that it gives
4637 visual feedback indicating the extent of the region being copied."
4638 ;; Pass mark first, then point, because the order matters when
4639 ;; calling `kill-append'.
4643 ;; This use of called-interactively-p is correct because the code it
4644 ;; controls just gives the user visual feedback.
4649 "Indicate that the region text has been copied interactively.
4650 If the mark is visible in the selected window, blink the cursor
4651 between point and mark if there is currently no active region
4652 highlighting.
4654 If the mark lies outside the selected window, display an
4655 informative message containing a sample of the copied text. The
4656 optional argument MESSAGE-LEN, if non-nil, specifies the length
4657 of this sample text; it defaults to 40."
4660 ;; Inhibit quitting so we can make a quit here
4661 ;; look like a C-g typed as a command.
4664 ;; Swap point-and-mark quickly so as to show the region that
4665 ;; was selected. Don't do it if the region is highlighted.
4668 ;; Swap point and mark.
4672 ;; Swap back.
4675 ;; If user quit, deactivate the mark
4676 ;; as C-g would as a command.
4682 ;; Don't say "killed"; that is misleading.
4689 "Cause following command, if it kills, to add to previous kill.
4690 If the next command kills forward from point, the kill is
4691 appended to the previous killed text. If the command kills
4692 backward, the kill is prepended. Kill commands that act on the
4693 region, such as `kill-region', are regarded as killing forward if
4694 point is after mark, and killing backward if point is before
4695 mark.
4697 If the next command is not a kill command, `append-next-kill' has
4698 no effect.
4700 The argument is used for internal purposes; do not supply one."
4702 ;; We don't use (interactive-p), since that breaks kbd macros.
4716 "A subroutine of `squeeze-bidi-context'.
4717 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4721 lim1)
4728 ;; L and R categories include embedding and
4729 ;; override controls, but we don't want to
4730 ;; replace them, because that might change
4731 ;; the visual order. Likewise with PDF and
4732 ;; isolate controls.
4734 bidi-directional-non-controls-chars
4735 limit)))))
4736 ;; Replace any run of non-RTL characters by a single LRM.
4738 ;; No more characters of CATEGORY, we are done.
4743 ;; Skip directional controls, if any.
4748 "Replace characters between FROM and TO while keeping bidi context.
4750 This function replaces the region of text with as few characters
4751 as possible, while preserving the effect that region will have on
4752 bidirectional display before and after the region."
4756 ;; This is for when they copy text with read-only text
4757 ;; properties.
4761 ;; Replace each run of non-RTL characters with a single LRM.
4763 ;; Replace each run of non-LTR characters with a single RLM. Note
4764 ;; that the \cR category includes both the Arabic Letter (AL) and
4765 ;; R characters; here we ignore the distinction between them,
4766 ;; because that distinction only affects Arabic Number (AN)
4767 ;; characters, which are weak and don't affect the reordering.
4771 "Return buffer text between START and END with its bidi context.
4773 START and END are assumed to belong to the same physical line
4774 of buffer text. This function prepends and appends to the text
4775 between START and END bidi control characters that preserve the
4776 visual order of that text when it is inserted at some other place."
4781 substr para-dir from to)
4788 ;; If we don't have any mixed directional characters in the
4789 ;; entire line, we can just copy the substring without adding
4790 ;; any context.
4805 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4806 ;; (1) force the string to have the same base embedding
4807 ;; direction as the paragraph direction at the source, no matter
4808 ;; what is the paragraph direction at destination; and (2) avoid
4809 ;; affecting the visual order of the surrounding text at
4810 ;; destination if there are characters of different
4811 ;; directionality there.
4816 "Return portion of current buffer between START and END with bidi context.
4818 This function works similar to `buffer-substring', but it prepends and
4819 appends to the text bidi directional control characters necessary to
4820 preserve the visual appearance of the text if it is inserted at another
4821 place. This is useful when the buffer substring includes bidirectional
4822 text and control characters that cause non-trivial reordering on display.
4823 If copied verbatim, such text can have a very different visual appearance,
4824 and can also change the visual appearance of the surrounding text at the
4825 destination of the copy.
4827 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4828 the text properties."
4841 no-properties)))
4845 substr)))
4846 \f
4847 ;; Yanking.
4852 "List of special text property handling conditions for yanking.
4853 Each element should have the form (PROP . FUN), where PROP is a
4854 property symbol and FUN is a function. When the `yank' command
4855 inserts text into the buffer, it scans the inserted text for
4856 stretches of text that have `eq' values of the text property
4857 PROP; for each such stretch of text, FUN is called with three
4858 arguments: the property's value in that text, and the start and
4859 end positions of the text.
4861 This is done prior to removing the properties specified by
4862 `yank-excluded-properties'."
4865 function))
4868 ;; This is actually used in subr.el but defcustom does not work there.
4871 intangible invisible keymap local-map mouse-face read-only
4872 yank-handler)
4873 "Text properties to discard when yanking.
4874 The value should be a list of text properties to discard or t,
4875 which means to discard all text properties.
4877 See also `yank-handled-properties'."
4884 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4885 Function is called with two parameters, START and END corresponding to
4886 the value of the mark and point; it is guaranteed that START <= END.
4890 "Replace just-yanked stretch of killed text with a different stretch.
4891 This command is allowed only immediately after a `yank' or a `yank-pop'.
4892 At such a time, the region contains a stretch of reinserted
4893 previously-killed text. `yank-pop' deletes that text and inserts in its
4894 place a different stretch of killed text.
4896 With no argument, the previous kill is inserted.
4897 With argument N, insert the Nth previous kill.
4898 If N is negative, this is a more recent kill.
4900 The sequence of kills wraps around, so that after the oldest one
4901 comes the newest one.
4903 This command honors the `yank-handled-properties' and
4904 `yank-excluded-properties' variables, and the `yank-handler' text
4905 property, in the way that `yank' does."
4919 ;; Set the window start back where it was in the yank command,
4920 ;; if possible.
4923 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4924 ;; It is cleaner to avoid activation, even though the command
4925 ;; loop would deactivate the mark because we inserted text.
4928 nil)
4932 More precisely, reinsert the most recent kill, which is the
4933 stretch of killed text most recently killed OR yanked. Put point
4934 at the end, and set mark at the beginning without activating it.
4936 With argument N, reinsert the Nth most recent kill.
4938 This command honors the `yank-handled-properties' and
4939 `yank-excluded-properties' variables, and the `yank-handler' text
4940 property, as described below.
4942 Properties listed in `yank-handled-properties' are processed,
4943 then those listed in `yank-excluded-properties' are discarded.
4945 If STRING has a non-nil `yank-handler' property anywhere, the
4946 normal insert behavior is altered, and instead, for each contiguous
4947 segment of STRING that has a given value of the `yank-handler'
4948 property, that value is used as follows:
4950 The value of a `yank-handler' property must be a list of one to four
4951 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
4952 FUNCTION, if non-nil, should be a function of one argument (the
4953 object to insert); FUNCTION is called instead of `insert'.
4954 PARAM, if present and non-nil, is passed to FUNCTION (to be handled
4955 in whatever way is appropriate; e.g. if FUNCTION is `yank-rectangle',
4956 PARAM may be a list of strings to insert as a rectangle). If PARAM
4957 is nil, then the current segment of STRING is used.
4958 If NOEXCLUDE is present and non-nil, the normal removal of
4959 `yank-excluded-properties' is not performed; instead FUNCTION is
4960 responsible for the removal. This may be necessary if FUNCTION
4961 adjusts point before or after inserting the object.
4962 UNDO, if present and non-nil, should be a function to be called
4963 by `yank-pop' to undo the insertion of the current PARAM. It is
4964 given two arguments, the start and end of the region. FUNCTION
4965 may set `yank-undo-function' to override UNDO.
4970 ;; If we don't get all the way thru, make last-command indicate that
4971 ;; for the following command.
4979 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4980 ;; It is cleaner to avoid activation, even though the command
4981 ;; loop would deactivate the mark because we inserted text.
4984 ;; If we do get all the way thru, make this-command indicate that.
4987 nil)
4990 "Rotate the yanking point in the kill ring.
4991 With ARG, rotate that many kills forward (or backward, if negative)."
4994 \f
4995 ;; Some kill commands.
4997 ;; Internal subroutine of delete-char
5003 ;; Internal subroutine of backward-delete-char
5010 "The method for untabifying when deleting backward.
5011 Can be `untabify' -- turn a tab to many spaces, then delete one space;
5012 `hungry' -- delete all whitespace, both tabs and spaces;
5013 `all' -- delete all whitespace, including tabs, spaces and newlines;
5014 nil -- just delete one character."
5020 "Delete characters backward, changing tabs into spaces.
5021 The exact behavior depends on `backward-delete-char-untabify-method'.
5022 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
5023 Interactively, ARG is the prefix arg (default 1)
5024 and KILLP is t if a prefix arg was specified."
5047 arg)))
5048 ;; Avoid warning about delete-backward-char
5052 "Kill up to and including ARGth occurrence of CHAR.
5053 Case is ignored if `case-fold-search' is non-nil in the current buffer.
5054 Goes backward if ARG is negative; error if CHAR not found."
5057 ;; Avoid "obsolete" warnings for translation-table-for-input.
5065 ;; kill-line and its subroutines.
5068 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
5073 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
5074 With prefix argument ARG, kill that many lines from point.
5075 Negative arguments kill lines backward.
5076 With zero argument, kills the text before point on the current line.
5079 a number counts as a prefix arg.
5081 To kill a whole line, when point is not at the beginning, type \
5084 If `show-trailing-whitespace' is non-nil, this command will just
5085 kill the rest of the current line, even if there are no nonblanks
5086 there.
5088 If option `kill-whole-line' is non-nil, then this command kills the whole line
5089 including its terminating newline, when used at the beginning of a line
5090 with no argument. As a consequence, you can always kill a whole line
5093 If you want to append the killed line to the last killed text,
5096 If the buffer is read-only, Emacs will beep and refrain from deleting
5097 the line, but put the line in the kill ring anyway. This means that
5098 you can use this command to copy text from a read-only buffer.
5099 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5100 even beep.)"
5103 ;; It is better to move point to the other end of the kill
5104 ;; before killing. That way, in a read-only buffer, point
5105 ;; moves across the text that is copied to the kill ring.
5106 ;; The choice has no effect on undo now that undo records
5107 ;; the value of point from before the command was run.
5117 ;; If trailing whitespace is visible,
5118 ;; don't treat it as nothing.
5128 "Kill current line.
5129 With prefix ARG, kill that many lines starting from the current line.
5130 If ARG is negative, kill backward. Also kill the preceding newline.
5132 If ARG is zero, kill current line but exclude the trailing newline."
5143 ;; We need to kill in two steps, because the previous command
5144 ;; could have been a kill command, in which case the text
5145 ;; before point needs to be prepended to the current kill
5146 ;; ring entry and the text after point appended. Also, we
5147 ;; need to use save-excursion to avoid copying the same text
5148 ;; twice to the kill ring in read-only buffers.
5166 "Move forward by ARG lines, ignoring currently invisible newlines only.
5167 If ARG is negative, move backward -ARG lines.
5168 If ARG is zero, move to the beginning of the current line."
5175 ;; If the newline we just skipped is invisible,
5176 ;; don't count it.
5180 prop
5185 ;; If invisible text follows, and it is a number of complete lines,
5186 ;; skip it.
5192 prop
5208 ;; If the newline we just moved to is invisible,
5209 ;; don't count it.
5214 prop
5219 ;; If invisible text follows, and it is a number of complete lines,
5220 ;; skip it.
5226 prop
5237 nil)))
5240 "Move to end of current visible line."
5242 ;; If the following character is currently invisible,
5243 ;; skip all characters with that same `invisible' property value,
5244 ;; then find the next newline.
5251 prop
5262 "Kill the current buffer.
5263 When called in the minibuffer, get out of the minibuffer
5264 using `abort-recursive-edit'.
5266 This is like `kill-this-buffer', but it doesn't have to be invoked
5267 via the menu bar, and pays no attention to the menu-bar's frame."
5275 \f
5277 "Insert after point the contents of BUFFER.
5278 Puts mark after the inserted text.
5279 BUFFER may be a buffer or a buffer name."
5289 t))))
5294 nil)
5297 "Append to specified buffer the text of the region.
5298 It is inserted into that buffer before its point.
5300 When calling from a program, give three arguments:
5301 BUFFER (or buffer name), START and END.
5302 START and END specify the portion of the current buffer to be copied."
5309 point)
5320 "Prepend to specified buffer the text of the region.
5321 It is inserted into that buffer after its point.
5323 When calling from a program, give three arguments:
5324 BUFFER (or buffer name), START and END.
5325 START and END specify the portion of the current buffer to be copied."
5334 "Copy to specified buffer the text of the region.
5335 It is inserted into that buffer, replacing existing text there.
5337 When calling from a program, give three arguments:
5338 BUFFER (or buffer name), START and END.
5339 START and END specify the portion of the current buffer to be copied."
5347 \f
5351 "Hook run when the mark becomes active.
5352 It is also run at the end of a command, if the mark is active and
5359 "Return this buffer's mark value as integer, or nil if never set.
5361 In Transient Mark mode, this function signals an error if
5362 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5363 or the argument FORCE is non-nil, it disregards whether the mark
5364 is active, and returns an integer or nil in the usual way.
5366 If you are using this in an editing command, you are most likely making
5367 a mistake; see the documentation of `set-mark'."
5372 ;; Behind display-selections-p.
5375 "Deactivate the mark.
5376 If Transient Mark mode is disabled, this function normally does
5377 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5379 Deactivating the mark sets `mark-active' to nil, updates the
5380 primary selection according to `select-active-regions', and runs
5381 `deactivate-mark-hook'.
5383 If Transient Mark mode was temporarily enabled, reset the value
5384 of the variable `transient-mark-mode'; if this causes Transient
5385 Mark mode to be disabled, don't change `mark-active' to nil or
5386 run `deactivate-mark-hook'."
5390 select-active-regions)
5393 ;; The var `saved-region-selection', if non-nil, is the text in
5394 ;; the region prior to the last command modifying the buffer.
5395 ;; Set the selection to that, or to the current region.
5400 ;; If another program has acquired the selection, region
5401 ;; deactivation should not clobber it (Bug#11772).
5420 "Activate the mark.
5421 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5431 "Set this buffer's mark to POS. Don't use this function!
5432 That is to say, don't use this function unless you want
5433 the user to see that the mark has moved, and you want the previous
5434 mark position to be lost.
5436 Normally, when a new mark is set, the old one should go on the stack.
5437 This is why most applications should use `push-mark', not `set-mark'.
5439 Novice Emacs Lisp programmers often try to use the mark for the wrong
5440 purposes. The mark saves a location for the user's convenience.
5441 Most editing commands should not alter the mark.
5442 To remember a location for internal use in the Lisp program,
5443 store it in a Lisp variable. Example:
5445 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5450 ;; Normally we never clear mark-active except in Transient Mark mode.
5451 ;; But when we actually clear out the mark value too, we must
5452 ;; clear mark-active in any mode.
5454 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5455 ;; it should never be nil if the mark is nil.
5463 mark-active))
5470 ;; Mark marker
5476 ;; Mark active
5479 ;; If mark is active now, and either was not active or was at a
5480 ;; different place, run the activate hook.
5485 ;; If mark has ceased to be active, run deactivate hook.
5490 "Like `save-excursion', but also save and restore the mark state.
5491 This macro does what `save-excursion' did before Emacs 25.1."
5501 If nil, region-aware commands treat the empty region as inactive.
5502 If non-nil, region-aware commands treat the region as active as
5503 long as the mark is active, even if the region is empty.
5505 Region-aware commands are those that act on the region if it is
5506 active and Transient Mark mode is enabled, and on the text near
5507 point otherwise."
5513 "Return t if the region is active and it is appropriate to act on it.
5514 This is used by commands that act specially on the region under
5515 Transient Mark mode.
5517 The return value is t if Transient Mark mode is enabled and the
5518 mark is active; furthermore, if `use-empty-active-region' is nil,
5519 the region must not be empty. Otherwise, the return value is nil.
5521 For some commands, it may be appropriate to ignore the value of
5522 `use-empty-active-region'; in that case, use `region-active-p'."
5527 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5529 Some commands act specially on the region when Transient Mark
5530 mode is enabled. Usually, such commands should use
5531 `use-region-p' instead of this function, because `use-region-p'
5532 also checks the value of `use-empty-active-region'."
5534 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5535 ;; without the mark being set (e.g. bug#17324). We really should fix
5536 ;; that problem, but in the mean time, let's make sure we don't say the
5537 ;; region is active when there's no mark.
5541 "Return the boundaries of the region as a pair of positions.
5542 Value is a list of cons cells of the form (START . END)."
5546 "Return non-nil if the region contains several pieces.
5547 An example is a rectangular region handled as a list of
5548 separate contiguous regions for each line."
5561 ;; Normal priority so that a large region doesn't hide all the
5562 ;; overlays within it, but high secondary priority so that if it
5563 ;; ends/starts in the middle of a small overlay, that small overlay
5564 ;; won't hide the region's boundaries.
5566 nrol)
5571 rol)))
5587 start end window rol)))
5590 new))))))
5593 "Hook run just before redisplay.
5594 It is called in each window that is to be redisplayed. It takes one argument,
5595 which is the window that will be redisplayed. When run, the `current-buffer'
5616 "Maximum size of mark ring. Start discarding off end if gets this big."
5624 "Maximum size of global mark ring. \
5625 Start discarding off end if gets this big."
5630 "Jump to mark, and pop a new position for mark off the ring.
5631 \(Does not affect global mark ring)."
5641 "Set mark at where point is.
5642 If no prefix ARG and mark is already set there, just activate it.
5643 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5655 will pop the mark twice, and
5657 will pop the mark three times.
5665 "Set the mark where point is, and activate it; or jump to the mark.
5666 Setting the mark also alters the region, which is the text
5667 between point and mark; this is the closest equivalent in
5670 With no prefix argument, set the mark at point, and push the
5671 old mark position on local mark ring. Also push the new mark on
5672 global mark ring, if the previous mark was set in another buffer.
5674 When Transient Mark Mode is off, immediately repeating this
5675 command activates `transient-mark-mode' temporarily.
5678 jump to the mark, and set the mark from
5679 position popped off the local mark ring (this does not affect the global
5681 mark ring (see `pop-global-mark').
5683 If `set-mark-command-repeat-pop' is non-nil, repeating
5685 off the local (or global) mark ring and jumps there.
5688 argument, unconditionally set mark where point is, even if
5689 `set-mark-command-repeat-pop' is non-nil.
5691 Novice Emacs Lisp programmers often try to use the mark for the wrong
5692 purposes. See the documentation of `set-mark' for more information."
5712 arg)
5726 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5727 If the last global mark pushed was not in the current buffer,
5728 also push LOCATION on the global mark ring.
5729 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5731 Novice Emacs Lisp programmers often try to use the mark for the wrong
5732 purposes. See the documentation of `set-mark' for more information.
5734 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5741 ;; Now push the mark on the global mark ring.
5744 ;; The last global mark pushed was in this same buffer.
5745 ;; Don't push another one.
5746 nil
5755 nil)
5758 "Pop off mark ring into the buffer's actual mark.
5759 Does not set point. Does nothing if mark ring is empty."
5771 "Put the mark where point is now, and point where the mark is now.
5772 This command works even when the mark is not active,
5773 and it reactivates the mark.
5775 If Transient Mark mode is on, a prefix ARG deactivates the mark
5776 if it is active, and otherwise avoids reactivating it. If
5777 Transient Mark mode is off, a prefix ARG enables Transient Mark
5778 mode temporarily."
5792 nil))
5795 "When non-nil, shifted motion keys activate the mark momentarily.
5797 While the mark is activated in this way, any shift-translated point
5798 motion key extends the region, and if Transient Mark mode was off, it
5799 is temporarily turned on. Furthermore, the mark will be deactivated
5800 by any subsequent point motion key that was not shift-translated, or
5801 by any action that normally deactivates the mark in Transient Mark mode.
5803 See `this-command-keys-shift-translated' for the meaning of
5804 shift-translation."
5809 "Activate/deactivate mark depending on invocation thru shift translation.
5810 This function is called by `call-interactively' when a command
5811 with a `^' character in its `interactive' spec is invoked, before
5812 running the command itself.
5814 If `shift-select-mode' is enabled and the command was invoked
5815 through shift translation, set the mark and activate the region
5816 temporarily, unless it was already set in this way. See
5817 `this-command-keys-shift-translated' for the meaning of shift
5818 translation.
5820 Otherwise, if the region has been activated temporarily,
5821 deactivate it, and restore the variable `transient-mark-mode' to
5822 its earlier value."
5829 transient-mark-mode)))
5838 "Toggle Transient Mark mode.
5839 With a prefix argument ARG, enable Transient Mark mode if ARG is
5840 positive, and disable it otherwise. If called from Lisp, enable
5841 Transient Mark mode if ARG is omitted or nil.
5843 Transient Mark mode is a global minor mode. When enabled, the
5844 region is highlighted with the `region' face whenever the mark
5846 and after certain other operations that set the mark but whose
5847 main purpose is something else--for example, incremental search,
5853 Many commands change their behavior when Transient Mark mode is
5854 in effect and the mark is active, by acting on the region instead
5855 of their usual default part of the buffer's text. Examples of
5858 To see the documentation of commands which are sensitive to the
5861 :global t
5862 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5866 "Non-nil means it is ok for commands to call `widen' when they want to.
5867 Some commands will do this in order to go to positions outside
5868 the current accessible part of the buffer.
5870 If `widen-automatically' is nil, these commands will do something else
5874 "Whether the currently executing code is performing an essential task.
5875 This variable should be non-nil only when running code which should not
5876 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5877 user for a password when we are simply scanning a set of files in the
5878 background or displaying possible completions before the user even asked
5882 "Pop off global mark ring and jump to the top location."
5884 ;; Pop entries which refer to non-existent buffers.
5902 \f
5904 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5910 "Move cursor vertically down ARG lines.
5911 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5912 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5913 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5914 function will not vscroll.
5916 ARG defaults to 1.
5918 If there is no character in the target line exactly under the current column,
5919 the cursor is positioned after the character in that line which spans this
5920 column, or at the end of the line if it is not long enough.
5921 If there is no line in the buffer after this one, behavior depends on the
5922 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5923 to create a line, and moves the cursor to that line. Otherwise it moves the
5924 cursor to the end of the buffer.
5926 If the variable `line-move-visual' is non-nil, this command moves
5927 by display lines. Otherwise, it moves by buffer lines, without
5928 taking variable-width characters or continued lines into account.
5932 a semipermanent goal column for this command.
5933 Then instead of trying to move exactly vertically (or as close as possible),
5934 this command moves to the specified goal column (or as close as possible).
5935 The goal column is stored in the variable `goal-column', which is nil
5936 when there is no goal column. Note that setting `goal-column'
5937 overrides `line-move-visual' and causes this command to move by buffer
5938 lines rather than by display lines."
5944 ;; When adding a newline, don't expand an abbrev.
5955 nil)
5958 "Move cursor vertically up ARG lines.
5959 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5960 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5961 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5962 function will not vscroll.
5964 ARG defaults to 1.
5966 If there is no character in the target line exactly over the current column,
5967 the cursor is positioned after the character in that line which spans this
5968 column, or at the end of the line if it is not long enough.
5970 If the variable `line-move-visual' is non-nil, this command moves
5971 by display lines. Otherwise, it moves by buffer lines, without
5972 taking variable-width characters or continued lines into account.
5976 a semipermanent goal column for this command.
5977 Then instead of trying to move exactly vertically (or as close as possible),
5978 this command moves to the specified goal column (or as close as possible).
5979 The goal column is stored in the variable `goal-column', which is nil
5980 when there is no goal column. Note that setting `goal-column'
5981 overrides `line-move-visual' and causes this command to move by buffer
5982 lines rather than by display lines."
5993 nil)
5996 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5997 This means moving to the end of each line moved onto.
5998 The beginning of a blank line does not count as the end of a line.
5999 This has no effect when the variable `line-move-visual' is non-nil."
6005 A non-nil setting overrides the variable `line-move-visual', which see."
6012 "Current goal column for vertical motion.
6013 It is the column where point was at the start of the current run
6014 of vertical motion commands.
6016 When moving by visual lines via the function `line-move-visual', it is a cons
6017 cell (COL . HSCROLL), where COL is the x-position, in pixels,
6018 divided by the default column width, and HSCROLL is the number of
6019 columns by which window is scrolled from left margin.
6021 When the `track-eol' feature is doing its job, the value is
6025 "Last value of width used for displaying line numbers.
6029 "Non-nil means commands that move by lines ignore invisible newlines.
6030 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
6031 as if newlines that are invisible didn't exist, and count
6032 only visible newlines. Thus, moving across 2 newlines
6033 one of which is invisible will be counted as a one-line move.
6034 Also, a non-nil value causes invisible text to be ignored when
6035 counting columns for the purposes of keeping point in the same
6038 Outline mode sets this."
6043 "When non-nil, `line-move' moves point by visual lines.
6044 This movement is based on where the cursor is displayed on the
6045 screen, instead of relying on buffer contents alone. It takes
6046 into account variable-width characters and line continuation.
6047 If nil, `line-move' moves point by logical lines.
6048 A non-nil setting of `goal-column' overrides the value of this variable
6049 and forces movement by logical lines.
6050 A window that is horizontally scrolled also forces movement by logical
6051 lines."
6056 ;; Only used if display-graphic-p.
6060 "Return the height in pixels of the current buffer's default face font.
6062 If the default font is remapped (see `face-remapping-alist'), the
6063 function returns the height of the remapped face."
6067 ;; Avoid calling font-info if the frame's default font was
6068 ;; not changed since the frame was created. That's because
6069 ;; font-info is expensive for some fonts, see bug #14838.
6075 "Return the width in pixels of the current buffer's default face font.
6077 If the default font is remapped (see `face-remapping-alist'), the
6078 function returns the width of the remapped face."
6082 ;; Avoid calling font-info if the frame's default font was
6083 ;; not changed since the frame was created. That's because
6084 ;; font-info is expensive for some fonts, see bug #14838.
6089 width
6094 "Return the pixel height of current buffer's default-face text line.
6096 The value includes `line-spacing', if any, defined for the buffer
6097 or the frame."
6110 "Return the number of screen lines in the text area of the selected window.
6112 This is different from `window-text-height' in that this function counts
6113 lines in units of the height of the font used by the default face displayed
6114 in the window, not in units of the frame's default font, and also accounts
6115 for `line-spacing', if any, defined for the window's buffer or frame.
6117 The value is a floating-point number."
6122 ;; Returns non-nil if partial move was done.
6125 ;; Move backward (up).
6126 ;; If already vscrolled, reduce vscroll
6132 ;; Move forward (down).
6145 py vs last-line)
6165 col-row)
6170 ;; VPOS > 0 means the last line is only partially visible.
6171 ;; But if the part that is visible is at least as tall as the
6172 ;; default font, that means the line is actually fully
6173 ;; readable, and something like line-spacing is hidden. So in
6174 ;; that case we accept the last line in the window as still
6175 ;; visible, and consider the margin as starting one line
6176 ;; later.
6184 ;; If last line of window is fully visible, and vscrolling
6185 ;; more would make this line invisible, move forward.
6190 nil)
6191 ;; If cursor is not in the bottom scroll margin, and the
6192 ;; current line is not too tall, move forward.
6194 vpos
6197 nil)
6198 ;; When already vscrolled, we vscroll some more if we can,
6199 ;; or clear vscroll and move forward at end of tall image.
6204 ;; If cursor just entered the bottom scroll margin, move forward,
6205 ;; but also optionally vscroll one line so redisplay won't recenter.
6209 ;; Don't vscroll if the partially-visible line at window
6210 ;; bottom is not too tall (a.k.a. "just one more text
6211 ;; line"): in that case, we do want redisplay to behave
6212 ;; normally, i.e. recenter or whatever.
6213 ;;
6214 ;; Note: ROWH + RBOT from the value returned by
6215 ;; pos-visible-in-window-p give the total height of the
6216 ;; partially-visible glyph row at the end of the window. As
6217 ;; we are dealing with floats, we disregard sub-pixel
6218 ;; discrepancies between that and DLH.
6222 t)
6223 ;; If there are lines above the last line, scroll-up one line.
6226 t)
6227 ;; Finally, start vscroll.
6232 ;; This is like line-move-1 except that it also performs
6233 ;; vertical scrolling of tall images if appropriate.
6234 ;; That is not really a clean thing to do, since it mixes
6235 ;; scrolling with cursor motion. But so far we don't have
6236 ;; a cleaner solution to the problem of making C-n do something
6237 ;; useful given a tall image.
6239 "Move forward ARG lines.
6240 If NOERROR, don't signal an error if we can't move ARG lines.
6241 TO-END is unused.
6242 TRY-VSCROLL controls whether to vscroll tall lines: if either
6243 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6244 not vscroll."
6248 ;; Only vscroll for single line moves
6250 ;; Under scroll-conservatively, the display engine
6251 ;; does this better.
6253 ;; But don't vscroll in a keyboard macro.
6259 ;; Display-based column are incompatible with goal-column.
6261 ;; When the text in the window is scrolled to the left,
6262 ;; display-based motion doesn't make sense (because each
6263 ;; logical line occupies exactly one screen line).
6265 ;; Likewise when the text _was_ scrolled to the left
6266 ;; when the current run of vertical motion commands
6267 ;; started.
6270 auto-hscroll-mode
6272 (>= temporary-goal-column
6275 ;; If we moved into a tall line, set vscroll to make
6276 ;; scrolling through tall images more smooth.
6280 winh)
6286 nil
6290 ;; Display-based alternative to line-move-1.
6291 ;; Arg says how many lines to move. The value is t if we can move the
6292 ;; specified number of lines.
6294 "Move ARG lines forward.
6295 If NOERROR, don't signal an error if we can't move that many lines."
6299 target-hscroll)
6300 ;; Check if the previous command was a line-motion command, or if
6301 ;; we were called from some other command.
6304 ;; If so, there's no need to reset `temporary-goal-column',
6305 ;; but we may need to hscroll.
6310 ;; Update the COLUMN part of temporary-goal-column if the
6311 ;; line-number display changed its width since the last
6312 ;; time.
6319 ;; Otherwise, we should reset `temporary-goal-column'.
6321 x-pos)
6323 ;; Handle the `overflow-newline-into-fringe' case
6324 ;; (left-fringe is for the R2L case):
6329 ;; In R2L lines, the X pixel coordinate is measured from the
6330 ;; left edge of the window, but columns are still counted
6331 ;; from the logical-order beginning of the line, i.e. from
6332 ;; the right edge in this case. We need to adjust for that.
6338 hscroll)))
6340 ;; When we move beyond the first/last character visible in
6341 ;; the window, posn-at-point will return nil, so we need to
6342 ;; approximate the goal column as below.
6347 ;; vertical-motion can move more than it was asked to if it moves
6348 ;; across display strings with newlines. We don't want to ring
6349 ;; the bell and announce beginning/end of buffer in that case.
6355 temporary-goal-column))
6356 arg))
6357 arg))
6363 temporary-goal-column))
6364 arg))
6365 arg)))
6368 ;; If the goal column lies on a display string,
6369 ;; `vertical-motion' advances the cursor to the end
6370 ;; of the string. For arg < 0, this can cause the
6371 ;; cursor to get stuck. (Bug#3020).
6375 nil)))))
6377 ;; This is the guts of next-line and previous-line.
6378 ;; Arg says how many lines to move.
6379 ;; The value is t if we can move the specified number of lines.
6381 ;; Don't run any point-motion hooks, and disregard intangibility,
6382 ;; for intermediate positions.
6394 ;; Don't count beg of empty line as end of line
6395 ;; unless we just did explicit end-of-line.
6397 most-positive-fixnum
6401 line-move-ignore-invisible))
6402 ;; Use just newline characters.
6403 ;; Set ARG to 0 if we move as many lines as requested.
6406 ;; This way of moving forward ARG lines
6407 ;; verifies that we have a newline after the last one.
6408 ;; It doesn't get confused by intangible text.
6417 'beginning-of-buffer
6419 nil)))
6420 ;; Move by arg lines, but ignore invisible ones.
6423 ;; If the following character is currently invisible,
6424 ;; skip all characters with that same `invisible' property value.
6427 ;; Move a line.
6428 ;; We don't use `end-of-line', since we want to escape
6429 ;; from field boundaries occurring exactly at point.
6435 ;; If there's no invisibility here, move over the newline.
6444 ;; We avoid vertical-motion when possible
6445 ;; because that has to fontify.
6447 ;; Otherwise move a more sophisticated way.
6454 ;; The logic of this is the same as the loop above,
6455 ;; it just goes in the other direction.
6457 ;; For completely consistency with the forward-motion
6458 ;; case, we should call beginning-of-line here.
6459 ;; However, if point is inside a field and on a
6460 ;; continued line, the call to (vertical-motion -1)
6461 ;; below won't move us back far enough; then we return
6462 ;; to the same column in line-move-finish, and point
6463 ;; gets stuck -- cyd
6481 ;; if our target is the middle of this line.
6486 ;; This is the value the function returns.
6490 ;; If we did not move down as far as desired, at least go
6491 ;; to end of line. Be sure to call point-entered and
6492 ;; point-left-hooks.
6498 ;; If we did not move up as far as desired,
6499 ;; at least go to beginning of line.
6511 ;; Set REPEAT to t to repeat the whole thing.
6518 ;; Compute the end of the line
6519 ;; ignoring effectively invisible newlines.
6521 ;; Like end-of-line but ignores fields.
6528 ;; Move to the desired column.
6531 ;; Under line-move-visual, goal-column should be
6532 ;; interpreted in units of the frame's canonical character
6533 ;; width, which is exactly what vertical-motion does.
6537 ;; Corner case: suppose we start out in a field boundary in
6538 ;; the middle of a continued line. When we get to
6539 ;; line-move-finish, point is at the start of a new *screen*
6540 ;; line but the same text line; then line-move-to-column would
6541 ;; move us backwards. Test using C-n with point on the "x" in
6542 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6549 ;; Process intangibility within a line.
6550 ;; With inhibit-point-motion-hooks bound to nil, a call to
6551 ;; goto-char moves point past intangible text.
6553 ;; However, inhibit-point-motion-hooks controls both the
6554 ;; intangibility and the point-entered/point-left hooks. The
6555 ;; following hack avoids calling the point-* hooks
6556 ;; unnecessarily. Note that we move *forward* past intangible
6557 ;; text when the initial and final points are the same.
6562 ;; If intangibility moves us to a different (later) place
6563 ;; in the same line, use that as the destination.
6566 ;; If that position is "too late",
6567 ;; try the previous allowable position.
6568 ;; See if it is ok.
6571 ;; If going forward, don't accept the previous
6572 ;; allowable position if it is before the target line.
6574 ;; If going backward, don't accept the previous
6575 ;; allowable position if it is still after the target line.
6578 ;; As a last resort, use the end of the line.
6581 ;; Now move to the updated destination, processing fields
6582 ;; as well as intangibility.
6586 ;; Ignore field boundaries if the initial and final
6587 ;; positions have the same `field' property, even if the
6588 ;; fields are non-contiguous. This seems to be "nicer"
6589 ;; behavior in many situations.
6592 new
6596 ;; If all this moved us to a different line,
6597 ;; retry everything within that new line.
6599 ;; Repeat the intangibility and field processing.
6603 "Try to find column COL, considering invisibility.
6604 This function works only in certain cases,
6605 because what we really need is for `move-to-column'
6606 and `current-column' to be able to ignore invisible text."
6615 ;; If the following character is currently invisible,
6616 ;; skip all characters with that same `invisible' property value.
6620 ;; Have we advanced to a larger column position?
6622 ;; We have made some progress towards the desired column.
6623 ;; See if we can make any further progress.
6625 ;; Otherwise, go to the place we originally found
6626 ;; and move back over invisible text.
6627 ;; that will get us to the same place on the screen
6628 ;; but with a more reasonable buffer position.
6631 ;; We want the real line beginning, so it's consistent
6632 ;; with bolp below, otherwise we might infloop.
6639 "Move point to end of current line as displayed.
6640 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6641 If point reaches the beginning or end of buffer, it stops there.
6643 To ignore the effects of the `intangible' text or overlay
6644 property, bind `inhibit-point-motion-hooks' to t.
6645 If there is an image in the current line, this function
6646 disregards newlines that are part of the text on which the image
6647 rests."
6657 ;; With bidi reordering, we may not be at bol,
6658 ;; so make sure we are.
6673 ;; If we skipped something intangible and now we're not
6674 ;; really at eol, keep going.
6679 "Move point to beginning of current line as displayed.
6680 \(If there's an image in the line, this disregards newlines
6681 which are part of the text that the image rests on.)
6683 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6684 If point reaches the beginning or end of buffer, it stops there.
6685 \(But if the buffer doesn't end in a newline, it stops at the
6686 beginning of the last line.)
6687 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6692 first-vis first-vis-field-value)
6694 ;; Move by lines, if ARG is not 1 (the default).
6699 ;; Move to beginning-of-line, ignoring fields and invisible text.
6705 ;; Now find first visible char in the line.
6710 ;; See if fields would stop us from reaching FIRST-VIS.
6715 ;; If yes, obey them.
6716 first-vis-field-value
6717 ;; Otherwise, move to START with attention to fields.
6718 ;; (It is possible that fields never matter in this case.)
6723 ;; Many people have said they rarely use this feature, and often type
6724 ;; it by accident. Maybe it shouldn't even be on a key.
6729 Those commands will move to this position in the line moved to
6730 rather than trying to keep the same horizontal position.
6731 With a non-nil argument ARG, clears out the goal column
6733 The goal column is stored in the variable `goal-column'.
6734 This is a buffer-local setting."
6741 ;; The older method below can be erroneous if `set-goal-column' is bound
6742 ;; to a sequence containing %
6743 ;;(message (substitute-command-keys
6744 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6745 ;;goal-column)
6752 )
6753 nil)
6754 \f
6755 ;;; Editing based on visual lines, as opposed to logical lines.
6758 "Move point to end of current visual line.
6759 With argument N not nil or 1, move forward N - 1 visual lines first.
6760 If point reaches the beginning or end of buffer, it stops there.
6761 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6767 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6768 ;; constrain to field boundaries, so we don't either.
6772 "Move point to beginning of current visual line.
6773 With argument N not nil or 1, move forward N - 1 visual lines first.
6774 If point reaches the beginning or end of buffer, it stops there.
6775 \(But if the buffer doesn't end in a newline, it stops at the
6776 beginning of the last visual line.)
6777 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6785 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6789 "Kill the rest of the visual line.
6790 With prefix argument ARG, kill that many visual lines from point.
6791 If ARG is negative, kill visual lines backward.
6792 If ARG is zero, kill the text before point on the current visual
6793 line.
6795 If you want to append the killed line to the last killed text,
6798 If the buffer is read-only, Emacs will beep and refrain from deleting
6799 the line, but put the line in the kill ring anyway. This means that
6800 you can use this command to copy text from a read-only buffer.
6801 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6802 even beep.)"
6804 ;; Like in `kill-line', it's better to move point to the other end
6805 ;; of the kill before killing.
6813 ;; Skip any trailing whitespace at the end of the visual line.
6814 ;; We used to do this only if `show-trailing-whitespace' is
6815 ;; nil, but that's wrong; the correct thing would be to check
6816 ;; whether the trailing whitespace is highlighted. But, it's
6817 ;; OK to just do this unconditionally.
6824 "Move cursor vertically down ARG lines.
6825 This is identical to `next-line', except that it always moves
6826 by logical lines instead of visual lines, ignoring the value of
6827 the variable `line-move-visual'."
6834 "Move cursor vertically up ARG lines.
6835 This is identical to `previous-line', except that it always moves
6836 by logical lines instead of visual lines, ignoring the value of
6837 the variable `line-move-visual'."
6844 "Editing based on visual lines."
6853 ;; These keybindings interfere with xterm function keys. Are
6854 ;; there any other suitable bindings?
6855 ;; (define-key map "\M-[" 'previous-logical-line)
6856 ;; (define-key map "\M-]" 'next-logical-line)
6857 map))
6860 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6861 The value should be a list of the form (LEFT RIGHT), where LEFT
6862 and RIGHT are symbols representing the bitmaps to display, to
6863 indicate wrapped lines, in the left and right fringes respectively.
6864 See also `fringe-indicator-alist'.
6865 The default is not to display fringe indicators for wrapped lines.
6866 This variable does not affect fringe indicators displayed for
6867 other purposes."
6882 'continuation
6889 "Toggle visual line based editing (Visual Line mode) in the current buffer.
6890 Interactively, with a prefix argument, enable
6891 Visual Line mode if the prefix argument is positive,
6892 and disable it otherwise. If called from Lisp, toggle
6893 the mode if ARG is `toggle', disable the mode if ARG is
6894 a non-positive integer, and enable the mode otherwise
6895 \(including if ARG is omitted or nil or a positive integer).
6897 When Visual Line mode is enabled, `word-wrap' is turned on in
6898 this buffer, and simple editing commands are redefined to act on
6899 visual lines, not logical lines. See Info node `Visual Line
6900 Mode' for details."
6901 :keymap visual-line-mode-map
6907 ;; Save the local values of some variables, to be restored if
6908 ;; visual-line-mode is turned off.
6910 truncate-partial-width-windows
6911 word-wrap fringe-indicator-alist))
6914 visual-line--saved-state)))
6918 word-wrap t
6919 fringe-indicator-alist
6921 fringe-indicator-alist)))
6935 visual-line-mode turn-on-visual-line-mode)
6937 \f
6939 "Interchange characters around point, moving forward one character.
6940 With prefix arg ARG, effect is to take character before point
6941 and drag it forward past ARG other characters (backward if ARG negative).
6942 If no argument and at end of line, the previous two chars are exchanged."
6950 "Interchange words around point, leaving point at end of them.
6951 With prefix arg ARG, effect is to take word before or around point
6952 and drag it forward past ARG other words (backward if ARG negative).
6953 If ARG is zero, the words around or after point and around or after mark
6954 are interchanged."
6955 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6961 Unlike `transpose-words', point must be between the two sexps and not
6962 in the middle of a sexp to be transposed.
6963 With non-zero prefix arg ARG, effect is to take the sexp before point
6964 and drag it forward past ARG other sexps (backward if ARG is negative).
6965 If ARG is zero, the sexps ending at or after point and at or after mark
6966 are interchanged."
6970 ;; Here we should try to simulate the behavior of
6971 ;; (cons (progn (forward-sexp x) (point))
6972 ;; (progn (forward-sexp (- x)) (point)))
6973 ;; Except that we don't want to rely on the second forward-sexp
6974 ;; putting us back to where we want to be, since forward-sexp-function
6975 ;; might do funny things like infix-precedence.
6980 ;; Jumping over a symbol. We might be inside it, mind you.
6985 ;; Otherwise, we're between sexps. Take a step back before jumping
6986 ;; to make sure we'll obey the same precedence no matter which direction
6987 ;; we're going.
6992 'skip-syntax-forward
6999 "Exchange current line and previous line, leaving point after both.
7000 With argument ARG, takes previous line and moves it past ARG lines.
7001 With argument 0, interchanges line point is in with line mark is in."
7007 ;; Move forward over ARG lines,
7008 ;; but create newlines if necessary.
7015 arg))
7017 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
7018 ;; which seems inconsistent with the ARG /= 0 case.
7019 ;; FIXME document SPECIAL.
7021 "Subroutine to do the work of transposing objects.
7022 Works for lines, sentences, paragraphs, etc. MOVER is a function that
7023 moves forward by units of the given object (e.g. forward-sentence,
7024 forward-paragraph). If ARG is zero, exchanges the current object
7025 with the one containing mark. If ARG is an integer, moves the
7026 current object past ARG following (if ARG is positive) or
7027 preceding (if ARG is negative) objects, leaving point after the
7028 current object."
7033 pos1 pos2)
7062 ;; This sequence of insertions attempts to preserve marker
7063 ;; positions at the start and end of the transposed objects.
7077 \f
7079 "Move backward until encountering the beginning of a word.
7080 With argument ARG, do this that many times.
7081 If ARG is omitted or nil, move point backward one word.
7083 The word boundaries are normally determined by the buffer's syntax
7084 table, but `find-word-boundary-function-table', such as set up
7085 by `subword-mode', can change that. If a Lisp program needs to
7086 move by words determined strictly by the syntax table, it should
7087 use `backward-word-strictly' instead."
7092 "Set mark ARG words away from point.
7094 move to with the same argument.
7095 Interactively, if this command is repeated
7096 or (in Transient Mark mode) if the mark is active,
7097 it marks the next ARG words after the ones already marked."
7114 nil t))))
7117 "Kill characters forward until encountering the end of a word.
7118 With argument ARG, do this that many times."
7123 "Kill characters backward until encountering the beginning of a word.
7124 With argument ARG, do this that many times."
7129 "Return the word at or near point, as a string.
7130 The return value includes no text properties.
7132 If optional arg STRICT is non-nil, return nil unless point is
7133 within or adjacent to a word, otherwise look for a word within
7134 point's line. If there is no word anywhere on point's line, the
7135 value is nil regardless of STRICT.
7137 By default, this function treats as a single word any sequence of
7138 characters that have either word or symbol syntax. If optional
7139 arg REALLY-WORD is non-nil, only characters of word syntax can
7140 constitute a word."
7149 ;; Point is neither within nor adjacent to a word.
7151 ;; Look for preceding word in same line.
7154 ;; No preceding word in same line.
7155 ;; Look for following word in same line.
7164 ;; If we found something nonempty, return it as a string.
7167 \f
7169 "String for filling to insert at front of new line, or nil for none."
7171 string)
7177 "Regexp to match lines which should not be auto-filled."
7179 regexp)
7183 "The default value for `normal-auto-fill-function'.
7184 This is the default auto-fill function, some major modes use a different one.
7185 Returns t if it really did any work."
7195 nil ;; Auto-filling not required
7199 ;; Choose a fill-prefix automatically.
7207 ;; Use auto-indentation rather than a guessed empty prefix.
7213 ;; Determine where to split the line.
7217 ;; Don't split earlier in the line than the length of the
7218 ;; fill prefix, since the resulting line would be longer.
7226 ;; See whether the place we found is any good.
7230 ;; There is no use breaking at end of line.
7232 ;; Don't split right after a comment starter
7233 ;; since we would just make another comment starter.
7238 limit t)
7240 ;; No good place to break => stop trying.
7242 ;; Ok, we have a useful place to break the line. Do it.
7244 ;; If point is at the fill-point, do not `save-excursion'.
7245 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7246 ;; point will end up before it rather than after it.
7254 ;; Now do justification, if required
7259 ;; If making the new line didn't reduce the hpos of
7260 ;; the end of the line, then give up now;
7261 ;; trying again will not help.
7264 ;; Justify last line.
7266 t)))
7269 "Mode-specific function which line breaks and continues a comment.
7270 This function is called during auto-filling when a comment syntax
7271 is defined.
7272 The function should take a single optional argument, which is a flag
7276 "Break line at point and indent.
7277 If a comment syntax is defined, call `comment-indent-new-line'.
7279 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7280 unless optional argument SOFT is non-nil."
7284 ;; Insert the newline before removing empty space so that markers
7285 ;; get preserved better.
7291 ;; Blindly trust a non-adaptive fill-prefix.
7297 ;; If there's an adaptive prefix, use it unless we're inside
7298 ;; a comment and the prefix is not a comment starter.
7302 ;; If we're not inside a comment, just try to indent.
7306 "The function called by `self-insert-command' to perform auto-filling."
7313 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7317 ;; `functions' and `hooks' are usually unsafe to set, but setting
7318 ;; auto-fill-function to nil in a file-local setting is safe and
7319 ;; can be useful to prevent auto-filling.
7323 "Toggle automatic line breaking (Auto Fill mode).
7324 Interactively, with a prefix argument, enable
7325 Auto Fill mode if the prefix argument is positive,
7326 and disable it otherwise. If called from Lisp, toggle
7327 the mode if ARG is `toggle', disable the mode if ARG is
7328 a non-positive integer, and enable the mode otherwise
7329 \(including if ARG is omitted or nil or a positive integer).
7331 When Auto Fill mode is enabled, inserting a space at a column
7332 beyond `current-fill-column' automatically breaks the line at a
7333 previous space.
7335 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7336 non-nil.
7338 The value of `normal-auto-fill-function' specifies the function to use
7339 for `auto-fill-function' when turning Auto Fill mode on."
7344 ;; This holds a document string used to document auto-fill-mode.
7346 "Automatically break line at a previous space, in insertion of text."
7347 nil)
7350 "Unconditionally turn on Auto Fill mode."
7354 "Unconditionally turn off Auto Fill mode."
7360 "Set `fill-column' to specified argument.
7365 ;; We used to use current-column silently, but C-x f is too easily
7366 ;; typed as a typo for C-x C-f, so we turned it into an error and
7367 ;; now an interactive prompt.
7372 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7376 \f
7378 "Set `selective-display' to ARG; clear it if no arg.
7379 When the value of `selective-display' is a number > 0,
7380 lines whose indentation is >= that value are not displayed.
7381 The variable `selective-display' has a separate value for each buffer."
7401 "Toggle truncating of long lines for the current buffer.
7402 When truncating is off, long lines are folded.
7403 With prefix argument ARG, truncate long lines if ARG is positive,
7404 otherwise fold them. Note that in side-by-side windows, this
7405 command has no effect if `truncate-partial-width-windows' is
7406 non-nil."
7418 nil t)))
7423 "Toggle whether to use word-wrapping for continuation lines.
7424 With prefix argument ARG, wrap continuation lines at word boundaries
7425 if ARG is positive, otherwise wrap them at the right screen edge.
7426 This command toggles the value of `word-wrap'. It has no effect
7427 if long lines are truncated."
7443 "Toggle Overwrite mode.
7444 With a prefix argument ARG, enable Overwrite mode if ARG is
7445 positive, and disable it otherwise. If called from Lisp, enable
7446 the mode if ARG is omitted or nil.
7448 When Overwrite mode is enabled, printing characters typed in
7449 replace existing text on a one-for-one basis, rather than pushing
7450 it to the right. At the end of a line, such characters extend
7451 the line. Before a tab, such characters insert until the tab is
7453 overwrite mode; this is supposed to make it easier to insert
7454 characters when necessary."
7459 "Toggle Binary Overwrite mode.
7460 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7461 is positive, and disable it otherwise. If called from Lisp,
7462 enable the mode if ARG is omitted or nil.
7464 When Binary Overwrite mode is enabled, printing characters typed
7465 in replace existing text. Newlines are not treated specially, so
7466 typing at the end of a line joins the line to the next, with the
7467 typed character between them. Typing before a tab character
7468 simply replaces the tab with the character typed.
7470 ordinary typing characters do.
7472 Note that Binary Overwrite mode is not its own minor mode; it is
7473 a specialization of overwrite mode, entered by setting the
7474 `overwrite-mode' variable to `overwrite-mode-binary'."
7479 "Toggle line number display in the mode line (Line Number mode).
7480 With a prefix argument ARG, enable Line Number mode if ARG is
7481 positive, and disable it otherwise. If called from Lisp, enable
7482 the mode if ARG is omitted or nil.
7484 Line numbers do not appear for very large buffers and buffers
7485 with very long lines; see variables `line-number-display-limit'
7486 and `line-number-display-limit-width'."
7490 "Toggle column number display in the mode line (Column Number mode).
7491 With a prefix argument ARG, enable Column Number mode if ARG is
7492 positive, and disable it otherwise.
7494 If called from Lisp, enable the mode if ARG is omitted or nil."
7498 "Toggle buffer size display in the mode line (Size Indication mode).
7499 With a prefix argument ARG, enable Size Indication mode if ARG is
7500 positive, and disable it otherwise.
7502 If called from Lisp, enable the mode if ARG is omitted or nil."
7506 "Toggle auto-saving in the current buffer (Auto Save mode).
7507 With a prefix argument ARG, enable Auto Save mode if ARG is
7508 positive, and disable it otherwise.
7510 If called from Lisp, enable the mode if ARG is omitted or nil."
7512 ;; If auto-save is off because buffer has shrunk,
7513 ;; then toggling should turn it on.
7521 buffer-file-name)
7523 ;; If -1 was stored here, to temporarily turn off saving,
7524 ;; turn it back on.
7527 \f
7529 "Blinking matching of parens and expressions."
7534 "Non-nil means show matching open-paren when close-paren is inserted.
7535 If t, highlight the paren. If `jump', briefly move cursor to its
7536 position. If `jump-offscreen', move cursor there even if the
7537 position is off screen. With any other non-nil value, the
7538 off-screen position of the opening paren will be shown in the
7539 echo area."
7548 "Non-nil means show matching open-paren when it is on screen.
7549 If nil, don't show it (but the open-paren can still be shown
7550 in the echo area when it is off screen).
7552 This variable has no effect if `blink-matching-paren' is nil.
7553 \(In that case, the open-paren is never shown.)
7554 It is also ignored if `show-paren-mode' is enabled."
7559 "If non-nil, maximum distance to search backwards for matching open-paren.
7560 If nil, search stops at the beginning of the accessible portion of the buffer."
7566 "Time in seconds to delay after showing a matching paren."
7571 "If nil, `blink-matching-paren' ignores comments.
7572 More precisely, when looking for the matching parenthesis,
7573 it skips the contents of comments that end before point."
7578 "Return whether or not START...END are matching parens.
7579 END is the current point and START is the blink position.
7580 START might be nil if no matching starter was found.
7581 Returns non-nil if we find there is a mismatch."
7586 ;; For self-matched chars like " and $, we can't know when they're
7587 ;; mismatched or unmatched, so we can only do it for parens.
7592 ;; The cdr might hold a new paren-class info rather than
7593 ;; a matching-char info, in which case the two CDRs
7594 ;; should match.
7598 "Function to check parentheses mismatches.
7599 The function takes two arguments (START and END) where START is the
7600 position just before the opening token and END is the position right after.
7601 START can be nil, if it was not found.
7608 ol)
7612 "Momentarily highlight the beginning of the sexp before point."
7615 blink-matching-paren)
7625 oldpos))
7633 ;; backward-sexp skips backward over prefix chars,
7634 ;; so move back to the matching paren.
7657 ;; Matching open within window, temporarily move to or highlight
7658 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7659 ;; is non-nil.
7676 ;; Show what precedes the open in its line, if anything.
7681 ;; Show what follows the open in its line, if anything.
7688 ;; Otherwise show the previous nonblank line,
7689 ;; if there is one.
7698 ;; Replace the newline and other whitespace with `...'.
7699 "..."
7701 ;; There is nothing to show except the char itself.
7704 "Matches %s"
7708 "Function called, if non-nil, whenever a close parenthesis is inserted.
7714 blink-paren-function
7717 ;; Verify an even number of quoting characters precede the close.
7718 ;; FIXME: Also check if this parenthesis closes a comment as
7719 ;; can happen in Pascal and SML.
7730 ;; Most likely, this hook is nil, so this arg doesn't matter,
7731 ;; but I use it as a reminder that this function usually
7732 ;; likes to be run after others since it does
7733 ;; `sit-for'. That's also the reason it get a `priority' prop
7734 ;; of 100.
7736 \f
7737 ;; This executes C-g typed while Emacs is waiting for a command.
7738 ;; Quitting out of a program does not go through here;
7739 ;; that happens in the maybe_quit function at the C code level.
7741 "Signal a `quit' condition.
7742 During execution of Lisp code, this character causes a quit directly.
7743 At top-level, as an editor command, this simply beeps."
7745 ;; Avoid adding the region to the window selection.
7753 ;; Force the next redisplay cycle to remove the "Def" indicator from
7754 ;; all the mode lines.
7768 This command can exit an interactive command such as `query-replace',
7769 can clear out a prefix argument or a region,
7770 can get out of the minibuffer or other recursive edit,
7771 cancel the use of the current buffer (for special-purpose buffers),
7772 or go back to just one window (by deleting all but the selected window)."
7780 nil)
7791 "Play sound stored in FILE.
7792 VOLUME and DEVICE correspond to the keywords of the sound
7793 specification for `play-sound'."
7803 \f
7805 "Your preference for a mail reading package.
7806 This is used by some keybindings which support reading mail.
7807 See also `mail-user-agent' concerning sending mail."
7817 "Your preference for a mail composition package.
7818 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7819 outgoing email message. This variable lets you specify which
7820 mail-sending package you prefer.
7822 Valid values include:
7824 `message-user-agent' -- use the Message package.
7825 See Info node `(message)'.
7826 `sendmail-user-agent' -- use the Mail package.
7827 See Info node `(emacs)Sending Mail'.
7828 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7829 See Info node `(mh-e)'.
7830 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7831 paraphernalia if Gnus is running, particularly
7832 the Gcc: header for archiving.
7834 Additional valid symbols may be available; check with the author of
7835 your package for details. The function should return non-nil if it
7836 succeeds.
7838 See also `read-mail-command' concerning reading mail."
7841 message-user-agent)
7844 sendmail-user-agent)
7847 mh-e-user-agent)
7850 gnus-user-agent)
7856 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7857 If the value of `mail-user-agent' is the default, and the user
7858 appears to have customizations applying to the old default,
7859 `compose-mail' issues a warning."
7865 "If the buffer starts with a mail header, move point to the header's end.
7866 Otherwise, moves to `point-min'.
7867 The end of the header is the start of the next line, if there is one,
7868 else the end of the last line. This function obeys RFC822."
7874 ;; Used by Rmail (e.g., rmail-forward).
7876 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7880 switch-function yank-action send-actions
7881 return-action)
7882 "Start composing a mail message to send.
7883 This uses the user's chosen mail composition package
7884 as selected with the variable `mail-user-agent'.
7885 The optional arguments TO and SUBJECT specify recipients
7886 and the initial Subject field, respectively.
7888 OTHER-HEADERS is an alist specifying additional
7889 header fields. Elements look like (HEADER . VALUE) where both
7890 HEADER and VALUE are strings.
7892 CONTINUE, if non-nil, says to continue editing a message already
7893 being composed. Interactively, CONTINUE is the prefix argument.
7895 SWITCH-FUNCTION, if non-nil, is a function to use to
7896 switch to and display the buffer used for mail composition.
7898 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7899 to insert the raw text of the message being replied to.
7900 It has the form (FUNCTION . ARGS). The user agent will apply
7901 FUNCTION to ARGS, to insert the raw text of the original message.
7902 \(The user agent will also run `mail-citation-hook', *after* the
7903 original text has been inserted in this way.)
7905 SEND-ACTIONS is a list of actions to call when the message is sent.
7906 Each action has the form (FUNCTION . ARGS).
7908 RETURN-ACTION, if non-nil, is an action for returning to the
7909 caller. It has the form (FUNCTION . ARGS). The function is
7910 called after the mail has been sent or put aside, and the mail
7911 buffer buried."
7915 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7916 ;; from sendmail-user-agent to message-user-agent. Some users may
7917 ;; encounter incompatibilities. This hack tries to detect problems
7918 ;; and warn about them.
7923 mail-citation-hook mail-archive-file-name
7924 mail-default-reply-to mail-mailing-lists
7925 mail-self-blind))
7932 The default mail mode is now Message mode.
7933 You have the following Mail mode variable%s customized:
7935 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7942 yank-action send-actions return-action)))
7945 yank-action send-actions
7946 return-action)
7950 'switch-to-buffer-other-window yank-action send-actions
7951 return-action))
7954 yank-action send-actions
7955 return-action)
7959 'switch-to-buffer-other-frame yank-action send-actions
7960 return-action))
7962 \f
7964 "History of values entered with `set-variable'.
7966 Maximum length of the history list is determined by the value
7970 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7971 VARIABLE should be a user option variable name, a Lisp variable
7972 meant to be customized by users. You should enter VALUE in Lisp syntax,
7973 so if you want VALUE to be a string, you must surround it with doublequotes.
7974 VALUE is used literally, not evaluated.
7976 If VARIABLE has a `variable-interactive' property, that is used as if
7977 it were the arg to `interactive' (which see) to interactively read VALUE.
7979 If VARIABLE has been defined with `defcustom', then the type information
7980 in the definition is used to check that VALUE is valid.
7982 Note that this function is at heart equivalent to the basic `set' function.
7983 For a variable defined with `defcustom', it does not pay attention to
7984 any :set property that the variable might have (if you want that, use
7987 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7992 default-var)
8008 var obsolete)
8011 ;; Use VAR's `variable-interactive' property
8012 ;; as an interactive spec for prompting.
8015 arg))
8017 read-expression-map t
8018 'set-variable-value-history
8027 ;; Match with custom type.
8039 ;; Force a thorough redisplay for the case that the variable
8040 ;; has an effect on the display, like `tab-width' has.
8042 \f
8043 ;; Define the major mode for lists of completions.
8053 (define-key map [right] 'next-completion)
8055 (define-key map [backtab] 'previous-completion)
8056 (define-key map "q" 'quit-window)
8057 (define-key map "z" 'kill-current-buffer)
8058 map)
8059 "Local map for completion list buffers.")
8061 ;; Completion mode is suitable only for specially formatted data.
8062 (put 'completion-list-mode 'mode-class 'special)
8064 (defvar completion-reference-buffer nil
8065 "Record the buffer that was current when the completion list was requested.
8066 This is a local variable in the completion list buffer.
8067 Initial value is nil to avoid some compiler warnings.")
8069 (defvar completion-no-auto-exit nil
8070 "Non-nil means `choose-completion-string' should never exit the minibuffer.
8071 This also applies to other functions such as `choose-completion'.")
8073 (defvar completion-base-position nil
8074 "Position of the base of the text corresponding to the shown completions.
8075 This variable is used in the *Completions* buffers.
8076 Its value is a list of the form (START END) where START is the place
8077 where the completion should be inserted and END (if non-nil) is the end
8078 of the text to replace. If END is nil, point is used instead.")
8080 (defvar completion-list-insert-choice-function #'completion--replace
8081 "Function to use to insert the text chosen in *Completions*.
8082 Called with three arguments (BEG END TEXT), it should replace the text
8083 between BEG and END with TEXT. Expected to be set buffer-locally
8084 in the *Completions* buffer.")
8086 (defvar completion-base-size nil
8087 "Number of chars before point not involved in completion.
8088 This is a local variable in the completion list buffer.
8089 It refers to the chars in the minibuffer if completing in the
8090 minibuffer, or in `completion-reference-buffer' otherwise.
8091 Only characters in the field at point are included.
8093 If nil, Emacs determines which part of the tail end of the
8094 buffer's text is involved in completion by comparing the text
8095 directly.")
8096 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
8098 (defun delete-completion-window ()
8099 "Delete the completion list window.
8100 Go to the window from which completion was requested."
8101 (interactive)
8102 (let ((buf completion-reference-buffer))
8103 (if (one-window-p t)
8104 (if (window-dedicated-p) (delete-frame))
8105 (delete-window (selected-window))
8106 (if (get-buffer-window buf)
8107 (select-window (get-buffer-window buf))))))
8109 (defun previous-completion (n)
8110 "Move to the previous item in the completion list."
8111 (interactive "p")
8112 (next-completion (- n)))
8114 (defun next-completion (n)
8115 "Move to the next item in the completion list.
8116 With prefix argument N, move N items (negative N means move backward)."
8117 (interactive "p")
8118 (let ((beg (point-min)) (end (point-max)))
8119 (while (and (> n 0) (not (eobp)))
8120 ;; If in a completion, move to the end of it.
8121 (when (get-text-property (point) 'mouse-face)
8122 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8123 ;; Move to start of next one.
8124 (unless (get-text-property (point) 'mouse-face)
8125 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8126 (setq n (1- n)))
8127 (while (and (< n 0) (not (bobp)))
8128 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
8129 ;; If in a completion, move to the start of it.
8130 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
8131 (goto-char (previous-single-property-change
8132 (point) 'mouse-face nil beg)))
8133 ;; Move to end of the previous completion.
8134 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
8135 (goto-char (previous-single-property-change
8136 (point) 'mouse-face nil beg)))
8137 ;; Move to the start of that one.
8138 (goto-char (previous-single-property-change
8139 (point) 'mouse-face nil beg))
8140 (setq n (1+ n))))))
8142 (defun choose-completion (&optional event)
8143 "Choose the completion at point.
8144 If EVENT, use EVENT's position to determine the starting position."
8145 (interactive (list last-nonmenu-event))
8146 ;; In case this is run via the mouse, give temporary modes such as
8147 ;; isearch a chance to turn off.
8148 (run-hooks 'mouse-leave-buffer-hook)
8149 (with-current-buffer (window-buffer (posn-window (event-start event)))
8150 (let ((buffer completion-reference-buffer)
8151 (base-size completion-base-size)
8152 (base-position completion-base-position)
8153 (insert-function completion-list-insert-choice-function)
8154 (choice
8155 (save-excursion
8156 (goto-char (posn-point (event-start event)))
8157 (let (beg end)
8158 (cond
8159 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
8160 (setq end (point) beg (1+ (point))))
8161 ((and (not (bobp))
8162 (get-text-property (1- (point)) 'mouse-face))
8163 (setq end (1- (point)) beg (point)))
8164 (t (error "No completion here")))
8165 (setq beg (previous-single-property-change beg 'mouse-face))
8166 (setq end (or (next-single-property-change end 'mouse-face)
8167 (point-max)))
8168 (buffer-substring-no-properties beg end)))))
8170 (unless (buffer-live-p buffer)
8171 (error "Destination buffer is dead"))
8172 (quit-window nil (posn-window (event-start event)))
8174 (with-current-buffer buffer
8175 (choose-completion-string
8176 choice buffer
8177 (or base-position
8178 (when base-size
8179 ;; Someone's using old completion code that doesn't know
8180 ;; about base-position yet.
8181 (list (+ base-size (field-beginning))))
8182 ;; If all else fails, just guess.
8183 (list (choose-completion-guess-base-position choice)))
8184 insert-function)))))
8186 ;; Delete the longest partial match for STRING
8187 ;; that can be found before POINT.
8188 (defun choose-completion-guess-base-position (string)
8189 (save-excursion
8190 (let ((opoint (point))
8191 len)
8192 ;; Try moving back by the length of the string.
8193 (goto-char (max (- (point) (length string))
8194 (minibuffer-prompt-end)))
8195 ;; See how far back we were actually able to move. That is the
8196 ;; upper bound on how much we can match and delete.
8197 (setq len (- opoint (point)))
8198 (if completion-ignore-case
8199 (setq string (downcase string)))
8200 (while (and (> len 0)
8201 (let ((tail (buffer-substring (point) opoint)))
8202 (if completion-ignore-case
8203 (setq tail (downcase tail)))
8204 (not (string= tail (substring string 0 len)))))
8205 (setq len (1- len))
8206 (forward-char 1))
8207 (point))))
8209 (defun choose-completion-delete-max-match (string)
8210 (declare (obsolete choose-completion-guess-base-position "23.2"))
8211 (delete-region (choose-completion-guess-base-position string) (point)))
8213 (defvar choose-completion-string-functions nil
8214 "Functions that may override the normal insertion of a completion choice.
8215 These functions are called in order with three arguments:
8216 CHOICE - the string to insert in the buffer,
8217 BUFFER - the buffer in which the choice should be inserted,
8218 BASE-POSITION - where to insert the completion.
8220 If a function in the list returns non-nil, that function is supposed
8221 to have inserted the CHOICE in the BUFFER, and possibly exited
8222 the minibuffer; no further functions will be called.
8224 If all functions in the list return nil, that means to use
8225 the default method of inserting the completion in BUFFER.")
8227 (defun choose-completion-string (choice &optional
8228 buffer base-position insert-function)
8229 "Switch to BUFFER and insert the completion choice CHOICE.
8230 BASE-POSITION says where to insert the completion.
8231 INSERT-FUNCTION says how to insert the completion and falls
8232 back on `completion-list-insert-choice-function' when nil."
8234 ;; If BUFFER is the minibuffer, exit the minibuffer
8235 ;; unless it is reading a file name and CHOICE is a directory,
8236 ;; or completion-no-auto-exit is non-nil.
8238 ;; Some older code may call us passing `base-size' instead of
8239 ;; `base-position'. It's difficult to make any use of `base-size',
8240 ;; so we just ignore it.
8241 (unless (consp base-position)
8242 (message "Obsolete `base-size' passed to choose-completion-string")
8243 (setq base-position nil))
8245 (let* ((buffer (or buffer completion-reference-buffer))
8246 (mini-p (minibufferp buffer)))
8247 ;; If BUFFER is a minibuffer, barf unless it's the currently
8248 ;; active minibuffer.
8249 (if (and mini-p
8250 (not (and (active-minibuffer-window)
8251 (equal buffer
8252 (window-buffer (active-minibuffer-window))))))
8253 (error "Minibuffer is not active for completion")
8254 ;; Set buffer so buffer-local choose-completion-string-functions works.
8255 (set-buffer buffer)
8256 (unless (run-hook-with-args-until-success
8257 'choose-completion-string-functions
8258 ;; The fourth arg used to be `mini-p' but was useless
8259 ;; (since minibufferp can be used on the `buffer' arg)
8260 ;; and indeed unused. The last used to be `base-size', so we
8261 ;; keep it to try and avoid breaking old code.
8262 choice buffer base-position nil)
8263 ;; This remove-text-properties should be unnecessary since `choice'
8264 ;; comes from buffer-substring-no-properties.
8265 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8266 ;; Insert the completion into the buffer where it was requested.
8267 (funcall (or insert-function completion-list-insert-choice-function)
8268 (or (car base-position) (point))
8269 (or (cadr base-position) (point))
8270 choice)
8271 ;; Update point in the window that BUFFER is showing in.
8272 (let ((window (get-buffer-window buffer t)))
8273 (set-window-point window (point)))
8274 ;; If completing for the minibuffer, exit it with this choice.
8275 (and (not completion-no-auto-exit)
8276 (minibufferp buffer)
8277 minibuffer-completion-table
8278 ;; If this is reading a file name, and the file name chosen
8279 ;; is a directory, don't exit the minibuffer.
8280 (let* ((result (buffer-substring (field-beginning) (point)))
8281 (bounds
8282 (completion-boundaries result minibuffer-completion-table
8283 minibuffer-completion-predicate
8284 "")))
8285 (if (eq (car bounds) (length result))
8286 ;; The completion chosen leads to a new set of completions
8287 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8288 (let ((mini (active-minibuffer-window)))
8289 (select-window mini)
8290 (when minibuffer-auto-raise
8291 (raise-frame (window-frame mini))))
8292 (exit-minibuffer))))))))
8294 (define-derived-mode completion-list-mode nil "Completion List"
8295 "Major mode for buffers showing lists of possible completions.
8297 to select the completion near point.
8298 Or click to select one with the mouse.
8301 (set (make-local-variable 'completion-base-size) nil))
8303 (defun completion-list-mode-finish ()
8304 "Finish setup of the completions buffer.
8305 Called from `temp-buffer-show-hook'."
8306 (when (eq major-mode 'completion-list-mode)
8307 (setq buffer-read-only t)))
8309 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8312 ;; Variables and faces used in `completion-setup-function'.
8314 (defcustom completion-show-help t
8315 "Non-nil means show help message in *Completions* buffer."
8316 :type 'boolean
8317 :version "22.1"
8318 :group 'completion)
8320 ;; This function goes in completion-setup-hook, so that it is called
8321 ;; after the text of the completion list buffer is written.
8322 (defun completion-setup-function ()
8323 (let* ((mainbuf (current-buffer))
8324 (base-dir
8325 ;; FIXME: This is a bad hack. We try to set the default-directory
8326 ;; in the *Completions* buffer so that the relative file names
8327 ;; displayed there can be treated as valid file names, independently
8328 ;; from the completion context. But this suffers from many problems:
8329 ;; - It's not clear when the completions are file names. With some
8330 ;; completion tables (e.g. bzr revision specs), the listed
8331 ;; completions can mix file names and other things.
8332 ;; - It doesn't pay attention to possible quoting.
8333 ;; - With fancy completion styles, the code below will not always
8334 ;; find the right base directory.
8335 (if minibuffer-completing-file-name
8336 (file-name-as-directory
8337 (expand-file-name
8338 (buffer-substring (minibuffer-prompt-end)
8339 (- (point) (or completion-base-size 0))))))))
8340 (with-current-buffer standard-output
8341 (let ((base-size completion-base-size) ;Read before killing localvars.
8342 (base-position completion-base-position)
8343 (insert-fun completion-list-insert-choice-function))
8344 (completion-list-mode)
8345 (set (make-local-variable 'completion-base-size) base-size)
8346 (set (make-local-variable 'completion-base-position) base-position)
8347 (set (make-local-variable 'completion-list-insert-choice-function)
8348 insert-fun))
8349 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8350 (if base-dir (setq default-directory base-dir))
8351 ;; Maybe insert help string.
8352 (when completion-show-help
8353 (goto-char (point-min))
8354 (if (display-mouse-p)
8356 (insert (substitute-command-keys
8360 (add-hook 'completion-setup-hook 'completion-setup-function)
8362 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8363 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8365 (defun switch-to-completions ()
8366 "Select the completion list window."
8367 (interactive)
8368 (let ((window (or (get-buffer-window "*Completions*" 0)
8369 ;; Make sure we have a completions window.
8370 (progn (minibuffer-completion-help)
8371 (get-buffer-window "*Completions*" 0)))))
8372 (when window
8373 (select-window window)
8374 ;; In the new buffer, go to the first completion.
8375 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8376 (when (bobp)
8377 (next-completion 1)))))
8378 \f
8379 ;;; Support keyboard commands to turn on various modifiers.
8381 ;; These functions -- which are not commands -- each add one modifier
8382 ;; to the following event.
8384 (defun event-apply-alt-modifier (_ignore-prompt)
8387 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8388 (defun event-apply-super-modifier (_ignore-prompt)
8391 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8392 (defun event-apply-hyper-modifier (_ignore-prompt)
8395 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8396 (defun event-apply-shift-modifier (_ignore-prompt)
8399 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8400 (defun event-apply-control-modifier (_ignore-prompt)
8403 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8404 (defun event-apply-meta-modifier (_ignore-prompt)
8407 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8409 (defun event-apply-modifier (event symbol lshiftby prefix)
8410 "Apply a modifier flag to event EVENT.
8411 SYMBOL is the name of this modifier, as a symbol.
8412 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8413 PREFIX is the string that represents this modifier in an event type symbol."
8414 (if (numberp event)
8415 (cond ((eq symbol 'control)
8416 (if (and (<= (downcase event) ?z)
8417 (>= (downcase event) ?a))
8418 (- (downcase event) ?a -1)
8419 (if (and (<= (downcase event) ?Z)
8420 (>= (downcase event) ?A))
8421 (- (downcase event) ?A -1)
8422 (logior (lsh 1 lshiftby) event))))
8423 ((eq symbol 'shift)
8424 (if (and (<= (downcase event) ?z)
8425 (>= (downcase event) ?a))
8426 (upcase event)
8427 (logior (lsh 1 lshiftby) event)))
8428 (t
8429 (logior (lsh 1 lshiftby) event)))
8430 (if (memq symbol (event-modifiers event))
8431 event
8432 (let ((event-type (if (symbolp event) event (car event))))
8433 (setq event-type (intern (concat prefix (symbol-name event-type))))
8434 (if (symbolp event)
8435 event-type
8436 (cons event-type (cdr event)))))))
8438 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8439 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8440 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8441 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8442 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8443 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8444 \f
8445 ;;;; Keypad support.
8447 ;; Make the keypad keys act like ordinary typing keys. If people add
8448 ;; bindings for the function key symbols, then those bindings will
8449 ;; override these, so this shouldn't interfere with any existing
8450 ;; bindings.
8452 ;; Also tell read-char how to handle these keys.
8453 (mapc
8454 (lambda (keypad-normal)
8455 (let ((keypad (nth 0 keypad-normal))
8456 (normal (nth 1 keypad-normal)))
8457 (put keypad 'ascii-character normal)
8458 (define-key function-key-map (vector keypad) (vector normal))))
8459 ;; See also kp-keys bound in bindings.el.
8460 '((kp-space ?\s)
8463 (kp-separator ?,)
8464 (kp-equal ?=)
8465 ;; Do the same for various keys that are represented as symbols under
8466 ;; GUIs but naturally correspond to characters.
8467 (backspace 127)
8468 (delete 127)
8471 (clear ?\C-l)
8472 (return ?\C-m)
8473 (escape ?\e)
8474 ))
8475 \f
8476 ;;;;
8477 ;;;; forking a twin copy of a buffer.
8478 ;;;;
8480 (defvar clone-buffer-hook nil
8481 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8483 (defvar clone-indirect-buffer-hook nil
8484 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8486 (defun clone-process (process &optional newname)
8487 "Create a twin copy of PROCESS.
8488 If NEWNAME is nil, it defaults to PROCESS' name;
8489 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8490 If PROCESS is associated with a buffer, the new process will be associated
8491 with the current buffer instead.
8492 Returns nil if PROCESS has already terminated."
8493 (setq newname (or newname (process-name process)))
8495 (setq newname (substring newname 0 (match-beginning 0))))
8496 (when (memq (process-status process) '(run stop open))
8497 (let* ((process-connection-type (process-tty-name process))
8498 (new-process
8499 (if (memq (process-status process) '(open))
8500 (let ((args (process-contact process t)))
8501 (setq args (plist-put args :name newname))
8502 (setq args (plist-put args :buffer
8503 (if (process-buffer process)
8504 (current-buffer))))
8505 (apply 'make-network-process args))
8506 (apply 'start-process newname
8507 (if (process-buffer process) (current-buffer))
8508 (process-command process)))))
8509 (set-process-query-on-exit-flag
8510 new-process (process-query-on-exit-flag process))
8511 (set-process-inherit-coding-system-flag
8512 new-process (process-inherit-coding-system-flag process))
8513 (set-process-filter new-process (process-filter process))
8514 (set-process-sentinel new-process (process-sentinel process))
8515 (set-process-plist new-process (copy-sequence (process-plist process)))
8516 new-process)))
8518 ;; things to maybe add (currently partly covered by `funcall mode'):
8519 ;; - syntax-table
8520 ;; - overlays
8521 (defun clone-buffer (&optional newname display-flag)
8522 "Create and return a twin copy of the current buffer.
8523 Unlike an indirect buffer, the new buffer can be edited
8524 independently of the old one (if it is not read-only).
8525 NEWNAME is the name of the new buffer. It may be modified by
8526 adding or incrementing <N> at the end as necessary to create a
8527 unique buffer name. If nil, it defaults to the name of the
8528 current buffer, with the proper suffix. If DISPLAY-FLAG is
8529 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8530 clone a file-visiting buffer, or a buffer whose major mode symbol
8531 has a non-nil `no-clone' property, results in an error.
8533 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8534 current buffer with appropriate suffix. However, if a prefix
8535 argument is given, then the command prompts for NEWNAME in the
8536 minibuffer.
8538 This runs the normal hook `clone-buffer-hook' in the new buffer
8539 after it has been set up properly in other respects."
8540 (interactive
8541 (progn
8542 (if buffer-file-name
8543 (error "Cannot clone a file-visiting buffer"))
8544 (if (get major-mode 'no-clone)
8545 (error "Cannot clone a buffer in %s mode" mode-name))
8546 (list (if current-prefix-arg
8547 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8548 t)))
8549 (if buffer-file-name
8550 (error "Cannot clone a file-visiting buffer"))
8551 (if (get major-mode 'no-clone)
8552 (error "Cannot clone a buffer in %s mode" mode-name))
8553 (setq newname (or newname (buffer-name)))
8555 (setq newname (substring newname 0 (match-beginning 0))))
8556 (let ((buf (current-buffer))
8557 (ptmin (point-min))
8558 (ptmax (point-max))
8559 (pt (point))
8560 (mk (if mark-active (mark t)))
8561 (modified (buffer-modified-p))
8562 (mode major-mode)
8563 (lvars (buffer-local-variables))
8564 (process (get-buffer-process (current-buffer)))
8565 (new (generate-new-buffer (or newname (buffer-name)))))
8566 (save-restriction
8567 (widen)
8568 (with-current-buffer new
8569 (insert-buffer-substring buf)))
8570 (with-current-buffer new
8571 (narrow-to-region ptmin ptmax)
8572 (goto-char pt)
8573 (if mk (set-mark mk))
8574 (set-buffer-modified-p modified)
8576 ;; Clone the old buffer's process, if any.
8577 (when process (clone-process process))
8579 ;; Now set up the major mode.
8580 (funcall mode)
8582 ;; Set up other local variables.
8583 (mapc (lambda (v)
8584 (condition-case ()
8585 (if (symbolp v)
8586 (makunbound v)
8587 (set (make-local-variable (car v)) (cdr v)))
8588 (setting-constant nil))) ;E.g. for enable-multibyte-characters.
8589 lvars)
8591 (setq mark-ring (mapcar (lambda (mk) (copy-marker (marker-position mk)))
8592 mark-ring))
8594 ;; Run any hooks (typically set up by the major mode
8595 ;; for cloning to work properly).
8596 (run-hooks 'clone-buffer-hook))
8597 (if display-flag
8598 ;; Presumably the current buffer is shown in the selected frame, so
8599 ;; we want to display the clone elsewhere.
8600 (let ((same-window-regexps nil)
8601 (same-window-buffer-names))
8602 (pop-to-buffer new)))
8603 new))
8606 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8607 "Create an indirect buffer that is a twin copy of the current buffer.
8609 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8610 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8611 or if not called with a prefix arg, NEWNAME defaults to the current
8612 buffer's name. The name is modified by adding a `<N>' suffix to it
8613 or by incrementing the N in an existing suffix. Trying to clone a
8614 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8615 property results in an error.
8617 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8618 This is always done when called interactively.
8620 Optional third arg NORECORD non-nil means do not put this buffer at the
8621 front of the list of recently selected ones.
8623 Returns the newly created indirect buffer."
8624 (interactive
8625 (progn
8626 (if (get major-mode 'no-clone-indirect)
8627 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8628 (list (if current-prefix-arg
8629 (read-buffer "Name of indirect buffer: " (current-buffer)))
8630 t)))
8631 (if (get major-mode 'no-clone-indirect)
8632 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8633 (setq newname (or newname (buffer-name)))
8635 (setq newname (substring newname 0 (match-beginning 0))))
8636 (let* ((name (generate-new-buffer-name newname))
8637 (buffer (make-indirect-buffer (current-buffer) name t)))
8638 (with-current-buffer buffer
8639 (run-hooks 'clone-indirect-buffer-hook))
8640 (when display-flag
8641 (pop-to-buffer buffer nil norecord))
8642 buffer))
8645 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8646 "Like `clone-indirect-buffer' but display in another window."
8647 (interactive
8648 (progn
8649 (if (get major-mode 'no-clone-indirect)
8650 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8651 (list (if current-prefix-arg
8652 (read-buffer "Name of indirect buffer: " (current-buffer)))
8653 t)))
8654 (let ((pop-up-windows t))
8655 (clone-indirect-buffer newname display-flag norecord)))
8657 \f
8658 ;;; Handling of Backspace and Delete keys.
8660 (defcustom normal-erase-is-backspace 'maybe
8661 "Set the default behavior of the Delete and Backspace keys.
8663 If set to t, Delete key deletes forward and Backspace key deletes
8664 backward.
8666 If set to nil, both Delete and Backspace keys delete backward.
8668 If set to `maybe' (which is the default), Emacs automatically
8669 selects a behavior. On window systems, the behavior depends on
8670 the keyboard used. If the keyboard has both a Backspace key and
8671 a Delete key, and both are mapped to their usual meanings, the
8672 option's default value is set to t, so that Backspace can be used
8673 to delete backward, and Delete can be used to delete forward.
8675 If not running under a window system, customizing this option
8676 accomplishes a similar effect by mapping C-h, which is usually
8677 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8678 via `keyboard-translate'. The former functionality of C-h is
8679 available on the F1 key. You should probably not use this
8680 setting if you don't have both Backspace, Delete and F1 keys.
8682 Setting this variable with setq doesn't take effect. Programmatically,
8683 call `normal-erase-is-backspace-mode' (which see) instead."
8684 :type '(choice (const :tag "Off" nil)
8685 (const :tag "Maybe" maybe)
8686 (other :tag "On" t))
8687 :group 'editing-basics
8688 :version "21.1"
8689 :set (lambda (symbol value)
8690 ;; The fboundp is because of a problem with :set when
8691 ;; dumping Emacs. It doesn't really matter.
8692 (if (fboundp 'normal-erase-is-backspace-mode)
8693 (normal-erase-is-backspace-mode (or value 0))
8694 (set-default symbol value))))
8696 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8697 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8698 (unless frame (setq frame (selected-frame)))
8699 (with-selected-frame frame
8700 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8701 (normal-erase-is-backspace-mode
8702 (if (if (eq normal-erase-is-backspace 'maybe)
8703 (and (not noninteractive)
8704 (or (memq system-type '(ms-dos windows-nt))
8705 (memq window-system '(w32 ns))
8706 (and (memq window-system '(x))
8707 (fboundp 'x-backspace-delete-keys-p)
8708 (x-backspace-delete-keys-p))
8709 ;; If the terminal Emacs is running on has erase char
8710 ;; set to ^H, use the Backspace key for deleting
8711 ;; backward, and the Delete key for deleting forward.
8712 (and (null window-system)
8713 (eq tty-erase-char ?\^H))))
8714 normal-erase-is-backspace)
8715 1 0)))))
8717 (define-minor-mode normal-erase-is-backspace-mode
8718 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8719 With a prefix argument ARG, enable this feature if ARG is
8720 positive, and disable it otherwise. If called from Lisp, enable
8721 the mode if ARG is omitted or nil.
8723 On window systems, when this mode is on, Delete is mapped to C-d
8724 and Backspace is mapped to DEL; when this mode is off, both
8725 Delete and Backspace are mapped to DEL. (The remapping goes via
8726 `local-function-key-map', so binding Delete or Backspace in the
8727 global or local keymap will override that.)
8729 In addition, on window systems, the bindings of C-Delete, M-Delete,
8730 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8731 the global keymap in accordance with the functionality of Delete and
8732 Backspace. For example, if Delete is remapped to C-d, which deletes
8733 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8734 to DEL, which deletes backward, C-Delete is bound to
8735 `backward-kill-word'.
8737 If not running on a window system, a similar effect is accomplished by
8738 remapping C-h (normally produced by the Backspace key) and DEL via
8739 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8740 to C-d; if it's off, the keys are not remapped.
8742 When not running on a window system, and this mode is turned on, the
8743 former functionality of C-h is available on the F1 key. You should
8744 probably not turn on this mode on a text-only terminal if you don't
8745 have both Backspace, Delete and F1 keys.
8747 See also `normal-erase-is-backspace'."
8748 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8749 . (lambda (v)
8750 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8751 (if v 1 0))))
8752 (let ((enabled (eq 1 (terminal-parameter
8753 nil 'normal-erase-is-backspace))))
8755 (cond ((or (memq window-system '(x w32 ns pc))
8756 (memq system-type '(ms-dos windows-nt)))
8757 (let ((bindings
8758 `(([M-delete] [M-backspace])
8759 ([C-M-delete] [C-M-backspace])
8760 ([?\e C-delete] [?\e C-backspace]))))
8762 (if enabled
8763 (progn
8764 (define-key local-function-key-map [delete] [deletechar])
8765 (define-key local-function-key-map [kp-delete] [deletechar])
8766 (define-key local-function-key-map [backspace] [?\C-?])
8767 (dolist (b bindings)
8768 ;; Not sure if input-decode-map is really right, but
8769 ;; keyboard-translate-table (used below) only works
8770 ;; for integer events, and key-translation-table is
8771 ;; global (like the global-map, used earlier).
8772 (define-key input-decode-map (car b) nil)
8773 (define-key input-decode-map (cadr b) nil)))
8774 (define-key local-function-key-map [delete] [?\C-?])
8775 (define-key local-function-key-map [kp-delete] [?\C-?])
8776 (define-key local-function-key-map [backspace] [?\C-?])
8777 (dolist (b bindings)
8778 (define-key input-decode-map (car b) (cadr b))
8779 (define-key input-decode-map (cadr b) (car b))))))
8780 (t
8781 (if enabled
8782 (progn
8783 (keyboard-translate ?\C-h ?\C-?)
8784 (keyboard-translate ?\C-? ?\C-d))
8785 (keyboard-translate ?\C-h ?\C-h)
8786 (keyboard-translate ?\C-? ?\C-?))))
8788 (if (called-interactively-p 'interactive)
8789 (message "Delete key deletes %s"
8790 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8791 "forward" "backward")))))
8792 \f
8793 (defvar vis-mode-saved-buffer-invisibility-spec nil
8794 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8796 (define-minor-mode read-only-mode
8797 "Change whether the current buffer is read-only.
8798 With prefix argument ARG, make the buffer read-only if ARG is
8799 positive, otherwise make it writable. If buffer is read-only
8800 and `view-read-only' is non-nil, enter view mode.
8802 Do not call this from a Lisp program unless you really intend to
8804 possibly enabling or disabling View mode. Also, note that this
8805 command works by setting the variable `buffer-read-only', which
8806 does not affect read-only regions caused by text properties. To
8807 ignore read-only status in a Lisp program (whether due to text
8808 properties or buffer state), bind `inhibit-read-only' temporarily
8809 to a non-nil value."
8810 :variable buffer-read-only
8811 (cond
8812 ((and (not buffer-read-only) view-mode)
8813 (View-exit-and-edit)
8814 (make-local-variable 'view-read-only)
8815 (setq view-read-only t)) ; Must leave view mode.
8816 ((and buffer-read-only view-read-only
8817 ;; If view-mode is already active, `view-mode-enter' is a nop.
8818 (not view-mode)
8819 (not (eq (get major-mode 'mode-class) 'special)))
8820 (view-mode-enter))))
8822 (define-minor-mode visible-mode
8823 "Toggle making all invisible text temporarily visible (Visible mode).
8824 With a prefix argument ARG, enable Visible mode if ARG is
8825 positive, and disable it otherwise. If called from Lisp, enable
8826 the mode if ARG is omitted or nil.
8828 This mode works by saving the value of `buffer-invisibility-spec'
8829 and setting it to nil."
8830 :lighter " Vis"
8831 :group 'editing-basics
8832 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8833 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8834 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8835 (when visible-mode
8836 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8837 buffer-invisibility-spec)
8838 (setq buffer-invisibility-spec nil)))
8839 \f
8840 (defvar messages-buffer-mode-map
8841 (let ((map (make-sparse-keymap)))
8842 (set-keymap-parent map special-mode-map)
8843 (define-key map "g" nil) ; nothing to revert
8844 map))
8846 (define-derived-mode messages-buffer-mode special-mode "Messages"
8849 (defun messages-buffer ()
8851 If it does not exist, create and it switch it to `messages-buffer-mode'."
8852 (or (get-buffer "*Messages*")
8853 (with-current-buffer (get-buffer-create "*Messages*")
8854 (messages-buffer-mode)
8855 (current-buffer))))
8857 \f
8858 ;; Minibuffer prompt stuff.
8860 ;;(defun minibuffer-prompt-modification (start end)
8861 ;; (error "You cannot modify the prompt"))
8862 ;;
8863 ;;
8864 ;;(defun minibuffer-prompt-insertion (start end)
8865 ;; (let ((inhibit-modification-hooks t))
8866 ;; (delete-region start end)
8867 ;; ;; Discard undo information for the text insertion itself
8868 ;; ;; and for the text deletion.above.
8869 ;; (when (consp buffer-undo-list)
8870 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8871 ;; (message "You cannot modify the prompt")))
8872 ;;
8873 ;;
8874 ;;(setq minibuffer-prompt-properties
8875 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8876 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8878 \f
8879 ;;;; Problematic external packages.
8881 ;; rms says this should be done by specifying symbols that define
8882 ;; versions together with bad values. This is therefore not as
8883 ;; flexible as it could be. See the thread:
8884 ;; https://lists.gnu.org/r/emacs-devel/2007-08/msg00300.html
8885 (defconst bad-packages-alist
8886 ;; Not sure exactly which semantic versions have problems.
8887 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8889 "The version of `semantic' loaded does not work in Emacs 22.
8890 It can cause constant high CPU load.
8891 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8892 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8893 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8894 ;; provided the `CUA-mode' feature. Since this is no longer true,
8895 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8896 (CUA-mode t nil
8897 "CUA-mode is now part of the standard GNU Emacs distribution,
8898 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8900 You have loaded an older version of CUA-mode which does not work
8901 correctly with this version of Emacs. You should remove the old
8902 version and use the one distributed with Emacs."))
8903 "Alist of packages known to cause problems in this version of Emacs.
8904 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8905 PACKAGE is either a regular expression to match file names, or a
8906 symbol (a feature name), like for `with-eval-after-load'.
8907 SYMBOL is either the name of a string variable, or t. Upon
8908 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8909 warning using STRING as the message.")
8911 (defun bad-package-check (package)
8912 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8913 (condition-case nil
8914 (let* ((list (assoc package bad-packages-alist))
8915 (symbol (nth 1 list)))
8916 (and list
8917 (boundp symbol)
8918 (or (eq symbol t)
8919 (and (stringp (setq symbol (eval symbol)))
8920 (string-match-p (nth 2 list) symbol)))
8921 (display-warning package (nth 3 list) :warning)))
8922 (error nil)))
8924 (dolist (elem bad-packages-alist)
8925 (let ((pkg (car elem)))
8926 (with-eval-after-load pkg
8927 (bad-package-check pkg))))
8929 \f
8930 ;;; Generic dispatcher commands
8932 ;; Macro `define-alternatives' is used to create generic commands.
8933 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8934 ;; that can have different alternative implementations where choosing
8935 ;; among them is exclusively a matter of user preference.
8937 ;; (define-alternatives COMMAND) creates a new interactive command
8938 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8939 ;; Typically, the user will not need to customize this variable; packages
8940 ;; wanting to add alternative implementations should use
8941 ;;
8942 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8944 (defmacro define-alternatives (command &rest customizations)
8945 "Define the new command `COMMAND'.
8947 The argument `COMMAND' should be a symbol.
8949 Running `M-x COMMAND RET' for the first time prompts for which
8950 alternative to use and records the selected command as a custom
8951 variable.
8953 Running `C-u M-x COMMAND RET' prompts again for an alternative
8954 and overwrites the previous choice.
8956 The variable `COMMAND-alternatives' contains an alist with
8957 alternative implementations of COMMAND. `define-alternatives'
8958 does not have any effect until this variable is set.
8960 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8961 `defcustom' keywords and values to add to the declaration of
8962 `COMMAND-alternatives' (typically :group and :version)."
8963 (let* ((command-name (symbol-name command))
8964 (varalt-name (concat command-name "-alternatives"))
8965 (varalt-sym (intern varalt-name))
8966 (varimp-sym (intern (concat command-name "--implementation"))))
8967 `(progn
8969 (defcustom ,varalt-sym nil
8970 ,(format "Alist of alternative implementations for the `%s' command.
8972 Each entry must be a pair (ALTNAME . ALTFUN), where:
8973 ALTNAME - The name shown at user to describe the alternative implementation.
8974 ALTFUN - The function called to implement this alternative."
8975 command-name)
8976 :type '(alist :key-type string :value-type function)
8977 ,@customizations)
8979 (put ',varalt-sym 'definition-name ',command)
8980 (defvar ,varimp-sym nil "Internal use only.")
8982 (defun ,command (&optional arg)
8983 ,(format "Run generic command `%s'.
8984 If used for the first time, or with interactive ARG, ask the user which
8985 implementation to use for `%s'. The variable `%s'
8986 contains the list of implementations currently supported for this command."
8987 command-name command-name varalt-name)
8988 (interactive "P")
8989 (when (or arg (null ,varimp-sym))
8990 (let ((val (completing-read
8991 ,(format-message
8992 "Select implementation for command `%s': "
8993 command-name)
8994 ,varalt-sym nil t)))
8995 (unless (string-equal val "")
8996 (when (null ,varimp-sym)
8997 (message
8998 "Use C-u M-x %s RET`to select another implementation"
8999 ,command-name)
9000 (sit-for 3))
9001 (customize-save-variable ',varimp-sym
9002 (cdr (assoc-string val ,varalt-sym))))))
9003 (if ,varimp-sym
9004 (call-interactively ,varimp-sym)
9005 (message "%s" ,(format-message
9006 "No implementation selected for command `%s'"
9007 command-name)))))))
9009 \f
9010 ;;; Functions for changing capitalization that Do What I Mean
9011 (defun upcase-dwim (arg)
9012 "Upcase words in the region, if active; if not, upcase word at point.
9013 If the region is active, this function calls `upcase-region'.
9014 Otherwise, it calls `upcase-word', with prefix argument passed to it
9015 to upcase ARG words."
9016 (interactive "*p")
9017 (if (use-region-p)
9018 (upcase-region (region-beginning) (region-end) (region-noncontiguous-p))
9019 (upcase-word arg)))
9021 (defun downcase-dwim (arg)
9022 "Downcase words in the region, if active; if not, downcase word at point.
9023 If the region is active, this function calls `downcase-region'.
9024 Otherwise, it calls `downcase-word', with prefix argument passed to it
9025 to downcase ARG words."
9026 (interactive "*p")
9027 (if (use-region-p)
9028 (downcase-region (region-beginning) (region-end) (region-noncontiguous-p))
9029 (downcase-word arg)))
9031 (defun capitalize-dwim (arg)
9032 "Capitalize words in the region, if active; if not, capitalize word at point.
9033 If the region is active, this function calls `capitalize-region'.
9034 Otherwise, it calls `capitalize-word', with prefix argument passed to it
9035 to capitalize ARG words."
9036 (interactive "*p")
9037 (if (use-region-p)
9038 (capitalize-region (region-beginning) (region-end))
9039 (capitalize-word arg)))
9041 \f
9043 (provide 'simple)
9045 ;;; simple.el ends here