| blob | 5c2f3c3db1d1b331de37619ff2438845ece0ef5c |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2014 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
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:
34 ;;; From compile.el
39 "Idle time delay before updating various things on the screen.
40 Various Emacs features that update auxiliary information when point moves
41 wait this many seconds after Emacs becomes idle before doing an update."
47 "Killing and yanking commands."
51 "Highlight (un)matching of parens and expressions."
53 \f
54 ;;; next-error support framework
57 "`next-error' support framework."
63 "Face used to highlight next error locus."
68 "Highlighting of locations in selected source buffers.
69 If a number, highlight the locus in `next-error' face for the given time
70 in seconds, or until the next command is executed.
71 If t, highlight the locus until the next command is executed, or until
72 some other locus replaces it.
73 If nil, don't highlight the locus in the source buffer.
74 If `fringe-arrow', indicate the locus by the fringe arrow
75 indefinitely until some other locus replaces it."
84 "Highlighting of locations in `next-error-no-select'.
85 If number, highlight the locus in `next-error' face for given time in seconds.
86 If t, highlight the locus indefinitely until some other locus replaces it.
87 If nil, don't highlight the locus in the source buffer.
88 If `fringe-arrow', indicate the locus by the fringe arrow
89 indefinitely until some other locus replaces it."
98 "Display the line in the visited source file recentered as specified.
99 If non-nil, the value is passed directly to `recenter'."
107 "List of hook functions run by `next-error' after visiting source file."
118 "The most recent `next-error' buffer.
119 A buffer becomes most recent when its compilation, grep, or
124 "Function to use to find the next error in the current buffer.
125 The function is called with 2 parameters:
126 ARG is an integer specifying by how many errors to move.
127 RESET is a boolean which, if non-nil, says to go back to the beginning
128 of the errors before moving.
129 Major modes providing compile-like functionality should set this variable
130 to indicate to `next-error' that this is a candidate buffer and how
135 "Function to use to move to an error locus.
136 It takes two arguments, a buffer position in the error buffer
137 and a buffer position in the error locus buffer.
138 The buffer for the error locus should already be current.
143 &optional avoid-current
144 extra-test-inclusive
145 extra-test-exclusive)
146 "Test if BUFFER is a `next-error' capable buffer.
148 If AVOID-CURRENT is non-nil, treat the current buffer
149 as an absolute last resort only.
151 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
152 that normally would not qualify. If it returns t, the buffer
153 in question is treated as usable.
155 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
156 that would normally be considered usable. If it returns nil,
157 that buffer is rejected."
162 ;; Optionally reject some buffers.
165 t)
166 ;; Optionally accept some other buffers.
171 extra-test-inclusive
172 extra-test-exclusive)
173 "Return a `next-error' capable buffer.
175 If AVOID-CURRENT is non-nil, treat the current buffer
176 as an absolute last resort only.
178 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
179 that normally would not qualify. If it returns t, the buffer
180 in question is treated as usable.
182 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
183 that would normally be considered usable. If it returns nil,
184 that buffer is rejected."
186 ;; 1. If one window on the selected frame displays such buffer, return it.
192 avoid-current
193 extra-test-inclusive extra-test-exclusive)
198 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
201 extra-test-inclusive extra-test-exclusive))
202 next-error-last-buffer)
203 ;; 3. If the current buffer is acceptable, choose it.
205 extra-test-inclusive extra-test-exclusive)
207 ;; 4. Look for any acceptable buffer.
212 extra-test-inclusive extra-test-exclusive)))
215 ;; 5. Use the current buffer as a last resort if it qualifies,
216 ;; even despite AVOID-CURRENT.
219 extra-test-inclusive extra-test-exclusive)
223 ;; 6. Give up.
227 "Visit next `next-error' message and corresponding source code.
229 If all the error messages parsed so far have been processed already,
230 the message buffer is checked for new ones.
232 A prefix ARG specifies how many error messages to move;
233 negative means move back to previous error messages.
235 and start at the first error.
237 The RESET argument specifies that we should restart from the beginning.
240 compilation, grep, or occur buffer. It can also operate on any
242 more generally, on any buffer in Compilation mode or with
243 Compilation Minor mode enabled, or any buffer in which
244 `next-error-function' is bound to an appropriate function.
245 To specify use of a particular buffer for error messages, type
247 in the current frame.
250 runs `next-error-hook' with `run-hooks', and stays with that buffer
251 until you use it in some other buffer which uses Compilation mode
252 or Compilation Minor mode.
254 To control which errors are matched, customize the variable
255 `compilation-error-regexp-alist'."
259 ;; we know here that next-error-function is a valid symbol we can funcall
267 "Visit the source code corresponding to the `next-error' message at point."
269 ;; we know here that next-error-function is a valid symbol we can funcall
280 "Visit previous `next-error' message and corresponding source code.
282 Prefix arg N says how many error messages to move backwards (or
283 forwards, if negative).
290 "Restart at the first error.
291 Visit corresponding source code.
292 With prefix arg N, visit the source code of the Nth error.
298 "Move point to the next error in the `next-error' buffer and highlight match.
299 Prefix arg N says how many error messages to move forwards (or
300 backwards, if negative).
302 select the source buffer."
309 "Move point to the previous error in the `next-error' buffer and highlight match.
310 Prefix arg N says how many error messages to move backwards (or
311 forwards, if negative).
313 select the source buffer."
317 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
321 "Minor mode for compilation, occur and diff modes.
322 With a prefix argument ARG, enable mode if ARG is positive, and
323 disable it otherwise. If called from Lisp, enable mode if ARG is
324 omitted or nil.
325 When turned on, cursor motion in the compilation, grep, occur or diff
326 buffer causes automatic display of the corresponding source code location."
333 ;; Used as a `post-command-hook' by `next-error-follow-mode'
334 ;; for the *Compilation* *grep* and *Occur* buffers.
344 \f
345 ;;;
348 "Major mode not specialized for anything in particular.
349 Other major modes are defined by comparison with this one."
354 ;; Special major modes to view specially formatted data rather than files.
368 map))
372 "Parent major mode from which special major modes should inherit."
375 ;; Making and deleting lines.
381 "Insert a newline, and move to left margin of the new line if it's blank.
382 If option `use-hard-newlines' is non-nil, the newline is marked with the
383 text-property `hard'.
384 With ARG, insert that many newlines.
386 To turn off indentation by this command, disable Electric Indent mode
389 Calls `auto-fill-function' if the current column number is greater
390 than the value of `fill-column' and ARG is nil.
391 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
394 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
395 ;; Set last-command-event to tell self-insert what to insert.
399 ;; Don't auto-fill if we have a numeric argument.
402 ;; Do the rest in post-self-insert-hook, because we want to do it
403 ;; *before* other functions on that hook.
405 ;; Mark the newline(s) `hard'.
409 ;; If the newline leaves the previous line blank, and we
410 ;; have a left margin, delete that from the blank line.
418 ;; Indent the line after the newline, except in one case:
419 ;; when we added the newline at the beginning of a line which
420 ;; starts a page.
424 ;; FIXME: For non-interactive uses, many calls actually just want
425 ;; (insert "\n"), so maybe we should do just that, so as to avoid
426 ;; the risk of filling or running abbrevs unexpectedly.
433 ;; We first used let-binding to protect the hook, but that was naive
434 ;; since add-hook affects the symbol-default value of the variable,
435 ;; whereas the let-binding might only protect the buffer-local value.
437 nil)
442 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
448 "Insert a newline and leave point before it.
449 If there is a fill prefix and/or a `left-margin', insert them
450 on the new line if the line would have been blank.
451 With arg N, insert N newlines."
456 ;; Don't expand an abbrev before point.
470 "Split current line, moving portion beyond point vertically down.
471 If the current line starts with `fill-prefix', insert it on the new
472 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
474 When called from Lisp code, ARG may be a prefix string to copy."
479 ;; What prefix should we check for (nil means don't).
483 ;; Does this line start with it?
494 "Join this line to previous and fix up whitespace at join.
495 If there is a fill prefix, delete it from the beginning of this line.
496 With argument, join this line to following line."
503 ;; If the second line started with the fill prefix,
504 ;; delete the prefix.
516 "On blank line, delete all surrounding blank lines, leaving just one.
517 On isolated blank line, delete that one.
518 On nonblank line, delete any immediately following blank lines."
524 ;; Set singleblank if there is just one blank line here.
531 ;; Delete preceding blank lines, and this one too if it's the only one.
540 ;; Delete following blank lines, unless the current line is blank
541 ;; and there are no following blank lines.
550 ;; Handle the special case where point is followed by newline and eob.
551 ;; Delete the line, leaving point at eob.
557 Trailing lines are deleted only if `delete-trailing-whitespace'
558 is called on the entire buffer (rather than an active region)."
564 "Delete trailing whitespace between START and END.
565 If called interactively, START and END are the start/end of the
566 region if the mark is active, or of the buffer's accessible
567 portion if the mark is inactive.
569 This command deletes whitespace characters after the last
570 non-whitespace character in each line between START and END. It
571 does not consider formfeed characters to be whitespace.
573 If this command acts on the entire buffer (i.e. if called
574 interactively with the mark inactive, or called from Lisp with
575 END nil), it also deletes all trailing lines at the end of the
576 buffer if the variable `delete-trailing-lines' is non-nil."
589 ;; Don't delete formfeeds, even if they are considered whitespace.
593 ;; Delete trailing empty lines.
596 delete-trailing-lines
597 ;; Really the end of buffer.
602 ;; Return nil for the benefit of `write-file-functions'.
603 nil)
606 "Insert a newline, then indent according to major mode.
607 Indentation is done using the value of `indent-line-function'.
608 In programming language modes, this is the same as TAB.
609 In some text modes, where TAB inserts a tab, this command indents to the
610 column specified by the function `current-left-margin'."
617 "Reindent current line, insert newline, then indent the new line.
618 Indentation of both lines is done according to the current major mode,
619 which means calling the current value of `indent-line-function'.
620 In programming language modes, this is the same as TAB.
621 In some text modes, where TAB inserts a tab, this indents to the
622 column specified by the function `current-left-margin'."
625 ;; Be careful to insert the newline before indenting the line.
626 ;; Otherwise, the indentation might be wrong.
630 ;; We are at EOL before the call to indent-according-to-mode, and
631 ;; after it we usually are as well, but not always. We tried to
632 ;; address it with `save-excursion' but that uses a normal marker
633 ;; whereas we need `move after insertion', so we do the save/restore
634 ;; by hand.
638 ;; Remove the trailing white-space after indentation because
639 ;; indentation may introduce the whitespace.
645 Legitimate radix values are 8, 10 and 16."
650 "Like `read-char', but do not allow quitting.
651 Also, if the first character read is an octal digit,
652 we read any number of octal digits and return the
653 specified character code. Any nondigit terminates the sequence.
654 If the terminator is RET, it is discarded;
655 any other terminator is used itself as input.
657 The optional argument PROMPT specifies a string to use to prompt the user.
658 The variable `read-quoted-char-radix' controls which radix to use
659 for numeric input."
663 ;; Don't let C-h get the help message--only help function keys.
666 "Type the special character you want to use,
667 or the octal character code.
668 RET terminates the character code and is discarded;
678 done t))
680 ;; Turn a meta-character into a character with the 0200 bit set.
682 done t))
698 done t))
700 done t)))
702 code))
705 "Read next input character and insert it.
706 This is useful for inserting control characters.
707 With argument, insert ARG copies of the character.
709 If the first character you type after this command is an octal digit,
710 you should type a sequence of octal digits which specify a character code.
711 Any nondigit terminates the sequence. If the terminator is a RET,
712 it is discarded; any other terminator is used itself as input.
713 The variable `read-quoted-char-radix' specifies the radix for this feature;
714 set it to 10 or 16 to use decimal or hex instead of octal.
716 In overwrite mode, this function inserts the character anyway, and
717 does not handle octal digits specially. This means that if you use
718 overwrite as your normal editing mode, you can use this function to
719 insert characters when necessary.
721 In binary overwrite mode, this function does overwrite, and octal
722 digits are interpreted as a character code. This is intended to be
723 useful for editing binary files."
726 ;; Avoid "obsolete" warnings for translation-table-for-input.
733 ;; This used to assume character codes 0240 - 0377 stand for
734 ;; characters in some single-byte character set, and converted them
735 ;; to Emacs characters. But in 23.1 this feature is deprecated
736 ;; in favor of inserting the corresponding Unicode characters.
737 ;; (if (and enable-multibyte-characters
738 ;; (>= char ?\240)
739 ;; (<= char ?\377))
740 ;; (setq char (unibyte-char-to-multibyte char)))
749 "Move forward ARG lines and position at first nonblank character."
755 "Move backward ARG lines and position at first nonblank character."
761 "Move point to the first non-whitespace character on this line."
765 ;; Move back over chars that have whitespace syntax but have the p flag.
769 "Fixup white space between objects around point.
770 Leave one space or none, according to the context."
777 nil
781 "Delete all spaces and tabs around point.
782 If BACKWARD-ONLY is non-nil, only delete them before point."
787 orig-pos
796 "Delete all spaces and tabs around point, leaving one space (or N spaces).
797 If N is negative, delete newlines as well, leaving -N spaces."
802 "Store context used in consecutive calls to `cycle-spacing' command.
803 The first time this function is run, it saves the original point
804 position and original spacing around the point in this
808 "Manipulate spaces around the point in a smart way.
810 When run as an interactive command, the first time it's called
811 in a sequence, deletes all spaces and tabs around point leaving
812 one (or N spaces). If this does not change content of the
813 buffer, skips to the second step:
815 When run for the second time in a sequence, deletes all the
816 spaces it has previously inserted.
818 When run for the third time, returns the whitespace and point in
819 a state encountered when it had been run for the first time.
822 point, calling `cycle-spacing' command will replace two spaces with
823 a single space, calling it again immediately after, will remove all
824 spaces, and calling it for the third time will bring two spaces back
825 together.
827 If N is negative, delete newlines as well. However, if
828 PRESERVE-NL-BACK is t new line characters prior to the point
829 won't be removed.
831 If SINGLE-SHOT is non-nil, will only perform the first step. In
832 other words, it will work just like `just-one-space' command."
840 ;; Command run for the first time or single-shot is non-nil.
851 ;; Special handling for case where there was no space at all.
854 ;; If this run causes no change in buffer content, delete all spaces,
855 ;; otherwise delete all excess spaces.
860 ;; Command run for the second time.
864 ;; Command run for the third time.
869 \f
871 "Move point to the beginning of the buffer.
872 With numeric arg N, put point N/10 of the way from the beginning.
873 If the buffer is narrowed, this command uses the beginning of the
874 accessible part of the buffer.
876 If Transient Mark mode is disabled, leave mark at previous
879 Don't use this command in Lisp programs!
880 \(goto-char (point-min)) is faster."
889 ;; Avoid overflow for large buffer sizes!
899 "Move point to the end of the buffer.
900 With numeric arg N, put point N/10 of the way from the end.
901 If the buffer is narrowed, this command uses the end of the
902 accessible part of the buffer.
904 If Transient Mark mode is disabled, leave mark at previous
907 Don't use this command in Lisp programs!
908 \(goto-char (point-max)) is faster."
915 ;; Avoid overflow for large buffer sizes!
920 ;; If we went to a place in the middle of the buffer,
921 ;; adjust it to the beginning of a line.
925 ;; If the end of the buffer is not already on the screen,
926 ;; then scroll specially to put it near, but not at, the bottom.
932 "Whether single-char deletion commands delete an active region.
933 This has an effect only if Transient Mark mode is enabled, and
934 affects `delete-forward-char' and `delete-backward-char', though
935 not `delete-char'.
937 If the value is the symbol `kill', the active region is killed
938 instead of deleted."
951 "Function to get the region's content.
952 Called with one argument DELETE.
953 If DELETE is `delete-only', then only delete the region and the return value
954 is undefined. If DELETE is nil, just return the content as a string.
958 "Delete the previous N characters (following if N is negative).
959 If Transient Mark mode is enabled, the mark is active, and N is 1,
960 delete the text in the region and deactivate the mark instead.
961 To disable this, set option `delete-active-region' to nil.
963 Optional second arg KILLFLAG, if non-nil, means to kill (save in
964 kill ring) instead of delete. Interactively, N is the prefix
965 arg, and KILLFLAG is set if N is explicitly specified.
967 In Overwrite mode, single character backward deletion may replace
968 tabs with spaces so as to back over columns, unless point is at
969 the end of the line."
974 delete-active-region
976 ;; If a region is active, kill or delete it.
980 ;; In Overwrite mode, maybe untabify while deleting
990 ;; Otherwise, do simple deletion.
995 "Delete the following N characters (previous if N is negative).
996 If Transient Mark mode is enabled, the mark is active, and N is 1,
997 delete the text in the region and deactivate the mark instead.
998 To disable this, set variable `delete-active-region' to nil.
1000 Optional second arg KILLFLAG non-nil means to kill (save in kill
1001 ring) instead of delete. Interactively, N is the prefix arg, and
1002 KILLFLAG is set if N was explicitly specified."
1007 delete-active-region
1009 ;; If a region is active, kill or delete it.
1014 ;; Otherwise, do simple deletion.
1018 "Put point at beginning and mark at end of buffer.
1019 If narrowing is in effect, only uses the accessible part of the buffer.
1020 You probably should not use this function in Lisp programs;
1021 it is usually a mistake for a Lisp function to use any subroutine
1022 that uses or sets the mark."
1027 \f
1029 ;; Counting lines, one way or another.
1032 "Go to LINE, counting from line 1 at beginning of buffer.
1033 If called interactively, a numeric prefix argument specifies
1034 LINE; without a numeric prefix argument, read LINE from the
1035 minibuffer.
1037 If optional argument BUFFER is non-nil, switch to that buffer and
1039 as argument, BUFFER is the most recently selected other buffer.
1041 Prior to moving point, this function sets the mark (without
1042 activating it), unless Transient Mark mode is enabled and the
1043 mark is already active.
1045 This function is usually the wrong thing to use in a Lisp program.
1046 What you probably want instead is something like:
1047 (goto-char (point-min))
1048 (forward-line (1- N))
1049 If at all possible, an even better solution is to use char counts
1050 rather than line counts."
1054 ;; Look for a default, a number in the buffer at point.
1064 ;; Decide if we're switching buffers.
1072 ;; Read the argument, offering that number (if any) as default.
1075 buffer))))
1076 ;; Switch to the desired buffer, one way or another.
1081 ;; Leave mark at previous position
1083 ;; Move to the specified line number in that buffer.
1093 "Count the number of words in the region.
1094 If called interactively, print a message reporting the number of
1095 lines, words, and characters in the region (whether or not the
1096 region is active); with prefix ARG, report for the entire buffer
1097 rather than the region.
1099 If called from Lisp, return the number of words between positions
1100 START and END."
1112 "Count words between START and END.
1113 If called interactively, START and END are normally the start and
1114 end of the buffer; but if the region is active, START and END are
1115 the start and end of the region. Print a message reporting the
1116 number of lines, words, and chars.
1118 If called from Lisp, return the number of words between START and
1119 END, without printing any message."
1129 words))
1145 str
1153 "Print the current buffer line number and narrowed line number of point."
1166 "Return number of lines between START and END.
1167 This is usually the number of newlines between them,
1168 but can be one more if START is not equal to END
1169 and the greater of them is not at the start of a line."
1185 done)))
1189 "Return (narrowed) buffer line number at position POS.
1190 If POS is nil, use current buffer location.
1191 Counting starts at (point-min), so the value refers
1192 to the contents of the accessible portion of the buffer."
1202 "Print info on cursor position (on screen and within buffer).
1203 Also describe the character after point, and give its character code
1204 in octal, decimal and hex.
1206 For a non-ASCII multibyte character, also give its encoding in the
1207 buffer's selected coding system if the coding system encodes the
1208 character safely. If the character is encoded into one byte, that
1209 code is shown in hex. If the character is encoded into more than one
1212 In addition, with prefix argument, show details about that character
1213 in *Help* buffer. See also the command `describe-char'."
1218 ;; If the character is one of LRE, LRO, RLE, RLO, it
1219 ;; will start a directional embedding, which could
1220 ;; completely disrupt the rest of the line (e.g., RLO
1221 ;; will display the rest of the line right-to-left).
1222 ;; So we put an invisible PDF character after these
1223 ;; characters, to end the embedding, which eliminates
1224 ;; any effects on the rest of the line.
1226 ;; Strong right-to-left characters cause reordering of
1227 ;; the following numerical characters which show the
1228 ;; codepoint, so append LRM to countermand that.
1238 ;; Avoid overflow from multiplying by 100!
1242 ""
1248 pos total percent beg end col hscroll)
1250 pos total col hscroll))
1252 encoded encoding-msg display-prop under-display)
1259 ;; Check if the character is displayed with some `display'
1260 ;; text property. In that case, set under-display to the
1261 ;; buffer substring covered by that property.
1272 under-display)))
1278 char char char under-display)
1280 char char char under-display display-prop))
1283 char char char
1285 "..."
1289 ;; We show the detailed information about CHAR.
1296 bidi-fixer
1297 encoding-msg pos total percent beg end col hscroll)
1304 bidi-fixer encoding-msg pos total percent col hscroll))))))
1305 \f
1306 ;; Initialize read-expression-map. It is defined at C level.
1310 ;; Might as well bind TAB to completion, since inserting a TAB char is
1311 ;; much too rarely useful.
1314 m))
1317 "Return a Lisp object read using the minibuffer, unevaluated.
1318 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1319 is a string to insert in the minibuffer before reading.
1320 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1321 Such arguments are used as in `read-from-minibuffer'.)"
1322 ;; Used for interactive spec `x'.
1327 "Return value of Lisp expression read using the minibuffer.
1328 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1329 is a string to insert in the minibuffer before reading.
1330 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1331 Such arguments are used as in `read-from-minibuffer'.)"
1332 ;; Used for interactive spec `X'.
1340 "The current default value or list of default values in the minibuffer.
1341 The functions `read-from-minibuffer' and `completing-read' bind
1345 "Value for `print-level' while printing value in `eval-expression'.
1346 A value of nil means no limit."
1352 "Value for `print-length' while printing value in `eval-expression'.
1353 A value of nil means no limit."
1359 "If non-nil set `debug-on-error' to t in `eval-expression'.
1360 If nil, don't change the value of `debug-on-error'."
1366 "Format VALUE as a result of evaluated expression.
1367 Return a formatted string which is displayed in the echo area
1368 in addition to the value printed by prin1 in functions which
1369 display the result of expression evaluation."
1392 read-expression-map t
1395 ;; We define this, rather than making `eval' interactive,
1396 ;; for the sake of completion of names like eval-region, eval-buffer.
1398 "Evaluate EXP and print value in the echo area.
1399 When called interactively, read an Emacs Lisp expression and
1400 evaluate it.
1401 Value is also consed on to front of the variable `values'.
1402 Optional argument INSERT-VALUE non-nil (interactively,
1403 with prefix argument) means insert the result into the current buffer
1404 instead of printing it in the echo area. With a zero prefix arg,
1405 insert the result with no limit on the length and level of lists,
1406 and include additional formats for integers (octal, hexadecimal,
1407 and character). Truncates long output according to the value
1408 of the variables `eval-expression-print-length'
1409 and `eval-expression-print-level'.
1411 If `eval-expression-debug-on-error' is non-nil, which is the default,
1412 this command arranges for all errors to enter the debugger."
1415 current-prefix-arg))
1420 ;; Bind debug-on-error to something unique so that we can
1421 ;; detect when evalled code changes it.
1425 ;; If evalled code has changed the value of debug-on-error,
1426 ;; propagate that change to the global binding.
1431 eval-expression-print-length))
1433 eval-expression-print-level))
1449 "Prompting with PROMPT, let user edit COMMAND and eval result.
1450 COMMAND is a Lisp expression. Let user edit that expression in
1451 the minibuffer, then read and evaluate the result."
1458 read-expression-map t
1460 ;; If command was added to command-history as a string,
1461 ;; get rid of that. We want only evaluable expressions there.
1465 ;; If command to be redone does not match front of history,
1466 ;; add it to the history.
1472 "Edit and re-evaluate last complex command, or ARGth from last.
1473 A complex command is one which used the minibuffer.
1474 The command is placed in the minibuffer as a Lisp form for editing.
1475 The result is executed, repeating the command as changed.
1476 If the command has been changed or is not the most recent previous
1477 command it is added to the front of the command history.
1478 You can use the minibuffer history commands \
1480 to get different commands to edit and resubmit."
1483 newcmd)
1495 ;; If command was added to command-history as a
1496 ;; string, get rid of that. We want only
1497 ;; evaluable expressions there.
1501 ;; If command to be redone does not match front of history,
1502 ;; add it to the history.
1507 ;; Trick called-interactively-p into thinking that `newcmd' is
1508 ;; an interactive call (bug#14136).
1527 "Read command name to invoke in `execute-extended-command'."
1532 ;; Get a command name at point in the original buffer
1533 ;; to propose it after M-n.
1537 ;; Read a string, completing from and restricting to the set of
1538 ;; all defined commands. Don't provide any initial input.
1539 ;; Save the command read on the extended-command history list.
1550 ;; This isn't strictly correct if `execute-extended-command'
1551 ;; is bound to anything else (e.g. [menu]).
1552 ;; It could use (key-description (this-single-command-keys)),
1553 ;; but actually a prompt other than "M-x" would be confusing,
1554 ;; because "M-x" is a well-known prompt to read a command
1555 ;; and it serves as a shorthand for "Extended command: ".
1560 "Non-nil means show the equivalent key-binding when M-x command has one.
1561 The value can be a length of time to show the message for.
1562 If the value is non-nil and not a number, we wait 2 seconds."
1569 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1570 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1571 "Read function name, then read its arguments and call it.
1573 To pass a numeric argument to the command you are invoking, specify
1574 the numeric argument to this command.
1576 Noninteractively, the argument PREFIXARG is the prefix argument to
1577 give to the command you invoke, if it asks for an argument."
1579 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1590 ;; Normally `real-this-command' should never be changed, but here we really
1591 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1592 ;; binding" for <cmd>, so the command the user really wanted to run is
1593 ;; `function' and not `execute-extended-command'. The difference is
1594 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1598 ;; If enabled, show which key runs this command.
1600 ;; But first wait, and skip the message if there is input.
1602 ;; If this command displayed something in the echo area;
1603 ;; wait a few seconds, then display our suggestion message.
1613 suggest-key-bindings
1617 ;; BEWARE: Called directly from the C code.
1618 "Execute CMD as an editor command.
1619 CMD must be a symbol that satisfies the `commandp' predicate.
1620 Optional second arg RECORD-FLAG non-nil
1621 means unconditionally put this command in the variable `command-history'.
1622 Otherwise, that is done only if an arg is read using the minibuffer.
1623 The argument KEYS specifies the value to use instead of (this-command-keys)
1624 when reading the arguments; if it is nil, (this-command-keys) is used.
1625 The argument SPECIAL, if non-nil, means that this command is executing
1626 a special event, so ignore the prefix argument and don't clear it."
1634 ;; FIXME: Weird calling convention!
1644 ;; If requested, place the macro in the command history. For
1645 ;; other sorts of commands, call-interactively takes care of this.
1648 ;; Don't keep command history around forever.
1654 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1662 \f
1664 "Default minibuffer history list.
1665 This is used for all minibuffer input
1666 except when an alternate history list is specified.
1668 Maximum length of the history list is determined by the value
1671 "Control whether history list elements are expressions or strings.
1672 If the value of this variable equals current minibuffer depth,
1673 they are expressions; otherwise they are strings.
1674 \(That convention is designed to do the right thing for
1681 "Text that was in this minibuffer before any history commands.
1682 This is nil if there have not yet been any history commands
1691 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1695 "Minibuffer history variables for which matching should ignore case.
1696 If a history variable is a member of this list, then the
1698 commands ignore case when searching it, regardless of `case-fold-search'."
1703 "Find the previous history element that matches REGEXP.
1704 \(Previous history elements refer to earlier actions.)
1705 With prefix argument N, search for Nth previous match.
1706 If N is negative, find the next or Nth next match.
1707 Normally, history elements are matched case-insensitively if
1708 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1709 makes the search case-sensitive.
1710 See also `minibuffer-history-case-insensitive-variables'."
1714 nil
1715 minibuffer-local-map
1716 nil
1717 'minibuffer-history-search-history
1719 ;; Use the last regexp specified, by default, if input is empty.
1724 regexp)
1734 ;; On some systems, ignore case for file names.
1736 minibuffer-history-case-insensitive-variables)
1737 t
1738 ;; Respect the user's setting for case-fold-search:
1739 case-fold-search)
1740 nil))
1741 prevpos
1742 match-string
1743 match-offset
1750 "No later matching history item"
1771 next-matching-history-element))
1775 "Find the next history element that matches REGEXP.
1776 \(The next history element refers to a more recent action.)
1777 With prefix argument N, search for Nth next match.
1778 If N is negative, find the previous or Nth previous match.
1779 Normally, history elements are matched case-insensitively if
1780 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1781 makes the search case-sensitive."
1785 nil
1786 minibuffer-local-map
1787 nil
1788 'minibuffer-history-search-history
1790 ;; Use the last regexp specified, by default, if input is empty.
1795 regexp)
1802 "Function run by `goto-history-element' before consuming default values.
1803 This is useful to dynamically add more elements to the list of default values
1804 when `goto-history-element' reaches the end of this list.
1805 Before calling this function `goto-history-element' sets the variable
1806 `minibuffer-default-add-done' to t, so it will call this function only
1807 once. In special cases, when this function needs to be called more
1808 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1812 "When nil, add more elements to the end of the list of default values.
1813 The value nil causes `goto-history-element' to add more elements to
1814 the list of defaults when it reaches the end of this list. It does
1820 "Return a list of all completions without the default value.
1821 This function is used to add all elements of the completion table to
1822 the end of the list of defaults just after the default value."
1825 minibuffer-completion-table
1826 minibuffer-completion-predicate)))
1832 "Puts element of the minibuffer history in the minibuffer.
1833 The argument NABS specifies the absolute history position."
1847 elt minibuffer-returned-to-present)
1854 "End of defaults; no next item"
1859 previous-history-element))
1871 minibuffer-default)))
1883 elt))
1887 "Puts next element of the minibuffer history in the minibuffer.
1888 With argument N, it uses the Nth following element."
1894 "Puts previous element of the minibuffer history in the minibuffer.
1895 With argument N, it uses the Nth previous element."
1901 "Get next history element which completes the minibuffer before the point.
1902 The contents of the minibuffer after the point are deleted, and replaced
1903 by the new completion."
1909 n)
1910 ;; next-matching-history-element always puts us at (point-min).
1911 ;; Move to the position we were at before changing the buffer contents.
1912 ;; This is still sensible, because the text before point has not changed.
1916 "\
1917 Get previous history element which completes the minibuffer before the point.
1918 The contents of the minibuffer after the point are deleted, and replaced
1919 by the new completion."
1923 ;; For compatibility with the old subr of the same name.
1925 "Return the display width of the minibuffer prompt.
1926 Return 0 if current buffer is not a minibuffer."
1927 ;; Return the width of everything before the field at the end of
1928 ;; the buffer; this should be 0 for normal buffers.
1930 \f
1931 ;; isearch minibuffer history
1938 "Set up a minibuffer for using isearch to search the minibuffer history.
1939 Intended to be added to `minibuffer-setup-hook'."
1951 "Clean up the minibuffer after terminating isearch in the minibuffer."
1956 "Return the proper search function, for isearch in minibuffer history."
1959 ;; Use standard functions to search within minibuffer text
1961 found)
1962 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1963 ;; searching forward. Lazy-highlight calls this lambda with the
1964 ;; bound arg, so skip the minibuffer prompt.
1968 ;; 1. First try searching in the initial minibuffer text
1971 noerror)
1972 ;; 2. If the above search fails, start putting next/prev history
1973 ;; elements in the minibuffer successively, and search the string
1974 ;; in them. Do this only when bound is nil (i.e. not while
1975 ;; lazy-highlighting search strings in the current minibuffer text).
1987 ;; After putting the next/prev history element, search
1988 ;; the string in them again, until next-history-element
1989 ;; or previous-history-element raises an error at the
1990 ;; beginning/end of history.
1993 ;; For backward search, don't search
1994 ;; in the minibuffer prompt
1996 noerror)))
1997 ;; Return point of the new search result
1999 ;; Return nil when next(prev)-history-element fails
2003 "Display the minibuffer history search prompt.
2004 If there are no search errors, this function displays an overlay with
2005 the isearch prompt which replaces the original minibuffer prompt.
2006 Otherwise, it displays the standard isearch message returned from
2007 the function `isearch-message'."
2009 ;; Use standard function `isearch-message' when not in the minibuffer,
2010 ;; or search fails, or has an error (like incomplete regexp).
2011 ;; This function overwrites minibuffer text with isearch message,
2012 ;; so it's possible to see what is wrong in the search string.
2014 ;; Otherwise, put the overlay with the standard isearch prompt over
2015 ;; the initial minibuffer prompt.
2024 ;; And clear any previous isearch message.
2028 "Wrap the minibuffer history search when search fails.
2029 Move point to the first history element for a forward search,
2030 or to the last history element for a backward search."
2031 ;; When `minibuffer-history-isearch-search' fails on reaching the
2032 ;; beginning/end of the history, wrap the search to the first/last
2033 ;; minibuffer history element.
2041 "Save a function restoring the state of minibuffer history search.
2042 Save `minibuffer-history-position' to the additional state parameter
2043 in the search status stack."
2049 "Restore the minibuffer history search state.
2050 Go to the history element by the absolute history position HIST-POS."
2053 \f
2054 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2058 "Table mapping redo records to the corresponding undo one.
2059 A redo record for undo-in-region maps to t.
2069 "Within a run of consecutive undo commands, list remaining to be undone.
2073 "Undo some previous changes.
2074 Repeat this command to undo more changes.
2075 A numeric ARG serves as a repeat count.
2077 In Transient Mark mode when the mark is active, only undo changes within
2079 as an argument limits undo to changes within the current region."
2081 ;; Make last-command indicate for the next command that this was an undo.
2082 ;; That way, another undo will undo more.
2083 ;; If we get to the end of the undo history and get an error,
2084 ;; another undo command will find the undo history empty
2085 ;; and will get another error. To begin undoing the undos,
2086 ;; you must type some other command.
2088 ;; For an indirect buffer, look in the base buffer for the
2089 ;; auto-save data.
2093 message)
2094 ;; If we get an error in undo-start,
2095 ;; the next command should not be a "consecutive undo".
2096 ;; So set `this-command' to something other than `undo'.
2101 ;; If something (a timer or filter?) changed the buffer
2102 ;; since the previous command, don't continue the undo seq.
2106 ;; If the last undo record made was made by undo
2107 ;; it shows nothing else happened in between.
2114 ;; get rid of initial undo boundary
2116 ;; If we got this far, the next command should be a consecutive undo.
2118 ;; Check to see whether we're hitting a redo record, and if
2119 ;; so, ask the user whether she wants to skip the redo/undo pair.
2127 ;; The equiv entry might point to another redo record if we have done
2128 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2136 ;; Record the fact that the just-generated undo records come from an
2137 ;; undo operation--that is, they are redo records.
2138 ;; In the ordinary case (not within a region), map the redo
2139 ;; record to the following undos.
2140 ;; I don't know how to do that in the undo-in-region case.
2142 ;; Strip any leading undo boundaries there might be, like we do
2143 ;; above when checking.
2147 undo-equiv-table))
2148 ;; Don't specify a position in the undo record for the undo command.
2149 ;; Instead, undoing this should move point to where the change is.
2168 ;; Record what the current undo list says,
2169 ;; so the next command can tell if the buffer was modified in between.
2173 ;; Display a message announcing success.
2178 "Make BUFFER stop keeping undo information.
2179 No argument or nil as argument means do this for the current buffer."
2185 "Undo some previous changes.
2186 Repeat this command to undo more changes.
2187 A numeric ARG serves as a repeat count.
2188 Contrary to `undo', this will not redo a previous undo."
2193 "Non-nil while performing an undo.
2197 "Undo back N undo-boundaries beyond what was already undone recently.
2198 Call `undo-start' to get ready to undo recent changes,
2199 then call `undo-more' one or more times to undo them."
2204 ;; Note: The following, while pulling elements off
2205 ;; `pending-undo-list' will call primitive change functions which
2206 ;; will push more elements onto `buffer-undo-list'.
2212 "Undo N records from the front of the list LIST.
2213 Return what remains of the list."
2215 ;; This is a good feature, but would make undo-start
2216 ;; unable to do what is expected.
2217 ;;(when (null (car (list)))
2218 ;; ;; If the head of the list is a boundary, it is the boundary
2219 ;; ;; preceding this command. Get rid of it and don't count it.
2220 ;; (setq list (cdr list))))
2223 ;; In a writable buffer, enable undoing read-only text that is
2224 ;; so because of text properties.
2226 ;; Don't let `intangible' properties interfere with undo.
2228 ;; We use oldlist only to check for EQ. ++kfs
2234 ;; Handle an integer by setting point to that value.
2237 ;; Element (t . TIME) records previous modtime.
2238 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2239 ;; UNKNOWN_MODTIME_NSECS.
2241 ;; If this records an obsolete save
2242 ;; (not matching the actual disk file)
2243 ;; then don't mark unmodified.
2251 ;; Element (nil PROP VAL BEG . END) is property change.
2256 ;; Element (BEG . END) means range was inserted.
2258 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2259 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2262 ;; Set point first thing, so that undoing this undo
2263 ;; does not send point back to where it is now.
2266 ;; Element (apply FUN . ARGS) means call FUN to undo.
2270 ;; Long format: (apply DELTA START END FUN . ARGS).
2277 ;; Check that the function did what the entry
2278 ;; said it would do.
2288 ;; Element (STRING . POS) means STRING was deleted.
2298 ;; Now that we record marker adjustments
2299 ;; (caused by deletion) for undo,
2300 ;; we should always insert after markers,
2301 ;; so that undoing the marker adjustments
2302 ;; put the markers back in the right place.
2305 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2313 ;; Make sure an apply entry produces at least one undo entry,
2314 ;; so the test in `undo' for continuing an undo series
2315 ;; will work right.
2320 list)
2322 ;; Deep copy of a list
2324 "Make a copy of undo list LIST."
2330 elt))
2333 "Set `pending-undo-list' to the front of the undo list.
2334 The next call to `undo-more' will undo the most recently made change.
2335 If BEG and END are specified, then only undo elements
2336 that apply to text between BEG and END are used; other undo elements
2337 are ignored. If BEG and END are nil, all undo elements are used."
2343 buffer-undo-list)))
2348 "Return a list of undo elements for the region START to END.
2349 The elements come from `buffer-undo-list', but we keep only
2350 the elements inside this region, and discard those outside this region.
2351 If we find an element that crosses an edge of this region,
2352 we stop and ignore all further elements."
2355 undo-adjusted-markers
2356 some-rejected
2357 undo-elt temp-undo-list delta)
2362 ;; This is a "was unmodified" element.
2363 ;; Keep it if we have kept everything thus far.
2370 ;; Don't put two nils together in the list
2384 ;; Loop down the earlier events adjusting their buffer
2385 ;; positions to reflect the fact that a change to the buffer
2386 ;; isn't being undone. We only need to process those element
2387 ;; types which undo-elt-in-region will return as being in
2388 ;; the region since only those types can ever get into the
2389 ;; output
2398 ;; (TEXT . POSITION)
2405 ;; (BEGIN . END)
2410 ;; (nil PROPERTY VALUE BEG . END)
2420 "Determine whether UNDO-ELT falls inside the region START ... END.
2421 If it crosses the edge, we return nil."
2426 t)
2428 nil)
2430 ;; (TEXT . POSITION)
2434 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2435 ;; See if MARKER is inside the region.
2446 ;; (nil PROPERTY VALUE BEG . END)
2451 ;; (BEGIN . END)
2456 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2457 This assumes we have already decided that UNDO-ELT
2458 is not *inside* the region START...END."
2461 ;; (nil PROPERTY VALUE BEG . END)
2466 ;; (BEGIN . END)
2470 ;; Return the first affected buffer position and the delta for an undo element
2471 ;; delta is defined as the change in subsequent buffer positions if we *did*
2472 ;; the undo.
2476 ;; (TEXT . POSITION)
2479 ;; (BEGIN . END)
2486 "If non-nil ask about discarding undo info for the current command.
2487 Normally, Emacs discards the undo info for the current command if
2488 it exceeds `undo-outer-limit'. But if you set this option
2489 non-nil, it asks in the echo area whether to discard the info.
2490 If you answer no, there is a slight risk that Emacs might crash, so
2491 only do it if you really want to undo the command.
2493 This option is mainly intended for debugging. You have to be
2494 careful if you use it for other purposes. Garbage collection is
2495 inhibited while the question is asked, meaning that Emacs might
2496 leak memory. So you should make sure that you do not wait
2497 excessively long before answering the question."
2503 "If non-nil, an extra level of size that's ok in an undo item.
2504 We don't ask the user about truncating the undo list until the
2505 current item gets bigger than this amount.
2510 ;; When the first undo batch in an undo list is longer than
2511 ;; undo-outer-limit, this function gets called to warn the user that
2512 ;; the undo info for the current command was discarded. Garbage
2513 ;; collection is inhibited around the call, so it had better not do a
2514 ;; lot of consing.
2520 ;; Don't ask the question again unless it gets even bigger.
2521 ;; This applies, in particular, if the user quits from the question.
2522 ;; Such a quit quits out of GC, but something else will call GC
2523 ;; again momentarily. It will call this function again,
2524 ;; but we don't want to ask the question again.
2531 t)
2532 nil))
2537 "The undo info was discarded because it exceeded \
2538 `undo-outer-limit'.
2540 This is normal if you executed a command that made a huge change
2541 to the buffer. In that case, to prevent similar problems in the
2542 future, set `undo-outer-limit' to a value that is large enough to
2543 cover the maximum size of normal changes you expect a single
2544 command to make, but not so large that it might exceed the
2545 maximum memory allotted to Emacs.
2547 If you did not execute any such command, the situation is
2548 probably due to a bug and you should report it.
2550 You can disable the popping up of this buffer by adding the entry
2551 \(undo discard-info) to the user option `warning-suppress-types',
2555 t))
2556 \f
2558 "History list for some commands that read shell commands.
2560 Maximum length of the history list is determined by the value
2567 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2568 This buffer is used when `shell-command' or `shell-command-on-region'
2569 is run interactively. A value of nil means that output to stderr and
2576 "Return a list of all commands associated with the current file.
2577 This function is used to add all related commands retrieved by `mailcap'
2578 to the end of the list of defaults just after the default value."
2582 minibuffer-default))
2587 commands))
2598 map)
2602 "Read a shell command from the minibuffer.
2603 The arguments are the same as the ones of `read-from-minibuffer',
2604 except READ and KEYMAP are missing and HIST defaults
2605 to `shell-command-history'."
2613 minibuffer-local-shell-command-map
2614 nil
2616 args)))
2619 "What to do when the output buffer is used by another shell command.
2620 This option specifies how to resolve the conflict where a new command
2621 wants to direct its output to the buffer `*Async Shell Command*',
2622 but this buffer is already taken by another running shell command.
2624 The value `confirm-kill-process' is used to ask for confirmation before
2625 killing the already running process and running a new process
2626 in the same buffer, `confirm-new-buffer' for confirmation before running
2627 the command in a new buffer with a name other than the default buffer name,
2628 `new-buffer' for doing the same without confirmation,
2629 `confirm-rename-buffer' for confirmation before renaming the existing
2630 output buffer and running a new command in the default buffer,
2631 `rename-buffer' for doing the same without confirmation."
2633 confirm-kill-process)
2635 confirm-new-buffer)
2637 new-buffer)
2639 confirm-rename-buffer)
2641 rename-buffer))
2646 "Execute string COMMAND asynchronously in background.
2648 Like `shell-command', but adds `&' at the end of COMMAND
2649 to execute it asynchronously.
2651 The output appears in the buffer `*Async Shell Command*'.
2652 That buffer is in shell mode.
2654 You can configure `async-shell-command-buffer' to specify what to do in
2655 case when `*Async Shell Command*' buffer is already taken by another
2656 running shell command. To run COMMAND without displaying the output
2657 in a window you can configure `display-buffer-alist' to use the action
2658 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
2660 In Elisp, you will often be better served by calling `start-process'
2661 directly, since it offers more control and does not impose the use of a
2662 shell (with its need to quote arguments)."
2672 current-prefix-arg
2673 shell-command-default-error-buffer))
2679 "Execute string COMMAND in inferior shell; display output, if any.
2680 With prefix argument, insert the COMMAND's output at point.
2682 If COMMAND ends in `&', execute it asynchronously.
2683 The output appears in the buffer `*Async Shell Command*'.
2684 That buffer is in shell mode. You can also use
2685 `async-shell-command' that automatically adds `&'.
2687 Otherwise, COMMAND is executed synchronously. The output appears in
2688 the buffer `*Shell Command Output*'. If the output is short enough to
2689 display in the echo area (which is determined by the variables
2690 `resize-mini-windows' and `max-mini-window-height'), it is shown
2691 there, but it is nonetheless available in buffer `*Shell Command
2692 Output*' even though that buffer is not automatically displayed.
2694 To specify a coding system for converting non-ASCII characters
2696 before this command.
2698 Noninteractive callers can specify coding systems by binding
2699 `coding-system-for-read' and `coding-system-for-write'.
2701 The optional second argument OUTPUT-BUFFER, if non-nil,
2702 says to put the output in some other buffer.
2703 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2704 If OUTPUT-BUFFER is not a buffer and not nil,
2705 insert output in current buffer. (This cannot be done asynchronously.)
2706 In either case, the buffer is first erased, and the output is
2707 inserted after point (leaving mark after it).
2709 If the command terminates without error, but generates output,
2711 the output can be displayed in the echo area or in its buffer.
2712 If the output is short enough to display in the echo area
2713 \(determined by the variable `max-mini-window-height' if
2714 `resize-mini-windows' is non-nil), it is shown there.
2715 Otherwise,the buffer containing the output is displayed.
2719 of the output.
2721 If there is no output, or if output is inserted in the current buffer,
2722 then `*Shell Command Output*' is deleted.
2724 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2725 or buffer name to which to direct the command's standard error output.
2726 If it is nil, error output is mingled with regular output.
2727 In an interactive call, the variable `shell-command-default-error-buffer'
2728 specifies the value of ERROR-BUFFER.
2730 In Elisp, you will often be better served by calling `call-process' or
2731 `start-process' directly, since it offers more control and does not impose
2732 the use of a shell (with its need to quote arguments)."
2743 current-prefix-arg
2744 shell-command-default-error-buffer))
2745 ;; Look for a handler in case default-directory is a remote file name.
2753 ;; Output goes in current buffer.
2759 temporary-file-directory)))
2760 nil)))
2763 ;; We do not use -f for csh; we will not support broken use of
2764 ;; .cshrcs. Even the BSD csh manual says to use
2765 ;; "if ($?prompt) exit" before things which are not useful
2766 ;; non-interactively. Besides, if someone wants their other
2767 ;; aliases for shell commands then they can still have them.
2771 t)
2772 nil shell-command-switch command)
2779 ;; Do no formatting while reading error file,
2780 ;; because that can run a shell command, and we
2781 ;; don't want that to cause an infinite recursion.
2783 ;; Put point after the inserted errors.
2787 ;; This is like exchange-point-and-mark, but doesn't
2788 ;; activate the mark. It is cleaner to avoid activation,
2789 ;; even though the command loop would deactivate the mark
2790 ;; because we inserted text.
2794 ;; Output goes in a separate buffer.
2795 ;; Preserve the match data in case called from a program.
2798 ;; Command ending with ampersand means asynchronous.
2802 proc)
2803 ;; Remove the ampersand.
2805 ;; Ask the user what to do with already running process.
2810 ;; If will kill a process, query first.
2815 ;; If will create a new buffer, query first.
2821 ;; It will create a new buffer.
2825 ;; If will rename the buffer, query first.
2834 ;; It will rename the buffer.
2841 ;; Setting buffer-read-only to nil doesn't suffice
2842 ;; if some text has a non-nil read-only property,
2843 ;; which comint sometimes adds for prompts.
2849 shell-command-switch command))
2853 ;; Use the comint filter for proper handling of carriage motion
2854 ;; (see `comint-inhibit-carriage-motion'),.
2856 ))
2857 ;; Otherwise, command is executed synchronously.
2859 output-buffer nil error-buffer)))))))
2863 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2864 MESSAGE may be either a string or a buffer.
2866 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2867 the maximum height of the echo area, as defined by `max-mini-window-height'
2868 if `resize-mini-windows' is non-nil.
2870 Returns either the string shown in the echo area, or when a pop-up
2871 buffer is used, the window used to display it.
2873 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2874 name of the buffer used to display it in the case where a pop-up buffer
2875 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2876 string and it is displayed in the echo area, it is not specified whether
2877 the contents are inserted into the buffer anyway.
2879 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2880 and only used if a buffer is displayed."
2882 ;; Trivial case where we can use the echo area
2886 ;; Trivial case where we can just remove single trailing newline
2889 ;; General case
2892 message
2901 0
2905 (<= lines
2909 max-mini-window-height))
2911 max-mini-window-height)
2915 ;; Don't use the echo area if the output buffer is
2916 ;; already displayed in the selected frame.
2918 ;; Echo area
2924 ;; Buffer
2927 not-this-window frame))))))))
2930 ;; We have a sentinel to prevent insertion of a termination message
2931 ;; in the buffer itself.
2939 &optional output-buffer replace
2940 error-buffer display-error-buffer)
2941 "Execute string COMMAND in inferior shell with region as input.
2942 Normally display output (if any) in temp buffer `*Shell Command Output*';
2943 Prefix arg means replace the region with it. Return the exit code of
2944 COMMAND.
2946 To specify a coding system for converting non-ASCII characters
2948 before this command. By default, the input (from the current buffer)
2949 is encoded using coding-system specified by `process-coding-system-alist',
2950 falling back to `default-process-coding-system' if no match for COMMAND
2951 is found in `process-coding-system-alist'.
2953 Noninteractive callers can specify coding systems by binding
2954 `coding-system-for-read' and `coding-system-for-write'.
2956 If the command generates output, the output may be displayed
2957 in the echo area or in a buffer.
2958 If the output is short enough to display in the echo area
2959 \(determined by the variable `max-mini-window-height' if
2960 `resize-mini-windows' is non-nil), it is shown there.
2961 Otherwise it is displayed in the buffer `*Shell Command Output*'.
2962 The output is available in that buffer in both cases.
2964 If there is output and an error, a message about the error
2965 appears at the end of the output. If there is no output, or if
2966 output is inserted in the current buffer, the buffer `*Shell
2967 Command Output*' is deleted.
2969 Optional fourth arg OUTPUT-BUFFER specifies where to put the
2970 command's output. If the value is a buffer or buffer name,
2971 put the output there. If the value is nil, use the buffer
2972 `*Shell Command Output*'. Any other value, excluding nil,
2973 means to insert the output in the current buffer. In either case,
2974 the output is inserted after point (leaving mark after it).
2976 Optional fifth arg REPLACE, if non-nil, means to insert the
2977 output in place of text from START to END, putting point and mark
2978 around it.
2980 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
2981 or buffer name to which to direct the command's standard error
2982 output. If nil, error output is mingled with regular output.
2983 When called interactively, `shell-command-default-error-buffer'
2984 is used for ERROR-BUFFER.
2986 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
2987 display the error buffer if there were any errors. When called
2988 interactively, this is t."
2992 ;; Do this before calling region-beginning
2993 ;; and region-end, in case subprocess output
2994 ;; relocates them while we are in the minibuffer.
2996 ;; call-interactively recognizes region-beginning and
2997 ;; region-end specially, leaving them in the history.
2999 string
3000 current-prefix-arg
3001 current-prefix-arg
3002 shell-command-default-error-buffer
3003 t)))
3009 temporary-file-directory)))
3010 nil))
3011 exit-status)
3015 ;; Replace specified region with output from command.
3017 ;; Don't muck with mark unless REPLACE says we should.
3024 t)
3025 nil shell-command-switch command))
3026 ;; It is rude to delete a buffer which the command is not using.
3027 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3028 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3029 ;; (kill-buffer shell-buffer)))
3030 ;; Don't muck with mark unless REPLACE says we should.
3032 ;; No prefix argument: put the output in a temp buffer,
3033 ;; replacing its entire contents.
3038 ;; If the input is the same buffer as the output,
3039 ;; delete everything but the specified region,
3040 ;; then replace that region with the output.
3046 shell-file-name t
3049 t)
3050 nil shell-command-switch
3051 command)))
3052 ;; Clear the output buffer, then run the command with
3053 ;; output there.
3064 buffer)
3065 nil shell-command-switch command)))
3066 ;; Report the output.
3076 ;; There's some output, display it
3078 ;; No output; error?
3085 shell-command-default-error-buffer)
3092 output))
3095 exit-status))
3098 exit-status output))))
3099 ;; Don't kill: there might be useful info in the undo-log.
3100 ;; (kill-buffer buffer)
3101 ))))
3109 ;; Do no formatting while reading error file,
3110 ;; because that can run a shell command, and we
3111 ;; don't want that to cause an infinite recursion.
3113 ;; Put point after the inserted errors.
3118 exit-status))
3121 "Execute shell command COMMAND and return its output as a string."
3124 standard-output
3128 "Process files synchronously in a separate process.
3129 Similar to `call-process', but may invoke a file handler based on
3130 `default-directory'. The current working directory of the
3131 subprocess is `default-directory'.
3133 File names in INFILE and BUFFER are handled normally, but file
3134 names in ARGS should be relative to `default-directory', as they
3135 are passed to the process verbatim. \(This is a difference to
3136 `call-process' which does not support file handlers for INFILE
3137 and BUFFER.\)
3139 Some file handlers might not support all variants, for example
3140 they might behave as if DISPLAY was nil, regardless of the actual
3141 value passed."
3143 lc stderr-file)
3153 display args)
3159 "Whether a call of `process-file' changes remote files.
3161 By default, this variable is always set to `t', meaning that a
3162 call of `process-file' could potentially change any file on a
3163 remote host. When set to `nil', a file handler could optimize
3164 its behavior with respect to remote file attribute caching.
3166 You should only ever change this variable with a let-binding;
3170 "Start a program in a subprocess. Return the process object for it.
3172 Similar to `start-process', but may invoke a file handler based on
3173 `default-directory'. See Info node `(elisp)Magic File Names'.
3175 This handler ought to run PROGRAM, perhaps on the local host,
3176 perhaps on a remote host that corresponds to `default-directory'.
3177 In the latter case, the local part of `default-directory' becomes
3178 the working directory of the process.
3180 PROGRAM and PROGRAM-ARGS might be file names. They are not
3181 objects of file handler invocation. File handlers might not
3182 support pty association, if PROGRAM is nil."
3186 \f
3187 ;;;; Process menu
3199 "Major mode for listing the processes called by Emacs."
3211 "Recompute the list of processes for the Process List buffer.
3212 Also, delete any process that is exited or signaled."
3225 face link
3228 follow-link t
3229 process-buffer ,buf
3230 action process-menu-visit-buffer)
3239 "datagram"
3256 tabulated-list-entries))))))
3262 "Display a list of all processes that are Emacs sub-processes.
3263 If optional argument QUERY-ONLY is non-nil, only processes with
3264 the query-on-exit flag set are listed.
3265 Any process listed as exited or signaled is actually eliminated
3266 after the listing is made.
3267 Optional argument BUFFER specifies a buffer to use, instead of
3269 The return value is always nil.
3271 This function lists only processes that were launched by Emacs. To
3272 see other processes running on the system, use `list-system-processes'."
3284 nil)
3285 \f
3289 ;; For backward compatibility, minus with no modifiers is an ordinary
3290 ;; command if digits have already been entered.
3320 map)
3327 "Begin a numeric argument for the following command.
3332 multiplies the argument by 4 each time.
3334 which is different in effect from any particular numeric argument.
3341 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3342 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3348 arg)))
3352 "Begin a negative numeric argument for the next command.
3361 "Part of the numeric argument for the next command.
3365 last-command-event
3372 ;; Treat -0 as just -, so that -01 will work.
3375 digit))))
3377 \f
3385 "Function to perform the filtering in `filter-buffer-substring'.
3386 The function is called with 3 arguments:
3387 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
3388 as those of `filter-buffer-substring' in each case.
3392 "List of filter functions for `filter-buffer-substring'.
3393 Each function must accept a single argument, a string, and return
3394 a string. The buffer substring is passed to the first function
3395 in the list, and the return value of each function is passed to
3396 the next.
3397 As a special convention, point is set to the start of the buffer text
3398 being operated on (i.e., the first argument of `filter-buffer-substring')
3404 "Return the buffer substring between BEG and END, after filtering.
3405 The hook `filter-buffer-substring-function' performs the actual filtering.
3406 By default, no filtering is done.
3408 If DELETE is non-nil, the text between BEG and END is deleted
3409 from the buffer.
3411 This function should be used instead of `buffer-substring',
3412 `buffer-substring-no-properties', or `delete-and-extract-region'
3413 when you want to allow filtering to take place. For example,
3414 major or minor modes can use `filter-buffer-substring-function' to
3415 extract characters that are special to a buffer, and should not
3416 be copied into other buffers."
3419 ;; FIXME: `with-wrapper-hook' is obsolete
3430 string)))
3435 ;;;; Window system cut and paste hooks.
3438 "Function to call to make a killed region available to other programs.
3439 Most window systems provide a facility for cutting and pasting
3440 text between different programs, such as the clipboard on X and
3441 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3443 This variable holds a function that Emacs calls whenever text is
3444 put in the kill ring, to make the new kill available to other
3445 programs. The function takes one argument, TEXT, which is a
3449 "Function to call to get text cut from other programs.
3450 Most window systems provide a facility for cutting and pasting
3451 text between different programs, such as the clipboard on X and
3452 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3454 This variable holds a function that Emacs calls to obtain text
3455 that other programs have provided for pasting. The function is
3456 called with no arguments. If no other program has provided text
3457 to paste, the function should return nil (in which case the
3458 caller, usually `current-kill', should use the top of the Emacs
3459 kill ring). If another program has provided text to paste, the
3460 function should return that text as a string (in which case the
3461 caller should put this string in the kill ring as the latest
3462 kill).
3464 The function may also return a list of strings if the window
3465 system supports multiple selections. The first string will be
3466 used as the pasted text, but the other will be placed in the kill
3467 ring for easy access via `yank-pop'.
3469 Note that the function should return a string only if a program
3470 other than Emacs has provided a string for pasting; if Emacs
3471 provided the most recent string, the function should return nil.
3472 If it is difficult to tell whether Emacs or some other program
3473 provided the current string, it is probably good enough to return
3474 nil if the string is equal (according to `string=') to the last
3476 \f
3479 ;;;; The kill ring data structure.
3482 "List of killed text sequences.
3483 Since the kill ring is supposed to interact nicely with cut-and-paste
3484 facilities offered by window systems, use of this variable should
3485 interact nicely with `interprogram-cut-function' and
3486 `interprogram-paste-function'. The functions `kill-new',
3487 `kill-append', and `current-kill' are supposed to implement this
3488 interaction; you may want to use them instead of manipulating the kill
3492 "Maximum length of kill ring before oldest elements are thrown away."
3500 "Save clipboard strings into kill ring before replacing them.
3501 When one selects something in another program to paste it into Emacs,
3502 but kills something in Emacs before actually pasting it,
3503 this selection is gone unless this variable is non-nil,
3504 in which case the other program's selection is saved in the `kill-ring'
3511 "Do not add a new string to `kill-ring' if it duplicates the last one.
3512 The comparison is done using `equal-including-properties'."
3518 "Make STRING the latest kill in the kill ring.
3519 Set `kill-ring-yank-pointer' to point to it.
3520 If `interprogram-cut-function' is non-nil, apply it to STRING.
3521 Optional second argument REPLACE non-nil means that STRING will replace
3522 the front of the kill ring, rather than being added to the list.
3524 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3525 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3526 STRING.
3528 When the yank handler has a non-nil PARAM element, the original STRING
3529 argument is not used by `insert-for-yank'. However, since Lisp code
3530 may access and use elements from the kill ring directly, the STRING
3533 ;; Due to text properties such as 'yank-handler that
3534 ;; can alter the contents to yank, comparison using
3535 ;; `equal' is unsafe.
3561 "Append STRING to the end of the latest kill in the kill ring.
3562 If BEFORE-P is non-nil, prepend STRING to the kill.
3563 If `interprogram-cut-function' is set, pass the resulting kill to it."
3570 "Whether rotating the kill ring changes the window system selection.
3571 If non-nil, whenever the kill ring is rotated (usually via the
3572 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3573 to copy the new kill to the window system selection."
3579 "Rotate the yanking point by N places, and then return that kill.
3580 If N is zero and `interprogram-paste-function' is set to a
3581 function that returns a string or a list of strings, and if that
3582 function doesn't return nil, then that string (or list) is added
3583 to the front of the kill ring and the string (or first string in
3584 the list) is returned as the latest kill.
3586 If N is not zero, and if `yank-pop-change-selection' is
3587 non-nil, use `interprogram-cut-function' to transfer the
3588 kill at the new yank point into the window system selection.
3590 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3591 move the yanking point; just return the Nth kill forward."
3594 interprogram-paste-function
3598 ;; Disable the interprogram cut function when we add the new
3599 ;; text to the kill ring, so Emacs doesn't try to own the
3600 ;; selection, with identical text.
3610 kill-ring)))
3615 interprogram-cut-function)
3621 ;;;; Commands for manipulating the kill ring.
3624 "Non-nil means don't signal an error for killing read-only text."
3630 This deletes the text from the buffer and saves it in the kill ring.
3634 If you want to append the killed region to the last killed text,
3637 If the buffer is read-only, Emacs will beep and refrain from deleting
3638 the text, but put the text in the kill ring anyway. This means that
3639 you can use the killing commands to copy text from a read-only buffer.
3641 Lisp programs should use this function for killing text.
3642 (To delete text, use `delete-region'.)
3643 Supply two arguments, character positions indicating the stretch of text
3644 to be killed.
3646 If the previous command was also a kill command,
3647 the text killed this time appends to the text killed last time
3648 to make one entry in the kill ring.
3650 The optional argument REGION if non-nil, indicates that we're not just killing
3651 some text between BEG and END, but we're killing the region."
3652 ;; Pass mark first, then point, because the order matters when
3653 ;; calling `kill-append'.
3662 ;; Add that string to the kill ring, one way or another.
3669 nil)
3671 ;; The code above failed because the buffer, or some of the characters
3672 ;; in the region, are read-only.
3673 ;; We should beep, in case the user just isn't aware of this.
3674 ;; However, there's no harm in putting
3675 ;; the region's text in the kill ring, anyway.
3677 ;; Set this-command now, so it will be set even if we get an error.
3679 ;; This should barf, if appropriate, and give us the correct error.
3682 ;; Signal an error if the buffer is read-only.
3684 ;; If the buffer isn't read-only, the text is.
3687 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3688 ;; to get two copies of the text when the user accidentally types M-w and
3689 ;; then corrects it with the intended C-w.
3691 "Save the region as if killed, but don't kill it.
3692 In Transient Mark mode, deactivate the mark.
3693 If `interprogram-cut-function' is non-nil, also save the text for a window
3694 system cut and paste.
3696 The optional argument REGION if non-nil, indicates that we're not just copying
3697 some text between BEG and END, but we're copying the region.
3699 This command's old key binding has been given to `kill-ring-save'."
3700 ;; Pass mark first, then point, because the order matters when
3701 ;; calling `kill-append'.
3711 nil)
3714 "Save the region as if killed, but don't kill it.
3715 In Transient Mark mode, deactivate the mark.
3716 If `interprogram-cut-function' is non-nil, also save the text for a window
3717 system cut and paste.
3719 If you want to append the killed line to the last killed text,
3722 The optional argument REGION if non-nil, indicates that we're not just copying
3723 some text between BEG and END, but we're copying the region.
3725 This command is similar to `copy-region-as-kill', except that it gives
3726 visual feedback indicating the extent of the region being copied."
3727 ;; Pass mark first, then point, because the order matters when
3728 ;; calling `kill-append'.
3732 ;; This use of called-interactively-p is correct because the code it
3733 ;; controls just gives the user visual feedback.
3738 "Indicate that the region text has been copied interactively.
3739 If the mark is visible in the selected window, blink the cursor
3740 between point and mark if there is currently no active region
3741 highlighting.
3743 If the mark lies outside the selected window, display an
3744 informative message containing a sample of the copied text. The
3745 optional argument MESSAGE-LEN, if non-nil, specifies the length
3746 of this sample text; it defaults to 40."
3749 ;; Inhibit quitting so we can make a quit here
3750 ;; look like a C-g typed as a command.
3753 ;; Swap point-and-mark quickly so as to show the region that
3754 ;; was selected. Don't do it if the region is highlighted.
3757 ;; Swap point and mark.
3761 ;; Swap back.
3764 ;; If user quit, deactivate the mark
3765 ;; as C-g would as a command.
3771 ;; Don't say "killed"; that is misleading.
3778 "Cause following command, if it kills, to add to previous kill.
3779 If the next command kills forward from point, the kill is
3780 appended to the previous killed text. If the command kills
3781 backward, the kill is prepended. Kill commands that act on the
3782 region, such as `kill-region', are regarded as killing forward if
3783 point is after mark, and killing backward if point is before
3784 mark.
3786 If the next command is not a kill command, `append-next-kill' has
3787 no effect.
3789 The argument is used for internal purposes; do not supply one."
3791 ;; We don't use (interactive-p), since that breaks kbd macros.
3797 \f
3798 ;; Yanking.
3803 "List of special text property handling conditions for yanking.
3804 Each element should have the form (PROP . FUN), where PROP is a
3805 property symbol and FUN is a function. When the `yank' command
3806 inserts text into the buffer, it scans the inserted text for
3807 stretches of text that have `eq' values of the text property
3808 PROP; for each such stretch of text, FUN is called with three
3809 arguments: the property's value in that text, and the start and
3810 end positions of the text.
3812 This is done prior to removing the properties specified by
3813 `yank-excluded-properties'."
3816 function))
3819 ;; This is actually used in subr.el but defcustom does not work there.
3822 intangible invisible keymap local-map mouse-face read-only
3823 yank-handler)
3824 "Text properties to discard when yanking.
3825 The value should be a list of text properties to discard or t,
3826 which means to discard all text properties.
3828 See also `yank-handled-properties'."
3835 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3836 Function is called with two parameters, START and END corresponding to
3837 the value of the mark and point; it is guaranteed that START <= END.
3841 "Replace just-yanked stretch of killed text with a different stretch.
3842 This command is allowed only immediately after a `yank' or a `yank-pop'.
3843 At such a time, the region contains a stretch of reinserted
3844 previously-killed text. `yank-pop' deletes that text and inserts in its
3845 place a different stretch of killed text.
3847 With no argument, the previous kill is inserted.
3848 With argument N, insert the Nth previous kill.
3849 If N is negative, this is a more recent kill.
3851 The sequence of kills wraps around, so that after the oldest one
3852 comes the newest one.
3854 When this command inserts killed text into the buffer, it honors
3855 `yank-excluded-properties' and `yank-handler' as described in the
3856 doc string for `insert-for-yank-1', which see."
3870 ;; Set the window start back where it was in the yank command,
3871 ;; if possible.
3874 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3875 ;; It is cleaner to avoid activation, even though the command
3876 ;; loop would deactivate the mark because we inserted text.
3879 nil)
3883 More precisely, reinsert the most recent kill, which is the
3884 stretch of killed text most recently killed OR yanked. Put point
3885 at the end, and set mark at the beginning without activating it.
3887 With argument N, reinsert the Nth most recent kill.
3889 When this command inserts text into the buffer, it honors the
3890 `yank-handled-properties' and `yank-excluded-properties'
3891 variables, and the `yank-handler' text property. See
3892 `insert-for-yank-1' for details.
3897 ;; If we don't get all the way thru, make last-command indicate that
3898 ;; for the following command.
3906 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3907 ;; It is cleaner to avoid activation, even though the command
3908 ;; loop would deactivate the mark because we inserted text.
3911 ;; If we do get all the way thru, make this-command indicate that.
3914 nil)
3917 "Rotate the yanking point in the kill ring.
3918 With ARG, rotate that many kills forward (or backward, if negative)."
3921 \f
3922 ;; Some kill commands.
3924 ;; Internal subroutine of delete-char
3930 ;; Internal subroutine of backward-delete-char
3937 "The method for untabifying when deleting backward.
3938 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3939 `hungry' -- delete all whitespace, both tabs and spaces;
3940 `all' -- delete all whitespace, including tabs, spaces and newlines;
3941 nil -- just delete one character."
3947 "Delete characters backward, changing tabs into spaces.
3948 The exact behavior depends on `backward-delete-char-untabify-method'.
3949 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3950 Interactively, ARG is the prefix arg (default 1)
3951 and KILLP is t if a prefix arg was specified."
3974 arg)))
3975 ;; Avoid warning about delete-backward-char
3979 "Kill up to and including ARGth occurrence of CHAR.
3980 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3981 Goes backward if ARG is negative; error if CHAR not found."
3984 ;; Avoid "obsolete" warnings for translation-table-for-input.
3992 ;; kill-line and its subroutines.
3995 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4000 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4001 With prefix argument ARG, kill that many lines from point.
4002 Negative arguments kill lines backward.
4003 With zero argument, kills the text before point on the current line.
4006 a number counts as a prefix arg.
4008 To kill a whole line, when point is not at the beginning, type \
4011 If `show-trailing-whitespace' is non-nil, this command will just
4012 kill the rest of the current line, even if there are only
4013 nonblanks there.
4015 If option `kill-whole-line' is non-nil, then this command kills the whole line
4016 including its terminating newline, when used at the beginning of a line
4017 with no argument. As a consequence, you can always kill a whole line
4020 If you want to append the killed line to the last killed text,
4023 If the buffer is read-only, Emacs will beep and refrain from deleting
4024 the line, but put the line in the kill ring anyway. This means that
4025 you can use this command to copy text from a read-only buffer.
4026 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4027 even beep.)"
4030 ;; It is better to move point to the other end of the kill
4031 ;; before killing. That way, in a read-only buffer, point
4032 ;; moves across the text that is copied to the kill ring.
4033 ;; The choice has no effect on undo now that undo records
4034 ;; the value of point from before the command was run.
4044 ;; If trailing whitespace is visible,
4045 ;; don't treat it as nothing.
4055 "Kill current line.
4056 With prefix ARG, kill that many lines starting from the current line.
4057 If ARG is negative, kill backward. Also kill the preceding newline.
4059 If ARG is zero, kill current line but exclude the trailing newline."
4070 ;; We need to kill in two steps, because the previous command
4071 ;; could have been a kill command, in which case the text
4072 ;; before point needs to be prepended to the current kill
4073 ;; ring entry and the text after point appended. Also, we
4074 ;; need to use save-excursion to avoid copying the same text
4075 ;; twice to the kill ring in read-only buffers.
4093 "Move forward by ARG lines, ignoring currently invisible newlines only.
4094 If ARG is negative, move backward -ARG lines.
4095 If ARG is zero, move to the beginning of the current line."
4102 ;; If the newline we just skipped is invisible,
4103 ;; don't count it.
4107 prop
4112 ;; If invisible text follows, and it is a number of complete lines,
4113 ;; skip it.
4119 prop
4135 ;; If the newline we just moved to is invisible,
4136 ;; don't count it.
4141 prop
4146 ;; If invisible text follows, and it is a number of complete lines,
4147 ;; skip it.
4153 prop
4164 nil)))
4167 "Move to end of current visible line."
4169 ;; If the following character is currently invisible,
4170 ;; skip all characters with that same `invisible' property value,
4171 ;; then find the next newline.
4178 prop
4187 \f
4189 "Insert after point the contents of BUFFER.
4190 Puts mark after the inserted text.
4191 BUFFER may be a buffer or a buffer name.
4193 This function is meant for the user to run interactively.
4194 Don't call it from programs: use `insert-buffer-substring' instead!"
4203 t))))
4208 nil)
4212 "Append to specified buffer the text of the region.
4213 It is inserted into that buffer before its point.
4215 When calling from a program, give three arguments:
4216 BUFFER (or buffer name), START and END.
4217 START and END specify the portion of the current buffer to be copied."
4224 point)
4235 "Prepend to specified buffer the text of the region.
4236 It is inserted into that buffer after its point.
4238 When calling from a program, give three arguments:
4239 BUFFER (or buffer name), START and END.
4240 START and END specify the portion of the current buffer to be copied."
4249 "Copy to specified buffer the text of the region.
4250 It is inserted into that buffer, replacing existing text there.
4252 When calling from a program, give three arguments:
4253 BUFFER (or buffer name), START and END.
4254 START and END specify the portion of the current buffer to be copied."
4262 \f
4266 "Hook run when the mark becomes active.
4267 It is also run at the end of a command, if the mark is active and
4274 "Return this buffer's mark value as integer, or nil if never set.
4276 In Transient Mark mode, this function signals an error if
4277 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4278 or the argument FORCE is non-nil, it disregards whether the mark
4279 is active, and returns an integer or nil in the usual way.
4281 If you are using this in an editing command, you are most likely making
4282 a mistake; see the documentation of `set-mark'."
4287 ;; Behind display-selections-p.
4294 "Deactivate the mark.
4295 If Transient Mark mode is disabled, this function normally does
4296 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4298 Deactivating the mark sets `mark-active' to nil, updates the
4299 primary selection according to `select-active-regions', and runs
4300 `deactivate-mark-hook'.
4302 If Transient Mark mode was temporarily enabled, reset the value
4303 of the variable `transient-mark-mode'; if this causes Transient
4304 Mark mode to be disabled, don't change `mark-active' to nil or
4305 run `deactivate-mark-hook'."
4309 select-active-regions)
4312 ;; The var `saved-region-selection', if non-nil, is the text in
4313 ;; the region prior to the last command modifying the buffer.
4314 ;; Set the selection to that, or to the current region.
4318 ;; If another program has acquired the selection, region
4319 ;; deactivation should not clobber it (Bug#11772).
4330 ;; When deactivating a temporary region, don't change
4331 ;; `mark-active' or run `deactivate-mark-hook'.
4339 "Activate the mark.
4340 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
4350 "Set this buffer's mark to POS. Don't use this function!
4351 That is to say, don't use this function unless you want
4352 the user to see that the mark has moved, and you want the previous
4353 mark position to be lost.
4355 Normally, when a new mark is set, the old one should go on the stack.
4356 This is why most applications should use `push-mark', not `set-mark'.
4358 Novice Emacs Lisp programmers often try to use the mark for the wrong
4359 purposes. The mark saves a location for the user's convenience.
4360 Most editing commands should not alter the mark.
4361 To remember a location for internal use in the Lisp program,
4362 store it in a Lisp variable. Example:
4364 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4369 ;; Normally we never clear mark-active except in Transient Mark mode.
4370 ;; But when we actually clear out the mark value too, we must
4371 ;; clear mark-active in any mode.
4376 If nil, region-aware commands treat empty regions as inactive.
4377 If non-nil, region-aware commands treat the region as active as
4378 long as the mark is active, even if the region is empty.
4380 Region-aware commands are those that act on the region if it is
4381 active and Transient Mark mode is enabled, and on the text near
4382 point otherwise."
4388 "Return t if the region is active and it is appropriate to act on it.
4389 This is used by commands that act specially on the region under
4390 Transient Mark mode.
4392 The return value is t if Transient Mark mode is enabled and the
4393 mark is active; furthermore, if `use-empty-active-region' is nil,
4394 the region must not be empty. Otherwise, the return value is nil.
4396 For some commands, it may be appropriate to ignore the value of
4397 `use-empty-active-region'; in that case, use `region-active-p'."
4402 "Return t if Transient Mark mode is enabled and the mark is active.
4404 Some commands act specially on the region when Transient Mark
4405 mode is enabled. Usually, such commands should use
4406 `use-region-p' instead of this function, because `use-region-p'
4407 also checks the value of `use-empty-active-region'."
4421 nrol)
4426 rol)))
4439 start end window rol)))
4442 new)))))))
4467 "Maximum size of mark ring. Start discarding off end if gets this big."
4475 "Maximum size of global mark ring. \
4476 Start discarding off end if gets this big."
4481 "Jump to mark, and pop a new position for mark off the ring.
4482 \(Does not affect global mark ring\)."
4492 "Set mark at where point is.
4493 If no prefix ARG and mark is already set there, just activate it.
4494 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4506 will pop the mark twice, and
4508 will pop the mark three times.
4516 "Set the mark where point is, or jump to the mark.
4517 Setting the mark also alters the region, which is the text
4518 between point and mark; this is the closest equivalent in
4521 With no prefix argument, set the mark at point, and push the
4522 old mark position on local mark ring. Also push the old mark on
4523 global mark ring, if the previous mark was set in another buffer.
4525 When Transient Mark Mode is off, immediately repeating this
4526 command activates `transient-mark-mode' temporarily.
4529 jump to the mark, and set the mark from
4530 position popped off the local mark ring \(this does not affect the global
4532 mark ring \(see `pop-global-mark'\).
4534 If `set-mark-command-repeat-pop' is non-nil, repeating
4536 off the local (or global) mark ring and jumps there.
4539 argument, unconditionally set mark where point is, even if
4540 `set-mark-command-repeat-pop' is non-nil.
4542 Novice Emacs Lisp programmers often try to use the mark for the wrong
4543 purposes. See the documentation of `set-mark' for more information."
4579 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4580 If the last global mark pushed was not in the current buffer,
4581 also push LOCATION on the global mark ring.
4582 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4584 Novice Emacs Lisp programmers often try to use the mark for the wrong
4585 purposes. See the documentation of `set-mark' for more information.
4587 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4594 ;; Now push the mark on the global mark ring.
4597 ;; The last global mark pushed was in this same buffer.
4598 ;; Don't push another one.
4599 nil
4608 nil)
4611 "Pop off mark ring into the buffer's actual mark.
4612 Does not set point. Does nothing if mark ring is empty."
4624 "Put the mark where point is now, and point where the mark is now.
4625 This command works even when the mark is not active,
4626 and it reactivates the mark.
4628 If Transient Mark mode is on, a prefix ARG deactivates the mark
4629 if it is active, and otherwise avoids reactivating it. If
4630 Transient Mark mode is off, a prefix ARG enables Transient Mark
4631 mode temporarily."
4645 nil))
4648 "When non-nil, shifted motion keys activate the mark momentarily.
4650 While the mark is activated in this way, any shift-translated point
4651 motion key extends the region, and if Transient Mark mode was off, it
4652 is temporarily turned on. Furthermore, the mark will be deactivated
4653 by any subsequent point motion key that was not shift-translated, or
4654 by any action that normally deactivates the mark in Transient Mark mode.
4656 See `this-command-keys-shift-translated' for the meaning of
4657 shift-translation."
4662 "Activate/deactivate mark depending on invocation thru shift translation.
4663 This function is called by `call-interactively' when a command
4664 with a `^' character in its `interactive' spec is invoked, before
4665 running the command itself.
4667 If `shift-select-mode' is enabled and the command was invoked
4668 through shift translation, set the mark and activate the region
4669 temporarily, unless it was already set in this way. See
4670 `this-command-keys-shift-translated' for the meaning of shift
4671 translation.
4673 Otherwise, if the region has been activated temporarily,
4674 deactivate it, and restore the variable `transient-mark-mode' to
4675 its earlier value."
4682 transient-mark-mode)))
4689 "Toggle Transient Mark mode.
4690 With a prefix argument ARG, enable Transient Mark mode if ARG is
4691 positive, and disable it otherwise. If called from Lisp, enable
4692 Transient Mark mode if ARG is omitted or nil.
4694 Transient Mark mode is a global minor mode. When enabled, the
4695 region is highlighted whenever the mark is active. The mark is
4697 operations that set the mark but whose main purpose is something
4703 Many commands change their behavior when Transient Mark mode is
4704 in effect and the mark is active, by acting on the region instead
4705 of their usual default part of the buffer's text. Examples of
4708 To see the documentation of commands which are sensitive to the
4711 :global t
4712 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4716 "Non-nil means it is ok for commands to call `widen' when they want to.
4717 Some commands will do this in order to go to positions outside
4718 the current accessible part of the buffer.
4720 If `widen-automatically' is nil, these commands will do something else
4724 "Whether the currently executing code is performing an essential task.
4725 This variable should be non-nil only when running code which should not
4726 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4727 user for a password when we are simply scanning a set of files in the
4728 background or displaying possible completions before the user even asked
4732 "Pop off global mark ring and jump to the top location."
4734 ;; Pop entries which refer to non-existent buffers.
4752 \f
4754 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4760 "Move cursor vertically down ARG lines.
4761 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4762 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4763 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4764 function will not vscroll.
4766 ARG defaults to 1.
4768 If there is no character in the target line exactly under the current column,
4769 the cursor is positioned after the character in that line which spans this
4770 column, or at the end of the line if it is not long enough.
4771 If there is no line in the buffer after this one, behavior depends on the
4772 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4773 to create a line, and moves the cursor to that line. Otherwise it moves the
4774 cursor to the end of the buffer.
4776 If the variable `line-move-visual' is non-nil, this command moves
4777 by display lines. Otherwise, it moves by buffer lines, without
4778 taking variable-width characters or continued lines into account.
4781 a semipermanent goal column for this command.
4782 Then instead of trying to move exactly vertically (or as close as possible),
4783 this command moves to the specified goal column (or as close as possible).
4784 The goal column is stored in the variable `goal-column', which is nil
4785 when there is no goal column. Note that setting `goal-column'
4786 overrides `line-move-visual' and causes this command to move by buffer
4787 lines rather than by display lines.
4789 If you are thinking of using this in a Lisp program, consider
4790 using `forward-line' instead. It is usually easier to use
4791 and more reliable (no dependence on goal column, etc.)."
4796 ;; When adding a newline, don't expand an abbrev.
4807 nil)
4811 "Move cursor vertically up ARG lines.
4812 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4813 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4814 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4815 function will not vscroll.
4817 ARG defaults to 1.
4819 If there is no character in the target line exactly over the current column,
4820 the cursor is positioned after the character in that line which spans this
4821 column, or at the end of the line if it is not long enough.
4823 If the variable `line-move-visual' is non-nil, this command moves
4824 by display lines. Otherwise, it moves by buffer lines, without
4825 taking variable-width characters or continued lines into account.
4828 a semipermanent goal column for this command.
4829 Then instead of trying to move exactly vertically (or as close as possible),
4830 this command moves to the specified goal column (or as close as possible).
4831 The goal column is stored in the variable `goal-column', which is nil
4832 when there is no goal column. Note that setting `goal-column'
4833 overrides `line-move-visual' and causes this command to move by buffer
4834 lines rather than by display lines.
4836 If you are thinking of using this in a Lisp program, consider using
4837 `forward-line' with a negative argument instead. It is usually easier
4838 to use and more reliable (no dependence on goal column, etc.)."
4847 nil)
4852 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4853 This means moving to the end of each line moved onto.
4854 The beginning of a blank line does not count as the end of a line.
4855 This has no effect when the variable `line-move-visual' is non-nil."
4861 A non-nil setting overrides the variable `line-move-visual', which see."
4868 "Current goal column for vertical motion.
4869 It is the column where point was at the start of the current run
4870 of vertical motion commands.
4872 When moving by visual lines via the function `line-move-visual', it is a cons
4873 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4874 divided by the default column width, and HSCROLL is the number of
4875 columns by which window is scrolled from left margin.
4877 When the `track-eol' feature is doing its job, the value is
4882 Outline mode sets this."
4887 "When non-nil, `line-move' moves point by visual lines.
4888 This movement is based on where the cursor is displayed on the
4889 screen, instead of relying on buffer contents alone. It takes
4890 into account variable-width characters and line continuation.
4891 If nil, `line-move' moves point by logical lines.
4892 A non-nil setting of `goal-column' overrides the value of this variable
4893 and forces movement by logical lines.
4894 A window that is horizontally scrolled also forces movement by logical
4895 lines."
4900 ;; Only used if display-graphic-p.
4904 "Return the height in pixels of the current buffer's default face font."
4908 ;; Avoid calling font-info if the frame's default font was
4909 ;; not changed since the frame was created. That's because
4910 ;; font-info is expensive for some fonts, see bug #14838.
4916 "Return the pixel height of current buffer's default-face text line.
4918 The value includes `line-spacing', if any, defined for the buffer
4919 or the frame."
4932 "Return the number of screen lines in the text area of the selected window.
4934 This is different from `window-text-height' in that this function counts
4935 lines in units of the height of the font used by the default face displayed
4936 in the window, not in units of the frame's default font, and also accounts
4937 for `line-spacing', if any, defined for the window's buffer or frame.
4939 The value is a floating-point number."
4945 ;; Returns non-nil if partial move was done.
4948 ;; Move backward (up).
4949 ;; If already vscrolled, reduce vscroll
4955 ;; Move forward (down).
4968 py vs last-line)
4988 col-row)
4993 ;; VPOS > 0 means the last line is only partially visible.
4994 ;; But if the part that is visible is at least as tall as the
4995 ;; default font, that means the line is actually fully
4996 ;; readable, and something like line-spacing is hidden. So in
4997 ;; that case we accept the last line in the window as still
4998 ;; visible, and consider the margin as starting one line
4999 ;; later.
5007 ;; If last line of window is fully visible, and vscrolling
5008 ;; more would make this line invisible, move forward.
5013 nil)
5014 ;; If cursor is not in the bottom scroll margin, and the
5015 ;; current line is is not too tall, move forward.
5017 vpos
5020 nil)
5021 ;; When already vscrolled, we vscroll some more if we can,
5022 ;; or clear vscroll and move forward at end of tall image.
5027 ;; If cursor just entered the bottom scroll margin, move forward,
5028 ;; but also optionally vscroll one line so redisplay won't recenter.
5032 ;; Don't vscroll if the partially-visible line at window
5033 ;; bottom is not too tall (a.k.a. "just one more text
5034 ;; line"): in that case, we do want redisplay to behave
5035 ;; normally, i.e. recenter or whatever.
5036 ;;
5037 ;; Note: ROWH + RBOT from the value returned by
5038 ;; pos-visible-in-window-p give the total height of the
5039 ;; partially-visible glyph row at the end of the window. As
5040 ;; we are dealing with floats, we disregard sub-pixel
5041 ;; discrepancies between that and DLH.
5045 t)
5046 ;; If there are lines above the last line, scroll-up one line.
5049 t)
5050 ;; Finally, start vscroll.
5055 ;; This is like line-move-1 except that it also performs
5056 ;; vertical scrolling of tall images if appropriate.
5057 ;; That is not really a clean thing to do, since it mixes
5058 ;; scrolling with cursor motion. But so far we don't have
5059 ;; a cleaner solution to the problem of making C-n do something
5060 ;; useful given a tall image.
5065 ;; Only vscroll for single line moves
5067 ;; Under scroll-conservatively, the display engine
5068 ;; does this better.
5070 ;; But don't vscroll in a keyboard macro.
5076 ;; Display-based column are incompatible with goal-column.
5078 ;; When the text in the window is scrolled to the left,
5079 ;; display-based motion doesn't make sense (because each
5080 ;; logical line occupies exactly one screen line).
5082 ;; Likewise when the text _was_ scrolled to the left
5083 ;; when the current run of vertical motion commands
5084 ;; started.
5087 auto-hscroll-mode
5089 (>= temporary-goal-column
5092 ;; If we moved into a tall line, set vscroll to make
5093 ;; scrolling through tall images more smooth.
5097 winh)
5103 nil
5107 ;; Display-based alternative to line-move-1.
5108 ;; Arg says how many lines to move. The value is t if we can move the
5109 ;; specified number of lines.
5113 target-hscroll)
5114 ;; Check if the previous command was a line-motion command, or if
5115 ;; we were called from some other command.
5118 ;; If so, there's no need to reset `temporary-goal-column',
5119 ;; but we may need to hscroll.
5123 ;; Otherwise, we should reset `temporary-goal-column'.
5126 ;; Handle the `overflow-newline-into-fringe' case:
5135 ;; vertical-motion can move more than it was asked to if it moves
5136 ;; across display strings with newlines. We don't want to ring
5137 ;; the bell and announce beginning/end of buffer in that case.
5143 temporary-goal-column))
5144 arg))
5145 arg))
5151 temporary-goal-column))
5152 arg))
5153 arg)))
5156 ;; If the goal column lies on a display string,
5157 ;; `vertical-motion' advances the cursor to the end
5158 ;; of the string. For arg < 0, this can cause the
5159 ;; cursor to get stuck. (Bug#3020).
5163 nil)))))
5165 ;; This is the guts of next-line and previous-line.
5166 ;; Arg says how many lines to move.
5167 ;; The value is t if we can move the specified number of lines.
5169 ;; Don't run any point-motion hooks, and disregard intangibility,
5170 ;; for intermediate positions.
5182 ;; Don't count beg of empty line as end of line
5183 ;; unless we just did explicit end-of-line.
5185 most-positive-fixnum
5189 line-move-ignore-invisible))
5190 ;; Use just newline characters.
5191 ;; Set ARG to 0 if we move as many lines as requested.
5194 ;; This way of moving forward ARG lines
5195 ;; verifies that we have a newline after the last one.
5196 ;; It doesn't get confused by intangible text.
5205 'beginning-of-buffer
5207 nil)))
5208 ;; Move by arg lines, but ignore invisible ones.
5211 ;; If the following character is currently invisible,
5212 ;; skip all characters with that same `invisible' property value.
5215 ;; Move a line.
5216 ;; We don't use `end-of-line', since we want to escape
5217 ;; from field boundaries occurring exactly at point.
5223 ;; If there's no invisibility here, move over the newline.
5232 ;; We avoid vertical-motion when possible
5233 ;; because that has to fontify.
5235 ;; Otherwise move a more sophisticated way.
5242 ;; The logic of this is the same as the loop above,
5243 ;; it just goes in the other direction.
5245 ;; For completely consistency with the forward-motion
5246 ;; case, we should call beginning-of-line here.
5247 ;; However, if point is inside a field and on a
5248 ;; continued line, the call to (vertical-motion -1)
5249 ;; below won't move us back far enough; then we return
5250 ;; to the same column in line-move-finish, and point
5251 ;; gets stuck -- cyd
5269 ;; if our target is the middle of this line.
5274 ;; This is the value the function returns.
5278 ;; If we did not move down as far as desired, at least go
5279 ;; to end of line. Be sure to call point-entered and
5280 ;; point-left-hooks.
5286 ;; If we did not move up as far as desired,
5287 ;; at least go to beginning of line.
5299 ;; Set REPEAT to t to repeat the whole thing.
5306 ;; Compute the end of the line
5307 ;; ignoring effectively invisible newlines.
5309 ;; Like end-of-line but ignores fields.
5316 ;; Move to the desired column.
5319 ;; Corner case: suppose we start out in a field boundary in
5320 ;; the middle of a continued line. When we get to
5321 ;; line-move-finish, point is at the start of a new *screen*
5322 ;; line but the same text line; then line-move-to-column would
5323 ;; move us backwards. Test using C-n with point on the "x" in
5324 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5331 ;; Process intangibility within a line.
5332 ;; With inhibit-point-motion-hooks bound to nil, a call to
5333 ;; goto-char moves point past intangible text.
5335 ;; However, inhibit-point-motion-hooks controls both the
5336 ;; intangibility and the point-entered/point-left hooks. The
5337 ;; following hack avoids calling the point-* hooks
5338 ;; unnecessarily. Note that we move *forward* past intangible
5339 ;; text when the initial and final points are the same.
5344 ;; If intangibility moves us to a different (later) place
5345 ;; in the same line, use that as the destination.
5348 ;; If that position is "too late",
5349 ;; try the previous allowable position.
5350 ;; See if it is ok.
5353 ;; If going forward, don't accept the previous
5354 ;; allowable position if it is before the target line.
5356 ;; If going backward, don't accept the previous
5357 ;; allowable position if it is still after the target line.
5360 ;; As a last resort, use the end of the line.
5363 ;; Now move to the updated destination, processing fields
5364 ;; as well as intangibility.
5368 ;; Ignore field boundaries if the initial and final
5369 ;; positions have the same `field' property, even if the
5370 ;; fields are non-contiguous. This seems to be "nicer"
5371 ;; behavior in many situations.
5374 new
5378 ;; If all this moved us to a different line,
5379 ;; retry everything within that new line.
5381 ;; Repeat the intangibility and field processing.
5385 "Try to find column COL, considering invisibility.
5386 This function works only in certain cases,
5387 because what we really need is for `move-to-column'
5388 and `current-column' to be able to ignore invisible text."
5397 ;; If the following character is currently invisible,
5398 ;; skip all characters with that same `invisible' property value.
5402 ;; Have we advanced to a larger column position?
5404 ;; We have made some progress towards the desired column.
5405 ;; See if we can make any further progress.
5407 ;; Otherwise, go to the place we originally found
5408 ;; and move back over invisible text.
5409 ;; that will get us to the same place on the screen
5410 ;; but with a more reasonable buffer position.
5417 "Move point to end of current line as displayed.
5418 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5419 If point reaches the beginning or end of buffer, it stops there.
5421 To ignore the effects of the `intangible' text or overlay
5422 property, bind `inhibit-point-motion-hooks' to t.
5423 If there is an image in the current line, this function
5424 disregards newlines that are part of the text on which the image
5425 rests."
5435 ;; With bidi reordering, we may not be at bol,
5436 ;; so make sure we are.
5451 ;; If we skipped something intangible and now we're not
5452 ;; really at eol, keep going.
5457 "Move point to beginning of current line as displayed.
5458 \(If there's an image in the line, this disregards newlines
5459 which are part of the text that the image rests on.)
5461 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5462 If point reaches the beginning or end of buffer, it stops there.
5463 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5468 first-vis first-vis-field-value)
5470 ;; Move by lines, if ARG is not 1 (the default).
5475 ;; Move to beginning-of-line, ignoring fields and invisible text.
5481 ;; Now find first visible char in the line
5486 ;; See if fields would stop us from reaching FIRST-VIS.
5491 ;; If yes, obey them.
5492 first-vis-field-value
5493 ;; Otherwise, move to START with attention to fields.
5494 ;; (It is possible that fields never matter in this case.)
5499 ;; Many people have said they rarely use this feature, and often type
5500 ;; it by accident. Maybe it shouldn't even be on a key.
5505 Those commands will move to this position in the line moved to
5506 rather than trying to keep the same horizontal position.
5507 With a non-nil argument ARG, clears out the goal column
5509 The goal column is stored in the variable `goal-column'."
5516 ;; The older method below can be erroneous if `set-goal-column' is bound
5517 ;; to a sequence containing %
5518 ;;(message (substitute-command-keys
5519 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
5520 ;;goal-column)
5527 )
5528 nil)
5529 \f
5530 ;;; Editing based on visual lines, as opposed to logical lines.
5533 "Move point to end of current visual line.
5534 With argument N not nil or 1, move forward N - 1 visual lines first.
5535 If point reaches the beginning or end of buffer, it stops there.
5536 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5542 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5543 ;; constrain to field boundaries, so we don't either.
5547 "Move point to beginning of current visual line.
5548 With argument N not nil or 1, move forward N - 1 visual lines first.
5549 If point reaches the beginning or end of buffer, it stops there.
5550 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5558 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5562 "Kill the rest of the visual line.
5563 With prefix argument ARG, kill that many visual lines from point.
5564 If ARG is negative, kill visual lines backward.
5565 If ARG is zero, kill the text before point on the current visual
5566 line.
5568 If you want to append the killed line to the last killed text,
5571 If the buffer is read-only, Emacs will beep and refrain from deleting
5572 the line, but put the line in the kill ring anyway. This means that
5573 you can use this command to copy text from a read-only buffer.
5574 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5575 even beep.)"
5577 ;; Like in `kill-line', it's better to move point to the other end
5578 ;; of the kill before killing.
5586 ;; Skip any trailing whitespace at the end of the visual line.
5587 ;; We used to do this only if `show-trailing-whitespace' is
5588 ;; nil, but that's wrong; the correct thing would be to check
5589 ;; whether the trailing whitespace is highlighted. But, it's
5590 ;; OK to just do this unconditionally.
5597 "Move cursor vertically down ARG lines.
5598 This is identical to `next-line', except that it always moves
5599 by logical lines instead of visual lines, ignoring the value of
5600 the variable `line-move-visual'."
5607 "Move cursor vertically up ARG lines.
5608 This is identical to `previous-line', except that it always moves
5609 by logical lines instead of visual lines, ignoring the value of
5610 the variable `line-move-visual'."
5617 "Editing based on visual lines."
5626 ;; These keybindings interfere with xterm function keys. Are
5627 ;; there any other suitable bindings?
5628 ;; (define-key map "\M-[" 'previous-logical-line)
5629 ;; (define-key map "\M-]" 'next-logical-line)
5630 map))
5633 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5634 The value should be a list of the form (LEFT RIGHT), where LEFT
5635 and RIGHT are symbols representing the bitmaps to display, to
5636 indicate wrapped lines, in the left and right fringes respectively.
5637 See also `fringe-indicator-alist'.
5638 The default is not to display fringe indicators for wrapped lines.
5639 This variable does not affect fringe indicators displayed for
5640 other purposes."
5655 'continuation
5662 "Toggle visual line based editing (Visual Line mode).
5663 With a prefix argument ARG, enable Visual Line mode if ARG is
5664 positive, and disable it otherwise. If called from Lisp, enable
5665 the mode if ARG is omitted or nil.
5667 When Visual Line mode is enabled, `word-wrap' is turned on in
5668 this buffer, and simple editing commands are redefined to act on
5669 visual lines, not logical lines. See Info node `Visual Line
5670 Mode' for details."
5671 :keymap visual-line-mode-map
5677 ;; Save the local values of some variables, to be restored if
5678 ;; visual-line-mode is turned off.
5680 truncate-partial-width-windows
5681 word-wrap fringe-indicator-alist))
5684 visual-line--saved-state)))
5688 word-wrap t
5689 fringe-indicator-alist
5691 fringe-indicator-alist)))
5705 visual-line-mode turn-on-visual-line-mode)
5707 \f
5709 "Interchange characters around point, moving forward one character.
5710 With prefix arg ARG, effect is to take character before point
5711 and drag it forward past ARG other characters (backward if ARG negative).
5712 If no argument and at end of line, the previous two chars are exchanged."
5718 "Interchange words around point, leaving point at end of them.
5719 With prefix arg ARG, effect is to take word before or around point
5720 and drag it forward past ARG other words (backward if ARG negative).
5721 If ARG is zero, the words around or after point and around or after mark
5722 are interchanged."
5723 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5729 Does not work on a sexp that point is in the middle of
5730 if it is a list or string."
5734 ;; Here we should try to simulate the behavior of
5735 ;; (cons (progn (forward-sexp x) (point))
5736 ;; (progn (forward-sexp (- x)) (point)))
5737 ;; Except that we don't want to rely on the second forward-sexp
5738 ;; putting us back to where we want to be, since forward-sexp-function
5739 ;; might do funny things like infix-precedence.
5744 ;; Jumping over a symbol. We might be inside it, mind you.
5749 ;; Otherwise, we're between sexps. Take a step back before jumping
5750 ;; to make sure we'll obey the same precedence no matter which direction
5751 ;; we're going.
5756 'skip-syntax-forward
5763 "Exchange current line and previous line, leaving point after both.
5764 With argument ARG, takes previous line and moves it past ARG lines.
5765 With argument 0, interchanges line point is in with line mark is in."
5771 ;; Move forward over ARG lines,
5772 ;; but create newlines if necessary.
5779 arg))
5781 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5782 ;; which seems inconsistent with the ARG /= 0 case.
5783 ;; FIXME document SPECIAL.
5785 "Subroutine to do the work of transposing objects.
5786 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5787 moves forward by units of the given object (e.g. forward-sentence,
5788 forward-paragraph). If ARG is zero, exchanges the current object
5789 with the one containing mark. If ARG is an integer, moves the
5790 current object past ARG following (if ARG is positive) or
5791 preceding (if ARG is negative) objects, leaving point after the
5792 current object."
5797 pos1 pos2)
5825 ;; This sequence of insertions attempts to preserve marker
5826 ;; positions at the start and end of the transposed objects.
5840 \f
5842 "Move backward until encountering the beginning of a word.
5843 With argument ARG, do this that many times.
5844 If ARG is omitted or nil, move point backward one word."
5849 "Set mark ARG words away from point.
5851 move to with the same argument.
5852 Interactively, if this command is repeated
5853 or (in Transient Mark mode) if the mark is active,
5854 it marks the next ARG words after the ones already marked."
5871 nil t))))
5874 "Kill characters forward until encountering the end of a word.
5875 With argument ARG, do this that many times."
5880 "Kill characters backward until encountering the beginning of a word.
5881 With argument ARG, do this that many times."
5886 "Return the symbol or word that point is on (or a nearby one) as a string.
5887 The return value includes no text properties.
5888 If optional arg STRICT is non-nil, return nil unless point is within
5889 or adjacent to a symbol or word. In all cases the value can be nil
5890 if there is no word nearby.
5891 The function, belying its name, normally finds a symbol.
5892 If optional arg REALLY-WORD is non-nil, it finds just a word."
5901 ;; Point is neither within nor adjacent to a word.
5903 ;; Look for preceding word in same line.
5906 ;; No preceding word in same line.
5907 ;; Look for following word in same line.
5916 ;; If we found something nonempty, return it as a string.
5919 \f
5921 "String for filling to insert at front of new line, or nil for none."
5923 string)
5929 "Regexp to match lines which should not be auto-filled."
5931 regexp)
5935 "The default value for `normal-auto-fill-function'.
5936 This is the default auto-fill function, some major modes use a different one.
5937 Returns t if it really did any work."
5947 nil ;; Auto-filling not required
5951 ;; Choose a fill-prefix automatically.
5959 ;; Use auto-indentation rather than a guessed empty prefix.
5965 ;; Determine where to split the line.
5978 ;; See whether the place we found is any good.
5982 ;; There is no use breaking at end of line.
5984 ;; It is futile to split at the end of the prefix
5985 ;; since we would just insert the prefix again.
5987 ;; Don't split right after a comment starter
5988 ;; since we would just make another comment starter.
5993 limit t)
5995 ;; No good place to break => stop trying.
5997 ;; Ok, we have a useful place to break the line. Do it.
5999 ;; If point is at the fill-point, do not `save-excursion'.
6000 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6001 ;; point will end up before it rather than after it.
6009 ;; Now do justification, if required
6014 ;; If making the new line didn't reduce the hpos of
6015 ;; the end of the line, then give up now;
6016 ;; trying again will not help.
6019 ;; Justify last line.
6021 t)))
6024 "Mode-specific function which line breaks and continues a comment.
6025 This function is called during auto-filling when a comment syntax
6026 is defined.
6027 The function should take a single optional argument, which is a flag
6031 "Break line at point and indent.
6032 If a comment syntax is defined, call `comment-indent-new-line'.
6034 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6035 unless optional argument SOFT is non-nil."
6039 ;; Insert the newline before removing empty space so that markers
6040 ;; get preserved better.
6046 ;; Blindly trust a non-adaptive fill-prefix.
6052 ;; If there's an adaptive prefix, use it unless we're inside
6053 ;; a comment and the prefix is not a comment starter.
6057 ;; If we're not inside a comment, just try to indent.
6061 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6065 ;; `functions' and `hooks' are usually unsafe to set, but setting
6066 ;; auto-fill-function to nil in a file-local setting is safe and
6067 ;; can be useful to prevent auto-filling.
6071 "Toggle automatic line breaking (Auto Fill mode).
6072 With a prefix argument ARG, enable Auto Fill mode if ARG is
6073 positive, and disable it otherwise. If called from Lisp, enable
6074 the mode if ARG is omitted or nil.
6076 When Auto Fill mode is enabled, inserting a space at a column
6077 beyond `current-fill-column' automatically breaks the line at a
6078 previous space.
6080 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6081 non-`nil'.
6083 The value of `normal-auto-fill-function' specifies the function to use
6084 for `auto-fill-function' when turning Auto Fill mode on."
6089 ;; This holds a document string used to document auto-fill-mode.
6091 "Automatically break line at a previous space, in insertion of text."
6092 nil)
6095 "Unconditionally turn on Auto Fill mode."
6099 "Unconditionally turn off Auto Fill mode."
6105 "Set `fill-column' to specified argument.
6110 ;; We used to use current-column silently, but C-x f is too easily
6111 ;; typed as a typo for C-x C-f, so we turned it into an error and
6112 ;; now an interactive prompt.
6117 ;; Disallow missing argument; it's probably a typo for C-x C-f.
6121 \f
6123 "Set `selective-display' to ARG; clear it if no arg.
6124 When the value of `selective-display' is a number > 0,
6125 lines whose indentation is >= that value are not displayed.
6126 The variable `selective-display' has a separate value for each buffer."
6146 "Toggle truncating of long lines for the current buffer.
6147 When truncating is off, long lines are folded.
6148 With prefix argument ARG, truncate long lines if ARG is positive,
6149 otherwise fold them. Note that in side-by-side windows, this
6150 command has no effect if `truncate-partial-width-windows' is
6151 non-nil."
6163 nil t)))
6168 "Toggle whether to use word-wrapping for continuation lines.
6169 With prefix argument ARG, wrap continuation lines at word boundaries
6170 if ARG is positive, otherwise wrap them at the right screen edge.
6171 This command toggles the value of `word-wrap'. It has no effect
6172 if long lines are truncated."
6188 "Toggle Overwrite mode.
6189 With a prefix argument ARG, enable Overwrite mode if ARG is
6190 positive, and disable it otherwise. If called from Lisp, enable
6191 the mode if ARG is omitted or nil.
6193 When Overwrite mode is enabled, printing characters typed in
6194 replace existing text on a one-for-one basis, rather than pushing
6195 it to the right. At the end of a line, such characters extend
6196 the line. Before a tab, such characters insert until the tab is
6198 overwrite mode; this is supposed to make it easier to insert
6199 characters when necessary."
6204 "Toggle Binary Overwrite mode.
6205 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6206 is positive, and disable it otherwise. If called from Lisp,
6207 enable the mode if ARG is omitted or nil.
6209 When Binary Overwrite mode is enabled, printing characters typed
6210 in replace existing text. Newlines are not treated specially, so
6211 typing at the end of a line joins the line to the next, with the
6212 typed character between them. Typing before a tab character
6213 simply replaces the tab with the character typed.
6215 ordinary typing characters do.
6217 Note that Binary Overwrite mode is not its own minor mode; it is
6218 a specialization of overwrite mode, entered by setting the
6219 `overwrite-mode' variable to `overwrite-mode-binary'."
6224 "Toggle line number display in the mode line (Line Number mode).
6225 With a prefix argument ARG, enable Line Number mode if ARG is
6226 positive, and disable it otherwise. If called from Lisp, enable
6227 the mode if ARG is omitted or nil.
6229 Line numbers do not appear for very large buffers and buffers
6230 with very long lines; see variables `line-number-display-limit'
6231 and `line-number-display-limit-width'."
6235 "Toggle column number display in the mode line (Column Number mode).
6236 With a prefix argument ARG, enable Column Number mode if ARG is
6237 positive, and disable it otherwise.
6239 If called from Lisp, enable the mode if ARG is omitted or nil."
6243 "Toggle buffer size display in the mode line (Size Indication mode).
6244 With a prefix argument ARG, enable Size Indication mode if ARG is
6245 positive, and disable it otherwise.
6247 If called from Lisp, enable the mode if ARG is omitted or nil."
6251 "Toggle auto-saving in the current buffer (Auto Save mode).
6252 With a prefix argument ARG, enable Auto Save mode if ARG is
6253 positive, and disable it otherwise.
6255 If called from Lisp, enable the mode if ARG is omitted or nil."
6257 ;; If auto-save is off because buffer has shrunk,
6258 ;; then toggling should turn it on.
6266 buffer-file-name)
6268 ;; If -1 was stored here, to temporarily turn off saving,
6269 ;; turn it back on.
6272 \f
6274 "Blinking matching of parens and expressions."
6279 "Non-nil means show matching open-paren when close-paren is inserted."
6284 "Non-nil means show matching open-paren when it is on screen.
6285 If nil, don't show it (but the open-paren can still be shown
6286 when it is off screen).
6288 This variable has no effect if `blink-matching-paren' is nil.
6289 \(In that case, the open-paren is never shown.)
6290 It is also ignored if `show-paren-mode' is enabled."
6295 "If non-nil, maximum distance to search backwards for matching open-paren.
6296 If nil, search stops at the beginning of the accessible portion of the buffer."
6302 "Time in seconds to delay after showing a matching paren."
6307 "If nil, `blink-matching-paren' ignores comments.
6308 More precisely, when looking for the matching parenthesis,
6309 it skips the contents of comments that end before point."
6314 "Return whether or not START...END are matching parens.
6315 END is the current point and START is the blink position.
6316 START might be nil if no matching starter was found.
6317 Returns non-nil if we find there is a mismatch."
6322 ;; For self-matched chars like " and $, we can't know when they're
6323 ;; mismatched or unmatched, so we can only do it for parens.
6328 ;; The cdr might hold a new paren-class info rather than
6329 ;; a matching-char info, in which case the two CDRs
6330 ;; should match.
6334 "Function to check parentheses mismatches.
6335 The function takes two arguments (START and END) where START is the
6336 position just before the opening token and END is the position right after.
6337 START can be nil, if it was not found.
6344 ol)
6348 "Momentarily highlight the beginning of the sexp before point."
6351 blink-matching-paren)
6361 oldpos))
6368 ;; backward-sexp skips backward over prefix chars,
6369 ;; so move back to the matching paren.
6390 ;; Matching open within window, temporarily highlight char
6391 ;; after blinkpos but only if `blink-matching-paren-on-screen'
6392 ;; is non-nil.
6405 ;; Show what precedes the open in its line, if anything.
6410 ;; Show what follows the open in its line, if anything.
6417 ;; Otherwise show the previous nonblank line,
6418 ;; if there is one.
6427 ;; Replace the newline and other whitespace with `...'.
6428 "..."
6430 ;; There is nothing to show except the char itself.
6436 "Function called, if non-nil, whenever a close parenthesis is inserted.
6442 blink-paren-function
6445 ;; Verify an even number of quoting characters precede the close.
6456 ;; Most likely, this hook is nil, so this arg doesn't matter,
6457 ;; but I use it as a reminder that this function usually
6458 ;; likes to be run after others since it does
6459 ;; `sit-for'. That's also the reason it get a `priority' prop
6460 ;; of 100.
6462 \f
6463 ;; This executes C-g typed while Emacs is waiting for a command.
6464 ;; Quitting out of a program does not go through here;
6465 ;; that happens in the QUIT macro at the C code level.
6467 "Signal a `quit' condition.
6468 During execution of Lisp code, this character causes a quit directly.
6469 At top-level, as an editor command, this simply beeps."
6471 ;; Avoid adding the region to the window selection.
6488 This command can exit an interactive command such as `query-replace',
6489 can clear out a prefix argument or a region,
6490 can get out of the minibuffer or other recursive edit,
6491 cancel the use of the current buffer (for special-purpose buffers),
6492 or go back to just one window (by deleting all but the selected window)."
6500 nil)
6511 "Play sound stored in FILE.
6512 VOLUME and DEVICE correspond to the keywords of the sound
6513 specification for `play-sound'."
6523 \f
6525 "Your preference for a mail reading package.
6526 This is used by some keybindings which support reading mail.
6527 See also `mail-user-agent' concerning sending mail."
6537 "Your preference for a mail composition package.
6538 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6539 outgoing email message. This variable lets you specify which
6540 mail-sending package you prefer.
6542 Valid values include:
6544 `message-user-agent' -- use the Message package.
6545 See Info node `(message)'.
6546 `sendmail-user-agent' -- use the Mail package.
6547 See Info node `(emacs)Sending Mail'.
6548 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6549 See Info node `(mh-e)'.
6550 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6551 paraphernalia if Gnus is running, particularly
6552 the Gcc: header for archiving.
6554 Additional valid symbols may be available; check with the author of
6555 your package for details. The function should return non-nil if it
6556 succeeds.
6558 See also `read-mail-command' concerning reading mail."
6561 message-user-agent)
6564 sendmail-user-agent)
6567 mh-e-user-agent)
6570 gnus-user-agent)
6576 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6577 If the value of `mail-user-agent' is the default, and the user
6578 appears to have customizations applying to the old default,
6579 `compose-mail' issues a warning."
6585 "If the buffer starts with a mail header, move point to the header's end.
6586 Otherwise, moves to `point-min'.
6587 The end of the header is the start of the next line, if there is one,
6588 else the end of the last line. This function obeys RFC822."
6594 ;; Used by Rmail (e.g., rmail-forward).
6596 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6600 switch-function yank-action send-actions
6601 return-action)
6602 "Start composing a mail message to send.
6603 This uses the user's chosen mail composition package
6604 as selected with the variable `mail-user-agent'.
6605 The optional arguments TO and SUBJECT specify recipients
6606 and the initial Subject field, respectively.
6608 OTHER-HEADERS is an alist specifying additional
6609 header fields. Elements look like (HEADER . VALUE) where both
6610 HEADER and VALUE are strings.
6612 CONTINUE, if non-nil, says to continue editing a message already
6613 being composed. Interactively, CONTINUE is the prefix argument.
6615 SWITCH-FUNCTION, if non-nil, is a function to use to
6616 switch to and display the buffer used for mail composition.
6618 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6619 to insert the raw text of the message being replied to.
6620 It has the form (FUNCTION . ARGS). The user agent will apply
6621 FUNCTION to ARGS, to insert the raw text of the original message.
6622 \(The user agent will also run `mail-citation-hook', *after* the
6623 original text has been inserted in this way.)
6625 SEND-ACTIONS is a list of actions to call when the message is sent.
6626 Each action has the form (FUNCTION . ARGS).
6628 RETURN-ACTION, if non-nil, is an action for returning to the
6629 caller. It has the form (FUNCTION . ARGS). The function is
6630 called after the mail has been sent or put aside, and the mail
6631 buffer buried."
6635 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6636 ;; from sendmail-user-agent to message-user-agent. Some users may
6637 ;; encounter incompatibilities. This hack tries to detect problems
6638 ;; and warn about them.
6643 mail-yank-hooks mail-archive-file-name
6644 mail-default-reply-to mail-mailing-lists
6645 mail-self-blind))
6652 The default mail mode is now Message mode.
6653 You have the following Mail mode variable%s customized:
6655 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6662 yank-action send-actions return-action)))
6665 yank-action send-actions
6666 return-action)
6670 'switch-to-buffer-other-window yank-action send-actions
6671 return-action))
6674 yank-action send-actions
6675 return-action)
6679 'switch-to-buffer-other-frame yank-action send-actions
6680 return-action))
6682 \f
6684 "History of values entered with `set-variable'.
6686 Maximum length of the history list is determined by the value
6690 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6691 VARIABLE should be a user option variable name, a Lisp variable
6692 meant to be customized by users. You should enter VALUE in Lisp syntax,
6693 so if you want VALUE to be a string, you must surround it with doublequotes.
6694 VALUE is used literally, not evaluated.
6696 If VARIABLE has a `variable-interactive' property, that is used as if
6697 it were the arg to `interactive' (which see) to interactively read VALUE.
6699 If VARIABLE has been defined with `defcustom', then the type information
6700 in the definition is used to check that VALUE is valid.
6702 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6707 default-var)
6723 var obsolete)
6726 ;; Use VAR's `variable-interactive' property
6727 ;; as an interactive spec for prompting.
6730 arg))
6732 read-expression-map t
6733 'set-variable-value-history
6742 ;; Match with custom type.
6754 ;; Force a thorough redisplay for the case that the variable
6755 ;; has an effect on the display, like `tab-width' has.
6757 \f
6758 ;; Define the major mode for lists of completions.
6768 (define-key map [right] 'next-completion)
6769 (define-key map "q" 'quit-window)
6770 (define-key map "z" 'kill-this-buffer)
6771 map)
6772 "Local map for completion list buffers.")
6774 ;; Completion mode is suitable only for specially formatted data.
6775 (put 'completion-list-mode 'mode-class 'special)
6777 (defvar completion-reference-buffer nil
6778 "Record the buffer that was current when the completion list was requested.
6779 This is a local variable in the completion list buffer.
6780 Initial value is nil to avoid some compiler warnings.")
6782 (defvar completion-no-auto-exit nil
6783 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6784 This also applies to other functions such as `choose-completion'.")
6786 (defvar completion-base-position nil
6787 "Position of the base of the text corresponding to the shown completions.
6788 This variable is used in the *Completions* buffers.
6789 Its value is a list of the form (START END) where START is the place
6790 where the completion should be inserted and END (if non-nil) is the end
6791 of the text to replace. If END is nil, point is used instead.")
6793 (defvar completion-list-insert-choice-function #'completion--replace
6794 "Function to use to insert the text chosen in *Completions*.
6795 Called with three arguments (BEG END TEXT), it should replace the text
6796 between BEG and END with TEXT. Expected to be set buffer-locally
6797 in the *Completions* buffer.")
6799 (defvar completion-base-size nil
6800 "Number of chars before point not involved in completion.
6801 This is a local variable in the completion list buffer.
6802 It refers to the chars in the minibuffer if completing in the
6803 minibuffer, or in `completion-reference-buffer' otherwise.
6804 Only characters in the field at point are included.
6806 If nil, Emacs determines which part of the tail end of the
6807 buffer's text is involved in completion by comparing the text
6808 directly.")
6809 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6811 (defun delete-completion-window ()
6812 "Delete the completion list window.
6813 Go to the window from which completion was requested."
6814 (interactive)
6815 (let ((buf completion-reference-buffer))
6816 (if (one-window-p t)
6817 (if (window-dedicated-p) (delete-frame))
6818 (delete-window (selected-window))
6819 (if (get-buffer-window buf)
6820 (select-window (get-buffer-window buf))))))
6822 (defun previous-completion (n)
6823 "Move to the previous item in the completion list."
6824 (interactive "p")
6825 (next-completion (- n)))
6827 (defun next-completion (n)
6828 "Move to the next item in the completion list.
6829 With prefix argument N, move N items (negative N means move backward)."
6830 (interactive "p")
6831 (let ((beg (point-min)) (end (point-max)))
6832 (while (and (> n 0) (not (eobp)))
6833 ;; If in a completion, move to the end of it.
6834 (when (get-text-property (point) 'mouse-face)
6835 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6836 ;; Move to start of next one.
6837 (unless (get-text-property (point) 'mouse-face)
6838 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6839 (setq n (1- n)))
6840 (while (and (< n 0) (not (bobp)))
6841 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6842 ;; If in a completion, move to the start of it.
6843 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6844 (goto-char (previous-single-property-change
6845 (point) 'mouse-face nil beg)))
6846 ;; Move to end of the previous completion.
6847 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6848 (goto-char (previous-single-property-change
6849 (point) 'mouse-face nil beg)))
6850 ;; Move to the start of that one.
6851 (goto-char (previous-single-property-change
6852 (point) 'mouse-face nil beg))
6853 (setq n (1+ n))))))
6855 (defun choose-completion (&optional event)
6856 "Choose the completion at point."
6857 (interactive (list last-nonmenu-event))
6858 ;; In case this is run via the mouse, give temporary modes such as
6859 ;; isearch a chance to turn off.
6860 (run-hooks 'mouse-leave-buffer-hook)
6861 (with-current-buffer (window-buffer (posn-window (event-start event)))
6862 (let ((buffer completion-reference-buffer)
6863 (base-size completion-base-size)
6864 (base-position completion-base-position)
6865 (insert-function completion-list-insert-choice-function)
6866 (choice
6867 (save-excursion
6868 (goto-char (posn-point (event-start event)))
6869 (let (beg end)
6870 (cond
6871 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6872 (setq end (point) beg (1+ (point))))
6873 ((and (not (bobp))
6874 (get-text-property (1- (point)) 'mouse-face))
6875 (setq end (1- (point)) beg (point)))
6876 (t (error "No completion here")))
6877 (setq beg (previous-single-property-change beg 'mouse-face))
6878 (setq end (or (next-single-property-change end 'mouse-face)
6879 (point-max)))
6880 (buffer-substring-no-properties beg end)))))
6882 (unless (buffer-live-p buffer)
6883 (error "Destination buffer is dead"))
6884 (quit-window nil (posn-window (event-start event)))
6886 (with-current-buffer buffer
6887 (choose-completion-string
6888 choice buffer
6889 (or base-position
6890 (when base-size
6891 ;; Someone's using old completion code that doesn't know
6892 ;; about base-position yet.
6893 (list (+ base-size (field-beginning))))
6894 ;; If all else fails, just guess.
6895 (list (choose-completion-guess-base-position choice)))
6896 insert-function)))))
6898 ;; Delete the longest partial match for STRING
6899 ;; that can be found before POINT.
6900 (defun choose-completion-guess-base-position (string)
6901 (save-excursion
6902 (let ((opoint (point))
6903 len)
6904 ;; Try moving back by the length of the string.
6905 (goto-char (max (- (point) (length string))
6906 (minibuffer-prompt-end)))
6907 ;; See how far back we were actually able to move. That is the
6908 ;; upper bound on how much we can match and delete.
6909 (setq len (- opoint (point)))
6910 (if completion-ignore-case
6911 (setq string (downcase string)))
6912 (while (and (> len 0)
6913 (let ((tail (buffer-substring (point) opoint)))
6914 (if completion-ignore-case
6915 (setq tail (downcase tail)))
6916 (not (string= tail (substring string 0 len)))))
6917 (setq len (1- len))
6918 (forward-char 1))
6919 (point))))
6921 (defun choose-completion-delete-max-match (string)
6922 (declare (obsolete choose-completion-guess-base-position "23.2"))
6923 (delete-region (choose-completion-guess-base-position string) (point)))
6925 (defvar choose-completion-string-functions nil
6926 "Functions that may override the normal insertion of a completion choice.
6927 These functions are called in order with four arguments:
6928 CHOICE - the string to insert in the buffer,
6929 BUFFER - the buffer in which the choice should be inserted,
6930 MINI-P - non-nil if BUFFER is a minibuffer, and
6931 BASE-SIZE - the number of characters in BUFFER before
6932 the string being completed.
6934 If a function in the list returns non-nil, that function is supposed
6935 to have inserted the CHOICE in the BUFFER, and possibly exited
6936 the minibuffer; no further functions will be called.
6938 If all functions in the list return nil, that means to use
6939 the default method of inserting the completion in BUFFER.")
6941 (defun choose-completion-string (choice &optional
6942 buffer base-position insert-function)
6943 "Switch to BUFFER and insert the completion choice CHOICE.
6944 BASE-POSITION says where to insert the completion.
6945 INSERT-FUNCTION says how to insert the completion and falls
6946 back on `completion-list-insert-choice-function' when nil."
6948 ;; If BUFFER is the minibuffer, exit the minibuffer
6949 ;; unless it is reading a file name and CHOICE is a directory,
6950 ;; or completion-no-auto-exit is non-nil.
6952 ;; Some older code may call us passing `base-size' instead of
6953 ;; `base-position'. It's difficult to make any use of `base-size',
6954 ;; so we just ignore it.
6955 (unless (consp base-position)
6956 (message "Obsolete `base-size' passed to choose-completion-string")
6957 (setq base-position nil))
6959 (let* ((buffer (or buffer completion-reference-buffer))
6960 (mini-p (minibufferp buffer)))
6961 ;; If BUFFER is a minibuffer, barf unless it's the currently
6962 ;; active minibuffer.
6963 (if (and mini-p
6964 (not (and (active-minibuffer-window)
6965 (equal buffer
6966 (window-buffer (active-minibuffer-window))))))
6967 (error "Minibuffer is not active for completion")
6968 ;; Set buffer so buffer-local choose-completion-string-functions works.
6969 (set-buffer buffer)
6970 (unless (run-hook-with-args-until-success
6971 'choose-completion-string-functions
6972 ;; The fourth arg used to be `mini-p' but was useless
6973 ;; (since minibufferp can be used on the `buffer' arg)
6974 ;; and indeed unused. The last used to be `base-size', so we
6975 ;; keep it to try and avoid breaking old code.
6976 choice buffer base-position nil)
6977 ;; This remove-text-properties should be unnecessary since `choice'
6978 ;; comes from buffer-substring-no-properties.
6979 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6980 ;; Insert the completion into the buffer where it was requested.
6981 (funcall (or insert-function completion-list-insert-choice-function)
6982 (or (car base-position) (point))
6983 (or (cadr base-position) (point))
6984 choice)
6985 ;; Update point in the window that BUFFER is showing in.
6986 (let ((window (get-buffer-window buffer t)))
6987 (set-window-point window (point)))
6988 ;; If completing for the minibuffer, exit it with this choice.
6989 (and (not completion-no-auto-exit)
6990 (minibufferp buffer)
6991 minibuffer-completion-table
6992 ;; If this is reading a file name, and the file name chosen
6993 ;; is a directory, don't exit the minibuffer.
6994 (let* ((result (buffer-substring (field-beginning) (point)))
6995 (bounds
6996 (completion-boundaries result minibuffer-completion-table
6997 minibuffer-completion-predicate
6998 "")))
6999 (if (eq (car bounds) (length result))
7000 ;; The completion chosen leads to a new set of completions
7001 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7002 (let ((mini (active-minibuffer-window)))
7003 (select-window mini)
7004 (when minibuffer-auto-raise
7005 (raise-frame (window-frame mini))))
7006 (exit-minibuffer))))))))
7008 (define-derived-mode completion-list-mode nil "Completion List"
7009 "Major mode for buffers showing lists of possible completions.
7011 to select the completion near point.
7013 with the mouse.
7016 (set (make-local-variable 'completion-base-size) nil))
7018 (defun completion-list-mode-finish ()
7019 "Finish setup of the completions buffer.
7020 Called from `temp-buffer-show-hook'."
7021 (when (eq major-mode 'completion-list-mode)
7022 (setq buffer-read-only t)))
7024 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7027 ;; Variables and faces used in `completion-setup-function'.
7029 (defcustom completion-show-help t
7030 "Non-nil means show help message in *Completions* buffer."
7031 :type 'boolean
7032 :version "22.1"
7033 :group 'completion)
7035 ;; This function goes in completion-setup-hook, so that it is called
7036 ;; after the text of the completion list buffer is written.
7037 (defun completion-setup-function ()
7038 (let* ((mainbuf (current-buffer))
7039 (base-dir
7040 ;; FIXME: This is a bad hack. We try to set the default-directory
7041 ;; in the *Completions* buffer so that the relative file names
7042 ;; displayed there can be treated as valid file names, independently
7043 ;; from the completion context. But this suffers from many problems:
7044 ;; - It's not clear when the completions are file names. With some
7045 ;; completion tables (e.g. bzr revision specs), the listed
7046 ;; completions can mix file names and other things.
7047 ;; - It doesn't pay attention to possible quoting.
7048 ;; - With fancy completion styles, the code below will not always
7049 ;; find the right base directory.
7050 (if minibuffer-completing-file-name
7051 (file-name-as-directory
7052 (expand-file-name
7053 (buffer-substring (minibuffer-prompt-end)
7054 (- (point) (or completion-base-size 0))))))))
7055 (with-current-buffer standard-output
7056 (let ((base-size completion-base-size) ;Read before killing localvars.
7057 (base-position completion-base-position)
7058 (insert-fun completion-list-insert-choice-function))
7059 (completion-list-mode)
7060 (set (make-local-variable 'completion-base-size) base-size)
7061 (set (make-local-variable 'completion-base-position) base-position)
7062 (set (make-local-variable 'completion-list-insert-choice-function)
7063 insert-fun))
7064 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7065 (if base-dir (setq default-directory base-dir))
7066 ;; Maybe insert help string.
7067 (when completion-show-help
7068 (goto-char (point-min))
7069 (if (display-mouse-p)
7070 (insert (substitute-command-keys
7072 (insert (substitute-command-keys
7076 (add-hook 'completion-setup-hook 'completion-setup-function)
7078 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7079 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7081 (defun switch-to-completions ()
7082 "Select the completion list window."
7083 (interactive)
7084 (let ((window (or (get-buffer-window "*Completions*" 0)
7085 ;; Make sure we have a completions window.
7086 (progn (minibuffer-completion-help)
7087 (get-buffer-window "*Completions*" 0)))))
7088 (when window
7089 (select-window window)
7090 ;; In the new buffer, go to the first completion.
7091 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
7092 (when (bobp)
7093 (next-completion 1)))))
7094 \f
7095 ;;; Support keyboard commands to turn on various modifiers.
7097 ;; These functions -- which are not commands -- each add one modifier
7098 ;; to the following event.
7100 (defun event-apply-alt-modifier (_ignore-prompt)
7103 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
7104 (defun event-apply-super-modifier (_ignore-prompt)
7107 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
7108 (defun event-apply-hyper-modifier (_ignore-prompt)
7111 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
7112 (defun event-apply-shift-modifier (_ignore-prompt)
7115 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
7116 (defun event-apply-control-modifier (_ignore-prompt)
7119 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
7120 (defun event-apply-meta-modifier (_ignore-prompt)
7123 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
7125 (defun event-apply-modifier (event symbol lshiftby prefix)
7126 "Apply a modifier flag to event EVENT.
7127 SYMBOL is the name of this modifier, as a symbol.
7128 LSHIFTBY is the numeric value of this modifier, in keyboard events.
7129 PREFIX is the string that represents this modifier in an event type symbol."
7130 (if (numberp event)
7131 (cond ((eq symbol 'control)
7132 (if (and (<= (downcase event) ?z)
7133 (>= (downcase event) ?a))
7134 (- (downcase event) ?a -1)
7135 (if (and (<= (downcase event) ?Z)
7136 (>= (downcase event) ?A))
7137 (- (downcase event) ?A -1)
7138 (logior (lsh 1 lshiftby) event))))
7139 ((eq symbol 'shift)
7140 (if (and (<= (downcase event) ?z)
7141 (>= (downcase event) ?a))
7142 (upcase event)
7143 (logior (lsh 1 lshiftby) event)))
7144 (t
7145 (logior (lsh 1 lshiftby) event)))
7146 (if (memq symbol (event-modifiers event))
7147 event
7148 (let ((event-type (if (symbolp event) event (car event))))
7149 (setq event-type (intern (concat prefix (symbol-name event-type))))
7150 (if (symbolp event)
7151 event-type
7152 (cons event-type (cdr event)))))))
7154 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
7155 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
7156 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
7157 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
7158 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
7159 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
7160 \f
7161 ;;;; Keypad support.
7163 ;; Make the keypad keys act like ordinary typing keys. If people add
7164 ;; bindings for the function key symbols, then those bindings will
7165 ;; override these, so this shouldn't interfere with any existing
7166 ;; bindings.
7168 ;; Also tell read-char how to handle these keys.
7169 (mapc
7170 (lambda (keypad-normal)
7171 (let ((keypad (nth 0 keypad-normal))
7172 (normal (nth 1 keypad-normal)))
7173 (put keypad 'ascii-character normal)
7174 (define-key function-key-map (vector keypad) (vector normal))))
7175 ;; See also kp-keys bound in bindings.el.
7176 '((kp-space ?\s)
7179 (kp-separator ?,)
7180 (kp-equal ?=)
7181 ;; Do the same for various keys that are represented as symbols under
7182 ;; GUIs but naturally correspond to characters.
7183 (backspace 127)
7184 (delete 127)
7187 (clear ?\C-l)
7188 (return ?\C-m)
7189 (escape ?\e)
7190 ))
7191 \f
7192 ;;;;
7193 ;;;; forking a twin copy of a buffer.
7194 ;;;;
7196 (defvar clone-buffer-hook nil
7197 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7199 (defvar clone-indirect-buffer-hook nil
7200 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7202 (defun clone-process (process &optional newname)
7203 "Create a twin copy of PROCESS.
7204 If NEWNAME is nil, it defaults to PROCESS' name;
7205 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7206 If PROCESS is associated with a buffer, the new process will be associated
7207 with the current buffer instead.
7208 Returns nil if PROCESS has already terminated."
7209 (setq newname (or newname (process-name process)))
7211 (setq newname (substring newname 0 (match-beginning 0))))
7212 (when (memq (process-status process) '(run stop open))
7213 (let* ((process-connection-type (process-tty-name process))
7214 (new-process
7215 (if (memq (process-status process) '(open))
7216 (let ((args (process-contact process t)))
7217 (setq args (plist-put args :name newname))
7218 (setq args (plist-put args :buffer
7219 (if (process-buffer process)
7220 (current-buffer))))
7221 (apply 'make-network-process args))
7222 (apply 'start-process newname
7223 (if (process-buffer process) (current-buffer))
7224 (process-command process)))))
7225 (set-process-query-on-exit-flag
7226 new-process (process-query-on-exit-flag process))
7227 (set-process-inherit-coding-system-flag
7228 new-process (process-inherit-coding-system-flag process))
7229 (set-process-filter new-process (process-filter process))
7230 (set-process-sentinel new-process (process-sentinel process))
7231 (set-process-plist new-process (copy-sequence (process-plist process)))
7232 new-process)))
7234 ;; things to maybe add (currently partly covered by `funcall mode'):
7235 ;; - syntax-table
7236 ;; - overlays
7237 (defun clone-buffer (&optional newname display-flag)
7238 "Create and return a twin copy of the current buffer.
7239 Unlike an indirect buffer, the new buffer can be edited
7240 independently of the old one (if it is not read-only).
7241 NEWNAME is the name of the new buffer. It may be modified by
7242 adding or incrementing <N> at the end as necessary to create a
7243 unique buffer name. If nil, it defaults to the name of the
7244 current buffer, with the proper suffix. If DISPLAY-FLAG is
7245 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7246 clone a file-visiting buffer, or a buffer whose major mode symbol
7247 has a non-nil `no-clone' property, results in an error.
7249 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7250 current buffer with appropriate suffix. However, if a prefix
7251 argument is given, then the command prompts for NEWNAME in the
7252 minibuffer.
7254 This runs the normal hook `clone-buffer-hook' in the new buffer
7255 after it has been set up properly in other respects."
7256 (interactive
7257 (progn
7258 (if buffer-file-name
7259 (error "Cannot clone a file-visiting buffer"))
7260 (if (get major-mode 'no-clone)
7261 (error "Cannot clone a buffer in %s mode" mode-name))
7262 (list (if current-prefix-arg
7263 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7264 t)))
7265 (if buffer-file-name
7266 (error "Cannot clone a file-visiting buffer"))
7267 (if (get major-mode 'no-clone)
7268 (error "Cannot clone a buffer in %s mode" mode-name))
7269 (setq newname (or newname (buffer-name)))
7271 (setq newname (substring newname 0 (match-beginning 0))))
7272 (let ((buf (current-buffer))
7273 (ptmin (point-min))
7274 (ptmax (point-max))
7275 (pt (point))
7276 (mk (if mark-active (mark t)))
7277 (modified (buffer-modified-p))
7278 (mode major-mode)
7279 (lvars (buffer-local-variables))
7280 (process (get-buffer-process (current-buffer)))
7281 (new (generate-new-buffer (or newname (buffer-name)))))
7282 (save-restriction
7283 (widen)
7284 (with-current-buffer new
7285 (insert-buffer-substring buf)))
7286 (with-current-buffer new
7287 (narrow-to-region ptmin ptmax)
7288 (goto-char pt)
7289 (if mk (set-mark mk))
7290 (set-buffer-modified-p modified)
7292 ;; Clone the old buffer's process, if any.
7293 (when process (clone-process process))
7295 ;; Now set up the major mode.
7296 (funcall mode)
7298 ;; Set up other local variables.
7299 (mapc (lambda (v)
7300 (condition-case () ;in case var is read-only
7301 (if (symbolp v)
7302 (makunbound v)
7303 (set (make-local-variable (car v)) (cdr v)))
7304 (error nil)))
7305 lvars)
7307 ;; Run any hooks (typically set up by the major mode
7308 ;; for cloning to work properly).
7309 (run-hooks 'clone-buffer-hook))
7310 (if display-flag
7311 ;; Presumably the current buffer is shown in the selected frame, so
7312 ;; we want to display the clone elsewhere.
7313 (let ((same-window-regexps nil)
7314 (same-window-buffer-names))
7315 (pop-to-buffer new)))
7316 new))
7319 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7320 "Create an indirect buffer that is a twin copy of the current buffer.
7322 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7323 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7324 or if not called with a prefix arg, NEWNAME defaults to the current
7325 buffer's name. The name is modified by adding a `<N>' suffix to it
7326 or by incrementing the N in an existing suffix. Trying to clone a
7327 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7328 property results in an error.
7330 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7331 This is always done when called interactively.
7333 Optional third arg NORECORD non-nil means do not put this buffer at the
7334 front of the list of recently selected ones."
7335 (interactive
7336 (progn
7337 (if (get major-mode 'no-clone-indirect)
7338 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7339 (list (if current-prefix-arg
7340 (read-buffer "Name of indirect buffer: " (current-buffer)))
7341 t)))
7342 (if (get major-mode 'no-clone-indirect)
7343 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7344 (setq newname (or newname (buffer-name)))
7346 (setq newname (substring newname 0 (match-beginning 0))))
7347 (let* ((name (generate-new-buffer-name newname))
7348 (buffer (make-indirect-buffer (current-buffer) name t)))
7349 (with-current-buffer buffer
7350 (run-hooks 'clone-indirect-buffer-hook))
7351 (when display-flag
7352 (pop-to-buffer buffer norecord))
7353 buffer))
7356 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7357 "Like `clone-indirect-buffer' but display in another window."
7358 (interactive
7359 (progn
7360 (if (get major-mode 'no-clone-indirect)
7361 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7362 (list (if current-prefix-arg
7363 (read-buffer "Name of indirect buffer: " (current-buffer)))
7364 t)))
7365 (let ((pop-up-windows t))
7366 (clone-indirect-buffer newname display-flag norecord)))
7368 \f
7369 ;;; Handling of Backspace and Delete keys.
7371 (defcustom normal-erase-is-backspace 'maybe
7372 "Set the default behavior of the Delete and Backspace keys.
7374 If set to t, Delete key deletes forward and Backspace key deletes
7375 backward.
7377 If set to nil, both Delete and Backspace keys delete backward.
7379 If set to 'maybe (which is the default), Emacs automatically
7380 selects a behavior. On window systems, the behavior depends on
7381 the keyboard used. If the keyboard has both a Backspace key and
7382 a Delete key, and both are mapped to their usual meanings, the
7383 option's default value is set to t, so that Backspace can be used
7384 to delete backward, and Delete can be used to delete forward.
7386 If not running under a window system, customizing this option
7387 accomplishes a similar effect by mapping C-h, which is usually
7388 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7389 via `keyboard-translate'. The former functionality of C-h is
7390 available on the F1 key. You should probably not use this
7391 setting if you don't have both Backspace, Delete and F1 keys.
7393 Setting this variable with setq doesn't take effect. Programmatically,
7394 call `normal-erase-is-backspace-mode' (which see) instead."
7395 :type '(choice (const :tag "Off" nil)
7396 (const :tag "Maybe" maybe)
7397 (other :tag "On" t))
7398 :group 'editing-basics
7399 :version "21.1"
7400 :set (lambda (symbol value)
7401 ;; The fboundp is because of a problem with :set when
7402 ;; dumping Emacs. It doesn't really matter.
7403 (if (fboundp 'normal-erase-is-backspace-mode)
7404 (normal-erase-is-backspace-mode (or value 0))
7405 (set-default symbol value))))
7407 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7408 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7409 (unless frame (setq frame (selected-frame)))
7410 (with-selected-frame frame
7411 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7412 (normal-erase-is-backspace-mode
7413 (if (if (eq normal-erase-is-backspace 'maybe)
7414 (and (not noninteractive)
7415 (or (memq system-type '(ms-dos windows-nt))
7416 (memq window-system '(w32 ns))
7417 (and (memq window-system '(x))
7418 (fboundp 'x-backspace-delete-keys-p)
7419 (x-backspace-delete-keys-p))
7420 ;; If the terminal Emacs is running on has erase char
7421 ;; set to ^H, use the Backspace key for deleting
7422 ;; backward, and the Delete key for deleting forward.
7423 (and (null window-system)
7424 (eq tty-erase-char ?\^H))))
7425 normal-erase-is-backspace)
7426 1 0)))))
7428 (define-minor-mode normal-erase-is-backspace-mode
7429 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7430 With a prefix argument ARG, enable this feature if ARG is
7431 positive, and disable it otherwise. If called from Lisp, enable
7432 the mode if ARG is omitted or nil.
7434 On window systems, when this mode is on, Delete is mapped to C-d
7435 and Backspace is mapped to DEL; when this mode is off, both
7436 Delete and Backspace are mapped to DEL. (The remapping goes via
7437 `local-function-key-map', so binding Delete or Backspace in the
7438 global or local keymap will override that.)
7440 In addition, on window systems, the bindings of C-Delete, M-Delete,
7441 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7442 the global keymap in accordance with the functionality of Delete and
7443 Backspace. For example, if Delete is remapped to C-d, which deletes
7444 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7445 to DEL, which deletes backward, C-Delete is bound to
7446 `backward-kill-word'.
7448 If not running on a window system, a similar effect is accomplished by
7449 remapping C-h (normally produced by the Backspace key) and DEL via
7450 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7451 to C-d; if it's off, the keys are not remapped.
7453 When not running on a window system, and this mode is turned on, the
7454 former functionality of C-h is available on the F1 key. You should
7455 probably not turn on this mode on a text-only terminal if you don't
7456 have both Backspace, Delete and F1 keys.
7458 See also `normal-erase-is-backspace'."
7459 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7460 . (lambda (v)
7461 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7462 (if v 1 0))))
7463 (let ((enabled (eq 1 (terminal-parameter
7464 nil 'normal-erase-is-backspace))))
7466 (cond ((or (memq window-system '(x w32 ns pc))
7467 (memq system-type '(ms-dos windows-nt)))
7468 (let ((bindings
7469 `(([M-delete] [M-backspace])
7470 ([C-M-delete] [C-M-backspace])
7471 ([?\e C-delete] [?\e C-backspace]))))
7473 (if enabled
7474 (progn
7475 (define-key local-function-key-map [delete] [deletechar])
7476 (define-key local-function-key-map [kp-delete] [deletechar])
7477 (define-key local-function-key-map [backspace] [?\C-?])
7478 (dolist (b bindings)
7479 ;; Not sure if input-decode-map is really right, but
7480 ;; keyboard-translate-table (used below) only works
7481 ;; for integer events, and key-translation-table is
7482 ;; global (like the global-map, used earlier).
7483 (define-key input-decode-map (car b) nil)
7484 (define-key input-decode-map (cadr b) nil)))
7485 (define-key local-function-key-map [delete] [?\C-?])
7486 (define-key local-function-key-map [kp-delete] [?\C-?])
7487 (define-key local-function-key-map [backspace] [?\C-?])
7488 (dolist (b bindings)
7489 (define-key input-decode-map (car b) (cadr b))
7490 (define-key input-decode-map (cadr b) (car b))))))
7491 (t
7492 (if enabled
7493 (progn
7494 (keyboard-translate ?\C-h ?\C-?)
7495 (keyboard-translate ?\C-? ?\C-d))
7496 (keyboard-translate ?\C-h ?\C-h)
7497 (keyboard-translate ?\C-? ?\C-?))))
7499 (if (called-interactively-p 'interactive)
7500 (message "Delete key deletes %s"
7501 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7502 "forward" "backward")))))
7503 \f
7504 (defvar vis-mode-saved-buffer-invisibility-spec nil
7505 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7507 (define-minor-mode read-only-mode
7508 "Change whether the current buffer is read-only.
7509 With prefix argument ARG, make the buffer read-only if ARG is
7510 positive, otherwise make it writable. If buffer is read-only
7511 and `view-read-only' is non-nil, enter view mode.
7513 Do not call this from a Lisp program unless you really intend to
7515 possibly enabling or disabling View mode. Also, note that this
7516 command works by setting the variable `buffer-read-only', which
7517 does not affect read-only regions caused by text properties. To
7518 ignore read-only status in a Lisp program (whether due to text
7519 properties or buffer state), bind `inhibit-read-only' temporarily
7520 to a non-nil value."
7521 :variable buffer-read-only
7522 (cond
7523 ((and (not buffer-read-only) view-mode)
7524 (View-exit-and-edit)
7525 (make-local-variable 'view-read-only)
7526 (setq view-read-only t)) ; Must leave view mode.
7527 ((and buffer-read-only view-read-only
7528 ;; If view-mode is already active, `view-mode-enter' is a nop.
7529 (not view-mode)
7530 (not (eq (get major-mode 'mode-class) 'special)))
7531 (view-mode-enter))))
7533 (define-minor-mode visible-mode
7534 "Toggle making all invisible text temporarily visible (Visible mode).
7535 With a prefix argument ARG, enable Visible mode if ARG is
7536 positive, and disable it otherwise. If called from Lisp, enable
7537 the mode if ARG is omitted or nil.
7539 This mode works by saving the value of `buffer-invisibility-spec'
7540 and setting it to nil."
7541 :lighter " Vis"
7542 :group 'editing-basics
7543 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7544 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7545 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7546 (when visible-mode
7547 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7548 buffer-invisibility-spec)
7549 (setq buffer-invisibility-spec nil)))
7550 \f
7551 (defvar messages-buffer-mode-map
7552 (let ((map (make-sparse-keymap)))
7553 (set-keymap-parent map special-mode-map)
7554 (define-key map "g" nil) ; nothing to revert
7555 map))
7557 (define-derived-mode messages-buffer-mode special-mode "Messages"
7560 (defun messages-buffer ()
7562 If it does not exist, create and it switch it to `messages-buffer-mode'."
7563 (or (get-buffer "*Messages*")
7564 (with-current-buffer (get-buffer-create "*Messages*")
7565 (messages-buffer-mode)
7566 (current-buffer))))
7568 \f
7569 ;; Minibuffer prompt stuff.
7571 ;;(defun minibuffer-prompt-modification (start end)
7572 ;; (error "You cannot modify the prompt"))
7573 ;;
7574 ;;
7575 ;;(defun minibuffer-prompt-insertion (start end)
7576 ;; (let ((inhibit-modification-hooks t))
7577 ;; (delete-region start end)
7578 ;; ;; Discard undo information for the text insertion itself
7579 ;; ;; and for the text deletion.above.
7580 ;; (when (consp buffer-undo-list)
7581 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7582 ;; (message "You cannot modify the prompt")))
7583 ;;
7584 ;;
7585 ;;(setq minibuffer-prompt-properties
7586 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7587 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7589 \f
7590 ;;;; Problematic external packages.
7592 ;; rms says this should be done by specifying symbols that define
7593 ;; versions together with bad values. This is therefore not as
7594 ;; flexible as it could be. See the thread:
7595 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7596 (defconst bad-packages-alist
7597 ;; Not sure exactly which semantic versions have problems.
7598 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7600 "The version of `semantic' loaded does not work in Emacs 22.
7601 It can cause constant high CPU load.
7602 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7603 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7604 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7605 ;; provided the `CUA-mode' feature. Since this is no longer true,
7606 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7607 (CUA-mode t nil
7608 "CUA-mode is now part of the standard GNU Emacs distribution,
7609 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7611 You have loaded an older version of CUA-mode which does not work
7612 correctly with this version of Emacs. You should remove the old
7613 version and use the one distributed with Emacs."))
7614 "Alist of packages known to cause problems in this version of Emacs.
7615 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7616 PACKAGE is either a regular expression to match file names, or a
7617 symbol (a feature name), like for `with-eval-after-load'.
7618 SYMBOL is either the name of a string variable, or `t'. Upon
7619 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7620 warning using STRING as the message.")
7622 (defun bad-package-check (package)
7623 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7624 (condition-case nil
7625 (let* ((list (assoc package bad-packages-alist))
7626 (symbol (nth 1 list)))
7627 (and list
7628 (boundp symbol)
7629 (or (eq symbol t)
7630 (and (stringp (setq symbol (eval symbol)))
7631 (string-match-p (nth 2 list) symbol)))
7632 (display-warning package (nth 3 list) :warning)))
7633 (error nil)))
7635 (dolist (elem bad-packages-alist)
7636 (let ((pkg (car elem)))
7637 (with-eval-after-load pkg
7638 (bad-package-check pkg))))
7640 \f
7641 ;;; Generic dispatcher commands
7643 ;; Macro `define-alternatives' is used to create generic commands.
7644 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
7645 ;; that can have different alternative implementations where choosing
7646 ;; among them is exclusively a matter of user preference.
7648 ;; (define-alternatives COMMAND) creates a new interactive command
7649 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
7650 ;; Typically, the user will not need to customize this variable; packages
7651 ;; wanting to add alternative implementations should use
7652 ;;
7653 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
7655 (defmacro define-alternatives (command &rest customizations)
7656 "Define new command `COMMAND'.
7657 The variable `COMMAND-alternatives' will contain alternative
7658 implementations of COMMAND, so that running `C-u M-x COMMAND'
7659 will allow the user to chose among them.
7660 CUSTOMIZATIONS, if non-nil, should be composed of alternating
7661 `defcustom' keywords and values to add to the declaration of
7662 `COMMAND-alternatives' (typically :group and :version)."
7663 (let* ((command-name (symbol-name command))
7664 (varalt-name (concat command-name "-alternatives"))
7665 (varalt-sym (intern varalt-name))
7666 (varimp-sym (intern (concat command-name "--implementation"))))
7667 `(progn
7669 (defcustom ,varalt-sym nil
7670 ,(format "Alist of alternative implementations for the `%s' command.
7672 Each entry must be a pair (ALTNAME . ALTFUN), where:
7673 ALTNAME - The name shown at user to describe the alternative implementation.
7674 ALTFUN - The function called to implement this alternative."
7675 command-name)
7676 :type '(alist :key-type string :value-type function)
7677 ,@customizations)
7679 (defvar ,varimp-sym nil "Internal use only.")
7681 (defun ,command (&optional arg)
7682 ,(format "Run generic command `%s'.
7683 If used for the first time, or with interactive ARG, ask the user which
7684 implementation to use for `%s'. The variable `%s'
7685 contains the list of implementations currently supported for this command."
7686 command-name command-name varalt-name)
7687 (interactive "P")
7688 (when (or arg (null ,varimp-sym))
7689 (let ((val (completing-read
7690 ,(format "Select implementation for command `%s': " command-name)
7691 ,varalt-sym nil t)))
7692 (unless (string-equal val "")
7693 (customize-save-variable ',varimp-sym
7694 (cdr (assoc-string val ,varalt-sym))))))
7695 (if ,varimp-sym
7696 (funcall ,varimp-sym)
7697 (message ,(format "No implementation selected for command `%s'"
7698 command-name)))))))
7700 (provide 'simple)
7702 ;;; simple.el ends here