| blob | 0ee2f060e5e6b9919d3c1d543ef9b5b59eedcfe8 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2016 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "If non-nil, output buffer is not erased between shell commands.
42 Also, a non-nil value set the point in the output buffer
43 once the command complete.
44 The value `beg-last-out' set point at the beginning of the output,
45 `end-last-out' set point at the end of the buffer, `save-point'
46 restore the buffer position before the command."
56 "Point position in the output buffer after command complete.
57 It is an alist (BUFFER . POS), where BUFFER is the output
58 buffer, and POS is the point position in BUFFER once the command finish.
62 "Idle time delay before updating various things on the screen.
63 Various Emacs features that update auxiliary information when point moves
64 wait this many seconds after Emacs becomes idle before doing an update."
70 "Killing and yanking commands."
74 "Highlight (un)matching of parens and expressions."
76 \f
77 ;;; next-error support framework
80 "`next-error' support framework."
86 "Face used to highlight next error locus."
91 "Highlighting of locations in selected source buffers.
92 If a number, highlight the locus in `next-error' face for the given time
93 in seconds, or until the next command is executed.
94 If t, highlight the locus until the next command is executed, or until
95 some other locus replaces it.
96 If nil, don't highlight the locus in the source buffer.
97 If `fringe-arrow', indicate the locus by the fringe arrow
98 indefinitely until some other locus replaces it."
107 "Highlighting of locations in `next-error-no-select'.
108 If number, highlight the locus in `next-error' face for given time in seconds.
109 If t, highlight the locus indefinitely until some other locus replaces it.
110 If nil, don't highlight the locus in the source buffer.
111 If `fringe-arrow', indicate the locus by the fringe arrow
112 indefinitely until some other locus replaces it."
121 "Display the line in the visited source file recentered as specified.
122 If non-nil, the value is passed directly to `recenter'."
130 "List of hook functions run by `next-error' after visiting source file."
141 "The most recent `next-error' buffer.
142 A buffer becomes most recent when its compilation, grep, or
147 "Function to use to find the next error in the current buffer.
148 The function is called with 2 parameters:
149 ARG is an integer specifying by how many errors to move.
150 RESET is a boolean which, if non-nil, says to go back to the beginning
151 of the errors before moving.
152 Major modes providing compile-like functionality should set this variable
153 to indicate to `next-error' that this is a candidate buffer and how
158 "Function to use to move to an error locus.
159 It takes two arguments, a buffer position in the error buffer
160 and a buffer position in the error locus buffer.
161 The buffer for the error locus should already be current.
166 &optional avoid-current
167 extra-test-inclusive
168 extra-test-exclusive)
169 "Return non-nil if BUFFER is a `next-error' capable buffer.
170 If AVOID-CURRENT is non-nil, and BUFFER is the current buffer,
171 return nil.
173 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if
174 BUFFER would not normally qualify. If it returns non-nil, BUFFER
175 is considered `next-error' capable, anyway, and the function
176 returns non-nil.
178 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the
179 buffer would normally qualify. If it returns nil, BUFFER is
180 rejected, and the function returns nil."
185 ;; Optionally reject some buffers.
188 t)
189 ;; Optionally accept some other buffers.
194 extra-test-inclusive
195 extra-test-exclusive)
196 "Return a `next-error' capable buffer.
198 If AVOID-CURRENT is non-nil, treat the current buffer
199 as an absolute last resort only.
201 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
202 that normally would not qualify. If it returns t, the buffer
203 in question is treated as usable.
205 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
206 that would normally be considered usable. If it returns nil,
207 that buffer is rejected."
209 ;; 1. If one window on the selected frame displays such buffer, return it.
215 avoid-current
216 extra-test-inclusive extra-test-exclusive)
221 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
224 extra-test-inclusive extra-test-exclusive))
225 next-error-last-buffer)
226 ;; 3. If the current buffer is acceptable, choose it.
228 extra-test-inclusive extra-test-exclusive)
230 ;; 4. Look for any acceptable buffer.
235 extra-test-inclusive extra-test-exclusive)))
238 ;; 5. Use the current buffer as a last resort if it qualifies,
239 ;; even despite AVOID-CURRENT.
242 extra-test-inclusive extra-test-exclusive)
246 ;; 6. Give up.
250 "Visit next `next-error' message and corresponding source code.
252 If all the error messages parsed so far have been processed already,
253 the message buffer is checked for new ones.
255 A prefix ARG specifies how many error messages to move;
256 negative means move back to previous error messages.
258 and start at the first error.
260 The RESET argument specifies that we should restart from the beginning.
263 compilation, grep, or occur buffer. It can also operate on any
265 more generally, on any buffer in Compilation mode or with
266 Compilation Minor mode enabled, or any buffer in which
267 `next-error-function' is bound to an appropriate function.
268 To specify use of a particular buffer for error messages, type
270 in the current frame.
273 runs `next-error-hook' with `run-hooks', and stays with that buffer
274 until you use it in some other buffer which uses Compilation mode
275 or Compilation Minor mode.
277 To control which errors are matched, customize the variable
278 `compilation-error-regexp-alist'."
282 ;; we know here that next-error-function is a valid symbol we can funcall
290 "Visit the source code corresponding to the `next-error' message at point."
292 ;; we know here that next-error-function is a valid symbol we can funcall
303 "Visit previous `next-error' message and corresponding source code.
305 Prefix arg N says how many error messages to move backwards (or
306 forwards, if negative).
313 "Restart at the first error.
314 Visit corresponding source code.
315 With prefix arg N, visit the source code of the Nth error.
321 "Move point to the next error in the `next-error' buffer and highlight match.
322 Prefix arg N says how many error messages to move forwards (or
323 backwards, if negative).
325 select the source buffer."
332 "Move point to the previous error in the `next-error' buffer and highlight match.
333 Prefix arg N says how many error messages to move backwards (or
334 forwards, if negative).
336 select the source buffer."
340 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
344 "Minor mode for compilation, occur and diff modes.
345 With a prefix argument ARG, enable mode if ARG is positive, and
346 disable it otherwise. If called from Lisp, enable mode if ARG is
347 omitted or nil.
348 When turned on, cursor motion in the compilation, grep, occur or diff
349 buffer causes automatic display of the corresponding source code location."
356 ;; Used as a `post-command-hook' by `next-error-follow-mode'
357 ;; for the *Compilation* *grep* and *Occur* buffers.
367 \f
368 ;;;
371 "Major mode not specialized for anything in particular.
372 Other major modes are defined by comparison with this one."
377 ;; Special major modes to view specially formatted data rather than files.
391 map))
395 "Parent major mode from which special major modes should inherit."
398 ;; Making and deleting lines.
401 "Special hook to tell if `self-insert-command' will use the region.
402 It must be called via `run-hook-with-args-until-success' with no arguments.
403 Any `post-self-insert-command' which consumes the region should
404 register a function on this hook so that things like `delete-selection-mode'
411 "Insert a newline, and move to left margin of the new line if it's blank.
412 If option `use-hard-newlines' is non-nil, the newline is marked with the
413 text-property `hard'.
414 With ARG, insert that many newlines.
416 If `electric-indent-mode' is enabled, this indents the final new line
417 that it adds, and reindents the preceding line. To just insert
420 Calls `auto-fill-function' if the current column number is greater
421 than the value of `fill-column' and ARG is nil.
422 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
425 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
426 ;; Set last-command-event to tell self-insert what to insert.
430 ;; Don't auto-fill if we have a numeric argument.
434 ;; Do the rest in post-self-insert-hook, because we want to do it
435 ;; *before* other functions on that hook.
437 ;; We are not going to insert any newlines if arg is
438 ;; non-positive.
441 ;; Mark the newline(s) `hard'.
445 ;; If the newline leaves the previous line blank, and we
446 ;; have a left margin, delete that from the blank line.
454 ;; Indent the line after the newline, except in one case:
455 ;; when we added the newline at the beginning of a line which
456 ;; starts a page.
461 ;; FIXME: For non-interactive uses, many calls actually
462 ;; just want (insert "\n"), so maybe we should do just
463 ;; that, so as to avoid the risk of filling or running
464 ;; abbrevs unexpectedly.
471 ;; We first used let-binding to protect the hook, but that
472 ;; was naive since add-hook affects the symbol-default
473 ;; value of the variable, whereas the let-binding might
474 ;; only protect the buffer-local value.
478 nil)
483 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
489 "Insert a newline and leave point before it.
490 If there is a fill prefix and/or a `left-margin', insert them on
491 the new line if the line would have been blank.
492 With arg N, insert N newlines."
497 ;; Don't expand an abbrev before point.
508 ;; Necessary in case a margin or prefix was inserted.
512 "Split current line, moving portion beyond point vertically down.
513 If the current line starts with `fill-prefix', insert it on the new
514 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
516 When called from Lisp code, ARG may be a prefix string to copy."
521 ;; What prefix should we check for (nil means don't).
525 ;; Does this line start with it?
536 "Join this line to previous and fix up whitespace at join.
537 If there is a fill prefix, delete it from the beginning of this line.
538 With argument, join this line to following line."
545 ;; If the second line started with the fill prefix,
546 ;; delete the prefix.
558 "On blank line, delete all surrounding blank lines, leaving just one.
559 On isolated blank line, delete that one.
560 On nonblank line, delete any immediately following blank lines."
566 ;; Set singleblank if there is just one blank line here.
573 ;; Delete preceding blank lines, and this one too if it's the only one.
582 ;; Delete following blank lines, unless the current line is blank
583 ;; and there are no following blank lines.
592 ;; Handle the special case where point is followed by newline and eob.
593 ;; Delete the line, leaving point at eob.
599 Trailing lines are deleted only if `delete-trailing-whitespace'
600 is called on the entire buffer (rather than an active region)."
606 "Return non-nil if the region contains no read-only text."
611 "Delete trailing whitespace between START and END.
612 If called interactively, START and END are the start/end of the
613 region if the mark is active, or of the buffer's accessible
614 portion if the mark is inactive.
616 This command deletes whitespace characters after the last
617 non-whitespace character in each line between START and END. It
618 does not consider formfeed characters to be whitespace.
620 If this command acts on the entire buffer (i.e. if called
621 interactively with the mark inactive, or called from Lisp with
622 END nil), it also deletes all trailing lines at the end of the
623 buffer if the variable `delete-trailing-lines' is non-nil."
634 ;; Don't delete formfeeds, even if they are considered whitespace.
636 ;; Treating \n as non-whitespace makes things easier.
644 ;; Delete trailing empty lines.
646 ;; Really the end of buffer.
651 ;; Return nil for the benefit of `write-file-functions'.
652 nil)
655 "Insert a newline, then indent according to major mode.
656 Indentation is done using the value of `indent-line-function'.
657 In programming language modes, this is the same as TAB.
658 In some text modes, where TAB inserts a tab, this command indents to the
659 column specified by the function `current-left-margin'."
666 "Reindent current line, insert newline, then indent the new line.
667 Indentation of both lines is done according to the current major mode,
668 which means calling the current value of `indent-line-function'.
669 In programming language modes, this is the same as TAB.
670 In some text modes, where TAB inserts a tab, this indents to the
671 column specified by the function `current-left-margin'."
674 ;; Be careful to insert the newline before indenting the line.
675 ;; Otherwise, the indentation might be wrong.
679 ;; We are at EOL before the call to indent-according-to-mode, and
680 ;; after it we usually are as well, but not always. We tried to
681 ;; address it with `save-excursion' but that uses a normal marker
682 ;; whereas we need `move after insertion', so we do the save/restore
683 ;; by hand.
687 ;; Remove the trailing white-space after indentation because
688 ;; indentation may introduce the whitespace.
694 Legitimate radix values are 8, 10 and 16."
699 "Like `read-char', but do not allow quitting.
700 Also, if the first character read is an octal digit,
701 we read any number of octal digits and return the
702 specified character code. Any nondigit terminates the sequence.
703 If the terminator is RET, it is discarded;
704 any other terminator is used itself as input.
706 The optional argument PROMPT specifies a string to use to prompt the user.
707 The variable `read-quoted-char-radix' controls which radix to use
708 for numeric input."
711 help-event-list)))
715 ;; Don't let C-h or other help chars get the help
716 ;; message--only help function keys. See bug#16617.
720 "Type the special character you want to use,
721 or the octal character code.
722 RET terminates the character code and is discarded;
726 ;; Translate TAB key into control-I ASCII character, and so on.
727 ;; Note: `read-char' does it using the `ascii-character' property.
728 ;; We tried using read-key instead, but that disables the keystroke
729 ;; echo produced by 'C-q', see bug#24635.
733 char)))
739 done t))
741 ;; Turn a meta-character into a character with the 0200 bit set.
743 done t))
758 done t))
760 done t)))
762 code))
765 "Read next input character and insert it.
766 This is useful for inserting control characters.
767 With argument, insert ARG copies of the character.
769 If the first character you type after this command is an octal digit,
770 you should type a sequence of octal digits which specify a character code.
771 Any nondigit terminates the sequence. If the terminator is a RET,
772 it is discarded; any other terminator is used itself as input.
773 The variable `read-quoted-char-radix' specifies the radix for this feature;
774 set it to 10 or 16 to use decimal or hex instead of octal.
776 In overwrite mode, this function inserts the character anyway, and
777 does not handle octal digits specially. This means that if you use
778 overwrite as your normal editing mode, you can use this function to
779 insert characters when necessary.
781 In binary overwrite mode, this function does overwrite, and octal
782 digits are interpreted as a character code. This is intended to be
783 useful for editing binary files."
786 ;; Avoid "obsolete" warnings for translation-table-for-input.
793 ;; This used to assume character codes 0240 - 0377 stand for
794 ;; characters in some single-byte character set, and converted them
795 ;; to Emacs characters. But in 23.1 this feature is deprecated
796 ;; in favor of inserting the corresponding Unicode characters.
797 ;; (if (and enable-multibyte-characters
798 ;; (>= char ?\240)
799 ;; (<= char ?\377))
800 ;; (setq char (unibyte-char-to-multibyte char)))
812 "Move forward ARG lines and position at first nonblank character."
818 "Move backward ARG lines and position at first nonblank character."
824 "Move point to the first non-whitespace character on this line."
828 ;; Move back over chars that have whitespace syntax but have the p flag.
832 "Fixup white space between objects around point.
833 Leave one space or none, according to the context."
840 nil
844 "Delete all spaces and tabs around point.
845 If BACKWARD-ONLY is non-nil, only delete them before point."
850 orig-pos
859 "Delete all spaces and tabs around point, leaving one space (or N spaces).
860 If N is negative, delete newlines as well, leaving -N spaces.
861 See also `cycle-spacing'."
866 "Store context used in consecutive calls to `cycle-spacing' command.
867 The first time `cycle-spacing' runs, it saves in this variable:
868 its N argument, the original point position, and the original spacing
872 "Manipulate whitespace around point in a smart way.
873 In interactive use, this function behaves differently in successive
874 consecutive calls.
876 The first call in a sequence acts like `just-one-space'.
877 It deletes all spaces and tabs around point, leaving one space
878 \(or N spaces). N is the prefix argument. If N is negative,
879 it deletes newlines as well, leaving -N spaces.
880 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
882 The second call in a sequence deletes all spaces.
884 The third call in a sequence restores the original whitespace (and point).
886 If MODE is `single-shot', it only performs the first step in the sequence.
887 If MODE is `fast' and the first step would not result in any change
888 \(i.e., there are exactly (abs N) spaces around point),
889 the function goes straight to the second step.
891 Repeatedly calling the function with different values of N starts a
892 new sequence each time."
900 ;; Command run for the first time, single-shot mode or different argument
912 ;; Special handling for case where there was no space at all.
915 ;; If this run causes no change in buffer content, delete all spaces,
916 ;; otherwise delete all excess spaces.
921 ;; Command run for the second time.
925 ;; Command run for the third time.
930 \f
932 "Move point to the beginning of the buffer.
933 With numeric arg N, put point N/10 of the way from the beginning.
934 If the buffer is narrowed, this command uses the beginning of the
935 accessible part of the buffer.
938 is supplied, or Transient Mark mode is enabled and the mark is active."
948 ;; Avoid overflow for large buffer sizes!
956 "Move point to the end of the buffer.
957 With numeric arg N, put point N/10 of the way from the end.
958 If the buffer is narrowed, this command uses the end of the
959 accessible part of the buffer.
962 is supplied, or Transient Mark mode is enabled and the mark is active."
970 ;; Avoid overflow for large buffer sizes!
975 ;; If we went to a place in the middle of the buffer,
976 ;; adjust it to the beginning of a line.
980 ;; If the end of the buffer is not already on the screen,
981 ;; then scroll specially to put it near, but not at, the bottom.
986 "Whether single-char deletion commands delete an active region.
987 This has an effect only if Transient Mark mode is enabled, and
988 affects `delete-forward-char' and `delete-backward-char', though
989 not `delete-char'.
991 If the value is the symbol `kill', the active region is killed
992 instead of deleted."
1009 "Function to get the region's content.
1010 Called with one argument DELETE.
1011 If DELETE is `delete-only', then only delete the region and the return value
1012 is undefined. If DELETE is nil, just return the content as a string.
1013 If DELETE is `bounds', then don't delete, but just return the
1014 boundaries of the region as a list of (START . END) positions.
1015 If anything else, delete the region and return its content as a string,
1026 first nil))))
1027 "Function to insert the region's content.
1028 Called with one argument LINES.
1032 "Delete the previous N characters (following if N is negative).
1033 If Transient Mark mode is enabled, the mark is active, and N is 1,
1034 delete the text in the region and deactivate the mark instead.
1035 To disable this, set option `delete-active-region' to nil.
1037 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1038 kill ring) instead of delete. Interactively, N is the prefix
1039 arg, and KILLFLAG is set if N is explicitly specified.
1041 When killing, the killed text is filtered by
1042 `filter-buffer-substring' before it is saved in the kill ring, so
1043 the actual saved text might be different from what was killed.
1045 In Overwrite mode, single character backward deletion may replace
1046 tabs with spaces so as to back over columns, unless point is at
1047 the end of the line."
1053 delete-active-region
1055 ;; If a region is active, kill or delete it.
1059 ;; In Overwrite mode, maybe untabify while deleting
1069 ;; Otherwise, do simple deletion.
1073 "Delete the following N characters (previous if N is negative).
1074 If Transient Mark mode is enabled, the mark is active, and N is 1,
1075 delete the text in the region and deactivate the mark instead.
1076 To disable this, set variable `delete-active-region' to nil.
1078 Optional second arg KILLFLAG non-nil means to kill (save in kill
1079 ring) instead of delete. Interactively, N is the prefix arg, and
1080 KILLFLAG is set if N was explicitly specified.
1082 When killing, the killed text is filtered by
1083 `filter-buffer-substring' before it is saved in the kill ring, so
1084 the actual saved text might be different from what was killed."
1090 delete-active-region
1092 ;; If a region is active, kill or delete it.
1097 ;; Otherwise, do simple deletion.
1101 "Put point at beginning and mark at end of buffer.
1102 If narrowing is in effect, only uses the accessible part of the buffer.
1103 You probably should not use this function in Lisp programs;
1104 it is usually a mistake for a Lisp function to use any subroutine
1105 that uses or sets the mark."
1110 ;; This is really `point-min' in most cases, but if we're in the
1111 ;; minibuffer, this is at the end of the prompt.
1113 \f
1115 ;; Counting lines, one way or another.
1118 "Go to LINE, counting from line 1 at beginning of buffer.
1119 If called interactively, a numeric prefix argument specifies
1120 LINE; without a numeric prefix argument, read LINE from the
1121 minibuffer.
1123 If optional argument BUFFER is non-nil, switch to that buffer and
1125 as argument, BUFFER is the most recently selected other buffer.
1127 Prior to moving point, this function sets the mark (without
1128 activating it), unless Transient Mark mode is enabled and the
1129 mark is already active.
1131 This function is usually the wrong thing to use in a Lisp program.
1132 What you probably want instead is something like:
1133 (goto-char (point-min))
1134 (forward-line (1- N))
1135 If at all possible, an even better solution is to use char counts
1136 rather than line counts."
1141 ;; Look for a default, a number in the buffer at point.
1151 ;; Decide if we're switching buffers.
1159 ;; Read the argument, offering that number (if any) as default.
1162 buffer))))
1163 ;; Switch to the desired buffer, one way or another.
1168 ;; Leave mark at previous position
1170 ;; Move to the specified line number in that buffer.
1179 "Count the number of words in the region.
1180 If called interactively, print a message reporting the number of
1181 lines, words, and characters in the region (whether or not the
1182 region is active); with prefix ARG, report for the entire buffer
1183 rather than the region.
1185 If called from Lisp, return the number of words between positions
1186 START and END."
1198 "Count words between START and END.
1199 If called interactively, START and END are normally the start and
1200 end of the buffer; but if the region is active, START and END are
1201 the start and end of the region. Print a message reporting the
1202 number of lines, words, and chars.
1204 If called from Lisp, return the number of words between START and
1205 END, without printing any message."
1215 words))
1231 str
1239 "Print the current buffer line number and narrowed line number of point."
1252 "Return number of lines between START and END.
1253 This is usually the number of newlines between them,
1254 but can be one more if START is not equal to END
1255 and the greater of them is not at the start of a line."
1271 done)))
1275 "Return (narrowed) buffer line number at position POS.
1276 If POS is nil, use current buffer location.
1277 Counting starts at (point-min), so the value refers
1278 to the contents of the accessible portion of the buffer."
1288 "Print info on cursor position (on screen and within buffer).
1289 Also describe the character after point, and give its character code
1290 in octal, decimal and hex.
1292 For a non-ASCII multibyte character, also give its encoding in the
1293 buffer's selected coding system if the coding system encodes the
1294 character safely. If the character is encoded into one byte, that
1295 code is shown in hex. If the character is encoded into more than one
1298 In addition, with prefix argument, show details about that character
1299 in *Help* buffer. See also the command `describe-char'."
1303 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1304 ;; start a directional embedding, which could completely
1305 ;; disrupt the rest of the line (e.g., RLO will display the
1306 ;; rest of the line right-to-left). So we put an invisible
1307 ;; PDF character after these characters, to end the
1308 ;; embedding, which eliminates any effects on the rest of
1309 ;; the line. For RLE and RLO we also append an invisible
1310 ;; LRM, to avoid reordering the following numerical
1311 ;; characters. For LRI/RLI/FSI we append a PDI.
1318 ;; Strong right-to-left characters cause reordering of
1319 ;; the following numerical characters which show the
1320 ;; codepoint, so append LRM to countermand that.
1331 ""
1337 pos total percent beg end col hscroll)
1339 pos total col hscroll))
1341 encoded encoding-msg display-prop under-display)
1348 ;; Check if the character is displayed with some `display'
1349 ;; text property. In that case, set under-display to the
1350 ;; buffer substring covered by that property.
1361 under-display)))
1367 char char char under-display)
1369 char char char under-display display-prop))
1372 char char char
1374 "..."
1378 ;; We show the detailed information about CHAR.
1385 bidi-fixer
1386 encoding-msg pos total percent beg end col hscroll)
1393 bidi-fixer encoding-msg pos total percent col hscroll))))))
1394 \f
1395 ;; Initialize read-expression-map. It is defined at C level.
1399 ;; Might as well bind TAB to completion, since inserting a TAB char is
1400 ;; much too rarely useful.
1403 m))
1406 "Return a Lisp object read using the minibuffer, unevaluated.
1407 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1408 is a string to insert in the minibuffer before reading.
1409 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1410 Such arguments are used as in `read-from-minibuffer'.)"
1411 ;; Used for interactive spec `x'.
1416 "Return value of Lisp expression read using the minibuffer.
1417 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1418 is a string to insert in the minibuffer before reading.
1419 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1420 Such arguments are used as in `read-from-minibuffer'.)"
1421 ;; Used for interactive spec `X'.
1429 "The current default value or list of default values in the minibuffer.
1430 The functions `read-from-minibuffer' and `completing-read' bind
1434 "Value for `print-level' while printing value in `eval-expression'.
1435 A value of nil means no limit."
1441 "Value for `print-length' while printing value in `eval-expression'.
1442 A value of nil means no limit."
1448 "If non-nil set `debug-on-error' to t in `eval-expression'.
1449 If nil, don't change the value of `debug-on-error'."
1455 "If VALUE in an integer, return a specially formatted string.
1457 If VALUE is not an integer, nil is returned.
1458 This function is used by functions like `prin1' that display the
1459 result of expression evaluation."
1478 ;; FIXME: call emacs-lisp-mode?
1485 read-expression-map t
1488 ;; We define this, rather than making `eval' interactive,
1489 ;; for the sake of completion of names like eval-region, eval-buffer.
1491 "Evaluate EXP and print value in the echo area.
1492 When called interactively, read an Emacs Lisp expression and evaluate it.
1493 Value is also consed on to front of the variable `values'.
1494 If the resulting value is an integer, it will be printed in
1495 several additional formats (octal, hexadecimal, and character).
1496 Optional argument INSERT-VALUE non-nil (interactively, with
1497 prefix argument) means insert the result into the current buffer
1498 instead of printing it in the echo area.
1500 Normally, this function truncates long output according to the value
1501 of the variables `eval-expression-print-length' and
1502 `eval-expression-print-level'. With a prefix argument of zero,
1503 however, there is no such truncation.
1505 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1506 minibuffer.
1508 If `eval-expression-debug-on-error' is non-nil, which is the default,
1509 this command arranges for all errors to enter the debugger."
1512 current-prefix-arg))
1517 ;; Bind debug-on-error to something unique so that we can
1518 ;; detect when evalled code changes it.
1522 ;; If evalled code has changed the value of debug-on-error,
1523 ;; propagate that change to the global binding.
1528 eval-expression-print-length))
1530 eval-expression-print-level))
1546 "Prompting with PROMPT, let user edit COMMAND and eval result.
1547 COMMAND is a Lisp expression. Let user edit that expression in
1548 the minibuffer, then read and evaluate the result."
1555 read-expression-map t
1557 ;; If command was added to command-history as a string,
1558 ;; get rid of that. We want only evaluable expressions there.
1562 ;; If command to be redone does not match front of history,
1563 ;; add it to the history.
1569 "Edit and re-evaluate last complex command, or ARGth from last.
1570 A complex command is one which used the minibuffer.
1571 The command is placed in the minibuffer as a Lisp form for editing.
1572 The result is executed, repeating the command as changed.
1573 If the command has been changed or is not the most recent previous
1574 command it is added to the front of the command history.
1575 You can use the minibuffer history commands \
1577 to get different commands to edit and resubmit."
1580 newcmd)
1592 ;; If command was added to command-history as a
1593 ;; string, get rid of that. We want only
1594 ;; evaluable expressions there.
1598 ;; If command to be redone does not match front of history,
1599 ;; add it to the history.
1614 "Read command name to invoke in `execute-extended-command'."
1624 ;; Get a command name at point in the original buffer
1625 ;; to propose it after M-n.
1629 ;; Read a string, completing from and restricting to the set of
1630 ;; all defined commands. Don't provide any initial input.
1631 ;; Save the command read on the extended-command history list.
1642 ;; This isn't strictly correct if `execute-extended-command'
1643 ;; is bound to anything else (e.g. [menu]).
1644 ;; It could use (key-description (this-single-command-keys)),
1645 ;; but actually a prompt other than "M-x" would be confusing,
1646 ;; because "M-x" is a well-known prompt to read a command
1647 ;; and it serves as a shorthand for "Extended command: ".
1652 ;; Exclude obsolete commands from completions.
1657 pred)))
1662 "Non-nil means show the equivalent key-binding when M-x command has one.
1663 The value can be a length of time to show the message for.
1664 If the value is non-nil and not a number, we wait 2 seconds."
1671 "If non-nil, show a shorter M-x invocation when there is one."
1692 binding)
1698 name len)))
1699 ;; Don't show the help message if the binding isn't
1700 ;; significantly shorter than the M-x command the user typed.
1707 binding))
1710 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1711 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1712 "Read a command name, then read the arguments and call the command.
1713 To pass a prefix argument to the command you are
1714 invoking, give a prefix argument to `execute-extended-command'."
1716 ;; FIXME: Remember the actual text typed by the user before completion,
1717 ;; so that we don't later on suggest the same shortening.
1722 execute-extended-command--last-typed)))
1723 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1736 ;; Normally `real-this-command' should never be changed, but here we really
1737 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1738 ;; binding" for <cmd>, so the command the user really wanted to run is
1739 ;; `function' and not `execute-extended-command'. The difference is
1740 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1744 ;; If enabled, show which key runs this command.
1745 ;; But first wait, and skip the message if there is input.
1747 ;; If this command displayed something in the echo area;
1748 ;; wait a few seconds, then display our suggestion message.
1749 ;; FIXME: Wait *after* running post-command-hook!
1750 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1751 ;; find a better answer anyway!
1761 ;; There's no binding for CMD. Let's try and find the shortest
1762 ;; string to use in M-x.
1763 ;; FIXME: Can be slow. Cache it maybe?
1770 function
1775 suggest-key-bindings
1779 ;; BEWARE: Called directly from the C code.
1780 "Execute CMD as an editor command.
1781 CMD must be a symbol that satisfies the `commandp' predicate.
1782 Optional second arg RECORD-FLAG non-nil
1783 means unconditionally put this command in the variable `command-history'.
1784 Otherwise, that is done only if an arg is read using the minibuffer.
1785 The argument KEYS specifies the value to use instead of (this-command-keys)
1786 when reading the arguments; if it is nil, (this-command-keys) is used.
1787 The argument SPECIAL, if non-nil, means that this command is executing
1788 a special event, so ignore the prefix argument and don't clear it."
1791 ;; FIXME: This should probably be done around
1792 ;; pre-command-hook rather than here!
1800 disabled-command-function)
1801 ;; FIXME: Weird calling convention!
1811 ;; If requested, place the macro in the command history. For
1812 ;; other sorts of commands, call-interactively takes care of this.
1815 ;; Don't keep command history around forever.
1821 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1829 \f
1831 "Default minibuffer history list.
1832 This is used for all minibuffer input
1833 except when an alternate history list is specified.
1835 Maximum length of the history list is determined by the value
1838 "Control whether history list elements are expressions or strings.
1839 If the value of this variable equals current minibuffer depth,
1840 they are expressions; otherwise they are strings.
1841 \(That convention is designed to do the right thing for
1848 "Text that was in this minibuffer before any history commands.
1849 This is nil if there have not yet been any history commands
1858 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1863 "Minibuffer history variables for which matching should ignore case.
1864 If a history variable is a member of this list, then the
1866 commands ignore case when searching it, regardless of `case-fold-search'."
1871 "Find the previous history element that matches REGEXP.
1872 \(Previous history elements refer to earlier actions.)
1873 With prefix argument N, search for Nth previous match.
1874 If N is negative, find the next or Nth next match.
1875 Normally, history elements are matched case-insensitively if
1876 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1877 makes the search case-sensitive.
1878 See also `minibuffer-history-case-insensitive-variables'."
1882 nil
1883 minibuffer-local-map
1884 nil
1885 'minibuffer-history-search-history
1887 ;; Use the last regexp specified, by default, if input is empty.
1892 regexp)
1902 ;; On some systems, ignore case for file names.
1904 minibuffer-history-case-insensitive-variables)
1905 t
1906 ;; Respect the user's setting for case-fold-search:
1907 case-fold-search)
1908 nil))
1909 prevpos
1910 match-string
1911 match-offset
1918 "No later matching history item"
1939 next-matching-history-element))
1943 "Find the next history element that matches REGEXP.
1944 \(The next history element refers to a more recent action.)
1945 With prefix argument N, search for Nth next match.
1946 If N is negative, find the previous or Nth previous match.
1947 Normally, history elements are matched case-insensitively if
1948 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1949 makes the search case-sensitive."
1953 nil
1954 minibuffer-local-map
1955 nil
1956 'minibuffer-history-search-history
1958 ;; Use the last regexp specified, by default, if input is empty.
1963 regexp)
1970 "Function run by `goto-history-element' before consuming default values.
1971 This is useful to dynamically add more elements to the list of default values
1972 when `goto-history-element' reaches the end of this list.
1973 Before calling this function `goto-history-element' sets the variable
1974 `minibuffer-default-add-done' to t, so it will call this function only
1975 once. In special cases, when this function needs to be called more
1976 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1980 "When nil, add more elements to the end of the list of default values.
1981 The value nil causes `goto-history-element' to add more elements to
1982 the list of defaults when it reaches the end of this list. It does
1988 "Return a list of all completions without the default value.
1989 This function is used to add all elements of the completion table to
1990 the end of the list of defaults just after the default value."
1993 minibuffer-completion-table
1994 minibuffer-completion-predicate)))
2000 "Puts element of the minibuffer history in the minibuffer.
2001 The argument NABS specifies the absolute history position."
2015 elt minibuffer-returned-to-present)
2022 "End of defaults; no next item"
2029 previous-history-element))
2041 minibuffer-default)))
2053 elt))
2057 "Puts next element of the minibuffer history in the minibuffer.
2058 With argument N, it uses the Nth following element."
2064 "Puts previous element of the minibuffer history in the minibuffer.
2065 With argument N, it uses the Nth previous element."
2071 "Move cursor vertically down ARG lines, or to the next history element.
2072 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2073 next element of the minibuffer history in the minibuffer."
2077 ;; Remember the original goal column of possibly multi-line input
2078 ;; excluding the length of the prompt on the first line.
2088 ;; Restore old position since `line-move-visual' moves point to
2089 ;; the end of the line when it fails to go to the next line.
2092 ;; Reset `temporary-goal-column' because a correct value is not
2093 ;; calculated when `next-line' above fails by bumping against
2094 ;; the bottom of the minibuffer (bug#22544).
2096 ;; Restore the original goal column on the last line
2097 ;; of possibly multi-line input.
2105 "Move cursor vertically up ARG lines, or to the previous history element.
2106 When point moves over the top line of multi-line minibuffer, puts ARGth
2107 previous element of the minibuffer history in the minibuffer."
2111 ;; Remember the original goal column of possibly multi-line input
2112 ;; excluding the length of the prompt on the first line.
2122 ;; Restore old position since `line-move-visual' moves point to
2123 ;; the beginning of the line when it fails to go to the previous line.
2126 ;; Reset `temporary-goal-column' because a correct value is not
2127 ;; calculated when `previous-line' above fails by bumping against
2128 ;; the top of the minibuffer (bug#22544).
2130 ;; Restore the original goal column on the first line
2131 ;; of possibly multi-line input.
2137 ;; Put the cursor at the end of the visual line instead of the
2138 ;; logical line, so the next `previous-line-or-history-element'
2139 ;; would move to the previous history element, not to a possible upper
2140 ;; visual line from the end of logical line in `line-move-visual' mode.
2142 ;; Since `end-of-visual-line' puts the cursor at the beginning
2143 ;; of the next visual line, move it one char back to the end
2144 ;; of the first visual line (bug#22544).
2148 "Get next history element which completes the minibuffer before the point.
2149 The contents of the minibuffer after the point are deleted, and replaced
2150 by the new completion."
2156 n)
2157 ;; next-matching-history-element always puts us at (point-min).
2158 ;; Move to the position we were at before changing the buffer contents.
2159 ;; This is still sensible, because the text before point has not changed.
2163 "\
2164 Get previous history element which completes the minibuffer before the point.
2165 The contents of the minibuffer after the point are deleted, and replaced
2166 by the new completion."
2170 ;; For compatibility with the old subr of the same name.
2172 "Return the display width of the minibuffer prompt.
2173 Return 0 if current buffer is not a minibuffer."
2174 ;; Return the width of everything before the field at the end of
2175 ;; the buffer; this should be 0 for normal buffers.
2177 \f
2178 ;; isearch minibuffer history
2185 "Set up a minibuffer for using isearch to search the minibuffer history.
2186 Intended to be added to `minibuffer-setup-hook'."
2198 "Clean up the minibuffer after terminating isearch in the minibuffer."
2203 "Return the proper search function, for isearch in minibuffer history."
2206 ;; Use standard functions to search within minibuffer text
2208 found)
2209 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2210 ;; searching forward. Lazy-highlight calls this lambda with the
2211 ;; bound arg, so skip the minibuffer prompt.
2215 ;; 1. First try searching in the initial minibuffer text
2218 noerror)
2219 ;; 2. If the above search fails, start putting next/prev history
2220 ;; elements in the minibuffer successively, and search the string
2221 ;; in them. Do this only when bound is nil (i.e. not while
2222 ;; lazy-highlighting search strings in the current minibuffer text).
2234 ;; After putting the next/prev history element, search
2235 ;; the string in them again, until next-history-element
2236 ;; or previous-history-element raises an error at the
2237 ;; beginning/end of history.
2240 ;; For backward search, don't search
2241 ;; in the minibuffer prompt
2243 noerror)))
2244 ;; Return point of the new search result
2246 ;; Return nil when next(prev)-history-element fails
2250 "Display the minibuffer history search prompt.
2251 If there are no search errors, this function displays an overlay with
2252 the isearch prompt which replaces the original minibuffer prompt.
2253 Otherwise, it displays the standard isearch message returned from
2254 the function `isearch-message'."
2256 ;; Use standard function `isearch-message' when not in the minibuffer,
2257 ;; or search fails, or has an error (like incomplete regexp).
2258 ;; This function overwrites minibuffer text with isearch message,
2259 ;; so it's possible to see what is wrong in the search string.
2261 ;; Otherwise, put the overlay with the standard isearch prompt over
2262 ;; the initial minibuffer prompt.
2271 ;; And clear any previous isearch message.
2275 "Wrap the minibuffer history search when search fails.
2276 Move point to the first history element for a forward search,
2277 or to the last history element for a backward search."
2278 ;; When `minibuffer-history-isearch-search' fails on reaching the
2279 ;; beginning/end of the history, wrap the search to the first/last
2280 ;; minibuffer history element.
2288 "Save a function restoring the state of minibuffer history search.
2289 Save `minibuffer-history-position' to the additional state parameter
2290 in the search status stack."
2296 "Restore the minibuffer history search state.
2297 Go to the history element by the absolute history position HIST-POS."
2300 \f
2301 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2305 "Table mapping redo records to the corresponding undo one.
2306 A redo record for undo-in-region maps to t.
2316 "Within a run of consecutive undo commands, list remaining to be undone.
2320 "Undo some previous changes.
2321 Repeat this command to undo more changes.
2322 A numeric ARG serves as a repeat count.
2324 In Transient Mark mode when the mark is active, only undo changes within
2326 as an argument limits undo to changes within the current region."
2328 ;; Make last-command indicate for the next command that this was an undo.
2329 ;; That way, another undo will undo more.
2330 ;; If we get to the end of the undo history and get an error,
2331 ;; another undo command will find the undo history empty
2332 ;; and will get another error. To begin undoing the undos,
2333 ;; you must type some other command.
2335 ;; For an indirect buffer, look in the base buffer for the
2336 ;; auto-save data.
2340 message)
2341 ;; If we get an error in undo-start,
2342 ;; the next command should not be a "consecutive undo".
2343 ;; So set `this-command' to something other than `undo'.
2348 ;; If something (a timer or filter?) changed the buffer
2349 ;; since the previous command, don't continue the undo seq.
2353 ;; If the last undo record made was made by undo
2354 ;; it shows nothing else happened in between.
2361 ;; get rid of initial undo boundary
2363 ;; If we got this far, the next command should be a consecutive undo.
2365 ;; Check to see whether we're hitting a redo record, and if
2366 ;; so, ask the user whether she wants to skip the redo/undo pair.
2374 ;; The equiv entry might point to another redo record if we have done
2375 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2383 ;; Record the fact that the just-generated undo records come from an
2384 ;; undo operation--that is, they are redo records.
2385 ;; In the ordinary case (not within a region), map the redo
2386 ;; record to the following undos.
2387 ;; I don't know how to do that in the undo-in-region case.
2389 ;; Strip any leading undo boundaries there might be, like we do
2390 ;; above when checking.
2394 ;; Prevent identity mapping. This can happen if
2395 ;; consecutive nils are erroneously in undo list.
2397 t
2398 pending-undo-list)
2399 undo-equiv-table))
2400 ;; Don't specify a position in the undo record for the undo command.
2401 ;; Instead, undoing this should move point to where the change is.
2420 ;; Record what the current undo list says,
2421 ;; so the next command can tell if the buffer was modified in between.
2425 ;; Display a message announcing success.
2430 "Make BUFFER stop keeping undo information.
2431 No argument or nil as argument means do this for the current buffer."
2437 "Undo some previous changes.
2438 Repeat this command to undo more changes.
2439 A numeric ARG serves as a repeat count.
2440 Contrary to `undo', this will not redo a previous undo."
2445 "Non-nil while performing an undo.
2449 "Undo back N undo-boundaries beyond what was already undone recently.
2450 Call `undo-start' to get ready to undo recent changes,
2451 then call `undo-more' one or more times to undo them."
2456 ;; Note: The following, while pulling elements off
2457 ;; `pending-undo-list' will call primitive change functions which
2458 ;; will push more elements onto `buffer-undo-list'.
2464 "Undo N records from the front of the list LIST.
2465 Return what remains of the list."
2467 ;; This is a good feature, but would make undo-start
2468 ;; unable to do what is expected.
2469 ;;(when (null (car (list)))
2470 ;; ;; If the head of the list is a boundary, it is the boundary
2471 ;; ;; preceding this command. Get rid of it and don't count it.
2472 ;; (setq list (cdr list))))
2475 ;; In a writable buffer, enable undoing read-only text that is
2476 ;; so because of text properties.
2478 ;; Don't let `intangible' properties interfere with undo.
2480 ;; We use oldlist only to check for EQ. ++kfs
2486 ;; Handle an integer by setting point to that value.
2489 ;; Element (t . TIME) records previous modtime.
2490 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2491 ;; UNKNOWN_MODTIME_NSECS.
2493 ;; If this records an obsolete save
2494 ;; (not matching the actual disk file)
2495 ;; then don't mark unmodified.
2503 ;; Element (nil PROP VAL BEG . END) is property change.
2508 ;; Element (BEG . END) means range was inserted.
2510 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2511 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2514 ;; Set point first thing, so that undoing this undo
2515 ;; does not send point back to where it is now.
2518 ;; Element (apply FUN . ARGS) means call FUN to undo.
2522 ;; Long format: (apply DELTA START END FUN . ARGS).
2529 ;; Check that the function did what the entry
2530 ;; said it would do.
2540 ;; Element (STRING . POS) means STRING was deleted.
2546 ;; Check that marker adjustments which were recorded
2547 ;; with the (STRING . POS) record are still valid, ie
2548 ;; the markers haven't moved. We check their validity
2549 ;; before reinserting the string so as we don't need to
2550 ;; mind marker insertion-type.
2558 ;; Insert string and adjust point
2566 ;; Adjust the valid marker adjustments
2570 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2573 next)
2574 ;; Even though these elements are not expected in the undo
2575 ;; list, adjust them to be conservative for the 24.4
2576 ;; release. (Bug#16818)
2583 ;; Make sure an apply entry produces at least one undo entry,
2584 ;; so the test in `undo' for continuing an undo series
2585 ;; will work right.
2590 list)
2592 ;; Deep copy of a list
2594 "Make a copy of undo list LIST."
2600 elt))
2603 "Set `pending-undo-list' to the front of the undo list.
2604 The next call to `undo-more' will undo the most recently made change.
2605 If BEG and END are specified, then only undo elements
2606 that apply to text between BEG and END are used; other undo elements
2607 are ignored. If BEG and END are nil, all undo elements are used."
2613 buffer-undo-list)))
2615 ;; The positions given in elements of the undo list are the positions
2616 ;; as of the time that element was recorded to undo history. In
2617 ;; general, subsequent buffer edits render those positions invalid in
2618 ;; the current buffer, unless adjusted according to the intervening
2619 ;; undo elements.
2620 ;;
2621 ;; Undo in region is a use case that requires adjustments to undo
2622 ;; elements. It must adjust positions of elements in the region based
2623 ;; on newer elements not in the region so as they may be correctly
2624 ;; applied in the current buffer. undo-make-selective-list
2625 ;; accomplishes this with its undo-deltas list of adjustments. An
2626 ;; example undo history from oldest to newest:
2627 ;;
2628 ;; buf pos:
2629 ;; 123456789 buffer-undo-list undo-deltas
2630 ;; --------- ---------------- -----------
2631 ;; aaa (1 . 4) (1 . -3)
2632 ;; aaba (3 . 4) N/A (in region)
2633 ;; ccaaba (1 . 3) (1 . -2)
2634 ;; ccaabaddd (7 . 10) (7 . -3)
2635 ;; ccaabdd ("ad" . 6) (6 . 2)
2636 ;; ccaabaddd (6 . 8) (6 . -2)
2637 ;; | |<-- region: "caab", from 2 to 6
2638 ;;
2639 ;; When the user starts a run of undos in region,
2640 ;; undo-make-selective-list is called to create the full list of in
2641 ;; region elements. Each element is adjusted forward chronologically
2642 ;; through undo-deltas to determine if it is in the region.
2643 ;;
2644 ;; In the above example, the insertion of "b" is (3 . 4) in the
2645 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2646 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2647 ;; . 6) is assessed as in the region and placed in the selective list.
2648 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2649 ;; due to the selected element. The "b" insertion is the only element
2650 ;; fully in the region, so in this example undo-make-selective-list
2651 ;; returns (nil (5 . 6)).
2652 ;;
2653 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2654 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2655 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2656 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2657 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2658 ;;
2659 ;; More interesting is how to adjust the "ddd" insertion due to the
2660 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2661 ;; If the reinsertion was a manual retyping of "ad", then the total
2662 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2663 ;; the reinsertion was due to undo, one might expect the first "d"
2664 ;; character would again be a part of the "ddd" text, meaning its
2665 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2666 ;;
2667 ;; undo-make-selective-list assumes in this situation that "ad" was a
2668 ;; new edit, even if it was inserted because of an undo.
2669 ;; Consequently, if the user undos in region "8 to 10" of the
2670 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2671 ;; "ccaabad", as though the first "d" became detached from the
2672 ;; original "ddd" insertion. This quirk is a FIXME.
2675 "Return a list of undo elements for the region START to END.
2676 The elements come from `buffer-undo-list', but we keep only the
2677 elements inside this region, and discard those outside this
2678 region. The elements' positions are adjusted so as the returned
2679 list can be applied to the current buffer."
2681 ;; A list of position adjusted undo elements in the region.
2683 ;; A list of undo-deltas for out of region undo elements.
2684 undo-deltas
2685 undo-elt)
2693 ;; Don't put two nils together in the list
2697 ;; This is a "was unmodified" element. Keep it
2698 ;; if we have kept everything thus far.
2701 ;; Skip over marker adjustments, instead relying
2702 ;; on finding them after (TEXT . POS) elements
2704 nil)
2707 undo-deltas)))
2712 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2713 ;; kept. primitive-undo may discard them later.
2726 "Determine whether UNDO-ELT falls inside the region START ... END.
2727 If it crosses the edge, we return nil.
2729 Generally this function is not useful for determining
2730 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2731 because markers can be arbitrarily relocated. Instead, pass the
2732 marker adjustment's corresponding (TEXT . POS) element."
2737 t)
2739 nil)
2741 ;; (TEXT . POSITION)
2745 ;; (MARKER . ADJUSTMENT)
2748 ;; (nil PROPERTY VALUE BEG . END)
2753 ;; (BEGIN . END)
2758 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2759 This assumes we have already decided that UNDO-ELT
2760 is not *inside* the region START...END."
2764 ;; (nil PROPERTY VALUE BEG . END)
2769 ;; (BEGIN . END)
2774 "Return adjustment of undo element ELT by the undo DELTAS
2775 list."
2777 ;; POSITION
2780 ;; (BEG . END)
2783 ;; (TEXT . POSITION)
2787 ;; (nil PROPERTY VALUE BEG . END)
2790 ;; (apply DELTA START END FUN . ARGS)
2791 ;; FIXME
2792 ;; All others return same elt
2795 ;; (BEG . END) can adjust to the same positions, commonly when an
2796 ;; insertion was undone and they are out of region, for example:
2797 ;;
2798 ;; buf pos:
2799 ;; 123456789 buffer-undo-list undo-deltas
2800 ;; --------- ---------------- -----------
2801 ;; [...]
2802 ;; abbaa (2 . 4) (2 . -2)
2803 ;; aaa ("bb" . 2) (2 . 2)
2804 ;; [...]
2805 ;;
2806 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2807 ;; undo. Further adjustments to such an element should be the same as
2808 ;; for (TEXT . POSITION) elements. The options are:
2809 ;;
2810 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2811 ;; analogous to marker insertion-type t.
2812 ;;
2813 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2814 ;; marker insertion-type nil.
2815 ;;
2816 ;; There was no strong reason to prefer one or the other, except that
2817 ;; the first is more consistent with prior undo in region behavior.
2819 "Return cons of adjustments to BEG and END by the undo DELTAS
2820 list."
2822 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2827 "Return adjustment of POS by the undo DELTAS list, comparing
2828 with < or <= based on USE-<."
2834 ;; Don't allow pos to become less than the undo-delta
2835 ;; position. This edge case is described in the overview
2836 ;; comments.
2839 ;; Return the first affected buffer position and the delta for an undo element
2840 ;; delta is defined as the change in subsequent buffer positions if we *did*
2841 ;; the undo.
2845 ;; (TEXT . POSITION)
2848 ;; (BEGIN . END)
2854 ;;; Default undo-boundary addition
2855 ;;
2856 ;; This section adds a new undo-boundary at either after a command is
2857 ;; called or in some cases on a timer called after a change is made in
2858 ;; any buffer.
2860 "Describe the cause of the last undo-boundary.
2862 If `explicit', the last boundary was caused by an explicit call to
2863 `undo-boundary', that is one not called by the code in this
2864 section.
2866 If it is equal to `timer', then the last boundary was inserted
2867 by `undo-auto--boundary-timer'.
2869 If it is equal to `command', then the last boundary was inserted
2870 automatically after a command, that is by the code defined in
2871 this section.
2873 If it is equal to a list, then the last boundary was inserted by
2874 an amalgamating command. The car of the list is the number of
2875 times an amalgamating command has been called, and the cdr are the
2879 "Current timer which will run `undo-auto--boundary-timer' or nil.
2884 "Non-nil if `this-command' should be amalgamated.
2885 This variable is set to nil by `undo-auto--boundaries' and is set
2889 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2893 "Return the number of amalgamating last commands or nil.
2894 Amalgamating commands are, by default, either
2895 `self-insert-command' and `delete-char', but can be any command
2896 that calls `undo-auto-amalgamate'."
2900 "Add an `undo-boundary' to the current buffer if needed.
2901 REASON describes the reason that the boundary is being added; see
2902 `undo-auto--last-boundary' for more information."
2912 undo-auto--undoably-changed-buffers)
2913 cause)))))
2916 "Check recently changed buffers and add a boundary if necessary.
2917 REASON describes the reason that the boundary is being added; see
2918 `undo-last-boundary' for more information."
2919 ;; (Bug #23785) All commands should ensure that there is an undo
2920 ;; boundary whether they have changed the current buffer or not.
2930 "Timer which will run `undo--auto-boundary-timer'."
2935 "Ensure that the `undo-auto-boundary-timer' is set."
2941 "List of buffers that have changed recently.
2943 This list is maintained by `undo-auto--undoable-change' and
2944 `undo-auto--boundaries' and can be affected by changes to their
2948 "Add an `undo-boundary' in appropriate buffers."
2953 'amalgamate
2957 "Amalgamate undo if necessary.
2958 This function can be called before an amalgamating command. It
2959 removes the previous `undo-boundary' if a series of such calls
2960 have been made. By default `self-insert-command' and
2961 `delete-char' are the only amalgamating commands, although this
2962 function could be called by any command wishing to have this
2963 behavior."
2968 last-amalgamating-count
2973 ;; Amalgamate all buffers that have changed.
2977 b
2979 ;; The head of `buffer-undo-list' is nil.
2980 ;; `car-safe' doesn't work because
2981 ;; `buffer-undo-list' need not be a list!
2989 "Called after every undoable buffer change."
2992 ;; End auto-boundary section
2995 "Amalgamate changes in change-group since HANDLE.
2996 Remove all undo boundaries between the state of HANDLE and now.
2997 HANDLE is as returned by `prepare-change-group'."
3006 ;; Temporarily truncate the undo log at ELT.
3011 ;; `elt' is still in the log: normal case.
3013 ;; `elt' is not in the log any more, but that's because
3014 ;; the log is "all new", so we should remove all
3015 ;; boundaries from it.
3019 buffer-undo-list
3020 ;; Preserve the undo-boundaries at either ends of the
3021 ;; change-groups.
3023 ;; Reset the modified cons cell ELT to its original content.
3030 "If non-nil ask about discarding undo info for the current command.
3031 Normally, Emacs discards the undo info for the current command if
3032 it exceeds `undo-outer-limit'. But if you set this option
3033 non-nil, it asks in the echo area whether to discard the info.
3034 If you answer no, there is a slight risk that Emacs might crash, so
3035 only do it if you really want to undo the command.
3037 This option is mainly intended for debugging. You have to be
3038 careful if you use it for other purposes. Garbage collection is
3039 inhibited while the question is asked, meaning that Emacs might
3040 leak memory. So you should make sure that you do not wait
3041 excessively long before answering the question."
3047 "If non-nil, an extra level of size that's ok in an undo item.
3048 We don't ask the user about truncating the undo list until the
3049 current item gets bigger than this amount.
3054 ;; When the first undo batch in an undo list is longer than
3055 ;; undo-outer-limit, this function gets called to warn the user that
3056 ;; the undo info for the current command was discarded. Garbage
3057 ;; collection is inhibited around the call, so it had better not do a
3058 ;; lot of consing.
3064 ;; Don't ask the question again unless it gets even bigger.
3065 ;; This applies, in particular, if the user quits from the question.
3066 ;; Such a quit quits out of GC, but something else will call GC
3067 ;; again momentarily. It will call this function again,
3068 ;; but we don't want to ask the question again.
3072 "Buffer `%s' undo info is %d bytes long; discard it? "
3076 t)
3077 nil))
3083 "The undo info was discarded because it exceeded \
3084 `undo-outer-limit'.
3086 This is normal if you executed a command that made a huge change
3087 to the buffer. In that case, to prevent similar problems in the
3088 future, set `undo-outer-limit' to a value that is large enough to
3089 cover the maximum size of normal changes you expect a single
3090 command to make, but not so large that it might exceed the
3091 maximum memory allotted to Emacs.
3093 If you did not execute any such command, the situation is
3094 probably due to a bug and you should report it.
3096 You can disable the popping up of this buffer by adding the entry
3097 \(undo discard-info) to the user option `warning-suppress-types',
3101 t))
3102 \f
3105 ; These are sorted according to the GNU en_US locale.
3148 )
3150 This is used by Shell mode and other parts of Emacs to recognize
3151 password prompts, including prompts in languages other than
3152 English. Different case choices should not be assumed to be
3153 included; callers should bind `case-fold-search' to t."
3159 "History list for some commands that read shell commands.
3161 Maximum length of the history list is determined by the value
3168 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3169 This buffer is used when `shell-command' or `shell-command-on-region'
3170 is run interactively. A value of nil means that output to stderr and
3177 "Return a list of all commands associated with the current file.
3178 This function is used to add all related commands retrieved by `mailcap'
3179 to the end of the list of defaults just after the default value."
3183 minibuffer-default))
3188 commands))
3199 map)
3203 "Read a shell command from the minibuffer.
3204 The arguments are the same as the ones of `read-from-minibuffer',
3205 except READ and KEYMAP are missing and HIST defaults
3206 to `shell-command-history'."
3214 minibuffer-local-shell-command-map
3215 nil
3217 args)))
3220 "What to do when the output buffer is used by another shell command.
3221 This option specifies how to resolve the conflict where a new command
3222 wants to direct its output to the buffer `*Async Shell Command*',
3223 but this buffer is already taken by another running shell command.
3225 The value `confirm-kill-process' is used to ask for confirmation before
3226 killing the already running process and running a new process
3227 in the same buffer, `confirm-new-buffer' for confirmation before running
3228 the command in a new buffer with a name other than the default buffer name,
3229 `new-buffer' for doing the same without confirmation,
3230 `confirm-rename-buffer' for confirmation before renaming the existing
3231 output buffer and running a new command in the default buffer,
3232 `rename-buffer' for doing the same without confirmation."
3234 confirm-kill-process)
3236 confirm-new-buffer)
3238 new-buffer)
3240 confirm-rename-buffer)
3242 rename-buffer))
3247 "Store a buffer position or erase the buffer.
3248 See `shell-command-dont-erase-buffer'."
3250 pos)
3252 ;; Setting buffer-read-only to nil doesn't suffice
3253 ;; if some text has a non-nil read-only property,
3254 ;; which comint sometimes adds for prompts.
3264 shell-command-saved-pos))))
3267 "Set point in BUFFER after command complete.
3268 BUFFER is the output buffer of the command; if nil, then defaults
3269 to the current BUFFER.
3270 Set point to the `cdr' of the element in `shell-command-saved-pos'
3271 whose `car' is BUFFER."
3283 ;; Set point in the window displaying buf, if any; otherwise
3284 ;; display buf temporary in selected frame and set the point.
3289 buf
3294 "Execute string COMMAND asynchronously in background.
3296 Like `shell-command', but adds `&' at the end of COMMAND
3297 to execute it asynchronously.
3299 The output appears in the buffer `*Async Shell Command*'.
3300 That buffer is in shell mode.
3302 You can configure `async-shell-command-buffer' to specify what to do in
3303 case when `*Async Shell Command*' buffer is already taken by another
3304 running shell command. To run COMMAND without displaying the output
3305 in a window you can configure `display-buffer-alist' to use the action
3306 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3308 In Elisp, you will often be better served by calling `start-process'
3309 directly, since it offers more control and does not impose the use of a
3310 shell (with its need to quote arguments)."
3320 current-prefix-arg
3321 shell-command-default-error-buffer))
3327 "Execute string COMMAND in inferior shell; display output, if any.
3328 With prefix argument, insert the COMMAND's output at point.
3330 Interactively, prompt for COMMAND in the minibuffer.
3332 If COMMAND ends in `&', execute it asynchronously.
3333 The output appears in the buffer `*Async Shell Command*'.
3334 That buffer is in shell mode. You can also use
3335 `async-shell-command' that automatically adds `&'.
3337 Otherwise, COMMAND is executed synchronously. The output appears in
3338 the buffer `*Shell Command Output*'. If the output is short enough to
3339 display in the echo area (which is determined by the variables
3340 `resize-mini-windows' and `max-mini-window-height'), it is shown
3341 there, but it is nonetheless available in buffer `*Shell Command
3342 Output*' even though that buffer is not automatically displayed.
3344 To specify a coding system for converting non-ASCII characters
3346 before this command.
3348 Noninteractive callers can specify coding systems by binding
3349 `coding-system-for-read' and `coding-system-for-write'.
3351 The optional second argument OUTPUT-BUFFER, if non-nil,
3352 says to put the output in some other buffer.
3353 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3354 and insert the output there; a non-nil value of
3355 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3356 If OUTPUT-BUFFER is not a buffer and not nil, insert the output
3357 in current buffer after point leaving mark after it.
3358 This cannot be done asynchronously.
3360 If the command terminates without error, but generates output,
3362 the output can be displayed in the echo area or in its buffer.
3363 If the output is short enough to display in the echo area
3364 \(determined by the variable `max-mini-window-height' if
3365 `resize-mini-windows' is non-nil), it is shown there.
3366 Otherwise,the buffer containing the output is displayed.
3370 of the output.
3372 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3373 or buffer name to which to direct the command's standard error output.
3374 If it is nil, error output is mingled with regular output.
3375 In an interactive call, the variable `shell-command-default-error-buffer'
3376 specifies the value of ERROR-BUFFER.
3378 In Elisp, you will often be better served by calling `call-process' or
3379 `start-process' directly, since it offers more control and does not impose
3380 the use of a shell (with its need to quote arguments)."
3391 current-prefix-arg
3392 shell-command-default-error-buffer))
3393 ;; Look for a handler in case default-directory is a remote file name.
3401 ;; Output goes in current buffer.
3407 temporary-file-directory)))
3408 nil)))
3411 ;; We do not use -f for csh; we will not support broken use of
3412 ;; .cshrcs. Even the BSD csh manual says to use
3413 ;; "if ($?prompt) exit" before things which are not useful
3414 ;; non-interactively. Besides, if someone wants their other
3415 ;; aliases for shell commands then they can still have them.
3419 t)
3420 nil shell-command-switch command)
3427 ;; Do no formatting while reading error file,
3428 ;; because that can run a shell command, and we
3429 ;; don't want that to cause an infinite recursion.
3431 ;; Put point after the inserted errors.
3435 ;; This is like exchange-point-and-mark, but doesn't
3436 ;; activate the mark. It is cleaner to avoid activation,
3437 ;; even though the command loop would deactivate the mark
3438 ;; because we inserted text.
3442 ;; Output goes in a separate buffer.
3443 ;; Preserve the match data in case called from a program.
3444 ;; FIXME: It'd be ridiculous for an Elisp function to call
3445 ;; shell-command and assume that it won't mess the match-data!
3448 ;; Command ending with ampersand means asynchronous.
3452 proc)
3453 ;; Remove the ampersand.
3455 ;; Ask the user what to do with already running process.
3460 ;; If will kill a process, query first.
3465 ;; If will create a new buffer, query first.
3472 ;; It will create a new buffer.
3477 ;; If will rename the buffer, query first.
3486 ;; It will rename the buffer.
3496 shell-command-switch command))
3500 ;; Use the comint filter for proper handling of carriage motion
3501 ;; (see `comint-inhibit-carriage-motion'),.
3503 ))
3504 ;; Otherwise, command is executed synchronously.
3506 output-buffer nil error-buffer)))))))
3509 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3510 MESSAGE may be either a string or a buffer.
3512 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3513 for maximum height of the echo area, as defined by `max-mini-window-height'
3514 if `resize-mini-windows' is non-nil.
3516 Returns either the string shown in the echo area, or when a pop-up
3517 buffer is used, the window used to display it.
3519 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3520 name of the buffer used to display it in the case where a pop-up buffer
3521 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3522 string and it is displayed in the echo area, it is not specified whether
3523 the contents are inserted into the buffer anyway.
3525 Optional arguments ACTION and FRAME are as for `display-buffer',
3526 and are only used if a pop-up buffer is displayed."
3528 ;; Trivial case where we can use the echo area
3532 ;; Trivial case where we can just remove single trailing newline
3535 ;; General case
3538 message
3547 0
3551 (<= lines
3555 max-mini-window-height))
3557 max-mini-window-height)
3561 ;; Don't use the echo area if the output buffer is
3562 ;; already displayed in the selected frame.
3564 ;; Echo area
3570 ;; Buffer
3575 ;; We have a sentinel to prevent insertion of a termination message
3576 ;; in the buffer itself, and to set the point in the buffer when
3577 ;; `shell-command-dont-erase-buffer' is non-nil.
3586 &optional output-buffer replace
3587 error-buffer display-error-buffer
3588 region-noncontiguous-p)
3589 "Execute string COMMAND in inferior shell with region as input.
3590 Normally display output (if any) in temp buffer `*Shell Command Output*';
3591 Prefix arg means replace the region with it. Return the exit code of
3592 COMMAND.
3594 To specify a coding system for converting non-ASCII characters
3596 before this command. By default, the input (from the current buffer)
3597 is encoded using coding-system specified by `process-coding-system-alist',
3598 falling back to `default-process-coding-system' if no match for COMMAND
3599 is found in `process-coding-system-alist'.
3601 Noninteractive callers can specify coding systems by binding
3602 `coding-system-for-read' and `coding-system-for-write'.
3604 If the command generates output, the output may be displayed
3605 in the echo area or in a buffer.
3606 If the output is short enough to display in the echo area
3607 \(determined by the variable `max-mini-window-height' if
3608 `resize-mini-windows' is non-nil), it is shown there.
3609 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3610 The output is available in that buffer in both cases.
3612 If there is output and an error, a message about the error
3613 appears at the end of the output.
3615 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3616 command's output. If the value is a buffer or buffer name,
3617 erase that buffer and insert the output there; a non-nil value of
3618 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3619 If the value is nil, use the buffer `*Shell Command Output*'.
3620 Any other non-nil value means to insert the output in the
3621 current buffer after START.
3623 Optional fifth arg REPLACE, if non-nil, means to insert the
3624 output in place of text from START to END, putting point and mark
3625 around it.
3627 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3628 or buffer name to which to direct the command's standard error
3629 output. If nil, error output is mingled with regular output.
3630 When called interactively, `shell-command-default-error-buffer'
3631 is used for ERROR-BUFFER.
3633 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3634 display the error buffer if there were any errors. When called
3635 interactively, this is t."
3639 ;; Do this before calling region-beginning
3640 ;; and region-end, in case subprocess output
3641 ;; relocates them while we are in the minibuffer.
3643 ;; call-interactively recognizes region-beginning and
3644 ;; region-end specially, leaving them in the history.
3646 string
3647 current-prefix-arg
3648 current-prefix-arg
3649 shell-command-default-error-buffer
3650 t
3657 temporary-file-directory)))
3658 nil))
3659 exit-status)
3660 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3663 output)
3667 shell-file-name t t
3668 nil shell-command-switch
3669 command)
3676 ;; Replace specified region with output from command.
3678 ;; Don't muck with mark unless REPLACE says we should.
3685 t)))
3686 ;; It is rude to delete a buffer which the command is not using.
3687 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3688 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3689 ;; (kill-buffer shell-buffer)))
3690 ;; Don't muck with mark unless REPLACE says we should.
3692 ;; No prefix argument: put the output in a temp buffer,
3693 ;; replacing its entire contents.
3701 ;; If the input is the same buffer as the output,
3702 ;; delete everything but the specified region,
3703 ;; then replace that region with the output.
3709 shell-file-name t
3712 t)
3713 nil shell-command-switch
3714 command)))
3715 ;; Clear the output buffer, then run the command with
3716 ;; output there.
3726 buffer))))
3727 ;; Report the output.
3737 ;; There's some output, display it
3741 ;; No output; error?
3748 shell-command-default-error-buffer)
3755 output))
3758 exit-status))
3761 exit-status output))))
3762 ;; Don't kill: there might be useful info in the undo-log.
3763 ;; (kill-buffer buffer)
3764 )))))
3772 ;; Do no formatting while reading error file,
3773 ;; because that can run a shell command, and we
3774 ;; don't want that to cause an infinite recursion.
3776 ;; Put point after the inserted errors.
3781 exit-status))
3784 "Execute shell command COMMAND and return its output as a string."
3787 standard-output
3791 "Process files synchronously in a separate process.
3792 Similar to `call-process', but may invoke a file handler based on
3793 `default-directory'. The current working directory of the
3794 subprocess is `default-directory'.
3796 File names in INFILE and BUFFER are handled normally, but file
3797 names in ARGS should be relative to `default-directory', as they
3798 are passed to the process verbatim. (This is a difference to
3799 `call-process' which does not support file handlers for INFILE
3800 and BUFFER.)
3802 Some file handlers might not support all variants, for example
3803 they might behave as if DISPLAY was nil, regardless of the actual
3804 value passed."
3806 lc stderr-file)
3816 display args)
3822 "Whether a call of `process-file' changes remote files.
3824 By default, this variable is always set to t, meaning that a
3825 call of `process-file' could potentially change any file on a
3826 remote host. When set to nil, a file handler could optimize
3827 its behavior with respect to remote file attribute caching.
3829 You should only ever change this variable with a let-binding;
3833 "Start a program in a subprocess. Return the process object for it.
3835 Similar to `start-process', but may invoke a file handler based on
3836 `default-directory'. See Info node `(elisp)Magic File Names'.
3838 This handler ought to run PROGRAM, perhaps on the local host,
3839 perhaps on a remote host that corresponds to `default-directory'.
3840 In the latter case, the local part of `default-directory' becomes
3841 the working directory of the process.
3843 PROGRAM and PROGRAM-ARGS might be file names. They are not
3844 objects of file handler invocation. File handlers might not
3845 support pty association, if PROGRAM is nil."
3849 \f
3850 ;;;; Process menu
3864 map))
3867 "Major mode for listing the processes called by Emacs."
3880 "Kill process at point in a `list-processes' buffer."
3891 "Recompute the list of processes for the Process List buffer.
3892 Also, delete any process that is exited or signaled."
3906 face link
3908 "Visit buffer `%s'"
3910 follow-link t
3911 process-buffer ,buf
3912 action process-menu-visit-buffer)
3921 "datagram"
3938 tabulated-list-entries))))))
3944 "Display a list of all processes that are Emacs sub-processes.
3945 If optional argument QUERY-ONLY is non-nil, only processes with
3946 the query-on-exit flag set are listed.
3947 Any process listed as exited or signaled is actually eliminated
3948 after the listing is made.
3949 Optional argument BUFFER specifies a buffer to use, instead of
3951 The return value is always nil.
3953 This function lists only processes that were launched by Emacs. To
3954 see other processes running on the system, use `list-system-processes'."
3966 nil)
3967 \f
3968 ;;;; Prefix commands
3974 ;; BEWARE: Called directly from C code.
3975 ;; If the return value is non-nil, it means we are in the middle of
3976 ;; a command with prefix, such as a command invoked with prefix-arg.
3978 prefix-command--last-echo
3987 "Abnormal hook which constructs the description of the current prefix state.
3991 "Update state of prefix commands.
3999 "Pass the current prefix command state to the next command.
4000 Should be called by all prefix commands.
4001 Runs `prefix-command-preserve-state-hook'."
4003 ;; If the current command is a prefix command, we don't want the next (real)
4004 ;; command to have `last-command' set to, say, `universal-argument'.
4011 nil)
4013 ;;;;; The main prefix command.
4015 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
4040 ;; For backward compatibility, minus with no modifiers is an ordinary
4041 ;; command if digits have already been entered.
4071 map)
4079 "Begin a numeric argument for the following command.
4084 multiplies the argument by 4 each time.
4086 which is different in effect from any particular numeric argument.
4094 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
4095 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
4102 arg)))
4106 "Begin a negative numeric argument for the next command.
4116 "Part of the numeric argument for the next command.
4121 last-command-event
4128 ;; Treat -0 as just -, so that -01 will work.
4131 digit))))
4133 \f
4136 "This variable is a wrapper hook around `buffer-substring--filter'.
4142 "Function to perform the filtering in `filter-buffer-substring'.
4143 The function is called with the same 3 arguments (BEG END DELETE)
4144 that `filter-buffer-substring' received. It should return the
4145 buffer substring between BEG and END, after filtering. If DELETE is
4149 "List of filter functions for `buffer-substring--filter'.
4150 Each function must accept a single argument, a string, and return a string.
4151 The buffer substring is passed to the first function in the list,
4152 and the return value of each function is passed to the next.
4153 As a special convention, point is set to the start of the buffer text
4154 being operated on (i.e., the first argument of `buffer-substring--filter')
4160 "Return the buffer substring between BEG and END, after filtering.
4161 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4163 This calls the function that `filter-buffer-substring-function' specifies
4164 \(passing the same three arguments that it received) to do the work,
4165 and returns whatever it does. The default function does no filtering,
4166 unless a hook has been set.
4168 Use `filter-buffer-substring' instead of `buffer-substring',
4169 `buffer-substring-no-properties', or `delete-and-extract-region' when
4170 you want to allow filtering to take place. For example, major or minor
4171 modes can use `filter-buffer-substring-function' to extract characters
4172 that are special to a buffer, and should not be copied into other buffers."
4176 "Default function to use for `filter-buffer-substring-function'.
4177 Its arguments and return value are as specified for `filter-buffer-substring'.
4178 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4179 \(see `with-wrapper-hook' for details about wrapper hooks),
4180 and the abnormal hook `buffer-substring-filters'.
4181 No filtering is done unless a hook says to."
4192 string)))
4197 ;;;; Window system cut and paste hooks.
4200 "Function to call to make a killed region available to other programs.
4201 Most window systems provide a facility for cutting and pasting
4202 text between different programs, such as the clipboard on X and
4203 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4205 This variable holds a function that Emacs calls whenever text is
4206 put in the kill ring, to make the new kill available to other
4207 programs. The function takes one argument, TEXT, which is a
4211 "Function to call to get text cut from other programs.
4212 Most window systems provide a facility for cutting and pasting
4213 text between different programs, such as the clipboard on X and
4214 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4216 This variable holds a function that Emacs calls to obtain text
4217 that other programs have provided for pasting. The function is
4218 called with no arguments. If no other program has provided text
4219 to paste, the function should return nil (in which case the
4220 caller, usually `current-kill', should use the top of the Emacs
4221 kill ring). If another program has provided text to paste, the
4222 function should return that text as a string (in which case the
4223 caller should put this string in the kill ring as the latest
4224 kill).
4226 The function may also return a list of strings if the window
4227 system supports multiple selections. The first string will be
4228 used as the pasted text, but the other will be placed in the kill
4229 ring for easy access via `yank-pop'.
4231 Note that the function should return a string only if a program
4232 other than Emacs has provided a string for pasting; if Emacs
4233 provided the most recent string, the function should return nil.
4234 If it is difficult to tell whether Emacs or some other program
4235 provided the current string, it is probably good enough to return
4236 nil if the string is equal (according to `string=') to the last
4238 \f
4241 ;;;; The kill ring data structure.
4244 "List of killed text sequences.
4245 Since the kill ring is supposed to interact nicely with cut-and-paste
4246 facilities offered by window systems, use of this variable should
4247 interact nicely with `interprogram-cut-function' and
4248 `interprogram-paste-function'. The functions `kill-new',
4249 `kill-append', and `current-kill' are supposed to implement this
4250 interaction; you may want to use them instead of manipulating the kill
4254 "Maximum length of kill ring before oldest elements are thrown away."
4262 "Save clipboard strings into kill ring before replacing them.
4263 When one selects something in another program to paste it into Emacs,
4264 but kills something in Emacs before actually pasting it,
4265 this selection is gone unless this variable is non-nil,
4266 in which case the other program's selection is saved in the `kill-ring'
4273 "Do not add a new string to `kill-ring' if it duplicates the last one.
4274 The comparison is done using `equal-including-properties'."
4280 "Make STRING the latest kill in the kill ring.
4281 Set `kill-ring-yank-pointer' to point to it.
4282 If `interprogram-cut-function' is non-nil, apply it to STRING.
4283 Optional second argument REPLACE non-nil means that STRING will replace
4284 the front of the kill ring, rather than being added to the list.
4286 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4287 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4288 STRING.
4290 When the yank handler has a non-nil PARAM element, the original STRING
4291 argument is not used by `insert-for-yank'. However, since Lisp code
4292 may access and use elements from the kill ring directly, the STRING
4295 ;; Due to text properties such as 'yank-handler that
4296 ;; can alter the contents to yank, comparison using
4297 ;; `equal' is unsafe.
4322 ;; It has been argued that this should work similar to `self-insert-command'
4323 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4325 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4331 "Append STRING to the end of the latest kill in the kill ring.
4332 If BEFORE-P is non-nil, prepend STRING to the kill.
4333 Also removes the last undo boundary in the current buffer,
4334 depending on `kill-append-merge-undo'.
4335 If `interprogram-cut-function' is set, pass the resulting kill to it."
4343 ;; find the next undo boundary
4347 ;; remove this undo boundary
4352 "Whether rotating the kill ring changes the window system selection.
4353 If non-nil, whenever the kill ring is rotated (usually via the
4354 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4355 to copy the new kill to the window system selection."
4361 "Rotate the yanking point by N places, and then return that kill.
4362 If N is zero and `interprogram-paste-function' is set to a
4363 function that returns a string or a list of strings, and if that
4364 function doesn't return nil, then that string (or list) is added
4365 to the front of the kill ring and the string (or first string in
4366 the list) is returned as the latest kill.
4368 If N is not zero, and if `yank-pop-change-selection' is
4369 non-nil, use `interprogram-cut-function' to transfer the
4370 kill at the new yank point into the window system selection.
4372 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4373 move the yanking point; just return the Nth kill forward."
4376 interprogram-paste-function
4380 ;; Disable the interprogram cut function when we add the new
4381 ;; text to the kill ring, so Emacs doesn't try to own the
4382 ;; selection, with identical text.
4392 kill-ring)))
4397 interprogram-cut-function)
4403 ;;;; Commands for manipulating the kill ring.
4406 "Non-nil means don't signal an error for killing read-only text."
4412 This deletes the text from the buffer and saves it in the kill ring.
4416 If you want to append the killed region to the last killed text,
4420 If the previous command was also a kill command,
4421 the text killed this time appends to the text killed last time
4422 to make one entry in the kill ring.
4424 The killed text is filtered by `filter-buffer-substring' before it is
4425 saved in the kill ring, so the actual saved text might be different
4426 from what was killed.
4428 If the buffer is read-only, Emacs will beep and refrain from deleting
4429 the text, but put the text in the kill ring anyway. This means that
4430 you can use the killing commands to copy text from a read-only buffer.
4432 Lisp programs should use this function for killing text.
4433 (To delete text, use `delete-region'.)
4434 Supply two arguments, character positions BEG and END indicating the
4435 stretch of text to be killed. If the optional argument REGION is
4436 non-nil, the function ignores BEG and END, and kills the current
4437 region instead."
4438 ;; Pass mark first, then point, because the order matters when
4439 ;; calling `kill-append'.
4448 ;; Add that string to the kill ring, one way or another.
4455 nil)
4457 ;; The code above failed because the buffer, or some of the characters
4458 ;; in the region, are read-only.
4459 ;; We should beep, in case the user just isn't aware of this.
4460 ;; However, there's no harm in putting
4461 ;; the region's text in the kill ring, anyway.
4463 ;; Set this-command now, so it will be set even if we get an error.
4465 ;; This should barf, if appropriate, and give us the correct error.
4468 ;; Signal an error if the buffer is read-only.
4470 ;; If the buffer isn't read-only, the text is.
4473 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4474 ;; to get two copies of the text when the user accidentally types M-w and
4475 ;; then corrects it with the intended C-w.
4477 "Save the region as if killed, but don't kill it.
4478 In Transient Mark mode, deactivate the mark.
4479 If `interprogram-cut-function' is non-nil, also save the text for a window
4480 system cut and paste.
4482 The copied text is filtered by `filter-buffer-substring' before it is
4483 saved in the kill ring, so the actual saved text might be different
4484 from what was in the buffer.
4486 When called from Lisp, save in the kill ring the stretch of text
4487 between BEG and END, unless the optional argument REGION is
4488 non-nil, in which case ignore BEG and END, and save the current
4489 region instead.
4491 This command's old key binding has been given to `kill-ring-save'."
4492 ;; Pass mark first, then point, because the order matters when
4493 ;; calling `kill-append'.
4503 nil)
4506 "Save the region as if killed, but don't kill it.
4507 In Transient Mark mode, deactivate the mark.
4508 If `interprogram-cut-function' is non-nil, also save the text for a window
4509 system cut and paste.
4511 If you want to append the killed line to the last killed text,
4514 The copied text is filtered by `filter-buffer-substring' before it is
4515 saved in the kill ring, so the actual saved text might be different
4516 from what was in the buffer.
4518 When called from Lisp, save in the kill ring the stretch of text
4519 between BEG and END, unless the optional argument REGION is
4520 non-nil, in which case ignore BEG and END, and save the current
4521 region instead.
4523 This command is similar to `copy-region-as-kill', except that it gives
4524 visual feedback indicating the extent of the region being copied."
4525 ;; Pass mark first, then point, because the order matters when
4526 ;; calling `kill-append'.
4530 ;; This use of called-interactively-p is correct because the code it
4531 ;; controls just gives the user visual feedback.
4536 "Indicate that the region text has been copied interactively.
4537 If the mark is visible in the selected window, blink the cursor
4538 between point and mark if there is currently no active region
4539 highlighting.
4541 If the mark lies outside the selected window, display an
4542 informative message containing a sample of the copied text. The
4543 optional argument MESSAGE-LEN, if non-nil, specifies the length
4544 of this sample text; it defaults to 40."
4547 ;; Inhibit quitting so we can make a quit here
4548 ;; look like a C-g typed as a command.
4551 ;; Swap point-and-mark quickly so as to show the region that
4552 ;; was selected. Don't do it if the region is highlighted.
4555 ;; Swap point and mark.
4559 ;; Swap back.
4562 ;; If user quit, deactivate the mark
4563 ;; as C-g would as a command.
4569 ;; Don't say "killed"; that is misleading.
4576 "Cause following command, if it kills, to add to previous kill.
4577 If the next command kills forward from point, the kill is
4578 appended to the previous killed text. If the command kills
4579 backward, the kill is prepended. Kill commands that act on the
4580 region, such as `kill-region', are regarded as killing forward if
4581 point is after mark, and killing backward if point is before
4582 mark.
4584 If the next command is not a kill command, `append-next-kill' has
4585 no effect.
4587 The argument is used for internal purposes; do not supply one."
4589 ;; We don't use (interactive-p), since that breaks kbd macros.
4603 "A subroutine of `squeeze-bidi-context'.
4604 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4608 lim1)
4615 ;; L and R categories include embedding and
4616 ;; override controls, but we don't want to
4617 ;; replace them, because that might change
4618 ;; the visual order. Likewise with PDF and
4619 ;; isolate controls.
4621 bidi-directional-non-controls-chars
4622 limit)))))
4623 ;; Replace any run of non-RTL characters by a single LRM.
4625 ;; No more characters of CATEGORY, we are done.
4630 ;; Skip directional controls, if any.
4635 "Replace characters between FROM and TO while keeping bidi context.
4637 This function replaces the region of text with as few characters
4638 as possible, while preserving the effect that region will have on
4639 bidirectional display before and after the region."
4643 ;; This is for when they copy text with read-only text
4644 ;; properties.
4648 ;; Replace each run of non-RTL characters with a single LRM.
4650 ;; Replace each run of non-LTR characters with a single RLM. Note
4651 ;; that the \cR category includes both the Arabic Letter (AL) and
4652 ;; R characters; here we ignore the distinction between them,
4653 ;; because that distinction only affects Arabic Number (AN)
4654 ;; characters, which are weak and don't affect the reordering.
4658 "Return buffer text between START and END with its bidi context.
4660 START and END are assumed to belong to the same physical line
4661 of buffer text. This function prepends and appends to the text
4662 between START and END bidi control characters that preserve the
4663 visual order of that text when it is inserted at some other place."
4668 substr para-dir from to)
4675 ;; If we don't have any mixed directional characters in the
4676 ;; entire line, we can just copy the substring without adding
4677 ;; any context.
4692 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4693 ;; (1) force the string to have the same base embedding
4694 ;; direction as the paragraph direction at the source, no matter
4695 ;; what is the paragraph direction at destination; and (2) avoid
4696 ;; affecting the visual order of the surrounding text at
4697 ;; destination if there are characters of different
4698 ;; directionality there.
4703 "Return portion of current buffer between START and END with bidi context.
4705 This function works similar to `buffer-substring', but it prepends and
4706 appends to the text bidi directional control characters necessary to
4707 preserve the visual appearance of the text if it is inserted at another
4708 place. This is useful when the buffer substring includes bidirectional
4709 text and control characters that cause non-trivial reordering on display.
4710 If copied verbatim, such text can have a very different visual appearance,
4711 and can also change the visual appearance of the surrounding text at the
4712 destination of the copy.
4714 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4715 the text properties."
4728 no-properties)))
4732 substr)))
4733 \f
4734 ;; Yanking.
4739 "List of special text property handling conditions for yanking.
4740 Each element should have the form (PROP . FUN), where PROP is a
4741 property symbol and FUN is a function. When the `yank' command
4742 inserts text into the buffer, it scans the inserted text for
4743 stretches of text that have `eq' values of the text property
4744 PROP; for each such stretch of text, FUN is called with three
4745 arguments: the property's value in that text, and the start and
4746 end positions of the text.
4748 This is done prior to removing the properties specified by
4749 `yank-excluded-properties'."
4752 function))
4755 ;; This is actually used in subr.el but defcustom does not work there.
4758 intangible invisible keymap local-map mouse-face read-only
4759 yank-handler)
4760 "Text properties to discard when yanking.
4761 The value should be a list of text properties to discard or t,
4762 which means to discard all text properties.
4764 See also `yank-handled-properties'."
4771 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4772 Function is called with two parameters, START and END corresponding to
4773 the value of the mark and point; it is guaranteed that START <= END.
4777 "Replace just-yanked stretch of killed text with a different stretch.
4778 This command is allowed only immediately after a `yank' or a `yank-pop'.
4779 At such a time, the region contains a stretch of reinserted
4780 previously-killed text. `yank-pop' deletes that text and inserts in its
4781 place a different stretch of killed text.
4783 With no argument, the previous kill is inserted.
4784 With argument N, insert the Nth previous kill.
4785 If N is negative, this is a more recent kill.
4787 The sequence of kills wraps around, so that after the oldest one
4788 comes the newest one.
4790 This command honors the `yank-handled-properties' and
4791 `yank-excluded-properties' variables, and the `yank-handler' text
4792 property, in the way that `yank' does."
4806 ;; Set the window start back where it was in the yank command,
4807 ;; if possible.
4810 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4811 ;; It is cleaner to avoid activation, even though the command
4812 ;; loop would deactivate the mark because we inserted text.
4815 nil)
4819 More precisely, reinsert the most recent kill, which is the
4820 stretch of killed text most recently killed OR yanked. Put point
4821 at the end, and set mark at the beginning without activating it.
4823 With argument N, reinsert the Nth most recent kill.
4825 This command honors the `yank-handled-properties' and
4826 `yank-excluded-properties' variables, and the `yank-handler' text
4827 property, as described below.
4829 Properties listed in `yank-handled-properties' are processed,
4830 then those listed in `yank-excluded-properties' are discarded.
4832 If STRING has a non-nil `yank-handler' property anywhere, the
4833 normal insert behavior is altered, and instead, for each contiguous
4834 segment of STRING that has a given value of the `yank-handler'
4835 property, that value is used as follows:
4837 The value of a `yank-handler' property must be a list of one to four
4838 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
4839 FUNCTION, if non-nil, should be a function of one argument (the
4840 object to insert); FUNCTION is called instead of `insert'.
4841 PARAM, if present and non-nil, is passed to FUNCTION (to be handled
4842 in whatever way is appropriate; e.g. if FUNCTION is `yank-rectangle',
4843 PARAM may be a list of strings to insert as a rectangle). If PARAM
4844 is nil, then the current segment of STRING is used.
4845 If NOEXCLUDE is present and non-nil, the normal removal of
4846 `yank-excluded-properties' is not performed; instead FUNCTION is
4847 responsible for the removal. This may be necessary if FUNCTION
4848 adjusts point before or after inserting the object.
4849 UNDO, if present and non-nil, should be a function to be called
4850 by `yank-pop' to undo the insertion of the current PARAM. It is
4851 given two arguments, the start and end of the region. FUNCTION
4852 may set `yank-undo-function' to override UNDO.
4857 ;; If we don't get all the way thru, make last-command indicate that
4858 ;; for the following command.
4866 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4867 ;; It is cleaner to avoid activation, even though the command
4868 ;; loop would deactivate the mark because we inserted text.
4871 ;; If we do get all the way thru, make this-command indicate that.
4874 nil)
4877 "Rotate the yanking point in the kill ring.
4878 With ARG, rotate that many kills forward (or backward, if negative)."
4881 \f
4882 ;; Some kill commands.
4884 ;; Internal subroutine of delete-char
4890 ;; Internal subroutine of backward-delete-char
4897 "The method for untabifying when deleting backward.
4898 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4899 `hungry' -- delete all whitespace, both tabs and spaces;
4900 `all' -- delete all whitespace, including tabs, spaces and newlines;
4901 nil -- just delete one character."
4907 "Delete characters backward, changing tabs into spaces.
4908 The exact behavior depends on `backward-delete-char-untabify-method'.
4909 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4910 Interactively, ARG is the prefix arg (default 1)
4911 and KILLP is t if a prefix arg was specified."
4934 arg)))
4935 ;; Avoid warning about delete-backward-char
4939 "Kill up to and including ARGth occurrence of CHAR.
4940 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4941 Goes backward if ARG is negative; error if CHAR not found."
4944 ;; Avoid "obsolete" warnings for translation-table-for-input.
4952 ;; kill-line and its subroutines.
4955 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4960 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4961 With prefix argument ARG, kill that many lines from point.
4962 Negative arguments kill lines backward.
4963 With zero argument, kills the text before point on the current line.
4966 a number counts as a prefix arg.
4968 To kill a whole line, when point is not at the beginning, type \
4971 If `show-trailing-whitespace' is non-nil, this command will just
4972 kill the rest of the current line, even if there are no nonblanks
4973 there.
4975 If option `kill-whole-line' is non-nil, then this command kills the whole line
4976 including its terminating newline, when used at the beginning of a line
4977 with no argument. As a consequence, you can always kill a whole line
4980 If you want to append the killed line to the last killed text,
4983 If the buffer is read-only, Emacs will beep and refrain from deleting
4984 the line, but put the line in the kill ring anyway. This means that
4985 you can use this command to copy text from a read-only buffer.
4986 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4987 even beep.)"
4990 ;; It is better to move point to the other end of the kill
4991 ;; before killing. That way, in a read-only buffer, point
4992 ;; moves across the text that is copied to the kill ring.
4993 ;; The choice has no effect on undo now that undo records
4994 ;; the value of point from before the command was run.
5004 ;; If trailing whitespace is visible,
5005 ;; don't treat it as nothing.
5015 "Kill current line.
5016 With prefix ARG, kill that many lines starting from the current line.
5017 If ARG is negative, kill backward. Also kill the preceding newline.
5019 If ARG is zero, kill current line but exclude the trailing newline."
5030 ;; We need to kill in two steps, because the previous command
5031 ;; could have been a kill command, in which case the text
5032 ;; before point needs to be prepended to the current kill
5033 ;; ring entry and the text after point appended. Also, we
5034 ;; need to use save-excursion to avoid copying the same text
5035 ;; twice to the kill ring in read-only buffers.
5053 "Move forward by ARG lines, ignoring currently invisible newlines only.
5054 If ARG is negative, move backward -ARG lines.
5055 If ARG is zero, move to the beginning of the current line."
5062 ;; If the newline we just skipped is invisible,
5063 ;; don't count it.
5067 prop
5072 ;; If invisible text follows, and it is a number of complete lines,
5073 ;; skip it.
5079 prop
5095 ;; If the newline we just moved to is invisible,
5096 ;; don't count it.
5101 prop
5106 ;; If invisible text follows, and it is a number of complete lines,
5107 ;; skip it.
5113 prop
5124 nil)))
5127 "Move to end of current visible line."
5129 ;; If the following character is currently invisible,
5130 ;; skip all characters with that same `invisible' property value,
5131 ;; then find the next newline.
5138 prop
5147 \f
5149 "Insert after point the contents of BUFFER.
5150 Puts mark after the inserted text.
5151 BUFFER may be a buffer or a buffer name."
5161 t))))
5166 nil)
5169 "Append to specified buffer the text of the region.
5170 It is inserted into that buffer before its point.
5172 When calling from a program, give three arguments:
5173 BUFFER (or buffer name), START and END.
5174 START and END specify the portion of the current buffer to be copied."
5181 point)
5192 "Prepend to specified buffer the text of the region.
5193 It is inserted into that buffer after its point.
5195 When calling from a program, give three arguments:
5196 BUFFER (or buffer name), START and END.
5197 START and END specify the portion of the current buffer to be copied."
5206 "Copy to specified buffer the text of the region.
5207 It is inserted into that buffer, replacing existing text there.
5209 When calling from a program, give three arguments:
5210 BUFFER (or buffer name), START and END.
5211 START and END specify the portion of the current buffer to be copied."
5219 \f
5223 "Hook run when the mark becomes active.
5224 It is also run at the end of a command, if the mark is active and
5231 "Return this buffer's mark value as integer, or nil if never set.
5233 In Transient Mark mode, this function signals an error if
5234 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5235 or the argument FORCE is non-nil, it disregards whether the mark
5236 is active, and returns an integer or nil in the usual way.
5238 If you are using this in an editing command, you are most likely making
5239 a mistake; see the documentation of `set-mark'."
5244 ;; Behind display-selections-p.
5247 "Deactivate the mark.
5248 If Transient Mark mode is disabled, this function normally does
5249 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5251 Deactivating the mark sets `mark-active' to nil, updates the
5252 primary selection according to `select-active-regions', and runs
5253 `deactivate-mark-hook'.
5255 If Transient Mark mode was temporarily enabled, reset the value
5256 of the variable `transient-mark-mode'; if this causes Transient
5257 Mark mode to be disabled, don't change `mark-active' to nil or
5258 run `deactivate-mark-hook'."
5262 select-active-regions)
5265 ;; The var `saved-region-selection', if non-nil, is the text in
5266 ;; the region prior to the last command modifying the buffer.
5267 ;; Set the selection to that, or to the current region.
5272 ;; If another program has acquired the selection, region
5273 ;; deactivation should not clobber it (Bug#11772).
5292 "Activate the mark.
5293 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5303 "Set this buffer's mark to POS. Don't use this function!
5304 That is to say, don't use this function unless you want
5305 the user to see that the mark has moved, and you want the previous
5306 mark position to be lost.
5308 Normally, when a new mark is set, the old one should go on the stack.
5309 This is why most applications should use `push-mark', not `set-mark'.
5311 Novice Emacs Lisp programmers often try to use the mark for the wrong
5312 purposes. The mark saves a location for the user's convenience.
5313 Most editing commands should not alter the mark.
5314 To remember a location for internal use in the Lisp program,
5315 store it in a Lisp variable. Example:
5317 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5322 ;; Normally we never clear mark-active except in Transient Mark mode.
5323 ;; But when we actually clear out the mark value too, we must
5324 ;; clear mark-active in any mode.
5326 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5327 ;; it should never be nil if the mark is nil.
5335 mark-active))
5342 ;; Mark marker
5348 ;; Mark active
5351 ;; If mark is active now, and either was not active or was at a
5352 ;; different place, run the activate hook.
5357 ;; If mark has ceased to be active, run deactivate hook.
5362 "Like `save-excursion', but also save and restore the mark state.
5363 This macro does what `save-excursion' did before Emacs 25.1."
5373 If nil, region-aware commands treat the empty region as inactive.
5374 If non-nil, region-aware commands treat the region as active as
5375 long as the mark is active, even if the region is empty.
5377 Region-aware commands are those that act on the region if it is
5378 active and Transient Mark mode is enabled, and on the text near
5379 point otherwise."
5385 "Return t if the region is active and it is appropriate to act on it.
5386 This is used by commands that act specially on the region under
5387 Transient Mark mode.
5389 The return value is t if Transient Mark mode is enabled and the
5390 mark is active; furthermore, if `use-empty-active-region' is nil,
5391 the region must not be empty. Otherwise, the return value is nil.
5393 For some commands, it may be appropriate to ignore the value of
5394 `use-empty-active-region'; in that case, use `region-active-p'."
5399 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5401 Some commands act specially on the region when Transient Mark
5402 mode is enabled. Usually, such commands should use
5403 `use-region-p' instead of this function, because `use-region-p'
5404 also checks the value of `use-empty-active-region'."
5406 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5407 ;; without the mark being set (e.g. bug#17324). We really should fix
5408 ;; that problem, but in the mean time, let's make sure we don't say the
5409 ;; region is active when there's no mark.
5413 "Return non-nil if the region contains several pieces.
5414 An example is a rectangular region handled as a list of
5415 separate contiguous regions for each line."
5428 ;; Normal priority so that a large region doesn't hide all the
5429 ;; overlays within it, but high secondary priority so that if it
5430 ;; ends/starts in the middle of a small overlay, that small overlay
5431 ;; won't hide the region's boundaries.
5433 nrol)
5438 rol)))
5454 start end window rol)))
5457 new))))))
5460 "Hook run just before redisplay.
5461 It is called in each window that is to be redisplayed. It takes one argument,
5462 which is the window that will be redisplayed. When run, the `current-buffer'
5483 "Maximum size of mark ring. Start discarding off end if gets this big."
5491 "Maximum size of global mark ring. \
5492 Start discarding off end if gets this big."
5497 "Jump to mark, and pop a new position for mark off the ring.
5498 \(Does not affect global mark ring)."
5508 "Set mark at where point is.
5509 If no prefix ARG and mark is already set there, just activate it.
5510 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5522 will pop the mark twice, and
5524 will pop the mark three times.
5532 "Set the mark where point is, and activate it; or jump to the mark.
5533 Setting the mark also alters the region, which is the text
5534 between point and mark; this is the closest equivalent in
5537 With no prefix argument, set the mark at point, and push the
5538 old mark position on local mark ring. Also push the new mark on
5539 global mark ring, if the previous mark was set in another buffer.
5541 When Transient Mark Mode is off, immediately repeating this
5542 command activates `transient-mark-mode' temporarily.
5545 jump to the mark, and set the mark from
5546 position popped off the local mark ring (this does not affect the global
5548 mark ring (see `pop-global-mark').
5550 If `set-mark-command-repeat-pop' is non-nil, repeating
5552 off the local (or global) mark ring and jumps there.
5555 argument, unconditionally set mark where point is, even if
5556 `set-mark-command-repeat-pop' is non-nil.
5558 Novice Emacs Lisp programmers often try to use the mark for the wrong
5559 purposes. See the documentation of `set-mark' for more information."
5579 arg)
5593 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5594 If the last global mark pushed was not in the current buffer,
5595 also push LOCATION on the global mark ring.
5596 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5598 Novice Emacs Lisp programmers often try to use the mark for the wrong
5599 purposes. See the documentation of `set-mark' for more information.
5601 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5608 ;; Now push the mark on the global mark ring.
5611 ;; The last global mark pushed was in this same buffer.
5612 ;; Don't push another one.
5613 nil
5622 nil)
5625 "Pop off mark ring into the buffer's actual mark.
5626 Does not set point. Does nothing if mark ring is empty."
5638 "Put the mark where point is now, and point where the mark is now.
5639 This command works even when the mark is not active,
5640 and it reactivates the mark.
5642 If Transient Mark mode is on, a prefix ARG deactivates the mark
5643 if it is active, and otherwise avoids reactivating it. If
5644 Transient Mark mode is off, a prefix ARG enables Transient Mark
5645 mode temporarily."
5659 nil))
5662 "When non-nil, shifted motion keys activate the mark momentarily.
5664 While the mark is activated in this way, any shift-translated point
5665 motion key extends the region, and if Transient Mark mode was off, it
5666 is temporarily turned on. Furthermore, the mark will be deactivated
5667 by any subsequent point motion key that was not shift-translated, or
5668 by any action that normally deactivates the mark in Transient Mark mode.
5670 See `this-command-keys-shift-translated' for the meaning of
5671 shift-translation."
5676 "Activate/deactivate mark depending on invocation thru shift translation.
5677 This function is called by `call-interactively' when a command
5678 with a `^' character in its `interactive' spec is invoked, before
5679 running the command itself.
5681 If `shift-select-mode' is enabled and the command was invoked
5682 through shift translation, set the mark and activate the region
5683 temporarily, unless it was already set in this way. See
5684 `this-command-keys-shift-translated' for the meaning of shift
5685 translation.
5687 Otherwise, if the region has been activated temporarily,
5688 deactivate it, and restore the variable `transient-mark-mode' to
5689 its earlier value."
5696 transient-mark-mode)))
5705 "Toggle Transient Mark mode.
5706 With a prefix argument ARG, enable Transient Mark mode if ARG is
5707 positive, and disable it otherwise. If called from Lisp, enable
5708 Transient Mark mode if ARG is omitted or nil.
5710 Transient Mark mode is a global minor mode. When enabled, the
5711 region is highlighted with the `region' face whenever the mark
5713 and after certain other operations that set the mark but whose
5714 main purpose is something else--for example, incremental search,
5720 Many commands change their behavior when Transient Mark mode is
5721 in effect and the mark is active, by acting on the region instead
5722 of their usual default part of the buffer's text. Examples of
5725 To see the documentation of commands which are sensitive to the
5728 :global t
5729 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5733 "Non-nil means it is ok for commands to call `widen' when they want to.
5734 Some commands will do this in order to go to positions outside
5735 the current accessible part of the buffer.
5737 If `widen-automatically' is nil, these commands will do something else
5741 "Whether the currently executing code is performing an essential task.
5742 This variable should be non-nil only when running code which should not
5743 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5744 user for a password when we are simply scanning a set of files in the
5745 background or displaying possible completions before the user even asked
5749 "Pop off global mark ring and jump to the top location."
5751 ;; Pop entries which refer to non-existent buffers.
5769 \f
5771 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5777 "Move cursor vertically down ARG lines.
5778 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5779 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5780 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5781 function will not vscroll.
5783 ARG defaults to 1.
5785 If there is no character in the target line exactly under the current column,
5786 the cursor is positioned after the character in that line which spans this
5787 column, or at the end of the line if it is not long enough.
5788 If there is no line in the buffer after this one, behavior depends on the
5789 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5790 to create a line, and moves the cursor to that line. Otherwise it moves the
5791 cursor to the end of the buffer.
5793 If the variable `line-move-visual' is non-nil, this command moves
5794 by display lines. Otherwise, it moves by buffer lines, without
5795 taking variable-width characters or continued lines into account.
5799 a semipermanent goal column for this command.
5800 Then instead of trying to move exactly vertically (or as close as possible),
5801 this command moves to the specified goal column (or as close as possible).
5802 The goal column is stored in the variable `goal-column', which is nil
5803 when there is no goal column. Note that setting `goal-column'
5804 overrides `line-move-visual' and causes this command to move by buffer
5805 lines rather than by display lines."
5811 ;; When adding a newline, don't expand an abbrev.
5822 nil)
5825 "Move cursor vertically up ARG lines.
5826 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5827 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5828 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5829 function will not vscroll.
5831 ARG defaults to 1.
5833 If there is no character in the target line exactly over the current column,
5834 the cursor is positioned after the character in that line which spans this
5835 column, or at the end of the line if it is not long enough.
5837 If the variable `line-move-visual' is non-nil, this command moves
5838 by display lines. Otherwise, it moves by buffer lines, without
5839 taking variable-width characters or continued lines into account.
5843 a semipermanent goal column for this command.
5844 Then instead of trying to move exactly vertically (or as close as possible),
5845 this command moves to the specified goal column (or as close as possible).
5846 The goal column is stored in the variable `goal-column', which is nil
5847 when there is no goal column. Note that setting `goal-column'
5848 overrides `line-move-visual' and causes this command to move by buffer
5849 lines rather than by display lines."
5860 nil)
5863 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5864 This means moving to the end of each line moved onto.
5865 The beginning of a blank line does not count as the end of a line.
5866 This has no effect when the variable `line-move-visual' is non-nil."
5872 A non-nil setting overrides the variable `line-move-visual', which see."
5879 "Current goal column for vertical motion.
5880 It is the column where point was at the start of the current run
5881 of vertical motion commands.
5883 When moving by visual lines via the function `line-move-visual', it is a cons
5884 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5885 divided by the default column width, and HSCROLL is the number of
5886 columns by which window is scrolled from left margin.
5888 When the `track-eol' feature is doing its job, the value is
5892 "Non-nil means commands that move by lines ignore invisible newlines.
5893 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5894 as if newlines that are invisible didn't exist, and count
5895 only visible newlines. Thus, moving across across 2 newlines
5896 one of which is invisible will be counted as a one-line move.
5897 Also, a non-nil value causes invisible text to be ignored when
5898 counting columns for the purposes of keeping point in the same
5901 Outline mode sets this."
5906 "When non-nil, `line-move' moves point by visual lines.
5907 This movement is based on where the cursor is displayed on the
5908 screen, instead of relying on buffer contents alone. It takes
5909 into account variable-width characters and line continuation.
5910 If nil, `line-move' moves point by logical lines.
5911 A non-nil setting of `goal-column' overrides the value of this variable
5912 and forces movement by logical lines.
5913 A window that is horizontally scrolled also forces movement by logical
5914 lines."
5919 ;; Only used if display-graphic-p.
5923 "Return the height in pixels of the current buffer's default face font.
5925 If the default font is remapped (see `face-remapping-alist'), the
5926 function returns the height of the remapped face."
5930 ;; Avoid calling font-info if the frame's default font was
5931 ;; not changed since the frame was created. That's because
5932 ;; font-info is expensive for some fonts, see bug #14838.
5938 "Return the width in pixels of the current buffer's default face font.
5940 If the default font is remapped (see `face-remapping-alist'), the
5941 function returns the width of the remapped face."
5945 ;; Avoid calling font-info if the frame's default font was
5946 ;; not changed since the frame was created. That's because
5947 ;; font-info is expensive for some fonts, see bug #14838.
5952 width
5957 "Return the pixel height of current buffer's default-face text line.
5959 The value includes `line-spacing', if any, defined for the buffer
5960 or the frame."
5973 "Return the number of screen lines in the text area of the selected window.
5975 This is different from `window-text-height' in that this function counts
5976 lines in units of the height of the font used by the default face displayed
5977 in the window, not in units of the frame's default font, and also accounts
5978 for `line-spacing', if any, defined for the window's buffer or frame.
5980 The value is a floating-point number."
5985 ;; Returns non-nil if partial move was done.
5988 ;; Move backward (up).
5989 ;; If already vscrolled, reduce vscroll
5995 ;; Move forward (down).
6008 py vs last-line)
6028 col-row)
6033 ;; VPOS > 0 means the last line is only partially visible.
6034 ;; But if the part that is visible is at least as tall as the
6035 ;; default font, that means the line is actually fully
6036 ;; readable, and something like line-spacing is hidden. So in
6037 ;; that case we accept the last line in the window as still
6038 ;; visible, and consider the margin as starting one line
6039 ;; later.
6047 ;; If last line of window is fully visible, and vscrolling
6048 ;; more would make this line invisible, move forward.
6053 nil)
6054 ;; If cursor is not in the bottom scroll margin, and the
6055 ;; current line is is not too tall, move forward.
6057 vpos
6060 nil)
6061 ;; When already vscrolled, we vscroll some more if we can,
6062 ;; or clear vscroll and move forward at end of tall image.
6067 ;; If cursor just entered the bottom scroll margin, move forward,
6068 ;; but also optionally vscroll one line so redisplay won't recenter.
6072 ;; Don't vscroll if the partially-visible line at window
6073 ;; bottom is not too tall (a.k.a. "just one more text
6074 ;; line"): in that case, we do want redisplay to behave
6075 ;; normally, i.e. recenter or whatever.
6076 ;;
6077 ;; Note: ROWH + RBOT from the value returned by
6078 ;; pos-visible-in-window-p give the total height of the
6079 ;; partially-visible glyph row at the end of the window. As
6080 ;; we are dealing with floats, we disregard sub-pixel
6081 ;; discrepancies between that and DLH.
6085 t)
6086 ;; If there are lines above the last line, scroll-up one line.
6089 t)
6090 ;; Finally, start vscroll.
6095 ;; This is like line-move-1 except that it also performs
6096 ;; vertical scrolling of tall images if appropriate.
6097 ;; That is not really a clean thing to do, since it mixes
6098 ;; scrolling with cursor motion. But so far we don't have
6099 ;; a cleaner solution to the problem of making C-n do something
6100 ;; useful given a tall image.
6102 "Move forward ARG lines.
6103 If NOERROR, don't signal an error if we can't move ARG lines.
6104 TO-END is unused.
6105 TRY-VSCROLL controls whether to vscroll tall lines: if either
6106 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6107 not vscroll."
6111 ;; Only vscroll for single line moves
6113 ;; Under scroll-conservatively, the display engine
6114 ;; does this better.
6116 ;; But don't vscroll in a keyboard macro.
6122 ;; Display-based column are incompatible with goal-column.
6124 ;; When the text in the window is scrolled to the left,
6125 ;; display-based motion doesn't make sense (because each
6126 ;; logical line occupies exactly one screen line).
6128 ;; Likewise when the text _was_ scrolled to the left
6129 ;; when the current run of vertical motion commands
6130 ;; started.
6133 auto-hscroll-mode
6135 (>= temporary-goal-column
6138 ;; If we moved into a tall line, set vscroll to make
6139 ;; scrolling through tall images more smooth.
6143 winh)
6149 nil
6153 ;; Display-based alternative to line-move-1.
6154 ;; Arg says how many lines to move. The value is t if we can move the
6155 ;; specified number of lines.
6157 "Move ARG lines forward.
6158 If NOERROR, don't signal an error if we can't move that many lines."
6161 target-hscroll)
6162 ;; Check if the previous command was a line-motion command, or if
6163 ;; we were called from some other command.
6166 ;; If so, there's no need to reset `temporary-goal-column',
6167 ;; but we may need to hscroll.
6171 ;; Otherwise, we should reset `temporary-goal-column'.
6173 x-pos)
6175 ;; Handle the `overflow-newline-into-fringe' case:
6180 ;; In R2L lines, the X pixel coordinate is measured from the
6181 ;; left edge of the window, but columns are still counted
6182 ;; from the logical-order beginning of the line, i.e. from
6183 ;; the right edge in this case. We need to adjust for that.
6189 hscroll)))
6191 ;; When we move beyond the first/last character visible in
6192 ;; the window, posn-at-point will return nil, so we need to
6193 ;; approximate the goal column as below.
6198 ;; vertical-motion can move more than it was asked to if it moves
6199 ;; across display strings with newlines. We don't want to ring
6200 ;; the bell and announce beginning/end of buffer in that case.
6206 temporary-goal-column))
6207 arg))
6208 arg))
6214 temporary-goal-column))
6215 arg))
6216 arg)))
6219 ;; If the goal column lies on a display string,
6220 ;; `vertical-motion' advances the cursor to the end
6221 ;; of the string. For arg < 0, this can cause the
6222 ;; cursor to get stuck. (Bug#3020).
6226 nil)))))
6228 ;; This is the guts of next-line and previous-line.
6229 ;; Arg says how many lines to move.
6230 ;; The value is t if we can move the specified number of lines.
6232 ;; Don't run any point-motion hooks, and disregard intangibility,
6233 ;; for intermediate positions.
6245 ;; Don't count beg of empty line as end of line
6246 ;; unless we just did explicit end-of-line.
6248 most-positive-fixnum
6252 line-move-ignore-invisible))
6253 ;; Use just newline characters.
6254 ;; Set ARG to 0 if we move as many lines as requested.
6257 ;; This way of moving forward ARG lines
6258 ;; verifies that we have a newline after the last one.
6259 ;; It doesn't get confused by intangible text.
6268 'beginning-of-buffer
6270 nil)))
6271 ;; Move by arg lines, but ignore invisible ones.
6274 ;; If the following character is currently invisible,
6275 ;; skip all characters with that same `invisible' property value.
6278 ;; Move a line.
6279 ;; We don't use `end-of-line', since we want to escape
6280 ;; from field boundaries occurring exactly at point.
6286 ;; If there's no invisibility here, move over the newline.
6295 ;; We avoid vertical-motion when possible
6296 ;; because that has to fontify.
6298 ;; Otherwise move a more sophisticated way.
6305 ;; The logic of this is the same as the loop above,
6306 ;; it just goes in the other direction.
6308 ;; For completely consistency with the forward-motion
6309 ;; case, we should call beginning-of-line here.
6310 ;; However, if point is inside a field and on a
6311 ;; continued line, the call to (vertical-motion -1)
6312 ;; below won't move us back far enough; then we return
6313 ;; to the same column in line-move-finish, and point
6314 ;; gets stuck -- cyd
6332 ;; if our target is the middle of this line.
6337 ;; This is the value the function returns.
6341 ;; If we did not move down as far as desired, at least go
6342 ;; to end of line. Be sure to call point-entered and
6343 ;; point-left-hooks.
6349 ;; If we did not move up as far as desired,
6350 ;; at least go to beginning of line.
6362 ;; Set REPEAT to t to repeat the whole thing.
6369 ;; Compute the end of the line
6370 ;; ignoring effectively invisible newlines.
6372 ;; Like end-of-line but ignores fields.
6379 ;; Move to the desired column.
6382 ;; Corner case: suppose we start out in a field boundary in
6383 ;; the middle of a continued line. When we get to
6384 ;; line-move-finish, point is at the start of a new *screen*
6385 ;; line but the same text line; then line-move-to-column would
6386 ;; move us backwards. Test using C-n with point on the "x" in
6387 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6394 ;; Process intangibility within a line.
6395 ;; With inhibit-point-motion-hooks bound to nil, a call to
6396 ;; goto-char moves point past intangible text.
6398 ;; However, inhibit-point-motion-hooks controls both the
6399 ;; intangibility and the point-entered/point-left hooks. The
6400 ;; following hack avoids calling the point-* hooks
6401 ;; unnecessarily. Note that we move *forward* past intangible
6402 ;; text when the initial and final points are the same.
6407 ;; If intangibility moves us to a different (later) place
6408 ;; in the same line, use that as the destination.
6411 ;; If that position is "too late",
6412 ;; try the previous allowable position.
6413 ;; See if it is ok.
6416 ;; If going forward, don't accept the previous
6417 ;; allowable position if it is before the target line.
6419 ;; If going backward, don't accept the previous
6420 ;; allowable position if it is still after the target line.
6423 ;; As a last resort, use the end of the line.
6426 ;; Now move to the updated destination, processing fields
6427 ;; as well as intangibility.
6431 ;; Ignore field boundaries if the initial and final
6432 ;; positions have the same `field' property, even if the
6433 ;; fields are non-contiguous. This seems to be "nicer"
6434 ;; behavior in many situations.
6437 new
6441 ;; If all this moved us to a different line,
6442 ;; retry everything within that new line.
6444 ;; Repeat the intangibility and field processing.
6448 "Try to find column COL, considering invisibility.
6449 This function works only in certain cases,
6450 because what we really need is for `move-to-column'
6451 and `current-column' to be able to ignore invisible text."
6460 ;; If the following character is currently invisible,
6461 ;; skip all characters with that same `invisible' property value.
6465 ;; Have we advanced to a larger column position?
6467 ;; We have made some progress towards the desired column.
6468 ;; See if we can make any further progress.
6470 ;; Otherwise, go to the place we originally found
6471 ;; and move back over invisible text.
6472 ;; that will get us to the same place on the screen
6473 ;; but with a more reasonable buffer position.
6476 ;; We want the real line beginning, so it's consistent
6477 ;; with bolp below, otherwise we might infloop.
6484 "Move point to end of current line as displayed.
6485 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6486 If point reaches the beginning or end of buffer, it stops there.
6488 To ignore the effects of the `intangible' text or overlay
6489 property, bind `inhibit-point-motion-hooks' to t.
6490 If there is an image in the current line, this function
6491 disregards newlines that are part of the text on which the image
6492 rests."
6502 ;; With bidi reordering, we may not be at bol,
6503 ;; so make sure we are.
6518 ;; If we skipped something intangible and now we're not
6519 ;; really at eol, keep going.
6524 "Move point to beginning of current line as displayed.
6525 \(If there's an image in the line, this disregards newlines
6526 which are part of the text that the image rests on.)
6528 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6529 If point reaches the beginning or end of buffer, it stops there.
6530 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6535 first-vis first-vis-field-value)
6537 ;; Move by lines, if ARG is not 1 (the default).
6542 ;; Move to beginning-of-line, ignoring fields and invisible text.
6548 ;; Now find first visible char in the line.
6553 ;; See if fields would stop us from reaching FIRST-VIS.
6558 ;; If yes, obey them.
6559 first-vis-field-value
6560 ;; Otherwise, move to START with attention to fields.
6561 ;; (It is possible that fields never matter in this case.)
6566 ;; Many people have said they rarely use this feature, and often type
6567 ;; it by accident. Maybe it shouldn't even be on a key.
6572 Those commands will move to this position in the line moved to
6573 rather than trying to keep the same horizontal position.
6574 With a non-nil argument ARG, clears out the goal column
6576 The goal column is stored in the variable `goal-column'.
6577 This is a buffer-local setting."
6584 ;; The older method below can be erroneous if `set-goal-column' is bound
6585 ;; to a sequence containing %
6586 ;;(message (substitute-command-keys
6587 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6588 ;;goal-column)
6595 )
6596 nil)
6597 \f
6598 ;;; Editing based on visual lines, as opposed to logical lines.
6601 "Move point to end of current visual line.
6602 With argument N not nil or 1, move forward N - 1 visual lines first.
6603 If point reaches the beginning or end of buffer, it stops there.
6604 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6610 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6611 ;; constrain to field boundaries, so we don't either.
6615 "Move point to beginning of current visual line.
6616 With argument N not nil or 1, move forward N - 1 visual lines first.
6617 If point reaches the beginning or end of buffer, it stops there.
6618 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6626 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6630 "Kill the rest of the visual line.
6631 With prefix argument ARG, kill that many visual lines from point.
6632 If ARG is negative, kill visual lines backward.
6633 If ARG is zero, kill the text before point on the current visual
6634 line.
6636 If you want to append the killed line to the last killed text,
6639 If the buffer is read-only, Emacs will beep and refrain from deleting
6640 the line, but put the line in the kill ring anyway. This means that
6641 you can use this command to copy text from a read-only buffer.
6642 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6643 even beep.)"
6645 ;; Like in `kill-line', it's better to move point to the other end
6646 ;; of the kill before killing.
6654 ;; Skip any trailing whitespace at the end of the visual line.
6655 ;; We used to do this only if `show-trailing-whitespace' is
6656 ;; nil, but that's wrong; the correct thing would be to check
6657 ;; whether the trailing whitespace is highlighted. But, it's
6658 ;; OK to just do this unconditionally.
6665 "Move cursor vertically down ARG lines.
6666 This is identical to `next-line', except that it always moves
6667 by logical lines instead of visual lines, ignoring the value of
6668 the variable `line-move-visual'."
6675 "Move cursor vertically up ARG lines.
6676 This is identical to `previous-line', except that it always moves
6677 by logical lines instead of visual lines, ignoring the value of
6678 the variable `line-move-visual'."
6685 "Editing based on visual lines."
6694 ;; These keybindings interfere with xterm function keys. Are
6695 ;; there any other suitable bindings?
6696 ;; (define-key map "\M-[" 'previous-logical-line)
6697 ;; (define-key map "\M-]" 'next-logical-line)
6698 map))
6701 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6702 The value should be a list of the form (LEFT RIGHT), where LEFT
6703 and RIGHT are symbols representing the bitmaps to display, to
6704 indicate wrapped lines, in the left and right fringes respectively.
6705 See also `fringe-indicator-alist'.
6706 The default is not to display fringe indicators for wrapped lines.
6707 This variable does not affect fringe indicators displayed for
6708 other purposes."
6723 'continuation
6730 "Toggle visual line based editing (Visual Line mode).
6731 With a prefix argument ARG, enable Visual Line mode if ARG is
6732 positive, and disable it otherwise. If called from Lisp, enable
6733 the mode if ARG is omitted or nil.
6735 When Visual Line mode is enabled, `word-wrap' is turned on in
6736 this buffer, and simple editing commands are redefined to act on
6737 visual lines, not logical lines. See Info node `Visual Line
6738 Mode' for details."
6739 :keymap visual-line-mode-map
6745 ;; Save the local values of some variables, to be restored if
6746 ;; visual-line-mode is turned off.
6748 truncate-partial-width-windows
6749 word-wrap fringe-indicator-alist))
6752 visual-line--saved-state)))
6756 word-wrap t
6757 fringe-indicator-alist
6759 fringe-indicator-alist)))
6773 visual-line-mode turn-on-visual-line-mode)
6775 \f
6777 "Interchange characters around point, moving forward one character.
6778 With prefix arg ARG, effect is to take character before point
6779 and drag it forward past ARG other characters (backward if ARG negative).
6780 If no argument and at end of line, the previous two chars are exchanged."
6788 "Interchange words around point, leaving point at end of them.
6789 With prefix arg ARG, effect is to take word before or around point
6790 and drag it forward past ARG other words (backward if ARG negative).
6791 If ARG is zero, the words around or after point and around or after mark
6792 are interchanged."
6793 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6799 Unlike `transpose-words', point must be between the two sexps and not
6800 in the middle of a sexp to be transposed.
6801 With non-zero prefix arg ARG, effect is to take the sexp before point
6802 and drag it forward past ARG other sexps (backward if ARG is negative).
6803 If ARG is zero, the sexps ending at or after point and at or after mark
6804 are interchanged."
6808 ;; Here we should try to simulate the behavior of
6809 ;; (cons (progn (forward-sexp x) (point))
6810 ;; (progn (forward-sexp (- x)) (point)))
6811 ;; Except that we don't want to rely on the second forward-sexp
6812 ;; putting us back to where we want to be, since forward-sexp-function
6813 ;; might do funny things like infix-precedence.
6818 ;; Jumping over a symbol. We might be inside it, mind you.
6823 ;; Otherwise, we're between sexps. Take a step back before jumping
6824 ;; to make sure we'll obey the same precedence no matter which direction
6825 ;; we're going.
6830 'skip-syntax-forward
6837 "Exchange current line and previous line, leaving point after both.
6838 With argument ARG, takes previous line and moves it past ARG lines.
6839 With argument 0, interchanges line point is in with line mark is in."
6845 ;; Move forward over ARG lines,
6846 ;; but create newlines if necessary.
6853 arg))
6855 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6856 ;; which seems inconsistent with the ARG /= 0 case.
6857 ;; FIXME document SPECIAL.
6859 "Subroutine to do the work of transposing objects.
6860 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6861 moves forward by units of the given object (e.g. forward-sentence,
6862 forward-paragraph). If ARG is zero, exchanges the current object
6863 with the one containing mark. If ARG is an integer, moves the
6864 current object past ARG following (if ARG is positive) or
6865 preceding (if ARG is negative) objects, leaving point after the
6866 current object."
6871 pos1 pos2)
6900 ;; This sequence of insertions attempts to preserve marker
6901 ;; positions at the start and end of the transposed objects.
6915 \f
6917 "Move backward until encountering the beginning of a word.
6918 With argument ARG, do this that many times.
6919 If ARG is omitted or nil, move point backward one word.
6921 The word boundaries are normally determined by the buffer's syntax
6922 table, but `find-word-boundary-function-table', such as set up
6923 by `subword-mode', can change that. If a Lisp program needs to
6924 move by words determined strictly by the syntax table, it should
6925 use `backward-word-strictly' instead."
6930 "Set mark ARG words away from point.
6932 move to with the same argument.
6933 Interactively, if this command is repeated
6934 or (in Transient Mark mode) if the mark is active,
6935 it marks the next ARG words after the ones already marked."
6952 nil t))))
6955 "Kill characters forward until encountering the end of a word.
6956 With argument ARG, do this that many times."
6961 "Kill characters backward until encountering the beginning of a word.
6962 With argument ARG, do this that many times."
6967 "Return the word at or near point, as a string.
6968 The return value includes no text properties.
6970 If optional arg STRICT is non-nil, return nil unless point is
6971 within or adjacent to a word, otherwise look for a word within
6972 point's line. If there is no word anywhere on point's line, the
6973 value is nil regardless of STRICT.
6975 By default, this function treats as a single word any sequence of
6976 characters that have either word or symbol syntax. If optional
6977 arg REALLY-WORD is non-nil, only characters of word syntax can
6978 constitute a word."
6987 ;; Point is neither within nor adjacent to a word.
6989 ;; Look for preceding word in same line.
6992 ;; No preceding word in same line.
6993 ;; Look for following word in same line.
7002 ;; If we found something nonempty, return it as a string.
7005 \f
7007 "String for filling to insert at front of new line, or nil for none."
7009 string)
7015 "Regexp to match lines which should not be auto-filled."
7017 regexp)
7021 "The default value for `normal-auto-fill-function'.
7022 This is the default auto-fill function, some major modes use a different one.
7023 Returns t if it really did any work."
7033 nil ;; Auto-filling not required
7037 ;; Choose a fill-prefix automatically.
7045 ;; Use auto-indentation rather than a guessed empty prefix.
7051 ;; Determine where to split the line.
7064 ;; See whether the place we found is any good.
7068 ;; There is no use breaking at end of line.
7070 ;; It is futile to split at the end of the prefix
7071 ;; since we would just insert the prefix again.
7073 ;; Don't split right after a comment starter
7074 ;; since we would just make another comment starter.
7079 limit t)
7081 ;; No good place to break => stop trying.
7083 ;; Ok, we have a useful place to break the line. Do it.
7085 ;; If point is at the fill-point, do not `save-excursion'.
7086 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7087 ;; point will end up before it rather than after it.
7095 ;; Now do justification, if required
7100 ;; If making the new line didn't reduce the hpos of
7101 ;; the end of the line, then give up now;
7102 ;; trying again will not help.
7105 ;; Justify last line.
7107 t)))
7110 "Mode-specific function which line breaks and continues a comment.
7111 This function is called during auto-filling when a comment syntax
7112 is defined.
7113 The function should take a single optional argument, which is a flag
7117 "Break line at point and indent.
7118 If a comment syntax is defined, call `comment-indent-new-line'.
7120 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7121 unless optional argument SOFT is non-nil."
7125 ;; Insert the newline before removing empty space so that markers
7126 ;; get preserved better.
7132 ;; Blindly trust a non-adaptive fill-prefix.
7138 ;; If there's an adaptive prefix, use it unless we're inside
7139 ;; a comment and the prefix is not a comment starter.
7143 ;; If we're not inside a comment, just try to indent.
7147 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7151 ;; `functions' and `hooks' are usually unsafe to set, but setting
7152 ;; auto-fill-function to nil in a file-local setting is safe and
7153 ;; can be useful to prevent auto-filling.
7157 "Toggle automatic line breaking (Auto Fill mode).
7158 With a prefix argument ARG, enable Auto Fill mode if ARG is
7159 positive, and disable it otherwise. If called from Lisp, enable
7160 the mode if ARG is omitted or nil.
7162 When Auto Fill mode is enabled, inserting a space at a column
7163 beyond `current-fill-column' automatically breaks the line at a
7164 previous space.
7166 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7167 non-nil.
7169 The value of `normal-auto-fill-function' specifies the function to use
7170 for `auto-fill-function' when turning Auto Fill mode on."
7175 ;; This holds a document string used to document auto-fill-mode.
7177 "Automatically break line at a previous space, in insertion of text."
7178 nil)
7181 "Unconditionally turn on Auto Fill mode."
7185 "Unconditionally turn off Auto Fill mode."
7191 "Set `fill-column' to specified argument.
7196 ;; We used to use current-column silently, but C-x f is too easily
7197 ;; typed as a typo for C-x C-f, so we turned it into an error and
7198 ;; now an interactive prompt.
7203 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7207 \f
7209 "Set `selective-display' to ARG; clear it if no arg.
7210 When the value of `selective-display' is a number > 0,
7211 lines whose indentation is >= that value are not displayed.
7212 The variable `selective-display' has a separate value for each buffer."
7232 "Toggle truncating of long lines for the current buffer.
7233 When truncating is off, long lines are folded.
7234 With prefix argument ARG, truncate long lines if ARG is positive,
7235 otherwise fold them. Note that in side-by-side windows, this
7236 command has no effect if `truncate-partial-width-windows' is
7237 non-nil."
7249 nil t)))
7254 "Toggle whether to use word-wrapping for continuation lines.
7255 With prefix argument ARG, wrap continuation lines at word boundaries
7256 if ARG is positive, otherwise wrap them at the right screen edge.
7257 This command toggles the value of `word-wrap'. It has no effect
7258 if long lines are truncated."
7274 "Toggle Overwrite mode.
7275 With a prefix argument ARG, enable Overwrite mode if ARG is
7276 positive, and disable it otherwise. If called from Lisp, enable
7277 the mode if ARG is omitted or nil.
7279 When Overwrite mode is enabled, printing characters typed in
7280 replace existing text on a one-for-one basis, rather than pushing
7281 it to the right. At the end of a line, such characters extend
7282 the line. Before a tab, such characters insert until the tab is
7284 overwrite mode; this is supposed to make it easier to insert
7285 characters when necessary."
7290 "Toggle Binary Overwrite mode.
7291 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7292 is positive, and disable it otherwise. If called from Lisp,
7293 enable the mode if ARG is omitted or nil.
7295 When Binary Overwrite mode is enabled, printing characters typed
7296 in replace existing text. Newlines are not treated specially, so
7297 typing at the end of a line joins the line to the next, with the
7298 typed character between them. Typing before a tab character
7299 simply replaces the tab with the character typed.
7301 ordinary typing characters do.
7303 Note that Binary Overwrite mode is not its own minor mode; it is
7304 a specialization of overwrite mode, entered by setting the
7305 `overwrite-mode' variable to `overwrite-mode-binary'."
7310 "Toggle line number display in the mode line (Line Number mode).
7311 With a prefix argument ARG, enable Line Number mode if ARG is
7312 positive, and disable it otherwise. If called from Lisp, enable
7313 the mode if ARG is omitted or nil.
7315 Line numbers do not appear for very large buffers and buffers
7316 with very long lines; see variables `line-number-display-limit'
7317 and `line-number-display-limit-width'."
7321 "Toggle column number display in the mode line (Column Number mode).
7322 With a prefix argument ARG, enable Column Number mode if ARG is
7323 positive, and disable it otherwise.
7325 If called from Lisp, enable the mode if ARG is omitted or nil."
7329 "Toggle buffer size display in the mode line (Size Indication mode).
7330 With a prefix argument ARG, enable Size Indication mode if ARG is
7331 positive, and disable it otherwise.
7333 If called from Lisp, enable the mode if ARG is omitted or nil."
7337 "Toggle auto-saving in the current buffer (Auto Save mode).
7338 With a prefix argument ARG, enable Auto Save mode if ARG is
7339 positive, and disable it otherwise.
7341 If called from Lisp, enable the mode if ARG is omitted or nil."
7343 ;; If auto-save is off because buffer has shrunk,
7344 ;; then toggling should turn it on.
7352 buffer-file-name)
7354 ;; If -1 was stored here, to temporarily turn off saving,
7355 ;; turn it back on.
7358 \f
7360 "Blinking matching of parens and expressions."
7365 "Non-nil means show matching open-paren when close-paren is inserted.
7366 If t, highlight the paren. If `jump', briefly move cursor to its
7367 position. If `jump-offscreen', move cursor there even if the
7368 position is off screen. With any other non-nil value, the
7369 off-screen position of the opening paren will be shown in the
7370 echo area."
7379 "Non-nil means show matching open-paren when it is on screen.
7380 If nil, don't show it (but the open-paren can still be shown
7381 in the echo area when it is off screen).
7383 This variable has no effect if `blink-matching-paren' is nil.
7384 \(In that case, the open-paren is never shown.)
7385 It is also ignored if `show-paren-mode' is enabled."
7390 "If non-nil, maximum distance to search backwards for matching open-paren.
7391 If nil, search stops at the beginning of the accessible portion of the buffer."
7397 "Time in seconds to delay after showing a matching paren."
7402 "If nil, `blink-matching-paren' ignores comments.
7403 More precisely, when looking for the matching parenthesis,
7404 it skips the contents of comments that end before point."
7409 "Return whether or not START...END are matching parens.
7410 END is the current point and START is the blink position.
7411 START might be nil if no matching starter was found.
7412 Returns non-nil if we find there is a mismatch."
7417 ;; For self-matched chars like " and $, we can't know when they're
7418 ;; mismatched or unmatched, so we can only do it for parens.
7423 ;; The cdr might hold a new paren-class info rather than
7424 ;; a matching-char info, in which case the two CDRs
7425 ;; should match.
7429 "Function to check parentheses mismatches.
7430 The function takes two arguments (START and END) where START is the
7431 position just before the opening token and END is the position right after.
7432 START can be nil, if it was not found.
7439 ol)
7443 "Momentarily highlight the beginning of the sexp before point."
7446 blink-matching-paren)
7456 oldpos))
7464 ;; backward-sexp skips backward over prefix chars,
7465 ;; so move back to the matching paren.
7488 ;; Matching open within window, temporarily move to or highlight
7489 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7490 ;; is non-nil.
7507 ;; Show what precedes the open in its line, if anything.
7512 ;; Show what follows the open in its line, if anything.
7519 ;; Otherwise show the previous nonblank line,
7520 ;; if there is one.
7529 ;; Replace the newline and other whitespace with `...'.
7530 "..."
7532 ;; There is nothing to show except the char itself.
7535 "Matches %s"
7539 "Function called, if non-nil, whenever a close parenthesis is inserted.
7545 blink-paren-function
7548 ;; Verify an even number of quoting characters precede the close.
7549 ;; FIXME: Also check if this parenthesis closes a comment as
7550 ;; can happen in Pascal and SML.
7561 ;; Most likely, this hook is nil, so this arg doesn't matter,
7562 ;; but I use it as a reminder that this function usually
7563 ;; likes to be run after others since it does
7564 ;; `sit-for'. That's also the reason it get a `priority' prop
7565 ;; of 100.
7567 \f
7568 ;; This executes C-g typed while Emacs is waiting for a command.
7569 ;; Quitting out of a program does not go through here;
7570 ;; that happens in the QUIT macro at the C code level.
7572 "Signal a `quit' condition.
7573 During execution of Lisp code, this character causes a quit directly.
7574 At top-level, as an editor command, this simply beeps."
7576 ;; Avoid adding the region to the window selection.
7584 ;; Force the next redisplay cycle to remove the "Def" indicator from
7585 ;; all the mode lines.
7599 This command can exit an interactive command such as `query-replace',
7600 can clear out a prefix argument or a region,
7601 can get out of the minibuffer or other recursive edit,
7602 cancel the use of the current buffer (for special-purpose buffers),
7603 or go back to just one window (by deleting all but the selected window)."
7611 nil)
7622 "Play sound stored in FILE.
7623 VOLUME and DEVICE correspond to the keywords of the sound
7624 specification for `play-sound'."
7634 \f
7636 "Your preference for a mail reading package.
7637 This is used by some keybindings which support reading mail.
7638 See also `mail-user-agent' concerning sending mail."
7648 "Your preference for a mail composition package.
7649 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7650 outgoing email message. This variable lets you specify which
7651 mail-sending package you prefer.
7653 Valid values include:
7655 `message-user-agent' -- use the Message package.
7656 See Info node `(message)'.
7657 `sendmail-user-agent' -- use the Mail package.
7658 See Info node `(emacs)Sending Mail'.
7659 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7660 See Info node `(mh-e)'.
7661 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7662 paraphernalia if Gnus is running, particularly
7663 the Gcc: header for archiving.
7665 Additional valid symbols may be available; check with the author of
7666 your package for details. The function should return non-nil if it
7667 succeeds.
7669 See also `read-mail-command' concerning reading mail."
7672 message-user-agent)
7675 sendmail-user-agent)
7678 mh-e-user-agent)
7681 gnus-user-agent)
7687 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7688 If the value of `mail-user-agent' is the default, and the user
7689 appears to have customizations applying to the old default,
7690 `compose-mail' issues a warning."
7696 "If the buffer starts with a mail header, move point to the header's end.
7697 Otherwise, moves to `point-min'.
7698 The end of the header is the start of the next line, if there is one,
7699 else the end of the last line. This function obeys RFC822."
7705 ;; Used by Rmail (e.g., rmail-forward).
7707 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7711 switch-function yank-action send-actions
7712 return-action)
7713 "Start composing a mail message to send.
7714 This uses the user's chosen mail composition package
7715 as selected with the variable `mail-user-agent'.
7716 The optional arguments TO and SUBJECT specify recipients
7717 and the initial Subject field, respectively.
7719 OTHER-HEADERS is an alist specifying additional
7720 header fields. Elements look like (HEADER . VALUE) where both
7721 HEADER and VALUE are strings.
7723 CONTINUE, if non-nil, says to continue editing a message already
7724 being composed. Interactively, CONTINUE is the prefix argument.
7726 SWITCH-FUNCTION, if non-nil, is a function to use to
7727 switch to and display the buffer used for mail composition.
7729 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7730 to insert the raw text of the message being replied to.
7731 It has the form (FUNCTION . ARGS). The user agent will apply
7732 FUNCTION to ARGS, to insert the raw text of the original message.
7733 \(The user agent will also run `mail-citation-hook', *after* the
7734 original text has been inserted in this way.)
7736 SEND-ACTIONS is a list of actions to call when the message is sent.
7737 Each action has the form (FUNCTION . ARGS).
7739 RETURN-ACTION, if non-nil, is an action for returning to the
7740 caller. It has the form (FUNCTION . ARGS). The function is
7741 called after the mail has been sent or put aside, and the mail
7742 buffer buried."
7746 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7747 ;; from sendmail-user-agent to message-user-agent. Some users may
7748 ;; encounter incompatibilities. This hack tries to detect problems
7749 ;; and warn about them.
7754 mail-yank-hooks mail-archive-file-name
7755 mail-default-reply-to mail-mailing-lists
7756 mail-self-blind))
7763 The default mail mode is now Message mode.
7764 You have the following Mail mode variable%s customized:
7766 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7773 yank-action send-actions return-action)))
7776 yank-action send-actions
7777 return-action)
7781 'switch-to-buffer-other-window yank-action send-actions
7782 return-action))
7785 yank-action send-actions
7786 return-action)
7790 'switch-to-buffer-other-frame yank-action send-actions
7791 return-action))
7793 \f
7795 "History of values entered with `set-variable'.
7797 Maximum length of the history list is determined by the value
7801 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7802 VARIABLE should be a user option variable name, a Lisp variable
7803 meant to be customized by users. You should enter VALUE in Lisp syntax,
7804 so if you want VALUE to be a string, you must surround it with doublequotes.
7805 VALUE is used literally, not evaluated.
7807 If VARIABLE has a `variable-interactive' property, that is used as if
7808 it were the arg to `interactive' (which see) to interactively read VALUE.
7810 If VARIABLE has been defined with `defcustom', then the type information
7811 in the definition is used to check that VALUE is valid.
7813 Note that this function is at heart equivalent to the basic `set' function.
7814 For a variable defined with `defcustom', it does not pay attention to
7815 any :set property that the variable might have (if you want that, use
7818 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7823 default-var)
7839 var obsolete)
7842 ;; Use VAR's `variable-interactive' property
7843 ;; as an interactive spec for prompting.
7846 arg))
7848 read-expression-map t
7849 'set-variable-value-history
7858 ;; Match with custom type.
7870 ;; Force a thorough redisplay for the case that the variable
7871 ;; has an effect on the display, like `tab-width' has.
7873 \f
7874 ;; Define the major mode for lists of completions.
7884 (define-key map [right] 'next-completion)
7886 (define-key map [backtab] 'previous-completion)
7887 (define-key map "q" 'quit-window)
7888 (define-key map "z" 'kill-this-buffer)
7889 map)
7890 "Local map for completion list buffers.")
7892 ;; Completion mode is suitable only for specially formatted data.
7893 (put 'completion-list-mode 'mode-class 'special)
7895 (defvar completion-reference-buffer nil
7896 "Record the buffer that was current when the completion list was requested.
7897 This is a local variable in the completion list buffer.
7898 Initial value is nil to avoid some compiler warnings.")
7900 (defvar completion-no-auto-exit nil
7901 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7902 This also applies to other functions such as `choose-completion'.")
7904 (defvar completion-base-position nil
7905 "Position of the base of the text corresponding to the shown completions.
7906 This variable is used in the *Completions* buffers.
7907 Its value is a list of the form (START END) where START is the place
7908 where the completion should be inserted and END (if non-nil) is the end
7909 of the text to replace. If END is nil, point is used instead.")
7911 (defvar completion-list-insert-choice-function #'completion--replace
7912 "Function to use to insert the text chosen in *Completions*.
7913 Called with three arguments (BEG END TEXT), it should replace the text
7914 between BEG and END with TEXT. Expected to be set buffer-locally
7915 in the *Completions* buffer.")
7917 (defvar completion-base-size nil
7918 "Number of chars before point not involved in completion.
7919 This is a local variable in the completion list buffer.
7920 It refers to the chars in the minibuffer if completing in the
7921 minibuffer, or in `completion-reference-buffer' otherwise.
7922 Only characters in the field at point are included.
7924 If nil, Emacs determines which part of the tail end of the
7925 buffer's text is involved in completion by comparing the text
7926 directly.")
7927 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7929 (defun delete-completion-window ()
7930 "Delete the completion list window.
7931 Go to the window from which completion was requested."
7932 (interactive)
7933 (let ((buf completion-reference-buffer))
7934 (if (one-window-p t)
7935 (if (window-dedicated-p) (delete-frame))
7936 (delete-window (selected-window))
7937 (if (get-buffer-window buf)
7938 (select-window (get-buffer-window buf))))))
7940 (defun previous-completion (n)
7941 "Move to the previous item in the completion list."
7942 (interactive "p")
7943 (next-completion (- n)))
7945 (defun next-completion (n)
7946 "Move to the next item in the completion list.
7947 With prefix argument N, move N items (negative N means move backward)."
7948 (interactive "p")
7949 (let ((beg (point-min)) (end (point-max)))
7950 (while (and (> n 0) (not (eobp)))
7951 ;; If in a completion, move to the end of it.
7952 (when (get-text-property (point) 'mouse-face)
7953 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7954 ;; Move to start of next one.
7955 (unless (get-text-property (point) 'mouse-face)
7956 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7957 (setq n (1- n)))
7958 (while (and (< n 0) (not (bobp)))
7959 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7960 ;; If in a completion, move to the start of it.
7961 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7962 (goto-char (previous-single-property-change
7963 (point) 'mouse-face nil beg)))
7964 ;; Move to end of the previous completion.
7965 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7966 (goto-char (previous-single-property-change
7967 (point) 'mouse-face nil beg)))
7968 ;; Move to the start of that one.
7969 (goto-char (previous-single-property-change
7970 (point) 'mouse-face nil beg))
7971 (setq n (1+ n))))))
7973 (defun choose-completion (&optional event)
7974 "Choose the completion at point.
7975 If EVENT, use EVENT's position to determine the starting position."
7976 (interactive (list last-nonmenu-event))
7977 ;; In case this is run via the mouse, give temporary modes such as
7978 ;; isearch a chance to turn off.
7979 (run-hooks 'mouse-leave-buffer-hook)
7980 (with-current-buffer (window-buffer (posn-window (event-start event)))
7981 (let ((buffer completion-reference-buffer)
7982 (base-size completion-base-size)
7983 (base-position completion-base-position)
7984 (insert-function completion-list-insert-choice-function)
7985 (choice
7986 (save-excursion
7987 (goto-char (posn-point (event-start event)))
7988 (let (beg end)
7989 (cond
7990 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7991 (setq end (point) beg (1+ (point))))
7992 ((and (not (bobp))
7993 (get-text-property (1- (point)) 'mouse-face))
7994 (setq end (1- (point)) beg (point)))
7995 (t (error "No completion here")))
7996 (setq beg (previous-single-property-change beg 'mouse-face))
7997 (setq end (or (next-single-property-change end 'mouse-face)
7998 (point-max)))
7999 (buffer-substring-no-properties beg end)))))
8001 (unless (buffer-live-p buffer)
8002 (error "Destination buffer is dead"))
8003 (quit-window nil (posn-window (event-start event)))
8005 (with-current-buffer buffer
8006 (choose-completion-string
8007 choice buffer
8008 (or base-position
8009 (when base-size
8010 ;; Someone's using old completion code that doesn't know
8011 ;; about base-position yet.
8012 (list (+ base-size (field-beginning))))
8013 ;; If all else fails, just guess.
8014 (list (choose-completion-guess-base-position choice)))
8015 insert-function)))))
8017 ;; Delete the longest partial match for STRING
8018 ;; that can be found before POINT.
8019 (defun choose-completion-guess-base-position (string)
8020 (save-excursion
8021 (let ((opoint (point))
8022 len)
8023 ;; Try moving back by the length of the string.
8024 (goto-char (max (- (point) (length string))
8025 (minibuffer-prompt-end)))
8026 ;; See how far back we were actually able to move. That is the
8027 ;; upper bound on how much we can match and delete.
8028 (setq len (- opoint (point)))
8029 (if completion-ignore-case
8030 (setq string (downcase string)))
8031 (while (and (> len 0)
8032 (let ((tail (buffer-substring (point) opoint)))
8033 (if completion-ignore-case
8034 (setq tail (downcase tail)))
8035 (not (string= tail (substring string 0 len)))))
8036 (setq len (1- len))
8037 (forward-char 1))
8038 (point))))
8040 (defun choose-completion-delete-max-match (string)
8041 (declare (obsolete choose-completion-guess-base-position "23.2"))
8042 (delete-region (choose-completion-guess-base-position string) (point)))
8044 (defvar choose-completion-string-functions nil
8045 "Functions that may override the normal insertion of a completion choice.
8046 These functions are called in order with three arguments:
8047 CHOICE - the string to insert in the buffer,
8048 BUFFER - the buffer in which the choice should be inserted,
8049 BASE-POSITION - where to insert the completion.
8051 If a function in the list returns non-nil, that function is supposed
8052 to have inserted the CHOICE in the BUFFER, and possibly exited
8053 the minibuffer; no further functions will be called.
8055 If all functions in the list return nil, that means to use
8056 the default method of inserting the completion in BUFFER.")
8058 (defun choose-completion-string (choice &optional
8059 buffer base-position insert-function)
8060 "Switch to BUFFER and insert the completion choice CHOICE.
8061 BASE-POSITION says where to insert the completion.
8062 INSERT-FUNCTION says how to insert the completion and falls
8063 back on `completion-list-insert-choice-function' when nil."
8065 ;; If BUFFER is the minibuffer, exit the minibuffer
8066 ;; unless it is reading a file name and CHOICE is a directory,
8067 ;; or completion-no-auto-exit is non-nil.
8069 ;; Some older code may call us passing `base-size' instead of
8070 ;; `base-position'. It's difficult to make any use of `base-size',
8071 ;; so we just ignore it.
8072 (unless (consp base-position)
8073 (message "Obsolete `base-size' passed to choose-completion-string")
8074 (setq base-position nil))
8076 (let* ((buffer (or buffer completion-reference-buffer))
8077 (mini-p (minibufferp buffer)))
8078 ;; If BUFFER is a minibuffer, barf unless it's the currently
8079 ;; active minibuffer.
8080 (if (and mini-p
8081 (not (and (active-minibuffer-window)
8082 (equal buffer
8083 (window-buffer (active-minibuffer-window))))))
8084 (error "Minibuffer is not active for completion")
8085 ;; Set buffer so buffer-local choose-completion-string-functions works.
8086 (set-buffer buffer)
8087 (unless (run-hook-with-args-until-success
8088 'choose-completion-string-functions
8089 ;; The fourth arg used to be `mini-p' but was useless
8090 ;; (since minibufferp can be used on the `buffer' arg)
8091 ;; and indeed unused. The last used to be `base-size', so we
8092 ;; keep it to try and avoid breaking old code.
8093 choice buffer base-position nil)
8094 ;; This remove-text-properties should be unnecessary since `choice'
8095 ;; comes from buffer-substring-no-properties.
8096 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8097 ;; Insert the completion into the buffer where it was requested.
8098 (funcall (or insert-function completion-list-insert-choice-function)
8099 (or (car base-position) (point))
8100 (or (cadr base-position) (point))
8101 choice)
8102 ;; Update point in the window that BUFFER is showing in.
8103 (let ((window (get-buffer-window buffer t)))
8104 (set-window-point window (point)))
8105 ;; If completing for the minibuffer, exit it with this choice.
8106 (and (not completion-no-auto-exit)
8107 (minibufferp buffer)
8108 minibuffer-completion-table
8109 ;; If this is reading a file name, and the file name chosen
8110 ;; is a directory, don't exit the minibuffer.
8111 (let* ((result (buffer-substring (field-beginning) (point)))
8112 (bounds
8113 (completion-boundaries result minibuffer-completion-table
8114 minibuffer-completion-predicate
8115 "")))
8116 (if (eq (car bounds) (length result))
8117 ;; The completion chosen leads to a new set of completions
8118 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8119 (let ((mini (active-minibuffer-window)))
8120 (select-window mini)
8121 (when minibuffer-auto-raise
8122 (raise-frame (window-frame mini))))
8123 (exit-minibuffer))))))))
8125 (define-derived-mode completion-list-mode nil "Completion List"
8126 "Major mode for buffers showing lists of possible completions.
8128 to select the completion near point.
8129 Or click to select one with the mouse.
8132 (set (make-local-variable 'completion-base-size) nil))
8134 (defun completion-list-mode-finish ()
8135 "Finish setup of the completions buffer.
8136 Called from `temp-buffer-show-hook'."
8137 (when (eq major-mode 'completion-list-mode)
8138 (setq buffer-read-only t)))
8140 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8143 ;; Variables and faces used in `completion-setup-function'.
8145 (defcustom completion-show-help t
8146 "Non-nil means show help message in *Completions* buffer."
8147 :type 'boolean
8148 :version "22.1"
8149 :group 'completion)
8151 ;; This function goes in completion-setup-hook, so that it is called
8152 ;; after the text of the completion list buffer is written.
8153 (defun completion-setup-function ()
8154 (let* ((mainbuf (current-buffer))
8155 (base-dir
8156 ;; FIXME: This is a bad hack. We try to set the default-directory
8157 ;; in the *Completions* buffer so that the relative file names
8158 ;; displayed there can be treated as valid file names, independently
8159 ;; from the completion context. But this suffers from many problems:
8160 ;; - It's not clear when the completions are file names. With some
8161 ;; completion tables (e.g. bzr revision specs), the listed
8162 ;; completions can mix file names and other things.
8163 ;; - It doesn't pay attention to possible quoting.
8164 ;; - With fancy completion styles, the code below will not always
8165 ;; find the right base directory.
8166 (if minibuffer-completing-file-name
8167 (file-name-as-directory
8168 (expand-file-name
8169 (buffer-substring (minibuffer-prompt-end)
8170 (- (point) (or completion-base-size 0))))))))
8171 (with-current-buffer standard-output
8172 (let ((base-size completion-base-size) ;Read before killing localvars.
8173 (base-position completion-base-position)
8174 (insert-fun completion-list-insert-choice-function))
8175 (completion-list-mode)
8176 (set (make-local-variable 'completion-base-size) base-size)
8177 (set (make-local-variable 'completion-base-position) base-position)
8178 (set (make-local-variable 'completion-list-insert-choice-function)
8179 insert-fun))
8180 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8181 (if base-dir (setq default-directory base-dir))
8182 ;; Maybe insert help string.
8183 (when completion-show-help
8184 (goto-char (point-min))
8185 (if (display-mouse-p)
8187 (insert (substitute-command-keys
8191 (add-hook 'completion-setup-hook 'completion-setup-function)
8193 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8194 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8196 (defun switch-to-completions ()
8197 "Select the completion list window."
8198 (interactive)
8199 (let ((window (or (get-buffer-window "*Completions*" 0)
8200 ;; Make sure we have a completions window.
8201 (progn (minibuffer-completion-help)
8202 (get-buffer-window "*Completions*" 0)))))
8203 (when window
8204 (select-window window)
8205 ;; In the new buffer, go to the first completion.
8206 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8207 (when (bobp)
8208 (next-completion 1)))))
8209 \f
8210 ;;; Support keyboard commands to turn on various modifiers.
8212 ;; These functions -- which are not commands -- each add one modifier
8213 ;; to the following event.
8215 (defun event-apply-alt-modifier (_ignore-prompt)
8218 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8219 (defun event-apply-super-modifier (_ignore-prompt)
8222 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8223 (defun event-apply-hyper-modifier (_ignore-prompt)
8226 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8227 (defun event-apply-shift-modifier (_ignore-prompt)
8230 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8231 (defun event-apply-control-modifier (_ignore-prompt)
8234 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8235 (defun event-apply-meta-modifier (_ignore-prompt)
8238 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8240 (defun event-apply-modifier (event symbol lshiftby prefix)
8241 "Apply a modifier flag to event EVENT.
8242 SYMBOL is the name of this modifier, as a symbol.
8243 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8244 PREFIX is the string that represents this modifier in an event type symbol."
8245 (if (numberp event)
8246 (cond ((eq symbol 'control)
8247 (if (and (<= (downcase event) ?z)
8248 (>= (downcase event) ?a))
8249 (- (downcase event) ?a -1)
8250 (if (and (<= (downcase event) ?Z)
8251 (>= (downcase event) ?A))
8252 (- (downcase event) ?A -1)
8253 (logior (lsh 1 lshiftby) event))))
8254 ((eq symbol 'shift)
8255 (if (and (<= (downcase event) ?z)
8256 (>= (downcase event) ?a))
8257 (upcase event)
8258 (logior (lsh 1 lshiftby) event)))
8259 (t
8260 (logior (lsh 1 lshiftby) event)))
8261 (if (memq symbol (event-modifiers event))
8262 event
8263 (let ((event-type (if (symbolp event) event (car event))))
8264 (setq event-type (intern (concat prefix (symbol-name event-type))))
8265 (if (symbolp event)
8266 event-type
8267 (cons event-type (cdr event)))))))
8269 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8270 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8271 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8272 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8273 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8274 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8275 \f
8276 ;;;; Keypad support.
8278 ;; Make the keypad keys act like ordinary typing keys. If people add
8279 ;; bindings for the function key symbols, then those bindings will
8280 ;; override these, so this shouldn't interfere with any existing
8281 ;; bindings.
8283 ;; Also tell read-char how to handle these keys.
8284 (mapc
8285 (lambda (keypad-normal)
8286 (let ((keypad (nth 0 keypad-normal))
8287 (normal (nth 1 keypad-normal)))
8288 (put keypad 'ascii-character normal)
8289 (define-key function-key-map (vector keypad) (vector normal))))
8290 ;; See also kp-keys bound in bindings.el.
8291 '((kp-space ?\s)
8294 (kp-separator ?,)
8295 (kp-equal ?=)
8296 ;; Do the same for various keys that are represented as symbols under
8297 ;; GUIs but naturally correspond to characters.
8298 (backspace 127)
8299 (delete 127)
8302 (clear ?\C-l)
8303 (return ?\C-m)
8304 (escape ?\e)
8305 ))
8306 \f
8307 ;;;;
8308 ;;;; forking a twin copy of a buffer.
8309 ;;;;
8311 (defvar clone-buffer-hook nil
8312 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8314 (defvar clone-indirect-buffer-hook nil
8315 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8317 (defun clone-process (process &optional newname)
8318 "Create a twin copy of PROCESS.
8319 If NEWNAME is nil, it defaults to PROCESS' name;
8320 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8321 If PROCESS is associated with a buffer, the new process will be associated
8322 with the current buffer instead.
8323 Returns nil if PROCESS has already terminated."
8324 (setq newname (or newname (process-name process)))
8326 (setq newname (substring newname 0 (match-beginning 0))))
8327 (when (memq (process-status process) '(run stop open))
8328 (let* ((process-connection-type (process-tty-name process))
8329 (new-process
8330 (if (memq (process-status process) '(open))
8331 (let ((args (process-contact process t)))
8332 (setq args (plist-put args :name newname))
8333 (setq args (plist-put args :buffer
8334 (if (process-buffer process)
8335 (current-buffer))))
8336 (apply 'make-network-process args))
8337 (apply 'start-process newname
8338 (if (process-buffer process) (current-buffer))
8339 (process-command process)))))
8340 (set-process-query-on-exit-flag
8341 new-process (process-query-on-exit-flag process))
8342 (set-process-inherit-coding-system-flag
8343 new-process (process-inherit-coding-system-flag process))
8344 (set-process-filter new-process (process-filter process))
8345 (set-process-sentinel new-process (process-sentinel process))
8346 (set-process-plist new-process (copy-sequence (process-plist process)))
8347 new-process)))
8349 ;; things to maybe add (currently partly covered by `funcall mode'):
8350 ;; - syntax-table
8351 ;; - overlays
8352 (defun clone-buffer (&optional newname display-flag)
8353 "Create and return a twin copy of the current buffer.
8354 Unlike an indirect buffer, the new buffer can be edited
8355 independently of the old one (if it is not read-only).
8356 NEWNAME is the name of the new buffer. It may be modified by
8357 adding or incrementing <N> at the end as necessary to create a
8358 unique buffer name. If nil, it defaults to the name of the
8359 current buffer, with the proper suffix. If DISPLAY-FLAG is
8360 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8361 clone a file-visiting buffer, or a buffer whose major mode symbol
8362 has a non-nil `no-clone' property, results in an error.
8364 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8365 current buffer with appropriate suffix. However, if a prefix
8366 argument is given, then the command prompts for NEWNAME in the
8367 minibuffer.
8369 This runs the normal hook `clone-buffer-hook' in the new buffer
8370 after it has been set up properly in other respects."
8371 (interactive
8372 (progn
8373 (if buffer-file-name
8374 (error "Cannot clone a file-visiting buffer"))
8375 (if (get major-mode 'no-clone)
8376 (error "Cannot clone a buffer in %s mode" mode-name))
8377 (list (if current-prefix-arg
8378 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8379 t)))
8380 (if buffer-file-name
8381 (error "Cannot clone a file-visiting buffer"))
8382 (if (get major-mode 'no-clone)
8383 (error "Cannot clone a buffer in %s mode" mode-name))
8384 (setq newname (or newname (buffer-name)))
8386 (setq newname (substring newname 0 (match-beginning 0))))
8387 (let ((buf (current-buffer))
8388 (ptmin (point-min))
8389 (ptmax (point-max))
8390 (pt (point))
8391 (mk (if mark-active (mark t)))
8392 (modified (buffer-modified-p))
8393 (mode major-mode)
8394 (lvars (buffer-local-variables))
8395 (process (get-buffer-process (current-buffer)))
8396 (new (generate-new-buffer (or newname (buffer-name)))))
8397 (save-restriction
8398 (widen)
8399 (with-current-buffer new
8400 (insert-buffer-substring buf)))
8401 (with-current-buffer new
8402 (narrow-to-region ptmin ptmax)
8403 (goto-char pt)
8404 (if mk (set-mark mk))
8405 (set-buffer-modified-p modified)
8407 ;; Clone the old buffer's process, if any.
8408 (when process (clone-process process))
8410 ;; Now set up the major mode.
8411 (funcall mode)
8413 ;; Set up other local variables.
8414 (mapc (lambda (v)
8415 (condition-case () ;in case var is read-only
8416 (if (symbolp v)
8417 (makunbound v)
8418 (set (make-local-variable (car v)) (cdr v)))
8419 (error nil)))
8420 lvars)
8422 ;; Run any hooks (typically set up by the major mode
8423 ;; for cloning to work properly).
8424 (run-hooks 'clone-buffer-hook))
8425 (if display-flag
8426 ;; Presumably the current buffer is shown in the selected frame, so
8427 ;; we want to display the clone elsewhere.
8428 (let ((same-window-regexps nil)
8429 (same-window-buffer-names))
8430 (pop-to-buffer new)))
8431 new))
8434 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8435 "Create an indirect buffer that is a twin copy of the current buffer.
8437 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8438 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8439 or if not called with a prefix arg, NEWNAME defaults to the current
8440 buffer's name. The name is modified by adding a `<N>' suffix to it
8441 or by incrementing the N in an existing suffix. Trying to clone a
8442 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8443 property results in an error.
8445 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8446 This is always done when called interactively.
8448 Optional third arg NORECORD non-nil means do not put this buffer at the
8449 front of the list of recently selected ones.
8451 Returns the newly created indirect buffer."
8452 (interactive
8453 (progn
8454 (if (get major-mode 'no-clone-indirect)
8455 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8456 (list (if current-prefix-arg
8457 (read-buffer "Name of indirect buffer: " (current-buffer)))
8458 t)))
8459 (if (get major-mode 'no-clone-indirect)
8460 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8461 (setq newname (or newname (buffer-name)))
8463 (setq newname (substring newname 0 (match-beginning 0))))
8464 (let* ((name (generate-new-buffer-name newname))
8465 (buffer (make-indirect-buffer (current-buffer) name t)))
8466 (with-current-buffer buffer
8467 (run-hooks 'clone-indirect-buffer-hook))
8468 (when display-flag
8469 (pop-to-buffer buffer nil norecord))
8470 buffer))
8473 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8474 "Like `clone-indirect-buffer' but display in another window."
8475 (interactive
8476 (progn
8477 (if (get major-mode 'no-clone-indirect)
8478 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8479 (list (if current-prefix-arg
8480 (read-buffer "Name of indirect buffer: " (current-buffer)))
8481 t)))
8482 (let ((pop-up-windows t))
8483 (clone-indirect-buffer newname display-flag norecord)))
8485 \f
8486 ;;; Handling of Backspace and Delete keys.
8488 (defcustom normal-erase-is-backspace 'maybe
8489 "Set the default behavior of the Delete and Backspace keys.
8491 If set to t, Delete key deletes forward and Backspace key deletes
8492 backward.
8494 If set to nil, both Delete and Backspace keys delete backward.
8496 If set to `maybe' (which is the default), Emacs automatically
8497 selects a behavior. On window systems, the behavior depends on
8498 the keyboard used. If the keyboard has both a Backspace key and
8499 a Delete key, and both are mapped to their usual meanings, the
8500 option's default value is set to t, so that Backspace can be used
8501 to delete backward, and Delete can be used to delete forward.
8503 If not running under a window system, customizing this option
8504 accomplishes a similar effect by mapping C-h, which is usually
8505 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8506 via `keyboard-translate'. The former functionality of C-h is
8507 available on the F1 key. You should probably not use this
8508 setting if you don't have both Backspace, Delete and F1 keys.
8510 Setting this variable with setq doesn't take effect. Programmatically,
8511 call `normal-erase-is-backspace-mode' (which see) instead."
8512 :type '(choice (const :tag "Off" nil)
8513 (const :tag "Maybe" maybe)
8514 (other :tag "On" t))
8515 :group 'editing-basics
8516 :version "21.1"
8517 :set (lambda (symbol value)
8518 ;; The fboundp is because of a problem with :set when
8519 ;; dumping Emacs. It doesn't really matter.
8520 (if (fboundp 'normal-erase-is-backspace-mode)
8521 (normal-erase-is-backspace-mode (or value 0))
8522 (set-default symbol value))))
8524 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8525 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8526 (unless frame (setq frame (selected-frame)))
8527 (with-selected-frame frame
8528 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8529 (normal-erase-is-backspace-mode
8530 (if (if (eq normal-erase-is-backspace 'maybe)
8531 (and (not noninteractive)
8532 (or (memq system-type '(ms-dos windows-nt))
8533 (memq window-system '(w32 ns))
8534 (and (memq window-system '(x))
8535 (fboundp 'x-backspace-delete-keys-p)
8536 (x-backspace-delete-keys-p))
8537 ;; If the terminal Emacs is running on has erase char
8538 ;; set to ^H, use the Backspace key for deleting
8539 ;; backward, and the Delete key for deleting forward.
8540 (and (null window-system)
8541 (eq tty-erase-char ?\^H))))
8542 normal-erase-is-backspace)
8543 1 0)))))
8545 (define-minor-mode normal-erase-is-backspace-mode
8546 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8547 With a prefix argument ARG, enable this feature if ARG is
8548 positive, and disable it otherwise. If called from Lisp, enable
8549 the mode if ARG is omitted or nil.
8551 On window systems, when this mode is on, Delete is mapped to C-d
8552 and Backspace is mapped to DEL; when this mode is off, both
8553 Delete and Backspace are mapped to DEL. (The remapping goes via
8554 `local-function-key-map', so binding Delete or Backspace in the
8555 global or local keymap will override that.)
8557 In addition, on window systems, the bindings of C-Delete, M-Delete,
8558 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8559 the global keymap in accordance with the functionality of Delete and
8560 Backspace. For example, if Delete is remapped to C-d, which deletes
8561 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8562 to DEL, which deletes backward, C-Delete is bound to
8563 `backward-kill-word'.
8565 If not running on a window system, a similar effect is accomplished by
8566 remapping C-h (normally produced by the Backspace key) and DEL via
8567 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8568 to C-d; if it's off, the keys are not remapped.
8570 When not running on a window system, and this mode is turned on, the
8571 former functionality of C-h is available on the F1 key. You should
8572 probably not turn on this mode on a text-only terminal if you don't
8573 have both Backspace, Delete and F1 keys.
8575 See also `normal-erase-is-backspace'."
8576 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8577 . (lambda (v)
8578 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8579 (if v 1 0))))
8580 (let ((enabled (eq 1 (terminal-parameter
8581 nil 'normal-erase-is-backspace))))
8583 (cond ((or (memq window-system '(x w32 ns pc))
8584 (memq system-type '(ms-dos windows-nt)))
8585 (let ((bindings
8586 `(([M-delete] [M-backspace])
8587 ([C-M-delete] [C-M-backspace])
8588 ([?\e C-delete] [?\e C-backspace]))))
8590 (if enabled
8591 (progn
8592 (define-key local-function-key-map [delete] [deletechar])
8593 (define-key local-function-key-map [kp-delete] [deletechar])
8594 (define-key local-function-key-map [backspace] [?\C-?])
8595 (dolist (b bindings)
8596 ;; Not sure if input-decode-map is really right, but
8597 ;; keyboard-translate-table (used below) only works
8598 ;; for integer events, and key-translation-table is
8599 ;; global (like the global-map, used earlier).
8600 (define-key input-decode-map (car b) nil)
8601 (define-key input-decode-map (cadr b) nil)))
8602 (define-key local-function-key-map [delete] [?\C-?])
8603 (define-key local-function-key-map [kp-delete] [?\C-?])
8604 (define-key local-function-key-map [backspace] [?\C-?])
8605 (dolist (b bindings)
8606 (define-key input-decode-map (car b) (cadr b))
8607 (define-key input-decode-map (cadr b) (car b))))))
8608 (t
8609 (if enabled
8610 (progn
8611 (keyboard-translate ?\C-h ?\C-?)
8612 (keyboard-translate ?\C-? ?\C-d))
8613 (keyboard-translate ?\C-h ?\C-h)
8614 (keyboard-translate ?\C-? ?\C-?))))
8616 (if (called-interactively-p 'interactive)
8617 (message "Delete key deletes %s"
8618 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8619 "forward" "backward")))))
8620 \f
8621 (defvar vis-mode-saved-buffer-invisibility-spec nil
8622 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8624 (define-minor-mode read-only-mode
8625 "Change whether the current buffer is read-only.
8626 With prefix argument ARG, make the buffer read-only if ARG is
8627 positive, otherwise make it writable. If buffer is read-only
8628 and `view-read-only' is non-nil, enter view mode.
8630 Do not call this from a Lisp program unless you really intend to
8632 possibly enabling or disabling View mode. Also, note that this
8633 command works by setting the variable `buffer-read-only', which
8634 does not affect read-only regions caused by text properties. To
8635 ignore read-only status in a Lisp program (whether due to text
8636 properties or buffer state), bind `inhibit-read-only' temporarily
8637 to a non-nil value."
8638 :variable buffer-read-only
8639 (cond
8640 ((and (not buffer-read-only) view-mode)
8641 (View-exit-and-edit)
8642 (make-local-variable 'view-read-only)
8643 (setq view-read-only t)) ; Must leave view mode.
8644 ((and buffer-read-only view-read-only
8645 ;; If view-mode is already active, `view-mode-enter' is a nop.
8646 (not view-mode)
8647 (not (eq (get major-mode 'mode-class) 'special)))
8648 (view-mode-enter))))
8650 (define-minor-mode visible-mode
8651 "Toggle making all invisible text temporarily visible (Visible mode).
8652 With a prefix argument ARG, enable Visible mode if ARG is
8653 positive, and disable it otherwise. If called from Lisp, enable
8654 the mode if ARG is omitted or nil.
8656 This mode works by saving the value of `buffer-invisibility-spec'
8657 and setting it to nil."
8658 :lighter " Vis"
8659 :group 'editing-basics
8660 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8661 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8662 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8663 (when visible-mode
8664 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8665 buffer-invisibility-spec)
8666 (setq buffer-invisibility-spec nil)))
8667 \f
8668 (defvar messages-buffer-mode-map
8669 (let ((map (make-sparse-keymap)))
8670 (set-keymap-parent map special-mode-map)
8671 (define-key map "g" nil) ; nothing to revert
8672 map))
8674 (define-derived-mode messages-buffer-mode special-mode "Messages"
8677 (defun messages-buffer ()
8679 If it does not exist, create and it switch it to `messages-buffer-mode'."
8680 (or (get-buffer "*Messages*")
8681 (with-current-buffer (get-buffer-create "*Messages*")
8682 (messages-buffer-mode)
8683 (current-buffer))))
8685 \f
8686 ;; Minibuffer prompt stuff.
8688 ;;(defun minibuffer-prompt-modification (start end)
8689 ;; (error "You cannot modify the prompt"))
8690 ;;
8691 ;;
8692 ;;(defun minibuffer-prompt-insertion (start end)
8693 ;; (let ((inhibit-modification-hooks t))
8694 ;; (delete-region start end)
8695 ;; ;; Discard undo information for the text insertion itself
8696 ;; ;; and for the text deletion.above.
8697 ;; (when (consp buffer-undo-list)
8698 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8699 ;; (message "You cannot modify the prompt")))
8700 ;;
8701 ;;
8702 ;;(setq minibuffer-prompt-properties
8703 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8704 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8706 \f
8707 ;;;; Problematic external packages.
8709 ;; rms says this should be done by specifying symbols that define
8710 ;; versions together with bad values. This is therefore not as
8711 ;; flexible as it could be. See the thread:
8712 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8713 (defconst bad-packages-alist
8714 ;; Not sure exactly which semantic versions have problems.
8715 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8717 "The version of `semantic' loaded does not work in Emacs 22.
8718 It can cause constant high CPU load.
8719 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8720 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8721 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8722 ;; provided the `CUA-mode' feature. Since this is no longer true,
8723 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8724 (CUA-mode t nil
8725 "CUA-mode is now part of the standard GNU Emacs distribution,
8726 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8728 You have loaded an older version of CUA-mode which does not work
8729 correctly with this version of Emacs. You should remove the old
8730 version and use the one distributed with Emacs."))
8731 "Alist of packages known to cause problems in this version of Emacs.
8732 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8733 PACKAGE is either a regular expression to match file names, or a
8734 symbol (a feature name), like for `with-eval-after-load'.
8735 SYMBOL is either the name of a string variable, or t. Upon
8736 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8737 warning using STRING as the message.")
8739 (defun bad-package-check (package)
8740 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8741 (condition-case nil
8742 (let* ((list (assoc package bad-packages-alist))
8743 (symbol (nth 1 list)))
8744 (and list
8745 (boundp symbol)
8746 (or (eq symbol t)
8747 (and (stringp (setq symbol (eval symbol)))
8748 (string-match-p (nth 2 list) symbol)))
8749 (display-warning package (nth 3 list) :warning)))
8750 (error nil)))
8752 (dolist (elem bad-packages-alist)
8753 (let ((pkg (car elem)))
8754 (with-eval-after-load pkg
8755 (bad-package-check pkg))))
8757 \f
8758 ;;; Generic dispatcher commands
8760 ;; Macro `define-alternatives' is used to create generic commands.
8761 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8762 ;; that can have different alternative implementations where choosing
8763 ;; among them is exclusively a matter of user preference.
8765 ;; (define-alternatives COMMAND) creates a new interactive command
8766 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8767 ;; Typically, the user will not need to customize this variable; packages
8768 ;; wanting to add alternative implementations should use
8769 ;;
8770 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8772 (defmacro define-alternatives (command &rest customizations)
8773 "Define the new command `COMMAND'.
8775 The argument `COMMAND' should be a symbol.
8777 Running `M-x COMMAND RET' for the first time prompts for which
8778 alternative to use and records the selected command as a custom
8779 variable.
8781 Running `C-u M-x COMMAND RET' prompts again for an alternative
8782 and overwrites the previous choice.
8784 The variable `COMMAND-alternatives' contains an alist with
8785 alternative implementations of COMMAND. `define-alternatives'
8786 does not have any effect until this variable is set.
8788 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8789 `defcustom' keywords and values to add to the declaration of
8790 `COMMAND-alternatives' (typically :group and :version)."
8791 (let* ((command-name (symbol-name command))
8792 (varalt-name (concat command-name "-alternatives"))
8793 (varalt-sym (intern varalt-name))
8794 (varimp-sym (intern (concat command-name "--implementation"))))
8795 `(progn
8797 (defcustom ,varalt-sym nil
8798 ,(format "Alist of alternative implementations for the `%s' command.
8800 Each entry must be a pair (ALTNAME . ALTFUN), where:
8801 ALTNAME - The name shown at user to describe the alternative implementation.
8802 ALTFUN - The function called to implement this alternative."
8803 command-name)
8804 :type '(alist :key-type string :value-type function)
8805 ,@customizations)
8807 (put ',varalt-sym 'definition-name ',command)
8808 (defvar ,varimp-sym nil "Internal use only.")
8810 (defun ,command (&optional arg)
8811 ,(format "Run generic command `%s'.
8812 If used for the first time, or with interactive ARG, ask the user which
8813 implementation to use for `%s'. The variable `%s'
8814 contains the list of implementations currently supported for this command."
8815 command-name command-name varalt-name)
8816 (interactive "P")
8817 (when (or arg (null ,varimp-sym))
8818 (let ((val (completing-read
8819 ,(format-message
8820 "Select implementation for command `%s': "
8821 command-name)
8822 ,varalt-sym nil t)))
8823 (unless (string-equal val "")
8824 (when (null ,varimp-sym)
8825 (message
8826 "Use C-u M-x %s RET`to select another implementation"
8827 ,command-name)
8828 (sit-for 3))
8829 (customize-save-variable ',varimp-sym
8830 (cdr (assoc-string val ,varalt-sym))))))
8831 (if ,varimp-sym
8832 (call-interactively ,varimp-sym)
8833 (message "%s" ,(format-message
8834 "No implementation selected for command `%s'"
8835 command-name)))))))
8837 \f
8838 ;;; Functions for changing capitalization that Do What I Mean
8839 (defun upcase-dwim (arg)
8840 "Upcase words in the region, if active; if not, upcase word at point.
8841 If the region is active, this function calls `upcase-region'.
8842 Otherwise, it calls `upcase-word', with prefix argument passed to it
8843 to upcase ARG words."
8844 (interactive "*p")
8845 (if (use-region-p)
8846 (upcase-region (region-beginning) (region-end))
8847 (upcase-word arg)))
8849 (defun downcase-dwim (arg)
8850 "Downcase words in the region, if active; if not, downcase word at point.
8851 If the region is active, this function calls `downcase-region'.
8852 Otherwise, it calls `downcase-word', with prefix argument passed to it
8853 to downcase ARG words."
8854 (interactive "*p")
8855 (if (use-region-p)
8856 (downcase-region (region-beginning) (region-end))
8857 (downcase-word arg)))
8859 (defun capitalize-dwim (arg)
8860 "Capitalize words in the region, if active; if not, capitalize word at point.
8861 If the region is active, this function calls `capitalize-region'.
8862 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8863 to capitalize ARG words."
8864 (interactive "*p")
8865 (if (use-region-p)
8866 (capitalize-region (region-beginning) (region-end))
8867 (capitalize-word arg)))
8869 \f
8871 (provide 'simple)
8873 ;;; simple.el ends here