| blob | ff0aa066b550f62ece74baa4f6892b547109761b |
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 <http://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 set the point in the output buffer
43 once the command complete.
44 The value `beg-last-out' set point at the beginning of the output,
45 `end-last-out' set point at the end of the buffer, `save-point'
46 restore the buffer position before the command."
56 "Point position in the output buffer after command complete.
57 It is an alist (BUFFER . POS), where BUFFER is the output
58 buffer, and POS is the point position in BUFFER once the command finish.
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 ;; We are not going to insert any newlines if arg is
438 ;; non-positive.
441 ;; Mark the newline(s) `hard'.
445 ;; If the newline leaves the previous line blank, and we
446 ;; have a left margin, delete that from the blank line.
454 ;; Indent the line after the newline, except in one case:
455 ;; when we added the newline at the beginning of a line which
456 ;; starts a page.
461 ;; FIXME: For non-interactive uses, many calls actually
462 ;; just want (insert "\n"), so maybe we should do just
463 ;; that, so as to avoid the risk of filling or running
464 ;; abbrevs unexpectedly.
471 ;; We first used let-binding to protect the hook, but that
472 ;; was naive since add-hook affects the symbol-default
473 ;; value of the variable, whereas the let-binding might
474 ;; only protect the buffer-local value.
478 nil)
483 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
489 "Insert a newline and leave point before it.
490 If there is a fill prefix and/or a `left-margin', insert them on
491 the new line if the line would have been blank.
492 With arg N, insert N newlines."
497 ;; Don't expand an abbrev before point.
508 ;; Necessary in case a margin or prefix was inserted.
512 "Split current line, moving portion beyond point vertically down.
513 If the current line starts with `fill-prefix', insert it on the new
514 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
516 When called from Lisp code, ARG may be a prefix string to copy."
521 ;; What prefix should we check for (nil means don't).
525 ;; Does this line start with it?
536 "Join this line to previous and fix up whitespace at join.
537 If there is a fill prefix, delete it from the beginning of this line.
538 With argument, join this line to following line."
545 ;; If the second line started with the fill prefix,
546 ;; delete the prefix.
558 "On blank line, delete all surrounding blank lines, leaving just one.
559 On isolated blank line, delete that one.
560 On nonblank line, delete any immediately following blank lines."
566 ;; Set singleblank if there is just one blank line here.
573 ;; Delete preceding blank lines, and this one too if it's the only one.
582 ;; Delete following blank lines, unless the current line is blank
583 ;; and there are no following blank lines.
592 ;; Handle the special case where point is followed by newline and eob.
593 ;; Delete the line, leaving point at eob.
599 Trailing lines are deleted only if `delete-trailing-whitespace'
600 is called on the entire buffer (rather than an active region)."
606 "Return non-nil if the region contains no read-only text."
611 "Delete trailing whitespace between START and END.
612 If called interactively, START and END are the start/end of the
613 region if the mark is active, or of the buffer's accessible
614 portion if the mark is inactive.
616 This command deletes whitespace characters after the last
617 non-whitespace character in each line between START and END. It
618 does not consider formfeed characters to be whitespace.
620 If this command acts on the entire buffer (i.e. if called
621 interactively with the mark inactive, or called from Lisp with
622 END nil), it also deletes all trailing lines at the end of the
623 buffer if the variable `delete-trailing-lines' is non-nil."
634 ;; Don't delete formfeeds, even if they are considered whitespace.
643 ;; Delete trailing empty lines.
645 ;; Really the end of buffer.
650 ;; Return nil for the benefit of `write-file-functions'.
651 nil)
654 "Insert a newline, then indent according to major mode.
655 Indentation is done using the value of `indent-line-function'.
656 In programming language modes, this is the same as TAB.
657 In some text modes, where TAB inserts a tab, this command indents to the
658 column specified by the function `current-left-margin'."
665 "Reindent current line, insert newline, then indent the new line.
666 Indentation of both lines is done according to the current major mode,
667 which means calling the current value of `indent-line-function'.
668 In programming language modes, this is the same as TAB.
669 In some text modes, where TAB inserts a tab, this indents to the
670 column specified by the function `current-left-margin'."
673 ;; Be careful to insert the newline before indenting the line.
674 ;; Otherwise, the indentation might be wrong.
678 ;; We are at EOL before the call to indent-according-to-mode, and
679 ;; after it we usually are as well, but not always. We tried to
680 ;; address it with `save-excursion' but that uses a normal marker
681 ;; whereas we need `move after insertion', so we do the save/restore
682 ;; by hand.
686 ;; Remove the trailing white-space after indentation because
687 ;; indentation may introduce the whitespace.
693 Legitimate radix values are 8, 10 and 16."
698 "Like `read-char', but do not allow quitting.
699 Also, if the first character read is an octal digit,
700 we read any number of octal digits and return the
701 specified character code. Any nondigit terminates the sequence.
702 If the terminator is RET, it is discarded;
703 any other terminator is used itself as input.
705 The optional argument PROMPT specifies a string to use to prompt the user.
706 The variable `read-quoted-char-radix' controls which radix to use
707 for numeric input."
710 help-event-list)))
714 ;; Don't let C-h or other help chars get the help
715 ;; message--only help function keys. See bug#16617.
719 "Type the special character you want to use,
720 or the octal character code.
721 RET terminates the character code and is discarded;
725 ;; Translate TAB key into control-I ASCII character, and so on.
726 ;; Note: `read-char' does it using the `ascii-character' property.
727 ;; We tried using read-key instead, but that disables the keystroke
728 ;; echo produced by 'C-q', see bug#24635.
732 char)))
738 done t))
740 ;; Turn a meta-character into a character with the 0200 bit set.
742 done t))
757 done t))
759 done t)))
761 code))
764 "Read next input character and insert it.
765 This is useful for inserting control characters.
766 With argument, insert ARG copies of the character.
768 If the first character you type after this command is an octal digit,
769 you should type a sequence of octal digits which specify a character code.
770 Any nondigit terminates the sequence. If the terminator is a RET,
771 it is discarded; any other terminator is used itself as input.
772 The variable `read-quoted-char-radix' specifies the radix for this feature;
773 set it to 10 or 16 to use decimal or hex instead of octal.
775 In overwrite mode, this function inserts the character anyway, and
776 does not handle octal digits specially. This means that if you use
777 overwrite as your normal editing mode, you can use this function to
778 insert characters when necessary.
780 In binary overwrite mode, this function does overwrite, and octal
781 digits are interpreted as a character code. This is intended to be
782 useful for editing binary files."
785 ;; Avoid "obsolete" warnings for translation-table-for-input.
792 ;; This used to assume character codes 0240 - 0377 stand for
793 ;; characters in some single-byte character set, and converted them
794 ;; to Emacs characters. But in 23.1 this feature is deprecated
795 ;; in favor of inserting the corresponding Unicode characters.
796 ;; (if (and enable-multibyte-characters
797 ;; (>= char ?\240)
798 ;; (<= char ?\377))
799 ;; (setq char (unibyte-char-to-multibyte char)))
811 "Move forward ARG lines and position at first nonblank character."
817 "Move backward ARG lines and position at first nonblank character."
823 "Move point to the first non-whitespace character on this line."
827 ;; Move back over chars that have whitespace syntax but have the p flag.
831 "Fixup white space between objects around point.
832 Leave one space or none, according to the context."
839 nil
843 "Delete all spaces and tabs around point.
844 If BACKWARD-ONLY is non-nil, only delete them before point."
849 orig-pos
858 "Delete all spaces and tabs around point, leaving one space (or N spaces).
859 If N is negative, delete newlines as well, leaving -N spaces.
860 See also `cycle-spacing'."
865 "Store context used in consecutive calls to `cycle-spacing' command.
866 The first time `cycle-spacing' runs, it saves in this variable:
867 its N argument, the original point position, and the original spacing
871 "Manipulate whitespace around point in a smart way.
872 In interactive use, this function behaves differently in successive
873 consecutive calls.
875 The first call in a sequence acts like `just-one-space'.
876 It deletes all spaces and tabs around point, leaving one space
877 \(or N spaces). N is the prefix argument. If N is negative,
878 it deletes newlines as well, leaving -N spaces.
879 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
881 The second call in a sequence deletes all spaces.
883 The third call in a sequence restores the original whitespace (and point).
885 If MODE is `single-shot', it only performs the first step in the sequence.
886 If MODE is `fast' and the first step would not result in any change
887 \(i.e., there are exactly (abs N) spaces around point),
888 the function goes straight to the second step.
890 Repeatedly calling the function with different values of N starts a
891 new sequence each time."
899 ;; Command run for the first time, single-shot mode or different argument
911 ;; Special handling for case where there was no space at all.
914 ;; If this run causes no change in buffer content, delete all spaces,
915 ;; otherwise delete all excess spaces.
920 ;; Command run for the second time.
924 ;; Command run for the third time.
929 \f
931 "Move point to the beginning of the buffer.
932 With numeric arg N, put point N/10 of the way from the beginning.
933 If the buffer is narrowed, this command uses the beginning of the
934 accessible part of the buffer.
937 is supplied, or Transient Mark mode is enabled and the mark is active."
947 ;; Avoid overflow for large buffer sizes!
955 "Move point to the end of the buffer.
956 With numeric arg N, put point N/10 of the way from the end.
957 If the buffer is narrowed, this command uses the end of the
958 accessible part of the buffer.
961 is supplied, or Transient Mark mode is enabled and the mark is active."
969 ;; Avoid overflow for large buffer sizes!
974 ;; If we went to a place in the middle of the buffer,
975 ;; adjust it to the beginning of a line.
979 ;; If the end of the buffer is not already on the screen,
980 ;; then scroll specially to put it near, but not at, the bottom.
985 "Whether single-char deletion commands delete an active region.
986 This has an effect only if Transient Mark mode is enabled, and
987 affects `delete-forward-char' and `delete-backward-char', though
988 not `delete-char'.
990 If the value is the symbol `kill', the active region is killed
991 instead of deleted."
1008 "Function to get the region's content.
1009 Called with one argument METHOD.
1010 If METHOD is `delete-only', then delete the region; the return value
1011 is undefined. If METHOD is nil, then return the content as a string.
1012 If METHOD is `bounds', then return the boundaries of the region
1013 as a list of the form (START . END).
1014 If METHOD is anything else, delete the region and return its content
1015 as a string, after filtering it with `filter-buffer-substring', which
1026 first nil))))
1027 "Function to insert the region's content.
1028 Called with one argument LINES.
1032 "Delete the previous N characters (following if N is negative).
1033 If Transient Mark mode is enabled, the mark is active, and N is 1,
1034 delete the text in the region and deactivate the mark instead.
1035 To disable this, set option `delete-active-region' to nil.
1037 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1038 kill ring) instead of delete. Interactively, N is the prefix
1039 arg, and KILLFLAG is set if N is explicitly specified.
1041 When killing, the killed text is filtered by
1042 `filter-buffer-substring' before it is saved in the kill ring, so
1043 the actual saved text might be different from what was killed.
1045 In Overwrite mode, single character backward deletion may replace
1046 tabs with spaces so as to back over columns, unless point is at
1047 the end of the line."
1053 delete-active-region
1055 ;; If a region is active, kill or delete it.
1059 ;; In Overwrite mode, maybe untabify while deleting
1069 ;; Otherwise, do simple deletion.
1073 "Delete the following N characters (previous if N is negative).
1074 If Transient Mark mode is enabled, the mark is active, and N is 1,
1075 delete the text in the region and deactivate the mark instead.
1076 To disable this, set variable `delete-active-region' to nil.
1078 Optional second arg KILLFLAG non-nil means to kill (save in kill
1079 ring) instead of delete. Interactively, N is the prefix arg, and
1080 KILLFLAG is set if N was explicitly specified.
1082 When killing, the killed text is filtered by
1083 `filter-buffer-substring' before it is saved in the kill ring, so
1084 the actual saved text might be different from what was killed."
1090 delete-active-region
1092 ;; If a region is active, kill or delete it.
1097 ;; Otherwise, do simple deletion.
1101 "Put point at beginning and mark at end of buffer.
1102 If narrowing is in effect, only uses the accessible part of the buffer.
1103 You probably should not use this function in Lisp programs;
1104 it is usually a mistake for a Lisp function to use any subroutine
1105 that uses or sets the mark."
1110 ;; This is really `point-min' in most cases, but if we're in the
1111 ;; minibuffer, this is at the end of the prompt.
1113 \f
1115 ;; Counting lines, one way or another.
1118 "Go to LINE, counting from line 1 at beginning of buffer.
1119 If called interactively, a numeric prefix argument specifies
1120 LINE; without a numeric prefix argument, read LINE from the
1121 minibuffer.
1123 If optional argument BUFFER is non-nil, switch to that buffer and
1125 as argument, BUFFER is the most recently selected other buffer.
1127 Prior to moving point, this function sets the mark (without
1128 activating it), unless Transient Mark mode is enabled and the
1129 mark is already active.
1131 This function is usually the wrong thing to use in a Lisp program.
1132 What you probably want instead is something like:
1133 (goto-char (point-min))
1134 (forward-line (1- N))
1135 If at all possible, an even better solution is to use char counts
1136 rather than line counts."
1141 ;; Look for a default, a number in the buffer at point.
1151 ;; Decide if we're switching buffers.
1159 ;; Read the argument, offering that number (if any) as default.
1162 buffer))))
1163 ;; Switch to the desired buffer, one way or another.
1168 ;; Leave mark at previous position
1170 ;; Move to the specified line number in that buffer.
1179 "Count the number of words in the region.
1180 If called interactively, print a message reporting the number of
1181 lines, words, and characters in the region (whether or not the
1182 region is active); with prefix ARG, report for the entire buffer
1183 rather than the region.
1185 If called from Lisp, return the number of words between positions
1186 START and END."
1198 "Count words between START and END.
1199 If called interactively, START and END are normally the start and
1200 end of the buffer; but if the region is active, START and END are
1201 the start and end of the region. Print a message reporting the
1202 number of lines, words, and chars.
1204 If called from Lisp, return the number of words between START and
1205 END, without printing any message."
1215 words))
1231 str
1239 "Print the current buffer line number and narrowed line number of point."
1252 "Return number of lines between START and END.
1253 This is usually the number of newlines between them,
1254 but can be one more if START is not equal to END
1255 and the greater of them is not at the start of a line."
1271 done)))
1275 "Return buffer line number at position POS.
1276 If POS is nil, use current buffer location.
1278 If ABSOLUTE is nil, the default, counting starts
1279 at (point-min), so the value refers to the contents of the
1280 accessible portion of the (potentially narrowed) buffer. If
1281 ABSOLUTE is non-nil, ignore any narrowing and return the
1282 absolute line number."
1295 "Print info on cursor position (on screen and within buffer).
1296 Also describe the character after point, and give its character code
1297 in octal, decimal and hex.
1299 For a non-ASCII multibyte character, also give its encoding in the
1300 buffer's selected coding system if the coding system encodes the
1301 character safely. If the character is encoded into one byte, that
1302 code is shown in hex. If the character is encoded into more than one
1305 In addition, with prefix argument, show details about that character
1306 in *Help* buffer. See also the command `describe-char'."
1310 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1311 ;; start a directional embedding, which could completely
1312 ;; disrupt the rest of the line (e.g., RLO will display the
1313 ;; rest of the line right-to-left). So we put an invisible
1314 ;; PDF character after these characters, to end the
1315 ;; embedding, which eliminates any effects on the rest of
1316 ;; the line. For RLE and RLO we also append an invisible
1317 ;; LRM, to avoid reordering the following numerical
1318 ;; characters. For LRI/RLI/FSI we append a PDI.
1325 ;; Strong right-to-left characters cause reordering of
1326 ;; the following numerical characters which show the
1327 ;; codepoint, so append LRM to countermand that.
1338 ""
1344 pos total percent beg end col hscroll)
1346 pos total col hscroll))
1348 encoded encoding-msg display-prop under-display)
1355 ;; Check if the character is displayed with some `display'
1356 ;; text property. In that case, set under-display to the
1357 ;; buffer substring covered by that property.
1368 under-display)))
1374 char char char under-display)
1376 char char char under-display display-prop))
1379 char char char
1381 "..."
1385 ;; We show the detailed information about CHAR.
1392 bidi-fixer
1393 encoding-msg pos total percent beg end col hscroll)
1400 bidi-fixer encoding-msg pos total percent col hscroll))))))
1401 \f
1402 ;; Initialize read-expression-map. It is defined at C level.
1406 ;; Might as well bind TAB to completion, since inserting a TAB char is
1407 ;; much too rarely useful.
1410 m))
1413 "Return a Lisp object read using the minibuffer, unevaluated.
1414 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1415 is a string to insert in the minibuffer before reading.
1416 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1417 Such arguments are used as in `read-from-minibuffer'.)"
1418 ;; Used for interactive spec `x'.
1423 "Return value of Lisp expression read using the minibuffer.
1424 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1425 is a string to insert in the minibuffer before reading.
1426 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1427 Such arguments are used as in `read-from-minibuffer'.)"
1428 ;; Used for interactive spec `X'.
1436 "The current default value or list of default values in the minibuffer.
1437 The functions `read-from-minibuffer' and `completing-read' bind
1441 "Value for `print-level' while printing value in `eval-expression'.
1442 A value of nil means no limit."
1448 "Value for `print-length' while printing value in `eval-expression'.
1449 A value of nil means no limit."
1455 "If non-nil set `debug-on-error' to t in `eval-expression'.
1456 If nil, don't change the value of `debug-on-error'."
1462 "The largest integer that will be displayed as a character.
1463 This affects printing by `eval-expression' (via
1464 `eval-expression-print-format')."
1470 "If VALUE in an integer, return a specially formatted string.
1472 If VALUE is not an integer, nil is returned.
1473 This function is used by commands like `eval-expression' that
1474 display the result of expression evaluation."
1492 ;; FIXME: call emacs-lisp-mode?
1500 read-expression-map t
1504 "Get arguments for commands that print an expression result.
1505 Returns a list (INSERT-VALUE NO-TRUNCATE CHAR-PRINT-LIMIT)
1506 based on PREFIX-ARG. This function determines the interpretation
1507 of the prefix argument for `eval-expression' and
1508 `eval-last-sexp'."
1516 ;; We define this, rather than making `eval' interactive,
1517 ;; for the sake of completion of names like eval-region, eval-buffer.
1519 "Evaluate EXP and print value in the echo area.
1520 When called interactively, read an Emacs Lisp expression and
1521 evaluate it. Value is also consed on to front of the variable
1522 `values'. Optional argument INSERT-VALUE non-nil (interactively,
1523 with a non `-' prefix argument) means insert the result into the
1524 current buffer instead of printing it in the echo area.
1526 Normally, this function truncates long output according to the
1527 value of the variables `eval-expression-print-length' and
1528 `eval-expression-print-level'. When NO-TRUNCATE is
1529 non-nil (interactively, with a prefix argument of zero), however,
1530 there is no such truncation.
1532 If the resulting value is an integer, and CHAR-PRINT-LIMIT is
1533 non-nil (interactively, unless given a positive prefix argument)
1534 it will be printed in several additional formats (octal,
1535 hexadecimal, and character). The character format is only used
1536 if the value is below CHAR-PRINT-LIMIT (interactively, if the
1537 prefix argument is -1 or the value is below
1538 `eval-expression-print-maximum-character').
1540 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1541 minibuffer.
1543 If `eval-expression-debug-on-error' is non-nil, which is the default,
1544 this command arranges for all errors to enter the debugger."
1552 ;; Bind debug-on-error to something unique so that we can
1553 ;; detect when evalled code changes it.
1557 ;; If evalled code has changed the value of debug-on-error,
1558 ;; propagate that change to the global binding.
1574 "Prompting with PROMPT, let user edit COMMAND and eval result.
1575 COMMAND is a Lisp expression. Let user edit that expression in
1576 the minibuffer, then read and evaluate the result."
1583 read-expression-map t
1585 ;; If command was added to command-history as a string,
1586 ;; get rid of that. We want only evaluable expressions there.
1590 ;; If command to be redone does not match front of history,
1591 ;; add it to the history.
1597 "Edit and re-evaluate last complex command, or ARGth from last.
1598 A complex command is one which used the minibuffer.
1599 The command is placed in the minibuffer as a Lisp form for editing.
1600 The result is executed, repeating the command as changed.
1601 If the command has been changed or is not the most recent previous
1602 command it is added to the front of the command history.
1603 You can use the minibuffer history commands \
1605 to get different commands to edit and resubmit."
1608 newcmd)
1620 ;; If command was added to command-history as a
1621 ;; string, get rid of that. We want only
1622 ;; evaluable expressions there.
1626 ;; If command to be redone does not match front of history,
1627 ;; add it to the history.
1642 "Read command name to invoke in `execute-extended-command'."
1652 ;; Get a command name at point in the original buffer
1653 ;; to propose it after M-n.
1657 ;; Read a string, completing from and restricting to the set of
1658 ;; all defined commands. Don't provide any initial input.
1659 ;; Save the command read on the extended-command history list.
1670 ;; This isn't strictly correct if `execute-extended-command'
1671 ;; is bound to anything else (e.g. [menu]).
1672 ;; It could use (key-description (this-single-command-keys)),
1673 ;; but actually a prompt other than "M-x" would be confusing,
1674 ;; because "M-x" is a well-known prompt to read a command
1675 ;; and it serves as a shorthand for "Extended command: ".
1680 ;; Exclude obsolete commands from completions.
1685 pred)))
1690 "Non-nil means show the equivalent key-binding when M-x command has one.
1691 The value can be a length of time to show the message for.
1692 If the value is non-nil and not a number, we wait 2 seconds."
1699 "If non-nil, show a shorter M-x invocation when there is one."
1720 binding)
1726 name len)))
1727 ;; Don't show the help message if the binding isn't
1728 ;; significantly shorter than the M-x command the user typed.
1736 binding))
1739 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1740 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1741 "Read a command name, then read the arguments and call the command.
1742 To pass a prefix argument to the command you are
1743 invoking, give a prefix argument to `execute-extended-command'."
1745 ;; FIXME: Remember the actual text typed by the user before completion,
1746 ;; so that we don't later on suggest the same shortening.
1751 execute-extended-command--last-typed)))
1752 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1764 ;; Some features, such as novice.el, rely on this-command-keys
1765 ;; including M-x COMMAND-NAME RET.
1768 ;; Normally `real-this-command' should never be changed, but here we really
1769 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1770 ;; binding" for <cmd>, so the command the user really wanted to run is
1771 ;; `function' and not `execute-extended-command'. The difference is
1772 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1776 ;; If enabled, show which key runs this command.
1777 ;; But first wait, and skip the message if there is input.
1779 ;; If this command displayed something in the echo area;
1780 ;; wait a few seconds, then display our suggestion message.
1781 ;; FIXME: Wait *after* running post-command-hook!
1782 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1783 ;; find a better answer anyway!
1793 ;; There's no binding for CMD. Let's try and find the shortest
1794 ;; string to use in M-x.
1795 ;; FIXME: Can be slow. Cache it maybe?
1802 function
1807 suggest-key-bindings
1811 ;; BEWARE: Called directly from the C code.
1812 "Execute CMD as an editor command.
1813 CMD must be a symbol that satisfies the `commandp' predicate.
1814 Optional second arg RECORD-FLAG non-nil
1815 means unconditionally put this command in the variable `command-history'.
1816 Otherwise, that is done only if an arg is read using the minibuffer.
1817 The argument KEYS specifies the value to use instead of (this-command-keys)
1818 when reading the arguments; if it is nil, (this-command-keys) is used.
1819 The argument SPECIAL, if non-nil, means that this command is executing
1820 a special event, so ignore the prefix argument and don't clear it."
1823 ;; FIXME: This should probably be done around
1824 ;; pre-command-hook rather than here!
1832 disabled-command-function)
1833 ;; FIXME: Weird calling convention!
1843 ;; If requested, place the macro in the command history. For
1844 ;; other sorts of commands, call-interactively takes care of this.
1847 ;; Don't keep command history around forever.
1853 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1861 \f
1863 "Default minibuffer history list.
1864 This is used for all minibuffer input
1865 except when an alternate history list is specified.
1867 Maximum length of the history list is determined by the value
1870 "Control whether history list elements are expressions or strings.
1871 If the value of this variable equals current minibuffer depth,
1872 they are expressions; otherwise they are strings.
1873 \(That convention is designed to do the right thing for
1880 "Text that was in this minibuffer before any history commands.
1881 This is nil if there have not yet been any history commands
1890 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1895 "Minibuffer history variables for which matching should ignore case.
1896 If a history variable is a member of this list, then the
1898 commands ignore case when searching it, regardless of `case-fold-search'."
1903 "Find the previous history element that matches REGEXP.
1904 \(Previous history elements refer to earlier actions.)
1905 With prefix argument N, search for Nth previous match.
1906 If N is negative, find the next or Nth next match.
1907 Normally, history elements are matched case-insensitively if
1908 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1909 makes the search case-sensitive.
1910 See also `minibuffer-history-case-insensitive-variables'."
1914 nil
1915 minibuffer-local-map
1916 nil
1917 'minibuffer-history-search-history
1919 ;; Use the last regexp specified, by default, if input is empty.
1924 regexp)
1934 ;; On some systems, ignore case for file names.
1936 minibuffer-history-case-insensitive-variables)
1937 t
1938 ;; Respect the user's setting for case-fold-search:
1939 case-fold-search)
1940 nil))
1941 prevpos
1942 match-string
1943 match-offset
1950 "No later matching history item"
1971 next-matching-history-element))
1975 "Find the next history element that matches REGEXP.
1976 \(The next history element refers to a more recent action.)
1977 With prefix argument N, search for Nth next match.
1978 If N is negative, find the previous or Nth previous match.
1979 Normally, history elements are matched case-insensitively if
1980 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1981 makes the search case-sensitive."
1985 nil
1986 minibuffer-local-map
1987 nil
1988 'minibuffer-history-search-history
1990 ;; Use the last regexp specified, by default, if input is empty.
1995 regexp)
2002 "Function run by `goto-history-element' before consuming default values.
2003 This is useful to dynamically add more elements to the list of default values
2004 when `goto-history-element' reaches the end of this list.
2005 Before calling this function `goto-history-element' sets the variable
2006 `minibuffer-default-add-done' to t, so it will call this function only
2007 once. In special cases, when this function needs to be called more
2008 than once, it can set `minibuffer-default-add-done' to nil explicitly,
2012 "When nil, add more elements to the end of the list of default values.
2013 The value nil causes `goto-history-element' to add more elements to
2014 the list of defaults when it reaches the end of this list. It does
2020 "Return a list of all completions without the default value.
2021 This function is used to add all elements of the completion table to
2022 the end of the list of defaults just after the default value."
2025 minibuffer-completion-table
2026 minibuffer-completion-predicate)))
2032 "Puts element of the minibuffer history in the minibuffer.
2033 The argument NABS specifies the absolute history position."
2047 elt minibuffer-returned-to-present)
2054 "End of defaults; no next item"
2061 previous-history-element))
2073 minibuffer-default)))
2085 elt))
2089 "Puts next element of the minibuffer history in the minibuffer.
2090 With argument N, it uses the Nth following element."
2096 "Puts previous element of the minibuffer history in the minibuffer.
2097 With argument N, it uses the Nth previous element."
2103 "Move cursor vertically down ARG lines, or to the next history element.
2104 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2105 next element of the minibuffer history in the minibuffer."
2109 ;; Remember the original goal column of possibly multi-line input
2110 ;; excluding the length of the prompt on the first line.
2120 ;; Restore old position since `line-move-visual' moves point to
2121 ;; the end of the line when it fails to go to the next line.
2124 ;; Reset `temporary-goal-column' because a correct value is not
2125 ;; calculated when `next-line' above fails by bumping against
2126 ;; the bottom of the minibuffer (bug#22544).
2128 ;; Restore the original goal column on the last line
2129 ;; of possibly multi-line input.
2137 "Move cursor vertically up ARG lines, or to the previous history element.
2138 When point moves over the top line of multi-line minibuffer, puts ARGth
2139 previous element of the minibuffer history in the minibuffer."
2143 ;; Remember the original goal column of possibly multi-line input
2144 ;; excluding the length of the prompt on the first line.
2154 ;; Restore old position since `line-move-visual' moves point to
2155 ;; the beginning of the line when it fails to go to the previous line.
2158 ;; Reset `temporary-goal-column' because a correct value is not
2159 ;; calculated when `previous-line' above fails by bumping against
2160 ;; the top of the minibuffer (bug#22544).
2162 ;; Restore the original goal column on the first line
2163 ;; of possibly multi-line input.
2169 ;; Put the cursor at the end of the visual line instead of the
2170 ;; logical line, so the next `previous-line-or-history-element'
2171 ;; would move to the previous history element, not to a possible upper
2172 ;; visual line from the end of logical line in `line-move-visual' mode.
2174 ;; Since `end-of-visual-line' puts the cursor at the beginning
2175 ;; of the next visual line, move it one char back to the end
2176 ;; of the first visual line (bug#22544).
2180 "Get next history element which completes the minibuffer before the point.
2181 The contents of the minibuffer after the point are deleted, and replaced
2182 by the new completion."
2188 n)
2189 ;; next-matching-history-element always puts us at (point-min).
2190 ;; Move to the position we were at before changing the buffer contents.
2191 ;; This is still sensible, because the text before point has not changed.
2195 "\
2196 Get previous history element which completes the minibuffer before the point.
2197 The contents of the minibuffer after the point are deleted, and replaced
2198 by the new completion."
2202 ;; For compatibility with the old subr of the same name.
2204 "Return the display width of the minibuffer prompt.
2205 Return 0 if current buffer is not a minibuffer."
2206 ;; Return the width of everything before the field at the end of
2207 ;; the buffer; this should be 0 for normal buffers.
2209 \f
2210 ;; isearch minibuffer history
2217 "Set up a minibuffer for using isearch to search the minibuffer history.
2218 Intended to be added to `minibuffer-setup-hook'."
2230 "Clean up the minibuffer after terminating isearch in the minibuffer."
2235 "Return the proper search function, for isearch in minibuffer history."
2238 ;; Use standard functions to search within minibuffer text
2240 found)
2241 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2242 ;; searching forward. Lazy-highlight calls this lambda with the
2243 ;; bound arg, so skip the minibuffer prompt.
2247 ;; 1. First try searching in the initial minibuffer text
2250 noerror)
2251 ;; 2. If the above search fails, start putting next/prev history
2252 ;; elements in the minibuffer successively, and search the string
2253 ;; in them. Do this only when bound is nil (i.e. not while
2254 ;; lazy-highlighting search strings in the current minibuffer text).
2266 ;; After putting the next/prev history element, search
2267 ;; the string in them again, until next-history-element
2268 ;; or previous-history-element raises an error at the
2269 ;; beginning/end of history.
2272 ;; For backward search, don't search
2273 ;; in the minibuffer prompt
2275 noerror)))
2276 ;; Return point of the new search result
2278 ;; Return nil when next(prev)-history-element fails
2282 "Display the minibuffer history search prompt.
2283 If there are no search errors, this function displays an overlay with
2284 the isearch prompt which replaces the original minibuffer prompt.
2285 Otherwise, it displays the standard isearch message returned from
2286 the function `isearch-message'."
2288 ;; Use standard function `isearch-message' when not in the minibuffer,
2289 ;; or search fails, or has an error (like incomplete regexp).
2290 ;; This function overwrites minibuffer text with isearch message,
2291 ;; so it's possible to see what is wrong in the search string.
2293 ;; Otherwise, put the overlay with the standard isearch prompt over
2294 ;; the initial minibuffer prompt.
2303 ;; And clear any previous isearch message.
2307 "Wrap the minibuffer history search when search fails.
2308 Move point to the first history element for a forward search,
2309 or to the last history element for a backward search."
2310 ;; When `minibuffer-history-isearch-search' fails on reaching the
2311 ;; beginning/end of the history, wrap the search to the first/last
2312 ;; minibuffer history element.
2320 "Save a function restoring the state of minibuffer history search.
2321 Save `minibuffer-history-position' to the additional state parameter
2322 in the search status stack."
2328 "Restore the minibuffer history search state.
2329 Go to the history element by the absolute history position HIST-POS."
2332 \f
2333 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2337 "Table mapping redo records to the corresponding undo one.
2338 A redo record for undo-in-region maps to t.
2348 "Within a run of consecutive undo commands, list remaining to be undone.
2352 "Undo some previous changes.
2353 Repeat this command to undo more changes.
2354 A numeric ARG serves as a repeat count.
2356 In Transient Mark mode when the mark is active, only undo changes within
2358 as an argument limits undo to changes within the current region."
2360 ;; Make last-command indicate for the next command that this was an undo.
2361 ;; That way, another undo will undo more.
2362 ;; If we get to the end of the undo history and get an error,
2363 ;; another undo command will find the undo history empty
2364 ;; and will get another error. To begin undoing the undos,
2365 ;; you must type some other command.
2367 ;; For an indirect buffer, look in the base buffer for the
2368 ;; auto-save data.
2372 message)
2373 ;; If we get an error in undo-start,
2374 ;; the next command should not be a "consecutive undo".
2375 ;; So set `this-command' to something other than `undo'.
2380 ;; If something (a timer or filter?) changed the buffer
2381 ;; since the previous command, don't continue the undo seq.
2385 ;; If the last undo record made was made by undo
2386 ;; it shows nothing else happened in between.
2393 ;; get rid of initial undo boundary
2395 ;; If we got this far, the next command should be a consecutive undo.
2397 ;; Check to see whether we're hitting a redo record, and if
2398 ;; so, ask the user whether she wants to skip the redo/undo pair.
2406 ;; The equiv entry might point to another redo record if we have done
2407 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2415 ;; Record the fact that the just-generated undo records come from an
2416 ;; undo operation--that is, they are redo records.
2417 ;; In the ordinary case (not within a region), map the redo
2418 ;; record to the following undos.
2419 ;; I don't know how to do that in the undo-in-region case.
2421 ;; Strip any leading undo boundaries there might be, like we do
2422 ;; above when checking.
2426 ;; Prevent identity mapping. This can happen if
2427 ;; consecutive nils are erroneously in undo list.
2429 t
2430 pending-undo-list)
2431 undo-equiv-table))
2432 ;; Don't specify a position in the undo record for the undo command.
2433 ;; Instead, undoing this should move point to where the change is.
2452 ;; Record what the current undo list says,
2453 ;; so the next command can tell if the buffer was modified in between.
2457 ;; Display a message announcing success.
2462 "Make BUFFER stop keeping undo information.
2463 No argument or nil as argument means do this for the current buffer."
2469 "Undo some previous changes.
2470 Repeat this command to undo more changes.
2471 A numeric ARG serves as a repeat count.
2472 Contrary to `undo', this will not redo a previous undo."
2477 "Non-nil while performing an undo.
2481 "Undo back N undo-boundaries beyond what was already undone recently.
2482 Call `undo-start' to get ready to undo recent changes,
2483 then call `undo-more' one or more times to undo them."
2488 ;; Note: The following, while pulling elements off
2489 ;; `pending-undo-list' will call primitive change functions which
2490 ;; will push more elements onto `buffer-undo-list'.
2496 "Undo N records from the front of the list LIST.
2497 Return what remains of the list."
2499 ;; This is a good feature, but would make undo-start
2500 ;; unable to do what is expected.
2501 ;;(when (null (car (list)))
2502 ;; ;; If the head of the list is a boundary, it is the boundary
2503 ;; ;; preceding this command. Get rid of it and don't count it.
2504 ;; (setq list (cdr list))))
2507 ;; In a writable buffer, enable undoing read-only text that is
2508 ;; so because of text properties.
2510 ;; Don't let `intangible' properties interfere with undo.
2512 ;; We use oldlist only to check for EQ. ++kfs
2518 ;; Handle an integer by setting point to that value.
2521 ;; Element (t . TIME) records previous modtime.
2522 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2523 ;; UNKNOWN_MODTIME_NSECS.
2525 ;; If this records an obsolete save
2526 ;; (not matching the actual disk file)
2527 ;; then don't mark unmodified.
2535 ;; Element (nil PROP VAL BEG . END) is property change.
2540 ;; Element (BEG . END) means range was inserted.
2542 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2543 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2546 ;; Set point first thing, so that undoing this undo
2547 ;; does not send point back to where it is now.
2550 ;; Element (apply FUN . ARGS) means call FUN to undo.
2554 ;; Long format: (apply DELTA START END FUN . ARGS).
2561 ;; Check that the function did what the entry
2562 ;; said it would do.
2572 ;; Element (STRING . POS) means STRING was deleted.
2578 ;; Check that marker adjustments which were recorded
2579 ;; with the (STRING . POS) record are still valid, ie
2580 ;; the markers haven't moved. We check their validity
2581 ;; before reinserting the string so as we don't need to
2582 ;; mind marker insertion-type.
2590 ;; Insert string and adjust point
2598 ;; Adjust the valid marker adjustments
2600 ;; Insert might have invalidated some of the markers
2601 ;; via modification hooks. Update only the currently
2602 ;; valid ones (bug#25599).
2606 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2609 next)
2610 ;; Even though these elements are not expected in the undo
2611 ;; list, adjust them to be conservative for the 24.4
2612 ;; release. (Bug#16818)
2619 ;; Make sure an apply entry produces at least one undo entry,
2620 ;; so the test in `undo' for continuing an undo series
2621 ;; will work right.
2626 list)
2628 ;; Deep copy of a list
2630 "Make a copy of undo list LIST."
2636 elt))
2639 "Set `pending-undo-list' to the front of the undo list.
2640 The next call to `undo-more' will undo the most recently made change.
2641 If BEG and END are specified, then only undo elements
2642 that apply to text between BEG and END are used; other undo elements
2643 are ignored. If BEG and END are nil, all undo elements are used."
2649 buffer-undo-list)))
2651 ;; The positions given in elements of the undo list are the positions
2652 ;; as of the time that element was recorded to undo history. In
2653 ;; general, subsequent buffer edits render those positions invalid in
2654 ;; the current buffer, unless adjusted according to the intervening
2655 ;; undo elements.
2656 ;;
2657 ;; Undo in region is a use case that requires adjustments to undo
2658 ;; elements. It must adjust positions of elements in the region based
2659 ;; on newer elements not in the region so as they may be correctly
2660 ;; applied in the current buffer. undo-make-selective-list
2661 ;; accomplishes this with its undo-deltas list of adjustments. An
2662 ;; example undo history from oldest to newest:
2663 ;;
2664 ;; buf pos:
2665 ;; 123456789 buffer-undo-list undo-deltas
2666 ;; --------- ---------------- -----------
2667 ;; aaa (1 . 4) (1 . -3)
2668 ;; aaba (3 . 4) N/A (in region)
2669 ;; ccaaba (1 . 3) (1 . -2)
2670 ;; ccaabaddd (7 . 10) (7 . -3)
2671 ;; ccaabdd ("ad" . 6) (6 . 2)
2672 ;; ccaabaddd (6 . 8) (6 . -2)
2673 ;; | |<-- region: "caab", from 2 to 6
2674 ;;
2675 ;; When the user starts a run of undos in region,
2676 ;; undo-make-selective-list is called to create the full list of in
2677 ;; region elements. Each element is adjusted forward chronologically
2678 ;; through undo-deltas to determine if it is in the region.
2679 ;;
2680 ;; In the above example, the insertion of "b" is (3 . 4) in the
2681 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2682 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2683 ;; . 6) is assessed as in the region and placed in the selective list.
2684 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2685 ;; due to the selected element. The "b" insertion is the only element
2686 ;; fully in the region, so in this example undo-make-selective-list
2687 ;; returns (nil (5 . 6)).
2688 ;;
2689 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2690 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2691 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2692 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2693 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2694 ;;
2695 ;; More interesting is how to adjust the "ddd" insertion due to the
2696 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2697 ;; If the reinsertion was a manual retyping of "ad", then the total
2698 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2699 ;; the reinsertion was due to undo, one might expect the first "d"
2700 ;; character would again be a part of the "ddd" text, meaning its
2701 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2702 ;;
2703 ;; undo-make-selective-list assumes in this situation that "ad" was a
2704 ;; new edit, even if it was inserted because of an undo.
2705 ;; Consequently, if the user undos in region "8 to 10" of the
2706 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2707 ;; "ccaabad", as though the first "d" became detached from the
2708 ;; original "ddd" insertion. This quirk is a FIXME.
2711 "Return a list of undo elements for the region START to END.
2712 The elements come from `buffer-undo-list', but we keep only the
2713 elements inside this region, and discard those outside this
2714 region. The elements' positions are adjusted so as the returned
2715 list can be applied to the current buffer."
2717 ;; A list of position adjusted undo elements in the region.
2719 ;; A list of undo-deltas for out of region undo elements.
2720 undo-deltas
2721 undo-elt)
2729 ;; Don't put two nils together in the list
2733 ;; This is a "was unmodified" element. Keep it
2734 ;; if we have kept everything thus far.
2737 ;; Skip over marker adjustments, instead relying
2738 ;; on finding them after (TEXT . POS) elements
2740 nil)
2743 undo-deltas)))
2748 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2749 ;; kept. primitive-undo may discard them later.
2762 "Determine whether UNDO-ELT falls inside the region START ... END.
2763 If it crosses the edge, we return nil.
2765 Generally this function is not useful for determining
2766 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2767 because markers can be arbitrarily relocated. Instead, pass the
2768 marker adjustment's corresponding (TEXT . POS) element."
2773 t)
2775 nil)
2777 ;; (TEXT . POSITION)
2781 ;; (MARKER . ADJUSTMENT)
2784 ;; (nil PROPERTY VALUE BEG . END)
2789 ;; (BEGIN . END)
2794 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2795 This assumes we have already decided that UNDO-ELT
2796 is not *inside* the region START...END."
2800 ;; (nil PROPERTY VALUE BEG . END)
2805 ;; (BEGIN . END)
2810 "Return adjustment of undo element ELT by the undo DELTAS
2811 list."
2813 ;; POSITION
2816 ;; (BEG . END)
2819 ;; (TEXT . POSITION)
2823 ;; (nil PROPERTY VALUE BEG . END)
2826 ;; (apply DELTA START END FUN . ARGS)
2827 ;; FIXME
2828 ;; All others return same elt
2831 ;; (BEG . END) can adjust to the same positions, commonly when an
2832 ;; insertion was undone and they are out of region, for example:
2833 ;;
2834 ;; buf pos:
2835 ;; 123456789 buffer-undo-list undo-deltas
2836 ;; --------- ---------------- -----------
2837 ;; [...]
2838 ;; abbaa (2 . 4) (2 . -2)
2839 ;; aaa ("bb" . 2) (2 . 2)
2840 ;; [...]
2841 ;;
2842 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2843 ;; undo. Further adjustments to such an element should be the same as
2844 ;; for (TEXT . POSITION) elements. The options are:
2845 ;;
2846 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2847 ;; analogous to marker insertion-type t.
2848 ;;
2849 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2850 ;; marker insertion-type nil.
2851 ;;
2852 ;; There was no strong reason to prefer one or the other, except that
2853 ;; the first is more consistent with prior undo in region behavior.
2855 "Return cons of adjustments to BEG and END by the undo DELTAS
2856 list."
2858 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2863 "Return adjustment of POS by the undo DELTAS list, comparing
2864 with < or <= based on USE-<."
2870 ;; Don't allow pos to become less than the undo-delta
2871 ;; position. This edge case is described in the overview
2872 ;; comments.
2875 ;; Return the first affected buffer position and the delta for an undo element
2876 ;; delta is defined as the change in subsequent buffer positions if we *did*
2877 ;; the undo.
2881 ;; (TEXT . POSITION)
2884 ;; (BEGIN . END)
2890 ;;; Default undo-boundary addition
2891 ;;
2892 ;; This section adds a new undo-boundary at either after a command is
2893 ;; called or in some cases on a timer called after a change is made in
2894 ;; any buffer.
2896 "Describe the cause of the last undo-boundary.
2898 If `explicit', the last boundary was caused by an explicit call to
2899 `undo-boundary', that is one not called by the code in this
2900 section.
2902 If it is equal to `timer', then the last boundary was inserted
2903 by `undo-auto--boundary-timer'.
2905 If it is equal to `command', then the last boundary was inserted
2906 automatically after a command, that is by the code defined in
2907 this section.
2909 If it is equal to a list, then the last boundary was inserted by
2910 an amalgamating command. The car of the list is the number of
2911 times an amalgamating command has been called, and the cdr are the
2915 "Current timer which will run `undo-auto--boundary-timer' or nil.
2920 "Non-nil if `this-command' should be amalgamated.
2921 This variable is set to nil by `undo-auto--boundaries' and is set
2925 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2929 "Return the number of amalgamating last commands or nil.
2930 Amalgamating commands are, by default, either
2931 `self-insert-command' and `delete-char', but can be any command
2932 that calls `undo-auto-amalgamate'."
2936 "Add an `undo-boundary' to the current buffer if needed.
2937 REASON describes the reason that the boundary is being added; see
2938 `undo-auto--last-boundary' for more information."
2948 undo-auto--undoably-changed-buffers)
2949 cause)))))
2952 "Check recently changed buffers and add a boundary if necessary.
2953 REASON describes the reason that the boundary is being added; see
2954 `undo-last-boundary' for more information."
2955 ;; (Bug #23785) All commands should ensure that there is an undo
2956 ;; boundary whether they have changed the current buffer or not.
2966 "Timer which will run `undo--auto-boundary-timer'."
2971 "Ensure that the `undo-auto-boundary-timer' is set."
2977 "List of buffers that have changed recently.
2979 This list is maintained by `undo-auto--undoable-change' and
2980 `undo-auto--boundaries' and can be affected by changes to their
2984 "Add an `undo-boundary' in appropriate buffers."
2989 'amalgamate
2993 "Amalgamate undo if necessary.
2994 This function can be called before an amalgamating command. It
2995 removes the previous `undo-boundary' if a series of such calls
2996 have been made. By default `self-insert-command' and
2997 `delete-char' are the only amalgamating commands, although this
2998 function could be called by any command wishing to have this
2999 behavior."
3004 last-amalgamating-count
3009 ;; Amalgamate all buffers that have changed.
3013 b
3015 ;; The head of `buffer-undo-list' is nil.
3016 ;; `car-safe' doesn't work because
3017 ;; `buffer-undo-list' need not be a list!
3025 "Called after every undoable buffer change."
3028 ;; End auto-boundary section
3031 "Amalgamate changes in change-group since HANDLE.
3032 Remove all undo boundaries between the state of HANDLE and now.
3033 HANDLE is as returned by `prepare-change-group'."
3042 ;; Temporarily truncate the undo log at ELT.
3047 ;; `elt' is still in the log: normal case.
3049 ;; `elt' is not in the log any more, but that's because
3050 ;; the log is "all new", so we should remove all
3051 ;; boundaries from it.
3055 buffer-undo-list
3056 ;; Preserve the undo-boundaries at either ends of the
3057 ;; change-groups.
3059 ;; Reset the modified cons cell ELT to its original content.
3066 "If non-nil ask about discarding undo info for the current command.
3067 Normally, Emacs discards the undo info for the current command if
3068 it exceeds `undo-outer-limit'. But if you set this option
3069 non-nil, it asks in the echo area whether to discard the info.
3070 If you answer no, there is a slight risk that Emacs might crash, so
3071 only do it if you really want to undo the command.
3073 This option is mainly intended for debugging. You have to be
3074 careful if you use it for other purposes. Garbage collection is
3075 inhibited while the question is asked, meaning that Emacs might
3076 leak memory. So you should make sure that you do not wait
3077 excessively long before answering the question."
3083 "If non-nil, an extra level of size that's ok in an undo item.
3084 We don't ask the user about truncating the undo list until the
3085 current item gets bigger than this amount.
3090 ;; When the first undo batch in an undo list is longer than
3091 ;; undo-outer-limit, this function gets called to warn the user that
3092 ;; the undo info for the current command was discarded. Garbage
3093 ;; collection is inhibited around the call, so it had better not do a
3094 ;; lot of consing.
3100 ;; Don't ask the question again unless it gets even bigger.
3101 ;; This applies, in particular, if the user quits from the question.
3102 ;; Such a quit quits out of GC, but something else will call GC
3103 ;; again momentarily. It will call this function again,
3104 ;; but we don't want to ask the question again.
3108 "Buffer `%s' undo info is %d bytes long; discard it? "
3112 t)
3113 nil))
3119 "The undo info was discarded because it exceeded \
3120 `undo-outer-limit'.
3122 This is normal if you executed a command that made a huge change
3123 to the buffer. In that case, to prevent similar problems in the
3124 future, set `undo-outer-limit' to a value that is large enough to
3125 cover the maximum size of normal changes you expect a single
3126 command to make, but not so large that it might exceed the
3127 maximum memory allotted to Emacs.
3129 If you did not execute any such command, the situation is
3130 probably due to a bug and you should report it.
3132 You can disable the popping up of this buffer by adding the entry
3133 \(undo discard-info) to the user option `warning-suppress-types',
3137 t))
3138 \f
3141 ; These are sorted according to the GNU en_US locale.
3184 )
3186 This is used by Shell mode and other parts of Emacs to recognize
3187 password prompts, including prompts in languages other than
3188 English. Different case choices should not be assumed to be
3189 included; callers should bind `case-fold-search' to t."
3195 "History list for some commands that read shell commands.
3197 Maximum length of the history list is determined by the value
3204 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3205 This buffer is used when `shell-command' or `shell-command-on-region'
3206 is run interactively. A value of nil means that output to stderr and
3213 "Return a list of all commands associated with the current file.
3214 This function is used to add all related commands retrieved by `mailcap'
3215 to the end of the list of defaults just after the default value."
3219 minibuffer-default))
3224 commands))
3235 map)
3239 "Read a shell command from the minibuffer.
3240 The arguments are the same as the ones of `read-from-minibuffer',
3241 except READ and KEYMAP are missing and HIST defaults
3242 to `shell-command-history'."
3250 minibuffer-local-shell-command-map
3251 nil
3253 args)))
3256 "What to do when the output buffer is used by another shell command.
3257 This option specifies how to resolve the conflict where a new command
3258 wants to direct its output to the buffer `*Async Shell Command*',
3259 but this buffer is already taken by another running shell command.
3261 The value `confirm-kill-process' is used to ask for confirmation before
3262 killing the already running process and running a new process
3263 in the same buffer, `confirm-new-buffer' for confirmation before running
3264 the command in a new buffer with a name other than the default buffer name,
3265 `new-buffer' for doing the same without confirmation,
3266 `confirm-rename-buffer' for confirmation before renaming the existing
3267 output buffer and running a new command in the default buffer,
3268 `rename-buffer' for doing the same without confirmation."
3270 confirm-kill-process)
3272 confirm-new-buffer)
3274 new-buffer)
3276 confirm-rename-buffer)
3278 rename-buffer))
3283 "Whether to display the command buffer immediately.
3284 If t, display the buffer immediately; if nil, wait until there
3285 is output."
3287 t)
3289 nil))
3294 "Store a buffer position or erase the buffer.
3295 See `shell-command-dont-erase-buffer'."
3297 pos)
3299 ;; Setting buffer-read-only to nil doesn't suffice
3300 ;; if some text has a non-nil read-only property,
3301 ;; which comint sometimes adds for prompts.
3311 shell-command-saved-pos))))
3314 "Set point in BUFFER after command complete.
3315 BUFFER is the output buffer of the command; if nil, then defaults
3316 to the current BUFFER.
3317 Set point to the `cdr' of the element in `shell-command-saved-pos'
3318 whose `car' is BUFFER."
3330 ;; Set point in the window displaying buf, if any; otherwise
3331 ;; display buf temporary in selected frame and set the point.
3336 buf
3341 "Execute string COMMAND asynchronously in background.
3343 Like `shell-command', but adds `&' at the end of COMMAND
3344 to execute it asynchronously.
3346 The output appears in the buffer `*Async Shell Command*'.
3347 That buffer is in shell mode.
3349 You can configure `async-shell-command-buffer' to specify what to do in
3350 case when `*Async Shell Command*' buffer is already taken by another
3351 running shell command. To run COMMAND without displaying the output
3352 in a window you can configure `display-buffer-alist' to use the action
3353 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3355 In Elisp, you will often be better served by calling `start-process'
3356 directly, since it offers more control and does not impose the use of a
3357 shell (with its need to quote arguments)."
3367 current-prefix-arg
3368 shell-command-default-error-buffer))
3374 "Execute string COMMAND in inferior shell; display output, if any.
3375 With prefix argument, insert the COMMAND's output at point.
3377 Interactively, prompt for COMMAND in the minibuffer.
3379 If COMMAND ends in `&', execute it asynchronously.
3380 The output appears in the buffer `*Async Shell Command*'.
3381 That buffer is in shell mode. You can also use
3382 `async-shell-command' that automatically adds `&'.
3384 Otherwise, COMMAND is executed synchronously. The output appears in
3385 the buffer `*Shell Command Output*'. If the output is short enough to
3386 display in the echo area (which is determined by the variables
3387 `resize-mini-windows' and `max-mini-window-height'), it is shown
3388 there, but it is nonetheless available in buffer `*Shell Command
3389 Output*' even though that buffer is not automatically displayed.
3391 To specify a coding system for converting non-ASCII characters
3393 before this command.
3395 Noninteractive callers can specify coding systems by binding
3396 `coding-system-for-read' and `coding-system-for-write'.
3398 The optional second argument OUTPUT-BUFFER, if non-nil,
3399 says to put the output in some other buffer.
3400 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3401 and insert the output there; a non-nil value of
3402 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3403 If OUTPUT-BUFFER is not a buffer and not nil, insert the output
3404 in current buffer after point leaving mark after it.
3405 This cannot be done asynchronously.
3407 If the command terminates without error, but generates output,
3409 the output can be displayed in the echo area or in its buffer.
3410 If the output is short enough to display in the echo area
3411 \(determined by the variable `max-mini-window-height' if
3412 `resize-mini-windows' is non-nil), it is shown there.
3413 Otherwise,the buffer containing the output is displayed.
3417 of the output.
3419 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3420 or buffer name to which to direct the command's standard error output.
3421 If it is nil, error output is mingled with regular output.
3422 In an interactive call, the variable `shell-command-default-error-buffer'
3423 specifies the value of ERROR-BUFFER.
3425 In Elisp, you will often be better served by calling `call-process' or
3426 `start-process' directly, since it offers more control and does not impose
3427 the use of a shell (with its need to quote arguments)."
3438 current-prefix-arg
3439 shell-command-default-error-buffer))
3440 ;; Look for a handler in case default-directory is a remote file name.
3448 ;; Output goes in current buffer.
3454 temporary-file-directory)))
3455 nil)))
3458 ;; We do not use -f for csh; we will not support broken use of
3459 ;; .cshrcs. Even the BSD csh manual says to use
3460 ;; "if ($?prompt) exit" before things which are not useful
3461 ;; non-interactively. Besides, if someone wants their other
3462 ;; aliases for shell commands then they can still have them.
3466 t)
3467 nil shell-command-switch command)
3474 ;; Do no formatting while reading error file,
3475 ;; because that can run a shell command, and we
3476 ;; don't want that to cause an infinite recursion.
3478 ;; Put point after the inserted errors.
3482 ;; This is like exchange-point-and-mark, but doesn't
3483 ;; activate the mark. It is cleaner to avoid activation,
3484 ;; even though the command loop would deactivate the mark
3485 ;; because we inserted text.
3489 ;; Output goes in a separate buffer.
3490 ;; Preserve the match data in case called from a program.
3491 ;; FIXME: It'd be ridiculous for an Elisp function to call
3492 ;; shell-command and assume that it won't mess the match-data!
3495 ;; Command ending with ampersand means asynchronous.
3499 proc)
3500 ;; Remove the ampersand.
3502 ;; Ask the user what to do with already running process.
3507 ;; If will kill a process, query first.
3512 ;; If will create a new buffer, query first.
3519 ;; It will create a new buffer.
3524 ;; If will rename the buffer, query first.
3533 ;; It will rename the buffer.
3542 shell-command-switch command))
3546 ;; Use the comint filter for proper handling of carriage motion
3547 ;; (see `comint-inhibit-carriage-motion'),.
3557 ))
3558 ))
3559 ;; Otherwise, command is executed synchronously.
3561 output-buffer nil error-buffer)))))))
3564 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3565 MESSAGE may be either a string or a buffer.
3567 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3568 for maximum height of the echo area, as defined by `max-mini-window-height'
3569 if `resize-mini-windows' is non-nil.
3571 Returns either the string shown in the echo area, or when a pop-up
3572 buffer is used, the window used to display it.
3574 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3575 name of the buffer used to display it in the case where a pop-up buffer
3576 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3577 string and it is displayed in the echo area, it is not specified whether
3578 the contents are inserted into the buffer anyway.
3580 Optional arguments ACTION and FRAME are as for `display-buffer',
3581 and are only used if a pop-up buffer is displayed."
3583 ;; Trivial case where we can use the echo area
3587 ;; Trivial case where we can just remove single trailing newline
3590 ;; General case
3593 message
3602 0
3606 (<= lines
3610 max-mini-window-height))
3612 max-mini-window-height)
3616 ;; Don't use the echo area if the output buffer is
3617 ;; already displayed in the selected frame.
3619 ;; Echo area
3625 ;; Buffer
3630 ;; We have a sentinel to prevent insertion of a termination message
3631 ;; in the buffer itself, and to set the point in the buffer when
3632 ;; `shell-command-dont-erase-buffer' is non-nil.
3641 &optional output-buffer replace
3642 error-buffer display-error-buffer
3643 region-noncontiguous-p)
3644 "Execute string COMMAND in inferior shell with region as input.
3645 Normally display output (if any) in temp buffer `*Shell Command Output*';
3646 Prefix arg means replace the region with it. Return the exit code of
3647 COMMAND.
3649 To specify a coding system for converting non-ASCII characters
3651 before this command. By default, the input (from the current buffer)
3652 is encoded using coding-system specified by `process-coding-system-alist',
3653 falling back to `default-process-coding-system' if no match for COMMAND
3654 is found in `process-coding-system-alist'.
3656 Noninteractive callers can specify coding systems by binding
3657 `coding-system-for-read' and `coding-system-for-write'.
3659 If the command generates output, the output may be displayed
3660 in the echo area or in a buffer.
3661 If the output is short enough to display in the echo area
3662 \(determined by the variable `max-mini-window-height' if
3663 `resize-mini-windows' is non-nil), it is shown there.
3664 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3665 The output is available in that buffer in both cases.
3667 If there is output and an error, a message about the error
3668 appears at the end of the output.
3670 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3671 command's output. If the value is a buffer or buffer name,
3672 erase that buffer and insert the output there; a non-nil value of
3673 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3674 If the value is nil, use the buffer `*Shell Command Output*'.
3675 Any other non-nil value means to insert the output in the
3676 current buffer after START.
3678 Optional fifth arg REPLACE, if non-nil, means to insert the
3679 output in place of text from START to END, putting point and mark
3680 around it.
3682 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3683 or buffer name to which to direct the command's standard error
3684 output. If nil, error output is mingled with regular output.
3685 When called interactively, `shell-command-default-error-buffer'
3686 is used for ERROR-BUFFER.
3688 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3689 display the error buffer if there were any errors. When called
3690 interactively, this is t."
3694 ;; Do this before calling region-beginning
3695 ;; and region-end, in case subprocess output
3696 ;; relocates them while we are in the minibuffer.
3698 ;; call-interactively recognizes region-beginning and
3699 ;; region-end specially, leaving them in the history.
3701 string
3702 current-prefix-arg
3703 current-prefix-arg
3704 shell-command-default-error-buffer
3705 t
3712 temporary-file-directory)))
3713 nil))
3714 exit-status)
3715 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3718 output)
3722 shell-file-name t t
3723 nil shell-command-switch
3724 command)
3731 ;; Replace specified region with output from command.
3733 ;; Don't muck with mark unless REPLACE says we should.
3740 t)))
3741 ;; It is rude to delete a buffer which the command is not using.
3742 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3743 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3744 ;; (kill-buffer shell-buffer)))
3745 ;; Don't muck with mark unless REPLACE says we should.
3747 ;; No prefix argument: put the output in a temp buffer,
3748 ;; replacing its entire contents.
3756 ;; If the input is the same buffer as the output,
3757 ;; delete everything but the specified region,
3758 ;; then replace that region with the output.
3764 shell-file-name t
3767 t)
3768 nil shell-command-switch
3769 command)))
3770 ;; Clear the output buffer, then run the command with
3771 ;; output there.
3781 buffer))))
3782 ;; Report the output.
3792 ;; There's some output, display it
3796 ;; No output; error?
3803 shell-command-default-error-buffer)
3810 output))
3813 exit-status))
3816 exit-status output))))
3817 ;; Don't kill: there might be useful info in the undo-log.
3818 ;; (kill-buffer buffer)
3819 )))))
3827 ;; Do no formatting while reading error file,
3828 ;; because that can run a shell command, and we
3829 ;; don't want that to cause an infinite recursion.
3831 ;; Put point after the inserted errors.
3836 exit-status))
3839 "Execute shell command COMMAND and return its output as a string."
3842 standard-output
3846 "Process files synchronously in a separate process.
3847 Similar to `call-process', but may invoke a file handler based on
3848 `default-directory'. The current working directory of the
3849 subprocess is `default-directory'.
3851 File names in INFILE and BUFFER are handled normally, but file
3852 names in ARGS should be relative to `default-directory', as they
3853 are passed to the process verbatim. (This is a difference to
3854 `call-process' which does not support file handlers for INFILE
3855 and BUFFER.)
3857 Some file handlers might not support all variants, for example
3858 they might behave as if DISPLAY was nil, regardless of the actual
3859 value passed."
3861 lc stderr-file)
3871 display args)
3877 "Whether a call of `process-file' changes remote files.
3879 By default, this variable is always set to t, meaning that a
3880 call of `process-file' could potentially change any file on a
3881 remote host. When set to nil, a file handler could optimize
3882 its behavior with respect to remote file attribute caching.
3884 You should only ever change this variable with a let-binding;
3888 "Start a program in a subprocess. Return the process object for it.
3890 Similar to `start-process', but may invoke a file handler based on
3891 `default-directory'. See Info node `(elisp)Magic File Names'.
3893 This handler ought to run PROGRAM, perhaps on the local host,
3894 perhaps on a remote host that corresponds to `default-directory'.
3895 In the latter case, the local part of `default-directory' becomes
3896 the working directory of the process.
3898 PROGRAM and PROGRAM-ARGS might be file names. They are not
3899 objects of file handler invocation. File handlers might not
3900 support pty association, if PROGRAM is nil."
3904 \f
3905 ;;;; Process menu
3919 map))
3922 "Major mode for listing the processes called by Emacs."
3934 "Kill process at point in a `list-processes' buffer."
3945 "Recompute the list of processes for the Process List buffer.
3946 Also, delete any process that is exited or signaled."
3960 face link
3962 "Visit buffer `%s'"
3964 follow-link t
3965 process-buffer ,buf
3966 action process-menu-visit-buffer)
3975 "datagram"
3992 tabulated-list-entries)))))
3999 "Display a list of all processes that are Emacs sub-processes.
4000 If optional argument QUERY-ONLY is non-nil, only processes with
4001 the query-on-exit flag set are listed.
4002 Any process listed as exited or signaled is actually eliminated
4003 after the listing is made.
4004 Optional argument BUFFER specifies a buffer to use, instead of
4006 The return value is always nil.
4008 This function lists only processes that were launched by Emacs. To
4009 see other processes running on the system, use `list-system-processes'."
4021 nil)
4022 \f
4023 ;;;; Prefix commands
4029 ;; BEWARE: Called directly from C code.
4030 ;; If the return value is non-nil, it means we are in the middle of
4031 ;; a command with prefix, such as a command invoked with prefix-arg.
4033 prefix-command--last-echo
4042 "Abnormal hook which constructs the description of the current prefix state.
4046 "Update state of prefix commands.
4054 "Pass the current prefix command state to the next command.
4055 Should be called by all prefix commands.
4056 Runs `prefix-command-preserve-state-hook'."
4058 ;; If the current command is a prefix command, we don't want the next (real)
4059 ;; command to have `last-command' set to, say, `universal-argument'.
4066 nil)
4068 ;;;;; The main prefix command.
4070 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
4095 ;; For backward compatibility, minus with no modifiers is an ordinary
4096 ;; command if digits have already been entered.
4126 map)
4134 "Begin a numeric argument for the following command.
4139 multiplies the argument by 4 each time.
4141 which is different in effect from any particular numeric argument.
4149 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
4150 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
4157 arg)))
4161 "Begin a negative numeric argument for the next command.
4171 "Part of the numeric argument for the next command.
4176 last-command-event
4183 ;; Treat -0 as just -, so that -01 will work.
4186 digit))))
4188 \f
4191 "This variable is a wrapper hook around `buffer-substring--filter'.
4197 "Function to perform the filtering in `filter-buffer-substring'.
4198 The function is called with the same 3 arguments (BEG END DELETE)
4199 that `filter-buffer-substring' received. It should return the
4200 buffer substring between BEG and END, after filtering. If DELETE is
4204 "List of filter functions for `buffer-substring--filter'.
4205 Each function must accept a single argument, a string, and return a string.
4206 The buffer substring is passed to the first function in the list,
4207 and the return value of each function is passed to the next.
4208 As a special convention, point is set to the start of the buffer text
4209 being operated on (i.e., the first argument of `buffer-substring--filter')
4215 "Return the buffer substring between BEG and END, after filtering.
4216 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4218 This calls the function that `filter-buffer-substring-function' specifies
4219 \(passing the same three arguments that it received) to do the work,
4220 and returns whatever it does. The default function does no filtering,
4221 unless a hook has been set.
4223 Use `filter-buffer-substring' instead of `buffer-substring',
4224 `buffer-substring-no-properties', or `delete-and-extract-region' when
4225 you want to allow filtering to take place. For example, major or minor
4226 modes can use `filter-buffer-substring-function' to extract characters
4227 that are special to a buffer, and should not be copied into other buffers."
4231 "Default function to use for `filter-buffer-substring-function'.
4232 Its arguments and return value are as specified for `filter-buffer-substring'.
4233 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4234 \(see `with-wrapper-hook' for details about wrapper hooks),
4235 and the abnormal hook `buffer-substring-filters'.
4236 No filtering is done unless a hook says to."
4247 string)))
4252 ;;;; Window system cut and paste hooks.
4255 "Function to call to make a killed region available to other programs.
4256 Most window systems provide a facility for cutting and pasting
4257 text between different programs, such as the clipboard on X and
4258 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4260 This variable holds a function that Emacs calls whenever text is
4261 put in the kill ring, to make the new kill available to other
4262 programs. The function takes one argument, TEXT, which is a
4266 "Function to call to get text cut from other programs.
4267 Most window systems provide a facility for cutting and pasting
4268 text between different programs, such as the clipboard on X and
4269 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4271 This variable holds a function that Emacs calls to obtain text
4272 that other programs have provided for pasting. The function is
4273 called with no arguments. If no other program has provided text
4274 to paste, the function should return nil (in which case the
4275 caller, usually `current-kill', should use the top of the Emacs
4276 kill ring). If another program has provided text to paste, the
4277 function should return that text as a string (in which case the
4278 caller should put this string in the kill ring as the latest
4279 kill).
4281 The function may also return a list of strings if the window
4282 system supports multiple selections. The first string will be
4283 used as the pasted text, but the other will be placed in the kill
4284 ring for easy access via `yank-pop'.
4286 Note that the function should return a string only if a program
4287 other than Emacs has provided a string for pasting; if Emacs
4288 provided the most recent string, the function should return nil.
4289 If it is difficult to tell whether Emacs or some other program
4290 provided the current string, it is probably good enough to return
4291 nil if the string is equal (according to `string=') to the last
4293 \f
4296 ;;;; The kill ring data structure.
4299 "List of killed text sequences.
4300 Since the kill ring is supposed to interact nicely with cut-and-paste
4301 facilities offered by window systems, use of this variable should
4302 interact nicely with `interprogram-cut-function' and
4303 `interprogram-paste-function'. The functions `kill-new',
4304 `kill-append', and `current-kill' are supposed to implement this
4305 interaction; you may want to use them instead of manipulating the kill
4309 "Maximum length of kill ring before oldest elements are thrown away."
4317 "Save clipboard strings into kill ring before replacing them.
4318 When one selects something in another program to paste it into Emacs,
4319 but kills something in Emacs before actually pasting it,
4320 this selection is gone unless this variable is non-nil,
4321 in which case the other program's selection is saved in the `kill-ring'
4328 "Do not add a new string to `kill-ring' if it duplicates the last one.
4329 The comparison is done using `equal-including-properties'."
4335 "Make STRING the latest kill in the kill ring.
4336 Set `kill-ring-yank-pointer' to point to it.
4337 If `interprogram-cut-function' is non-nil, apply it to STRING.
4338 Optional second argument REPLACE non-nil means that STRING will replace
4339 the front of the kill ring, rather than being added to the list.
4341 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4342 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4343 STRING.
4345 When the yank handler has a non-nil PARAM element, the original STRING
4346 argument is not used by `insert-for-yank'. However, since Lisp code
4347 may access and use elements from the kill ring directly, the STRING
4350 ;; Due to text properties such as 'yank-handler that
4351 ;; can alter the contents to yank, comparison using
4352 ;; `equal' is unsafe.
4377 ;; It has been argued that this should work similar to `self-insert-command'
4378 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4380 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4386 "Append STRING to the end of the latest kill in the kill ring.
4387 If BEFORE-P is non-nil, prepend STRING to the kill.
4388 Also removes the last undo boundary in the current buffer,
4389 depending on `kill-append-merge-undo'.
4390 If `interprogram-cut-function' is set, pass the resulting kill to it."
4398 ;; find the next undo boundary
4402 ;; remove this undo boundary
4407 "Whether rotating the kill ring changes the window system selection.
4408 If non-nil, whenever the kill ring is rotated (usually via the
4409 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4410 to copy the new kill to the window system selection."
4416 "Rotate the yanking point by N places, and then return that kill.
4417 If N is zero and `interprogram-paste-function' is set to a
4418 function that returns a string or a list of strings, and if that
4419 function doesn't return nil, then that string (or list) is added
4420 to the front of the kill ring and the string (or first string in
4421 the list) is returned as the latest kill.
4423 If N is not zero, and if `yank-pop-change-selection' is
4424 non-nil, use `interprogram-cut-function' to transfer the
4425 kill at the new yank point into the window system selection.
4427 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4428 move the yanking point; just return the Nth kill forward."
4431 interprogram-paste-function
4435 ;; Disable the interprogram cut function when we add the new
4436 ;; text to the kill ring, so Emacs doesn't try to own the
4437 ;; selection, with identical text.
4447 kill-ring)))
4452 interprogram-cut-function)
4458 ;;;; Commands for manipulating the kill ring.
4461 "Non-nil means don't signal an error for killing read-only text."
4467 This deletes the text from the buffer and saves it in the kill ring.
4471 If you want to append the killed region to the last killed text,
4475 If the previous command was also a kill command,
4476 the text killed this time appends to the text killed last time
4477 to make one entry in the kill ring.
4479 The killed text is filtered by `filter-buffer-substring' before it is
4480 saved in the kill ring, so the actual saved text might be different
4481 from what was killed.
4483 If the buffer is read-only, Emacs will beep and refrain from deleting
4484 the text, but put the text in the kill ring anyway. This means that
4485 you can use the killing commands to copy text from a read-only buffer.
4487 Lisp programs should use this function for killing text.
4488 (To delete text, use `delete-region'.)
4489 Supply two arguments, character positions BEG and END indicating the
4490 stretch of text to be killed. If the optional argument REGION is
4491 non-nil, the function ignores BEG and END, and kills the current
4492 region instead."
4493 ;; Pass mark first, then point, because the order matters when
4494 ;; calling `kill-append'.
4503 ;; Add that string to the kill ring, one way or another.
4510 nil)
4512 ;; The code above failed because the buffer, or some of the characters
4513 ;; in the region, are read-only.
4514 ;; We should beep, in case the user just isn't aware of this.
4515 ;; However, there's no harm in putting
4516 ;; the region's text in the kill ring, anyway.
4518 ;; Set this-command now, so it will be set even if we get an error.
4520 ;; This should barf, if appropriate, and give us the correct error.
4523 ;; Signal an error if the buffer is read-only.
4525 ;; If the buffer isn't read-only, the text is.
4528 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4529 ;; to get two copies of the text when the user accidentally types M-w and
4530 ;; then corrects it with the intended C-w.
4532 "Save the region as if killed, but don't kill it.
4533 In Transient Mark mode, deactivate the mark.
4534 If `interprogram-cut-function' is non-nil, also save the text for a window
4535 system cut and paste.
4537 The copied text is filtered by `filter-buffer-substring' before it is
4538 saved in the kill ring, so the actual saved text might be different
4539 from what was in the buffer.
4541 When called from Lisp, save in the kill ring the stretch of text
4542 between BEG and END, unless the optional argument REGION is
4543 non-nil, in which case ignore BEG and END, and save the current
4544 region instead.
4546 This command's old key binding has been given to `kill-ring-save'."
4547 ;; Pass mark first, then point, because the order matters when
4548 ;; calling `kill-append'.
4558 nil)
4561 "Save the region as if killed, but don't kill it.
4562 In Transient Mark mode, deactivate the mark.
4563 If `interprogram-cut-function' is non-nil, also save the text for a window
4564 system cut and paste.
4566 If you want to append the killed line to the last killed text,
4569 The copied text is filtered by `filter-buffer-substring' before it is
4570 saved in the kill ring, so the actual saved text might be different
4571 from what was in the buffer.
4573 When called from Lisp, save in the kill ring the stretch of text
4574 between BEG and END, unless the optional argument REGION is
4575 non-nil, in which case ignore BEG and END, and save the current
4576 region instead.
4578 This command is similar to `copy-region-as-kill', except that it gives
4579 visual feedback indicating the extent of the region being copied."
4580 ;; Pass mark first, then point, because the order matters when
4581 ;; calling `kill-append'.
4585 ;; This use of called-interactively-p is correct because the code it
4586 ;; controls just gives the user visual feedback.
4591 "Indicate that the region text has been copied interactively.
4592 If the mark is visible in the selected window, blink the cursor
4593 between point and mark if there is currently no active region
4594 highlighting.
4596 If the mark lies outside the selected window, display an
4597 informative message containing a sample of the copied text. The
4598 optional argument MESSAGE-LEN, if non-nil, specifies the length
4599 of this sample text; it defaults to 40."
4602 ;; Inhibit quitting so we can make a quit here
4603 ;; look like a C-g typed as a command.
4606 ;; Swap point-and-mark quickly so as to show the region that
4607 ;; was selected. Don't do it if the region is highlighted.
4610 ;; Swap point and mark.
4614 ;; Swap back.
4617 ;; If user quit, deactivate the mark
4618 ;; as C-g would as a command.
4624 ;; Don't say "killed"; that is misleading.
4631 "Cause following command, if it kills, to add to previous kill.
4632 If the next command kills forward from point, the kill is
4633 appended to the previous killed text. If the command kills
4634 backward, the kill is prepended. Kill commands that act on the
4635 region, such as `kill-region', are regarded as killing forward if
4636 point is after mark, and killing backward if point is before
4637 mark.
4639 If the next command is not a kill command, `append-next-kill' has
4640 no effect.
4642 The argument is used for internal purposes; do not supply one."
4644 ;; We don't use (interactive-p), since that breaks kbd macros.
4658 "A subroutine of `squeeze-bidi-context'.
4659 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4663 lim1)
4670 ;; L and R categories include embedding and
4671 ;; override controls, but we don't want to
4672 ;; replace them, because that might change
4673 ;; the visual order. Likewise with PDF and
4674 ;; isolate controls.
4676 bidi-directional-non-controls-chars
4677 limit)))))
4678 ;; Replace any run of non-RTL characters by a single LRM.
4680 ;; No more characters of CATEGORY, we are done.
4685 ;; Skip directional controls, if any.
4690 "Replace characters between FROM and TO while keeping bidi context.
4692 This function replaces the region of text with as few characters
4693 as possible, while preserving the effect that region will have on
4694 bidirectional display before and after the region."
4698 ;; This is for when they copy text with read-only text
4699 ;; properties.
4703 ;; Replace each run of non-RTL characters with a single LRM.
4705 ;; Replace each run of non-LTR characters with a single RLM. Note
4706 ;; that the \cR category includes both the Arabic Letter (AL) and
4707 ;; R characters; here we ignore the distinction between them,
4708 ;; because that distinction only affects Arabic Number (AN)
4709 ;; characters, which are weak and don't affect the reordering.
4713 "Return buffer text between START and END with its bidi context.
4715 START and END are assumed to belong to the same physical line
4716 of buffer text. This function prepends and appends to the text
4717 between START and END bidi control characters that preserve the
4718 visual order of that text when it is inserted at some other place."
4723 substr para-dir from to)
4730 ;; If we don't have any mixed directional characters in the
4731 ;; entire line, we can just copy the substring without adding
4732 ;; any context.
4747 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4748 ;; (1) force the string to have the same base embedding
4749 ;; direction as the paragraph direction at the source, no matter
4750 ;; what is the paragraph direction at destination; and (2) avoid
4751 ;; affecting the visual order of the surrounding text at
4752 ;; destination if there are characters of different
4753 ;; directionality there.
4758 "Return portion of current buffer between START and END with bidi context.
4760 This function works similar to `buffer-substring', but it prepends and
4761 appends to the text bidi directional control characters necessary to
4762 preserve the visual appearance of the text if it is inserted at another
4763 place. This is useful when the buffer substring includes bidirectional
4764 text and control characters that cause non-trivial reordering on display.
4765 If copied verbatim, such text can have a very different visual appearance,
4766 and can also change the visual appearance of the surrounding text at the
4767 destination of the copy.
4769 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4770 the text properties."
4783 no-properties)))
4787 substr)))
4788 \f
4789 ;; Yanking.
4794 "List of special text property handling conditions for yanking.
4795 Each element should have the form (PROP . FUN), where PROP is a
4796 property symbol and FUN is a function. When the `yank' command
4797 inserts text into the buffer, it scans the inserted text for
4798 stretches of text that have `eq' values of the text property
4799 PROP; for each such stretch of text, FUN is called with three
4800 arguments: the property's value in that text, and the start and
4801 end positions of the text.
4803 This is done prior to removing the properties specified by
4804 `yank-excluded-properties'."
4807 function))
4810 ;; This is actually used in subr.el but defcustom does not work there.
4813 intangible invisible keymap local-map mouse-face read-only
4814 yank-handler)
4815 "Text properties to discard when yanking.
4816 The value should be a list of text properties to discard or t,
4817 which means to discard all text properties.
4819 See also `yank-handled-properties'."
4826 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4827 Function is called with two parameters, START and END corresponding to
4828 the value of the mark and point; it is guaranteed that START <= END.
4832 "Replace just-yanked stretch of killed text with a different stretch.
4833 This command is allowed only immediately after a `yank' or a `yank-pop'.
4834 At such a time, the region contains a stretch of reinserted
4835 previously-killed text. `yank-pop' deletes that text and inserts in its
4836 place a different stretch of killed text.
4838 With no argument, the previous kill is inserted.
4839 With argument N, insert the Nth previous kill.
4840 If N is negative, this is a more recent kill.
4842 The sequence of kills wraps around, so that after the oldest one
4843 comes the newest one.
4845 This command honors the `yank-handled-properties' and
4846 `yank-excluded-properties' variables, and the `yank-handler' text
4847 property, in the way that `yank' does."
4861 ;; Set the window start back where it was in the yank command,
4862 ;; if possible.
4865 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4866 ;; It is cleaner to avoid activation, even though the command
4867 ;; loop would deactivate the mark because we inserted text.
4870 nil)
4874 More precisely, reinsert the most recent kill, which is the
4875 stretch of killed text most recently killed OR yanked. Put point
4876 at the end, and set mark at the beginning without activating it.
4878 With argument N, reinsert the Nth most recent kill.
4880 This command honors the `yank-handled-properties' and
4881 `yank-excluded-properties' variables, and the `yank-handler' text
4882 property, as described below.
4884 Properties listed in `yank-handled-properties' are processed,
4885 then those listed in `yank-excluded-properties' are discarded.
4887 If STRING has a non-nil `yank-handler' property anywhere, the
4888 normal insert behavior is altered, and instead, for each contiguous
4889 segment of STRING that has a given value of the `yank-handler'
4890 property, that value is used as follows:
4892 The value of a `yank-handler' property must be a list of one to four
4893 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
4894 FUNCTION, if non-nil, should be a function of one argument (the
4895 object to insert); FUNCTION is called instead of `insert'.
4896 PARAM, if present and non-nil, is passed to FUNCTION (to be handled
4897 in whatever way is appropriate; e.g. if FUNCTION is `yank-rectangle',
4898 PARAM may be a list of strings to insert as a rectangle). If PARAM
4899 is nil, then the current segment of STRING is used.
4900 If NOEXCLUDE is present and non-nil, the normal removal of
4901 `yank-excluded-properties' is not performed; instead FUNCTION is
4902 responsible for the removal. This may be necessary if FUNCTION
4903 adjusts point before or after inserting the object.
4904 UNDO, if present and non-nil, should be a function to be called
4905 by `yank-pop' to undo the insertion of the current PARAM. It is
4906 given two arguments, the start and end of the region. FUNCTION
4907 may set `yank-undo-function' to override UNDO.
4912 ;; If we don't get all the way thru, make last-command indicate that
4913 ;; for the following command.
4921 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4922 ;; It is cleaner to avoid activation, even though the command
4923 ;; loop would deactivate the mark because we inserted text.
4926 ;; If we do get all the way thru, make this-command indicate that.
4929 nil)
4932 "Rotate the yanking point in the kill ring.
4933 With ARG, rotate that many kills forward (or backward, if negative)."
4936 \f
4937 ;; Some kill commands.
4939 ;; Internal subroutine of delete-char
4945 ;; Internal subroutine of backward-delete-char
4952 "The method for untabifying when deleting backward.
4953 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4954 `hungry' -- delete all whitespace, both tabs and spaces;
4955 `all' -- delete all whitespace, including tabs, spaces and newlines;
4956 nil -- just delete one character."
4962 "Delete characters backward, changing tabs into spaces.
4963 The exact behavior depends on `backward-delete-char-untabify-method'.
4964 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4965 Interactively, ARG is the prefix arg (default 1)
4966 and KILLP is t if a prefix arg was specified."
4989 arg)))
4990 ;; Avoid warning about delete-backward-char
4994 "Kill up to and including ARGth occurrence of CHAR.
4995 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4996 Goes backward if ARG is negative; error if CHAR not found."
4999 ;; Avoid "obsolete" warnings for translation-table-for-input.
5007 ;; kill-line and its subroutines.
5010 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
5015 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
5016 With prefix argument ARG, kill that many lines from point.
5017 Negative arguments kill lines backward.
5018 With zero argument, kills the text before point on the current line.
5021 a number counts as a prefix arg.
5023 To kill a whole line, when point is not at the beginning, type \
5026 If `show-trailing-whitespace' is non-nil, this command will just
5027 kill the rest of the current line, even if there are no nonblanks
5028 there.
5030 If option `kill-whole-line' is non-nil, then this command kills the whole line
5031 including its terminating newline, when used at the beginning of a line
5032 with no argument. As a consequence, you can always kill a whole line
5035 If you want to append the killed line to the last killed text,
5038 If the buffer is read-only, Emacs will beep and refrain from deleting
5039 the line, but put the line in the kill ring anyway. This means that
5040 you can use this command to copy text from a read-only buffer.
5041 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5042 even beep.)"
5045 ;; It is better to move point to the other end of the kill
5046 ;; before killing. That way, in a read-only buffer, point
5047 ;; moves across the text that is copied to the kill ring.
5048 ;; The choice has no effect on undo now that undo records
5049 ;; the value of point from before the command was run.
5059 ;; If trailing whitespace is visible,
5060 ;; don't treat it as nothing.
5070 "Kill current line.
5071 With prefix ARG, kill that many lines starting from the current line.
5072 If ARG is negative, kill backward. Also kill the preceding newline.
5074 If ARG is zero, kill current line but exclude the trailing newline."
5085 ;; We need to kill in two steps, because the previous command
5086 ;; could have been a kill command, in which case the text
5087 ;; before point needs to be prepended to the current kill
5088 ;; ring entry and the text after point appended. Also, we
5089 ;; need to use save-excursion to avoid copying the same text
5090 ;; twice to the kill ring in read-only buffers.
5108 "Move forward by ARG lines, ignoring currently invisible newlines only.
5109 If ARG is negative, move backward -ARG lines.
5110 If ARG is zero, move to the beginning of the current line."
5117 ;; If the newline we just skipped is invisible,
5118 ;; don't count it.
5122 prop
5127 ;; If invisible text follows, and it is a number of complete lines,
5128 ;; skip it.
5134 prop
5150 ;; If the newline we just moved to is invisible,
5151 ;; don't count it.
5156 prop
5161 ;; If invisible text follows, and it is a number of complete lines,
5162 ;; skip it.
5168 prop
5179 nil)))
5182 "Move to end of current visible line."
5184 ;; If the following character is currently invisible,
5185 ;; skip all characters with that same `invisible' property value,
5186 ;; then find the next newline.
5193 prop
5204 "Kill the current buffer.
5205 When called in the minibuffer, get out of the minibuffer
5206 using `abort-recursive-edit'.
5208 This is like `kill-this-buffer', but it doesn't have to be invoked
5209 via the menu bar, and pays no attention to the menu-bar's frame."
5217 \f
5219 "Insert after point the contents of BUFFER.
5220 Puts mark after the inserted text.
5221 BUFFER may be a buffer or a buffer name."
5231 t))))
5236 nil)
5239 "Append to specified buffer the text of the region.
5240 It is inserted into that buffer before its point.
5242 When calling from a program, give three arguments:
5243 BUFFER (or buffer name), START and END.
5244 START and END specify the portion of the current buffer to be copied."
5251 point)
5262 "Prepend to specified buffer the text of the region.
5263 It is inserted into that buffer after its point.
5265 When calling from a program, give three arguments:
5266 BUFFER (or buffer name), START and END.
5267 START and END specify the portion of the current buffer to be copied."
5276 "Copy to specified buffer the text of the region.
5277 It is inserted into that buffer, replacing existing text there.
5279 When calling from a program, give three arguments:
5280 BUFFER (or buffer name), START and END.
5281 START and END specify the portion of the current buffer to be copied."
5289 \f
5293 "Hook run when the mark becomes active.
5294 It is also run at the end of a command, if the mark is active and
5301 "Return this buffer's mark value as integer, or nil if never set.
5303 In Transient Mark mode, this function signals an error if
5304 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5305 or the argument FORCE is non-nil, it disregards whether the mark
5306 is active, and returns an integer or nil in the usual way.
5308 If you are using this in an editing command, you are most likely making
5309 a mistake; see the documentation of `set-mark'."
5314 ;; Behind display-selections-p.
5317 "Deactivate the mark.
5318 If Transient Mark mode is disabled, this function normally does
5319 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5321 Deactivating the mark sets `mark-active' to nil, updates the
5322 primary selection according to `select-active-regions', and runs
5323 `deactivate-mark-hook'.
5325 If Transient Mark mode was temporarily enabled, reset the value
5326 of the variable `transient-mark-mode'; if this causes Transient
5327 Mark mode to be disabled, don't change `mark-active' to nil or
5328 run `deactivate-mark-hook'."
5332 select-active-regions)
5335 ;; The var `saved-region-selection', if non-nil, is the text in
5336 ;; the region prior to the last command modifying the buffer.
5337 ;; Set the selection to that, or to the current region.
5342 ;; If another program has acquired the selection, region
5343 ;; deactivation should not clobber it (Bug#11772).
5362 "Activate the mark.
5363 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5373 "Set this buffer's mark to POS. Don't use this function!
5374 That is to say, don't use this function unless you want
5375 the user to see that the mark has moved, and you want the previous
5376 mark position to be lost.
5378 Normally, when a new mark is set, the old one should go on the stack.
5379 This is why most applications should use `push-mark', not `set-mark'.
5381 Novice Emacs Lisp programmers often try to use the mark for the wrong
5382 purposes. The mark saves a location for the user's convenience.
5383 Most editing commands should not alter the mark.
5384 To remember a location for internal use in the Lisp program,
5385 store it in a Lisp variable. Example:
5387 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5392 ;; Normally we never clear mark-active except in Transient Mark mode.
5393 ;; But when we actually clear out the mark value too, we must
5394 ;; clear mark-active in any mode.
5396 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5397 ;; it should never be nil if the mark is nil.
5405 mark-active))
5412 ;; Mark marker
5418 ;; Mark active
5421 ;; If mark is active now, and either was not active or was at a
5422 ;; different place, run the activate hook.
5427 ;; If mark has ceased to be active, run deactivate hook.
5432 "Like `save-excursion', but also save and restore the mark state.
5433 This macro does what `save-excursion' did before Emacs 25.1."
5443 If nil, region-aware commands treat the empty region as inactive.
5444 If non-nil, region-aware commands treat the region as active as
5445 long as the mark is active, even if the region is empty.
5447 Region-aware commands are those that act on the region if it is
5448 active and Transient Mark mode is enabled, and on the text near
5449 point otherwise."
5455 "Return t if the region is active and it is appropriate to act on it.
5456 This is used by commands that act specially on the region under
5457 Transient Mark mode.
5459 The return value is t if Transient Mark mode is enabled and the
5460 mark is active; furthermore, if `use-empty-active-region' is nil,
5461 the region must not be empty. Otherwise, the return value is nil.
5463 For some commands, it may be appropriate to ignore the value of
5464 `use-empty-active-region'; in that case, use `region-active-p'."
5469 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5471 Some commands act specially on the region when Transient Mark
5472 mode is enabled. Usually, such commands should use
5473 `use-region-p' instead of this function, because `use-region-p'
5474 also checks the value of `use-empty-active-region'."
5476 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5477 ;; without the mark being set (e.g. bug#17324). We really should fix
5478 ;; that problem, but in the mean time, let's make sure we don't say the
5479 ;; region is active when there's no mark.
5483 "Return the boundaries of the region as a list of (START . END) positions."
5487 "Return non-nil if the region contains several pieces.
5488 An example is a rectangular region handled as a list of
5489 separate contiguous regions for each line."
5502 ;; Normal priority so that a large region doesn't hide all the
5503 ;; overlays within it, but high secondary priority so that if it
5504 ;; ends/starts in the middle of a small overlay, that small overlay
5505 ;; won't hide the region's boundaries.
5507 nrol)
5512 rol)))
5528 start end window rol)))
5531 new))))))
5534 "Hook run just before redisplay.
5535 It is called in each window that is to be redisplayed. It takes one argument,
5536 which is the window that will be redisplayed. When run, the `current-buffer'
5557 "Maximum size of mark ring. Start discarding off end if gets this big."
5565 "Maximum size of global mark ring. \
5566 Start discarding off end if gets this big."
5571 "Jump to mark, and pop a new position for mark off the ring.
5572 \(Does not affect global mark ring)."
5582 "Set mark at where point is.
5583 If no prefix ARG and mark is already set there, just activate it.
5584 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5596 will pop the mark twice, and
5598 will pop the mark three times.
5606 "Set the mark where point is, and activate it; or jump to the mark.
5607 Setting the mark also alters the region, which is the text
5608 between point and mark; this is the closest equivalent in
5611 With no prefix argument, set the mark at point, and push the
5612 old mark position on local mark ring. Also push the new mark on
5613 global mark ring, if the previous mark was set in another buffer.
5615 When Transient Mark Mode is off, immediately repeating this
5616 command activates `transient-mark-mode' temporarily.
5619 jump to the mark, and set the mark from
5620 position popped off the local mark ring (this does not affect the global
5622 mark ring (see `pop-global-mark').
5624 If `set-mark-command-repeat-pop' is non-nil, repeating
5626 off the local (or global) mark ring and jumps there.
5629 argument, unconditionally set mark where point is, even if
5630 `set-mark-command-repeat-pop' is non-nil.
5632 Novice Emacs Lisp programmers often try to use the mark for the wrong
5633 purposes. See the documentation of `set-mark' for more information."
5653 arg)
5667 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5668 If the last global mark pushed was not in the current buffer,
5669 also push LOCATION on the global mark ring.
5670 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5672 Novice Emacs Lisp programmers often try to use the mark for the wrong
5673 purposes. See the documentation of `set-mark' for more information.
5675 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5682 ;; Now push the mark on the global mark ring.
5685 ;; The last global mark pushed was in this same buffer.
5686 ;; Don't push another one.
5687 nil
5696 nil)
5699 "Pop off mark ring into the buffer's actual mark.
5700 Does not set point. Does nothing if mark ring is empty."
5712 "Put the mark where point is now, and point where the mark is now.
5713 This command works even when the mark is not active,
5714 and it reactivates the mark.
5716 If Transient Mark mode is on, a prefix ARG deactivates the mark
5717 if it is active, and otherwise avoids reactivating it. If
5718 Transient Mark mode is off, a prefix ARG enables Transient Mark
5719 mode temporarily."
5733 nil))
5736 "When non-nil, shifted motion keys activate the mark momentarily.
5738 While the mark is activated in this way, any shift-translated point
5739 motion key extends the region, and if Transient Mark mode was off, it
5740 is temporarily turned on. Furthermore, the mark will be deactivated
5741 by any subsequent point motion key that was not shift-translated, or
5742 by any action that normally deactivates the mark in Transient Mark mode.
5744 See `this-command-keys-shift-translated' for the meaning of
5745 shift-translation."
5750 "Activate/deactivate mark depending on invocation thru shift translation.
5751 This function is called by `call-interactively' when a command
5752 with a `^' character in its `interactive' spec is invoked, before
5753 running the command itself.
5755 If `shift-select-mode' is enabled and the command was invoked
5756 through shift translation, set the mark and activate the region
5757 temporarily, unless it was already set in this way. See
5758 `this-command-keys-shift-translated' for the meaning of shift
5759 translation.
5761 Otherwise, if the region has been activated temporarily,
5762 deactivate it, and restore the variable `transient-mark-mode' to
5763 its earlier value."
5770 transient-mark-mode)))
5779 "Toggle Transient Mark mode.
5780 With a prefix argument ARG, enable Transient Mark mode if ARG is
5781 positive, and disable it otherwise. If called from Lisp, enable
5782 Transient Mark mode if ARG is omitted or nil.
5784 Transient Mark mode is a global minor mode. When enabled, the
5785 region is highlighted with the `region' face whenever the mark
5787 and after certain other operations that set the mark but whose
5788 main purpose is something else--for example, incremental search,
5794 Many commands change their behavior when Transient Mark mode is
5795 in effect and the mark is active, by acting on the region instead
5796 of their usual default part of the buffer's text. Examples of
5799 To see the documentation of commands which are sensitive to the
5802 :global t
5803 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5807 "Non-nil means it is ok for commands to call `widen' when they want to.
5808 Some commands will do this in order to go to positions outside
5809 the current accessible part of the buffer.
5811 If `widen-automatically' is nil, these commands will do something else
5815 "Whether the currently executing code is performing an essential task.
5816 This variable should be non-nil only when running code which should not
5817 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5818 user for a password when we are simply scanning a set of files in the
5819 background or displaying possible completions before the user even asked
5823 "Pop off global mark ring and jump to the top location."
5825 ;; Pop entries which refer to non-existent buffers.
5843 \f
5845 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5851 "Move cursor vertically down ARG lines.
5852 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5853 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5854 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5855 function will not vscroll.
5857 ARG defaults to 1.
5859 If there is no character in the target line exactly under the current column,
5860 the cursor is positioned after the character in that line which spans this
5861 column, or at the end of the line if it is not long enough.
5862 If there is no line in the buffer after this one, behavior depends on the
5863 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5864 to create a line, and moves the cursor to that line. Otherwise it moves the
5865 cursor to the end of the buffer.
5867 If the variable `line-move-visual' is non-nil, this command moves
5868 by display lines. Otherwise, it moves by buffer lines, without
5869 taking variable-width characters or continued lines into account.
5873 a semipermanent goal column for this command.
5874 Then instead of trying to move exactly vertically (or as close as possible),
5875 this command moves to the specified goal column (or as close as possible).
5876 The goal column is stored in the variable `goal-column', which is nil
5877 when there is no goal column. Note that setting `goal-column'
5878 overrides `line-move-visual' and causes this command to move by buffer
5879 lines rather than by display lines."
5885 ;; When adding a newline, don't expand an abbrev.
5896 nil)
5899 "Move cursor vertically up ARG lines.
5900 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5901 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5902 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5903 function will not vscroll.
5905 ARG defaults to 1.
5907 If there is no character in the target line exactly over the current column,
5908 the cursor is positioned after the character in that line which spans this
5909 column, or at the end of the line if it is not long enough.
5911 If the variable `line-move-visual' is non-nil, this command moves
5912 by display lines. Otherwise, it moves by buffer lines, without
5913 taking variable-width characters or continued lines into account.
5917 a semipermanent goal column for this command.
5918 Then instead of trying to move exactly vertically (or as close as possible),
5919 this command moves to the specified goal column (or as close as possible).
5920 The goal column is stored in the variable `goal-column', which is nil
5921 when there is no goal column. Note that setting `goal-column'
5922 overrides `line-move-visual' and causes this command to move by buffer
5923 lines rather than by display lines."
5934 nil)
5937 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5938 This means moving to the end of each line moved onto.
5939 The beginning of a blank line does not count as the end of a line.
5940 This has no effect when the variable `line-move-visual' is non-nil."
5946 A non-nil setting overrides the variable `line-move-visual', which see."
5953 "Current goal column for vertical motion.
5954 It is the column where point was at the start of the current run
5955 of vertical motion commands.
5957 When moving by visual lines via the function `line-move-visual', it is a cons
5958 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5959 divided by the default column width, and HSCROLL is the number of
5960 columns by which window is scrolled from left margin.
5962 When the `track-eol' feature is doing its job, the value is
5966 "Last value of width used for displaying line numbers.
5970 "Non-nil means commands that move by lines ignore invisible newlines.
5971 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5972 as if newlines that are invisible didn't exist, and count
5973 only visible newlines. Thus, moving across across 2 newlines
5974 one of which is invisible will be counted as a one-line move.
5975 Also, a non-nil value causes invisible text to be ignored when
5976 counting columns for the purposes of keeping point in the same
5979 Outline mode sets this."
5984 "When non-nil, `line-move' moves point by visual lines.
5985 This movement is based on where the cursor is displayed on the
5986 screen, instead of relying on buffer contents alone. It takes
5987 into account variable-width characters and line continuation.
5988 If nil, `line-move' moves point by logical lines.
5989 A non-nil setting of `goal-column' overrides the value of this variable
5990 and forces movement by logical lines.
5991 A window that is horizontally scrolled also forces movement by logical
5992 lines."
5997 ;; Only used if display-graphic-p.
6001 "Return the height in pixels of the current buffer's default face font.
6003 If the default font is remapped (see `face-remapping-alist'), the
6004 function returns the height of the remapped face."
6008 ;; Avoid calling font-info if the frame's default font was
6009 ;; not changed since the frame was created. That's because
6010 ;; font-info is expensive for some fonts, see bug #14838.
6016 "Return the width in pixels of the current buffer's default face font.
6018 If the default font is remapped (see `face-remapping-alist'), the
6019 function returns the width of the remapped face."
6023 ;; Avoid calling font-info if the frame's default font was
6024 ;; not changed since the frame was created. That's because
6025 ;; font-info is expensive for some fonts, see bug #14838.
6030 width
6035 "Return the pixel height of current buffer's default-face text line.
6037 The value includes `line-spacing', if any, defined for the buffer
6038 or the frame."
6051 "Return the number of screen lines in the text area of the selected window.
6053 This is different from `window-text-height' in that this function counts
6054 lines in units of the height of the font used by the default face displayed
6055 in the window, not in units of the frame's default font, and also accounts
6056 for `line-spacing', if any, defined for the window's buffer or frame.
6058 The value is a floating-point number."
6063 ;; Returns non-nil if partial move was done.
6066 ;; Move backward (up).
6067 ;; If already vscrolled, reduce vscroll
6073 ;; Move forward (down).
6086 py vs last-line)
6106 col-row)
6111 ;; VPOS > 0 means the last line is only partially visible.
6112 ;; But if the part that is visible is at least as tall as the
6113 ;; default font, that means the line is actually fully
6114 ;; readable, and something like line-spacing is hidden. So in
6115 ;; that case we accept the last line in the window as still
6116 ;; visible, and consider the margin as starting one line
6117 ;; later.
6125 ;; If last line of window is fully visible, and vscrolling
6126 ;; more would make this line invisible, move forward.
6131 nil)
6132 ;; If cursor is not in the bottom scroll margin, and the
6133 ;; current line is is not too tall, move forward.
6135 vpos
6138 nil)
6139 ;; When already vscrolled, we vscroll some more if we can,
6140 ;; or clear vscroll and move forward at end of tall image.
6145 ;; If cursor just entered the bottom scroll margin, move forward,
6146 ;; but also optionally vscroll one line so redisplay won't recenter.
6150 ;; Don't vscroll if the partially-visible line at window
6151 ;; bottom is not too tall (a.k.a. "just one more text
6152 ;; line"): in that case, we do want redisplay to behave
6153 ;; normally, i.e. recenter or whatever.
6154 ;;
6155 ;; Note: ROWH + RBOT from the value returned by
6156 ;; pos-visible-in-window-p give the total height of the
6157 ;; partially-visible glyph row at the end of the window. As
6158 ;; we are dealing with floats, we disregard sub-pixel
6159 ;; discrepancies between that and DLH.
6163 t)
6164 ;; If there are lines above the last line, scroll-up one line.
6167 t)
6168 ;; Finally, start vscroll.
6173 ;; This is like line-move-1 except that it also performs
6174 ;; vertical scrolling of tall images if appropriate.
6175 ;; That is not really a clean thing to do, since it mixes
6176 ;; scrolling with cursor motion. But so far we don't have
6177 ;; a cleaner solution to the problem of making C-n do something
6178 ;; useful given a tall image.
6180 "Move forward ARG lines.
6181 If NOERROR, don't signal an error if we can't move ARG lines.
6182 TO-END is unused.
6183 TRY-VSCROLL controls whether to vscroll tall lines: if either
6184 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6185 not vscroll."
6189 ;; Only vscroll for single line moves
6191 ;; Under scroll-conservatively, the display engine
6192 ;; does this better.
6194 ;; But don't vscroll in a keyboard macro.
6200 ;; Display-based column are incompatible with goal-column.
6202 ;; When the text in the window is scrolled to the left,
6203 ;; display-based motion doesn't make sense (because each
6204 ;; logical line occupies exactly one screen line).
6206 ;; Likewise when the text _was_ scrolled to the left
6207 ;; when the current run of vertical motion commands
6208 ;; started.
6211 auto-hscroll-mode
6213 (>= temporary-goal-column
6216 ;; If we moved into a tall line, set vscroll to make
6217 ;; scrolling through tall images more smooth.
6221 winh)
6227 nil
6231 ;; Display-based alternative to line-move-1.
6232 ;; Arg says how many lines to move. The value is t if we can move the
6233 ;; specified number of lines.
6235 "Move ARG lines forward.
6236 If NOERROR, don't signal an error if we can't move that many lines."
6240 target-hscroll)
6241 ;; Check if the previous command was a line-motion command, or if
6242 ;; we were called from some other command.
6245 ;; If so, there's no need to reset `temporary-goal-column',
6246 ;; but we may need to hscroll.
6251 ;; Update the COLUMN part of temporary-goal-column if the
6252 ;; line-number display changed its width since the last
6253 ;; time.
6260 ;; Otherwise, we should reset `temporary-goal-column'.
6262 x-pos)
6264 ;; Handle the `overflow-newline-into-fringe' case
6265 ;; (left-fringe is for the R2L case):
6270 ;; In R2L lines, the X pixel coordinate is measured from the
6271 ;; left edge of the window, but columns are still counted
6272 ;; from the logical-order beginning of the line, i.e. from
6273 ;; the right edge in this case. We need to adjust for that.
6279 hscroll)))
6281 ;; When we move beyond the first/last character visible in
6282 ;; the window, posn-at-point will return nil, so we need to
6283 ;; approximate the goal column as below.
6288 ;; vertical-motion can move more than it was asked to if it moves
6289 ;; across display strings with newlines. We don't want to ring
6290 ;; the bell and announce beginning/end of buffer in that case.
6296 temporary-goal-column))
6297 arg))
6298 arg))
6304 temporary-goal-column))
6305 arg))
6306 arg)))
6309 ;; If the goal column lies on a display string,
6310 ;; `vertical-motion' advances the cursor to the end
6311 ;; of the string. For arg < 0, this can cause the
6312 ;; cursor to get stuck. (Bug#3020).
6316 nil)))))
6318 ;; This is the guts of next-line and previous-line.
6319 ;; Arg says how many lines to move.
6320 ;; The value is t if we can move the specified number of lines.
6322 ;; Don't run any point-motion hooks, and disregard intangibility,
6323 ;; for intermediate positions.
6335 ;; Don't count beg of empty line as end of line
6336 ;; unless we just did explicit end-of-line.
6338 most-positive-fixnum
6342 line-move-ignore-invisible))
6343 ;; Use just newline characters.
6344 ;; Set ARG to 0 if we move as many lines as requested.
6347 ;; This way of moving forward ARG lines
6348 ;; verifies that we have a newline after the last one.
6349 ;; It doesn't get confused by intangible text.
6358 'beginning-of-buffer
6360 nil)))
6361 ;; Move by arg lines, but ignore invisible ones.
6364 ;; If the following character is currently invisible,
6365 ;; skip all characters with that same `invisible' property value.
6368 ;; Move a line.
6369 ;; We don't use `end-of-line', since we want to escape
6370 ;; from field boundaries occurring exactly at point.
6376 ;; If there's no invisibility here, move over the newline.
6385 ;; We avoid vertical-motion when possible
6386 ;; because that has to fontify.
6388 ;; Otherwise move a more sophisticated way.
6395 ;; The logic of this is the same as the loop above,
6396 ;; it just goes in the other direction.
6398 ;; For completely consistency with the forward-motion
6399 ;; case, we should call beginning-of-line here.
6400 ;; However, if point is inside a field and on a
6401 ;; continued line, the call to (vertical-motion -1)
6402 ;; below won't move us back far enough; then we return
6403 ;; to the same column in line-move-finish, and point
6404 ;; gets stuck -- cyd
6422 ;; if our target is the middle of this line.
6427 ;; This is the value the function returns.
6431 ;; If we did not move down as far as desired, at least go
6432 ;; to end of line. Be sure to call point-entered and
6433 ;; point-left-hooks.
6439 ;; If we did not move up as far as desired,
6440 ;; at least go to beginning of line.
6452 ;; Set REPEAT to t to repeat the whole thing.
6459 ;; Compute the end of the line
6460 ;; ignoring effectively invisible newlines.
6462 ;; Like end-of-line but ignores fields.
6469 ;; Move to the desired column.
6472 ;; Under line-move-visual, goal-column should be
6473 ;; interpreted in units of the frame's canonical character
6474 ;; width, which is exactly what vertical-motion does.
6478 ;; Corner case: suppose we start out in a field boundary in
6479 ;; the middle of a continued line. When we get to
6480 ;; line-move-finish, point is at the start of a new *screen*
6481 ;; line but the same text line; then line-move-to-column would
6482 ;; move us backwards. Test using C-n with point on the "x" in
6483 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6490 ;; Process intangibility within a line.
6491 ;; With inhibit-point-motion-hooks bound to nil, a call to
6492 ;; goto-char moves point past intangible text.
6494 ;; However, inhibit-point-motion-hooks controls both the
6495 ;; intangibility and the point-entered/point-left hooks. The
6496 ;; following hack avoids calling the point-* hooks
6497 ;; unnecessarily. Note that we move *forward* past intangible
6498 ;; text when the initial and final points are the same.
6503 ;; If intangibility moves us to a different (later) place
6504 ;; in the same line, use that as the destination.
6507 ;; If that position is "too late",
6508 ;; try the previous allowable position.
6509 ;; See if it is ok.
6512 ;; If going forward, don't accept the previous
6513 ;; allowable position if it is before the target line.
6515 ;; If going backward, don't accept the previous
6516 ;; allowable position if it is still after the target line.
6519 ;; As a last resort, use the end of the line.
6522 ;; Now move to the updated destination, processing fields
6523 ;; as well as intangibility.
6527 ;; Ignore field boundaries if the initial and final
6528 ;; positions have the same `field' property, even if the
6529 ;; fields are non-contiguous. This seems to be "nicer"
6530 ;; behavior in many situations.
6533 new
6537 ;; If all this moved us to a different line,
6538 ;; retry everything within that new line.
6540 ;; Repeat the intangibility and field processing.
6544 "Try to find column COL, considering invisibility.
6545 This function works only in certain cases,
6546 because what we really need is for `move-to-column'
6547 and `current-column' to be able to ignore invisible text."
6556 ;; If the following character is currently invisible,
6557 ;; skip all characters with that same `invisible' property value.
6561 ;; Have we advanced to a larger column position?
6563 ;; We have made some progress towards the desired column.
6564 ;; See if we can make any further progress.
6566 ;; Otherwise, go to the place we originally found
6567 ;; and move back over invisible text.
6568 ;; that will get us to the same place on the screen
6569 ;; but with a more reasonable buffer position.
6572 ;; We want the real line beginning, so it's consistent
6573 ;; with bolp below, otherwise we might infloop.
6580 "Move point to end of current line as displayed.
6581 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6582 If point reaches the beginning or end of buffer, it stops there.
6584 To ignore the effects of the `intangible' text or overlay
6585 property, bind `inhibit-point-motion-hooks' to t.
6586 If there is an image in the current line, this function
6587 disregards newlines that are part of the text on which the image
6588 rests."
6598 ;; With bidi reordering, we may not be at bol,
6599 ;; so make sure we are.
6614 ;; If we skipped something intangible and now we're not
6615 ;; really at eol, keep going.
6620 "Move point to beginning of current line as displayed.
6621 \(If there's an image in the line, this disregards newlines
6622 which are part of the text that the image rests on.)
6624 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6625 If point reaches the beginning or end of buffer, it stops there.
6626 \(But if the buffer doesn't end in a newline, it stops at the
6627 beginning of the last line.)
6628 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6633 first-vis first-vis-field-value)
6635 ;; Move by lines, if ARG is not 1 (the default).
6640 ;; Move to beginning-of-line, ignoring fields and invisible text.
6646 ;; Now find first visible char in the line.
6651 ;; See if fields would stop us from reaching FIRST-VIS.
6656 ;; If yes, obey them.
6657 first-vis-field-value
6658 ;; Otherwise, move to START with attention to fields.
6659 ;; (It is possible that fields never matter in this case.)
6664 ;; Many people have said they rarely use this feature, and often type
6665 ;; it by accident. Maybe it shouldn't even be on a key.
6670 Those commands will move to this position in the line moved to
6671 rather than trying to keep the same horizontal position.
6672 With a non-nil argument ARG, clears out the goal column
6674 The goal column is stored in the variable `goal-column'.
6675 This is a buffer-local setting."
6682 ;; The older method below can be erroneous if `set-goal-column' is bound
6683 ;; to a sequence containing %
6684 ;;(message (substitute-command-keys
6685 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6686 ;;goal-column)
6693 )
6694 nil)
6695 \f
6696 ;;; Editing based on visual lines, as opposed to logical lines.
6699 "Move point to end of current visual line.
6700 With argument N not nil or 1, move forward N - 1 visual lines first.
6701 If point reaches the beginning or end of buffer, it stops there.
6702 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6708 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6709 ;; constrain to field boundaries, so we don't either.
6713 "Move point to beginning of current visual line.
6714 With argument N not nil or 1, move forward N - 1 visual lines first.
6715 If point reaches the beginning or end of buffer, it stops there.
6716 \(But if the buffer doesn't end in a newline, it stops at the
6717 beginning of the last visual line.)
6718 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6726 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6730 "Kill the rest of the visual line.
6731 With prefix argument ARG, kill that many visual lines from point.
6732 If ARG is negative, kill visual lines backward.
6733 If ARG is zero, kill the text before point on the current visual
6734 line.
6736 If you want to append the killed line to the last killed text,
6739 If the buffer is read-only, Emacs will beep and refrain from deleting
6740 the line, but put the line in the kill ring anyway. This means that
6741 you can use this command to copy text from a read-only buffer.
6742 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6743 even beep.)"
6745 ;; Like in `kill-line', it's better to move point to the other end
6746 ;; of the kill before killing.
6754 ;; Skip any trailing whitespace at the end of the visual line.
6755 ;; We used to do this only if `show-trailing-whitespace' is
6756 ;; nil, but that's wrong; the correct thing would be to check
6757 ;; whether the trailing whitespace is highlighted. But, it's
6758 ;; OK to just do this unconditionally.
6765 "Move cursor vertically down ARG lines.
6766 This is identical to `next-line', except that it always moves
6767 by logical lines instead of visual lines, ignoring the value of
6768 the variable `line-move-visual'."
6775 "Move cursor vertically up ARG lines.
6776 This is identical to `previous-line', except that it always moves
6777 by logical lines instead of visual lines, ignoring the value of
6778 the variable `line-move-visual'."
6785 "Editing based on visual lines."
6794 ;; These keybindings interfere with xterm function keys. Are
6795 ;; there any other suitable bindings?
6796 ;; (define-key map "\M-[" 'previous-logical-line)
6797 ;; (define-key map "\M-]" 'next-logical-line)
6798 map))
6801 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6802 The value should be a list of the form (LEFT RIGHT), where LEFT
6803 and RIGHT are symbols representing the bitmaps to display, to
6804 indicate wrapped lines, in the left and right fringes respectively.
6805 See also `fringe-indicator-alist'.
6806 The default is not to display fringe indicators for wrapped lines.
6807 This variable does not affect fringe indicators displayed for
6808 other purposes."
6823 'continuation
6830 "Toggle visual line based editing (Visual Line mode) in the current buffer.
6831 Interactively, with a prefix argument, enable
6832 Visual Line mode if the prefix argument is positive,
6833 and disable it otherwise. If called from Lisp, toggle
6834 the mode if ARG is `toggle', disable the mode if ARG is
6835 a non-positive integer, and enable the mode otherwise
6836 \(including if ARG is omitted or nil or a positive integer).
6838 When Visual Line mode is enabled, `word-wrap' is turned on in
6839 this buffer, and simple editing commands are redefined to act on
6840 visual lines, not logical lines. See Info node `Visual Line
6841 Mode' for details."
6842 :keymap visual-line-mode-map
6848 ;; Save the local values of some variables, to be restored if
6849 ;; visual-line-mode is turned off.
6851 truncate-partial-width-windows
6852 word-wrap fringe-indicator-alist))
6855 visual-line--saved-state)))
6859 word-wrap t
6860 fringe-indicator-alist
6862 fringe-indicator-alist)))
6876 visual-line-mode turn-on-visual-line-mode)
6878 \f
6880 "Interchange characters around point, moving forward one character.
6881 With prefix arg ARG, effect is to take character before point
6882 and drag it forward past ARG other characters (backward if ARG negative).
6883 If no argument and at end of line, the previous two chars are exchanged."
6891 "Interchange words around point, leaving point at end of them.
6892 With prefix arg ARG, effect is to take word before or around point
6893 and drag it forward past ARG other words (backward if ARG negative).
6894 If ARG is zero, the words around or after point and around or after mark
6895 are interchanged."
6896 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6902 Unlike `transpose-words', point must be between the two sexps and not
6903 in the middle of a sexp to be transposed.
6904 With non-zero prefix arg ARG, effect is to take the sexp before point
6905 and drag it forward past ARG other sexps (backward if ARG is negative).
6906 If ARG is zero, the sexps ending at or after point and at or after mark
6907 are interchanged."
6911 ;; Here we should try to simulate the behavior of
6912 ;; (cons (progn (forward-sexp x) (point))
6913 ;; (progn (forward-sexp (- x)) (point)))
6914 ;; Except that we don't want to rely on the second forward-sexp
6915 ;; putting us back to where we want to be, since forward-sexp-function
6916 ;; might do funny things like infix-precedence.
6921 ;; Jumping over a symbol. We might be inside it, mind you.
6926 ;; Otherwise, we're between sexps. Take a step back before jumping
6927 ;; to make sure we'll obey the same precedence no matter which direction
6928 ;; we're going.
6933 'skip-syntax-forward
6940 "Exchange current line and previous line, leaving point after both.
6941 With argument ARG, takes previous line and moves it past ARG lines.
6942 With argument 0, interchanges line point is in with line mark is in."
6948 ;; Move forward over ARG lines,
6949 ;; but create newlines if necessary.
6956 arg))
6958 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6959 ;; which seems inconsistent with the ARG /= 0 case.
6960 ;; FIXME document SPECIAL.
6962 "Subroutine to do the work of transposing objects.
6963 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6964 moves forward by units of the given object (e.g. forward-sentence,
6965 forward-paragraph). If ARG is zero, exchanges the current object
6966 with the one containing mark. If ARG is an integer, moves the
6967 current object past ARG following (if ARG is positive) or
6968 preceding (if ARG is negative) objects, leaving point after the
6969 current object."
6974 pos1 pos2)
7003 ;; This sequence of insertions attempts to preserve marker
7004 ;; positions at the start and end of the transposed objects.
7018 \f
7020 "Move backward until encountering the beginning of a word.
7021 With argument ARG, do this that many times.
7022 If ARG is omitted or nil, move point backward one word.
7024 The word boundaries are normally determined by the buffer's syntax
7025 table, but `find-word-boundary-function-table', such as set up
7026 by `subword-mode', can change that. If a Lisp program needs to
7027 move by words determined strictly by the syntax table, it should
7028 use `backward-word-strictly' instead."
7033 "Set mark ARG words away from point.
7035 move to with the same argument.
7036 Interactively, if this command is repeated
7037 or (in Transient Mark mode) if the mark is active,
7038 it marks the next ARG words after the ones already marked."
7055 nil t))))
7058 "Kill characters forward until encountering the end of a word.
7059 With argument ARG, do this that many times."
7064 "Kill characters backward until encountering the beginning of a word.
7065 With argument ARG, do this that many times."
7070 "Return the word at or near point, as a string.
7071 The return value includes no text properties.
7073 If optional arg STRICT is non-nil, return nil unless point is
7074 within or adjacent to a word, otherwise look for a word within
7075 point's line. If there is no word anywhere on point's line, the
7076 value is nil regardless of STRICT.
7078 By default, this function treats as a single word any sequence of
7079 characters that have either word or symbol syntax. If optional
7080 arg REALLY-WORD is non-nil, only characters of word syntax can
7081 constitute a word."
7090 ;; Point is neither within nor adjacent to a word.
7092 ;; Look for preceding word in same line.
7095 ;; No preceding word in same line.
7096 ;; Look for following word in same line.
7105 ;; If we found something nonempty, return it as a string.
7108 \f
7110 "String for filling to insert at front of new line, or nil for none."
7112 string)
7118 "Regexp to match lines which should not be auto-filled."
7120 regexp)
7124 "The default value for `normal-auto-fill-function'.
7125 This is the default auto-fill function, some major modes use a different one.
7126 Returns t if it really did any work."
7136 nil ;; Auto-filling not required
7140 ;; Choose a fill-prefix automatically.
7148 ;; Use auto-indentation rather than a guessed empty prefix.
7154 ;; Determine where to split the line.
7158 ;; Don't split earlier in the line than the length of the
7159 ;; fill prefix, since the resulting line would be longer.
7167 ;; See whether the place we found is any good.
7171 ;; There is no use breaking at end of line.
7173 ;; Don't split right after a comment starter
7174 ;; since we would just make another comment starter.
7179 limit t)
7181 ;; No good place to break => stop trying.
7183 ;; Ok, we have a useful place to break the line. Do it.
7185 ;; If point is at the fill-point, do not `save-excursion'.
7186 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7187 ;; point will end up before it rather than after it.
7195 ;; Now do justification, if required
7200 ;; If making the new line didn't reduce the hpos of
7201 ;; the end of the line, then give up now;
7202 ;; trying again will not help.
7205 ;; Justify last line.
7207 t)))
7210 "Mode-specific function which line breaks and continues a comment.
7211 This function is called during auto-filling when a comment syntax
7212 is defined.
7213 The function should take a single optional argument, which is a flag
7217 "Break line at point and indent.
7218 If a comment syntax is defined, call `comment-indent-new-line'.
7220 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7221 unless optional argument SOFT is non-nil."
7225 ;; Insert the newline before removing empty space so that markers
7226 ;; get preserved better.
7232 ;; Blindly trust a non-adaptive fill-prefix.
7238 ;; If there's an adaptive prefix, use it unless we're inside
7239 ;; a comment and the prefix is not a comment starter.
7243 ;; If we're not inside a comment, just try to indent.
7247 "The function called by `self-insert-command' to perform auto-filling."
7254 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7258 ;; `functions' and `hooks' are usually unsafe to set, but setting
7259 ;; auto-fill-function to nil in a file-local setting is safe and
7260 ;; can be useful to prevent auto-filling.
7264 "Toggle automatic line breaking (Auto Fill mode).
7265 Interactively, with a prefix argument, enable
7266 Auto Fill mode if the prefix argument is positive,
7267 and disable it otherwise. If called from Lisp, toggle
7268 the mode if ARG is `toggle', disable the mode if ARG is
7269 a non-positive integer, and enable the mode otherwise
7270 \(including if ARG is omitted or nil or a positive integer).
7272 When Auto Fill mode is enabled, inserting a space at a column
7273 beyond `current-fill-column' automatically breaks the line at a
7274 previous space.
7276 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7277 non-nil.
7279 The value of `normal-auto-fill-function' specifies the function to use
7280 for `auto-fill-function' when turning Auto Fill mode on."
7285 ;; This holds a document string used to document auto-fill-mode.
7287 "Automatically break line at a previous space, in insertion of text."
7288 nil)
7291 "Unconditionally turn on Auto Fill mode."
7295 "Unconditionally turn off Auto Fill mode."
7301 "Set `fill-column' to specified argument.
7306 ;; We used to use current-column silently, but C-x f is too easily
7307 ;; typed as a typo for C-x C-f, so we turned it into an error and
7308 ;; now an interactive prompt.
7313 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7317 \f
7319 "Set `selective-display' to ARG; clear it if no arg.
7320 When the value of `selective-display' is a number > 0,
7321 lines whose indentation is >= that value are not displayed.
7322 The variable `selective-display' has a separate value for each buffer."
7342 "Toggle truncating of long lines for the current buffer.
7343 When truncating is off, long lines are folded.
7344 With prefix argument ARG, truncate long lines if ARG is positive,
7345 otherwise fold them. Note that in side-by-side windows, this
7346 command has no effect if `truncate-partial-width-windows' is
7347 non-nil."
7359 nil t)))
7364 "Toggle whether to use word-wrapping for continuation lines.
7365 With prefix argument ARG, wrap continuation lines at word boundaries
7366 if ARG is positive, otherwise wrap them at the right screen edge.
7367 This command toggles the value of `word-wrap'. It has no effect
7368 if long lines are truncated."
7384 "Toggle Overwrite mode.
7385 With a prefix argument ARG, enable Overwrite mode if ARG is
7386 positive, and disable it otherwise. If called from Lisp, enable
7387 the mode if ARG is omitted or nil.
7389 When Overwrite mode is enabled, printing characters typed in
7390 replace existing text on a one-for-one basis, rather than pushing
7391 it to the right. At the end of a line, such characters extend
7392 the line. Before a tab, such characters insert until the tab is
7394 overwrite mode; this is supposed to make it easier to insert
7395 characters when necessary."
7400 "Toggle Binary Overwrite mode.
7401 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7402 is positive, and disable it otherwise. If called from Lisp,
7403 enable the mode if ARG is omitted or nil.
7405 When Binary Overwrite mode is enabled, printing characters typed
7406 in replace existing text. Newlines are not treated specially, so
7407 typing at the end of a line joins the line to the next, with the
7408 typed character between them. Typing before a tab character
7409 simply replaces the tab with the character typed.
7411 ordinary typing characters do.
7413 Note that Binary Overwrite mode is not its own minor mode; it is
7414 a specialization of overwrite mode, entered by setting the
7415 `overwrite-mode' variable to `overwrite-mode-binary'."
7420 "Toggle line number display in the mode line (Line Number mode).
7421 With a prefix argument ARG, enable Line Number mode if ARG is
7422 positive, and disable it otherwise. If called from Lisp, enable
7423 the mode if ARG is omitted or nil.
7425 Line numbers do not appear for very large buffers and buffers
7426 with very long lines; see variables `line-number-display-limit'
7427 and `line-number-display-limit-width'."
7431 "Toggle column number display in the mode line (Column Number mode).
7432 With a prefix argument ARG, enable Column Number mode if ARG is
7433 positive, and disable it otherwise.
7435 If called from Lisp, enable the mode if ARG is omitted or nil."
7439 "Toggle buffer size display in the mode line (Size Indication mode).
7440 With a prefix argument ARG, enable Size Indication mode if ARG is
7441 positive, and disable it otherwise.
7443 If called from Lisp, enable the mode if ARG is omitted or nil."
7447 "Toggle auto-saving in the current buffer (Auto Save mode).
7448 With a prefix argument ARG, enable Auto Save mode if ARG is
7449 positive, and disable it otherwise.
7451 If called from Lisp, enable the mode if ARG is omitted or nil."
7453 ;; If auto-save is off because buffer has shrunk,
7454 ;; then toggling should turn it on.
7462 buffer-file-name)
7464 ;; If -1 was stored here, to temporarily turn off saving,
7465 ;; turn it back on.
7468 \f
7470 "Blinking matching of parens and expressions."
7475 "Non-nil means show matching open-paren when close-paren is inserted.
7476 If t, highlight the paren. If `jump', briefly move cursor to its
7477 position. If `jump-offscreen', move cursor there even if the
7478 position is off screen. With any other non-nil value, the
7479 off-screen position of the opening paren will be shown in the
7480 echo area."
7489 "Non-nil means show matching open-paren when it is on screen.
7490 If nil, don't show it (but the open-paren can still be shown
7491 in the echo area when it is off screen).
7493 This variable has no effect if `blink-matching-paren' is nil.
7494 \(In that case, the open-paren is never shown.)
7495 It is also ignored if `show-paren-mode' is enabled."
7500 "If non-nil, maximum distance to search backwards for matching open-paren.
7501 If nil, search stops at the beginning of the accessible portion of the buffer."
7507 "Time in seconds to delay after showing a matching paren."
7512 "If nil, `blink-matching-paren' ignores comments.
7513 More precisely, when looking for the matching parenthesis,
7514 it skips the contents of comments that end before point."
7519 "Return whether or not START...END are matching parens.
7520 END is the current point and START is the blink position.
7521 START might be nil if no matching starter was found.
7522 Returns non-nil if we find there is a mismatch."
7527 ;; For self-matched chars like " and $, we can't know when they're
7528 ;; mismatched or unmatched, so we can only do it for parens.
7533 ;; The cdr might hold a new paren-class info rather than
7534 ;; a matching-char info, in which case the two CDRs
7535 ;; should match.
7539 "Function to check parentheses mismatches.
7540 The function takes two arguments (START and END) where START is the
7541 position just before the opening token and END is the position right after.
7542 START can be nil, if it was not found.
7549 ol)
7553 "Momentarily highlight the beginning of the sexp before point."
7556 blink-matching-paren)
7566 oldpos))
7574 ;; backward-sexp skips backward over prefix chars,
7575 ;; so move back to the matching paren.
7598 ;; Matching open within window, temporarily move to or highlight
7599 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7600 ;; is non-nil.
7617 ;; Show what precedes the open in its line, if anything.
7622 ;; Show what follows the open in its line, if anything.
7629 ;; Otherwise show the previous nonblank line,
7630 ;; if there is one.
7639 ;; Replace the newline and other whitespace with `...'.
7640 "..."
7642 ;; There is nothing to show except the char itself.
7645 "Matches %s"
7649 "Function called, if non-nil, whenever a close parenthesis is inserted.
7655 blink-paren-function
7658 ;; Verify an even number of quoting characters precede the close.
7659 ;; FIXME: Also check if this parenthesis closes a comment as
7660 ;; can happen in Pascal and SML.
7671 ;; Most likely, this hook is nil, so this arg doesn't matter,
7672 ;; but I use it as a reminder that this function usually
7673 ;; likes to be run after others since it does
7674 ;; `sit-for'. That's also the reason it get a `priority' prop
7675 ;; of 100.
7677 \f
7678 ;; This executes C-g typed while Emacs is waiting for a command.
7679 ;; Quitting out of a program does not go through here;
7680 ;; that happens in the maybe_quit function at the C code level.
7682 "Signal a `quit' condition.
7683 During execution of Lisp code, this character causes a quit directly.
7684 At top-level, as an editor command, this simply beeps."
7686 ;; Avoid adding the region to the window selection.
7694 ;; Force the next redisplay cycle to remove the "Def" indicator from
7695 ;; all the mode lines.
7709 This command can exit an interactive command such as `query-replace',
7710 can clear out a prefix argument or a region,
7711 can get out of the minibuffer or other recursive edit,
7712 cancel the use of the current buffer (for special-purpose buffers),
7713 or go back to just one window (by deleting all but the selected window)."
7721 nil)
7732 "Play sound stored in FILE.
7733 VOLUME and DEVICE correspond to the keywords of the sound
7734 specification for `play-sound'."
7744 \f
7746 "Your preference for a mail reading package.
7747 This is used by some keybindings which support reading mail.
7748 See also `mail-user-agent' concerning sending mail."
7758 "Your preference for a mail composition package.
7759 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7760 outgoing email message. This variable lets you specify which
7761 mail-sending package you prefer.
7763 Valid values include:
7765 `message-user-agent' -- use the Message package.
7766 See Info node `(message)'.
7767 `sendmail-user-agent' -- use the Mail package.
7768 See Info node `(emacs)Sending Mail'.
7769 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7770 See Info node `(mh-e)'.
7771 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7772 paraphernalia if Gnus is running, particularly
7773 the Gcc: header for archiving.
7775 Additional valid symbols may be available; check with the author of
7776 your package for details. The function should return non-nil if it
7777 succeeds.
7779 See also `read-mail-command' concerning reading mail."
7782 message-user-agent)
7785 sendmail-user-agent)
7788 mh-e-user-agent)
7791 gnus-user-agent)
7797 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7798 If the value of `mail-user-agent' is the default, and the user
7799 appears to have customizations applying to the old default,
7800 `compose-mail' issues a warning."
7806 "If the buffer starts with a mail header, move point to the header's end.
7807 Otherwise, moves to `point-min'.
7808 The end of the header is the start of the next line, if there is one,
7809 else the end of the last line. This function obeys RFC822."
7815 ;; Used by Rmail (e.g., rmail-forward).
7817 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7821 switch-function yank-action send-actions
7822 return-action)
7823 "Start composing a mail message to send.
7824 This uses the user's chosen mail composition package
7825 as selected with the variable `mail-user-agent'.
7826 The optional arguments TO and SUBJECT specify recipients
7827 and the initial Subject field, respectively.
7829 OTHER-HEADERS is an alist specifying additional
7830 header fields. Elements look like (HEADER . VALUE) where both
7831 HEADER and VALUE are strings.
7833 CONTINUE, if non-nil, says to continue editing a message already
7834 being composed. Interactively, CONTINUE is the prefix argument.
7836 SWITCH-FUNCTION, if non-nil, is a function to use to
7837 switch to and display the buffer used for mail composition.
7839 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7840 to insert the raw text of the message being replied to.
7841 It has the form (FUNCTION . ARGS). The user agent will apply
7842 FUNCTION to ARGS, to insert the raw text of the original message.
7843 \(The user agent will also run `mail-citation-hook', *after* the
7844 original text has been inserted in this way.)
7846 SEND-ACTIONS is a list of actions to call when the message is sent.
7847 Each action has the form (FUNCTION . ARGS).
7849 RETURN-ACTION, if non-nil, is an action for returning to the
7850 caller. It has the form (FUNCTION . ARGS). The function is
7851 called after the mail has been sent or put aside, and the mail
7852 buffer buried."
7856 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7857 ;; from sendmail-user-agent to message-user-agent. Some users may
7858 ;; encounter incompatibilities. This hack tries to detect problems
7859 ;; and warn about them.
7864 mail-yank-hooks mail-archive-file-name
7865 mail-default-reply-to mail-mailing-lists
7866 mail-self-blind))
7873 The default mail mode is now Message mode.
7874 You have the following Mail mode variable%s customized:
7876 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7883 yank-action send-actions return-action)))
7886 yank-action send-actions
7887 return-action)
7891 'switch-to-buffer-other-window yank-action send-actions
7892 return-action))
7895 yank-action send-actions
7896 return-action)
7900 'switch-to-buffer-other-frame yank-action send-actions
7901 return-action))
7903 \f
7905 "History of values entered with `set-variable'.
7907 Maximum length of the history list is determined by the value
7911 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7912 VARIABLE should be a user option variable name, a Lisp variable
7913 meant to be customized by users. You should enter VALUE in Lisp syntax,
7914 so if you want VALUE to be a string, you must surround it with doublequotes.
7915 VALUE is used literally, not evaluated.
7917 If VARIABLE has a `variable-interactive' property, that is used as if
7918 it were the arg to `interactive' (which see) to interactively read VALUE.
7920 If VARIABLE has been defined with `defcustom', then the type information
7921 in the definition is used to check that VALUE is valid.
7923 Note that this function is at heart equivalent to the basic `set' function.
7924 For a variable defined with `defcustom', it does not pay attention to
7925 any :set property that the variable might have (if you want that, use
7928 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7933 default-var)
7949 var obsolete)
7952 ;; Use VAR's `variable-interactive' property
7953 ;; as an interactive spec for prompting.
7956 arg))
7958 read-expression-map t
7959 'set-variable-value-history
7968 ;; Match with custom type.
7980 ;; Force a thorough redisplay for the case that the variable
7981 ;; has an effect on the display, like `tab-width' has.
7983 \f
7984 ;; Define the major mode for lists of completions.
7994 (define-key map [right] 'next-completion)
7996 (define-key map [backtab] 'previous-completion)
7997 (define-key map "q" 'quit-window)
7998 (define-key map "z" 'kill-current-buffer)
7999 map)
8000 "Local map for completion list buffers.")
8002 ;; Completion mode is suitable only for specially formatted data.
8003 (put 'completion-list-mode 'mode-class 'special)
8005 (defvar completion-reference-buffer nil
8006 "Record the buffer that was current when the completion list was requested.
8007 This is a local variable in the completion list buffer.
8008 Initial value is nil to avoid some compiler warnings.")
8010 (defvar completion-no-auto-exit nil
8011 "Non-nil means `choose-completion-string' should never exit the minibuffer.
8012 This also applies to other functions such as `choose-completion'.")
8014 (defvar completion-base-position nil
8015 "Position of the base of the text corresponding to the shown completions.
8016 This variable is used in the *Completions* buffers.
8017 Its value is a list of the form (START END) where START is the place
8018 where the completion should be inserted and END (if non-nil) is the end
8019 of the text to replace. If END is nil, point is used instead.")
8021 (defvar completion-list-insert-choice-function #'completion--replace
8022 "Function to use to insert the text chosen in *Completions*.
8023 Called with three arguments (BEG END TEXT), it should replace the text
8024 between BEG and END with TEXT. Expected to be set buffer-locally
8025 in the *Completions* buffer.")
8027 (defvar completion-base-size nil
8028 "Number of chars before point not involved in completion.
8029 This is a local variable in the completion list buffer.
8030 It refers to the chars in the minibuffer if completing in the
8031 minibuffer, or in `completion-reference-buffer' otherwise.
8032 Only characters in the field at point are included.
8034 If nil, Emacs determines which part of the tail end of the
8035 buffer's text is involved in completion by comparing the text
8036 directly.")
8037 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
8039 (defun delete-completion-window ()
8040 "Delete the completion list window.
8041 Go to the window from which completion was requested."
8042 (interactive)
8043 (let ((buf completion-reference-buffer))
8044 (if (one-window-p t)
8045 (if (window-dedicated-p) (delete-frame))
8046 (delete-window (selected-window))
8047 (if (get-buffer-window buf)
8048 (select-window (get-buffer-window buf))))))
8050 (defun previous-completion (n)
8051 "Move to the previous item in the completion list."
8052 (interactive "p")
8053 (next-completion (- n)))
8055 (defun next-completion (n)
8056 "Move to the next item in the completion list.
8057 With prefix argument N, move N items (negative N means move backward)."
8058 (interactive "p")
8059 (let ((beg (point-min)) (end (point-max)))
8060 (while (and (> n 0) (not (eobp)))
8061 ;; If in a completion, move to the end of it.
8062 (when (get-text-property (point) 'mouse-face)
8063 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8064 ;; Move to start of next one.
8065 (unless (get-text-property (point) 'mouse-face)
8066 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8067 (setq n (1- n)))
8068 (while (and (< n 0) (not (bobp)))
8069 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
8070 ;; If in a completion, move to the start of it.
8071 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
8072 (goto-char (previous-single-property-change
8073 (point) 'mouse-face nil beg)))
8074 ;; Move to end of the previous completion.
8075 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
8076 (goto-char (previous-single-property-change
8077 (point) 'mouse-face nil beg)))
8078 ;; Move to the start of that one.
8079 (goto-char (previous-single-property-change
8080 (point) 'mouse-face nil beg))
8081 (setq n (1+ n))))))
8083 (defun choose-completion (&optional event)
8084 "Choose the completion at point.
8085 If EVENT, use EVENT's position to determine the starting position."
8086 (interactive (list last-nonmenu-event))
8087 ;; In case this is run via the mouse, give temporary modes such as
8088 ;; isearch a chance to turn off.
8089 (run-hooks 'mouse-leave-buffer-hook)
8090 (with-current-buffer (window-buffer (posn-window (event-start event)))
8091 (let ((buffer completion-reference-buffer)
8092 (base-size completion-base-size)
8093 (base-position completion-base-position)
8094 (insert-function completion-list-insert-choice-function)
8095 (choice
8096 (save-excursion
8097 (goto-char (posn-point (event-start event)))
8098 (let (beg end)
8099 (cond
8100 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
8101 (setq end (point) beg (1+ (point))))
8102 ((and (not (bobp))
8103 (get-text-property (1- (point)) 'mouse-face))
8104 (setq end (1- (point)) beg (point)))
8105 (t (error "No completion here")))
8106 (setq beg (previous-single-property-change beg 'mouse-face))
8107 (setq end (or (next-single-property-change end 'mouse-face)
8108 (point-max)))
8109 (buffer-substring-no-properties beg end)))))
8111 (unless (buffer-live-p buffer)
8112 (error "Destination buffer is dead"))
8113 (quit-window nil (posn-window (event-start event)))
8115 (with-current-buffer buffer
8116 (choose-completion-string
8117 choice buffer
8118 (or base-position
8119 (when base-size
8120 ;; Someone's using old completion code that doesn't know
8121 ;; about base-position yet.
8122 (list (+ base-size (field-beginning))))
8123 ;; If all else fails, just guess.
8124 (list (choose-completion-guess-base-position choice)))
8125 insert-function)))))
8127 ;; Delete the longest partial match for STRING
8128 ;; that can be found before POINT.
8129 (defun choose-completion-guess-base-position (string)
8130 (save-excursion
8131 (let ((opoint (point))
8132 len)
8133 ;; Try moving back by the length of the string.
8134 (goto-char (max (- (point) (length string))
8135 (minibuffer-prompt-end)))
8136 ;; See how far back we were actually able to move. That is the
8137 ;; upper bound on how much we can match and delete.
8138 (setq len (- opoint (point)))
8139 (if completion-ignore-case
8140 (setq string (downcase string)))
8141 (while (and (> len 0)
8142 (let ((tail (buffer-substring (point) opoint)))
8143 (if completion-ignore-case
8144 (setq tail (downcase tail)))
8145 (not (string= tail (substring string 0 len)))))
8146 (setq len (1- len))
8147 (forward-char 1))
8148 (point))))
8150 (defun choose-completion-delete-max-match (string)
8151 (declare (obsolete choose-completion-guess-base-position "23.2"))
8152 (delete-region (choose-completion-guess-base-position string) (point)))
8154 (defvar choose-completion-string-functions nil
8155 "Functions that may override the normal insertion of a completion choice.
8156 These functions are called in order with three arguments:
8157 CHOICE - the string to insert in the buffer,
8158 BUFFER - the buffer in which the choice should be inserted,
8159 BASE-POSITION - where to insert the completion.
8161 If a function in the list returns non-nil, that function is supposed
8162 to have inserted the CHOICE in the BUFFER, and possibly exited
8163 the minibuffer; no further functions will be called.
8165 If all functions in the list return nil, that means to use
8166 the default method of inserting the completion in BUFFER.")
8168 (defun choose-completion-string (choice &optional
8169 buffer base-position insert-function)
8170 "Switch to BUFFER and insert the completion choice CHOICE.
8171 BASE-POSITION says where to insert the completion.
8172 INSERT-FUNCTION says how to insert the completion and falls
8173 back on `completion-list-insert-choice-function' when nil."
8175 ;; If BUFFER is the minibuffer, exit the minibuffer
8176 ;; unless it is reading a file name and CHOICE is a directory,
8177 ;; or completion-no-auto-exit is non-nil.
8179 ;; Some older code may call us passing `base-size' instead of
8180 ;; `base-position'. It's difficult to make any use of `base-size',
8181 ;; so we just ignore it.
8182 (unless (consp base-position)
8183 (message "Obsolete `base-size' passed to choose-completion-string")
8184 (setq base-position nil))
8186 (let* ((buffer (or buffer completion-reference-buffer))
8187 (mini-p (minibufferp buffer)))
8188 ;; If BUFFER is a minibuffer, barf unless it's the currently
8189 ;; active minibuffer.
8190 (if (and mini-p
8191 (not (and (active-minibuffer-window)
8192 (equal buffer
8193 (window-buffer (active-minibuffer-window))))))
8194 (error "Minibuffer is not active for completion")
8195 ;; Set buffer so buffer-local choose-completion-string-functions works.
8196 (set-buffer buffer)
8197 (unless (run-hook-with-args-until-success
8198 'choose-completion-string-functions
8199 ;; The fourth arg used to be `mini-p' but was useless
8200 ;; (since minibufferp can be used on the `buffer' arg)
8201 ;; and indeed unused. The last used to be `base-size', so we
8202 ;; keep it to try and avoid breaking old code.
8203 choice buffer base-position nil)
8204 ;; This remove-text-properties should be unnecessary since `choice'
8205 ;; comes from buffer-substring-no-properties.
8206 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8207 ;; Insert the completion into the buffer where it was requested.
8208 (funcall (or insert-function completion-list-insert-choice-function)
8209 (or (car base-position) (point))
8210 (or (cadr base-position) (point))
8211 choice)
8212 ;; Update point in the window that BUFFER is showing in.
8213 (let ((window (get-buffer-window buffer t)))
8214 (set-window-point window (point)))
8215 ;; If completing for the minibuffer, exit it with this choice.
8216 (and (not completion-no-auto-exit)
8217 (minibufferp buffer)
8218 minibuffer-completion-table
8219 ;; If this is reading a file name, and the file name chosen
8220 ;; is a directory, don't exit the minibuffer.
8221 (let* ((result (buffer-substring (field-beginning) (point)))
8222 (bounds
8223 (completion-boundaries result minibuffer-completion-table
8224 minibuffer-completion-predicate
8225 "")))
8226 (if (eq (car bounds) (length result))
8227 ;; The completion chosen leads to a new set of completions
8228 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8229 (let ((mini (active-minibuffer-window)))
8230 (select-window mini)
8231 (when minibuffer-auto-raise
8232 (raise-frame (window-frame mini))))
8233 (exit-minibuffer))))))))
8235 (define-derived-mode completion-list-mode nil "Completion List"
8236 "Major mode for buffers showing lists of possible completions.
8238 to select the completion near point.
8239 Or click to select one with the mouse.
8242 (set (make-local-variable 'completion-base-size) nil))
8244 (defun completion-list-mode-finish ()
8245 "Finish setup of the completions buffer.
8246 Called from `temp-buffer-show-hook'."
8247 (when (eq major-mode 'completion-list-mode)
8248 (setq buffer-read-only t)))
8250 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8253 ;; Variables and faces used in `completion-setup-function'.
8255 (defcustom completion-show-help t
8256 "Non-nil means show help message in *Completions* buffer."
8257 :type 'boolean
8258 :version "22.1"
8259 :group 'completion)
8261 ;; This function goes in completion-setup-hook, so that it is called
8262 ;; after the text of the completion list buffer is written.
8263 (defun completion-setup-function ()
8264 (let* ((mainbuf (current-buffer))
8265 (base-dir
8266 ;; FIXME: This is a bad hack. We try to set the default-directory
8267 ;; in the *Completions* buffer so that the relative file names
8268 ;; displayed there can be treated as valid file names, independently
8269 ;; from the completion context. But this suffers from many problems:
8270 ;; - It's not clear when the completions are file names. With some
8271 ;; completion tables (e.g. bzr revision specs), the listed
8272 ;; completions can mix file names and other things.
8273 ;; - It doesn't pay attention to possible quoting.
8274 ;; - With fancy completion styles, the code below will not always
8275 ;; find the right base directory.
8276 (if minibuffer-completing-file-name
8277 (file-name-as-directory
8278 (expand-file-name
8279 (buffer-substring (minibuffer-prompt-end)
8280 (- (point) (or completion-base-size 0))))))))
8281 (with-current-buffer standard-output
8282 (let ((base-size completion-base-size) ;Read before killing localvars.
8283 (base-position completion-base-position)
8284 (insert-fun completion-list-insert-choice-function))
8285 (completion-list-mode)
8286 (set (make-local-variable 'completion-base-size) base-size)
8287 (set (make-local-variable 'completion-base-position) base-position)
8288 (set (make-local-variable 'completion-list-insert-choice-function)
8289 insert-fun))
8290 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8291 (if base-dir (setq default-directory base-dir))
8292 ;; Maybe insert help string.
8293 (when completion-show-help
8294 (goto-char (point-min))
8295 (if (display-mouse-p)
8297 (insert (substitute-command-keys
8301 (add-hook 'completion-setup-hook 'completion-setup-function)
8303 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8304 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8306 (defun switch-to-completions ()
8307 "Select the completion list window."
8308 (interactive)
8309 (let ((window (or (get-buffer-window "*Completions*" 0)
8310 ;; Make sure we have a completions window.
8311 (progn (minibuffer-completion-help)
8312 (get-buffer-window "*Completions*" 0)))))
8313 (when window
8314 (select-window window)
8315 ;; In the new buffer, go to the first completion.
8316 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8317 (when (bobp)
8318 (next-completion 1)))))
8319 \f
8320 ;;; Support keyboard commands to turn on various modifiers.
8322 ;; These functions -- which are not commands -- each add one modifier
8323 ;; to the following event.
8325 (defun event-apply-alt-modifier (_ignore-prompt)
8328 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8329 (defun event-apply-super-modifier (_ignore-prompt)
8332 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8333 (defun event-apply-hyper-modifier (_ignore-prompt)
8336 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8337 (defun event-apply-shift-modifier (_ignore-prompt)
8340 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8341 (defun event-apply-control-modifier (_ignore-prompt)
8344 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8345 (defun event-apply-meta-modifier (_ignore-prompt)
8348 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8350 (defun event-apply-modifier (event symbol lshiftby prefix)
8351 "Apply a modifier flag to event EVENT.
8352 SYMBOL is the name of this modifier, as a symbol.
8353 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8354 PREFIX is the string that represents this modifier in an event type symbol."
8355 (if (numberp event)
8356 (cond ((eq symbol 'control)
8357 (if (and (<= (downcase event) ?z)
8358 (>= (downcase event) ?a))
8359 (- (downcase event) ?a -1)
8360 (if (and (<= (downcase event) ?Z)
8361 (>= (downcase event) ?A))
8362 (- (downcase event) ?A -1)
8363 (logior (lsh 1 lshiftby) event))))
8364 ((eq symbol 'shift)
8365 (if (and (<= (downcase event) ?z)
8366 (>= (downcase event) ?a))
8367 (upcase event)
8368 (logior (lsh 1 lshiftby) event)))
8369 (t
8370 (logior (lsh 1 lshiftby) event)))
8371 (if (memq symbol (event-modifiers event))
8372 event
8373 (let ((event-type (if (symbolp event) event (car event))))
8374 (setq event-type (intern (concat prefix (symbol-name event-type))))
8375 (if (symbolp event)
8376 event-type
8377 (cons event-type (cdr event)))))))
8379 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8380 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8381 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8382 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8383 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8384 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8385 \f
8386 ;;;; Keypad support.
8388 ;; Make the keypad keys act like ordinary typing keys. If people add
8389 ;; bindings for the function key symbols, then those bindings will
8390 ;; override these, so this shouldn't interfere with any existing
8391 ;; bindings.
8393 ;; Also tell read-char how to handle these keys.
8394 (mapc
8395 (lambda (keypad-normal)
8396 (let ((keypad (nth 0 keypad-normal))
8397 (normal (nth 1 keypad-normal)))
8398 (put keypad 'ascii-character normal)
8399 (define-key function-key-map (vector keypad) (vector normal))))
8400 ;; See also kp-keys bound in bindings.el.
8401 '((kp-space ?\s)
8404 (kp-separator ?,)
8405 (kp-equal ?=)
8406 ;; Do the same for various keys that are represented as symbols under
8407 ;; GUIs but naturally correspond to characters.
8408 (backspace 127)
8409 (delete 127)
8412 (clear ?\C-l)
8413 (return ?\C-m)
8414 (escape ?\e)
8415 ))
8416 \f
8417 ;;;;
8418 ;;;; forking a twin copy of a buffer.
8419 ;;;;
8421 (defvar clone-buffer-hook nil
8422 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8424 (defvar clone-indirect-buffer-hook nil
8425 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8427 (defun clone-process (process &optional newname)
8428 "Create a twin copy of PROCESS.
8429 If NEWNAME is nil, it defaults to PROCESS' name;
8430 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8431 If PROCESS is associated with a buffer, the new process will be associated
8432 with the current buffer instead.
8433 Returns nil if PROCESS has already terminated."
8434 (setq newname (or newname (process-name process)))
8436 (setq newname (substring newname 0 (match-beginning 0))))
8437 (when (memq (process-status process) '(run stop open))
8438 (let* ((process-connection-type (process-tty-name process))
8439 (new-process
8440 (if (memq (process-status process) '(open))
8441 (let ((args (process-contact process t)))
8442 (setq args (plist-put args :name newname))
8443 (setq args (plist-put args :buffer
8444 (if (process-buffer process)
8445 (current-buffer))))
8446 (apply 'make-network-process args))
8447 (apply 'start-process newname
8448 (if (process-buffer process) (current-buffer))
8449 (process-command process)))))
8450 (set-process-query-on-exit-flag
8451 new-process (process-query-on-exit-flag process))
8452 (set-process-inherit-coding-system-flag
8453 new-process (process-inherit-coding-system-flag process))
8454 (set-process-filter new-process (process-filter process))
8455 (set-process-sentinel new-process (process-sentinel process))
8456 (set-process-plist new-process (copy-sequence (process-plist process)))
8457 new-process)))
8459 ;; things to maybe add (currently partly covered by `funcall mode'):
8460 ;; - syntax-table
8461 ;; - overlays
8462 (defun clone-buffer (&optional newname display-flag)
8463 "Create and return a twin copy of the current buffer.
8464 Unlike an indirect buffer, the new buffer can be edited
8465 independently of the old one (if it is not read-only).
8466 NEWNAME is the name of the new buffer. It may be modified by
8467 adding or incrementing <N> at the end as necessary to create a
8468 unique buffer name. If nil, it defaults to the name of the
8469 current buffer, with the proper suffix. If DISPLAY-FLAG is
8470 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8471 clone a file-visiting buffer, or a buffer whose major mode symbol
8472 has a non-nil `no-clone' property, results in an error.
8474 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8475 current buffer with appropriate suffix. However, if a prefix
8476 argument is given, then the command prompts for NEWNAME in the
8477 minibuffer.
8479 This runs the normal hook `clone-buffer-hook' in the new buffer
8480 after it has been set up properly in other respects."
8481 (interactive
8482 (progn
8483 (if buffer-file-name
8484 (error "Cannot clone a file-visiting buffer"))
8485 (if (get major-mode 'no-clone)
8486 (error "Cannot clone a buffer in %s mode" mode-name))
8487 (list (if current-prefix-arg
8488 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8489 t)))
8490 (if buffer-file-name
8491 (error "Cannot clone a file-visiting buffer"))
8492 (if (get major-mode 'no-clone)
8493 (error "Cannot clone a buffer in %s mode" mode-name))
8494 (setq newname (or newname (buffer-name)))
8496 (setq newname (substring newname 0 (match-beginning 0))))
8497 (let ((buf (current-buffer))
8498 (ptmin (point-min))
8499 (ptmax (point-max))
8500 (pt (point))
8501 (mk (if mark-active (mark t)))
8502 (modified (buffer-modified-p))
8503 (mode major-mode)
8504 (lvars (buffer-local-variables))
8505 (process (get-buffer-process (current-buffer)))
8506 (new (generate-new-buffer (or newname (buffer-name)))))
8507 (save-restriction
8508 (widen)
8509 (with-current-buffer new
8510 (insert-buffer-substring buf)))
8511 (with-current-buffer new
8512 (narrow-to-region ptmin ptmax)
8513 (goto-char pt)
8514 (if mk (set-mark mk))
8515 (set-buffer-modified-p modified)
8517 ;; Clone the old buffer's process, if any.
8518 (when process (clone-process process))
8520 ;; Now set up the major mode.
8521 (funcall mode)
8523 ;; Set up other local variables.
8524 (mapc (lambda (v)
8525 (condition-case () ;in case var is read-only
8526 (if (symbolp v)
8527 (makunbound v)
8528 (set (make-local-variable (car v)) (cdr v)))
8529 (error nil)))
8530 lvars)
8532 ;; Run any hooks (typically set up by the major mode
8533 ;; for cloning to work properly).
8534 (run-hooks 'clone-buffer-hook))
8535 (if display-flag
8536 ;; Presumably the current buffer is shown in the selected frame, so
8537 ;; we want to display the clone elsewhere.
8538 (let ((same-window-regexps nil)
8539 (same-window-buffer-names))
8540 (pop-to-buffer new)))
8541 new))
8544 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8545 "Create an indirect buffer that is a twin copy of the current buffer.
8547 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8548 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8549 or if not called with a prefix arg, NEWNAME defaults to the current
8550 buffer's name. The name is modified by adding a `<N>' suffix to it
8551 or by incrementing the N in an existing suffix. Trying to clone a
8552 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8553 property results in an error.
8555 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8556 This is always done when called interactively.
8558 Optional third arg NORECORD non-nil means do not put this buffer at the
8559 front of the list of recently selected ones.
8561 Returns the newly created indirect buffer."
8562 (interactive
8563 (progn
8564 (if (get major-mode 'no-clone-indirect)
8565 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8566 (list (if current-prefix-arg
8567 (read-buffer "Name of indirect buffer: " (current-buffer)))
8568 t)))
8569 (if (get major-mode 'no-clone-indirect)
8570 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8571 (setq newname (or newname (buffer-name)))
8573 (setq newname (substring newname 0 (match-beginning 0))))
8574 (let* ((name (generate-new-buffer-name newname))
8575 (buffer (make-indirect-buffer (current-buffer) name t)))
8576 (with-current-buffer buffer
8577 (run-hooks 'clone-indirect-buffer-hook))
8578 (when display-flag
8579 (pop-to-buffer buffer nil norecord))
8580 buffer))
8583 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8584 "Like `clone-indirect-buffer' but display in another window."
8585 (interactive
8586 (progn
8587 (if (get major-mode 'no-clone-indirect)
8588 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8589 (list (if current-prefix-arg
8590 (read-buffer "Name of indirect buffer: " (current-buffer)))
8591 t)))
8592 (let ((pop-up-windows t))
8593 (clone-indirect-buffer newname display-flag norecord)))
8595 \f
8596 ;;; Handling of Backspace and Delete keys.
8598 (defcustom normal-erase-is-backspace 'maybe
8599 "Set the default behavior of the Delete and Backspace keys.
8601 If set to t, Delete key deletes forward and Backspace key deletes
8602 backward.
8604 If set to nil, both Delete and Backspace keys delete backward.
8606 If set to `maybe' (which is the default), Emacs automatically
8607 selects a behavior. On window systems, the behavior depends on
8608 the keyboard used. If the keyboard has both a Backspace key and
8609 a Delete key, and both are mapped to their usual meanings, the
8610 option's default value is set to t, so that Backspace can be used
8611 to delete backward, and Delete can be used to delete forward.
8613 If not running under a window system, customizing this option
8614 accomplishes a similar effect by mapping C-h, which is usually
8615 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8616 via `keyboard-translate'. The former functionality of C-h is
8617 available on the F1 key. You should probably not use this
8618 setting if you don't have both Backspace, Delete and F1 keys.
8620 Setting this variable with setq doesn't take effect. Programmatically,
8621 call `normal-erase-is-backspace-mode' (which see) instead."
8622 :type '(choice (const :tag "Off" nil)
8623 (const :tag "Maybe" maybe)
8624 (other :tag "On" t))
8625 :group 'editing-basics
8626 :version "21.1"
8627 :set (lambda (symbol value)
8628 ;; The fboundp is because of a problem with :set when
8629 ;; dumping Emacs. It doesn't really matter.
8630 (if (fboundp 'normal-erase-is-backspace-mode)
8631 (normal-erase-is-backspace-mode (or value 0))
8632 (set-default symbol value))))
8634 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8635 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8636 (unless frame (setq frame (selected-frame)))
8637 (with-selected-frame frame
8638 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8639 (normal-erase-is-backspace-mode
8640 (if (if (eq normal-erase-is-backspace 'maybe)
8641 (and (not noninteractive)
8642 (or (memq system-type '(ms-dos windows-nt))
8643 (memq window-system '(w32 ns))
8644 (and (memq window-system '(x))
8645 (fboundp 'x-backspace-delete-keys-p)
8646 (x-backspace-delete-keys-p))
8647 ;; If the terminal Emacs is running on has erase char
8648 ;; set to ^H, use the Backspace key for deleting
8649 ;; backward, and the Delete key for deleting forward.
8650 (and (null window-system)
8651 (eq tty-erase-char ?\^H))))
8652 normal-erase-is-backspace)
8653 1 0)))))
8655 (define-minor-mode normal-erase-is-backspace-mode
8656 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8657 With a prefix argument ARG, enable this feature if ARG is
8658 positive, and disable it otherwise. If called from Lisp, enable
8659 the mode if ARG is omitted or nil.
8661 On window systems, when this mode is on, Delete is mapped to C-d
8662 and Backspace is mapped to DEL; when this mode is off, both
8663 Delete and Backspace are mapped to DEL. (The remapping goes via
8664 `local-function-key-map', so binding Delete or Backspace in the
8665 global or local keymap will override that.)
8667 In addition, on window systems, the bindings of C-Delete, M-Delete,
8668 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8669 the global keymap in accordance with the functionality of Delete and
8670 Backspace. For example, if Delete is remapped to C-d, which deletes
8671 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8672 to DEL, which deletes backward, C-Delete is bound to
8673 `backward-kill-word'.
8675 If not running on a window system, a similar effect is accomplished by
8676 remapping C-h (normally produced by the Backspace key) and DEL via
8677 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8678 to C-d; if it's off, the keys are not remapped.
8680 When not running on a window system, and this mode is turned on, the
8681 former functionality of C-h is available on the F1 key. You should
8682 probably not turn on this mode on a text-only terminal if you don't
8683 have both Backspace, Delete and F1 keys.
8685 See also `normal-erase-is-backspace'."
8686 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8687 . (lambda (v)
8688 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8689 (if v 1 0))))
8690 (let ((enabled (eq 1 (terminal-parameter
8691 nil 'normal-erase-is-backspace))))
8693 (cond ((or (memq window-system '(x w32 ns pc))
8694 (memq system-type '(ms-dos windows-nt)))
8695 (let ((bindings
8696 `(([M-delete] [M-backspace])
8697 ([C-M-delete] [C-M-backspace])
8698 ([?\e C-delete] [?\e C-backspace]))))
8700 (if enabled
8701 (progn
8702 (define-key local-function-key-map [delete] [deletechar])
8703 (define-key local-function-key-map [kp-delete] [deletechar])
8704 (define-key local-function-key-map [backspace] [?\C-?])
8705 (dolist (b bindings)
8706 ;; Not sure if input-decode-map is really right, but
8707 ;; keyboard-translate-table (used below) only works
8708 ;; for integer events, and key-translation-table is
8709 ;; global (like the global-map, used earlier).
8710 (define-key input-decode-map (car b) nil)
8711 (define-key input-decode-map (cadr b) nil)))
8712 (define-key local-function-key-map [delete] [?\C-?])
8713 (define-key local-function-key-map [kp-delete] [?\C-?])
8714 (define-key local-function-key-map [backspace] [?\C-?])
8715 (dolist (b bindings)
8716 (define-key input-decode-map (car b) (cadr b))
8717 (define-key input-decode-map (cadr b) (car b))))))
8718 (t
8719 (if enabled
8720 (progn
8721 (keyboard-translate ?\C-h ?\C-?)
8722 (keyboard-translate ?\C-? ?\C-d))
8723 (keyboard-translate ?\C-h ?\C-h)
8724 (keyboard-translate ?\C-? ?\C-?))))
8726 (if (called-interactively-p 'interactive)
8727 (message "Delete key deletes %s"
8728 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8729 "forward" "backward")))))
8730 \f
8731 (defvar vis-mode-saved-buffer-invisibility-spec nil
8732 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8734 (define-minor-mode read-only-mode
8735 "Change whether the current buffer is read-only.
8736 With prefix argument ARG, make the buffer read-only if ARG is
8737 positive, otherwise make it writable. If buffer is read-only
8738 and `view-read-only' is non-nil, enter view mode.
8740 Do not call this from a Lisp program unless you really intend to
8742 possibly enabling or disabling View mode. Also, note that this
8743 command works by setting the variable `buffer-read-only', which
8744 does not affect read-only regions caused by text properties. To
8745 ignore read-only status in a Lisp program (whether due to text
8746 properties or buffer state), bind `inhibit-read-only' temporarily
8747 to a non-nil value."
8748 :variable buffer-read-only
8749 (cond
8750 ((and (not buffer-read-only) view-mode)
8751 (View-exit-and-edit)
8752 (make-local-variable 'view-read-only)
8753 (setq view-read-only t)) ; Must leave view mode.
8754 ((and buffer-read-only view-read-only
8755 ;; If view-mode is already active, `view-mode-enter' is a nop.
8756 (not view-mode)
8757 (not (eq (get major-mode 'mode-class) 'special)))
8758 (view-mode-enter))))
8760 (define-minor-mode visible-mode
8761 "Toggle making all invisible text temporarily visible (Visible mode).
8762 With a prefix argument ARG, enable Visible mode if ARG is
8763 positive, and disable it otherwise. If called from Lisp, enable
8764 the mode if ARG is omitted or nil.
8766 This mode works by saving the value of `buffer-invisibility-spec'
8767 and setting it to nil."
8768 :lighter " Vis"
8769 :group 'editing-basics
8770 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8771 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8772 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8773 (when visible-mode
8774 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8775 buffer-invisibility-spec)
8776 (setq buffer-invisibility-spec nil)))
8777 \f
8778 (defvar messages-buffer-mode-map
8779 (let ((map (make-sparse-keymap)))
8780 (set-keymap-parent map special-mode-map)
8781 (define-key map "g" nil) ; nothing to revert
8782 map))
8784 (define-derived-mode messages-buffer-mode special-mode "Messages"
8787 (defun messages-buffer ()
8789 If it does not exist, create and it switch it to `messages-buffer-mode'."
8790 (or (get-buffer "*Messages*")
8791 (with-current-buffer (get-buffer-create "*Messages*")
8792 (messages-buffer-mode)
8793 (current-buffer))))
8795 \f
8796 ;; Minibuffer prompt stuff.
8798 ;;(defun minibuffer-prompt-modification (start end)
8799 ;; (error "You cannot modify the prompt"))
8800 ;;
8801 ;;
8802 ;;(defun minibuffer-prompt-insertion (start end)
8803 ;; (let ((inhibit-modification-hooks t))
8804 ;; (delete-region start end)
8805 ;; ;; Discard undo information for the text insertion itself
8806 ;; ;; and for the text deletion.above.
8807 ;; (when (consp buffer-undo-list)
8808 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8809 ;; (message "You cannot modify the prompt")))
8810 ;;
8811 ;;
8812 ;;(setq minibuffer-prompt-properties
8813 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8814 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8816 \f
8817 ;;;; Problematic external packages.
8819 ;; rms says this should be done by specifying symbols that define
8820 ;; versions together with bad values. This is therefore not as
8821 ;; flexible as it could be. See the thread:
8822 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8823 (defconst bad-packages-alist
8824 ;; Not sure exactly which semantic versions have problems.
8825 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8827 "The version of `semantic' loaded does not work in Emacs 22.
8828 It can cause constant high CPU load.
8829 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8830 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8831 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8832 ;; provided the `CUA-mode' feature. Since this is no longer true,
8833 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8834 (CUA-mode t nil
8835 "CUA-mode is now part of the standard GNU Emacs distribution,
8836 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8838 You have loaded an older version of CUA-mode which does not work
8839 correctly with this version of Emacs. You should remove the old
8840 version and use the one distributed with Emacs."))
8841 "Alist of packages known to cause problems in this version of Emacs.
8842 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8843 PACKAGE is either a regular expression to match file names, or a
8844 symbol (a feature name), like for `with-eval-after-load'.
8845 SYMBOL is either the name of a string variable, or t. Upon
8846 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8847 warning using STRING as the message.")
8849 (defun bad-package-check (package)
8850 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8851 (condition-case nil
8852 (let* ((list (assoc package bad-packages-alist))
8853 (symbol (nth 1 list)))
8854 (and list
8855 (boundp symbol)
8856 (or (eq symbol t)
8857 (and (stringp (setq symbol (eval symbol)))
8858 (string-match-p (nth 2 list) symbol)))
8859 (display-warning package (nth 3 list) :warning)))
8860 (error nil)))
8862 (dolist (elem bad-packages-alist)
8863 (let ((pkg (car elem)))
8864 (with-eval-after-load pkg
8865 (bad-package-check pkg))))
8867 \f
8868 ;;; Generic dispatcher commands
8870 ;; Macro `define-alternatives' is used to create generic commands.
8871 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8872 ;; that can have different alternative implementations where choosing
8873 ;; among them is exclusively a matter of user preference.
8875 ;; (define-alternatives COMMAND) creates a new interactive command
8876 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8877 ;; Typically, the user will not need to customize this variable; packages
8878 ;; wanting to add alternative implementations should use
8879 ;;
8880 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8882 (defmacro define-alternatives (command &rest customizations)
8883 "Define the new command `COMMAND'.
8885 The argument `COMMAND' should be a symbol.
8887 Running `M-x COMMAND RET' for the first time prompts for which
8888 alternative to use and records the selected command as a custom
8889 variable.
8891 Running `C-u M-x COMMAND RET' prompts again for an alternative
8892 and overwrites the previous choice.
8894 The variable `COMMAND-alternatives' contains an alist with
8895 alternative implementations of COMMAND. `define-alternatives'
8896 does not have any effect until this variable is set.
8898 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8899 `defcustom' keywords and values to add to the declaration of
8900 `COMMAND-alternatives' (typically :group and :version)."
8901 (let* ((command-name (symbol-name command))
8902 (varalt-name (concat command-name "-alternatives"))
8903 (varalt-sym (intern varalt-name))
8904 (varimp-sym (intern (concat command-name "--implementation"))))
8905 `(progn
8907 (defcustom ,varalt-sym nil
8908 ,(format "Alist of alternative implementations for the `%s' command.
8910 Each entry must be a pair (ALTNAME . ALTFUN), where:
8911 ALTNAME - The name shown at user to describe the alternative implementation.
8912 ALTFUN - The function called to implement this alternative."
8913 command-name)
8914 :type '(alist :key-type string :value-type function)
8915 ,@customizations)
8917 (put ',varalt-sym 'definition-name ',command)
8918 (defvar ,varimp-sym nil "Internal use only.")
8920 (defun ,command (&optional arg)
8921 ,(format "Run generic command `%s'.
8922 If used for the first time, or with interactive ARG, ask the user which
8923 implementation to use for `%s'. The variable `%s'
8924 contains the list of implementations currently supported for this command."
8925 command-name command-name varalt-name)
8926 (interactive "P")
8927 (when (or arg (null ,varimp-sym))
8928 (let ((val (completing-read
8929 ,(format-message
8930 "Select implementation for command `%s': "
8931 command-name)
8932 ,varalt-sym nil t)))
8933 (unless (string-equal val "")
8934 (when (null ,varimp-sym)
8935 (message
8936 "Use C-u M-x %s RET`to select another implementation"
8937 ,command-name)
8938 (sit-for 3))
8939 (customize-save-variable ',varimp-sym
8940 (cdr (assoc-string val ,varalt-sym))))))
8941 (if ,varimp-sym
8942 (call-interactively ,varimp-sym)
8943 (message "%s" ,(format-message
8944 "No implementation selected for command `%s'"
8945 command-name)))))))
8947 \f
8948 ;;; Functions for changing capitalization that Do What I Mean
8949 (defun upcase-dwim (arg)
8950 "Upcase words in the region, if active; if not, upcase word at point.
8951 If the region is active, this function calls `upcase-region'.
8952 Otherwise, it calls `upcase-word', with prefix argument passed to it
8953 to upcase ARG words."
8954 (interactive "*p")
8955 (if (use-region-p)
8956 (upcase-region (region-beginning) (region-end))
8957 (upcase-word arg)))
8959 (defun downcase-dwim (arg)
8960 "Downcase words in the region, if active; if not, downcase word at point.
8961 If the region is active, this function calls `downcase-region'.
8962 Otherwise, it calls `downcase-word', with prefix argument passed to it
8963 to downcase ARG words."
8964 (interactive "*p")
8965 (if (use-region-p)
8966 (downcase-region (region-beginning) (region-end))
8967 (downcase-word arg)))
8969 (defun capitalize-dwim (arg)
8970 "Capitalize words in the region, if active; if not, capitalize word at point.
8971 If the region is active, this function calls `capitalize-region'.
8972 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8973 to capitalize ARG words."
8974 (interactive "*p")
8975 (if (use-region-p)
8976 (capitalize-region (region-beginning) (region-end))
8977 (capitalize-word arg)))
8979 \f
8981 (provide 'simple)
8983 ;;; simple.el ends here