| blob | edc822eb51e2fe449e2d72c8f20a929815f252d2 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2017 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "If non-nil, output buffer is not erased between shell commands.
42 Also, a non-nil value set the point in the output buffer
43 once the command complete.
44 The value `beg-last-out' set point at the beginning of the output,
45 `end-last-out' set point at the end of the buffer, `save-point'
46 restore the buffer position before the command."
56 "Point position in the output buffer after command complete.
57 It is an alist (BUFFER . POS), where BUFFER is the output
58 buffer, and POS is the point position in BUFFER once the command finish.
62 "Idle time delay before updating various things on the screen.
63 Various Emacs features that update auxiliary information when point moves
64 wait this many seconds after Emacs becomes idle before doing an update."
70 "Killing and yanking commands."
74 "Highlight (un)matching of parens and expressions."
76 \f
77 ;;; next-error support framework
80 "`next-error' support framework."
86 "Face used to highlight next error locus."
91 "Highlighting of locations in selected source buffers.
92 If a number, highlight the locus in `next-error' face for the given time
93 in seconds, or until the next command is executed.
94 If t, highlight the locus until the next command is executed, or until
95 some other locus replaces it.
96 If nil, don't highlight the locus in the source buffer.
97 If `fringe-arrow', indicate the locus by the fringe arrow
98 indefinitely until some other locus replaces it."
107 "Highlighting of locations in `next-error-no-select'.
108 If number, highlight the locus in `next-error' face for given time in seconds.
109 If t, highlight the locus indefinitely until some other locus replaces it.
110 If nil, don't highlight the locus in the source buffer.
111 If `fringe-arrow', indicate the locus by the fringe arrow
112 indefinitely until some other locus replaces it."
121 "Display the line in the visited source file recentered as specified.
122 If non-nil, the value is passed directly to `recenter'."
130 "List of hook functions run by `next-error' after visiting source file."
141 "The most recent `next-error' buffer.
142 A buffer becomes most recent when its compilation, grep, or
147 "Function to use to find the next error in the current buffer.
148 The function is called with 2 parameters:
149 ARG is an integer specifying by how many errors to move.
150 RESET is a boolean which, if non-nil, says to go back to the beginning
151 of the errors before moving.
152 Major modes providing compile-like functionality should set this variable
153 to indicate to `next-error' that this is a candidate buffer and how
158 "Function to use to move to an error locus.
159 It takes two arguments, a buffer position in the error buffer
160 and a buffer position in the error locus buffer.
161 The buffer for the error locus should already be current.
166 &optional avoid-current
167 extra-test-inclusive
168 extra-test-exclusive)
169 "Return non-nil if BUFFER is a `next-error' capable buffer.
170 If AVOID-CURRENT is non-nil, and BUFFER is the current buffer,
171 return nil.
173 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if
174 BUFFER would not normally qualify. If it returns non-nil, BUFFER
175 is considered `next-error' capable, anyway, and the function
176 returns non-nil.
178 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the
179 buffer would normally qualify. If it returns nil, BUFFER is
180 rejected, and the function returns nil."
185 ;; Optionally reject some buffers.
188 t)
189 ;; Optionally accept some other buffers.
194 extra-test-inclusive
195 extra-test-exclusive)
196 "Return a `next-error' capable buffer.
198 If AVOID-CURRENT is non-nil, treat the current buffer
199 as an absolute last resort only.
201 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
202 that normally would not qualify. If it returns t, the buffer
203 in question is treated as usable.
205 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
206 that would normally be considered usable. If it returns nil,
207 that buffer is rejected."
209 ;; 1. If one window on the selected frame displays such buffer, return it.
215 avoid-current
216 extra-test-inclusive extra-test-exclusive)
221 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
224 extra-test-inclusive extra-test-exclusive))
225 next-error-last-buffer)
226 ;; 3. If the current buffer is acceptable, choose it.
228 extra-test-inclusive extra-test-exclusive)
230 ;; 4. Look for any acceptable buffer.
235 extra-test-inclusive extra-test-exclusive)))
238 ;; 5. Use the current buffer as a last resort if it qualifies,
239 ;; even despite AVOID-CURRENT.
242 extra-test-inclusive extra-test-exclusive)
246 ;; 6. Give up.
250 "Visit next `next-error' message and corresponding source code.
252 If all the error messages parsed so far have been processed already,
253 the message buffer is checked for new ones.
255 A prefix ARG specifies how many error messages to move;
256 negative means move back to previous error messages.
258 and start at the first error.
260 The RESET argument specifies that we should restart from the beginning.
263 compilation, grep, or occur buffer. It can also operate on any
265 more generally, on any buffer in Compilation mode or with
266 Compilation Minor mode enabled, or any buffer in which
267 `next-error-function' is bound to an appropriate function.
268 To specify use of a particular buffer for error messages, type
270 in the current frame.
273 runs `next-error-hook' with `run-hooks', and stays with that buffer
274 until you use it in some other buffer which uses Compilation mode
275 or Compilation Minor mode.
277 To control which errors are matched, customize the variable
278 `compilation-error-regexp-alist'."
282 ;; we know here that next-error-function is a valid symbol we can funcall
290 "Visit the source code corresponding to the `next-error' message at point."
292 ;; we know here that next-error-function is a valid symbol we can funcall
303 "Visit previous `next-error' message and corresponding source code.
305 Prefix arg N says how many error messages to move backwards (or
306 forwards, if negative).
313 "Restart at the first error.
314 Visit corresponding source code.
315 With prefix arg N, visit the source code of the Nth error.
321 "Move point to the next error in the `next-error' buffer and highlight match.
322 Prefix arg N says how many error messages to move forwards (or
323 backwards, if negative).
325 select the source buffer."
332 "Move point to the previous error in the `next-error' buffer and highlight match.
333 Prefix arg N says how many error messages to move backwards (or
334 forwards, if negative).
336 select the source buffer."
340 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
344 "Minor mode for compilation, occur and diff modes.
345 With a prefix argument ARG, enable mode if ARG is positive, and
346 disable it otherwise. If called from Lisp, enable mode if ARG is
347 omitted or nil.
348 When turned on, cursor motion in the compilation, grep, occur or diff
349 buffer causes automatic display of the corresponding source code location."
356 ;; Used as a `post-command-hook' by `next-error-follow-mode'
357 ;; for the *Compilation* *grep* and *Occur* buffers.
367 \f
368 ;;;
371 "Major mode not specialized for anything in particular.
372 Other major modes are defined by comparison with this one."
377 ;; Special major modes to view specially formatted data rather than files.
391 map))
395 "Parent major mode from which special major modes should inherit."
398 ;; Making and deleting lines.
401 "Special hook to tell if `self-insert-command' will use the region.
402 It must be called via `run-hook-with-args-until-success' with no arguments.
403 Any `post-self-insert-command' which consumes the region should
404 register a function on this hook so that things like `delete-selection-mode'
411 "Insert a newline, and move to left margin of the new line if it's blank.
412 If option `use-hard-newlines' is non-nil, the newline is marked with the
413 text-property `hard'.
414 With ARG, insert that many newlines.
416 If `electric-indent-mode' is enabled, this indents the final new line
417 that it adds, and reindents the preceding line. To just insert
420 Calls `auto-fill-function' if the current column number is greater
421 than the value of `fill-column' and ARG is nil.
422 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
425 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
426 ;; Set last-command-event to tell self-insert what to insert.
430 ;; Don't auto-fill if we have a numeric argument.
434 ;; Do the rest in post-self-insert-hook, because we want to do it
435 ;; *before* other functions on that hook.
437 ;; We are not going to insert any newlines if arg is
438 ;; non-positive.
441 ;; Mark the newline(s) `hard'.
445 ;; If the newline leaves the previous line blank, and we
446 ;; have a left margin, delete that from the blank line.
454 ;; Indent the line after the newline, except in one case:
455 ;; when we added the newline at the beginning of a line which
456 ;; starts a page.
461 ;; FIXME: For non-interactive uses, many calls actually
462 ;; just want (insert "\n"), so maybe we should do just
463 ;; that, so as to avoid the risk of filling or running
464 ;; abbrevs unexpectedly.
471 ;; We first used let-binding to protect the hook, but that
472 ;; was naive since add-hook affects the symbol-default
473 ;; value of the variable, whereas the let-binding might
474 ;; only protect the buffer-local value.
478 nil)
483 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
489 "Insert a newline and leave point before it.
490 If there is a fill prefix and/or a `left-margin', insert them on
491 the new line if the line would have been blank.
492 With arg N, insert N newlines."
497 ;; Don't expand an abbrev before point.
508 ;; Necessary in case a margin or prefix was inserted.
512 "Split current line, moving portion beyond point vertically down.
513 If the current line starts with `fill-prefix', insert it on the new
514 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
516 When called from Lisp code, ARG may be a prefix string to copy."
521 ;; What prefix should we check for (nil means don't).
525 ;; Does this line start with it?
536 "Join this line to previous and fix up whitespace at join.
537 If there is a fill prefix, delete it from the beginning of this line.
538 With argument, join this line to following line."
545 ;; If the second line started with the fill prefix,
546 ;; delete the prefix.
558 "On blank line, delete all surrounding blank lines, leaving just one.
559 On isolated blank line, delete that one.
560 On nonblank line, delete any immediately following blank lines."
566 ;; Set singleblank if there is just one blank line here.
573 ;; Delete preceding blank lines, and this one too if it's the only one.
582 ;; Delete following blank lines, unless the current line is blank
583 ;; and there are no following blank lines.
592 ;; Handle the special case where point is followed by newline and eob.
593 ;; Delete the line, leaving point at eob.
599 Trailing lines are deleted only if `delete-trailing-whitespace'
600 is called on the entire buffer (rather than an active region)."
606 "Return non-nil if the region contains no read-only text."
611 "Delete trailing whitespace between START and END.
612 If called interactively, START and END are the start/end of the
613 region if the mark is active, or of the buffer's accessible
614 portion if the mark is inactive.
616 This command deletes whitespace characters after the last
617 non-whitespace character in each line between START and END. It
618 does not consider formfeed characters to be whitespace.
620 If this command acts on the entire buffer (i.e. if called
621 interactively with the mark inactive, or called from Lisp with
622 END nil), it also deletes all trailing lines at the end of the
623 buffer if the variable `delete-trailing-lines' is non-nil."
634 ;; Don't delete formfeeds, even if they are considered whitespace.
643 ;; Delete trailing empty lines.
645 ;; Really the end of buffer.
650 ;; Return nil for the benefit of `write-file-functions'.
651 nil)
654 "Insert a newline, then indent according to major mode.
655 Indentation is done using the value of `indent-line-function'.
656 In programming language modes, this is the same as TAB.
657 In some text modes, where TAB inserts a tab, this command indents to the
658 column specified by the function `current-left-margin'."
665 "Reindent current line, insert newline, then indent the new line.
666 Indentation of both lines is done according to the current major mode,
667 which means calling the current value of `indent-line-function'.
668 In programming language modes, this is the same as TAB.
669 In some text modes, where TAB inserts a tab, this indents to the
670 column specified by the function `current-left-margin'."
673 ;; Be careful to insert the newline before indenting the line.
674 ;; Otherwise, the indentation might be wrong.
678 ;; We are at EOL before the call to indent-according-to-mode, and
679 ;; after it we usually are as well, but not always. We tried to
680 ;; address it with `save-excursion' but that uses a normal marker
681 ;; whereas we need `move after insertion', so we do the save/restore
682 ;; by hand.
686 ;; Remove the trailing white-space after indentation because
687 ;; indentation may introduce the whitespace.
693 Legitimate radix values are 8, 10 and 16."
698 "Like `read-char', but do not allow quitting.
699 Also, if the first character read is an octal digit,
700 we read any number of octal digits and return the
701 specified character code. Any nondigit terminates the sequence.
702 If the terminator is RET, it is discarded;
703 any other terminator is used itself as input.
705 The optional argument PROMPT specifies a string to use to prompt the user.
706 The variable `read-quoted-char-radix' controls which radix to use
707 for numeric input."
710 help-event-list)))
714 ;; Don't let C-h or other help chars get the help
715 ;; message--only help function keys. See bug#16617.
719 "Type the special character you want to use,
720 or the octal character code.
721 RET terminates the character code and is discarded;
725 ;; Translate TAB key into control-I ASCII character, and so on.
726 ;; Note: `read-char' does it using the `ascii-character' property.
727 ;; We tried using read-key instead, but that disables the keystroke
728 ;; echo produced by 'C-q', see bug#24635.
732 char)))
738 done t))
740 ;; Turn a meta-character into a character with the 0200 bit set.
742 done t))
757 done t))
759 done t)))
761 code))
764 "Read next input character and insert it.
765 This is useful for inserting control characters.
766 With argument, insert ARG copies of the character.
768 If the first character you type after this command is an octal digit,
769 you should type a sequence of octal digits which specify a character code.
770 Any nondigit terminates the sequence. If the terminator is a RET,
771 it is discarded; any other terminator is used itself as input.
772 The variable `read-quoted-char-radix' specifies the radix for this feature;
773 set it to 10 or 16 to use decimal or hex instead of octal.
775 In overwrite mode, this function inserts the character anyway, and
776 does not handle octal digits specially. This means that if you use
777 overwrite as your normal editing mode, you can use this function to
778 insert characters when necessary.
780 In binary overwrite mode, this function does overwrite, and octal
781 digits are interpreted as a character code. This is intended to be
782 useful for editing binary files."
785 ;; Avoid "obsolete" warnings for translation-table-for-input.
792 ;; This used to assume character codes 0240 - 0377 stand for
793 ;; characters in some single-byte character set, and converted them
794 ;; to Emacs characters. But in 23.1 this feature is deprecated
795 ;; in favor of inserting the corresponding Unicode characters.
796 ;; (if (and enable-multibyte-characters
797 ;; (>= char ?\240)
798 ;; (<= char ?\377))
799 ;; (setq char (unibyte-char-to-multibyte char)))
811 "Move forward ARG lines and position at first nonblank character."
817 "Move backward ARG lines and position at first nonblank character."
823 "Move point to the first non-whitespace character on this line."
827 ;; Move back over chars that have whitespace syntax but have the p flag.
831 "Fixup white space between objects around point.
832 Leave one space or none, according to the context."
839 nil
843 "Delete all spaces and tabs around point.
844 If BACKWARD-ONLY is non-nil, only delete them before point."
849 orig-pos
858 "Delete all spaces and tabs around point, leaving one space (or N spaces).
859 If N is negative, delete newlines as well, leaving -N spaces.
860 See also `cycle-spacing'."
865 "Store context used in consecutive calls to `cycle-spacing' command.
866 The first time `cycle-spacing' runs, it saves in this variable:
867 its N argument, the original point position, and the original spacing
871 "Manipulate whitespace around point in a smart way.
872 In interactive use, this function behaves differently in successive
873 consecutive calls.
875 The first call in a sequence acts like `just-one-space'.
876 It deletes all spaces and tabs around point, leaving one space
877 \(or N spaces). N is the prefix argument. If N is negative,
878 it deletes newlines as well, leaving -N spaces.
879 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
881 The second call in a sequence deletes all spaces.
883 The third call in a sequence restores the original whitespace (and point).
885 If MODE is `single-shot', it only performs the first step in the sequence.
886 If MODE is `fast' and the first step would not result in any change
887 \(i.e., there are exactly (abs N) spaces around point),
888 the function goes straight to the second step.
890 Repeatedly calling the function with different values of N starts a
891 new sequence each time."
899 ;; Command run for the first time, single-shot mode or different argument
911 ;; Special handling for case where there was no space at all.
914 ;; If this run causes no change in buffer content, delete all spaces,
915 ;; otherwise delete all excess spaces.
920 ;; Command run for the second time.
924 ;; Command run for the third time.
929 \f
931 "Move point to the beginning of the buffer.
932 With numeric arg N, put point N/10 of the way from the beginning.
933 If the buffer is narrowed, this command uses the beginning of the
934 accessible part of the buffer.
937 is supplied, or Transient Mark mode is enabled and the mark is active."
947 ;; Avoid overflow for large buffer sizes!
955 "Move point to the end of the buffer.
956 With numeric arg N, put point N/10 of the way from the end.
957 If the buffer is narrowed, this command uses the end of the
958 accessible part of the buffer.
961 is supplied, or Transient Mark mode is enabled and the mark is active."
969 ;; Avoid overflow for large buffer sizes!
974 ;; If we went to a place in the middle of the buffer,
975 ;; adjust it to the beginning of a line.
979 ;; If the end of the buffer is not already on the screen,
980 ;; then scroll specially to put it near, but not at, the bottom.
985 "Whether single-char deletion commands delete an active region.
986 This has an effect only if Transient Mark mode is enabled, and
987 affects `delete-forward-char' and `delete-backward-char', though
988 not `delete-char'.
990 If the value is the symbol `kill', the active region is killed
991 instead of deleted."
1008 "Function to get the region's content.
1009 Called with one argument DELETE.
1010 If DELETE is `delete-only', then only delete the region and the return value
1011 is undefined. If DELETE is nil, just return the content as a string.
1012 If DELETE is `bounds', then don't delete, but just return the
1013 boundaries of the region as a list of (START . END) positions.
1014 If anything else, delete the region and return its content as a string,
1025 first nil))))
1026 "Function to insert the region's content.
1027 Called with one argument LINES.
1031 "Delete the previous N characters (following if N is negative).
1032 If Transient Mark mode is enabled, the mark is active, and N is 1,
1033 delete the text in the region and deactivate the mark instead.
1034 To disable this, set option `delete-active-region' to nil.
1036 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1037 kill ring) instead of delete. Interactively, N is the prefix
1038 arg, and KILLFLAG is set if N is explicitly specified.
1040 When killing, the killed text is filtered by
1041 `filter-buffer-substring' before it is saved in the kill ring, so
1042 the actual saved text might be different from what was killed.
1044 In Overwrite mode, single character backward deletion may replace
1045 tabs with spaces so as to back over columns, unless point is at
1046 the end of the line."
1052 delete-active-region
1054 ;; If a region is active, kill or delete it.
1058 ;; In Overwrite mode, maybe untabify while deleting
1068 ;; Otherwise, do simple deletion.
1072 "Delete the following N characters (previous if N is negative).
1073 If Transient Mark mode is enabled, the mark is active, and N is 1,
1074 delete the text in the region and deactivate the mark instead.
1075 To disable this, set variable `delete-active-region' to nil.
1077 Optional second arg KILLFLAG non-nil means to kill (save in kill
1078 ring) instead of delete. Interactively, N is the prefix arg, and
1079 KILLFLAG is set if N was explicitly specified.
1081 When killing, the killed text is filtered by
1082 `filter-buffer-substring' before it is saved in the kill ring, so
1083 the actual saved text might be different from what was killed."
1089 delete-active-region
1091 ;; If a region is active, kill or delete it.
1096 ;; Otherwise, do simple deletion.
1100 "Put point at beginning and mark at end of buffer.
1101 If narrowing is in effect, only uses the accessible part of the buffer.
1102 You probably should not use this function in Lisp programs;
1103 it is usually a mistake for a Lisp function to use any subroutine
1104 that uses or sets the mark."
1109 ;; This is really `point-min' in most cases, but if we're in the
1110 ;; minibuffer, this is at the end of the prompt.
1112 \f
1114 ;; Counting lines, one way or another.
1117 "Go to LINE, counting from line 1 at beginning of buffer.
1118 If called interactively, a numeric prefix argument specifies
1119 LINE; without a numeric prefix argument, read LINE from the
1120 minibuffer.
1122 If optional argument BUFFER is non-nil, switch to that buffer and
1124 as argument, BUFFER is the most recently selected other buffer.
1126 Prior to moving point, this function sets the mark (without
1127 activating it), unless Transient Mark mode is enabled and the
1128 mark is already active.
1130 This function is usually the wrong thing to use in a Lisp program.
1131 What you probably want instead is something like:
1132 (goto-char (point-min))
1133 (forward-line (1- N))
1134 If at all possible, an even better solution is to use char counts
1135 rather than line counts."
1140 ;; Look for a default, a number in the buffer at point.
1150 ;; Decide if we're switching buffers.
1158 ;; Read the argument, offering that number (if any) as default.
1161 buffer))))
1162 ;; Switch to the desired buffer, one way or another.
1167 ;; Leave mark at previous position
1169 ;; Move to the specified line number in that buffer.
1178 "Count the number of words in the region.
1179 If called interactively, print a message reporting the number of
1180 lines, words, and characters in the region (whether or not the
1181 region is active); with prefix ARG, report for the entire buffer
1182 rather than the region.
1184 If called from Lisp, return the number of words between positions
1185 START and END."
1197 "Count words between START and END.
1198 If called interactively, START and END are normally the start and
1199 end of the buffer; but if the region is active, START and END are
1200 the start and end of the region. Print a message reporting the
1201 number of lines, words, and chars.
1203 If called from Lisp, return the number of words between START and
1204 END, without printing any message."
1214 words))
1230 str
1238 "Print the current buffer line number and narrowed line number of point."
1251 "Return number of lines between START and END.
1252 This is usually the number of newlines between them,
1253 but can be one more if START is not equal to END
1254 and the greater of them is not at the start of a line."
1270 done)))
1274 "Return (narrowed) buffer line number at position POS.
1275 If POS is nil, use current buffer location.
1276 Counting starts at (point-min), so the value refers
1277 to the contents of the accessible portion of the buffer."
1287 "Print info on cursor position (on screen and within buffer).
1288 Also describe the character after point, and give its character code
1289 in octal, decimal and hex.
1291 For a non-ASCII multibyte character, also give its encoding in the
1292 buffer's selected coding system if the coding system encodes the
1293 character safely. If the character is encoded into one byte, that
1294 code is shown in hex. If the character is encoded into more than one
1297 In addition, with prefix argument, show details about that character
1298 in *Help* buffer. See also the command `describe-char'."
1302 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1303 ;; start a directional embedding, which could completely
1304 ;; disrupt the rest of the line (e.g., RLO will display the
1305 ;; rest of the line right-to-left). So we put an invisible
1306 ;; PDF character after these characters, to end the
1307 ;; embedding, which eliminates any effects on the rest of
1308 ;; the line. For RLE and RLO we also append an invisible
1309 ;; LRM, to avoid reordering the following numerical
1310 ;; characters. For LRI/RLI/FSI we append a PDI.
1317 ;; Strong right-to-left characters cause reordering of
1318 ;; the following numerical characters which show the
1319 ;; codepoint, so append LRM to countermand that.
1330 ""
1336 pos total percent beg end col hscroll)
1338 pos total col hscroll))
1340 encoded encoding-msg display-prop under-display)
1347 ;; Check if the character is displayed with some `display'
1348 ;; text property. In that case, set under-display to the
1349 ;; buffer substring covered by that property.
1360 under-display)))
1366 char char char under-display)
1368 char char char under-display display-prop))
1371 char char char
1373 "..."
1377 ;; We show the detailed information about CHAR.
1384 bidi-fixer
1385 encoding-msg pos total percent beg end col hscroll)
1392 bidi-fixer encoding-msg pos total percent col hscroll))))))
1393 \f
1394 ;; Initialize read-expression-map. It is defined at C level.
1398 ;; Might as well bind TAB to completion, since inserting a TAB char is
1399 ;; much too rarely useful.
1402 m))
1405 "Return a Lisp object read using the minibuffer, unevaluated.
1406 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1407 is a string to insert in the minibuffer before reading.
1408 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1409 Such arguments are used as in `read-from-minibuffer'.)"
1410 ;; Used for interactive spec `x'.
1415 "Return value of Lisp expression read using the minibuffer.
1416 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1417 is a string to insert in the minibuffer before reading.
1418 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1419 Such arguments are used as in `read-from-minibuffer'.)"
1420 ;; Used for interactive spec `X'.
1428 "The current default value or list of default values in the minibuffer.
1429 The functions `read-from-minibuffer' and `completing-read' bind
1433 "Value for `print-level' while printing value in `eval-expression'.
1434 A value of nil means no limit."
1440 "Value for `print-length' while printing value in `eval-expression'.
1441 A value of nil means no limit."
1447 "If non-nil set `debug-on-error' to t in `eval-expression'.
1448 If nil, don't change the value of `debug-on-error'."
1454 "If VALUE in an integer, return a specially formatted string.
1456 If VALUE is not an integer, nil is returned.
1457 This function is used by functions like `prin1' that display the
1458 result of expression evaluation."
1477 ;; FIXME: call emacs-lisp-mode?
1484 read-expression-map t
1487 ;; We define this, rather than making `eval' interactive,
1488 ;; for the sake of completion of names like eval-region, eval-buffer.
1490 "Evaluate EXP and print value in the echo area.
1491 When called interactively, read an Emacs Lisp expression and evaluate it.
1492 Value is also consed on to front of the variable `values'.
1493 If the resulting value is an integer, it will be printed in
1494 several additional formats (octal, hexadecimal, and character).
1495 Optional argument INSERT-VALUE non-nil (interactively, with
1496 prefix argument) means insert the result into the current buffer
1497 instead of printing it in the echo area.
1499 Normally, this function truncates long output according to the value
1500 of the variables `eval-expression-print-length' and
1501 `eval-expression-print-level'. With a prefix argument of zero,
1502 however, there is no such truncation.
1504 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1505 minibuffer.
1507 If `eval-expression-debug-on-error' is non-nil, which is the default,
1508 this command arranges for all errors to enter the debugger."
1511 current-prefix-arg))
1516 ;; Bind debug-on-error to something unique so that we can
1517 ;; detect when evalled code changes it.
1521 ;; If evalled code has changed the value of debug-on-error,
1522 ;; propagate that change to the global binding.
1527 eval-expression-print-length))
1529 eval-expression-print-level))
1545 "Prompting with PROMPT, let user edit COMMAND and eval result.
1546 COMMAND is a Lisp expression. Let user edit that expression in
1547 the minibuffer, then read and evaluate the result."
1554 read-expression-map t
1556 ;; If command was added to command-history as a string,
1557 ;; get rid of that. We want only evaluable expressions there.
1561 ;; If command to be redone does not match front of history,
1562 ;; add it to the history.
1568 "Edit and re-evaluate last complex command, or ARGth from last.
1569 A complex command is one which used the minibuffer.
1570 The command is placed in the minibuffer as a Lisp form for editing.
1571 The result is executed, repeating the command as changed.
1572 If the command has been changed or is not the most recent previous
1573 command it is added to the front of the command history.
1574 You can use the minibuffer history commands \
1576 to get different commands to edit and resubmit."
1579 newcmd)
1591 ;; If command was added to command-history as a
1592 ;; string, get rid of that. We want only
1593 ;; evaluable expressions there.
1597 ;; If command to be redone does not match front of history,
1598 ;; add it to the history.
1613 "Read command name to invoke in `execute-extended-command'."
1623 ;; Get a command name at point in the original buffer
1624 ;; to propose it after M-n.
1628 ;; Read a string, completing from and restricting to the set of
1629 ;; all defined commands. Don't provide any initial input.
1630 ;; Save the command read on the extended-command history list.
1641 ;; This isn't strictly correct if `execute-extended-command'
1642 ;; is bound to anything else (e.g. [menu]).
1643 ;; It could use (key-description (this-single-command-keys)),
1644 ;; but actually a prompt other than "M-x" would be confusing,
1645 ;; because "M-x" is a well-known prompt to read a command
1646 ;; and it serves as a shorthand for "Extended command: ".
1651 ;; Exclude obsolete commands from completions.
1656 pred)))
1661 "Non-nil means show the equivalent key-binding when M-x command has one.
1662 The value can be a length of time to show the message for.
1663 If the value is non-nil and not a number, we wait 2 seconds."
1670 "If non-nil, show a shorter M-x invocation when there is one."
1691 binding)
1697 name len)))
1698 ;; Don't show the help message if the binding isn't
1699 ;; significantly shorter than the M-x command the user typed.
1707 binding))
1710 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1711 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1712 "Read a command name, then read the arguments and call the command.
1713 To pass a prefix argument to the command you are
1714 invoking, give a prefix argument to `execute-extended-command'."
1716 ;; FIXME: Remember the actual text typed by the user before completion,
1717 ;; so that we don't later on suggest the same shortening.
1722 execute-extended-command--last-typed)))
1723 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1735 ;; Some features, such as novice.el, rely on this-command-keys
1736 ;; including M-x COMMAND-NAME RET.
1739 ;; Normally `real-this-command' should never be changed, but here we really
1740 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1741 ;; binding" for <cmd>, so the command the user really wanted to run is
1742 ;; `function' and not `execute-extended-command'. The difference is
1743 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1747 ;; If enabled, show which key runs this command.
1748 ;; But first wait, and skip the message if there is input.
1750 ;; If this command displayed something in the echo area;
1751 ;; wait a few seconds, then display our suggestion message.
1752 ;; FIXME: Wait *after* running post-command-hook!
1753 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1754 ;; find a better answer anyway!
1764 ;; There's no binding for CMD. Let's try and find the shortest
1765 ;; string to use in M-x.
1766 ;; FIXME: Can be slow. Cache it maybe?
1773 function
1778 suggest-key-bindings
1782 ;; BEWARE: Called directly from the C code.
1783 "Execute CMD as an editor command.
1784 CMD must be a symbol that satisfies the `commandp' predicate.
1785 Optional second arg RECORD-FLAG non-nil
1786 means unconditionally put this command in the variable `command-history'.
1787 Otherwise, that is done only if an arg is read using the minibuffer.
1788 The argument KEYS specifies the value to use instead of (this-command-keys)
1789 when reading the arguments; if it is nil, (this-command-keys) is used.
1790 The argument SPECIAL, if non-nil, means that this command is executing
1791 a special event, so ignore the prefix argument and don't clear it."
1794 ;; FIXME: This should probably be done around
1795 ;; pre-command-hook rather than here!
1803 disabled-command-function)
1804 ;; FIXME: Weird calling convention!
1814 ;; If requested, place the macro in the command history. For
1815 ;; other sorts of commands, call-interactively takes care of this.
1818 ;; Don't keep command history around forever.
1824 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1832 \f
1834 "Default minibuffer history list.
1835 This is used for all minibuffer input
1836 except when an alternate history list is specified.
1838 Maximum length of the history list is determined by the value
1841 "Control whether history list elements are expressions or strings.
1842 If the value of this variable equals current minibuffer depth,
1843 they are expressions; otherwise they are strings.
1844 \(That convention is designed to do the right thing for
1851 "Text that was in this minibuffer before any history commands.
1852 This is nil if there have not yet been any history commands
1861 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1866 "Minibuffer history variables for which matching should ignore case.
1867 If a history variable is a member of this list, then the
1869 commands ignore case when searching it, regardless of `case-fold-search'."
1874 "Find the previous history element that matches REGEXP.
1875 \(Previous history elements refer to earlier actions.)
1876 With prefix argument N, search for Nth previous match.
1877 If N is negative, find the next or Nth next match.
1878 Normally, history elements are matched case-insensitively if
1879 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1880 makes the search case-sensitive.
1881 See also `minibuffer-history-case-insensitive-variables'."
1885 nil
1886 minibuffer-local-map
1887 nil
1888 'minibuffer-history-search-history
1890 ;; Use the last regexp specified, by default, if input is empty.
1895 regexp)
1905 ;; On some systems, ignore case for file names.
1907 minibuffer-history-case-insensitive-variables)
1908 t
1909 ;; Respect the user's setting for case-fold-search:
1910 case-fold-search)
1911 nil))
1912 prevpos
1913 match-string
1914 match-offset
1921 "No later matching history item"
1942 next-matching-history-element))
1946 "Find the next history element that matches REGEXP.
1947 \(The next history element refers to a more recent action.)
1948 With prefix argument N, search for Nth next match.
1949 If N is negative, find the previous or Nth previous match.
1950 Normally, history elements are matched case-insensitively if
1951 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1952 makes the search case-sensitive."
1956 nil
1957 minibuffer-local-map
1958 nil
1959 'minibuffer-history-search-history
1961 ;; Use the last regexp specified, by default, if input is empty.
1966 regexp)
1973 "Function run by `goto-history-element' before consuming default values.
1974 This is useful to dynamically add more elements to the list of default values
1975 when `goto-history-element' reaches the end of this list.
1976 Before calling this function `goto-history-element' sets the variable
1977 `minibuffer-default-add-done' to t, so it will call this function only
1978 once. In special cases, when this function needs to be called more
1979 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1983 "When nil, add more elements to the end of the list of default values.
1984 The value nil causes `goto-history-element' to add more elements to
1985 the list of defaults when it reaches the end of this list. It does
1991 "Return a list of all completions without the default value.
1992 This function is used to add all elements of the completion table to
1993 the end of the list of defaults just after the default value."
1996 minibuffer-completion-table
1997 minibuffer-completion-predicate)))
2003 "Puts element of the minibuffer history in the minibuffer.
2004 The argument NABS specifies the absolute history position."
2018 elt minibuffer-returned-to-present)
2025 "End of defaults; no next item"
2032 previous-history-element))
2044 minibuffer-default)))
2056 elt))
2060 "Puts next element of the minibuffer history in the minibuffer.
2061 With argument N, it uses the Nth following element."
2067 "Puts previous element of the minibuffer history in the minibuffer.
2068 With argument N, it uses the Nth previous element."
2074 "Move cursor vertically down ARG lines, or to the next history element.
2075 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2076 next element of the minibuffer history in the minibuffer."
2080 ;; Remember the original goal column of possibly multi-line input
2081 ;; excluding the length of the prompt on the first line.
2091 ;; Restore old position since `line-move-visual' moves point to
2092 ;; the end of the line when it fails to go to the next line.
2095 ;; Reset `temporary-goal-column' because a correct value is not
2096 ;; calculated when `next-line' above fails by bumping against
2097 ;; the bottom of the minibuffer (bug#22544).
2099 ;; Restore the original goal column on the last line
2100 ;; of possibly multi-line input.
2108 "Move cursor vertically up ARG lines, or to the previous history element.
2109 When point moves over the top line of multi-line minibuffer, puts ARGth
2110 previous element of the minibuffer history in the minibuffer."
2114 ;; Remember the original goal column of possibly multi-line input
2115 ;; excluding the length of the prompt on the first line.
2125 ;; Restore old position since `line-move-visual' moves point to
2126 ;; the beginning of the line when it fails to go to the previous line.
2129 ;; Reset `temporary-goal-column' because a correct value is not
2130 ;; calculated when `previous-line' above fails by bumping against
2131 ;; the top of the minibuffer (bug#22544).
2133 ;; Restore the original goal column on the first line
2134 ;; of possibly multi-line input.
2140 ;; Put the cursor at the end of the visual line instead of the
2141 ;; logical line, so the next `previous-line-or-history-element'
2142 ;; would move to the previous history element, not to a possible upper
2143 ;; visual line from the end of logical line in `line-move-visual' mode.
2145 ;; Since `end-of-visual-line' puts the cursor at the beginning
2146 ;; of the next visual line, move it one char back to the end
2147 ;; of the first visual line (bug#22544).
2151 "Get next history element which completes the minibuffer before the point.
2152 The contents of the minibuffer after the point are deleted, and replaced
2153 by the new completion."
2159 n)
2160 ;; next-matching-history-element always puts us at (point-min).
2161 ;; Move to the position we were at before changing the buffer contents.
2162 ;; This is still sensible, because the text before point has not changed.
2166 "\
2167 Get previous history element which completes the minibuffer before the point.
2168 The contents of the minibuffer after the point are deleted, and replaced
2169 by the new completion."
2173 ;; For compatibility with the old subr of the same name.
2175 "Return the display width of the minibuffer prompt.
2176 Return 0 if current buffer is not a minibuffer."
2177 ;; Return the width of everything before the field at the end of
2178 ;; the buffer; this should be 0 for normal buffers.
2180 \f
2181 ;; isearch minibuffer history
2188 "Set up a minibuffer for using isearch to search the minibuffer history.
2189 Intended to be added to `minibuffer-setup-hook'."
2201 "Clean up the minibuffer after terminating isearch in the minibuffer."
2206 "Return the proper search function, for isearch in minibuffer history."
2209 ;; Use standard functions to search within minibuffer text
2211 found)
2212 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2213 ;; searching forward. Lazy-highlight calls this lambda with the
2214 ;; bound arg, so skip the minibuffer prompt.
2218 ;; 1. First try searching in the initial minibuffer text
2221 noerror)
2222 ;; 2. If the above search fails, start putting next/prev history
2223 ;; elements in the minibuffer successively, and search the string
2224 ;; in them. Do this only when bound is nil (i.e. not while
2225 ;; lazy-highlighting search strings in the current minibuffer text).
2237 ;; After putting the next/prev history element, search
2238 ;; the string in them again, until next-history-element
2239 ;; or previous-history-element raises an error at the
2240 ;; beginning/end of history.
2243 ;; For backward search, don't search
2244 ;; in the minibuffer prompt
2246 noerror)))
2247 ;; Return point of the new search result
2249 ;; Return nil when next(prev)-history-element fails
2253 "Display the minibuffer history search prompt.
2254 If there are no search errors, this function displays an overlay with
2255 the isearch prompt which replaces the original minibuffer prompt.
2256 Otherwise, it displays the standard isearch message returned from
2257 the function `isearch-message'."
2259 ;; Use standard function `isearch-message' when not in the minibuffer,
2260 ;; or search fails, or has an error (like incomplete regexp).
2261 ;; This function overwrites minibuffer text with isearch message,
2262 ;; so it's possible to see what is wrong in the search string.
2264 ;; Otherwise, put the overlay with the standard isearch prompt over
2265 ;; the initial minibuffer prompt.
2274 ;; And clear any previous isearch message.
2278 "Wrap the minibuffer history search when search fails.
2279 Move point to the first history element for a forward search,
2280 or to the last history element for a backward search."
2281 ;; When `minibuffer-history-isearch-search' fails on reaching the
2282 ;; beginning/end of the history, wrap the search to the first/last
2283 ;; minibuffer history element.
2291 "Save a function restoring the state of minibuffer history search.
2292 Save `minibuffer-history-position' to the additional state parameter
2293 in the search status stack."
2299 "Restore the minibuffer history search state.
2300 Go to the history element by the absolute history position HIST-POS."
2303 \f
2304 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2308 "Table mapping redo records to the corresponding undo one.
2309 A redo record for undo-in-region maps to t.
2319 "Within a run of consecutive undo commands, list remaining to be undone.
2323 "Undo some previous changes.
2324 Repeat this command to undo more changes.
2325 A numeric ARG serves as a repeat count.
2327 In Transient Mark mode when the mark is active, only undo changes within
2329 as an argument limits undo to changes within the current region."
2331 ;; Make last-command indicate for the next command that this was an undo.
2332 ;; That way, another undo will undo more.
2333 ;; If we get to the end of the undo history and get an error,
2334 ;; another undo command will find the undo history empty
2335 ;; and will get another error. To begin undoing the undos,
2336 ;; you must type some other command.
2338 ;; For an indirect buffer, look in the base buffer for the
2339 ;; auto-save data.
2343 message)
2344 ;; If we get an error in undo-start,
2345 ;; the next command should not be a "consecutive undo".
2346 ;; So set `this-command' to something other than `undo'.
2351 ;; If something (a timer or filter?) changed the buffer
2352 ;; since the previous command, don't continue the undo seq.
2356 ;; If the last undo record made was made by undo
2357 ;; it shows nothing else happened in between.
2364 ;; get rid of initial undo boundary
2366 ;; If we got this far, the next command should be a consecutive undo.
2368 ;; Check to see whether we're hitting a redo record, and if
2369 ;; so, ask the user whether she wants to skip the redo/undo pair.
2377 ;; The equiv entry might point to another redo record if we have done
2378 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2386 ;; Record the fact that the just-generated undo records come from an
2387 ;; undo operation--that is, they are redo records.
2388 ;; In the ordinary case (not within a region), map the redo
2389 ;; record to the following undos.
2390 ;; I don't know how to do that in the undo-in-region case.
2392 ;; Strip any leading undo boundaries there might be, like we do
2393 ;; above when checking.
2397 ;; Prevent identity mapping. This can happen if
2398 ;; consecutive nils are erroneously in undo list.
2400 t
2401 pending-undo-list)
2402 undo-equiv-table))
2403 ;; Don't specify a position in the undo record for the undo command.
2404 ;; Instead, undoing this should move point to where the change is.
2423 ;; Record what the current undo list says,
2424 ;; so the next command can tell if the buffer was modified in between.
2428 ;; Display a message announcing success.
2433 "Make BUFFER stop keeping undo information.
2434 No argument or nil as argument means do this for the current buffer."
2440 "Undo some previous changes.
2441 Repeat this command to undo more changes.
2442 A numeric ARG serves as a repeat count.
2443 Contrary to `undo', this will not redo a previous undo."
2448 "Non-nil while performing an undo.
2452 "Undo back N undo-boundaries beyond what was already undone recently.
2453 Call `undo-start' to get ready to undo recent changes,
2454 then call `undo-more' one or more times to undo them."
2459 ;; Note: The following, while pulling elements off
2460 ;; `pending-undo-list' will call primitive change functions which
2461 ;; will push more elements onto `buffer-undo-list'.
2467 "Undo N records from the front of the list LIST.
2468 Return what remains of the list."
2470 ;; This is a good feature, but would make undo-start
2471 ;; unable to do what is expected.
2472 ;;(when (null (car (list)))
2473 ;; ;; If the head of the list is a boundary, it is the boundary
2474 ;; ;; preceding this command. Get rid of it and don't count it.
2475 ;; (setq list (cdr list))))
2478 ;; In a writable buffer, enable undoing read-only text that is
2479 ;; so because of text properties.
2481 ;; Don't let `intangible' properties interfere with undo.
2483 ;; We use oldlist only to check for EQ. ++kfs
2489 ;; Handle an integer by setting point to that value.
2492 ;; Element (t . TIME) records previous modtime.
2493 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2494 ;; UNKNOWN_MODTIME_NSECS.
2496 ;; If this records an obsolete save
2497 ;; (not matching the actual disk file)
2498 ;; then don't mark unmodified.
2506 ;; Element (nil PROP VAL BEG . END) is property change.
2511 ;; Element (BEG . END) means range was inserted.
2513 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2514 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2517 ;; Set point first thing, so that undoing this undo
2518 ;; does not send point back to where it is now.
2521 ;; Element (apply FUN . ARGS) means call FUN to undo.
2525 ;; Long format: (apply DELTA START END FUN . ARGS).
2532 ;; Check that the function did what the entry
2533 ;; said it would do.
2543 ;; Element (STRING . POS) means STRING was deleted.
2549 ;; Check that marker adjustments which were recorded
2550 ;; with the (STRING . POS) record are still valid, ie
2551 ;; the markers haven't moved. We check their validity
2552 ;; before reinserting the string so as we don't need to
2553 ;; mind marker insertion-type.
2561 ;; Insert string and adjust point
2569 ;; Adjust the valid marker adjustments
2573 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2576 next)
2577 ;; Even though these elements are not expected in the undo
2578 ;; list, adjust them to be conservative for the 24.4
2579 ;; release. (Bug#16818)
2586 ;; Make sure an apply entry produces at least one undo entry,
2587 ;; so the test in `undo' for continuing an undo series
2588 ;; will work right.
2593 list)
2595 ;; Deep copy of a list
2597 "Make a copy of undo list LIST."
2603 elt))
2606 "Set `pending-undo-list' to the front of the undo list.
2607 The next call to `undo-more' will undo the most recently made change.
2608 If BEG and END are specified, then only undo elements
2609 that apply to text between BEG and END are used; other undo elements
2610 are ignored. If BEG and END are nil, all undo elements are used."
2616 buffer-undo-list)))
2618 ;; The positions given in elements of the undo list are the positions
2619 ;; as of the time that element was recorded to undo history. In
2620 ;; general, subsequent buffer edits render those positions invalid in
2621 ;; the current buffer, unless adjusted according to the intervening
2622 ;; undo elements.
2623 ;;
2624 ;; Undo in region is a use case that requires adjustments to undo
2625 ;; elements. It must adjust positions of elements in the region based
2626 ;; on newer elements not in the region so as they may be correctly
2627 ;; applied in the current buffer. undo-make-selective-list
2628 ;; accomplishes this with its undo-deltas list of adjustments. An
2629 ;; example undo history from oldest to newest:
2630 ;;
2631 ;; buf pos:
2632 ;; 123456789 buffer-undo-list undo-deltas
2633 ;; --------- ---------------- -----------
2634 ;; aaa (1 . 4) (1 . -3)
2635 ;; aaba (3 . 4) N/A (in region)
2636 ;; ccaaba (1 . 3) (1 . -2)
2637 ;; ccaabaddd (7 . 10) (7 . -3)
2638 ;; ccaabdd ("ad" . 6) (6 . 2)
2639 ;; ccaabaddd (6 . 8) (6 . -2)
2640 ;; | |<-- region: "caab", from 2 to 6
2641 ;;
2642 ;; When the user starts a run of undos in region,
2643 ;; undo-make-selective-list is called to create the full list of in
2644 ;; region elements. Each element is adjusted forward chronologically
2645 ;; through undo-deltas to determine if it is in the region.
2646 ;;
2647 ;; In the above example, the insertion of "b" is (3 . 4) in the
2648 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2649 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2650 ;; . 6) is assessed as in the region and placed in the selective list.
2651 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2652 ;; due to the selected element. The "b" insertion is the only element
2653 ;; fully in the region, so in this example undo-make-selective-list
2654 ;; returns (nil (5 . 6)).
2655 ;;
2656 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2657 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2658 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2659 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2660 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2661 ;;
2662 ;; More interesting is how to adjust the "ddd" insertion due to the
2663 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2664 ;; If the reinsertion was a manual retyping of "ad", then the total
2665 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2666 ;; the reinsertion was due to undo, one might expect the first "d"
2667 ;; character would again be a part of the "ddd" text, meaning its
2668 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2669 ;;
2670 ;; undo-make-selective-list assumes in this situation that "ad" was a
2671 ;; new edit, even if it was inserted because of an undo.
2672 ;; Consequently, if the user undos in region "8 to 10" of the
2673 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2674 ;; "ccaabad", as though the first "d" became detached from the
2675 ;; original "ddd" insertion. This quirk is a FIXME.
2678 "Return a list of undo elements for the region START to END.
2679 The elements come from `buffer-undo-list', but we keep only the
2680 elements inside this region, and discard those outside this
2681 region. The elements' positions are adjusted so as the returned
2682 list can be applied to the current buffer."
2684 ;; A list of position adjusted undo elements in the region.
2686 ;; A list of undo-deltas for out of region undo elements.
2687 undo-deltas
2688 undo-elt)
2696 ;; Don't put two nils together in the list
2700 ;; This is a "was unmodified" element. Keep it
2701 ;; if we have kept everything thus far.
2704 ;; Skip over marker adjustments, instead relying
2705 ;; on finding them after (TEXT . POS) elements
2707 nil)
2710 undo-deltas)))
2715 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2716 ;; kept. primitive-undo may discard them later.
2729 "Determine whether UNDO-ELT falls inside the region START ... END.
2730 If it crosses the edge, we return nil.
2732 Generally this function is not useful for determining
2733 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2734 because markers can be arbitrarily relocated. Instead, pass the
2735 marker adjustment's corresponding (TEXT . POS) element."
2740 t)
2742 nil)
2744 ;; (TEXT . POSITION)
2748 ;; (MARKER . ADJUSTMENT)
2751 ;; (nil PROPERTY VALUE BEG . END)
2756 ;; (BEGIN . END)
2761 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2762 This assumes we have already decided that UNDO-ELT
2763 is not *inside* the region START...END."
2767 ;; (nil PROPERTY VALUE BEG . END)
2772 ;; (BEGIN . END)
2777 "Return adjustment of undo element ELT by the undo DELTAS
2778 list."
2780 ;; POSITION
2783 ;; (BEG . END)
2786 ;; (TEXT . POSITION)
2790 ;; (nil PROPERTY VALUE BEG . END)
2793 ;; (apply DELTA START END FUN . ARGS)
2794 ;; FIXME
2795 ;; All others return same elt
2798 ;; (BEG . END) can adjust to the same positions, commonly when an
2799 ;; insertion was undone and they are out of region, for example:
2800 ;;
2801 ;; buf pos:
2802 ;; 123456789 buffer-undo-list undo-deltas
2803 ;; --------- ---------------- -----------
2804 ;; [...]
2805 ;; abbaa (2 . 4) (2 . -2)
2806 ;; aaa ("bb" . 2) (2 . 2)
2807 ;; [...]
2808 ;;
2809 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2810 ;; undo. Further adjustments to such an element should be the same as
2811 ;; for (TEXT . POSITION) elements. The options are:
2812 ;;
2813 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2814 ;; analogous to marker insertion-type t.
2815 ;;
2816 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2817 ;; marker insertion-type nil.
2818 ;;
2819 ;; There was no strong reason to prefer one or the other, except that
2820 ;; the first is more consistent with prior undo in region behavior.
2822 "Return cons of adjustments to BEG and END by the undo DELTAS
2823 list."
2825 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2830 "Return adjustment of POS by the undo DELTAS list, comparing
2831 with < or <= based on USE-<."
2837 ;; Don't allow pos to become less than the undo-delta
2838 ;; position. This edge case is described in the overview
2839 ;; comments.
2842 ;; Return the first affected buffer position and the delta for an undo element
2843 ;; delta is defined as the change in subsequent buffer positions if we *did*
2844 ;; the undo.
2848 ;; (TEXT . POSITION)
2851 ;; (BEGIN . END)
2857 ;;; Default undo-boundary addition
2858 ;;
2859 ;; This section adds a new undo-boundary at either after a command is
2860 ;; called or in some cases on a timer called after a change is made in
2861 ;; any buffer.
2863 "Describe the cause of the last undo-boundary.
2865 If `explicit', the last boundary was caused by an explicit call to
2866 `undo-boundary', that is one not called by the code in this
2867 section.
2869 If it is equal to `timer', then the last boundary was inserted
2870 by `undo-auto--boundary-timer'.
2872 If it is equal to `command', then the last boundary was inserted
2873 automatically after a command, that is by the code defined in
2874 this section.
2876 If it is equal to a list, then the last boundary was inserted by
2877 an amalgamating command. The car of the list is the number of
2878 times an amalgamating command has been called, and the cdr are the
2882 "Current timer which will run `undo-auto--boundary-timer' or nil.
2887 "Non-nil if `this-command' should be amalgamated.
2888 This variable is set to nil by `undo-auto--boundaries' and is set
2892 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2896 "Return the number of amalgamating last commands or nil.
2897 Amalgamating commands are, by default, either
2898 `self-insert-command' and `delete-char', but can be any command
2899 that calls `undo-auto-amalgamate'."
2903 "Add an `undo-boundary' to the current buffer if needed.
2904 REASON describes the reason that the boundary is being added; see
2905 `undo-auto--last-boundary' for more information."
2915 undo-auto--undoably-changed-buffers)
2916 cause)))))
2919 "Check recently changed buffers and add a boundary if necessary.
2920 REASON describes the reason that the boundary is being added; see
2921 `undo-last-boundary' for more information."
2922 ;; (Bug #23785) All commands should ensure that there is an undo
2923 ;; boundary whether they have changed the current buffer or not.
2933 "Timer which will run `undo--auto-boundary-timer'."
2938 "Ensure that the `undo-auto-boundary-timer' is set."
2944 "List of buffers that have changed recently.
2946 This list is maintained by `undo-auto--undoable-change' and
2947 `undo-auto--boundaries' and can be affected by changes to their
2951 "Add an `undo-boundary' in appropriate buffers."
2956 'amalgamate
2960 "Amalgamate undo if necessary.
2961 This function can be called before an amalgamating command. It
2962 removes the previous `undo-boundary' if a series of such calls
2963 have been made. By default `self-insert-command' and
2964 `delete-char' are the only amalgamating commands, although this
2965 function could be called by any command wishing to have this
2966 behavior."
2971 last-amalgamating-count
2976 ;; Amalgamate all buffers that have changed.
2980 b
2982 ;; The head of `buffer-undo-list' is nil.
2983 ;; `car-safe' doesn't work because
2984 ;; `buffer-undo-list' need not be a list!
2992 "Called after every undoable buffer change."
2995 ;; End auto-boundary section
2998 "Amalgamate changes in change-group since HANDLE.
2999 Remove all undo boundaries between the state of HANDLE and now.
3000 HANDLE is as returned by `prepare-change-group'."
3009 ;; Temporarily truncate the undo log at ELT.
3014 ;; `elt' is still in the log: normal case.
3016 ;; `elt' is not in the log any more, but that's because
3017 ;; the log is "all new", so we should remove all
3018 ;; boundaries from it.
3022 buffer-undo-list
3023 ;; Preserve the undo-boundaries at either ends of the
3024 ;; change-groups.
3026 ;; Reset the modified cons cell ELT to its original content.
3033 "If non-nil ask about discarding undo info for the current command.
3034 Normally, Emacs discards the undo info for the current command if
3035 it exceeds `undo-outer-limit'. But if you set this option
3036 non-nil, it asks in the echo area whether to discard the info.
3037 If you answer no, there is a slight risk that Emacs might crash, so
3038 only do it if you really want to undo the command.
3040 This option is mainly intended for debugging. You have to be
3041 careful if you use it for other purposes. Garbage collection is
3042 inhibited while the question is asked, meaning that Emacs might
3043 leak memory. So you should make sure that you do not wait
3044 excessively long before answering the question."
3050 "If non-nil, an extra level of size that's ok in an undo item.
3051 We don't ask the user about truncating the undo list until the
3052 current item gets bigger than this amount.
3057 ;; When the first undo batch in an undo list is longer than
3058 ;; undo-outer-limit, this function gets called to warn the user that
3059 ;; the undo info for the current command was discarded. Garbage
3060 ;; collection is inhibited around the call, so it had better not do a
3061 ;; lot of consing.
3067 ;; Don't ask the question again unless it gets even bigger.
3068 ;; This applies, in particular, if the user quits from the question.
3069 ;; Such a quit quits out of GC, but something else will call GC
3070 ;; again momentarily. It will call this function again,
3071 ;; but we don't want to ask the question again.
3075 "Buffer `%s' undo info is %d bytes long; discard it? "
3079 t)
3080 nil))
3086 "The undo info was discarded because it exceeded \
3087 `undo-outer-limit'.
3089 This is normal if you executed a command that made a huge change
3090 to the buffer. In that case, to prevent similar problems in the
3091 future, set `undo-outer-limit' to a value that is large enough to
3092 cover the maximum size of normal changes you expect a single
3093 command to make, but not so large that it might exceed the
3094 maximum memory allotted to Emacs.
3096 If you did not execute any such command, the situation is
3097 probably due to a bug and you should report it.
3099 You can disable the popping up of this buffer by adding the entry
3100 \(undo discard-info) to the user option `warning-suppress-types',
3104 t))
3105 \f
3108 ; These are sorted according to the GNU en_US locale.
3151 )
3153 This is used by Shell mode and other parts of Emacs to recognize
3154 password prompts, including prompts in languages other than
3155 English. Different case choices should not be assumed to be
3156 included; callers should bind `case-fold-search' to t."
3162 "History list for some commands that read shell commands.
3164 Maximum length of the history list is determined by the value
3171 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3172 This buffer is used when `shell-command' or `shell-command-on-region'
3173 is run interactively. A value of nil means that output to stderr and
3180 "Return a list of all commands associated with the current file.
3181 This function is used to add all related commands retrieved by `mailcap'
3182 to the end of the list of defaults just after the default value."
3186 minibuffer-default))
3191 commands))
3202 map)
3206 "Read a shell command from the minibuffer.
3207 The arguments are the same as the ones of `read-from-minibuffer',
3208 except READ and KEYMAP are missing and HIST defaults
3209 to `shell-command-history'."
3217 minibuffer-local-shell-command-map
3218 nil
3220 args)))
3223 "What to do when the output buffer is used by another shell command.
3224 This option specifies how to resolve the conflict where a new command
3225 wants to direct its output to the buffer `*Async Shell Command*',
3226 but this buffer is already taken by another running shell command.
3228 The value `confirm-kill-process' is used to ask for confirmation before
3229 killing the already running process and running a new process
3230 in the same buffer, `confirm-new-buffer' for confirmation before running
3231 the command in a new buffer with a name other than the default buffer name,
3232 `new-buffer' for doing the same without confirmation,
3233 `confirm-rename-buffer' for confirmation before renaming the existing
3234 output buffer and running a new command in the default buffer,
3235 `rename-buffer' for doing the same without confirmation."
3237 confirm-kill-process)
3239 confirm-new-buffer)
3241 new-buffer)
3243 confirm-rename-buffer)
3245 rename-buffer))
3250 "Store a buffer position or erase the buffer.
3251 See `shell-command-dont-erase-buffer'."
3253 pos)
3255 ;; Setting buffer-read-only to nil doesn't suffice
3256 ;; if some text has a non-nil read-only property,
3257 ;; which comint sometimes adds for prompts.
3267 shell-command-saved-pos))))
3270 "Set point in BUFFER after command complete.
3271 BUFFER is the output buffer of the command; if nil, then defaults
3272 to the current BUFFER.
3273 Set point to the `cdr' of the element in `shell-command-saved-pos'
3274 whose `car' is BUFFER."
3286 ;; Set point in the window displaying buf, if any; otherwise
3287 ;; display buf temporary in selected frame and set the point.
3292 buf
3297 "Execute string COMMAND asynchronously in background.
3299 Like `shell-command', but adds `&' at the end of COMMAND
3300 to execute it asynchronously.
3302 The output appears in the buffer `*Async Shell Command*'.
3303 That buffer is in shell mode.
3305 You can configure `async-shell-command-buffer' to specify what to do in
3306 case when `*Async Shell Command*' buffer is already taken by another
3307 running shell command. To run COMMAND without displaying the output
3308 in a window you can configure `display-buffer-alist' to use the action
3309 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3311 In Elisp, you will often be better served by calling `start-process'
3312 directly, since it offers more control and does not impose the use of a
3313 shell (with its need to quote arguments)."
3323 current-prefix-arg
3324 shell-command-default-error-buffer))
3330 "Execute string COMMAND in inferior shell; display output, if any.
3331 With prefix argument, insert the COMMAND's output at point.
3333 Interactively, prompt for COMMAND in the minibuffer.
3335 If COMMAND ends in `&', execute it asynchronously.
3336 The output appears in the buffer `*Async Shell Command*'.
3337 That buffer is in shell mode. You can also use
3338 `async-shell-command' that automatically adds `&'.
3340 Otherwise, COMMAND is executed synchronously. The output appears in
3341 the buffer `*Shell Command Output*'. If the output is short enough to
3342 display in the echo area (which is determined by the variables
3343 `resize-mini-windows' and `max-mini-window-height'), it is shown
3344 there, but it is nonetheless available in buffer `*Shell Command
3345 Output*' even though that buffer is not automatically displayed.
3347 To specify a coding system for converting non-ASCII characters
3349 before this command.
3351 Noninteractive callers can specify coding systems by binding
3352 `coding-system-for-read' and `coding-system-for-write'.
3354 The optional second argument OUTPUT-BUFFER, if non-nil,
3355 says to put the output in some other buffer.
3356 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3357 and insert the output there; a non-nil value of
3358 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3359 If OUTPUT-BUFFER is not a buffer and not nil, insert the output
3360 in current buffer after point leaving mark after it.
3361 This cannot be done asynchronously.
3363 If the command terminates without error, but generates output,
3365 the output can be displayed in the echo area or in its buffer.
3366 If the output is short enough to display in the echo area
3367 \(determined by the variable `max-mini-window-height' if
3368 `resize-mini-windows' is non-nil), it is shown there.
3369 Otherwise,the buffer containing the output is displayed.
3373 of the output.
3375 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3376 or buffer name to which to direct the command's standard error output.
3377 If it is nil, error output is mingled with regular output.
3378 In an interactive call, the variable `shell-command-default-error-buffer'
3379 specifies the value of ERROR-BUFFER.
3381 In Elisp, you will often be better served by calling `call-process' or
3382 `start-process' directly, since it offers more control and does not impose
3383 the use of a shell (with its need to quote arguments)."
3394 current-prefix-arg
3395 shell-command-default-error-buffer))
3396 ;; Look for a handler in case default-directory is a remote file name.
3404 ;; Output goes in current buffer.
3410 temporary-file-directory)))
3411 nil)))
3414 ;; We do not use -f for csh; we will not support broken use of
3415 ;; .cshrcs. Even the BSD csh manual says to use
3416 ;; "if ($?prompt) exit" before things which are not useful
3417 ;; non-interactively. Besides, if someone wants their other
3418 ;; aliases for shell commands then they can still have them.
3422 t)
3423 nil shell-command-switch command)
3430 ;; Do no formatting while reading error file,
3431 ;; because that can run a shell command, and we
3432 ;; don't want that to cause an infinite recursion.
3434 ;; Put point after the inserted errors.
3438 ;; This is like exchange-point-and-mark, but doesn't
3439 ;; activate the mark. It is cleaner to avoid activation,
3440 ;; even though the command loop would deactivate the mark
3441 ;; because we inserted text.
3445 ;; Output goes in a separate buffer.
3446 ;; Preserve the match data in case called from a program.
3447 ;; FIXME: It'd be ridiculous for an Elisp function to call
3448 ;; shell-command and assume that it won't mess the match-data!
3451 ;; Command ending with ampersand means asynchronous.
3455 proc)
3456 ;; Remove the ampersand.
3458 ;; Ask the user what to do with already running process.
3463 ;; If will kill a process, query first.
3468 ;; If will create a new buffer, query first.
3475 ;; It will create a new buffer.
3480 ;; If will rename the buffer, query first.
3489 ;; It will rename the buffer.
3499 shell-command-switch command))
3503 ;; Use the comint filter for proper handling of carriage motion
3504 ;; (see `comint-inhibit-carriage-motion'),.
3506 ))
3507 ;; Otherwise, command is executed synchronously.
3509 output-buffer nil error-buffer)))))))
3512 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3513 MESSAGE may be either a string or a buffer.
3515 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3516 for maximum height of the echo area, as defined by `max-mini-window-height'
3517 if `resize-mini-windows' is non-nil.
3519 Returns either the string shown in the echo area, or when a pop-up
3520 buffer is used, the window used to display it.
3522 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3523 name of the buffer used to display it in the case where a pop-up buffer
3524 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3525 string and it is displayed in the echo area, it is not specified whether
3526 the contents are inserted into the buffer anyway.
3528 Optional arguments ACTION and FRAME are as for `display-buffer',
3529 and are only used if a pop-up buffer is displayed."
3531 ;; Trivial case where we can use the echo area
3535 ;; Trivial case where we can just remove single trailing newline
3538 ;; General case
3541 message
3550 0
3554 (<= lines
3558 max-mini-window-height))
3560 max-mini-window-height)
3564 ;; Don't use the echo area if the output buffer is
3565 ;; already displayed in the selected frame.
3567 ;; Echo area
3573 ;; Buffer
3578 ;; We have a sentinel to prevent insertion of a termination message
3579 ;; in the buffer itself, and to set the point in the buffer when
3580 ;; `shell-command-dont-erase-buffer' is non-nil.
3589 &optional output-buffer replace
3590 error-buffer display-error-buffer
3591 region-noncontiguous-p)
3592 "Execute string COMMAND in inferior shell with region as input.
3593 Normally display output (if any) in temp buffer `*Shell Command Output*';
3594 Prefix arg means replace the region with it. Return the exit code of
3595 COMMAND.
3597 To specify a coding system for converting non-ASCII characters
3599 before this command. By default, the input (from the current buffer)
3600 is encoded using coding-system specified by `process-coding-system-alist',
3601 falling back to `default-process-coding-system' if no match for COMMAND
3602 is found in `process-coding-system-alist'.
3604 Noninteractive callers can specify coding systems by binding
3605 `coding-system-for-read' and `coding-system-for-write'.
3607 If the command generates output, the output may be displayed
3608 in the echo area or in a buffer.
3609 If the output is short enough to display in the echo area
3610 \(determined by the variable `max-mini-window-height' if
3611 `resize-mini-windows' is non-nil), it is shown there.
3612 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3613 The output is available in that buffer in both cases.
3615 If there is output and an error, a message about the error
3616 appears at the end of the output.
3618 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3619 command's output. If the value is a buffer or buffer name,
3620 erase that buffer and insert the output there; a non-nil value of
3621 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3622 If the value is nil, use the buffer `*Shell Command Output*'.
3623 Any other non-nil value means to insert the output in the
3624 current buffer after START.
3626 Optional fifth arg REPLACE, if non-nil, means to insert the
3627 output in place of text from START to END, putting point and mark
3628 around it.
3630 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3631 or buffer name to which to direct the command's standard error
3632 output. If nil, error output is mingled with regular output.
3633 When called interactively, `shell-command-default-error-buffer'
3634 is used for ERROR-BUFFER.
3636 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3637 display the error buffer if there were any errors. When called
3638 interactively, this is t."
3642 ;; Do this before calling region-beginning
3643 ;; and region-end, in case subprocess output
3644 ;; relocates them while we are in the minibuffer.
3646 ;; call-interactively recognizes region-beginning and
3647 ;; region-end specially, leaving them in the history.
3649 string
3650 current-prefix-arg
3651 current-prefix-arg
3652 shell-command-default-error-buffer
3653 t
3660 temporary-file-directory)))
3661 nil))
3662 exit-status)
3663 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3666 output)
3670 shell-file-name t t
3671 nil shell-command-switch
3672 command)
3679 ;; Replace specified region with output from command.
3681 ;; Don't muck with mark unless REPLACE says we should.
3688 t)))
3689 ;; It is rude to delete a buffer which the command is not using.
3690 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3691 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3692 ;; (kill-buffer shell-buffer)))
3693 ;; Don't muck with mark unless REPLACE says we should.
3695 ;; No prefix argument: put the output in a temp buffer,
3696 ;; replacing its entire contents.
3704 ;; If the input is the same buffer as the output,
3705 ;; delete everything but the specified region,
3706 ;; then replace that region with the output.
3712 shell-file-name t
3715 t)
3716 nil shell-command-switch
3717 command)))
3718 ;; Clear the output buffer, then run the command with
3719 ;; output there.
3729 buffer))))
3730 ;; Report the output.
3740 ;; There's some output, display it
3744 ;; No output; error?
3751 shell-command-default-error-buffer)
3758 output))
3761 exit-status))
3764 exit-status output))))
3765 ;; Don't kill: there might be useful info in the undo-log.
3766 ;; (kill-buffer buffer)
3767 )))))
3775 ;; Do no formatting while reading error file,
3776 ;; because that can run a shell command, and we
3777 ;; don't want that to cause an infinite recursion.
3779 ;; Put point after the inserted errors.
3784 exit-status))
3787 "Execute shell command COMMAND and return its output as a string."
3790 standard-output
3794 "Process files synchronously in a separate process.
3795 Similar to `call-process', but may invoke a file handler based on
3796 `default-directory'. The current working directory of the
3797 subprocess is `default-directory'.
3799 File names in INFILE and BUFFER are handled normally, but file
3800 names in ARGS should be relative to `default-directory', as they
3801 are passed to the process verbatim. (This is a difference to
3802 `call-process' which does not support file handlers for INFILE
3803 and BUFFER.)
3805 Some file handlers might not support all variants, for example
3806 they might behave as if DISPLAY was nil, regardless of the actual
3807 value passed."
3809 lc stderr-file)
3819 display args)
3825 "Whether a call of `process-file' changes remote files.
3827 By default, this variable is always set to t, meaning that a
3828 call of `process-file' could potentially change any file on a
3829 remote host. When set to nil, a file handler could optimize
3830 its behavior with respect to remote file attribute caching.
3832 You should only ever change this variable with a let-binding;
3836 "Start a program in a subprocess. Return the process object for it.
3838 Similar to `start-process', but may invoke a file handler based on
3839 `default-directory'. See Info node `(elisp)Magic File Names'.
3841 This handler ought to run PROGRAM, perhaps on the local host,
3842 perhaps on a remote host that corresponds to `default-directory'.
3843 In the latter case, the local part of `default-directory' becomes
3844 the working directory of the process.
3846 PROGRAM and PROGRAM-ARGS might be file names. They are not
3847 objects of file handler invocation. File handlers might not
3848 support pty association, if PROGRAM is nil."
3852 \f
3853 ;;;; Process menu
3867 map))
3870 "Major mode for listing the processes called by Emacs."
3883 "Kill process at point in a `list-processes' buffer."
3894 "Recompute the list of processes for the Process List buffer.
3895 Also, delete any process that is exited or signaled."
3909 face link
3911 "Visit buffer `%s'"
3913 follow-link t
3914 process-buffer ,buf
3915 action process-menu-visit-buffer)
3924 "datagram"
3941 tabulated-list-entries))))))
3947 "Display a list of all processes that are Emacs sub-processes.
3948 If optional argument QUERY-ONLY is non-nil, only processes with
3949 the query-on-exit flag set are listed.
3950 Any process listed as exited or signaled is actually eliminated
3951 after the listing is made.
3952 Optional argument BUFFER specifies a buffer to use, instead of
3954 The return value is always nil.
3956 This function lists only processes that were launched by Emacs. To
3957 see other processes running on the system, use `list-system-processes'."
3969 nil)
3970 \f
3971 ;;;; Prefix commands
3977 ;; BEWARE: Called directly from C code.
3978 ;; If the return value is non-nil, it means we are in the middle of
3979 ;; a command with prefix, such as a command invoked with prefix-arg.
3981 prefix-command--last-echo
3990 "Abnormal hook which constructs the description of the current prefix state.
3994 "Update state of prefix commands.
4002 "Pass the current prefix command state to the next command.
4003 Should be called by all prefix commands.
4004 Runs `prefix-command-preserve-state-hook'."
4006 ;; If the current command is a prefix command, we don't want the next (real)
4007 ;; command to have `last-command' set to, say, `universal-argument'.
4014 nil)
4016 ;;;;; The main prefix command.
4018 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
4043 ;; For backward compatibility, minus with no modifiers is an ordinary
4044 ;; command if digits have already been entered.
4074 map)
4082 "Begin a numeric argument for the following command.
4087 multiplies the argument by 4 each time.
4089 which is different in effect from any particular numeric argument.
4097 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
4098 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
4105 arg)))
4109 "Begin a negative numeric argument for the next command.
4119 "Part of the numeric argument for the next command.
4124 last-command-event
4131 ;; Treat -0 as just -, so that -01 will work.
4134 digit))))
4136 \f
4139 "This variable is a wrapper hook around `buffer-substring--filter'.
4145 "Function to perform the filtering in `filter-buffer-substring'.
4146 The function is called with the same 3 arguments (BEG END DELETE)
4147 that `filter-buffer-substring' received. It should return the
4148 buffer substring between BEG and END, after filtering. If DELETE is
4152 "List of filter functions for `buffer-substring--filter'.
4153 Each function must accept a single argument, a string, and return a string.
4154 The buffer substring is passed to the first function in the list,
4155 and the return value of each function is passed to the next.
4156 As a special convention, point is set to the start of the buffer text
4157 being operated on (i.e., the first argument of `buffer-substring--filter')
4163 "Return the buffer substring between BEG and END, after filtering.
4164 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4166 This calls the function that `filter-buffer-substring-function' specifies
4167 \(passing the same three arguments that it received) to do the work,
4168 and returns whatever it does. The default function does no filtering,
4169 unless a hook has been set.
4171 Use `filter-buffer-substring' instead of `buffer-substring',
4172 `buffer-substring-no-properties', or `delete-and-extract-region' when
4173 you want to allow filtering to take place. For example, major or minor
4174 modes can use `filter-buffer-substring-function' to extract characters
4175 that are special to a buffer, and should not be copied into other buffers."
4179 "Default function to use for `filter-buffer-substring-function'.
4180 Its arguments and return value are as specified for `filter-buffer-substring'.
4181 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4182 \(see `with-wrapper-hook' for details about wrapper hooks),
4183 and the abnormal hook `buffer-substring-filters'.
4184 No filtering is done unless a hook says to."
4195 string)))
4200 ;;;; Window system cut and paste hooks.
4203 "Function to call to make a killed region available to other programs.
4204 Most window systems provide a facility for cutting and pasting
4205 text between different programs, such as the clipboard on X and
4206 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4208 This variable holds a function that Emacs calls whenever text is
4209 put in the kill ring, to make the new kill available to other
4210 programs. The function takes one argument, TEXT, which is a
4214 "Function to call to get text cut from other programs.
4215 Most window systems provide a facility for cutting and pasting
4216 text between different programs, such as the clipboard on X and
4217 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4219 This variable holds a function that Emacs calls to obtain text
4220 that other programs have provided for pasting. The function is
4221 called with no arguments. If no other program has provided text
4222 to paste, the function should return nil (in which case the
4223 caller, usually `current-kill', should use the top of the Emacs
4224 kill ring). If another program has provided text to paste, the
4225 function should return that text as a string (in which case the
4226 caller should put this string in the kill ring as the latest
4227 kill).
4229 The function may also return a list of strings if the window
4230 system supports multiple selections. The first string will be
4231 used as the pasted text, but the other will be placed in the kill
4232 ring for easy access via `yank-pop'.
4234 Note that the function should return a string only if a program
4235 other than Emacs has provided a string for pasting; if Emacs
4236 provided the most recent string, the function should return nil.
4237 If it is difficult to tell whether Emacs or some other program
4238 provided the current string, it is probably good enough to return
4239 nil if the string is equal (according to `string=') to the last
4241 \f
4244 ;;;; The kill ring data structure.
4247 "List of killed text sequences.
4248 Since the kill ring is supposed to interact nicely with cut-and-paste
4249 facilities offered by window systems, use of this variable should
4250 interact nicely with `interprogram-cut-function' and
4251 `interprogram-paste-function'. The functions `kill-new',
4252 `kill-append', and `current-kill' are supposed to implement this
4253 interaction; you may want to use them instead of manipulating the kill
4257 "Maximum length of kill ring before oldest elements are thrown away."
4265 "Save clipboard strings into kill ring before replacing them.
4266 When one selects something in another program to paste it into Emacs,
4267 but kills something in Emacs before actually pasting it,
4268 this selection is gone unless this variable is non-nil,
4269 in which case the other program's selection is saved in the `kill-ring'
4276 "Do not add a new string to `kill-ring' if it duplicates the last one.
4277 The comparison is done using `equal-including-properties'."
4283 "Make STRING the latest kill in the kill ring.
4284 Set `kill-ring-yank-pointer' to point to it.
4285 If `interprogram-cut-function' is non-nil, apply it to STRING.
4286 Optional second argument REPLACE non-nil means that STRING will replace
4287 the front of the kill ring, rather than being added to the list.
4289 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4290 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4291 STRING.
4293 When the yank handler has a non-nil PARAM element, the original STRING
4294 argument is not used by `insert-for-yank'. However, since Lisp code
4295 may access and use elements from the kill ring directly, the STRING
4298 ;; Due to text properties such as 'yank-handler that
4299 ;; can alter the contents to yank, comparison using
4300 ;; `equal' is unsafe.
4325 ;; It has been argued that this should work similar to `self-insert-command'
4326 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4328 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4334 "Append STRING to the end of the latest kill in the kill ring.
4335 If BEFORE-P is non-nil, prepend STRING to the kill.
4336 Also removes the last undo boundary in the current buffer,
4337 depending on `kill-append-merge-undo'.
4338 If `interprogram-cut-function' is set, pass the resulting kill to it."
4346 ;; find the next undo boundary
4350 ;; remove this undo boundary
4355 "Whether rotating the kill ring changes the window system selection.
4356 If non-nil, whenever the kill ring is rotated (usually via the
4357 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4358 to copy the new kill to the window system selection."
4364 "Rotate the yanking point by N places, and then return that kill.
4365 If N is zero and `interprogram-paste-function' is set to a
4366 function that returns a string or a list of strings, and if that
4367 function doesn't return nil, then that string (or list) is added
4368 to the front of the kill ring and the string (or first string in
4369 the list) is returned as the latest kill.
4371 If N is not zero, and if `yank-pop-change-selection' is
4372 non-nil, use `interprogram-cut-function' to transfer the
4373 kill at the new yank point into the window system selection.
4375 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4376 move the yanking point; just return the Nth kill forward."
4379 interprogram-paste-function
4383 ;; Disable the interprogram cut function when we add the new
4384 ;; text to the kill ring, so Emacs doesn't try to own the
4385 ;; selection, with identical text.
4395 kill-ring)))
4400 interprogram-cut-function)
4406 ;;;; Commands for manipulating the kill ring.
4409 "Non-nil means don't signal an error for killing read-only text."
4415 This deletes the text from the buffer and saves it in the kill ring.
4419 If you want to append the killed region to the last killed text,
4423 If the previous command was also a kill command,
4424 the text killed this time appends to the text killed last time
4425 to make one entry in the kill ring.
4427 The killed text is filtered by `filter-buffer-substring' before it is
4428 saved in the kill ring, so the actual saved text might be different
4429 from what was killed.
4431 If the buffer is read-only, Emacs will beep and refrain from deleting
4432 the text, but put the text in the kill ring anyway. This means that
4433 you can use the killing commands to copy text from a read-only buffer.
4435 Lisp programs should use this function for killing text.
4436 (To delete text, use `delete-region'.)
4437 Supply two arguments, character positions BEG and END indicating the
4438 stretch of text to be killed. If the optional argument REGION is
4439 non-nil, the function ignores BEG and END, and kills the current
4440 region instead."
4441 ;; Pass mark first, then point, because the order matters when
4442 ;; calling `kill-append'.
4451 ;; Add that string to the kill ring, one way or another.
4458 nil)
4460 ;; The code above failed because the buffer, or some of the characters
4461 ;; in the region, are read-only.
4462 ;; We should beep, in case the user just isn't aware of this.
4463 ;; However, there's no harm in putting
4464 ;; the region's text in the kill ring, anyway.
4466 ;; Set this-command now, so it will be set even if we get an error.
4468 ;; This should barf, if appropriate, and give us the correct error.
4471 ;; Signal an error if the buffer is read-only.
4473 ;; If the buffer isn't read-only, the text is.
4476 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4477 ;; to get two copies of the text when the user accidentally types M-w and
4478 ;; then corrects it with the intended C-w.
4480 "Save the region as if killed, but don't kill it.
4481 In Transient Mark mode, deactivate the mark.
4482 If `interprogram-cut-function' is non-nil, also save the text for a window
4483 system cut and paste.
4485 The copied text is filtered by `filter-buffer-substring' before it is
4486 saved in the kill ring, so the actual saved text might be different
4487 from what was in the buffer.
4489 When called from Lisp, save in the kill ring the stretch of text
4490 between BEG and END, unless the optional argument REGION is
4491 non-nil, in which case ignore BEG and END, and save the current
4492 region instead.
4494 This command's old key binding has been given to `kill-ring-save'."
4495 ;; Pass mark first, then point, because the order matters when
4496 ;; calling `kill-append'.
4506 nil)
4509 "Save the region as if killed, but don't kill it.
4510 In Transient Mark mode, deactivate the mark.
4511 If `interprogram-cut-function' is non-nil, also save the text for a window
4512 system cut and paste.
4514 If you want to append the killed line to the last killed text,
4517 The copied text is filtered by `filter-buffer-substring' before it is
4518 saved in the kill ring, so the actual saved text might be different
4519 from what was in the buffer.
4521 When called from Lisp, save in the kill ring the stretch of text
4522 between BEG and END, unless the optional argument REGION is
4523 non-nil, in which case ignore BEG and END, and save the current
4524 region instead.
4526 This command is similar to `copy-region-as-kill', except that it gives
4527 visual feedback indicating the extent of the region being copied."
4528 ;; Pass mark first, then point, because the order matters when
4529 ;; calling `kill-append'.
4533 ;; This use of called-interactively-p is correct because the code it
4534 ;; controls just gives the user visual feedback.
4539 "Indicate that the region text has been copied interactively.
4540 If the mark is visible in the selected window, blink the cursor
4541 between point and mark if there is currently no active region
4542 highlighting.
4544 If the mark lies outside the selected window, display an
4545 informative message containing a sample of the copied text. The
4546 optional argument MESSAGE-LEN, if non-nil, specifies the length
4547 of this sample text; it defaults to 40."
4550 ;; Inhibit quitting so we can make a quit here
4551 ;; look like a C-g typed as a command.
4554 ;; Swap point-and-mark quickly so as to show the region that
4555 ;; was selected. Don't do it if the region is highlighted.
4558 ;; Swap point and mark.
4562 ;; Swap back.
4565 ;; If user quit, deactivate the mark
4566 ;; as C-g would as a command.
4572 ;; Don't say "killed"; that is misleading.
4579 "Cause following command, if it kills, to add to previous kill.
4580 If the next command kills forward from point, the kill is
4581 appended to the previous killed text. If the command kills
4582 backward, the kill is prepended. Kill commands that act on the
4583 region, such as `kill-region', are regarded as killing forward if
4584 point is after mark, and killing backward if point is before
4585 mark.
4587 If the next command is not a kill command, `append-next-kill' has
4588 no effect.
4590 The argument is used for internal purposes; do not supply one."
4592 ;; We don't use (interactive-p), since that breaks kbd macros.
4606 "A subroutine of `squeeze-bidi-context'.
4607 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4611 lim1)
4618 ;; L and R categories include embedding and
4619 ;; override controls, but we don't want to
4620 ;; replace them, because that might change
4621 ;; the visual order. Likewise with PDF and
4622 ;; isolate controls.
4624 bidi-directional-non-controls-chars
4625 limit)))))
4626 ;; Replace any run of non-RTL characters by a single LRM.
4628 ;; No more characters of CATEGORY, we are done.
4633 ;; Skip directional controls, if any.
4638 "Replace characters between FROM and TO while keeping bidi context.
4640 This function replaces the region of text with as few characters
4641 as possible, while preserving the effect that region will have on
4642 bidirectional display before and after the region."
4646 ;; This is for when they copy text with read-only text
4647 ;; properties.
4651 ;; Replace each run of non-RTL characters with a single LRM.
4653 ;; Replace each run of non-LTR characters with a single RLM. Note
4654 ;; that the \cR category includes both the Arabic Letter (AL) and
4655 ;; R characters; here we ignore the distinction between them,
4656 ;; because that distinction only affects Arabic Number (AN)
4657 ;; characters, which are weak and don't affect the reordering.
4661 "Return buffer text between START and END with its bidi context.
4663 START and END are assumed to belong to the same physical line
4664 of buffer text. This function prepends and appends to the text
4665 between START and END bidi control characters that preserve the
4666 visual order of that text when it is inserted at some other place."
4671 substr para-dir from to)
4678 ;; If we don't have any mixed directional characters in the
4679 ;; entire line, we can just copy the substring without adding
4680 ;; any context.
4695 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4696 ;; (1) force the string to have the same base embedding
4697 ;; direction as the paragraph direction at the source, no matter
4698 ;; what is the paragraph direction at destination; and (2) avoid
4699 ;; affecting the visual order of the surrounding text at
4700 ;; destination if there are characters of different
4701 ;; directionality there.
4706 "Return portion of current buffer between START and END with bidi context.
4708 This function works similar to `buffer-substring', but it prepends and
4709 appends to the text bidi directional control characters necessary to
4710 preserve the visual appearance of the text if it is inserted at another
4711 place. This is useful when the buffer substring includes bidirectional
4712 text and control characters that cause non-trivial reordering on display.
4713 If copied verbatim, such text can have a very different visual appearance,
4714 and can also change the visual appearance of the surrounding text at the
4715 destination of the copy.
4717 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4718 the text properties."
4731 no-properties)))
4735 substr)))
4736 \f
4737 ;; Yanking.
4742 "List of special text property handling conditions for yanking.
4743 Each element should have the form (PROP . FUN), where PROP is a
4744 property symbol and FUN is a function. When the `yank' command
4745 inserts text into the buffer, it scans the inserted text for
4746 stretches of text that have `eq' values of the text property
4747 PROP; for each such stretch of text, FUN is called with three
4748 arguments: the property's value in that text, and the start and
4749 end positions of the text.
4751 This is done prior to removing the properties specified by
4752 `yank-excluded-properties'."
4755 function))
4758 ;; This is actually used in subr.el but defcustom does not work there.
4761 intangible invisible keymap local-map mouse-face read-only
4762 yank-handler)
4763 "Text properties to discard when yanking.
4764 The value should be a list of text properties to discard or t,
4765 which means to discard all text properties.
4767 See also `yank-handled-properties'."
4774 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4775 Function is called with two parameters, START and END corresponding to
4776 the value of the mark and point; it is guaranteed that START <= END.
4780 "Replace just-yanked stretch of killed text with a different stretch.
4781 This command is allowed only immediately after a `yank' or a `yank-pop'.
4782 At such a time, the region contains a stretch of reinserted
4783 previously-killed text. `yank-pop' deletes that text and inserts in its
4784 place a different stretch of killed text.
4786 With no argument, the previous kill is inserted.
4787 With argument N, insert the Nth previous kill.
4788 If N is negative, this is a more recent kill.
4790 The sequence of kills wraps around, so that after the oldest one
4791 comes the newest one.
4793 This command honors the `yank-handled-properties' and
4794 `yank-excluded-properties' variables, and the `yank-handler' text
4795 property, in the way that `yank' does."
4809 ;; Set the window start back where it was in the yank command,
4810 ;; if possible.
4813 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4814 ;; It is cleaner to avoid activation, even though the command
4815 ;; loop would deactivate the mark because we inserted text.
4818 nil)
4822 More precisely, reinsert the most recent kill, which is the
4823 stretch of killed text most recently killed OR yanked. Put point
4824 at the end, and set mark at the beginning without activating it.
4826 With argument N, reinsert the Nth most recent kill.
4828 This command honors the `yank-handled-properties' and
4829 `yank-excluded-properties' variables, and the `yank-handler' text
4830 property, as described below.
4832 Properties listed in `yank-handled-properties' are processed,
4833 then those listed in `yank-excluded-properties' are discarded.
4835 If STRING has a non-nil `yank-handler' property anywhere, the
4836 normal insert behavior is altered, and instead, for each contiguous
4837 segment of STRING that has a given value of the `yank-handler'
4838 property, that value is used as follows:
4840 The value of a `yank-handler' property must be a list of one to four
4841 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
4842 FUNCTION, if non-nil, should be a function of one argument (the
4843 object to insert); FUNCTION is called instead of `insert'.
4844 PARAM, if present and non-nil, is passed to FUNCTION (to be handled
4845 in whatever way is appropriate; e.g. if FUNCTION is `yank-rectangle',
4846 PARAM may be a list of strings to insert as a rectangle). If PARAM
4847 is nil, then the current segment of STRING is used.
4848 If NOEXCLUDE is present and non-nil, the normal removal of
4849 `yank-excluded-properties' is not performed; instead FUNCTION is
4850 responsible for the removal. This may be necessary if FUNCTION
4851 adjusts point before or after inserting the object.
4852 UNDO, if present and non-nil, should be a function to be called
4853 by `yank-pop' to undo the insertion of the current PARAM. It is
4854 given two arguments, the start and end of the region. FUNCTION
4855 may set `yank-undo-function' to override UNDO.
4860 ;; If we don't get all the way thru, make last-command indicate that
4861 ;; for the following command.
4869 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4870 ;; It is cleaner to avoid activation, even though the command
4871 ;; loop would deactivate the mark because we inserted text.
4874 ;; If we do get all the way thru, make this-command indicate that.
4877 nil)
4880 "Rotate the yanking point in the kill ring.
4881 With ARG, rotate that many kills forward (or backward, if negative)."
4884 \f
4885 ;; Some kill commands.
4887 ;; Internal subroutine of delete-char
4893 ;; Internal subroutine of backward-delete-char
4900 "The method for untabifying when deleting backward.
4901 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4902 `hungry' -- delete all whitespace, both tabs and spaces;
4903 `all' -- delete all whitespace, including tabs, spaces and newlines;
4904 nil -- just delete one character."
4910 "Delete characters backward, changing tabs into spaces.
4911 The exact behavior depends on `backward-delete-char-untabify-method'.
4912 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4913 Interactively, ARG is the prefix arg (default 1)
4914 and KILLP is t if a prefix arg was specified."
4937 arg)))
4938 ;; Avoid warning about delete-backward-char
4942 "Kill up to and including ARGth occurrence of CHAR.
4943 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4944 Goes backward if ARG is negative; error if CHAR not found."
4947 ;; Avoid "obsolete" warnings for translation-table-for-input.
4955 ;; kill-line and its subroutines.
4958 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4963 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4964 With prefix argument ARG, kill that many lines from point.
4965 Negative arguments kill lines backward.
4966 With zero argument, kills the text before point on the current line.
4969 a number counts as a prefix arg.
4971 To kill a whole line, when point is not at the beginning, type \
4974 If `show-trailing-whitespace' is non-nil, this command will just
4975 kill the rest of the current line, even if there are no nonblanks
4976 there.
4978 If option `kill-whole-line' is non-nil, then this command kills the whole line
4979 including its terminating newline, when used at the beginning of a line
4980 with no argument. As a consequence, you can always kill a whole line
4983 If you want to append the killed line to the last killed text,
4986 If the buffer is read-only, Emacs will beep and refrain from deleting
4987 the line, but put the line in the kill ring anyway. This means that
4988 you can use this command to copy text from a read-only buffer.
4989 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4990 even beep.)"
4993 ;; It is better to move point to the other end of the kill
4994 ;; before killing. That way, in a read-only buffer, point
4995 ;; moves across the text that is copied to the kill ring.
4996 ;; The choice has no effect on undo now that undo records
4997 ;; the value of point from before the command was run.
5007 ;; If trailing whitespace is visible,
5008 ;; don't treat it as nothing.
5018 "Kill current line.
5019 With prefix ARG, kill that many lines starting from the current line.
5020 If ARG is negative, kill backward. Also kill the preceding newline.
5022 If ARG is zero, kill current line but exclude the trailing newline."
5033 ;; We need to kill in two steps, because the previous command
5034 ;; could have been a kill command, in which case the text
5035 ;; before point needs to be prepended to the current kill
5036 ;; ring entry and the text after point appended. Also, we
5037 ;; need to use save-excursion to avoid copying the same text
5038 ;; twice to the kill ring in read-only buffers.
5056 "Move forward by ARG lines, ignoring currently invisible newlines only.
5057 If ARG is negative, move backward -ARG lines.
5058 If ARG is zero, move to the beginning of the current line."
5065 ;; If the newline we just skipped is invisible,
5066 ;; don't count it.
5070 prop
5075 ;; If invisible text follows, and it is a number of complete lines,
5076 ;; skip it.
5082 prop
5098 ;; If the newline we just moved to is invisible,
5099 ;; don't count it.
5104 prop
5109 ;; If invisible text follows, and it is a number of complete lines,
5110 ;; skip it.
5116 prop
5127 nil)))
5130 "Move to end of current visible line."
5132 ;; If the following character is currently invisible,
5133 ;; skip all characters with that same `invisible' property value,
5134 ;; then find the next newline.
5141 prop
5152 "Kill the current buffer.
5153 When called in the minibuffer, get out of the minibuffer
5154 using `abort-recursive-edit'.
5156 This is like `kill-this-buffer', but it doesn't have to be invoked
5157 via the menu bar, and pays no attention to the menu-bar's frame."
5165 \f
5167 "Insert after point the contents of BUFFER.
5168 Puts mark after the inserted text.
5169 BUFFER may be a buffer or a buffer name."
5179 t))))
5184 nil)
5187 "Append to specified buffer the text of the region.
5188 It is inserted into that buffer before its point.
5190 When calling from a program, give three arguments:
5191 BUFFER (or buffer name), START and END.
5192 START and END specify the portion of the current buffer to be copied."
5199 point)
5210 "Prepend to specified buffer the text of the region.
5211 It is inserted into that buffer after its point.
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."
5224 "Copy to specified buffer the text of the region.
5225 It is inserted into that buffer, replacing existing text there.
5227 When calling from a program, give three arguments:
5228 BUFFER (or buffer name), START and END.
5229 START and END specify the portion of the current buffer to be copied."
5237 \f
5241 "Hook run when the mark becomes active.
5242 It is also run at the end of a command, if the mark is active and
5249 "Return this buffer's mark value as integer, or nil if never set.
5251 In Transient Mark mode, this function signals an error if
5252 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5253 or the argument FORCE is non-nil, it disregards whether the mark
5254 is active, and returns an integer or nil in the usual way.
5256 If you are using this in an editing command, you are most likely making
5257 a mistake; see the documentation of `set-mark'."
5262 ;; Behind display-selections-p.
5265 "Deactivate the mark.
5266 If Transient Mark mode is disabled, this function normally does
5267 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5269 Deactivating the mark sets `mark-active' to nil, updates the
5270 primary selection according to `select-active-regions', and runs
5271 `deactivate-mark-hook'.
5273 If Transient Mark mode was temporarily enabled, reset the value
5274 of the variable `transient-mark-mode'; if this causes Transient
5275 Mark mode to be disabled, don't change `mark-active' to nil or
5276 run `deactivate-mark-hook'."
5280 select-active-regions)
5283 ;; The var `saved-region-selection', if non-nil, is the text in
5284 ;; the region prior to the last command modifying the buffer.
5285 ;; Set the selection to that, or to the current region.
5290 ;; If another program has acquired the selection, region
5291 ;; deactivation should not clobber it (Bug#11772).
5310 "Activate the mark.
5311 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5321 "Set this buffer's mark to POS. Don't use this function!
5322 That is to say, don't use this function unless you want
5323 the user to see that the mark has moved, and you want the previous
5324 mark position to be lost.
5326 Normally, when a new mark is set, the old one should go on the stack.
5327 This is why most applications should use `push-mark', not `set-mark'.
5329 Novice Emacs Lisp programmers often try to use the mark for the wrong
5330 purposes. The mark saves a location for the user's convenience.
5331 Most editing commands should not alter the mark.
5332 To remember a location for internal use in the Lisp program,
5333 store it in a Lisp variable. Example:
5335 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5340 ;; Normally we never clear mark-active except in Transient Mark mode.
5341 ;; But when we actually clear out the mark value too, we must
5342 ;; clear mark-active in any mode.
5344 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5345 ;; it should never be nil if the mark is nil.
5353 mark-active))
5360 ;; Mark marker
5366 ;; Mark active
5369 ;; If mark is active now, and either was not active or was at a
5370 ;; different place, run the activate hook.
5375 ;; If mark has ceased to be active, run deactivate hook.
5380 "Like `save-excursion', but also save and restore the mark state.
5381 This macro does what `save-excursion' did before Emacs 25.1."
5391 If nil, region-aware commands treat the empty region as inactive.
5392 If non-nil, region-aware commands treat the region as active as
5393 long as the mark is active, even if the region is empty.
5395 Region-aware commands are those that act on the region if it is
5396 active and Transient Mark mode is enabled, and on the text near
5397 point otherwise."
5403 "Return t if the region is active and it is appropriate to act on it.
5404 This is used by commands that act specially on the region under
5405 Transient Mark mode.
5407 The return value is t if Transient Mark mode is enabled and the
5408 mark is active; furthermore, if `use-empty-active-region' is nil,
5409 the region must not be empty. Otherwise, the return value is nil.
5411 For some commands, it may be appropriate to ignore the value of
5412 `use-empty-active-region'; in that case, use `region-active-p'."
5417 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5419 Some commands act specially on the region when Transient Mark
5420 mode is enabled. Usually, such commands should use
5421 `use-region-p' instead of this function, because `use-region-p'
5422 also checks the value of `use-empty-active-region'."
5424 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5425 ;; without the mark being set (e.g. bug#17324). We really should fix
5426 ;; that problem, but in the mean time, let's make sure we don't say the
5427 ;; region is active when there's no mark.
5431 "Return the boundaries of the region as a list of (START . END) positions."
5435 "Return non-nil if the region contains several pieces.
5436 An example is a rectangular region handled as a list of
5437 separate contiguous regions for each line."
5450 ;; Normal priority so that a large region doesn't hide all the
5451 ;; overlays within it, but high secondary priority so that if it
5452 ;; ends/starts in the middle of a small overlay, that small overlay
5453 ;; won't hide the region's boundaries.
5455 nrol)
5460 rol)))
5476 start end window rol)))
5479 new))))))
5482 "Hook run just before redisplay.
5483 It is called in each window that is to be redisplayed. It takes one argument,
5484 which is the window that will be redisplayed. When run, the `current-buffer'
5505 "Maximum size of mark ring. Start discarding off end if gets this big."
5513 "Maximum size of global mark ring. \
5514 Start discarding off end if gets this big."
5519 "Jump to mark, and pop a new position for mark off the ring.
5520 \(Does not affect global mark ring)."
5530 "Set mark at where point is.
5531 If no prefix ARG and mark is already set there, just activate it.
5532 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5544 will pop the mark twice, and
5546 will pop the mark three times.
5554 "Set the mark where point is, and activate it; or jump to the mark.
5555 Setting the mark also alters the region, which is the text
5556 between point and mark; this is the closest equivalent in
5559 With no prefix argument, set the mark at point, and push the
5560 old mark position on local mark ring. Also push the new mark on
5561 global mark ring, if the previous mark was set in another buffer.
5563 When Transient Mark Mode is off, immediately repeating this
5564 command activates `transient-mark-mode' temporarily.
5567 jump to the mark, and set the mark from
5568 position popped off the local mark ring (this does not affect the global
5570 mark ring (see `pop-global-mark').
5572 If `set-mark-command-repeat-pop' is non-nil, repeating
5574 off the local (or global) mark ring and jumps there.
5577 argument, unconditionally set mark where point is, even if
5578 `set-mark-command-repeat-pop' is non-nil.
5580 Novice Emacs Lisp programmers often try to use the mark for the wrong
5581 purposes. See the documentation of `set-mark' for more information."
5601 arg)
5615 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5616 If the last global mark pushed was not in the current buffer,
5617 also push LOCATION on the global mark ring.
5618 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5620 Novice Emacs Lisp programmers often try to use the mark for the wrong
5621 purposes. See the documentation of `set-mark' for more information.
5623 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5630 ;; Now push the mark on the global mark ring.
5633 ;; The last global mark pushed was in this same buffer.
5634 ;; Don't push another one.
5635 nil
5644 nil)
5647 "Pop off mark ring into the buffer's actual mark.
5648 Does not set point. Does nothing if mark ring is empty."
5660 "Put the mark where point is now, and point where the mark is now.
5661 This command works even when the mark is not active,
5662 and it reactivates the mark.
5664 If Transient Mark mode is on, a prefix ARG deactivates the mark
5665 if it is active, and otherwise avoids reactivating it. If
5666 Transient Mark mode is off, a prefix ARG enables Transient Mark
5667 mode temporarily."
5681 nil))
5684 "When non-nil, shifted motion keys activate the mark momentarily.
5686 While the mark is activated in this way, any shift-translated point
5687 motion key extends the region, and if Transient Mark mode was off, it
5688 is temporarily turned on. Furthermore, the mark will be deactivated
5689 by any subsequent point motion key that was not shift-translated, or
5690 by any action that normally deactivates the mark in Transient Mark mode.
5692 See `this-command-keys-shift-translated' for the meaning of
5693 shift-translation."
5698 "Activate/deactivate mark depending on invocation thru shift translation.
5699 This function is called by `call-interactively' when a command
5700 with a `^' character in its `interactive' spec is invoked, before
5701 running the command itself.
5703 If `shift-select-mode' is enabled and the command was invoked
5704 through shift translation, set the mark and activate the region
5705 temporarily, unless it was already set in this way. See
5706 `this-command-keys-shift-translated' for the meaning of shift
5707 translation.
5709 Otherwise, if the region has been activated temporarily,
5710 deactivate it, and restore the variable `transient-mark-mode' to
5711 its earlier value."
5718 transient-mark-mode)))
5727 "Toggle Transient Mark mode.
5728 With a prefix argument ARG, enable Transient Mark mode if ARG is
5729 positive, and disable it otherwise. If called from Lisp, enable
5730 Transient Mark mode if ARG is omitted or nil.
5732 Transient Mark mode is a global minor mode. When enabled, the
5733 region is highlighted with the `region' face whenever the mark
5735 and after certain other operations that set the mark but whose
5736 main purpose is something else--for example, incremental search,
5742 Many commands change their behavior when Transient Mark mode is
5743 in effect and the mark is active, by acting on the region instead
5744 of their usual default part of the buffer's text. Examples of
5747 To see the documentation of commands which are sensitive to the
5750 :global t
5751 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5755 "Non-nil means it is ok for commands to call `widen' when they want to.
5756 Some commands will do this in order to go to positions outside
5757 the current accessible part of the buffer.
5759 If `widen-automatically' is nil, these commands will do something else
5763 "Whether the currently executing code is performing an essential task.
5764 This variable should be non-nil only when running code which should not
5765 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5766 user for a password when we are simply scanning a set of files in the
5767 background or displaying possible completions before the user even asked
5771 "Pop off global mark ring and jump to the top location."
5773 ;; Pop entries which refer to non-existent buffers.
5791 \f
5793 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5799 "Move cursor vertically down ARG lines.
5800 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5801 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5802 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5803 function will not vscroll.
5805 ARG defaults to 1.
5807 If there is no character in the target line exactly under the current column,
5808 the cursor is positioned after the character in that line which spans this
5809 column, or at the end of the line if it is not long enough.
5810 If there is no line in the buffer after this one, behavior depends on the
5811 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5812 to create a line, and moves the cursor to that line. Otherwise it moves the
5813 cursor to the end of the buffer.
5815 If the variable `line-move-visual' is non-nil, this command moves
5816 by display lines. Otherwise, it moves by buffer lines, without
5817 taking variable-width characters or continued lines into account.
5821 a semipermanent goal column for this command.
5822 Then instead of trying to move exactly vertically (or as close as possible),
5823 this command moves to the specified goal column (or as close as possible).
5824 The goal column is stored in the variable `goal-column', which is nil
5825 when there is no goal column. Note that setting `goal-column'
5826 overrides `line-move-visual' and causes this command to move by buffer
5827 lines rather than by display lines."
5833 ;; When adding a newline, don't expand an abbrev.
5844 nil)
5847 "Move cursor vertically up ARG lines.
5848 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5849 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5850 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5851 function will not vscroll.
5853 ARG defaults to 1.
5855 If there is no character in the target line exactly over the current column,
5856 the cursor is positioned after the character in that line which spans this
5857 column, or at the end of the line if it is not long enough.
5859 If the variable `line-move-visual' is non-nil, this command moves
5860 by display lines. Otherwise, it moves by buffer lines, without
5861 taking variable-width characters or continued lines into account.
5865 a semipermanent goal column for this command.
5866 Then instead of trying to move exactly vertically (or as close as possible),
5867 this command moves to the specified goal column (or as close as possible).
5868 The goal column is stored in the variable `goal-column', which is nil
5869 when there is no goal column. Note that setting `goal-column'
5870 overrides `line-move-visual' and causes this command to move by buffer
5871 lines rather than by display lines."
5882 nil)
5885 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5886 This means moving to the end of each line moved onto.
5887 The beginning of a blank line does not count as the end of a line.
5888 This has no effect when the variable `line-move-visual' is non-nil."
5894 A non-nil setting overrides the variable `line-move-visual', which see."
5901 "Current goal column for vertical motion.
5902 It is the column where point was at the start of the current run
5903 of vertical motion commands.
5905 When moving by visual lines via the function `line-move-visual', it is a cons
5906 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5907 divided by the default column width, and HSCROLL is the number of
5908 columns by which window is scrolled from left margin.
5910 When the `track-eol' feature is doing its job, the value is
5914 "Non-nil means commands that move by lines ignore invisible newlines.
5915 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5916 as if newlines that are invisible didn't exist, and count
5917 only visible newlines. Thus, moving across across 2 newlines
5918 one of which is invisible will be counted as a one-line move.
5919 Also, a non-nil value causes invisible text to be ignored when
5920 counting columns for the purposes of keeping point in the same
5923 Outline mode sets this."
5928 "When non-nil, `line-move' moves point by visual lines.
5929 This movement is based on where the cursor is displayed on the
5930 screen, instead of relying on buffer contents alone. It takes
5931 into account variable-width characters and line continuation.
5932 If nil, `line-move' moves point by logical lines.
5933 A non-nil setting of `goal-column' overrides the value of this variable
5934 and forces movement by logical lines.
5935 A window that is horizontally scrolled also forces movement by logical
5936 lines."
5941 ;; Only used if display-graphic-p.
5945 "Return the height in pixels of the current buffer's default face font.
5947 If the default font is remapped (see `face-remapping-alist'), the
5948 function returns the height of the remapped face."
5952 ;; Avoid calling font-info if the frame's default font was
5953 ;; not changed since the frame was created. That's because
5954 ;; font-info is expensive for some fonts, see bug #14838.
5960 "Return the width in pixels of the current buffer's default face font.
5962 If the default font is remapped (see `face-remapping-alist'), the
5963 function returns the width of the remapped face."
5967 ;; Avoid calling font-info if the frame's default font was
5968 ;; not changed since the frame was created. That's because
5969 ;; font-info is expensive for some fonts, see bug #14838.
5974 width
5979 "Return the pixel height of current buffer's default-face text line.
5981 The value includes `line-spacing', if any, defined for the buffer
5982 or the frame."
5995 "Return the number of screen lines in the text area of the selected window.
5997 This is different from `window-text-height' in that this function counts
5998 lines in units of the height of the font used by the default face displayed
5999 in the window, not in units of the frame's default font, and also accounts
6000 for `line-spacing', if any, defined for the window's buffer or frame.
6002 The value is a floating-point number."
6007 ;; Returns non-nil if partial move was done.
6010 ;; Move backward (up).
6011 ;; If already vscrolled, reduce vscroll
6017 ;; Move forward (down).
6030 py vs last-line)
6050 col-row)
6055 ;; VPOS > 0 means the last line is only partially visible.
6056 ;; But if the part that is visible is at least as tall as the
6057 ;; default font, that means the line is actually fully
6058 ;; readable, and something like line-spacing is hidden. So in
6059 ;; that case we accept the last line in the window as still
6060 ;; visible, and consider the margin as starting one line
6061 ;; later.
6069 ;; If last line of window is fully visible, and vscrolling
6070 ;; more would make this line invisible, move forward.
6075 nil)
6076 ;; If cursor is not in the bottom scroll margin, and the
6077 ;; current line is is not too tall, move forward.
6079 vpos
6082 nil)
6083 ;; When already vscrolled, we vscroll some more if we can,
6084 ;; or clear vscroll and move forward at end of tall image.
6089 ;; If cursor just entered the bottom scroll margin, move forward,
6090 ;; but also optionally vscroll one line so redisplay won't recenter.
6094 ;; Don't vscroll if the partially-visible line at window
6095 ;; bottom is not too tall (a.k.a. "just one more text
6096 ;; line"): in that case, we do want redisplay to behave
6097 ;; normally, i.e. recenter or whatever.
6098 ;;
6099 ;; Note: ROWH + RBOT from the value returned by
6100 ;; pos-visible-in-window-p give the total height of the
6101 ;; partially-visible glyph row at the end of the window. As
6102 ;; we are dealing with floats, we disregard sub-pixel
6103 ;; discrepancies between that and DLH.
6107 t)
6108 ;; If there are lines above the last line, scroll-up one line.
6111 t)
6112 ;; Finally, start vscroll.
6117 ;; This is like line-move-1 except that it also performs
6118 ;; vertical scrolling of tall images if appropriate.
6119 ;; That is not really a clean thing to do, since it mixes
6120 ;; scrolling with cursor motion. But so far we don't have
6121 ;; a cleaner solution to the problem of making C-n do something
6122 ;; useful given a tall image.
6124 "Move forward ARG lines.
6125 If NOERROR, don't signal an error if we can't move ARG lines.
6126 TO-END is unused.
6127 TRY-VSCROLL controls whether to vscroll tall lines: if either
6128 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6129 not vscroll."
6133 ;; Only vscroll for single line moves
6135 ;; Under scroll-conservatively, the display engine
6136 ;; does this better.
6138 ;; But don't vscroll in a keyboard macro.
6144 ;; Display-based column are incompatible with goal-column.
6146 ;; When the text in the window is scrolled to the left,
6147 ;; display-based motion doesn't make sense (because each
6148 ;; logical line occupies exactly one screen line).
6150 ;; Likewise when the text _was_ scrolled to the left
6151 ;; when the current run of vertical motion commands
6152 ;; started.
6155 auto-hscroll-mode
6157 (>= temporary-goal-column
6160 ;; If we moved into a tall line, set vscroll to make
6161 ;; scrolling through tall images more smooth.
6165 winh)
6171 nil
6175 ;; Display-based alternative to line-move-1.
6176 ;; Arg says how many lines to move. The value is t if we can move the
6177 ;; specified number of lines.
6179 "Move ARG lines forward.
6180 If NOERROR, don't signal an error if we can't move that many lines."
6183 target-hscroll)
6184 ;; Check if the previous command was a line-motion command, or if
6185 ;; we were called from some other command.
6188 ;; If so, there's no need to reset `temporary-goal-column',
6189 ;; but we may need to hscroll.
6193 ;; Otherwise, we should reset `temporary-goal-column'.
6195 x-pos)
6197 ;; Handle the `overflow-newline-into-fringe' case:
6202 ;; In R2L lines, the X pixel coordinate is measured from the
6203 ;; left edge of the window, but columns are still counted
6204 ;; from the logical-order beginning of the line, i.e. from
6205 ;; the right edge in this case. We need to adjust for that.
6211 hscroll)))
6213 ;; When we move beyond the first/last character visible in
6214 ;; the window, posn-at-point will return nil, so we need to
6215 ;; approximate the goal column as below.
6220 ;; vertical-motion can move more than it was asked to if it moves
6221 ;; across display strings with newlines. We don't want to ring
6222 ;; the bell and announce beginning/end of buffer in that case.
6228 temporary-goal-column))
6229 arg))
6230 arg))
6236 temporary-goal-column))
6237 arg))
6238 arg)))
6241 ;; If the goal column lies on a display string,
6242 ;; `vertical-motion' advances the cursor to the end
6243 ;; of the string. For arg < 0, this can cause the
6244 ;; cursor to get stuck. (Bug#3020).
6248 nil)))))
6250 ;; This is the guts of next-line and previous-line.
6251 ;; Arg says how many lines to move.
6252 ;; The value is t if we can move the specified number of lines.
6254 ;; Don't run any point-motion hooks, and disregard intangibility,
6255 ;; for intermediate positions.
6267 ;; Don't count beg of empty line as end of line
6268 ;; unless we just did explicit end-of-line.
6270 most-positive-fixnum
6274 line-move-ignore-invisible))
6275 ;; Use just newline characters.
6276 ;; Set ARG to 0 if we move as many lines as requested.
6279 ;; This way of moving forward ARG lines
6280 ;; verifies that we have a newline after the last one.
6281 ;; It doesn't get confused by intangible text.
6290 'beginning-of-buffer
6292 nil)))
6293 ;; Move by arg lines, but ignore invisible ones.
6296 ;; If the following character is currently invisible,
6297 ;; skip all characters with that same `invisible' property value.
6300 ;; Move a line.
6301 ;; We don't use `end-of-line', since we want to escape
6302 ;; from field boundaries occurring exactly at point.
6308 ;; If there's no invisibility here, move over the newline.
6317 ;; We avoid vertical-motion when possible
6318 ;; because that has to fontify.
6320 ;; Otherwise move a more sophisticated way.
6327 ;; The logic of this is the same as the loop above,
6328 ;; it just goes in the other direction.
6330 ;; For completely consistency with the forward-motion
6331 ;; case, we should call beginning-of-line here.
6332 ;; However, if point is inside a field and on a
6333 ;; continued line, the call to (vertical-motion -1)
6334 ;; below won't move us back far enough; then we return
6335 ;; to the same column in line-move-finish, and point
6336 ;; gets stuck -- cyd
6354 ;; if our target is the middle of this line.
6359 ;; This is the value the function returns.
6363 ;; If we did not move down as far as desired, at least go
6364 ;; to end of line. Be sure to call point-entered and
6365 ;; point-left-hooks.
6371 ;; If we did not move up as far as desired,
6372 ;; at least go to beginning of line.
6384 ;; Set REPEAT to t to repeat the whole thing.
6391 ;; Compute the end of the line
6392 ;; ignoring effectively invisible newlines.
6394 ;; Like end-of-line but ignores fields.
6401 ;; Move to the desired column.
6404 ;; Corner case: suppose we start out in a field boundary in
6405 ;; the middle of a continued line. When we get to
6406 ;; line-move-finish, point is at the start of a new *screen*
6407 ;; line but the same text line; then line-move-to-column would
6408 ;; move us backwards. Test using C-n with point on the "x" in
6409 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6416 ;; Process intangibility within a line.
6417 ;; With inhibit-point-motion-hooks bound to nil, a call to
6418 ;; goto-char moves point past intangible text.
6420 ;; However, inhibit-point-motion-hooks controls both the
6421 ;; intangibility and the point-entered/point-left hooks. The
6422 ;; following hack avoids calling the point-* hooks
6423 ;; unnecessarily. Note that we move *forward* past intangible
6424 ;; text when the initial and final points are the same.
6429 ;; If intangibility moves us to a different (later) place
6430 ;; in the same line, use that as the destination.
6433 ;; If that position is "too late",
6434 ;; try the previous allowable position.
6435 ;; See if it is ok.
6438 ;; If going forward, don't accept the previous
6439 ;; allowable position if it is before the target line.
6441 ;; If going backward, don't accept the previous
6442 ;; allowable position if it is still after the target line.
6445 ;; As a last resort, use the end of the line.
6448 ;; Now move to the updated destination, processing fields
6449 ;; as well as intangibility.
6453 ;; Ignore field boundaries if the initial and final
6454 ;; positions have the same `field' property, even if the
6455 ;; fields are non-contiguous. This seems to be "nicer"
6456 ;; behavior in many situations.
6459 new
6463 ;; If all this moved us to a different line,
6464 ;; retry everything within that new line.
6466 ;; Repeat the intangibility and field processing.
6470 "Try to find column COL, considering invisibility.
6471 This function works only in certain cases,
6472 because what we really need is for `move-to-column'
6473 and `current-column' to be able to ignore invisible text."
6482 ;; If the following character is currently invisible,
6483 ;; skip all characters with that same `invisible' property value.
6487 ;; Have we advanced to a larger column position?
6489 ;; We have made some progress towards the desired column.
6490 ;; See if we can make any further progress.
6492 ;; Otherwise, go to the place we originally found
6493 ;; and move back over invisible text.
6494 ;; that will get us to the same place on the screen
6495 ;; but with a more reasonable buffer position.
6498 ;; We want the real line beginning, so it's consistent
6499 ;; with bolp below, otherwise we might infloop.
6506 "Move point to end of current line as displayed.
6507 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6508 If point reaches the beginning or end of buffer, it stops there.
6510 To ignore the effects of the `intangible' text or overlay
6511 property, bind `inhibit-point-motion-hooks' to t.
6512 If there is an image in the current line, this function
6513 disregards newlines that are part of the text on which the image
6514 rests."
6524 ;; With bidi reordering, we may not be at bol,
6525 ;; so make sure we are.
6540 ;; If we skipped something intangible and now we're not
6541 ;; really at eol, keep going.
6546 "Move point to beginning of current line as displayed.
6547 \(If there's an image in the line, this disregards newlines
6548 which are part of the text that the image rests on.)
6550 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6551 If point reaches the beginning or end of buffer, it stops there.
6552 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6557 first-vis first-vis-field-value)
6559 ;; Move by lines, if ARG is not 1 (the default).
6564 ;; Move to beginning-of-line, ignoring fields and invisible text.
6570 ;; Now find first visible char in the line.
6575 ;; See if fields would stop us from reaching FIRST-VIS.
6580 ;; If yes, obey them.
6581 first-vis-field-value
6582 ;; Otherwise, move to START with attention to fields.
6583 ;; (It is possible that fields never matter in this case.)
6588 ;; Many people have said they rarely use this feature, and often type
6589 ;; it by accident. Maybe it shouldn't even be on a key.
6594 Those commands will move to this position in the line moved to
6595 rather than trying to keep the same horizontal position.
6596 With a non-nil argument ARG, clears out the goal column
6598 The goal column is stored in the variable `goal-column'.
6599 This is a buffer-local setting."
6606 ;; The older method below can be erroneous if `set-goal-column' is bound
6607 ;; to a sequence containing %
6608 ;;(message (substitute-command-keys
6609 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6610 ;;goal-column)
6617 )
6618 nil)
6619 \f
6620 ;;; Editing based on visual lines, as opposed to logical lines.
6623 "Move point to end 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."
6632 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6633 ;; constrain to field boundaries, so we don't either.
6637 "Move point to beginning of current visual line.
6638 With argument N not nil or 1, move forward N - 1 visual lines first.
6639 If point reaches the beginning or end of buffer, it stops there.
6640 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6648 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6652 "Kill the rest of the visual line.
6653 With prefix argument ARG, kill that many visual lines from point.
6654 If ARG is negative, kill visual lines backward.
6655 If ARG is zero, kill the text before point on the current visual
6656 line.
6658 If you want to append the killed line to the last killed text,
6661 If the buffer is read-only, Emacs will beep and refrain from deleting
6662 the line, but put the line in the kill ring anyway. This means that
6663 you can use this command to copy text from a read-only buffer.
6664 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6665 even beep.)"
6667 ;; Like in `kill-line', it's better to move point to the other end
6668 ;; of the kill before killing.
6676 ;; Skip any trailing whitespace at the end of the visual line.
6677 ;; We used to do this only if `show-trailing-whitespace' is
6678 ;; nil, but that's wrong; the correct thing would be to check
6679 ;; whether the trailing whitespace is highlighted. But, it's
6680 ;; OK to just do this unconditionally.
6687 "Move cursor vertically down ARG lines.
6688 This is identical to `next-line', except that it always moves
6689 by logical lines instead of visual lines, ignoring the value of
6690 the variable `line-move-visual'."
6697 "Move cursor vertically up ARG lines.
6698 This is identical to `previous-line', except that it always moves
6699 by logical lines instead of visual lines, ignoring the value of
6700 the variable `line-move-visual'."
6707 "Editing based on visual lines."
6716 ;; These keybindings interfere with xterm function keys. Are
6717 ;; there any other suitable bindings?
6718 ;; (define-key map "\M-[" 'previous-logical-line)
6719 ;; (define-key map "\M-]" 'next-logical-line)
6720 map))
6723 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6724 The value should be a list of the form (LEFT RIGHT), where LEFT
6725 and RIGHT are symbols representing the bitmaps to display, to
6726 indicate wrapped lines, in the left and right fringes respectively.
6727 See also `fringe-indicator-alist'.
6728 The default is not to display fringe indicators for wrapped lines.
6729 This variable does not affect fringe indicators displayed for
6730 other purposes."
6745 'continuation
6752 "Toggle visual line based editing (Visual Line mode).
6753 With a prefix argument ARG, enable Visual Line mode if ARG is
6754 positive, and disable it otherwise. If called from Lisp, enable
6755 the mode if ARG is omitted or nil.
6757 When Visual Line mode is enabled, `word-wrap' is turned on in
6758 this buffer, and simple editing commands are redefined to act on
6759 visual lines, not logical lines. See Info node `Visual Line
6760 Mode' for details."
6761 :keymap visual-line-mode-map
6767 ;; Save the local values of some variables, to be restored if
6768 ;; visual-line-mode is turned off.
6770 truncate-partial-width-windows
6771 word-wrap fringe-indicator-alist))
6774 visual-line--saved-state)))
6778 word-wrap t
6779 fringe-indicator-alist
6781 fringe-indicator-alist)))
6795 visual-line-mode turn-on-visual-line-mode)
6797 \f
6799 "Interchange characters around point, moving forward one character.
6800 With prefix arg ARG, effect is to take character before point
6801 and drag it forward past ARG other characters (backward if ARG negative).
6802 If no argument and at end of line, the previous two chars are exchanged."
6810 "Interchange words around point, leaving point at end of them.
6811 With prefix arg ARG, effect is to take word before or around point
6812 and drag it forward past ARG other words (backward if ARG negative).
6813 If ARG is zero, the words around or after point and around or after mark
6814 are interchanged."
6815 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6821 Unlike `transpose-words', point must be between the two sexps and not
6822 in the middle of a sexp to be transposed.
6823 With non-zero prefix arg ARG, effect is to take the sexp before point
6824 and drag it forward past ARG other sexps (backward if ARG is negative).
6825 If ARG is zero, the sexps ending at or after point and at or after mark
6826 are interchanged."
6830 ;; Here we should try to simulate the behavior of
6831 ;; (cons (progn (forward-sexp x) (point))
6832 ;; (progn (forward-sexp (- x)) (point)))
6833 ;; Except that we don't want to rely on the second forward-sexp
6834 ;; putting us back to where we want to be, since forward-sexp-function
6835 ;; might do funny things like infix-precedence.
6840 ;; Jumping over a symbol. We might be inside it, mind you.
6845 ;; Otherwise, we're between sexps. Take a step back before jumping
6846 ;; to make sure we'll obey the same precedence no matter which direction
6847 ;; we're going.
6852 'skip-syntax-forward
6859 "Exchange current line and previous line, leaving point after both.
6860 With argument ARG, takes previous line and moves it past ARG lines.
6861 With argument 0, interchanges line point is in with line mark is in."
6867 ;; Move forward over ARG lines,
6868 ;; but create newlines if necessary.
6875 arg))
6877 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6878 ;; which seems inconsistent with the ARG /= 0 case.
6879 ;; FIXME document SPECIAL.
6881 "Subroutine to do the work of transposing objects.
6882 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6883 moves forward by units of the given object (e.g. forward-sentence,
6884 forward-paragraph). If ARG is zero, exchanges the current object
6885 with the one containing mark. If ARG is an integer, moves the
6886 current object past ARG following (if ARG is positive) or
6887 preceding (if ARG is negative) objects, leaving point after the
6888 current object."
6893 pos1 pos2)
6922 ;; This sequence of insertions attempts to preserve marker
6923 ;; positions at the start and end of the transposed objects.
6937 \f
6939 "Move backward until encountering the beginning of a word.
6940 With argument ARG, do this that many times.
6941 If ARG is omitted or nil, move point backward one word.
6943 The word boundaries are normally determined by the buffer's syntax
6944 table, but `find-word-boundary-function-table', such as set up
6945 by `subword-mode', can change that. If a Lisp program needs to
6946 move by words determined strictly by the syntax table, it should
6947 use `backward-word-strictly' instead."
6952 "Set mark ARG words away from point.
6954 move to with the same argument.
6955 Interactively, if this command is repeated
6956 or (in Transient Mark mode) if the mark is active,
6957 it marks the next ARG words after the ones already marked."
6974 nil t))))
6977 "Kill characters forward until encountering the end of a word.
6978 With argument ARG, do this that many times."
6983 "Kill characters backward until encountering the beginning of a word.
6984 With argument ARG, do this that many times."
6989 "Return the word at or near point, as a string.
6990 The return value includes no text properties.
6992 If optional arg STRICT is non-nil, return nil unless point is
6993 within or adjacent to a word, otherwise look for a word within
6994 point's line. If there is no word anywhere on point's line, the
6995 value is nil regardless of STRICT.
6997 By default, this function treats as a single word any sequence of
6998 characters that have either word or symbol syntax. If optional
6999 arg REALLY-WORD is non-nil, only characters of word syntax can
7000 constitute a word."
7009 ;; Point is neither within nor adjacent to a word.
7011 ;; Look for preceding word in same line.
7014 ;; No preceding word in same line.
7015 ;; Look for following word in same line.
7024 ;; If we found something nonempty, return it as a string.
7027 \f
7029 "String for filling to insert at front of new line, or nil for none."
7031 string)
7037 "Regexp to match lines which should not be auto-filled."
7039 regexp)
7043 "The default value for `normal-auto-fill-function'.
7044 This is the default auto-fill function, some major modes use a different one.
7045 Returns t if it really did any work."
7055 nil ;; Auto-filling not required
7059 ;; Choose a fill-prefix automatically.
7067 ;; Use auto-indentation rather than a guessed empty prefix.
7073 ;; Determine where to split the line.
7086 ;; See whether the place we found is any good.
7090 ;; There is no use breaking at end of line.
7092 ;; It is futile to split at the end of the prefix
7093 ;; since we would just insert the prefix again.
7095 ;; Don't split right after a comment starter
7096 ;; since we would just make another comment starter.
7101 limit t)
7103 ;; No good place to break => stop trying.
7105 ;; Ok, we have a useful place to break the line. Do it.
7107 ;; If point is at the fill-point, do not `save-excursion'.
7108 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7109 ;; point will end up before it rather than after it.
7117 ;; Now do justification, if required
7122 ;; If making the new line didn't reduce the hpos of
7123 ;; the end of the line, then give up now;
7124 ;; trying again will not help.
7127 ;; Justify last line.
7129 t)))
7132 "Mode-specific function which line breaks and continues a comment.
7133 This function is called during auto-filling when a comment syntax
7134 is defined.
7135 The function should take a single optional argument, which is a flag
7139 "Break line at point and indent.
7140 If a comment syntax is defined, call `comment-indent-new-line'.
7142 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7143 unless optional argument SOFT is non-nil."
7147 ;; Insert the newline before removing empty space so that markers
7148 ;; get preserved better.
7154 ;; Blindly trust a non-adaptive fill-prefix.
7160 ;; If there's an adaptive prefix, use it unless we're inside
7161 ;; a comment and the prefix is not a comment starter.
7165 ;; If we're not inside a comment, just try to indent.
7169 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7173 ;; `functions' and `hooks' are usually unsafe to set, but setting
7174 ;; auto-fill-function to nil in a file-local setting is safe and
7175 ;; can be useful to prevent auto-filling.
7179 "Toggle automatic line breaking (Auto Fill mode).
7180 With a prefix argument ARG, enable Auto Fill mode if ARG is
7181 positive, and disable it otherwise. If called from Lisp, enable
7182 the mode if ARG is omitted or nil.
7184 When Auto Fill mode is enabled, inserting a space at a column
7185 beyond `current-fill-column' automatically breaks the line at a
7186 previous space.
7188 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7189 non-nil.
7191 The value of `normal-auto-fill-function' specifies the function to use
7192 for `auto-fill-function' when turning Auto Fill mode on."
7197 ;; This holds a document string used to document auto-fill-mode.
7199 "Automatically break line at a previous space, in insertion of text."
7200 nil)
7203 "Unconditionally turn on Auto Fill mode."
7207 "Unconditionally turn off Auto Fill mode."
7213 "Set `fill-column' to specified argument.
7218 ;; We used to use current-column silently, but C-x f is too easily
7219 ;; typed as a typo for C-x C-f, so we turned it into an error and
7220 ;; now an interactive prompt.
7225 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7229 \f
7231 "Set `selective-display' to ARG; clear it if no arg.
7232 When the value of `selective-display' is a number > 0,
7233 lines whose indentation is >= that value are not displayed.
7234 The variable `selective-display' has a separate value for each buffer."
7254 "Toggle truncating of long lines for the current buffer.
7255 When truncating is off, long lines are folded.
7256 With prefix argument ARG, truncate long lines if ARG is positive,
7257 otherwise fold them. Note that in side-by-side windows, this
7258 command has no effect if `truncate-partial-width-windows' is
7259 non-nil."
7271 nil t)))
7276 "Toggle whether to use word-wrapping for continuation lines.
7277 With prefix argument ARG, wrap continuation lines at word boundaries
7278 if ARG is positive, otherwise wrap them at the right screen edge.
7279 This command toggles the value of `word-wrap'. It has no effect
7280 if long lines are truncated."
7296 "Toggle Overwrite mode.
7297 With a prefix argument ARG, enable Overwrite mode if ARG is
7298 positive, and disable it otherwise. If called from Lisp, enable
7299 the mode if ARG is omitted or nil.
7301 When Overwrite mode is enabled, printing characters typed in
7302 replace existing text on a one-for-one basis, rather than pushing
7303 it to the right. At the end of a line, such characters extend
7304 the line. Before a tab, such characters insert until the tab is
7306 overwrite mode; this is supposed to make it easier to insert
7307 characters when necessary."
7312 "Toggle Binary Overwrite mode.
7313 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7314 is positive, and disable it otherwise. If called from Lisp,
7315 enable the mode if ARG is omitted or nil.
7317 When Binary Overwrite mode is enabled, printing characters typed
7318 in replace existing text. Newlines are not treated specially, so
7319 typing at the end of a line joins the line to the next, with the
7320 typed character between them. Typing before a tab character
7321 simply replaces the tab with the character typed.
7323 ordinary typing characters do.
7325 Note that Binary Overwrite mode is not its own minor mode; it is
7326 a specialization of overwrite mode, entered by setting the
7327 `overwrite-mode' variable to `overwrite-mode-binary'."
7332 "Toggle line number display in the mode line (Line Number mode).
7333 With a prefix argument ARG, enable Line Number mode if ARG is
7334 positive, and disable it otherwise. If called from Lisp, enable
7335 the mode if ARG is omitted or nil.
7337 Line numbers do not appear for very large buffers and buffers
7338 with very long lines; see variables `line-number-display-limit'
7339 and `line-number-display-limit-width'."
7343 "Toggle column number display in the mode line (Column Number mode).
7344 With a prefix argument ARG, enable Column Number mode if ARG is
7345 positive, and disable it otherwise.
7347 If called from Lisp, enable the mode if ARG is omitted or nil."
7351 "Toggle buffer size display in the mode line (Size Indication mode).
7352 With a prefix argument ARG, enable Size Indication mode if ARG is
7353 positive, and disable it otherwise.
7355 If called from Lisp, enable the mode if ARG is omitted or nil."
7359 "Toggle auto-saving in the current buffer (Auto Save mode).
7360 With a prefix argument ARG, enable Auto Save mode if ARG is
7361 positive, and disable it otherwise.
7363 If called from Lisp, enable the mode if ARG is omitted or nil."
7365 ;; If auto-save is off because buffer has shrunk,
7366 ;; then toggling should turn it on.
7374 buffer-file-name)
7376 ;; If -1 was stored here, to temporarily turn off saving,
7377 ;; turn it back on.
7380 \f
7382 "Blinking matching of parens and expressions."
7387 "Non-nil means show matching open-paren when close-paren is inserted.
7388 If t, highlight the paren. If `jump', briefly move cursor to its
7389 position. If `jump-offscreen', move cursor there even if the
7390 position is off screen. With any other non-nil value, the
7391 off-screen position of the opening paren will be shown in the
7392 echo area."
7401 "Non-nil means show matching open-paren when it is on screen.
7402 If nil, don't show it (but the open-paren can still be shown
7403 in the echo area when it is off screen).
7405 This variable has no effect if `blink-matching-paren' is nil.
7406 \(In that case, the open-paren is never shown.)
7407 It is also ignored if `show-paren-mode' is enabled."
7412 "If non-nil, maximum distance to search backwards for matching open-paren.
7413 If nil, search stops at the beginning of the accessible portion of the buffer."
7419 "Time in seconds to delay after showing a matching paren."
7424 "If nil, `blink-matching-paren' ignores comments.
7425 More precisely, when looking for the matching parenthesis,
7426 it skips the contents of comments that end before point."
7431 "Return whether or not START...END are matching parens.
7432 END is the current point and START is the blink position.
7433 START might be nil if no matching starter was found.
7434 Returns non-nil if we find there is a mismatch."
7439 ;; For self-matched chars like " and $, we can't know when they're
7440 ;; mismatched or unmatched, so we can only do it for parens.
7445 ;; The cdr might hold a new paren-class info rather than
7446 ;; a matching-char info, in which case the two CDRs
7447 ;; should match.
7451 "Function to check parentheses mismatches.
7452 The function takes two arguments (START and END) where START is the
7453 position just before the opening token and END is the position right after.
7454 START can be nil, if it was not found.
7461 ol)
7465 "Momentarily highlight the beginning of the sexp before point."
7468 blink-matching-paren)
7478 oldpos))
7486 ;; backward-sexp skips backward over prefix chars,
7487 ;; so move back to the matching paren.
7510 ;; Matching open within window, temporarily move to or highlight
7511 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7512 ;; is non-nil.
7529 ;; Show what precedes the open in its line, if anything.
7534 ;; Show what follows the open in its line, if anything.
7541 ;; Otherwise show the previous nonblank line,
7542 ;; if there is one.
7551 ;; Replace the newline and other whitespace with `...'.
7552 "..."
7554 ;; There is nothing to show except the char itself.
7557 "Matches %s"
7561 "Function called, if non-nil, whenever a close parenthesis is inserted.
7567 blink-paren-function
7570 ;; Verify an even number of quoting characters precede the close.
7571 ;; FIXME: Also check if this parenthesis closes a comment as
7572 ;; can happen in Pascal and SML.
7583 ;; Most likely, this hook is nil, so this arg doesn't matter,
7584 ;; but I use it as a reminder that this function usually
7585 ;; likes to be run after others since it does
7586 ;; `sit-for'. That's also the reason it get a `priority' prop
7587 ;; of 100.
7589 \f
7590 ;; This executes C-g typed while Emacs is waiting for a command.
7591 ;; Quitting out of a program does not go through here;
7592 ;; that happens in the maybe_quit function at the C code level.
7594 "Signal a `quit' condition.
7595 During execution of Lisp code, this character causes a quit directly.
7596 At top-level, as an editor command, this simply beeps."
7598 ;; Avoid adding the region to the window selection.
7606 ;; Force the next redisplay cycle to remove the "Def" indicator from
7607 ;; all the mode lines.
7621 This command can exit an interactive command such as `query-replace',
7622 can clear out a prefix argument or a region,
7623 can get out of the minibuffer or other recursive edit,
7624 cancel the use of the current buffer (for special-purpose buffers),
7625 or go back to just one window (by deleting all but the selected window)."
7633 nil)
7644 "Play sound stored in FILE.
7645 VOLUME and DEVICE correspond to the keywords of the sound
7646 specification for `play-sound'."
7656 \f
7658 "Your preference for a mail reading package.
7659 This is used by some keybindings which support reading mail.
7660 See also `mail-user-agent' concerning sending mail."
7670 "Your preference for a mail composition package.
7671 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7672 outgoing email message. This variable lets you specify which
7673 mail-sending package you prefer.
7675 Valid values include:
7677 `message-user-agent' -- use the Message package.
7678 See Info node `(message)'.
7679 `sendmail-user-agent' -- use the Mail package.
7680 See Info node `(emacs)Sending Mail'.
7681 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7682 See Info node `(mh-e)'.
7683 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7684 paraphernalia if Gnus is running, particularly
7685 the Gcc: header for archiving.
7687 Additional valid symbols may be available; check with the author of
7688 your package for details. The function should return non-nil if it
7689 succeeds.
7691 See also `read-mail-command' concerning reading mail."
7694 message-user-agent)
7697 sendmail-user-agent)
7700 mh-e-user-agent)
7703 gnus-user-agent)
7709 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7710 If the value of `mail-user-agent' is the default, and the user
7711 appears to have customizations applying to the old default,
7712 `compose-mail' issues a warning."
7718 "If the buffer starts with a mail header, move point to the header's end.
7719 Otherwise, moves to `point-min'.
7720 The end of the header is the start of the next line, if there is one,
7721 else the end of the last line. This function obeys RFC822."
7727 ;; Used by Rmail (e.g., rmail-forward).
7729 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7733 switch-function yank-action send-actions
7734 return-action)
7735 "Start composing a mail message to send.
7736 This uses the user's chosen mail composition package
7737 as selected with the variable `mail-user-agent'.
7738 The optional arguments TO and SUBJECT specify recipients
7739 and the initial Subject field, respectively.
7741 OTHER-HEADERS is an alist specifying additional
7742 header fields. Elements look like (HEADER . VALUE) where both
7743 HEADER and VALUE are strings.
7745 CONTINUE, if non-nil, says to continue editing a message already
7746 being composed. Interactively, CONTINUE is the prefix argument.
7748 SWITCH-FUNCTION, if non-nil, is a function to use to
7749 switch to and display the buffer used for mail composition.
7751 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7752 to insert the raw text of the message being replied to.
7753 It has the form (FUNCTION . ARGS). The user agent will apply
7754 FUNCTION to ARGS, to insert the raw text of the original message.
7755 \(The user agent will also run `mail-citation-hook', *after* the
7756 original text has been inserted in this way.)
7758 SEND-ACTIONS is a list of actions to call when the message is sent.
7759 Each action has the form (FUNCTION . ARGS).
7761 RETURN-ACTION, if non-nil, is an action for returning to the
7762 caller. It has the form (FUNCTION . ARGS). The function is
7763 called after the mail has been sent or put aside, and the mail
7764 buffer buried."
7768 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7769 ;; from sendmail-user-agent to message-user-agent. Some users may
7770 ;; encounter incompatibilities. This hack tries to detect problems
7771 ;; and warn about them.
7776 mail-yank-hooks mail-archive-file-name
7777 mail-default-reply-to mail-mailing-lists
7778 mail-self-blind))
7785 The default mail mode is now Message mode.
7786 You have the following Mail mode variable%s customized:
7788 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7795 yank-action send-actions return-action)))
7798 yank-action send-actions
7799 return-action)
7803 'switch-to-buffer-other-window yank-action send-actions
7804 return-action))
7807 yank-action send-actions
7808 return-action)
7812 'switch-to-buffer-other-frame yank-action send-actions
7813 return-action))
7815 \f
7817 "History of values entered with `set-variable'.
7819 Maximum length of the history list is determined by the value
7823 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7824 VARIABLE should be a user option variable name, a Lisp variable
7825 meant to be customized by users. You should enter VALUE in Lisp syntax,
7826 so if you want VALUE to be a string, you must surround it with doublequotes.
7827 VALUE is used literally, not evaluated.
7829 If VARIABLE has a `variable-interactive' property, that is used as if
7830 it were the arg to `interactive' (which see) to interactively read VALUE.
7832 If VARIABLE has been defined with `defcustom', then the type information
7833 in the definition is used to check that VALUE is valid.
7835 Note that this function is at heart equivalent to the basic `set' function.
7836 For a variable defined with `defcustom', it does not pay attention to
7837 any :set property that the variable might have (if you want that, use
7840 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7845 default-var)
7861 var obsolete)
7864 ;; Use VAR's `variable-interactive' property
7865 ;; as an interactive spec for prompting.
7868 arg))
7870 read-expression-map t
7871 'set-variable-value-history
7880 ;; Match with custom type.
7892 ;; Force a thorough redisplay for the case that the variable
7893 ;; has an effect on the display, like `tab-width' has.
7895 \f
7896 ;; Define the major mode for lists of completions.
7906 (define-key map [right] 'next-completion)
7908 (define-key map [backtab] 'previous-completion)
7909 (define-key map "q" 'quit-window)
7910 (define-key map "z" 'kill-current-buffer)
7911 map)
7912 "Local map for completion list buffers.")
7914 ;; Completion mode is suitable only for specially formatted data.
7915 (put 'completion-list-mode 'mode-class 'special)
7917 (defvar completion-reference-buffer nil
7918 "Record the buffer that was current when the completion list was requested.
7919 This is a local variable in the completion list buffer.
7920 Initial value is nil to avoid some compiler warnings.")
7922 (defvar completion-no-auto-exit nil
7923 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7924 This also applies to other functions such as `choose-completion'.")
7926 (defvar completion-base-position nil
7927 "Position of the base of the text corresponding to the shown completions.
7928 This variable is used in the *Completions* buffers.
7929 Its value is a list of the form (START END) where START is the place
7930 where the completion should be inserted and END (if non-nil) is the end
7931 of the text to replace. If END is nil, point is used instead.")
7933 (defvar completion-list-insert-choice-function #'completion--replace
7934 "Function to use to insert the text chosen in *Completions*.
7935 Called with three arguments (BEG END TEXT), it should replace the text
7936 between BEG and END with TEXT. Expected to be set buffer-locally
7937 in the *Completions* buffer.")
7939 (defvar completion-base-size nil
7940 "Number of chars before point not involved in completion.
7941 This is a local variable in the completion list buffer.
7942 It refers to the chars in the minibuffer if completing in the
7943 minibuffer, or in `completion-reference-buffer' otherwise.
7944 Only characters in the field at point are included.
7946 If nil, Emacs determines which part of the tail end of the
7947 buffer's text is involved in completion by comparing the text
7948 directly.")
7949 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7951 (defun delete-completion-window ()
7952 "Delete the completion list window.
7953 Go to the window from which completion was requested."
7954 (interactive)
7955 (let ((buf completion-reference-buffer))
7956 (if (one-window-p t)
7957 (if (window-dedicated-p) (delete-frame))
7958 (delete-window (selected-window))
7959 (if (get-buffer-window buf)
7960 (select-window (get-buffer-window buf))))))
7962 (defun previous-completion (n)
7963 "Move to the previous item in the completion list."
7964 (interactive "p")
7965 (next-completion (- n)))
7967 (defun next-completion (n)
7968 "Move to the next item in the completion list.
7969 With prefix argument N, move N items (negative N means move backward)."
7970 (interactive "p")
7971 (let ((beg (point-min)) (end (point-max)))
7972 (while (and (> n 0) (not (eobp)))
7973 ;; If in a completion, move to the end of it.
7974 (when (get-text-property (point) 'mouse-face)
7975 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7976 ;; Move to start of next one.
7977 (unless (get-text-property (point) 'mouse-face)
7978 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7979 (setq n (1- n)))
7980 (while (and (< n 0) (not (bobp)))
7981 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7982 ;; If in a completion, move to the start of it.
7983 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7984 (goto-char (previous-single-property-change
7985 (point) 'mouse-face nil beg)))
7986 ;; Move to end of the previous completion.
7987 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7988 (goto-char (previous-single-property-change
7989 (point) 'mouse-face nil beg)))
7990 ;; Move to the start of that one.
7991 (goto-char (previous-single-property-change
7992 (point) 'mouse-face nil beg))
7993 (setq n (1+ n))))))
7995 (defun choose-completion (&optional event)
7996 "Choose the completion at point.
7997 If EVENT, use EVENT's position to determine the starting position."
7998 (interactive (list last-nonmenu-event))
7999 ;; In case this is run via the mouse, give temporary modes such as
8000 ;; isearch a chance to turn off.
8001 (run-hooks 'mouse-leave-buffer-hook)
8002 (with-current-buffer (window-buffer (posn-window (event-start event)))
8003 (let ((buffer completion-reference-buffer)
8004 (base-size completion-base-size)
8005 (base-position completion-base-position)
8006 (insert-function completion-list-insert-choice-function)
8007 (choice
8008 (save-excursion
8009 (goto-char (posn-point (event-start event)))
8010 (let (beg end)
8011 (cond
8012 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
8013 (setq end (point) beg (1+ (point))))
8014 ((and (not (bobp))
8015 (get-text-property (1- (point)) 'mouse-face))
8016 (setq end (1- (point)) beg (point)))
8017 (t (error "No completion here")))
8018 (setq beg (previous-single-property-change beg 'mouse-face))
8019 (setq end (or (next-single-property-change end 'mouse-face)
8020 (point-max)))
8021 (buffer-substring-no-properties beg end)))))
8023 (unless (buffer-live-p buffer)
8024 (error "Destination buffer is dead"))
8025 (quit-window nil (posn-window (event-start event)))
8027 (with-current-buffer buffer
8028 (choose-completion-string
8029 choice buffer
8030 (or base-position
8031 (when base-size
8032 ;; Someone's using old completion code that doesn't know
8033 ;; about base-position yet.
8034 (list (+ base-size (field-beginning))))
8035 ;; If all else fails, just guess.
8036 (list (choose-completion-guess-base-position choice)))
8037 insert-function)))))
8039 ;; Delete the longest partial match for STRING
8040 ;; that can be found before POINT.
8041 (defun choose-completion-guess-base-position (string)
8042 (save-excursion
8043 (let ((opoint (point))
8044 len)
8045 ;; Try moving back by the length of the string.
8046 (goto-char (max (- (point) (length string))
8047 (minibuffer-prompt-end)))
8048 ;; See how far back we were actually able to move. That is the
8049 ;; upper bound on how much we can match and delete.
8050 (setq len (- opoint (point)))
8051 (if completion-ignore-case
8052 (setq string (downcase string)))
8053 (while (and (> len 0)
8054 (let ((tail (buffer-substring (point) opoint)))
8055 (if completion-ignore-case
8056 (setq tail (downcase tail)))
8057 (not (string= tail (substring string 0 len)))))
8058 (setq len (1- len))
8059 (forward-char 1))
8060 (point))))
8062 (defun choose-completion-delete-max-match (string)
8063 (declare (obsolete choose-completion-guess-base-position "23.2"))
8064 (delete-region (choose-completion-guess-base-position string) (point)))
8066 (defvar choose-completion-string-functions nil
8067 "Functions that may override the normal insertion of a completion choice.
8068 These functions are called in order with three arguments:
8069 CHOICE - the string to insert in the buffer,
8070 BUFFER - the buffer in which the choice should be inserted,
8071 BASE-POSITION - where to insert the completion.
8073 If a function in the list returns non-nil, that function is supposed
8074 to have inserted the CHOICE in the BUFFER, and possibly exited
8075 the minibuffer; no further functions will be called.
8077 If all functions in the list return nil, that means to use
8078 the default method of inserting the completion in BUFFER.")
8080 (defun choose-completion-string (choice &optional
8081 buffer base-position insert-function)
8082 "Switch to BUFFER and insert the completion choice CHOICE.
8083 BASE-POSITION says where to insert the completion.
8084 INSERT-FUNCTION says how to insert the completion and falls
8085 back on `completion-list-insert-choice-function' when nil."
8087 ;; If BUFFER is the minibuffer, exit the minibuffer
8088 ;; unless it is reading a file name and CHOICE is a directory,
8089 ;; or completion-no-auto-exit is non-nil.
8091 ;; Some older code may call us passing `base-size' instead of
8092 ;; `base-position'. It's difficult to make any use of `base-size',
8093 ;; so we just ignore it.
8094 (unless (consp base-position)
8095 (message "Obsolete `base-size' passed to choose-completion-string")
8096 (setq base-position nil))
8098 (let* ((buffer (or buffer completion-reference-buffer))
8099 (mini-p (minibufferp buffer)))
8100 ;; If BUFFER is a minibuffer, barf unless it's the currently
8101 ;; active minibuffer.
8102 (if (and mini-p
8103 (not (and (active-minibuffer-window)
8104 (equal buffer
8105 (window-buffer (active-minibuffer-window))))))
8106 (error "Minibuffer is not active for completion")
8107 ;; Set buffer so buffer-local choose-completion-string-functions works.
8108 (set-buffer buffer)
8109 (unless (run-hook-with-args-until-success
8110 'choose-completion-string-functions
8111 ;; The fourth arg used to be `mini-p' but was useless
8112 ;; (since minibufferp can be used on the `buffer' arg)
8113 ;; and indeed unused. The last used to be `base-size', so we
8114 ;; keep it to try and avoid breaking old code.
8115 choice buffer base-position nil)
8116 ;; This remove-text-properties should be unnecessary since `choice'
8117 ;; comes from buffer-substring-no-properties.
8118 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8119 ;; Insert the completion into the buffer where it was requested.
8120 (funcall (or insert-function completion-list-insert-choice-function)
8121 (or (car base-position) (point))
8122 (or (cadr base-position) (point))
8123 choice)
8124 ;; Update point in the window that BUFFER is showing in.
8125 (let ((window (get-buffer-window buffer t)))
8126 (set-window-point window (point)))
8127 ;; If completing for the minibuffer, exit it with this choice.
8128 (and (not completion-no-auto-exit)
8129 (minibufferp buffer)
8130 minibuffer-completion-table
8131 ;; If this is reading a file name, and the file name chosen
8132 ;; is a directory, don't exit the minibuffer.
8133 (let* ((result (buffer-substring (field-beginning) (point)))
8134 (bounds
8135 (completion-boundaries result minibuffer-completion-table
8136 minibuffer-completion-predicate
8137 "")))
8138 (if (eq (car bounds) (length result))
8139 ;; The completion chosen leads to a new set of completions
8140 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8141 (let ((mini (active-minibuffer-window)))
8142 (select-window mini)
8143 (when minibuffer-auto-raise
8144 (raise-frame (window-frame mini))))
8145 (exit-minibuffer))))))))
8147 (define-derived-mode completion-list-mode nil "Completion List"
8148 "Major mode for buffers showing lists of possible completions.
8150 to select the completion near point.
8151 Or click to select one with the mouse.
8154 (set (make-local-variable 'completion-base-size) nil))
8156 (defun completion-list-mode-finish ()
8157 "Finish setup of the completions buffer.
8158 Called from `temp-buffer-show-hook'."
8159 (when (eq major-mode 'completion-list-mode)
8160 (setq buffer-read-only t)))
8162 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8165 ;; Variables and faces used in `completion-setup-function'.
8167 (defcustom completion-show-help t
8168 "Non-nil means show help message in *Completions* buffer."
8169 :type 'boolean
8170 :version "22.1"
8171 :group 'completion)
8173 ;; This function goes in completion-setup-hook, so that it is called
8174 ;; after the text of the completion list buffer is written.
8175 (defun completion-setup-function ()
8176 (let* ((mainbuf (current-buffer))
8177 (base-dir
8178 ;; FIXME: This is a bad hack. We try to set the default-directory
8179 ;; in the *Completions* buffer so that the relative file names
8180 ;; displayed there can be treated as valid file names, independently
8181 ;; from the completion context. But this suffers from many problems:
8182 ;; - It's not clear when the completions are file names. With some
8183 ;; completion tables (e.g. bzr revision specs), the listed
8184 ;; completions can mix file names and other things.
8185 ;; - It doesn't pay attention to possible quoting.
8186 ;; - With fancy completion styles, the code below will not always
8187 ;; find the right base directory.
8188 (if minibuffer-completing-file-name
8189 (file-name-as-directory
8190 (expand-file-name
8191 (buffer-substring (minibuffer-prompt-end)
8192 (- (point) (or completion-base-size 0))))))))
8193 (with-current-buffer standard-output
8194 (let ((base-size completion-base-size) ;Read before killing localvars.
8195 (base-position completion-base-position)
8196 (insert-fun completion-list-insert-choice-function))
8197 (completion-list-mode)
8198 (set (make-local-variable 'completion-base-size) base-size)
8199 (set (make-local-variable 'completion-base-position) base-position)
8200 (set (make-local-variable 'completion-list-insert-choice-function)
8201 insert-fun))
8202 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8203 (if base-dir (setq default-directory base-dir))
8204 ;; Maybe insert help string.
8205 (when completion-show-help
8206 (goto-char (point-min))
8207 (if (display-mouse-p)
8209 (insert (substitute-command-keys
8213 (add-hook 'completion-setup-hook 'completion-setup-function)
8215 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8216 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8218 (defun switch-to-completions ()
8219 "Select the completion list window."
8220 (interactive)
8221 (let ((window (or (get-buffer-window "*Completions*" 0)
8222 ;; Make sure we have a completions window.
8223 (progn (minibuffer-completion-help)
8224 (get-buffer-window "*Completions*" 0)))))
8225 (when window
8226 (select-window window)
8227 ;; In the new buffer, go to the first completion.
8228 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8229 (when (bobp)
8230 (next-completion 1)))))
8231 \f
8232 ;;; Support keyboard commands to turn on various modifiers.
8234 ;; These functions -- which are not commands -- each add one modifier
8235 ;; to the following event.
8237 (defun event-apply-alt-modifier (_ignore-prompt)
8240 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8241 (defun event-apply-super-modifier (_ignore-prompt)
8244 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8245 (defun event-apply-hyper-modifier (_ignore-prompt)
8248 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8249 (defun event-apply-shift-modifier (_ignore-prompt)
8252 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8253 (defun event-apply-control-modifier (_ignore-prompt)
8256 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8257 (defun event-apply-meta-modifier (_ignore-prompt)
8260 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8262 (defun event-apply-modifier (event symbol lshiftby prefix)
8263 "Apply a modifier flag to event EVENT.
8264 SYMBOL is the name of this modifier, as a symbol.
8265 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8266 PREFIX is the string that represents this modifier in an event type symbol."
8267 (if (numberp event)
8268 (cond ((eq symbol 'control)
8269 (if (and (<= (downcase event) ?z)
8270 (>= (downcase event) ?a))
8271 (- (downcase event) ?a -1)
8272 (if (and (<= (downcase event) ?Z)
8273 (>= (downcase event) ?A))
8274 (- (downcase event) ?A -1)
8275 (logior (lsh 1 lshiftby) event))))
8276 ((eq symbol 'shift)
8277 (if (and (<= (downcase event) ?z)
8278 (>= (downcase event) ?a))
8279 (upcase event)
8280 (logior (lsh 1 lshiftby) event)))
8281 (t
8282 (logior (lsh 1 lshiftby) event)))
8283 (if (memq symbol (event-modifiers event))
8284 event
8285 (let ((event-type (if (symbolp event) event (car event))))
8286 (setq event-type (intern (concat prefix (symbol-name event-type))))
8287 (if (symbolp event)
8288 event-type
8289 (cons event-type (cdr event)))))))
8291 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8292 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8293 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8294 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8295 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8296 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8297 \f
8298 ;;;; Keypad support.
8300 ;; Make the keypad keys act like ordinary typing keys. If people add
8301 ;; bindings for the function key symbols, then those bindings will
8302 ;; override these, so this shouldn't interfere with any existing
8303 ;; bindings.
8305 ;; Also tell read-char how to handle these keys.
8306 (mapc
8307 (lambda (keypad-normal)
8308 (let ((keypad (nth 0 keypad-normal))
8309 (normal (nth 1 keypad-normal)))
8310 (put keypad 'ascii-character normal)
8311 (define-key function-key-map (vector keypad) (vector normal))))
8312 ;; See also kp-keys bound in bindings.el.
8313 '((kp-space ?\s)
8316 (kp-separator ?,)
8317 (kp-equal ?=)
8318 ;; Do the same for various keys that are represented as symbols under
8319 ;; GUIs but naturally correspond to characters.
8320 (backspace 127)
8321 (delete 127)
8324 (clear ?\C-l)
8325 (return ?\C-m)
8326 (escape ?\e)
8327 ))
8328 \f
8329 ;;;;
8330 ;;;; forking a twin copy of a buffer.
8331 ;;;;
8333 (defvar clone-buffer-hook nil
8334 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8336 (defvar clone-indirect-buffer-hook nil
8337 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8339 (defun clone-process (process &optional newname)
8340 "Create a twin copy of PROCESS.
8341 If NEWNAME is nil, it defaults to PROCESS' name;
8342 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8343 If PROCESS is associated with a buffer, the new process will be associated
8344 with the current buffer instead.
8345 Returns nil if PROCESS has already terminated."
8346 (setq newname (or newname (process-name process)))
8348 (setq newname (substring newname 0 (match-beginning 0))))
8349 (when (memq (process-status process) '(run stop open))
8350 (let* ((process-connection-type (process-tty-name process))
8351 (new-process
8352 (if (memq (process-status process) '(open))
8353 (let ((args (process-contact process t)))
8354 (setq args (plist-put args :name newname))
8355 (setq args (plist-put args :buffer
8356 (if (process-buffer process)
8357 (current-buffer))))
8358 (apply 'make-network-process args))
8359 (apply 'start-process newname
8360 (if (process-buffer process) (current-buffer))
8361 (process-command process)))))
8362 (set-process-query-on-exit-flag
8363 new-process (process-query-on-exit-flag process))
8364 (set-process-inherit-coding-system-flag
8365 new-process (process-inherit-coding-system-flag process))
8366 (set-process-filter new-process (process-filter process))
8367 (set-process-sentinel new-process (process-sentinel process))
8368 (set-process-plist new-process (copy-sequence (process-plist process)))
8369 new-process)))
8371 ;; things to maybe add (currently partly covered by `funcall mode'):
8372 ;; - syntax-table
8373 ;; - overlays
8374 (defun clone-buffer (&optional newname display-flag)
8375 "Create and return a twin copy of the current buffer.
8376 Unlike an indirect buffer, the new buffer can be edited
8377 independently of the old one (if it is not read-only).
8378 NEWNAME is the name of the new buffer. It may be modified by
8379 adding or incrementing <N> at the end as necessary to create a
8380 unique buffer name. If nil, it defaults to the name of the
8381 current buffer, with the proper suffix. If DISPLAY-FLAG is
8382 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8383 clone a file-visiting buffer, or a buffer whose major mode symbol
8384 has a non-nil `no-clone' property, results in an error.
8386 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8387 current buffer with appropriate suffix. However, if a prefix
8388 argument is given, then the command prompts for NEWNAME in the
8389 minibuffer.
8391 This runs the normal hook `clone-buffer-hook' in the new buffer
8392 after it has been set up properly in other respects."
8393 (interactive
8394 (progn
8395 (if buffer-file-name
8396 (error "Cannot clone a file-visiting buffer"))
8397 (if (get major-mode 'no-clone)
8398 (error "Cannot clone a buffer in %s mode" mode-name))
8399 (list (if current-prefix-arg
8400 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8401 t)))
8402 (if buffer-file-name
8403 (error "Cannot clone a file-visiting buffer"))
8404 (if (get major-mode 'no-clone)
8405 (error "Cannot clone a buffer in %s mode" mode-name))
8406 (setq newname (or newname (buffer-name)))
8408 (setq newname (substring newname 0 (match-beginning 0))))
8409 (let ((buf (current-buffer))
8410 (ptmin (point-min))
8411 (ptmax (point-max))
8412 (pt (point))
8413 (mk (if mark-active (mark t)))
8414 (modified (buffer-modified-p))
8415 (mode major-mode)
8416 (lvars (buffer-local-variables))
8417 (process (get-buffer-process (current-buffer)))
8418 (new (generate-new-buffer (or newname (buffer-name)))))
8419 (save-restriction
8420 (widen)
8421 (with-current-buffer new
8422 (insert-buffer-substring buf)))
8423 (with-current-buffer new
8424 (narrow-to-region ptmin ptmax)
8425 (goto-char pt)
8426 (if mk (set-mark mk))
8427 (set-buffer-modified-p modified)
8429 ;; Clone the old buffer's process, if any.
8430 (when process (clone-process process))
8432 ;; Now set up the major mode.
8433 (funcall mode)
8435 ;; Set up other local variables.
8436 (mapc (lambda (v)
8437 (condition-case () ;in case var is read-only
8438 (if (symbolp v)
8439 (makunbound v)
8440 (set (make-local-variable (car v)) (cdr v)))
8441 (error nil)))
8442 lvars)
8444 ;; Run any hooks (typically set up by the major mode
8445 ;; for cloning to work properly).
8446 (run-hooks 'clone-buffer-hook))
8447 (if display-flag
8448 ;; Presumably the current buffer is shown in the selected frame, so
8449 ;; we want to display the clone elsewhere.
8450 (let ((same-window-regexps nil)
8451 (same-window-buffer-names))
8452 (pop-to-buffer new)))
8453 new))
8456 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8457 "Create an indirect buffer that is a twin copy of the current buffer.
8459 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8460 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8461 or if not called with a prefix arg, NEWNAME defaults to the current
8462 buffer's name. The name is modified by adding a `<N>' suffix to it
8463 or by incrementing the N in an existing suffix. Trying to clone a
8464 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8465 property results in an error.
8467 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8468 This is always done when called interactively.
8470 Optional third arg NORECORD non-nil means do not put this buffer at the
8471 front of the list of recently selected ones.
8473 Returns the newly created indirect buffer."
8474 (interactive
8475 (progn
8476 (if (get major-mode 'no-clone-indirect)
8477 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8478 (list (if current-prefix-arg
8479 (read-buffer "Name of indirect buffer: " (current-buffer)))
8480 t)))
8481 (if (get major-mode 'no-clone-indirect)
8482 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8483 (setq newname (or newname (buffer-name)))
8485 (setq newname (substring newname 0 (match-beginning 0))))
8486 (let* ((name (generate-new-buffer-name newname))
8487 (buffer (make-indirect-buffer (current-buffer) name t)))
8488 (with-current-buffer buffer
8489 (run-hooks 'clone-indirect-buffer-hook))
8490 (when display-flag
8491 (pop-to-buffer buffer nil norecord))
8492 buffer))
8495 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8496 "Like `clone-indirect-buffer' but display in another window."
8497 (interactive
8498 (progn
8499 (if (get major-mode 'no-clone-indirect)
8500 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8501 (list (if current-prefix-arg
8502 (read-buffer "Name of indirect buffer: " (current-buffer)))
8503 t)))
8504 (let ((pop-up-windows t))
8505 (clone-indirect-buffer newname display-flag norecord)))
8507 \f
8508 ;;; Handling of Backspace and Delete keys.
8510 (defcustom normal-erase-is-backspace 'maybe
8511 "Set the default behavior of the Delete and Backspace keys.
8513 If set to t, Delete key deletes forward and Backspace key deletes
8514 backward.
8516 If set to nil, both Delete and Backspace keys delete backward.
8518 If set to `maybe' (which is the default), Emacs automatically
8519 selects a behavior. On window systems, the behavior depends on
8520 the keyboard used. If the keyboard has both a Backspace key and
8521 a Delete key, and both are mapped to their usual meanings, the
8522 option's default value is set to t, so that Backspace can be used
8523 to delete backward, and Delete can be used to delete forward.
8525 If not running under a window system, customizing this option
8526 accomplishes a similar effect by mapping C-h, which is usually
8527 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8528 via `keyboard-translate'. The former functionality of C-h is
8529 available on the F1 key. You should probably not use this
8530 setting if you don't have both Backspace, Delete and F1 keys.
8532 Setting this variable with setq doesn't take effect. Programmatically,
8533 call `normal-erase-is-backspace-mode' (which see) instead."
8534 :type '(choice (const :tag "Off" nil)
8535 (const :tag "Maybe" maybe)
8536 (other :tag "On" t))
8537 :group 'editing-basics
8538 :version "21.1"
8539 :set (lambda (symbol value)
8540 ;; The fboundp is because of a problem with :set when
8541 ;; dumping Emacs. It doesn't really matter.
8542 (if (fboundp 'normal-erase-is-backspace-mode)
8543 (normal-erase-is-backspace-mode (or value 0))
8544 (set-default symbol value))))
8546 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8547 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8548 (unless frame (setq frame (selected-frame)))
8549 (with-selected-frame frame
8550 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8551 (normal-erase-is-backspace-mode
8552 (if (if (eq normal-erase-is-backspace 'maybe)
8553 (and (not noninteractive)
8554 (or (memq system-type '(ms-dos windows-nt))
8555 (memq window-system '(w32 ns))
8556 (and (memq window-system '(x))
8557 (fboundp 'x-backspace-delete-keys-p)
8558 (x-backspace-delete-keys-p))
8559 ;; If the terminal Emacs is running on has erase char
8560 ;; set to ^H, use the Backspace key for deleting
8561 ;; backward, and the Delete key for deleting forward.
8562 (and (null window-system)
8563 (eq tty-erase-char ?\^H))))
8564 normal-erase-is-backspace)
8565 1 0)))))
8567 (define-minor-mode normal-erase-is-backspace-mode
8568 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8569 With a prefix argument ARG, enable this feature if ARG is
8570 positive, and disable it otherwise. If called from Lisp, enable
8571 the mode if ARG is omitted or nil.
8573 On window systems, when this mode is on, Delete is mapped to C-d
8574 and Backspace is mapped to DEL; when this mode is off, both
8575 Delete and Backspace are mapped to DEL. (The remapping goes via
8576 `local-function-key-map', so binding Delete or Backspace in the
8577 global or local keymap will override that.)
8579 In addition, on window systems, the bindings of C-Delete, M-Delete,
8580 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8581 the global keymap in accordance with the functionality of Delete and
8582 Backspace. For example, if Delete is remapped to C-d, which deletes
8583 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8584 to DEL, which deletes backward, C-Delete is bound to
8585 `backward-kill-word'.
8587 If not running on a window system, a similar effect is accomplished by
8588 remapping C-h (normally produced by the Backspace key) and DEL via
8589 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8590 to C-d; if it's off, the keys are not remapped.
8592 When not running on a window system, and this mode is turned on, the
8593 former functionality of C-h is available on the F1 key. You should
8594 probably not turn on this mode on a text-only terminal if you don't
8595 have both Backspace, Delete and F1 keys.
8597 See also `normal-erase-is-backspace'."
8598 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8599 . (lambda (v)
8600 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8601 (if v 1 0))))
8602 (let ((enabled (eq 1 (terminal-parameter
8603 nil 'normal-erase-is-backspace))))
8605 (cond ((or (memq window-system '(x w32 ns pc))
8606 (memq system-type '(ms-dos windows-nt)))
8607 (let ((bindings
8608 `(([M-delete] [M-backspace])
8609 ([C-M-delete] [C-M-backspace])
8610 ([?\e C-delete] [?\e C-backspace]))))
8612 (if enabled
8613 (progn
8614 (define-key local-function-key-map [delete] [deletechar])
8615 (define-key local-function-key-map [kp-delete] [deletechar])
8616 (define-key local-function-key-map [backspace] [?\C-?])
8617 (dolist (b bindings)
8618 ;; Not sure if input-decode-map is really right, but
8619 ;; keyboard-translate-table (used below) only works
8620 ;; for integer events, and key-translation-table is
8621 ;; global (like the global-map, used earlier).
8622 (define-key input-decode-map (car b) nil)
8623 (define-key input-decode-map (cadr b) nil)))
8624 (define-key local-function-key-map [delete] [?\C-?])
8625 (define-key local-function-key-map [kp-delete] [?\C-?])
8626 (define-key local-function-key-map [backspace] [?\C-?])
8627 (dolist (b bindings)
8628 (define-key input-decode-map (car b) (cadr b))
8629 (define-key input-decode-map (cadr b) (car b))))))
8630 (t
8631 (if enabled
8632 (progn
8633 (keyboard-translate ?\C-h ?\C-?)
8634 (keyboard-translate ?\C-? ?\C-d))
8635 (keyboard-translate ?\C-h ?\C-h)
8636 (keyboard-translate ?\C-? ?\C-?))))
8638 (if (called-interactively-p 'interactive)
8639 (message "Delete key deletes %s"
8640 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8641 "forward" "backward")))))
8642 \f
8643 (defvar vis-mode-saved-buffer-invisibility-spec nil
8644 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8646 (define-minor-mode read-only-mode
8647 "Change whether the current buffer is read-only.
8648 With prefix argument ARG, make the buffer read-only if ARG is
8649 positive, otherwise make it writable. If buffer is read-only
8650 and `view-read-only' is non-nil, enter view mode.
8652 Do not call this from a Lisp program unless you really intend to
8654 possibly enabling or disabling View mode. Also, note that this
8655 command works by setting the variable `buffer-read-only', which
8656 does not affect read-only regions caused by text properties. To
8657 ignore read-only status in a Lisp program (whether due to text
8658 properties or buffer state), bind `inhibit-read-only' temporarily
8659 to a non-nil value."
8660 :variable buffer-read-only
8661 (cond
8662 ((and (not buffer-read-only) view-mode)
8663 (View-exit-and-edit)
8664 (make-local-variable 'view-read-only)
8665 (setq view-read-only t)) ; Must leave view mode.
8666 ((and buffer-read-only view-read-only
8667 ;; If view-mode is already active, `view-mode-enter' is a nop.
8668 (not view-mode)
8669 (not (eq (get major-mode 'mode-class) 'special)))
8670 (view-mode-enter))))
8672 (define-minor-mode visible-mode
8673 "Toggle making all invisible text temporarily visible (Visible mode).
8674 With a prefix argument ARG, enable Visible mode if ARG is
8675 positive, and disable it otherwise. If called from Lisp, enable
8676 the mode if ARG is omitted or nil.
8678 This mode works by saving the value of `buffer-invisibility-spec'
8679 and setting it to nil."
8680 :lighter " Vis"
8681 :group 'editing-basics
8682 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8683 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8684 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8685 (when visible-mode
8686 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8687 buffer-invisibility-spec)
8688 (setq buffer-invisibility-spec nil)))
8689 \f
8690 (defvar messages-buffer-mode-map
8691 (let ((map (make-sparse-keymap)))
8692 (set-keymap-parent map special-mode-map)
8693 (define-key map "g" nil) ; nothing to revert
8694 map))
8696 (define-derived-mode messages-buffer-mode special-mode "Messages"
8699 (defun messages-buffer ()
8701 If it does not exist, create and it switch it to `messages-buffer-mode'."
8702 (or (get-buffer "*Messages*")
8703 (with-current-buffer (get-buffer-create "*Messages*")
8704 (messages-buffer-mode)
8705 (current-buffer))))
8707 \f
8708 ;; Minibuffer prompt stuff.
8710 ;;(defun minibuffer-prompt-modification (start end)
8711 ;; (error "You cannot modify the prompt"))
8712 ;;
8713 ;;
8714 ;;(defun minibuffer-prompt-insertion (start end)
8715 ;; (let ((inhibit-modification-hooks t))
8716 ;; (delete-region start end)
8717 ;; ;; Discard undo information for the text insertion itself
8718 ;; ;; and for the text deletion.above.
8719 ;; (when (consp buffer-undo-list)
8720 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8721 ;; (message "You cannot modify the prompt")))
8722 ;;
8723 ;;
8724 ;;(setq minibuffer-prompt-properties
8725 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8726 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8728 \f
8729 ;;;; Problematic external packages.
8731 ;; rms says this should be done by specifying symbols that define
8732 ;; versions together with bad values. This is therefore not as
8733 ;; flexible as it could be. See the thread:
8734 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8735 (defconst bad-packages-alist
8736 ;; Not sure exactly which semantic versions have problems.
8737 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8739 "The version of `semantic' loaded does not work in Emacs 22.
8740 It can cause constant high CPU load.
8741 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8742 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8743 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8744 ;; provided the `CUA-mode' feature. Since this is no longer true,
8745 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8746 (CUA-mode t nil
8747 "CUA-mode is now part of the standard GNU Emacs distribution,
8748 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8750 You have loaded an older version of CUA-mode which does not work
8751 correctly with this version of Emacs. You should remove the old
8752 version and use the one distributed with Emacs."))
8753 "Alist of packages known to cause problems in this version of Emacs.
8754 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8755 PACKAGE is either a regular expression to match file names, or a
8756 symbol (a feature name), like for `with-eval-after-load'.
8757 SYMBOL is either the name of a string variable, or t. Upon
8758 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8759 warning using STRING as the message.")
8761 (defun bad-package-check (package)
8762 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8763 (condition-case nil
8764 (let* ((list (assoc package bad-packages-alist))
8765 (symbol (nth 1 list)))
8766 (and list
8767 (boundp symbol)
8768 (or (eq symbol t)
8769 (and (stringp (setq symbol (eval symbol)))
8770 (string-match-p (nth 2 list) symbol)))
8771 (display-warning package (nth 3 list) :warning)))
8772 (error nil)))
8774 (dolist (elem bad-packages-alist)
8775 (let ((pkg (car elem)))
8776 (with-eval-after-load pkg
8777 (bad-package-check pkg))))
8779 \f
8780 ;;; Generic dispatcher commands
8782 ;; Macro `define-alternatives' is used to create generic commands.
8783 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8784 ;; that can have different alternative implementations where choosing
8785 ;; among them is exclusively a matter of user preference.
8787 ;; (define-alternatives COMMAND) creates a new interactive command
8788 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8789 ;; Typically, the user will not need to customize this variable; packages
8790 ;; wanting to add alternative implementations should use
8791 ;;
8792 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8794 (defmacro define-alternatives (command &rest customizations)
8795 "Define the new command `COMMAND'.
8797 The argument `COMMAND' should be a symbol.
8799 Running `M-x COMMAND RET' for the first time prompts for which
8800 alternative to use and records the selected command as a custom
8801 variable.
8803 Running `C-u M-x COMMAND RET' prompts again for an alternative
8804 and overwrites the previous choice.
8806 The variable `COMMAND-alternatives' contains an alist with
8807 alternative implementations of COMMAND. `define-alternatives'
8808 does not have any effect until this variable is set.
8810 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8811 `defcustom' keywords and values to add to the declaration of
8812 `COMMAND-alternatives' (typically :group and :version)."
8813 (let* ((command-name (symbol-name command))
8814 (varalt-name (concat command-name "-alternatives"))
8815 (varalt-sym (intern varalt-name))
8816 (varimp-sym (intern (concat command-name "--implementation"))))
8817 `(progn
8819 (defcustom ,varalt-sym nil
8820 ,(format "Alist of alternative implementations for the `%s' command.
8822 Each entry must be a pair (ALTNAME . ALTFUN), where:
8823 ALTNAME - The name shown at user to describe the alternative implementation.
8824 ALTFUN - The function called to implement this alternative."
8825 command-name)
8826 :type '(alist :key-type string :value-type function)
8827 ,@customizations)
8829 (put ',varalt-sym 'definition-name ',command)
8830 (defvar ,varimp-sym nil "Internal use only.")
8832 (defun ,command (&optional arg)
8833 ,(format "Run generic command `%s'.
8834 If used for the first time, or with interactive ARG, ask the user which
8835 implementation to use for `%s'. The variable `%s'
8836 contains the list of implementations currently supported for this command."
8837 command-name command-name varalt-name)
8838 (interactive "P")
8839 (when (or arg (null ,varimp-sym))
8840 (let ((val (completing-read
8841 ,(format-message
8842 "Select implementation for command `%s': "
8843 command-name)
8844 ,varalt-sym nil t)))
8845 (unless (string-equal val "")
8846 (when (null ,varimp-sym)
8847 (message
8848 "Use C-u M-x %s RET`to select another implementation"
8849 ,command-name)
8850 (sit-for 3))
8851 (customize-save-variable ',varimp-sym
8852 (cdr (assoc-string val ,varalt-sym))))))
8853 (if ,varimp-sym
8854 (call-interactively ,varimp-sym)
8855 (message "%s" ,(format-message
8856 "No implementation selected for command `%s'"
8857 command-name)))))))
8859 \f
8860 ;;; Functions for changing capitalization that Do What I Mean
8861 (defun upcase-dwim (arg)
8862 "Upcase words in the region, if active; if not, upcase word at point.
8863 If the region is active, this function calls `upcase-region'.
8864 Otherwise, it calls `upcase-word', with prefix argument passed to it
8865 to upcase ARG words."
8866 (interactive "*p")
8867 (if (use-region-p)
8868 (upcase-region (region-beginning) (region-end))
8869 (upcase-word arg)))
8871 (defun downcase-dwim (arg)
8872 "Downcase words in the region, if active; if not, downcase word at point.
8873 If the region is active, this function calls `downcase-region'.
8874 Otherwise, it calls `downcase-word', with prefix argument passed to it
8875 to downcase ARG words."
8876 (interactive "*p")
8877 (if (use-region-p)
8878 (downcase-region (region-beginning) (region-end))
8879 (downcase-word arg)))
8881 (defun capitalize-dwim (arg)
8882 "Capitalize words in the region, if active; if not, capitalize word at point.
8883 If the region is active, this function calls `capitalize-region'.
8884 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8885 to capitalize ARG words."
8886 (interactive "*p")
8887 (if (use-region-p)
8888 (capitalize-region (region-beginning) (region-end))
8889 (capitalize-word arg)))
8891 \f
8893 (provide 'simple)
8895 ;;; simple.el ends here