| blob | bc92a9ab24b9bba3b58e282a13ee504e309b5933 |
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.
381 "Insert a newline, and move to left margin of the new line if it's blank.
382 If option `use-hard-newlines' is non-nil, the newline is marked with the
383 text-property `hard'.
384 With ARG, insert that many newlines.
386 If `electric-indent-mode' is enabled, this indents the final new line
387 that it adds, and reindents the preceding line. To just insert
390 Calls `auto-fill-function' if the current column number is greater
391 than the value of `fill-column' and ARG is nil.
392 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
395 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
396 ;; Set last-command-event to tell self-insert what to insert.
400 ;; Don't auto-fill if we have a numeric argument.
403 ;; Do the rest in post-self-insert-hook, because we want to do it
404 ;; *before* other functions on that hook.
406 ;; Mark the newline(s) `hard'.
410 ;; If the newline leaves the previous line blank, and we
411 ;; have a left margin, delete that from the blank line.
419 ;; Indent the line after the newline, except in one case:
420 ;; when we added the newline at the beginning of a line which
421 ;; starts a page.
425 ;; FIXME: For non-interactive uses, many calls actually just want
426 ;; (insert "\n"), so maybe we should do just that, so as to avoid
427 ;; the risk of filling or running abbrevs unexpectedly.
434 ;; We first used let-binding to protect the hook, but that was naive
435 ;; since add-hook affects the symbol-default value of the variable,
436 ;; whereas the let-binding might only protect the buffer-local value.
438 nil)
443 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
449 "Insert a newline and leave point before it.
450 If there is a fill prefix and/or a `left-margin', insert them
451 on the new line if the line would have been blank.
452 With arg N, insert N newlines."
457 ;; Don't expand an abbrev before point.
471 "Split current line, moving portion beyond point vertically down.
472 If the current line starts with `fill-prefix', insert it on the new
473 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
475 When called from Lisp code, ARG may be a prefix string to copy."
480 ;; What prefix should we check for (nil means don't).
484 ;; Does this line start with it?
495 "Join this line to previous and fix up whitespace at join.
496 If there is a fill prefix, delete it from the beginning of this line.
497 With argument, join this line to following line."
504 ;; If the second line started with the fill prefix,
505 ;; delete the prefix.
517 "On blank line, delete all surrounding blank lines, leaving just one.
518 On isolated blank line, delete that one.
519 On nonblank line, delete any immediately following blank lines."
525 ;; Set singleblank if there is just one blank line here.
532 ;; Delete preceding blank lines, and this one too if it's the only one.
541 ;; Delete following blank lines, unless the current line is blank
542 ;; and there are no following blank lines.
551 ;; Handle the special case where point is followed by newline and eob.
552 ;; Delete the line, leaving point at eob.
558 Trailing lines are deleted only if `delete-trailing-whitespace'
559 is called on the entire buffer (rather than an active region)."
565 "Delete trailing whitespace between START and END.
566 If called interactively, START and END are the start/end of the
567 region if the mark is active, or of the buffer's accessible
568 portion if the mark is inactive.
570 This command deletes whitespace characters after the last
571 non-whitespace character in each line between START and END. It
572 does not consider formfeed characters to be whitespace.
574 If this command acts on the entire buffer (i.e. if called
575 interactively with the mark inactive, or called from Lisp with
576 END nil), it also deletes all trailing lines at the end of the
577 buffer if the variable `delete-trailing-lines' is non-nil."
590 ;; Don't delete formfeeds, even if they are considered whitespace.
594 ;; Delete trailing empty lines.
597 delete-trailing-lines
598 ;; Really the end of buffer.
603 ;; Return nil for the benefit of `write-file-functions'.
604 nil)
607 "Insert a newline, then indent according to major mode.
608 Indentation is done using the value of `indent-line-function'.
609 In programming language modes, this is the same as TAB.
610 In some text modes, where TAB inserts a tab, this command indents to the
611 column specified by the function `current-left-margin'."
618 "Reindent current line, insert newline, then indent the new line.
619 Indentation of both lines is done according to the current major mode,
620 which means calling the current value of `indent-line-function'.
621 In programming language modes, this is the same as TAB.
622 In some text modes, where TAB inserts a tab, this indents to the
623 column specified by the function `current-left-margin'."
626 ;; Be careful to insert the newline before indenting the line.
627 ;; Otherwise, the indentation might be wrong.
631 ;; We are at EOL before the call to indent-according-to-mode, and
632 ;; after it we usually are as well, but not always. We tried to
633 ;; address it with `save-excursion' but that uses a normal marker
634 ;; whereas we need `move after insertion', so we do the save/restore
635 ;; by hand.
639 ;; Remove the trailing white-space after indentation because
640 ;; indentation may introduce the whitespace.
646 Legitimate radix values are 8, 10 and 16."
651 "Like `read-char', but do not allow quitting.
652 Also, if the first character read is an octal digit,
653 we read any number of octal digits and return the
654 specified character code. Any nondigit terminates the sequence.
655 If the terminator is RET, it is discarded;
656 any other terminator is used itself as input.
658 The optional argument PROMPT specifies a string to use to prompt the user.
659 The variable `read-quoted-char-radix' controls which radix to use
660 for numeric input."
664 ;; Don't let C-h get the help message--only help function keys.
667 "Type the special character you want to use,
668 or the octal character code.
669 RET terminates the character code and is discarded;
679 done t))
681 ;; Turn a meta-character into a character with the 0200 bit set.
683 done t))
699 done t))
701 done t)))
703 code))
706 "Read next input character and insert it.
707 This is useful for inserting control characters.
708 With argument, insert ARG copies of the character.
710 If the first character you type after this command is an octal digit,
711 you should type a sequence of octal digits which specify a character code.
712 Any nondigit terminates the sequence. If the terminator is a RET,
713 it is discarded; any other terminator is used itself as input.
714 The variable `read-quoted-char-radix' specifies the radix for this feature;
715 set it to 10 or 16 to use decimal or hex instead of octal.
717 In overwrite mode, this function inserts the character anyway, and
718 does not handle octal digits specially. This means that if you use
719 overwrite as your normal editing mode, you can use this function to
720 insert characters when necessary.
722 In binary overwrite mode, this function does overwrite, and octal
723 digits are interpreted as a character code. This is intended to be
724 useful for editing binary files."
727 ;; Avoid "obsolete" warnings for translation-table-for-input.
734 ;; This used to assume character codes 0240 - 0377 stand for
735 ;; characters in some single-byte character set, and converted them
736 ;; to Emacs characters. But in 23.1 this feature is deprecated
737 ;; in favor of inserting the corresponding Unicode characters.
738 ;; (if (and enable-multibyte-characters
739 ;; (>= char ?\240)
740 ;; (<= char ?\377))
741 ;; (setq char (unibyte-char-to-multibyte char)))
753 "Move forward ARG lines and position at first nonblank character."
759 "Move backward ARG lines and position at first nonblank character."
765 "Move point to the first non-whitespace character on this line."
769 ;; Move back over chars that have whitespace syntax but have the p flag.
773 "Fixup white space between objects around point.
774 Leave one space or none, according to the context."
781 nil
785 "Delete all spaces and tabs around point.
786 If BACKWARD-ONLY is non-nil, only delete them before point."
791 orig-pos
800 "Delete all spaces and tabs around point, leaving one space (or N spaces).
801 If N is negative, delete newlines as well, leaving -N spaces.
802 See also `cycle-spacing'."
807 "Store context used in consecutive calls to `cycle-spacing' command.
808 The first time `cycle-spacing' runs, it saves in this variable:
809 its N argument, the original point position, and the original spacing
813 "Manipulate whitespace around point in a smart way.
814 In interactive use, this function behaves differently in successive
815 consecutive calls.
817 The first call in a sequence acts like `just-one-space'.
818 It deletes all spaces and tabs around point, leaving one space
819 \(or N spaces). N is the prefix argument. If N is negative,
820 it deletes newlines as well, leaving -N spaces.
821 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
823 The second call in a sequence deletes all spaces.
825 The third call in a sequence restores the original whitespace (and point).
827 If MODE is `single-shot', it only performs the first step in the sequence.
828 If MODE is `fast' and the first step would not result in any change
829 \(i.e., there are exactly (abs N) spaces around point),
830 the function goes straight to the second step.
832 Repeatedly calling the function with different values of N starts a
833 new sequence each time."
841 ;; Command run for the first time, single-shot mode or different argument
853 ;; Special handling for case where there was no space at all.
856 ;; If this run causes no change in buffer content, delete all spaces,
857 ;; otherwise delete all excess spaces.
862 ;; Command run for the second time.
866 ;; Command run for the third time.
871 \f
873 "Move point to the beginning of the buffer.
874 With numeric arg N, put point N/10 of the way from the beginning.
875 If the buffer is narrowed, this command uses the beginning of the
876 accessible part of the buffer.
878 If Transient Mark mode is disabled, leave mark at previous
889 ;; Avoid overflow for large buffer sizes!
897 "Move point to the end of the buffer.
898 With numeric arg N, put point N/10 of the way from the end.
899 If the buffer is narrowed, this command uses the end of the
900 accessible part of the buffer.
902 If Transient Mark mode is disabled, leave mark at previous
911 ;; Avoid overflow for large buffer sizes!
916 ;; If we went to a place in the middle of the buffer,
917 ;; adjust it to the beginning of a line.
921 ;; If the end of the buffer is not already on the screen,
922 ;; then scroll specially to put it near, but not at, the bottom.
927 "Whether single-char deletion commands delete an active region.
928 This has an effect only if Transient Mark mode is enabled, and
929 affects `delete-forward-char' and `delete-backward-char', though
930 not `delete-char'.
932 If the value is the symbol `kill', the active region is killed
933 instead of deleted."
946 "Function to get the region's content.
947 Called with one argument DELETE.
948 If DELETE is `delete-only', then only delete the region and the return value
949 is undefined. If DELETE is nil, just return the content as a string.
953 "Delete the previous N characters (following if N is negative).
954 If Transient Mark mode is enabled, the mark is active, and N is 1,
955 delete the text in the region and deactivate the mark instead.
956 To disable this, set option `delete-active-region' to nil.
958 Optional second arg KILLFLAG, if non-nil, means to kill (save in
959 kill ring) instead of delete. Interactively, N is the prefix
960 arg, and KILLFLAG is set if N is explicitly specified.
962 In Overwrite mode, single character backward deletion may replace
963 tabs with spaces so as to back over columns, unless point is at
964 the end of the line."
970 delete-active-region
972 ;; If a region is active, kill or delete it.
976 ;; In Overwrite mode, maybe untabify while deleting
986 ;; Otherwise, do simple deletion.
990 "Delete the following N characters (previous if N is negative).
991 If Transient Mark mode is enabled, the mark is active, and N is 1,
992 delete the text in the region and deactivate the mark instead.
993 To disable this, set variable `delete-active-region' to nil.
995 Optional second arg KILLFLAG non-nil means to kill (save in kill
996 ring) instead of delete. Interactively, N is the prefix arg, and
997 KILLFLAG is set if N was explicitly specified."
1003 delete-active-region
1005 ;; If a region is active, kill or delete it.
1010 ;; Otherwise, do simple deletion.
1014 "Put point at beginning and mark at end of buffer.
1015 If narrowing is in effect, only uses the accessible part of the buffer.
1016 You probably should not use this function in Lisp programs;
1017 it is usually a mistake for a Lisp function to use any subroutine
1018 that uses or sets the mark."
1024 \f
1026 ;; Counting lines, one way or another.
1029 "Go to LINE, counting from line 1 at beginning of buffer.
1030 If called interactively, a numeric prefix argument specifies
1031 LINE; without a numeric prefix argument, read LINE from the
1032 minibuffer.
1034 If optional argument BUFFER is non-nil, switch to that buffer and
1036 as argument, BUFFER is the most recently selected other buffer.
1038 Prior to moving point, this function sets the mark (without
1039 activating it), unless Transient Mark mode is enabled and the
1040 mark is already active.
1042 This function is usually the wrong thing to use in a Lisp program.
1043 What you probably want instead is something like:
1044 (goto-char (point-min))
1045 (forward-line (1- N))
1046 If at all possible, an even better solution is to use char counts
1047 rather than line counts."
1052 ;; Look for a default, a number in the buffer at point.
1062 ;; Decide if we're switching buffers.
1070 ;; Read the argument, offering that number (if any) as default.
1073 buffer))))
1074 ;; Switch to the desired buffer, one way or another.
1079 ;; Leave mark at previous position
1081 ;; Move to the specified line number in that buffer.
1090 "Count the number of words in the region.
1091 If called interactively, print a message reporting the number of
1092 lines, words, and characters in the region (whether or not the
1093 region is active); with prefix ARG, report for the entire buffer
1094 rather than the region.
1096 If called from Lisp, return the number of words between positions
1097 START and END."
1109 "Count words between START and END.
1110 If called interactively, START and END are normally the start and
1111 end of the buffer; but if the region is active, START and END are
1112 the start and end of the region. Print a message reporting the
1113 number of lines, words, and chars.
1115 If called from Lisp, return the number of words between START and
1116 END, without printing any message."
1126 words))
1142 str
1150 "Print the current buffer line number and narrowed line number of point."
1163 "Return number of lines between START and END.
1164 This is usually the number of newlines between them,
1165 but can be one more if START is not equal to END
1166 and the greater of them is not at the start of a line."
1182 done)))
1186 "Return (narrowed) buffer line number at position POS.
1187 If POS is nil, use current buffer location.
1188 Counting starts at (point-min), so the value refers
1189 to the contents of the accessible portion of the buffer."
1199 "Print info on cursor position (on screen and within buffer).
1200 Also describe the character after point, and give its character code
1201 in octal, decimal and hex.
1203 For a non-ASCII multibyte character, also give its encoding in the
1204 buffer's selected coding system if the coding system encodes the
1205 character safely. If the character is encoded into one byte, that
1206 code is shown in hex. If the character is encoded into more than one
1209 In addition, with prefix argument, show details about that character
1210 in *Help* buffer. See also the command `describe-char'."
1215 ;; If the character is one of LRE, LRO, RLE, RLO, it
1216 ;; will start a directional embedding, which could
1217 ;; completely disrupt the rest of the line (e.g., RLO
1218 ;; will display the rest of the line right-to-left).
1219 ;; So we put an invisible PDF character after these
1220 ;; characters, to end the embedding, which eliminates
1221 ;; any effects on the rest of the line.
1223 ;; Strong right-to-left characters cause reordering of
1224 ;; the following numerical characters which show the
1225 ;; codepoint, so append LRM to countermand that.
1235 ;; Avoid overflow from multiplying by 100!
1239 ""
1245 pos total percent beg end col hscroll)
1247 pos total col hscroll))
1249 encoded encoding-msg display-prop under-display)
1256 ;; Check if the character is displayed with some `display'
1257 ;; text property. In that case, set under-display to the
1258 ;; buffer substring covered by that property.
1269 under-display)))
1275 char char char under-display)
1277 char char char under-display display-prop))
1280 char char char
1282 "..."
1286 ;; We show the detailed information about CHAR.
1293 bidi-fixer
1294 encoding-msg pos total percent beg end col hscroll)
1301 bidi-fixer encoding-msg pos total percent col hscroll))))))
1302 \f
1303 ;; Initialize read-expression-map. It is defined at C level.
1307 ;; Might as well bind TAB to completion, since inserting a TAB char is
1308 ;; much too rarely useful.
1311 m))
1314 "Return a Lisp object read using the minibuffer, unevaluated.
1315 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1316 is a string to insert in the minibuffer before reading.
1317 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1318 Such arguments are used as in `read-from-minibuffer'.)"
1319 ;; Used for interactive spec `x'.
1324 "Return value of Lisp expression read using the minibuffer.
1325 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1326 is a string to insert in the minibuffer before reading.
1327 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1328 Such arguments are used as in `read-from-minibuffer'.)"
1329 ;; Used for interactive spec `X'.
1337 "The current default value or list of default values in the minibuffer.
1338 The functions `read-from-minibuffer' and `completing-read' bind
1342 "Value for `print-level' while printing value in `eval-expression'.
1343 A value of nil means no limit."
1349 "Value for `print-length' while printing value in `eval-expression'.
1350 A value of nil means no limit."
1356 "If non-nil set `debug-on-error' to t in `eval-expression'.
1357 If nil, don't change the value of `debug-on-error'."
1363 "Format VALUE as a result of evaluated expression.
1364 Return a formatted string which is displayed in the echo area
1365 in addition to the value printed by prin1 in functions which
1366 display the result of expression evaluation."
1389 read-expression-map t
1392 ;; We define this, rather than making `eval' interactive,
1393 ;; for the sake of completion of names like eval-region, eval-buffer.
1395 "Evaluate EXP and print value in the echo area.
1396 When called interactively, read an Emacs Lisp expression and evaluate it.
1397 Value is also consed on to front of the variable `values'.
1398 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1399 argument) means insert the result into the current buffer instead of
1400 printing it in the echo area.
1402 Normally, this function truncates long output according to the value
1403 of the variables `eval-expression-print-length' and
1404 `eval-expression-print-level'. With a prefix argument of zero,
1405 however, there is no such truncation. Such a prefix argument
1406 also causes integers to be printed in several additional formats
1407 \(octal, hexadecimal, and character).
1409 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1410 minibuffer.
1412 If `eval-expression-debug-on-error' is non-nil, which is the default,
1413 this command arranges for all errors to enter the debugger."
1416 current-prefix-arg))
1421 ;; Bind debug-on-error to something unique so that we can
1422 ;; detect when evalled code changes it.
1426 ;; If evalled code has changed the value of debug-on-error,
1427 ;; propagate that change to the global binding.
1432 eval-expression-print-length))
1434 eval-expression-print-level))
1450 "Prompting with PROMPT, let user edit COMMAND and eval result.
1451 COMMAND is a Lisp expression. Let user edit that expression in
1452 the minibuffer, then read and evaluate the result."
1459 read-expression-map t
1461 ;; If command was added to command-history as a string,
1462 ;; get rid of that. We want only evaluable expressions there.
1466 ;; If command to be redone does not match front of history,
1467 ;; add it to the history.
1473 "Edit and re-evaluate last complex command, or ARGth from last.
1474 A complex command is one which used the minibuffer.
1475 The command is placed in the minibuffer as a Lisp form for editing.
1476 The result is executed, repeating the command as changed.
1477 If the command has been changed or is not the most recent previous
1478 command it is added to the front of the command history.
1479 You can use the minibuffer history commands \
1481 to get different commands to edit and resubmit."
1484 newcmd)
1496 ;; If command was added to command-history as a
1497 ;; string, get rid of that. We want only
1498 ;; evaluable expressions there.
1502 ;; If command to be redone does not match front of history,
1503 ;; add it to the history.
1508 ;; Trick called-interactively-p into thinking that `newcmd' is
1509 ;; an interactive call (bug#14136).
1528 "Read command name to invoke in `execute-extended-command'."
1533 ;; Get a command name at point in the original buffer
1534 ;; to propose it after M-n.
1538 ;; Read a string, completing from and restricting to the set of
1539 ;; all defined commands. Don't provide any initial input.
1540 ;; Save the command read on the extended-command history list.
1551 ;; This isn't strictly correct if `execute-extended-command'
1552 ;; is bound to anything else (e.g. [menu]).
1553 ;; It could use (key-description (this-single-command-keys)),
1554 ;; but actually a prompt other than "M-x" would be confusing,
1555 ;; because "M-x" is a well-known prompt to read a command
1556 ;; and it serves as a shorthand for "Extended command: ".
1561 "Non-nil means show the equivalent key-binding when M-x command has one.
1562 The value can be a length of time to show the message for.
1563 If the value is non-nil and not a number, we wait 2 seconds."
1570 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1571 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1572 "Read a command name, then read the arguments and call the command.
1573 Interactively, to pass a prefix argument to the command you are
1574 invoking, give a prefix argument to `execute-extended-command'.
1575 Noninteractively, the argument PREFIXARG is the prefix argument to
1576 give to the command you invoke."
1578 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1589 ;; Normally `real-this-command' should never be changed, but here we really
1590 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1591 ;; binding" for <cmd>, so the command the user really wanted to run is
1592 ;; `function' and not `execute-extended-command'. The difference is
1593 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1597 ;; If enabled, show which key runs this command.
1599 ;; But first wait, and skip the message if there is input.
1601 ;; If this command displayed something in the echo area;
1602 ;; wait a few seconds, then display our suggestion message.
1612 suggest-key-bindings
1616 ;; BEWARE: Called directly from the C code.
1617 "Execute CMD as an editor command.
1618 CMD must be a symbol that satisfies the `commandp' predicate.
1619 Optional second arg RECORD-FLAG non-nil
1620 means unconditionally put this command in the variable `command-history'.
1621 Otherwise, that is done only if an arg is read using the minibuffer.
1622 The argument KEYS specifies the value to use instead of (this-command-keys)
1623 when reading the arguments; if it is nil, (this-command-keys) is used.
1624 The argument SPECIAL, if non-nil, means that this command is executing
1625 a special event, so ignore the prefix argument and don't clear it."
1633 ;; FIXME: Weird calling convention!
1643 ;; If requested, place the macro in the command history. For
1644 ;; other sorts of commands, call-interactively takes care of this.
1647 ;; Don't keep command history around forever.
1653 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1661 \f
1663 "Default minibuffer history list.
1664 This is used for all minibuffer input
1665 except when an alternate history list is specified.
1667 Maximum length of the history list is determined by the value
1670 "Control whether history list elements are expressions or strings.
1671 If the value of this variable equals current minibuffer depth,
1672 they are expressions; otherwise they are strings.
1673 \(That convention is designed to do the right thing for
1680 "Text that was in this minibuffer before any history commands.
1681 This is nil if there have not yet been any history commands
1690 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1694 "Minibuffer history variables for which matching should ignore case.
1695 If a history variable is a member of this list, then the
1697 commands ignore case when searching it, regardless of `case-fold-search'."
1702 "Find the previous history element that matches REGEXP.
1703 \(Previous history elements refer to earlier actions.)
1704 With prefix argument N, search for Nth previous match.
1705 If N is negative, find the next or Nth next match.
1706 Normally, history elements are matched case-insensitively if
1707 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1708 makes the search case-sensitive.
1709 See also `minibuffer-history-case-insensitive-variables'."
1713 nil
1714 minibuffer-local-map
1715 nil
1716 'minibuffer-history-search-history
1718 ;; Use the last regexp specified, by default, if input is empty.
1723 regexp)
1733 ;; On some systems, ignore case for file names.
1735 minibuffer-history-case-insensitive-variables)
1736 t
1737 ;; Respect the user's setting for case-fold-search:
1738 case-fold-search)
1739 nil))
1740 prevpos
1741 match-string
1742 match-offset
1749 "No later matching history item"
1770 next-matching-history-element))
1774 "Find the next history element that matches REGEXP.
1775 \(The next history element refers to a more recent action.)
1776 With prefix argument N, search for Nth next match.
1777 If N is negative, find the previous or Nth previous match.
1778 Normally, history elements are matched case-insensitively if
1779 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1780 makes the search case-sensitive."
1784 nil
1785 minibuffer-local-map
1786 nil
1787 'minibuffer-history-search-history
1789 ;; Use the last regexp specified, by default, if input is empty.
1794 regexp)
1801 "Function run by `goto-history-element' before consuming default values.
1802 This is useful to dynamically add more elements to the list of default values
1803 when `goto-history-element' reaches the end of this list.
1804 Before calling this function `goto-history-element' sets the variable
1805 `minibuffer-default-add-done' to t, so it will call this function only
1806 once. In special cases, when this function needs to be called more
1807 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1811 "When nil, add more elements to the end of the list of default values.
1812 The value nil causes `goto-history-element' to add more elements to
1813 the list of defaults when it reaches the end of this list. It does
1819 "Return a list of all completions without the default value.
1820 This function is used to add all elements of the completion table to
1821 the end of the list of defaults just after the default value."
1824 minibuffer-completion-table
1825 minibuffer-completion-predicate)))
1831 "Puts element of the minibuffer history in the minibuffer.
1832 The argument NABS specifies the absolute history position."
1846 elt minibuffer-returned-to-present)
1853 "End of defaults; no next item"
1858 previous-history-element))
1870 minibuffer-default)))
1882 elt))
1886 "Puts next element of the minibuffer history in the minibuffer.
1887 With argument N, it uses the Nth following element."
1893 "Puts previous element of the minibuffer history in the minibuffer.
1894 With argument N, it uses the Nth previous element."
1900 "Get next history element which completes the minibuffer before the point.
1901 The contents of the minibuffer after the point are deleted, and replaced
1902 by the new completion."
1908 n)
1909 ;; next-matching-history-element always puts us at (point-min).
1910 ;; Move to the position we were at before changing the buffer contents.
1911 ;; This is still sensible, because the text before point has not changed.
1915 "\
1916 Get previous history element which completes the minibuffer before the point.
1917 The contents of the minibuffer after the point are deleted, and replaced
1918 by the new completion."
1922 ;; For compatibility with the old subr of the same name.
1924 "Return the display width of the minibuffer prompt.
1925 Return 0 if current buffer is not a minibuffer."
1926 ;; Return the width of everything before the field at the end of
1927 ;; the buffer; this should be 0 for normal buffers.
1929 \f
1930 ;; isearch minibuffer history
1937 "Set up a minibuffer for using isearch to search the minibuffer history.
1938 Intended to be added to `minibuffer-setup-hook'."
1950 "Clean up the minibuffer after terminating isearch in the minibuffer."
1955 "Return the proper search function, for isearch in minibuffer history."
1958 ;; Use standard functions to search within minibuffer text
1960 found)
1961 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1962 ;; searching forward. Lazy-highlight calls this lambda with the
1963 ;; bound arg, so skip the minibuffer prompt.
1967 ;; 1. First try searching in the initial minibuffer text
1970 noerror)
1971 ;; 2. If the above search fails, start putting next/prev history
1972 ;; elements in the minibuffer successively, and search the string
1973 ;; in them. Do this only when bound is nil (i.e. not while
1974 ;; lazy-highlighting search strings in the current minibuffer text).
1986 ;; After putting the next/prev history element, search
1987 ;; the string in them again, until next-history-element
1988 ;; or previous-history-element raises an error at the
1989 ;; beginning/end of history.
1992 ;; For backward search, don't search
1993 ;; in the minibuffer prompt
1995 noerror)))
1996 ;; Return point of the new search result
1998 ;; Return nil when next(prev)-history-element fails
2002 "Display the minibuffer history search prompt.
2003 If there are no search errors, this function displays an overlay with
2004 the isearch prompt which replaces the original minibuffer prompt.
2005 Otherwise, it displays the standard isearch message returned from
2006 the function `isearch-message'."
2008 ;; Use standard function `isearch-message' when not in the minibuffer,
2009 ;; or search fails, or has an error (like incomplete regexp).
2010 ;; This function overwrites minibuffer text with isearch message,
2011 ;; so it's possible to see what is wrong in the search string.
2013 ;; Otherwise, put the overlay with the standard isearch prompt over
2014 ;; the initial minibuffer prompt.
2023 ;; And clear any previous isearch message.
2027 "Wrap the minibuffer history search when search fails.
2028 Move point to the first history element for a forward search,
2029 or to the last history element for a backward search."
2030 ;; When `minibuffer-history-isearch-search' fails on reaching the
2031 ;; beginning/end of the history, wrap the search to the first/last
2032 ;; minibuffer history element.
2040 "Save a function restoring the state of minibuffer history search.
2041 Save `minibuffer-history-position' to the additional state parameter
2042 in the search status stack."
2048 "Restore the minibuffer history search state.
2049 Go to the history element by the absolute history position HIST-POS."
2052 \f
2053 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2057 "Table mapping redo records to the corresponding undo one.
2058 A redo record for undo-in-region maps to t.
2068 "Within a run of consecutive undo commands, list remaining to be undone.
2072 "Undo some previous changes.
2073 Repeat this command to undo more changes.
2074 A numeric ARG serves as a repeat count.
2076 In Transient Mark mode when the mark is active, only undo changes within
2078 as an argument limits undo to changes within the current region."
2080 ;; Make last-command indicate for the next command that this was an undo.
2081 ;; That way, another undo will undo more.
2082 ;; If we get to the end of the undo history and get an error,
2083 ;; another undo command will find the undo history empty
2084 ;; and will get another error. To begin undoing the undos,
2085 ;; you must type some other command.
2087 ;; For an indirect buffer, look in the base buffer for the
2088 ;; auto-save data.
2092 message)
2093 ;; If we get an error in undo-start,
2094 ;; the next command should not be a "consecutive undo".
2095 ;; So set `this-command' to something other than `undo'.
2100 ;; If something (a timer or filter?) changed the buffer
2101 ;; since the previous command, don't continue the undo seq.
2105 ;; If the last undo record made was made by undo
2106 ;; it shows nothing else happened in between.
2113 ;; get rid of initial undo boundary
2115 ;; If we got this far, the next command should be a consecutive undo.
2117 ;; Check to see whether we're hitting a redo record, and if
2118 ;; so, ask the user whether she wants to skip the redo/undo pair.
2126 ;; The equiv entry might point to another redo record if we have done
2127 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2135 ;; Record the fact that the just-generated undo records come from an
2136 ;; undo operation--that is, they are redo records.
2137 ;; In the ordinary case (not within a region), map the redo
2138 ;; record to the following undos.
2139 ;; I don't know how to do that in the undo-in-region case.
2141 ;; Strip any leading undo boundaries there might be, like we do
2142 ;; above when checking.
2146 undo-equiv-table))
2147 ;; Don't specify a position in the undo record for the undo command.
2148 ;; Instead, undoing this should move point to where the change is.
2167 ;; Record what the current undo list says,
2168 ;; so the next command can tell if the buffer was modified in between.
2172 ;; Display a message announcing success.
2177 "Make BUFFER stop keeping undo information.
2178 No argument or nil as argument means do this for the current buffer."
2184 "Undo some previous changes.
2185 Repeat this command to undo more changes.
2186 A numeric ARG serves as a repeat count.
2187 Contrary to `undo', this will not redo a previous undo."
2192 "Non-nil while performing an undo.
2196 "Undo back N undo-boundaries beyond what was already undone recently.
2197 Call `undo-start' to get ready to undo recent changes,
2198 then call `undo-more' one or more times to undo them."
2203 ;; Note: The following, while pulling elements off
2204 ;; `pending-undo-list' will call primitive change functions which
2205 ;; will push more elements onto `buffer-undo-list'.
2211 "Undo N records from the front of the list LIST.
2212 Return what remains of the list."
2214 ;; This is a good feature, but would make undo-start
2215 ;; unable to do what is expected.
2216 ;;(when (null (car (list)))
2217 ;; ;; If the head of the list is a boundary, it is the boundary
2218 ;; ;; preceding this command. Get rid of it and don't count it.
2219 ;; (setq list (cdr list))))
2222 ;; In a writable buffer, enable undoing read-only text that is
2223 ;; so because of text properties.
2225 ;; Don't let `intangible' properties interfere with undo.
2227 ;; We use oldlist only to check for EQ. ++kfs
2233 ;; Handle an integer by setting point to that value.
2236 ;; Element (t . TIME) records previous modtime.
2237 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2238 ;; UNKNOWN_MODTIME_NSECS.
2240 ;; If this records an obsolete save
2241 ;; (not matching the actual disk file)
2242 ;; then don't mark unmodified.
2250 ;; Element (nil PROP VAL BEG . END) is property change.
2255 ;; Element (BEG . END) means range was inserted.
2257 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2258 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2261 ;; Set point first thing, so that undoing this undo
2262 ;; does not send point back to where it is now.
2265 ;; Element (apply FUN . ARGS) means call FUN to undo.
2269 ;; Long format: (apply DELTA START END FUN . ARGS).
2276 ;; Check that the function did what the entry
2277 ;; said it would do.
2287 ;; Element (STRING . POS) means STRING was deleted.
2293 ;; Check that marker adjustments which were recorded
2294 ;; with the (STRING . POS) record are still valid, ie
2295 ;; the markers haven't moved. We check their validity
2296 ;; before reinserting the string so as we don't need to
2297 ;; mind marker insertion-type.
2305 ;; Insert string and adjust point
2313 ;; Adjust the valid marker adjustments
2317 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2320 next)
2321 ;; Even though these elements are not expected in the undo
2322 ;; list, adjust them to be conservative for the 24.4
2323 ;; release. (Bug#16818)
2330 ;; Make sure an apply entry produces at least one undo entry,
2331 ;; so the test in `undo' for continuing an undo series
2332 ;; will work right.
2337 list)
2339 ;; Deep copy of a list
2341 "Make a copy of undo list LIST."
2347 elt))
2350 "Set `pending-undo-list' to the front of the undo list.
2351 The next call to `undo-more' will undo the most recently made change.
2352 If BEG and END are specified, then only undo elements
2353 that apply to text between BEG and END are used; other undo elements
2354 are ignored. If BEG and END are nil, all undo elements are used."
2360 buffer-undo-list)))
2363 "Return a list of undo elements for the region START to END.
2364 The elements come from `buffer-undo-list', but we keep only
2365 the elements inside this region, and discard those outside this region.
2366 If we find an element that crosses an edge of this region,
2367 we stop and ignore all further elements."
2370 some-rejected
2371 undo-elt temp-undo-list delta)
2376 ;; This is a "was unmodified" element.
2377 ;; Keep it if we have kept everything thus far.
2379 ;; Skip over marker adjustments, instead relying on
2380 ;; finding them after (TEXT . POS) elements
2382 nil)
2388 ;; Don't put two nils together in the list
2392 ;; If (TEXT . POS), "keep" its subsequent (MARKER
2393 ;; . ADJUSTMENT) whose markers haven't moved.
2413 ;; Loop down the earlier events adjusting their buffer
2414 ;; positions to reflect the fact that a change to the buffer
2415 ;; isn't being undone. We only need to process those element
2416 ;; types which undo-elt-in-region will return as being in
2417 ;; the region since only those types can ever get into the
2418 ;; output
2427 ;; (TEXT . POSITION)
2434 ;; (BEGIN . END)
2439 ;; (nil PROPERTY VALUE BEG . END)
2449 "Determine whether UNDO-ELT falls inside the region START ... END.
2450 If it crosses the edge, we return nil.
2452 Generally this function is not useful for determining
2453 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2454 because markers can be arbitrarily relocated. Instead, pass the
2455 marker adjustment's corresponding (TEXT . POS) element."
2460 t)
2462 nil)
2464 ;; (TEXT . POSITION)
2468 ;; (MARKER . ADJUSTMENT)
2471 ;; (nil PROPERTY VALUE BEG . END)
2476 ;; (BEGIN . END)
2481 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2482 This assumes we have already decided that UNDO-ELT
2483 is not *inside* the region START...END."
2486 ;; (nil PROPERTY VALUE BEG . END)
2491 ;; (BEGIN . END)
2495 ;; Return the first affected buffer position and the delta for an undo element
2496 ;; delta is defined as the change in subsequent buffer positions if we *did*
2497 ;; the undo.
2501 ;; (TEXT . POSITION)
2504 ;; (BEGIN . END)
2511 "If non-nil ask about discarding undo info for the current command.
2512 Normally, Emacs discards the undo info for the current command if
2513 it exceeds `undo-outer-limit'. But if you set this option
2514 non-nil, it asks in the echo area whether to discard the info.
2515 If you answer no, there is a slight risk that Emacs might crash, so
2516 only do it if you really want to undo the command.
2518 This option is mainly intended for debugging. You have to be
2519 careful if you use it for other purposes. Garbage collection is
2520 inhibited while the question is asked, meaning that Emacs might
2521 leak memory. So you should make sure that you do not wait
2522 excessively long before answering the question."
2528 "If non-nil, an extra level of size that's ok in an undo item.
2529 We don't ask the user about truncating the undo list until the
2530 current item gets bigger than this amount.
2535 ;; When the first undo batch in an undo list is longer than
2536 ;; undo-outer-limit, this function gets called to warn the user that
2537 ;; the undo info for the current command was discarded. Garbage
2538 ;; collection is inhibited around the call, so it had better not do a
2539 ;; lot of consing.
2545 ;; Don't ask the question again unless it gets even bigger.
2546 ;; This applies, in particular, if the user quits from the question.
2547 ;; Such a quit quits out of GC, but something else will call GC
2548 ;; again momentarily. It will call this function again,
2549 ;; but we don't want to ask the question again.
2556 t)
2557 nil))
2562 "The undo info was discarded because it exceeded \
2563 `undo-outer-limit'.
2565 This is normal if you executed a command that made a huge change
2566 to the buffer. In that case, to prevent similar problems in the
2567 future, set `undo-outer-limit' to a value that is large enough to
2568 cover the maximum size of normal changes you expect a single
2569 command to make, but not so large that it might exceed the
2570 maximum memory allotted to Emacs.
2572 If you did not execute any such command, the situation is
2573 probably due to a bug and you should report it.
2575 You can disable the popping up of this buffer by adding the entry
2576 \(undo discard-info) to the user option `warning-suppress-types',
2580 t))
2581 \f
2584 ; These are sorted according to the GNU en_US locale.
2627 )
2629 This is used by Shell mode and other parts of Emacs to recognize
2630 password prompts, including prompts in languages other than
2631 English. Different case choices should not be assumed to be
2632 included; callers should bind `case-fold-search' to t."
2638 "History list for some commands that read shell commands.
2640 Maximum length of the history list is determined by the value
2647 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2648 This buffer is used when `shell-command' or `shell-command-on-region'
2649 is run interactively. A value of nil means that output to stderr and
2656 "Return a list of all commands associated with the current file.
2657 This function is used to add all related commands retrieved by `mailcap'
2658 to the end of the list of defaults just after the default value."
2662 minibuffer-default))
2667 commands))
2678 map)
2682 "Read a shell command from the minibuffer.
2683 The arguments are the same as the ones of `read-from-minibuffer',
2684 except READ and KEYMAP are missing and HIST defaults
2685 to `shell-command-history'."
2693 minibuffer-local-shell-command-map
2694 nil
2696 args)))
2699 "What to do when the output buffer is used by another shell command.
2700 This option specifies how to resolve the conflict where a new command
2701 wants to direct its output to the buffer `*Async Shell Command*',
2702 but this buffer is already taken by another running shell command.
2704 The value `confirm-kill-process' is used to ask for confirmation before
2705 killing the already running process and running a new process
2706 in the same buffer, `confirm-new-buffer' for confirmation before running
2707 the command in a new buffer with a name other than the default buffer name,
2708 `new-buffer' for doing the same without confirmation,
2709 `confirm-rename-buffer' for confirmation before renaming the existing
2710 output buffer and running a new command in the default buffer,
2711 `rename-buffer' for doing the same without confirmation."
2713 confirm-kill-process)
2715 confirm-new-buffer)
2717 new-buffer)
2719 confirm-rename-buffer)
2721 rename-buffer))
2726 "Execute string COMMAND asynchronously in background.
2728 Like `shell-command', but adds `&' at the end of COMMAND
2729 to execute it asynchronously.
2731 The output appears in the buffer `*Async Shell Command*'.
2732 That buffer is in shell mode.
2734 You can configure `async-shell-command-buffer' to specify what to do in
2735 case when `*Async Shell Command*' buffer is already taken by another
2736 running shell command. To run COMMAND without displaying the output
2737 in a window you can configure `display-buffer-alist' to use the action
2738 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
2740 In Elisp, you will often be better served by calling `start-process'
2741 directly, since it offers more control and does not impose the use of a
2742 shell (with its need to quote arguments)."
2752 current-prefix-arg
2753 shell-command-default-error-buffer))
2759 "Execute string COMMAND in inferior shell; display output, if any.
2760 With prefix argument, insert the COMMAND's output at point.
2762 If COMMAND ends in `&', execute it asynchronously.
2763 The output appears in the buffer `*Async Shell Command*'.
2764 That buffer is in shell mode. You can also use
2765 `async-shell-command' that automatically adds `&'.
2767 Otherwise, COMMAND is executed synchronously. The output appears in
2768 the buffer `*Shell Command Output*'. If the output is short enough to
2769 display in the echo area (which is determined by the variables
2770 `resize-mini-windows' and `max-mini-window-height'), it is shown
2771 there, but it is nonetheless available in buffer `*Shell Command
2772 Output*' even though that buffer is not automatically displayed.
2774 To specify a coding system for converting non-ASCII characters
2776 before this command.
2778 Noninteractive callers can specify coding systems by binding
2779 `coding-system-for-read' and `coding-system-for-write'.
2781 The optional second argument OUTPUT-BUFFER, if non-nil,
2782 says to put the output in some other buffer.
2783 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2784 If OUTPUT-BUFFER is not a buffer and not nil,
2785 insert output in current buffer. (This cannot be done asynchronously.)
2786 In either case, the buffer is first erased, and the output is
2787 inserted after point (leaving mark after it).
2789 If the command terminates without error, but generates output,
2791 the output can be displayed in the echo area or in its buffer.
2792 If the output is short enough to display in the echo area
2793 \(determined by the variable `max-mini-window-height' if
2794 `resize-mini-windows' is non-nil), it is shown there.
2795 Otherwise,the buffer containing the output is displayed.
2799 of the output.
2801 If there is no output, or if output is inserted in the current buffer,
2802 then `*Shell Command Output*' is deleted.
2804 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2805 or buffer name to which to direct the command's standard error output.
2806 If it is nil, error output is mingled with regular output.
2807 In an interactive call, the variable `shell-command-default-error-buffer'
2808 specifies the value of ERROR-BUFFER.
2810 In Elisp, you will often be better served by calling `call-process' or
2811 `start-process' directly, since it offers more control and does not impose
2812 the use of a shell (with its need to quote arguments)."
2823 current-prefix-arg
2824 shell-command-default-error-buffer))
2825 ;; Look for a handler in case default-directory is a remote file name.
2833 ;; Output goes in current buffer.
2839 temporary-file-directory)))
2840 nil)))
2843 ;; We do not use -f for csh; we will not support broken use of
2844 ;; .cshrcs. Even the BSD csh manual says to use
2845 ;; "if ($?prompt) exit" before things which are not useful
2846 ;; non-interactively. Besides, if someone wants their other
2847 ;; aliases for shell commands then they can still have them.
2851 t)
2852 nil shell-command-switch command)
2859 ;; Do no formatting while reading error file,
2860 ;; because that can run a shell command, and we
2861 ;; don't want that to cause an infinite recursion.
2863 ;; Put point after the inserted errors.
2867 ;; This is like exchange-point-and-mark, but doesn't
2868 ;; activate the mark. It is cleaner to avoid activation,
2869 ;; even though the command loop would deactivate the mark
2870 ;; because we inserted text.
2874 ;; Output goes in a separate buffer.
2875 ;; Preserve the match data in case called from a program.
2878 ;; Command ending with ampersand means asynchronous.
2882 proc)
2883 ;; Remove the ampersand.
2885 ;; Ask the user what to do with already running process.
2890 ;; If will kill a process, query first.
2895 ;; If will create a new buffer, query first.
2901 ;; It will create a new buffer.
2905 ;; If will rename the buffer, query first.
2914 ;; It will rename the buffer.
2921 ;; Setting buffer-read-only to nil doesn't suffice
2922 ;; if some text has a non-nil read-only property,
2923 ;; which comint sometimes adds for prompts.
2929 shell-command-switch command))
2933 ;; Use the comint filter for proper handling of carriage motion
2934 ;; (see `comint-inhibit-carriage-motion'),.
2936 ))
2937 ;; Otherwise, command is executed synchronously.
2939 output-buffer nil error-buffer)))))))
2943 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2944 MESSAGE may be either a string or a buffer.
2946 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2947 the maximum height of the echo area, as defined by `max-mini-window-height'
2948 if `resize-mini-windows' is non-nil.
2950 Returns either the string shown in the echo area, or when a pop-up
2951 buffer is used, the window used to display it.
2953 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2954 name of the buffer used to display it in the case where a pop-up buffer
2955 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2956 string and it is displayed in the echo area, it is not specified whether
2957 the contents are inserted into the buffer anyway.
2959 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2960 and only used if a buffer is displayed."
2962 ;; Trivial case where we can use the echo area
2966 ;; Trivial case where we can just remove single trailing newline
2969 ;; General case
2972 message
2981 0
2985 (<= lines
2989 max-mini-window-height))
2991 max-mini-window-height)
2995 ;; Don't use the echo area if the output buffer is
2996 ;; already displayed in the selected frame.
2998 ;; Echo area
3004 ;; Buffer
3007 not-this-window frame))))))))
3010 ;; We have a sentinel to prevent insertion of a termination message
3011 ;; in the buffer itself.
3019 &optional output-buffer replace
3020 error-buffer display-error-buffer)
3021 "Execute string COMMAND in inferior shell with region as input.
3022 Normally display output (if any) in temp buffer `*Shell Command Output*';
3023 Prefix arg means replace the region with it. Return the exit code of
3024 COMMAND.
3026 To specify a coding system for converting non-ASCII characters
3028 before this command. By default, the input (from the current buffer)
3029 is encoded using coding-system specified by `process-coding-system-alist',
3030 falling back to `default-process-coding-system' if no match for COMMAND
3031 is found in `process-coding-system-alist'.
3033 Noninteractive callers can specify coding systems by binding
3034 `coding-system-for-read' and `coding-system-for-write'.
3036 If the command generates output, the output may be displayed
3037 in the echo area or in a buffer.
3038 If the output is short enough to display in the echo area
3039 \(determined by the variable `max-mini-window-height' if
3040 `resize-mini-windows' is non-nil), it is shown there.
3041 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3042 The output is available in that buffer in both cases.
3044 If there is output and an error, a message about the error
3045 appears at the end of the output. If there is no output, or if
3046 output is inserted in the current buffer, the buffer `*Shell
3047 Command Output*' is deleted.
3049 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3050 command's output. If the value is a buffer or buffer name,
3051 put the output there. If the value is nil, use the buffer
3052 `*Shell Command Output*'. Any other value, excluding nil,
3053 means to insert the output in the current buffer. In either case,
3054 the output is inserted after point (leaving mark after it).
3056 Optional fifth arg REPLACE, if non-nil, means to insert the
3057 output in place of text from START to END, putting point and mark
3058 around it.
3060 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3061 or buffer name to which to direct the command's standard error
3062 output. If nil, error output is mingled with regular output.
3063 When called interactively, `shell-command-default-error-buffer'
3064 is used for ERROR-BUFFER.
3066 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3067 display the error buffer if there were any errors. When called
3068 interactively, this is t."
3072 ;; Do this before calling region-beginning
3073 ;; and region-end, in case subprocess output
3074 ;; relocates them while we are in the minibuffer.
3076 ;; call-interactively recognizes region-beginning and
3077 ;; region-end specially, leaving them in the history.
3079 string
3080 current-prefix-arg
3081 current-prefix-arg
3082 shell-command-default-error-buffer
3083 t)))
3089 temporary-file-directory)))
3090 nil))
3091 exit-status)
3095 ;; Replace specified region with output from command.
3097 ;; Don't muck with mark unless REPLACE says we should.
3104 t)
3105 nil shell-command-switch command))
3106 ;; It is rude to delete a buffer which the command is not using.
3107 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3108 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3109 ;; (kill-buffer shell-buffer)))
3110 ;; Don't muck with mark unless REPLACE says we should.
3112 ;; No prefix argument: put the output in a temp buffer,
3113 ;; replacing its entire contents.
3118 ;; If the input is the same buffer as the output,
3119 ;; delete everything but the specified region,
3120 ;; then replace that region with the output.
3126 shell-file-name t
3129 t)
3130 nil shell-command-switch
3131 command)))
3132 ;; Clear the output buffer, then run the command with
3133 ;; output there.
3144 buffer)
3145 nil shell-command-switch command)))
3146 ;; Report the output.
3156 ;; There's some output, display it
3158 ;; No output; error?
3165 shell-command-default-error-buffer)
3172 output))
3175 exit-status))
3178 exit-status output))))
3179 ;; Don't kill: there might be useful info in the undo-log.
3180 ;; (kill-buffer buffer)
3181 ))))
3189 ;; Do no formatting while reading error file,
3190 ;; because that can run a shell command, and we
3191 ;; don't want that to cause an infinite recursion.
3193 ;; Put point after the inserted errors.
3198 exit-status))
3201 "Execute shell command COMMAND and return its output as a string."
3204 standard-output
3208 "Process files synchronously in a separate process.
3209 Similar to `call-process', but may invoke a file handler based on
3210 `default-directory'. The current working directory of the
3211 subprocess is `default-directory'.
3213 File names in INFILE and BUFFER are handled normally, but file
3214 names in ARGS should be relative to `default-directory', as they
3215 are passed to the process verbatim. (This is a difference to
3216 `call-process' which does not support file handlers for INFILE
3217 and BUFFER.)
3219 Some file handlers might not support all variants, for example
3220 they might behave as if DISPLAY was nil, regardless of the actual
3221 value passed."
3223 lc stderr-file)
3233 display args)
3239 "Whether a call of `process-file' changes remote files.
3241 By default, this variable is always set to `t', meaning that a
3242 call of `process-file' could potentially change any file on a
3243 remote host. When set to `nil', a file handler could optimize
3244 its behavior with respect to remote file attribute caching.
3246 You should only ever change this variable with a let-binding;
3250 "Start a program in a subprocess. Return the process object for it.
3252 Similar to `start-process', but may invoke a file handler based on
3253 `default-directory'. See Info node `(elisp)Magic File Names'.
3255 This handler ought to run PROGRAM, perhaps on the local host,
3256 perhaps on a remote host that corresponds to `default-directory'.
3257 In the latter case, the local part of `default-directory' becomes
3258 the working directory of the process.
3260 PROGRAM and PROGRAM-ARGS might be file names. They are not
3261 objects of file handler invocation. File handlers might not
3262 support pty association, if PROGRAM is nil."
3266 \f
3267 ;;;; Process menu
3281 map))
3284 "Major mode for listing the processes called by Emacs."
3296 "Kill process at point in a `list-processes' buffer."
3302 "Recompute the list of processes for the Process List buffer.
3303 Also, delete any process that is exited or signaled."
3316 face link
3319 follow-link t
3320 process-buffer ,buf
3321 action process-menu-visit-buffer)
3330 "datagram"
3347 tabulated-list-entries))))))
3353 "Display a list of all processes that are Emacs sub-processes.
3354 If optional argument QUERY-ONLY is non-nil, only processes with
3355 the query-on-exit flag set are listed.
3356 Any process listed as exited or signaled is actually eliminated
3357 after the listing is made.
3358 Optional argument BUFFER specifies a buffer to use, instead of
3360 The return value is always nil.
3362 This function lists only processes that were launched by Emacs. To
3363 see other processes running on the system, use `list-system-processes'."
3375 nil)
3376 \f
3380 ;; For backward compatibility, minus with no modifiers is an ordinary
3381 ;; command if digits have already been entered.
3411 map)
3418 "Begin a numeric argument for the following command.
3423 multiplies the argument by 4 each time.
3425 which is different in effect from any particular numeric argument.
3432 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3433 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3439 arg)))
3443 "Begin a negative numeric argument for the next command.
3452 "Part of the numeric argument for the next command.
3456 last-command-event
3463 ;; Treat -0 as just -, so that -01 will work.
3466 digit))))
3468 \f
3476 "Function to perform the filtering in `filter-buffer-substring'.
3477 The function is called with 3 arguments:
3478 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
3479 as those of `filter-buffer-substring' in each case.
3483 "List of filter functions for `filter-buffer-substring'.
3484 Each function must accept a single argument, a string, and return
3485 a string. The buffer substring is passed to the first function
3486 in the list, and the return value of each function is passed to
3487 the next.
3488 As a special convention, point is set to the start of the buffer text
3489 being operated on (i.e., the first argument of `filter-buffer-substring')
3495 "Return the buffer substring between BEG and END, after filtering.
3496 The hook `filter-buffer-substring-function' performs the actual filtering.
3497 By default, no filtering is done.
3499 If DELETE is non-nil, the text between BEG and END is deleted
3500 from the buffer.
3502 This function should be used instead of `buffer-substring',
3503 `buffer-substring-no-properties', or `delete-and-extract-region'
3504 when you want to allow filtering to take place. For example,
3505 major or minor modes can use `filter-buffer-substring-function' to
3506 extract characters that are special to a buffer, and should not
3507 be copied into other buffers."
3520 string)))
3525 ;;;; Window system cut and paste hooks.
3528 "Function to call to make a killed region available to other programs.
3529 Most window systems provide a facility for cutting and pasting
3530 text between different programs, such as the clipboard on X and
3531 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3533 This variable holds a function that Emacs calls whenever text is
3534 put in the kill ring, to make the new kill available to other
3535 programs. The function takes one argument, TEXT, which is a
3539 "Function to call to get text cut from 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 to obtain text
3545 that other programs have provided for pasting. The function is
3546 called with no arguments. If no other program has provided text
3547 to paste, the function should return nil (in which case the
3548 caller, usually `current-kill', should use the top of the Emacs
3549 kill ring). If another program has provided text to paste, the
3550 function should return that text as a string (in which case the
3551 caller should put this string in the kill ring as the latest
3552 kill).
3554 The function may also return a list of strings if the window
3555 system supports multiple selections. The first string will be
3556 used as the pasted text, but the other will be placed in the kill
3557 ring for easy access via `yank-pop'.
3559 Note that the function should return a string only if a program
3560 other than Emacs has provided a string for pasting; if Emacs
3561 provided the most recent string, the function should return nil.
3562 If it is difficult to tell whether Emacs or some other program
3563 provided the current string, it is probably good enough to return
3564 nil if the string is equal (according to `string=') to the last
3566 \f
3569 ;;;; The kill ring data structure.
3572 "List of killed text sequences.
3573 Since the kill ring is supposed to interact nicely with cut-and-paste
3574 facilities offered by window systems, use of this variable should
3575 interact nicely with `interprogram-cut-function' and
3576 `interprogram-paste-function'. The functions `kill-new',
3577 `kill-append', and `current-kill' are supposed to implement this
3578 interaction; you may want to use them instead of manipulating the kill
3582 "Maximum length of kill ring before oldest elements are thrown away."
3590 "Save clipboard strings into kill ring before replacing them.
3591 When one selects something in another program to paste it into Emacs,
3592 but kills something in Emacs before actually pasting it,
3593 this selection is gone unless this variable is non-nil,
3594 in which case the other program's selection is saved in the `kill-ring'
3601 "Do not add a new string to `kill-ring' if it duplicates the last one.
3602 The comparison is done using `equal-including-properties'."
3608 "Make STRING the latest kill in the kill ring.
3609 Set `kill-ring-yank-pointer' to point to it.
3610 If `interprogram-cut-function' is non-nil, apply it to STRING.
3611 Optional second argument REPLACE non-nil means that STRING will replace
3612 the front of the kill ring, rather than being added to the list.
3614 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3615 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3616 STRING.
3618 When the yank handler has a non-nil PARAM element, the original STRING
3619 argument is not used by `insert-for-yank'. However, since Lisp code
3620 may access and use elements from the kill ring directly, the STRING
3623 ;; Due to text properties such as 'yank-handler that
3624 ;; can alter the contents to yank, comparison using
3625 ;; `equal' is unsafe.
3651 "Append STRING to the end of the latest kill in the kill ring.
3652 If BEFORE-P is non-nil, prepend STRING to the kill.
3653 If `interprogram-cut-function' is set, pass the resulting kill to it."
3660 "Whether rotating the kill ring changes the window system selection.
3661 If non-nil, whenever the kill ring is rotated (usually via the
3662 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3663 to copy the new kill to the window system selection."
3669 "Rotate the yanking point by N places, and then return that kill.
3670 If N is zero and `interprogram-paste-function' is set to a
3671 function that returns a string or a list of strings, and if that
3672 function doesn't return nil, then that string (or list) is added
3673 to the front of the kill ring and the string (or first string in
3674 the list) is returned as the latest kill.
3676 If N is not zero, and if `yank-pop-change-selection' is
3677 non-nil, use `interprogram-cut-function' to transfer the
3678 kill at the new yank point into the window system selection.
3680 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3681 move the yanking point; just return the Nth kill forward."
3684 interprogram-paste-function
3688 ;; Disable the interprogram cut function when we add the new
3689 ;; text to the kill ring, so Emacs doesn't try to own the
3690 ;; selection, with identical text.
3700 kill-ring)))
3705 interprogram-cut-function)
3711 ;;;; Commands for manipulating the kill ring.
3714 "Non-nil means don't signal an error for killing read-only text."
3720 This deletes the text from the buffer and saves it in the kill ring.
3724 If you want to append the killed region to the last killed text,
3727 If the buffer is read-only, Emacs will beep and refrain from deleting
3728 the text, but put the text in the kill ring anyway. This means that
3729 you can use the killing commands to copy text from a read-only buffer.
3731 Lisp programs should use this function for killing text.
3732 (To delete text, use `delete-region'.)
3733 Supply two arguments, character positions indicating the stretch of text
3734 to be killed.
3736 If the previous command was also a kill command,
3737 the text killed this time appends to the text killed last time
3738 to make one entry in the kill ring.
3740 The optional argument REGION if non-nil, indicates that we're not just killing
3741 some text between BEG and END, but we're killing the region."
3742 ;; Pass mark first, then point, because the order matters when
3743 ;; calling `kill-append'.
3752 ;; Add that string to the kill ring, one way or another.
3759 nil)
3761 ;; The code above failed because the buffer, or some of the characters
3762 ;; in the region, are read-only.
3763 ;; We should beep, in case the user just isn't aware of this.
3764 ;; However, there's no harm in putting
3765 ;; the region's text in the kill ring, anyway.
3767 ;; Set this-command now, so it will be set even if we get an error.
3769 ;; This should barf, if appropriate, and give us the correct error.
3772 ;; Signal an error if the buffer is read-only.
3774 ;; If the buffer isn't read-only, the text is.
3777 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3778 ;; to get two copies of the text when the user accidentally types M-w and
3779 ;; then corrects it with the intended C-w.
3781 "Save the region as if killed, but don't kill it.
3782 In Transient Mark mode, deactivate the mark.
3783 If `interprogram-cut-function' is non-nil, also save the text for a window
3784 system cut and paste.
3786 The optional argument REGION if non-nil, indicates that we're not just copying
3787 some text between BEG and END, but we're copying the region.
3789 This command's old key binding has been given to `kill-ring-save'."
3790 ;; Pass mark first, then point, because the order matters when
3791 ;; calling `kill-append'.
3801 nil)
3804 "Save the region as if killed, but don't kill it.
3805 In Transient Mark mode, deactivate the mark.
3806 If `interprogram-cut-function' is non-nil, also save the text for a window
3807 system cut and paste.
3809 If you want to append the killed line to the last killed text,
3812 The optional argument REGION if non-nil, indicates that we're not just copying
3813 some text between BEG and END, but we're copying the region.
3815 This command is similar to `copy-region-as-kill', except that it gives
3816 visual feedback indicating the extent of the region being copied."
3817 ;; Pass mark first, then point, because the order matters when
3818 ;; calling `kill-append'.
3822 ;; This use of called-interactively-p is correct because the code it
3823 ;; controls just gives the user visual feedback.
3828 "Indicate that the region text has been copied interactively.
3829 If the mark is visible in the selected window, blink the cursor
3830 between point and mark if there is currently no active region
3831 highlighting.
3833 If the mark lies outside the selected window, display an
3834 informative message containing a sample of the copied text. The
3835 optional argument MESSAGE-LEN, if non-nil, specifies the length
3836 of this sample text; it defaults to 40."
3839 ;; Inhibit quitting so we can make a quit here
3840 ;; look like a C-g typed as a command.
3843 ;; Swap point-and-mark quickly so as to show the region that
3844 ;; was selected. Don't do it if the region is highlighted.
3847 ;; Swap point and mark.
3851 ;; Swap back.
3854 ;; If user quit, deactivate the mark
3855 ;; as C-g would as a command.
3861 ;; Don't say "killed"; that is misleading.
3868 "Cause following command, if it kills, to add to previous kill.
3869 If the next command kills forward from point, the kill is
3870 appended to the previous killed text. If the command kills
3871 backward, the kill is prepended. Kill commands that act on the
3872 region, such as `kill-region', are regarded as killing forward if
3873 point is after mark, and killing backward if point is before
3874 mark.
3876 If the next command is not a kill command, `append-next-kill' has
3877 no effect.
3879 The argument is used for internal purposes; do not supply one."
3881 ;; We don't use (interactive-p), since that breaks kbd macros.
3887 \f
3888 ;; Yanking.
3893 "List of special text property handling conditions for yanking.
3894 Each element should have the form (PROP . FUN), where PROP is a
3895 property symbol and FUN is a function. When the `yank' command
3896 inserts text into the buffer, it scans the inserted text for
3897 stretches of text that have `eq' values of the text property
3898 PROP; for each such stretch of text, FUN is called with three
3899 arguments: the property's value in that text, and the start and
3900 end positions of the text.
3902 This is done prior to removing the properties specified by
3903 `yank-excluded-properties'."
3906 function))
3909 ;; This is actually used in subr.el but defcustom does not work there.
3912 intangible invisible keymap local-map mouse-face read-only
3913 yank-handler)
3914 "Text properties to discard when yanking.
3915 The value should be a list of text properties to discard or t,
3916 which means to discard all text properties.
3918 See also `yank-handled-properties'."
3925 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3926 Function is called with two parameters, START and END corresponding to
3927 the value of the mark and point; it is guaranteed that START <= END.
3931 "Replace just-yanked stretch of killed text with a different stretch.
3932 This command is allowed only immediately after a `yank' or a `yank-pop'.
3933 At such a time, the region contains a stretch of reinserted
3934 previously-killed text. `yank-pop' deletes that text and inserts in its
3935 place a different stretch of killed text.
3937 With no argument, the previous kill is inserted.
3938 With argument N, insert the Nth previous kill.
3939 If N is negative, this is a more recent kill.
3941 The sequence of kills wraps around, so that after the oldest one
3942 comes the newest one.
3944 When this command inserts killed text into the buffer, it honors
3945 `yank-excluded-properties' and `yank-handler' as described in the
3946 doc string for `insert-for-yank-1', which see."
3960 ;; Set the window start back where it was in the yank command,
3961 ;; if possible.
3964 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3965 ;; It is cleaner to avoid activation, even though the command
3966 ;; loop would deactivate the mark because we inserted text.
3969 nil)
3973 More precisely, reinsert the most recent kill, which is the
3974 stretch of killed text most recently killed OR yanked. Put point
3975 at the end, and set mark at the beginning without activating it.
3977 With argument N, reinsert the Nth most recent kill.
3979 When this command inserts text into the buffer, it honors the
3980 `yank-handled-properties' and `yank-excluded-properties'
3981 variables, and the `yank-handler' text property. See
3982 `insert-for-yank-1' for details.
3987 ;; If we don't get all the way thru, make last-command indicate that
3988 ;; for the following command.
3996 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3997 ;; It is cleaner to avoid activation, even though the command
3998 ;; loop would deactivate the mark because we inserted text.
4001 ;; If we do get all the way thru, make this-command indicate that.
4004 nil)
4007 "Rotate the yanking point in the kill ring.
4008 With ARG, rotate that many kills forward (or backward, if negative)."
4011 \f
4012 ;; Some kill commands.
4014 ;; Internal subroutine of delete-char
4020 ;; Internal subroutine of backward-delete-char
4027 "The method for untabifying when deleting backward.
4028 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4029 `hungry' -- delete all whitespace, both tabs and spaces;
4030 `all' -- delete all whitespace, including tabs, spaces and newlines;
4031 nil -- just delete one character."
4037 "Delete characters backward, changing tabs into spaces.
4038 The exact behavior depends on `backward-delete-char-untabify-method'.
4039 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4040 Interactively, ARG is the prefix arg (default 1)
4041 and KILLP is t if a prefix arg was specified."
4064 arg)))
4065 ;; Avoid warning about delete-backward-char
4069 "Kill up to and including ARGth occurrence of CHAR.
4070 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4071 Goes backward if ARG is negative; error if CHAR not found."
4074 ;; Avoid "obsolete" warnings for translation-table-for-input.
4082 ;; kill-line and its subroutines.
4085 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4090 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4091 With prefix argument ARG, kill that many lines from point.
4092 Negative arguments kill lines backward.
4093 With zero argument, kills the text before point on the current line.
4096 a number counts as a prefix arg.
4098 To kill a whole line, when point is not at the beginning, type \
4101 If `show-trailing-whitespace' is non-nil, this command will just
4102 kill the rest of the current line, even if there are only
4103 nonblanks there.
4105 If option `kill-whole-line' is non-nil, then this command kills the whole line
4106 including its terminating newline, when used at the beginning of a line
4107 with no argument. As a consequence, you can always kill a whole line
4110 If you want to append the killed line to the last killed text,
4113 If the buffer is read-only, Emacs will beep and refrain from deleting
4114 the line, but put the line in the kill ring anyway. This means that
4115 you can use this command to copy text from a read-only buffer.
4116 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4117 even beep.)"
4120 ;; It is better to move point to the other end of the kill
4121 ;; before killing. That way, in a read-only buffer, point
4122 ;; moves across the text that is copied to the kill ring.
4123 ;; The choice has no effect on undo now that undo records
4124 ;; the value of point from before the command was run.
4134 ;; If trailing whitespace is visible,
4135 ;; don't treat it as nothing.
4145 "Kill current line.
4146 With prefix ARG, kill that many lines starting from the current line.
4147 If ARG is negative, kill backward. Also kill the preceding newline.
4149 If ARG is zero, kill current line but exclude the trailing newline."
4160 ;; We need to kill in two steps, because the previous command
4161 ;; could have been a kill command, in which case the text
4162 ;; before point needs to be prepended to the current kill
4163 ;; ring entry and the text after point appended. Also, we
4164 ;; need to use save-excursion to avoid copying the same text
4165 ;; twice to the kill ring in read-only buffers.
4183 "Move forward by ARG lines, ignoring currently invisible newlines only.
4184 If ARG is negative, move backward -ARG lines.
4185 If ARG is zero, move to the beginning of the current line."
4192 ;; If the newline we just skipped is invisible,
4193 ;; don't count it.
4197 prop
4202 ;; If invisible text follows, and it is a number of complete lines,
4203 ;; skip it.
4209 prop
4225 ;; If the newline we just moved to is invisible,
4226 ;; don't count it.
4231 prop
4236 ;; If invisible text follows, and it is a number of complete lines,
4237 ;; skip it.
4243 prop
4254 nil)))
4257 "Move to end of current visible line."
4259 ;; If the following character is currently invisible,
4260 ;; skip all characters with that same `invisible' property value,
4261 ;; then find the next newline.
4268 prop
4277 \f
4279 "Insert after point the contents of BUFFER.
4280 Puts mark after the inserted text.
4281 BUFFER may be a buffer or a buffer name."
4291 t))))
4296 nil)
4299 "Append to specified buffer the text of the region.
4300 It is inserted into that buffer before its point.
4302 When calling from a program, give three arguments:
4303 BUFFER (or buffer name), START and END.
4304 START and END specify the portion of the current buffer to be copied."
4311 point)
4322 "Prepend to specified buffer the text of the region.
4323 It is inserted into that buffer after its point.
4325 When calling from a program, give three arguments:
4326 BUFFER (or buffer name), START and END.
4327 START and END specify the portion of the current buffer to be copied."
4336 "Copy to specified buffer the text of the region.
4337 It is inserted into that buffer, replacing existing text there.
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."
4349 \f
4353 "Hook run when the mark becomes active.
4354 It is also run at the end of a command, if the mark is active and
4361 "Return this buffer's mark value as integer, or nil if never set.
4363 In Transient Mark mode, this function signals an error if
4364 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4365 or the argument FORCE is non-nil, it disregards whether the mark
4366 is active, and returns an integer or nil in the usual way.
4368 If you are using this in an editing command, you are most likely making
4369 a mistake; see the documentation of `set-mark'."
4374 ;; Behind display-selections-p.
4381 "Deactivate the mark.
4382 If Transient Mark mode is disabled, this function normally does
4383 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4385 Deactivating the mark sets `mark-active' to nil, updates the
4386 primary selection according to `select-active-regions', and runs
4387 `deactivate-mark-hook'.
4389 If Transient Mark mode was temporarily enabled, reset the value
4390 of the variable `transient-mark-mode'; if this causes Transient
4391 Mark mode to be disabled, don't change `mark-active' to nil or
4392 run `deactivate-mark-hook'."
4396 select-active-regions)
4399 ;; The var `saved-region-selection', if non-nil, is the text in
4400 ;; the region prior to the last command modifying the buffer.
4401 ;; Set the selection to that, or to the current region.
4405 ;; If another program has acquired the selection, region
4406 ;; deactivation should not clobber it (Bug#11772).
4417 ;; When deactivating a temporary region, don't change
4418 ;; `mark-active' or run `deactivate-mark-hook'.
4427 "Activate the mark.
4428 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
4438 "Set this buffer's mark to POS. Don't use this function!
4439 That is to say, don't use this function unless you want
4440 the user to see that the mark has moved, and you want the previous
4441 mark position to be lost.
4443 Normally, when a new mark is set, the old one should go on the stack.
4444 This is why most applications should use `push-mark', not `set-mark'.
4446 Novice Emacs Lisp programmers often try to use the mark for the wrong
4447 purposes. The mark saves a location for the user's convenience.
4448 Most editing commands should not alter the mark.
4449 To remember a location for internal use in the Lisp program,
4450 store it in a Lisp variable. Example:
4452 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4457 ;; Normally we never clear mark-active except in Transient Mark mode.
4458 ;; But when we actually clear out the mark value too, we must
4459 ;; clear mark-active in any mode.
4461 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
4462 ;; it should never be nil if the mark is nil.
4468 If nil, region-aware commands treat empty regions as inactive.
4469 If non-nil, region-aware commands treat the region as active as
4470 long as the mark is active, even if the region is empty.
4472 Region-aware commands are those that act on the region if it is
4473 active and Transient Mark mode is enabled, and on the text near
4474 point otherwise."
4480 "Return t if the region is active and it is appropriate to act on it.
4481 This is used by commands that act specially on the region under
4482 Transient Mark mode.
4484 The return value is t if Transient Mark mode is enabled and the
4485 mark is active; furthermore, if `use-empty-active-region' is nil,
4486 the region must not be empty. Otherwise, the return value is nil.
4488 For some commands, it may be appropriate to ignore the value of
4489 `use-empty-active-region'; in that case, use `region-active-p'."
4494 "Return t if Transient Mark mode is enabled and the mark is active.
4496 Some commands act specially on the region when Transient Mark
4497 mode is enabled. Usually, such commands should use
4498 `use-region-p' instead of this function, because `use-region-p'
4499 also checks the value of `use-empty-active-region'."
4513 ;; Normal priority so that a large region doesn't hide all the
4514 ;; overlays within it, but high secondary priority so that if it
4515 ;; ends/starts in the middle of a small overlay, that small overlay
4516 ;; won't hide the region's boundaries.
4518 nrol)
4523 rol)))
4536 start end window rol)))
4539 new)))))))
4564 "Maximum size of mark ring. Start discarding off end if gets this big."
4572 "Maximum size of global mark ring. \
4573 Start discarding off end if gets this big."
4578 "Jump to mark, and pop a new position for mark off the ring.
4579 \(Does not affect global mark ring)."
4589 "Set mark at where point is.
4590 If no prefix ARG and mark is already set there, just activate it.
4591 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4603 will pop the mark twice, and
4605 will pop the mark three times.
4613 "Set the mark where point is, or jump to the mark.
4614 Setting the mark also alters the region, which is the text
4615 between point and mark; this is the closest equivalent in
4618 With no prefix argument, set the mark at point, and push the
4619 old mark position on local mark ring. Also push the old mark on
4620 global mark ring, if the previous mark was set in another buffer.
4622 When Transient Mark Mode is off, immediately repeating this
4623 command activates `transient-mark-mode' temporarily.
4626 jump to the mark, and set the mark from
4627 position popped off the local mark ring (this does not affect the global
4629 mark ring (see `pop-global-mark').
4631 If `set-mark-command-repeat-pop' is non-nil, repeating
4633 off the local (or global) mark ring and jumps there.
4636 argument, unconditionally set mark where point is, even if
4637 `set-mark-command-repeat-pop' is non-nil.
4639 Novice Emacs Lisp programmers often try to use the mark for the wrong
4640 purposes. See the documentation of `set-mark' for more information."
4676 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4677 If the last global mark pushed was not in the current buffer,
4678 also push LOCATION on the global mark ring.
4679 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4681 Novice Emacs Lisp programmers often try to use the mark for the wrong
4682 purposes. See the documentation of `set-mark' for more information.
4684 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4691 ;; Now push the mark on the global mark ring.
4694 ;; The last global mark pushed was in this same buffer.
4695 ;; Don't push another one.
4696 nil
4705 nil)
4708 "Pop off mark ring into the buffer's actual mark.
4709 Does not set point. Does nothing if mark ring is empty."
4721 "Put the mark where point is now, and point where the mark is now.
4722 This command works even when the mark is not active,
4723 and it reactivates the mark.
4725 If Transient Mark mode is on, a prefix ARG deactivates the mark
4726 if it is active, and otherwise avoids reactivating it. If
4727 Transient Mark mode is off, a prefix ARG enables Transient Mark
4728 mode temporarily."
4742 nil))
4745 "When non-nil, shifted motion keys activate the mark momentarily.
4747 While the mark is activated in this way, any shift-translated point
4748 motion key extends the region, and if Transient Mark mode was off, it
4749 is temporarily turned on. Furthermore, the mark will be deactivated
4750 by any subsequent point motion key that was not shift-translated, or
4751 by any action that normally deactivates the mark in Transient Mark mode.
4753 See `this-command-keys-shift-translated' for the meaning of
4754 shift-translation."
4759 "Activate/deactivate mark depending on invocation thru shift translation.
4760 This function is called by `call-interactively' when a command
4761 with a `^' character in its `interactive' spec is invoked, before
4762 running the command itself.
4764 If `shift-select-mode' is enabled and the command was invoked
4765 through shift translation, set the mark and activate the region
4766 temporarily, unless it was already set in this way. See
4767 `this-command-keys-shift-translated' for the meaning of shift
4768 translation.
4770 Otherwise, if the region has been activated temporarily,
4771 deactivate it, and restore the variable `transient-mark-mode' to
4772 its earlier value."
4779 transient-mark-mode)))
4786 "Toggle Transient Mark mode.
4787 With a prefix argument ARG, enable Transient Mark mode if ARG is
4788 positive, and disable it otherwise. If called from Lisp, enable
4789 Transient Mark mode if ARG is omitted or nil.
4791 Transient Mark mode is a global minor mode. When enabled, the
4792 region is highlighted whenever the mark is active. The mark is
4794 operations that set the mark but whose main purpose is something
4800 Many commands change their behavior when Transient Mark mode is
4801 in effect and the mark is active, by acting on the region instead
4802 of their usual default part of the buffer's text. Examples of
4805 To see the documentation of commands which are sensitive to the
4808 :global t
4809 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4813 "Non-nil means it is ok for commands to call `widen' when they want to.
4814 Some commands will do this in order to go to positions outside
4815 the current accessible part of the buffer.
4817 If `widen-automatically' is nil, these commands will do something else
4821 "Whether the currently executing code is performing an essential task.
4822 This variable should be non-nil only when running code which should not
4823 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4824 user for a password when we are simply scanning a set of files in the
4825 background or displaying possible completions before the user even asked
4829 "Pop off global mark ring and jump to the top location."
4831 ;; Pop entries which refer to non-existent buffers.
4849 \f
4851 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4857 "Move cursor vertically down ARG lines.
4858 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4859 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4860 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4861 function will not vscroll.
4863 ARG defaults to 1.
4865 If there is no character in the target line exactly under the current column,
4866 the cursor is positioned after the character in that line which spans this
4867 column, or at the end of the line if it is not long enough.
4868 If there is no line in the buffer after this one, behavior depends on the
4869 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4870 to create a line, and moves the cursor to that line. Otherwise it moves the
4871 cursor to the end of the buffer.
4873 If the variable `line-move-visual' is non-nil, this command moves
4874 by display lines. Otherwise, it moves by buffer lines, without
4875 taking variable-width characters or continued lines into account.
4878 a semipermanent goal column for this command.
4879 Then instead of trying to move exactly vertically (or as close as possible),
4880 this command moves to the specified goal column (or as close as possible).
4881 The goal column is stored in the variable `goal-column', which is nil
4882 when there is no goal column. Note that setting `goal-column'
4883 overrides `line-move-visual' and causes this command to move by buffer
4884 lines rather than by display lines."
4890 ;; When adding a newline, don't expand an abbrev.
4901 nil)
4904 "Move cursor vertically up ARG lines.
4905 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4906 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4907 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4908 function will not vscroll.
4910 ARG defaults to 1.
4912 If there is no character in the target line exactly over the current column,
4913 the cursor is positioned after the character in that line which spans this
4914 column, or at the end of the line if it is not long enough.
4916 If the variable `line-move-visual' is non-nil, this command moves
4917 by display lines. Otherwise, it moves by buffer lines, without
4918 taking variable-width characters or continued lines into account.
4921 a semipermanent goal column for this command.
4922 Then instead of trying to move exactly vertically (or as close as possible),
4923 this command moves to the specified goal column (or as close as possible).
4924 The goal column is stored in the variable `goal-column', which is nil
4925 when there is no goal column. Note that setting `goal-column'
4926 overrides `line-move-visual' and causes this command to move by buffer
4927 lines rather than by display lines."
4938 nil)
4941 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4942 This means moving to the end of each line moved onto.
4943 The beginning of a blank line does not count as the end of a line.
4944 This has no effect when the variable `line-move-visual' is non-nil."
4950 A non-nil setting overrides the variable `line-move-visual', which see."
4957 "Current goal column for vertical motion.
4958 It is the column where point was at the start of the current run
4959 of vertical motion commands.
4961 When moving by visual lines via the function `line-move-visual', it is a cons
4962 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4963 divided by the default column width, and HSCROLL is the number of
4964 columns by which window is scrolled from left margin.
4966 When the `track-eol' feature is doing its job, the value is
4971 Outline mode sets this."
4976 "When non-nil, `line-move' moves point by visual lines.
4977 This movement is based on where the cursor is displayed on the
4978 screen, instead of relying on buffer contents alone. It takes
4979 into account variable-width characters and line continuation.
4980 If nil, `line-move' moves point by logical lines.
4981 A non-nil setting of `goal-column' overrides the value of this variable
4982 and forces movement by logical lines.
4983 A window that is horizontally scrolled also forces movement by logical
4984 lines."
4989 ;; Only used if display-graphic-p.
4993 "Return the height in pixels of the current buffer's default face font."
4997 ;; Avoid calling font-info if the frame's default font was
4998 ;; not changed since the frame was created. That's because
4999 ;; font-info is expensive for some fonts, see bug #14838.
5005 "Return the pixel height of current buffer's default-face text line.
5007 The value includes `line-spacing', if any, defined for the buffer
5008 or the frame."
5021 "Return the number of screen lines in the text area of the selected window.
5023 This is different from `window-text-height' in that this function counts
5024 lines in units of the height of the font used by the default face displayed
5025 in the window, not in units of the frame's default font, and also accounts
5026 for `line-spacing', if any, defined for the window's buffer or frame.
5028 The value is a floating-point number."
5034 ;; Returns non-nil if partial move was done.
5037 ;; Move backward (up).
5038 ;; If already vscrolled, reduce vscroll
5044 ;; Move forward (down).
5057 py vs last-line)
5077 col-row)
5082 ;; VPOS > 0 means the last line is only partially visible.
5083 ;; But if the part that is visible is at least as tall as the
5084 ;; default font, that means the line is actually fully
5085 ;; readable, and something like line-spacing is hidden. So in
5086 ;; that case we accept the last line in the window as still
5087 ;; visible, and consider the margin as starting one line
5088 ;; later.
5096 ;; If last line of window is fully visible, and vscrolling
5097 ;; more would make this line invisible, move forward.
5102 nil)
5103 ;; If cursor is not in the bottom scroll margin, and the
5104 ;; current line is is not too tall, move forward.
5106 vpos
5109 nil)
5110 ;; When already vscrolled, we vscroll some more if we can,
5111 ;; or clear vscroll and move forward at end of tall image.
5116 ;; If cursor just entered the bottom scroll margin, move forward,
5117 ;; but also optionally vscroll one line so redisplay won't recenter.
5121 ;; Don't vscroll if the partially-visible line at window
5122 ;; bottom is not too tall (a.k.a. "just one more text
5123 ;; line"): in that case, we do want redisplay to behave
5124 ;; normally, i.e. recenter or whatever.
5125 ;;
5126 ;; Note: ROWH + RBOT from the value returned by
5127 ;; pos-visible-in-window-p give the total height of the
5128 ;; partially-visible glyph row at the end of the window. As
5129 ;; we are dealing with floats, we disregard sub-pixel
5130 ;; discrepancies between that and DLH.
5134 t)
5135 ;; If there are lines above the last line, scroll-up one line.
5138 t)
5139 ;; Finally, start vscroll.
5144 ;; This is like line-move-1 except that it also performs
5145 ;; vertical scrolling of tall images if appropriate.
5146 ;; That is not really a clean thing to do, since it mixes
5147 ;; scrolling with cursor motion. But so far we don't have
5148 ;; a cleaner solution to the problem of making C-n do something
5149 ;; useful given a tall image.
5151 "Move forward ARG lines.
5152 If NOERROR, don't signal an error if we can't move ARG lines.
5153 TO-END is unused.
5154 TRY-VSCROLL controls whether to vscroll tall lines: if either
5155 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5156 not vscroll."
5160 ;; Only vscroll for single line moves
5162 ;; Under scroll-conservatively, the display engine
5163 ;; does this better.
5165 ;; But don't vscroll in a keyboard macro.
5171 ;; Display-based column are incompatible with goal-column.
5173 ;; When the text in the window is scrolled to the left,
5174 ;; display-based motion doesn't make sense (because each
5175 ;; logical line occupies exactly one screen line).
5177 ;; Likewise when the text _was_ scrolled to the left
5178 ;; when the current run of vertical motion commands
5179 ;; started.
5182 auto-hscroll-mode
5184 (>= temporary-goal-column
5187 ;; If we moved into a tall line, set vscroll to make
5188 ;; scrolling through tall images more smooth.
5192 winh)
5198 nil
5202 ;; Display-based alternative to line-move-1.
5203 ;; Arg says how many lines to move. The value is t if we can move the
5204 ;; specified number of lines.
5206 "Move ARG lines forward.
5207 If NOERROR, don't signal an error if we can't move that many lines."
5210 target-hscroll)
5211 ;; Check if the previous command was a line-motion command, or if
5212 ;; we were called from some other command.
5215 ;; If so, there's no need to reset `temporary-goal-column',
5216 ;; but we may need to hscroll.
5220 ;; Otherwise, we should reset `temporary-goal-column'.
5223 ;; Handle the `overflow-newline-into-fringe' case:
5232 ;; vertical-motion can move more than it was asked to if it moves
5233 ;; across display strings with newlines. We don't want to ring
5234 ;; the bell and announce beginning/end of buffer in that case.
5240 temporary-goal-column))
5241 arg))
5242 arg))
5248 temporary-goal-column))
5249 arg))
5250 arg)))
5253 ;; If the goal column lies on a display string,
5254 ;; `vertical-motion' advances the cursor to the end
5255 ;; of the string. For arg < 0, this can cause the
5256 ;; cursor to get stuck. (Bug#3020).
5260 nil)))))
5262 ;; This is the guts of next-line and previous-line.
5263 ;; Arg says how many lines to move.
5264 ;; The value is t if we can move the specified number of lines.
5266 ;; Don't run any point-motion hooks, and disregard intangibility,
5267 ;; for intermediate positions.
5279 ;; Don't count beg of empty line as end of line
5280 ;; unless we just did explicit end-of-line.
5282 most-positive-fixnum
5286 line-move-ignore-invisible))
5287 ;; Use just newline characters.
5288 ;; Set ARG to 0 if we move as many lines as requested.
5291 ;; This way of moving forward ARG lines
5292 ;; verifies that we have a newline after the last one.
5293 ;; It doesn't get confused by intangible text.
5302 'beginning-of-buffer
5304 nil)))
5305 ;; Move by arg lines, but ignore invisible ones.
5308 ;; If the following character is currently invisible,
5309 ;; skip all characters with that same `invisible' property value.
5312 ;; Move a line.
5313 ;; We don't use `end-of-line', since we want to escape
5314 ;; from field boundaries occurring exactly at point.
5320 ;; If there's no invisibility here, move over the newline.
5329 ;; We avoid vertical-motion when possible
5330 ;; because that has to fontify.
5332 ;; Otherwise move a more sophisticated way.
5339 ;; The logic of this is the same as the loop above,
5340 ;; it just goes in the other direction.
5342 ;; For completely consistency with the forward-motion
5343 ;; case, we should call beginning-of-line here.
5344 ;; However, if point is inside a field and on a
5345 ;; continued line, the call to (vertical-motion -1)
5346 ;; below won't move us back far enough; then we return
5347 ;; to the same column in line-move-finish, and point
5348 ;; gets stuck -- cyd
5366 ;; if our target is the middle of this line.
5371 ;; This is the value the function returns.
5375 ;; If we did not move down as far as desired, at least go
5376 ;; to end of line. Be sure to call point-entered and
5377 ;; point-left-hooks.
5383 ;; If we did not move up as far as desired,
5384 ;; at least go to beginning of line.
5396 ;; Set REPEAT to t to repeat the whole thing.
5403 ;; Compute the end of the line
5404 ;; ignoring effectively invisible newlines.
5406 ;; Like end-of-line but ignores fields.
5413 ;; Move to the desired column.
5416 ;; Corner case: suppose we start out in a field boundary in
5417 ;; the middle of a continued line. When we get to
5418 ;; line-move-finish, point is at the start of a new *screen*
5419 ;; line but the same text line; then line-move-to-column would
5420 ;; move us backwards. Test using C-n with point on the "x" in
5421 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5428 ;; Process intangibility within a line.
5429 ;; With inhibit-point-motion-hooks bound to nil, a call to
5430 ;; goto-char moves point past intangible text.
5432 ;; However, inhibit-point-motion-hooks controls both the
5433 ;; intangibility and the point-entered/point-left hooks. The
5434 ;; following hack avoids calling the point-* hooks
5435 ;; unnecessarily. Note that we move *forward* past intangible
5436 ;; text when the initial and final points are the same.
5441 ;; If intangibility moves us to a different (later) place
5442 ;; in the same line, use that as the destination.
5445 ;; If that position is "too late",
5446 ;; try the previous allowable position.
5447 ;; See if it is ok.
5450 ;; If going forward, don't accept the previous
5451 ;; allowable position if it is before the target line.
5453 ;; If going backward, don't accept the previous
5454 ;; allowable position if it is still after the target line.
5457 ;; As a last resort, use the end of the line.
5460 ;; Now move to the updated destination, processing fields
5461 ;; as well as intangibility.
5465 ;; Ignore field boundaries if the initial and final
5466 ;; positions have the same `field' property, even if the
5467 ;; fields are non-contiguous. This seems to be "nicer"
5468 ;; behavior in many situations.
5471 new
5475 ;; If all this moved us to a different line,
5476 ;; retry everything within that new line.
5478 ;; Repeat the intangibility and field processing.
5482 "Try to find column COL, considering invisibility.
5483 This function works only in certain cases,
5484 because what we really need is for `move-to-column'
5485 and `current-column' to be able to ignore invisible text."
5494 ;; If the following character is currently invisible,
5495 ;; skip all characters with that same `invisible' property value.
5499 ;; Have we advanced to a larger column position?
5501 ;; We have made some progress towards the desired column.
5502 ;; See if we can make any further progress.
5504 ;; Otherwise, go to the place we originally found
5505 ;; and move back over invisible text.
5506 ;; that will get us to the same place on the screen
5507 ;; but with a more reasonable buffer position.
5514 "Move point to end of current line as displayed.
5515 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5516 If point reaches the beginning or end of buffer, it stops there.
5518 To ignore the effects of the `intangible' text or overlay
5519 property, bind `inhibit-point-motion-hooks' to t.
5520 If there is an image in the current line, this function
5521 disregards newlines that are part of the text on which the image
5522 rests."
5532 ;; With bidi reordering, we may not be at bol,
5533 ;; so make sure we are.
5548 ;; If we skipped something intangible and now we're not
5549 ;; really at eol, keep going.
5554 "Move point to beginning of current line as displayed.
5555 \(If there's an image in the line, this disregards newlines
5556 which are part of the text that the image rests on.)
5558 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5559 If point reaches the beginning or end of buffer, it stops there.
5560 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5565 first-vis first-vis-field-value)
5567 ;; Move by lines, if ARG is not 1 (the default).
5572 ;; Move to beginning-of-line, ignoring fields and invisible text.
5578 ;; Now find first visible char in the line.
5583 ;; See if fields would stop us from reaching FIRST-VIS.
5588 ;; If yes, obey them.
5589 first-vis-field-value
5590 ;; Otherwise, move to START with attention to fields.
5591 ;; (It is possible that fields never matter in this case.)
5596 ;; Many people have said they rarely use this feature, and often type
5597 ;; it by accident. Maybe it shouldn't even be on a key.
5602 Those commands will move to this position in the line moved to
5603 rather than trying to keep the same horizontal position.
5604 With a non-nil argument ARG, clears out the goal column
5606 The goal column is stored in the variable `goal-column'."
5613 ;; The older method below can be erroneous if `set-goal-column' is bound
5614 ;; to a sequence containing %
5615 ;;(message (substitute-command-keys
5616 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
5617 ;;goal-column)
5624 )
5625 nil)
5626 \f
5627 ;;; Editing based on visual lines, as opposed to logical lines.
5630 "Move point to end of current visual line.
5631 With argument N not nil or 1, move forward N - 1 visual lines first.
5632 If point reaches the beginning or end of buffer, it stops there.
5633 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5639 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5640 ;; constrain to field boundaries, so we don't either.
5644 "Move point to beginning of current visual line.
5645 With argument N not nil or 1, move forward N - 1 visual lines first.
5646 If point reaches the beginning or end of buffer, it stops there.
5647 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5655 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5659 "Kill the rest of the visual line.
5660 With prefix argument ARG, kill that many visual lines from point.
5661 If ARG is negative, kill visual lines backward.
5662 If ARG is zero, kill the text before point on the current visual
5663 line.
5665 If you want to append the killed line to the last killed text,
5668 If the buffer is read-only, Emacs will beep and refrain from deleting
5669 the line, but put the line in the kill ring anyway. This means that
5670 you can use this command to copy text from a read-only buffer.
5671 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5672 even beep.)"
5674 ;; Like in `kill-line', it's better to move point to the other end
5675 ;; of the kill before killing.
5683 ;; Skip any trailing whitespace at the end of the visual line.
5684 ;; We used to do this only if `show-trailing-whitespace' is
5685 ;; nil, but that's wrong; the correct thing would be to check
5686 ;; whether the trailing whitespace is highlighted. But, it's
5687 ;; OK to just do this unconditionally.
5694 "Move cursor vertically down ARG lines.
5695 This is identical to `next-line', except that it always moves
5696 by logical lines instead of visual lines, ignoring the value of
5697 the variable `line-move-visual'."
5704 "Move cursor vertically up ARG lines.
5705 This is identical to `previous-line', except that it always moves
5706 by logical lines instead of visual lines, ignoring the value of
5707 the variable `line-move-visual'."
5714 "Editing based on visual lines."
5723 ;; These keybindings interfere with xterm function keys. Are
5724 ;; there any other suitable bindings?
5725 ;; (define-key map "\M-[" 'previous-logical-line)
5726 ;; (define-key map "\M-]" 'next-logical-line)
5727 map))
5730 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5731 The value should be a list of the form (LEFT RIGHT), where LEFT
5732 and RIGHT are symbols representing the bitmaps to display, to
5733 indicate wrapped lines, in the left and right fringes respectively.
5734 See also `fringe-indicator-alist'.
5735 The default is not to display fringe indicators for wrapped lines.
5736 This variable does not affect fringe indicators displayed for
5737 other purposes."
5752 'continuation
5759 "Toggle visual line based editing (Visual Line mode).
5760 With a prefix argument ARG, enable Visual Line mode if ARG is
5761 positive, and disable it otherwise. If called from Lisp, enable
5762 the mode if ARG is omitted or nil.
5764 When Visual Line mode is enabled, `word-wrap' is turned on in
5765 this buffer, and simple editing commands are redefined to act on
5766 visual lines, not logical lines. See Info node `Visual Line
5767 Mode' for details."
5768 :keymap visual-line-mode-map
5774 ;; Save the local values of some variables, to be restored if
5775 ;; visual-line-mode is turned off.
5777 truncate-partial-width-windows
5778 word-wrap fringe-indicator-alist))
5781 visual-line--saved-state)))
5785 word-wrap t
5786 fringe-indicator-alist
5788 fringe-indicator-alist)))
5802 visual-line-mode turn-on-visual-line-mode)
5804 \f
5806 "Interchange characters around point, moving forward one character.
5807 With prefix arg ARG, effect is to take character before point
5808 and drag it forward past ARG other characters (backward if ARG negative).
5809 If no argument and at end of line, the previous two chars are exchanged."
5815 "Interchange words around point, leaving point at end of them.
5816 With prefix arg ARG, effect is to take word before or around point
5817 and drag it forward past ARG other words (backward if ARG negative).
5818 If ARG is zero, the words around or after point and around or after mark
5819 are interchanged."
5820 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5826 Does not work on a sexp that point is in the middle of
5827 if it is a list or string."
5831 ;; Here we should try to simulate the behavior of
5832 ;; (cons (progn (forward-sexp x) (point))
5833 ;; (progn (forward-sexp (- x)) (point)))
5834 ;; Except that we don't want to rely on the second forward-sexp
5835 ;; putting us back to where we want to be, since forward-sexp-function
5836 ;; might do funny things like infix-precedence.
5841 ;; Jumping over a symbol. We might be inside it, mind you.
5846 ;; Otherwise, we're between sexps. Take a step back before jumping
5847 ;; to make sure we'll obey the same precedence no matter which direction
5848 ;; we're going.
5853 'skip-syntax-forward
5860 "Exchange current line and previous line, leaving point after both.
5861 With argument ARG, takes previous line and moves it past ARG lines.
5862 With argument 0, interchanges line point is in with line mark is in."
5868 ;; Move forward over ARG lines,
5869 ;; but create newlines if necessary.
5876 arg))
5878 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5879 ;; which seems inconsistent with the ARG /= 0 case.
5880 ;; FIXME document SPECIAL.
5882 "Subroutine to do the work of transposing objects.
5883 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5884 moves forward by units of the given object (e.g. forward-sentence,
5885 forward-paragraph). If ARG is zero, exchanges the current object
5886 with the one containing mark. If ARG is an integer, moves the
5887 current object past ARG following (if ARG is positive) or
5888 preceding (if ARG is negative) objects, leaving point after the
5889 current object."
5894 pos1 pos2)
5922 ;; This sequence of insertions attempts to preserve marker
5923 ;; positions at the start and end of the transposed objects.
5937 \f
5939 "Move backward until encountering the beginning of a word.
5940 With argument ARG, do this that many times.
5941 If ARG is omitted or nil, move point backward one word."
5946 "Set mark ARG words away from point.
5948 move to with the same argument.
5949 Interactively, if this command is repeated
5950 or (in Transient Mark mode) if the mark is active,
5951 it marks the next ARG words after the ones already marked."
5968 nil t))))
5971 "Kill characters forward until encountering the end of a word.
5972 With argument ARG, do this that many times."
5977 "Kill characters backward until encountering the beginning of a word.
5978 With argument ARG, do this that many times."
5983 "Return the symbol or word that point is on (or a nearby one) as a string.
5984 The return value includes no text properties.
5985 If optional arg STRICT is non-nil, return nil unless point is within
5986 or adjacent to a symbol or word. In all cases the value can be nil
5987 if there is no word nearby.
5988 The function, belying its name, normally finds a symbol.
5989 If optional arg REALLY-WORD is non-nil, it finds just a word."
5998 ;; Point is neither within nor adjacent to a word.
6000 ;; Look for preceding word in same line.
6003 ;; No preceding word in same line.
6004 ;; Look for following word in same line.
6013 ;; If we found something nonempty, return it as a string.
6016 \f
6018 "String for filling to insert at front of new line, or nil for none."
6020 string)
6026 "Regexp to match lines which should not be auto-filled."
6028 regexp)
6032 "The default value for `normal-auto-fill-function'.
6033 This is the default auto-fill function, some major modes use a different one.
6034 Returns t if it really did any work."
6044 nil ;; Auto-filling not required
6048 ;; Choose a fill-prefix automatically.
6056 ;; Use auto-indentation rather than a guessed empty prefix.
6062 ;; Determine where to split the line.
6075 ;; See whether the place we found is any good.
6079 ;; There is no use breaking at end of line.
6081 ;; It is futile to split at the end of the prefix
6082 ;; since we would just insert the prefix again.
6084 ;; Don't split right after a comment starter
6085 ;; since we would just make another comment starter.
6090 limit t)
6092 ;; No good place to break => stop trying.
6094 ;; Ok, we have a useful place to break the line. Do it.
6096 ;; If point is at the fill-point, do not `save-excursion'.
6097 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6098 ;; point will end up before it rather than after it.
6106 ;; Now do justification, if required
6111 ;; If making the new line didn't reduce the hpos of
6112 ;; the end of the line, then give up now;
6113 ;; trying again will not help.
6116 ;; Justify last line.
6118 t)))
6121 "Mode-specific function which line breaks and continues a comment.
6122 This function is called during auto-filling when a comment syntax
6123 is defined.
6124 The function should take a single optional argument, which is a flag
6128 "Break line at point and indent.
6129 If a comment syntax is defined, call `comment-indent-new-line'.
6131 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6132 unless optional argument SOFT is non-nil."
6136 ;; Insert the newline before removing empty space so that markers
6137 ;; get preserved better.
6143 ;; Blindly trust a non-adaptive fill-prefix.
6149 ;; If there's an adaptive prefix, use it unless we're inside
6150 ;; a comment and the prefix is not a comment starter.
6154 ;; If we're not inside a comment, just try to indent.
6158 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6162 ;; `functions' and `hooks' are usually unsafe to set, but setting
6163 ;; auto-fill-function to nil in a file-local setting is safe and
6164 ;; can be useful to prevent auto-filling.
6168 "Toggle automatic line breaking (Auto Fill mode).
6169 With a prefix argument ARG, enable Auto Fill mode if ARG is
6170 positive, and disable it otherwise. If called from Lisp, enable
6171 the mode if ARG is omitted or nil.
6173 When Auto Fill mode is enabled, inserting a space at a column
6174 beyond `current-fill-column' automatically breaks the line at a
6175 previous space.
6177 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6178 non-`nil'.
6180 The value of `normal-auto-fill-function' specifies the function to use
6181 for `auto-fill-function' when turning Auto Fill mode on."
6186 ;; This holds a document string used to document auto-fill-mode.
6188 "Automatically break line at a previous space, in insertion of text."
6189 nil)
6192 "Unconditionally turn on Auto Fill mode."
6196 "Unconditionally turn off Auto Fill mode."
6202 "Set `fill-column' to specified argument.
6207 ;; We used to use current-column silently, but C-x f is too easily
6208 ;; typed as a typo for C-x C-f, so we turned it into an error and
6209 ;; now an interactive prompt.
6214 ;; Disallow missing argument; it's probably a typo for C-x C-f.
6218 \f
6220 "Set `selective-display' to ARG; clear it if no arg.
6221 When the value of `selective-display' is a number > 0,
6222 lines whose indentation is >= that value are not displayed.
6223 The variable `selective-display' has a separate value for each buffer."
6243 "Toggle truncating of long lines for the current buffer.
6244 When truncating is off, long lines are folded.
6245 With prefix argument ARG, truncate long lines if ARG is positive,
6246 otherwise fold them. Note that in side-by-side windows, this
6247 command has no effect if `truncate-partial-width-windows' is
6248 non-nil."
6260 nil t)))
6265 "Toggle whether to use word-wrapping for continuation lines.
6266 With prefix argument ARG, wrap continuation lines at word boundaries
6267 if ARG is positive, otherwise wrap them at the right screen edge.
6268 This command toggles the value of `word-wrap'. It has no effect
6269 if long lines are truncated."
6285 "Toggle Overwrite mode.
6286 With a prefix argument ARG, enable Overwrite mode if ARG is
6287 positive, and disable it otherwise. If called from Lisp, enable
6288 the mode if ARG is omitted or nil.
6290 When Overwrite mode is enabled, printing characters typed in
6291 replace existing text on a one-for-one basis, rather than pushing
6292 it to the right. At the end of a line, such characters extend
6293 the line. Before a tab, such characters insert until the tab is
6295 overwrite mode; this is supposed to make it easier to insert
6296 characters when necessary."
6301 "Toggle Binary Overwrite mode.
6302 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6303 is positive, and disable it otherwise. If called from Lisp,
6304 enable the mode if ARG is omitted or nil.
6306 When Binary Overwrite mode is enabled, printing characters typed
6307 in replace existing text. Newlines are not treated specially, so
6308 typing at the end of a line joins the line to the next, with the
6309 typed character between them. Typing before a tab character
6310 simply replaces the tab with the character typed.
6312 ordinary typing characters do.
6314 Note that Binary Overwrite mode is not its own minor mode; it is
6315 a specialization of overwrite mode, entered by setting the
6316 `overwrite-mode' variable to `overwrite-mode-binary'."
6321 "Toggle line number display in the mode line (Line Number mode).
6322 With a prefix argument ARG, enable Line Number mode if ARG is
6323 positive, and disable it otherwise. If called from Lisp, enable
6324 the mode if ARG is omitted or nil.
6326 Line numbers do not appear for very large buffers and buffers
6327 with very long lines; see variables `line-number-display-limit'
6328 and `line-number-display-limit-width'."
6332 "Toggle column number display in the mode line (Column Number mode).
6333 With a prefix argument ARG, enable Column Number mode if ARG is
6334 positive, and disable it otherwise.
6336 If called from Lisp, enable the mode if ARG is omitted or nil."
6340 "Toggle buffer size display in the mode line (Size Indication mode).
6341 With a prefix argument ARG, enable Size Indication mode if ARG is
6342 positive, and disable it otherwise.
6344 If called from Lisp, enable the mode if ARG is omitted or nil."
6348 "Toggle auto-saving in the current buffer (Auto Save mode).
6349 With a prefix argument ARG, enable Auto Save mode if ARG is
6350 positive, and disable it otherwise.
6352 If called from Lisp, enable the mode if ARG is omitted or nil."
6354 ;; If auto-save is off because buffer has shrunk,
6355 ;; then toggling should turn it on.
6363 buffer-file-name)
6365 ;; If -1 was stored here, to temporarily turn off saving,
6366 ;; turn it back on.
6369 \f
6371 "Blinking matching of parens and expressions."
6376 "Non-nil means show matching open-paren when close-paren is inserted.
6377 If t, highlight the paren. If `jump', move cursor to its position."
6385 "Non-nil means show matching open-paren when it is on screen.
6386 If nil, don't show it (but the open-paren can still be shown
6387 when it is off screen).
6389 This variable has no effect if `blink-matching-paren' is nil.
6390 \(In that case, the open-paren is never shown.)
6391 It is also ignored if `show-paren-mode' is enabled."
6396 "If non-nil, maximum distance to search backwards for matching open-paren.
6397 If nil, search stops at the beginning of the accessible portion of the buffer."
6403 "Time in seconds to delay after showing a matching paren."
6408 "If nil, `blink-matching-paren' ignores comments.
6409 More precisely, when looking for the matching parenthesis,
6410 it skips the contents of comments that end before point."
6415 "Return whether or not START...END are matching parens.
6416 END is the current point and START is the blink position.
6417 START might be nil if no matching starter was found.
6418 Returns non-nil if we find there is a mismatch."
6423 ;; For self-matched chars like " and $, we can't know when they're
6424 ;; mismatched or unmatched, so we can only do it for parens.
6429 ;; The cdr might hold a new paren-class info rather than
6430 ;; a matching-char info, in which case the two CDRs
6431 ;; should match.
6435 "Function to check parentheses mismatches.
6436 The function takes two arguments (START and END) where START is the
6437 position just before the opening token and END is the position right after.
6438 START can be nil, if it was not found.
6445 ol)
6449 "Momentarily highlight the beginning of the sexp before point."
6452 blink-matching-paren)
6462 oldpos))
6469 ;; backward-sexp skips backward over prefix chars,
6470 ;; so move back to the matching paren.
6491 ;; Matching open within window, temporarily move to or highlight
6492 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
6493 ;; is non-nil.
6510 ;; Show what precedes the open in its line, if anything.
6515 ;; Show what follows the open in its line, if anything.
6522 ;; Otherwise show the previous nonblank line,
6523 ;; if there is one.
6532 ;; Replace the newline and other whitespace with `...'.
6533 "..."
6535 ;; There is nothing to show except the char itself.
6541 "Function called, if non-nil, whenever a close parenthesis is inserted.
6547 blink-paren-function
6550 ;; Verify an even number of quoting characters precede the close.
6561 ;; Most likely, this hook is nil, so this arg doesn't matter,
6562 ;; but I use it as a reminder that this function usually
6563 ;; likes to be run after others since it does
6564 ;; `sit-for'. That's also the reason it get a `priority' prop
6565 ;; of 100.
6567 \f
6568 ;; This executes C-g typed while Emacs is waiting for a command.
6569 ;; Quitting out of a program does not go through here;
6570 ;; that happens in the QUIT macro at the C code level.
6572 "Signal a `quit' condition.
6573 During execution of Lisp code, this character causes a quit directly.
6574 At top-level, as an editor command, this simply beeps."
6576 ;; Avoid adding the region to the window selection.
6595 This command can exit an interactive command such as `query-replace',
6596 can clear out a prefix argument or a region,
6597 can get out of the minibuffer or other recursive edit,
6598 cancel the use of the current buffer (for special-purpose buffers),
6599 or go back to just one window (by deleting all but the selected window)."
6607 nil)
6618 "Play sound stored in FILE.
6619 VOLUME and DEVICE correspond to the keywords of the sound
6620 specification for `play-sound'."
6630 \f
6632 "Your preference for a mail reading package.
6633 This is used by some keybindings which support reading mail.
6634 See also `mail-user-agent' concerning sending mail."
6644 "Your preference for a mail composition package.
6645 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6646 outgoing email message. This variable lets you specify which
6647 mail-sending package you prefer.
6649 Valid values include:
6651 `message-user-agent' -- use the Message package.
6652 See Info node `(message)'.
6653 `sendmail-user-agent' -- use the Mail package.
6654 See Info node `(emacs)Sending Mail'.
6655 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6656 See Info node `(mh-e)'.
6657 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6658 paraphernalia if Gnus is running, particularly
6659 the Gcc: header for archiving.
6661 Additional valid symbols may be available; check with the author of
6662 your package for details. The function should return non-nil if it
6663 succeeds.
6665 See also `read-mail-command' concerning reading mail."
6668 message-user-agent)
6671 sendmail-user-agent)
6674 mh-e-user-agent)
6677 gnus-user-agent)
6683 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6684 If the value of `mail-user-agent' is the default, and the user
6685 appears to have customizations applying to the old default,
6686 `compose-mail' issues a warning."
6692 "If the buffer starts with a mail header, move point to the header's end.
6693 Otherwise, moves to `point-min'.
6694 The end of the header is the start of the next line, if there is one,
6695 else the end of the last line. This function obeys RFC822."
6701 ;; Used by Rmail (e.g., rmail-forward).
6703 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6707 switch-function yank-action send-actions
6708 return-action)
6709 "Start composing a mail message to send.
6710 This uses the user's chosen mail composition package
6711 as selected with the variable `mail-user-agent'.
6712 The optional arguments TO and SUBJECT specify recipients
6713 and the initial Subject field, respectively.
6715 OTHER-HEADERS is an alist specifying additional
6716 header fields. Elements look like (HEADER . VALUE) where both
6717 HEADER and VALUE are strings.
6719 CONTINUE, if non-nil, says to continue editing a message already
6720 being composed. Interactively, CONTINUE is the prefix argument.
6722 SWITCH-FUNCTION, if non-nil, is a function to use to
6723 switch to and display the buffer used for mail composition.
6725 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6726 to insert the raw text of the message being replied to.
6727 It has the form (FUNCTION . ARGS). The user agent will apply
6728 FUNCTION to ARGS, to insert the raw text of the original message.
6729 \(The user agent will also run `mail-citation-hook', *after* the
6730 original text has been inserted in this way.)
6732 SEND-ACTIONS is a list of actions to call when the message is sent.
6733 Each action has the form (FUNCTION . ARGS).
6735 RETURN-ACTION, if non-nil, is an action for returning to the
6736 caller. It has the form (FUNCTION . ARGS). The function is
6737 called after the mail has been sent or put aside, and the mail
6738 buffer buried."
6742 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6743 ;; from sendmail-user-agent to message-user-agent. Some users may
6744 ;; encounter incompatibilities. This hack tries to detect problems
6745 ;; and warn about them.
6750 mail-yank-hooks mail-archive-file-name
6751 mail-default-reply-to mail-mailing-lists
6752 mail-self-blind))
6759 The default mail mode is now Message mode.
6760 You have the following Mail mode variable%s customized:
6762 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6769 yank-action send-actions return-action)))
6772 yank-action send-actions
6773 return-action)
6777 'switch-to-buffer-other-window yank-action send-actions
6778 return-action))
6781 yank-action send-actions
6782 return-action)
6786 'switch-to-buffer-other-frame yank-action send-actions
6787 return-action))
6789 \f
6791 "History of values entered with `set-variable'.
6793 Maximum length of the history list is determined by the value
6797 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6798 VARIABLE should be a user option variable name, a Lisp variable
6799 meant to be customized by users. You should enter VALUE in Lisp syntax,
6800 so if you want VALUE to be a string, you must surround it with doublequotes.
6801 VALUE is used literally, not evaluated.
6803 If VARIABLE has a `variable-interactive' property, that is used as if
6804 it were the arg to `interactive' (which see) to interactively read VALUE.
6806 If VARIABLE has been defined with `defcustom', then the type information
6807 in the definition is used to check that VALUE is valid.
6809 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6814 default-var)
6830 var obsolete)
6833 ;; Use VAR's `variable-interactive' property
6834 ;; as an interactive spec for prompting.
6837 arg))
6839 read-expression-map t
6840 'set-variable-value-history
6849 ;; Match with custom type.
6861 ;; Force a thorough redisplay for the case that the variable
6862 ;; has an effect on the display, like `tab-width' has.
6864 \f
6865 ;; Define the major mode for lists of completions.
6875 (define-key map [right] 'next-completion)
6876 (define-key map "q" 'quit-window)
6877 (define-key map "z" 'kill-this-buffer)
6878 map)
6879 "Local map for completion list buffers.")
6881 ;; Completion mode is suitable only for specially formatted data.
6882 (put 'completion-list-mode 'mode-class 'special)
6884 (defvar completion-reference-buffer nil
6885 "Record the buffer that was current when the completion list was requested.
6886 This is a local variable in the completion list buffer.
6887 Initial value is nil to avoid some compiler warnings.")
6889 (defvar completion-no-auto-exit nil
6890 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6891 This also applies to other functions such as `choose-completion'.")
6893 (defvar completion-base-position nil
6894 "Position of the base of the text corresponding to the shown completions.
6895 This variable is used in the *Completions* buffers.
6896 Its value is a list of the form (START END) where START is the place
6897 where the completion should be inserted and END (if non-nil) is the end
6898 of the text to replace. If END is nil, point is used instead.")
6900 (defvar completion-list-insert-choice-function #'completion--replace
6901 "Function to use to insert the text chosen in *Completions*.
6902 Called with three arguments (BEG END TEXT), it should replace the text
6903 between BEG and END with TEXT. Expected to be set buffer-locally
6904 in the *Completions* buffer.")
6906 (defvar completion-base-size nil
6907 "Number of chars before point not involved in completion.
6908 This is a local variable in the completion list buffer.
6909 It refers to the chars in the minibuffer if completing in the
6910 minibuffer, or in `completion-reference-buffer' otherwise.
6911 Only characters in the field at point are included.
6913 If nil, Emacs determines which part of the tail end of the
6914 buffer's text is involved in completion by comparing the text
6915 directly.")
6916 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6918 (defun delete-completion-window ()
6919 "Delete the completion list window.
6920 Go to the window from which completion was requested."
6921 (interactive)
6922 (let ((buf completion-reference-buffer))
6923 (if (one-window-p t)
6924 (if (window-dedicated-p) (delete-frame))
6925 (delete-window (selected-window))
6926 (if (get-buffer-window buf)
6927 (select-window (get-buffer-window buf))))))
6929 (defun previous-completion (n)
6930 "Move to the previous item in the completion list."
6931 (interactive "p")
6932 (next-completion (- n)))
6934 (defun next-completion (n)
6935 "Move to the next item in the completion list.
6936 With prefix argument N, move N items (negative N means move backward)."
6937 (interactive "p")
6938 (let ((beg (point-min)) (end (point-max)))
6939 (while (and (> n 0) (not (eobp)))
6940 ;; If in a completion, move to the end of it.
6941 (when (get-text-property (point) 'mouse-face)
6942 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6943 ;; Move to start of next one.
6944 (unless (get-text-property (point) 'mouse-face)
6945 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6946 (setq n (1- n)))
6947 (while (and (< n 0) (not (bobp)))
6948 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6949 ;; If in a completion, move to the start of it.
6950 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6951 (goto-char (previous-single-property-change
6952 (point) 'mouse-face nil beg)))
6953 ;; Move to end of the previous completion.
6954 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6955 (goto-char (previous-single-property-change
6956 (point) 'mouse-face nil beg)))
6957 ;; Move to the start of that one.
6958 (goto-char (previous-single-property-change
6959 (point) 'mouse-face nil beg))
6960 (setq n (1+ n))))))
6962 (defun choose-completion (&optional event)
6963 "Choose the completion at point.
6964 If EVENT, use EVENT's position to determine the starting position."
6965 (interactive (list last-nonmenu-event))
6966 ;; In case this is run via the mouse, give temporary modes such as
6967 ;; isearch a chance to turn off.
6968 (run-hooks 'mouse-leave-buffer-hook)
6969 (with-current-buffer (window-buffer (posn-window (event-start event)))
6970 (let ((buffer completion-reference-buffer)
6971 (base-size completion-base-size)
6972 (base-position completion-base-position)
6973 (insert-function completion-list-insert-choice-function)
6974 (choice
6975 (save-excursion
6976 (goto-char (posn-point (event-start event)))
6977 (let (beg end)
6978 (cond
6979 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6980 (setq end (point) beg (1+ (point))))
6981 ((and (not (bobp))
6982 (get-text-property (1- (point)) 'mouse-face))
6983 (setq end (1- (point)) beg (point)))
6984 (t (error "No completion here")))
6985 (setq beg (previous-single-property-change beg 'mouse-face))
6986 (setq end (or (next-single-property-change end 'mouse-face)
6987 (point-max)))
6988 (buffer-substring-no-properties beg end)))))
6990 (unless (buffer-live-p buffer)
6991 (error "Destination buffer is dead"))
6992 (quit-window nil (posn-window (event-start event)))
6994 (with-current-buffer buffer
6995 (choose-completion-string
6996 choice buffer
6997 (or base-position
6998 (when base-size
6999 ;; Someone's using old completion code that doesn't know
7000 ;; about base-position yet.
7001 (list (+ base-size (field-beginning))))
7002 ;; If all else fails, just guess.
7003 (list (choose-completion-guess-base-position choice)))
7004 insert-function)))))
7006 ;; Delete the longest partial match for STRING
7007 ;; that can be found before POINT.
7008 (defun choose-completion-guess-base-position (string)
7009 (save-excursion
7010 (let ((opoint (point))
7011 len)
7012 ;; Try moving back by the length of the string.
7013 (goto-char (max (- (point) (length string))
7014 (minibuffer-prompt-end)))
7015 ;; See how far back we were actually able to move. That is the
7016 ;; upper bound on how much we can match and delete.
7017 (setq len (- opoint (point)))
7018 (if completion-ignore-case
7019 (setq string (downcase string)))
7020 (while (and (> len 0)
7021 (let ((tail (buffer-substring (point) opoint)))
7022 (if completion-ignore-case
7023 (setq tail (downcase tail)))
7024 (not (string= tail (substring string 0 len)))))
7025 (setq len (1- len))
7026 (forward-char 1))
7027 (point))))
7029 (defun choose-completion-delete-max-match (string)
7030 (declare (obsolete choose-completion-guess-base-position "23.2"))
7031 (delete-region (choose-completion-guess-base-position string) (point)))
7033 (defvar choose-completion-string-functions nil
7034 "Functions that may override the normal insertion of a completion choice.
7035 These functions are called in order with three arguments:
7036 CHOICE - the string to insert in the buffer,
7037 BUFFER - the buffer in which the choice should be inserted,
7038 BASE-POSITION - where to insert the completion.
7040 If a function in the list returns non-nil, that function is supposed
7041 to have inserted the CHOICE in the BUFFER, and possibly exited
7042 the minibuffer; no further functions will be called.
7044 If all functions in the list return nil, that means to use
7045 the default method of inserting the completion in BUFFER.")
7047 (defun choose-completion-string (choice &optional
7048 buffer base-position insert-function)
7049 "Switch to BUFFER and insert the completion choice CHOICE.
7050 BASE-POSITION says where to insert the completion.
7051 INSERT-FUNCTION says how to insert the completion and falls
7052 back on `completion-list-insert-choice-function' when nil."
7054 ;; If BUFFER is the minibuffer, exit the minibuffer
7055 ;; unless it is reading a file name and CHOICE is a directory,
7056 ;; or completion-no-auto-exit is non-nil.
7058 ;; Some older code may call us passing `base-size' instead of
7059 ;; `base-position'. It's difficult to make any use of `base-size',
7060 ;; so we just ignore it.
7061 (unless (consp base-position)
7062 (message "Obsolete `base-size' passed to choose-completion-string")
7063 (setq base-position nil))
7065 (let* ((buffer (or buffer completion-reference-buffer))
7066 (mini-p (minibufferp buffer)))
7067 ;; If BUFFER is a minibuffer, barf unless it's the currently
7068 ;; active minibuffer.
7069 (if (and mini-p
7070 (not (and (active-minibuffer-window)
7071 (equal buffer
7072 (window-buffer (active-minibuffer-window))))))
7073 (error "Minibuffer is not active for completion")
7074 ;; Set buffer so buffer-local choose-completion-string-functions works.
7075 (set-buffer buffer)
7076 (unless (run-hook-with-args-until-success
7077 'choose-completion-string-functions
7078 ;; The fourth arg used to be `mini-p' but was useless
7079 ;; (since minibufferp can be used on the `buffer' arg)
7080 ;; and indeed unused. The last used to be `base-size', so we
7081 ;; keep it to try and avoid breaking old code.
7082 choice buffer base-position nil)
7083 ;; This remove-text-properties should be unnecessary since `choice'
7084 ;; comes from buffer-substring-no-properties.
7085 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7086 ;; Insert the completion into the buffer where it was requested.
7087 (funcall (or insert-function completion-list-insert-choice-function)
7088 (or (car base-position) (point))
7089 (or (cadr base-position) (point))
7090 choice)
7091 ;; Update point in the window that BUFFER is showing in.
7092 (let ((window (get-buffer-window buffer t)))
7093 (set-window-point window (point)))
7094 ;; If completing for the minibuffer, exit it with this choice.
7095 (and (not completion-no-auto-exit)
7096 (minibufferp buffer)
7097 minibuffer-completion-table
7098 ;; If this is reading a file name, and the file name chosen
7099 ;; is a directory, don't exit the minibuffer.
7100 (let* ((result (buffer-substring (field-beginning) (point)))
7101 (bounds
7102 (completion-boundaries result minibuffer-completion-table
7103 minibuffer-completion-predicate
7104 "")))
7105 (if (eq (car bounds) (length result))
7106 ;; The completion chosen leads to a new set of completions
7107 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7108 (let ((mini (active-minibuffer-window)))
7109 (select-window mini)
7110 (when minibuffer-auto-raise
7111 (raise-frame (window-frame mini))))
7112 (exit-minibuffer))))))))
7114 (define-derived-mode completion-list-mode nil "Completion List"
7115 "Major mode for buffers showing lists of possible completions.
7117 to select the completion near point.
7119 with the mouse.
7122 (set (make-local-variable 'completion-base-size) nil))
7124 (defun completion-list-mode-finish ()
7125 "Finish setup of the completions buffer.
7126 Called from `temp-buffer-show-hook'."
7127 (when (eq major-mode 'completion-list-mode)
7128 (setq buffer-read-only t)))
7130 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7133 ;; Variables and faces used in `completion-setup-function'.
7135 (defcustom completion-show-help t
7136 "Non-nil means show help message in *Completions* buffer."
7137 :type 'boolean
7138 :version "22.1"
7139 :group 'completion)
7141 ;; This function goes in completion-setup-hook, so that it is called
7142 ;; after the text of the completion list buffer is written.
7143 (defun completion-setup-function ()
7144 (let* ((mainbuf (current-buffer))
7145 (base-dir
7146 ;; FIXME: This is a bad hack. We try to set the default-directory
7147 ;; in the *Completions* buffer so that the relative file names
7148 ;; displayed there can be treated as valid file names, independently
7149 ;; from the completion context. But this suffers from many problems:
7150 ;; - It's not clear when the completions are file names. With some
7151 ;; completion tables (e.g. bzr revision specs), the listed
7152 ;; completions can mix file names and other things.
7153 ;; - It doesn't pay attention to possible quoting.
7154 ;; - With fancy completion styles, the code below will not always
7155 ;; find the right base directory.
7156 (if minibuffer-completing-file-name
7157 (file-name-as-directory
7158 (expand-file-name
7159 (buffer-substring (minibuffer-prompt-end)
7160 (- (point) (or completion-base-size 0))))))))
7161 (with-current-buffer standard-output
7162 (let ((base-size completion-base-size) ;Read before killing localvars.
7163 (base-position completion-base-position)
7164 (insert-fun completion-list-insert-choice-function))
7165 (completion-list-mode)
7166 (set (make-local-variable 'completion-base-size) base-size)
7167 (set (make-local-variable 'completion-base-position) base-position)
7168 (set (make-local-variable 'completion-list-insert-choice-function)
7169 insert-fun))
7170 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7171 (if base-dir (setq default-directory base-dir))
7172 ;; Maybe insert help string.
7173 (when completion-show-help
7174 (goto-char (point-min))
7175 (if (display-mouse-p)
7176 (insert (substitute-command-keys
7178 (insert (substitute-command-keys
7182 (add-hook 'completion-setup-hook 'completion-setup-function)
7184 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7185 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7187 (defun switch-to-completions ()
7188 "Select the completion list window."
7189 (interactive)
7190 (let ((window (or (get-buffer-window "*Completions*" 0)
7191 ;; Make sure we have a completions window.
7192 (progn (minibuffer-completion-help)
7193 (get-buffer-window "*Completions*" 0)))))
7194 (when window
7195 (select-window window)
7196 ;; In the new buffer, go to the first completion.
7197 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
7198 (when (bobp)
7199 (next-completion 1)))))
7200 \f
7201 ;;; Support keyboard commands to turn on various modifiers.
7203 ;; These functions -- which are not commands -- each add one modifier
7204 ;; to the following event.
7206 (defun event-apply-alt-modifier (_ignore-prompt)
7209 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
7210 (defun event-apply-super-modifier (_ignore-prompt)
7213 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
7214 (defun event-apply-hyper-modifier (_ignore-prompt)
7217 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
7218 (defun event-apply-shift-modifier (_ignore-prompt)
7221 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
7222 (defun event-apply-control-modifier (_ignore-prompt)
7225 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
7226 (defun event-apply-meta-modifier (_ignore-prompt)
7229 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
7231 (defun event-apply-modifier (event symbol lshiftby prefix)
7232 "Apply a modifier flag to event EVENT.
7233 SYMBOL is the name of this modifier, as a symbol.
7234 LSHIFTBY is the numeric value of this modifier, in keyboard events.
7235 PREFIX is the string that represents this modifier in an event type symbol."
7236 (if (numberp event)
7237 (cond ((eq symbol 'control)
7238 (if (and (<= (downcase event) ?z)
7239 (>= (downcase event) ?a))
7240 (- (downcase event) ?a -1)
7241 (if (and (<= (downcase event) ?Z)
7242 (>= (downcase event) ?A))
7243 (- (downcase event) ?A -1)
7244 (logior (lsh 1 lshiftby) event))))
7245 ((eq symbol 'shift)
7246 (if (and (<= (downcase event) ?z)
7247 (>= (downcase event) ?a))
7248 (upcase event)
7249 (logior (lsh 1 lshiftby) event)))
7250 (t
7251 (logior (lsh 1 lshiftby) event)))
7252 (if (memq symbol (event-modifiers event))
7253 event
7254 (let ((event-type (if (symbolp event) event (car event))))
7255 (setq event-type (intern (concat prefix (symbol-name event-type))))
7256 (if (symbolp event)
7257 event-type
7258 (cons event-type (cdr event)))))))
7260 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
7261 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
7262 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
7263 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
7264 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
7265 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
7266 \f
7267 ;;;; Keypad support.
7269 ;; Make the keypad keys act like ordinary typing keys. If people add
7270 ;; bindings for the function key symbols, then those bindings will
7271 ;; override these, so this shouldn't interfere with any existing
7272 ;; bindings.
7274 ;; Also tell read-char how to handle these keys.
7275 (mapc
7276 (lambda (keypad-normal)
7277 (let ((keypad (nth 0 keypad-normal))
7278 (normal (nth 1 keypad-normal)))
7279 (put keypad 'ascii-character normal)
7280 (define-key function-key-map (vector keypad) (vector normal))))
7281 ;; See also kp-keys bound in bindings.el.
7282 '((kp-space ?\s)
7285 (kp-separator ?,)
7286 (kp-equal ?=)
7287 ;; Do the same for various keys that are represented as symbols under
7288 ;; GUIs but naturally correspond to characters.
7289 (backspace 127)
7290 (delete 127)
7293 (clear ?\C-l)
7294 (return ?\C-m)
7295 (escape ?\e)
7296 ))
7297 \f
7298 ;;;;
7299 ;;;; forking a twin copy of a buffer.
7300 ;;;;
7302 (defvar clone-buffer-hook nil
7303 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7305 (defvar clone-indirect-buffer-hook nil
7306 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7308 (defun clone-process (process &optional newname)
7309 "Create a twin copy of PROCESS.
7310 If NEWNAME is nil, it defaults to PROCESS' name;
7311 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7312 If PROCESS is associated with a buffer, the new process will be associated
7313 with the current buffer instead.
7314 Returns nil if PROCESS has already terminated."
7315 (setq newname (or newname (process-name process)))
7317 (setq newname (substring newname 0 (match-beginning 0))))
7318 (when (memq (process-status process) '(run stop open))
7319 (let* ((process-connection-type (process-tty-name process))
7320 (new-process
7321 (if (memq (process-status process) '(open))
7322 (let ((args (process-contact process t)))
7323 (setq args (plist-put args :name newname))
7324 (setq args (plist-put args :buffer
7325 (if (process-buffer process)
7326 (current-buffer))))
7327 (apply 'make-network-process args))
7328 (apply 'start-process newname
7329 (if (process-buffer process) (current-buffer))
7330 (process-command process)))))
7331 (set-process-query-on-exit-flag
7332 new-process (process-query-on-exit-flag process))
7333 (set-process-inherit-coding-system-flag
7334 new-process (process-inherit-coding-system-flag process))
7335 (set-process-filter new-process (process-filter process))
7336 (set-process-sentinel new-process (process-sentinel process))
7337 (set-process-plist new-process (copy-sequence (process-plist process)))
7338 new-process)))
7340 ;; things to maybe add (currently partly covered by `funcall mode'):
7341 ;; - syntax-table
7342 ;; - overlays
7343 (defun clone-buffer (&optional newname display-flag)
7344 "Create and return a twin copy of the current buffer.
7345 Unlike an indirect buffer, the new buffer can be edited
7346 independently of the old one (if it is not read-only).
7347 NEWNAME is the name of the new buffer. It may be modified by
7348 adding or incrementing <N> at the end as necessary to create a
7349 unique buffer name. If nil, it defaults to the name of the
7350 current buffer, with the proper suffix. If DISPLAY-FLAG is
7351 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7352 clone a file-visiting buffer, or a buffer whose major mode symbol
7353 has a non-nil `no-clone' property, results in an error.
7355 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7356 current buffer with appropriate suffix. However, if a prefix
7357 argument is given, then the command prompts for NEWNAME in the
7358 minibuffer.
7360 This runs the normal hook `clone-buffer-hook' in the new buffer
7361 after it has been set up properly in other respects."
7362 (interactive
7363 (progn
7364 (if buffer-file-name
7365 (error "Cannot clone a file-visiting buffer"))
7366 (if (get major-mode 'no-clone)
7367 (error "Cannot clone a buffer in %s mode" mode-name))
7368 (list (if current-prefix-arg
7369 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7370 t)))
7371 (if buffer-file-name
7372 (error "Cannot clone a file-visiting buffer"))
7373 (if (get major-mode 'no-clone)
7374 (error "Cannot clone a buffer in %s mode" mode-name))
7375 (setq newname (or newname (buffer-name)))
7377 (setq newname (substring newname 0 (match-beginning 0))))
7378 (let ((buf (current-buffer))
7379 (ptmin (point-min))
7380 (ptmax (point-max))
7381 (pt (point))
7382 (mk (if mark-active (mark t)))
7383 (modified (buffer-modified-p))
7384 (mode major-mode)
7385 (lvars (buffer-local-variables))
7386 (process (get-buffer-process (current-buffer)))
7387 (new (generate-new-buffer (or newname (buffer-name)))))
7388 (save-restriction
7389 (widen)
7390 (with-current-buffer new
7391 (insert-buffer-substring buf)))
7392 (with-current-buffer new
7393 (narrow-to-region ptmin ptmax)
7394 (goto-char pt)
7395 (if mk (set-mark mk))
7396 (set-buffer-modified-p modified)
7398 ;; Clone the old buffer's process, if any.
7399 (when process (clone-process process))
7401 ;; Now set up the major mode.
7402 (funcall mode)
7404 ;; Set up other local variables.
7405 (mapc (lambda (v)
7406 (condition-case () ;in case var is read-only
7407 (if (symbolp v)
7408 (makunbound v)
7409 (set (make-local-variable (car v)) (cdr v)))
7410 (error nil)))
7411 lvars)
7413 ;; Run any hooks (typically set up by the major mode
7414 ;; for cloning to work properly).
7415 (run-hooks 'clone-buffer-hook))
7416 (if display-flag
7417 ;; Presumably the current buffer is shown in the selected frame, so
7418 ;; we want to display the clone elsewhere.
7419 (let ((same-window-regexps nil)
7420 (same-window-buffer-names))
7421 (pop-to-buffer new)))
7422 new))
7425 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7426 "Create an indirect buffer that is a twin copy of the current buffer.
7428 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7429 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7430 or if not called with a prefix arg, NEWNAME defaults to the current
7431 buffer's name. The name is modified by adding a `<N>' suffix to it
7432 or by incrementing the N in an existing suffix. Trying to clone a
7433 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7434 property results in an error.
7436 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7437 This is always done when called interactively.
7439 Optional third arg NORECORD non-nil means do not put this buffer at the
7440 front of the list of recently selected ones."
7441 (interactive
7442 (progn
7443 (if (get major-mode 'no-clone-indirect)
7444 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7445 (list (if current-prefix-arg
7446 (read-buffer "Name of indirect buffer: " (current-buffer)))
7447 t)))
7448 (if (get major-mode 'no-clone-indirect)
7449 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7450 (setq newname (or newname (buffer-name)))
7452 (setq newname (substring newname 0 (match-beginning 0))))
7453 (let* ((name (generate-new-buffer-name newname))
7454 (buffer (make-indirect-buffer (current-buffer) name t)))
7455 (with-current-buffer buffer
7456 (run-hooks 'clone-indirect-buffer-hook))
7457 (when display-flag
7458 (pop-to-buffer buffer norecord))
7459 buffer))
7462 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7463 "Like `clone-indirect-buffer' but display in another window."
7464 (interactive
7465 (progn
7466 (if (get major-mode 'no-clone-indirect)
7467 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7468 (list (if current-prefix-arg
7469 (read-buffer "Name of indirect buffer: " (current-buffer)))
7470 t)))
7471 (let ((pop-up-windows t))
7472 (clone-indirect-buffer newname display-flag norecord)))
7474 \f
7475 ;;; Handling of Backspace and Delete keys.
7477 (defcustom normal-erase-is-backspace 'maybe
7478 "Set the default behavior of the Delete and Backspace keys.
7480 If set to t, Delete key deletes forward and Backspace key deletes
7481 backward.
7483 If set to nil, both Delete and Backspace keys delete backward.
7485 If set to 'maybe (which is the default), Emacs automatically
7486 selects a behavior. On window systems, the behavior depends on
7487 the keyboard used. If the keyboard has both a Backspace key and
7488 a Delete key, and both are mapped to their usual meanings, the
7489 option's default value is set to t, so that Backspace can be used
7490 to delete backward, and Delete can be used to delete forward.
7492 If not running under a window system, customizing this option
7493 accomplishes a similar effect by mapping C-h, which is usually
7494 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7495 via `keyboard-translate'. The former functionality of C-h is
7496 available on the F1 key. You should probably not use this
7497 setting if you don't have both Backspace, Delete and F1 keys.
7499 Setting this variable with setq doesn't take effect. Programmatically,
7500 call `normal-erase-is-backspace-mode' (which see) instead."
7501 :type '(choice (const :tag "Off" nil)
7502 (const :tag "Maybe" maybe)
7503 (other :tag "On" t))
7504 :group 'editing-basics
7505 :version "21.1"
7506 :set (lambda (symbol value)
7507 ;; The fboundp is because of a problem with :set when
7508 ;; dumping Emacs. It doesn't really matter.
7509 (if (fboundp 'normal-erase-is-backspace-mode)
7510 (normal-erase-is-backspace-mode (or value 0))
7511 (set-default symbol value))))
7513 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7514 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7515 (unless frame (setq frame (selected-frame)))
7516 (with-selected-frame frame
7517 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7518 (normal-erase-is-backspace-mode
7519 (if (if (eq normal-erase-is-backspace 'maybe)
7520 (and (not noninteractive)
7521 (or (memq system-type '(ms-dos windows-nt))
7522 (memq window-system '(w32 ns))
7523 (and (memq window-system '(x))
7524 (fboundp 'x-backspace-delete-keys-p)
7525 (x-backspace-delete-keys-p))
7526 ;; If the terminal Emacs is running on has erase char
7527 ;; set to ^H, use the Backspace key for deleting
7528 ;; backward, and the Delete key for deleting forward.
7529 (and (null window-system)
7530 (eq tty-erase-char ?\^H))))
7531 normal-erase-is-backspace)
7532 1 0)))))
7534 (define-minor-mode normal-erase-is-backspace-mode
7535 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7536 With a prefix argument ARG, enable this feature if ARG is
7537 positive, and disable it otherwise. If called from Lisp, enable
7538 the mode if ARG is omitted or nil.
7540 On window systems, when this mode is on, Delete is mapped to C-d
7541 and Backspace is mapped to DEL; when this mode is off, both
7542 Delete and Backspace are mapped to DEL. (The remapping goes via
7543 `local-function-key-map', so binding Delete or Backspace in the
7544 global or local keymap will override that.)
7546 In addition, on window systems, the bindings of C-Delete, M-Delete,
7547 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7548 the global keymap in accordance with the functionality of Delete and
7549 Backspace. For example, if Delete is remapped to C-d, which deletes
7550 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7551 to DEL, which deletes backward, C-Delete is bound to
7552 `backward-kill-word'.
7554 If not running on a window system, a similar effect is accomplished by
7555 remapping C-h (normally produced by the Backspace key) and DEL via
7556 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7557 to C-d; if it's off, the keys are not remapped.
7559 When not running on a window system, and this mode is turned on, the
7560 former functionality of C-h is available on the F1 key. You should
7561 probably not turn on this mode on a text-only terminal if you don't
7562 have both Backspace, Delete and F1 keys.
7564 See also `normal-erase-is-backspace'."
7565 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7566 . (lambda (v)
7567 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7568 (if v 1 0))))
7569 (let ((enabled (eq 1 (terminal-parameter
7570 nil 'normal-erase-is-backspace))))
7572 (cond ((or (memq window-system '(x w32 ns pc))
7573 (memq system-type '(ms-dos windows-nt)))
7574 (let ((bindings
7575 `(([M-delete] [M-backspace])
7576 ([C-M-delete] [C-M-backspace])
7577 ([?\e C-delete] [?\e C-backspace]))))
7579 (if enabled
7580 (progn
7581 (define-key local-function-key-map [delete] [deletechar])
7582 (define-key local-function-key-map [kp-delete] [deletechar])
7583 (define-key local-function-key-map [backspace] [?\C-?])
7584 (dolist (b bindings)
7585 ;; Not sure if input-decode-map is really right, but
7586 ;; keyboard-translate-table (used below) only works
7587 ;; for integer events, and key-translation-table is
7588 ;; global (like the global-map, used earlier).
7589 (define-key input-decode-map (car b) nil)
7590 (define-key input-decode-map (cadr b) nil)))
7591 (define-key local-function-key-map [delete] [?\C-?])
7592 (define-key local-function-key-map [kp-delete] [?\C-?])
7593 (define-key local-function-key-map [backspace] [?\C-?])
7594 (dolist (b bindings)
7595 (define-key input-decode-map (car b) (cadr b))
7596 (define-key input-decode-map (cadr b) (car b))))))
7597 (t
7598 (if enabled
7599 (progn
7600 (keyboard-translate ?\C-h ?\C-?)
7601 (keyboard-translate ?\C-? ?\C-d))
7602 (keyboard-translate ?\C-h ?\C-h)
7603 (keyboard-translate ?\C-? ?\C-?))))
7605 (if (called-interactively-p 'interactive)
7606 (message "Delete key deletes %s"
7607 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7608 "forward" "backward")))))
7609 \f
7610 (defvar vis-mode-saved-buffer-invisibility-spec nil
7611 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7613 (define-minor-mode read-only-mode
7614 "Change whether the current buffer is read-only.
7615 With prefix argument ARG, make the buffer read-only if ARG is
7616 positive, otherwise make it writable. If buffer is read-only
7617 and `view-read-only' is non-nil, enter view mode.
7619 Do not call this from a Lisp program unless you really intend to
7621 possibly enabling or disabling View mode. Also, note that this
7622 command works by setting the variable `buffer-read-only', which
7623 does not affect read-only regions caused by text properties. To
7624 ignore read-only status in a Lisp program (whether due to text
7625 properties or buffer state), bind `inhibit-read-only' temporarily
7626 to a non-nil value."
7627 :variable buffer-read-only
7628 (cond
7629 ((and (not buffer-read-only) view-mode)
7630 (View-exit-and-edit)
7631 (make-local-variable 'view-read-only)
7632 (setq view-read-only t)) ; Must leave view mode.
7633 ((and buffer-read-only view-read-only
7634 ;; If view-mode is already active, `view-mode-enter' is a nop.
7635 (not view-mode)
7636 (not (eq (get major-mode 'mode-class) 'special)))
7637 (view-mode-enter))))
7639 (define-minor-mode visible-mode
7640 "Toggle making all invisible text temporarily visible (Visible mode).
7641 With a prefix argument ARG, enable Visible mode if ARG is
7642 positive, and disable it otherwise. If called from Lisp, enable
7643 the mode if ARG is omitted or nil.
7645 This mode works by saving the value of `buffer-invisibility-spec'
7646 and setting it to nil."
7647 :lighter " Vis"
7648 :group 'editing-basics
7649 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7650 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7651 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7652 (when visible-mode
7653 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7654 buffer-invisibility-spec)
7655 (setq buffer-invisibility-spec nil)))
7656 \f
7657 (defvar messages-buffer-mode-map
7658 (let ((map (make-sparse-keymap)))
7659 (set-keymap-parent map special-mode-map)
7660 (define-key map "g" nil) ; nothing to revert
7661 map))
7663 (define-derived-mode messages-buffer-mode special-mode "Messages"
7666 (defun messages-buffer ()
7668 If it does not exist, create and it switch it to `messages-buffer-mode'."
7669 (or (get-buffer "*Messages*")
7670 (with-current-buffer (get-buffer-create "*Messages*")
7671 (messages-buffer-mode)
7672 (current-buffer))))
7674 \f
7675 ;; Minibuffer prompt stuff.
7677 ;;(defun minibuffer-prompt-modification (start end)
7678 ;; (error "You cannot modify the prompt"))
7679 ;;
7680 ;;
7681 ;;(defun minibuffer-prompt-insertion (start end)
7682 ;; (let ((inhibit-modification-hooks t))
7683 ;; (delete-region start end)
7684 ;; ;; Discard undo information for the text insertion itself
7685 ;; ;; and for the text deletion.above.
7686 ;; (when (consp buffer-undo-list)
7687 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7688 ;; (message "You cannot modify the prompt")))
7689 ;;
7690 ;;
7691 ;;(setq minibuffer-prompt-properties
7692 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7693 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7695 \f
7696 ;;;; Problematic external packages.
7698 ;; rms says this should be done by specifying symbols that define
7699 ;; versions together with bad values. This is therefore not as
7700 ;; flexible as it could be. See the thread:
7701 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7702 (defconst bad-packages-alist
7703 ;; Not sure exactly which semantic versions have problems.
7704 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7706 "The version of `semantic' loaded does not work in Emacs 22.
7707 It can cause constant high CPU load.
7708 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7709 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7710 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7711 ;; provided the `CUA-mode' feature. Since this is no longer true,
7712 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7713 (CUA-mode t nil
7714 "CUA-mode is now part of the standard GNU Emacs distribution,
7715 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7717 You have loaded an older version of CUA-mode which does not work
7718 correctly with this version of Emacs. You should remove the old
7719 version and use the one distributed with Emacs."))
7720 "Alist of packages known to cause problems in this version of Emacs.
7721 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7722 PACKAGE is either a regular expression to match file names, or a
7723 symbol (a feature name), like for `with-eval-after-load'.
7724 SYMBOL is either the name of a string variable, or `t'. Upon
7725 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7726 warning using STRING as the message.")
7728 (defun bad-package-check (package)
7729 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7730 (condition-case nil
7731 (let* ((list (assoc package bad-packages-alist))
7732 (symbol (nth 1 list)))
7733 (and list
7734 (boundp symbol)
7735 (or (eq symbol t)
7736 (and (stringp (setq symbol (eval symbol)))
7737 (string-match-p (nth 2 list) symbol)))
7738 (display-warning package (nth 3 list) :warning)))
7739 (error nil)))
7741 (dolist (elem bad-packages-alist)
7742 (let ((pkg (car elem)))
7743 (with-eval-after-load pkg
7744 (bad-package-check pkg))))
7746 \f
7747 ;;; Generic dispatcher commands
7749 ;; Macro `define-alternatives' is used to create generic commands.
7750 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
7751 ;; that can have different alternative implementations where choosing
7752 ;; among them is exclusively a matter of user preference.
7754 ;; (define-alternatives COMMAND) creates a new interactive command
7755 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
7756 ;; Typically, the user will not need to customize this variable; packages
7757 ;; wanting to add alternative implementations should use
7758 ;;
7759 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
7761 (defmacro define-alternatives (command &rest customizations)
7762 "Define the new command `COMMAND'.
7764 The argument `COMMAND' should be a symbol.
7766 Running `M-x COMMAND RET' for the first time prompts for which
7767 alternative to use and records the selected command as a custom
7768 variable.
7770 Running `C-u M-x COMMAND RET' prompts again for an alternative
7771 and overwrites the previous choice.
7773 The variable `COMMAND-alternatives' contains an alist with
7774 alternative implementations of COMMAND. `define-alternatives'
7775 does not have any effect until this variable is set.
7777 CUSTOMIZATIONS, if non-nil, should be composed of alternating
7778 `defcustom' keywords and values to add to the declaration of
7779 `COMMAND-alternatives' (typically :group and :version)."
7780 (let* ((command-name (symbol-name command))
7781 (varalt-name (concat command-name "-alternatives"))
7782 (varalt-sym (intern varalt-name))
7783 (varimp-sym (intern (concat command-name "--implementation"))))
7784 `(progn
7786 (defcustom ,varalt-sym nil
7787 ,(format "Alist of alternative implementations for the `%s' command.
7789 Each entry must be a pair (ALTNAME . ALTFUN), where:
7790 ALTNAME - The name shown at user to describe the alternative implementation.
7791 ALTFUN - The function called to implement this alternative."
7792 command-name)
7793 :type '(alist :key-type string :value-type function)
7794 ,@customizations)
7796 (put ',varalt-sym 'definition-name ',command)
7797 (defvar ,varimp-sym nil "Internal use only.")
7799 (defun ,command (&optional arg)
7800 ,(format "Run generic command `%s'.
7801 If used for the first time, or with interactive ARG, ask the user which
7802 implementation to use for `%s'. The variable `%s'
7803 contains the list of implementations currently supported for this command."
7804 command-name command-name varalt-name)
7805 (interactive "P")
7806 (when (or arg (null ,varimp-sym))
7807 (let ((val (completing-read
7808 ,(format "Select implementation for command `%s': "
7809 command-name)
7810 ,varalt-sym nil t)))
7811 (unless (string-equal val "")
7812 (when (null ,varimp-sym)
7813 (message
7814 "Use `C-u M-x %s RET' to select another implementation"
7815 ,command-name)
7816 (sit-for 3))
7817 (customize-save-variable ',varimp-sym
7818 (cdr (assoc-string val ,varalt-sym))))))
7819 (if ,varimp-sym
7820 (call-interactively ,varimp-sym)
7821 (message ,(format "No implementation selected for command `%s'"
7822 command-name)))))))
7824 \f
7826 (provide 'simple)
7828 ;;; simple.el ends here