| blob | f798cd43847d4ad9320ea35709e18da4fb0fa3d6 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2017 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "If non-nil, output buffer is not erased between shell commands.
42 Also, a non-nil value set the point in the output buffer
43 once the command complete.
44 The value `beg-last-out' set point at the beginning of the output,
45 `end-last-out' set point at the end of the buffer, `save-point'
46 restore the buffer position before the command."
56 "Point position in the output buffer after command complete.
57 It is an alist (BUFFER . POS), where BUFFER is the output
58 buffer, and POS is the point position in BUFFER once the command finish.
62 "Idle time delay before updating various things on the screen.
63 Various Emacs features that update auxiliary information when point moves
64 wait this many seconds after Emacs becomes idle before doing an update."
70 "Killing and yanking commands."
74 "Highlight (un)matching of parens and expressions."
76 \f
77 ;;; next-error support framework
80 "`next-error' support framework."
86 "Face used to highlight next error locus."
91 "Highlighting of locations in selected source buffers.
92 If a number, highlight the locus in `next-error' face for the given time
93 in seconds, or until the next command is executed.
94 If t, highlight the locus until the next command is executed, or until
95 some other locus replaces it.
96 If nil, don't highlight the locus in the source buffer.
97 If `fringe-arrow', indicate the locus by the fringe arrow
98 indefinitely until some other locus replaces it."
107 "Highlighting of locations in `next-error-no-select'.
108 If number, highlight the locus in `next-error' face for given time in seconds.
109 If t, highlight the locus indefinitely until some other locus replaces it.
110 If nil, don't highlight the locus in the source buffer.
111 If `fringe-arrow', indicate the locus by the fringe arrow
112 indefinitely until some other locus replaces it."
121 "Display the line in the visited source file recentered as specified.
122 If non-nil, the value is passed directly to `recenter'."
130 "List of hook functions run by `next-error' after visiting source file."
141 "The most recent `next-error' buffer.
142 A buffer becomes most recent when its compilation, grep, or
147 "Function to use to find the next error in the current buffer.
148 The function is called with 2 parameters:
149 ARG is an integer specifying by how many errors to move.
150 RESET is a boolean which, if non-nil, says to go back to the beginning
151 of the errors before moving.
152 Major modes providing compile-like functionality should set this variable
153 to indicate to `next-error' that this is a candidate buffer and how
158 "Function to use to move to an error locus.
159 It takes two arguments, a buffer position in the error buffer
160 and a buffer position in the error locus buffer.
161 The buffer for the error locus should already be current.
166 &optional avoid-current
167 extra-test-inclusive
168 extra-test-exclusive)
169 "Return non-nil if BUFFER is a `next-error' capable buffer.
170 If AVOID-CURRENT is non-nil, and BUFFER is the current buffer,
171 return nil.
173 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if
174 BUFFER would not normally qualify. If it returns non-nil, BUFFER
175 is considered `next-error' capable, anyway, and the function
176 returns non-nil.
178 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the
179 buffer would normally qualify. If it returns nil, BUFFER is
180 rejected, and the function returns nil."
185 ;; Optionally reject some buffers.
188 t)
189 ;; Optionally accept some other buffers.
194 extra-test-inclusive
195 extra-test-exclusive)
196 "Return a `next-error' capable buffer.
198 If AVOID-CURRENT is non-nil, treat the current buffer
199 as an absolute last resort only.
201 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
202 that normally would not qualify. If it returns t, the buffer
203 in question is treated as usable.
205 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
206 that would normally be considered usable. If it returns nil,
207 that buffer is rejected."
209 ;; 1. If one window on the selected frame displays such buffer, return it.
215 avoid-current
216 extra-test-inclusive extra-test-exclusive)
221 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
224 extra-test-inclusive extra-test-exclusive))
225 next-error-last-buffer)
226 ;; 3. If the current buffer is acceptable, choose it.
228 extra-test-inclusive extra-test-exclusive)
230 ;; 4. Look for any acceptable buffer.
235 extra-test-inclusive extra-test-exclusive)))
238 ;; 5. Use the current buffer as a last resort if it qualifies,
239 ;; even despite AVOID-CURRENT.
242 extra-test-inclusive extra-test-exclusive)
246 ;; 6. Give up.
250 "Visit next `next-error' message and corresponding source code.
252 If all the error messages parsed so far have been processed already,
253 the message buffer is checked for new ones.
255 A prefix ARG specifies how many error messages to move;
256 negative means move back to previous error messages.
258 and start at the first error.
260 The RESET argument specifies that we should restart from the beginning.
263 compilation, grep, or occur buffer. It can also operate on any
265 more generally, on any buffer in Compilation mode or with
266 Compilation Minor mode enabled, or any buffer in which
267 `next-error-function' is bound to an appropriate function.
268 To specify use of a particular buffer for error messages, type
270 in the current frame.
273 runs `next-error-hook' with `run-hooks', and stays with that buffer
274 until you use it in some other buffer which uses Compilation mode
275 or Compilation Minor mode.
277 To control which errors are matched, customize the variable
278 `compilation-error-regexp-alist'."
282 ;; we know here that next-error-function is a valid symbol we can funcall
290 "Visit the source code corresponding to the `next-error' message at point."
292 ;; we know here that next-error-function is a valid symbol we can funcall
303 "Visit previous `next-error' message and corresponding source code.
305 Prefix arg N says how many error messages to move backwards (or
306 forwards, if negative).
313 "Restart at the first error.
314 Visit corresponding source code.
315 With prefix arg N, visit the source code of the Nth error.
321 "Move point to the next error in the `next-error' buffer and highlight match.
322 Prefix arg N says how many error messages to move forwards (or
323 backwards, if negative).
325 select the source buffer."
332 "Move point to the previous error in the `next-error' buffer and highlight match.
333 Prefix arg N says how many error messages to move backwards (or
334 forwards, if negative).
336 select the source buffer."
340 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
344 "Minor mode for compilation, occur and diff modes.
345 With a prefix argument ARG, enable mode if ARG is positive, and
346 disable it otherwise. If called from Lisp, enable mode if ARG is
347 omitted or nil.
348 When turned on, cursor motion in the compilation, grep, occur or diff
349 buffer causes automatic display of the corresponding source code location."
356 ;; Used as a `post-command-hook' by `next-error-follow-mode'
357 ;; for the *Compilation* *grep* and *Occur* buffers.
367 \f
368 ;;;
371 "Major mode not specialized for anything in particular.
372 Other major modes are defined by comparison with this one."
377 ;; Special major modes to view specially formatted data rather than files.
391 map))
395 "Parent major mode from which special major modes should inherit."
398 ;; Making and deleting lines.
401 "Special hook to tell if `self-insert-command' will use the region.
402 It must be called via `run-hook-with-args-until-success' with no arguments.
403 Any `post-self-insert-command' which consumes the region should
404 register a function on this hook so that things like `delete-selection-mode'
411 "Insert a newline, and move to left margin of the new line if it's blank.
412 If option `use-hard-newlines' is non-nil, the newline is marked with the
413 text-property `hard'.
414 With ARG, insert that many newlines.
416 If `electric-indent-mode' is enabled, this indents the final new line
417 that it adds, and reindents the preceding line. To just insert
420 Calls `auto-fill-function' if the current column number is greater
421 than the value of `fill-column' and ARG is nil.
422 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
425 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
426 ;; Set last-command-event to tell self-insert what to insert.
430 ;; Don't auto-fill if we have a numeric argument.
434 ;; Do the rest in post-self-insert-hook, because we want to do it
435 ;; *before* other functions on that hook.
437 ;; We are not going to insert any newlines if arg is
438 ;; non-positive.
441 ;; Mark the newline(s) `hard'.
445 ;; If the newline leaves the previous line blank, and we
446 ;; have a left margin, delete that from the blank line.
454 ;; Indent the line after the newline, except in one case:
455 ;; when we added the newline at the beginning of a line which
456 ;; starts a page.
461 ;; FIXME: For non-interactive uses, many calls actually
462 ;; just want (insert "\n"), so maybe we should do just
463 ;; that, so as to avoid the risk of filling or running
464 ;; abbrevs unexpectedly.
471 ;; We first used let-binding to protect the hook, but that
472 ;; was naive since add-hook affects the symbol-default
473 ;; value of the variable, whereas the let-binding might
474 ;; only protect the buffer-local value.
478 nil)
483 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
489 "Insert a newline and leave point before it.
490 If there is a fill prefix and/or a `left-margin', insert them on
491 the new line if the line would have been blank.
492 With arg N, insert N newlines."
497 ;; Don't expand an abbrev before point.
508 ;; Necessary in case a margin or prefix was inserted.
512 "Split current line, moving portion beyond point vertically down.
513 If the current line starts with `fill-prefix', insert it on the new
514 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
516 When called from Lisp code, ARG may be a prefix string to copy."
521 ;; What prefix should we check for (nil means don't).
525 ;; Does this line start with it?
536 "Join this line to previous and fix up whitespace at join.
537 If there is a fill prefix, delete it from the beginning of this line.
538 With argument, join this line to following line."
545 ;; If the second line started with the fill prefix,
546 ;; delete the prefix.
558 "On blank line, delete all surrounding blank lines, leaving just one.
559 On isolated blank line, delete that one.
560 On nonblank line, delete any immediately following blank lines."
566 ;; Set singleblank if there is just one blank line here.
573 ;; Delete preceding blank lines, and this one too if it's the only one.
582 ;; Delete following blank lines, unless the current line is blank
583 ;; and there are no following blank lines.
592 ;; Handle the special case where point is followed by newline and eob.
593 ;; Delete the line, leaving point at eob.
599 Trailing lines are deleted only if `delete-trailing-whitespace'
600 is called on the entire buffer (rather than an active region)."
606 "Return non-nil if the region contains no read-only text."
611 "Delete trailing whitespace between START and END.
612 If called interactively, START and END are the start/end of the
613 region if the mark is active, or of the buffer's accessible
614 portion if the mark is inactive.
616 This command deletes whitespace characters after the last
617 non-whitespace character in each line between START and END. It
618 does not consider formfeed characters to be whitespace.
620 If this command acts on the entire buffer (i.e. if called
621 interactively with the mark inactive, or called from Lisp with
622 END nil), it also deletes all trailing lines at the end of the
623 buffer if the variable `delete-trailing-lines' is non-nil."
634 ;; Don't delete formfeeds, even if they are considered whitespace.
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.
1708 binding))
1711 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1712 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1713 "Read a command name, then read the arguments and call the command.
1714 To pass a prefix argument to the command you are
1715 invoking, give a prefix argument to `execute-extended-command'."
1717 ;; FIXME: Remember the actual text typed by the user before completion,
1718 ;; so that we don't later on suggest the same shortening.
1723 execute-extended-command--last-typed)))
1724 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1737 ;; Normally `real-this-command' should never be changed, but here we really
1738 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1739 ;; binding" for <cmd>, so the command the user really wanted to run is
1740 ;; `function' and not `execute-extended-command'. The difference is
1741 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1745 ;; If enabled, show which key runs this command.
1746 ;; But first wait, and skip the message if there is input.
1748 ;; If this command displayed something in the echo area;
1749 ;; wait a few seconds, then display our suggestion message.
1750 ;; FIXME: Wait *after* running post-command-hook!
1751 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1752 ;; find a better answer anyway!
1762 ;; There's no binding for CMD. Let's try and find the shortest
1763 ;; string to use in M-x.
1764 ;; FIXME: Can be slow. Cache it maybe?
1771 function
1776 suggest-key-bindings
1780 ;; BEWARE: Called directly from the C code.
1781 "Execute CMD as an editor command.
1782 CMD must be a symbol that satisfies the `commandp' predicate.
1783 Optional second arg RECORD-FLAG non-nil
1784 means unconditionally put this command in the variable `command-history'.
1785 Otherwise, that is done only if an arg is read using the minibuffer.
1786 The argument KEYS specifies the value to use instead of (this-command-keys)
1787 when reading the arguments; if it is nil, (this-command-keys) is used.
1788 The argument SPECIAL, if non-nil, means that this command is executing
1789 a special event, so ignore the prefix argument and don't clear it."
1792 ;; FIXME: This should probably be done around
1793 ;; pre-command-hook rather than here!
1801 disabled-command-function)
1802 ;; FIXME: Weird calling convention!
1812 ;; If requested, place the macro in the command history. For
1813 ;; other sorts of commands, call-interactively takes care of this.
1816 ;; Don't keep command history around forever.
1822 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1830 \f
1832 "Default minibuffer history list.
1833 This is used for all minibuffer input
1834 except when an alternate history list is specified.
1836 Maximum length of the history list is determined by the value
1839 "Control whether history list elements are expressions or strings.
1840 If the value of this variable equals current minibuffer depth,
1841 they are expressions; otherwise they are strings.
1842 \(That convention is designed to do the right thing for
1849 "Text that was in this minibuffer before any history commands.
1850 This is nil if there have not yet been any history commands
1859 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1864 "Minibuffer history variables for which matching should ignore case.
1865 If a history variable is a member of this list, then the
1867 commands ignore case when searching it, regardless of `case-fold-search'."
1872 "Find the previous history element that matches REGEXP.
1873 \(Previous history elements refer to earlier actions.)
1874 With prefix argument N, search for Nth previous match.
1875 If N is negative, find the next or Nth next match.
1876 Normally, history elements are matched case-insensitively if
1877 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1878 makes the search case-sensitive.
1879 See also `minibuffer-history-case-insensitive-variables'."
1883 nil
1884 minibuffer-local-map
1885 nil
1886 'minibuffer-history-search-history
1888 ;; Use the last regexp specified, by default, if input is empty.
1893 regexp)
1903 ;; On some systems, ignore case for file names.
1905 minibuffer-history-case-insensitive-variables)
1906 t
1907 ;; Respect the user's setting for case-fold-search:
1908 case-fold-search)
1909 nil))
1910 prevpos
1911 match-string
1912 match-offset
1919 "No later matching history item"
1940 next-matching-history-element))
1944 "Find the next history element that matches REGEXP.
1945 \(The next history element refers to a more recent action.)
1946 With prefix argument N, search for Nth next match.
1947 If N is negative, find the previous or Nth previous match.
1948 Normally, history elements are matched case-insensitively if
1949 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1950 makes the search case-sensitive."
1954 nil
1955 minibuffer-local-map
1956 nil
1957 'minibuffer-history-search-history
1959 ;; Use the last regexp specified, by default, if input is empty.
1964 regexp)
1971 "Function run by `goto-history-element' before consuming default values.
1972 This is useful to dynamically add more elements to the list of default values
1973 when `goto-history-element' reaches the end of this list.
1974 Before calling this function `goto-history-element' sets the variable
1975 `minibuffer-default-add-done' to t, so it will call this function only
1976 once. In special cases, when this function needs to be called more
1977 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1981 "When nil, add more elements to the end of the list of default values.
1982 The value nil causes `goto-history-element' to add more elements to
1983 the list of defaults when it reaches the end of this list. It does
1989 "Return a list of all completions without the default value.
1990 This function is used to add all elements of the completion table to
1991 the end of the list of defaults just after the default value."
1994 minibuffer-completion-table
1995 minibuffer-completion-predicate)))
2001 "Puts element of the minibuffer history in the minibuffer.
2002 The argument NABS specifies the absolute history position."
2016 elt minibuffer-returned-to-present)
2023 "End of defaults; no next item"
2030 previous-history-element))
2042 minibuffer-default)))
2054 elt))
2058 "Puts next element of the minibuffer history in the minibuffer.
2059 With argument N, it uses the Nth following element."
2065 "Puts previous element of the minibuffer history in the minibuffer.
2066 With argument N, it uses the Nth previous element."
2072 "Move cursor vertically down ARG lines, or to the next history element.
2073 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2074 next element of the minibuffer history in the minibuffer."
2078 ;; Remember the original goal column of possibly multi-line input
2079 ;; excluding the length of the prompt on the first line.
2089 ;; Restore old position since `line-move-visual' moves point to
2090 ;; the end of the line when it fails to go to the next line.
2093 ;; Reset `temporary-goal-column' because a correct value is not
2094 ;; calculated when `next-line' above fails by bumping against
2095 ;; the bottom of the minibuffer (bug#22544).
2097 ;; Restore the original goal column on the last line
2098 ;; of possibly multi-line input.
2106 "Move cursor vertically up ARG lines, or to the previous history element.
2107 When point moves over the top line of multi-line minibuffer, puts ARGth
2108 previous element of the minibuffer history in the minibuffer."
2112 ;; Remember the original goal column of possibly multi-line input
2113 ;; excluding the length of the prompt on the first line.
2123 ;; Restore old position since `line-move-visual' moves point to
2124 ;; the beginning of the line when it fails to go to the previous line.
2127 ;; Reset `temporary-goal-column' because a correct value is not
2128 ;; calculated when `previous-line' above fails by bumping against
2129 ;; the top of the minibuffer (bug#22544).
2131 ;; Restore the original goal column on the first line
2132 ;; of possibly multi-line input.
2138 ;; Put the cursor at the end of the visual line instead of the
2139 ;; logical line, so the next `previous-line-or-history-element'
2140 ;; would move to the previous history element, not to a possible upper
2141 ;; visual line from the end of logical line in `line-move-visual' mode.
2143 ;; Since `end-of-visual-line' puts the cursor at the beginning
2144 ;; of the next visual line, move it one char back to the end
2145 ;; of the first visual line (bug#22544).
2149 "Get next history element which completes the minibuffer before the point.
2150 The contents of the minibuffer after the point are deleted, and replaced
2151 by the new completion."
2157 n)
2158 ;; next-matching-history-element always puts us at (point-min).
2159 ;; Move to the position we were at before changing the buffer contents.
2160 ;; This is still sensible, because the text before point has not changed.
2164 "\
2165 Get previous history element which completes the minibuffer before the point.
2166 The contents of the minibuffer after the point are deleted, and replaced
2167 by the new completion."
2171 ;; For compatibility with the old subr of the same name.
2173 "Return the display width of the minibuffer prompt.
2174 Return 0 if current buffer is not a minibuffer."
2175 ;; Return the width of everything before the field at the end of
2176 ;; the buffer; this should be 0 for normal buffers.
2178 \f
2179 ;; isearch minibuffer history
2186 "Set up a minibuffer for using isearch to search the minibuffer history.
2187 Intended to be added to `minibuffer-setup-hook'."
2199 "Clean up the minibuffer after terminating isearch in the minibuffer."
2204 "Return the proper search function, for isearch in minibuffer history."
2207 ;; Use standard functions to search within minibuffer text
2209 found)
2210 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2211 ;; searching forward. Lazy-highlight calls this lambda with the
2212 ;; bound arg, so skip the minibuffer prompt.
2216 ;; 1. First try searching in the initial minibuffer text
2219 noerror)
2220 ;; 2. If the above search fails, start putting next/prev history
2221 ;; elements in the minibuffer successively, and search the string
2222 ;; in them. Do this only when bound is nil (i.e. not while
2223 ;; lazy-highlighting search strings in the current minibuffer text).
2235 ;; After putting the next/prev history element, search
2236 ;; the string in them again, until next-history-element
2237 ;; or previous-history-element raises an error at the
2238 ;; beginning/end of history.
2241 ;; For backward search, don't search
2242 ;; in the minibuffer prompt
2244 noerror)))
2245 ;; Return point of the new search result
2247 ;; Return nil when next(prev)-history-element fails
2251 "Display the minibuffer history search prompt.
2252 If there are no search errors, this function displays an overlay with
2253 the isearch prompt which replaces the original minibuffer prompt.
2254 Otherwise, it displays the standard isearch message returned from
2255 the function `isearch-message'."
2257 ;; Use standard function `isearch-message' when not in the minibuffer,
2258 ;; or search fails, or has an error (like incomplete regexp).
2259 ;; This function overwrites minibuffer text with isearch message,
2260 ;; so it's possible to see what is wrong in the search string.
2262 ;; Otherwise, put the overlay with the standard isearch prompt over
2263 ;; the initial minibuffer prompt.
2272 ;; And clear any previous isearch message.
2276 "Wrap the minibuffer history search when search fails.
2277 Move point to the first history element for a forward search,
2278 or to the last history element for a backward search."
2279 ;; When `minibuffer-history-isearch-search' fails on reaching the
2280 ;; beginning/end of the history, wrap the search to the first/last
2281 ;; minibuffer history element.
2289 "Save a function restoring the state of minibuffer history search.
2290 Save `minibuffer-history-position' to the additional state parameter
2291 in the search status stack."
2297 "Restore the minibuffer history search state.
2298 Go to the history element by the absolute history position HIST-POS."
2301 \f
2302 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2306 "Table mapping redo records to the corresponding undo one.
2307 A redo record for undo-in-region maps to t.
2317 "Within a run of consecutive undo commands, list remaining to be undone.
2321 "Undo some previous changes.
2322 Repeat this command to undo more changes.
2323 A numeric ARG serves as a repeat count.
2325 In Transient Mark mode when the mark is active, only undo changes within
2327 as an argument limits undo to changes within the current region."
2329 ;; Make last-command indicate for the next command that this was an undo.
2330 ;; That way, another undo will undo more.
2331 ;; If we get to the end of the undo history and get an error,
2332 ;; another undo command will find the undo history empty
2333 ;; and will get another error. To begin undoing the undos,
2334 ;; you must type some other command.
2336 ;; For an indirect buffer, look in the base buffer for the
2337 ;; auto-save data.
2341 message)
2342 ;; If we get an error in undo-start,
2343 ;; the next command should not be a "consecutive undo".
2344 ;; So set `this-command' to something other than `undo'.
2349 ;; If something (a timer or filter?) changed the buffer
2350 ;; since the previous command, don't continue the undo seq.
2354 ;; If the last undo record made was made by undo
2355 ;; it shows nothing else happened in between.
2362 ;; get rid of initial undo boundary
2364 ;; If we got this far, the next command should be a consecutive undo.
2366 ;; Check to see whether we're hitting a redo record, and if
2367 ;; so, ask the user whether she wants to skip the redo/undo pair.
2375 ;; The equiv entry might point to another redo record if we have done
2376 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2384 ;; Record the fact that the just-generated undo records come from an
2385 ;; undo operation--that is, they are redo records.
2386 ;; In the ordinary case (not within a region), map the redo
2387 ;; record to the following undos.
2388 ;; I don't know how to do that in the undo-in-region case.
2390 ;; Strip any leading undo boundaries there might be, like we do
2391 ;; above when checking.
2395 ;; Prevent identity mapping. This can happen if
2396 ;; consecutive nils are erroneously in undo list.
2398 t
2399 pending-undo-list)
2400 undo-equiv-table))
2401 ;; Don't specify a position in the undo record for the undo command.
2402 ;; Instead, undoing this should move point to where the change is.
2421 ;; Record what the current undo list says,
2422 ;; so the next command can tell if the buffer was modified in between.
2426 ;; Display a message announcing success.
2431 "Make BUFFER stop keeping undo information.
2432 No argument or nil as argument means do this for the current buffer."
2438 "Undo some previous changes.
2439 Repeat this command to undo more changes.
2440 A numeric ARG serves as a repeat count.
2441 Contrary to `undo', this will not redo a previous undo."
2446 "Non-nil while performing an undo.
2450 "Undo back N undo-boundaries beyond what was already undone recently.
2451 Call `undo-start' to get ready to undo recent changes,
2452 then call `undo-more' one or more times to undo them."
2457 ;; Note: The following, while pulling elements off
2458 ;; `pending-undo-list' will call primitive change functions which
2459 ;; will push more elements onto `buffer-undo-list'.
2465 "Undo N records from the front of the list LIST.
2466 Return what remains of the list."
2468 ;; This is a good feature, but would make undo-start
2469 ;; unable to do what is expected.
2470 ;;(when (null (car (list)))
2471 ;; ;; If the head of the list is a boundary, it is the boundary
2472 ;; ;; preceding this command. Get rid of it and don't count it.
2473 ;; (setq list (cdr list))))
2476 ;; In a writable buffer, enable undoing read-only text that is
2477 ;; so because of text properties.
2479 ;; Don't let `intangible' properties interfere with undo.
2481 ;; We use oldlist only to check for EQ. ++kfs
2487 ;; Handle an integer by setting point to that value.
2490 ;; Element (t . TIME) records previous modtime.
2491 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2492 ;; UNKNOWN_MODTIME_NSECS.
2494 ;; If this records an obsolete save
2495 ;; (not matching the actual disk file)
2496 ;; then don't mark unmodified.
2504 ;; Element (nil PROP VAL BEG . END) is property change.
2509 ;; Element (BEG . END) means range was inserted.
2511 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2512 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2515 ;; Set point first thing, so that undoing this undo
2516 ;; does not send point back to where it is now.
2519 ;; Element (apply FUN . ARGS) means call FUN to undo.
2523 ;; Long format: (apply DELTA START END FUN . ARGS).
2530 ;; Check that the function did what the entry
2531 ;; said it would do.
2541 ;; Element (STRING . POS) means STRING was deleted.
2547 ;; Check that marker adjustments which were recorded
2548 ;; with the (STRING . POS) record are still valid, ie
2549 ;; the markers haven't moved. We check their validity
2550 ;; before reinserting the string so as we don't need to
2551 ;; mind marker insertion-type.
2559 ;; Insert string and adjust point
2567 ;; Adjust the valid marker adjustments
2571 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2574 next)
2575 ;; Even though these elements are not expected in the undo
2576 ;; list, adjust them to be conservative for the 24.4
2577 ;; release. (Bug#16818)
2584 ;; Make sure an apply entry produces at least one undo entry,
2585 ;; so the test in `undo' for continuing an undo series
2586 ;; will work right.
2591 list)
2593 ;; Deep copy of a list
2595 "Make a copy of undo list LIST."
2601 elt))
2604 "Set `pending-undo-list' to the front of the undo list.
2605 The next call to `undo-more' will undo the most recently made change.
2606 If BEG and END are specified, then only undo elements
2607 that apply to text between BEG and END are used; other undo elements
2608 are ignored. If BEG and END are nil, all undo elements are used."
2614 buffer-undo-list)))
2616 ;; The positions given in elements of the undo list are the positions
2617 ;; as of the time that element was recorded to undo history. In
2618 ;; general, subsequent buffer edits render those positions invalid in
2619 ;; the current buffer, unless adjusted according to the intervening
2620 ;; undo elements.
2621 ;;
2622 ;; Undo in region is a use case that requires adjustments to undo
2623 ;; elements. It must adjust positions of elements in the region based
2624 ;; on newer elements not in the region so as they may be correctly
2625 ;; applied in the current buffer. undo-make-selective-list
2626 ;; accomplishes this with its undo-deltas list of adjustments. An
2627 ;; example undo history from oldest to newest:
2628 ;;
2629 ;; buf pos:
2630 ;; 123456789 buffer-undo-list undo-deltas
2631 ;; --------- ---------------- -----------
2632 ;; aaa (1 . 4) (1 . -3)
2633 ;; aaba (3 . 4) N/A (in region)
2634 ;; ccaaba (1 . 3) (1 . -2)
2635 ;; ccaabaddd (7 . 10) (7 . -3)
2636 ;; ccaabdd ("ad" . 6) (6 . 2)
2637 ;; ccaabaddd (6 . 8) (6 . -2)
2638 ;; | |<-- region: "caab", from 2 to 6
2639 ;;
2640 ;; When the user starts a run of undos in region,
2641 ;; undo-make-selective-list is called to create the full list of in
2642 ;; region elements. Each element is adjusted forward chronologically
2643 ;; through undo-deltas to determine if it is in the region.
2644 ;;
2645 ;; In the above example, the insertion of "b" is (3 . 4) in the
2646 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2647 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2648 ;; . 6) is assessed as in the region and placed in the selective list.
2649 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2650 ;; due to the selected element. The "b" insertion is the only element
2651 ;; fully in the region, so in this example undo-make-selective-list
2652 ;; returns (nil (5 . 6)).
2653 ;;
2654 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2655 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2656 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2657 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2658 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2659 ;;
2660 ;; More interesting is how to adjust the "ddd" insertion due to the
2661 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2662 ;; If the reinsertion was a manual retyping of "ad", then the total
2663 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2664 ;; the reinsertion was due to undo, one might expect the first "d"
2665 ;; character would again be a part of the "ddd" text, meaning its
2666 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2667 ;;
2668 ;; undo-make-selective-list assumes in this situation that "ad" was a
2669 ;; new edit, even if it was inserted because of an undo.
2670 ;; Consequently, if the user undos in region "8 to 10" of the
2671 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2672 ;; "ccaabad", as though the first "d" became detached from the
2673 ;; original "ddd" insertion. This quirk is a FIXME.
2676 "Return a list of undo elements for the region START to END.
2677 The elements come from `buffer-undo-list', but we keep only the
2678 elements inside this region, and discard those outside this
2679 region. The elements' positions are adjusted so as the returned
2680 list can be applied to the current buffer."
2682 ;; A list of position adjusted undo elements in the region.
2684 ;; A list of undo-deltas for out of region undo elements.
2685 undo-deltas
2686 undo-elt)
2694 ;; Don't put two nils together in the list
2698 ;; This is a "was unmodified" element. Keep it
2699 ;; if we have kept everything thus far.
2702 ;; Skip over marker adjustments, instead relying
2703 ;; on finding them after (TEXT . POS) elements
2705 nil)
2708 undo-deltas)))
2713 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2714 ;; kept. primitive-undo may discard them later.
2727 "Determine whether UNDO-ELT falls inside the region START ... END.
2728 If it crosses the edge, we return nil.
2730 Generally this function is not useful for determining
2731 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2732 because markers can be arbitrarily relocated. Instead, pass the
2733 marker adjustment's corresponding (TEXT . POS) element."
2738 t)
2740 nil)
2742 ;; (TEXT . POSITION)
2746 ;; (MARKER . ADJUSTMENT)
2749 ;; (nil PROPERTY VALUE BEG . END)
2754 ;; (BEGIN . END)
2759 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2760 This assumes we have already decided that UNDO-ELT
2761 is not *inside* the region START...END."
2765 ;; (nil PROPERTY VALUE BEG . END)
2770 ;; (BEGIN . END)
2775 "Return adjustment of undo element ELT by the undo DELTAS
2776 list."
2778 ;; POSITION
2781 ;; (BEG . END)
2784 ;; (TEXT . POSITION)
2788 ;; (nil PROPERTY VALUE BEG . END)
2791 ;; (apply DELTA START END FUN . ARGS)
2792 ;; FIXME
2793 ;; All others return same elt
2796 ;; (BEG . END) can adjust to the same positions, commonly when an
2797 ;; insertion was undone and they are out of region, for example:
2798 ;;
2799 ;; buf pos:
2800 ;; 123456789 buffer-undo-list undo-deltas
2801 ;; --------- ---------------- -----------
2802 ;; [...]
2803 ;; abbaa (2 . 4) (2 . -2)
2804 ;; aaa ("bb" . 2) (2 . 2)
2805 ;; [...]
2806 ;;
2807 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2808 ;; undo. Further adjustments to such an element should be the same as
2809 ;; for (TEXT . POSITION) elements. The options are:
2810 ;;
2811 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2812 ;; analogous to marker insertion-type t.
2813 ;;
2814 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2815 ;; marker insertion-type nil.
2816 ;;
2817 ;; There was no strong reason to prefer one or the other, except that
2818 ;; the first is more consistent with prior undo in region behavior.
2820 "Return cons of adjustments to BEG and END by the undo DELTAS
2821 list."
2823 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2828 "Return adjustment of POS by the undo DELTAS list, comparing
2829 with < or <= based on USE-<."
2835 ;; Don't allow pos to become less than the undo-delta
2836 ;; position. This edge case is described in the overview
2837 ;; comments.
2840 ;; Return the first affected buffer position and the delta for an undo element
2841 ;; delta is defined as the change in subsequent buffer positions if we *did*
2842 ;; the undo.
2846 ;; (TEXT . POSITION)
2849 ;; (BEGIN . END)
2855 ;;; Default undo-boundary addition
2856 ;;
2857 ;; This section adds a new undo-boundary at either after a command is
2858 ;; called or in some cases on a timer called after a change is made in
2859 ;; any buffer.
2861 "Describe the cause of the last undo-boundary.
2863 If `explicit', the last boundary was caused by an explicit call to
2864 `undo-boundary', that is one not called by the code in this
2865 section.
2867 If it is equal to `timer', then the last boundary was inserted
2868 by `undo-auto--boundary-timer'.
2870 If it is equal to `command', then the last boundary was inserted
2871 automatically after a command, that is by the code defined in
2872 this section.
2874 If it is equal to a list, then the last boundary was inserted by
2875 an amalgamating command. The car of the list is the number of
2876 times an amalgamating command has been called, and the cdr are the
2880 "Current timer which will run `undo-auto--boundary-timer' or nil.
2885 "Non-nil if `this-command' should be amalgamated.
2886 This variable is set to nil by `undo-auto--boundaries' and is set
2890 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2894 "Return the number of amalgamating last commands or nil.
2895 Amalgamating commands are, by default, either
2896 `self-insert-command' and `delete-char', but can be any command
2897 that calls `undo-auto-amalgamate'."
2901 "Add an `undo-boundary' to the current buffer if needed.
2902 REASON describes the reason that the boundary is being added; see
2903 `undo-auto--last-boundary' for more information."
2913 undo-auto--undoably-changed-buffers)
2914 cause)))))
2917 "Check recently changed buffers and add a boundary if necessary.
2918 REASON describes the reason that the boundary is being added; see
2919 `undo-last-boundary' for more information."
2920 ;; (Bug #23785) All commands should ensure that there is an undo
2921 ;; boundary whether they have changed the current buffer or not.
2931 "Timer which will run `undo--auto-boundary-timer'."
2936 "Ensure that the `undo-auto-boundary-timer' is set."
2942 "List of buffers that have changed recently.
2944 This list is maintained by `undo-auto--undoable-change' and
2945 `undo-auto--boundaries' and can be affected by changes to their
2949 "Add an `undo-boundary' in appropriate buffers."
2954 'amalgamate
2958 "Amalgamate undo if necessary.
2959 This function can be called before an amalgamating command. It
2960 removes the previous `undo-boundary' if a series of such calls
2961 have been made. By default `self-insert-command' and
2962 `delete-char' are the only amalgamating commands, although this
2963 function could be called by any command wishing to have this
2964 behavior."
2969 last-amalgamating-count
2974 ;; Amalgamate all buffers that have changed.
2978 b
2980 ;; The head of `buffer-undo-list' is nil.
2981 ;; `car-safe' doesn't work because
2982 ;; `buffer-undo-list' need not be a list!
2990 "Called after every undoable buffer change."
2993 ;; End auto-boundary section
2996 "Amalgamate changes in change-group since HANDLE.
2997 Remove all undo boundaries between the state of HANDLE and now.
2998 HANDLE is as returned by `prepare-change-group'."
3007 ;; Temporarily truncate the undo log at ELT.
3012 ;; `elt' is still in the log: normal case.
3014 ;; `elt' is not in the log any more, but that's because
3015 ;; the log is "all new", so we should remove all
3016 ;; boundaries from it.
3020 buffer-undo-list
3021 ;; Preserve the undo-boundaries at either ends of the
3022 ;; change-groups.
3024 ;; Reset the modified cons cell ELT to its original content.
3031 "If non-nil ask about discarding undo info for the current command.
3032 Normally, Emacs discards the undo info for the current command if
3033 it exceeds `undo-outer-limit'. But if you set this option
3034 non-nil, it asks in the echo area whether to discard the info.
3035 If you answer no, there is a slight risk that Emacs might crash, so
3036 only do it if you really want to undo the command.
3038 This option is mainly intended for debugging. You have to be
3039 careful if you use it for other purposes. Garbage collection is
3040 inhibited while the question is asked, meaning that Emacs might
3041 leak memory. So you should make sure that you do not wait
3042 excessively long before answering the question."
3048 "If non-nil, an extra level of size that's ok in an undo item.
3049 We don't ask the user about truncating the undo list until the
3050 current item gets bigger than this amount.
3055 ;; When the first undo batch in an undo list is longer than
3056 ;; undo-outer-limit, this function gets called to warn the user that
3057 ;; the undo info for the current command was discarded. Garbage
3058 ;; collection is inhibited around the call, so it had better not do a
3059 ;; lot of consing.
3065 ;; Don't ask the question again unless it gets even bigger.
3066 ;; This applies, in particular, if the user quits from the question.
3067 ;; Such a quit quits out of GC, but something else will call GC
3068 ;; again momentarily. It will call this function again,
3069 ;; but we don't want to ask the question again.
3073 "Buffer `%s' undo info is %d bytes long; discard it? "
3077 t)
3078 nil))
3084 "The undo info was discarded because it exceeded \
3085 `undo-outer-limit'.
3087 This is normal if you executed a command that made a huge change
3088 to the buffer. In that case, to prevent similar problems in the
3089 future, set `undo-outer-limit' to a value that is large enough to
3090 cover the maximum size of normal changes you expect a single
3091 command to make, but not so large that it might exceed the
3092 maximum memory allotted to Emacs.
3094 If you did not execute any such command, the situation is
3095 probably due to a bug and you should report it.
3097 You can disable the popping up of this buffer by adding the entry
3098 \(undo discard-info) to the user option `warning-suppress-types',
3102 t))
3103 \f
3106 ; These are sorted according to the GNU en_US locale.
3149 )
3151 This is used by Shell mode and other parts of Emacs to recognize
3152 password prompts, including prompts in languages other than
3153 English. Different case choices should not be assumed to be
3154 included; callers should bind `case-fold-search' to t."
3160 "History list for some commands that read shell commands.
3162 Maximum length of the history list is determined by the value
3169 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3170 This buffer is used when `shell-command' or `shell-command-on-region'
3171 is run interactively. A value of nil means that output to stderr and
3178 "Return a list of all commands associated with the current file.
3179 This function is used to add all related commands retrieved by `mailcap'
3180 to the end of the list of defaults just after the default value."
3184 minibuffer-default))
3189 commands))
3200 map)
3204 "Read a shell command from the minibuffer.
3205 The arguments are the same as the ones of `read-from-minibuffer',
3206 except READ and KEYMAP are missing and HIST defaults
3207 to `shell-command-history'."
3215 minibuffer-local-shell-command-map
3216 nil
3218 args)))
3221 "What to do when the output buffer is used by another shell command.
3222 This option specifies how to resolve the conflict where a new command
3223 wants to direct its output to the buffer `*Async Shell Command*',
3224 but this buffer is already taken by another running shell command.
3226 The value `confirm-kill-process' is used to ask for confirmation before
3227 killing the already running process and running a new process
3228 in the same buffer, `confirm-new-buffer' for confirmation before running
3229 the command in a new buffer with a name other than the default buffer name,
3230 `new-buffer' for doing the same without confirmation,
3231 `confirm-rename-buffer' for confirmation before renaming the existing
3232 output buffer and running a new command in the default buffer,
3233 `rename-buffer' for doing the same without confirmation."
3235 confirm-kill-process)
3237 confirm-new-buffer)
3239 new-buffer)
3241 confirm-rename-buffer)
3243 rename-buffer))
3248 "Store a buffer position or erase the buffer.
3249 See `shell-command-dont-erase-buffer'."
3251 pos)
3253 ;; Setting buffer-read-only to nil doesn't suffice
3254 ;; if some text has a non-nil read-only property,
3255 ;; which comint sometimes adds for prompts.
3265 shell-command-saved-pos))))
3268 "Set point in BUFFER after command complete.
3269 BUFFER is the output buffer of the command; if nil, then defaults
3270 to the current BUFFER.
3271 Set point to the `cdr' of the element in `shell-command-saved-pos'
3272 whose `car' is BUFFER."
3284 ;; Set point in the window displaying buf, if any; otherwise
3285 ;; display buf temporary in selected frame and set the point.
3290 buf
3295 "Execute string COMMAND asynchronously in background.
3297 Like `shell-command', but adds `&' at the end of COMMAND
3298 to execute it asynchronously.
3300 The output appears in the buffer `*Async Shell Command*'.
3301 That buffer is in shell mode.
3303 You can configure `async-shell-command-buffer' to specify what to do in
3304 case when `*Async Shell Command*' buffer is already taken by another
3305 running shell command. To run COMMAND without displaying the output
3306 in a window you can configure `display-buffer-alist' to use the action
3307 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3309 In Elisp, you will often be better served by calling `start-process'
3310 directly, since it offers more control and does not impose the use of a
3311 shell (with its need to quote arguments)."
3321 current-prefix-arg
3322 shell-command-default-error-buffer))
3328 "Execute string COMMAND in inferior shell; display output, if any.
3329 With prefix argument, insert the COMMAND's output at point.
3331 Interactively, prompt for COMMAND in the minibuffer.
3333 If COMMAND ends in `&', execute it asynchronously.
3334 The output appears in the buffer `*Async Shell Command*'.
3335 That buffer is in shell mode. You can also use
3336 `async-shell-command' that automatically adds `&'.
3338 Otherwise, COMMAND is executed synchronously. The output appears in
3339 the buffer `*Shell Command Output*'. If the output is short enough to
3340 display in the echo area (which is determined by the variables
3341 `resize-mini-windows' and `max-mini-window-height'), it is shown
3342 there, but it is nonetheless available in buffer `*Shell Command
3343 Output*' even though that buffer is not automatically displayed.
3345 To specify a coding system for converting non-ASCII characters
3347 before this command.
3349 Noninteractive callers can specify coding systems by binding
3350 `coding-system-for-read' and `coding-system-for-write'.
3352 The optional second argument OUTPUT-BUFFER, if non-nil,
3353 says to put the output in some other buffer.
3354 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3355 and insert the output there; a non-nil value of
3356 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3357 If OUTPUT-BUFFER is not a buffer and not nil, insert the output
3358 in current buffer after point leaving mark after it.
3359 This cannot be done asynchronously.
3361 If the command terminates without error, but generates output,
3363 the output can be displayed in the echo area or in its buffer.
3364 If the output is short enough to display in the echo area
3365 \(determined by the variable `max-mini-window-height' if
3366 `resize-mini-windows' is non-nil), it is shown there.
3367 Otherwise,the buffer containing the output is displayed.
3371 of the output.
3373 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3374 or buffer name to which to direct the command's standard error output.
3375 If it is nil, error output is mingled with regular output.
3376 In an interactive call, the variable `shell-command-default-error-buffer'
3377 specifies the value of ERROR-BUFFER.
3379 In Elisp, you will often be better served by calling `call-process' or
3380 `start-process' directly, since it offers more control and does not impose
3381 the use of a shell (with its need to quote arguments)."
3392 current-prefix-arg
3393 shell-command-default-error-buffer))
3394 ;; Look for a handler in case default-directory is a remote file name.
3402 ;; Output goes in current buffer.
3408 temporary-file-directory)))
3409 nil)))
3412 ;; We do not use -f for csh; we will not support broken use of
3413 ;; .cshrcs. Even the BSD csh manual says to use
3414 ;; "if ($?prompt) exit" before things which are not useful
3415 ;; non-interactively. Besides, if someone wants their other
3416 ;; aliases for shell commands then they can still have them.
3420 t)
3421 nil shell-command-switch command)
3428 ;; Do no formatting while reading error file,
3429 ;; because that can run a shell command, and we
3430 ;; don't want that to cause an infinite recursion.
3432 ;; Put point after the inserted errors.
3436 ;; This is like exchange-point-and-mark, but doesn't
3437 ;; activate the mark. It is cleaner to avoid activation,
3438 ;; even though the command loop would deactivate the mark
3439 ;; because we inserted text.
3443 ;; Output goes in a separate buffer.
3444 ;; Preserve the match data in case called from a program.
3445 ;; FIXME: It'd be ridiculous for an Elisp function to call
3446 ;; shell-command and assume that it won't mess the match-data!
3449 ;; Command ending with ampersand means asynchronous.
3453 proc)
3454 ;; Remove the ampersand.
3456 ;; Ask the user what to do with already running process.
3461 ;; If will kill a process, query first.
3466 ;; If will create a new buffer, query first.
3473 ;; It will create a new buffer.
3478 ;; If will rename the buffer, query first.
3487 ;; It will rename the buffer.
3497 shell-command-switch command))
3501 ;; Use the comint filter for proper handling of carriage motion
3502 ;; (see `comint-inhibit-carriage-motion'),.
3504 ))
3505 ;; Otherwise, command is executed synchronously.
3507 output-buffer nil error-buffer)))))))
3510 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3511 MESSAGE may be either a string or a buffer.
3513 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3514 for maximum height of the echo area, as defined by `max-mini-window-height'
3515 if `resize-mini-windows' is non-nil.
3517 Returns either the string shown in the echo area, or when a pop-up
3518 buffer is used, the window used to display it.
3520 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3521 name of the buffer used to display it in the case where a pop-up buffer
3522 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3523 string and it is displayed in the echo area, it is not specified whether
3524 the contents are inserted into the buffer anyway.
3526 Optional arguments ACTION and FRAME are as for `display-buffer',
3527 and are only used if a pop-up buffer is displayed."
3529 ;; Trivial case where we can use the echo area
3533 ;; Trivial case where we can just remove single trailing newline
3536 ;; General case
3539 message
3548 0
3552 (<= lines
3556 max-mini-window-height))
3558 max-mini-window-height)
3562 ;; Don't use the echo area if the output buffer is
3563 ;; already displayed in the selected frame.
3565 ;; Echo area
3571 ;; Buffer
3576 ;; We have a sentinel to prevent insertion of a termination message
3577 ;; in the buffer itself, and to set the point in the buffer when
3578 ;; `shell-command-dont-erase-buffer' is non-nil.
3587 &optional output-buffer replace
3588 error-buffer display-error-buffer
3589 region-noncontiguous-p)
3590 "Execute string COMMAND in inferior shell with region as input.
3591 Normally display output (if any) in temp buffer `*Shell Command Output*';
3592 Prefix arg means replace the region with it. Return the exit code of
3593 COMMAND.
3595 To specify a coding system for converting non-ASCII characters
3597 before this command. By default, the input (from the current buffer)
3598 is encoded using coding-system specified by `process-coding-system-alist',
3599 falling back to `default-process-coding-system' if no match for COMMAND
3600 is found in `process-coding-system-alist'.
3602 Noninteractive callers can specify coding systems by binding
3603 `coding-system-for-read' and `coding-system-for-write'.
3605 If the command generates output, the output may be displayed
3606 in the echo area or in a buffer.
3607 If the output is short enough to display in the echo area
3608 \(determined by the variable `max-mini-window-height' if
3609 `resize-mini-windows' is non-nil), it is shown there.
3610 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3611 The output is available in that buffer in both cases.
3613 If there is output and an error, a message about the error
3614 appears at the end of the output.
3616 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3617 command's output. If the value is a buffer or buffer name,
3618 erase that buffer and insert the output there; a non-nil value of
3619 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3620 If the value is nil, use the buffer `*Shell Command Output*'.
3621 Any other non-nil value means to insert the output in the
3622 current buffer after START.
3624 Optional fifth arg REPLACE, if non-nil, means to insert the
3625 output in place of text from START to END, putting point and mark
3626 around it.
3628 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3629 or buffer name to which to direct the command's standard error
3630 output. If nil, error output is mingled with regular output.
3631 When called interactively, `shell-command-default-error-buffer'
3632 is used for ERROR-BUFFER.
3634 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3635 display the error buffer if there were any errors. When called
3636 interactively, this is t."
3640 ;; Do this before calling region-beginning
3641 ;; and region-end, in case subprocess output
3642 ;; relocates them while we are in the minibuffer.
3644 ;; call-interactively recognizes region-beginning and
3645 ;; region-end specially, leaving them in the history.
3647 string
3648 current-prefix-arg
3649 current-prefix-arg
3650 shell-command-default-error-buffer
3651 t
3658 temporary-file-directory)))
3659 nil))
3660 exit-status)
3661 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3664 output)
3668 shell-file-name t t
3669 nil shell-command-switch
3670 command)
3677 ;; Replace specified region with output from command.
3679 ;; Don't muck with mark unless REPLACE says we should.
3686 t)))
3687 ;; It is rude to delete a buffer which the command is not using.
3688 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3689 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3690 ;; (kill-buffer shell-buffer)))
3691 ;; Don't muck with mark unless REPLACE says we should.
3693 ;; No prefix argument: put the output in a temp buffer,
3694 ;; replacing its entire contents.
3702 ;; If the input is the same buffer as the output,
3703 ;; delete everything but the specified region,
3704 ;; then replace that region with the output.
3710 shell-file-name t
3713 t)
3714 nil shell-command-switch
3715 command)))
3716 ;; Clear the output buffer, then run the command with
3717 ;; output there.
3727 buffer))))
3728 ;; Report the output.
3738 ;; There's some output, display it
3742 ;; No output; error?
3749 shell-command-default-error-buffer)
3756 output))
3759 exit-status))
3762 exit-status output))))
3763 ;; Don't kill: there might be useful info in the undo-log.
3764 ;; (kill-buffer buffer)
3765 )))))
3773 ;; Do no formatting while reading error file,
3774 ;; because that can run a shell command, and we
3775 ;; don't want that to cause an infinite recursion.
3777 ;; Put point after the inserted errors.
3782 exit-status))
3785 "Execute shell command COMMAND and return its output as a string."
3788 standard-output
3792 "Process files synchronously in a separate process.
3793 Similar to `call-process', but may invoke a file handler based on
3794 `default-directory'. The current working directory of the
3795 subprocess is `default-directory'.
3797 File names in INFILE and BUFFER are handled normally, but file
3798 names in ARGS should be relative to `default-directory', as they
3799 are passed to the process verbatim. (This is a difference to
3800 `call-process' which does not support file handlers for INFILE
3801 and BUFFER.)
3803 Some file handlers might not support all variants, for example
3804 they might behave as if DISPLAY was nil, regardless of the actual
3805 value passed."
3807 lc stderr-file)
3817 display args)
3823 "Whether a call of `process-file' changes remote files.
3825 By default, this variable is always set to t, meaning that a
3826 call of `process-file' could potentially change any file on a
3827 remote host. When set to nil, a file handler could optimize
3828 its behavior with respect to remote file attribute caching.
3830 You should only ever change this variable with a let-binding;
3834 "Start a program in a subprocess. Return the process object for it.
3836 Similar to `start-process', but may invoke a file handler based on
3837 `default-directory'. See Info node `(elisp)Magic File Names'.
3839 This handler ought to run PROGRAM, perhaps on the local host,
3840 perhaps on a remote host that corresponds to `default-directory'.
3841 In the latter case, the local part of `default-directory' becomes
3842 the working directory of the process.
3844 PROGRAM and PROGRAM-ARGS might be file names. They are not
3845 objects of file handler invocation. File handlers might not
3846 support pty association, if PROGRAM is nil."
3850 \f
3851 ;;;; Process menu
3865 map))
3868 "Major mode for listing the processes called by Emacs."
3881 "Kill process at point in a `list-processes' buffer."
3892 "Recompute the list of processes for the Process List buffer.
3893 Also, delete any process that is exited or signaled."
3907 face link
3909 "Visit buffer `%s'"
3911 follow-link t
3912 process-buffer ,buf
3913 action process-menu-visit-buffer)
3922 "datagram"
3939 tabulated-list-entries))))))
3945 "Display a list of all processes that are Emacs sub-processes.
3946 If optional argument QUERY-ONLY is non-nil, only processes with
3947 the query-on-exit flag set are listed.
3948 Any process listed as exited or signaled is actually eliminated
3949 after the listing is made.
3950 Optional argument BUFFER specifies a buffer to use, instead of
3952 The return value is always nil.
3954 This function lists only processes that were launched by Emacs. To
3955 see other processes running on the system, use `list-system-processes'."
3967 nil)
3968 \f
3969 ;;;; Prefix commands
3975 ;; BEWARE: Called directly from C code.
3976 ;; If the return value is non-nil, it means we are in the middle of
3977 ;; a command with prefix, such as a command invoked with prefix-arg.
3979 prefix-command--last-echo
3988 "Abnormal hook which constructs the description of the current prefix state.
3992 "Update state of prefix commands.
4000 "Pass the current prefix command state to the next command.
4001 Should be called by all prefix commands.
4002 Runs `prefix-command-preserve-state-hook'."
4004 ;; If the current command is a prefix command, we don't want the next (real)
4005 ;; command to have `last-command' set to, say, `universal-argument'.
4012 nil)
4014 ;;;;; The main prefix command.
4016 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
4041 ;; For backward compatibility, minus with no modifiers is an ordinary
4042 ;; command if digits have already been entered.
4072 map)
4080 "Begin a numeric argument for the following command.
4085 multiplies the argument by 4 each time.
4087 which is different in effect from any particular numeric argument.
4095 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
4096 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
4103 arg)))
4107 "Begin a negative numeric argument for the next command.
4117 "Part of the numeric argument for the next command.
4122 last-command-event
4129 ;; Treat -0 as just -, so that -01 will work.
4132 digit))))
4134 \f
4137 "This variable is a wrapper hook around `buffer-substring--filter'.
4143 "Function to perform the filtering in `filter-buffer-substring'.
4144 The function is called with the same 3 arguments (BEG END DELETE)
4145 that `filter-buffer-substring' received. It should return the
4146 buffer substring between BEG and END, after filtering. If DELETE is
4150 "List of filter functions for `buffer-substring--filter'.
4151 Each function must accept a single argument, a string, and return a string.
4152 The buffer substring is passed to the first function in the list,
4153 and the return value of each function is passed to the next.
4154 As a special convention, point is set to the start of the buffer text
4155 being operated on (i.e., the first argument of `buffer-substring--filter')
4161 "Return the buffer substring between BEG and END, after filtering.
4162 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4164 This calls the function that `filter-buffer-substring-function' specifies
4165 \(passing the same three arguments that it received) to do the work,
4166 and returns whatever it does. The default function does no filtering,
4167 unless a hook has been set.
4169 Use `filter-buffer-substring' instead of `buffer-substring',
4170 `buffer-substring-no-properties', or `delete-and-extract-region' when
4171 you want to allow filtering to take place. For example, major or minor
4172 modes can use `filter-buffer-substring-function' to extract characters
4173 that are special to a buffer, and should not be copied into other buffers."
4177 "Default function to use for `filter-buffer-substring-function'.
4178 Its arguments and return value are as specified for `filter-buffer-substring'.
4179 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4180 \(see `with-wrapper-hook' for details about wrapper hooks),
4181 and the abnormal hook `buffer-substring-filters'.
4182 No filtering is done unless a hook says to."
4193 string)))
4198 ;;;; Window system cut and paste hooks.
4201 "Function to call to make a killed region available to other programs.
4202 Most window systems provide a facility for cutting and pasting
4203 text between different programs, such as the clipboard on X and
4204 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4206 This variable holds a function that Emacs calls whenever text is
4207 put in the kill ring, to make the new kill available to other
4208 programs. The function takes one argument, TEXT, which is a
4212 "Function to call to get text cut from other programs.
4213 Most window systems provide a facility for cutting and pasting
4214 text between different programs, such as the clipboard on X and
4215 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4217 This variable holds a function that Emacs calls to obtain text
4218 that other programs have provided for pasting. The function is
4219 called with no arguments. If no other program has provided text
4220 to paste, the function should return nil (in which case the
4221 caller, usually `current-kill', should use the top of the Emacs
4222 kill ring). If another program has provided text to paste, the
4223 function should return that text as a string (in which case the
4224 caller should put this string in the kill ring as the latest
4225 kill).
4227 The function may also return a list of strings if the window
4228 system supports multiple selections. The first string will be
4229 used as the pasted text, but the other will be placed in the kill
4230 ring for easy access via `yank-pop'.
4232 Note that the function should return a string only if a program
4233 other than Emacs has provided a string for pasting; if Emacs
4234 provided the most recent string, the function should return nil.
4235 If it is difficult to tell whether Emacs or some other program
4236 provided the current string, it is probably good enough to return
4237 nil if the string is equal (according to `string=') to the last
4239 \f
4242 ;;;; The kill ring data structure.
4245 "List of killed text sequences.
4246 Since the kill ring is supposed to interact nicely with cut-and-paste
4247 facilities offered by window systems, use of this variable should
4248 interact nicely with `interprogram-cut-function' and
4249 `interprogram-paste-function'. The functions `kill-new',
4250 `kill-append', and `current-kill' are supposed to implement this
4251 interaction; you may want to use them instead of manipulating the kill
4255 "Maximum length of kill ring before oldest elements are thrown away."
4263 "Save clipboard strings into kill ring before replacing them.
4264 When one selects something in another program to paste it into Emacs,
4265 but kills something in Emacs before actually pasting it,
4266 this selection is gone unless this variable is non-nil,
4267 in which case the other program's selection is saved in the `kill-ring'
4274 "Do not add a new string to `kill-ring' if it duplicates the last one.
4275 The comparison is done using `equal-including-properties'."
4281 "Make STRING the latest kill in the kill ring.
4282 Set `kill-ring-yank-pointer' to point to it.
4283 If `interprogram-cut-function' is non-nil, apply it to STRING.
4284 Optional second argument REPLACE non-nil means that STRING will replace
4285 the front of the kill ring, rather than being added to the list.
4287 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4288 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4289 STRING.
4291 When the yank handler has a non-nil PARAM element, the original STRING
4292 argument is not used by `insert-for-yank'. However, since Lisp code
4293 may access and use elements from the kill ring directly, the STRING
4296 ;; Due to text properties such as 'yank-handler that
4297 ;; can alter the contents to yank, comparison using
4298 ;; `equal' is unsafe.
4323 ;; It has been argued that this should work similar to `self-insert-command'
4324 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4326 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4332 "Append STRING to the end of the latest kill in the kill ring.
4333 If BEFORE-P is non-nil, prepend STRING to the kill.
4334 Also removes the last undo boundary in the current buffer,
4335 depending on `kill-append-merge-undo'.
4336 If `interprogram-cut-function' is set, pass the resulting kill to it."
4344 ;; find the next undo boundary
4348 ;; remove this undo boundary
4353 "Whether rotating the kill ring changes the window system selection.
4354 If non-nil, whenever the kill ring is rotated (usually via the
4355 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4356 to copy the new kill to the window system selection."
4362 "Rotate the yanking point by N places, and then return that kill.
4363 If N is zero and `interprogram-paste-function' is set to a
4364 function that returns a string or a list of strings, and if that
4365 function doesn't return nil, then that string (or list) is added
4366 to the front of the kill ring and the string (or first string in
4367 the list) is returned as the latest kill.
4369 If N is not zero, and if `yank-pop-change-selection' is
4370 non-nil, use `interprogram-cut-function' to transfer the
4371 kill at the new yank point into the window system selection.
4373 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4374 move the yanking point; just return the Nth kill forward."
4377 interprogram-paste-function
4381 ;; Disable the interprogram cut function when we add the new
4382 ;; text to the kill ring, so Emacs doesn't try to own the
4383 ;; selection, with identical text.
4393 kill-ring)))
4398 interprogram-cut-function)
4404 ;;;; Commands for manipulating the kill ring.
4407 "Non-nil means don't signal an error for killing read-only text."
4413 This deletes the text from the buffer and saves it in the kill ring.
4417 If you want to append the killed region to the last killed text,
4421 If the previous command was also a kill command,
4422 the text killed this time appends to the text killed last time
4423 to make one entry in the kill ring.
4425 The killed text is filtered by `filter-buffer-substring' before it is
4426 saved in the kill ring, so the actual saved text might be different
4427 from what was killed.
4429 If the buffer is read-only, Emacs will beep and refrain from deleting
4430 the text, but put the text in the kill ring anyway. This means that
4431 you can use the killing commands to copy text from a read-only buffer.
4433 Lisp programs should use this function for killing text.
4434 (To delete text, use `delete-region'.)
4435 Supply two arguments, character positions BEG and END indicating the
4436 stretch of text to be killed. If the optional argument REGION is
4437 non-nil, the function ignores BEG and END, and kills the current
4438 region instead."
4439 ;; Pass mark first, then point, because the order matters when
4440 ;; calling `kill-append'.
4449 ;; Add that string to the kill ring, one way or another.
4456 nil)
4458 ;; The code above failed because the buffer, or some of the characters
4459 ;; in the region, are read-only.
4460 ;; We should beep, in case the user just isn't aware of this.
4461 ;; However, there's no harm in putting
4462 ;; the region's text in the kill ring, anyway.
4464 ;; Set this-command now, so it will be set even if we get an error.
4466 ;; This should barf, if appropriate, and give us the correct error.
4469 ;; Signal an error if the buffer is read-only.
4471 ;; If the buffer isn't read-only, the text is.
4474 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4475 ;; to get two copies of the text when the user accidentally types M-w and
4476 ;; then corrects it with the intended C-w.
4478 "Save the region as if killed, but don't kill it.
4479 In Transient Mark mode, deactivate the mark.
4480 If `interprogram-cut-function' is non-nil, also save the text for a window
4481 system cut and paste.
4483 The copied text is filtered by `filter-buffer-substring' before it is
4484 saved in the kill ring, so the actual saved text might be different
4485 from what was in the buffer.
4487 When called from Lisp, save in the kill ring the stretch of text
4488 between BEG and END, unless the optional argument REGION is
4489 non-nil, in which case ignore BEG and END, and save the current
4490 region instead.
4492 This command's old key binding has been given to `kill-ring-save'."
4493 ;; Pass mark first, then point, because the order matters when
4494 ;; calling `kill-append'.
4504 nil)
4507 "Save the region as if killed, but don't kill it.
4508 In Transient Mark mode, deactivate the mark.
4509 If `interprogram-cut-function' is non-nil, also save the text for a window
4510 system cut and paste.
4512 If you want to append the killed line to the last killed text,
4515 The copied text is filtered by `filter-buffer-substring' before it is
4516 saved in the kill ring, so the actual saved text might be different
4517 from what was in the buffer.
4519 When called from Lisp, save in the kill ring the stretch of text
4520 between BEG and END, unless the optional argument REGION is
4521 non-nil, in which case ignore BEG and END, and save the current
4522 region instead.
4524 This command is similar to `copy-region-as-kill', except that it gives
4525 visual feedback indicating the extent of the region being copied."
4526 ;; Pass mark first, then point, because the order matters when
4527 ;; calling `kill-append'.
4531 ;; This use of called-interactively-p is correct because the code it
4532 ;; controls just gives the user visual feedback.
4537 "Indicate that the region text has been copied interactively.
4538 If the mark is visible in the selected window, blink the cursor
4539 between point and mark if there is currently no active region
4540 highlighting.
4542 If the mark lies outside the selected window, display an
4543 informative message containing a sample of the copied text. The
4544 optional argument MESSAGE-LEN, if non-nil, specifies the length
4545 of this sample text; it defaults to 40."
4548 ;; Inhibit quitting so we can make a quit here
4549 ;; look like a C-g typed as a command.
4552 ;; Swap point-and-mark quickly so as to show the region that
4553 ;; was selected. Don't do it if the region is highlighted.
4556 ;; Swap point and mark.
4560 ;; Swap back.
4563 ;; If user quit, deactivate the mark
4564 ;; as C-g would as a command.
4570 ;; Don't say "killed"; that is misleading.
4577 "Cause following command, if it kills, to add to previous kill.
4578 If the next command kills forward from point, the kill is
4579 appended to the previous killed text. If the command kills
4580 backward, the kill is prepended. Kill commands that act on the
4581 region, such as `kill-region', are regarded as killing forward if
4582 point is after mark, and killing backward if point is before
4583 mark.
4585 If the next command is not a kill command, `append-next-kill' has
4586 no effect.
4588 The argument is used for internal purposes; do not supply one."
4590 ;; We don't use (interactive-p), since that breaks kbd macros.
4604 "A subroutine of `squeeze-bidi-context'.
4605 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4609 lim1)
4616 ;; L and R categories include embedding and
4617 ;; override controls, but we don't want to
4618 ;; replace them, because that might change
4619 ;; the visual order. Likewise with PDF and
4620 ;; isolate controls.
4622 bidi-directional-non-controls-chars
4623 limit)))))
4624 ;; Replace any run of non-RTL characters by a single LRM.
4626 ;; No more characters of CATEGORY, we are done.
4631 ;; Skip directional controls, if any.
4636 "Replace characters between FROM and TO while keeping bidi context.
4638 This function replaces the region of text with as few characters
4639 as possible, while preserving the effect that region will have on
4640 bidirectional display before and after the region."
4644 ;; This is for when they copy text with read-only text
4645 ;; properties.
4649 ;; Replace each run of non-RTL characters with a single LRM.
4651 ;; Replace each run of non-LTR characters with a single RLM. Note
4652 ;; that the \cR category includes both the Arabic Letter (AL) and
4653 ;; R characters; here we ignore the distinction between them,
4654 ;; because that distinction only affects Arabic Number (AN)
4655 ;; characters, which are weak and don't affect the reordering.
4659 "Return buffer text between START and END with its bidi context.
4661 START and END are assumed to belong to the same physical line
4662 of buffer text. This function prepends and appends to the text
4663 between START and END bidi control characters that preserve the
4664 visual order of that text when it is inserted at some other place."
4669 substr para-dir from to)
4676 ;; If we don't have any mixed directional characters in the
4677 ;; entire line, we can just copy the substring without adding
4678 ;; any context.
4693 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4694 ;; (1) force the string to have the same base embedding
4695 ;; direction as the paragraph direction at the source, no matter
4696 ;; what is the paragraph direction at destination; and (2) avoid
4697 ;; affecting the visual order of the surrounding text at
4698 ;; destination if there are characters of different
4699 ;; directionality there.
4704 "Return portion of current buffer between START and END with bidi context.
4706 This function works similar to `buffer-substring', but it prepends and
4707 appends to the text bidi directional control characters necessary to
4708 preserve the visual appearance of the text if it is inserted at another
4709 place. This is useful when the buffer substring includes bidirectional
4710 text and control characters that cause non-trivial reordering on display.
4711 If copied verbatim, such text can have a very different visual appearance,
4712 and can also change the visual appearance of the surrounding text at the
4713 destination of the copy.
4715 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4716 the text properties."
4729 no-properties)))
4733 substr)))
4734 \f
4735 ;; Yanking.
4740 "List of special text property handling conditions for yanking.
4741 Each element should have the form (PROP . FUN), where PROP is a
4742 property symbol and FUN is a function. When the `yank' command
4743 inserts text into the buffer, it scans the inserted text for
4744 stretches of text that have `eq' values of the text property
4745 PROP; for each such stretch of text, FUN is called with three
4746 arguments: the property's value in that text, and the start and
4747 end positions of the text.
4749 This is done prior to removing the properties specified by
4750 `yank-excluded-properties'."
4753 function))
4756 ;; This is actually used in subr.el but defcustom does not work there.
4759 intangible invisible keymap local-map mouse-face read-only
4760 yank-handler)
4761 "Text properties to discard when yanking.
4762 The value should be a list of text properties to discard or t,
4763 which means to discard all text properties.
4765 See also `yank-handled-properties'."
4772 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4773 Function is called with two parameters, START and END corresponding to
4774 the value of the mark and point; it is guaranteed that START <= END.
4778 "Replace just-yanked stretch of killed text with a different stretch.
4779 This command is allowed only immediately after a `yank' or a `yank-pop'.
4780 At such a time, the region contains a stretch of reinserted
4781 previously-killed text. `yank-pop' deletes that text and inserts in its
4782 place a different stretch of killed text.
4784 With no argument, the previous kill is inserted.
4785 With argument N, insert the Nth previous kill.
4786 If N is negative, this is a more recent kill.
4788 The sequence of kills wraps around, so that after the oldest one
4789 comes the newest one.
4791 This command honors the `yank-handled-properties' and
4792 `yank-excluded-properties' variables, and the `yank-handler' text
4793 property, in the way that `yank' does."
4807 ;; Set the window start back where it was in the yank command,
4808 ;; if possible.
4811 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4812 ;; It is cleaner to avoid activation, even though the command
4813 ;; loop would deactivate the mark because we inserted text.
4816 nil)
4820 More precisely, reinsert the most recent kill, which is the
4821 stretch of killed text most recently killed OR yanked. Put point
4822 at the end, and set mark at the beginning without activating it.
4824 With argument N, reinsert the Nth most recent kill.
4826 This command honors the `yank-handled-properties' and
4827 `yank-excluded-properties' variables, and the `yank-handler' text
4828 property, as described below.
4830 Properties listed in `yank-handled-properties' are processed,
4831 then those listed in `yank-excluded-properties' are discarded.
4833 If STRING has a non-nil `yank-handler' property anywhere, the
4834 normal insert behavior is altered, and instead, for each contiguous
4835 segment of STRING that has a given value of the `yank-handler'
4836 property, that value is used as follows:
4838 The value of a `yank-handler' property must be a list of one to four
4839 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
4840 FUNCTION, if non-nil, should be a function of one argument (the
4841 object to insert); FUNCTION is called instead of `insert'.
4842 PARAM, if present and non-nil, is passed to FUNCTION (to be handled
4843 in whatever way is appropriate; e.g. if FUNCTION is `yank-rectangle',
4844 PARAM may be a list of strings to insert as a rectangle). If PARAM
4845 is nil, then the current segment of STRING is used.
4846 If NOEXCLUDE is present and non-nil, the normal removal of
4847 `yank-excluded-properties' is not performed; instead FUNCTION is
4848 responsible for the removal. This may be necessary if FUNCTION
4849 adjusts point before or after inserting the object.
4850 UNDO, if present and non-nil, should be a function to be called
4851 by `yank-pop' to undo the insertion of the current PARAM. It is
4852 given two arguments, the start and end of the region. FUNCTION
4853 may set `yank-undo-function' to override UNDO.
4858 ;; If we don't get all the way thru, make last-command indicate that
4859 ;; for the following command.
4867 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4868 ;; It is cleaner to avoid activation, even though the command
4869 ;; loop would deactivate the mark because we inserted text.
4872 ;; If we do get all the way thru, make this-command indicate that.
4875 nil)
4878 "Rotate the yanking point in the kill ring.
4879 With ARG, rotate that many kills forward (or backward, if negative)."
4882 \f
4883 ;; Some kill commands.
4885 ;; Internal subroutine of delete-char
4891 ;; Internal subroutine of backward-delete-char
4898 "The method for untabifying when deleting backward.
4899 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4900 `hungry' -- delete all whitespace, both tabs and spaces;
4901 `all' -- delete all whitespace, including tabs, spaces and newlines;
4902 nil -- just delete one character."
4908 "Delete characters backward, changing tabs into spaces.
4909 The exact behavior depends on `backward-delete-char-untabify-method'.
4910 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4911 Interactively, ARG is the prefix arg (default 1)
4912 and KILLP is t if a prefix arg was specified."
4935 arg)))
4936 ;; Avoid warning about delete-backward-char
4940 "Kill up to and including ARGth occurrence of CHAR.
4941 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4942 Goes backward if ARG is negative; error if CHAR not found."
4945 ;; Avoid "obsolete" warnings for translation-table-for-input.
4953 ;; kill-line and its subroutines.
4956 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4961 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4962 With prefix argument ARG, kill that many lines from point.
4963 Negative arguments kill lines backward.
4964 With zero argument, kills the text before point on the current line.
4967 a number counts as a prefix arg.
4969 To kill a whole line, when point is not at the beginning, type \
4972 If `show-trailing-whitespace' is non-nil, this command will just
4973 kill the rest of the current line, even if there are no nonblanks
4974 there.
4976 If option `kill-whole-line' is non-nil, then this command kills the whole line
4977 including its terminating newline, when used at the beginning of a line
4978 with no argument. As a consequence, you can always kill a whole line
4981 If you want to append the killed line to the last killed text,
4984 If the buffer is read-only, Emacs will beep and refrain from deleting
4985 the line, but put the line in the kill ring anyway. This means that
4986 you can use this command to copy text from a read-only buffer.
4987 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4988 even beep.)"
4991 ;; It is better to move point to the other end of the kill
4992 ;; before killing. That way, in a read-only buffer, point
4993 ;; moves across the text that is copied to the kill ring.
4994 ;; The choice has no effect on undo now that undo records
4995 ;; the value of point from before the command was run.
5005 ;; If trailing whitespace is visible,
5006 ;; don't treat it as nothing.
5016 "Kill current line.
5017 With prefix ARG, kill that many lines starting from the current line.
5018 If ARG is negative, kill backward. Also kill the preceding newline.
5020 If ARG is zero, kill current line but exclude the trailing newline."
5031 ;; We need to kill in two steps, because the previous command
5032 ;; could have been a kill command, in which case the text
5033 ;; before point needs to be prepended to the current kill
5034 ;; ring entry and the text after point appended. Also, we
5035 ;; need to use save-excursion to avoid copying the same text
5036 ;; twice to the kill ring in read-only buffers.
5054 "Move forward by ARG lines, ignoring currently invisible newlines only.
5055 If ARG is negative, move backward -ARG lines.
5056 If ARG is zero, move to the beginning of the current line."
5063 ;; If the newline we just skipped is invisible,
5064 ;; don't count it.
5068 prop
5073 ;; If invisible text follows, and it is a number of complete lines,
5074 ;; skip it.
5080 prop
5096 ;; If the newline we just moved to is invisible,
5097 ;; don't count it.
5102 prop
5107 ;; If invisible text follows, and it is a number of complete lines,
5108 ;; skip it.
5114 prop
5125 nil)))
5128 "Move to end of current visible line."
5130 ;; If the following character is currently invisible,
5131 ;; skip all characters with that same `invisible' property value,
5132 ;; then find the next newline.
5139 prop
5148 \f
5150 "Insert after point the contents of BUFFER.
5151 Puts mark after the inserted text.
5152 BUFFER may be a buffer or a buffer name."
5162 t))))
5167 nil)
5170 "Append to specified buffer the text of the region.
5171 It is inserted into that buffer before its point.
5173 When calling from a program, give three arguments:
5174 BUFFER (or buffer name), START and END.
5175 START and END specify the portion of the current buffer to be copied."
5182 point)
5193 "Prepend to specified buffer the text of the region.
5194 It is inserted into that buffer after its point.
5196 When calling from a program, give three arguments:
5197 BUFFER (or buffer name), START and END.
5198 START and END specify the portion of the current buffer to be copied."
5207 "Copy to specified buffer the text of the region.
5208 It is inserted into that buffer, replacing existing text there.
5210 When calling from a program, give three arguments:
5211 BUFFER (or buffer name), START and END.
5212 START and END specify the portion of the current buffer to be copied."
5220 \f
5224 "Hook run when the mark becomes active.
5225 It is also run at the end of a command, if the mark is active and
5232 "Return this buffer's mark value as integer, or nil if never set.
5234 In Transient Mark mode, this function signals an error if
5235 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5236 or the argument FORCE is non-nil, it disregards whether the mark
5237 is active, and returns an integer or nil in the usual way.
5239 If you are using this in an editing command, you are most likely making
5240 a mistake; see the documentation of `set-mark'."
5245 ;; Behind display-selections-p.
5248 "Deactivate the mark.
5249 If Transient Mark mode is disabled, this function normally does
5250 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5252 Deactivating the mark sets `mark-active' to nil, updates the
5253 primary selection according to `select-active-regions', and runs
5254 `deactivate-mark-hook'.
5256 If Transient Mark mode was temporarily enabled, reset the value
5257 of the variable `transient-mark-mode'; if this causes Transient
5258 Mark mode to be disabled, don't change `mark-active' to nil or
5259 run `deactivate-mark-hook'."
5263 select-active-regions)
5266 ;; The var `saved-region-selection', if non-nil, is the text in
5267 ;; the region prior to the last command modifying the buffer.
5268 ;; Set the selection to that, or to the current region.
5273 ;; If another program has acquired the selection, region
5274 ;; deactivation should not clobber it (Bug#11772).
5293 "Activate the mark.
5294 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5304 "Set this buffer's mark to POS. Don't use this function!
5305 That is to say, don't use this function unless you want
5306 the user to see that the mark has moved, and you want the previous
5307 mark position to be lost.
5309 Normally, when a new mark is set, the old one should go on the stack.
5310 This is why most applications should use `push-mark', not `set-mark'.
5312 Novice Emacs Lisp programmers often try to use the mark for the wrong
5313 purposes. The mark saves a location for the user's convenience.
5314 Most editing commands should not alter the mark.
5315 To remember a location for internal use in the Lisp program,
5316 store it in a Lisp variable. Example:
5318 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5323 ;; Normally we never clear mark-active except in Transient Mark mode.
5324 ;; But when we actually clear out the mark value too, we must
5325 ;; clear mark-active in any mode.
5327 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5328 ;; it should never be nil if the mark is nil.
5336 mark-active))
5343 ;; Mark marker
5349 ;; Mark active
5352 ;; If mark is active now, and either was not active or was at a
5353 ;; different place, run the activate hook.
5358 ;; If mark has ceased to be active, run deactivate hook.
5363 "Like `save-excursion', but also save and restore the mark state.
5364 This macro does what `save-excursion' did before Emacs 25.1."
5374 If nil, region-aware commands treat the empty region as inactive.
5375 If non-nil, region-aware commands treat the region as active as
5376 long as the mark is active, even if the region is empty.
5378 Region-aware commands are those that act on the region if it is
5379 active and Transient Mark mode is enabled, and on the text near
5380 point otherwise."
5386 "Return t if the region is active and it is appropriate to act on it.
5387 This is used by commands that act specially on the region under
5388 Transient Mark mode.
5390 The return value is t if Transient Mark mode is enabled and the
5391 mark is active; furthermore, if `use-empty-active-region' is nil,
5392 the region must not be empty. Otherwise, the return value is nil.
5394 For some commands, it may be appropriate to ignore the value of
5395 `use-empty-active-region'; in that case, use `region-active-p'."
5400 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5402 Some commands act specially on the region when Transient Mark
5403 mode is enabled. Usually, such commands should use
5404 `use-region-p' instead of this function, because `use-region-p'
5405 also checks the value of `use-empty-active-region'."
5407 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5408 ;; without the mark being set (e.g. bug#17324). We really should fix
5409 ;; that problem, but in the mean time, let's make sure we don't say the
5410 ;; region is active when there's no mark.
5414 "Return non-nil if the region contains several pieces.
5415 An example is a rectangular region handled as a list of
5416 separate contiguous regions for each line."
5429 ;; Normal priority so that a large region doesn't hide all the
5430 ;; overlays within it, but high secondary priority so that if it
5431 ;; ends/starts in the middle of a small overlay, that small overlay
5432 ;; won't hide the region's boundaries.
5434 nrol)
5439 rol)))
5455 start end window rol)))
5458 new))))))
5461 "Hook run just before redisplay.
5462 It is called in each window that is to be redisplayed. It takes one argument,
5463 which is the window that will be redisplayed. When run, the `current-buffer'
5484 "Maximum size of mark ring. Start discarding off end if gets this big."
5492 "Maximum size of global mark ring. \
5493 Start discarding off end if gets this big."
5498 "Jump to mark, and pop a new position for mark off the ring.
5499 \(Does not affect global mark ring)."
5509 "Set mark at where point is.
5510 If no prefix ARG and mark is already set there, just activate it.
5511 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5523 will pop the mark twice, and
5525 will pop the mark three times.
5533 "Set the mark where point is, and activate it; or jump to the mark.
5534 Setting the mark also alters the region, which is the text
5535 between point and mark; this is the closest equivalent in
5538 With no prefix argument, set the mark at point, and push the
5539 old mark position on local mark ring. Also push the new mark on
5540 global mark ring, if the previous mark was set in another buffer.
5542 When Transient Mark Mode is off, immediately repeating this
5543 command activates `transient-mark-mode' temporarily.
5546 jump to the mark, and set the mark from
5547 position popped off the local mark ring (this does not affect the global
5549 mark ring (see `pop-global-mark').
5551 If `set-mark-command-repeat-pop' is non-nil, repeating
5553 off the local (or global) mark ring and jumps there.
5556 argument, unconditionally set mark where point is, even if
5557 `set-mark-command-repeat-pop' is non-nil.
5559 Novice Emacs Lisp programmers often try to use the mark for the wrong
5560 purposes. See the documentation of `set-mark' for more information."
5580 arg)
5594 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5595 If the last global mark pushed was not in the current buffer,
5596 also push LOCATION on the global mark ring.
5597 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5599 Novice Emacs Lisp programmers often try to use the mark for the wrong
5600 purposes. See the documentation of `set-mark' for more information.
5602 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5609 ;; Now push the mark on the global mark ring.
5612 ;; The last global mark pushed was in this same buffer.
5613 ;; Don't push another one.
5614 nil
5623 nil)
5626 "Pop off mark ring into the buffer's actual mark.
5627 Does not set point. Does nothing if mark ring is empty."
5639 "Put the mark where point is now, and point where the mark is now.
5640 This command works even when the mark is not active,
5641 and it reactivates the mark.
5643 If Transient Mark mode is on, a prefix ARG deactivates the mark
5644 if it is active, and otherwise avoids reactivating it. If
5645 Transient Mark mode is off, a prefix ARG enables Transient Mark
5646 mode temporarily."
5660 nil))
5663 "When non-nil, shifted motion keys activate the mark momentarily.
5665 While the mark is activated in this way, any shift-translated point
5666 motion key extends the region, and if Transient Mark mode was off, it
5667 is temporarily turned on. Furthermore, the mark will be deactivated
5668 by any subsequent point motion key that was not shift-translated, or
5669 by any action that normally deactivates the mark in Transient Mark mode.
5671 See `this-command-keys-shift-translated' for the meaning of
5672 shift-translation."
5677 "Activate/deactivate mark depending on invocation thru shift translation.
5678 This function is called by `call-interactively' when a command
5679 with a `^' character in its `interactive' spec is invoked, before
5680 running the command itself.
5682 If `shift-select-mode' is enabled and the command was invoked
5683 through shift translation, set the mark and activate the region
5684 temporarily, unless it was already set in this way. See
5685 `this-command-keys-shift-translated' for the meaning of shift
5686 translation.
5688 Otherwise, if the region has been activated temporarily,
5689 deactivate it, and restore the variable `transient-mark-mode' to
5690 its earlier value."
5697 transient-mark-mode)))
5706 "Toggle Transient Mark mode.
5707 With a prefix argument ARG, enable Transient Mark mode if ARG is
5708 positive, and disable it otherwise. If called from Lisp, enable
5709 Transient Mark mode if ARG is omitted or nil.
5711 Transient Mark mode is a global minor mode. When enabled, the
5712 region is highlighted with the `region' face whenever the mark
5714 and after certain other operations that set the mark but whose
5715 main purpose is something else--for example, incremental search,
5721 Many commands change their behavior when Transient Mark mode is
5722 in effect and the mark is active, by acting on the region instead
5723 of their usual default part of the buffer's text. Examples of
5726 To see the documentation of commands which are sensitive to the
5729 :global t
5730 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5734 "Non-nil means it is ok for commands to call `widen' when they want to.
5735 Some commands will do this in order to go to positions outside
5736 the current accessible part of the buffer.
5738 If `widen-automatically' is nil, these commands will do something else
5742 "Whether the currently executing code is performing an essential task.
5743 This variable should be non-nil only when running code which should not
5744 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5745 user for a password when we are simply scanning a set of files in the
5746 background or displaying possible completions before the user even asked
5750 "Pop off global mark ring and jump to the top location."
5752 ;; Pop entries which refer to non-existent buffers.
5770 \f
5772 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5778 "Move cursor vertically down ARG lines.
5779 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5780 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5781 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5782 function will not vscroll.
5784 ARG defaults to 1.
5786 If there is no character in the target line exactly under the current column,
5787 the cursor is positioned after the character in that line which spans this
5788 column, or at the end of the line if it is not long enough.
5789 If there is no line in the buffer after this one, behavior depends on the
5790 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5791 to create a line, and moves the cursor to that line. Otherwise it moves the
5792 cursor to the end of the buffer.
5794 If the variable `line-move-visual' is non-nil, this command moves
5795 by display lines. Otherwise, it moves by buffer lines, without
5796 taking variable-width characters or continued lines into account.
5800 a semipermanent goal column for this command.
5801 Then instead of trying to move exactly vertically (or as close as possible),
5802 this command moves to the specified goal column (or as close as possible).
5803 The goal column is stored in the variable `goal-column', which is nil
5804 when there is no goal column. Note that setting `goal-column'
5805 overrides `line-move-visual' and causes this command to move by buffer
5806 lines rather than by display lines."
5812 ;; When adding a newline, don't expand an abbrev.
5823 nil)
5826 "Move cursor vertically up ARG lines.
5827 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5828 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5829 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5830 function will not vscroll.
5832 ARG defaults to 1.
5834 If there is no character in the target line exactly over the current column,
5835 the cursor is positioned after the character in that line which spans this
5836 column, or at the end of the line if it is not long enough.
5838 If the variable `line-move-visual' is non-nil, this command moves
5839 by display lines. Otherwise, it moves by buffer lines, without
5840 taking variable-width characters or continued lines into account.
5844 a semipermanent goal column for this command.
5845 Then instead of trying to move exactly vertically (or as close as possible),
5846 this command moves to the specified goal column (or as close as possible).
5847 The goal column is stored in the variable `goal-column', which is nil
5848 when there is no goal column. Note that setting `goal-column'
5849 overrides `line-move-visual' and causes this command to move by buffer
5850 lines rather than by display lines."
5861 nil)
5864 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5865 This means moving to the end of each line moved onto.
5866 The beginning of a blank line does not count as the end of a line.
5867 This has no effect when the variable `line-move-visual' is non-nil."
5873 A non-nil setting overrides the variable `line-move-visual', which see."
5880 "Current goal column for vertical motion.
5881 It is the column where point was at the start of the current run
5882 of vertical motion commands.
5884 When moving by visual lines via the function `line-move-visual', it is a cons
5885 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5886 divided by the default column width, and HSCROLL is the number of
5887 columns by which window is scrolled from left margin.
5889 When the `track-eol' feature is doing its job, the value is
5893 "Non-nil means commands that move by lines ignore invisible newlines.
5894 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5895 as if newlines that are invisible didn't exist, and count
5896 only visible newlines. Thus, moving across across 2 newlines
5897 one of which is invisible will be counted as a one-line move.
5898 Also, a non-nil value causes invisible text to be ignored when
5899 counting columns for the purposes of keeping point in the same
5902 Outline mode sets this."
5907 "When non-nil, `line-move' moves point by visual lines.
5908 This movement is based on where the cursor is displayed on the
5909 screen, instead of relying on buffer contents alone. It takes
5910 into account variable-width characters and line continuation.
5911 If nil, `line-move' moves point by logical lines.
5912 A non-nil setting of `goal-column' overrides the value of this variable
5913 and forces movement by logical lines.
5914 A window that is horizontally scrolled also forces movement by logical
5915 lines."
5920 ;; Only used if display-graphic-p.
5924 "Return the height in pixels of the current buffer's default face font.
5926 If the default font is remapped (see `face-remapping-alist'), the
5927 function returns the height of the remapped face."
5931 ;; Avoid calling font-info if the frame's default font was
5932 ;; not changed since the frame was created. That's because
5933 ;; font-info is expensive for some fonts, see bug #14838.
5939 "Return the width in pixels of the current buffer's default face font.
5941 If the default font is remapped (see `face-remapping-alist'), the
5942 function returns the width of the remapped face."
5946 ;; Avoid calling font-info if the frame's default font was
5947 ;; not changed since the frame was created. That's because
5948 ;; font-info is expensive for some fonts, see bug #14838.
5953 width
5958 "Return the pixel height of current buffer's default-face text line.
5960 The value includes `line-spacing', if any, defined for the buffer
5961 or the frame."
5974 "Return the number of screen lines in the text area of the selected window.
5976 This is different from `window-text-height' in that this function counts
5977 lines in units of the height of the font used by the default face displayed
5978 in the window, not in units of the frame's default font, and also accounts
5979 for `line-spacing', if any, defined for the window's buffer or frame.
5981 The value is a floating-point number."
5986 ;; Returns non-nil if partial move was done.
5989 ;; Move backward (up).
5990 ;; If already vscrolled, reduce vscroll
5996 ;; Move forward (down).
6009 py vs last-line)
6029 col-row)
6034 ;; VPOS > 0 means the last line is only partially visible.
6035 ;; But if the part that is visible is at least as tall as the
6036 ;; default font, that means the line is actually fully
6037 ;; readable, and something like line-spacing is hidden. So in
6038 ;; that case we accept the last line in the window as still
6039 ;; visible, and consider the margin as starting one line
6040 ;; later.
6048 ;; If last line of window is fully visible, and vscrolling
6049 ;; more would make this line invisible, move forward.
6054 nil)
6055 ;; If cursor is not in the bottom scroll margin, and the
6056 ;; current line is is not too tall, move forward.
6058 vpos
6061 nil)
6062 ;; When already vscrolled, we vscroll some more if we can,
6063 ;; or clear vscroll and move forward at end of tall image.
6068 ;; If cursor just entered the bottom scroll margin, move forward,
6069 ;; but also optionally vscroll one line so redisplay won't recenter.
6073 ;; Don't vscroll if the partially-visible line at window
6074 ;; bottom is not too tall (a.k.a. "just one more text
6075 ;; line"): in that case, we do want redisplay to behave
6076 ;; normally, i.e. recenter or whatever.
6077 ;;
6078 ;; Note: ROWH + RBOT from the value returned by
6079 ;; pos-visible-in-window-p give the total height of the
6080 ;; partially-visible glyph row at the end of the window. As
6081 ;; we are dealing with floats, we disregard sub-pixel
6082 ;; discrepancies between that and DLH.
6086 t)
6087 ;; If there are lines above the last line, scroll-up one line.
6090 t)
6091 ;; Finally, start vscroll.
6096 ;; This is like line-move-1 except that it also performs
6097 ;; vertical scrolling of tall images if appropriate.
6098 ;; That is not really a clean thing to do, since it mixes
6099 ;; scrolling with cursor motion. But so far we don't have
6100 ;; a cleaner solution to the problem of making C-n do something
6101 ;; useful given a tall image.
6103 "Move forward ARG lines.
6104 If NOERROR, don't signal an error if we can't move ARG lines.
6105 TO-END is unused.
6106 TRY-VSCROLL controls whether to vscroll tall lines: if either
6107 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6108 not vscroll."
6112 ;; Only vscroll for single line moves
6114 ;; Under scroll-conservatively, the display engine
6115 ;; does this better.
6117 ;; But don't vscroll in a keyboard macro.
6123 ;; Display-based column are incompatible with goal-column.
6125 ;; When the text in the window is scrolled to the left,
6126 ;; display-based motion doesn't make sense (because each
6127 ;; logical line occupies exactly one screen line).
6129 ;; Likewise when the text _was_ scrolled to the left
6130 ;; when the current run of vertical motion commands
6131 ;; started.
6134 auto-hscroll-mode
6136 (>= temporary-goal-column
6139 ;; If we moved into a tall line, set vscroll to make
6140 ;; scrolling through tall images more smooth.
6144 winh)
6150 nil
6154 ;; Display-based alternative to line-move-1.
6155 ;; Arg says how many lines to move. The value is t if we can move the
6156 ;; specified number of lines.
6158 "Move ARG lines forward.
6159 If NOERROR, don't signal an error if we can't move that many lines."
6162 target-hscroll)
6163 ;; Check if the previous command was a line-motion command, or if
6164 ;; we were called from some other command.
6167 ;; If so, there's no need to reset `temporary-goal-column',
6168 ;; but we may need to hscroll.
6172 ;; Otherwise, we should reset `temporary-goal-column'.
6174 x-pos)
6176 ;; Handle the `overflow-newline-into-fringe' case:
6181 ;; In R2L lines, the X pixel coordinate is measured from the
6182 ;; left edge of the window, but columns are still counted
6183 ;; from the logical-order beginning of the line, i.e. from
6184 ;; the right edge in this case. We need to adjust for that.
6190 hscroll)))
6192 ;; When we move beyond the first/last character visible in
6193 ;; the window, posn-at-point will return nil, so we need to
6194 ;; approximate the goal column as below.
6199 ;; vertical-motion can move more than it was asked to if it moves
6200 ;; across display strings with newlines. We don't want to ring
6201 ;; the bell and announce beginning/end of buffer in that case.
6207 temporary-goal-column))
6208 arg))
6209 arg))
6215 temporary-goal-column))
6216 arg))
6217 arg)))
6220 ;; If the goal column lies on a display string,
6221 ;; `vertical-motion' advances the cursor to the end
6222 ;; of the string. For arg < 0, this can cause the
6223 ;; cursor to get stuck. (Bug#3020).
6227 nil)))))
6229 ;; This is the guts of next-line and previous-line.
6230 ;; Arg says how many lines to move.
6231 ;; The value is t if we can move the specified number of lines.
6233 ;; Don't run any point-motion hooks, and disregard intangibility,
6234 ;; for intermediate positions.
6246 ;; Don't count beg of empty line as end of line
6247 ;; unless we just did explicit end-of-line.
6249 most-positive-fixnum
6253 line-move-ignore-invisible))
6254 ;; Use just newline characters.
6255 ;; Set ARG to 0 if we move as many lines as requested.
6258 ;; This way of moving forward ARG lines
6259 ;; verifies that we have a newline after the last one.
6260 ;; It doesn't get confused by intangible text.
6269 'beginning-of-buffer
6271 nil)))
6272 ;; Move by arg lines, but ignore invisible ones.
6275 ;; If the following character is currently invisible,
6276 ;; skip all characters with that same `invisible' property value.
6279 ;; Move a line.
6280 ;; We don't use `end-of-line', since we want to escape
6281 ;; from field boundaries occurring exactly at point.
6287 ;; If there's no invisibility here, move over the newline.
6296 ;; We avoid vertical-motion when possible
6297 ;; because that has to fontify.
6299 ;; Otherwise move a more sophisticated way.
6306 ;; The logic of this is the same as the loop above,
6307 ;; it just goes in the other direction.
6309 ;; For completely consistency with the forward-motion
6310 ;; case, we should call beginning-of-line here.
6311 ;; However, if point is inside a field and on a
6312 ;; continued line, the call to (vertical-motion -1)
6313 ;; below won't move us back far enough; then we return
6314 ;; to the same column in line-move-finish, and point
6315 ;; gets stuck -- cyd
6333 ;; if our target is the middle of this line.
6338 ;; This is the value the function returns.
6342 ;; If we did not move down as far as desired, at least go
6343 ;; to end of line. Be sure to call point-entered and
6344 ;; point-left-hooks.
6350 ;; If we did not move up as far as desired,
6351 ;; at least go to beginning of line.
6363 ;; Set REPEAT to t to repeat the whole thing.
6370 ;; Compute the end of the line
6371 ;; ignoring effectively invisible newlines.
6373 ;; Like end-of-line but ignores fields.
6380 ;; Move to the desired column.
6383 ;; Corner case: suppose we start out in a field boundary in
6384 ;; the middle of a continued line. When we get to
6385 ;; line-move-finish, point is at the start of a new *screen*
6386 ;; line but the same text line; then line-move-to-column would
6387 ;; move us backwards. Test using C-n with point on the "x" in
6388 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6395 ;; Process intangibility within a line.
6396 ;; With inhibit-point-motion-hooks bound to nil, a call to
6397 ;; goto-char moves point past intangible text.
6399 ;; However, inhibit-point-motion-hooks controls both the
6400 ;; intangibility and the point-entered/point-left hooks. The
6401 ;; following hack avoids calling the point-* hooks
6402 ;; unnecessarily. Note that we move *forward* past intangible
6403 ;; text when the initial and final points are the same.
6408 ;; If intangibility moves us to a different (later) place
6409 ;; in the same line, use that as the destination.
6412 ;; If that position is "too late",
6413 ;; try the previous allowable position.
6414 ;; See if it is ok.
6417 ;; If going forward, don't accept the previous
6418 ;; allowable position if it is before the target line.
6420 ;; If going backward, don't accept the previous
6421 ;; allowable position if it is still after the target line.
6424 ;; As a last resort, use the end of the line.
6427 ;; Now move to the updated destination, processing fields
6428 ;; as well as intangibility.
6432 ;; Ignore field boundaries if the initial and final
6433 ;; positions have the same `field' property, even if the
6434 ;; fields are non-contiguous. This seems to be "nicer"
6435 ;; behavior in many situations.
6438 new
6442 ;; If all this moved us to a different line,
6443 ;; retry everything within that new line.
6445 ;; Repeat the intangibility and field processing.
6449 "Try to find column COL, considering invisibility.
6450 This function works only in certain cases,
6451 because what we really need is for `move-to-column'
6452 and `current-column' to be able to ignore invisible text."
6461 ;; If the following character is currently invisible,
6462 ;; skip all characters with that same `invisible' property value.
6466 ;; Have we advanced to a larger column position?
6468 ;; We have made some progress towards the desired column.
6469 ;; See if we can make any further progress.
6471 ;; Otherwise, go to the place we originally found
6472 ;; and move back over invisible text.
6473 ;; that will get us to the same place on the screen
6474 ;; but with a more reasonable buffer position.
6477 ;; We want the real line beginning, so it's consistent
6478 ;; with bolp below, otherwise we might infloop.
6485 "Move point to end of current line as displayed.
6486 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6487 If point reaches the beginning or end of buffer, it stops there.
6489 To ignore the effects of the `intangible' text or overlay
6490 property, bind `inhibit-point-motion-hooks' to t.
6491 If there is an image in the current line, this function
6492 disregards newlines that are part of the text on which the image
6493 rests."
6503 ;; With bidi reordering, we may not be at bol,
6504 ;; so make sure we are.
6519 ;; If we skipped something intangible and now we're not
6520 ;; really at eol, keep going.
6525 "Move point to beginning of current line as displayed.
6526 \(If there's an image in the line, this disregards newlines
6527 which are part of the text that the image rests on.)
6529 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6530 If point reaches the beginning or end of buffer, it stops there.
6531 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6536 first-vis first-vis-field-value)
6538 ;; Move by lines, if ARG is not 1 (the default).
6543 ;; Move to beginning-of-line, ignoring fields and invisible text.
6549 ;; Now find first visible char in the line.
6554 ;; See if fields would stop us from reaching FIRST-VIS.
6559 ;; If yes, obey them.
6560 first-vis-field-value
6561 ;; Otherwise, move to START with attention to fields.
6562 ;; (It is possible that fields never matter in this case.)
6567 ;; Many people have said they rarely use this feature, and often type
6568 ;; it by accident. Maybe it shouldn't even be on a key.
6573 Those commands will move to this position in the line moved to
6574 rather than trying to keep the same horizontal position.
6575 With a non-nil argument ARG, clears out the goal column
6577 The goal column is stored in the variable `goal-column'.
6578 This is a buffer-local setting."
6585 ;; The older method below can be erroneous if `set-goal-column' is bound
6586 ;; to a sequence containing %
6587 ;;(message (substitute-command-keys
6588 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6589 ;;goal-column)
6596 )
6597 nil)
6598 \f
6599 ;;; Editing based on visual lines, as opposed to logical lines.
6602 "Move point to end of current visual line.
6603 With argument N not nil or 1, move forward N - 1 visual lines first.
6604 If point reaches the beginning or end of buffer, it stops there.
6605 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6611 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6612 ;; constrain to field boundaries, so we don't either.
6616 "Move point to beginning of current visual line.
6617 With argument N not nil or 1, move forward N - 1 visual lines first.
6618 If point reaches the beginning or end of buffer, it stops there.
6619 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6627 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6631 "Kill the rest of the visual line.
6632 With prefix argument ARG, kill that many visual lines from point.
6633 If ARG is negative, kill visual lines backward.
6634 If ARG is zero, kill the text before point on the current visual
6635 line.
6637 If you want to append the killed line to the last killed text,
6640 If the buffer is read-only, Emacs will beep and refrain from deleting
6641 the line, but put the line in the kill ring anyway. This means that
6642 you can use this command to copy text from a read-only buffer.
6643 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6644 even beep.)"
6646 ;; Like in `kill-line', it's better to move point to the other end
6647 ;; of the kill before killing.
6655 ;; Skip any trailing whitespace at the end of the visual line.
6656 ;; We used to do this only if `show-trailing-whitespace' is
6657 ;; nil, but that's wrong; the correct thing would be to check
6658 ;; whether the trailing whitespace is highlighted. But, it's
6659 ;; OK to just do this unconditionally.
6666 "Move cursor vertically down ARG lines.
6667 This is identical to `next-line', except that it always moves
6668 by logical lines instead of visual lines, ignoring the value of
6669 the variable `line-move-visual'."
6676 "Move cursor vertically up ARG lines.
6677 This is identical to `previous-line', except that it always moves
6678 by logical lines instead of visual lines, ignoring the value of
6679 the variable `line-move-visual'."
6686 "Editing based on visual lines."
6695 ;; These keybindings interfere with xterm function keys. Are
6696 ;; there any other suitable bindings?
6697 ;; (define-key map "\M-[" 'previous-logical-line)
6698 ;; (define-key map "\M-]" 'next-logical-line)
6699 map))
6702 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6703 The value should be a list of the form (LEFT RIGHT), where LEFT
6704 and RIGHT are symbols representing the bitmaps to display, to
6705 indicate wrapped lines, in the left and right fringes respectively.
6706 See also `fringe-indicator-alist'.
6707 The default is not to display fringe indicators for wrapped lines.
6708 This variable does not affect fringe indicators displayed for
6709 other purposes."
6724 'continuation
6731 "Toggle visual line based editing (Visual Line mode).
6732 With a prefix argument ARG, enable Visual Line mode if ARG is
6733 positive, and disable it otherwise. If called from Lisp, enable
6734 the mode if ARG is omitted or nil.
6736 When Visual Line mode is enabled, `word-wrap' is turned on in
6737 this buffer, and simple editing commands are redefined to act on
6738 visual lines, not logical lines. See Info node `Visual Line
6739 Mode' for details."
6740 :keymap visual-line-mode-map
6746 ;; Save the local values of some variables, to be restored if
6747 ;; visual-line-mode is turned off.
6749 truncate-partial-width-windows
6750 word-wrap fringe-indicator-alist))
6753 visual-line--saved-state)))
6757 word-wrap t
6758 fringe-indicator-alist
6760 fringe-indicator-alist)))
6774 visual-line-mode turn-on-visual-line-mode)
6776 \f
6778 "Interchange characters around point, moving forward one character.
6779 With prefix arg ARG, effect is to take character before point
6780 and drag it forward past ARG other characters (backward if ARG negative).
6781 If no argument and at end of line, the previous two chars are exchanged."
6789 "Interchange words around point, leaving point at end of them.
6790 With prefix arg ARG, effect is to take word before or around point
6791 and drag it forward past ARG other words (backward if ARG negative).
6792 If ARG is zero, the words around or after point and around or after mark
6793 are interchanged."
6794 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6800 Unlike `transpose-words', point must be between the two sexps and not
6801 in the middle of a sexp to be transposed.
6802 With non-zero prefix arg ARG, effect is to take the sexp before point
6803 and drag it forward past ARG other sexps (backward if ARG is negative).
6804 If ARG is zero, the sexps ending at or after point and at or after mark
6805 are interchanged."
6809 ;; Here we should try to simulate the behavior of
6810 ;; (cons (progn (forward-sexp x) (point))
6811 ;; (progn (forward-sexp (- x)) (point)))
6812 ;; Except that we don't want to rely on the second forward-sexp
6813 ;; putting us back to where we want to be, since forward-sexp-function
6814 ;; might do funny things like infix-precedence.
6819 ;; Jumping over a symbol. We might be inside it, mind you.
6824 ;; Otherwise, we're between sexps. Take a step back before jumping
6825 ;; to make sure we'll obey the same precedence no matter which direction
6826 ;; we're going.
6831 'skip-syntax-forward
6838 "Exchange current line and previous line, leaving point after both.
6839 With argument ARG, takes previous line and moves it past ARG lines.
6840 With argument 0, interchanges line point is in with line mark is in."
6846 ;; Move forward over ARG lines,
6847 ;; but create newlines if necessary.
6854 arg))
6856 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6857 ;; which seems inconsistent with the ARG /= 0 case.
6858 ;; FIXME document SPECIAL.
6860 "Subroutine to do the work of transposing objects.
6861 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6862 moves forward by units of the given object (e.g. forward-sentence,
6863 forward-paragraph). If ARG is zero, exchanges the current object
6864 with the one containing mark. If ARG is an integer, moves the
6865 current object past ARG following (if ARG is positive) or
6866 preceding (if ARG is negative) objects, leaving point after the
6867 current object."
6872 pos1 pos2)
6901 ;; This sequence of insertions attempts to preserve marker
6902 ;; positions at the start and end of the transposed objects.
6916 \f
6918 "Move backward until encountering the beginning of a word.
6919 With argument ARG, do this that many times.
6920 If ARG is omitted or nil, move point backward one word.
6922 The word boundaries are normally determined by the buffer's syntax
6923 table, but `find-word-boundary-function-table', such as set up
6924 by `subword-mode', can change that. If a Lisp program needs to
6925 move by words determined strictly by the syntax table, it should
6926 use `backward-word-strictly' instead."
6931 "Set mark ARG words away from point.
6933 move to with the same argument.
6934 Interactively, if this command is repeated
6935 or (in Transient Mark mode) if the mark is active,
6936 it marks the next ARG words after the ones already marked."
6953 nil t))))
6956 "Kill characters forward until encountering the end of a word.
6957 With argument ARG, do this that many times."
6962 "Kill characters backward until encountering the beginning of a word.
6963 With argument ARG, do this that many times."
6968 "Return the word at or near point, as a string.
6969 The return value includes no text properties.
6971 If optional arg STRICT is non-nil, return nil unless point is
6972 within or adjacent to a word, otherwise look for a word within
6973 point's line. If there is no word anywhere on point's line, the
6974 value is nil regardless of STRICT.
6976 By default, this function treats as a single word any sequence of
6977 characters that have either word or symbol syntax. If optional
6978 arg REALLY-WORD is non-nil, only characters of word syntax can
6979 constitute a word."
6988 ;; Point is neither within nor adjacent to a word.
6990 ;; Look for preceding word in same line.
6993 ;; No preceding word in same line.
6994 ;; Look for following word in same line.
7003 ;; If we found something nonempty, return it as a string.
7006 \f
7008 "String for filling to insert at front of new line, or nil for none."
7010 string)
7016 "Regexp to match lines which should not be auto-filled."
7018 regexp)
7022 "The default value for `normal-auto-fill-function'.
7023 This is the default auto-fill function, some major modes use a different one.
7024 Returns t if it really did any work."
7034 nil ;; Auto-filling not required
7038 ;; Choose a fill-prefix automatically.
7046 ;; Use auto-indentation rather than a guessed empty prefix.
7052 ;; Determine where to split the line.
7065 ;; See whether the place we found is any good.
7069 ;; There is no use breaking at end of line.
7071 ;; It is futile to split at the end of the prefix
7072 ;; since we would just insert the prefix again.
7074 ;; Don't split right after a comment starter
7075 ;; since we would just make another comment starter.
7080 limit t)
7082 ;; No good place to break => stop trying.
7084 ;; Ok, we have a useful place to break the line. Do it.
7086 ;; If point is at the fill-point, do not `save-excursion'.
7087 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7088 ;; point will end up before it rather than after it.
7096 ;; Now do justification, if required
7101 ;; If making the new line didn't reduce the hpos of
7102 ;; the end of the line, then give up now;
7103 ;; trying again will not help.
7106 ;; Justify last line.
7108 t)))
7111 "Mode-specific function which line breaks and continues a comment.
7112 This function is called during auto-filling when a comment syntax
7113 is defined.
7114 The function should take a single optional argument, which is a flag
7118 "Break line at point and indent.
7119 If a comment syntax is defined, call `comment-indent-new-line'.
7121 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7122 unless optional argument SOFT is non-nil."
7126 ;; Insert the newline before removing empty space so that markers
7127 ;; get preserved better.
7133 ;; Blindly trust a non-adaptive fill-prefix.
7139 ;; If there's an adaptive prefix, use it unless we're inside
7140 ;; a comment and the prefix is not a comment starter.
7144 ;; If we're not inside a comment, just try to indent.
7148 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7152 ;; `functions' and `hooks' are usually unsafe to set, but setting
7153 ;; auto-fill-function to nil in a file-local setting is safe and
7154 ;; can be useful to prevent auto-filling.
7158 "Toggle automatic line breaking (Auto Fill mode).
7159 With a prefix argument ARG, enable Auto Fill mode if ARG is
7160 positive, and disable it otherwise. If called from Lisp, enable
7161 the mode if ARG is omitted or nil.
7163 When Auto Fill mode is enabled, inserting a space at a column
7164 beyond `current-fill-column' automatically breaks the line at a
7165 previous space.
7167 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7168 non-nil.
7170 The value of `normal-auto-fill-function' specifies the function to use
7171 for `auto-fill-function' when turning Auto Fill mode on."
7176 ;; This holds a document string used to document auto-fill-mode.
7178 "Automatically break line at a previous space, in insertion of text."
7179 nil)
7182 "Unconditionally turn on Auto Fill mode."
7186 "Unconditionally turn off Auto Fill mode."
7192 "Set `fill-column' to specified argument.
7197 ;; We used to use current-column silently, but C-x f is too easily
7198 ;; typed as a typo for C-x C-f, so we turned it into an error and
7199 ;; now an interactive prompt.
7204 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7208 \f
7210 "Set `selective-display' to ARG; clear it if no arg.
7211 When the value of `selective-display' is a number > 0,
7212 lines whose indentation is >= that value are not displayed.
7213 The variable `selective-display' has a separate value for each buffer."
7233 "Toggle truncating of long lines for the current buffer.
7234 When truncating is off, long lines are folded.
7235 With prefix argument ARG, truncate long lines if ARG is positive,
7236 otherwise fold them. Note that in side-by-side windows, this
7237 command has no effect if `truncate-partial-width-windows' is
7238 non-nil."
7250 nil t)))
7255 "Toggle whether to use word-wrapping for continuation lines.
7256 With prefix argument ARG, wrap continuation lines at word boundaries
7257 if ARG is positive, otherwise wrap them at the right screen edge.
7258 This command toggles the value of `word-wrap'. It has no effect
7259 if long lines are truncated."
7275 "Toggle Overwrite mode.
7276 With a prefix argument ARG, enable Overwrite mode if ARG is
7277 positive, and disable it otherwise. If called from Lisp, enable
7278 the mode if ARG is omitted or nil.
7280 When Overwrite mode is enabled, printing characters typed in
7281 replace existing text on a one-for-one basis, rather than pushing
7282 it to the right. At the end of a line, such characters extend
7283 the line. Before a tab, such characters insert until the tab is
7285 overwrite mode; this is supposed to make it easier to insert
7286 characters when necessary."
7291 "Toggle Binary Overwrite mode.
7292 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7293 is positive, and disable it otherwise. If called from Lisp,
7294 enable the mode if ARG is omitted or nil.
7296 When Binary Overwrite mode is enabled, printing characters typed
7297 in replace existing text. Newlines are not treated specially, so
7298 typing at the end of a line joins the line to the next, with the
7299 typed character between them. Typing before a tab character
7300 simply replaces the tab with the character typed.
7302 ordinary typing characters do.
7304 Note that Binary Overwrite mode is not its own minor mode; it is
7305 a specialization of overwrite mode, entered by setting the
7306 `overwrite-mode' variable to `overwrite-mode-binary'."
7311 "Toggle line number display in the mode line (Line Number mode).
7312 With a prefix argument ARG, enable Line Number mode if ARG is
7313 positive, and disable it otherwise. If called from Lisp, enable
7314 the mode if ARG is omitted or nil.
7316 Line numbers do not appear for very large buffers and buffers
7317 with very long lines; see variables `line-number-display-limit'
7318 and `line-number-display-limit-width'."
7322 "Toggle column number display in the mode line (Column Number mode).
7323 With a prefix argument ARG, enable Column Number mode if ARG is
7324 positive, and disable it otherwise.
7326 If called from Lisp, enable the mode if ARG is omitted or nil."
7330 "Toggle buffer size display in the mode line (Size Indication mode).
7331 With a prefix argument ARG, enable Size Indication mode if ARG is
7332 positive, and disable it otherwise.
7334 If called from Lisp, enable the mode if ARG is omitted or nil."
7338 "Toggle auto-saving in the current buffer (Auto Save mode).
7339 With a prefix argument ARG, enable Auto Save mode if ARG is
7340 positive, and disable it otherwise.
7342 If called from Lisp, enable the mode if ARG is omitted or nil."
7344 ;; If auto-save is off because buffer has shrunk,
7345 ;; then toggling should turn it on.
7353 buffer-file-name)
7355 ;; If -1 was stored here, to temporarily turn off saving,
7356 ;; turn it back on.
7359 \f
7361 "Blinking matching of parens and expressions."
7366 "Non-nil means show matching open-paren when close-paren is inserted.
7367 If t, highlight the paren. If `jump', briefly move cursor to its
7368 position. If `jump-offscreen', move cursor there even if the
7369 position is off screen. With any other non-nil value, the
7370 off-screen position of the opening paren will be shown in the
7371 echo area."
7380 "Non-nil means show matching open-paren when it is on screen.
7381 If nil, don't show it (but the open-paren can still be shown
7382 in the echo area when it is off screen).
7384 This variable has no effect if `blink-matching-paren' is nil.
7385 \(In that case, the open-paren is never shown.)
7386 It is also ignored if `show-paren-mode' is enabled."
7391 "If non-nil, maximum distance to search backwards for matching open-paren.
7392 If nil, search stops at the beginning of the accessible portion of the buffer."
7398 "Time in seconds to delay after showing a matching paren."
7403 "If nil, `blink-matching-paren' ignores comments.
7404 More precisely, when looking for the matching parenthesis,
7405 it skips the contents of comments that end before point."
7410 "Return whether or not START...END are matching parens.
7411 END is the current point and START is the blink position.
7412 START might be nil if no matching starter was found.
7413 Returns non-nil if we find there is a mismatch."
7418 ;; For self-matched chars like " and $, we can't know when they're
7419 ;; mismatched or unmatched, so we can only do it for parens.
7424 ;; The cdr might hold a new paren-class info rather than
7425 ;; a matching-char info, in which case the two CDRs
7426 ;; should match.
7430 "Function to check parentheses mismatches.
7431 The function takes two arguments (START and END) where START is the
7432 position just before the opening token and END is the position right after.
7433 START can be nil, if it was not found.
7440 ol)
7444 "Momentarily highlight the beginning of the sexp before point."
7447 blink-matching-paren)
7457 oldpos))
7465 ;; backward-sexp skips backward over prefix chars,
7466 ;; so move back to the matching paren.
7489 ;; Matching open within window, temporarily move to or highlight
7490 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7491 ;; is non-nil.
7508 ;; Show what precedes the open in its line, if anything.
7513 ;; Show what follows the open in its line, if anything.
7520 ;; Otherwise show the previous nonblank line,
7521 ;; if there is one.
7530 ;; Replace the newline and other whitespace with `...'.
7531 "..."
7533 ;; There is nothing to show except the char itself.
7536 "Matches %s"
7540 "Function called, if non-nil, whenever a close parenthesis is inserted.
7546 blink-paren-function
7549 ;; Verify an even number of quoting characters precede the close.
7550 ;; FIXME: Also check if this parenthesis closes a comment as
7551 ;; can happen in Pascal and SML.
7562 ;; Most likely, this hook is nil, so this arg doesn't matter,
7563 ;; but I use it as a reminder that this function usually
7564 ;; likes to be run after others since it does
7565 ;; `sit-for'. That's also the reason it get a `priority' prop
7566 ;; of 100.
7568 \f
7569 ;; This executes C-g typed while Emacs is waiting for a command.
7570 ;; Quitting out of a program does not go through here;
7571 ;; that happens in the QUIT macro at the C code level.
7573 "Signal a `quit' condition.
7574 During execution of Lisp code, this character causes a quit directly.
7575 At top-level, as an editor command, this simply beeps."
7577 ;; Avoid adding the region to the window selection.
7585 ;; Force the next redisplay cycle to remove the "Def" indicator from
7586 ;; all the mode lines.
7600 This command can exit an interactive command such as `query-replace',
7601 can clear out a prefix argument or a region,
7602 can get out of the minibuffer or other recursive edit,
7603 cancel the use of the current buffer (for special-purpose buffers),
7604 or go back to just one window (by deleting all but the selected window)."
7612 nil)
7623 "Play sound stored in FILE.
7624 VOLUME and DEVICE correspond to the keywords of the sound
7625 specification for `play-sound'."
7635 \f
7637 "Your preference for a mail reading package.
7638 This is used by some keybindings which support reading mail.
7639 See also `mail-user-agent' concerning sending mail."
7649 "Your preference for a mail composition package.
7650 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7651 outgoing email message. This variable lets you specify which
7652 mail-sending package you prefer.
7654 Valid values include:
7656 `message-user-agent' -- use the Message package.
7657 See Info node `(message)'.
7658 `sendmail-user-agent' -- use the Mail package.
7659 See Info node `(emacs)Sending Mail'.
7660 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7661 See Info node `(mh-e)'.
7662 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7663 paraphernalia if Gnus is running, particularly
7664 the Gcc: header for archiving.
7666 Additional valid symbols may be available; check with the author of
7667 your package for details. The function should return non-nil if it
7668 succeeds.
7670 See also `read-mail-command' concerning reading mail."
7673 message-user-agent)
7676 sendmail-user-agent)
7679 mh-e-user-agent)
7682 gnus-user-agent)
7688 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7689 If the value of `mail-user-agent' is the default, and the user
7690 appears to have customizations applying to the old default,
7691 `compose-mail' issues a warning."
7697 "If the buffer starts with a mail header, move point to the header's end.
7698 Otherwise, moves to `point-min'.
7699 The end of the header is the start of the next line, if there is one,
7700 else the end of the last line. This function obeys RFC822."
7706 ;; Used by Rmail (e.g., rmail-forward).
7708 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7712 switch-function yank-action send-actions
7713 return-action)
7714 "Start composing a mail message to send.
7715 This uses the user's chosen mail composition package
7716 as selected with the variable `mail-user-agent'.
7717 The optional arguments TO and SUBJECT specify recipients
7718 and the initial Subject field, respectively.
7720 OTHER-HEADERS is an alist specifying additional
7721 header fields. Elements look like (HEADER . VALUE) where both
7722 HEADER and VALUE are strings.
7724 CONTINUE, if non-nil, says to continue editing a message already
7725 being composed. Interactively, CONTINUE is the prefix argument.
7727 SWITCH-FUNCTION, if non-nil, is a function to use to
7728 switch to and display the buffer used for mail composition.
7730 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7731 to insert the raw text of the message being replied to.
7732 It has the form (FUNCTION . ARGS). The user agent will apply
7733 FUNCTION to ARGS, to insert the raw text of the original message.
7734 \(The user agent will also run `mail-citation-hook', *after* the
7735 original text has been inserted in this way.)
7737 SEND-ACTIONS is a list of actions to call when the message is sent.
7738 Each action has the form (FUNCTION . ARGS).
7740 RETURN-ACTION, if non-nil, is an action for returning to the
7741 caller. It has the form (FUNCTION . ARGS). The function is
7742 called after the mail has been sent or put aside, and the mail
7743 buffer buried."
7747 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7748 ;; from sendmail-user-agent to message-user-agent. Some users may
7749 ;; encounter incompatibilities. This hack tries to detect problems
7750 ;; and warn about them.
7755 mail-yank-hooks mail-archive-file-name
7756 mail-default-reply-to mail-mailing-lists
7757 mail-self-blind))
7764 The default mail mode is now Message mode.
7765 You have the following Mail mode variable%s customized:
7767 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7774 yank-action send-actions return-action)))
7777 yank-action send-actions
7778 return-action)
7782 'switch-to-buffer-other-window yank-action send-actions
7783 return-action))
7786 yank-action send-actions
7787 return-action)
7791 'switch-to-buffer-other-frame yank-action send-actions
7792 return-action))
7794 \f
7796 "History of values entered with `set-variable'.
7798 Maximum length of the history list is determined by the value
7802 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7803 VARIABLE should be a user option variable name, a Lisp variable
7804 meant to be customized by users. You should enter VALUE in Lisp syntax,
7805 so if you want VALUE to be a string, you must surround it with doublequotes.
7806 VALUE is used literally, not evaluated.
7808 If VARIABLE has a `variable-interactive' property, that is used as if
7809 it were the arg to `interactive' (which see) to interactively read VALUE.
7811 If VARIABLE has been defined with `defcustom', then the type information
7812 in the definition is used to check that VALUE is valid.
7814 Note that this function is at heart equivalent to the basic `set' function.
7815 For a variable defined with `defcustom', it does not pay attention to
7816 any :set property that the variable might have (if you want that, use
7819 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7824 default-var)
7840 var obsolete)
7843 ;; Use VAR's `variable-interactive' property
7844 ;; as an interactive spec for prompting.
7847 arg))
7849 read-expression-map t
7850 'set-variable-value-history
7859 ;; Match with custom type.
7871 ;; Force a thorough redisplay for the case that the variable
7872 ;; has an effect on the display, like `tab-width' has.
7874 \f
7875 ;; Define the major mode for lists of completions.
7885 (define-key map [right] 'next-completion)
7887 (define-key map [backtab] 'previous-completion)
7888 (define-key map "q" 'quit-window)
7889 (define-key map "z" 'kill-this-buffer)
7890 map)
7891 "Local map for completion list buffers.")
7893 ;; Completion mode is suitable only for specially formatted data.
7894 (put 'completion-list-mode 'mode-class 'special)
7896 (defvar completion-reference-buffer nil
7897 "Record the buffer that was current when the completion list was requested.
7898 This is a local variable in the completion list buffer.
7899 Initial value is nil to avoid some compiler warnings.")
7901 (defvar completion-no-auto-exit nil
7902 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7903 This also applies to other functions such as `choose-completion'.")
7905 (defvar completion-base-position nil
7906 "Position of the base of the text corresponding to the shown completions.
7907 This variable is used in the *Completions* buffers.
7908 Its value is a list of the form (START END) where START is the place
7909 where the completion should be inserted and END (if non-nil) is the end
7910 of the text to replace. If END is nil, point is used instead.")
7912 (defvar completion-list-insert-choice-function #'completion--replace
7913 "Function to use to insert the text chosen in *Completions*.
7914 Called with three arguments (BEG END TEXT), it should replace the text
7915 between BEG and END with TEXT. Expected to be set buffer-locally
7916 in the *Completions* buffer.")
7918 (defvar completion-base-size nil
7919 "Number of chars before point not involved in completion.
7920 This is a local variable in the completion list buffer.
7921 It refers to the chars in the minibuffer if completing in the
7922 minibuffer, or in `completion-reference-buffer' otherwise.
7923 Only characters in the field at point are included.
7925 If nil, Emacs determines which part of the tail end of the
7926 buffer's text is involved in completion by comparing the text
7927 directly.")
7928 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7930 (defun delete-completion-window ()
7931 "Delete the completion list window.
7932 Go to the window from which completion was requested."
7933 (interactive)
7934 (let ((buf completion-reference-buffer))
7935 (if (one-window-p t)
7936 (if (window-dedicated-p) (delete-frame))
7937 (delete-window (selected-window))
7938 (if (get-buffer-window buf)
7939 (select-window (get-buffer-window buf))))))
7941 (defun previous-completion (n)
7942 "Move to the previous item in the completion list."
7943 (interactive "p")
7944 (next-completion (- n)))
7946 (defun next-completion (n)
7947 "Move to the next item in the completion list.
7948 With prefix argument N, move N items (negative N means move backward)."
7949 (interactive "p")
7950 (let ((beg (point-min)) (end (point-max)))
7951 (while (and (> n 0) (not (eobp)))
7952 ;; If in a completion, move to the end of it.
7953 (when (get-text-property (point) 'mouse-face)
7954 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7955 ;; Move to start of next one.
7956 (unless (get-text-property (point) 'mouse-face)
7957 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7958 (setq n (1- n)))
7959 (while (and (< n 0) (not (bobp)))
7960 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7961 ;; If in a completion, move to the start of it.
7962 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7963 (goto-char (previous-single-property-change
7964 (point) 'mouse-face nil beg)))
7965 ;; Move to end of the previous completion.
7966 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7967 (goto-char (previous-single-property-change
7968 (point) 'mouse-face nil beg)))
7969 ;; Move to the start of that one.
7970 (goto-char (previous-single-property-change
7971 (point) 'mouse-face nil beg))
7972 (setq n (1+ n))))))
7974 (defun choose-completion (&optional event)
7975 "Choose the completion at point.
7976 If EVENT, use EVENT's position to determine the starting position."
7977 (interactive (list last-nonmenu-event))
7978 ;; In case this is run via the mouse, give temporary modes such as
7979 ;; isearch a chance to turn off.
7980 (run-hooks 'mouse-leave-buffer-hook)
7981 (with-current-buffer (window-buffer (posn-window (event-start event)))
7982 (let ((buffer completion-reference-buffer)
7983 (base-size completion-base-size)
7984 (base-position completion-base-position)
7985 (insert-function completion-list-insert-choice-function)
7986 (choice
7987 (save-excursion
7988 (goto-char (posn-point (event-start event)))
7989 (let (beg end)
7990 (cond
7991 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7992 (setq end (point) beg (1+ (point))))
7993 ((and (not (bobp))
7994 (get-text-property (1- (point)) 'mouse-face))
7995 (setq end (1- (point)) beg (point)))
7996 (t (error "No completion here")))
7997 (setq beg (previous-single-property-change beg 'mouse-face))
7998 (setq end (or (next-single-property-change end 'mouse-face)
7999 (point-max)))
8000 (buffer-substring-no-properties beg end)))))
8002 (unless (buffer-live-p buffer)
8003 (error "Destination buffer is dead"))
8004 (quit-window nil (posn-window (event-start event)))
8006 (with-current-buffer buffer
8007 (choose-completion-string
8008 choice buffer
8009 (or base-position
8010 (when base-size
8011 ;; Someone's using old completion code that doesn't know
8012 ;; about base-position yet.
8013 (list (+ base-size (field-beginning))))
8014 ;; If all else fails, just guess.
8015 (list (choose-completion-guess-base-position choice)))
8016 insert-function)))))
8018 ;; Delete the longest partial match for STRING
8019 ;; that can be found before POINT.
8020 (defun choose-completion-guess-base-position (string)
8021 (save-excursion
8022 (let ((opoint (point))
8023 len)
8024 ;; Try moving back by the length of the string.
8025 (goto-char (max (- (point) (length string))
8026 (minibuffer-prompt-end)))
8027 ;; See how far back we were actually able to move. That is the
8028 ;; upper bound on how much we can match and delete.
8029 (setq len (- opoint (point)))
8030 (if completion-ignore-case
8031 (setq string (downcase string)))
8032 (while (and (> len 0)
8033 (let ((tail (buffer-substring (point) opoint)))
8034 (if completion-ignore-case
8035 (setq tail (downcase tail)))
8036 (not (string= tail (substring string 0 len)))))
8037 (setq len (1- len))
8038 (forward-char 1))
8039 (point))))
8041 (defun choose-completion-delete-max-match (string)
8042 (declare (obsolete choose-completion-guess-base-position "23.2"))
8043 (delete-region (choose-completion-guess-base-position string) (point)))
8045 (defvar choose-completion-string-functions nil
8046 "Functions that may override the normal insertion of a completion choice.
8047 These functions are called in order with three arguments:
8048 CHOICE - the string to insert in the buffer,
8049 BUFFER - the buffer in which the choice should be inserted,
8050 BASE-POSITION - where to insert the completion.
8052 If a function in the list returns non-nil, that function is supposed
8053 to have inserted the CHOICE in the BUFFER, and possibly exited
8054 the minibuffer; no further functions will be called.
8056 If all functions in the list return nil, that means to use
8057 the default method of inserting the completion in BUFFER.")
8059 (defun choose-completion-string (choice &optional
8060 buffer base-position insert-function)
8061 "Switch to BUFFER and insert the completion choice CHOICE.
8062 BASE-POSITION says where to insert the completion.
8063 INSERT-FUNCTION says how to insert the completion and falls
8064 back on `completion-list-insert-choice-function' when nil."
8066 ;; If BUFFER is the minibuffer, exit the minibuffer
8067 ;; unless it is reading a file name and CHOICE is a directory,
8068 ;; or completion-no-auto-exit is non-nil.
8070 ;; Some older code may call us passing `base-size' instead of
8071 ;; `base-position'. It's difficult to make any use of `base-size',
8072 ;; so we just ignore it.
8073 (unless (consp base-position)
8074 (message "Obsolete `base-size' passed to choose-completion-string")
8075 (setq base-position nil))
8077 (let* ((buffer (or buffer completion-reference-buffer))
8078 (mini-p (minibufferp buffer)))
8079 ;; If BUFFER is a minibuffer, barf unless it's the currently
8080 ;; active minibuffer.
8081 (if (and mini-p
8082 (not (and (active-minibuffer-window)
8083 (equal buffer
8084 (window-buffer (active-minibuffer-window))))))
8085 (error "Minibuffer is not active for completion")
8086 ;; Set buffer so buffer-local choose-completion-string-functions works.
8087 (set-buffer buffer)
8088 (unless (run-hook-with-args-until-success
8089 'choose-completion-string-functions
8090 ;; The fourth arg used to be `mini-p' but was useless
8091 ;; (since minibufferp can be used on the `buffer' arg)
8092 ;; and indeed unused. The last used to be `base-size', so we
8093 ;; keep it to try and avoid breaking old code.
8094 choice buffer base-position nil)
8095 ;; This remove-text-properties should be unnecessary since `choice'
8096 ;; comes from buffer-substring-no-properties.
8097 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8098 ;; Insert the completion into the buffer where it was requested.
8099 (funcall (or insert-function completion-list-insert-choice-function)
8100 (or (car base-position) (point))
8101 (or (cadr base-position) (point))
8102 choice)
8103 ;; Update point in the window that BUFFER is showing in.
8104 (let ((window (get-buffer-window buffer t)))
8105 (set-window-point window (point)))
8106 ;; If completing for the minibuffer, exit it with this choice.
8107 (and (not completion-no-auto-exit)
8108 (minibufferp buffer)
8109 minibuffer-completion-table
8110 ;; If this is reading a file name, and the file name chosen
8111 ;; is a directory, don't exit the minibuffer.
8112 (let* ((result (buffer-substring (field-beginning) (point)))
8113 (bounds
8114 (completion-boundaries result minibuffer-completion-table
8115 minibuffer-completion-predicate
8116 "")))
8117 (if (eq (car bounds) (length result))
8118 ;; The completion chosen leads to a new set of completions
8119 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8120 (let ((mini (active-minibuffer-window)))
8121 (select-window mini)
8122 (when minibuffer-auto-raise
8123 (raise-frame (window-frame mini))))
8124 (exit-minibuffer))))))))
8126 (define-derived-mode completion-list-mode nil "Completion List"
8127 "Major mode for buffers showing lists of possible completions.
8129 to select the completion near point.
8130 Or click to select one with the mouse.
8133 (set (make-local-variable 'completion-base-size) nil))
8135 (defun completion-list-mode-finish ()
8136 "Finish setup of the completions buffer.
8137 Called from `temp-buffer-show-hook'."
8138 (when (eq major-mode 'completion-list-mode)
8139 (setq buffer-read-only t)))
8141 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8144 ;; Variables and faces used in `completion-setup-function'.
8146 (defcustom completion-show-help t
8147 "Non-nil means show help message in *Completions* buffer."
8148 :type 'boolean
8149 :version "22.1"
8150 :group 'completion)
8152 ;; This function goes in completion-setup-hook, so that it is called
8153 ;; after the text of the completion list buffer is written.
8154 (defun completion-setup-function ()
8155 (let* ((mainbuf (current-buffer))
8156 (base-dir
8157 ;; FIXME: This is a bad hack. We try to set the default-directory
8158 ;; in the *Completions* buffer so that the relative file names
8159 ;; displayed there can be treated as valid file names, independently
8160 ;; from the completion context. But this suffers from many problems:
8161 ;; - It's not clear when the completions are file names. With some
8162 ;; completion tables (e.g. bzr revision specs), the listed
8163 ;; completions can mix file names and other things.
8164 ;; - It doesn't pay attention to possible quoting.
8165 ;; - With fancy completion styles, the code below will not always
8166 ;; find the right base directory.
8167 (if minibuffer-completing-file-name
8168 (file-name-as-directory
8169 (expand-file-name
8170 (buffer-substring (minibuffer-prompt-end)
8171 (- (point) (or completion-base-size 0))))))))
8172 (with-current-buffer standard-output
8173 (let ((base-size completion-base-size) ;Read before killing localvars.
8174 (base-position completion-base-position)
8175 (insert-fun completion-list-insert-choice-function))
8176 (completion-list-mode)
8177 (set (make-local-variable 'completion-base-size) base-size)
8178 (set (make-local-variable 'completion-base-position) base-position)
8179 (set (make-local-variable 'completion-list-insert-choice-function)
8180 insert-fun))
8181 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8182 (if base-dir (setq default-directory base-dir))
8183 ;; Maybe insert help string.
8184 (when completion-show-help
8185 (goto-char (point-min))
8186 (if (display-mouse-p)
8188 (insert (substitute-command-keys
8192 (add-hook 'completion-setup-hook 'completion-setup-function)
8194 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8195 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8197 (defun switch-to-completions ()
8198 "Select the completion list window."
8199 (interactive)
8200 (let ((window (or (get-buffer-window "*Completions*" 0)
8201 ;; Make sure we have a completions window.
8202 (progn (minibuffer-completion-help)
8203 (get-buffer-window "*Completions*" 0)))))
8204 (when window
8205 (select-window window)
8206 ;; In the new buffer, go to the first completion.
8207 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8208 (when (bobp)
8209 (next-completion 1)))))
8210 \f
8211 ;;; Support keyboard commands to turn on various modifiers.
8213 ;; These functions -- which are not commands -- each add one modifier
8214 ;; to the following event.
8216 (defun event-apply-alt-modifier (_ignore-prompt)
8219 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8220 (defun event-apply-super-modifier (_ignore-prompt)
8223 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8224 (defun event-apply-hyper-modifier (_ignore-prompt)
8227 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8228 (defun event-apply-shift-modifier (_ignore-prompt)
8231 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8232 (defun event-apply-control-modifier (_ignore-prompt)
8235 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8236 (defun event-apply-meta-modifier (_ignore-prompt)
8239 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8241 (defun event-apply-modifier (event symbol lshiftby prefix)
8242 "Apply a modifier flag to event EVENT.
8243 SYMBOL is the name of this modifier, as a symbol.
8244 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8245 PREFIX is the string that represents this modifier in an event type symbol."
8246 (if (numberp event)
8247 (cond ((eq symbol 'control)
8248 (if (and (<= (downcase event) ?z)
8249 (>= (downcase event) ?a))
8250 (- (downcase event) ?a -1)
8251 (if (and (<= (downcase event) ?Z)
8252 (>= (downcase event) ?A))
8253 (- (downcase event) ?A -1)
8254 (logior (lsh 1 lshiftby) event))))
8255 ((eq symbol 'shift)
8256 (if (and (<= (downcase event) ?z)
8257 (>= (downcase event) ?a))
8258 (upcase event)
8259 (logior (lsh 1 lshiftby) event)))
8260 (t
8261 (logior (lsh 1 lshiftby) event)))
8262 (if (memq symbol (event-modifiers event))
8263 event
8264 (let ((event-type (if (symbolp event) event (car event))))
8265 (setq event-type (intern (concat prefix (symbol-name event-type))))
8266 (if (symbolp event)
8267 event-type
8268 (cons event-type (cdr event)))))))
8270 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8271 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8272 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8273 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8274 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8275 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8276 \f
8277 ;;;; Keypad support.
8279 ;; Make the keypad keys act like ordinary typing keys. If people add
8280 ;; bindings for the function key symbols, then those bindings will
8281 ;; override these, so this shouldn't interfere with any existing
8282 ;; bindings.
8284 ;; Also tell read-char how to handle these keys.
8285 (mapc
8286 (lambda (keypad-normal)
8287 (let ((keypad (nth 0 keypad-normal))
8288 (normal (nth 1 keypad-normal)))
8289 (put keypad 'ascii-character normal)
8290 (define-key function-key-map (vector keypad) (vector normal))))
8291 ;; See also kp-keys bound in bindings.el.
8292 '((kp-space ?\s)
8295 (kp-separator ?,)
8296 (kp-equal ?=)
8297 ;; Do the same for various keys that are represented as symbols under
8298 ;; GUIs but naturally correspond to characters.
8299 (backspace 127)
8300 (delete 127)
8303 (clear ?\C-l)
8304 (return ?\C-m)
8305 (escape ?\e)
8306 ))
8307 \f
8308 ;;;;
8309 ;;;; forking a twin copy of a buffer.
8310 ;;;;
8312 (defvar clone-buffer-hook nil
8313 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8315 (defvar clone-indirect-buffer-hook nil
8316 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8318 (defun clone-process (process &optional newname)
8319 "Create a twin copy of PROCESS.
8320 If NEWNAME is nil, it defaults to PROCESS' name;
8321 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8322 If PROCESS is associated with a buffer, the new process will be associated
8323 with the current buffer instead.
8324 Returns nil if PROCESS has already terminated."
8325 (setq newname (or newname (process-name process)))
8327 (setq newname (substring newname 0 (match-beginning 0))))
8328 (when (memq (process-status process) '(run stop open))
8329 (let* ((process-connection-type (process-tty-name process))
8330 (new-process
8331 (if (memq (process-status process) '(open))
8332 (let ((args (process-contact process t)))
8333 (setq args (plist-put args :name newname))
8334 (setq args (plist-put args :buffer
8335 (if (process-buffer process)
8336 (current-buffer))))
8337 (apply 'make-network-process args))
8338 (apply 'start-process newname
8339 (if (process-buffer process) (current-buffer))
8340 (process-command process)))))
8341 (set-process-query-on-exit-flag
8342 new-process (process-query-on-exit-flag process))
8343 (set-process-inherit-coding-system-flag
8344 new-process (process-inherit-coding-system-flag process))
8345 (set-process-filter new-process (process-filter process))
8346 (set-process-sentinel new-process (process-sentinel process))
8347 (set-process-plist new-process (copy-sequence (process-plist process)))
8348 new-process)))
8350 ;; things to maybe add (currently partly covered by `funcall mode'):
8351 ;; - syntax-table
8352 ;; - overlays
8353 (defun clone-buffer (&optional newname display-flag)
8354 "Create and return a twin copy of the current buffer.
8355 Unlike an indirect buffer, the new buffer can be edited
8356 independently of the old one (if it is not read-only).
8357 NEWNAME is the name of the new buffer. It may be modified by
8358 adding or incrementing <N> at the end as necessary to create a
8359 unique buffer name. If nil, it defaults to the name of the
8360 current buffer, with the proper suffix. If DISPLAY-FLAG is
8361 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8362 clone a file-visiting buffer, or a buffer whose major mode symbol
8363 has a non-nil `no-clone' property, results in an error.
8365 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8366 current buffer with appropriate suffix. However, if a prefix
8367 argument is given, then the command prompts for NEWNAME in the
8368 minibuffer.
8370 This runs the normal hook `clone-buffer-hook' in the new buffer
8371 after it has been set up properly in other respects."
8372 (interactive
8373 (progn
8374 (if buffer-file-name
8375 (error "Cannot clone a file-visiting buffer"))
8376 (if (get major-mode 'no-clone)
8377 (error "Cannot clone a buffer in %s mode" mode-name))
8378 (list (if current-prefix-arg
8379 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8380 t)))
8381 (if buffer-file-name
8382 (error "Cannot clone a file-visiting buffer"))
8383 (if (get major-mode 'no-clone)
8384 (error "Cannot clone a buffer in %s mode" mode-name))
8385 (setq newname (or newname (buffer-name)))
8387 (setq newname (substring newname 0 (match-beginning 0))))
8388 (let ((buf (current-buffer))
8389 (ptmin (point-min))
8390 (ptmax (point-max))
8391 (pt (point))
8392 (mk (if mark-active (mark t)))
8393 (modified (buffer-modified-p))
8394 (mode major-mode)
8395 (lvars (buffer-local-variables))
8396 (process (get-buffer-process (current-buffer)))
8397 (new (generate-new-buffer (or newname (buffer-name)))))
8398 (save-restriction
8399 (widen)
8400 (with-current-buffer new
8401 (insert-buffer-substring buf)))
8402 (with-current-buffer new
8403 (narrow-to-region ptmin ptmax)
8404 (goto-char pt)
8405 (if mk (set-mark mk))
8406 (set-buffer-modified-p modified)
8408 ;; Clone the old buffer's process, if any.
8409 (when process (clone-process process))
8411 ;; Now set up the major mode.
8412 (funcall mode)
8414 ;; Set up other local variables.
8415 (mapc (lambda (v)
8416 (condition-case () ;in case var is read-only
8417 (if (symbolp v)
8418 (makunbound v)
8419 (set (make-local-variable (car v)) (cdr v)))
8420 (error nil)))
8421 lvars)
8423 ;; Run any hooks (typically set up by the major mode
8424 ;; for cloning to work properly).
8425 (run-hooks 'clone-buffer-hook))
8426 (if display-flag
8427 ;; Presumably the current buffer is shown in the selected frame, so
8428 ;; we want to display the clone elsewhere.
8429 (let ((same-window-regexps nil)
8430 (same-window-buffer-names))
8431 (pop-to-buffer new)))
8432 new))
8435 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8436 "Create an indirect buffer that is a twin copy of the current buffer.
8438 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8439 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8440 or if not called with a prefix arg, NEWNAME defaults to the current
8441 buffer's name. The name is modified by adding a `<N>' suffix to it
8442 or by incrementing the N in an existing suffix. Trying to clone a
8443 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8444 property results in an error.
8446 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8447 This is always done when called interactively.
8449 Optional third arg NORECORD non-nil means do not put this buffer at the
8450 front of the list of recently selected ones.
8452 Returns the newly created indirect buffer."
8453 (interactive
8454 (progn
8455 (if (get major-mode 'no-clone-indirect)
8456 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8457 (list (if current-prefix-arg
8458 (read-buffer "Name of indirect buffer: " (current-buffer)))
8459 t)))
8460 (if (get major-mode 'no-clone-indirect)
8461 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8462 (setq newname (or newname (buffer-name)))
8464 (setq newname (substring newname 0 (match-beginning 0))))
8465 (let* ((name (generate-new-buffer-name newname))
8466 (buffer (make-indirect-buffer (current-buffer) name t)))
8467 (with-current-buffer buffer
8468 (run-hooks 'clone-indirect-buffer-hook))
8469 (when display-flag
8470 (pop-to-buffer buffer nil norecord))
8471 buffer))
8474 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8475 "Like `clone-indirect-buffer' but display in another window."
8476 (interactive
8477 (progn
8478 (if (get major-mode 'no-clone-indirect)
8479 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8480 (list (if current-prefix-arg
8481 (read-buffer "Name of indirect buffer: " (current-buffer)))
8482 t)))
8483 (let ((pop-up-windows t))
8484 (clone-indirect-buffer newname display-flag norecord)))
8486 \f
8487 ;;; Handling of Backspace and Delete keys.
8489 (defcustom normal-erase-is-backspace 'maybe
8490 "Set the default behavior of the Delete and Backspace keys.
8492 If set to t, Delete key deletes forward and Backspace key deletes
8493 backward.
8495 If set to nil, both Delete and Backspace keys delete backward.
8497 If set to `maybe' (which is the default), Emacs automatically
8498 selects a behavior. On window systems, the behavior depends on
8499 the keyboard used. If the keyboard has both a Backspace key and
8500 a Delete key, and both are mapped to their usual meanings, the
8501 option's default value is set to t, so that Backspace can be used
8502 to delete backward, and Delete can be used to delete forward.
8504 If not running under a window system, customizing this option
8505 accomplishes a similar effect by mapping C-h, which is usually
8506 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8507 via `keyboard-translate'. The former functionality of C-h is
8508 available on the F1 key. You should probably not use this
8509 setting if you don't have both Backspace, Delete and F1 keys.
8511 Setting this variable with setq doesn't take effect. Programmatically,
8512 call `normal-erase-is-backspace-mode' (which see) instead."
8513 :type '(choice (const :tag "Off" nil)
8514 (const :tag "Maybe" maybe)
8515 (other :tag "On" t))
8516 :group 'editing-basics
8517 :version "21.1"
8518 :set (lambda (symbol value)
8519 ;; The fboundp is because of a problem with :set when
8520 ;; dumping Emacs. It doesn't really matter.
8521 (if (fboundp 'normal-erase-is-backspace-mode)
8522 (normal-erase-is-backspace-mode (or value 0))
8523 (set-default symbol value))))
8525 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8526 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8527 (unless frame (setq frame (selected-frame)))
8528 (with-selected-frame frame
8529 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8530 (normal-erase-is-backspace-mode
8531 (if (if (eq normal-erase-is-backspace 'maybe)
8532 (and (not noninteractive)
8533 (or (memq system-type '(ms-dos windows-nt))
8534 (memq window-system '(w32 ns))
8535 (and (memq window-system '(x))
8536 (fboundp 'x-backspace-delete-keys-p)
8537 (x-backspace-delete-keys-p))
8538 ;; If the terminal Emacs is running on has erase char
8539 ;; set to ^H, use the Backspace key for deleting
8540 ;; backward, and the Delete key for deleting forward.
8541 (and (null window-system)
8542 (eq tty-erase-char ?\^H))))
8543 normal-erase-is-backspace)
8544 1 0)))))
8546 (define-minor-mode normal-erase-is-backspace-mode
8547 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8548 With a prefix argument ARG, enable this feature if ARG is
8549 positive, and disable it otherwise. If called from Lisp, enable
8550 the mode if ARG is omitted or nil.
8552 On window systems, when this mode is on, Delete is mapped to C-d
8553 and Backspace is mapped to DEL; when this mode is off, both
8554 Delete and Backspace are mapped to DEL. (The remapping goes via
8555 `local-function-key-map', so binding Delete or Backspace in the
8556 global or local keymap will override that.)
8558 In addition, on window systems, the bindings of C-Delete, M-Delete,
8559 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8560 the global keymap in accordance with the functionality of Delete and
8561 Backspace. For example, if Delete is remapped to C-d, which deletes
8562 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8563 to DEL, which deletes backward, C-Delete is bound to
8564 `backward-kill-word'.
8566 If not running on a window system, a similar effect is accomplished by
8567 remapping C-h (normally produced by the Backspace key) and DEL via
8568 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8569 to C-d; if it's off, the keys are not remapped.
8571 When not running on a window system, and this mode is turned on, the
8572 former functionality of C-h is available on the F1 key. You should
8573 probably not turn on this mode on a text-only terminal if you don't
8574 have both Backspace, Delete and F1 keys.
8576 See also `normal-erase-is-backspace'."
8577 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8578 . (lambda (v)
8579 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8580 (if v 1 0))))
8581 (let ((enabled (eq 1 (terminal-parameter
8582 nil 'normal-erase-is-backspace))))
8584 (cond ((or (memq window-system '(x w32 ns pc))
8585 (memq system-type '(ms-dos windows-nt)))
8586 (let ((bindings
8587 `(([M-delete] [M-backspace])
8588 ([C-M-delete] [C-M-backspace])
8589 ([?\e C-delete] [?\e C-backspace]))))
8591 (if enabled
8592 (progn
8593 (define-key local-function-key-map [delete] [deletechar])
8594 (define-key local-function-key-map [kp-delete] [deletechar])
8595 (define-key local-function-key-map [backspace] [?\C-?])
8596 (dolist (b bindings)
8597 ;; Not sure if input-decode-map is really right, but
8598 ;; keyboard-translate-table (used below) only works
8599 ;; for integer events, and key-translation-table is
8600 ;; global (like the global-map, used earlier).
8601 (define-key input-decode-map (car b) nil)
8602 (define-key input-decode-map (cadr b) nil)))
8603 (define-key local-function-key-map [delete] [?\C-?])
8604 (define-key local-function-key-map [kp-delete] [?\C-?])
8605 (define-key local-function-key-map [backspace] [?\C-?])
8606 (dolist (b bindings)
8607 (define-key input-decode-map (car b) (cadr b))
8608 (define-key input-decode-map (cadr b) (car b))))))
8609 (t
8610 (if enabled
8611 (progn
8612 (keyboard-translate ?\C-h ?\C-?)
8613 (keyboard-translate ?\C-? ?\C-d))
8614 (keyboard-translate ?\C-h ?\C-h)
8615 (keyboard-translate ?\C-? ?\C-?))))
8617 (if (called-interactively-p 'interactive)
8618 (message "Delete key deletes %s"
8619 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8620 "forward" "backward")))))
8621 \f
8622 (defvar vis-mode-saved-buffer-invisibility-spec nil
8623 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8625 (define-minor-mode read-only-mode
8626 "Change whether the current buffer is read-only.
8627 With prefix argument ARG, make the buffer read-only if ARG is
8628 positive, otherwise make it writable. If buffer is read-only
8629 and `view-read-only' is non-nil, enter view mode.
8631 Do not call this from a Lisp program unless you really intend to
8633 possibly enabling or disabling View mode. Also, note that this
8634 command works by setting the variable `buffer-read-only', which
8635 does not affect read-only regions caused by text properties. To
8636 ignore read-only status in a Lisp program (whether due to text
8637 properties or buffer state), bind `inhibit-read-only' temporarily
8638 to a non-nil value."
8639 :variable buffer-read-only
8640 (cond
8641 ((and (not buffer-read-only) view-mode)
8642 (View-exit-and-edit)
8643 (make-local-variable 'view-read-only)
8644 (setq view-read-only t)) ; Must leave view mode.
8645 ((and buffer-read-only view-read-only
8646 ;; If view-mode is already active, `view-mode-enter' is a nop.
8647 (not view-mode)
8648 (not (eq (get major-mode 'mode-class) 'special)))
8649 (view-mode-enter))))
8651 (define-minor-mode visible-mode
8652 "Toggle making all invisible text temporarily visible (Visible mode).
8653 With a prefix argument ARG, enable Visible mode if ARG is
8654 positive, and disable it otherwise. If called from Lisp, enable
8655 the mode if ARG is omitted or nil.
8657 This mode works by saving the value of `buffer-invisibility-spec'
8658 and setting it to nil."
8659 :lighter " Vis"
8660 :group 'editing-basics
8661 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8662 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8663 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8664 (when visible-mode
8665 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8666 buffer-invisibility-spec)
8667 (setq buffer-invisibility-spec nil)))
8668 \f
8669 (defvar messages-buffer-mode-map
8670 (let ((map (make-sparse-keymap)))
8671 (set-keymap-parent map special-mode-map)
8672 (define-key map "g" nil) ; nothing to revert
8673 map))
8675 (define-derived-mode messages-buffer-mode special-mode "Messages"
8678 (defun messages-buffer ()
8680 If it does not exist, create and it switch it to `messages-buffer-mode'."
8681 (or (get-buffer "*Messages*")
8682 (with-current-buffer (get-buffer-create "*Messages*")
8683 (messages-buffer-mode)
8684 (current-buffer))))
8686 \f
8687 ;; Minibuffer prompt stuff.
8689 ;;(defun minibuffer-prompt-modification (start end)
8690 ;; (error "You cannot modify the prompt"))
8691 ;;
8692 ;;
8693 ;;(defun minibuffer-prompt-insertion (start end)
8694 ;; (let ((inhibit-modification-hooks t))
8695 ;; (delete-region start end)
8696 ;; ;; Discard undo information for the text insertion itself
8697 ;; ;; and for the text deletion.above.
8698 ;; (when (consp buffer-undo-list)
8699 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8700 ;; (message "You cannot modify the prompt")))
8701 ;;
8702 ;;
8703 ;;(setq minibuffer-prompt-properties
8704 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8705 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8707 \f
8708 ;;;; Problematic external packages.
8710 ;; rms says this should be done by specifying symbols that define
8711 ;; versions together with bad values. This is therefore not as
8712 ;; flexible as it could be. See the thread:
8713 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8714 (defconst bad-packages-alist
8715 ;; Not sure exactly which semantic versions have problems.
8716 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8718 "The version of `semantic' loaded does not work in Emacs 22.
8719 It can cause constant high CPU load.
8720 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8721 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8722 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8723 ;; provided the `CUA-mode' feature. Since this is no longer true,
8724 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8725 (CUA-mode t nil
8726 "CUA-mode is now part of the standard GNU Emacs distribution,
8727 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8729 You have loaded an older version of CUA-mode which does not work
8730 correctly with this version of Emacs. You should remove the old
8731 version and use the one distributed with Emacs."))
8732 "Alist of packages known to cause problems in this version of Emacs.
8733 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8734 PACKAGE is either a regular expression to match file names, or a
8735 symbol (a feature name), like for `with-eval-after-load'.
8736 SYMBOL is either the name of a string variable, or t. Upon
8737 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8738 warning using STRING as the message.")
8740 (defun bad-package-check (package)
8741 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8742 (condition-case nil
8743 (let* ((list (assoc package bad-packages-alist))
8744 (symbol (nth 1 list)))
8745 (and list
8746 (boundp symbol)
8747 (or (eq symbol t)
8748 (and (stringp (setq symbol (eval symbol)))
8749 (string-match-p (nth 2 list) symbol)))
8750 (display-warning package (nth 3 list) :warning)))
8751 (error nil)))
8753 (dolist (elem bad-packages-alist)
8754 (let ((pkg (car elem)))
8755 (with-eval-after-load pkg
8756 (bad-package-check pkg))))
8758 \f
8759 ;;; Generic dispatcher commands
8761 ;; Macro `define-alternatives' is used to create generic commands.
8762 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8763 ;; that can have different alternative implementations where choosing
8764 ;; among them is exclusively a matter of user preference.
8766 ;; (define-alternatives COMMAND) creates a new interactive command
8767 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8768 ;; Typically, the user will not need to customize this variable; packages
8769 ;; wanting to add alternative implementations should use
8770 ;;
8771 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8773 (defmacro define-alternatives (command &rest customizations)
8774 "Define the new command `COMMAND'.
8776 The argument `COMMAND' should be a symbol.
8778 Running `M-x COMMAND RET' for the first time prompts for which
8779 alternative to use and records the selected command as a custom
8780 variable.
8782 Running `C-u M-x COMMAND RET' prompts again for an alternative
8783 and overwrites the previous choice.
8785 The variable `COMMAND-alternatives' contains an alist with
8786 alternative implementations of COMMAND. `define-alternatives'
8787 does not have any effect until this variable is set.
8789 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8790 `defcustom' keywords and values to add to the declaration of
8791 `COMMAND-alternatives' (typically :group and :version)."
8792 (let* ((command-name (symbol-name command))
8793 (varalt-name (concat command-name "-alternatives"))
8794 (varalt-sym (intern varalt-name))
8795 (varimp-sym (intern (concat command-name "--implementation"))))
8796 `(progn
8798 (defcustom ,varalt-sym nil
8799 ,(format "Alist of alternative implementations for the `%s' command.
8801 Each entry must be a pair (ALTNAME . ALTFUN), where:
8802 ALTNAME - The name shown at user to describe the alternative implementation.
8803 ALTFUN - The function called to implement this alternative."
8804 command-name)
8805 :type '(alist :key-type string :value-type function)
8806 ,@customizations)
8808 (put ',varalt-sym 'definition-name ',command)
8809 (defvar ,varimp-sym nil "Internal use only.")
8811 (defun ,command (&optional arg)
8812 ,(format "Run generic command `%s'.
8813 If used for the first time, or with interactive ARG, ask the user which
8814 implementation to use for `%s'. The variable `%s'
8815 contains the list of implementations currently supported for this command."
8816 command-name command-name varalt-name)
8817 (interactive "P")
8818 (when (or arg (null ,varimp-sym))
8819 (let ((val (completing-read
8820 ,(format-message
8821 "Select implementation for command `%s': "
8822 command-name)
8823 ,varalt-sym nil t)))
8824 (unless (string-equal val "")
8825 (when (null ,varimp-sym)
8826 (message
8827 "Use C-u M-x %s RET`to select another implementation"
8828 ,command-name)
8829 (sit-for 3))
8830 (customize-save-variable ',varimp-sym
8831 (cdr (assoc-string val ,varalt-sym))))))
8832 (if ,varimp-sym
8833 (call-interactively ,varimp-sym)
8834 (message "%s" ,(format-message
8835 "No implementation selected for command `%s'"
8836 command-name)))))))
8838 \f
8839 ;;; Functions for changing capitalization that Do What I Mean
8840 (defun upcase-dwim (arg)
8841 "Upcase words in the region, if active; if not, upcase word at point.
8842 If the region is active, this function calls `upcase-region'.
8843 Otherwise, it calls `upcase-word', with prefix argument passed to it
8844 to upcase ARG words."
8845 (interactive "*p")
8846 (if (use-region-p)
8847 (upcase-region (region-beginning) (region-end))
8848 (upcase-word arg)))
8850 (defun downcase-dwim (arg)
8851 "Downcase words in the region, if active; if not, downcase word at point.
8852 If the region is active, this function calls `downcase-region'.
8853 Otherwise, it calls `downcase-word', with prefix argument passed to it
8854 to downcase ARG words."
8855 (interactive "*p")
8856 (if (use-region-p)
8857 (downcase-region (region-beginning) (region-end))
8858 (downcase-word arg)))
8860 (defun capitalize-dwim (arg)
8861 "Capitalize words in the region, if active; if not, capitalize word at point.
8862 If the region is active, this function calls `capitalize-region'.
8863 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8864 to capitalize ARG words."
8865 (interactive "*p")
8866 (if (use-region-p)
8867 (capitalize-region (region-beginning) (region-end))
8868 (capitalize-word arg)))
8870 \f
8872 (provide 'simple)
8874 ;;; simple.el ends here