| blob | df664fc0503ad2df3e92ad01bfb547f9c5caaa78 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2017 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "If non-nil, output buffer is not erased between shell commands.
42 Also, a non-nil value set the point in the output buffer
43 once the command complete.
44 The value `beg-last-out' set point at the beginning of the output,
45 `end-last-out' set point at the end of the buffer, `save-point'
46 restore the buffer position before the command."
56 "Point position in the output buffer after command complete.
57 It is an alist (BUFFER . POS), where BUFFER is the output
58 buffer, and POS is the point position in BUFFER once the command finish.
62 "Idle time delay before updating various things on the screen.
63 Various Emacs features that update auxiliary information when point moves
64 wait this many seconds after Emacs becomes idle before doing an update."
70 "Killing and yanking commands."
74 "Highlight (un)matching of parens and expressions."
76 \f
77 ;;; next-error support framework
80 "`next-error' support framework."
86 "Face used to highlight next error locus."
91 "Highlighting of locations in selected source buffers.
92 If a number, highlight the locus in `next-error' face for the given time
93 in seconds, or until the next command is executed.
94 If t, highlight the locus until the next command is executed, or until
95 some other locus replaces it.
96 If nil, don't highlight the locus in the source buffer.
97 If `fringe-arrow', indicate the locus by the fringe arrow
98 indefinitely until some other locus replaces it."
107 "Highlighting of locations in `next-error-no-select'.
108 If number, highlight the locus in `next-error' face for given time in seconds.
109 If t, highlight the locus indefinitely until some other locus replaces it.
110 If nil, don't highlight the locus in the source buffer.
111 If `fringe-arrow', indicate the locus by the fringe arrow
112 indefinitely until some other locus replaces it."
121 "Display the line in the visited source file recentered as specified.
122 If non-nil, the value is passed directly to `recenter'."
130 "List of hook functions run by `next-error' after visiting source file."
141 "The most recent `next-error' buffer.
142 A buffer becomes most recent when its compilation, grep, or
147 "Function to use to find the next error in the current buffer.
148 The function is called with 2 parameters:
149 ARG is an integer specifying by how many errors to move.
150 RESET is a boolean which, if non-nil, says to go back to the beginning
151 of the errors before moving.
152 Major modes providing compile-like functionality should set this variable
153 to indicate to `next-error' that this is a candidate buffer and how
158 "Function to use to move to an error locus.
159 It takes two arguments, a buffer position in the error buffer
160 and a buffer position in the error locus buffer.
161 The buffer for the error locus should already be current.
166 &optional avoid-current
167 extra-test-inclusive
168 extra-test-exclusive)
169 "Return non-nil if BUFFER is a `next-error' capable buffer.
170 If AVOID-CURRENT is non-nil, and BUFFER is the current buffer,
171 return nil.
173 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if
174 BUFFER would not normally qualify. If it returns non-nil, BUFFER
175 is considered `next-error' capable, anyway, and the function
176 returns non-nil.
178 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the
179 buffer would normally qualify. If it returns nil, BUFFER is
180 rejected, and the function returns nil."
185 ;; Optionally reject some buffers.
188 t)
189 ;; Optionally accept some other buffers.
194 extra-test-inclusive
195 extra-test-exclusive)
196 "Return a `next-error' capable buffer.
198 If AVOID-CURRENT is non-nil, treat the current buffer
199 as an absolute last resort only.
201 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
202 that normally would not qualify. If it returns t, the buffer
203 in question is treated as usable.
205 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
206 that would normally be considered usable. If it returns nil,
207 that buffer is rejected."
209 ;; 1. If one window on the selected frame displays such buffer, return it.
215 avoid-current
216 extra-test-inclusive extra-test-exclusive)
221 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
224 extra-test-inclusive extra-test-exclusive))
225 next-error-last-buffer)
226 ;; 3. If the current buffer is acceptable, choose it.
228 extra-test-inclusive extra-test-exclusive)
230 ;; 4. Look for any acceptable buffer.
235 extra-test-inclusive extra-test-exclusive)))
238 ;; 5. Use the current buffer as a last resort if it qualifies,
239 ;; even despite AVOID-CURRENT.
242 extra-test-inclusive extra-test-exclusive)
246 ;; 6. Give up.
250 "Visit next `next-error' message and corresponding source code.
252 If all the error messages parsed so far have been processed already,
253 the message buffer is checked for new ones.
255 A prefix ARG specifies how many error messages to move;
256 negative means move back to previous error messages.
258 and start at the first error.
260 The RESET argument specifies that we should restart from the beginning.
263 compilation, grep, or occur buffer. It can also operate on any
265 more generally, on any buffer in Compilation mode or with
266 Compilation Minor mode enabled, or any buffer in which
267 `next-error-function' is bound to an appropriate function.
268 To specify use of a particular buffer for error messages, type
270 in the current frame.
273 runs `next-error-hook' with `run-hooks', and stays with that buffer
274 until you use it in some other buffer which uses Compilation mode
275 or Compilation Minor mode.
277 To control which errors are matched, customize the variable
278 `compilation-error-regexp-alist'."
282 ;; we know here that next-error-function is a valid symbol we can funcall
290 "Visit the source code corresponding to the `next-error' message at point."
292 ;; we know here that next-error-function is a valid symbol we can funcall
303 "Visit previous `next-error' message and corresponding source code.
305 Prefix arg N says how many error messages to move backwards (or
306 forwards, if negative).
313 "Restart at the first error.
314 Visit corresponding source code.
315 With prefix arg N, visit the source code of the Nth error.
321 "Move point to the next error in the `next-error' buffer and highlight match.
322 Prefix arg N says how many error messages to move forwards (or
323 backwards, if negative).
325 select the source buffer."
332 "Move point to the previous error in the `next-error' buffer and highlight match.
333 Prefix arg N says how many error messages to move backwards (or
334 forwards, if negative).
336 select the source buffer."
340 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
344 "Minor mode for compilation, occur and diff modes.
345 With a prefix argument ARG, enable mode if ARG is positive, and
346 disable it otherwise. If called from Lisp, enable mode if ARG is
347 omitted or nil.
348 When turned on, cursor motion in the compilation, grep, occur or diff
349 buffer causes automatic display of the corresponding source code location."
356 ;; Used as a `post-command-hook' by `next-error-follow-mode'
357 ;; for the *Compilation* *grep* and *Occur* buffers.
367 \f
368 ;;;
371 "Major mode not specialized for anything in particular.
372 Other major modes are defined by comparison with this one."
377 ;; Special major modes to view specially formatted data rather than files.
391 map))
395 "Parent major mode from which special major modes should inherit."
398 ;; Making and deleting lines.
401 "Special hook to tell if `self-insert-command' will use the region.
402 It must be called via `run-hook-with-args-until-success' with no arguments.
403 Any `post-self-insert-command' which consumes the region should
404 register a function on this hook so that things like `delete-selection-mode'
411 "Insert a newline, and move to left margin of the new line if it's blank.
412 If option `use-hard-newlines' is non-nil, the newline is marked with the
413 text-property `hard'.
414 With ARG, insert that many newlines.
416 If `electric-indent-mode' is enabled, this indents the final new line
417 that it adds, and reindents the preceding line. To just insert
420 Calls `auto-fill-function' if the current column number is greater
421 than the value of `fill-column' and ARG is nil.
422 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
425 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
426 ;; Set last-command-event to tell self-insert what to insert.
430 ;; Don't auto-fill if we have a numeric argument.
434 ;; Do the rest in post-self-insert-hook, because we want to do it
435 ;; *before* other functions on that hook.
437 ;; We are not going to insert any newlines if arg is
438 ;; non-positive.
441 ;; Mark the newline(s) `hard'.
445 ;; If the newline leaves the previous line blank, and we
446 ;; have a left margin, delete that from the blank line.
454 ;; Indent the line after the newline, except in one case:
455 ;; when we added the newline at the beginning of a line which
456 ;; starts a page.
461 ;; FIXME: For non-interactive uses, many calls actually
462 ;; just want (insert "\n"), so maybe we should do just
463 ;; that, so as to avoid the risk of filling or running
464 ;; abbrevs unexpectedly.
471 ;; We first used let-binding to protect the hook, but that
472 ;; was naive since add-hook affects the symbol-default
473 ;; value of the variable, whereas the let-binding might
474 ;; only protect the buffer-local value.
478 nil)
483 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
489 "Insert a newline and leave point before it.
490 If there is a fill prefix and/or a `left-margin', insert them on
491 the new line if the line would have been blank.
492 With arg N, insert N newlines."
497 ;; Don't expand an abbrev before point.
508 ;; Necessary in case a margin or prefix was inserted.
512 "Split current line, moving portion beyond point vertically down.
513 If the current line starts with `fill-prefix', insert it on the new
514 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
516 When called from Lisp code, ARG may be a prefix string to copy."
521 ;; What prefix should we check for (nil means don't).
525 ;; Does this line start with it?
536 "Join this line to previous and fix up whitespace at join.
537 If there is a fill prefix, delete it from the beginning of this line.
538 With argument, join this line to following line."
545 ;; If the second line started with the fill prefix,
546 ;; delete the prefix.
558 "On blank line, delete all surrounding blank lines, leaving just one.
559 On isolated blank line, delete that one.
560 On nonblank line, delete any immediately following blank lines."
566 ;; Set singleblank if there is just one blank line here.
573 ;; Delete preceding blank lines, and this one too if it's the only one.
582 ;; Delete following blank lines, unless the current line is blank
583 ;; and there are no following blank lines.
592 ;; Handle the special case where point is followed by newline and eob.
593 ;; Delete the line, leaving point at eob.
599 Trailing lines are deleted only if `delete-trailing-whitespace'
600 is called on the entire buffer (rather than an active region)."
606 "Return non-nil if the region contains no read-only text."
611 "Delete trailing whitespace between START and END.
612 If called interactively, START and END are the start/end of the
613 region if the mark is active, or of the buffer's accessible
614 portion if the mark is inactive.
616 This command deletes whitespace characters after the last
617 non-whitespace character in each line between START and END. It
618 does not consider formfeed characters to be whitespace.
620 If this command acts on the entire buffer (i.e. if called
621 interactively with the mark inactive, or called from Lisp with
622 END nil), it also deletes all trailing lines at the end of the
623 buffer if the variable `delete-trailing-lines' is non-nil."
634 ;; Don't delete formfeeds, even if they are considered whitespace.
643 ;; Delete trailing empty lines.
645 ;; Really the end of buffer.
650 ;; Return nil for the benefit of `write-file-functions'.
651 nil)
654 "Insert a newline, then indent according to major mode.
655 Indentation is done using the value of `indent-line-function'.
656 In programming language modes, this is the same as TAB.
657 In some text modes, where TAB inserts a tab, this command indents to the
658 column specified by the function `current-left-margin'."
665 "Reindent current line, insert newline, then indent the new line.
666 Indentation of both lines is done according to the current major mode,
667 which means calling the current value of `indent-line-function'.
668 In programming language modes, this is the same as TAB.
669 In some text modes, where TAB inserts a tab, this indents to the
670 column specified by the function `current-left-margin'."
673 ;; Be careful to insert the newline before indenting the line.
674 ;; Otherwise, the indentation might be wrong.
678 ;; We are at EOL before the call to indent-according-to-mode, and
679 ;; after it we usually are as well, but not always. We tried to
680 ;; address it with `save-excursion' but that uses a normal marker
681 ;; whereas we need `move after insertion', so we do the save/restore
682 ;; by hand.
686 ;; Remove the trailing white-space after indentation because
687 ;; indentation may introduce the whitespace.
693 Legitimate radix values are 8, 10 and 16."
698 "Like `read-char', but do not allow quitting.
699 Also, if the first character read is an octal digit,
700 we read any number of octal digits and return the
701 specified character code. Any nondigit terminates the sequence.
702 If the terminator is RET, it is discarded;
703 any other terminator is used itself as input.
705 The optional argument PROMPT specifies a string to use to prompt the user.
706 The variable `read-quoted-char-radix' controls which radix to use
707 for numeric input."
710 help-event-list)))
714 ;; Don't let C-h or other help chars get the help
715 ;; message--only help function keys. See bug#16617.
719 "Type the special character you want to use,
720 or the octal character code.
721 RET terminates the character code and is discarded;
725 ;; Translate TAB key into control-I ASCII character, and so on.
726 ;; Note: `read-char' does it using the `ascii-character' property.
727 ;; We tried using read-key instead, but that disables the keystroke
728 ;; echo produced by 'C-q', see bug#24635.
732 char)))
738 done t))
740 ;; Turn a meta-character into a character with the 0200 bit set.
742 done t))
757 done t))
759 done t)))
761 code))
764 "Read next input character and insert it.
765 This is useful for inserting control characters.
766 With argument, insert ARG copies of the character.
768 If the first character you type after this command is an octal digit,
769 you should type a sequence of octal digits which specify a character code.
770 Any nondigit terminates the sequence. If the terminator is a RET,
771 it is discarded; any other terminator is used itself as input.
772 The variable `read-quoted-char-radix' specifies the radix for this feature;
773 set it to 10 or 16 to use decimal or hex instead of octal.
775 In overwrite mode, this function inserts the character anyway, and
776 does not handle octal digits specially. This means that if you use
777 overwrite as your normal editing mode, you can use this function to
778 insert characters when necessary.
780 In binary overwrite mode, this function does overwrite, and octal
781 digits are interpreted as a character code. This is intended to be
782 useful for editing binary files."
785 ;; Avoid "obsolete" warnings for translation-table-for-input.
792 ;; This used to assume character codes 0240 - 0377 stand for
793 ;; characters in some single-byte character set, and converted them
794 ;; to Emacs characters. But in 23.1 this feature is deprecated
795 ;; in favor of inserting the corresponding Unicode characters.
796 ;; (if (and enable-multibyte-characters
797 ;; (>= char ?\240)
798 ;; (<= char ?\377))
799 ;; (setq char (unibyte-char-to-multibyte char)))
811 "Move forward ARG lines and position at first nonblank character."
817 "Move backward ARG lines and position at first nonblank character."
823 "Move point to the first non-whitespace character on this line."
827 ;; Move back over chars that have whitespace syntax but have the p flag.
831 "Fixup white space between objects around point.
832 Leave one space or none, according to the context."
839 nil
843 "Delete all spaces and tabs around point.
844 If BACKWARD-ONLY is non-nil, only delete them before point."
849 orig-pos
858 "Delete all spaces and tabs around point, leaving one space (or N spaces).
859 If N is negative, delete newlines as well, leaving -N spaces.
860 See also `cycle-spacing'."
865 "Store context used in consecutive calls to `cycle-spacing' command.
866 The first time `cycle-spacing' runs, it saves in this variable:
867 its N argument, the original point position, and the original spacing
871 "Manipulate whitespace around point in a smart way.
872 In interactive use, this function behaves differently in successive
873 consecutive calls.
875 The first call in a sequence acts like `just-one-space'.
876 It deletes all spaces and tabs around point, leaving one space
877 \(or N spaces). N is the prefix argument. If N is negative,
878 it deletes newlines as well, leaving -N spaces.
879 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
881 The second call in a sequence deletes all spaces.
883 The third call in a sequence restores the original whitespace (and point).
885 If MODE is `single-shot', it only performs the first step in the sequence.
886 If MODE is `fast' and the first step would not result in any change
887 \(i.e., there are exactly (abs N) spaces around point),
888 the function goes straight to the second step.
890 Repeatedly calling the function with different values of N starts a
891 new sequence each time."
899 ;; Command run for the first time, single-shot mode or different argument
911 ;; Special handling for case where there was no space at all.
914 ;; If this run causes no change in buffer content, delete all spaces,
915 ;; otherwise delete all excess spaces.
920 ;; Command run for the second time.
924 ;; Command run for the third time.
929 \f
931 "Move point to the beginning of the buffer.
932 With numeric arg N, put point N/10 of the way from the beginning.
933 If the buffer is narrowed, this command uses the beginning of the
934 accessible part of the buffer.
937 is supplied, or Transient Mark mode is enabled and the mark is active."
947 ;; Avoid overflow for large buffer sizes!
955 "Move point to the end of the buffer.
956 With numeric arg N, put point N/10 of the way from the end.
957 If the buffer is narrowed, this command uses the end of the
958 accessible part of the buffer.
961 is supplied, or Transient Mark mode is enabled and the mark is active."
969 ;; Avoid overflow for large buffer sizes!
974 ;; If we went to a place in the middle of the buffer,
975 ;; adjust it to the beginning of a line.
979 ;; If the end of the buffer is not already on the screen,
980 ;; then scroll specially to put it near, but not at, the bottom.
985 "Whether single-char deletion commands delete an active region.
986 This has an effect only if Transient Mark mode is enabled, and
987 affects `delete-forward-char' and `delete-backward-char', though
988 not `delete-char'.
990 If the value is the symbol `kill', the active region is killed
991 instead of deleted."
1008 "Function to get the region's content.
1009 Called with one argument DELETE.
1010 If DELETE is `delete-only', then only delete the region and the return value
1011 is undefined. If DELETE is nil, just return the content as a string.
1012 If DELETE is `bounds', then don't delete, but just return the
1013 boundaries of the region as a list of (START . END) positions.
1014 If anything else, delete the region and return its content as a string,
1025 first nil))))
1026 "Function to insert the region's content.
1027 Called with one argument LINES.
1031 "Delete the previous N characters (following if N is negative).
1032 If Transient Mark mode is enabled, the mark is active, and N is 1,
1033 delete the text in the region and deactivate the mark instead.
1034 To disable this, set option `delete-active-region' to nil.
1036 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1037 kill ring) instead of delete. Interactively, N is the prefix
1038 arg, and KILLFLAG is set if N is explicitly specified.
1040 When killing, the killed text is filtered by
1041 `filter-buffer-substring' before it is saved in the kill ring, so
1042 the actual saved text might be different from what was killed.
1044 In Overwrite mode, single character backward deletion may replace
1045 tabs with spaces so as to back over columns, unless point is at
1046 the end of the line."
1052 delete-active-region
1054 ;; If a region is active, kill or delete it.
1058 ;; In Overwrite mode, maybe untabify while deleting
1068 ;; Otherwise, do simple deletion.
1072 "Delete the following N characters (previous if N is negative).
1073 If Transient Mark mode is enabled, the mark is active, and N is 1,
1074 delete the text in the region and deactivate the mark instead.
1075 To disable this, set variable `delete-active-region' to nil.
1077 Optional second arg KILLFLAG non-nil means to kill (save in kill
1078 ring) instead of delete. Interactively, N is the prefix arg, and
1079 KILLFLAG is set if N was explicitly specified.
1081 When killing, the killed text is filtered by
1082 `filter-buffer-substring' before it is saved in the kill ring, so
1083 the actual saved text might be different from what was killed."
1089 delete-active-region
1091 ;; If a region is active, kill or delete it.
1096 ;; Otherwise, do simple deletion.
1100 "Put point at beginning and mark at end of buffer.
1101 If narrowing is in effect, only uses the accessible part of the buffer.
1102 You probably should not use this function in Lisp programs;
1103 it is usually a mistake for a Lisp function to use any subroutine
1104 that uses or sets the mark."
1109 ;; This is really `point-min' in most cases, but if we're in the
1110 ;; minibuffer, this is at the end of the prompt.
1112 \f
1114 ;; Counting lines, one way or another.
1117 "Go to LINE, counting from line 1 at beginning of buffer.
1118 If called interactively, a numeric prefix argument specifies
1119 LINE; without a numeric prefix argument, read LINE from the
1120 minibuffer.
1122 If optional argument BUFFER is non-nil, switch to that buffer and
1124 as argument, BUFFER is the most recently selected other buffer.
1126 Prior to moving point, this function sets the mark (without
1127 activating it), unless Transient Mark mode is enabled and the
1128 mark is already active.
1130 This function is usually the wrong thing to use in a Lisp program.
1131 What you probably want instead is something like:
1132 (goto-char (point-min))
1133 (forward-line (1- N))
1134 If at all possible, an even better solution is to use char counts
1135 rather than line counts."
1140 ;; Look for a default, a number in the buffer at point.
1150 ;; Decide if we're switching buffers.
1158 ;; Read the argument, offering that number (if any) as default.
1161 buffer))))
1162 ;; Switch to the desired buffer, one way or another.
1167 ;; Leave mark at previous position
1169 ;; Move to the specified line number in that buffer.
1178 "Count the number of words in the region.
1179 If called interactively, print a message reporting the number of
1180 lines, words, and characters in the region (whether or not the
1181 region is active); with prefix ARG, report for the entire buffer
1182 rather than the region.
1184 If called from Lisp, return the number of words between positions
1185 START and END."
1197 "Count words between START and END.
1198 If called interactively, START and END are normally the start and
1199 end of the buffer; but if the region is active, START and END are
1200 the start and end of the region. Print a message reporting the
1201 number of lines, words, and chars.
1203 If called from Lisp, return the number of words between START and
1204 END, without printing any message."
1214 words))
1230 str
1238 "Print the current buffer line number and narrowed line number of point."
1251 "Return number of lines between START and END.
1252 This is usually the number of newlines between them,
1253 but can be one more if START is not equal to END
1254 and the greater of them is not at the start of a line."
1270 done)))
1274 "Return (narrowed) buffer line number at position POS.
1275 If POS is nil, use current buffer location.
1276 Counting starts at (point-min), so the value refers
1277 to the contents of the accessible portion of the buffer."
1287 "Print info on cursor position (on screen and within buffer).
1288 Also describe the character after point, and give its character code
1289 in octal, decimal and hex.
1291 For a non-ASCII multibyte character, also give its encoding in the
1292 buffer's selected coding system if the coding system encodes the
1293 character safely. If the character is encoded into one byte, that
1294 code is shown in hex. If the character is encoded into more than one
1297 In addition, with prefix argument, show details about that character
1298 in *Help* buffer. See also the command `describe-char'."
1302 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1303 ;; start a directional embedding, which could completely
1304 ;; disrupt the rest of the line (e.g., RLO will display the
1305 ;; rest of the line right-to-left). So we put an invisible
1306 ;; PDF character after these characters, to end the
1307 ;; embedding, which eliminates any effects on the rest of
1308 ;; the line. For RLE and RLO we also append an invisible
1309 ;; LRM, to avoid reordering the following numerical
1310 ;; characters. For LRI/RLI/FSI we append a PDI.
1317 ;; Strong right-to-left characters cause reordering of
1318 ;; the following numerical characters which show the
1319 ;; codepoint, so append LRM to countermand that.
1330 ""
1336 pos total percent beg end col hscroll)
1338 pos total col hscroll))
1340 encoded encoding-msg display-prop under-display)
1347 ;; Check if the character is displayed with some `display'
1348 ;; text property. In that case, set under-display to the
1349 ;; buffer substring covered by that property.
1360 under-display)))
1366 char char char under-display)
1368 char char char under-display display-prop))
1371 char char char
1373 "..."
1377 ;; We show the detailed information about CHAR.
1384 bidi-fixer
1385 encoding-msg pos total percent beg end col hscroll)
1392 bidi-fixer encoding-msg pos total percent col hscroll))))))
1393 \f
1394 ;; Initialize read-expression-map. It is defined at C level.
1398 ;; Might as well bind TAB to completion, since inserting a TAB char is
1399 ;; much too rarely useful.
1402 m))
1405 "Return a Lisp object read using the minibuffer, unevaluated.
1406 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1407 is a string to insert in the minibuffer before reading.
1408 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1409 Such arguments are used as in `read-from-minibuffer'.)"
1410 ;; Used for interactive spec `x'.
1415 "Return value of Lisp expression read using the minibuffer.
1416 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1417 is a string to insert in the minibuffer before reading.
1418 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1419 Such arguments are used as in `read-from-minibuffer'.)"
1420 ;; Used for interactive spec `X'.
1428 "The current default value or list of default values in the minibuffer.
1429 The functions `read-from-minibuffer' and `completing-read' bind
1433 "Value for `print-level' while printing value in `eval-expression'.
1434 A value of nil means no limit."
1440 "Value for `print-length' while printing value in `eval-expression'.
1441 A value of nil means no limit."
1447 "If non-nil set `debug-on-error' to t in `eval-expression'.
1448 If nil, don't change the value of `debug-on-error'."
1454 "The largest integer that will be displayed as a character.
1455 This affects printing by `eval-expression' (via
1456 `eval-expression-print-format')."
1462 "If VALUE in an integer, return a specially formatted string.
1464 If VALUE is not an integer, nil is returned.
1465 This function is used by commands like `eval-expression' that
1466 display the result of expression evaluation."
1484 ;; FIXME: call emacs-lisp-mode?
1492 read-expression-map t
1496 "Get arguments for commands that print an expression result.
1497 Returns a list (INSERT-VALUE NO-TRUNCATE CHAR-PRINT-LIMIT)
1498 based on PREFIX-ARG. This function determines the interpretation
1499 of the prefix argument for `eval-expression' and
1500 `eval-last-sexp'."
1508 ;; We define this, rather than making `eval' interactive,
1509 ;; for the sake of completion of names like eval-region, eval-buffer.
1511 "Evaluate EXP and print value in the echo area.
1512 When called interactively, read an Emacs Lisp expression and
1513 evaluate it. Value is also consed on to front of the variable
1514 `values'. Optional argument INSERT-VALUE non-nil (interactively,
1515 with a non `-' prefix argument) means insert the result into the
1516 current buffer instead of printing it in the echo area.
1518 Normally, this function truncates long output according to the
1519 value of the variables `eval-expression-print-length' and
1520 `eval-expression-print-level'. When NO-TRUNCATE is
1521 non-nil (interactively, with a prefix argument of zero), however,
1522 there is no such truncation.
1524 If the resulting value is an integer, and CHAR-PRINT-LIMIT is
1525 non-nil (interactively, unless given a positive prefix argument)
1526 it will be printed in several additional formats (octal,
1527 hexadecimal, and character). The character format is only used
1528 if the value is below CHAR-PRINT-LIMIT (interactively, if the
1529 prefix argument is -1 or the value is below
1530 `eval-expression-print-maximum-character').
1532 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1533 minibuffer.
1535 If `eval-expression-debug-on-error' is non-nil, which is the default,
1536 this command arranges for all errors to enter the debugger."
1544 ;; Bind debug-on-error to something unique so that we can
1545 ;; detect when evalled code changes it.
1549 ;; If evalled code has changed the value of debug-on-error,
1550 ;; propagate that change to the global binding.
1566 "Prompting with PROMPT, let user edit COMMAND and eval result.
1567 COMMAND is a Lisp expression. Let user edit that expression in
1568 the minibuffer, then read and evaluate the result."
1575 read-expression-map t
1577 ;; If command was added to command-history as a string,
1578 ;; get rid of that. We want only evaluable expressions there.
1582 ;; If command to be redone does not match front of history,
1583 ;; add it to the history.
1589 "Edit and re-evaluate last complex command, or ARGth from last.
1590 A complex command is one which used the minibuffer.
1591 The command is placed in the minibuffer as a Lisp form for editing.
1592 The result is executed, repeating the command as changed.
1593 If the command has been changed or is not the most recent previous
1594 command it is added to the front of the command history.
1595 You can use the minibuffer history commands \
1597 to get different commands to edit and resubmit."
1600 newcmd)
1612 ;; If command was added to command-history as a
1613 ;; string, get rid of that. We want only
1614 ;; evaluable expressions there.
1618 ;; If command to be redone does not match front of history,
1619 ;; add it to the history.
1634 "Read command name to invoke in `execute-extended-command'."
1644 ;; Get a command name at point in the original buffer
1645 ;; to propose it after M-n.
1649 ;; Read a string, completing from and restricting to the set of
1650 ;; all defined commands. Don't provide any initial input.
1651 ;; Save the command read on the extended-command history list.
1662 ;; This isn't strictly correct if `execute-extended-command'
1663 ;; is bound to anything else (e.g. [menu]).
1664 ;; It could use (key-description (this-single-command-keys)),
1665 ;; but actually a prompt other than "M-x" would be confusing,
1666 ;; because "M-x" is a well-known prompt to read a command
1667 ;; and it serves as a shorthand for "Extended command: ".
1672 ;; Exclude obsolete commands from completions.
1677 pred)))
1682 "Non-nil means show the equivalent key-binding when M-x command has one.
1683 The value can be a length of time to show the message for.
1684 If the value is non-nil and not a number, we wait 2 seconds."
1691 "If non-nil, show a shorter M-x invocation when there is one."
1712 binding)
1718 name len)))
1719 ;; Don't show the help message if the binding isn't
1720 ;; significantly shorter than the M-x command the user typed.
1728 binding))
1731 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1732 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1733 "Read a command name, then read the arguments and call the command.
1734 To pass a prefix argument to the command you are
1735 invoking, give a prefix argument to `execute-extended-command'."
1737 ;; FIXME: Remember the actual text typed by the user before completion,
1738 ;; so that we don't later on suggest the same shortening.
1743 execute-extended-command--last-typed)))
1744 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1756 ;; Some features, such as novice.el, rely on this-command-keys
1757 ;; including M-x COMMAND-NAME RET.
1760 ;; Normally `real-this-command' should never be changed, but here we really
1761 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1762 ;; binding" for <cmd>, so the command the user really wanted to run is
1763 ;; `function' and not `execute-extended-command'. The difference is
1764 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1768 ;; If enabled, show which key runs this command.
1769 ;; But first wait, and skip the message if there is input.
1771 ;; If this command displayed something in the echo area;
1772 ;; wait a few seconds, then display our suggestion message.
1773 ;; FIXME: Wait *after* running post-command-hook!
1774 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1775 ;; find a better answer anyway!
1785 ;; There's no binding for CMD. Let's try and find the shortest
1786 ;; string to use in M-x.
1787 ;; FIXME: Can be slow. Cache it maybe?
1794 function
1799 suggest-key-bindings
1803 ;; BEWARE: Called directly from the C code.
1804 "Execute CMD as an editor command.
1805 CMD must be a symbol that satisfies the `commandp' predicate.
1806 Optional second arg RECORD-FLAG non-nil
1807 means unconditionally put this command in the variable `command-history'.
1808 Otherwise, that is done only if an arg is read using the minibuffer.
1809 The argument KEYS specifies the value to use instead of (this-command-keys)
1810 when reading the arguments; if it is nil, (this-command-keys) is used.
1811 The argument SPECIAL, if non-nil, means that this command is executing
1812 a special event, so ignore the prefix argument and don't clear it."
1815 ;; FIXME: This should probably be done around
1816 ;; pre-command-hook rather than here!
1824 disabled-command-function)
1825 ;; FIXME: Weird calling convention!
1835 ;; If requested, place the macro in the command history. For
1836 ;; other sorts of commands, call-interactively takes care of this.
1839 ;; Don't keep command history around forever.
1845 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1853 \f
1855 "Default minibuffer history list.
1856 This is used for all minibuffer input
1857 except when an alternate history list is specified.
1859 Maximum length of the history list is determined by the value
1862 "Control whether history list elements are expressions or strings.
1863 If the value of this variable equals current minibuffer depth,
1864 they are expressions; otherwise they are strings.
1865 \(That convention is designed to do the right thing for
1872 "Text that was in this minibuffer before any history commands.
1873 This is nil if there have not yet been any history commands
1882 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1887 "Minibuffer history variables for which matching should ignore case.
1888 If a history variable is a member of this list, then the
1890 commands ignore case when searching it, regardless of `case-fold-search'."
1895 "Find the previous history element that matches REGEXP.
1896 \(Previous history elements refer to earlier actions.)
1897 With prefix argument N, search for Nth previous match.
1898 If N is negative, find the next or Nth next match.
1899 Normally, history elements are matched case-insensitively if
1900 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1901 makes the search case-sensitive.
1902 See also `minibuffer-history-case-insensitive-variables'."
1906 nil
1907 minibuffer-local-map
1908 nil
1909 'minibuffer-history-search-history
1911 ;; Use the last regexp specified, by default, if input is empty.
1916 regexp)
1926 ;; On some systems, ignore case for file names.
1928 minibuffer-history-case-insensitive-variables)
1929 t
1930 ;; Respect the user's setting for case-fold-search:
1931 case-fold-search)
1932 nil))
1933 prevpos
1934 match-string
1935 match-offset
1942 "No later matching history item"
1963 next-matching-history-element))
1967 "Find the next history element that matches REGEXP.
1968 \(The next history element refers to a more recent action.)
1969 With prefix argument N, search for Nth next match.
1970 If N is negative, find the previous or Nth previous match.
1971 Normally, history elements are matched case-insensitively if
1972 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1973 makes the search case-sensitive."
1977 nil
1978 minibuffer-local-map
1979 nil
1980 'minibuffer-history-search-history
1982 ;; Use the last regexp specified, by default, if input is empty.
1987 regexp)
1994 "Function run by `goto-history-element' before consuming default values.
1995 This is useful to dynamically add more elements to the list of default values
1996 when `goto-history-element' reaches the end of this list.
1997 Before calling this function `goto-history-element' sets the variable
1998 `minibuffer-default-add-done' to t, so it will call this function only
1999 once. In special cases, when this function needs to be called more
2000 than once, it can set `minibuffer-default-add-done' to nil explicitly,
2004 "When nil, add more elements to the end of the list of default values.
2005 The value nil causes `goto-history-element' to add more elements to
2006 the list of defaults when it reaches the end of this list. It does
2012 "Return a list of all completions without the default value.
2013 This function is used to add all elements of the completion table to
2014 the end of the list of defaults just after the default value."
2017 minibuffer-completion-table
2018 minibuffer-completion-predicate)))
2024 "Puts element of the minibuffer history in the minibuffer.
2025 The argument NABS specifies the absolute history position."
2039 elt minibuffer-returned-to-present)
2046 "End of defaults; no next item"
2053 previous-history-element))
2065 minibuffer-default)))
2077 elt))
2081 "Puts next element of the minibuffer history in the minibuffer.
2082 With argument N, it uses the Nth following element."
2088 "Puts previous element of the minibuffer history in the minibuffer.
2089 With argument N, it uses the Nth previous element."
2095 "Move cursor vertically down ARG lines, or to the next history element.
2096 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2097 next element of the minibuffer history in the minibuffer."
2101 ;; Remember the original goal column of possibly multi-line input
2102 ;; excluding the length of the prompt on the first line.
2112 ;; Restore old position since `line-move-visual' moves point to
2113 ;; the end of the line when it fails to go to the next line.
2116 ;; Reset `temporary-goal-column' because a correct value is not
2117 ;; calculated when `next-line' above fails by bumping against
2118 ;; the bottom of the minibuffer (bug#22544).
2120 ;; Restore the original goal column on the last line
2121 ;; of possibly multi-line input.
2129 "Move cursor vertically up ARG lines, or to the previous history element.
2130 When point moves over the top line of multi-line minibuffer, puts ARGth
2131 previous element of the minibuffer history in the minibuffer."
2135 ;; Remember the original goal column of possibly multi-line input
2136 ;; excluding the length of the prompt on the first line.
2146 ;; Restore old position since `line-move-visual' moves point to
2147 ;; the beginning of the line when it fails to go to the previous line.
2150 ;; Reset `temporary-goal-column' because a correct value is not
2151 ;; calculated when `previous-line' above fails by bumping against
2152 ;; the top of the minibuffer (bug#22544).
2154 ;; Restore the original goal column on the first line
2155 ;; of possibly multi-line input.
2161 ;; Put the cursor at the end of the visual line instead of the
2162 ;; logical line, so the next `previous-line-or-history-element'
2163 ;; would move to the previous history element, not to a possible upper
2164 ;; visual line from the end of logical line in `line-move-visual' mode.
2166 ;; Since `end-of-visual-line' puts the cursor at the beginning
2167 ;; of the next visual line, move it one char back to the end
2168 ;; of the first visual line (bug#22544).
2172 "Get next history element which completes the minibuffer before the point.
2173 The contents of the minibuffer after the point are deleted, and replaced
2174 by the new completion."
2180 n)
2181 ;; next-matching-history-element always puts us at (point-min).
2182 ;; Move to the position we were at before changing the buffer contents.
2183 ;; This is still sensible, because the text before point has not changed.
2187 "\
2188 Get previous history element which completes the minibuffer before the point.
2189 The contents of the minibuffer after the point are deleted, and replaced
2190 by the new completion."
2194 ;; For compatibility with the old subr of the same name.
2196 "Return the display width of the minibuffer prompt.
2197 Return 0 if current buffer is not a minibuffer."
2198 ;; Return the width of everything before the field at the end of
2199 ;; the buffer; this should be 0 for normal buffers.
2201 \f
2202 ;; isearch minibuffer history
2209 "Set up a minibuffer for using isearch to search the minibuffer history.
2210 Intended to be added to `minibuffer-setup-hook'."
2222 "Clean up the minibuffer after terminating isearch in the minibuffer."
2227 "Return the proper search function, for isearch in minibuffer history."
2230 ;; Use standard functions to search within minibuffer text
2232 found)
2233 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2234 ;; searching forward. Lazy-highlight calls this lambda with the
2235 ;; bound arg, so skip the minibuffer prompt.
2239 ;; 1. First try searching in the initial minibuffer text
2242 noerror)
2243 ;; 2. If the above search fails, start putting next/prev history
2244 ;; elements in the minibuffer successively, and search the string
2245 ;; in them. Do this only when bound is nil (i.e. not while
2246 ;; lazy-highlighting search strings in the current minibuffer text).
2258 ;; After putting the next/prev history element, search
2259 ;; the string in them again, until next-history-element
2260 ;; or previous-history-element raises an error at the
2261 ;; beginning/end of history.
2264 ;; For backward search, don't search
2265 ;; in the minibuffer prompt
2267 noerror)))
2268 ;; Return point of the new search result
2270 ;; Return nil when next(prev)-history-element fails
2274 "Display the minibuffer history search prompt.
2275 If there are no search errors, this function displays an overlay with
2276 the isearch prompt which replaces the original minibuffer prompt.
2277 Otherwise, it displays the standard isearch message returned from
2278 the function `isearch-message'."
2280 ;; Use standard function `isearch-message' when not in the minibuffer,
2281 ;; or search fails, or has an error (like incomplete regexp).
2282 ;; This function overwrites minibuffer text with isearch message,
2283 ;; so it's possible to see what is wrong in the search string.
2285 ;; Otherwise, put the overlay with the standard isearch prompt over
2286 ;; the initial minibuffer prompt.
2295 ;; And clear any previous isearch message.
2299 "Wrap the minibuffer history search when search fails.
2300 Move point to the first history element for a forward search,
2301 or to the last history element for a backward search."
2302 ;; When `minibuffer-history-isearch-search' fails on reaching the
2303 ;; beginning/end of the history, wrap the search to the first/last
2304 ;; minibuffer history element.
2312 "Save a function restoring the state of minibuffer history search.
2313 Save `minibuffer-history-position' to the additional state parameter
2314 in the search status stack."
2320 "Restore the minibuffer history search state.
2321 Go to the history element by the absolute history position HIST-POS."
2324 \f
2325 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2329 "Table mapping redo records to the corresponding undo one.
2330 A redo record for undo-in-region maps to t.
2340 "Within a run of consecutive undo commands, list remaining to be undone.
2344 "Undo some previous changes.
2345 Repeat this command to undo more changes.
2346 A numeric ARG serves as a repeat count.
2348 In Transient Mark mode when the mark is active, only undo changes within
2350 as an argument limits undo to changes within the current region."
2352 ;; Make last-command indicate for the next command that this was an undo.
2353 ;; That way, another undo will undo more.
2354 ;; If we get to the end of the undo history and get an error,
2355 ;; another undo command will find the undo history empty
2356 ;; and will get another error. To begin undoing the undos,
2357 ;; you must type some other command.
2359 ;; For an indirect buffer, look in the base buffer for the
2360 ;; auto-save data.
2364 message)
2365 ;; If we get an error in undo-start,
2366 ;; the next command should not be a "consecutive undo".
2367 ;; So set `this-command' to something other than `undo'.
2372 ;; If something (a timer or filter?) changed the buffer
2373 ;; since the previous command, don't continue the undo seq.
2377 ;; If the last undo record made was made by undo
2378 ;; it shows nothing else happened in between.
2385 ;; get rid of initial undo boundary
2387 ;; If we got this far, the next command should be a consecutive undo.
2389 ;; Check to see whether we're hitting a redo record, and if
2390 ;; so, ask the user whether she wants to skip the redo/undo pair.
2398 ;; The equiv entry might point to another redo record if we have done
2399 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2407 ;; Record the fact that the just-generated undo records come from an
2408 ;; undo operation--that is, they are redo records.
2409 ;; In the ordinary case (not within a region), map the redo
2410 ;; record to the following undos.
2411 ;; I don't know how to do that in the undo-in-region case.
2413 ;; Strip any leading undo boundaries there might be, like we do
2414 ;; above when checking.
2418 ;; Prevent identity mapping. This can happen if
2419 ;; consecutive nils are erroneously in undo list.
2421 t
2422 pending-undo-list)
2423 undo-equiv-table))
2424 ;; Don't specify a position in the undo record for the undo command.
2425 ;; Instead, undoing this should move point to where the change is.
2444 ;; Record what the current undo list says,
2445 ;; so the next command can tell if the buffer was modified in between.
2449 ;; Display a message announcing success.
2454 "Make BUFFER stop keeping undo information.
2455 No argument or nil as argument means do this for the current buffer."
2461 "Undo some previous changes.
2462 Repeat this command to undo more changes.
2463 A numeric ARG serves as a repeat count.
2464 Contrary to `undo', this will not redo a previous undo."
2469 "Non-nil while performing an undo.
2473 "Undo back N undo-boundaries beyond what was already undone recently.
2474 Call `undo-start' to get ready to undo recent changes,
2475 then call `undo-more' one or more times to undo them."
2480 ;; Note: The following, while pulling elements off
2481 ;; `pending-undo-list' will call primitive change functions which
2482 ;; will push more elements onto `buffer-undo-list'.
2488 "Undo N records from the front of the list LIST.
2489 Return what remains of the list."
2491 ;; This is a good feature, but would make undo-start
2492 ;; unable to do what is expected.
2493 ;;(when (null (car (list)))
2494 ;; ;; If the head of the list is a boundary, it is the boundary
2495 ;; ;; preceding this command. Get rid of it and don't count it.
2496 ;; (setq list (cdr list))))
2499 ;; In a writable buffer, enable undoing read-only text that is
2500 ;; so because of text properties.
2502 ;; Don't let `intangible' properties interfere with undo.
2504 ;; We use oldlist only to check for EQ. ++kfs
2510 ;; Handle an integer by setting point to that value.
2513 ;; Element (t . TIME) records previous modtime.
2514 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2515 ;; UNKNOWN_MODTIME_NSECS.
2517 ;; If this records an obsolete save
2518 ;; (not matching the actual disk file)
2519 ;; then don't mark unmodified.
2527 ;; Element (nil PROP VAL BEG . END) is property change.
2532 ;; Element (BEG . END) means range was inserted.
2534 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2535 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2538 ;; Set point first thing, so that undoing this undo
2539 ;; does not send point back to where it is now.
2542 ;; Element (apply FUN . ARGS) means call FUN to undo.
2546 ;; Long format: (apply DELTA START END FUN . ARGS).
2553 ;; Check that the function did what the entry
2554 ;; said it would do.
2564 ;; Element (STRING . POS) means STRING was deleted.
2570 ;; Check that marker adjustments which were recorded
2571 ;; with the (STRING . POS) record are still valid, ie
2572 ;; the markers haven't moved. We check their validity
2573 ;; before reinserting the string so as we don't need to
2574 ;; mind marker insertion-type.
2582 ;; Insert string and adjust point
2590 ;; Adjust the valid marker adjustments
2594 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2597 next)
2598 ;; Even though these elements are not expected in the undo
2599 ;; list, adjust them to be conservative for the 24.4
2600 ;; release. (Bug#16818)
2607 ;; Make sure an apply entry produces at least one undo entry,
2608 ;; so the test in `undo' for continuing an undo series
2609 ;; will work right.
2614 list)
2616 ;; Deep copy of a list
2618 "Make a copy of undo list LIST."
2624 elt))
2627 "Set `pending-undo-list' to the front of the undo list.
2628 The next call to `undo-more' will undo the most recently made change.
2629 If BEG and END are specified, then only undo elements
2630 that apply to text between BEG and END are used; other undo elements
2631 are ignored. If BEG and END are nil, all undo elements are used."
2637 buffer-undo-list)))
2639 ;; The positions given in elements of the undo list are the positions
2640 ;; as of the time that element was recorded to undo history. In
2641 ;; general, subsequent buffer edits render those positions invalid in
2642 ;; the current buffer, unless adjusted according to the intervening
2643 ;; undo elements.
2644 ;;
2645 ;; Undo in region is a use case that requires adjustments to undo
2646 ;; elements. It must adjust positions of elements in the region based
2647 ;; on newer elements not in the region so as they may be correctly
2648 ;; applied in the current buffer. undo-make-selective-list
2649 ;; accomplishes this with its undo-deltas list of adjustments. An
2650 ;; example undo history from oldest to newest:
2651 ;;
2652 ;; buf pos:
2653 ;; 123456789 buffer-undo-list undo-deltas
2654 ;; --------- ---------------- -----------
2655 ;; aaa (1 . 4) (1 . -3)
2656 ;; aaba (3 . 4) N/A (in region)
2657 ;; ccaaba (1 . 3) (1 . -2)
2658 ;; ccaabaddd (7 . 10) (7 . -3)
2659 ;; ccaabdd ("ad" . 6) (6 . 2)
2660 ;; ccaabaddd (6 . 8) (6 . -2)
2661 ;; | |<-- region: "caab", from 2 to 6
2662 ;;
2663 ;; When the user starts a run of undos in region,
2664 ;; undo-make-selective-list is called to create the full list of in
2665 ;; region elements. Each element is adjusted forward chronologically
2666 ;; through undo-deltas to determine if it is in the region.
2667 ;;
2668 ;; In the above example, the insertion of "b" is (3 . 4) in the
2669 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2670 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2671 ;; . 6) is assessed as in the region and placed in the selective list.
2672 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2673 ;; due to the selected element. The "b" insertion is the only element
2674 ;; fully in the region, so in this example undo-make-selective-list
2675 ;; returns (nil (5 . 6)).
2676 ;;
2677 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2678 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2679 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2680 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2681 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2682 ;;
2683 ;; More interesting is how to adjust the "ddd" insertion due to the
2684 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2685 ;; If the reinsertion was a manual retyping of "ad", then the total
2686 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2687 ;; the reinsertion was due to undo, one might expect the first "d"
2688 ;; character would again be a part of the "ddd" text, meaning its
2689 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2690 ;;
2691 ;; undo-make-selective-list assumes in this situation that "ad" was a
2692 ;; new edit, even if it was inserted because of an undo.
2693 ;; Consequently, if the user undos in region "8 to 10" of the
2694 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2695 ;; "ccaabad", as though the first "d" became detached from the
2696 ;; original "ddd" insertion. This quirk is a FIXME.
2699 "Return a list of undo elements for the region START to END.
2700 The elements come from `buffer-undo-list', but we keep only the
2701 elements inside this region, and discard those outside this
2702 region. The elements' positions are adjusted so as the returned
2703 list can be applied to the current buffer."
2705 ;; A list of position adjusted undo elements in the region.
2707 ;; A list of undo-deltas for out of region undo elements.
2708 undo-deltas
2709 undo-elt)
2717 ;; Don't put two nils together in the list
2721 ;; This is a "was unmodified" element. Keep it
2722 ;; if we have kept everything thus far.
2725 ;; Skip over marker adjustments, instead relying
2726 ;; on finding them after (TEXT . POS) elements
2728 nil)
2731 undo-deltas)))
2736 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2737 ;; kept. primitive-undo may discard them later.
2750 "Determine whether UNDO-ELT falls inside the region START ... END.
2751 If it crosses the edge, we return nil.
2753 Generally this function is not useful for determining
2754 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2755 because markers can be arbitrarily relocated. Instead, pass the
2756 marker adjustment's corresponding (TEXT . POS) element."
2761 t)
2763 nil)
2765 ;; (TEXT . POSITION)
2769 ;; (MARKER . ADJUSTMENT)
2772 ;; (nil PROPERTY VALUE BEG . END)
2777 ;; (BEGIN . END)
2782 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2783 This assumes we have already decided that UNDO-ELT
2784 is not *inside* the region START...END."
2788 ;; (nil PROPERTY VALUE BEG . END)
2793 ;; (BEGIN . END)
2798 "Return adjustment of undo element ELT by the undo DELTAS
2799 list."
2801 ;; POSITION
2804 ;; (BEG . END)
2807 ;; (TEXT . POSITION)
2811 ;; (nil PROPERTY VALUE BEG . END)
2814 ;; (apply DELTA START END FUN . ARGS)
2815 ;; FIXME
2816 ;; All others return same elt
2819 ;; (BEG . END) can adjust to the same positions, commonly when an
2820 ;; insertion was undone and they are out of region, for example:
2821 ;;
2822 ;; buf pos:
2823 ;; 123456789 buffer-undo-list undo-deltas
2824 ;; --------- ---------------- -----------
2825 ;; [...]
2826 ;; abbaa (2 . 4) (2 . -2)
2827 ;; aaa ("bb" . 2) (2 . 2)
2828 ;; [...]
2829 ;;
2830 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2831 ;; undo. Further adjustments to such an element should be the same as
2832 ;; for (TEXT . POSITION) elements. The options are:
2833 ;;
2834 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2835 ;; analogous to marker insertion-type t.
2836 ;;
2837 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2838 ;; marker insertion-type nil.
2839 ;;
2840 ;; There was no strong reason to prefer one or the other, except that
2841 ;; the first is more consistent with prior undo in region behavior.
2843 "Return cons of adjustments to BEG and END by the undo DELTAS
2844 list."
2846 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2851 "Return adjustment of POS by the undo DELTAS list, comparing
2852 with < or <= based on USE-<."
2858 ;; Don't allow pos to become less than the undo-delta
2859 ;; position. This edge case is described in the overview
2860 ;; comments.
2863 ;; Return the first affected buffer position and the delta for an undo element
2864 ;; delta is defined as the change in subsequent buffer positions if we *did*
2865 ;; the undo.
2869 ;; (TEXT . POSITION)
2872 ;; (BEGIN . END)
2878 ;;; Default undo-boundary addition
2879 ;;
2880 ;; This section adds a new undo-boundary at either after a command is
2881 ;; called or in some cases on a timer called after a change is made in
2882 ;; any buffer.
2884 "Describe the cause of the last undo-boundary.
2886 If `explicit', the last boundary was caused by an explicit call to
2887 `undo-boundary', that is one not called by the code in this
2888 section.
2890 If it is equal to `timer', then the last boundary was inserted
2891 by `undo-auto--boundary-timer'.
2893 If it is equal to `command', then the last boundary was inserted
2894 automatically after a command, that is by the code defined in
2895 this section.
2897 If it is equal to a list, then the last boundary was inserted by
2898 an amalgamating command. The car of the list is the number of
2899 times an amalgamating command has been called, and the cdr are the
2903 "Current timer which will run `undo-auto--boundary-timer' or nil.
2908 "Non-nil if `this-command' should be amalgamated.
2909 This variable is set to nil by `undo-auto--boundaries' and is set
2913 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2917 "Return the number of amalgamating last commands or nil.
2918 Amalgamating commands are, by default, either
2919 `self-insert-command' and `delete-char', but can be any command
2920 that calls `undo-auto-amalgamate'."
2924 "Add an `undo-boundary' to the current buffer if needed.
2925 REASON describes the reason that the boundary is being added; see
2926 `undo-auto--last-boundary' for more information."
2936 undo-auto--undoably-changed-buffers)
2937 cause)))))
2940 "Check recently changed buffers and add a boundary if necessary.
2941 REASON describes the reason that the boundary is being added; see
2942 `undo-last-boundary' for more information."
2943 ;; (Bug #23785) All commands should ensure that there is an undo
2944 ;; boundary whether they have changed the current buffer or not.
2954 "Timer which will run `undo--auto-boundary-timer'."
2959 "Ensure that the `undo-auto-boundary-timer' is set."
2965 "List of buffers that have changed recently.
2967 This list is maintained by `undo-auto--undoable-change' and
2968 `undo-auto--boundaries' and can be affected by changes to their
2972 "Add an `undo-boundary' in appropriate buffers."
2977 'amalgamate
2981 "Amalgamate undo if necessary.
2982 This function can be called before an amalgamating command. It
2983 removes the previous `undo-boundary' if a series of such calls
2984 have been made. By default `self-insert-command' and
2985 `delete-char' are the only amalgamating commands, although this
2986 function could be called by any command wishing to have this
2987 behavior."
2992 last-amalgamating-count
2997 ;; Amalgamate all buffers that have changed.
3001 b
3003 ;; The head of `buffer-undo-list' is nil.
3004 ;; `car-safe' doesn't work because
3005 ;; `buffer-undo-list' need not be a list!
3013 "Called after every undoable buffer change."
3016 ;; End auto-boundary section
3019 "Amalgamate changes in change-group since HANDLE.
3020 Remove all undo boundaries between the state of HANDLE and now.
3021 HANDLE is as returned by `prepare-change-group'."
3030 ;; Temporarily truncate the undo log at ELT.
3035 ;; `elt' is still in the log: normal case.
3037 ;; `elt' is not in the log any more, but that's because
3038 ;; the log is "all new", so we should remove all
3039 ;; boundaries from it.
3043 buffer-undo-list
3044 ;; Preserve the undo-boundaries at either ends of the
3045 ;; change-groups.
3047 ;; Reset the modified cons cell ELT to its original content.
3054 "If non-nil ask about discarding undo info for the current command.
3055 Normally, Emacs discards the undo info for the current command if
3056 it exceeds `undo-outer-limit'. But if you set this option
3057 non-nil, it asks in the echo area whether to discard the info.
3058 If you answer no, there is a slight risk that Emacs might crash, so
3059 only do it if you really want to undo the command.
3061 This option is mainly intended for debugging. You have to be
3062 careful if you use it for other purposes. Garbage collection is
3063 inhibited while the question is asked, meaning that Emacs might
3064 leak memory. So you should make sure that you do not wait
3065 excessively long before answering the question."
3071 "If non-nil, an extra level of size that's ok in an undo item.
3072 We don't ask the user about truncating the undo list until the
3073 current item gets bigger than this amount.
3078 ;; When the first undo batch in an undo list is longer than
3079 ;; undo-outer-limit, this function gets called to warn the user that
3080 ;; the undo info for the current command was discarded. Garbage
3081 ;; collection is inhibited around the call, so it had better not do a
3082 ;; lot of consing.
3088 ;; Don't ask the question again unless it gets even bigger.
3089 ;; This applies, in particular, if the user quits from the question.
3090 ;; Such a quit quits out of GC, but something else will call GC
3091 ;; again momentarily. It will call this function again,
3092 ;; but we don't want to ask the question again.
3096 "Buffer `%s' undo info is %d bytes long; discard it? "
3100 t)
3101 nil))
3107 "The undo info was discarded because it exceeded \
3108 `undo-outer-limit'.
3110 This is normal if you executed a command that made a huge change
3111 to the buffer. In that case, to prevent similar problems in the
3112 future, set `undo-outer-limit' to a value that is large enough to
3113 cover the maximum size of normal changes you expect a single
3114 command to make, but not so large that it might exceed the
3115 maximum memory allotted to Emacs.
3117 If you did not execute any such command, the situation is
3118 probably due to a bug and you should report it.
3120 You can disable the popping up of this buffer by adding the entry
3121 \(undo discard-info) to the user option `warning-suppress-types',
3125 t))
3126 \f
3129 ; These are sorted according to the GNU en_US locale.
3172 )
3174 This is used by Shell mode and other parts of Emacs to recognize
3175 password prompts, including prompts in languages other than
3176 English. Different case choices should not be assumed to be
3177 included; callers should bind `case-fold-search' to t."
3183 "History list for some commands that read shell commands.
3185 Maximum length of the history list is determined by the value
3192 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3193 This buffer is used when `shell-command' or `shell-command-on-region'
3194 is run interactively. A value of nil means that output to stderr and
3201 "Return a list of all commands associated with the current file.
3202 This function is used to add all related commands retrieved by `mailcap'
3203 to the end of the list of defaults just after the default value."
3207 minibuffer-default))
3212 commands))
3223 map)
3227 "Read a shell command from the minibuffer.
3228 The arguments are the same as the ones of `read-from-minibuffer',
3229 except READ and KEYMAP are missing and HIST defaults
3230 to `shell-command-history'."
3238 minibuffer-local-shell-command-map
3239 nil
3241 args)))
3244 "What to do when the output buffer is used by another shell command.
3245 This option specifies how to resolve the conflict where a new command
3246 wants to direct its output to the buffer `*Async Shell Command*',
3247 but this buffer is already taken by another running shell command.
3249 The value `confirm-kill-process' is used to ask for confirmation before
3250 killing the already running process and running a new process
3251 in the same buffer, `confirm-new-buffer' for confirmation before running
3252 the command in a new buffer with a name other than the default buffer name,
3253 `new-buffer' for doing the same without confirmation,
3254 `confirm-rename-buffer' for confirmation before renaming the existing
3255 output buffer and running a new command in the default buffer,
3256 `rename-buffer' for doing the same without confirmation."
3258 confirm-kill-process)
3260 confirm-new-buffer)
3262 new-buffer)
3264 confirm-rename-buffer)
3266 rename-buffer))
3271 "Store a buffer position or erase the buffer.
3272 See `shell-command-dont-erase-buffer'."
3274 pos)
3276 ;; Setting buffer-read-only to nil doesn't suffice
3277 ;; if some text has a non-nil read-only property,
3278 ;; which comint sometimes adds for prompts.
3288 shell-command-saved-pos))))
3291 "Set point in BUFFER after command complete.
3292 BUFFER is the output buffer of the command; if nil, then defaults
3293 to the current BUFFER.
3294 Set point to the `cdr' of the element in `shell-command-saved-pos'
3295 whose `car' is BUFFER."
3307 ;; Set point in the window displaying buf, if any; otherwise
3308 ;; display buf temporary in selected frame and set the point.
3313 buf
3318 "Execute string COMMAND asynchronously in background.
3320 Like `shell-command', but adds `&' at the end of COMMAND
3321 to execute it asynchronously.
3323 The output appears in the buffer `*Async Shell Command*'.
3324 That buffer is in shell mode.
3326 You can configure `async-shell-command-buffer' to specify what to do in
3327 case when `*Async Shell Command*' buffer is already taken by another
3328 running shell command. To run COMMAND without displaying the output
3329 in a window you can configure `display-buffer-alist' to use the action
3330 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3332 In Elisp, you will often be better served by calling `start-process'
3333 directly, since it offers more control and does not impose the use of a
3334 shell (with its need to quote arguments)."
3344 current-prefix-arg
3345 shell-command-default-error-buffer))
3351 "Execute string COMMAND in inferior shell; display output, if any.
3352 With prefix argument, insert the COMMAND's output at point.
3354 Interactively, prompt for COMMAND in the minibuffer.
3356 If COMMAND ends in `&', execute it asynchronously.
3357 The output appears in the buffer `*Async Shell Command*'.
3358 That buffer is in shell mode. You can also use
3359 `async-shell-command' that automatically adds `&'.
3361 Otherwise, COMMAND is executed synchronously. The output appears in
3362 the buffer `*Shell Command Output*'. If the output is short enough to
3363 display in the echo area (which is determined by the variables
3364 `resize-mini-windows' and `max-mini-window-height'), it is shown
3365 there, but it is nonetheless available in buffer `*Shell Command
3366 Output*' even though that buffer is not automatically displayed.
3368 To specify a coding system for converting non-ASCII characters
3370 before this command.
3372 Noninteractive callers can specify coding systems by binding
3373 `coding-system-for-read' and `coding-system-for-write'.
3375 The optional second argument OUTPUT-BUFFER, if non-nil,
3376 says to put the output in some other buffer.
3377 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3378 and insert the output there; a non-nil value of
3379 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3380 If OUTPUT-BUFFER is not a buffer and not nil, insert the output
3381 in current buffer after point leaving mark after it.
3382 This cannot be done asynchronously.
3384 If the command terminates without error, but generates output,
3386 the output can be displayed in the echo area or in its buffer.
3387 If the output is short enough to display in the echo area
3388 \(determined by the variable `max-mini-window-height' if
3389 `resize-mini-windows' is non-nil), it is shown there.
3390 Otherwise,the buffer containing the output is displayed.
3394 of the output.
3396 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3397 or buffer name to which to direct the command's standard error output.
3398 If it is nil, error output is mingled with regular output.
3399 In an interactive call, the variable `shell-command-default-error-buffer'
3400 specifies the value of ERROR-BUFFER.
3402 In Elisp, you will often be better served by calling `call-process' or
3403 `start-process' directly, since it offers more control and does not impose
3404 the use of a shell (with its need to quote arguments)."
3415 current-prefix-arg
3416 shell-command-default-error-buffer))
3417 ;; Look for a handler in case default-directory is a remote file name.
3425 ;; Output goes in current buffer.
3431 temporary-file-directory)))
3432 nil)))
3435 ;; We do not use -f for csh; we will not support broken use of
3436 ;; .cshrcs. Even the BSD csh manual says to use
3437 ;; "if ($?prompt) exit" before things which are not useful
3438 ;; non-interactively. Besides, if someone wants their other
3439 ;; aliases for shell commands then they can still have them.
3443 t)
3444 nil shell-command-switch command)
3451 ;; Do no formatting while reading error file,
3452 ;; because that can run a shell command, and we
3453 ;; don't want that to cause an infinite recursion.
3455 ;; Put point after the inserted errors.
3459 ;; This is like exchange-point-and-mark, but doesn't
3460 ;; activate the mark. It is cleaner to avoid activation,
3461 ;; even though the command loop would deactivate the mark
3462 ;; because we inserted text.
3466 ;; Output goes in a separate buffer.
3467 ;; Preserve the match data in case called from a program.
3468 ;; FIXME: It'd be ridiculous for an Elisp function to call
3469 ;; shell-command and assume that it won't mess the match-data!
3472 ;; Command ending with ampersand means asynchronous.
3476 proc)
3477 ;; Remove the ampersand.
3479 ;; Ask the user what to do with already running process.
3484 ;; If will kill a process, query first.
3489 ;; If will create a new buffer, query first.
3496 ;; It will create a new buffer.
3501 ;; If will rename the buffer, query first.
3510 ;; It will rename the buffer.
3520 shell-command-switch command))
3524 ;; Use the comint filter for proper handling of carriage motion
3525 ;; (see `comint-inhibit-carriage-motion'),.
3527 ))
3528 ;; Otherwise, command is executed synchronously.
3530 output-buffer nil error-buffer)))))))
3533 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3534 MESSAGE may be either a string or a buffer.
3536 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3537 for maximum height of the echo area, as defined by `max-mini-window-height'
3538 if `resize-mini-windows' is non-nil.
3540 Returns either the string shown in the echo area, or when a pop-up
3541 buffer is used, the window used to display it.
3543 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3544 name of the buffer used to display it in the case where a pop-up buffer
3545 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3546 string and it is displayed in the echo area, it is not specified whether
3547 the contents are inserted into the buffer anyway.
3549 Optional arguments ACTION and FRAME are as for `display-buffer',
3550 and are only used if a pop-up buffer is displayed."
3552 ;; Trivial case where we can use the echo area
3556 ;; Trivial case where we can just remove single trailing newline
3559 ;; General case
3562 message
3571 0
3575 (<= lines
3579 max-mini-window-height))
3581 max-mini-window-height)
3585 ;; Don't use the echo area if the output buffer is
3586 ;; already displayed in the selected frame.
3588 ;; Echo area
3594 ;; Buffer
3599 ;; We have a sentinel to prevent insertion of a termination message
3600 ;; in the buffer itself, and to set the point in the buffer when
3601 ;; `shell-command-dont-erase-buffer' is non-nil.
3610 &optional output-buffer replace
3611 error-buffer display-error-buffer
3612 region-noncontiguous-p)
3613 "Execute string COMMAND in inferior shell with region as input.
3614 Normally display output (if any) in temp buffer `*Shell Command Output*';
3615 Prefix arg means replace the region with it. Return the exit code of
3616 COMMAND.
3618 To specify a coding system for converting non-ASCII characters
3620 before this command. By default, the input (from the current buffer)
3621 is encoded using coding-system specified by `process-coding-system-alist',
3622 falling back to `default-process-coding-system' if no match for COMMAND
3623 is found in `process-coding-system-alist'.
3625 Noninteractive callers can specify coding systems by binding
3626 `coding-system-for-read' and `coding-system-for-write'.
3628 If the command generates output, the output may be displayed
3629 in the echo area or in a buffer.
3630 If the output is short enough to display in the echo area
3631 \(determined by the variable `max-mini-window-height' if
3632 `resize-mini-windows' is non-nil), it is shown there.
3633 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3634 The output is available in that buffer in both cases.
3636 If there is output and an error, a message about the error
3637 appears at the end of the output.
3639 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3640 command's output. If the value is a buffer or buffer name,
3641 erase that buffer and insert the output there; a non-nil value of
3642 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3643 If the value is nil, use the buffer `*Shell Command Output*'.
3644 Any other non-nil value means to insert the output in the
3645 current buffer after START.
3647 Optional fifth arg REPLACE, if non-nil, means to insert the
3648 output in place of text from START to END, putting point and mark
3649 around it.
3651 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3652 or buffer name to which to direct the command's standard error
3653 output. If nil, error output is mingled with regular output.
3654 When called interactively, `shell-command-default-error-buffer'
3655 is used for ERROR-BUFFER.
3657 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3658 display the error buffer if there were any errors. When called
3659 interactively, this is t."
3663 ;; Do this before calling region-beginning
3664 ;; and region-end, in case subprocess output
3665 ;; relocates them while we are in the minibuffer.
3667 ;; call-interactively recognizes region-beginning and
3668 ;; region-end specially, leaving them in the history.
3670 string
3671 current-prefix-arg
3672 current-prefix-arg
3673 shell-command-default-error-buffer
3674 t
3681 temporary-file-directory)))
3682 nil))
3683 exit-status)
3684 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3687 output)
3691 shell-file-name t t
3692 nil shell-command-switch
3693 command)
3700 ;; Replace specified region with output from command.
3702 ;; Don't muck with mark unless REPLACE says we should.
3709 t)))
3710 ;; It is rude to delete a buffer which the command is not using.
3711 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3712 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3713 ;; (kill-buffer shell-buffer)))
3714 ;; Don't muck with mark unless REPLACE says we should.
3716 ;; No prefix argument: put the output in a temp buffer,
3717 ;; replacing its entire contents.
3725 ;; If the input is the same buffer as the output,
3726 ;; delete everything but the specified region,
3727 ;; then replace that region with the output.
3733 shell-file-name t
3736 t)
3737 nil shell-command-switch
3738 command)))
3739 ;; Clear the output buffer, then run the command with
3740 ;; output there.
3750 buffer))))
3751 ;; Report the output.
3761 ;; There's some output, display it
3765 ;; No output; error?
3772 shell-command-default-error-buffer)
3779 output))
3782 exit-status))
3785 exit-status output))))
3786 ;; Don't kill: there might be useful info in the undo-log.
3787 ;; (kill-buffer buffer)
3788 )))))
3796 ;; Do no formatting while reading error file,
3797 ;; because that can run a shell command, and we
3798 ;; don't want that to cause an infinite recursion.
3800 ;; Put point after the inserted errors.
3805 exit-status))
3808 "Execute shell command COMMAND and return its output as a string."
3811 standard-output
3815 "Process files synchronously in a separate process.
3816 Similar to `call-process', but may invoke a file handler based on
3817 `default-directory'. The current working directory of the
3818 subprocess is `default-directory'.
3820 File names in INFILE and BUFFER are handled normally, but file
3821 names in ARGS should be relative to `default-directory', as they
3822 are passed to the process verbatim. (This is a difference to
3823 `call-process' which does not support file handlers for INFILE
3824 and BUFFER.)
3826 Some file handlers might not support all variants, for example
3827 they might behave as if DISPLAY was nil, regardless of the actual
3828 value passed."
3830 lc stderr-file)
3840 display args)
3846 "Whether a call of `process-file' changes remote files.
3848 By default, this variable is always set to t, meaning that a
3849 call of `process-file' could potentially change any file on a
3850 remote host. When set to nil, a file handler could optimize
3851 its behavior with respect to remote file attribute caching.
3853 You should only ever change this variable with a let-binding;
3857 "Start a program in a subprocess. Return the process object for it.
3859 Similar to `start-process', but may invoke a file handler based on
3860 `default-directory'. See Info node `(elisp)Magic File Names'.
3862 This handler ought to run PROGRAM, perhaps on the local host,
3863 perhaps on a remote host that corresponds to `default-directory'.
3864 In the latter case, the local part of `default-directory' becomes
3865 the working directory of the process.
3867 PROGRAM and PROGRAM-ARGS might be file names. They are not
3868 objects of file handler invocation. File handlers might not
3869 support pty association, if PROGRAM is nil."
3873 \f
3874 ;;;; Process menu
3888 map))
3891 "Major mode for listing the processes called by Emacs."
3904 "Kill process at point in a `list-processes' buffer."
3915 "Recompute the list of processes for the Process List buffer.
3916 Also, delete any process that is exited or signaled."
3930 face link
3932 "Visit buffer `%s'"
3934 follow-link t
3935 process-buffer ,buf
3936 action process-menu-visit-buffer)
3945 "datagram"
3962 tabulated-list-entries))))))
3968 "Display a list of all processes that are Emacs sub-processes.
3969 If optional argument QUERY-ONLY is non-nil, only processes with
3970 the query-on-exit flag set are listed.
3971 Any process listed as exited or signaled is actually eliminated
3972 after the listing is made.
3973 Optional argument BUFFER specifies a buffer to use, instead of
3975 The return value is always nil.
3977 This function lists only processes that were launched by Emacs. To
3978 see other processes running on the system, use `list-system-processes'."
3990 nil)
3991 \f
3992 ;;;; Prefix commands
3998 ;; BEWARE: Called directly from C code.
3999 ;; If the return value is non-nil, it means we are in the middle of
4000 ;; a command with prefix, such as a command invoked with prefix-arg.
4002 prefix-command--last-echo
4011 "Abnormal hook which constructs the description of the current prefix state.
4015 "Update state of prefix commands.
4023 "Pass the current prefix command state to the next command.
4024 Should be called by all prefix commands.
4025 Runs `prefix-command-preserve-state-hook'."
4027 ;; If the current command is a prefix command, we don't want the next (real)
4028 ;; command to have `last-command' set to, say, `universal-argument'.
4035 nil)
4037 ;;;;; The main prefix command.
4039 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
4064 ;; For backward compatibility, minus with no modifiers is an ordinary
4065 ;; command if digits have already been entered.
4095 map)
4103 "Begin a numeric argument for the following command.
4108 multiplies the argument by 4 each time.
4110 which is different in effect from any particular numeric argument.
4118 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
4119 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
4126 arg)))
4130 "Begin a negative numeric argument for the next command.
4140 "Part of the numeric argument for the next command.
4145 last-command-event
4152 ;; Treat -0 as just -, so that -01 will work.
4155 digit))))
4157 \f
4160 "This variable is a wrapper hook around `buffer-substring--filter'.
4166 "Function to perform the filtering in `filter-buffer-substring'.
4167 The function is called with the same 3 arguments (BEG END DELETE)
4168 that `filter-buffer-substring' received. It should return the
4169 buffer substring between BEG and END, after filtering. If DELETE is
4173 "List of filter functions for `buffer-substring--filter'.
4174 Each function must accept a single argument, a string, and return a string.
4175 The buffer substring is passed to the first function in the list,
4176 and the return value of each function is passed to the next.
4177 As a special convention, point is set to the start of the buffer text
4178 being operated on (i.e., the first argument of `buffer-substring--filter')
4184 "Return the buffer substring between BEG and END, after filtering.
4185 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4187 This calls the function that `filter-buffer-substring-function' specifies
4188 \(passing the same three arguments that it received) to do the work,
4189 and returns whatever it does. The default function does no filtering,
4190 unless a hook has been set.
4192 Use `filter-buffer-substring' instead of `buffer-substring',
4193 `buffer-substring-no-properties', or `delete-and-extract-region' when
4194 you want to allow filtering to take place. For example, major or minor
4195 modes can use `filter-buffer-substring-function' to extract characters
4196 that are special to a buffer, and should not be copied into other buffers."
4200 "Default function to use for `filter-buffer-substring-function'.
4201 Its arguments and return value are as specified for `filter-buffer-substring'.
4202 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4203 \(see `with-wrapper-hook' for details about wrapper hooks),
4204 and the abnormal hook `buffer-substring-filters'.
4205 No filtering is done unless a hook says to."
4216 string)))
4221 ;;;; Window system cut and paste hooks.
4224 "Function to call to make a killed region available to other programs.
4225 Most window systems provide a facility for cutting and pasting
4226 text between different programs, such as the clipboard on X and
4227 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4229 This variable holds a function that Emacs calls whenever text is
4230 put in the kill ring, to make the new kill available to other
4231 programs. The function takes one argument, TEXT, which is a
4235 "Function to call to get text cut from 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 to obtain text
4241 that other programs have provided for pasting. The function is
4242 called with no arguments. If no other program has provided text
4243 to paste, the function should return nil (in which case the
4244 caller, usually `current-kill', should use the top of the Emacs
4245 kill ring). If another program has provided text to paste, the
4246 function should return that text as a string (in which case the
4247 caller should put this string in the kill ring as the latest
4248 kill).
4250 The function may also return a list of strings if the window
4251 system supports multiple selections. The first string will be
4252 used as the pasted text, but the other will be placed in the kill
4253 ring for easy access via `yank-pop'.
4255 Note that the function should return a string only if a program
4256 other than Emacs has provided a string for pasting; if Emacs
4257 provided the most recent string, the function should return nil.
4258 If it is difficult to tell whether Emacs or some other program
4259 provided the current string, it is probably good enough to return
4260 nil if the string is equal (according to `string=') to the last
4262 \f
4265 ;;;; The kill ring data structure.
4268 "List of killed text sequences.
4269 Since the kill ring is supposed to interact nicely with cut-and-paste
4270 facilities offered by window systems, use of this variable should
4271 interact nicely with `interprogram-cut-function' and
4272 `interprogram-paste-function'. The functions `kill-new',
4273 `kill-append', and `current-kill' are supposed to implement this
4274 interaction; you may want to use them instead of manipulating the kill
4278 "Maximum length of kill ring before oldest elements are thrown away."
4286 "Save clipboard strings into kill ring before replacing them.
4287 When one selects something in another program to paste it into Emacs,
4288 but kills something in Emacs before actually pasting it,
4289 this selection is gone unless this variable is non-nil,
4290 in which case the other program's selection is saved in the `kill-ring'
4297 "Do not add a new string to `kill-ring' if it duplicates the last one.
4298 The comparison is done using `equal-including-properties'."
4304 "Make STRING the latest kill in the kill ring.
4305 Set `kill-ring-yank-pointer' to point to it.
4306 If `interprogram-cut-function' is non-nil, apply it to STRING.
4307 Optional second argument REPLACE non-nil means that STRING will replace
4308 the front of the kill ring, rather than being added to the list.
4310 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4311 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4312 STRING.
4314 When the yank handler has a non-nil PARAM element, the original STRING
4315 argument is not used by `insert-for-yank'. However, since Lisp code
4316 may access and use elements from the kill ring directly, the STRING
4319 ;; Due to text properties such as 'yank-handler that
4320 ;; can alter the contents to yank, comparison using
4321 ;; `equal' is unsafe.
4346 ;; It has been argued that this should work similar to `self-insert-command'
4347 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4349 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4355 "Append STRING to the end of the latest kill in the kill ring.
4356 If BEFORE-P is non-nil, prepend STRING to the kill.
4357 Also removes the last undo boundary in the current buffer,
4358 depending on `kill-append-merge-undo'.
4359 If `interprogram-cut-function' is set, pass the resulting kill to it."
4367 ;; find the next undo boundary
4371 ;; remove this undo boundary
4376 "Whether rotating the kill ring changes the window system selection.
4377 If non-nil, whenever the kill ring is rotated (usually via the
4378 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4379 to copy the new kill to the window system selection."
4385 "Rotate the yanking point by N places, and then return that kill.
4386 If N is zero and `interprogram-paste-function' is set to a
4387 function that returns a string or a list of strings, and if that
4388 function doesn't return nil, then that string (or list) is added
4389 to the front of the kill ring and the string (or first string in
4390 the list) is returned as the latest kill.
4392 If N is not zero, and if `yank-pop-change-selection' is
4393 non-nil, use `interprogram-cut-function' to transfer the
4394 kill at the new yank point into the window system selection.
4396 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4397 move the yanking point; just return the Nth kill forward."
4400 interprogram-paste-function
4404 ;; Disable the interprogram cut function when we add the new
4405 ;; text to the kill ring, so Emacs doesn't try to own the
4406 ;; selection, with identical text.
4416 kill-ring)))
4421 interprogram-cut-function)
4427 ;;;; Commands for manipulating the kill ring.
4430 "Non-nil means don't signal an error for killing read-only text."
4436 This deletes the text from the buffer and saves it in the kill ring.
4440 If you want to append the killed region to the last killed text,
4444 If the previous command was also a kill command,
4445 the text killed this time appends to the text killed last time
4446 to make one entry in the kill ring.
4448 The killed text is filtered by `filter-buffer-substring' before it is
4449 saved in the kill ring, so the actual saved text might be different
4450 from what was killed.
4452 If the buffer is read-only, Emacs will beep and refrain from deleting
4453 the text, but put the text in the kill ring anyway. This means that
4454 you can use the killing commands to copy text from a read-only buffer.
4456 Lisp programs should use this function for killing text.
4457 (To delete text, use `delete-region'.)
4458 Supply two arguments, character positions BEG and END indicating the
4459 stretch of text to be killed. If the optional argument REGION is
4460 non-nil, the function ignores BEG and END, and kills the current
4461 region instead."
4462 ;; Pass mark first, then point, because the order matters when
4463 ;; calling `kill-append'.
4472 ;; Add that string to the kill ring, one way or another.
4479 nil)
4481 ;; The code above failed because the buffer, or some of the characters
4482 ;; in the region, are read-only.
4483 ;; We should beep, in case the user just isn't aware of this.
4484 ;; However, there's no harm in putting
4485 ;; the region's text in the kill ring, anyway.
4487 ;; Set this-command now, so it will be set even if we get an error.
4489 ;; This should barf, if appropriate, and give us the correct error.
4492 ;; Signal an error if the buffer is read-only.
4494 ;; If the buffer isn't read-only, the text is.
4497 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4498 ;; to get two copies of the text when the user accidentally types M-w and
4499 ;; then corrects it with the intended C-w.
4501 "Save the region as if killed, but don't kill it.
4502 In Transient Mark mode, deactivate the mark.
4503 If `interprogram-cut-function' is non-nil, also save the text for a window
4504 system cut and paste.
4506 The copied text is filtered by `filter-buffer-substring' before it is
4507 saved in the kill ring, so the actual saved text might be different
4508 from what was in the buffer.
4510 When called from Lisp, save in the kill ring the stretch of text
4511 between BEG and END, unless the optional argument REGION is
4512 non-nil, in which case ignore BEG and END, and save the current
4513 region instead.
4515 This command's old key binding has been given to `kill-ring-save'."
4516 ;; Pass mark first, then point, because the order matters when
4517 ;; calling `kill-append'.
4527 nil)
4530 "Save the region as if killed, but don't kill it.
4531 In Transient Mark mode, deactivate the mark.
4532 If `interprogram-cut-function' is non-nil, also save the text for a window
4533 system cut and paste.
4535 If you want to append the killed line to the last killed text,
4538 The copied text is filtered by `filter-buffer-substring' before it is
4539 saved in the kill ring, so the actual saved text might be different
4540 from what was in the buffer.
4542 When called from Lisp, save in the kill ring the stretch of text
4543 between BEG and END, unless the optional argument REGION is
4544 non-nil, in which case ignore BEG and END, and save the current
4545 region instead.
4547 This command is similar to `copy-region-as-kill', except that it gives
4548 visual feedback indicating the extent of the region being copied."
4549 ;; Pass mark first, then point, because the order matters when
4550 ;; calling `kill-append'.
4554 ;; This use of called-interactively-p is correct because the code it
4555 ;; controls just gives the user visual feedback.
4560 "Indicate that the region text has been copied interactively.
4561 If the mark is visible in the selected window, blink the cursor
4562 between point and mark if there is currently no active region
4563 highlighting.
4565 If the mark lies outside the selected window, display an
4566 informative message containing a sample of the copied text. The
4567 optional argument MESSAGE-LEN, if non-nil, specifies the length
4568 of this sample text; it defaults to 40."
4571 ;; Inhibit quitting so we can make a quit here
4572 ;; look like a C-g typed as a command.
4575 ;; Swap point-and-mark quickly so as to show the region that
4576 ;; was selected. Don't do it if the region is highlighted.
4579 ;; Swap point and mark.
4583 ;; Swap back.
4586 ;; If user quit, deactivate the mark
4587 ;; as C-g would as a command.
4593 ;; Don't say "killed"; that is misleading.
4600 "Cause following command, if it kills, to add to previous kill.
4601 If the next command kills forward from point, the kill is
4602 appended to the previous killed text. If the command kills
4603 backward, the kill is prepended. Kill commands that act on the
4604 region, such as `kill-region', are regarded as killing forward if
4605 point is after mark, and killing backward if point is before
4606 mark.
4608 If the next command is not a kill command, `append-next-kill' has
4609 no effect.
4611 The argument is used for internal purposes; do not supply one."
4613 ;; We don't use (interactive-p), since that breaks kbd macros.
4627 "A subroutine of `squeeze-bidi-context'.
4628 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4632 lim1)
4639 ;; L and R categories include embedding and
4640 ;; override controls, but we don't want to
4641 ;; replace them, because that might change
4642 ;; the visual order. Likewise with PDF and
4643 ;; isolate controls.
4645 bidi-directional-non-controls-chars
4646 limit)))))
4647 ;; Replace any run of non-RTL characters by a single LRM.
4649 ;; No more characters of CATEGORY, we are done.
4654 ;; Skip directional controls, if any.
4659 "Replace characters between FROM and TO while keeping bidi context.
4661 This function replaces the region of text with as few characters
4662 as possible, while preserving the effect that region will have on
4663 bidirectional display before and after the region."
4667 ;; This is for when they copy text with read-only text
4668 ;; properties.
4672 ;; Replace each run of non-RTL characters with a single LRM.
4674 ;; Replace each run of non-LTR characters with a single RLM. Note
4675 ;; that the \cR category includes both the Arabic Letter (AL) and
4676 ;; R characters; here we ignore the distinction between them,
4677 ;; because that distinction only affects Arabic Number (AN)
4678 ;; characters, which are weak and don't affect the reordering.
4682 "Return buffer text between START and END with its bidi context.
4684 START and END are assumed to belong to the same physical line
4685 of buffer text. This function prepends and appends to the text
4686 between START and END bidi control characters that preserve the
4687 visual order of that text when it is inserted at some other place."
4692 substr para-dir from to)
4699 ;; If we don't have any mixed directional characters in the
4700 ;; entire line, we can just copy the substring without adding
4701 ;; any context.
4716 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4717 ;; (1) force the string to have the same base embedding
4718 ;; direction as the paragraph direction at the source, no matter
4719 ;; what is the paragraph direction at destination; and (2) avoid
4720 ;; affecting the visual order of the surrounding text at
4721 ;; destination if there are characters of different
4722 ;; directionality there.
4727 "Return portion of current buffer between START and END with bidi context.
4729 This function works similar to `buffer-substring', but it prepends and
4730 appends to the text bidi directional control characters necessary to
4731 preserve the visual appearance of the text if it is inserted at another
4732 place. This is useful when the buffer substring includes bidirectional
4733 text and control characters that cause non-trivial reordering on display.
4734 If copied verbatim, such text can have a very different visual appearance,
4735 and can also change the visual appearance of the surrounding text at the
4736 destination of the copy.
4738 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4739 the text properties."
4752 no-properties)))
4756 substr)))
4757 \f
4758 ;; Yanking.
4763 "List of special text property handling conditions for yanking.
4764 Each element should have the form (PROP . FUN), where PROP is a
4765 property symbol and FUN is a function. When the `yank' command
4766 inserts text into the buffer, it scans the inserted text for
4767 stretches of text that have `eq' values of the text property
4768 PROP; for each such stretch of text, FUN is called with three
4769 arguments: the property's value in that text, and the start and
4770 end positions of the text.
4772 This is done prior to removing the properties specified by
4773 `yank-excluded-properties'."
4776 function))
4779 ;; This is actually used in subr.el but defcustom does not work there.
4782 intangible invisible keymap local-map mouse-face read-only
4783 yank-handler)
4784 "Text properties to discard when yanking.
4785 The value should be a list of text properties to discard or t,
4786 which means to discard all text properties.
4788 See also `yank-handled-properties'."
4795 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4796 Function is called with two parameters, START and END corresponding to
4797 the value of the mark and point; it is guaranteed that START <= END.
4801 "Replace just-yanked stretch of killed text with a different stretch.
4802 This command is allowed only immediately after a `yank' or a `yank-pop'.
4803 At such a time, the region contains a stretch of reinserted
4804 previously-killed text. `yank-pop' deletes that text and inserts in its
4805 place a different stretch of killed text.
4807 With no argument, the previous kill is inserted.
4808 With argument N, insert the Nth previous kill.
4809 If N is negative, this is a more recent kill.
4811 The sequence of kills wraps around, so that after the oldest one
4812 comes the newest one.
4814 This command honors the `yank-handled-properties' and
4815 `yank-excluded-properties' variables, and the `yank-handler' text
4816 property, in the way that `yank' does."
4830 ;; Set the window start back where it was in the yank command,
4831 ;; if possible.
4834 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4835 ;; It is cleaner to avoid activation, even though the command
4836 ;; loop would deactivate the mark because we inserted text.
4839 nil)
4843 More precisely, reinsert the most recent kill, which is the
4844 stretch of killed text most recently killed OR yanked. Put point
4845 at the end, and set mark at the beginning without activating it.
4847 With argument N, reinsert the Nth most recent kill.
4849 This command honors the `yank-handled-properties' and
4850 `yank-excluded-properties' variables, and the `yank-handler' text
4851 property, as described below.
4853 Properties listed in `yank-handled-properties' are processed,
4854 then those listed in `yank-excluded-properties' are discarded.
4856 If STRING has a non-nil `yank-handler' property anywhere, the
4857 normal insert behavior is altered, and instead, for each contiguous
4858 segment of STRING that has a given value of the `yank-handler'
4859 property, that value is used as follows:
4861 The value of a `yank-handler' property must be a list of one to four
4862 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
4863 FUNCTION, if non-nil, should be a function of one argument (the
4864 object to insert); FUNCTION is called instead of `insert'.
4865 PARAM, if present and non-nil, is passed to FUNCTION (to be handled
4866 in whatever way is appropriate; e.g. if FUNCTION is `yank-rectangle',
4867 PARAM may be a list of strings to insert as a rectangle). If PARAM
4868 is nil, then the current segment of STRING is used.
4869 If NOEXCLUDE is present and non-nil, the normal removal of
4870 `yank-excluded-properties' is not performed; instead FUNCTION is
4871 responsible for the removal. This may be necessary if FUNCTION
4872 adjusts point before or after inserting the object.
4873 UNDO, if present and non-nil, should be a function to be called
4874 by `yank-pop' to undo the insertion of the current PARAM. It is
4875 given two arguments, the start and end of the region. FUNCTION
4876 may set `yank-undo-function' to override UNDO.
4881 ;; If we don't get all the way thru, make last-command indicate that
4882 ;; for the following command.
4890 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4891 ;; It is cleaner to avoid activation, even though the command
4892 ;; loop would deactivate the mark because we inserted text.
4895 ;; If we do get all the way thru, make this-command indicate that.
4898 nil)
4901 "Rotate the yanking point in the kill ring.
4902 With ARG, rotate that many kills forward (or backward, if negative)."
4905 \f
4906 ;; Some kill commands.
4908 ;; Internal subroutine of delete-char
4914 ;; Internal subroutine of backward-delete-char
4921 "The method for untabifying when deleting backward.
4922 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4923 `hungry' -- delete all whitespace, both tabs and spaces;
4924 `all' -- delete all whitespace, including tabs, spaces and newlines;
4925 nil -- just delete one character."
4931 "Delete characters backward, changing tabs into spaces.
4932 The exact behavior depends on `backward-delete-char-untabify-method'.
4933 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4934 Interactively, ARG is the prefix arg (default 1)
4935 and KILLP is t if a prefix arg was specified."
4958 arg)))
4959 ;; Avoid warning about delete-backward-char
4963 "Kill up to and including ARGth occurrence of CHAR.
4964 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4965 Goes backward if ARG is negative; error if CHAR not found."
4968 ;; Avoid "obsolete" warnings for translation-table-for-input.
4976 ;; kill-line and its subroutines.
4979 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4984 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4985 With prefix argument ARG, kill that many lines from point.
4986 Negative arguments kill lines backward.
4987 With zero argument, kills the text before point on the current line.
4990 a number counts as a prefix arg.
4992 To kill a whole line, when point is not at the beginning, type \
4995 If `show-trailing-whitespace' is non-nil, this command will just
4996 kill the rest of the current line, even if there are no nonblanks
4997 there.
4999 If option `kill-whole-line' is non-nil, then this command kills the whole line
5000 including its terminating newline, when used at the beginning of a line
5001 with no argument. As a consequence, you can always kill a whole line
5004 If you want to append the killed line to the last killed text,
5007 If the buffer is read-only, Emacs will beep and refrain from deleting
5008 the line, but put the line in the kill ring anyway. This means that
5009 you can use this command to copy text from a read-only buffer.
5010 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5011 even beep.)"
5014 ;; It is better to move point to the other end of the kill
5015 ;; before killing. That way, in a read-only buffer, point
5016 ;; moves across the text that is copied to the kill ring.
5017 ;; The choice has no effect on undo now that undo records
5018 ;; the value of point from before the command was run.
5028 ;; If trailing whitespace is visible,
5029 ;; don't treat it as nothing.
5039 "Kill current line.
5040 With prefix ARG, kill that many lines starting from the current line.
5041 If ARG is negative, kill backward. Also kill the preceding newline.
5043 If ARG is zero, kill current line but exclude the trailing newline."
5054 ;; We need to kill in two steps, because the previous command
5055 ;; could have been a kill command, in which case the text
5056 ;; before point needs to be prepended to the current kill
5057 ;; ring entry and the text after point appended. Also, we
5058 ;; need to use save-excursion to avoid copying the same text
5059 ;; twice to the kill ring in read-only buffers.
5077 "Move forward by ARG lines, ignoring currently invisible newlines only.
5078 If ARG is negative, move backward -ARG lines.
5079 If ARG is zero, move to the beginning of the current line."
5086 ;; If the newline we just skipped is invisible,
5087 ;; don't count it.
5091 prop
5096 ;; If invisible text follows, and it is a number of complete lines,
5097 ;; skip it.
5103 prop
5119 ;; If the newline we just moved to is invisible,
5120 ;; don't count it.
5125 prop
5130 ;; If invisible text follows, and it is a number of complete lines,
5131 ;; skip it.
5137 prop
5148 nil)))
5151 "Move to end of current visible line."
5153 ;; If the following character is currently invisible,
5154 ;; skip all characters with that same `invisible' property value,
5155 ;; then find the next newline.
5162 prop
5173 "Kill the current buffer.
5174 When called in the minibuffer, get out of the minibuffer
5175 using `abort-recursive-edit'.
5177 This is like `kill-this-buffer', but it doesn't have to be invoked
5178 via the menu bar, and pays no attention to the menu-bar's frame."
5186 \f
5188 "Insert after point the contents of BUFFER.
5189 Puts mark after the inserted text.
5190 BUFFER may be a buffer or a buffer name."
5200 t))))
5205 nil)
5208 "Append to specified buffer the text of the region.
5209 It is inserted into that buffer before its point.
5211 When calling from a program, give three arguments:
5212 BUFFER (or buffer name), START and END.
5213 START and END specify the portion of the current buffer to be copied."
5220 point)
5231 "Prepend to specified buffer the text of the region.
5232 It is inserted into that buffer after its point.
5234 When calling from a program, give three arguments:
5235 BUFFER (or buffer name), START and END.
5236 START and END specify the portion of the current buffer to be copied."
5245 "Copy to specified buffer the text of the region.
5246 It is inserted into that buffer, replacing existing text there.
5248 When calling from a program, give three arguments:
5249 BUFFER (or buffer name), START and END.
5250 START and END specify the portion of the current buffer to be copied."
5258 \f
5262 "Hook run when the mark becomes active.
5263 It is also run at the end of a command, if the mark is active and
5270 "Return this buffer's mark value as integer, or nil if never set.
5272 In Transient Mark mode, this function signals an error if
5273 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5274 or the argument FORCE is non-nil, it disregards whether the mark
5275 is active, and returns an integer or nil in the usual way.
5277 If you are using this in an editing command, you are most likely making
5278 a mistake; see the documentation of `set-mark'."
5283 ;; Behind display-selections-p.
5286 "Deactivate the mark.
5287 If Transient Mark mode is disabled, this function normally does
5288 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5290 Deactivating the mark sets `mark-active' to nil, updates the
5291 primary selection according to `select-active-regions', and runs
5292 `deactivate-mark-hook'.
5294 If Transient Mark mode was temporarily enabled, reset the value
5295 of the variable `transient-mark-mode'; if this causes Transient
5296 Mark mode to be disabled, don't change `mark-active' to nil or
5297 run `deactivate-mark-hook'."
5301 select-active-regions)
5304 ;; The var `saved-region-selection', if non-nil, is the text in
5305 ;; the region prior to the last command modifying the buffer.
5306 ;; Set the selection to that, or to the current region.
5311 ;; If another program has acquired the selection, region
5312 ;; deactivation should not clobber it (Bug#11772).
5331 "Activate the mark.
5332 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5342 "Set this buffer's mark to POS. Don't use this function!
5343 That is to say, don't use this function unless you want
5344 the user to see that the mark has moved, and you want the previous
5345 mark position to be lost.
5347 Normally, when a new mark is set, the old one should go on the stack.
5348 This is why most applications should use `push-mark', not `set-mark'.
5350 Novice Emacs Lisp programmers often try to use the mark for the wrong
5351 purposes. The mark saves a location for the user's convenience.
5352 Most editing commands should not alter the mark.
5353 To remember a location for internal use in the Lisp program,
5354 store it in a Lisp variable. Example:
5356 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5361 ;; Normally we never clear mark-active except in Transient Mark mode.
5362 ;; But when we actually clear out the mark value too, we must
5363 ;; clear mark-active in any mode.
5365 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5366 ;; it should never be nil if the mark is nil.
5374 mark-active))
5381 ;; Mark marker
5387 ;; Mark active
5390 ;; If mark is active now, and either was not active or was at a
5391 ;; different place, run the activate hook.
5396 ;; If mark has ceased to be active, run deactivate hook.
5401 "Like `save-excursion', but also save and restore the mark state.
5402 This macro does what `save-excursion' did before Emacs 25.1."
5412 If nil, region-aware commands treat the empty region as inactive.
5413 If non-nil, region-aware commands treat the region as active as
5414 long as the mark is active, even if the region is empty.
5416 Region-aware commands are those that act on the region if it is
5417 active and Transient Mark mode is enabled, and on the text near
5418 point otherwise."
5424 "Return t if the region is active and it is appropriate to act on it.
5425 This is used by commands that act specially on the region under
5426 Transient Mark mode.
5428 The return value is t if Transient Mark mode is enabled and the
5429 mark is active; furthermore, if `use-empty-active-region' is nil,
5430 the region must not be empty. Otherwise, the return value is nil.
5432 For some commands, it may be appropriate to ignore the value of
5433 `use-empty-active-region'; in that case, use `region-active-p'."
5438 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5440 Some commands act specially on the region when Transient Mark
5441 mode is enabled. Usually, such commands should use
5442 `use-region-p' instead of this function, because `use-region-p'
5443 also checks the value of `use-empty-active-region'."
5445 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5446 ;; without the mark being set (e.g. bug#17324). We really should fix
5447 ;; that problem, but in the mean time, let's make sure we don't say the
5448 ;; region is active when there's no mark.
5452 "Return the boundaries of the region as a list of (START . END) positions."
5456 "Return non-nil if the region contains several pieces.
5457 An example is a rectangular region handled as a list of
5458 separate contiguous regions for each line."
5471 ;; Normal priority so that a large region doesn't hide all the
5472 ;; overlays within it, but high secondary priority so that if it
5473 ;; ends/starts in the middle of a small overlay, that small overlay
5474 ;; won't hide the region's boundaries.
5476 nrol)
5481 rol)))
5497 start end window rol)))
5500 new))))))
5503 "Hook run just before redisplay.
5504 It is called in each window that is to be redisplayed. It takes one argument,
5505 which is the window that will be redisplayed. When run, the `current-buffer'
5526 "Maximum size of mark ring. Start discarding off end if gets this big."
5534 "Maximum size of global mark ring. \
5535 Start discarding off end if gets this big."
5540 "Jump to mark, and pop a new position for mark off the ring.
5541 \(Does not affect global mark ring)."
5551 "Set mark at where point is.
5552 If no prefix ARG and mark is already set there, just activate it.
5553 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5565 will pop the mark twice, and
5567 will pop the mark three times.
5575 "Set the mark where point is, and activate it; or jump to the mark.
5576 Setting the mark also alters the region, which is the text
5577 between point and mark; this is the closest equivalent in
5580 With no prefix argument, set the mark at point, and push the
5581 old mark position on local mark ring. Also push the new mark on
5582 global mark ring, if the previous mark was set in another buffer.
5584 When Transient Mark Mode is off, immediately repeating this
5585 command activates `transient-mark-mode' temporarily.
5588 jump to the mark, and set the mark from
5589 position popped off the local mark ring (this does not affect the global
5591 mark ring (see `pop-global-mark').
5593 If `set-mark-command-repeat-pop' is non-nil, repeating
5595 off the local (or global) mark ring and jumps there.
5598 argument, unconditionally set mark where point is, even if
5599 `set-mark-command-repeat-pop' is non-nil.
5601 Novice Emacs Lisp programmers often try to use the mark for the wrong
5602 purposes. See the documentation of `set-mark' for more information."
5622 arg)
5636 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5637 If the last global mark pushed was not in the current buffer,
5638 also push LOCATION on the global mark ring.
5639 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5641 Novice Emacs Lisp programmers often try to use the mark for the wrong
5642 purposes. See the documentation of `set-mark' for more information.
5644 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5651 ;; Now push the mark on the global mark ring.
5654 ;; The last global mark pushed was in this same buffer.
5655 ;; Don't push another one.
5656 nil
5665 nil)
5668 "Pop off mark ring into the buffer's actual mark.
5669 Does not set point. Does nothing if mark ring is empty."
5681 "Put the mark where point is now, and point where the mark is now.
5682 This command works even when the mark is not active,
5683 and it reactivates the mark.
5685 If Transient Mark mode is on, a prefix ARG deactivates the mark
5686 if it is active, and otherwise avoids reactivating it. If
5687 Transient Mark mode is off, a prefix ARG enables Transient Mark
5688 mode temporarily."
5702 nil))
5705 "When non-nil, shifted motion keys activate the mark momentarily.
5707 While the mark is activated in this way, any shift-translated point
5708 motion key extends the region, and if Transient Mark mode was off, it
5709 is temporarily turned on. Furthermore, the mark will be deactivated
5710 by any subsequent point motion key that was not shift-translated, or
5711 by any action that normally deactivates the mark in Transient Mark mode.
5713 See `this-command-keys-shift-translated' for the meaning of
5714 shift-translation."
5719 "Activate/deactivate mark depending on invocation thru shift translation.
5720 This function is called by `call-interactively' when a command
5721 with a `^' character in its `interactive' spec is invoked, before
5722 running the command itself.
5724 If `shift-select-mode' is enabled and the command was invoked
5725 through shift translation, set the mark and activate the region
5726 temporarily, unless it was already set in this way. See
5727 `this-command-keys-shift-translated' for the meaning of shift
5728 translation.
5730 Otherwise, if the region has been activated temporarily,
5731 deactivate it, and restore the variable `transient-mark-mode' to
5732 its earlier value."
5739 transient-mark-mode)))
5748 "Toggle Transient Mark mode.
5749 With a prefix argument ARG, enable Transient Mark mode if ARG is
5750 positive, and disable it otherwise. If called from Lisp, enable
5751 Transient Mark mode if ARG is omitted or nil.
5753 Transient Mark mode is a global minor mode. When enabled, the
5754 region is highlighted with the `region' face whenever the mark
5756 and after certain other operations that set the mark but whose
5757 main purpose is something else--for example, incremental search,
5763 Many commands change their behavior when Transient Mark mode is
5764 in effect and the mark is active, by acting on the region instead
5765 of their usual default part of the buffer's text. Examples of
5768 To see the documentation of commands which are sensitive to the
5771 :global t
5772 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5776 "Non-nil means it is ok for commands to call `widen' when they want to.
5777 Some commands will do this in order to go to positions outside
5778 the current accessible part of the buffer.
5780 If `widen-automatically' is nil, these commands will do something else
5784 "Whether the currently executing code is performing an essential task.
5785 This variable should be non-nil only when running code which should not
5786 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5787 user for a password when we are simply scanning a set of files in the
5788 background or displaying possible completions before the user even asked
5792 "Pop off global mark ring and jump to the top location."
5794 ;; Pop entries which refer to non-existent buffers.
5812 \f
5814 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5820 "Move cursor vertically down ARG lines.
5821 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5822 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5823 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5824 function will not vscroll.
5826 ARG defaults to 1.
5828 If there is no character in the target line exactly under the current column,
5829 the cursor is positioned after the character in that line which spans this
5830 column, or at the end of the line if it is not long enough.
5831 If there is no line in the buffer after this one, behavior depends on the
5832 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5833 to create a line, and moves the cursor to that line. Otherwise it moves the
5834 cursor to the end of the buffer.
5836 If the variable `line-move-visual' is non-nil, this command moves
5837 by display lines. Otherwise, it moves by buffer lines, without
5838 taking variable-width characters or continued lines into account.
5842 a semipermanent goal column for this command.
5843 Then instead of trying to move exactly vertically (or as close as possible),
5844 this command moves to the specified goal column (or as close as possible).
5845 The goal column is stored in the variable `goal-column', which is nil
5846 when there is no goal column. Note that setting `goal-column'
5847 overrides `line-move-visual' and causes this command to move by buffer
5848 lines rather than by display lines."
5854 ;; When adding a newline, don't expand an abbrev.
5865 nil)
5868 "Move cursor vertically up ARG lines.
5869 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5870 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5871 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5872 function will not vscroll.
5874 ARG defaults to 1.
5876 If there is no character in the target line exactly over the current column,
5877 the cursor is positioned after the character in that line which spans this
5878 column, or at the end of the line if it is not long enough.
5880 If the variable `line-move-visual' is non-nil, this command moves
5881 by display lines. Otherwise, it moves by buffer lines, without
5882 taking variable-width characters or continued lines into account.
5886 a semipermanent goal column for this command.
5887 Then instead of trying to move exactly vertically (or as close as possible),
5888 this command moves to the specified goal column (or as close as possible).
5889 The goal column is stored in the variable `goal-column', which is nil
5890 when there is no goal column. Note that setting `goal-column'
5891 overrides `line-move-visual' and causes this command to move by buffer
5892 lines rather than by display lines."
5903 nil)
5906 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5907 This means moving to the end of each line moved onto.
5908 The beginning of a blank line does not count as the end of a line.
5909 This has no effect when the variable `line-move-visual' is non-nil."
5915 A non-nil setting overrides the variable `line-move-visual', which see."
5922 "Current goal column for vertical motion.
5923 It is the column where point was at the start of the current run
5924 of vertical motion commands.
5926 When moving by visual lines via the function `line-move-visual', it is a cons
5927 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5928 divided by the default column width, and HSCROLL is the number of
5929 columns by which window is scrolled from left margin.
5931 When the `track-eol' feature is doing its job, the value is
5935 "Non-nil means commands that move by lines ignore invisible newlines.
5936 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5937 as if newlines that are invisible didn't exist, and count
5938 only visible newlines. Thus, moving across across 2 newlines
5939 one of which is invisible will be counted as a one-line move.
5940 Also, a non-nil value causes invisible text to be ignored when
5941 counting columns for the purposes of keeping point in the same
5944 Outline mode sets this."
5949 "When non-nil, `line-move' moves point by visual lines.
5950 This movement is based on where the cursor is displayed on the
5951 screen, instead of relying on buffer contents alone. It takes
5952 into account variable-width characters and line continuation.
5953 If nil, `line-move' moves point by logical lines.
5954 A non-nil setting of `goal-column' overrides the value of this variable
5955 and forces movement by logical lines.
5956 A window that is horizontally scrolled also forces movement by logical
5957 lines."
5962 ;; Only used if display-graphic-p.
5966 "Return the height in pixels of the current buffer's default face font.
5968 If the default font is remapped (see `face-remapping-alist'), the
5969 function returns the height of the remapped face."
5973 ;; Avoid calling font-info if the frame's default font was
5974 ;; not changed since the frame was created. That's because
5975 ;; font-info is expensive for some fonts, see bug #14838.
5981 "Return the width in pixels of the current buffer's default face font.
5983 If the default font is remapped (see `face-remapping-alist'), the
5984 function returns the width of the remapped face."
5988 ;; Avoid calling font-info if the frame's default font was
5989 ;; not changed since the frame was created. That's because
5990 ;; font-info is expensive for some fonts, see bug #14838.
5995 width
6000 "Return the pixel height of current buffer's default-face text line.
6002 The value includes `line-spacing', if any, defined for the buffer
6003 or the frame."
6016 "Return the number of screen lines in the text area of the selected window.
6018 This is different from `window-text-height' in that this function counts
6019 lines in units of the height of the font used by the default face displayed
6020 in the window, not in units of the frame's default font, and also accounts
6021 for `line-spacing', if any, defined for the window's buffer or frame.
6023 The value is a floating-point number."
6028 ;; Returns non-nil if partial move was done.
6031 ;; Move backward (up).
6032 ;; If already vscrolled, reduce vscroll
6038 ;; Move forward (down).
6051 py vs last-line)
6071 col-row)
6076 ;; VPOS > 0 means the last line is only partially visible.
6077 ;; But if the part that is visible is at least as tall as the
6078 ;; default font, that means the line is actually fully
6079 ;; readable, and something like line-spacing is hidden. So in
6080 ;; that case we accept the last line in the window as still
6081 ;; visible, and consider the margin as starting one line
6082 ;; later.
6090 ;; If last line of window is fully visible, and vscrolling
6091 ;; more would make this line invisible, move forward.
6096 nil)
6097 ;; If cursor is not in the bottom scroll margin, and the
6098 ;; current line is is not too tall, move forward.
6100 vpos
6103 nil)
6104 ;; When already vscrolled, we vscroll some more if we can,
6105 ;; or clear vscroll and move forward at end of tall image.
6110 ;; If cursor just entered the bottom scroll margin, move forward,
6111 ;; but also optionally vscroll one line so redisplay won't recenter.
6115 ;; Don't vscroll if the partially-visible line at window
6116 ;; bottom is not too tall (a.k.a. "just one more text
6117 ;; line"): in that case, we do want redisplay to behave
6118 ;; normally, i.e. recenter or whatever.
6119 ;;
6120 ;; Note: ROWH + RBOT from the value returned by
6121 ;; pos-visible-in-window-p give the total height of the
6122 ;; partially-visible glyph row at the end of the window. As
6123 ;; we are dealing with floats, we disregard sub-pixel
6124 ;; discrepancies between that and DLH.
6128 t)
6129 ;; If there are lines above the last line, scroll-up one line.
6132 t)
6133 ;; Finally, start vscroll.
6138 ;; This is like line-move-1 except that it also performs
6139 ;; vertical scrolling of tall images if appropriate.
6140 ;; That is not really a clean thing to do, since it mixes
6141 ;; scrolling with cursor motion. But so far we don't have
6142 ;; a cleaner solution to the problem of making C-n do something
6143 ;; useful given a tall image.
6145 "Move forward ARG lines.
6146 If NOERROR, don't signal an error if we can't move ARG lines.
6147 TO-END is unused.
6148 TRY-VSCROLL controls whether to vscroll tall lines: if either
6149 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6150 not vscroll."
6154 ;; Only vscroll for single line moves
6156 ;; Under scroll-conservatively, the display engine
6157 ;; does this better.
6159 ;; But don't vscroll in a keyboard macro.
6165 ;; Display-based column are incompatible with goal-column.
6167 ;; When the text in the window is scrolled to the left,
6168 ;; display-based motion doesn't make sense (because each
6169 ;; logical line occupies exactly one screen line).
6171 ;; Likewise when the text _was_ scrolled to the left
6172 ;; when the current run of vertical motion commands
6173 ;; started.
6176 auto-hscroll-mode
6178 (>= temporary-goal-column
6181 ;; If we moved into a tall line, set vscroll to make
6182 ;; scrolling through tall images more smooth.
6186 winh)
6192 nil
6196 ;; Display-based alternative to line-move-1.
6197 ;; Arg says how many lines to move. The value is t if we can move the
6198 ;; specified number of lines.
6200 "Move ARG lines forward.
6201 If NOERROR, don't signal an error if we can't move that many lines."
6204 target-hscroll)
6205 ;; Check if the previous command was a line-motion command, or if
6206 ;; we were called from some other command.
6209 ;; If so, there's no need to reset `temporary-goal-column',
6210 ;; but we may need to hscroll.
6214 ;; Otherwise, we should reset `temporary-goal-column'.
6216 x-pos)
6218 ;; Handle the `overflow-newline-into-fringe' case:
6223 ;; In R2L lines, the X pixel coordinate is measured from the
6224 ;; left edge of the window, but columns are still counted
6225 ;; from the logical-order beginning of the line, i.e. from
6226 ;; the right edge in this case. We need to adjust for that.
6232 hscroll)))
6234 ;; When we move beyond the first/last character visible in
6235 ;; the window, posn-at-point will return nil, so we need to
6236 ;; approximate the goal column as below.
6241 ;; vertical-motion can move more than it was asked to if it moves
6242 ;; across display strings with newlines. We don't want to ring
6243 ;; the bell and announce beginning/end of buffer in that case.
6249 temporary-goal-column))
6250 arg))
6251 arg))
6257 temporary-goal-column))
6258 arg))
6259 arg)))
6262 ;; If the goal column lies on a display string,
6263 ;; `vertical-motion' advances the cursor to the end
6264 ;; of the string. For arg < 0, this can cause the
6265 ;; cursor to get stuck. (Bug#3020).
6269 nil)))))
6271 ;; This is the guts of next-line and previous-line.
6272 ;; Arg says how many lines to move.
6273 ;; The value is t if we can move the specified number of lines.
6275 ;; Don't run any point-motion hooks, and disregard intangibility,
6276 ;; for intermediate positions.
6288 ;; Don't count beg of empty line as end of line
6289 ;; unless we just did explicit end-of-line.
6291 most-positive-fixnum
6295 line-move-ignore-invisible))
6296 ;; Use just newline characters.
6297 ;; Set ARG to 0 if we move as many lines as requested.
6300 ;; This way of moving forward ARG lines
6301 ;; verifies that we have a newline after the last one.
6302 ;; It doesn't get confused by intangible text.
6311 'beginning-of-buffer
6313 nil)))
6314 ;; Move by arg lines, but ignore invisible ones.
6317 ;; If the following character is currently invisible,
6318 ;; skip all characters with that same `invisible' property value.
6321 ;; Move a line.
6322 ;; We don't use `end-of-line', since we want to escape
6323 ;; from field boundaries occurring exactly at point.
6329 ;; If there's no invisibility here, move over the newline.
6338 ;; We avoid vertical-motion when possible
6339 ;; because that has to fontify.
6341 ;; Otherwise move a more sophisticated way.
6348 ;; The logic of this is the same as the loop above,
6349 ;; it just goes in the other direction.
6351 ;; For completely consistency with the forward-motion
6352 ;; case, we should call beginning-of-line here.
6353 ;; However, if point is inside a field and on a
6354 ;; continued line, the call to (vertical-motion -1)
6355 ;; below won't move us back far enough; then we return
6356 ;; to the same column in line-move-finish, and point
6357 ;; gets stuck -- cyd
6375 ;; if our target is the middle of this line.
6380 ;; This is the value the function returns.
6384 ;; If we did not move down as far as desired, at least go
6385 ;; to end of line. Be sure to call point-entered and
6386 ;; point-left-hooks.
6392 ;; If we did not move up as far as desired,
6393 ;; at least go to beginning of line.
6405 ;; Set REPEAT to t to repeat the whole thing.
6412 ;; Compute the end of the line
6413 ;; ignoring effectively invisible newlines.
6415 ;; Like end-of-line but ignores fields.
6422 ;; Move to the desired column.
6425 ;; Under line-move-visual, goal-column should be
6426 ;; interpreted in units of the frame's canonical character
6427 ;; width, which is exactly what vertical-motion does.
6431 ;; Corner case: suppose we start out in a field boundary in
6432 ;; the middle of a continued line. When we get to
6433 ;; line-move-finish, point is at the start of a new *screen*
6434 ;; line but the same text line; then line-move-to-column would
6435 ;; move us backwards. Test using C-n with point on the "x" in
6436 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6443 ;; Process intangibility within a line.
6444 ;; With inhibit-point-motion-hooks bound to nil, a call to
6445 ;; goto-char moves point past intangible text.
6447 ;; However, inhibit-point-motion-hooks controls both the
6448 ;; intangibility and the point-entered/point-left hooks. The
6449 ;; following hack avoids calling the point-* hooks
6450 ;; unnecessarily. Note that we move *forward* past intangible
6451 ;; text when the initial and final points are the same.
6456 ;; If intangibility moves us to a different (later) place
6457 ;; in the same line, use that as the destination.
6460 ;; If that position is "too late",
6461 ;; try the previous allowable position.
6462 ;; See if it is ok.
6465 ;; If going forward, don't accept the previous
6466 ;; allowable position if it is before the target line.
6468 ;; If going backward, don't accept the previous
6469 ;; allowable position if it is still after the target line.
6472 ;; As a last resort, use the end of the line.
6475 ;; Now move to the updated destination, processing fields
6476 ;; as well as intangibility.
6480 ;; Ignore field boundaries if the initial and final
6481 ;; positions have the same `field' property, even if the
6482 ;; fields are non-contiguous. This seems to be "nicer"
6483 ;; behavior in many situations.
6486 new
6490 ;; If all this moved us to a different line,
6491 ;; retry everything within that new line.
6493 ;; Repeat the intangibility and field processing.
6497 "Try to find column COL, considering invisibility.
6498 This function works only in certain cases,
6499 because what we really need is for `move-to-column'
6500 and `current-column' to be able to ignore invisible text."
6509 ;; If the following character is currently invisible,
6510 ;; skip all characters with that same `invisible' property value.
6514 ;; Have we advanced to a larger column position?
6516 ;; We have made some progress towards the desired column.
6517 ;; See if we can make any further progress.
6519 ;; Otherwise, go to the place we originally found
6520 ;; and move back over invisible text.
6521 ;; that will get us to the same place on the screen
6522 ;; but with a more reasonable buffer position.
6525 ;; We want the real line beginning, so it's consistent
6526 ;; with bolp below, otherwise we might infloop.
6533 "Move point to end of current line as displayed.
6534 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6535 If point reaches the beginning or end of buffer, it stops there.
6537 To ignore the effects of the `intangible' text or overlay
6538 property, bind `inhibit-point-motion-hooks' to t.
6539 If there is an image in the current line, this function
6540 disregards newlines that are part of the text on which the image
6541 rests."
6551 ;; With bidi reordering, we may not be at bol,
6552 ;; so make sure we are.
6567 ;; If we skipped something intangible and now we're not
6568 ;; really at eol, keep going.
6573 "Move point to beginning of current line as displayed.
6574 \(If there's an image in the line, this disregards newlines
6575 which are part of the text that the image rests on.)
6577 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6578 If point reaches the beginning or end of buffer, it stops there.
6579 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6584 first-vis first-vis-field-value)
6586 ;; Move by lines, if ARG is not 1 (the default).
6591 ;; Move to beginning-of-line, ignoring fields and invisible text.
6597 ;; Now find first visible char in the line.
6602 ;; See if fields would stop us from reaching FIRST-VIS.
6607 ;; If yes, obey them.
6608 first-vis-field-value
6609 ;; Otherwise, move to START with attention to fields.
6610 ;; (It is possible that fields never matter in this case.)
6615 ;; Many people have said they rarely use this feature, and often type
6616 ;; it by accident. Maybe it shouldn't even be on a key.
6621 Those commands will move to this position in the line moved to
6622 rather than trying to keep the same horizontal position.
6623 With a non-nil argument ARG, clears out the goal column
6625 The goal column is stored in the variable `goal-column'.
6626 This is a buffer-local setting."
6633 ;; The older method below can be erroneous if `set-goal-column' is bound
6634 ;; to a sequence containing %
6635 ;;(message (substitute-command-keys
6636 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6637 ;;goal-column)
6644 )
6645 nil)
6646 \f
6647 ;;; Editing based on visual lines, as opposed to logical lines.
6650 "Move point to end of current visual line.
6651 With argument N not nil or 1, move forward N - 1 visual lines first.
6652 If point reaches the beginning or end of buffer, it stops there.
6653 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6659 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6660 ;; constrain to field boundaries, so we don't either.
6664 "Move point to beginning of current visual line.
6665 With argument N not nil or 1, move forward N - 1 visual lines first.
6666 If point reaches the beginning or end of buffer, it stops there.
6667 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6675 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6679 "Kill the rest of the visual line.
6680 With prefix argument ARG, kill that many visual lines from point.
6681 If ARG is negative, kill visual lines backward.
6682 If ARG is zero, kill the text before point on the current visual
6683 line.
6685 If you want to append the killed line to the last killed text,
6688 If the buffer is read-only, Emacs will beep and refrain from deleting
6689 the line, but put the line in the kill ring anyway. This means that
6690 you can use this command to copy text from a read-only buffer.
6691 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6692 even beep.)"
6694 ;; Like in `kill-line', it's better to move point to the other end
6695 ;; of the kill before killing.
6703 ;; Skip any trailing whitespace at the end of the visual line.
6704 ;; We used to do this only if `show-trailing-whitespace' is
6705 ;; nil, but that's wrong; the correct thing would be to check
6706 ;; whether the trailing whitespace is highlighted. But, it's
6707 ;; OK to just do this unconditionally.
6714 "Move cursor vertically down ARG lines.
6715 This is identical to `next-line', except that it always moves
6716 by logical lines instead of visual lines, ignoring the value of
6717 the variable `line-move-visual'."
6724 "Move cursor vertically up ARG lines.
6725 This is identical to `previous-line', except that it always moves
6726 by logical lines instead of visual lines, ignoring the value of
6727 the variable `line-move-visual'."
6734 "Editing based on visual lines."
6743 ;; These keybindings interfere with xterm function keys. Are
6744 ;; there any other suitable bindings?
6745 ;; (define-key map "\M-[" 'previous-logical-line)
6746 ;; (define-key map "\M-]" 'next-logical-line)
6747 map))
6750 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6751 The value should be a list of the form (LEFT RIGHT), where LEFT
6752 and RIGHT are symbols representing the bitmaps to display, to
6753 indicate wrapped lines, in the left and right fringes respectively.
6754 See also `fringe-indicator-alist'.
6755 The default is not to display fringe indicators for wrapped lines.
6756 This variable does not affect fringe indicators displayed for
6757 other purposes."
6772 'continuation
6779 "Toggle visual line based editing (Visual Line mode).
6780 With a prefix argument ARG, enable Visual Line mode if ARG is
6781 positive, and disable it otherwise. If called from Lisp, enable
6782 the mode if ARG is omitted or nil.
6784 When Visual Line mode is enabled, `word-wrap' is turned on in
6785 this buffer, and simple editing commands are redefined to act on
6786 visual lines, not logical lines. See Info node `Visual Line
6787 Mode' for details."
6788 :keymap visual-line-mode-map
6794 ;; Save the local values of some variables, to be restored if
6795 ;; visual-line-mode is turned off.
6797 truncate-partial-width-windows
6798 word-wrap fringe-indicator-alist))
6801 visual-line--saved-state)))
6805 word-wrap t
6806 fringe-indicator-alist
6808 fringe-indicator-alist)))
6822 visual-line-mode turn-on-visual-line-mode)
6824 \f
6826 "Interchange characters around point, moving forward one character.
6827 With prefix arg ARG, effect is to take character before point
6828 and drag it forward past ARG other characters (backward if ARG negative).
6829 If no argument and at end of line, the previous two chars are exchanged."
6837 "Interchange words around point, leaving point at end of them.
6838 With prefix arg ARG, effect is to take word before or around point
6839 and drag it forward past ARG other words (backward if ARG negative).
6840 If ARG is zero, the words around or after point and around or after mark
6841 are interchanged."
6842 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6848 Unlike `transpose-words', point must be between the two sexps and not
6849 in the middle of a sexp to be transposed.
6850 With non-zero prefix arg ARG, effect is to take the sexp before point
6851 and drag it forward past ARG other sexps (backward if ARG is negative).
6852 If ARG is zero, the sexps ending at or after point and at or after mark
6853 are interchanged."
6857 ;; Here we should try to simulate the behavior of
6858 ;; (cons (progn (forward-sexp x) (point))
6859 ;; (progn (forward-sexp (- x)) (point)))
6860 ;; Except that we don't want to rely on the second forward-sexp
6861 ;; putting us back to where we want to be, since forward-sexp-function
6862 ;; might do funny things like infix-precedence.
6867 ;; Jumping over a symbol. We might be inside it, mind you.
6872 ;; Otherwise, we're between sexps. Take a step back before jumping
6873 ;; to make sure we'll obey the same precedence no matter which direction
6874 ;; we're going.
6879 'skip-syntax-forward
6886 "Exchange current line and previous line, leaving point after both.
6887 With argument ARG, takes previous line and moves it past ARG lines.
6888 With argument 0, interchanges line point is in with line mark is in."
6894 ;; Move forward over ARG lines,
6895 ;; but create newlines if necessary.
6902 arg))
6904 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6905 ;; which seems inconsistent with the ARG /= 0 case.
6906 ;; FIXME document SPECIAL.
6908 "Subroutine to do the work of transposing objects.
6909 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6910 moves forward by units of the given object (e.g. forward-sentence,
6911 forward-paragraph). If ARG is zero, exchanges the current object
6912 with the one containing mark. If ARG is an integer, moves the
6913 current object past ARG following (if ARG is positive) or
6914 preceding (if ARG is negative) objects, leaving point after the
6915 current object."
6920 pos1 pos2)
6949 ;; This sequence of insertions attempts to preserve marker
6950 ;; positions at the start and end of the transposed objects.
6964 \f
6966 "Move backward until encountering the beginning of a word.
6967 With argument ARG, do this that many times.
6968 If ARG is omitted or nil, move point backward one word.
6970 The word boundaries are normally determined by the buffer's syntax
6971 table, but `find-word-boundary-function-table', such as set up
6972 by `subword-mode', can change that. If a Lisp program needs to
6973 move by words determined strictly by the syntax table, it should
6974 use `backward-word-strictly' instead."
6979 "Set mark ARG words away from point.
6981 move to with the same argument.
6982 Interactively, if this command is repeated
6983 or (in Transient Mark mode) if the mark is active,
6984 it marks the next ARG words after the ones already marked."
7001 nil t))))
7004 "Kill characters forward until encountering the end of a word.
7005 With argument ARG, do this that many times."
7010 "Kill characters backward until encountering the beginning of a word.
7011 With argument ARG, do this that many times."
7016 "Return the word at or near point, as a string.
7017 The return value includes no text properties.
7019 If optional arg STRICT is non-nil, return nil unless point is
7020 within or adjacent to a word, otherwise look for a word within
7021 point's line. If there is no word anywhere on point's line, the
7022 value is nil regardless of STRICT.
7024 By default, this function treats as a single word any sequence of
7025 characters that have either word or symbol syntax. If optional
7026 arg REALLY-WORD is non-nil, only characters of word syntax can
7027 constitute a word."
7036 ;; Point is neither within nor adjacent to a word.
7038 ;; Look for preceding word in same line.
7041 ;; No preceding word in same line.
7042 ;; Look for following word in same line.
7051 ;; If we found something nonempty, return it as a string.
7054 \f
7056 "String for filling to insert at front of new line, or nil for none."
7058 string)
7064 "Regexp to match lines which should not be auto-filled."
7066 regexp)
7070 "The default value for `normal-auto-fill-function'.
7071 This is the default auto-fill function, some major modes use a different one.
7072 Returns t if it really did any work."
7082 nil ;; Auto-filling not required
7086 ;; Choose a fill-prefix automatically.
7094 ;; Use auto-indentation rather than a guessed empty prefix.
7100 ;; Determine where to split the line.
7113 ;; See whether the place we found is any good.
7117 ;; There is no use breaking at end of line.
7119 ;; It is futile to split at the end of the prefix
7120 ;; since we would just insert the prefix again.
7122 ;; Don't split right after a comment starter
7123 ;; since we would just make another comment starter.
7128 limit t)
7130 ;; No good place to break => stop trying.
7132 ;; Ok, we have a useful place to break the line. Do it.
7134 ;; If point is at the fill-point, do not `save-excursion'.
7135 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7136 ;; point will end up before it rather than after it.
7144 ;; Now do justification, if required
7149 ;; If making the new line didn't reduce the hpos of
7150 ;; the end of the line, then give up now;
7151 ;; trying again will not help.
7154 ;; Justify last line.
7156 t)))
7159 "Mode-specific function which line breaks and continues a comment.
7160 This function is called during auto-filling when a comment syntax
7161 is defined.
7162 The function should take a single optional argument, which is a flag
7166 "Break line at point and indent.
7167 If a comment syntax is defined, call `comment-indent-new-line'.
7169 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7170 unless optional argument SOFT is non-nil."
7174 ;; Insert the newline before removing empty space so that markers
7175 ;; get preserved better.
7181 ;; Blindly trust a non-adaptive fill-prefix.
7187 ;; If there's an adaptive prefix, use it unless we're inside
7188 ;; a comment and the prefix is not a comment starter.
7192 ;; If we're not inside a comment, just try to indent.
7196 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7200 ;; `functions' and `hooks' are usually unsafe to set, but setting
7201 ;; auto-fill-function to nil in a file-local setting is safe and
7202 ;; can be useful to prevent auto-filling.
7206 "Toggle automatic line breaking (Auto Fill mode).
7207 With a prefix argument ARG, enable Auto Fill mode if ARG is
7208 positive, and disable it otherwise. If called from Lisp, enable
7209 the mode if ARG is omitted or nil.
7211 When Auto Fill mode is enabled, inserting a space at a column
7212 beyond `current-fill-column' automatically breaks the line at a
7213 previous space.
7215 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7216 non-nil.
7218 The value of `normal-auto-fill-function' specifies the function to use
7219 for `auto-fill-function' when turning Auto Fill mode on."
7224 ;; This holds a document string used to document auto-fill-mode.
7226 "Automatically break line at a previous space, in insertion of text."
7227 nil)
7230 "Unconditionally turn on Auto Fill mode."
7234 "Unconditionally turn off Auto Fill mode."
7240 "Set `fill-column' to specified argument.
7245 ;; We used to use current-column silently, but C-x f is too easily
7246 ;; typed as a typo for C-x C-f, so we turned it into an error and
7247 ;; now an interactive prompt.
7252 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7256 \f
7258 "Set `selective-display' to ARG; clear it if no arg.
7259 When the value of `selective-display' is a number > 0,
7260 lines whose indentation is >= that value are not displayed.
7261 The variable `selective-display' has a separate value for each buffer."
7281 "Toggle truncating of long lines for the current buffer.
7282 When truncating is off, long lines are folded.
7283 With prefix argument ARG, truncate long lines if ARG is positive,
7284 otherwise fold them. Note that in side-by-side windows, this
7285 command has no effect if `truncate-partial-width-windows' is
7286 non-nil."
7298 nil t)))
7303 "Toggle whether to use word-wrapping for continuation lines.
7304 With prefix argument ARG, wrap continuation lines at word boundaries
7305 if ARG is positive, otherwise wrap them at the right screen edge.
7306 This command toggles the value of `word-wrap'. It has no effect
7307 if long lines are truncated."
7323 "Toggle Overwrite mode.
7324 With a prefix argument ARG, enable Overwrite mode if ARG is
7325 positive, and disable it otherwise. If called from Lisp, enable
7326 the mode if ARG is omitted or nil.
7328 When Overwrite mode is enabled, printing characters typed in
7329 replace existing text on a one-for-one basis, rather than pushing
7330 it to the right. At the end of a line, such characters extend
7331 the line. Before a tab, such characters insert until the tab is
7333 overwrite mode; this is supposed to make it easier to insert
7334 characters when necessary."
7339 "Toggle Binary Overwrite mode.
7340 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7341 is positive, and disable it otherwise. If called from Lisp,
7342 enable the mode if ARG is omitted or nil.
7344 When Binary Overwrite mode is enabled, printing characters typed
7345 in replace existing text. Newlines are not treated specially, so
7346 typing at the end of a line joins the line to the next, with the
7347 typed character between them. Typing before a tab character
7348 simply replaces the tab with the character typed.
7350 ordinary typing characters do.
7352 Note that Binary Overwrite mode is not its own minor mode; it is
7353 a specialization of overwrite mode, entered by setting the
7354 `overwrite-mode' variable to `overwrite-mode-binary'."
7359 "Toggle line number display in the mode line (Line Number mode).
7360 With a prefix argument ARG, enable Line Number mode if ARG is
7361 positive, and disable it otherwise. If called from Lisp, enable
7362 the mode if ARG is omitted or nil.
7364 Line numbers do not appear for very large buffers and buffers
7365 with very long lines; see variables `line-number-display-limit'
7366 and `line-number-display-limit-width'."
7370 "Toggle column number display in the mode line (Column Number mode).
7371 With a prefix argument ARG, enable Column Number mode if ARG is
7372 positive, and disable it otherwise.
7374 If called from Lisp, enable the mode if ARG is omitted or nil."
7378 "Toggle buffer size display in the mode line (Size Indication mode).
7379 With a prefix argument ARG, enable Size Indication mode if ARG is
7380 positive, and disable it otherwise.
7382 If called from Lisp, enable the mode if ARG is omitted or nil."
7386 "Toggle auto-saving in the current buffer (Auto Save mode).
7387 With a prefix argument ARG, enable Auto Save mode if ARG is
7388 positive, and disable it otherwise.
7390 If called from Lisp, enable the mode if ARG is omitted or nil."
7392 ;; If auto-save is off because buffer has shrunk,
7393 ;; then toggling should turn it on.
7401 buffer-file-name)
7403 ;; If -1 was stored here, to temporarily turn off saving,
7404 ;; turn it back on.
7407 \f
7409 "Blinking matching of parens and expressions."
7414 "Non-nil means show matching open-paren when close-paren is inserted.
7415 If t, highlight the paren. If `jump', briefly move cursor to its
7416 position. If `jump-offscreen', move cursor there even if the
7417 position is off screen. With any other non-nil value, the
7418 off-screen position of the opening paren will be shown in the
7419 echo area."
7428 "Non-nil means show matching open-paren when it is on screen.
7429 If nil, don't show it (but the open-paren can still be shown
7430 in the echo area when it is off screen).
7432 This variable has no effect if `blink-matching-paren' is nil.
7433 \(In that case, the open-paren is never shown.)
7434 It is also ignored if `show-paren-mode' is enabled."
7439 "If non-nil, maximum distance to search backwards for matching open-paren.
7440 If nil, search stops at the beginning of the accessible portion of the buffer."
7446 "Time in seconds to delay after showing a matching paren."
7451 "If nil, `blink-matching-paren' ignores comments.
7452 More precisely, when looking for the matching parenthesis,
7453 it skips the contents of comments that end before point."
7458 "Return whether or not START...END are matching parens.
7459 END is the current point and START is the blink position.
7460 START might be nil if no matching starter was found.
7461 Returns non-nil if we find there is a mismatch."
7466 ;; For self-matched chars like " and $, we can't know when they're
7467 ;; mismatched or unmatched, so we can only do it for parens.
7472 ;; The cdr might hold a new paren-class info rather than
7473 ;; a matching-char info, in which case the two CDRs
7474 ;; should match.
7478 "Function to check parentheses mismatches.
7479 The function takes two arguments (START and END) where START is the
7480 position just before the opening token and END is the position right after.
7481 START can be nil, if it was not found.
7488 ol)
7492 "Momentarily highlight the beginning of the sexp before point."
7495 blink-matching-paren)
7505 oldpos))
7513 ;; backward-sexp skips backward over prefix chars,
7514 ;; so move back to the matching paren.
7537 ;; Matching open within window, temporarily move to or highlight
7538 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7539 ;; is non-nil.
7556 ;; Show what precedes the open in its line, if anything.
7561 ;; Show what follows the open in its line, if anything.
7568 ;; Otherwise show the previous nonblank line,
7569 ;; if there is one.
7578 ;; Replace the newline and other whitespace with `...'.
7579 "..."
7581 ;; There is nothing to show except the char itself.
7584 "Matches %s"
7588 "Function called, if non-nil, whenever a close parenthesis is inserted.
7594 blink-paren-function
7597 ;; Verify an even number of quoting characters precede the close.
7598 ;; FIXME: Also check if this parenthesis closes a comment as
7599 ;; can happen in Pascal and SML.
7610 ;; Most likely, this hook is nil, so this arg doesn't matter,
7611 ;; but I use it as a reminder that this function usually
7612 ;; likes to be run after others since it does
7613 ;; `sit-for'. That's also the reason it get a `priority' prop
7614 ;; of 100.
7616 \f
7617 ;; This executes C-g typed while Emacs is waiting for a command.
7618 ;; Quitting out of a program does not go through here;
7619 ;; that happens in the maybe_quit function at the C code level.
7621 "Signal a `quit' condition.
7622 During execution of Lisp code, this character causes a quit directly.
7623 At top-level, as an editor command, this simply beeps."
7625 ;; Avoid adding the region to the window selection.
7633 ;; Force the next redisplay cycle to remove the "Def" indicator from
7634 ;; all the mode lines.
7648 This command can exit an interactive command such as `query-replace',
7649 can clear out a prefix argument or a region,
7650 can get out of the minibuffer or other recursive edit,
7651 cancel the use of the current buffer (for special-purpose buffers),
7652 or go back to just one window (by deleting all but the selected window)."
7660 nil)
7671 "Play sound stored in FILE.
7672 VOLUME and DEVICE correspond to the keywords of the sound
7673 specification for `play-sound'."
7683 \f
7685 "Your preference for a mail reading package.
7686 This is used by some keybindings which support reading mail.
7687 See also `mail-user-agent' concerning sending mail."
7697 "Your preference for a mail composition package.
7698 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7699 outgoing email message. This variable lets you specify which
7700 mail-sending package you prefer.
7702 Valid values include:
7704 `message-user-agent' -- use the Message package.
7705 See Info node `(message)'.
7706 `sendmail-user-agent' -- use the Mail package.
7707 See Info node `(emacs)Sending Mail'.
7708 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7709 See Info node `(mh-e)'.
7710 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7711 paraphernalia if Gnus is running, particularly
7712 the Gcc: header for archiving.
7714 Additional valid symbols may be available; check with the author of
7715 your package for details. The function should return non-nil if it
7716 succeeds.
7718 See also `read-mail-command' concerning reading mail."
7721 message-user-agent)
7724 sendmail-user-agent)
7727 mh-e-user-agent)
7730 gnus-user-agent)
7736 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7737 If the value of `mail-user-agent' is the default, and the user
7738 appears to have customizations applying to the old default,
7739 `compose-mail' issues a warning."
7745 "If the buffer starts with a mail header, move point to the header's end.
7746 Otherwise, moves to `point-min'.
7747 The end of the header is the start of the next line, if there is one,
7748 else the end of the last line. This function obeys RFC822."
7754 ;; Used by Rmail (e.g., rmail-forward).
7756 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7760 switch-function yank-action send-actions
7761 return-action)
7762 "Start composing a mail message to send.
7763 This uses the user's chosen mail composition package
7764 as selected with the variable `mail-user-agent'.
7765 The optional arguments TO and SUBJECT specify recipients
7766 and the initial Subject field, respectively.
7768 OTHER-HEADERS is an alist specifying additional
7769 header fields. Elements look like (HEADER . VALUE) where both
7770 HEADER and VALUE are strings.
7772 CONTINUE, if non-nil, says to continue editing a message already
7773 being composed. Interactively, CONTINUE is the prefix argument.
7775 SWITCH-FUNCTION, if non-nil, is a function to use to
7776 switch to and display the buffer used for mail composition.
7778 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7779 to insert the raw text of the message being replied to.
7780 It has the form (FUNCTION . ARGS). The user agent will apply
7781 FUNCTION to ARGS, to insert the raw text of the original message.
7782 \(The user agent will also run `mail-citation-hook', *after* the
7783 original text has been inserted in this way.)
7785 SEND-ACTIONS is a list of actions to call when the message is sent.
7786 Each action has the form (FUNCTION . ARGS).
7788 RETURN-ACTION, if non-nil, is an action for returning to the
7789 caller. It has the form (FUNCTION . ARGS). The function is
7790 called after the mail has been sent or put aside, and the mail
7791 buffer buried."
7795 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7796 ;; from sendmail-user-agent to message-user-agent. Some users may
7797 ;; encounter incompatibilities. This hack tries to detect problems
7798 ;; and warn about them.
7803 mail-yank-hooks mail-archive-file-name
7804 mail-default-reply-to mail-mailing-lists
7805 mail-self-blind))
7812 The default mail mode is now Message mode.
7813 You have the following Mail mode variable%s customized:
7815 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7822 yank-action send-actions return-action)))
7825 yank-action send-actions
7826 return-action)
7830 'switch-to-buffer-other-window yank-action send-actions
7831 return-action))
7834 yank-action send-actions
7835 return-action)
7839 'switch-to-buffer-other-frame yank-action send-actions
7840 return-action))
7842 \f
7844 "History of values entered with `set-variable'.
7846 Maximum length of the history list is determined by the value
7850 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7851 VARIABLE should be a user option variable name, a Lisp variable
7852 meant to be customized by users. You should enter VALUE in Lisp syntax,
7853 so if you want VALUE to be a string, you must surround it with doublequotes.
7854 VALUE is used literally, not evaluated.
7856 If VARIABLE has a `variable-interactive' property, that is used as if
7857 it were the arg to `interactive' (which see) to interactively read VALUE.
7859 If VARIABLE has been defined with `defcustom', then the type information
7860 in the definition is used to check that VALUE is valid.
7862 Note that this function is at heart equivalent to the basic `set' function.
7863 For a variable defined with `defcustom', it does not pay attention to
7864 any :set property that the variable might have (if you want that, use
7867 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7872 default-var)
7888 var obsolete)
7891 ;; Use VAR's `variable-interactive' property
7892 ;; as an interactive spec for prompting.
7895 arg))
7897 read-expression-map t
7898 'set-variable-value-history
7907 ;; Match with custom type.
7919 ;; Force a thorough redisplay for the case that the variable
7920 ;; has an effect on the display, like `tab-width' has.
7922 \f
7923 ;; Define the major mode for lists of completions.
7933 (define-key map [right] 'next-completion)
7935 (define-key map [backtab] 'previous-completion)
7936 (define-key map "q" 'quit-window)
7937 (define-key map "z" 'kill-current-buffer)
7938 map)
7939 "Local map for completion list buffers.")
7941 ;; Completion mode is suitable only for specially formatted data.
7942 (put 'completion-list-mode 'mode-class 'special)
7944 (defvar completion-reference-buffer nil
7945 "Record the buffer that was current when the completion list was requested.
7946 This is a local variable in the completion list buffer.
7947 Initial value is nil to avoid some compiler warnings.")
7949 (defvar completion-no-auto-exit nil
7950 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7951 This also applies to other functions such as `choose-completion'.")
7953 (defvar completion-base-position nil
7954 "Position of the base of the text corresponding to the shown completions.
7955 This variable is used in the *Completions* buffers.
7956 Its value is a list of the form (START END) where START is the place
7957 where the completion should be inserted and END (if non-nil) is the end
7958 of the text to replace. If END is nil, point is used instead.")
7960 (defvar completion-list-insert-choice-function #'completion--replace
7961 "Function to use to insert the text chosen in *Completions*.
7962 Called with three arguments (BEG END TEXT), it should replace the text
7963 between BEG and END with TEXT. Expected to be set buffer-locally
7964 in the *Completions* buffer.")
7966 (defvar completion-base-size nil
7967 "Number of chars before point not involved in completion.
7968 This is a local variable in the completion list buffer.
7969 It refers to the chars in the minibuffer if completing in the
7970 minibuffer, or in `completion-reference-buffer' otherwise.
7971 Only characters in the field at point are included.
7973 If nil, Emacs determines which part of the tail end of the
7974 buffer's text is involved in completion by comparing the text
7975 directly.")
7976 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7978 (defun delete-completion-window ()
7979 "Delete the completion list window.
7980 Go to the window from which completion was requested."
7981 (interactive)
7982 (let ((buf completion-reference-buffer))
7983 (if (one-window-p t)
7984 (if (window-dedicated-p) (delete-frame))
7985 (delete-window (selected-window))
7986 (if (get-buffer-window buf)
7987 (select-window (get-buffer-window buf))))))
7989 (defun previous-completion (n)
7990 "Move to the previous item in the completion list."
7991 (interactive "p")
7992 (next-completion (- n)))
7994 (defun next-completion (n)
7995 "Move to the next item in the completion list.
7996 With prefix argument N, move N items (negative N means move backward)."
7997 (interactive "p")
7998 (let ((beg (point-min)) (end (point-max)))
7999 (while (and (> n 0) (not (eobp)))
8000 ;; If in a completion, move to the end of it.
8001 (when (get-text-property (point) 'mouse-face)
8002 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8003 ;; Move to start of next one.
8004 (unless (get-text-property (point) 'mouse-face)
8005 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
8006 (setq n (1- n)))
8007 (while (and (< n 0) (not (bobp)))
8008 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
8009 ;; If in a completion, move to the start of it.
8010 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
8011 (goto-char (previous-single-property-change
8012 (point) 'mouse-face nil beg)))
8013 ;; Move to end of the previous completion.
8014 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
8015 (goto-char (previous-single-property-change
8016 (point) 'mouse-face nil beg)))
8017 ;; Move to the start of that one.
8018 (goto-char (previous-single-property-change
8019 (point) 'mouse-face nil beg))
8020 (setq n (1+ n))))))
8022 (defun choose-completion (&optional event)
8023 "Choose the completion at point.
8024 If EVENT, use EVENT's position to determine the starting position."
8025 (interactive (list last-nonmenu-event))
8026 ;; In case this is run via the mouse, give temporary modes such as
8027 ;; isearch a chance to turn off.
8028 (run-hooks 'mouse-leave-buffer-hook)
8029 (with-current-buffer (window-buffer (posn-window (event-start event)))
8030 (let ((buffer completion-reference-buffer)
8031 (base-size completion-base-size)
8032 (base-position completion-base-position)
8033 (insert-function completion-list-insert-choice-function)
8034 (choice
8035 (save-excursion
8036 (goto-char (posn-point (event-start event)))
8037 (let (beg end)
8038 (cond
8039 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
8040 (setq end (point) beg (1+ (point))))
8041 ((and (not (bobp))
8042 (get-text-property (1- (point)) 'mouse-face))
8043 (setq end (1- (point)) beg (point)))
8044 (t (error "No completion here")))
8045 (setq beg (previous-single-property-change beg 'mouse-face))
8046 (setq end (or (next-single-property-change end 'mouse-face)
8047 (point-max)))
8048 (buffer-substring-no-properties beg end)))))
8050 (unless (buffer-live-p buffer)
8051 (error "Destination buffer is dead"))
8052 (quit-window nil (posn-window (event-start event)))
8054 (with-current-buffer buffer
8055 (choose-completion-string
8056 choice buffer
8057 (or base-position
8058 (when base-size
8059 ;; Someone's using old completion code that doesn't know
8060 ;; about base-position yet.
8061 (list (+ base-size (field-beginning))))
8062 ;; If all else fails, just guess.
8063 (list (choose-completion-guess-base-position choice)))
8064 insert-function)))))
8066 ;; Delete the longest partial match for STRING
8067 ;; that can be found before POINT.
8068 (defun choose-completion-guess-base-position (string)
8069 (save-excursion
8070 (let ((opoint (point))
8071 len)
8072 ;; Try moving back by the length of the string.
8073 (goto-char (max (- (point) (length string))
8074 (minibuffer-prompt-end)))
8075 ;; See how far back we were actually able to move. That is the
8076 ;; upper bound on how much we can match and delete.
8077 (setq len (- opoint (point)))
8078 (if completion-ignore-case
8079 (setq string (downcase string)))
8080 (while (and (> len 0)
8081 (let ((tail (buffer-substring (point) opoint)))
8082 (if completion-ignore-case
8083 (setq tail (downcase tail)))
8084 (not (string= tail (substring string 0 len)))))
8085 (setq len (1- len))
8086 (forward-char 1))
8087 (point))))
8089 (defun choose-completion-delete-max-match (string)
8090 (declare (obsolete choose-completion-guess-base-position "23.2"))
8091 (delete-region (choose-completion-guess-base-position string) (point)))
8093 (defvar choose-completion-string-functions nil
8094 "Functions that may override the normal insertion of a completion choice.
8095 These functions are called in order with three arguments:
8096 CHOICE - the string to insert in the buffer,
8097 BUFFER - the buffer in which the choice should be inserted,
8098 BASE-POSITION - where to insert the completion.
8100 If a function in the list returns non-nil, that function is supposed
8101 to have inserted the CHOICE in the BUFFER, and possibly exited
8102 the minibuffer; no further functions will be called.
8104 If all functions in the list return nil, that means to use
8105 the default method of inserting the completion in BUFFER.")
8107 (defun choose-completion-string (choice &optional
8108 buffer base-position insert-function)
8109 "Switch to BUFFER and insert the completion choice CHOICE.
8110 BASE-POSITION says where to insert the completion.
8111 INSERT-FUNCTION says how to insert the completion and falls
8112 back on `completion-list-insert-choice-function' when nil."
8114 ;; If BUFFER is the minibuffer, exit the minibuffer
8115 ;; unless it is reading a file name and CHOICE is a directory,
8116 ;; or completion-no-auto-exit is non-nil.
8118 ;; Some older code may call us passing `base-size' instead of
8119 ;; `base-position'. It's difficult to make any use of `base-size',
8120 ;; so we just ignore it.
8121 (unless (consp base-position)
8122 (message "Obsolete `base-size' passed to choose-completion-string")
8123 (setq base-position nil))
8125 (let* ((buffer (or buffer completion-reference-buffer))
8126 (mini-p (minibufferp buffer)))
8127 ;; If BUFFER is a minibuffer, barf unless it's the currently
8128 ;; active minibuffer.
8129 (if (and mini-p
8130 (not (and (active-minibuffer-window)
8131 (equal buffer
8132 (window-buffer (active-minibuffer-window))))))
8133 (error "Minibuffer is not active for completion")
8134 ;; Set buffer so buffer-local choose-completion-string-functions works.
8135 (set-buffer buffer)
8136 (unless (run-hook-with-args-until-success
8137 'choose-completion-string-functions
8138 ;; The fourth arg used to be `mini-p' but was useless
8139 ;; (since minibufferp can be used on the `buffer' arg)
8140 ;; and indeed unused. The last used to be `base-size', so we
8141 ;; keep it to try and avoid breaking old code.
8142 choice buffer base-position nil)
8143 ;; This remove-text-properties should be unnecessary since `choice'
8144 ;; comes from buffer-substring-no-properties.
8145 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8146 ;; Insert the completion into the buffer where it was requested.
8147 (funcall (or insert-function completion-list-insert-choice-function)
8148 (or (car base-position) (point))
8149 (or (cadr base-position) (point))
8150 choice)
8151 ;; Update point in the window that BUFFER is showing in.
8152 (let ((window (get-buffer-window buffer t)))
8153 (set-window-point window (point)))
8154 ;; If completing for the minibuffer, exit it with this choice.
8155 (and (not completion-no-auto-exit)
8156 (minibufferp buffer)
8157 minibuffer-completion-table
8158 ;; If this is reading a file name, and the file name chosen
8159 ;; is a directory, don't exit the minibuffer.
8160 (let* ((result (buffer-substring (field-beginning) (point)))
8161 (bounds
8162 (completion-boundaries result minibuffer-completion-table
8163 minibuffer-completion-predicate
8164 "")))
8165 (if (eq (car bounds) (length result))
8166 ;; The completion chosen leads to a new set of completions
8167 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8168 (let ((mini (active-minibuffer-window)))
8169 (select-window mini)
8170 (when minibuffer-auto-raise
8171 (raise-frame (window-frame mini))))
8172 (exit-minibuffer))))))))
8174 (define-derived-mode completion-list-mode nil "Completion List"
8175 "Major mode for buffers showing lists of possible completions.
8177 to select the completion near point.
8178 Or click to select one with the mouse.
8181 (set (make-local-variable 'completion-base-size) nil))
8183 (defun completion-list-mode-finish ()
8184 "Finish setup of the completions buffer.
8185 Called from `temp-buffer-show-hook'."
8186 (when (eq major-mode 'completion-list-mode)
8187 (setq buffer-read-only t)))
8189 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8192 ;; Variables and faces used in `completion-setup-function'.
8194 (defcustom completion-show-help t
8195 "Non-nil means show help message in *Completions* buffer."
8196 :type 'boolean
8197 :version "22.1"
8198 :group 'completion)
8200 ;; This function goes in completion-setup-hook, so that it is called
8201 ;; after the text of the completion list buffer is written.
8202 (defun completion-setup-function ()
8203 (let* ((mainbuf (current-buffer))
8204 (base-dir
8205 ;; FIXME: This is a bad hack. We try to set the default-directory
8206 ;; in the *Completions* buffer so that the relative file names
8207 ;; displayed there can be treated as valid file names, independently
8208 ;; from the completion context. But this suffers from many problems:
8209 ;; - It's not clear when the completions are file names. With some
8210 ;; completion tables (e.g. bzr revision specs), the listed
8211 ;; completions can mix file names and other things.
8212 ;; - It doesn't pay attention to possible quoting.
8213 ;; - With fancy completion styles, the code below will not always
8214 ;; find the right base directory.
8215 (if minibuffer-completing-file-name
8216 (file-name-as-directory
8217 (expand-file-name
8218 (buffer-substring (minibuffer-prompt-end)
8219 (- (point) (or completion-base-size 0))))))))
8220 (with-current-buffer standard-output
8221 (let ((base-size completion-base-size) ;Read before killing localvars.
8222 (base-position completion-base-position)
8223 (insert-fun completion-list-insert-choice-function))
8224 (completion-list-mode)
8225 (set (make-local-variable 'completion-base-size) base-size)
8226 (set (make-local-variable 'completion-base-position) base-position)
8227 (set (make-local-variable 'completion-list-insert-choice-function)
8228 insert-fun))
8229 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8230 (if base-dir (setq default-directory base-dir))
8231 ;; Maybe insert help string.
8232 (when completion-show-help
8233 (goto-char (point-min))
8234 (if (display-mouse-p)
8236 (insert (substitute-command-keys
8240 (add-hook 'completion-setup-hook 'completion-setup-function)
8242 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8243 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8245 (defun switch-to-completions ()
8246 "Select the completion list window."
8247 (interactive)
8248 (let ((window (or (get-buffer-window "*Completions*" 0)
8249 ;; Make sure we have a completions window.
8250 (progn (minibuffer-completion-help)
8251 (get-buffer-window "*Completions*" 0)))))
8252 (when window
8253 (select-window window)
8254 ;; In the new buffer, go to the first completion.
8255 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8256 (when (bobp)
8257 (next-completion 1)))))
8258 \f
8259 ;;; Support keyboard commands to turn on various modifiers.
8261 ;; These functions -- which are not commands -- each add one modifier
8262 ;; to the following event.
8264 (defun event-apply-alt-modifier (_ignore-prompt)
8267 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8268 (defun event-apply-super-modifier (_ignore-prompt)
8271 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8272 (defun event-apply-hyper-modifier (_ignore-prompt)
8275 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8276 (defun event-apply-shift-modifier (_ignore-prompt)
8279 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8280 (defun event-apply-control-modifier (_ignore-prompt)
8283 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8284 (defun event-apply-meta-modifier (_ignore-prompt)
8287 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8289 (defun event-apply-modifier (event symbol lshiftby prefix)
8290 "Apply a modifier flag to event EVENT.
8291 SYMBOL is the name of this modifier, as a symbol.
8292 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8293 PREFIX is the string that represents this modifier in an event type symbol."
8294 (if (numberp event)
8295 (cond ((eq symbol 'control)
8296 (if (and (<= (downcase event) ?z)
8297 (>= (downcase event) ?a))
8298 (- (downcase event) ?a -1)
8299 (if (and (<= (downcase event) ?Z)
8300 (>= (downcase event) ?A))
8301 (- (downcase event) ?A -1)
8302 (logior (lsh 1 lshiftby) event))))
8303 ((eq symbol 'shift)
8304 (if (and (<= (downcase event) ?z)
8305 (>= (downcase event) ?a))
8306 (upcase event)
8307 (logior (lsh 1 lshiftby) event)))
8308 (t
8309 (logior (lsh 1 lshiftby) event)))
8310 (if (memq symbol (event-modifiers event))
8311 event
8312 (let ((event-type (if (symbolp event) event (car event))))
8313 (setq event-type (intern (concat prefix (symbol-name event-type))))
8314 (if (symbolp event)
8315 event-type
8316 (cons event-type (cdr event)))))))
8318 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8319 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8320 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8321 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8322 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8323 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8324 \f
8325 ;;;; Keypad support.
8327 ;; Make the keypad keys act like ordinary typing keys. If people add
8328 ;; bindings for the function key symbols, then those bindings will
8329 ;; override these, so this shouldn't interfere with any existing
8330 ;; bindings.
8332 ;; Also tell read-char how to handle these keys.
8333 (mapc
8334 (lambda (keypad-normal)
8335 (let ((keypad (nth 0 keypad-normal))
8336 (normal (nth 1 keypad-normal)))
8337 (put keypad 'ascii-character normal)
8338 (define-key function-key-map (vector keypad) (vector normal))))
8339 ;; See also kp-keys bound in bindings.el.
8340 '((kp-space ?\s)
8343 (kp-separator ?,)
8344 (kp-equal ?=)
8345 ;; Do the same for various keys that are represented as symbols under
8346 ;; GUIs but naturally correspond to characters.
8347 (backspace 127)
8348 (delete 127)
8351 (clear ?\C-l)
8352 (return ?\C-m)
8353 (escape ?\e)
8354 ))
8355 \f
8356 ;;;;
8357 ;;;; forking a twin copy of a buffer.
8358 ;;;;
8360 (defvar clone-buffer-hook nil
8361 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8363 (defvar clone-indirect-buffer-hook nil
8364 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8366 (defun clone-process (process &optional newname)
8367 "Create a twin copy of PROCESS.
8368 If NEWNAME is nil, it defaults to PROCESS' name;
8369 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8370 If PROCESS is associated with a buffer, the new process will be associated
8371 with the current buffer instead.
8372 Returns nil if PROCESS has already terminated."
8373 (setq newname (or newname (process-name process)))
8375 (setq newname (substring newname 0 (match-beginning 0))))
8376 (when (memq (process-status process) '(run stop open))
8377 (let* ((process-connection-type (process-tty-name process))
8378 (new-process
8379 (if (memq (process-status process) '(open))
8380 (let ((args (process-contact process t)))
8381 (setq args (plist-put args :name newname))
8382 (setq args (plist-put args :buffer
8383 (if (process-buffer process)
8384 (current-buffer))))
8385 (apply 'make-network-process args))
8386 (apply 'start-process newname
8387 (if (process-buffer process) (current-buffer))
8388 (process-command process)))))
8389 (set-process-query-on-exit-flag
8390 new-process (process-query-on-exit-flag process))
8391 (set-process-inherit-coding-system-flag
8392 new-process (process-inherit-coding-system-flag process))
8393 (set-process-filter new-process (process-filter process))
8394 (set-process-sentinel new-process (process-sentinel process))
8395 (set-process-plist new-process (copy-sequence (process-plist process)))
8396 new-process)))
8398 ;; things to maybe add (currently partly covered by `funcall mode'):
8399 ;; - syntax-table
8400 ;; - overlays
8401 (defun clone-buffer (&optional newname display-flag)
8402 "Create and return a twin copy of the current buffer.
8403 Unlike an indirect buffer, the new buffer can be edited
8404 independently of the old one (if it is not read-only).
8405 NEWNAME is the name of the new buffer. It may be modified by
8406 adding or incrementing <N> at the end as necessary to create a
8407 unique buffer name. If nil, it defaults to the name of the
8408 current buffer, with the proper suffix. If DISPLAY-FLAG is
8409 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8410 clone a file-visiting buffer, or a buffer whose major mode symbol
8411 has a non-nil `no-clone' property, results in an error.
8413 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8414 current buffer with appropriate suffix. However, if a prefix
8415 argument is given, then the command prompts for NEWNAME in the
8416 minibuffer.
8418 This runs the normal hook `clone-buffer-hook' in the new buffer
8419 after it has been set up properly in other respects."
8420 (interactive
8421 (progn
8422 (if buffer-file-name
8423 (error "Cannot clone a file-visiting buffer"))
8424 (if (get major-mode 'no-clone)
8425 (error "Cannot clone a buffer in %s mode" mode-name))
8426 (list (if current-prefix-arg
8427 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8428 t)))
8429 (if buffer-file-name
8430 (error "Cannot clone a file-visiting buffer"))
8431 (if (get major-mode 'no-clone)
8432 (error "Cannot clone a buffer in %s mode" mode-name))
8433 (setq newname (or newname (buffer-name)))
8435 (setq newname (substring newname 0 (match-beginning 0))))
8436 (let ((buf (current-buffer))
8437 (ptmin (point-min))
8438 (ptmax (point-max))
8439 (pt (point))
8440 (mk (if mark-active (mark t)))
8441 (modified (buffer-modified-p))
8442 (mode major-mode)
8443 (lvars (buffer-local-variables))
8444 (process (get-buffer-process (current-buffer)))
8445 (new (generate-new-buffer (or newname (buffer-name)))))
8446 (save-restriction
8447 (widen)
8448 (with-current-buffer new
8449 (insert-buffer-substring buf)))
8450 (with-current-buffer new
8451 (narrow-to-region ptmin ptmax)
8452 (goto-char pt)
8453 (if mk (set-mark mk))
8454 (set-buffer-modified-p modified)
8456 ;; Clone the old buffer's process, if any.
8457 (when process (clone-process process))
8459 ;; Now set up the major mode.
8460 (funcall mode)
8462 ;; Set up other local variables.
8463 (mapc (lambda (v)
8464 (condition-case () ;in case var is read-only
8465 (if (symbolp v)
8466 (makunbound v)
8467 (set (make-local-variable (car v)) (cdr v)))
8468 (error nil)))
8469 lvars)
8471 ;; Run any hooks (typically set up by the major mode
8472 ;; for cloning to work properly).
8473 (run-hooks 'clone-buffer-hook))
8474 (if display-flag
8475 ;; Presumably the current buffer is shown in the selected frame, so
8476 ;; we want to display the clone elsewhere.
8477 (let ((same-window-regexps nil)
8478 (same-window-buffer-names))
8479 (pop-to-buffer new)))
8480 new))
8483 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8484 "Create an indirect buffer that is a twin copy of the current buffer.
8486 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8487 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8488 or if not called with a prefix arg, NEWNAME defaults to the current
8489 buffer's name. The name is modified by adding a `<N>' suffix to it
8490 or by incrementing the N in an existing suffix. Trying to clone a
8491 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8492 property results in an error.
8494 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8495 This is always done when called interactively.
8497 Optional third arg NORECORD non-nil means do not put this buffer at the
8498 front of the list of recently selected ones.
8500 Returns the newly created indirect buffer."
8501 (interactive
8502 (progn
8503 (if (get major-mode 'no-clone-indirect)
8504 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8505 (list (if current-prefix-arg
8506 (read-buffer "Name of indirect buffer: " (current-buffer)))
8507 t)))
8508 (if (get major-mode 'no-clone-indirect)
8509 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8510 (setq newname (or newname (buffer-name)))
8512 (setq newname (substring newname 0 (match-beginning 0))))
8513 (let* ((name (generate-new-buffer-name newname))
8514 (buffer (make-indirect-buffer (current-buffer) name t)))
8515 (with-current-buffer buffer
8516 (run-hooks 'clone-indirect-buffer-hook))
8517 (when display-flag
8518 (pop-to-buffer buffer nil norecord))
8519 buffer))
8522 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8523 "Like `clone-indirect-buffer' but display in another window."
8524 (interactive
8525 (progn
8526 (if (get major-mode 'no-clone-indirect)
8527 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8528 (list (if current-prefix-arg
8529 (read-buffer "Name of indirect buffer: " (current-buffer)))
8530 t)))
8531 (let ((pop-up-windows t))
8532 (clone-indirect-buffer newname display-flag norecord)))
8534 \f
8535 ;;; Handling of Backspace and Delete keys.
8537 (defcustom normal-erase-is-backspace 'maybe
8538 "Set the default behavior of the Delete and Backspace keys.
8540 If set to t, Delete key deletes forward and Backspace key deletes
8541 backward.
8543 If set to nil, both Delete and Backspace keys delete backward.
8545 If set to `maybe' (which is the default), Emacs automatically
8546 selects a behavior. On window systems, the behavior depends on
8547 the keyboard used. If the keyboard has both a Backspace key and
8548 a Delete key, and both are mapped to their usual meanings, the
8549 option's default value is set to t, so that Backspace can be used
8550 to delete backward, and Delete can be used to delete forward.
8552 If not running under a window system, customizing this option
8553 accomplishes a similar effect by mapping C-h, which is usually
8554 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8555 via `keyboard-translate'. The former functionality of C-h is
8556 available on the F1 key. You should probably not use this
8557 setting if you don't have both Backspace, Delete and F1 keys.
8559 Setting this variable with setq doesn't take effect. Programmatically,
8560 call `normal-erase-is-backspace-mode' (which see) instead."
8561 :type '(choice (const :tag "Off" nil)
8562 (const :tag "Maybe" maybe)
8563 (other :tag "On" t))
8564 :group 'editing-basics
8565 :version "21.1"
8566 :set (lambda (symbol value)
8567 ;; The fboundp is because of a problem with :set when
8568 ;; dumping Emacs. It doesn't really matter.
8569 (if (fboundp 'normal-erase-is-backspace-mode)
8570 (normal-erase-is-backspace-mode (or value 0))
8571 (set-default symbol value))))
8573 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8574 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8575 (unless frame (setq frame (selected-frame)))
8576 (with-selected-frame frame
8577 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8578 (normal-erase-is-backspace-mode
8579 (if (if (eq normal-erase-is-backspace 'maybe)
8580 (and (not noninteractive)
8581 (or (memq system-type '(ms-dos windows-nt))
8582 (memq window-system '(w32 ns))
8583 (and (memq window-system '(x))
8584 (fboundp 'x-backspace-delete-keys-p)
8585 (x-backspace-delete-keys-p))
8586 ;; If the terminal Emacs is running on has erase char
8587 ;; set to ^H, use the Backspace key for deleting
8588 ;; backward, and the Delete key for deleting forward.
8589 (and (null window-system)
8590 (eq tty-erase-char ?\^H))))
8591 normal-erase-is-backspace)
8592 1 0)))))
8594 (define-minor-mode normal-erase-is-backspace-mode
8595 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8596 With a prefix argument ARG, enable this feature if ARG is
8597 positive, and disable it otherwise. If called from Lisp, enable
8598 the mode if ARG is omitted or nil.
8600 On window systems, when this mode is on, Delete is mapped to C-d
8601 and Backspace is mapped to DEL; when this mode is off, both
8602 Delete and Backspace are mapped to DEL. (The remapping goes via
8603 `local-function-key-map', so binding Delete or Backspace in the
8604 global or local keymap will override that.)
8606 In addition, on window systems, the bindings of C-Delete, M-Delete,
8607 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8608 the global keymap in accordance with the functionality of Delete and
8609 Backspace. For example, if Delete is remapped to C-d, which deletes
8610 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8611 to DEL, which deletes backward, C-Delete is bound to
8612 `backward-kill-word'.
8614 If not running on a window system, a similar effect is accomplished by
8615 remapping C-h (normally produced by the Backspace key) and DEL via
8616 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8617 to C-d; if it's off, the keys are not remapped.
8619 When not running on a window system, and this mode is turned on, the
8620 former functionality of C-h is available on the F1 key. You should
8621 probably not turn on this mode on a text-only terminal if you don't
8622 have both Backspace, Delete and F1 keys.
8624 See also `normal-erase-is-backspace'."
8625 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8626 . (lambda (v)
8627 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8628 (if v 1 0))))
8629 (let ((enabled (eq 1 (terminal-parameter
8630 nil 'normal-erase-is-backspace))))
8632 (cond ((or (memq window-system '(x w32 ns pc))
8633 (memq system-type '(ms-dos windows-nt)))
8634 (let ((bindings
8635 `(([M-delete] [M-backspace])
8636 ([C-M-delete] [C-M-backspace])
8637 ([?\e C-delete] [?\e C-backspace]))))
8639 (if enabled
8640 (progn
8641 (define-key local-function-key-map [delete] [deletechar])
8642 (define-key local-function-key-map [kp-delete] [deletechar])
8643 (define-key local-function-key-map [backspace] [?\C-?])
8644 (dolist (b bindings)
8645 ;; Not sure if input-decode-map is really right, but
8646 ;; keyboard-translate-table (used below) only works
8647 ;; for integer events, and key-translation-table is
8648 ;; global (like the global-map, used earlier).
8649 (define-key input-decode-map (car b) nil)
8650 (define-key input-decode-map (cadr b) nil)))
8651 (define-key local-function-key-map [delete] [?\C-?])
8652 (define-key local-function-key-map [kp-delete] [?\C-?])
8653 (define-key local-function-key-map [backspace] [?\C-?])
8654 (dolist (b bindings)
8655 (define-key input-decode-map (car b) (cadr b))
8656 (define-key input-decode-map (cadr b) (car b))))))
8657 (t
8658 (if enabled
8659 (progn
8660 (keyboard-translate ?\C-h ?\C-?)
8661 (keyboard-translate ?\C-? ?\C-d))
8662 (keyboard-translate ?\C-h ?\C-h)
8663 (keyboard-translate ?\C-? ?\C-?))))
8665 (if (called-interactively-p 'interactive)
8666 (message "Delete key deletes %s"
8667 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8668 "forward" "backward")))))
8669 \f
8670 (defvar vis-mode-saved-buffer-invisibility-spec nil
8671 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8673 (define-minor-mode read-only-mode
8674 "Change whether the current buffer is read-only.
8675 With prefix argument ARG, make the buffer read-only if ARG is
8676 positive, otherwise make it writable. If buffer is read-only
8677 and `view-read-only' is non-nil, enter view mode.
8679 Do not call this from a Lisp program unless you really intend to
8681 possibly enabling or disabling View mode. Also, note that this
8682 command works by setting the variable `buffer-read-only', which
8683 does not affect read-only regions caused by text properties. To
8684 ignore read-only status in a Lisp program (whether due to text
8685 properties or buffer state), bind `inhibit-read-only' temporarily
8686 to a non-nil value."
8687 :variable buffer-read-only
8688 (cond
8689 ((and (not buffer-read-only) view-mode)
8690 (View-exit-and-edit)
8691 (make-local-variable 'view-read-only)
8692 (setq view-read-only t)) ; Must leave view mode.
8693 ((and buffer-read-only view-read-only
8694 ;; If view-mode is already active, `view-mode-enter' is a nop.
8695 (not view-mode)
8696 (not (eq (get major-mode 'mode-class) 'special)))
8697 (view-mode-enter))))
8699 (define-minor-mode visible-mode
8700 "Toggle making all invisible text temporarily visible (Visible mode).
8701 With a prefix argument ARG, enable Visible mode if ARG is
8702 positive, and disable it otherwise. If called from Lisp, enable
8703 the mode if ARG is omitted or nil.
8705 This mode works by saving the value of `buffer-invisibility-spec'
8706 and setting it to nil."
8707 :lighter " Vis"
8708 :group 'editing-basics
8709 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8710 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8711 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8712 (when visible-mode
8713 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8714 buffer-invisibility-spec)
8715 (setq buffer-invisibility-spec nil)))
8716 \f
8717 (defvar messages-buffer-mode-map
8718 (let ((map (make-sparse-keymap)))
8719 (set-keymap-parent map special-mode-map)
8720 (define-key map "g" nil) ; nothing to revert
8721 map))
8723 (define-derived-mode messages-buffer-mode special-mode "Messages"
8726 (defun messages-buffer ()
8728 If it does not exist, create and it switch it to `messages-buffer-mode'."
8729 (or (get-buffer "*Messages*")
8730 (with-current-buffer (get-buffer-create "*Messages*")
8731 (messages-buffer-mode)
8732 (current-buffer))))
8734 \f
8735 ;; Minibuffer prompt stuff.
8737 ;;(defun minibuffer-prompt-modification (start end)
8738 ;; (error "You cannot modify the prompt"))
8739 ;;
8740 ;;
8741 ;;(defun minibuffer-prompt-insertion (start end)
8742 ;; (let ((inhibit-modification-hooks t))
8743 ;; (delete-region start end)
8744 ;; ;; Discard undo information for the text insertion itself
8745 ;; ;; and for the text deletion.above.
8746 ;; (when (consp buffer-undo-list)
8747 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8748 ;; (message "You cannot modify the prompt")))
8749 ;;
8750 ;;
8751 ;;(setq minibuffer-prompt-properties
8752 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8753 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8755 \f
8756 ;;;; Problematic external packages.
8758 ;; rms says this should be done by specifying symbols that define
8759 ;; versions together with bad values. This is therefore not as
8760 ;; flexible as it could be. See the thread:
8761 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8762 (defconst bad-packages-alist
8763 ;; Not sure exactly which semantic versions have problems.
8764 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8766 "The version of `semantic' loaded does not work in Emacs 22.
8767 It can cause constant high CPU load.
8768 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8769 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8770 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8771 ;; provided the `CUA-mode' feature. Since this is no longer true,
8772 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8773 (CUA-mode t nil
8774 "CUA-mode is now part of the standard GNU Emacs distribution,
8775 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8777 You have loaded an older version of CUA-mode which does not work
8778 correctly with this version of Emacs. You should remove the old
8779 version and use the one distributed with Emacs."))
8780 "Alist of packages known to cause problems in this version of Emacs.
8781 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8782 PACKAGE is either a regular expression to match file names, or a
8783 symbol (a feature name), like for `with-eval-after-load'.
8784 SYMBOL is either the name of a string variable, or t. Upon
8785 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8786 warning using STRING as the message.")
8788 (defun bad-package-check (package)
8789 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8790 (condition-case nil
8791 (let* ((list (assoc package bad-packages-alist))
8792 (symbol (nth 1 list)))
8793 (and list
8794 (boundp symbol)
8795 (or (eq symbol t)
8796 (and (stringp (setq symbol (eval symbol)))
8797 (string-match-p (nth 2 list) symbol)))
8798 (display-warning package (nth 3 list) :warning)))
8799 (error nil)))
8801 (dolist (elem bad-packages-alist)
8802 (let ((pkg (car elem)))
8803 (with-eval-after-load pkg
8804 (bad-package-check pkg))))
8806 \f
8807 ;;; Generic dispatcher commands
8809 ;; Macro `define-alternatives' is used to create generic commands.
8810 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8811 ;; that can have different alternative implementations where choosing
8812 ;; among them is exclusively a matter of user preference.
8814 ;; (define-alternatives COMMAND) creates a new interactive command
8815 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8816 ;; Typically, the user will not need to customize this variable; packages
8817 ;; wanting to add alternative implementations should use
8818 ;;
8819 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8821 (defmacro define-alternatives (command &rest customizations)
8822 "Define the new command `COMMAND'.
8824 The argument `COMMAND' should be a symbol.
8826 Running `M-x COMMAND RET' for the first time prompts for which
8827 alternative to use and records the selected command as a custom
8828 variable.
8830 Running `C-u M-x COMMAND RET' prompts again for an alternative
8831 and overwrites the previous choice.
8833 The variable `COMMAND-alternatives' contains an alist with
8834 alternative implementations of COMMAND. `define-alternatives'
8835 does not have any effect until this variable is set.
8837 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8838 `defcustom' keywords and values to add to the declaration of
8839 `COMMAND-alternatives' (typically :group and :version)."
8840 (let* ((command-name (symbol-name command))
8841 (varalt-name (concat command-name "-alternatives"))
8842 (varalt-sym (intern varalt-name))
8843 (varimp-sym (intern (concat command-name "--implementation"))))
8844 `(progn
8846 (defcustom ,varalt-sym nil
8847 ,(format "Alist of alternative implementations for the `%s' command.
8849 Each entry must be a pair (ALTNAME . ALTFUN), where:
8850 ALTNAME - The name shown at user to describe the alternative implementation.
8851 ALTFUN - The function called to implement this alternative."
8852 command-name)
8853 :type '(alist :key-type string :value-type function)
8854 ,@customizations)
8856 (put ',varalt-sym 'definition-name ',command)
8857 (defvar ,varimp-sym nil "Internal use only.")
8859 (defun ,command (&optional arg)
8860 ,(format "Run generic command `%s'.
8861 If used for the first time, or with interactive ARG, ask the user which
8862 implementation to use for `%s'. The variable `%s'
8863 contains the list of implementations currently supported for this command."
8864 command-name command-name varalt-name)
8865 (interactive "P")
8866 (when (or arg (null ,varimp-sym))
8867 (let ((val (completing-read
8868 ,(format-message
8869 "Select implementation for command `%s': "
8870 command-name)
8871 ,varalt-sym nil t)))
8872 (unless (string-equal val "")
8873 (when (null ,varimp-sym)
8874 (message
8875 "Use C-u M-x %s RET`to select another implementation"
8876 ,command-name)
8877 (sit-for 3))
8878 (customize-save-variable ',varimp-sym
8879 (cdr (assoc-string val ,varalt-sym))))))
8880 (if ,varimp-sym
8881 (call-interactively ,varimp-sym)
8882 (message "%s" ,(format-message
8883 "No implementation selected for command `%s'"
8884 command-name)))))))
8886 \f
8887 ;;; Functions for changing capitalization that Do What I Mean
8888 (defun upcase-dwim (arg)
8889 "Upcase words in the region, if active; if not, upcase word at point.
8890 If the region is active, this function calls `upcase-region'.
8891 Otherwise, it calls `upcase-word', with prefix argument passed to it
8892 to upcase ARG words."
8893 (interactive "*p")
8894 (if (use-region-p)
8895 (upcase-region (region-beginning) (region-end))
8896 (upcase-word arg)))
8898 (defun downcase-dwim (arg)
8899 "Downcase words in the region, if active; if not, downcase word at point.
8900 If the region is active, this function calls `downcase-region'.
8901 Otherwise, it calls `downcase-word', with prefix argument passed to it
8902 to downcase ARG words."
8903 (interactive "*p")
8904 (if (use-region-p)
8905 (downcase-region (region-beginning) (region-end))
8906 (downcase-word arg)))
8908 (defun capitalize-dwim (arg)
8909 "Capitalize words in the region, if active; if not, capitalize word at point.
8910 If the region is active, this function calls `capitalize-region'.
8911 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8912 to capitalize ARG words."
8913 (interactive "*p")
8914 (if (use-region-p)
8915 (capitalize-region (region-beginning) (region-end))
8916 (capitalize-word arg)))
8918 \f
8920 (provide 'simple)
8922 ;;; simple.el ends here