| blob | 5ef511ce0a0bac365f6db8bd789729cd4c5a60c4 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2017 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "If non-nil, output buffer is not erased between shell commands.
42 Also, a non-nil value sets the point in the output buffer
43 once the command completes.
44 The value `beg-last-out' sets point at the beginning of the output,
45 `end-last-out' sets point at the end of the buffer, `save-point'
46 restores the buffer position before the command."
56 "Position of point in the output buffer after command completes.
57 It is a cons cell of the form (BUFFER . POS), where BUFFER is the output
58 buffer, and POS is the point position in BUFFER once the command finishes.
62 "Idle time delay before updating various things on the screen.
63 Various Emacs features that update auxiliary information when point moves
64 wait this many seconds after Emacs becomes idle before doing an update."
70 "Killing and yanking commands."
74 "Highlight (un)matching of parens and expressions."
76 \f
77 ;;; next-error support framework
80 "`next-error' support framework."
86 "Face used to highlight next error locus."
91 "Highlighting of locations in selected source buffers.
92 If a number, highlight the locus in `next-error' face for the given time
93 in seconds, or until the next command is executed.
94 If t, highlight the locus until the next command is executed, or until
95 some other locus replaces it.
96 If nil, don't highlight the locus in the source buffer.
97 If `fringe-arrow', indicate the locus by the fringe arrow
98 indefinitely until some other locus replaces it."
107 "Highlighting of locations in `next-error-no-select'.
108 If number, highlight the locus in `next-error' face for given time in seconds.
109 If t, highlight the locus indefinitely until some other locus replaces it.
110 If nil, don't highlight the locus in the source buffer.
111 If `fringe-arrow', indicate the locus by the fringe arrow
112 indefinitely until some other locus replaces it."
121 "Display the line in the visited source file recentered as specified.
122 If non-nil, the value is passed directly to `recenter'."
130 "List of hook functions run by `next-error' after visiting source file."
141 "The most recent `next-error' buffer.
142 A buffer becomes most recent when its compilation, grep, or
147 "Function to use to find the next error in the current buffer.
148 The function is called with 2 parameters:
149 ARG is an integer specifying by how many errors to move.
150 RESET is a boolean which, if non-nil, says to go back to the beginning
151 of the errors before moving.
152 Major modes providing compile-like functionality should set this variable
153 to indicate to `next-error' that this is a candidate buffer and how
158 "Function to use to move to an error locus.
159 It takes two arguments, a buffer position in the error buffer
160 and a buffer position in the error locus buffer.
161 The buffer for the error locus should already be current.
166 &optional avoid-current
167 extra-test-inclusive
168 extra-test-exclusive)
169 "Return non-nil if BUFFER is a `next-error' capable buffer.
170 If AVOID-CURRENT is non-nil, and BUFFER is the current buffer,
171 return nil.
173 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if
174 BUFFER would not normally qualify. If it returns non-nil, BUFFER
175 is considered `next-error' capable, anyway, and the function
176 returns non-nil.
178 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the
179 buffer would normally qualify. If it returns nil, BUFFER is
180 rejected, and the function returns nil."
185 ;; Optionally reject some buffers.
188 t)
189 ;; Optionally accept some other buffers.
194 extra-test-inclusive
195 extra-test-exclusive)
196 "Return a `next-error' capable buffer.
198 If AVOID-CURRENT is non-nil, treat the current buffer
199 as an absolute last resort only.
201 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
202 that normally would not qualify. If it returns t, the buffer
203 in question is treated as usable.
205 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
206 that would normally be considered usable. If it returns nil,
207 that buffer is rejected."
209 ;; 1. If one window on the selected frame displays such buffer, return it.
215 avoid-current
216 extra-test-inclusive extra-test-exclusive)
221 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
224 extra-test-inclusive extra-test-exclusive))
225 next-error-last-buffer)
226 ;; 3. If the current buffer is acceptable, choose it.
228 extra-test-inclusive extra-test-exclusive)
230 ;; 4. Look for any acceptable buffer.
235 extra-test-inclusive extra-test-exclusive)))
238 ;; 5. Use the current buffer as a last resort if it qualifies,
239 ;; even despite AVOID-CURRENT.
242 extra-test-inclusive extra-test-exclusive)
246 ;; 6. Give up.
250 "Visit next `next-error' message and corresponding source code.
252 If all the error messages parsed so far have been processed already,
253 the message buffer is checked for new ones.
255 A prefix ARG specifies how many error messages to move;
256 negative means move back to previous error messages.
258 and start at the first error.
260 The RESET argument specifies that we should restart from the beginning.
263 compilation, grep, or occur buffer. It can also operate on any
265 more generally, on any buffer in Compilation mode or with
266 Compilation Minor mode enabled, or any buffer in which
267 `next-error-function' is bound to an appropriate function.
268 To specify use of a particular buffer for error messages, type
270 in the current frame.
273 runs `next-error-hook' with `run-hooks', and stays with that buffer
274 until you use it in some other buffer which uses Compilation mode
275 or Compilation Minor mode.
277 To control which errors are matched, customize the variable
278 `compilation-error-regexp-alist'."
282 ;; we know here that next-error-function is a valid symbol we can funcall
290 "Visit the source code corresponding to the `next-error' message at point."
292 ;; we know here that next-error-function is a valid symbol we can funcall
303 "Visit previous `next-error' message and corresponding source code.
305 Prefix arg N says how many error messages to move backwards (or
306 forwards, if negative).
313 "Restart at the first error.
314 Visit corresponding source code.
315 With prefix arg N, visit the source code of the Nth error.
321 "Move point to the next error in the `next-error' buffer and highlight match.
322 Prefix arg N says how many error messages to move forwards (or
323 backwards, if negative).
325 select the source buffer."
332 "Move point to the previous error in the `next-error' buffer and highlight match.
333 Prefix arg N says how many error messages to move backwards (or
334 forwards, if negative).
336 select the source buffer."
340 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
344 "Minor mode for compilation, occur and diff modes.
345 With a prefix argument ARG, enable mode if ARG is positive, and
346 disable it otherwise. If called from Lisp, enable mode if ARG is
347 omitted or nil.
348 When turned on, cursor motion in the compilation, grep, occur or diff
349 buffer causes automatic display of the corresponding source code location."
356 ;; Used as a `post-command-hook' by `next-error-follow-mode'
357 ;; for the *Compilation* *grep* and *Occur* buffers.
367 \f
368 ;;;
371 "Major mode not specialized for anything in particular.
372 Other major modes are defined by comparison with this one."
377 ;; Special major modes to view specially formatted data rather than files.
391 map))
395 "Parent major mode from which special major modes should inherit."
398 ;; Making and deleting lines.
401 "Special hook to tell if `self-insert-command' will use the region.
402 It must be called via `run-hook-with-args-until-success' with no arguments.
403 Any `post-self-insert-command' which consumes the region should
404 register a function on this hook so that things like `delete-selection-mode'
411 "Insert a newline, and move to left margin of the new line if it's blank.
412 If option `use-hard-newlines' is non-nil, the newline is marked with the
413 text-property `hard'.
414 With ARG, insert that many newlines.
416 If `electric-indent-mode' is enabled, this indents the final new line
417 that it adds, and reindents the preceding line. To just insert
420 Calls `auto-fill-function' if the current column number is greater
421 than the value of `fill-column' and ARG is nil.
422 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
425 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
426 ;; Set last-command-event to tell self-insert what to insert.
430 ;; Don't auto-fill if we have a numeric argument.
434 ;; Do the rest in post-self-insert-hook, because we want to do it
435 ;; *before* other functions on that hook.
437 ;; Mark the newline(s) `hard'.
441 ;; If the newline leaves the previous line blank, and we
442 ;; have a left margin, delete that from the blank line.
450 ;; Indent the line after the newline, except in one case:
451 ;; when we added the newline at the beginning of a line which
452 ;; starts a page.
456 ;; FIXME: For non-interactive uses, many calls actually
457 ;; just want (insert "\n"), so maybe we should do just
458 ;; that, so as to avoid the risk of filling or running
459 ;; abbrevs unexpectedly.
466 ;; We first used let-binding to protect the hook, but that
467 ;; was naive since add-hook affects the symbol-default
468 ;; value of the variable, whereas the let-binding might
469 ;; only protect the buffer-local value.
471 nil)
476 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
482 "Insert a newline and leave point before it.
483 If there is a fill prefix and/or a `left-margin', insert them on
484 the new line if the line would have been blank.
485 With arg N, insert N newlines."
490 ;; Don't expand an abbrev before point.
501 ;; Necessary in case a margin or prefix was inserted.
505 "Split current line, moving portion beyond point vertically down.
506 If the current line starts with `fill-prefix', insert it on the new
507 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
509 When called from Lisp code, ARG may be a prefix string to copy."
514 ;; What prefix should we check for (nil means don't).
518 ;; Does this line start with it?
529 "Join this line to previous and fix up whitespace at join.
530 If there is a fill prefix, delete it from the beginning of this line.
531 With argument, join this line to following line."
538 ;; If the second line started with the fill prefix,
539 ;; delete the prefix.
551 "On blank line, delete all surrounding blank lines, leaving just one.
552 On isolated blank line, delete that one.
553 On nonblank line, delete any immediately following blank lines."
559 ;; Set singleblank if there is just one blank line here.
566 ;; Delete preceding blank lines, and this one too if it's the only one.
575 ;; Delete following blank lines, unless the current line is blank
576 ;; and there are no following blank lines.
585 ;; Handle the special case where point is followed by newline and eob.
586 ;; Delete the line, leaving point at eob.
592 Trailing lines are deleted only if `delete-trailing-whitespace'
593 is called on the entire buffer (rather than an active region)."
599 "Return non-nil if the region contains no read-only text."
604 "Delete trailing whitespace between START and END.
605 If called interactively, START and END are the start/end of the
606 region if the mark is active, or of the buffer's accessible
607 portion if the mark is inactive.
609 This command deletes whitespace characters after the last
610 non-whitespace character in each line between START and END. It
611 does not consider formfeed characters to be whitespace.
613 If this command acts on the entire buffer (i.e. if called
614 interactively with the mark inactive, or called from Lisp with
615 END nil), it also deletes all trailing lines at the end of the
616 buffer if the variable `delete-trailing-lines' is non-nil."
627 ;; Don't delete formfeeds, even if they are considered whitespace.
636 ;; Delete trailing empty lines.
638 ;; Really the end of buffer.
643 ;; Return nil for the benefit of `write-file-functions'.
644 nil)
647 "Insert a newline, then indent according to major mode.
648 Indentation is done using the value of `indent-line-function'.
649 In programming language modes, this is the same as TAB.
650 In some text modes, where TAB inserts a tab, this command indents to the
651 column specified by the function `current-left-margin'."
658 "Reindent current line, insert newline, then indent the new line.
659 Indentation of both lines is done according to the current major mode,
660 which means calling the current value of `indent-line-function'.
661 In programming language modes, this is the same as TAB.
662 In some text modes, where TAB inserts a tab, this indents to the
663 column specified by the function `current-left-margin'."
666 ;; Be careful to insert the newline before indenting the line.
667 ;; Otherwise, the indentation might be wrong.
671 ;; We are at EOL before the call to indent-according-to-mode, and
672 ;; after it we usually are as well, but not always. We tried to
673 ;; address it with `save-excursion' but that uses a normal marker
674 ;; whereas we need `move after insertion', so we do the save/restore
675 ;; by hand.
679 ;; Remove the trailing white-space after indentation because
680 ;; indentation may introduce the whitespace.
686 Legitimate radix values are 8, 10 and 16."
691 "Like `read-char', but do not allow quitting.
692 Also, if the first character read is an octal digit,
693 we read any number of octal digits and return the
694 specified character code. Any nondigit terminates the sequence.
695 If the terminator is RET, it is discarded;
696 any other terminator is used itself as input.
698 The optional argument PROMPT specifies a string to use to prompt the user.
699 The variable `read-quoted-char-radix' controls which radix to use
700 for numeric input."
703 help-event-list)))
707 ;; Don't let C-h or other help chars get the help
708 ;; message--only help function keys. See bug#16617.
712 "Type the special character you want to use,
713 or the octal character code.
714 RET terminates the character code and is discarded;
718 ;; Translate TAB key into control-I ASCII character, and so on.
719 ;; Note: `read-char' does it using the `ascii-character' property.
720 ;; We tried using read-key instead, but that disables the keystroke
721 ;; echo produced by 'C-q', see bug#24635.
725 char)))
731 done t))
733 ;; Turn a meta-character into a character with the 0200 bit set.
735 done t))
750 done t))
752 done t)))
754 code))
757 "Read next input character and insert it.
758 This is useful for inserting control characters.
759 With argument, insert ARG copies of the character.
761 If the first character you type after this command is an octal digit,
762 you should type a sequence of octal digits which specify a character code.
763 Any nondigit terminates the sequence. If the terminator is a RET,
764 it is discarded; any other terminator is used itself as input.
765 The variable `read-quoted-char-radix' specifies the radix for this feature;
766 set it to 10 or 16 to use decimal or hex instead of octal.
768 In overwrite mode, this function inserts the character anyway, and
769 does not handle octal digits specially. This means that if you use
770 overwrite as your normal editing mode, you can use this function to
771 insert characters when necessary.
773 In binary overwrite mode, this function does overwrite, and octal
774 digits are interpreted as a character code. This is intended to be
775 useful for editing binary files."
778 ;; Avoid "obsolete" warnings for translation-table-for-input.
785 ;; This used to assume character codes 0240 - 0377 stand for
786 ;; characters in some single-byte character set, and converted them
787 ;; to Emacs characters. But in 23.1 this feature is deprecated
788 ;; in favor of inserting the corresponding Unicode characters.
789 ;; (if (and enable-multibyte-characters
790 ;; (>= char ?\240)
791 ;; (<= char ?\377))
792 ;; (setq char (unibyte-char-to-multibyte char)))
804 "Move forward ARG lines and position at first nonblank character."
810 "Move backward ARG lines and position at first nonblank character."
816 "Move point to the first non-whitespace character on this line."
820 ;; Move back over chars that have whitespace syntax but have the p flag.
824 "Fixup white space between objects around point.
825 Leave one space or none, according to the context."
832 nil
836 "Delete all spaces and tabs around point.
837 If BACKWARD-ONLY is non-nil, only delete them before point."
842 orig-pos
851 "Delete all spaces and tabs around point, leaving one space (or N spaces).
852 If N is negative, delete newlines as well, leaving -N spaces.
853 See also `cycle-spacing'."
858 "Store context used in consecutive calls to `cycle-spacing' command.
859 The first time `cycle-spacing' runs, it saves in this variable:
860 its N argument, the original point position, and the original spacing
864 "Manipulate whitespace around point in a smart way.
865 In interactive use, this function behaves differently in successive
866 consecutive calls.
868 The first call in a sequence acts like `just-one-space'.
869 It deletes all spaces and tabs around point, leaving one space
870 \(or N spaces). N is the prefix argument. If N is negative,
871 it deletes newlines as well, leaving -N spaces.
872 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
874 The second call in a sequence deletes all spaces.
876 The third call in a sequence restores the original whitespace (and point).
878 If MODE is `single-shot', it only performs the first step in the sequence.
879 If MODE is `fast' and the first step would not result in any change
880 \(i.e., there are exactly (abs N) spaces around point),
881 the function goes straight to the second step.
883 Repeatedly calling the function with different values of N starts a
884 new sequence each time."
892 ;; Command run for the first time, single-shot mode or different argument
904 ;; Special handling for case where there was no space at all.
907 ;; If this run causes no change in buffer content, delete all spaces,
908 ;; otherwise delete all excess spaces.
913 ;; Command run for the second time.
917 ;; Command run for the third time.
922 \f
924 "Move point to the beginning of the buffer.
925 With numeric arg N, put point N/10 of the way from the beginning.
926 If the buffer is narrowed, this command uses the beginning of the
927 accessible part of the buffer.
930 is supplied, or Transient Mark mode is enabled and the mark is active."
940 ;; Avoid overflow for large buffer sizes!
948 "Move point to the end of the buffer.
949 With numeric arg N, put point N/10 of the way from the end.
950 If the buffer is narrowed, this command uses the end of the
951 accessible part of the buffer.
954 is supplied, or Transient Mark mode is enabled and the mark is active."
962 ;; Avoid overflow for large buffer sizes!
967 ;; If we went to a place in the middle of the buffer,
968 ;; adjust it to the beginning of a line.
972 ;; If the end of the buffer is not already on the screen,
973 ;; then scroll specially to put it near, but not at, the bottom.
978 "Whether single-char deletion commands delete an active region.
979 This has an effect only if Transient Mark mode is enabled, and
980 affects `delete-forward-char' and `delete-backward-char', though
981 not `delete-char'.
983 If the value is the symbol `kill', the active region is killed
984 instead of deleted."
1001 "Function to get the region's content.
1002 Called with one argument METHOD.
1003 If METHOD is `delete-only', then delete the region; the return value
1004 is undefined. If METHOD is nil, then return the content as a string.
1005 If METHOD is `bounds', then return the boundaries of the region
1006 as a cons cell of the form (START . END).
1007 If METHOD is anything else, delete the region and return its content
1008 as a string, after filtering it with `filter-buffer-substring', which
1019 first nil))))
1020 "Function to insert the region's content.
1021 Called with one argument LINES.
1025 "Delete the previous N characters (following if N is negative).
1026 If Transient Mark mode is enabled, the mark is active, and N is 1,
1027 delete the text in the region and deactivate the mark instead.
1028 To disable this, set option `delete-active-region' to nil.
1030 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1031 kill ring) instead of delete. Interactively, N is the prefix
1032 arg, and KILLFLAG is set if N is explicitly specified.
1034 When killing, the killed text is filtered by
1035 `filter-buffer-substring' before it is saved in the kill ring, so
1036 the actual saved text might be different from what was killed.
1038 In Overwrite mode, single character backward deletion may replace
1039 tabs with spaces so as to back over columns, unless point is at
1040 the end of the line."
1046 delete-active-region
1048 ;; If a region is active, kill or delete it.
1052 ;; In Overwrite mode, maybe untabify while deleting
1062 ;; Otherwise, do simple deletion.
1066 "Delete the following N characters (previous if N is negative).
1067 If Transient Mark mode is enabled, the mark is active, and N is 1,
1068 delete the text in the region and deactivate the mark instead.
1069 To disable this, set variable `delete-active-region' to nil.
1071 Optional second arg KILLFLAG non-nil means to kill (save in kill
1072 ring) instead of delete. Interactively, N is the prefix arg, and
1073 KILLFLAG is set if N was explicitly specified.
1075 When killing, the killed text is filtered by
1076 `filter-buffer-substring' before it is saved in the kill ring, so
1077 the actual saved text might be different from what was killed."
1083 delete-active-region
1085 ;; If a region is active, kill or delete it.
1090 ;; Otherwise, do simple deletion.
1094 "Put point at beginning and mark at end of buffer.
1095 If narrowing is in effect, only uses the accessible part of the buffer.
1096 You probably should not use this function in Lisp programs;
1097 it is usually a mistake for a Lisp function to use any subroutine
1098 that uses or sets the mark."
1103 ;; This is really `point-min' in most cases, but if we're in the
1104 ;; minibuffer, this is at the end of the prompt.
1106 \f
1108 ;; Counting lines, one way or another.
1111 "Go to LINE, counting from line 1 at beginning of buffer.
1112 If called interactively, a numeric prefix argument specifies
1113 LINE; without a numeric prefix argument, read LINE from the
1114 minibuffer.
1116 If optional argument BUFFER is non-nil, switch to that buffer and
1118 as argument, BUFFER is the most recently selected other buffer.
1120 Prior to moving point, this function sets the mark (without
1121 activating it), unless Transient Mark mode is enabled and the
1122 mark is already active.
1124 This function is usually the wrong thing to use in a Lisp program.
1125 What you probably want instead is something like:
1126 (goto-char (point-min))
1127 (forward-line (1- N))
1128 If at all possible, an even better solution is to use char counts
1129 rather than line counts."
1134 ;; Look for a default, a number in the buffer at point.
1144 ;; Decide if we're switching buffers.
1152 ;; Read the argument, offering that number (if any) as default.
1155 buffer))))
1156 ;; Switch to the desired buffer, one way or another.
1161 ;; Leave mark at previous position
1163 ;; Move to the specified line number in that buffer.
1172 "Count the number of words in the region.
1173 If called interactively, print a message reporting the number of
1174 lines, words, and characters in the region (whether or not the
1175 region is active); with prefix ARG, report for the entire buffer
1176 rather than the region.
1178 If called from Lisp, return the number of words between positions
1179 START and END."
1191 "Count words between START and END.
1192 If called interactively, START and END are normally the start and
1193 end of the buffer; but if the region is active, START and END are
1194 the start and end of the region. Print a message reporting the
1195 number of lines, words, and chars.
1197 If called from Lisp, return the number of words between START and
1198 END, without printing any message."
1208 words))
1224 str
1232 "Print the current buffer line number and narrowed line number of point."
1245 "Return number of lines between START and END.
1246 This is usually the number of newlines between them,
1247 but can be one more if START is not equal to END
1248 and the greater of them is not at the start of a line."
1264 done)))
1268 "Return buffer line number at position POS.
1269 If POS is nil, use current buffer location.
1271 If ABSOLUTE is nil, the default, counting starts
1272 at (point-min), so the value refers to the contents of the
1273 accessible portion of the (potentially narrowed) buffer. If
1274 ABSOLUTE is non-nil, ignore any narrowing and return the
1275 absolute line number."
1288 "Print info on cursor position (on screen and within buffer).
1289 Also describe the character after point, and give its character code
1290 in octal, decimal and hex.
1292 For a non-ASCII multibyte character, also give its encoding in the
1293 buffer's selected coding system if the coding system encodes the
1294 character safely. If the character is encoded into one byte, that
1295 code is shown in hex. If the character is encoded into more than one
1298 In addition, with prefix argument, show details about that character
1299 in *Help* buffer. See also the command `describe-char'."
1303 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1304 ;; start a directional embedding, which could completely
1305 ;; disrupt the rest of the line (e.g., RLO will display the
1306 ;; rest of the line right-to-left). So we put an invisible
1307 ;; PDF character after these characters, to end the
1308 ;; embedding, which eliminates any effects on the rest of
1309 ;; the line. For RLE and RLO we also append an invisible
1310 ;; LRM, to avoid reordering the following numerical
1311 ;; characters. For LRI/RLI/FSI we append a PDI.
1318 ;; Strong right-to-left characters cause reordering of
1319 ;; the following numerical characters which show the
1320 ;; codepoint, so append LRM to countermand that.
1331 ""
1337 pos total percent beg end col hscroll)
1339 pos total col hscroll))
1341 encoded encoding-msg display-prop under-display)
1348 ;; Check if the character is displayed with some `display'
1349 ;; text property. In that case, set under-display to the
1350 ;; buffer substring covered by that property.
1361 under-display)))
1367 char char char under-display)
1369 char char char under-display display-prop))
1372 char char char
1374 "..."
1378 ;; We show the detailed information about CHAR.
1385 bidi-fixer
1386 encoding-msg pos total percent beg end col hscroll)
1393 bidi-fixer encoding-msg pos total percent col hscroll))))))
1394 \f
1395 ;; Initialize read-expression-map. It is defined at C level.
1399 ;; Might as well bind TAB to completion, since inserting a TAB char is
1400 ;; much too rarely useful.
1403 m))
1406 "Return a Lisp object read using the minibuffer, unevaluated.
1407 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1408 is a string to insert in the minibuffer before reading.
1409 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1410 Such arguments are used as in `read-from-minibuffer'.)"
1411 ;; Used for interactive spec `x'.
1416 "Return value of Lisp expression read using the minibuffer.
1417 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1418 is a string to insert in the minibuffer before reading.
1419 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1420 Such arguments are used as in `read-from-minibuffer'.)"
1421 ;; Used for interactive spec `X'.
1429 "The current default value or list of default values in the minibuffer.
1430 The functions `read-from-minibuffer' and `completing-read' bind
1434 "Value for `print-level' while printing value in `eval-expression'.
1435 A value of nil means no limit."
1441 "Value for `print-length' while printing value in `eval-expression'.
1442 A value of nil means no limit."
1448 "If non-nil set `debug-on-error' to t in `eval-expression'.
1449 If nil, don't change the value of `debug-on-error'."
1455 "The largest integer that will be displayed as a character.
1456 This affects printing by `eval-expression' (via
1457 `eval-expression-print-format')."
1463 "If VALUE in an integer, return a specially formatted string.
1465 If VALUE is not an integer, nil is returned.
1466 This function is used by commands like `eval-expression' that
1467 display the result of expression evaluation."
1485 ;; FIXME: call emacs-lisp-mode?
1493 read-expression-map t
1497 "Get arguments for commands that print an expression result.
1498 Returns a list (INSERT-VALUE NO-TRUNCATE CHAR-PRINT-LIMIT)
1499 based on PREFIX-ARG. This function determines the interpretation
1500 of the prefix argument for `eval-expression' and
1501 `eval-last-sexp'."
1509 ;; We define this, rather than making `eval' interactive,
1510 ;; for the sake of completion of names like eval-region, eval-buffer.
1512 "Evaluate EXP and print value in the echo area.
1513 When called interactively, read an Emacs Lisp expression and
1514 evaluate it. Value is also consed on to front of the variable
1515 `values'. Optional argument INSERT-VALUE non-nil (interactively,
1516 with a non `-' prefix argument) means insert the result into the
1517 current buffer instead of printing it in the echo area.
1519 Normally, this function truncates long output according to the
1520 value of the variables `eval-expression-print-length' and
1521 `eval-expression-print-level'. When NO-TRUNCATE is
1522 non-nil (interactively, with a prefix argument of zero), however,
1523 there is no such truncation.
1525 If the resulting value is an integer, and CHAR-PRINT-LIMIT is
1526 non-nil (interactively, unless given a positive prefix argument)
1527 it will be printed in several additional formats (octal,
1528 hexadecimal, and character). The character format is only used
1529 if the value is below CHAR-PRINT-LIMIT (interactively, if the
1530 prefix argument is -1 or the value is below
1531 `eval-expression-print-maximum-character').
1533 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1534 minibuffer.
1536 If `eval-expression-debug-on-error' is non-nil, which is the default,
1537 this command arranges for all errors to enter the debugger."
1545 ;; Bind debug-on-error to something unique so that we can
1546 ;; detect when evalled code changes it.
1550 ;; If evalled code has changed the value of debug-on-error,
1551 ;; propagate that change to the global binding.
1567 "Prompting with PROMPT, let user edit COMMAND and eval result.
1568 COMMAND is a Lisp expression. Let user edit that expression in
1569 the minibuffer, then read and evaluate the result."
1576 read-expression-map t
1578 ;; If command was added to command-history as a string,
1579 ;; get rid of that. We want only evaluable expressions there.
1583 ;; If command to be redone does not match front of history,
1584 ;; add it to the history.
1590 "Edit and re-evaluate last complex command, or ARGth from last.
1591 A complex command is one which used the minibuffer.
1592 The command is placed in the minibuffer as a Lisp form for editing.
1593 The result is executed, repeating the command as changed.
1594 If the command has been changed or is not the most recent previous
1595 command it is added to the front of the command history.
1596 You can use the minibuffer history commands \
1598 to get different commands to edit and resubmit."
1601 newcmd)
1613 ;; If command was added to command-history as a
1614 ;; string, get rid of that. We want only
1615 ;; evaluable expressions there.
1619 ;; If command to be redone does not match front of history,
1620 ;; add it to the history.
1635 "Read command name to invoke in `execute-extended-command'."
1645 ;; Get a command name at point in the original buffer
1646 ;; to propose it after M-n.
1650 ;; Read a string, completing from and restricting to the set of
1651 ;; all defined commands. Don't provide any initial input.
1652 ;; Save the command read on the extended-command history list.
1663 ;; This isn't strictly correct if `execute-extended-command'
1664 ;; is bound to anything else (e.g. [menu]).
1665 ;; It could use (key-description (this-single-command-keys)),
1666 ;; but actually a prompt other than "M-x" would be confusing,
1667 ;; because "M-x" is a well-known prompt to read a command
1668 ;; and it serves as a shorthand for "Extended command: ".
1673 ;; Exclude obsolete commands from completions.
1678 pred)))
1683 "Non-nil means show the equivalent key-binding when M-x command has one.
1684 The value can be a length of time to show the message for.
1685 If the value is non-nil and not a number, we wait 2 seconds."
1692 "If non-nil, show a shorter M-x invocation when there is one."
1713 binding)
1719 name len)))
1720 ;; Don't show the help message if the binding isn't
1721 ;; significantly shorter than the M-x command the user typed.
1729 binding))
1732 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1733 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1734 "Read a command name, then read the arguments and call the command.
1735 To pass a prefix argument to the command you are
1736 invoking, give a prefix argument to `execute-extended-command'."
1738 ;; FIXME: Remember the actual text typed by the user before completion,
1739 ;; so that we don't later on suggest the same shortening.
1744 execute-extended-command--last-typed)))
1745 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1757 ;; Some features, such as novice.el, rely on this-command-keys
1758 ;; including M-x COMMAND-NAME RET.
1761 ;; Normally `real-this-command' should never be changed, but here we really
1762 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1763 ;; binding" for <cmd>, so the command the user really wanted to run is
1764 ;; `function' and not `execute-extended-command'. The difference is
1765 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1769 ;; If enabled, show which key runs this command.
1770 ;; But first wait, and skip the message if there is input.
1772 ;; If this command displayed something in the echo area;
1773 ;; wait a few seconds, then display our suggestion message.
1774 ;; FIXME: Wait *after* running post-command-hook!
1775 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1776 ;; find a better answer anyway!
1786 ;; There's no binding for CMD. Let's try and find the shortest
1787 ;; string to use in M-x.
1788 ;; FIXME: Can be slow. Cache it maybe?
1795 function
1800 suggest-key-bindings
1804 ;; BEWARE: Called directly from the C code.
1805 "Execute CMD as an editor command.
1806 CMD must be a symbol that satisfies the `commandp' predicate.
1807 Optional second arg RECORD-FLAG non-nil
1808 means unconditionally put this command in the variable `command-history'.
1809 Otherwise, that is done only if an arg is read using the minibuffer.
1810 The argument KEYS specifies the value to use instead of (this-command-keys)
1811 when reading the arguments; if it is nil, (this-command-keys) is used.
1812 The argument SPECIAL, if non-nil, means that this command is executing
1813 a special event, so ignore the prefix argument and don't clear it."
1816 ;; FIXME: This should probably be done around
1817 ;; pre-command-hook rather than here!
1825 disabled-command-function)
1826 ;; FIXME: Weird calling convention!
1836 ;; If requested, place the macro in the command history. For
1837 ;; other sorts of commands, call-interactively takes care of this.
1840 ;; Don't keep command history around forever.
1846 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1854 \f
1856 "Default minibuffer history list.
1857 This is used for all minibuffer input
1858 except when an alternate history list is specified.
1860 Maximum length of the history list is determined by the value
1863 "Control whether history list elements are expressions or strings.
1864 If the value of this variable equals current minibuffer depth,
1865 they are expressions; otherwise they are strings.
1866 \(That convention is designed to do the right thing for
1873 "Text that was in this minibuffer before any history commands.
1874 This is nil if there have not yet been any history commands
1883 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1888 "Minibuffer history variables for which matching should ignore case.
1889 If a history variable is a member of this list, then the
1891 commands ignore case when searching it, regardless of `case-fold-search'."
1896 "Find the previous history element that matches REGEXP.
1897 \(Previous history elements refer to earlier actions.)
1898 With prefix argument N, search for Nth previous match.
1899 If N is negative, find the next or Nth next match.
1900 Normally, history elements are matched case-insensitively if
1901 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1902 makes the search case-sensitive.
1903 See also `minibuffer-history-case-insensitive-variables'."
1907 nil
1908 minibuffer-local-map
1909 nil
1910 'minibuffer-history-search-history
1912 ;; Use the last regexp specified, by default, if input is empty.
1917 regexp)
1927 ;; On some systems, ignore case for file names.
1929 minibuffer-history-case-insensitive-variables)
1930 t
1931 ;; Respect the user's setting for case-fold-search:
1932 case-fold-search)
1933 nil))
1934 prevpos
1935 match-string
1936 match-offset
1943 "No later matching history item"
1964 next-matching-history-element))
1968 "Find the next history element that matches REGEXP.
1969 \(The next history element refers to a more recent action.)
1970 With prefix argument N, search for Nth next match.
1971 If N is negative, find the previous or Nth previous match.
1972 Normally, history elements are matched case-insensitively if
1973 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1974 makes the search case-sensitive."
1978 nil
1979 minibuffer-local-map
1980 nil
1981 'minibuffer-history-search-history
1983 ;; Use the last regexp specified, by default, if input is empty.
1988 regexp)
1995 "Function run by `goto-history-element' before consuming default values.
1996 This is useful to dynamically add more elements to the list of default values
1997 when `goto-history-element' reaches the end of this list.
1998 Before calling this function `goto-history-element' sets the variable
1999 `minibuffer-default-add-done' to t, so it will call this function only
2000 once. In special cases, when this function needs to be called more
2001 than once, it can set `minibuffer-default-add-done' to nil explicitly,
2005 "When nil, add more elements to the end of the list of default values.
2006 The value nil causes `goto-history-element' to add more elements to
2007 the list of defaults when it reaches the end of this list. It does
2013 "Return a list of all completions without the default value.
2014 This function is used to add all elements of the completion table to
2015 the end of the list of defaults just after the default value."
2018 minibuffer-completion-table
2019 minibuffer-completion-predicate)))
2025 "Puts element of the minibuffer history in the minibuffer.
2026 The argument NABS specifies the absolute history position."
2040 elt minibuffer-returned-to-present)
2047 "End of defaults; no next item"
2054 previous-history-element))
2066 minibuffer-default)))
2078 elt))
2082 "Puts next element of the minibuffer history in the minibuffer.
2083 With argument N, it uses the Nth following element."
2089 "Puts previous element of the minibuffer history in the minibuffer.
2090 With argument N, it uses the Nth previous element."
2096 "Move cursor vertically down ARG lines, or to the next history element.
2097 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2098 next element of the minibuffer history in the minibuffer."
2102 ;; Remember the original goal column of possibly multi-line input
2103 ;; excluding the length of the prompt on the first line.
2113 ;; Restore old position since `line-move-visual' moves point to
2114 ;; the end of the line when it fails to go to the next line.
2117 ;; Reset `temporary-goal-column' because a correct value is not
2118 ;; calculated when `next-line' above fails by bumping against
2119 ;; the bottom of the minibuffer (bug#22544).
2121 ;; Restore the original goal column on the last line
2122 ;; of possibly multi-line input.
2130 "Move cursor vertically up ARG lines, or to the previous history element.
2131 When point moves over the top line of multi-line minibuffer, puts ARGth
2132 previous element of the minibuffer history in the minibuffer."
2136 ;; Remember the original goal column of possibly multi-line input
2137 ;; excluding the length of the prompt on the first line.
2147 ;; Restore old position since `line-move-visual' moves point to
2148 ;; the beginning of the line when it fails to go to the previous line.
2151 ;; Reset `temporary-goal-column' because a correct value is not
2152 ;; calculated when `previous-line' above fails by bumping against
2153 ;; the top of the minibuffer (bug#22544).
2155 ;; Restore the original goal column on the first line
2156 ;; of possibly multi-line input.
2162 ;; Put the cursor at the end of the visual line instead of the
2163 ;; logical line, so the next `previous-line-or-history-element'
2164 ;; would move to the previous history element, not to a possible upper
2165 ;; visual line from the end of logical line in `line-move-visual' mode.
2167 ;; Since `end-of-visual-line' puts the cursor at the beginning
2168 ;; of the next visual line, move it one char back to the end
2169 ;; of the first visual line (bug#22544).
2173 "Get next history element which completes the minibuffer before the point.
2174 The contents of the minibuffer after the point are deleted, and replaced
2175 by the new completion."
2181 n)
2182 ;; next-matching-history-element always puts us at (point-min).
2183 ;; Move to the position we were at before changing the buffer contents.
2184 ;; This is still sensible, because the text before point has not changed.
2188 "\
2189 Get previous history element which completes the minibuffer before the point.
2190 The contents of the minibuffer after the point are deleted, and replaced
2191 by the new completion."
2195 ;; For compatibility with the old subr of the same name.
2197 "Return the display width of the minibuffer prompt.
2198 Return 0 if current buffer is not a minibuffer."
2199 ;; Return the width of everything before the field at the end of
2200 ;; the buffer; this should be 0 for normal buffers.
2202 \f
2203 ;; isearch minibuffer history
2210 "Set up a minibuffer for using isearch to search the minibuffer history.
2211 Intended to be added to `minibuffer-setup-hook'."
2223 "Clean up the minibuffer after terminating isearch in the minibuffer."
2228 "Return the proper search function, for isearch in minibuffer history."
2231 ;; Use standard functions to search within minibuffer text
2233 found)
2234 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2235 ;; searching forward. Lazy-highlight calls this lambda with the
2236 ;; bound arg, so skip the minibuffer prompt.
2240 ;; 1. First try searching in the initial minibuffer text
2243 noerror)
2244 ;; 2. If the above search fails, start putting next/prev history
2245 ;; elements in the minibuffer successively, and search the string
2246 ;; in them. Do this only when bound is nil (i.e. not while
2247 ;; lazy-highlighting search strings in the current minibuffer text).
2259 ;; After putting the next/prev history element, search
2260 ;; the string in them again, until next-history-element
2261 ;; or previous-history-element raises an error at the
2262 ;; beginning/end of history.
2265 ;; For backward search, don't search
2266 ;; in the minibuffer prompt
2268 noerror)))
2269 ;; Return point of the new search result
2271 ;; Return nil when next(prev)-history-element fails
2275 "Display the minibuffer history search prompt.
2276 If there are no search errors, this function displays an overlay with
2277 the isearch prompt which replaces the original minibuffer prompt.
2278 Otherwise, it displays the standard isearch message returned from
2279 the function `isearch-message'."
2281 ;; Use standard function `isearch-message' when not in the minibuffer,
2282 ;; or search fails, or has an error (like incomplete regexp).
2283 ;; This function overwrites minibuffer text with isearch message,
2284 ;; so it's possible to see what is wrong in the search string.
2286 ;; Otherwise, put the overlay with the standard isearch prompt over
2287 ;; the initial minibuffer prompt.
2296 ;; And clear any previous isearch message.
2300 "Wrap the minibuffer history search when search fails.
2301 Move point to the first history element for a forward search,
2302 or to the last history element for a backward search."
2303 ;; When `minibuffer-history-isearch-search' fails on reaching the
2304 ;; beginning/end of the history, wrap the search to the first/last
2305 ;; minibuffer history element.
2313 "Save a function restoring the state of minibuffer history search.
2314 Save `minibuffer-history-position' to the additional state parameter
2315 in the search status stack."
2321 "Restore the minibuffer history search state.
2322 Go to the history element by the absolute history position HIST-POS."
2325 \f
2326 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2330 "Table mapping redo records to the corresponding undo one.
2331 A redo record for undo-in-region maps to t.
2341 "Within a run of consecutive undo commands, list remaining to be undone.
2345 "Undo some previous changes.
2346 Repeat this command to undo more changes.
2347 A numeric ARG serves as a repeat count.
2349 In Transient Mark mode when the mark is active, only undo changes within
2351 as an argument limits undo to changes within the current region."
2353 ;; Make last-command indicate for the next command that this was an undo.
2354 ;; That way, another undo will undo more.
2355 ;; If we get to the end of the undo history and get an error,
2356 ;; another undo command will find the undo history empty
2357 ;; and will get another error. To begin undoing the undos,
2358 ;; you must type some other command.
2360 ;; For an indirect buffer, look in the base buffer for the
2361 ;; auto-save data.
2365 message)
2366 ;; If we get an error in undo-start,
2367 ;; the next command should not be a "consecutive undo".
2368 ;; So set `this-command' to something other than `undo'.
2373 ;; If something (a timer or filter?) changed the buffer
2374 ;; since the previous command, don't continue the undo seq.
2378 ;; If the last undo record made was made by undo
2379 ;; it shows nothing else happened in between.
2386 ;; get rid of initial undo boundary
2388 ;; If we got this far, the next command should be a consecutive undo.
2390 ;; Check to see whether we're hitting a redo record, and if
2391 ;; so, ask the user whether she wants to skip the redo/undo pair.
2399 ;; The equiv entry might point to another redo record if we have done
2400 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2408 ;; Record the fact that the just-generated undo records come from an
2409 ;; undo operation--that is, they are redo records.
2410 ;; In the ordinary case (not within a region), map the redo
2411 ;; record to the following undos.
2412 ;; I don't know how to do that in the undo-in-region case.
2414 ;; Strip any leading undo boundaries there might be, like we do
2415 ;; above when checking.
2419 ;; Prevent identity mapping. This can happen if
2420 ;; consecutive nils are erroneously in undo list.
2422 t
2423 pending-undo-list)
2424 undo-equiv-table))
2425 ;; Don't specify a position in the undo record for the undo command.
2426 ;; Instead, undoing this should move point to where the change is.
2445 ;; Record what the current undo list says,
2446 ;; so the next command can tell if the buffer was modified in between.
2450 ;; Display a message announcing success.
2455 "Make BUFFER stop keeping undo information.
2456 No argument or nil as argument means do this for the current buffer."
2462 "Undo some previous changes.
2463 Repeat this command to undo more changes.
2464 A numeric ARG serves as a repeat count.
2465 Contrary to `undo', this will not redo a previous undo."
2470 "Non-nil while performing an undo.
2474 "Undo back N undo-boundaries beyond what was already undone recently.
2475 Call `undo-start' to get ready to undo recent changes,
2476 then call `undo-more' one or more times to undo them."
2481 ;; Note: The following, while pulling elements off
2482 ;; `pending-undo-list' will call primitive change functions which
2483 ;; will push more elements onto `buffer-undo-list'.
2489 "Undo N records from the front of the list LIST.
2490 Return what remains of the list."
2492 ;; This is a good feature, but would make undo-start
2493 ;; unable to do what is expected.
2494 ;;(when (null (car (list)))
2495 ;; ;; If the head of the list is a boundary, it is the boundary
2496 ;; ;; preceding this command. Get rid of it and don't count it.
2497 ;; (setq list (cdr list))))
2500 ;; In a writable buffer, enable undoing read-only text that is
2501 ;; so because of text properties.
2503 ;; Don't let `intangible' properties interfere with undo.
2505 ;; We use oldlist only to check for EQ. ++kfs
2511 ;; Handle an integer by setting point to that value.
2514 ;; Element (t . TIME) records previous modtime.
2515 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2516 ;; UNKNOWN_MODTIME_NSECS.
2518 ;; If this records an obsolete save
2519 ;; (not matching the actual disk file)
2520 ;; then don't mark unmodified.
2528 ;; Element (nil PROP VAL BEG . END) is property change.
2533 ;; Element (BEG . END) means range was inserted.
2535 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2536 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2539 ;; Set point first thing, so that undoing this undo
2540 ;; does not send point back to where it is now.
2543 ;; Element (apply FUN . ARGS) means call FUN to undo.
2547 ;; Long format: (apply DELTA START END FUN . ARGS).
2554 ;; Check that the function did what the entry
2555 ;; said it would do.
2565 ;; Element (STRING . POS) means STRING was deleted.
2571 ;; Check that marker adjustments which were recorded
2572 ;; with the (STRING . POS) record are still valid, ie
2573 ;; the markers haven't moved. We check their validity
2574 ;; before reinserting the string so as we don't need to
2575 ;; mind marker insertion-type.
2583 ;; Insert string and adjust point
2591 ;; Adjust the valid marker adjustments
2593 ;; Insert might have invalidated some of the markers
2594 ;; via modification hooks. Update only the currently
2595 ;; valid ones (bug#25599).
2599 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2602 next)
2603 ;; Even though these elements are not expected in the undo
2604 ;; list, adjust them to be conservative for the 24.4
2605 ;; release. (Bug#16818)
2612 ;; Make sure an apply entry produces at least one undo entry,
2613 ;; so the test in `undo' for continuing an undo series
2614 ;; will work right.
2619 list)
2621 ;; Deep copy of a list
2623 "Make a copy of undo list LIST."
2629 elt))
2632 "Set `pending-undo-list' to the front of the undo list.
2633 The next call to `undo-more' will undo the most recently made change.
2634 If BEG and END are specified, then only undo elements
2635 that apply to text between BEG and END are used; other undo elements
2636 are ignored. If BEG and END are nil, all undo elements are used."
2642 buffer-undo-list)))
2644 ;; The positions given in elements of the undo list are the positions
2645 ;; as of the time that element was recorded to undo history. In
2646 ;; general, subsequent buffer edits render those positions invalid in
2647 ;; the current buffer, unless adjusted according to the intervening
2648 ;; undo elements.
2649 ;;
2650 ;; Undo in region is a use case that requires adjustments to undo
2651 ;; elements. It must adjust positions of elements in the region based
2652 ;; on newer elements not in the region so as they may be correctly
2653 ;; applied in the current buffer. undo-make-selective-list
2654 ;; accomplishes this with its undo-deltas list of adjustments. An
2655 ;; example undo history from oldest to newest:
2656 ;;
2657 ;; buf pos:
2658 ;; 123456789 buffer-undo-list undo-deltas
2659 ;; --------- ---------------- -----------
2660 ;; aaa (1 . 4) (1 . -3)
2661 ;; aaba (3 . 4) N/A (in region)
2662 ;; ccaaba (1 . 3) (1 . -2)
2663 ;; ccaabaddd (7 . 10) (7 . -3)
2664 ;; ccaabdd ("ad" . 6) (6 . 2)
2665 ;; ccaabaddd (6 . 8) (6 . -2)
2666 ;; | |<-- region: "caab", from 2 to 6
2667 ;;
2668 ;; When the user starts a run of undos in region,
2669 ;; undo-make-selective-list is called to create the full list of in
2670 ;; region elements. Each element is adjusted forward chronologically
2671 ;; through undo-deltas to determine if it is in the region.
2672 ;;
2673 ;; In the above example, the insertion of "b" is (3 . 4) in the
2674 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2675 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2676 ;; . 6) is assessed as in the region and placed in the selective list.
2677 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2678 ;; due to the selected element. The "b" insertion is the only element
2679 ;; fully in the region, so in this example undo-make-selective-list
2680 ;; returns (nil (5 . 6)).
2681 ;;
2682 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2683 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2684 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2685 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2686 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2687 ;;
2688 ;; More interesting is how to adjust the "ddd" insertion due to the
2689 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2690 ;; If the reinsertion was a manual retyping of "ad", then the total
2691 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2692 ;; the reinsertion was due to undo, one might expect the first "d"
2693 ;; character would again be a part of the "ddd" text, meaning its
2694 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2695 ;;
2696 ;; undo-make-selective-list assumes in this situation that "ad" was a
2697 ;; new edit, even if it was inserted because of an undo.
2698 ;; Consequently, if the user undos in region "8 to 10" of the
2699 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2700 ;; "ccaabad", as though the first "d" became detached from the
2701 ;; original "ddd" insertion. This quirk is a FIXME.
2704 "Return a list of undo elements for the region START to END.
2705 The elements come from `buffer-undo-list', but we keep only the
2706 elements inside this region, and discard those outside this
2707 region. The elements' positions are adjusted so as the returned
2708 list can be applied to the current buffer."
2710 ;; A list of position adjusted undo elements in the region.
2712 ;; A list of undo-deltas for out of region undo elements.
2713 undo-deltas
2714 undo-elt)
2722 ;; Don't put two nils together in the list
2726 ;; This is a "was unmodified" element. Keep it
2727 ;; if we have kept everything thus far.
2730 ;; Skip over marker adjustments, instead relying
2731 ;; on finding them after (TEXT . POS) elements
2733 nil)
2736 undo-deltas)))
2741 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2742 ;; kept. primitive-undo may discard them later.
2755 "Determine whether UNDO-ELT falls inside the region START ... END.
2756 If it crosses the edge, we return nil.
2758 Generally this function is not useful for determining
2759 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2760 because markers can be arbitrarily relocated. Instead, pass the
2761 marker adjustment's corresponding (TEXT . POS) element."
2766 t)
2768 nil)
2770 ;; (TEXT . POSITION)
2774 ;; (MARKER . ADJUSTMENT)
2777 ;; (nil PROPERTY VALUE BEG . END)
2782 ;; (BEGIN . END)
2787 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2788 This assumes we have already decided that UNDO-ELT
2789 is not *inside* the region START...END."
2793 ;; (nil PROPERTY VALUE BEG . END)
2798 ;; (BEGIN . END)
2803 "Return adjustment of undo element ELT by the undo DELTAS
2804 list."
2806 ;; POSITION
2809 ;; (BEG . END)
2812 ;; (TEXT . POSITION)
2816 ;; (nil PROPERTY VALUE BEG . END)
2819 ;; (apply DELTA START END FUN . ARGS)
2820 ;; FIXME
2821 ;; All others return same elt
2824 ;; (BEG . END) can adjust to the same positions, commonly when an
2825 ;; insertion was undone and they are out of region, for example:
2826 ;;
2827 ;; buf pos:
2828 ;; 123456789 buffer-undo-list undo-deltas
2829 ;; --------- ---------------- -----------
2830 ;; [...]
2831 ;; abbaa (2 . 4) (2 . -2)
2832 ;; aaa ("bb" . 2) (2 . 2)
2833 ;; [...]
2834 ;;
2835 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2836 ;; undo. Further adjustments to such an element should be the same as
2837 ;; for (TEXT . POSITION) elements. The options are:
2838 ;;
2839 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2840 ;; analogous to marker insertion-type t.
2841 ;;
2842 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2843 ;; marker insertion-type nil.
2844 ;;
2845 ;; There was no strong reason to prefer one or the other, except that
2846 ;; the first is more consistent with prior undo in region behavior.
2848 "Return cons of adjustments to BEG and END by the undo DELTAS
2849 list."
2851 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2856 "Return adjustment of POS by the undo DELTAS list, comparing
2857 with < or <= based on USE-<."
2863 ;; Don't allow pos to become less than the undo-delta
2864 ;; position. This edge case is described in the overview
2865 ;; comments.
2868 ;; Return the first affected buffer position and the delta for an undo element
2869 ;; delta is defined as the change in subsequent buffer positions if we *did*
2870 ;; the undo.
2874 ;; (TEXT . POSITION)
2877 ;; (BEGIN . END)
2883 ;;; Default undo-boundary addition
2884 ;;
2885 ;; This section adds a new undo-boundary at either after a command is
2886 ;; called or in some cases on a timer called after a change is made in
2887 ;; any buffer.
2889 "Describe the cause of the last undo-boundary.
2891 If `explicit', the last boundary was caused by an explicit call to
2892 `undo-boundary', that is one not called by the code in this
2893 section.
2895 If it is equal to `timer', then the last boundary was inserted
2896 by `undo-auto--boundary-timer'.
2898 If it is equal to `command', then the last boundary was inserted
2899 automatically after a command, that is by the code defined in
2900 this section.
2902 If it is equal to a list, then the last boundary was inserted by
2903 an amalgamating command. The car of the list is the number of
2904 times an amalgamating command has been called, and the cdr are the
2908 "Current timer which will run `undo-auto--boundary-timer' or nil.
2913 "Non-nil if `this-command' should be amalgamated.
2914 This variable is set to nil by `undo-auto--boundaries' and is set
2918 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2922 "Return the number of amalgamating last commands or nil.
2923 Amalgamating commands are, by default, either
2924 `self-insert-command' and `delete-char', but can be any command
2925 that calls `undo-auto-amalgamate'."
2929 "Add an `undo-boundary' to the current buffer if needed.
2930 REASON describes the reason that the boundary is being added; see
2931 `undo-auto--last-boundary' for more information."
2941 undo-auto--undoably-changed-buffers)
2942 cause)))))
2945 "Check recently changed buffers and add a boundary if necessary.
2946 REASON describes the reason that the boundary is being added; see
2947 `undo-last-boundary' for more information."
2948 ;; (Bug #23785) All commands should ensure that there is an undo
2949 ;; boundary whether they have changed the current buffer or not.
2959 "Timer which will run `undo--auto-boundary-timer'."
2964 "Ensure that the `undo-auto-boundary-timer' is set."
2970 "List of buffers that have changed recently.
2972 This list is maintained by `undo-auto--undoable-change' and
2973 `undo-auto--boundaries' and can be affected by changes to their
2977 "Add an `undo-boundary' in appropriate buffers."
2982 'amalgamate
2986 "Amalgamate undo if necessary.
2987 This function can be called before an amalgamating command. It
2988 removes the previous `undo-boundary' if a series of such calls
2989 have been made. By default `self-insert-command' and
2990 `delete-char' are the only amalgamating commands, although this
2991 function could be called by any command wishing to have this
2992 behavior."
2997 last-amalgamating-count
3002 ;; Amalgamate all buffers that have changed.
3006 b
3008 ;; The head of `buffer-undo-list' is nil.
3009 ;; `car-safe' doesn't work because
3010 ;; `buffer-undo-list' need not be a list!
3018 "Called after every undoable buffer change."
3021 ;; End auto-boundary section
3024 "Amalgamate changes in change-group since HANDLE.
3025 Remove all undo boundaries between the state of HANDLE and now.
3026 HANDLE is as returned by `prepare-change-group'."
3035 ;; Temporarily truncate the undo log at ELT.
3040 ;; `elt' is still in the log: normal case.
3042 ;; `elt' is not in the log any more, but that's because
3043 ;; the log is "all new", so we should remove all
3044 ;; boundaries from it.
3048 buffer-undo-list
3049 ;; Preserve the undo-boundaries at either ends of the
3050 ;; change-groups.
3052 ;; Reset the modified cons cell ELT to its original content.
3059 "If non-nil ask about discarding undo info for the current command.
3060 Normally, Emacs discards the undo info for the current command if
3061 it exceeds `undo-outer-limit'. But if you set this option
3062 non-nil, it asks in the echo area whether to discard the info.
3063 If you answer no, there is a slight risk that Emacs might crash, so
3064 only do it if you really want to undo the command.
3066 This option is mainly intended for debugging. You have to be
3067 careful if you use it for other purposes. Garbage collection is
3068 inhibited while the question is asked, meaning that Emacs might
3069 leak memory. So you should make sure that you do not wait
3070 excessively long before answering the question."
3076 "If non-nil, an extra level of size that's ok in an undo item.
3077 We don't ask the user about truncating the undo list until the
3078 current item gets bigger than this amount.
3083 ;; When the first undo batch in an undo list is longer than
3084 ;; undo-outer-limit, this function gets called to warn the user that
3085 ;; the undo info for the current command was discarded. Garbage
3086 ;; collection is inhibited around the call, so it had better not do a
3087 ;; lot of consing.
3093 ;; Don't ask the question again unless it gets even bigger.
3094 ;; This applies, in particular, if the user quits from the question.
3095 ;; Such a quit quits out of GC, but something else will call GC
3096 ;; again momentarily. It will call this function again,
3097 ;; but we don't want to ask the question again.
3101 "Buffer `%s' undo info is %d bytes long; discard it? "
3105 t)
3106 nil))
3112 "The undo info was discarded because it exceeded \
3113 `undo-outer-limit'.
3115 This is normal if you executed a command that made a huge change
3116 to the buffer. In that case, to prevent similar problems in the
3117 future, set `undo-outer-limit' to a value that is large enough to
3118 cover the maximum size of normal changes you expect a single
3119 command to make, but not so large that it might exceed the
3120 maximum memory allotted to Emacs.
3122 If you did not execute any such command, the situation is
3123 probably due to a bug and you should report it.
3125 You can disable the popping up of this buffer by adding the entry
3126 \(undo discard-info) to the user option `warning-suppress-types',
3130 t))
3131 \f
3134 ; These are sorted according to the GNU en_US locale.
3177 )
3179 This is used by Shell mode and other parts of Emacs to recognize
3180 password prompts, including prompts in languages other than
3181 English. Different case choices should not be assumed to be
3182 included; callers should bind `case-fold-search' to t."
3188 "History list for some commands that read shell commands.
3190 Maximum length of the history list is determined by the value
3197 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3198 This buffer is used when `shell-command' or `shell-command-on-region'
3199 is run interactively. A value of nil means that output to stderr and
3206 "Return a list of all commands associated with the current file.
3207 This function is used to add all related commands retrieved by `mailcap'
3208 to the end of the list of defaults just after the default value."
3212 minibuffer-default))
3217 commands))
3228 map)
3232 "Read a shell command from the minibuffer.
3233 The arguments are the same as the ones of `read-from-minibuffer',
3234 except READ and KEYMAP are missing and HIST defaults
3235 to `shell-command-history'."
3243 minibuffer-local-shell-command-map
3244 nil
3246 args)))
3249 "What to do when the output buffer is used by another shell command.
3250 This option specifies how to resolve the conflict where a new command
3251 wants to direct its output to the buffer `*Async Shell Command*',
3252 but this buffer is already taken by another running shell command.
3254 The value `confirm-kill-process' is used to ask for confirmation before
3255 killing the already running process and running a new process
3256 in the same buffer, `confirm-new-buffer' for confirmation before running
3257 the command in a new buffer with a name other than the default buffer name,
3258 `new-buffer' for doing the same without confirmation,
3259 `confirm-rename-buffer' for confirmation before renaming the existing
3260 output buffer and running a new command in the default buffer,
3261 `rename-buffer' for doing the same without confirmation."
3263 confirm-kill-process)
3265 confirm-new-buffer)
3267 new-buffer)
3269 confirm-rename-buffer)
3271 rename-buffer))
3276 "Whether to display the command buffer immediately.
3277 If t, display the buffer immediately; if nil, wait until there
3278 is output."
3280 t)
3282 nil))
3287 "Store a buffer position or erase the buffer.
3288 See `shell-command-dont-erase-buffer'."
3290 pos)
3292 ;; Setting buffer-read-only to nil doesn't suffice
3293 ;; if some text has a non-nil read-only property,
3294 ;; which comint sometimes adds for prompts.
3304 shell-command-saved-pos))))
3307 "Set point in BUFFER after command complete.
3308 BUFFER is the output buffer of the command; if nil, then defaults
3309 to the current BUFFER.
3310 Set point to the `cdr' of the element in `shell-command-saved-pos'
3311 whose `car' is BUFFER."
3323 ;; Set point in the window displaying buf, if any; otherwise
3324 ;; display buf temporary in selected frame and set the point.
3329 buf
3334 "Execute string COMMAND asynchronously in background.
3336 Like `shell-command', but adds `&' at the end of COMMAND
3337 to execute it asynchronously.
3339 The output appears in the buffer `*Async Shell Command*'.
3340 That buffer is in shell mode.
3342 You can configure `async-shell-command-buffer' to specify what to do in
3343 case when `*Async Shell Command*' buffer is already taken by another
3344 running shell command. To run COMMAND without displaying the output
3345 in a window you can configure `display-buffer-alist' to use the action
3346 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3348 In Elisp, you will often be better served by calling `start-process'
3349 directly, since it offers more control and does not impose the use of a
3350 shell (with its need to quote arguments)."
3360 current-prefix-arg
3361 shell-command-default-error-buffer))
3367 "Execute string COMMAND in inferior shell; display output, if any.
3368 With prefix argument, insert the COMMAND's output at point.
3370 Interactively, prompt for COMMAND in the minibuffer.
3372 If COMMAND ends in `&', execute it asynchronously.
3373 The output appears in the buffer `*Async Shell Command*'.
3374 That buffer is in shell mode. You can also use
3375 `async-shell-command' that automatically adds `&'.
3377 Otherwise, COMMAND is executed synchronously. The output appears in
3378 the buffer `*Shell Command Output*'. If the output is short enough to
3379 display in the echo area (which is determined by the variables
3380 `resize-mini-windows' and `max-mini-window-height'), it is shown
3381 there, but it is nonetheless available in buffer `*Shell Command
3382 Output*' even though that buffer is not automatically displayed.
3384 To specify a coding system for converting non-ASCII characters
3386 before this command.
3388 Noninteractive callers can specify coding systems by binding
3389 `coding-system-for-read' and `coding-system-for-write'.
3391 The optional second argument OUTPUT-BUFFER, if non-nil,
3392 says to put the output in some other buffer.
3393 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3394 and insert the output there; a non-nil value of
3395 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3396 If OUTPUT-BUFFER is not a buffer and not nil, insert the output
3397 in current buffer after point leaving mark after it.
3398 This cannot be done asynchronously.
3400 If the command terminates without error, but generates output,
3402 the output can be displayed in the echo area or in its buffer.
3403 If the output is short enough to display in the echo area
3404 \(determined by the variable `max-mini-window-height' if
3405 `resize-mini-windows' is non-nil), it is shown there.
3406 Otherwise,the buffer containing the output is displayed.
3410 of the output.
3412 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3413 or buffer name to which to direct the command's standard error output.
3414 If it is nil, error output is mingled with regular output.
3415 In an interactive call, the variable `shell-command-default-error-buffer'
3416 specifies the value of ERROR-BUFFER.
3418 In Elisp, you will often be better served by calling `call-process' or
3419 `start-process' directly, since it offers more control and does not impose
3420 the use of a shell (with its need to quote arguments)."
3431 current-prefix-arg
3432 shell-command-default-error-buffer))
3433 ;; Look for a handler in case default-directory is a remote file name.
3441 ;; Output goes in current buffer.
3447 temporary-file-directory)))
3448 nil)))
3451 ;; We do not use -f for csh; we will not support broken use of
3452 ;; .cshrcs. Even the BSD csh manual says to use
3453 ;; "if ($?prompt) exit" before things which are not useful
3454 ;; non-interactively. Besides, if someone wants their other
3455 ;; aliases for shell commands then they can still have them.
3459 t)
3460 nil shell-command-switch command)
3467 ;; Do no formatting while reading error file,
3468 ;; because that can run a shell command, and we
3469 ;; don't want that to cause an infinite recursion.
3471 ;; Put point after the inserted errors.
3475 ;; This is like exchange-point-and-mark, but doesn't
3476 ;; activate the mark. It is cleaner to avoid activation,
3477 ;; even though the command loop would deactivate the mark
3478 ;; because we inserted text.
3482 ;; Output goes in a separate buffer.
3483 ;; Preserve the match data in case called from a program.
3484 ;; FIXME: It'd be ridiculous for an Elisp function to call
3485 ;; shell-command and assume that it won't mess the match-data!
3488 ;; Command ending with ampersand means asynchronous.
3492 proc)
3493 ;; Remove the ampersand.
3495 ;; Ask the user what to do with already running process.
3500 ;; If will kill a process, query first.
3505 ;; If will create a new buffer, query first.
3512 ;; It will create a new buffer.
3517 ;; If will rename the buffer, query first.
3526 ;; It will rename the buffer.
3535 shell-command-switch command))
3539 ;; Use the comint filter for proper handling of carriage motion
3540 ;; (see `comint-inhibit-carriage-motion'),.
3550 ))
3551 ))
3552 ;; Otherwise, command is executed synchronously.
3554 output-buffer nil error-buffer)))))))
3557 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3558 MESSAGE may be either a string or a buffer.
3560 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3561 for maximum height of the echo area, as defined by `max-mini-window-height'
3562 if `resize-mini-windows' is non-nil.
3564 Returns either the string shown in the echo area, or when a pop-up
3565 buffer is used, the window used to display it.
3567 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3568 name of the buffer used to display it in the case where a pop-up buffer
3569 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3570 string and it is displayed in the echo area, it is not specified whether
3571 the contents are inserted into the buffer anyway.
3573 Optional arguments ACTION and FRAME are as for `display-buffer',
3574 and are only used if a pop-up buffer is displayed."
3576 ;; Trivial case where we can use the echo area
3580 ;; Trivial case where we can just remove single trailing newline
3583 ;; General case
3586 message
3595 0
3599 (<= lines
3603 max-mini-window-height))
3605 max-mini-window-height)
3609 ;; Don't use the echo area if the output buffer is
3610 ;; already displayed in the selected frame.
3612 ;; Echo area
3618 ;; Buffer
3623 ;; We have a sentinel to prevent insertion of a termination message
3624 ;; in the buffer itself, and to set the point in the buffer when
3625 ;; `shell-command-dont-erase-buffer' is non-nil.
3634 &optional output-buffer replace
3635 error-buffer display-error-buffer
3636 region-noncontiguous-p)
3637 "Execute string COMMAND in inferior shell with region as input.
3638 Normally display output (if any) in temp buffer `*Shell Command Output*';
3639 Prefix arg means replace the region with it. Return the exit code of
3640 COMMAND.
3642 To specify a coding system for converting non-ASCII characters
3644 before this command. By default, the input (from the current buffer)
3645 is encoded using coding-system specified by `process-coding-system-alist',
3646 falling back to `default-process-coding-system' if no match for COMMAND
3647 is found in `process-coding-system-alist'.
3649 Noninteractive callers can specify coding systems by binding
3650 `coding-system-for-read' and `coding-system-for-write'.
3652 If the command generates output, the output may be displayed
3653 in the echo area or in a buffer.
3654 If the output is short enough to display in the echo area
3655 \(determined by the variable `max-mini-window-height' if
3656 `resize-mini-windows' is non-nil), it is shown there.
3657 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3658 The output is available in that buffer in both cases.
3660 If there is output and an error, a message about the error
3661 appears at the end of the output.
3663 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3664 command's output. If the value is a buffer or buffer name,
3665 erase that buffer and insert the output there; a non-nil value of
3666 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3667 If the value is nil, use the buffer `*Shell Command Output*'.
3668 Any other non-nil value means to insert the output in the
3669 current buffer after START.
3671 Optional fifth arg REPLACE, if non-nil, means to insert the
3672 output in place of text from START to END, putting point and mark
3673 around it.
3675 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3676 or buffer name to which to direct the command's standard error
3677 output. If nil, error output is mingled with regular output.
3678 When called interactively, `shell-command-default-error-buffer'
3679 is used for ERROR-BUFFER.
3681 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3682 display the error buffer if there were any errors. When called
3683 interactively, this is t."
3687 ;; Do this before calling region-beginning
3688 ;; and region-end, in case subprocess output
3689 ;; relocates them while we are in the minibuffer.
3691 ;; call-interactively recognizes region-beginning and
3692 ;; region-end specially, leaving them in the history.
3694 string
3695 current-prefix-arg
3696 current-prefix-arg
3697 shell-command-default-error-buffer
3698 t
3705 temporary-file-directory)))
3706 nil))
3707 exit-status)
3708 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3711 output)
3715 shell-file-name t t
3716 nil shell-command-switch
3717 command)
3724 ;; Replace specified region with output from command.
3726 ;; Don't muck with mark unless REPLACE says we should.
3733 t)))
3734 ;; It is rude to delete a buffer which the command is not using.
3735 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3736 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3737 ;; (kill-buffer shell-buffer)))
3738 ;; Don't muck with mark unless REPLACE says we should.
3740 ;; No prefix argument: put the output in a temp buffer,
3741 ;; replacing its entire contents.
3749 ;; If the input is the same buffer as the output,
3750 ;; delete everything but the specified region,
3751 ;; then replace that region with the output.
3757 shell-file-name t
3760 t)
3761 nil shell-command-switch
3762 command)))
3763 ;; Clear the output buffer, then run the command with
3764 ;; output there.
3774 buffer))))
3775 ;; Report the output.
3785 ;; There's some output, display it
3789 ;; No output; error?
3796 shell-command-default-error-buffer)
3803 output))
3806 exit-status))
3809 exit-status output))))
3810 ;; Don't kill: there might be useful info in the undo-log.
3811 ;; (kill-buffer buffer)
3812 )))))
3820 ;; Do no formatting while reading error file,
3821 ;; because that can run a shell command, and we
3822 ;; don't want that to cause an infinite recursion.
3824 ;; Put point after the inserted errors.
3829 exit-status))
3832 "Execute shell command COMMAND and return its output as a string."
3835 standard-output
3839 "Process files synchronously in a separate process.
3840 Similar to `call-process', but may invoke a file handler based on
3841 `default-directory'. The current working directory of the
3842 subprocess is `default-directory'.
3844 File names in INFILE and BUFFER are handled normally, but file
3845 names in ARGS should be relative to `default-directory', as they
3846 are passed to the process verbatim. (This is a difference to
3847 `call-process' which does not support file handlers for INFILE
3848 and BUFFER.)
3850 Some file handlers might not support all variants, for example
3851 they might behave as if DISPLAY was nil, regardless of the actual
3852 value passed."
3854 lc stderr-file)
3864 display args)
3870 "Whether a call of `process-file' changes remote files.
3872 By default, this variable is always set to t, meaning that a
3873 call of `process-file' could potentially change any file on a
3874 remote host. When set to nil, a file handler could optimize
3875 its behavior with respect to remote file attribute caching.
3877 You should only ever change this variable with a let-binding;
3881 "Start a program in a subprocess. Return the process object for it.
3883 Similar to `start-process', but may invoke a file handler based on
3884 `default-directory'. See Info node `(elisp)Magic File Names'.
3886 This handler ought to run PROGRAM, perhaps on the local host,
3887 perhaps on a remote host that corresponds to `default-directory'.
3888 In the latter case, the local part of `default-directory' becomes
3889 the working directory of the process.
3891 PROGRAM and PROGRAM-ARGS might be file names. They are not
3892 objects of file handler invocation. File handlers might not
3893 support pty association, if PROGRAM is nil."
3897 \f
3898 ;;;; Process menu
3912 map))
3915 "Major mode for listing the processes called by Emacs."
3927 "Kill process at point in a `list-processes' buffer."
3938 "Recompute the list of processes for the Process List buffer.
3939 Also, delete any process that is exited or signaled."
3953 face link
3955 "Visit buffer `%s'"
3957 follow-link t
3958 process-buffer ,buf
3959 action process-menu-visit-buffer)
3968 "datagram"
3985 tabulated-list-entries)))))
3992 "Display a list of all processes that are Emacs sub-processes.
3993 If optional argument QUERY-ONLY is non-nil, only processes with
3994 the query-on-exit flag set are listed.
3995 Any process listed as exited or signaled is actually eliminated
3996 after the listing is made.
3997 Optional argument BUFFER specifies a buffer to use, instead of
3999 The return value is always nil.
4001 This function lists only processes that were launched by Emacs. To
4002 see other processes running on the system, use `list-system-processes'."
4014 nil)
4015 \f
4016 ;;;; Prefix commands
4022 ;; BEWARE: Called directly from C code.
4023 ;; If the return value is non-nil, it means we are in the middle of
4024 ;; a command with prefix, such as a command invoked with prefix-arg.
4026 prefix-command--last-echo
4035 "Abnormal hook which constructs the description of the current prefix state.
4039 "Update state of prefix commands.
4047 "Pass the current prefix command state to the next command.
4048 Should be called by all prefix commands.
4049 Runs `prefix-command-preserve-state-hook'."
4051 ;; If the current command is a prefix command, we don't want the next (real)
4052 ;; command to have `last-command' set to, say, `universal-argument'.
4059 nil)
4061 ;;;;; The main prefix command.
4063 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
4088 ;; For backward compatibility, minus with no modifiers is an ordinary
4089 ;; command if digits have already been entered.
4119 map)
4127 "Begin a numeric argument for the following command.
4132 multiplies the argument by 4 each time.
4134 which is different in effect from any particular numeric argument.
4142 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
4143 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
4150 arg)))
4154 "Begin a negative numeric argument for the next command.
4164 "Part of the numeric argument for the next command.
4169 last-command-event
4176 ;; Treat -0 as just -, so that -01 will work.
4179 digit))))
4181 \f
4184 "This variable is a wrapper hook around `buffer-substring--filter'.
4190 "Function to perform the filtering in `filter-buffer-substring'.
4191 The function is called with the same 3 arguments (BEG END DELETE)
4192 that `filter-buffer-substring' received. It should return the
4193 buffer substring between BEG and END, after filtering. If DELETE is
4197 "List of filter functions for `buffer-substring--filter'.
4198 Each function must accept a single argument, a string, and return a string.
4199 The buffer substring is passed to the first function in the list,
4200 and the return value of each function is passed to the next.
4201 As a special convention, point is set to the start of the buffer text
4202 being operated on (i.e., the first argument of `buffer-substring--filter')
4208 "Return the buffer substring between BEG and END, after filtering.
4209 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4211 This calls the function that `filter-buffer-substring-function' specifies
4212 \(passing the same three arguments that it received) to do the work,
4213 and returns whatever it does. The default function does no filtering,
4214 unless a hook has been set.
4216 Use `filter-buffer-substring' instead of `buffer-substring',
4217 `buffer-substring-no-properties', or `delete-and-extract-region' when
4218 you want to allow filtering to take place. For example, major or minor
4219 modes can use `filter-buffer-substring-function' to extract characters
4220 that are special to a buffer, and should not be copied into other buffers."
4224 "Default function to use for `filter-buffer-substring-function'.
4225 Its arguments and return value are as specified for `filter-buffer-substring'.
4226 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4227 \(see `with-wrapper-hook' for details about wrapper hooks),
4228 and the abnormal hook `buffer-substring-filters'.
4229 No filtering is done unless a hook says to."
4240 string)))
4245 ;;;; Window system cut and paste hooks.
4248 "Function to call to make a killed region available to other programs.
4249 Most window systems provide a facility for cutting and pasting
4250 text between different programs, such as the clipboard on X and
4251 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4253 This variable holds a function that Emacs calls whenever text is
4254 put in the kill ring, to make the new kill available to other
4255 programs. The function takes one argument, TEXT, which is a
4259 "Function to call to get text cut from other programs.
4260 Most window systems provide a facility for cutting and pasting
4261 text between different programs, such as the clipboard on X and
4262 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4264 This variable holds a function that Emacs calls to obtain text
4265 that other programs have provided for pasting. The function is
4266 called with no arguments. If no other program has provided text
4267 to paste, the function should return nil (in which case the
4268 caller, usually `current-kill', should use the top of the Emacs
4269 kill ring). If another program has provided text to paste, the
4270 function should return that text as a string (in which case the
4271 caller should put this string in the kill ring as the latest
4272 kill).
4274 The function may also return a list of strings if the window
4275 system supports multiple selections. The first string will be
4276 used as the pasted text, but the other will be placed in the kill
4277 ring for easy access via `yank-pop'.
4279 Note that the function should return a string only if a program
4280 other than Emacs has provided a string for pasting; if Emacs
4281 provided the most recent string, the function should return nil.
4282 If it is difficult to tell whether Emacs or some other program
4283 provided the current string, it is probably good enough to return
4284 nil if the string is equal (according to `string=') to the last
4286 \f
4289 ;;;; The kill ring data structure.
4292 "List of killed text sequences.
4293 Since the kill ring is supposed to interact nicely with cut-and-paste
4294 facilities offered by window systems, use of this variable should
4295 interact nicely with `interprogram-cut-function' and
4296 `interprogram-paste-function'. The functions `kill-new',
4297 `kill-append', and `current-kill' are supposed to implement this
4298 interaction; you may want to use them instead of manipulating the kill
4302 "Maximum length of kill ring before oldest elements are thrown away."
4310 "Save clipboard strings into kill ring before replacing them.
4311 When one selects something in another program to paste it into Emacs,
4312 but kills something in Emacs before actually pasting it,
4313 this selection is gone unless this variable is non-nil,
4314 in which case the other program's selection is saved in the `kill-ring'
4321 "Do not add a new string to `kill-ring' if it duplicates the last one.
4322 The comparison is done using `equal-including-properties'."
4328 "Make STRING the latest kill in the kill ring.
4329 Set `kill-ring-yank-pointer' to point to it.
4330 If `interprogram-cut-function' is non-nil, apply it to STRING.
4331 Optional second argument REPLACE non-nil means that STRING will replace
4332 the front of the kill ring, rather than being added to the list.
4334 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4335 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4336 STRING.
4338 When the yank handler has a non-nil PARAM element, the original STRING
4339 argument is not used by `insert-for-yank'. However, since Lisp code
4340 may access and use elements from the kill ring directly, the STRING
4343 ;; Due to text properties such as 'yank-handler that
4344 ;; can alter the contents to yank, comparison using
4345 ;; `equal' is unsafe.
4370 ;; It has been argued that this should work similar to `self-insert-command'
4371 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4373 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4379 "Append STRING to the end of the latest kill in the kill ring.
4380 If BEFORE-P is non-nil, prepend STRING to the kill.
4381 Also removes the last undo boundary in the current buffer,
4382 depending on `kill-append-merge-undo'.
4383 If `interprogram-cut-function' is set, pass the resulting kill to it."
4391 ;; find the next undo boundary
4395 ;; remove this undo boundary
4400 "Whether rotating the kill ring changes the window system selection.
4401 If non-nil, whenever the kill ring is rotated (usually via the
4402 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4403 to copy the new kill to the window system selection."
4409 "Rotate the yanking point by N places, and then return that kill.
4410 If N is zero and `interprogram-paste-function' is set to a
4411 function that returns a string or a list of strings, and if that
4412 function doesn't return nil, then that string (or list) is added
4413 to the front of the kill ring and the string (or first string in
4414 the list) is returned as the latest kill.
4416 If N is not zero, and if `yank-pop-change-selection' is
4417 non-nil, use `interprogram-cut-function' to transfer the
4418 kill at the new yank point into the window system selection.
4420 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4421 move the yanking point; just return the Nth kill forward."
4424 interprogram-paste-function
4428 ;; Disable the interprogram cut function when we add the new
4429 ;; text to the kill ring, so Emacs doesn't try to own the
4430 ;; selection, with identical text.
4440 kill-ring)))
4445 interprogram-cut-function)
4451 ;;;; Commands for manipulating the kill ring.
4454 "Non-nil means don't signal an error for killing read-only text."
4460 This deletes the text from the buffer and saves it in the kill ring.
4464 If you want to append the killed region to the last killed text,
4468 If the previous command was also a kill command,
4469 the text killed this time appends to the text killed last time
4470 to make one entry in the kill ring.
4472 The killed text is filtered by `filter-buffer-substring' before it is
4473 saved in the kill ring, so the actual saved text might be different
4474 from what was killed.
4476 If the buffer is read-only, Emacs will beep and refrain from deleting
4477 the text, but put the text in the kill ring anyway. This means that
4478 you can use the killing commands to copy text from a read-only buffer.
4480 Lisp programs should use this function for killing text.
4481 (To delete text, use `delete-region'.)
4482 Supply two arguments, character positions BEG and END indicating the
4483 stretch of text to be killed. If the optional argument REGION is
4484 non-nil, the function ignores BEG and END, and kills the current
4485 region instead."
4486 ;; Pass mark first, then point, because the order matters when
4487 ;; calling `kill-append'.
4496 ;; Add that string to the kill ring, one way or another.
4503 nil)
4505 ;; The code above failed because the buffer, or some of the characters
4506 ;; in the region, are read-only.
4507 ;; We should beep, in case the user just isn't aware of this.
4508 ;; However, there's no harm in putting
4509 ;; the region's text in the kill ring, anyway.
4511 ;; Set this-command now, so it will be set even if we get an error.
4513 ;; This should barf, if appropriate, and give us the correct error.
4516 ;; Signal an error if the buffer is read-only.
4518 ;; If the buffer isn't read-only, the text is.
4521 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4522 ;; to get two copies of the text when the user accidentally types M-w and
4523 ;; then corrects it with the intended C-w.
4525 "Save the region as if killed, but don't kill it.
4526 In Transient Mark mode, deactivate the mark.
4527 If `interprogram-cut-function' is non-nil, also save the text for a window
4528 system cut and paste.
4530 The copied text is filtered by `filter-buffer-substring' before it is
4531 saved in the kill ring, so the actual saved text might be different
4532 from what was in the buffer.
4534 When called from Lisp, save in the kill ring the stretch of text
4535 between BEG and END, unless the optional argument REGION is
4536 non-nil, in which case ignore BEG and END, and save the current
4537 region instead.
4539 This command's old key binding has been given to `kill-ring-save'."
4540 ;; Pass mark first, then point, because the order matters when
4541 ;; calling `kill-append'.
4551 nil)
4554 "Save the region as if killed, but don't kill it.
4555 In Transient Mark mode, deactivate the mark.
4556 If `interprogram-cut-function' is non-nil, also save the text for a window
4557 system cut and paste.
4559 If you want to append the killed line to the last killed text,
4562 The copied text is filtered by `filter-buffer-substring' before it is
4563 saved in the kill ring, so the actual saved text might be different
4564 from what was in the buffer.
4566 When called from Lisp, save in the kill ring the stretch of text
4567 between BEG and END, unless the optional argument REGION is
4568 non-nil, in which case ignore BEG and END, and save the current
4569 region instead.
4571 This command is similar to `copy-region-as-kill', except that it gives
4572 visual feedback indicating the extent of the region being copied."
4573 ;; Pass mark first, then point, because the order matters when
4574 ;; calling `kill-append'.
4578 ;; This use of called-interactively-p is correct because the code it
4579 ;; controls just gives the user visual feedback.
4584 "Indicate that the region text has been copied interactively.
4585 If the mark is visible in the selected window, blink the cursor
4586 between point and mark if there is currently no active region
4587 highlighting.
4589 If the mark lies outside the selected window, display an
4590 informative message containing a sample of the copied text. The
4591 optional argument MESSAGE-LEN, if non-nil, specifies the length
4592 of this sample text; it defaults to 40."
4595 ;; Inhibit quitting so we can make a quit here
4596 ;; look like a C-g typed as a command.
4599 ;; Swap point-and-mark quickly so as to show the region that
4600 ;; was selected. Don't do it if the region is highlighted.
4603 ;; Swap point and mark.
4607 ;; Swap back.
4610 ;; If user quit, deactivate the mark
4611 ;; as C-g would as a command.
4617 ;; Don't say "killed"; that is misleading.
4624 "Cause following command, if it kills, to add to previous kill.
4625 If the next command kills forward from point, the kill is
4626 appended to the previous killed text. If the command kills
4627 backward, the kill is prepended. Kill commands that act on the
4628 region, such as `kill-region', are regarded as killing forward if
4629 point is after mark, and killing backward if point is before
4630 mark.
4632 If the next command is not a kill command, `append-next-kill' has
4633 no effect.
4635 The argument is used for internal purposes; do not supply one."
4637 ;; We don't use (interactive-p), since that breaks kbd macros.
4651 "A subroutine of `squeeze-bidi-context'.
4652 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4656 lim1)
4663 ;; L and R categories include embedding and
4664 ;; override controls, but we don't want to
4665 ;; replace them, because that might change
4666 ;; the visual order. Likewise with PDF and
4667 ;; isolate controls.
4669 bidi-directional-non-controls-chars
4670 limit)))))
4671 ;; Replace any run of non-RTL characters by a single LRM.
4673 ;; No more characters of CATEGORY, we are done.
4678 ;; Skip directional controls, if any.
4683 "Replace characters between FROM and TO while keeping bidi context.
4685 This function replaces the region of text with as few characters
4686 as possible, while preserving the effect that region will have on
4687 bidirectional display before and after the region."
4691 ;; This is for when they copy text with read-only text
4692 ;; properties.
4696 ;; Replace each run of non-RTL characters with a single LRM.
4698 ;; Replace each run of non-LTR characters with a single RLM. Note
4699 ;; that the \cR category includes both the Arabic Letter (AL) and
4700 ;; R characters; here we ignore the distinction between them,
4701 ;; because that distinction only affects Arabic Number (AN)
4702 ;; characters, which are weak and don't affect the reordering.
4706 "Return buffer text between START and END with its bidi context.
4708 START and END are assumed to belong to the same physical line
4709 of buffer text. This function prepends and appends to the text
4710 between START and END bidi control characters that preserve the
4711 visual order of that text when it is inserted at some other place."
4716 substr para-dir from to)
4723 ;; If we don't have any mixed directional characters in the
4724 ;; entire line, we can just copy the substring without adding
4725 ;; any context.
4740 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4741 ;; (1) force the string to have the same base embedding
4742 ;; direction as the paragraph direction at the source, no matter
4743 ;; what is the paragraph direction at destination; and (2) avoid
4744 ;; affecting the visual order of the surrounding text at
4745 ;; destination if there are characters of different
4746 ;; directionality there.
4751 "Return portion of current buffer between START and END with bidi context.
4753 This function works similar to `buffer-substring', but it prepends and
4754 appends to the text bidi directional control characters necessary to
4755 preserve the visual appearance of the text if it is inserted at another
4756 place. This is useful when the buffer substring includes bidirectional
4757 text and control characters that cause non-trivial reordering on display.
4758 If copied verbatim, such text can have a very different visual appearance,
4759 and can also change the visual appearance of the surrounding text at the
4760 destination of the copy.
4762 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4763 the text properties."
4776 no-properties)))
4780 substr)))
4781 \f
4782 ;; Yanking.
4787 "List of special text property handling conditions for yanking.
4788 Each element should have the form (PROP . FUN), where PROP is a
4789 property symbol and FUN is a function. When the `yank' command
4790 inserts text into the buffer, it scans the inserted text for
4791 stretches of text that have `eq' values of the text property
4792 PROP; for each such stretch of text, FUN is called with three
4793 arguments: the property's value in that text, and the start and
4794 end positions of the text.
4796 This is done prior to removing the properties specified by
4797 `yank-excluded-properties'."
4800 function))
4803 ;; This is actually used in subr.el but defcustom does not work there.
4806 intangible invisible keymap local-map mouse-face read-only
4807 yank-handler)
4808 "Text properties to discard when yanking.
4809 The value should be a list of text properties to discard or t,
4810 which means to discard all text properties.
4812 See also `yank-handled-properties'."
4819 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4820 Function is called with two parameters, START and END corresponding to
4821 the value of the mark and point; it is guaranteed that START <= END.
4825 "Replace just-yanked stretch of killed text with a different stretch.
4826 This command is allowed only immediately after a `yank' or a `yank-pop'.
4827 At such a time, the region contains a stretch of reinserted
4828 previously-killed text. `yank-pop' deletes that text and inserts in its
4829 place a different stretch of killed text.
4831 With no argument, the previous kill is inserted.
4832 With argument N, insert the Nth previous kill.
4833 If N is negative, this is a more recent kill.
4835 The sequence of kills wraps around, so that after the oldest one
4836 comes the newest one.
4838 This command honors the `yank-handled-properties' and
4839 `yank-excluded-properties' variables, and the `yank-handler' text
4840 property, in the way that `yank' does."
4854 ;; Set the window start back where it was in the yank command,
4855 ;; if possible.
4858 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4859 ;; It is cleaner to avoid activation, even though the command
4860 ;; loop would deactivate the mark because we inserted text.
4863 nil)
4867 More precisely, reinsert the most recent kill, which is the
4868 stretch of killed text most recently killed OR yanked. Put point
4869 at the end, and set mark at the beginning without activating it.
4871 With argument N, reinsert the Nth most recent kill.
4873 This command honors the `yank-handled-properties' and
4874 `yank-excluded-properties' variables, and the `yank-handler' text
4875 property, as described below.
4877 Properties listed in `yank-handled-properties' are processed,
4878 then those listed in `yank-excluded-properties' are discarded.
4880 If STRING has a non-nil `yank-handler' property anywhere, the
4881 normal insert behavior is altered, and instead, for each contiguous
4882 segment of STRING that has a given value of the `yank-handler'
4883 property, that value is used as follows:
4885 The value of a `yank-handler' property must be a list of one to four
4886 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
4887 FUNCTION, if non-nil, should be a function of one argument (the
4888 object to insert); FUNCTION is called instead of `insert'.
4889 PARAM, if present and non-nil, is passed to FUNCTION (to be handled
4890 in whatever way is appropriate; e.g. if FUNCTION is `yank-rectangle',
4891 PARAM may be a list of strings to insert as a rectangle). If PARAM
4892 is nil, then the current segment of STRING is used.
4893 If NOEXCLUDE is present and non-nil, the normal removal of
4894 `yank-excluded-properties' is not performed; instead FUNCTION is
4895 responsible for the removal. This may be necessary if FUNCTION
4896 adjusts point before or after inserting the object.
4897 UNDO, if present and non-nil, should be a function to be called
4898 by `yank-pop' to undo the insertion of the current PARAM. It is
4899 given two arguments, the start and end of the region. FUNCTION
4900 may set `yank-undo-function' to override UNDO.
4905 ;; If we don't get all the way thru, make last-command indicate that
4906 ;; for the following command.
4914 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4915 ;; It is cleaner to avoid activation, even though the command
4916 ;; loop would deactivate the mark because we inserted text.
4919 ;; If we do get all the way thru, make this-command indicate that.
4922 nil)
4925 "Rotate the yanking point in the kill ring.
4926 With ARG, rotate that many kills forward (or backward, if negative)."
4929 \f
4930 ;; Some kill commands.
4932 ;; Internal subroutine of delete-char
4938 ;; Internal subroutine of backward-delete-char
4945 "The method for untabifying when deleting backward.
4946 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4947 `hungry' -- delete all whitespace, both tabs and spaces;
4948 `all' -- delete all whitespace, including tabs, spaces and newlines;
4949 nil -- just delete one character."
4955 "Delete characters backward, changing tabs into spaces.
4956 The exact behavior depends on `backward-delete-char-untabify-method'.
4957 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4958 Interactively, ARG is the prefix arg (default 1)
4959 and KILLP is t if a prefix arg was specified."
4982 arg)))
4983 ;; Avoid warning about delete-backward-char
4987 "Kill up to and including ARGth occurrence of CHAR.
4988 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4989 Goes backward if ARG is negative; error if CHAR not found."
4992 ;; Avoid "obsolete" warnings for translation-table-for-input.
5000 ;; kill-line and its subroutines.
5003 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
5008 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
5009 With prefix argument ARG, kill that many lines from point.
5010 Negative arguments kill lines backward.
5011 With zero argument, kills the text before point on the current line.
5014 a number counts as a prefix arg.
5016 To kill a whole line, when point is not at the beginning, type \
5019 If `show-trailing-whitespace' is non-nil, this command will just
5020 kill the rest of the current line, even if there are no nonblanks
5021 there.
5023 If option `kill-whole-line' is non-nil, then this command kills the whole line
5024 including its terminating newline, when used at the beginning of a line
5025 with no argument. As a consequence, you can always kill a whole line
5028 If you want to append the killed line to the last killed text,
5031 If the buffer is read-only, Emacs will beep and refrain from deleting
5032 the line, but put the line in the kill ring anyway. This means that
5033 you can use this command to copy text from a read-only buffer.
5034 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5035 even beep.)"
5038 ;; It is better to move point to the other end of the kill
5039 ;; before killing. That way, in a read-only buffer, point
5040 ;; moves across the text that is copied to the kill ring.
5041 ;; The choice has no effect on undo now that undo records
5042 ;; the value of point from before the command was run.
5052 ;; If trailing whitespace is visible,
5053 ;; don't treat it as nothing.
5063 "Kill current line.
5064 With prefix ARG, kill that many lines starting from the current line.
5065 If ARG is negative, kill backward. Also kill the preceding newline.
5067 If ARG is zero, kill current line but exclude the trailing newline."
5078 ;; We need to kill in two steps, because the previous command
5079 ;; could have been a kill command, in which case the text
5080 ;; before point needs to be prepended to the current kill
5081 ;; ring entry and the text after point appended. Also, we
5082 ;; need to use save-excursion to avoid copying the same text
5083 ;; twice to the kill ring in read-only buffers.
5101 "Move forward by ARG lines, ignoring currently invisible newlines only.
5102 If ARG is negative, move backward -ARG lines.
5103 If ARG is zero, move to the beginning of the current line."
5110 ;; If the newline we just skipped is invisible,
5111 ;; don't count it.
5115 prop
5120 ;; If invisible text follows, and it is a number of complete lines,
5121 ;; skip it.
5127 prop
5143 ;; If the newline we just moved to is invisible,
5144 ;; don't count it.
5149 prop
5154 ;; If invisible text follows, and it is a number of complete lines,
5155 ;; skip it.
5161 prop
5172 nil)))
5175 "Move to end of current visible line."
5177 ;; If the following character is currently invisible,
5178 ;; skip all characters with that same `invisible' property value,
5179 ;; then find the next newline.
5186 prop
5197 "Kill the current buffer.
5198 When called in the minibuffer, get out of the minibuffer
5199 using `abort-recursive-edit'.
5201 This is like `kill-this-buffer', but it doesn't have to be invoked
5202 via the menu bar, and pays no attention to the menu-bar's frame."
5210 \f
5212 "Insert after point the contents of BUFFER.
5213 Puts mark after the inserted text.
5214 BUFFER may be a buffer or a buffer name."
5224 t))))
5229 nil)
5232 "Append to specified buffer the text of the region.
5233 It is inserted into that buffer before its point.
5235 When calling from a program, give three arguments:
5236 BUFFER (or buffer name), START and END.
5237 START and END specify the portion of the current buffer to be copied."
5244 point)
5255 "Prepend to specified buffer the text of the region.
5256 It is inserted into that buffer after its point.
5258 When calling from a program, give three arguments:
5259 BUFFER (or buffer name), START and END.
5260 START and END specify the portion of the current buffer to be copied."
5269 "Copy to specified buffer the text of the region.
5270 It is inserted into that buffer, replacing existing text there.
5272 When calling from a program, give three arguments:
5273 BUFFER (or buffer name), START and END.
5274 START and END specify the portion of the current buffer to be copied."
5282 \f
5286 "Hook run when the mark becomes active.
5287 It is also run at the end of a command, if the mark is active and
5294 "Return this buffer's mark value as integer, or nil if never set.
5296 In Transient Mark mode, this function signals an error if
5297 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5298 or the argument FORCE is non-nil, it disregards whether the mark
5299 is active, and returns an integer or nil in the usual way.
5301 If you are using this in an editing command, you are most likely making
5302 a mistake; see the documentation of `set-mark'."
5307 ;; Behind display-selections-p.
5310 "Deactivate the mark.
5311 If Transient Mark mode is disabled, this function normally does
5312 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5314 Deactivating the mark sets `mark-active' to nil, updates the
5315 primary selection according to `select-active-regions', and runs
5316 `deactivate-mark-hook'.
5318 If Transient Mark mode was temporarily enabled, reset the value
5319 of the variable `transient-mark-mode'; if this causes Transient
5320 Mark mode to be disabled, don't change `mark-active' to nil or
5321 run `deactivate-mark-hook'."
5325 select-active-regions)
5328 ;; The var `saved-region-selection', if non-nil, is the text in
5329 ;; the region prior to the last command modifying the buffer.
5330 ;; Set the selection to that, or to the current region.
5335 ;; If another program has acquired the selection, region
5336 ;; deactivation should not clobber it (Bug#11772).
5355 "Activate the mark.
5356 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5366 "Set this buffer's mark to POS. Don't use this function!
5367 That is to say, don't use this function unless you want
5368 the user to see that the mark has moved, and you want the previous
5369 mark position to be lost.
5371 Normally, when a new mark is set, the old one should go on the stack.
5372 This is why most applications should use `push-mark', not `set-mark'.
5374 Novice Emacs Lisp programmers often try to use the mark for the wrong
5375 purposes. The mark saves a location for the user's convenience.
5376 Most editing commands should not alter the mark.
5377 To remember a location for internal use in the Lisp program,
5378 store it in a Lisp variable. Example:
5380 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5385 ;; Normally we never clear mark-active except in Transient Mark mode.
5386 ;; But when we actually clear out the mark value too, we must
5387 ;; clear mark-active in any mode.
5389 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5390 ;; it should never be nil if the mark is nil.
5398 mark-active))
5405 ;; Mark marker
5411 ;; Mark active
5414 ;; If mark is active now, and either was not active or was at a
5415 ;; different place, run the activate hook.
5420 ;; If mark has ceased to be active, run deactivate hook.
5425 "Like `save-excursion', but also save and restore the mark state.
5426 This macro does what `save-excursion' did before Emacs 25.1."
5436 If nil, region-aware commands treat the empty region as inactive.
5437 If non-nil, region-aware commands treat the region as active as
5438 long as the mark is active, even if the region is empty.
5440 Region-aware commands are those that act on the region if it is
5441 active and Transient Mark mode is enabled, and on the text near
5442 point otherwise."
5448 "Return t if the region is active and it is appropriate to act on it.
5449 This is used by commands that act specially on the region under
5450 Transient Mark mode.
5452 The return value is t if Transient Mark mode is enabled and the
5453 mark is active; furthermore, if `use-empty-active-region' is nil,
5454 the region must not be empty. Otherwise, the return value is nil.
5456 For some commands, it may be appropriate to ignore the value of
5457 `use-empty-active-region'; in that case, use `region-active-p'."
5462 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5464 Some commands act specially on the region when Transient Mark
5465 mode is enabled. Usually, such commands should use
5466 `use-region-p' instead of this function, because `use-region-p'
5467 also checks the value of `use-empty-active-region'."
5469 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5470 ;; without the mark being set (e.g. bug#17324). We really should fix
5471 ;; that problem, but in the mean time, let's make sure we don't say the
5472 ;; region is active when there's no mark.
5476 "Return the boundaries of the region as a pair of positions.
5477 Value is a cons cell of the form (START . END)."
5481 "Return non-nil if the region contains several pieces.
5482 An example is a rectangular region handled as a list of
5483 separate contiguous regions for each line."
5496 ;; Normal priority so that a large region doesn't hide all the
5497 ;; overlays within it, but high secondary priority so that if it
5498 ;; ends/starts in the middle of a small overlay, that small overlay
5499 ;; won't hide the region's boundaries.
5501 nrol)
5506 rol)))
5522 start end window rol)))
5525 new))))))
5528 "Hook run just before redisplay.
5529 It is called in each window that is to be redisplayed. It takes one argument,
5530 which is the window that will be redisplayed. When run, the `current-buffer'
5551 "Maximum size of mark ring. Start discarding off end if gets this big."
5559 "Maximum size of global mark ring. \
5560 Start discarding off end if gets this big."
5565 "Jump to mark, and pop a new position for mark off the ring.
5566 \(Does not affect global mark ring)."
5576 "Set mark at where point is.
5577 If no prefix ARG and mark is already set there, just activate it.
5578 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5590 will pop the mark twice, and
5592 will pop the mark three times.
5600 "Set the mark where point is, and activate it; or jump to the mark.
5601 Setting the mark also alters the region, which is the text
5602 between point and mark; this is the closest equivalent in
5605 With no prefix argument, set the mark at point, and push the
5606 old mark position on local mark ring. Also push the new mark on
5607 global mark ring, if the previous mark was set in another buffer.
5609 When Transient Mark Mode is off, immediately repeating this
5610 command activates `transient-mark-mode' temporarily.
5613 jump to the mark, and set the mark from
5614 position popped off the local mark ring (this does not affect the global
5616 mark ring (see `pop-global-mark').
5618 If `set-mark-command-repeat-pop' is non-nil, repeating
5620 off the local (or global) mark ring and jumps there.
5623 argument, unconditionally set mark where point is, even if
5624 `set-mark-command-repeat-pop' is non-nil.
5626 Novice Emacs Lisp programmers often try to use the mark for the wrong
5627 purposes. See the documentation of `set-mark' for more information."
5647 arg)
5661 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5662 If the last global mark pushed was not in the current buffer,
5663 also push LOCATION on the global mark ring.
5664 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5666 Novice Emacs Lisp programmers often try to use the mark for the wrong
5667 purposes. See the documentation of `set-mark' for more information.
5669 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5676 ;; Now push the mark on the global mark ring.
5679 ;; The last global mark pushed was in this same buffer.
5680 ;; Don't push another one.
5681 nil
5690 nil)
5693 "Pop off mark ring into the buffer's actual mark.
5694 Does not set point. Does nothing if mark ring is empty."
5706 "Put the mark where point is now, and point where the mark is now.
5707 This command works even when the mark is not active,
5708 and it reactivates the mark.
5710 If Transient Mark mode is on, a prefix ARG deactivates the mark
5711 if it is active, and otherwise avoids reactivating it. If
5712 Transient Mark mode is off, a prefix ARG enables Transient Mark
5713 mode temporarily."
5727 nil))
5730 "When non-nil, shifted motion keys activate the mark momentarily.
5732 While the mark is activated in this way, any shift-translated point
5733 motion key extends the region, and if Transient Mark mode was off, it
5734 is temporarily turned on. Furthermore, the mark will be deactivated
5735 by any subsequent point motion key that was not shift-translated, or
5736 by any action that normally deactivates the mark in Transient Mark mode.
5738 See `this-command-keys-shift-translated' for the meaning of
5739 shift-translation."
5744 "Activate/deactivate mark depending on invocation thru shift translation.
5745 This function is called by `call-interactively' when a command
5746 with a `^' character in its `interactive' spec is invoked, before
5747 running the command itself.
5749 If `shift-select-mode' is enabled and the command was invoked
5750 through shift translation, set the mark and activate the region
5751 temporarily, unless it was already set in this way. See
5752 `this-command-keys-shift-translated' for the meaning of shift
5753 translation.
5755 Otherwise, if the region has been activated temporarily,
5756 deactivate it, and restore the variable `transient-mark-mode' to
5757 its earlier value."
5764 transient-mark-mode)))
5773 "Toggle Transient Mark mode.
5774 With a prefix argument ARG, enable Transient Mark mode if ARG is
5775 positive, and disable it otherwise. If called from Lisp, enable
5776 Transient Mark mode if ARG is omitted or nil.
5778 Transient Mark mode is a global minor mode. When enabled, the
5779 region is highlighted with the `region' face whenever the mark
5781 and after certain other operations that set the mark but whose
5782 main purpose is something else--for example, incremental search,
5788 Many commands change their behavior when Transient Mark mode is
5789 in effect and the mark is active, by acting on the region instead
5790 of their usual default part of the buffer's text. Examples of
5793 To see the documentation of commands which are sensitive to the
5796 :global t
5797 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5801 "Non-nil means it is ok for commands to call `widen' when they want to.
5802 Some commands will do this in order to go to positions outside
5803 the current accessible part of the buffer.
5805 If `widen-automatically' is nil, these commands will do something else
5809 "Whether the currently executing code is performing an essential task.
5810 This variable should be non-nil only when running code which should not
5811 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5812 user for a password when we are simply scanning a set of files in the
5813 background or displaying possible completions before the user even asked
5817 "Pop off global mark ring and jump to the top location."
5819 ;; Pop entries which refer to non-existent buffers.
5837 \f
5839 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5845 "Move cursor vertically down ARG lines.
5846 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5847 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5848 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5849 function will not vscroll.
5851 ARG defaults to 1.
5853 If there is no character in the target line exactly under the current column,
5854 the cursor is positioned after the character in that line which spans this
5855 column, or at the end of the line if it is not long enough.
5856 If there is no line in the buffer after this one, behavior depends on the
5857 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5858 to create a line, and moves the cursor to that line. Otherwise it moves the
5859 cursor to the end of the buffer.
5861 If the variable `line-move-visual' is non-nil, this command moves
5862 by display lines. Otherwise, it moves by buffer lines, without
5863 taking variable-width characters or continued lines into account.
5867 a semipermanent goal column for this command.
5868 Then instead of trying to move exactly vertically (or as close as possible),
5869 this command moves to the specified goal column (or as close as possible).
5870 The goal column is stored in the variable `goal-column', which is nil
5871 when there is no goal column. Note that setting `goal-column'
5872 overrides `line-move-visual' and causes this command to move by buffer
5873 lines rather than by display lines."
5879 ;; When adding a newline, don't expand an abbrev.
5890 nil)
5893 "Move cursor vertically up ARG lines.
5894 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5895 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5896 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5897 function will not vscroll.
5899 ARG defaults to 1.
5901 If there is no character in the target line exactly over the current column,
5902 the cursor is positioned after the character in that line which spans this
5903 column, or at the end of the line if it is not long enough.
5905 If the variable `line-move-visual' is non-nil, this command moves
5906 by display lines. Otherwise, it moves by buffer lines, without
5907 taking variable-width characters or continued lines into account.
5911 a semipermanent goal column for this command.
5912 Then instead of trying to move exactly vertically (or as close as possible),
5913 this command moves to the specified goal column (or as close as possible).
5914 The goal column is stored in the variable `goal-column', which is nil
5915 when there is no goal column. Note that setting `goal-column'
5916 overrides `line-move-visual' and causes this command to move by buffer
5917 lines rather than by display lines."
5928 nil)
5931 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5932 This means moving to the end of each line moved onto.
5933 The beginning of a blank line does not count as the end of a line.
5934 This has no effect when the variable `line-move-visual' is non-nil."
5940 A non-nil setting overrides the variable `line-move-visual', which see."
5947 "Current goal column for vertical motion.
5948 It is the column where point was at the start of the current run
5949 of vertical motion commands.
5951 When moving by visual lines via the function `line-move-visual', it is a cons
5952 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5953 divided by the default column width, and HSCROLL is the number of
5954 columns by which window is scrolled from left margin.
5956 When the `track-eol' feature is doing its job, the value is
5960 "Last value of width used for displaying line numbers.
5964 "Non-nil means commands that move by lines ignore invisible newlines.
5965 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5966 as if newlines that are invisible didn't exist, and count
5967 only visible newlines. Thus, moving across across 2 newlines
5968 one of which is invisible will be counted as a one-line move.
5969 Also, a non-nil value causes invisible text to be ignored when
5970 counting columns for the purposes of keeping point in the same
5973 Outline mode sets this."
5978 "When non-nil, `line-move' moves point by visual lines.
5979 This movement is based on where the cursor is displayed on the
5980 screen, instead of relying on buffer contents alone. It takes
5981 into account variable-width characters and line continuation.
5982 If nil, `line-move' moves point by logical lines.
5983 A non-nil setting of `goal-column' overrides the value of this variable
5984 and forces movement by logical lines.
5985 A window that is horizontally scrolled also forces movement by logical
5986 lines."
5991 ;; Only used if display-graphic-p.
5995 "Return the height in pixels of the current buffer's default face font.
5997 If the default font is remapped (see `face-remapping-alist'), the
5998 function returns the height of the remapped face."
6002 ;; Avoid calling font-info if the frame's default font was
6003 ;; not changed since the frame was created. That's because
6004 ;; font-info is expensive for some fonts, see bug #14838.
6010 "Return the width in pixels of the current buffer's default face font.
6012 If the default font is remapped (see `face-remapping-alist'), the
6013 function returns the width of the remapped face."
6017 ;; Avoid calling font-info if the frame's default font was
6018 ;; not changed since the frame was created. That's because
6019 ;; font-info is expensive for some fonts, see bug #14838.
6024 width
6029 "Return the pixel height of current buffer's default-face text line.
6031 The value includes `line-spacing', if any, defined for the buffer
6032 or the frame."
6045 "Return the number of screen lines in the text area of the selected window.
6047 This is different from `window-text-height' in that this function counts
6048 lines in units of the height of the font used by the default face displayed
6049 in the window, not in units of the frame's default font, and also accounts
6050 for `line-spacing', if any, defined for the window's buffer or frame.
6052 The value is a floating-point number."
6057 ;; Returns non-nil if partial move was done.
6060 ;; Move backward (up).
6061 ;; If already vscrolled, reduce vscroll
6067 ;; Move forward (down).
6080 py vs last-line)
6100 col-row)
6105 ;; VPOS > 0 means the last line is only partially visible.
6106 ;; But if the part that is visible is at least as tall as the
6107 ;; default font, that means the line is actually fully
6108 ;; readable, and something like line-spacing is hidden. So in
6109 ;; that case we accept the last line in the window as still
6110 ;; visible, and consider the margin as starting one line
6111 ;; later.
6119 ;; If last line of window is fully visible, and vscrolling
6120 ;; more would make this line invisible, move forward.
6125 nil)
6126 ;; If cursor is not in the bottom scroll margin, and the
6127 ;; current line is is not too tall, move forward.
6129 vpos
6132 nil)
6133 ;; When already vscrolled, we vscroll some more if we can,
6134 ;; or clear vscroll and move forward at end of tall image.
6139 ;; If cursor just entered the bottom scroll margin, move forward,
6140 ;; but also optionally vscroll one line so redisplay won't recenter.
6144 ;; Don't vscroll if the partially-visible line at window
6145 ;; bottom is not too tall (a.k.a. "just one more text
6146 ;; line"): in that case, we do want redisplay to behave
6147 ;; normally, i.e. recenter or whatever.
6148 ;;
6149 ;; Note: ROWH + RBOT from the value returned by
6150 ;; pos-visible-in-window-p give the total height of the
6151 ;; partially-visible glyph row at the end of the window. As
6152 ;; we are dealing with floats, we disregard sub-pixel
6153 ;; discrepancies between that and DLH.
6157 t)
6158 ;; If there are lines above the last line, scroll-up one line.
6161 t)
6162 ;; Finally, start vscroll.
6167 ;; This is like line-move-1 except that it also performs
6168 ;; vertical scrolling of tall images if appropriate.
6169 ;; That is not really a clean thing to do, since it mixes
6170 ;; scrolling with cursor motion. But so far we don't have
6171 ;; a cleaner solution to the problem of making C-n do something
6172 ;; useful given a tall image.
6174 "Move forward ARG lines.
6175 If NOERROR, don't signal an error if we can't move ARG lines.
6176 TO-END is unused.
6177 TRY-VSCROLL controls whether to vscroll tall lines: if either
6178 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6179 not vscroll."
6183 ;; Only vscroll for single line moves
6185 ;; Under scroll-conservatively, the display engine
6186 ;; does this better.
6188 ;; But don't vscroll in a keyboard macro.
6194 ;; Display-based column are incompatible with goal-column.
6196 ;; When the text in the window is scrolled to the left,
6197 ;; display-based motion doesn't make sense (because each
6198 ;; logical line occupies exactly one screen line).
6200 ;; Likewise when the text _was_ scrolled to the left
6201 ;; when the current run of vertical motion commands
6202 ;; started.
6205 auto-hscroll-mode
6207 (>= temporary-goal-column
6210 ;; If we moved into a tall line, set vscroll to make
6211 ;; scrolling through tall images more smooth.
6215 winh)
6221 nil
6225 ;; Display-based alternative to line-move-1.
6226 ;; Arg says how many lines to move. The value is t if we can move the
6227 ;; specified number of lines.
6229 "Move ARG lines forward.
6230 If NOERROR, don't signal an error if we can't move that many lines."
6234 target-hscroll)
6235 ;; Check if the previous command was a line-motion command, or if
6236 ;; we were called from some other command.
6239 ;; If so, there's no need to reset `temporary-goal-column',
6240 ;; but we may need to hscroll.
6245 ;; Update the COLUMN part of temporary-goal-column if the
6246 ;; line-number display changed its width since the last
6247 ;; time.
6254 ;; Otherwise, we should reset `temporary-goal-column'.
6256 x-pos)
6258 ;; Handle the `overflow-newline-into-fringe' case
6259 ;; (left-fringe is for the R2L case):
6264 ;; In R2L lines, the X pixel coordinate is measured from the
6265 ;; left edge of the window, but columns are still counted
6266 ;; from the logical-order beginning of the line, i.e. from
6267 ;; the right edge in this case. We need to adjust for that.
6273 hscroll)))
6275 ;; When we move beyond the first/last character visible in
6276 ;; the window, posn-at-point will return nil, so we need to
6277 ;; approximate the goal column as below.
6282 ;; vertical-motion can move more than it was asked to if it moves
6283 ;; across display strings with newlines. We don't want to ring
6284 ;; the bell and announce beginning/end of buffer in that case.
6290 temporary-goal-column))
6291 arg))
6292 arg))
6298 temporary-goal-column))
6299 arg))
6300 arg)))
6303 ;; If the goal column lies on a display string,
6304 ;; `vertical-motion' advances the cursor to the end
6305 ;; of the string. For arg < 0, this can cause the
6306 ;; cursor to get stuck. (Bug#3020).
6310 nil)))))
6312 ;; This is the guts of next-line and previous-line.
6313 ;; Arg says how many lines to move.
6314 ;; The value is t if we can move the specified number of lines.
6316 ;; Don't run any point-motion hooks, and disregard intangibility,
6317 ;; for intermediate positions.
6329 ;; Don't count beg of empty line as end of line
6330 ;; unless we just did explicit end-of-line.
6332 most-positive-fixnum
6336 line-move-ignore-invisible))
6337 ;; Use just newline characters.
6338 ;; Set ARG to 0 if we move as many lines as requested.
6341 ;; This way of moving forward ARG lines
6342 ;; verifies that we have a newline after the last one.
6343 ;; It doesn't get confused by intangible text.
6352 'beginning-of-buffer
6354 nil)))
6355 ;; Move by arg lines, but ignore invisible ones.
6358 ;; If the following character is currently invisible,
6359 ;; skip all characters with that same `invisible' property value.
6362 ;; Move a line.
6363 ;; We don't use `end-of-line', since we want to escape
6364 ;; from field boundaries occurring exactly at point.
6370 ;; If there's no invisibility here, move over the newline.
6379 ;; We avoid vertical-motion when possible
6380 ;; because that has to fontify.
6382 ;; Otherwise move a more sophisticated way.
6389 ;; The logic of this is the same as the loop above,
6390 ;; it just goes in the other direction.
6392 ;; For completely consistency with the forward-motion
6393 ;; case, we should call beginning-of-line here.
6394 ;; However, if point is inside a field and on a
6395 ;; continued line, the call to (vertical-motion -1)
6396 ;; below won't move us back far enough; then we return
6397 ;; to the same column in line-move-finish, and point
6398 ;; gets stuck -- cyd
6416 ;; if our target is the middle of this line.
6421 ;; This is the value the function returns.
6425 ;; If we did not move down as far as desired, at least go
6426 ;; to end of line. Be sure to call point-entered and
6427 ;; point-left-hooks.
6433 ;; If we did not move up as far as desired,
6434 ;; at least go to beginning of line.
6446 ;; Set REPEAT to t to repeat the whole thing.
6453 ;; Compute the end of the line
6454 ;; ignoring effectively invisible newlines.
6456 ;; Like end-of-line but ignores fields.
6463 ;; Move to the desired column.
6466 ;; Under line-move-visual, goal-column should be
6467 ;; interpreted in units of the frame's canonical character
6468 ;; width, which is exactly what vertical-motion does.
6472 ;; Corner case: suppose we start out in a field boundary in
6473 ;; the middle of a continued line. When we get to
6474 ;; line-move-finish, point is at the start of a new *screen*
6475 ;; line but the same text line; then line-move-to-column would
6476 ;; move us backwards. Test using C-n with point on the "x" in
6477 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6484 ;; Process intangibility within a line.
6485 ;; With inhibit-point-motion-hooks bound to nil, a call to
6486 ;; goto-char moves point past intangible text.
6488 ;; However, inhibit-point-motion-hooks controls both the
6489 ;; intangibility and the point-entered/point-left hooks. The
6490 ;; following hack avoids calling the point-* hooks
6491 ;; unnecessarily. Note that we move *forward* past intangible
6492 ;; text when the initial and final points are the same.
6497 ;; If intangibility moves us to a different (later) place
6498 ;; in the same line, use that as the destination.
6501 ;; If that position is "too late",
6502 ;; try the previous allowable position.
6503 ;; See if it is ok.
6506 ;; If going forward, don't accept the previous
6507 ;; allowable position if it is before the target line.
6509 ;; If going backward, don't accept the previous
6510 ;; allowable position if it is still after the target line.
6513 ;; As a last resort, use the end of the line.
6516 ;; Now move to the updated destination, processing fields
6517 ;; as well as intangibility.
6521 ;; Ignore field boundaries if the initial and final
6522 ;; positions have the same `field' property, even if the
6523 ;; fields are non-contiguous. This seems to be "nicer"
6524 ;; behavior in many situations.
6527 new
6531 ;; If all this moved us to a different line,
6532 ;; retry everything within that new line.
6534 ;; Repeat the intangibility and field processing.
6538 "Try to find column COL, considering invisibility.
6539 This function works only in certain cases,
6540 because what we really need is for `move-to-column'
6541 and `current-column' to be able to ignore invisible text."
6550 ;; If the following character is currently invisible,
6551 ;; skip all characters with that same `invisible' property value.
6555 ;; Have we advanced to a larger column position?
6557 ;; We have made some progress towards the desired column.
6558 ;; See if we can make any further progress.
6560 ;; Otherwise, go to the place we originally found
6561 ;; and move back over invisible text.
6562 ;; that will get us to the same place on the screen
6563 ;; but with a more reasonable buffer position.
6566 ;; We want the real line beginning, so it's consistent
6567 ;; with bolp below, otherwise we might infloop.
6574 "Move point to end of current line as displayed.
6575 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6576 If point reaches the beginning or end of buffer, it stops there.
6578 To ignore the effects of the `intangible' text or overlay
6579 property, bind `inhibit-point-motion-hooks' to t.
6580 If there is an image in the current line, this function
6581 disregards newlines that are part of the text on which the image
6582 rests."
6592 ;; With bidi reordering, we may not be at bol,
6593 ;; so make sure we are.
6608 ;; If we skipped something intangible and now we're not
6609 ;; really at eol, keep going.
6614 "Move point to beginning of current line as displayed.
6615 \(If there's an image in the line, this disregards newlines
6616 which are part of the text that the image rests on.)
6618 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6619 If point reaches the beginning or end of buffer, it stops there.
6620 \(But if the buffer doesn't end in a newline, it stops at the
6621 beginning of the last line.)
6622 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6627 first-vis first-vis-field-value)
6629 ;; Move by lines, if ARG is not 1 (the default).
6634 ;; Move to beginning-of-line, ignoring fields and invisible text.
6640 ;; Now find first visible char in the line.
6645 ;; See if fields would stop us from reaching FIRST-VIS.
6650 ;; If yes, obey them.
6651 first-vis-field-value
6652 ;; Otherwise, move to START with attention to fields.
6653 ;; (It is possible that fields never matter in this case.)
6658 ;; Many people have said they rarely use this feature, and often type
6659 ;; it by accident. Maybe it shouldn't even be on a key.
6664 Those commands will move to this position in the line moved to
6665 rather than trying to keep the same horizontal position.
6666 With a non-nil argument ARG, clears out the goal column
6668 The goal column is stored in the variable `goal-column'.
6669 This is a buffer-local setting."
6676 ;; The older method below can be erroneous if `set-goal-column' is bound
6677 ;; to a sequence containing %
6678 ;;(message (substitute-command-keys
6679 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6680 ;;goal-column)
6687 )
6688 nil)
6689 \f
6690 ;;; Editing based on visual lines, as opposed to logical lines.
6693 "Move point to end of current visual line.
6694 With argument N not nil or 1, move forward N - 1 visual lines first.
6695 If point reaches the beginning or end of buffer, it stops there.
6696 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6702 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6703 ;; constrain to field boundaries, so we don't either.
6707 "Move point to beginning of current visual line.
6708 With argument N not nil or 1, move forward N - 1 visual lines first.
6709 If point reaches the beginning or end of buffer, it stops there.
6710 \(But if the buffer doesn't end in a newline, it stops at the
6711 beginning of the last visual line.)
6712 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6720 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6724 "Kill the rest of the visual line.
6725 With prefix argument ARG, kill that many visual lines from point.
6726 If ARG is negative, kill visual lines backward.
6727 If ARG is zero, kill the text before point on the current visual
6728 line.
6730 If you want to append the killed line to the last killed text,
6733 If the buffer is read-only, Emacs will beep and refrain from deleting
6734 the line, but put the line in the kill ring anyway. This means that
6735 you can use this command to copy text from a read-only buffer.
6736 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6737 even beep.)"
6739 ;; Like in `kill-line', it's better to move point to the other end
6740 ;; of the kill before killing.
6748 ;; Skip any trailing whitespace at the end of the visual line.
6749 ;; We used to do this only if `show-trailing-whitespace' is
6750 ;; nil, but that's wrong; the correct thing would be to check
6751 ;; whether the trailing whitespace is highlighted. But, it's
6752 ;; OK to just do this unconditionally.
6759 "Move cursor vertically down ARG lines.
6760 This is identical to `next-line', except that it always moves
6761 by logical lines instead of visual lines, ignoring the value of
6762 the variable `line-move-visual'."
6769 "Move cursor vertically up ARG lines.
6770 This is identical to `previous-line', except that it always moves
6771 by logical lines instead of visual lines, ignoring the value of
6772 the variable `line-move-visual'."
6779 "Editing based on visual lines."
6788 ;; These keybindings interfere with xterm function keys. Are
6789 ;; there any other suitable bindings?
6790 ;; (define-key map "\M-[" 'previous-logical-line)
6791 ;; (define-key map "\M-]" 'next-logical-line)
6792 map))
6795 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6796 The value should be a list of the form (LEFT RIGHT), where LEFT
6797 and RIGHT are symbols representing the bitmaps to display, to
6798 indicate wrapped lines, in the left and right fringes respectively.
6799 See also `fringe-indicator-alist'.
6800 The default is not to display fringe indicators for wrapped lines.
6801 This variable does not affect fringe indicators displayed for
6802 other purposes."
6817 'continuation
6824 "Toggle visual line based editing (Visual Line mode) in the current buffer.
6825 Interactively, with a prefix argument, enable
6826 Visual Line mode if the prefix argument is positive,
6827 and disable it otherwise. If called from Lisp, toggle
6828 the mode if ARG is `toggle', disable the mode if ARG is
6829 a non-positive integer, and enable the mode otherwise
6830 \(including if ARG is omitted or nil or a positive integer).
6832 When Visual Line mode is enabled, `word-wrap' is turned on in
6833 this buffer, and simple editing commands are redefined to act on
6834 visual lines, not logical lines. See Info node `Visual Line
6835 Mode' for details."
6836 :keymap visual-line-mode-map
6842 ;; Save the local values of some variables, to be restored if
6843 ;; visual-line-mode is turned off.
6845 truncate-partial-width-windows
6846 word-wrap fringe-indicator-alist))
6849 visual-line--saved-state)))
6853 word-wrap t
6854 fringe-indicator-alist
6856 fringe-indicator-alist)))
6870 visual-line-mode turn-on-visual-line-mode)
6872 \f
6874 "Interchange characters around point, moving forward one character.
6875 With prefix arg ARG, effect is to take character before point
6876 and drag it forward past ARG other characters (backward if ARG negative).
6877 If no argument and at end of line, the previous two chars are exchanged."
6885 "Interchange words around point, leaving point at end of them.
6886 With prefix arg ARG, effect is to take word before or around point
6887 and drag it forward past ARG other words (backward if ARG negative).
6888 If ARG is zero, the words around or after point and around or after mark
6889 are interchanged."
6890 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6896 Unlike `transpose-words', point must be between the two sexps and not
6897 in the middle of a sexp to be transposed.
6898 With non-zero prefix arg ARG, effect is to take the sexp before point
6899 and drag it forward past ARG other sexps (backward if ARG is negative).
6900 If ARG is zero, the sexps ending at or after point and at or after mark
6901 are interchanged."
6905 ;; Here we should try to simulate the behavior of
6906 ;; (cons (progn (forward-sexp x) (point))
6907 ;; (progn (forward-sexp (- x)) (point)))
6908 ;; Except that we don't want to rely on the second forward-sexp
6909 ;; putting us back to where we want to be, since forward-sexp-function
6910 ;; might do funny things like infix-precedence.
6915 ;; Jumping over a symbol. We might be inside it, mind you.
6920 ;; Otherwise, we're between sexps. Take a step back before jumping
6921 ;; to make sure we'll obey the same precedence no matter which direction
6922 ;; we're going.
6927 'skip-syntax-forward
6934 "Exchange current line and previous line, leaving point after both.
6935 With argument ARG, takes previous line and moves it past ARG lines.
6936 With argument 0, interchanges line point is in with line mark is in."
6942 ;; Move forward over ARG lines,
6943 ;; but create newlines if necessary.
6950 arg))
6952 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6953 ;; which seems inconsistent with the ARG /= 0 case.
6954 ;; FIXME document SPECIAL.
6956 "Subroutine to do the work of transposing objects.
6957 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6958 moves forward by units of the given object (e.g. forward-sentence,
6959 forward-paragraph). If ARG is zero, exchanges the current object
6960 with the one containing mark. If ARG is an integer, moves the
6961 current object past ARG following (if ARG is positive) or
6962 preceding (if ARG is negative) objects, leaving point after the
6963 current object."
6968 pos1 pos2)
6997 ;; This sequence of insertions attempts to preserve marker
6998 ;; positions at the start and end of the transposed objects.
7012 \f
7014 "Move backward until encountering the beginning of a word.
7015 With argument ARG, do this that many times.
7016 If ARG is omitted or nil, move point backward one word.
7018 The word boundaries are normally determined by the buffer's syntax
7019 table, but `find-word-boundary-function-table', such as set up
7020 by `subword-mode', can change that. If a Lisp program needs to
7021 move by words determined strictly by the syntax table, it should
7022 use `backward-word-strictly' instead."
7027 "Set mark ARG words away from point.
7029 move to with the same argument.
7030 Interactively, if this command is repeated
7031 or (in Transient Mark mode) if the mark is active,
7032 it marks the next ARG words after the ones already marked."
7049 nil t))))
7052 "Kill characters forward until encountering the end of a word.
7053 With argument ARG, do this that many times."
7058 "Kill characters backward until encountering the beginning of a word.
7059 With argument ARG, do this that many times."
7064 "Return the word at or near point, as a string.
7065 The return value includes no text properties.
7067 If optional arg STRICT is non-nil, return nil unless point is
7068 within or adjacent to a word, otherwise look for a word within
7069 point's line. If there is no word anywhere on point's line, the
7070 value is nil regardless of STRICT.
7072 By default, this function treats as a single word any sequence of
7073 characters that have either word or symbol syntax. If optional
7074 arg REALLY-WORD is non-nil, only characters of word syntax can
7075 constitute a word."
7084 ;; Point is neither within nor adjacent to a word.
7086 ;; Look for preceding word in same line.
7089 ;; No preceding word in same line.
7090 ;; Look for following word in same line.
7099 ;; If we found something nonempty, return it as a string.
7102 \f
7104 "String for filling to insert at front of new line, or nil for none."
7106 string)
7112 "Regexp to match lines which should not be auto-filled."
7114 regexp)
7118 "The default value for `normal-auto-fill-function'.
7119 This is the default auto-fill function, some major modes use a different one.
7120 Returns t if it really did any work."
7130 nil ;; Auto-filling not required
7134 ;; Choose a fill-prefix automatically.
7142 ;; Use auto-indentation rather than a guessed empty prefix.
7148 ;; Determine where to split the line.
7152 ;; Don't split earlier in the line than the length of the
7153 ;; fill prefix, since the resulting line would be longer.
7161 ;; See whether the place we found is any good.
7165 ;; There is no use breaking at end of line.
7167 ;; Don't split right after a comment starter
7168 ;; since we would just make another comment starter.
7173 limit t)
7175 ;; No good place to break => stop trying.
7177 ;; Ok, we have a useful place to break the line. Do it.
7179 ;; If point is at the fill-point, do not `save-excursion'.
7180 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7181 ;; point will end up before it rather than after it.
7189 ;; Now do justification, if required
7194 ;; If making the new line didn't reduce the hpos of
7195 ;; the end of the line, then give up now;
7196 ;; trying again will not help.
7199 ;; Justify last line.
7201 t)))
7204 "Mode-specific function which line breaks and continues a comment.
7205 This function is called during auto-filling when a comment syntax
7206 is defined.
7207 The function should take a single optional argument, which is a flag
7211 "Break line at point and indent.
7212 If a comment syntax is defined, call `comment-indent-new-line'.
7214 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7215 unless optional argument SOFT is non-nil."
7219 ;; Insert the newline before removing empty space so that markers
7220 ;; get preserved better.
7226 ;; Blindly trust a non-adaptive fill-prefix.
7232 ;; If there's an adaptive prefix, use it unless we're inside
7233 ;; a comment and the prefix is not a comment starter.
7237 ;; If we're not inside a comment, just try to indent.
7241 "The function called by `self-insert-command' to perform auto-filling."
7248 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7252 ;; `functions' and `hooks' are usually unsafe to set, but setting
7253 ;; auto-fill-function to nil in a file-local setting is safe and
7254 ;; can be useful to prevent auto-filling.
7258 "Toggle automatic line breaking (Auto Fill mode).
7259 Interactively, with a prefix argument, enable
7260 Auto Fill mode if the prefix argument is positive,
7261 and disable it otherwise. If called from Lisp, toggle
7262 the mode if ARG is `toggle', disable the mode if ARG is
7263 a non-positive integer, and enable the mode otherwise
7264 \(including if ARG is omitted or nil or a positive integer).
7266 When Auto Fill mode is enabled, inserting a space at a column
7267 beyond `current-fill-column' automatically breaks the line at a
7268 previous space.
7270 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7271 non-nil.
7273 The value of `normal-auto-fill-function' specifies the function to use
7274 for `auto-fill-function' when turning Auto Fill mode on."
7279 ;; This holds a document string used to document auto-fill-mode.
7281 "Automatically break line at a previous space, in insertion of text."
7282 nil)
7285 "Unconditionally turn on Auto Fill mode."
7289 "Unconditionally turn off Auto Fill mode."
7295 "Set `fill-column' to specified argument.
7300 ;; We used to use current-column silently, but C-x f is too easily
7301 ;; typed as a typo for C-x C-f, so we turned it into an error and
7302 ;; now an interactive prompt.
7307 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7311 \f
7313 "Set `selective-display' to ARG; clear it if no arg.
7314 When the value of `selective-display' is a number > 0,
7315 lines whose indentation is >= that value are not displayed.
7316 The variable `selective-display' has a separate value for each buffer."
7336 "Toggle truncating of long lines for the current buffer.
7337 When truncating is off, long lines are folded.
7338 With prefix argument ARG, truncate long lines if ARG is positive,
7339 otherwise fold them. Note that in side-by-side windows, this
7340 command has no effect if `truncate-partial-width-windows' is
7341 non-nil."
7353 nil t)))
7358 "Toggle whether to use word-wrapping for continuation lines.
7359 With prefix argument ARG, wrap continuation lines at word boundaries
7360 if ARG is positive, otherwise wrap them at the right screen edge.
7361 This command toggles the value of `word-wrap'. It has no effect
7362 if long lines are truncated."
7378 "Toggle Overwrite mode.
7379 With a prefix argument ARG, enable Overwrite mode if ARG is
7380 positive, and disable it otherwise. If called from Lisp, enable
7381 the mode if ARG is omitted or nil.
7383 When Overwrite mode is enabled, printing characters typed in
7384 replace existing text on a one-for-one basis, rather than pushing
7385 it to the right. At the end of a line, such characters extend
7386 the line. Before a tab, such characters insert until the tab is
7388 overwrite mode; this is supposed to make it easier to insert
7389 characters when necessary."
7394 "Toggle Binary Overwrite mode.
7395 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7396 is positive, and disable it otherwise. If called from Lisp,
7397 enable the mode if ARG is omitted or nil.
7399 When Binary Overwrite mode is enabled, printing characters typed
7400 in replace existing text. Newlines are not treated specially, so
7401 typing at the end of a line joins the line to the next, with the
7402 typed character between them. Typing before a tab character
7403 simply replaces the tab with the character typed.
7405 ordinary typing characters do.
7407 Note that Binary Overwrite mode is not its own minor mode; it is
7408 a specialization of overwrite mode, entered by setting the
7409 `overwrite-mode' variable to `overwrite-mode-binary'."
7414 "Toggle line number display in the mode line (Line Number mode).
7415 With a prefix argument ARG, enable Line Number mode if ARG is
7416 positive, and disable it otherwise. If called from Lisp, enable
7417 the mode if ARG is omitted or nil.
7419 Line numbers do not appear for very large buffers and buffers
7420 with very long lines; see variables `line-number-display-limit'
7421 and `line-number-display-limit-width'."
7425 "Toggle column number display in the mode line (Column Number mode).
7426 With a prefix argument ARG, enable Column Number mode if ARG is
7427 positive, and disable it otherwise.
7429 If called from Lisp, enable the mode if ARG is omitted or nil."
7433 "Toggle buffer size display in the mode line (Size Indication mode).
7434 With a prefix argument ARG, enable Size Indication mode if ARG is
7435 positive, and disable it otherwise.
7437 If called from Lisp, enable the mode if ARG is omitted or nil."
7441 "Toggle auto-saving in the current buffer (Auto Save mode).
7442 With a prefix argument ARG, enable Auto Save mode if ARG is
7443 positive, and disable it otherwise.
7445 If called from Lisp, enable the mode if ARG is omitted or nil."
7447 ;; If auto-save is off because buffer has shrunk,
7448 ;; then toggling should turn it on.
7456 buffer-file-name)
7458 ;; If -1 was stored here, to temporarily turn off saving,
7459 ;; turn it back on.
7462 \f
7464 "Blinking matching of parens and expressions."
7469 "Non-nil means show matching open-paren when close-paren is inserted.
7470 If t, highlight the paren. If `jump', briefly move cursor to its
7471 position. If `jump-offscreen', move cursor there even if the
7472 position is off screen. With any other non-nil value, the
7473 off-screen position of the opening paren will be shown in the
7474 echo area."
7483 "Non-nil means show matching open-paren when it is on screen.
7484 If nil, don't show it (but the open-paren can still be shown
7485 in the echo area when it is off screen).
7487 This variable has no effect if `blink-matching-paren' is nil.
7488 \(In that case, the open-paren is never shown.)
7489 It is also ignored if `show-paren-mode' is enabled."
7494 "If non-nil, maximum distance to search backwards for matching open-paren.
7495 If nil, search stops at the beginning of the accessible portion of the buffer."
7501 "Time in seconds to delay after showing a matching paren."
7506 "If nil, `blink-matching-paren' ignores comments.
7507 More precisely, when looking for the matching parenthesis,
7508 it skips the contents of comments that end before point."
7513 "Return whether or not START...END are matching parens.
7514 END is the current point and START is the blink position.
7515 START might be nil if no matching starter was found.
7516 Returns non-nil if we find there is a mismatch."
7521 ;; For self-matched chars like " and $, we can't know when they're
7522 ;; mismatched or unmatched, so we can only do it for parens.
7527 ;; The cdr might hold a new paren-class info rather than
7528 ;; a matching-char info, in which case the two CDRs
7529 ;; should match.
7533 "Function to check parentheses mismatches.
7534 The function takes two arguments (START and END) where START is the
7535 position just before the opening token and END is the position right after.
7536 START can be nil, if it was not found.
7543 ol)
7547 "Momentarily highlight the beginning of the sexp before point."
7550 blink-matching-paren)
7560 oldpos))
7568 ;; backward-sexp skips backward over prefix chars,
7569 ;; so move back to the matching paren.
7592 ;; Matching open within window, temporarily move to or highlight
7593 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7594 ;; is non-nil.
7611 ;; Show what precedes the open in its line, if anything.
7616 ;; Show what follows the open in its line, if anything.
7623 ;; Otherwise show the previous nonblank line,
7624 ;; if there is one.
7633 ;; Replace the newline and other whitespace with `...'.
7634 "..."
7636 ;; There is nothing to show except the char itself.
7639 "Matches %s"
7643 "Function called, if non-nil, whenever a close parenthesis is inserted.
7649 blink-paren-function
7652 ;; Verify an even number of quoting characters precede the close.
7653 ;; FIXME: Also check if this parenthesis closes a comment as
7654 ;; can happen in Pascal and SML.
7665 ;; Most likely, this hook is nil, so this arg doesn't matter,
7666 ;; but I use it as a reminder that this function usually
7667 ;; likes to be run after others since it does
7668 ;; `sit-for'. That's also the reason it get a `priority' prop
7669 ;; of 100.
7671 \f
7672 ;; This executes C-g typed while Emacs is waiting for a command.
7673 ;; Quitting out of a program does not go through here;
7674 ;; that happens in the maybe_quit function at the C code level.
7676 "Signal a `quit' condition.
7677 During execution of Lisp code, this character causes a quit directly.
7678 At top-level, as an editor command, this simply beeps."
7680 ;; Avoid adding the region to the window selection.
7688 ;; Force the next redisplay cycle to remove the "Def" indicator from
7689 ;; all the mode lines.
7703 This command can exit an interactive command such as `query-replace',
7704 can clear out a prefix argument or a region,
7705 can get out of the minibuffer or other recursive edit,
7706 cancel the use of the current buffer (for special-purpose buffers),
7707 or go back to just one window (by deleting all but the selected window)."
7715 nil)
7726 "Play sound stored in FILE.
7727 VOLUME and DEVICE correspond to the keywords of the sound
7728 specification for `play-sound'."
7738 \f
7740 "Your preference for a mail reading package.
7741 This is used by some keybindings which support reading mail.
7742 See also `mail-user-agent' concerning sending mail."
7752 "Your preference for a mail composition package.
7753 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7754 outgoing email message. This variable lets you specify which
7755 mail-sending package you prefer.
7757 Valid values include:
7759 `message-user-agent' -- use the Message package.
7760 See Info node `(message)'.
7761 `sendmail-user-agent' -- use the Mail package.
7762 See Info node `(emacs)Sending Mail'.
7763 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7764 See Info node `(mh-e)'.
7765 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7766 paraphernalia if Gnus is running, particularly
7767 the Gcc: header for archiving.
7769 Additional valid symbols may be available; check with the author of
7770 your package for details. The function should return non-nil if it
7771 succeeds.
7773 See also `read-mail-command' concerning reading mail."
7776 message-user-agent)
7779 sendmail-user-agent)
7782 mh-e-user-agent)
7785 gnus-user-agent)
7791 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7792 If the value of `mail-user-agent' is the default, and the user
7793 appears to have customizations applying to the old default,
7794 `compose-mail' issues a warning."
7800 "If the buffer starts with a mail header, move point to the header's end.
7801 Otherwise, moves to `point-min'.
7802 The end of the header is the start of the next line, if there is one,
7803 else the end of the last line. This function obeys RFC822."
7809 ;; Used by Rmail (e.g., rmail-forward).
7811 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7815 switch-function yank-action send-actions
7816 return-action)
7817 "Start composing a mail message to send.
7818 This uses the user's chosen mail composition package
7819 as selected with the variable `mail-user-agent'.
7820 The optional arguments TO and SUBJECT specify recipients
7821 and the initial Subject field, respectively.
7823 OTHER-HEADERS is an alist specifying additional
7824 header fields. Elements look like (HEADER . VALUE) where both
7825 HEADER and VALUE are strings.
7827 CONTINUE, if non-nil, says to continue editing a message already
7828 being composed. Interactively, CONTINUE is the prefix argument.
7830 SWITCH-FUNCTION, if non-nil, is a function to use to
7831 switch to and display the buffer used for mail composition.
7833 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7834 to insert the raw text of the message being replied to.
7835 It has the form (FUNCTION . ARGS). The user agent will apply
7836 FUNCTION to ARGS, to insert the raw text of the original message.
7837 \(The user agent will also run `mail-citation-hook', *after* the
7838 original text has been inserted in this way.)
7840 SEND-ACTIONS is a list of actions to call when the message is sent.
7841 Each action has the form (FUNCTION . ARGS).
7843 RETURN-ACTION, if non-nil, is an action for returning to the
7844 caller. It has the form (FUNCTION . ARGS). The function is
7845 called after the mail has been sent or put aside, and the mail
7846 buffer buried."
7850 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7851 ;; from sendmail-user-agent to message-user-agent. Some users may
7852 ;; encounter incompatibilities. This hack tries to detect problems
7853 ;; and warn about them.
7858 mail-yank-hooks mail-archive-file-name
7859 mail-default-reply-to mail-mailing-lists
7860 mail-self-blind))
7867 The default mail mode is now Message mode.
7868 You have the following Mail mode variable%s customized:
7870 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7877 yank-action send-actions return-action)))
7880 yank-action send-actions
7881 return-action)
7885 'switch-to-buffer-other-window yank-action send-actions
7886 return-action))
7889 yank-action send-actions
7890 return-action)
7894 'switch-to-buffer-other-frame yank-action send-actions
7895 return-action))
7897 \f
7899 "History of values entered with `set-variable'.
7901 Maximum length of the history list is determined by the value
7905 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7906 VARIABLE should be a user option variable name, a Lisp variable
7907 meant to be customized by users. You should enter VALUE in Lisp syntax,
7908 so if you want VALUE to be a string, you must surround it with doublequotes.
7909 VALUE is used literally, not evaluated.
7911 If VARIABLE has a `variable-interactive' property, that is used as if
7912 it were the arg to `interactive' (which see) to interactively read VALUE.
7914 If VARIABLE has been defined with `defcustom', then the type information
7915 in the definition is used to check that VALUE is valid.
7917 Note that this function is at heart equivalent to the basic `set' function.
7918 For a variable defined with `defcustom', it does not pay attention to
7919 any :set property that the variable might have (if you want that, use
7922 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7927 default-var)
7943 var obsolete)
7946 ;; Use VAR's `variable-interactive' property
7947 ;; as an interactive spec for prompting.
7950 arg))
7952 read-expression-map t
7953 'set-variable-value-history
7962 ;; Match with custom type.
7974 ;; Force a thorough redisplay for the case that the variable
7975 ;; has an effect on the display, like `tab-width' has.
7977 \f
7978 ;; Define the major mode for lists of completions.
7988 (define-key map [right] 'next-completion)
7990 (define-key map [backtab] 'previous-completion)
7991 (define-key map "q" 'quit-window)
7992 (define-key map "z" 'kill-current-buffer)
7993 map)
7994 "Local map for completion list buffers.")
7996 ;; Completion mode is suitable only for specially formatted data.
7997 (put 'completion-list-mode 'mode-class 'special)
7999 (defvar completion-reference-buffer nil
8000 "Record the buffer that was current when the completion list was requested.
8001 This is a local variable in the completion list buffer.
8002 Initial value is nil to avoid some compiler warnings.")
8004 (defvar completion-no-auto-exit nil
8005 "Non-nil means `choose-completion-string' should never exit the minibuffer.
8006 This also applies to other functions such as `choose-completion'.")
8008 (defvar completion-base-position nil
8009 "Position of the base of the text corresponding to the shown completions.
8010 This variable is used in the *Completions* buffers.
8011 Its value is a list of the form (START END) where START is the place
8012 where the completion should be inserted and END (if non-nil) is the end
8013 of the text to replace. If END is nil, point is used instead.")
8015 (defvar completion-list-insert-choice-function #'completion--replace
8016 "Function to use to insert the text chosen in *Completions*.
8017 Called with three arguments (BEG END TEXT), it should replace the text
8018 between BEG and END with TEXT. Expected to be set buffer-locally
8019 in the *Completions* buffer.")
8021 (defvar completion-base-size nil
8022 "Number of chars before point not involved in completion.
8023 This is a local variable in the completion list buffer.
8024 It refers to the chars in the minibuffer if completing in the
8025 minibuffer, or in `completion-reference-buffer' otherwise.
8026 Only characters in the field at point are included.
8028 If nil, Emacs determines which part of the tail end of the
8029 buffer's text is involved in completion by comparing the text
8030 directly.")
8031 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
8033 (defun delete-completion-window ()
8034 "Delete the completion list window.
8035 Go to the window from which completion was requested."
8036 (interactive)
8037 (let ((buf completion-reference-buffer))
8038 (if (one-window-p t)
8039 (if (window-dedicated-p) (delete-frame))
8040 (delete-window (selected-window))
8041 (if (get-buffer-window buf)
8042 (select-window (get-buffer-window buf))))))
8044 (defun previous-completion (n)
8045 "Move to the previous item in the completion list."
8046 (interactive "p")
8047 (next-completion (- n)))
8049 (defun next-completion (n)
8050 "Move to the next item in the completion list.
8051 With prefix argument N, move N items (negative N means move backward)."
8052 (interactive "p")
8053 (let ((beg (point-min)) (end (point-max)))
8054 (while (and (> n 0) (not (eobp)))
8055 ;; If in a completion, move to the end of it.
8056 (when (get-text-property (point) 'mouse-face)
8057 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8058 ;; Move to start of next one.
8059 (unless (get-text-property (point) 'mouse-face)
8060 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8061 (setq n (1- n)))
8062 (while (and (< n 0) (not (bobp)))
8063 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
8064 ;; If in a completion, move to the start of it.
8065 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
8066 (goto-char (previous-single-property-change
8067 (point) 'mouse-face nil beg)))
8068 ;; Move to end of the previous completion.
8069 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
8070 (goto-char (previous-single-property-change
8071 (point) 'mouse-face nil beg)))
8072 ;; Move to the start of that one.
8073 (goto-char (previous-single-property-change
8074 (point) 'mouse-face nil beg))
8075 (setq n (1+ n))))))
8077 (defun choose-completion (&optional event)
8078 "Choose the completion at point.
8079 If EVENT, use EVENT's position to determine the starting position."
8080 (interactive (list last-nonmenu-event))
8081 ;; In case this is run via the mouse, give temporary modes such as
8082 ;; isearch a chance to turn off.
8083 (run-hooks 'mouse-leave-buffer-hook)
8084 (with-current-buffer (window-buffer (posn-window (event-start event)))
8085 (let ((buffer completion-reference-buffer)
8086 (base-size completion-base-size)
8087 (base-position completion-base-position)
8088 (insert-function completion-list-insert-choice-function)
8089 (choice
8090 (save-excursion
8091 (goto-char (posn-point (event-start event)))
8092 (let (beg end)
8093 (cond
8094 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
8095 (setq end (point) beg (1+ (point))))
8096 ((and (not (bobp))
8097 (get-text-property (1- (point)) 'mouse-face))
8098 (setq end (1- (point)) beg (point)))
8099 (t (error "No completion here")))
8100 (setq beg (previous-single-property-change beg 'mouse-face))
8101 (setq end (or (next-single-property-change end 'mouse-face)
8102 (point-max)))
8103 (buffer-substring-no-properties beg end)))))
8105 (unless (buffer-live-p buffer)
8106 (error "Destination buffer is dead"))
8107 (quit-window nil (posn-window (event-start event)))
8109 (with-current-buffer buffer
8110 (choose-completion-string
8111 choice buffer
8112 (or base-position
8113 (when base-size
8114 ;; Someone's using old completion code that doesn't know
8115 ;; about base-position yet.
8116 (list (+ base-size (field-beginning))))
8117 ;; If all else fails, just guess.
8118 (list (choose-completion-guess-base-position choice)))
8119 insert-function)))))
8121 ;; Delete the longest partial match for STRING
8122 ;; that can be found before POINT.
8123 (defun choose-completion-guess-base-position (string)
8124 (save-excursion
8125 (let ((opoint (point))
8126 len)
8127 ;; Try moving back by the length of the string.
8128 (goto-char (max (- (point) (length string))
8129 (minibuffer-prompt-end)))
8130 ;; See how far back we were actually able to move. That is the
8131 ;; upper bound on how much we can match and delete.
8132 (setq len (- opoint (point)))
8133 (if completion-ignore-case
8134 (setq string (downcase string)))
8135 (while (and (> len 0)
8136 (let ((tail (buffer-substring (point) opoint)))
8137 (if completion-ignore-case
8138 (setq tail (downcase tail)))
8139 (not (string= tail (substring string 0 len)))))
8140 (setq len (1- len))
8141 (forward-char 1))
8142 (point))))
8144 (defun choose-completion-delete-max-match (string)
8145 (declare (obsolete choose-completion-guess-base-position "23.2"))
8146 (delete-region (choose-completion-guess-base-position string) (point)))
8148 (defvar choose-completion-string-functions nil
8149 "Functions that may override the normal insertion of a completion choice.
8150 These functions are called in order with three arguments:
8151 CHOICE - the string to insert in the buffer,
8152 BUFFER - the buffer in which the choice should be inserted,
8153 BASE-POSITION - where to insert the completion.
8155 If a function in the list returns non-nil, that function is supposed
8156 to have inserted the CHOICE in the BUFFER, and possibly exited
8157 the minibuffer; no further functions will be called.
8159 If all functions in the list return nil, that means to use
8160 the default method of inserting the completion in BUFFER.")
8162 (defun choose-completion-string (choice &optional
8163 buffer base-position insert-function)
8164 "Switch to BUFFER and insert the completion choice CHOICE.
8165 BASE-POSITION says where to insert the completion.
8166 INSERT-FUNCTION says how to insert the completion and falls
8167 back on `completion-list-insert-choice-function' when nil."
8169 ;; If BUFFER is the minibuffer, exit the minibuffer
8170 ;; unless it is reading a file name and CHOICE is a directory,
8171 ;; or completion-no-auto-exit is non-nil.
8173 ;; Some older code may call us passing `base-size' instead of
8174 ;; `base-position'. It's difficult to make any use of `base-size',
8175 ;; so we just ignore it.
8176 (unless (consp base-position)
8177 (message "Obsolete `base-size' passed to choose-completion-string")
8178 (setq base-position nil))
8180 (let* ((buffer (or buffer completion-reference-buffer))
8181 (mini-p (minibufferp buffer)))
8182 ;; If BUFFER is a minibuffer, barf unless it's the currently
8183 ;; active minibuffer.
8184 (if (and mini-p
8185 (not (and (active-minibuffer-window)
8186 (equal buffer
8187 (window-buffer (active-minibuffer-window))))))
8188 (error "Minibuffer is not active for completion")
8189 ;; Set buffer so buffer-local choose-completion-string-functions works.
8190 (set-buffer buffer)
8191 (unless (run-hook-with-args-until-success
8192 'choose-completion-string-functions
8193 ;; The fourth arg used to be `mini-p' but was useless
8194 ;; (since minibufferp can be used on the `buffer' arg)
8195 ;; and indeed unused. The last used to be `base-size', so we
8196 ;; keep it to try and avoid breaking old code.
8197 choice buffer base-position nil)
8198 ;; This remove-text-properties should be unnecessary since `choice'
8199 ;; comes from buffer-substring-no-properties.
8200 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8201 ;; Insert the completion into the buffer where it was requested.
8202 (funcall (or insert-function completion-list-insert-choice-function)
8203 (or (car base-position) (point))
8204 (or (cadr base-position) (point))
8205 choice)
8206 ;; Update point in the window that BUFFER is showing in.
8207 (let ((window (get-buffer-window buffer t)))
8208 (set-window-point window (point)))
8209 ;; If completing for the minibuffer, exit it with this choice.
8210 (and (not completion-no-auto-exit)
8211 (minibufferp buffer)
8212 minibuffer-completion-table
8213 ;; If this is reading a file name, and the file name chosen
8214 ;; is a directory, don't exit the minibuffer.
8215 (let* ((result (buffer-substring (field-beginning) (point)))
8216 (bounds
8217 (completion-boundaries result minibuffer-completion-table
8218 minibuffer-completion-predicate
8219 "")))
8220 (if (eq (car bounds) (length result))
8221 ;; The completion chosen leads to a new set of completions
8222 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8223 (let ((mini (active-minibuffer-window)))
8224 (select-window mini)
8225 (when minibuffer-auto-raise
8226 (raise-frame (window-frame mini))))
8227 (exit-minibuffer))))))))
8229 (define-derived-mode completion-list-mode nil "Completion List"
8230 "Major mode for buffers showing lists of possible completions.
8232 to select the completion near point.
8233 Or click to select one with the mouse.
8236 (set (make-local-variable 'completion-base-size) nil))
8238 (defun completion-list-mode-finish ()
8239 "Finish setup of the completions buffer.
8240 Called from `temp-buffer-show-hook'."
8241 (when (eq major-mode 'completion-list-mode)
8242 (setq buffer-read-only t)))
8244 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8247 ;; Variables and faces used in `completion-setup-function'.
8249 (defcustom completion-show-help t
8250 "Non-nil means show help message in *Completions* buffer."
8251 :type 'boolean
8252 :version "22.1"
8253 :group 'completion)
8255 ;; This function goes in completion-setup-hook, so that it is called
8256 ;; after the text of the completion list buffer is written.
8257 (defun completion-setup-function ()
8258 (let* ((mainbuf (current-buffer))
8259 (base-dir
8260 ;; FIXME: This is a bad hack. We try to set the default-directory
8261 ;; in the *Completions* buffer so that the relative file names
8262 ;; displayed there can be treated as valid file names, independently
8263 ;; from the completion context. But this suffers from many problems:
8264 ;; - It's not clear when the completions are file names. With some
8265 ;; completion tables (e.g. bzr revision specs), the listed
8266 ;; completions can mix file names and other things.
8267 ;; - It doesn't pay attention to possible quoting.
8268 ;; - With fancy completion styles, the code below will not always
8269 ;; find the right base directory.
8270 (if minibuffer-completing-file-name
8271 (file-name-as-directory
8272 (expand-file-name
8273 (buffer-substring (minibuffer-prompt-end)
8274 (- (point) (or completion-base-size 0))))))))
8275 (with-current-buffer standard-output
8276 (let ((base-size completion-base-size) ;Read before killing localvars.
8277 (base-position completion-base-position)
8278 (insert-fun completion-list-insert-choice-function))
8279 (completion-list-mode)
8280 (set (make-local-variable 'completion-base-size) base-size)
8281 (set (make-local-variable 'completion-base-position) base-position)
8282 (set (make-local-variable 'completion-list-insert-choice-function)
8283 insert-fun))
8284 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8285 (if base-dir (setq default-directory base-dir))
8286 ;; Maybe insert help string.
8287 (when completion-show-help
8288 (goto-char (point-min))
8289 (if (display-mouse-p)
8291 (insert (substitute-command-keys
8295 (add-hook 'completion-setup-hook 'completion-setup-function)
8297 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8298 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8300 (defun switch-to-completions ()
8301 "Select the completion list window."
8302 (interactive)
8303 (let ((window (or (get-buffer-window "*Completions*" 0)
8304 ;; Make sure we have a completions window.
8305 (progn (minibuffer-completion-help)
8306 (get-buffer-window "*Completions*" 0)))))
8307 (when window
8308 (select-window window)
8309 ;; In the new buffer, go to the first completion.
8310 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8311 (when (bobp)
8312 (next-completion 1)))))
8313 \f
8314 ;;; Support keyboard commands to turn on various modifiers.
8316 ;; These functions -- which are not commands -- each add one modifier
8317 ;; to the following event.
8319 (defun event-apply-alt-modifier (_ignore-prompt)
8322 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8323 (defun event-apply-super-modifier (_ignore-prompt)
8326 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8327 (defun event-apply-hyper-modifier (_ignore-prompt)
8330 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8331 (defun event-apply-shift-modifier (_ignore-prompt)
8334 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8335 (defun event-apply-control-modifier (_ignore-prompt)
8338 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8339 (defun event-apply-meta-modifier (_ignore-prompt)
8342 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8344 (defun event-apply-modifier (event symbol lshiftby prefix)
8345 "Apply a modifier flag to event EVENT.
8346 SYMBOL is the name of this modifier, as a symbol.
8347 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8348 PREFIX is the string that represents this modifier in an event type symbol."
8349 (if (numberp event)
8350 (cond ((eq symbol 'control)
8351 (if (and (<= (downcase event) ?z)
8352 (>= (downcase event) ?a))
8353 (- (downcase event) ?a -1)
8354 (if (and (<= (downcase event) ?Z)
8355 (>= (downcase event) ?A))
8356 (- (downcase event) ?A -1)
8357 (logior (lsh 1 lshiftby) event))))
8358 ((eq symbol 'shift)
8359 (if (and (<= (downcase event) ?z)
8360 (>= (downcase event) ?a))
8361 (upcase event)
8362 (logior (lsh 1 lshiftby) event)))
8363 (t
8364 (logior (lsh 1 lshiftby) event)))
8365 (if (memq symbol (event-modifiers event))
8366 event
8367 (let ((event-type (if (symbolp event) event (car event))))
8368 (setq event-type (intern (concat prefix (symbol-name event-type))))
8369 (if (symbolp event)
8370 event-type
8371 (cons event-type (cdr event)))))))
8373 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8374 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8375 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8376 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8377 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8378 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8379 \f
8380 ;;;; Keypad support.
8382 ;; Make the keypad keys act like ordinary typing keys. If people add
8383 ;; bindings for the function key symbols, then those bindings will
8384 ;; override these, so this shouldn't interfere with any existing
8385 ;; bindings.
8387 ;; Also tell read-char how to handle these keys.
8388 (mapc
8389 (lambda (keypad-normal)
8390 (let ((keypad (nth 0 keypad-normal))
8391 (normal (nth 1 keypad-normal)))
8392 (put keypad 'ascii-character normal)
8393 (define-key function-key-map (vector keypad) (vector normal))))
8394 ;; See also kp-keys bound in bindings.el.
8395 '((kp-space ?\s)
8398 (kp-separator ?,)
8399 (kp-equal ?=)
8400 ;; Do the same for various keys that are represented as symbols under
8401 ;; GUIs but naturally correspond to characters.
8402 (backspace 127)
8403 (delete 127)
8406 (clear ?\C-l)
8407 (return ?\C-m)
8408 (escape ?\e)
8409 ))
8410 \f
8411 ;;;;
8412 ;;;; forking a twin copy of a buffer.
8413 ;;;;
8415 (defvar clone-buffer-hook nil
8416 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8418 (defvar clone-indirect-buffer-hook nil
8419 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8421 (defun clone-process (process &optional newname)
8422 "Create a twin copy of PROCESS.
8423 If NEWNAME is nil, it defaults to PROCESS' name;
8424 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8425 If PROCESS is associated with a buffer, the new process will be associated
8426 with the current buffer instead.
8427 Returns nil if PROCESS has already terminated."
8428 (setq newname (or newname (process-name process)))
8430 (setq newname (substring newname 0 (match-beginning 0))))
8431 (when (memq (process-status process) '(run stop open))
8432 (let* ((process-connection-type (process-tty-name process))
8433 (new-process
8434 (if (memq (process-status process) '(open))
8435 (let ((args (process-contact process t)))
8436 (setq args (plist-put args :name newname))
8437 (setq args (plist-put args :buffer
8438 (if (process-buffer process)
8439 (current-buffer))))
8440 (apply 'make-network-process args))
8441 (apply 'start-process newname
8442 (if (process-buffer process) (current-buffer))
8443 (process-command process)))))
8444 (set-process-query-on-exit-flag
8445 new-process (process-query-on-exit-flag process))
8446 (set-process-inherit-coding-system-flag
8447 new-process (process-inherit-coding-system-flag process))
8448 (set-process-filter new-process (process-filter process))
8449 (set-process-sentinel new-process (process-sentinel process))
8450 (set-process-plist new-process (copy-sequence (process-plist process)))
8451 new-process)))
8453 ;; things to maybe add (currently partly covered by `funcall mode'):
8454 ;; - syntax-table
8455 ;; - overlays
8456 (defun clone-buffer (&optional newname display-flag)
8457 "Create and return a twin copy of the current buffer.
8458 Unlike an indirect buffer, the new buffer can be edited
8459 independently of the old one (if it is not read-only).
8460 NEWNAME is the name of the new buffer. It may be modified by
8461 adding or incrementing <N> at the end as necessary to create a
8462 unique buffer name. If nil, it defaults to the name of the
8463 current buffer, with the proper suffix. If DISPLAY-FLAG is
8464 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8465 clone a file-visiting buffer, or a buffer whose major mode symbol
8466 has a non-nil `no-clone' property, results in an error.
8468 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8469 current buffer with appropriate suffix. However, if a prefix
8470 argument is given, then the command prompts for NEWNAME in the
8471 minibuffer.
8473 This runs the normal hook `clone-buffer-hook' in the new buffer
8474 after it has been set up properly in other respects."
8475 (interactive
8476 (progn
8477 (if buffer-file-name
8478 (error "Cannot clone a file-visiting buffer"))
8479 (if (get major-mode 'no-clone)
8480 (error "Cannot clone a buffer in %s mode" mode-name))
8481 (list (if current-prefix-arg
8482 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8483 t)))
8484 (if buffer-file-name
8485 (error "Cannot clone a file-visiting buffer"))
8486 (if (get major-mode 'no-clone)
8487 (error "Cannot clone a buffer in %s mode" mode-name))
8488 (setq newname (or newname (buffer-name)))
8490 (setq newname (substring newname 0 (match-beginning 0))))
8491 (let ((buf (current-buffer))
8492 (ptmin (point-min))
8493 (ptmax (point-max))
8494 (pt (point))
8495 (mk (if mark-active (mark t)))
8496 (modified (buffer-modified-p))
8497 (mode major-mode)
8498 (lvars (buffer-local-variables))
8499 (process (get-buffer-process (current-buffer)))
8500 (new (generate-new-buffer (or newname (buffer-name)))))
8501 (save-restriction
8502 (widen)
8503 (with-current-buffer new
8504 (insert-buffer-substring buf)))
8505 (with-current-buffer new
8506 (narrow-to-region ptmin ptmax)
8507 (goto-char pt)
8508 (if mk (set-mark mk))
8509 (set-buffer-modified-p modified)
8511 ;; Clone the old buffer's process, if any.
8512 (when process (clone-process process))
8514 ;; Now set up the major mode.
8515 (funcall mode)
8517 ;; Set up other local variables.
8518 (mapc (lambda (v)
8519 (condition-case () ;in case var is read-only
8520 (if (symbolp v)
8521 (makunbound v)
8522 (set (make-local-variable (car v)) (cdr v)))
8523 (error nil)))
8524 lvars)
8526 ;; Run any hooks (typically set up by the major mode
8527 ;; for cloning to work properly).
8528 (run-hooks 'clone-buffer-hook))
8529 (if display-flag
8530 ;; Presumably the current buffer is shown in the selected frame, so
8531 ;; we want to display the clone elsewhere.
8532 (let ((same-window-regexps nil)
8533 (same-window-buffer-names))
8534 (pop-to-buffer new)))
8535 new))
8538 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8539 "Create an indirect buffer that is a twin copy of the current buffer.
8541 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8542 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8543 or if not called with a prefix arg, NEWNAME defaults to the current
8544 buffer's name. The name is modified by adding a `<N>' suffix to it
8545 or by incrementing the N in an existing suffix. Trying to clone a
8546 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8547 property results in an error.
8549 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8550 This is always done when called interactively.
8552 Optional third arg NORECORD non-nil means do not put this buffer at the
8553 front of the list of recently selected ones.
8555 Returns the newly created indirect buffer."
8556 (interactive
8557 (progn
8558 (if (get major-mode 'no-clone-indirect)
8559 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8560 (list (if current-prefix-arg
8561 (read-buffer "Name of indirect buffer: " (current-buffer)))
8562 t)))
8563 (if (get major-mode 'no-clone-indirect)
8564 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8565 (setq newname (or newname (buffer-name)))
8567 (setq newname (substring newname 0 (match-beginning 0))))
8568 (let* ((name (generate-new-buffer-name newname))
8569 (buffer (make-indirect-buffer (current-buffer) name t)))
8570 (with-current-buffer buffer
8571 (run-hooks 'clone-indirect-buffer-hook))
8572 (when display-flag
8573 (pop-to-buffer buffer nil norecord))
8574 buffer))
8577 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8578 "Like `clone-indirect-buffer' but display in another window."
8579 (interactive
8580 (progn
8581 (if (get major-mode 'no-clone-indirect)
8582 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8583 (list (if current-prefix-arg
8584 (read-buffer "Name of indirect buffer: " (current-buffer)))
8585 t)))
8586 (let ((pop-up-windows t))
8587 (clone-indirect-buffer newname display-flag norecord)))
8589 \f
8590 ;;; Handling of Backspace and Delete keys.
8592 (defcustom normal-erase-is-backspace 'maybe
8593 "Set the default behavior of the Delete and Backspace keys.
8595 If set to t, Delete key deletes forward and Backspace key deletes
8596 backward.
8598 If set to nil, both Delete and Backspace keys delete backward.
8600 If set to `maybe' (which is the default), Emacs automatically
8601 selects a behavior. On window systems, the behavior depends on
8602 the keyboard used. If the keyboard has both a Backspace key and
8603 a Delete key, and both are mapped to their usual meanings, the
8604 option's default value is set to t, so that Backspace can be used
8605 to delete backward, and Delete can be used to delete forward.
8607 If not running under a window system, customizing this option
8608 accomplishes a similar effect by mapping C-h, which is usually
8609 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8610 via `keyboard-translate'. The former functionality of C-h is
8611 available on the F1 key. You should probably not use this
8612 setting if you don't have both Backspace, Delete and F1 keys.
8614 Setting this variable with setq doesn't take effect. Programmatically,
8615 call `normal-erase-is-backspace-mode' (which see) instead."
8616 :type '(choice (const :tag "Off" nil)
8617 (const :tag "Maybe" maybe)
8618 (other :tag "On" t))
8619 :group 'editing-basics
8620 :version "21.1"
8621 :set (lambda (symbol value)
8622 ;; The fboundp is because of a problem with :set when
8623 ;; dumping Emacs. It doesn't really matter.
8624 (if (fboundp 'normal-erase-is-backspace-mode)
8625 (normal-erase-is-backspace-mode (or value 0))
8626 (set-default symbol value))))
8628 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8629 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8630 (unless frame (setq frame (selected-frame)))
8631 (with-selected-frame frame
8632 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8633 (normal-erase-is-backspace-mode
8634 (if (if (eq normal-erase-is-backspace 'maybe)
8635 (and (not noninteractive)
8636 (or (memq system-type '(ms-dos windows-nt))
8637 (memq window-system '(w32 ns))
8638 (and (memq window-system '(x))
8639 (fboundp 'x-backspace-delete-keys-p)
8640 (x-backspace-delete-keys-p))
8641 ;; If the terminal Emacs is running on has erase char
8642 ;; set to ^H, use the Backspace key for deleting
8643 ;; backward, and the Delete key for deleting forward.
8644 (and (null window-system)
8645 (eq tty-erase-char ?\^H))))
8646 normal-erase-is-backspace)
8647 1 0)))))
8649 (define-minor-mode normal-erase-is-backspace-mode
8650 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8651 With a prefix argument ARG, enable this feature if ARG is
8652 positive, and disable it otherwise. If called from Lisp, enable
8653 the mode if ARG is omitted or nil.
8655 On window systems, when this mode is on, Delete is mapped to C-d
8656 and Backspace is mapped to DEL; when this mode is off, both
8657 Delete and Backspace are mapped to DEL. (The remapping goes via
8658 `local-function-key-map', so binding Delete or Backspace in the
8659 global or local keymap will override that.)
8661 In addition, on window systems, the bindings of C-Delete, M-Delete,
8662 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8663 the global keymap in accordance with the functionality of Delete and
8664 Backspace. For example, if Delete is remapped to C-d, which deletes
8665 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8666 to DEL, which deletes backward, C-Delete is bound to
8667 `backward-kill-word'.
8669 If not running on a window system, a similar effect is accomplished by
8670 remapping C-h (normally produced by the Backspace key) and DEL via
8671 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8672 to C-d; if it's off, the keys are not remapped.
8674 When not running on a window system, and this mode is turned on, the
8675 former functionality of C-h is available on the F1 key. You should
8676 probably not turn on this mode on a text-only terminal if you don't
8677 have both Backspace, Delete and F1 keys.
8679 See also `normal-erase-is-backspace'."
8680 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8681 . (lambda (v)
8682 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8683 (if v 1 0))))
8684 (let ((enabled (eq 1 (terminal-parameter
8685 nil 'normal-erase-is-backspace))))
8687 (cond ((or (memq window-system '(x w32 ns pc))
8688 (memq system-type '(ms-dos windows-nt)))
8689 (let ((bindings
8690 `(([M-delete] [M-backspace])
8691 ([C-M-delete] [C-M-backspace])
8692 ([?\e C-delete] [?\e C-backspace]))))
8694 (if enabled
8695 (progn
8696 (define-key local-function-key-map [delete] [deletechar])
8697 (define-key local-function-key-map [kp-delete] [deletechar])
8698 (define-key local-function-key-map [backspace] [?\C-?])
8699 (dolist (b bindings)
8700 ;; Not sure if input-decode-map is really right, but
8701 ;; keyboard-translate-table (used below) only works
8702 ;; for integer events, and key-translation-table is
8703 ;; global (like the global-map, used earlier).
8704 (define-key input-decode-map (car b) nil)
8705 (define-key input-decode-map (cadr b) nil)))
8706 (define-key local-function-key-map [delete] [?\C-?])
8707 (define-key local-function-key-map [kp-delete] [?\C-?])
8708 (define-key local-function-key-map [backspace] [?\C-?])
8709 (dolist (b bindings)
8710 (define-key input-decode-map (car b) (cadr b))
8711 (define-key input-decode-map (cadr b) (car b))))))
8712 (t
8713 (if enabled
8714 (progn
8715 (keyboard-translate ?\C-h ?\C-?)
8716 (keyboard-translate ?\C-? ?\C-d))
8717 (keyboard-translate ?\C-h ?\C-h)
8718 (keyboard-translate ?\C-? ?\C-?))))
8720 (if (called-interactively-p 'interactive)
8721 (message "Delete key deletes %s"
8722 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8723 "forward" "backward")))))
8724 \f
8725 (defvar vis-mode-saved-buffer-invisibility-spec nil
8726 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8728 (define-minor-mode read-only-mode
8729 "Change whether the current buffer is read-only.
8730 With prefix argument ARG, make the buffer read-only if ARG is
8731 positive, otherwise make it writable. If buffer is read-only
8732 and `view-read-only' is non-nil, enter view mode.
8734 Do not call this from a Lisp program unless you really intend to
8736 possibly enabling or disabling View mode. Also, note that this
8737 command works by setting the variable `buffer-read-only', which
8738 does not affect read-only regions caused by text properties. To
8739 ignore read-only status in a Lisp program (whether due to text
8740 properties or buffer state), bind `inhibit-read-only' temporarily
8741 to a non-nil value."
8742 :variable buffer-read-only
8743 (cond
8744 ((and (not buffer-read-only) view-mode)
8745 (View-exit-and-edit)
8746 (make-local-variable 'view-read-only)
8747 (setq view-read-only t)) ; Must leave view mode.
8748 ((and buffer-read-only view-read-only
8749 ;; If view-mode is already active, `view-mode-enter' is a nop.
8750 (not view-mode)
8751 (not (eq (get major-mode 'mode-class) 'special)))
8752 (view-mode-enter))))
8754 (define-minor-mode visible-mode
8755 "Toggle making all invisible text temporarily visible (Visible mode).
8756 With a prefix argument ARG, enable Visible mode if ARG is
8757 positive, and disable it otherwise. If called from Lisp, enable
8758 the mode if ARG is omitted or nil.
8760 This mode works by saving the value of `buffer-invisibility-spec'
8761 and setting it to nil."
8762 :lighter " Vis"
8763 :group 'editing-basics
8764 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8765 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8766 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8767 (when visible-mode
8768 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8769 buffer-invisibility-spec)
8770 (setq buffer-invisibility-spec nil)))
8771 \f
8772 (defvar messages-buffer-mode-map
8773 (let ((map (make-sparse-keymap)))
8774 (set-keymap-parent map special-mode-map)
8775 (define-key map "g" nil) ; nothing to revert
8776 map))
8778 (define-derived-mode messages-buffer-mode special-mode "Messages"
8781 (defun messages-buffer ()
8783 If it does not exist, create and it switch it to `messages-buffer-mode'."
8784 (or (get-buffer "*Messages*")
8785 (with-current-buffer (get-buffer-create "*Messages*")
8786 (messages-buffer-mode)
8787 (current-buffer))))
8789 \f
8790 ;; Minibuffer prompt stuff.
8792 ;;(defun minibuffer-prompt-modification (start end)
8793 ;; (error "You cannot modify the prompt"))
8794 ;;
8795 ;;
8796 ;;(defun minibuffer-prompt-insertion (start end)
8797 ;; (let ((inhibit-modification-hooks t))
8798 ;; (delete-region start end)
8799 ;; ;; Discard undo information for the text insertion itself
8800 ;; ;; and for the text deletion.above.
8801 ;; (when (consp buffer-undo-list)
8802 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8803 ;; (message "You cannot modify the prompt")))
8804 ;;
8805 ;;
8806 ;;(setq minibuffer-prompt-properties
8807 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8808 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8810 \f
8811 ;;;; Problematic external packages.
8813 ;; rms says this should be done by specifying symbols that define
8814 ;; versions together with bad values. This is therefore not as
8815 ;; flexible as it could be. See the thread:
8816 ;; https://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8817 (defconst bad-packages-alist
8818 ;; Not sure exactly which semantic versions have problems.
8819 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8821 "The version of `semantic' loaded does not work in Emacs 22.
8822 It can cause constant high CPU load.
8823 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8824 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8825 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8826 ;; provided the `CUA-mode' feature. Since this is no longer true,
8827 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8828 (CUA-mode t nil
8829 "CUA-mode is now part of the standard GNU Emacs distribution,
8830 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8832 You have loaded an older version of CUA-mode which does not work
8833 correctly with this version of Emacs. You should remove the old
8834 version and use the one distributed with Emacs."))
8835 "Alist of packages known to cause problems in this version of Emacs.
8836 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8837 PACKAGE is either a regular expression to match file names, or a
8838 symbol (a feature name), like for `with-eval-after-load'.
8839 SYMBOL is either the name of a string variable, or t. Upon
8840 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8841 warning using STRING as the message.")
8843 (defun bad-package-check (package)
8844 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8845 (condition-case nil
8846 (let* ((list (assoc package bad-packages-alist))
8847 (symbol (nth 1 list)))
8848 (and list
8849 (boundp symbol)
8850 (or (eq symbol t)
8851 (and (stringp (setq symbol (eval symbol)))
8852 (string-match-p (nth 2 list) symbol)))
8853 (display-warning package (nth 3 list) :warning)))
8854 (error nil)))
8856 (dolist (elem bad-packages-alist)
8857 (let ((pkg (car elem)))
8858 (with-eval-after-load pkg
8859 (bad-package-check pkg))))
8861 \f
8862 ;;; Generic dispatcher commands
8864 ;; Macro `define-alternatives' is used to create generic commands.
8865 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8866 ;; that can have different alternative implementations where choosing
8867 ;; among them is exclusively a matter of user preference.
8869 ;; (define-alternatives COMMAND) creates a new interactive command
8870 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8871 ;; Typically, the user will not need to customize this variable; packages
8872 ;; wanting to add alternative implementations should use
8873 ;;
8874 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8876 (defmacro define-alternatives (command &rest customizations)
8877 "Define the new command `COMMAND'.
8879 The argument `COMMAND' should be a symbol.
8881 Running `M-x COMMAND RET' for the first time prompts for which
8882 alternative to use and records the selected command as a custom
8883 variable.
8885 Running `C-u M-x COMMAND RET' prompts again for an alternative
8886 and overwrites the previous choice.
8888 The variable `COMMAND-alternatives' contains an alist with
8889 alternative implementations of COMMAND. `define-alternatives'
8890 does not have any effect until this variable is set.
8892 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8893 `defcustom' keywords and values to add to the declaration of
8894 `COMMAND-alternatives' (typically :group and :version)."
8895 (let* ((command-name (symbol-name command))
8896 (varalt-name (concat command-name "-alternatives"))
8897 (varalt-sym (intern varalt-name))
8898 (varimp-sym (intern (concat command-name "--implementation"))))
8899 `(progn
8901 (defcustom ,varalt-sym nil
8902 ,(format "Alist of alternative implementations for the `%s' command.
8904 Each entry must be a pair (ALTNAME . ALTFUN), where:
8905 ALTNAME - The name shown at user to describe the alternative implementation.
8906 ALTFUN - The function called to implement this alternative."
8907 command-name)
8908 :type '(alist :key-type string :value-type function)
8909 ,@customizations)
8911 (put ',varalt-sym 'definition-name ',command)
8912 (defvar ,varimp-sym nil "Internal use only.")
8914 (defun ,command (&optional arg)
8915 ,(format "Run generic command `%s'.
8916 If used for the first time, or with interactive ARG, ask the user which
8917 implementation to use for `%s'. The variable `%s'
8918 contains the list of implementations currently supported for this command."
8919 command-name command-name varalt-name)
8920 (interactive "P")
8921 (when (or arg (null ,varimp-sym))
8922 (let ((val (completing-read
8923 ,(format-message
8924 "Select implementation for command `%s': "
8925 command-name)
8926 ,varalt-sym nil t)))
8927 (unless (string-equal val "")
8928 (when (null ,varimp-sym)
8929 (message
8930 "Use C-u M-x %s RET`to select another implementation"
8931 ,command-name)
8932 (sit-for 3))
8933 (customize-save-variable ',varimp-sym
8934 (cdr (assoc-string val ,varalt-sym))))))
8935 (if ,varimp-sym
8936 (call-interactively ,varimp-sym)
8937 (message "%s" ,(format-message
8938 "No implementation selected for command `%s'"
8939 command-name)))))))
8941 \f
8942 ;;; Functions for changing capitalization that Do What I Mean
8943 (defun upcase-dwim (arg)
8944 "Upcase words in the region, if active; if not, upcase word at point.
8945 If the region is active, this function calls `upcase-region'.
8946 Otherwise, it calls `upcase-word', with prefix argument passed to it
8947 to upcase ARG words."
8948 (interactive "*p")
8949 (if (use-region-p)
8950 (upcase-region (region-beginning) (region-end))
8951 (upcase-word arg)))
8953 (defun downcase-dwim (arg)
8954 "Downcase words in the region, if active; if not, downcase word at point.
8955 If the region is active, this function calls `downcase-region'.
8956 Otherwise, it calls `downcase-word', with prefix argument passed to it
8957 to downcase ARG words."
8958 (interactive "*p")
8959 (if (use-region-p)
8960 (downcase-region (region-beginning) (region-end))
8961 (downcase-word arg)))
8963 (defun capitalize-dwim (arg)
8964 "Capitalize words in the region, if active; if not, capitalize word at point.
8965 If the region is active, this function calls `capitalize-region'.
8966 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8967 to capitalize ARG words."
8968 (interactive "*p")
8969 (if (use-region-p)
8970 (capitalize-region (region-beginning) (region-end))
8971 (capitalize-word arg)))
8973 \f
8975 (provide 'simple)
8977 ;;; simple.el ends here