| blob | 4d35d7c27e67142258d89f44ec3338530909881e |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2016 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "Idle time delay before updating various things on the screen.
42 Various Emacs features that update auxiliary information when point moves
43 wait this many seconds after Emacs becomes idle before doing an update."
49 "Killing and yanking commands."
53 "Highlight (un)matching of parens and expressions."
55 \f
56 ;;; next-error support framework
59 "`next-error' support framework."
65 "Face used to highlight next error locus."
70 "Highlighting of locations in selected source buffers.
71 If a number, highlight the locus in `next-error' face for the given time
72 in seconds, or until the next command is executed.
73 If t, highlight the locus until the next command is executed, or until
74 some other locus replaces it.
75 If nil, don't highlight the locus in the source buffer.
76 If `fringe-arrow', indicate the locus by the fringe arrow
77 indefinitely until some other locus replaces it."
86 "Highlighting of locations in `next-error-no-select'.
87 If number, highlight the locus in `next-error' face for given time in seconds.
88 If t, highlight the locus indefinitely until some other locus replaces it.
89 If nil, don't highlight the locus in the source buffer.
90 If `fringe-arrow', indicate the locus by the fringe arrow
91 indefinitely until some other locus replaces it."
100 "Display the line in the visited source file recentered as specified.
101 If non-nil, the value is passed directly to `recenter'."
109 "List of hook functions run by `next-error' after visiting source file."
120 "The most recent `next-error' buffer.
121 A buffer becomes most recent when its compilation, grep, or
126 "Function to use to find the next error in the current buffer.
127 The function is called with 2 parameters:
128 ARG is an integer specifying by how many errors to move.
129 RESET is a boolean which, if non-nil, says to go back to the beginning
130 of the errors before moving.
131 Major modes providing compile-like functionality should set this variable
132 to indicate to `next-error' that this is a candidate buffer and how
137 "Function to use to move to an error locus.
138 It takes two arguments, a buffer position in the error buffer
139 and a buffer position in the error locus buffer.
140 The buffer for the error locus should already be current.
145 &optional avoid-current
146 extra-test-inclusive
147 extra-test-exclusive)
148 "Return non-nil if BUFFER is a `next-error' capable buffer.
149 If AVOID-CURRENT is non-nil, and BUFFER is the current buffer,
150 return nil.
152 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if
153 BUFFER would not normally qualify. If it returns non-nil, BUFFER
154 is considered `next-error' capable, anyway, and the function
155 returns non-nil.
157 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the
158 buffer would normally qualify. If it returns nil, BUFFER is
159 rejected, and the function returns nil."
164 ;; Optionally reject some buffers.
167 t)
168 ;; Optionally accept some other buffers.
173 extra-test-inclusive
174 extra-test-exclusive)
175 "Return a `next-error' capable buffer.
177 If AVOID-CURRENT is non-nil, treat the current buffer
178 as an absolute last resort only.
180 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
181 that normally would not qualify. If it returns t, the buffer
182 in question is treated as usable.
184 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
185 that would normally be considered usable. If it returns nil,
186 that buffer is rejected."
188 ;; 1. If one window on the selected frame displays such buffer, return it.
194 avoid-current
195 extra-test-inclusive extra-test-exclusive)
200 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
203 extra-test-inclusive extra-test-exclusive))
204 next-error-last-buffer)
205 ;; 3. If the current buffer is acceptable, choose it.
207 extra-test-inclusive extra-test-exclusive)
209 ;; 4. Look for any acceptable buffer.
214 extra-test-inclusive extra-test-exclusive)))
217 ;; 5. Use the current buffer as a last resort if it qualifies,
218 ;; even despite AVOID-CURRENT.
221 extra-test-inclusive extra-test-exclusive)
225 ;; 6. Give up.
229 "Visit next `next-error' message and corresponding source code.
231 If all the error messages parsed so far have been processed already,
232 the message buffer is checked for new ones.
234 A prefix ARG specifies how many error messages to move;
235 negative means move back to previous error messages.
237 and start at the first error.
239 The RESET argument specifies that we should restart from the beginning.
242 compilation, grep, or occur buffer. It can also operate on any
244 more generally, on any buffer in Compilation mode or with
245 Compilation Minor mode enabled, or any buffer in which
246 `next-error-function' is bound to an appropriate function.
247 To specify use of a particular buffer for error messages, type
249 in the current frame.
252 runs `next-error-hook' with `run-hooks', and stays with that buffer
253 until you use it in some other buffer which uses Compilation mode
254 or Compilation Minor mode.
256 To control which errors are matched, customize the variable
257 `compilation-error-regexp-alist'."
261 ;; we know here that next-error-function is a valid symbol we can funcall
269 "Visit the source code corresponding to the `next-error' message at point."
271 ;; we know here that next-error-function is a valid symbol we can funcall
282 "Visit previous `next-error' message and corresponding source code.
284 Prefix arg N says how many error messages to move backwards (or
285 forwards, if negative).
292 "Restart at the first error.
293 Visit corresponding source code.
294 With prefix arg N, visit the source code of the Nth error.
300 "Move point to the next error in the `next-error' buffer and highlight match.
301 Prefix arg N says how many error messages to move forwards (or
302 backwards, if negative).
304 select the source buffer."
311 "Move point to the previous error in the `next-error' buffer and highlight match.
312 Prefix arg N says how many error messages to move backwards (or
313 forwards, if negative).
315 select the source buffer."
319 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
323 "Minor mode for compilation, occur and diff modes.
324 With a prefix argument ARG, enable mode if ARG is positive, and
325 disable it otherwise. If called from Lisp, enable mode if ARG is
326 omitted or nil.
327 When turned on, cursor motion in the compilation, grep, occur or diff
328 buffer causes automatic display of the corresponding source code location."
335 ;; Used as a `post-command-hook' by `next-error-follow-mode'
336 ;; for the *Compilation* *grep* and *Occur* buffers.
346 \f
347 ;;;
350 "Major mode not specialized for anything in particular.
351 Other major modes are defined by comparison with this one."
356 ;; Special major modes to view specially formatted data rather than files.
370 map))
374 "Parent major mode from which special major modes should inherit."
377 ;; Making and deleting lines.
380 "Special hook to tell if `self-insert-command' will use the region.
381 It must be called via `run-hook-with-args-until-success' with no arguments.
382 Any `post-self-insert-command' which consumes the region should
383 register a function on this hook so that things like `delete-selection-mode'
390 "Insert a newline, and move to left margin of the new line if it's blank.
391 If option `use-hard-newlines' is non-nil, the newline is marked with the
392 text-property `hard'.
393 With ARG, insert that many newlines.
395 If `electric-indent-mode' is enabled, this indents the final new line
396 that it adds, and reindents the preceding line. To just insert
399 Calls `auto-fill-function' if the current column number is greater
400 than the value of `fill-column' and ARG is nil.
401 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
404 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
405 ;; Set last-command-event to tell self-insert what to insert.
409 ;; Don't auto-fill if we have a numeric argument.
413 ;; Do the rest in post-self-insert-hook, because we want to do it
414 ;; *before* other functions on that hook.
416 ;; We are not going to insert any newlines if arg is
417 ;; non-positive.
420 ;; Mark the newline(s) `hard'.
424 ;; If the newline leaves the previous line blank, and we
425 ;; have a left margin, delete that from the blank line.
433 ;; Indent the line after the newline, except in one case:
434 ;; when we added the newline at the beginning of a line which
435 ;; starts a page.
440 ;; FIXME: For non-interactive uses, many calls actually
441 ;; just want (insert "\n"), so maybe we should do just
442 ;; that, so as to avoid the risk of filling or running
443 ;; abbrevs unexpectedly.
450 ;; We first used let-binding to protect the hook, but that
451 ;; was naive since add-hook affects the symbol-default
452 ;; value of the variable, whereas the let-binding might
453 ;; only protect the buffer-local value.
457 nil)
462 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
468 "Insert a newline and leave point before it.
469 If there is a fill prefix and/or a `left-margin', insert them on
470 the new line if the line would have been blank.
471 With arg N, insert N newlines."
476 ;; Don't expand an abbrev before point.
487 ;; Necessary in case a margin or prefix was inserted.
491 "Split current line, moving portion beyond point vertically down.
492 If the current line starts with `fill-prefix', insert it on the new
493 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
495 When called from Lisp code, ARG may be a prefix string to copy."
500 ;; What prefix should we check for (nil means don't).
504 ;; Does this line start with it?
515 "Join this line to previous and fix up whitespace at join.
516 If there is a fill prefix, delete it from the beginning of this line.
517 With argument, join this line to following line."
524 ;; If the second line started with the fill prefix,
525 ;; delete the prefix.
537 "On blank line, delete all surrounding blank lines, leaving just one.
538 On isolated blank line, delete that one.
539 On nonblank line, delete any immediately following blank lines."
545 ;; Set singleblank if there is just one blank line here.
552 ;; Delete preceding blank lines, and this one too if it's the only one.
561 ;; Delete following blank lines, unless the current line is blank
562 ;; and there are no following blank lines.
571 ;; Handle the special case where point is followed by newline and eob.
572 ;; Delete the line, leaving point at eob.
578 Trailing lines are deleted only if `delete-trailing-whitespace'
579 is called on the entire buffer (rather than an active region)."
585 "Delete trailing whitespace between START and END.
586 If called interactively, START and END are the start/end of the
587 region if the mark is active, or of the buffer's accessible
588 portion if the mark is inactive.
590 This command deletes whitespace characters after the last
591 non-whitespace character in each line between START and END. It
592 does not consider formfeed characters to be whitespace.
594 If this command acts on the entire buffer (i.e. if called
595 interactively with the mark inactive, or called from Lisp with
596 END nil), it also deletes all trailing lines at the end of the
597 buffer if the variable `delete-trailing-lines' is non-nil."
608 ;; Don't delete formfeeds, even if they are considered whitespace.
610 ;; Treating \n as non-whitespace makes things easier.
616 ;; Delete trailing empty lines.
618 ;; Really the end of buffer.
622 ;; Return nil for the benefit of `write-file-functions'.
623 nil)
626 "Insert a newline, then indent according to major mode.
627 Indentation is done using the value of `indent-line-function'.
628 In programming language modes, this is the same as TAB.
629 In some text modes, where TAB inserts a tab, this command indents to the
630 column specified by the function `current-left-margin'."
637 "Reindent current line, insert newline, then indent the new line.
638 Indentation of both lines is done according to the current major mode,
639 which means calling the current value of `indent-line-function'.
640 In programming language modes, this is the same as TAB.
641 In some text modes, where TAB inserts a tab, this indents to the
642 column specified by the function `current-left-margin'."
645 ;; Be careful to insert the newline before indenting the line.
646 ;; Otherwise, the indentation might be wrong.
650 ;; We are at EOL before the call to indent-according-to-mode, and
651 ;; after it we usually are as well, but not always. We tried to
652 ;; address it with `save-excursion' but that uses a normal marker
653 ;; whereas we need `move after insertion', so we do the save/restore
654 ;; by hand.
658 ;; Remove the trailing white-space after indentation because
659 ;; indentation may introduce the whitespace.
665 Legitimate radix values are 8, 10 and 16."
670 "Like `read-char', but do not allow quitting.
671 Also, if the first character read is an octal digit,
672 we read any number of octal digits and return the
673 specified character code. Any nondigit terminates the sequence.
674 If the terminator is RET, it is discarded;
675 any other terminator is used itself as input.
677 The optional argument PROMPT specifies a string to use to prompt the user.
678 The variable `read-quoted-char-radix' controls which radix to use
679 for numeric input."
682 help-event-list)))
686 ;; Don't let C-h or other help chars get the help
687 ;; message--only help function keys. See bug#16617.
691 "Type the special character you want to use,
692 or the octal character code.
693 RET terminates the character code and is discarded;
703 unread-command-events)
704 done t))
706 ;; Turn a meta-character into a character with the 0200 bit set.
708 done t))
724 unread-command-events)
725 done t))
727 done t)))
729 code))
732 "Read next input character and insert it.
733 This is useful for inserting control characters.
734 With argument, insert ARG copies of the character.
736 If the first character you type after this command is an octal digit,
737 you should type a sequence of octal digits which specify a character code.
738 Any nondigit terminates the sequence. If the terminator is a RET,
739 it is discarded; any other terminator is used itself as input.
740 The variable `read-quoted-char-radix' specifies the radix for this feature;
741 set it to 10 or 16 to use decimal or hex instead of octal.
743 In overwrite mode, this function inserts the character anyway, and
744 does not handle octal digits specially. This means that if you use
745 overwrite as your normal editing mode, you can use this function to
746 insert characters when necessary.
748 In binary overwrite mode, this function does overwrite, and octal
749 digits are interpreted as a character code. This is intended to be
750 useful for editing binary files."
753 ;; Avoid "obsolete" warnings for translation-table-for-input.
760 ;; This used to assume character codes 0240 - 0377 stand for
761 ;; characters in some single-byte character set, and converted them
762 ;; to Emacs characters. But in 23.1 this feature is deprecated
763 ;; in favor of inserting the corresponding Unicode characters.
764 ;; (if (and enable-multibyte-characters
765 ;; (>= char ?\240)
766 ;; (<= char ?\377))
767 ;; (setq char (unibyte-char-to-multibyte char)))
779 "Move forward ARG lines and position at first nonblank character."
785 "Move backward ARG lines and position at first nonblank character."
791 "Move point to the first non-whitespace character on this line."
795 ;; Move back over chars that have whitespace syntax but have the p flag.
799 "Fixup white space between objects around point.
800 Leave one space or none, according to the context."
807 nil
811 "Delete all spaces and tabs around point.
812 If BACKWARD-ONLY is non-nil, only delete them before point."
817 orig-pos
826 "Delete all spaces and tabs around point, leaving one space (or N spaces).
827 If N is negative, delete newlines as well, leaving -N spaces.
828 See also `cycle-spacing'."
833 "Store context used in consecutive calls to `cycle-spacing' command.
834 The first time `cycle-spacing' runs, it saves in this variable:
835 its N argument, the original point position, and the original spacing
839 "Manipulate whitespace around point in a smart way.
840 In interactive use, this function behaves differently in successive
841 consecutive calls.
843 The first call in a sequence acts like `just-one-space'.
844 It deletes all spaces and tabs around point, leaving one space
845 \(or N spaces). N is the prefix argument. If N is negative,
846 it deletes newlines as well, leaving -N spaces.
847 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
849 The second call in a sequence deletes all spaces.
851 The third call in a sequence restores the original whitespace (and point).
853 If MODE is `single-shot', it only performs the first step in the sequence.
854 If MODE is `fast' and the first step would not result in any change
855 \(i.e., there are exactly (abs N) spaces around point),
856 the function goes straight to the second step.
858 Repeatedly calling the function with different values of N starts a
859 new sequence each time."
867 ;; Command run for the first time, single-shot mode or different argument
879 ;; Special handling for case where there was no space at all.
882 ;; If this run causes no change in buffer content, delete all spaces,
883 ;; otherwise delete all excess spaces.
888 ;; Command run for the second time.
892 ;; Command run for the third time.
897 \f
899 "Move point to the beginning of the buffer.
900 With numeric arg N, put point N/10 of the way from the beginning.
901 If the buffer is narrowed, this command uses the beginning of the
902 accessible part of the buffer.
905 is supplied, or Transient Mark mode is enabled and the mark is active."
915 ;; Avoid overflow for large buffer sizes!
923 "Move point to the end of the buffer.
924 With numeric arg N, put point N/10 of the way from the end.
925 If the buffer is narrowed, this command uses the end of the
926 accessible part of the buffer.
929 is supplied, or Transient Mark mode is enabled and the mark is active."
937 ;; Avoid overflow for large buffer sizes!
942 ;; If we went to a place in the middle of the buffer,
943 ;; adjust it to the beginning of a line.
947 ;; If the end of the buffer is not already on the screen,
948 ;; then scroll specially to put it near, but not at, the bottom.
953 "Whether single-char deletion commands delete an active region.
954 This has an effect only if Transient Mark mode is enabled, and
955 affects `delete-forward-char' and `delete-backward-char', though
956 not `delete-char'.
958 If the value is the symbol `kill', the active region is killed
959 instead of deleted."
976 "Function to get the region's content.
977 Called with one argument DELETE.
978 If DELETE is `delete-only', then only delete the region and the return value
979 is undefined. If DELETE is nil, just return the content as a string.
980 If DELETE is `bounds', then don't delete, but just return the
981 boundaries of the region as a list of (START . END) positions.
982 If anything else, delete the region and return its content as a string,
993 first nil))))
994 "Function to insert the region's content.
995 Called with one argument LINES.
999 "Delete the previous N characters (following if N is negative).
1000 If Transient Mark mode is enabled, the mark is active, and N is 1,
1001 delete the text in the region and deactivate the mark instead.
1002 To disable this, set option `delete-active-region' to nil.
1004 Optional second arg KILLFLAG, if non-nil, means to kill (save in
1005 kill ring) instead of delete. Interactively, N is the prefix
1006 arg, and KILLFLAG is set if N is explicitly specified.
1008 When killing, the killed text is filtered by
1009 `filter-buffer-substring' before it is saved in the kill ring, so
1010 the actual saved text might be different from what was killed.
1012 In Overwrite mode, single character backward deletion may replace
1013 tabs with spaces so as to back over columns, unless point is at
1014 the end of the line."
1020 delete-active-region
1022 ;; If a region is active, kill or delete it.
1026 ;; In Overwrite mode, maybe untabify while deleting
1036 ;; Otherwise, do simple deletion.
1040 "Delete the following N characters (previous if N is negative).
1041 If Transient Mark mode is enabled, the mark is active, and N is 1,
1042 delete the text in the region and deactivate the mark instead.
1043 To disable this, set variable `delete-active-region' to nil.
1045 Optional second arg KILLFLAG non-nil means to kill (save in kill
1046 ring) instead of delete. Interactively, N is the prefix arg, and
1047 KILLFLAG is set if N was explicitly specified.
1049 When killing, the killed text is filtered by
1050 `filter-buffer-substring' before it is saved in the kill ring, so
1051 the actual saved text might be different from what was killed."
1057 delete-active-region
1059 ;; If a region is active, kill or delete it.
1064 ;; Otherwise, do simple deletion.
1068 "Put point at beginning and mark at end of buffer.
1069 If narrowing is in effect, only uses the accessible part of the buffer.
1070 You probably should not use this function in Lisp programs;
1071 it is usually a mistake for a Lisp function to use any subroutine
1072 that uses or sets the mark."
1077 ;; This is really `point-min' in most cases, but if we're in the
1078 ;; minibuffer, this is at the end of the prompt.
1080 \f
1082 ;; Counting lines, one way or another.
1085 "Go to LINE, counting from line 1 at beginning of buffer.
1086 If called interactively, a numeric prefix argument specifies
1087 LINE; without a numeric prefix argument, read LINE from the
1088 minibuffer.
1090 If optional argument BUFFER is non-nil, switch to that buffer and
1092 as argument, BUFFER is the most recently selected other buffer.
1094 Prior to moving point, this function sets the mark (without
1095 activating it), unless Transient Mark mode is enabled and the
1096 mark is already active.
1098 This function is usually the wrong thing to use in a Lisp program.
1099 What you probably want instead is something like:
1100 (goto-char (point-min))
1101 (forward-line (1- N))
1102 If at all possible, an even better solution is to use char counts
1103 rather than line counts."
1108 ;; Look for a default, a number in the buffer at point.
1118 ;; Decide if we're switching buffers.
1126 ;; Read the argument, offering that number (if any) as default.
1129 buffer))))
1130 ;; Switch to the desired buffer, one way or another.
1135 ;; Leave mark at previous position
1137 ;; Move to the specified line number in that buffer.
1146 "Count the number of words in the region.
1147 If called interactively, print a message reporting the number of
1148 lines, words, and characters in the region (whether or not the
1149 region is active); with prefix ARG, report for the entire buffer
1150 rather than the region.
1152 If called from Lisp, return the number of words between positions
1153 START and END."
1165 "Count words between START and END.
1166 If called interactively, START and END are normally the start and
1167 end of the buffer; but if the region is active, START and END are
1168 the start and end of the region. Print a message reporting the
1169 number of lines, words, and chars.
1171 If called from Lisp, return the number of words between START and
1172 END, without printing any message."
1182 words))
1198 str
1206 "Print the current buffer line number and narrowed line number of point."
1219 "Return number of lines between START and END.
1220 This is usually the number of newlines between them,
1221 but can be one more if START is not equal to END
1222 and the greater of them is not at the start of a line."
1238 done)))
1242 "Return (narrowed) buffer line number at position POS.
1243 If POS is nil, use current buffer location.
1244 Counting starts at (point-min), so the value refers
1245 to the contents of the accessible portion of the buffer."
1255 "Print info on cursor position (on screen and within buffer).
1256 Also describe the character after point, and give its character code
1257 in octal, decimal and hex.
1259 For a non-ASCII multibyte character, also give its encoding in the
1260 buffer's selected coding system if the coding system encodes the
1261 character safely. If the character is encoded into one byte, that
1262 code is shown in hex. If the character is encoded into more than one
1265 In addition, with prefix argument, show details about that character
1266 in *Help* buffer. See also the command `describe-char'."
1270 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1271 ;; start a directional embedding, which could completely
1272 ;; disrupt the rest of the line (e.g., RLO will display the
1273 ;; rest of the line right-to-left). So we put an invisible
1274 ;; PDF character after these characters, to end the
1275 ;; embedding, which eliminates any effects on the rest of
1276 ;; the line. For RLE and RLO we also append an invisible
1277 ;; LRM, to avoid reordering the following numerical
1278 ;; characters. For LRI/RLI/FSI we append a PDI.
1285 ;; Strong right-to-left characters cause reordering of
1286 ;; the following numerical characters which show the
1287 ;; codepoint, so append LRM to countermand that.
1298 ""
1304 pos total percent beg end col hscroll)
1306 pos total col hscroll))
1308 encoded encoding-msg display-prop under-display)
1315 ;; Check if the character is displayed with some `display'
1316 ;; text property. In that case, set under-display to the
1317 ;; buffer substring covered by that property.
1328 under-display)))
1334 char char char under-display)
1336 char char char under-display display-prop))
1339 char char char
1341 "..."
1345 ;; We show the detailed information about CHAR.
1352 bidi-fixer
1353 encoding-msg pos total percent beg end col hscroll)
1360 bidi-fixer encoding-msg pos total percent col hscroll))))))
1361 \f
1362 ;; Initialize read-expression-map. It is defined at C level.
1366 ;; Might as well bind TAB to completion, since inserting a TAB char is
1367 ;; much too rarely useful.
1370 m))
1373 "Return a Lisp object read using the minibuffer, unevaluated.
1374 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1375 is a string to insert in the minibuffer before reading.
1376 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1377 Such arguments are used as in `read-from-minibuffer'.)"
1378 ;; Used for interactive spec `x'.
1383 "Return value of Lisp expression read using the minibuffer.
1384 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1385 is a string to insert in the minibuffer before reading.
1386 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1387 Such arguments are used as in `read-from-minibuffer'.)"
1388 ;; Used for interactive spec `X'.
1396 "The current default value or list of default values in the minibuffer.
1397 The functions `read-from-minibuffer' and `completing-read' bind
1401 "Value for `print-level' while printing value in `eval-expression'.
1402 A value of nil means no limit."
1408 "Value for `print-length' while printing value in `eval-expression'.
1409 A value of nil means no limit."
1415 "If non-nil set `debug-on-error' to t in `eval-expression'.
1416 If nil, don't change the value of `debug-on-error'."
1422 "If VALUE in an integer, return a specially formatted string.
1424 If VALUE is not an integer, nil is returned.
1425 This function is used by functions like `prin1' that display the
1426 result of expression evaluation."
1445 ;; FIXME: call emacs-lisp-mode?
1452 read-expression-map t
1455 ;; We define this, rather than making `eval' interactive,
1456 ;; for the sake of completion of names like eval-region, eval-buffer.
1458 "Evaluate EXP and print value in the echo area.
1459 When called interactively, read an Emacs Lisp expression and evaluate it.
1460 Value is also consed on to front of the variable `values'.
1461 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1462 argument) means insert the result into the current buffer instead of
1463 printing it in the echo area.
1465 Normally, this function truncates long output according to the value
1466 of the variables `eval-expression-print-length' and
1467 `eval-expression-print-level'. With a prefix argument of zero,
1468 however, there is no such truncation. Such a prefix argument
1469 also causes integers to be printed in several additional formats
1470 \(octal, hexadecimal, and character).
1472 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1473 minibuffer.
1475 If `eval-expression-debug-on-error' is non-nil, which is the default,
1476 this command arranges for all errors to enter the debugger."
1479 current-prefix-arg))
1484 ;; Bind debug-on-error to something unique so that we can
1485 ;; detect when evalled code changes it.
1489 ;; If evalled code has changed the value of debug-on-error,
1490 ;; propagate that change to the global binding.
1495 eval-expression-print-length))
1497 eval-expression-print-level))
1513 "Prompting with PROMPT, let user edit COMMAND and eval result.
1514 COMMAND is a Lisp expression. Let user edit that expression in
1515 the minibuffer, then read and evaluate the result."
1522 read-expression-map t
1524 ;; If command was added to command-history as a string,
1525 ;; get rid of that. We want only evaluable expressions there.
1529 ;; If command to be redone does not match front of history,
1530 ;; add it to the history.
1536 "Edit and re-evaluate last complex command, or ARGth from last.
1537 A complex command is one which used the minibuffer.
1538 The command is placed in the minibuffer as a Lisp form for editing.
1539 The result is executed, repeating the command as changed.
1540 If the command has been changed or is not the most recent previous
1541 command it is added to the front of the command history.
1542 You can use the minibuffer history commands \
1544 to get different commands to edit and resubmit."
1547 newcmd)
1559 ;; If command was added to command-history as a
1560 ;; string, get rid of that. We want only
1561 ;; evaluable expressions there.
1565 ;; If command to be redone does not match front of history,
1566 ;; add it to the history.
1581 "Read command name to invoke in `execute-extended-command'."
1591 ;; Get a command name at point in the original buffer
1592 ;; to propose it after M-n.
1596 ;; Read a string, completing from and restricting to the set of
1597 ;; all defined commands. Don't provide any initial input.
1598 ;; Save the command read on the extended-command history list.
1609 ;; This isn't strictly correct if `execute-extended-command'
1610 ;; is bound to anything else (e.g. [menu]).
1611 ;; It could use (key-description (this-single-command-keys)),
1612 ;; but actually a prompt other than "M-x" would be confusing,
1613 ;; because "M-x" is a well-known prompt to read a command
1614 ;; and it serves as a shorthand for "Extended command: ".
1619 ;; Exclude obsolete commands from completions.
1624 pred)))
1629 "Non-nil means show the equivalent key-binding when M-x command has one.
1630 The value can be a length of time to show the message for.
1631 If the value is non-nil and not a number, we wait 2 seconds."
1638 "If non-nil, show a shorter M-x invocation when there is one."
1659 binding)
1665 name len)))
1666 ;; Don't show the help message if the binding isn't
1667 ;; significantly shorter than the M-x command the user typed.
1674 binding))
1677 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1678 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1679 "Read a command name, then read the arguments and call the command.
1680 To pass a prefix argument to the command you are
1681 invoking, give a prefix argument to `execute-extended-command'."
1683 ;; FIXME: Remember the actual text typed by the user before completion,
1684 ;; so that we don't later on suggest the same shortening.
1689 execute-extended-command--last-typed)))
1690 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1703 ;; Normally `real-this-command' should never be changed, but here we really
1704 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1705 ;; binding" for <cmd>, so the command the user really wanted to run is
1706 ;; `function' and not `execute-extended-command'. The difference is
1707 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1711 ;; If enabled, show which key runs this command.
1712 ;; But first wait, and skip the message if there is input.
1714 ;; If this command displayed something in the echo area;
1715 ;; wait a few seconds, then display our suggestion message.
1716 ;; FIXME: Wait *after* running post-command-hook!
1717 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1718 ;; find a better answer anyway!
1728 ;; There's no binding for CMD. Let's try and find the shortest
1729 ;; string to use in M-x.
1730 ;; FIXME: Can be slow. Cache it maybe?
1737 function
1742 suggest-key-bindings
1746 ;; BEWARE: Called directly from the C code.
1747 "Execute CMD as an editor command.
1748 CMD must be a symbol that satisfies the `commandp' predicate.
1749 Optional second arg RECORD-FLAG non-nil
1750 means unconditionally put this command in the variable `command-history'.
1751 Otherwise, that is done only if an arg is read using the minibuffer.
1752 The argument KEYS specifies the value to use instead of (this-command-keys)
1753 when reading the arguments; if it is nil, (this-command-keys) is used.
1754 The argument SPECIAL, if non-nil, means that this command is executing
1755 a special event, so ignore the prefix argument and don't clear it."
1758 ;; FIXME: This should probably be done around
1759 ;; pre-command-hook rather than here!
1767 disabled-command-function)
1768 ;; FIXME: Weird calling convention!
1778 ;; If requested, place the macro in the command history. For
1779 ;; other sorts of commands, call-interactively takes care of this.
1782 ;; Don't keep command history around forever.
1788 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1796 \f
1798 "Default minibuffer history list.
1799 This is used for all minibuffer input
1800 except when an alternate history list is specified.
1802 Maximum length of the history list is determined by the value
1805 "Control whether history list elements are expressions or strings.
1806 If the value of this variable equals current minibuffer depth,
1807 they are expressions; otherwise they are strings.
1808 \(That convention is designed to do the right thing for
1815 "Text that was in this minibuffer before any history commands.
1816 This is nil if there have not yet been any history commands
1825 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1830 "Minibuffer history variables for which matching should ignore case.
1831 If a history variable is a member of this list, then the
1833 commands ignore case when searching it, regardless of `case-fold-search'."
1838 "Find the previous history element that matches REGEXP.
1839 \(Previous history elements refer to earlier actions.)
1840 With prefix argument N, search for Nth previous match.
1841 If N is negative, find the next or Nth next match.
1842 Normally, history elements are matched case-insensitively if
1843 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1844 makes the search case-sensitive.
1845 See also `minibuffer-history-case-insensitive-variables'."
1849 nil
1850 minibuffer-local-map
1851 nil
1852 'minibuffer-history-search-history
1854 ;; Use the last regexp specified, by default, if input is empty.
1859 regexp)
1869 ;; On some systems, ignore case for file names.
1871 minibuffer-history-case-insensitive-variables)
1872 t
1873 ;; Respect the user's setting for case-fold-search:
1874 case-fold-search)
1875 nil))
1876 prevpos
1877 match-string
1878 match-offset
1885 "No later matching history item"
1906 next-matching-history-element))
1910 "Find the next history element that matches REGEXP.
1911 \(The next history element refers to a more recent action.)
1912 With prefix argument N, search for Nth next match.
1913 If N is negative, find the previous or Nth previous match.
1914 Normally, history elements are matched case-insensitively if
1915 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1916 makes the search case-sensitive."
1920 nil
1921 minibuffer-local-map
1922 nil
1923 'minibuffer-history-search-history
1925 ;; Use the last regexp specified, by default, if input is empty.
1930 regexp)
1937 "Function run by `goto-history-element' before consuming default values.
1938 This is useful to dynamically add more elements to the list of default values
1939 when `goto-history-element' reaches the end of this list.
1940 Before calling this function `goto-history-element' sets the variable
1941 `minibuffer-default-add-done' to t, so it will call this function only
1942 once. In special cases, when this function needs to be called more
1943 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1947 "When nil, add more elements to the end of the list of default values.
1948 The value nil causes `goto-history-element' to add more elements to
1949 the list of defaults when it reaches the end of this list. It does
1955 "Return a list of all completions without the default value.
1956 This function is used to add all elements of the completion table to
1957 the end of the list of defaults just after the default value."
1960 minibuffer-completion-table
1961 minibuffer-completion-predicate)))
1967 "Puts element of the minibuffer history in the minibuffer.
1968 The argument NABS specifies the absolute history position."
1982 elt minibuffer-returned-to-present)
1989 "End of defaults; no next item"
1996 previous-history-element))
2008 minibuffer-default)))
2020 elt))
2024 "Puts next element of the minibuffer history in the minibuffer.
2025 With argument N, it uses the Nth following element."
2031 "Puts previous element of the minibuffer history in the minibuffer.
2032 With argument N, it uses the Nth previous element."
2038 "Move cursor vertically down ARG lines, or to the next history element.
2039 When point moves over the bottom line of multi-line minibuffer, puts ARGth
2040 next element of the minibuffer history in the minibuffer."
2044 ;; Remember the original goal column of possibly multi-line input
2045 ;; excluding the length of the prompt on the first line.
2055 ;; Restore old position since `line-move-visual' moves point to
2056 ;; the end of the line when it fails to go to the next line.
2059 ;; Reset `temporary-goal-column' because a correct value is not
2060 ;; calculated when `next-line' above fails by bumping against
2061 ;; the bottom of the minibuffer (bug#22544).
2063 ;; Restore the original goal column on the last line
2064 ;; of possibly multi-line input.
2072 "Move cursor vertically up ARG lines, or to the previous history element.
2073 When point moves over the top line of multi-line minibuffer, puts ARGth
2074 previous element of the minibuffer history in the minibuffer."
2078 ;; Remember the original goal column of possibly multi-line input
2079 ;; excluding the length of the prompt on the first line.
2089 ;; Restore old position since `line-move-visual' moves point to
2090 ;; the beginning of the line when it fails to go to the previous line.
2093 ;; Reset `temporary-goal-column' because a correct value is not
2094 ;; calculated when `previous-line' above fails by bumping against
2095 ;; the top of the minibuffer (bug#22544).
2097 ;; Restore the original goal column on the first line
2098 ;; of possibly multi-line input.
2104 ;; Put the cursor at the end of the visual line instead of the
2105 ;; logical line, so the next `previous-line-or-history-element'
2106 ;; would move to the previous history element, not to a possible upper
2107 ;; visual line from the end of logical line in `line-move-visual' mode.
2109 ;; Since `end-of-visual-line' puts the cursor at the beginning
2110 ;; of the next visual line, move it one char back to the end
2111 ;; of the first visual line (bug#22544).
2115 "Get next history element which completes the minibuffer before the point.
2116 The contents of the minibuffer after the point are deleted, and replaced
2117 by the new completion."
2123 n)
2124 ;; next-matching-history-element always puts us at (point-min).
2125 ;; Move to the position we were at before changing the buffer contents.
2126 ;; This is still sensible, because the text before point has not changed.
2130 "\
2131 Get previous history element which completes the minibuffer before the point.
2132 The contents of the minibuffer after the point are deleted, and replaced
2133 by the new completion."
2137 ;; For compatibility with the old subr of the same name.
2139 "Return the display width of the minibuffer prompt.
2140 Return 0 if current buffer is not a minibuffer."
2141 ;; Return the width of everything before the field at the end of
2142 ;; the buffer; this should be 0 for normal buffers.
2144 \f
2145 ;; isearch minibuffer history
2152 "Set up a minibuffer for using isearch to search the minibuffer history.
2153 Intended to be added to `minibuffer-setup-hook'."
2165 "Clean up the minibuffer after terminating isearch in the minibuffer."
2170 "Return the proper search function, for isearch in minibuffer history."
2173 ;; Use standard functions to search within minibuffer text
2175 found)
2176 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2177 ;; searching forward. Lazy-highlight calls this lambda with the
2178 ;; bound arg, so skip the minibuffer prompt.
2182 ;; 1. First try searching in the initial minibuffer text
2185 noerror)
2186 ;; 2. If the above search fails, start putting next/prev history
2187 ;; elements in the minibuffer successively, and search the string
2188 ;; in them. Do this only when bound is nil (i.e. not while
2189 ;; lazy-highlighting search strings in the current minibuffer text).
2201 ;; After putting the next/prev history element, search
2202 ;; the string in them again, until next-history-element
2203 ;; or previous-history-element raises an error at the
2204 ;; beginning/end of history.
2207 ;; For backward search, don't search
2208 ;; in the minibuffer prompt
2210 noerror)))
2211 ;; Return point of the new search result
2213 ;; Return nil when next(prev)-history-element fails
2217 "Display the minibuffer history search prompt.
2218 If there are no search errors, this function displays an overlay with
2219 the isearch prompt which replaces the original minibuffer prompt.
2220 Otherwise, it displays the standard isearch message returned from
2221 the function `isearch-message'."
2223 ;; Use standard function `isearch-message' when not in the minibuffer,
2224 ;; or search fails, or has an error (like incomplete regexp).
2225 ;; This function overwrites minibuffer text with isearch message,
2226 ;; so it's possible to see what is wrong in the search string.
2228 ;; Otherwise, put the overlay with the standard isearch prompt over
2229 ;; the initial minibuffer prompt.
2238 ;; And clear any previous isearch message.
2242 "Wrap the minibuffer history search when search fails.
2243 Move point to the first history element for a forward search,
2244 or to the last history element for a backward search."
2245 ;; When `minibuffer-history-isearch-search' fails on reaching the
2246 ;; beginning/end of the history, wrap the search to the first/last
2247 ;; minibuffer history element.
2255 "Save a function restoring the state of minibuffer history search.
2256 Save `minibuffer-history-position' to the additional state parameter
2257 in the search status stack."
2263 "Restore the minibuffer history search state.
2264 Go to the history element by the absolute history position HIST-POS."
2267 \f
2268 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2272 "Table mapping redo records to the corresponding undo one.
2273 A redo record for undo-in-region maps to t.
2283 "Within a run of consecutive undo commands, list remaining to be undone.
2287 "Undo some previous changes.
2288 Repeat this command to undo more changes.
2289 A numeric ARG serves as a repeat count.
2291 In Transient Mark mode when the mark is active, only undo changes within
2293 as an argument limits undo to changes within the current region."
2295 ;; Make last-command indicate for the next command that this was an undo.
2296 ;; That way, another undo will undo more.
2297 ;; If we get to the end of the undo history and get an error,
2298 ;; another undo command will find the undo history empty
2299 ;; and will get another error. To begin undoing the undos,
2300 ;; you must type some other command.
2302 ;; For an indirect buffer, look in the base buffer for the
2303 ;; auto-save data.
2307 message)
2308 ;; If we get an error in undo-start,
2309 ;; the next command should not be a "consecutive undo".
2310 ;; So set `this-command' to something other than `undo'.
2315 ;; If something (a timer or filter?) changed the buffer
2316 ;; since the previous command, don't continue the undo seq.
2320 ;; If the last undo record made was made by undo
2321 ;; it shows nothing else happened in between.
2328 ;; get rid of initial undo boundary
2330 ;; If we got this far, the next command should be a consecutive undo.
2332 ;; Check to see whether we're hitting a redo record, and if
2333 ;; so, ask the user whether she wants to skip the redo/undo pair.
2341 ;; The equiv entry might point to another redo record if we have done
2342 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2350 ;; Record the fact that the just-generated undo records come from an
2351 ;; undo operation--that is, they are redo records.
2352 ;; In the ordinary case (not within a region), map the redo
2353 ;; record to the following undos.
2354 ;; I don't know how to do that in the undo-in-region case.
2356 ;; Strip any leading undo boundaries there might be, like we do
2357 ;; above when checking.
2361 ;; Prevent identity mapping. This can happen if
2362 ;; consecutive nils are erroneously in undo list.
2364 t
2365 pending-undo-list)
2366 undo-equiv-table))
2367 ;; Don't specify a position in the undo record for the undo command.
2368 ;; Instead, undoing this should move point to where the change is.
2387 ;; Record what the current undo list says,
2388 ;; so the next command can tell if the buffer was modified in between.
2392 ;; Display a message announcing success.
2397 "Make BUFFER stop keeping undo information.
2398 No argument or nil as argument means do this for the current buffer."
2404 "Undo some previous changes.
2405 Repeat this command to undo more changes.
2406 A numeric ARG serves as a repeat count.
2407 Contrary to `undo', this will not redo a previous undo."
2412 "Non-nil while performing an undo.
2416 "Undo back N undo-boundaries beyond what was already undone recently.
2417 Call `undo-start' to get ready to undo recent changes,
2418 then call `undo-more' one or more times to undo them."
2423 ;; Note: The following, while pulling elements off
2424 ;; `pending-undo-list' will call primitive change functions which
2425 ;; will push more elements onto `buffer-undo-list'.
2431 "Undo N records from the front of the list LIST.
2432 Return what remains of the list."
2434 ;; This is a good feature, but would make undo-start
2435 ;; unable to do what is expected.
2436 ;;(when (null (car (list)))
2437 ;; ;; If the head of the list is a boundary, it is the boundary
2438 ;; ;; preceding this command. Get rid of it and don't count it.
2439 ;; (setq list (cdr list))))
2442 ;; In a writable buffer, enable undoing read-only text that is
2443 ;; so because of text properties.
2445 ;; Don't let `intangible' properties interfere with undo.
2447 ;; We use oldlist only to check for EQ. ++kfs
2453 ;; Handle an integer by setting point to that value.
2456 ;; Element (t . TIME) records previous modtime.
2457 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2458 ;; UNKNOWN_MODTIME_NSECS.
2460 ;; If this records an obsolete save
2461 ;; (not matching the actual disk file)
2462 ;; then don't mark unmodified.
2470 ;; Element (nil PROP VAL BEG . END) is property change.
2475 ;; Element (BEG . END) means range was inserted.
2477 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2478 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2481 ;; Set point first thing, so that undoing this undo
2482 ;; does not send point back to where it is now.
2485 ;; Element (apply FUN . ARGS) means call FUN to undo.
2489 ;; Long format: (apply DELTA START END FUN . ARGS).
2496 ;; Check that the function did what the entry
2497 ;; said it would do.
2507 ;; Element (STRING . POS) means STRING was deleted.
2513 ;; Check that marker adjustments which were recorded
2514 ;; with the (STRING . POS) record are still valid, ie
2515 ;; the markers haven't moved. We check their validity
2516 ;; before reinserting the string so as we don't need to
2517 ;; mind marker insertion-type.
2525 ;; Insert string and adjust point
2533 ;; Adjust the valid marker adjustments
2537 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2540 next)
2541 ;; Even though these elements are not expected in the undo
2542 ;; list, adjust them to be conservative for the 24.4
2543 ;; release. (Bug#16818)
2550 ;; Make sure an apply entry produces at least one undo entry,
2551 ;; so the test in `undo' for continuing an undo series
2552 ;; will work right.
2557 list)
2559 ;; Deep copy of a list
2561 "Make a copy of undo list LIST."
2567 elt))
2570 "Set `pending-undo-list' to the front of the undo list.
2571 The next call to `undo-more' will undo the most recently made change.
2572 If BEG and END are specified, then only undo elements
2573 that apply to text between BEG and END are used; other undo elements
2574 are ignored. If BEG and END are nil, all undo elements are used."
2580 buffer-undo-list)))
2582 ;; The positions given in elements of the undo list are the positions
2583 ;; as of the time that element was recorded to undo history. In
2584 ;; general, subsequent buffer edits render those positions invalid in
2585 ;; the current buffer, unless adjusted according to the intervening
2586 ;; undo elements.
2587 ;;
2588 ;; Undo in region is a use case that requires adjustments to undo
2589 ;; elements. It must adjust positions of elements in the region based
2590 ;; on newer elements not in the region so as they may be correctly
2591 ;; applied in the current buffer. undo-make-selective-list
2592 ;; accomplishes this with its undo-deltas list of adjustments. An
2593 ;; example undo history from oldest to newest:
2594 ;;
2595 ;; buf pos:
2596 ;; 123456789 buffer-undo-list undo-deltas
2597 ;; --------- ---------------- -----------
2598 ;; aaa (1 . 4) (1 . -3)
2599 ;; aaba (3 . 4) N/A (in region)
2600 ;; ccaaba (1 . 3) (1 . -2)
2601 ;; ccaabaddd (7 . 10) (7 . -3)
2602 ;; ccaabdd ("ad" . 6) (6 . 2)
2603 ;; ccaabaddd (6 . 8) (6 . -2)
2604 ;; | |<-- region: "caab", from 2 to 6
2605 ;;
2606 ;; When the user starts a run of undos in region,
2607 ;; undo-make-selective-list is called to create the full list of in
2608 ;; region elements. Each element is adjusted forward chronologically
2609 ;; through undo-deltas to determine if it is in the region.
2610 ;;
2611 ;; In the above example, the insertion of "b" is (3 . 4) in the
2612 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2613 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2614 ;; . 6) is assessed as in the region and placed in the selective list.
2615 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2616 ;; due to the selected element. The "b" insertion is the only element
2617 ;; fully in the region, so in this example undo-make-selective-list
2618 ;; returns (nil (5 . 6)).
2619 ;;
2620 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2621 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2622 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2623 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2624 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2625 ;;
2626 ;; More interesting is how to adjust the "ddd" insertion due to the
2627 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2628 ;; If the reinsertion was a manual retyping of "ad", then the total
2629 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2630 ;; the reinsertion was due to undo, one might expect the first "d"
2631 ;; character would again be a part of the "ddd" text, meaning its
2632 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2633 ;;
2634 ;; undo-make-selective-list assumes in this situation that "ad" was a
2635 ;; new edit, even if it was inserted because of an undo.
2636 ;; Consequently, if the user undos in region "8 to 10" of the
2637 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2638 ;; "ccaabad", as though the first "d" became detached from the
2639 ;; original "ddd" insertion. This quirk is a FIXME.
2642 "Return a list of undo elements for the region START to END.
2643 The elements come from `buffer-undo-list', but we keep only the
2644 elements inside this region, and discard those outside this
2645 region. The elements' positions are adjusted so as the returned
2646 list can be applied to the current buffer."
2648 ;; A list of position adjusted undo elements in the region.
2650 ;; A list of undo-deltas for out of region undo elements.
2651 undo-deltas
2652 undo-elt)
2660 ;; Don't put two nils together in the list
2664 ;; This is a "was unmodified" element. Keep it
2665 ;; if we have kept everything thus far.
2668 ;; Skip over marker adjustments, instead relying
2669 ;; on finding them after (TEXT . POS) elements
2671 nil)
2674 undo-deltas)))
2679 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2680 ;; kept. primitive-undo may discard them later.
2693 "Determine whether UNDO-ELT falls inside the region START ... END.
2694 If it crosses the edge, we return nil.
2696 Generally this function is not useful for determining
2697 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2698 because markers can be arbitrarily relocated. Instead, pass the
2699 marker adjustment's corresponding (TEXT . POS) element."
2704 t)
2706 nil)
2708 ;; (TEXT . POSITION)
2712 ;; (MARKER . ADJUSTMENT)
2715 ;; (nil PROPERTY VALUE BEG . END)
2720 ;; (BEGIN . END)
2725 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2726 This assumes we have already decided that UNDO-ELT
2727 is not *inside* the region START...END."
2731 ;; (nil PROPERTY VALUE BEG . END)
2736 ;; (BEGIN . END)
2741 "Return adjustment of undo element ELT by the undo DELTAS
2742 list."
2744 ;; POSITION
2747 ;; (BEG . END)
2750 ;; (TEXT . POSITION)
2754 ;; (nil PROPERTY VALUE BEG . END)
2757 ;; (apply DELTA START END FUN . ARGS)
2758 ;; FIXME
2759 ;; All others return same elt
2762 ;; (BEG . END) can adjust to the same positions, commonly when an
2763 ;; insertion was undone and they are out of region, for example:
2764 ;;
2765 ;; buf pos:
2766 ;; 123456789 buffer-undo-list undo-deltas
2767 ;; --------- ---------------- -----------
2768 ;; [...]
2769 ;; abbaa (2 . 4) (2 . -2)
2770 ;; aaa ("bb" . 2) (2 . 2)
2771 ;; [...]
2772 ;;
2773 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2774 ;; undo. Further adjustments to such an element should be the same as
2775 ;; for (TEXT . POSITION) elements. The options are:
2776 ;;
2777 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2778 ;; analogous to marker insertion-type t.
2779 ;;
2780 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2781 ;; marker insertion-type nil.
2782 ;;
2783 ;; There was no strong reason to prefer one or the other, except that
2784 ;; the first is more consistent with prior undo in region behavior.
2786 "Return cons of adjustments to BEG and END by the undo DELTAS
2787 list."
2789 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2794 "Return adjustment of POS by the undo DELTAS list, comparing
2795 with < or <= based on USE-<."
2801 ;; Don't allow pos to become less than the undo-delta
2802 ;; position. This edge case is described in the overview
2803 ;; comments.
2806 ;; Return the first affected buffer position and the delta for an undo element
2807 ;; delta is defined as the change in subsequent buffer positions if we *did*
2808 ;; the undo.
2812 ;; (TEXT . POSITION)
2815 ;; (BEGIN . END)
2821 ;;; Default undo-boundary addition
2822 ;;
2823 ;; This section adds a new undo-boundary at either after a command is
2824 ;; called or in some cases on a timer called after a change is made in
2825 ;; any buffer.
2827 "Describe the cause of the last undo-boundary.
2829 If `explicit', the last boundary was caused by an explicit call to
2830 `undo-boundary', that is one not called by the code in this
2831 section.
2833 If it is equal to `timer', then the last boundary was inserted
2834 by `undo-auto--boundary-timer'.
2836 If it is equal to `command', then the last boundary was inserted
2837 automatically after a command, that is by the code defined in
2838 this section.
2840 If it is equal to a list, then the last boundary was inserted by
2841 an amalgamating command. The car of the list is the number of
2842 times an amalgamating command has been called, and the cdr are the
2846 "Current timer which will run `undo-auto--boundary-timer' or nil.
2851 "Non-nil if `this-command' should be amalgamated.
2852 This variable is set to nil by `undo-auto--boundaries' and is set
2856 "Return non-nil if `buffer-undo-list' needs a boundary at the start."
2860 "Return the number of amalgamating last commands or nil.
2861 Amalgamating commands are, by default, either
2862 `self-insert-command' and `delete-char', but can be any command
2863 that calls `undo-auto-amalgamate'."
2867 "Add an `undo-boundary' to the current buffer if needed.
2868 REASON describes the reason that the boundary is being added; see
2869 `undo-auto--last-boundary' for more information."
2879 undo-auto--undoably-changed-buffers)
2880 cause)))))
2883 "Check recently changed buffers and add a boundary if necessary.
2884 REASON describes the reason that the boundary is being added; see
2885 `undo-last-boundary' for more information."
2886 ;; (Bug #23785) All commands should ensure that there is an undo
2887 ;; boundary whether they have changed the current buffer or not.
2897 "Timer which will run `undo--auto-boundary-timer'."
2902 "Ensure that the `undo-auto-boundary-timer' is set."
2908 "List of buffers that have changed recently.
2910 This list is maintained by `undo-auto--undoable-change' and
2911 `undo-auto--boundaries' and can be affected by changes to their
2915 "Add an `undo-boundary' in appropriate buffers."
2920 'amalgamate
2924 "Amalgamate undo if necessary.
2925 This function can be called before an amalgamating command. It
2926 removes the previous `undo-boundary' if a series of such calls
2927 have been made. By default `self-insert-command' and
2928 `delete-char' are the only amalgamating commands, although this
2929 function could be called by any command wishing to have this
2930 behavior."
2935 last-amalgamating-count
2940 ;; Amalgamate all buffers that have changed.
2944 b
2946 ;; The head of `buffer-undo-list' is nil.
2947 ;; `car-safe' doesn't work because
2948 ;; `buffer-undo-list' need not be a list!
2956 "Called after every undoable buffer change."
2959 ;; End auto-boundary section
2962 "If non-nil ask about discarding undo info for the current command.
2963 Normally, Emacs discards the undo info for the current command if
2964 it exceeds `undo-outer-limit'. But if you set this option
2965 non-nil, it asks in the echo area whether to discard the info.
2966 If you answer no, there is a slight risk that Emacs might crash, so
2967 only do it if you really want to undo the command.
2969 This option is mainly intended for debugging. You have to be
2970 careful if you use it for other purposes. Garbage collection is
2971 inhibited while the question is asked, meaning that Emacs might
2972 leak memory. So you should make sure that you do not wait
2973 excessively long before answering the question."
2979 "If non-nil, an extra level of size that's ok in an undo item.
2980 We don't ask the user about truncating the undo list until the
2981 current item gets bigger than this amount.
2986 ;; When the first undo batch in an undo list is longer than
2987 ;; undo-outer-limit, this function gets called to warn the user that
2988 ;; the undo info for the current command was discarded. Garbage
2989 ;; collection is inhibited around the call, so it had better not do a
2990 ;; lot of consing.
2996 ;; Don't ask the question again unless it gets even bigger.
2997 ;; This applies, in particular, if the user quits from the question.
2998 ;; Such a quit quits out of GC, but something else will call GC
2999 ;; again momentarily. It will call this function again,
3000 ;; but we don't want to ask the question again.
3004 "Buffer `%s' undo info is %d bytes long; discard it? "
3008 t)
3009 nil))
3015 "The undo info was discarded because it exceeded \
3016 `undo-outer-limit'.
3018 This is normal if you executed a command that made a huge change
3019 to the buffer. In that case, to prevent similar problems in the
3020 future, set `undo-outer-limit' to a value that is large enough to
3021 cover the maximum size of normal changes you expect a single
3022 command to make, but not so large that it might exceed the
3023 maximum memory allotted to Emacs.
3025 If you did not execute any such command, the situation is
3026 probably due to a bug and you should report it.
3028 You can disable the popping up of this buffer by adding the entry
3029 \(undo discard-info) to the user option `warning-suppress-types',
3033 t))
3034 \f
3037 ; These are sorted according to the GNU en_US locale.
3080 )
3082 This is used by Shell mode and other parts of Emacs to recognize
3083 password prompts, including prompts in languages other than
3084 English. Different case choices should not be assumed to be
3085 included; callers should bind `case-fold-search' to t."
3091 "History list for some commands that read shell commands.
3093 Maximum length of the history list is determined by the value
3100 "Buffer name for `shell-command' and `shell-command-on-region' error output.
3101 This buffer is used when `shell-command' or `shell-command-on-region'
3102 is run interactively. A value of nil means that output to stderr and
3109 "Return a list of all commands associated with the current file.
3110 This function is used to add all related commands retrieved by `mailcap'
3111 to the end of the list of defaults just after the default value."
3115 minibuffer-default))
3120 commands))
3131 map)
3135 "Read a shell command from the minibuffer.
3136 The arguments are the same as the ones of `read-from-minibuffer',
3137 except READ and KEYMAP are missing and HIST defaults
3138 to `shell-command-history'."
3146 minibuffer-local-shell-command-map
3147 nil
3149 args)))
3152 "What to do when the output buffer is used by another shell command.
3153 This option specifies how to resolve the conflict where a new command
3154 wants to direct its output to the buffer `*Async Shell Command*',
3155 but this buffer is already taken by another running shell command.
3157 The value `confirm-kill-process' is used to ask for confirmation before
3158 killing the already running process and running a new process
3159 in the same buffer, `confirm-new-buffer' for confirmation before running
3160 the command in a new buffer with a name other than the default buffer name,
3161 `new-buffer' for doing the same without confirmation,
3162 `confirm-rename-buffer' for confirmation before renaming the existing
3163 output buffer and running a new command in the default buffer,
3164 `rename-buffer' for doing the same without confirmation."
3166 confirm-kill-process)
3168 confirm-new-buffer)
3170 new-buffer)
3172 confirm-rename-buffer)
3174 rename-buffer))
3179 "Execute string COMMAND asynchronously in background.
3181 Like `shell-command', but adds `&' at the end of COMMAND
3182 to execute it asynchronously.
3184 The output appears in the buffer `*Async Shell Command*'.
3185 That buffer is in shell mode.
3187 You can configure `async-shell-command-buffer' to specify what to do in
3188 case when `*Async Shell Command*' buffer is already taken by another
3189 running shell command. To run COMMAND without displaying the output
3190 in a window you can configure `display-buffer-alist' to use the action
3191 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
3193 In Elisp, you will often be better served by calling `start-process'
3194 directly, since it offers more control and does not impose the use of a
3195 shell (with its need to quote arguments)."
3205 current-prefix-arg
3206 shell-command-default-error-buffer))
3212 "Execute string COMMAND in inferior shell; display output, if any.
3213 With prefix argument, insert the COMMAND's output at point.
3215 Interactively, prompt for COMMAND in the minibuffer.
3217 If COMMAND ends in `&', execute it asynchronously.
3218 The output appears in the buffer `*Async Shell Command*'.
3219 That buffer is in shell mode. You can also use
3220 `async-shell-command' that automatically adds `&'.
3222 Otherwise, COMMAND is executed synchronously. The output appears in
3223 the buffer `*Shell Command Output*'. If the output is short enough to
3224 display in the echo area (which is determined by the variables
3225 `resize-mini-windows' and `max-mini-window-height'), it is shown
3226 there, but it is nonetheless available in buffer `*Shell Command
3227 Output*' even though that buffer is not automatically displayed.
3229 To specify a coding system for converting non-ASCII characters
3231 before this command.
3233 Noninteractive callers can specify coding systems by binding
3234 `coding-system-for-read' and `coding-system-for-write'.
3236 The optional second argument OUTPUT-BUFFER, if non-nil,
3237 says to put the output in some other buffer.
3238 If OUTPUT-BUFFER is a buffer or buffer name, erase that buffer
3239 and insert the output there.
3240 If OUTPUT-BUFFER is not a buffer and not nil, insert the output
3241 in current buffer after point leaving mark after it.
3242 (This cannot be done asynchronously).
3244 If the command terminates without error, but generates output,
3246 the output can be displayed in the echo area or in its buffer.
3247 If the output is short enough to display in the echo area
3248 \(determined by the variable `max-mini-window-height' if
3249 `resize-mini-windows' is non-nil), it is shown there.
3250 Otherwise,the buffer containing the output is displayed.
3254 of the output.
3256 If there is no output, or if output is inserted in the current buffer,
3257 then `*Shell Command Output*' is deleted.
3259 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3260 or buffer name to which to direct the command's standard error output.
3261 If it is nil, error output is mingled with regular output.
3262 In an interactive call, the variable `shell-command-default-error-buffer'
3263 specifies the value of ERROR-BUFFER.
3265 In Elisp, you will often be better served by calling `call-process' or
3266 `start-process' directly, since it offers more control and does not impose
3267 the use of a shell (with its need to quote arguments)."
3278 current-prefix-arg
3279 shell-command-default-error-buffer))
3280 ;; Look for a handler in case default-directory is a remote file name.
3288 ;; Output goes in current buffer.
3294 temporary-file-directory)))
3295 nil)))
3298 ;; We do not use -f for csh; we will not support broken use of
3299 ;; .cshrcs. Even the BSD csh manual says to use
3300 ;; "if ($?prompt) exit" before things which are not useful
3301 ;; non-interactively. Besides, if someone wants their other
3302 ;; aliases for shell commands then they can still have them.
3306 t)
3307 nil shell-command-switch command)
3314 ;; Do no formatting while reading error file,
3315 ;; because that can run a shell command, and we
3316 ;; don't want that to cause an infinite recursion.
3318 ;; Put point after the inserted errors.
3322 ;; This is like exchange-point-and-mark, but doesn't
3323 ;; activate the mark. It is cleaner to avoid activation,
3324 ;; even though the command loop would deactivate the mark
3325 ;; because we inserted text.
3329 ;; Output goes in a separate buffer.
3330 ;; Preserve the match data in case called from a program.
3333 ;; Command ending with ampersand means asynchronous.
3337 proc)
3338 ;; Remove the ampersand.
3340 ;; Ask the user what to do with already running process.
3345 ;; If will kill a process, query first.
3350 ;; If will create a new buffer, query first.
3357 ;; It will create a new buffer.
3362 ;; If will rename the buffer, query first.
3371 ;; It will rename the buffer.
3378 ;; Setting buffer-read-only to nil doesn't suffice
3379 ;; if some text has a non-nil read-only property,
3380 ;; which comint sometimes adds for prompts.
3386 shell-command-switch command))
3390 ;; Use the comint filter for proper handling of carriage motion
3391 ;; (see `comint-inhibit-carriage-motion'),.
3393 ))
3394 ;; Otherwise, command is executed synchronously.
3396 output-buffer nil error-buffer)))))))
3399 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3400 MESSAGE may be either a string or a buffer.
3402 A pop-up buffer is displayed using `display-buffer' if MESSAGE is too long
3403 for maximum height of the echo area, as defined by `max-mini-window-height'
3404 if `resize-mini-windows' is non-nil.
3406 Returns either the string shown in the echo area, or when a pop-up
3407 buffer is used, the window used to display it.
3409 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3410 name of the buffer used to display it in the case where a pop-up buffer
3411 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3412 string and it is displayed in the echo area, it is not specified whether
3413 the contents are inserted into the buffer anyway.
3415 Optional arguments ACTION and FRAME are as for `display-buffer',
3416 and are only used if a pop-up buffer is displayed."
3418 ;; Trivial case where we can use the echo area
3422 ;; Trivial case where we can just remove single trailing newline
3425 ;; General case
3428 message
3437 0
3441 (<= lines
3445 max-mini-window-height))
3447 max-mini-window-height)
3451 ;; Don't use the echo area if the output buffer is
3452 ;; already displayed in the selected frame.
3454 ;; Echo area
3460 ;; Buffer
3465 ;; We have a sentinel to prevent insertion of a termination message
3466 ;; in the buffer itself.
3474 &optional output-buffer replace
3475 error-buffer display-error-buffer
3476 region-noncontiguous-p)
3477 "Execute string COMMAND in inferior shell with region as input.
3478 Normally display output (if any) in temp buffer `*Shell Command Output*';
3479 Prefix arg means replace the region with it. Return the exit code of
3480 COMMAND.
3482 To specify a coding system for converting non-ASCII characters
3484 before this command. By default, the input (from the current buffer)
3485 is encoded using coding-system specified by `process-coding-system-alist',
3486 falling back to `default-process-coding-system' if no match for COMMAND
3487 is found in `process-coding-system-alist'.
3489 Noninteractive callers can specify coding systems by binding
3490 `coding-system-for-read' and `coding-system-for-write'.
3492 If the command generates output, the output may be displayed
3493 in the echo area or in a buffer.
3494 If the output is short enough to display in the echo area
3495 \(determined by the variable `max-mini-window-height' if
3496 `resize-mini-windows' is non-nil), it is shown there.
3497 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3498 The output is available in that buffer in both cases.
3500 If there is output and an error, a message about the error
3501 appears at the end of the output. If there is no output, or if
3502 output is inserted in the current buffer, the buffer `*Shell
3503 Command Output*' is deleted.
3505 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3506 command's output. If the value is a buffer or buffer name,
3507 erase that buffer and insert the output there.
3508 If the value is nil, use the buffer `*Shell Command Output*'.
3509 Any other non-nil value means to insert the output in the
3510 current buffer after START.
3512 Optional fifth arg REPLACE, if non-nil, means to insert the
3513 output in place of text from START to END, putting point and mark
3514 around it.
3516 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3517 or buffer name to which to direct the command's standard error
3518 output. If nil, error output is mingled with regular output.
3519 When called interactively, `shell-command-default-error-buffer'
3520 is used for ERROR-BUFFER.
3522 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3523 display the error buffer if there were any errors. When called
3524 interactively, this is t."
3528 ;; Do this before calling region-beginning
3529 ;; and region-end, in case subprocess output
3530 ;; relocates them while we are in the minibuffer.
3532 ;; call-interactively recognizes region-beginning and
3533 ;; region-end specially, leaving them in the history.
3535 string
3536 current-prefix-arg
3537 current-prefix-arg
3538 shell-command-default-error-buffer
3539 t
3546 temporary-file-directory)))
3547 nil))
3548 exit-status)
3549 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
3552 output)
3556 shell-file-name t t
3557 nil shell-command-switch
3558 command)
3565 ;; Replace specified region with output from command.
3567 ;; Don't muck with mark unless REPLACE says we should.
3574 t)
3575 nil shell-command-switch command))
3576 ;; It is rude to delete a buffer which the command is not using.
3577 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3578 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3579 ;; (kill-buffer shell-buffer)))
3580 ;; Don't muck with mark unless REPLACE says we should.
3582 ;; No prefix argument: put the output in a temp buffer,
3583 ;; replacing its entire contents.
3588 ;; If the input is the same buffer as the output,
3589 ;; delete everything but the specified region,
3590 ;; then replace that region with the output.
3596 shell-file-name t
3599 t)
3600 nil shell-command-switch
3601 command)))
3602 ;; Clear the output buffer, then run the command with
3603 ;; output there.
3614 buffer)
3615 nil shell-command-switch command)))
3616 ;; Report the output.
3626 ;; There's some output, display it
3628 ;; No output; error?
3635 shell-command-default-error-buffer)
3642 output))
3645 exit-status))
3648 exit-status output))))
3649 ;; Don't kill: there might be useful info in the undo-log.
3650 ;; (kill-buffer buffer)
3651 )))))
3659 ;; Do no formatting while reading error file,
3660 ;; because that can run a shell command, and we
3661 ;; don't want that to cause an infinite recursion.
3663 ;; Put point after the inserted errors.
3668 exit-status))
3671 "Execute shell command COMMAND and return its output as a string."
3674 standard-output
3678 "Process files synchronously in a separate process.
3679 Similar to `call-process', but may invoke a file handler based on
3680 `default-directory'. The current working directory of the
3681 subprocess is `default-directory'.
3683 File names in INFILE and BUFFER are handled normally, but file
3684 names in ARGS should be relative to `default-directory', as they
3685 are passed to the process verbatim. (This is a difference to
3686 `call-process' which does not support file handlers for INFILE
3687 and BUFFER.)
3689 Some file handlers might not support all variants, for example
3690 they might behave as if DISPLAY was nil, regardless of the actual
3691 value passed."
3693 lc stderr-file)
3703 display args)
3709 "Whether a call of `process-file' changes remote files.
3711 By default, this variable is always set to t, meaning that a
3712 call of `process-file' could potentially change any file on a
3713 remote host. When set to nil, a file handler could optimize
3714 its behavior with respect to remote file attribute caching.
3716 You should only ever change this variable with a let-binding;
3720 "Start a program in a subprocess. Return the process object for it.
3722 Similar to `start-process', but may invoke a file handler based on
3723 `default-directory'. See Info node `(elisp)Magic File Names'.
3725 This handler ought to run PROGRAM, perhaps on the local host,
3726 perhaps on a remote host that corresponds to `default-directory'.
3727 In the latter case, the local part of `default-directory' becomes
3728 the working directory of the process.
3730 PROGRAM and PROGRAM-ARGS might be file names. They are not
3731 objects of file handler invocation. File handlers might not
3732 support pty association, if PROGRAM is nil."
3736 \f
3737 ;;;; Process menu
3751 map))
3754 "Major mode for listing the processes called by Emacs."
3767 "Kill process at point in a `list-processes' buffer."
3778 "Recompute the list of processes for the Process List buffer.
3779 Also, delete any process that is exited or signaled."
3793 face link
3795 "Visit buffer `%s'"
3797 follow-link t
3798 process-buffer ,buf
3799 action process-menu-visit-buffer)
3808 "datagram"
3825 tabulated-list-entries))))))
3831 "Display a list of all processes that are Emacs sub-processes.
3832 If optional argument QUERY-ONLY is non-nil, only processes with
3833 the query-on-exit flag set are listed.
3834 Any process listed as exited or signaled is actually eliminated
3835 after the listing is made.
3836 Optional argument BUFFER specifies a buffer to use, instead of
3838 The return value is always nil.
3840 This function lists only processes that were launched by Emacs. To
3841 see other processes running on the system, use `list-system-processes'."
3853 nil)
3854 \f
3855 ;;;; Prefix commands
3861 ;; BEWARE: Called directly from C code.
3862 ;; If the return value is non-nil, it means we are in the middle of
3863 ;; a command with prefix, such as a command invoked with prefix-arg.
3865 prefix-command--last-echo
3874 "Abnormal hook which constructs the description of the current prefix state.
3878 "Update state of prefix commands.
3886 "Pass the current prefix command state to the next command.
3887 Should be called by all prefix commands.
3888 Runs `prefix-command-preserve-state-hook'."
3890 ;; If the current command is a prefix command, we don't want the next (real)
3891 ;; command to have `last-command' set to, say, `universal-argument'.
3898 nil)
3900 ;;;;; The main prefix command.
3902 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
3927 ;; For backward compatibility, minus with no modifiers is an ordinary
3928 ;; command if digits have already been entered.
3958 map)
3966 "Begin a numeric argument for the following command.
3971 multiplies the argument by 4 each time.
3973 which is different in effect from any particular numeric argument.
3981 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3982 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3989 arg)))
3993 "Begin a negative numeric argument for the next command.
4003 "Part of the numeric argument for the next command.
4008 last-command-event
4015 ;; Treat -0 as just -, so that -01 will work.
4018 digit))))
4020 \f
4028 "Function to perform the filtering in `filter-buffer-substring'.
4029 The function is called with the same 3 arguments (BEG END DELETE)
4030 that `filter-buffer-substring' received. It should return the
4031 buffer substring between BEG and END, after filtering. If DELETE is
4035 "List of filter functions for `buffer-substring--filter'.
4036 Each function must accept a single argument, a string, and return a string.
4037 The buffer substring is passed to the first function in the list,
4038 and the return value of each function is passed to the next.
4039 As a special convention, point is set to the start of the buffer text
4040 being operated on (i.e., the first argument of `buffer-substring--filter')
4046 "Return the buffer substring between BEG and END, after filtering.
4047 If DELETE is non-nil, delete the text between BEG and END from the buffer.
4049 This calls the function that `filter-buffer-substring-function' specifies
4050 \(passing the same three arguments that it received) to do the work,
4051 and returns whatever it does. The default function does no filtering,
4052 unless a hook has been set.
4054 Use `filter-buffer-substring' instead of `buffer-substring',
4055 `buffer-substring-no-properties', or `delete-and-extract-region' when
4056 you want to allow filtering to take place. For example, major or minor
4057 modes can use `filter-buffer-substring-function' to extract characters
4058 that are special to a buffer, and should not be copied into other buffers."
4062 "Default function to use for `filter-buffer-substring-function'.
4063 Its arguments and return value are as specified for `filter-buffer-substring'.
4064 This respects the wrapper hook `filter-buffer-substring-functions',
4065 and the abnormal hook `buffer-substring-filters'.
4066 No filtering is done unless a hook says to."
4077 string)))
4082 ;;;; Window system cut and paste hooks.
4085 "Function to call to make a killed region available to other programs.
4086 Most window systems provide a facility for cutting and pasting
4087 text between different programs, such as the clipboard on X and
4088 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4090 This variable holds a function that Emacs calls whenever text is
4091 put in the kill ring, to make the new kill available to other
4092 programs. The function takes one argument, TEXT, which is a
4096 "Function to call to get text cut from other programs.
4097 Most window systems provide a facility for cutting and pasting
4098 text between different programs, such as the clipboard on X and
4099 MS-Windows, or the pasteboard on Nextstep/Mac OS.
4101 This variable holds a function that Emacs calls to obtain text
4102 that other programs have provided for pasting. The function is
4103 called with no arguments. If no other program has provided text
4104 to paste, the function should return nil (in which case the
4105 caller, usually `current-kill', should use the top of the Emacs
4106 kill ring). If another program has provided text to paste, the
4107 function should return that text as a string (in which case the
4108 caller should put this string in the kill ring as the latest
4109 kill).
4111 The function may also return a list of strings if the window
4112 system supports multiple selections. The first string will be
4113 used as the pasted text, but the other will be placed in the kill
4114 ring for easy access via `yank-pop'.
4116 Note that the function should return a string only if a program
4117 other than Emacs has provided a string for pasting; if Emacs
4118 provided the most recent string, the function should return nil.
4119 If it is difficult to tell whether Emacs or some other program
4120 provided the current string, it is probably good enough to return
4121 nil if the string is equal (according to `string=') to the last
4123 \f
4126 ;;;; The kill ring data structure.
4129 "List of killed text sequences.
4130 Since the kill ring is supposed to interact nicely with cut-and-paste
4131 facilities offered by window systems, use of this variable should
4132 interact nicely with `interprogram-cut-function' and
4133 `interprogram-paste-function'. The functions `kill-new',
4134 `kill-append', and `current-kill' are supposed to implement this
4135 interaction; you may want to use them instead of manipulating the kill
4139 "Maximum length of kill ring before oldest elements are thrown away."
4147 "Save clipboard strings into kill ring before replacing them.
4148 When one selects something in another program to paste it into Emacs,
4149 but kills something in Emacs before actually pasting it,
4150 this selection is gone unless this variable is non-nil,
4151 in which case the other program's selection is saved in the `kill-ring'
4158 "Do not add a new string to `kill-ring' if it duplicates the last one.
4159 The comparison is done using `equal-including-properties'."
4165 "Make STRING the latest kill in the kill ring.
4166 Set `kill-ring-yank-pointer' to point to it.
4167 If `interprogram-cut-function' is non-nil, apply it to STRING.
4168 Optional second argument REPLACE non-nil means that STRING will replace
4169 the front of the kill ring, rather than being added to the list.
4171 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
4172 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
4173 STRING.
4175 When the yank handler has a non-nil PARAM element, the original STRING
4176 argument is not used by `insert-for-yank'. However, since Lisp code
4177 may access and use elements from the kill ring directly, the STRING
4180 ;; Due to text properties such as 'yank-handler that
4181 ;; can alter the contents to yank, comparison using
4182 ;; `equal' is unsafe.
4207 ;; It has been argued that this should work similar to `self-insert-command'
4208 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
4210 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
4216 "Append STRING to the end of the latest kill in the kill ring.
4217 If BEFORE-P is non-nil, prepend STRING to the kill.
4218 Also removes the last undo boundary in the current buffer,
4219 depending on `kill-append-merge-undo'.
4220 If `interprogram-cut-function' is set, pass the resulting kill to it."
4228 ;; find the next undo boundary
4232 ;; remove this undo boundary
4237 "Whether rotating the kill ring changes the window system selection.
4238 If non-nil, whenever the kill ring is rotated (usually via the
4239 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4240 to copy the new kill to the window system selection."
4246 "Rotate the yanking point by N places, and then return that kill.
4247 If N is zero and `interprogram-paste-function' is set to a
4248 function that returns a string or a list of strings, and if that
4249 function doesn't return nil, then that string (or list) is added
4250 to the front of the kill ring and the string (or first string in
4251 the list) is returned as the latest kill.
4253 If N is not zero, and if `yank-pop-change-selection' is
4254 non-nil, use `interprogram-cut-function' to transfer the
4255 kill at the new yank point into the window system selection.
4257 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4258 move the yanking point; just return the Nth kill forward."
4261 interprogram-paste-function
4265 ;; Disable the interprogram cut function when we add the new
4266 ;; text to the kill ring, so Emacs doesn't try to own the
4267 ;; selection, with identical text.
4277 kill-ring)))
4282 interprogram-cut-function)
4288 ;;;; Commands for manipulating the kill ring.
4291 "Non-nil means don't signal an error for killing read-only text."
4297 This deletes the text from the buffer and saves it in the kill ring.
4301 If you want to append the killed region to the last killed text,
4305 If the previous command was also a kill command,
4306 the text killed this time appends to the text killed last time
4307 to make one entry in the kill ring.
4309 The killed text is filtered by `filter-buffer-substring' before it is
4310 saved in the kill ring, so the actual saved text might be different
4311 from what was killed.
4313 If the buffer is read-only, Emacs will beep and refrain from deleting
4314 the text, but put the text in the kill ring anyway. This means that
4315 you can use the killing commands to copy text from a read-only buffer.
4317 Lisp programs should use this function for killing text.
4318 (To delete text, use `delete-region'.)
4319 Supply two arguments, character positions BEG and END indicating the
4320 stretch of text to be killed. If the optional argument REGION is
4321 non-nil, the function ignores BEG and END, and kills the current
4322 region instead."
4323 ;; Pass mark first, then point, because the order matters when
4324 ;; calling `kill-append'.
4333 ;; Add that string to the kill ring, one way or another.
4340 nil)
4342 ;; The code above failed because the buffer, or some of the characters
4343 ;; in the region, are read-only.
4344 ;; We should beep, in case the user just isn't aware of this.
4345 ;; However, there's no harm in putting
4346 ;; the region's text in the kill ring, anyway.
4348 ;; Set this-command now, so it will be set even if we get an error.
4350 ;; This should barf, if appropriate, and give us the correct error.
4353 ;; Signal an error if the buffer is read-only.
4355 ;; If the buffer isn't read-only, the text is.
4358 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4359 ;; to get two copies of the text when the user accidentally types M-w and
4360 ;; then corrects it with the intended C-w.
4362 "Save the region as if killed, but don't kill it.
4363 In Transient Mark mode, deactivate the mark.
4364 If `interprogram-cut-function' is non-nil, also save the text for a window
4365 system cut and paste.
4367 The copied text is filtered by `filter-buffer-substring' before it is
4368 saved in the kill ring, so the actual saved text might be different
4369 from what was in the buffer.
4371 When called from Lisp, save in the kill ring the stretch of text
4372 between BEG and END, unless the optional argument REGION is
4373 non-nil, in which case ignore BEG and END, and save the current
4374 region instead.
4376 This command's old key binding has been given to `kill-ring-save'."
4377 ;; Pass mark first, then point, because the order matters when
4378 ;; calling `kill-append'.
4388 nil)
4391 "Save the region as if killed, but don't kill it.
4392 In Transient Mark mode, deactivate the mark.
4393 If `interprogram-cut-function' is non-nil, also save the text for a window
4394 system cut and paste.
4396 If you want to append the killed line to the last killed text,
4399 The copied text is filtered by `filter-buffer-substring' before it is
4400 saved in the kill ring, so the actual saved text might be different
4401 from what was in the buffer.
4403 When called from Lisp, save in the kill ring the stretch of text
4404 between BEG and END, unless the optional argument REGION is
4405 non-nil, in which case ignore BEG and END, and save the current
4406 region instead.
4408 This command is similar to `copy-region-as-kill', except that it gives
4409 visual feedback indicating the extent of the region being copied."
4410 ;; Pass mark first, then point, because the order matters when
4411 ;; calling `kill-append'.
4415 ;; This use of called-interactively-p is correct because the code it
4416 ;; controls just gives the user visual feedback.
4421 "Indicate that the region text has been copied interactively.
4422 If the mark is visible in the selected window, blink the cursor
4423 between point and mark if there is currently no active region
4424 highlighting.
4426 If the mark lies outside the selected window, display an
4427 informative message containing a sample of the copied text. The
4428 optional argument MESSAGE-LEN, if non-nil, specifies the length
4429 of this sample text; it defaults to 40."
4432 ;; Inhibit quitting so we can make a quit here
4433 ;; look like a C-g typed as a command.
4436 ;; Swap point-and-mark quickly so as to show the region that
4437 ;; was selected. Don't do it if the region is highlighted.
4440 ;; Swap point and mark.
4444 ;; Swap back.
4447 ;; If user quit, deactivate the mark
4448 ;; as C-g would as a command.
4454 ;; Don't say "killed"; that is misleading.
4461 "Cause following command, if it kills, to add to previous kill.
4462 If the next command kills forward from point, the kill is
4463 appended to the previous killed text. If the command kills
4464 backward, the kill is prepended. Kill commands that act on the
4465 region, such as `kill-region', are regarded as killing forward if
4466 point is after mark, and killing backward if point is before
4467 mark.
4469 If the next command is not a kill command, `append-next-kill' has
4470 no effect.
4472 The argument is used for internal purposes; do not supply one."
4474 ;; We don't use (interactive-p), since that breaks kbd macros.
4488 "A subroutine of `squeeze-bidi-context'.
4489 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4493 lim1)
4500 ;; L and R categories include embedding and
4501 ;; override controls, but we don't want to
4502 ;; replace them, because that might change
4503 ;; the visual order. Likewise with PDF and
4504 ;; isolate controls.
4506 bidi-directional-non-controls-chars
4507 limit)))))
4508 ;; Replace any run of non-RTL characters by a single LRM.
4510 ;; No more characters of CATEGORY, we are done.
4515 ;; Skip directional controls, if any.
4520 "Replace characters between FROM and TO while keeping bidi context.
4522 This function replaces the region of text with as few characters
4523 as possible, while preserving the effect that region will have on
4524 bidirectional display before and after the region."
4528 ;; This is for when they copy text with read-only text
4529 ;; properties.
4533 ;; Replace each run of non-RTL characters with a single LRM.
4535 ;; Replace each run of non-LTR characters with a single RLM. Note
4536 ;; that the \cR category includes both the Arabic Letter (AL) and
4537 ;; R characters; here we ignore the distinction between them,
4538 ;; because that distinction only affects Arabic Number (AN)
4539 ;; characters, which are weak and don't affect the reordering.
4543 "Return buffer text between START and END with its bidi context.
4545 START and END are assumed to belong to the same physical line
4546 of buffer text. This function prepends and appends to the text
4547 between START and END bidi control characters that preserve the
4548 visual order of that text when it is inserted at some other place."
4553 substr para-dir from to)
4560 ;; If we don't have any mixed directional characters in the
4561 ;; entire line, we can just copy the substring without adding
4562 ;; any context.
4577 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4578 ;; (1) force the string to have the same base embedding
4579 ;; direction as the paragraph direction at the source, no matter
4580 ;; what is the paragraph direction at destination; and (2) avoid
4581 ;; affecting the visual order of the surrounding text at
4582 ;; destination if there are characters of different
4583 ;; directionality there.
4588 "Return portion of current buffer between START and END with bidi context.
4590 This function works similar to `buffer-substring', but it prepends and
4591 appends to the text bidi directional control characters necessary to
4592 preserve the visual appearance of the text if it is inserted at another
4593 place. This is useful when the buffer substring includes bidirectional
4594 text and control characters that cause non-trivial reordering on display.
4595 If copied verbatim, such text can have a very different visual appearance,
4596 and can also change the visual appearance of the surrounding text at the
4597 destination of the copy.
4599 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4600 the text properties."
4613 no-properties)))
4617 substr)))
4618 \f
4619 ;; Yanking.
4624 "List of special text property handling conditions for yanking.
4625 Each element should have the form (PROP . FUN), where PROP is a
4626 property symbol and FUN is a function. When the `yank' command
4627 inserts text into the buffer, it scans the inserted text for
4628 stretches of text that have `eq' values of the text property
4629 PROP; for each such stretch of text, FUN is called with three
4630 arguments: the property's value in that text, and the start and
4631 end positions of the text.
4633 This is done prior to removing the properties specified by
4634 `yank-excluded-properties'."
4637 function))
4640 ;; This is actually used in subr.el but defcustom does not work there.
4643 intangible invisible keymap local-map mouse-face read-only
4644 yank-handler)
4645 "Text properties to discard when yanking.
4646 The value should be a list of text properties to discard or t,
4647 which means to discard all text properties.
4649 See also `yank-handled-properties'."
4656 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4657 Function is called with two parameters, START and END corresponding to
4658 the value of the mark and point; it is guaranteed that START <= END.
4662 "Replace just-yanked stretch of killed text with a different stretch.
4663 This command is allowed only immediately after a `yank' or a `yank-pop'.
4664 At such a time, the region contains a stretch of reinserted
4665 previously-killed text. `yank-pop' deletes that text and inserts in its
4666 place a different stretch of killed text.
4668 With no argument, the previous kill is inserted.
4669 With argument N, insert the Nth previous kill.
4670 If N is negative, this is a more recent kill.
4672 The sequence of kills wraps around, so that after the oldest one
4673 comes the newest one.
4675 When this command inserts killed text into the buffer, it honors
4676 `yank-excluded-properties' and `yank-handler' as described in the
4677 doc string for `insert-for-yank-1', which see."
4691 ;; Set the window start back where it was in the yank command,
4692 ;; if possible.
4695 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4696 ;; It is cleaner to avoid activation, even though the command
4697 ;; loop would deactivate the mark because we inserted text.
4700 nil)
4704 More precisely, reinsert the most recent kill, which is the
4705 stretch of killed text most recently killed OR yanked. Put point
4706 at the end, and set mark at the beginning without activating it.
4708 With argument N, reinsert the Nth most recent kill.
4710 When this command inserts text into the buffer, it honors the
4711 `yank-handled-properties' and `yank-excluded-properties'
4712 variables, and the `yank-handler' text property. See
4713 `insert-for-yank-1' for details.
4718 ;; If we don't get all the way thru, make last-command indicate that
4719 ;; for the following command.
4727 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4728 ;; It is cleaner to avoid activation, even though the command
4729 ;; loop would deactivate the mark because we inserted text.
4732 ;; If we do get all the way thru, make this-command indicate that.
4735 nil)
4738 "Rotate the yanking point in the kill ring.
4739 With ARG, rotate that many kills forward (or backward, if negative)."
4742 \f
4743 ;; Some kill commands.
4745 ;; Internal subroutine of delete-char
4751 ;; Internal subroutine of backward-delete-char
4758 "The method for untabifying when deleting backward.
4759 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4760 `hungry' -- delete all whitespace, both tabs and spaces;
4761 `all' -- delete all whitespace, including tabs, spaces and newlines;
4762 nil -- just delete one character."
4768 "Delete characters backward, changing tabs into spaces.
4769 The exact behavior depends on `backward-delete-char-untabify-method'.
4770 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4771 Interactively, ARG is the prefix arg (default 1)
4772 and KILLP is t if a prefix arg was specified."
4795 arg)))
4796 ;; Avoid warning about delete-backward-char
4800 "Kill up to and including ARGth occurrence of CHAR.
4801 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4802 Goes backward if ARG is negative; error if CHAR not found."
4805 ;; Avoid "obsolete" warnings for translation-table-for-input.
4813 ;; kill-line and its subroutines.
4816 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4821 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4822 With prefix argument ARG, kill that many lines from point.
4823 Negative arguments kill lines backward.
4824 With zero argument, kills the text before point on the current line.
4827 a number counts as a prefix arg.
4829 To kill a whole line, when point is not at the beginning, type \
4832 If `show-trailing-whitespace' is non-nil, this command will just
4833 kill the rest of the current line, even if there are only
4834 nonblanks there.
4836 If option `kill-whole-line' is non-nil, then this command kills the whole line
4837 including its terminating newline, when used at the beginning of a line
4838 with no argument. As a consequence, you can always kill a whole line
4841 If you want to append the killed line to the last killed text,
4844 If the buffer is read-only, Emacs will beep and refrain from deleting
4845 the line, but put the line in the kill ring anyway. This means that
4846 you can use this command to copy text from a read-only buffer.
4847 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4848 even beep.)"
4851 ;; It is better to move point to the other end of the kill
4852 ;; before killing. That way, in a read-only buffer, point
4853 ;; moves across the text that is copied to the kill ring.
4854 ;; The choice has no effect on undo now that undo records
4855 ;; the value of point from before the command was run.
4865 ;; If trailing whitespace is visible,
4866 ;; don't treat it as nothing.
4876 "Kill current line.
4877 With prefix ARG, kill that many lines starting from the current line.
4878 If ARG is negative, kill backward. Also kill the preceding newline.
4880 If ARG is zero, kill current line but exclude the trailing newline."
4891 ;; We need to kill in two steps, because the previous command
4892 ;; could have been a kill command, in which case the text
4893 ;; before point needs to be prepended to the current kill
4894 ;; ring entry and the text after point appended. Also, we
4895 ;; need to use save-excursion to avoid copying the same text
4896 ;; twice to the kill ring in read-only buffers.
4914 "Move forward by ARG lines, ignoring currently invisible newlines only.
4915 If ARG is negative, move backward -ARG lines.
4916 If ARG is zero, move to the beginning of the current line."
4923 ;; If the newline we just skipped is invisible,
4924 ;; don't count it.
4928 prop
4933 ;; If invisible text follows, and it is a number of complete lines,
4934 ;; skip it.
4940 prop
4956 ;; If the newline we just moved to is invisible,
4957 ;; don't count it.
4962 prop
4967 ;; If invisible text follows, and it is a number of complete lines,
4968 ;; skip it.
4974 prop
4985 nil)))
4988 "Move to end of current visible line."
4990 ;; If the following character is currently invisible,
4991 ;; skip all characters with that same `invisible' property value,
4992 ;; then find the next newline.
4999 prop
5008 \f
5010 "Insert after point the contents of BUFFER.
5011 Puts mark after the inserted text.
5012 BUFFER may be a buffer or a buffer name."
5022 t))))
5027 nil)
5030 "Append to specified buffer the text of the region.
5031 It is inserted into that buffer before its point.
5033 When calling from a program, give three arguments:
5034 BUFFER (or buffer name), START and END.
5035 START and END specify the portion of the current buffer to be copied."
5042 point)
5053 "Prepend to specified buffer the text of the region.
5054 It is inserted into that buffer after its point.
5056 When calling from a program, give three arguments:
5057 BUFFER (or buffer name), START and END.
5058 START and END specify the portion of the current buffer to be copied."
5067 "Copy to specified buffer the text of the region.
5068 It is inserted into that buffer, replacing existing text there.
5070 When calling from a program, give three arguments:
5071 BUFFER (or buffer name), START and END.
5072 START and END specify the portion of the current buffer to be copied."
5080 \f
5084 "Hook run when the mark becomes active.
5085 It is also run at the end of a command, if the mark is active and
5092 "Return this buffer's mark value as integer, or nil if never set.
5094 In Transient Mark mode, this function signals an error if
5095 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
5096 or the argument FORCE is non-nil, it disregards whether the mark
5097 is active, and returns an integer or nil in the usual way.
5099 If you are using this in an editing command, you are most likely making
5100 a mistake; see the documentation of `set-mark'."
5105 ;; Behind display-selections-p.
5108 "Deactivate the mark.
5109 If Transient Mark mode is disabled, this function normally does
5110 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
5112 Deactivating the mark sets `mark-active' to nil, updates the
5113 primary selection according to `select-active-regions', and runs
5114 `deactivate-mark-hook'.
5116 If Transient Mark mode was temporarily enabled, reset the value
5117 of the variable `transient-mark-mode'; if this causes Transient
5118 Mark mode to be disabled, don't change `mark-active' to nil or
5119 run `deactivate-mark-hook'."
5123 select-active-regions)
5126 ;; The var `saved-region-selection', if non-nil, is the text in
5127 ;; the region prior to the last command modifying the buffer.
5128 ;; Set the selection to that, or to the current region.
5133 ;; If another program has acquired the selection, region
5134 ;; deactivation should not clobber it (Bug#11772).
5153 "Activate the mark.
5154 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
5164 "Set this buffer's mark to POS. Don't use this function!
5165 That is to say, don't use this function unless you want
5166 the user to see that the mark has moved, and you want the previous
5167 mark position to be lost.
5169 Normally, when a new mark is set, the old one should go on the stack.
5170 This is why most applications should use `push-mark', not `set-mark'.
5172 Novice Emacs Lisp programmers often try to use the mark for the wrong
5173 purposes. The mark saves a location for the user's convenience.
5174 Most editing commands should not alter the mark.
5175 To remember a location for internal use in the Lisp program,
5176 store it in a Lisp variable. Example:
5178 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
5183 ;; Normally we never clear mark-active except in Transient Mark mode.
5184 ;; But when we actually clear out the mark value too, we must
5185 ;; clear mark-active in any mode.
5187 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
5188 ;; it should never be nil if the mark is nil.
5196 mark-active))
5203 ;; Mark marker
5209 ;; Mark active
5212 ;; If mark is active now, and either was not active or was at a
5213 ;; different place, run the activate hook.
5218 ;; If mark has ceased to be active, run deactivate hook.
5223 "Like `save-excursion', but also save and restore the mark state.
5224 This macro does what `save-excursion' did before Emacs 25.1."
5234 If nil, region-aware commands treat the empty region as inactive.
5235 If non-nil, region-aware commands treat the region as active as
5236 long as the mark is active, even if the region is empty.
5238 Region-aware commands are those that act on the region if it is
5239 active and Transient Mark mode is enabled, and on the text near
5240 point otherwise."
5246 "Return t if the region is active and it is appropriate to act on it.
5247 This is used by commands that act specially on the region under
5248 Transient Mark mode.
5250 The return value is t if Transient Mark mode is enabled and the
5251 mark is active; furthermore, if `use-empty-active-region' is nil,
5252 the region must not be empty. Otherwise, the return value is nil.
5254 For some commands, it may be appropriate to ignore the value of
5255 `use-empty-active-region'; in that case, use `region-active-p'."
5260 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5262 Some commands act specially on the region when Transient Mark
5263 mode is enabled. Usually, such commands should use
5264 `use-region-p' instead of this function, because `use-region-p'
5265 also checks the value of `use-empty-active-region'."
5267 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5268 ;; without the mark being set (e.g. bug#17324). We really should fix
5269 ;; that problem, but in the mean time, let's make sure we don't say the
5270 ;; region is active when there's no mark.
5274 "Return non-nil if the region contains several pieces.
5275 An example is a rectangular region handled as a list of
5276 separate contiguous regions for each line."
5289 ;; Normal priority so that a large region doesn't hide all the
5290 ;; overlays within it, but high secondary priority so that if it
5291 ;; ends/starts in the middle of a small overlay, that small overlay
5292 ;; won't hide the region's boundaries.
5294 nrol)
5299 rol)))
5315 start end window rol)))
5318 new))))))
5321 "Hook run just before redisplay.
5322 It is called in each window that is to be redisplayed. It takes one argument,
5323 which is the window that will be redisplayed. When run, the `current-buffer'
5344 "Maximum size of mark ring. Start discarding off end if gets this big."
5352 "Maximum size of global mark ring. \
5353 Start discarding off end if gets this big."
5358 "Jump to mark, and pop a new position for mark off the ring.
5359 \(Does not affect global mark ring)."
5369 "Set mark at where point is.
5370 If no prefix ARG and mark is already set there, just activate it.
5371 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5383 will pop the mark twice, and
5385 will pop the mark three times.
5393 "Set the mark where point is, or jump to the mark.
5394 Setting the mark also alters the region, which is the text
5395 between point and mark; this is the closest equivalent in
5398 With no prefix argument, set the mark at point, and push the
5399 old mark position on local mark ring. Also push the old mark on
5400 global mark ring, if the previous mark was set in another buffer.
5402 When Transient Mark Mode is off, immediately repeating this
5403 command activates `transient-mark-mode' temporarily.
5406 jump to the mark, and set the mark from
5407 position popped off the local mark ring (this does not affect the global
5409 mark ring (see `pop-global-mark').
5411 If `set-mark-command-repeat-pop' is non-nil, repeating
5413 off the local (or global) mark ring and jumps there.
5416 argument, unconditionally set mark where point is, even if
5417 `set-mark-command-repeat-pop' is non-nil.
5419 Novice Emacs Lisp programmers often try to use the mark for the wrong
5420 purposes. See the documentation of `set-mark' for more information."
5440 arg)
5454 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5455 If the last global mark pushed was not in the current buffer,
5456 also push LOCATION on the global mark ring.
5457 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5459 Novice Emacs Lisp programmers often try to use the mark for the wrong
5460 purposes. See the documentation of `set-mark' for more information.
5462 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5469 ;; Now push the mark on the global mark ring.
5472 ;; The last global mark pushed was in this same buffer.
5473 ;; Don't push another one.
5474 nil
5483 nil)
5486 "Pop off mark ring into the buffer's actual mark.
5487 Does not set point. Does nothing if mark ring is empty."
5499 "Put the mark where point is now, and point where the mark is now.
5500 This command works even when the mark is not active,
5501 and it reactivates the mark.
5503 If Transient Mark mode is on, a prefix ARG deactivates the mark
5504 if it is active, and otherwise avoids reactivating it. If
5505 Transient Mark mode is off, a prefix ARG enables Transient Mark
5506 mode temporarily."
5520 nil))
5523 "When non-nil, shifted motion keys activate the mark momentarily.
5525 While the mark is activated in this way, any shift-translated point
5526 motion key extends the region, and if Transient Mark mode was off, it
5527 is temporarily turned on. Furthermore, the mark will be deactivated
5528 by any subsequent point motion key that was not shift-translated, or
5529 by any action that normally deactivates the mark in Transient Mark mode.
5531 See `this-command-keys-shift-translated' for the meaning of
5532 shift-translation."
5537 "Activate/deactivate mark depending on invocation thru shift translation.
5538 This function is called by `call-interactively' when a command
5539 with a `^' character in its `interactive' spec is invoked, before
5540 running the command itself.
5542 If `shift-select-mode' is enabled and the command was invoked
5543 through shift translation, set the mark and activate the region
5544 temporarily, unless it was already set in this way. See
5545 `this-command-keys-shift-translated' for the meaning of shift
5546 translation.
5548 Otherwise, if the region has been activated temporarily,
5549 deactivate it, and restore the variable `transient-mark-mode' to
5550 its earlier value."
5557 transient-mark-mode)))
5566 "Toggle Transient Mark mode.
5567 With a prefix argument ARG, enable Transient Mark mode if ARG is
5568 positive, and disable it otherwise. If called from Lisp, enable
5569 Transient Mark mode if ARG is omitted or nil.
5571 Transient Mark mode is a global minor mode. When enabled, the
5572 region is highlighted with the `region' face whenever the mark
5574 and after certain other operations that set the mark but whose
5575 main purpose is something else--for example, incremental search,
5581 Many commands change their behavior when Transient Mark mode is
5582 in effect and the mark is active, by acting on the region instead
5583 of their usual default part of the buffer's text. Examples of
5586 To see the documentation of commands which are sensitive to the
5589 :global t
5590 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5594 "Non-nil means it is ok for commands to call `widen' when they want to.
5595 Some commands will do this in order to go to positions outside
5596 the current accessible part of the buffer.
5598 If `widen-automatically' is nil, these commands will do something else
5602 "Whether the currently executing code is performing an essential task.
5603 This variable should be non-nil only when running code which should not
5604 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5605 user for a password when we are simply scanning a set of files in the
5606 background or displaying possible completions before the user even asked
5610 "Pop off global mark ring and jump to the top location."
5612 ;; Pop entries which refer to non-existent buffers.
5630 \f
5632 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5638 "Move cursor vertically down ARG lines.
5639 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5640 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5641 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5642 function will not vscroll.
5644 ARG defaults to 1.
5646 If there is no character in the target line exactly under the current column,
5647 the cursor is positioned after the character in that line which spans this
5648 column, or at the end of the line if it is not long enough.
5649 If there is no line in the buffer after this one, behavior depends on the
5650 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5651 to create a line, and moves the cursor to that line. Otherwise it moves the
5652 cursor to the end of the buffer.
5654 If the variable `line-move-visual' is non-nil, this command moves
5655 by display lines. Otherwise, it moves by buffer lines, without
5656 taking variable-width characters or continued lines into account.
5659 a semipermanent goal column for this command.
5660 Then instead of trying to move exactly vertically (or as close as possible),
5661 this command moves to the specified goal column (or as close as possible).
5662 The goal column is stored in the variable `goal-column', which is nil
5663 when there is no goal column. Note that setting `goal-column'
5664 overrides `line-move-visual' and causes this command to move by buffer
5665 lines rather than by display lines."
5671 ;; When adding a newline, don't expand an abbrev.
5682 nil)
5685 "Move cursor vertically up ARG lines.
5686 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5687 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5688 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5689 function will not vscroll.
5691 ARG defaults to 1.
5693 If there is no character in the target line exactly over the current column,
5694 the cursor is positioned after the character in that line which spans this
5695 column, or at the end of the line if it is not long enough.
5697 If the variable `line-move-visual' is non-nil, this command moves
5698 by display lines. Otherwise, it moves by buffer lines, without
5699 taking variable-width characters or continued lines into account.
5702 a semipermanent goal column for this command.
5703 Then instead of trying to move exactly vertically (or as close as possible),
5704 this command moves to the specified goal column (or as close as possible).
5705 The goal column is stored in the variable `goal-column', which is nil
5706 when there is no goal column. Note that setting `goal-column'
5707 overrides `line-move-visual' and causes this command to move by buffer
5708 lines rather than by display lines."
5719 nil)
5722 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5723 This means moving to the end of each line moved onto.
5724 The beginning of a blank line does not count as the end of a line.
5725 This has no effect when the variable `line-move-visual' is non-nil."
5731 A non-nil setting overrides the variable `line-move-visual', which see."
5738 "Current goal column for vertical motion.
5739 It is the column where point was at the start of the current run
5740 of vertical motion commands.
5742 When moving by visual lines via the function `line-move-visual', it is a cons
5743 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5744 divided by the default column width, and HSCROLL is the number of
5745 columns by which window is scrolled from left margin.
5747 When the `track-eol' feature is doing its job, the value is
5751 "Non-nil means commands that move by lines ignore invisible newlines.
5752 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5753 as if newlines that are invisible didn't exist, and count
5754 only visible newlines. Thus, moving across across 2 newlines
5755 one of which is invisible will be counted as a one-line move.
5756 Also, a non-nil value causes invisible text to be ignored when
5757 counting columns for the purposes of keeping point in the same
5760 Outline mode sets this."
5765 "When non-nil, `line-move' moves point by visual lines.
5766 This movement is based on where the cursor is displayed on the
5767 screen, instead of relying on buffer contents alone. It takes
5768 into account variable-width characters and line continuation.
5769 If nil, `line-move' moves point by logical lines.
5770 A non-nil setting of `goal-column' overrides the value of this variable
5771 and forces movement by logical lines.
5772 A window that is horizontally scrolled also forces movement by logical
5773 lines."
5778 ;; Only used if display-graphic-p.
5782 "Return the height in pixels of the current buffer's default face font.
5784 If the default font is remapped (see `face-remapping-alist'), the
5785 function returns the height of the remapped face."
5789 ;; Avoid calling font-info if the frame's default font was
5790 ;; not changed since the frame was created. That's because
5791 ;; font-info is expensive for some fonts, see bug #14838.
5797 "Return the width in pixels of the current buffer's default face font.
5799 If the default font is remapped (see `face-remapping-alist'), the
5800 function returns the width of the remapped face."
5804 ;; Avoid calling font-info if the frame's default font was
5805 ;; not changed since the frame was created. That's because
5806 ;; font-info is expensive for some fonts, see bug #14838.
5811 width
5816 "Return the pixel height of current buffer's default-face text line.
5818 The value includes `line-spacing', if any, defined for the buffer
5819 or the frame."
5832 "Return the number of screen lines in the text area of the selected window.
5834 This is different from `window-text-height' in that this function counts
5835 lines in units of the height of the font used by the default face displayed
5836 in the window, not in units of the frame's default font, and also accounts
5837 for `line-spacing', if any, defined for the window's buffer or frame.
5839 The value is a floating-point number."
5844 ;; Returns non-nil if partial move was done.
5847 ;; Move backward (up).
5848 ;; If already vscrolled, reduce vscroll
5854 ;; Move forward (down).
5867 py vs last-line)
5887 col-row)
5892 ;; VPOS > 0 means the last line is only partially visible.
5893 ;; But if the part that is visible is at least as tall as the
5894 ;; default font, that means the line is actually fully
5895 ;; readable, and something like line-spacing is hidden. So in
5896 ;; that case we accept the last line in the window as still
5897 ;; visible, and consider the margin as starting one line
5898 ;; later.
5906 ;; If last line of window is fully visible, and vscrolling
5907 ;; more would make this line invisible, move forward.
5912 nil)
5913 ;; If cursor is not in the bottom scroll margin, and the
5914 ;; current line is is not too tall, move forward.
5916 vpos
5919 nil)
5920 ;; When already vscrolled, we vscroll some more if we can,
5921 ;; or clear vscroll and move forward at end of tall image.
5926 ;; If cursor just entered the bottom scroll margin, move forward,
5927 ;; but also optionally vscroll one line so redisplay won't recenter.
5931 ;; Don't vscroll if the partially-visible line at window
5932 ;; bottom is not too tall (a.k.a. "just one more text
5933 ;; line"): in that case, we do want redisplay to behave
5934 ;; normally, i.e. recenter or whatever.
5935 ;;
5936 ;; Note: ROWH + RBOT from the value returned by
5937 ;; pos-visible-in-window-p give the total height of the
5938 ;; partially-visible glyph row at the end of the window. As
5939 ;; we are dealing with floats, we disregard sub-pixel
5940 ;; discrepancies between that and DLH.
5944 t)
5945 ;; If there are lines above the last line, scroll-up one line.
5948 t)
5949 ;; Finally, start vscroll.
5954 ;; This is like line-move-1 except that it also performs
5955 ;; vertical scrolling of tall images if appropriate.
5956 ;; That is not really a clean thing to do, since it mixes
5957 ;; scrolling with cursor motion. But so far we don't have
5958 ;; a cleaner solution to the problem of making C-n do something
5959 ;; useful given a tall image.
5961 "Move forward ARG lines.
5962 If NOERROR, don't signal an error if we can't move ARG lines.
5963 TO-END is unused.
5964 TRY-VSCROLL controls whether to vscroll tall lines: if either
5965 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5966 not vscroll."
5970 ;; Only vscroll for single line moves
5972 ;; Under scroll-conservatively, the display engine
5973 ;; does this better.
5975 ;; But don't vscroll in a keyboard macro.
5981 ;; Display-based column are incompatible with goal-column.
5983 ;; When the text in the window is scrolled to the left,
5984 ;; display-based motion doesn't make sense (because each
5985 ;; logical line occupies exactly one screen line).
5987 ;; Likewise when the text _was_ scrolled to the left
5988 ;; when the current run of vertical motion commands
5989 ;; started.
5992 auto-hscroll-mode
5994 (>= temporary-goal-column
5997 ;; If we moved into a tall line, set vscroll to make
5998 ;; scrolling through tall images more smooth.
6002 winh)
6008 nil
6012 ;; Display-based alternative to line-move-1.
6013 ;; Arg says how many lines to move. The value is t if we can move the
6014 ;; specified number of lines.
6016 "Move ARG lines forward.
6017 If NOERROR, don't signal an error if we can't move that many lines."
6020 target-hscroll)
6021 ;; Check if the previous command was a line-motion command, or if
6022 ;; we were called from some other command.
6025 ;; If so, there's no need to reset `temporary-goal-column',
6026 ;; but we may need to hscroll.
6030 ;; Otherwise, we should reset `temporary-goal-column'.
6032 x-pos)
6034 ;; Handle the `overflow-newline-into-fringe' case:
6039 ;; In R2L lines, the X pixel coordinate is measured from the
6040 ;; left edge of the window, but columns are still counted
6041 ;; from the logical-order beginning of the line, i.e. from
6042 ;; the right edge in this case. We need to adjust for that.
6048 hscroll)))
6050 ;; When we move beyond the first/last character visible in
6051 ;; the window, posn-at-point will return nil, so we need to
6052 ;; approximate the goal column as below.
6057 ;; vertical-motion can move more than it was asked to if it moves
6058 ;; across display strings with newlines. We don't want to ring
6059 ;; the bell and announce beginning/end of buffer in that case.
6065 temporary-goal-column))
6066 arg))
6067 arg))
6073 temporary-goal-column))
6074 arg))
6075 arg)))
6078 ;; If the goal column lies on a display string,
6079 ;; `vertical-motion' advances the cursor to the end
6080 ;; of the string. For arg < 0, this can cause the
6081 ;; cursor to get stuck. (Bug#3020).
6085 nil)))))
6087 ;; This is the guts of next-line and previous-line.
6088 ;; Arg says how many lines to move.
6089 ;; The value is t if we can move the specified number of lines.
6091 ;; Don't run any point-motion hooks, and disregard intangibility,
6092 ;; for intermediate positions.
6104 ;; Don't count beg of empty line as end of line
6105 ;; unless we just did explicit end-of-line.
6107 most-positive-fixnum
6111 line-move-ignore-invisible))
6112 ;; Use just newline characters.
6113 ;; Set ARG to 0 if we move as many lines as requested.
6116 ;; This way of moving forward ARG lines
6117 ;; verifies that we have a newline after the last one.
6118 ;; It doesn't get confused by intangible text.
6127 'beginning-of-buffer
6129 nil)))
6130 ;; Move by arg lines, but ignore invisible ones.
6133 ;; If the following character is currently invisible,
6134 ;; skip all characters with that same `invisible' property value.
6137 ;; Move a line.
6138 ;; We don't use `end-of-line', since we want to escape
6139 ;; from field boundaries occurring exactly at point.
6145 ;; If there's no invisibility here, move over the newline.
6154 ;; We avoid vertical-motion when possible
6155 ;; because that has to fontify.
6157 ;; Otherwise move a more sophisticated way.
6164 ;; The logic of this is the same as the loop above,
6165 ;; it just goes in the other direction.
6167 ;; For completely consistency with the forward-motion
6168 ;; case, we should call beginning-of-line here.
6169 ;; However, if point is inside a field and on a
6170 ;; continued line, the call to (vertical-motion -1)
6171 ;; below won't move us back far enough; then we return
6172 ;; to the same column in line-move-finish, and point
6173 ;; gets stuck -- cyd
6191 ;; if our target is the middle of this line.
6196 ;; This is the value the function returns.
6200 ;; If we did not move down as far as desired, at least go
6201 ;; to end of line. Be sure to call point-entered and
6202 ;; point-left-hooks.
6208 ;; If we did not move up as far as desired,
6209 ;; at least go to beginning of line.
6221 ;; Set REPEAT to t to repeat the whole thing.
6228 ;; Compute the end of the line
6229 ;; ignoring effectively invisible newlines.
6231 ;; Like end-of-line but ignores fields.
6238 ;; Move to the desired column.
6241 ;; Corner case: suppose we start out in a field boundary in
6242 ;; the middle of a continued line. When we get to
6243 ;; line-move-finish, point is at the start of a new *screen*
6244 ;; line but the same text line; then line-move-to-column would
6245 ;; move us backwards. Test using C-n with point on the "x" in
6246 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6253 ;; Process intangibility within a line.
6254 ;; With inhibit-point-motion-hooks bound to nil, a call to
6255 ;; goto-char moves point past intangible text.
6257 ;; However, inhibit-point-motion-hooks controls both the
6258 ;; intangibility and the point-entered/point-left hooks. The
6259 ;; following hack avoids calling the point-* hooks
6260 ;; unnecessarily. Note that we move *forward* past intangible
6261 ;; text when the initial and final points are the same.
6266 ;; If intangibility moves us to a different (later) place
6267 ;; in the same line, use that as the destination.
6270 ;; If that position is "too late",
6271 ;; try the previous allowable position.
6272 ;; See if it is ok.
6275 ;; If going forward, don't accept the previous
6276 ;; allowable position if it is before the target line.
6278 ;; If going backward, don't accept the previous
6279 ;; allowable position if it is still after the target line.
6282 ;; As a last resort, use the end of the line.
6285 ;; Now move to the updated destination, processing fields
6286 ;; as well as intangibility.
6290 ;; Ignore field boundaries if the initial and final
6291 ;; positions have the same `field' property, even if the
6292 ;; fields are non-contiguous. This seems to be "nicer"
6293 ;; behavior in many situations.
6296 new
6300 ;; If all this moved us to a different line,
6301 ;; retry everything within that new line.
6303 ;; Repeat the intangibility and field processing.
6307 "Try to find column COL, considering invisibility.
6308 This function works only in certain cases,
6309 because what we really need is for `move-to-column'
6310 and `current-column' to be able to ignore invisible text."
6319 ;; If the following character is currently invisible,
6320 ;; skip all characters with that same `invisible' property value.
6324 ;; Have we advanced to a larger column position?
6326 ;; We have made some progress towards the desired column.
6327 ;; See if we can make any further progress.
6329 ;; Otherwise, go to the place we originally found
6330 ;; and move back over invisible text.
6331 ;; that will get us to the same place on the screen
6332 ;; but with a more reasonable buffer position.
6335 ;; We want the real line beginning, so it's consistent
6336 ;; with bolp below, otherwise we might infloop.
6343 "Move point to end of current line as displayed.
6344 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6345 If point reaches the beginning or end of buffer, it stops there.
6347 To ignore the effects of the `intangible' text or overlay
6348 property, bind `inhibit-point-motion-hooks' to t.
6349 If there is an image in the current line, this function
6350 disregards newlines that are part of the text on which the image
6351 rests."
6361 ;; With bidi reordering, we may not be at bol,
6362 ;; so make sure we are.
6377 ;; If we skipped something intangible and now we're not
6378 ;; really at eol, keep going.
6383 "Move point to beginning of current line as displayed.
6384 \(If there's an image in the line, this disregards newlines
6385 which are part of the text that the image rests on.)
6387 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6388 If point reaches the beginning or end of buffer, it stops there.
6389 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6394 first-vis first-vis-field-value)
6396 ;; Move by lines, if ARG is not 1 (the default).
6401 ;; Move to beginning-of-line, ignoring fields and invisible text.
6407 ;; Now find first visible char in the line.
6412 ;; See if fields would stop us from reaching FIRST-VIS.
6417 ;; If yes, obey them.
6418 first-vis-field-value
6419 ;; Otherwise, move to START with attention to fields.
6420 ;; (It is possible that fields never matter in this case.)
6425 ;; Many people have said they rarely use this feature, and often type
6426 ;; it by accident. Maybe it shouldn't even be on a key.
6431 Those commands will move to this position in the line moved to
6432 rather than trying to keep the same horizontal position.
6433 With a non-nil argument ARG, clears out the goal column
6435 The goal column is stored in the variable `goal-column'.
6436 This is a buffer-local setting."
6443 ;; The older method below can be erroneous if `set-goal-column' is bound
6444 ;; to a sequence containing %
6445 ;;(message (substitute-command-keys
6446 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6447 ;;goal-column)
6454 )
6455 nil)
6456 \f
6457 ;;; Editing based on visual lines, as opposed to logical lines.
6460 "Move point to end of current visual line.
6461 With argument N not nil or 1, move forward N - 1 visual lines first.
6462 If point reaches the beginning or end of buffer, it stops there.
6463 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6469 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6470 ;; constrain to field boundaries, so we don't either.
6474 "Move point to beginning of current visual line.
6475 With argument N not nil or 1, move forward N - 1 visual lines first.
6476 If point reaches the beginning or end of buffer, it stops there.
6477 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6485 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6489 "Kill the rest of the visual line.
6490 With prefix argument ARG, kill that many visual lines from point.
6491 If ARG is negative, kill visual lines backward.
6492 If ARG is zero, kill the text before point on the current visual
6493 line.
6495 If you want to append the killed line to the last killed text,
6498 If the buffer is read-only, Emacs will beep and refrain from deleting
6499 the line, but put the line in the kill ring anyway. This means that
6500 you can use this command to copy text from a read-only buffer.
6501 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6502 even beep.)"
6504 ;; Like in `kill-line', it's better to move point to the other end
6505 ;; of the kill before killing.
6513 ;; Skip any trailing whitespace at the end of the visual line.
6514 ;; We used to do this only if `show-trailing-whitespace' is
6515 ;; nil, but that's wrong; the correct thing would be to check
6516 ;; whether the trailing whitespace is highlighted. But, it's
6517 ;; OK to just do this unconditionally.
6524 "Move cursor vertically down ARG lines.
6525 This is identical to `next-line', except that it always moves
6526 by logical lines instead of visual lines, ignoring the value of
6527 the variable `line-move-visual'."
6534 "Move cursor vertically up ARG lines.
6535 This is identical to `previous-line', except that it always moves
6536 by logical lines instead of visual lines, ignoring the value of
6537 the variable `line-move-visual'."
6544 "Editing based on visual lines."
6553 ;; These keybindings interfere with xterm function keys. Are
6554 ;; there any other suitable bindings?
6555 ;; (define-key map "\M-[" 'previous-logical-line)
6556 ;; (define-key map "\M-]" 'next-logical-line)
6557 map))
6560 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6561 The value should be a list of the form (LEFT RIGHT), where LEFT
6562 and RIGHT are symbols representing the bitmaps to display, to
6563 indicate wrapped lines, in the left and right fringes respectively.
6564 See also `fringe-indicator-alist'.
6565 The default is not to display fringe indicators for wrapped lines.
6566 This variable does not affect fringe indicators displayed for
6567 other purposes."
6582 'continuation
6589 "Toggle visual line based editing (Visual Line mode).
6590 With a prefix argument ARG, enable Visual Line mode if ARG is
6591 positive, and disable it otherwise. If called from Lisp, enable
6592 the mode if ARG is omitted or nil.
6594 When Visual Line mode is enabled, `word-wrap' is turned on in
6595 this buffer, and simple editing commands are redefined to act on
6596 visual lines, not logical lines. See Info node `Visual Line
6597 Mode' for details."
6598 :keymap visual-line-mode-map
6604 ;; Save the local values of some variables, to be restored if
6605 ;; visual-line-mode is turned off.
6607 truncate-partial-width-windows
6608 word-wrap fringe-indicator-alist))
6611 visual-line--saved-state)))
6615 word-wrap t
6616 fringe-indicator-alist
6618 fringe-indicator-alist)))
6632 visual-line-mode turn-on-visual-line-mode)
6634 \f
6636 "Interchange characters around point, moving forward one character.
6637 With prefix arg ARG, effect is to take character before point
6638 and drag it forward past ARG other characters (backward if ARG negative).
6639 If no argument and at end of line, the previous two chars are exchanged."
6647 "Interchange words around point, leaving point at end of them.
6648 With prefix arg ARG, effect is to take word before or around point
6649 and drag it forward past ARG other words (backward if ARG negative).
6650 If ARG is zero, the words around or after point and around or after mark
6651 are interchanged."
6652 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6658 Does not work on a sexp that point is in the middle of
6659 if it is a list or string."
6663 ;; Here we should try to simulate the behavior of
6664 ;; (cons (progn (forward-sexp x) (point))
6665 ;; (progn (forward-sexp (- x)) (point)))
6666 ;; Except that we don't want to rely on the second forward-sexp
6667 ;; putting us back to where we want to be, since forward-sexp-function
6668 ;; might do funny things like infix-precedence.
6673 ;; Jumping over a symbol. We might be inside it, mind you.
6678 ;; Otherwise, we're between sexps. Take a step back before jumping
6679 ;; to make sure we'll obey the same precedence no matter which direction
6680 ;; we're going.
6685 'skip-syntax-forward
6692 "Exchange current line and previous line, leaving point after both.
6693 With argument ARG, takes previous line and moves it past ARG lines.
6694 With argument 0, interchanges line point is in with line mark is in."
6700 ;; Move forward over ARG lines,
6701 ;; but create newlines if necessary.
6708 arg))
6710 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6711 ;; which seems inconsistent with the ARG /= 0 case.
6712 ;; FIXME document SPECIAL.
6714 "Subroutine to do the work of transposing objects.
6715 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6716 moves forward by units of the given object (e.g. forward-sentence,
6717 forward-paragraph). If ARG is zero, exchanges the current object
6718 with the one containing mark. If ARG is an integer, moves the
6719 current object past ARG following (if ARG is positive) or
6720 preceding (if ARG is negative) objects, leaving point after the
6721 current object."
6726 pos1 pos2)
6755 ;; This sequence of insertions attempts to preserve marker
6756 ;; positions at the start and end of the transposed objects.
6770 \f
6772 "Move backward until encountering the beginning of a word.
6773 With argument ARG, do this that many times.
6774 If ARG is omitted or nil, move point backward one word.
6776 The word boundaries are normally determined by the buffer's syntax
6777 table, but `find-word-boundary-function-table', such as set up
6778 by `subword-mode', can change that. If a Lisp program needs to
6779 move by words determined strictly by the syntax table, it should
6780 use `backward-word-strictly' instead."
6785 "Set mark ARG words away from point.
6787 move to with the same argument.
6788 Interactively, if this command is repeated
6789 or (in Transient Mark mode) if the mark is active,
6790 it marks the next ARG words after the ones already marked."
6807 nil t))))
6810 "Kill characters forward until encountering the end of a word.
6811 With argument ARG, do this that many times."
6816 "Kill characters backward until encountering the beginning of a word.
6817 With argument ARG, do this that many times."
6822 "Return the symbol or word that point is on (or a nearby one) as a string.
6823 The return value includes no text properties.
6824 If optional arg STRICT is non-nil, return nil unless point is within
6825 or adjacent to a symbol or word. In all cases the value can be nil
6826 if there is no word nearby.
6827 The function, belying its name, normally finds a symbol.
6828 If optional arg REALLY-WORD is non-nil, it finds just a word."
6837 ;; Point is neither within nor adjacent to a word.
6839 ;; Look for preceding word in same line.
6842 ;; No preceding word in same line.
6843 ;; Look for following word in same line.
6852 ;; If we found something nonempty, return it as a string.
6855 \f
6857 "String for filling to insert at front of new line, or nil for none."
6859 string)
6865 "Regexp to match lines which should not be auto-filled."
6867 regexp)
6871 "The default value for `normal-auto-fill-function'.
6872 This is the default auto-fill function, some major modes use a different one.
6873 Returns t if it really did any work."
6883 nil ;; Auto-filling not required
6887 ;; Choose a fill-prefix automatically.
6895 ;; Use auto-indentation rather than a guessed empty prefix.
6901 ;; Determine where to split the line.
6914 ;; See whether the place we found is any good.
6918 ;; There is no use breaking at end of line.
6920 ;; It is futile to split at the end of the prefix
6921 ;; since we would just insert the prefix again.
6923 ;; Don't split right after a comment starter
6924 ;; since we would just make another comment starter.
6929 limit t)
6931 ;; No good place to break => stop trying.
6933 ;; Ok, we have a useful place to break the line. Do it.
6935 ;; If point is at the fill-point, do not `save-excursion'.
6936 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6937 ;; point will end up before it rather than after it.
6945 ;; Now do justification, if required
6950 ;; If making the new line didn't reduce the hpos of
6951 ;; the end of the line, then give up now;
6952 ;; trying again will not help.
6955 ;; Justify last line.
6957 t)))
6960 "Mode-specific function which line breaks and continues a comment.
6961 This function is called during auto-filling when a comment syntax
6962 is defined.
6963 The function should take a single optional argument, which is a flag
6967 "Break line at point and indent.
6968 If a comment syntax is defined, call `comment-indent-new-line'.
6970 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6971 unless optional argument SOFT is non-nil."
6975 ;; Insert the newline before removing empty space so that markers
6976 ;; get preserved better.
6982 ;; Blindly trust a non-adaptive fill-prefix.
6988 ;; If there's an adaptive prefix, use it unless we're inside
6989 ;; a comment and the prefix is not a comment starter.
6993 ;; If we're not inside a comment, just try to indent.
6997 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
7001 ;; `functions' and `hooks' are usually unsafe to set, but setting
7002 ;; auto-fill-function to nil in a file-local setting is safe and
7003 ;; can be useful to prevent auto-filling.
7007 "Toggle automatic line breaking (Auto Fill mode).
7008 With a prefix argument ARG, enable Auto Fill mode if ARG is
7009 positive, and disable it otherwise. If called from Lisp, enable
7010 the mode if ARG is omitted or nil.
7012 When Auto Fill mode is enabled, inserting a space at a column
7013 beyond `current-fill-column' automatically breaks the line at a
7014 previous space.
7016 When `auto-fill-mode' is on, the `auto-fill-function' variable is
7017 non-nil.
7019 The value of `normal-auto-fill-function' specifies the function to use
7020 for `auto-fill-function' when turning Auto Fill mode on."
7025 ;; This holds a document string used to document auto-fill-mode.
7027 "Automatically break line at a previous space, in insertion of text."
7028 nil)
7031 "Unconditionally turn on Auto Fill mode."
7035 "Unconditionally turn off Auto Fill mode."
7041 "Set `fill-column' to specified argument.
7046 ;; We used to use current-column silently, but C-x f is too easily
7047 ;; typed as a typo for C-x C-f, so we turned it into an error and
7048 ;; now an interactive prompt.
7053 ;; Disallow missing argument; it's probably a typo for C-x C-f.
7057 \f
7059 "Set `selective-display' to ARG; clear it if no arg.
7060 When the value of `selective-display' is a number > 0,
7061 lines whose indentation is >= that value are not displayed.
7062 The variable `selective-display' has a separate value for each buffer."
7082 "Toggle truncating of long lines for the current buffer.
7083 When truncating is off, long lines are folded.
7084 With prefix argument ARG, truncate long lines if ARG is positive,
7085 otherwise fold them. Note that in side-by-side windows, this
7086 command has no effect if `truncate-partial-width-windows' is
7087 non-nil."
7099 nil t)))
7104 "Toggle whether to use word-wrapping for continuation lines.
7105 With prefix argument ARG, wrap continuation lines at word boundaries
7106 if ARG is positive, otherwise wrap them at the right screen edge.
7107 This command toggles the value of `word-wrap'. It has no effect
7108 if long lines are truncated."
7124 "Toggle Overwrite mode.
7125 With a prefix argument ARG, enable Overwrite mode if ARG is
7126 positive, and disable it otherwise. If called from Lisp, enable
7127 the mode if ARG is omitted or nil.
7129 When Overwrite mode is enabled, printing characters typed in
7130 replace existing text on a one-for-one basis, rather than pushing
7131 it to the right. At the end of a line, such characters extend
7132 the line. Before a tab, such characters insert until the tab is
7134 overwrite mode; this is supposed to make it easier to insert
7135 characters when necessary."
7140 "Toggle Binary Overwrite mode.
7141 With a prefix argument ARG, enable Binary Overwrite mode if ARG
7142 is positive, and disable it otherwise. If called from Lisp,
7143 enable the mode if ARG is omitted or nil.
7145 When Binary Overwrite mode is enabled, printing characters typed
7146 in replace existing text. Newlines are not treated specially, so
7147 typing at the end of a line joins the line to the next, with the
7148 typed character between them. Typing before a tab character
7149 simply replaces the tab with the character typed.
7151 ordinary typing characters do.
7153 Note that Binary Overwrite mode is not its own minor mode; it is
7154 a specialization of overwrite mode, entered by setting the
7155 `overwrite-mode' variable to `overwrite-mode-binary'."
7160 "Toggle line number display in the mode line (Line Number mode).
7161 With a prefix argument ARG, enable Line Number mode if ARG is
7162 positive, and disable it otherwise. If called from Lisp, enable
7163 the mode if ARG is omitted or nil.
7165 Line numbers do not appear for very large buffers and buffers
7166 with very long lines; see variables `line-number-display-limit'
7167 and `line-number-display-limit-width'."
7171 "Toggle column number display in the mode line (Column Number mode).
7172 With a prefix argument ARG, enable Column Number mode if ARG is
7173 positive, and disable it otherwise.
7175 If called from Lisp, enable the mode if ARG is omitted or nil."
7179 "Toggle buffer size display in the mode line (Size Indication mode).
7180 With a prefix argument ARG, enable Size Indication mode if ARG is
7181 positive, and disable it otherwise.
7183 If called from Lisp, enable the mode if ARG is omitted or nil."
7187 "Toggle auto-saving in the current buffer (Auto Save mode).
7188 With a prefix argument ARG, enable Auto Save mode if ARG is
7189 positive, and disable it otherwise.
7191 If called from Lisp, enable the mode if ARG is omitted or nil."
7193 ;; If auto-save is off because buffer has shrunk,
7194 ;; then toggling should turn it on.
7202 buffer-file-name)
7204 ;; If -1 was stored here, to temporarily turn off saving,
7205 ;; turn it back on.
7208 \f
7210 "Blinking matching of parens and expressions."
7215 "Non-nil means show matching open-paren when close-paren is inserted.
7216 If t, highlight the paren. If `jump', briefly move cursor to its
7217 position. If `jump-offscreen', move cursor there even if the
7218 position is off screen. With any other non-nil value, the
7219 off-screen position of the opening paren will be shown in the
7220 echo area."
7229 "Non-nil means show matching open-paren when it is on screen.
7230 If nil, don't show it (but the open-paren can still be shown
7231 in the echo area when it is off screen).
7233 This variable has no effect if `blink-matching-paren' is nil.
7234 \(In that case, the open-paren is never shown.)
7235 It is also ignored if `show-paren-mode' is enabled."
7240 "If non-nil, maximum distance to search backwards for matching open-paren.
7241 If nil, search stops at the beginning of the accessible portion of the buffer."
7247 "Time in seconds to delay after showing a matching paren."
7252 "If nil, `blink-matching-paren' ignores comments.
7253 More precisely, when looking for the matching parenthesis,
7254 it skips the contents of comments that end before point."
7259 "Return whether or not START...END are matching parens.
7260 END is the current point and START is the blink position.
7261 START might be nil if no matching starter was found.
7262 Returns non-nil if we find there is a mismatch."
7267 ;; For self-matched chars like " and $, we can't know when they're
7268 ;; mismatched or unmatched, so we can only do it for parens.
7273 ;; The cdr might hold a new paren-class info rather than
7274 ;; a matching-char info, in which case the two CDRs
7275 ;; should match.
7279 "Function to check parentheses mismatches.
7280 The function takes two arguments (START and END) where START is the
7281 position just before the opening token and END is the position right after.
7282 START can be nil, if it was not found.
7289 ol)
7293 "Momentarily highlight the beginning of the sexp before point."
7296 blink-matching-paren)
7306 oldpos))
7314 ;; backward-sexp skips backward over prefix chars,
7315 ;; so move back to the matching paren.
7338 ;; Matching open within window, temporarily move to or highlight
7339 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7340 ;; is non-nil.
7357 ;; Show what precedes the open in its line, if anything.
7362 ;; Show what follows the open in its line, if anything.
7369 ;; Otherwise show the previous nonblank line,
7370 ;; if there is one.
7379 ;; Replace the newline and other whitespace with `...'.
7380 "..."
7382 ;; There is nothing to show except the char itself.
7385 "Matches %s"
7389 "Function called, if non-nil, whenever a close parenthesis is inserted.
7395 blink-paren-function
7398 ;; Verify an even number of quoting characters precede the close.
7399 ;; FIXME: Also check if this parenthesis closes a comment as
7400 ;; can happen in Pascal and SML.
7411 ;; Most likely, this hook is nil, so this arg doesn't matter,
7412 ;; but I use it as a reminder that this function usually
7413 ;; likes to be run after others since it does
7414 ;; `sit-for'. That's also the reason it get a `priority' prop
7415 ;; of 100.
7417 \f
7418 ;; This executes C-g typed while Emacs is waiting for a command.
7419 ;; Quitting out of a program does not go through here;
7420 ;; that happens in the QUIT macro at the C code level.
7422 "Signal a `quit' condition.
7423 During execution of Lisp code, this character causes a quit directly.
7424 At top-level, as an editor command, this simply beeps."
7426 ;; Avoid adding the region to the window selection.
7434 ;; Force the next redisplay cycle to remove the "Def" indicator from
7435 ;; all the mode lines.
7449 This command can exit an interactive command such as `query-replace',
7450 can clear out a prefix argument or a region,
7451 can get out of the minibuffer or other recursive edit,
7452 cancel the use of the current buffer (for special-purpose buffers),
7453 or go back to just one window (by deleting all but the selected window)."
7461 nil)
7472 "Play sound stored in FILE.
7473 VOLUME and DEVICE correspond to the keywords of the sound
7474 specification for `play-sound'."
7484 \f
7486 "Your preference for a mail reading package.
7487 This is used by some keybindings which support reading mail.
7488 See also `mail-user-agent' concerning sending mail."
7498 "Your preference for a mail composition package.
7499 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7500 outgoing email message. This variable lets you specify which
7501 mail-sending package you prefer.
7503 Valid values include:
7505 `message-user-agent' -- use the Message package.
7506 See Info node `(message)'.
7507 `sendmail-user-agent' -- use the Mail package.
7508 See Info node `(emacs)Sending Mail'.
7509 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7510 See Info node `(mh-e)'.
7511 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7512 paraphernalia if Gnus is running, particularly
7513 the Gcc: header for archiving.
7515 Additional valid symbols may be available; check with the author of
7516 your package for details. The function should return non-nil if it
7517 succeeds.
7519 See also `read-mail-command' concerning reading mail."
7522 message-user-agent)
7525 sendmail-user-agent)
7528 mh-e-user-agent)
7531 gnus-user-agent)
7537 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7538 If the value of `mail-user-agent' is the default, and the user
7539 appears to have customizations applying to the old default,
7540 `compose-mail' issues a warning."
7546 "If the buffer starts with a mail header, move point to the header's end.
7547 Otherwise, moves to `point-min'.
7548 The end of the header is the start of the next line, if there is one,
7549 else the end of the last line. This function obeys RFC822."
7555 ;; Used by Rmail (e.g., rmail-forward).
7557 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7561 switch-function yank-action send-actions
7562 return-action)
7563 "Start composing a mail message to send.
7564 This uses the user's chosen mail composition package
7565 as selected with the variable `mail-user-agent'.
7566 The optional arguments TO and SUBJECT specify recipients
7567 and the initial Subject field, respectively.
7569 OTHER-HEADERS is an alist specifying additional
7570 header fields. Elements look like (HEADER . VALUE) where both
7571 HEADER and VALUE are strings.
7573 CONTINUE, if non-nil, says to continue editing a message already
7574 being composed. Interactively, CONTINUE is the prefix argument.
7576 SWITCH-FUNCTION, if non-nil, is a function to use to
7577 switch to and display the buffer used for mail composition.
7579 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7580 to insert the raw text of the message being replied to.
7581 It has the form (FUNCTION . ARGS). The user agent will apply
7582 FUNCTION to ARGS, to insert the raw text of the original message.
7583 \(The user agent will also run `mail-citation-hook', *after* the
7584 original text has been inserted in this way.)
7586 SEND-ACTIONS is a list of actions to call when the message is sent.
7587 Each action has the form (FUNCTION . ARGS).
7589 RETURN-ACTION, if non-nil, is an action for returning to the
7590 caller. It has the form (FUNCTION . ARGS). The function is
7591 called after the mail has been sent or put aside, and the mail
7592 buffer buried."
7596 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7597 ;; from sendmail-user-agent to message-user-agent. Some users may
7598 ;; encounter incompatibilities. This hack tries to detect problems
7599 ;; and warn about them.
7604 mail-yank-hooks mail-archive-file-name
7605 mail-default-reply-to mail-mailing-lists
7606 mail-self-blind))
7613 The default mail mode is now Message mode.
7614 You have the following Mail mode variable%s customized:
7616 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7623 yank-action send-actions return-action)))
7626 yank-action send-actions
7627 return-action)
7631 'switch-to-buffer-other-window yank-action send-actions
7632 return-action))
7635 yank-action send-actions
7636 return-action)
7640 'switch-to-buffer-other-frame yank-action send-actions
7641 return-action))
7643 \f
7645 "History of values entered with `set-variable'.
7647 Maximum length of the history list is determined by the value
7651 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7652 VARIABLE should be a user option variable name, a Lisp variable
7653 meant to be customized by users. You should enter VALUE in Lisp syntax,
7654 so if you want VALUE to be a string, you must surround it with doublequotes.
7655 VALUE is used literally, not evaluated.
7657 If VARIABLE has a `variable-interactive' property, that is used as if
7658 it were the arg to `interactive' (which see) to interactively read VALUE.
7660 If VARIABLE has been defined with `defcustom', then the type information
7661 in the definition is used to check that VALUE is valid.
7663 Note that this function is at heart equivalent to the basic `set' function.
7664 For a variable defined with `defcustom', it does not pay attention to
7665 any :set property that the variable might have (if you want that, use
7668 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7673 default-var)
7689 var obsolete)
7692 ;; Use VAR's `variable-interactive' property
7693 ;; as an interactive spec for prompting.
7696 arg))
7698 read-expression-map t
7699 'set-variable-value-history
7708 ;; Match with custom type.
7720 ;; Force a thorough redisplay for the case that the variable
7721 ;; has an effect on the display, like `tab-width' has.
7723 \f
7724 ;; Define the major mode for lists of completions.
7734 (define-key map [right] 'next-completion)
7736 (define-key map [backtab] 'previous-completion)
7737 (define-key map "q" 'quit-window)
7738 (define-key map "z" 'kill-this-buffer)
7739 map)
7740 "Local map for completion list buffers.")
7742 ;; Completion mode is suitable only for specially formatted data.
7743 (put 'completion-list-mode 'mode-class 'special)
7745 (defvar completion-reference-buffer nil
7746 "Record the buffer that was current when the completion list was requested.
7747 This is a local variable in the completion list buffer.
7748 Initial value is nil to avoid some compiler warnings.")
7750 (defvar completion-no-auto-exit nil
7751 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7752 This also applies to other functions such as `choose-completion'.")
7754 (defvar completion-base-position nil
7755 "Position of the base of the text corresponding to the shown completions.
7756 This variable is used in the *Completions* buffers.
7757 Its value is a list of the form (START END) where START is the place
7758 where the completion should be inserted and END (if non-nil) is the end
7759 of the text to replace. If END is nil, point is used instead.")
7761 (defvar completion-list-insert-choice-function #'completion--replace
7762 "Function to use to insert the text chosen in *Completions*.
7763 Called with three arguments (BEG END TEXT), it should replace the text
7764 between BEG and END with TEXT. Expected to be set buffer-locally
7765 in the *Completions* buffer.")
7767 (defvar completion-base-size nil
7768 "Number of chars before point not involved in completion.
7769 This is a local variable in the completion list buffer.
7770 It refers to the chars in the minibuffer if completing in the
7771 minibuffer, or in `completion-reference-buffer' otherwise.
7772 Only characters in the field at point are included.
7774 If nil, Emacs determines which part of the tail end of the
7775 buffer's text is involved in completion by comparing the text
7776 directly.")
7777 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7779 (defun delete-completion-window ()
7780 "Delete the completion list window.
7781 Go to the window from which completion was requested."
7782 (interactive)
7783 (let ((buf completion-reference-buffer))
7784 (if (one-window-p t)
7785 (if (window-dedicated-p) (delete-frame))
7786 (delete-window (selected-window))
7787 (if (get-buffer-window buf)
7788 (select-window (get-buffer-window buf))))))
7790 (defun previous-completion (n)
7791 "Move to the previous item in the completion list."
7792 (interactive "p")
7793 (next-completion (- n)))
7795 (defun next-completion (n)
7796 "Move to the next item in the completion list.
7797 With prefix argument N, move N items (negative N means move backward)."
7798 (interactive "p")
7799 (let ((beg (point-min)) (end (point-max)))
7800 (while (and (> n 0) (not (eobp)))
7801 ;; If in a completion, move to the end of it.
7802 (when (get-text-property (point) 'mouse-face)
7803 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7804 ;; Move to start of next one.
7805 (unless (get-text-property (point) 'mouse-face)
7806 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7807 (setq n (1- n)))
7808 (while (and (< n 0) (not (bobp)))
7809 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7810 ;; If in a completion, move to the start of it.
7811 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7812 (goto-char (previous-single-property-change
7813 (point) 'mouse-face nil beg)))
7814 ;; Move to end of the previous completion.
7815 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7816 (goto-char (previous-single-property-change
7817 (point) 'mouse-face nil beg)))
7818 ;; Move to the start of that one.
7819 (goto-char (previous-single-property-change
7820 (point) 'mouse-face nil beg))
7821 (setq n (1+ n))))))
7823 (defun choose-completion (&optional event)
7824 "Choose the completion at point.
7825 If EVENT, use EVENT's position to determine the starting position."
7826 (interactive (list last-nonmenu-event))
7827 ;; In case this is run via the mouse, give temporary modes such as
7828 ;; isearch a chance to turn off.
7829 (run-hooks 'mouse-leave-buffer-hook)
7830 (with-current-buffer (window-buffer (posn-window (event-start event)))
7831 (let ((buffer completion-reference-buffer)
7832 (base-size completion-base-size)
7833 (base-position completion-base-position)
7834 (insert-function completion-list-insert-choice-function)
7835 (choice
7836 (save-excursion
7837 (goto-char (posn-point (event-start event)))
7838 (let (beg end)
7839 (cond
7840 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7841 (setq end (point) beg (1+ (point))))
7842 ((and (not (bobp))
7843 (get-text-property (1- (point)) 'mouse-face))
7844 (setq end (1- (point)) beg (point)))
7845 (t (error "No completion here")))
7846 (setq beg (previous-single-property-change beg 'mouse-face))
7847 (setq end (or (next-single-property-change end 'mouse-face)
7848 (point-max)))
7849 (buffer-substring-no-properties beg end)))))
7851 (unless (buffer-live-p buffer)
7852 (error "Destination buffer is dead"))
7853 (quit-window nil (posn-window (event-start event)))
7855 (with-current-buffer buffer
7856 (choose-completion-string
7857 choice buffer
7858 (or base-position
7859 (when base-size
7860 ;; Someone's using old completion code that doesn't know
7861 ;; about base-position yet.
7862 (list (+ base-size (field-beginning))))
7863 ;; If all else fails, just guess.
7864 (list (choose-completion-guess-base-position choice)))
7865 insert-function)))))
7867 ;; Delete the longest partial match for STRING
7868 ;; that can be found before POINT.
7869 (defun choose-completion-guess-base-position (string)
7870 (save-excursion
7871 (let ((opoint (point))
7872 len)
7873 ;; Try moving back by the length of the string.
7874 (goto-char (max (- (point) (length string))
7875 (minibuffer-prompt-end)))
7876 ;; See how far back we were actually able to move. That is the
7877 ;; upper bound on how much we can match and delete.
7878 (setq len (- opoint (point)))
7879 (if completion-ignore-case
7880 (setq string (downcase string)))
7881 (while (and (> len 0)
7882 (let ((tail (buffer-substring (point) opoint)))
7883 (if completion-ignore-case
7884 (setq tail (downcase tail)))
7885 (not (string= tail (substring string 0 len)))))
7886 (setq len (1- len))
7887 (forward-char 1))
7888 (point))))
7890 (defun choose-completion-delete-max-match (string)
7891 (declare (obsolete choose-completion-guess-base-position "23.2"))
7892 (delete-region (choose-completion-guess-base-position string) (point)))
7894 (defvar choose-completion-string-functions nil
7895 "Functions that may override the normal insertion of a completion choice.
7896 These functions are called in order with three arguments:
7897 CHOICE - the string to insert in the buffer,
7898 BUFFER - the buffer in which the choice should be inserted,
7899 BASE-POSITION - where to insert the completion.
7901 If a function in the list returns non-nil, that function is supposed
7902 to have inserted the CHOICE in the BUFFER, and possibly exited
7903 the minibuffer; no further functions will be called.
7905 If all functions in the list return nil, that means to use
7906 the default method of inserting the completion in BUFFER.")
7908 (defun choose-completion-string (choice &optional
7909 buffer base-position insert-function)
7910 "Switch to BUFFER and insert the completion choice CHOICE.
7911 BASE-POSITION says where to insert the completion.
7912 INSERT-FUNCTION says how to insert the completion and falls
7913 back on `completion-list-insert-choice-function' when nil."
7915 ;; If BUFFER is the minibuffer, exit the minibuffer
7916 ;; unless it is reading a file name and CHOICE is a directory,
7917 ;; or completion-no-auto-exit is non-nil.
7919 ;; Some older code may call us passing `base-size' instead of
7920 ;; `base-position'. It's difficult to make any use of `base-size',
7921 ;; so we just ignore it.
7922 (unless (consp base-position)
7923 (message "Obsolete `base-size' passed to choose-completion-string")
7924 (setq base-position nil))
7926 (let* ((buffer (or buffer completion-reference-buffer))
7927 (mini-p (minibufferp buffer)))
7928 ;; If BUFFER is a minibuffer, barf unless it's the currently
7929 ;; active minibuffer.
7930 (if (and mini-p
7931 (not (and (active-minibuffer-window)
7932 (equal buffer
7933 (window-buffer (active-minibuffer-window))))))
7934 (error "Minibuffer is not active for completion")
7935 ;; Set buffer so buffer-local choose-completion-string-functions works.
7936 (set-buffer buffer)
7937 (unless (run-hook-with-args-until-success
7938 'choose-completion-string-functions
7939 ;; The fourth arg used to be `mini-p' but was useless
7940 ;; (since minibufferp can be used on the `buffer' arg)
7941 ;; and indeed unused. The last used to be `base-size', so we
7942 ;; keep it to try and avoid breaking old code.
7943 choice buffer base-position nil)
7944 ;; This remove-text-properties should be unnecessary since `choice'
7945 ;; comes from buffer-substring-no-properties.
7946 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7947 ;; Insert the completion into the buffer where it was requested.
7948 (funcall (or insert-function completion-list-insert-choice-function)
7949 (or (car base-position) (point))
7950 (or (cadr base-position) (point))
7951 choice)
7952 ;; Update point in the window that BUFFER is showing in.
7953 (let ((window (get-buffer-window buffer t)))
7954 (set-window-point window (point)))
7955 ;; If completing for the minibuffer, exit it with this choice.
7956 (and (not completion-no-auto-exit)
7957 (minibufferp buffer)
7958 minibuffer-completion-table
7959 ;; If this is reading a file name, and the file name chosen
7960 ;; is a directory, don't exit the minibuffer.
7961 (let* ((result (buffer-substring (field-beginning) (point)))
7962 (bounds
7963 (completion-boundaries result minibuffer-completion-table
7964 minibuffer-completion-predicate
7965 "")))
7966 (if (eq (car bounds) (length result))
7967 ;; The completion chosen leads to a new set of completions
7968 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7969 (let ((mini (active-minibuffer-window)))
7970 (select-window mini)
7971 (when minibuffer-auto-raise
7972 (raise-frame (window-frame mini))))
7973 (exit-minibuffer))))))))
7975 (define-derived-mode completion-list-mode nil "Completion List"
7976 "Major mode for buffers showing lists of possible completions.
7978 to select the completion near point.
7979 Or click to select one with the mouse.
7982 (set (make-local-variable 'completion-base-size) nil))
7984 (defun completion-list-mode-finish ()
7985 "Finish setup of the completions buffer.
7986 Called from `temp-buffer-show-hook'."
7987 (when (eq major-mode 'completion-list-mode)
7988 (setq buffer-read-only t)))
7990 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7993 ;; Variables and faces used in `completion-setup-function'.
7995 (defcustom completion-show-help t
7996 "Non-nil means show help message in *Completions* buffer."
7997 :type 'boolean
7998 :version "22.1"
7999 :group 'completion)
8001 ;; This function goes in completion-setup-hook, so that it is called
8002 ;; after the text of the completion list buffer is written.
8003 (defun completion-setup-function ()
8004 (let* ((mainbuf (current-buffer))
8005 (base-dir
8006 ;; FIXME: This is a bad hack. We try to set the default-directory
8007 ;; in the *Completions* buffer so that the relative file names
8008 ;; displayed there can be treated as valid file names, independently
8009 ;; from the completion context. But this suffers from many problems:
8010 ;; - It's not clear when the completions are file names. With some
8011 ;; completion tables (e.g. bzr revision specs), the listed
8012 ;; completions can mix file names and other things.
8013 ;; - It doesn't pay attention to possible quoting.
8014 ;; - With fancy completion styles, the code below will not always
8015 ;; find the right base directory.
8016 (if minibuffer-completing-file-name
8017 (file-name-as-directory
8018 (expand-file-name
8019 (buffer-substring (minibuffer-prompt-end)
8020 (- (point) (or completion-base-size 0))))))))
8021 (with-current-buffer standard-output
8022 (let ((base-size completion-base-size) ;Read before killing localvars.
8023 (base-position completion-base-position)
8024 (insert-fun completion-list-insert-choice-function))
8025 (completion-list-mode)
8026 (set (make-local-variable 'completion-base-size) base-size)
8027 (set (make-local-variable 'completion-base-position) base-position)
8028 (set (make-local-variable 'completion-list-insert-choice-function)
8029 insert-fun))
8030 (set (make-local-variable 'completion-reference-buffer) mainbuf)
8031 (if base-dir (setq default-directory base-dir))
8032 ;; Maybe insert help string.
8033 (when completion-show-help
8034 (goto-char (point-min))
8035 (if (display-mouse-p)
8037 (insert (substitute-command-keys
8041 (add-hook 'completion-setup-hook 'completion-setup-function)
8043 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
8044 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
8046 (defun switch-to-completions ()
8047 "Select the completion list window."
8048 (interactive)
8049 (let ((window (or (get-buffer-window "*Completions*" 0)
8050 ;; Make sure we have a completions window.
8051 (progn (minibuffer-completion-help)
8052 (get-buffer-window "*Completions*" 0)))))
8053 (when window
8054 (select-window window)
8055 ;; In the new buffer, go to the first completion.
8056 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
8057 (when (bobp)
8058 (next-completion 1)))))
8059 \f
8060 ;;; Support keyboard commands to turn on various modifiers.
8062 ;; These functions -- which are not commands -- each add one modifier
8063 ;; to the following event.
8065 (defun event-apply-alt-modifier (_ignore-prompt)
8068 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
8069 (defun event-apply-super-modifier (_ignore-prompt)
8072 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
8073 (defun event-apply-hyper-modifier (_ignore-prompt)
8076 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
8077 (defun event-apply-shift-modifier (_ignore-prompt)
8080 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
8081 (defun event-apply-control-modifier (_ignore-prompt)
8084 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
8085 (defun event-apply-meta-modifier (_ignore-prompt)
8088 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
8090 (defun event-apply-modifier (event symbol lshiftby prefix)
8091 "Apply a modifier flag to event EVENT.
8092 SYMBOL is the name of this modifier, as a symbol.
8093 LSHIFTBY is the numeric value of this modifier, in keyboard events.
8094 PREFIX is the string that represents this modifier in an event type symbol."
8095 (if (numberp event)
8096 (cond ((eq symbol 'control)
8097 (if (and (<= (downcase event) ?z)
8098 (>= (downcase event) ?a))
8099 (- (downcase event) ?a -1)
8100 (if (and (<= (downcase event) ?Z)
8101 (>= (downcase event) ?A))
8102 (- (downcase event) ?A -1)
8103 (logior (lsh 1 lshiftby) event))))
8104 ((eq symbol 'shift)
8105 (if (and (<= (downcase event) ?z)
8106 (>= (downcase event) ?a))
8107 (upcase event)
8108 (logior (lsh 1 lshiftby) event)))
8109 (t
8110 (logior (lsh 1 lshiftby) event)))
8111 (if (memq symbol (event-modifiers event))
8112 event
8113 (let ((event-type (if (symbolp event) event (car event))))
8114 (setq event-type (intern (concat prefix (symbol-name event-type))))
8115 (if (symbolp event)
8116 event-type
8117 (cons event-type (cdr event)))))))
8119 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
8120 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
8121 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
8122 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
8123 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
8124 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
8125 \f
8126 ;;;; Keypad support.
8128 ;; Make the keypad keys act like ordinary typing keys. If people add
8129 ;; bindings for the function key symbols, then those bindings will
8130 ;; override these, so this shouldn't interfere with any existing
8131 ;; bindings.
8133 ;; Also tell read-char how to handle these keys.
8134 (mapc
8135 (lambda (keypad-normal)
8136 (let ((keypad (nth 0 keypad-normal))
8137 (normal (nth 1 keypad-normal)))
8138 (put keypad 'ascii-character normal)
8139 (define-key function-key-map (vector keypad) (vector normal))))
8140 ;; See also kp-keys bound in bindings.el.
8141 '((kp-space ?\s)
8144 (kp-separator ?,)
8145 (kp-equal ?=)
8146 ;; Do the same for various keys that are represented as symbols under
8147 ;; GUIs but naturally correspond to characters.
8148 (backspace 127)
8149 (delete 127)
8152 (clear ?\C-l)
8153 (return ?\C-m)
8154 (escape ?\e)
8155 ))
8156 \f
8157 ;;;;
8158 ;;;; forking a twin copy of a buffer.
8159 ;;;;
8161 (defvar clone-buffer-hook nil
8162 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
8164 (defvar clone-indirect-buffer-hook nil
8165 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
8167 (defun clone-process (process &optional newname)
8168 "Create a twin copy of PROCESS.
8169 If NEWNAME is nil, it defaults to PROCESS' name;
8170 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
8171 If PROCESS is associated with a buffer, the new process will be associated
8172 with the current buffer instead.
8173 Returns nil if PROCESS has already terminated."
8174 (setq newname (or newname (process-name process)))
8176 (setq newname (substring newname 0 (match-beginning 0))))
8177 (when (memq (process-status process) '(run stop open))
8178 (let* ((process-connection-type (process-tty-name process))
8179 (new-process
8180 (if (memq (process-status process) '(open))
8181 (let ((args (process-contact process t)))
8182 (setq args (plist-put args :name newname))
8183 (setq args (plist-put args :buffer
8184 (if (process-buffer process)
8185 (current-buffer))))
8186 (apply 'make-network-process args))
8187 (apply 'start-process newname
8188 (if (process-buffer process) (current-buffer))
8189 (process-command process)))))
8190 (set-process-query-on-exit-flag
8191 new-process (process-query-on-exit-flag process))
8192 (set-process-inherit-coding-system-flag
8193 new-process (process-inherit-coding-system-flag process))
8194 (set-process-filter new-process (process-filter process))
8195 (set-process-sentinel new-process (process-sentinel process))
8196 (set-process-plist new-process (copy-sequence (process-plist process)))
8197 new-process)))
8199 ;; things to maybe add (currently partly covered by `funcall mode'):
8200 ;; - syntax-table
8201 ;; - overlays
8202 (defun clone-buffer (&optional newname display-flag)
8203 "Create and return a twin copy of the current buffer.
8204 Unlike an indirect buffer, the new buffer can be edited
8205 independently of the old one (if it is not read-only).
8206 NEWNAME is the name of the new buffer. It may be modified by
8207 adding or incrementing <N> at the end as necessary to create a
8208 unique buffer name. If nil, it defaults to the name of the
8209 current buffer, with the proper suffix. If DISPLAY-FLAG is
8210 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
8211 clone a file-visiting buffer, or a buffer whose major mode symbol
8212 has a non-nil `no-clone' property, results in an error.
8214 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
8215 current buffer with appropriate suffix. However, if a prefix
8216 argument is given, then the command prompts for NEWNAME in the
8217 minibuffer.
8219 This runs the normal hook `clone-buffer-hook' in the new buffer
8220 after it has been set up properly in other respects."
8221 (interactive
8222 (progn
8223 (if buffer-file-name
8224 (error "Cannot clone a file-visiting buffer"))
8225 (if (get major-mode 'no-clone)
8226 (error "Cannot clone a buffer in %s mode" mode-name))
8227 (list (if current-prefix-arg
8228 (read-buffer "Name of new cloned buffer: " (current-buffer)))
8229 t)))
8230 (if buffer-file-name
8231 (error "Cannot clone a file-visiting buffer"))
8232 (if (get major-mode 'no-clone)
8233 (error "Cannot clone a buffer in %s mode" mode-name))
8234 (setq newname (or newname (buffer-name)))
8236 (setq newname (substring newname 0 (match-beginning 0))))
8237 (let ((buf (current-buffer))
8238 (ptmin (point-min))
8239 (ptmax (point-max))
8240 (pt (point))
8241 (mk (if mark-active (mark t)))
8242 (modified (buffer-modified-p))
8243 (mode major-mode)
8244 (lvars (buffer-local-variables))
8245 (process (get-buffer-process (current-buffer)))
8246 (new (generate-new-buffer (or newname (buffer-name)))))
8247 (save-restriction
8248 (widen)
8249 (with-current-buffer new
8250 (insert-buffer-substring buf)))
8251 (with-current-buffer new
8252 (narrow-to-region ptmin ptmax)
8253 (goto-char pt)
8254 (if mk (set-mark mk))
8255 (set-buffer-modified-p modified)
8257 ;; Clone the old buffer's process, if any.
8258 (when process (clone-process process))
8260 ;; Now set up the major mode.
8261 (funcall mode)
8263 ;; Set up other local variables.
8264 (mapc (lambda (v)
8265 (condition-case () ;in case var is read-only
8266 (if (symbolp v)
8267 (makunbound v)
8268 (set (make-local-variable (car v)) (cdr v)))
8269 (error nil)))
8270 lvars)
8272 ;; Run any hooks (typically set up by the major mode
8273 ;; for cloning to work properly).
8274 (run-hooks 'clone-buffer-hook))
8275 (if display-flag
8276 ;; Presumably the current buffer is shown in the selected frame, so
8277 ;; we want to display the clone elsewhere.
8278 (let ((same-window-regexps nil)
8279 (same-window-buffer-names))
8280 (pop-to-buffer new)))
8281 new))
8284 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8285 "Create an indirect buffer that is a twin copy of the current buffer.
8287 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8288 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8289 or if not called with a prefix arg, NEWNAME defaults to the current
8290 buffer's name. The name is modified by adding a `<N>' suffix to it
8291 or by incrementing the N in an existing suffix. Trying to clone a
8292 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8293 property results in an error.
8295 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8296 This is always done when called interactively.
8298 Optional third arg NORECORD non-nil means do not put this buffer at the
8299 front of the list of recently selected ones.
8301 Returns the newly created indirect buffer."
8302 (interactive
8303 (progn
8304 (if (get major-mode 'no-clone-indirect)
8305 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8306 (list (if current-prefix-arg
8307 (read-buffer "Name of indirect buffer: " (current-buffer)))
8308 t)))
8309 (if (get major-mode 'no-clone-indirect)
8310 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8311 (setq newname (or newname (buffer-name)))
8313 (setq newname (substring newname 0 (match-beginning 0))))
8314 (let* ((name (generate-new-buffer-name newname))
8315 (buffer (make-indirect-buffer (current-buffer) name t)))
8316 (with-current-buffer buffer
8317 (run-hooks 'clone-indirect-buffer-hook))
8318 (when display-flag
8319 (pop-to-buffer buffer norecord))
8320 buffer))
8323 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8324 "Like `clone-indirect-buffer' but display in another window."
8325 (interactive
8326 (progn
8327 (if (get major-mode 'no-clone-indirect)
8328 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8329 (list (if current-prefix-arg
8330 (read-buffer "Name of indirect buffer: " (current-buffer)))
8331 t)))
8332 (let ((pop-up-windows t))
8333 (clone-indirect-buffer newname display-flag norecord)))
8335 \f
8336 ;;; Handling of Backspace and Delete keys.
8338 (defcustom normal-erase-is-backspace 'maybe
8339 "Set the default behavior of the Delete and Backspace keys.
8341 If set to t, Delete key deletes forward and Backspace key deletes
8342 backward.
8344 If set to nil, both Delete and Backspace keys delete backward.
8346 If set to `maybe' (which is the default), Emacs automatically
8347 selects a behavior. On window systems, the behavior depends on
8348 the keyboard used. If the keyboard has both a Backspace key and
8349 a Delete key, and both are mapped to their usual meanings, the
8350 option's default value is set to t, so that Backspace can be used
8351 to delete backward, and Delete can be used to delete forward.
8353 If not running under a window system, customizing this option
8354 accomplishes a similar effect by mapping C-h, which is usually
8355 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8356 via `keyboard-translate'. The former functionality of C-h is
8357 available on the F1 key. You should probably not use this
8358 setting if you don't have both Backspace, Delete and F1 keys.
8360 Setting this variable with setq doesn't take effect. Programmatically,
8361 call `normal-erase-is-backspace-mode' (which see) instead."
8362 :type '(choice (const :tag "Off" nil)
8363 (const :tag "Maybe" maybe)
8364 (other :tag "On" t))
8365 :group 'editing-basics
8366 :version "21.1"
8367 :set (lambda (symbol value)
8368 ;; The fboundp is because of a problem with :set when
8369 ;; dumping Emacs. It doesn't really matter.
8370 (if (fboundp 'normal-erase-is-backspace-mode)
8371 (normal-erase-is-backspace-mode (or value 0))
8372 (set-default symbol value))))
8374 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8375 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8376 (unless frame (setq frame (selected-frame)))
8377 (with-selected-frame frame
8378 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8379 (normal-erase-is-backspace-mode
8380 (if (if (eq normal-erase-is-backspace 'maybe)
8381 (and (not noninteractive)
8382 (or (memq system-type '(ms-dos windows-nt))
8383 (memq window-system '(w32 ns))
8384 (and (memq window-system '(x))
8385 (fboundp 'x-backspace-delete-keys-p)
8386 (x-backspace-delete-keys-p))
8387 ;; If the terminal Emacs is running on has erase char
8388 ;; set to ^H, use the Backspace key for deleting
8389 ;; backward, and the Delete key for deleting forward.
8390 (and (null window-system)
8391 (eq tty-erase-char ?\^H))))
8392 normal-erase-is-backspace)
8393 1 0)))))
8395 (define-minor-mode normal-erase-is-backspace-mode
8396 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8397 With a prefix argument ARG, enable this feature if ARG is
8398 positive, and disable it otherwise. If called from Lisp, enable
8399 the mode if ARG is omitted or nil.
8401 On window systems, when this mode is on, Delete is mapped to C-d
8402 and Backspace is mapped to DEL; when this mode is off, both
8403 Delete and Backspace are mapped to DEL. (The remapping goes via
8404 `local-function-key-map', so binding Delete or Backspace in the
8405 global or local keymap will override that.)
8407 In addition, on window systems, the bindings of C-Delete, M-Delete,
8408 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8409 the global keymap in accordance with the functionality of Delete and
8410 Backspace. For example, if Delete is remapped to C-d, which deletes
8411 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8412 to DEL, which deletes backward, C-Delete is bound to
8413 `backward-kill-word'.
8415 If not running on a window system, a similar effect is accomplished by
8416 remapping C-h (normally produced by the Backspace key) and DEL via
8417 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8418 to C-d; if it's off, the keys are not remapped.
8420 When not running on a window system, and this mode is turned on, the
8421 former functionality of C-h is available on the F1 key. You should
8422 probably not turn on this mode on a text-only terminal if you don't
8423 have both Backspace, Delete and F1 keys.
8425 See also `normal-erase-is-backspace'."
8426 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8427 . (lambda (v)
8428 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8429 (if v 1 0))))
8430 (let ((enabled (eq 1 (terminal-parameter
8431 nil 'normal-erase-is-backspace))))
8433 (cond ((or (memq window-system '(x w32 ns pc))
8434 (memq system-type '(ms-dos windows-nt)))
8435 (let ((bindings
8436 `(([M-delete] [M-backspace])
8437 ([C-M-delete] [C-M-backspace])
8438 ([?\e C-delete] [?\e C-backspace]))))
8440 (if enabled
8441 (progn
8442 (define-key local-function-key-map [delete] [deletechar])
8443 (define-key local-function-key-map [kp-delete] [deletechar])
8444 (define-key local-function-key-map [backspace] [?\C-?])
8445 (dolist (b bindings)
8446 ;; Not sure if input-decode-map is really right, but
8447 ;; keyboard-translate-table (used below) only works
8448 ;; for integer events, and key-translation-table is
8449 ;; global (like the global-map, used earlier).
8450 (define-key input-decode-map (car b) nil)
8451 (define-key input-decode-map (cadr b) nil)))
8452 (define-key local-function-key-map [delete] [?\C-?])
8453 (define-key local-function-key-map [kp-delete] [?\C-?])
8454 (define-key local-function-key-map [backspace] [?\C-?])
8455 (dolist (b bindings)
8456 (define-key input-decode-map (car b) (cadr b))
8457 (define-key input-decode-map (cadr b) (car b))))))
8458 (t
8459 (if enabled
8460 (progn
8461 (keyboard-translate ?\C-h ?\C-?)
8462 (keyboard-translate ?\C-? ?\C-d))
8463 (keyboard-translate ?\C-h ?\C-h)
8464 (keyboard-translate ?\C-? ?\C-?))))
8466 (if (called-interactively-p 'interactive)
8467 (message "Delete key deletes %s"
8468 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8469 "forward" "backward")))))
8470 \f
8471 (defvar vis-mode-saved-buffer-invisibility-spec nil
8472 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8474 (define-minor-mode read-only-mode
8475 "Change whether the current buffer is read-only.
8476 With prefix argument ARG, make the buffer read-only if ARG is
8477 positive, otherwise make it writable. If buffer is read-only
8478 and `view-read-only' is non-nil, enter view mode.
8480 Do not call this from a Lisp program unless you really intend to
8482 possibly enabling or disabling View mode. Also, note that this
8483 command works by setting the variable `buffer-read-only', which
8484 does not affect read-only regions caused by text properties. To
8485 ignore read-only status in a Lisp program (whether due to text
8486 properties or buffer state), bind `inhibit-read-only' temporarily
8487 to a non-nil value."
8488 :variable buffer-read-only
8489 (cond
8490 ((and (not buffer-read-only) view-mode)
8491 (View-exit-and-edit)
8492 (make-local-variable 'view-read-only)
8493 (setq view-read-only t)) ; Must leave view mode.
8494 ((and buffer-read-only view-read-only
8495 ;; If view-mode is already active, `view-mode-enter' is a nop.
8496 (not view-mode)
8497 (not (eq (get major-mode 'mode-class) 'special)))
8498 (view-mode-enter))))
8500 (define-minor-mode visible-mode
8501 "Toggle making all invisible text temporarily visible (Visible mode).
8502 With a prefix argument ARG, enable Visible mode if ARG is
8503 positive, and disable it otherwise. If called from Lisp, enable
8504 the mode if ARG is omitted or nil.
8506 This mode works by saving the value of `buffer-invisibility-spec'
8507 and setting it to nil."
8508 :lighter " Vis"
8509 :group 'editing-basics
8510 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8511 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8512 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8513 (when visible-mode
8514 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8515 buffer-invisibility-spec)
8516 (setq buffer-invisibility-spec nil)))
8517 \f
8518 (defvar messages-buffer-mode-map
8519 (let ((map (make-sparse-keymap)))
8520 (set-keymap-parent map special-mode-map)
8521 (define-key map "g" nil) ; nothing to revert
8522 map))
8524 (define-derived-mode messages-buffer-mode special-mode "Messages"
8527 (defun messages-buffer ()
8529 If it does not exist, create and it switch it to `messages-buffer-mode'."
8530 (or (get-buffer "*Messages*")
8531 (with-current-buffer (get-buffer-create "*Messages*")
8532 (messages-buffer-mode)
8533 (current-buffer))))
8535 \f
8536 ;; Minibuffer prompt stuff.
8538 ;;(defun minibuffer-prompt-modification (start end)
8539 ;; (error "You cannot modify the prompt"))
8540 ;;
8541 ;;
8542 ;;(defun minibuffer-prompt-insertion (start end)
8543 ;; (let ((inhibit-modification-hooks t))
8544 ;; (delete-region start end)
8545 ;; ;; Discard undo information for the text insertion itself
8546 ;; ;; and for the text deletion.above.
8547 ;; (when (consp buffer-undo-list)
8548 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8549 ;; (message "You cannot modify the prompt")))
8550 ;;
8551 ;;
8552 ;;(setq minibuffer-prompt-properties
8553 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8554 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8556 \f
8557 ;;;; Problematic external packages.
8559 ;; rms says this should be done by specifying symbols that define
8560 ;; versions together with bad values. This is therefore not as
8561 ;; flexible as it could be. See the thread:
8562 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8563 (defconst bad-packages-alist
8564 ;; Not sure exactly which semantic versions have problems.
8565 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8567 "The version of `semantic' loaded does not work in Emacs 22.
8568 It can cause constant high CPU load.
8569 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8570 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8571 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8572 ;; provided the `CUA-mode' feature. Since this is no longer true,
8573 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8574 (CUA-mode t nil
8575 "CUA-mode is now part of the standard GNU Emacs distribution,
8576 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8578 You have loaded an older version of CUA-mode which does not work
8579 correctly with this version of Emacs. You should remove the old
8580 version and use the one distributed with Emacs."))
8581 "Alist of packages known to cause problems in this version of Emacs.
8582 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8583 PACKAGE is either a regular expression to match file names, or a
8584 symbol (a feature name), like for `with-eval-after-load'.
8585 SYMBOL is either the name of a string variable, or t. Upon
8586 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8587 warning using STRING as the message.")
8589 (defun bad-package-check (package)
8590 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8591 (condition-case nil
8592 (let* ((list (assoc package bad-packages-alist))
8593 (symbol (nth 1 list)))
8594 (and list
8595 (boundp symbol)
8596 (or (eq symbol t)
8597 (and (stringp (setq symbol (eval symbol)))
8598 (string-match-p (nth 2 list) symbol)))
8599 (display-warning package (nth 3 list) :warning)))
8600 (error nil)))
8602 (dolist (elem bad-packages-alist)
8603 (let ((pkg (car elem)))
8604 (with-eval-after-load pkg
8605 (bad-package-check pkg))))
8607 \f
8608 ;;; Generic dispatcher commands
8610 ;; Macro `define-alternatives' is used to create generic commands.
8611 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8612 ;; that can have different alternative implementations where choosing
8613 ;; among them is exclusively a matter of user preference.
8615 ;; (define-alternatives COMMAND) creates a new interactive command
8616 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8617 ;; Typically, the user will not need to customize this variable; packages
8618 ;; wanting to add alternative implementations should use
8619 ;;
8620 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8622 (defmacro define-alternatives (command &rest customizations)
8623 "Define the new command `COMMAND'.
8625 The argument `COMMAND' should be a symbol.
8627 Running `M-x COMMAND RET' for the first time prompts for which
8628 alternative to use and records the selected command as a custom
8629 variable.
8631 Running `C-u M-x COMMAND RET' prompts again for an alternative
8632 and overwrites the previous choice.
8634 The variable `COMMAND-alternatives' contains an alist with
8635 alternative implementations of COMMAND. `define-alternatives'
8636 does not have any effect until this variable is set.
8638 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8639 `defcustom' keywords and values to add to the declaration of
8640 `COMMAND-alternatives' (typically :group and :version)."
8641 (let* ((command-name (symbol-name command))
8642 (varalt-name (concat command-name "-alternatives"))
8643 (varalt-sym (intern varalt-name))
8644 (varimp-sym (intern (concat command-name "--implementation"))))
8645 `(progn
8647 (defcustom ,varalt-sym nil
8648 ,(format "Alist of alternative implementations for the `%s' command.
8650 Each entry must be a pair (ALTNAME . ALTFUN), where:
8651 ALTNAME - The name shown at user to describe the alternative implementation.
8652 ALTFUN - The function called to implement this alternative."
8653 command-name)
8654 :type '(alist :key-type string :value-type function)
8655 ,@customizations)
8657 (put ',varalt-sym 'definition-name ',command)
8658 (defvar ,varimp-sym nil "Internal use only.")
8660 (defun ,command (&optional arg)
8661 ,(format "Run generic command `%s'.
8662 If used for the first time, or with interactive ARG, ask the user which
8663 implementation to use for `%s'. The variable `%s'
8664 contains the list of implementations currently supported for this command."
8665 command-name command-name varalt-name)
8666 (interactive "P")
8667 (when (or arg (null ,varimp-sym))
8668 (let ((val (completing-read
8669 ,(format-message
8670 "Select implementation for command `%s': "
8671 command-name)
8672 ,varalt-sym nil t)))
8673 (unless (string-equal val "")
8674 (when (null ,varimp-sym)
8675 (message
8676 "Use C-u M-x %s RET`to select another implementation"
8677 ,command-name)
8678 (sit-for 3))
8679 (customize-save-variable ',varimp-sym
8680 (cdr (assoc-string val ,varalt-sym))))))
8681 (if ,varimp-sym
8682 (call-interactively ,varimp-sym)
8683 (message "%s" ,(format-message
8684 "No implementation selected for command `%s'"
8685 command-name)))))))
8687 \f
8688 ;;; Functions for changing capitalization that Do What I Mean
8689 (defun upcase-dwim (arg)
8690 "Upcase words in the region, if active; if not, upcase word at point.
8691 If the region is active, this function calls `upcase-region'.
8692 Otherwise, it calls `upcase-word', with prefix argument passed to it
8693 to upcase ARG words."
8694 (interactive "*p")
8695 (if (use-region-p)
8696 (upcase-region (region-beginning) (region-end))
8697 (upcase-word arg)))
8699 (defun downcase-dwim (arg)
8700 "Downcase words in the region, if active; if not, downcase word at point.
8701 If the region is active, this function calls `downcase-region'.
8702 Otherwise, it calls `downcase-word', with prefix argument passed to it
8703 to downcase ARG words."
8704 (interactive "*p")
8705 (if (use-region-p)
8706 (downcase-region (region-beginning) (region-end))
8707 (downcase-word arg)))
8709 (defun capitalize-dwim (arg)
8710 "Capitalize words in the region, if active; if not, capitalize word at point.
8711 If the region is active, this function calls `capitalize-region'.
8712 Otherwise, it calls `capitalize-word', with prefix argument passed to it
8713 to capitalize ARG words."
8714 (interactive "*p")
8715 (if (use-region-p)
8716 (capitalize-region (region-beginning) (region-end))
8717 (capitalize-word arg)))
8719 \f
8721 (provide 'simple)
8723 ;;; simple.el ends here