| blob | 7b505d116450247fedf420f7cdd99ec563c76969 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2014 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
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.
378 "Special hook to tell if `self-insert-command' will use the region.
379 It must be called via `run-hook-with-args-until-success' with no arguments.
380 Any `post-self-insert-command' which consumes the region should
381 register a function on this hook so that things like `delete-selection-mode'
388 "Insert a newline, and move to left margin of the new line if it's blank.
389 If option `use-hard-newlines' is non-nil, the newline is marked with the
390 text-property `hard'.
391 With ARG, insert that many newlines.
393 If `electric-indent-mode' is enabled, this indents the final new line
394 that it adds, and reindents the preceding line. To just insert
397 Calls `auto-fill-function' if the current column number is greater
398 than the value of `fill-column' and ARG is nil.
399 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
402 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
403 ;; Set last-command-event to tell self-insert what to insert.
407 ;; Don't auto-fill if we have a numeric argument.
410 ;; Do the rest in post-self-insert-hook, because we want to do it
411 ;; *before* other functions on that hook.
413 ;; Mark the newline(s) `hard'.
417 ;; If the newline leaves the previous line blank, and we
418 ;; have a left margin, delete that from the blank line.
426 ;; Indent the line after the newline, except in one case:
427 ;; when we added the newline at the beginning of a line which
428 ;; starts a page.
432 ;; FIXME: For non-interactive uses, many calls actually just want
433 ;; (insert "\n"), so maybe we should do just that, so as to avoid
434 ;; the risk of filling or running abbrevs unexpectedly.
441 ;; We first used let-binding to protect the hook, but that was naive
442 ;; since add-hook affects the symbol-default value of the variable,
443 ;; whereas the let-binding might only protect the buffer-local value.
445 nil)
450 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
456 "Insert a newline and leave point before it.
457 If there is a fill prefix and/or a `left-margin', insert them
458 on the new line if the line would have been blank.
459 With arg N, insert N newlines."
464 ;; Don't expand an abbrev before point.
478 "Split current line, moving portion beyond point vertically down.
479 If the current line starts with `fill-prefix', insert it on the new
480 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
482 When called from Lisp code, ARG may be a prefix string to copy."
487 ;; What prefix should we check for (nil means don't).
491 ;; Does this line start with it?
502 "Join this line to previous and fix up whitespace at join.
503 If there is a fill prefix, delete it from the beginning of this line.
504 With argument, join this line to following line."
511 ;; If the second line started with the fill prefix,
512 ;; delete the prefix.
524 "On blank line, delete all surrounding blank lines, leaving just one.
525 On isolated blank line, delete that one.
526 On nonblank line, delete any immediately following blank lines."
532 ;; Set singleblank if there is just one blank line here.
539 ;; Delete preceding blank lines, and this one too if it's the only one.
548 ;; Delete following blank lines, unless the current line is blank
549 ;; and there are no following blank lines.
558 ;; Handle the special case where point is followed by newline and eob.
559 ;; Delete the line, leaving point at eob.
565 Trailing lines are deleted only if `delete-trailing-whitespace'
566 is called on the entire buffer (rather than an active region)."
572 "Delete trailing whitespace between START and END.
573 If called interactively, START and END are the start/end of the
574 region if the mark is active, or of the buffer's accessible
575 portion if the mark is inactive.
577 This command deletes whitespace characters after the last
578 non-whitespace character in each line between START and END. It
579 does not consider formfeed characters to be whitespace.
581 If this command acts on the entire buffer (i.e. if called
582 interactively with the mark inactive, or called from Lisp with
583 END nil), it also deletes all trailing lines at the end of the
584 buffer if the variable `delete-trailing-lines' is non-nil."
597 ;; Don't delete formfeeds, even if they are considered whitespace.
601 ;; Delete trailing empty lines.
604 delete-trailing-lines
605 ;; Really the end of buffer.
610 ;; Return nil for the benefit of `write-file-functions'.
611 nil)
614 "Insert a newline, then indent according to major mode.
615 Indentation is done using the value of `indent-line-function'.
616 In programming language modes, this is the same as TAB.
617 In some text modes, where TAB inserts a tab, this command indents to the
618 column specified by the function `current-left-margin'."
625 "Reindent current line, insert newline, then indent the new line.
626 Indentation of both lines is done according to the current major mode,
627 which means calling the current value of `indent-line-function'.
628 In programming language modes, this is the same as TAB.
629 In some text modes, where TAB inserts a tab, this indents to the
630 column specified by the function `current-left-margin'."
633 ;; Be careful to insert the newline before indenting the line.
634 ;; Otherwise, the indentation might be wrong.
638 ;; We are at EOL before the call to indent-according-to-mode, and
639 ;; after it we usually are as well, but not always. We tried to
640 ;; address it with `save-excursion' but that uses a normal marker
641 ;; whereas we need `move after insertion', so we do the save/restore
642 ;; by hand.
646 ;; Remove the trailing white-space after indentation because
647 ;; indentation may introduce the whitespace.
653 Legitimate radix values are 8, 10 and 16."
658 "Like `read-char', but do not allow quitting.
659 Also, if the first character read is an octal digit,
660 we read any number of octal digits and return the
661 specified character code. Any nondigit terminates the sequence.
662 If the terminator is RET, it is discarded;
663 any other terminator is used itself as input.
665 The optional argument PROMPT specifies a string to use to prompt the user.
666 The variable `read-quoted-char-radix' controls which radix to use
667 for numeric input."
670 help-event-list)))
674 ;; Don't let C-h or other help chars get the help
675 ;; message--only help function keys. See bug#16617.
679 "Type the special character you want to use,
680 or the octal character code.
681 RET terminates the character code and is discarded;
691 done t))
693 ;; Turn a meta-character into a character with the 0200 bit set.
695 done t))
711 done t))
713 done t)))
715 code))
718 "Read next input character and insert it.
719 This is useful for inserting control characters.
720 With argument, insert ARG copies of the character.
722 If the first character you type after this command is an octal digit,
723 you should type a sequence of octal digits which specify a character code.
724 Any nondigit terminates the sequence. If the terminator is a RET,
725 it is discarded; any other terminator is used itself as input.
726 The variable `read-quoted-char-radix' specifies the radix for this feature;
727 set it to 10 or 16 to use decimal or hex instead of octal.
729 In overwrite mode, this function inserts the character anyway, and
730 does not handle octal digits specially. This means that if you use
731 overwrite as your normal editing mode, you can use this function to
732 insert characters when necessary.
734 In binary overwrite mode, this function does overwrite, and octal
735 digits are interpreted as a character code. This is intended to be
736 useful for editing binary files."
739 ;; Avoid "obsolete" warnings for translation-table-for-input.
746 ;; This used to assume character codes 0240 - 0377 stand for
747 ;; characters in some single-byte character set, and converted them
748 ;; to Emacs characters. But in 23.1 this feature is deprecated
749 ;; in favor of inserting the corresponding Unicode characters.
750 ;; (if (and enable-multibyte-characters
751 ;; (>= char ?\240)
752 ;; (<= char ?\377))
753 ;; (setq char (unibyte-char-to-multibyte char)))
765 "Move forward ARG lines and position at first nonblank character."
771 "Move backward ARG lines and position at first nonblank character."
777 "Move point to the first non-whitespace character on this line."
781 ;; Move back over chars that have whitespace syntax but have the p flag.
785 "Fixup white space between objects around point.
786 Leave one space or none, according to the context."
793 nil
797 "Delete all spaces and tabs around point.
798 If BACKWARD-ONLY is non-nil, only delete them before point."
803 orig-pos
812 "Delete all spaces and tabs around point, leaving one space (or N spaces).
813 If N is negative, delete newlines as well, leaving -N spaces.
814 See also `cycle-spacing'."
819 "Store context used in consecutive calls to `cycle-spacing' command.
820 The first time this function is run, it saves the original point
821 position and original spacing around the point in this
825 "Manipulate whitespace around point in a smart way.
826 In interactive use, this function behaves differently in successive
827 consecutive calls.
829 The first call in a sequence acts like `just-one-space'.
830 It deletes all spaces and tabs around point, leaving one space
831 \(or N spaces). N is the prefix argument. If N is negative,
832 it deletes newlines as well, leaving -N spaces.
833 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
835 The second call in a sequence (or the first call if the above does
836 not result in any changes) deletes all spaces.
838 The third call in a sequence restores the original whitespace (and point).
840 If SINGLE-SHOT is non-nil, it only performs the first step in the sequence."
848 ;; Command run for the first time or single-shot is non-nil.
859 ;; Special handling for case where there was no space at all.
862 ;; If this run causes no change in buffer content, delete all spaces,
863 ;; otherwise delete all excess spaces.
868 ;; Command run for the second time.
872 ;; Command run for the third time.
877 \f
879 "Move point to the beginning of the buffer.
880 With numeric arg N, put point N/10 of the way from the beginning.
881 If the buffer is narrowed, this command uses the beginning of the
882 accessible part of the buffer.
884 If Transient Mark mode is disabled, leave mark at previous
887 Don't use this command in Lisp programs!
888 \(goto-char (point-min)) is faster."
897 ;; Avoid overflow for large buffer sizes!
907 "Move point to the end of the buffer.
908 With numeric arg N, put point N/10 of the way from the end.
909 If the buffer is narrowed, this command uses the end of the
910 accessible part of the buffer.
912 If Transient Mark mode is disabled, leave mark at previous
915 Don't use this command in Lisp programs!
916 \(goto-char (point-max)) is faster."
923 ;; Avoid overflow for large buffer sizes!
928 ;; If we went to a place in the middle of the buffer,
929 ;; adjust it to the beginning of a line.
933 ;; If the end of the buffer is not already on the screen,
934 ;; then scroll specially to put it near, but not at, the bottom.
940 "Whether single-char deletion commands delete an active region.
941 This has an effect only if Transient Mark mode is enabled, and
942 affects `delete-forward-char' and `delete-backward-char', though
943 not `delete-char'.
945 If the value is the symbol `kill', the active region is killed
946 instead of deleted."
959 "Function to get the region's content.
960 Called with one argument DELETE.
961 If DELETE is `delete-only', then only delete the region and the return value
962 is undefined. If DELETE is nil, just return the content as a string.
966 "Delete the previous N characters (following if N is negative).
967 If Transient Mark mode is enabled, the mark is active, and N is 1,
968 delete the text in the region and deactivate the mark instead.
969 To disable this, set option `delete-active-region' to nil.
971 Optional second arg KILLFLAG, if non-nil, means to kill (save in
972 kill ring) instead of delete. Interactively, N is the prefix
973 arg, and KILLFLAG is set if N is explicitly specified.
975 In Overwrite mode, single character backward deletion may replace
976 tabs with spaces so as to back over columns, unless point is at
977 the end of the line."
982 delete-active-region
984 ;; If a region is active, kill or delete it.
988 ;; In Overwrite mode, maybe untabify while deleting
998 ;; Otherwise, do simple deletion.
1003 "Delete the following N characters (previous if N is negative).
1004 If Transient Mark mode is enabled, the mark is active, and N is 1,
1005 delete the text in the region and deactivate the mark instead.
1006 To disable this, set variable `delete-active-region' to nil.
1008 Optional second arg KILLFLAG non-nil means to kill (save in kill
1009 ring) instead of delete. Interactively, N is the prefix arg, and
1010 KILLFLAG is set if N was explicitly specified."
1015 delete-active-region
1017 ;; If a region is active, kill or delete it.
1022 ;; Otherwise, do simple deletion.
1027 "Put point at beginning and mark at end of buffer.
1028 If narrowing is in effect, only uses the accessible part of the buffer.
1029 You probably should not use this function in Lisp programs;
1030 it is usually a mistake for a Lisp function to use any subroutine
1031 that uses or sets the mark."
1036 \f
1038 ;; Counting lines, one way or another.
1041 "Go to LINE, counting from line 1 at beginning of buffer.
1042 If called interactively, a numeric prefix argument specifies
1043 LINE; without a numeric prefix argument, read LINE from the
1044 minibuffer.
1046 If optional argument BUFFER is non-nil, switch to that buffer and
1048 as argument, BUFFER is the most recently selected other buffer.
1050 Prior to moving point, this function sets the mark (without
1051 activating it), unless Transient Mark mode is enabled and the
1052 mark is already active.
1054 This function is usually the wrong thing to use in a Lisp program.
1055 What you probably want instead is something like:
1056 (goto-char (point-min))
1057 (forward-line (1- N))
1058 If at all possible, an even better solution is to use char counts
1059 rather than line counts."
1063 ;; Look for a default, a number in the buffer at point.
1073 ;; Decide if we're switching buffers.
1081 ;; Read the argument, offering that number (if any) as default.
1084 buffer))))
1085 ;; Switch to the desired buffer, one way or another.
1090 ;; Leave mark at previous position
1092 ;; Move to the specified line number in that buffer.
1102 "Count the number of words in the region.
1103 If called interactively, print a message reporting the number of
1104 lines, words, and characters in the region (whether or not the
1105 region is active); with prefix ARG, report for the entire buffer
1106 rather than the region.
1108 If called from Lisp, return the number of words between positions
1109 START and END."
1121 "Count words between START and END.
1122 If called interactively, START and END are normally the start and
1123 end of the buffer; but if the region is active, START and END are
1124 the start and end of the region. Print a message reporting the
1125 number of lines, words, and chars.
1127 If called from Lisp, return the number of words between START and
1128 END, without printing any message."
1138 words))
1154 str
1162 "Print the current buffer line number and narrowed line number of point."
1175 "Return number of lines between START and END.
1176 This is usually the number of newlines between them,
1177 but can be one more if START is not equal to END
1178 and the greater of them is not at the start of a line."
1194 done)))
1198 "Return (narrowed) buffer line number at position POS.
1199 If POS is nil, use current buffer location.
1200 Counting starts at (point-min), so the value refers
1201 to the contents of the accessible portion of the buffer."
1211 "Print info on cursor position (on screen and within buffer).
1212 Also describe the character after point, and give its character code
1213 in octal, decimal and hex.
1215 For a non-ASCII multibyte character, also give its encoding in the
1216 buffer's selected coding system if the coding system encodes the
1217 character safely. If the character is encoded into one byte, that
1218 code is shown in hex. If the character is encoded into more than one
1221 In addition, with prefix argument, show details about that character
1222 in *Help* buffer. See also the command `describe-char'."
1227 ;; If the character is one of LRE, LRO, RLE, RLO, it
1228 ;; will start a directional embedding, which could
1229 ;; completely disrupt the rest of the line (e.g., RLO
1230 ;; will display the rest of the line right-to-left).
1231 ;; So we put an invisible PDF character after these
1232 ;; characters, to end the embedding, which eliminates
1233 ;; any effects on the rest of the line.
1235 ;; Strong right-to-left characters cause reordering of
1236 ;; the following numerical characters which show the
1237 ;; codepoint, so append LRM to countermand that.
1247 ;; Avoid overflow from multiplying by 100!
1251 ""
1257 pos total percent beg end col hscroll)
1259 pos total col hscroll))
1261 encoded encoding-msg display-prop under-display)
1268 ;; Check if the character is displayed with some `display'
1269 ;; text property. In that case, set under-display to the
1270 ;; buffer substring covered by that property.
1281 under-display)))
1287 char char char under-display)
1289 char char char under-display display-prop))
1292 char char char
1294 "..."
1298 ;; We show the detailed information about CHAR.
1305 bidi-fixer
1306 encoding-msg pos total percent beg end col hscroll)
1313 bidi-fixer encoding-msg pos total percent col hscroll))))))
1314 \f
1315 ;; Initialize read-expression-map. It is defined at C level.
1319 ;; Might as well bind TAB to completion, since inserting a TAB char is
1320 ;; much too rarely useful.
1323 m))
1326 "Return a Lisp object read using the minibuffer, unevaluated.
1327 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1328 is a string to insert in the minibuffer before reading.
1329 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1330 Such arguments are used as in `read-from-minibuffer'.)"
1331 ;; Used for interactive spec `x'.
1336 "Return value of Lisp expression read using the minibuffer.
1337 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1338 is a string to insert in the minibuffer before reading.
1339 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1340 Such arguments are used as in `read-from-minibuffer'.)"
1341 ;; Used for interactive spec `X'.
1349 "The current default value or list of default values in the minibuffer.
1350 The functions `read-from-minibuffer' and `completing-read' bind
1354 "Value for `print-level' while printing value in `eval-expression'.
1355 A value of nil means no limit."
1361 "Value for `print-length' while printing value in `eval-expression'.
1362 A value of nil means no limit."
1368 "If non-nil set `debug-on-error' to t in `eval-expression'.
1369 If nil, don't change the value of `debug-on-error'."
1375 "Format VALUE as a result of evaluated expression.
1376 Return a formatted string which is displayed in the echo area
1377 in addition to the value printed by prin1 in functions which
1378 display the result of expression evaluation."
1401 read-expression-map t
1404 ;; We define this, rather than making `eval' interactive,
1405 ;; for the sake of completion of names like eval-region, eval-buffer.
1407 "Evaluate EXP and print value in the echo area.
1408 When called interactively, read an Emacs Lisp expression and evaluate it.
1409 Value is also consed on to front of the variable `values'.
1410 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1411 argument) means insert the result into the current buffer instead of
1412 printing it in the echo area.
1414 Normally, this function truncates long output according to the value
1415 of the variables `eval-expression-print-length' and
1416 `eval-expression-print-level'. With a prefix argument of zero,
1417 however, there is no such truncation. Such a prefix argument
1418 also causes integers to be printed in several additional formats
1419 \(octal, hexadecimal, and character).
1421 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1422 minibuffer.
1424 If `eval-expression-debug-on-error' is non-nil, which is the default,
1425 this command arranges for all errors to enter the debugger."
1428 current-prefix-arg))
1433 ;; Bind debug-on-error to something unique so that we can
1434 ;; detect when evalled code changes it.
1438 ;; If evalled code has changed the value of debug-on-error,
1439 ;; propagate that change to the global binding.
1444 eval-expression-print-length))
1446 eval-expression-print-level))
1462 "Prompting with PROMPT, let user edit COMMAND and eval result.
1463 COMMAND is a Lisp expression. Let user edit that expression in
1464 the minibuffer, then read and evaluate the result."
1471 read-expression-map t
1473 ;; If command was added to command-history as a string,
1474 ;; get rid of that. We want only evaluable expressions there.
1478 ;; If command to be redone does not match front of history,
1479 ;; add it to the history.
1485 "Edit and re-evaluate last complex command, or ARGth from last.
1486 A complex command is one which used the minibuffer.
1487 The command is placed in the minibuffer as a Lisp form for editing.
1488 The result is executed, repeating the command as changed.
1489 If the command has been changed or is not the most recent previous
1490 command it is added to the front of the command history.
1491 You can use the minibuffer history commands \
1493 to get different commands to edit and resubmit."
1496 newcmd)
1508 ;; If command was added to command-history as a
1509 ;; string, get rid of that. We want only
1510 ;; evaluable expressions there.
1514 ;; If command to be redone does not match front of history,
1515 ;; add it to the history.
1520 ;; Trick called-interactively-p into thinking that `newcmd' is
1521 ;; an interactive call (bug#14136).
1540 "Read command name to invoke in `execute-extended-command'."
1545 ;; Get a command name at point in the original buffer
1546 ;; to propose it after M-n.
1550 ;; Read a string, completing from and restricting to the set of
1551 ;; all defined commands. Don't provide any initial input.
1552 ;; Save the command read on the extended-command history list.
1563 ;; This isn't strictly correct if `execute-extended-command'
1564 ;; is bound to anything else (e.g. [menu]).
1565 ;; It could use (key-description (this-single-command-keys)),
1566 ;; but actually a prompt other than "M-x" would be confusing,
1567 ;; because "M-x" is a well-known prompt to read a command
1568 ;; and it serves as a shorthand for "Extended command: ".
1573 "Non-nil means show the equivalent key-binding when M-x command has one.
1574 The value can be a length of time to show the message for.
1575 If the value is non-nil and not a number, we wait 2 seconds."
1582 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1583 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1584 "Read a command name, then read the arguments and call the command.
1585 Interactively, to pass a prefix argument to the command you are
1586 invoking, give a prefix argument to `execute-extended-command'.
1587 Noninteractively, the argument PREFIXARG is the prefix argument to
1588 give to the command you invoke."
1590 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1601 ;; Normally `real-this-command' should never be changed, but here we really
1602 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1603 ;; binding" for <cmd>, so the command the user really wanted to run is
1604 ;; `function' and not `execute-extended-command'. The difference is
1605 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1609 ;; If enabled, show which key runs this command.
1611 ;; But first wait, and skip the message if there is input.
1613 ;; If this command displayed something in the echo area;
1614 ;; wait a few seconds, then display our suggestion message.
1624 suggest-key-bindings
1628 ;; BEWARE: Called directly from the C code.
1629 "Execute CMD as an editor command.
1630 CMD must be a symbol that satisfies the `commandp' predicate.
1631 Optional second arg RECORD-FLAG non-nil
1632 means unconditionally put this command in the variable `command-history'.
1633 Otherwise, that is done only if an arg is read using the minibuffer.
1634 The argument KEYS specifies the value to use instead of (this-command-keys)
1635 when reading the arguments; if it is nil, (this-command-keys) is used.
1636 The argument SPECIAL, if non-nil, means that this command is executing
1637 a special event, so ignore the prefix argument and don't clear it."
1645 disabled-command-function)
1646 ;; FIXME: Weird calling convention!
1656 ;; If requested, place the macro in the command history. For
1657 ;; other sorts of commands, call-interactively takes care of this.
1660 ;; Don't keep command history around forever.
1666 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1674 \f
1676 "Default minibuffer history list.
1677 This is used for all minibuffer input
1678 except when an alternate history list is specified.
1680 Maximum length of the history list is determined by the value
1683 "Control whether history list elements are expressions or strings.
1684 If the value of this variable equals current minibuffer depth,
1685 they are expressions; otherwise they are strings.
1686 \(That convention is designed to do the right thing for
1693 "Text that was in this minibuffer before any history commands.
1694 This is nil if there have not yet been any history commands
1703 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1707 "Minibuffer history variables for which matching should ignore case.
1708 If a history variable is a member of this list, then the
1710 commands ignore case when searching it, regardless of `case-fold-search'."
1715 "Find the previous history element that matches REGEXP.
1716 \(Previous history elements refer to earlier actions.)
1717 With prefix argument N, search for Nth previous match.
1718 If N is negative, find the next or Nth next match.
1719 Normally, history elements are matched case-insensitively if
1720 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1721 makes the search case-sensitive.
1722 See also `minibuffer-history-case-insensitive-variables'."
1726 nil
1727 minibuffer-local-map
1728 nil
1729 'minibuffer-history-search-history
1731 ;; Use the last regexp specified, by default, if input is empty.
1736 regexp)
1746 ;; On some systems, ignore case for file names.
1748 minibuffer-history-case-insensitive-variables)
1749 t
1750 ;; Respect the user's setting for case-fold-search:
1751 case-fold-search)
1752 nil))
1753 prevpos
1754 match-string
1755 match-offset
1762 "No later matching history item"
1783 next-matching-history-element))
1787 "Find the next history element that matches REGEXP.
1788 \(The next history element refers to a more recent action.)
1789 With prefix argument N, search for Nth next match.
1790 If N is negative, find the previous or Nth previous match.
1791 Normally, history elements are matched case-insensitively if
1792 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1793 makes the search case-sensitive."
1797 nil
1798 minibuffer-local-map
1799 nil
1800 'minibuffer-history-search-history
1802 ;; Use the last regexp specified, by default, if input is empty.
1807 regexp)
1814 "Function run by `goto-history-element' before consuming default values.
1815 This is useful to dynamically add more elements to the list of default values
1816 when `goto-history-element' reaches the end of this list.
1817 Before calling this function `goto-history-element' sets the variable
1818 `minibuffer-default-add-done' to t, so it will call this function only
1819 once. In special cases, when this function needs to be called more
1820 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1824 "When nil, add more elements to the end of the list of default values.
1825 The value nil causes `goto-history-element' to add more elements to
1826 the list of defaults when it reaches the end of this list. It does
1832 "Return a list of all completions without the default value.
1833 This function is used to add all elements of the completion table to
1834 the end of the list of defaults just after the default value."
1837 minibuffer-completion-table
1838 minibuffer-completion-predicate)))
1844 "Puts element of the minibuffer history in the minibuffer.
1845 The argument NABS specifies the absolute history position."
1859 elt minibuffer-returned-to-present)
1866 "End of defaults; no next item"
1871 previous-history-element))
1883 minibuffer-default)))
1895 elt))
1899 "Puts next element of the minibuffer history in the minibuffer.
1900 With argument N, it uses the Nth following element."
1906 "Puts previous element of the minibuffer history in the minibuffer.
1907 With argument N, it uses the Nth previous element."
1913 "Get next history element which completes the minibuffer before the point.
1914 The contents of the minibuffer after the point are deleted, and replaced
1915 by the new completion."
1921 n)
1922 ;; next-matching-history-element always puts us at (point-min).
1923 ;; Move to the position we were at before changing the buffer contents.
1924 ;; This is still sensible, because the text before point has not changed.
1928 "\
1929 Get previous history element which completes the minibuffer before the point.
1930 The contents of the minibuffer after the point are deleted, and replaced
1931 by the new completion."
1935 ;; For compatibility with the old subr of the same name.
1937 "Return the display width of the minibuffer prompt.
1938 Return 0 if current buffer is not a minibuffer."
1939 ;; Return the width of everything before the field at the end of
1940 ;; the buffer; this should be 0 for normal buffers.
1942 \f
1943 ;; isearch minibuffer history
1950 "Set up a minibuffer for using isearch to search the minibuffer history.
1951 Intended to be added to `minibuffer-setup-hook'."
1963 "Clean up the minibuffer after terminating isearch in the minibuffer."
1968 "Return the proper search function, for isearch in minibuffer history."
1971 ;; Use standard functions to search within minibuffer text
1973 found)
1974 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1975 ;; searching forward. Lazy-highlight calls this lambda with the
1976 ;; bound arg, so skip the minibuffer prompt.
1980 ;; 1. First try searching in the initial minibuffer text
1983 noerror)
1984 ;; 2. If the above search fails, start putting next/prev history
1985 ;; elements in the minibuffer successively, and search the string
1986 ;; in them. Do this only when bound is nil (i.e. not while
1987 ;; lazy-highlighting search strings in the current minibuffer text).
1999 ;; After putting the next/prev history element, search
2000 ;; the string in them again, until next-history-element
2001 ;; or previous-history-element raises an error at the
2002 ;; beginning/end of history.
2005 ;; For backward search, don't search
2006 ;; in the minibuffer prompt
2008 noerror)))
2009 ;; Return point of the new search result
2011 ;; Return nil when next(prev)-history-element fails
2015 "Display the minibuffer history search prompt.
2016 If there are no search errors, this function displays an overlay with
2017 the isearch prompt which replaces the original minibuffer prompt.
2018 Otherwise, it displays the standard isearch message returned from
2019 the function `isearch-message'."
2021 ;; Use standard function `isearch-message' when not in the minibuffer,
2022 ;; or search fails, or has an error (like incomplete regexp).
2023 ;; This function overwrites minibuffer text with isearch message,
2024 ;; so it's possible to see what is wrong in the search string.
2026 ;; Otherwise, put the overlay with the standard isearch prompt over
2027 ;; the initial minibuffer prompt.
2036 ;; And clear any previous isearch message.
2040 "Wrap the minibuffer history search when search fails.
2041 Move point to the first history element for a forward search,
2042 or to the last history element for a backward search."
2043 ;; When `minibuffer-history-isearch-search' fails on reaching the
2044 ;; beginning/end of the history, wrap the search to the first/last
2045 ;; minibuffer history element.
2053 "Save a function restoring the state of minibuffer history search.
2054 Save `minibuffer-history-position' to the additional state parameter
2055 in the search status stack."
2061 "Restore the minibuffer history search state.
2062 Go to the history element by the absolute history position HIST-POS."
2065 \f
2066 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2070 "Table mapping redo records to the corresponding undo one.
2071 A redo record for undo-in-region maps to t.
2081 "Within a run of consecutive undo commands, list remaining to be undone.
2085 "Undo some previous changes.
2086 Repeat this command to undo more changes.
2087 A numeric ARG serves as a repeat count.
2089 In Transient Mark mode when the mark is active, only undo changes within
2091 as an argument limits undo to changes within the current region."
2093 ;; Make last-command indicate for the next command that this was an undo.
2094 ;; That way, another undo will undo more.
2095 ;; If we get to the end of the undo history and get an error,
2096 ;; another undo command will find the undo history empty
2097 ;; and will get another error. To begin undoing the undos,
2098 ;; you must type some other command.
2100 ;; For an indirect buffer, look in the base buffer for the
2101 ;; auto-save data.
2105 message)
2106 ;; If we get an error in undo-start,
2107 ;; the next command should not be a "consecutive undo".
2108 ;; So set `this-command' to something other than `undo'.
2113 ;; If something (a timer or filter?) changed the buffer
2114 ;; since the previous command, don't continue the undo seq.
2118 ;; If the last undo record made was made by undo
2119 ;; it shows nothing else happened in between.
2126 ;; get rid of initial undo boundary
2128 ;; If we got this far, the next command should be a consecutive undo.
2130 ;; Check to see whether we're hitting a redo record, and if
2131 ;; so, ask the user whether she wants to skip the redo/undo pair.
2139 ;; The equiv entry might point to another redo record if we have done
2140 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2148 ;; Record the fact that the just-generated undo records come from an
2149 ;; undo operation--that is, they are redo records.
2150 ;; In the ordinary case (not within a region), map the redo
2151 ;; record to the following undos.
2152 ;; I don't know how to do that in the undo-in-region case.
2154 ;; Strip any leading undo boundaries there might be, like we do
2155 ;; above when checking.
2159 ;; Prevent identity mapping. This can happen if
2160 ;; consecutive nils are erroneously in undo list.
2162 t
2163 pending-undo-list)
2164 undo-equiv-table))
2165 ;; Don't specify a position in the undo record for the undo command.
2166 ;; Instead, undoing this should move point to where the change is.
2185 ;; Record what the current undo list says,
2186 ;; so the next command can tell if the buffer was modified in between.
2190 ;; Display a message announcing success.
2195 "Make BUFFER stop keeping undo information.
2196 No argument or nil as argument means do this for the current buffer."
2202 "Undo some previous changes.
2203 Repeat this command to undo more changes.
2204 A numeric ARG serves as a repeat count.
2205 Contrary to `undo', this will not redo a previous undo."
2210 "Non-nil while performing an undo.
2214 "Undo back N undo-boundaries beyond what was already undone recently.
2215 Call `undo-start' to get ready to undo recent changes,
2216 then call `undo-more' one or more times to undo them."
2221 ;; Note: The following, while pulling elements off
2222 ;; `pending-undo-list' will call primitive change functions which
2223 ;; will push more elements onto `buffer-undo-list'.
2229 "Undo N records from the front of the list LIST.
2230 Return what remains of the list."
2232 ;; This is a good feature, but would make undo-start
2233 ;; unable to do what is expected.
2234 ;;(when (null (car (list)))
2235 ;; ;; If the head of the list is a boundary, it is the boundary
2236 ;; ;; preceding this command. Get rid of it and don't count it.
2237 ;; (setq list (cdr list))))
2240 ;; In a writable buffer, enable undoing read-only text that is
2241 ;; so because of text properties.
2243 ;; Don't let `intangible' properties interfere with undo.
2245 ;; We use oldlist only to check for EQ. ++kfs
2251 ;; Handle an integer by setting point to that value.
2254 ;; Element (t . TIME) records previous modtime.
2255 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2256 ;; UNKNOWN_MODTIME_NSECS.
2258 ;; If this records an obsolete save
2259 ;; (not matching the actual disk file)
2260 ;; then don't mark unmodified.
2268 ;; Element (nil PROP VAL BEG . END) is property change.
2273 ;; Element (BEG . END) means range was inserted.
2275 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2276 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2279 ;; Set point first thing, so that undoing this undo
2280 ;; does not send point back to where it is now.
2283 ;; Element (apply FUN . ARGS) means call FUN to undo.
2287 ;; Long format: (apply DELTA START END FUN . ARGS).
2294 ;; Check that the function did what the entry
2295 ;; said it would do.
2305 ;; Element (STRING . POS) means STRING was deleted.
2311 ;; Check that marker adjustments which were recorded
2312 ;; with the (STRING . POS) record are still valid, ie
2313 ;; the markers haven't moved. We check their validity
2314 ;; before reinserting the string so as we don't need to
2315 ;; mind marker insertion-type.
2323 ;; Insert string and adjust point
2331 ;; Adjust the valid marker adjustments
2335 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2338 next)
2339 ;; Even though these elements are not expected in the undo
2340 ;; list, adjust them to be conservative for the 24.4
2341 ;; release. (Bug#16818)
2348 ;; Make sure an apply entry produces at least one undo entry,
2349 ;; so the test in `undo' for continuing an undo series
2350 ;; will work right.
2355 list)
2357 ;; Deep copy of a list
2359 "Make a copy of undo list LIST."
2365 elt))
2368 "Set `pending-undo-list' to the front of the undo list.
2369 The next call to `undo-more' will undo the most recently made change.
2370 If BEG and END are specified, then only undo elements
2371 that apply to text between BEG and END are used; other undo elements
2372 are ignored. If BEG and END are nil, all undo elements are used."
2378 buffer-undo-list)))
2381 "Return a list of undo elements for the region START to END.
2382 The elements come from `buffer-undo-list', but we keep only
2383 the elements inside this region, and discard those outside this region.
2384 If we find an element that crosses an edge of this region,
2385 we stop and ignore all further elements."
2388 some-rejected
2389 undo-elt temp-undo-list delta)
2394 ;; This is a "was unmodified" element.
2395 ;; Keep it if we have kept everything thus far.
2397 ;; Skip over marker adjustments, instead relying on
2398 ;; finding them after (TEXT . POS) elements
2400 nil)
2406 ;; Don't put two nils together in the list
2410 ;; If (TEXT . POS), "keep" its subsequent (MARKER
2411 ;; . ADJUSTMENT) whose markers haven't moved.
2431 ;; Loop down the earlier events adjusting their buffer
2432 ;; positions to reflect the fact that a change to the buffer
2433 ;; isn't being undone. We only need to process those element
2434 ;; types which undo-elt-in-region will return as being in
2435 ;; the region since only those types can ever get into the
2436 ;; output
2445 ;; (TEXT . POSITION)
2452 ;; (BEGIN . END)
2457 ;; (nil PROPERTY VALUE BEG . END)
2467 "Determine whether UNDO-ELT falls inside the region START ... END.
2468 If it crosses the edge, we return nil.
2470 Generally this function is not useful for determining
2471 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2472 because markers can be arbitrarily relocated. Instead, pass the
2473 marker adjustment's corresponding (TEXT . POS) element."
2478 t)
2480 nil)
2482 ;; (TEXT . POSITION)
2486 ;; (MARKER . ADJUSTMENT)
2489 ;; (nil PROPERTY VALUE BEG . END)
2494 ;; (BEGIN . END)
2499 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2500 This assumes we have already decided that UNDO-ELT
2501 is not *inside* the region START...END."
2504 ;; (nil PROPERTY VALUE BEG . END)
2509 ;; (BEGIN . END)
2513 ;; Return the first affected buffer position and the delta for an undo element
2514 ;; delta is defined as the change in subsequent buffer positions if we *did*
2515 ;; the undo.
2519 ;; (TEXT . POSITION)
2522 ;; (BEGIN . END)
2529 "If non-nil ask about discarding undo info for the current command.
2530 Normally, Emacs discards the undo info for the current command if
2531 it exceeds `undo-outer-limit'. But if you set this option
2532 non-nil, it asks in the echo area whether to discard the info.
2533 If you answer no, there is a slight risk that Emacs might crash, so
2534 only do it if you really want to undo the command.
2536 This option is mainly intended for debugging. You have to be
2537 careful if you use it for other purposes. Garbage collection is
2538 inhibited while the question is asked, meaning that Emacs might
2539 leak memory. So you should make sure that you do not wait
2540 excessively long before answering the question."
2546 "If non-nil, an extra level of size that's ok in an undo item.
2547 We don't ask the user about truncating the undo list until the
2548 current item gets bigger than this amount.
2553 ;; When the first undo batch in an undo list is longer than
2554 ;; undo-outer-limit, this function gets called to warn the user that
2555 ;; the undo info for the current command was discarded. Garbage
2556 ;; collection is inhibited around the call, so it had better not do a
2557 ;; lot of consing.
2563 ;; Don't ask the question again unless it gets even bigger.
2564 ;; This applies, in particular, if the user quits from the question.
2565 ;; Such a quit quits out of GC, but something else will call GC
2566 ;; again momentarily. It will call this function again,
2567 ;; but we don't want to ask the question again.
2574 t)
2575 nil))
2580 "The undo info was discarded because it exceeded \
2581 `undo-outer-limit'.
2583 This is normal if you executed a command that made a huge change
2584 to the buffer. In that case, to prevent similar problems in the
2585 future, set `undo-outer-limit' to a value that is large enough to
2586 cover the maximum size of normal changes you expect a single
2587 command to make, but not so large that it might exceed the
2588 maximum memory allotted to Emacs.
2590 If you did not execute any such command, the situation is
2591 probably due to a bug and you should report it.
2593 You can disable the popping up of this buffer by adding the entry
2594 \(undo discard-info) to the user option `warning-suppress-types',
2598 t))
2599 \f
2602 ; These are sorted according to the GNU en_US locale.
2645 )
2647 This is used by Shell mode and other parts of Emacs to recognize
2648 password prompts, including prompts in languages other than
2649 English. Different case choices should not be assumed to be
2650 included; callers should bind `case-fold-search' to t."
2656 "History list for some commands that read shell commands.
2658 Maximum length of the history list is determined by the value
2665 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2666 This buffer is used when `shell-command' or `shell-command-on-region'
2667 is run interactively. A value of nil means that output to stderr and
2674 "Return a list of all commands associated with the current file.
2675 This function is used to add all related commands retrieved by `mailcap'
2676 to the end of the list of defaults just after the default value."
2680 minibuffer-default))
2685 commands))
2696 map)
2700 "Read a shell command from the minibuffer.
2701 The arguments are the same as the ones of `read-from-minibuffer',
2702 except READ and KEYMAP are missing and HIST defaults
2703 to `shell-command-history'."
2711 minibuffer-local-shell-command-map
2712 nil
2714 args)))
2717 "What to do when the output buffer is used by another shell command.
2718 This option specifies how to resolve the conflict where a new command
2719 wants to direct its output to the buffer `*Async Shell Command*',
2720 but this buffer is already taken by another running shell command.
2722 The value `confirm-kill-process' is used to ask for confirmation before
2723 killing the already running process and running a new process
2724 in the same buffer, `confirm-new-buffer' for confirmation before running
2725 the command in a new buffer with a name other than the default buffer name,
2726 `new-buffer' for doing the same without confirmation,
2727 `confirm-rename-buffer' for confirmation before renaming the existing
2728 output buffer and running a new command in the default buffer,
2729 `rename-buffer' for doing the same without confirmation."
2731 confirm-kill-process)
2733 confirm-new-buffer)
2735 new-buffer)
2737 confirm-rename-buffer)
2739 rename-buffer))
2744 "Execute string COMMAND asynchronously in background.
2746 Like `shell-command', but adds `&' at the end of COMMAND
2747 to execute it asynchronously.
2749 The output appears in the buffer `*Async Shell Command*'.
2750 That buffer is in shell mode.
2752 You can configure `async-shell-command-buffer' to specify what to do in
2753 case when `*Async Shell Command*' buffer is already taken by another
2754 running shell command. To run COMMAND without displaying the output
2755 in a window you can configure `display-buffer-alist' to use the action
2756 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
2758 In Elisp, you will often be better served by calling `start-process'
2759 directly, since it offers more control and does not impose the use of a
2760 shell (with its need to quote arguments)."
2770 current-prefix-arg
2771 shell-command-default-error-buffer))
2777 "Execute string COMMAND in inferior shell; display output, if any.
2778 With prefix argument, insert the COMMAND's output at point.
2780 If COMMAND ends in `&', execute it asynchronously.
2781 The output appears in the buffer `*Async Shell Command*'.
2782 That buffer is in shell mode. You can also use
2783 `async-shell-command' that automatically adds `&'.
2785 Otherwise, COMMAND is executed synchronously. The output appears in
2786 the buffer `*Shell Command Output*'. If the output is short enough to
2787 display in the echo area (which is determined by the variables
2788 `resize-mini-windows' and `max-mini-window-height'), it is shown
2789 there, but it is nonetheless available in buffer `*Shell Command
2790 Output*' even though that buffer is not automatically displayed.
2792 To specify a coding system for converting non-ASCII characters
2794 before this command.
2796 Noninteractive callers can specify coding systems by binding
2797 `coding-system-for-read' and `coding-system-for-write'.
2799 The optional second argument OUTPUT-BUFFER, if non-nil,
2800 says to put the output in some other buffer.
2801 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2802 If OUTPUT-BUFFER is not a buffer and not nil,
2803 insert output in current buffer. (This cannot be done asynchronously.)
2804 In either case, the buffer is first erased, and the output is
2805 inserted after point (leaving mark after it).
2807 If the command terminates without error, but generates output,
2809 the output can be displayed in the echo area or in its buffer.
2810 If the output is short enough to display in the echo area
2811 \(determined by the variable `max-mini-window-height' if
2812 `resize-mini-windows' is non-nil), it is shown there.
2813 Otherwise,the buffer containing the output is displayed.
2817 of the output.
2819 If there is no output, or if output is inserted in the current buffer,
2820 then `*Shell Command Output*' is deleted.
2822 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2823 or buffer name to which to direct the command's standard error output.
2824 If it is nil, error output is mingled with regular output.
2825 In an interactive call, the variable `shell-command-default-error-buffer'
2826 specifies the value of ERROR-BUFFER.
2828 In Elisp, you will often be better served by calling `call-process' or
2829 `start-process' directly, since it offers more control and does not impose
2830 the use of a shell (with its need to quote arguments)."
2841 current-prefix-arg
2842 shell-command-default-error-buffer))
2843 ;; Look for a handler in case default-directory is a remote file name.
2851 ;; Output goes in current buffer.
2857 temporary-file-directory)))
2858 nil)))
2861 ;; We do not use -f for csh; we will not support broken use of
2862 ;; .cshrcs. Even the BSD csh manual says to use
2863 ;; "if ($?prompt) exit" before things which are not useful
2864 ;; non-interactively. Besides, if someone wants their other
2865 ;; aliases for shell commands then they can still have them.
2869 t)
2870 nil shell-command-switch command)
2877 ;; Do no formatting while reading error file,
2878 ;; because that can run a shell command, and we
2879 ;; don't want that to cause an infinite recursion.
2881 ;; Put point after the inserted errors.
2885 ;; This is like exchange-point-and-mark, but doesn't
2886 ;; activate the mark. It is cleaner to avoid activation,
2887 ;; even though the command loop would deactivate the mark
2888 ;; because we inserted text.
2892 ;; Output goes in a separate buffer.
2893 ;; Preserve the match data in case called from a program.
2896 ;; Command ending with ampersand means asynchronous.
2900 proc)
2901 ;; Remove the ampersand.
2903 ;; Ask the user what to do with already running process.
2908 ;; If will kill a process, query first.
2913 ;; If will create a new buffer, query first.
2919 ;; It will create a new buffer.
2923 ;; If will rename the buffer, query first.
2932 ;; It will rename the buffer.
2939 ;; Setting buffer-read-only to nil doesn't suffice
2940 ;; if some text has a non-nil read-only property,
2941 ;; which comint sometimes adds for prompts.
2947 shell-command-switch command))
2951 ;; Use the comint filter for proper handling of carriage motion
2952 ;; (see `comint-inhibit-carriage-motion'),.
2954 ))
2955 ;; Otherwise, command is executed synchronously.
2957 output-buffer nil error-buffer)))))))
2961 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2962 MESSAGE may be either a string or a buffer.
2964 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2965 the maximum height of the echo area, as defined by `max-mini-window-height'
2966 if `resize-mini-windows' is non-nil.
2968 Returns either the string shown in the echo area, or when a pop-up
2969 buffer is used, the window used to display it.
2971 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2972 name of the buffer used to display it in the case where a pop-up buffer
2973 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2974 string and it is displayed in the echo area, it is not specified whether
2975 the contents are inserted into the buffer anyway.
2977 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2978 and only used if a buffer is displayed."
2980 ;; Trivial case where we can use the echo area
2984 ;; Trivial case where we can just remove single trailing newline
2987 ;; General case
2990 message
2999 0
3003 (<= lines
3007 max-mini-window-height))
3009 max-mini-window-height)
3013 ;; Don't use the echo area if the output buffer is
3014 ;; already displayed in the selected frame.
3016 ;; Echo area
3022 ;; Buffer
3025 not-this-window frame))))))))
3028 ;; We have a sentinel to prevent insertion of a termination message
3029 ;; in the buffer itself.
3037 &optional output-buffer replace
3038 error-buffer display-error-buffer)
3039 "Execute string COMMAND in inferior shell with region as input.
3040 Normally display output (if any) in temp buffer `*Shell Command Output*';
3041 Prefix arg means replace the region with it. Return the exit code of
3042 COMMAND.
3044 To specify a coding system for converting non-ASCII characters
3046 before this command. By default, the input (from the current buffer)
3047 is encoded using coding-system specified by `process-coding-system-alist',
3048 falling back to `default-process-coding-system' if no match for COMMAND
3049 is found in `process-coding-system-alist'.
3051 Noninteractive callers can specify coding systems by binding
3052 `coding-system-for-read' and `coding-system-for-write'.
3054 If the command generates output, the output may be displayed
3055 in the echo area or in a buffer.
3056 If the output is short enough to display in the echo area
3057 \(determined by the variable `max-mini-window-height' if
3058 `resize-mini-windows' is non-nil), it is shown there.
3059 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3060 The output is available in that buffer in both cases.
3062 If there is output and an error, a message about the error
3063 appears at the end of the output. If there is no output, or if
3064 output is inserted in the current buffer, the buffer `*Shell
3065 Command Output*' is deleted.
3067 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3068 command's output. If the value is a buffer or buffer name,
3069 put the output there. If the value is nil, use the buffer
3070 `*Shell Command Output*'. Any other value, excluding nil,
3071 means to insert the output in the current buffer. In either case,
3072 the output is inserted after point (leaving mark after it).
3074 Optional fifth arg REPLACE, if non-nil, means to insert the
3075 output in place of text from START to END, putting point and mark
3076 around it.
3078 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3079 or buffer name to which to direct the command's standard error
3080 output. If nil, error output is mingled with regular output.
3081 When called interactively, `shell-command-default-error-buffer'
3082 is used for ERROR-BUFFER.
3084 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3085 display the error buffer if there were any errors. When called
3086 interactively, this is t."
3090 ;; Do this before calling region-beginning
3091 ;; and region-end, in case subprocess output
3092 ;; relocates them while we are in the minibuffer.
3094 ;; call-interactively recognizes region-beginning and
3095 ;; region-end specially, leaving them in the history.
3097 string
3098 current-prefix-arg
3099 current-prefix-arg
3100 shell-command-default-error-buffer
3101 t)))
3107 temporary-file-directory)))
3108 nil))
3109 exit-status)
3113 ;; Replace specified region with output from command.
3115 ;; Don't muck with mark unless REPLACE says we should.
3122 t)
3123 nil shell-command-switch command))
3124 ;; It is rude to delete a buffer which the command is not using.
3125 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3126 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3127 ;; (kill-buffer shell-buffer)))
3128 ;; Don't muck with mark unless REPLACE says we should.
3130 ;; No prefix argument: put the output in a temp buffer,
3131 ;; replacing its entire contents.
3136 ;; If the input is the same buffer as the output,
3137 ;; delete everything but the specified region,
3138 ;; then replace that region with the output.
3144 shell-file-name t
3147 t)
3148 nil shell-command-switch
3149 command)))
3150 ;; Clear the output buffer, then run the command with
3151 ;; output there.
3162 buffer)
3163 nil shell-command-switch command)))
3164 ;; Report the output.
3174 ;; There's some output, display it
3176 ;; No output; error?
3183 shell-command-default-error-buffer)
3190 output))
3193 exit-status))
3196 exit-status output))))
3197 ;; Don't kill: there might be useful info in the undo-log.
3198 ;; (kill-buffer buffer)
3199 ))))
3207 ;; Do no formatting while reading error file,
3208 ;; because that can run a shell command, and we
3209 ;; don't want that to cause an infinite recursion.
3211 ;; Put point after the inserted errors.
3216 exit-status))
3219 "Execute shell command COMMAND and return its output as a string."
3222 standard-output
3226 "Process files synchronously in a separate process.
3227 Similar to `call-process', but may invoke a file handler based on
3228 `default-directory'. The current working directory of the
3229 subprocess is `default-directory'.
3231 File names in INFILE and BUFFER are handled normally, but file
3232 names in ARGS should be relative to `default-directory', as they
3233 are passed to the process verbatim. (This is a difference to
3234 `call-process' which does not support file handlers for INFILE
3235 and BUFFER.)
3237 Some file handlers might not support all variants, for example
3238 they might behave as if DISPLAY was nil, regardless of the actual
3239 value passed."
3241 lc stderr-file)
3251 display args)
3257 "Whether a call of `process-file' changes remote files.
3259 By default, this variable is always set to `t', meaning that a
3260 call of `process-file' could potentially change any file on a
3261 remote host. When set to `nil', a file handler could optimize
3262 its behavior with respect to remote file attribute caching.
3264 You should only ever change this variable with a let-binding;
3268 "Start a program in a subprocess. Return the process object for it.
3270 Similar to `start-process', but may invoke a file handler based on
3271 `default-directory'. See Info node `(elisp)Magic File Names'.
3273 This handler ought to run PROGRAM, perhaps on the local host,
3274 perhaps on a remote host that corresponds to `default-directory'.
3275 In the latter case, the local part of `default-directory' becomes
3276 the working directory of the process.
3278 PROGRAM and PROGRAM-ARGS might be file names. They are not
3279 objects of file handler invocation. File handlers might not
3280 support pty association, if PROGRAM is nil."
3284 \f
3285 ;;;; Process menu
3297 "Major mode for listing the processes called by Emacs."
3309 "Recompute the list of processes for the Process List buffer.
3310 Also, delete any process that is exited or signaled."
3323 face link
3326 follow-link t
3327 process-buffer ,buf
3328 action process-menu-visit-buffer)
3337 "datagram"
3354 tabulated-list-entries))))))
3360 "Display a list of all processes that are Emacs sub-processes.
3361 If optional argument QUERY-ONLY is non-nil, only processes with
3362 the query-on-exit flag set are listed.
3363 Any process listed as exited or signaled is actually eliminated
3364 after the listing is made.
3365 Optional argument BUFFER specifies a buffer to use, instead of
3367 The return value is always nil.
3369 This function lists only processes that were launched by Emacs. To
3370 see other processes running on the system, use `list-system-processes'."
3382 nil)
3383 \f
3387 ;; For backward compatibility, minus with no modifiers is an ordinary
3388 ;; command if digits have already been entered.
3418 map)
3425 "Begin a numeric argument for the following command.
3430 multiplies the argument by 4 each time.
3432 which is different in effect from any particular numeric argument.
3439 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3440 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3446 arg)))
3450 "Begin a negative numeric argument for the next command.
3459 "Part of the numeric argument for the next command.
3463 last-command-event
3470 ;; Treat -0 as just -, so that -01 will work.
3473 digit))))
3475 \f
3483 "Function to perform the filtering in `filter-buffer-substring'.
3484 The function is called with the same 3 arguments (BEG END DELETE)
3485 that `filter-buffer-substring' received. It should return the
3486 buffer substring between BEG and END, after filtering. If DELETE is
3490 "List of filter functions for `buffer-substring--filter'.
3491 Each function must accept a single argument, a string, and return a string.
3492 The buffer substring is passed to the first function in the list,
3493 and the return value of each function is passed to the next.
3494 As a special convention, point is set to the start of the buffer text
3495 being operated on (i.e., the first argument of `buffer-substring--filter')
3501 "Return the buffer substring between BEG and END, after filtering.
3502 If DELETE is non-nil, delete the text between BEG and END from the buffer.
3504 This calls the function that `filter-buffer-substring-function' specifies
3505 \(passing the same three arguments that it received) to do the work,
3506 and returns whatever it does. The default function does no filtering,
3507 unless a hook has been set.
3509 Use `filter-buffer-substring' instead of `buffer-substring',
3510 `buffer-substring-no-properties', or `delete-and-extract-region' when
3511 you want to allow filtering to take place. For example, major or minor
3512 modes can use `filter-buffer-substring-function' to extract characters
3513 that are special to a buffer, and should not be copied into other buffers."
3517 "Default function to use for `filter-buffer-substring-function'.
3518 Its arguments and return value are as specified for `filter-buffer-substring'.
3519 This respects the wrapper hook `filter-buffer-substring-functions',
3520 and the abnormal hook `buffer-substring-filters'.
3521 No filtering is done unless a hook says to."
3531 string)))
3536 ;;;; Window system cut and paste hooks.
3539 "Function to call to make a killed region available to other programs.
3540 Most window systems provide a facility for cutting and pasting
3541 text between different programs, such as the clipboard on X and
3542 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3544 This variable holds a function that Emacs calls whenever text is
3545 put in the kill ring, to make the new kill available to other
3546 programs. The function takes one argument, TEXT, which is a
3550 "Function to call to get text cut from other programs.
3551 Most window systems provide a facility for cutting and pasting
3552 text between different programs, such as the clipboard on X and
3553 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3555 This variable holds a function that Emacs calls to obtain text
3556 that other programs have provided for pasting. The function is
3557 called with no arguments. If no other program has provided text
3558 to paste, the function should return nil (in which case the
3559 caller, usually `current-kill', should use the top of the Emacs
3560 kill ring). If another program has provided text to paste, the
3561 function should return that text as a string (in which case the
3562 caller should put this string in the kill ring as the latest
3563 kill).
3565 The function may also return a list of strings if the window
3566 system supports multiple selections. The first string will be
3567 used as the pasted text, but the other will be placed in the kill
3568 ring for easy access via `yank-pop'.
3570 Note that the function should return a string only if a program
3571 other than Emacs has provided a string for pasting; if Emacs
3572 provided the most recent string, the function should return nil.
3573 If it is difficult to tell whether Emacs or some other program
3574 provided the current string, it is probably good enough to return
3575 nil if the string is equal (according to `string=') to the last
3577 \f
3580 ;;;; The kill ring data structure.
3583 "List of killed text sequences.
3584 Since the kill ring is supposed to interact nicely with cut-and-paste
3585 facilities offered by window systems, use of this variable should
3586 interact nicely with `interprogram-cut-function' and
3587 `interprogram-paste-function'. The functions `kill-new',
3588 `kill-append', and `current-kill' are supposed to implement this
3589 interaction; you may want to use them instead of manipulating the kill
3593 "Maximum length of kill ring before oldest elements are thrown away."
3601 "Save clipboard strings into kill ring before replacing them.
3602 When one selects something in another program to paste it into Emacs,
3603 but kills something in Emacs before actually pasting it,
3604 this selection is gone unless this variable is non-nil,
3605 in which case the other program's selection is saved in the `kill-ring'
3612 "Do not add a new string to `kill-ring' if it duplicates the last one.
3613 The comparison is done using `equal-including-properties'."
3619 "Make STRING the latest kill in the kill ring.
3620 Set `kill-ring-yank-pointer' to point to it.
3621 If `interprogram-cut-function' is non-nil, apply it to STRING.
3622 Optional second argument REPLACE non-nil means that STRING will replace
3623 the front of the kill ring, rather than being added to the list.
3625 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3626 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3627 STRING.
3629 When the yank handler has a non-nil PARAM element, the original STRING
3630 argument is not used by `insert-for-yank'. However, since Lisp code
3631 may access and use elements from the kill ring directly, the STRING
3634 ;; Due to text properties such as 'yank-handler that
3635 ;; can alter the contents to yank, comparison using
3636 ;; `equal' is unsafe.
3662 "Append STRING to the end of the latest kill in the kill ring.
3663 If BEFORE-P is non-nil, prepend STRING to the kill.
3664 If `interprogram-cut-function' is set, pass the resulting kill to it."
3671 "Whether rotating the kill ring changes the window system selection.
3672 If non-nil, whenever the kill ring is rotated (usually via the
3673 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3674 to copy the new kill to the window system selection."
3680 "Rotate the yanking point by N places, and then return that kill.
3681 If N is zero and `interprogram-paste-function' is set to a
3682 function that returns a string or a list of strings, and if that
3683 function doesn't return nil, then that string (or list) is added
3684 to the front of the kill ring and the string (or first string in
3685 the list) is returned as the latest kill.
3687 If N is not zero, and if `yank-pop-change-selection' is
3688 non-nil, use `interprogram-cut-function' to transfer the
3689 kill at the new yank point into the window system selection.
3691 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3692 move the yanking point; just return the Nth kill forward."
3695 interprogram-paste-function
3699 ;; Disable the interprogram cut function when we add the new
3700 ;; text to the kill ring, so Emacs doesn't try to own the
3701 ;; selection, with identical text.
3711 kill-ring)))
3716 interprogram-cut-function)
3722 ;;;; Commands for manipulating the kill ring.
3725 "Non-nil means don't signal an error for killing read-only text."
3731 This deletes the text from the buffer and saves it in the kill ring.
3735 If you want to append the killed region to the last killed text,
3738 If the buffer is read-only, Emacs will beep and refrain from deleting
3739 the text, but put the text in the kill ring anyway. This means that
3740 you can use the killing commands to copy text from a read-only buffer.
3742 Lisp programs should use this function for killing text.
3743 (To delete text, use `delete-region'.)
3744 Supply two arguments, character positions indicating the stretch of text
3745 to be killed.
3747 If the previous command was also a kill command,
3748 the text killed this time appends to the text killed last time
3749 to make one entry in the kill ring.
3751 The optional argument REGION if non-nil, indicates that we're not just killing
3752 some text between BEG and END, but we're killing the region."
3753 ;; Pass mark first, then point, because the order matters when
3754 ;; calling `kill-append'.
3763 ;; Add that string to the kill ring, one way or another.
3770 nil)
3772 ;; The code above failed because the buffer, or some of the characters
3773 ;; in the region, are read-only.
3774 ;; We should beep, in case the user just isn't aware of this.
3775 ;; However, there's no harm in putting
3776 ;; the region's text in the kill ring, anyway.
3778 ;; Set this-command now, so it will be set even if we get an error.
3780 ;; This should barf, if appropriate, and give us the correct error.
3783 ;; Signal an error if the buffer is read-only.
3785 ;; If the buffer isn't read-only, the text is.
3788 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3789 ;; to get two copies of the text when the user accidentally types M-w and
3790 ;; then corrects it with the intended C-w.
3792 "Save the region as if killed, but don't kill it.
3793 In Transient Mark mode, deactivate the mark.
3794 If `interprogram-cut-function' is non-nil, also save the text for a window
3795 system cut and paste.
3797 The optional argument REGION if non-nil, indicates that we're not just copying
3798 some text between BEG and END, but we're copying the region.
3800 This command's old key binding has been given to `kill-ring-save'."
3801 ;; Pass mark first, then point, because the order matters when
3802 ;; calling `kill-append'.
3812 nil)
3815 "Save the region as if killed, but don't kill it.
3816 In Transient Mark mode, deactivate the mark.
3817 If `interprogram-cut-function' is non-nil, also save the text for a window
3818 system cut and paste.
3820 If you want to append the killed line to the last killed text,
3823 The optional argument REGION if non-nil, indicates that we're not just copying
3824 some text between BEG and END, but we're copying the region.
3826 This command is similar to `copy-region-as-kill', except that it gives
3827 visual feedback indicating the extent of the region being copied."
3828 ;; Pass mark first, then point, because the order matters when
3829 ;; calling `kill-append'.
3833 ;; This use of called-interactively-p is correct because the code it
3834 ;; controls just gives the user visual feedback.
3839 "Indicate that the region text has been copied interactively.
3840 If the mark is visible in the selected window, blink the cursor
3841 between point and mark if there is currently no active region
3842 highlighting.
3844 If the mark lies outside the selected window, display an
3845 informative message containing a sample of the copied text. The
3846 optional argument MESSAGE-LEN, if non-nil, specifies the length
3847 of this sample text; it defaults to 40."
3850 ;; Inhibit quitting so we can make a quit here
3851 ;; look like a C-g typed as a command.
3854 ;; Swap point-and-mark quickly so as to show the region that
3855 ;; was selected. Don't do it if the region is highlighted.
3858 ;; Swap point and mark.
3862 ;; Swap back.
3865 ;; If user quit, deactivate the mark
3866 ;; as C-g would as a command.
3872 ;; Don't say "killed"; that is misleading.
3879 "Cause following command, if it kills, to add to previous kill.
3880 If the next command kills forward from point, the kill is
3881 appended to the previous killed text. If the command kills
3882 backward, the kill is prepended. Kill commands that act on the
3883 region, such as `kill-region', are regarded as killing forward if
3884 point is after mark, and killing backward if point is before
3885 mark.
3887 If the next command is not a kill command, `append-next-kill' has
3888 no effect.
3890 The argument is used for internal purposes; do not supply one."
3892 ;; We don't use (interactive-p), since that breaks kbd macros.
3898 \f
3899 ;; Yanking.
3904 "List of special text property handling conditions for yanking.
3905 Each element should have the form (PROP . FUN), where PROP is a
3906 property symbol and FUN is a function. When the `yank' command
3907 inserts text into the buffer, it scans the inserted text for
3908 stretches of text that have `eq' values of the text property
3909 PROP; for each such stretch of text, FUN is called with three
3910 arguments: the property's value in that text, and the start and
3911 end positions of the text.
3913 This is done prior to removing the properties specified by
3914 `yank-excluded-properties'."
3917 function))
3920 ;; This is actually used in subr.el but defcustom does not work there.
3923 intangible invisible keymap local-map mouse-face read-only
3924 yank-handler)
3925 "Text properties to discard when yanking.
3926 The value should be a list of text properties to discard or t,
3927 which means to discard all text properties.
3929 See also `yank-handled-properties'."
3936 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3937 Function is called with two parameters, START and END corresponding to
3938 the value of the mark and point; it is guaranteed that START <= END.
3942 "Replace just-yanked stretch of killed text with a different stretch.
3943 This command is allowed only immediately after a `yank' or a `yank-pop'.
3944 At such a time, the region contains a stretch of reinserted
3945 previously-killed text. `yank-pop' deletes that text and inserts in its
3946 place a different stretch of killed text.
3948 With no argument, the previous kill is inserted.
3949 With argument N, insert the Nth previous kill.
3950 If N is negative, this is a more recent kill.
3952 The sequence of kills wraps around, so that after the oldest one
3953 comes the newest one.
3955 When this command inserts killed text into the buffer, it honors
3956 `yank-excluded-properties' and `yank-handler' as described in the
3957 doc string for `insert-for-yank-1', which see."
3971 ;; Set the window start back where it was in the yank command,
3972 ;; if possible.
3975 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3976 ;; It is cleaner to avoid activation, even though the command
3977 ;; loop would deactivate the mark because we inserted text.
3980 nil)
3984 More precisely, reinsert the most recent kill, which is the
3985 stretch of killed text most recently killed OR yanked. Put point
3986 at the end, and set mark at the beginning without activating it.
3988 With argument N, reinsert the Nth most recent kill.
3990 When this command inserts text into the buffer, it honors the
3991 `yank-handled-properties' and `yank-excluded-properties'
3992 variables, and the `yank-handler' text property. See
3993 `insert-for-yank-1' for details.
3998 ;; If we don't get all the way thru, make last-command indicate that
3999 ;; for the following command.
4007 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4008 ;; It is cleaner to avoid activation, even though the command
4009 ;; loop would deactivate the mark because we inserted text.
4012 ;; If we do get all the way thru, make this-command indicate that.
4015 nil)
4018 "Rotate the yanking point in the kill ring.
4019 With ARG, rotate that many kills forward (or backward, if negative)."
4022 \f
4023 ;; Some kill commands.
4025 ;; Internal subroutine of delete-char
4031 ;; Internal subroutine of backward-delete-char
4038 "The method for untabifying when deleting backward.
4039 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4040 `hungry' -- delete all whitespace, both tabs and spaces;
4041 `all' -- delete all whitespace, including tabs, spaces and newlines;
4042 nil -- just delete one character."
4048 "Delete characters backward, changing tabs into spaces.
4049 The exact behavior depends on `backward-delete-char-untabify-method'.
4050 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4051 Interactively, ARG is the prefix arg (default 1)
4052 and KILLP is t if a prefix arg was specified."
4075 arg)))
4076 ;; Avoid warning about delete-backward-char
4080 "Kill up to and including ARGth occurrence of CHAR.
4081 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4082 Goes backward if ARG is negative; error if CHAR not found."
4085 ;; Avoid "obsolete" warnings for translation-table-for-input.
4093 ;; kill-line and its subroutines.
4096 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4101 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4102 With prefix argument ARG, kill that many lines from point.
4103 Negative arguments kill lines backward.
4104 With zero argument, kills the text before point on the current line.
4107 a number counts as a prefix arg.
4109 To kill a whole line, when point is not at the beginning, type \
4112 If `show-trailing-whitespace' is non-nil, this command will just
4113 kill the rest of the current line, even if there are only
4114 nonblanks there.
4116 If option `kill-whole-line' is non-nil, then this command kills the whole line
4117 including its terminating newline, when used at the beginning of a line
4118 with no argument. As a consequence, you can always kill a whole line
4121 If you want to append the killed line to the last killed text,
4124 If the buffer is read-only, Emacs will beep and refrain from deleting
4125 the line, but put the line in the kill ring anyway. This means that
4126 you can use this command to copy text from a read-only buffer.
4127 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4128 even beep.)"
4131 ;; It is better to move point to the other end of the kill
4132 ;; before killing. That way, in a read-only buffer, point
4133 ;; moves across the text that is copied to the kill ring.
4134 ;; The choice has no effect on undo now that undo records
4135 ;; the value of point from before the command was run.
4145 ;; If trailing whitespace is visible,
4146 ;; don't treat it as nothing.
4156 "Kill current line.
4157 With prefix ARG, kill that many lines starting from the current line.
4158 If ARG is negative, kill backward. Also kill the preceding newline.
4160 If ARG is zero, kill current line but exclude the trailing newline."
4171 ;; We need to kill in two steps, because the previous command
4172 ;; could have been a kill command, in which case the text
4173 ;; before point needs to be prepended to the current kill
4174 ;; ring entry and the text after point appended. Also, we
4175 ;; need to use save-excursion to avoid copying the same text
4176 ;; twice to the kill ring in read-only buffers.
4194 "Move forward by ARG lines, ignoring currently invisible newlines only.
4195 If ARG is negative, move backward -ARG lines.
4196 If ARG is zero, move to the beginning of the current line."
4203 ;; If the newline we just skipped is invisible,
4204 ;; don't count it.
4208 prop
4213 ;; If invisible text follows, and it is a number of complete lines,
4214 ;; skip it.
4220 prop
4236 ;; If the newline we just moved to is invisible,
4237 ;; don't count it.
4242 prop
4247 ;; If invisible text follows, and it is a number of complete lines,
4248 ;; skip it.
4254 prop
4265 nil)))
4268 "Move to end of current visible line."
4270 ;; If the following character is currently invisible,
4271 ;; skip all characters with that same `invisible' property value,
4272 ;; then find the next newline.
4279 prop
4288 \f
4290 "Insert after point the contents of BUFFER.
4291 Puts mark after the inserted text.
4292 BUFFER may be a buffer or a buffer name.
4294 This function is meant for the user to run interactively.
4295 Don't call it from programs: use `insert-buffer-substring' instead!"
4304 t))))
4309 nil)
4313 "Append to specified buffer the text of the region.
4314 It is inserted into that buffer before its point.
4316 When calling from a program, give three arguments:
4317 BUFFER (or buffer name), START and END.
4318 START and END specify the portion of the current buffer to be copied."
4325 point)
4336 "Prepend to specified buffer the text of the region.
4337 It is inserted into that buffer after its point.
4339 When calling from a program, give three arguments:
4340 BUFFER (or buffer name), START and END.
4341 START and END specify the portion of the current buffer to be copied."
4350 "Copy to specified buffer the text of the region.
4351 It is inserted into that buffer, replacing existing text there.
4353 When calling from a program, give three arguments:
4354 BUFFER (or buffer name), START and END.
4355 START and END specify the portion of the current buffer to be copied."
4363 \f
4367 "Hook run when the mark becomes active.
4368 It is also run at the end of a command, if the mark is active and
4375 "Return this buffer's mark value as integer, or nil if never set.
4377 In Transient Mark mode, this function signals an error if
4378 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4379 or the argument FORCE is non-nil, it disregards whether the mark
4380 is active, and returns an integer or nil in the usual way.
4382 If you are using this in an editing command, you are most likely making
4383 a mistake; see the documentation of `set-mark'."
4388 ;; Behind display-selections-p.
4395 "Deactivate the mark.
4396 If Transient Mark mode is disabled, this function normally does
4397 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4399 Deactivating the mark sets `mark-active' to nil, updates the
4400 primary selection according to `select-active-regions', and runs
4401 `deactivate-mark-hook'.
4403 If Transient Mark mode was temporarily enabled, reset the value
4404 of the variable `transient-mark-mode'; if this causes Transient
4405 Mark mode to be disabled, don't change `mark-active' to nil or
4406 run `deactivate-mark-hook'."
4410 select-active-regions)
4413 ;; The var `saved-region-selection', if non-nil, is the text in
4414 ;; the region prior to the last command modifying the buffer.
4415 ;; Set the selection to that, or to the current region.
4419 ;; If another program has acquired the selection, region
4420 ;; deactivation should not clobber it (Bug#11772).
4437 "Activate the mark.
4438 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
4448 "Set this buffer's mark to POS. Don't use this function!
4449 That is to say, don't use this function unless you want
4450 the user to see that the mark has moved, and you want the previous
4451 mark position to be lost.
4453 Normally, when a new mark is set, the old one should go on the stack.
4454 This is why most applications should use `push-mark', not `set-mark'.
4456 Novice Emacs Lisp programmers often try to use the mark for the wrong
4457 purposes. The mark saves a location for the user's convenience.
4458 Most editing commands should not alter the mark.
4459 To remember a location for internal use in the Lisp program,
4460 store it in a Lisp variable. Example:
4462 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4467 ;; Normally we never clear mark-active except in Transient Mark mode.
4468 ;; But when we actually clear out the mark value too, we must
4469 ;; clear mark-active in any mode.
4471 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
4472 ;; it should never be nil if the mark is nil.
4478 If nil, region-aware commands treat empty regions as inactive.
4479 If non-nil, region-aware commands treat the region as active as
4480 long as the mark is active, even if the region is empty.
4482 Region-aware commands are those that act on the region if it is
4483 active and Transient Mark mode is enabled, and on the text near
4484 point otherwise."
4490 "Return t if the region is active and it is appropriate to act on it.
4491 This is used by commands that act specially on the region under
4492 Transient Mark mode.
4494 The return value is t if Transient Mark mode is enabled and the
4495 mark is active; furthermore, if `use-empty-active-region' is nil,
4496 the region must not be empty. Otherwise, the return value is nil.
4498 For some commands, it may be appropriate to ignore the value of
4499 `use-empty-active-region'; in that case, use `region-active-p'."
4504 "Return t if Transient Mark mode is enabled and the mark is active.
4506 Some commands act specially on the region when Transient Mark
4507 mode is enabled. Usually, such commands should use
4508 `use-region-p' instead of this function, because `use-region-p'
4509 also checks the value of `use-empty-active-region'."
4511 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
4512 ;; without the mark being set (e.g. bug#17324). We really should fix
4513 ;; that problem, but in the mean time, let's make sure we don't say the
4514 ;; region is active when there's no mark.
4528 ;; Normal priority so that a large region doesn't hide all the
4529 ;; overlays within it, but high secondary priority so that if it
4530 ;; ends/starts in the middle of a small overlay, that small overlay
4531 ;; won't hide the region's boundaries.
4533 nrol)
4538 rol)))
4551 start end window rol)))
4554 new)))))))
4579 "Maximum size of mark ring. Start discarding off end if gets this big."
4587 "Maximum size of global mark ring. \
4588 Start discarding off end if gets this big."
4593 "Jump to mark, and pop a new position for mark off the ring.
4594 \(Does not affect global mark ring)."
4604 "Set mark at where point is.
4605 If no prefix ARG and mark is already set there, just activate it.
4606 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4618 will pop the mark twice, and
4620 will pop the mark three times.
4628 "Set the mark where point is, or jump to the mark.
4629 Setting the mark also alters the region, which is the text
4630 between point and mark; this is the closest equivalent in
4633 With no prefix argument, set the mark at point, and push the
4634 old mark position on local mark ring. Also push the old mark on
4635 global mark ring, if the previous mark was set in another buffer.
4637 When Transient Mark Mode is off, immediately repeating this
4638 command activates `transient-mark-mode' temporarily.
4641 jump to the mark, and set the mark from
4642 position popped off the local mark ring (this does not affect the global
4644 mark ring (see `pop-global-mark').
4646 If `set-mark-command-repeat-pop' is non-nil, repeating
4648 off the local (or global) mark ring and jumps there.
4651 argument, unconditionally set mark where point is, even if
4652 `set-mark-command-repeat-pop' is non-nil.
4654 Novice Emacs Lisp programmers often try to use the mark for the wrong
4655 purposes. See the documentation of `set-mark' for more information."
4691 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4692 If the last global mark pushed was not in the current buffer,
4693 also push LOCATION on the global mark ring.
4694 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4696 Novice Emacs Lisp programmers often try to use the mark for the wrong
4697 purposes. See the documentation of `set-mark' for more information.
4699 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4706 ;; Now push the mark on the global mark ring.
4709 ;; The last global mark pushed was in this same buffer.
4710 ;; Don't push another one.
4711 nil
4720 nil)
4723 "Pop off mark ring into the buffer's actual mark.
4724 Does not set point. Does nothing if mark ring is empty."
4736 "Put the mark where point is now, and point where the mark is now.
4737 This command works even when the mark is not active,
4738 and it reactivates the mark.
4740 If Transient Mark mode is on, a prefix ARG deactivates the mark
4741 if it is active, and otherwise avoids reactivating it. If
4742 Transient Mark mode is off, a prefix ARG enables Transient Mark
4743 mode temporarily."
4757 nil))
4760 "When non-nil, shifted motion keys activate the mark momentarily.
4762 While the mark is activated in this way, any shift-translated point
4763 motion key extends the region, and if Transient Mark mode was off, it
4764 is temporarily turned on. Furthermore, the mark will be deactivated
4765 by any subsequent point motion key that was not shift-translated, or
4766 by any action that normally deactivates the mark in Transient Mark mode.
4768 See `this-command-keys-shift-translated' for the meaning of
4769 shift-translation."
4774 "Activate/deactivate mark depending on invocation thru shift translation.
4775 This function is called by `call-interactively' when a command
4776 with a `^' character in its `interactive' spec is invoked, before
4777 running the command itself.
4779 If `shift-select-mode' is enabled and the command was invoked
4780 through shift translation, set the mark and activate the region
4781 temporarily, unless it was already set in this way. See
4782 `this-command-keys-shift-translated' for the meaning of shift
4783 translation.
4785 Otherwise, if the region has been activated temporarily,
4786 deactivate it, and restore the variable `transient-mark-mode' to
4787 its earlier value."
4794 transient-mark-mode)))
4801 "Toggle Transient Mark mode.
4802 With a prefix argument ARG, enable Transient Mark mode if ARG is
4803 positive, and disable it otherwise. If called from Lisp, enable
4804 Transient Mark mode if ARG is omitted or nil.
4806 Transient Mark mode is a global minor mode. When enabled, the
4807 region is highlighted whenever the mark is active. The mark is
4809 operations that set the mark but whose main purpose is something
4815 Many commands change their behavior when Transient Mark mode is
4816 in effect and the mark is active, by acting on the region instead
4817 of their usual default part of the buffer's text. Examples of
4820 To see the documentation of commands which are sensitive to the
4823 :global t
4824 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4828 "Non-nil means it is ok for commands to call `widen' when they want to.
4829 Some commands will do this in order to go to positions outside
4830 the current accessible part of the buffer.
4832 If `widen-automatically' is nil, these commands will do something else
4836 "Whether the currently executing code is performing an essential task.
4837 This variable should be non-nil only when running code which should not
4838 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4839 user for a password when we are simply scanning a set of files in the
4840 background or displaying possible completions before the user even asked
4844 "Pop off global mark ring and jump to the top location."
4846 ;; Pop entries which refer to non-existent buffers.
4864 \f
4866 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4872 "Move cursor vertically down ARG lines.
4873 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4874 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4875 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4876 function will not vscroll.
4878 ARG defaults to 1.
4880 If there is no character in the target line exactly under the current column,
4881 the cursor is positioned after the character in that line which spans this
4882 column, or at the end of the line if it is not long enough.
4883 If there is no line in the buffer after this one, behavior depends on the
4884 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4885 to create a line, and moves the cursor to that line. Otherwise it moves the
4886 cursor to the end of the buffer.
4888 If the variable `line-move-visual' is non-nil, this command moves
4889 by display lines. Otherwise, it moves by buffer lines, without
4890 taking variable-width characters or continued lines into account.
4893 a semipermanent goal column for this command.
4894 Then instead of trying to move exactly vertically (or as close as possible),
4895 this command moves to the specified goal column (or as close as possible).
4896 The goal column is stored in the variable `goal-column', which is nil
4897 when there is no goal column. Note that setting `goal-column'
4898 overrides `line-move-visual' and causes this command to move by buffer
4899 lines rather than by display lines.
4901 If you are thinking of using this in a Lisp program, consider
4902 using `forward-line' instead. It is usually easier to use
4903 and more reliable (no dependence on goal column, etc.)."
4908 ;; When adding a newline, don't expand an abbrev.
4919 nil)
4923 "Move cursor vertically up ARG lines.
4924 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4925 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4926 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4927 function will not vscroll.
4929 ARG defaults to 1.
4931 If there is no character in the target line exactly over the current column,
4932 the cursor is positioned after the character in that line which spans this
4933 column, or at the end of the line if it is not long enough.
4935 If the variable `line-move-visual' is non-nil, this command moves
4936 by display lines. Otherwise, it moves by buffer lines, without
4937 taking variable-width characters or continued lines into account.
4940 a semipermanent goal column for this command.
4941 Then instead of trying to move exactly vertically (or as close as possible),
4942 this command moves to the specified goal column (or as close as possible).
4943 The goal column is stored in the variable `goal-column', which is nil
4944 when there is no goal column. Note that setting `goal-column'
4945 overrides `line-move-visual' and causes this command to move by buffer
4946 lines rather than by display lines.
4948 If you are thinking of using this in a Lisp program, consider using
4949 `forward-line' with a negative argument instead. It is usually easier
4950 to use and more reliable (no dependence on goal column, etc.)."
4959 nil)
4964 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4965 This means moving to the end of each line moved onto.
4966 The beginning of a blank line does not count as the end of a line.
4967 This has no effect when the variable `line-move-visual' is non-nil."
4973 A non-nil setting overrides the variable `line-move-visual', which see."
4980 "Current goal column for vertical motion.
4981 It is the column where point was at the start of the current run
4982 of vertical motion commands.
4984 When moving by visual lines via the function `line-move-visual', it is a cons
4985 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4986 divided by the default column width, and HSCROLL is the number of
4987 columns by which window is scrolled from left margin.
4989 When the `track-eol' feature is doing its job, the value is
4993 "Non-nil means commands that move by lines ignore invisible newlines.
4994 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
4995 as if newlines that are invisible didn't exist, and count
4996 only visible newlines. Thus, moving across across 2 newlines
4997 one of which is invisible will be counted as a one-line move.
4998 Also, a non-nil value causes invisible text to be ignored when
4999 counting columns for the purposes of keeping point in the same
5002 Outline mode sets this."
5007 "When non-nil, `line-move' moves point by visual lines.
5008 This movement is based on where the cursor is displayed on the
5009 screen, instead of relying on buffer contents alone. It takes
5010 into account variable-width characters and line continuation.
5011 If nil, `line-move' moves point by logical lines.
5012 A non-nil setting of `goal-column' overrides the value of this variable
5013 and forces movement by logical lines.
5014 A window that is horizontally scrolled also forces movement by logical
5015 lines."
5020 ;; Only used if display-graphic-p.
5024 "Return the height in pixels of the current buffer's default face font."
5028 ;; Avoid calling font-info if the frame's default font was
5029 ;; not changed since the frame was created. That's because
5030 ;; font-info is expensive for some fonts, see bug #14838.
5036 "Return the pixel height of current buffer's default-face text line.
5038 The value includes `line-spacing', if any, defined for the buffer
5039 or the frame."
5052 "Return the number of screen lines in the text area of the selected window.
5054 This is different from `window-text-height' in that this function counts
5055 lines in units of the height of the font used by the default face displayed
5056 in the window, not in units of the frame's default font, and also accounts
5057 for `line-spacing', if any, defined for the window's buffer or frame.
5059 The value is a floating-point number."
5064 ;; Returns non-nil if partial move was done.
5067 ;; Move backward (up).
5068 ;; If already vscrolled, reduce vscroll
5074 ;; Move forward (down).
5087 py vs last-line)
5107 col-row)
5112 ;; VPOS > 0 means the last line is only partially visible.
5113 ;; But if the part that is visible is at least as tall as the
5114 ;; default font, that means the line is actually fully
5115 ;; readable, and something like line-spacing is hidden. So in
5116 ;; that case we accept the last line in the window as still
5117 ;; visible, and consider the margin as starting one line
5118 ;; later.
5126 ;; If last line of window is fully visible, and vscrolling
5127 ;; more would make this line invisible, move forward.
5132 nil)
5133 ;; If cursor is not in the bottom scroll margin, and the
5134 ;; current line is is not too tall, move forward.
5136 vpos
5139 nil)
5140 ;; When already vscrolled, we vscroll some more if we can,
5141 ;; or clear vscroll and move forward at end of tall image.
5146 ;; If cursor just entered the bottom scroll margin, move forward,
5147 ;; but also optionally vscroll one line so redisplay won't recenter.
5151 ;; Don't vscroll if the partially-visible line at window
5152 ;; bottom is not too tall (a.k.a. "just one more text
5153 ;; line"): in that case, we do want redisplay to behave
5154 ;; normally, i.e. recenter or whatever.
5155 ;;
5156 ;; Note: ROWH + RBOT from the value returned by
5157 ;; pos-visible-in-window-p give the total height of the
5158 ;; partially-visible glyph row at the end of the window. As
5159 ;; we are dealing with floats, we disregard sub-pixel
5160 ;; discrepancies between that and DLH.
5164 t)
5165 ;; If there are lines above the last line, scroll-up one line.
5168 t)
5169 ;; Finally, start vscroll.
5174 ;; This is like line-move-1 except that it also performs
5175 ;; vertical scrolling of tall images if appropriate.
5176 ;; That is not really a clean thing to do, since it mixes
5177 ;; scrolling with cursor motion. But so far we don't have
5178 ;; a cleaner solution to the problem of making C-n do something
5179 ;; useful given a tall image.
5181 "Move forward ARG lines.
5182 If NOERROR, don't signal an error if we can't move ARG lines.
5183 TO-END is unused.
5184 TRY-VSCROLL controls whether to vscroll tall lines: if either
5185 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5186 not vscroll."
5190 ;; Only vscroll for single line moves
5192 ;; Under scroll-conservatively, the display engine
5193 ;; does this better.
5195 ;; But don't vscroll in a keyboard macro.
5201 ;; Display-based column are incompatible with goal-column.
5203 ;; When the text in the window is scrolled to the left,
5204 ;; display-based motion doesn't make sense (because each
5205 ;; logical line occupies exactly one screen line).
5207 ;; Likewise when the text _was_ scrolled to the left
5208 ;; when the current run of vertical motion commands
5209 ;; started.
5212 auto-hscroll-mode
5214 (>= temporary-goal-column
5217 ;; If we moved into a tall line, set vscroll to make
5218 ;; scrolling through tall images more smooth.
5222 winh)
5228 nil
5232 ;; Display-based alternative to line-move-1.
5233 ;; Arg says how many lines to move. The value is t if we can move the
5234 ;; specified number of lines.
5236 "Move ARG lines forward.
5237 If NOERROR, don't signal an error if we can't move that many lines."
5240 target-hscroll)
5241 ;; Check if the previous command was a line-motion command, or if
5242 ;; we were called from some other command.
5245 ;; If so, there's no need to reset `temporary-goal-column',
5246 ;; but we may need to hscroll.
5250 ;; Otherwise, we should reset `temporary-goal-column'.
5253 ;; Handle the `overflow-newline-into-fringe' case:
5262 ;; vertical-motion can move more than it was asked to if it moves
5263 ;; across display strings with newlines. We don't want to ring
5264 ;; the bell and announce beginning/end of buffer in that case.
5270 temporary-goal-column))
5271 arg))
5272 arg))
5278 temporary-goal-column))
5279 arg))
5280 arg)))
5283 ;; If the goal column lies on a display string,
5284 ;; `vertical-motion' advances the cursor to the end
5285 ;; of the string. For arg < 0, this can cause the
5286 ;; cursor to get stuck. (Bug#3020).
5290 nil)))))
5292 ;; This is the guts of next-line and previous-line.
5293 ;; Arg says how many lines to move.
5294 ;; The value is t if we can move the specified number of lines.
5296 ;; Don't run any point-motion hooks, and disregard intangibility,
5297 ;; for intermediate positions.
5309 ;; Don't count beg of empty line as end of line
5310 ;; unless we just did explicit end-of-line.
5312 most-positive-fixnum
5316 line-move-ignore-invisible))
5317 ;; Use just newline characters.
5318 ;; Set ARG to 0 if we move as many lines as requested.
5321 ;; This way of moving forward ARG lines
5322 ;; verifies that we have a newline after the last one.
5323 ;; It doesn't get confused by intangible text.
5332 'beginning-of-buffer
5334 nil)))
5335 ;; Move by arg lines, but ignore invisible ones.
5338 ;; If the following character is currently invisible,
5339 ;; skip all characters with that same `invisible' property value.
5342 ;; Move a line.
5343 ;; We don't use `end-of-line', since we want to escape
5344 ;; from field boundaries occurring exactly at point.
5350 ;; If there's no invisibility here, move over the newline.
5359 ;; We avoid vertical-motion when possible
5360 ;; because that has to fontify.
5362 ;; Otherwise move a more sophisticated way.
5369 ;; The logic of this is the same as the loop above,
5370 ;; it just goes in the other direction.
5372 ;; For completely consistency with the forward-motion
5373 ;; case, we should call beginning-of-line here.
5374 ;; However, if point is inside a field and on a
5375 ;; continued line, the call to (vertical-motion -1)
5376 ;; below won't move us back far enough; then we return
5377 ;; to the same column in line-move-finish, and point
5378 ;; gets stuck -- cyd
5396 ;; if our target is the middle of this line.
5401 ;; This is the value the function returns.
5405 ;; If we did not move down as far as desired, at least go
5406 ;; to end of line. Be sure to call point-entered and
5407 ;; point-left-hooks.
5413 ;; If we did not move up as far as desired,
5414 ;; at least go to beginning of line.
5426 ;; Set REPEAT to t to repeat the whole thing.
5433 ;; Compute the end of the line
5434 ;; ignoring effectively invisible newlines.
5436 ;; Like end-of-line but ignores fields.
5443 ;; Move to the desired column.
5446 ;; Corner case: suppose we start out in a field boundary in
5447 ;; the middle of a continued line. When we get to
5448 ;; line-move-finish, point is at the start of a new *screen*
5449 ;; line but the same text line; then line-move-to-column would
5450 ;; move us backwards. Test using C-n with point on the "x" in
5451 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5458 ;; Process intangibility within a line.
5459 ;; With inhibit-point-motion-hooks bound to nil, a call to
5460 ;; goto-char moves point past intangible text.
5462 ;; However, inhibit-point-motion-hooks controls both the
5463 ;; intangibility and the point-entered/point-left hooks. The
5464 ;; following hack avoids calling the point-* hooks
5465 ;; unnecessarily. Note that we move *forward* past intangible
5466 ;; text when the initial and final points are the same.
5471 ;; If intangibility moves us to a different (later) place
5472 ;; in the same line, use that as the destination.
5475 ;; If that position is "too late",
5476 ;; try the previous allowable position.
5477 ;; See if it is ok.
5480 ;; If going forward, don't accept the previous
5481 ;; allowable position if it is before the target line.
5483 ;; If going backward, don't accept the previous
5484 ;; allowable position if it is still after the target line.
5487 ;; As a last resort, use the end of the line.
5490 ;; Now move to the updated destination, processing fields
5491 ;; as well as intangibility.
5495 ;; Ignore field boundaries if the initial and final
5496 ;; positions have the same `field' property, even if the
5497 ;; fields are non-contiguous. This seems to be "nicer"
5498 ;; behavior in many situations.
5501 new
5505 ;; If all this moved us to a different line,
5506 ;; retry everything within that new line.
5508 ;; Repeat the intangibility and field processing.
5512 "Try to find column COL, considering invisibility.
5513 This function works only in certain cases,
5514 because what we really need is for `move-to-column'
5515 and `current-column' to be able to ignore invisible text."
5524 ;; If the following character is currently invisible,
5525 ;; skip all characters with that same `invisible' property value.
5529 ;; Have we advanced to a larger column position?
5531 ;; We have made some progress towards the desired column.
5532 ;; See if we can make any further progress.
5534 ;; Otherwise, go to the place we originally found
5535 ;; and move back over invisible text.
5536 ;; that will get us to the same place on the screen
5537 ;; but with a more reasonable buffer position.
5544 "Move point to end of current line as displayed.
5545 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5546 If point reaches the beginning or end of buffer, it stops there.
5548 To ignore the effects of the `intangible' text or overlay
5549 property, bind `inhibit-point-motion-hooks' to t.
5550 If there is an image in the current line, this function
5551 disregards newlines that are part of the text on which the image
5552 rests."
5562 ;; With bidi reordering, we may not be at bol,
5563 ;; so make sure we are.
5578 ;; If we skipped something intangible and now we're not
5579 ;; really at eol, keep going.
5584 "Move point to beginning of current line as displayed.
5585 \(If there's an image in the line, this disregards newlines
5586 which are part of the text that the image rests on.)
5588 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5589 If point reaches the beginning or end of buffer, it stops there.
5590 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5595 first-vis first-vis-field-value)
5597 ;; Move by lines, if ARG is not 1 (the default).
5602 ;; Move to beginning-of-line, ignoring fields and invisible text.
5608 ;; Now find first visible char in the line.
5613 ;; See if fields would stop us from reaching FIRST-VIS.
5618 ;; If yes, obey them.
5619 first-vis-field-value
5620 ;; Otherwise, move to START with attention to fields.
5621 ;; (It is possible that fields never matter in this case.)
5626 ;; Many people have said they rarely use this feature, and often type
5627 ;; it by accident. Maybe it shouldn't even be on a key.
5632 Those commands will move to this position in the line moved to
5633 rather than trying to keep the same horizontal position.
5634 With a non-nil argument ARG, clears out the goal column
5636 The goal column is stored in the variable `goal-column'."
5643 ;; The older method below can be erroneous if `set-goal-column' is bound
5644 ;; to a sequence containing %
5645 ;;(message (substitute-command-keys
5646 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
5647 ;;goal-column)
5654 )
5655 nil)
5656 \f
5657 ;;; Editing based on visual lines, as opposed to logical lines.
5660 "Move point to end of current visual line.
5661 With argument N not nil or 1, move forward N - 1 visual lines first.
5662 If point reaches the beginning or end of buffer, it stops there.
5663 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5669 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5670 ;; constrain to field boundaries, so we don't either.
5674 "Move point to beginning of current visual line.
5675 With argument N not nil or 1, move forward N - 1 visual lines first.
5676 If point reaches the beginning or end of buffer, it stops there.
5677 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5685 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5689 "Kill the rest of the visual line.
5690 With prefix argument ARG, kill that many visual lines from point.
5691 If ARG is negative, kill visual lines backward.
5692 If ARG is zero, kill the text before point on the current visual
5693 line.
5695 If you want to append the killed line to the last killed text,
5698 If the buffer is read-only, Emacs will beep and refrain from deleting
5699 the line, but put the line in the kill ring anyway. This means that
5700 you can use this command to copy text from a read-only buffer.
5701 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5702 even beep.)"
5704 ;; Like in `kill-line', it's better to move point to the other end
5705 ;; of the kill before killing.
5713 ;; Skip any trailing whitespace at the end of the visual line.
5714 ;; We used to do this only if `show-trailing-whitespace' is
5715 ;; nil, but that's wrong; the correct thing would be to check
5716 ;; whether the trailing whitespace is highlighted. But, it's
5717 ;; OK to just do this unconditionally.
5724 "Move cursor vertically down ARG lines.
5725 This is identical to `next-line', except that it always moves
5726 by logical lines instead of visual lines, ignoring the value of
5727 the variable `line-move-visual'."
5734 "Move cursor vertically up ARG lines.
5735 This is identical to `previous-line', except that it always moves
5736 by logical lines instead of visual lines, ignoring the value of
5737 the variable `line-move-visual'."
5744 "Editing based on visual lines."
5753 ;; These keybindings interfere with xterm function keys. Are
5754 ;; there any other suitable bindings?
5755 ;; (define-key map "\M-[" 'previous-logical-line)
5756 ;; (define-key map "\M-]" 'next-logical-line)
5757 map))
5760 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5761 The value should be a list of the form (LEFT RIGHT), where LEFT
5762 and RIGHT are symbols representing the bitmaps to display, to
5763 indicate wrapped lines, in the left and right fringes respectively.
5764 See also `fringe-indicator-alist'.
5765 The default is not to display fringe indicators for wrapped lines.
5766 This variable does not affect fringe indicators displayed for
5767 other purposes."
5782 'continuation
5789 "Toggle visual line based editing (Visual Line mode).
5790 With a prefix argument ARG, enable Visual Line mode if ARG is
5791 positive, and disable it otherwise. If called from Lisp, enable
5792 the mode if ARG is omitted or nil.
5794 When Visual Line mode is enabled, `word-wrap' is turned on in
5795 this buffer, and simple editing commands are redefined to act on
5796 visual lines, not logical lines. See Info node `Visual Line
5797 Mode' for details."
5798 :keymap visual-line-mode-map
5804 ;; Save the local values of some variables, to be restored if
5805 ;; visual-line-mode is turned off.
5807 truncate-partial-width-windows
5808 word-wrap fringe-indicator-alist))
5811 visual-line--saved-state)))
5815 word-wrap t
5816 fringe-indicator-alist
5818 fringe-indicator-alist)))
5832 visual-line-mode turn-on-visual-line-mode)
5834 \f
5836 "Interchange characters around point, moving forward one character.
5837 With prefix arg ARG, effect is to take character before point
5838 and drag it forward past ARG other characters (backward if ARG negative).
5839 If no argument and at end of line, the previous two chars are exchanged."
5845 "Interchange words around point, leaving point at end of them.
5846 With prefix arg ARG, effect is to take word before or around point
5847 and drag it forward past ARG other words (backward if ARG negative).
5848 If ARG is zero, the words around or after point and around or after mark
5849 are interchanged."
5850 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5856 Does not work on a sexp that point is in the middle of
5857 if it is a list or string."
5861 ;; Here we should try to simulate the behavior of
5862 ;; (cons (progn (forward-sexp x) (point))
5863 ;; (progn (forward-sexp (- x)) (point)))
5864 ;; Except that we don't want to rely on the second forward-sexp
5865 ;; putting us back to where we want to be, since forward-sexp-function
5866 ;; might do funny things like infix-precedence.
5871 ;; Jumping over a symbol. We might be inside it, mind you.
5876 ;; Otherwise, we're between sexps. Take a step back before jumping
5877 ;; to make sure we'll obey the same precedence no matter which direction
5878 ;; we're going.
5883 'skip-syntax-forward
5890 "Exchange current line and previous line, leaving point after both.
5891 With argument ARG, takes previous line and moves it past ARG lines.
5892 With argument 0, interchanges line point is in with line mark is in."
5898 ;; Move forward over ARG lines,
5899 ;; but create newlines if necessary.
5906 arg))
5908 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5909 ;; which seems inconsistent with the ARG /= 0 case.
5910 ;; FIXME document SPECIAL.
5912 "Subroutine to do the work of transposing objects.
5913 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5914 moves forward by units of the given object (e.g. forward-sentence,
5915 forward-paragraph). If ARG is zero, exchanges the current object
5916 with the one containing mark. If ARG is an integer, moves the
5917 current object past ARG following (if ARG is positive) or
5918 preceding (if ARG is negative) objects, leaving point after the
5919 current object."
5924 pos1 pos2)
5952 ;; This sequence of insertions attempts to preserve marker
5953 ;; positions at the start and end of the transposed objects.
5967 \f
5969 "Move backward until encountering the beginning of a word.
5970 With argument ARG, do this that many times.
5971 If ARG is omitted or nil, move point backward one word."
5976 "Set mark ARG words away from point.
5978 move to with the same argument.
5979 Interactively, if this command is repeated
5980 or (in Transient Mark mode) if the mark is active,
5981 it marks the next ARG words after the ones already marked."
5998 nil t))))
6001 "Kill characters forward until encountering the end of a word.
6002 With argument ARG, do this that many times."
6007 "Kill characters backward until encountering the beginning of a word.
6008 With argument ARG, do this that many times."
6013 "Return the symbol or word that point is on (or a nearby one) as a string.
6014 The return value includes no text properties.
6015 If optional arg STRICT is non-nil, return nil unless point is within
6016 or adjacent to a symbol or word. In all cases the value can be nil
6017 if there is no word nearby.
6018 The function, belying its name, normally finds a symbol.
6019 If optional arg REALLY-WORD is non-nil, it finds just a word."
6028 ;; Point is neither within nor adjacent to a word.
6030 ;; Look for preceding word in same line.
6033 ;; No preceding word in same line.
6034 ;; Look for following word in same line.
6043 ;; If we found something nonempty, return it as a string.
6046 \f
6048 "String for filling to insert at front of new line, or nil for none."
6050 string)
6056 "Regexp to match lines which should not be auto-filled."
6058 regexp)
6062 "The default value for `normal-auto-fill-function'.
6063 This is the default auto-fill function, some major modes use a different one.
6064 Returns t if it really did any work."
6074 nil ;; Auto-filling not required
6078 ;; Choose a fill-prefix automatically.
6086 ;; Use auto-indentation rather than a guessed empty prefix.
6092 ;; Determine where to split the line.
6105 ;; See whether the place we found is any good.
6109 ;; There is no use breaking at end of line.
6111 ;; It is futile to split at the end of the prefix
6112 ;; since we would just insert the prefix again.
6114 ;; Don't split right after a comment starter
6115 ;; since we would just make another comment starter.
6120 limit t)
6122 ;; No good place to break => stop trying.
6124 ;; Ok, we have a useful place to break the line. Do it.
6126 ;; If point is at the fill-point, do not `save-excursion'.
6127 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6128 ;; point will end up before it rather than after it.
6136 ;; Now do justification, if required
6141 ;; If making the new line didn't reduce the hpos of
6142 ;; the end of the line, then give up now;
6143 ;; trying again will not help.
6146 ;; Justify last line.
6148 t)))
6151 "Mode-specific function which line breaks and continues a comment.
6152 This function is called during auto-filling when a comment syntax
6153 is defined.
6154 The function should take a single optional argument, which is a flag
6158 "Break line at point and indent.
6159 If a comment syntax is defined, call `comment-indent-new-line'.
6161 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6162 unless optional argument SOFT is non-nil."
6166 ;; Insert the newline before removing empty space so that markers
6167 ;; get preserved better.
6173 ;; Blindly trust a non-adaptive fill-prefix.
6179 ;; If there's an adaptive prefix, use it unless we're inside
6180 ;; a comment and the prefix is not a comment starter.
6184 ;; If we're not inside a comment, just try to indent.
6188 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6192 ;; `functions' and `hooks' are usually unsafe to set, but setting
6193 ;; auto-fill-function to nil in a file-local setting is safe and
6194 ;; can be useful to prevent auto-filling.
6198 "Toggle automatic line breaking (Auto Fill mode).
6199 With a prefix argument ARG, enable Auto Fill mode if ARG is
6200 positive, and disable it otherwise. If called from Lisp, enable
6201 the mode if ARG is omitted or nil.
6203 When Auto Fill mode is enabled, inserting a space at a column
6204 beyond `current-fill-column' automatically breaks the line at a
6205 previous space.
6207 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6208 non-`nil'.
6210 The value of `normal-auto-fill-function' specifies the function to use
6211 for `auto-fill-function' when turning Auto Fill mode on."
6216 ;; This holds a document string used to document auto-fill-mode.
6218 "Automatically break line at a previous space, in insertion of text."
6219 nil)
6222 "Unconditionally turn on Auto Fill mode."
6226 "Unconditionally turn off Auto Fill mode."
6232 "Set `fill-column' to specified argument.
6237 ;; We used to use current-column silently, but C-x f is too easily
6238 ;; typed as a typo for C-x C-f, so we turned it into an error and
6239 ;; now an interactive prompt.
6244 ;; Disallow missing argument; it's probably a typo for C-x C-f.
6248 \f
6250 "Set `selective-display' to ARG; clear it if no arg.
6251 When the value of `selective-display' is a number > 0,
6252 lines whose indentation is >= that value are not displayed.
6253 The variable `selective-display' has a separate value for each buffer."
6273 "Toggle truncating of long lines for the current buffer.
6274 When truncating is off, long lines are folded.
6275 With prefix argument ARG, truncate long lines if ARG is positive,
6276 otherwise fold them. Note that in side-by-side windows, this
6277 command has no effect if `truncate-partial-width-windows' is
6278 non-nil."
6290 nil t)))
6295 "Toggle whether to use word-wrapping for continuation lines.
6296 With prefix argument ARG, wrap continuation lines at word boundaries
6297 if ARG is positive, otherwise wrap them at the right screen edge.
6298 This command toggles the value of `word-wrap'. It has no effect
6299 if long lines are truncated."
6315 "Toggle Overwrite mode.
6316 With a prefix argument ARG, enable Overwrite mode if ARG is
6317 positive, and disable it otherwise. If called from Lisp, enable
6318 the mode if ARG is omitted or nil.
6320 When Overwrite mode is enabled, printing characters typed in
6321 replace existing text on a one-for-one basis, rather than pushing
6322 it to the right. At the end of a line, such characters extend
6323 the line. Before a tab, such characters insert until the tab is
6325 overwrite mode; this is supposed to make it easier to insert
6326 characters when necessary."
6331 "Toggle Binary Overwrite mode.
6332 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6333 is positive, and disable it otherwise. If called from Lisp,
6334 enable the mode if ARG is omitted or nil.
6336 When Binary Overwrite mode is enabled, printing characters typed
6337 in replace existing text. Newlines are not treated specially, so
6338 typing at the end of a line joins the line to the next, with the
6339 typed character between them. Typing before a tab character
6340 simply replaces the tab with the character typed.
6342 ordinary typing characters do.
6344 Note that Binary Overwrite mode is not its own minor mode; it is
6345 a specialization of overwrite mode, entered by setting the
6346 `overwrite-mode' variable to `overwrite-mode-binary'."
6351 "Toggle line number display in the mode line (Line Number mode).
6352 With a prefix argument ARG, enable Line Number mode if ARG is
6353 positive, and disable it otherwise. If called from Lisp, enable
6354 the mode if ARG is omitted or nil.
6356 Line numbers do not appear for very large buffers and buffers
6357 with very long lines; see variables `line-number-display-limit'
6358 and `line-number-display-limit-width'."
6362 "Toggle column number display in the mode line (Column Number mode).
6363 With a prefix argument ARG, enable Column Number mode if ARG is
6364 positive, and disable it otherwise.
6366 If called from Lisp, enable the mode if ARG is omitted or nil."
6370 "Toggle buffer size display in the mode line (Size Indication mode).
6371 With a prefix argument ARG, enable Size Indication mode if ARG is
6372 positive, and disable it otherwise.
6374 If called from Lisp, enable the mode if ARG is omitted or nil."
6378 "Toggle auto-saving in the current buffer (Auto Save mode).
6379 With a prefix argument ARG, enable Auto Save mode if ARG is
6380 positive, and disable it otherwise.
6382 If called from Lisp, enable the mode if ARG is omitted or nil."
6384 ;; If auto-save is off because buffer has shrunk,
6385 ;; then toggling should turn it on.
6393 buffer-file-name)
6395 ;; If -1 was stored here, to temporarily turn off saving,
6396 ;; turn it back on.
6399 \f
6401 "Blinking matching of parens and expressions."
6406 "Non-nil means show matching open-paren when close-paren is inserted.
6407 If t, highlight the paren. If `jump', move cursor to its position."
6415 "Non-nil means show matching open-paren when it is on screen.
6416 If nil, don't show it (but the open-paren can still be shown
6417 when it is off screen).
6419 This variable has no effect if `blink-matching-paren' is nil.
6420 \(In that case, the open-paren is never shown.)
6421 It is also ignored if `show-paren-mode' is enabled."
6426 "If non-nil, maximum distance to search backwards for matching open-paren.
6427 If nil, search stops at the beginning of the accessible portion of the buffer."
6433 "Time in seconds to delay after showing a matching paren."
6438 "If nil, `blink-matching-paren' ignores comments.
6439 More precisely, when looking for the matching parenthesis,
6440 it skips the contents of comments that end before point."
6445 "Return whether or not START...END are matching parens.
6446 END is the current point and START is the blink position.
6447 START might be nil if no matching starter was found.
6448 Returns non-nil if we find there is a mismatch."
6453 ;; For self-matched chars like " and $, we can't know when they're
6454 ;; mismatched or unmatched, so we can only do it for parens.
6459 ;; The cdr might hold a new paren-class info rather than
6460 ;; a matching-char info, in which case the two CDRs
6461 ;; should match.
6465 "Function to check parentheses mismatches.
6466 The function takes two arguments (START and END) where START is the
6467 position just before the opening token and END is the position right after.
6468 START can be nil, if it was not found.
6475 ol)
6479 "Momentarily highlight the beginning of the sexp before point."
6482 blink-matching-paren)
6492 oldpos))
6499 ;; backward-sexp skips backward over prefix chars,
6500 ;; so move back to the matching paren.
6521 ;; Matching open within window, temporarily move to or highlight
6522 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
6523 ;; is non-nil.
6540 ;; Show what precedes the open in its line, if anything.
6545 ;; Show what follows the open in its line, if anything.
6552 ;; Otherwise show the previous nonblank line,
6553 ;; if there is one.
6562 ;; Replace the newline and other whitespace with `...'.
6563 "..."
6565 ;; There is nothing to show except the char itself.
6571 "Function called, if non-nil, whenever a close parenthesis is inserted.
6577 blink-paren-function
6580 ;; Verify an even number of quoting characters precede the close.
6591 ;; Most likely, this hook is nil, so this arg doesn't matter,
6592 ;; but I use it as a reminder that this function usually
6593 ;; likes to be run after others since it does
6594 ;; `sit-for'. That's also the reason it get a `priority' prop
6595 ;; of 100.
6597 \f
6598 ;; This executes C-g typed while Emacs is waiting for a command.
6599 ;; Quitting out of a program does not go through here;
6600 ;; that happens in the QUIT macro at the C code level.
6602 "Signal a `quit' condition.
6603 During execution of Lisp code, this character causes a quit directly.
6604 At top-level, as an editor command, this simply beeps."
6606 ;; Avoid adding the region to the window selection.
6612 ;; Force the next redisplay cycle to remove the "Def" indicator from
6613 ;; all the mode lines.
6627 This command can exit an interactive command such as `query-replace',
6628 can clear out a prefix argument or a region,
6629 can get out of the minibuffer or other recursive edit,
6630 cancel the use of the current buffer (for special-purpose buffers),
6631 or go back to just one window (by deleting all but the selected window)."
6639 nil)
6650 "Play sound stored in FILE.
6651 VOLUME and DEVICE correspond to the keywords of the sound
6652 specification for `play-sound'."
6662 \f
6664 "Your preference for a mail reading package.
6665 This is used by some keybindings which support reading mail.
6666 See also `mail-user-agent' concerning sending mail."
6676 "Your preference for a mail composition package.
6677 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6678 outgoing email message. This variable lets you specify which
6679 mail-sending package you prefer.
6681 Valid values include:
6683 `message-user-agent' -- use the Message package.
6684 See Info node `(message)'.
6685 `sendmail-user-agent' -- use the Mail package.
6686 See Info node `(emacs)Sending Mail'.
6687 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6688 See Info node `(mh-e)'.
6689 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6690 paraphernalia if Gnus is running, particularly
6691 the Gcc: header for archiving.
6693 Additional valid symbols may be available; check with the author of
6694 your package for details. The function should return non-nil if it
6695 succeeds.
6697 See also `read-mail-command' concerning reading mail."
6700 message-user-agent)
6703 sendmail-user-agent)
6706 mh-e-user-agent)
6709 gnus-user-agent)
6715 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6716 If the value of `mail-user-agent' is the default, and the user
6717 appears to have customizations applying to the old default,
6718 `compose-mail' issues a warning."
6724 "If the buffer starts with a mail header, move point to the header's end.
6725 Otherwise, moves to `point-min'.
6726 The end of the header is the start of the next line, if there is one,
6727 else the end of the last line. This function obeys RFC822."
6733 ;; Used by Rmail (e.g., rmail-forward).
6735 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6739 switch-function yank-action send-actions
6740 return-action)
6741 "Start composing a mail message to send.
6742 This uses the user's chosen mail composition package
6743 as selected with the variable `mail-user-agent'.
6744 The optional arguments TO and SUBJECT specify recipients
6745 and the initial Subject field, respectively.
6747 OTHER-HEADERS is an alist specifying additional
6748 header fields. Elements look like (HEADER . VALUE) where both
6749 HEADER and VALUE are strings.
6751 CONTINUE, if non-nil, says to continue editing a message already
6752 being composed. Interactively, CONTINUE is the prefix argument.
6754 SWITCH-FUNCTION, if non-nil, is a function to use to
6755 switch to and display the buffer used for mail composition.
6757 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6758 to insert the raw text of the message being replied to.
6759 It has the form (FUNCTION . ARGS). The user agent will apply
6760 FUNCTION to ARGS, to insert the raw text of the original message.
6761 \(The user agent will also run `mail-citation-hook', *after* the
6762 original text has been inserted in this way.)
6764 SEND-ACTIONS is a list of actions to call when the message is sent.
6765 Each action has the form (FUNCTION . ARGS).
6767 RETURN-ACTION, if non-nil, is an action for returning to the
6768 caller. It has the form (FUNCTION . ARGS). The function is
6769 called after the mail has been sent or put aside, and the mail
6770 buffer buried."
6774 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6775 ;; from sendmail-user-agent to message-user-agent. Some users may
6776 ;; encounter incompatibilities. This hack tries to detect problems
6777 ;; and warn about them.
6782 mail-yank-hooks mail-archive-file-name
6783 mail-default-reply-to mail-mailing-lists
6784 mail-self-blind))
6791 The default mail mode is now Message mode.
6792 You have the following Mail mode variable%s customized:
6794 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6801 yank-action send-actions return-action)))
6804 yank-action send-actions
6805 return-action)
6809 'switch-to-buffer-other-window yank-action send-actions
6810 return-action))
6813 yank-action send-actions
6814 return-action)
6818 'switch-to-buffer-other-frame yank-action send-actions
6819 return-action))
6821 \f
6823 "History of values entered with `set-variable'.
6825 Maximum length of the history list is determined by the value
6829 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6830 VARIABLE should be a user option variable name, a Lisp variable
6831 meant to be customized by users. You should enter VALUE in Lisp syntax,
6832 so if you want VALUE to be a string, you must surround it with doublequotes.
6833 VALUE is used literally, not evaluated.
6835 If VARIABLE has a `variable-interactive' property, that is used as if
6836 it were the arg to `interactive' (which see) to interactively read VALUE.
6838 If VARIABLE has been defined with `defcustom', then the type information
6839 in the definition is used to check that VALUE is valid.
6841 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6846 default-var)
6862 var obsolete)
6865 ;; Use VAR's `variable-interactive' property
6866 ;; as an interactive spec for prompting.
6869 arg))
6871 read-expression-map t
6872 'set-variable-value-history
6881 ;; Match with custom type.
6893 ;; Force a thorough redisplay for the case that the variable
6894 ;; has an effect on the display, like `tab-width' has.
6896 \f
6897 ;; Define the major mode for lists of completions.
6907 (define-key map [right] 'next-completion)
6908 (define-key map "q" 'quit-window)
6909 (define-key map "z" 'kill-this-buffer)
6910 map)
6911 "Local map for completion list buffers.")
6913 ;; Completion mode is suitable only for specially formatted data.
6914 (put 'completion-list-mode 'mode-class 'special)
6916 (defvar completion-reference-buffer nil
6917 "Record the buffer that was current when the completion list was requested.
6918 This is a local variable in the completion list buffer.
6919 Initial value is nil to avoid some compiler warnings.")
6921 (defvar completion-no-auto-exit nil
6922 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6923 This also applies to other functions such as `choose-completion'.")
6925 (defvar completion-base-position nil
6926 "Position of the base of the text corresponding to the shown completions.
6927 This variable is used in the *Completions* buffers.
6928 Its value is a list of the form (START END) where START is the place
6929 where the completion should be inserted and END (if non-nil) is the end
6930 of the text to replace. If END is nil, point is used instead.")
6932 (defvar completion-list-insert-choice-function #'completion--replace
6933 "Function to use to insert the text chosen in *Completions*.
6934 Called with three arguments (BEG END TEXT), it should replace the text
6935 between BEG and END with TEXT. Expected to be set buffer-locally
6936 in the *Completions* buffer.")
6938 (defvar completion-base-size nil
6939 "Number of chars before point not involved in completion.
6940 This is a local variable in the completion list buffer.
6941 It refers to the chars in the minibuffer if completing in the
6942 minibuffer, or in `completion-reference-buffer' otherwise.
6943 Only characters in the field at point are included.
6945 If nil, Emacs determines which part of the tail end of the
6946 buffer's text is involved in completion by comparing the text
6947 directly.")
6948 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6950 (defun delete-completion-window ()
6951 "Delete the completion list window.
6952 Go to the window from which completion was requested."
6953 (interactive)
6954 (let ((buf completion-reference-buffer))
6955 (if (one-window-p t)
6956 (if (window-dedicated-p) (delete-frame))
6957 (delete-window (selected-window))
6958 (if (get-buffer-window buf)
6959 (select-window (get-buffer-window buf))))))
6961 (defun previous-completion (n)
6962 "Move to the previous item in the completion list."
6963 (interactive "p")
6964 (next-completion (- n)))
6966 (defun next-completion (n)
6967 "Move to the next item in the completion list.
6968 With prefix argument N, move N items (negative N means move backward)."
6969 (interactive "p")
6970 (let ((beg (point-min)) (end (point-max)))
6971 (while (and (> n 0) (not (eobp)))
6972 ;; If in a completion, move to the end of it.
6973 (when (get-text-property (point) 'mouse-face)
6974 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6975 ;; Move to start of next one.
6976 (unless (get-text-property (point) 'mouse-face)
6977 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6978 (setq n (1- n)))
6979 (while (and (< n 0) (not (bobp)))
6980 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6981 ;; If in a completion, move to the start of it.
6982 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6983 (goto-char (previous-single-property-change
6984 (point) 'mouse-face nil beg)))
6985 ;; Move to end of the previous completion.
6986 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6987 (goto-char (previous-single-property-change
6988 (point) 'mouse-face nil beg)))
6989 ;; Move to the start of that one.
6990 (goto-char (previous-single-property-change
6991 (point) 'mouse-face nil beg))
6992 (setq n (1+ n))))))
6994 (defun choose-completion (&optional event)
6995 "Choose the completion at point.
6996 If EVENT, use EVENT's position to determine the starting position."
6997 (interactive (list last-nonmenu-event))
6998 ;; In case this is run via the mouse, give temporary modes such as
6999 ;; isearch a chance to turn off.
7000 (run-hooks 'mouse-leave-buffer-hook)
7001 (with-current-buffer (window-buffer (posn-window (event-start event)))
7002 (let ((buffer completion-reference-buffer)
7003 (base-size completion-base-size)
7004 (base-position completion-base-position)
7005 (insert-function completion-list-insert-choice-function)
7006 (choice
7007 (save-excursion
7008 (goto-char (posn-point (event-start event)))
7009 (let (beg end)
7010 (cond
7011 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7012 (setq end (point) beg (1+ (point))))
7013 ((and (not (bobp))
7014 (get-text-property (1- (point)) 'mouse-face))
7015 (setq end (1- (point)) beg (point)))
7016 (t (error "No completion here")))
7017 (setq beg (previous-single-property-change beg 'mouse-face))
7018 (setq end (or (next-single-property-change end 'mouse-face)
7019 (point-max)))
7020 (buffer-substring-no-properties beg end)))))
7022 (unless (buffer-live-p buffer)
7023 (error "Destination buffer is dead"))
7024 (quit-window nil (posn-window (event-start event)))
7026 (with-current-buffer buffer
7027 (choose-completion-string
7028 choice buffer
7029 (or base-position
7030 (when base-size
7031 ;; Someone's using old completion code that doesn't know
7032 ;; about base-position yet.
7033 (list (+ base-size (field-beginning))))
7034 ;; If all else fails, just guess.
7035 (list (choose-completion-guess-base-position choice)))
7036 insert-function)))))
7038 ;; Delete the longest partial match for STRING
7039 ;; that can be found before POINT.
7040 (defun choose-completion-guess-base-position (string)
7041 (save-excursion
7042 (let ((opoint (point))
7043 len)
7044 ;; Try moving back by the length of the string.
7045 (goto-char (max (- (point) (length string))
7046 (minibuffer-prompt-end)))
7047 ;; See how far back we were actually able to move. That is the
7048 ;; upper bound on how much we can match and delete.
7049 (setq len (- opoint (point)))
7050 (if completion-ignore-case
7051 (setq string (downcase string)))
7052 (while (and (> len 0)
7053 (let ((tail (buffer-substring (point) opoint)))
7054 (if completion-ignore-case
7055 (setq tail (downcase tail)))
7056 (not (string= tail (substring string 0 len)))))
7057 (setq len (1- len))
7058 (forward-char 1))
7059 (point))))
7061 (defun choose-completion-delete-max-match (string)
7062 (declare (obsolete choose-completion-guess-base-position "23.2"))
7063 (delete-region (choose-completion-guess-base-position string) (point)))
7065 (defvar choose-completion-string-functions nil
7066 "Functions that may override the normal insertion of a completion choice.
7067 These functions are called in order with three arguments:
7068 CHOICE - the string to insert in the buffer,
7069 BUFFER - the buffer in which the choice should be inserted,
7070 BASE-POSITION - where to insert the completion.
7072 If a function in the list returns non-nil, that function is supposed
7073 to have inserted the CHOICE in the BUFFER, and possibly exited
7074 the minibuffer; no further functions will be called.
7076 If all functions in the list return nil, that means to use
7077 the default method of inserting the completion in BUFFER.")
7079 (defun choose-completion-string (choice &optional
7080 buffer base-position insert-function)
7081 "Switch to BUFFER and insert the completion choice CHOICE.
7082 BASE-POSITION says where to insert the completion.
7083 INSERT-FUNCTION says how to insert the completion and falls
7084 back on `completion-list-insert-choice-function' when nil."
7086 ;; If BUFFER is the minibuffer, exit the minibuffer
7087 ;; unless it is reading a file name and CHOICE is a directory,
7088 ;; or completion-no-auto-exit is non-nil.
7090 ;; Some older code may call us passing `base-size' instead of
7091 ;; `base-position'. It's difficult to make any use of `base-size',
7092 ;; so we just ignore it.
7093 (unless (consp base-position)
7094 (message "Obsolete `base-size' passed to choose-completion-string")
7095 (setq base-position nil))
7097 (let* ((buffer (or buffer completion-reference-buffer))
7098 (mini-p (minibufferp buffer)))
7099 ;; If BUFFER is a minibuffer, barf unless it's the currently
7100 ;; active minibuffer.
7101 (if (and mini-p
7102 (not (and (active-minibuffer-window)
7103 (equal buffer
7104 (window-buffer (active-minibuffer-window))))))
7105 (error "Minibuffer is not active for completion")
7106 ;; Set buffer so buffer-local choose-completion-string-functions works.
7107 (set-buffer buffer)
7108 (unless (run-hook-with-args-until-success
7109 'choose-completion-string-functions
7110 ;; The fourth arg used to be `mini-p' but was useless
7111 ;; (since minibufferp can be used on the `buffer' arg)
7112 ;; and indeed unused. The last used to be `base-size', so we
7113 ;; keep it to try and avoid breaking old code.
7114 choice buffer base-position nil)
7115 ;; This remove-text-properties should be unnecessary since `choice'
7116 ;; comes from buffer-substring-no-properties.
7117 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7118 ;; Insert the completion into the buffer where it was requested.
7119 (funcall (or insert-function completion-list-insert-choice-function)
7120 (or (car base-position) (point))
7121 (or (cadr base-position) (point))
7122 choice)
7123 ;; Update point in the window that BUFFER is showing in.
7124 (let ((window (get-buffer-window buffer t)))
7125 (set-window-point window (point)))
7126 ;; If completing for the minibuffer, exit it with this choice.
7127 (and (not completion-no-auto-exit)
7128 (minibufferp buffer)
7129 minibuffer-completion-table
7130 ;; If this is reading a file name, and the file name chosen
7131 ;; is a directory, don't exit the minibuffer.
7132 (let* ((result (buffer-substring (field-beginning) (point)))
7133 (bounds
7134 (completion-boundaries result minibuffer-completion-table
7135 minibuffer-completion-predicate
7136 "")))
7137 (if (eq (car bounds) (length result))
7138 ;; The completion chosen leads to a new set of completions
7139 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7140 (let ((mini (active-minibuffer-window)))
7141 (select-window mini)
7142 (when minibuffer-auto-raise
7143 (raise-frame (window-frame mini))))
7144 (exit-minibuffer))))))))
7146 (define-derived-mode completion-list-mode nil "Completion List"
7147 "Major mode for buffers showing lists of possible completions.
7149 to select the completion near point.
7150 Or click to select one with the mouse.
7153 (set (make-local-variable 'completion-base-size) nil))
7155 (defun completion-list-mode-finish ()
7156 "Finish setup of the completions buffer.
7157 Called from `temp-buffer-show-hook'."
7158 (when (eq major-mode 'completion-list-mode)
7159 (setq buffer-read-only t)))
7161 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7164 ;; Variables and faces used in `completion-setup-function'.
7166 (defcustom completion-show-help t
7167 "Non-nil means show help message in *Completions* buffer."
7168 :type 'boolean
7169 :version "22.1"
7170 :group 'completion)
7172 ;; This function goes in completion-setup-hook, so that it is called
7173 ;; after the text of the completion list buffer is written.
7174 (defun completion-setup-function ()
7175 (let* ((mainbuf (current-buffer))
7176 (base-dir
7177 ;; FIXME: This is a bad hack. We try to set the default-directory
7178 ;; in the *Completions* buffer so that the relative file names
7179 ;; displayed there can be treated as valid file names, independently
7180 ;; from the completion context. But this suffers from many problems:
7181 ;; - It's not clear when the completions are file names. With some
7182 ;; completion tables (e.g. bzr revision specs), the listed
7183 ;; completions can mix file names and other things.
7184 ;; - It doesn't pay attention to possible quoting.
7185 ;; - With fancy completion styles, the code below will not always
7186 ;; find the right base directory.
7187 (if minibuffer-completing-file-name
7188 (file-name-as-directory
7189 (expand-file-name
7190 (buffer-substring (minibuffer-prompt-end)
7191 (- (point) (or completion-base-size 0))))))))
7192 (with-current-buffer standard-output
7193 (let ((base-size completion-base-size) ;Read before killing localvars.
7194 (base-position completion-base-position)
7195 (insert-fun completion-list-insert-choice-function))
7196 (completion-list-mode)
7197 (set (make-local-variable 'completion-base-size) base-size)
7198 (set (make-local-variable 'completion-base-position) base-position)
7199 (set (make-local-variable 'completion-list-insert-choice-function)
7200 insert-fun))
7201 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7202 (if base-dir (setq default-directory base-dir))
7203 ;; Maybe insert help string.
7204 (when completion-show-help
7205 (goto-char (point-min))
7206 (if (display-mouse-p)
7207 (insert (substitute-command-keys
7209 (insert (substitute-command-keys
7213 (add-hook 'completion-setup-hook 'completion-setup-function)
7215 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7216 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7218 (defun switch-to-completions ()
7219 "Select the completion list window."
7220 (interactive)
7221 (let ((window (or (get-buffer-window "*Completions*" 0)
7222 ;; Make sure we have a completions window.
7223 (progn (minibuffer-completion-help)
7224 (get-buffer-window "*Completions*" 0)))))
7225 (when window
7226 (select-window window)
7227 ;; In the new buffer, go to the first completion.
7228 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
7229 (when (bobp)
7230 (next-completion 1)))))
7231 \f
7232 ;;; Support keyboard commands to turn on various modifiers.
7234 ;; These functions -- which are not commands -- each add one modifier
7235 ;; to the following event.
7237 (defun event-apply-alt-modifier (_ignore-prompt)
7240 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
7241 (defun event-apply-super-modifier (_ignore-prompt)
7244 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
7245 (defun event-apply-hyper-modifier (_ignore-prompt)
7248 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
7249 (defun event-apply-shift-modifier (_ignore-prompt)
7252 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
7253 (defun event-apply-control-modifier (_ignore-prompt)
7256 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
7257 (defun event-apply-meta-modifier (_ignore-prompt)
7260 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
7262 (defun event-apply-modifier (event symbol lshiftby prefix)
7263 "Apply a modifier flag to event EVENT.
7264 SYMBOL is the name of this modifier, as a symbol.
7265 LSHIFTBY is the numeric value of this modifier, in keyboard events.
7266 PREFIX is the string that represents this modifier in an event type symbol."
7267 (if (numberp event)
7268 (cond ((eq symbol 'control)
7269 (if (and (<= (downcase event) ?z)
7270 (>= (downcase event) ?a))
7271 (- (downcase event) ?a -1)
7272 (if (and (<= (downcase event) ?Z)
7273 (>= (downcase event) ?A))
7274 (- (downcase event) ?A -1)
7275 (logior (lsh 1 lshiftby) event))))
7276 ((eq symbol 'shift)
7277 (if (and (<= (downcase event) ?z)
7278 (>= (downcase event) ?a))
7279 (upcase event)
7280 (logior (lsh 1 lshiftby) event)))
7281 (t
7282 (logior (lsh 1 lshiftby) event)))
7283 (if (memq symbol (event-modifiers event))
7284 event
7285 (let ((event-type (if (symbolp event) event (car event))))
7286 (setq event-type (intern (concat prefix (symbol-name event-type))))
7287 (if (symbolp event)
7288 event-type
7289 (cons event-type (cdr event)))))))
7291 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
7292 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
7293 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
7294 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
7295 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
7296 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
7297 \f
7298 ;;;; Keypad support.
7300 ;; Make the keypad keys act like ordinary typing keys. If people add
7301 ;; bindings for the function key symbols, then those bindings will
7302 ;; override these, so this shouldn't interfere with any existing
7303 ;; bindings.
7305 ;; Also tell read-char how to handle these keys.
7306 (mapc
7307 (lambda (keypad-normal)
7308 (let ((keypad (nth 0 keypad-normal))
7309 (normal (nth 1 keypad-normal)))
7310 (put keypad 'ascii-character normal)
7311 (define-key function-key-map (vector keypad) (vector normal))))
7312 ;; See also kp-keys bound in bindings.el.
7313 '((kp-space ?\s)
7316 (kp-separator ?,)
7317 (kp-equal ?=)
7318 ;; Do the same for various keys that are represented as symbols under
7319 ;; GUIs but naturally correspond to characters.
7320 (backspace 127)
7321 (delete 127)
7324 (clear ?\C-l)
7325 (return ?\C-m)
7326 (escape ?\e)
7327 ))
7328 \f
7329 ;;;;
7330 ;;;; forking a twin copy of a buffer.
7331 ;;;;
7333 (defvar clone-buffer-hook nil
7334 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7336 (defvar clone-indirect-buffer-hook nil
7337 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7339 (defun clone-process (process &optional newname)
7340 "Create a twin copy of PROCESS.
7341 If NEWNAME is nil, it defaults to PROCESS' name;
7342 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7343 If PROCESS is associated with a buffer, the new process will be associated
7344 with the current buffer instead.
7345 Returns nil if PROCESS has already terminated."
7346 (setq newname (or newname (process-name process)))
7348 (setq newname (substring newname 0 (match-beginning 0))))
7349 (when (memq (process-status process) '(run stop open))
7350 (let* ((process-connection-type (process-tty-name process))
7351 (new-process
7352 (if (memq (process-status process) '(open))
7353 (let ((args (process-contact process t)))
7354 (setq args (plist-put args :name newname))
7355 (setq args (plist-put args :buffer
7356 (if (process-buffer process)
7357 (current-buffer))))
7358 (apply 'make-network-process args))
7359 (apply 'start-process newname
7360 (if (process-buffer process) (current-buffer))
7361 (process-command process)))))
7362 (set-process-query-on-exit-flag
7363 new-process (process-query-on-exit-flag process))
7364 (set-process-inherit-coding-system-flag
7365 new-process (process-inherit-coding-system-flag process))
7366 (set-process-filter new-process (process-filter process))
7367 (set-process-sentinel new-process (process-sentinel process))
7368 (set-process-plist new-process (copy-sequence (process-plist process)))
7369 new-process)))
7371 ;; things to maybe add (currently partly covered by `funcall mode'):
7372 ;; - syntax-table
7373 ;; - overlays
7374 (defun clone-buffer (&optional newname display-flag)
7375 "Create and return a twin copy of the current buffer.
7376 Unlike an indirect buffer, the new buffer can be edited
7377 independently of the old one (if it is not read-only).
7378 NEWNAME is the name of the new buffer. It may be modified by
7379 adding or incrementing <N> at the end as necessary to create a
7380 unique buffer name. If nil, it defaults to the name of the
7381 current buffer, with the proper suffix. If DISPLAY-FLAG is
7382 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7383 clone a file-visiting buffer, or a buffer whose major mode symbol
7384 has a non-nil `no-clone' property, results in an error.
7386 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7387 current buffer with appropriate suffix. However, if a prefix
7388 argument is given, then the command prompts for NEWNAME in the
7389 minibuffer.
7391 This runs the normal hook `clone-buffer-hook' in the new buffer
7392 after it has been set up properly in other respects."
7393 (interactive
7394 (progn
7395 (if buffer-file-name
7396 (error "Cannot clone a file-visiting buffer"))
7397 (if (get major-mode 'no-clone)
7398 (error "Cannot clone a buffer in %s mode" mode-name))
7399 (list (if current-prefix-arg
7400 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7401 t)))
7402 (if buffer-file-name
7403 (error "Cannot clone a file-visiting buffer"))
7404 (if (get major-mode 'no-clone)
7405 (error "Cannot clone a buffer in %s mode" mode-name))
7406 (setq newname (or newname (buffer-name)))
7408 (setq newname (substring newname 0 (match-beginning 0))))
7409 (let ((buf (current-buffer))
7410 (ptmin (point-min))
7411 (ptmax (point-max))
7412 (pt (point))
7413 (mk (if mark-active (mark t)))
7414 (modified (buffer-modified-p))
7415 (mode major-mode)
7416 (lvars (buffer-local-variables))
7417 (process (get-buffer-process (current-buffer)))
7418 (new (generate-new-buffer (or newname (buffer-name)))))
7419 (save-restriction
7420 (widen)
7421 (with-current-buffer new
7422 (insert-buffer-substring buf)))
7423 (with-current-buffer new
7424 (narrow-to-region ptmin ptmax)
7425 (goto-char pt)
7426 (if mk (set-mark mk))
7427 (set-buffer-modified-p modified)
7429 ;; Clone the old buffer's process, if any.
7430 (when process (clone-process process))
7432 ;; Now set up the major mode.
7433 (funcall mode)
7435 ;; Set up other local variables.
7436 (mapc (lambda (v)
7437 (condition-case () ;in case var is read-only
7438 (if (symbolp v)
7439 (makunbound v)
7440 (set (make-local-variable (car v)) (cdr v)))
7441 (error nil)))
7442 lvars)
7444 ;; Run any hooks (typically set up by the major mode
7445 ;; for cloning to work properly).
7446 (run-hooks 'clone-buffer-hook))
7447 (if display-flag
7448 ;; Presumably the current buffer is shown in the selected frame, so
7449 ;; we want to display the clone elsewhere.
7450 (let ((same-window-regexps nil)
7451 (same-window-buffer-names))
7452 (pop-to-buffer new)))
7453 new))
7456 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7457 "Create an indirect buffer that is a twin copy of the current buffer.
7459 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7460 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7461 or if not called with a prefix arg, NEWNAME defaults to the current
7462 buffer's name. The name is modified by adding a `<N>' suffix to it
7463 or by incrementing the N in an existing suffix. Trying to clone a
7464 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7465 property results in an error.
7467 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7468 This is always done when called interactively.
7470 Optional third arg NORECORD non-nil means do not put this buffer at the
7471 front of the list of recently selected ones."
7472 (interactive
7473 (progn
7474 (if (get major-mode 'no-clone-indirect)
7475 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7476 (list (if current-prefix-arg
7477 (read-buffer "Name of indirect buffer: " (current-buffer)))
7478 t)))
7479 (if (get major-mode 'no-clone-indirect)
7480 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7481 (setq newname (or newname (buffer-name)))
7483 (setq newname (substring newname 0 (match-beginning 0))))
7484 (let* ((name (generate-new-buffer-name newname))
7485 (buffer (make-indirect-buffer (current-buffer) name t)))
7486 (with-current-buffer buffer
7487 (run-hooks 'clone-indirect-buffer-hook))
7488 (when display-flag
7489 (pop-to-buffer buffer norecord))
7490 buffer))
7493 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7494 "Like `clone-indirect-buffer' but display in another window."
7495 (interactive
7496 (progn
7497 (if (get major-mode 'no-clone-indirect)
7498 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7499 (list (if current-prefix-arg
7500 (read-buffer "Name of indirect buffer: " (current-buffer)))
7501 t)))
7502 (let ((pop-up-windows t))
7503 (clone-indirect-buffer newname display-flag norecord)))
7505 \f
7506 ;;; Handling of Backspace and Delete keys.
7508 (defcustom normal-erase-is-backspace 'maybe
7509 "Set the default behavior of the Delete and Backspace keys.
7511 If set to t, Delete key deletes forward and Backspace key deletes
7512 backward.
7514 If set to nil, both Delete and Backspace keys delete backward.
7516 If set to 'maybe (which is the default), Emacs automatically
7517 selects a behavior. On window systems, the behavior depends on
7518 the keyboard used. If the keyboard has both a Backspace key and
7519 a Delete key, and both are mapped to their usual meanings, the
7520 option's default value is set to t, so that Backspace can be used
7521 to delete backward, and Delete can be used to delete forward.
7523 If not running under a window system, customizing this option
7524 accomplishes a similar effect by mapping C-h, which is usually
7525 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7526 via `keyboard-translate'. The former functionality of C-h is
7527 available on the F1 key. You should probably not use this
7528 setting if you don't have both Backspace, Delete and F1 keys.
7530 Setting this variable with setq doesn't take effect. Programmatically,
7531 call `normal-erase-is-backspace-mode' (which see) instead."
7532 :type '(choice (const :tag "Off" nil)
7533 (const :tag "Maybe" maybe)
7534 (other :tag "On" t))
7535 :group 'editing-basics
7536 :version "21.1"
7537 :set (lambda (symbol value)
7538 ;; The fboundp is because of a problem with :set when
7539 ;; dumping Emacs. It doesn't really matter.
7540 (if (fboundp 'normal-erase-is-backspace-mode)
7541 (normal-erase-is-backspace-mode (or value 0))
7542 (set-default symbol value))))
7544 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7545 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7546 (unless frame (setq frame (selected-frame)))
7547 (with-selected-frame frame
7548 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7549 (normal-erase-is-backspace-mode
7550 (if (if (eq normal-erase-is-backspace 'maybe)
7551 (and (not noninteractive)
7552 (or (memq system-type '(ms-dos windows-nt))
7553 (memq window-system '(w32 ns))
7554 (and (memq window-system '(x))
7555 (fboundp 'x-backspace-delete-keys-p)
7556 (x-backspace-delete-keys-p))
7557 ;; If the terminal Emacs is running on has erase char
7558 ;; set to ^H, use the Backspace key for deleting
7559 ;; backward, and the Delete key for deleting forward.
7560 (and (null window-system)
7561 (eq tty-erase-char ?\^H))))
7562 normal-erase-is-backspace)
7563 1 0)))))
7565 (define-minor-mode normal-erase-is-backspace-mode
7566 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7567 With a prefix argument ARG, enable this feature if ARG is
7568 positive, and disable it otherwise. If called from Lisp, enable
7569 the mode if ARG is omitted or nil.
7571 On window systems, when this mode is on, Delete is mapped to C-d
7572 and Backspace is mapped to DEL; when this mode is off, both
7573 Delete and Backspace are mapped to DEL. (The remapping goes via
7574 `local-function-key-map', so binding Delete or Backspace in the
7575 global or local keymap will override that.)
7577 In addition, on window systems, the bindings of C-Delete, M-Delete,
7578 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7579 the global keymap in accordance with the functionality of Delete and
7580 Backspace. For example, if Delete is remapped to C-d, which deletes
7581 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7582 to DEL, which deletes backward, C-Delete is bound to
7583 `backward-kill-word'.
7585 If not running on a window system, a similar effect is accomplished by
7586 remapping C-h (normally produced by the Backspace key) and DEL via
7587 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7588 to C-d; if it's off, the keys are not remapped.
7590 When not running on a window system, and this mode is turned on, the
7591 former functionality of C-h is available on the F1 key. You should
7592 probably not turn on this mode on a text-only terminal if you don't
7593 have both Backspace, Delete and F1 keys.
7595 See also `normal-erase-is-backspace'."
7596 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7597 . (lambda (v)
7598 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7599 (if v 1 0))))
7600 (let ((enabled (eq 1 (terminal-parameter
7601 nil 'normal-erase-is-backspace))))
7603 (cond ((or (memq window-system '(x w32 ns pc))
7604 (memq system-type '(ms-dos windows-nt)))
7605 (let ((bindings
7606 `(([M-delete] [M-backspace])
7607 ([C-M-delete] [C-M-backspace])
7608 ([?\e C-delete] [?\e C-backspace]))))
7610 (if enabled
7611 (progn
7612 (define-key local-function-key-map [delete] [deletechar])
7613 (define-key local-function-key-map [kp-delete] [deletechar])
7614 (define-key local-function-key-map [backspace] [?\C-?])
7615 (dolist (b bindings)
7616 ;; Not sure if input-decode-map is really right, but
7617 ;; keyboard-translate-table (used below) only works
7618 ;; for integer events, and key-translation-table is
7619 ;; global (like the global-map, used earlier).
7620 (define-key input-decode-map (car b) nil)
7621 (define-key input-decode-map (cadr b) nil)))
7622 (define-key local-function-key-map [delete] [?\C-?])
7623 (define-key local-function-key-map [kp-delete] [?\C-?])
7624 (define-key local-function-key-map [backspace] [?\C-?])
7625 (dolist (b bindings)
7626 (define-key input-decode-map (car b) (cadr b))
7627 (define-key input-decode-map (cadr b) (car b))))))
7628 (t
7629 (if enabled
7630 (progn
7631 (keyboard-translate ?\C-h ?\C-?)
7632 (keyboard-translate ?\C-? ?\C-d))
7633 (keyboard-translate ?\C-h ?\C-h)
7634 (keyboard-translate ?\C-? ?\C-?))))
7636 (if (called-interactively-p 'interactive)
7637 (message "Delete key deletes %s"
7638 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7639 "forward" "backward")))))
7640 \f
7641 (defvar vis-mode-saved-buffer-invisibility-spec nil
7642 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7644 (define-minor-mode read-only-mode
7645 "Change whether the current buffer is read-only.
7646 With prefix argument ARG, make the buffer read-only if ARG is
7647 positive, otherwise make it writable. If buffer is read-only
7648 and `view-read-only' is non-nil, enter view mode.
7650 Do not call this from a Lisp program unless you really intend to
7652 possibly enabling or disabling View mode. Also, note that this
7653 command works by setting the variable `buffer-read-only', which
7654 does not affect read-only regions caused by text properties. To
7655 ignore read-only status in a Lisp program (whether due to text
7656 properties or buffer state), bind `inhibit-read-only' temporarily
7657 to a non-nil value."
7658 :variable buffer-read-only
7659 (cond
7660 ((and (not buffer-read-only) view-mode)
7661 (View-exit-and-edit)
7662 (make-local-variable 'view-read-only)
7663 (setq view-read-only t)) ; Must leave view mode.
7664 ((and buffer-read-only view-read-only
7665 ;; If view-mode is already active, `view-mode-enter' is a nop.
7666 (not view-mode)
7667 (not (eq (get major-mode 'mode-class) 'special)))
7668 (view-mode-enter))))
7670 (define-minor-mode visible-mode
7671 "Toggle making all invisible text temporarily visible (Visible mode).
7672 With a prefix argument ARG, enable Visible mode if ARG is
7673 positive, and disable it otherwise. If called from Lisp, enable
7674 the mode if ARG is omitted or nil.
7676 This mode works by saving the value of `buffer-invisibility-spec'
7677 and setting it to nil."
7678 :lighter " Vis"
7679 :group 'editing-basics
7680 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7681 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7682 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7683 (when visible-mode
7684 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7685 buffer-invisibility-spec)
7686 (setq buffer-invisibility-spec nil)))
7687 \f
7688 (defvar messages-buffer-mode-map
7689 (let ((map (make-sparse-keymap)))
7690 (set-keymap-parent map special-mode-map)
7691 (define-key map "g" nil) ; nothing to revert
7692 map))
7694 (define-derived-mode messages-buffer-mode special-mode "Messages"
7697 (defun messages-buffer ()
7699 If it does not exist, create and it switch it to `messages-buffer-mode'."
7700 (or (get-buffer "*Messages*")
7701 (with-current-buffer (get-buffer-create "*Messages*")
7702 (messages-buffer-mode)
7703 (current-buffer))))
7705 \f
7706 ;; Minibuffer prompt stuff.
7708 ;;(defun minibuffer-prompt-modification (start end)
7709 ;; (error "You cannot modify the prompt"))
7710 ;;
7711 ;;
7712 ;;(defun minibuffer-prompt-insertion (start end)
7713 ;; (let ((inhibit-modification-hooks t))
7714 ;; (delete-region start end)
7715 ;; ;; Discard undo information for the text insertion itself
7716 ;; ;; and for the text deletion.above.
7717 ;; (when (consp buffer-undo-list)
7718 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7719 ;; (message "You cannot modify the prompt")))
7720 ;;
7721 ;;
7722 ;;(setq minibuffer-prompt-properties
7723 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7724 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7726 \f
7727 ;;;; Problematic external packages.
7729 ;; rms says this should be done by specifying symbols that define
7730 ;; versions together with bad values. This is therefore not as
7731 ;; flexible as it could be. See the thread:
7732 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7733 (defconst bad-packages-alist
7734 ;; Not sure exactly which semantic versions have problems.
7735 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7737 "The version of `semantic' loaded does not work in Emacs 22.
7738 It can cause constant high CPU load.
7739 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7740 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7741 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7742 ;; provided the `CUA-mode' feature. Since this is no longer true,
7743 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7744 (CUA-mode t nil
7745 "CUA-mode is now part of the standard GNU Emacs distribution,
7746 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7748 You have loaded an older version of CUA-mode which does not work
7749 correctly with this version of Emacs. You should remove the old
7750 version and use the one distributed with Emacs."))
7751 "Alist of packages known to cause problems in this version of Emacs.
7752 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7753 PACKAGE is either a regular expression to match file names, or a
7754 symbol (a feature name), like for `with-eval-after-load'.
7755 SYMBOL is either the name of a string variable, or `t'. Upon
7756 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7757 warning using STRING as the message.")
7759 (defun bad-package-check (package)
7760 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7761 (condition-case nil
7762 (let* ((list (assoc package bad-packages-alist))
7763 (symbol (nth 1 list)))
7764 (and list
7765 (boundp symbol)
7766 (or (eq symbol t)
7767 (and (stringp (setq symbol (eval symbol)))
7768 (string-match-p (nth 2 list) symbol)))
7769 (display-warning package (nth 3 list) :warning)))
7770 (error nil)))
7772 (dolist (elem bad-packages-alist)
7773 (let ((pkg (car elem)))
7774 (with-eval-after-load pkg
7775 (bad-package-check pkg))))
7777 \f
7778 ;;; Generic dispatcher commands
7780 ;; Macro `define-alternatives' is used to create generic commands.
7781 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
7782 ;; that can have different alternative implementations where choosing
7783 ;; among them is exclusively a matter of user preference.
7785 ;; (define-alternatives COMMAND) creates a new interactive command
7786 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
7787 ;; Typically, the user will not need to customize this variable; packages
7788 ;; wanting to add alternative implementations should use
7789 ;;
7790 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
7792 (defmacro define-alternatives (command &rest customizations)
7793 "Define the new command `COMMAND'.
7795 The argument `COMMAND' should be a symbol.
7797 Running `M-x COMMAND RET' for the first time prompts for which
7798 alternative to use and records the selected command as a custom
7799 variable.
7801 Running `C-u M-x COMMAND RET' prompts again for an alternative
7802 and overwrites the previous choice.
7804 The variable `COMMAND-alternatives' contains an alist with
7805 alternative implementations of COMMAND. `define-alternatives'
7806 does not have any effect until this variable is set.
7808 CUSTOMIZATIONS, if non-nil, should be composed of alternating
7809 `defcustom' keywords and values to add to the declaration of
7810 `COMMAND-alternatives' (typically :group and :version)."
7811 (let* ((command-name (symbol-name command))
7812 (varalt-name (concat command-name "-alternatives"))
7813 (varalt-sym (intern varalt-name))
7814 (varimp-sym (intern (concat command-name "--implementation"))))
7815 `(progn
7817 (defcustom ,varalt-sym nil
7818 ,(format "Alist of alternative implementations for the `%s' command.
7820 Each entry must be a pair (ALTNAME . ALTFUN), where:
7821 ALTNAME - The name shown at user to describe the alternative implementation.
7822 ALTFUN - The function called to implement this alternative."
7823 command-name)
7824 :type '(alist :key-type string :value-type function)
7825 ,@customizations)
7827 (put ',varalt-sym 'definition-name ',command)
7828 (defvar ,varimp-sym nil "Internal use only.")
7830 (defun ,command (&optional arg)
7831 ,(format "Run generic command `%s'.
7832 If used for the first time, or with interactive ARG, ask the user which
7833 implementation to use for `%s'. The variable `%s'
7834 contains the list of implementations currently supported for this command."
7835 command-name command-name varalt-name)
7836 (interactive "P")
7837 (when (or arg (null ,varimp-sym))
7838 (let ((val (completing-read
7839 ,(format "Select implementation for command `%s': "
7840 command-name)
7841 ,varalt-sym nil t)))
7842 (unless (string-equal val "")
7843 (when (null ,varimp-sym)
7844 (message
7845 "Use `C-u M-x %s RET' to select another implementation"
7846 ,command-name)
7847 (sit-for 3))
7848 (customize-save-variable ',varimp-sym
7849 (cdr (assoc-string val ,varalt-sym))))))
7850 (if ,varimp-sym
7851 (call-interactively ,varimp-sym)
7852 (message ,(format "No implementation selected for command `%s'"
7853 command-name)))))))
7855 \f
7856 ;; This is here because files in obsolete/ are not scanned for autoloads.
7858 (defvar iswitchb-mode nil "\
7859 Non-nil if Iswitchb mode is enabled.
7860 See the command `iswitchb-mode' for a description of this minor mode.
7861 Setting this variable directly does not take effect;
7862 either customize it (see the info node `Easy Customization')
7863 or call the function `iswitchb-mode'.")
7865 (custom-autoload 'iswitchb-mode "iswitchb" nil)
7867 (autoload 'iswitchb-mode "iswitchb" "\
7868 Toggle Iswitchb mode.
7869 With a prefix argument ARG, enable Iswitchb mode if ARG is
7870 positive, and disable it otherwise. If called from Lisp, enable
7871 the mode if ARG is omitted or nil.
7873 Iswitchb mode is a global minor mode that enables switching
7874 between buffers using substrings. See `iswitchb' for details.
7876 \(fn &optional ARG)" t nil)
7878 (make-obsolete 'iswitchb-mode
7879 "use `icomplete-mode' or `ido-mode' instead." "24.4")
7880 \f
7882 (provide 'simple)
7884 ;;; simple.el ends here