| blob | 4db81071b589ec160d80bb47f94826b21ad951d3 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2017 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "If non-nil, output buffer is not erased between shell commands.
42 Also, a non-nil value sets the point in the output buffer
43 once the command completes.
44 The value `beg-last-out' sets point at the beginning of the output,
45 `end-last-out' sets point at the end of the buffer, `save-point'
46 restores the buffer position before the command."
56 "Record of point positions in output buffers after command completion.
57 The value is an alist whose elements are of the form (BUFFER . POS),
58 where BUFFER is the output buffer, and POS is the point position
59 in BUFFER once the command finishes.
63 "Idle time delay before updating various things on the screen.
64 Various Emacs features that update auxiliary information when point moves
65 wait this many seconds after Emacs becomes idle before doing an update."
71 "Killing and yanking commands."
75 "Highlight (un)matching of parens and expressions."
77 \f
78 ;;; next-error support framework
81 "`next-error' support framework."
87 "Face used to highlight next error locus."
92 "Highlighting of locations in selected source buffers.
93 If a number, highlight the locus in `next-error' face for the given time
94 in seconds, or until the next command is executed.
95 If t, highlight the locus until the next command is executed, or until
96 some other locus replaces it.
97 If nil, don't highlight the locus in the source buffer.
98 If `fringe-arrow', indicate the locus by the fringe arrow
99 indefinitely until some other locus replaces it."
108 "Highlighting of locations in `next-error-no-select'.
109 If number, highlight the locus in `next-error' face for given time in seconds.
110 If t, highlight the locus indefinitely until some other locus replaces it.
111 If nil, don't highlight the locus in the source buffer.
112 If `fringe-arrow', indicate the locus by the fringe arrow
113 indefinitely until some other locus replaces it."
122 "Display the line in the visited source file recentered as specified.
123 If non-nil, the value is passed directly to `recenter'."
131 "List of hook functions run by `next-error' after visiting source file."
142 "The most recent `next-error' buffer.
143 A buffer becomes most recent when its compilation, grep, or
148 "Function to use to find the next error in the current buffer.
149 The function is called with 2 parameters:
150 ARG is an integer specifying by how many errors to move.
151 RESET is a boolean which, if non-nil, says to go back to the beginning
152 of the errors before moving.
153 Major modes providing compile-like functionality should set this variable
154 to indicate to `next-error' that this is a candidate buffer and how
159 "Function to use to move to an error locus.
160 It takes two arguments, a buffer position in the error buffer
161 and a buffer position in the error locus buffer.
162 The buffer for the error locus should already be current.
167 &optional avoid-current
168 extra-test-inclusive
169 extra-test-exclusive)
170 "Return non-nil if BUFFER is a `next-error' capable buffer.
171 If AVOID-CURRENT is non-nil, and BUFFER is the current buffer,
172 return nil.
174 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if
175 BUFFER would not normally qualify. If it returns non-nil, BUFFER
176 is considered `next-error' capable, anyway, and the function
177 returns non-nil.
179 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the
180 buffer would normally qualify. If it returns nil, BUFFER is
181 rejected, and the function returns nil."
186 ;; Optionally reject some buffers.
189 t)
190 ;; Optionally accept some other buffers.
195 extra-test-inclusive
196 extra-test-exclusive)
197 "Return a `next-error' capable buffer.
199 If AVOID-CURRENT is non-nil, treat the current buffer
200 as an absolute last resort only.
202 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
203 that normally would not qualify. If it returns t, the buffer
204 in question is treated as usable.
206 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
207 that would normally be considered usable. If it returns nil,
208 that buffer is rejected."
210 ;; 1. If one window on the selected frame displays such buffer, return it.
216 avoid-current
217 extra-test-inclusive extra-test-exclusive)
222 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
225 extra-test-inclusive extra-test-exclusive))
226 next-error-last-buffer)
227 ;; 3. If the current buffer is acceptable, choose it.
229 extra-test-inclusive extra-test-exclusive)
231 ;; 4. Look for any acceptable buffer.
236 extra-test-inclusive extra-test-exclusive)))
239 ;; 5. Use the current buffer as a last resort if it qualifies,
240 ;; even despite AVOID-CURRENT.
243 extra-test-inclusive extra-test-exclusive)
247 ;; 6. Give up.
251 "Visit next `next-error' message and corresponding source code.
253 If all the error messages parsed so far have been processed already,
254 the message buffer is checked for new ones.
256 A prefix ARG specifies how many error messages to move;
257 negative means move back to previous error messages.
259 and start at the first error.
261 The RESET argument specifies that we should restart from the beginning.
264 compilation, grep, or occur buffer. It can also operate on any
266 more generally, on any buffer in Compilation mode or with
267 Compilation Minor mode enabled, or any buffer in which
268 `next-error-function' is bound to an appropriate function.
269 To specify use of a particular buffer for error messages, type
271 in the current frame.
274 runs `next-error-hook' with `run-hooks', and stays with that buffer
275 until you use it in some other buffer which uses Compilation mode
276 or Compilation Minor mode.
278 To control which errors are matched, customize the variable
279 `compilation-error-regexp-alist'."
283 ;; we know here that next-error-function is a valid symbol we can funcall
291 "Visit the source code corresponding to the `next-error' message at point."
293 ;; we know here that next-error-function is a valid symbol we can funcall
304 "Visit previous `next-error' message and corresponding source code.
306 Prefix arg N says how many error messages to move backwards (or
307 forwards, if negative).
314 "Restart at the first error.
315 Visit corresponding source code.
316 With prefix arg N, visit the source code of the Nth error.
322 "Move point to the next error in the `next-error' buffer and highlight match.
323 Prefix arg N says how many error messages to move forwards (or
324 backwards, if negative).
326 select the source buffer."
333 "Move point to the previous error in the `next-error' buffer and highlight match.
334 Prefix arg N says how many error messages to move backwards (or
335 forwards, if negative).
337 select the source buffer."
341 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
345 "Minor mode for compilation, occur and diff modes.
346 With a prefix argument ARG, enable mode if ARG is positive, and
347 disable it otherwise. If called from Lisp, enable mode if ARG is
348 omitted or nil.
349 When turned on, cursor motion in the compilation, grep, occur or diff
350 buffer causes automatic display of the corresponding source code location."
357 ;; Used as a `post-command-hook' by `next-error-follow-mode'
358 ;; for the *Compilation* *grep* and *Occur* buffers.
368 \f
369 ;;;
372 "Major mode not specialized for anything in particular.
373 Other major modes are defined by comparison with this one."
378 ;; Special major modes to view specially formatted data rather than files.
392 map))
396 "Parent major mode from which special major modes should inherit."
399 ;; Making and deleting lines.
402 "Special hook to tell if `self-insert-command' will use the region.
403 It must be called via `run-hook-with-args-until-success' with no arguments.
404 Any `post-self-insert-command' which consumes the region should
405 register a function on this hook so that things like `delete-selection-mode'
412 "Insert a newline, and move to left margin of the new line if it's blank.
413 If option `use-hard-newlines' is non-nil, the newline is marked with the
414 text-property `hard'.
415 With ARG, insert that many newlines.
417 If `electric-indent-mode' is enabled, this indents the final new line
418 that it adds, and reindents the preceding line. To just insert
421 Calls `auto-fill-function' if the current column number is greater
422 than the value of `fill-column' and ARG is nil.
423 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
426 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
427 ;; Set last-command-event to tell self-insert what to insert.
431 ;; Don't auto-fill if we have a numeric argument.
435 ;; Do the rest in post-self-insert-hook, because we want to do it
436 ;; *before* other functions on that hook.
438 ;; Mark the newline(s) `hard'.
442 ;; If the newline leaves the previous line blank, and we
443 ;; have a left margin, delete that from the blank line.
451 ;; Indent the line after the newline, except in one case:
452 ;; when we added the newline at the beginning of a line which
453 ;; starts a page.
457 ;; FIXME: For non-interactive uses, many calls actually
458 ;; just want (insert "\n"), so maybe we should do just
459 ;; that, so as to avoid the risk of filling or running
460 ;; abbrevs unexpectedly.
467 ;; We first used let-binding to protect the hook, but that
468 ;; was naive since add-hook affects the symbol-default
469 ;; value of the variable, whereas the let-binding might
470 ;; only protect the buffer-local value.
472 nil)
477 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
483 "Insert a newline and leave point before it.
484 If there is a fill prefix and/or a `left-margin', insert them on
485 the new line if the line would have been blank.
486 With arg N, insert N newlines."
491 ;; Don't expand an abbrev before point.
502 ;; Necessary in case a margin or prefix was inserted.
506 "Split current line, moving portion beyond point vertically down.
507 If the current line starts with `fill-prefix', insert it on the new
508 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
510 When called from Lisp code, ARG may be a prefix string to copy."
515 ;; What prefix should we check for (nil means don't).
519 ;; Does this line start with it?
530 "Join this line to previous and fix up whitespace at join.
531 If there is a fill prefix, delete it from the beginning of this line.
532 With argument, join this line to following line."
539 ;; If the second line started with the fill prefix,
540 ;; delete the prefix.
552 "On blank line, delete all surrounding blank lines, leaving just one.
553 On isolated blank line, delete that one.
554 On nonblank line, delete any immediately following blank lines."
560 ;; Set singleblank if there is just one blank line here.
567 ;; Delete preceding blank lines, and this one too if it's the only one.
576 ;; Delete following blank lines, unless the current line is blank
577 ;; and there are no following blank lines.
586 ;; Handle the special case where point is followed by newline and eob.
587 ;; Delete the line, leaving point at eob.
593 Trailing lines are deleted only if `delete-trailing-whitespace'
594 is called on the entire buffer (rather than an active region)."
600 "Return non-nil if the region contains no read-only text."
605 "Delete trailing whitespace between START and END.
606 If called interactively, START and END are the start/end of the
607 region if the mark is active, or of the buffer's accessible
608 portion if the mark is inactive.
610 This command deletes whitespace characters after the last
611 non-whitespace character in each line between START and END. It
612 does not consider formfeed characters to be whitespace.
614 If this command acts on the entire buffer (i.e. if called
615 interactively with the mark inactive, or called from Lisp with
616 END nil), it also deletes all trailing lines at the end of the
617 buffer if the variable `delete-trailing-lines' is non-nil."
628 ;; Don't delete formfeeds, even if they are considered whitespace.
637 ;; Delete trailing empty lines.
639 ;; Really the end of buffer.
644 ;; Return nil for the benefit of `write-file-functions'.
645 nil)
648 "Insert a newline, then indent according to major mode.
649 Indentation is done using the value of `indent-line-function'.
650 In programming language modes, this is the same as TAB.
651 In some text modes, where TAB inserts a tab, this command indents to the
652 column specified by the function `current-left-margin'."
659 "Reindent current line, insert newline, then indent the new line.
660 Indentation of both lines is done according to the current major mode,
661 which means calling the current value of `indent-line-function'.
662 In programming language modes, this is the same as TAB.
663 In some text modes, where TAB inserts a tab, this indents to the
664 column specified by the function `current-left-margin'."
667 ;; Be careful to insert the newline before indenting the line.
668 ;; Otherwise, the indentation might be wrong.
672 ;; We are at EOL before the call to indent-according-to-mode, and
673 ;; after it we usually are as well, but not always. We tried to
674 ;; address it with `save-excursion' but that uses a normal marker
675 ;; whereas we need `move after insertion', so we do the save/restore
676 ;; by hand.
680 ;; Remove the trailing white-space after indentation because
681 ;; indentation may introduce the whitespace.
687 Legitimate radix values are 8, 10 and 16."
692 "Like `read-char', but do not allow quitting.
693 Also, if the first character read is an octal digit,
694 we read any number of octal digits and return the
695 specified character code. Any nondigit terminates the sequence.
696 If the terminator is RET, it is discarded;
697 any other terminator is used itself as input.
699 The optional argument PROMPT specifies a string to use to prompt the user.
700 The variable `read-quoted-char-radix' controls which radix to use
701 for numeric input."
704 help-event-list)))
708 ;; Don't let C-h or other help chars get the help
709 ;; message--only help function keys. See bug#16617.
713 "Type the special character you want to use,
714 or the octal character code.
715 RET terminates the character code and is discarded;
719 ;; Translate TAB key into control-I ASCII character, and so on.
720 ;; Note: `read-char' does it using the `ascii-character' property.
721 ;; We tried using read-key instead, but that disables the keystroke
722 ;; echo produced by 'C-q', see bug#24635.
726 char)))
732 done t))
734 ;; Turn a meta-character into a character with the 0200 bit set.
736 done t))
751 done t))
753 done t)))
755 code))
758 "Read next input character and insert it.
759 This is useful for inserting control characters.
760 With argument, insert ARG copies of the character.
762 If the first character you type after this command is an octal digit,
763 you should type a sequence of octal digits which specify a character code.
764 Any nondigit terminates the sequence. If the terminator is a RET,
765 it is discarded; any other terminator is used itself as input.
766 The variable `read-quoted-char-radix' specifies the radix for this feature;
767 set it to 10 or 16 to use decimal or hex instead of octal.
769 In overwrite mode, this function inserts the character anyway, and
770 does not handle octal digits specially. This means that if you use
771 overwrite as your normal editing mode, you can use this function to
772 insert characters when necessary.
774 In binary overwrite mode, this function does overwrite, and octal
775 digits are interpreted as a character code. This is intended to be
776 useful for editing binary files."
779 ;; Avoid "obsolete" warnings for translation-table-for-input.
786 ;; This used to assume character codes 0240 - 0377 stand for
787 ;; characters in some single-byte character set, and converted them
788 ;; to Emacs characters. But in 23.1 this feature is deprecated
789 ;; in favor of inserting the corresponding Unicode characters.
790 ;; (if (and enable-multibyte-characters
791 ;; (>= char ?\240)
792 ;; (<= char ?\377))
793 ;; (setq char (unibyte-char-to-multibyte char)))
805 "Move forward ARG lines and position at first nonblank character."
811 "Move backward ARG lines and position at first nonblank character."
817 "Move point to the first non-whitespace character on this line."
821 ;; Move back over chars that have whitespace syntax but have the p flag.
825 "Fixup white space between objects around point.
826 Leave one space or none, according to the context."
833 nil
837 "Delete all spaces and tabs around point.
838 If BACKWARD-ONLY is non-nil, only delete them before point."
843 orig-pos
852 "Delete all spaces and tabs around point, leaving one space (or N spaces).
853 If N is negative, delete newlines as well, leaving -N spaces.
854 See also `cycle-spacing'."
859 "Store context used in consecutive calls to `cycle-spacing' command.
860 The first time `cycle-spacing' runs, it saves in this variable:
861 its N argument, the original point position, and the original spacing
865 "Manipulate whitespace around point in a smart way.
866 In interactive use, this function behaves differently in successive
867 consecutive calls.
869 The first call in a sequence acts like `just-one-space'.
870 It deletes all spaces and tabs around point, leaving one space
871 \(or N spaces). N is the prefix argument. If N is negative,
872 it deletes newlines as well, leaving -N spaces.
873 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
875 The second call in a sequence deletes all spaces.
877 The third call in a sequence restores the original whitespace (and point).
879 If MODE is `single-shot', it only performs the first step in the sequence.
880 If MODE is `fast' and the first step would not result in any change
881 \(i.e., there are exactly (abs N) spaces around point),
882 the function goes straight to the second step.
884 Repeatedly calling the function with different values of N starts a
885 new sequence each time."
893 ;; Command run for the first time, single-shot mode or different argument
905 ;; Special handling for case where there was no space at all.
908 ;; If this run causes no change in buffer content, delete all spaces,
909 ;; otherwise delete all excess spaces.
914 ;; Command run for the second time.
918 ;; Command run for the third time.
923 \f
925 "Move point to the beginning of the buffer.
926 With numeric arg N, put point N/10 of the way from the beginning.
927 If the buffer is narrowed, this command uses the beginning of the
928 accessible part of the buffer.
931 is supplied, or Transient Mark mode is enabled and the mark is active."
941 ;; Avoid overflow for large buffer sizes!
949 "Move point to the end of the buffer.
950 With numeric arg N, put point N/10 of the way from the end.
951 If the buffer is narrowed, this command uses the end of the
952 accessible part of the buffer.
955 is supplied, or Transient Mark mode is enabled and the mark is active."
963 ;; Avoid overflow for large buffer sizes!
968 ;; If we went to a place in the middle of the buffer,
969 ;; adjust it to the beginning of a line.
973 ;; If the end of the buffer is not already on the screen,
974 ;; then scroll specially to put it near, but not at, the bottom.
979 "Whether single-char deletion commands delete an active region.
980 This has an effect only if Transient Mark mode is enabled, and
981 affects `delete-forward-char' and `delete-backward-char', though
982 not `delete-char'.
984 If the value is the symbol `kill', the active region is killed
985 instead of deleted."
1002 "Function to get the region's content.
1003 Called with one argument METHOD.
1004 If METHOD is `delete-only', then delete the region; the return value
1005 is undefined. If METHOD is nil, then return the content as a string.
1006 If METHOD is `bounds', then return the boundaries of the region
1007 as a list of cons cells of the form (START . END).
1008 If METHOD is anything else, delete the region and return its content
1009 as a string, after filtering it with `filter-buffer-substring', which
1020 first nil))))
1021 "Function to insert the region's content.
1022 Called with one argument LINES.
1026 "Delete the previous N characters (following if N is negative).
1027 If Transient Mark mode is enabled, the mark is active, and N is 1,
1028 delete the text in the region and deactivate the mark instead.
1029 To disable this, set option `delete-active-region' to nil.
1031 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1032 kill ring) instead of delete. Interactively, N is the prefix
1033 arg, and KILLFLAG is set if N is explicitly specified.
1035 When killing, the killed text is filtered by
1036 `filter-buffer-substring' before it is saved in the kill ring, so
1037 the actual saved text might be different from what was killed.
1039 In Overwrite mode, single character backward deletion may replace
1040 tabs with spaces so as to back over columns, unless point is at
1041 the end of the line."
1047 delete-active-region
1049 ;; If a region is active, kill or delete it.
1053 ;; In Overwrite mode, maybe untabify while deleting
1063 ;; Otherwise, do simple deletion.
1067 "Delete the following N characters (previous if N is negative).
1068 If Transient Mark mode is enabled, the mark is active, and N is 1,
1069 delete the text in the region and deactivate the mark instead.
1070 To disable this, set variable `delete-active-region' to nil.
1072 Optional second arg KILLFLAG non-nil means to kill (save in kill
1073 ring) instead of delete. Interactively, N is the prefix arg, and
1074 KILLFLAG is set if N was explicitly specified.
1076 When killing, the killed text is filtered by
1077 `filter-buffer-substring' before it is saved in the kill ring, so
1078 the actual saved text might be different from what was killed."
1084 delete-active-region
1086 ;; If a region is active, kill or delete it.
1091 ;; Otherwise, do simple deletion.
1095 "Put point at beginning and mark at end of buffer.
1096 If narrowing is in effect, only uses the accessible part of the buffer.
1097 You probably should not use this function in Lisp programs;
1098 it is usually a mistake for a Lisp function to use any subroutine
1099 that uses or sets the mark."
1104 ;; This is really `point-min' in most cases, but if we're in the
1105 ;; minibuffer, this is at the end of the prompt.
1107 \f
1109 ;; Counting lines, one way or another.
1112 "Go to LINE, counting from line 1 at beginning of buffer.
1113 If called interactively, a numeric prefix argument specifies
1114 LINE; without a numeric prefix argument, read LINE from the
1115 minibuffer.
1117 If optional argument BUFFER is non-nil, switch to that buffer and
1119 as argument, BUFFER is the most recently selected other buffer.
1121 Prior to moving point, this function sets the mark (without
1122 activating it), unless Transient Mark mode is enabled and the
1123 mark is already active.
1125 This function is usually the wrong thing to use in a Lisp program.
1126 What you probably want instead is something like:
1127 (goto-char (point-min))
1128 (forward-line (1- N))
1129 If at all possible, an even better solution is to use char counts
1130 rather than line counts."
1135 ;; Look for a default, a number in the buffer at point.
1145 ;; Decide if we're switching buffers.
1153 ;; Read the argument, offering that number (if any) as default.
1156 buffer))))
1157 ;; Switch to the desired buffer, one way or another.
1162 ;; Leave mark at previous position
1164 ;; Move to the specified line number in that buffer.
1173 "Count the number of words in the region.
1174 If called interactively, print a message reporting the number of
1175 lines, words, and characters in the region (whether or not the
1176 region is active); with prefix ARG, report for the entire buffer
1177 rather than the region.
1179 If called from Lisp, return the number of words between positions
1180 START and END."
1192 "Count words between START and END.
1193 If called interactively, START and END are normally the start and
1194 end of the buffer; but if the region is active, START and END are
1195 the start and end of the region. Print a message reporting the
1196 number of lines, words, and chars.
1198 If called from Lisp, return the number of words between START and
1199 END, without printing any message."
1209 words))
1225 str
1233 "Print the current buffer line number and narrowed line number of point."
1246 "Return number of lines between START and END.
1247 This is usually the number of newlines between them,
1248 but can be one more if START is not equal to END
1249 and the greater of them is not at the start of a line."
1265 done)))
1269 "Return buffer line number at position POS.
1270 If POS is nil, use current buffer location.
1272 If ABSOLUTE is nil, the default, counting starts
1273 at (point-min), so the value refers to the contents of the
1274 accessible portion of the (potentially narrowed) buffer. If
1275 ABSOLUTE is non-nil, ignore any narrowing and return the
1276 absolute line number."
1289 "Print info on cursor position (on screen and within buffer).
1290 Also describe the character after point, and give its character code
1291 in octal, decimal and hex.
1293 For a non-ASCII multibyte character, also give its encoding in the
1294 buffer's selected coding system if the coding system encodes the
1295 character safely. If the character is encoded into one byte, that
1296 code is shown in hex. If the character is encoded into more than one
1299 In addition, with prefix argument, show details about that character
1300 in *Help* buffer. See also the command `describe-char'."
1304 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1305 ;; start a directional embedding, which could completely
1306 ;; disrupt the rest of the line (e.g., RLO will display the
1307 ;; rest of the line right-to-left). So we put an invisible
1308 ;; PDF character after these characters, to end the
1309 ;; embedding, which eliminates any effects on the rest of
1310 ;; the line. For RLE and RLO we also append an invisible
1311 ;; LRM, to avoid reordering the following numerical
1312 ;; characters. For LRI/RLI/FSI we append a PDI.
1319 ;; Strong right-to-left characters cause reordering of
1320 ;; the following numerical characters which show the
1321 ;; codepoint, so append LRM to countermand that.
1332 ""
1338 pos total percent beg end col hscroll)
1340 pos total col hscroll))
1342 encoded encoding-msg display-prop under-display)
1349 ;; Check if the character is displayed with some `display'
1350 ;; text property. In that case, set under-display to the
1351 ;; buffer substring covered by that property.
1362 under-display)))
1368 char char char under-display)
1370 char char char under-display display-prop))
1373 char char char
1375 "..."
1379 ;; We show the detailed information about CHAR.
1386 bidi-fixer
1387 encoding-msg pos total percent beg end col hscroll)
1394 bidi-fixer encoding-msg pos total percent col hscroll))))))
1395 \f
1396 ;; Initialize read-expression-map. It is defined at C level.
1400 ;; Might as well bind TAB to completion, since inserting a TAB char is
1401 ;; much too rarely useful.
1404 m))
1407 "Return a Lisp object read using the minibuffer, unevaluated.
1408 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1409 is a string to insert in the minibuffer before reading.
1410 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1411 Such arguments are used as in `read-from-minibuffer'.)"
1412 ;; Used for interactive spec `x'.
1417 "Return value of Lisp expression read using the minibuffer.
1418 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1419 is a string to insert in the minibuffer before reading.
1420 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1421 Such arguments are used as in `read-from-minibuffer'.)"
1422 ;; Used for interactive spec `X'.
1430 "The current default value or list of default values in the minibuffer.
1431 The functions `read-from-minibuffer' and `completing-read' bind
1435 "Value for `print-level' while printing value in `eval-expression'.
1436 A value of nil means no limit."
1442 "Value for `print-length' while printing value in `eval-expression'.
1443 A value of nil means no limit."
1449 "If non-nil set `debug-on-error' to t in `eval-expression'.
1450 If nil, don't change the value of `debug-on-error'."
1456 "The largest integer that will be displayed as a character.
1457 This affects printing by `eval-expression' (via
1458 `eval-expression-print-format')."
1464 "If VALUE in an integer, return a specially formatted string.
1466 If VALUE is not an integer, nil is returned.
1467 This function is used by commands like `eval-expression' that
1468 display the result of expression evaluation."
1486 ;; FIXME: call emacs-lisp-mode?
1494 read-expression-map t
1498 "Get arguments for commands that print an expression result.
1499 Returns a list (INSERT-VALUE NO-TRUNCATE CHAR-PRINT-LIMIT)
1500 based on PREFIX-ARG. This function determines the interpretation
1501 of the prefix argument for `eval-expression' and
1502 `eval-last-sexp'."
1510 ;; We define this, rather than making `eval' interactive,
1511 ;; for the sake of completion of names like eval-region, eval-buffer.
1513 "Evaluate EXP and print value in the echo area.
1514 When called interactively, read an Emacs Lisp expression and
1515 evaluate it. Value is also consed on to front of the variable
1516 `values'. Optional argument INSERT-VALUE non-nil (interactively,
1517 with a non `-' prefix argument) means insert the result into the
1518 current buffer instead of printing it in the echo area.
1520 Normally, this function truncates long output according to the
1521 value of the variables `eval-expression-print-length' and
1522 `eval-expression-print-level'. When NO-TRUNCATE is
1523 non-nil (interactively, with a prefix argument of zero), however,
1524 there is no such truncation.
1526 If the resulting value is an integer, and CHAR-PRINT-LIMIT is
1527 non-nil (interactively, unless given a positive prefix argument)
1528 it will be printed in several additional formats (octal,
1529 hexadecimal, and character). The character format is only used
1530 if the value is below CHAR-PRINT-LIMIT (interactively, if the
1531 prefix argument is -1 or the value is below
1532 `eval-expression-print-maximum-character').
1534 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1535 minibuffer.
1537 If `eval-expression-debug-on-error' is non-nil, which is the default,
1538 this command arranges for all errors to enter the debugger."
1546 ;; Bind debug-on-error to something unique so that we can
1547 ;; detect when evalled code changes it.
1551 ;; If evalled code has changed the value of debug-on-error,
1552 ;; propagate that change to the global binding.
1568 "Prompting with PROMPT, let user edit COMMAND and eval result.
1569 COMMAND is a Lisp expression. Let user edit that expression in
1570 the minibuffer, then read and evaluate the result."
1577 read-expression-map t
1579 ;; If command was added to command-history as a string,
1580 ;; get rid of that. We want only evaluable expressions there.
1584 ;; If command to be redone does not match front of history,
1585 ;; add it to the history.
1591 "Edit and re-evaluate last complex command, or ARGth from last.
1592 A complex command is one which used the minibuffer.
1593 The command is placed in the minibuffer as a Lisp form for editing.
1594 The result is executed, repeating the command as changed.
1595 If the command has been changed or is not the most recent previous
1596 command it is added to the front of the command history.
1597 You can use the minibuffer history commands \
1599 to get different commands to edit and resubmit."
1602 newcmd)
1614 ;; If command was added to command-history as a
1615 ;; string, get rid of that. We want only
1616 ;; evaluable expressions there.
1620 ;; If command to be redone does not match front of history,
1621 ;; add it to the history.
1636 "Read command name to invoke in `execute-extended-command'."
1646 ;; Get a command name at point in the original buffer
1647 ;; to propose it after M-n.
1651 ;; Read a string, completing from and restricting to the set of
1652 ;; all defined commands. Don't provide any initial input.
1653 ;; Save the command read on the extended-command history list.
1664 ;; This isn't strictly correct if `execute-extended-command'
1665 ;; is bound to anything else (e.g. [menu]).
1666 ;; It could use (key-description (this-single-command-keys)),
1667 ;; but actually a prompt other than "M-x" would be confusing,
1668 ;; because "M-x" is a well-known prompt to read a command
1669 ;; and it serves as a shorthand for "Extended command: ".
1674 ;; Exclude obsolete commands from completions.
1679 pred)))
1684 "Non-nil means show the equivalent key-binding when M-x command has one.
1685 The value can be a length of time to show the message for.
1686 If the value is non-nil and not a number, we wait 2 seconds."
1693 "If non-nil, show a shorter M-x invocation when there is one."
1714 binding)
1720 name len)))
1721 ;; Don't show the help message if the binding isn't
1722 ;; significantly shorter than the M-x command the user typed.
1730 binding))
1733 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1734 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1735 "Read a command name, then read the arguments and call the command.
1736 To pass a prefix argument to the command you are
1737 invoking, give a prefix argument to `execute-extended-command'."
1739 ;; FIXME: Remember the actual text typed by the user before completion,
1740 ;; so that we don't later on suggest the same shortening.
1745 execute-extended-command--last-typed)))
1746 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1758 ;; Some features, such as novice.el, rely on this-command-keys
1759 ;; including M-x COMMAND-NAME RET.
1762 ;; Normally `real-this-command' should never be changed, but here we really
1763 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1764 ;; binding" for <cmd>, so the command the user really wanted to run is
1765 ;; `function' and not `execute-extended-command'. The difference is
1766 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1770 ;; If enabled, show which key runs this command.
1771 ;; But first wait, and skip the message if there is input.
1773 ;; If this command displayed something in the echo area;
1774 ;; wait a few seconds, then display our suggestion message.
1775 ;; FIXME: Wait *after* running post-command-hook!
1776 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1777 ;; find a better answer anyway!
1787 ;; There's no binding for CMD. Let's try and find the shortest
1788 ;; string to use in M-x.
1789 ;; FIXME: Can be slow. Cache it maybe?
1796 function
1801 suggest-key-bindings
1805 ;; BEWARE: Called directly from the C code.
1806 "Execute CMD as an editor command.
1807 CMD must be a symbol that satisfies the `commandp' predicate.
1808 Optional second arg RECORD-FLAG non-nil
1809 means unconditionally put this command in the variable `command-history'.
1810 Otherwise, that is done only if an arg is read using the minibuffer.
1811 The argument KEYS specifies the value to use instead of (this-command-keys)
1812 when reading the arguments; if it is nil, (this-command-keys) is used.
1813 The argument SPECIAL, if non-nil, means that this command is executing
1814 a special event, so ignore the prefix argument and don't clear it."
1817 ;; FIXME: This should probably be done around
1818 ;; pre-command-hook rather than here!
1826 disabled-command-function)
1827 ;; FIXME: Weird calling convention!
1837 ;; If requested, place the macro in the command history. For
1838 ;; other sorts of commands, call-interactively takes care of this.
1841 ;; Don't keep command history around forever.
1847 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1855 \f
1857 "Default minibuffer history list.
1858 This is used for all minibuffer input
1859 except when an alternate history list is specified.
1861 Maximum length of the history list is determined by the value
1864 "Control whether history list elements are expressions or strings.
1865 If the value of this variable equals current minibuffer depth,
1866 they are expressions; otherwise they are strings.
1867 \(That convention is designed to do the right thing for
1874 "Text that was in this minibuffer before any history commands.
1875 This is nil if there have not yet been any history commands
1884 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1889 "Minibuffer history variables for which matching should ignore case.
1890 If a history variable is a member of this list, then the
1892 commands ignore case when searching it, regardless of `case-fold-search'."
1897 "Find the previous history element that matches REGEXP.
1898 \(Previous history elements refer to earlier actions.)
1899 With prefix argument N, search for Nth previous match.
1900 If N is negative, find the next or Nth next match.
1901 Normally, history elements are matched case-insensitively if
1902 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1903 makes the search case-sensitive.
1904 See also `minibuffer-history-case-insensitive-variables'."
1908 nil
1909 minibuffer-local-map
1910 nil
1911 'minibuffer-history-search-history
1913 ;; Use the last regexp specified, by default, if input is empty.
1918 regexp)
1928 ;; On some systems, ignore case for file names.
1930 minibuffer-history-case-insensitive-variables)
1931 t
1932 ;; Respect the user's setting for case-fold-search:
1933 case-fold-search)
1934 nil))
1935 prevpos
1936 match-string
1937 match-offset
1944 "No later matching history item"
1965 next-matching-history-element))
1969 "Find the next history element that matches REGEXP.
1970 \(The next history element refers to a more recent action.)
1971 With prefix argument N, search for Nth next match.
1972 If N is negative, find the previous or Nth previous match.
1973 Normally, history elements are matched case-insensitively if
1974 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1975 makes the search case-sensitive."
1979 nil
1980 minibuffer-local-map
1981 nil
1982 'minibuffer-history-search-history
1984 ;; Use the last regexp specified, by default, if input is empty.
1989 regexp)
1996 "Function run by `goto-history-element' before consuming default values.
1997 This is useful to dynamically add more elements to the list of default values
1998 when `goto-history-element' reaches the end of this list.
1999 Before calling this function `goto-history-element' sets the variable
2000 `minibuffer-default-add-done' to t, so it will call this function only
2001 once. In special cases, when this function needs to be called more
2002 than once, it can set `minibuffer-default-add-done' to nil explicitly,
2006 "When nil, add more elements to the end of the list of default values.
2007 The value nil causes `goto-history-element' to add more elements to
2008 the list of defaults when it reaches the end of this list. It does
2014 "Return a list of all completions without the default value.
2015 This function is used to add all elements of the completion table to
2016 the end of the list of defaults just after the default value."
2019 minibuffer-completion-table
2020 minibuffer-completion-predicate)))
2026 "Puts element of the minibuffer history in the minibuffer.
2027 The argument NABS specifies the absolute history position."
2041 elt minibuffer-returned-to-present)
2048 "End of defaults; no next item"
2055 previous-history-element))
2067 minibuffer-default)))
2079 elt))
2083 "Puts next element of the minibuffer history in the minibuffer.
2084 With argument N, it uses the Nth following element."
2090 "Puts previous element of the minibuffer history in the minibuffer.
2091 With argument N, it uses the Nth previous element."
2097 "Move cursor vertically down ARG lines, or to the next history element.
2098 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2099 next element of the minibuffer history in the minibuffer."
2103 ;; Remember the original goal column of possibly multi-line input
2104 ;; excluding the length of the prompt on the first line.
2114 ;; Restore old position since `line-move-visual' moves point to
2115 ;; the end of the line when it fails to go to the next line.
2118 ;; Reset `temporary-goal-column' because a correct value is not
2119 ;; calculated when `next-line' above fails by bumping against
2120 ;; the bottom of the minibuffer (bug#22544).
2122 ;; Restore the original goal column on the last line
2123 ;; of possibly multi-line input.
2131 "Move cursor vertically up ARG lines, or to the previous history element.
2132 When point moves over the top line of multi-line minibuffer, puts ARGth
2133 previous element of the minibuffer history in the minibuffer."
2137 ;; Remember the original goal column of possibly multi-line input
2138 ;; excluding the length of the prompt on the first line.
2148 ;; Restore old position since `line-move-visual' moves point to
2149 ;; the beginning of the line when it fails to go to the previous line.
2152 ;; Reset `temporary-goal-column' because a correct value is not
2153 ;; calculated when `previous-line' above fails by bumping against
2154 ;; the top of the minibuffer (bug#22544).
2156 ;; Restore the original goal column on the first line
2157 ;; of possibly multi-line input.
2163 ;; Put the cursor at the end of the visual line instead of the
2164 ;; logical line, so the next `previous-line-or-history-element'
2165 ;; would move to the previous history element, not to a possible upper
2166 ;; visual line from the end of logical line in `line-move-visual' mode.
2168 ;; Since `end-of-visual-line' puts the cursor at the beginning
2169 ;; of the next visual line, move it one char back to the end
2170 ;; of the first visual line (bug#22544).
2174 "Get next history element which completes the minibuffer before the point.
2175 The contents of the minibuffer after the point are deleted, and replaced
2176 by the new completion."
2182 n)
2183 ;; next-matching-history-element always puts us at (point-min).
2184 ;; Move to the position we were at before changing the buffer contents.
2185 ;; This is still sensible, because the text before point has not changed.
2189 "\
2190 Get previous history element which completes the minibuffer before the point.
2191 The contents of the minibuffer after the point are deleted, and replaced
2192 by the new completion."
2196 ;; For compatibility with the old subr of the same name.
2198 "Return the display width of the minibuffer prompt.
2199 Return 0 if current buffer is not a minibuffer."
2200 ;; Return the width of everything before the field at the end of
2201 ;; the buffer; this should be 0 for normal buffers.
2203 \f
2204 ;; isearch minibuffer history
2211 "Set up a minibuffer for using isearch to search the minibuffer history.
2212 Intended to be added to `minibuffer-setup-hook'."
2224 "Clean up the minibuffer after terminating isearch in the minibuffer."
2229 "Return the proper search function, for isearch in minibuffer history."
2232 ;; Use standard functions to search within minibuffer text
2234 found)
2235 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2236 ;; searching forward. Lazy-highlight calls this lambda with the
2237 ;; bound arg, so skip the minibuffer prompt.
2241 ;; 1. First try searching in the initial minibuffer text
2244 noerror)
2245 ;; 2. If the above search fails, start putting next/prev history
2246 ;; elements in the minibuffer successively, and search the string
2247 ;; in them. Do this only when bound is nil (i.e. not while
2248 ;; lazy-highlighting search strings in the current minibuffer text).
2260 ;; After putting the next/prev history element, search
2261 ;; the string in them again, until next-history-element
2262 ;; or previous-history-element raises an error at the
2263 ;; beginning/end of history.
2266 ;; For backward search, don't search
2267 ;; in the minibuffer prompt
2269 noerror)))
2270 ;; Return point of the new search result
2272 ;; Return nil when next(prev)-history-element fails
2276 "Display the minibuffer history search prompt.
2277 If there are no search errors, this function displays an overlay with
2278 the isearch prompt which replaces the original minibuffer prompt.
2279 Otherwise, it displays the standard isearch message returned from
2280 the function `isearch-message'."
2282 ;; Use standard function `isearch-message' when not in the minibuffer,
2283 ;; or search fails, or has an error (like incomplete regexp).
2284 ;; This function overwrites minibuffer text with isearch message,
2285 ;; so it's possible to see what is wrong in the search string.
2287 ;; Otherwise, put the overlay with the standard isearch prompt over
2288 ;; the initial minibuffer prompt.
2297 ;; And clear any previous isearch message.
2301 "Wrap the minibuffer history search when search fails.
2302 Move point to the first history element for a forward search,
2303 or to the last history element for a backward search."
2304 ;; When `minibuffer-history-isearch-search' fails on reaching the
2305 ;; beginning/end of the history, wrap the search to the first/last
2306 ;; minibuffer history element.
2314 "Save a function restoring the state of minibuffer history search.
2315 Save `minibuffer-history-position' to the additional state parameter
2316 in the search status stack."
2322 "Restore the minibuffer history search state.
2323 Go to the history element by the absolute history position HIST-POS."
2326 \f
2327 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2331 "Table mapping redo records to the corresponding undo one.
2332 A redo record for undo-in-region maps to t.
2342 "Within a run of consecutive undo commands, list remaining to be undone.
2346 "Undo some previous changes.
2347 Repeat this command to undo more changes.
2348 A numeric ARG serves as a repeat count.
2350 In Transient Mark mode when the mark is active, only undo changes within
2352 as an argument limits undo to changes within the current region."
2354 ;; Make last-command indicate for the next command that this was an undo.
2355 ;; That way, another undo will undo more.
2356 ;; If we get to the end of the undo history and get an error,
2357 ;; another undo command will find the undo history empty
2358 ;; and will get another error. To begin undoing the undos,
2359 ;; you must type some other command.
2361 ;; For an indirect buffer, look in the base buffer for the
2362 ;; auto-save data.
2366 message)
2367 ;; If we get an error in undo-start,
2368 ;; the next command should not be a "consecutive undo".
2369 ;; So set `this-command' to something other than `undo'.
2374 ;; If something (a timer or filter?) changed the buffer
2375 ;; since the previous command, don't continue the undo seq.
2379 ;; If the last undo record made was made by undo
2380 ;; it shows nothing else happened in between.
2387 ;; get rid of initial undo boundary
2389 ;; If we got this far, the next command should be a consecutive undo.
2391 ;; Check to see whether we're hitting a redo record, and if
2392 ;; so, ask the user whether she wants to skip the redo/undo pair.
2400 ;; The equiv entry might point to another redo record if we have done
2401 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2409 ;; Record the fact that the just-generated undo records come from an
2410 ;; undo operation--that is, they are redo records.
2411 ;; In the ordinary case (not within a region), map the redo
2412 ;; record to the following undos.
2413 ;; I don't know how to do that in the undo-in-region case.
2415 ;; Strip any leading undo boundaries there might be, like we do
2416 ;; above when checking.
2420 ;; Prevent identity mapping. This can happen if
2421 ;; consecutive nils are erroneously in undo list.
2423 t
2424 pending-undo-list)
2425 undo-equiv-table))
2426 ;; Don't specify a position in the undo record for the undo command.
2427 ;; Instead, undoing this should move point to where the change is.
2446 ;; Record what the current undo list says,
2447 ;; so the next command can tell if the buffer was modified in between.
2451 ;; Display a message announcing success.
2456 "Make BUFFER stop keeping undo information.
2457 No argument or nil as argument means do this for the current buffer."
2463 "Undo some previous changes.
2464 Repeat this command to undo more changes.
2465 A numeric ARG serves as a repeat count.
2466 Contrary to `undo', this will not redo a previous undo."
2471 "Non-nil while performing an undo.
2475 "Undo back N undo-boundaries beyond what was already undone recently.
2476 Call `undo-start' to get ready to undo recent changes,
2477 then call `undo-more' one or more times to undo them."
2482 ;; Note: The following, while pulling elements off
2483 ;; `pending-undo-list' will call primitive change functions which
2484 ;; will push more elements onto `buffer-undo-list'.
2490 "Undo N records from the front of the list LIST.
2491 Return what remains of the list."
2493 ;; This is a good feature, but would make undo-start
2494 ;; unable to do what is expected.
2495 ;;(when (null (car (list)))
2496 ;; ;; If the head of the list is a boundary, it is the boundary
2497 ;; ;; preceding this command. Get rid of it and don't count it.
2498 ;; (setq list (cdr list))))
2501 ;; In a writable buffer, enable undoing read-only text that is
2502 ;; so because of text properties.
2504 ;; Don't let `intangible' properties interfere with undo.
2506 ;; We use oldlist only to check for EQ. ++kfs
2512 ;; Handle an integer by setting point to that value.
2515 ;; Element (t . TIME) records previous modtime.
2516 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2517 ;; UNKNOWN_MODTIME_NSECS.
2519 ;; If this records an obsolete save
2520 ;; (not matching the actual disk file)
2521 ;; then don't mark unmodified.
2529 ;; Element (nil PROP VAL BEG . END) is property change.
2534 ;; Element (BEG . END) means range was inserted.
2536 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2537 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2540 ;; Set point first thing, so that undoing this undo
2541 ;; does not send point back to where it is now.
2544 ;; Element (apply FUN . ARGS) means call FUN to undo.
2548 ;; Long format: (apply DELTA START END FUN . ARGS).
2555 ;; Check that the function did what the entry
2556 ;; said it would do.
2566 ;; Element (STRING . POS) means STRING was deleted.
2572 ;; Check that marker adjustments which were recorded
2573 ;; with the (STRING . POS) record are still valid, ie
2574 ;; the markers haven't moved. We check their validity
2575 ;; before reinserting the string so as we don't need to
2576 ;; mind marker insertion-type.
2584 ;; Insert string and adjust point
2592 ;; Adjust the valid marker adjustments
2594 ;; Insert might have invalidated some of the markers
2595 ;; via modification hooks. Update only the currently
2596 ;; valid ones (bug#25599).
2600 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2603 next)
2604 ;; Even though these elements are not expected in the undo
2605 ;; list, adjust them to be conservative for the 24.4
2606 ;; release. (Bug#16818)
2613 ;; Make sure an apply entry produces at least one undo entry,
2614 ;; so the test in `undo' for continuing an undo series
2615 ;; will work right.
2620 list)
2622 ;; Deep copy of a list
2624 "Make a copy of undo list LIST."
2630 elt))
2633 "Set `pending-undo-list' to the front of the undo list.
2634 The next call to `undo-more' will undo the most recently made change.
2635 If BEG and END are specified, then only undo elements
2636 that apply to text between BEG and END are used; other undo elements
2637 are ignored. If BEG and END are nil, all undo elements are used."
2643 buffer-undo-list)))
2645 ;; The positions given in elements of the undo list are the positions
2646 ;; as of the time that element was recorded to undo history. In
2647 ;; general, subsequent buffer edits render those positions invalid in
2648 ;; the current buffer, unless adjusted according to the intervening
2649 ;; undo elements.
2650 ;;
2651 ;; Undo in region is a use case that requires adjustments to undo
2652 ;; elements. It must adjust positions of elements in the region based
2653 ;; on newer elements not in the region so as they may be correctly
2654 ;; applied in the current buffer. undo-make-selective-list
2655 ;; accomplishes this with its undo-deltas list of adjustments. An
2656 ;; example undo history from oldest to newest:
2657 ;;
2658 ;; buf pos:
2659 ;; 123456789 buffer-undo-list undo-deltas
2660 ;; --------- ---------------- -----------
2661 ;; aaa (1 . 4) (1 . -3)
2662 ;; aaba (3 . 4) N/A (in region)
2663 ;; ccaaba (1 . 3) (1 . -2)
2664 ;; ccaabaddd (7 . 10) (7 . -3)
2665 ;; ccaabdd ("ad" . 6) (6 . 2)
2666 ;; ccaabaddd (6 . 8) (6 . -2)
2667 ;; | |<-- region: "caab", from 2 to 6
2668 ;;
2669 ;; When the user starts a run of undos in region,
2670 ;; undo-make-selective-list is called to create the full list of in
2671 ;; region elements. Each element is adjusted forward chronologically
2672 ;; through undo-deltas to determine if it is in the region.
2673 ;;
2674 ;; In the above example, the insertion of "b" is (3 . 4) in the
2675 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2676 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2677 ;; . 6) is assessed as in the region and placed in the selective list.
2678 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2679 ;; due to the selected element. The "b" insertion is the only element
2680 ;; fully in the region, so in this example undo-make-selective-list
2681 ;; returns (nil (5 . 6)).
2682 ;;
2683 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2684 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2685 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2686 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2687 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2688 ;;
2689 ;; More interesting is how to adjust the "ddd" insertion due to the
2690 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2691 ;; If the reinsertion was a manual retyping of "ad", then the total
2692 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2693 ;; the reinsertion was due to undo, one might expect the first "d"
2694 ;; character would again be a part of the "ddd" text, meaning its
2695 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2696 ;;
2697 ;; undo-make-selective-list assumes in this situation that "ad" was a
2698 ;; new edit, even if it was inserted because of an undo.
2699 ;; Consequently, if the user undos in region "8 to 10" of the
2700 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2701 ;; "ccaabad", as though the first "d" became detached from the
2702 ;; original "ddd" insertion. This quirk is a FIXME.
2705 "Return a list of undo elements for the region START to END.
2706 The elements come from `buffer-undo-list', but we keep only the
2707 elements inside this region, and discard those outside this
2708 region. The elements' positions are adjusted so as the returned
2709 list can be applied to the current buffer."
2711 ;; A list of position adjusted undo elements in the region.
2713 ;; A list of undo-deltas for out of region undo elements.
2714 undo-deltas
2715 undo-elt)
2723 ;; Don't put two nils together in the list
2727 ;; This is a "was unmodified" element. Keep it
2728 ;; if we have kept everything thus far.
2731 ;; Skip over marker adjustments, instead relying
2732 ;; on finding them after (TEXT . POS) elements
2734 nil)
2737 undo-deltas)))
2742 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2743 ;; kept. primitive-undo may discard them later.
2756 "Determine whether UNDO-ELT falls inside the region START ... END.
2757 If it crosses the edge, we return nil.
2759 Generally this function is not useful for determining
2760 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2761 because markers can be arbitrarily relocated. Instead, pass the
2762 marker adjustment's corresponding (TEXT . POS) element."
2767 t)
2769 nil)
2771 ;; (TEXT . POSITION)
2775 ;; (MARKER . ADJUSTMENT)
2778 ;; (nil PROPERTY VALUE BEG . END)
2783 ;; (BEGIN . END)
2788 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2789 This assumes we have already decided that UNDO-ELT
2790 is not *inside* the region START...END."
2794 ;; (nil PROPERTY VALUE BEG . END)
2799 ;; (BEGIN . END)
2804 "Return adjustment of undo element ELT by the undo DELTAS
2805 list."
2807 ;; POSITION
2810 ;; (BEG . END)
2813 ;; (TEXT . POSITION)
2817 ;; (nil PROPERTY VALUE BEG . END)
2820 ;; (apply DELTA START END FUN . ARGS)
2821 ;; FIXME
2822 ;; All others return same elt
2825 ;; (BEG . END) can adjust to the same positions, commonly when an
2826 ;; insertion was undone and they are out of region, for example:
2827 ;;
2828 ;; buf pos:
2829 ;; 123456789 buffer-undo-list undo-deltas
2830 ;; --------- ---------------- -----------
2831 ;; [...]
2832 ;; abbaa (2 . 4) (2 . -2)
2833 ;; aaa ("bb" . 2) (2 . 2)
2834 ;; [...]
2835 ;;
2836 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2837 ;; undo. Further adjustments to such an element should be the same as
2838 ;; for (TEXT . POSITION) elements. The options are:
2839 ;;
2840 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2841 ;; analogous to marker insertion-type t.
2842 ;;
2843 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2844 ;; marker insertion-type nil.
2845 ;;
2846 ;; There was no strong reason to prefer one or the other, except that
2847 ;; the first is more consistent with prior undo in region behavior.
2849 "Return cons of adjustments to BEG and END by the undo DELTAS
2850 list."
2852 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2857 "Return adjustment of POS by the undo DELTAS list, comparing
2858 with < or <= based on USE-<."
2864 ;; Don't allow pos to become less than the undo-delta
2865 ;; position. This edge case is described in the overview
2866 ;; comments.
2869 ;; Return the first affected buffer position and the delta for an undo element
2870 ;; delta is defined as the change in subsequent buffer positions if we *did*
2871 ;; the undo.
2875 ;; (TEXT . POSITION)
2878 ;; (BEGIN . END)
2884 ;;; Default undo-boundary addition
2885 ;;
2886 ;; This section adds a new undo-boundary at either after a command is
2887 ;; called or in some cases on a timer called after a change is made in
2888 ;; any buffer.
2890 "Describe the cause of the last undo-boundary.
2892 If `explicit', the last boundary was caused by an explicit call to
2893 `undo-boundary', that is one not called by the code in this
2894 section.
2896 If it is equal to `timer', then the last boundary was inserted
2897 by `undo-auto--boundary-timer'.
2899 If it is equal to `command', then the last boundary was inserted
2900 automatically after a command, that is by the code defined in
2901 this section.
2903 If it is equal to a list, then the last boundary was inserted by
2904 an amalgamating command. The car of the list is the number of
2905 times an amalgamating command has been called, and the cdr are the
2909 "Current timer which will run `undo-auto--boundary-timer' or nil.
2914 "Non-nil if `this-command' should be amalgamated.
2915 This variable is set to nil by `undo-auto--boundaries' and is set
2919 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2923 "Return the number of amalgamating last commands or nil.
2924 Amalgamating commands are, by default, either
2925 `self-insert-command' and `delete-char', but can be any command
2926 that calls `undo-auto-amalgamate'."
2930 "Add an `undo-boundary' to the current buffer if needed.
2931 REASON describes the reason that the boundary is being added; see
2932 `undo-auto--last-boundary' for more information."
2942 undo-auto--undoably-changed-buffers)
2943 cause)))))
2946 "Check recently changed buffers and add a boundary if necessary.
2947 REASON describes the reason that the boundary is being added; see
2948 `undo-last-boundary' for more information."
2949 ;; (Bug #23785) All commands should ensure that there is an undo
2950 ;; boundary whether they have changed the current buffer or not.
2960 "Timer which will run `undo--auto-boundary-timer'."
2965 "Ensure that the `undo-auto-boundary-timer' is set."
2971 "List of buffers that have changed recently.
2973 This list is maintained by `undo-auto--undoable-change' and
2974 `undo-auto--boundaries' and can be affected by changes to their
2978 "Add an `undo-boundary' in appropriate buffers."
2983 'amalgamate
2987 "Amalgamate undo if necessary.
2988 This function can be called before an amalgamating command. It
2989 removes the previous `undo-boundary' if a series of such calls
2990 have been made. By default `self-insert-command' and
2991 `delete-char' are the only amalgamating commands, although this
2992 function could be called by any command wishing to have this
2993 behavior."
2998 last-amalgamating-count
3003 ;; Amalgamate all buffers that have changed.
3007 b
3009 ;; The head of `buffer-undo-list' is nil.
3010 ;; `car-safe' doesn't work because
3011 ;; `buffer-undo-list' need not be a list!
3019 "Called after every undoable buffer change."
3022 ;; End auto-boundary section
3025 "Amalgamate changes in change-group since HANDLE.
3026 Remove all undo boundaries between the state of HANDLE and now.
3027 HANDLE is as returned by `prepare-change-group'."
3036 ;; Temporarily truncate the undo log at ELT.
3041 ;; `elt' is still in the log: normal case.
3043 ;; `elt' is not in the log any more, but that's because
3044 ;; the log is "all new", so we should remove all
3045 ;; boundaries from it.
3049 buffer-undo-list
3050 ;; Preserve the undo-boundaries at either ends of the
3051 ;; change-groups.
3053 ;; Reset the modified cons cell ELT to its original content.
3060 "If non-nil ask about discarding undo info for the current command.
3061 Normally, Emacs discards the undo info for the current command if
3062 it exceeds `undo-outer-limit'. But if you set this option
3063 non-nil, it asks in the echo area whether to discard the info.
3064 If you answer no, there is a slight risk that Emacs might crash, so
3065 only do it if you really want to undo the command.
3067 This option is mainly intended for debugging. You have to be
3068 careful if you use it for other purposes. Garbage collection is
3069 inhibited while the question is asked, meaning that Emacs might
3070 leak memory. So you should make sure that you do not wait
3071 excessively long before answering the question."
3077 "If non-nil, an extra level of size that's ok in an undo item.
3078 We don't ask the user about truncating the undo list until the
3079 current item gets bigger than this amount.
3084 ;; When the first undo batch in an undo list is longer than
3085 ;; undo-outer-limit, this function gets called to warn the user that
3086 ;; the undo info for the current command was discarded. Garbage
3087 ;; collection is inhibited around the call, so it had better not do a
3088 ;; lot of consing.
3094 ;; Don't ask the question again unless it gets even bigger.
3095 ;; This applies, in particular, if the user quits from the question.
3096 ;; Such a quit quits out of GC, but something else will call GC
3097 ;; again momentarily. It will call this function again,
3098 ;; but we don't want to ask the question again.
3102 "Buffer `%s' undo info is %d bytes long; discard it? "
3106 t)
3107 nil))
3113 "The undo info was discarded because it exceeded \
3114 `undo-outer-limit'.
3116 This is normal if you executed a command that made a huge change
3117 to the buffer. In that case, to prevent similar problems in the
3118 future, set `undo-outer-limit' to a value that is large enough to
3119 cover the maximum size of normal changes you expect a single
3120 command to make, but not so large that it might exceed the
3121 maximum memory allotted to Emacs.
3123 If you did not execute any such command, the situation is
3124 probably due to a bug and you should report it.
3126 You can disable the popping up of this buffer by adding the entry
3127 \(undo discard-info) to the user option `warning-suppress-types',
3131 t))
3132 \f
3135 ; These are sorted according to the GNU en_US locale.
3178 )
3180 This is used by Shell mode and other parts of Emacs to recognize
3181 password prompts, including prompts in languages other than
3182 English. Different case choices should not be assumed to be
3183 included; callers should bind `case-fold-search' to t."
3189 "History list for some commands that read shell commands.
3191 Maximum length of the history list is determined by the value
3198 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3199 This buffer is used when `shell-command' or `shell-command-on-region'
3200 is run interactively. A value of nil means that output to stderr and
3207 "Return a list of all commands associated with the current file.
3208 This function is used to add all related commands retrieved by `mailcap'
3209 to the end of the list of defaults just after the default value."
3213 minibuffer-default))
3218 commands))
3229 map)
3233 "Read a shell command from the minibuffer.
3234 The arguments are the same as the ones of `read-from-minibuffer',
3235 except READ and KEYMAP are missing and HIST defaults
3236 to `shell-command-history'."
3244 minibuffer-local-shell-command-map
3245 nil
3247 args)))
3250 "What to do when the output buffer is used by another shell command.
3251 This option specifies how to resolve the conflict where a new command
3252 wants to direct its output to the buffer `*Async Shell Command*',
3253 but this buffer is already taken by another running shell command.
3255 The value `confirm-kill-process' is used to ask for confirmation before
3256 killing the already running process and running a new process
3257 in the same buffer, `confirm-new-buffer' for confirmation before running
3258 the command in a new buffer with a name other than the default buffer name,
3259 `new-buffer' for doing the same without confirmation,
3260 `confirm-rename-buffer' for confirmation before renaming the existing
3261 output buffer and running a new command in the default buffer,
3262 `rename-buffer' for doing the same without confirmation."
3264 confirm-kill-process)
3266 confirm-new-buffer)
3268 new-buffer)
3270 confirm-rename-buffer)
3272 rename-buffer))
3277 "Whether to display the command buffer immediately.
3278 If t, display the buffer immediately; if nil, wait until there
3279 is output."
3281 t)
3283 nil))
3288 "Store a buffer position or erase the buffer.
3289 See `shell-command-dont-erase-buffer'."
3291 pos)
3293 ;; Setting buffer-read-only to nil doesn't suffice
3294 ;; if some text has a non-nil read-only property,
3295 ;; which comint sometimes adds for prompts.
3305 shell-command-saved-pos))))
3308 "Set point in BUFFER after command complete.
3309 BUFFER is the output buffer of the command; if nil, then defaults
3310 to the current BUFFER.
3311 Set point to the `cdr' of the element in `shell-command-saved-pos'
3312 whose `car' is BUFFER."
3324 ;; Set point in the window displaying buf, if any; otherwise
3325 ;; display buf temporary in selected frame and set the point.
3330 buf
3335 "Execute string COMMAND asynchronously in background.
3337 Like `shell-command', but adds `&' at the end of COMMAND
3338 to execute it asynchronously.
3340 The output appears in the buffer `*Async Shell Command*'.
3341 That buffer is in shell mode.
3343 You can configure `async-shell-command-buffer' to specify what to do in
3344 case when `*Async Shell Command*' buffer is already taken by another
3345 running shell command. To run COMMAND without displaying the output
3346 in a window you can configure `display-buffer-alist' to use the action
3347 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3349 In Elisp, you will often be better served by calling `start-process'
3350 directly, since it offers more control and does not impose the use of a
3351 shell (with its need to quote arguments)."
3361 current-prefix-arg
3362 shell-command-default-error-buffer))
3368 "Execute string COMMAND in inferior shell; display output, if any.
3369 With prefix argument, insert the COMMAND's output at point.
3371 Interactively, prompt for COMMAND in the minibuffer.
3373 If COMMAND ends in `&', execute it asynchronously.
3374 The output appears in the buffer `*Async Shell Command*'.
3375 That buffer is in shell mode. You can also use
3376 `async-shell-command' that automatically adds `&'.
3378 Otherwise, COMMAND is executed synchronously. The output appears in
3379 the buffer `*Shell Command Output*'. If the output is short enough to
3380 display in the echo area (which is determined by the variables
3381 `resize-mini-windows' and `max-mini-window-height'), it is shown
3382 there, but it is nonetheless available in buffer `*Shell Command
3383 Output*' even though that buffer is not automatically displayed.
3385 To specify a coding system for converting non-ASCII characters
3387 before this command.
3389 Noninteractive callers can specify coding systems by binding
3390 `coding-system-for-read' and `coding-system-for-write'.
3392 The optional second argument OUTPUT-BUFFER, if non-nil,
3393 says to put the output in some other buffer.
3394 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3395 and insert the output there; a non-nil value of
3396 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3397 If OUTPUT-BUFFER is not a buffer and not nil, insert the output
3398 in current buffer after point leaving mark after it.
3399 This cannot be done asynchronously.
3401 If the command terminates without error, but generates output,
3403 the output can be displayed in the echo area or in its buffer.
3404 If the output is short enough to display in the echo area
3405 \(determined by the variable `max-mini-window-height' if
3406 `resize-mini-windows' is non-nil), it is shown there.
3407 Otherwise,the buffer containing the output is displayed.
3411 of the output.
3413 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3414 or buffer name to which to direct the command's standard error output.
3415 If it is nil, error output is mingled with regular output.
3416 In an interactive call, the variable `shell-command-default-error-buffer'
3417 specifies the value of ERROR-BUFFER.
3419 In Elisp, you will often be better served by calling `call-process' or
3420 `start-process' directly, since it offers more control and does not impose
3421 the use of a shell (with its need to quote arguments)."
3432 current-prefix-arg
3433 shell-command-default-error-buffer))
3434 ;; Look for a handler in case default-directory is a remote file name.
3442 ;; Output goes in current buffer.
3448 temporary-file-directory)))
3449 nil)))
3452 ;; We do not use -f for csh; we will not support broken use of
3453 ;; .cshrcs. Even the BSD csh manual says to use
3454 ;; "if ($?prompt) exit" before things which are not useful
3455 ;; non-interactively. Besides, if someone wants their other
3456 ;; aliases for shell commands then they can still have them.
3460 t)
3461 nil shell-command-switch command)
3468 ;; Do no formatting while reading error file,
3469 ;; because that can run a shell command, and we
3470 ;; don't want that to cause an infinite recursion.
3472 ;; Put point after the inserted errors.
3476 ;; This is like exchange-point-and-mark, but doesn't
3477 ;; activate the mark. It is cleaner to avoid activation,
3478 ;; even though the command loop would deactivate the mark
3479 ;; because we inserted text.
3483 ;; Output goes in a separate buffer.
3484 ;; Preserve the match data in case called from a program.
3485 ;; FIXME: It'd be ridiculous for an Elisp function to call
3486 ;; shell-command and assume that it won't mess the match-data!
3489 ;; Command ending with ampersand means asynchronous.
3494 proc)
3495 ;; Remove the ampersand.
3497 ;; Ask the user what to do with already running process.
3502 ;; If will kill a process, query first.
3507 ;; If will create a new buffer, query first.
3512 ;; It will create a new buffer.
3515 ;; If will rename the buffer, query first.
3523 ;; It will rename the buffer.
3531 shell-command-switch command))
3535 ;; Use the comint filter for proper handling of
3536 ;; carriage motion (see comint-inhibit-carriage-motion).
3545 bname))
3547 ;; Otherwise, command is executed synchronously.
3549 output-buffer nil error-buffer)))))))
3552 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3553 MESSAGE may be either a string or a buffer.
3555 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3556 for maximum height of the echo area, as defined by `max-mini-window-height'
3557 if `resize-mini-windows' is non-nil.
3559 Returns either the string shown in the echo area, or when a pop-up
3560 buffer is used, the window used to display it.
3562 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3563 name of the buffer used to display it in the case where a pop-up buffer
3564 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3565 string and it is displayed in the echo area, it is not specified whether
3566 the contents are inserted into the buffer anyway.
3568 Optional arguments ACTION and FRAME are as for `display-buffer',
3569 and are only used if a pop-up buffer is displayed."
3571 ;; Trivial case where we can use the echo area
3575 ;; Trivial case where we can just remove single trailing newline
3578 ;; General case
3581 message
3590 0
3594 (<= lines
3598 max-mini-window-height))
3600 max-mini-window-height)
3604 ;; Don't use the echo area if the output buffer is
3605 ;; already displayed in the selected frame.
3607 ;; Echo area
3613 ;; Buffer
3618 ;; We have a sentinel to prevent insertion of a termination message
3619 ;; in the buffer itself, and to set the point in the buffer when
3620 ;; `shell-command-dont-erase-buffer' is non-nil.
3629 &optional output-buffer replace
3630 error-buffer display-error-buffer
3631 region-noncontiguous-p)
3632 "Execute string COMMAND in inferior shell with region as input.
3633 Normally display output (if any) in temp buffer `*Shell Command Output*';
3634 Prefix arg means replace the region with it. Return the exit code of
3635 COMMAND.
3637 To specify a coding system for converting non-ASCII characters
3639 before this command. By default, the input (from the current buffer)
3640 is encoded using coding-system specified by `process-coding-system-alist',
3641 falling back to `default-process-coding-system' if no match for COMMAND
3642 is found in `process-coding-system-alist'.
3644 Noninteractive callers can specify coding systems by binding
3645 `coding-system-for-read' and `coding-system-for-write'.
3647 If the command generates output, the output may be displayed
3648 in the echo area or in a buffer.
3649 If the output is short enough to display in the echo area
3650 \(determined by the variable `max-mini-window-height' if
3651 `resize-mini-windows' is non-nil), it is shown there.
3652 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3653 The output is available in that buffer in both cases.
3655 If there is output and an error, a message about the error
3656 appears at the end of the output.
3658 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3659 command's output. If the value is a buffer or buffer name,
3660 erase that buffer and insert the output there; a non-nil value of
3661 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3662 If the value is nil, use the buffer `*Shell Command Output*'.
3663 Any other non-nil value means to insert the output in the
3664 current buffer after START.
3666 Optional fifth arg REPLACE, if non-nil, means to insert the
3667 output in place of text from START to END, putting point and mark
3668 around it.
3670 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3671 or buffer name to which to direct the command's standard error
3672 output. If nil, error output is mingled with regular output.
3673 When called interactively, `shell-command-default-error-buffer'
3674 is used for ERROR-BUFFER.
3676 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3677 display the error buffer if there were any errors. When called
3678 interactively, this is t."
3682 ;; Do this before calling region-beginning
3683 ;; and region-end, in case subprocess output
3684 ;; relocates them while we are in the minibuffer.
3686 ;; call-interactively recognizes region-beginning and
3687 ;; region-end specially, leaving them in the history.
3689 string
3690 current-prefix-arg
3691 current-prefix-arg
3692 shell-command-default-error-buffer
3693 t
3700 temporary-file-directory)))
3701 nil))
3702 exit-status)
3703 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3706 output)
3710 shell-file-name t t
3711 nil shell-command-switch
3712 command)
3719 ;; Replace specified region with output from command.
3721 ;; Don't muck with mark unless REPLACE says we should.
3728 t)))
3729 ;; It is rude to delete a buffer which the command is not using.
3730 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3731 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3732 ;; (kill-buffer shell-buffer)))
3733 ;; Don't muck with mark unless REPLACE says we should.
3735 ;; No prefix argument: put the output in a temp buffer,
3736 ;; replacing its entire contents.
3744 ;; If the input is the same buffer as the output,
3745 ;; delete everything but the specified region,
3746 ;; then replace that region with the output.
3752 shell-file-name t
3755 t)
3756 nil shell-command-switch
3757 command)))
3758 ;; Clear the output buffer, then run the command with
3759 ;; output there.
3769 buffer))))
3770 ;; Report the output.
3780 ;; There's some output, display it
3784 ;; No output; error?
3791 shell-command-default-error-buffer)
3798 output))
3801 exit-status))
3804 exit-status output))))
3805 ;; Don't kill: there might be useful info in the undo-log.
3806 ;; (kill-buffer buffer)
3807 )))))
3815 ;; Do no formatting while reading error file,
3816 ;; because that can run a shell command, and we
3817 ;; don't want that to cause an infinite recursion.
3819 ;; Put point after the inserted errors.
3824 exit-status))
3827 "Execute shell command COMMAND and return its output as a string."
3830 standard-output
3834 "Process files synchronously in a separate process.
3835 Similar to `call-process', but may invoke a file handler based on
3836 `default-directory'. The current working directory of the
3837 subprocess is `default-directory'.
3839 File names in INFILE and BUFFER are handled normally, but file
3840 names in ARGS should be relative to `default-directory', as they
3841 are passed to the process verbatim. (This is a difference to
3842 `call-process' which does not support file handlers for INFILE
3843 and BUFFER.)
3845 Some file handlers might not support all variants, for example
3846 they might behave as if DISPLAY was nil, regardless of the actual
3847 value passed."
3849 lc stderr-file)
3859 display args)
3865 "Whether a call of `process-file' changes remote files.
3867 By default, this variable is always set to t, meaning that a
3868 call of `process-file' could potentially change any file on a
3869 remote host. When set to nil, a file handler could optimize
3870 its behavior with respect to remote file attribute caching.
3872 You should only ever change this variable with a let-binding;
3876 "Start a program in a subprocess. Return the process object for it.
3878 Similar to `start-process', but may invoke a file handler based on
3879 `default-directory'. See Info node `(elisp)Magic File Names'.
3881 This handler ought to run PROGRAM, perhaps on the local host,
3882 perhaps on a remote host that corresponds to `default-directory'.
3883 In the latter case, the local part of `default-directory' becomes
3884 the working directory of the process.
3886 PROGRAM and PROGRAM-ARGS might be file names. They are not
3887 objects of file handler invocation. File handlers might not
3888 support pty association, if PROGRAM is nil."
3892 \f
3893 ;;;; Process menu
3907 map))
3910 "Major mode for listing the processes called by Emacs."
3922 "Kill process at point in a `list-processes' buffer."
3933 "Recompute the list of processes for the Process List buffer.
3934 Also, delete any process that is exited or signaled."
3948 face link
3950 "Visit buffer `%s'"
3952 follow-link t
3953 process-buffer ,buf
3954 action process-menu-visit-buffer)
3963 "datagram"
3980 tabulated-list-entries)))))
3987 "Display a list of all processes that are Emacs sub-processes.
3988 If optional argument QUERY-ONLY is non-nil, only processes with
3989 the query-on-exit flag set are listed.
3990 Any process listed as exited or signaled is actually eliminated
3991 after the listing is made.
3992 Optional argument BUFFER specifies a buffer to use, instead of
3994 The return value is always nil.
3996 This function lists only processes that were launched by Emacs. To
3997 see other processes running on the system, use `list-system-processes'."
4009 nil)
4010 \f
4011 ;;;; Prefix commands
4017 ;; BEWARE: Called directly from C code.
4018 ;; If the return value is non-nil, it means we are in the middle of
4019 ;; a command with prefix, such as a command invoked with prefix-arg.
4021 prefix-command--last-echo
4030 "Abnormal hook which constructs the description of the current prefix state.
4034 "Update state of prefix commands.
4042 "Pass the current prefix command state to the next command.
4043 Should be called by all prefix commands.
4044 Runs `prefix-command-preserve-state-hook'."
4046 ;; If the current command is a prefix command, we don't want the next (real)
4047 ;; command to have `last-command' set to, say, `universal-argument'.
4054 nil)
4056 ;;;;; The main prefix command.
4058 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
4083 ;; For backward compatibility, minus with no modifiers is an ordinary
4084 ;; command if digits have already been entered.
4114 map)
4122 "Begin a numeric argument for the following command.
4127 multiplies the argument by 4 each time.
4129 which is different in effect from any particular numeric argument.
4137 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
4138 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
4145 arg)))
4149 "Begin a negative numeric argument for the next command.
4159 "Part of the numeric argument for the next command.
4164 last-command-event
4171 ;; Treat -0 as just -, so that -01 will work.
4174 digit))))
4176 \f
4179 "This variable is a wrapper hook around `buffer-substring--filter'.
4185 "Function to perform the filtering in `filter-buffer-substring'.
4186 The function is called with the same 3 arguments (BEG END DELETE)
4187 that `filter-buffer-substring' received. It should return the
4188 buffer substring between BEG and END, after filtering. If DELETE is
4192 "List of filter functions for `buffer-substring--filter'.
4193 Each function must accept a single argument, a string, and return a string.
4194 The buffer substring is passed to the first function in the list,
4195 and the return value of each function is passed to the next.
4196 As a special convention, point is set to the start of the buffer text
4197 being operated on (i.e., the first argument of `buffer-substring--filter')
4203 "Return the buffer substring between BEG and END, after filtering.
4204 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4206 This calls the function that `filter-buffer-substring-function' specifies
4207 \(passing the same three arguments that it received) to do the work,
4208 and returns whatever it does. The default function does no filtering,
4209 unless a hook has been set.
4211 Use `filter-buffer-substring' instead of `buffer-substring',
4212 `buffer-substring-no-properties', or `delete-and-extract-region' when
4213 you want to allow filtering to take place. For example, major or minor
4214 modes can use `filter-buffer-substring-function' to extract characters
4215 that are special to a buffer, and should not be copied into other buffers."
4219 "Default function to use for `filter-buffer-substring-function'.
4220 Its arguments and return value are as specified for `filter-buffer-substring'.
4221 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4222 \(see `with-wrapper-hook' for details about wrapper hooks),
4223 and the abnormal hook `buffer-substring-filters'.
4224 No filtering is done unless a hook says to."
4235 string)))
4240 ;;;; Window system cut and paste hooks.
4243 "Function to call to make a killed region available to other programs.
4244 Most window systems provide a facility for cutting and pasting
4245 text between different programs, such as the clipboard on X and
4246 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4248 This variable holds a function that Emacs calls whenever text is
4249 put in the kill ring, to make the new kill available to other
4250 programs. The function takes one argument, TEXT, which is a
4254 "Function to call to get text cut from other programs.
4255 Most window systems provide a facility for cutting and pasting
4256 text between different programs, such as the clipboard on X and
4257 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4259 This variable holds a function that Emacs calls to obtain text
4260 that other programs have provided for pasting. The function is
4261 called with no arguments. If no other program has provided text
4262 to paste, the function should return nil (in which case the
4263 caller, usually `current-kill', should use the top of the Emacs
4264 kill ring). If another program has provided text to paste, the
4265 function should return that text as a string (in which case the
4266 caller should put this string in the kill ring as the latest
4267 kill).
4269 The function may also return a list of strings if the window
4270 system supports multiple selections. The first string will be
4271 used as the pasted text, but the other will be placed in the kill
4272 ring for easy access via `yank-pop'.
4274 Note that the function should return a string only if a program
4275 other than Emacs has provided a string for pasting; if Emacs
4276 provided the most recent string, the function should return nil.
4277 If it is difficult to tell whether Emacs or some other program
4278 provided the current string, it is probably good enough to return
4279 nil if the string is equal (according to `string=') to the last
4281 \f
4284 ;;;; The kill ring data structure.
4287 "List of killed text sequences.
4288 Since the kill ring is supposed to interact nicely with cut-and-paste
4289 facilities offered by window systems, use of this variable should
4290 interact nicely with `interprogram-cut-function' and
4291 `interprogram-paste-function'. The functions `kill-new',
4292 `kill-append', and `current-kill' are supposed to implement this
4293 interaction; you may want to use them instead of manipulating the kill
4297 "Maximum length of kill ring before oldest elements are thrown away."
4305 "Save clipboard strings into kill ring before replacing them.
4306 When one selects something in another program to paste it into Emacs,
4307 but kills something in Emacs before actually pasting it,
4308 this selection is gone unless this variable is non-nil,
4309 in which case the other program's selection is saved in the `kill-ring'
4316 "Do not add a new string to `kill-ring' if it duplicates the last one.
4317 The comparison is done using `equal-including-properties'."
4323 "Make STRING the latest kill in the kill ring.
4324 Set `kill-ring-yank-pointer' to point to it.
4325 If `interprogram-cut-function' is non-nil, apply it to STRING.
4326 Optional second argument REPLACE non-nil means that STRING will replace
4327 the front of the kill ring, rather than being added to the list.
4329 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4330 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4331 STRING.
4333 When the yank handler has a non-nil PARAM element, the original STRING
4334 argument is not used by `insert-for-yank'. However, since Lisp code
4335 may access and use elements from the kill ring directly, the STRING
4338 ;; Due to text properties such as 'yank-handler that
4339 ;; can alter the contents to yank, comparison using
4340 ;; `equal' is unsafe.
4365 ;; It has been argued that this should work similar to `self-insert-command'
4366 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4368 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4374 "Append STRING to the end of the latest kill in the kill ring.
4375 If BEFORE-P is non-nil, prepend STRING to the kill.
4376 Also removes the last undo boundary in the current buffer,
4377 depending on `kill-append-merge-undo'.
4378 If `interprogram-cut-function' is set, pass the resulting kill to it."
4386 ;; find the next undo boundary
4390 ;; remove this undo boundary
4395 "Whether rotating the kill ring changes the window system selection.
4396 If non-nil, whenever the kill ring is rotated (usually via the
4397 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4398 to copy the new kill to the window system selection."
4404 "Rotate the yanking point by N places, and then return that kill.
4405 If N is zero and `interprogram-paste-function' is set to a
4406 function that returns a string or a list of strings, and if that
4407 function doesn't return nil, then that string (or list) is added
4408 to the front of the kill ring and the string (or first string in
4409 the list) is returned as the latest kill.
4411 If N is not zero, and if `yank-pop-change-selection' is
4412 non-nil, use `interprogram-cut-function' to transfer the
4413 kill at the new yank point into the window system selection.
4415 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4416 move the yanking point; just return the Nth kill forward."
4419 interprogram-paste-function
4423 ;; Disable the interprogram cut function when we add the new
4424 ;; text to the kill ring, so Emacs doesn't try to own the
4425 ;; selection, with identical text.
4435 kill-ring)))
4440 interprogram-cut-function)
4446 ;;;; Commands for manipulating the kill ring.
4449 "Non-nil means don't signal an error for killing read-only text."
4455 This deletes the text from the buffer and saves it in the kill ring.
4459 If you want to append the killed region to the last killed text,
4463 If the previous command was also a kill command,
4464 the text killed this time appends to the text killed last time
4465 to make one entry in the kill ring.
4467 The killed text is filtered by `filter-buffer-substring' before it is
4468 saved in the kill ring, so the actual saved text might be different
4469 from what was killed.
4471 If the buffer is read-only, Emacs will beep and refrain from deleting
4472 the text, but put the text in the kill ring anyway. This means that
4473 you can use the killing commands to copy text from a read-only buffer.
4475 Lisp programs should use this function for killing text.
4476 (To delete text, use `delete-region'.)
4477 Supply two arguments, character positions BEG and END indicating the
4478 stretch of text to be killed. If the optional argument REGION is
4479 non-nil, the function ignores BEG and END, and kills the current
4480 region instead."
4481 ;; Pass mark first, then point, because the order matters when
4482 ;; calling `kill-append'.
4491 ;; Add that string to the kill ring, one way or another.
4498 nil)
4500 ;; The code above failed because the buffer, or some of the characters
4501 ;; in the region, are read-only.
4502 ;; We should beep, in case the user just isn't aware of this.
4503 ;; However, there's no harm in putting
4504 ;; the region's text in the kill ring, anyway.
4506 ;; Set this-command now, so it will be set even if we get an error.
4508 ;; This should barf, if appropriate, and give us the correct error.
4511 ;; Signal an error if the buffer is read-only.
4513 ;; If the buffer isn't read-only, the text is.
4516 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4517 ;; to get two copies of the text when the user accidentally types M-w and
4518 ;; then corrects it with the intended C-w.
4520 "Save the region as if killed, but don't kill it.
4521 In Transient Mark mode, deactivate the mark.
4522 If `interprogram-cut-function' is non-nil, also save the text for a window
4523 system cut and paste.
4525 The copied text is filtered by `filter-buffer-substring' before it is
4526 saved in the kill ring, so the actual saved text might be different
4527 from what was in the buffer.
4529 When called from Lisp, save in the kill ring the stretch of text
4530 between BEG and END, unless the optional argument REGION is
4531 non-nil, in which case ignore BEG and END, and save the current
4532 region instead.
4534 This command's old key binding has been given to `kill-ring-save'."
4535 ;; Pass mark first, then point, because the order matters when
4536 ;; calling `kill-append'.
4546 nil)
4549 "Save the region as if killed, but don't kill it.
4550 In Transient Mark mode, deactivate the mark.
4551 If `interprogram-cut-function' is non-nil, also save the text for a window
4552 system cut and paste.
4554 If you want to append the killed line to the last killed text,
4557 The copied text is filtered by `filter-buffer-substring' before it is
4558 saved in the kill ring, so the actual saved text might be different
4559 from what was in the buffer.
4561 When called from Lisp, save in the kill ring the stretch of text
4562 between BEG and END, unless the optional argument REGION is
4563 non-nil, in which case ignore BEG and END, and save the current
4564 region instead.
4566 This command is similar to `copy-region-as-kill', except that it gives
4567 visual feedback indicating the extent of the region being copied."
4568 ;; Pass mark first, then point, because the order matters when
4569 ;; calling `kill-append'.
4573 ;; This use of called-interactively-p is correct because the code it
4574 ;; controls just gives the user visual feedback.
4579 "Indicate that the region text has been copied interactively.
4580 If the mark is visible in the selected window, blink the cursor
4581 between point and mark if there is currently no active region
4582 highlighting.
4584 If the mark lies outside the selected window, display an
4585 informative message containing a sample of the copied text. The
4586 optional argument MESSAGE-LEN, if non-nil, specifies the length
4587 of this sample text; it defaults to 40."
4590 ;; Inhibit quitting so we can make a quit here
4591 ;; look like a C-g typed as a command.
4594 ;; Swap point-and-mark quickly so as to show the region that
4595 ;; was selected. Don't do it if the region is highlighted.
4598 ;; Swap point and mark.
4602 ;; Swap back.
4605 ;; If user quit, deactivate the mark
4606 ;; as C-g would as a command.
4612 ;; Don't say "killed"; that is misleading.
4619 "Cause following command, if it kills, to add to previous kill.
4620 If the next command kills forward from point, the kill is
4621 appended to the previous killed text. If the command kills
4622 backward, the kill is prepended. Kill commands that act on the
4623 region, such as `kill-region', are regarded as killing forward if
4624 point is after mark, and killing backward if point is before
4625 mark.
4627 If the next command is not a kill command, `append-next-kill' has
4628 no effect.
4630 The argument is used for internal purposes; do not supply one."
4632 ;; We don't use (interactive-p), since that breaks kbd macros.
4646 "A subroutine of `squeeze-bidi-context'.
4647 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4651 lim1)
4658 ;; L and R categories include embedding and
4659 ;; override controls, but we don't want to
4660 ;; replace them, because that might change
4661 ;; the visual order. Likewise with PDF and
4662 ;; isolate controls.
4664 bidi-directional-non-controls-chars
4665 limit)))))
4666 ;; Replace any run of non-RTL characters by a single LRM.
4668 ;; No more characters of CATEGORY, we are done.
4673 ;; Skip directional controls, if any.
4678 "Replace characters between FROM and TO while keeping bidi context.
4680 This function replaces the region of text with as few characters
4681 as possible, while preserving the effect that region will have on
4682 bidirectional display before and after the region."
4686 ;; This is for when they copy text with read-only text
4687 ;; properties.
4691 ;; Replace each run of non-RTL characters with a single LRM.
4693 ;; Replace each run of non-LTR characters with a single RLM. Note
4694 ;; that the \cR category includes both the Arabic Letter (AL) and
4695 ;; R characters; here we ignore the distinction between them,
4696 ;; because that distinction only affects Arabic Number (AN)
4697 ;; characters, which are weak and don't affect the reordering.
4701 "Return buffer text between START and END with its bidi context.
4703 START and END are assumed to belong to the same physical line
4704 of buffer text. This function prepends and appends to the text
4705 between START and END bidi control characters that preserve the
4706 visual order of that text when it is inserted at some other place."
4711 substr para-dir from to)
4718 ;; If we don't have any mixed directional characters in the
4719 ;; entire line, we can just copy the substring without adding
4720 ;; any context.
4735 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4736 ;; (1) force the string to have the same base embedding
4737 ;; direction as the paragraph direction at the source, no matter
4738 ;; what is the paragraph direction at destination; and (2) avoid
4739 ;; affecting the visual order of the surrounding text at
4740 ;; destination if there are characters of different
4741 ;; directionality there.
4746 "Return portion of current buffer between START and END with bidi context.
4748 This function works similar to `buffer-substring', but it prepends and
4749 appends to the text bidi directional control characters necessary to
4750 preserve the visual appearance of the text if it is inserted at another
4751 place. This is useful when the buffer substring includes bidirectional
4752 text and control characters that cause non-trivial reordering on display.
4753 If copied verbatim, such text can have a very different visual appearance,
4754 and can also change the visual appearance of the surrounding text at the
4755 destination of the copy.
4757 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4758 the text properties."
4771 no-properties)))
4775 substr)))
4776 \f
4777 ;; Yanking.
4782 "List of special text property handling conditions for yanking.
4783 Each element should have the form (PROP . FUN), where PROP is a
4784 property symbol and FUN is a function. When the `yank' command
4785 inserts text into the buffer, it scans the inserted text for
4786 stretches of text that have `eq' values of the text property
4787 PROP; for each such stretch of text, FUN is called with three
4788 arguments: the property's value in that text, and the start and
4789 end positions of the text.
4791 This is done prior to removing the properties specified by
4792 `yank-excluded-properties'."
4795 function))
4798 ;; This is actually used in subr.el but defcustom does not work there.
4801 intangible invisible keymap local-map mouse-face read-only
4802 yank-handler)
4803 "Text properties to discard when yanking.
4804 The value should be a list of text properties to discard or t,
4805 which means to discard all text properties.
4807 See also `yank-handled-properties'."
4814 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4815 Function is called with two parameters, START and END corresponding to
4816 the value of the mark and point; it is guaranteed that START <= END.
4820 "Replace just-yanked stretch of killed text with a different stretch.
4821 This command is allowed only immediately after a `yank' or a `yank-pop'.
4822 At such a time, the region contains a stretch of reinserted
4823 previously-killed text. `yank-pop' deletes that text and inserts in its
4824 place a different stretch of killed text.
4826 With no argument, the previous kill is inserted.
4827 With argument N, insert the Nth previous kill.
4828 If N is negative, this is a more recent kill.
4830 The sequence of kills wraps around, so that after the oldest one
4831 comes the newest one.
4833 This command honors the `yank-handled-properties' and
4834 `yank-excluded-properties' variables, and the `yank-handler' text
4835 property, in the way that `yank' does."
4849 ;; Set the window start back where it was in the yank command,
4850 ;; if possible.
4853 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4854 ;; It is cleaner to avoid activation, even though the command
4855 ;; loop would deactivate the mark because we inserted text.
4858 nil)
4862 More precisely, reinsert the most recent kill, which is the
4863 stretch of killed text most recently killed OR yanked. Put point
4864 at the end, and set mark at the beginning without activating it.
4866 With argument N, reinsert the Nth most recent kill.
4868 This command honors the `yank-handled-properties' and
4869 `yank-excluded-properties' variables, and the `yank-handler' text
4870 property, as described below.
4872 Properties listed in `yank-handled-properties' are processed,
4873 then those listed in `yank-excluded-properties' are discarded.
4875 If STRING has a non-nil `yank-handler' property anywhere, the
4876 normal insert behavior is altered, and instead, for each contiguous
4877 segment of STRING that has a given value of the `yank-handler'
4878 property, that value is used as follows:
4880 The value of a `yank-handler' property must be a list of one to four
4881 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
4882 FUNCTION, if non-nil, should be a function of one argument (the
4883 object to insert); FUNCTION is called instead of `insert'.
4884 PARAM, if present and non-nil, is passed to FUNCTION (to be handled
4885 in whatever way is appropriate; e.g. if FUNCTION is `yank-rectangle',
4886 PARAM may be a list of strings to insert as a rectangle). If PARAM
4887 is nil, then the current segment of STRING is used.
4888 If NOEXCLUDE is present and non-nil, the normal removal of
4889 `yank-excluded-properties' is not performed; instead FUNCTION is
4890 responsible for the removal. This may be necessary if FUNCTION
4891 adjusts point before or after inserting the object.
4892 UNDO, if present and non-nil, should be a function to be called
4893 by `yank-pop' to undo the insertion of the current PARAM. It is
4894 given two arguments, the start and end of the region. FUNCTION
4895 may set `yank-undo-function' to override UNDO.
4900 ;; If we don't get all the way thru, make last-command indicate that
4901 ;; for the following command.
4909 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4910 ;; It is cleaner to avoid activation, even though the command
4911 ;; loop would deactivate the mark because we inserted text.
4914 ;; If we do get all the way thru, make this-command indicate that.
4917 nil)
4920 "Rotate the yanking point in the kill ring.
4921 With ARG, rotate that many kills forward (or backward, if negative)."
4924 \f
4925 ;; Some kill commands.
4927 ;; Internal subroutine of delete-char
4933 ;; Internal subroutine of backward-delete-char
4940 "The method for untabifying when deleting backward.
4941 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4942 `hungry' -- delete all whitespace, both tabs and spaces;
4943 `all' -- delete all whitespace, including tabs, spaces and newlines;
4944 nil -- just delete one character."
4950 "Delete characters backward, changing tabs into spaces.
4951 The exact behavior depends on `backward-delete-char-untabify-method'.
4952 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4953 Interactively, ARG is the prefix arg (default 1)
4954 and KILLP is t if a prefix arg was specified."
4977 arg)))
4978 ;; Avoid warning about delete-backward-char
4982 "Kill up to and including ARGth occurrence of CHAR.
4983 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4984 Goes backward if ARG is negative; error if CHAR not found."
4987 ;; Avoid "obsolete" warnings for translation-table-for-input.
4995 ;; kill-line and its subroutines.
4998 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
5003 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
5004 With prefix argument ARG, kill that many lines from point.
5005 Negative arguments kill lines backward.
5006 With zero argument, kills the text before point on the current line.
5009 a number counts as a prefix arg.
5011 To kill a whole line, when point is not at the beginning, type \
5014 If `show-trailing-whitespace' is non-nil, this command will just
5015 kill the rest of the current line, even if there are no nonblanks
5016 there.
5018 If option `kill-whole-line' is non-nil, then this command kills the whole line
5019 including its terminating newline, when used at the beginning of a line
5020 with no argument. As a consequence, you can always kill a whole line
5023 If you want to append the killed line to the last killed text,
5026 If the buffer is read-only, Emacs will beep and refrain from deleting
5027 the line, but put the line in the kill ring anyway. This means that
5028 you can use this command to copy text from a read-only buffer.
5029 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5030 even beep.)"
5033 ;; It is better to move point to the other end of the kill
5034 ;; before killing. That way, in a read-only buffer, point
5035 ;; moves across the text that is copied to the kill ring.
5036 ;; The choice has no effect on undo now that undo records
5037 ;; the value of point from before the command was run.
5047 ;; If trailing whitespace is visible,
5048 ;; don't treat it as nothing.
5058 "Kill current line.
5059 With prefix ARG, kill that many lines starting from the current line.
5060 If ARG is negative, kill backward. Also kill the preceding newline.
5062 If ARG is zero, kill current line but exclude the trailing newline."
5073 ;; We need to kill in two steps, because the previous command
5074 ;; could have been a kill command, in which case the text
5075 ;; before point needs to be prepended to the current kill
5076 ;; ring entry and the text after point appended. Also, we
5077 ;; need to use save-excursion to avoid copying the same text
5078 ;; twice to the kill ring in read-only buffers.
5096 "Move forward by ARG lines, ignoring currently invisible newlines only.
5097 If ARG is negative, move backward -ARG lines.
5098 If ARG is zero, move to the beginning of the current line."
5105 ;; If the newline we just skipped is invisible,
5106 ;; don't count it.
5110 prop
5115 ;; If invisible text follows, and it is a number of complete lines,
5116 ;; skip it.
5122 prop
5138 ;; If the newline we just moved to is invisible,
5139 ;; don't count it.
5144 prop
5149 ;; If invisible text follows, and it is a number of complete lines,
5150 ;; skip it.
5156 prop
5167 nil)))
5170 "Move to end of current visible line."
5172 ;; If the following character is currently invisible,
5173 ;; skip all characters with that same `invisible' property value,
5174 ;; then find the next newline.
5181 prop
5192 "Kill the current buffer.
5193 When called in the minibuffer, get out of the minibuffer
5194 using `abort-recursive-edit'.
5196 This is like `kill-this-buffer', but it doesn't have to be invoked
5197 via the menu bar, and pays no attention to the menu-bar's frame."
5205 \f
5207 "Insert after point the contents of BUFFER.
5208 Puts mark after the inserted text.
5209 BUFFER may be a buffer or a buffer name."
5219 t))))
5224 nil)
5227 "Append to specified buffer the text of the region.
5228 It is inserted into that buffer before its point.
5230 When calling from a program, give three arguments:
5231 BUFFER (or buffer name), START and END.
5232 START and END specify the portion of the current buffer to be copied."
5239 point)
5250 "Prepend to specified buffer the text of the region.
5251 It is inserted into that buffer after its point.
5253 When calling from a program, give three arguments:
5254 BUFFER (or buffer name), START and END.
5255 START and END specify the portion of the current buffer to be copied."
5264 "Copy to specified buffer the text of the region.
5265 It is inserted into that buffer, replacing existing text there.
5267 When calling from a program, give three arguments:
5268 BUFFER (or buffer name), START and END.
5269 START and END specify the portion of the current buffer to be copied."
5277 \f
5281 "Hook run when the mark becomes active.
5282 It is also run at the end of a command, if the mark is active and
5289 "Return this buffer's mark value as integer, or nil if never set.
5291 In Transient Mark mode, this function signals an error if
5292 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5293 or the argument FORCE is non-nil, it disregards whether the mark
5294 is active, and returns an integer or nil in the usual way.
5296 If you are using this in an editing command, you are most likely making
5297 a mistake; see the documentation of `set-mark'."
5302 ;; Behind display-selections-p.
5305 "Deactivate the mark.
5306 If Transient Mark mode is disabled, this function normally does
5307 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5309 Deactivating the mark sets `mark-active' to nil, updates the
5310 primary selection according to `select-active-regions', and runs
5311 `deactivate-mark-hook'.
5313 If Transient Mark mode was temporarily enabled, reset the value
5314 of the variable `transient-mark-mode'; if this causes Transient
5315 Mark mode to be disabled, don't change `mark-active' to nil or
5316 run `deactivate-mark-hook'."
5320 select-active-regions)
5323 ;; The var `saved-region-selection', if non-nil, is the text in
5324 ;; the region prior to the last command modifying the buffer.
5325 ;; Set the selection to that, or to the current region.
5330 ;; If another program has acquired the selection, region
5331 ;; deactivation should not clobber it (Bug#11772).
5350 "Activate the mark.
5351 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5361 "Set this buffer's mark to POS. Don't use this function!
5362 That is to say, don't use this function unless you want
5363 the user to see that the mark has moved, and you want the previous
5364 mark position to be lost.
5366 Normally, when a new mark is set, the old one should go on the stack.
5367 This is why most applications should use `push-mark', not `set-mark'.
5369 Novice Emacs Lisp programmers often try to use the mark for the wrong
5370 purposes. The mark saves a location for the user's convenience.
5371 Most editing commands should not alter the mark.
5372 To remember a location for internal use in the Lisp program,
5373 store it in a Lisp variable. Example:
5375 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5380 ;; Normally we never clear mark-active except in Transient Mark mode.
5381 ;; But when we actually clear out the mark value too, we must
5382 ;; clear mark-active in any mode.
5384 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5385 ;; it should never be nil if the mark is nil.
5393 mark-active))
5400 ;; Mark marker
5406 ;; Mark active
5409 ;; If mark is active now, and either was not active or was at a
5410 ;; different place, run the activate hook.
5415 ;; If mark has ceased to be active, run deactivate hook.
5420 "Like `save-excursion', but also save and restore the mark state.
5421 This macro does what `save-excursion' did before Emacs 25.1."
5431 If nil, region-aware commands treat the empty region as inactive.
5432 If non-nil, region-aware commands treat the region as active as
5433 long as the mark is active, even if the region is empty.
5435 Region-aware commands are those that act on the region if it is
5436 active and Transient Mark mode is enabled, and on the text near
5437 point otherwise."
5443 "Return t if the region is active and it is appropriate to act on it.
5444 This is used by commands that act specially on the region under
5445 Transient Mark mode.
5447 The return value is t if Transient Mark mode is enabled and the
5448 mark is active; furthermore, if `use-empty-active-region' is nil,
5449 the region must not be empty. Otherwise, the return value is nil.
5451 For some commands, it may be appropriate to ignore the value of
5452 `use-empty-active-region'; in that case, use `region-active-p'."
5457 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5459 Some commands act specially on the region when Transient Mark
5460 mode is enabled. Usually, such commands should use
5461 `use-region-p' instead of this function, because `use-region-p'
5462 also checks the value of `use-empty-active-region'."
5464 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5465 ;; without the mark being set (e.g. bug#17324). We really should fix
5466 ;; that problem, but in the mean time, let's make sure we don't say the
5467 ;; region is active when there's no mark.
5471 "Return the boundaries of the region as a pair of positions.
5472 Value is a list of cons cells of the form (START . END)."
5476 "Return non-nil if the region contains several pieces.
5477 An example is a rectangular region handled as a list of
5478 separate contiguous regions for each line."
5491 ;; Normal priority so that a large region doesn't hide all the
5492 ;; overlays within it, but high secondary priority so that if it
5493 ;; ends/starts in the middle of a small overlay, that small overlay
5494 ;; won't hide the region's boundaries.
5496 nrol)
5501 rol)))
5517 start end window rol)))
5520 new))))))
5523 "Hook run just before redisplay.
5524 It is called in each window that is to be redisplayed. It takes one argument,
5525 which is the window that will be redisplayed. When run, the `current-buffer'
5546 "Maximum size of mark ring. Start discarding off end if gets this big."
5554 "Maximum size of global mark ring. \
5555 Start discarding off end if gets this big."
5560 "Jump to mark, and pop a new position for mark off the ring.
5561 \(Does not affect global mark ring)."
5571 "Set mark at where point is.
5572 If no prefix ARG and mark is already set there, just activate it.
5573 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5585 will pop the mark twice, and
5587 will pop the mark three times.
5595 "Set the mark where point is, and activate it; or jump to the mark.
5596 Setting the mark also alters the region, which is the text
5597 between point and mark; this is the closest equivalent in
5600 With no prefix argument, set the mark at point, and push the
5601 old mark position on local mark ring. Also push the new mark on
5602 global mark ring, if the previous mark was set in another buffer.
5604 When Transient Mark Mode is off, immediately repeating this
5605 command activates `transient-mark-mode' temporarily.
5608 jump to the mark, and set the mark from
5609 position popped off the local mark ring (this does not affect the global
5611 mark ring (see `pop-global-mark').
5613 If `set-mark-command-repeat-pop' is non-nil, repeating
5615 off the local (or global) mark ring and jumps there.
5618 argument, unconditionally set mark where point is, even if
5619 `set-mark-command-repeat-pop' is non-nil.
5621 Novice Emacs Lisp programmers often try to use the mark for the wrong
5622 purposes. See the documentation of `set-mark' for more information."
5642 arg)
5656 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5657 If the last global mark pushed was not in the current buffer,
5658 also push LOCATION on the global mark ring.
5659 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5661 Novice Emacs Lisp programmers often try to use the mark for the wrong
5662 purposes. See the documentation of `set-mark' for more information.
5664 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5671 ;; Now push the mark on the global mark ring.
5674 ;; The last global mark pushed was in this same buffer.
5675 ;; Don't push another one.
5676 nil
5685 nil)
5688 "Pop off mark ring into the buffer's actual mark.
5689 Does not set point. Does nothing if mark ring is empty."
5701 "Put the mark where point is now, and point where the mark is now.
5702 This command works even when the mark is not active,
5703 and it reactivates the mark.
5705 If Transient Mark mode is on, a prefix ARG deactivates the mark
5706 if it is active, and otherwise avoids reactivating it. If
5707 Transient Mark mode is off, a prefix ARG enables Transient Mark
5708 mode temporarily."
5722 nil))
5725 "When non-nil, shifted motion keys activate the mark momentarily.
5727 While the mark is activated in this way, any shift-translated point
5728 motion key extends the region, and if Transient Mark mode was off, it
5729 is temporarily turned on. Furthermore, the mark will be deactivated
5730 by any subsequent point motion key that was not shift-translated, or
5731 by any action that normally deactivates the mark in Transient Mark mode.
5733 See `this-command-keys-shift-translated' for the meaning of
5734 shift-translation."
5739 "Activate/deactivate mark depending on invocation thru shift translation.
5740 This function is called by `call-interactively' when a command
5741 with a `^' character in its `interactive' spec is invoked, before
5742 running the command itself.
5744 If `shift-select-mode' is enabled and the command was invoked
5745 through shift translation, set the mark and activate the region
5746 temporarily, unless it was already set in this way. See
5747 `this-command-keys-shift-translated' for the meaning of shift
5748 translation.
5750 Otherwise, if the region has been activated temporarily,
5751 deactivate it, and restore the variable `transient-mark-mode' to
5752 its earlier value."
5759 transient-mark-mode)))
5768 "Toggle Transient Mark mode.
5769 With a prefix argument ARG, enable Transient Mark mode if ARG is
5770 positive, and disable it otherwise. If called from Lisp, enable
5771 Transient Mark mode if ARG is omitted or nil.
5773 Transient Mark mode is a global minor mode. When enabled, the
5774 region is highlighted with the `region' face whenever the mark
5776 and after certain other operations that set the mark but whose
5777 main purpose is something else--for example, incremental search,
5783 Many commands change their behavior when Transient Mark mode is
5784 in effect and the mark is active, by acting on the region instead
5785 of their usual default part of the buffer's text. Examples of
5788 To see the documentation of commands which are sensitive to the
5791 :global t
5792 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5796 "Non-nil means it is ok for commands to call `widen' when they want to.
5797 Some commands will do this in order to go to positions outside
5798 the current accessible part of the buffer.
5800 If `widen-automatically' is nil, these commands will do something else
5804 "Whether the currently executing code is performing an essential task.
5805 This variable should be non-nil only when running code which should not
5806 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5807 user for a password when we are simply scanning a set of files in the
5808 background or displaying possible completions before the user even asked
5812 "Pop off global mark ring and jump to the top location."
5814 ;; Pop entries which refer to non-existent buffers.
5832 \f
5834 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5840 "Move cursor vertically down ARG lines.
5841 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5842 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5843 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5844 function will not vscroll.
5846 ARG defaults to 1.
5848 If there is no character in the target line exactly under the current column,
5849 the cursor is positioned after the character in that line which spans this
5850 column, or at the end of the line if it is not long enough.
5851 If there is no line in the buffer after this one, behavior depends on the
5852 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5853 to create a line, and moves the cursor to that line. Otherwise it moves the
5854 cursor to the end of the buffer.
5856 If the variable `line-move-visual' is non-nil, this command moves
5857 by display lines. Otherwise, it moves by buffer lines, without
5858 taking variable-width characters or continued lines into account.
5862 a semipermanent goal column for this command.
5863 Then instead of trying to move exactly vertically (or as close as possible),
5864 this command moves to the specified goal column (or as close as possible).
5865 The goal column is stored in the variable `goal-column', which is nil
5866 when there is no goal column. Note that setting `goal-column'
5867 overrides `line-move-visual' and causes this command to move by buffer
5868 lines rather than by display lines."
5874 ;; When adding a newline, don't expand an abbrev.
5885 nil)
5888 "Move cursor vertically up ARG lines.
5889 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5890 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5891 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5892 function will not vscroll.
5894 ARG defaults to 1.
5896 If there is no character in the target line exactly over the current column,
5897 the cursor is positioned after the character in that line which spans this
5898 column, or at the end of the line if it is not long enough.
5900 If the variable `line-move-visual' is non-nil, this command moves
5901 by display lines. Otherwise, it moves by buffer lines, without
5902 taking variable-width characters or continued lines into account.
5906 a semipermanent goal column for this command.
5907 Then instead of trying to move exactly vertically (or as close as possible),
5908 this command moves to the specified goal column (or as close as possible).
5909 The goal column is stored in the variable `goal-column', which is nil
5910 when there is no goal column. Note that setting `goal-column'
5911 overrides `line-move-visual' and causes this command to move by buffer
5912 lines rather than by display lines."
5923 nil)
5926 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5927 This means moving to the end of each line moved onto.
5928 The beginning of a blank line does not count as the end of a line.
5929 This has no effect when the variable `line-move-visual' is non-nil."
5935 A non-nil setting overrides the variable `line-move-visual', which see."
5942 "Current goal column for vertical motion.
5943 It is the column where point was at the start of the current run
5944 of vertical motion commands.
5946 When moving by visual lines via the function `line-move-visual', it is a cons
5947 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5948 divided by the default column width, and HSCROLL is the number of
5949 columns by which window is scrolled from left margin.
5951 When the `track-eol' feature is doing its job, the value is
5955 "Last value of width used for displaying line numbers.
5959 "Non-nil means commands that move by lines ignore invisible newlines.
5960 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5961 as if newlines that are invisible didn't exist, and count
5962 only visible newlines. Thus, moving across 2 newlines
5963 one of which is invisible will be counted as a one-line move.
5964 Also, a non-nil value causes invisible text to be ignored when
5965 counting columns for the purposes of keeping point in the same
5968 Outline mode sets this."
5973 "When non-nil, `line-move' moves point by visual lines.
5974 This movement is based on where the cursor is displayed on the
5975 screen, instead of relying on buffer contents alone. It takes
5976 into account variable-width characters and line continuation.
5977 If nil, `line-move' moves point by logical lines.
5978 A non-nil setting of `goal-column' overrides the value of this variable
5979 and forces movement by logical lines.
5980 A window that is horizontally scrolled also forces movement by logical
5981 lines."
5986 ;; Only used if display-graphic-p.
5990 "Return the height in pixels of the current buffer's default face font.
5992 If the default font is remapped (see `face-remapping-alist'), the
5993 function returns the height of the remapped face."
5997 ;; Avoid calling font-info if the frame's default font was
5998 ;; not changed since the frame was created. That's because
5999 ;; font-info is expensive for some fonts, see bug #14838.
6005 "Return the width in pixels of the current buffer's default face font.
6007 If the default font is remapped (see `face-remapping-alist'), the
6008 function returns the width of the remapped face."
6012 ;; Avoid calling font-info if the frame's default font was
6013 ;; not changed since the frame was created. That's because
6014 ;; font-info is expensive for some fonts, see bug #14838.
6019 width
6024 "Return the pixel height of current buffer's default-face text line.
6026 The value includes `line-spacing', if any, defined for the buffer
6027 or the frame."
6040 "Return the number of screen lines in the text area of the selected window.
6042 This is different from `window-text-height' in that this function counts
6043 lines in units of the height of the font used by the default face displayed
6044 in the window, not in units of the frame's default font, and also accounts
6045 for `line-spacing', if any, defined for the window's buffer or frame.
6047 The value is a floating-point number."
6052 ;; Returns non-nil if partial move was done.
6055 ;; Move backward (up).
6056 ;; If already vscrolled, reduce vscroll
6062 ;; Move forward (down).
6075 py vs last-line)
6095 col-row)
6100 ;; VPOS > 0 means the last line is only partially visible.
6101 ;; But if the part that is visible is at least as tall as the
6102 ;; default font, that means the line is actually fully
6103 ;; readable, and something like line-spacing is hidden. So in
6104 ;; that case we accept the last line in the window as still
6105 ;; visible, and consider the margin as starting one line
6106 ;; later.
6114 ;; If last line of window is fully visible, and vscrolling
6115 ;; more would make this line invisible, move forward.
6120 nil)
6121 ;; If cursor is not in the bottom scroll margin, and the
6122 ;; current line is not too tall, move forward.
6124 vpos
6127 nil)
6128 ;; When already vscrolled, we vscroll some more if we can,
6129 ;; or clear vscroll and move forward at end of tall image.
6134 ;; If cursor just entered the bottom scroll margin, move forward,
6135 ;; but also optionally vscroll one line so redisplay won't recenter.
6139 ;; Don't vscroll if the partially-visible line at window
6140 ;; bottom is not too tall (a.k.a. "just one more text
6141 ;; line"): in that case, we do want redisplay to behave
6142 ;; normally, i.e. recenter or whatever.
6143 ;;
6144 ;; Note: ROWH + RBOT from the value returned by
6145 ;; pos-visible-in-window-p give the total height of the
6146 ;; partially-visible glyph row at the end of the window. As
6147 ;; we are dealing with floats, we disregard sub-pixel
6148 ;; discrepancies between that and DLH.
6152 t)
6153 ;; If there are lines above the last line, scroll-up one line.
6156 t)
6157 ;; Finally, start vscroll.
6162 ;; This is like line-move-1 except that it also performs
6163 ;; vertical scrolling of tall images if appropriate.
6164 ;; That is not really a clean thing to do, since it mixes
6165 ;; scrolling with cursor motion. But so far we don't have
6166 ;; a cleaner solution to the problem of making C-n do something
6167 ;; useful given a tall image.
6169 "Move forward ARG lines.
6170 If NOERROR, don't signal an error if we can't move ARG lines.
6171 TO-END is unused.
6172 TRY-VSCROLL controls whether to vscroll tall lines: if either
6173 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6174 not vscroll."
6178 ;; Only vscroll for single line moves
6180 ;; Under scroll-conservatively, the display engine
6181 ;; does this better.
6183 ;; But don't vscroll in a keyboard macro.
6189 ;; Display-based column are incompatible with goal-column.
6191 ;; When the text in the window is scrolled to the left,
6192 ;; display-based motion doesn't make sense (because each
6193 ;; logical line occupies exactly one screen line).
6195 ;; Likewise when the text _was_ scrolled to the left
6196 ;; when the current run of vertical motion commands
6197 ;; started.
6200 auto-hscroll-mode
6202 (>= temporary-goal-column
6205 ;; If we moved into a tall line, set vscroll to make
6206 ;; scrolling through tall images more smooth.
6210 winh)
6216 nil
6220 ;; Display-based alternative to line-move-1.
6221 ;; Arg says how many lines to move. The value is t if we can move the
6222 ;; specified number of lines.
6224 "Move ARG lines forward.
6225 If NOERROR, don't signal an error if we can't move that many lines."
6229 target-hscroll)
6230 ;; Check if the previous command was a line-motion command, or if
6231 ;; we were called from some other command.
6234 ;; If so, there's no need to reset `temporary-goal-column',
6235 ;; but we may need to hscroll.
6240 ;; Update the COLUMN part of temporary-goal-column if the
6241 ;; line-number display changed its width since the last
6242 ;; time.
6249 ;; Otherwise, we should reset `temporary-goal-column'.
6251 x-pos)
6253 ;; Handle the `overflow-newline-into-fringe' case
6254 ;; (left-fringe is for the R2L case):
6259 ;; In R2L lines, the X pixel coordinate is measured from the
6260 ;; left edge of the window, but columns are still counted
6261 ;; from the logical-order beginning of the line, i.e. from
6262 ;; the right edge in this case. We need to adjust for that.
6268 hscroll)))
6270 ;; When we move beyond the first/last character visible in
6271 ;; the window, posn-at-point will return nil, so we need to
6272 ;; approximate the goal column as below.
6277 ;; vertical-motion can move more than it was asked to if it moves
6278 ;; across display strings with newlines. We don't want to ring
6279 ;; the bell and announce beginning/end of buffer in that case.
6285 temporary-goal-column))
6286 arg))
6287 arg))
6293 temporary-goal-column))
6294 arg))
6295 arg)))
6298 ;; If the goal column lies on a display string,
6299 ;; `vertical-motion' advances the cursor to the end
6300 ;; of the string. For arg < 0, this can cause the
6301 ;; cursor to get stuck. (Bug#3020).
6305 nil)))))
6307 ;; This is the guts of next-line and previous-line.
6308 ;; Arg says how many lines to move.
6309 ;; The value is t if we can move the specified number of lines.
6311 ;; Don't run any point-motion hooks, and disregard intangibility,
6312 ;; for intermediate positions.
6324 ;; Don't count beg of empty line as end of line
6325 ;; unless we just did explicit end-of-line.
6327 most-positive-fixnum
6331 line-move-ignore-invisible))
6332 ;; Use just newline characters.
6333 ;; Set ARG to 0 if we move as many lines as requested.
6336 ;; This way of moving forward ARG lines
6337 ;; verifies that we have a newline after the last one.
6338 ;; It doesn't get confused by intangible text.
6347 'beginning-of-buffer
6349 nil)))
6350 ;; Move by arg lines, but ignore invisible ones.
6353 ;; If the following character is currently invisible,
6354 ;; skip all characters with that same `invisible' property value.
6357 ;; Move a line.
6358 ;; We don't use `end-of-line', since we want to escape
6359 ;; from field boundaries occurring exactly at point.
6365 ;; If there's no invisibility here, move over the newline.
6374 ;; We avoid vertical-motion when possible
6375 ;; because that has to fontify.
6377 ;; Otherwise move a more sophisticated way.
6384 ;; The logic of this is the same as the loop above,
6385 ;; it just goes in the other direction.
6387 ;; For completely consistency with the forward-motion
6388 ;; case, we should call beginning-of-line here.
6389 ;; However, if point is inside a field and on a
6390 ;; continued line, the call to (vertical-motion -1)
6391 ;; below won't move us back far enough; then we return
6392 ;; to the same column in line-move-finish, and point
6393 ;; gets stuck -- cyd
6411 ;; if our target is the middle of this line.
6416 ;; This is the value the function returns.
6420 ;; If we did not move down as far as desired, at least go
6421 ;; to end of line. Be sure to call point-entered and
6422 ;; point-left-hooks.
6428 ;; If we did not move up as far as desired,
6429 ;; at least go to beginning of line.
6441 ;; Set REPEAT to t to repeat the whole thing.
6448 ;; Compute the end of the line
6449 ;; ignoring effectively invisible newlines.
6451 ;; Like end-of-line but ignores fields.
6458 ;; Move to the desired column.
6461 ;; Under line-move-visual, goal-column should be
6462 ;; interpreted in units of the frame's canonical character
6463 ;; width, which is exactly what vertical-motion does.
6467 ;; Corner case: suppose we start out in a field boundary in
6468 ;; the middle of a continued line. When we get to
6469 ;; line-move-finish, point is at the start of a new *screen*
6470 ;; line but the same text line; then line-move-to-column would
6471 ;; move us backwards. Test using C-n with point on the "x" in
6472 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6479 ;; Process intangibility within a line.
6480 ;; With inhibit-point-motion-hooks bound to nil, a call to
6481 ;; goto-char moves point past intangible text.
6483 ;; However, inhibit-point-motion-hooks controls both the
6484 ;; intangibility and the point-entered/point-left hooks. The
6485 ;; following hack avoids calling the point-* hooks
6486 ;; unnecessarily. Note that we move *forward* past intangible
6487 ;; text when the initial and final points are the same.
6492 ;; If intangibility moves us to a different (later) place
6493 ;; in the same line, use that as the destination.
6496 ;; If that position is "too late",
6497 ;; try the previous allowable position.
6498 ;; See if it is ok.
6501 ;; If going forward, don't accept the previous
6502 ;; allowable position if it is before the target line.
6504 ;; If going backward, don't accept the previous
6505 ;; allowable position if it is still after the target line.
6508 ;; As a last resort, use the end of the line.
6511 ;; Now move to the updated destination, processing fields
6512 ;; as well as intangibility.
6516 ;; Ignore field boundaries if the initial and final
6517 ;; positions have the same `field' property, even if the
6518 ;; fields are non-contiguous. This seems to be "nicer"
6519 ;; behavior in many situations.
6522 new
6526 ;; If all this moved us to a different line,
6527 ;; retry everything within that new line.
6529 ;; Repeat the intangibility and field processing.
6533 "Try to find column COL, considering invisibility.
6534 This function works only in certain cases,
6535 because what we really need is for `move-to-column'
6536 and `current-column' to be able to ignore invisible text."
6545 ;; If the following character is currently invisible,
6546 ;; skip all characters with that same `invisible' property value.
6550 ;; Have we advanced to a larger column position?
6552 ;; We have made some progress towards the desired column.
6553 ;; See if we can make any further progress.
6555 ;; Otherwise, go to the place we originally found
6556 ;; and move back over invisible text.
6557 ;; that will get us to the same place on the screen
6558 ;; but with a more reasonable buffer position.
6561 ;; We want the real line beginning, so it's consistent
6562 ;; with bolp below, otherwise we might infloop.
6569 "Move point to end of current line as displayed.
6570 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6571 If point reaches the beginning or end of buffer, it stops there.
6573 To ignore the effects of the `intangible' text or overlay
6574 property, bind `inhibit-point-motion-hooks' to t.
6575 If there is an image in the current line, this function
6576 disregards newlines that are part of the text on which the image
6577 rests."
6587 ;; With bidi reordering, we may not be at bol,
6588 ;; so make sure we are.
6603 ;; If we skipped something intangible and now we're not
6604 ;; really at eol, keep going.
6609 "Move point to beginning of current line as displayed.
6610 \(If there's an image in the line, this disregards newlines
6611 which are part of the text that the image rests on.)
6613 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6614 If point reaches the beginning or end of buffer, it stops there.
6615 \(But if the buffer doesn't end in a newline, it stops at the
6616 beginning of the last line.)
6617 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6622 first-vis first-vis-field-value)
6624 ;; Move by lines, if ARG is not 1 (the default).
6629 ;; Move to beginning-of-line, ignoring fields and invisible text.
6635 ;; Now find first visible char in the line.
6640 ;; See if fields would stop us from reaching FIRST-VIS.
6645 ;; If yes, obey them.
6646 first-vis-field-value
6647 ;; Otherwise, move to START with attention to fields.
6648 ;; (It is possible that fields never matter in this case.)
6653 ;; Many people have said they rarely use this feature, and often type
6654 ;; it by accident. Maybe it shouldn't even be on a key.
6659 Those commands will move to this position in the line moved to
6660 rather than trying to keep the same horizontal position.
6661 With a non-nil argument ARG, clears out the goal column
6663 The goal column is stored in the variable `goal-column'.
6664 This is a buffer-local setting."
6671 ;; The older method below can be erroneous if `set-goal-column' is bound
6672 ;; to a sequence containing %
6673 ;;(message (substitute-command-keys
6674 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6675 ;;goal-column)
6682 )
6683 nil)
6684 \f
6685 ;;; Editing based on visual lines, as opposed to logical lines.
6688 "Move point to end of current visual line.
6689 With argument N not nil or 1, move forward N - 1 visual lines first.
6690 If point reaches the beginning or end of buffer, it stops there.
6691 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6697 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6698 ;; constrain to field boundaries, so we don't either.
6702 "Move point to beginning of current visual line.
6703 With argument N not nil or 1, move forward N - 1 visual lines first.
6704 If point reaches the beginning or end of buffer, it stops there.
6705 \(But if the buffer doesn't end in a newline, it stops at the
6706 beginning of the last visual line.)
6707 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6715 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6719 "Kill the rest of the visual line.
6720 With prefix argument ARG, kill that many visual lines from point.
6721 If ARG is negative, kill visual lines backward.
6722 If ARG is zero, kill the text before point on the current visual
6723 line.
6725 If you want to append the killed line to the last killed text,
6728 If the buffer is read-only, Emacs will beep and refrain from deleting
6729 the line, but put the line in the kill ring anyway. This means that
6730 you can use this command to copy text from a read-only buffer.
6731 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6732 even beep.)"
6734 ;; Like in `kill-line', it's better to move point to the other end
6735 ;; of the kill before killing.
6743 ;; Skip any trailing whitespace at the end of the visual line.
6744 ;; We used to do this only if `show-trailing-whitespace' is
6745 ;; nil, but that's wrong; the correct thing would be to check
6746 ;; whether the trailing whitespace is highlighted. But, it's
6747 ;; OK to just do this unconditionally.
6754 "Move cursor vertically down ARG lines.
6755 This is identical to `next-line', except that it always moves
6756 by logical lines instead of visual lines, ignoring the value of
6757 the variable `line-move-visual'."
6764 "Move cursor vertically up ARG lines.
6765 This is identical to `previous-line', except that it always moves
6766 by logical lines instead of visual lines, ignoring the value of
6767 the variable `line-move-visual'."
6774 "Editing based on visual lines."
6783 ;; These keybindings interfere with xterm function keys. Are
6784 ;; there any other suitable bindings?
6785 ;; (define-key map "\M-[" 'previous-logical-line)
6786 ;; (define-key map "\M-]" 'next-logical-line)
6787 map))
6790 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6791 The value should be a list of the form (LEFT RIGHT), where LEFT
6792 and RIGHT are symbols representing the bitmaps to display, to
6793 indicate wrapped lines, in the left and right fringes respectively.
6794 See also `fringe-indicator-alist'.
6795 The default is not to display fringe indicators for wrapped lines.
6796 This variable does not affect fringe indicators displayed for
6797 other purposes."
6812 'continuation
6819 "Toggle visual line based editing (Visual Line mode) in the current buffer.
6820 Interactively, with a prefix argument, enable
6821 Visual Line mode if the prefix argument is positive,
6822 and disable it otherwise. If called from Lisp, toggle
6823 the mode if ARG is `toggle', disable the mode if ARG is
6824 a non-positive integer, and enable the mode otherwise
6825 \(including if ARG is omitted or nil or a positive integer).
6827 When Visual Line mode is enabled, `word-wrap' is turned on in
6828 this buffer, and simple editing commands are redefined to act on
6829 visual lines, not logical lines. See Info node `Visual Line
6830 Mode' for details."
6831 :keymap visual-line-mode-map
6837 ;; Save the local values of some variables, to be restored if
6838 ;; visual-line-mode is turned off.
6840 truncate-partial-width-windows
6841 word-wrap fringe-indicator-alist))
6844 visual-line--saved-state)))
6848 word-wrap t
6849 fringe-indicator-alist
6851 fringe-indicator-alist)))
6865 visual-line-mode turn-on-visual-line-mode)
6867 \f
6869 "Interchange characters around point, moving forward one character.
6870 With prefix arg ARG, effect is to take character before point
6871 and drag it forward past ARG other characters (backward if ARG negative).
6872 If no argument and at end of line, the previous two chars are exchanged."
6880 "Interchange words around point, leaving point at end of them.
6881 With prefix arg ARG, effect is to take word before or around point
6882 and drag it forward past ARG other words (backward if ARG negative).
6883 If ARG is zero, the words around or after point and around or after mark
6884 are interchanged."
6885 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6891 Unlike `transpose-words', point must be between the two sexps and not
6892 in the middle of a sexp to be transposed.
6893 With non-zero prefix arg ARG, effect is to take the sexp before point
6894 and drag it forward past ARG other sexps (backward if ARG is negative).
6895 If ARG is zero, the sexps ending at or after point and at or after mark
6896 are interchanged."
6900 ;; Here we should try to simulate the behavior of
6901 ;; (cons (progn (forward-sexp x) (point))
6902 ;; (progn (forward-sexp (- x)) (point)))
6903 ;; Except that we don't want to rely on the second forward-sexp
6904 ;; putting us back to where we want to be, since forward-sexp-function
6905 ;; might do funny things like infix-precedence.
6910 ;; Jumping over a symbol. We might be inside it, mind you.
6915 ;; Otherwise, we're between sexps. Take a step back before jumping
6916 ;; to make sure we'll obey the same precedence no matter which direction
6917 ;; we're going.
6922 'skip-syntax-forward
6929 "Exchange current line and previous line, leaving point after both.
6930 With argument ARG, takes previous line and moves it past ARG lines.
6931 With argument 0, interchanges line point is in with line mark is in."
6937 ;; Move forward over ARG lines,
6938 ;; but create newlines if necessary.
6945 arg))
6947 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6948 ;; which seems inconsistent with the ARG /= 0 case.
6949 ;; FIXME document SPECIAL.
6951 "Subroutine to do the work of transposing objects.
6952 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6953 moves forward by units of the given object (e.g. forward-sentence,
6954 forward-paragraph). If ARG is zero, exchanges the current object
6955 with the one containing mark. If ARG is an integer, moves the
6956 current object past ARG following (if ARG is positive) or
6957 preceding (if ARG is negative) objects, leaving point after the
6958 current object."
6963 pos1 pos2)
6992 ;; This sequence of insertions attempts to preserve marker
6993 ;; positions at the start and end of the transposed objects.
7007 \f
7009 "Move backward until encountering the beginning of a word.
7010 With argument ARG, do this that many times.
7011 If ARG is omitted or nil, move point backward one word.
7013 The word boundaries are normally determined by the buffer's syntax
7014 table, but `find-word-boundary-function-table', such as set up
7015 by `subword-mode', can change that. If a Lisp program needs to
7016 move by words determined strictly by the syntax table, it should
7017 use `backward-word-strictly' instead."
7022 "Set mark ARG words away from point.
7024 move to with the same argument.
7025 Interactively, if this command is repeated
7026 or (in Transient Mark mode) if the mark is active,
7027 it marks the next ARG words after the ones already marked."
7044 nil t))))
7047 "Kill characters forward until encountering the end of a word.
7048 With argument ARG, do this that many times."
7053 "Kill characters backward until encountering the beginning of a word.
7054 With argument ARG, do this that many times."
7059 "Return the word at or near point, as a string.
7060 The return value includes no text properties.
7062 If optional arg STRICT is non-nil, return nil unless point is
7063 within or adjacent to a word, otherwise look for a word within
7064 point's line. If there is no word anywhere on point's line, the
7065 value is nil regardless of STRICT.
7067 By default, this function treats as a single word any sequence of
7068 characters that have either word or symbol syntax. If optional
7069 arg REALLY-WORD is non-nil, only characters of word syntax can
7070 constitute a word."
7079 ;; Point is neither within nor adjacent to a word.
7081 ;; Look for preceding word in same line.
7084 ;; No preceding word in same line.
7085 ;; Look for following word in same line.
7094 ;; If we found something nonempty, return it as a string.
7097 \f
7099 "String for filling to insert at front of new line, or nil for none."
7101 string)
7107 "Regexp to match lines which should not be auto-filled."
7109 regexp)
7113 "The default value for `normal-auto-fill-function'.
7114 This is the default auto-fill function, some major modes use a different one.
7115 Returns t if it really did any work."
7125 nil ;; Auto-filling not required
7129 ;; Choose a fill-prefix automatically.
7137 ;; Use auto-indentation rather than a guessed empty prefix.
7143 ;; Determine where to split the line.
7147 ;; Don't split earlier in the line than the length of the
7148 ;; fill prefix, since the resulting line would be longer.
7156 ;; See whether the place we found is any good.
7160 ;; There is no use breaking at end of line.
7162 ;; Don't split right after a comment starter
7163 ;; since we would just make another comment starter.
7168 limit t)
7170 ;; No good place to break => stop trying.
7172 ;; Ok, we have a useful place to break the line. Do it.
7174 ;; If point is at the fill-point, do not `save-excursion'.
7175 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7176 ;; point will end up before it rather than after it.
7184 ;; Now do justification, if required
7189 ;; If making the new line didn't reduce the hpos of
7190 ;; the end of the line, then give up now;
7191 ;; trying again will not help.
7194 ;; Justify last line.
7196 t)))
7199 "Mode-specific function which line breaks and continues a comment.
7200 This function is called during auto-filling when a comment syntax
7201 is defined.
7202 The function should take a single optional argument, which is a flag
7206 "Break line at point and indent.
7207 If a comment syntax is defined, call `comment-indent-new-line'.
7209 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7210 unless optional argument SOFT is non-nil."
7214 ;; Insert the newline before removing empty space so that markers
7215 ;; get preserved better.
7221 ;; Blindly trust a non-adaptive fill-prefix.
7227 ;; If there's an adaptive prefix, use it unless we're inside
7228 ;; a comment and the prefix is not a comment starter.
7232 ;; If we're not inside a comment, just try to indent.
7236 "The function called by `self-insert-command' to perform auto-filling."
7243 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7247 ;; `functions' and `hooks' are usually unsafe to set, but setting
7248 ;; auto-fill-function to nil in a file-local setting is safe and
7249 ;; can be useful to prevent auto-filling.
7253 "Toggle automatic line breaking (Auto Fill mode).
7254 Interactively, with a prefix argument, enable
7255 Auto Fill mode if the prefix argument is positive,
7256 and disable it otherwise. If called from Lisp, toggle
7257 the mode if ARG is `toggle', disable the mode if ARG is
7258 a non-positive integer, and enable the mode otherwise
7259 \(including if ARG is omitted or nil or a positive integer).
7261 When Auto Fill mode is enabled, inserting a space at a column
7262 beyond `current-fill-column' automatically breaks the line at a
7263 previous space.
7265 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7266 non-nil.
7268 The value of `normal-auto-fill-function' specifies the function to use
7269 for `auto-fill-function' when turning Auto Fill mode on."
7274 ;; This holds a document string used to document auto-fill-mode.
7276 "Automatically break line at a previous space, in insertion of text."
7277 nil)
7280 "Unconditionally turn on Auto Fill mode."
7284 "Unconditionally turn off Auto Fill mode."
7290 "Set `fill-column' to specified argument.
7295 ;; We used to use current-column silently, but C-x f is too easily
7296 ;; typed as a typo for C-x C-f, so we turned it into an error and
7297 ;; now an interactive prompt.
7302 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7306 \f
7308 "Set `selective-display' to ARG; clear it if no arg.
7309 When the value of `selective-display' is a number > 0,
7310 lines whose indentation is >= that value are not displayed.
7311 The variable `selective-display' has a separate value for each buffer."
7331 "Toggle truncating of long lines for the current buffer.
7332 When truncating is off, long lines are folded.
7333 With prefix argument ARG, truncate long lines if ARG is positive,
7334 otherwise fold them. Note that in side-by-side windows, this
7335 command has no effect if `truncate-partial-width-windows' is
7336 non-nil."
7348 nil t)))
7353 "Toggle whether to use word-wrapping for continuation lines.
7354 With prefix argument ARG, wrap continuation lines at word boundaries
7355 if ARG is positive, otherwise wrap them at the right screen edge.
7356 This command toggles the value of `word-wrap'. It has no effect
7357 if long lines are truncated."
7373 "Toggle Overwrite mode.
7374 With a prefix argument ARG, enable Overwrite mode if ARG is
7375 positive, and disable it otherwise. If called from Lisp, enable
7376 the mode if ARG is omitted or nil.
7378 When Overwrite mode is enabled, printing characters typed in
7379 replace existing text on a one-for-one basis, rather than pushing
7380 it to the right. At the end of a line, such characters extend
7381 the line. Before a tab, such characters insert until the tab is
7383 overwrite mode; this is supposed to make it easier to insert
7384 characters when necessary."
7389 "Toggle Binary Overwrite mode.
7390 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7391 is positive, and disable it otherwise. If called from Lisp,
7392 enable the mode if ARG is omitted or nil.
7394 When Binary Overwrite mode is enabled, printing characters typed
7395 in replace existing text. Newlines are not treated specially, so
7396 typing at the end of a line joins the line to the next, with the
7397 typed character between them. Typing before a tab character
7398 simply replaces the tab with the character typed.
7400 ordinary typing characters do.
7402 Note that Binary Overwrite mode is not its own minor mode; it is
7403 a specialization of overwrite mode, entered by setting the
7404 `overwrite-mode' variable to `overwrite-mode-binary'."
7409 "Toggle line number display in the mode line (Line Number mode).
7410 With a prefix argument ARG, enable Line Number mode if ARG is
7411 positive, and disable it otherwise. If called from Lisp, enable
7412 the mode if ARG is omitted or nil.
7414 Line numbers do not appear for very large buffers and buffers
7415 with very long lines; see variables `line-number-display-limit'
7416 and `line-number-display-limit-width'."
7420 "Toggle column number display in the mode line (Column Number mode).
7421 With a prefix argument ARG, enable Column Number mode if ARG is
7422 positive, and disable it otherwise.
7424 If called from Lisp, enable the mode if ARG is omitted or nil."
7428 "Toggle buffer size display in the mode line (Size Indication mode).
7429 With a prefix argument ARG, enable Size Indication mode if ARG is
7430 positive, and disable it otherwise.
7432 If called from Lisp, enable the mode if ARG is omitted or nil."
7436 "Toggle auto-saving in the current buffer (Auto Save mode).
7437 With a prefix argument ARG, enable Auto Save mode if ARG is
7438 positive, and disable it otherwise.
7440 If called from Lisp, enable the mode if ARG is omitted or nil."
7442 ;; If auto-save is off because buffer has shrunk,
7443 ;; then toggling should turn it on.
7451 buffer-file-name)
7453 ;; If -1 was stored here, to temporarily turn off saving,
7454 ;; turn it back on.
7457 \f
7459 "Blinking matching of parens and expressions."
7464 "Non-nil means show matching open-paren when close-paren is inserted.
7465 If t, highlight the paren. If `jump', briefly move cursor to its
7466 position. If `jump-offscreen', move cursor there even if the
7467 position is off screen. With any other non-nil value, the
7468 off-screen position of the opening paren will be shown in the
7469 echo area."
7478 "Non-nil means show matching open-paren when it is on screen.
7479 If nil, don't show it (but the open-paren can still be shown
7480 in the echo area when it is off screen).
7482 This variable has no effect if `blink-matching-paren' is nil.
7483 \(In that case, the open-paren is never shown.)
7484 It is also ignored if `show-paren-mode' is enabled."
7489 "If non-nil, maximum distance to search backwards for matching open-paren.
7490 If nil, search stops at the beginning of the accessible portion of the buffer."
7496 "Time in seconds to delay after showing a matching paren."
7501 "If nil, `blink-matching-paren' ignores comments.
7502 More precisely, when looking for the matching parenthesis,
7503 it skips the contents of comments that end before point."
7508 "Return whether or not START...END are matching parens.
7509 END is the current point and START is the blink position.
7510 START might be nil if no matching starter was found.
7511 Returns non-nil if we find there is a mismatch."
7516 ;; For self-matched chars like " and $, we can't know when they're
7517 ;; mismatched or unmatched, so we can only do it for parens.
7522 ;; The cdr might hold a new paren-class info rather than
7523 ;; a matching-char info, in which case the two CDRs
7524 ;; should match.
7528 "Function to check parentheses mismatches.
7529 The function takes two arguments (START and END) where START is the
7530 position just before the opening token and END is the position right after.
7531 START can be nil, if it was not found.
7538 ol)
7542 "Momentarily highlight the beginning of the sexp before point."
7545 blink-matching-paren)
7555 oldpos))
7563 ;; backward-sexp skips backward over prefix chars,
7564 ;; so move back to the matching paren.
7587 ;; Matching open within window, temporarily move to or highlight
7588 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7589 ;; is non-nil.
7606 ;; Show what precedes the open in its line, if anything.
7611 ;; Show what follows the open in its line, if anything.
7618 ;; Otherwise show the previous nonblank line,
7619 ;; if there is one.
7628 ;; Replace the newline and other whitespace with `...'.
7629 "..."
7631 ;; There is nothing to show except the char itself.
7634 "Matches %s"
7638 "Function called, if non-nil, whenever a close parenthesis is inserted.
7644 blink-paren-function
7647 ;; Verify an even number of quoting characters precede the close.
7648 ;; FIXME: Also check if this parenthesis closes a comment as
7649 ;; can happen in Pascal and SML.
7660 ;; Most likely, this hook is nil, so this arg doesn't matter,
7661 ;; but I use it as a reminder that this function usually
7662 ;; likes to be run after others since it does
7663 ;; `sit-for'. That's also the reason it get a `priority' prop
7664 ;; of 100.
7666 \f
7667 ;; This executes C-g typed while Emacs is waiting for a command.
7668 ;; Quitting out of a program does not go through here;
7669 ;; that happens in the maybe_quit function at the C code level.
7671 "Signal a `quit' condition.
7672 During execution of Lisp code, this character causes a quit directly.
7673 At top-level, as an editor command, this simply beeps."
7675 ;; Avoid adding the region to the window selection.
7683 ;; Force the next redisplay cycle to remove the "Def" indicator from
7684 ;; all the mode lines.
7698 This command can exit an interactive command such as `query-replace',
7699 can clear out a prefix argument or a region,
7700 can get out of the minibuffer or other recursive edit,
7701 cancel the use of the current buffer (for special-purpose buffers),
7702 or go back to just one window (by deleting all but the selected window)."
7710 nil)
7721 "Play sound stored in FILE.
7722 VOLUME and DEVICE correspond to the keywords of the sound
7723 specification for `play-sound'."
7733 \f
7735 "Your preference for a mail reading package.
7736 This is used by some keybindings which support reading mail.
7737 See also `mail-user-agent' concerning sending mail."
7747 "Your preference for a mail composition package.
7748 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7749 outgoing email message. This variable lets you specify which
7750 mail-sending package you prefer.
7752 Valid values include:
7754 `message-user-agent' -- use the Message package.
7755 See Info node `(message)'.
7756 `sendmail-user-agent' -- use the Mail package.
7757 See Info node `(emacs)Sending Mail'.
7758 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7759 See Info node `(mh-e)'.
7760 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7761 paraphernalia if Gnus is running, particularly
7762 the Gcc: header for archiving.
7764 Additional valid symbols may be available; check with the author of
7765 your package for details. The function should return non-nil if it
7766 succeeds.
7768 See also `read-mail-command' concerning reading mail."
7771 message-user-agent)
7774 sendmail-user-agent)
7777 mh-e-user-agent)
7780 gnus-user-agent)
7786 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7787 If the value of `mail-user-agent' is the default, and the user
7788 appears to have customizations applying to the old default,
7789 `compose-mail' issues a warning."
7795 "If the buffer starts with a mail header, move point to the header's end.
7796 Otherwise, moves to `point-min'.
7797 The end of the header is the start of the next line, if there is one,
7798 else the end of the last line. This function obeys RFC822."
7804 ;; Used by Rmail (e.g., rmail-forward).
7806 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7810 switch-function yank-action send-actions
7811 return-action)
7812 "Start composing a mail message to send.
7813 This uses the user's chosen mail composition package
7814 as selected with the variable `mail-user-agent'.
7815 The optional arguments TO and SUBJECT specify recipients
7816 and the initial Subject field, respectively.
7818 OTHER-HEADERS is an alist specifying additional
7819 header fields. Elements look like (HEADER . VALUE) where both
7820 HEADER and VALUE are strings.
7822 CONTINUE, if non-nil, says to continue editing a message already
7823 being composed. Interactively, CONTINUE is the prefix argument.
7825 SWITCH-FUNCTION, if non-nil, is a function to use to
7826 switch to and display the buffer used for mail composition.
7828 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7829 to insert the raw text of the message being replied to.
7830 It has the form (FUNCTION . ARGS). The user agent will apply
7831 FUNCTION to ARGS, to insert the raw text of the original message.
7832 \(The user agent will also run `mail-citation-hook', *after* the
7833 original text has been inserted in this way.)
7835 SEND-ACTIONS is a list of actions to call when the message is sent.
7836 Each action has the form (FUNCTION . ARGS).
7838 RETURN-ACTION, if non-nil, is an action for returning to the
7839 caller. It has the form (FUNCTION . ARGS). The function is
7840 called after the mail has been sent or put aside, and the mail
7841 buffer buried."
7845 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7846 ;; from sendmail-user-agent to message-user-agent. Some users may
7847 ;; encounter incompatibilities. This hack tries to detect problems
7848 ;; and warn about them.
7853 mail-yank-hooks mail-archive-file-name
7854 mail-default-reply-to mail-mailing-lists
7855 mail-self-blind))
7862 The default mail mode is now Message mode.
7863 You have the following Mail mode variable%s customized:
7865 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7872 yank-action send-actions return-action)))
7875 yank-action send-actions
7876 return-action)
7880 'switch-to-buffer-other-window yank-action send-actions
7881 return-action))
7884 yank-action send-actions
7885 return-action)
7889 'switch-to-buffer-other-frame yank-action send-actions
7890 return-action))
7892 \f
7894 "History of values entered with `set-variable'.
7896 Maximum length of the history list is determined by the value
7900 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7901 VARIABLE should be a user option variable name, a Lisp variable
7902 meant to be customized by users. You should enter VALUE in Lisp syntax,
7903 so if you want VALUE to be a string, you must surround it with doublequotes.
7904 VALUE is used literally, not evaluated.
7906 If VARIABLE has a `variable-interactive' property, that is used as if
7907 it were the arg to `interactive' (which see) to interactively read VALUE.
7909 If VARIABLE has been defined with `defcustom', then the type information
7910 in the definition is used to check that VALUE is valid.
7912 Note that this function is at heart equivalent to the basic `set' function.
7913 For a variable defined with `defcustom', it does not pay attention to
7914 any :set property that the variable might have (if you want that, use
7917 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7922 default-var)
7938 var obsolete)
7941 ;; Use VAR's `variable-interactive' property
7942 ;; as an interactive spec for prompting.
7945 arg))
7947 read-expression-map t
7948 'set-variable-value-history
7957 ;; Match with custom type.
7969 ;; Force a thorough redisplay for the case that the variable
7970 ;; has an effect on the display, like `tab-width' has.
7972 \f
7973 ;; Define the major mode for lists of completions.
7983 (define-key map [right] 'next-completion)
7985 (define-key map [backtab] 'previous-completion)
7986 (define-key map "q" 'quit-window)
7987 (define-key map "z" 'kill-current-buffer)
7988 map)
7989 "Local map for completion list buffers.")
7991 ;; Completion mode is suitable only for specially formatted data.
7992 (put 'completion-list-mode 'mode-class 'special)
7994 (defvar completion-reference-buffer nil
7995 "Record the buffer that was current when the completion list was requested.
7996 This is a local variable in the completion list buffer.
7997 Initial value is nil to avoid some compiler warnings.")
7999 (defvar completion-no-auto-exit nil
8000 "Non-nil means `choose-completion-string' should never exit the minibuffer.
8001 This also applies to other functions such as `choose-completion'.")
8003 (defvar completion-base-position nil
8004 "Position of the base of the text corresponding to the shown completions.
8005 This variable is used in the *Completions* buffers.
8006 Its value is a list of the form (START END) where START is the place
8007 where the completion should be inserted and END (if non-nil) is the end
8008 of the text to replace. If END is nil, point is used instead.")
8010 (defvar completion-list-insert-choice-function #'completion--replace
8011 "Function to use to insert the text chosen in *Completions*.
8012 Called with three arguments (BEG END TEXT), it should replace the text
8013 between BEG and END with TEXT. Expected to be set buffer-locally
8014 in the *Completions* buffer.")
8016 (defvar completion-base-size nil
8017 "Number of chars before point not involved in completion.
8018 This is a local variable in the completion list buffer.
8019 It refers to the chars in the minibuffer if completing in the
8020 minibuffer, or in `completion-reference-buffer' otherwise.
8021 Only characters in the field at point are included.
8023 If nil, Emacs determines which part of the tail end of the
8024 buffer's text is involved in completion by comparing the text
8025 directly.")
8026 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
8028 (defun delete-completion-window ()
8029 "Delete the completion list window.
8030 Go to the window from which completion was requested."
8031 (interactive)
8032 (let ((buf completion-reference-buffer))
8033 (if (one-window-p t)
8034 (if (window-dedicated-p) (delete-frame))
8035 (delete-window (selected-window))
8036 (if (get-buffer-window buf)
8037 (select-window (get-buffer-window buf))))))
8039 (defun previous-completion (n)
8040 "Move to the previous item in the completion list."
8041 (interactive "p")
8042 (next-completion (- n)))
8044 (defun next-completion (n)
8045 "Move to the next item in the completion list.
8046 With prefix argument N, move N items (negative N means move backward)."
8047 (interactive "p")
8048 (let ((beg (point-min)) (end (point-max)))
8049 (while (and (> n 0) (not (eobp)))
8050 ;; If in a completion, move to the end of it.
8051 (when (get-text-property (point) 'mouse-face)
8052 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8053 ;; Move to start of next one.
8054 (unless (get-text-property (point) 'mouse-face)
8055 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8056 (setq n (1- n)))
8057 (while (and (< n 0) (not (bobp)))
8058 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
8059 ;; If in a completion, move to the start of it.
8060 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
8061 (goto-char (previous-single-property-change
8062 (point) 'mouse-face nil beg)))
8063 ;; Move to end of the previous completion.
8064 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
8065 (goto-char (previous-single-property-change
8066 (point) 'mouse-face nil beg)))
8067 ;; Move to the start of that one.
8068 (goto-char (previous-single-property-change
8069 (point) 'mouse-face nil beg))
8070 (setq n (1+ n))))))
8072 (defun choose-completion (&optional event)
8073 "Choose the completion at point.
8074 If EVENT, use EVENT's position to determine the starting position."
8075 (interactive (list last-nonmenu-event))
8076 ;; In case this is run via the mouse, give temporary modes such as
8077 ;; isearch a chance to turn off.
8078 (run-hooks 'mouse-leave-buffer-hook)
8079 (with-current-buffer (window-buffer (posn-window (event-start event)))
8080 (let ((buffer completion-reference-buffer)
8081 (base-size completion-base-size)
8082 (base-position completion-base-position)
8083 (insert-function completion-list-insert-choice-function)
8084 (choice
8085 (save-excursion
8086 (goto-char (posn-point (event-start event)))
8087 (let (beg end)
8088 (cond
8089 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
8090 (setq end (point) beg (1+ (point))))
8091 ((and (not (bobp))
8092 (get-text-property (1- (point)) 'mouse-face))
8093 (setq end (1- (point)) beg (point)))
8094 (t (error "No completion here")))
8095 (setq beg (previous-single-property-change beg 'mouse-face))
8096 (setq end (or (next-single-property-change end 'mouse-face)
8097 (point-max)))
8098 (buffer-substring-no-properties beg end)))))
8100 (unless (buffer-live-p buffer)
8101 (error "Destination buffer is dead"))
8102 (quit-window nil (posn-window (event-start event)))
8104 (with-current-buffer buffer
8105 (choose-completion-string
8106 choice buffer
8107 (or base-position
8108 (when base-size
8109 ;; Someone's using old completion code that doesn't know
8110 ;; about base-position yet.
8111 (list (+ base-size (field-beginning))))
8112 ;; If all else fails, just guess.
8113 (list (choose-completion-guess-base-position choice)))
8114 insert-function)))))
8116 ;; Delete the longest partial match for STRING
8117 ;; that can be found before POINT.
8118 (defun choose-completion-guess-base-position (string)
8119 (save-excursion
8120 (let ((opoint (point))
8121 len)
8122 ;; Try moving back by the length of the string.
8123 (goto-char (max (- (point) (length string))
8124 (minibuffer-prompt-end)))
8125 ;; See how far back we were actually able to move. That is the
8126 ;; upper bound on how much we can match and delete.
8127 (setq len (- opoint (point)))
8128 (if completion-ignore-case
8129 (setq string (downcase string)))
8130 (while (and (> len 0)
8131 (let ((tail (buffer-substring (point) opoint)))
8132 (if completion-ignore-case
8133 (setq tail (downcase tail)))
8134 (not (string= tail (substring string 0 len)))))
8135 (setq len (1- len))
8136 (forward-char 1))
8137 (point))))
8139 (defun choose-completion-delete-max-match (string)
8140 (declare (obsolete choose-completion-guess-base-position "23.2"))
8141 (delete-region (choose-completion-guess-base-position string) (point)))
8143 (defvar choose-completion-string-functions nil
8144 "Functions that may override the normal insertion of a completion choice.
8145 These functions are called in order with three arguments:
8146 CHOICE - the string to insert in the buffer,
8147 BUFFER - the buffer in which the choice should be inserted,
8148 BASE-POSITION - where to insert the completion.
8150 If a function in the list returns non-nil, that function is supposed
8151 to have inserted the CHOICE in the BUFFER, and possibly exited
8152 the minibuffer; no further functions will be called.
8154 If all functions in the list return nil, that means to use
8155 the default method of inserting the completion in BUFFER.")
8157 (defun choose-completion-string (choice &optional
8158 buffer base-position insert-function)
8159 "Switch to BUFFER and insert the completion choice CHOICE.
8160 BASE-POSITION says where to insert the completion.
8161 INSERT-FUNCTION says how to insert the completion and falls
8162 back on `completion-list-insert-choice-function' when nil."
8164 ;; If BUFFER is the minibuffer, exit the minibuffer
8165 ;; unless it is reading a file name and CHOICE is a directory,
8166 ;; or completion-no-auto-exit is non-nil.
8168 ;; Some older code may call us passing `base-size' instead of
8169 ;; `base-position'. It's difficult to make any use of `base-size',
8170 ;; so we just ignore it.
8171 (unless (consp base-position)
8172 (message "Obsolete `base-size' passed to choose-completion-string")
8173 (setq base-position nil))
8175 (let* ((buffer (or buffer completion-reference-buffer))
8176 (mini-p (minibufferp buffer)))
8177 ;; If BUFFER is a minibuffer, barf unless it's the currently
8178 ;; active minibuffer.
8179 (if (and mini-p
8180 (not (and (active-minibuffer-window)
8181 (equal buffer
8182 (window-buffer (active-minibuffer-window))))))
8183 (error "Minibuffer is not active for completion")
8184 ;; Set buffer so buffer-local choose-completion-string-functions works.
8185 (set-buffer buffer)
8186 (unless (run-hook-with-args-until-success
8187 'choose-completion-string-functions
8188 ;; The fourth arg used to be `mini-p' but was useless
8189 ;; (since minibufferp can be used on the `buffer' arg)
8190 ;; and indeed unused. The last used to be `base-size', so we
8191 ;; keep it to try and avoid breaking old code.
8192 choice buffer base-position nil)
8193 ;; This remove-text-properties should be unnecessary since `choice'
8194 ;; comes from buffer-substring-no-properties.
8195 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8196 ;; Insert the completion into the buffer where it was requested.
8197 (funcall (or insert-function completion-list-insert-choice-function)
8198 (or (car base-position) (point))
8199 (or (cadr base-position) (point))
8200 choice)
8201 ;; Update point in the window that BUFFER is showing in.
8202 (let ((window (get-buffer-window buffer t)))
8203 (set-window-point window (point)))
8204 ;; If completing for the minibuffer, exit it with this choice.
8205 (and (not completion-no-auto-exit)
8206 (minibufferp buffer)
8207 minibuffer-completion-table
8208 ;; If this is reading a file name, and the file name chosen
8209 ;; is a directory, don't exit the minibuffer.
8210 (let* ((result (buffer-substring (field-beginning) (point)))
8211 (bounds
8212 (completion-boundaries result minibuffer-completion-table
8213 minibuffer-completion-predicate
8214 "")))
8215 (if (eq (car bounds) (length result))
8216 ;; The completion chosen leads to a new set of completions
8217 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8218 (let ((mini (active-minibuffer-window)))
8219 (select-window mini)
8220 (when minibuffer-auto-raise
8221 (raise-frame (window-frame mini))))
8222 (exit-minibuffer))))))))
8224 (define-derived-mode completion-list-mode nil "Completion List"
8225 "Major mode for buffers showing lists of possible completions.
8227 to select the completion near point.
8228 Or click to select one with the mouse.
8231 (set (make-local-variable 'completion-base-size) nil))
8233 (defun completion-list-mode-finish ()
8234 "Finish setup of the completions buffer.
8235 Called from `temp-buffer-show-hook'."
8236 (when (eq major-mode 'completion-list-mode)
8237 (setq buffer-read-only t)))
8239 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8242 ;; Variables and faces used in `completion-setup-function'.
8244 (defcustom completion-show-help t
8245 "Non-nil means show help message in *Completions* buffer."
8246 :type 'boolean
8247 :version "22.1"
8248 :group 'completion)
8250 ;; This function goes in completion-setup-hook, so that it is called
8251 ;; after the text of the completion list buffer is written.
8252 (defun completion-setup-function ()
8253 (let* ((mainbuf (current-buffer))
8254 (base-dir
8255 ;; FIXME: This is a bad hack. We try to set the default-directory
8256 ;; in the *Completions* buffer so that the relative file names
8257 ;; displayed there can be treated as valid file names, independently
8258 ;; from the completion context. But this suffers from many problems:
8259 ;; - It's not clear when the completions are file names. With some
8260 ;; completion tables (e.g. bzr revision specs), the listed
8261 ;; completions can mix file names and other things.
8262 ;; - It doesn't pay attention to possible quoting.
8263 ;; - With fancy completion styles, the code below will not always
8264 ;; find the right base directory.
8265 (if minibuffer-completing-file-name
8266 (file-name-as-directory
8267 (expand-file-name
8268 (buffer-substring (minibuffer-prompt-end)
8269 (- (point) (or completion-base-size 0))))))))
8270 (with-current-buffer standard-output
8271 (let ((base-size completion-base-size) ;Read before killing localvars.
8272 (base-position completion-base-position)
8273 (insert-fun completion-list-insert-choice-function))
8274 (completion-list-mode)
8275 (set (make-local-variable 'completion-base-size) base-size)
8276 (set (make-local-variable 'completion-base-position) base-position)
8277 (set (make-local-variable 'completion-list-insert-choice-function)
8278 insert-fun))
8279 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8280 (if base-dir (setq default-directory base-dir))
8281 ;; Maybe insert help string.
8282 (when completion-show-help
8283 (goto-char (point-min))
8284 (if (display-mouse-p)
8286 (insert (substitute-command-keys
8290 (add-hook 'completion-setup-hook 'completion-setup-function)
8292 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8293 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8295 (defun switch-to-completions ()
8296 "Select the completion list window."
8297 (interactive)
8298 (let ((window (or (get-buffer-window "*Completions*" 0)
8299 ;; Make sure we have a completions window.
8300 (progn (minibuffer-completion-help)
8301 (get-buffer-window "*Completions*" 0)))))
8302 (when window
8303 (select-window window)
8304 ;; In the new buffer, go to the first completion.
8305 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8306 (when (bobp)
8307 (next-completion 1)))))
8308 \f
8309 ;;; Support keyboard commands to turn on various modifiers.
8311 ;; These functions -- which are not commands -- each add one modifier
8312 ;; to the following event.
8314 (defun event-apply-alt-modifier (_ignore-prompt)
8317 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8318 (defun event-apply-super-modifier (_ignore-prompt)
8321 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8322 (defun event-apply-hyper-modifier (_ignore-prompt)
8325 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8326 (defun event-apply-shift-modifier (_ignore-prompt)
8329 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8330 (defun event-apply-control-modifier (_ignore-prompt)
8333 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8334 (defun event-apply-meta-modifier (_ignore-prompt)
8337 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8339 (defun event-apply-modifier (event symbol lshiftby prefix)
8340 "Apply a modifier flag to event EVENT.
8341 SYMBOL is the name of this modifier, as a symbol.
8342 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8343 PREFIX is the string that represents this modifier in an event type symbol."
8344 (if (numberp event)
8345 (cond ((eq symbol 'control)
8346 (if (and (<= (downcase event) ?z)
8347 (>= (downcase event) ?a))
8348 (- (downcase event) ?a -1)
8349 (if (and (<= (downcase event) ?Z)
8350 (>= (downcase event) ?A))
8351 (- (downcase event) ?A -1)
8352 (logior (lsh 1 lshiftby) event))))
8353 ((eq symbol 'shift)
8354 (if (and (<= (downcase event) ?z)
8355 (>= (downcase event) ?a))
8356 (upcase event)
8357 (logior (lsh 1 lshiftby) event)))
8358 (t
8359 (logior (lsh 1 lshiftby) event)))
8360 (if (memq symbol (event-modifiers event))
8361 event
8362 (let ((event-type (if (symbolp event) event (car event))))
8363 (setq event-type (intern (concat prefix (symbol-name event-type))))
8364 (if (symbolp event)
8365 event-type
8366 (cons event-type (cdr event)))))))
8368 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8369 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8370 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8371 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8372 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8373 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8374 \f
8375 ;;;; Keypad support.
8377 ;; Make the keypad keys act like ordinary typing keys. If people add
8378 ;; bindings for the function key symbols, then those bindings will
8379 ;; override these, so this shouldn't interfere with any existing
8380 ;; bindings.
8382 ;; Also tell read-char how to handle these keys.
8383 (mapc
8384 (lambda (keypad-normal)
8385 (let ((keypad (nth 0 keypad-normal))
8386 (normal (nth 1 keypad-normal)))
8387 (put keypad 'ascii-character normal)
8388 (define-key function-key-map (vector keypad) (vector normal))))
8389 ;; See also kp-keys bound in bindings.el.
8390 '((kp-space ?\s)
8393 (kp-separator ?,)
8394 (kp-equal ?=)
8395 ;; Do the same for various keys that are represented as symbols under
8396 ;; GUIs but naturally correspond to characters.
8397 (backspace 127)
8398 (delete 127)
8401 (clear ?\C-l)
8402 (return ?\C-m)
8403 (escape ?\e)
8404 ))
8405 \f
8406 ;;;;
8407 ;;;; forking a twin copy of a buffer.
8408 ;;;;
8410 (defvar clone-buffer-hook nil
8411 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8413 (defvar clone-indirect-buffer-hook nil
8414 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8416 (defun clone-process (process &optional newname)
8417 "Create a twin copy of PROCESS.
8418 If NEWNAME is nil, it defaults to PROCESS' name;
8419 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8420 If PROCESS is associated with a buffer, the new process will be associated
8421 with the current buffer instead.
8422 Returns nil if PROCESS has already terminated."
8423 (setq newname (or newname (process-name process)))
8425 (setq newname (substring newname 0 (match-beginning 0))))
8426 (when (memq (process-status process) '(run stop open))
8427 (let* ((process-connection-type (process-tty-name process))
8428 (new-process
8429 (if (memq (process-status process) '(open))
8430 (let ((args (process-contact process t)))
8431 (setq args (plist-put args :name newname))
8432 (setq args (plist-put args :buffer
8433 (if (process-buffer process)
8434 (current-buffer))))
8435 (apply 'make-network-process args))
8436 (apply 'start-process newname
8437 (if (process-buffer process) (current-buffer))
8438 (process-command process)))))
8439 (set-process-query-on-exit-flag
8440 new-process (process-query-on-exit-flag process))
8441 (set-process-inherit-coding-system-flag
8442 new-process (process-inherit-coding-system-flag process))
8443 (set-process-filter new-process (process-filter process))
8444 (set-process-sentinel new-process (process-sentinel process))
8445 (set-process-plist new-process (copy-sequence (process-plist process)))
8446 new-process)))
8448 ;; things to maybe add (currently partly covered by `funcall mode'):
8449 ;; - syntax-table
8450 ;; - overlays
8451 (defun clone-buffer (&optional newname display-flag)
8452 "Create and return a twin copy of the current buffer.
8453 Unlike an indirect buffer, the new buffer can be edited
8454 independently of the old one (if it is not read-only).
8455 NEWNAME is the name of the new buffer. It may be modified by
8456 adding or incrementing <N> at the end as necessary to create a
8457 unique buffer name. If nil, it defaults to the name of the
8458 current buffer, with the proper suffix. If DISPLAY-FLAG is
8459 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8460 clone a file-visiting buffer, or a buffer whose major mode symbol
8461 has a non-nil `no-clone' property, results in an error.
8463 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8464 current buffer with appropriate suffix. However, if a prefix
8465 argument is given, then the command prompts for NEWNAME in the
8466 minibuffer.
8468 This runs the normal hook `clone-buffer-hook' in the new buffer
8469 after it has been set up properly in other respects."
8470 (interactive
8471 (progn
8472 (if buffer-file-name
8473 (error "Cannot clone a file-visiting buffer"))
8474 (if (get major-mode 'no-clone)
8475 (error "Cannot clone a buffer in %s mode" mode-name))
8476 (list (if current-prefix-arg
8477 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8478 t)))
8479 (if buffer-file-name
8480 (error "Cannot clone a file-visiting buffer"))
8481 (if (get major-mode 'no-clone)
8482 (error "Cannot clone a buffer in %s mode" mode-name))
8483 (setq newname (or newname (buffer-name)))
8485 (setq newname (substring newname 0 (match-beginning 0))))
8486 (let ((buf (current-buffer))
8487 (ptmin (point-min))
8488 (ptmax (point-max))
8489 (pt (point))
8490 (mk (if mark-active (mark t)))
8491 (modified (buffer-modified-p))
8492 (mode major-mode)
8493 (lvars (buffer-local-variables))
8494 (process (get-buffer-process (current-buffer)))
8495 (new (generate-new-buffer (or newname (buffer-name)))))
8496 (save-restriction
8497 (widen)
8498 (with-current-buffer new
8499 (insert-buffer-substring buf)))
8500 (with-current-buffer new
8501 (narrow-to-region ptmin ptmax)
8502 (goto-char pt)
8503 (if mk (set-mark mk))
8504 (set-buffer-modified-p modified)
8506 ;; Clone the old buffer's process, if any.
8507 (when process (clone-process process))
8509 ;; Now set up the major mode.
8510 (funcall mode)
8512 ;; Set up other local variables.
8513 (mapc (lambda (v)
8514 (condition-case () ;in case var is read-only
8515 (if (symbolp v)
8516 (makunbound v)
8517 (set (make-local-variable (car v)) (cdr v)))
8518 (error nil)))
8519 lvars)
8521 ;; Run any hooks (typically set up by the major mode
8522 ;; for cloning to work properly).
8523 (run-hooks 'clone-buffer-hook))
8524 (if display-flag
8525 ;; Presumably the current buffer is shown in the selected frame, so
8526 ;; we want to display the clone elsewhere.
8527 (let ((same-window-regexps nil)
8528 (same-window-buffer-names))
8529 (pop-to-buffer new)))
8530 new))
8533 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8534 "Create an indirect buffer that is a twin copy of the current buffer.
8536 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8537 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8538 or if not called with a prefix arg, NEWNAME defaults to the current
8539 buffer's name. The name is modified by adding a `<N>' suffix to it
8540 or by incrementing the N in an existing suffix. Trying to clone a
8541 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8542 property results in an error.
8544 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8545 This is always done when called interactively.
8547 Optional third arg NORECORD non-nil means do not put this buffer at the
8548 front of the list of recently selected ones.
8550 Returns the newly created indirect buffer."
8551 (interactive
8552 (progn
8553 (if (get major-mode 'no-clone-indirect)
8554 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8555 (list (if current-prefix-arg
8556 (read-buffer "Name of indirect buffer: " (current-buffer)))
8557 t)))
8558 (if (get major-mode 'no-clone-indirect)
8559 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8560 (setq newname (or newname (buffer-name)))
8562 (setq newname (substring newname 0 (match-beginning 0))))
8563 (let* ((name (generate-new-buffer-name newname))
8564 (buffer (make-indirect-buffer (current-buffer) name t)))
8565 (with-current-buffer buffer
8566 (run-hooks 'clone-indirect-buffer-hook))
8567 (when display-flag
8568 (pop-to-buffer buffer nil norecord))
8569 buffer))
8572 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8573 "Like `clone-indirect-buffer' but display in another window."
8574 (interactive
8575 (progn
8576 (if (get major-mode 'no-clone-indirect)
8577 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8578 (list (if current-prefix-arg
8579 (read-buffer "Name of indirect buffer: " (current-buffer)))
8580 t)))
8581 (let ((pop-up-windows t))
8582 (clone-indirect-buffer newname display-flag norecord)))
8584 \f
8585 ;;; Handling of Backspace and Delete keys.
8587 (defcustom normal-erase-is-backspace 'maybe
8588 "Set the default behavior of the Delete and Backspace keys.
8590 If set to t, Delete key deletes forward and Backspace key deletes
8591 backward.
8593 If set to nil, both Delete and Backspace keys delete backward.
8595 If set to `maybe' (which is the default), Emacs automatically
8596 selects a behavior. On window systems, the behavior depends on
8597 the keyboard used. If the keyboard has both a Backspace key and
8598 a Delete key, and both are mapped to their usual meanings, the
8599 option's default value is set to t, so that Backspace can be used
8600 to delete backward, and Delete can be used to delete forward.
8602 If not running under a window system, customizing this option
8603 accomplishes a similar effect by mapping C-h, which is usually
8604 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8605 via `keyboard-translate'. The former functionality of C-h is
8606 available on the F1 key. You should probably not use this
8607 setting if you don't have both Backspace, Delete and F1 keys.
8609 Setting this variable with setq doesn't take effect. Programmatically,
8610 call `normal-erase-is-backspace-mode' (which see) instead."
8611 :type '(choice (const :tag "Off" nil)
8612 (const :tag "Maybe" maybe)
8613 (other :tag "On" t))
8614 :group 'editing-basics
8615 :version "21.1"
8616 :set (lambda (symbol value)
8617 ;; The fboundp is because of a problem with :set when
8618 ;; dumping Emacs. It doesn't really matter.
8619 (if (fboundp 'normal-erase-is-backspace-mode)
8620 (normal-erase-is-backspace-mode (or value 0))
8621 (set-default symbol value))))
8623 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8624 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8625 (unless frame (setq frame (selected-frame)))
8626 (with-selected-frame frame
8627 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8628 (normal-erase-is-backspace-mode
8629 (if (if (eq normal-erase-is-backspace 'maybe)
8630 (and (not noninteractive)
8631 (or (memq system-type '(ms-dos windows-nt))
8632 (memq window-system '(w32 ns))
8633 (and (memq window-system '(x))
8634 (fboundp 'x-backspace-delete-keys-p)
8635 (x-backspace-delete-keys-p))
8636 ;; If the terminal Emacs is running on has erase char
8637 ;; set to ^H, use the Backspace key for deleting
8638 ;; backward, and the Delete key for deleting forward.
8639 (and (null window-system)
8640 (eq tty-erase-char ?\^H))))
8641 normal-erase-is-backspace)
8642 1 0)))))
8644 (define-minor-mode normal-erase-is-backspace-mode
8645 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8646 With a prefix argument ARG, enable this feature if ARG is
8647 positive, and disable it otherwise. If called from Lisp, enable
8648 the mode if ARG is omitted or nil.
8650 On window systems, when this mode is on, Delete is mapped to C-d
8651 and Backspace is mapped to DEL; when this mode is off, both
8652 Delete and Backspace are mapped to DEL. (The remapping goes via
8653 `local-function-key-map', so binding Delete or Backspace in the
8654 global or local keymap will override that.)
8656 In addition, on window systems, the bindings of C-Delete, M-Delete,
8657 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8658 the global keymap in accordance with the functionality of Delete and
8659 Backspace. For example, if Delete is remapped to C-d, which deletes
8660 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8661 to DEL, which deletes backward, C-Delete is bound to
8662 `backward-kill-word'.
8664 If not running on a window system, a similar effect is accomplished by
8665 remapping C-h (normally produced by the Backspace key) and DEL via
8666 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8667 to C-d; if it's off, the keys are not remapped.
8669 When not running on a window system, and this mode is turned on, the
8670 former functionality of C-h is available on the F1 key. You should
8671 probably not turn on this mode on a text-only terminal if you don't
8672 have both Backspace, Delete and F1 keys.
8674 See also `normal-erase-is-backspace'."
8675 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8676 . (lambda (v)
8677 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8678 (if v 1 0))))
8679 (let ((enabled (eq 1 (terminal-parameter
8680 nil 'normal-erase-is-backspace))))
8682 (cond ((or (memq window-system '(x w32 ns pc))
8683 (memq system-type '(ms-dos windows-nt)))
8684 (let ((bindings
8685 `(([M-delete] [M-backspace])
8686 ([C-M-delete] [C-M-backspace])
8687 ([?\e C-delete] [?\e C-backspace]))))
8689 (if enabled
8690 (progn
8691 (define-key local-function-key-map [delete] [deletechar])
8692 (define-key local-function-key-map [kp-delete] [deletechar])
8693 (define-key local-function-key-map [backspace] [?\C-?])
8694 (dolist (b bindings)
8695 ;; Not sure if input-decode-map is really right, but
8696 ;; keyboard-translate-table (used below) only works
8697 ;; for integer events, and key-translation-table is
8698 ;; global (like the global-map, used earlier).
8699 (define-key input-decode-map (car b) nil)
8700 (define-key input-decode-map (cadr b) nil)))
8701 (define-key local-function-key-map [delete] [?\C-?])
8702 (define-key local-function-key-map [kp-delete] [?\C-?])
8703 (define-key local-function-key-map [backspace] [?\C-?])
8704 (dolist (b bindings)
8705 (define-key input-decode-map (car b) (cadr b))
8706 (define-key input-decode-map (cadr b) (car b))))))
8707 (t
8708 (if enabled
8709 (progn
8710 (keyboard-translate ?\C-h ?\C-?)
8711 (keyboard-translate ?\C-? ?\C-d))
8712 (keyboard-translate ?\C-h ?\C-h)
8713 (keyboard-translate ?\C-? ?\C-?))))
8715 (if (called-interactively-p 'interactive)
8716 (message "Delete key deletes %s"
8717 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8718 "forward" "backward")))))
8719 \f
8720 (defvar vis-mode-saved-buffer-invisibility-spec nil
8721 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8723 (define-minor-mode read-only-mode
8724 "Change whether the current buffer is read-only.
8725 With prefix argument ARG, make the buffer read-only if ARG is
8726 positive, otherwise make it writable. If buffer is read-only
8727 and `view-read-only' is non-nil, enter view mode.
8729 Do not call this from a Lisp program unless you really intend to
8731 possibly enabling or disabling View mode. Also, note that this
8732 command works by setting the variable `buffer-read-only', which
8733 does not affect read-only regions caused by text properties. To
8734 ignore read-only status in a Lisp program (whether due to text
8735 properties or buffer state), bind `inhibit-read-only' temporarily
8736 to a non-nil value."
8737 :variable buffer-read-only
8738 (cond
8739 ((and (not buffer-read-only) view-mode)
8740 (View-exit-and-edit)
8741 (make-local-variable 'view-read-only)
8742 (setq view-read-only t)) ; Must leave view mode.
8743 ((and buffer-read-only view-read-only
8744 ;; If view-mode is already active, `view-mode-enter' is a nop.
8745 (not view-mode)
8746 (not (eq (get major-mode 'mode-class) 'special)))
8747 (view-mode-enter))))
8749 (define-minor-mode visible-mode
8750 "Toggle making all invisible text temporarily visible (Visible mode).
8751 With a prefix argument ARG, enable Visible mode if ARG is
8752 positive, and disable it otherwise. If called from Lisp, enable
8753 the mode if ARG is omitted or nil.
8755 This mode works by saving the value of `buffer-invisibility-spec'
8756 and setting it to nil."
8757 :lighter " Vis"
8758 :group 'editing-basics
8759 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8760 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8761 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8762 (when visible-mode
8763 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8764 buffer-invisibility-spec)
8765 (setq buffer-invisibility-spec nil)))
8766 \f
8767 (defvar messages-buffer-mode-map
8768 (let ((map (make-sparse-keymap)))
8769 (set-keymap-parent map special-mode-map)
8770 (define-key map "g" nil) ; nothing to revert
8771 map))
8773 (define-derived-mode messages-buffer-mode special-mode "Messages"
8776 (defun messages-buffer ()
8778 If it does not exist, create and it switch it to `messages-buffer-mode'."
8779 (or (get-buffer "*Messages*")
8780 (with-current-buffer (get-buffer-create "*Messages*")
8781 (messages-buffer-mode)
8782 (current-buffer))))
8784 \f
8785 ;; Minibuffer prompt stuff.
8787 ;;(defun minibuffer-prompt-modification (start end)
8788 ;; (error "You cannot modify the prompt"))
8789 ;;
8790 ;;
8791 ;;(defun minibuffer-prompt-insertion (start end)
8792 ;; (let ((inhibit-modification-hooks t))
8793 ;; (delete-region start end)
8794 ;; ;; Discard undo information for the text insertion itself
8795 ;; ;; and for the text deletion.above.
8796 ;; (when (consp buffer-undo-list)
8797 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8798 ;; (message "You cannot modify the prompt")))
8799 ;;
8800 ;;
8801 ;;(setq minibuffer-prompt-properties
8802 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8803 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8805 \f
8806 ;;;; Problematic external packages.
8808 ;; rms says this should be done by specifying symbols that define
8809 ;; versions together with bad values. This is therefore not as
8810 ;; flexible as it could be. See the thread:
8811 ;; https://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8812 (defconst bad-packages-alist
8813 ;; Not sure exactly which semantic versions have problems.
8814 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8816 "The version of `semantic' loaded does not work in Emacs 22.
8817 It can cause constant high CPU load.
8818 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8819 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8820 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8821 ;; provided the `CUA-mode' feature. Since this is no longer true,
8822 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8823 (CUA-mode t nil
8824 "CUA-mode is now part of the standard GNU Emacs distribution,
8825 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8827 You have loaded an older version of CUA-mode which does not work
8828 correctly with this version of Emacs. You should remove the old
8829 version and use the one distributed with Emacs."))
8830 "Alist of packages known to cause problems in this version of Emacs.
8831 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8832 PACKAGE is either a regular expression to match file names, or a
8833 symbol (a feature name), like for `with-eval-after-load'.
8834 SYMBOL is either the name of a string variable, or t. Upon
8835 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8836 warning using STRING as the message.")
8838 (defun bad-package-check (package)
8839 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8840 (condition-case nil
8841 (let* ((list (assoc package bad-packages-alist))
8842 (symbol (nth 1 list)))
8843 (and list
8844 (boundp symbol)
8845 (or (eq symbol t)
8846 (and (stringp (setq symbol (eval symbol)))
8847 (string-match-p (nth 2 list) symbol)))
8848 (display-warning package (nth 3 list) :warning)))
8849 (error nil)))
8851 (dolist (elem bad-packages-alist)
8852 (let ((pkg (car elem)))
8853 (with-eval-after-load pkg
8854 (bad-package-check pkg))))
8856 \f
8857 ;;; Generic dispatcher commands
8859 ;; Macro `define-alternatives' is used to create generic commands.
8860 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8861 ;; that can have different alternative implementations where choosing
8862 ;; among them is exclusively a matter of user preference.
8864 ;; (define-alternatives COMMAND) creates a new interactive command
8865 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8866 ;; Typically, the user will not need to customize this variable; packages
8867 ;; wanting to add alternative implementations should use
8868 ;;
8869 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8871 (defmacro define-alternatives (command &rest customizations)
8872 "Define the new command `COMMAND'.
8874 The argument `COMMAND' should be a symbol.
8876 Running `M-x COMMAND RET' for the first time prompts for which
8877 alternative to use and records the selected command as a custom
8878 variable.
8880 Running `C-u M-x COMMAND RET' prompts again for an alternative
8881 and overwrites the previous choice.
8883 The variable `COMMAND-alternatives' contains an alist with
8884 alternative implementations of COMMAND. `define-alternatives'
8885 does not have any effect until this variable is set.
8887 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8888 `defcustom' keywords and values to add to the declaration of
8889 `COMMAND-alternatives' (typically :group and :version)."
8890 (let* ((command-name (symbol-name command))
8891 (varalt-name (concat command-name "-alternatives"))
8892 (varalt-sym (intern varalt-name))
8893 (varimp-sym (intern (concat command-name "--implementation"))))
8894 `(progn
8896 (defcustom ,varalt-sym nil
8897 ,(format "Alist of alternative implementations for the `%s' command.
8899 Each entry must be a pair (ALTNAME . ALTFUN), where:
8900 ALTNAME - The name shown at user to describe the alternative implementation.
8901 ALTFUN - The function called to implement this alternative."
8902 command-name)
8903 :type '(alist :key-type string :value-type function)
8904 ,@customizations)
8906 (put ',varalt-sym 'definition-name ',command)
8907 (defvar ,varimp-sym nil "Internal use only.")
8909 (defun ,command (&optional arg)
8910 ,(format "Run generic command `%s'.
8911 If used for the first time, or with interactive ARG, ask the user which
8912 implementation to use for `%s'. The variable `%s'
8913 contains the list of implementations currently supported for this command."
8914 command-name command-name varalt-name)
8915 (interactive "P")
8916 (when (or arg (null ,varimp-sym))
8917 (let ((val (completing-read
8918 ,(format-message
8919 "Select implementation for command `%s': "
8920 command-name)
8921 ,varalt-sym nil t)))
8922 (unless (string-equal val "")
8923 (when (null ,varimp-sym)
8924 (message
8925 "Use C-u M-x %s RET`to select another implementation"
8926 ,command-name)
8927 (sit-for 3))
8928 (customize-save-variable ',varimp-sym
8929 (cdr (assoc-string val ,varalt-sym))))))
8930 (if ,varimp-sym
8931 (call-interactively ,varimp-sym)
8932 (message "%s" ,(format-message
8933 "No implementation selected for command `%s'"
8934 command-name)))))))
8936 \f
8937 ;;; Functions for changing capitalization that Do What I Mean
8938 (defun upcase-dwim (arg)
8939 "Upcase words in the region, if active; if not, upcase word at point.
8940 If the region is active, this function calls `upcase-region'.
8941 Otherwise, it calls `upcase-word', with prefix argument passed to it
8942 to upcase ARG words."
8943 (interactive "*p")
8944 (if (use-region-p)
8945 (upcase-region (region-beginning) (region-end))
8946 (upcase-word arg)))
8948 (defun downcase-dwim (arg)
8949 "Downcase words in the region, if active; if not, downcase word at point.
8950 If the region is active, this function calls `downcase-region'.
8951 Otherwise, it calls `downcase-word', with prefix argument passed to it
8952 to downcase ARG words."
8953 (interactive "*p")
8954 (if (use-region-p)
8955 (downcase-region (region-beginning) (region-end))
8956 (downcase-word arg)))
8958 (defun capitalize-dwim (arg)
8959 "Capitalize words in the region, if active; if not, capitalize word at point.
8960 If the region is active, this function calls `capitalize-region'.
8961 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8962 to capitalize ARG words."
8963 (interactive "*p")
8964 (if (use-region-p)
8965 (capitalize-region (region-beginning) (region-end))
8966 (capitalize-word arg)))
8968 \f
8970 (provide 'simple)
8972 ;;; simple.el ends here