| blob | f110c6f3267e9b0f07644c30da2f9726bd9914d6 |
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.
1736 ;; Some features, such as novice.el, rely on this-command-keys
1737 ;; including M-x COMMAND-NAME RET.
1740 ;; Normally `real-this-command' should never be changed, but here we really
1741 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1742 ;; binding" for <cmd>, so the command the user really wanted to run is
1743 ;; `function' and not `execute-extended-command'. The difference is
1744 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1748 ;; If enabled, show which key runs this command.
1749 ;; But first wait, and skip the message if there is input.
1751 ;; If this command displayed something in the echo area;
1752 ;; wait a few seconds, then display our suggestion message.
1753 ;; FIXME: Wait *after* running post-command-hook!
1754 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1755 ;; find a better answer anyway!
1765 ;; There's no binding for CMD. Let's try and find the shortest
1766 ;; string to use in M-x.
1767 ;; FIXME: Can be slow. Cache it maybe?
1774 function
1779 suggest-key-bindings
1783 ;; BEWARE: Called directly from the C code.
1784 "Execute CMD as an editor command.
1785 CMD must be a symbol that satisfies the `commandp' predicate.
1786 Optional second arg RECORD-FLAG non-nil
1787 means unconditionally put this command in the variable `command-history'.
1788 Otherwise, that is done only if an arg is read using the minibuffer.
1789 The argument KEYS specifies the value to use instead of (this-command-keys)
1790 when reading the arguments; if it is nil, (this-command-keys) is used.
1791 The argument SPECIAL, if non-nil, means that this command is executing
1792 a special event, so ignore the prefix argument and don't clear it."
1795 ;; FIXME: This should probably be done around
1796 ;; pre-command-hook rather than here!
1804 disabled-command-function)
1805 ;; FIXME: Weird calling convention!
1815 ;; If requested, place the macro in the command history. For
1816 ;; other sorts of commands, call-interactively takes care of this.
1819 ;; Don't keep command history around forever.
1825 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1833 \f
1835 "Default minibuffer history list.
1836 This is used for all minibuffer input
1837 except when an alternate history list is specified.
1839 Maximum length of the history list is determined by the value
1842 "Control whether history list elements are expressions or strings.
1843 If the value of this variable equals current minibuffer depth,
1844 they are expressions; otherwise they are strings.
1845 \(That convention is designed to do the right thing for
1852 "Text that was in this minibuffer before any history commands.
1853 This is nil if there have not yet been any history commands
1862 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1867 "Minibuffer history variables for which matching should ignore case.
1868 If a history variable is a member of this list, then the
1870 commands ignore case when searching it, regardless of `case-fold-search'."
1875 "Find the previous history element that matches REGEXP.
1876 \(Previous history elements refer to earlier actions.)
1877 With prefix argument N, search for Nth previous match.
1878 If N is negative, find the next or Nth next match.
1879 Normally, history elements are matched case-insensitively if
1880 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1881 makes the search case-sensitive.
1882 See also `minibuffer-history-case-insensitive-variables'."
1886 nil
1887 minibuffer-local-map
1888 nil
1889 'minibuffer-history-search-history
1891 ;; Use the last regexp specified, by default, if input is empty.
1896 regexp)
1906 ;; On some systems, ignore case for file names.
1908 minibuffer-history-case-insensitive-variables)
1909 t
1910 ;; Respect the user's setting for case-fold-search:
1911 case-fold-search)
1912 nil))
1913 prevpos
1914 match-string
1915 match-offset
1922 "No later matching history item"
1943 next-matching-history-element))
1947 "Find the next history element that matches REGEXP.
1948 \(The next history element refers to a more recent action.)
1949 With prefix argument N, search for Nth next match.
1950 If N is negative, find the previous or Nth previous match.
1951 Normally, history elements are matched case-insensitively if
1952 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1953 makes the search case-sensitive."
1957 nil
1958 minibuffer-local-map
1959 nil
1960 'minibuffer-history-search-history
1962 ;; Use the last regexp specified, by default, if input is empty.
1967 regexp)
1974 "Function run by `goto-history-element' before consuming default values.
1975 This is useful to dynamically add more elements to the list of default values
1976 when `goto-history-element' reaches the end of this list.
1977 Before calling this function `goto-history-element' sets the variable
1978 `minibuffer-default-add-done' to t, so it will call this function only
1979 once. In special cases, when this function needs to be called more
1980 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1984 "When nil, add more elements to the end of the list of default values.
1985 The value nil causes `goto-history-element' to add more elements to
1986 the list of defaults when it reaches the end of this list. It does
1992 "Return a list of all completions without the default value.
1993 This function is used to add all elements of the completion table to
1994 the end of the list of defaults just after the default value."
1997 minibuffer-completion-table
1998 minibuffer-completion-predicate)))
2004 "Puts element of the minibuffer history in the minibuffer.
2005 The argument NABS specifies the absolute history position."
2019 elt minibuffer-returned-to-present)
2026 "End of defaults; no next item"
2033 previous-history-element))
2045 minibuffer-default)))
2057 elt))
2061 "Puts next element of the minibuffer history in the minibuffer.
2062 With argument N, it uses the Nth following element."
2068 "Puts previous element of the minibuffer history in the minibuffer.
2069 With argument N, it uses the Nth previous element."
2075 "Move cursor vertically down ARG lines, or to the next history element.
2076 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2077 next element of the minibuffer history in the minibuffer."
2081 ;; Remember the original goal column of possibly multi-line input
2082 ;; excluding the length of the prompt on the first line.
2092 ;; Restore old position since `line-move-visual' moves point to
2093 ;; the end of the line when it fails to go to the next line.
2096 ;; Reset `temporary-goal-column' because a correct value is not
2097 ;; calculated when `next-line' above fails by bumping against
2098 ;; the bottom of the minibuffer (bug#22544).
2100 ;; Restore the original goal column on the last line
2101 ;; of possibly multi-line input.
2109 "Move cursor vertically up ARG lines, or to the previous history element.
2110 When point moves over the top line of multi-line minibuffer, puts ARGth
2111 previous element of the minibuffer history in the minibuffer."
2115 ;; Remember the original goal column of possibly multi-line input
2116 ;; excluding the length of the prompt on the first line.
2126 ;; Restore old position since `line-move-visual' moves point to
2127 ;; the beginning of the line when it fails to go to the previous line.
2130 ;; Reset `temporary-goal-column' because a correct value is not
2131 ;; calculated when `previous-line' above fails by bumping against
2132 ;; the top of the minibuffer (bug#22544).
2134 ;; Restore the original goal column on the first line
2135 ;; of possibly multi-line input.
2141 ;; Put the cursor at the end of the visual line instead of the
2142 ;; logical line, so the next `previous-line-or-history-element'
2143 ;; would move to the previous history element, not to a possible upper
2144 ;; visual line from the end of logical line in `line-move-visual' mode.
2146 ;; Since `end-of-visual-line' puts the cursor at the beginning
2147 ;; of the next visual line, move it one char back to the end
2148 ;; of the first visual line (bug#22544).
2152 "Get next history element which completes the minibuffer before the point.
2153 The contents of the minibuffer after the point are deleted, and replaced
2154 by the new completion."
2160 n)
2161 ;; next-matching-history-element always puts us at (point-min).
2162 ;; Move to the position we were at before changing the buffer contents.
2163 ;; This is still sensible, because the text before point has not changed.
2167 "\
2168 Get previous history element which completes the minibuffer before the point.
2169 The contents of the minibuffer after the point are deleted, and replaced
2170 by the new completion."
2174 ;; For compatibility with the old subr of the same name.
2176 "Return the display width of the minibuffer prompt.
2177 Return 0 if current buffer is not a minibuffer."
2178 ;; Return the width of everything before the field at the end of
2179 ;; the buffer; this should be 0 for normal buffers.
2181 \f
2182 ;; isearch minibuffer history
2189 "Set up a minibuffer for using isearch to search the minibuffer history.
2190 Intended to be added to `minibuffer-setup-hook'."
2202 "Clean up the minibuffer after terminating isearch in the minibuffer."
2207 "Return the proper search function, for isearch in minibuffer history."
2210 ;; Use standard functions to search within minibuffer text
2212 found)
2213 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2214 ;; searching forward. Lazy-highlight calls this lambda with the
2215 ;; bound arg, so skip the minibuffer prompt.
2219 ;; 1. First try searching in the initial minibuffer text
2222 noerror)
2223 ;; 2. If the above search fails, start putting next/prev history
2224 ;; elements in the minibuffer successively, and search the string
2225 ;; in them. Do this only when bound is nil (i.e. not while
2226 ;; lazy-highlighting search strings in the current minibuffer text).
2238 ;; After putting the next/prev history element, search
2239 ;; the string in them again, until next-history-element
2240 ;; or previous-history-element raises an error at the
2241 ;; beginning/end of history.
2244 ;; For backward search, don't search
2245 ;; in the minibuffer prompt
2247 noerror)))
2248 ;; Return point of the new search result
2250 ;; Return nil when next(prev)-history-element fails
2254 "Display the minibuffer history search prompt.
2255 If there are no search errors, this function displays an overlay with
2256 the isearch prompt which replaces the original minibuffer prompt.
2257 Otherwise, it displays the standard isearch message returned from
2258 the function `isearch-message'."
2260 ;; Use standard function `isearch-message' when not in the minibuffer,
2261 ;; or search fails, or has an error (like incomplete regexp).
2262 ;; This function overwrites minibuffer text with isearch message,
2263 ;; so it's possible to see what is wrong in the search string.
2265 ;; Otherwise, put the overlay with the standard isearch prompt over
2266 ;; the initial minibuffer prompt.
2275 ;; And clear any previous isearch message.
2279 "Wrap the minibuffer history search when search fails.
2280 Move point to the first history element for a forward search,
2281 or to the last history element for a backward search."
2282 ;; When `minibuffer-history-isearch-search' fails on reaching the
2283 ;; beginning/end of the history, wrap the search to the first/last
2284 ;; minibuffer history element.
2292 "Save a function restoring the state of minibuffer history search.
2293 Save `minibuffer-history-position' to the additional state parameter
2294 in the search status stack."
2300 "Restore the minibuffer history search state.
2301 Go to the history element by the absolute history position HIST-POS."
2304 \f
2305 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2309 "Table mapping redo records to the corresponding undo one.
2310 A redo record for undo-in-region maps to t.
2320 "Within a run of consecutive undo commands, list remaining to be undone.
2324 "Undo some previous changes.
2325 Repeat this command to undo more changes.
2326 A numeric ARG serves as a repeat count.
2328 In Transient Mark mode when the mark is active, only undo changes within
2330 as an argument limits undo to changes within the current region."
2332 ;; Make last-command indicate for the next command that this was an undo.
2333 ;; That way, another undo will undo more.
2334 ;; If we get to the end of the undo history and get an error,
2335 ;; another undo command will find the undo history empty
2336 ;; and will get another error. To begin undoing the undos,
2337 ;; you must type some other command.
2339 ;; For an indirect buffer, look in the base buffer for the
2340 ;; auto-save data.
2344 message)
2345 ;; If we get an error in undo-start,
2346 ;; the next command should not be a "consecutive undo".
2347 ;; So set `this-command' to something other than `undo'.
2352 ;; If something (a timer or filter?) changed the buffer
2353 ;; since the previous command, don't continue the undo seq.
2357 ;; If the last undo record made was made by undo
2358 ;; it shows nothing else happened in between.
2365 ;; get rid of initial undo boundary
2367 ;; If we got this far, the next command should be a consecutive undo.
2369 ;; Check to see whether we're hitting a redo record, and if
2370 ;; so, ask the user whether she wants to skip the redo/undo pair.
2378 ;; The equiv entry might point to another redo record if we have done
2379 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2387 ;; Record the fact that the just-generated undo records come from an
2388 ;; undo operation--that is, they are redo records.
2389 ;; In the ordinary case (not within a region), map the redo
2390 ;; record to the following undos.
2391 ;; I don't know how to do that in the undo-in-region case.
2393 ;; Strip any leading undo boundaries there might be, like we do
2394 ;; above when checking.
2398 ;; Prevent identity mapping. This can happen if
2399 ;; consecutive nils are erroneously in undo list.
2401 t
2402 pending-undo-list)
2403 undo-equiv-table))
2404 ;; Don't specify a position in the undo record for the undo command.
2405 ;; Instead, undoing this should move point to where the change is.
2424 ;; Record what the current undo list says,
2425 ;; so the next command can tell if the buffer was modified in between.
2429 ;; Display a message announcing success.
2434 "Make BUFFER stop keeping undo information.
2435 No argument or nil as argument means do this for the current buffer."
2441 "Undo some previous changes.
2442 Repeat this command to undo more changes.
2443 A numeric ARG serves as a repeat count.
2444 Contrary to `undo', this will not redo a previous undo."
2449 "Non-nil while performing an undo.
2453 "Undo back N undo-boundaries beyond what was already undone recently.
2454 Call `undo-start' to get ready to undo recent changes,
2455 then call `undo-more' one or more times to undo them."
2460 ;; Note: The following, while pulling elements off
2461 ;; `pending-undo-list' will call primitive change functions which
2462 ;; will push more elements onto `buffer-undo-list'.
2468 "Undo N records from the front of the list LIST.
2469 Return what remains of the list."
2471 ;; This is a good feature, but would make undo-start
2472 ;; unable to do what is expected.
2473 ;;(when (null (car (list)))
2474 ;; ;; If the head of the list is a boundary, it is the boundary
2475 ;; ;; preceding this command. Get rid of it and don't count it.
2476 ;; (setq list (cdr list))))
2479 ;; In a writable buffer, enable undoing read-only text that is
2480 ;; so because of text properties.
2482 ;; Don't let `intangible' properties interfere with undo.
2484 ;; We use oldlist only to check for EQ. ++kfs
2490 ;; Handle an integer by setting point to that value.
2493 ;; Element (t . TIME) records previous modtime.
2494 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2495 ;; UNKNOWN_MODTIME_NSECS.
2497 ;; If this records an obsolete save
2498 ;; (not matching the actual disk file)
2499 ;; then don't mark unmodified.
2507 ;; Element (nil PROP VAL BEG . END) is property change.
2512 ;; Element (BEG . END) means range was inserted.
2514 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2515 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2518 ;; Set point first thing, so that undoing this undo
2519 ;; does not send point back to where it is now.
2522 ;; Element (apply FUN . ARGS) means call FUN to undo.
2526 ;; Long format: (apply DELTA START END FUN . ARGS).
2533 ;; Check that the function did what the entry
2534 ;; said it would do.
2544 ;; Element (STRING . POS) means STRING was deleted.
2550 ;; Check that marker adjustments which were recorded
2551 ;; with the (STRING . POS) record are still valid, ie
2552 ;; the markers haven't moved. We check their validity
2553 ;; before reinserting the string so as we don't need to
2554 ;; mind marker insertion-type.
2562 ;; Insert string and adjust point
2570 ;; Adjust the valid marker adjustments
2574 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2577 next)
2578 ;; Even though these elements are not expected in the undo
2579 ;; list, adjust them to be conservative for the 24.4
2580 ;; release. (Bug#16818)
2587 ;; Make sure an apply entry produces at least one undo entry,
2588 ;; so the test in `undo' for continuing an undo series
2589 ;; will work right.
2594 list)
2596 ;; Deep copy of a list
2598 "Make a copy of undo list LIST."
2604 elt))
2607 "Set `pending-undo-list' to the front of the undo list.
2608 The next call to `undo-more' will undo the most recently made change.
2609 If BEG and END are specified, then only undo elements
2610 that apply to text between BEG and END are used; other undo elements
2611 are ignored. If BEG and END are nil, all undo elements are used."
2617 buffer-undo-list)))
2619 ;; The positions given in elements of the undo list are the positions
2620 ;; as of the time that element was recorded to undo history. In
2621 ;; general, subsequent buffer edits render those positions invalid in
2622 ;; the current buffer, unless adjusted according to the intervening
2623 ;; undo elements.
2624 ;;
2625 ;; Undo in region is a use case that requires adjustments to undo
2626 ;; elements. It must adjust positions of elements in the region based
2627 ;; on newer elements not in the region so as they may be correctly
2628 ;; applied in the current buffer. undo-make-selective-list
2629 ;; accomplishes this with its undo-deltas list of adjustments. An
2630 ;; example undo history from oldest to newest:
2631 ;;
2632 ;; buf pos:
2633 ;; 123456789 buffer-undo-list undo-deltas
2634 ;; --------- ---------------- -----------
2635 ;; aaa (1 . 4) (1 . -3)
2636 ;; aaba (3 . 4) N/A (in region)
2637 ;; ccaaba (1 . 3) (1 . -2)
2638 ;; ccaabaddd (7 . 10) (7 . -3)
2639 ;; ccaabdd ("ad" . 6) (6 . 2)
2640 ;; ccaabaddd (6 . 8) (6 . -2)
2641 ;; | |<-- region: "caab", from 2 to 6
2642 ;;
2643 ;; When the user starts a run of undos in region,
2644 ;; undo-make-selective-list is called to create the full list of in
2645 ;; region elements. Each element is adjusted forward chronologically
2646 ;; through undo-deltas to determine if it is in the region.
2647 ;;
2648 ;; In the above example, the insertion of "b" is (3 . 4) in the
2649 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2650 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2651 ;; . 6) is assessed as in the region and placed in the selective list.
2652 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2653 ;; due to the selected element. The "b" insertion is the only element
2654 ;; fully in the region, so in this example undo-make-selective-list
2655 ;; returns (nil (5 . 6)).
2656 ;;
2657 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2658 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2659 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2660 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2661 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2662 ;;
2663 ;; More interesting is how to adjust the "ddd" insertion due to the
2664 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2665 ;; If the reinsertion was a manual retyping of "ad", then the total
2666 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2667 ;; the reinsertion was due to undo, one might expect the first "d"
2668 ;; character would again be a part of the "ddd" text, meaning its
2669 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2670 ;;
2671 ;; undo-make-selective-list assumes in this situation that "ad" was a
2672 ;; new edit, even if it was inserted because of an undo.
2673 ;; Consequently, if the user undos in region "8 to 10" of the
2674 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2675 ;; "ccaabad", as though the first "d" became detached from the
2676 ;; original "ddd" insertion. This quirk is a FIXME.
2679 "Return a list of undo elements for the region START to END.
2680 The elements come from `buffer-undo-list', but we keep only the
2681 elements inside this region, and discard those outside this
2682 region. The elements' positions are adjusted so as the returned
2683 list can be applied to the current buffer."
2685 ;; A list of position adjusted undo elements in the region.
2687 ;; A list of undo-deltas for out of region undo elements.
2688 undo-deltas
2689 undo-elt)
2697 ;; Don't put two nils together in the list
2701 ;; This is a "was unmodified" element. Keep it
2702 ;; if we have kept everything thus far.
2705 ;; Skip over marker adjustments, instead relying
2706 ;; on finding them after (TEXT . POS) elements
2708 nil)
2711 undo-deltas)))
2716 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2717 ;; kept. primitive-undo may discard them later.
2730 "Determine whether UNDO-ELT falls inside the region START ... END.
2731 If it crosses the edge, we return nil.
2733 Generally this function is not useful for determining
2734 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2735 because markers can be arbitrarily relocated. Instead, pass the
2736 marker adjustment's corresponding (TEXT . POS) element."
2741 t)
2743 nil)
2745 ;; (TEXT . POSITION)
2749 ;; (MARKER . ADJUSTMENT)
2752 ;; (nil PROPERTY VALUE BEG . END)
2757 ;; (BEGIN . END)
2762 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2763 This assumes we have already decided that UNDO-ELT
2764 is not *inside* the region START...END."
2768 ;; (nil PROPERTY VALUE BEG . END)
2773 ;; (BEGIN . END)
2778 "Return adjustment of undo element ELT by the undo DELTAS
2779 list."
2781 ;; POSITION
2784 ;; (BEG . END)
2787 ;; (TEXT . POSITION)
2791 ;; (nil PROPERTY VALUE BEG . END)
2794 ;; (apply DELTA START END FUN . ARGS)
2795 ;; FIXME
2796 ;; All others return same elt
2799 ;; (BEG . END) can adjust to the same positions, commonly when an
2800 ;; insertion was undone and they are out of region, for example:
2801 ;;
2802 ;; buf pos:
2803 ;; 123456789 buffer-undo-list undo-deltas
2804 ;; --------- ---------------- -----------
2805 ;; [...]
2806 ;; abbaa (2 . 4) (2 . -2)
2807 ;; aaa ("bb" . 2) (2 . 2)
2808 ;; [...]
2809 ;;
2810 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2811 ;; undo. Further adjustments to such an element should be the same as
2812 ;; for (TEXT . POSITION) elements. The options are:
2813 ;;
2814 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2815 ;; analogous to marker insertion-type t.
2816 ;;
2817 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2818 ;; marker insertion-type nil.
2819 ;;
2820 ;; There was no strong reason to prefer one or the other, except that
2821 ;; the first is more consistent with prior undo in region behavior.
2823 "Return cons of adjustments to BEG and END by the undo DELTAS
2824 list."
2826 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2831 "Return adjustment of POS by the undo DELTAS list, comparing
2832 with < or <= based on USE-<."
2838 ;; Don't allow pos to become less than the undo-delta
2839 ;; position. This edge case is described in the overview
2840 ;; comments.
2843 ;; Return the first affected buffer position and the delta for an undo element
2844 ;; delta is defined as the change in subsequent buffer positions if we *did*
2845 ;; the undo.
2849 ;; (TEXT . POSITION)
2852 ;; (BEGIN . END)
2858 ;;; Default undo-boundary addition
2859 ;;
2860 ;; This section adds a new undo-boundary at either after a command is
2861 ;; called or in some cases on a timer called after a change is made in
2862 ;; any buffer.
2864 "Describe the cause of the last undo-boundary.
2866 If `explicit', the last boundary was caused by an explicit call to
2867 `undo-boundary', that is one not called by the code in this
2868 section.
2870 If it is equal to `timer', then the last boundary was inserted
2871 by `undo-auto--boundary-timer'.
2873 If it is equal to `command', then the last boundary was inserted
2874 automatically after a command, that is by the code defined in
2875 this section.
2877 If it is equal to a list, then the last boundary was inserted by
2878 an amalgamating command. The car of the list is the number of
2879 times an amalgamating command has been called, and the cdr are the
2883 "Current timer which will run `undo-auto--boundary-timer' or nil.
2888 "Non-nil if `this-command' should be amalgamated.
2889 This variable is set to nil by `undo-auto--boundaries' and is set
2893 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2897 "Return the number of amalgamating last commands or nil.
2898 Amalgamating commands are, by default, either
2899 `self-insert-command' and `delete-char', but can be any command
2900 that calls `undo-auto-amalgamate'."
2904 "Add an `undo-boundary' to the current buffer if needed.
2905 REASON describes the reason that the boundary is being added; see
2906 `undo-auto--last-boundary' for more information."
2916 undo-auto--undoably-changed-buffers)
2917 cause)))))
2920 "Check recently changed buffers and add a boundary if necessary.
2921 REASON describes the reason that the boundary is being added; see
2922 `undo-last-boundary' for more information."
2923 ;; (Bug #23785) All commands should ensure that there is an undo
2924 ;; boundary whether they have changed the current buffer or not.
2934 "Timer which will run `undo--auto-boundary-timer'."
2939 "Ensure that the `undo-auto-boundary-timer' is set."
2945 "List of buffers that have changed recently.
2947 This list is maintained by `undo-auto--undoable-change' and
2948 `undo-auto--boundaries' and can be affected by changes to their
2952 "Add an `undo-boundary' in appropriate buffers."
2957 'amalgamate
2961 "Amalgamate undo if necessary.
2962 This function can be called before an amalgamating command. It
2963 removes the previous `undo-boundary' if a series of such calls
2964 have been made. By default `self-insert-command' and
2965 `delete-char' are the only amalgamating commands, although this
2966 function could be called by any command wishing to have this
2967 behavior."
2972 last-amalgamating-count
2977 ;; Amalgamate all buffers that have changed.
2981 b
2983 ;; The head of `buffer-undo-list' is nil.
2984 ;; `car-safe' doesn't work because
2985 ;; `buffer-undo-list' need not be a list!
2993 "Called after every undoable buffer change."
2996 ;; End auto-boundary section
2999 "Amalgamate changes in change-group since HANDLE.
3000 Remove all undo boundaries between the state of HANDLE and now.
3001 HANDLE is as returned by `prepare-change-group'."
3010 ;; Temporarily truncate the undo log at ELT.
3015 ;; `elt' is still in the log: normal case.
3017 ;; `elt' is not in the log any more, but that's because
3018 ;; the log is "all new", so we should remove all
3019 ;; boundaries from it.
3023 buffer-undo-list
3024 ;; Preserve the undo-boundaries at either ends of the
3025 ;; change-groups.
3027 ;; Reset the modified cons cell ELT to its original content.
3034 "If non-nil ask about discarding undo info for the current command.
3035 Normally, Emacs discards the undo info for the current command if
3036 it exceeds `undo-outer-limit'. But if you set this option
3037 non-nil, it asks in the echo area whether to discard the info.
3038 If you answer no, there is a slight risk that Emacs might crash, so
3039 only do it if you really want to undo the command.
3041 This option is mainly intended for debugging. You have to be
3042 careful if you use it for other purposes. Garbage collection is
3043 inhibited while the question is asked, meaning that Emacs might
3044 leak memory. So you should make sure that you do not wait
3045 excessively long before answering the question."
3051 "If non-nil, an extra level of size that's ok in an undo item.
3052 We don't ask the user about truncating the undo list until the
3053 current item gets bigger than this amount.
3058 ;; When the first undo batch in an undo list is longer than
3059 ;; undo-outer-limit, this function gets called to warn the user that
3060 ;; the undo info for the current command was discarded. Garbage
3061 ;; collection is inhibited around the call, so it had better not do a
3062 ;; lot of consing.
3068 ;; Don't ask the question again unless it gets even bigger.
3069 ;; This applies, in particular, if the user quits from the question.
3070 ;; Such a quit quits out of GC, but something else will call GC
3071 ;; again momentarily. It will call this function again,
3072 ;; but we don't want to ask the question again.
3076 "Buffer `%s' undo info is %d bytes long; discard it? "
3080 t)
3081 nil))
3087 "The undo info was discarded because it exceeded \
3088 `undo-outer-limit'.
3090 This is normal if you executed a command that made a huge change
3091 to the buffer. In that case, to prevent similar problems in the
3092 future, set `undo-outer-limit' to a value that is large enough to
3093 cover the maximum size of normal changes you expect a single
3094 command to make, but not so large that it might exceed the
3095 maximum memory allotted to Emacs.
3097 If you did not execute any such command, the situation is
3098 probably due to a bug and you should report it.
3100 You can disable the popping up of this buffer by adding the entry
3101 \(undo discard-info) to the user option `warning-suppress-types',
3105 t))
3106 \f
3109 ; These are sorted according to the GNU en_US locale.
3152 )
3154 This is used by Shell mode and other parts of Emacs to recognize
3155 password prompts, including prompts in languages other than
3156 English. Different case choices should not be assumed to be
3157 included; callers should bind `case-fold-search' to t."
3163 "History list for some commands that read shell commands.
3165 Maximum length of the history list is determined by the value
3172 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3173 This buffer is used when `shell-command' or `shell-command-on-region'
3174 is run interactively. A value of nil means that output to stderr and
3181 "Return a list of all commands associated with the current file.
3182 This function is used to add all related commands retrieved by `mailcap'
3183 to the end of the list of defaults just after the default value."
3187 minibuffer-default))
3192 commands))
3203 map)
3207 "Read a shell command from the minibuffer.
3208 The arguments are the same as the ones of `read-from-minibuffer',
3209 except READ and KEYMAP are missing and HIST defaults
3210 to `shell-command-history'."
3218 minibuffer-local-shell-command-map
3219 nil
3221 args)))
3224 "What to do when the output buffer is used by another shell command.
3225 This option specifies how to resolve the conflict where a new command
3226 wants to direct its output to the buffer `*Async Shell Command*',
3227 but this buffer is already taken by another running shell command.
3229 The value `confirm-kill-process' is used to ask for confirmation before
3230 killing the already running process and running a new process
3231 in the same buffer, `confirm-new-buffer' for confirmation before running
3232 the command in a new buffer with a name other than the default buffer name,
3233 `new-buffer' for doing the same without confirmation,
3234 `confirm-rename-buffer' for confirmation before renaming the existing
3235 output buffer and running a new command in the default buffer,
3236 `rename-buffer' for doing the same without confirmation."
3238 confirm-kill-process)
3240 confirm-new-buffer)
3242 new-buffer)
3244 confirm-rename-buffer)
3246 rename-buffer))
3251 "Store a buffer position or erase the buffer.
3252 See `shell-command-dont-erase-buffer'."
3254 pos)
3256 ;; Setting buffer-read-only to nil doesn't suffice
3257 ;; if some text has a non-nil read-only property,
3258 ;; which comint sometimes adds for prompts.
3268 shell-command-saved-pos))))
3271 "Set point in BUFFER after command complete.
3272 BUFFER is the output buffer of the command; if nil, then defaults
3273 to the current BUFFER.
3274 Set point to the `cdr' of the element in `shell-command-saved-pos'
3275 whose `car' is BUFFER."
3287 ;; Set point in the window displaying buf, if any; otherwise
3288 ;; display buf temporary in selected frame and set the point.
3293 buf
3298 "Execute string COMMAND asynchronously in background.
3300 Like `shell-command', but adds `&' at the end of COMMAND
3301 to execute it asynchronously.
3303 The output appears in the buffer `*Async Shell Command*'.
3304 That buffer is in shell mode.
3306 You can configure `async-shell-command-buffer' to specify what to do in
3307 case when `*Async Shell Command*' buffer is already taken by another
3308 running shell command. To run COMMAND without displaying the output
3309 in a window you can configure `display-buffer-alist' to use the action
3310 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3312 In Elisp, you will often be better served by calling `start-process'
3313 directly, since it offers more control and does not impose the use of a
3314 shell (with its need to quote arguments)."
3324 current-prefix-arg
3325 shell-command-default-error-buffer))
3331 "Execute string COMMAND in inferior shell; display output, if any.
3332 With prefix argument, insert the COMMAND's output at point.
3334 Interactively, prompt for COMMAND in the minibuffer.
3336 If COMMAND ends in `&', execute it asynchronously.
3337 The output appears in the buffer `*Async Shell Command*'.
3338 That buffer is in shell mode. You can also use
3339 `async-shell-command' that automatically adds `&'.
3341 Otherwise, COMMAND is executed synchronously. The output appears in
3342 the buffer `*Shell Command Output*'. If the output is short enough to
3343 display in the echo area (which is determined by the variables
3344 `resize-mini-windows' and `max-mini-window-height'), it is shown
3345 there, but it is nonetheless available in buffer `*Shell Command
3346 Output*' even though that buffer is not automatically displayed.
3348 To specify a coding system for converting non-ASCII characters
3350 before this command.
3352 Noninteractive callers can specify coding systems by binding
3353 `coding-system-for-read' and `coding-system-for-write'.
3355 The optional second argument OUTPUT-BUFFER, if non-nil,
3356 says to put the output in some other buffer.
3357 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3358 and insert the output there; a non-nil value of
3359 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3360 If OUTPUT-BUFFER is not a buffer and not nil, insert the output
3361 in current buffer after point leaving mark after it.
3362 This cannot be done asynchronously.
3364 If the command terminates without error, but generates output,
3366 the output can be displayed in the echo area or in its buffer.
3367 If the output is short enough to display in the echo area
3368 \(determined by the variable `max-mini-window-height' if
3369 `resize-mini-windows' is non-nil), it is shown there.
3370 Otherwise,the buffer containing the output is displayed.
3374 of the output.
3376 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3377 or buffer name to which to direct the command's standard error output.
3378 If it is nil, error output is mingled with regular output.
3379 In an interactive call, the variable `shell-command-default-error-buffer'
3380 specifies the value of ERROR-BUFFER.
3382 In Elisp, you will often be better served by calling `call-process' or
3383 `start-process' directly, since it offers more control and does not impose
3384 the use of a shell (with its need to quote arguments)."
3395 current-prefix-arg
3396 shell-command-default-error-buffer))
3397 ;; Look for a handler in case default-directory is a remote file name.
3405 ;; Output goes in current buffer.
3411 temporary-file-directory)))
3412 nil)))
3415 ;; We do not use -f for csh; we will not support broken use of
3416 ;; .cshrcs. Even the BSD csh manual says to use
3417 ;; "if ($?prompt) exit" before things which are not useful
3418 ;; non-interactively. Besides, if someone wants their other
3419 ;; aliases for shell commands then they can still have them.
3423 t)
3424 nil shell-command-switch command)
3431 ;; Do no formatting while reading error file,
3432 ;; because that can run a shell command, and we
3433 ;; don't want that to cause an infinite recursion.
3435 ;; Put point after the inserted errors.
3439 ;; This is like exchange-point-and-mark, but doesn't
3440 ;; activate the mark. It is cleaner to avoid activation,
3441 ;; even though the command loop would deactivate the mark
3442 ;; because we inserted text.
3446 ;; Output goes in a separate buffer.
3447 ;; Preserve the match data in case called from a program.
3448 ;; FIXME: It'd be ridiculous for an Elisp function to call
3449 ;; shell-command and assume that it won't mess the match-data!
3452 ;; Command ending with ampersand means asynchronous.
3456 proc)
3457 ;; Remove the ampersand.
3459 ;; Ask the user what to do with already running process.
3464 ;; If will kill a process, query first.
3469 ;; If will create a new buffer, query first.
3476 ;; It will create a new buffer.
3481 ;; If will rename the buffer, query first.
3490 ;; It will rename the buffer.
3500 shell-command-switch command))
3504 ;; Use the comint filter for proper handling of carriage motion
3505 ;; (see `comint-inhibit-carriage-motion'),.
3507 ))
3508 ;; Otherwise, command is executed synchronously.
3510 output-buffer nil error-buffer)))))))
3513 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3514 MESSAGE may be either a string or a buffer.
3516 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3517 for maximum height of the echo area, as defined by `max-mini-window-height'
3518 if `resize-mini-windows' is non-nil.
3520 Returns either the string shown in the echo area, or when a pop-up
3521 buffer is used, the window used to display it.
3523 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3524 name of the buffer used to display it in the case where a pop-up buffer
3525 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3526 string and it is displayed in the echo area, it is not specified whether
3527 the contents are inserted into the buffer anyway.
3529 Optional arguments ACTION and FRAME are as for `display-buffer',
3530 and are only used if a pop-up buffer is displayed."
3532 ;; Trivial case where we can use the echo area
3536 ;; Trivial case where we can just remove single trailing newline
3539 ;; General case
3542 message
3551 0
3555 (<= lines
3559 max-mini-window-height))
3561 max-mini-window-height)
3565 ;; Don't use the echo area if the output buffer is
3566 ;; already displayed in the selected frame.
3568 ;; Echo area
3574 ;; Buffer
3579 ;; We have a sentinel to prevent insertion of a termination message
3580 ;; in the buffer itself, and to set the point in the buffer when
3581 ;; `shell-command-dont-erase-buffer' is non-nil.
3590 &optional output-buffer replace
3591 error-buffer display-error-buffer
3592 region-noncontiguous-p)
3593 "Execute string COMMAND in inferior shell with region as input.
3594 Normally display output (if any) in temp buffer `*Shell Command Output*';
3595 Prefix arg means replace the region with it. Return the exit code of
3596 COMMAND.
3598 To specify a coding system for converting non-ASCII characters
3600 before this command. By default, the input (from the current buffer)
3601 is encoded using coding-system specified by `process-coding-system-alist',
3602 falling back to `default-process-coding-system' if no match for COMMAND
3603 is found in `process-coding-system-alist'.
3605 Noninteractive callers can specify coding systems by binding
3606 `coding-system-for-read' and `coding-system-for-write'.
3608 If the command generates output, the output may be displayed
3609 in the echo area or in a buffer.
3610 If the output is short enough to display in the echo area
3611 \(determined by the variable `max-mini-window-height' if
3612 `resize-mini-windows' is non-nil), it is shown there.
3613 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3614 The output is available in that buffer in both cases.
3616 If there is output and an error, a message about the error
3617 appears at the end of the output.
3619 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3620 command's output. If the value is a buffer or buffer name,
3621 erase that buffer and insert the output there; a non-nil value of
3622 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3623 If the value is nil, use the buffer `*Shell Command Output*'.
3624 Any other non-nil value means to insert the output in the
3625 current buffer after START.
3627 Optional fifth arg REPLACE, if non-nil, means to insert the
3628 output in place of text from START to END, putting point and mark
3629 around it.
3631 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3632 or buffer name to which to direct the command's standard error
3633 output. If nil, error output is mingled with regular output.
3634 When called interactively, `shell-command-default-error-buffer'
3635 is used for ERROR-BUFFER.
3637 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3638 display the error buffer if there were any errors. When called
3639 interactively, this is t."
3643 ;; Do this before calling region-beginning
3644 ;; and region-end, in case subprocess output
3645 ;; relocates them while we are in the minibuffer.
3647 ;; call-interactively recognizes region-beginning and
3648 ;; region-end specially, leaving them in the history.
3650 string
3651 current-prefix-arg
3652 current-prefix-arg
3653 shell-command-default-error-buffer
3654 t
3661 temporary-file-directory)))
3662 nil))
3663 exit-status)
3664 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3667 output)
3671 shell-file-name t t
3672 nil shell-command-switch
3673 command)
3680 ;; Replace specified region with output from command.
3682 ;; Don't muck with mark unless REPLACE says we should.
3689 t)))
3690 ;; It is rude to delete a buffer which the command is not using.
3691 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3692 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3693 ;; (kill-buffer shell-buffer)))
3694 ;; Don't muck with mark unless REPLACE says we should.
3696 ;; No prefix argument: put the output in a temp buffer,
3697 ;; replacing its entire contents.
3705 ;; If the input is the same buffer as the output,
3706 ;; delete everything but the specified region,
3707 ;; then replace that region with the output.
3713 shell-file-name t
3716 t)
3717 nil shell-command-switch
3718 command)))
3719 ;; Clear the output buffer, then run the command with
3720 ;; output there.
3730 buffer))))
3731 ;; Report the output.
3741 ;; There's some output, display it
3745 ;; No output; error?
3752 shell-command-default-error-buffer)
3759 output))
3762 exit-status))
3765 exit-status output))))
3766 ;; Don't kill: there might be useful info in the undo-log.
3767 ;; (kill-buffer buffer)
3768 )))))
3776 ;; Do no formatting while reading error file,
3777 ;; because that can run a shell command, and we
3778 ;; don't want that to cause an infinite recursion.
3780 ;; Put point after the inserted errors.
3785 exit-status))
3788 "Execute shell command COMMAND and return its output as a string."
3791 standard-output
3795 "Process files synchronously in a separate process.
3796 Similar to `call-process', but may invoke a file handler based on
3797 `default-directory'. The current working directory of the
3798 subprocess is `default-directory'.
3800 File names in INFILE and BUFFER are handled normally, but file
3801 names in ARGS should be relative to `default-directory', as they
3802 are passed to the process verbatim. (This is a difference to
3803 `call-process' which does not support file handlers for INFILE
3804 and BUFFER.)
3806 Some file handlers might not support all variants, for example
3807 they might behave as if DISPLAY was nil, regardless of the actual
3808 value passed."
3810 lc stderr-file)
3820 display args)
3826 "Whether a call of `process-file' changes remote files.
3828 By default, this variable is always set to t, meaning that a
3829 call of `process-file' could potentially change any file on a
3830 remote host. When set to nil, a file handler could optimize
3831 its behavior with respect to remote file attribute caching.
3833 You should only ever change this variable with a let-binding;
3837 "Start a program in a subprocess. Return the process object for it.
3839 Similar to `start-process', but may invoke a file handler based on
3840 `default-directory'. See Info node `(elisp)Magic File Names'.
3842 This handler ought to run PROGRAM, perhaps on the local host,
3843 perhaps on a remote host that corresponds to `default-directory'.
3844 In the latter case, the local part of `default-directory' becomes
3845 the working directory of the process.
3847 PROGRAM and PROGRAM-ARGS might be file names. They are not
3848 objects of file handler invocation. File handlers might not
3849 support pty association, if PROGRAM is nil."
3853 \f
3854 ;;;; Process menu
3868 map))
3871 "Major mode for listing the processes called by Emacs."
3884 "Kill process at point in a `list-processes' buffer."
3895 "Recompute the list of processes for the Process List buffer.
3896 Also, delete any process that is exited or signaled."
3910 face link
3912 "Visit buffer `%s'"
3914 follow-link t
3915 process-buffer ,buf
3916 action process-menu-visit-buffer)
3925 "datagram"
3942 tabulated-list-entries))))))
3948 "Display a list of all processes that are Emacs sub-processes.
3949 If optional argument QUERY-ONLY is non-nil, only processes with
3950 the query-on-exit flag set are listed.
3951 Any process listed as exited or signaled is actually eliminated
3952 after the listing is made.
3953 Optional argument BUFFER specifies a buffer to use, instead of
3955 The return value is always nil.
3957 This function lists only processes that were launched by Emacs. To
3958 see other processes running on the system, use `list-system-processes'."
3970 nil)
3971 \f
3972 ;;;; Prefix commands
3978 ;; BEWARE: Called directly from C code.
3979 ;; If the return value is non-nil, it means we are in the middle of
3980 ;; a command with prefix, such as a command invoked with prefix-arg.
3982 prefix-command--last-echo
3991 "Abnormal hook which constructs the description of the current prefix state.
3995 "Update state of prefix commands.
4003 "Pass the current prefix command state to the next command.
4004 Should be called by all prefix commands.
4005 Runs `prefix-command-preserve-state-hook'."
4007 ;; If the current command is a prefix command, we don't want the next (real)
4008 ;; command to have `last-command' set to, say, `universal-argument'.
4015 nil)
4017 ;;;;; The main prefix command.
4019 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
4044 ;; For backward compatibility, minus with no modifiers is an ordinary
4045 ;; command if digits have already been entered.
4075 map)
4083 "Begin a numeric argument for the following command.
4088 multiplies the argument by 4 each time.
4090 which is different in effect from any particular numeric argument.
4098 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
4099 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
4106 arg)))
4110 "Begin a negative numeric argument for the next command.
4120 "Part of the numeric argument for the next command.
4125 last-command-event
4132 ;; Treat -0 as just -, so that -01 will work.
4135 digit))))
4137 \f
4140 "This variable is a wrapper hook around `buffer-substring--filter'.
4146 "Function to perform the filtering in `filter-buffer-substring'.
4147 The function is called with the same 3 arguments (BEG END DELETE)
4148 that `filter-buffer-substring' received. It should return the
4149 buffer substring between BEG and END, after filtering. If DELETE is
4153 "List of filter functions for `buffer-substring--filter'.
4154 Each function must accept a single argument, a string, and return a string.
4155 The buffer substring is passed to the first function in the list,
4156 and the return value of each function is passed to the next.
4157 As a special convention, point is set to the start of the buffer text
4158 being operated on (i.e., the first argument of `buffer-substring--filter')
4164 "Return the buffer substring between BEG and END, after filtering.
4165 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4167 This calls the function that `filter-buffer-substring-function' specifies
4168 \(passing the same three arguments that it received) to do the work,
4169 and returns whatever it does. The default function does no filtering,
4170 unless a hook has been set.
4172 Use `filter-buffer-substring' instead of `buffer-substring',
4173 `buffer-substring-no-properties', or `delete-and-extract-region' when
4174 you want to allow filtering to take place. For example, major or minor
4175 modes can use `filter-buffer-substring-function' to extract characters
4176 that are special to a buffer, and should not be copied into other buffers."
4180 "Default function to use for `filter-buffer-substring-function'.
4181 Its arguments and return value are as specified for `filter-buffer-substring'.
4182 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4183 \(see `with-wrapper-hook' for details about wrapper hooks),
4184 and the abnormal hook `buffer-substring-filters'.
4185 No filtering is done unless a hook says to."
4196 string)))
4201 ;;;; Window system cut and paste hooks.
4204 "Function to call to make a killed region available to other programs.
4205 Most window systems provide a facility for cutting and pasting
4206 text between different programs, such as the clipboard on X and
4207 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4209 This variable holds a function that Emacs calls whenever text is
4210 put in the kill ring, to make the new kill available to other
4211 programs. The function takes one argument, TEXT, which is a
4215 "Function to call to get text cut from other programs.
4216 Most window systems provide a facility for cutting and pasting
4217 text between different programs, such as the clipboard on X and
4218 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4220 This variable holds a function that Emacs calls to obtain text
4221 that other programs have provided for pasting. The function is
4222 called with no arguments. If no other program has provided text
4223 to paste, the function should return nil (in which case the
4224 caller, usually `current-kill', should use the top of the Emacs
4225 kill ring). If another program has provided text to paste, the
4226 function should return that text as a string (in which case the
4227 caller should put this string in the kill ring as the latest
4228 kill).
4230 The function may also return a list of strings if the window
4231 system supports multiple selections. The first string will be
4232 used as the pasted text, but the other will be placed in the kill
4233 ring for easy access via `yank-pop'.
4235 Note that the function should return a string only if a program
4236 other than Emacs has provided a string for pasting; if Emacs
4237 provided the most recent string, the function should return nil.
4238 If it is difficult to tell whether Emacs or some other program
4239 provided the current string, it is probably good enough to return
4240 nil if the string is equal (according to `string=') to the last
4242 \f
4245 ;;;; The kill ring data structure.
4248 "List of killed text sequences.
4249 Since the kill ring is supposed to interact nicely with cut-and-paste
4250 facilities offered by window systems, use of this variable should
4251 interact nicely with `interprogram-cut-function' and
4252 `interprogram-paste-function'. The functions `kill-new',
4253 `kill-append', and `current-kill' are supposed to implement this
4254 interaction; you may want to use them instead of manipulating the kill
4258 "Maximum length of kill ring before oldest elements are thrown away."
4266 "Save clipboard strings into kill ring before replacing them.
4267 When one selects something in another program to paste it into Emacs,
4268 but kills something in Emacs before actually pasting it,
4269 this selection is gone unless this variable is non-nil,
4270 in which case the other program's selection is saved in the `kill-ring'
4277 "Do not add a new string to `kill-ring' if it duplicates the last one.
4278 The comparison is done using `equal-including-properties'."
4284 "Make STRING the latest kill in the kill ring.
4285 Set `kill-ring-yank-pointer' to point to it.
4286 If `interprogram-cut-function' is non-nil, apply it to STRING.
4287 Optional second argument REPLACE non-nil means that STRING will replace
4288 the front of the kill ring, rather than being added to the list.
4290 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4291 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4292 STRING.
4294 When the yank handler has a non-nil PARAM element, the original STRING
4295 argument is not used by `insert-for-yank'. However, since Lisp code
4296 may access and use elements from the kill ring directly, the STRING
4299 ;; Due to text properties such as 'yank-handler that
4300 ;; can alter the contents to yank, comparison using
4301 ;; `equal' is unsafe.
4326 ;; It has been argued that this should work similar to `self-insert-command'
4327 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4329 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4335 "Append STRING to the end of the latest kill in the kill ring.
4336 If BEFORE-P is non-nil, prepend STRING to the kill.
4337 Also removes the last undo boundary in the current buffer,
4338 depending on `kill-append-merge-undo'.
4339 If `interprogram-cut-function' is set, pass the resulting kill to it."
4347 ;; find the next undo boundary
4351 ;; remove this undo boundary
4356 "Whether rotating the kill ring changes the window system selection.
4357 If non-nil, whenever the kill ring is rotated (usually via the
4358 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4359 to copy the new kill to the window system selection."
4365 "Rotate the yanking point by N places, and then return that kill.
4366 If N is zero and `interprogram-paste-function' is set to a
4367 function that returns a string or a list of strings, and if that
4368 function doesn't return nil, then that string (or list) is added
4369 to the front of the kill ring and the string (or first string in
4370 the list) is returned as the latest kill.
4372 If N is not zero, and if `yank-pop-change-selection' is
4373 non-nil, use `interprogram-cut-function' to transfer the
4374 kill at the new yank point into the window system selection.
4376 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4377 move the yanking point; just return the Nth kill forward."
4380 interprogram-paste-function
4384 ;; Disable the interprogram cut function when we add the new
4385 ;; text to the kill ring, so Emacs doesn't try to own the
4386 ;; selection, with identical text.
4396 kill-ring)))
4401 interprogram-cut-function)
4407 ;;;; Commands for manipulating the kill ring.
4410 "Non-nil means don't signal an error for killing read-only text."
4416 This deletes the text from the buffer and saves it in the kill ring.
4420 If you want to append the killed region to the last killed text,
4424 If the previous command was also a kill command,
4425 the text killed this time appends to the text killed last time
4426 to make one entry in the kill ring.
4428 The killed text is filtered by `filter-buffer-substring' before it is
4429 saved in the kill ring, so the actual saved text might be different
4430 from what was killed.
4432 If the buffer is read-only, Emacs will beep and refrain from deleting
4433 the text, but put the text in the kill ring anyway. This means that
4434 you can use the killing commands to copy text from a read-only buffer.
4436 Lisp programs should use this function for killing text.
4437 (To delete text, use `delete-region'.)
4438 Supply two arguments, character positions BEG and END indicating the
4439 stretch of text to be killed. If the optional argument REGION is
4440 non-nil, the function ignores BEG and END, and kills the current
4441 region instead."
4442 ;; Pass mark first, then point, because the order matters when
4443 ;; calling `kill-append'.
4452 ;; Add that string to the kill ring, one way or another.
4459 nil)
4461 ;; The code above failed because the buffer, or some of the characters
4462 ;; in the region, are read-only.
4463 ;; We should beep, in case the user just isn't aware of this.
4464 ;; However, there's no harm in putting
4465 ;; the region's text in the kill ring, anyway.
4467 ;; Set this-command now, so it will be set even if we get an error.
4469 ;; This should barf, if appropriate, and give us the correct error.
4472 ;; Signal an error if the buffer is read-only.
4474 ;; If the buffer isn't read-only, the text is.
4477 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4478 ;; to get two copies of the text when the user accidentally types M-w and
4479 ;; then corrects it with the intended C-w.
4481 "Save the region as if killed, but don't kill it.
4482 In Transient Mark mode, deactivate the mark.
4483 If `interprogram-cut-function' is non-nil, also save the text for a window
4484 system cut and paste.
4486 The copied text is filtered by `filter-buffer-substring' before it is
4487 saved in the kill ring, so the actual saved text might be different
4488 from what was in the buffer.
4490 When called from Lisp, save in the kill ring the stretch of text
4491 between BEG and END, unless the optional argument REGION is
4492 non-nil, in which case ignore BEG and END, and save the current
4493 region instead.
4495 This command's old key binding has been given to `kill-ring-save'."
4496 ;; Pass mark first, then point, because the order matters when
4497 ;; calling `kill-append'.
4507 nil)
4510 "Save the region as if killed, but don't kill it.
4511 In Transient Mark mode, deactivate the mark.
4512 If `interprogram-cut-function' is non-nil, also save the text for a window
4513 system cut and paste.
4515 If you want to append the killed line to the last killed text,
4518 The copied text is filtered by `filter-buffer-substring' before it is
4519 saved in the kill ring, so the actual saved text might be different
4520 from what was in the buffer.
4522 When called from Lisp, save in the kill ring the stretch of text
4523 between BEG and END, unless the optional argument REGION is
4524 non-nil, in which case ignore BEG and END, and save the current
4525 region instead.
4527 This command is similar to `copy-region-as-kill', except that it gives
4528 visual feedback indicating the extent of the region being copied."
4529 ;; Pass mark first, then point, because the order matters when
4530 ;; calling `kill-append'.
4534 ;; This use of called-interactively-p is correct because the code it
4535 ;; controls just gives the user visual feedback.
4540 "Indicate that the region text has been copied interactively.
4541 If the mark is visible in the selected window, blink the cursor
4542 between point and mark if there is currently no active region
4543 highlighting.
4545 If the mark lies outside the selected window, display an
4546 informative message containing a sample of the copied text. The
4547 optional argument MESSAGE-LEN, if non-nil, specifies the length
4548 of this sample text; it defaults to 40."
4551 ;; Inhibit quitting so we can make a quit here
4552 ;; look like a C-g typed as a command.
4555 ;; Swap point-and-mark quickly so as to show the region that
4556 ;; was selected. Don't do it if the region is highlighted.
4559 ;; Swap point and mark.
4563 ;; Swap back.
4566 ;; If user quit, deactivate the mark
4567 ;; as C-g would as a command.
4573 ;; Don't say "killed"; that is misleading.
4580 "Cause following command, if it kills, to add to previous kill.
4581 If the next command kills forward from point, the kill is
4582 appended to the previous killed text. If the command kills
4583 backward, the kill is prepended. Kill commands that act on the
4584 region, such as `kill-region', are regarded as killing forward if
4585 point is after mark, and killing backward if point is before
4586 mark.
4588 If the next command is not a kill command, `append-next-kill' has
4589 no effect.
4591 The argument is used for internal purposes; do not supply one."
4593 ;; We don't use (interactive-p), since that breaks kbd macros.
4607 "A subroutine of `squeeze-bidi-context'.
4608 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4612 lim1)
4619 ;; L and R categories include embedding and
4620 ;; override controls, but we don't want to
4621 ;; replace them, because that might change
4622 ;; the visual order. Likewise with PDF and
4623 ;; isolate controls.
4625 bidi-directional-non-controls-chars
4626 limit)))))
4627 ;; Replace any run of non-RTL characters by a single LRM.
4629 ;; No more characters of CATEGORY, we are done.
4634 ;; Skip directional controls, if any.
4639 "Replace characters between FROM and TO while keeping bidi context.
4641 This function replaces the region of text with as few characters
4642 as possible, while preserving the effect that region will have on
4643 bidirectional display before and after the region."
4647 ;; This is for when they copy text with read-only text
4648 ;; properties.
4652 ;; Replace each run of non-RTL characters with a single LRM.
4654 ;; Replace each run of non-LTR characters with a single RLM. Note
4655 ;; that the \cR category includes both the Arabic Letter (AL) and
4656 ;; R characters; here we ignore the distinction between them,
4657 ;; because that distinction only affects Arabic Number (AN)
4658 ;; characters, which are weak and don't affect the reordering.
4662 "Return buffer text between START and END with its bidi context.
4664 START and END are assumed to belong to the same physical line
4665 of buffer text. This function prepends and appends to the text
4666 between START and END bidi control characters that preserve the
4667 visual order of that text when it is inserted at some other place."
4672 substr para-dir from to)
4679 ;; If we don't have any mixed directional characters in the
4680 ;; entire line, we can just copy the substring without adding
4681 ;; any context.
4696 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4697 ;; (1) force the string to have the same base embedding
4698 ;; direction as the paragraph direction at the source, no matter
4699 ;; what is the paragraph direction at destination; and (2) avoid
4700 ;; affecting the visual order of the surrounding text at
4701 ;; destination if there are characters of different
4702 ;; directionality there.
4707 "Return portion of current buffer between START and END with bidi context.
4709 This function works similar to `buffer-substring', but it prepends and
4710 appends to the text bidi directional control characters necessary to
4711 preserve the visual appearance of the text if it is inserted at another
4712 place. This is useful when the buffer substring includes bidirectional
4713 text and control characters that cause non-trivial reordering on display.
4714 If copied verbatim, such text can have a very different visual appearance,
4715 and can also change the visual appearance of the surrounding text at the
4716 destination of the copy.
4718 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4719 the text properties."
4732 no-properties)))
4736 substr)))
4737 \f
4738 ;; Yanking.
4743 "List of special text property handling conditions for yanking.
4744 Each element should have the form (PROP . FUN), where PROP is a
4745 property symbol and FUN is a function. When the `yank' command
4746 inserts text into the buffer, it scans the inserted text for
4747 stretches of text that have `eq' values of the text property
4748 PROP; for each such stretch of text, FUN is called with three
4749 arguments: the property's value in that text, and the start and
4750 end positions of the text.
4752 This is done prior to removing the properties specified by
4753 `yank-excluded-properties'."
4756 function))
4759 ;; This is actually used in subr.el but defcustom does not work there.
4762 intangible invisible keymap local-map mouse-face read-only
4763 yank-handler)
4764 "Text properties to discard when yanking.
4765 The value should be a list of text properties to discard or t,
4766 which means to discard all text properties.
4768 See also `yank-handled-properties'."
4775 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4776 Function is called with two parameters, START and END corresponding to
4777 the value of the mark and point; it is guaranteed that START <= END.
4781 "Replace just-yanked stretch of killed text with a different stretch.
4782 This command is allowed only immediately after a `yank' or a `yank-pop'.
4783 At such a time, the region contains a stretch of reinserted
4784 previously-killed text. `yank-pop' deletes that text and inserts in its
4785 place a different stretch of killed text.
4787 With no argument, the previous kill is inserted.
4788 With argument N, insert the Nth previous kill.
4789 If N is negative, this is a more recent kill.
4791 The sequence of kills wraps around, so that after the oldest one
4792 comes the newest one.
4794 This command honors the `yank-handled-properties' and
4795 `yank-excluded-properties' variables, and the `yank-handler' text
4796 property, in the way that `yank' does."
4810 ;; Set the window start back where it was in the yank command,
4811 ;; if possible.
4814 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4815 ;; It is cleaner to avoid activation, even though the command
4816 ;; loop would deactivate the mark because we inserted text.
4819 nil)
4823 More precisely, reinsert the most recent kill, which is the
4824 stretch of killed text most recently killed OR yanked. Put point
4825 at the end, and set mark at the beginning without activating it.
4827 With argument N, reinsert the Nth most recent kill.
4829 This command honors the `yank-handled-properties' and
4830 `yank-excluded-properties' variables, and the `yank-handler' text
4831 property, as described below.
4833 Properties listed in `yank-handled-properties' are processed,
4834 then those listed in `yank-excluded-properties' are discarded.
4836 If STRING has a non-nil `yank-handler' property anywhere, the
4837 normal insert behavior is altered, and instead, for each contiguous
4838 segment of STRING that has a given value of the `yank-handler'
4839 property, that value is used as follows:
4841 The value of a `yank-handler' property must be a list of one to four
4842 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
4843 FUNCTION, if non-nil, should be a function of one argument (the
4844 object to insert); FUNCTION is called instead of `insert'.
4845 PARAM, if present and non-nil, is passed to FUNCTION (to be handled
4846 in whatever way is appropriate; e.g. if FUNCTION is `yank-rectangle',
4847 PARAM may be a list of strings to insert as a rectangle). If PARAM
4848 is nil, then the current segment of STRING is used.
4849 If NOEXCLUDE is present and non-nil, the normal removal of
4850 `yank-excluded-properties' is not performed; instead FUNCTION is
4851 responsible for the removal. This may be necessary if FUNCTION
4852 adjusts point before or after inserting the object.
4853 UNDO, if present and non-nil, should be a function to be called
4854 by `yank-pop' to undo the insertion of the current PARAM. It is
4855 given two arguments, the start and end of the region. FUNCTION
4856 may set `yank-undo-function' to override UNDO.
4861 ;; If we don't get all the way thru, make last-command indicate that
4862 ;; for the following command.
4870 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4871 ;; It is cleaner to avoid activation, even though the command
4872 ;; loop would deactivate the mark because we inserted text.
4875 ;; If we do get all the way thru, make this-command indicate that.
4878 nil)
4881 "Rotate the yanking point in the kill ring.
4882 With ARG, rotate that many kills forward (or backward, if negative)."
4885 \f
4886 ;; Some kill commands.
4888 ;; Internal subroutine of delete-char
4894 ;; Internal subroutine of backward-delete-char
4901 "The method for untabifying when deleting backward.
4902 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4903 `hungry' -- delete all whitespace, both tabs and spaces;
4904 `all' -- delete all whitespace, including tabs, spaces and newlines;
4905 nil -- just delete one character."
4911 "Delete characters backward, changing tabs into spaces.
4912 The exact behavior depends on `backward-delete-char-untabify-method'.
4913 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4914 Interactively, ARG is the prefix arg (default 1)
4915 and KILLP is t if a prefix arg was specified."
4938 arg)))
4939 ;; Avoid warning about delete-backward-char
4943 "Kill up to and including ARGth occurrence of CHAR.
4944 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4945 Goes backward if ARG is negative; error if CHAR not found."
4948 ;; Avoid "obsolete" warnings for translation-table-for-input.
4956 ;; kill-line and its subroutines.
4959 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4964 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4965 With prefix argument ARG, kill that many lines from point.
4966 Negative arguments kill lines backward.
4967 With zero argument, kills the text before point on the current line.
4970 a number counts as a prefix arg.
4972 To kill a whole line, when point is not at the beginning, type \
4975 If `show-trailing-whitespace' is non-nil, this command will just
4976 kill the rest of the current line, even if there are no nonblanks
4977 there.
4979 If option `kill-whole-line' is non-nil, then this command kills the whole line
4980 including its terminating newline, when used at the beginning of a line
4981 with no argument. As a consequence, you can always kill a whole line
4984 If you want to append the killed line to the last killed text,
4987 If the buffer is read-only, Emacs will beep and refrain from deleting
4988 the line, but put the line in the kill ring anyway. This means that
4989 you can use this command to copy text from a read-only buffer.
4990 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4991 even beep.)"
4994 ;; It is better to move point to the other end of the kill
4995 ;; before killing. That way, in a read-only buffer, point
4996 ;; moves across the text that is copied to the kill ring.
4997 ;; The choice has no effect on undo now that undo records
4998 ;; the value of point from before the command was run.
5008 ;; If trailing whitespace is visible,
5009 ;; don't treat it as nothing.
5019 "Kill current line.
5020 With prefix ARG, kill that many lines starting from the current line.
5021 If ARG is negative, kill backward. Also kill the preceding newline.
5023 If ARG is zero, kill current line but exclude the trailing newline."
5034 ;; We need to kill in two steps, because the previous command
5035 ;; could have been a kill command, in which case the text
5036 ;; before point needs to be prepended to the current kill
5037 ;; ring entry and the text after point appended. Also, we
5038 ;; need to use save-excursion to avoid copying the same text
5039 ;; twice to the kill ring in read-only buffers.
5057 "Move forward by ARG lines, ignoring currently invisible newlines only.
5058 If ARG is negative, move backward -ARG lines.
5059 If ARG is zero, move to the beginning of the current line."
5066 ;; If the newline we just skipped is invisible,
5067 ;; don't count it.
5071 prop
5076 ;; If invisible text follows, and it is a number of complete lines,
5077 ;; skip it.
5083 prop
5099 ;; If the newline we just moved to is invisible,
5100 ;; don't count it.
5105 prop
5110 ;; If invisible text follows, and it is a number of complete lines,
5111 ;; skip it.
5117 prop
5128 nil)))
5131 "Move to end of current visible line."
5133 ;; If the following character is currently invisible,
5134 ;; skip all characters with that same `invisible' property value,
5135 ;; then find the next newline.
5142 prop
5151 \f
5153 "Insert after point the contents of BUFFER.
5154 Puts mark after the inserted text.
5155 BUFFER may be a buffer or a buffer name."
5165 t))))
5170 nil)
5173 "Append to specified buffer the text of the region.
5174 It is inserted into that buffer before its point.
5176 When calling from a program, give three arguments:
5177 BUFFER (or buffer name), START and END.
5178 START and END specify the portion of the current buffer to be copied."
5185 point)
5196 "Prepend to specified buffer the text of the region.
5197 It is inserted into that buffer after its point.
5199 When calling from a program, give three arguments:
5200 BUFFER (or buffer name), START and END.
5201 START and END specify the portion of the current buffer to be copied."
5210 "Copy to specified buffer the text of the region.
5211 It is inserted into that buffer, replacing existing text there.
5213 When calling from a program, give three arguments:
5214 BUFFER (or buffer name), START and END.
5215 START and END specify the portion of the current buffer to be copied."
5223 \f
5227 "Hook run when the mark becomes active.
5228 It is also run at the end of a command, if the mark is active and
5235 "Return this buffer's mark value as integer, or nil if never set.
5237 In Transient Mark mode, this function signals an error if
5238 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5239 or the argument FORCE is non-nil, it disregards whether the mark
5240 is active, and returns an integer or nil in the usual way.
5242 If you are using this in an editing command, you are most likely making
5243 a mistake; see the documentation of `set-mark'."
5248 ;; Behind display-selections-p.
5251 "Deactivate the mark.
5252 If Transient Mark mode is disabled, this function normally does
5253 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5255 Deactivating the mark sets `mark-active' to nil, updates the
5256 primary selection according to `select-active-regions', and runs
5257 `deactivate-mark-hook'.
5259 If Transient Mark mode was temporarily enabled, reset the value
5260 of the variable `transient-mark-mode'; if this causes Transient
5261 Mark mode to be disabled, don't change `mark-active' to nil or
5262 run `deactivate-mark-hook'."
5266 select-active-regions)
5269 ;; The var `saved-region-selection', if non-nil, is the text in
5270 ;; the region prior to the last command modifying the buffer.
5271 ;; Set the selection to that, or to the current region.
5276 ;; If another program has acquired the selection, region
5277 ;; deactivation should not clobber it (Bug#11772).
5296 "Activate the mark.
5297 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5307 "Set this buffer's mark to POS. Don't use this function!
5308 That is to say, don't use this function unless you want
5309 the user to see that the mark has moved, and you want the previous
5310 mark position to be lost.
5312 Normally, when a new mark is set, the old one should go on the stack.
5313 This is why most applications should use `push-mark', not `set-mark'.
5315 Novice Emacs Lisp programmers often try to use the mark for the wrong
5316 purposes. The mark saves a location for the user's convenience.
5317 Most editing commands should not alter the mark.
5318 To remember a location for internal use in the Lisp program,
5319 store it in a Lisp variable. Example:
5321 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5326 ;; Normally we never clear mark-active except in Transient Mark mode.
5327 ;; But when we actually clear out the mark value too, we must
5328 ;; clear mark-active in any mode.
5330 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5331 ;; it should never be nil if the mark is nil.
5339 mark-active))
5346 ;; Mark marker
5352 ;; Mark active
5355 ;; If mark is active now, and either was not active or was at a
5356 ;; different place, run the activate hook.
5361 ;; If mark has ceased to be active, run deactivate hook.
5366 "Like `save-excursion', but also save and restore the mark state.
5367 This macro does what `save-excursion' did before Emacs 25.1."
5377 If nil, region-aware commands treat the empty region as inactive.
5378 If non-nil, region-aware commands treat the region as active as
5379 long as the mark is active, even if the region is empty.
5381 Region-aware commands are those that act on the region if it is
5382 active and Transient Mark mode is enabled, and on the text near
5383 point otherwise."
5389 "Return t if the region is active and it is appropriate to act on it.
5390 This is used by commands that act specially on the region under
5391 Transient Mark mode.
5393 The return value is t if Transient Mark mode is enabled and the
5394 mark is active; furthermore, if `use-empty-active-region' is nil,
5395 the region must not be empty. Otherwise, the return value is nil.
5397 For some commands, it may be appropriate to ignore the value of
5398 `use-empty-active-region'; in that case, use `region-active-p'."
5403 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5405 Some commands act specially on the region when Transient Mark
5406 mode is enabled. Usually, such commands should use
5407 `use-region-p' instead of this function, because `use-region-p'
5408 also checks the value of `use-empty-active-region'."
5410 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5411 ;; without the mark being set (e.g. bug#17324). We really should fix
5412 ;; that problem, but in the mean time, let's make sure we don't say the
5413 ;; region is active when there's no mark.
5417 "Return the boundaries of the region as a list of (START . END) positions."
5421 "Return non-nil if the region contains several pieces.
5422 An example is a rectangular region handled as a list of
5423 separate contiguous regions for each line."
5436 ;; Normal priority so that a large region doesn't hide all the
5437 ;; overlays within it, but high secondary priority so that if it
5438 ;; ends/starts in the middle of a small overlay, that small overlay
5439 ;; won't hide the region's boundaries.
5441 nrol)
5446 rol)))
5462 start end window rol)))
5465 new))))))
5468 "Hook run just before redisplay.
5469 It is called in each window that is to be redisplayed. It takes one argument,
5470 which is the window that will be redisplayed. When run, the `current-buffer'
5491 "Maximum size of mark ring. Start discarding off end if gets this big."
5499 "Maximum size of global mark ring. \
5500 Start discarding off end if gets this big."
5505 "Jump to mark, and pop a new position for mark off the ring.
5506 \(Does not affect global mark ring)."
5516 "Set mark at where point is.
5517 If no prefix ARG and mark is already set there, just activate it.
5518 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5530 will pop the mark twice, and
5532 will pop the mark three times.
5540 "Set the mark where point is, and activate it; or jump to the mark.
5541 Setting the mark also alters the region, which is the text
5542 between point and mark; this is the closest equivalent in
5545 With no prefix argument, set the mark at point, and push the
5546 old mark position on local mark ring. Also push the new mark on
5547 global mark ring, if the previous mark was set in another buffer.
5549 When Transient Mark Mode is off, immediately repeating this
5550 command activates `transient-mark-mode' temporarily.
5553 jump to the mark, and set the mark from
5554 position popped off the local mark ring (this does not affect the global
5556 mark ring (see `pop-global-mark').
5558 If `set-mark-command-repeat-pop' is non-nil, repeating
5560 off the local (or global) mark ring and jumps there.
5563 argument, unconditionally set mark where point is, even if
5564 `set-mark-command-repeat-pop' is non-nil.
5566 Novice Emacs Lisp programmers often try to use the mark for the wrong
5567 purposes. See the documentation of `set-mark' for more information."
5587 arg)
5601 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5602 If the last global mark pushed was not in the current buffer,
5603 also push LOCATION on the global mark ring.
5604 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5606 Novice Emacs Lisp programmers often try to use the mark for the wrong
5607 purposes. See the documentation of `set-mark' for more information.
5609 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5616 ;; Now push the mark on the global mark ring.
5619 ;; The last global mark pushed was in this same buffer.
5620 ;; Don't push another one.
5621 nil
5630 nil)
5633 "Pop off mark ring into the buffer's actual mark.
5634 Does not set point. Does nothing if mark ring is empty."
5646 "Put the mark where point is now, and point where the mark is now.
5647 This command works even when the mark is not active,
5648 and it reactivates the mark.
5650 If Transient Mark mode is on, a prefix ARG deactivates the mark
5651 if it is active, and otherwise avoids reactivating it. If
5652 Transient Mark mode is off, a prefix ARG enables Transient Mark
5653 mode temporarily."
5667 nil))
5670 "When non-nil, shifted motion keys activate the mark momentarily.
5672 While the mark is activated in this way, any shift-translated point
5673 motion key extends the region, and if Transient Mark mode was off, it
5674 is temporarily turned on. Furthermore, the mark will be deactivated
5675 by any subsequent point motion key that was not shift-translated, or
5676 by any action that normally deactivates the mark in Transient Mark mode.
5678 See `this-command-keys-shift-translated' for the meaning of
5679 shift-translation."
5684 "Activate/deactivate mark depending on invocation thru shift translation.
5685 This function is called by `call-interactively' when a command
5686 with a `^' character in its `interactive' spec is invoked, before
5687 running the command itself.
5689 If `shift-select-mode' is enabled and the command was invoked
5690 through shift translation, set the mark and activate the region
5691 temporarily, unless it was already set in this way. See
5692 `this-command-keys-shift-translated' for the meaning of shift
5693 translation.
5695 Otherwise, if the region has been activated temporarily,
5696 deactivate it, and restore the variable `transient-mark-mode' to
5697 its earlier value."
5704 transient-mark-mode)))
5713 "Toggle Transient Mark mode.
5714 With a prefix argument ARG, enable Transient Mark mode if ARG is
5715 positive, and disable it otherwise. If called from Lisp, enable
5716 Transient Mark mode if ARG is omitted or nil.
5718 Transient Mark mode is a global minor mode. When enabled, the
5719 region is highlighted with the `region' face whenever the mark
5721 and after certain other operations that set the mark but whose
5722 main purpose is something else--for example, incremental search,
5728 Many commands change their behavior when Transient Mark mode is
5729 in effect and the mark is active, by acting on the region instead
5730 of their usual default part of the buffer's text. Examples of
5733 To see the documentation of commands which are sensitive to the
5736 :global t
5737 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5741 "Non-nil means it is ok for commands to call `widen' when they want to.
5742 Some commands will do this in order to go to positions outside
5743 the current accessible part of the buffer.
5745 If `widen-automatically' is nil, these commands will do something else
5749 "Whether the currently executing code is performing an essential task.
5750 This variable should be non-nil only when running code which should not
5751 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5752 user for a password when we are simply scanning a set of files in the
5753 background or displaying possible completions before the user even asked
5757 "Pop off global mark ring and jump to the top location."
5759 ;; Pop entries which refer to non-existent buffers.
5777 \f
5779 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5785 "Move cursor vertically down ARG lines.
5786 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5787 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5788 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5789 function will not vscroll.
5791 ARG defaults to 1.
5793 If there is no character in the target line exactly under the current column,
5794 the cursor is positioned after the character in that line which spans this
5795 column, or at the end of the line if it is not long enough.
5796 If there is no line in the buffer after this one, behavior depends on the
5797 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5798 to create a line, and moves the cursor to that line. Otherwise it moves the
5799 cursor to the end of the buffer.
5801 If the variable `line-move-visual' is non-nil, this command moves
5802 by display lines. Otherwise, it moves by buffer lines, without
5803 taking variable-width characters or continued lines into account.
5807 a semipermanent goal column for this command.
5808 Then instead of trying to move exactly vertically (or as close as possible),
5809 this command moves to the specified goal column (or as close as possible).
5810 The goal column is stored in the variable `goal-column', which is nil
5811 when there is no goal column. Note that setting `goal-column'
5812 overrides `line-move-visual' and causes this command to move by buffer
5813 lines rather than by display lines."
5819 ;; When adding a newline, don't expand an abbrev.
5830 nil)
5833 "Move cursor vertically up ARG lines.
5834 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5835 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5836 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5837 function will not vscroll.
5839 ARG defaults to 1.
5841 If there is no character in the target line exactly over the current column,
5842 the cursor is positioned after the character in that line which spans this
5843 column, or at the end of the line if it is not long enough.
5845 If the variable `line-move-visual' is non-nil, this command moves
5846 by display lines. Otherwise, it moves by buffer lines, without
5847 taking variable-width characters or continued lines into account.
5851 a semipermanent goal column for this command.
5852 Then instead of trying to move exactly vertically (or as close as possible),
5853 this command moves to the specified goal column (or as close as possible).
5854 The goal column is stored in the variable `goal-column', which is nil
5855 when there is no goal column. Note that setting `goal-column'
5856 overrides `line-move-visual' and causes this command to move by buffer
5857 lines rather than by display lines."
5868 nil)
5871 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5872 This means moving to the end of each line moved onto.
5873 The beginning of a blank line does not count as the end of a line.
5874 This has no effect when the variable `line-move-visual' is non-nil."
5880 A non-nil setting overrides the variable `line-move-visual', which see."
5887 "Current goal column for vertical motion.
5888 It is the column where point was at the start of the current run
5889 of vertical motion commands.
5891 When moving by visual lines via the function `line-move-visual', it is a cons
5892 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5893 divided by the default column width, and HSCROLL is the number of
5894 columns by which window is scrolled from left margin.
5896 When the `track-eol' feature is doing its job, the value is
5900 "Non-nil means commands that move by lines ignore invisible newlines.
5901 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5902 as if newlines that are invisible didn't exist, and count
5903 only visible newlines. Thus, moving across across 2 newlines
5904 one of which is invisible will be counted as a one-line move.
5905 Also, a non-nil value causes invisible text to be ignored when
5906 counting columns for the purposes of keeping point in the same
5909 Outline mode sets this."
5914 "When non-nil, `line-move' moves point by visual lines.
5915 This movement is based on where the cursor is displayed on the
5916 screen, instead of relying on buffer contents alone. It takes
5917 into account variable-width characters and line continuation.
5918 If nil, `line-move' moves point by logical lines.
5919 A non-nil setting of `goal-column' overrides the value of this variable
5920 and forces movement by logical lines.
5921 A window that is horizontally scrolled also forces movement by logical
5922 lines."
5927 ;; Only used if display-graphic-p.
5931 "Return the height in pixels of the current buffer's default face font.
5933 If the default font is remapped (see `face-remapping-alist'), the
5934 function returns the height of the remapped face."
5938 ;; Avoid calling font-info if the frame's default font was
5939 ;; not changed since the frame was created. That's because
5940 ;; font-info is expensive for some fonts, see bug #14838.
5946 "Return the width in pixels of the current buffer's default face font.
5948 If the default font is remapped (see `face-remapping-alist'), the
5949 function returns the width of the remapped face."
5953 ;; Avoid calling font-info if the frame's default font was
5954 ;; not changed since the frame was created. That's because
5955 ;; font-info is expensive for some fonts, see bug #14838.
5960 width
5965 "Return the pixel height of current buffer's default-face text line.
5967 The value includes `line-spacing', if any, defined for the buffer
5968 or the frame."
5981 "Return the number of screen lines in the text area of the selected window.
5983 This is different from `window-text-height' in that this function counts
5984 lines in units of the height of the font used by the default face displayed
5985 in the window, not in units of the frame's default font, and also accounts
5986 for `line-spacing', if any, defined for the window's buffer or frame.
5988 The value is a floating-point number."
5993 ;; Returns non-nil if partial move was done.
5996 ;; Move backward (up).
5997 ;; If already vscrolled, reduce vscroll
6003 ;; Move forward (down).
6016 py vs last-line)
6036 col-row)
6041 ;; VPOS > 0 means the last line is only partially visible.
6042 ;; But if the part that is visible is at least as tall as the
6043 ;; default font, that means the line is actually fully
6044 ;; readable, and something like line-spacing is hidden. So in
6045 ;; that case we accept the last line in the window as still
6046 ;; visible, and consider the margin as starting one line
6047 ;; later.
6055 ;; If last line of window is fully visible, and vscrolling
6056 ;; more would make this line invisible, move forward.
6061 nil)
6062 ;; If cursor is not in the bottom scroll margin, and the
6063 ;; current line is is not too tall, move forward.
6065 vpos
6068 nil)
6069 ;; When already vscrolled, we vscroll some more if we can,
6070 ;; or clear vscroll and move forward at end of tall image.
6075 ;; If cursor just entered the bottom scroll margin, move forward,
6076 ;; but also optionally vscroll one line so redisplay won't recenter.
6080 ;; Don't vscroll if the partially-visible line at window
6081 ;; bottom is not too tall (a.k.a. "just one more text
6082 ;; line"): in that case, we do want redisplay to behave
6083 ;; normally, i.e. recenter or whatever.
6084 ;;
6085 ;; Note: ROWH + RBOT from the value returned by
6086 ;; pos-visible-in-window-p give the total height of the
6087 ;; partially-visible glyph row at the end of the window. As
6088 ;; we are dealing with floats, we disregard sub-pixel
6089 ;; discrepancies between that and DLH.
6093 t)
6094 ;; If there are lines above the last line, scroll-up one line.
6097 t)
6098 ;; Finally, start vscroll.
6103 ;; This is like line-move-1 except that it also performs
6104 ;; vertical scrolling of tall images if appropriate.
6105 ;; That is not really a clean thing to do, since it mixes
6106 ;; scrolling with cursor motion. But so far we don't have
6107 ;; a cleaner solution to the problem of making C-n do something
6108 ;; useful given a tall image.
6110 "Move forward ARG lines.
6111 If NOERROR, don't signal an error if we can't move ARG lines.
6112 TO-END is unused.
6113 TRY-VSCROLL controls whether to vscroll tall lines: if either
6114 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6115 not vscroll."
6119 ;; Only vscroll for single line moves
6121 ;; Under scroll-conservatively, the display engine
6122 ;; does this better.
6124 ;; But don't vscroll in a keyboard macro.
6130 ;; Display-based column are incompatible with goal-column.
6132 ;; When the text in the window is scrolled to the left,
6133 ;; display-based motion doesn't make sense (because each
6134 ;; logical line occupies exactly one screen line).
6136 ;; Likewise when the text _was_ scrolled to the left
6137 ;; when the current run of vertical motion commands
6138 ;; started.
6141 auto-hscroll-mode
6143 (>= temporary-goal-column
6146 ;; If we moved into a tall line, set vscroll to make
6147 ;; scrolling through tall images more smooth.
6151 winh)
6157 nil
6161 ;; Display-based alternative to line-move-1.
6162 ;; Arg says how many lines to move. The value is t if we can move the
6163 ;; specified number of lines.
6165 "Move ARG lines forward.
6166 If NOERROR, don't signal an error if we can't move that many lines."
6169 target-hscroll)
6170 ;; Check if the previous command was a line-motion command, or if
6171 ;; we were called from some other command.
6174 ;; If so, there's no need to reset `temporary-goal-column',
6175 ;; but we may need to hscroll.
6179 ;; Otherwise, we should reset `temporary-goal-column'.
6181 x-pos)
6183 ;; Handle the `overflow-newline-into-fringe' case:
6188 ;; In R2L lines, the X pixel coordinate is measured from the
6189 ;; left edge of the window, but columns are still counted
6190 ;; from the logical-order beginning of the line, i.e. from
6191 ;; the right edge in this case. We need to adjust for that.
6197 hscroll)))
6199 ;; When we move beyond the first/last character visible in
6200 ;; the window, posn-at-point will return nil, so we need to
6201 ;; approximate the goal column as below.
6206 ;; vertical-motion can move more than it was asked to if it moves
6207 ;; across display strings with newlines. We don't want to ring
6208 ;; the bell and announce beginning/end of buffer in that case.
6214 temporary-goal-column))
6215 arg))
6216 arg))
6222 temporary-goal-column))
6223 arg))
6224 arg)))
6227 ;; If the goal column lies on a display string,
6228 ;; `vertical-motion' advances the cursor to the end
6229 ;; of the string. For arg < 0, this can cause the
6230 ;; cursor to get stuck. (Bug#3020).
6234 nil)))))
6236 ;; This is the guts of next-line and previous-line.
6237 ;; Arg says how many lines to move.
6238 ;; The value is t if we can move the specified number of lines.
6240 ;; Don't run any point-motion hooks, and disregard intangibility,
6241 ;; for intermediate positions.
6253 ;; Don't count beg of empty line as end of line
6254 ;; unless we just did explicit end-of-line.
6256 most-positive-fixnum
6260 line-move-ignore-invisible))
6261 ;; Use just newline characters.
6262 ;; Set ARG to 0 if we move as many lines as requested.
6265 ;; This way of moving forward ARG lines
6266 ;; verifies that we have a newline after the last one.
6267 ;; It doesn't get confused by intangible text.
6276 'beginning-of-buffer
6278 nil)))
6279 ;; Move by arg lines, but ignore invisible ones.
6282 ;; If the following character is currently invisible,
6283 ;; skip all characters with that same `invisible' property value.
6286 ;; Move a line.
6287 ;; We don't use `end-of-line', since we want to escape
6288 ;; from field boundaries occurring exactly at point.
6294 ;; If there's no invisibility here, move over the newline.
6303 ;; We avoid vertical-motion when possible
6304 ;; because that has to fontify.
6306 ;; Otherwise move a more sophisticated way.
6313 ;; The logic of this is the same as the loop above,
6314 ;; it just goes in the other direction.
6316 ;; For completely consistency with the forward-motion
6317 ;; case, we should call beginning-of-line here.
6318 ;; However, if point is inside a field and on a
6319 ;; continued line, the call to (vertical-motion -1)
6320 ;; below won't move us back far enough; then we return
6321 ;; to the same column in line-move-finish, and point
6322 ;; gets stuck -- cyd
6340 ;; if our target is the middle of this line.
6345 ;; This is the value the function returns.
6349 ;; If we did not move down as far as desired, at least go
6350 ;; to end of line. Be sure to call point-entered and
6351 ;; point-left-hooks.
6357 ;; If we did not move up as far as desired,
6358 ;; at least go to beginning of line.
6370 ;; Set REPEAT to t to repeat the whole thing.
6377 ;; Compute the end of the line
6378 ;; ignoring effectively invisible newlines.
6380 ;; Like end-of-line but ignores fields.
6387 ;; Move to the desired column.
6390 ;; Corner case: suppose we start out in a field boundary in
6391 ;; the middle of a continued line. When we get to
6392 ;; line-move-finish, point is at the start of a new *screen*
6393 ;; line but the same text line; then line-move-to-column would
6394 ;; move us backwards. Test using C-n with point on the "x" in
6395 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6402 ;; Process intangibility within a line.
6403 ;; With inhibit-point-motion-hooks bound to nil, a call to
6404 ;; goto-char moves point past intangible text.
6406 ;; However, inhibit-point-motion-hooks controls both the
6407 ;; intangibility and the point-entered/point-left hooks. The
6408 ;; following hack avoids calling the point-* hooks
6409 ;; unnecessarily. Note that we move *forward* past intangible
6410 ;; text when the initial and final points are the same.
6415 ;; If intangibility moves us to a different (later) place
6416 ;; in the same line, use that as the destination.
6419 ;; If that position is "too late",
6420 ;; try the previous allowable position.
6421 ;; See if it is ok.
6424 ;; If going forward, don't accept the previous
6425 ;; allowable position if it is before the target line.
6427 ;; If going backward, don't accept the previous
6428 ;; allowable position if it is still after the target line.
6431 ;; As a last resort, use the end of the line.
6434 ;; Now move to the updated destination, processing fields
6435 ;; as well as intangibility.
6439 ;; Ignore field boundaries if the initial and final
6440 ;; positions have the same `field' property, even if the
6441 ;; fields are non-contiguous. This seems to be "nicer"
6442 ;; behavior in many situations.
6445 new
6449 ;; If all this moved us to a different line,
6450 ;; retry everything within that new line.
6452 ;; Repeat the intangibility and field processing.
6456 "Try to find column COL, considering invisibility.
6457 This function works only in certain cases,
6458 because what we really need is for `move-to-column'
6459 and `current-column' to be able to ignore invisible text."
6468 ;; If the following character is currently invisible,
6469 ;; skip all characters with that same `invisible' property value.
6473 ;; Have we advanced to a larger column position?
6475 ;; We have made some progress towards the desired column.
6476 ;; See if we can make any further progress.
6478 ;; Otherwise, go to the place we originally found
6479 ;; and move back over invisible text.
6480 ;; that will get us to the same place on the screen
6481 ;; but with a more reasonable buffer position.
6484 ;; We want the real line beginning, so it's consistent
6485 ;; with bolp below, otherwise we might infloop.
6492 "Move point to end of current line as displayed.
6493 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6494 If point reaches the beginning or end of buffer, it stops there.
6496 To ignore the effects of the `intangible' text or overlay
6497 property, bind `inhibit-point-motion-hooks' to t.
6498 If there is an image in the current line, this function
6499 disregards newlines that are part of the text on which the image
6500 rests."
6510 ;; With bidi reordering, we may not be at bol,
6511 ;; so make sure we are.
6526 ;; If we skipped something intangible and now we're not
6527 ;; really at eol, keep going.
6532 "Move point to beginning of current line as displayed.
6533 \(If there's an image in the line, this disregards newlines
6534 which are part of the text that the image rests on.)
6536 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6537 If point reaches the beginning or end of buffer, it stops there.
6538 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6543 first-vis first-vis-field-value)
6545 ;; Move by lines, if ARG is not 1 (the default).
6550 ;; Move to beginning-of-line, ignoring fields and invisible text.
6556 ;; Now find first visible char in the line.
6561 ;; See if fields would stop us from reaching FIRST-VIS.
6566 ;; If yes, obey them.
6567 first-vis-field-value
6568 ;; Otherwise, move to START with attention to fields.
6569 ;; (It is possible that fields never matter in this case.)
6574 ;; Many people have said they rarely use this feature, and often type
6575 ;; it by accident. Maybe it shouldn't even be on a key.
6580 Those commands will move to this position in the line moved to
6581 rather than trying to keep the same horizontal position.
6582 With a non-nil argument ARG, clears out the goal column
6584 The goal column is stored in the variable `goal-column'.
6585 This is a buffer-local setting."
6592 ;; The older method below can be erroneous if `set-goal-column' is bound
6593 ;; to a sequence containing %
6594 ;;(message (substitute-command-keys
6595 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6596 ;;goal-column)
6603 )
6604 nil)
6605 \f
6606 ;;; Editing based on visual lines, as opposed to logical lines.
6609 "Move point to end of current visual line.
6610 With argument N not nil or 1, move forward N - 1 visual lines first.
6611 If point reaches the beginning or end of buffer, it stops there.
6612 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6618 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6619 ;; constrain to field boundaries, so we don't either.
6623 "Move point to beginning of current visual line.
6624 With argument N not nil or 1, move forward N - 1 visual lines first.
6625 If point reaches the beginning or end of buffer, it stops there.
6626 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6634 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6638 "Kill the rest of the visual line.
6639 With prefix argument ARG, kill that many visual lines from point.
6640 If ARG is negative, kill visual lines backward.
6641 If ARG is zero, kill the text before point on the current visual
6642 line.
6644 If you want to append the killed line to the last killed text,
6647 If the buffer is read-only, Emacs will beep and refrain from deleting
6648 the line, but put the line in the kill ring anyway. This means that
6649 you can use this command to copy text from a read-only buffer.
6650 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6651 even beep.)"
6653 ;; Like in `kill-line', it's better to move point to the other end
6654 ;; of the kill before killing.
6662 ;; Skip any trailing whitespace at the end of the visual line.
6663 ;; We used to do this only if `show-trailing-whitespace' is
6664 ;; nil, but that's wrong; the correct thing would be to check
6665 ;; whether the trailing whitespace is highlighted. But, it's
6666 ;; OK to just do this unconditionally.
6673 "Move cursor vertically down ARG lines.
6674 This is identical to `next-line', except that it always moves
6675 by logical lines instead of visual lines, ignoring the value of
6676 the variable `line-move-visual'."
6683 "Move cursor vertically up ARG lines.
6684 This is identical to `previous-line', except that it always moves
6685 by logical lines instead of visual lines, ignoring the value of
6686 the variable `line-move-visual'."
6693 "Editing based on visual lines."
6702 ;; These keybindings interfere with xterm function keys. Are
6703 ;; there any other suitable bindings?
6704 ;; (define-key map "\M-[" 'previous-logical-line)
6705 ;; (define-key map "\M-]" 'next-logical-line)
6706 map))
6709 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6710 The value should be a list of the form (LEFT RIGHT), where LEFT
6711 and RIGHT are symbols representing the bitmaps to display, to
6712 indicate wrapped lines, in the left and right fringes respectively.
6713 See also `fringe-indicator-alist'.
6714 The default is not to display fringe indicators for wrapped lines.
6715 This variable does not affect fringe indicators displayed for
6716 other purposes."
6731 'continuation
6738 "Toggle visual line based editing (Visual Line mode).
6739 With a prefix argument ARG, enable Visual Line mode if ARG is
6740 positive, and disable it otherwise. If called from Lisp, enable
6741 the mode if ARG is omitted or nil.
6743 When Visual Line mode is enabled, `word-wrap' is turned on in
6744 this buffer, and simple editing commands are redefined to act on
6745 visual lines, not logical lines. See Info node `Visual Line
6746 Mode' for details."
6747 :keymap visual-line-mode-map
6753 ;; Save the local values of some variables, to be restored if
6754 ;; visual-line-mode is turned off.
6756 truncate-partial-width-windows
6757 word-wrap fringe-indicator-alist))
6760 visual-line--saved-state)))
6764 word-wrap t
6765 fringe-indicator-alist
6767 fringe-indicator-alist)))
6781 visual-line-mode turn-on-visual-line-mode)
6783 \f
6785 "Interchange characters around point, moving forward one character.
6786 With prefix arg ARG, effect is to take character before point
6787 and drag it forward past ARG other characters (backward if ARG negative).
6788 If no argument and at end of line, the previous two chars are exchanged."
6796 "Interchange words around point, leaving point at end of them.
6797 With prefix arg ARG, effect is to take word before or around point
6798 and drag it forward past ARG other words (backward if ARG negative).
6799 If ARG is zero, the words around or after point and around or after mark
6800 are interchanged."
6801 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6807 Unlike `transpose-words', point must be between the two sexps and not
6808 in the middle of a sexp to be transposed.
6809 With non-zero prefix arg ARG, effect is to take the sexp before point
6810 and drag it forward past ARG other sexps (backward if ARG is negative).
6811 If ARG is zero, the sexps ending at or after point and at or after mark
6812 are interchanged."
6816 ;; Here we should try to simulate the behavior of
6817 ;; (cons (progn (forward-sexp x) (point))
6818 ;; (progn (forward-sexp (- x)) (point)))
6819 ;; Except that we don't want to rely on the second forward-sexp
6820 ;; putting us back to where we want to be, since forward-sexp-function
6821 ;; might do funny things like infix-precedence.
6826 ;; Jumping over a symbol. We might be inside it, mind you.
6831 ;; Otherwise, we're between sexps. Take a step back before jumping
6832 ;; to make sure we'll obey the same precedence no matter which direction
6833 ;; we're going.
6838 'skip-syntax-forward
6845 "Exchange current line and previous line, leaving point after both.
6846 With argument ARG, takes previous line and moves it past ARG lines.
6847 With argument 0, interchanges line point is in with line mark is in."
6853 ;; Move forward over ARG lines,
6854 ;; but create newlines if necessary.
6861 arg))
6863 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6864 ;; which seems inconsistent with the ARG /= 0 case.
6865 ;; FIXME document SPECIAL.
6867 "Subroutine to do the work of transposing objects.
6868 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6869 moves forward by units of the given object (e.g. forward-sentence,
6870 forward-paragraph). If ARG is zero, exchanges the current object
6871 with the one containing mark. If ARG is an integer, moves the
6872 current object past ARG following (if ARG is positive) or
6873 preceding (if ARG is negative) objects, leaving point after the
6874 current object."
6879 pos1 pos2)
6908 ;; This sequence of insertions attempts to preserve marker
6909 ;; positions at the start and end of the transposed objects.
6923 \f
6925 "Move backward until encountering the beginning of a word.
6926 With argument ARG, do this that many times.
6927 If ARG is omitted or nil, move point backward one word.
6929 The word boundaries are normally determined by the buffer's syntax
6930 table, but `find-word-boundary-function-table', such as set up
6931 by `subword-mode', can change that. If a Lisp program needs to
6932 move by words determined strictly by the syntax table, it should
6933 use `backward-word-strictly' instead."
6938 "Set mark ARG words away from point.
6940 move to with the same argument.
6941 Interactively, if this command is repeated
6942 or (in Transient Mark mode) if the mark is active,
6943 it marks the next ARG words after the ones already marked."
6960 nil t))))
6963 "Kill characters forward until encountering the end of a word.
6964 With argument ARG, do this that many times."
6969 "Kill characters backward until encountering the beginning of a word.
6970 With argument ARG, do this that many times."
6975 "Return the word at or near point, as a string.
6976 The return value includes no text properties.
6978 If optional arg STRICT is non-nil, return nil unless point is
6979 within or adjacent to a word, otherwise look for a word within
6980 point's line. If there is no word anywhere on point's line, the
6981 value is nil regardless of STRICT.
6983 By default, this function treats as a single word any sequence of
6984 characters that have either word or symbol syntax. If optional
6985 arg REALLY-WORD is non-nil, only characters of word syntax can
6986 constitute a word."
6995 ;; Point is neither within nor adjacent to a word.
6997 ;; Look for preceding word in same line.
7000 ;; No preceding word in same line.
7001 ;; Look for following word in same line.
7010 ;; If we found something nonempty, return it as a string.
7013 \f
7015 "String for filling to insert at front of new line, or nil for none."
7017 string)
7023 "Regexp to match lines which should not be auto-filled."
7025 regexp)
7029 "The default value for `normal-auto-fill-function'.
7030 This is the default auto-fill function, some major modes use a different one.
7031 Returns t if it really did any work."
7041 nil ;; Auto-filling not required
7045 ;; Choose a fill-prefix automatically.
7053 ;; Use auto-indentation rather than a guessed empty prefix.
7059 ;; Determine where to split the line.
7072 ;; See whether the place we found is any good.
7076 ;; There is no use breaking at end of line.
7078 ;; It is futile to split at the end of the prefix
7079 ;; since we would just insert the prefix again.
7081 ;; Don't split right after a comment starter
7082 ;; since we would just make another comment starter.
7087 limit t)
7089 ;; No good place to break => stop trying.
7091 ;; Ok, we have a useful place to break the line. Do it.
7093 ;; If point is at the fill-point, do not `save-excursion'.
7094 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7095 ;; point will end up before it rather than after it.
7103 ;; Now do justification, if required
7108 ;; If making the new line didn't reduce the hpos of
7109 ;; the end of the line, then give up now;
7110 ;; trying again will not help.
7113 ;; Justify last line.
7115 t)))
7118 "Mode-specific function which line breaks and continues a comment.
7119 This function is called during auto-filling when a comment syntax
7120 is defined.
7121 The function should take a single optional argument, which is a flag
7125 "Break line at point and indent.
7126 If a comment syntax is defined, call `comment-indent-new-line'.
7128 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7129 unless optional argument SOFT is non-nil."
7133 ;; Insert the newline before removing empty space so that markers
7134 ;; get preserved better.
7140 ;; Blindly trust a non-adaptive fill-prefix.
7146 ;; If there's an adaptive prefix, use it unless we're inside
7147 ;; a comment and the prefix is not a comment starter.
7151 ;; If we're not inside a comment, just try to indent.
7155 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7159 ;; `functions' and `hooks' are usually unsafe to set, but setting
7160 ;; auto-fill-function to nil in a file-local setting is safe and
7161 ;; can be useful to prevent auto-filling.
7165 "Toggle automatic line breaking (Auto Fill mode).
7166 With a prefix argument ARG, enable Auto Fill mode if ARG is
7167 positive, and disable it otherwise. If called from Lisp, enable
7168 the mode if ARG is omitted or nil.
7170 When Auto Fill mode is enabled, inserting a space at a column
7171 beyond `current-fill-column' automatically breaks the line at a
7172 previous space.
7174 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7175 non-nil.
7177 The value of `normal-auto-fill-function' specifies the function to use
7178 for `auto-fill-function' when turning Auto Fill mode on."
7183 ;; This holds a document string used to document auto-fill-mode.
7185 "Automatically break line at a previous space, in insertion of text."
7186 nil)
7189 "Unconditionally turn on Auto Fill mode."
7193 "Unconditionally turn off Auto Fill mode."
7199 "Set `fill-column' to specified argument.
7204 ;; We used to use current-column silently, but C-x f is too easily
7205 ;; typed as a typo for C-x C-f, so we turned it into an error and
7206 ;; now an interactive prompt.
7211 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7215 \f
7217 "Set `selective-display' to ARG; clear it if no arg.
7218 When the value of `selective-display' is a number > 0,
7219 lines whose indentation is >= that value are not displayed.
7220 The variable `selective-display' has a separate value for each buffer."
7240 "Toggle truncating of long lines for the current buffer.
7241 When truncating is off, long lines are folded.
7242 With prefix argument ARG, truncate long lines if ARG is positive,
7243 otherwise fold them. Note that in side-by-side windows, this
7244 command has no effect if `truncate-partial-width-windows' is
7245 non-nil."
7257 nil t)))
7262 "Toggle whether to use word-wrapping for continuation lines.
7263 With prefix argument ARG, wrap continuation lines at word boundaries
7264 if ARG is positive, otherwise wrap them at the right screen edge.
7265 This command toggles the value of `word-wrap'. It has no effect
7266 if long lines are truncated."
7282 "Toggle Overwrite mode.
7283 With a prefix argument ARG, enable Overwrite mode if ARG is
7284 positive, and disable it otherwise. If called from Lisp, enable
7285 the mode if ARG is omitted or nil.
7287 When Overwrite mode is enabled, printing characters typed in
7288 replace existing text on a one-for-one basis, rather than pushing
7289 it to the right. At the end of a line, such characters extend
7290 the line. Before a tab, such characters insert until the tab is
7292 overwrite mode; this is supposed to make it easier to insert
7293 characters when necessary."
7298 "Toggle Binary Overwrite mode.
7299 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7300 is positive, and disable it otherwise. If called from Lisp,
7301 enable the mode if ARG is omitted or nil.
7303 When Binary Overwrite mode is enabled, printing characters typed
7304 in replace existing text. Newlines are not treated specially, so
7305 typing at the end of a line joins the line to the next, with the
7306 typed character between them. Typing before a tab character
7307 simply replaces the tab with the character typed.
7309 ordinary typing characters do.
7311 Note that Binary Overwrite mode is not its own minor mode; it is
7312 a specialization of overwrite mode, entered by setting the
7313 `overwrite-mode' variable to `overwrite-mode-binary'."
7318 "Toggle line number display in the mode line (Line Number mode).
7319 With a prefix argument ARG, enable Line Number mode if ARG is
7320 positive, and disable it otherwise. If called from Lisp, enable
7321 the mode if ARG is omitted or nil.
7323 Line numbers do not appear for very large buffers and buffers
7324 with very long lines; see variables `line-number-display-limit'
7325 and `line-number-display-limit-width'."
7329 "Toggle column number display in the mode line (Column Number mode).
7330 With a prefix argument ARG, enable Column Number mode if ARG is
7331 positive, and disable it otherwise.
7333 If called from Lisp, enable the mode if ARG is omitted or nil."
7337 "Toggle buffer size display in the mode line (Size Indication mode).
7338 With a prefix argument ARG, enable Size Indication mode if ARG is
7339 positive, and disable it otherwise.
7341 If called from Lisp, enable the mode if ARG is omitted or nil."
7345 "Toggle auto-saving in the current buffer (Auto Save mode).
7346 With a prefix argument ARG, enable Auto Save mode if ARG is
7347 positive, and disable it otherwise.
7349 If called from Lisp, enable the mode if ARG is omitted or nil."
7351 ;; If auto-save is off because buffer has shrunk,
7352 ;; then toggling should turn it on.
7360 buffer-file-name)
7362 ;; If -1 was stored here, to temporarily turn off saving,
7363 ;; turn it back on.
7366 \f
7368 "Blinking matching of parens and expressions."
7373 "Non-nil means show matching open-paren when close-paren is inserted.
7374 If t, highlight the paren. If `jump', briefly move cursor to its
7375 position. If `jump-offscreen', move cursor there even if the
7376 position is off screen. With any other non-nil value, the
7377 off-screen position of the opening paren will be shown in the
7378 echo area."
7387 "Non-nil means show matching open-paren when it is on screen.
7388 If nil, don't show it (but the open-paren can still be shown
7389 in the echo area when it is off screen).
7391 This variable has no effect if `blink-matching-paren' is nil.
7392 \(In that case, the open-paren is never shown.)
7393 It is also ignored if `show-paren-mode' is enabled."
7398 "If non-nil, maximum distance to search backwards for matching open-paren.
7399 If nil, search stops at the beginning of the accessible portion of the buffer."
7405 "Time in seconds to delay after showing a matching paren."
7410 "If nil, `blink-matching-paren' ignores comments.
7411 More precisely, when looking for the matching parenthesis,
7412 it skips the contents of comments that end before point."
7417 "Return whether or not START...END are matching parens.
7418 END is the current point and START is the blink position.
7419 START might be nil if no matching starter was found.
7420 Returns non-nil if we find there is a mismatch."
7425 ;; For self-matched chars like " and $, we can't know when they're
7426 ;; mismatched or unmatched, so we can only do it for parens.
7431 ;; The cdr might hold a new paren-class info rather than
7432 ;; a matching-char info, in which case the two CDRs
7433 ;; should match.
7437 "Function to check parentheses mismatches.
7438 The function takes two arguments (START and END) where START is the
7439 position just before the opening token and END is the position right after.
7440 START can be nil, if it was not found.
7447 ol)
7451 "Momentarily highlight the beginning of the sexp before point."
7454 blink-matching-paren)
7464 oldpos))
7472 ;; backward-sexp skips backward over prefix chars,
7473 ;; so move back to the matching paren.
7496 ;; Matching open within window, temporarily move to or highlight
7497 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7498 ;; is non-nil.
7515 ;; Show what precedes the open in its line, if anything.
7520 ;; Show what follows the open in its line, if anything.
7527 ;; Otherwise show the previous nonblank line,
7528 ;; if there is one.
7537 ;; Replace the newline and other whitespace with `...'.
7538 "..."
7540 ;; There is nothing to show except the char itself.
7543 "Matches %s"
7547 "Function called, if non-nil, whenever a close parenthesis is inserted.
7553 blink-paren-function
7556 ;; Verify an even number of quoting characters precede the close.
7557 ;; FIXME: Also check if this parenthesis closes a comment as
7558 ;; can happen in Pascal and SML.
7569 ;; Most likely, this hook is nil, so this arg doesn't matter,
7570 ;; but I use it as a reminder that this function usually
7571 ;; likes to be run after others since it does
7572 ;; `sit-for'. That's also the reason it get a `priority' prop
7573 ;; of 100.
7575 \f
7576 ;; This executes C-g typed while Emacs is waiting for a command.
7577 ;; Quitting out of a program does not go through here;
7578 ;; that happens in the maybe_quit function at the C code level.
7580 "Signal a `quit' condition.
7581 During execution of Lisp code, this character causes a quit directly.
7582 At top-level, as an editor command, this simply beeps."
7584 ;; Avoid adding the region to the window selection.
7592 ;; Force the next redisplay cycle to remove the "Def" indicator from
7593 ;; all the mode lines.
7607 This command can exit an interactive command such as `query-replace',
7608 can clear out a prefix argument or a region,
7609 can get out of the minibuffer or other recursive edit,
7610 cancel the use of the current buffer (for special-purpose buffers),
7611 or go back to just one window (by deleting all but the selected window)."
7619 nil)
7630 "Play sound stored in FILE.
7631 VOLUME and DEVICE correspond to the keywords of the sound
7632 specification for `play-sound'."
7642 \f
7644 "Your preference for a mail reading package.
7645 This is used by some keybindings which support reading mail.
7646 See also `mail-user-agent' concerning sending mail."
7656 "Your preference for a mail composition package.
7657 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7658 outgoing email message. This variable lets you specify which
7659 mail-sending package you prefer.
7661 Valid values include:
7663 `message-user-agent' -- use the Message package.
7664 See Info node `(message)'.
7665 `sendmail-user-agent' -- use the Mail package.
7666 See Info node `(emacs)Sending Mail'.
7667 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7668 See Info node `(mh-e)'.
7669 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7670 paraphernalia if Gnus is running, particularly
7671 the Gcc: header for archiving.
7673 Additional valid symbols may be available; check with the author of
7674 your package for details. The function should return non-nil if it
7675 succeeds.
7677 See also `read-mail-command' concerning reading mail."
7680 message-user-agent)
7683 sendmail-user-agent)
7686 mh-e-user-agent)
7689 gnus-user-agent)
7695 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7696 If the value of `mail-user-agent' is the default, and the user
7697 appears to have customizations applying to the old default,
7698 `compose-mail' issues a warning."
7704 "If the buffer starts with a mail header, move point to the header's end.
7705 Otherwise, moves to `point-min'.
7706 The end of the header is the start of the next line, if there is one,
7707 else the end of the last line. This function obeys RFC822."
7713 ;; Used by Rmail (e.g., rmail-forward).
7715 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7719 switch-function yank-action send-actions
7720 return-action)
7721 "Start composing a mail message to send.
7722 This uses the user's chosen mail composition package
7723 as selected with the variable `mail-user-agent'.
7724 The optional arguments TO and SUBJECT specify recipients
7725 and the initial Subject field, respectively.
7727 OTHER-HEADERS is an alist specifying additional
7728 header fields. Elements look like (HEADER . VALUE) where both
7729 HEADER and VALUE are strings.
7731 CONTINUE, if non-nil, says to continue editing a message already
7732 being composed. Interactively, CONTINUE is the prefix argument.
7734 SWITCH-FUNCTION, if non-nil, is a function to use to
7735 switch to and display the buffer used for mail composition.
7737 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7738 to insert the raw text of the message being replied to.
7739 It has the form (FUNCTION . ARGS). The user agent will apply
7740 FUNCTION to ARGS, to insert the raw text of the original message.
7741 \(The user agent will also run `mail-citation-hook', *after* the
7742 original text has been inserted in this way.)
7744 SEND-ACTIONS is a list of actions to call when the message is sent.
7745 Each action has the form (FUNCTION . ARGS).
7747 RETURN-ACTION, if non-nil, is an action for returning to the
7748 caller. It has the form (FUNCTION . ARGS). The function is
7749 called after the mail has been sent or put aside, and the mail
7750 buffer buried."
7754 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7755 ;; from sendmail-user-agent to message-user-agent. Some users may
7756 ;; encounter incompatibilities. This hack tries to detect problems
7757 ;; and warn about them.
7762 mail-yank-hooks mail-archive-file-name
7763 mail-default-reply-to mail-mailing-lists
7764 mail-self-blind))
7771 The default mail mode is now Message mode.
7772 You have the following Mail mode variable%s customized:
7774 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7781 yank-action send-actions return-action)))
7784 yank-action send-actions
7785 return-action)
7789 'switch-to-buffer-other-window yank-action send-actions
7790 return-action))
7793 yank-action send-actions
7794 return-action)
7798 'switch-to-buffer-other-frame yank-action send-actions
7799 return-action))
7801 \f
7803 "History of values entered with `set-variable'.
7805 Maximum length of the history list is determined by the value
7809 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7810 VARIABLE should be a user option variable name, a Lisp variable
7811 meant to be customized by users. You should enter VALUE in Lisp syntax,
7812 so if you want VALUE to be a string, you must surround it with doublequotes.
7813 VALUE is used literally, not evaluated.
7815 If VARIABLE has a `variable-interactive' property, that is used as if
7816 it were the arg to `interactive' (which see) to interactively read VALUE.
7818 If VARIABLE has been defined with `defcustom', then the type information
7819 in the definition is used to check that VALUE is valid.
7821 Note that this function is at heart equivalent to the basic `set' function.
7822 For a variable defined with `defcustom', it does not pay attention to
7823 any :set property that the variable might have (if you want that, use
7826 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7831 default-var)
7847 var obsolete)
7850 ;; Use VAR's `variable-interactive' property
7851 ;; as an interactive spec for prompting.
7854 arg))
7856 read-expression-map t
7857 'set-variable-value-history
7866 ;; Match with custom type.
7878 ;; Force a thorough redisplay for the case that the variable
7879 ;; has an effect on the display, like `tab-width' has.
7881 \f
7882 ;; Define the major mode for lists of completions.
7892 (define-key map [right] 'next-completion)
7894 (define-key map [backtab] 'previous-completion)
7895 (define-key map "q" 'quit-window)
7896 (define-key map "z" 'kill-this-buffer)
7897 map)
7898 "Local map for completion list buffers.")
7900 ;; Completion mode is suitable only for specially formatted data.
7901 (put 'completion-list-mode 'mode-class 'special)
7903 (defvar completion-reference-buffer nil
7904 "Record the buffer that was current when the completion list was requested.
7905 This is a local variable in the completion list buffer.
7906 Initial value is nil to avoid some compiler warnings.")
7908 (defvar completion-no-auto-exit nil
7909 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7910 This also applies to other functions such as `choose-completion'.")
7912 (defvar completion-base-position nil
7913 "Position of the base of the text corresponding to the shown completions.
7914 This variable is used in the *Completions* buffers.
7915 Its value is a list of the form (START END) where START is the place
7916 where the completion should be inserted and END (if non-nil) is the end
7917 of the text to replace. If END is nil, point is used instead.")
7919 (defvar completion-list-insert-choice-function #'completion--replace
7920 "Function to use to insert the text chosen in *Completions*.
7921 Called with three arguments (BEG END TEXT), it should replace the text
7922 between BEG and END with TEXT. Expected to be set buffer-locally
7923 in the *Completions* buffer.")
7925 (defvar completion-base-size nil
7926 "Number of chars before point not involved in completion.
7927 This is a local variable in the completion list buffer.
7928 It refers to the chars in the minibuffer if completing in the
7929 minibuffer, or in `completion-reference-buffer' otherwise.
7930 Only characters in the field at point are included.
7932 If nil, Emacs determines which part of the tail end of the
7933 buffer's text is involved in completion by comparing the text
7934 directly.")
7935 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7937 (defun delete-completion-window ()
7938 "Delete the completion list window.
7939 Go to the window from which completion was requested."
7940 (interactive)
7941 (let ((buf completion-reference-buffer))
7942 (if (one-window-p t)
7943 (if (window-dedicated-p) (delete-frame))
7944 (delete-window (selected-window))
7945 (if (get-buffer-window buf)
7946 (select-window (get-buffer-window buf))))))
7948 (defun previous-completion (n)
7949 "Move to the previous item in the completion list."
7950 (interactive "p")
7951 (next-completion (- n)))
7953 (defun next-completion (n)
7954 "Move to the next item in the completion list.
7955 With prefix argument N, move N items (negative N means move backward)."
7956 (interactive "p")
7957 (let ((beg (point-min)) (end (point-max)))
7958 (while (and (> n 0) (not (eobp)))
7959 ;; If in a completion, move to the end of it.
7960 (when (get-text-property (point) 'mouse-face)
7961 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7962 ;; Move to start of next one.
7963 (unless (get-text-property (point) 'mouse-face)
7964 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7965 (setq n (1- n)))
7966 (while (and (< n 0) (not (bobp)))
7967 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7968 ;; If in a completion, move to the start of it.
7969 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7970 (goto-char (previous-single-property-change
7971 (point) 'mouse-face nil beg)))
7972 ;; Move to end of the previous completion.
7973 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7974 (goto-char (previous-single-property-change
7975 (point) 'mouse-face nil beg)))
7976 ;; Move to the start of that one.
7977 (goto-char (previous-single-property-change
7978 (point) 'mouse-face nil beg))
7979 (setq n (1+ n))))))
7981 (defun choose-completion (&optional event)
7982 "Choose the completion at point.
7983 If EVENT, use EVENT's position to determine the starting position."
7984 (interactive (list last-nonmenu-event))
7985 ;; In case this is run via the mouse, give temporary modes such as
7986 ;; isearch a chance to turn off.
7987 (run-hooks 'mouse-leave-buffer-hook)
7988 (with-current-buffer (window-buffer (posn-window (event-start event)))
7989 (let ((buffer completion-reference-buffer)
7990 (base-size completion-base-size)
7991 (base-position completion-base-position)
7992 (insert-function completion-list-insert-choice-function)
7993 (choice
7994 (save-excursion
7995 (goto-char (posn-point (event-start event)))
7996 (let (beg end)
7997 (cond
7998 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7999 (setq end (point) beg (1+ (point))))
8000 ((and (not (bobp))
8001 (get-text-property (1- (point)) 'mouse-face))
8002 (setq end (1- (point)) beg (point)))
8003 (t (error "No completion here")))
8004 (setq beg (previous-single-property-change beg 'mouse-face))
8005 (setq end (or (next-single-property-change end 'mouse-face)
8006 (point-max)))
8007 (buffer-substring-no-properties beg end)))))
8009 (unless (buffer-live-p buffer)
8010 (error "Destination buffer is dead"))
8011 (quit-window nil (posn-window (event-start event)))
8013 (with-current-buffer buffer
8014 (choose-completion-string
8015 choice buffer
8016 (or base-position
8017 (when base-size
8018 ;; Someone's using old completion code that doesn't know
8019 ;; about base-position yet.
8020 (list (+ base-size (field-beginning))))
8021 ;; If all else fails, just guess.
8022 (list (choose-completion-guess-base-position choice)))
8023 insert-function)))))
8025 ;; Delete the longest partial match for STRING
8026 ;; that can be found before POINT.
8027 (defun choose-completion-guess-base-position (string)
8028 (save-excursion
8029 (let ((opoint (point))
8030 len)
8031 ;; Try moving back by the length of the string.
8032 (goto-char (max (- (point) (length string))
8033 (minibuffer-prompt-end)))
8034 ;; See how far back we were actually able to move. That is the
8035 ;; upper bound on how much we can match and delete.
8036 (setq len (- opoint (point)))
8037 (if completion-ignore-case
8038 (setq string (downcase string)))
8039 (while (and (> len 0)
8040 (let ((tail (buffer-substring (point) opoint)))
8041 (if completion-ignore-case
8042 (setq tail (downcase tail)))
8043 (not (string= tail (substring string 0 len)))))
8044 (setq len (1- len))
8045 (forward-char 1))
8046 (point))))
8048 (defun choose-completion-delete-max-match (string)
8049 (declare (obsolete choose-completion-guess-base-position "23.2"))
8050 (delete-region (choose-completion-guess-base-position string) (point)))
8052 (defvar choose-completion-string-functions nil
8053 "Functions that may override the normal insertion of a completion choice.
8054 These functions are called in order with three arguments:
8055 CHOICE - the string to insert in the buffer,
8056 BUFFER - the buffer in which the choice should be inserted,
8057 BASE-POSITION - where to insert the completion.
8059 If a function in the list returns non-nil, that function is supposed
8060 to have inserted the CHOICE in the BUFFER, and possibly exited
8061 the minibuffer; no further functions will be called.
8063 If all functions in the list return nil, that means to use
8064 the default method of inserting the completion in BUFFER.")
8066 (defun choose-completion-string (choice &optional
8067 buffer base-position insert-function)
8068 "Switch to BUFFER and insert the completion choice CHOICE.
8069 BASE-POSITION says where to insert the completion.
8070 INSERT-FUNCTION says how to insert the completion and falls
8071 back on `completion-list-insert-choice-function' when nil."
8073 ;; If BUFFER is the minibuffer, exit the minibuffer
8074 ;; unless it is reading a file name and CHOICE is a directory,
8075 ;; or completion-no-auto-exit is non-nil.
8077 ;; Some older code may call us passing `base-size' instead of
8078 ;; `base-position'. It's difficult to make any use of `base-size',
8079 ;; so we just ignore it.
8080 (unless (consp base-position)
8081 (message "Obsolete `base-size' passed to choose-completion-string")
8082 (setq base-position nil))
8084 (let* ((buffer (or buffer completion-reference-buffer))
8085 (mini-p (minibufferp buffer)))
8086 ;; If BUFFER is a minibuffer, barf unless it's the currently
8087 ;; active minibuffer.
8088 (if (and mini-p
8089 (not (and (active-minibuffer-window)
8090 (equal buffer
8091 (window-buffer (active-minibuffer-window))))))
8092 (error "Minibuffer is not active for completion")
8093 ;; Set buffer so buffer-local choose-completion-string-functions works.
8094 (set-buffer buffer)
8095 (unless (run-hook-with-args-until-success
8096 'choose-completion-string-functions
8097 ;; The fourth arg used to be `mini-p' but was useless
8098 ;; (since minibufferp can be used on the `buffer' arg)
8099 ;; and indeed unused. The last used to be `base-size', so we
8100 ;; keep it to try and avoid breaking old code.
8101 choice buffer base-position nil)
8102 ;; This remove-text-properties should be unnecessary since `choice'
8103 ;; comes from buffer-substring-no-properties.
8104 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8105 ;; Insert the completion into the buffer where it was requested.
8106 (funcall (or insert-function completion-list-insert-choice-function)
8107 (or (car base-position) (point))
8108 (or (cadr base-position) (point))
8109 choice)
8110 ;; Update point in the window that BUFFER is showing in.
8111 (let ((window (get-buffer-window buffer t)))
8112 (set-window-point window (point)))
8113 ;; If completing for the minibuffer, exit it with this choice.
8114 (and (not completion-no-auto-exit)
8115 (minibufferp buffer)
8116 minibuffer-completion-table
8117 ;; If this is reading a file name, and the file name chosen
8118 ;; is a directory, don't exit the minibuffer.
8119 (let* ((result (buffer-substring (field-beginning) (point)))
8120 (bounds
8121 (completion-boundaries result minibuffer-completion-table
8122 minibuffer-completion-predicate
8123 "")))
8124 (if (eq (car bounds) (length result))
8125 ;; The completion chosen leads to a new set of completions
8126 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8127 (let ((mini (active-minibuffer-window)))
8128 (select-window mini)
8129 (when minibuffer-auto-raise
8130 (raise-frame (window-frame mini))))
8131 (exit-minibuffer))))))))
8133 (define-derived-mode completion-list-mode nil "Completion List"
8134 "Major mode for buffers showing lists of possible completions.
8136 to select the completion near point.
8137 Or click to select one with the mouse.
8140 (set (make-local-variable 'completion-base-size) nil))
8142 (defun completion-list-mode-finish ()
8143 "Finish setup of the completions buffer.
8144 Called from `temp-buffer-show-hook'."
8145 (when (eq major-mode 'completion-list-mode)
8146 (setq buffer-read-only t)))
8148 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8151 ;; Variables and faces used in `completion-setup-function'.
8153 (defcustom completion-show-help t
8154 "Non-nil means show help message in *Completions* buffer."
8155 :type 'boolean
8156 :version "22.1"
8157 :group 'completion)
8159 ;; This function goes in completion-setup-hook, so that it is called
8160 ;; after the text of the completion list buffer is written.
8161 (defun completion-setup-function ()
8162 (let* ((mainbuf (current-buffer))
8163 (base-dir
8164 ;; FIXME: This is a bad hack. We try to set the default-directory
8165 ;; in the *Completions* buffer so that the relative file names
8166 ;; displayed there can be treated as valid file names, independently
8167 ;; from the completion context. But this suffers from many problems:
8168 ;; - It's not clear when the completions are file names. With some
8169 ;; completion tables (e.g. bzr revision specs), the listed
8170 ;; completions can mix file names and other things.
8171 ;; - It doesn't pay attention to possible quoting.
8172 ;; - With fancy completion styles, the code below will not always
8173 ;; find the right base directory.
8174 (if minibuffer-completing-file-name
8175 (file-name-as-directory
8176 (expand-file-name
8177 (buffer-substring (minibuffer-prompt-end)
8178 (- (point) (or completion-base-size 0))))))))
8179 (with-current-buffer standard-output
8180 (let ((base-size completion-base-size) ;Read before killing localvars.
8181 (base-position completion-base-position)
8182 (insert-fun completion-list-insert-choice-function))
8183 (completion-list-mode)
8184 (set (make-local-variable 'completion-base-size) base-size)
8185 (set (make-local-variable 'completion-base-position) base-position)
8186 (set (make-local-variable 'completion-list-insert-choice-function)
8187 insert-fun))
8188 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8189 (if base-dir (setq default-directory base-dir))
8190 ;; Maybe insert help string.
8191 (when completion-show-help
8192 (goto-char (point-min))
8193 (if (display-mouse-p)
8195 (insert (substitute-command-keys
8199 (add-hook 'completion-setup-hook 'completion-setup-function)
8201 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8202 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8204 (defun switch-to-completions ()
8205 "Select the completion list window."
8206 (interactive)
8207 (let ((window (or (get-buffer-window "*Completions*" 0)
8208 ;; Make sure we have a completions window.
8209 (progn (minibuffer-completion-help)
8210 (get-buffer-window "*Completions*" 0)))))
8211 (when window
8212 (select-window window)
8213 ;; In the new buffer, go to the first completion.
8214 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8215 (when (bobp)
8216 (next-completion 1)))))
8217 \f
8218 ;;; Support keyboard commands to turn on various modifiers.
8220 ;; These functions -- which are not commands -- each add one modifier
8221 ;; to the following event.
8223 (defun event-apply-alt-modifier (_ignore-prompt)
8226 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8227 (defun event-apply-super-modifier (_ignore-prompt)
8230 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8231 (defun event-apply-hyper-modifier (_ignore-prompt)
8234 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8235 (defun event-apply-shift-modifier (_ignore-prompt)
8238 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8239 (defun event-apply-control-modifier (_ignore-prompt)
8242 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8243 (defun event-apply-meta-modifier (_ignore-prompt)
8246 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8248 (defun event-apply-modifier (event symbol lshiftby prefix)
8249 "Apply a modifier flag to event EVENT.
8250 SYMBOL is the name of this modifier, as a symbol.
8251 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8252 PREFIX is the string that represents this modifier in an event type symbol."
8253 (if (numberp event)
8254 (cond ((eq symbol 'control)
8255 (if (and (<= (downcase event) ?z)
8256 (>= (downcase event) ?a))
8257 (- (downcase event) ?a -1)
8258 (if (and (<= (downcase event) ?Z)
8259 (>= (downcase event) ?A))
8260 (- (downcase event) ?A -1)
8261 (logior (lsh 1 lshiftby) event))))
8262 ((eq symbol 'shift)
8263 (if (and (<= (downcase event) ?z)
8264 (>= (downcase event) ?a))
8265 (upcase event)
8266 (logior (lsh 1 lshiftby) event)))
8267 (t
8268 (logior (lsh 1 lshiftby) event)))
8269 (if (memq symbol (event-modifiers event))
8270 event
8271 (let ((event-type (if (symbolp event) event (car event))))
8272 (setq event-type (intern (concat prefix (symbol-name event-type))))
8273 (if (symbolp event)
8274 event-type
8275 (cons event-type (cdr event)))))))
8277 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8278 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8279 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8280 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8281 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8282 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8283 \f
8284 ;;;; Keypad support.
8286 ;; Make the keypad keys act like ordinary typing keys. If people add
8287 ;; bindings for the function key symbols, then those bindings will
8288 ;; override these, so this shouldn't interfere with any existing
8289 ;; bindings.
8291 ;; Also tell read-char how to handle these keys.
8292 (mapc
8293 (lambda (keypad-normal)
8294 (let ((keypad (nth 0 keypad-normal))
8295 (normal (nth 1 keypad-normal)))
8296 (put keypad 'ascii-character normal)
8297 (define-key function-key-map (vector keypad) (vector normal))))
8298 ;; See also kp-keys bound in bindings.el.
8299 '((kp-space ?\s)
8302 (kp-separator ?,)
8303 (kp-equal ?=)
8304 ;; Do the same for various keys that are represented as symbols under
8305 ;; GUIs but naturally correspond to characters.
8306 (backspace 127)
8307 (delete 127)
8310 (clear ?\C-l)
8311 (return ?\C-m)
8312 (escape ?\e)
8313 ))
8314 \f
8315 ;;;;
8316 ;;;; forking a twin copy of a buffer.
8317 ;;;;
8319 (defvar clone-buffer-hook nil
8320 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8322 (defvar clone-indirect-buffer-hook nil
8323 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8325 (defun clone-process (process &optional newname)
8326 "Create a twin copy of PROCESS.
8327 If NEWNAME is nil, it defaults to PROCESS' name;
8328 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8329 If PROCESS is associated with a buffer, the new process will be associated
8330 with the current buffer instead.
8331 Returns nil if PROCESS has already terminated."
8332 (setq newname (or newname (process-name process)))
8334 (setq newname (substring newname 0 (match-beginning 0))))
8335 (when (memq (process-status process) '(run stop open))
8336 (let* ((process-connection-type (process-tty-name process))
8337 (new-process
8338 (if (memq (process-status process) '(open))
8339 (let ((args (process-contact process t)))
8340 (setq args (plist-put args :name newname))
8341 (setq args (plist-put args :buffer
8342 (if (process-buffer process)
8343 (current-buffer))))
8344 (apply 'make-network-process args))
8345 (apply 'start-process newname
8346 (if (process-buffer process) (current-buffer))
8347 (process-command process)))))
8348 (set-process-query-on-exit-flag
8349 new-process (process-query-on-exit-flag process))
8350 (set-process-inherit-coding-system-flag
8351 new-process (process-inherit-coding-system-flag process))
8352 (set-process-filter new-process (process-filter process))
8353 (set-process-sentinel new-process (process-sentinel process))
8354 (set-process-plist new-process (copy-sequence (process-plist process)))
8355 new-process)))
8357 ;; things to maybe add (currently partly covered by `funcall mode'):
8358 ;; - syntax-table
8359 ;; - overlays
8360 (defun clone-buffer (&optional newname display-flag)
8361 "Create and return a twin copy of the current buffer.
8362 Unlike an indirect buffer, the new buffer can be edited
8363 independently of the old one (if it is not read-only).
8364 NEWNAME is the name of the new buffer. It may be modified by
8365 adding or incrementing <N> at the end as necessary to create a
8366 unique buffer name. If nil, it defaults to the name of the
8367 current buffer, with the proper suffix. If DISPLAY-FLAG is
8368 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8369 clone a file-visiting buffer, or a buffer whose major mode symbol
8370 has a non-nil `no-clone' property, results in an error.
8372 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8373 current buffer with appropriate suffix. However, if a prefix
8374 argument is given, then the command prompts for NEWNAME in the
8375 minibuffer.
8377 This runs the normal hook `clone-buffer-hook' in the new buffer
8378 after it has been set up properly in other respects."
8379 (interactive
8380 (progn
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 (list (if current-prefix-arg
8386 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8387 t)))
8388 (if buffer-file-name
8389 (error "Cannot clone a file-visiting buffer"))
8390 (if (get major-mode 'no-clone)
8391 (error "Cannot clone a buffer in %s mode" mode-name))
8392 (setq newname (or newname (buffer-name)))
8394 (setq newname (substring newname 0 (match-beginning 0))))
8395 (let ((buf (current-buffer))
8396 (ptmin (point-min))
8397 (ptmax (point-max))
8398 (pt (point))
8399 (mk (if mark-active (mark t)))
8400 (modified (buffer-modified-p))
8401 (mode major-mode)
8402 (lvars (buffer-local-variables))
8403 (process (get-buffer-process (current-buffer)))
8404 (new (generate-new-buffer (or newname (buffer-name)))))
8405 (save-restriction
8406 (widen)
8407 (with-current-buffer new
8408 (insert-buffer-substring buf)))
8409 (with-current-buffer new
8410 (narrow-to-region ptmin ptmax)
8411 (goto-char pt)
8412 (if mk (set-mark mk))
8413 (set-buffer-modified-p modified)
8415 ;; Clone the old buffer's process, if any.
8416 (when process (clone-process process))
8418 ;; Now set up the major mode.
8419 (funcall mode)
8421 ;; Set up other local variables.
8422 (mapc (lambda (v)
8423 (condition-case () ;in case var is read-only
8424 (if (symbolp v)
8425 (makunbound v)
8426 (set (make-local-variable (car v)) (cdr v)))
8427 (error nil)))
8428 lvars)
8430 ;; Run any hooks (typically set up by the major mode
8431 ;; for cloning to work properly).
8432 (run-hooks 'clone-buffer-hook))
8433 (if display-flag
8434 ;; Presumably the current buffer is shown in the selected frame, so
8435 ;; we want to display the clone elsewhere.
8436 (let ((same-window-regexps nil)
8437 (same-window-buffer-names))
8438 (pop-to-buffer new)))
8439 new))
8442 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8443 "Create an indirect buffer that is a twin copy of the current buffer.
8445 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8446 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8447 or if not called with a prefix arg, NEWNAME defaults to the current
8448 buffer's name. The name is modified by adding a `<N>' suffix to it
8449 or by incrementing the N in an existing suffix. Trying to clone a
8450 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8451 property results in an error.
8453 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8454 This is always done when called interactively.
8456 Optional third arg NORECORD non-nil means do not put this buffer at the
8457 front of the list of recently selected ones.
8459 Returns the newly created indirect buffer."
8460 (interactive
8461 (progn
8462 (if (get major-mode 'no-clone-indirect)
8463 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8464 (list (if current-prefix-arg
8465 (read-buffer "Name of indirect buffer: " (current-buffer)))
8466 t)))
8467 (if (get major-mode 'no-clone-indirect)
8468 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8469 (setq newname (or newname (buffer-name)))
8471 (setq newname (substring newname 0 (match-beginning 0))))
8472 (let* ((name (generate-new-buffer-name newname))
8473 (buffer (make-indirect-buffer (current-buffer) name t)))
8474 (with-current-buffer buffer
8475 (run-hooks 'clone-indirect-buffer-hook))
8476 (when display-flag
8477 (pop-to-buffer buffer nil norecord))
8478 buffer))
8481 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8482 "Like `clone-indirect-buffer' but display in another window."
8483 (interactive
8484 (progn
8485 (if (get major-mode 'no-clone-indirect)
8486 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8487 (list (if current-prefix-arg
8488 (read-buffer "Name of indirect buffer: " (current-buffer)))
8489 t)))
8490 (let ((pop-up-windows t))
8491 (clone-indirect-buffer newname display-flag norecord)))
8493 \f
8494 ;;; Handling of Backspace and Delete keys.
8496 (defcustom normal-erase-is-backspace 'maybe
8497 "Set the default behavior of the Delete and Backspace keys.
8499 If set to t, Delete key deletes forward and Backspace key deletes
8500 backward.
8502 If set to nil, both Delete and Backspace keys delete backward.
8504 If set to `maybe' (which is the default), Emacs automatically
8505 selects a behavior. On window systems, the behavior depends on
8506 the keyboard used. If the keyboard has both a Backspace key and
8507 a Delete key, and both are mapped to their usual meanings, the
8508 option's default value is set to t, so that Backspace can be used
8509 to delete backward, and Delete can be used to delete forward.
8511 If not running under a window system, customizing this option
8512 accomplishes a similar effect by mapping C-h, which is usually
8513 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8514 via `keyboard-translate'. The former functionality of C-h is
8515 available on the F1 key. You should probably not use this
8516 setting if you don't have both Backspace, Delete and F1 keys.
8518 Setting this variable with setq doesn't take effect. Programmatically,
8519 call `normal-erase-is-backspace-mode' (which see) instead."
8520 :type '(choice (const :tag "Off" nil)
8521 (const :tag "Maybe" maybe)
8522 (other :tag "On" t))
8523 :group 'editing-basics
8524 :version "21.1"
8525 :set (lambda (symbol value)
8526 ;; The fboundp is because of a problem with :set when
8527 ;; dumping Emacs. It doesn't really matter.
8528 (if (fboundp 'normal-erase-is-backspace-mode)
8529 (normal-erase-is-backspace-mode (or value 0))
8530 (set-default symbol value))))
8532 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8533 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8534 (unless frame (setq frame (selected-frame)))
8535 (with-selected-frame frame
8536 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8537 (normal-erase-is-backspace-mode
8538 (if (if (eq normal-erase-is-backspace 'maybe)
8539 (and (not noninteractive)
8540 (or (memq system-type '(ms-dos windows-nt))
8541 (memq window-system '(w32 ns))
8542 (and (memq window-system '(x))
8543 (fboundp 'x-backspace-delete-keys-p)
8544 (x-backspace-delete-keys-p))
8545 ;; If the terminal Emacs is running on has erase char
8546 ;; set to ^H, use the Backspace key for deleting
8547 ;; backward, and the Delete key for deleting forward.
8548 (and (null window-system)
8549 (eq tty-erase-char ?\^H))))
8550 normal-erase-is-backspace)
8551 1 0)))))
8553 (define-minor-mode normal-erase-is-backspace-mode
8554 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8555 With a prefix argument ARG, enable this feature if ARG is
8556 positive, and disable it otherwise. If called from Lisp, enable
8557 the mode if ARG is omitted or nil.
8559 On window systems, when this mode is on, Delete is mapped to C-d
8560 and Backspace is mapped to DEL; when this mode is off, both
8561 Delete and Backspace are mapped to DEL. (The remapping goes via
8562 `local-function-key-map', so binding Delete or Backspace in the
8563 global or local keymap will override that.)
8565 In addition, on window systems, the bindings of C-Delete, M-Delete,
8566 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8567 the global keymap in accordance with the functionality of Delete and
8568 Backspace. For example, if Delete is remapped to C-d, which deletes
8569 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8570 to DEL, which deletes backward, C-Delete is bound to
8571 `backward-kill-word'.
8573 If not running on a window system, a similar effect is accomplished by
8574 remapping C-h (normally produced by the Backspace key) and DEL via
8575 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8576 to C-d; if it's off, the keys are not remapped.
8578 When not running on a window system, and this mode is turned on, the
8579 former functionality of C-h is available on the F1 key. You should
8580 probably not turn on this mode on a text-only terminal if you don't
8581 have both Backspace, Delete and F1 keys.
8583 See also `normal-erase-is-backspace'."
8584 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8585 . (lambda (v)
8586 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8587 (if v 1 0))))
8588 (let ((enabled (eq 1 (terminal-parameter
8589 nil 'normal-erase-is-backspace))))
8591 (cond ((or (memq window-system '(x w32 ns pc))
8592 (memq system-type '(ms-dos windows-nt)))
8593 (let ((bindings
8594 `(([M-delete] [M-backspace])
8595 ([C-M-delete] [C-M-backspace])
8596 ([?\e C-delete] [?\e C-backspace]))))
8598 (if enabled
8599 (progn
8600 (define-key local-function-key-map [delete] [deletechar])
8601 (define-key local-function-key-map [kp-delete] [deletechar])
8602 (define-key local-function-key-map [backspace] [?\C-?])
8603 (dolist (b bindings)
8604 ;; Not sure if input-decode-map is really right, but
8605 ;; keyboard-translate-table (used below) only works
8606 ;; for integer events, and key-translation-table is
8607 ;; global (like the global-map, used earlier).
8608 (define-key input-decode-map (car b) nil)
8609 (define-key input-decode-map (cadr b) nil)))
8610 (define-key local-function-key-map [delete] [?\C-?])
8611 (define-key local-function-key-map [kp-delete] [?\C-?])
8612 (define-key local-function-key-map [backspace] [?\C-?])
8613 (dolist (b bindings)
8614 (define-key input-decode-map (car b) (cadr b))
8615 (define-key input-decode-map (cadr b) (car b))))))
8616 (t
8617 (if enabled
8618 (progn
8619 (keyboard-translate ?\C-h ?\C-?)
8620 (keyboard-translate ?\C-? ?\C-d))
8621 (keyboard-translate ?\C-h ?\C-h)
8622 (keyboard-translate ?\C-? ?\C-?))))
8624 (if (called-interactively-p 'interactive)
8625 (message "Delete key deletes %s"
8626 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8627 "forward" "backward")))))
8628 \f
8629 (defvar vis-mode-saved-buffer-invisibility-spec nil
8630 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8632 (define-minor-mode read-only-mode
8633 "Change whether the current buffer is read-only.
8634 With prefix argument ARG, make the buffer read-only if ARG is
8635 positive, otherwise make it writable. If buffer is read-only
8636 and `view-read-only' is non-nil, enter view mode.
8638 Do not call this from a Lisp program unless you really intend to
8640 possibly enabling or disabling View mode. Also, note that this
8641 command works by setting the variable `buffer-read-only', which
8642 does not affect read-only regions caused by text properties. To
8643 ignore read-only status in a Lisp program (whether due to text
8644 properties or buffer state), bind `inhibit-read-only' temporarily
8645 to a non-nil value."
8646 :variable buffer-read-only
8647 (cond
8648 ((and (not buffer-read-only) view-mode)
8649 (View-exit-and-edit)
8650 (make-local-variable 'view-read-only)
8651 (setq view-read-only t)) ; Must leave view mode.
8652 ((and buffer-read-only view-read-only
8653 ;; If view-mode is already active, `view-mode-enter' is a nop.
8654 (not view-mode)
8655 (not (eq (get major-mode 'mode-class) 'special)))
8656 (view-mode-enter))))
8658 (define-minor-mode visible-mode
8659 "Toggle making all invisible text temporarily visible (Visible mode).
8660 With a prefix argument ARG, enable Visible mode if ARG is
8661 positive, and disable it otherwise. If called from Lisp, enable
8662 the mode if ARG is omitted or nil.
8664 This mode works by saving the value of `buffer-invisibility-spec'
8665 and setting it to nil."
8666 :lighter " Vis"
8667 :group 'editing-basics
8668 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8669 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8670 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8671 (when visible-mode
8672 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8673 buffer-invisibility-spec)
8674 (setq buffer-invisibility-spec nil)))
8675 \f
8676 (defvar messages-buffer-mode-map
8677 (let ((map (make-sparse-keymap)))
8678 (set-keymap-parent map special-mode-map)
8679 (define-key map "g" nil) ; nothing to revert
8680 map))
8682 (define-derived-mode messages-buffer-mode special-mode "Messages"
8685 (defun messages-buffer ()
8687 If it does not exist, create and it switch it to `messages-buffer-mode'."
8688 (or (get-buffer "*Messages*")
8689 (with-current-buffer (get-buffer-create "*Messages*")
8690 (messages-buffer-mode)
8691 (current-buffer))))
8693 \f
8694 ;; Minibuffer prompt stuff.
8696 ;;(defun minibuffer-prompt-modification (start end)
8697 ;; (error "You cannot modify the prompt"))
8698 ;;
8699 ;;
8700 ;;(defun minibuffer-prompt-insertion (start end)
8701 ;; (let ((inhibit-modification-hooks t))
8702 ;; (delete-region start end)
8703 ;; ;; Discard undo information for the text insertion itself
8704 ;; ;; and for the text deletion.above.
8705 ;; (when (consp buffer-undo-list)
8706 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8707 ;; (message "You cannot modify the prompt")))
8708 ;;
8709 ;;
8710 ;;(setq minibuffer-prompt-properties
8711 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8712 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8714 \f
8715 ;;;; Problematic external packages.
8717 ;; rms says this should be done by specifying symbols that define
8718 ;; versions together with bad values. This is therefore not as
8719 ;; flexible as it could be. See the thread:
8720 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8721 (defconst bad-packages-alist
8722 ;; Not sure exactly which semantic versions have problems.
8723 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8725 "The version of `semantic' loaded does not work in Emacs 22.
8726 It can cause constant high CPU load.
8727 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8728 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8729 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8730 ;; provided the `CUA-mode' feature. Since this is no longer true,
8731 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8732 (CUA-mode t nil
8733 "CUA-mode is now part of the standard GNU Emacs distribution,
8734 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8736 You have loaded an older version of CUA-mode which does not work
8737 correctly with this version of Emacs. You should remove the old
8738 version and use the one distributed with Emacs."))
8739 "Alist of packages known to cause problems in this version of Emacs.
8740 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8741 PACKAGE is either a regular expression to match file names, or a
8742 symbol (a feature name), like for `with-eval-after-load'.
8743 SYMBOL is either the name of a string variable, or t. Upon
8744 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8745 warning using STRING as the message.")
8747 (defun bad-package-check (package)
8748 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8749 (condition-case nil
8750 (let* ((list (assoc package bad-packages-alist))
8751 (symbol (nth 1 list)))
8752 (and list
8753 (boundp symbol)
8754 (or (eq symbol t)
8755 (and (stringp (setq symbol (eval symbol)))
8756 (string-match-p (nth 2 list) symbol)))
8757 (display-warning package (nth 3 list) :warning)))
8758 (error nil)))
8760 (dolist (elem bad-packages-alist)
8761 (let ((pkg (car elem)))
8762 (with-eval-after-load pkg
8763 (bad-package-check pkg))))
8765 \f
8766 ;;; Generic dispatcher commands
8768 ;; Macro `define-alternatives' is used to create generic commands.
8769 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8770 ;; that can have different alternative implementations where choosing
8771 ;; among them is exclusively a matter of user preference.
8773 ;; (define-alternatives COMMAND) creates a new interactive command
8774 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8775 ;; Typically, the user will not need to customize this variable; packages
8776 ;; wanting to add alternative implementations should use
8777 ;;
8778 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8780 (defmacro define-alternatives (command &rest customizations)
8781 "Define the new command `COMMAND'.
8783 The argument `COMMAND' should be a symbol.
8785 Running `M-x COMMAND RET' for the first time prompts for which
8786 alternative to use and records the selected command as a custom
8787 variable.
8789 Running `C-u M-x COMMAND RET' prompts again for an alternative
8790 and overwrites the previous choice.
8792 The variable `COMMAND-alternatives' contains an alist with
8793 alternative implementations of COMMAND. `define-alternatives'
8794 does not have any effect until this variable is set.
8796 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8797 `defcustom' keywords and values to add to the declaration of
8798 `COMMAND-alternatives' (typically :group and :version)."
8799 (let* ((command-name (symbol-name command))
8800 (varalt-name (concat command-name "-alternatives"))
8801 (varalt-sym (intern varalt-name))
8802 (varimp-sym (intern (concat command-name "--implementation"))))
8803 `(progn
8805 (defcustom ,varalt-sym nil
8806 ,(format "Alist of alternative implementations for the `%s' command.
8808 Each entry must be a pair (ALTNAME . ALTFUN), where:
8809 ALTNAME - The name shown at user to describe the alternative implementation.
8810 ALTFUN - The function called to implement this alternative."
8811 command-name)
8812 :type '(alist :key-type string :value-type function)
8813 ,@customizations)
8815 (put ',varalt-sym 'definition-name ',command)
8816 (defvar ,varimp-sym nil "Internal use only.")
8818 (defun ,command (&optional arg)
8819 ,(format "Run generic command `%s'.
8820 If used for the first time, or with interactive ARG, ask the user which
8821 implementation to use for `%s'. The variable `%s'
8822 contains the list of implementations currently supported for this command."
8823 command-name command-name varalt-name)
8824 (interactive "P")
8825 (when (or arg (null ,varimp-sym))
8826 (let ((val (completing-read
8827 ,(format-message
8828 "Select implementation for command `%s': "
8829 command-name)
8830 ,varalt-sym nil t)))
8831 (unless (string-equal val "")
8832 (when (null ,varimp-sym)
8833 (message
8834 "Use C-u M-x %s RET`to select another implementation"
8835 ,command-name)
8836 (sit-for 3))
8837 (customize-save-variable ',varimp-sym
8838 (cdr (assoc-string val ,varalt-sym))))))
8839 (if ,varimp-sym
8840 (call-interactively ,varimp-sym)
8841 (message "%s" ,(format-message
8842 "No implementation selected for command `%s'"
8843 command-name)))))))
8845 \f
8846 ;;; Functions for changing capitalization that Do What I Mean
8847 (defun upcase-dwim (arg)
8848 "Upcase words in the region, if active; if not, upcase word at point.
8849 If the region is active, this function calls `upcase-region'.
8850 Otherwise, it calls `upcase-word', with prefix argument passed to it
8851 to upcase ARG words."
8852 (interactive "*p")
8853 (if (use-region-p)
8854 (upcase-region (region-beginning) (region-end))
8855 (upcase-word arg)))
8857 (defun downcase-dwim (arg)
8858 "Downcase words in the region, if active; if not, downcase word at point.
8859 If the region is active, this function calls `downcase-region'.
8860 Otherwise, it calls `downcase-word', with prefix argument passed to it
8861 to downcase ARG words."
8862 (interactive "*p")
8863 (if (use-region-p)
8864 (downcase-region (region-beginning) (region-end))
8865 (downcase-word arg)))
8867 (defun capitalize-dwim (arg)
8868 "Capitalize words in the region, if active; if not, capitalize word at point.
8869 If the region is active, this function calls `capitalize-region'.
8870 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8871 to capitalize ARG words."
8872 (interactive "*p")
8873 (if (use-region-p)
8874 (capitalize-region (region-beginning) (region-end))
8875 (capitalize-word arg)))
8877 \f
8879 (provide 'simple)
8881 ;;; simple.el ends here