| blob | 1db14a859d616e643c326f59e2cbc11a8fba7c30 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2017 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "If non-nil, output buffer is not erased between shell commands.
42 Also, a non-nil value set the point in the output buffer
43 once the command complete.
44 The value `beg-last-out' set point at the beginning of the output,
45 `end-last-out' set point at the end of the buffer, `save-point'
46 restore the buffer position before the command."
56 "Point position in the output buffer after command complete.
57 It is an alist (BUFFER . POS), where BUFFER is the output
58 buffer, and POS is the point position in BUFFER once the command finish.
62 "Idle time delay before updating various things on the screen.
63 Various Emacs features that update auxiliary information when point moves
64 wait this many seconds after Emacs becomes idle before doing an update."
70 "Killing and yanking commands."
74 "Highlight (un)matching of parens and expressions."
76 \f
77 ;;; next-error support framework
80 "`next-error' support framework."
86 "Face used to highlight next error locus."
91 "Highlighting of locations in selected source buffers.
92 If a number, highlight the locus in `next-error' face for the given time
93 in seconds, or until the next command is executed.
94 If t, highlight the locus until the next command is executed, or until
95 some other locus replaces it.
96 If nil, don't highlight the locus in the source buffer.
97 If `fringe-arrow', indicate the locus by the fringe arrow
98 indefinitely until some other locus replaces it."
107 "Highlighting of locations in `next-error-no-select'.
108 If number, highlight the locus in `next-error' face for given time in seconds.
109 If t, highlight the locus indefinitely until some other locus replaces it.
110 If nil, don't highlight the locus in the source buffer.
111 If `fringe-arrow', indicate the locus by the fringe arrow
112 indefinitely until some other locus replaces it."
121 "Display the line in the visited source file recentered as specified.
122 If non-nil, the value is passed directly to `recenter'."
130 "List of hook functions run by `next-error' after visiting source file."
141 "The most recent `next-error' buffer.
142 A buffer becomes most recent when its compilation, grep, or
147 "Function to use to find the next error in the current buffer.
148 The function is called with 2 parameters:
149 ARG is an integer specifying by how many errors to move.
150 RESET is a boolean which, if non-nil, says to go back to the beginning
151 of the errors before moving.
152 Major modes providing compile-like functionality should set this variable
153 to indicate to `next-error' that this is a candidate buffer and how
158 "Function to use to move to an error locus.
159 It takes two arguments, a buffer position in the error buffer
160 and a buffer position in the error locus buffer.
161 The buffer for the error locus should already be current.
166 &optional avoid-current
167 extra-test-inclusive
168 extra-test-exclusive)
169 "Return non-nil if BUFFER is a `next-error' capable buffer.
170 If AVOID-CURRENT is non-nil, and BUFFER is the current buffer,
171 return nil.
173 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if
174 BUFFER would not normally qualify. If it returns non-nil, BUFFER
175 is considered `next-error' capable, anyway, and the function
176 returns non-nil.
178 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the
179 buffer would normally qualify. If it returns nil, BUFFER is
180 rejected, and the function returns nil."
185 ;; Optionally reject some buffers.
188 t)
189 ;; Optionally accept some other buffers.
194 extra-test-inclusive
195 extra-test-exclusive)
196 "Return a `next-error' capable buffer.
198 If AVOID-CURRENT is non-nil, treat the current buffer
199 as an absolute last resort only.
201 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
202 that normally would not qualify. If it returns t, the buffer
203 in question is treated as usable.
205 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
206 that would normally be considered usable. If it returns nil,
207 that buffer is rejected."
209 ;; 1. If one window on the selected frame displays such buffer, return it.
215 avoid-current
216 extra-test-inclusive extra-test-exclusive)
221 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
224 extra-test-inclusive extra-test-exclusive))
225 next-error-last-buffer)
226 ;; 3. If the current buffer is acceptable, choose it.
228 extra-test-inclusive extra-test-exclusive)
230 ;; 4. Look for any acceptable buffer.
235 extra-test-inclusive extra-test-exclusive)))
238 ;; 5. Use the current buffer as a last resort if it qualifies,
239 ;; even despite AVOID-CURRENT.
242 extra-test-inclusive extra-test-exclusive)
246 ;; 6. Give up.
250 "Visit next `next-error' message and corresponding source code.
252 If all the error messages parsed so far have been processed already,
253 the message buffer is checked for new ones.
255 A prefix ARG specifies how many error messages to move;
256 negative means move back to previous error messages.
258 and start at the first error.
260 The RESET argument specifies that we should restart from the beginning.
263 compilation, grep, or occur buffer. It can also operate on any
265 more generally, on any buffer in Compilation mode or with
266 Compilation Minor mode enabled, or any buffer in which
267 `next-error-function' is bound to an appropriate function.
268 To specify use of a particular buffer for error messages, type
270 in the current frame.
273 runs `next-error-hook' with `run-hooks', and stays with that buffer
274 until you use it in some other buffer which uses Compilation mode
275 or Compilation Minor mode.
277 To control which errors are matched, customize the variable
278 `compilation-error-regexp-alist'."
282 ;; we know here that next-error-function is a valid symbol we can funcall
290 "Visit the source code corresponding to the `next-error' message at point."
292 ;; we know here that next-error-function is a valid symbol we can funcall
303 "Visit previous `next-error' message and corresponding source code.
305 Prefix arg N says how many error messages to move backwards (or
306 forwards, if negative).
313 "Restart at the first error.
314 Visit corresponding source code.
315 With prefix arg N, visit the source code of the Nth error.
321 "Move point to the next error in the `next-error' buffer and highlight match.
322 Prefix arg N says how many error messages to move forwards (or
323 backwards, if negative).
325 select the source buffer."
332 "Move point to the previous error in the `next-error' buffer and highlight match.
333 Prefix arg N says how many error messages to move backwards (or
334 forwards, if negative).
336 select the source buffer."
340 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
344 "Minor mode for compilation, occur and diff modes.
345 With a prefix argument ARG, enable mode if ARG is positive, and
346 disable it otherwise. If called from Lisp, enable mode if ARG is
347 omitted or nil.
348 When turned on, cursor motion in the compilation, grep, occur or diff
349 buffer causes automatic display of the corresponding source code location."
356 ;; Used as a `post-command-hook' by `next-error-follow-mode'
357 ;; for the *Compilation* *grep* and *Occur* buffers.
367 \f
368 ;;;
371 "Major mode not specialized for anything in particular.
372 Other major modes are defined by comparison with this one."
377 ;; Special major modes to view specially formatted data rather than files.
391 map))
395 "Parent major mode from which special major modes should inherit."
398 ;; Making and deleting lines.
401 "Special hook to tell if `self-insert-command' will use the region.
402 It must be called via `run-hook-with-args-until-success' with no arguments.
403 Any `post-self-insert-command' which consumes the region should
404 register a function on this hook so that things like `delete-selection-mode'
411 "Insert a newline, and move to left margin of the new line if it's blank.
412 If option `use-hard-newlines' is non-nil, the newline is marked with the
413 text-property `hard'.
414 With ARG, insert that many newlines.
416 If `electric-indent-mode' is enabled, this indents the final new line
417 that it adds, and reindents the preceding line. To just insert
420 Calls `auto-fill-function' if the current column number is greater
421 than the value of `fill-column' and ARG is nil.
422 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
425 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
426 ;; Set last-command-event to tell self-insert what to insert.
430 ;; Don't auto-fill if we have a numeric argument.
434 ;; Do the rest in post-self-insert-hook, because we want to do it
435 ;; *before* other functions on that hook.
437 ;; We are not going to insert any newlines if arg is
438 ;; non-positive.
441 ;; Mark the newline(s) `hard'.
445 ;; If the newline leaves the previous line blank, and we
446 ;; have a left margin, delete that from the blank line.
454 ;; Indent the line after the newline, except in one case:
455 ;; when we added the newline at the beginning of a line which
456 ;; starts a page.
461 ;; FIXME: For non-interactive uses, many calls actually
462 ;; just want (insert "\n"), so maybe we should do just
463 ;; that, so as to avoid the risk of filling or running
464 ;; abbrevs unexpectedly.
471 ;; We first used let-binding to protect the hook, but that
472 ;; was naive since add-hook affects the symbol-default
473 ;; value of the variable, whereas the let-binding might
474 ;; only protect the buffer-local value.
478 nil)
483 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
489 "Insert a newline and leave point before it.
490 If there is a fill prefix and/or a `left-margin', insert them on
491 the new line if the line would have been blank.
492 With arg N, insert N newlines."
497 ;; Don't expand an abbrev before point.
508 ;; Necessary in case a margin or prefix was inserted.
512 "Split current line, moving portion beyond point vertically down.
513 If the current line starts with `fill-prefix', insert it on the new
514 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
516 When called from Lisp code, ARG may be a prefix string to copy."
521 ;; What prefix should we check for (nil means don't).
525 ;; Does this line start with it?
536 "Join this line to previous and fix up whitespace at join.
537 If there is a fill prefix, delete it from the beginning of this line.
538 With argument, join this line to following line."
545 ;; If the second line started with the fill prefix,
546 ;; delete the prefix.
558 "On blank line, delete all surrounding blank lines, leaving just one.
559 On isolated blank line, delete that one.
560 On nonblank line, delete any immediately following blank lines."
566 ;; Set singleblank if there is just one blank line here.
573 ;; Delete preceding blank lines, and this one too if it's the only one.
582 ;; Delete following blank lines, unless the current line is blank
583 ;; and there are no following blank lines.
592 ;; Handle the special case where point is followed by newline and eob.
593 ;; Delete the line, leaving point at eob.
599 Trailing lines are deleted only if `delete-trailing-whitespace'
600 is called on the entire buffer (rather than an active region)."
606 "Return non-nil if the region contains no read-only text."
611 "Delete trailing whitespace between START and END.
612 If called interactively, START and END are the start/end of the
613 region if the mark is active, or of the buffer's accessible
614 portion if the mark is inactive.
616 This command deletes whitespace characters after the last
617 non-whitespace character in each line between START and END. It
618 does not consider formfeed characters to be whitespace.
620 If this command acts on the entire buffer (i.e. if called
621 interactively with the mark inactive, or called from Lisp with
622 END nil), it also deletes all trailing lines at the end of the
623 buffer if the variable `delete-trailing-lines' is non-nil."
634 ;; Don't delete formfeeds, even if they are considered whitespace.
643 ;; Delete trailing empty lines.
645 ;; Really the end of buffer.
650 ;; Return nil for the benefit of `write-file-functions'.
651 nil)
654 "Insert a newline, then indent according to major mode.
655 Indentation is done using the value of `indent-line-function'.
656 In programming language modes, this is the same as TAB.
657 In some text modes, where TAB inserts a tab, this command indents to the
658 column specified by the function `current-left-margin'."
665 "Reindent current line, insert newline, then indent the new line.
666 Indentation of both lines is done according to the current major mode,
667 which means calling the current value of `indent-line-function'.
668 In programming language modes, this is the same as TAB.
669 In some text modes, where TAB inserts a tab, this indents to the
670 column specified by the function `current-left-margin'."
673 ;; Be careful to insert the newline before indenting the line.
674 ;; Otherwise, the indentation might be wrong.
678 ;; We are at EOL before the call to indent-according-to-mode, and
679 ;; after it we usually are as well, but not always. We tried to
680 ;; address it with `save-excursion' but that uses a normal marker
681 ;; whereas we need `move after insertion', so we do the save/restore
682 ;; by hand.
686 ;; Remove the trailing white-space after indentation because
687 ;; indentation may introduce the whitespace.
693 Legitimate radix values are 8, 10 and 16."
698 "Like `read-char', but do not allow quitting.
699 Also, if the first character read is an octal digit,
700 we read any number of octal digits and return the
701 specified character code. Any nondigit terminates the sequence.
702 If the terminator is RET, it is discarded;
703 any other terminator is used itself as input.
705 The optional argument PROMPT specifies a string to use to prompt the user.
706 The variable `read-quoted-char-radix' controls which radix to use
707 for numeric input."
710 help-event-list)))
714 ;; Don't let C-h or other help chars get the help
715 ;; message--only help function keys. See bug#16617.
719 "Type the special character you want to use,
720 or the octal character code.
721 RET terminates the character code and is discarded;
725 ;; Translate TAB key into control-I ASCII character, and so on.
726 ;; Note: `read-char' does it using the `ascii-character' property.
727 ;; We tried using read-key instead, but that disables the keystroke
728 ;; echo produced by 'C-q', see bug#24635.
732 char)))
738 done t))
740 ;; Turn a meta-character into a character with the 0200 bit set.
742 done t))
757 done t))
759 done t)))
761 code))
764 "Read next input character and insert it.
765 This is useful for inserting control characters.
766 With argument, insert ARG copies of the character.
768 If the first character you type after this command is an octal digit,
769 you should type a sequence of octal digits which specify a character code.
770 Any nondigit terminates the sequence. If the terminator is a RET,
771 it is discarded; any other terminator is used itself as input.
772 The variable `read-quoted-char-radix' specifies the radix for this feature;
773 set it to 10 or 16 to use decimal or hex instead of octal.
775 In overwrite mode, this function inserts the character anyway, and
776 does not handle octal digits specially. This means that if you use
777 overwrite as your normal editing mode, you can use this function to
778 insert characters when necessary.
780 In binary overwrite mode, this function does overwrite, and octal
781 digits are interpreted as a character code. This is intended to be
782 useful for editing binary files."
785 ;; Avoid "obsolete" warnings for translation-table-for-input.
792 ;; This used to assume character codes 0240 - 0377 stand for
793 ;; characters in some single-byte character set, and converted them
794 ;; to Emacs characters. But in 23.1 this feature is deprecated
795 ;; in favor of inserting the corresponding Unicode characters.
796 ;; (if (and enable-multibyte-characters
797 ;; (>= char ?\240)
798 ;; (<= char ?\377))
799 ;; (setq char (unibyte-char-to-multibyte char)))
811 "Move forward ARG lines and position at first nonblank character."
817 "Move backward ARG lines and position at first nonblank character."
823 "Move point to the first non-whitespace character on this line."
827 ;; Move back over chars that have whitespace syntax but have the p flag.
831 "Fixup white space between objects around point.
832 Leave one space or none, according to the context."
839 nil
843 "Delete all spaces and tabs around point.
844 If BACKWARD-ONLY is non-nil, only delete them before point."
849 orig-pos
858 "Delete all spaces and tabs around point, leaving one space (or N spaces).
859 If N is negative, delete newlines as well, leaving -N spaces.
860 See also `cycle-spacing'."
865 "Store context used in consecutive calls to `cycle-spacing' command.
866 The first time `cycle-spacing' runs, it saves in this variable:
867 its N argument, the original point position, and the original spacing
871 "Manipulate whitespace around point in a smart way.
872 In interactive use, this function behaves differently in successive
873 consecutive calls.
875 The first call in a sequence acts like `just-one-space'.
876 It deletes all spaces and tabs around point, leaving one space
877 \(or N spaces). N is the prefix argument. If N is negative,
878 it deletes newlines as well, leaving -N spaces.
879 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
881 The second call in a sequence deletes all spaces.
883 The third call in a sequence restores the original whitespace (and point).
885 If MODE is `single-shot', it only performs the first step in the sequence.
886 If MODE is `fast' and the first step would not result in any change
887 \(i.e., there are exactly (abs N) spaces around point),
888 the function goes straight to the second step.
890 Repeatedly calling the function with different values of N starts a
891 new sequence each time."
899 ;; Command run for the first time, single-shot mode or different argument
911 ;; Special handling for case where there was no space at all.
914 ;; If this run causes no change in buffer content, delete all spaces,
915 ;; otherwise delete all excess spaces.
920 ;; Command run for the second time.
924 ;; Command run for the third time.
929 \f
931 "Move point to the beginning of the buffer.
932 With numeric arg N, put point N/10 of the way from the beginning.
933 If the buffer is narrowed, this command uses the beginning of the
934 accessible part of the buffer.
937 is supplied, or Transient Mark mode is enabled and the mark is active."
947 ;; Avoid overflow for large buffer sizes!
955 "Move point to the end of the buffer.
956 With numeric arg N, put point N/10 of the way from the end.
957 If the buffer is narrowed, this command uses the end of the
958 accessible part of the buffer.
961 is supplied, or Transient Mark mode is enabled and the mark is active."
969 ;; Avoid overflow for large buffer sizes!
974 ;; If we went to a place in the middle of the buffer,
975 ;; adjust it to the beginning of a line.
979 ;; If the end of the buffer is not already on the screen,
980 ;; then scroll specially to put it near, but not at, the bottom.
985 "Whether single-char deletion commands delete an active region.
986 This has an effect only if Transient Mark mode is enabled, and
987 affects `delete-forward-char' and `delete-backward-char', though
988 not `delete-char'.
990 If the value is the symbol `kill', the active region is killed
991 instead of deleted."
1008 "Function to get the region's content.
1009 Called with one argument DELETE.
1010 If DELETE is `delete-only', then only delete the region and the return value
1011 is undefined. If DELETE is nil, just return the content as a string.
1012 If DELETE is `bounds', then don't delete, but just return the
1013 boundaries of the region as a list of (START . END) positions.
1014 If anything else, delete the region and return its content as a string,
1025 first nil))))
1026 "Function to insert the region's content.
1027 Called with one argument LINES.
1031 "Delete the previous N characters (following if N is negative).
1032 If Transient Mark mode is enabled, the mark is active, and N is 1,
1033 delete the text in the region and deactivate the mark instead.
1034 To disable this, set option `delete-active-region' to nil.
1036 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1037 kill ring) instead of delete. Interactively, N is the prefix
1038 arg, and KILLFLAG is set if N is explicitly specified.
1040 When killing, the killed text is filtered by
1041 `filter-buffer-substring' before it is saved in the kill ring, so
1042 the actual saved text might be different from what was killed.
1044 In Overwrite mode, single character backward deletion may replace
1045 tabs with spaces so as to back over columns, unless point is at
1046 the end of the line."
1052 delete-active-region
1054 ;; If a region is active, kill or delete it.
1058 ;; In Overwrite mode, maybe untabify while deleting
1068 ;; Otherwise, do simple deletion.
1072 "Delete the following N characters (previous if N is negative).
1073 If Transient Mark mode is enabled, the mark is active, and N is 1,
1074 delete the text in the region and deactivate the mark instead.
1075 To disable this, set variable `delete-active-region' to nil.
1077 Optional second arg KILLFLAG non-nil means to kill (save in kill
1078 ring) instead of delete. Interactively, N is the prefix arg, and
1079 KILLFLAG is set if N was explicitly specified.
1081 When killing, the killed text is filtered by
1082 `filter-buffer-substring' before it is saved in the kill ring, so
1083 the actual saved text might be different from what was killed."
1089 delete-active-region
1091 ;; If a region is active, kill or delete it.
1096 ;; Otherwise, do simple deletion.
1100 "Put point at beginning and mark at end of buffer.
1101 If narrowing is in effect, only uses the accessible part of the buffer.
1102 You probably should not use this function in Lisp programs;
1103 it is usually a mistake for a Lisp function to use any subroutine
1104 that uses or sets the mark."
1109 ;; This is really `point-min' in most cases, but if we're in the
1110 ;; minibuffer, this is at the end of the prompt.
1112 \f
1114 ;; Counting lines, one way or another.
1117 "Go to LINE, counting from line 1 at beginning of buffer.
1118 If called interactively, a numeric prefix argument specifies
1119 LINE; without a numeric prefix argument, read LINE from the
1120 minibuffer.
1122 If optional argument BUFFER is non-nil, switch to that buffer and
1124 as argument, BUFFER is the most recently selected other buffer.
1126 Prior to moving point, this function sets the mark (without
1127 activating it), unless Transient Mark mode is enabled and the
1128 mark is already active.
1130 This function is usually the wrong thing to use in a Lisp program.
1131 What you probably want instead is something like:
1132 (goto-char (point-min))
1133 (forward-line (1- N))
1134 If at all possible, an even better solution is to use char counts
1135 rather than line counts."
1140 ;; Look for a default, a number in the buffer at point.
1150 ;; Decide if we're switching buffers.
1158 ;; Read the argument, offering that number (if any) as default.
1161 buffer))))
1162 ;; Switch to the desired buffer, one way or another.
1167 ;; Leave mark at previous position
1169 ;; Move to the specified line number in that buffer.
1178 "Count the number of words in the region.
1179 If called interactively, print a message reporting the number of
1180 lines, words, and characters in the region (whether or not the
1181 region is active); with prefix ARG, report for the entire buffer
1182 rather than the region.
1184 If called from Lisp, return the number of words between positions
1185 START and END."
1197 "Count words between START and END.
1198 If called interactively, START and END are normally the start and
1199 end of the buffer; but if the region is active, START and END are
1200 the start and end of the region. Print a message reporting the
1201 number of lines, words, and chars.
1203 If called from Lisp, return the number of words between START and
1204 END, without printing any message."
1214 words))
1230 str
1238 "Print the current buffer line number and narrowed line number of point."
1251 "Return number of lines between START and END.
1252 This is usually the number of newlines between them,
1253 but can be one more if START is not equal to END
1254 and the greater of them is not at the start of a line."
1270 done)))
1274 "Return buffer line number at position POS.
1275 If POS is nil, use current buffer location.
1277 If ABSOLUTE is nil, the default, counting starts
1278 at (point-min), so the value refers to the contents of the
1279 accessible portion of the (potentially narrowed) buffer. If
1280 ABSOLUTE is non-nil, ignore any narrowing and return the
1281 absolute line number."
1294 "Print info on cursor position (on screen and within buffer).
1295 Also describe the character after point, and give its character code
1296 in octal, decimal and hex.
1298 For a non-ASCII multibyte character, also give its encoding in the
1299 buffer's selected coding system if the coding system encodes the
1300 character safely. If the character is encoded into one byte, that
1301 code is shown in hex. If the character is encoded into more than one
1304 In addition, with prefix argument, show details about that character
1305 in *Help* buffer. See also the command `describe-char'."
1309 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1310 ;; start a directional embedding, which could completely
1311 ;; disrupt the rest of the line (e.g., RLO will display the
1312 ;; rest of the line right-to-left). So we put an invisible
1313 ;; PDF character after these characters, to end the
1314 ;; embedding, which eliminates any effects on the rest of
1315 ;; the line. For RLE and RLO we also append an invisible
1316 ;; LRM, to avoid reordering the following numerical
1317 ;; characters. For LRI/RLI/FSI we append a PDI.
1324 ;; Strong right-to-left characters cause reordering of
1325 ;; the following numerical characters which show the
1326 ;; codepoint, so append LRM to countermand that.
1337 ""
1343 pos total percent beg end col hscroll)
1345 pos total col hscroll))
1347 encoded encoding-msg display-prop under-display)
1354 ;; Check if the character is displayed with some `display'
1355 ;; text property. In that case, set under-display to the
1356 ;; buffer substring covered by that property.
1367 under-display)))
1373 char char char under-display)
1375 char char char under-display display-prop))
1378 char char char
1380 "..."
1384 ;; We show the detailed information about CHAR.
1391 bidi-fixer
1392 encoding-msg pos total percent beg end col hscroll)
1399 bidi-fixer encoding-msg pos total percent col hscroll))))))
1400 \f
1401 ;; Initialize read-expression-map. It is defined at C level.
1405 ;; Might as well bind TAB to completion, since inserting a TAB char is
1406 ;; much too rarely useful.
1409 m))
1412 "Return a Lisp object read using the minibuffer, unevaluated.
1413 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1414 is a string to insert in the minibuffer before reading.
1415 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1416 Such arguments are used as in `read-from-minibuffer'.)"
1417 ;; Used for interactive spec `x'.
1422 "Return value of Lisp expression read using the minibuffer.
1423 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1424 is a string to insert in the minibuffer before reading.
1425 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1426 Such arguments are used as in `read-from-minibuffer'.)"
1427 ;; Used for interactive spec `X'.
1435 "The current default value or list of default values in the minibuffer.
1436 The functions `read-from-minibuffer' and `completing-read' bind
1440 "Value for `print-level' while printing value in `eval-expression'.
1441 A value of nil means no limit."
1447 "Value for `print-length' while printing value in `eval-expression'.
1448 A value of nil means no limit."
1454 "If non-nil set `debug-on-error' to t in `eval-expression'.
1455 If nil, don't change the value of `debug-on-error'."
1461 "The largest integer that will be displayed as a character.
1462 This affects printing by `eval-expression' (via
1463 `eval-expression-print-format')."
1469 "If VALUE in an integer, return a specially formatted string.
1471 If VALUE is not an integer, nil is returned.
1472 This function is used by commands like `eval-expression' that
1473 display the result of expression evaluation."
1491 ;; FIXME: call emacs-lisp-mode?
1499 read-expression-map t
1503 "Get arguments for commands that print an expression result.
1504 Returns a list (INSERT-VALUE NO-TRUNCATE CHAR-PRINT-LIMIT)
1505 based on PREFIX-ARG. This function determines the interpretation
1506 of the prefix argument for `eval-expression' and
1507 `eval-last-sexp'."
1515 ;; We define this, rather than making `eval' interactive,
1516 ;; for the sake of completion of names like eval-region, eval-buffer.
1518 "Evaluate EXP and print value in the echo area.
1519 When called interactively, read an Emacs Lisp expression and
1520 evaluate it. Value is also consed on to front of the variable
1521 `values'. Optional argument INSERT-VALUE non-nil (interactively,
1522 with a non `-' prefix argument) means insert the result into the
1523 current buffer instead of printing it in the echo area.
1525 Normally, this function truncates long output according to the
1526 value of the variables `eval-expression-print-length' and
1527 `eval-expression-print-level'. When NO-TRUNCATE is
1528 non-nil (interactively, with a prefix argument of zero), however,
1529 there is no such truncation.
1531 If the resulting value is an integer, and CHAR-PRINT-LIMIT is
1532 non-nil (interactively, unless given a positive prefix argument)
1533 it will be printed in several additional formats (octal,
1534 hexadecimal, and character). The character format is only used
1535 if the value is below CHAR-PRINT-LIMIT (interactively, if the
1536 prefix argument is -1 or the value is below
1537 `eval-expression-print-maximum-character').
1539 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1540 minibuffer.
1542 If `eval-expression-debug-on-error' is non-nil, which is the default,
1543 this command arranges for all errors to enter the debugger."
1551 ;; Bind debug-on-error to something unique so that we can
1552 ;; detect when evalled code changes it.
1556 ;; If evalled code has changed the value of debug-on-error,
1557 ;; propagate that change to the global binding.
1573 "Prompting with PROMPT, let user edit COMMAND and eval result.
1574 COMMAND is a Lisp expression. Let user edit that expression in
1575 the minibuffer, then read and evaluate the result."
1582 read-expression-map t
1584 ;; If command was added to command-history as a string,
1585 ;; get rid of that. We want only evaluable expressions there.
1589 ;; If command to be redone does not match front of history,
1590 ;; add it to the history.
1596 "Edit and re-evaluate last complex command, or ARGth from last.
1597 A complex command is one which used the minibuffer.
1598 The command is placed in the minibuffer as a Lisp form for editing.
1599 The result is executed, repeating the command as changed.
1600 If the command has been changed or is not the most recent previous
1601 command it is added to the front of the command history.
1602 You can use the minibuffer history commands \
1604 to get different commands to edit and resubmit."
1607 newcmd)
1619 ;; If command was added to command-history as a
1620 ;; string, get rid of that. We want only
1621 ;; evaluable expressions there.
1625 ;; If command to be redone does not match front of history,
1626 ;; add it to the history.
1641 "Read command name to invoke in `execute-extended-command'."
1651 ;; Get a command name at point in the original buffer
1652 ;; to propose it after M-n.
1656 ;; Read a string, completing from and restricting to the set of
1657 ;; all defined commands. Don't provide any initial input.
1658 ;; Save the command read on the extended-command history list.
1669 ;; This isn't strictly correct if `execute-extended-command'
1670 ;; is bound to anything else (e.g. [menu]).
1671 ;; It could use (key-description (this-single-command-keys)),
1672 ;; but actually a prompt other than "M-x" would be confusing,
1673 ;; because "M-x" is a well-known prompt to read a command
1674 ;; and it serves as a shorthand for "Extended command: ".
1679 ;; Exclude obsolete commands from completions.
1684 pred)))
1689 "Non-nil means show the equivalent key-binding when M-x command has one.
1690 The value can be a length of time to show the message for.
1691 If the value is non-nil and not a number, we wait 2 seconds."
1698 "If non-nil, show a shorter M-x invocation when there is one."
1719 binding)
1725 name len)))
1726 ;; Don't show the help message if the binding isn't
1727 ;; significantly shorter than the M-x command the user typed.
1735 binding))
1738 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1739 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1740 "Read a command name, then read the arguments and call the command.
1741 To pass a prefix argument to the command you are
1742 invoking, give a prefix argument to `execute-extended-command'."
1744 ;; FIXME: Remember the actual text typed by the user before completion,
1745 ;; so that we don't later on suggest the same shortening.
1750 execute-extended-command--last-typed)))
1751 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1763 ;; Some features, such as novice.el, rely on this-command-keys
1764 ;; including M-x COMMAND-NAME RET.
1767 ;; Normally `real-this-command' should never be changed, but here we really
1768 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1769 ;; binding" for <cmd>, so the command the user really wanted to run is
1770 ;; `function' and not `execute-extended-command'. The difference is
1771 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1775 ;; If enabled, show which key runs this command.
1776 ;; But first wait, and skip the message if there is input.
1778 ;; If this command displayed something in the echo area;
1779 ;; wait a few seconds, then display our suggestion message.
1780 ;; FIXME: Wait *after* running post-command-hook!
1781 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1782 ;; find a better answer anyway!
1792 ;; There's no binding for CMD. Let's try and find the shortest
1793 ;; string to use in M-x.
1794 ;; FIXME: Can be slow. Cache it maybe?
1801 function
1806 suggest-key-bindings
1810 ;; BEWARE: Called directly from the C code.
1811 "Execute CMD as an editor command.
1812 CMD must be a symbol that satisfies the `commandp' predicate.
1813 Optional second arg RECORD-FLAG non-nil
1814 means unconditionally put this command in the variable `command-history'.
1815 Otherwise, that is done only if an arg is read using the minibuffer.
1816 The argument KEYS specifies the value to use instead of (this-command-keys)
1817 when reading the arguments; if it is nil, (this-command-keys) is used.
1818 The argument SPECIAL, if non-nil, means that this command is executing
1819 a special event, so ignore the prefix argument and don't clear it."
1822 ;; FIXME: This should probably be done around
1823 ;; pre-command-hook rather than here!
1831 disabled-command-function)
1832 ;; FIXME: Weird calling convention!
1842 ;; If requested, place the macro in the command history. For
1843 ;; other sorts of commands, call-interactively takes care of this.
1846 ;; Don't keep command history around forever.
1852 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1860 \f
1862 "Default minibuffer history list.
1863 This is used for all minibuffer input
1864 except when an alternate history list is specified.
1866 Maximum length of the history list is determined by the value
1869 "Control whether history list elements are expressions or strings.
1870 If the value of this variable equals current minibuffer depth,
1871 they are expressions; otherwise they are strings.
1872 \(That convention is designed to do the right thing for
1879 "Text that was in this minibuffer before any history commands.
1880 This is nil if there have not yet been any history commands
1889 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1894 "Minibuffer history variables for which matching should ignore case.
1895 If a history variable is a member of this list, then the
1897 commands ignore case when searching it, regardless of `case-fold-search'."
1902 "Find the previous history element that matches REGEXP.
1903 \(Previous history elements refer to earlier actions.)
1904 With prefix argument N, search for Nth previous match.
1905 If N is negative, find the next or Nth next match.
1906 Normally, history elements are matched case-insensitively if
1907 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1908 makes the search case-sensitive.
1909 See also `minibuffer-history-case-insensitive-variables'."
1913 nil
1914 minibuffer-local-map
1915 nil
1916 'minibuffer-history-search-history
1918 ;; Use the last regexp specified, by default, if input is empty.
1923 regexp)
1933 ;; On some systems, ignore case for file names.
1935 minibuffer-history-case-insensitive-variables)
1936 t
1937 ;; Respect the user's setting for case-fold-search:
1938 case-fold-search)
1939 nil))
1940 prevpos
1941 match-string
1942 match-offset
1949 "No later matching history item"
1970 next-matching-history-element))
1974 "Find the next history element that matches REGEXP.
1975 \(The next history element refers to a more recent action.)
1976 With prefix argument N, search for Nth next match.
1977 If N is negative, find the previous or Nth previous match.
1978 Normally, history elements are matched case-insensitively if
1979 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1980 makes the search case-sensitive."
1984 nil
1985 minibuffer-local-map
1986 nil
1987 'minibuffer-history-search-history
1989 ;; Use the last regexp specified, by default, if input is empty.
1994 regexp)
2001 "Function run by `goto-history-element' before consuming default values.
2002 This is useful to dynamically add more elements to the list of default values
2003 when `goto-history-element' reaches the end of this list.
2004 Before calling this function `goto-history-element' sets the variable
2005 `minibuffer-default-add-done' to t, so it will call this function only
2006 once. In special cases, when this function needs to be called more
2007 than once, it can set `minibuffer-default-add-done' to nil explicitly,
2011 "When nil, add more elements to the end of the list of default values.
2012 The value nil causes `goto-history-element' to add more elements to
2013 the list of defaults when it reaches the end of this list. It does
2019 "Return a list of all completions without the default value.
2020 This function is used to add all elements of the completion table to
2021 the end of the list of defaults just after the default value."
2024 minibuffer-completion-table
2025 minibuffer-completion-predicate)))
2031 "Puts element of the minibuffer history in the minibuffer.
2032 The argument NABS specifies the absolute history position."
2046 elt minibuffer-returned-to-present)
2053 "End of defaults; no next item"
2060 previous-history-element))
2072 minibuffer-default)))
2084 elt))
2088 "Puts next element of the minibuffer history in the minibuffer.
2089 With argument N, it uses the Nth following element."
2095 "Puts previous element of the minibuffer history in the minibuffer.
2096 With argument N, it uses the Nth previous element."
2102 "Move cursor vertically down ARG lines, or to the next history element.
2103 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2104 next element of the minibuffer history in the minibuffer."
2108 ;; Remember the original goal column of possibly multi-line input
2109 ;; excluding the length of the prompt on the first line.
2119 ;; Restore old position since `line-move-visual' moves point to
2120 ;; the end of the line when it fails to go to the next line.
2123 ;; Reset `temporary-goal-column' because a correct value is not
2124 ;; calculated when `next-line' above fails by bumping against
2125 ;; the bottom of the minibuffer (bug#22544).
2127 ;; Restore the original goal column on the last line
2128 ;; of possibly multi-line input.
2136 "Move cursor vertically up ARG lines, or to the previous history element.
2137 When point moves over the top line of multi-line minibuffer, puts ARGth
2138 previous element of the minibuffer history in the minibuffer."
2142 ;; Remember the original goal column of possibly multi-line input
2143 ;; excluding the length of the prompt on the first line.
2153 ;; Restore old position since `line-move-visual' moves point to
2154 ;; the beginning of the line when it fails to go to the previous line.
2157 ;; Reset `temporary-goal-column' because a correct value is not
2158 ;; calculated when `previous-line' above fails by bumping against
2159 ;; the top of the minibuffer (bug#22544).
2161 ;; Restore the original goal column on the first line
2162 ;; of possibly multi-line input.
2168 ;; Put the cursor at the end of the visual line instead of the
2169 ;; logical line, so the next `previous-line-or-history-element'
2170 ;; would move to the previous history element, not to a possible upper
2171 ;; visual line from the end of logical line in `line-move-visual' mode.
2173 ;; Since `end-of-visual-line' puts the cursor at the beginning
2174 ;; of the next visual line, move it one char back to the end
2175 ;; of the first visual line (bug#22544).
2179 "Get next history element which completes the minibuffer before the point.
2180 The contents of the minibuffer after the point are deleted, and replaced
2181 by the new completion."
2187 n)
2188 ;; next-matching-history-element always puts us at (point-min).
2189 ;; Move to the position we were at before changing the buffer contents.
2190 ;; This is still sensible, because the text before point has not changed.
2194 "\
2195 Get previous history element which completes the minibuffer before the point.
2196 The contents of the minibuffer after the point are deleted, and replaced
2197 by the new completion."
2201 ;; For compatibility with the old subr of the same name.
2203 "Return the display width of the minibuffer prompt.
2204 Return 0 if current buffer is not a minibuffer."
2205 ;; Return the width of everything before the field at the end of
2206 ;; the buffer; this should be 0 for normal buffers.
2208 \f
2209 ;; isearch minibuffer history
2216 "Set up a minibuffer for using isearch to search the minibuffer history.
2217 Intended to be added to `minibuffer-setup-hook'."
2229 "Clean up the minibuffer after terminating isearch in the minibuffer."
2234 "Return the proper search function, for isearch in minibuffer history."
2237 ;; Use standard functions to search within minibuffer text
2239 found)
2240 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2241 ;; searching forward. Lazy-highlight calls this lambda with the
2242 ;; bound arg, so skip the minibuffer prompt.
2246 ;; 1. First try searching in the initial minibuffer text
2249 noerror)
2250 ;; 2. If the above search fails, start putting next/prev history
2251 ;; elements in the minibuffer successively, and search the string
2252 ;; in them. Do this only when bound is nil (i.e. not while
2253 ;; lazy-highlighting search strings in the current minibuffer text).
2265 ;; After putting the next/prev history element, search
2266 ;; the string in them again, until next-history-element
2267 ;; or previous-history-element raises an error at the
2268 ;; beginning/end of history.
2271 ;; For backward search, don't search
2272 ;; in the minibuffer prompt
2274 noerror)))
2275 ;; Return point of the new search result
2277 ;; Return nil when next(prev)-history-element fails
2281 "Display the minibuffer history search prompt.
2282 If there are no search errors, this function displays an overlay with
2283 the isearch prompt which replaces the original minibuffer prompt.
2284 Otherwise, it displays the standard isearch message returned from
2285 the function `isearch-message'."
2287 ;; Use standard function `isearch-message' when not in the minibuffer,
2288 ;; or search fails, or has an error (like incomplete regexp).
2289 ;; This function overwrites minibuffer text with isearch message,
2290 ;; so it's possible to see what is wrong in the search string.
2292 ;; Otherwise, put the overlay with the standard isearch prompt over
2293 ;; the initial minibuffer prompt.
2302 ;; And clear any previous isearch message.
2306 "Wrap the minibuffer history search when search fails.
2307 Move point to the first history element for a forward search,
2308 or to the last history element for a backward search."
2309 ;; When `minibuffer-history-isearch-search' fails on reaching the
2310 ;; beginning/end of the history, wrap the search to the first/last
2311 ;; minibuffer history element.
2319 "Save a function restoring the state of minibuffer history search.
2320 Save `minibuffer-history-position' to the additional state parameter
2321 in the search status stack."
2327 "Restore the minibuffer history search state.
2328 Go to the history element by the absolute history position HIST-POS."
2331 \f
2332 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2336 "Table mapping redo records to the corresponding undo one.
2337 A redo record for undo-in-region maps to t.
2347 "Within a run of consecutive undo commands, list remaining to be undone.
2351 "Undo some previous changes.
2352 Repeat this command to undo more changes.
2353 A numeric ARG serves as a repeat count.
2355 In Transient Mark mode when the mark is active, only undo changes within
2357 as an argument limits undo to changes within the current region."
2359 ;; Make last-command indicate for the next command that this was an undo.
2360 ;; That way, another undo will undo more.
2361 ;; If we get to the end of the undo history and get an error,
2362 ;; another undo command will find the undo history empty
2363 ;; and will get another error. To begin undoing the undos,
2364 ;; you must type some other command.
2366 ;; For an indirect buffer, look in the base buffer for the
2367 ;; auto-save data.
2371 message)
2372 ;; If we get an error in undo-start,
2373 ;; the next command should not be a "consecutive undo".
2374 ;; So set `this-command' to something other than `undo'.
2379 ;; If something (a timer or filter?) changed the buffer
2380 ;; since the previous command, don't continue the undo seq.
2384 ;; If the last undo record made was made by undo
2385 ;; it shows nothing else happened in between.
2392 ;; get rid of initial undo boundary
2394 ;; If we got this far, the next command should be a consecutive undo.
2396 ;; Check to see whether we're hitting a redo record, and if
2397 ;; so, ask the user whether she wants to skip the redo/undo pair.
2405 ;; The equiv entry might point to another redo record if we have done
2406 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2414 ;; Record the fact that the just-generated undo records come from an
2415 ;; undo operation--that is, they are redo records.
2416 ;; In the ordinary case (not within a region), map the redo
2417 ;; record to the following undos.
2418 ;; I don't know how to do that in the undo-in-region case.
2420 ;; Strip any leading undo boundaries there might be, like we do
2421 ;; above when checking.
2425 ;; Prevent identity mapping. This can happen if
2426 ;; consecutive nils are erroneously in undo list.
2428 t
2429 pending-undo-list)
2430 undo-equiv-table))
2431 ;; Don't specify a position in the undo record for the undo command.
2432 ;; Instead, undoing this should move point to where the change is.
2451 ;; Record what the current undo list says,
2452 ;; so the next command can tell if the buffer was modified in between.
2456 ;; Display a message announcing success.
2461 "Make BUFFER stop keeping undo information.
2462 No argument or nil as argument means do this for the current buffer."
2468 "Undo some previous changes.
2469 Repeat this command to undo more changes.
2470 A numeric ARG serves as a repeat count.
2471 Contrary to `undo', this will not redo a previous undo."
2476 "Non-nil while performing an undo.
2480 "Undo back N undo-boundaries beyond what was already undone recently.
2481 Call `undo-start' to get ready to undo recent changes,
2482 then call `undo-more' one or more times to undo them."
2487 ;; Note: The following, while pulling elements off
2488 ;; `pending-undo-list' will call primitive change functions which
2489 ;; will push more elements onto `buffer-undo-list'.
2495 "Undo N records from the front of the list LIST.
2496 Return what remains of the list."
2498 ;; This is a good feature, but would make undo-start
2499 ;; unable to do what is expected.
2500 ;;(when (null (car (list)))
2501 ;; ;; If the head of the list is a boundary, it is the boundary
2502 ;; ;; preceding this command. Get rid of it and don't count it.
2503 ;; (setq list (cdr list))))
2506 ;; In a writable buffer, enable undoing read-only text that is
2507 ;; so because of text properties.
2509 ;; Don't let `intangible' properties interfere with undo.
2511 ;; We use oldlist only to check for EQ. ++kfs
2517 ;; Handle an integer by setting point to that value.
2520 ;; Element (t . TIME) records previous modtime.
2521 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2522 ;; UNKNOWN_MODTIME_NSECS.
2524 ;; If this records an obsolete save
2525 ;; (not matching the actual disk file)
2526 ;; then don't mark unmodified.
2534 ;; Element (nil PROP VAL BEG . END) is property change.
2539 ;; Element (BEG . END) means range was inserted.
2541 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2542 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2545 ;; Set point first thing, so that undoing this undo
2546 ;; does not send point back to where it is now.
2549 ;; Element (apply FUN . ARGS) means call FUN to undo.
2553 ;; Long format: (apply DELTA START END FUN . ARGS).
2560 ;; Check that the function did what the entry
2561 ;; said it would do.
2571 ;; Element (STRING . POS) means STRING was deleted.
2577 ;; Check that marker adjustments which were recorded
2578 ;; with the (STRING . POS) record are still valid, ie
2579 ;; the markers haven't moved. We check their validity
2580 ;; before reinserting the string so as we don't need to
2581 ;; mind marker insertion-type.
2589 ;; Insert string and adjust point
2597 ;; Adjust the valid marker adjustments
2599 ;; Insert might have invalidated some of the markers
2600 ;; via modification hooks. Update only the currently
2601 ;; valid ones (bug#25599).
2605 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2608 next)
2609 ;; Even though these elements are not expected in the undo
2610 ;; list, adjust them to be conservative for the 24.4
2611 ;; release. (Bug#16818)
2618 ;; Make sure an apply entry produces at least one undo entry,
2619 ;; so the test in `undo' for continuing an undo series
2620 ;; will work right.
2625 list)
2627 ;; Deep copy of a list
2629 "Make a copy of undo list LIST."
2635 elt))
2638 "Set `pending-undo-list' to the front of the undo list.
2639 The next call to `undo-more' will undo the most recently made change.
2640 If BEG and END are specified, then only undo elements
2641 that apply to text between BEG and END are used; other undo elements
2642 are ignored. If BEG and END are nil, all undo elements are used."
2648 buffer-undo-list)))
2650 ;; The positions given in elements of the undo list are the positions
2651 ;; as of the time that element was recorded to undo history. In
2652 ;; general, subsequent buffer edits render those positions invalid in
2653 ;; the current buffer, unless adjusted according to the intervening
2654 ;; undo elements.
2655 ;;
2656 ;; Undo in region is a use case that requires adjustments to undo
2657 ;; elements. It must adjust positions of elements in the region based
2658 ;; on newer elements not in the region so as they may be correctly
2659 ;; applied in the current buffer. undo-make-selective-list
2660 ;; accomplishes this with its undo-deltas list of adjustments. An
2661 ;; example undo history from oldest to newest:
2662 ;;
2663 ;; buf pos:
2664 ;; 123456789 buffer-undo-list undo-deltas
2665 ;; --------- ---------------- -----------
2666 ;; aaa (1 . 4) (1 . -3)
2667 ;; aaba (3 . 4) N/A (in region)
2668 ;; ccaaba (1 . 3) (1 . -2)
2669 ;; ccaabaddd (7 . 10) (7 . -3)
2670 ;; ccaabdd ("ad" . 6) (6 . 2)
2671 ;; ccaabaddd (6 . 8) (6 . -2)
2672 ;; | |<-- region: "caab", from 2 to 6
2673 ;;
2674 ;; When the user starts a run of undos in region,
2675 ;; undo-make-selective-list is called to create the full list of in
2676 ;; region elements. Each element is adjusted forward chronologically
2677 ;; through undo-deltas to determine if it is in the region.
2678 ;;
2679 ;; In the above example, the insertion of "b" is (3 . 4) in the
2680 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2681 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2682 ;; . 6) is assessed as in the region and placed in the selective list.
2683 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2684 ;; due to the selected element. The "b" insertion is the only element
2685 ;; fully in the region, so in this example undo-make-selective-list
2686 ;; returns (nil (5 . 6)).
2687 ;;
2688 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2689 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2690 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2691 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2692 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2693 ;;
2694 ;; More interesting is how to adjust the "ddd" insertion due to the
2695 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2696 ;; If the reinsertion was a manual retyping of "ad", then the total
2697 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2698 ;; the reinsertion was due to undo, one might expect the first "d"
2699 ;; character would again be a part of the "ddd" text, meaning its
2700 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2701 ;;
2702 ;; undo-make-selective-list assumes in this situation that "ad" was a
2703 ;; new edit, even if it was inserted because of an undo.
2704 ;; Consequently, if the user undos in region "8 to 10" of the
2705 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2706 ;; "ccaabad", as though the first "d" became detached from the
2707 ;; original "ddd" insertion. This quirk is a FIXME.
2710 "Return a list of undo elements for the region START to END.
2711 The elements come from `buffer-undo-list', but we keep only the
2712 elements inside this region, and discard those outside this
2713 region. The elements' positions are adjusted so as the returned
2714 list can be applied to the current buffer."
2716 ;; A list of position adjusted undo elements in the region.
2718 ;; A list of undo-deltas for out of region undo elements.
2719 undo-deltas
2720 undo-elt)
2728 ;; Don't put two nils together in the list
2732 ;; This is a "was unmodified" element. Keep it
2733 ;; if we have kept everything thus far.
2736 ;; Skip over marker adjustments, instead relying
2737 ;; on finding them after (TEXT . POS) elements
2739 nil)
2742 undo-deltas)))
2747 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2748 ;; kept. primitive-undo may discard them later.
2761 "Determine whether UNDO-ELT falls inside the region START ... END.
2762 If it crosses the edge, we return nil.
2764 Generally this function is not useful for determining
2765 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2766 because markers can be arbitrarily relocated. Instead, pass the
2767 marker adjustment's corresponding (TEXT . POS) element."
2772 t)
2774 nil)
2776 ;; (TEXT . POSITION)
2780 ;; (MARKER . ADJUSTMENT)
2783 ;; (nil PROPERTY VALUE BEG . END)
2788 ;; (BEGIN . END)
2793 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2794 This assumes we have already decided that UNDO-ELT
2795 is not *inside* the region START...END."
2799 ;; (nil PROPERTY VALUE BEG . END)
2804 ;; (BEGIN . END)
2809 "Return adjustment of undo element ELT by the undo DELTAS
2810 list."
2812 ;; POSITION
2815 ;; (BEG . END)
2818 ;; (TEXT . POSITION)
2822 ;; (nil PROPERTY VALUE BEG . END)
2825 ;; (apply DELTA START END FUN . ARGS)
2826 ;; FIXME
2827 ;; All others return same elt
2830 ;; (BEG . END) can adjust to the same positions, commonly when an
2831 ;; insertion was undone and they are out of region, for example:
2832 ;;
2833 ;; buf pos:
2834 ;; 123456789 buffer-undo-list undo-deltas
2835 ;; --------- ---------------- -----------
2836 ;; [...]
2837 ;; abbaa (2 . 4) (2 . -2)
2838 ;; aaa ("bb" . 2) (2 . 2)
2839 ;; [...]
2840 ;;
2841 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2842 ;; undo. Further adjustments to such an element should be the same as
2843 ;; for (TEXT . POSITION) elements. The options are:
2844 ;;
2845 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2846 ;; analogous to marker insertion-type t.
2847 ;;
2848 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2849 ;; marker insertion-type nil.
2850 ;;
2851 ;; There was no strong reason to prefer one or the other, except that
2852 ;; the first is more consistent with prior undo in region behavior.
2854 "Return cons of adjustments to BEG and END by the undo DELTAS
2855 list."
2857 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2862 "Return adjustment of POS by the undo DELTAS list, comparing
2863 with < or <= based on USE-<."
2869 ;; Don't allow pos to become less than the undo-delta
2870 ;; position. This edge case is described in the overview
2871 ;; comments.
2874 ;; Return the first affected buffer position and the delta for an undo element
2875 ;; delta is defined as the change in subsequent buffer positions if we *did*
2876 ;; the undo.
2880 ;; (TEXT . POSITION)
2883 ;; (BEGIN . END)
2889 ;;; Default undo-boundary addition
2890 ;;
2891 ;; This section adds a new undo-boundary at either after a command is
2892 ;; called or in some cases on a timer called after a change is made in
2893 ;; any buffer.
2895 "Describe the cause of the last undo-boundary.
2897 If `explicit', the last boundary was caused by an explicit call to
2898 `undo-boundary', that is one not called by the code in this
2899 section.
2901 If it is equal to `timer', then the last boundary was inserted
2902 by `undo-auto--boundary-timer'.
2904 If it is equal to `command', then the last boundary was inserted
2905 automatically after a command, that is by the code defined in
2906 this section.
2908 If it is equal to a list, then the last boundary was inserted by
2909 an amalgamating command. The car of the list is the number of
2910 times an amalgamating command has been called, and the cdr are the
2914 "Current timer which will run `undo-auto--boundary-timer' or nil.
2919 "Non-nil if `this-command' should be amalgamated.
2920 This variable is set to nil by `undo-auto--boundaries' and is set
2924 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2928 "Return the number of amalgamating last commands or nil.
2929 Amalgamating commands are, by default, either
2930 `self-insert-command' and `delete-char', but can be any command
2931 that calls `undo-auto-amalgamate'."
2935 "Add an `undo-boundary' to the current buffer if needed.
2936 REASON describes the reason that the boundary is being added; see
2937 `undo-auto--last-boundary' for more information."
2947 undo-auto--undoably-changed-buffers)
2948 cause)))))
2951 "Check recently changed buffers and add a boundary if necessary.
2952 REASON describes the reason that the boundary is being added; see
2953 `undo-last-boundary' for more information."
2954 ;; (Bug #23785) All commands should ensure that there is an undo
2955 ;; boundary whether they have changed the current buffer or not.
2965 "Timer which will run `undo--auto-boundary-timer'."
2970 "Ensure that the `undo-auto-boundary-timer' is set."
2976 "List of buffers that have changed recently.
2978 This list is maintained by `undo-auto--undoable-change' and
2979 `undo-auto--boundaries' and can be affected by changes to their
2983 "Add an `undo-boundary' in appropriate buffers."
2988 'amalgamate
2992 "Amalgamate undo if necessary.
2993 This function can be called before an amalgamating command. It
2994 removes the previous `undo-boundary' if a series of such calls
2995 have been made. By default `self-insert-command' and
2996 `delete-char' are the only amalgamating commands, although this
2997 function could be called by any command wishing to have this
2998 behavior."
3003 last-amalgamating-count
3008 ;; Amalgamate all buffers that have changed.
3012 b
3014 ;; The head of `buffer-undo-list' is nil.
3015 ;; `car-safe' doesn't work because
3016 ;; `buffer-undo-list' need not be a list!
3024 "Called after every undoable buffer change."
3027 ;; End auto-boundary section
3030 "Amalgamate changes in change-group since HANDLE.
3031 Remove all undo boundaries between the state of HANDLE and now.
3032 HANDLE is as returned by `prepare-change-group'."
3041 ;; Temporarily truncate the undo log at ELT.
3046 ;; `elt' is still in the log: normal case.
3048 ;; `elt' is not in the log any more, but that's because
3049 ;; the log is "all new", so we should remove all
3050 ;; boundaries from it.
3054 buffer-undo-list
3055 ;; Preserve the undo-boundaries at either ends of the
3056 ;; change-groups.
3058 ;; Reset the modified cons cell ELT to its original content.
3065 "If non-nil ask about discarding undo info for the current command.
3066 Normally, Emacs discards the undo info for the current command if
3067 it exceeds `undo-outer-limit'. But if you set this option
3068 non-nil, it asks in the echo area whether to discard the info.
3069 If you answer no, there is a slight risk that Emacs might crash, so
3070 only do it if you really want to undo the command.
3072 This option is mainly intended for debugging. You have to be
3073 careful if you use it for other purposes. Garbage collection is
3074 inhibited while the question is asked, meaning that Emacs might
3075 leak memory. So you should make sure that you do not wait
3076 excessively long before answering the question."
3082 "If non-nil, an extra level of size that's ok in an undo item.
3083 We don't ask the user about truncating the undo list until the
3084 current item gets bigger than this amount.
3089 ;; When the first undo batch in an undo list is longer than
3090 ;; undo-outer-limit, this function gets called to warn the user that
3091 ;; the undo info for the current command was discarded. Garbage
3092 ;; collection is inhibited around the call, so it had better not do a
3093 ;; lot of consing.
3099 ;; Don't ask the question again unless it gets even bigger.
3100 ;; This applies, in particular, if the user quits from the question.
3101 ;; Such a quit quits out of GC, but something else will call GC
3102 ;; again momentarily. It will call this function again,
3103 ;; but we don't want to ask the question again.
3107 "Buffer `%s' undo info is %d bytes long; discard it? "
3111 t)
3112 nil))
3118 "The undo info was discarded because it exceeded \
3119 `undo-outer-limit'.
3121 This is normal if you executed a command that made a huge change
3122 to the buffer. In that case, to prevent similar problems in the
3123 future, set `undo-outer-limit' to a value that is large enough to
3124 cover the maximum size of normal changes you expect a single
3125 command to make, but not so large that it might exceed the
3126 maximum memory allotted to Emacs.
3128 If you did not execute any such command, the situation is
3129 probably due to a bug and you should report it.
3131 You can disable the popping up of this buffer by adding the entry
3132 \(undo discard-info) to the user option `warning-suppress-types',
3136 t))
3137 \f
3140 ; These are sorted according to the GNU en_US locale.
3183 )
3185 This is used by Shell mode and other parts of Emacs to recognize
3186 password prompts, including prompts in languages other than
3187 English. Different case choices should not be assumed to be
3188 included; callers should bind `case-fold-search' to t."
3194 "History list for some commands that read shell commands.
3196 Maximum length of the history list is determined by the value
3203 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3204 This buffer is used when `shell-command' or `shell-command-on-region'
3205 is run interactively. A value of nil means that output to stderr and
3212 "Return a list of all commands associated with the current file.
3213 This function is used to add all related commands retrieved by `mailcap'
3214 to the end of the list of defaults just after the default value."
3218 minibuffer-default))
3223 commands))
3234 map)
3238 "Read a shell command from the minibuffer.
3239 The arguments are the same as the ones of `read-from-minibuffer',
3240 except READ and KEYMAP are missing and HIST defaults
3241 to `shell-command-history'."
3249 minibuffer-local-shell-command-map
3250 nil
3252 args)))
3255 "What to do when the output buffer is used by another shell command.
3256 This option specifies how to resolve the conflict where a new command
3257 wants to direct its output to the buffer `*Async Shell Command*',
3258 but this buffer is already taken by another running shell command.
3260 The value `confirm-kill-process' is used to ask for confirmation before
3261 killing the already running process and running a new process
3262 in the same buffer, `confirm-new-buffer' for confirmation before running
3263 the command in a new buffer with a name other than the default buffer name,
3264 `new-buffer' for doing the same without confirmation,
3265 `confirm-rename-buffer' for confirmation before renaming the existing
3266 output buffer and running a new command in the default buffer,
3267 `rename-buffer' for doing the same without confirmation."
3269 confirm-kill-process)
3271 confirm-new-buffer)
3273 new-buffer)
3275 confirm-rename-buffer)
3277 rename-buffer))
3282 "Store a buffer position or erase the buffer.
3283 See `shell-command-dont-erase-buffer'."
3285 pos)
3287 ;; Setting buffer-read-only to nil doesn't suffice
3288 ;; if some text has a non-nil read-only property,
3289 ;; which comint sometimes adds for prompts.
3299 shell-command-saved-pos))))
3302 "Set point in BUFFER after command complete.
3303 BUFFER is the output buffer of the command; if nil, then defaults
3304 to the current BUFFER.
3305 Set point to the `cdr' of the element in `shell-command-saved-pos'
3306 whose `car' is BUFFER."
3318 ;; Set point in the window displaying buf, if any; otherwise
3319 ;; display buf temporary in selected frame and set the point.
3324 buf
3329 "Execute string COMMAND asynchronously in background.
3331 Like `shell-command', but adds `&' at the end of COMMAND
3332 to execute it asynchronously.
3334 The output appears in the buffer `*Async Shell Command*'.
3335 That buffer is in shell mode.
3337 You can configure `async-shell-command-buffer' to specify what to do in
3338 case when `*Async Shell Command*' buffer is already taken by another
3339 running shell command. To run COMMAND without displaying the output
3340 in a window you can configure `display-buffer-alist' to use the action
3341 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3343 In Elisp, you will often be better served by calling `start-process'
3344 directly, since it offers more control and does not impose the use of a
3345 shell (with its need to quote arguments)."
3355 current-prefix-arg
3356 shell-command-default-error-buffer))
3362 "Execute string COMMAND in inferior shell; display output, if any.
3363 With prefix argument, insert the COMMAND's output at point.
3365 Interactively, prompt for COMMAND in the minibuffer.
3367 If COMMAND ends in `&', execute it asynchronously.
3368 The output appears in the buffer `*Async Shell Command*'.
3369 That buffer is in shell mode. You can also use
3370 `async-shell-command' that automatically adds `&'.
3372 Otherwise, COMMAND is executed synchronously. The output appears in
3373 the buffer `*Shell Command Output*'. If the output is short enough to
3374 display in the echo area (which is determined by the variables
3375 `resize-mini-windows' and `max-mini-window-height'), it is shown
3376 there, but it is nonetheless available in buffer `*Shell Command
3377 Output*' even though that buffer is not automatically displayed.
3379 To specify a coding system for converting non-ASCII characters
3381 before this command.
3383 Noninteractive callers can specify coding systems by binding
3384 `coding-system-for-read' and `coding-system-for-write'.
3386 The optional second argument OUTPUT-BUFFER, if non-nil,
3387 says to put the output in some other buffer.
3388 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3389 and insert the output there; a non-nil value of
3390 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3391 If OUTPUT-BUFFER is not a buffer and not nil, insert the output
3392 in current buffer after point leaving mark after it.
3393 This cannot be done asynchronously.
3395 If the command terminates without error, but generates output,
3397 the output can be displayed in the echo area or in its buffer.
3398 If the output is short enough to display in the echo area
3399 \(determined by the variable `max-mini-window-height' if
3400 `resize-mini-windows' is non-nil), it is shown there.
3401 Otherwise,the buffer containing the output is displayed.
3405 of the output.
3407 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3408 or buffer name to which to direct the command's standard error output.
3409 If it is nil, error output is mingled with regular output.
3410 In an interactive call, the variable `shell-command-default-error-buffer'
3411 specifies the value of ERROR-BUFFER.
3413 In Elisp, you will often be better served by calling `call-process' or
3414 `start-process' directly, since it offers more control and does not impose
3415 the use of a shell (with its need to quote arguments)."
3426 current-prefix-arg
3427 shell-command-default-error-buffer))
3428 ;; Look for a handler in case default-directory is a remote file name.
3436 ;; Output goes in current buffer.
3442 temporary-file-directory)))
3443 nil)))
3446 ;; We do not use -f for csh; we will not support broken use of
3447 ;; .cshrcs. Even the BSD csh manual says to use
3448 ;; "if ($?prompt) exit" before things which are not useful
3449 ;; non-interactively. Besides, if someone wants their other
3450 ;; aliases for shell commands then they can still have them.
3454 t)
3455 nil shell-command-switch command)
3462 ;; Do no formatting while reading error file,
3463 ;; because that can run a shell command, and we
3464 ;; don't want that to cause an infinite recursion.
3466 ;; Put point after the inserted errors.
3470 ;; This is like exchange-point-and-mark, but doesn't
3471 ;; activate the mark. It is cleaner to avoid activation,
3472 ;; even though the command loop would deactivate the mark
3473 ;; because we inserted text.
3477 ;; Output goes in a separate buffer.
3478 ;; Preserve the match data in case called from a program.
3479 ;; FIXME: It'd be ridiculous for an Elisp function to call
3480 ;; shell-command and assume that it won't mess the match-data!
3483 ;; Command ending with ampersand means asynchronous.
3487 proc)
3488 ;; Remove the ampersand.
3490 ;; Ask the user what to do with already running process.
3495 ;; If will kill a process, query first.
3500 ;; If will create a new buffer, query first.
3507 ;; It will create a new buffer.
3512 ;; If will rename the buffer, query first.
3521 ;; It will rename the buffer.
3531 shell-command-switch command))
3535 ;; Use the comint filter for proper handling of carriage motion
3536 ;; (see `comint-inhibit-carriage-motion'),.
3538 ))
3539 ;; Otherwise, command is executed synchronously.
3541 output-buffer nil error-buffer)))))))
3544 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3545 MESSAGE may be either a string or a buffer.
3547 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3548 for maximum height of the echo area, as defined by `max-mini-window-height'
3549 if `resize-mini-windows' is non-nil.
3551 Returns either the string shown in the echo area, or when a pop-up
3552 buffer is used, the window used to display it.
3554 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3555 name of the buffer used to display it in the case where a pop-up buffer
3556 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3557 string and it is displayed in the echo area, it is not specified whether
3558 the contents are inserted into the buffer anyway.
3560 Optional arguments ACTION and FRAME are as for `display-buffer',
3561 and are only used if a pop-up buffer is displayed."
3563 ;; Trivial case where we can use the echo area
3567 ;; Trivial case where we can just remove single trailing newline
3570 ;; General case
3573 message
3582 0
3586 (<= lines
3590 max-mini-window-height))
3592 max-mini-window-height)
3596 ;; Don't use the echo area if the output buffer is
3597 ;; already displayed in the selected frame.
3599 ;; Echo area
3605 ;; Buffer
3610 ;; We have a sentinel to prevent insertion of a termination message
3611 ;; in the buffer itself, and to set the point in the buffer when
3612 ;; `shell-command-dont-erase-buffer' is non-nil.
3621 &optional output-buffer replace
3622 error-buffer display-error-buffer
3623 region-noncontiguous-p)
3624 "Execute string COMMAND in inferior shell with region as input.
3625 Normally display output (if any) in temp buffer `*Shell Command Output*';
3626 Prefix arg means replace the region with it. Return the exit code of
3627 COMMAND.
3629 To specify a coding system for converting non-ASCII characters
3631 before this command. By default, the input (from the current buffer)
3632 is encoded using coding-system specified by `process-coding-system-alist',
3633 falling back to `default-process-coding-system' if no match for COMMAND
3634 is found in `process-coding-system-alist'.
3636 Noninteractive callers can specify coding systems by binding
3637 `coding-system-for-read' and `coding-system-for-write'.
3639 If the command generates output, the output may be displayed
3640 in the echo area or in a buffer.
3641 If the output is short enough to display in the echo area
3642 \(determined by the variable `max-mini-window-height' if
3643 `resize-mini-windows' is non-nil), it is shown there.
3644 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3645 The output is available in that buffer in both cases.
3647 If there is output and an error, a message about the error
3648 appears at the end of the output.
3650 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3651 command's output. If the value is a buffer or buffer name,
3652 erase that buffer and insert the output there; a non-nil value of
3653 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3654 If the value is nil, use the buffer `*Shell Command Output*'.
3655 Any other non-nil value means to insert the output in the
3656 current buffer after START.
3658 Optional fifth arg REPLACE, if non-nil, means to insert the
3659 output in place of text from START to END, putting point and mark
3660 around it.
3662 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3663 or buffer name to which to direct the command's standard error
3664 output. If nil, error output is mingled with regular output.
3665 When called interactively, `shell-command-default-error-buffer'
3666 is used for ERROR-BUFFER.
3668 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3669 display the error buffer if there were any errors. When called
3670 interactively, this is t."
3674 ;; Do this before calling region-beginning
3675 ;; and region-end, in case subprocess output
3676 ;; relocates them while we are in the minibuffer.
3678 ;; call-interactively recognizes region-beginning and
3679 ;; region-end specially, leaving them in the history.
3681 string
3682 current-prefix-arg
3683 current-prefix-arg
3684 shell-command-default-error-buffer
3685 t
3692 temporary-file-directory)))
3693 nil))
3694 exit-status)
3695 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3698 output)
3702 shell-file-name t t
3703 nil shell-command-switch
3704 command)
3711 ;; Replace specified region with output from command.
3713 ;; Don't muck with mark unless REPLACE says we should.
3720 t)))
3721 ;; It is rude to delete a buffer which the command is not using.
3722 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3723 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3724 ;; (kill-buffer shell-buffer)))
3725 ;; Don't muck with mark unless REPLACE says we should.
3727 ;; No prefix argument: put the output in a temp buffer,
3728 ;; replacing its entire contents.
3736 ;; If the input is the same buffer as the output,
3737 ;; delete everything but the specified region,
3738 ;; then replace that region with the output.
3744 shell-file-name t
3747 t)
3748 nil shell-command-switch
3749 command)))
3750 ;; Clear the output buffer, then run the command with
3751 ;; output there.
3761 buffer))))
3762 ;; Report the output.
3772 ;; There's some output, display it
3776 ;; No output; error?
3783 shell-command-default-error-buffer)
3790 output))
3793 exit-status))
3796 exit-status output))))
3797 ;; Don't kill: there might be useful info in the undo-log.
3798 ;; (kill-buffer buffer)
3799 )))))
3807 ;; Do no formatting while reading error file,
3808 ;; because that can run a shell command, and we
3809 ;; don't want that to cause an infinite recursion.
3811 ;; Put point after the inserted errors.
3816 exit-status))
3819 "Execute shell command COMMAND and return its output as a string."
3822 standard-output
3826 "Process files synchronously in a separate process.
3827 Similar to `call-process', but may invoke a file handler based on
3828 `default-directory'. The current working directory of the
3829 subprocess is `default-directory'.
3831 File names in INFILE and BUFFER are handled normally, but file
3832 names in ARGS should be relative to `default-directory', as they
3833 are passed to the process verbatim. (This is a difference to
3834 `call-process' which does not support file handlers for INFILE
3835 and BUFFER.)
3837 Some file handlers might not support all variants, for example
3838 they might behave as if DISPLAY was nil, regardless of the actual
3839 value passed."
3841 lc stderr-file)
3851 display args)
3857 "Whether a call of `process-file' changes remote files.
3859 By default, this variable is always set to t, meaning that a
3860 call of `process-file' could potentially change any file on a
3861 remote host. When set to nil, a file handler could optimize
3862 its behavior with respect to remote file attribute caching.
3864 You should only ever change this variable with a let-binding;
3868 "Start a program in a subprocess. Return the process object for it.
3870 Similar to `start-process', but may invoke a file handler based on
3871 `default-directory'. See Info node `(elisp)Magic File Names'.
3873 This handler ought to run PROGRAM, perhaps on the local host,
3874 perhaps on a remote host that corresponds to `default-directory'.
3875 In the latter case, the local part of `default-directory' becomes
3876 the working directory of the process.
3878 PROGRAM and PROGRAM-ARGS might be file names. They are not
3879 objects of file handler invocation. File handlers might not
3880 support pty association, if PROGRAM is nil."
3884 \f
3885 ;;;; Process menu
3899 map))
3902 "Major mode for listing the processes called by Emacs."
3915 "Kill process at point in a `list-processes' buffer."
3926 "Recompute the list of processes for the Process List buffer.
3927 Also, delete any process that is exited or signaled."
3941 face link
3943 "Visit buffer `%s'"
3945 follow-link t
3946 process-buffer ,buf
3947 action process-menu-visit-buffer)
3956 "datagram"
3973 tabulated-list-entries))))))
3979 "Display a list of all processes that are Emacs sub-processes.
3980 If optional argument QUERY-ONLY is non-nil, only processes with
3981 the query-on-exit flag set are listed.
3982 Any process listed as exited or signaled is actually eliminated
3983 after the listing is made.
3984 Optional argument BUFFER specifies a buffer to use, instead of
3986 The return value is always nil.
3988 This function lists only processes that were launched by Emacs. To
3989 see other processes running on the system, use `list-system-processes'."
4001 nil)
4002 \f
4003 ;;;; Prefix commands
4009 ;; BEWARE: Called directly from C code.
4010 ;; If the return value is non-nil, it means we are in the middle of
4011 ;; a command with prefix, such as a command invoked with prefix-arg.
4013 prefix-command--last-echo
4022 "Abnormal hook which constructs the description of the current prefix state.
4026 "Update state of prefix commands.
4034 "Pass the current prefix command state to the next command.
4035 Should be called by all prefix commands.
4036 Runs `prefix-command-preserve-state-hook'."
4038 ;; If the current command is a prefix command, we don't want the next (real)
4039 ;; command to have `last-command' set to, say, `universal-argument'.
4046 nil)
4048 ;;;;; The main prefix command.
4050 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
4075 ;; For backward compatibility, minus with no modifiers is an ordinary
4076 ;; command if digits have already been entered.
4106 map)
4114 "Begin a numeric argument for the following command.
4119 multiplies the argument by 4 each time.
4121 which is different in effect from any particular numeric argument.
4129 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
4130 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
4137 arg)))
4141 "Begin a negative numeric argument for the next command.
4151 "Part of the numeric argument for the next command.
4156 last-command-event
4163 ;; Treat -0 as just -, so that -01 will work.
4166 digit))))
4168 \f
4171 "This variable is a wrapper hook around `buffer-substring--filter'.
4177 "Function to perform the filtering in `filter-buffer-substring'.
4178 The function is called with the same 3 arguments (BEG END DELETE)
4179 that `filter-buffer-substring' received. It should return the
4180 buffer substring between BEG and END, after filtering. If DELETE is
4184 "List of filter functions for `buffer-substring--filter'.
4185 Each function must accept a single argument, a string, and return a string.
4186 The buffer substring is passed to the first function in the list,
4187 and the return value of each function is passed to the next.
4188 As a special convention, point is set to the start of the buffer text
4189 being operated on (i.e., the first argument of `buffer-substring--filter')
4195 "Return the buffer substring between BEG and END, after filtering.
4196 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4198 This calls the function that `filter-buffer-substring-function' specifies
4199 \(passing the same three arguments that it received) to do the work,
4200 and returns whatever it does. The default function does no filtering,
4201 unless a hook has been set.
4203 Use `filter-buffer-substring' instead of `buffer-substring',
4204 `buffer-substring-no-properties', or `delete-and-extract-region' when
4205 you want to allow filtering to take place. For example, major or minor
4206 modes can use `filter-buffer-substring-function' to extract characters
4207 that are special to a buffer, and should not be copied into other buffers."
4211 "Default function to use for `filter-buffer-substring-function'.
4212 Its arguments and return value are as specified for `filter-buffer-substring'.
4213 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4214 \(see `with-wrapper-hook' for details about wrapper hooks),
4215 and the abnormal hook `buffer-substring-filters'.
4216 No filtering is done unless a hook says to."
4227 string)))
4232 ;;;; Window system cut and paste hooks.
4235 "Function to call to make a killed region available to other programs.
4236 Most window systems provide a facility for cutting and pasting
4237 text between different programs, such as the clipboard on X and
4238 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4240 This variable holds a function that Emacs calls whenever text is
4241 put in the kill ring, to make the new kill available to other
4242 programs. The function takes one argument, TEXT, which is a
4246 "Function to call to get text cut from other programs.
4247 Most window systems provide a facility for cutting and pasting
4248 text between different programs, such as the clipboard on X and
4249 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4251 This variable holds a function that Emacs calls to obtain text
4252 that other programs have provided for pasting. The function is
4253 called with no arguments. If no other program has provided text
4254 to paste, the function should return nil (in which case the
4255 caller, usually `current-kill', should use the top of the Emacs
4256 kill ring). If another program has provided text to paste, the
4257 function should return that text as a string (in which case the
4258 caller should put this string in the kill ring as the latest
4259 kill).
4261 The function may also return a list of strings if the window
4262 system supports multiple selections. The first string will be
4263 used as the pasted text, but the other will be placed in the kill
4264 ring for easy access via `yank-pop'.
4266 Note that the function should return a string only if a program
4267 other than Emacs has provided a string for pasting; if Emacs
4268 provided the most recent string, the function should return nil.
4269 If it is difficult to tell whether Emacs or some other program
4270 provided the current string, it is probably good enough to return
4271 nil if the string is equal (according to `string=') to the last
4273 \f
4276 ;;;; The kill ring data structure.
4279 "List of killed text sequences.
4280 Since the kill ring is supposed to interact nicely with cut-and-paste
4281 facilities offered by window systems, use of this variable should
4282 interact nicely with `interprogram-cut-function' and
4283 `interprogram-paste-function'. The functions `kill-new',
4284 `kill-append', and `current-kill' are supposed to implement this
4285 interaction; you may want to use them instead of manipulating the kill
4289 "Maximum length of kill ring before oldest elements are thrown away."
4297 "Save clipboard strings into kill ring before replacing them.
4298 When one selects something in another program to paste it into Emacs,
4299 but kills something in Emacs before actually pasting it,
4300 this selection is gone unless this variable is non-nil,
4301 in which case the other program's selection is saved in the `kill-ring'
4308 "Do not add a new string to `kill-ring' if it duplicates the last one.
4309 The comparison is done using `equal-including-properties'."
4315 "Make STRING the latest kill in the kill ring.
4316 Set `kill-ring-yank-pointer' to point to it.
4317 If `interprogram-cut-function' is non-nil, apply it to STRING.
4318 Optional second argument REPLACE non-nil means that STRING will replace
4319 the front of the kill ring, rather than being added to the list.
4321 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4322 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4323 STRING.
4325 When the yank handler has a non-nil PARAM element, the original STRING
4326 argument is not used by `insert-for-yank'. However, since Lisp code
4327 may access and use elements from the kill ring directly, the STRING
4330 ;; Due to text properties such as 'yank-handler that
4331 ;; can alter the contents to yank, comparison using
4332 ;; `equal' is unsafe.
4357 ;; It has been argued that this should work similar to `self-insert-command'
4358 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4360 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4366 "Append STRING to the end of the latest kill in the kill ring.
4367 If BEFORE-P is non-nil, prepend STRING to the kill.
4368 Also removes the last undo boundary in the current buffer,
4369 depending on `kill-append-merge-undo'.
4370 If `interprogram-cut-function' is set, pass the resulting kill to it."
4378 ;; find the next undo boundary
4382 ;; remove this undo boundary
4387 "Whether rotating the kill ring changes the window system selection.
4388 If non-nil, whenever the kill ring is rotated (usually via the
4389 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4390 to copy the new kill to the window system selection."
4396 "Rotate the yanking point by N places, and then return that kill.
4397 If N is zero and `interprogram-paste-function' is set to a
4398 function that returns a string or a list of strings, and if that
4399 function doesn't return nil, then that string (or list) is added
4400 to the front of the kill ring and the string (or first string in
4401 the list) is returned as the latest kill.
4403 If N is not zero, and if `yank-pop-change-selection' is
4404 non-nil, use `interprogram-cut-function' to transfer the
4405 kill at the new yank point into the window system selection.
4407 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4408 move the yanking point; just return the Nth kill forward."
4411 interprogram-paste-function
4415 ;; Disable the interprogram cut function when we add the new
4416 ;; text to the kill ring, so Emacs doesn't try to own the
4417 ;; selection, with identical text.
4427 kill-ring)))
4432 interprogram-cut-function)
4438 ;;;; Commands for manipulating the kill ring.
4441 "Non-nil means don't signal an error for killing read-only text."
4447 This deletes the text from the buffer and saves it in the kill ring.
4451 If you want to append the killed region to the last killed text,
4455 If the previous command was also a kill command,
4456 the text killed this time appends to the text killed last time
4457 to make one entry in the kill ring.
4459 The killed text is filtered by `filter-buffer-substring' before it is
4460 saved in the kill ring, so the actual saved text might be different
4461 from what was killed.
4463 If the buffer is read-only, Emacs will beep and refrain from deleting
4464 the text, but put the text in the kill ring anyway. This means that
4465 you can use the killing commands to copy text from a read-only buffer.
4467 Lisp programs should use this function for killing text.
4468 (To delete text, use `delete-region'.)
4469 Supply two arguments, character positions BEG and END indicating the
4470 stretch of text to be killed. If the optional argument REGION is
4471 non-nil, the function ignores BEG and END, and kills the current
4472 region instead."
4473 ;; Pass mark first, then point, because the order matters when
4474 ;; calling `kill-append'.
4483 ;; Add that string to the kill ring, one way or another.
4490 nil)
4492 ;; The code above failed because the buffer, or some of the characters
4493 ;; in the region, are read-only.
4494 ;; We should beep, in case the user just isn't aware of this.
4495 ;; However, there's no harm in putting
4496 ;; the region's text in the kill ring, anyway.
4498 ;; Set this-command now, so it will be set even if we get an error.
4500 ;; This should barf, if appropriate, and give us the correct error.
4503 ;; Signal an error if the buffer is read-only.
4505 ;; If the buffer isn't read-only, the text is.
4508 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4509 ;; to get two copies of the text when the user accidentally types M-w and
4510 ;; then corrects it with the intended C-w.
4512 "Save the region as if killed, but don't kill it.
4513 In Transient Mark mode, deactivate the mark.
4514 If `interprogram-cut-function' is non-nil, also save the text for a window
4515 system cut and paste.
4517 The copied text is filtered by `filter-buffer-substring' before it is
4518 saved in the kill ring, so the actual saved text might be different
4519 from what was in the buffer.
4521 When called from Lisp, save in the kill ring the stretch of text
4522 between BEG and END, unless the optional argument REGION is
4523 non-nil, in which case ignore BEG and END, and save the current
4524 region instead.
4526 This command's old key binding has been given to `kill-ring-save'."
4527 ;; Pass mark first, then point, because the order matters when
4528 ;; calling `kill-append'.
4538 nil)
4541 "Save the region as if killed, but don't kill it.
4542 In Transient Mark mode, deactivate the mark.
4543 If `interprogram-cut-function' is non-nil, also save the text for a window
4544 system cut and paste.
4546 If you want to append the killed line to the last killed text,
4549 The copied text is filtered by `filter-buffer-substring' before it is
4550 saved in the kill ring, so the actual saved text might be different
4551 from what was in the buffer.
4553 When called from Lisp, save in the kill ring the stretch of text
4554 between BEG and END, unless the optional argument REGION is
4555 non-nil, in which case ignore BEG and END, and save the current
4556 region instead.
4558 This command is similar to `copy-region-as-kill', except that it gives
4559 visual feedback indicating the extent of the region being copied."
4560 ;; Pass mark first, then point, because the order matters when
4561 ;; calling `kill-append'.
4565 ;; This use of called-interactively-p is correct because the code it
4566 ;; controls just gives the user visual feedback.
4571 "Indicate that the region text has been copied interactively.
4572 If the mark is visible in the selected window, blink the cursor
4573 between point and mark if there is currently no active region
4574 highlighting.
4576 If the mark lies outside the selected window, display an
4577 informative message containing a sample of the copied text. The
4578 optional argument MESSAGE-LEN, if non-nil, specifies the length
4579 of this sample text; it defaults to 40."
4582 ;; Inhibit quitting so we can make a quit here
4583 ;; look like a C-g typed as a command.
4586 ;; Swap point-and-mark quickly so as to show the region that
4587 ;; was selected. Don't do it if the region is highlighted.
4590 ;; Swap point and mark.
4594 ;; Swap back.
4597 ;; If user quit, deactivate the mark
4598 ;; as C-g would as a command.
4604 ;; Don't say "killed"; that is misleading.
4611 "Cause following command, if it kills, to add to previous kill.
4612 If the next command kills forward from point, the kill is
4613 appended to the previous killed text. If the command kills
4614 backward, the kill is prepended. Kill commands that act on the
4615 region, such as `kill-region', are regarded as killing forward if
4616 point is after mark, and killing backward if point is before
4617 mark.
4619 If the next command is not a kill command, `append-next-kill' has
4620 no effect.
4622 The argument is used for internal purposes; do not supply one."
4624 ;; We don't use (interactive-p), since that breaks kbd macros.
4638 "A subroutine of `squeeze-bidi-context'.
4639 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4643 lim1)
4650 ;; L and R categories include embedding and
4651 ;; override controls, but we don't want to
4652 ;; replace them, because that might change
4653 ;; the visual order. Likewise with PDF and
4654 ;; isolate controls.
4656 bidi-directional-non-controls-chars
4657 limit)))))
4658 ;; Replace any run of non-RTL characters by a single LRM.
4660 ;; No more characters of CATEGORY, we are done.
4665 ;; Skip directional controls, if any.
4670 "Replace characters between FROM and TO while keeping bidi context.
4672 This function replaces the region of text with as few characters
4673 as possible, while preserving the effect that region will have on
4674 bidirectional display before and after the region."
4678 ;; This is for when they copy text with read-only text
4679 ;; properties.
4683 ;; Replace each run of non-RTL characters with a single LRM.
4685 ;; Replace each run of non-LTR characters with a single RLM. Note
4686 ;; that the \cR category includes both the Arabic Letter (AL) and
4687 ;; R characters; here we ignore the distinction between them,
4688 ;; because that distinction only affects Arabic Number (AN)
4689 ;; characters, which are weak and don't affect the reordering.
4693 "Return buffer text between START and END with its bidi context.
4695 START and END are assumed to belong to the same physical line
4696 of buffer text. This function prepends and appends to the text
4697 between START and END bidi control characters that preserve the
4698 visual order of that text when it is inserted at some other place."
4703 substr para-dir from to)
4710 ;; If we don't have any mixed directional characters in the
4711 ;; entire line, we can just copy the substring without adding
4712 ;; any context.
4727 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4728 ;; (1) force the string to have the same base embedding
4729 ;; direction as the paragraph direction at the source, no matter
4730 ;; what is the paragraph direction at destination; and (2) avoid
4731 ;; affecting the visual order of the surrounding text at
4732 ;; destination if there are characters of different
4733 ;; directionality there.
4738 "Return portion of current buffer between START and END with bidi context.
4740 This function works similar to `buffer-substring', but it prepends and
4741 appends to the text bidi directional control characters necessary to
4742 preserve the visual appearance of the text if it is inserted at another
4743 place. This is useful when the buffer substring includes bidirectional
4744 text and control characters that cause non-trivial reordering on display.
4745 If copied verbatim, such text can have a very different visual appearance,
4746 and can also change the visual appearance of the surrounding text at the
4747 destination of the copy.
4749 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4750 the text properties."
4763 no-properties)))
4767 substr)))
4768 \f
4769 ;; Yanking.
4774 "List of special text property handling conditions for yanking.
4775 Each element should have the form (PROP . FUN), where PROP is a
4776 property symbol and FUN is a function. When the `yank' command
4777 inserts text into the buffer, it scans the inserted text for
4778 stretches of text that have `eq' values of the text property
4779 PROP; for each such stretch of text, FUN is called with three
4780 arguments: the property's value in that text, and the start and
4781 end positions of the text.
4783 This is done prior to removing the properties specified by
4784 `yank-excluded-properties'."
4787 function))
4790 ;; This is actually used in subr.el but defcustom does not work there.
4793 intangible invisible keymap local-map mouse-face read-only
4794 yank-handler)
4795 "Text properties to discard when yanking.
4796 The value should be a list of text properties to discard or t,
4797 which means to discard all text properties.
4799 See also `yank-handled-properties'."
4806 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4807 Function is called with two parameters, START and END corresponding to
4808 the value of the mark and point; it is guaranteed that START <= END.
4812 "Replace just-yanked stretch of killed text with a different stretch.
4813 This command is allowed only immediately after a `yank' or a `yank-pop'.
4814 At such a time, the region contains a stretch of reinserted
4815 previously-killed text. `yank-pop' deletes that text and inserts in its
4816 place a different stretch of killed text.
4818 With no argument, the previous kill is inserted.
4819 With argument N, insert the Nth previous kill.
4820 If N is negative, this is a more recent kill.
4822 The sequence of kills wraps around, so that after the oldest one
4823 comes the newest one.
4825 This command honors the `yank-handled-properties' and
4826 `yank-excluded-properties' variables, and the `yank-handler' text
4827 property, in the way that `yank' does."
4841 ;; Set the window start back where it was in the yank command,
4842 ;; if possible.
4845 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4846 ;; It is cleaner to avoid activation, even though the command
4847 ;; loop would deactivate the mark because we inserted text.
4850 nil)
4854 More precisely, reinsert the most recent kill, which is the
4855 stretch of killed text most recently killed OR yanked. Put point
4856 at the end, and set mark at the beginning without activating it.
4858 With argument N, reinsert the Nth most recent kill.
4860 This command honors the `yank-handled-properties' and
4861 `yank-excluded-properties' variables, and the `yank-handler' text
4862 property, as described below.
4864 Properties listed in `yank-handled-properties' are processed,
4865 then those listed in `yank-excluded-properties' are discarded.
4867 If STRING has a non-nil `yank-handler' property anywhere, the
4868 normal insert behavior is altered, and instead, for each contiguous
4869 segment of STRING that has a given value of the `yank-handler'
4870 property, that value is used as follows:
4872 The value of a `yank-handler' property must be a list of one to four
4873 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
4874 FUNCTION, if non-nil, should be a function of one argument (the
4875 object to insert); FUNCTION is called instead of `insert'.
4876 PARAM, if present and non-nil, is passed to FUNCTION (to be handled
4877 in whatever way is appropriate; e.g. if FUNCTION is `yank-rectangle',
4878 PARAM may be a list of strings to insert as a rectangle). If PARAM
4879 is nil, then the current segment of STRING is used.
4880 If NOEXCLUDE is present and non-nil, the normal removal of
4881 `yank-excluded-properties' is not performed; instead FUNCTION is
4882 responsible for the removal. This may be necessary if FUNCTION
4883 adjusts point before or after inserting the object.
4884 UNDO, if present and non-nil, should be a function to be called
4885 by `yank-pop' to undo the insertion of the current PARAM. It is
4886 given two arguments, the start and end of the region. FUNCTION
4887 may set `yank-undo-function' to override UNDO.
4892 ;; If we don't get all the way thru, make last-command indicate that
4893 ;; for the following command.
4901 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4902 ;; It is cleaner to avoid activation, even though the command
4903 ;; loop would deactivate the mark because we inserted text.
4906 ;; If we do get all the way thru, make this-command indicate that.
4909 nil)
4912 "Rotate the yanking point in the kill ring.
4913 With ARG, rotate that many kills forward (or backward, if negative)."
4916 \f
4917 ;; Some kill commands.
4919 ;; Internal subroutine of delete-char
4925 ;; Internal subroutine of backward-delete-char
4932 "The method for untabifying when deleting backward.
4933 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4934 `hungry' -- delete all whitespace, both tabs and spaces;
4935 `all' -- delete all whitespace, including tabs, spaces and newlines;
4936 nil -- just delete one character."
4942 "Delete characters backward, changing tabs into spaces.
4943 The exact behavior depends on `backward-delete-char-untabify-method'.
4944 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4945 Interactively, ARG is the prefix arg (default 1)
4946 and KILLP is t if a prefix arg was specified."
4969 arg)))
4970 ;; Avoid warning about delete-backward-char
4974 "Kill up to and including ARGth occurrence of CHAR.
4975 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4976 Goes backward if ARG is negative; error if CHAR not found."
4979 ;; Avoid "obsolete" warnings for translation-table-for-input.
4987 ;; kill-line and its subroutines.
4990 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4995 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4996 With prefix argument ARG, kill that many lines from point.
4997 Negative arguments kill lines backward.
4998 With zero argument, kills the text before point on the current line.
5001 a number counts as a prefix arg.
5003 To kill a whole line, when point is not at the beginning, type \
5006 If `show-trailing-whitespace' is non-nil, this command will just
5007 kill the rest of the current line, even if there are no nonblanks
5008 there.
5010 If option `kill-whole-line' is non-nil, then this command kills the whole line
5011 including its terminating newline, when used at the beginning of a line
5012 with no argument. As a consequence, you can always kill a whole line
5015 If you want to append the killed line to the last killed text,
5018 If the buffer is read-only, Emacs will beep and refrain from deleting
5019 the line, but put the line in the kill ring anyway. This means that
5020 you can use this command to copy text from a read-only buffer.
5021 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5022 even beep.)"
5025 ;; It is better to move point to the other end of the kill
5026 ;; before killing. That way, in a read-only buffer, point
5027 ;; moves across the text that is copied to the kill ring.
5028 ;; The choice has no effect on undo now that undo records
5029 ;; the value of point from before the command was run.
5039 ;; If trailing whitespace is visible,
5040 ;; don't treat it as nothing.
5050 "Kill current line.
5051 With prefix ARG, kill that many lines starting from the current line.
5052 If ARG is negative, kill backward. Also kill the preceding newline.
5054 If ARG is zero, kill current line but exclude the trailing newline."
5065 ;; We need to kill in two steps, because the previous command
5066 ;; could have been a kill command, in which case the text
5067 ;; before point needs to be prepended to the current kill
5068 ;; ring entry and the text after point appended. Also, we
5069 ;; need to use save-excursion to avoid copying the same text
5070 ;; twice to the kill ring in read-only buffers.
5088 "Move forward by ARG lines, ignoring currently invisible newlines only.
5089 If ARG is negative, move backward -ARG lines.
5090 If ARG is zero, move to the beginning of the current line."
5097 ;; If the newline we just skipped is invisible,
5098 ;; don't count it.
5102 prop
5107 ;; If invisible text follows, and it is a number of complete lines,
5108 ;; skip it.
5114 prop
5130 ;; If the newline we just moved to is invisible,
5131 ;; don't count it.
5136 prop
5141 ;; If invisible text follows, and it is a number of complete lines,
5142 ;; skip it.
5148 prop
5159 nil)))
5162 "Move to end of current visible line."
5164 ;; If the following character is currently invisible,
5165 ;; skip all characters with that same `invisible' property value,
5166 ;; then find the next newline.
5173 prop
5184 "Kill the current buffer.
5185 When called in the minibuffer, get out of the minibuffer
5186 using `abort-recursive-edit'.
5188 This is like `kill-this-buffer', but it doesn't have to be invoked
5189 via the menu bar, and pays no attention to the menu-bar's frame."
5197 \f
5199 "Insert after point the contents of BUFFER.
5200 Puts mark after the inserted text.
5201 BUFFER may be a buffer or a buffer name."
5211 t))))
5216 nil)
5219 "Append to specified buffer the text of the region.
5220 It is inserted into that buffer before its point.
5222 When calling from a program, give three arguments:
5223 BUFFER (or buffer name), START and END.
5224 START and END specify the portion of the current buffer to be copied."
5231 point)
5242 "Prepend to specified buffer the text of the region.
5243 It is inserted into that buffer after its point.
5245 When calling from a program, give three arguments:
5246 BUFFER (or buffer name), START and END.
5247 START and END specify the portion of the current buffer to be copied."
5256 "Copy to specified buffer the text of the region.
5257 It is inserted into that buffer, replacing existing text there.
5259 When calling from a program, give three arguments:
5260 BUFFER (or buffer name), START and END.
5261 START and END specify the portion of the current buffer to be copied."
5269 \f
5273 "Hook run when the mark becomes active.
5274 It is also run at the end of a command, if the mark is active and
5281 "Return this buffer's mark value as integer, or nil if never set.
5283 In Transient Mark mode, this function signals an error if
5284 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5285 or the argument FORCE is non-nil, it disregards whether the mark
5286 is active, and returns an integer or nil in the usual way.
5288 If you are using this in an editing command, you are most likely making
5289 a mistake; see the documentation of `set-mark'."
5294 ;; Behind display-selections-p.
5297 "Deactivate the mark.
5298 If Transient Mark mode is disabled, this function normally does
5299 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5301 Deactivating the mark sets `mark-active' to nil, updates the
5302 primary selection according to `select-active-regions', and runs
5303 `deactivate-mark-hook'.
5305 If Transient Mark mode was temporarily enabled, reset the value
5306 of the variable `transient-mark-mode'; if this causes Transient
5307 Mark mode to be disabled, don't change `mark-active' to nil or
5308 run `deactivate-mark-hook'."
5312 select-active-regions)
5315 ;; The var `saved-region-selection', if non-nil, is the text in
5316 ;; the region prior to the last command modifying the buffer.
5317 ;; Set the selection to that, or to the current region.
5322 ;; If another program has acquired the selection, region
5323 ;; deactivation should not clobber it (Bug#11772).
5342 "Activate the mark.
5343 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5353 "Set this buffer's mark to POS. Don't use this function!
5354 That is to say, don't use this function unless you want
5355 the user to see that the mark has moved, and you want the previous
5356 mark position to be lost.
5358 Normally, when a new mark is set, the old one should go on the stack.
5359 This is why most applications should use `push-mark', not `set-mark'.
5361 Novice Emacs Lisp programmers often try to use the mark for the wrong
5362 purposes. The mark saves a location for the user's convenience.
5363 Most editing commands should not alter the mark.
5364 To remember a location for internal use in the Lisp program,
5365 store it in a Lisp variable. Example:
5367 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5372 ;; Normally we never clear mark-active except in Transient Mark mode.
5373 ;; But when we actually clear out the mark value too, we must
5374 ;; clear mark-active in any mode.
5376 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5377 ;; it should never be nil if the mark is nil.
5385 mark-active))
5392 ;; Mark marker
5398 ;; Mark active
5401 ;; If mark is active now, and either was not active or was at a
5402 ;; different place, run the activate hook.
5407 ;; If mark has ceased to be active, run deactivate hook.
5412 "Like `save-excursion', but also save and restore the mark state.
5413 This macro does what `save-excursion' did before Emacs 25.1."
5423 If nil, region-aware commands treat the empty region as inactive.
5424 If non-nil, region-aware commands treat the region as active as
5425 long as the mark is active, even if the region is empty.
5427 Region-aware commands are those that act on the region if it is
5428 active and Transient Mark mode is enabled, and on the text near
5429 point otherwise."
5435 "Return t if the region is active and it is appropriate to act on it.
5436 This is used by commands that act specially on the region under
5437 Transient Mark mode.
5439 The return value is t if Transient Mark mode is enabled and the
5440 mark is active; furthermore, if `use-empty-active-region' is nil,
5441 the region must not be empty. Otherwise, the return value is nil.
5443 For some commands, it may be appropriate to ignore the value of
5444 `use-empty-active-region'; in that case, use `region-active-p'."
5449 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5451 Some commands act specially on the region when Transient Mark
5452 mode is enabled. Usually, such commands should use
5453 `use-region-p' instead of this function, because `use-region-p'
5454 also checks the value of `use-empty-active-region'."
5456 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5457 ;; without the mark being set (e.g. bug#17324). We really should fix
5458 ;; that problem, but in the mean time, let's make sure we don't say the
5459 ;; region is active when there's no mark.
5463 "Return the boundaries of the region as a list of (START . END) positions."
5467 "Return non-nil if the region contains several pieces.
5468 An example is a rectangular region handled as a list of
5469 separate contiguous regions for each line."
5482 ;; Normal priority so that a large region doesn't hide all the
5483 ;; overlays within it, but high secondary priority so that if it
5484 ;; ends/starts in the middle of a small overlay, that small overlay
5485 ;; won't hide the region's boundaries.
5487 nrol)
5492 rol)))
5508 start end window rol)))
5511 new))))))
5514 "Hook run just before redisplay.
5515 It is called in each window that is to be redisplayed. It takes one argument,
5516 which is the window that will be redisplayed. When run, the `current-buffer'
5537 "Maximum size of mark ring. Start discarding off end if gets this big."
5545 "Maximum size of global mark ring. \
5546 Start discarding off end if gets this big."
5551 "Jump to mark, and pop a new position for mark off the ring.
5552 \(Does not affect global mark ring)."
5562 "Set mark at where point is.
5563 If no prefix ARG and mark is already set there, just activate it.
5564 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5576 will pop the mark twice, and
5578 will pop the mark three times.
5586 "Set the mark where point is, and activate it; or jump to the mark.
5587 Setting the mark also alters the region, which is the text
5588 between point and mark; this is the closest equivalent in
5591 With no prefix argument, set the mark at point, and push the
5592 old mark position on local mark ring. Also push the new mark on
5593 global mark ring, if the previous mark was set in another buffer.
5595 When Transient Mark Mode is off, immediately repeating this
5596 command activates `transient-mark-mode' temporarily.
5599 jump to the mark, and set the mark from
5600 position popped off the local mark ring (this does not affect the global
5602 mark ring (see `pop-global-mark').
5604 If `set-mark-command-repeat-pop' is non-nil, repeating
5606 off the local (or global) mark ring and jumps there.
5609 argument, unconditionally set mark where point is, even if
5610 `set-mark-command-repeat-pop' is non-nil.
5612 Novice Emacs Lisp programmers often try to use the mark for the wrong
5613 purposes. See the documentation of `set-mark' for more information."
5633 arg)
5647 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5648 If the last global mark pushed was not in the current buffer,
5649 also push LOCATION on the global mark ring.
5650 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5652 Novice Emacs Lisp programmers often try to use the mark for the wrong
5653 purposes. See the documentation of `set-mark' for more information.
5655 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5662 ;; Now push the mark on the global mark ring.
5665 ;; The last global mark pushed was in this same buffer.
5666 ;; Don't push another one.
5667 nil
5676 nil)
5679 "Pop off mark ring into the buffer's actual mark.
5680 Does not set point. Does nothing if mark ring is empty."
5692 "Put the mark where point is now, and point where the mark is now.
5693 This command works even when the mark is not active,
5694 and it reactivates the mark.
5696 If Transient Mark mode is on, a prefix ARG deactivates the mark
5697 if it is active, and otherwise avoids reactivating it. If
5698 Transient Mark mode is off, a prefix ARG enables Transient Mark
5699 mode temporarily."
5713 nil))
5716 "When non-nil, shifted motion keys activate the mark momentarily.
5718 While the mark is activated in this way, any shift-translated point
5719 motion key extends the region, and if Transient Mark mode was off, it
5720 is temporarily turned on. Furthermore, the mark will be deactivated
5721 by any subsequent point motion key that was not shift-translated, or
5722 by any action that normally deactivates the mark in Transient Mark mode.
5724 See `this-command-keys-shift-translated' for the meaning of
5725 shift-translation."
5730 "Activate/deactivate mark depending on invocation thru shift translation.
5731 This function is called by `call-interactively' when a command
5732 with a `^' character in its `interactive' spec is invoked, before
5733 running the command itself.
5735 If `shift-select-mode' is enabled and the command was invoked
5736 through shift translation, set the mark and activate the region
5737 temporarily, unless it was already set in this way. See
5738 `this-command-keys-shift-translated' for the meaning of shift
5739 translation.
5741 Otherwise, if the region has been activated temporarily,
5742 deactivate it, and restore the variable `transient-mark-mode' to
5743 its earlier value."
5750 transient-mark-mode)))
5759 "Toggle Transient Mark mode.
5760 With a prefix argument ARG, enable Transient Mark mode if ARG is
5761 positive, and disable it otherwise. If called from Lisp, enable
5762 Transient Mark mode if ARG is omitted or nil.
5764 Transient Mark mode is a global minor mode. When enabled, the
5765 region is highlighted with the `region' face whenever the mark
5767 and after certain other operations that set the mark but whose
5768 main purpose is something else--for example, incremental search,
5774 Many commands change their behavior when Transient Mark mode is
5775 in effect and the mark is active, by acting on the region instead
5776 of their usual default part of the buffer's text. Examples of
5779 To see the documentation of commands which are sensitive to the
5782 :global t
5783 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5787 "Non-nil means it is ok for commands to call `widen' when they want to.
5788 Some commands will do this in order to go to positions outside
5789 the current accessible part of the buffer.
5791 If `widen-automatically' is nil, these commands will do something else
5795 "Whether the currently executing code is performing an essential task.
5796 This variable should be non-nil only when running code which should not
5797 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5798 user for a password when we are simply scanning a set of files in the
5799 background or displaying possible completions before the user even asked
5803 "Pop off global mark ring and jump to the top location."
5805 ;; Pop entries which refer to non-existent buffers.
5823 \f
5825 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5831 "Move cursor vertically down ARG lines.
5832 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5833 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5834 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5835 function will not vscroll.
5837 ARG defaults to 1.
5839 If there is no character in the target line exactly under the current column,
5840 the cursor is positioned after the character in that line which spans this
5841 column, or at the end of the line if it is not long enough.
5842 If there is no line in the buffer after this one, behavior depends on the
5843 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5844 to create a line, and moves the cursor to that line. Otherwise it moves the
5845 cursor to the end of the buffer.
5847 If the variable `line-move-visual' is non-nil, this command moves
5848 by display lines. Otherwise, it moves by buffer lines, without
5849 taking variable-width characters or continued lines into account.
5853 a semipermanent goal column for this command.
5854 Then instead of trying to move exactly vertically (or as close as possible),
5855 this command moves to the specified goal column (or as close as possible).
5856 The goal column is stored in the variable `goal-column', which is nil
5857 when there is no goal column. Note that setting `goal-column'
5858 overrides `line-move-visual' and causes this command to move by buffer
5859 lines rather than by display lines."
5865 ;; When adding a newline, don't expand an abbrev.
5876 nil)
5879 "Move cursor vertically up ARG lines.
5880 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5881 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5882 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5883 function will not vscroll.
5885 ARG defaults to 1.
5887 If there is no character in the target line exactly over the current column,
5888 the cursor is positioned after the character in that line which spans this
5889 column, or at the end of the line if it is not long enough.
5891 If the variable `line-move-visual' is non-nil, this command moves
5892 by display lines. Otherwise, it moves by buffer lines, without
5893 taking variable-width characters or continued lines into account.
5897 a semipermanent goal column for this command.
5898 Then instead of trying to move exactly vertically (or as close as possible),
5899 this command moves to the specified goal column (or as close as possible).
5900 The goal column is stored in the variable `goal-column', which is nil
5901 when there is no goal column. Note that setting `goal-column'
5902 overrides `line-move-visual' and causes this command to move by buffer
5903 lines rather than by display lines."
5914 nil)
5917 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5918 This means moving to the end of each line moved onto.
5919 The beginning of a blank line does not count as the end of a line.
5920 This has no effect when the variable `line-move-visual' is non-nil."
5926 A non-nil setting overrides the variable `line-move-visual', which see."
5933 "Current goal column for vertical motion.
5934 It is the column where point was at the start of the current run
5935 of vertical motion commands.
5937 When moving by visual lines via the function `line-move-visual', it is a cons
5938 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5939 divided by the default column width, and HSCROLL is the number of
5940 columns by which window is scrolled from left margin.
5942 When the `track-eol' feature is doing its job, the value is
5946 "Non-nil means commands that move by lines ignore invisible newlines.
5947 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5948 as if newlines that are invisible didn't exist, and count
5949 only visible newlines. Thus, moving across across 2 newlines
5950 one of which is invisible will be counted as a one-line move.
5951 Also, a non-nil value causes invisible text to be ignored when
5952 counting columns for the purposes of keeping point in the same
5955 Outline mode sets this."
5960 "When non-nil, `line-move' moves point by visual lines.
5961 This movement is based on where the cursor is displayed on the
5962 screen, instead of relying on buffer contents alone. It takes
5963 into account variable-width characters and line continuation.
5964 If nil, `line-move' moves point by logical lines.
5965 A non-nil setting of `goal-column' overrides the value of this variable
5966 and forces movement by logical lines.
5967 A window that is horizontally scrolled also forces movement by logical
5968 lines."
5973 ;; Only used if display-graphic-p.
5977 "Return the height in pixels of the current buffer's default face font.
5979 If the default font is remapped (see `face-remapping-alist'), the
5980 function returns the height of the remapped face."
5984 ;; Avoid calling font-info if the frame's default font was
5985 ;; not changed since the frame was created. That's because
5986 ;; font-info is expensive for some fonts, see bug #14838.
5992 "Return the width in pixels of the current buffer's default face font.
5994 If the default font is remapped (see `face-remapping-alist'), the
5995 function returns the width of the remapped face."
5999 ;; Avoid calling font-info if the frame's default font was
6000 ;; not changed since the frame was created. That's because
6001 ;; font-info is expensive for some fonts, see bug #14838.
6006 width
6011 "Return the pixel height of current buffer's default-face text line.
6013 The value includes `line-spacing', if any, defined for the buffer
6014 or the frame."
6027 "Return the number of screen lines in the text area of the selected window.
6029 This is different from `window-text-height' in that this function counts
6030 lines in units of the height of the font used by the default face displayed
6031 in the window, not in units of the frame's default font, and also accounts
6032 for `line-spacing', if any, defined for the window's buffer or frame.
6034 The value is a floating-point number."
6039 ;; Returns non-nil if partial move was done.
6042 ;; Move backward (up).
6043 ;; If already vscrolled, reduce vscroll
6049 ;; Move forward (down).
6062 py vs last-line)
6082 col-row)
6087 ;; VPOS > 0 means the last line is only partially visible.
6088 ;; But if the part that is visible is at least as tall as the
6089 ;; default font, that means the line is actually fully
6090 ;; readable, and something like line-spacing is hidden. So in
6091 ;; that case we accept the last line in the window as still
6092 ;; visible, and consider the margin as starting one line
6093 ;; later.
6101 ;; If last line of window is fully visible, and vscrolling
6102 ;; more would make this line invisible, move forward.
6107 nil)
6108 ;; If cursor is not in the bottom scroll margin, and the
6109 ;; current line is is not too tall, move forward.
6111 vpos
6114 nil)
6115 ;; When already vscrolled, we vscroll some more if we can,
6116 ;; or clear vscroll and move forward at end of tall image.
6121 ;; If cursor just entered the bottom scroll margin, move forward,
6122 ;; but also optionally vscroll one line so redisplay won't recenter.
6126 ;; Don't vscroll if the partially-visible line at window
6127 ;; bottom is not too tall (a.k.a. "just one more text
6128 ;; line"): in that case, we do want redisplay to behave
6129 ;; normally, i.e. recenter or whatever.
6130 ;;
6131 ;; Note: ROWH + RBOT from the value returned by
6132 ;; pos-visible-in-window-p give the total height of the
6133 ;; partially-visible glyph row at the end of the window. As
6134 ;; we are dealing with floats, we disregard sub-pixel
6135 ;; discrepancies between that and DLH.
6139 t)
6140 ;; If there are lines above the last line, scroll-up one line.
6143 t)
6144 ;; Finally, start vscroll.
6149 ;; This is like line-move-1 except that it also performs
6150 ;; vertical scrolling of tall images if appropriate.
6151 ;; That is not really a clean thing to do, since it mixes
6152 ;; scrolling with cursor motion. But so far we don't have
6153 ;; a cleaner solution to the problem of making C-n do something
6154 ;; useful given a tall image.
6156 "Move forward ARG lines.
6157 If NOERROR, don't signal an error if we can't move ARG lines.
6158 TO-END is unused.
6159 TRY-VSCROLL controls whether to vscroll tall lines: if either
6160 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6161 not vscroll."
6165 ;; Only vscroll for single line moves
6167 ;; Under scroll-conservatively, the display engine
6168 ;; does this better.
6170 ;; But don't vscroll in a keyboard macro.
6176 ;; Display-based column are incompatible with goal-column.
6178 ;; When the text in the window is scrolled to the left,
6179 ;; display-based motion doesn't make sense (because each
6180 ;; logical line occupies exactly one screen line).
6182 ;; Likewise when the text _was_ scrolled to the left
6183 ;; when the current run of vertical motion commands
6184 ;; started.
6187 auto-hscroll-mode
6189 (>= temporary-goal-column
6192 ;; If we moved into a tall line, set vscroll to make
6193 ;; scrolling through tall images more smooth.
6197 winh)
6203 nil
6207 ;; Display-based alternative to line-move-1.
6208 ;; Arg says how many lines to move. The value is t if we can move the
6209 ;; specified number of lines.
6211 "Move ARG lines forward.
6212 If NOERROR, don't signal an error if we can't move that many lines."
6215 target-hscroll)
6216 ;; Check if the previous command was a line-motion command, or if
6217 ;; we were called from some other command.
6220 ;; If so, there's no need to reset `temporary-goal-column',
6221 ;; but we may need to hscroll.
6225 ;; Otherwise, we should reset `temporary-goal-column'.
6227 x-pos)
6229 ;; Handle the `overflow-newline-into-fringe' case:
6234 ;; In R2L lines, the X pixel coordinate is measured from the
6235 ;; left edge of the window, but columns are still counted
6236 ;; from the logical-order beginning of the line, i.e. from
6237 ;; the right edge in this case. We need to adjust for that.
6243 hscroll)))
6245 ;; When we move beyond the first/last character visible in
6246 ;; the window, posn-at-point will return nil, so we need to
6247 ;; approximate the goal column as below.
6252 ;; vertical-motion can move more than it was asked to if it moves
6253 ;; across display strings with newlines. We don't want to ring
6254 ;; the bell and announce beginning/end of buffer in that case.
6260 temporary-goal-column))
6261 arg))
6262 arg))
6268 temporary-goal-column))
6269 arg))
6270 arg)))
6273 ;; If the goal column lies on a display string,
6274 ;; `vertical-motion' advances the cursor to the end
6275 ;; of the string. For arg < 0, this can cause the
6276 ;; cursor to get stuck. (Bug#3020).
6280 nil)))))
6282 ;; This is the guts of next-line and previous-line.
6283 ;; Arg says how many lines to move.
6284 ;; The value is t if we can move the specified number of lines.
6286 ;; Don't run any point-motion hooks, and disregard intangibility,
6287 ;; for intermediate positions.
6299 ;; Don't count beg of empty line as end of line
6300 ;; unless we just did explicit end-of-line.
6302 most-positive-fixnum
6306 line-move-ignore-invisible))
6307 ;; Use just newline characters.
6308 ;; Set ARG to 0 if we move as many lines as requested.
6311 ;; This way of moving forward ARG lines
6312 ;; verifies that we have a newline after the last one.
6313 ;; It doesn't get confused by intangible text.
6322 'beginning-of-buffer
6324 nil)))
6325 ;; Move by arg lines, but ignore invisible ones.
6328 ;; If the following character is currently invisible,
6329 ;; skip all characters with that same `invisible' property value.
6332 ;; Move a line.
6333 ;; We don't use `end-of-line', since we want to escape
6334 ;; from field boundaries occurring exactly at point.
6340 ;; If there's no invisibility here, move over the newline.
6349 ;; We avoid vertical-motion when possible
6350 ;; because that has to fontify.
6352 ;; Otherwise move a more sophisticated way.
6359 ;; The logic of this is the same as the loop above,
6360 ;; it just goes in the other direction.
6362 ;; For completely consistency with the forward-motion
6363 ;; case, we should call beginning-of-line here.
6364 ;; However, if point is inside a field and on a
6365 ;; continued line, the call to (vertical-motion -1)
6366 ;; below won't move us back far enough; then we return
6367 ;; to the same column in line-move-finish, and point
6368 ;; gets stuck -- cyd
6386 ;; if our target is the middle of this line.
6391 ;; This is the value the function returns.
6395 ;; If we did not move down as far as desired, at least go
6396 ;; to end of line. Be sure to call point-entered and
6397 ;; point-left-hooks.
6403 ;; If we did not move up as far as desired,
6404 ;; at least go to beginning of line.
6416 ;; Set REPEAT to t to repeat the whole thing.
6423 ;; Compute the end of the line
6424 ;; ignoring effectively invisible newlines.
6426 ;; Like end-of-line but ignores fields.
6433 ;; Move to the desired column.
6436 ;; Under line-move-visual, goal-column should be
6437 ;; interpreted in units of the frame's canonical character
6438 ;; width, which is exactly what vertical-motion does.
6442 ;; Corner case: suppose we start out in a field boundary in
6443 ;; the middle of a continued line. When we get to
6444 ;; line-move-finish, point is at the start of a new *screen*
6445 ;; line but the same text line; then line-move-to-column would
6446 ;; move us backwards. Test using C-n with point on the "x" in
6447 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6454 ;; Process intangibility within a line.
6455 ;; With inhibit-point-motion-hooks bound to nil, a call to
6456 ;; goto-char moves point past intangible text.
6458 ;; However, inhibit-point-motion-hooks controls both the
6459 ;; intangibility and the point-entered/point-left hooks. The
6460 ;; following hack avoids calling the point-* hooks
6461 ;; unnecessarily. Note that we move *forward* past intangible
6462 ;; text when the initial and final points are the same.
6467 ;; If intangibility moves us to a different (later) place
6468 ;; in the same line, use that as the destination.
6471 ;; If that position is "too late",
6472 ;; try the previous allowable position.
6473 ;; See if it is ok.
6476 ;; If going forward, don't accept the previous
6477 ;; allowable position if it is before the target line.
6479 ;; If going backward, don't accept the previous
6480 ;; allowable position if it is still after the target line.
6483 ;; As a last resort, use the end of the line.
6486 ;; Now move to the updated destination, processing fields
6487 ;; as well as intangibility.
6491 ;; Ignore field boundaries if the initial and final
6492 ;; positions have the same `field' property, even if the
6493 ;; fields are non-contiguous. This seems to be "nicer"
6494 ;; behavior in many situations.
6497 new
6501 ;; If all this moved us to a different line,
6502 ;; retry everything within that new line.
6504 ;; Repeat the intangibility and field processing.
6508 "Try to find column COL, considering invisibility.
6509 This function works only in certain cases,
6510 because what we really need is for `move-to-column'
6511 and `current-column' to be able to ignore invisible text."
6520 ;; If the following character is currently invisible,
6521 ;; skip all characters with that same `invisible' property value.
6525 ;; Have we advanced to a larger column position?
6527 ;; We have made some progress towards the desired column.
6528 ;; See if we can make any further progress.
6530 ;; Otherwise, go to the place we originally found
6531 ;; and move back over invisible text.
6532 ;; that will get us to the same place on the screen
6533 ;; but with a more reasonable buffer position.
6536 ;; We want the real line beginning, so it's consistent
6537 ;; with bolp below, otherwise we might infloop.
6544 "Move point to end of current line as displayed.
6545 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6546 If point reaches the beginning or end of buffer, it stops there.
6548 To ignore the effects of the `intangible' text or overlay
6549 property, bind `inhibit-point-motion-hooks' to t.
6550 If there is an image in the current line, this function
6551 disregards newlines that are part of the text on which the image
6552 rests."
6562 ;; With bidi reordering, we may not be at bol,
6563 ;; so make sure we are.
6578 ;; If we skipped something intangible and now we're not
6579 ;; really at eol, keep going.
6584 "Move point to beginning of current line as displayed.
6585 \(If there's an image in the line, this disregards newlines
6586 which are part of the text that the image rests on.)
6588 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6589 If point reaches the beginning or end of buffer, it stops there.
6590 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6595 first-vis first-vis-field-value)
6597 ;; Move by lines, if ARG is not 1 (the default).
6602 ;; Move to beginning-of-line, ignoring fields and invisible text.
6608 ;; Now find first visible char in the line.
6613 ;; See if fields would stop us from reaching FIRST-VIS.
6618 ;; If yes, obey them.
6619 first-vis-field-value
6620 ;; Otherwise, move to START with attention to fields.
6621 ;; (It is possible that fields never matter in this case.)
6626 ;; Many people have said they rarely use this feature, and often type
6627 ;; it by accident. Maybe it shouldn't even be on a key.
6632 Those commands will move to this position in the line moved to
6633 rather than trying to keep the same horizontal position.
6634 With a non-nil argument ARG, clears out the goal column
6636 The goal column is stored in the variable `goal-column'.
6637 This is a buffer-local setting."
6644 ;; The older method below can be erroneous if `set-goal-column' is bound
6645 ;; to a sequence containing %
6646 ;;(message (substitute-command-keys
6647 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6648 ;;goal-column)
6655 )
6656 nil)
6657 \f
6658 ;;; Editing based on visual lines, as opposed to logical lines.
6661 "Move point to end of current visual line.
6662 With argument N not nil or 1, move forward N - 1 visual lines first.
6663 If point reaches the beginning or end of buffer, it stops there.
6664 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6670 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6671 ;; constrain to field boundaries, so we don't either.
6675 "Move point to beginning of current visual line.
6676 With argument N not nil or 1, move forward N - 1 visual lines first.
6677 If point reaches the beginning or end of buffer, it stops there.
6678 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6686 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6690 "Kill the rest of the visual line.
6691 With prefix argument ARG, kill that many visual lines from point.
6692 If ARG is negative, kill visual lines backward.
6693 If ARG is zero, kill the text before point on the current visual
6694 line.
6696 If you want to append the killed line to the last killed text,
6699 If the buffer is read-only, Emacs will beep and refrain from deleting
6700 the line, but put the line in the kill ring anyway. This means that
6701 you can use this command to copy text from a read-only buffer.
6702 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6703 even beep.)"
6705 ;; Like in `kill-line', it's better to move point to the other end
6706 ;; of the kill before killing.
6714 ;; Skip any trailing whitespace at the end of the visual line.
6715 ;; We used to do this only if `show-trailing-whitespace' is
6716 ;; nil, but that's wrong; the correct thing would be to check
6717 ;; whether the trailing whitespace is highlighted. But, it's
6718 ;; OK to just do this unconditionally.
6725 "Move cursor vertically down ARG lines.
6726 This is identical to `next-line', except that it always moves
6727 by logical lines instead of visual lines, ignoring the value of
6728 the variable `line-move-visual'."
6735 "Move cursor vertically up ARG lines.
6736 This is identical to `previous-line', except that it always moves
6737 by logical lines instead of visual lines, ignoring the value of
6738 the variable `line-move-visual'."
6745 "Editing based on visual lines."
6754 ;; These keybindings interfere with xterm function keys. Are
6755 ;; there any other suitable bindings?
6756 ;; (define-key map "\M-[" 'previous-logical-line)
6757 ;; (define-key map "\M-]" 'next-logical-line)
6758 map))
6761 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6762 The value should be a list of the form (LEFT RIGHT), where LEFT
6763 and RIGHT are symbols representing the bitmaps to display, to
6764 indicate wrapped lines, in the left and right fringes respectively.
6765 See also `fringe-indicator-alist'.
6766 The default is not to display fringe indicators for wrapped lines.
6767 This variable does not affect fringe indicators displayed for
6768 other purposes."
6783 'continuation
6790 "Toggle visual line based editing (Visual Line mode).
6791 With a prefix argument ARG, enable Visual Line mode if ARG is
6792 positive, and disable it otherwise. If called from Lisp, enable
6793 the mode if ARG is omitted or nil.
6795 When Visual Line mode is enabled, `word-wrap' is turned on in
6796 this buffer, and simple editing commands are redefined to act on
6797 visual lines, not logical lines. See Info node `Visual Line
6798 Mode' for details."
6799 :keymap visual-line-mode-map
6805 ;; Save the local values of some variables, to be restored if
6806 ;; visual-line-mode is turned off.
6808 truncate-partial-width-windows
6809 word-wrap fringe-indicator-alist))
6812 visual-line--saved-state)))
6816 word-wrap t
6817 fringe-indicator-alist
6819 fringe-indicator-alist)))
6833 visual-line-mode turn-on-visual-line-mode)
6835 \f
6837 "Interchange characters around point, moving forward one character.
6838 With prefix arg ARG, effect is to take character before point
6839 and drag it forward past ARG other characters (backward if ARG negative).
6840 If no argument and at end of line, the previous two chars are exchanged."
6848 "Interchange words around point, leaving point at end of them.
6849 With prefix arg ARG, effect is to take word before or around point
6850 and drag it forward past ARG other words (backward if ARG negative).
6851 If ARG is zero, the words around or after point and around or after mark
6852 are interchanged."
6853 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6859 Unlike `transpose-words', point must be between the two sexps and not
6860 in the middle of a sexp to be transposed.
6861 With non-zero prefix arg ARG, effect is to take the sexp before point
6862 and drag it forward past ARG other sexps (backward if ARG is negative).
6863 If ARG is zero, the sexps ending at or after point and at or after mark
6864 are interchanged."
6868 ;; Here we should try to simulate the behavior of
6869 ;; (cons (progn (forward-sexp x) (point))
6870 ;; (progn (forward-sexp (- x)) (point)))
6871 ;; Except that we don't want to rely on the second forward-sexp
6872 ;; putting us back to where we want to be, since forward-sexp-function
6873 ;; might do funny things like infix-precedence.
6878 ;; Jumping over a symbol. We might be inside it, mind you.
6883 ;; Otherwise, we're between sexps. Take a step back before jumping
6884 ;; to make sure we'll obey the same precedence no matter which direction
6885 ;; we're going.
6890 'skip-syntax-forward
6897 "Exchange current line and previous line, leaving point after both.
6898 With argument ARG, takes previous line and moves it past ARG lines.
6899 With argument 0, interchanges line point is in with line mark is in."
6905 ;; Move forward over ARG lines,
6906 ;; but create newlines if necessary.
6913 arg))
6915 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6916 ;; which seems inconsistent with the ARG /= 0 case.
6917 ;; FIXME document SPECIAL.
6919 "Subroutine to do the work of transposing objects.
6920 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6921 moves forward by units of the given object (e.g. forward-sentence,
6922 forward-paragraph). If ARG is zero, exchanges the current object
6923 with the one containing mark. If ARG is an integer, moves the
6924 current object past ARG following (if ARG is positive) or
6925 preceding (if ARG is negative) objects, leaving point after the
6926 current object."
6931 pos1 pos2)
6960 ;; This sequence of insertions attempts to preserve marker
6961 ;; positions at the start and end of the transposed objects.
6975 \f
6977 "Move backward until encountering the beginning of a word.
6978 With argument ARG, do this that many times.
6979 If ARG is omitted or nil, move point backward one word.
6981 The word boundaries are normally determined by the buffer's syntax
6982 table, but `find-word-boundary-function-table', such as set up
6983 by `subword-mode', can change that. If a Lisp program needs to
6984 move by words determined strictly by the syntax table, it should
6985 use `backward-word-strictly' instead."
6990 "Set mark ARG words away from point.
6992 move to with the same argument.
6993 Interactively, if this command is repeated
6994 or (in Transient Mark mode) if the mark is active,
6995 it marks the next ARG words after the ones already marked."
7012 nil t))))
7015 "Kill characters forward until encountering the end of a word.
7016 With argument ARG, do this that many times."
7021 "Kill characters backward until encountering the beginning of a word.
7022 With argument ARG, do this that many times."
7027 "Return the word at or near point, as a string.
7028 The return value includes no text properties.
7030 If optional arg STRICT is non-nil, return nil unless point is
7031 within or adjacent to a word, otherwise look for a word within
7032 point's line. If there is no word anywhere on point's line, the
7033 value is nil regardless of STRICT.
7035 By default, this function treats as a single word any sequence of
7036 characters that have either word or symbol syntax. If optional
7037 arg REALLY-WORD is non-nil, only characters of word syntax can
7038 constitute a word."
7047 ;; Point is neither within nor adjacent to a word.
7049 ;; Look for preceding word in same line.
7052 ;; No preceding word in same line.
7053 ;; Look for following word in same line.
7062 ;; If we found something nonempty, return it as a string.
7065 \f
7067 "String for filling to insert at front of new line, or nil for none."
7069 string)
7075 "Regexp to match lines which should not be auto-filled."
7077 regexp)
7081 "The default value for `normal-auto-fill-function'.
7082 This is the default auto-fill function, some major modes use a different one.
7083 Returns t if it really did any work."
7093 nil ;; Auto-filling not required
7097 ;; Choose a fill-prefix automatically.
7105 ;; Use auto-indentation rather than a guessed empty prefix.
7111 ;; Determine where to split the line.
7124 ;; See whether the place we found is any good.
7128 ;; There is no use breaking at end of line.
7130 ;; It is futile to split at the end of the prefix
7131 ;; since we would just insert the prefix again.
7133 ;; Don't split right after a comment starter
7134 ;; since we would just make another comment starter.
7139 limit t)
7141 ;; No good place to break => stop trying.
7143 ;; Ok, we have a useful place to break the line. Do it.
7145 ;; If point is at the fill-point, do not `save-excursion'.
7146 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7147 ;; point will end up before it rather than after it.
7155 ;; Now do justification, if required
7160 ;; If making the new line didn't reduce the hpos of
7161 ;; the end of the line, then give up now;
7162 ;; trying again will not help.
7165 ;; Justify last line.
7167 t)))
7170 "Mode-specific function which line breaks and continues a comment.
7171 This function is called during auto-filling when a comment syntax
7172 is defined.
7173 The function should take a single optional argument, which is a flag
7177 "Break line at point and indent.
7178 If a comment syntax is defined, call `comment-indent-new-line'.
7180 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7181 unless optional argument SOFT is non-nil."
7185 ;; Insert the newline before removing empty space so that markers
7186 ;; get preserved better.
7192 ;; Blindly trust a non-adaptive fill-prefix.
7198 ;; If there's an adaptive prefix, use it unless we're inside
7199 ;; a comment and the prefix is not a comment starter.
7203 ;; If we're not inside a comment, just try to indent.
7207 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7211 ;; `functions' and `hooks' are usually unsafe to set, but setting
7212 ;; auto-fill-function to nil in a file-local setting is safe and
7213 ;; can be useful to prevent auto-filling.
7217 "Toggle automatic line breaking (Auto Fill mode).
7218 With a prefix argument ARG, enable Auto Fill mode if ARG is
7219 positive, and disable it otherwise. If called from Lisp, enable
7220 the mode if ARG is omitted or nil.
7222 When Auto Fill mode is enabled, inserting a space at a column
7223 beyond `current-fill-column' automatically breaks the line at a
7224 previous space.
7226 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7227 non-nil.
7229 The value of `normal-auto-fill-function' specifies the function to use
7230 for `auto-fill-function' when turning Auto Fill mode on."
7235 ;; This holds a document string used to document auto-fill-mode.
7237 "Automatically break line at a previous space, in insertion of text."
7238 nil)
7241 "Unconditionally turn on Auto Fill mode."
7245 "Unconditionally turn off Auto Fill mode."
7251 "Set `fill-column' to specified argument.
7256 ;; We used to use current-column silently, but C-x f is too easily
7257 ;; typed as a typo for C-x C-f, so we turned it into an error and
7258 ;; now an interactive prompt.
7263 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7267 \f
7269 "Set `selective-display' to ARG; clear it if no arg.
7270 When the value of `selective-display' is a number > 0,
7271 lines whose indentation is >= that value are not displayed.
7272 The variable `selective-display' has a separate value for each buffer."
7292 "Toggle truncating of long lines for the current buffer.
7293 When truncating is off, long lines are folded.
7294 With prefix argument ARG, truncate long lines if ARG is positive,
7295 otherwise fold them. Note that in side-by-side windows, this
7296 command has no effect if `truncate-partial-width-windows' is
7297 non-nil."
7309 nil t)))
7314 "Toggle whether to use word-wrapping for continuation lines.
7315 With prefix argument ARG, wrap continuation lines at word boundaries
7316 if ARG is positive, otherwise wrap them at the right screen edge.
7317 This command toggles the value of `word-wrap'. It has no effect
7318 if long lines are truncated."
7334 "Toggle Overwrite mode.
7335 With a prefix argument ARG, enable Overwrite mode if ARG is
7336 positive, and disable it otherwise. If called from Lisp, enable
7337 the mode if ARG is omitted or nil.
7339 When Overwrite mode is enabled, printing characters typed in
7340 replace existing text on a one-for-one basis, rather than pushing
7341 it to the right. At the end of a line, such characters extend
7342 the line. Before a tab, such characters insert until the tab is
7344 overwrite mode; this is supposed to make it easier to insert
7345 characters when necessary."
7350 "Toggle Binary Overwrite mode.
7351 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7352 is positive, and disable it otherwise. If called from Lisp,
7353 enable the mode if ARG is omitted or nil.
7355 When Binary Overwrite mode is enabled, printing characters typed
7356 in replace existing text. Newlines are not treated specially, so
7357 typing at the end of a line joins the line to the next, with the
7358 typed character between them. Typing before a tab character
7359 simply replaces the tab with the character typed.
7361 ordinary typing characters do.
7363 Note that Binary Overwrite mode is not its own minor mode; it is
7364 a specialization of overwrite mode, entered by setting the
7365 `overwrite-mode' variable to `overwrite-mode-binary'."
7370 "Toggle line number display in the mode line (Line Number mode).
7371 With a prefix argument ARG, enable Line Number mode if ARG is
7372 positive, and disable it otherwise. If called from Lisp, enable
7373 the mode if ARG is omitted or nil.
7375 Line numbers do not appear for very large buffers and buffers
7376 with very long lines; see variables `line-number-display-limit'
7377 and `line-number-display-limit-width'."
7381 "Toggle column number display in the mode line (Column Number mode).
7382 With a prefix argument ARG, enable Column Number mode if ARG is
7383 positive, and disable it otherwise.
7385 If called from Lisp, enable the mode if ARG is omitted or nil."
7389 "Toggle buffer size display in the mode line (Size Indication mode).
7390 With a prefix argument ARG, enable Size Indication mode if ARG is
7391 positive, and disable it otherwise.
7393 If called from Lisp, enable the mode if ARG is omitted or nil."
7397 "Toggle auto-saving in the current buffer (Auto Save mode).
7398 With a prefix argument ARG, enable Auto Save mode if ARG is
7399 positive, and disable it otherwise.
7401 If called from Lisp, enable the mode if ARG is omitted or nil."
7403 ;; If auto-save is off because buffer has shrunk,
7404 ;; then toggling should turn it on.
7412 buffer-file-name)
7414 ;; If -1 was stored here, to temporarily turn off saving,
7415 ;; turn it back on.
7418 \f
7420 "Blinking matching of parens and expressions."
7425 "Non-nil means show matching open-paren when close-paren is inserted.
7426 If t, highlight the paren. If `jump', briefly move cursor to its
7427 position. If `jump-offscreen', move cursor there even if the
7428 position is off screen. With any other non-nil value, the
7429 off-screen position of the opening paren will be shown in the
7430 echo area."
7439 "Non-nil means show matching open-paren when it is on screen.
7440 If nil, don't show it (but the open-paren can still be shown
7441 in the echo area when it is off screen).
7443 This variable has no effect if `blink-matching-paren' is nil.
7444 \(In that case, the open-paren is never shown.)
7445 It is also ignored if `show-paren-mode' is enabled."
7450 "If non-nil, maximum distance to search backwards for matching open-paren.
7451 If nil, search stops at the beginning of the accessible portion of the buffer."
7457 "Time in seconds to delay after showing a matching paren."
7462 "If nil, `blink-matching-paren' ignores comments.
7463 More precisely, when looking for the matching parenthesis,
7464 it skips the contents of comments that end before point."
7469 "Return whether or not START...END are matching parens.
7470 END is the current point and START is the blink position.
7471 START might be nil if no matching starter was found.
7472 Returns non-nil if we find there is a mismatch."
7477 ;; For self-matched chars like " and $, we can't know when they're
7478 ;; mismatched or unmatched, so we can only do it for parens.
7483 ;; The cdr might hold a new paren-class info rather than
7484 ;; a matching-char info, in which case the two CDRs
7485 ;; should match.
7489 "Function to check parentheses mismatches.
7490 The function takes two arguments (START and END) where START is the
7491 position just before the opening token and END is the position right after.
7492 START can be nil, if it was not found.
7499 ol)
7503 "Momentarily highlight the beginning of the sexp before point."
7506 blink-matching-paren)
7516 oldpos))
7524 ;; backward-sexp skips backward over prefix chars,
7525 ;; so move back to the matching paren.
7548 ;; Matching open within window, temporarily move to or highlight
7549 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7550 ;; is non-nil.
7567 ;; Show what precedes the open in its line, if anything.
7572 ;; Show what follows the open in its line, if anything.
7579 ;; Otherwise show the previous nonblank line,
7580 ;; if there is one.
7589 ;; Replace the newline and other whitespace with `...'.
7590 "..."
7592 ;; There is nothing to show except the char itself.
7595 "Matches %s"
7599 "Function called, if non-nil, whenever a close parenthesis is inserted.
7605 blink-paren-function
7608 ;; Verify an even number of quoting characters precede the close.
7609 ;; FIXME: Also check if this parenthesis closes a comment as
7610 ;; can happen in Pascal and SML.
7621 ;; Most likely, this hook is nil, so this arg doesn't matter,
7622 ;; but I use it as a reminder that this function usually
7623 ;; likes to be run after others since it does
7624 ;; `sit-for'. That's also the reason it get a `priority' prop
7625 ;; of 100.
7627 \f
7628 ;; This executes C-g typed while Emacs is waiting for a command.
7629 ;; Quitting out of a program does not go through here;
7630 ;; that happens in the maybe_quit function at the C code level.
7632 "Signal a `quit' condition.
7633 During execution of Lisp code, this character causes a quit directly.
7634 At top-level, as an editor command, this simply beeps."
7636 ;; Avoid adding the region to the window selection.
7644 ;; Force the next redisplay cycle to remove the "Def" indicator from
7645 ;; all the mode lines.
7659 This command can exit an interactive command such as `query-replace',
7660 can clear out a prefix argument or a region,
7661 can get out of the minibuffer or other recursive edit,
7662 cancel the use of the current buffer (for special-purpose buffers),
7663 or go back to just one window (by deleting all but the selected window)."
7671 nil)
7682 "Play sound stored in FILE.
7683 VOLUME and DEVICE correspond to the keywords of the sound
7684 specification for `play-sound'."
7694 \f
7696 "Your preference for a mail reading package.
7697 This is used by some keybindings which support reading mail.
7698 See also `mail-user-agent' concerning sending mail."
7708 "Your preference for a mail composition package.
7709 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7710 outgoing email message. This variable lets you specify which
7711 mail-sending package you prefer.
7713 Valid values include:
7715 `message-user-agent' -- use the Message package.
7716 See Info node `(message)'.
7717 `sendmail-user-agent' -- use the Mail package.
7718 See Info node `(emacs)Sending Mail'.
7719 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7720 See Info node `(mh-e)'.
7721 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7722 paraphernalia if Gnus is running, particularly
7723 the Gcc: header for archiving.
7725 Additional valid symbols may be available; check with the author of
7726 your package for details. The function should return non-nil if it
7727 succeeds.
7729 See also `read-mail-command' concerning reading mail."
7732 message-user-agent)
7735 sendmail-user-agent)
7738 mh-e-user-agent)
7741 gnus-user-agent)
7747 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7748 If the value of `mail-user-agent' is the default, and the user
7749 appears to have customizations applying to the old default,
7750 `compose-mail' issues a warning."
7756 "If the buffer starts with a mail header, move point to the header's end.
7757 Otherwise, moves to `point-min'.
7758 The end of the header is the start of the next line, if there is one,
7759 else the end of the last line. This function obeys RFC822."
7765 ;; Used by Rmail (e.g., rmail-forward).
7767 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7771 switch-function yank-action send-actions
7772 return-action)
7773 "Start composing a mail message to send.
7774 This uses the user's chosen mail composition package
7775 as selected with the variable `mail-user-agent'.
7776 The optional arguments TO and SUBJECT specify recipients
7777 and the initial Subject field, respectively.
7779 OTHER-HEADERS is an alist specifying additional
7780 header fields. Elements look like (HEADER . VALUE) where both
7781 HEADER and VALUE are strings.
7783 CONTINUE, if non-nil, says to continue editing a message already
7784 being composed. Interactively, CONTINUE is the prefix argument.
7786 SWITCH-FUNCTION, if non-nil, is a function to use to
7787 switch to and display the buffer used for mail composition.
7789 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7790 to insert the raw text of the message being replied to.
7791 It has the form (FUNCTION . ARGS). The user agent will apply
7792 FUNCTION to ARGS, to insert the raw text of the original message.
7793 \(The user agent will also run `mail-citation-hook', *after* the
7794 original text has been inserted in this way.)
7796 SEND-ACTIONS is a list of actions to call when the message is sent.
7797 Each action has the form (FUNCTION . ARGS).
7799 RETURN-ACTION, if non-nil, is an action for returning to the
7800 caller. It has the form (FUNCTION . ARGS). The function is
7801 called after the mail has been sent or put aside, and the mail
7802 buffer buried."
7806 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7807 ;; from sendmail-user-agent to message-user-agent. Some users may
7808 ;; encounter incompatibilities. This hack tries to detect problems
7809 ;; and warn about them.
7814 mail-yank-hooks mail-archive-file-name
7815 mail-default-reply-to mail-mailing-lists
7816 mail-self-blind))
7823 The default mail mode is now Message mode.
7824 You have the following Mail mode variable%s customized:
7826 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7833 yank-action send-actions return-action)))
7836 yank-action send-actions
7837 return-action)
7841 'switch-to-buffer-other-window yank-action send-actions
7842 return-action))
7845 yank-action send-actions
7846 return-action)
7850 'switch-to-buffer-other-frame yank-action send-actions
7851 return-action))
7853 \f
7855 "History of values entered with `set-variable'.
7857 Maximum length of the history list is determined by the value
7861 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7862 VARIABLE should be a user option variable name, a Lisp variable
7863 meant to be customized by users. You should enter VALUE in Lisp syntax,
7864 so if you want VALUE to be a string, you must surround it with doublequotes.
7865 VALUE is used literally, not evaluated.
7867 If VARIABLE has a `variable-interactive' property, that is used as if
7868 it were the arg to `interactive' (which see) to interactively read VALUE.
7870 If VARIABLE has been defined with `defcustom', then the type information
7871 in the definition is used to check that VALUE is valid.
7873 Note that this function is at heart equivalent to the basic `set' function.
7874 For a variable defined with `defcustom', it does not pay attention to
7875 any :set property that the variable might have (if you want that, use
7878 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7883 default-var)
7899 var obsolete)
7902 ;; Use VAR's `variable-interactive' property
7903 ;; as an interactive spec for prompting.
7906 arg))
7908 read-expression-map t
7909 'set-variable-value-history
7918 ;; Match with custom type.
7930 ;; Force a thorough redisplay for the case that the variable
7931 ;; has an effect on the display, like `tab-width' has.
7933 \f
7934 ;; Define the major mode for lists of completions.
7944 (define-key map [right] 'next-completion)
7946 (define-key map [backtab] 'previous-completion)
7947 (define-key map "q" 'quit-window)
7948 (define-key map "z" 'kill-current-buffer)
7949 map)
7950 "Local map for completion list buffers.")
7952 ;; Completion mode is suitable only for specially formatted data.
7953 (put 'completion-list-mode 'mode-class 'special)
7955 (defvar completion-reference-buffer nil
7956 "Record the buffer that was current when the completion list was requested.
7957 This is a local variable in the completion list buffer.
7958 Initial value is nil to avoid some compiler warnings.")
7960 (defvar completion-no-auto-exit nil
7961 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7962 This also applies to other functions such as `choose-completion'.")
7964 (defvar completion-base-position nil
7965 "Position of the base of the text corresponding to the shown completions.
7966 This variable is used in the *Completions* buffers.
7967 Its value is a list of the form (START END) where START is the place
7968 where the completion should be inserted and END (if non-nil) is the end
7969 of the text to replace. If END is nil, point is used instead.")
7971 (defvar completion-list-insert-choice-function #'completion--replace
7972 "Function to use to insert the text chosen in *Completions*.
7973 Called with three arguments (BEG END TEXT), it should replace the text
7974 between BEG and END with TEXT. Expected to be set buffer-locally
7975 in the *Completions* buffer.")
7977 (defvar completion-base-size nil
7978 "Number of chars before point not involved in completion.
7979 This is a local variable in the completion list buffer.
7980 It refers to the chars in the minibuffer if completing in the
7981 minibuffer, or in `completion-reference-buffer' otherwise.
7982 Only characters in the field at point are included.
7984 If nil, Emacs determines which part of the tail end of the
7985 buffer's text is involved in completion by comparing the text
7986 directly.")
7987 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7989 (defun delete-completion-window ()
7990 "Delete the completion list window.
7991 Go to the window from which completion was requested."
7992 (interactive)
7993 (let ((buf completion-reference-buffer))
7994 (if (one-window-p t)
7995 (if (window-dedicated-p) (delete-frame))
7996 (delete-window (selected-window))
7997 (if (get-buffer-window buf)
7998 (select-window (get-buffer-window buf))))))
8000 (defun previous-completion (n)
8001 "Move to the previous item in the completion list."
8002 (interactive "p")
8003 (next-completion (- n)))
8005 (defun next-completion (n)
8006 "Move to the next item in the completion list.
8007 With prefix argument N, move N items (negative N means move backward)."
8008 (interactive "p")
8009 (let ((beg (point-min)) (end (point-max)))
8010 (while (and (> n 0) (not (eobp)))
8011 ;; If in a completion, move to the end of it.
8012 (when (get-text-property (point) 'mouse-face)
8013 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8014 ;; Move to start of next one.
8015 (unless (get-text-property (point) 'mouse-face)
8016 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8017 (setq n (1- n)))
8018 (while (and (< n 0) (not (bobp)))
8019 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
8020 ;; If in a completion, move to the start of it.
8021 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
8022 (goto-char (previous-single-property-change
8023 (point) 'mouse-face nil beg)))
8024 ;; Move to end of the previous completion.
8025 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
8026 (goto-char (previous-single-property-change
8027 (point) 'mouse-face nil beg)))
8028 ;; Move to the start of that one.
8029 (goto-char (previous-single-property-change
8030 (point) 'mouse-face nil beg))
8031 (setq n (1+ n))))))
8033 (defun choose-completion (&optional event)
8034 "Choose the completion at point.
8035 If EVENT, use EVENT's position to determine the starting position."
8036 (interactive (list last-nonmenu-event))
8037 ;; In case this is run via the mouse, give temporary modes such as
8038 ;; isearch a chance to turn off.
8039 (run-hooks 'mouse-leave-buffer-hook)
8040 (with-current-buffer (window-buffer (posn-window (event-start event)))
8041 (let ((buffer completion-reference-buffer)
8042 (base-size completion-base-size)
8043 (base-position completion-base-position)
8044 (insert-function completion-list-insert-choice-function)
8045 (choice
8046 (save-excursion
8047 (goto-char (posn-point (event-start event)))
8048 (let (beg end)
8049 (cond
8050 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
8051 (setq end (point) beg (1+ (point))))
8052 ((and (not (bobp))
8053 (get-text-property (1- (point)) 'mouse-face))
8054 (setq end (1- (point)) beg (point)))
8055 (t (error "No completion here")))
8056 (setq beg (previous-single-property-change beg 'mouse-face))
8057 (setq end (or (next-single-property-change end 'mouse-face)
8058 (point-max)))
8059 (buffer-substring-no-properties beg end)))))
8061 (unless (buffer-live-p buffer)
8062 (error "Destination buffer is dead"))
8063 (quit-window nil (posn-window (event-start event)))
8065 (with-current-buffer buffer
8066 (choose-completion-string
8067 choice buffer
8068 (or base-position
8069 (when base-size
8070 ;; Someone's using old completion code that doesn't know
8071 ;; about base-position yet.
8072 (list (+ base-size (field-beginning))))
8073 ;; If all else fails, just guess.
8074 (list (choose-completion-guess-base-position choice)))
8075 insert-function)))))
8077 ;; Delete the longest partial match for STRING
8078 ;; that can be found before POINT.
8079 (defun choose-completion-guess-base-position (string)
8080 (save-excursion
8081 (let ((opoint (point))
8082 len)
8083 ;; Try moving back by the length of the string.
8084 (goto-char (max (- (point) (length string))
8085 (minibuffer-prompt-end)))
8086 ;; See how far back we were actually able to move. That is the
8087 ;; upper bound on how much we can match and delete.
8088 (setq len (- opoint (point)))
8089 (if completion-ignore-case
8090 (setq string (downcase string)))
8091 (while (and (> len 0)
8092 (let ((tail (buffer-substring (point) opoint)))
8093 (if completion-ignore-case
8094 (setq tail (downcase tail)))
8095 (not (string= tail (substring string 0 len)))))
8096 (setq len (1- len))
8097 (forward-char 1))
8098 (point))))
8100 (defun choose-completion-delete-max-match (string)
8101 (declare (obsolete choose-completion-guess-base-position "23.2"))
8102 (delete-region (choose-completion-guess-base-position string) (point)))
8104 (defvar choose-completion-string-functions nil
8105 "Functions that may override the normal insertion of a completion choice.
8106 These functions are called in order with three arguments:
8107 CHOICE - the string to insert in the buffer,
8108 BUFFER - the buffer in which the choice should be inserted,
8109 BASE-POSITION - where to insert the completion.
8111 If a function in the list returns non-nil, that function is supposed
8112 to have inserted the CHOICE in the BUFFER, and possibly exited
8113 the minibuffer; no further functions will be called.
8115 If all functions in the list return nil, that means to use
8116 the default method of inserting the completion in BUFFER.")
8118 (defun choose-completion-string (choice &optional
8119 buffer base-position insert-function)
8120 "Switch to BUFFER and insert the completion choice CHOICE.
8121 BASE-POSITION says where to insert the completion.
8122 INSERT-FUNCTION says how to insert the completion and falls
8123 back on `completion-list-insert-choice-function' when nil."
8125 ;; If BUFFER is the minibuffer, exit the minibuffer
8126 ;; unless it is reading a file name and CHOICE is a directory,
8127 ;; or completion-no-auto-exit is non-nil.
8129 ;; Some older code may call us passing `base-size' instead of
8130 ;; `base-position'. It's difficult to make any use of `base-size',
8131 ;; so we just ignore it.
8132 (unless (consp base-position)
8133 (message "Obsolete `base-size' passed to choose-completion-string")
8134 (setq base-position nil))
8136 (let* ((buffer (or buffer completion-reference-buffer))
8137 (mini-p (minibufferp buffer)))
8138 ;; If BUFFER is a minibuffer, barf unless it's the currently
8139 ;; active minibuffer.
8140 (if (and mini-p
8141 (not (and (active-minibuffer-window)
8142 (equal buffer
8143 (window-buffer (active-minibuffer-window))))))
8144 (error "Minibuffer is not active for completion")
8145 ;; Set buffer so buffer-local choose-completion-string-functions works.
8146 (set-buffer buffer)
8147 (unless (run-hook-with-args-until-success
8148 'choose-completion-string-functions
8149 ;; The fourth arg used to be `mini-p' but was useless
8150 ;; (since minibufferp can be used on the `buffer' arg)
8151 ;; and indeed unused. The last used to be `base-size', so we
8152 ;; keep it to try and avoid breaking old code.
8153 choice buffer base-position nil)
8154 ;; This remove-text-properties should be unnecessary since `choice'
8155 ;; comes from buffer-substring-no-properties.
8156 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8157 ;; Insert the completion into the buffer where it was requested.
8158 (funcall (or insert-function completion-list-insert-choice-function)
8159 (or (car base-position) (point))
8160 (or (cadr base-position) (point))
8161 choice)
8162 ;; Update point in the window that BUFFER is showing in.
8163 (let ((window (get-buffer-window buffer t)))
8164 (set-window-point window (point)))
8165 ;; If completing for the minibuffer, exit it with this choice.
8166 (and (not completion-no-auto-exit)
8167 (minibufferp buffer)
8168 minibuffer-completion-table
8169 ;; If this is reading a file name, and the file name chosen
8170 ;; is a directory, don't exit the minibuffer.
8171 (let* ((result (buffer-substring (field-beginning) (point)))
8172 (bounds
8173 (completion-boundaries result minibuffer-completion-table
8174 minibuffer-completion-predicate
8175 "")))
8176 (if (eq (car bounds) (length result))
8177 ;; The completion chosen leads to a new set of completions
8178 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8179 (let ((mini (active-minibuffer-window)))
8180 (select-window mini)
8181 (when minibuffer-auto-raise
8182 (raise-frame (window-frame mini))))
8183 (exit-minibuffer))))))))
8185 (define-derived-mode completion-list-mode nil "Completion List"
8186 "Major mode for buffers showing lists of possible completions.
8188 to select the completion near point.
8189 Or click to select one with the mouse.
8192 (set (make-local-variable 'completion-base-size) nil))
8194 (defun completion-list-mode-finish ()
8195 "Finish setup of the completions buffer.
8196 Called from `temp-buffer-show-hook'."
8197 (when (eq major-mode 'completion-list-mode)
8198 (setq buffer-read-only t)))
8200 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8203 ;; Variables and faces used in `completion-setup-function'.
8205 (defcustom completion-show-help t
8206 "Non-nil means show help message in *Completions* buffer."
8207 :type 'boolean
8208 :version "22.1"
8209 :group 'completion)
8211 ;; This function goes in completion-setup-hook, so that it is called
8212 ;; after the text of the completion list buffer is written.
8213 (defun completion-setup-function ()
8214 (let* ((mainbuf (current-buffer))
8215 (base-dir
8216 ;; FIXME: This is a bad hack. We try to set the default-directory
8217 ;; in the *Completions* buffer so that the relative file names
8218 ;; displayed there can be treated as valid file names, independently
8219 ;; from the completion context. But this suffers from many problems:
8220 ;; - It's not clear when the completions are file names. With some
8221 ;; completion tables (e.g. bzr revision specs), the listed
8222 ;; completions can mix file names and other things.
8223 ;; - It doesn't pay attention to possible quoting.
8224 ;; - With fancy completion styles, the code below will not always
8225 ;; find the right base directory.
8226 (if minibuffer-completing-file-name
8227 (file-name-as-directory
8228 (expand-file-name
8229 (buffer-substring (minibuffer-prompt-end)
8230 (- (point) (or completion-base-size 0))))))))
8231 (with-current-buffer standard-output
8232 (let ((base-size completion-base-size) ;Read before killing localvars.
8233 (base-position completion-base-position)
8234 (insert-fun completion-list-insert-choice-function))
8235 (completion-list-mode)
8236 (set (make-local-variable 'completion-base-size) base-size)
8237 (set (make-local-variable 'completion-base-position) base-position)
8238 (set (make-local-variable 'completion-list-insert-choice-function)
8239 insert-fun))
8240 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8241 (if base-dir (setq default-directory base-dir))
8242 ;; Maybe insert help string.
8243 (when completion-show-help
8244 (goto-char (point-min))
8245 (if (display-mouse-p)
8247 (insert (substitute-command-keys
8251 (add-hook 'completion-setup-hook 'completion-setup-function)
8253 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8254 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8256 (defun switch-to-completions ()
8257 "Select the completion list window."
8258 (interactive)
8259 (let ((window (or (get-buffer-window "*Completions*" 0)
8260 ;; Make sure we have a completions window.
8261 (progn (minibuffer-completion-help)
8262 (get-buffer-window "*Completions*" 0)))))
8263 (when window
8264 (select-window window)
8265 ;; In the new buffer, go to the first completion.
8266 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8267 (when (bobp)
8268 (next-completion 1)))))
8269 \f
8270 ;;; Support keyboard commands to turn on various modifiers.
8272 ;; These functions -- which are not commands -- each add one modifier
8273 ;; to the following event.
8275 (defun event-apply-alt-modifier (_ignore-prompt)
8278 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8279 (defun event-apply-super-modifier (_ignore-prompt)
8282 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8283 (defun event-apply-hyper-modifier (_ignore-prompt)
8286 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8287 (defun event-apply-shift-modifier (_ignore-prompt)
8290 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8291 (defun event-apply-control-modifier (_ignore-prompt)
8294 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8295 (defun event-apply-meta-modifier (_ignore-prompt)
8298 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8300 (defun event-apply-modifier (event symbol lshiftby prefix)
8301 "Apply a modifier flag to event EVENT.
8302 SYMBOL is the name of this modifier, as a symbol.
8303 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8304 PREFIX is the string that represents this modifier in an event type symbol."
8305 (if (numberp event)
8306 (cond ((eq symbol 'control)
8307 (if (and (<= (downcase event) ?z)
8308 (>= (downcase event) ?a))
8309 (- (downcase event) ?a -1)
8310 (if (and (<= (downcase event) ?Z)
8311 (>= (downcase event) ?A))
8312 (- (downcase event) ?A -1)
8313 (logior (lsh 1 lshiftby) event))))
8314 ((eq symbol 'shift)
8315 (if (and (<= (downcase event) ?z)
8316 (>= (downcase event) ?a))
8317 (upcase event)
8318 (logior (lsh 1 lshiftby) event)))
8319 (t
8320 (logior (lsh 1 lshiftby) event)))
8321 (if (memq symbol (event-modifiers event))
8322 event
8323 (let ((event-type (if (symbolp event) event (car event))))
8324 (setq event-type (intern (concat prefix (symbol-name event-type))))
8325 (if (symbolp event)
8326 event-type
8327 (cons event-type (cdr event)))))))
8329 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8330 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8331 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8332 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8333 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8334 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8335 \f
8336 ;;;; Keypad support.
8338 ;; Make the keypad keys act like ordinary typing keys. If people add
8339 ;; bindings for the function key symbols, then those bindings will
8340 ;; override these, so this shouldn't interfere with any existing
8341 ;; bindings.
8343 ;; Also tell read-char how to handle these keys.
8344 (mapc
8345 (lambda (keypad-normal)
8346 (let ((keypad (nth 0 keypad-normal))
8347 (normal (nth 1 keypad-normal)))
8348 (put keypad 'ascii-character normal)
8349 (define-key function-key-map (vector keypad) (vector normal))))
8350 ;; See also kp-keys bound in bindings.el.
8351 '((kp-space ?\s)
8354 (kp-separator ?,)
8355 (kp-equal ?=)
8356 ;; Do the same for various keys that are represented as symbols under
8357 ;; GUIs but naturally correspond to characters.
8358 (backspace 127)
8359 (delete 127)
8362 (clear ?\C-l)
8363 (return ?\C-m)
8364 (escape ?\e)
8365 ))
8366 \f
8367 ;;;;
8368 ;;;; forking a twin copy of a buffer.
8369 ;;;;
8371 (defvar clone-buffer-hook nil
8372 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8374 (defvar clone-indirect-buffer-hook nil
8375 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8377 (defun clone-process (process &optional newname)
8378 "Create a twin copy of PROCESS.
8379 If NEWNAME is nil, it defaults to PROCESS' name;
8380 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8381 If PROCESS is associated with a buffer, the new process will be associated
8382 with the current buffer instead.
8383 Returns nil if PROCESS has already terminated."
8384 (setq newname (or newname (process-name process)))
8386 (setq newname (substring newname 0 (match-beginning 0))))
8387 (when (memq (process-status process) '(run stop open))
8388 (let* ((process-connection-type (process-tty-name process))
8389 (new-process
8390 (if (memq (process-status process) '(open))
8391 (let ((args (process-contact process t)))
8392 (setq args (plist-put args :name newname))
8393 (setq args (plist-put args :buffer
8394 (if (process-buffer process)
8395 (current-buffer))))
8396 (apply 'make-network-process args))
8397 (apply 'start-process newname
8398 (if (process-buffer process) (current-buffer))
8399 (process-command process)))))
8400 (set-process-query-on-exit-flag
8401 new-process (process-query-on-exit-flag process))
8402 (set-process-inherit-coding-system-flag
8403 new-process (process-inherit-coding-system-flag process))
8404 (set-process-filter new-process (process-filter process))
8405 (set-process-sentinel new-process (process-sentinel process))
8406 (set-process-plist new-process (copy-sequence (process-plist process)))
8407 new-process)))
8409 ;; things to maybe add (currently partly covered by `funcall mode'):
8410 ;; - syntax-table
8411 ;; - overlays
8412 (defun clone-buffer (&optional newname display-flag)
8413 "Create and return a twin copy of the current buffer.
8414 Unlike an indirect buffer, the new buffer can be edited
8415 independently of the old one (if it is not read-only).
8416 NEWNAME is the name of the new buffer. It may be modified by
8417 adding or incrementing <N> at the end as necessary to create a
8418 unique buffer name. If nil, it defaults to the name of the
8419 current buffer, with the proper suffix. If DISPLAY-FLAG is
8420 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8421 clone a file-visiting buffer, or a buffer whose major mode symbol
8422 has a non-nil `no-clone' property, results in an error.
8424 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8425 current buffer with appropriate suffix. However, if a prefix
8426 argument is given, then the command prompts for NEWNAME in the
8427 minibuffer.
8429 This runs the normal hook `clone-buffer-hook' in the new buffer
8430 after it has been set up properly in other respects."
8431 (interactive
8432 (progn
8433 (if buffer-file-name
8434 (error "Cannot clone a file-visiting buffer"))
8435 (if (get major-mode 'no-clone)
8436 (error "Cannot clone a buffer in %s mode" mode-name))
8437 (list (if current-prefix-arg
8438 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8439 t)))
8440 (if buffer-file-name
8441 (error "Cannot clone a file-visiting buffer"))
8442 (if (get major-mode 'no-clone)
8443 (error "Cannot clone a buffer in %s mode" mode-name))
8444 (setq newname (or newname (buffer-name)))
8446 (setq newname (substring newname 0 (match-beginning 0))))
8447 (let ((buf (current-buffer))
8448 (ptmin (point-min))
8449 (ptmax (point-max))
8450 (pt (point))
8451 (mk (if mark-active (mark t)))
8452 (modified (buffer-modified-p))
8453 (mode major-mode)
8454 (lvars (buffer-local-variables))
8455 (process (get-buffer-process (current-buffer)))
8456 (new (generate-new-buffer (or newname (buffer-name)))))
8457 (save-restriction
8458 (widen)
8459 (with-current-buffer new
8460 (insert-buffer-substring buf)))
8461 (with-current-buffer new
8462 (narrow-to-region ptmin ptmax)
8463 (goto-char pt)
8464 (if mk (set-mark mk))
8465 (set-buffer-modified-p modified)
8467 ;; Clone the old buffer's process, if any.
8468 (when process (clone-process process))
8470 ;; Now set up the major mode.
8471 (funcall mode)
8473 ;; Set up other local variables.
8474 (mapc (lambda (v)
8475 (condition-case () ;in case var is read-only
8476 (if (symbolp v)
8477 (makunbound v)
8478 (set (make-local-variable (car v)) (cdr v)))
8479 (error nil)))
8480 lvars)
8482 ;; Run any hooks (typically set up by the major mode
8483 ;; for cloning to work properly).
8484 (run-hooks 'clone-buffer-hook))
8485 (if display-flag
8486 ;; Presumably the current buffer is shown in the selected frame, so
8487 ;; we want to display the clone elsewhere.
8488 (let ((same-window-regexps nil)
8489 (same-window-buffer-names))
8490 (pop-to-buffer new)))
8491 new))
8494 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8495 "Create an indirect buffer that is a twin copy of the current buffer.
8497 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8498 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8499 or if not called with a prefix arg, NEWNAME defaults to the current
8500 buffer's name. The name is modified by adding a `<N>' suffix to it
8501 or by incrementing the N in an existing suffix. Trying to clone a
8502 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8503 property results in an error.
8505 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8506 This is always done when called interactively.
8508 Optional third arg NORECORD non-nil means do not put this buffer at the
8509 front of the list of recently selected ones.
8511 Returns the newly created indirect buffer."
8512 (interactive
8513 (progn
8514 (if (get major-mode 'no-clone-indirect)
8515 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8516 (list (if current-prefix-arg
8517 (read-buffer "Name of indirect buffer: " (current-buffer)))
8518 t)))
8519 (if (get major-mode 'no-clone-indirect)
8520 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8521 (setq newname (or newname (buffer-name)))
8523 (setq newname (substring newname 0 (match-beginning 0))))
8524 (let* ((name (generate-new-buffer-name newname))
8525 (buffer (make-indirect-buffer (current-buffer) name t)))
8526 (with-current-buffer buffer
8527 (run-hooks 'clone-indirect-buffer-hook))
8528 (when display-flag
8529 (pop-to-buffer buffer nil norecord))
8530 buffer))
8533 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8534 "Like `clone-indirect-buffer' but display in another window."
8535 (interactive
8536 (progn
8537 (if (get major-mode 'no-clone-indirect)
8538 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8539 (list (if current-prefix-arg
8540 (read-buffer "Name of indirect buffer: " (current-buffer)))
8541 t)))
8542 (let ((pop-up-windows t))
8543 (clone-indirect-buffer newname display-flag norecord)))
8545 \f
8546 ;;; Handling of Backspace and Delete keys.
8548 (defcustom normal-erase-is-backspace 'maybe
8549 "Set the default behavior of the Delete and Backspace keys.
8551 If set to t, Delete key deletes forward and Backspace key deletes
8552 backward.
8554 If set to nil, both Delete and Backspace keys delete backward.
8556 If set to `maybe' (which is the default), Emacs automatically
8557 selects a behavior. On window systems, the behavior depends on
8558 the keyboard used. If the keyboard has both a Backspace key and
8559 a Delete key, and both are mapped to their usual meanings, the
8560 option's default value is set to t, so that Backspace can be used
8561 to delete backward, and Delete can be used to delete forward.
8563 If not running under a window system, customizing this option
8564 accomplishes a similar effect by mapping C-h, which is usually
8565 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8566 via `keyboard-translate'. The former functionality of C-h is
8567 available on the F1 key. You should probably not use this
8568 setting if you don't have both Backspace, Delete and F1 keys.
8570 Setting this variable with setq doesn't take effect. Programmatically,
8571 call `normal-erase-is-backspace-mode' (which see) instead."
8572 :type '(choice (const :tag "Off" nil)
8573 (const :tag "Maybe" maybe)
8574 (other :tag "On" t))
8575 :group 'editing-basics
8576 :version "21.1"
8577 :set (lambda (symbol value)
8578 ;; The fboundp is because of a problem with :set when
8579 ;; dumping Emacs. It doesn't really matter.
8580 (if (fboundp 'normal-erase-is-backspace-mode)
8581 (normal-erase-is-backspace-mode (or value 0))
8582 (set-default symbol value))))
8584 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8585 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8586 (unless frame (setq frame (selected-frame)))
8587 (with-selected-frame frame
8588 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8589 (normal-erase-is-backspace-mode
8590 (if (if (eq normal-erase-is-backspace 'maybe)
8591 (and (not noninteractive)
8592 (or (memq system-type '(ms-dos windows-nt))
8593 (memq window-system '(w32 ns))
8594 (and (memq window-system '(x))
8595 (fboundp 'x-backspace-delete-keys-p)
8596 (x-backspace-delete-keys-p))
8597 ;; If the terminal Emacs is running on has erase char
8598 ;; set to ^H, use the Backspace key for deleting
8599 ;; backward, and the Delete key for deleting forward.
8600 (and (null window-system)
8601 (eq tty-erase-char ?\^H))))
8602 normal-erase-is-backspace)
8603 1 0)))))
8605 (define-minor-mode normal-erase-is-backspace-mode
8606 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8607 With a prefix argument ARG, enable this feature if ARG is
8608 positive, and disable it otherwise. If called from Lisp, enable
8609 the mode if ARG is omitted or nil.
8611 On window systems, when this mode is on, Delete is mapped to C-d
8612 and Backspace is mapped to DEL; when this mode is off, both
8613 Delete and Backspace are mapped to DEL. (The remapping goes via
8614 `local-function-key-map', so binding Delete or Backspace in the
8615 global or local keymap will override that.)
8617 In addition, on window systems, the bindings of C-Delete, M-Delete,
8618 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8619 the global keymap in accordance with the functionality of Delete and
8620 Backspace. For example, if Delete is remapped to C-d, which deletes
8621 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8622 to DEL, which deletes backward, C-Delete is bound to
8623 `backward-kill-word'.
8625 If not running on a window system, a similar effect is accomplished by
8626 remapping C-h (normally produced by the Backspace key) and DEL via
8627 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8628 to C-d; if it's off, the keys are not remapped.
8630 When not running on a window system, and this mode is turned on, the
8631 former functionality of C-h is available on the F1 key. You should
8632 probably not turn on this mode on a text-only terminal if you don't
8633 have both Backspace, Delete and F1 keys.
8635 See also `normal-erase-is-backspace'."
8636 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8637 . (lambda (v)
8638 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8639 (if v 1 0))))
8640 (let ((enabled (eq 1 (terminal-parameter
8641 nil 'normal-erase-is-backspace))))
8643 (cond ((or (memq window-system '(x w32 ns pc))
8644 (memq system-type '(ms-dos windows-nt)))
8645 (let ((bindings
8646 `(([M-delete] [M-backspace])
8647 ([C-M-delete] [C-M-backspace])
8648 ([?\e C-delete] [?\e C-backspace]))))
8650 (if enabled
8651 (progn
8652 (define-key local-function-key-map [delete] [deletechar])
8653 (define-key local-function-key-map [kp-delete] [deletechar])
8654 (define-key local-function-key-map [backspace] [?\C-?])
8655 (dolist (b bindings)
8656 ;; Not sure if input-decode-map is really right, but
8657 ;; keyboard-translate-table (used below) only works
8658 ;; for integer events, and key-translation-table is
8659 ;; global (like the global-map, used earlier).
8660 (define-key input-decode-map (car b) nil)
8661 (define-key input-decode-map (cadr b) nil)))
8662 (define-key local-function-key-map [delete] [?\C-?])
8663 (define-key local-function-key-map [kp-delete] [?\C-?])
8664 (define-key local-function-key-map [backspace] [?\C-?])
8665 (dolist (b bindings)
8666 (define-key input-decode-map (car b) (cadr b))
8667 (define-key input-decode-map (cadr b) (car b))))))
8668 (t
8669 (if enabled
8670 (progn
8671 (keyboard-translate ?\C-h ?\C-?)
8672 (keyboard-translate ?\C-? ?\C-d))
8673 (keyboard-translate ?\C-h ?\C-h)
8674 (keyboard-translate ?\C-? ?\C-?))))
8676 (if (called-interactively-p 'interactive)
8677 (message "Delete key deletes %s"
8678 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8679 "forward" "backward")))))
8680 \f
8681 (defvar vis-mode-saved-buffer-invisibility-spec nil
8682 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8684 (define-minor-mode read-only-mode
8685 "Change whether the current buffer is read-only.
8686 With prefix argument ARG, make the buffer read-only if ARG is
8687 positive, otherwise make it writable. If buffer is read-only
8688 and `view-read-only' is non-nil, enter view mode.
8690 Do not call this from a Lisp program unless you really intend to
8692 possibly enabling or disabling View mode. Also, note that this
8693 command works by setting the variable `buffer-read-only', which
8694 does not affect read-only regions caused by text properties. To
8695 ignore read-only status in a Lisp program (whether due to text
8696 properties or buffer state), bind `inhibit-read-only' temporarily
8697 to a non-nil value."
8698 :variable buffer-read-only
8699 (cond
8700 ((and (not buffer-read-only) view-mode)
8701 (View-exit-and-edit)
8702 (make-local-variable 'view-read-only)
8703 (setq view-read-only t)) ; Must leave view mode.
8704 ((and buffer-read-only view-read-only
8705 ;; If view-mode is already active, `view-mode-enter' is a nop.
8706 (not view-mode)
8707 (not (eq (get major-mode 'mode-class) 'special)))
8708 (view-mode-enter))))
8710 (define-minor-mode visible-mode
8711 "Toggle making all invisible text temporarily visible (Visible mode).
8712 With a prefix argument ARG, enable Visible mode if ARG is
8713 positive, and disable it otherwise. If called from Lisp, enable
8714 the mode if ARG is omitted or nil.
8716 This mode works by saving the value of `buffer-invisibility-spec'
8717 and setting it to nil."
8718 :lighter " Vis"
8719 :group 'editing-basics
8720 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8721 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8722 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8723 (when visible-mode
8724 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8725 buffer-invisibility-spec)
8726 (setq buffer-invisibility-spec nil)))
8727 \f
8728 (defvar messages-buffer-mode-map
8729 (let ((map (make-sparse-keymap)))
8730 (set-keymap-parent map special-mode-map)
8731 (define-key map "g" nil) ; nothing to revert
8732 map))
8734 (define-derived-mode messages-buffer-mode special-mode "Messages"
8737 (defun messages-buffer ()
8739 If it does not exist, create and it switch it to `messages-buffer-mode'."
8740 (or (get-buffer "*Messages*")
8741 (with-current-buffer (get-buffer-create "*Messages*")
8742 (messages-buffer-mode)
8743 (current-buffer))))
8745 \f
8746 ;; Minibuffer prompt stuff.
8748 ;;(defun minibuffer-prompt-modification (start end)
8749 ;; (error "You cannot modify the prompt"))
8750 ;;
8751 ;;
8752 ;;(defun minibuffer-prompt-insertion (start end)
8753 ;; (let ((inhibit-modification-hooks t))
8754 ;; (delete-region start end)
8755 ;; ;; Discard undo information for the text insertion itself
8756 ;; ;; and for the text deletion.above.
8757 ;; (when (consp buffer-undo-list)
8758 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8759 ;; (message "You cannot modify the prompt")))
8760 ;;
8761 ;;
8762 ;;(setq minibuffer-prompt-properties
8763 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8764 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8766 \f
8767 ;;;; Problematic external packages.
8769 ;; rms says this should be done by specifying symbols that define
8770 ;; versions together with bad values. This is therefore not as
8771 ;; flexible as it could be. See the thread:
8772 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8773 (defconst bad-packages-alist
8774 ;; Not sure exactly which semantic versions have problems.
8775 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8777 "The version of `semantic' loaded does not work in Emacs 22.
8778 It can cause constant high CPU load.
8779 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8780 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8781 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8782 ;; provided the `CUA-mode' feature. Since this is no longer true,
8783 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8784 (CUA-mode t nil
8785 "CUA-mode is now part of the standard GNU Emacs distribution,
8786 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8788 You have loaded an older version of CUA-mode which does not work
8789 correctly with this version of Emacs. You should remove the old
8790 version and use the one distributed with Emacs."))
8791 "Alist of packages known to cause problems in this version of Emacs.
8792 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8793 PACKAGE is either a regular expression to match file names, or a
8794 symbol (a feature name), like for `with-eval-after-load'.
8795 SYMBOL is either the name of a string variable, or t. Upon
8796 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8797 warning using STRING as the message.")
8799 (defun bad-package-check (package)
8800 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8801 (condition-case nil
8802 (let* ((list (assoc package bad-packages-alist))
8803 (symbol (nth 1 list)))
8804 (and list
8805 (boundp symbol)
8806 (or (eq symbol t)
8807 (and (stringp (setq symbol (eval symbol)))
8808 (string-match-p (nth 2 list) symbol)))
8809 (display-warning package (nth 3 list) :warning)))
8810 (error nil)))
8812 (dolist (elem bad-packages-alist)
8813 (let ((pkg (car elem)))
8814 (with-eval-after-load pkg
8815 (bad-package-check pkg))))
8817 \f
8818 ;;; Generic dispatcher commands
8820 ;; Macro `define-alternatives' is used to create generic commands.
8821 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8822 ;; that can have different alternative implementations where choosing
8823 ;; among them is exclusively a matter of user preference.
8825 ;; (define-alternatives COMMAND) creates a new interactive command
8826 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8827 ;; Typically, the user will not need to customize this variable; packages
8828 ;; wanting to add alternative implementations should use
8829 ;;
8830 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8832 (defmacro define-alternatives (command &rest customizations)
8833 "Define the new command `COMMAND'.
8835 The argument `COMMAND' should be a symbol.
8837 Running `M-x COMMAND RET' for the first time prompts for which
8838 alternative to use and records the selected command as a custom
8839 variable.
8841 Running `C-u M-x COMMAND RET' prompts again for an alternative
8842 and overwrites the previous choice.
8844 The variable `COMMAND-alternatives' contains an alist with
8845 alternative implementations of COMMAND. `define-alternatives'
8846 does not have any effect until this variable is set.
8848 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8849 `defcustom' keywords and values to add to the declaration of
8850 `COMMAND-alternatives' (typically :group and :version)."
8851 (let* ((command-name (symbol-name command))
8852 (varalt-name (concat command-name "-alternatives"))
8853 (varalt-sym (intern varalt-name))
8854 (varimp-sym (intern (concat command-name "--implementation"))))
8855 `(progn
8857 (defcustom ,varalt-sym nil
8858 ,(format "Alist of alternative implementations for the `%s' command.
8860 Each entry must be a pair (ALTNAME . ALTFUN), where:
8861 ALTNAME - The name shown at user to describe the alternative implementation.
8862 ALTFUN - The function called to implement this alternative."
8863 command-name)
8864 :type '(alist :key-type string :value-type function)
8865 ,@customizations)
8867 (put ',varalt-sym 'definition-name ',command)
8868 (defvar ,varimp-sym nil "Internal use only.")
8870 (defun ,command (&optional arg)
8871 ,(format "Run generic command `%s'.
8872 If used for the first time, or with interactive ARG, ask the user which
8873 implementation to use for `%s'. The variable `%s'
8874 contains the list of implementations currently supported for this command."
8875 command-name command-name varalt-name)
8876 (interactive "P")
8877 (when (or arg (null ,varimp-sym))
8878 (let ((val (completing-read
8879 ,(format-message
8880 "Select implementation for command `%s': "
8881 command-name)
8882 ,varalt-sym nil t)))
8883 (unless (string-equal val "")
8884 (when (null ,varimp-sym)
8885 (message
8886 "Use C-u M-x %s RET`to select another implementation"
8887 ,command-name)
8888 (sit-for 3))
8889 (customize-save-variable ',varimp-sym
8890 (cdr (assoc-string val ,varalt-sym))))))
8891 (if ,varimp-sym
8892 (call-interactively ,varimp-sym)
8893 (message "%s" ,(format-message
8894 "No implementation selected for command `%s'"
8895 command-name)))))))
8897 \f
8898 ;;; Functions for changing capitalization that Do What I Mean
8899 (defun upcase-dwim (arg)
8900 "Upcase words in the region, if active; if not, upcase word at point.
8901 If the region is active, this function calls `upcase-region'.
8902 Otherwise, it calls `upcase-word', with prefix argument passed to it
8903 to upcase ARG words."
8904 (interactive "*p")
8905 (if (use-region-p)
8906 (upcase-region (region-beginning) (region-end))
8907 (upcase-word arg)))
8909 (defun downcase-dwim (arg)
8910 "Downcase words in the region, if active; if not, downcase word at point.
8911 If the region is active, this function calls `downcase-region'.
8912 Otherwise, it calls `downcase-word', with prefix argument passed to it
8913 to downcase ARG words."
8914 (interactive "*p")
8915 (if (use-region-p)
8916 (downcase-region (region-beginning) (region-end))
8917 (downcase-word arg)))
8919 (defun capitalize-dwim (arg)
8920 "Capitalize words in the region, if active; if not, capitalize word at point.
8921 If the region is active, this function calls `capitalize-region'.
8922 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8923 to capitalize ARG words."
8924 (interactive "*p")
8925 (if (use-region-p)
8926 (capitalize-region (region-beginning) (region-end))
8927 (capitalize-word arg)))
8929 \f
8931 (provide 'simple)
8933 ;;; simple.el ends here