| blob | ed4ca91b2e5f8a6bf1bd647d99c61aa698a8a603 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2016 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "Idle time delay before updating various things on the screen.
42 Various Emacs features that update auxiliary information when point moves
43 wait this many seconds after Emacs becomes idle before doing an update."
49 "Killing and yanking commands."
53 "Highlight (un)matching of parens and expressions."
55 \f
56 ;;; next-error support framework
59 "`next-error' support framework."
65 "Face used to highlight next error locus."
70 "Highlighting of locations in selected source buffers.
71 If a number, highlight the locus in `next-error' face for the given time
72 in seconds, or until the next command is executed.
73 If t, highlight the locus until the next command is executed, or until
74 some other locus replaces it.
75 If nil, don't highlight the locus in the source buffer.
76 If `fringe-arrow', indicate the locus by the fringe arrow
77 indefinitely until some other locus replaces it."
86 "Highlighting of locations in `next-error-no-select'.
87 If number, highlight the locus in `next-error' face for given time in seconds.
88 If t, highlight the locus indefinitely until some other locus replaces it.
89 If nil, don't highlight the locus in the source buffer.
90 If `fringe-arrow', indicate the locus by the fringe arrow
91 indefinitely until some other locus replaces it."
100 "Display the line in the visited source file recentered as specified.
101 If non-nil, the value is passed directly to `recenter'."
109 "List of hook functions run by `next-error' after visiting source file."
120 "The most recent `next-error' buffer.
121 A buffer becomes most recent when its compilation, grep, or
126 "Function to use to find the next error in the current buffer.
127 The function is called with 2 parameters:
128 ARG is an integer specifying by how many errors to move.
129 RESET is a boolean which, if non-nil, says to go back to the beginning
130 of the errors before moving.
131 Major modes providing compile-like functionality should set this variable
132 to indicate to `next-error' that this is a candidate buffer and how
137 "Function to use to move to an error locus.
138 It takes two arguments, a buffer position in the error buffer
139 and a buffer position in the error locus buffer.
140 The buffer for the error locus should already be current.
145 &optional avoid-current
146 extra-test-inclusive
147 extra-test-exclusive)
148 "Test if BUFFER is a `next-error' capable buffer.
150 If AVOID-CURRENT is non-nil, treat the current buffer
151 as an absolute last resort only.
153 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
154 that normally would not qualify. If it returns t, the buffer
155 in question is treated as usable.
157 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
158 that would normally be considered usable. If it returns nil,
159 that buffer is rejected."
164 ;; Optionally reject some buffers.
167 t)
168 ;; Optionally accept some other buffers.
173 extra-test-inclusive
174 extra-test-exclusive)
175 "Return a `next-error' capable buffer.
177 If AVOID-CURRENT is non-nil, treat the current buffer
178 as an absolute last resort only.
180 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
181 that normally would not qualify. If it returns t, the buffer
182 in question is treated as usable.
184 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
185 that would normally be considered usable. If it returns nil,
186 that buffer is rejected."
188 ;; 1. If one window on the selected frame displays such buffer, return it.
194 avoid-current
195 extra-test-inclusive extra-test-exclusive)
200 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
203 extra-test-inclusive extra-test-exclusive))
204 next-error-last-buffer)
205 ;; 3. If the current buffer is acceptable, choose it.
207 extra-test-inclusive extra-test-exclusive)
209 ;; 4. Look for any acceptable buffer.
214 extra-test-inclusive extra-test-exclusive)))
217 ;; 5. Use the current buffer as a last resort if it qualifies,
218 ;; even despite AVOID-CURRENT.
221 extra-test-inclusive extra-test-exclusive)
225 ;; 6. Give up.
229 "Visit next `next-error' message and corresponding source code.
231 If all the error messages parsed so far have been processed already,
232 the message buffer is checked for new ones.
234 A prefix ARG specifies how many error messages to move;
235 negative means move back to previous error messages.
237 and start at the first error.
239 The RESET argument specifies that we should restart from the beginning.
242 compilation, grep, or occur buffer. It can also operate on any
244 more generally, on any buffer in Compilation mode or with
245 Compilation Minor mode enabled, or any buffer in which
246 `next-error-function' is bound to an appropriate function.
247 To specify use of a particular buffer for error messages, type
249 in the current frame.
252 runs `next-error-hook' with `run-hooks', and stays with that buffer
253 until you use it in some other buffer which uses Compilation mode
254 or Compilation Minor mode.
256 To control which errors are matched, customize the variable
257 `compilation-error-regexp-alist'."
261 ;; we know here that next-error-function is a valid symbol we can funcall
269 "Visit the source code corresponding to the `next-error' message at point."
271 ;; we know here that next-error-function is a valid symbol we can funcall
282 "Visit previous `next-error' message and corresponding source code.
284 Prefix arg N says how many error messages to move backwards (or
285 forwards, if negative).
292 "Restart at the first error.
293 Visit corresponding source code.
294 With prefix arg N, visit the source code of the Nth error.
300 "Move point to the next error in the `next-error' buffer and highlight match.
301 Prefix arg N says how many error messages to move forwards (or
302 backwards, if negative).
304 select the source buffer."
311 "Move point to the previous error in the `next-error' buffer and highlight match.
312 Prefix arg N says how many error messages to move backwards (or
313 forwards, if negative).
315 select the source buffer."
319 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
323 "Minor mode for compilation, occur and diff modes.
324 With a prefix argument ARG, enable mode if ARG is positive, and
325 disable it otherwise. If called from Lisp, enable mode if ARG is
326 omitted or nil.
327 When turned on, cursor motion in the compilation, grep, occur or diff
328 buffer causes automatic display of the corresponding source code location."
335 ;; Used as a `post-command-hook' by `next-error-follow-mode'
336 ;; for the *Compilation* *grep* and *Occur* buffers.
346 \f
347 ;;;
350 "Major mode not specialized for anything in particular.
351 Other major modes are defined by comparison with this one."
356 ;; Special major modes to view specially formatted data rather than files.
370 map))
374 "Parent major mode from which special major modes should inherit."
377 ;; Making and deleting lines.
380 "Special hook to tell if `self-insert-command' will use the region.
381 It must be called via `run-hook-with-args-until-success' with no arguments.
382 Any `post-self-insert-command' which consumes the region should
383 register a function on this hook so that things like `delete-selection-mode'
390 "Insert a newline, and move to left margin of the new line if it's blank.
391 If option `use-hard-newlines' is non-nil, the newline is marked with the
392 text-property `hard'.
393 With ARG, insert that many newlines.
395 If `electric-indent-mode' is enabled, this indents the final new line
396 that it adds, and reindents the preceding line. To just insert
399 Calls `auto-fill-function' if the current column number is greater
400 than the value of `fill-column' and ARG is nil.
401 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
404 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
405 ;; Set last-command-event to tell self-insert what to insert.
409 ;; Don't auto-fill if we have a numeric argument.
412 ;; Do the rest in post-self-insert-hook, because we want to do it
413 ;; *before* other functions on that hook.
416 ;; Mark the newline(s) `hard'.
420 ;; If the newline leaves the previous line blank, and we
421 ;; have a left margin, delete that from the blank line.
429 ;; Indent the line after the newline, except in one case:
430 ;; when we added the newline at the beginning of a line which
431 ;; starts a page.
436 ;; FIXME: For non-interactive uses, many calls actually just want
437 ;; (insert "\n"), so maybe we should do just that, so as to avoid
438 ;; the risk of filling or running abbrevs unexpectedly.
445 ;; We first used let-binding to protect the hook, but that was naive
446 ;; since add-hook affects the symbol-default value of the variable,
447 ;; whereas the let-binding might only protect the buffer-local value.
451 nil)
456 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
462 "Insert a newline and leave point before it.
463 If there is a fill prefix and/or a `left-margin', insert them on
464 the new line if the line would have been blank.
465 With arg N, insert N newlines."
470 ;; Don't expand an abbrev before point.
481 ;; Necessary in case a margin or prefix was inserted.
485 "Split current line, moving portion beyond point vertically down.
486 If the current line starts with `fill-prefix', insert it on the new
487 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
489 When called from Lisp code, ARG may be a prefix string to copy."
494 ;; What prefix should we check for (nil means don't).
498 ;; Does this line start with it?
509 "Join this line to previous and fix up whitespace at join.
510 If there is a fill prefix, delete it from the beginning of this line.
511 With argument, join this line to following line."
518 ;; If the second line started with the fill prefix,
519 ;; delete the prefix.
531 "On blank line, delete all surrounding blank lines, leaving just one.
532 On isolated blank line, delete that one.
533 On nonblank line, delete any immediately following blank lines."
539 ;; Set singleblank if there is just one blank line here.
546 ;; Delete preceding blank lines, and this one too if it's the only one.
555 ;; Delete following blank lines, unless the current line is blank
556 ;; and there are no following blank lines.
565 ;; Handle the special case where point is followed by newline and eob.
566 ;; Delete the line, leaving point at eob.
572 Trailing lines are deleted only if `delete-trailing-whitespace'
573 is called on the entire buffer (rather than an active region)."
579 "Delete trailing whitespace between START and END.
580 If called interactively, START and END are the start/end of the
581 region if the mark is active, or of the buffer's accessible
582 portion if the mark is inactive.
584 This command deletes whitespace characters after the last
585 non-whitespace character in each line between START and END. It
586 does not consider formfeed characters to be whitespace.
588 If this command acts on the entire buffer (i.e. if called
589 interactively with the mark inactive, or called from Lisp with
590 END nil), it also deletes all trailing lines at the end of the
591 buffer if the variable `delete-trailing-lines' is non-nil."
604 ;; Don't delete formfeeds, even if they are considered whitespace.
608 ;; Delete trailing empty lines.
611 delete-trailing-lines
612 ;; Really the end of buffer.
617 ;; Return nil for the benefit of `write-file-functions'.
618 nil)
621 "Insert a newline, then indent according to major mode.
622 Indentation is done using the value of `indent-line-function'.
623 In programming language modes, this is the same as TAB.
624 In some text modes, where TAB inserts a tab, this command indents to the
625 column specified by the function `current-left-margin'."
632 "Reindent current line, insert newline, then indent the new line.
633 Indentation of both lines is done according to the current major mode,
634 which means calling the current value of `indent-line-function'.
635 In programming language modes, this is the same as TAB.
636 In some text modes, where TAB inserts a tab, this indents to the
637 column specified by the function `current-left-margin'."
640 ;; Be careful to insert the newline before indenting the line.
641 ;; Otherwise, the indentation might be wrong.
645 ;; We are at EOL before the call to indent-according-to-mode, and
646 ;; after it we usually are as well, but not always. We tried to
647 ;; address it with `save-excursion' but that uses a normal marker
648 ;; whereas we need `move after insertion', so we do the save/restore
649 ;; by hand.
653 ;; Remove the trailing white-space after indentation because
654 ;; indentation may introduce the whitespace.
660 Legitimate radix values are 8, 10 and 16."
665 "Like `read-char', but do not allow quitting.
666 Also, if the first character read is an octal digit,
667 we read any number of octal digits and return the
668 specified character code. Any nondigit terminates the sequence.
669 If the terminator is RET, it is discarded;
670 any other terminator is used itself as input.
672 The optional argument PROMPT specifies a string to use to prompt the user.
673 The variable `read-quoted-char-radix' controls which radix to use
674 for numeric input."
677 help-event-list)))
681 ;; Don't let C-h or other help chars get the help
682 ;; message--only help function keys. See bug#16617.
686 "Type the special character you want to use,
687 or the octal character code.
688 RET terminates the character code and is discarded;
698 unread-command-events)
699 done t))
701 ;; Turn a meta-character into a character with the 0200 bit set.
703 done t))
719 unread-command-events)
720 done t))
722 done t)))
724 code))
727 "Read next input character and insert it.
728 This is useful for inserting control characters.
729 With argument, insert ARG copies of the character.
731 If the first character you type after this command is an octal digit,
732 you should type a sequence of octal digits which specify a character code.
733 Any nondigit terminates the sequence. If the terminator is a RET,
734 it is discarded; any other terminator is used itself as input.
735 The variable `read-quoted-char-radix' specifies the radix for this feature;
736 set it to 10 or 16 to use decimal or hex instead of octal.
738 In overwrite mode, this function inserts the character anyway, and
739 does not handle octal digits specially. This means that if you use
740 overwrite as your normal editing mode, you can use this function to
741 insert characters when necessary.
743 In binary overwrite mode, this function does overwrite, and octal
744 digits are interpreted as a character code. This is intended to be
745 useful for editing binary files."
748 ;; Avoid "obsolete" warnings for translation-table-for-input.
755 ;; This used to assume character codes 0240 - 0377 stand for
756 ;; characters in some single-byte character set, and converted them
757 ;; to Emacs characters. But in 23.1 this feature is deprecated
758 ;; in favor of inserting the corresponding Unicode characters.
759 ;; (if (and enable-multibyte-characters
760 ;; (>= char ?\240)
761 ;; (<= char ?\377))
762 ;; (setq char (unibyte-char-to-multibyte char)))
774 "Move forward ARG lines and position at first nonblank character."
780 "Move backward ARG lines and position at first nonblank character."
786 "Move point to the first non-whitespace character on this line."
790 ;; Move back over chars that have whitespace syntax but have the p flag.
794 "Fixup white space between objects around point.
795 Leave one space or none, according to the context."
802 nil
806 "Delete all spaces and tabs around point.
807 If BACKWARD-ONLY is non-nil, only delete them before point."
812 orig-pos
821 "Delete all spaces and tabs around point, leaving one space (or N spaces).
822 If N is negative, delete newlines as well, leaving -N spaces.
823 See also `cycle-spacing'."
828 "Store context used in consecutive calls to `cycle-spacing' command.
829 The first time `cycle-spacing' runs, it saves in this variable:
830 its N argument, the original point position, and the original spacing
834 "Manipulate whitespace around point in a smart way.
835 In interactive use, this function behaves differently in successive
836 consecutive calls.
838 The first call in a sequence acts like `just-one-space'.
839 It deletes all spaces and tabs around point, leaving one space
840 \(or N spaces). N is the prefix argument. If N is negative,
841 it deletes newlines as well, leaving -N spaces.
842 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
844 The second call in a sequence deletes all spaces.
846 The third call in a sequence restores the original whitespace (and point).
848 If MODE is `single-shot', it only performs the first step in the sequence.
849 If MODE is `fast' and the first step would not result in any change
850 \(i.e., there are exactly (abs N) spaces around point),
851 the function goes straight to the second step.
853 Repeatedly calling the function with different values of N starts a
854 new sequence each time."
862 ;; Command run for the first time, single-shot mode or different argument
874 ;; Special handling for case where there was no space at all.
877 ;; If this run causes no change in buffer content, delete all spaces,
878 ;; otherwise delete all excess spaces.
883 ;; Command run for the second time.
887 ;; Command run for the third time.
892 \f
894 "Move point to the beginning of the buffer.
895 With numeric arg N, put point N/10 of the way from the beginning.
896 If the buffer is narrowed, this command uses the beginning of the
897 accessible part of the buffer.
900 is supplied, or Transient Mark mode is enabled and the mark is active."
910 ;; Avoid overflow for large buffer sizes!
918 "Move point to the end of the buffer.
919 With numeric arg N, put point N/10 of the way from the end.
920 If the buffer is narrowed, this command uses the end of the
921 accessible part of the buffer.
924 is supplied, or Transient Mark mode is enabled and the mark is active."
932 ;; Avoid overflow for large buffer sizes!
937 ;; If we went to a place in the middle of the buffer,
938 ;; adjust it to the beginning of a line.
942 ;; If the end of the buffer is not already on the screen,
943 ;; then scroll specially to put it near, but not at, the bottom.
948 "Whether single-char deletion commands delete an active region.
949 This has an effect only if Transient Mark mode is enabled, and
950 affects `delete-forward-char' and `delete-backward-char', though
951 not `delete-char'.
953 If the value is the symbol `kill', the active region is killed
954 instead of deleted."
971 "Function to get the region's content.
972 Called with one argument DELETE.
973 If DELETE is `delete-only', then only delete the region and the return value
974 is undefined. If DELETE is nil, just return the content as a string.
975 If DELETE is `bounds', then don't delete, but just return the
976 boundaries of the region as a list of (START . END) positions.
977 If anything else, delete the region and return its content as a string,
988 first nil))))
989 "Function to insert the region's content.
990 Called with one argument LINES.
994 "Delete the previous N characters (following if N is negative).
995 If Transient Mark mode is enabled, the mark is active, and N is 1,
996 delete the text in the region and deactivate the mark instead.
997 To disable this, set option `delete-active-region' to nil.
999 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1000 kill ring) instead of delete. Interactively, N is the prefix
1001 arg, and KILLFLAG is set if N is explicitly specified.
1003 When killing, the killed text is filtered by
1004 `filter-buffer-substring' before it is saved in the kill ring, so
1005 the actual saved text might be different from what was killed.
1007 In Overwrite mode, single character backward deletion may replace
1008 tabs with spaces so as to back over columns, unless point is at
1009 the end of the line."
1015 delete-active-region
1017 ;; If a region is active, kill or delete it.
1021 ;; In Overwrite mode, maybe untabify while deleting
1031 ;; Otherwise, do simple deletion.
1035 "Delete the following N characters (previous if N is negative).
1036 If Transient Mark mode is enabled, the mark is active, and N is 1,
1037 delete the text in the region and deactivate the mark instead.
1038 To disable this, set variable `delete-active-region' to nil.
1040 Optional second arg KILLFLAG non-nil means to kill (save in kill
1041 ring) instead of delete. Interactively, N is the prefix arg, and
1042 KILLFLAG is set if N was explicitly specified.
1044 When killing, the killed text is filtered by
1045 `filter-buffer-substring' before it is saved in the kill ring, so
1046 the actual saved text might be different from what was killed."
1052 delete-active-region
1054 ;; If a region is active, kill or delete it.
1059 ;; Otherwise, do simple deletion.
1063 "Put point at beginning and mark at end of buffer.
1064 If narrowing is in effect, only uses the accessible part of the buffer.
1065 You probably should not use this function in Lisp programs;
1066 it is usually a mistake for a Lisp function to use any subroutine
1067 that uses or sets the mark."
1073 \f
1075 ;; Counting lines, one way or another.
1078 "Go to LINE, counting from line 1 at beginning of buffer.
1079 If called interactively, a numeric prefix argument specifies
1080 LINE; without a numeric prefix argument, read LINE from the
1081 minibuffer.
1083 If optional argument BUFFER is non-nil, switch to that buffer and
1085 as argument, BUFFER is the most recently selected other buffer.
1087 Prior to moving point, this function sets the mark (without
1088 activating it), unless Transient Mark mode is enabled and the
1089 mark is already active.
1091 This function is usually the wrong thing to use in a Lisp program.
1092 What you probably want instead is something like:
1093 (goto-char (point-min))
1094 (forward-line (1- N))
1095 If at all possible, an even better solution is to use char counts
1096 rather than line counts."
1101 ;; Look for a default, a number in the buffer at point.
1111 ;; Decide if we're switching buffers.
1119 ;; Read the argument, offering that number (if any) as default.
1122 buffer))))
1123 ;; Switch to the desired buffer, one way or another.
1128 ;; Leave mark at previous position
1130 ;; Move to the specified line number in that buffer.
1139 "Count the number of words in the region.
1140 If called interactively, print a message reporting the number of
1141 lines, words, and characters in the region (whether or not the
1142 region is active); with prefix ARG, report for the entire buffer
1143 rather than the region.
1145 If called from Lisp, return the number of words between positions
1146 START and END."
1158 "Count words between START and END.
1159 If called interactively, START and END are normally the start and
1160 end of the buffer; but if the region is active, START and END are
1161 the start and end of the region. Print a message reporting the
1162 number of lines, words, and chars.
1164 If called from Lisp, return the number of words between START and
1165 END, without printing any message."
1175 words))
1191 str
1199 "Print the current buffer line number and narrowed line number of point."
1212 "Return number of lines between START and END.
1213 This is usually the number of newlines between them,
1214 but can be one more if START is not equal to END
1215 and the greater of them is not at the start of a line."
1231 done)))
1235 "Return (narrowed) buffer line number at position POS.
1236 If POS is nil, use current buffer location.
1237 Counting starts at (point-min), so the value refers
1238 to the contents of the accessible portion of the buffer."
1248 "Print info on cursor position (on screen and within buffer).
1249 Also describe the character after point, and give its character code
1250 in octal, decimal and hex.
1252 For a non-ASCII multibyte character, also give its encoding in the
1253 buffer's selected coding system if the coding system encodes the
1254 character safely. If the character is encoded into one byte, that
1255 code is shown in hex. If the character is encoded into more than one
1258 In addition, with prefix argument, show details about that character
1259 in *Help* buffer. See also the command `describe-char'."
1263 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1264 ;; start a directional embedding, which could completely
1265 ;; disrupt the rest of the line (e.g., RLO will display the
1266 ;; rest of the line right-to-left). So we put an invisible
1267 ;; PDF character after these characters, to end the
1268 ;; embedding, which eliminates any effects on the rest of
1269 ;; the line. For RLE and RLO we also append an invisible
1270 ;; LRM, to avoid reordering the following numerical
1271 ;; characters. For LRI/RLI/FSI we append a PDI.
1278 ;; Strong right-to-left characters cause reordering of
1279 ;; the following numerical characters which show the
1280 ;; codepoint, so append LRM to countermand that.
1291 ""
1297 pos total percent beg end col hscroll)
1299 pos total col hscroll))
1301 encoded encoding-msg display-prop under-display)
1308 ;; Check if the character is displayed with some `display'
1309 ;; text property. In that case, set under-display to the
1310 ;; buffer substring covered by that property.
1321 under-display)))
1327 char char char under-display)
1329 char char char under-display display-prop))
1332 char char char
1334 "..."
1338 ;; We show the detailed information about CHAR.
1345 bidi-fixer
1346 encoding-msg pos total percent beg end col hscroll)
1353 bidi-fixer encoding-msg pos total percent col hscroll))))))
1354 \f
1355 ;; Initialize read-expression-map. It is defined at C level.
1359 ;; Might as well bind TAB to completion, since inserting a TAB char is
1360 ;; much too rarely useful.
1363 m))
1366 "Return a Lisp object read using the minibuffer, unevaluated.
1367 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1368 is a string to insert in the minibuffer before reading.
1369 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1370 Such arguments are used as in `read-from-minibuffer'.)"
1371 ;; Used for interactive spec `x'.
1376 "Return value of Lisp expression read using the minibuffer.
1377 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1378 is a string to insert in the minibuffer before reading.
1379 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1380 Such arguments are used as in `read-from-minibuffer'.)"
1381 ;; Used for interactive spec `X'.
1389 "The current default value or list of default values in the minibuffer.
1390 The functions `read-from-minibuffer' and `completing-read' bind
1394 "Value for `print-level' while printing value in `eval-expression'.
1395 A value of nil means no limit."
1401 "Value for `print-length' while printing value in `eval-expression'.
1402 A value of nil means no limit."
1408 "If non-nil set `debug-on-error' to t in `eval-expression'.
1409 If nil, don't change the value of `debug-on-error'."
1415 "Format VALUE as a result of evaluated expression.
1416 Return a formatted string which is displayed in the echo area
1417 in addition to the value printed by prin1 in functions which
1418 display the result of expression evaluation."
1437 ;; FIXME: call emacs-lisp-mode?
1444 read-expression-map t
1447 ;; We define this, rather than making `eval' interactive,
1448 ;; for the sake of completion of names like eval-region, eval-buffer.
1450 "Evaluate EXP and print value in the echo area.
1451 When called interactively, read an Emacs Lisp expression and evaluate it.
1452 Value is also consed on to front of the variable `values'.
1453 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1454 argument) means insert the result into the current buffer instead of
1455 printing it in the echo area.
1457 Normally, this function truncates long output according to the value
1458 of the variables `eval-expression-print-length' and
1459 `eval-expression-print-level'. With a prefix argument of zero,
1460 however, there is no such truncation. Such a prefix argument
1461 also causes integers to be printed in several additional formats
1462 \(octal, hexadecimal, and character).
1464 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1465 minibuffer.
1467 If `eval-expression-debug-on-error' is non-nil, which is the default,
1468 this command arranges for all errors to enter the debugger."
1471 current-prefix-arg))
1476 ;; Bind debug-on-error to something unique so that we can
1477 ;; detect when evalled code changes it.
1481 ;; If evalled code has changed the value of debug-on-error,
1482 ;; propagate that change to the global binding.
1487 eval-expression-print-length))
1489 eval-expression-print-level))
1505 "Prompting with PROMPT, let user edit COMMAND and eval result.
1506 COMMAND is a Lisp expression. Let user edit that expression in
1507 the minibuffer, then read and evaluate the result."
1514 read-expression-map t
1516 ;; If command was added to command-history as a string,
1517 ;; get rid of that. We want only evaluable expressions there.
1521 ;; If command to be redone does not match front of history,
1522 ;; add it to the history.
1528 "Edit and re-evaluate last complex command, or ARGth from last.
1529 A complex command is one which used the minibuffer.
1530 The command is placed in the minibuffer as a Lisp form for editing.
1531 The result is executed, repeating the command as changed.
1532 If the command has been changed or is not the most recent previous
1533 command it is added to the front of the command history.
1534 You can use the minibuffer history commands \
1536 to get different commands to edit and resubmit."
1539 newcmd)
1551 ;; If command was added to command-history as a
1552 ;; string, get rid of that. We want only
1553 ;; evaluable expressions there.
1557 ;; If command to be redone does not match front of history,
1558 ;; add it to the history.
1573 "Read command name to invoke in `execute-extended-command'."
1583 ;; Get a command name at point in the original buffer
1584 ;; to propose it after M-n.
1588 ;; Read a string, completing from and restricting to the set of
1589 ;; all defined commands. Don't provide any initial input.
1590 ;; Save the command read on the extended-command history list.
1601 ;; This isn't strictly correct if `execute-extended-command'
1602 ;; is bound to anything else (e.g. [menu]).
1603 ;; It could use (key-description (this-single-command-keys)),
1604 ;; but actually a prompt other than "M-x" would be confusing,
1605 ;; because "M-x" is a well-known prompt to read a command
1606 ;; and it serves as a shorthand for "Extended command: ".
1611 ;; Exclude obsolete commands from completions.
1616 pred)))
1621 "Non-nil means show the equivalent key-binding when M-x command has one.
1622 The value can be a length of time to show the message for.
1623 If the value is non-nil and not a number, we wait 2 seconds."
1645 binding)
1651 name len)))
1652 ;; Don't show the help message if the binding isn't
1653 ;; significantly shorter than the M-x command the user typed.
1660 binding))
1663 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1664 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1665 "Read a command name, then read the arguments and call the command.
1666 To pass a prefix argument to the command you are
1667 invoking, give a prefix argument to `execute-extended-command'."
1669 ;; FIXME: Remember the actual text typed by the user before completion,
1670 ;; so that we don't later on suggest the same shortening.
1675 execute-extended-command--last-typed)))
1676 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1689 ;; Normally `real-this-command' should never be changed, but here we really
1690 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1691 ;; binding" for <cmd>, so the command the user really wanted to run is
1692 ;; `function' and not `execute-extended-command'. The difference is
1693 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1697 ;; If enabled, show which key runs this command.
1698 ;; But first wait, and skip the message if there is input.
1700 ;; If this command displayed something in the echo area;
1701 ;; wait a few seconds, then display our suggestion message.
1702 ;; FIXME: Wait *after* running post-command-hook!
1703 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1704 ;; find a better answer anyway!
1713 ;; There's no binding for CMD. Let's try and find the shortest
1714 ;; string to use in M-x.
1715 ;; FIXME: Can be slow. Cache it maybe?
1722 function
1727 suggest-key-bindings
1731 ;; BEWARE: Called directly from the C code.
1732 "Execute CMD as an editor command.
1733 CMD must be a symbol that satisfies the `commandp' predicate.
1734 Optional second arg RECORD-FLAG non-nil
1735 means unconditionally put this command in the variable `command-history'.
1736 Otherwise, that is done only if an arg is read using the minibuffer.
1737 The argument KEYS specifies the value to use instead of (this-command-keys)
1738 when reading the arguments; if it is nil, (this-command-keys) is used.
1739 The argument SPECIAL, if non-nil, means that this command is executing
1740 a special event, so ignore the prefix argument and don't clear it."
1743 ;; FIXME: This should probably be done around
1744 ;; pre-command-hook rather than here!
1752 disabled-command-function)
1753 ;; FIXME: Weird calling convention!
1763 ;; If requested, place the macro in the command history. For
1764 ;; other sorts of commands, call-interactively takes care of this.
1767 ;; Don't keep command history around forever.
1773 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1781 \f
1783 "Default minibuffer history list.
1784 This is used for all minibuffer input
1785 except when an alternate history list is specified.
1787 Maximum length of the history list is determined by the value
1790 "Control whether history list elements are expressions or strings.
1791 If the value of this variable equals current minibuffer depth,
1792 they are expressions; otherwise they are strings.
1793 \(That convention is designed to do the right thing for
1800 "Text that was in this minibuffer before any history commands.
1801 This is nil if there have not yet been any history commands
1810 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1815 "Minibuffer history variables for which matching should ignore case.
1816 If a history variable is a member of this list, then the
1818 commands ignore case when searching it, regardless of `case-fold-search'."
1823 "Find the previous history element that matches REGEXP.
1824 \(Previous history elements refer to earlier actions.)
1825 With prefix argument N, search for Nth previous match.
1826 If N is negative, find the next or Nth next match.
1827 Normally, history elements are matched case-insensitively if
1828 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1829 makes the search case-sensitive.
1830 See also `minibuffer-history-case-insensitive-variables'."
1834 nil
1835 minibuffer-local-map
1836 nil
1837 'minibuffer-history-search-history
1839 ;; Use the last regexp specified, by default, if input is empty.
1844 regexp)
1854 ;; On some systems, ignore case for file names.
1856 minibuffer-history-case-insensitive-variables)
1857 t
1858 ;; Respect the user's setting for case-fold-search:
1859 case-fold-search)
1860 nil))
1861 prevpos
1862 match-string
1863 match-offset
1870 "No later matching history item"
1891 next-matching-history-element))
1895 "Find the next history element that matches REGEXP.
1896 \(The next history element refers to a more recent action.)
1897 With prefix argument N, search for Nth next match.
1898 If N is negative, find the previous or Nth previous match.
1899 Normally, history elements are matched case-insensitively if
1900 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1901 makes the search case-sensitive."
1905 nil
1906 minibuffer-local-map
1907 nil
1908 'minibuffer-history-search-history
1910 ;; Use the last regexp specified, by default, if input is empty.
1915 regexp)
1922 "Function run by `goto-history-element' before consuming default values.
1923 This is useful to dynamically add more elements to the list of default values
1924 when `goto-history-element' reaches the end of this list.
1925 Before calling this function `goto-history-element' sets the variable
1926 `minibuffer-default-add-done' to t, so it will call this function only
1927 once. In special cases, when this function needs to be called more
1928 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1932 "When nil, add more elements to the end of the list of default values.
1933 The value nil causes `goto-history-element' to add more elements to
1934 the list of defaults when it reaches the end of this list. It does
1940 "Return a list of all completions without the default value.
1941 This function is used to add all elements of the completion table to
1942 the end of the list of defaults just after the default value."
1945 minibuffer-completion-table
1946 minibuffer-completion-predicate)))
1952 "Puts element of the minibuffer history in the minibuffer.
1953 The argument NABS specifies the absolute history position."
1967 elt minibuffer-returned-to-present)
1974 "End of defaults; no next item"
1981 previous-history-element))
1993 minibuffer-default)))
2005 elt))
2009 "Puts next element of the minibuffer history in the minibuffer.
2010 With argument N, it uses the Nth following element."
2016 "Puts previous element of the minibuffer history in the minibuffer.
2017 With argument N, it uses the Nth previous element."
2023 "Move cursor vertically down ARG lines, or to the next history element.
2024 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2025 next element of the minibuffer history in the minibuffer."
2029 ;; Remember the original goal column of possibly multi-line input
2030 ;; excluding the length of the prompt on the first line.
2040 ;; Restore old position since `line-move-visual' moves point to
2041 ;; the end of the line when it fails to go to the next line.
2044 ;; Restore the original goal column on the last line
2045 ;; of possibly multi-line input.
2053 "Move cursor vertically up ARG lines, or to the previous history element.
2054 When point moves over the top line of multi-line minibuffer, puts ARGth
2055 previous element of the minibuffer history in the minibuffer."
2059 ;; Remember the original goal column of possibly multi-line input
2060 ;; excluding the length of the prompt on the first line.
2070 ;; Restore old position since `line-move-visual' moves point to
2071 ;; the beginning of the line when it fails to go to the previous line.
2074 ;; Restore the original goal column on the first line
2075 ;; of possibly multi-line input.
2084 "Get next history element which completes the minibuffer before the point.
2085 The contents of the minibuffer after the point are deleted, and replaced
2086 by the new completion."
2092 n)
2093 ;; next-matching-history-element always puts us at (point-min).
2094 ;; Move to the position we were at before changing the buffer contents.
2095 ;; This is still sensible, because the text before point has not changed.
2099 "\
2100 Get previous history element which completes the minibuffer before the point.
2101 The contents of the minibuffer after the point are deleted, and replaced
2102 by the new completion."
2106 ;; For compatibility with the old subr of the same name.
2108 "Return the display width of the minibuffer prompt.
2109 Return 0 if current buffer is not a minibuffer."
2110 ;; Return the width of everything before the field at the end of
2111 ;; the buffer; this should be 0 for normal buffers.
2113 \f
2114 ;; isearch minibuffer history
2121 "Set up a minibuffer for using isearch to search the minibuffer history.
2122 Intended to be added to `minibuffer-setup-hook'."
2134 "Clean up the minibuffer after terminating isearch in the minibuffer."
2139 "Return the proper search function, for isearch in minibuffer history."
2142 ;; Use standard functions to search within minibuffer text
2144 found)
2145 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2146 ;; searching forward. Lazy-highlight calls this lambda with the
2147 ;; bound arg, so skip the minibuffer prompt.
2151 ;; 1. First try searching in the initial minibuffer text
2154 noerror)
2155 ;; 2. If the above search fails, start putting next/prev history
2156 ;; elements in the minibuffer successively, and search the string
2157 ;; in them. Do this only when bound is nil (i.e. not while
2158 ;; lazy-highlighting search strings in the current minibuffer text).
2170 ;; After putting the next/prev history element, search
2171 ;; the string in them again, until next-history-element
2172 ;; or previous-history-element raises an error at the
2173 ;; beginning/end of history.
2176 ;; For backward search, don't search
2177 ;; in the minibuffer prompt
2179 noerror)))
2180 ;; Return point of the new search result
2182 ;; Return nil when next(prev)-history-element fails
2186 "Display the minibuffer history search prompt.
2187 If there are no search errors, this function displays an overlay with
2188 the isearch prompt which replaces the original minibuffer prompt.
2189 Otherwise, it displays the standard isearch message returned from
2190 the function `isearch-message'."
2192 ;; Use standard function `isearch-message' when not in the minibuffer,
2193 ;; or search fails, or has an error (like incomplete regexp).
2194 ;; This function overwrites minibuffer text with isearch message,
2195 ;; so it's possible to see what is wrong in the search string.
2197 ;; Otherwise, put the overlay with the standard isearch prompt over
2198 ;; the initial minibuffer prompt.
2207 ;; And clear any previous isearch message.
2211 "Wrap the minibuffer history search when search fails.
2212 Move point to the first history element for a forward search,
2213 or to the last history element for a backward search."
2214 ;; When `minibuffer-history-isearch-search' fails on reaching the
2215 ;; beginning/end of the history, wrap the search to the first/last
2216 ;; minibuffer history element.
2224 "Save a function restoring the state of minibuffer history search.
2225 Save `minibuffer-history-position' to the additional state parameter
2226 in the search status stack."
2232 "Restore the minibuffer history search state.
2233 Go to the history element by the absolute history position HIST-POS."
2236 \f
2237 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2241 "Table mapping redo records to the corresponding undo one.
2242 A redo record for undo-in-region maps to t.
2252 "Within a run of consecutive undo commands, list remaining to be undone.
2256 "Undo some previous changes.
2257 Repeat this command to undo more changes.
2258 A numeric ARG serves as a repeat count.
2260 In Transient Mark mode when the mark is active, only undo changes within
2262 as an argument limits undo to changes within the current region."
2264 ;; Make last-command indicate for the next command that this was an undo.
2265 ;; That way, another undo will undo more.
2266 ;; If we get to the end of the undo history and get an error,
2267 ;; another undo command will find the undo history empty
2268 ;; and will get another error. To begin undoing the undos,
2269 ;; you must type some other command.
2271 ;; For an indirect buffer, look in the base buffer for the
2272 ;; auto-save data.
2276 message)
2277 ;; If we get an error in undo-start,
2278 ;; the next command should not be a "consecutive undo".
2279 ;; So set `this-command' to something other than `undo'.
2284 ;; If something (a timer or filter?) changed the buffer
2285 ;; since the previous command, don't continue the undo seq.
2289 ;; If the last undo record made was made by undo
2290 ;; it shows nothing else happened in between.
2297 ;; get rid of initial undo boundary
2299 ;; If we got this far, the next command should be a consecutive undo.
2301 ;; Check to see whether we're hitting a redo record, and if
2302 ;; so, ask the user whether she wants to skip the redo/undo pair.
2310 ;; The equiv entry might point to another redo record if we have done
2311 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2319 ;; Record the fact that the just-generated undo records come from an
2320 ;; undo operation--that is, they are redo records.
2321 ;; In the ordinary case (not within a region), map the redo
2322 ;; record to the following undos.
2323 ;; I don't know how to do that in the undo-in-region case.
2325 ;; Strip any leading undo boundaries there might be, like we do
2326 ;; above when checking.
2330 ;; Prevent identity mapping. This can happen if
2331 ;; consecutive nils are erroneously in undo list.
2333 t
2334 pending-undo-list)
2335 undo-equiv-table))
2336 ;; Don't specify a position in the undo record for the undo command.
2337 ;; Instead, undoing this should move point to where the change is.
2356 ;; Record what the current undo list says,
2357 ;; so the next command can tell if the buffer was modified in between.
2361 ;; Display a message announcing success.
2366 "Make BUFFER stop keeping undo information.
2367 No argument or nil as argument means do this for the current buffer."
2373 "Undo some previous changes.
2374 Repeat this command to undo more changes.
2375 A numeric ARG serves as a repeat count.
2376 Contrary to `undo', this will not redo a previous undo."
2381 "Non-nil while performing an undo.
2385 "Undo back N undo-boundaries beyond what was already undone recently.
2386 Call `undo-start' to get ready to undo recent changes,
2387 then call `undo-more' one or more times to undo them."
2392 ;; Note: The following, while pulling elements off
2393 ;; `pending-undo-list' will call primitive change functions which
2394 ;; will push more elements onto `buffer-undo-list'.
2400 "Undo N records from the front of the list LIST.
2401 Return what remains of the list."
2403 ;; This is a good feature, but would make undo-start
2404 ;; unable to do what is expected.
2405 ;;(when (null (car (list)))
2406 ;; ;; If the head of the list is a boundary, it is the boundary
2407 ;; ;; preceding this command. Get rid of it and don't count it.
2408 ;; (setq list (cdr list))))
2411 ;; In a writable buffer, enable undoing read-only text that is
2412 ;; so because of text properties.
2414 ;; Don't let `intangible' properties interfere with undo.
2416 ;; We use oldlist only to check for EQ. ++kfs
2422 ;; Handle an integer by setting point to that value.
2425 ;; Element (t . TIME) records previous modtime.
2426 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2427 ;; UNKNOWN_MODTIME_NSECS.
2429 ;; If this records an obsolete save
2430 ;; (not matching the actual disk file)
2431 ;; then don't mark unmodified.
2439 ;; Element (nil PROP VAL BEG . END) is property change.
2444 ;; Element (BEG . END) means range was inserted.
2446 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2447 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2450 ;; Set point first thing, so that undoing this undo
2451 ;; does not send point back to where it is now.
2454 ;; Element (apply FUN . ARGS) means call FUN to undo.
2458 ;; Long format: (apply DELTA START END FUN . ARGS).
2465 ;; Check that the function did what the entry
2466 ;; said it would do.
2476 ;; Element (STRING . POS) means STRING was deleted.
2482 ;; Check that marker adjustments which were recorded
2483 ;; with the (STRING . POS) record are still valid, ie
2484 ;; the markers haven't moved. We check their validity
2485 ;; before reinserting the string so as we don't need to
2486 ;; mind marker insertion-type.
2494 ;; Insert string and adjust point
2502 ;; Adjust the valid marker adjustments
2506 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2509 next)
2510 ;; Even though these elements are not expected in the undo
2511 ;; list, adjust them to be conservative for the 24.4
2512 ;; release. (Bug#16818)
2519 ;; Make sure an apply entry produces at least one undo entry,
2520 ;; so the test in `undo' for continuing an undo series
2521 ;; will work right.
2526 list)
2528 ;; Deep copy of a list
2530 "Make a copy of undo list LIST."
2536 elt))
2539 "Set `pending-undo-list' to the front of the undo list.
2540 The next call to `undo-more' will undo the most recently made change.
2541 If BEG and END are specified, then only undo elements
2542 that apply to text between BEG and END are used; other undo elements
2543 are ignored. If BEG and END are nil, all undo elements are used."
2549 buffer-undo-list)))
2551 ;; The positions given in elements of the undo list are the positions
2552 ;; as of the time that element was recorded to undo history. In
2553 ;; general, subsequent buffer edits render those positions invalid in
2554 ;; the current buffer, unless adjusted according to the intervening
2555 ;; undo elements.
2556 ;;
2557 ;; Undo in region is a use case that requires adjustments to undo
2558 ;; elements. It must adjust positions of elements in the region based
2559 ;; on newer elements not in the region so as they may be correctly
2560 ;; applied in the current buffer. undo-make-selective-list
2561 ;; accomplishes this with its undo-deltas list of adjustments. An
2562 ;; example undo history from oldest to newest:
2563 ;;
2564 ;; buf pos:
2565 ;; 123456789 buffer-undo-list undo-deltas
2566 ;; --------- ---------------- -----------
2567 ;; aaa (1 . 4) (1 . -3)
2568 ;; aaba (3 . 4) N/A (in region)
2569 ;; ccaaba (1 . 3) (1 . -2)
2570 ;; ccaabaddd (7 . 10) (7 . -3)
2571 ;; ccaabdd ("ad" . 6) (6 . 2)
2572 ;; ccaabaddd (6 . 8) (6 . -2)
2573 ;; | |<-- region: "caab", from 2 to 6
2574 ;;
2575 ;; When the user starts a run of undos in region,
2576 ;; undo-make-selective-list is called to create the full list of in
2577 ;; region elements. Each element is adjusted forward chronologically
2578 ;; through undo-deltas to determine if it is in the region.
2579 ;;
2580 ;; In the above example, the insertion of "b" is (3 . 4) in the
2581 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2582 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2583 ;; . 6) is assessed as in the region and placed in the selective list.
2584 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2585 ;; due to the selected element. The "b" insertion is the only element
2586 ;; fully in the region, so in this example undo-make-selective-list
2587 ;; returns (nil (5 . 6)).
2588 ;;
2589 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2590 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2591 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2592 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2593 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2594 ;;
2595 ;; More interesting is how to adjust the "ddd" insertion due to the
2596 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2597 ;; If the reinsertion was a manual retyping of "ad", then the total
2598 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2599 ;; the reinsertion was due to undo, one might expect the first "d"
2600 ;; character would again be a part of the "ddd" text, meaning its
2601 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2602 ;;
2603 ;; undo-make-selective-list assumes in this situation that "ad" was a
2604 ;; new edit, even if it was inserted because of an undo.
2605 ;; Consequently, if the user undos in region "8 to 10" of the
2606 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2607 ;; "ccaabad", as though the first "d" became detached from the
2608 ;; original "ddd" insertion. This quirk is a FIXME.
2611 "Return a list of undo elements for the region START to END.
2612 The elements come from `buffer-undo-list', but we keep only the
2613 elements inside this region, and discard those outside this
2614 region. The elements' positions are adjusted so as the returned
2615 list can be applied to the current buffer."
2617 ;; A list of position adjusted undo elements in the region.
2619 ;; A list of undo-deltas for out of region undo elements.
2620 undo-deltas
2621 undo-elt)
2629 ;; Don't put two nils together in the list
2633 ;; This is a "was unmodified" element. Keep it
2634 ;; if we have kept everything thus far.
2637 ;; Skip over marker adjustments, instead relying
2638 ;; on finding them after (TEXT . POS) elements
2640 nil)
2643 undo-deltas)))
2648 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2649 ;; kept. primitive-undo may discard them later.
2662 "Determine whether UNDO-ELT falls inside the region START ... END.
2663 If it crosses the edge, we return nil.
2665 Generally this function is not useful for determining
2666 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2667 because markers can be arbitrarily relocated. Instead, pass the
2668 marker adjustment's corresponding (TEXT . POS) element."
2673 t)
2675 nil)
2677 ;; (TEXT . POSITION)
2681 ;; (MARKER . ADJUSTMENT)
2684 ;; (nil PROPERTY VALUE BEG . END)
2689 ;; (BEGIN . END)
2694 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2695 This assumes we have already decided that UNDO-ELT
2696 is not *inside* the region START...END."
2700 ;; (nil PROPERTY VALUE BEG . END)
2705 ;; (BEGIN . END)
2710 "Return adjustment of undo element ELT by the undo DELTAS
2711 list."
2713 ;; POSITION
2716 ;; (BEG . END)
2719 ;; (TEXT . POSITION)
2723 ;; (nil PROPERTY VALUE BEG . END)
2726 ;; (apply DELTA START END FUN . ARGS)
2727 ;; FIXME
2728 ;; All others return same elt
2731 ;; (BEG . END) can adjust to the same positions, commonly when an
2732 ;; insertion was undone and they are out of region, for example:
2733 ;;
2734 ;; buf pos:
2735 ;; 123456789 buffer-undo-list undo-deltas
2736 ;; --------- ---------------- -----------
2737 ;; [...]
2738 ;; abbaa (2 . 4) (2 . -2)
2739 ;; aaa ("bb" . 2) (2 . 2)
2740 ;; [...]
2741 ;;
2742 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2743 ;; undo. Further adjustments to such an element should be the same as
2744 ;; for (TEXT . POSITION) elements. The options are:
2745 ;;
2746 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2747 ;; analogous to marker insertion-type t.
2748 ;;
2749 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2750 ;; marker insertion-type nil.
2751 ;;
2752 ;; There was no strong reason to prefer one or the other, except that
2753 ;; the first is more consistent with prior undo in region behavior.
2755 "Return cons of adjustments to BEG and END by the undo DELTAS
2756 list."
2758 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2763 "Return adjustment of POS by the undo DELTAS list, comparing
2764 with < or <= based on USE-<."
2770 ;; Don't allow pos to become less than the undo-delta
2771 ;; position. This edge case is described in the overview
2772 ;; comments.
2775 ;; Return the first affected buffer position and the delta for an undo element
2776 ;; delta is defined as the change in subsequent buffer positions if we *did*
2777 ;; the undo.
2781 ;; (TEXT . POSITION)
2784 ;; (BEGIN . END)
2790 ;;; Default undo-boundary addition
2791 ;;
2792 ;; This section adds a new undo-boundary at either after a command is
2793 ;; called or in some cases on a timer called after a change is made in
2794 ;; any buffer.
2796 "Describe the cause of the last undo-boundary.
2798 If `explicit', the last boundary was caused by an explicit call to
2799 `undo-boundary', that is one not called by the code in this
2800 section.
2802 If it is equal to `timer', then the last boundary was inserted
2803 by `undo-auto--boundary-timer'.
2805 If it is equal to `command', then the last boundary was inserted
2806 automatically after a command, that is by the code defined in
2807 this section.
2809 If it is equal to a list, then the last boundary was inserted by
2810 an amalgamating command. The car of the list is the number of
2811 times an amalgamating command has been called, and the cdr are the
2815 "Current timer which will run `undo-auto--boundary-timer' or nil.
2820 "Non-nil if `this-command' should be amalgamated.
2821 This variable is set to nil by `undo-auto--boundaries' and is set
2825 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2829 "Return the number of amalgamating last commands or nil.
2830 Amalgamating commands are, by default, either
2831 `self-insert-command' and `delete-char', but can be any command
2832 that calls `undo-auto-amalgamate'."
2836 "Add an `undo-boundary' to the current buffer if needed.
2837 REASON describes the reason that the boundary is being added; see
2838 `undo-auto--last-boundary' for more information."
2848 undo-auto--undoably-changed-buffers)
2849 cause)))))
2852 "Check recently changed buffers and add a boundary if necessary.
2853 REASON describes the reason that the boundary is being added; see
2854 `undo-last-boundary' for more information."
2862 "Timer which will run `undo--auto-boundary-timer'."
2867 "Ensure that the `undo-auto-boundary-timer' is set."
2873 "List of buffers that have changed recently.
2875 This list is maintained by `undo-auto--undoable-change' and
2876 `undo-auto--boundaries' and can be affected by changes to their
2877 default values.
2882 "Add an `undo-boundary' in appropriate buffers."
2887 'amalgamate
2891 "Amalgamate undo if necessary.
2892 This function can be called before an amalgamating command. It
2893 removes the previous `undo-boundary' if a series of such calls
2894 have been made. By default `self-insert-command' and
2895 `delete-char' are the only amalgamating commands, although this
2896 function could be called by any command wishing to have this
2897 behaviour."
2902 last-amalgamating-count
2907 ;; Amalgamate all buffers that have changed.
2911 b
2913 ;; The head of `buffer-undo-list' is nil.
2914 ;; `car-safe' doesn't work because
2915 ;; `buffer-undo-list' need not be a list!
2923 "Called after every undoable buffer change."
2926 ;; End auto-boundary section
2929 "If non-nil ask about discarding undo info for the current command.
2930 Normally, Emacs discards the undo info for the current command if
2931 it exceeds `undo-outer-limit'. But if you set this option
2932 non-nil, it asks in the echo area whether to discard the info.
2933 If you answer no, there is a slight risk that Emacs might crash, so
2934 only do it if you really want to undo the command.
2936 This option is mainly intended for debugging. You have to be
2937 careful if you use it for other purposes. Garbage collection is
2938 inhibited while the question is asked, meaning that Emacs might
2939 leak memory. So you should make sure that you do not wait
2940 excessively long before answering the question."
2946 "If non-nil, an extra level of size that's ok in an undo item.
2947 We don't ask the user about truncating the undo list until the
2948 current item gets bigger than this amount.
2953 ;; When the first undo batch in an undo list is longer than
2954 ;; undo-outer-limit, this function gets called to warn the user that
2955 ;; the undo info for the current command was discarded. Garbage
2956 ;; collection is inhibited around the call, so it had better not do a
2957 ;; lot of consing.
2963 ;; Don't ask the question again unless it gets even bigger.
2964 ;; This applies, in particular, if the user quits from the question.
2965 ;; Such a quit quits out of GC, but something else will call GC
2966 ;; again momentarily. It will call this function again,
2967 ;; but we don't want to ask the question again.
2971 "Buffer `%s' undo info is %d bytes long; discard it? "
2975 t)
2976 nil))
2982 "The undo info was discarded because it exceeded \
2983 `undo-outer-limit'.
2985 This is normal if you executed a command that made a huge change
2986 to the buffer. In that case, to prevent similar problems in the
2987 future, set `undo-outer-limit' to a value that is large enough to
2988 cover the maximum size of normal changes you expect a single
2989 command to make, but not so large that it might exceed the
2990 maximum memory allotted to Emacs.
2992 If you did not execute any such command, the situation is
2993 probably due to a bug and you should report it.
2995 You can disable the popping up of this buffer by adding the entry
2996 \(undo discard-info) to the user option `warning-suppress-types',
3000 t))
3001 \f
3004 ; These are sorted according to the GNU en_US locale.
3047 )
3049 This is used by Shell mode and other parts of Emacs to recognize
3050 password prompts, including prompts in languages other than
3051 English. Different case choices should not be assumed to be
3052 included; callers should bind `case-fold-search' to t."
3058 "History list for some commands that read shell commands.
3060 Maximum length of the history list is determined by the value
3067 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3068 This buffer is used when `shell-command' or `shell-command-on-region'
3069 is run interactively. A value of nil means that output to stderr and
3076 "Return a list of all commands associated with the current file.
3077 This function is used to add all related commands retrieved by `mailcap'
3078 to the end of the list of defaults just after the default value."
3082 minibuffer-default))
3087 commands))
3098 map)
3102 "Read a shell command from the minibuffer.
3103 The arguments are the same as the ones of `read-from-minibuffer',
3104 except READ and KEYMAP are missing and HIST defaults
3105 to `shell-command-history'."
3113 minibuffer-local-shell-command-map
3114 nil
3116 args)))
3119 "What to do when the output buffer is used by another shell command.
3120 This option specifies how to resolve the conflict where a new command
3121 wants to direct its output to the buffer `*Async Shell Command*',
3122 but this buffer is already taken by another running shell command.
3124 The value `confirm-kill-process' is used to ask for confirmation before
3125 killing the already running process and running a new process
3126 in the same buffer, `confirm-new-buffer' for confirmation before running
3127 the command in a new buffer with a name other than the default buffer name,
3128 `new-buffer' for doing the same without confirmation,
3129 `confirm-rename-buffer' for confirmation before renaming the existing
3130 output buffer and running a new command in the default buffer,
3131 `rename-buffer' for doing the same without confirmation."
3133 confirm-kill-process)
3135 confirm-new-buffer)
3137 new-buffer)
3139 confirm-rename-buffer)
3141 rename-buffer))
3146 "Execute string COMMAND asynchronously in background.
3148 Like `shell-command', but adds `&' at the end of COMMAND
3149 to execute it asynchronously.
3151 The output appears in the buffer `*Async Shell Command*'.
3152 That buffer is in shell mode.
3154 You can configure `async-shell-command-buffer' to specify what to do in
3155 case when `*Async Shell Command*' buffer is already taken by another
3156 running shell command. To run COMMAND without displaying the output
3157 in a window you can configure `display-buffer-alist' to use the action
3158 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3160 In Elisp, you will often be better served by calling `start-process'
3161 directly, since it offers more control and does not impose the use of a
3162 shell (with its need to quote arguments)."
3172 current-prefix-arg
3173 shell-command-default-error-buffer))
3179 "Execute string COMMAND in inferior shell; display output, if any.
3180 With prefix argument, insert the COMMAND's output at point.
3182 If COMMAND ends in `&', execute it asynchronously.
3183 The output appears in the buffer `*Async Shell Command*'.
3184 That buffer is in shell mode. You can also use
3185 `async-shell-command' that automatically adds `&'.
3187 Otherwise, COMMAND is executed synchronously. The output appears in
3188 the buffer `*Shell Command Output*'. If the output is short enough to
3189 display in the echo area (which is determined by the variables
3190 `resize-mini-windows' and `max-mini-window-height'), it is shown
3191 there, but it is nonetheless available in buffer `*Shell Command
3192 Output*' even though that buffer is not automatically displayed.
3194 To specify a coding system for converting non-ASCII characters
3196 before this command.
3198 Noninteractive callers can specify coding systems by binding
3199 `coding-system-for-read' and `coding-system-for-write'.
3201 The optional second argument OUTPUT-BUFFER, if non-nil,
3202 says to put the output in some other buffer.
3203 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
3204 If OUTPUT-BUFFER is not a buffer and not nil,
3205 insert output in current buffer. (This cannot be done asynchronously.)
3206 In either case, the buffer is first erased, and the output is
3207 inserted after point (leaving mark after it).
3209 If the command terminates without error, but generates output,
3211 the output can be displayed in the echo area or in its buffer.
3212 If the output is short enough to display in the echo area
3213 \(determined by the variable `max-mini-window-height' if
3214 `resize-mini-windows' is non-nil), it is shown there.
3215 Otherwise,the buffer containing the output is displayed.
3219 of the output.
3221 If there is no output, or if output is inserted in the current buffer,
3222 then `*Shell Command Output*' is deleted.
3224 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3225 or buffer name to which to direct the command's standard error output.
3226 If it is nil, error output is mingled with regular output.
3227 In an interactive call, the variable `shell-command-default-error-buffer'
3228 specifies the value of ERROR-BUFFER.
3230 In Elisp, you will often be better served by calling `call-process' or
3231 `start-process' directly, since it offers more control and does not impose
3232 the use of a shell (with its need to quote arguments)."
3243 current-prefix-arg
3244 shell-command-default-error-buffer))
3245 ;; Look for a handler in case default-directory is a remote file name.
3253 ;; Output goes in current buffer.
3259 temporary-file-directory)))
3260 nil)))
3263 ;; We do not use -f for csh; we will not support broken use of
3264 ;; .cshrcs. Even the BSD csh manual says to use
3265 ;; "if ($?prompt) exit" before things which are not useful
3266 ;; non-interactively. Besides, if someone wants their other
3267 ;; aliases for shell commands then they can still have them.
3271 t)
3272 nil shell-command-switch command)
3279 ;; Do no formatting while reading error file,
3280 ;; because that can run a shell command, and we
3281 ;; don't want that to cause an infinite recursion.
3283 ;; Put point after the inserted errors.
3287 ;; This is like exchange-point-and-mark, but doesn't
3288 ;; activate the mark. It is cleaner to avoid activation,
3289 ;; even though the command loop would deactivate the mark
3290 ;; because we inserted text.
3294 ;; Output goes in a separate buffer.
3295 ;; Preserve the match data in case called from a program.
3298 ;; Command ending with ampersand means asynchronous.
3302 proc)
3303 ;; Remove the ampersand.
3305 ;; Ask the user what to do with already running process.
3310 ;; If will kill a process, query first.
3315 ;; If will create a new buffer, query first.
3322 ;; It will create a new buffer.
3327 ;; If will rename the buffer, query first.
3336 ;; It will rename the buffer.
3343 ;; Setting buffer-read-only to nil doesn't suffice
3344 ;; if some text has a non-nil read-only property,
3345 ;; which comint sometimes adds for prompts.
3351 shell-command-switch command))
3355 ;; Use the comint filter for proper handling of carriage motion
3356 ;; (see `comint-inhibit-carriage-motion'),.
3358 ))
3359 ;; Otherwise, command is executed synchronously.
3361 output-buffer nil error-buffer)))))))
3364 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3365 MESSAGE may be either a string or a buffer.
3367 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3368 for maximum height of the echo area, as defined by `max-mini-window-height'
3369 if `resize-mini-windows' is non-nil.
3371 Returns either the string shown in the echo area, or when a pop-up
3372 buffer is used, the window used to display it.
3374 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3375 name of the buffer used to display it in the case where a pop-up buffer
3376 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3377 string and it is displayed in the echo area, it is not specified whether
3378 the contents are inserted into the buffer anyway.
3380 Optional arguments ACTION and FRAME are as for `display-buffer',
3381 and are only used if a pop-up buffer is displayed."
3383 ;; Trivial case where we can use the echo area
3387 ;; Trivial case where we can just remove single trailing newline
3390 ;; General case
3393 message
3402 0
3406 (<= lines
3410 max-mini-window-height))
3412 max-mini-window-height)
3416 ;; Don't use the echo area if the output buffer is
3417 ;; already displayed in the selected frame.
3419 ;; Echo area
3425 ;; Buffer
3430 ;; We have a sentinel to prevent insertion of a termination message
3431 ;; in the buffer itself.
3439 &optional output-buffer replace
3440 error-buffer display-error-buffer
3441 region-noncontiguous-p)
3442 "Execute string COMMAND in inferior shell with region as input.
3443 Normally display output (if any) in temp buffer `*Shell Command Output*';
3444 Prefix arg means replace the region with it. Return the exit code of
3445 COMMAND.
3447 To specify a coding system for converting non-ASCII characters
3449 before this command. By default, the input (from the current buffer)
3450 is encoded using coding-system specified by `process-coding-system-alist',
3451 falling back to `default-process-coding-system' if no match for COMMAND
3452 is found in `process-coding-system-alist'.
3454 Noninteractive callers can specify coding systems by binding
3455 `coding-system-for-read' and `coding-system-for-write'.
3457 If the command generates output, the output may be displayed
3458 in the echo area or in a buffer.
3459 If the output is short enough to display in the echo area
3460 \(determined by the variable `max-mini-window-height' if
3461 `resize-mini-windows' is non-nil), it is shown there.
3462 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3463 The output is available in that buffer in both cases.
3465 If there is output and an error, a message about the error
3466 appears at the end of the output. If there is no output, or if
3467 output is inserted in the current buffer, the buffer `*Shell
3468 Command Output*' is deleted.
3470 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3471 command's output. If the value is a buffer or buffer name,
3472 put the output there. If the value is nil, use the buffer
3473 `*Shell Command Output*'. Any other value, excluding nil,
3474 means to insert the output in the current buffer. In either case,
3475 the output is inserted after point (leaving mark after it).
3477 Optional fifth arg REPLACE, if non-nil, means to insert the
3478 output in place of text from START to END, putting point and mark
3479 around it.
3481 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3482 or buffer name to which to direct the command's standard error
3483 output. If nil, error output is mingled with regular output.
3484 When called interactively, `shell-command-default-error-buffer'
3485 is used for ERROR-BUFFER.
3487 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3488 display the error buffer if there were any errors. When called
3489 interactively, this is t."
3493 ;; Do this before calling region-beginning
3494 ;; and region-end, in case subprocess output
3495 ;; relocates them while we are in the minibuffer.
3497 ;; call-interactively recognizes region-beginning and
3498 ;; region-end specially, leaving them in the history.
3500 string
3501 current-prefix-arg
3502 current-prefix-arg
3503 shell-command-default-error-buffer
3504 t
3511 temporary-file-directory)))
3512 nil))
3513 exit-status)
3514 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3517 output)
3521 shell-file-name t t
3522 nil shell-command-switch
3523 command)
3530 ;; Replace specified region with output from command.
3532 ;; Don't muck with mark unless REPLACE says we should.
3539 t)
3540 nil shell-command-switch command))
3541 ;; It is rude to delete a buffer which the command is not using.
3542 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3543 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3544 ;; (kill-buffer shell-buffer)))
3545 ;; Don't muck with mark unless REPLACE says we should.
3547 ;; No prefix argument: put the output in a temp buffer,
3548 ;; replacing its entire contents.
3553 ;; If the input is the same buffer as the output,
3554 ;; delete everything but the specified region,
3555 ;; then replace that region with the output.
3561 shell-file-name t
3564 t)
3565 nil shell-command-switch
3566 command)))
3567 ;; Clear the output buffer, then run the command with
3568 ;; output there.
3579 buffer)
3580 nil shell-command-switch command)))
3581 ;; Report the output.
3591 ;; There's some output, display it
3593 ;; No output; error?
3600 shell-command-default-error-buffer)
3607 output))
3610 exit-status))
3613 exit-status output))))
3614 ;; Don't kill: there might be useful info in the undo-log.
3615 ;; (kill-buffer buffer)
3616 )))))
3624 ;; Do no formatting while reading error file,
3625 ;; because that can run a shell command, and we
3626 ;; don't want that to cause an infinite recursion.
3628 ;; Put point after the inserted errors.
3633 exit-status))
3636 "Execute shell command COMMAND and return its output as a string."
3639 standard-output
3643 "Process files synchronously in a separate process.
3644 Similar to `call-process', but may invoke a file handler based on
3645 `default-directory'. The current working directory of the
3646 subprocess is `default-directory'.
3648 File names in INFILE and BUFFER are handled normally, but file
3649 names in ARGS should be relative to `default-directory', as they
3650 are passed to the process verbatim. (This is a difference to
3651 `call-process' which does not support file handlers for INFILE
3652 and BUFFER.)
3654 Some file handlers might not support all variants, for example
3655 they might behave as if DISPLAY was nil, regardless of the actual
3656 value passed."
3658 lc stderr-file)
3668 display args)
3674 "Whether a call of `process-file' changes remote files.
3676 By default, this variable is always set to t, meaning that a
3677 call of `process-file' could potentially change any file on a
3678 remote host. When set to nil, a file handler could optimize
3679 its behavior with respect to remote file attribute caching.
3681 You should only ever change this variable with a let-binding;
3685 "Start a program in a subprocess. Return the process object for it.
3687 Similar to `start-process', but may invoke a file handler based on
3688 `default-directory'. See Info node `(elisp)Magic File Names'.
3690 This handler ought to run PROGRAM, perhaps on the local host,
3691 perhaps on a remote host that corresponds to `default-directory'.
3692 In the latter case, the local part of `default-directory' becomes
3693 the working directory of the process.
3695 PROGRAM and PROGRAM-ARGS might be file names. They are not
3696 objects of file handler invocation. File handlers might not
3697 support pty association, if PROGRAM is nil."
3701 \f
3702 ;;;; Process menu
3716 map))
3719 "Major mode for listing the processes called by Emacs."
3731 "Kill process at point in a `list-processes' buffer."
3737 "Recompute the list of processes for the Process List buffer.
3738 Also, delete any process that is exited or signaled."
3751 face link
3753 "Visit buffer `%s'"
3755 follow-link t
3756 process-buffer ,buf
3757 action process-menu-visit-buffer)
3766 "datagram"
3783 tabulated-list-entries))))))
3789 "Display a list of all processes that are Emacs sub-processes.
3790 If optional argument QUERY-ONLY is non-nil, only processes with
3791 the query-on-exit flag set are listed.
3792 Any process listed as exited or signaled is actually eliminated
3793 after the listing is made.
3794 Optional argument BUFFER specifies a buffer to use, instead of
3796 The return value is always nil.
3798 This function lists only processes that were launched by Emacs. To
3799 see other processes running on the system, use `list-system-processes'."
3811 nil)
3812 \f
3813 ;;;; Prefix commands
3819 ;; BEWARE: Called directly from C code.
3820 ;; If the return value is non-nil, it means we are in the middle of
3821 ;; a command with prefix, such as a command invoked with prefix-arg.
3823 prefix-command--last-echo
3832 "Abnormal hook which constructs the description of the current prefix state.
3836 "Update state of prefix commands.
3844 "Pass the current prefix command state to the next command.
3845 Should be called by all prefix commands.
3846 Runs `prefix-command-preserve-state-hook'."
3848 ;; If the current command is a prefix command, we don't want the next (real)
3849 ;; command to have `last-command' set to, say, `universal-argument'.
3856 nil)
3858 ;;;;; The main prefix command.
3860 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
3885 ;; For backward compatibility, minus with no modifiers is an ordinary
3886 ;; command if digits have already been entered.
3916 map)
3924 "Begin a numeric argument for the following command.
3929 multiplies the argument by 4 each time.
3931 which is different in effect from any particular numeric argument.
3939 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3940 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3947 arg)))
3951 "Begin a negative numeric argument for the next command.
3961 "Part of the numeric argument for the next command.
3966 last-command-event
3973 ;; Treat -0 as just -, so that -01 will work.
3976 digit))))
3978 \f
3986 "Function to perform the filtering in `filter-buffer-substring'.
3987 The function is called with the same 3 arguments (BEG END DELETE)
3988 that `filter-buffer-substring' received. It should return the
3989 buffer substring between BEG and END, after filtering. If DELETE is
3993 "List of filter functions for `buffer-substring--filter'.
3994 Each function must accept a single argument, a string, and return a string.
3995 The buffer substring is passed to the first function in the list,
3996 and the return value of each function is passed to the next.
3997 As a special convention, point is set to the start of the buffer text
3998 being operated on (i.e., the first argument of `buffer-substring--filter')
4004 "Return the buffer substring between BEG and END, after filtering.
4005 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4007 This calls the function that `filter-buffer-substring-function' specifies
4008 \(passing the same three arguments that it received) to do the work,
4009 and returns whatever it does. The default function does no filtering,
4010 unless a hook has been set.
4012 Use `filter-buffer-substring' instead of `buffer-substring',
4013 `buffer-substring-no-properties', or `delete-and-extract-region' when
4014 you want to allow filtering to take place. For example, major or minor
4015 modes can use `filter-buffer-substring-function' to extract characters
4016 that are special to a buffer, and should not be copied into other buffers."
4020 "Default function to use for `filter-buffer-substring-function'.
4021 Its arguments and return value are as specified for `filter-buffer-substring'.
4022 This respects the wrapper hook `filter-buffer-substring-functions',
4023 and the abnormal hook `buffer-substring-filters'.
4024 No filtering is done unless a hook says to."
4034 string)))
4039 ;;;; Window system cut and paste hooks.
4042 "Function to call to make a killed region available to other programs.
4043 Most window systems provide a facility for cutting and pasting
4044 text between different programs, such as the clipboard on X and
4045 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4047 This variable holds a function that Emacs calls whenever text is
4048 put in the kill ring, to make the new kill available to other
4049 programs. The function takes one argument, TEXT, which is a
4053 "Function to call to get text cut from other programs.
4054 Most window systems provide a facility for cutting and pasting
4055 text between different programs, such as the clipboard on X and
4056 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4058 This variable holds a function that Emacs calls to obtain text
4059 that other programs have provided for pasting. The function is
4060 called with no arguments. If no other program has provided text
4061 to paste, the function should return nil (in which case the
4062 caller, usually `current-kill', should use the top of the Emacs
4063 kill ring). If another program has provided text to paste, the
4064 function should return that text as a string (in which case the
4065 caller should put this string in the kill ring as the latest
4066 kill).
4068 The function may also return a list of strings if the window
4069 system supports multiple selections. The first string will be
4070 used as the pasted text, but the other will be placed in the kill
4071 ring for easy access via `yank-pop'.
4073 Note that the function should return a string only if a program
4074 other than Emacs has provided a string for pasting; if Emacs
4075 provided the most recent string, the function should return nil.
4076 If it is difficult to tell whether Emacs or some other program
4077 provided the current string, it is probably good enough to return
4078 nil if the string is equal (according to `string=') to the last
4080 \f
4083 ;;;; The kill ring data structure.
4086 "List of killed text sequences.
4087 Since the kill ring is supposed to interact nicely with cut-and-paste
4088 facilities offered by window systems, use of this variable should
4089 interact nicely with `interprogram-cut-function' and
4090 `interprogram-paste-function'. The functions `kill-new',
4091 `kill-append', and `current-kill' are supposed to implement this
4092 interaction; you may want to use them instead of manipulating the kill
4096 "Maximum length of kill ring before oldest elements are thrown away."
4104 "Save clipboard strings into kill ring before replacing them.
4105 When one selects something in another program to paste it into Emacs,
4106 but kills something in Emacs before actually pasting it,
4107 this selection is gone unless this variable is non-nil,
4108 in which case the other program's selection is saved in the `kill-ring'
4115 "Do not add a new string to `kill-ring' if it duplicates the last one.
4116 The comparison is done using `equal-including-properties'."
4122 "Make STRING the latest kill in the kill ring.
4123 Set `kill-ring-yank-pointer' to point to it.
4124 If `interprogram-cut-function' is non-nil, apply it to STRING.
4125 Optional second argument REPLACE non-nil means that STRING will replace
4126 the front of the kill ring, rather than being added to the list.
4128 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4129 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4130 STRING.
4132 When the yank handler has a non-nil PARAM element, the original STRING
4133 argument is not used by `insert-for-yank'. However, since Lisp code
4134 may access and use elements from the kill ring directly, the STRING
4137 ;; Due to text properties such as 'yank-handler that
4138 ;; can alter the contents to yank, comparison using
4139 ;; `equal' is unsafe.
4164 ;; It has been argued that this should work similar to `self-insert-command'
4165 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4167 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4173 "Append STRING to the end of the latest kill in the kill ring.
4174 If BEFORE-P is non-nil, prepend STRING to the kill.
4175 Also removes the last undo boundary in the current buffer,
4176 depending on `kill-append-merge-undo'.
4177 If `interprogram-cut-function' is set, pass the resulting kill to it."
4185 ;; find the next undo boundary
4189 ;; remove this undo boundary
4194 "Whether rotating the kill ring changes the window system selection.
4195 If non-nil, whenever the kill ring is rotated (usually via the
4196 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4197 to copy the new kill to the window system selection."
4203 "Rotate the yanking point by N places, and then return that kill.
4204 If N is zero and `interprogram-paste-function' is set to a
4205 function that returns a string or a list of strings, and if that
4206 function doesn't return nil, then that string (or list) is added
4207 to the front of the kill ring and the string (or first string in
4208 the list) is returned as the latest kill.
4210 If N is not zero, and if `yank-pop-change-selection' is
4211 non-nil, use `interprogram-cut-function' to transfer the
4212 kill at the new yank point into the window system selection.
4214 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4215 move the yanking point; just return the Nth kill forward."
4218 interprogram-paste-function
4222 ;; Disable the interprogram cut function when we add the new
4223 ;; text to the kill ring, so Emacs doesn't try to own the
4224 ;; selection, with identical text.
4234 kill-ring)))
4239 interprogram-cut-function)
4245 ;;;; Commands for manipulating the kill ring.
4248 "Non-nil means don't signal an error for killing read-only text."
4254 This deletes the text from the buffer and saves it in the kill ring.
4258 If you want to append the killed region to the last killed text,
4262 If the previous command was also a kill command,
4263 the text killed this time appends to the text killed last time
4264 to make one entry in the kill ring.
4266 The killed text is filtered by `filter-buffer-substring' before it is
4267 saved in the kill ring, so the actual saved text might be different
4268 from what was killed.
4270 If the buffer is read-only, Emacs will beep and refrain from deleting
4271 the text, but put the text in the kill ring anyway. This means that
4272 you can use the killing commands to copy text from a read-only buffer.
4274 Lisp programs should use this function for killing text.
4275 (To delete text, use `delete-region'.)
4276 Supply two arguments, character positions BEG and END indicating the
4277 stretch of text to be killed. If the optional argument REGION is
4278 non-nil, the function ignores BEG and END, and kills the current
4279 region instead."
4280 ;; Pass mark first, then point, because the order matters when
4281 ;; calling `kill-append'.
4290 ;; Add that string to the kill ring, one way or another.
4297 nil)
4299 ;; The code above failed because the buffer, or some of the characters
4300 ;; in the region, are read-only.
4301 ;; We should beep, in case the user just isn't aware of this.
4302 ;; However, there's no harm in putting
4303 ;; the region's text in the kill ring, anyway.
4305 ;; Set this-command now, so it will be set even if we get an error.
4307 ;; This should barf, if appropriate, and give us the correct error.
4310 ;; Signal an error if the buffer is read-only.
4312 ;; If the buffer isn't read-only, the text is.
4315 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4316 ;; to get two copies of the text when the user accidentally types M-w and
4317 ;; then corrects it with the intended C-w.
4319 "Save the region as if killed, but don't kill it.
4320 In Transient Mark mode, deactivate the mark.
4321 If `interprogram-cut-function' is non-nil, also save the text for a window
4322 system cut and paste.
4324 The copied text is filtered by `filter-buffer-substring' before it is
4325 saved in the kill ring, so the actual saved text might be different
4326 from what was in the buffer.
4328 When called from Lisp, save in the kill ring the stretch of text
4329 between BEG and END, unless the optional argument REGION is
4330 non-nil, in which case ignore BEG and END, and save the current
4331 region instead.
4333 This command's old key binding has been given to `kill-ring-save'."
4334 ;; Pass mark first, then point, because the order matters when
4335 ;; calling `kill-append'.
4345 nil)
4348 "Save the region as if killed, but don't kill it.
4349 In Transient Mark mode, deactivate the mark.
4350 If `interprogram-cut-function' is non-nil, also save the text for a window
4351 system cut and paste.
4353 If you want to append the killed line to the last killed text,
4356 The copied text is filtered by `filter-buffer-substring' before it is
4357 saved in the kill ring, so the actual saved text might be different
4358 from what was in the buffer.
4360 When called from Lisp, save in the kill ring the stretch of text
4361 between BEG and END, unless the optional argument REGION is
4362 non-nil, in which case ignore BEG and END, and save the current
4363 region instead.
4365 This command is similar to `copy-region-as-kill', except that it gives
4366 visual feedback indicating the extent of the region being copied."
4367 ;; Pass mark first, then point, because the order matters when
4368 ;; calling `kill-append'.
4372 ;; This use of called-interactively-p is correct because the code it
4373 ;; controls just gives the user visual feedback.
4378 "Indicate that the region text has been copied interactively.
4379 If the mark is visible in the selected window, blink the cursor
4380 between point and mark if there is currently no active region
4381 highlighting.
4383 If the mark lies outside the selected window, display an
4384 informative message containing a sample of the copied text. The
4385 optional argument MESSAGE-LEN, if non-nil, specifies the length
4386 of this sample text; it defaults to 40."
4389 ;; Inhibit quitting so we can make a quit here
4390 ;; look like a C-g typed as a command.
4393 ;; Swap point-and-mark quickly so as to show the region that
4394 ;; was selected. Don't do it if the region is highlighted.
4397 ;; Swap point and mark.
4401 ;; Swap back.
4404 ;; If user quit, deactivate the mark
4405 ;; as C-g would as a command.
4411 ;; Don't say "killed"; that is misleading.
4418 "Cause following command, if it kills, to add to previous kill.
4419 If the next command kills forward from point, the kill is
4420 appended to the previous killed text. If the command kills
4421 backward, the kill is prepended. Kill commands that act on the
4422 region, such as `kill-region', are regarded as killing forward if
4423 point is after mark, and killing backward if point is before
4424 mark.
4426 If the next command is not a kill command, `append-next-kill' has
4427 no effect.
4429 The argument is used for internal purposes; do not supply one."
4431 ;; We don't use (interactive-p), since that breaks kbd macros.
4445 "A subroutine of `squeeze-bidi-context'.
4446 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4450 lim1)
4457 ;; L and R categories include embedding and
4458 ;; override controls, but we don't want to
4459 ;; replace them, because that might change
4460 ;; the visual order. Likewise with PDF and
4461 ;; isolate controls.
4463 bidi-directional-non-controls-chars
4464 limit)))))
4465 ;; Replace any run of non-RTL characters by a single LRM.
4467 ;; No more characters of CATEGORY, we are done.
4472 ;; Skip directional controls, if any.
4477 "Replace characters between FROM and TO while keeping bidi context.
4479 This function replaces the region of text with as few characters
4480 as possible, while preserving the effect that region will have on
4481 bidirectional display before and after the region."
4485 ;; This is for when they copy text with read-only text
4486 ;; properties.
4490 ;; Replace each run of non-RTL characters with a single LRM.
4492 ;; Replace each run of non-LTR characters with a single RLM. Note
4493 ;; that the \cR category includes both the Arabic Letter (AL) and
4494 ;; R characters; here we ignore the distinction between them,
4495 ;; because that distinction only affects Arabic Number (AN)
4496 ;; characters, which are weak and don't affect the reordering.
4500 "Return buffer text between START and END with its bidi context.
4502 START and END are assumed to belong to the same physical line
4503 of buffer text. This function prepends and appends to the text
4504 between START and END bidi control characters that preserve the
4505 visual order of that text when it is inserted at some other place."
4510 substr para-dir from to)
4517 ;; If we don't have any mixed directional characters in the
4518 ;; entire line, we can just copy the substring without adding
4519 ;; any context.
4534 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4535 ;; (1) force the string to have the same base embedding
4536 ;; direction as the paragraph direction at the source, no matter
4537 ;; what is the paragraph direction at destination; and (2) avoid
4538 ;; affecting the visual order of the surrounding text at
4539 ;; destination if there are characters of different
4540 ;; directionality there.
4545 "Return portion of current buffer between START and END with bidi context.
4547 This function works similar to `buffer-substring', but it prepends and
4548 appends to the text bidi directional control characters necessary to
4549 preserve the visual appearance of the text if it is inserted at another
4550 place. This is useful when the buffer substring includes bidirectional
4551 text and control characters that cause non-trivial reordering on display.
4552 If copied verbatim, such text can have a very different visual appearance,
4553 and can also change the visual appearance of the surrounding text at the
4554 destination of the copy.
4556 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4557 the text properties."
4570 no-properties)))
4574 substr)))
4575 \f
4576 ;; Yanking.
4581 "List of special text property handling conditions for yanking.
4582 Each element should have the form (PROP . FUN), where PROP is a
4583 property symbol and FUN is a function. When the `yank' command
4584 inserts text into the buffer, it scans the inserted text for
4585 stretches of text that have `eq' values of the text property
4586 PROP; for each such stretch of text, FUN is called with three
4587 arguments: the property's value in that text, and the start and
4588 end positions of the text.
4590 This is done prior to removing the properties specified by
4591 `yank-excluded-properties'."
4594 function))
4597 ;; This is actually used in subr.el but defcustom does not work there.
4600 intangible invisible keymap local-map mouse-face read-only
4601 yank-handler)
4602 "Text properties to discard when yanking.
4603 The value should be a list of text properties to discard or t,
4604 which means to discard all text properties.
4606 See also `yank-handled-properties'."
4613 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4614 Function is called with two parameters, START and END corresponding to
4615 the value of the mark and point; it is guaranteed that START <= END.
4619 "Replace just-yanked stretch of killed text with a different stretch.
4620 This command is allowed only immediately after a `yank' or a `yank-pop'.
4621 At such a time, the region contains a stretch of reinserted
4622 previously-killed text. `yank-pop' deletes that text and inserts in its
4623 place a different stretch of killed text.
4625 With no argument, the previous kill is inserted.
4626 With argument N, insert the Nth previous kill.
4627 If N is negative, this is a more recent kill.
4629 The sequence of kills wraps around, so that after the oldest one
4630 comes the newest one.
4632 When this command inserts killed text into the buffer, it honors
4633 `yank-excluded-properties' and `yank-handler' as described in the
4634 doc string for `insert-for-yank-1', which see."
4648 ;; Set the window start back where it was in the yank command,
4649 ;; if possible.
4652 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4653 ;; It is cleaner to avoid activation, even though the command
4654 ;; loop would deactivate the mark because we inserted text.
4657 nil)
4661 More precisely, reinsert the most recent kill, which is the
4662 stretch of killed text most recently killed OR yanked. Put point
4663 at the end, and set mark at the beginning without activating it.
4665 With argument N, reinsert the Nth most recent kill.
4667 When this command inserts text into the buffer, it honors the
4668 `yank-handled-properties' and `yank-excluded-properties'
4669 variables, and the `yank-handler' text property. See
4670 `insert-for-yank-1' for details.
4675 ;; If we don't get all the way thru, make last-command indicate that
4676 ;; for the following command.
4684 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4685 ;; It is cleaner to avoid activation, even though the command
4686 ;; loop would deactivate the mark because we inserted text.
4689 ;; If we do get all the way thru, make this-command indicate that.
4692 nil)
4695 "Rotate the yanking point in the kill ring.
4696 With ARG, rotate that many kills forward (or backward, if negative)."
4699 \f
4700 ;; Some kill commands.
4702 ;; Internal subroutine of delete-char
4708 ;; Internal subroutine of backward-delete-char
4715 "The method for untabifying when deleting backward.
4716 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4717 `hungry' -- delete all whitespace, both tabs and spaces;
4718 `all' -- delete all whitespace, including tabs, spaces and newlines;
4719 nil -- just delete one character."
4725 "Delete characters backward, changing tabs into spaces.
4726 The exact behavior depends on `backward-delete-char-untabify-method'.
4727 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4728 Interactively, ARG is the prefix arg (default 1)
4729 and KILLP is t if a prefix arg was specified."
4752 arg)))
4753 ;; Avoid warning about delete-backward-char
4757 "Kill up to and including ARGth occurrence of CHAR.
4758 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4759 Goes backward if ARG is negative; error if CHAR not found."
4762 ;; Avoid "obsolete" warnings for translation-table-for-input.
4770 ;; kill-line and its subroutines.
4773 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4778 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4779 With prefix argument ARG, kill that many lines from point.
4780 Negative arguments kill lines backward.
4781 With zero argument, kills the text before point on the current line.
4784 a number counts as a prefix arg.
4786 To kill a whole line, when point is not at the beginning, type \
4789 If `show-trailing-whitespace' is non-nil, this command will just
4790 kill the rest of the current line, even if there are only
4791 nonblanks there.
4793 If option `kill-whole-line' is non-nil, then this command kills the whole line
4794 including its terminating newline, when used at the beginning of a line
4795 with no argument. As a consequence, you can always kill a whole line
4798 If you want to append the killed line to the last killed text,
4801 If the buffer is read-only, Emacs will beep and refrain from deleting
4802 the line, but put the line in the kill ring anyway. This means that
4803 you can use this command to copy text from a read-only buffer.
4804 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4805 even beep.)"
4808 ;; It is better to move point to the other end of the kill
4809 ;; before killing. That way, in a read-only buffer, point
4810 ;; moves across the text that is copied to the kill ring.
4811 ;; The choice has no effect on undo now that undo records
4812 ;; the value of point from before the command was run.
4822 ;; If trailing whitespace is visible,
4823 ;; don't treat it as nothing.
4833 "Kill current line.
4834 With prefix ARG, kill that many lines starting from the current line.
4835 If ARG is negative, kill backward. Also kill the preceding newline.
4837 If ARG is zero, kill current line but exclude the trailing newline."
4848 ;; We need to kill in two steps, because the previous command
4849 ;; could have been a kill command, in which case the text
4850 ;; before point needs to be prepended to the current kill
4851 ;; ring entry and the text after point appended. Also, we
4852 ;; need to use save-excursion to avoid copying the same text
4853 ;; twice to the kill ring in read-only buffers.
4871 "Move forward by ARG lines, ignoring currently invisible newlines only.
4872 If ARG is negative, move backward -ARG lines.
4873 If ARG is zero, move to the beginning of the current line."
4880 ;; If the newline we just skipped is invisible,
4881 ;; don't count it.
4885 prop
4890 ;; If invisible text follows, and it is a number of complete lines,
4891 ;; skip it.
4897 prop
4913 ;; If the newline we just moved to is invisible,
4914 ;; don't count it.
4919 prop
4924 ;; If invisible text follows, and it is a number of complete lines,
4925 ;; skip it.
4931 prop
4942 nil)))
4945 "Move to end of current visible line."
4947 ;; If the following character is currently invisible,
4948 ;; skip all characters with that same `invisible' property value,
4949 ;; then find the next newline.
4956 prop
4965 \f
4967 "Insert after point the contents of BUFFER.
4968 Puts mark after the inserted text.
4969 BUFFER may be a buffer or a buffer name."
4979 t))))
4984 nil)
4987 "Append to specified buffer the text of the region.
4988 It is inserted into that buffer before its point.
4990 When calling from a program, give three arguments:
4991 BUFFER (or buffer name), START and END.
4992 START and END specify the portion of the current buffer to be copied."
4999 point)
5010 "Prepend to specified buffer the text of the region.
5011 It is inserted into that buffer after its point.
5013 When calling from a program, give three arguments:
5014 BUFFER (or buffer name), START and END.
5015 START and END specify the portion of the current buffer to be copied."
5024 "Copy to specified buffer the text of the region.
5025 It is inserted into that buffer, replacing existing text there.
5027 When calling from a program, give three arguments:
5028 BUFFER (or buffer name), START and END.
5029 START and END specify the portion of the current buffer to be copied."
5037 \f
5041 "Hook run when the mark becomes active.
5042 It is also run at the end of a command, if the mark is active and
5049 "Return this buffer's mark value as integer, or nil if never set.
5051 In Transient Mark mode, this function signals an error if
5052 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5053 or the argument FORCE is non-nil, it disregards whether the mark
5054 is active, and returns an integer or nil in the usual way.
5056 If you are using this in an editing command, you are most likely making
5057 a mistake; see the documentation of `set-mark'."
5062 ;; Behind display-selections-p.
5065 "Deactivate the mark.
5066 If Transient Mark mode is disabled, this function normally does
5067 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5069 Deactivating the mark sets `mark-active' to nil, updates the
5070 primary selection according to `select-active-regions', and runs
5071 `deactivate-mark-hook'.
5073 If Transient Mark mode was temporarily enabled, reset the value
5074 of the variable `transient-mark-mode'; if this causes Transient
5075 Mark mode to be disabled, don't change `mark-active' to nil or
5076 run `deactivate-mark-hook'."
5080 select-active-regions)
5083 ;; The var `saved-region-selection', if non-nil, is the text in
5084 ;; the region prior to the last command modifying the buffer.
5085 ;; Set the selection to that, or to the current region.
5090 ;; If another program has acquired the selection, region
5091 ;; deactivation should not clobber it (Bug#11772).
5110 "Activate the mark.
5111 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5121 "Set this buffer's mark to POS. Don't use this function!
5122 That is to say, don't use this function unless you want
5123 the user to see that the mark has moved, and you want the previous
5124 mark position to be lost.
5126 Normally, when a new mark is set, the old one should go on the stack.
5127 This is why most applications should use `push-mark', not `set-mark'.
5129 Novice Emacs Lisp programmers often try to use the mark for the wrong
5130 purposes. The mark saves a location for the user's convenience.
5131 Most editing commands should not alter the mark.
5132 To remember a location for internal use in the Lisp program,
5133 store it in a Lisp variable. Example:
5135 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5140 ;; Normally we never clear mark-active except in Transient Mark mode.
5141 ;; But when we actually clear out the mark value too, we must
5142 ;; clear mark-active in any mode.
5144 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5145 ;; it should never be nil if the mark is nil.
5153 mark-active))
5160 ;; Mark marker
5166 ;; Mark active
5169 ;; If mark is active now, and either was not active or was at a
5170 ;; different place, run the activate hook.
5175 ;; If mark has ceased to be active, run deactivate hook.
5180 "Like `save-excursion', but also save and restore the mark state.
5181 This macro does what `save-excursion' did before Emacs 25.1."
5190 If nil, region-aware commands treat empty regions as inactive.
5191 If non-nil, region-aware commands treat the region as active as
5192 long as the mark is active, even if the region is empty.
5194 Region-aware commands are those that act on the region if it is
5195 active and Transient Mark mode is enabled, and on the text near
5196 point otherwise."
5202 "Return t if the region is active and it is appropriate to act on it.
5203 This is used by commands that act specially on the region under
5204 Transient Mark mode.
5206 The return value is t if Transient Mark mode is enabled and the
5207 mark is active; furthermore, if `use-empty-active-region' is nil,
5208 the region must not be empty. Otherwise, the return value is nil.
5210 For some commands, it may be appropriate to ignore the value of
5211 `use-empty-active-region'; in that case, use `region-active-p'."
5216 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5218 Some commands act specially on the region when Transient Mark
5219 mode is enabled. Usually, such commands should use
5220 `use-region-p' instead of this function, because `use-region-p'
5221 also checks the value of `use-empty-active-region'."
5223 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5224 ;; without the mark being set (e.g. bug#17324). We really should fix
5225 ;; that problem, but in the mean time, let's make sure we don't say the
5226 ;; region is active when there's no mark.
5230 "Return non-nil if the region contains several pieces.
5231 An example is a rectangular region handled as a list of
5232 separate contiguous regions for each line."
5245 ;; Normal priority so that a large region doesn't hide all the
5246 ;; overlays within it, but high secondary priority so that if it
5247 ;; ends/starts in the middle of a small overlay, that small overlay
5248 ;; won't hide the region's boundaries.
5250 nrol)
5255 rol)))
5271 start end window rol)))
5274 new))))))
5277 "Hook run just before redisplay.
5278 It is called in each window that is to be redisplayed. It takes one argument,
5279 which is the window that will be redisplayed. When run, the `current-buffer'
5300 "Maximum size of mark ring. Start discarding off end if gets this big."
5308 "Maximum size of global mark ring. \
5309 Start discarding off end if gets this big."
5314 "Jump to mark, and pop a new position for mark off the ring.
5315 \(Does not affect global mark ring)."
5325 "Set mark at where point is.
5326 If no prefix ARG and mark is already set there, just activate it.
5327 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5339 will pop the mark twice, and
5341 will pop the mark three times.
5349 "Set the mark where point is, or jump to the mark.
5350 Setting the mark also alters the region, which is the text
5351 between point and mark; this is the closest equivalent in
5354 With no prefix argument, set the mark at point, and push the
5355 old mark position on local mark ring. Also push the old mark on
5356 global mark ring, if the previous mark was set in another buffer.
5358 When Transient Mark Mode is off, immediately repeating this
5359 command activates `transient-mark-mode' temporarily.
5362 jump to the mark, and set the mark from
5363 position popped off the local mark ring (this does not affect the global
5365 mark ring (see `pop-global-mark').
5367 If `set-mark-command-repeat-pop' is non-nil, repeating
5369 off the local (or global) mark ring and jumps there.
5372 argument, unconditionally set mark where point is, even if
5373 `set-mark-command-repeat-pop' is non-nil.
5375 Novice Emacs Lisp programmers often try to use the mark for the wrong
5376 purposes. See the documentation of `set-mark' for more information."
5396 arg)
5410 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5411 If the last global mark pushed was not in the current buffer,
5412 also push LOCATION on the global mark ring.
5413 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5415 Novice Emacs Lisp programmers often try to use the mark for the wrong
5416 purposes. See the documentation of `set-mark' for more information.
5418 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5425 ;; Now push the mark on the global mark ring.
5428 ;; The last global mark pushed was in this same buffer.
5429 ;; Don't push another one.
5430 nil
5439 nil)
5442 "Pop off mark ring into the buffer's actual mark.
5443 Does not set point. Does nothing if mark ring is empty."
5455 "Put the mark where point is now, and point where the mark is now.
5456 This command works even when the mark is not active,
5457 and it reactivates the mark.
5459 If Transient Mark mode is on, a prefix ARG deactivates the mark
5460 if it is active, and otherwise avoids reactivating it. If
5461 Transient Mark mode is off, a prefix ARG enables Transient Mark
5462 mode temporarily."
5476 nil))
5479 "When non-nil, shifted motion keys activate the mark momentarily.
5481 While the mark is activated in this way, any shift-translated point
5482 motion key extends the region, and if Transient Mark mode was off, it
5483 is temporarily turned on. Furthermore, the mark will be deactivated
5484 by any subsequent point motion key that was not shift-translated, or
5485 by any action that normally deactivates the mark in Transient Mark mode.
5487 See `this-command-keys-shift-translated' for the meaning of
5488 shift-translation."
5493 "Activate/deactivate mark depending on invocation thru shift translation.
5494 This function is called by `call-interactively' when a command
5495 with a `^' character in its `interactive' spec is invoked, before
5496 running the command itself.
5498 If `shift-select-mode' is enabled and the command was invoked
5499 through shift translation, set the mark and activate the region
5500 temporarily, unless it was already set in this way. See
5501 `this-command-keys-shift-translated' for the meaning of shift
5502 translation.
5504 Otherwise, if the region has been activated temporarily,
5505 deactivate it, and restore the variable `transient-mark-mode' to
5506 its earlier value."
5513 transient-mark-mode)))
5522 "Toggle Transient Mark mode.
5523 With a prefix argument ARG, enable Transient Mark mode if ARG is
5524 positive, and disable it otherwise. If called from Lisp, enable
5525 Transient Mark mode if ARG is omitted or nil.
5527 Transient Mark mode is a global minor mode. When enabled, the
5528 region is highlighted with the `region' face whenever the mark
5530 and after certain other operations that set the mark but whose
5531 main purpose is something else--for example, incremental search,
5537 Many commands change their behavior when Transient Mark mode is
5538 in effect and the mark is active, by acting on the region instead
5539 of their usual default part of the buffer's text. Examples of
5542 To see the documentation of commands which are sensitive to the
5545 :global t
5546 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5550 "Non-nil means it is ok for commands to call `widen' when they want to.
5551 Some commands will do this in order to go to positions outside
5552 the current accessible part of the buffer.
5554 If `widen-automatically' is nil, these commands will do something else
5558 "Whether the currently executing code is performing an essential task.
5559 This variable should be non-nil only when running code which should not
5560 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5561 user for a password when we are simply scanning a set of files in the
5562 background or displaying possible completions before the user even asked
5566 "Pop off global mark ring and jump to the top location."
5568 ;; Pop entries which refer to non-existent buffers.
5586 \f
5588 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5594 "Move cursor vertically down ARG lines.
5595 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5596 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5597 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5598 function will not vscroll.
5600 ARG defaults to 1.
5602 If there is no character in the target line exactly under the current column,
5603 the cursor is positioned after the character in that line which spans this
5604 column, or at the end of the line if it is not long enough.
5605 If there is no line in the buffer after this one, behavior depends on the
5606 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5607 to create a line, and moves the cursor to that line. Otherwise it moves the
5608 cursor to the end of the buffer.
5610 If the variable `line-move-visual' is non-nil, this command moves
5611 by display lines. Otherwise, it moves by buffer lines, without
5612 taking variable-width characters or continued lines into account.
5615 a semipermanent goal column for this command.
5616 Then instead of trying to move exactly vertically (or as close as possible),
5617 this command moves to the specified goal column (or as close as possible).
5618 The goal column is stored in the variable `goal-column', which is nil
5619 when there is no goal column. Note that setting `goal-column'
5620 overrides `line-move-visual' and causes this command to move by buffer
5621 lines rather than by display lines."
5627 ;; When adding a newline, don't expand an abbrev.
5638 nil)
5641 "Move cursor vertically up ARG lines.
5642 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5643 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5644 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5645 function will not vscroll.
5647 ARG defaults to 1.
5649 If there is no character in the target line exactly over the current column,
5650 the cursor is positioned after the character in that line which spans this
5651 column, or at the end of the line if it is not long enough.
5653 If the variable `line-move-visual' is non-nil, this command moves
5654 by display lines. Otherwise, it moves by buffer lines, without
5655 taking variable-width characters or continued lines into account.
5658 a semipermanent goal column for this command.
5659 Then instead of trying to move exactly vertically (or as close as possible),
5660 this command moves to the specified goal column (or as close as possible).
5661 The goal column is stored in the variable `goal-column', which is nil
5662 when there is no goal column. Note that setting `goal-column'
5663 overrides `line-move-visual' and causes this command to move by buffer
5664 lines rather than by display lines."
5675 nil)
5678 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5679 This means moving to the end of each line moved onto.
5680 The beginning of a blank line does not count as the end of a line.
5681 This has no effect when the variable `line-move-visual' is non-nil."
5687 A non-nil setting overrides the variable `line-move-visual', which see."
5694 "Current goal column for vertical motion.
5695 It is the column where point was at the start of the current run
5696 of vertical motion commands.
5698 When moving by visual lines via the function `line-move-visual', it is a cons
5699 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5700 divided by the default column width, and HSCROLL is the number of
5701 columns by which window is scrolled from left margin.
5703 When the `track-eol' feature is doing its job, the value is
5707 "Non-nil means commands that move by lines ignore invisible newlines.
5708 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5709 as if newlines that are invisible didn't exist, and count
5710 only visible newlines. Thus, moving across across 2 newlines
5711 one of which is invisible will be counted as a one-line move.
5712 Also, a non-nil value causes invisible text to be ignored when
5713 counting columns for the purposes of keeping point in the same
5716 Outline mode sets this."
5721 "When non-nil, `line-move' moves point by visual lines.
5722 This movement is based on where the cursor is displayed on the
5723 screen, instead of relying on buffer contents alone. It takes
5724 into account variable-width characters and line continuation.
5725 If nil, `line-move' moves point by logical lines.
5726 A non-nil setting of `goal-column' overrides the value of this variable
5727 and forces movement by logical lines.
5728 A window that is horizontally scrolled also forces movement by logical
5729 lines."
5734 ;; Only used if display-graphic-p.
5738 "Return the height in pixels of the current buffer's default face font.
5740 If the default font is remapped (see `face-remapping-alist'), the
5741 function returns the height of the remapped face."
5745 ;; Avoid calling font-info if the frame's default font was
5746 ;; not changed since the frame was created. That's because
5747 ;; font-info is expensive for some fonts, see bug #14838.
5753 "Return the width in pixels of the current buffer's default face font.
5755 If the default font is remapped (see `face-remapping-alist'), the
5756 function returns the width of the remapped face."
5760 ;; Avoid calling font-info if the frame's default font was
5761 ;; not changed since the frame was created. That's because
5762 ;; font-info is expensive for some fonts, see bug #14838.
5767 width
5772 "Return the pixel height of current buffer's default-face text line.
5774 The value includes `line-spacing', if any, defined for the buffer
5775 or the frame."
5788 "Return the number of screen lines in the text area of the selected window.
5790 This is different from `window-text-height' in that this function counts
5791 lines in units of the height of the font used by the default face displayed
5792 in the window, not in units of the frame's default font, and also accounts
5793 for `line-spacing', if any, defined for the window's buffer or frame.
5795 The value is a floating-point number."
5800 ;; Returns non-nil if partial move was done.
5803 ;; Move backward (up).
5804 ;; If already vscrolled, reduce vscroll
5810 ;; Move forward (down).
5823 py vs last-line)
5843 col-row)
5848 ;; VPOS > 0 means the last line is only partially visible.
5849 ;; But if the part that is visible is at least as tall as the
5850 ;; default font, that means the line is actually fully
5851 ;; readable, and something like line-spacing is hidden. So in
5852 ;; that case we accept the last line in the window as still
5853 ;; visible, and consider the margin as starting one line
5854 ;; later.
5862 ;; If last line of window is fully visible, and vscrolling
5863 ;; more would make this line invisible, move forward.
5868 nil)
5869 ;; If cursor is not in the bottom scroll margin, and the
5870 ;; current line is is not too tall, move forward.
5872 vpos
5875 nil)
5876 ;; When already vscrolled, we vscroll some more if we can,
5877 ;; or clear vscroll and move forward at end of tall image.
5882 ;; If cursor just entered the bottom scroll margin, move forward,
5883 ;; but also optionally vscroll one line so redisplay won't recenter.
5887 ;; Don't vscroll if the partially-visible line at window
5888 ;; bottom is not too tall (a.k.a. "just one more text
5889 ;; line"): in that case, we do want redisplay to behave
5890 ;; normally, i.e. recenter or whatever.
5891 ;;
5892 ;; Note: ROWH + RBOT from the value returned by
5893 ;; pos-visible-in-window-p give the total height of the
5894 ;; partially-visible glyph row at the end of the window. As
5895 ;; we are dealing with floats, we disregard sub-pixel
5896 ;; discrepancies between that and DLH.
5900 t)
5901 ;; If there are lines above the last line, scroll-up one line.
5904 t)
5905 ;; Finally, start vscroll.
5910 ;; This is like line-move-1 except that it also performs
5911 ;; vertical scrolling of tall images if appropriate.
5912 ;; That is not really a clean thing to do, since it mixes
5913 ;; scrolling with cursor motion. But so far we don't have
5914 ;; a cleaner solution to the problem of making C-n do something
5915 ;; useful given a tall image.
5917 "Move forward ARG lines.
5918 If NOERROR, don't signal an error if we can't move ARG lines.
5919 TO-END is unused.
5920 TRY-VSCROLL controls whether to vscroll tall lines: if either
5921 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5922 not vscroll."
5926 ;; Only vscroll for single line moves
5928 ;; Under scroll-conservatively, the display engine
5929 ;; does this better.
5931 ;; But don't vscroll in a keyboard macro.
5937 ;; Display-based column are incompatible with goal-column.
5939 ;; When the text in the window is scrolled to the left,
5940 ;; display-based motion doesn't make sense (because each
5941 ;; logical line occupies exactly one screen line).
5943 ;; Likewise when the text _was_ scrolled to the left
5944 ;; when the current run of vertical motion commands
5945 ;; started.
5948 auto-hscroll-mode
5950 (>= temporary-goal-column
5953 ;; If we moved into a tall line, set vscroll to make
5954 ;; scrolling through tall images more smooth.
5958 winh)
5964 nil
5968 ;; Display-based alternative to line-move-1.
5969 ;; Arg says how many lines to move. The value is t if we can move the
5970 ;; specified number of lines.
5972 "Move ARG lines forward.
5973 If NOERROR, don't signal an error if we can't move that many lines."
5976 target-hscroll)
5977 ;; Check if the previous command was a line-motion command, or if
5978 ;; we were called from some other command.
5981 ;; If so, there's no need to reset `temporary-goal-column',
5982 ;; but we may need to hscroll.
5986 ;; Otherwise, we should reset `temporary-goal-column'.
5988 x-pos)
5990 ;; Handle the `overflow-newline-into-fringe' case:
5995 ;; In R2L lines, the X pixel coordinate is measured from the
5996 ;; left edge of the window, but columns are still counted
5997 ;; from the logical-order beginning of the line, i.e. from
5998 ;; the right edge in this case. We need to adjust for that.
6004 hscroll))))))
6007 ;; vertical-motion can move more than it was asked to if it moves
6008 ;; across display strings with newlines. We don't want to ring
6009 ;; the bell and announce beginning/end of buffer in that case.
6015 temporary-goal-column))
6016 arg))
6017 arg))
6023 temporary-goal-column))
6024 arg))
6025 arg)))
6028 ;; If the goal column lies on a display string,
6029 ;; `vertical-motion' advances the cursor to the end
6030 ;; of the string. For arg < 0, this can cause the
6031 ;; cursor to get stuck. (Bug#3020).
6035 nil)))))
6037 ;; This is the guts of next-line and previous-line.
6038 ;; Arg says how many lines to move.
6039 ;; The value is t if we can move the specified number of lines.
6041 ;; Don't run any point-motion hooks, and disregard intangibility,
6042 ;; for intermediate positions.
6054 ;; Don't count beg of empty line as end of line
6055 ;; unless we just did explicit end-of-line.
6057 most-positive-fixnum
6061 line-move-ignore-invisible))
6062 ;; Use just newline characters.
6063 ;; Set ARG to 0 if we move as many lines as requested.
6066 ;; This way of moving forward ARG lines
6067 ;; verifies that we have a newline after the last one.
6068 ;; It doesn't get confused by intangible text.
6077 'beginning-of-buffer
6079 nil)))
6080 ;; Move by arg lines, but ignore invisible ones.
6083 ;; If the following character is currently invisible,
6084 ;; skip all characters with that same `invisible' property value.
6087 ;; Move a line.
6088 ;; We don't use `end-of-line', since we want to escape
6089 ;; from field boundaries occurring exactly at point.
6095 ;; If there's no invisibility here, move over the newline.
6104 ;; We avoid vertical-motion when possible
6105 ;; because that has to fontify.
6107 ;; Otherwise move a more sophisticated way.
6114 ;; The logic of this is the same as the loop above,
6115 ;; it just goes in the other direction.
6117 ;; For completely consistency with the forward-motion
6118 ;; case, we should call beginning-of-line here.
6119 ;; However, if point is inside a field and on a
6120 ;; continued line, the call to (vertical-motion -1)
6121 ;; below won't move us back far enough; then we return
6122 ;; to the same column in line-move-finish, and point
6123 ;; gets stuck -- cyd
6141 ;; if our target is the middle of this line.
6146 ;; This is the value the function returns.
6150 ;; If we did not move down as far as desired, at least go
6151 ;; to end of line. Be sure to call point-entered and
6152 ;; point-left-hooks.
6158 ;; If we did not move up as far as desired,
6159 ;; at least go to beginning of line.
6171 ;; Set REPEAT to t to repeat the whole thing.
6178 ;; Compute the end of the line
6179 ;; ignoring effectively invisible newlines.
6181 ;; Like end-of-line but ignores fields.
6188 ;; Move to the desired column.
6191 ;; Corner case: suppose we start out in a field boundary in
6192 ;; the middle of a continued line. When we get to
6193 ;; line-move-finish, point is at the start of a new *screen*
6194 ;; line but the same text line; then line-move-to-column would
6195 ;; move us backwards. Test using C-n with point on the "x" in
6196 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6203 ;; Process intangibility within a line.
6204 ;; With inhibit-point-motion-hooks bound to nil, a call to
6205 ;; goto-char moves point past intangible text.
6207 ;; However, inhibit-point-motion-hooks controls both the
6208 ;; intangibility and the point-entered/point-left hooks. The
6209 ;; following hack avoids calling the point-* hooks
6210 ;; unnecessarily. Note that we move *forward* past intangible
6211 ;; text when the initial and final points are the same.
6216 ;; If intangibility moves us to a different (later) place
6217 ;; in the same line, use that as the destination.
6220 ;; If that position is "too late",
6221 ;; try the previous allowable position.
6222 ;; See if it is ok.
6225 ;; If going forward, don't accept the previous
6226 ;; allowable position if it is before the target line.
6228 ;; If going backward, don't accept the previous
6229 ;; allowable position if it is still after the target line.
6232 ;; As a last resort, use the end of the line.
6235 ;; Now move to the updated destination, processing fields
6236 ;; as well as intangibility.
6240 ;; Ignore field boundaries if the initial and final
6241 ;; positions have the same `field' property, even if the
6242 ;; fields are non-contiguous. This seems to be "nicer"
6243 ;; behavior in many situations.
6246 new
6250 ;; If all this moved us to a different line,
6251 ;; retry everything within that new line.
6253 ;; Repeat the intangibility and field processing.
6257 "Try to find column COL, considering invisibility.
6258 This function works only in certain cases,
6259 because what we really need is for `move-to-column'
6260 and `current-column' to be able to ignore invisible text."
6269 ;; If the following character is currently invisible,
6270 ;; skip all characters with that same `invisible' property value.
6274 ;; Have we advanced to a larger column position?
6276 ;; We have made some progress towards the desired column.
6277 ;; See if we can make any further progress.
6279 ;; Otherwise, go to the place we originally found
6280 ;; and move back over invisible text.
6281 ;; that will get us to the same place on the screen
6282 ;; but with a more reasonable buffer position.
6285 ;; We want the real line beginning, so it's consistent
6286 ;; with bolp below, otherwise we might infloop.
6293 "Move point to end of current line as displayed.
6294 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6295 If point reaches the beginning or end of buffer, it stops there.
6297 To ignore the effects of the `intangible' text or overlay
6298 property, bind `inhibit-point-motion-hooks' to t.
6299 If there is an image in the current line, this function
6300 disregards newlines that are part of the text on which the image
6301 rests."
6311 ;; With bidi reordering, we may not be at bol,
6312 ;; so make sure we are.
6327 ;; If we skipped something intangible and now we're not
6328 ;; really at eol, keep going.
6333 "Move point to beginning of current line as displayed.
6334 \(If there's an image in the line, this disregards newlines
6335 which are part of the text that the image rests on.)
6337 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6338 If point reaches the beginning or end of buffer, it stops there.
6339 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6344 first-vis first-vis-field-value)
6346 ;; Move by lines, if ARG is not 1 (the default).
6351 ;; Move to beginning-of-line, ignoring fields and invisible text.
6357 ;; Now find first visible char in the line.
6362 ;; See if fields would stop us from reaching FIRST-VIS.
6367 ;; If yes, obey them.
6368 first-vis-field-value
6369 ;; Otherwise, move to START with attention to fields.
6370 ;; (It is possible that fields never matter in this case.)
6375 ;; Many people have said they rarely use this feature, and often type
6376 ;; it by accident. Maybe it shouldn't even be on a key.
6381 Those commands will move to this position in the line moved to
6382 rather than trying to keep the same horizontal position.
6383 With a non-nil argument ARG, clears out the goal column
6385 The goal column is stored in the variable `goal-column'."
6392 ;; The older method below can be erroneous if `set-goal-column' is bound
6393 ;; to a sequence containing %
6394 ;;(message (substitute-command-keys
6395 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6396 ;;goal-column)
6403 )
6404 nil)
6405 \f
6406 ;;; Editing based on visual lines, as opposed to logical lines.
6409 "Move point to end of current visual line.
6410 With argument N not nil or 1, move forward N - 1 visual lines first.
6411 If point reaches the beginning or end of buffer, it stops there.
6412 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6418 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6419 ;; constrain to field boundaries, so we don't either.
6423 "Move point to beginning of current visual line.
6424 With argument N not nil or 1, move forward N - 1 visual lines first.
6425 If point reaches the beginning or end of buffer, it stops there.
6426 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6434 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6438 "Kill the rest of the visual line.
6439 With prefix argument ARG, kill that many visual lines from point.
6440 If ARG is negative, kill visual lines backward.
6441 If ARG is zero, kill the text before point on the current visual
6442 line.
6444 If you want to append the killed line to the last killed text,
6447 If the buffer is read-only, Emacs will beep and refrain from deleting
6448 the line, but put the line in the kill ring anyway. This means that
6449 you can use this command to copy text from a read-only buffer.
6450 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6451 even beep.)"
6453 ;; Like in `kill-line', it's better to move point to the other end
6454 ;; of the kill before killing.
6462 ;; Skip any trailing whitespace at the end of the visual line.
6463 ;; We used to do this only if `show-trailing-whitespace' is
6464 ;; nil, but that's wrong; the correct thing would be to check
6465 ;; whether the trailing whitespace is highlighted. But, it's
6466 ;; OK to just do this unconditionally.
6473 "Move cursor vertically down ARG lines.
6474 This is identical to `next-line', except that it always moves
6475 by logical lines instead of visual lines, ignoring the value of
6476 the variable `line-move-visual'."
6483 "Move cursor vertically up ARG lines.
6484 This is identical to `previous-line', except that it always moves
6485 by logical lines instead of visual lines, ignoring the value of
6486 the variable `line-move-visual'."
6493 "Editing based on visual lines."
6502 ;; These keybindings interfere with xterm function keys. Are
6503 ;; there any other suitable bindings?
6504 ;; (define-key map "\M-[" 'previous-logical-line)
6505 ;; (define-key map "\M-]" 'next-logical-line)
6506 map))
6509 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6510 The value should be a list of the form (LEFT RIGHT), where LEFT
6511 and RIGHT are symbols representing the bitmaps to display, to
6512 indicate wrapped lines, in the left and right fringes respectively.
6513 See also `fringe-indicator-alist'.
6514 The default is not to display fringe indicators for wrapped lines.
6515 This variable does not affect fringe indicators displayed for
6516 other purposes."
6531 'continuation
6538 "Toggle visual line based editing (Visual Line mode).
6539 With a prefix argument ARG, enable Visual Line mode if ARG is
6540 positive, and disable it otherwise. If called from Lisp, enable
6541 the mode if ARG is omitted or nil.
6543 When Visual Line mode is enabled, `word-wrap' is turned on in
6544 this buffer, and simple editing commands are redefined to act on
6545 visual lines, not logical lines. See Info node `Visual Line
6546 Mode' for details."
6547 :keymap visual-line-mode-map
6553 ;; Save the local values of some variables, to be restored if
6554 ;; visual-line-mode is turned off.
6556 truncate-partial-width-windows
6557 word-wrap fringe-indicator-alist))
6560 visual-line--saved-state)))
6564 word-wrap t
6565 fringe-indicator-alist
6567 fringe-indicator-alist)))
6581 visual-line-mode turn-on-visual-line-mode)
6583 \f
6585 "Interchange characters around point, moving forward one character.
6586 With prefix arg ARG, effect is to take character before point
6587 and drag it forward past ARG other characters (backward if ARG negative).
6588 If no argument and at end of line, the previous two chars are exchanged."
6596 "Interchange words around point, leaving point at end of them.
6597 With prefix arg ARG, effect is to take word before or around point
6598 and drag it forward past ARG other words (backward if ARG negative).
6599 If ARG is zero, the words around or after point and around or after mark
6600 are interchanged."
6601 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6607 Does not work on a sexp that point is in the middle of
6608 if it is a list or string."
6612 ;; Here we should try to simulate the behavior of
6613 ;; (cons (progn (forward-sexp x) (point))
6614 ;; (progn (forward-sexp (- x)) (point)))
6615 ;; Except that we don't want to rely on the second forward-sexp
6616 ;; putting us back to where we want to be, since forward-sexp-function
6617 ;; might do funny things like infix-precedence.
6622 ;; Jumping over a symbol. We might be inside it, mind you.
6627 ;; Otherwise, we're between sexps. Take a step back before jumping
6628 ;; to make sure we'll obey the same precedence no matter which direction
6629 ;; we're going.
6634 'skip-syntax-forward
6641 "Exchange current line and previous line, leaving point after both.
6642 With argument ARG, takes previous line and moves it past ARG lines.
6643 With argument 0, interchanges line point is in with line mark is in."
6649 ;; Move forward over ARG lines,
6650 ;; but create newlines if necessary.
6657 arg))
6659 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6660 ;; which seems inconsistent with the ARG /= 0 case.
6661 ;; FIXME document SPECIAL.
6663 "Subroutine to do the work of transposing objects.
6664 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6665 moves forward by units of the given object (e.g. forward-sentence,
6666 forward-paragraph). If ARG is zero, exchanges the current object
6667 with the one containing mark. If ARG is an integer, moves the
6668 current object past ARG following (if ARG is positive) or
6669 preceding (if ARG is negative) objects, leaving point after the
6670 current object."
6675 pos1 pos2)
6704 ;; This sequence of insertions attempts to preserve marker
6705 ;; positions at the start and end of the transposed objects.
6719 \f
6721 "Move backward until encountering the beginning of a word.
6722 With argument ARG, do this that many times.
6723 If ARG is omitted or nil, move point backward one word."
6728 "Set mark ARG words away from point.
6730 move to with the same argument.
6731 Interactively, if this command is repeated
6732 or (in Transient Mark mode) if the mark is active,
6733 it marks the next ARG words after the ones already marked."
6750 nil t))))
6753 "Kill characters forward until encountering the end of a word.
6754 With argument ARG, do this that many times."
6759 "Kill characters backward until encountering the beginning of a word.
6760 With argument ARG, do this that many times."
6765 "Return the symbol or word that point is on (or a nearby one) as a string.
6766 The return value includes no text properties.
6767 If optional arg STRICT is non-nil, return nil unless point is within
6768 or adjacent to a symbol or word. In all cases the value can be nil
6769 if there is no word nearby.
6770 The function, belying its name, normally finds a symbol.
6771 If optional arg REALLY-WORD is non-nil, it finds just a word."
6780 ;; Point is neither within nor adjacent to a word.
6782 ;; Look for preceding word in same line.
6785 ;; No preceding word in same line.
6786 ;; Look for following word in same line.
6795 ;; If we found something nonempty, return it as a string.
6798 \f
6800 "String for filling to insert at front of new line, or nil for none."
6802 string)
6808 "Regexp to match lines which should not be auto-filled."
6810 regexp)
6814 "The default value for `normal-auto-fill-function'.
6815 This is the default auto-fill function, some major modes use a different one.
6816 Returns t if it really did any work."
6826 nil ;; Auto-filling not required
6830 ;; Choose a fill-prefix automatically.
6838 ;; Use auto-indentation rather than a guessed empty prefix.
6844 ;; Determine where to split the line.
6857 ;; See whether the place we found is any good.
6861 ;; There is no use breaking at end of line.
6863 ;; It is futile to split at the end of the prefix
6864 ;; since we would just insert the prefix again.
6866 ;; Don't split right after a comment starter
6867 ;; since we would just make another comment starter.
6872 limit t)
6874 ;; No good place to break => stop trying.
6876 ;; Ok, we have a useful place to break the line. Do it.
6878 ;; If point is at the fill-point, do not `save-excursion'.
6879 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6880 ;; point will end up before it rather than after it.
6888 ;; Now do justification, if required
6893 ;; If making the new line didn't reduce the hpos of
6894 ;; the end of the line, then give up now;
6895 ;; trying again will not help.
6898 ;; Justify last line.
6900 t)))
6903 "Mode-specific function which line breaks and continues a comment.
6904 This function is called during auto-filling when a comment syntax
6905 is defined.
6906 The function should take a single optional argument, which is a flag
6910 "Break line at point and indent.
6911 If a comment syntax is defined, call `comment-indent-new-line'.
6913 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6914 unless optional argument SOFT is non-nil."
6918 ;; Insert the newline before removing empty space so that markers
6919 ;; get preserved better.
6925 ;; Blindly trust a non-adaptive fill-prefix.
6931 ;; If there's an adaptive prefix, use it unless we're inside
6932 ;; a comment and the prefix is not a comment starter.
6936 ;; If we're not inside a comment, just try to indent.
6940 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6944 ;; `functions' and `hooks' are usually unsafe to set, but setting
6945 ;; auto-fill-function to nil in a file-local setting is safe and
6946 ;; can be useful to prevent auto-filling.
6950 "Toggle automatic line breaking (Auto Fill mode).
6951 With a prefix argument ARG, enable Auto Fill mode if ARG is
6952 positive, and disable it otherwise. If called from Lisp, enable
6953 the mode if ARG is omitted or nil.
6955 When Auto Fill mode is enabled, inserting a space at a column
6956 beyond `current-fill-column' automatically breaks the line at a
6957 previous space.
6959 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6960 non-nil.
6962 The value of `normal-auto-fill-function' specifies the function to use
6963 for `auto-fill-function' when turning Auto Fill mode on."
6968 ;; This holds a document string used to document auto-fill-mode.
6970 "Automatically break line at a previous space, in insertion of text."
6971 nil)
6974 "Unconditionally turn on Auto Fill mode."
6978 "Unconditionally turn off Auto Fill mode."
6984 "Set `fill-column' to specified argument.
6989 ;; We used to use current-column silently, but C-x f is too easily
6990 ;; typed as a typo for C-x C-f, so we turned it into an error and
6991 ;; now an interactive prompt.
6996 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7000 \f
7002 "Set `selective-display' to ARG; clear it if no arg.
7003 When the value of `selective-display' is a number > 0,
7004 lines whose indentation is >= that value are not displayed.
7005 The variable `selective-display' has a separate value for each buffer."
7025 "Toggle truncating of long lines for the current buffer.
7026 When truncating is off, long lines are folded.
7027 With prefix argument ARG, truncate long lines if ARG is positive,
7028 otherwise fold them. Note that in side-by-side windows, this
7029 command has no effect if `truncate-partial-width-windows' is
7030 non-nil."
7042 nil t)))
7047 "Toggle whether to use word-wrapping for continuation lines.
7048 With prefix argument ARG, wrap continuation lines at word boundaries
7049 if ARG is positive, otherwise wrap them at the right screen edge.
7050 This command toggles the value of `word-wrap'. It has no effect
7051 if long lines are truncated."
7067 "Toggle Overwrite mode.
7068 With a prefix argument ARG, enable Overwrite mode if ARG is
7069 positive, and disable it otherwise. If called from Lisp, enable
7070 the mode if ARG is omitted or nil.
7072 When Overwrite mode is enabled, printing characters typed in
7073 replace existing text on a one-for-one basis, rather than pushing
7074 it to the right. At the end of a line, such characters extend
7075 the line. Before a tab, such characters insert until the tab is
7077 overwrite mode; this is supposed to make it easier to insert
7078 characters when necessary."
7083 "Toggle Binary Overwrite mode.
7084 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7085 is positive, and disable it otherwise. If called from Lisp,
7086 enable the mode if ARG is omitted or nil.
7088 When Binary Overwrite mode is enabled, printing characters typed
7089 in replace existing text. Newlines are not treated specially, so
7090 typing at the end of a line joins the line to the next, with the
7091 typed character between them. Typing before a tab character
7092 simply replaces the tab with the character typed.
7094 ordinary typing characters do.
7096 Note that Binary Overwrite mode is not its own minor mode; it is
7097 a specialization of overwrite mode, entered by setting the
7098 `overwrite-mode' variable to `overwrite-mode-binary'."
7103 "Toggle line number display in the mode line (Line Number mode).
7104 With a prefix argument ARG, enable Line Number mode if ARG is
7105 positive, and disable it otherwise. If called from Lisp, enable
7106 the mode if ARG is omitted or nil.
7108 Line numbers do not appear for very large buffers and buffers
7109 with very long lines; see variables `line-number-display-limit'
7110 and `line-number-display-limit-width'."
7114 "Toggle column number display in the mode line (Column Number mode).
7115 With a prefix argument ARG, enable Column Number mode if ARG is
7116 positive, and disable it otherwise.
7118 If called from Lisp, enable the mode if ARG is omitted or nil."
7122 "Toggle buffer size display in the mode line (Size Indication mode).
7123 With a prefix argument ARG, enable Size Indication mode if ARG is
7124 positive, and disable it otherwise.
7126 If called from Lisp, enable the mode if ARG is omitted or nil."
7130 "Toggle auto-saving in the current buffer (Auto Save mode).
7131 With a prefix argument ARG, enable Auto Save mode if ARG is
7132 positive, and disable it otherwise.
7134 If called from Lisp, enable the mode if ARG is omitted or nil."
7136 ;; If auto-save is off because buffer has shrunk,
7137 ;; then toggling should turn it on.
7145 buffer-file-name)
7147 ;; If -1 was stored here, to temporarily turn off saving,
7148 ;; turn it back on.
7151 \f
7153 "Blinking matching of parens and expressions."
7158 "Non-nil means show matching open-paren when close-paren is inserted.
7159 If t, highlight the paren. If `jump', briefly move cursor to its
7160 position. If `jump-offscreen', move cursor there even if the
7161 position is off screen. With any other non-nil value, the
7162 off-screen position of the opening paren will be shown in the
7163 echo area."
7172 "Non-nil means show matching open-paren when it is on screen.
7173 If nil, don't show it (but the open-paren can still be shown
7174 in the echo area when it is off screen).
7176 This variable has no effect if `blink-matching-paren' is nil.
7177 \(In that case, the open-paren is never shown.)
7178 It is also ignored if `show-paren-mode' is enabled."
7183 "If non-nil, maximum distance to search backwards for matching open-paren.
7184 If nil, search stops at the beginning of the accessible portion of the buffer."
7190 "Time in seconds to delay after showing a matching paren."
7195 "If nil, `blink-matching-paren' ignores comments.
7196 More precisely, when looking for the matching parenthesis,
7197 it skips the contents of comments that end before point."
7202 "Return whether or not START...END are matching parens.
7203 END is the current point and START is the blink position.
7204 START might be nil if no matching starter was found.
7205 Returns non-nil if we find there is a mismatch."
7210 ;; For self-matched chars like " and $, we can't know when they're
7211 ;; mismatched or unmatched, so we can only do it for parens.
7216 ;; The cdr might hold a new paren-class info rather than
7217 ;; a matching-char info, in which case the two CDRs
7218 ;; should match.
7222 "Function to check parentheses mismatches.
7223 The function takes two arguments (START and END) where START is the
7224 position just before the opening token and END is the position right after.
7225 START can be nil, if it was not found.
7232 ol)
7236 "Momentarily highlight the beginning of the sexp before point."
7239 blink-matching-paren)
7249 oldpos))
7257 ;; backward-sexp skips backward over prefix chars,
7258 ;; so move back to the matching paren.
7281 ;; Matching open within window, temporarily move to or highlight
7282 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7283 ;; is non-nil.
7300 ;; Show what precedes the open in its line, if anything.
7305 ;; Show what follows the open in its line, if anything.
7312 ;; Otherwise show the previous nonblank line,
7313 ;; if there is one.
7322 ;; Replace the newline and other whitespace with `...'.
7323 "..."
7325 ;; There is nothing to show except the char itself.
7328 "Matches %s"
7332 "Function called, if non-nil, whenever a close parenthesis is inserted.
7338 blink-paren-function
7341 ;; Verify an even number of quoting characters precede the close.
7342 ;; FIXME: Also check if this parenthesis closes a comment as
7343 ;; can happen in Pascal and SML.
7354 ;; Most likely, this hook is nil, so this arg doesn't matter,
7355 ;; but I use it as a reminder that this function usually
7356 ;; likes to be run after others since it does
7357 ;; `sit-for'. That's also the reason it get a `priority' prop
7358 ;; of 100.
7360 \f
7361 ;; This executes C-g typed while Emacs is waiting for a command.
7362 ;; Quitting out of a program does not go through here;
7363 ;; that happens in the QUIT macro at the C code level.
7365 "Signal a `quit' condition.
7366 During execution of Lisp code, this character causes a quit directly.
7367 At top-level, as an editor command, this simply beeps."
7369 ;; Avoid adding the region to the window selection.
7377 ;; Force the next redisplay cycle to remove the "Def" indicator from
7378 ;; all the mode lines.
7392 This command can exit an interactive command such as `query-replace',
7393 can clear out a prefix argument or a region,
7394 can get out of the minibuffer or other recursive edit,
7395 cancel the use of the current buffer (for special-purpose buffers),
7396 or go back to just one window (by deleting all but the selected window)."
7404 nil)
7415 "Play sound stored in FILE.
7416 VOLUME and DEVICE correspond to the keywords of the sound
7417 specification for `play-sound'."
7427 \f
7429 "Your preference for a mail reading package.
7430 This is used by some keybindings which support reading mail.
7431 See also `mail-user-agent' concerning sending mail."
7441 "Your preference for a mail composition package.
7442 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7443 outgoing email message. This variable lets you specify which
7444 mail-sending package you prefer.
7446 Valid values include:
7448 `message-user-agent' -- use the Message package.
7449 See Info node `(message)'.
7450 `sendmail-user-agent' -- use the Mail package.
7451 See Info node `(emacs)Sending Mail'.
7452 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7453 See Info node `(mh-e)'.
7454 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7455 paraphernalia if Gnus is running, particularly
7456 the Gcc: header for archiving.
7458 Additional valid symbols may be available; check with the author of
7459 your package for details. The function should return non-nil if it
7460 succeeds.
7462 See also `read-mail-command' concerning reading mail."
7465 message-user-agent)
7468 sendmail-user-agent)
7471 mh-e-user-agent)
7474 gnus-user-agent)
7480 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7481 If the value of `mail-user-agent' is the default, and the user
7482 appears to have customizations applying to the old default,
7483 `compose-mail' issues a warning."
7489 "If the buffer starts with a mail header, move point to the header's end.
7490 Otherwise, moves to `point-min'.
7491 The end of the header is the start of the next line, if there is one,
7492 else the end of the last line. This function obeys RFC822."
7498 ;; Used by Rmail (e.g., rmail-forward).
7500 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7504 switch-function yank-action send-actions
7505 return-action)
7506 "Start composing a mail message to send.
7507 This uses the user's chosen mail composition package
7508 as selected with the variable `mail-user-agent'.
7509 The optional arguments TO and SUBJECT specify recipients
7510 and the initial Subject field, respectively.
7512 OTHER-HEADERS is an alist specifying additional
7513 header fields. Elements look like (HEADER . VALUE) where both
7514 HEADER and VALUE are strings.
7516 CONTINUE, if non-nil, says to continue editing a message already
7517 being composed. Interactively, CONTINUE is the prefix argument.
7519 SWITCH-FUNCTION, if non-nil, is a function to use to
7520 switch to and display the buffer used for mail composition.
7522 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7523 to insert the raw text of the message being replied to.
7524 It has the form (FUNCTION . ARGS). The user agent will apply
7525 FUNCTION to ARGS, to insert the raw text of the original message.
7526 \(The user agent will also run `mail-citation-hook', *after* the
7527 original text has been inserted in this way.)
7529 SEND-ACTIONS is a list of actions to call when the message is sent.
7530 Each action has the form (FUNCTION . ARGS).
7532 RETURN-ACTION, if non-nil, is an action for returning to the
7533 caller. It has the form (FUNCTION . ARGS). The function is
7534 called after the mail has been sent or put aside, and the mail
7535 buffer buried."
7539 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7540 ;; from sendmail-user-agent to message-user-agent. Some users may
7541 ;; encounter incompatibilities. This hack tries to detect problems
7542 ;; and warn about them.
7547 mail-yank-hooks mail-archive-file-name
7548 mail-default-reply-to mail-mailing-lists
7549 mail-self-blind))
7556 The default mail mode is now Message mode.
7557 You have the following Mail mode variable%s customized:
7559 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7566 yank-action send-actions return-action)))
7569 yank-action send-actions
7570 return-action)
7574 'switch-to-buffer-other-window yank-action send-actions
7575 return-action))
7578 yank-action send-actions
7579 return-action)
7583 'switch-to-buffer-other-frame yank-action send-actions
7584 return-action))
7586 \f
7588 "History of values entered with `set-variable'.
7590 Maximum length of the history list is determined by the value
7594 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7595 VARIABLE should be a user option variable name, a Lisp variable
7596 meant to be customized by users. You should enter VALUE in Lisp syntax,
7597 so if you want VALUE to be a string, you must surround it with doublequotes.
7598 VALUE is used literally, not evaluated.
7600 If VARIABLE has a `variable-interactive' property, that is used as if
7601 it were the arg to `interactive' (which see) to interactively read VALUE.
7603 If VARIABLE has been defined with `defcustom', then the type information
7604 in the definition is used to check that VALUE is valid.
7606 Note that this function is at heart equivalent to the basic `set' function.
7607 For a variable defined with `defcustom', it does not pay attention to
7608 any :set property that the variable might have (if you want that, use
7611 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7616 default-var)
7632 var obsolete)
7635 ;; Use VAR's `variable-interactive' property
7636 ;; as an interactive spec for prompting.
7639 arg))
7641 read-expression-map t
7642 'set-variable-value-history
7651 ;; Match with custom type.
7663 ;; Force a thorough redisplay for the case that the variable
7664 ;; has an effect on the display, like `tab-width' has.
7666 \f
7667 ;; Define the major mode for lists of completions.
7677 (define-key map [right] 'next-completion)
7679 (define-key map [backtab] 'previous-completion)
7680 (define-key map "q" 'quit-window)
7681 (define-key map "z" 'kill-this-buffer)
7682 map)
7683 "Local map for completion list buffers.")
7685 ;; Completion mode is suitable only for specially formatted data.
7686 (put 'completion-list-mode 'mode-class 'special)
7688 (defvar completion-reference-buffer nil
7689 "Record the buffer that was current when the completion list was requested.
7690 This is a local variable in the completion list buffer.
7691 Initial value is nil to avoid some compiler warnings.")
7693 (defvar completion-no-auto-exit nil
7694 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7695 This also applies to other functions such as `choose-completion'.")
7697 (defvar completion-base-position nil
7698 "Position of the base of the text corresponding to the shown completions.
7699 This variable is used in the *Completions* buffers.
7700 Its value is a list of the form (START END) where START is the place
7701 where the completion should be inserted and END (if non-nil) is the end
7702 of the text to replace. If END is nil, point is used instead.")
7704 (defvar completion-list-insert-choice-function #'completion--replace
7705 "Function to use to insert the text chosen in *Completions*.
7706 Called with three arguments (BEG END TEXT), it should replace the text
7707 between BEG and END with TEXT. Expected to be set buffer-locally
7708 in the *Completions* buffer.")
7710 (defvar completion-base-size nil
7711 "Number of chars before point not involved in completion.
7712 This is a local variable in the completion list buffer.
7713 It refers to the chars in the minibuffer if completing in the
7714 minibuffer, or in `completion-reference-buffer' otherwise.
7715 Only characters in the field at point are included.
7717 If nil, Emacs determines which part of the tail end of the
7718 buffer's text is involved in completion by comparing the text
7719 directly.")
7720 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7722 (defun delete-completion-window ()
7723 "Delete the completion list window.
7724 Go to the window from which completion was requested."
7725 (interactive)
7726 (let ((buf completion-reference-buffer))
7727 (if (one-window-p t)
7728 (if (window-dedicated-p) (delete-frame))
7729 (delete-window (selected-window))
7730 (if (get-buffer-window buf)
7731 (select-window (get-buffer-window buf))))))
7733 (defun previous-completion (n)
7734 "Move to the previous item in the completion list."
7735 (interactive "p")
7736 (next-completion (- n)))
7738 (defun next-completion (n)
7739 "Move to the next item in the completion list.
7740 With prefix argument N, move N items (negative N means move backward)."
7741 (interactive "p")
7742 (let ((beg (point-min)) (end (point-max)))
7743 (while (and (> n 0) (not (eobp)))
7744 ;; If in a completion, move to the end of it.
7745 (when (get-text-property (point) 'mouse-face)
7746 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7747 ;; Move to start of next one.
7748 (unless (get-text-property (point) 'mouse-face)
7749 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7750 (setq n (1- n)))
7751 (while (and (< n 0) (not (bobp)))
7752 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7753 ;; If in a completion, move to the start of it.
7754 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7755 (goto-char (previous-single-property-change
7756 (point) 'mouse-face nil beg)))
7757 ;; Move to end of the previous completion.
7758 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7759 (goto-char (previous-single-property-change
7760 (point) 'mouse-face nil beg)))
7761 ;; Move to the start of that one.
7762 (goto-char (previous-single-property-change
7763 (point) 'mouse-face nil beg))
7764 (setq n (1+ n))))))
7766 (defun choose-completion (&optional event)
7767 "Choose the completion at point.
7768 If EVENT, use EVENT's position to determine the starting position."
7769 (interactive (list last-nonmenu-event))
7770 ;; In case this is run via the mouse, give temporary modes such as
7771 ;; isearch a chance to turn off.
7772 (run-hooks 'mouse-leave-buffer-hook)
7773 (with-current-buffer (window-buffer (posn-window (event-start event)))
7774 (let ((buffer completion-reference-buffer)
7775 (base-size completion-base-size)
7776 (base-position completion-base-position)
7777 (insert-function completion-list-insert-choice-function)
7778 (choice
7779 (save-excursion
7780 (goto-char (posn-point (event-start event)))
7781 (let (beg end)
7782 (cond
7783 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7784 (setq end (point) beg (1+ (point))))
7785 ((and (not (bobp))
7786 (get-text-property (1- (point)) 'mouse-face))
7787 (setq end (1- (point)) beg (point)))
7788 (t (error "No completion here")))
7789 (setq beg (previous-single-property-change beg 'mouse-face))
7790 (setq end (or (next-single-property-change end 'mouse-face)
7791 (point-max)))
7792 (buffer-substring-no-properties beg end)))))
7794 (unless (buffer-live-p buffer)
7795 (error "Destination buffer is dead"))
7796 (quit-window nil (posn-window (event-start event)))
7798 (with-current-buffer buffer
7799 (choose-completion-string
7800 choice buffer
7801 (or base-position
7802 (when base-size
7803 ;; Someone's using old completion code that doesn't know
7804 ;; about base-position yet.
7805 (list (+ base-size (field-beginning))))
7806 ;; If all else fails, just guess.
7807 (list (choose-completion-guess-base-position choice)))
7808 insert-function)))))
7810 ;; Delete the longest partial match for STRING
7811 ;; that can be found before POINT.
7812 (defun choose-completion-guess-base-position (string)
7813 (save-excursion
7814 (let ((opoint (point))
7815 len)
7816 ;; Try moving back by the length of the string.
7817 (goto-char (max (- (point) (length string))
7818 (minibuffer-prompt-end)))
7819 ;; See how far back we were actually able to move. That is the
7820 ;; upper bound on how much we can match and delete.
7821 (setq len (- opoint (point)))
7822 (if completion-ignore-case
7823 (setq string (downcase string)))
7824 (while (and (> len 0)
7825 (let ((tail (buffer-substring (point) opoint)))
7826 (if completion-ignore-case
7827 (setq tail (downcase tail)))
7828 (not (string= tail (substring string 0 len)))))
7829 (setq len (1- len))
7830 (forward-char 1))
7831 (point))))
7833 (defun choose-completion-delete-max-match (string)
7834 (declare (obsolete choose-completion-guess-base-position "23.2"))
7835 (delete-region (choose-completion-guess-base-position string) (point)))
7837 (defvar choose-completion-string-functions nil
7838 "Functions that may override the normal insertion of a completion choice.
7839 These functions are called in order with three arguments:
7840 CHOICE - the string to insert in the buffer,
7841 BUFFER - the buffer in which the choice should be inserted,
7842 BASE-POSITION - where to insert the completion.
7844 If a function in the list returns non-nil, that function is supposed
7845 to have inserted the CHOICE in the BUFFER, and possibly exited
7846 the minibuffer; no further functions will be called.
7848 If all functions in the list return nil, that means to use
7849 the default method of inserting the completion in BUFFER.")
7851 (defun choose-completion-string (choice &optional
7852 buffer base-position insert-function)
7853 "Switch to BUFFER and insert the completion choice CHOICE.
7854 BASE-POSITION says where to insert the completion.
7855 INSERT-FUNCTION says how to insert the completion and falls
7856 back on `completion-list-insert-choice-function' when nil."
7858 ;; If BUFFER is the minibuffer, exit the minibuffer
7859 ;; unless it is reading a file name and CHOICE is a directory,
7860 ;; or completion-no-auto-exit is non-nil.
7862 ;; Some older code may call us passing `base-size' instead of
7863 ;; `base-position'. It's difficult to make any use of `base-size',
7864 ;; so we just ignore it.
7865 (unless (consp base-position)
7866 (message "Obsolete `base-size' passed to choose-completion-string")
7867 (setq base-position nil))
7869 (let* ((buffer (or buffer completion-reference-buffer))
7870 (mini-p (minibufferp buffer)))
7871 ;; If BUFFER is a minibuffer, barf unless it's the currently
7872 ;; active minibuffer.
7873 (if (and mini-p
7874 (not (and (active-minibuffer-window)
7875 (equal buffer
7876 (window-buffer (active-minibuffer-window))))))
7877 (error "Minibuffer is not active for completion")
7878 ;; Set buffer so buffer-local choose-completion-string-functions works.
7879 (set-buffer buffer)
7880 (unless (run-hook-with-args-until-success
7881 'choose-completion-string-functions
7882 ;; The fourth arg used to be `mini-p' but was useless
7883 ;; (since minibufferp can be used on the `buffer' arg)
7884 ;; and indeed unused. The last used to be `base-size', so we
7885 ;; keep it to try and avoid breaking old code.
7886 choice buffer base-position nil)
7887 ;; This remove-text-properties should be unnecessary since `choice'
7888 ;; comes from buffer-substring-no-properties.
7889 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7890 ;; Insert the completion into the buffer where it was requested.
7891 (funcall (or insert-function completion-list-insert-choice-function)
7892 (or (car base-position) (point))
7893 (or (cadr base-position) (point))
7894 choice)
7895 ;; Update point in the window that BUFFER is showing in.
7896 (let ((window (get-buffer-window buffer t)))
7897 (set-window-point window (point)))
7898 ;; If completing for the minibuffer, exit it with this choice.
7899 (and (not completion-no-auto-exit)
7900 (minibufferp buffer)
7901 minibuffer-completion-table
7902 ;; If this is reading a file name, and the file name chosen
7903 ;; is a directory, don't exit the minibuffer.
7904 (let* ((result (buffer-substring (field-beginning) (point)))
7905 (bounds
7906 (completion-boundaries result minibuffer-completion-table
7907 minibuffer-completion-predicate
7908 "")))
7909 (if (eq (car bounds) (length result))
7910 ;; The completion chosen leads to a new set of completions
7911 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7912 (let ((mini (active-minibuffer-window)))
7913 (select-window mini)
7914 (when minibuffer-auto-raise
7915 (raise-frame (window-frame mini))))
7916 (exit-minibuffer))))))))
7918 (define-derived-mode completion-list-mode nil "Completion List"
7919 "Major mode for buffers showing lists of possible completions.
7921 to select the completion near point.
7922 Or click to select one with the mouse.
7925 (set (make-local-variable 'completion-base-size) nil))
7927 (defun completion-list-mode-finish ()
7928 "Finish setup of the completions buffer.
7929 Called from `temp-buffer-show-hook'."
7930 (when (eq major-mode 'completion-list-mode)
7931 (setq buffer-read-only t)))
7933 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7936 ;; Variables and faces used in `completion-setup-function'.
7938 (defcustom completion-show-help t
7939 "Non-nil means show help message in *Completions* buffer."
7940 :type 'boolean
7941 :version "22.1"
7942 :group 'completion)
7944 ;; This function goes in completion-setup-hook, so that it is called
7945 ;; after the text of the completion list buffer is written.
7946 (defun completion-setup-function ()
7947 (let* ((mainbuf (current-buffer))
7948 (base-dir
7949 ;; FIXME: This is a bad hack. We try to set the default-directory
7950 ;; in the *Completions* buffer so that the relative file names
7951 ;; displayed there can be treated as valid file names, independently
7952 ;; from the completion context. But this suffers from many problems:
7953 ;; - It's not clear when the completions are file names. With some
7954 ;; completion tables (e.g. bzr revision specs), the listed
7955 ;; completions can mix file names and other things.
7956 ;; - It doesn't pay attention to possible quoting.
7957 ;; - With fancy completion styles, the code below will not always
7958 ;; find the right base directory.
7959 (if minibuffer-completing-file-name
7960 (file-name-as-directory
7961 (expand-file-name
7962 (buffer-substring (minibuffer-prompt-end)
7963 (- (point) (or completion-base-size 0))))))))
7964 (with-current-buffer standard-output
7965 (let ((base-size completion-base-size) ;Read before killing localvars.
7966 (base-position completion-base-position)
7967 (insert-fun completion-list-insert-choice-function))
7968 (completion-list-mode)
7969 (set (make-local-variable 'completion-base-size) base-size)
7970 (set (make-local-variable 'completion-base-position) base-position)
7971 (set (make-local-variable 'completion-list-insert-choice-function)
7972 insert-fun))
7973 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7974 (if base-dir (setq default-directory base-dir))
7975 ;; Maybe insert help string.
7976 (when completion-show-help
7977 (goto-char (point-min))
7978 (if (display-mouse-p)
7980 (insert (substitute-command-keys
7984 (add-hook 'completion-setup-hook 'completion-setup-function)
7986 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7987 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7989 (defun switch-to-completions ()
7990 "Select the completion list window."
7991 (interactive)
7992 (let ((window (or (get-buffer-window "*Completions*" 0)
7993 ;; Make sure we have a completions window.
7994 (progn (minibuffer-completion-help)
7995 (get-buffer-window "*Completions*" 0)))))
7996 (when window
7997 (select-window window)
7998 ;; In the new buffer, go to the first completion.
7999 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8000 (when (bobp)
8001 (next-completion 1)))))
8002 \f
8003 ;;; Support keyboard commands to turn on various modifiers.
8005 ;; These functions -- which are not commands -- each add one modifier
8006 ;; to the following event.
8008 (defun event-apply-alt-modifier (_ignore-prompt)
8011 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8012 (defun event-apply-super-modifier (_ignore-prompt)
8015 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8016 (defun event-apply-hyper-modifier (_ignore-prompt)
8019 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8020 (defun event-apply-shift-modifier (_ignore-prompt)
8023 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8024 (defun event-apply-control-modifier (_ignore-prompt)
8027 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8028 (defun event-apply-meta-modifier (_ignore-prompt)
8031 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8033 (defun event-apply-modifier (event symbol lshiftby prefix)
8034 "Apply a modifier flag to event EVENT.
8035 SYMBOL is the name of this modifier, as a symbol.
8036 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8037 PREFIX is the string that represents this modifier in an event type symbol."
8038 (if (numberp event)
8039 (cond ((eq symbol 'control)
8040 (if (and (<= (downcase event) ?z)
8041 (>= (downcase event) ?a))
8042 (- (downcase event) ?a -1)
8043 (if (and (<= (downcase event) ?Z)
8044 (>= (downcase event) ?A))
8045 (- (downcase event) ?A -1)
8046 (logior (lsh 1 lshiftby) event))))
8047 ((eq symbol 'shift)
8048 (if (and (<= (downcase event) ?z)
8049 (>= (downcase event) ?a))
8050 (upcase event)
8051 (logior (lsh 1 lshiftby) event)))
8052 (t
8053 (logior (lsh 1 lshiftby) event)))
8054 (if (memq symbol (event-modifiers event))
8055 event
8056 (let ((event-type (if (symbolp event) event (car event))))
8057 (setq event-type (intern (concat prefix (symbol-name event-type))))
8058 (if (symbolp event)
8059 event-type
8060 (cons event-type (cdr event)))))))
8062 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8063 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8064 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8065 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8066 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8067 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8068 \f
8069 ;;;; Keypad support.
8071 ;; Make the keypad keys act like ordinary typing keys. If people add
8072 ;; bindings for the function key symbols, then those bindings will
8073 ;; override these, so this shouldn't interfere with any existing
8074 ;; bindings.
8076 ;; Also tell read-char how to handle these keys.
8077 (mapc
8078 (lambda (keypad-normal)
8079 (let ((keypad (nth 0 keypad-normal))
8080 (normal (nth 1 keypad-normal)))
8081 (put keypad 'ascii-character normal)
8082 (define-key function-key-map (vector keypad) (vector normal))))
8083 ;; See also kp-keys bound in bindings.el.
8084 '((kp-space ?\s)
8087 (kp-separator ?,)
8088 (kp-equal ?=)
8089 ;; Do the same for various keys that are represented as symbols under
8090 ;; GUIs but naturally correspond to characters.
8091 (backspace 127)
8092 (delete 127)
8095 (clear ?\C-l)
8096 (return ?\C-m)
8097 (escape ?\e)
8098 ))
8099 \f
8100 ;;;;
8101 ;;;; forking a twin copy of a buffer.
8102 ;;;;
8104 (defvar clone-buffer-hook nil
8105 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8107 (defvar clone-indirect-buffer-hook nil
8108 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8110 (defun clone-process (process &optional newname)
8111 "Create a twin copy of PROCESS.
8112 If NEWNAME is nil, it defaults to PROCESS' name;
8113 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8114 If PROCESS is associated with a buffer, the new process will be associated
8115 with the current buffer instead.
8116 Returns nil if PROCESS has already terminated."
8117 (setq newname (or newname (process-name process)))
8119 (setq newname (substring newname 0 (match-beginning 0))))
8120 (when (memq (process-status process) '(run stop open))
8121 (let* ((process-connection-type (process-tty-name process))
8122 (new-process
8123 (if (memq (process-status process) '(open))
8124 (let ((args (process-contact process t)))
8125 (setq args (plist-put args :name newname))
8126 (setq args (plist-put args :buffer
8127 (if (process-buffer process)
8128 (current-buffer))))
8129 (apply 'make-network-process args))
8130 (apply 'start-process newname
8131 (if (process-buffer process) (current-buffer))
8132 (process-command process)))))
8133 (set-process-query-on-exit-flag
8134 new-process (process-query-on-exit-flag process))
8135 (set-process-inherit-coding-system-flag
8136 new-process (process-inherit-coding-system-flag process))
8137 (set-process-filter new-process (process-filter process))
8138 (set-process-sentinel new-process (process-sentinel process))
8139 (set-process-plist new-process (copy-sequence (process-plist process)))
8140 new-process)))
8142 ;; things to maybe add (currently partly covered by `funcall mode'):
8143 ;; - syntax-table
8144 ;; - overlays
8145 (defun clone-buffer (&optional newname display-flag)
8146 "Create and return a twin copy of the current buffer.
8147 Unlike an indirect buffer, the new buffer can be edited
8148 independently of the old one (if it is not read-only).
8149 NEWNAME is the name of the new buffer. It may be modified by
8150 adding or incrementing <N> at the end as necessary to create a
8151 unique buffer name. If nil, it defaults to the name of the
8152 current buffer, with the proper suffix. If DISPLAY-FLAG is
8153 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8154 clone a file-visiting buffer, or a buffer whose major mode symbol
8155 has a non-nil `no-clone' property, results in an error.
8157 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8158 current buffer with appropriate suffix. However, if a prefix
8159 argument is given, then the command prompts for NEWNAME in the
8160 minibuffer.
8162 This runs the normal hook `clone-buffer-hook' in the new buffer
8163 after it has been set up properly in other respects."
8164 (interactive
8165 (progn
8166 (if buffer-file-name
8167 (error "Cannot clone a file-visiting buffer"))
8168 (if (get major-mode 'no-clone)
8169 (error "Cannot clone a buffer in %s mode" mode-name))
8170 (list (if current-prefix-arg
8171 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8172 t)))
8173 (if buffer-file-name
8174 (error "Cannot clone a file-visiting buffer"))
8175 (if (get major-mode 'no-clone)
8176 (error "Cannot clone a buffer in %s mode" mode-name))
8177 (setq newname (or newname (buffer-name)))
8179 (setq newname (substring newname 0 (match-beginning 0))))
8180 (let ((buf (current-buffer))
8181 (ptmin (point-min))
8182 (ptmax (point-max))
8183 (pt (point))
8184 (mk (if mark-active (mark t)))
8185 (modified (buffer-modified-p))
8186 (mode major-mode)
8187 (lvars (buffer-local-variables))
8188 (process (get-buffer-process (current-buffer)))
8189 (new (generate-new-buffer (or newname (buffer-name)))))
8190 (save-restriction
8191 (widen)
8192 (with-current-buffer new
8193 (insert-buffer-substring buf)))
8194 (with-current-buffer new
8195 (narrow-to-region ptmin ptmax)
8196 (goto-char pt)
8197 (if mk (set-mark mk))
8198 (set-buffer-modified-p modified)
8200 ;; Clone the old buffer's process, if any.
8201 (when process (clone-process process))
8203 ;; Now set up the major mode.
8204 (funcall mode)
8206 ;; Set up other local variables.
8207 (mapc (lambda (v)
8208 (condition-case () ;in case var is read-only
8209 (if (symbolp v)
8210 (makunbound v)
8211 (set (make-local-variable (car v)) (cdr v)))
8212 (error nil)))
8213 lvars)
8215 ;; Run any hooks (typically set up by the major mode
8216 ;; for cloning to work properly).
8217 (run-hooks 'clone-buffer-hook))
8218 (if display-flag
8219 ;; Presumably the current buffer is shown in the selected frame, so
8220 ;; we want to display the clone elsewhere.
8221 (let ((same-window-regexps nil)
8222 (same-window-buffer-names))
8223 (pop-to-buffer new)))
8224 new))
8227 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8228 "Create an indirect buffer that is a twin copy of the current buffer.
8230 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8231 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8232 or if not called with a prefix arg, NEWNAME defaults to the current
8233 buffer's name. The name is modified by adding a `<N>' suffix to it
8234 or by incrementing the N in an existing suffix. Trying to clone a
8235 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8236 property results in an error.
8238 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8239 This is always done when called interactively.
8241 Optional third arg NORECORD non-nil means do not put this buffer at the
8242 front of the list of recently selected ones.
8244 Returns the newly created indirect buffer."
8245 (interactive
8246 (progn
8247 (if (get major-mode 'no-clone-indirect)
8248 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8249 (list (if current-prefix-arg
8250 (read-buffer "Name of indirect buffer: " (current-buffer)))
8251 t)))
8252 (if (get major-mode 'no-clone-indirect)
8253 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8254 (setq newname (or newname (buffer-name)))
8256 (setq newname (substring newname 0 (match-beginning 0))))
8257 (let* ((name (generate-new-buffer-name newname))
8258 (buffer (make-indirect-buffer (current-buffer) name t)))
8259 (with-current-buffer buffer
8260 (run-hooks 'clone-indirect-buffer-hook))
8261 (when display-flag
8262 (pop-to-buffer buffer norecord))
8263 buffer))
8266 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8267 "Like `clone-indirect-buffer' but display in another window."
8268 (interactive
8269 (progn
8270 (if (get major-mode 'no-clone-indirect)
8271 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8272 (list (if current-prefix-arg
8273 (read-buffer "Name of indirect buffer: " (current-buffer)))
8274 t)))
8275 (let ((pop-up-windows t))
8276 (clone-indirect-buffer newname display-flag norecord)))
8278 \f
8279 ;;; Handling of Backspace and Delete keys.
8281 (defcustom normal-erase-is-backspace 'maybe
8282 "Set the default behavior of the Delete and Backspace keys.
8284 If set to t, Delete key deletes forward and Backspace key deletes
8285 backward.
8287 If set to nil, both Delete and Backspace keys delete backward.
8289 If set to `maybe' (which is the default), Emacs automatically
8290 selects a behavior. On window systems, the behavior depends on
8291 the keyboard used. If the keyboard has both a Backspace key and
8292 a Delete key, and both are mapped to their usual meanings, the
8293 option's default value is set to t, so that Backspace can be used
8294 to delete backward, and Delete can be used to delete forward.
8296 If not running under a window system, customizing this option
8297 accomplishes a similar effect by mapping C-h, which is usually
8298 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8299 via `keyboard-translate'. The former functionality of C-h is
8300 available on the F1 key. You should probably not use this
8301 setting if you don't have both Backspace, Delete and F1 keys.
8303 Setting this variable with setq doesn't take effect. Programmatically,
8304 call `normal-erase-is-backspace-mode' (which see) instead."
8305 :type '(choice (const :tag "Off" nil)
8306 (const :tag "Maybe" maybe)
8307 (other :tag "On" t))
8308 :group 'editing-basics
8309 :version "21.1"
8310 :set (lambda (symbol value)
8311 ;; The fboundp is because of a problem with :set when
8312 ;; dumping Emacs. It doesn't really matter.
8313 (if (fboundp 'normal-erase-is-backspace-mode)
8314 (normal-erase-is-backspace-mode (or value 0))
8315 (set-default symbol value))))
8317 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8318 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8319 (unless frame (setq frame (selected-frame)))
8320 (with-selected-frame frame
8321 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8322 (normal-erase-is-backspace-mode
8323 (if (if (eq normal-erase-is-backspace 'maybe)
8324 (and (not noninteractive)
8325 (or (memq system-type '(ms-dos windows-nt))
8326 (memq window-system '(w32 ns))
8327 (and (memq window-system '(x))
8328 (fboundp 'x-backspace-delete-keys-p)
8329 (x-backspace-delete-keys-p))
8330 ;; If the terminal Emacs is running on has erase char
8331 ;; set to ^H, use the Backspace key for deleting
8332 ;; backward, and the Delete key for deleting forward.
8333 (and (null window-system)
8334 (eq tty-erase-char ?\^H))))
8335 normal-erase-is-backspace)
8336 1 0)))))
8338 (define-minor-mode normal-erase-is-backspace-mode
8339 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8340 With a prefix argument ARG, enable this feature if ARG is
8341 positive, and disable it otherwise. If called from Lisp, enable
8342 the mode if ARG is omitted or nil.
8344 On window systems, when this mode is on, Delete is mapped to C-d
8345 and Backspace is mapped to DEL; when this mode is off, both
8346 Delete and Backspace are mapped to DEL. (The remapping goes via
8347 `local-function-key-map', so binding Delete or Backspace in the
8348 global or local keymap will override that.)
8350 In addition, on window systems, the bindings of C-Delete, M-Delete,
8351 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8352 the global keymap in accordance with the functionality of Delete and
8353 Backspace. For example, if Delete is remapped to C-d, which deletes
8354 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8355 to DEL, which deletes backward, C-Delete is bound to
8356 `backward-kill-word'.
8358 If not running on a window system, a similar effect is accomplished by
8359 remapping C-h (normally produced by the Backspace key) and DEL via
8360 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8361 to C-d; if it's off, the keys are not remapped.
8363 When not running on a window system, and this mode is turned on, the
8364 former functionality of C-h is available on the F1 key. You should
8365 probably not turn on this mode on a text-only terminal if you don't
8366 have both Backspace, Delete and F1 keys.
8368 See also `normal-erase-is-backspace'."
8369 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8370 . (lambda (v)
8371 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8372 (if v 1 0))))
8373 (let ((enabled (eq 1 (terminal-parameter
8374 nil 'normal-erase-is-backspace))))
8376 (cond ((or (memq window-system '(x w32 ns pc))
8377 (memq system-type '(ms-dos windows-nt)))
8378 (let ((bindings
8379 `(([M-delete] [M-backspace])
8380 ([C-M-delete] [C-M-backspace])
8381 ([?\e C-delete] [?\e C-backspace]))))
8383 (if enabled
8384 (progn
8385 (define-key local-function-key-map [delete] [deletechar])
8386 (define-key local-function-key-map [kp-delete] [deletechar])
8387 (define-key local-function-key-map [backspace] [?\C-?])
8388 (dolist (b bindings)
8389 ;; Not sure if input-decode-map is really right, but
8390 ;; keyboard-translate-table (used below) only works
8391 ;; for integer events, and key-translation-table is
8392 ;; global (like the global-map, used earlier).
8393 (define-key input-decode-map (car b) nil)
8394 (define-key input-decode-map (cadr b) nil)))
8395 (define-key local-function-key-map [delete] [?\C-?])
8396 (define-key local-function-key-map [kp-delete] [?\C-?])
8397 (define-key local-function-key-map [backspace] [?\C-?])
8398 (dolist (b bindings)
8399 (define-key input-decode-map (car b) (cadr b))
8400 (define-key input-decode-map (cadr b) (car b))))))
8401 (t
8402 (if enabled
8403 (progn
8404 (keyboard-translate ?\C-h ?\C-?)
8405 (keyboard-translate ?\C-? ?\C-d))
8406 (keyboard-translate ?\C-h ?\C-h)
8407 (keyboard-translate ?\C-? ?\C-?))))
8409 (if (called-interactively-p 'interactive)
8410 (message "Delete key deletes %s"
8411 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8412 "forward" "backward")))))
8413 \f
8414 (defvar vis-mode-saved-buffer-invisibility-spec nil
8415 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8417 (define-minor-mode read-only-mode
8418 "Change whether the current buffer is read-only.
8419 With prefix argument ARG, make the buffer read-only if ARG is
8420 positive, otherwise make it writable. If buffer is read-only
8421 and `view-read-only' is non-nil, enter view mode.
8423 Do not call this from a Lisp program unless you really intend to
8425 possibly enabling or disabling View mode. Also, note that this
8426 command works by setting the variable `buffer-read-only', which
8427 does not affect read-only regions caused by text properties. To
8428 ignore read-only status in a Lisp program (whether due to text
8429 properties or buffer state), bind `inhibit-read-only' temporarily
8430 to a non-nil value."
8431 :variable buffer-read-only
8432 (cond
8433 ((and (not buffer-read-only) view-mode)
8434 (View-exit-and-edit)
8435 (make-local-variable 'view-read-only)
8436 (setq view-read-only t)) ; Must leave view mode.
8437 ((and buffer-read-only view-read-only
8438 ;; If view-mode is already active, `view-mode-enter' is a nop.
8439 (not view-mode)
8440 (not (eq (get major-mode 'mode-class) 'special)))
8441 (view-mode-enter))))
8443 (define-minor-mode visible-mode
8444 "Toggle making all invisible text temporarily visible (Visible mode).
8445 With a prefix argument ARG, enable Visible mode if ARG is
8446 positive, and disable it otherwise. If called from Lisp, enable
8447 the mode if ARG is omitted or nil.
8449 This mode works by saving the value of `buffer-invisibility-spec'
8450 and setting it to nil."
8451 :lighter " Vis"
8452 :group 'editing-basics
8453 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8454 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8455 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8456 (when visible-mode
8457 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8458 buffer-invisibility-spec)
8459 (setq buffer-invisibility-spec nil)))
8460 \f
8461 (defvar messages-buffer-mode-map
8462 (let ((map (make-sparse-keymap)))
8463 (set-keymap-parent map special-mode-map)
8464 (define-key map "g" nil) ; nothing to revert
8465 map))
8467 (define-derived-mode messages-buffer-mode special-mode "Messages"
8470 (defun messages-buffer ()
8472 If it does not exist, create and it switch it to `messages-buffer-mode'."
8473 (or (get-buffer "*Messages*")
8474 (with-current-buffer (get-buffer-create "*Messages*")
8475 (messages-buffer-mode)
8476 (current-buffer))))
8478 \f
8479 ;; Minibuffer prompt stuff.
8481 ;;(defun minibuffer-prompt-modification (start end)
8482 ;; (error "You cannot modify the prompt"))
8483 ;;
8484 ;;
8485 ;;(defun minibuffer-prompt-insertion (start end)
8486 ;; (let ((inhibit-modification-hooks t))
8487 ;; (delete-region start end)
8488 ;; ;; Discard undo information for the text insertion itself
8489 ;; ;; and for the text deletion.above.
8490 ;; (when (consp buffer-undo-list)
8491 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8492 ;; (message "You cannot modify the prompt")))
8493 ;;
8494 ;;
8495 ;;(setq minibuffer-prompt-properties
8496 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8497 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8499 \f
8500 ;;;; Problematic external packages.
8502 ;; rms says this should be done by specifying symbols that define
8503 ;; versions together with bad values. This is therefore not as
8504 ;; flexible as it could be. See the thread:
8505 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8506 (defconst bad-packages-alist
8507 ;; Not sure exactly which semantic versions have problems.
8508 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8510 "The version of `semantic' loaded does not work in Emacs 22.
8511 It can cause constant high CPU load.
8512 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8513 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8514 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8515 ;; provided the `CUA-mode' feature. Since this is no longer true,
8516 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8517 (CUA-mode t nil
8518 "CUA-mode is now part of the standard GNU Emacs distribution,
8519 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8521 You have loaded an older version of CUA-mode which does not work
8522 correctly with this version of Emacs. You should remove the old
8523 version and use the one distributed with Emacs."))
8524 "Alist of packages known to cause problems in this version of Emacs.
8525 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8526 PACKAGE is either a regular expression to match file names, or a
8527 symbol (a feature name), like for `with-eval-after-load'.
8528 SYMBOL is either the name of a string variable, or t. Upon
8529 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8530 warning using STRING as the message.")
8532 (defun bad-package-check (package)
8533 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8534 (condition-case nil
8535 (let* ((list (assoc package bad-packages-alist))
8536 (symbol (nth 1 list)))
8537 (and list
8538 (boundp symbol)
8539 (or (eq symbol t)
8540 (and (stringp (setq symbol (eval symbol)))
8541 (string-match-p (nth 2 list) symbol)))
8542 (display-warning package (nth 3 list) :warning)))
8543 (error nil)))
8545 (dolist (elem bad-packages-alist)
8546 (let ((pkg (car elem)))
8547 (with-eval-after-load pkg
8548 (bad-package-check pkg))))
8550 \f
8551 ;;; Generic dispatcher commands
8553 ;; Macro `define-alternatives' is used to create generic commands.
8554 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8555 ;; that can have different alternative implementations where choosing
8556 ;; among them is exclusively a matter of user preference.
8558 ;; (define-alternatives COMMAND) creates a new interactive command
8559 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8560 ;; Typically, the user will not need to customize this variable; packages
8561 ;; wanting to add alternative implementations should use
8562 ;;
8563 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8565 (defmacro define-alternatives (command &rest customizations)
8566 "Define the new command `COMMAND'.
8568 The argument `COMMAND' should be a symbol.
8570 Running `M-x COMMAND RET' for the first time prompts for which
8571 alternative to use and records the selected command as a custom
8572 variable.
8574 Running `C-u M-x COMMAND RET' prompts again for an alternative
8575 and overwrites the previous choice.
8577 The variable `COMMAND-alternatives' contains an alist with
8578 alternative implementations of COMMAND. `define-alternatives'
8579 does not have any effect until this variable is set.
8581 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8582 `defcustom' keywords and values to add to the declaration of
8583 `COMMAND-alternatives' (typically :group and :version)."
8584 (let* ((command-name (symbol-name command))
8585 (varalt-name (concat command-name "-alternatives"))
8586 (varalt-sym (intern varalt-name))
8587 (varimp-sym (intern (concat command-name "--implementation"))))
8588 `(progn
8590 (defcustom ,varalt-sym nil
8591 ,(format "Alist of alternative implementations for the `%s' command.
8593 Each entry must be a pair (ALTNAME . ALTFUN), where:
8594 ALTNAME - The name shown at user to describe the alternative implementation.
8595 ALTFUN - The function called to implement this alternative."
8596 command-name)
8597 :type '(alist :key-type string :value-type function)
8598 ,@customizations)
8600 (put ',varalt-sym 'definition-name ',command)
8601 (defvar ,varimp-sym nil "Internal use only.")
8603 (defun ,command (&optional arg)
8604 ,(format "Run generic command `%s'.
8605 If used for the first time, or with interactive ARG, ask the user which
8606 implementation to use for `%s'. The variable `%s'
8607 contains the list of implementations currently supported for this command."
8608 command-name command-name varalt-name)
8609 (interactive "P")
8610 (when (or arg (null ,varimp-sym))
8611 (let ((val (completing-read
8612 ,(format-message
8613 "Select implementation for command `%s': "
8614 command-name)
8615 ,varalt-sym nil t)))
8616 (unless (string-equal val "")
8617 (when (null ,varimp-sym)
8618 (message
8619 "Use C-u M-x %s RET`to select another implementation"
8620 ,command-name)
8621 (sit-for 3))
8622 (customize-save-variable ',varimp-sym
8623 (cdr (assoc-string val ,varalt-sym))))))
8624 (if ,varimp-sym
8625 (call-interactively ,varimp-sym)
8626 (message "%s" ,(format-message
8627 "No implementation selected for command `%s'"
8628 command-name)))))))
8630 \f
8631 ;;; Functions for changing capitalization that Do What I Mean
8632 (defun upcase-dwim (arg)
8633 "Upcase words in the region, if active; if not, upcase word at point.
8634 If the region is active, this function calls `upcase-region'.
8635 Otherwise, it calls `upcase-word', with prefix argument passed to it
8636 to upcase ARG words."
8637 (interactive "*p")
8638 (if (use-region-p)
8639 (upcase-region (region-beginning) (region-end))
8640 (upcase-word arg)))
8642 (defun downcase-dwim (arg)
8643 "Downcase words in the region, if active; if not, downcase word at point.
8644 If the region is active, this function calls `downcase-region'.
8645 Otherwise, it calls `downcase-word', with prefix argument passed to it
8646 to downcase ARG words."
8647 (interactive "*p")
8648 (if (use-region-p)
8649 (downcase-region (region-beginning) (region-end))
8650 (downcase-word arg)))
8652 (defun capitalize-dwim (arg)
8653 "Capitalize words in the region, if active; if not, capitalize word at point.
8654 If the region is active, this function calls `capitalize-region'.
8655 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8656 to capitalize ARG words."
8657 (interactive "*p")
8658 (if (use-region-p)
8659 (capitalize-region (region-beginning) (region-end))
8660 (capitalize-word arg)))
8662 \f
8664 (provide 'simple)
8666 ;;; simple.el ends here