| blob | 70bd759edab69ff295effa3bd0c897711e331475 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2016 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "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 "Delete trailing whitespace between START and END.
607 If called interactively, START and END are the start/end of the
608 region if the mark is active, or of the buffer's accessible
609 portion if the mark is inactive.
611 This command deletes whitespace characters after the last
612 non-whitespace character in each line between START and END. It
613 does not consider formfeed characters to be whitespace.
615 If this command acts on the entire buffer (i.e. if called
616 interactively with the mark inactive, or called from Lisp with
617 END nil), it also deletes all trailing lines at the end of the
618 buffer if the variable `delete-trailing-lines' is non-nil."
629 ;; Don't delete formfeeds, even if they are considered whitespace.
631 ;; Treating \n as non-whitespace makes things easier.
637 ;; Delete trailing empty lines.
639 ;; Really the end of buffer.
643 ;; Return nil for the benefit of `write-file-functions'.
644 nil)
647 "Insert a newline, then indent according to major mode.
648 Indentation is done using the value of `indent-line-function'.
649 In programming language modes, this is the same as TAB.
650 In some text modes, where TAB inserts a tab, this command indents to the
651 column specified by the function `current-left-margin'."
658 "Reindent current line, insert newline, then indent the new line.
659 Indentation of both lines is done according to the current major mode,
660 which means calling the current value of `indent-line-function'.
661 In programming language modes, this is the same as TAB.
662 In some text modes, where TAB inserts a tab, this indents to the
663 column specified by the function `current-left-margin'."
666 ;; Be careful to insert the newline before indenting the line.
667 ;; Otherwise, the indentation might be wrong.
671 ;; We are at EOL before the call to indent-according-to-mode, and
672 ;; after it we usually are as well, but not always. We tried to
673 ;; address it with `save-excursion' but that uses a normal marker
674 ;; whereas we need `move after insertion', so we do the save/restore
675 ;; by hand.
679 ;; Remove the trailing white-space after indentation because
680 ;; indentation may introduce the whitespace.
686 Legitimate radix values are 8, 10 and 16."
691 "Like `read-char', but do not allow quitting.
692 Also, if the first character read is an octal digit,
693 we read any number of octal digits and return the
694 specified character code. Any nondigit terminates the sequence.
695 If the terminator is RET, it is discarded;
696 any other terminator is used itself as input.
698 The optional argument PROMPT specifies a string to use to prompt the user.
699 The variable `read-quoted-char-radix' controls which radix to use
700 for numeric input."
703 help-event-list)))
707 ;; Don't let C-h or other help chars get the help
708 ;; message--only help function keys. See bug#16617.
712 "Type the special character you want to use,
713 or the octal character code.
714 RET terminates the character code and is discarded;
724 unread-command-events)
725 done t))
727 ;; Turn a meta-character into a character with the 0200 bit set.
729 done t))
745 unread-command-events)
746 done t))
748 done t)))
750 code))
753 "Read next input character and insert it.
754 This is useful for inserting control characters.
755 With argument, insert ARG copies of the character.
757 If the first character you type after this command is an octal digit,
758 you should type a sequence of octal digits which specify a character code.
759 Any nondigit terminates the sequence. If the terminator is a RET,
760 it is discarded; any other terminator is used itself as input.
761 The variable `read-quoted-char-radix' specifies the radix for this feature;
762 set it to 10 or 16 to use decimal or hex instead of octal.
764 In overwrite mode, this function inserts the character anyway, and
765 does not handle octal digits specially. This means that if you use
766 overwrite as your normal editing mode, you can use this function to
767 insert characters when necessary.
769 In binary overwrite mode, this function does overwrite, and octal
770 digits are interpreted as a character code. This is intended to be
771 useful for editing binary files."
774 ;; Avoid "obsolete" warnings for translation-table-for-input.
781 ;; This used to assume character codes 0240 - 0377 stand for
782 ;; characters in some single-byte character set, and converted them
783 ;; to Emacs characters. But in 23.1 this feature is deprecated
784 ;; in favor of inserting the corresponding Unicode characters.
785 ;; (if (and enable-multibyte-characters
786 ;; (>= char ?\240)
787 ;; (<= char ?\377))
788 ;; (setq char (unibyte-char-to-multibyte char)))
800 "Move forward ARG lines and position at first nonblank character."
806 "Move backward ARG lines and position at first nonblank character."
812 "Move point to the first non-whitespace character on this line."
816 ;; Move back over chars that have whitespace syntax but have the p flag.
820 "Fixup white space between objects around point.
821 Leave one space or none, according to the context."
828 nil
832 "Delete all spaces and tabs around point.
833 If BACKWARD-ONLY is non-nil, only delete them before point."
838 orig-pos
847 "Delete all spaces and tabs around point, leaving one space (or N spaces).
848 If N is negative, delete newlines as well, leaving -N spaces.
849 See also `cycle-spacing'."
854 "Store context used in consecutive calls to `cycle-spacing' command.
855 The first time `cycle-spacing' runs, it saves in this variable:
856 its N argument, the original point position, and the original spacing
860 "Manipulate whitespace around point in a smart way.
861 In interactive use, this function behaves differently in successive
862 consecutive calls.
864 The first call in a sequence acts like `just-one-space'.
865 It deletes all spaces and tabs around point, leaving one space
866 \(or N spaces). N is the prefix argument. If N is negative,
867 it deletes newlines as well, leaving -N spaces.
868 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
870 The second call in a sequence deletes all spaces.
872 The third call in a sequence restores the original whitespace (and point).
874 If MODE is `single-shot', it only performs the first step in the sequence.
875 If MODE is `fast' and the first step would not result in any change
876 \(i.e., there are exactly (abs N) spaces around point),
877 the function goes straight to the second step.
879 Repeatedly calling the function with different values of N starts a
880 new sequence each time."
888 ;; Command run for the first time, single-shot mode or different argument
900 ;; Special handling for case where there was no space at all.
903 ;; If this run causes no change in buffer content, delete all spaces,
904 ;; otherwise delete all excess spaces.
909 ;; Command run for the second time.
913 ;; Command run for the third time.
918 \f
920 "Move point to the beginning of the buffer.
921 With numeric arg N, put point N/10 of the way from the beginning.
922 If the buffer is narrowed, this command uses the beginning of the
923 accessible part of the buffer.
926 is supplied, or Transient Mark mode is enabled and the mark is active."
936 ;; Avoid overflow for large buffer sizes!
944 "Move point to the end of the buffer.
945 With numeric arg N, put point N/10 of the way from the end.
946 If the buffer is narrowed, this command uses the end of the
947 accessible part of the buffer.
950 is supplied, or Transient Mark mode is enabled and the mark is active."
958 ;; Avoid overflow for large buffer sizes!
963 ;; If we went to a place in the middle of the buffer,
964 ;; adjust it to the beginning of a line.
968 ;; If the end of the buffer is not already on the screen,
969 ;; then scroll specially to put it near, but not at, the bottom.
974 "Whether single-char deletion commands delete an active region.
975 This has an effect only if Transient Mark mode is enabled, and
976 affects `delete-forward-char' and `delete-backward-char', though
977 not `delete-char'.
979 If the value is the symbol `kill', the active region is killed
980 instead of deleted."
997 "Function to get the region's content.
998 Called with one argument DELETE.
999 If DELETE is `delete-only', then only delete the region and the return value
1000 is undefined. If DELETE is nil, just return the content as a string.
1001 If DELETE is `bounds', then don't delete, but just return the
1002 boundaries of the region as a list of (START . END) positions.
1003 If anything else, delete the region and return its content as a string,
1014 first nil))))
1015 "Function to insert the region's content.
1016 Called with one argument LINES.
1020 "Delete the previous N characters (following if N is negative).
1021 If Transient Mark mode is enabled, the mark is active, and N is 1,
1022 delete the text in the region and deactivate the mark instead.
1023 To disable this, set option `delete-active-region' to nil.
1025 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1026 kill ring) instead of delete. Interactively, N is the prefix
1027 arg, and KILLFLAG is set if N is explicitly specified.
1029 When killing, the killed text is filtered by
1030 `filter-buffer-substring' before it is saved in the kill ring, so
1031 the actual saved text might be different from what was killed.
1033 In Overwrite mode, single character backward deletion may replace
1034 tabs with spaces so as to back over columns, unless point is at
1035 the end of the line."
1041 delete-active-region
1043 ;; If a region is active, kill or delete it.
1047 ;; In Overwrite mode, maybe untabify while deleting
1057 ;; Otherwise, do simple deletion.
1061 "Delete the following N characters (previous if N is negative).
1062 If Transient Mark mode is enabled, the mark is active, and N is 1,
1063 delete the text in the region and deactivate the mark instead.
1064 To disable this, set variable `delete-active-region' to nil.
1066 Optional second arg KILLFLAG non-nil means to kill (save in kill
1067 ring) instead of delete. Interactively, N is the prefix arg, and
1068 KILLFLAG is set if N was explicitly specified.
1070 When killing, the killed text is filtered by
1071 `filter-buffer-substring' before it is saved in the kill ring, so
1072 the actual saved text might be different from what was killed."
1078 delete-active-region
1080 ;; If a region is active, kill or delete it.
1085 ;; Otherwise, do simple deletion.
1089 "Put point at beginning and mark at end of buffer.
1090 If narrowing is in effect, only uses the accessible part of the buffer.
1091 You probably should not use this function in Lisp programs;
1092 it is usually a mistake for a Lisp function to use any subroutine
1093 that uses or sets the mark."
1098 ;; This is really `point-min' in most cases, but if we're in the
1099 ;; minibuffer, this is at the end of the prompt.
1101 \f
1103 ;; Counting lines, one way or another.
1106 "Go to LINE, counting from line 1 at beginning of buffer.
1107 If called interactively, a numeric prefix argument specifies
1108 LINE; without a numeric prefix argument, read LINE from the
1109 minibuffer.
1111 If optional argument BUFFER is non-nil, switch to that buffer and
1113 as argument, BUFFER is the most recently selected other buffer.
1115 Prior to moving point, this function sets the mark (without
1116 activating it), unless Transient Mark mode is enabled and the
1117 mark is already active.
1119 This function is usually the wrong thing to use in a Lisp program.
1120 What you probably want instead is something like:
1121 (goto-char (point-min))
1122 (forward-line (1- N))
1123 If at all possible, an even better solution is to use char counts
1124 rather than line counts."
1129 ;; Look for a default, a number in the buffer at point.
1139 ;; Decide if we're switching buffers.
1147 ;; Read the argument, offering that number (if any) as default.
1150 buffer))))
1151 ;; Switch to the desired buffer, one way or another.
1156 ;; Leave mark at previous position
1158 ;; Move to the specified line number in that buffer.
1167 "Count the number of words in the region.
1168 If called interactively, print a message reporting the number of
1169 lines, words, and characters in the region (whether or not the
1170 region is active); with prefix ARG, report for the entire buffer
1171 rather than the region.
1173 If called from Lisp, return the number of words between positions
1174 START and END."
1186 "Count words between START and END.
1187 If called interactively, START and END are normally the start and
1188 end of the buffer; but if the region is active, START and END are
1189 the start and end of the region. Print a message reporting the
1190 number of lines, words, and chars.
1192 If called from Lisp, return the number of words between START and
1193 END, without printing any message."
1203 words))
1219 str
1227 "Print the current buffer line number and narrowed line number of point."
1240 "Return number of lines between START and END.
1241 This is usually the number of newlines between them,
1242 but can be one more if START is not equal to END
1243 and the greater of them is not at the start of a line."
1259 done)))
1263 "Return (narrowed) buffer line number at position POS.
1264 If POS is nil, use current buffer location.
1265 Counting starts at (point-min), so the value refers
1266 to the contents of the accessible portion of the buffer."
1276 "Print info on cursor position (on screen and within buffer).
1277 Also describe the character after point, and give its character code
1278 in octal, decimal and hex.
1280 For a non-ASCII multibyte character, also give its encoding in the
1281 buffer's selected coding system if the coding system encodes the
1282 character safely. If the character is encoded into one byte, that
1283 code is shown in hex. If the character is encoded into more than one
1286 In addition, with prefix argument, show details about that character
1287 in *Help* buffer. See also the command `describe-char'."
1291 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1292 ;; start a directional embedding, which could completely
1293 ;; disrupt the rest of the line (e.g., RLO will display the
1294 ;; rest of the line right-to-left). So we put an invisible
1295 ;; PDF character after these characters, to end the
1296 ;; embedding, which eliminates any effects on the rest of
1297 ;; the line. For RLE and RLO we also append an invisible
1298 ;; LRM, to avoid reordering the following numerical
1299 ;; characters. For LRI/RLI/FSI we append a PDI.
1306 ;; Strong right-to-left characters cause reordering of
1307 ;; the following numerical characters which show the
1308 ;; codepoint, so append LRM to countermand that.
1319 ""
1325 pos total percent beg end col hscroll)
1327 pos total col hscroll))
1329 encoded encoding-msg display-prop under-display)
1336 ;; Check if the character is displayed with some `display'
1337 ;; text property. In that case, set under-display to the
1338 ;; buffer substring covered by that property.
1349 under-display)))
1355 char char char under-display)
1357 char char char under-display display-prop))
1360 char char char
1362 "..."
1366 ;; We show the detailed information about CHAR.
1373 bidi-fixer
1374 encoding-msg pos total percent beg end col hscroll)
1381 bidi-fixer encoding-msg pos total percent col hscroll))))))
1382 \f
1383 ;; Initialize read-expression-map. It is defined at C level.
1387 ;; Might as well bind TAB to completion, since inserting a TAB char is
1388 ;; much too rarely useful.
1391 m))
1394 "Return a Lisp object read using the minibuffer, unevaluated.
1395 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1396 is a string to insert in the minibuffer before reading.
1397 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1398 Such arguments are used as in `read-from-minibuffer'.)"
1399 ;; Used for interactive spec `x'.
1404 "Return value of Lisp expression read using the minibuffer.
1405 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1406 is a string to insert in the minibuffer before reading.
1407 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1408 Such arguments are used as in `read-from-minibuffer'.)"
1409 ;; Used for interactive spec `X'.
1417 "The current default value or list of default values in the minibuffer.
1418 The functions `read-from-minibuffer' and `completing-read' bind
1422 "Value for `print-level' while printing value in `eval-expression'.
1423 A value of nil means no limit."
1429 "Value for `print-length' while printing value in `eval-expression'.
1430 A value of nil means no limit."
1436 "If non-nil set `debug-on-error' to t in `eval-expression'.
1437 If nil, don't change the value of `debug-on-error'."
1443 "If VALUE in an integer, return a specially formatted string.
1445 If VALUE is not an integer, nil is returned.
1446 This function is used by functions like `prin1' that display the
1447 result of expression evaluation."
1466 ;; FIXME: call emacs-lisp-mode?
1473 read-expression-map t
1476 ;; We define this, rather than making `eval' interactive,
1477 ;; for the sake of completion of names like eval-region, eval-buffer.
1479 "Evaluate EXP and print value in the echo area.
1480 When called interactively, read an Emacs Lisp expression and evaluate it.
1481 Value is also consed on to front of the variable `values'.
1482 If the resulting value is an integer, it will be printed in
1483 several additional formats (octal, hexadecimal, and character).
1484 Optional argument INSERT-VALUE non-nil (interactively, with
1485 prefix argument) means insert the result into the current buffer
1486 instead of printing it in the echo area.
1488 Normally, this function truncates long output according to the value
1489 of the variables `eval-expression-print-length' and
1490 `eval-expression-print-level'. With a prefix argument of zero,
1491 however, there is no such truncation.
1493 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1494 minibuffer.
1496 If `eval-expression-debug-on-error' is non-nil, which is the default,
1497 this command arranges for all errors to enter the debugger."
1500 current-prefix-arg))
1505 ;; Bind debug-on-error to something unique so that we can
1506 ;; detect when evalled code changes it.
1510 ;; If evalled code has changed the value of debug-on-error,
1511 ;; propagate that change to the global binding.
1516 eval-expression-print-length))
1518 eval-expression-print-level))
1534 "Prompting with PROMPT, let user edit COMMAND and eval result.
1535 COMMAND is a Lisp expression. Let user edit that expression in
1536 the minibuffer, then read and evaluate the result."
1543 read-expression-map t
1545 ;; If command was added to command-history as a string,
1546 ;; get rid of that. We want only evaluable expressions there.
1550 ;; If command to be redone does not match front of history,
1551 ;; add it to the history.
1557 "Edit and re-evaluate last complex command, or ARGth from last.
1558 A complex command is one which used the minibuffer.
1559 The command is placed in the minibuffer as a Lisp form for editing.
1560 The result is executed, repeating the command as changed.
1561 If the command has been changed or is not the most recent previous
1562 command it is added to the front of the command history.
1563 You can use the minibuffer history commands \
1565 to get different commands to edit and resubmit."
1568 newcmd)
1580 ;; If command was added to command-history as a
1581 ;; string, get rid of that. We want only
1582 ;; evaluable expressions there.
1586 ;; If command to be redone does not match front of history,
1587 ;; add it to the history.
1602 "Read command name to invoke in `execute-extended-command'."
1612 ;; Get a command name at point in the original buffer
1613 ;; to propose it after M-n.
1617 ;; Read a string, completing from and restricting to the set of
1618 ;; all defined commands. Don't provide any initial input.
1619 ;; Save the command read on the extended-command history list.
1630 ;; This isn't strictly correct if `execute-extended-command'
1631 ;; is bound to anything else (e.g. [menu]).
1632 ;; It could use (key-description (this-single-command-keys)),
1633 ;; but actually a prompt other than "M-x" would be confusing,
1634 ;; because "M-x" is a well-known prompt to read a command
1635 ;; and it serves as a shorthand for "Extended command: ".
1640 ;; Exclude obsolete commands from completions.
1645 pred)))
1650 "Non-nil means show the equivalent key-binding when M-x command has one.
1651 The value can be a length of time to show the message for.
1652 If the value is non-nil and not a number, we wait 2 seconds."
1659 "If non-nil, show a shorter M-x invocation when there is one."
1680 binding)
1686 name len)))
1687 ;; Don't show the help message if the binding isn't
1688 ;; significantly shorter than the M-x command the user typed.
1695 binding))
1698 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1699 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1700 "Read a command name, then read the arguments and call the command.
1701 To pass a prefix argument to the command you are
1702 invoking, give a prefix argument to `execute-extended-command'."
1704 ;; FIXME: Remember the actual text typed by the user before completion,
1705 ;; so that we don't later on suggest the same shortening.
1710 execute-extended-command--last-typed)))
1711 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1724 ;; Normally `real-this-command' should never be changed, but here we really
1725 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1726 ;; binding" for <cmd>, so the command the user really wanted to run is
1727 ;; `function' and not `execute-extended-command'. The difference is
1728 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1732 ;; If enabled, show which key runs this command.
1733 ;; But first wait, and skip the message if there is input.
1735 ;; If this command displayed something in the echo area;
1736 ;; wait a few seconds, then display our suggestion message.
1737 ;; FIXME: Wait *after* running post-command-hook!
1738 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1739 ;; find a better answer anyway!
1749 ;; There's no binding for CMD. Let's try and find the shortest
1750 ;; string to use in M-x.
1751 ;; FIXME: Can be slow. Cache it maybe?
1758 function
1763 suggest-key-bindings
1767 ;; BEWARE: Called directly from the C code.
1768 "Execute CMD as an editor command.
1769 CMD must be a symbol that satisfies the `commandp' predicate.
1770 Optional second arg RECORD-FLAG non-nil
1771 means unconditionally put this command in the variable `command-history'.
1772 Otherwise, that is done only if an arg is read using the minibuffer.
1773 The argument KEYS specifies the value to use instead of (this-command-keys)
1774 when reading the arguments; if it is nil, (this-command-keys) is used.
1775 The argument SPECIAL, if non-nil, means that this command is executing
1776 a special event, so ignore the prefix argument and don't clear it."
1779 ;; FIXME: This should probably be done around
1780 ;; pre-command-hook rather than here!
1788 disabled-command-function)
1789 ;; FIXME: Weird calling convention!
1799 ;; If requested, place the macro in the command history. For
1800 ;; other sorts of commands, call-interactively takes care of this.
1803 ;; Don't keep command history around forever.
1809 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1817 \f
1819 "Default minibuffer history list.
1820 This is used for all minibuffer input
1821 except when an alternate history list is specified.
1823 Maximum length of the history list is determined by the value
1826 "Control whether history list elements are expressions or strings.
1827 If the value of this variable equals current minibuffer depth,
1828 they are expressions; otherwise they are strings.
1829 \(That convention is designed to do the right thing for
1836 "Text that was in this minibuffer before any history commands.
1837 This is nil if there have not yet been any history commands
1846 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1851 "Minibuffer history variables for which matching should ignore case.
1852 If a history variable is a member of this list, then the
1854 commands ignore case when searching it, regardless of `case-fold-search'."
1859 "Find the previous history element that matches REGEXP.
1860 \(Previous history elements refer to earlier actions.)
1861 With prefix argument N, search for Nth previous match.
1862 If N is negative, find the next or Nth next match.
1863 Normally, history elements are matched case-insensitively if
1864 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1865 makes the search case-sensitive.
1866 See also `minibuffer-history-case-insensitive-variables'."
1870 nil
1871 minibuffer-local-map
1872 nil
1873 'minibuffer-history-search-history
1875 ;; Use the last regexp specified, by default, if input is empty.
1880 regexp)
1890 ;; On some systems, ignore case for file names.
1892 minibuffer-history-case-insensitive-variables)
1893 t
1894 ;; Respect the user's setting for case-fold-search:
1895 case-fold-search)
1896 nil))
1897 prevpos
1898 match-string
1899 match-offset
1906 "No later matching history item"
1927 next-matching-history-element))
1931 "Find the next history element that matches REGEXP.
1932 \(The next history element refers to a more recent action.)
1933 With prefix argument N, search for Nth next match.
1934 If N is negative, find the previous or Nth previous match.
1935 Normally, history elements are matched case-insensitively if
1936 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1937 makes the search case-sensitive."
1941 nil
1942 minibuffer-local-map
1943 nil
1944 'minibuffer-history-search-history
1946 ;; Use the last regexp specified, by default, if input is empty.
1951 regexp)
1958 "Function run by `goto-history-element' before consuming default values.
1959 This is useful to dynamically add more elements to the list of default values
1960 when `goto-history-element' reaches the end of this list.
1961 Before calling this function `goto-history-element' sets the variable
1962 `minibuffer-default-add-done' to t, so it will call this function only
1963 once. In special cases, when this function needs to be called more
1964 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1968 "When nil, add more elements to the end of the list of default values.
1969 The value nil causes `goto-history-element' to add more elements to
1970 the list of defaults when it reaches the end of this list. It does
1976 "Return a list of all completions without the default value.
1977 This function is used to add all elements of the completion table to
1978 the end of the list of defaults just after the default value."
1981 minibuffer-completion-table
1982 minibuffer-completion-predicate)))
1988 "Puts element of the minibuffer history in the minibuffer.
1989 The argument NABS specifies the absolute history position."
2003 elt minibuffer-returned-to-present)
2010 "End of defaults; no next item"
2017 previous-history-element))
2029 minibuffer-default)))
2041 elt))
2045 "Puts next element of the minibuffer history in the minibuffer.
2046 With argument N, it uses the Nth following element."
2052 "Puts previous element of the minibuffer history in the minibuffer.
2053 With argument N, it uses the Nth previous element."
2059 "Move cursor vertically down ARG lines, or to the next history element.
2060 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2061 next element of the minibuffer history in the minibuffer."
2065 ;; Remember the original goal column of possibly multi-line input
2066 ;; excluding the length of the prompt on the first line.
2076 ;; Restore old position since `line-move-visual' moves point to
2077 ;; the end of the line when it fails to go to the next line.
2080 ;; Reset `temporary-goal-column' because a correct value is not
2081 ;; calculated when `next-line' above fails by bumping against
2082 ;; the bottom of the minibuffer (bug#22544).
2084 ;; Restore the original goal column on the last line
2085 ;; of possibly multi-line input.
2093 "Move cursor vertically up ARG lines, or to the previous history element.
2094 When point moves over the top line of multi-line minibuffer, puts ARGth
2095 previous element of the minibuffer history in the minibuffer."
2099 ;; Remember the original goal column of possibly multi-line input
2100 ;; excluding the length of the prompt on the first line.
2110 ;; Restore old position since `line-move-visual' moves point to
2111 ;; the beginning of the line when it fails to go to the previous line.
2114 ;; Reset `temporary-goal-column' because a correct value is not
2115 ;; calculated when `previous-line' above fails by bumping against
2116 ;; the top of the minibuffer (bug#22544).
2118 ;; Restore the original goal column on the first line
2119 ;; of possibly multi-line input.
2125 ;; Put the cursor at the end of the visual line instead of the
2126 ;; logical line, so the next `previous-line-or-history-element'
2127 ;; would move to the previous history element, not to a possible upper
2128 ;; visual line from the end of logical line in `line-move-visual' mode.
2130 ;; Since `end-of-visual-line' puts the cursor at the beginning
2131 ;; of the next visual line, move it one char back to the end
2132 ;; of the first visual line (bug#22544).
2136 "Get next history element which completes the minibuffer before the point.
2137 The contents of the minibuffer after the point are deleted, and replaced
2138 by the new completion."
2144 n)
2145 ;; next-matching-history-element always puts us at (point-min).
2146 ;; Move to the position we were at before changing the buffer contents.
2147 ;; This is still sensible, because the text before point has not changed.
2151 "\
2152 Get previous history element which completes the minibuffer before the point.
2153 The contents of the minibuffer after the point are deleted, and replaced
2154 by the new completion."
2158 ;; For compatibility with the old subr of the same name.
2160 "Return the display width of the minibuffer prompt.
2161 Return 0 if current buffer is not a minibuffer."
2162 ;; Return the width of everything before the field at the end of
2163 ;; the buffer; this should be 0 for normal buffers.
2165 \f
2166 ;; isearch minibuffer history
2173 "Set up a minibuffer for using isearch to search the minibuffer history.
2174 Intended to be added to `minibuffer-setup-hook'."
2186 "Clean up the minibuffer after terminating isearch in the minibuffer."
2191 "Return the proper search function, for isearch in minibuffer history."
2194 ;; Use standard functions to search within minibuffer text
2196 found)
2197 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2198 ;; searching forward. Lazy-highlight calls this lambda with the
2199 ;; bound arg, so skip the minibuffer prompt.
2203 ;; 1. First try searching in the initial minibuffer text
2206 noerror)
2207 ;; 2. If the above search fails, start putting next/prev history
2208 ;; elements in the minibuffer successively, and search the string
2209 ;; in them. Do this only when bound is nil (i.e. not while
2210 ;; lazy-highlighting search strings in the current minibuffer text).
2222 ;; After putting the next/prev history element, search
2223 ;; the string in them again, until next-history-element
2224 ;; or previous-history-element raises an error at the
2225 ;; beginning/end of history.
2228 ;; For backward search, don't search
2229 ;; in the minibuffer prompt
2231 noerror)))
2232 ;; Return point of the new search result
2234 ;; Return nil when next(prev)-history-element fails
2238 "Display the minibuffer history search prompt.
2239 If there are no search errors, this function displays an overlay with
2240 the isearch prompt which replaces the original minibuffer prompt.
2241 Otherwise, it displays the standard isearch message returned from
2242 the function `isearch-message'."
2244 ;; Use standard function `isearch-message' when not in the minibuffer,
2245 ;; or search fails, or has an error (like incomplete regexp).
2246 ;; This function overwrites minibuffer text with isearch message,
2247 ;; so it's possible to see what is wrong in the search string.
2249 ;; Otherwise, put the overlay with the standard isearch prompt over
2250 ;; the initial minibuffer prompt.
2259 ;; And clear any previous isearch message.
2263 "Wrap the minibuffer history search when search fails.
2264 Move point to the first history element for a forward search,
2265 or to the last history element for a backward search."
2266 ;; When `minibuffer-history-isearch-search' fails on reaching the
2267 ;; beginning/end of the history, wrap the search to the first/last
2268 ;; minibuffer history element.
2276 "Save a function restoring the state of minibuffer history search.
2277 Save `minibuffer-history-position' to the additional state parameter
2278 in the search status stack."
2284 "Restore the minibuffer history search state.
2285 Go to the history element by the absolute history position HIST-POS."
2288 \f
2289 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2293 "Table mapping redo records to the corresponding undo one.
2294 A redo record for undo-in-region maps to t.
2304 "Within a run of consecutive undo commands, list remaining to be undone.
2308 "Undo some previous changes.
2309 Repeat this command to undo more changes.
2310 A numeric ARG serves as a repeat count.
2312 In Transient Mark mode when the mark is active, only undo changes within
2314 as an argument limits undo to changes within the current region."
2316 ;; Make last-command indicate for the next command that this was an undo.
2317 ;; That way, another undo will undo more.
2318 ;; If we get to the end of the undo history and get an error,
2319 ;; another undo command will find the undo history empty
2320 ;; and will get another error. To begin undoing the undos,
2321 ;; you must type some other command.
2323 ;; For an indirect buffer, look in the base buffer for the
2324 ;; auto-save data.
2328 message)
2329 ;; If we get an error in undo-start,
2330 ;; the next command should not be a "consecutive undo".
2331 ;; So set `this-command' to something other than `undo'.
2336 ;; If something (a timer or filter?) changed the buffer
2337 ;; since the previous command, don't continue the undo seq.
2341 ;; If the last undo record made was made by undo
2342 ;; it shows nothing else happened in between.
2349 ;; get rid of initial undo boundary
2351 ;; If we got this far, the next command should be a consecutive undo.
2353 ;; Check to see whether we're hitting a redo record, and if
2354 ;; so, ask the user whether she wants to skip the redo/undo pair.
2362 ;; The equiv entry might point to another redo record if we have done
2363 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2371 ;; Record the fact that the just-generated undo records come from an
2372 ;; undo operation--that is, they are redo records.
2373 ;; In the ordinary case (not within a region), map the redo
2374 ;; record to the following undos.
2375 ;; I don't know how to do that in the undo-in-region case.
2377 ;; Strip any leading undo boundaries there might be, like we do
2378 ;; above when checking.
2382 ;; Prevent identity mapping. This can happen if
2383 ;; consecutive nils are erroneously in undo list.
2385 t
2386 pending-undo-list)
2387 undo-equiv-table))
2388 ;; Don't specify a position in the undo record for the undo command.
2389 ;; Instead, undoing this should move point to where the change is.
2408 ;; Record what the current undo list says,
2409 ;; so the next command can tell if the buffer was modified in between.
2413 ;; Display a message announcing success.
2418 "Make BUFFER stop keeping undo information.
2419 No argument or nil as argument means do this for the current buffer."
2425 "Undo some previous changes.
2426 Repeat this command to undo more changes.
2427 A numeric ARG serves as a repeat count.
2428 Contrary to `undo', this will not redo a previous undo."
2433 "Non-nil while performing an undo.
2437 "Undo back N undo-boundaries beyond what was already undone recently.
2438 Call `undo-start' to get ready to undo recent changes,
2439 then call `undo-more' one or more times to undo them."
2444 ;; Note: The following, while pulling elements off
2445 ;; `pending-undo-list' will call primitive change functions which
2446 ;; will push more elements onto `buffer-undo-list'.
2452 "Undo N records from the front of the list LIST.
2453 Return what remains of the list."
2455 ;; This is a good feature, but would make undo-start
2456 ;; unable to do what is expected.
2457 ;;(when (null (car (list)))
2458 ;; ;; If the head of the list is a boundary, it is the boundary
2459 ;; ;; preceding this command. Get rid of it and don't count it.
2460 ;; (setq list (cdr list))))
2463 ;; In a writable buffer, enable undoing read-only text that is
2464 ;; so because of text properties.
2466 ;; Don't let `intangible' properties interfere with undo.
2468 ;; We use oldlist only to check for EQ. ++kfs
2474 ;; Handle an integer by setting point to that value.
2477 ;; Element (t . TIME) records previous modtime.
2478 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2479 ;; UNKNOWN_MODTIME_NSECS.
2481 ;; If this records an obsolete save
2482 ;; (not matching the actual disk file)
2483 ;; then don't mark unmodified.
2491 ;; Element (nil PROP VAL BEG . END) is property change.
2496 ;; Element (BEG . END) means range was inserted.
2498 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2499 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2502 ;; Set point first thing, so that undoing this undo
2503 ;; does not send point back to where it is now.
2506 ;; Element (apply FUN . ARGS) means call FUN to undo.
2510 ;; Long format: (apply DELTA START END FUN . ARGS).
2517 ;; Check that the function did what the entry
2518 ;; said it would do.
2528 ;; Element (STRING . POS) means STRING was deleted.
2534 ;; Check that marker adjustments which were recorded
2535 ;; with the (STRING . POS) record are still valid, ie
2536 ;; the markers haven't moved. We check their validity
2537 ;; before reinserting the string so as we don't need to
2538 ;; mind marker insertion-type.
2546 ;; Insert string and adjust point
2554 ;; Adjust the valid marker adjustments
2558 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2561 next)
2562 ;; Even though these elements are not expected in the undo
2563 ;; list, adjust them to be conservative for the 24.4
2564 ;; release. (Bug#16818)
2571 ;; Make sure an apply entry produces at least one undo entry,
2572 ;; so the test in `undo' for continuing an undo series
2573 ;; will work right.
2578 list)
2580 ;; Deep copy of a list
2582 "Make a copy of undo list LIST."
2588 elt))
2591 "Set `pending-undo-list' to the front of the undo list.
2592 The next call to `undo-more' will undo the most recently made change.
2593 If BEG and END are specified, then only undo elements
2594 that apply to text between BEG and END are used; other undo elements
2595 are ignored. If BEG and END are nil, all undo elements are used."
2601 buffer-undo-list)))
2603 ;; The positions given in elements of the undo list are the positions
2604 ;; as of the time that element was recorded to undo history. In
2605 ;; general, subsequent buffer edits render those positions invalid in
2606 ;; the current buffer, unless adjusted according to the intervening
2607 ;; undo elements.
2608 ;;
2609 ;; Undo in region is a use case that requires adjustments to undo
2610 ;; elements. It must adjust positions of elements in the region based
2611 ;; on newer elements not in the region so as they may be correctly
2612 ;; applied in the current buffer. undo-make-selective-list
2613 ;; accomplishes this with its undo-deltas list of adjustments. An
2614 ;; example undo history from oldest to newest:
2615 ;;
2616 ;; buf pos:
2617 ;; 123456789 buffer-undo-list undo-deltas
2618 ;; --------- ---------------- -----------
2619 ;; aaa (1 . 4) (1 . -3)
2620 ;; aaba (3 . 4) N/A (in region)
2621 ;; ccaaba (1 . 3) (1 . -2)
2622 ;; ccaabaddd (7 . 10) (7 . -3)
2623 ;; ccaabdd ("ad" . 6) (6 . 2)
2624 ;; ccaabaddd (6 . 8) (6 . -2)
2625 ;; | |<-- region: "caab", from 2 to 6
2626 ;;
2627 ;; When the user starts a run of undos in region,
2628 ;; undo-make-selective-list is called to create the full list of in
2629 ;; region elements. Each element is adjusted forward chronologically
2630 ;; through undo-deltas to determine if it is in the region.
2631 ;;
2632 ;; In the above example, the insertion of "b" is (3 . 4) in the
2633 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2634 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2635 ;; . 6) is assessed as in the region and placed in the selective list.
2636 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2637 ;; due to the selected element. The "b" insertion is the only element
2638 ;; fully in the region, so in this example undo-make-selective-list
2639 ;; returns (nil (5 . 6)).
2640 ;;
2641 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2642 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2643 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2644 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2645 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2646 ;;
2647 ;; More interesting is how to adjust the "ddd" insertion due to the
2648 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2649 ;; If the reinsertion was a manual retyping of "ad", then the total
2650 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2651 ;; the reinsertion was due to undo, one might expect the first "d"
2652 ;; character would again be a part of the "ddd" text, meaning its
2653 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2654 ;;
2655 ;; undo-make-selective-list assumes in this situation that "ad" was a
2656 ;; new edit, even if it was inserted because of an undo.
2657 ;; Consequently, if the user undos in region "8 to 10" of the
2658 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2659 ;; "ccaabad", as though the first "d" became detached from the
2660 ;; original "ddd" insertion. This quirk is a FIXME.
2663 "Return a list of undo elements for the region START to END.
2664 The elements come from `buffer-undo-list', but we keep only the
2665 elements inside this region, and discard those outside this
2666 region. The elements' positions are adjusted so as the returned
2667 list can be applied to the current buffer."
2669 ;; A list of position adjusted undo elements in the region.
2671 ;; A list of undo-deltas for out of region undo elements.
2672 undo-deltas
2673 undo-elt)
2681 ;; Don't put two nils together in the list
2685 ;; This is a "was unmodified" element. Keep it
2686 ;; if we have kept everything thus far.
2689 ;; Skip over marker adjustments, instead relying
2690 ;; on finding them after (TEXT . POS) elements
2692 nil)
2695 undo-deltas)))
2700 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2701 ;; kept. primitive-undo may discard them later.
2714 "Determine whether UNDO-ELT falls inside the region START ... END.
2715 If it crosses the edge, we return nil.
2717 Generally this function is not useful for determining
2718 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2719 because markers can be arbitrarily relocated. Instead, pass the
2720 marker adjustment's corresponding (TEXT . POS) element."
2725 t)
2727 nil)
2729 ;; (TEXT . POSITION)
2733 ;; (MARKER . ADJUSTMENT)
2736 ;; (nil PROPERTY VALUE BEG . END)
2741 ;; (BEGIN . END)
2746 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2747 This assumes we have already decided that UNDO-ELT
2748 is not *inside* the region START...END."
2752 ;; (nil PROPERTY VALUE BEG . END)
2757 ;; (BEGIN . END)
2762 "Return adjustment of undo element ELT by the undo DELTAS
2763 list."
2765 ;; POSITION
2768 ;; (BEG . END)
2771 ;; (TEXT . POSITION)
2775 ;; (nil PROPERTY VALUE BEG . END)
2778 ;; (apply DELTA START END FUN . ARGS)
2779 ;; FIXME
2780 ;; All others return same elt
2783 ;; (BEG . END) can adjust to the same positions, commonly when an
2784 ;; insertion was undone and they are out of region, for example:
2785 ;;
2786 ;; buf pos:
2787 ;; 123456789 buffer-undo-list undo-deltas
2788 ;; --------- ---------------- -----------
2789 ;; [...]
2790 ;; abbaa (2 . 4) (2 . -2)
2791 ;; aaa ("bb" . 2) (2 . 2)
2792 ;; [...]
2793 ;;
2794 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2795 ;; undo. Further adjustments to such an element should be the same as
2796 ;; for (TEXT . POSITION) elements. The options are:
2797 ;;
2798 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2799 ;; analogous to marker insertion-type t.
2800 ;;
2801 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2802 ;; marker insertion-type nil.
2803 ;;
2804 ;; There was no strong reason to prefer one or the other, except that
2805 ;; the first is more consistent with prior undo in region behavior.
2807 "Return cons of adjustments to BEG and END by the undo DELTAS
2808 list."
2810 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2815 "Return adjustment of POS by the undo DELTAS list, comparing
2816 with < or <= based on USE-<."
2822 ;; Don't allow pos to become less than the undo-delta
2823 ;; position. This edge case is described in the overview
2824 ;; comments.
2827 ;; Return the first affected buffer position and the delta for an undo element
2828 ;; delta is defined as the change in subsequent buffer positions if we *did*
2829 ;; the undo.
2833 ;; (TEXT . POSITION)
2836 ;; (BEGIN . END)
2842 ;;; Default undo-boundary addition
2843 ;;
2844 ;; This section adds a new undo-boundary at either after a command is
2845 ;; called or in some cases on a timer called after a change is made in
2846 ;; any buffer.
2848 "Describe the cause of the last undo-boundary.
2850 If `explicit', the last boundary was caused by an explicit call to
2851 `undo-boundary', that is one not called by the code in this
2852 section.
2854 If it is equal to `timer', then the last boundary was inserted
2855 by `undo-auto--boundary-timer'.
2857 If it is equal to `command', then the last boundary was inserted
2858 automatically after a command, that is by the code defined in
2859 this section.
2861 If it is equal to a list, then the last boundary was inserted by
2862 an amalgamating command. The car of the list is the number of
2863 times an amalgamating command has been called, and the cdr are the
2867 "Current timer which will run `undo-auto--boundary-timer' or nil.
2872 "Non-nil if `this-command' should be amalgamated.
2873 This variable is set to nil by `undo-auto--boundaries' and is set
2877 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2881 "Return the number of amalgamating last commands or nil.
2882 Amalgamating commands are, by default, either
2883 `self-insert-command' and `delete-char', but can be any command
2884 that calls `undo-auto-amalgamate'."
2888 "Add an `undo-boundary' to the current buffer if needed.
2889 REASON describes the reason that the boundary is being added; see
2890 `undo-auto--last-boundary' for more information."
2900 undo-auto--undoably-changed-buffers)
2901 cause)))))
2904 "Check recently changed buffers and add a boundary if necessary.
2905 REASON describes the reason that the boundary is being added; see
2906 `undo-last-boundary' for more information."
2907 ;; (Bug #23785) All commands should ensure that there is an undo
2908 ;; boundary whether they have changed the current buffer or not.
2918 "Timer which will run `undo--auto-boundary-timer'."
2923 "Ensure that the `undo-auto-boundary-timer' is set."
2929 "List of buffers that have changed recently.
2931 This list is maintained by `undo-auto--undoable-change' and
2932 `undo-auto--boundaries' and can be affected by changes to their
2936 "Add an `undo-boundary' in appropriate buffers."
2941 'amalgamate
2945 "Amalgamate undo if necessary.
2946 This function can be called before an amalgamating command. It
2947 removes the previous `undo-boundary' if a series of such calls
2948 have been made. By default `self-insert-command' and
2949 `delete-char' are the only amalgamating commands, although this
2950 function could be called by any command wishing to have this
2951 behavior."
2956 last-amalgamating-count
2961 ;; Amalgamate all buffers that have changed.
2965 b
2967 ;; The head of `buffer-undo-list' is nil.
2968 ;; `car-safe' doesn't work because
2969 ;; `buffer-undo-list' need not be a list!
2977 "Called after every undoable buffer change."
2980 ;; End auto-boundary section
2983 "Amalgamate changes in change-group since HANDLE.
2984 Remove all undo boundaries between the state of HANDLE and now.
2985 HANDLE is as returned by `prepare-change-group'."
2994 ;; Temporarily truncate the undo log at ELT.
2999 ;; `elt' is still in the log: normal case.
3001 ;; `elt' is not in the log any more, but that's because
3002 ;; the log is "all new", so we should remove all
3003 ;; boundaries from it.
3007 buffer-undo-list
3008 ;; Preserve the undo-boundaries at either ends of the
3009 ;; change-groups.
3011 ;; Reset the modified cons cell ELT to its original content.
3018 "If non-nil ask about discarding undo info for the current command.
3019 Normally, Emacs discards the undo info for the current command if
3020 it exceeds `undo-outer-limit'. But if you set this option
3021 non-nil, it asks in the echo area whether to discard the info.
3022 If you answer no, there is a slight risk that Emacs might crash, so
3023 only do it if you really want to undo the command.
3025 This option is mainly intended for debugging. You have to be
3026 careful if you use it for other purposes. Garbage collection is
3027 inhibited while the question is asked, meaning that Emacs might
3028 leak memory. So you should make sure that you do not wait
3029 excessively long before answering the question."
3035 "If non-nil, an extra level of size that's ok in an undo item.
3036 We don't ask the user about truncating the undo list until the
3037 current item gets bigger than this amount.
3042 ;; When the first undo batch in an undo list is longer than
3043 ;; undo-outer-limit, this function gets called to warn the user that
3044 ;; the undo info for the current command was discarded. Garbage
3045 ;; collection is inhibited around the call, so it had better not do a
3046 ;; lot of consing.
3052 ;; Don't ask the question again unless it gets even bigger.
3053 ;; This applies, in particular, if the user quits from the question.
3054 ;; Such a quit quits out of GC, but something else will call GC
3055 ;; again momentarily. It will call this function again,
3056 ;; but we don't want to ask the question again.
3060 "Buffer `%s' undo info is %d bytes long; discard it? "
3064 t)
3065 nil))
3071 "The undo info was discarded because it exceeded \
3072 `undo-outer-limit'.
3074 This is normal if you executed a command that made a huge change
3075 to the buffer. In that case, to prevent similar problems in the
3076 future, set `undo-outer-limit' to a value that is large enough to
3077 cover the maximum size of normal changes you expect a single
3078 command to make, but not so large that it might exceed the
3079 maximum memory allotted to Emacs.
3081 If you did not execute any such command, the situation is
3082 probably due to a bug and you should report it.
3084 You can disable the popping up of this buffer by adding the entry
3085 \(undo discard-info) to the user option `warning-suppress-types',
3089 t))
3090 \f
3093 ; These are sorted according to the GNU en_US locale.
3136 )
3138 This is used by Shell mode and other parts of Emacs to recognize
3139 password prompts, including prompts in languages other than
3140 English. Different case choices should not be assumed to be
3141 included; callers should bind `case-fold-search' to t."
3147 "History list for some commands that read shell commands.
3149 Maximum length of the history list is determined by the value
3156 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3157 This buffer is used when `shell-command' or `shell-command-on-region'
3158 is run interactively. A value of nil means that output to stderr and
3165 "Return a list of all commands associated with the current file.
3166 This function is used to add all related commands retrieved by `mailcap'
3167 to the end of the list of defaults just after the default value."
3171 minibuffer-default))
3176 commands))
3187 map)
3191 "Read a shell command from the minibuffer.
3192 The arguments are the same as the ones of `read-from-minibuffer',
3193 except READ and KEYMAP are missing and HIST defaults
3194 to `shell-command-history'."
3202 minibuffer-local-shell-command-map
3203 nil
3205 args)))
3208 "What to do when the output buffer is used by another shell command.
3209 This option specifies how to resolve the conflict where a new command
3210 wants to direct its output to the buffer `*Async Shell Command*',
3211 but this buffer is already taken by another running shell command.
3213 The value `confirm-kill-process' is used to ask for confirmation before
3214 killing the already running process and running a new process
3215 in the same buffer, `confirm-new-buffer' for confirmation before running
3216 the command in a new buffer with a name other than the default buffer name,
3217 `new-buffer' for doing the same without confirmation,
3218 `confirm-rename-buffer' for confirmation before renaming the existing
3219 output buffer and running a new command in the default buffer,
3220 `rename-buffer' for doing the same without confirmation."
3222 confirm-kill-process)
3224 confirm-new-buffer)
3226 new-buffer)
3228 confirm-rename-buffer)
3230 rename-buffer))
3235 "Store a buffer position or erase the buffer.
3236 See `shell-command-dont-erase-buffer'."
3238 pos)
3240 ;; Setting buffer-read-only to nil doesn't suffice
3241 ;; if some text has a non-nil read-only property,
3242 ;; which comint sometimes adds for prompts.
3252 shell-command-saved-pos))))
3255 "Set point in BUFFER after command complete.
3256 BUFFER is the output buffer of the command; if nil, then defaults
3257 to the current BUFFER.
3258 Set point to the `cdr' of the element in `shell-command-saved-pos'
3259 whose `car' is BUFFER."
3271 ;; Set point in the window displaying buf, if any; otherwise
3272 ;; display buf temporary in selected frame and set the point.
3277 buf
3282 "Execute string COMMAND asynchronously in background.
3284 Like `shell-command', but adds `&' at the end of COMMAND
3285 to execute it asynchronously.
3287 The output appears in the buffer `*Async Shell Command*'.
3288 That buffer is in shell mode.
3290 You can configure `async-shell-command-buffer' to specify what to do in
3291 case when `*Async Shell Command*' buffer is already taken by another
3292 running shell command. To run COMMAND without displaying the output
3293 in a window you can configure `display-buffer-alist' to use the action
3294 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3296 In Elisp, you will often be better served by calling `start-process'
3297 directly, since it offers more control and does not impose the use of a
3298 shell (with its need to quote arguments)."
3308 current-prefix-arg
3309 shell-command-default-error-buffer))
3315 "Execute string COMMAND in inferior shell; display output, if any.
3316 With prefix argument, insert the COMMAND's output at point.
3318 Interactively, prompt for COMMAND in the minibuffer.
3320 If COMMAND ends in `&', execute it asynchronously.
3321 The output appears in the buffer `*Async Shell Command*'.
3322 That buffer is in shell mode. You can also use
3323 `async-shell-command' that automatically adds `&'.
3325 Otherwise, COMMAND is executed synchronously. The output appears in
3326 the buffer `*Shell Command Output*'. If the output is short enough to
3327 display in the echo area (which is determined by the variables
3328 `resize-mini-windows' and `max-mini-window-height'), it is shown
3329 there, but it is nonetheless available in buffer `*Shell Command
3330 Output*' even though that buffer is not automatically displayed.
3332 To specify a coding system for converting non-ASCII characters
3334 before this command.
3336 Noninteractive callers can specify coding systems by binding
3337 `coding-system-for-read' and `coding-system-for-write'.
3339 The optional second argument OUTPUT-BUFFER, if non-nil,
3340 says to put the output in some other buffer.
3341 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3342 and insert the output there; a non-nil value of
3343 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3344 If OUTPUT-BUFFER is not a buffer and not nil, insert the output
3345 in current buffer after point leaving mark after it.
3346 This cannot be done asynchronously.
3348 If the command terminates without error, but generates output,
3350 the output can be displayed in the echo area or in its buffer.
3351 If the output is short enough to display in the echo area
3352 \(determined by the variable `max-mini-window-height' if
3353 `resize-mini-windows' is non-nil), it is shown there.
3354 Otherwise,the buffer containing the output is displayed.
3358 of the output.
3360 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3361 or buffer name to which to direct the command's standard error output.
3362 If it is nil, error output is mingled with regular output.
3363 In an interactive call, the variable `shell-command-default-error-buffer'
3364 specifies the value of ERROR-BUFFER.
3366 In Elisp, you will often be better served by calling `call-process' or
3367 `start-process' directly, since it offers more control and does not impose
3368 the use of a shell (with its need to quote arguments)."
3379 current-prefix-arg
3380 shell-command-default-error-buffer))
3381 ;; Look for a handler in case default-directory is a remote file name.
3389 ;; Output goes in current buffer.
3395 temporary-file-directory)))
3396 nil)))
3399 ;; We do not use -f for csh; we will not support broken use of
3400 ;; .cshrcs. Even the BSD csh manual says to use
3401 ;; "if ($?prompt) exit" before things which are not useful
3402 ;; non-interactively. Besides, if someone wants their other
3403 ;; aliases for shell commands then they can still have them.
3407 t)
3408 nil shell-command-switch command)
3415 ;; Do no formatting while reading error file,
3416 ;; because that can run a shell command, and we
3417 ;; don't want that to cause an infinite recursion.
3419 ;; Put point after the inserted errors.
3423 ;; This is like exchange-point-and-mark, but doesn't
3424 ;; activate the mark. It is cleaner to avoid activation,
3425 ;; even though the command loop would deactivate the mark
3426 ;; because we inserted text.
3430 ;; Output goes in a separate buffer.
3431 ;; Preserve the match data in case called from a program.
3432 ;; FIXME: It'd be ridiculous for an Elisp function to call
3433 ;; shell-command and assume that it won't mess the match-data!
3436 ;; Command ending with ampersand means asynchronous.
3440 proc)
3441 ;; Remove the ampersand.
3443 ;; Ask the user what to do with already running process.
3448 ;; If will kill a process, query first.
3453 ;; If will create a new buffer, query first.
3460 ;; It will create a new buffer.
3465 ;; If will rename the buffer, query first.
3474 ;; It will rename the buffer.
3484 shell-command-switch command))
3488 ;; Use the comint filter for proper handling of carriage motion
3489 ;; (see `comint-inhibit-carriage-motion'),.
3491 ))
3492 ;; Otherwise, command is executed synchronously.
3494 output-buffer nil error-buffer)))))))
3497 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3498 MESSAGE may be either a string or a buffer.
3500 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3501 for maximum height of the echo area, as defined by `max-mini-window-height'
3502 if `resize-mini-windows' is non-nil.
3504 Returns either the string shown in the echo area, or when a pop-up
3505 buffer is used, the window used to display it.
3507 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3508 name of the buffer used to display it in the case where a pop-up buffer
3509 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3510 string and it is displayed in the echo area, it is not specified whether
3511 the contents are inserted into the buffer anyway.
3513 Optional arguments ACTION and FRAME are as for `display-buffer',
3514 and are only used if a pop-up buffer is displayed."
3516 ;; Trivial case where we can use the echo area
3520 ;; Trivial case where we can just remove single trailing newline
3523 ;; General case
3526 message
3535 0
3539 (<= lines
3543 max-mini-window-height))
3545 max-mini-window-height)
3549 ;; Don't use the echo area if the output buffer is
3550 ;; already displayed in the selected frame.
3552 ;; Echo area
3558 ;; Buffer
3563 ;; We have a sentinel to prevent insertion of a termination message
3564 ;; in the buffer itself, and to set the point in the buffer when
3565 ;; `shell-command-dont-erase-buffer' is non-nil.
3574 &optional output-buffer replace
3575 error-buffer display-error-buffer
3576 region-noncontiguous-p)
3577 "Execute string COMMAND in inferior shell with region as input.
3578 Normally display output (if any) in temp buffer `*Shell Command Output*';
3579 Prefix arg means replace the region with it. Return the exit code of
3580 COMMAND.
3582 To specify a coding system for converting non-ASCII characters
3584 before this command. By default, the input (from the current buffer)
3585 is encoded using coding-system specified by `process-coding-system-alist',
3586 falling back to `default-process-coding-system' if no match for COMMAND
3587 is found in `process-coding-system-alist'.
3589 Noninteractive callers can specify coding systems by binding
3590 `coding-system-for-read' and `coding-system-for-write'.
3592 If the command generates output, the output may be displayed
3593 in the echo area or in a buffer.
3594 If the output is short enough to display in the echo area
3595 \(determined by the variable `max-mini-window-height' if
3596 `resize-mini-windows' is non-nil), it is shown there.
3597 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3598 The output is available in that buffer in both cases.
3600 If there is output and an error, a message about the error
3601 appears at the end of the output.
3603 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3604 command's output. If the value is a buffer or buffer name,
3605 erase that buffer and insert the output there; a non-nil value of
3606 `shell-command-dont-erase-buffer' prevent to erase the buffer.
3607 If the value is nil, use the buffer `*Shell Command Output*'.
3608 Any other non-nil value means to insert the output in the
3609 current buffer after START.
3611 Optional fifth arg REPLACE, if non-nil, means to insert the
3612 output in place of text from START to END, putting point and mark
3613 around it.
3615 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3616 or buffer name to which to direct the command's standard error
3617 output. If nil, error output is mingled with regular output.
3618 When called interactively, `shell-command-default-error-buffer'
3619 is used for ERROR-BUFFER.
3621 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3622 display the error buffer if there were any errors. When called
3623 interactively, this is t."
3627 ;; Do this before calling region-beginning
3628 ;; and region-end, in case subprocess output
3629 ;; relocates them while we are in the minibuffer.
3631 ;; call-interactively recognizes region-beginning and
3632 ;; region-end specially, leaving them in the history.
3634 string
3635 current-prefix-arg
3636 current-prefix-arg
3637 shell-command-default-error-buffer
3638 t
3645 temporary-file-directory)))
3646 nil))
3647 exit-status)
3648 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3651 output)
3655 shell-file-name t t
3656 nil shell-command-switch
3657 command)
3664 ;; Replace specified region with output from command.
3666 ;; Don't muck with mark unless REPLACE says we should.
3673 t)))
3674 ;; It is rude to delete a buffer which the command is not using.
3675 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3676 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3677 ;; (kill-buffer shell-buffer)))
3678 ;; Don't muck with mark unless REPLACE says we should.
3680 ;; No prefix argument: put the output in a temp buffer,
3681 ;; replacing its entire contents.
3689 ;; If the input is the same buffer as the output,
3690 ;; delete everything but the specified region,
3691 ;; then replace that region with the output.
3697 shell-file-name t
3700 t)
3701 nil shell-command-switch
3702 command)))
3703 ;; Clear the output buffer, then run the command with
3704 ;; output there.
3714 buffer))))
3715 ;; Report the output.
3725 ;; There's some output, display it
3729 ;; No output; error?
3736 shell-command-default-error-buffer)
3743 output))
3746 exit-status))
3749 exit-status output))))
3750 ;; Don't kill: there might be useful info in the undo-log.
3751 ;; (kill-buffer buffer)
3752 )))))
3760 ;; Do no formatting while reading error file,
3761 ;; because that can run a shell command, and we
3762 ;; don't want that to cause an infinite recursion.
3764 ;; Put point after the inserted errors.
3769 exit-status))
3772 "Execute shell command COMMAND and return its output as a string."
3775 standard-output
3779 "Process files synchronously in a separate process.
3780 Similar to `call-process', but may invoke a file handler based on
3781 `default-directory'. The current working directory of the
3782 subprocess is `default-directory'.
3784 File names in INFILE and BUFFER are handled normally, but file
3785 names in ARGS should be relative to `default-directory', as they
3786 are passed to the process verbatim. (This is a difference to
3787 `call-process' which does not support file handlers for INFILE
3788 and BUFFER.)
3790 Some file handlers might not support all variants, for example
3791 they might behave as if DISPLAY was nil, regardless of the actual
3792 value passed."
3794 lc stderr-file)
3804 display args)
3810 "Whether a call of `process-file' changes remote files.
3812 By default, this variable is always set to t, meaning that a
3813 call of `process-file' could potentially change any file on a
3814 remote host. When set to nil, a file handler could optimize
3815 its behavior with respect to remote file attribute caching.
3817 You should only ever change this variable with a let-binding;
3821 "Start a program in a subprocess. Return the process object for it.
3823 Similar to `start-process', but may invoke a file handler based on
3824 `default-directory'. See Info node `(elisp)Magic File Names'.
3826 This handler ought to run PROGRAM, perhaps on the local host,
3827 perhaps on a remote host that corresponds to `default-directory'.
3828 In the latter case, the local part of `default-directory' becomes
3829 the working directory of the process.
3831 PROGRAM and PROGRAM-ARGS might be file names. They are not
3832 objects of file handler invocation. File handlers might not
3833 support pty association, if PROGRAM is nil."
3837 \f
3838 ;;;; Process menu
3852 map))
3855 "Major mode for listing the processes called by Emacs."
3868 "Kill process at point in a `list-processes' buffer."
3879 "Recompute the list of processes for the Process List buffer.
3880 Also, delete any process that is exited or signaled."
3894 face link
3896 "Visit buffer `%s'"
3898 follow-link t
3899 process-buffer ,buf
3900 action process-menu-visit-buffer)
3909 "datagram"
3926 tabulated-list-entries))))))
3932 "Display a list of all processes that are Emacs sub-processes.
3933 If optional argument QUERY-ONLY is non-nil, only processes with
3934 the query-on-exit flag set are listed.
3935 Any process listed as exited or signaled is actually eliminated
3936 after the listing is made.
3937 Optional argument BUFFER specifies a buffer to use, instead of
3939 The return value is always nil.
3941 This function lists only processes that were launched by Emacs. To
3942 see other processes running on the system, use `list-system-processes'."
3954 nil)
3955 \f
3956 ;;;; Prefix commands
3962 ;; BEWARE: Called directly from C code.
3963 ;; If the return value is non-nil, it means we are in the middle of
3964 ;; a command with prefix, such as a command invoked with prefix-arg.
3966 prefix-command--last-echo
3975 "Abnormal hook which constructs the description of the current prefix state.
3979 "Update state of prefix commands.
3987 "Pass the current prefix command state to the next command.
3988 Should be called by all prefix commands.
3989 Runs `prefix-command-preserve-state-hook'."
3991 ;; If the current command is a prefix command, we don't want the next (real)
3992 ;; command to have `last-command' set to, say, `universal-argument'.
3999 nil)
4001 ;;;;; The main prefix command.
4003 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
4028 ;; For backward compatibility, minus with no modifiers is an ordinary
4029 ;; command if digits have already been entered.
4059 map)
4067 "Begin a numeric argument for the following command.
4072 multiplies the argument by 4 each time.
4074 which is different in effect from any particular numeric argument.
4082 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
4083 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
4090 arg)))
4094 "Begin a negative numeric argument for the next command.
4104 "Part of the numeric argument for the next command.
4109 last-command-event
4116 ;; Treat -0 as just -, so that -01 will work.
4119 digit))))
4121 \f
4124 "This variable is a wrapper hook around `buffer-substring--filter'.
4130 "Function to perform the filtering in `filter-buffer-substring'.
4131 The function is called with the same 3 arguments (BEG END DELETE)
4132 that `filter-buffer-substring' received. It should return the
4133 buffer substring between BEG and END, after filtering. If DELETE is
4137 "List of filter functions for `buffer-substring--filter'.
4138 Each function must accept a single argument, a string, and return a string.
4139 The buffer substring is passed to the first function in the list,
4140 and the return value of each function is passed to the next.
4141 As a special convention, point is set to the start of the buffer text
4142 being operated on (i.e., the first argument of `buffer-substring--filter')
4148 "Return the buffer substring between BEG and END, after filtering.
4149 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4151 This calls the function that `filter-buffer-substring-function' specifies
4152 \(passing the same three arguments that it received) to do the work,
4153 and returns whatever it does. The default function does no filtering,
4154 unless a hook has been set.
4156 Use `filter-buffer-substring' instead of `buffer-substring',
4157 `buffer-substring-no-properties', or `delete-and-extract-region' when
4158 you want to allow filtering to take place. For example, major or minor
4159 modes can use `filter-buffer-substring-function' to extract characters
4160 that are special to a buffer, and should not be copied into other buffers."
4164 "Default function to use for `filter-buffer-substring-function'.
4165 Its arguments and return value are as specified for `filter-buffer-substring'.
4166 Also respects the obsolete wrapper hook `filter-buffer-substring-functions'
4167 \(see `with-wrapper-hook' for details about wrapper hooks),
4168 and the abnormal hook `buffer-substring-filters'.
4169 No filtering is done unless a hook says to."
4180 string)))
4185 ;;;; Window system cut and paste hooks.
4188 "Function to call to make a killed region available to other programs.
4189 Most window systems provide a facility for cutting and pasting
4190 text between different programs, such as the clipboard on X and
4191 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4193 This variable holds a function that Emacs calls whenever text is
4194 put in the kill ring, to make the new kill available to other
4195 programs. The function takes one argument, TEXT, which is a
4199 "Function to call to get text cut from other programs.
4200 Most window systems provide a facility for cutting and pasting
4201 text between different programs, such as the clipboard on X and
4202 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4204 This variable holds a function that Emacs calls to obtain text
4205 that other programs have provided for pasting. The function is
4206 called with no arguments. If no other program has provided text
4207 to paste, the function should return nil (in which case the
4208 caller, usually `current-kill', should use the top of the Emacs
4209 kill ring). If another program has provided text to paste, the
4210 function should return that text as a string (in which case the
4211 caller should put this string in the kill ring as the latest
4212 kill).
4214 The function may also return a list of strings if the window
4215 system supports multiple selections. The first string will be
4216 used as the pasted text, but the other will be placed in the kill
4217 ring for easy access via `yank-pop'.
4219 Note that the function should return a string only if a program
4220 other than Emacs has provided a string for pasting; if Emacs
4221 provided the most recent string, the function should return nil.
4222 If it is difficult to tell whether Emacs or some other program
4223 provided the current string, it is probably good enough to return
4224 nil if the string is equal (according to `string=') to the last
4226 \f
4229 ;;;; The kill ring data structure.
4232 "List of killed text sequences.
4233 Since the kill ring is supposed to interact nicely with cut-and-paste
4234 facilities offered by window systems, use of this variable should
4235 interact nicely with `interprogram-cut-function' and
4236 `interprogram-paste-function'. The functions `kill-new',
4237 `kill-append', and `current-kill' are supposed to implement this
4238 interaction; you may want to use them instead of manipulating the kill
4242 "Maximum length of kill ring before oldest elements are thrown away."
4250 "Save clipboard strings into kill ring before replacing them.
4251 When one selects something in another program to paste it into Emacs,
4252 but kills something in Emacs before actually pasting it,
4253 this selection is gone unless this variable is non-nil,
4254 in which case the other program's selection is saved in the `kill-ring'
4261 "Do not add a new string to `kill-ring' if it duplicates the last one.
4262 The comparison is done using `equal-including-properties'."
4268 "Make STRING the latest kill in the kill ring.
4269 Set `kill-ring-yank-pointer' to point to it.
4270 If `interprogram-cut-function' is non-nil, apply it to STRING.
4271 Optional second argument REPLACE non-nil means that STRING will replace
4272 the front of the kill ring, rather than being added to the list.
4274 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4275 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4276 STRING.
4278 When the yank handler has a non-nil PARAM element, the original STRING
4279 argument is not used by `insert-for-yank'. However, since Lisp code
4280 may access and use elements from the kill ring directly, the STRING
4283 ;; Due to text properties such as 'yank-handler that
4284 ;; can alter the contents to yank, comparison using
4285 ;; `equal' is unsafe.
4310 ;; It has been argued that this should work similar to `self-insert-command'
4311 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4313 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4319 "Append STRING to the end of the latest kill in the kill ring.
4320 If BEFORE-P is non-nil, prepend STRING to the kill.
4321 Also removes the last undo boundary in the current buffer,
4322 depending on `kill-append-merge-undo'.
4323 If `interprogram-cut-function' is set, pass the resulting kill to it."
4331 ;; find the next undo boundary
4335 ;; remove this undo boundary
4340 "Whether rotating the kill ring changes the window system selection.
4341 If non-nil, whenever the kill ring is rotated (usually via the
4342 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4343 to copy the new kill to the window system selection."
4349 "Rotate the yanking point by N places, and then return that kill.
4350 If N is zero and `interprogram-paste-function' is set to a
4351 function that returns a string or a list of strings, and if that
4352 function doesn't return nil, then that string (or list) is added
4353 to the front of the kill ring and the string (or first string in
4354 the list) is returned as the latest kill.
4356 If N is not zero, and if `yank-pop-change-selection' is
4357 non-nil, use `interprogram-cut-function' to transfer the
4358 kill at the new yank point into the window system selection.
4360 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4361 move the yanking point; just return the Nth kill forward."
4364 interprogram-paste-function
4368 ;; Disable the interprogram cut function when we add the new
4369 ;; text to the kill ring, so Emacs doesn't try to own the
4370 ;; selection, with identical text.
4380 kill-ring)))
4385 interprogram-cut-function)
4391 ;;;; Commands for manipulating the kill ring.
4394 "Non-nil means don't signal an error for killing read-only text."
4400 This deletes the text from the buffer and saves it in the kill ring.
4404 If you want to append the killed region to the last killed text,
4408 If the previous command was also a kill command,
4409 the text killed this time appends to the text killed last time
4410 to make one entry in the kill ring.
4412 The killed text is filtered by `filter-buffer-substring' before it is
4413 saved in the kill ring, so the actual saved text might be different
4414 from what was killed.
4416 If the buffer is read-only, Emacs will beep and refrain from deleting
4417 the text, but put the text in the kill ring anyway. This means that
4418 you can use the killing commands to copy text from a read-only buffer.
4420 Lisp programs should use this function for killing text.
4421 (To delete text, use `delete-region'.)
4422 Supply two arguments, character positions BEG and END indicating the
4423 stretch of text to be killed. If the optional argument REGION is
4424 non-nil, the function ignores BEG and END, and kills the current
4425 region instead."
4426 ;; Pass mark first, then point, because the order matters when
4427 ;; calling `kill-append'.
4436 ;; Add that string to the kill ring, one way or another.
4443 nil)
4445 ;; The code above failed because the buffer, or some of the characters
4446 ;; in the region, are read-only.
4447 ;; We should beep, in case the user just isn't aware of this.
4448 ;; However, there's no harm in putting
4449 ;; the region's text in the kill ring, anyway.
4451 ;; Set this-command now, so it will be set even if we get an error.
4453 ;; This should barf, if appropriate, and give us the correct error.
4456 ;; Signal an error if the buffer is read-only.
4458 ;; If the buffer isn't read-only, the text is.
4461 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4462 ;; to get two copies of the text when the user accidentally types M-w and
4463 ;; then corrects it with the intended C-w.
4465 "Save the region as if killed, but don't kill it.
4466 In Transient Mark mode, deactivate the mark.
4467 If `interprogram-cut-function' is non-nil, also save the text for a window
4468 system cut and paste.
4470 The copied text is filtered by `filter-buffer-substring' before it is
4471 saved in the kill ring, so the actual saved text might be different
4472 from what was in the buffer.
4474 When called from Lisp, save in the kill ring the stretch of text
4475 between BEG and END, unless the optional argument REGION is
4476 non-nil, in which case ignore BEG and END, and save the current
4477 region instead.
4479 This command's old key binding has been given to `kill-ring-save'."
4480 ;; Pass mark first, then point, because the order matters when
4481 ;; calling `kill-append'.
4491 nil)
4494 "Save the region as if killed, but don't kill it.
4495 In Transient Mark mode, deactivate the mark.
4496 If `interprogram-cut-function' is non-nil, also save the text for a window
4497 system cut and paste.
4499 If you want to append the killed line to the last killed text,
4502 The copied text is filtered by `filter-buffer-substring' before it is
4503 saved in the kill ring, so the actual saved text might be different
4504 from what was in the buffer.
4506 When called from Lisp, save in the kill ring the stretch of text
4507 between BEG and END, unless the optional argument REGION is
4508 non-nil, in which case ignore BEG and END, and save the current
4509 region instead.
4511 This command is similar to `copy-region-as-kill', except that it gives
4512 visual feedback indicating the extent of the region being copied."
4513 ;; Pass mark first, then point, because the order matters when
4514 ;; calling `kill-append'.
4518 ;; This use of called-interactively-p is correct because the code it
4519 ;; controls just gives the user visual feedback.
4524 "Indicate that the region text has been copied interactively.
4525 If the mark is visible in the selected window, blink the cursor
4526 between point and mark if there is currently no active region
4527 highlighting.
4529 If the mark lies outside the selected window, display an
4530 informative message containing a sample of the copied text. The
4531 optional argument MESSAGE-LEN, if non-nil, specifies the length
4532 of this sample text; it defaults to 40."
4535 ;; Inhibit quitting so we can make a quit here
4536 ;; look like a C-g typed as a command.
4539 ;; Swap point-and-mark quickly so as to show the region that
4540 ;; was selected. Don't do it if the region is highlighted.
4543 ;; Swap point and mark.
4547 ;; Swap back.
4550 ;; If user quit, deactivate the mark
4551 ;; as C-g would as a command.
4557 ;; Don't say "killed"; that is misleading.
4564 "Cause following command, if it kills, to add to previous kill.
4565 If the next command kills forward from point, the kill is
4566 appended to the previous killed text. If the command kills
4567 backward, the kill is prepended. Kill commands that act on the
4568 region, such as `kill-region', are regarded as killing forward if
4569 point is after mark, and killing backward if point is before
4570 mark.
4572 If the next command is not a kill command, `append-next-kill' has
4573 no effect.
4575 The argument is used for internal purposes; do not supply one."
4577 ;; We don't use (interactive-p), since that breaks kbd macros.
4591 "A subroutine of `squeeze-bidi-context'.
4592 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4596 lim1)
4603 ;; L and R categories include embedding and
4604 ;; override controls, but we don't want to
4605 ;; replace them, because that might change
4606 ;; the visual order. Likewise with PDF and
4607 ;; isolate controls.
4609 bidi-directional-non-controls-chars
4610 limit)))))
4611 ;; Replace any run of non-RTL characters by a single LRM.
4613 ;; No more characters of CATEGORY, we are done.
4618 ;; Skip directional controls, if any.
4623 "Replace characters between FROM and TO while keeping bidi context.
4625 This function replaces the region of text with as few characters
4626 as possible, while preserving the effect that region will have on
4627 bidirectional display before and after the region."
4631 ;; This is for when they copy text with read-only text
4632 ;; properties.
4636 ;; Replace each run of non-RTL characters with a single LRM.
4638 ;; Replace each run of non-LTR characters with a single RLM. Note
4639 ;; that the \cR category includes both the Arabic Letter (AL) and
4640 ;; R characters; here we ignore the distinction between them,
4641 ;; because that distinction only affects Arabic Number (AN)
4642 ;; characters, which are weak and don't affect the reordering.
4646 "Return buffer text between START and END with its bidi context.
4648 START and END are assumed to belong to the same physical line
4649 of buffer text. This function prepends and appends to the text
4650 between START and END bidi control characters that preserve the
4651 visual order of that text when it is inserted at some other place."
4656 substr para-dir from to)
4663 ;; If we don't have any mixed directional characters in the
4664 ;; entire line, we can just copy the substring without adding
4665 ;; any context.
4680 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4681 ;; (1) force the string to have the same base embedding
4682 ;; direction as the paragraph direction at the source, no matter
4683 ;; what is the paragraph direction at destination; and (2) avoid
4684 ;; affecting the visual order of the surrounding text at
4685 ;; destination if there are characters of different
4686 ;; directionality there.
4691 "Return portion of current buffer between START and END with bidi context.
4693 This function works similar to `buffer-substring', but it prepends and
4694 appends to the text bidi directional control characters necessary to
4695 preserve the visual appearance of the text if it is inserted at another
4696 place. This is useful when the buffer substring includes bidirectional
4697 text and control characters that cause non-trivial reordering on display.
4698 If copied verbatim, such text can have a very different visual appearance,
4699 and can also change the visual appearance of the surrounding text at the
4700 destination of the copy.
4702 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4703 the text properties."
4716 no-properties)))
4720 substr)))
4721 \f
4722 ;; Yanking.
4727 "List of special text property handling conditions for yanking.
4728 Each element should have the form (PROP . FUN), where PROP is a
4729 property symbol and FUN is a function. When the `yank' command
4730 inserts text into the buffer, it scans the inserted text for
4731 stretches of text that have `eq' values of the text property
4732 PROP; for each such stretch of text, FUN is called with three
4733 arguments: the property's value in that text, and the start and
4734 end positions of the text.
4736 This is done prior to removing the properties specified by
4737 `yank-excluded-properties'."
4740 function))
4743 ;; This is actually used in subr.el but defcustom does not work there.
4746 intangible invisible keymap local-map mouse-face read-only
4747 yank-handler)
4748 "Text properties to discard when yanking.
4749 The value should be a list of text properties to discard or t,
4750 which means to discard all text properties.
4752 See also `yank-handled-properties'."
4759 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4760 Function is called with two parameters, START and END corresponding to
4761 the value of the mark and point; it is guaranteed that START <= END.
4765 "Replace just-yanked stretch of killed text with a different stretch.
4766 This command is allowed only immediately after a `yank' or a `yank-pop'.
4767 At such a time, the region contains a stretch of reinserted
4768 previously-killed text. `yank-pop' deletes that text and inserts in its
4769 place a different stretch of killed text.
4771 With no argument, the previous kill is inserted.
4772 With argument N, insert the Nth previous kill.
4773 If N is negative, this is a more recent kill.
4775 The sequence of kills wraps around, so that after the oldest one
4776 comes the newest one.
4778 This command honors the `yank-handled-properties' and
4779 `yank-excluded-properties' variables, and the `yank-handler' text
4780 property, in the way that `yank' does."
4794 ;; Set the window start back where it was in the yank command,
4795 ;; if possible.
4798 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4799 ;; It is cleaner to avoid activation, even though the command
4800 ;; loop would deactivate the mark because we inserted text.
4803 nil)
4807 More precisely, reinsert the most recent kill, which is the
4808 stretch of killed text most recently killed OR yanked. Put point
4809 at the end, and set mark at the beginning without activating it.
4811 With argument N, reinsert the Nth most recent kill.
4813 This command honors the `yank-handled-properties' and
4814 `yank-excluded-properties' variables, and the `yank-handler' text
4815 property, as described below.
4817 Properties listed in `yank-handled-properties' are processed,
4818 then those listed in `yank-excluded-properties' are discarded.
4820 If STRING has a non-nil `yank-handler' property anywhere, the
4821 normal insert behavior is altered, and instead, for each contiguous
4822 segment of STRING that has a given value of the `yank-handler'
4823 property, that value is used as follows:
4825 The value of a `yank-handler' property must be a list of one to four
4826 elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
4827 FUNCTION, if non-nil, should be a function of one argument (the
4828 object to insert); FUNCTION is called instead of `insert'.
4829 PARAM, if present and non-nil, is passed to FUNCTION (to be handled
4830 in whatever way is appropriate; e.g. if FUNCTION is `yank-rectangle',
4831 PARAM may be a list of strings to insert as a rectangle). If PARAM
4832 is nil, then the current segment of STRING is used.
4833 If NOEXCLUDE is present and non-nil, the normal removal of
4834 `yank-excluded-properties' is not performed; instead FUNCTION is
4835 responsible for the removal. This may be necessary if FUNCTION
4836 adjusts point before or after inserting the object.
4837 UNDO, if present and non-nil, should be a function to be called
4838 by `yank-pop' to undo the insertion of the current PARAM. It is
4839 given two arguments, the start and end of the region. FUNCTION
4840 may set `yank-undo-function' to override UNDO.
4845 ;; If we don't get all the way thru, make last-command indicate that
4846 ;; for the following command.
4854 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4855 ;; It is cleaner to avoid activation, even though the command
4856 ;; loop would deactivate the mark because we inserted text.
4859 ;; If we do get all the way thru, make this-command indicate that.
4862 nil)
4865 "Rotate the yanking point in the kill ring.
4866 With ARG, rotate that many kills forward (or backward, if negative)."
4869 \f
4870 ;; Some kill commands.
4872 ;; Internal subroutine of delete-char
4878 ;; Internal subroutine of backward-delete-char
4885 "The method for untabifying when deleting backward.
4886 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4887 `hungry' -- delete all whitespace, both tabs and spaces;
4888 `all' -- delete all whitespace, including tabs, spaces and newlines;
4889 nil -- just delete one character."
4895 "Delete characters backward, changing tabs into spaces.
4896 The exact behavior depends on `backward-delete-char-untabify-method'.
4897 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4898 Interactively, ARG is the prefix arg (default 1)
4899 and KILLP is t if a prefix arg was specified."
4922 arg)))
4923 ;; Avoid warning about delete-backward-char
4927 "Kill up to and including ARGth occurrence of CHAR.
4928 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4929 Goes backward if ARG is negative; error if CHAR not found."
4932 ;; Avoid "obsolete" warnings for translation-table-for-input.
4940 ;; kill-line and its subroutines.
4943 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4948 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4949 With prefix argument ARG, kill that many lines from point.
4950 Negative arguments kill lines backward.
4951 With zero argument, kills the text before point on the current line.
4954 a number counts as a prefix arg.
4956 To kill a whole line, when point is not at the beginning, type \
4959 If `show-trailing-whitespace' is non-nil, this command will just
4960 kill the rest of the current line, even if there are only
4961 nonblanks there.
4963 If option `kill-whole-line' is non-nil, then this command kills the whole line
4964 including its terminating newline, when used at the beginning of a line
4965 with no argument. As a consequence, you can always kill a whole line
4968 If you want to append the killed line to the last killed text,
4971 If the buffer is read-only, Emacs will beep and refrain from deleting
4972 the line, but put the line in the kill ring anyway. This means that
4973 you can use this command to copy text from a read-only buffer.
4974 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4975 even beep.)"
4978 ;; It is better to move point to the other end of the kill
4979 ;; before killing. That way, in a read-only buffer, point
4980 ;; moves across the text that is copied to the kill ring.
4981 ;; The choice has no effect on undo now that undo records
4982 ;; the value of point from before the command was run.
4992 ;; If trailing whitespace is visible,
4993 ;; don't treat it as nothing.
5003 "Kill current line.
5004 With prefix ARG, kill that many lines starting from the current line.
5005 If ARG is negative, kill backward. Also kill the preceding newline.
5007 If ARG is zero, kill current line but exclude the trailing newline."
5018 ;; We need to kill in two steps, because the previous command
5019 ;; could have been a kill command, in which case the text
5020 ;; before point needs to be prepended to the current kill
5021 ;; ring entry and the text after point appended. Also, we
5022 ;; need to use save-excursion to avoid copying the same text
5023 ;; twice to the kill ring in read-only buffers.
5041 "Move forward by ARG lines, ignoring currently invisible newlines only.
5042 If ARG is negative, move backward -ARG lines.
5043 If ARG is zero, move to the beginning of the current line."
5050 ;; If the newline we just skipped is invisible,
5051 ;; don't count it.
5055 prop
5060 ;; If invisible text follows, and it is a number of complete lines,
5061 ;; skip it.
5067 prop
5083 ;; If the newline we just moved to is invisible,
5084 ;; don't count it.
5089 prop
5094 ;; If invisible text follows, and it is a number of complete lines,
5095 ;; skip it.
5101 prop
5112 nil)))
5115 "Move to end of current visible line."
5117 ;; If the following character is currently invisible,
5118 ;; skip all characters with that same `invisible' property value,
5119 ;; then find the next newline.
5126 prop
5135 \f
5137 "Insert after point the contents of BUFFER.
5138 Puts mark after the inserted text.
5139 BUFFER may be a buffer or a buffer name."
5149 t))))
5154 nil)
5157 "Append to specified buffer the text of the region.
5158 It is inserted into that buffer before its point.
5160 When calling from a program, give three arguments:
5161 BUFFER (or buffer name), START and END.
5162 START and END specify the portion of the current buffer to be copied."
5169 point)
5180 "Prepend to specified buffer the text of the region.
5181 It is inserted into that buffer after its point.
5183 When calling from a program, give three arguments:
5184 BUFFER (or buffer name), START and END.
5185 START and END specify the portion of the current buffer to be copied."
5194 "Copy to specified buffer the text of the region.
5195 It is inserted into that buffer, replacing existing text there.
5197 When calling from a program, give three arguments:
5198 BUFFER (or buffer name), START and END.
5199 START and END specify the portion of the current buffer to be copied."
5207 \f
5211 "Hook run when the mark becomes active.
5212 It is also run at the end of a command, if the mark is active and
5219 "Return this buffer's mark value as integer, or nil if never set.
5221 In Transient Mark mode, this function signals an error if
5222 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5223 or the argument FORCE is non-nil, it disregards whether the mark
5224 is active, and returns an integer or nil in the usual way.
5226 If you are using this in an editing command, you are most likely making
5227 a mistake; see the documentation of `set-mark'."
5232 ;; Behind display-selections-p.
5235 "Deactivate the mark.
5236 If Transient Mark mode is disabled, this function normally does
5237 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5239 Deactivating the mark sets `mark-active' to nil, updates the
5240 primary selection according to `select-active-regions', and runs
5241 `deactivate-mark-hook'.
5243 If Transient Mark mode was temporarily enabled, reset the value
5244 of the variable `transient-mark-mode'; if this causes Transient
5245 Mark mode to be disabled, don't change `mark-active' to nil or
5246 run `deactivate-mark-hook'."
5250 select-active-regions)
5253 ;; The var `saved-region-selection', if non-nil, is the text in
5254 ;; the region prior to the last command modifying the buffer.
5255 ;; Set the selection to that, or to the current region.
5260 ;; If another program has acquired the selection, region
5261 ;; deactivation should not clobber it (Bug#11772).
5280 "Activate the mark.
5281 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5291 "Set this buffer's mark to POS. Don't use this function!
5292 That is to say, don't use this function unless you want
5293 the user to see that the mark has moved, and you want the previous
5294 mark position to be lost.
5296 Normally, when a new mark is set, the old one should go on the stack.
5297 This is why most applications should use `push-mark', not `set-mark'.
5299 Novice Emacs Lisp programmers often try to use the mark for the wrong
5300 purposes. The mark saves a location for the user's convenience.
5301 Most editing commands should not alter the mark.
5302 To remember a location for internal use in the Lisp program,
5303 store it in a Lisp variable. Example:
5305 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5310 ;; Normally we never clear mark-active except in Transient Mark mode.
5311 ;; But when we actually clear out the mark value too, we must
5312 ;; clear mark-active in any mode.
5314 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5315 ;; it should never be nil if the mark is nil.
5323 mark-active))
5330 ;; Mark marker
5336 ;; Mark active
5339 ;; If mark is active now, and either was not active or was at a
5340 ;; different place, run the activate hook.
5345 ;; If mark has ceased to be active, run deactivate hook.
5350 "Like `save-excursion', but also save and restore the mark state.
5351 This macro does what `save-excursion' did before Emacs 25.1."
5361 If nil, region-aware commands treat the empty region as inactive.
5362 If non-nil, region-aware commands treat the region as active as
5363 long as the mark is active, even if the region is empty.
5365 Region-aware commands are those that act on the region if it is
5366 active and Transient Mark mode is enabled, and on the text near
5367 point otherwise."
5373 "Return t if the region is active and it is appropriate to act on it.
5374 This is used by commands that act specially on the region under
5375 Transient Mark mode.
5377 The return value is t if Transient Mark mode is enabled and the
5378 mark is active; furthermore, if `use-empty-active-region' is nil,
5379 the region must not be empty. Otherwise, the return value is nil.
5381 For some commands, it may be appropriate to ignore the value of
5382 `use-empty-active-region'; in that case, use `region-active-p'."
5387 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5389 Some commands act specially on the region when Transient Mark
5390 mode is enabled. Usually, such commands should use
5391 `use-region-p' instead of this function, because `use-region-p'
5392 also checks the value of `use-empty-active-region'."
5394 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5395 ;; without the mark being set (e.g. bug#17324). We really should fix
5396 ;; that problem, but in the mean time, let's make sure we don't say the
5397 ;; region is active when there's no mark.
5401 "Return non-nil if the region contains several pieces.
5402 An example is a rectangular region handled as a list of
5403 separate contiguous regions for each line."
5416 ;; Normal priority so that a large region doesn't hide all the
5417 ;; overlays within it, but high secondary priority so that if it
5418 ;; ends/starts in the middle of a small overlay, that small overlay
5419 ;; won't hide the region's boundaries.
5421 nrol)
5426 rol)))
5442 start end window rol)))
5445 new))))))
5448 "Hook run just before redisplay.
5449 It is called in each window that is to be redisplayed. It takes one argument,
5450 which is the window that will be redisplayed. When run, the `current-buffer'
5471 "Maximum size of mark ring. Start discarding off end if gets this big."
5479 "Maximum size of global mark ring. \
5480 Start discarding off end if gets this big."
5485 "Jump to mark, and pop a new position for mark off the ring.
5486 \(Does not affect global mark ring)."
5496 "Set mark at where point is.
5497 If no prefix ARG and mark is already set there, just activate it.
5498 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5510 will pop the mark twice, and
5512 will pop the mark three times.
5520 "Set the mark where point is, or jump to the mark.
5521 Setting the mark also alters the region, which is the text
5522 between point and mark; this is the closest equivalent in
5525 With no prefix argument, set the mark at point, and push the
5526 old mark position on local mark ring. Also push the old mark on
5527 global mark ring, if the previous mark was set in another buffer.
5529 When Transient Mark Mode is off, immediately repeating this
5530 command activates `transient-mark-mode' temporarily.
5533 jump to the mark, and set the mark from
5534 position popped off the local mark ring (this does not affect the global
5536 mark ring (see `pop-global-mark').
5538 If `set-mark-command-repeat-pop' is non-nil, repeating
5540 off the local (or global) mark ring and jumps there.
5543 argument, unconditionally set mark where point is, even if
5544 `set-mark-command-repeat-pop' is non-nil.
5546 Novice Emacs Lisp programmers often try to use the mark for the wrong
5547 purposes. See the documentation of `set-mark' for more information."
5567 arg)
5581 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5582 If the last global mark pushed was not in the current buffer,
5583 also push LOCATION on the global mark ring.
5584 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5586 Novice Emacs Lisp programmers often try to use the mark for the wrong
5587 purposes. See the documentation of `set-mark' for more information.
5589 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5596 ;; Now push the mark on the global mark ring.
5599 ;; The last global mark pushed was in this same buffer.
5600 ;; Don't push another one.
5601 nil
5610 nil)
5613 "Pop off mark ring into the buffer's actual mark.
5614 Does not set point. Does nothing if mark ring is empty."
5626 "Put the mark where point is now, and point where the mark is now.
5627 This command works even when the mark is not active,
5628 and it reactivates the mark.
5630 If Transient Mark mode is on, a prefix ARG deactivates the mark
5631 if it is active, and otherwise avoids reactivating it. If
5632 Transient Mark mode is off, a prefix ARG enables Transient Mark
5633 mode temporarily."
5647 nil))
5650 "When non-nil, shifted motion keys activate the mark momentarily.
5652 While the mark is activated in this way, any shift-translated point
5653 motion key extends the region, and if Transient Mark mode was off, it
5654 is temporarily turned on. Furthermore, the mark will be deactivated
5655 by any subsequent point motion key that was not shift-translated, or
5656 by any action that normally deactivates the mark in Transient Mark mode.
5658 See `this-command-keys-shift-translated' for the meaning of
5659 shift-translation."
5664 "Activate/deactivate mark depending on invocation thru shift translation.
5665 This function is called by `call-interactively' when a command
5666 with a `^' character in its `interactive' spec is invoked, before
5667 running the command itself.
5669 If `shift-select-mode' is enabled and the command was invoked
5670 through shift translation, set the mark and activate the region
5671 temporarily, unless it was already set in this way. See
5672 `this-command-keys-shift-translated' for the meaning of shift
5673 translation.
5675 Otherwise, if the region has been activated temporarily,
5676 deactivate it, and restore the variable `transient-mark-mode' to
5677 its earlier value."
5684 transient-mark-mode)))
5693 "Toggle Transient Mark mode.
5694 With a prefix argument ARG, enable Transient Mark mode if ARG is
5695 positive, and disable it otherwise. If called from Lisp, enable
5696 Transient Mark mode if ARG is omitted or nil.
5698 Transient Mark mode is a global minor mode. When enabled, the
5699 region is highlighted with the `region' face whenever the mark
5701 and after certain other operations that set the mark but whose
5702 main purpose is something else--for example, incremental search,
5708 Many commands change their behavior when Transient Mark mode is
5709 in effect and the mark is active, by acting on the region instead
5710 of their usual default part of the buffer's text. Examples of
5713 To see the documentation of commands which are sensitive to the
5716 :global t
5717 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5721 "Non-nil means it is ok for commands to call `widen' when they want to.
5722 Some commands will do this in order to go to positions outside
5723 the current accessible part of the buffer.
5725 If `widen-automatically' is nil, these commands will do something else
5729 "Whether the currently executing code is performing an essential task.
5730 This variable should be non-nil only when running code which should not
5731 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5732 user for a password when we are simply scanning a set of files in the
5733 background or displaying possible completions before the user even asked
5737 "Pop off global mark ring and jump to the top location."
5739 ;; Pop entries which refer to non-existent buffers.
5757 \f
5759 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5765 "Move cursor vertically down ARG lines.
5766 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5767 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5768 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5769 function will not vscroll.
5771 ARG defaults to 1.
5773 If there is no character in the target line exactly under the current column,
5774 the cursor is positioned after the character in that line which spans this
5775 column, or at the end of the line if it is not long enough.
5776 If there is no line in the buffer after this one, behavior depends on the
5777 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5778 to create a line, and moves the cursor to that line. Otherwise it moves the
5779 cursor to the end of the buffer.
5781 If the variable `line-move-visual' is non-nil, this command moves
5782 by display lines. Otherwise, it moves by buffer lines, without
5783 taking variable-width characters or continued lines into account.
5787 a semipermanent goal column for this command.
5788 Then instead of trying to move exactly vertically (or as close as possible),
5789 this command moves to the specified goal column (or as close as possible).
5790 The goal column is stored in the variable `goal-column', which is nil
5791 when there is no goal column. Note that setting `goal-column'
5792 overrides `line-move-visual' and causes this command to move by buffer
5793 lines rather than by display lines."
5799 ;; When adding a newline, don't expand an abbrev.
5810 nil)
5813 "Move cursor vertically up ARG lines.
5814 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5815 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5816 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5817 function will not vscroll.
5819 ARG defaults to 1.
5821 If there is no character in the target line exactly over the current column,
5822 the cursor is positioned after the character in that line which spans this
5823 column, or at the end of the line if it is not long enough.
5825 If the variable `line-move-visual' is non-nil, this command moves
5826 by display lines. Otherwise, it moves by buffer lines, without
5827 taking variable-width characters or continued lines into account.
5831 a semipermanent goal column for this command.
5832 Then instead of trying to move exactly vertically (or as close as possible),
5833 this command moves to the specified goal column (or as close as possible).
5834 The goal column is stored in the variable `goal-column', which is nil
5835 when there is no goal column. Note that setting `goal-column'
5836 overrides `line-move-visual' and causes this command to move by buffer
5837 lines rather than by display lines."
5848 nil)
5851 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5852 This means moving to the end of each line moved onto.
5853 The beginning of a blank line does not count as the end of a line.
5854 This has no effect when the variable `line-move-visual' is non-nil."
5860 A non-nil setting overrides the variable `line-move-visual', which see."
5867 "Current goal column for vertical motion.
5868 It is the column where point was at the start of the current run
5869 of vertical motion commands.
5871 When moving by visual lines via the function `line-move-visual', it is a cons
5872 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5873 divided by the default column width, and HSCROLL is the number of
5874 columns by which window is scrolled from left margin.
5876 When the `track-eol' feature is doing its job, the value is
5880 "Non-nil means commands that move by lines ignore invisible newlines.
5881 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5882 as if newlines that are invisible didn't exist, and count
5883 only visible newlines. Thus, moving across across 2 newlines
5884 one of which is invisible will be counted as a one-line move.
5885 Also, a non-nil value causes invisible text to be ignored when
5886 counting columns for the purposes of keeping point in the same
5889 Outline mode sets this."
5894 "When non-nil, `line-move' moves point by visual lines.
5895 This movement is based on where the cursor is displayed on the
5896 screen, instead of relying on buffer contents alone. It takes
5897 into account variable-width characters and line continuation.
5898 If nil, `line-move' moves point by logical lines.
5899 A non-nil setting of `goal-column' overrides the value of this variable
5900 and forces movement by logical lines.
5901 A window that is horizontally scrolled also forces movement by logical
5902 lines."
5907 ;; Only used if display-graphic-p.
5911 "Return the height in pixels of the current buffer's default face font.
5913 If the default font is remapped (see `face-remapping-alist'), the
5914 function returns the height of the remapped face."
5918 ;; Avoid calling font-info if the frame's default font was
5919 ;; not changed since the frame was created. That's because
5920 ;; font-info is expensive for some fonts, see bug #14838.
5926 "Return the width in pixels of the current buffer's default face font.
5928 If the default font is remapped (see `face-remapping-alist'), the
5929 function returns the width of the remapped face."
5933 ;; Avoid calling font-info if the frame's default font was
5934 ;; not changed since the frame was created. That's because
5935 ;; font-info is expensive for some fonts, see bug #14838.
5940 width
5945 "Return the pixel height of current buffer's default-face text line.
5947 The value includes `line-spacing', if any, defined for the buffer
5948 or the frame."
5961 "Return the number of screen lines in the text area of the selected window.
5963 This is different from `window-text-height' in that this function counts
5964 lines in units of the height of the font used by the default face displayed
5965 in the window, not in units of the frame's default font, and also accounts
5966 for `line-spacing', if any, defined for the window's buffer or frame.
5968 The value is a floating-point number."
5973 ;; Returns non-nil if partial move was done.
5976 ;; Move backward (up).
5977 ;; If already vscrolled, reduce vscroll
5983 ;; Move forward (down).
5996 py vs last-line)
6016 col-row)
6021 ;; VPOS > 0 means the last line is only partially visible.
6022 ;; But if the part that is visible is at least as tall as the
6023 ;; default font, that means the line is actually fully
6024 ;; readable, and something like line-spacing is hidden. So in
6025 ;; that case we accept the last line in the window as still
6026 ;; visible, and consider the margin as starting one line
6027 ;; later.
6035 ;; If last line of window is fully visible, and vscrolling
6036 ;; more would make this line invisible, move forward.
6041 nil)
6042 ;; If cursor is not in the bottom scroll margin, and the
6043 ;; current line is is not too tall, move forward.
6045 vpos
6048 nil)
6049 ;; When already vscrolled, we vscroll some more if we can,
6050 ;; or clear vscroll and move forward at end of tall image.
6055 ;; If cursor just entered the bottom scroll margin, move forward,
6056 ;; but also optionally vscroll one line so redisplay won't recenter.
6060 ;; Don't vscroll if the partially-visible line at window
6061 ;; bottom is not too tall (a.k.a. "just one more text
6062 ;; line"): in that case, we do want redisplay to behave
6063 ;; normally, i.e. recenter or whatever.
6064 ;;
6065 ;; Note: ROWH + RBOT from the value returned by
6066 ;; pos-visible-in-window-p give the total height of the
6067 ;; partially-visible glyph row at the end of the window. As
6068 ;; we are dealing with floats, we disregard sub-pixel
6069 ;; discrepancies between that and DLH.
6073 t)
6074 ;; If there are lines above the last line, scroll-up one line.
6077 t)
6078 ;; Finally, start vscroll.
6083 ;; This is like line-move-1 except that it also performs
6084 ;; vertical scrolling of tall images if appropriate.
6085 ;; That is not really a clean thing to do, since it mixes
6086 ;; scrolling with cursor motion. But so far we don't have
6087 ;; a cleaner solution to the problem of making C-n do something
6088 ;; useful given a tall image.
6090 "Move forward ARG lines.
6091 If NOERROR, don't signal an error if we can't move ARG lines.
6092 TO-END is unused.
6093 TRY-VSCROLL controls whether to vscroll tall lines: if either
6094 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6095 not vscroll."
6099 ;; Only vscroll for single line moves
6101 ;; Under scroll-conservatively, the display engine
6102 ;; does this better.
6104 ;; But don't vscroll in a keyboard macro.
6110 ;; Display-based column are incompatible with goal-column.
6112 ;; When the text in the window is scrolled to the left,
6113 ;; display-based motion doesn't make sense (because each
6114 ;; logical line occupies exactly one screen line).
6116 ;; Likewise when the text _was_ scrolled to the left
6117 ;; when the current run of vertical motion commands
6118 ;; started.
6121 auto-hscroll-mode
6123 (>= temporary-goal-column
6126 ;; If we moved into a tall line, set vscroll to make
6127 ;; scrolling through tall images more smooth.
6131 winh)
6137 nil
6141 ;; Display-based alternative to line-move-1.
6142 ;; Arg says how many lines to move. The value is t if we can move the
6143 ;; specified number of lines.
6145 "Move ARG lines forward.
6146 If NOERROR, don't signal an error if we can't move that many lines."
6149 target-hscroll)
6150 ;; Check if the previous command was a line-motion command, or if
6151 ;; we were called from some other command.
6154 ;; If so, there's no need to reset `temporary-goal-column',
6155 ;; but we may need to hscroll.
6159 ;; Otherwise, we should reset `temporary-goal-column'.
6161 x-pos)
6163 ;; Handle the `overflow-newline-into-fringe' case:
6168 ;; In R2L lines, the X pixel coordinate is measured from the
6169 ;; left edge of the window, but columns are still counted
6170 ;; from the logical-order beginning of the line, i.e. from
6171 ;; the right edge in this case. We need to adjust for that.
6177 hscroll)))
6179 ;; When we move beyond the first/last character visible in
6180 ;; the window, posn-at-point will return nil, so we need to
6181 ;; approximate the goal column as below.
6186 ;; vertical-motion can move more than it was asked to if it moves
6187 ;; across display strings with newlines. We don't want to ring
6188 ;; the bell and announce beginning/end of buffer in that case.
6194 temporary-goal-column))
6195 arg))
6196 arg))
6202 temporary-goal-column))
6203 arg))
6204 arg)))
6207 ;; If the goal column lies on a display string,
6208 ;; `vertical-motion' advances the cursor to the end
6209 ;; of the string. For arg < 0, this can cause the
6210 ;; cursor to get stuck. (Bug#3020).
6214 nil)))))
6216 ;; This is the guts of next-line and previous-line.
6217 ;; Arg says how many lines to move.
6218 ;; The value is t if we can move the specified number of lines.
6220 ;; Don't run any point-motion hooks, and disregard intangibility,
6221 ;; for intermediate positions.
6233 ;; Don't count beg of empty line as end of line
6234 ;; unless we just did explicit end-of-line.
6236 most-positive-fixnum
6240 line-move-ignore-invisible))
6241 ;; Use just newline characters.
6242 ;; Set ARG to 0 if we move as many lines as requested.
6245 ;; This way of moving forward ARG lines
6246 ;; verifies that we have a newline after the last one.
6247 ;; It doesn't get confused by intangible text.
6256 'beginning-of-buffer
6258 nil)))
6259 ;; Move by arg lines, but ignore invisible ones.
6262 ;; If the following character is currently invisible,
6263 ;; skip all characters with that same `invisible' property value.
6266 ;; Move a line.
6267 ;; We don't use `end-of-line', since we want to escape
6268 ;; from field boundaries occurring exactly at point.
6274 ;; If there's no invisibility here, move over the newline.
6283 ;; We avoid vertical-motion when possible
6284 ;; because that has to fontify.
6286 ;; Otherwise move a more sophisticated way.
6293 ;; The logic of this is the same as the loop above,
6294 ;; it just goes in the other direction.
6296 ;; For completely consistency with the forward-motion
6297 ;; case, we should call beginning-of-line here.
6298 ;; However, if point is inside a field and on a
6299 ;; continued line, the call to (vertical-motion -1)
6300 ;; below won't move us back far enough; then we return
6301 ;; to the same column in line-move-finish, and point
6302 ;; gets stuck -- cyd
6320 ;; if our target is the middle of this line.
6325 ;; This is the value the function returns.
6329 ;; If we did not move down as far as desired, at least go
6330 ;; to end of line. Be sure to call point-entered and
6331 ;; point-left-hooks.
6337 ;; If we did not move up as far as desired,
6338 ;; at least go to beginning of line.
6350 ;; Set REPEAT to t to repeat the whole thing.
6357 ;; Compute the end of the line
6358 ;; ignoring effectively invisible newlines.
6360 ;; Like end-of-line but ignores fields.
6367 ;; Move to the desired column.
6370 ;; Corner case: suppose we start out in a field boundary in
6371 ;; the middle of a continued line. When we get to
6372 ;; line-move-finish, point is at the start of a new *screen*
6373 ;; line but the same text line; then line-move-to-column would
6374 ;; move us backwards. Test using C-n with point on the "x" in
6375 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6382 ;; Process intangibility within a line.
6383 ;; With inhibit-point-motion-hooks bound to nil, a call to
6384 ;; goto-char moves point past intangible text.
6386 ;; However, inhibit-point-motion-hooks controls both the
6387 ;; intangibility and the point-entered/point-left hooks. The
6388 ;; following hack avoids calling the point-* hooks
6389 ;; unnecessarily. Note that we move *forward* past intangible
6390 ;; text when the initial and final points are the same.
6395 ;; If intangibility moves us to a different (later) place
6396 ;; in the same line, use that as the destination.
6399 ;; If that position is "too late",
6400 ;; try the previous allowable position.
6401 ;; See if it is ok.
6404 ;; If going forward, don't accept the previous
6405 ;; allowable position if it is before the target line.
6407 ;; If going backward, don't accept the previous
6408 ;; allowable position if it is still after the target line.
6411 ;; As a last resort, use the end of the line.
6414 ;; Now move to the updated destination, processing fields
6415 ;; as well as intangibility.
6419 ;; Ignore field boundaries if the initial and final
6420 ;; positions have the same `field' property, even if the
6421 ;; fields are non-contiguous. This seems to be "nicer"
6422 ;; behavior in many situations.
6425 new
6429 ;; If all this moved us to a different line,
6430 ;; retry everything within that new line.
6432 ;; Repeat the intangibility and field processing.
6436 "Try to find column COL, considering invisibility.
6437 This function works only in certain cases,
6438 because what we really need is for `move-to-column'
6439 and `current-column' to be able to ignore invisible text."
6448 ;; If the following character is currently invisible,
6449 ;; skip all characters with that same `invisible' property value.
6453 ;; Have we advanced to a larger column position?
6455 ;; We have made some progress towards the desired column.
6456 ;; See if we can make any further progress.
6458 ;; Otherwise, go to the place we originally found
6459 ;; and move back over invisible text.
6460 ;; that will get us to the same place on the screen
6461 ;; but with a more reasonable buffer position.
6464 ;; We want the real line beginning, so it's consistent
6465 ;; with bolp below, otherwise we might infloop.
6472 "Move point to end of current line as displayed.
6473 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6474 If point reaches the beginning or end of buffer, it stops there.
6476 To ignore the effects of the `intangible' text or overlay
6477 property, bind `inhibit-point-motion-hooks' to t.
6478 If there is an image in the current line, this function
6479 disregards newlines that are part of the text on which the image
6480 rests."
6490 ;; With bidi reordering, we may not be at bol,
6491 ;; so make sure we are.
6506 ;; If we skipped something intangible and now we're not
6507 ;; really at eol, keep going.
6512 "Move point to beginning of current line as displayed.
6513 \(If there's an image in the line, this disregards newlines
6514 which are part of the text that the image rests on.)
6516 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6517 If point reaches the beginning or end of buffer, it stops there.
6518 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6523 first-vis first-vis-field-value)
6525 ;; Move by lines, if ARG is not 1 (the default).
6530 ;; Move to beginning-of-line, ignoring fields and invisible text.
6536 ;; Now find first visible char in the line.
6541 ;; See if fields would stop us from reaching FIRST-VIS.
6546 ;; If yes, obey them.
6547 first-vis-field-value
6548 ;; Otherwise, move to START with attention to fields.
6549 ;; (It is possible that fields never matter in this case.)
6554 ;; Many people have said they rarely use this feature, and often type
6555 ;; it by accident. Maybe it shouldn't even be on a key.
6560 Those commands will move to this position in the line moved to
6561 rather than trying to keep the same horizontal position.
6562 With a non-nil argument ARG, clears out the goal column
6564 The goal column is stored in the variable `goal-column'.
6565 This is a buffer-local setting."
6572 ;; The older method below can be erroneous if `set-goal-column' is bound
6573 ;; to a sequence containing %
6574 ;;(message (substitute-command-keys
6575 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6576 ;;goal-column)
6583 )
6584 nil)
6585 \f
6586 ;;; Editing based on visual lines, as opposed to logical lines.
6589 "Move point to end of current visual line.
6590 With argument N not nil or 1, move forward N - 1 visual lines first.
6591 If point reaches the beginning or end of buffer, it stops there.
6592 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6598 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6599 ;; constrain to field boundaries, so we don't either.
6603 "Move point to beginning of current visual line.
6604 With argument N not nil or 1, move forward N - 1 visual lines first.
6605 If point reaches the beginning or end of buffer, it stops there.
6606 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6614 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6618 "Kill the rest of the visual line.
6619 With prefix argument ARG, kill that many visual lines from point.
6620 If ARG is negative, kill visual lines backward.
6621 If ARG is zero, kill the text before point on the current visual
6622 line.
6624 If you want to append the killed line to the last killed text,
6627 If the buffer is read-only, Emacs will beep and refrain from deleting
6628 the line, but put the line in the kill ring anyway. This means that
6629 you can use this command to copy text from a read-only buffer.
6630 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6631 even beep.)"
6633 ;; Like in `kill-line', it's better to move point to the other end
6634 ;; of the kill before killing.
6642 ;; Skip any trailing whitespace at the end of the visual line.
6643 ;; We used to do this only if `show-trailing-whitespace' is
6644 ;; nil, but that's wrong; the correct thing would be to check
6645 ;; whether the trailing whitespace is highlighted. But, it's
6646 ;; OK to just do this unconditionally.
6653 "Move cursor vertically down ARG lines.
6654 This is identical to `next-line', except that it always moves
6655 by logical lines instead of visual lines, ignoring the value of
6656 the variable `line-move-visual'."
6663 "Move cursor vertically up ARG lines.
6664 This is identical to `previous-line', except that it always moves
6665 by logical lines instead of visual lines, ignoring the value of
6666 the variable `line-move-visual'."
6673 "Editing based on visual lines."
6682 ;; These keybindings interfere with xterm function keys. Are
6683 ;; there any other suitable bindings?
6684 ;; (define-key map "\M-[" 'previous-logical-line)
6685 ;; (define-key map "\M-]" 'next-logical-line)
6686 map))
6689 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6690 The value should be a list of the form (LEFT RIGHT), where LEFT
6691 and RIGHT are symbols representing the bitmaps to display, to
6692 indicate wrapped lines, in the left and right fringes respectively.
6693 See also `fringe-indicator-alist'.
6694 The default is not to display fringe indicators for wrapped lines.
6695 This variable does not affect fringe indicators displayed for
6696 other purposes."
6711 'continuation
6718 "Toggle visual line based editing (Visual Line mode).
6719 With a prefix argument ARG, enable Visual Line mode if ARG is
6720 positive, and disable it otherwise. If called from Lisp, enable
6721 the mode if ARG is omitted or nil.
6723 When Visual Line mode is enabled, `word-wrap' is turned on in
6724 this buffer, and simple editing commands are redefined to act on
6725 visual lines, not logical lines. See Info node `Visual Line
6726 Mode' for details."
6727 :keymap visual-line-mode-map
6733 ;; Save the local values of some variables, to be restored if
6734 ;; visual-line-mode is turned off.
6736 truncate-partial-width-windows
6737 word-wrap fringe-indicator-alist))
6740 visual-line--saved-state)))
6744 word-wrap t
6745 fringe-indicator-alist
6747 fringe-indicator-alist)))
6761 visual-line-mode turn-on-visual-line-mode)
6763 \f
6765 "Interchange characters around point, moving forward one character.
6766 With prefix arg ARG, effect is to take character before point
6767 and drag it forward past ARG other characters (backward if ARG negative).
6768 If no argument and at end of line, the previous two chars are exchanged."
6776 "Interchange words around point, leaving point at end of them.
6777 With prefix arg ARG, effect is to take word before or around point
6778 and drag it forward past ARG other words (backward if ARG negative).
6779 If ARG is zero, the words around or after point and around or after mark
6780 are interchanged."
6781 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6787 Does not work on a sexp that point is in the middle of
6788 if it is a list or string."
6792 ;; Here we should try to simulate the behavior of
6793 ;; (cons (progn (forward-sexp x) (point))
6794 ;; (progn (forward-sexp (- x)) (point)))
6795 ;; Except that we don't want to rely on the second forward-sexp
6796 ;; putting us back to where we want to be, since forward-sexp-function
6797 ;; might do funny things like infix-precedence.
6802 ;; Jumping over a symbol. We might be inside it, mind you.
6807 ;; Otherwise, we're between sexps. Take a step back before jumping
6808 ;; to make sure we'll obey the same precedence no matter which direction
6809 ;; we're going.
6814 'skip-syntax-forward
6821 "Exchange current line and previous line, leaving point after both.
6822 With argument ARG, takes previous line and moves it past ARG lines.
6823 With argument 0, interchanges line point is in with line mark is in."
6829 ;; Move forward over ARG lines,
6830 ;; but create newlines if necessary.
6837 arg))
6839 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6840 ;; which seems inconsistent with the ARG /= 0 case.
6841 ;; FIXME document SPECIAL.
6843 "Subroutine to do the work of transposing objects.
6844 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6845 moves forward by units of the given object (e.g. forward-sentence,
6846 forward-paragraph). If ARG is zero, exchanges the current object
6847 with the one containing mark. If ARG is an integer, moves the
6848 current object past ARG following (if ARG is positive) or
6849 preceding (if ARG is negative) objects, leaving point after the
6850 current object."
6855 pos1 pos2)
6884 ;; This sequence of insertions attempts to preserve marker
6885 ;; positions at the start and end of the transposed objects.
6899 \f
6901 "Move backward until encountering the beginning of a word.
6902 With argument ARG, do this that many times.
6903 If ARG is omitted or nil, move point backward one word.
6905 The word boundaries are normally determined by the buffer's syntax
6906 table, but `find-word-boundary-function-table', such as set up
6907 by `subword-mode', can change that. If a Lisp program needs to
6908 move by words determined strictly by the syntax table, it should
6909 use `backward-word-strictly' instead."
6914 "Set mark ARG words away from point.
6916 move to with the same argument.
6917 Interactively, if this command is repeated
6918 or (in Transient Mark mode) if the mark is active,
6919 it marks the next ARG words after the ones already marked."
6936 nil t))))
6939 "Kill characters forward until encountering the end of a word.
6940 With argument ARG, do this that many times."
6945 "Kill characters backward until encountering the beginning of a word.
6946 With argument ARG, do this that many times."
6951 "Return the symbol or word that point is on (or a nearby one) as a string.
6952 The return value includes no text properties.
6953 If optional arg STRICT is non-nil, return nil unless point is within
6954 or adjacent to a symbol or word. In all cases the value can be nil
6955 if there is no word nearby.
6956 The function, belying its name, normally finds a symbol.
6957 If optional arg REALLY-WORD is non-nil, it finds just a word."
6966 ;; Point is neither within nor adjacent to a word.
6968 ;; Look for preceding word in same line.
6971 ;; No preceding word in same line.
6972 ;; Look for following word in same line.
6981 ;; If we found something nonempty, return it as a string.
6984 \f
6986 "String for filling to insert at front of new line, or nil for none."
6988 string)
6994 "Regexp to match lines which should not be auto-filled."
6996 regexp)
7000 "The default value for `normal-auto-fill-function'.
7001 This is the default auto-fill function, some major modes use a different one.
7002 Returns t if it really did any work."
7012 nil ;; Auto-filling not required
7016 ;; Choose a fill-prefix automatically.
7024 ;; Use auto-indentation rather than a guessed empty prefix.
7030 ;; Determine where to split the line.
7043 ;; See whether the place we found is any good.
7047 ;; There is no use breaking at end of line.
7049 ;; It is futile to split at the end of the prefix
7050 ;; since we would just insert the prefix again.
7052 ;; Don't split right after a comment starter
7053 ;; since we would just make another comment starter.
7058 limit t)
7060 ;; No good place to break => stop trying.
7062 ;; Ok, we have a useful place to break the line. Do it.
7064 ;; If point is at the fill-point, do not `save-excursion'.
7065 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7066 ;; point will end up before it rather than after it.
7074 ;; Now do justification, if required
7079 ;; If making the new line didn't reduce the hpos of
7080 ;; the end of the line, then give up now;
7081 ;; trying again will not help.
7084 ;; Justify last line.
7086 t)))
7089 "Mode-specific function which line breaks and continues a comment.
7090 This function is called during auto-filling when a comment syntax
7091 is defined.
7092 The function should take a single optional argument, which is a flag
7096 "Break line at point and indent.
7097 If a comment syntax is defined, call `comment-indent-new-line'.
7099 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7100 unless optional argument SOFT is non-nil."
7104 ;; Insert the newline before removing empty space so that markers
7105 ;; get preserved better.
7111 ;; Blindly trust a non-adaptive fill-prefix.
7117 ;; If there's an adaptive prefix, use it unless we're inside
7118 ;; a comment and the prefix is not a comment starter.
7122 ;; If we're not inside a comment, just try to indent.
7126 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7130 ;; `functions' and `hooks' are usually unsafe to set, but setting
7131 ;; auto-fill-function to nil in a file-local setting is safe and
7132 ;; can be useful to prevent auto-filling.
7136 "Toggle automatic line breaking (Auto Fill mode).
7137 With a prefix argument ARG, enable Auto Fill mode if ARG is
7138 positive, and disable it otherwise. If called from Lisp, enable
7139 the mode if ARG is omitted or nil.
7141 When Auto Fill mode is enabled, inserting a space at a column
7142 beyond `current-fill-column' automatically breaks the line at a
7143 previous space.
7145 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7146 non-nil.
7148 The value of `normal-auto-fill-function' specifies the function to use
7149 for `auto-fill-function' when turning Auto Fill mode on."
7154 ;; This holds a document string used to document auto-fill-mode.
7156 "Automatically break line at a previous space, in insertion of text."
7157 nil)
7160 "Unconditionally turn on Auto Fill mode."
7164 "Unconditionally turn off Auto Fill mode."
7170 "Set `fill-column' to specified argument.
7175 ;; We used to use current-column silently, but C-x f is too easily
7176 ;; typed as a typo for C-x C-f, so we turned it into an error and
7177 ;; now an interactive prompt.
7182 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7186 \f
7188 "Set `selective-display' to ARG; clear it if no arg.
7189 When the value of `selective-display' is a number > 0,
7190 lines whose indentation is >= that value are not displayed.
7191 The variable `selective-display' has a separate value for each buffer."
7211 "Toggle truncating of long lines for the current buffer.
7212 When truncating is off, long lines are folded.
7213 With prefix argument ARG, truncate long lines if ARG is positive,
7214 otherwise fold them. Note that in side-by-side windows, this
7215 command has no effect if `truncate-partial-width-windows' is
7216 non-nil."
7228 nil t)))
7233 "Toggle whether to use word-wrapping for continuation lines.
7234 With prefix argument ARG, wrap continuation lines at word boundaries
7235 if ARG is positive, otherwise wrap them at the right screen edge.
7236 This command toggles the value of `word-wrap'. It has no effect
7237 if long lines are truncated."
7253 "Toggle Overwrite mode.
7254 With a prefix argument ARG, enable Overwrite mode if ARG is
7255 positive, and disable it otherwise. If called from Lisp, enable
7256 the mode if ARG is omitted or nil.
7258 When Overwrite mode is enabled, printing characters typed in
7259 replace existing text on a one-for-one basis, rather than pushing
7260 it to the right. At the end of a line, such characters extend
7261 the line. Before a tab, such characters insert until the tab is
7263 overwrite mode; this is supposed to make it easier to insert
7264 characters when necessary."
7269 "Toggle Binary Overwrite mode.
7270 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7271 is positive, and disable it otherwise. If called from Lisp,
7272 enable the mode if ARG is omitted or nil.
7274 When Binary Overwrite mode is enabled, printing characters typed
7275 in replace existing text. Newlines are not treated specially, so
7276 typing at the end of a line joins the line to the next, with the
7277 typed character between them. Typing before a tab character
7278 simply replaces the tab with the character typed.
7280 ordinary typing characters do.
7282 Note that Binary Overwrite mode is not its own minor mode; it is
7283 a specialization of overwrite mode, entered by setting the
7284 `overwrite-mode' variable to `overwrite-mode-binary'."
7289 "Toggle line number display in the mode line (Line Number mode).
7290 With a prefix argument ARG, enable Line Number mode if ARG is
7291 positive, and disable it otherwise. If called from Lisp, enable
7292 the mode if ARG is omitted or nil.
7294 Line numbers do not appear for very large buffers and buffers
7295 with very long lines; see variables `line-number-display-limit'
7296 and `line-number-display-limit-width'."
7300 "Toggle column number display in the mode line (Column Number mode).
7301 With a prefix argument ARG, enable Column Number mode if ARG is
7302 positive, and disable it otherwise.
7304 If called from Lisp, enable the mode if ARG is omitted or nil."
7308 "Toggle buffer size display in the mode line (Size Indication mode).
7309 With a prefix argument ARG, enable Size Indication mode if ARG is
7310 positive, and disable it otherwise.
7312 If called from Lisp, enable the mode if ARG is omitted or nil."
7316 "Toggle auto-saving in the current buffer (Auto Save mode).
7317 With a prefix argument ARG, enable Auto Save mode if ARG is
7318 positive, and disable it otherwise.
7320 If called from Lisp, enable the mode if ARG is omitted or nil."
7322 ;; If auto-save is off because buffer has shrunk,
7323 ;; then toggling should turn it on.
7331 buffer-file-name)
7333 ;; If -1 was stored here, to temporarily turn off saving,
7334 ;; turn it back on.
7337 \f
7339 "Blinking matching of parens and expressions."
7344 "Non-nil means show matching open-paren when close-paren is inserted.
7345 If t, highlight the paren. If `jump', briefly move cursor to its
7346 position. If `jump-offscreen', move cursor there even if the
7347 position is off screen. With any other non-nil value, the
7348 off-screen position of the opening paren will be shown in the
7349 echo area."
7358 "Non-nil means show matching open-paren when it is on screen.
7359 If nil, don't show it (but the open-paren can still be shown
7360 in the echo area when it is off screen).
7362 This variable has no effect if `blink-matching-paren' is nil.
7363 \(In that case, the open-paren is never shown.)
7364 It is also ignored if `show-paren-mode' is enabled."
7369 "If non-nil, maximum distance to search backwards for matching open-paren.
7370 If nil, search stops at the beginning of the accessible portion of the buffer."
7376 "Time in seconds to delay after showing a matching paren."
7381 "If nil, `blink-matching-paren' ignores comments.
7382 More precisely, when looking for the matching parenthesis,
7383 it skips the contents of comments that end before point."
7388 "Return whether or not START...END are matching parens.
7389 END is the current point and START is the blink position.
7390 START might be nil if no matching starter was found.
7391 Returns non-nil if we find there is a mismatch."
7396 ;; For self-matched chars like " and $, we can't know when they're
7397 ;; mismatched or unmatched, so we can only do it for parens.
7402 ;; The cdr might hold a new paren-class info rather than
7403 ;; a matching-char info, in which case the two CDRs
7404 ;; should match.
7408 "Function to check parentheses mismatches.
7409 The function takes two arguments (START and END) where START is the
7410 position just before the opening token and END is the position right after.
7411 START can be nil, if it was not found.
7418 ol)
7422 "Momentarily highlight the beginning of the sexp before point."
7425 blink-matching-paren)
7435 oldpos))
7443 ;; backward-sexp skips backward over prefix chars,
7444 ;; so move back to the matching paren.
7467 ;; Matching open within window, temporarily move to or highlight
7468 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7469 ;; is non-nil.
7486 ;; Show what precedes the open in its line, if anything.
7491 ;; Show what follows the open in its line, if anything.
7498 ;; Otherwise show the previous nonblank line,
7499 ;; if there is one.
7508 ;; Replace the newline and other whitespace with `...'.
7509 "..."
7511 ;; There is nothing to show except the char itself.
7514 "Matches %s"
7518 "Function called, if non-nil, whenever a close parenthesis is inserted.
7524 blink-paren-function
7527 ;; Verify an even number of quoting characters precede the close.
7528 ;; FIXME: Also check if this parenthesis closes a comment as
7529 ;; can happen in Pascal and SML.
7540 ;; Most likely, this hook is nil, so this arg doesn't matter,
7541 ;; but I use it as a reminder that this function usually
7542 ;; likes to be run after others since it does
7543 ;; `sit-for'. That's also the reason it get a `priority' prop
7544 ;; of 100.
7546 \f
7547 ;; This executes C-g typed while Emacs is waiting for a command.
7548 ;; Quitting out of a program does not go through here;
7549 ;; that happens in the QUIT macro at the C code level.
7551 "Signal a `quit' condition.
7552 During execution of Lisp code, this character causes a quit directly.
7553 At top-level, as an editor command, this simply beeps."
7555 ;; Avoid adding the region to the window selection.
7563 ;; Force the next redisplay cycle to remove the "Def" indicator from
7564 ;; all the mode lines.
7578 This command can exit an interactive command such as `query-replace',
7579 can clear out a prefix argument or a region,
7580 can get out of the minibuffer or other recursive edit,
7581 cancel the use of the current buffer (for special-purpose buffers),
7582 or go back to just one window (by deleting all but the selected window)."
7590 nil)
7601 "Play sound stored in FILE.
7602 VOLUME and DEVICE correspond to the keywords of the sound
7603 specification for `play-sound'."
7613 \f
7615 "Your preference for a mail reading package.
7616 This is used by some keybindings which support reading mail.
7617 See also `mail-user-agent' concerning sending mail."
7627 "Your preference for a mail composition package.
7628 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7629 outgoing email message. This variable lets you specify which
7630 mail-sending package you prefer.
7632 Valid values include:
7634 `message-user-agent' -- use the Message package.
7635 See Info node `(message)'.
7636 `sendmail-user-agent' -- use the Mail package.
7637 See Info node `(emacs)Sending Mail'.
7638 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7639 See Info node `(mh-e)'.
7640 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7641 paraphernalia if Gnus is running, particularly
7642 the Gcc: header for archiving.
7644 Additional valid symbols may be available; check with the author of
7645 your package for details. The function should return non-nil if it
7646 succeeds.
7648 See also `read-mail-command' concerning reading mail."
7651 message-user-agent)
7654 sendmail-user-agent)
7657 mh-e-user-agent)
7660 gnus-user-agent)
7666 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7667 If the value of `mail-user-agent' is the default, and the user
7668 appears to have customizations applying to the old default,
7669 `compose-mail' issues a warning."
7675 "If the buffer starts with a mail header, move point to the header's end.
7676 Otherwise, moves to `point-min'.
7677 The end of the header is the start of the next line, if there is one,
7678 else the end of the last line. This function obeys RFC822."
7684 ;; Used by Rmail (e.g., rmail-forward).
7686 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7690 switch-function yank-action send-actions
7691 return-action)
7692 "Start composing a mail message to send.
7693 This uses the user's chosen mail composition package
7694 as selected with the variable `mail-user-agent'.
7695 The optional arguments TO and SUBJECT specify recipients
7696 and the initial Subject field, respectively.
7698 OTHER-HEADERS is an alist specifying additional
7699 header fields. Elements look like (HEADER . VALUE) where both
7700 HEADER and VALUE are strings.
7702 CONTINUE, if non-nil, says to continue editing a message already
7703 being composed. Interactively, CONTINUE is the prefix argument.
7705 SWITCH-FUNCTION, if non-nil, is a function to use to
7706 switch to and display the buffer used for mail composition.
7708 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7709 to insert the raw text of the message being replied to.
7710 It has the form (FUNCTION . ARGS). The user agent will apply
7711 FUNCTION to ARGS, to insert the raw text of the original message.
7712 \(The user agent will also run `mail-citation-hook', *after* the
7713 original text has been inserted in this way.)
7715 SEND-ACTIONS is a list of actions to call when the message is sent.
7716 Each action has the form (FUNCTION . ARGS).
7718 RETURN-ACTION, if non-nil, is an action for returning to the
7719 caller. It has the form (FUNCTION . ARGS). The function is
7720 called after the mail has been sent or put aside, and the mail
7721 buffer buried."
7725 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7726 ;; from sendmail-user-agent to message-user-agent. Some users may
7727 ;; encounter incompatibilities. This hack tries to detect problems
7728 ;; and warn about them.
7733 mail-yank-hooks mail-archive-file-name
7734 mail-default-reply-to mail-mailing-lists
7735 mail-self-blind))
7742 The default mail mode is now Message mode.
7743 You have the following Mail mode variable%s customized:
7745 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7752 yank-action send-actions return-action)))
7755 yank-action send-actions
7756 return-action)
7760 'switch-to-buffer-other-window yank-action send-actions
7761 return-action))
7764 yank-action send-actions
7765 return-action)
7769 'switch-to-buffer-other-frame yank-action send-actions
7770 return-action))
7772 \f
7774 "History of values entered with `set-variable'.
7776 Maximum length of the history list is determined by the value
7780 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7781 VARIABLE should be a user option variable name, a Lisp variable
7782 meant to be customized by users. You should enter VALUE in Lisp syntax,
7783 so if you want VALUE to be a string, you must surround it with doublequotes.
7784 VALUE is used literally, not evaluated.
7786 If VARIABLE has a `variable-interactive' property, that is used as if
7787 it were the arg to `interactive' (which see) to interactively read VALUE.
7789 If VARIABLE has been defined with `defcustom', then the type information
7790 in the definition is used to check that VALUE is valid.
7792 Note that this function is at heart equivalent to the basic `set' function.
7793 For a variable defined with `defcustom', it does not pay attention to
7794 any :set property that the variable might have (if you want that, use
7797 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7802 default-var)
7818 var obsolete)
7821 ;; Use VAR's `variable-interactive' property
7822 ;; as an interactive spec for prompting.
7825 arg))
7827 read-expression-map t
7828 'set-variable-value-history
7837 ;; Match with custom type.
7849 ;; Force a thorough redisplay for the case that the variable
7850 ;; has an effect on the display, like `tab-width' has.
7852 \f
7853 ;; Define the major mode for lists of completions.
7863 (define-key map [right] 'next-completion)
7865 (define-key map [backtab] 'previous-completion)
7866 (define-key map "q" 'quit-window)
7867 (define-key map "z" 'kill-this-buffer)
7868 map)
7869 "Local map for completion list buffers.")
7871 ;; Completion mode is suitable only for specially formatted data.
7872 (put 'completion-list-mode 'mode-class 'special)
7874 (defvar completion-reference-buffer nil
7875 "Record the buffer that was current when the completion list was requested.
7876 This is a local variable in the completion list buffer.
7877 Initial value is nil to avoid some compiler warnings.")
7879 (defvar completion-no-auto-exit nil
7880 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7881 This also applies to other functions such as `choose-completion'.")
7883 (defvar completion-base-position nil
7884 "Position of the base of the text corresponding to the shown completions.
7885 This variable is used in the *Completions* buffers.
7886 Its value is a list of the form (START END) where START is the place
7887 where the completion should be inserted and END (if non-nil) is the end
7888 of the text to replace. If END is nil, point is used instead.")
7890 (defvar completion-list-insert-choice-function #'completion--replace
7891 "Function to use to insert the text chosen in *Completions*.
7892 Called with three arguments (BEG END TEXT), it should replace the text
7893 between BEG and END with TEXT. Expected to be set buffer-locally
7894 in the *Completions* buffer.")
7896 (defvar completion-base-size nil
7897 "Number of chars before point not involved in completion.
7898 This is a local variable in the completion list buffer.
7899 It refers to the chars in the minibuffer if completing in the
7900 minibuffer, or in `completion-reference-buffer' otherwise.
7901 Only characters in the field at point are included.
7903 If nil, Emacs determines which part of the tail end of the
7904 buffer's text is involved in completion by comparing the text
7905 directly.")
7906 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7908 (defun delete-completion-window ()
7909 "Delete the completion list window.
7910 Go to the window from which completion was requested."
7911 (interactive)
7912 (let ((buf completion-reference-buffer))
7913 (if (one-window-p t)
7914 (if (window-dedicated-p) (delete-frame))
7915 (delete-window (selected-window))
7916 (if (get-buffer-window buf)
7917 (select-window (get-buffer-window buf))))))
7919 (defun previous-completion (n)
7920 "Move to the previous item in the completion list."
7921 (interactive "p")
7922 (next-completion (- n)))
7924 (defun next-completion (n)
7925 "Move to the next item in the completion list.
7926 With prefix argument N, move N items (negative N means move backward)."
7927 (interactive "p")
7928 (let ((beg (point-min)) (end (point-max)))
7929 (while (and (> n 0) (not (eobp)))
7930 ;; If in a completion, move to the end of it.
7931 (when (get-text-property (point) 'mouse-face)
7932 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7933 ;; Move to start of next one.
7934 (unless (get-text-property (point) 'mouse-face)
7935 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7936 (setq n (1- n)))
7937 (while (and (< n 0) (not (bobp)))
7938 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7939 ;; If in a completion, move to the start of it.
7940 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7941 (goto-char (previous-single-property-change
7942 (point) 'mouse-face nil beg)))
7943 ;; Move to end of the previous completion.
7944 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7945 (goto-char (previous-single-property-change
7946 (point) 'mouse-face nil beg)))
7947 ;; Move to the start of that one.
7948 (goto-char (previous-single-property-change
7949 (point) 'mouse-face nil beg))
7950 (setq n (1+ n))))))
7952 (defun choose-completion (&optional event)
7953 "Choose the completion at point.
7954 If EVENT, use EVENT's position to determine the starting position."
7955 (interactive (list last-nonmenu-event))
7956 ;; In case this is run via the mouse, give temporary modes such as
7957 ;; isearch a chance to turn off.
7958 (run-hooks 'mouse-leave-buffer-hook)
7959 (with-current-buffer (window-buffer (posn-window (event-start event)))
7960 (let ((buffer completion-reference-buffer)
7961 (base-size completion-base-size)
7962 (base-position completion-base-position)
7963 (insert-function completion-list-insert-choice-function)
7964 (choice
7965 (save-excursion
7966 (goto-char (posn-point (event-start event)))
7967 (let (beg end)
7968 (cond
7969 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7970 (setq end (point) beg (1+ (point))))
7971 ((and (not (bobp))
7972 (get-text-property (1- (point)) 'mouse-face))
7973 (setq end (1- (point)) beg (point)))
7974 (t (error "No completion here")))
7975 (setq beg (previous-single-property-change beg 'mouse-face))
7976 (setq end (or (next-single-property-change end 'mouse-face)
7977 (point-max)))
7978 (buffer-substring-no-properties beg end)))))
7980 (unless (buffer-live-p buffer)
7981 (error "Destination buffer is dead"))
7982 (quit-window nil (posn-window (event-start event)))
7984 (with-current-buffer buffer
7985 (choose-completion-string
7986 choice buffer
7987 (or base-position
7988 (when base-size
7989 ;; Someone's using old completion code that doesn't know
7990 ;; about base-position yet.
7991 (list (+ base-size (field-beginning))))
7992 ;; If all else fails, just guess.
7993 (list (choose-completion-guess-base-position choice)))
7994 insert-function)))))
7996 ;; Delete the longest partial match for STRING
7997 ;; that can be found before POINT.
7998 (defun choose-completion-guess-base-position (string)
7999 (save-excursion
8000 (let ((opoint (point))
8001 len)
8002 ;; Try moving back by the length of the string.
8003 (goto-char (max (- (point) (length string))
8004 (minibuffer-prompt-end)))
8005 ;; See how far back we were actually able to move. That is the
8006 ;; upper bound on how much we can match and delete.
8007 (setq len (- opoint (point)))
8008 (if completion-ignore-case
8009 (setq string (downcase string)))
8010 (while (and (> len 0)
8011 (let ((tail (buffer-substring (point) opoint)))
8012 (if completion-ignore-case
8013 (setq tail (downcase tail)))
8014 (not (string= tail (substring string 0 len)))))
8015 (setq len (1- len))
8016 (forward-char 1))
8017 (point))))
8019 (defun choose-completion-delete-max-match (string)
8020 (declare (obsolete choose-completion-guess-base-position "23.2"))
8021 (delete-region (choose-completion-guess-base-position string) (point)))
8023 (defvar choose-completion-string-functions nil
8024 "Functions that may override the normal insertion of a completion choice.
8025 These functions are called in order with three arguments:
8026 CHOICE - the string to insert in the buffer,
8027 BUFFER - the buffer in which the choice should be inserted,
8028 BASE-POSITION - where to insert the completion.
8030 If a function in the list returns non-nil, that function is supposed
8031 to have inserted the CHOICE in the BUFFER, and possibly exited
8032 the minibuffer; no further functions will be called.
8034 If all functions in the list return nil, that means to use
8035 the default method of inserting the completion in BUFFER.")
8037 (defun choose-completion-string (choice &optional
8038 buffer base-position insert-function)
8039 "Switch to BUFFER and insert the completion choice CHOICE.
8040 BASE-POSITION says where to insert the completion.
8041 INSERT-FUNCTION says how to insert the completion and falls
8042 back on `completion-list-insert-choice-function' when nil."
8044 ;; If BUFFER is the minibuffer, exit the minibuffer
8045 ;; unless it is reading a file name and CHOICE is a directory,
8046 ;; or completion-no-auto-exit is non-nil.
8048 ;; Some older code may call us passing `base-size' instead of
8049 ;; `base-position'. It's difficult to make any use of `base-size',
8050 ;; so we just ignore it.
8051 (unless (consp base-position)
8052 (message "Obsolete `base-size' passed to choose-completion-string")
8053 (setq base-position nil))
8055 (let* ((buffer (or buffer completion-reference-buffer))
8056 (mini-p (minibufferp buffer)))
8057 ;; If BUFFER is a minibuffer, barf unless it's the currently
8058 ;; active minibuffer.
8059 (if (and mini-p
8060 (not (and (active-minibuffer-window)
8061 (equal buffer
8062 (window-buffer (active-minibuffer-window))))))
8063 (error "Minibuffer is not active for completion")
8064 ;; Set buffer so buffer-local choose-completion-string-functions works.
8065 (set-buffer buffer)
8066 (unless (run-hook-with-args-until-success
8067 'choose-completion-string-functions
8068 ;; The fourth arg used to be `mini-p' but was useless
8069 ;; (since minibufferp can be used on the `buffer' arg)
8070 ;; and indeed unused. The last used to be `base-size', so we
8071 ;; keep it to try and avoid breaking old code.
8072 choice buffer base-position nil)
8073 ;; This remove-text-properties should be unnecessary since `choice'
8074 ;; comes from buffer-substring-no-properties.
8075 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8076 ;; Insert the completion into the buffer where it was requested.
8077 (funcall (or insert-function completion-list-insert-choice-function)
8078 (or (car base-position) (point))
8079 (or (cadr base-position) (point))
8080 choice)
8081 ;; Update point in the window that BUFFER is showing in.
8082 (let ((window (get-buffer-window buffer t)))
8083 (set-window-point window (point)))
8084 ;; If completing for the minibuffer, exit it with this choice.
8085 (and (not completion-no-auto-exit)
8086 (minibufferp buffer)
8087 minibuffer-completion-table
8088 ;; If this is reading a file name, and the file name chosen
8089 ;; is a directory, don't exit the minibuffer.
8090 (let* ((result (buffer-substring (field-beginning) (point)))
8091 (bounds
8092 (completion-boundaries result minibuffer-completion-table
8093 minibuffer-completion-predicate
8094 "")))
8095 (if (eq (car bounds) (length result))
8096 ;; The completion chosen leads to a new set of completions
8097 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8098 (let ((mini (active-minibuffer-window)))
8099 (select-window mini)
8100 (when minibuffer-auto-raise
8101 (raise-frame (window-frame mini))))
8102 (exit-minibuffer))))))))
8104 (define-derived-mode completion-list-mode nil "Completion List"
8105 "Major mode for buffers showing lists of possible completions.
8107 to select the completion near point.
8108 Or click to select one with the mouse.
8111 (set (make-local-variable 'completion-base-size) nil))
8113 (defun completion-list-mode-finish ()
8114 "Finish setup of the completions buffer.
8115 Called from `temp-buffer-show-hook'."
8116 (when (eq major-mode 'completion-list-mode)
8117 (setq buffer-read-only t)))
8119 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8122 ;; Variables and faces used in `completion-setup-function'.
8124 (defcustom completion-show-help t
8125 "Non-nil means show help message in *Completions* buffer."
8126 :type 'boolean
8127 :version "22.1"
8128 :group 'completion)
8130 ;; This function goes in completion-setup-hook, so that it is called
8131 ;; after the text of the completion list buffer is written.
8132 (defun completion-setup-function ()
8133 (let* ((mainbuf (current-buffer))
8134 (base-dir
8135 ;; FIXME: This is a bad hack. We try to set the default-directory
8136 ;; in the *Completions* buffer so that the relative file names
8137 ;; displayed there can be treated as valid file names, independently
8138 ;; from the completion context. But this suffers from many problems:
8139 ;; - It's not clear when the completions are file names. With some
8140 ;; completion tables (e.g. bzr revision specs), the listed
8141 ;; completions can mix file names and other things.
8142 ;; - It doesn't pay attention to possible quoting.
8143 ;; - With fancy completion styles, the code below will not always
8144 ;; find the right base directory.
8145 (if minibuffer-completing-file-name
8146 (file-name-as-directory
8147 (expand-file-name
8148 (buffer-substring (minibuffer-prompt-end)
8149 (- (point) (or completion-base-size 0))))))))
8150 (with-current-buffer standard-output
8151 (let ((base-size completion-base-size) ;Read before killing localvars.
8152 (base-position completion-base-position)
8153 (insert-fun completion-list-insert-choice-function))
8154 (completion-list-mode)
8155 (set (make-local-variable 'completion-base-size) base-size)
8156 (set (make-local-variable 'completion-base-position) base-position)
8157 (set (make-local-variable 'completion-list-insert-choice-function)
8158 insert-fun))
8159 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8160 (if base-dir (setq default-directory base-dir))
8161 ;; Maybe insert help string.
8162 (when completion-show-help
8163 (goto-char (point-min))
8164 (if (display-mouse-p)
8166 (insert (substitute-command-keys
8170 (add-hook 'completion-setup-hook 'completion-setup-function)
8172 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8173 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8175 (defun switch-to-completions ()
8176 "Select the completion list window."
8177 (interactive)
8178 (let ((window (or (get-buffer-window "*Completions*" 0)
8179 ;; Make sure we have a completions window.
8180 (progn (minibuffer-completion-help)
8181 (get-buffer-window "*Completions*" 0)))))
8182 (when window
8183 (select-window window)
8184 ;; In the new buffer, go to the first completion.
8185 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8186 (when (bobp)
8187 (next-completion 1)))))
8188 \f
8189 ;;; Support keyboard commands to turn on various modifiers.
8191 ;; These functions -- which are not commands -- each add one modifier
8192 ;; to the following event.
8194 (defun event-apply-alt-modifier (_ignore-prompt)
8197 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8198 (defun event-apply-super-modifier (_ignore-prompt)
8201 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8202 (defun event-apply-hyper-modifier (_ignore-prompt)
8205 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8206 (defun event-apply-shift-modifier (_ignore-prompt)
8209 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8210 (defun event-apply-control-modifier (_ignore-prompt)
8213 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8214 (defun event-apply-meta-modifier (_ignore-prompt)
8217 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8219 (defun event-apply-modifier (event symbol lshiftby prefix)
8220 "Apply a modifier flag to event EVENT.
8221 SYMBOL is the name of this modifier, as a symbol.
8222 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8223 PREFIX is the string that represents this modifier in an event type symbol."
8224 (if (numberp event)
8225 (cond ((eq symbol 'control)
8226 (if (and (<= (downcase event) ?z)
8227 (>= (downcase event) ?a))
8228 (- (downcase event) ?a -1)
8229 (if (and (<= (downcase event) ?Z)
8230 (>= (downcase event) ?A))
8231 (- (downcase event) ?A -1)
8232 (logior (lsh 1 lshiftby) event))))
8233 ((eq symbol 'shift)
8234 (if (and (<= (downcase event) ?z)
8235 (>= (downcase event) ?a))
8236 (upcase event)
8237 (logior (lsh 1 lshiftby) event)))
8238 (t
8239 (logior (lsh 1 lshiftby) event)))
8240 (if (memq symbol (event-modifiers event))
8241 event
8242 (let ((event-type (if (symbolp event) event (car event))))
8243 (setq event-type (intern (concat prefix (symbol-name event-type))))
8244 (if (symbolp event)
8245 event-type
8246 (cons event-type (cdr event)))))))
8248 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8249 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8250 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8251 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8252 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8253 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8254 \f
8255 ;;;; Keypad support.
8257 ;; Make the keypad keys act like ordinary typing keys. If people add
8258 ;; bindings for the function key symbols, then those bindings will
8259 ;; override these, so this shouldn't interfere with any existing
8260 ;; bindings.
8262 ;; Also tell read-char how to handle these keys.
8263 (mapc
8264 (lambda (keypad-normal)
8265 (let ((keypad (nth 0 keypad-normal))
8266 (normal (nth 1 keypad-normal)))
8267 (put keypad 'ascii-character normal)
8268 (define-key function-key-map (vector keypad) (vector normal))))
8269 ;; See also kp-keys bound in bindings.el.
8270 '((kp-space ?\s)
8273 (kp-separator ?,)
8274 (kp-equal ?=)
8275 ;; Do the same for various keys that are represented as symbols under
8276 ;; GUIs but naturally correspond to characters.
8277 (backspace 127)
8278 (delete 127)
8281 (clear ?\C-l)
8282 (return ?\C-m)
8283 (escape ?\e)
8284 ))
8285 \f
8286 ;;;;
8287 ;;;; forking a twin copy of a buffer.
8288 ;;;;
8290 (defvar clone-buffer-hook nil
8291 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8293 (defvar clone-indirect-buffer-hook nil
8294 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8296 (defun clone-process (process &optional newname)
8297 "Create a twin copy of PROCESS.
8298 If NEWNAME is nil, it defaults to PROCESS' name;
8299 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8300 If PROCESS is associated with a buffer, the new process will be associated
8301 with the current buffer instead.
8302 Returns nil if PROCESS has already terminated."
8303 (setq newname (or newname (process-name process)))
8305 (setq newname (substring newname 0 (match-beginning 0))))
8306 (when (memq (process-status process) '(run stop open))
8307 (let* ((process-connection-type (process-tty-name process))
8308 (new-process
8309 (if (memq (process-status process) '(open))
8310 (let ((args (process-contact process t)))
8311 (setq args (plist-put args :name newname))
8312 (setq args (plist-put args :buffer
8313 (if (process-buffer process)
8314 (current-buffer))))
8315 (apply 'make-network-process args))
8316 (apply 'start-process newname
8317 (if (process-buffer process) (current-buffer))
8318 (process-command process)))))
8319 (set-process-query-on-exit-flag
8320 new-process (process-query-on-exit-flag process))
8321 (set-process-inherit-coding-system-flag
8322 new-process (process-inherit-coding-system-flag process))
8323 (set-process-filter new-process (process-filter process))
8324 (set-process-sentinel new-process (process-sentinel process))
8325 (set-process-plist new-process (copy-sequence (process-plist process)))
8326 new-process)))
8328 ;; things to maybe add (currently partly covered by `funcall mode'):
8329 ;; - syntax-table
8330 ;; - overlays
8331 (defun clone-buffer (&optional newname display-flag)
8332 "Create and return a twin copy of the current buffer.
8333 Unlike an indirect buffer, the new buffer can be edited
8334 independently of the old one (if it is not read-only).
8335 NEWNAME is the name of the new buffer. It may be modified by
8336 adding or incrementing <N> at the end as necessary to create a
8337 unique buffer name. If nil, it defaults to the name of the
8338 current buffer, with the proper suffix. If DISPLAY-FLAG is
8339 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8340 clone a file-visiting buffer, or a buffer whose major mode symbol
8341 has a non-nil `no-clone' property, results in an error.
8343 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8344 current buffer with appropriate suffix. However, if a prefix
8345 argument is given, then the command prompts for NEWNAME in the
8346 minibuffer.
8348 This runs the normal hook `clone-buffer-hook' in the new buffer
8349 after it has been set up properly in other respects."
8350 (interactive
8351 (progn
8352 (if buffer-file-name
8353 (error "Cannot clone a file-visiting buffer"))
8354 (if (get major-mode 'no-clone)
8355 (error "Cannot clone a buffer in %s mode" mode-name))
8356 (list (if current-prefix-arg
8357 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8358 t)))
8359 (if buffer-file-name
8360 (error "Cannot clone a file-visiting buffer"))
8361 (if (get major-mode 'no-clone)
8362 (error "Cannot clone a buffer in %s mode" mode-name))
8363 (setq newname (or newname (buffer-name)))
8365 (setq newname (substring newname 0 (match-beginning 0))))
8366 (let ((buf (current-buffer))
8367 (ptmin (point-min))
8368 (ptmax (point-max))
8369 (pt (point))
8370 (mk (if mark-active (mark t)))
8371 (modified (buffer-modified-p))
8372 (mode major-mode)
8373 (lvars (buffer-local-variables))
8374 (process (get-buffer-process (current-buffer)))
8375 (new (generate-new-buffer (or newname (buffer-name)))))
8376 (save-restriction
8377 (widen)
8378 (with-current-buffer new
8379 (insert-buffer-substring buf)))
8380 (with-current-buffer new
8381 (narrow-to-region ptmin ptmax)
8382 (goto-char pt)
8383 (if mk (set-mark mk))
8384 (set-buffer-modified-p modified)
8386 ;; Clone the old buffer's process, if any.
8387 (when process (clone-process process))
8389 ;; Now set up the major mode.
8390 (funcall mode)
8392 ;; Set up other local variables.
8393 (mapc (lambda (v)
8394 (condition-case () ;in case var is read-only
8395 (if (symbolp v)
8396 (makunbound v)
8397 (set (make-local-variable (car v)) (cdr v)))
8398 (error nil)))
8399 lvars)
8401 ;; Run any hooks (typically set up by the major mode
8402 ;; for cloning to work properly).
8403 (run-hooks 'clone-buffer-hook))
8404 (if display-flag
8405 ;; Presumably the current buffer is shown in the selected frame, so
8406 ;; we want to display the clone elsewhere.
8407 (let ((same-window-regexps nil)
8408 (same-window-buffer-names))
8409 (pop-to-buffer new)))
8410 new))
8413 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8414 "Create an indirect buffer that is a twin copy of the current buffer.
8416 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8417 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8418 or if not called with a prefix arg, NEWNAME defaults to the current
8419 buffer's name. The name is modified by adding a `<N>' suffix to it
8420 or by incrementing the N in an existing suffix. Trying to clone a
8421 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8422 property results in an error.
8424 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8425 This is always done when called interactively.
8427 Optional third arg NORECORD non-nil means do not put this buffer at the
8428 front of the list of recently selected ones.
8430 Returns the newly created indirect buffer."
8431 (interactive
8432 (progn
8433 (if (get major-mode 'no-clone-indirect)
8434 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8435 (list (if current-prefix-arg
8436 (read-buffer "Name of indirect buffer: " (current-buffer)))
8437 t)))
8438 (if (get major-mode 'no-clone-indirect)
8439 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8440 (setq newname (or newname (buffer-name)))
8442 (setq newname (substring newname 0 (match-beginning 0))))
8443 (let* ((name (generate-new-buffer-name newname))
8444 (buffer (make-indirect-buffer (current-buffer) name t)))
8445 (with-current-buffer buffer
8446 (run-hooks 'clone-indirect-buffer-hook))
8447 (when display-flag
8448 (pop-to-buffer buffer nil norecord))
8449 buffer))
8452 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8453 "Like `clone-indirect-buffer' but display in another window."
8454 (interactive
8455 (progn
8456 (if (get major-mode 'no-clone-indirect)
8457 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8458 (list (if current-prefix-arg
8459 (read-buffer "Name of indirect buffer: " (current-buffer)))
8460 t)))
8461 (let ((pop-up-windows t))
8462 (clone-indirect-buffer newname display-flag norecord)))
8464 \f
8465 ;;; Handling of Backspace and Delete keys.
8467 (defcustom normal-erase-is-backspace 'maybe
8468 "Set the default behavior of the Delete and Backspace keys.
8470 If set to t, Delete key deletes forward and Backspace key deletes
8471 backward.
8473 If set to nil, both Delete and Backspace keys delete backward.
8475 If set to `maybe' (which is the default), Emacs automatically
8476 selects a behavior. On window systems, the behavior depends on
8477 the keyboard used. If the keyboard has both a Backspace key and
8478 a Delete key, and both are mapped to their usual meanings, the
8479 option's default value is set to t, so that Backspace can be used
8480 to delete backward, and Delete can be used to delete forward.
8482 If not running under a window system, customizing this option
8483 accomplishes a similar effect by mapping C-h, which is usually
8484 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8485 via `keyboard-translate'. The former functionality of C-h is
8486 available on the F1 key. You should probably not use this
8487 setting if you don't have both Backspace, Delete and F1 keys.
8489 Setting this variable with setq doesn't take effect. Programmatically,
8490 call `normal-erase-is-backspace-mode' (which see) instead."
8491 :type '(choice (const :tag "Off" nil)
8492 (const :tag "Maybe" maybe)
8493 (other :tag "On" t))
8494 :group 'editing-basics
8495 :version "21.1"
8496 :set (lambda (symbol value)
8497 ;; The fboundp is because of a problem with :set when
8498 ;; dumping Emacs. It doesn't really matter.
8499 (if (fboundp 'normal-erase-is-backspace-mode)
8500 (normal-erase-is-backspace-mode (or value 0))
8501 (set-default symbol value))))
8503 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8504 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8505 (unless frame (setq frame (selected-frame)))
8506 (with-selected-frame frame
8507 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8508 (normal-erase-is-backspace-mode
8509 (if (if (eq normal-erase-is-backspace 'maybe)
8510 (and (not noninteractive)
8511 (or (memq system-type '(ms-dos windows-nt))
8512 (memq window-system '(w32 ns))
8513 (and (memq window-system '(x))
8514 (fboundp 'x-backspace-delete-keys-p)
8515 (x-backspace-delete-keys-p))
8516 ;; If the terminal Emacs is running on has erase char
8517 ;; set to ^H, use the Backspace key for deleting
8518 ;; backward, and the Delete key for deleting forward.
8519 (and (null window-system)
8520 (eq tty-erase-char ?\^H))))
8521 normal-erase-is-backspace)
8522 1 0)))))
8524 (define-minor-mode normal-erase-is-backspace-mode
8525 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8526 With a prefix argument ARG, enable this feature if ARG is
8527 positive, and disable it otherwise. If called from Lisp, enable
8528 the mode if ARG is omitted or nil.
8530 On window systems, when this mode is on, Delete is mapped to C-d
8531 and Backspace is mapped to DEL; when this mode is off, both
8532 Delete and Backspace are mapped to DEL. (The remapping goes via
8533 `local-function-key-map', so binding Delete or Backspace in the
8534 global or local keymap will override that.)
8536 In addition, on window systems, the bindings of C-Delete, M-Delete,
8537 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8538 the global keymap in accordance with the functionality of Delete and
8539 Backspace. For example, if Delete is remapped to C-d, which deletes
8540 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8541 to DEL, which deletes backward, C-Delete is bound to
8542 `backward-kill-word'.
8544 If not running on a window system, a similar effect is accomplished by
8545 remapping C-h (normally produced by the Backspace key) and DEL via
8546 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8547 to C-d; if it's off, the keys are not remapped.
8549 When not running on a window system, and this mode is turned on, the
8550 former functionality of C-h is available on the F1 key. You should
8551 probably not turn on this mode on a text-only terminal if you don't
8552 have both Backspace, Delete and F1 keys.
8554 See also `normal-erase-is-backspace'."
8555 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8556 . (lambda (v)
8557 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8558 (if v 1 0))))
8559 (let ((enabled (eq 1 (terminal-parameter
8560 nil 'normal-erase-is-backspace))))
8562 (cond ((or (memq window-system '(x w32 ns pc))
8563 (memq system-type '(ms-dos windows-nt)))
8564 (let ((bindings
8565 `(([M-delete] [M-backspace])
8566 ([C-M-delete] [C-M-backspace])
8567 ([?\e C-delete] [?\e C-backspace]))))
8569 (if enabled
8570 (progn
8571 (define-key local-function-key-map [delete] [deletechar])
8572 (define-key local-function-key-map [kp-delete] [deletechar])
8573 (define-key local-function-key-map [backspace] [?\C-?])
8574 (dolist (b bindings)
8575 ;; Not sure if input-decode-map is really right, but
8576 ;; keyboard-translate-table (used below) only works
8577 ;; for integer events, and key-translation-table is
8578 ;; global (like the global-map, used earlier).
8579 (define-key input-decode-map (car b) nil)
8580 (define-key input-decode-map (cadr b) nil)))
8581 (define-key local-function-key-map [delete] [?\C-?])
8582 (define-key local-function-key-map [kp-delete] [?\C-?])
8583 (define-key local-function-key-map [backspace] [?\C-?])
8584 (dolist (b bindings)
8585 (define-key input-decode-map (car b) (cadr b))
8586 (define-key input-decode-map (cadr b) (car b))))))
8587 (t
8588 (if enabled
8589 (progn
8590 (keyboard-translate ?\C-h ?\C-?)
8591 (keyboard-translate ?\C-? ?\C-d))
8592 (keyboard-translate ?\C-h ?\C-h)
8593 (keyboard-translate ?\C-? ?\C-?))))
8595 (if (called-interactively-p 'interactive)
8596 (message "Delete key deletes %s"
8597 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8598 "forward" "backward")))))
8599 \f
8600 (defvar vis-mode-saved-buffer-invisibility-spec nil
8601 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8603 (define-minor-mode read-only-mode
8604 "Change whether the current buffer is read-only.
8605 With prefix argument ARG, make the buffer read-only if ARG is
8606 positive, otherwise make it writable. If buffer is read-only
8607 and `view-read-only' is non-nil, enter view mode.
8609 Do not call this from a Lisp program unless you really intend to
8611 possibly enabling or disabling View mode. Also, note that this
8612 command works by setting the variable `buffer-read-only', which
8613 does not affect read-only regions caused by text properties. To
8614 ignore read-only status in a Lisp program (whether due to text
8615 properties or buffer state), bind `inhibit-read-only' temporarily
8616 to a non-nil value."
8617 :variable buffer-read-only
8618 (cond
8619 ((and (not buffer-read-only) view-mode)
8620 (View-exit-and-edit)
8621 (make-local-variable 'view-read-only)
8622 (setq view-read-only t)) ; Must leave view mode.
8623 ((and buffer-read-only view-read-only
8624 ;; If view-mode is already active, `view-mode-enter' is a nop.
8625 (not view-mode)
8626 (not (eq (get major-mode 'mode-class) 'special)))
8627 (view-mode-enter))))
8629 (define-minor-mode visible-mode
8630 "Toggle making all invisible text temporarily visible (Visible mode).
8631 With a prefix argument ARG, enable Visible mode if ARG is
8632 positive, and disable it otherwise. If called from Lisp, enable
8633 the mode if ARG is omitted or nil.
8635 This mode works by saving the value of `buffer-invisibility-spec'
8636 and setting it to nil."
8637 :lighter " Vis"
8638 :group 'editing-basics
8639 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8640 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8641 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8642 (when visible-mode
8643 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8644 buffer-invisibility-spec)
8645 (setq buffer-invisibility-spec nil)))
8646 \f
8647 (defvar messages-buffer-mode-map
8648 (let ((map (make-sparse-keymap)))
8649 (set-keymap-parent map special-mode-map)
8650 (define-key map "g" nil) ; nothing to revert
8651 map))
8653 (define-derived-mode messages-buffer-mode special-mode "Messages"
8656 (defun messages-buffer ()
8658 If it does not exist, create and it switch it to `messages-buffer-mode'."
8659 (or (get-buffer "*Messages*")
8660 (with-current-buffer (get-buffer-create "*Messages*")
8661 (messages-buffer-mode)
8662 (current-buffer))))
8664 \f
8665 ;; Minibuffer prompt stuff.
8667 ;;(defun minibuffer-prompt-modification (start end)
8668 ;; (error "You cannot modify the prompt"))
8669 ;;
8670 ;;
8671 ;;(defun minibuffer-prompt-insertion (start end)
8672 ;; (let ((inhibit-modification-hooks t))
8673 ;; (delete-region start end)
8674 ;; ;; Discard undo information for the text insertion itself
8675 ;; ;; and for the text deletion.above.
8676 ;; (when (consp buffer-undo-list)
8677 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8678 ;; (message "You cannot modify the prompt")))
8679 ;;
8680 ;;
8681 ;;(setq minibuffer-prompt-properties
8682 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8683 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8685 \f
8686 ;;;; Problematic external packages.
8688 ;; rms says this should be done by specifying symbols that define
8689 ;; versions together with bad values. This is therefore not as
8690 ;; flexible as it could be. See the thread:
8691 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8692 (defconst bad-packages-alist
8693 ;; Not sure exactly which semantic versions have problems.
8694 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8696 "The version of `semantic' loaded does not work in Emacs 22.
8697 It can cause constant high CPU load.
8698 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8699 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8700 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8701 ;; provided the `CUA-mode' feature. Since this is no longer true,
8702 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8703 (CUA-mode t nil
8704 "CUA-mode is now part of the standard GNU Emacs distribution,
8705 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8707 You have loaded an older version of CUA-mode which does not work
8708 correctly with this version of Emacs. You should remove the old
8709 version and use the one distributed with Emacs."))
8710 "Alist of packages known to cause problems in this version of Emacs.
8711 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8712 PACKAGE is either a regular expression to match file names, or a
8713 symbol (a feature name), like for `with-eval-after-load'.
8714 SYMBOL is either the name of a string variable, or t. Upon
8715 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8716 warning using STRING as the message.")
8718 (defun bad-package-check (package)
8719 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8720 (condition-case nil
8721 (let* ((list (assoc package bad-packages-alist))
8722 (symbol (nth 1 list)))
8723 (and list
8724 (boundp symbol)
8725 (or (eq symbol t)
8726 (and (stringp (setq symbol (eval symbol)))
8727 (string-match-p (nth 2 list) symbol)))
8728 (display-warning package (nth 3 list) :warning)))
8729 (error nil)))
8731 (dolist (elem bad-packages-alist)
8732 (let ((pkg (car elem)))
8733 (with-eval-after-load pkg
8734 (bad-package-check pkg))))
8736 \f
8737 ;;; Generic dispatcher commands
8739 ;; Macro `define-alternatives' is used to create generic commands.
8740 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8741 ;; that can have different alternative implementations where choosing
8742 ;; among them is exclusively a matter of user preference.
8744 ;; (define-alternatives COMMAND) creates a new interactive command
8745 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8746 ;; Typically, the user will not need to customize this variable; packages
8747 ;; wanting to add alternative implementations should use
8748 ;;
8749 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8751 (defmacro define-alternatives (command &rest customizations)
8752 "Define the new command `COMMAND'.
8754 The argument `COMMAND' should be a symbol.
8756 Running `M-x COMMAND RET' for the first time prompts for which
8757 alternative to use and records the selected command as a custom
8758 variable.
8760 Running `C-u M-x COMMAND RET' prompts again for an alternative
8761 and overwrites the previous choice.
8763 The variable `COMMAND-alternatives' contains an alist with
8764 alternative implementations of COMMAND. `define-alternatives'
8765 does not have any effect until this variable is set.
8767 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8768 `defcustom' keywords and values to add to the declaration of
8769 `COMMAND-alternatives' (typically :group and :version)."
8770 (let* ((command-name (symbol-name command))
8771 (varalt-name (concat command-name "-alternatives"))
8772 (varalt-sym (intern varalt-name))
8773 (varimp-sym (intern (concat command-name "--implementation"))))
8774 `(progn
8776 (defcustom ,varalt-sym nil
8777 ,(format "Alist of alternative implementations for the `%s' command.
8779 Each entry must be a pair (ALTNAME . ALTFUN), where:
8780 ALTNAME - The name shown at user to describe the alternative implementation.
8781 ALTFUN - The function called to implement this alternative."
8782 command-name)
8783 :type '(alist :key-type string :value-type function)
8784 ,@customizations)
8786 (put ',varalt-sym 'definition-name ',command)
8787 (defvar ,varimp-sym nil "Internal use only.")
8789 (defun ,command (&optional arg)
8790 ,(format "Run generic command `%s'.
8791 If used for the first time, or with interactive ARG, ask the user which
8792 implementation to use for `%s'. The variable `%s'
8793 contains the list of implementations currently supported for this command."
8794 command-name command-name varalt-name)
8795 (interactive "P")
8796 (when (or arg (null ,varimp-sym))
8797 (let ((val (completing-read
8798 ,(format-message
8799 "Select implementation for command `%s': "
8800 command-name)
8801 ,varalt-sym nil t)))
8802 (unless (string-equal val "")
8803 (when (null ,varimp-sym)
8804 (message
8805 "Use C-u M-x %s RET`to select another implementation"
8806 ,command-name)
8807 (sit-for 3))
8808 (customize-save-variable ',varimp-sym
8809 (cdr (assoc-string val ,varalt-sym))))))
8810 (if ,varimp-sym
8811 (call-interactively ,varimp-sym)
8812 (message "%s" ,(format-message
8813 "No implementation selected for command `%s'"
8814 command-name)))))))
8816 \f
8817 ;;; Functions for changing capitalization that Do What I Mean
8818 (defun upcase-dwim (arg)
8819 "Upcase words in the region, if active; if not, upcase word at point.
8820 If the region is active, this function calls `upcase-region'.
8821 Otherwise, it calls `upcase-word', with prefix argument passed to it
8822 to upcase ARG words."
8823 (interactive "*p")
8824 (if (use-region-p)
8825 (upcase-region (region-beginning) (region-end))
8826 (upcase-word arg)))
8828 (defun downcase-dwim (arg)
8829 "Downcase words in the region, if active; if not, downcase word at point.
8830 If the region is active, this function calls `downcase-region'.
8831 Otherwise, it calls `downcase-word', with prefix argument passed to it
8832 to downcase ARG words."
8833 (interactive "*p")
8834 (if (use-region-p)
8835 (downcase-region (region-beginning) (region-end))
8836 (downcase-word arg)))
8838 (defun capitalize-dwim (arg)
8839 "Capitalize words in the region, if active; if not, capitalize word at point.
8840 If the region is active, this function calls `capitalize-region'.
8841 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8842 to capitalize ARG words."
8843 (interactive "*p")
8844 (if (use-region-p)
8845 (capitalize-region (region-beginning) (region-end))
8846 (capitalize-word arg)))
8848 \f
8850 (provide 'simple)
8852 ;;; simple.el ends here