| blob | 04a525c439243761060da230baca930c97d66ce1 |
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
4129 "Function to perform the filtering in `filter-buffer-substring'.
4130 The function is called with the same 3 arguments (BEG END DELETE)
4131 that `filter-buffer-substring' received. It should return the
4132 buffer substring between BEG and END, after filtering. If DELETE is
4136 "List of filter functions for `buffer-substring--filter'.
4137 Each function must accept a single argument, a string, and return a string.
4138 The buffer substring is passed to the first function in the list,
4139 and the return value of each function is passed to the next.
4140 As a special convention, point is set to the start of the buffer text
4141 being operated on (i.e., the first argument of `buffer-substring--filter')
4147 "Return the buffer substring between BEG and END, after filtering.
4148 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4150 This calls the function that `filter-buffer-substring-function' specifies
4151 \(passing the same three arguments that it received) to do the work,
4152 and returns whatever it does. The default function does no filtering,
4153 unless a hook has been set.
4155 Use `filter-buffer-substring' instead of `buffer-substring',
4156 `buffer-substring-no-properties', or `delete-and-extract-region' when
4157 you want to allow filtering to take place. For example, major or minor
4158 modes can use `filter-buffer-substring-function' to extract characters
4159 that are special to a buffer, and should not be copied into other buffers."
4163 "Default function to use for `filter-buffer-substring-function'.
4164 Its arguments and return value are as specified for `filter-buffer-substring'.
4165 This respects the wrapper hook `filter-buffer-substring-functions',
4166 and the abnormal hook `buffer-substring-filters'.
4167 No filtering is done unless a hook says to."
4178 string)))
4183 ;;;; Window system cut and paste hooks.
4186 "Function to call to make a killed region available to other programs.
4187 Most window systems provide a facility for cutting and pasting
4188 text between different programs, such as the clipboard on X and
4189 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4191 This variable holds a function that Emacs calls whenever text is
4192 put in the kill ring, to make the new kill available to other
4193 programs. The function takes one argument, TEXT, which is a
4197 "Function to call to get text cut from other programs.
4198 Most window systems provide a facility for cutting and pasting
4199 text between different programs, such as the clipboard on X and
4200 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4202 This variable holds a function that Emacs calls to obtain text
4203 that other programs have provided for pasting. The function is
4204 called with no arguments. If no other program has provided text
4205 to paste, the function should return nil (in which case the
4206 caller, usually `current-kill', should use the top of the Emacs
4207 kill ring). If another program has provided text to paste, the
4208 function should return that text as a string (in which case the
4209 caller should put this string in the kill ring as the latest
4210 kill).
4212 The function may also return a list of strings if the window
4213 system supports multiple selections. The first string will be
4214 used as the pasted text, but the other will be placed in the kill
4215 ring for easy access via `yank-pop'.
4217 Note that the function should return a string only if a program
4218 other than Emacs has provided a string for pasting; if Emacs
4219 provided the most recent string, the function should return nil.
4220 If it is difficult to tell whether Emacs or some other program
4221 provided the current string, it is probably good enough to return
4222 nil if the string is equal (according to `string=') to the last
4224 \f
4227 ;;;; The kill ring data structure.
4230 "List of killed text sequences.
4231 Since the kill ring is supposed to interact nicely with cut-and-paste
4232 facilities offered by window systems, use of this variable should
4233 interact nicely with `interprogram-cut-function' and
4234 `interprogram-paste-function'. The functions `kill-new',
4235 `kill-append', and `current-kill' are supposed to implement this
4236 interaction; you may want to use them instead of manipulating the kill
4240 "Maximum length of kill ring before oldest elements are thrown away."
4248 "Save clipboard strings into kill ring before replacing them.
4249 When one selects something in another program to paste it into Emacs,
4250 but kills something in Emacs before actually pasting it,
4251 this selection is gone unless this variable is non-nil,
4252 in which case the other program's selection is saved in the `kill-ring'
4259 "Do not add a new string to `kill-ring' if it duplicates the last one.
4260 The comparison is done using `equal-including-properties'."
4266 "Make STRING the latest kill in the kill ring.
4267 Set `kill-ring-yank-pointer' to point to it.
4268 If `interprogram-cut-function' is non-nil, apply it to STRING.
4269 Optional second argument REPLACE non-nil means that STRING will replace
4270 the front of the kill ring, rather than being added to the list.
4272 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4273 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4274 STRING.
4276 When the yank handler has a non-nil PARAM element, the original STRING
4277 argument is not used by `insert-for-yank'. However, since Lisp code
4278 may access and use elements from the kill ring directly, the STRING
4281 ;; Due to text properties such as 'yank-handler that
4282 ;; can alter the contents to yank, comparison using
4283 ;; `equal' is unsafe.
4308 ;; It has been argued that this should work similar to `self-insert-command'
4309 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4311 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4317 "Append STRING to the end of the latest kill in the kill ring.
4318 If BEFORE-P is non-nil, prepend STRING to the kill.
4319 Also removes the last undo boundary in the current buffer,
4320 depending on `kill-append-merge-undo'.
4321 If `interprogram-cut-function' is set, pass the resulting kill to it."
4329 ;; find the next undo boundary
4333 ;; remove this undo boundary
4338 "Whether rotating the kill ring changes the window system selection.
4339 If non-nil, whenever the kill ring is rotated (usually via the
4340 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4341 to copy the new kill to the window system selection."
4347 "Rotate the yanking point by N places, and then return that kill.
4348 If N is zero and `interprogram-paste-function' is set to a
4349 function that returns a string or a list of strings, and if that
4350 function doesn't return nil, then that string (or list) is added
4351 to the front of the kill ring and the string (or first string in
4352 the list) is returned as the latest kill.
4354 If N is not zero, and if `yank-pop-change-selection' is
4355 non-nil, use `interprogram-cut-function' to transfer the
4356 kill at the new yank point into the window system selection.
4358 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4359 move the yanking point; just return the Nth kill forward."
4362 interprogram-paste-function
4366 ;; Disable the interprogram cut function when we add the new
4367 ;; text to the kill ring, so Emacs doesn't try to own the
4368 ;; selection, with identical text.
4378 kill-ring)))
4383 interprogram-cut-function)
4389 ;;;; Commands for manipulating the kill ring.
4392 "Non-nil means don't signal an error for killing read-only text."
4398 This deletes the text from the buffer and saves it in the kill ring.
4402 If you want to append the killed region to the last killed text,
4406 If the previous command was also a kill command,
4407 the text killed this time appends to the text killed last time
4408 to make one entry in the kill ring.
4410 The killed text is filtered by `filter-buffer-substring' before it is
4411 saved in the kill ring, so the actual saved text might be different
4412 from what was killed.
4414 If the buffer is read-only, Emacs will beep and refrain from deleting
4415 the text, but put the text in the kill ring anyway. This means that
4416 you can use the killing commands to copy text from a read-only buffer.
4418 Lisp programs should use this function for killing text.
4419 (To delete text, use `delete-region'.)
4420 Supply two arguments, character positions BEG and END indicating the
4421 stretch of text to be killed. If the optional argument REGION is
4422 non-nil, the function ignores BEG and END, and kills the current
4423 region instead."
4424 ;; Pass mark first, then point, because the order matters when
4425 ;; calling `kill-append'.
4434 ;; Add that string to the kill ring, one way or another.
4441 nil)
4443 ;; The code above failed because the buffer, or some of the characters
4444 ;; in the region, are read-only.
4445 ;; We should beep, in case the user just isn't aware of this.
4446 ;; However, there's no harm in putting
4447 ;; the region's text in the kill ring, anyway.
4449 ;; Set this-command now, so it will be set even if we get an error.
4451 ;; This should barf, if appropriate, and give us the correct error.
4454 ;; Signal an error if the buffer is read-only.
4456 ;; If the buffer isn't read-only, the text is.
4459 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4460 ;; to get two copies of the text when the user accidentally types M-w and
4461 ;; then corrects it with the intended C-w.
4463 "Save the region as if killed, but don't kill it.
4464 In Transient Mark mode, deactivate the mark.
4465 If `interprogram-cut-function' is non-nil, also save the text for a window
4466 system cut and paste.
4468 The copied text is filtered by `filter-buffer-substring' before it is
4469 saved in the kill ring, so the actual saved text might be different
4470 from what was in the buffer.
4472 When called from Lisp, save in the kill ring the stretch of text
4473 between BEG and END, unless the optional argument REGION is
4474 non-nil, in which case ignore BEG and END, and save the current
4475 region instead.
4477 This command's old key binding has been given to `kill-ring-save'."
4478 ;; Pass mark first, then point, because the order matters when
4479 ;; calling `kill-append'.
4489 nil)
4492 "Save the region as if killed, but don't kill it.
4493 In Transient Mark mode, deactivate the mark.
4494 If `interprogram-cut-function' is non-nil, also save the text for a window
4495 system cut and paste.
4497 If you want to append the killed line to the last killed text,
4500 The copied text is filtered by `filter-buffer-substring' before it is
4501 saved in the kill ring, so the actual saved text might be different
4502 from what was in the buffer.
4504 When called from Lisp, save in the kill ring the stretch of text
4505 between BEG and END, unless the optional argument REGION is
4506 non-nil, in which case ignore BEG and END, and save the current
4507 region instead.
4509 This command is similar to `copy-region-as-kill', except that it gives
4510 visual feedback indicating the extent of the region being copied."
4511 ;; Pass mark first, then point, because the order matters when
4512 ;; calling `kill-append'.
4516 ;; This use of called-interactively-p is correct because the code it
4517 ;; controls just gives the user visual feedback.
4522 "Indicate that the region text has been copied interactively.
4523 If the mark is visible in the selected window, blink the cursor
4524 between point and mark if there is currently no active region
4525 highlighting.
4527 If the mark lies outside the selected window, display an
4528 informative message containing a sample of the copied text. The
4529 optional argument MESSAGE-LEN, if non-nil, specifies the length
4530 of this sample text; it defaults to 40."
4533 ;; Inhibit quitting so we can make a quit here
4534 ;; look like a C-g typed as a command.
4537 ;; Swap point-and-mark quickly so as to show the region that
4538 ;; was selected. Don't do it if the region is highlighted.
4541 ;; Swap point and mark.
4545 ;; Swap back.
4548 ;; If user quit, deactivate the mark
4549 ;; as C-g would as a command.
4555 ;; Don't say "killed"; that is misleading.
4562 "Cause following command, if it kills, to add to previous kill.
4563 If the next command kills forward from point, the kill is
4564 appended to the previous killed text. If the command kills
4565 backward, the kill is prepended. Kill commands that act on the
4566 region, such as `kill-region', are regarded as killing forward if
4567 point is after mark, and killing backward if point is before
4568 mark.
4570 If the next command is not a kill command, `append-next-kill' has
4571 no effect.
4573 The argument is used for internal purposes; do not supply one."
4575 ;; We don't use (interactive-p), since that breaks kbd macros.
4589 "A subroutine of `squeeze-bidi-context'.
4590 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4594 lim1)
4601 ;; L and R categories include embedding and
4602 ;; override controls, but we don't want to
4603 ;; replace them, because that might change
4604 ;; the visual order. Likewise with PDF and
4605 ;; isolate controls.
4607 bidi-directional-non-controls-chars
4608 limit)))))
4609 ;; Replace any run of non-RTL characters by a single LRM.
4611 ;; No more characters of CATEGORY, we are done.
4616 ;; Skip directional controls, if any.
4621 "Replace characters between FROM and TO while keeping bidi context.
4623 This function replaces the region of text with as few characters
4624 as possible, while preserving the effect that region will have on
4625 bidirectional display before and after the region."
4629 ;; This is for when they copy text with read-only text
4630 ;; properties.
4634 ;; Replace each run of non-RTL characters with a single LRM.
4636 ;; Replace each run of non-LTR characters with a single RLM. Note
4637 ;; that the \cR category includes both the Arabic Letter (AL) and
4638 ;; R characters; here we ignore the distinction between them,
4639 ;; because that distinction only affects Arabic Number (AN)
4640 ;; characters, which are weak and don't affect the reordering.
4644 "Return buffer text between START and END with its bidi context.
4646 START and END are assumed to belong to the same physical line
4647 of buffer text. This function prepends and appends to the text
4648 between START and END bidi control characters that preserve the
4649 visual order of that text when it is inserted at some other place."
4654 substr para-dir from to)
4661 ;; If we don't have any mixed directional characters in the
4662 ;; entire line, we can just copy the substring without adding
4663 ;; any context.
4678 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4679 ;; (1) force the string to have the same base embedding
4680 ;; direction as the paragraph direction at the source, no matter
4681 ;; what is the paragraph direction at destination; and (2) avoid
4682 ;; affecting the visual order of the surrounding text at
4683 ;; destination if there are characters of different
4684 ;; directionality there.
4689 "Return portion of current buffer between START and END with bidi context.
4691 This function works similar to `buffer-substring', but it prepends and
4692 appends to the text bidi directional control characters necessary to
4693 preserve the visual appearance of the text if it is inserted at another
4694 place. This is useful when the buffer substring includes bidirectional
4695 text and control characters that cause non-trivial reordering on display.
4696 If copied verbatim, such text can have a very different visual appearance,
4697 and can also change the visual appearance of the surrounding text at the
4698 destination of the copy.
4700 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4701 the text properties."
4714 no-properties)))
4718 substr)))
4719 \f
4720 ;; Yanking.
4725 "List of special text property handling conditions for yanking.
4726 Each element should have the form (PROP . FUN), where PROP is a
4727 property symbol and FUN is a function. When the `yank' command
4728 inserts text into the buffer, it scans the inserted text for
4729 stretches of text that have `eq' values of the text property
4730 PROP; for each such stretch of text, FUN is called with three
4731 arguments: the property's value in that text, and the start and
4732 end positions of the text.
4734 This is done prior to removing the properties specified by
4735 `yank-excluded-properties'."
4738 function))
4741 ;; This is actually used in subr.el but defcustom does not work there.
4744 intangible invisible keymap local-map mouse-face read-only
4745 yank-handler)
4746 "Text properties to discard when yanking.
4747 The value should be a list of text properties to discard or t,
4748 which means to discard all text properties.
4750 See also `yank-handled-properties'."
4757 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4758 Function is called with two parameters, START and END corresponding to
4759 the value of the mark and point; it is guaranteed that START <= END.
4763 "Replace just-yanked stretch of killed text with a different stretch.
4764 This command is allowed only immediately after a `yank' or a `yank-pop'.
4765 At such a time, the region contains a stretch of reinserted
4766 previously-killed text. `yank-pop' deletes that text and inserts in its
4767 place a different stretch of killed text.
4769 With no argument, the previous kill is inserted.
4770 With argument N, insert the Nth previous kill.
4771 If N is negative, this is a more recent kill.
4773 The sequence of kills wraps around, so that after the oldest one
4774 comes the newest one.
4776 When this command inserts killed text into the buffer, it honors
4777 `yank-excluded-properties' and `yank-handler' as described in the
4778 doc string for `insert-for-yank-1', which see."
4792 ;; Set the window start back where it was in the yank command,
4793 ;; if possible.
4796 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4797 ;; It is cleaner to avoid activation, even though the command
4798 ;; loop would deactivate the mark because we inserted text.
4801 nil)
4805 More precisely, reinsert the most recent kill, which is the
4806 stretch of killed text most recently killed OR yanked. Put point
4807 at the end, and set mark at the beginning without activating it.
4809 With argument N, reinsert the Nth most recent kill.
4811 When this command inserts text into the buffer, it honors the
4812 `yank-handled-properties' and `yank-excluded-properties'
4813 variables, and the `yank-handler' text property. See
4814 `insert-for-yank-1' for details.
4819 ;; If we don't get all the way thru, make last-command indicate that
4820 ;; for the following command.
4828 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4829 ;; It is cleaner to avoid activation, even though the command
4830 ;; loop would deactivate the mark because we inserted text.
4833 ;; If we do get all the way thru, make this-command indicate that.
4836 nil)
4839 "Rotate the yanking point in the kill ring.
4840 With ARG, rotate that many kills forward (or backward, if negative)."
4843 \f
4844 ;; Some kill commands.
4846 ;; Internal subroutine of delete-char
4852 ;; Internal subroutine of backward-delete-char
4859 "The method for untabifying when deleting backward.
4860 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4861 `hungry' -- delete all whitespace, both tabs and spaces;
4862 `all' -- delete all whitespace, including tabs, spaces and newlines;
4863 nil -- just delete one character."
4869 "Delete characters backward, changing tabs into spaces.
4870 The exact behavior depends on `backward-delete-char-untabify-method'.
4871 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4872 Interactively, ARG is the prefix arg (default 1)
4873 and KILLP is t if a prefix arg was specified."
4896 arg)))
4897 ;; Avoid warning about delete-backward-char
4901 "Kill up to and including ARGth occurrence of CHAR.
4902 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4903 Goes backward if ARG is negative; error if CHAR not found."
4906 ;; Avoid "obsolete" warnings for translation-table-for-input.
4914 ;; kill-line and its subroutines.
4917 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4922 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4923 With prefix argument ARG, kill that many lines from point.
4924 Negative arguments kill lines backward.
4925 With zero argument, kills the text before point on the current line.
4928 a number counts as a prefix arg.
4930 To kill a whole line, when point is not at the beginning, type \
4933 If `show-trailing-whitespace' is non-nil, this command will just
4934 kill the rest of the current line, even if there are only
4935 nonblanks there.
4937 If option `kill-whole-line' is non-nil, then this command kills the whole line
4938 including its terminating newline, when used at the beginning of a line
4939 with no argument. As a consequence, you can always kill a whole line
4942 If you want to append the killed line to the last killed text,
4945 If the buffer is read-only, Emacs will beep and refrain from deleting
4946 the line, but put the line in the kill ring anyway. This means that
4947 you can use this command to copy text from a read-only buffer.
4948 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4949 even beep.)"
4952 ;; It is better to move point to the other end of the kill
4953 ;; before killing. That way, in a read-only buffer, point
4954 ;; moves across the text that is copied to the kill ring.
4955 ;; The choice has no effect on undo now that undo records
4956 ;; the value of point from before the command was run.
4966 ;; If trailing whitespace is visible,
4967 ;; don't treat it as nothing.
4977 "Kill current line.
4978 With prefix ARG, kill that many lines starting from the current line.
4979 If ARG is negative, kill backward. Also kill the preceding newline.
4981 If ARG is zero, kill current line but exclude the trailing newline."
4992 ;; We need to kill in two steps, because the previous command
4993 ;; could have been a kill command, in which case the text
4994 ;; before point needs to be prepended to the current kill
4995 ;; ring entry and the text after point appended. Also, we
4996 ;; need to use save-excursion to avoid copying the same text
4997 ;; twice to the kill ring in read-only buffers.
5015 "Move forward by ARG lines, ignoring currently invisible newlines only.
5016 If ARG is negative, move backward -ARG lines.
5017 If ARG is zero, move to the beginning of the current line."
5024 ;; If the newline we just skipped is invisible,
5025 ;; don't count it.
5029 prop
5034 ;; If invisible text follows, and it is a number of complete lines,
5035 ;; skip it.
5041 prop
5057 ;; If the newline we just moved to is invisible,
5058 ;; don't count it.
5063 prop
5068 ;; If invisible text follows, and it is a number of complete lines,
5069 ;; skip it.
5075 prop
5086 nil)))
5089 "Move to end of current visible line."
5091 ;; If the following character is currently invisible,
5092 ;; skip all characters with that same `invisible' property value,
5093 ;; then find the next newline.
5100 prop
5109 \f
5111 "Insert after point the contents of BUFFER.
5112 Puts mark after the inserted text.
5113 BUFFER may be a buffer or a buffer name."
5123 t))))
5128 nil)
5131 "Append to specified buffer the text of the region.
5132 It is inserted into that buffer before its point.
5134 When calling from a program, give three arguments:
5135 BUFFER (or buffer name), START and END.
5136 START and END specify the portion of the current buffer to be copied."
5143 point)
5154 "Prepend to specified buffer the text of the region.
5155 It is inserted into that buffer after its point.
5157 When calling from a program, give three arguments:
5158 BUFFER (or buffer name), START and END.
5159 START and END specify the portion of the current buffer to be copied."
5168 "Copy to specified buffer the text of the region.
5169 It is inserted into that buffer, replacing existing text there.
5171 When calling from a program, give three arguments:
5172 BUFFER (or buffer name), START and END.
5173 START and END specify the portion of the current buffer to be copied."
5181 \f
5185 "Hook run when the mark becomes active.
5186 It is also run at the end of a command, if the mark is active and
5193 "Return this buffer's mark value as integer, or nil if never set.
5195 In Transient Mark mode, this function signals an error if
5196 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5197 or the argument FORCE is non-nil, it disregards whether the mark
5198 is active, and returns an integer or nil in the usual way.
5200 If you are using this in an editing command, you are most likely making
5201 a mistake; see the documentation of `set-mark'."
5206 ;; Behind display-selections-p.
5209 "Deactivate the mark.
5210 If Transient Mark mode is disabled, this function normally does
5211 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5213 Deactivating the mark sets `mark-active' to nil, updates the
5214 primary selection according to `select-active-regions', and runs
5215 `deactivate-mark-hook'.
5217 If Transient Mark mode was temporarily enabled, reset the value
5218 of the variable `transient-mark-mode'; if this causes Transient
5219 Mark mode to be disabled, don't change `mark-active' to nil or
5220 run `deactivate-mark-hook'."
5224 select-active-regions)
5227 ;; The var `saved-region-selection', if non-nil, is the text in
5228 ;; the region prior to the last command modifying the buffer.
5229 ;; Set the selection to that, or to the current region.
5234 ;; If another program has acquired the selection, region
5235 ;; deactivation should not clobber it (Bug#11772).
5254 "Activate the mark.
5255 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5265 "Set this buffer's mark to POS. Don't use this function!
5266 That is to say, don't use this function unless you want
5267 the user to see that the mark has moved, and you want the previous
5268 mark position to be lost.
5270 Normally, when a new mark is set, the old one should go on the stack.
5271 This is why most applications should use `push-mark', not `set-mark'.
5273 Novice Emacs Lisp programmers often try to use the mark for the wrong
5274 purposes. The mark saves a location for the user's convenience.
5275 Most editing commands should not alter the mark.
5276 To remember a location for internal use in the Lisp program,
5277 store it in a Lisp variable. Example:
5279 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5284 ;; Normally we never clear mark-active except in Transient Mark mode.
5285 ;; But when we actually clear out the mark value too, we must
5286 ;; clear mark-active in any mode.
5288 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5289 ;; it should never be nil if the mark is nil.
5297 mark-active))
5304 ;; Mark marker
5310 ;; Mark active
5313 ;; If mark is active now, and either was not active or was at a
5314 ;; different place, run the activate hook.
5319 ;; If mark has ceased to be active, run deactivate hook.
5324 "Like `save-excursion', but also save and restore the mark state.
5325 This macro does what `save-excursion' did before Emacs 25.1."
5335 If nil, region-aware commands treat the empty region as inactive.
5336 If non-nil, region-aware commands treat the region as active as
5337 long as the mark is active, even if the region is empty.
5339 Region-aware commands are those that act on the region if it is
5340 active and Transient Mark mode is enabled, and on the text near
5341 point otherwise."
5347 "Return t if the region is active and it is appropriate to act on it.
5348 This is used by commands that act specially on the region under
5349 Transient Mark mode.
5351 The return value is t if Transient Mark mode is enabled and the
5352 mark is active; furthermore, if `use-empty-active-region' is nil,
5353 the region must not be empty. Otherwise, the return value is nil.
5355 For some commands, it may be appropriate to ignore the value of
5356 `use-empty-active-region'; in that case, use `region-active-p'."
5361 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5363 Some commands act specially on the region when Transient Mark
5364 mode is enabled. Usually, such commands should use
5365 `use-region-p' instead of this function, because `use-region-p'
5366 also checks the value of `use-empty-active-region'."
5368 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5369 ;; without the mark being set (e.g. bug#17324). We really should fix
5370 ;; that problem, but in the mean time, let's make sure we don't say the
5371 ;; region is active when there's no mark.
5375 "Return non-nil if the region contains several pieces.
5376 An example is a rectangular region handled as a list of
5377 separate contiguous regions for each line."
5390 ;; Normal priority so that a large region doesn't hide all the
5391 ;; overlays within it, but high secondary priority so that if it
5392 ;; ends/starts in the middle of a small overlay, that small overlay
5393 ;; won't hide the region's boundaries.
5395 nrol)
5400 rol)))
5416 start end window rol)))
5419 new))))))
5422 "Hook run just before redisplay.
5423 It is called in each window that is to be redisplayed. It takes one argument,
5424 which is the window that will be redisplayed. When run, the `current-buffer'
5445 "Maximum size of mark ring. Start discarding off end if gets this big."
5453 "Maximum size of global mark ring. \
5454 Start discarding off end if gets this big."
5459 "Jump to mark, and pop a new position for mark off the ring.
5460 \(Does not affect global mark ring)."
5470 "Set mark at where point is.
5471 If no prefix ARG and mark is already set there, just activate it.
5472 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5484 will pop the mark twice, and
5486 will pop the mark three times.
5494 "Set the mark where point is, or jump to the mark.
5495 Setting the mark also alters the region, which is the text
5496 between point and mark; this is the closest equivalent in
5499 With no prefix argument, set the mark at point, and push the
5500 old mark position on local mark ring. Also push the old mark on
5501 global mark ring, if the previous mark was set in another buffer.
5503 When Transient Mark Mode is off, immediately repeating this
5504 command activates `transient-mark-mode' temporarily.
5507 jump to the mark, and set the mark from
5508 position popped off the local mark ring (this does not affect the global
5510 mark ring (see `pop-global-mark').
5512 If `set-mark-command-repeat-pop' is non-nil, repeating
5514 off the local (or global) mark ring and jumps there.
5517 argument, unconditionally set mark where point is, even if
5518 `set-mark-command-repeat-pop' is non-nil.
5520 Novice Emacs Lisp programmers often try to use the mark for the wrong
5521 purposes. See the documentation of `set-mark' for more information."
5541 arg)
5555 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5556 If the last global mark pushed was not in the current buffer,
5557 also push LOCATION on the global mark ring.
5558 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5560 Novice Emacs Lisp programmers often try to use the mark for the wrong
5561 purposes. See the documentation of `set-mark' for more information.
5563 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5570 ;; Now push the mark on the global mark ring.
5573 ;; The last global mark pushed was in this same buffer.
5574 ;; Don't push another one.
5575 nil
5584 nil)
5587 "Pop off mark ring into the buffer's actual mark.
5588 Does not set point. Does nothing if mark ring is empty."
5600 "Put the mark where point is now, and point where the mark is now.
5601 This command works even when the mark is not active,
5602 and it reactivates the mark.
5604 If Transient Mark mode is on, a prefix ARG deactivates the mark
5605 if it is active, and otherwise avoids reactivating it. If
5606 Transient Mark mode is off, a prefix ARG enables Transient Mark
5607 mode temporarily."
5621 nil))
5624 "When non-nil, shifted motion keys activate the mark momentarily.
5626 While the mark is activated in this way, any shift-translated point
5627 motion key extends the region, and if Transient Mark mode was off, it
5628 is temporarily turned on. Furthermore, the mark will be deactivated
5629 by any subsequent point motion key that was not shift-translated, or
5630 by any action that normally deactivates the mark in Transient Mark mode.
5632 See `this-command-keys-shift-translated' for the meaning of
5633 shift-translation."
5638 "Activate/deactivate mark depending on invocation thru shift translation.
5639 This function is called by `call-interactively' when a command
5640 with a `^' character in its `interactive' spec is invoked, before
5641 running the command itself.
5643 If `shift-select-mode' is enabled and the command was invoked
5644 through shift translation, set the mark and activate the region
5645 temporarily, unless it was already set in this way. See
5646 `this-command-keys-shift-translated' for the meaning of shift
5647 translation.
5649 Otherwise, if the region has been activated temporarily,
5650 deactivate it, and restore the variable `transient-mark-mode' to
5651 its earlier value."
5658 transient-mark-mode)))
5667 "Toggle Transient Mark mode.
5668 With a prefix argument ARG, enable Transient Mark mode if ARG is
5669 positive, and disable it otherwise. If called from Lisp, enable
5670 Transient Mark mode if ARG is omitted or nil.
5672 Transient Mark mode is a global minor mode. When enabled, the
5673 region is highlighted with the `region' face whenever the mark
5675 and after certain other operations that set the mark but whose
5676 main purpose is something else--for example, incremental search,
5682 Many commands change their behavior when Transient Mark mode is
5683 in effect and the mark is active, by acting on the region instead
5684 of their usual default part of the buffer's text. Examples of
5687 To see the documentation of commands which are sensitive to the
5690 :global t
5691 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5695 "Non-nil means it is ok for commands to call `widen' when they want to.
5696 Some commands will do this in order to go to positions outside
5697 the current accessible part of the buffer.
5699 If `widen-automatically' is nil, these commands will do something else
5703 "Whether the currently executing code is performing an essential task.
5704 This variable should be non-nil only when running code which should not
5705 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5706 user for a password when we are simply scanning a set of files in the
5707 background or displaying possible completions before the user even asked
5711 "Pop off global mark ring and jump to the top location."
5713 ;; Pop entries which refer to non-existent buffers.
5731 \f
5733 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5739 "Move cursor vertically down ARG lines.
5740 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5741 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5742 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5743 function will not vscroll.
5745 ARG defaults to 1.
5747 If there is no character in the target line exactly under the current column,
5748 the cursor is positioned after the character in that line which spans this
5749 column, or at the end of the line if it is not long enough.
5750 If there is no line in the buffer after this one, behavior depends on the
5751 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5752 to create a line, and moves the cursor to that line. Otherwise it moves the
5753 cursor to the end of the buffer.
5755 If the variable `line-move-visual' is non-nil, this command moves
5756 by display lines. Otherwise, it moves by buffer lines, without
5757 taking variable-width characters or continued lines into account.
5760 a semipermanent goal column for this command.
5761 Then instead of trying to move exactly vertically (or as close as possible),
5762 this command moves to the specified goal column (or as close as possible).
5763 The goal column is stored in the variable `goal-column', which is nil
5764 when there is no goal column. Note that setting `goal-column'
5765 overrides `line-move-visual' and causes this command to move by buffer
5766 lines rather than by display lines."
5772 ;; When adding a newline, don't expand an abbrev.
5783 nil)
5786 "Move cursor vertically up ARG lines.
5787 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5788 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5789 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5790 function will not vscroll.
5792 ARG defaults to 1.
5794 If there is no character in the target line exactly over the current column,
5795 the cursor is positioned after the character in that line which spans this
5796 column, or at the end of the line if it is not long enough.
5798 If the variable `line-move-visual' is non-nil, this command moves
5799 by display lines. Otherwise, it moves by buffer lines, without
5800 taking variable-width characters or continued lines into account.
5803 a semipermanent goal column for this command.
5804 Then instead of trying to move exactly vertically (or as close as possible),
5805 this command moves to the specified goal column (or as close as possible).
5806 The goal column is stored in the variable `goal-column', which is nil
5807 when there is no goal column. Note that setting `goal-column'
5808 overrides `line-move-visual' and causes this command to move by buffer
5809 lines rather than by display lines."
5820 nil)
5823 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5824 This means moving to the end of each line moved onto.
5825 The beginning of a blank line does not count as the end of a line.
5826 This has no effect when the variable `line-move-visual' is non-nil."
5832 A non-nil setting overrides the variable `line-move-visual', which see."
5839 "Current goal column for vertical motion.
5840 It is the column where point was at the start of the current run
5841 of vertical motion commands.
5843 When moving by visual lines via the function `line-move-visual', it is a cons
5844 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5845 divided by the default column width, and HSCROLL is the number of
5846 columns by which window is scrolled from left margin.
5848 When the `track-eol' feature is doing its job, the value is
5852 "Non-nil means commands that move by lines ignore invisible newlines.
5853 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5854 as if newlines that are invisible didn't exist, and count
5855 only visible newlines. Thus, moving across across 2 newlines
5856 one of which is invisible will be counted as a one-line move.
5857 Also, a non-nil value causes invisible text to be ignored when
5858 counting columns for the purposes of keeping point in the same
5861 Outline mode sets this."
5866 "When non-nil, `line-move' moves point by visual lines.
5867 This movement is based on where the cursor is displayed on the
5868 screen, instead of relying on buffer contents alone. It takes
5869 into account variable-width characters and line continuation.
5870 If nil, `line-move' moves point by logical lines.
5871 A non-nil setting of `goal-column' overrides the value of this variable
5872 and forces movement by logical lines.
5873 A window that is horizontally scrolled also forces movement by logical
5874 lines."
5879 ;; Only used if display-graphic-p.
5883 "Return the height in pixels of the current buffer's default face font.
5885 If the default font is remapped (see `face-remapping-alist'), the
5886 function returns the height of the remapped face."
5890 ;; Avoid calling font-info if the frame's default font was
5891 ;; not changed since the frame was created. That's because
5892 ;; font-info is expensive for some fonts, see bug #14838.
5898 "Return the width in pixels of the current buffer's default face font.
5900 If the default font is remapped (see `face-remapping-alist'), the
5901 function returns the width of the remapped face."
5905 ;; Avoid calling font-info if the frame's default font was
5906 ;; not changed since the frame was created. That's because
5907 ;; font-info is expensive for some fonts, see bug #14838.
5912 width
5917 "Return the pixel height of current buffer's default-face text line.
5919 The value includes `line-spacing', if any, defined for the buffer
5920 or the frame."
5933 "Return the number of screen lines in the text area of the selected window.
5935 This is different from `window-text-height' in that this function counts
5936 lines in units of the height of the font used by the default face displayed
5937 in the window, not in units of the frame's default font, and also accounts
5938 for `line-spacing', if any, defined for the window's buffer or frame.
5940 The value is a floating-point number."
5945 ;; Returns non-nil if partial move was done.
5948 ;; Move backward (up).
5949 ;; If already vscrolled, reduce vscroll
5955 ;; Move forward (down).
5968 py vs last-line)
5988 col-row)
5993 ;; VPOS > 0 means the last line is only partially visible.
5994 ;; But if the part that is visible is at least as tall as the
5995 ;; default font, that means the line is actually fully
5996 ;; readable, and something like line-spacing is hidden. So in
5997 ;; that case we accept the last line in the window as still
5998 ;; visible, and consider the margin as starting one line
5999 ;; later.
6007 ;; If last line of window is fully visible, and vscrolling
6008 ;; more would make this line invisible, move forward.
6013 nil)
6014 ;; If cursor is not in the bottom scroll margin, and the
6015 ;; current line is is not too tall, move forward.
6017 vpos
6020 nil)
6021 ;; When already vscrolled, we vscroll some more if we can,
6022 ;; or clear vscroll and move forward at end of tall image.
6027 ;; If cursor just entered the bottom scroll margin, move forward,
6028 ;; but also optionally vscroll one line so redisplay won't recenter.
6032 ;; Don't vscroll if the partially-visible line at window
6033 ;; bottom is not too tall (a.k.a. "just one more text
6034 ;; line"): in that case, we do want redisplay to behave
6035 ;; normally, i.e. recenter or whatever.
6036 ;;
6037 ;; Note: ROWH + RBOT from the value returned by
6038 ;; pos-visible-in-window-p give the total height of the
6039 ;; partially-visible glyph row at the end of the window. As
6040 ;; we are dealing with floats, we disregard sub-pixel
6041 ;; discrepancies between that and DLH.
6045 t)
6046 ;; If there are lines above the last line, scroll-up one line.
6049 t)
6050 ;; Finally, start vscroll.
6055 ;; This is like line-move-1 except that it also performs
6056 ;; vertical scrolling of tall images if appropriate.
6057 ;; That is not really a clean thing to do, since it mixes
6058 ;; scrolling with cursor motion. But so far we don't have
6059 ;; a cleaner solution to the problem of making C-n do something
6060 ;; useful given a tall image.
6062 "Move forward ARG lines.
6063 If NOERROR, don't signal an error if we can't move ARG lines.
6064 TO-END is unused.
6065 TRY-VSCROLL controls whether to vscroll tall lines: if either
6066 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
6067 not vscroll."
6071 ;; Only vscroll for single line moves
6073 ;; Under scroll-conservatively, the display engine
6074 ;; does this better.
6076 ;; But don't vscroll in a keyboard macro.
6082 ;; Display-based column are incompatible with goal-column.
6084 ;; When the text in the window is scrolled to the left,
6085 ;; display-based motion doesn't make sense (because each
6086 ;; logical line occupies exactly one screen line).
6088 ;; Likewise when the text _was_ scrolled to the left
6089 ;; when the current run of vertical motion commands
6090 ;; started.
6093 auto-hscroll-mode
6095 (>= temporary-goal-column
6098 ;; If we moved into a tall line, set vscroll to make
6099 ;; scrolling through tall images more smooth.
6103 winh)
6109 nil
6113 ;; Display-based alternative to line-move-1.
6114 ;; Arg says how many lines to move. The value is t if we can move the
6115 ;; specified number of lines.
6117 "Move ARG lines forward.
6118 If NOERROR, don't signal an error if we can't move that many lines."
6121 target-hscroll)
6122 ;; Check if the previous command was a line-motion command, or if
6123 ;; we were called from some other command.
6126 ;; If so, there's no need to reset `temporary-goal-column',
6127 ;; but we may need to hscroll.
6131 ;; Otherwise, we should reset `temporary-goal-column'.
6133 x-pos)
6135 ;; Handle the `overflow-newline-into-fringe' case:
6140 ;; In R2L lines, the X pixel coordinate is measured from the
6141 ;; left edge of the window, but columns are still counted
6142 ;; from the logical-order beginning of the line, i.e. from
6143 ;; the right edge in this case. We need to adjust for that.
6149 hscroll)))
6151 ;; When we move beyond the first/last character visible in
6152 ;; the window, posn-at-point will return nil, so we need to
6153 ;; approximate the goal column as below.
6158 ;; vertical-motion can move more than it was asked to if it moves
6159 ;; across display strings with newlines. We don't want to ring
6160 ;; the bell and announce beginning/end of buffer in that case.
6166 temporary-goal-column))
6167 arg))
6168 arg))
6174 temporary-goal-column))
6175 arg))
6176 arg)))
6179 ;; If the goal column lies on a display string,
6180 ;; `vertical-motion' advances the cursor to the end
6181 ;; of the string. For arg < 0, this can cause the
6182 ;; cursor to get stuck. (Bug#3020).
6186 nil)))))
6188 ;; This is the guts of next-line and previous-line.
6189 ;; Arg says how many lines to move.
6190 ;; The value is t if we can move the specified number of lines.
6192 ;; Don't run any point-motion hooks, and disregard intangibility,
6193 ;; for intermediate positions.
6205 ;; Don't count beg of empty line as end of line
6206 ;; unless we just did explicit end-of-line.
6208 most-positive-fixnum
6212 line-move-ignore-invisible))
6213 ;; Use just newline characters.
6214 ;; Set ARG to 0 if we move as many lines as requested.
6217 ;; This way of moving forward ARG lines
6218 ;; verifies that we have a newline after the last one.
6219 ;; It doesn't get confused by intangible text.
6228 'beginning-of-buffer
6230 nil)))
6231 ;; Move by arg lines, but ignore invisible ones.
6234 ;; If the following character is currently invisible,
6235 ;; skip all characters with that same `invisible' property value.
6238 ;; Move a line.
6239 ;; We don't use `end-of-line', since we want to escape
6240 ;; from field boundaries occurring exactly at point.
6246 ;; If there's no invisibility here, move over the newline.
6255 ;; We avoid vertical-motion when possible
6256 ;; because that has to fontify.
6258 ;; Otherwise move a more sophisticated way.
6265 ;; The logic of this is the same as the loop above,
6266 ;; it just goes in the other direction.
6268 ;; For completely consistency with the forward-motion
6269 ;; case, we should call beginning-of-line here.
6270 ;; However, if point is inside a field and on a
6271 ;; continued line, the call to (vertical-motion -1)
6272 ;; below won't move us back far enough; then we return
6273 ;; to the same column in line-move-finish, and point
6274 ;; gets stuck -- cyd
6292 ;; if our target is the middle of this line.
6297 ;; This is the value the function returns.
6301 ;; If we did not move down as far as desired, at least go
6302 ;; to end of line. Be sure to call point-entered and
6303 ;; point-left-hooks.
6309 ;; If we did not move up as far as desired,
6310 ;; at least go to beginning of line.
6322 ;; Set REPEAT to t to repeat the whole thing.
6329 ;; Compute the end of the line
6330 ;; ignoring effectively invisible newlines.
6332 ;; Like end-of-line but ignores fields.
6339 ;; Move to the desired column.
6342 ;; Corner case: suppose we start out in a field boundary in
6343 ;; the middle of a continued line. When we get to
6344 ;; line-move-finish, point is at the start of a new *screen*
6345 ;; line but the same text line; then line-move-to-column would
6346 ;; move us backwards. Test using C-n with point on the "x" in
6347 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6354 ;; Process intangibility within a line.
6355 ;; With inhibit-point-motion-hooks bound to nil, a call to
6356 ;; goto-char moves point past intangible text.
6358 ;; However, inhibit-point-motion-hooks controls both the
6359 ;; intangibility and the point-entered/point-left hooks. The
6360 ;; following hack avoids calling the point-* hooks
6361 ;; unnecessarily. Note that we move *forward* past intangible
6362 ;; text when the initial and final points are the same.
6367 ;; If intangibility moves us to a different (later) place
6368 ;; in the same line, use that as the destination.
6371 ;; If that position is "too late",
6372 ;; try the previous allowable position.
6373 ;; See if it is ok.
6376 ;; If going forward, don't accept the previous
6377 ;; allowable position if it is before the target line.
6379 ;; If going backward, don't accept the previous
6380 ;; allowable position if it is still after the target line.
6383 ;; As a last resort, use the end of the line.
6386 ;; Now move to the updated destination, processing fields
6387 ;; as well as intangibility.
6391 ;; Ignore field boundaries if the initial and final
6392 ;; positions have the same `field' property, even if the
6393 ;; fields are non-contiguous. This seems to be "nicer"
6394 ;; behavior in many situations.
6397 new
6401 ;; If all this moved us to a different line,
6402 ;; retry everything within that new line.
6404 ;; Repeat the intangibility and field processing.
6408 "Try to find column COL, considering invisibility.
6409 This function works only in certain cases,
6410 because what we really need is for `move-to-column'
6411 and `current-column' to be able to ignore invisible text."
6420 ;; If the following character is currently invisible,
6421 ;; skip all characters with that same `invisible' property value.
6425 ;; Have we advanced to a larger column position?
6427 ;; We have made some progress towards the desired column.
6428 ;; See if we can make any further progress.
6430 ;; Otherwise, go to the place we originally found
6431 ;; and move back over invisible text.
6432 ;; that will get us to the same place on the screen
6433 ;; but with a more reasonable buffer position.
6436 ;; We want the real line beginning, so it's consistent
6437 ;; with bolp below, otherwise we might infloop.
6444 "Move point to end of current line as displayed.
6445 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6446 If point reaches the beginning or end of buffer, it stops there.
6448 To ignore the effects of the `intangible' text or overlay
6449 property, bind `inhibit-point-motion-hooks' to t.
6450 If there is an image in the current line, this function
6451 disregards newlines that are part of the text on which the image
6452 rests."
6462 ;; With bidi reordering, we may not be at bol,
6463 ;; so make sure we are.
6478 ;; If we skipped something intangible and now we're not
6479 ;; really at eol, keep going.
6484 "Move point to beginning of current line as displayed.
6485 \(If there's an image in the line, this disregards newlines
6486 which are part of the text that the image rests on.)
6488 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6489 If point reaches the beginning or end of buffer, it stops there.
6490 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6495 first-vis first-vis-field-value)
6497 ;; Move by lines, if ARG is not 1 (the default).
6502 ;; Move to beginning-of-line, ignoring fields and invisible text.
6508 ;; Now find first visible char in the line.
6513 ;; See if fields would stop us from reaching FIRST-VIS.
6518 ;; If yes, obey them.
6519 first-vis-field-value
6520 ;; Otherwise, move to START with attention to fields.
6521 ;; (It is possible that fields never matter in this case.)
6526 ;; Many people have said they rarely use this feature, and often type
6527 ;; it by accident. Maybe it shouldn't even be on a key.
6532 Those commands will move to this position in the line moved to
6533 rather than trying to keep the same horizontal position.
6534 With a non-nil argument ARG, clears out the goal column
6536 The goal column is stored in the variable `goal-column'.
6537 This is a buffer-local setting."
6544 ;; The older method below can be erroneous if `set-goal-column' is bound
6545 ;; to a sequence containing %
6546 ;;(message (substitute-command-keys
6547 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6548 ;;goal-column)
6555 )
6556 nil)
6557 \f
6558 ;;; Editing based on visual lines, as opposed to logical lines.
6561 "Move point to end of current visual line.
6562 With argument N not nil or 1, move forward N - 1 visual lines first.
6563 If point reaches the beginning or end of buffer, it stops there.
6564 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6570 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6571 ;; constrain to field boundaries, so we don't either.
6575 "Move point to beginning of current visual line.
6576 With argument N not nil or 1, move forward N - 1 visual lines first.
6577 If point reaches the beginning or end of buffer, it stops there.
6578 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6586 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6590 "Kill the rest of the visual line.
6591 With prefix argument ARG, kill that many visual lines from point.
6592 If ARG is negative, kill visual lines backward.
6593 If ARG is zero, kill the text before point on the current visual
6594 line.
6596 If you want to append the killed line to the last killed text,
6599 If the buffer is read-only, Emacs will beep and refrain from deleting
6600 the line, but put the line in the kill ring anyway. This means that
6601 you can use this command to copy text from a read-only buffer.
6602 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6603 even beep.)"
6605 ;; Like in `kill-line', it's better to move point to the other end
6606 ;; of the kill before killing.
6614 ;; Skip any trailing whitespace at the end of the visual line.
6615 ;; We used to do this only if `show-trailing-whitespace' is
6616 ;; nil, but that's wrong; the correct thing would be to check
6617 ;; whether the trailing whitespace is highlighted. But, it's
6618 ;; OK to just do this unconditionally.
6625 "Move cursor vertically down ARG lines.
6626 This is identical to `next-line', except that it always moves
6627 by logical lines instead of visual lines, ignoring the value of
6628 the variable `line-move-visual'."
6635 "Move cursor vertically up ARG lines.
6636 This is identical to `previous-line', except that it always moves
6637 by logical lines instead of visual lines, ignoring the value of
6638 the variable `line-move-visual'."
6645 "Editing based on visual lines."
6654 ;; These keybindings interfere with xterm function keys. Are
6655 ;; there any other suitable bindings?
6656 ;; (define-key map "\M-[" 'previous-logical-line)
6657 ;; (define-key map "\M-]" 'next-logical-line)
6658 map))
6661 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6662 The value should be a list of the form (LEFT RIGHT), where LEFT
6663 and RIGHT are symbols representing the bitmaps to display, to
6664 indicate wrapped lines, in the left and right fringes respectively.
6665 See also `fringe-indicator-alist'.
6666 The default is not to display fringe indicators for wrapped lines.
6667 This variable does not affect fringe indicators displayed for
6668 other purposes."
6683 'continuation
6690 "Toggle visual line based editing (Visual Line mode).
6691 With a prefix argument ARG, enable Visual Line mode if ARG is
6692 positive, and disable it otherwise. If called from Lisp, enable
6693 the mode if ARG is omitted or nil.
6695 When Visual Line mode is enabled, `word-wrap' is turned on in
6696 this buffer, and simple editing commands are redefined to act on
6697 visual lines, not logical lines. See Info node `Visual Line
6698 Mode' for details."
6699 :keymap visual-line-mode-map
6705 ;; Save the local values of some variables, to be restored if
6706 ;; visual-line-mode is turned off.
6708 truncate-partial-width-windows
6709 word-wrap fringe-indicator-alist))
6712 visual-line--saved-state)))
6716 word-wrap t
6717 fringe-indicator-alist
6719 fringe-indicator-alist)))
6733 visual-line-mode turn-on-visual-line-mode)
6735 \f
6737 "Interchange characters around point, moving forward one character.
6738 With prefix arg ARG, effect is to take character before point
6739 and drag it forward past ARG other characters (backward if ARG negative).
6740 If no argument and at end of line, the previous two chars are exchanged."
6748 "Interchange words around point, leaving point at end of them.
6749 With prefix arg ARG, effect is to take word before or around point
6750 and drag it forward past ARG other words (backward if ARG negative).
6751 If ARG is zero, the words around or after point and around or after mark
6752 are interchanged."
6753 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6759 Does not work on a sexp that point is in the middle of
6760 if it is a list or string."
6764 ;; Here we should try to simulate the behavior of
6765 ;; (cons (progn (forward-sexp x) (point))
6766 ;; (progn (forward-sexp (- x)) (point)))
6767 ;; Except that we don't want to rely on the second forward-sexp
6768 ;; putting us back to where we want to be, since forward-sexp-function
6769 ;; might do funny things like infix-precedence.
6774 ;; Jumping over a symbol. We might be inside it, mind you.
6779 ;; Otherwise, we're between sexps. Take a step back before jumping
6780 ;; to make sure we'll obey the same precedence no matter which direction
6781 ;; we're going.
6786 'skip-syntax-forward
6793 "Exchange current line and previous line, leaving point after both.
6794 With argument ARG, takes previous line and moves it past ARG lines.
6795 With argument 0, interchanges line point is in with line mark is in."
6801 ;; Move forward over ARG lines,
6802 ;; but create newlines if necessary.
6809 arg))
6811 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6812 ;; which seems inconsistent with the ARG /= 0 case.
6813 ;; FIXME document SPECIAL.
6815 "Subroutine to do the work of transposing objects.
6816 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6817 moves forward by units of the given object (e.g. forward-sentence,
6818 forward-paragraph). If ARG is zero, exchanges the current object
6819 with the one containing mark. If ARG is an integer, moves the
6820 current object past ARG following (if ARG is positive) or
6821 preceding (if ARG is negative) objects, leaving point after the
6822 current object."
6827 pos1 pos2)
6856 ;; This sequence of insertions attempts to preserve marker
6857 ;; positions at the start and end of the transposed objects.
6871 \f
6873 "Move backward until encountering the beginning of a word.
6874 With argument ARG, do this that many times.
6875 If ARG is omitted or nil, move point backward one word.
6877 The word boundaries are normally determined by the buffer's syntax
6878 table, but `find-word-boundary-function-table', such as set up
6879 by `subword-mode', can change that. If a Lisp program needs to
6880 move by words determined strictly by the syntax table, it should
6881 use `backward-word-strictly' instead."
6886 "Set mark ARG words away from point.
6888 move to with the same argument.
6889 Interactively, if this command is repeated
6890 or (in Transient Mark mode) if the mark is active,
6891 it marks the next ARG words after the ones already marked."
6908 nil t))))
6911 "Kill characters forward until encountering the end of a word.
6912 With argument ARG, do this that many times."
6917 "Kill characters backward until encountering the beginning of a word.
6918 With argument ARG, do this that many times."
6923 "Return the symbol or word that point is on (or a nearby one) as a string.
6924 The return value includes no text properties.
6925 If optional arg STRICT is non-nil, return nil unless point is within
6926 or adjacent to a symbol or word. In all cases the value can be nil
6927 if there is no word nearby.
6928 The function, belying its name, normally finds a symbol.
6929 If optional arg REALLY-WORD is non-nil, it finds just a word."
6938 ;; Point is neither within nor adjacent to a word.
6940 ;; Look for preceding word in same line.
6943 ;; No preceding word in same line.
6944 ;; Look for following word in same line.
6953 ;; If we found something nonempty, return it as a string.
6956 \f
6958 "String for filling to insert at front of new line, or nil for none."
6960 string)
6966 "Regexp to match lines which should not be auto-filled."
6968 regexp)
6972 "The default value for `normal-auto-fill-function'.
6973 This is the default auto-fill function, some major modes use a different one.
6974 Returns t if it really did any work."
6984 nil ;; Auto-filling not required
6988 ;; Choose a fill-prefix automatically.
6996 ;; Use auto-indentation rather than a guessed empty prefix.
7002 ;; Determine where to split the line.
7015 ;; See whether the place we found is any good.
7019 ;; There is no use breaking at end of line.
7021 ;; It is futile to split at the end of the prefix
7022 ;; since we would just insert the prefix again.
7024 ;; Don't split right after a comment starter
7025 ;; since we would just make another comment starter.
7030 limit t)
7032 ;; No good place to break => stop trying.
7034 ;; Ok, we have a useful place to break the line. Do it.
7036 ;; If point is at the fill-point, do not `save-excursion'.
7037 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
7038 ;; point will end up before it rather than after it.
7046 ;; Now do justification, if required
7051 ;; If making the new line didn't reduce the hpos of
7052 ;; the end of the line, then give up now;
7053 ;; trying again will not help.
7056 ;; Justify last line.
7058 t)))
7061 "Mode-specific function which line breaks and continues a comment.
7062 This function is called during auto-filling when a comment syntax
7063 is defined.
7064 The function should take a single optional argument, which is a flag
7068 "Break line at point and indent.
7069 If a comment syntax is defined, call `comment-indent-new-line'.
7071 The inserted newline is marked hard if variable `use-hard-newlines' is true,
7072 unless optional argument SOFT is non-nil."
7076 ;; Insert the newline before removing empty space so that markers
7077 ;; get preserved better.
7083 ;; Blindly trust a non-adaptive fill-prefix.
7089 ;; If there's an adaptive prefix, use it unless we're inside
7090 ;; a comment and the prefix is not a comment starter.
7094 ;; If we're not inside a comment, just try to indent.
7098 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7102 ;; `functions' and `hooks' are usually unsafe to set, but setting
7103 ;; auto-fill-function to nil in a file-local setting is safe and
7104 ;; can be useful to prevent auto-filling.
7108 "Toggle automatic line breaking (Auto Fill mode).
7109 With a prefix argument ARG, enable Auto Fill mode if ARG is
7110 positive, and disable it otherwise. If called from Lisp, enable
7111 the mode if ARG is omitted or nil.
7113 When Auto Fill mode is enabled, inserting a space at a column
7114 beyond `current-fill-column' automatically breaks the line at a
7115 previous space.
7117 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7118 non-nil.
7120 The value of `normal-auto-fill-function' specifies the function to use
7121 for `auto-fill-function' when turning Auto Fill mode on."
7126 ;; This holds a document string used to document auto-fill-mode.
7128 "Automatically break line at a previous space, in insertion of text."
7129 nil)
7132 "Unconditionally turn on Auto Fill mode."
7136 "Unconditionally turn off Auto Fill mode."
7142 "Set `fill-column' to specified argument.
7147 ;; We used to use current-column silently, but C-x f is too easily
7148 ;; typed as a typo for C-x C-f, so we turned it into an error and
7149 ;; now an interactive prompt.
7154 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7158 \f
7160 "Set `selective-display' to ARG; clear it if no arg.
7161 When the value of `selective-display' is a number > 0,
7162 lines whose indentation is >= that value are not displayed.
7163 The variable `selective-display' has a separate value for each buffer."
7183 "Toggle truncating of long lines for the current buffer.
7184 When truncating is off, long lines are folded.
7185 With prefix argument ARG, truncate long lines if ARG is positive,
7186 otherwise fold them. Note that in side-by-side windows, this
7187 command has no effect if `truncate-partial-width-windows' is
7188 non-nil."
7200 nil t)))
7205 "Toggle whether to use word-wrapping for continuation lines.
7206 With prefix argument ARG, wrap continuation lines at word boundaries
7207 if ARG is positive, otherwise wrap them at the right screen edge.
7208 This command toggles the value of `word-wrap'. It has no effect
7209 if long lines are truncated."
7225 "Toggle Overwrite mode.
7226 With a prefix argument ARG, enable Overwrite mode if ARG is
7227 positive, and disable it otherwise. If called from Lisp, enable
7228 the mode if ARG is omitted or nil.
7230 When Overwrite mode is enabled, printing characters typed in
7231 replace existing text on a one-for-one basis, rather than pushing
7232 it to the right. At the end of a line, such characters extend
7233 the line. Before a tab, such characters insert until the tab is
7235 overwrite mode; this is supposed to make it easier to insert
7236 characters when necessary."
7241 "Toggle Binary Overwrite mode.
7242 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7243 is positive, and disable it otherwise. If called from Lisp,
7244 enable the mode if ARG is omitted or nil.
7246 When Binary Overwrite mode is enabled, printing characters typed
7247 in replace existing text. Newlines are not treated specially, so
7248 typing at the end of a line joins the line to the next, with the
7249 typed character between them. Typing before a tab character
7250 simply replaces the tab with the character typed.
7252 ordinary typing characters do.
7254 Note that Binary Overwrite mode is not its own minor mode; it is
7255 a specialization of overwrite mode, entered by setting the
7256 `overwrite-mode' variable to `overwrite-mode-binary'."
7261 "Toggle line number display in the mode line (Line Number mode).
7262 With a prefix argument ARG, enable Line Number mode if ARG is
7263 positive, and disable it otherwise. If called from Lisp, enable
7264 the mode if ARG is omitted or nil.
7266 Line numbers do not appear for very large buffers and buffers
7267 with very long lines; see variables `line-number-display-limit'
7268 and `line-number-display-limit-width'."
7272 "Toggle column number display in the mode line (Column Number mode).
7273 With a prefix argument ARG, enable Column Number mode if ARG is
7274 positive, and disable it otherwise.
7276 If called from Lisp, enable the mode if ARG is omitted or nil."
7280 "Toggle buffer size display in the mode line (Size Indication mode).
7281 With a prefix argument ARG, enable Size Indication mode if ARG is
7282 positive, and disable it otherwise.
7284 If called from Lisp, enable the mode if ARG is omitted or nil."
7288 "Toggle auto-saving in the current buffer (Auto Save mode).
7289 With a prefix argument ARG, enable Auto Save mode if ARG is
7290 positive, and disable it otherwise.
7292 If called from Lisp, enable the mode if ARG is omitted or nil."
7294 ;; If auto-save is off because buffer has shrunk,
7295 ;; then toggling should turn it on.
7303 buffer-file-name)
7305 ;; If -1 was stored here, to temporarily turn off saving,
7306 ;; turn it back on.
7309 \f
7311 "Blinking matching of parens and expressions."
7316 "Non-nil means show matching open-paren when close-paren is inserted.
7317 If t, highlight the paren. If `jump', briefly move cursor to its
7318 position. If `jump-offscreen', move cursor there even if the
7319 position is off screen. With any other non-nil value, the
7320 off-screen position of the opening paren will be shown in the
7321 echo area."
7330 "Non-nil means show matching open-paren when it is on screen.
7331 If nil, don't show it (but the open-paren can still be shown
7332 in the echo area when it is off screen).
7334 This variable has no effect if `blink-matching-paren' is nil.
7335 \(In that case, the open-paren is never shown.)
7336 It is also ignored if `show-paren-mode' is enabled."
7341 "If non-nil, maximum distance to search backwards for matching open-paren.
7342 If nil, search stops at the beginning of the accessible portion of the buffer."
7348 "Time in seconds to delay after showing a matching paren."
7353 "If nil, `blink-matching-paren' ignores comments.
7354 More precisely, when looking for the matching parenthesis,
7355 it skips the contents of comments that end before point."
7360 "Return whether or not START...END are matching parens.
7361 END is the current point and START is the blink position.
7362 START might be nil if no matching starter was found.
7363 Returns non-nil if we find there is a mismatch."
7368 ;; For self-matched chars like " and $, we can't know when they're
7369 ;; mismatched or unmatched, so we can only do it for parens.
7374 ;; The cdr might hold a new paren-class info rather than
7375 ;; a matching-char info, in which case the two CDRs
7376 ;; should match.
7380 "Function to check parentheses mismatches.
7381 The function takes two arguments (START and END) where START is the
7382 position just before the opening token and END is the position right after.
7383 START can be nil, if it was not found.
7390 ol)
7394 "Momentarily highlight the beginning of the sexp before point."
7397 blink-matching-paren)
7407 oldpos))
7415 ;; backward-sexp skips backward over prefix chars,
7416 ;; so move back to the matching paren.
7439 ;; Matching open within window, temporarily move to or highlight
7440 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7441 ;; is non-nil.
7458 ;; Show what precedes the open in its line, if anything.
7463 ;; Show what follows the open in its line, if anything.
7470 ;; Otherwise show the previous nonblank line,
7471 ;; if there is one.
7480 ;; Replace the newline and other whitespace with `...'.
7481 "..."
7483 ;; There is nothing to show except the char itself.
7486 "Matches %s"
7490 "Function called, if non-nil, whenever a close parenthesis is inserted.
7496 blink-paren-function
7499 ;; Verify an even number of quoting characters precede the close.
7500 ;; FIXME: Also check if this parenthesis closes a comment as
7501 ;; can happen in Pascal and SML.
7512 ;; Most likely, this hook is nil, so this arg doesn't matter,
7513 ;; but I use it as a reminder that this function usually
7514 ;; likes to be run after others since it does
7515 ;; `sit-for'. That's also the reason it get a `priority' prop
7516 ;; of 100.
7518 \f
7519 ;; This executes C-g typed while Emacs is waiting for a command.
7520 ;; Quitting out of a program does not go through here;
7521 ;; that happens in the QUIT macro at the C code level.
7523 "Signal a `quit' condition.
7524 During execution of Lisp code, this character causes a quit directly.
7525 At top-level, as an editor command, this simply beeps."
7527 ;; Avoid adding the region to the window selection.
7535 ;; Force the next redisplay cycle to remove the "Def" indicator from
7536 ;; all the mode lines.
7550 This command can exit an interactive command such as `query-replace',
7551 can clear out a prefix argument or a region,
7552 can get out of the minibuffer or other recursive edit,
7553 cancel the use of the current buffer (for special-purpose buffers),
7554 or go back to just one window (by deleting all but the selected window)."
7562 nil)
7573 "Play sound stored in FILE.
7574 VOLUME and DEVICE correspond to the keywords of the sound
7575 specification for `play-sound'."
7585 \f
7587 "Your preference for a mail reading package.
7588 This is used by some keybindings which support reading mail.
7589 See also `mail-user-agent' concerning sending mail."
7599 "Your preference for a mail composition package.
7600 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7601 outgoing email message. This variable lets you specify which
7602 mail-sending package you prefer.
7604 Valid values include:
7606 `message-user-agent' -- use the Message package.
7607 See Info node `(message)'.
7608 `sendmail-user-agent' -- use the Mail package.
7609 See Info node `(emacs)Sending Mail'.
7610 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7611 See Info node `(mh-e)'.
7612 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7613 paraphernalia if Gnus is running, particularly
7614 the Gcc: header for archiving.
7616 Additional valid symbols may be available; check with the author of
7617 your package for details. The function should return non-nil if it
7618 succeeds.
7620 See also `read-mail-command' concerning reading mail."
7623 message-user-agent)
7626 sendmail-user-agent)
7629 mh-e-user-agent)
7632 gnus-user-agent)
7638 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7639 If the value of `mail-user-agent' is the default, and the user
7640 appears to have customizations applying to the old default,
7641 `compose-mail' issues a warning."
7647 "If the buffer starts with a mail header, move point to the header's end.
7648 Otherwise, moves to `point-min'.
7649 The end of the header is the start of the next line, if there is one,
7650 else the end of the last line. This function obeys RFC822."
7656 ;; Used by Rmail (e.g., rmail-forward).
7658 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7662 switch-function yank-action send-actions
7663 return-action)
7664 "Start composing a mail message to send.
7665 This uses the user's chosen mail composition package
7666 as selected with the variable `mail-user-agent'.
7667 The optional arguments TO and SUBJECT specify recipients
7668 and the initial Subject field, respectively.
7670 OTHER-HEADERS is an alist specifying additional
7671 header fields. Elements look like (HEADER . VALUE) where both
7672 HEADER and VALUE are strings.
7674 CONTINUE, if non-nil, says to continue editing a message already
7675 being composed. Interactively, CONTINUE is the prefix argument.
7677 SWITCH-FUNCTION, if non-nil, is a function to use to
7678 switch to and display the buffer used for mail composition.
7680 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7681 to insert the raw text of the message being replied to.
7682 It has the form (FUNCTION . ARGS). The user agent will apply
7683 FUNCTION to ARGS, to insert the raw text of the original message.
7684 \(The user agent will also run `mail-citation-hook', *after* the
7685 original text has been inserted in this way.)
7687 SEND-ACTIONS is a list of actions to call when the message is sent.
7688 Each action has the form (FUNCTION . ARGS).
7690 RETURN-ACTION, if non-nil, is an action for returning to the
7691 caller. It has the form (FUNCTION . ARGS). The function is
7692 called after the mail has been sent or put aside, and the mail
7693 buffer buried."
7697 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7698 ;; from sendmail-user-agent to message-user-agent. Some users may
7699 ;; encounter incompatibilities. This hack tries to detect problems
7700 ;; and warn about them.
7705 mail-yank-hooks mail-archive-file-name
7706 mail-default-reply-to mail-mailing-lists
7707 mail-self-blind))
7714 The default mail mode is now Message mode.
7715 You have the following Mail mode variable%s customized:
7717 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7724 yank-action send-actions return-action)))
7727 yank-action send-actions
7728 return-action)
7732 'switch-to-buffer-other-window yank-action send-actions
7733 return-action))
7736 yank-action send-actions
7737 return-action)
7741 'switch-to-buffer-other-frame yank-action send-actions
7742 return-action))
7744 \f
7746 "History of values entered with `set-variable'.
7748 Maximum length of the history list is determined by the value
7752 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7753 VARIABLE should be a user option variable name, a Lisp variable
7754 meant to be customized by users. You should enter VALUE in Lisp syntax,
7755 so if you want VALUE to be a string, you must surround it with doublequotes.
7756 VALUE is used literally, not evaluated.
7758 If VARIABLE has a `variable-interactive' property, that is used as if
7759 it were the arg to `interactive' (which see) to interactively read VALUE.
7761 If VARIABLE has been defined with `defcustom', then the type information
7762 in the definition is used to check that VALUE is valid.
7764 Note that this function is at heart equivalent to the basic `set' function.
7765 For a variable defined with `defcustom', it does not pay attention to
7766 any :set property that the variable might have (if you want that, use
7769 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7774 default-var)
7790 var obsolete)
7793 ;; Use VAR's `variable-interactive' property
7794 ;; as an interactive spec for prompting.
7797 arg))
7799 read-expression-map t
7800 'set-variable-value-history
7809 ;; Match with custom type.
7821 ;; Force a thorough redisplay for the case that the variable
7822 ;; has an effect on the display, like `tab-width' has.
7824 \f
7825 ;; Define the major mode for lists of completions.
7835 (define-key map [right] 'next-completion)
7837 (define-key map [backtab] 'previous-completion)
7838 (define-key map "q" 'quit-window)
7839 (define-key map "z" 'kill-this-buffer)
7840 map)
7841 "Local map for completion list buffers.")
7843 ;; Completion mode is suitable only for specially formatted data.
7844 (put 'completion-list-mode 'mode-class 'special)
7846 (defvar completion-reference-buffer nil
7847 "Record the buffer that was current when the completion list was requested.
7848 This is a local variable in the completion list buffer.
7849 Initial value is nil to avoid some compiler warnings.")
7851 (defvar completion-no-auto-exit nil
7852 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7853 This also applies to other functions such as `choose-completion'.")
7855 (defvar completion-base-position nil
7856 "Position of the base of the text corresponding to the shown completions.
7857 This variable is used in the *Completions* buffers.
7858 Its value is a list of the form (START END) where START is the place
7859 where the completion should be inserted and END (if non-nil) is the end
7860 of the text to replace. If END is nil, point is used instead.")
7862 (defvar completion-list-insert-choice-function #'completion--replace
7863 "Function to use to insert the text chosen in *Completions*.
7864 Called with three arguments (BEG END TEXT), it should replace the text
7865 between BEG and END with TEXT. Expected to be set buffer-locally
7866 in the *Completions* buffer.")
7868 (defvar completion-base-size nil
7869 "Number of chars before point not involved in completion.
7870 This is a local variable in the completion list buffer.
7871 It refers to the chars in the minibuffer if completing in the
7872 minibuffer, or in `completion-reference-buffer' otherwise.
7873 Only characters in the field at point are included.
7875 If nil, Emacs determines which part of the tail end of the
7876 buffer's text is involved in completion by comparing the text
7877 directly.")
7878 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7880 (defun delete-completion-window ()
7881 "Delete the completion list window.
7882 Go to the window from which completion was requested."
7883 (interactive)
7884 (let ((buf completion-reference-buffer))
7885 (if (one-window-p t)
7886 (if (window-dedicated-p) (delete-frame))
7887 (delete-window (selected-window))
7888 (if (get-buffer-window buf)
7889 (select-window (get-buffer-window buf))))))
7891 (defun previous-completion (n)
7892 "Move to the previous item in the completion list."
7893 (interactive "p")
7894 (next-completion (- n)))
7896 (defun next-completion (n)
7897 "Move to the next item in the completion list.
7898 With prefix argument N, move N items (negative N means move backward)."
7899 (interactive "p")
7900 (let ((beg (point-min)) (end (point-max)))
7901 (while (and (> n 0) (not (eobp)))
7902 ;; If in a completion, move to the end of it.
7903 (when (get-text-property (point) 'mouse-face)
7904 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7905 ;; Move to start of next one.
7906 (unless (get-text-property (point) 'mouse-face)
7907 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7908 (setq n (1- n)))
7909 (while (and (< n 0) (not (bobp)))
7910 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7911 ;; If in a completion, move to the start of it.
7912 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7913 (goto-char (previous-single-property-change
7914 (point) 'mouse-face nil beg)))
7915 ;; Move to end of the previous completion.
7916 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7917 (goto-char (previous-single-property-change
7918 (point) 'mouse-face nil beg)))
7919 ;; Move to the start of that one.
7920 (goto-char (previous-single-property-change
7921 (point) 'mouse-face nil beg))
7922 (setq n (1+ n))))))
7924 (defun choose-completion (&optional event)
7925 "Choose the completion at point.
7926 If EVENT, use EVENT's position to determine the starting position."
7927 (interactive (list last-nonmenu-event))
7928 ;; In case this is run via the mouse, give temporary modes such as
7929 ;; isearch a chance to turn off.
7930 (run-hooks 'mouse-leave-buffer-hook)
7931 (with-current-buffer (window-buffer (posn-window (event-start event)))
7932 (let ((buffer completion-reference-buffer)
7933 (base-size completion-base-size)
7934 (base-position completion-base-position)
7935 (insert-function completion-list-insert-choice-function)
7936 (choice
7937 (save-excursion
7938 (goto-char (posn-point (event-start event)))
7939 (let (beg end)
7940 (cond
7941 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7942 (setq end (point) beg (1+ (point))))
7943 ((and (not (bobp))
7944 (get-text-property (1- (point)) 'mouse-face))
7945 (setq end (1- (point)) beg (point)))
7946 (t (error "No completion here")))
7947 (setq beg (previous-single-property-change beg 'mouse-face))
7948 (setq end (or (next-single-property-change end 'mouse-face)
7949 (point-max)))
7950 (buffer-substring-no-properties beg end)))))
7952 (unless (buffer-live-p buffer)
7953 (error "Destination buffer is dead"))
7954 (quit-window nil (posn-window (event-start event)))
7956 (with-current-buffer buffer
7957 (choose-completion-string
7958 choice buffer
7959 (or base-position
7960 (when base-size
7961 ;; Someone's using old completion code that doesn't know
7962 ;; about base-position yet.
7963 (list (+ base-size (field-beginning))))
7964 ;; If all else fails, just guess.
7965 (list (choose-completion-guess-base-position choice)))
7966 insert-function)))))
7968 ;; Delete the longest partial match for STRING
7969 ;; that can be found before POINT.
7970 (defun choose-completion-guess-base-position (string)
7971 (save-excursion
7972 (let ((opoint (point))
7973 len)
7974 ;; Try moving back by the length of the string.
7975 (goto-char (max (- (point) (length string))
7976 (minibuffer-prompt-end)))
7977 ;; See how far back we were actually able to move. That is the
7978 ;; upper bound on how much we can match and delete.
7979 (setq len (- opoint (point)))
7980 (if completion-ignore-case
7981 (setq string (downcase string)))
7982 (while (and (> len 0)
7983 (let ((tail (buffer-substring (point) opoint)))
7984 (if completion-ignore-case
7985 (setq tail (downcase tail)))
7986 (not (string= tail (substring string 0 len)))))
7987 (setq len (1- len))
7988 (forward-char 1))
7989 (point))))
7991 (defun choose-completion-delete-max-match (string)
7992 (declare (obsolete choose-completion-guess-base-position "23.2"))
7993 (delete-region (choose-completion-guess-base-position string) (point)))
7995 (defvar choose-completion-string-functions nil
7996 "Functions that may override the normal insertion of a completion choice.
7997 These functions are called in order with three arguments:
7998 CHOICE - the string to insert in the buffer,
7999 BUFFER - the buffer in which the choice should be inserted,
8000 BASE-POSITION - where to insert the completion.
8002 If a function in the list returns non-nil, that function is supposed
8003 to have inserted the CHOICE in the BUFFER, and possibly exited
8004 the minibuffer; no further functions will be called.
8006 If all functions in the list return nil, that means to use
8007 the default method of inserting the completion in BUFFER.")
8009 (defun choose-completion-string (choice &optional
8010 buffer base-position insert-function)
8011 "Switch to BUFFER and insert the completion choice CHOICE.
8012 BASE-POSITION says where to insert the completion.
8013 INSERT-FUNCTION says how to insert the completion and falls
8014 back on `completion-list-insert-choice-function' when nil."
8016 ;; If BUFFER is the minibuffer, exit the minibuffer
8017 ;; unless it is reading a file name and CHOICE is a directory,
8018 ;; or completion-no-auto-exit is non-nil.
8020 ;; Some older code may call us passing `base-size' instead of
8021 ;; `base-position'. It's difficult to make any use of `base-size',
8022 ;; so we just ignore it.
8023 (unless (consp base-position)
8024 (message "Obsolete `base-size' passed to choose-completion-string")
8025 (setq base-position nil))
8027 (let* ((buffer (or buffer completion-reference-buffer))
8028 (mini-p (minibufferp buffer)))
8029 ;; If BUFFER is a minibuffer, barf unless it's the currently
8030 ;; active minibuffer.
8031 (if (and mini-p
8032 (not (and (active-minibuffer-window)
8033 (equal buffer
8034 (window-buffer (active-minibuffer-window))))))
8035 (error "Minibuffer is not active for completion")
8036 ;; Set buffer so buffer-local choose-completion-string-functions works.
8037 (set-buffer buffer)
8038 (unless (run-hook-with-args-until-success
8039 'choose-completion-string-functions
8040 ;; The fourth arg used to be `mini-p' but was useless
8041 ;; (since minibufferp can be used on the `buffer' arg)
8042 ;; and indeed unused. The last used to be `base-size', so we
8043 ;; keep it to try and avoid breaking old code.
8044 choice buffer base-position nil)
8045 ;; This remove-text-properties should be unnecessary since `choice'
8046 ;; comes from buffer-substring-no-properties.
8047 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
8048 ;; Insert the completion into the buffer where it was requested.
8049 (funcall (or insert-function completion-list-insert-choice-function)
8050 (or (car base-position) (point))
8051 (or (cadr base-position) (point))
8052 choice)
8053 ;; Update point in the window that BUFFER is showing in.
8054 (let ((window (get-buffer-window buffer t)))
8055 (set-window-point window (point)))
8056 ;; If completing for the minibuffer, exit it with this choice.
8057 (and (not completion-no-auto-exit)
8058 (minibufferp buffer)
8059 minibuffer-completion-table
8060 ;; If this is reading a file name, and the file name chosen
8061 ;; is a directory, don't exit the minibuffer.
8062 (let* ((result (buffer-substring (field-beginning) (point)))
8063 (bounds
8064 (completion-boundaries result minibuffer-completion-table
8065 minibuffer-completion-predicate
8066 "")))
8067 (if (eq (car bounds) (length result))
8068 ;; The completion chosen leads to a new set of completions
8069 ;; (e.g. it's a directory): don't exit the minibuffer yet.
8070 (let ((mini (active-minibuffer-window)))
8071 (select-window mini)
8072 (when minibuffer-auto-raise
8073 (raise-frame (window-frame mini))))
8074 (exit-minibuffer))))))))
8076 (define-derived-mode completion-list-mode nil "Completion List"
8077 "Major mode for buffers showing lists of possible completions.
8079 to select the completion near point.
8080 Or click to select one with the mouse.
8083 (set (make-local-variable 'completion-base-size) nil))
8085 (defun completion-list-mode-finish ()
8086 "Finish setup of the completions buffer.
8087 Called from `temp-buffer-show-hook'."
8088 (when (eq major-mode 'completion-list-mode)
8089 (setq buffer-read-only t)))
8091 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
8094 ;; Variables and faces used in `completion-setup-function'.
8096 (defcustom completion-show-help t
8097 "Non-nil means show help message in *Completions* buffer."
8098 :type 'boolean
8099 :version "22.1"
8100 :group 'completion)
8102 ;; This function goes in completion-setup-hook, so that it is called
8103 ;; after the text of the completion list buffer is written.
8104 (defun completion-setup-function ()
8105 (let* ((mainbuf (current-buffer))
8106 (base-dir
8107 ;; FIXME: This is a bad hack. We try to set the default-directory
8108 ;; in the *Completions* buffer so that the relative file names
8109 ;; displayed there can be treated as valid file names, independently
8110 ;; from the completion context. But this suffers from many problems:
8111 ;; - It's not clear when the completions are file names. With some
8112 ;; completion tables (e.g. bzr revision specs), the listed
8113 ;; completions can mix file names and other things.
8114 ;; - It doesn't pay attention to possible quoting.
8115 ;; - With fancy completion styles, the code below will not always
8116 ;; find the right base directory.
8117 (if minibuffer-completing-file-name
8118 (file-name-as-directory
8119 (expand-file-name
8120 (buffer-substring (minibuffer-prompt-end)
8121 (- (point) (or completion-base-size 0))))))))
8122 (with-current-buffer standard-output
8123 (let ((base-size completion-base-size) ;Read before killing localvars.
8124 (base-position completion-base-position)
8125 (insert-fun completion-list-insert-choice-function))
8126 (completion-list-mode)
8127 (set (make-local-variable 'completion-base-size) base-size)
8128 (set (make-local-variable 'completion-base-position) base-position)
8129 (set (make-local-variable 'completion-list-insert-choice-function)
8130 insert-fun))
8131 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8132 (if base-dir (setq default-directory base-dir))
8133 ;; Maybe insert help string.
8134 (when completion-show-help
8135 (goto-char (point-min))
8136 (if (display-mouse-p)
8138 (insert (substitute-command-keys
8142 (add-hook 'completion-setup-hook 'completion-setup-function)
8144 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8145 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8147 (defun switch-to-completions ()
8148 "Select the completion list window."
8149 (interactive)
8150 (let ((window (or (get-buffer-window "*Completions*" 0)
8151 ;; Make sure we have a completions window.
8152 (progn (minibuffer-completion-help)
8153 (get-buffer-window "*Completions*" 0)))))
8154 (when window
8155 (select-window window)
8156 ;; In the new buffer, go to the first completion.
8157 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8158 (when (bobp)
8159 (next-completion 1)))))
8160 \f
8161 ;;; Support keyboard commands to turn on various modifiers.
8163 ;; These functions -- which are not commands -- each add one modifier
8164 ;; to the following event.
8166 (defun event-apply-alt-modifier (_ignore-prompt)
8169 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8170 (defun event-apply-super-modifier (_ignore-prompt)
8173 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8174 (defun event-apply-hyper-modifier (_ignore-prompt)
8177 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8178 (defun event-apply-shift-modifier (_ignore-prompt)
8181 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8182 (defun event-apply-control-modifier (_ignore-prompt)
8185 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8186 (defun event-apply-meta-modifier (_ignore-prompt)
8189 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8191 (defun event-apply-modifier (event symbol lshiftby prefix)
8192 "Apply a modifier flag to event EVENT.
8193 SYMBOL is the name of this modifier, as a symbol.
8194 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8195 PREFIX is the string that represents this modifier in an event type symbol."
8196 (if (numberp event)
8197 (cond ((eq symbol 'control)
8198 (if (and (<= (downcase event) ?z)
8199 (>= (downcase event) ?a))
8200 (- (downcase event) ?a -1)
8201 (if (and (<= (downcase event) ?Z)
8202 (>= (downcase event) ?A))
8203 (- (downcase event) ?A -1)
8204 (logior (lsh 1 lshiftby) event))))
8205 ((eq symbol 'shift)
8206 (if (and (<= (downcase event) ?z)
8207 (>= (downcase event) ?a))
8208 (upcase event)
8209 (logior (lsh 1 lshiftby) event)))
8210 (t
8211 (logior (lsh 1 lshiftby) event)))
8212 (if (memq symbol (event-modifiers event))
8213 event
8214 (let ((event-type (if (symbolp event) event (car event))))
8215 (setq event-type (intern (concat prefix (symbol-name event-type))))
8216 (if (symbolp event)
8217 event-type
8218 (cons event-type (cdr event)))))))
8220 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8221 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8222 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8223 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8224 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8225 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8226 \f
8227 ;;;; Keypad support.
8229 ;; Make the keypad keys act like ordinary typing keys. If people add
8230 ;; bindings for the function key symbols, then those bindings will
8231 ;; override these, so this shouldn't interfere with any existing
8232 ;; bindings.
8234 ;; Also tell read-char how to handle these keys.
8235 (mapc
8236 (lambda (keypad-normal)
8237 (let ((keypad (nth 0 keypad-normal))
8238 (normal (nth 1 keypad-normal)))
8239 (put keypad 'ascii-character normal)
8240 (define-key function-key-map (vector keypad) (vector normal))))
8241 ;; See also kp-keys bound in bindings.el.
8242 '((kp-space ?\s)
8245 (kp-separator ?,)
8246 (kp-equal ?=)
8247 ;; Do the same for various keys that are represented as symbols under
8248 ;; GUIs but naturally correspond to characters.
8249 (backspace 127)
8250 (delete 127)
8253 (clear ?\C-l)
8254 (return ?\C-m)
8255 (escape ?\e)
8256 ))
8257 \f
8258 ;;;;
8259 ;;;; forking a twin copy of a buffer.
8260 ;;;;
8262 (defvar clone-buffer-hook nil
8263 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8265 (defvar clone-indirect-buffer-hook nil
8266 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8268 (defun clone-process (process &optional newname)
8269 "Create a twin copy of PROCESS.
8270 If NEWNAME is nil, it defaults to PROCESS' name;
8271 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8272 If PROCESS is associated with a buffer, the new process will be associated
8273 with the current buffer instead.
8274 Returns nil if PROCESS has already terminated."
8275 (setq newname (or newname (process-name process)))
8277 (setq newname (substring newname 0 (match-beginning 0))))
8278 (when (memq (process-status process) '(run stop open))
8279 (let* ((process-connection-type (process-tty-name process))
8280 (new-process
8281 (if (memq (process-status process) '(open))
8282 (let ((args (process-contact process t)))
8283 (setq args (plist-put args :name newname))
8284 (setq args (plist-put args :buffer
8285 (if (process-buffer process)
8286 (current-buffer))))
8287 (apply 'make-network-process args))
8288 (apply 'start-process newname
8289 (if (process-buffer process) (current-buffer))
8290 (process-command process)))))
8291 (set-process-query-on-exit-flag
8292 new-process (process-query-on-exit-flag process))
8293 (set-process-inherit-coding-system-flag
8294 new-process (process-inherit-coding-system-flag process))
8295 (set-process-filter new-process (process-filter process))
8296 (set-process-sentinel new-process (process-sentinel process))
8297 (set-process-plist new-process (copy-sequence (process-plist process)))
8298 new-process)))
8300 ;; things to maybe add (currently partly covered by `funcall mode'):
8301 ;; - syntax-table
8302 ;; - overlays
8303 (defun clone-buffer (&optional newname display-flag)
8304 "Create and return a twin copy of the current buffer.
8305 Unlike an indirect buffer, the new buffer can be edited
8306 independently of the old one (if it is not read-only).
8307 NEWNAME is the name of the new buffer. It may be modified by
8308 adding or incrementing <N> at the end as necessary to create a
8309 unique buffer name. If nil, it defaults to the name of the
8310 current buffer, with the proper suffix. If DISPLAY-FLAG is
8311 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8312 clone a file-visiting buffer, or a buffer whose major mode symbol
8313 has a non-nil `no-clone' property, results in an error.
8315 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8316 current buffer with appropriate suffix. However, if a prefix
8317 argument is given, then the command prompts for NEWNAME in the
8318 minibuffer.
8320 This runs the normal hook `clone-buffer-hook' in the new buffer
8321 after it has been set up properly in other respects."
8322 (interactive
8323 (progn
8324 (if buffer-file-name
8325 (error "Cannot clone a file-visiting buffer"))
8326 (if (get major-mode 'no-clone)
8327 (error "Cannot clone a buffer in %s mode" mode-name))
8328 (list (if current-prefix-arg
8329 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8330 t)))
8331 (if buffer-file-name
8332 (error "Cannot clone a file-visiting buffer"))
8333 (if (get major-mode 'no-clone)
8334 (error "Cannot clone a buffer in %s mode" mode-name))
8335 (setq newname (or newname (buffer-name)))
8337 (setq newname (substring newname 0 (match-beginning 0))))
8338 (let ((buf (current-buffer))
8339 (ptmin (point-min))
8340 (ptmax (point-max))
8341 (pt (point))
8342 (mk (if mark-active (mark t)))
8343 (modified (buffer-modified-p))
8344 (mode major-mode)
8345 (lvars (buffer-local-variables))
8346 (process (get-buffer-process (current-buffer)))
8347 (new (generate-new-buffer (or newname (buffer-name)))))
8348 (save-restriction
8349 (widen)
8350 (with-current-buffer new
8351 (insert-buffer-substring buf)))
8352 (with-current-buffer new
8353 (narrow-to-region ptmin ptmax)
8354 (goto-char pt)
8355 (if mk (set-mark mk))
8356 (set-buffer-modified-p modified)
8358 ;; Clone the old buffer's process, if any.
8359 (when process (clone-process process))
8361 ;; Now set up the major mode.
8362 (funcall mode)
8364 ;; Set up other local variables.
8365 (mapc (lambda (v)
8366 (condition-case () ;in case var is read-only
8367 (if (symbolp v)
8368 (makunbound v)
8369 (set (make-local-variable (car v)) (cdr v)))
8370 (error nil)))
8371 lvars)
8373 ;; Run any hooks (typically set up by the major mode
8374 ;; for cloning to work properly).
8375 (run-hooks 'clone-buffer-hook))
8376 (if display-flag
8377 ;; Presumably the current buffer is shown in the selected frame, so
8378 ;; we want to display the clone elsewhere.
8379 (let ((same-window-regexps nil)
8380 (same-window-buffer-names))
8381 (pop-to-buffer new)))
8382 new))
8385 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8386 "Create an indirect buffer that is a twin copy of the current buffer.
8388 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8389 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8390 or if not called with a prefix arg, NEWNAME defaults to the current
8391 buffer's name. The name is modified by adding a `<N>' suffix to it
8392 or by incrementing the N in an existing suffix. Trying to clone a
8393 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8394 property results in an error.
8396 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8397 This is always done when called interactively.
8399 Optional third arg NORECORD non-nil means do not put this buffer at the
8400 front of the list of recently selected ones.
8402 Returns the newly created indirect buffer."
8403 (interactive
8404 (progn
8405 (if (get major-mode 'no-clone-indirect)
8406 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8407 (list (if current-prefix-arg
8408 (read-buffer "Name of indirect buffer: " (current-buffer)))
8409 t)))
8410 (if (get major-mode 'no-clone-indirect)
8411 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8412 (setq newname (or newname (buffer-name)))
8414 (setq newname (substring newname 0 (match-beginning 0))))
8415 (let* ((name (generate-new-buffer-name newname))
8416 (buffer (make-indirect-buffer (current-buffer) name t)))
8417 (with-current-buffer buffer
8418 (run-hooks 'clone-indirect-buffer-hook))
8419 (when display-flag
8420 (pop-to-buffer buffer nil norecord))
8421 buffer))
8424 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8425 "Like `clone-indirect-buffer' but display in another window."
8426 (interactive
8427 (progn
8428 (if (get major-mode 'no-clone-indirect)
8429 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8430 (list (if current-prefix-arg
8431 (read-buffer "Name of indirect buffer: " (current-buffer)))
8432 t)))
8433 (let ((pop-up-windows t))
8434 (clone-indirect-buffer newname display-flag norecord)))
8436 \f
8437 ;;; Handling of Backspace and Delete keys.
8439 (defcustom normal-erase-is-backspace 'maybe
8440 "Set the default behavior of the Delete and Backspace keys.
8442 If set to t, Delete key deletes forward and Backspace key deletes
8443 backward.
8445 If set to nil, both Delete and Backspace keys delete backward.
8447 If set to `maybe' (which is the default), Emacs automatically
8448 selects a behavior. On window systems, the behavior depends on
8449 the keyboard used. If the keyboard has both a Backspace key and
8450 a Delete key, and both are mapped to their usual meanings, the
8451 option's default value is set to t, so that Backspace can be used
8452 to delete backward, and Delete can be used to delete forward.
8454 If not running under a window system, customizing this option
8455 accomplishes a similar effect by mapping C-h, which is usually
8456 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8457 via `keyboard-translate'. The former functionality of C-h is
8458 available on the F1 key. You should probably not use this
8459 setting if you don't have both Backspace, Delete and F1 keys.
8461 Setting this variable with setq doesn't take effect. Programmatically,
8462 call `normal-erase-is-backspace-mode' (which see) instead."
8463 :type '(choice (const :tag "Off" nil)
8464 (const :tag "Maybe" maybe)
8465 (other :tag "On" t))
8466 :group 'editing-basics
8467 :version "21.1"
8468 :set (lambda (symbol value)
8469 ;; The fboundp is because of a problem with :set when
8470 ;; dumping Emacs. It doesn't really matter.
8471 (if (fboundp 'normal-erase-is-backspace-mode)
8472 (normal-erase-is-backspace-mode (or value 0))
8473 (set-default symbol value))))
8475 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8476 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8477 (unless frame (setq frame (selected-frame)))
8478 (with-selected-frame frame
8479 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8480 (normal-erase-is-backspace-mode
8481 (if (if (eq normal-erase-is-backspace 'maybe)
8482 (and (not noninteractive)
8483 (or (memq system-type '(ms-dos windows-nt))
8484 (memq window-system '(w32 ns))
8485 (and (memq window-system '(x))
8486 (fboundp 'x-backspace-delete-keys-p)
8487 (x-backspace-delete-keys-p))
8488 ;; If the terminal Emacs is running on has erase char
8489 ;; set to ^H, use the Backspace key for deleting
8490 ;; backward, and the Delete key for deleting forward.
8491 (and (null window-system)
8492 (eq tty-erase-char ?\^H))))
8493 normal-erase-is-backspace)
8494 1 0)))))
8496 (define-minor-mode normal-erase-is-backspace-mode
8497 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8498 With a prefix argument ARG, enable this feature if ARG is
8499 positive, and disable it otherwise. If called from Lisp, enable
8500 the mode if ARG is omitted or nil.
8502 On window systems, when this mode is on, Delete is mapped to C-d
8503 and Backspace is mapped to DEL; when this mode is off, both
8504 Delete and Backspace are mapped to DEL. (The remapping goes via
8505 `local-function-key-map', so binding Delete or Backspace in the
8506 global or local keymap will override that.)
8508 In addition, on window systems, the bindings of C-Delete, M-Delete,
8509 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8510 the global keymap in accordance with the functionality of Delete and
8511 Backspace. For example, if Delete is remapped to C-d, which deletes
8512 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8513 to DEL, which deletes backward, C-Delete is bound to
8514 `backward-kill-word'.
8516 If not running on a window system, a similar effect is accomplished by
8517 remapping C-h (normally produced by the Backspace key) and DEL via
8518 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8519 to C-d; if it's off, the keys are not remapped.
8521 When not running on a window system, and this mode is turned on, the
8522 former functionality of C-h is available on the F1 key. You should
8523 probably not turn on this mode on a text-only terminal if you don't
8524 have both Backspace, Delete and F1 keys.
8526 See also `normal-erase-is-backspace'."
8527 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8528 . (lambda (v)
8529 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8530 (if v 1 0))))
8531 (let ((enabled (eq 1 (terminal-parameter
8532 nil 'normal-erase-is-backspace))))
8534 (cond ((or (memq window-system '(x w32 ns pc))
8535 (memq system-type '(ms-dos windows-nt)))
8536 (let ((bindings
8537 `(([M-delete] [M-backspace])
8538 ([C-M-delete] [C-M-backspace])
8539 ([?\e C-delete] [?\e C-backspace]))))
8541 (if enabled
8542 (progn
8543 (define-key local-function-key-map [delete] [deletechar])
8544 (define-key local-function-key-map [kp-delete] [deletechar])
8545 (define-key local-function-key-map [backspace] [?\C-?])
8546 (dolist (b bindings)
8547 ;; Not sure if input-decode-map is really right, but
8548 ;; keyboard-translate-table (used below) only works
8549 ;; for integer events, and key-translation-table is
8550 ;; global (like the global-map, used earlier).
8551 (define-key input-decode-map (car b) nil)
8552 (define-key input-decode-map (cadr b) nil)))
8553 (define-key local-function-key-map [delete] [?\C-?])
8554 (define-key local-function-key-map [kp-delete] [?\C-?])
8555 (define-key local-function-key-map [backspace] [?\C-?])
8556 (dolist (b bindings)
8557 (define-key input-decode-map (car b) (cadr b))
8558 (define-key input-decode-map (cadr b) (car b))))))
8559 (t
8560 (if enabled
8561 (progn
8562 (keyboard-translate ?\C-h ?\C-?)
8563 (keyboard-translate ?\C-? ?\C-d))
8564 (keyboard-translate ?\C-h ?\C-h)
8565 (keyboard-translate ?\C-? ?\C-?))))
8567 (if (called-interactively-p 'interactive)
8568 (message "Delete key deletes %s"
8569 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8570 "forward" "backward")))))
8571 \f
8572 (defvar vis-mode-saved-buffer-invisibility-spec nil
8573 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8575 (define-minor-mode read-only-mode
8576 "Change whether the current buffer is read-only.
8577 With prefix argument ARG, make the buffer read-only if ARG is
8578 positive, otherwise make it writable. If buffer is read-only
8579 and `view-read-only' is non-nil, enter view mode.
8581 Do not call this from a Lisp program unless you really intend to
8583 possibly enabling or disabling View mode. Also, note that this
8584 command works by setting the variable `buffer-read-only', which
8585 does not affect read-only regions caused by text properties. To
8586 ignore read-only status in a Lisp program (whether due to text
8587 properties or buffer state), bind `inhibit-read-only' temporarily
8588 to a non-nil value."
8589 :variable buffer-read-only
8590 (cond
8591 ((and (not buffer-read-only) view-mode)
8592 (View-exit-and-edit)
8593 (make-local-variable 'view-read-only)
8594 (setq view-read-only t)) ; Must leave view mode.
8595 ((and buffer-read-only view-read-only
8596 ;; If view-mode is already active, `view-mode-enter' is a nop.
8597 (not view-mode)
8598 (not (eq (get major-mode 'mode-class) 'special)))
8599 (view-mode-enter))))
8601 (define-minor-mode visible-mode
8602 "Toggle making all invisible text temporarily visible (Visible mode).
8603 With a prefix argument ARG, enable Visible mode if ARG is
8604 positive, and disable it otherwise. If called from Lisp, enable
8605 the mode if ARG is omitted or nil.
8607 This mode works by saving the value of `buffer-invisibility-spec'
8608 and setting it to nil."
8609 :lighter " Vis"
8610 :group 'editing-basics
8611 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8612 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8613 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8614 (when visible-mode
8615 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8616 buffer-invisibility-spec)
8617 (setq buffer-invisibility-spec nil)))
8618 \f
8619 (defvar messages-buffer-mode-map
8620 (let ((map (make-sparse-keymap)))
8621 (set-keymap-parent map special-mode-map)
8622 (define-key map "g" nil) ; nothing to revert
8623 map))
8625 (define-derived-mode messages-buffer-mode special-mode "Messages"
8628 (defun messages-buffer ()
8630 If it does not exist, create and it switch it to `messages-buffer-mode'."
8631 (or (get-buffer "*Messages*")
8632 (with-current-buffer (get-buffer-create "*Messages*")
8633 (messages-buffer-mode)
8634 (current-buffer))))
8636 \f
8637 ;; Minibuffer prompt stuff.
8639 ;;(defun minibuffer-prompt-modification (start end)
8640 ;; (error "You cannot modify the prompt"))
8641 ;;
8642 ;;
8643 ;;(defun minibuffer-prompt-insertion (start end)
8644 ;; (let ((inhibit-modification-hooks t))
8645 ;; (delete-region start end)
8646 ;; ;; Discard undo information for the text insertion itself
8647 ;; ;; and for the text deletion.above.
8648 ;; (when (consp buffer-undo-list)
8649 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8650 ;; (message "You cannot modify the prompt")))
8651 ;;
8652 ;;
8653 ;;(setq minibuffer-prompt-properties
8654 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8655 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8657 \f
8658 ;;;; Problematic external packages.
8660 ;; rms says this should be done by specifying symbols that define
8661 ;; versions together with bad values. This is therefore not as
8662 ;; flexible as it could be. See the thread:
8663 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8664 (defconst bad-packages-alist
8665 ;; Not sure exactly which semantic versions have problems.
8666 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8668 "The version of `semantic' loaded does not work in Emacs 22.
8669 It can cause constant high CPU load.
8670 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8671 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8672 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8673 ;; provided the `CUA-mode' feature. Since this is no longer true,
8674 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8675 (CUA-mode t nil
8676 "CUA-mode is now part of the standard GNU Emacs distribution,
8677 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8679 You have loaded an older version of CUA-mode which does not work
8680 correctly with this version of Emacs. You should remove the old
8681 version and use the one distributed with Emacs."))
8682 "Alist of packages known to cause problems in this version of Emacs.
8683 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8684 PACKAGE is either a regular expression to match file names, or a
8685 symbol (a feature name), like for `with-eval-after-load'.
8686 SYMBOL is either the name of a string variable, or t. Upon
8687 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8688 warning using STRING as the message.")
8690 (defun bad-package-check (package)
8691 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8692 (condition-case nil
8693 (let* ((list (assoc package bad-packages-alist))
8694 (symbol (nth 1 list)))
8695 (and list
8696 (boundp symbol)
8697 (or (eq symbol t)
8698 (and (stringp (setq symbol (eval symbol)))
8699 (string-match-p (nth 2 list) symbol)))
8700 (display-warning package (nth 3 list) :warning)))
8701 (error nil)))
8703 (dolist (elem bad-packages-alist)
8704 (let ((pkg (car elem)))
8705 (with-eval-after-load pkg
8706 (bad-package-check pkg))))
8708 \f
8709 ;;; Generic dispatcher commands
8711 ;; Macro `define-alternatives' is used to create generic commands.
8712 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8713 ;; that can have different alternative implementations where choosing
8714 ;; among them is exclusively a matter of user preference.
8716 ;; (define-alternatives COMMAND) creates a new interactive command
8717 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8718 ;; Typically, the user will not need to customize this variable; packages
8719 ;; wanting to add alternative implementations should use
8720 ;;
8721 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8723 (defmacro define-alternatives (command &rest customizations)
8724 "Define the new command `COMMAND'.
8726 The argument `COMMAND' should be a symbol.
8728 Running `M-x COMMAND RET' for the first time prompts for which
8729 alternative to use and records the selected command as a custom
8730 variable.
8732 Running `C-u M-x COMMAND RET' prompts again for an alternative
8733 and overwrites the previous choice.
8735 The variable `COMMAND-alternatives' contains an alist with
8736 alternative implementations of COMMAND. `define-alternatives'
8737 does not have any effect until this variable is set.
8739 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8740 `defcustom' keywords and values to add to the declaration of
8741 `COMMAND-alternatives' (typically :group and :version)."
8742 (let* ((command-name (symbol-name command))
8743 (varalt-name (concat command-name "-alternatives"))
8744 (varalt-sym (intern varalt-name))
8745 (varimp-sym (intern (concat command-name "--implementation"))))
8746 `(progn
8748 (defcustom ,varalt-sym nil
8749 ,(format "Alist of alternative implementations for the `%s' command.
8751 Each entry must be a pair (ALTNAME . ALTFUN), where:
8752 ALTNAME - The name shown at user to describe the alternative implementation.
8753 ALTFUN - The function called to implement this alternative."
8754 command-name)
8755 :type '(alist :key-type string :value-type function)
8756 ,@customizations)
8758 (put ',varalt-sym 'definition-name ',command)
8759 (defvar ,varimp-sym nil "Internal use only.")
8761 (defun ,command (&optional arg)
8762 ,(format "Run generic command `%s'.
8763 If used for the first time, or with interactive ARG, ask the user which
8764 implementation to use for `%s'. The variable `%s'
8765 contains the list of implementations currently supported for this command."
8766 command-name command-name varalt-name)
8767 (interactive "P")
8768 (when (or arg (null ,varimp-sym))
8769 (let ((val (completing-read
8770 ,(format-message
8771 "Select implementation for command `%s': "
8772 command-name)
8773 ,varalt-sym nil t)))
8774 (unless (string-equal val "")
8775 (when (null ,varimp-sym)
8776 (message
8777 "Use C-u M-x %s RET`to select another implementation"
8778 ,command-name)
8779 (sit-for 3))
8780 (customize-save-variable ',varimp-sym
8781 (cdr (assoc-string val ,varalt-sym))))))
8782 (if ,varimp-sym
8783 (call-interactively ,varimp-sym)
8784 (message "%s" ,(format-message
8785 "No implementation selected for command `%s'"
8786 command-name)))))))
8788 \f
8789 ;;; Functions for changing capitalization that Do What I Mean
8790 (defun upcase-dwim (arg)
8791 "Upcase words in the region, if active; if not, upcase word at point.
8792 If the region is active, this function calls `upcase-region'.
8793 Otherwise, it calls `upcase-word', with prefix argument passed to it
8794 to upcase ARG words."
8795 (interactive "*p")
8796 (if (use-region-p)
8797 (upcase-region (region-beginning) (region-end))
8798 (upcase-word arg)))
8800 (defun downcase-dwim (arg)
8801 "Downcase words in the region, if active; if not, downcase word at point.
8802 If the region is active, this function calls `downcase-region'.
8803 Otherwise, it calls `downcase-word', with prefix argument passed to it
8804 to downcase ARG words."
8805 (interactive "*p")
8806 (if (use-region-p)
8807 (downcase-region (region-beginning) (region-end))
8808 (downcase-word arg)))
8810 (defun capitalize-dwim (arg)
8811 "Capitalize words in the region, if active; if not, capitalize word at point.
8812 If the region is active, this function calls `capitalize-region'.
8813 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8814 to capitalize ARG words."
8815 (interactive "*p")
8816 (if (use-region-p)
8817 (capitalize-region (region-beginning) (region-end))
8818 (capitalize-word arg)))
8820 \f
8822 (provide 'simple)
8824 ;;; simple.el ends here