| blob | 3fefce15d2a7d43a1c641ff83c590924405882aa |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2013 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
34 ;;; From compile.el
39 "Idle time delay before updating various things on the screen.
40 Various Emacs features that update auxiliary information when point moves
41 wait this many seconds after Emacs becomes idle before doing an update."
47 "Killing and yanking commands."
51 "Highlight (un)matching of parens and expressions."
53 \f
54 ;;; next-error support framework
57 "`next-error' support framework."
63 "Face used to highlight next error locus."
68 "Highlighting of locations in selected source buffers.
69 If a number, highlight the locus in `next-error' face for the given time
70 in seconds, or until the next command is executed.
71 If t, highlight the locus until the next command is executed, or until
72 some other locus replaces it.
73 If nil, don't highlight the locus in the source buffer.
74 If `fringe-arrow', indicate the locus by the fringe arrow
75 indefinitely until some other locus replaces it."
84 "Highlighting of locations in `next-error-no-select'.
85 If number, highlight the locus in `next-error' face for given time in seconds.
86 If t, highlight the locus indefinitely until some other locus replaces it.
87 If nil, don't highlight the locus in the source buffer.
88 If `fringe-arrow', indicate the locus by the fringe arrow
89 indefinitely until some other locus replaces it."
98 "Display the line in the visited source file recentered as specified.
99 If non-nil, the value is passed directly to `recenter'."
107 "List of hook functions run by `next-error' after visiting source file."
118 "The most recent `next-error' buffer.
119 A buffer becomes most recent when its compilation, grep, or
124 "Function to use to find the next error in the current buffer.
125 The function is called with 2 parameters:
126 ARG is an integer specifying by how many errors to move.
127 RESET is a boolean which, if non-nil, says to go back to the beginning
128 of the errors before moving.
129 Major modes providing compile-like functionality should set this variable
130 to indicate to `next-error' that this is a candidate buffer and how
135 "Function to use to move to an error locus.
136 It takes two arguments, a buffer position in the error buffer
137 and a buffer position in the error locus buffer.
138 The buffer for the error locus should already be current.
143 &optional avoid-current
144 extra-test-inclusive
145 extra-test-exclusive)
146 "Test if BUFFER is a `next-error' capable buffer.
148 If AVOID-CURRENT is non-nil, treat the current buffer
149 as an absolute last resort only.
151 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
152 that normally would not qualify. If it returns t, the buffer
153 in question is treated as usable.
155 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
156 that would normally be considered usable. If it returns nil,
157 that buffer is rejected."
162 ;; Optionally reject some buffers.
165 t)
166 ;; Optionally accept some other buffers.
171 extra-test-inclusive
172 extra-test-exclusive)
173 "Return a `next-error' capable buffer.
175 If AVOID-CURRENT is non-nil, treat the current buffer
176 as an absolute last resort only.
178 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
179 that normally would not qualify. If it returns t, the buffer
180 in question is treated as usable.
182 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
183 that would normally be considered usable. If it returns nil,
184 that buffer is rejected."
186 ;; 1. If one window on the selected frame displays such buffer, return it.
192 avoid-current
193 extra-test-inclusive extra-test-exclusive)
198 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
201 extra-test-inclusive extra-test-exclusive))
202 next-error-last-buffer)
203 ;; 3. If the current buffer is acceptable, choose it.
205 extra-test-inclusive extra-test-exclusive)
207 ;; 4. Look for any acceptable buffer.
212 extra-test-inclusive extra-test-exclusive)))
215 ;; 5. Use the current buffer as a last resort if it qualifies,
216 ;; even despite AVOID-CURRENT.
219 extra-test-inclusive extra-test-exclusive)
223 ;; 6. Give up.
227 "Visit next `next-error' message and corresponding source code.
229 If all the error messages parsed so far have been processed already,
230 the message buffer is checked for new ones.
232 A prefix ARG specifies how many error messages to move;
233 negative means move back to previous error messages.
235 and start at the first error.
237 The RESET argument specifies that we should restart from the beginning.
240 compilation, grep, or occur buffer. It can also operate on any
242 more generally, on any buffer in Compilation mode or with
243 Compilation Minor mode enabled, or any buffer in which
244 `next-error-function' is bound to an appropriate function.
245 To specify use of a particular buffer for error messages, type
247 in the current frame.
250 runs `next-error-hook' with `run-hooks', and stays with that buffer
251 until you use it in some other buffer which uses Compilation mode
252 or Compilation Minor mode.
254 To control which errors are matched, customize the variable
255 `compilation-error-regexp-alist'."
259 ;; we know here that next-error-function is a valid symbol we can funcall
267 "Visit the source code corresponding to the `next-error' message at point."
269 ;; we know here that next-error-function is a valid symbol we can funcall
280 "Visit previous `next-error' message and corresponding source code.
282 Prefix arg N says how many error messages to move backwards (or
283 forwards, if negative).
290 "Restart at the first error.
291 Visit corresponding source code.
292 With prefix arg N, visit the source code of the Nth error.
298 "Move point to the next error in the `next-error' buffer and highlight match.
299 Prefix arg N says how many error messages to move forwards (or
300 backwards, if negative).
302 select the source buffer."
309 "Move point to the previous error in the `next-error' buffer and highlight match.
310 Prefix arg N says how many error messages to move backwards (or
311 forwards, if negative).
313 select the source buffer."
317 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
321 "Minor mode for compilation, occur and diff modes.
322 With a prefix argument ARG, enable mode if ARG is positive, and
323 disable it otherwise. If called from Lisp, enable mode if ARG is
324 omitted or nil.
325 When turned on, cursor motion in the compilation, grep, occur or diff
326 buffer causes automatic display of the corresponding source code location."
333 ;; Used as a `post-command-hook' by `next-error-follow-mode'
334 ;; for the *Compilation* *grep* and *Occur* buffers.
344 \f
345 ;;;
348 "Major mode not specialized for anything in particular.
349 Other major modes are defined by comparison with this one."
354 ;; Special major modes to view specially formatted data rather than files.
368 map))
372 "Parent major mode from which special major modes should inherit."
375 ;; Making and deleting lines.
381 "Insert a newline, and move to left margin of the new line if it's blank.
382 If option `use-hard-newlines' is non-nil, the newline is marked with the
383 text-property `hard'.
384 With ARG, insert that many newlines.
385 Call `auto-fill-function' if the current column number is greater
386 than the value of `fill-column' and ARG is nil.
387 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
390 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
391 ;; Set last-command-event to tell self-insert what to insert.
395 ;; Don't auto-fill if we have a numeric argument.
398 ;; Do the rest in post-self-insert-hook, because we want to do it
399 ;; *before* other functions on that hook.
401 ;; Mark the newline(s) `hard'.
405 ;; If the newline leaves the previous line blank, and we
406 ;; have a left margin, delete that from the blank line.
414 ;; Indent the line after the newline, except in one case:
415 ;; when we added the newline at the beginning of a line which
416 ;; starts a page.
420 ;; FIXME: For non-interactive uses, many calls actually just want
421 ;; (insert "\n"), so maybe we should do just that, so as to avoid
422 ;; the risk of filling or running abbrevs unexpectedly.
429 ;; We first used let-binding to protect the hook, but that was naive
430 ;; since add-hook affects the symbol-default value of the variable,
431 ;; whereas the let-binding might only protect the buffer-local value.
433 nil)
438 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
444 "Insert a newline and leave point before it.
445 If there is a fill prefix and/or a `left-margin', insert them
446 on the new line if the line would have been blank.
447 With arg N, insert N newlines."
452 ;; Don't expand an abbrev before point.
466 "Split current line, moving portion beyond point vertically down.
467 If the current line starts with `fill-prefix', insert it on the new
468 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
470 When called from Lisp code, ARG may be a prefix string to copy."
475 ;; What prefix should we check for (nil means don't).
479 ;; Does this line start with it?
490 "Join this line to previous and fix up whitespace at join.
491 If there is a fill prefix, delete it from the beginning of this line.
492 With argument, join this line to following line."
499 ;; If the second line started with the fill prefix,
500 ;; delete the prefix.
512 "On blank line, delete all surrounding blank lines, leaving just one.
513 On isolated blank line, delete that one.
514 On nonblank line, delete any immediately following blank lines."
520 ;; Set singleblank if there is just one blank line here.
527 ;; Delete preceding blank lines, and this one too if it's the only one.
536 ;; Delete following blank lines, unless the current line is blank
537 ;; and there are no following blank lines.
546 ;; Handle the special case where point is followed by newline and eob.
547 ;; Delete the line, leaving point at eob.
553 Trailing lines are deleted only if `delete-trailing-whitespace'
554 is called on the entire buffer (rather than an active region)."
560 "Delete trailing whitespace between START and END.
561 If called interactively, START and END are the start/end of the
562 region if the mark is active, or of the buffer's accessible
563 portion if the mark is inactive.
565 This command deletes whitespace characters after the last
566 non-whitespace character in each line between START and END. It
567 does not consider formfeed characters to be whitespace.
569 If this command acts on the entire buffer (i.e. if called
570 interactively with the mark inactive, or called from Lisp with
571 END nil), it also deletes all trailing lines at the end of the
572 buffer if the variable `delete-trailing-lines' is non-nil."
585 ;; Don't delete formfeeds, even if they are considered whitespace.
589 ;; Delete trailing empty lines.
592 delete-trailing-lines
593 ;; Really the end of buffer.
598 ;; Return nil for the benefit of `write-file-functions'.
599 nil)
602 "Insert a newline, then indent according to major mode.
603 Indentation is done using the value of `indent-line-function'.
604 In programming language modes, this is the same as TAB.
605 In some text modes, where TAB inserts a tab, this command indents to the
606 column specified by the function `current-left-margin'."
613 "Reindent current line, insert newline, then indent the new line.
614 Indentation of both lines is done according to the current major mode,
615 which means calling the current value of `indent-line-function'.
616 In programming language modes, this is the same as TAB.
617 In some text modes, where TAB inserts a tab, this indents to the
618 column specified by the function `current-left-margin'."
621 ;; Be careful to insert the newline before indenting the line.
622 ;; Otherwise, the indentation might be wrong.
626 ;; We are at EOL before the call to indent-according-to-mode, and
627 ;; after it we usually are as well, but not always. We tried to
628 ;; address it with `save-excursion' but that uses a normal marker
629 ;; whereas we need `move after insertion', so we do the save/restore
630 ;; by hand.
634 ;; Remove the trailing white-space after indentation because
635 ;; indentation may introduce the whitespace.
640 "Read next input character and insert it.
641 This is useful for inserting control characters.
642 With argument, insert ARG copies of the character.
644 If the first character you type after this command is an octal digit,
645 you should type a sequence of octal digits which specify a character code.
646 Any nondigit terminates the sequence. If the terminator is a RET,
647 it is discarded; any other terminator is used itself as input.
648 The variable `read-quoted-char-radix' specifies the radix for this feature;
649 set it to 10 or 16 to use decimal or hex instead of octal.
651 In overwrite mode, this function inserts the character anyway, and
652 does not handle octal digits specially. This means that if you use
653 overwrite as your normal editing mode, you can use this function to
654 insert characters when necessary.
656 In binary overwrite mode, this function does overwrite, and octal
657 digits are interpreted as a character code. This is intended to be
658 useful for editing binary files."
661 ;; Avoid "obsolete" warnings for translation-table-for-input.
668 ;; This used to assume character codes 0240 - 0377 stand for
669 ;; characters in some single-byte character set, and converted them
670 ;; to Emacs characters. But in 23.1 this feature is deprecated
671 ;; in favor of inserting the corresponding Unicode characters.
672 ;; (if (and enable-multibyte-characters
673 ;; (>= char ?\240)
674 ;; (<= char ?\377))
675 ;; (setq char (unibyte-char-to-multibyte char)))
684 "Move forward ARG lines and position at first nonblank character."
690 "Move backward ARG lines and position at first nonblank character."
696 "Move point to the first non-whitespace character on this line."
700 ;; Move back over chars that have whitespace syntax but have the p flag.
704 "Fixup white space between objects around point.
705 Leave one space or none, according to the context."
712 nil
716 "Delete all spaces and tabs around point.
717 If BACKWARD-ONLY is non-nil, only delete them before point."
722 orig-pos
731 "Delete all spaces and tabs around point, leaving one space (or N spaces).
732 If N is negative, delete newlines as well, leaving -N spaces."
737 "Store context used in consecutive calls to `cycle-spacing' command.
738 The first time this function is run, it saves the original point
739 position and original spacing around the point in this
743 "Manipulate spaces around the point in a smart way.
745 When run as an interactive command, the first time it's called
746 in a sequence, deletes all spaces and tabs around point leaving
747 one (or N spaces). If this does not change content of the
748 buffer, skips to the second step:
750 When run for the second time in a sequence, deletes all the
751 spaces it has previously inserted.
753 When run for the third time, returns the whitespace and point in
754 a state encountered when it had been run for the first time.
757 point, calling `cycle-spacing' command will replace two spaces with
758 a single space, calling it again immediately after, will remove all
759 spaces, and calling it for the third time will bring two spaces back
760 together.
762 If N is negative, delete newlines as well. However, if
763 PRESERVE-NL-BACK is t new line characters prior to the point
764 won't be removed.
766 If SINGLE-SHOT is non-nil, will only perform the first step. In
767 other words, it will work just like `just-one-space' command."
775 ;; Command run for the first time or single-shot is non-nil.
786 ;; Special handling for case where there was no space at all.
789 ;; If this run causes no change in buffer content, delete all spaces,
790 ;; otherwise delete all excess spaces.
795 ;; Command run for the second time.
799 ;; Command run for the third time.
804 \f
806 "Move point to the beginning of the buffer.
807 With numeric arg N, put point N/10 of the way from the beginning.
808 If the buffer is narrowed, this command uses the beginning of the
809 accessible part of the buffer.
811 If Transient Mark mode is disabled, leave mark at previous
814 Don't use this command in Lisp programs!
815 \(goto-char (point-min)) is faster."
824 ;; Avoid overflow for large buffer sizes!
832 "Move point to the end of the buffer.
833 With numeric arg N, put point N/10 of the way from the end.
834 If the buffer is narrowed, this command uses the end of the
835 accessible part of the buffer.
837 If Transient Mark mode is disabled, leave mark at previous
840 Don't use this command in Lisp programs!
841 \(goto-char (point-max)) is faster."
848 ;; Avoid overflow for large buffer sizes!
853 ;; If we went to a place in the middle of the buffer,
854 ;; adjust it to the beginning of a line.
858 ;; If the end of the buffer is not already on the screen,
859 ;; then scroll specially to put it near, but not at, the bottom.
864 "Whether single-char deletion commands delete an active region.
865 This has an effect only if Transient Mark mode is enabled, and
866 affects `delete-forward-char' and `delete-backward-char', though
867 not `delete-char'.
869 If the value is the symbol `kill', the active region is killed
870 instead of deleted."
878 "Delete the previous N characters (following if N is negative).
879 If Transient Mark mode is enabled, the mark is active, and N is 1,
880 delete the text in the region and deactivate the mark instead.
881 To disable this, set option `delete-active-region' to nil.
883 Optional second arg KILLFLAG, if non-nil, means to kill (save in
884 kill ring) instead of delete. Interactively, N is the prefix
885 arg, and KILLFLAG is set if N is explicitly specified.
887 In Overwrite mode, single character backward deletion may replace
888 tabs with spaces so as to back over columns, unless point is at
889 the end of the line."
894 delete-active-region
896 ;; If a region is active, kill or delete it.
900 ;; In Overwrite mode, maybe untabify while deleting
910 ;; Otherwise, do simple deletion.
914 "Delete the following N characters (previous if N is negative).
915 If Transient Mark mode is enabled, the mark is active, and N is 1,
916 delete the text in the region and deactivate the mark instead.
917 To disable this, set variable `delete-active-region' to nil.
919 Optional second arg KILLFLAG non-nil means to kill (save in kill
920 ring) instead of delete. Interactively, N is the prefix arg, and
921 KILLFLAG is set if N was explicitly specified."
926 delete-active-region
928 ;; If a region is active, kill or delete it.
932 ;; Otherwise, do simple deletion.
936 "Put point at beginning and mark at end of buffer.
937 If narrowing is in effect, only uses the accessible part of the buffer.
938 You probably should not use this function in Lisp programs;
939 it is usually a mistake for a Lisp function to use any subroutine
940 that uses or sets the mark."
945 \f
947 ;; Counting lines, one way or another.
950 "Go to LINE, counting from line 1 at beginning of buffer.
951 If called interactively, a numeric prefix argument specifies
952 LINE; without a numeric prefix argument, read LINE from the
953 minibuffer.
955 If optional argument BUFFER is non-nil, switch to that buffer and
957 as argument, BUFFER is the most recently selected other buffer.
959 Prior to moving point, this function sets the mark (without
960 activating it), unless Transient Mark mode is enabled and the
961 mark is already active.
963 This function is usually the wrong thing to use in a Lisp program.
964 What you probably want instead is something like:
965 (goto-char (point-min))
966 (forward-line (1- N))
967 If at all possible, an even better solution is to use char counts
968 rather than line counts."
972 ;; Look for a default, a number in the buffer at point.
982 ;; Decide if we're switching buffers.
990 ;; Read the argument, offering that number (if any) as default.
993 buffer))))
994 ;; Switch to the desired buffer, one way or another.
999 ;; Leave mark at previous position
1001 ;; Move to the specified line number in that buffer.
1010 "Count the number of words in the region.
1011 If called interactively, print a message reporting the number of
1012 lines, words, and characters in the region (whether or not the
1013 region is active); with prefix ARG, report for the entire buffer
1014 rather than the region.
1016 If called from Lisp, return the number of words between positions
1017 START and END."
1029 "Count words between START and END.
1030 If called interactively, START and END are normally the start and
1031 end of the buffer; but if the region is active, START and END are
1032 the start and end of the region. Print a message reporting the
1033 number of lines, words, and chars.
1035 If called from Lisp, return the number of words between START and
1036 END, without printing any message."
1046 words))
1062 str
1070 "Print the current buffer line number and narrowed line number of point."
1083 "Return number of lines between START and END.
1084 This is usually the number of newlines between them,
1085 but can be one more if START is not equal to END
1086 and the greater of them is not at the start of a line."
1102 done)))
1106 "Return (narrowed) buffer line number at position POS.
1107 If POS is nil, use current buffer location.
1108 Counting starts at (point-min), so the value refers
1109 to the contents of the accessible portion of the buffer."
1119 "Print info on cursor position (on screen and within buffer).
1120 Also describe the character after point, and give its character code
1121 in octal, decimal and hex.
1123 For a non-ASCII multibyte character, also give its encoding in the
1124 buffer's selected coding system if the coding system encodes the
1125 character safely. If the character is encoded into one byte, that
1126 code is shown in hex. If the character is encoded into more than one
1129 In addition, with prefix argument, show details about that character
1130 in *Help* buffer. See also the command `describe-char'."
1135 ;; If the character is one of LRE, LRO, RLE, RLO, it
1136 ;; will start a directional embedding, which could
1137 ;; completely disrupt the rest of the line (e.g., RLO
1138 ;; will display the rest of the line right-to-left).
1139 ;; So we put an invisible PDF character after these
1140 ;; characters, to end the embedding, which eliminates
1141 ;; any effects on the rest of the line.
1143 ;; Strong right-to-left characters cause reordering of
1144 ;; the following numerical characters which show the
1145 ;; codepoint, so append LRM to countermand that.
1155 ;; Avoid overflow from multiplying by 100!
1159 ""
1165 pos total percent beg end col hscroll)
1167 pos total col hscroll))
1169 encoded encoding-msg display-prop under-display)
1176 ;; Check if the character is displayed with some `display'
1177 ;; text property. In that case, set under-display to the
1178 ;; buffer substring covered by that property.
1189 under-display)))
1195 char char char under-display)
1197 char char char under-display display-prop))
1200 char char char
1202 "..."
1206 ;; We show the detailed information about CHAR.
1213 bidi-fixer
1214 encoding-msg pos total percent beg end col hscroll)
1221 bidi-fixer encoding-msg pos total percent col hscroll))))))
1222 \f
1223 ;; Initialize read-expression-map. It is defined at C level.
1227 ;; Might as well bind TAB to completion, since inserting a TAB char is
1228 ;; much too rarely useful.
1231 m))
1234 "Return a Lisp object read using the minibuffer, unevaluated.
1235 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1236 is a string to insert in the minibuffer before reading.
1237 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1238 Such arguments are used as in `read-from-minibuffer'.)"
1239 ;; Used for interactive spec `x'.
1244 "Return value of Lisp expression read using the minibuffer.
1245 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1246 is a string to insert in the minibuffer before reading.
1247 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1248 Such arguments are used as in `read-from-minibuffer'.)"
1249 ;; Used for interactive spec `X'.
1257 "The current default value or list of default values in the minibuffer.
1258 The functions `read-from-minibuffer' and `completing-read' bind
1262 "Value for `print-level' while printing value in `eval-expression'.
1263 A value of nil means no limit."
1269 "Value for `print-length' while printing value in `eval-expression'.
1270 A value of nil means no limit."
1276 "If non-nil set `debug-on-error' to t in `eval-expression'.
1277 If nil, don't change the value of `debug-on-error'."
1283 "Format VALUE as a result of evaluated expression.
1284 Return a formatted string which is displayed in the echo area
1285 in addition to the value printed by prin1 in functions which
1286 display the result of expression evaluation."
1310 read-expression-map t
1313 ;; We define this, rather than making `eval' interactive,
1314 ;; for the sake of completion of names like eval-region, eval-buffer.
1316 "Evaluate EXP and print value in the echo area.
1317 When called interactively, read an Emacs Lisp expression and
1318 evaluate it.
1319 Value is also consed on to front of the variable `values'.
1320 Optional argument INSERT-VALUE non-nil (interactively,
1321 with prefix argument) means insert the result into the current buffer
1322 instead of printing it in the echo area. Truncates long output
1323 according to the value of the variables `eval-expression-print-length'
1324 and `eval-expression-print-level'.
1326 If `eval-expression-debug-on-error' is non-nil, which is the default,
1327 this command arranges for all errors to enter the debugger."
1330 current-prefix-arg))
1335 ;; Bind debug-on-error to something unique so that we can
1336 ;; detect when evalled code changes it.
1340 ;; If evalled code has changed the value of debug-on-error,
1341 ;; propagate that change to the global binding.
1358 "Prompting with PROMPT, let user edit COMMAND and eval result.
1359 COMMAND is a Lisp expression. Let user edit that expression in
1360 the minibuffer, then read and evaluate the result."
1367 read-expression-map t
1369 ;; If command was added to command-history as a string,
1370 ;; get rid of that. We want only evaluable expressions there.
1374 ;; If command to be redone does not match front of history,
1375 ;; add it to the history.
1381 "Edit and re-evaluate last complex command, or ARGth from last.
1382 A complex command is one which used the minibuffer.
1383 The command is placed in the minibuffer as a Lisp form for editing.
1384 The result is executed, repeating the command as changed.
1385 If the command has been changed or is not the most recent previous
1386 command it is added to the front of the command history.
1387 You can use the minibuffer history commands \
1389 to get different commands to edit and resubmit."
1392 newcmd)
1404 ;; If command was added to command-history as a
1405 ;; string, get rid of that. We want only
1406 ;; evaluable expressions there.
1410 ;; If command to be redone does not match front of history,
1411 ;; add it to the history.
1416 ;; Trick called-interactively-p into thinking that `newcmd' is
1417 ;; an interactive call (bug#14136).
1436 "Read command name to invoke in `execute-extended-command'."
1441 ;; Get a command name at point in the original buffer
1442 ;; to propose it after M-n.
1446 ;; Read a string, completing from and restricting to the set of
1447 ;; all defined commands. Don't provide any initial input.
1448 ;; Save the command read on the extended-command history list.
1459 ;; This isn't strictly correct if `execute-extended-command'
1460 ;; is bound to anything else (e.g. [menu]).
1461 ;; It could use (key-description (this-single-command-keys)),
1462 ;; but actually a prompt other than "M-x" would be confusing,
1463 ;; because "M-x" is a well-known prompt to read a command
1464 ;; and it serves as a shorthand for "Extended command: ".
1469 "Non-nil means show the equivalent key-binding when M-x command has one.
1470 The value can be a length of time to show the message for.
1471 If the value is non-nil and not a number, we wait 2 seconds."
1478 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1479 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1480 "Read function name, then read its arguments and call it.
1482 To pass a numeric argument to the command you are invoking, specify
1483 the numeric argument to this command.
1485 Noninteractively, the argument PREFIXARG is the prefix argument to
1486 give to the command you invoke, if it asks for an argument."
1488 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1499 ;; Normally `real-this-command' should never be changed, but here we really
1500 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1501 ;; binding" for <cmd>, so the command the user really wanted to run is
1502 ;; `function' and not `execute-extended-command'. The difference is
1503 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1507 ;; If enabled, show which key runs this command.
1509 ;; But first wait, and skip the message if there is input.
1511 ;; If this command displayed something in the echo area;
1512 ;; wait a few seconds, then display our suggestion message.
1522 suggest-key-bindings
1526 ;; BEWARE: Called directly from the C code.
1527 "Execute CMD as an editor command.
1528 CMD must be a symbol that satisfies the `commandp' predicate.
1529 Optional second arg RECORD-FLAG non-nil
1530 means unconditionally put this command in the variable `command-history'.
1531 Otherwise, that is done only if an arg is read using the minibuffer.
1532 The argument KEYS specifies the value to use instead of (this-command-keys)
1533 when reading the arguments; if it is nil, (this-command-keys) is used.
1534 The argument SPECIAL, if non-nil, means that this command is executing
1535 a special event, so ignore the prefix argument and don't clear it."
1543 ;; FIXME: Weird calling convention!
1553 ;; If requested, place the macro in the command history. For
1554 ;; other sorts of commands, call-interactively takes care of this.
1557 ;; Don't keep command history around forever.
1563 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1571 \f
1573 "Default minibuffer history list.
1574 This is used for all minibuffer input
1575 except when an alternate history list is specified.
1577 Maximum length of the history list is determined by the value
1580 "Control whether history list elements are expressions or strings.
1581 If the value of this variable equals current minibuffer depth,
1582 they are expressions; otherwise they are strings.
1583 \(That convention is designed to do the right thing for
1590 "Text that was in this minibuffer before any history commands.
1591 This is nil if there have not yet been any history commands
1600 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1604 "Minibuffer history variables for which matching should ignore case.
1605 If a history variable is a member of this list, then the
1607 commands ignore case when searching it, regardless of `case-fold-search'."
1612 "Find the previous history element that matches REGEXP.
1613 \(Previous history elements refer to earlier actions.)
1614 With prefix argument N, search for Nth previous match.
1615 If N is negative, find the next or Nth next match.
1616 Normally, history elements are matched case-insensitively if
1617 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1618 makes the search case-sensitive.
1619 See also `minibuffer-history-case-insensitive-variables'."
1623 nil
1624 minibuffer-local-map
1625 nil
1626 'minibuffer-history-search-history
1628 ;; Use the last regexp specified, by default, if input is empty.
1633 regexp)
1643 ;; On some systems, ignore case for file names.
1645 minibuffer-history-case-insensitive-variables)
1646 t
1647 ;; Respect the user's setting for case-fold-search:
1648 case-fold-search)
1649 nil))
1650 prevpos
1651 match-string
1652 match-offset
1659 "No later matching history item"
1680 next-matching-history-element))
1684 "Find the next history element that matches REGEXP.
1685 \(The next history element refers to a more recent action.)
1686 With prefix argument N, search for Nth next match.
1687 If N is negative, find the previous or Nth previous match.
1688 Normally, history elements are matched case-insensitively if
1689 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1690 makes the search case-sensitive."
1694 nil
1695 minibuffer-local-map
1696 nil
1697 'minibuffer-history-search-history
1699 ;; Use the last regexp specified, by default, if input is empty.
1704 regexp)
1711 "Function run by `goto-history-element' before consuming default values.
1712 This is useful to dynamically add more elements to the list of default values
1713 when `goto-history-element' reaches the end of this list.
1714 Before calling this function `goto-history-element' sets the variable
1715 `minibuffer-default-add-done' to t, so it will call this function only
1716 once. In special cases, when this function needs to be called more
1717 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1721 "When nil, add more elements to the end of the list of default values.
1722 The value nil causes `goto-history-element' to add more elements to
1723 the list of defaults when it reaches the end of this list. It does
1729 "Return a list of all completions without the default value.
1730 This function is used to add all elements of the completion table to
1731 the end of the list of defaults just after the default value."
1734 minibuffer-completion-table
1735 minibuffer-completion-predicate)))
1741 "Puts element of the minibuffer history in the minibuffer.
1742 The argument NABS specifies the absolute history position."
1756 elt minibuffer-returned-to-present)
1763 "End of defaults; no next item"
1768 previous-history-element))
1780 minibuffer-default)))
1792 elt))
1796 "Puts next element of the minibuffer history in the minibuffer.
1797 With argument N, it uses the Nth following element."
1803 "Puts previous element of the minibuffer history in the minibuffer.
1804 With argument N, it uses the Nth previous element."
1810 "Get next history element which completes the minibuffer before the point.
1811 The contents of the minibuffer after the point are deleted, and replaced
1812 by the new completion."
1818 n)
1819 ;; next-matching-history-element always puts us at (point-min).
1820 ;; Move to the position we were at before changing the buffer contents.
1821 ;; This is still sensible, because the text before point has not changed.
1825 "\
1826 Get previous history element which completes the minibuffer before the point.
1827 The contents of the minibuffer after the point are deleted, and replaced
1828 by the new completion."
1832 ;; For compatibility with the old subr of the same name.
1834 "Return the display width of the minibuffer prompt.
1835 Return 0 if current buffer is not a minibuffer."
1836 ;; Return the width of everything before the field at the end of
1837 ;; the buffer; this should be 0 for normal buffers.
1839 \f
1840 ;; isearch minibuffer history
1847 "Set up a minibuffer for using isearch to search the minibuffer history.
1848 Intended to be added to `minibuffer-setup-hook'."
1860 "Clean up the minibuffer after terminating isearch in the minibuffer."
1865 "Return the proper search function, for isearch in minibuffer history."
1868 ;; Use standard functions to search within minibuffer text
1870 found)
1871 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1872 ;; searching forward. Lazy-highlight calls this lambda with the
1873 ;; bound arg, so skip the minibuffer prompt.
1877 ;; 1. First try searching in the initial minibuffer text
1880 noerror)
1881 ;; 2. If the above search fails, start putting next/prev history
1882 ;; elements in the minibuffer successively, and search the string
1883 ;; in them. Do this only when bound is nil (i.e. not while
1884 ;; lazy-highlighting search strings in the current minibuffer text).
1896 ;; After putting the next/prev history element, search
1897 ;; the string in them again, until next-history-element
1898 ;; or previous-history-element raises an error at the
1899 ;; beginning/end of history.
1902 ;; For backward search, don't search
1903 ;; in the minibuffer prompt
1905 noerror)))
1906 ;; Return point of the new search result
1908 ;; Return nil when next(prev)-history-element fails
1912 "Display the minibuffer history search prompt.
1913 If there are no search errors, this function displays an overlay with
1914 the isearch prompt which replaces the original minibuffer prompt.
1915 Otherwise, it displays the standard isearch message returned from
1916 the function `isearch-message'."
1918 ;; Use standard function `isearch-message' when not in the minibuffer,
1919 ;; or search fails, or has an error (like incomplete regexp).
1920 ;; This function overwrites minibuffer text with isearch message,
1921 ;; so it's possible to see what is wrong in the search string.
1923 ;; Otherwise, put the overlay with the standard isearch prompt over
1924 ;; the initial minibuffer prompt.
1933 ;; And clear any previous isearch message.
1937 "Wrap the minibuffer history search when search fails.
1938 Move point to the first history element for a forward search,
1939 or to the last history element for a backward search."
1940 ;; When `minibuffer-history-isearch-search' fails on reaching the
1941 ;; beginning/end of the history, wrap the search to the first/last
1942 ;; minibuffer history element.
1950 "Save a function restoring the state of minibuffer history search.
1951 Save `minibuffer-history-position' to the additional state parameter
1952 in the search status stack."
1958 "Restore the minibuffer history search state.
1959 Go to the history element by the absolute history position HIST-POS."
1962 \f
1963 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1967 "Table mapping redo records to the corresponding undo one.
1968 A redo record for undo-in-region maps to t.
1978 "Within a run of consecutive undo commands, list remaining to be undone.
1982 "Undo some previous changes.
1983 Repeat this command to undo more changes.
1984 A numeric ARG serves as a repeat count.
1986 In Transient Mark mode when the mark is active, only undo changes within
1988 as an argument limits undo to changes within the current region."
1990 ;; Make last-command indicate for the next command that this was an undo.
1991 ;; That way, another undo will undo more.
1992 ;; If we get to the end of the undo history and get an error,
1993 ;; another undo command will find the undo history empty
1994 ;; and will get another error. To begin undoing the undos,
1995 ;; you must type some other command.
1997 ;; For an indirect buffer, look in the base buffer for the
1998 ;; auto-save data.
2002 message)
2003 ;; If we get an error in undo-start,
2004 ;; the next command should not be a "consecutive undo".
2005 ;; So set `this-command' to something other than `undo'.
2010 ;; If something (a timer or filter?) changed the buffer
2011 ;; since the previous command, don't continue the undo seq.
2015 ;; If the last undo record made was made by undo
2016 ;; it shows nothing else happened in between.
2023 ;; get rid of initial undo boundary
2025 ;; If we got this far, the next command should be a consecutive undo.
2027 ;; Check to see whether we're hitting a redo record, and if
2028 ;; so, ask the user whether she wants to skip the redo/undo pair.
2036 ;; The equiv entry might point to another redo record if we have done
2037 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2045 ;; Record the fact that the just-generated undo records come from an
2046 ;; undo operation--that is, they are redo records.
2047 ;; In the ordinary case (not within a region), map the redo
2048 ;; record to the following undos.
2049 ;; I don't know how to do that in the undo-in-region case.
2051 ;; Strip any leading undo boundaries there might be, like we do
2052 ;; above when checking.
2056 undo-equiv-table))
2057 ;; Don't specify a position in the undo record for the undo command.
2058 ;; Instead, undoing this should move point to where the change is.
2077 ;; Record what the current undo list says,
2078 ;; so the next command can tell if the buffer was modified in between.
2082 ;; Display a message announcing success.
2087 "Make BUFFER stop keeping undo information.
2088 No argument or nil as argument means do this for the current buffer."
2094 "Undo some previous changes.
2095 Repeat this command to undo more changes.
2096 A numeric ARG serves as a repeat count.
2097 Contrary to `undo', this will not redo a previous undo."
2102 "Non-nil while performing an undo.
2106 "Undo back N undo-boundaries beyond what was already undone recently.
2107 Call `undo-start' to get ready to undo recent changes,
2108 then call `undo-more' one or more times to undo them."
2113 ;; Note: The following, while pulling elements off
2114 ;; `pending-undo-list' will call primitive change functions which
2115 ;; will push more elements onto `buffer-undo-list'.
2121 "Undo N records from the front of the list LIST.
2122 Return what remains of the list."
2124 ;; This is a good feature, but would make undo-start
2125 ;; unable to do what is expected.
2126 ;;(when (null (car (list)))
2127 ;; ;; If the head of the list is a boundary, it is the boundary
2128 ;; ;; preceding this command. Get rid of it and don't count it.
2129 ;; (setq list (cdr list))))
2132 ;; In a writable buffer, enable undoing read-only text that is
2133 ;; so because of text properties.
2135 ;; Don't let `intangible' properties interfere with undo.
2137 ;; We use oldlist only to check for EQ. ++kfs
2143 ;; Handle an integer by setting point to that value.
2146 ;; Element (t . TIME) records previous modtime.
2147 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2148 ;; UNKNOWN_MODTIME_NSECS.
2150 ;; If this records an obsolete save
2151 ;; (not matching the actual disk file)
2152 ;; then don't mark unmodified.
2160 ;; Element (nil PROP VAL BEG . END) is property change.
2165 ;; Element (BEG . END) means range was inserted.
2167 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2168 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2171 ;; Set point first thing, so that undoing this undo
2172 ;; does not send point back to where it is now.
2175 ;; Element (apply FUN . ARGS) means call FUN to undo.
2179 ;; Long format: (apply DELTA START END FUN . ARGS).
2186 ;; Check that the function did what the entry
2187 ;; said it would do.
2197 ;; Element (STRING . POS) means STRING was deleted.
2207 ;; Now that we record marker adjustments
2208 ;; (caused by deletion) for undo,
2209 ;; we should always insert after markers,
2210 ;; so that undoing the marker adjustments
2211 ;; put the markers back in the right place.
2214 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2222 ;; Make sure an apply entry produces at least one undo entry,
2223 ;; so the test in `undo' for continuing an undo series
2224 ;; will work right.
2229 list)
2231 ;; Deep copy of a list
2233 "Make a copy of undo list LIST."
2239 elt))
2242 "Set `pending-undo-list' to the front of the undo list.
2243 The next call to `undo-more' will undo the most recently made change.
2244 If BEG and END are specified, then only undo elements
2245 that apply to text between BEG and END are used; other undo elements
2246 are ignored. If BEG and END are nil, all undo elements are used."
2252 buffer-undo-list)))
2257 "Return a list of undo elements for the region START to END.
2258 The elements come from `buffer-undo-list', but we keep only
2259 the elements inside this region, and discard those outside this region.
2260 If we find an element that crosses an edge of this region,
2261 we stop and ignore all further elements."
2264 undo-adjusted-markers
2265 some-rejected
2266 undo-elt temp-undo-list delta)
2271 ;; This is a "was unmodified" element.
2272 ;; Keep it if we have kept everything thus far.
2279 ;; Don't put two nils together in the list
2293 ;; Loop down the earlier events adjusting their buffer
2294 ;; positions to reflect the fact that a change to the buffer
2295 ;; isn't being undone. We only need to process those element
2296 ;; types which undo-elt-in-region will return as being in
2297 ;; the region since only those types can ever get into the
2298 ;; output
2307 ;; (TEXT . POSITION)
2314 ;; (BEGIN . END)
2319 ;; (nil PROPERTY VALUE BEG . END)
2329 "Determine whether UNDO-ELT falls inside the region START ... END.
2330 If it crosses the edge, we return nil."
2335 t)
2337 nil)
2339 ;; (TEXT . POSITION)
2343 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2344 ;; See if MARKER is inside the region.
2355 ;; (nil PROPERTY VALUE BEG . END)
2360 ;; (BEGIN . END)
2365 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2366 This assumes we have already decided that UNDO-ELT
2367 is not *inside* the region START...END."
2370 ;; (nil PROPERTY VALUE BEG . END)
2375 ;; (BEGIN . END)
2379 ;; Return the first affected buffer position and the delta for an undo element
2380 ;; delta is defined as the change in subsequent buffer positions if we *did*
2381 ;; the undo.
2385 ;; (TEXT . POSITION)
2388 ;; (BEGIN . END)
2395 "If non-nil ask about discarding undo info for the current command.
2396 Normally, Emacs discards the undo info for the current command if
2397 it exceeds `undo-outer-limit'. But if you set this option
2398 non-nil, it asks in the echo area whether to discard the info.
2399 If you answer no, there is a slight risk that Emacs might crash, so
2400 only do it if you really want to undo the command.
2402 This option is mainly intended for debugging. You have to be
2403 careful if you use it for other purposes. Garbage collection is
2404 inhibited while the question is asked, meaning that Emacs might
2405 leak memory. So you should make sure that you do not wait
2406 excessively long before answering the question."
2412 "If non-nil, an extra level of size that's ok in an undo item.
2413 We don't ask the user about truncating the undo list until the
2414 current item gets bigger than this amount.
2419 ;; When the first undo batch in an undo list is longer than
2420 ;; undo-outer-limit, this function gets called to warn the user that
2421 ;; the undo info for the current command was discarded. Garbage
2422 ;; collection is inhibited around the call, so it had better not do a
2423 ;; lot of consing.
2429 ;; Don't ask the question again unless it gets even bigger.
2430 ;; This applies, in particular, if the user quits from the question.
2431 ;; Such a quit quits out of GC, but something else will call GC
2432 ;; again momentarily. It will call this function again,
2433 ;; but we don't want to ask the question again.
2440 t)
2441 nil))
2446 "The undo info was discarded because it exceeded \
2447 `undo-outer-limit'.
2449 This is normal if you executed a command that made a huge change
2450 to the buffer. In that case, to prevent similar problems in the
2451 future, set `undo-outer-limit' to a value that is large enough to
2452 cover the maximum size of normal changes you expect a single
2453 command to make, but not so large that it might exceed the
2454 maximum memory allotted to Emacs.
2456 If you did not execute any such command, the situation is
2457 probably due to a bug and you should report it.
2459 You can disable the popping up of this buffer by adding the entry
2460 \(undo discard-info) to the user option `warning-suppress-types',
2464 t))
2465 \f
2467 "History list for some commands that read shell commands.
2469 Maximum length of the history list is determined by the value
2476 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2477 This buffer is used when `shell-command' or `shell-command-on-region'
2478 is run interactively. A value of nil means that output to stderr and
2485 "Return a list of all commands associated with the current file.
2486 This function is used to add all related commands retrieved by `mailcap'
2487 to the end of the list of defaults just after the default value."
2491 minibuffer-default))
2496 commands))
2507 map)
2511 "Read a shell command from the minibuffer.
2512 The arguments are the same as the ones of `read-from-minibuffer',
2513 except READ and KEYMAP are missing and HIST defaults
2514 to `shell-command-history'."
2522 minibuffer-local-shell-command-map
2523 nil
2525 args)))
2528 "What to do when the output buffer is used by another shell command.
2529 This option specifies how to resolve the conflict where a new command
2530 wants to direct its output to the buffer `*Async Shell Command*',
2531 but this buffer is already taken by another running shell command.
2533 The value `confirm-kill-process' is used to ask for confirmation before
2534 killing the already running process and running a new process
2535 in the same buffer, `confirm-new-buffer' for confirmation before running
2536 the command in a new buffer with a name other than the default buffer name,
2537 `new-buffer' for doing the same without confirmation,
2538 `confirm-rename-buffer' for confirmation before renaming the existing
2539 output buffer and running a new command in the default buffer,
2540 `rename-buffer' for doing the same without confirmation."
2542 confirm-kill-process)
2544 confirm-new-buffer)
2546 new-buffer)
2548 confirm-rename-buffer)
2550 rename-buffer))
2555 "Execute string COMMAND asynchronously in background.
2557 Like `shell-command', but adds `&' at the end of COMMAND
2558 to execute it asynchronously.
2560 The output appears in the buffer `*Async Shell Command*'.
2561 That buffer is in shell mode.
2563 In Elisp, you will often be better served by calling `start-process'
2564 directly, since it offers more control and does not impose the use of a
2565 shell (with its need to quote arguments)."
2575 current-prefix-arg
2576 shell-command-default-error-buffer))
2582 "Execute string COMMAND in inferior shell; display output, if any.
2583 With prefix argument, insert the COMMAND's output at point.
2585 If COMMAND ends in `&', execute it asynchronously.
2586 The output appears in the buffer `*Async Shell Command*'.
2587 That buffer is in shell mode. You can also use
2588 `async-shell-command' that automatically adds `&'.
2590 Otherwise, COMMAND is executed synchronously. The output appears in
2591 the buffer `*Shell Command Output*'. If the output is short enough to
2592 display in the echo area (which is determined by the variables
2593 `resize-mini-windows' and `max-mini-window-height'), it is shown
2594 there, but it is nonetheless available in buffer `*Shell Command
2595 Output*' even though that buffer is not automatically displayed.
2597 To specify a coding system for converting non-ASCII characters
2599 before this command.
2601 Noninteractive callers can specify coding systems by binding
2602 `coding-system-for-read' and `coding-system-for-write'.
2604 The optional second argument OUTPUT-BUFFER, if non-nil,
2605 says to put the output in some other buffer.
2606 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2607 If OUTPUT-BUFFER is not a buffer and not nil,
2608 insert output in current buffer. (This cannot be done asynchronously.)
2609 In either case, the buffer is first erased, and the output is
2610 inserted after point (leaving mark after it).
2612 If the command terminates without error, but generates output,
2614 the output can be displayed in the echo area or in its buffer.
2615 If the output is short enough to display in the echo area
2616 \(determined by the variable `max-mini-window-height' if
2617 `resize-mini-windows' is non-nil), it is shown there.
2618 Otherwise,the buffer containing the output is displayed.
2622 of the output.
2624 If there is no output, or if output is inserted in the current buffer,
2625 then `*Shell Command Output*' is deleted.
2627 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2628 or buffer name to which to direct the command's standard error output.
2629 If it is nil, error output is mingled with regular output.
2630 In an interactive call, the variable `shell-command-default-error-buffer'
2631 specifies the value of ERROR-BUFFER.
2633 In Elisp, you will often be better served by calling `call-process' or
2634 `start-process' directly, since it offers more control and does not impose
2635 the use of a shell (with its need to quote arguments)."
2646 current-prefix-arg
2647 shell-command-default-error-buffer))
2648 ;; Look for a handler in case default-directory is a remote file name.
2656 ;; Output goes in current buffer.
2662 temporary-file-directory)))
2663 nil)))
2666 ;; We do not use -f for csh; we will not support broken use of
2667 ;; .cshrcs. Even the BSD csh manual says to use
2668 ;; "if ($?prompt) exit" before things which are not useful
2669 ;; non-interactively. Besides, if someone wants their other
2670 ;; aliases for shell commands then they can still have them.
2674 t)
2675 nil shell-command-switch command)
2682 ;; Do no formatting while reading error file,
2683 ;; because that can run a shell command, and we
2684 ;; don't want that to cause an infinite recursion.
2686 ;; Put point after the inserted errors.
2690 ;; This is like exchange-point-and-mark, but doesn't
2691 ;; activate the mark. It is cleaner to avoid activation,
2692 ;; even though the command loop would deactivate the mark
2693 ;; because we inserted text.
2697 ;; Output goes in a separate buffer.
2698 ;; Preserve the match data in case called from a program.
2701 ;; Command ending with ampersand means asynchronous.
2705 proc)
2706 ;; Remove the ampersand.
2708 ;; Ask the user what to do with already running process.
2713 ;; If will kill a process, query first.
2718 ;; If will create a new buffer, query first.
2724 ;; It will create a new buffer.
2728 ;; If will rename the buffer, query first.
2737 ;; It will rename the buffer.
2744 ;; Setting buffer-read-only to nil doesn't suffice
2745 ;; if some text has a non-nil read-only property,
2746 ;; which comint sometimes adds for prompts.
2752 shell-command-switch command))
2756 ;; Use the comint filter for proper handling of carriage motion
2757 ;; (see `comint-inhibit-carriage-motion'),.
2759 ))
2760 ;; Otherwise, command is executed synchronously.
2762 output-buffer nil error-buffer)))))))
2766 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2767 MESSAGE may be either a string or a buffer.
2769 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2770 the maximum height of the echo area, as defined by `max-mini-window-height'
2771 if `resize-mini-windows' is non-nil.
2773 Returns either the string shown in the echo area, or when a pop-up
2774 buffer is used, the window used to display it.
2776 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2777 name of the buffer used to display it in the case where a pop-up buffer
2778 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2779 string and it is displayed in the echo area, it is not specified whether
2780 the contents are inserted into the buffer anyway.
2782 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2783 and only used if a buffer is displayed."
2785 ;; Trivial case where we can use the echo area
2789 ;; Trivial case where we can just remove single trailing newline
2792 ;; General case
2795 message
2804 0
2808 (<= lines
2812 max-mini-window-height))
2814 max-mini-window-height)
2818 ;; Don't use the echo area if the output buffer is
2819 ;; already displayed in the selected frame.
2821 ;; Echo area
2827 ;; Buffer
2830 not-this-window frame))))))))
2833 ;; We have a sentinel to prevent insertion of a termination message
2834 ;; in the buffer itself.
2842 &optional output-buffer replace
2843 error-buffer display-error-buffer)
2844 "Execute string COMMAND in inferior shell with region as input.
2845 Normally display output (if any) in temp buffer `*Shell Command Output*';
2846 Prefix arg means replace the region with it. Return the exit code of
2847 COMMAND.
2849 To specify a coding system for converting non-ASCII characters
2851 before this command. By default, the input (from the current buffer)
2852 is encoded using coding-system specified by `process-coding-system-alist',
2853 falling back to `default-process-coding-system' if no match for COMMAND
2854 is found in `process-coding-system-alist'.
2856 Noninteractive callers can specify coding systems by binding
2857 `coding-system-for-read' and `coding-system-for-write'.
2859 If the command generates output, the output may be displayed
2860 in the echo area or in a buffer.
2861 If the output is short enough to display in the echo area
2862 \(determined by the variable `max-mini-window-height' if
2863 `resize-mini-windows' is non-nil), it is shown there.
2864 Otherwise it is displayed in the buffer `*Shell Command Output*'.
2865 The output is available in that buffer in both cases.
2867 If there is output and an error, a message about the error
2868 appears at the end of the output. If there is no output, or if
2869 output is inserted in the current buffer, the buffer `*Shell
2870 Command Output*' is deleted.
2872 Optional fourth arg OUTPUT-BUFFER specifies where to put the
2873 command's output. If the value is a buffer or buffer name,
2874 put the output there. If the value is nil, use the buffer
2875 `*Shell Command Output*'. Any other value, excluding nil,
2876 means to insert the output in the current buffer. In either case,
2877 the output is inserted after point (leaving mark after it).
2879 Optional fifth arg REPLACE, if non-nil, means to insert the
2880 output in place of text from START to END, putting point and mark
2881 around it.
2883 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
2884 or buffer name to which to direct the command's standard error
2885 output. If nil, error output is mingled with regular output.
2886 When called interactively, `shell-command-default-error-buffer'
2887 is used for ERROR-BUFFER.
2889 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
2890 display the error buffer if there were any errors. When called
2891 interactively, this is t."
2895 ;; Do this before calling region-beginning
2896 ;; and region-end, in case subprocess output
2897 ;; relocates them while we are in the minibuffer.
2899 ;; call-interactively recognizes region-beginning and
2900 ;; region-end specially, leaving them in the history.
2902 string
2903 current-prefix-arg
2904 current-prefix-arg
2905 shell-command-default-error-buffer
2906 t)))
2912 temporary-file-directory)))
2913 nil))
2914 exit-status)
2918 ;; Replace specified region with output from command.
2920 ;; Don't muck with mark unless REPLACE says we should.
2927 t)
2928 nil shell-command-switch command))
2929 ;; It is rude to delete a buffer which the command is not using.
2930 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2931 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2932 ;; (kill-buffer shell-buffer)))
2933 ;; Don't muck with mark unless REPLACE says we should.
2935 ;; No prefix argument: put the output in a temp buffer,
2936 ;; replacing its entire contents.
2941 ;; If the input is the same buffer as the output,
2942 ;; delete everything but the specified region,
2943 ;; then replace that region with the output.
2949 shell-file-name t
2952 t)
2953 nil shell-command-switch
2954 command)))
2955 ;; Clear the output buffer, then run the command with
2956 ;; output there.
2967 buffer)
2968 nil shell-command-switch command)))
2969 ;; Report the output.
2979 ;; There's some output, display it
2981 ;; No output; error?
2988 shell-command-default-error-buffer)
2995 output))
2998 exit-status))
3001 exit-status output))))
3002 ;; Don't kill: there might be useful info in the undo-log.
3003 ;; (kill-buffer buffer)
3004 ))))
3012 ;; Do no formatting while reading error file,
3013 ;; because that can run a shell command, and we
3014 ;; don't want that to cause an infinite recursion.
3016 ;; Put point after the inserted errors.
3021 exit-status))
3024 "Execute shell command COMMAND and return its output as a string."
3027 standard-output
3031 "Process files synchronously in a separate process.
3032 Similar to `call-process', but may invoke a file handler based on
3033 `default-directory'. The current working directory of the
3034 subprocess is `default-directory'.
3036 File names in INFILE and BUFFER are handled normally, but file
3037 names in ARGS should be relative to `default-directory', as they
3038 are passed to the process verbatim. \(This is a difference to
3039 `call-process' which does not support file handlers for INFILE
3040 and BUFFER.\)
3042 Some file handlers might not support all variants, for example
3043 they might behave as if DISPLAY was nil, regardless of the actual
3044 value passed."
3046 lc stderr-file)
3056 display args)
3062 "Whether a call of `process-file' changes remote files.
3064 By default, this variable is always set to `t', meaning that a
3065 call of `process-file' could potentially change any file on a
3066 remote host. When set to `nil', a file handler could optimize
3067 its behavior with respect to remote file attribute caching.
3069 You should only ever change this variable with a let-binding;
3073 "Start a program in a subprocess. Return the process object for it.
3075 Similar to `start-process', but may invoke a file handler based on
3076 `default-directory'. See Info node `(elisp)Magic File Names'.
3078 This handler ought to run PROGRAM, perhaps on the local host,
3079 perhaps on a remote host that corresponds to `default-directory'.
3080 In the latter case, the local part of `default-directory' becomes
3081 the working directory of the process.
3083 PROGRAM and PROGRAM-ARGS might be file names. They are not
3084 objects of file handler invocation. File handlers might not
3085 support pty association, if PROGRAM is nil."
3089 \f
3090 ;;;; Process menu
3102 "Major mode for listing the processes called by Emacs."
3114 "Recompute the list of processes for the Process List buffer.
3115 Also, delete any process that is exited or signaled."
3128 face link
3131 follow-link t
3132 process-buffer ,buf
3133 action process-menu-visit-buffer)
3142 "datagram"
3159 tabulated-list-entries))))))
3165 "Display a list of all processes that are Emacs sub-processes.
3166 If optional argument QUERY-ONLY is non-nil, only processes with
3167 the query-on-exit flag set are listed.
3168 Any process listed as exited or signaled is actually eliminated
3169 after the listing is made.
3170 Optional argument BUFFER specifies a buffer to use, instead of
3172 The return value is always nil.
3174 This function lists only processes that were launched by Emacs. To
3175 see other processes running on the system, use `list-system-processes'."
3187 nil)
3188 \f
3192 ;; For backward compatibility, minus with no modifiers is an ordinary
3193 ;; command if digits have already been entered.
3223 map)
3230 "Begin a numeric argument for the following command.
3235 multiplies the argument by 4 each time.
3237 which is different in effect from any particular numeric argument.
3244 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3245 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3251 arg)))
3255 "Begin a negative numeric argument for the next command.
3264 "Part of the numeric argument for the next command.
3268 last-command-event
3275 ;; Treat -0 as just -, so that -01 will work.
3278 digit))))
3280 \f
3288 "Function to perform the filtering in `filter-buffer-substring'.
3289 The function is called with 3 arguments:
3290 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
3291 as those of `filter-buffer-substring' in each case.
3295 "List of filter functions for `filter-buffer-substring'.
3296 Each function must accept a single argument, a string, and return
3297 a string. The buffer substring is passed to the first function
3298 in the list, and the return value of each function is passed to
3299 the next.
3300 As a special convention, point is set to the start of the buffer text
3301 being operated on (i.e., the first argument of `filter-buffer-substring')
3307 "Return the buffer substring between BEG and END, after filtering.
3308 The hook `filter-buffer-substring-function' performs the actual filtering.
3309 By default, no filtering is done.
3311 If DELETE is non-nil, the text between BEG and END is deleted
3312 from the buffer.
3314 This function should be used instead of `buffer-substring',
3315 `buffer-substring-no-properties', or `delete-and-extract-region'
3316 when you want to allow filtering to take place. For example,
3317 major or minor modes can use `filter-buffer-substring-function' to
3318 extract characters that are special to a buffer, and should not
3319 be copied into other buffers."
3322 ;; FIXME: `with-wrapper-hook' is obsolete
3333 string)))
3338 ;;;; Window system cut and paste hooks.
3341 "Function to call to make a killed region available to other programs.
3342 Most window systems provide a facility for cutting and pasting
3343 text between different programs, such as the clipboard on X and
3344 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3346 This variable holds a function that Emacs calls whenever text is
3347 put in the kill ring, to make the new kill available to other
3348 programs. The function takes one argument, TEXT, which is a
3352 "Function to call to get text cut from other programs.
3353 Most window systems provide a facility for cutting and pasting
3354 text between different programs, such as the clipboard on X and
3355 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3357 This variable holds a function that Emacs calls to obtain text
3358 that other programs have provided for pasting. The function is
3359 called with no arguments. If no other program has provided text
3360 to paste, the function should return nil (in which case the
3361 caller, usually `current-kill', should use the top of the Emacs
3362 kill ring). If another program has provided text to paste, the
3363 function should return that text as a string (in which case the
3364 caller should put this string in the kill ring as the latest
3365 kill).
3367 The function may also return a list of strings if the window
3368 system supports multiple selections. The first string will be
3369 used as the pasted text, but the other will be placed in the kill
3370 ring for easy access via `yank-pop'.
3372 Note that the function should return a string only if a program
3373 other than Emacs has provided a string for pasting; if Emacs
3374 provided the most recent string, the function should return nil.
3375 If it is difficult to tell whether Emacs or some other program
3376 provided the current string, it is probably good enough to return
3377 nil if the string is equal (according to `string=') to the last
3379 \f
3382 ;;;; The kill ring data structure.
3385 "List of killed text sequences.
3386 Since the kill ring is supposed to interact nicely with cut-and-paste
3387 facilities offered by window systems, use of this variable should
3388 interact nicely with `interprogram-cut-function' and
3389 `interprogram-paste-function'. The functions `kill-new',
3390 `kill-append', and `current-kill' are supposed to implement this
3391 interaction; you may want to use them instead of manipulating the kill
3395 "Maximum length of kill ring before oldest elements are thrown away."
3403 "Save clipboard strings into kill ring before replacing them.
3404 When one selects something in another program to paste it into Emacs,
3405 but kills something in Emacs before actually pasting it,
3406 this selection is gone unless this variable is non-nil,
3407 in which case the other program's selection is saved in the `kill-ring'
3414 "Do not add a new string to `kill-ring' if it duplicates the last one.
3415 The comparison is done using `equal-including-properties'."
3421 "Make STRING the latest kill in the kill ring.
3422 Set `kill-ring-yank-pointer' to point to it.
3423 If `interprogram-cut-function' is non-nil, apply it to STRING.
3424 Optional second argument REPLACE non-nil means that STRING will replace
3425 the front of the kill ring, rather than being added to the list.
3427 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3428 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3429 STRING.
3431 When the yank handler has a non-nil PARAM element, the original STRING
3432 argument is not used by `insert-for-yank'. However, since Lisp code
3433 may access and use elements from the kill ring directly, the STRING
3443 ;; Due to text properties such as 'yank-handler that
3444 ;; can alter the contents to yank, comparison using
3445 ;; `equal' is unsafe.
3473 "Append STRING to the end of the latest kill in the kill ring.
3474 If BEFORE-P is non-nil, prepend STRING to the kill.
3475 If `interprogram-cut-function' is set, pass the resulting kill to it."
3480 yank-handler)))
3484 "Whether rotating the kill ring changes the window system selection.
3485 If non-nil, whenever the kill ring is rotated (usually via the
3486 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3487 to copy the new kill to the window system selection."
3493 "Rotate the yanking point by N places, and then return that kill.
3494 If N is zero and `interprogram-paste-function' is set to a
3495 function that returns a string or a list of strings, and if that
3496 function doesn't return nil, then that string (or list) is added
3497 to the front of the kill ring and the string (or first string in
3498 the list) is returned as the latest kill.
3500 If N is not zero, and if `yank-pop-change-selection' is
3501 non-nil, use `interprogram-cut-function' to transfer the
3502 kill at the new yank point into the window system selection.
3504 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3505 move the yanking point; just return the Nth kill forward."
3508 interprogram-paste-function
3512 ;; Disable the interprogram cut function when we add the new
3513 ;; text to the kill ring, so Emacs doesn't try to own the
3514 ;; selection, with identical text.
3524 kill-ring)))
3529 interprogram-cut-function)
3535 ;;;; Commands for manipulating the kill ring.
3538 "Non-nil means don't signal an error for killing read-only text."
3544 This deletes the text from the buffer and saves it in the kill ring.
3548 If you want to append the killed region to the last killed text,
3551 If the buffer is read-only, Emacs will beep and refrain from deleting
3552 the text, but put the text in the kill ring anyway. This means that
3553 you can use the killing commands to copy text from a read-only buffer.
3555 Lisp programs should use this function for killing text.
3556 (To delete text, use `delete-region'.)
3557 Supply two arguments, character positions indicating the stretch of text
3558 to be killed.
3560 If the previous command was also a kill command,
3561 the text killed this time appends to the text killed last time
3562 to make one entry in the kill ring."
3563 ;; Pass point first, then mark, because the order matters
3564 ;; when calling kill-append.
3571 ;; Add that string to the kill ring, one way or another.
3578 nil)
3580 ;; The code above failed because the buffer, or some of the characters
3581 ;; in the region, are read-only.
3582 ;; We should beep, in case the user just isn't aware of this.
3583 ;; However, there's no harm in putting
3584 ;; the region's text in the kill ring, anyway.
3586 ;; Set this-command now, so it will be set even if we get an error.
3588 ;; This should barf, if appropriate, and give us the correct error.
3591 ;; Signal an error if the buffer is read-only.
3593 ;; If the buffer isn't read-only, the text is.
3597 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3598 ;; to get two copies of the text when the user accidentally types M-w and
3599 ;; then corrects it with the intended C-w.
3601 "Save the region as if killed, but don't kill it.
3602 In Transient Mark mode, deactivate the mark.
3603 If `interprogram-cut-function' is non-nil, also save the text for a window
3604 system cut and paste.
3606 This command's old key binding has been given to `kill-ring-save'."
3612 nil)
3615 "Save the region as if killed, but don't kill it.
3616 In Transient Mark mode, deactivate the mark.
3617 If `interprogram-cut-function' is non-nil, also save the text for a window
3618 system cut and paste.
3620 If you want to append the killed line to the last killed text,
3623 This command is similar to `copy-region-as-kill', except that it gives
3624 visual feedback indicating the extent of the region being copied."
3627 ;; This use of called-interactively-p is correct because the code it
3628 ;; controls just gives the user visual feedback.
3633 "Indicate that the region text has been copied interactively.
3634 If the mark is visible in the selected window, blink the cursor
3635 between point and mark if there is currently no active region
3636 highlighting.
3638 If the mark lies outside the selected window, display an
3639 informative message containing a sample of the copied text. The
3640 optional argument MESSAGE-LEN, if non-nil, specifies the length
3641 of this sample text; it defaults to 40."
3644 ;; Inhibit quitting so we can make a quit here
3645 ;; look like a C-g typed as a command.
3648 ;; Swap point-and-mark quickly so as to show the region that
3649 ;; was selected. Don't do it if the region is highlighted.
3652 ;; Swap point and mark.
3656 ;; Swap back.
3659 ;; If user quit, deactivate the mark
3660 ;; as C-g would as a command.
3666 ;; Don't say "killed"; that is misleading.
3673 "Cause following command, if it kills, to append to previous kill.
3674 The argument is used for internal purposes; do not supply one."
3676 ;; We don't use (interactive-p), since that breaks kbd macros.
3682 \f
3683 ;; Yanking.
3688 "List of special text property handling conditions for yanking.
3689 Each element should have the form (PROP . FUN), where PROP is a
3690 property symbol and FUN is a function. When the `yank' command
3691 inserts text into the buffer, it scans the inserted text for
3692 stretches of text that have `eq' values of the text property
3693 PROP; for each such stretch of text, FUN is called with three
3694 arguments: the property's value in that text, and the start and
3695 end positions of the text.
3697 This is done prior to removing the properties specified by
3698 `yank-excluded-properties'."
3702 ;; This is actually used in subr.el but defcustom does not work there.
3705 intangible invisible keymap local-map mouse-face read-only
3706 yank-handler)
3707 "Text properties to discard when yanking.
3708 The value should be a list of text properties to discard or t,
3709 which means to discard all text properties.
3711 See also `yank-handled-properties'."
3718 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3719 Function is called with two parameters, START and END corresponding to
3720 the value of the mark and point; it is guaranteed that START <= END.
3724 "Replace just-yanked stretch of killed text with a different stretch.
3725 This command is allowed only immediately after a `yank' or a `yank-pop'.
3726 At such a time, the region contains a stretch of reinserted
3727 previously-killed text. `yank-pop' deletes that text and inserts in its
3728 place a different stretch of killed text.
3730 With no argument, the previous kill is inserted.
3731 With argument N, insert the Nth previous kill.
3732 If N is negative, this is a more recent kill.
3734 The sequence of kills wraps around, so that after the oldest one
3735 comes the newest one.
3737 When this command inserts killed text into the buffer, it honors
3738 `yank-excluded-properties' and `yank-handler' as described in the
3739 doc string for `insert-for-yank-1', which see."
3753 ;; Set the window start back where it was in the yank command,
3754 ;; if possible.
3757 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3758 ;; It is cleaner to avoid activation, even though the command
3759 ;; loop would deactivate the mark because we inserted text.
3762 nil)
3766 More precisely, reinsert the most recent kill, which is the
3767 stretch of killed text most recently killed OR yanked. Put point
3768 at the end, and set mark at the beginning without activating it.
3770 With argument N, reinsert the Nth most recent kill.
3772 When this command inserts text into the buffer, it honors the
3773 `yank-handled-properties' and `yank-excluded-properties'
3774 variables, and the `yank-handler' text property. See
3775 `insert-for-yank-1' for details.
3780 ;; If we don't get all the way thru, make last-command indicate that
3781 ;; for the following command.
3789 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3790 ;; It is cleaner to avoid activation, even though the command
3791 ;; loop would deactivate the mark because we inserted text.
3794 ;; If we do get all the way thru, make this-command indicate that.
3797 nil)
3800 "Rotate the yanking point in the kill ring.
3801 With ARG, rotate that many kills forward (or backward, if negative)."
3804 \f
3805 ;; Some kill commands.
3807 ;; Internal subroutine of delete-char
3813 ;; Internal subroutine of backward-delete-char
3820 "The method for untabifying when deleting backward.
3821 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3822 `hungry' -- delete all whitespace, both tabs and spaces;
3823 `all' -- delete all whitespace, including tabs, spaces and newlines;
3824 nil -- just delete one character."
3830 "Delete characters backward, changing tabs into spaces.
3831 The exact behavior depends on `backward-delete-char-untabify-method'.
3832 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3833 Interactively, ARG is the prefix arg (default 1)
3834 and KILLP is t if a prefix arg was specified."
3857 arg)))
3858 ;; Avoid warning about delete-backward-char
3862 "Kill up to and including ARGth occurrence of CHAR.
3863 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3864 Goes backward if ARG is negative; error if CHAR not found."
3867 ;; Avoid "obsolete" warnings for translation-table-for-input.
3875 ;; kill-line and its subroutines.
3878 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
3883 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3884 With prefix argument ARG, kill that many lines from point.
3885 Negative arguments kill lines backward.
3886 With zero argument, kills the text before point on the current line.
3889 a number counts as a prefix arg.
3891 To kill a whole line, when point is not at the beginning, type \
3894 If `show-trailing-whitespace' is non-nil, this command will just
3895 kill the rest of the current line, even if there are only
3896 nonblanks there.
3898 If option `kill-whole-line' is non-nil, then this command kills the whole line
3899 including its terminating newline, when used at the beginning of a line
3900 with no argument. As a consequence, you can always kill a whole line
3903 If you want to append the killed line to the last killed text,
3906 If the buffer is read-only, Emacs will beep and refrain from deleting
3907 the line, but put the line in the kill ring anyway. This means that
3908 you can use this command to copy text from a read-only buffer.
3909 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3910 even beep.)"
3913 ;; It is better to move point to the other end of the kill
3914 ;; before killing. That way, in a read-only buffer, point
3915 ;; moves across the text that is copied to the kill ring.
3916 ;; The choice has no effect on undo now that undo records
3917 ;; the value of point from before the command was run.
3927 ;; If trailing whitespace is visible,
3928 ;; don't treat it as nothing.
3938 "Kill current line.
3939 With prefix ARG, kill that many lines starting from the current line.
3940 If ARG is negative, kill backward. Also kill the preceding newline.
3942 If ARG is zero, kill current line but exclude the trailing newline."
3953 ;; We need to kill in two steps, because the previous command
3954 ;; could have been a kill command, in which case the text
3955 ;; before point needs to be prepended to the current kill
3956 ;; ring entry and the text after point appended. Also, we
3957 ;; need to use save-excursion to avoid copying the same text
3958 ;; twice to the kill ring in read-only buffers.
3976 "Move forward by ARG lines, ignoring currently invisible newlines only.
3977 If ARG is negative, move backward -ARG lines.
3978 If ARG is zero, move to the beginning of the current line."
3985 ;; If the newline we just skipped is invisible,
3986 ;; don't count it.
3990 prop
3995 ;; If invisible text follows, and it is a number of complete lines,
3996 ;; skip it.
4002 prop
4018 ;; If the newline we just moved to is invisible,
4019 ;; don't count it.
4024 prop
4029 ;; If invisible text follows, and it is a number of complete lines,
4030 ;; skip it.
4036 prop
4047 nil)))
4050 "Move to end of current visible line."
4052 ;; If the following character is currently invisible,
4053 ;; skip all characters with that same `invisible' property value,
4054 ;; then find the next newline.
4061 prop
4070 \f
4072 "Insert after point the contents of BUFFER.
4073 Puts mark after the inserted text.
4074 BUFFER may be a buffer or a buffer name.
4076 This function is meant for the user to run interactively.
4077 Don't call it from programs: use `insert-buffer-substring' instead!"
4086 t))))
4091 nil)
4094 "Append to specified buffer the text of the region.
4095 It is inserted into that buffer before its point.
4097 When calling from a program, give three arguments:
4098 BUFFER (or buffer name), START and END.
4099 START and END specify the portion of the current buffer to be copied."
4106 point)
4117 "Prepend to specified buffer the text of the region.
4118 It is inserted into that buffer after its point.
4120 When calling from a program, give three arguments:
4121 BUFFER (or buffer name), START and END.
4122 START and END specify the portion of the current buffer to be copied."
4131 "Copy to specified buffer the text of the region.
4132 It is inserted into that buffer, replacing existing text there.
4134 When calling from a program, give three arguments:
4135 BUFFER (or buffer name), START and END.
4136 START and END specify the portion of the current buffer to be copied."
4144 \f
4148 "Hook run when the mark becomes active.
4149 It is also run at the end of a command, if the mark is active and
4156 "Return this buffer's mark value as integer, or nil if never set.
4158 In Transient Mark mode, this function signals an error if
4159 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4160 or the argument FORCE is non-nil, it disregards whether the mark
4161 is active, and returns an integer or nil in the usual way.
4163 If you are using this in an editing command, you are most likely making
4164 a mistake; see the documentation of `set-mark'."
4169 ;; Behind display-selections-p.
4176 "Deactivate the mark.
4177 If Transient Mark mode is disabled, this function normally does
4178 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4180 Deactivating the mark sets `mark-active' to nil, updates the
4181 primary selection according to `select-active-regions', and runs
4182 `deactivate-mark-hook'.
4184 If Transient Mark mode was temporarily enabled, reset the value
4185 of the variable `transient-mark-mode'; if this causes Transient
4186 Mark mode to be disabled, don't change `mark-active' to nil or
4187 run `deactivate-mark-hook'."
4191 select-active-regions)
4194 ;; The var `saved-region-selection', if non-nil, is the text in
4195 ;; the region prior to the last command modifying the buffer.
4196 ;; Set the selection to that, or to the current region.
4200 ;; If another program has acquired the selection, region
4201 ;; deactivation should not clobber it (Bug#11772).
4212 ;; When deactivating a temporary region, don't change
4213 ;; `mark-active' or run `deactivate-mark-hook'.
4221 "Activate the mark."
4229 "Set this buffer's mark to POS. Don't use this function!
4230 That is to say, don't use this function unless you want
4231 the user to see that the mark has moved, and you want the previous
4232 mark position to be lost.
4234 Normally, when a new mark is set, the old one should go on the stack.
4235 This is why most applications should use `push-mark', not `set-mark'.
4237 Novice Emacs Lisp programmers often try to use the mark for the wrong
4238 purposes. The mark saves a location for the user's convenience.
4239 Most editing commands should not alter the mark.
4240 To remember a location for internal use in the Lisp program,
4241 store it in a Lisp variable. Example:
4243 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4250 ;; Normally we never clear mark-active except in Transient Mark mode.
4251 ;; But when we actually clear out the mark value too, we must
4252 ;; clear mark-active in any mode.
4258 If nil, region-aware commands treat empty regions as inactive.
4259 If non-nil, region-aware commands treat the region as active as
4260 long as the mark is active, even if the region is empty.
4262 Region-aware commands are those that act on the region if it is
4263 active and Transient Mark mode is enabled, and on the text near
4264 point otherwise."
4270 "Return t if the region is active and it is appropriate to act on it.
4271 This is used by commands that act specially on the region under
4272 Transient Mark mode.
4274 The return value is t if Transient Mark mode is enabled and the
4275 mark is active; furthermore, if `use-empty-active-region' is nil,
4276 the region must not be empty. Otherwise, the return value is nil.
4278 For some commands, it may be appropriate to ignore the value of
4279 `use-empty-active-region'; in that case, use `region-active-p'."
4284 "Return t if Transient Mark mode is enabled and the mark is active.
4286 Some commands act specially on the region when Transient Mark
4287 mode is enabled. Usually, such commands should use
4288 `use-region-p' instead of this function, because `use-region-p'
4289 also checks the value of `use-empty-active-region'."
4298 "Maximum size of mark ring. Start discarding off end if gets this big."
4306 "Maximum size of global mark ring. \
4307 Start discarding off end if gets this big."
4312 "Jump to mark, and pop a new position for mark off the ring.
4313 \(Does not affect global mark ring\)."
4323 "Set mark at where point is.
4324 If no prefix ARG and mark is already set there, just activate it.
4325 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4338 will pop the mark twice, and
4340 will pop the mark three times.
4348 "Set the mark where point is, or jump to the mark.
4349 Setting the mark also alters the region, which is the text
4350 between point and mark; this is the closest equivalent in
4353 With no prefix argument, set the mark at point, and push the
4354 old mark position on local mark ring. Also push the old mark on
4355 global mark ring, if the previous mark was set in another buffer.
4357 When Transient Mark Mode is off, immediately repeating this
4358 command activates `transient-mark-mode' temporarily.
4361 jump to the mark, and set the mark from
4362 position popped off the local mark ring \(this does not affect the global
4364 mark ring \(see `pop-global-mark'\).
4366 If `set-mark-command-repeat-pop' is non-nil, repeating
4368 off the local (or global) mark ring and jumps there.
4371 argument, unconditionally set mark where point is, even if
4372 `set-mark-command-repeat-pop' is non-nil.
4374 Novice Emacs Lisp programmers often try to use the mark for the wrong
4375 purposes. See the documentation of `set-mark' for more information."
4411 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4412 If the last global mark pushed was not in the current buffer,
4413 also push LOCATION on the global mark ring.
4414 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4416 Novice Emacs Lisp programmers often try to use the mark for the wrong
4417 purposes. See the documentation of `set-mark' for more information.
4419 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4426 ;; Now push the mark on the global mark ring.
4429 ;; The last global mark pushed was in this same buffer.
4430 ;; Don't push another one.
4431 nil
4440 nil)
4443 "Pop off mark ring into the buffer's actual mark.
4444 Does not set point. Does nothing if mark ring is empty."
4456 "Put the mark where point is now, and point where the mark is now.
4457 This command works even when the mark is not active,
4458 and it reactivates the mark.
4460 If Transient Mark mode is on, a prefix ARG deactivates the mark
4461 if it is active, and otherwise avoids reactivating it. If
4462 Transient Mark mode is off, a prefix ARG enables Transient Mark
4463 mode temporarily."
4478 nil))
4481 "When non-nil, shifted motion keys activate the mark momentarily.
4483 While the mark is activated in this way, any shift-translated point
4484 motion key extends the region, and if Transient Mark mode was off, it
4485 is temporarily turned on. Furthermore, the mark will be deactivated
4486 by any subsequent point motion key that was not shift-translated, or
4487 by any action that normally deactivates the mark in Transient Mark mode.
4489 See `this-command-keys-shift-translated' for the meaning of
4490 shift-translation."
4495 "Activate/deactivate mark depending on invocation thru shift translation.
4496 This function is called by `call-interactively' when a command
4497 with a `^' character in its `interactive' spec is invoked, before
4498 running the command itself.
4500 If `shift-select-mode' is enabled and the command was invoked
4501 through shift translation, set the mark and activate the region
4502 temporarily, unless it was already set in this way. See
4503 `this-command-keys-shift-translated' for the meaning of shift
4504 translation.
4506 Otherwise, if the region has been activated temporarily,
4507 deactivate it, and restore the variable `transient-mark-mode' to
4508 its earlier value."
4515 transient-mark-mode)))
4522 "Toggle Transient Mark mode.
4523 With a prefix argument ARG, enable Transient Mark mode if ARG is
4524 positive, and disable it otherwise. If called from Lisp, enable
4525 Transient Mark mode if ARG is omitted or nil.
4527 Transient Mark mode is a global minor mode. When enabled, the
4528 region is highlighted whenever the mark is active. The mark is
4530 operations that set the mark but whose main purpose is something
4536 Many commands change their behavior when Transient Mark mode is
4537 in effect and the mark is active, by acting on the region instead
4538 of their usual default part of the buffer's text. Examples of
4541 To see the documentation of commands which are sensitive to the
4544 :global t
4545 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4549 "Non-nil means it is ok for commands to call `widen' when they want to.
4550 Some commands will do this in order to go to positions outside
4551 the current accessible part of the buffer.
4553 If `widen-automatically' is nil, these commands will do something else
4557 "Whether the currently executing code is performing an essential task.
4558 This variable should be non-nil only when running code which should not
4559 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4560 user for a password when we are simply scanning a set of files in the
4561 background or displaying possible completions before the user even asked
4565 "Pop off global mark ring and jump to the top location."
4567 ;; Pop entries which refer to non-existent buffers.
4585 \f
4587 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4593 "Move cursor vertically down ARG lines.
4594 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4595 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4596 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4597 function will not vscroll.
4599 ARG defaults to 1.
4601 If there is no character in the target line exactly under the current column,
4602 the cursor is positioned after the character in that line which spans this
4603 column, or at the end of the line if it is not long enough.
4604 If there is no line in the buffer after this one, behavior depends on the
4605 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4606 to create a line, and moves the cursor to that line. Otherwise it moves the
4607 cursor to the end of the buffer.
4609 If the variable `line-move-visual' is non-nil, this command moves
4610 by display lines. Otherwise, it moves by buffer lines, without
4611 taking variable-width characters or continued lines into account.
4614 a semipermanent goal column for this command.
4615 Then instead of trying to move exactly vertically (or as close as possible),
4616 this command moves to the specified goal column (or as close as possible).
4617 The goal column is stored in the variable `goal-column', which is nil
4618 when there is no goal column. Note that setting `goal-column'
4619 overrides `line-move-visual' and causes this command to move by buffer
4620 lines rather than by display lines.
4622 If you are thinking of using this in a Lisp program, consider
4623 using `forward-line' instead. It is usually easier to use
4624 and more reliable (no dependence on goal column, etc.)."
4629 ;; When adding a newline, don't expand an abbrev.
4640 nil)
4643 "Move cursor vertically up ARG lines.
4644 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4645 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4646 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4647 function will not vscroll.
4649 ARG defaults to 1.
4651 If there is no character in the target line exactly over the current column,
4652 the cursor is positioned after the character in that line which spans this
4653 column, or at the end of the line if it is not long enough.
4655 If the variable `line-move-visual' is non-nil, this command moves
4656 by display lines. Otherwise, it moves by buffer lines, without
4657 taking variable-width characters or continued lines into account.
4660 a semipermanent goal column for this command.
4661 Then instead of trying to move exactly vertically (or as close as possible),
4662 this command moves to the specified goal column (or as close as possible).
4663 The goal column is stored in the variable `goal-column', which is nil
4664 when there is no goal column. Note that setting `goal-column'
4665 overrides `line-move-visual' and causes this command to move by buffer
4666 lines rather than by display lines.
4668 If you are thinking of using this in a Lisp program, consider using
4669 `forward-line' with a negative argument instead. It is usually easier
4670 to use and more reliable (no dependence on goal column, etc.)."
4679 nil)
4682 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4683 This means moving to the end of each line moved onto.
4684 The beginning of a blank line does not count as the end of a line.
4685 This has no effect when the variable `line-move-visual' is non-nil."
4691 A non-nil setting overrides the variable `line-move-visual', which see."
4698 "Current goal column for vertical motion.
4699 It is the column where point was at the start of the current run
4700 of vertical motion commands.
4702 When moving by visual lines via the function `line-move-visual', it is a cons
4703 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4704 divided by the default column width, and HSCROLL is the number of
4705 columns by which window is scrolled from left margin.
4707 When the `track-eol' feature is doing its job, the value is
4712 Outline mode sets this."
4717 "When non-nil, `line-move' moves point by visual lines.
4718 This movement is based on where the cursor is displayed on the
4719 screen, instead of relying on buffer contents alone. It takes
4720 into account variable-width characters and line continuation.
4721 If nil, `line-move' moves point by logical lines.
4722 A non-nil setting of `goal-column' overrides the value of this variable
4723 and forces movement by logical lines.
4724 A window that is horizontally scrolled also forces movement by logical
4725 lines."
4730 ;; Only used if display-graphic-p.
4734 "Return the height in pixels of the current buffer's default face font."
4738 ;; Avoid calling font-info if the frame's default font was
4739 ;; not changed since the frame was created. That's because
4740 ;; font-info is expensive for some fonts, see bug #14838.
4746 "Return the pixel height of current buffer's default-face text line.
4748 The value includes `line-spacing', if any, defined for the buffer
4749 or the frame."
4762 "Return the number of screen lines in the text area of the selected window.
4764 This is different from `window-text-height' in that this function counts
4765 lines in units of the height of the font used by the default face displayed
4766 in the window, not in units of the frame's default font, and also accounts
4767 for `line-spacing', if any, defined for the window's buffer or frame.
4769 The value is a floating-point number."
4775 ;; Returns non-nil if partial move was done.
4778 ;; Move backward (up).
4779 ;; If already vscrolled, reduce vscroll
4785 ;; Move forward (down).
4798 py vs last-line)
4818 col-row)
4823 ;; VPOS > 0 means the last line is only partially visible.
4824 ;; But if the part that is visible is at least as tall as the
4825 ;; default font, that means the line is actually fully
4826 ;; readable, and something like line-spacing is hidden. So in
4827 ;; that case we accept the last line in the window as still
4828 ;; visible, and consider the margin as starting one line
4829 ;; later.
4837 ;; If last line of window is fully visible, and vscrolling
4838 ;; more would make this line invisible, move forward.
4843 nil)
4844 ;; If cursor is not in the bottom scroll margin, and the
4845 ;; current line is is not too tall, move forward.
4847 vpos
4850 nil)
4851 ;; When already vscrolled, we vscroll some more if we can,
4852 ;; or clear vscroll and move forward at end of tall image.
4857 ;; If cursor just entered the bottom scroll margin, move forward,
4858 ;; but also optionally vscroll one line so redisplay won't recenter.
4862 ;; Don't vscroll if the partially-visible line at window
4863 ;; bottom is not too tall (a.k.a. "just one more text
4864 ;; line"): in that case, we do want redisplay to behave
4865 ;; normally, i.e. recenter or whatever.
4866 ;;
4867 ;; Note: ROWH + RBOT from the value returned by
4868 ;; pos-visible-in-window-p give the total height of the
4869 ;; partially-visible glyph row at the end of the window. As
4870 ;; we are dealing with floats, we disregard sub-pixel
4871 ;; discrepancies between that and DLH.
4875 t)
4876 ;; If there are lines above the last line, scroll-up one line.
4879 t)
4880 ;; Finally, start vscroll.
4885 ;; This is like line-move-1 except that it also performs
4886 ;; vertical scrolling of tall images if appropriate.
4887 ;; That is not really a clean thing to do, since it mixes
4888 ;; scrolling with cursor motion. But so far we don't have
4889 ;; a cleaner solution to the problem of making C-n do something
4890 ;; useful given a tall image.
4895 ;; Only vscroll for single line moves
4897 ;; Under scroll-conservatively, the display engine
4898 ;; does this better.
4900 ;; But don't vscroll in a keyboard macro.
4906 ;; Display-based column are incompatible with goal-column.
4908 ;; When the text in the window is scrolled to the left,
4909 ;; display-based motion doesn't make sense (because each
4910 ;; logical line occupies exactly one screen line).
4913 ;; If we moved into a tall line, set vscroll to make
4914 ;; scrolling through tall images more smooth.
4918 winh)
4924 nil
4928 ;; Display-based alternative to line-move-1.
4929 ;; Arg says how many lines to move. The value is t if we can move the
4930 ;; specified number of lines.
4934 target-hscroll)
4935 ;; Check if the previous command was a line-motion command, or if
4936 ;; we were called from some other command.
4939 ;; If so, there's no need to reset `temporary-goal-column',
4940 ;; but we may need to hscroll.
4944 ;; Otherwise, we should reset `temporary-goal-column'.
4947 ;; Handle the `overflow-newline-into-fringe' case:
4956 ;; vertical-motion can move more than it was asked to if it moves
4957 ;; across display strings with newlines. We don't want to ring
4958 ;; the bell and announce beginning/end of buffer in that case.
4964 temporary-goal-column))
4965 arg))
4966 arg))
4972 temporary-goal-column))
4973 arg))
4974 arg)))
4977 ;; If the goal column lies on a display string,
4978 ;; `vertical-motion' advances the cursor to the end
4979 ;; of the string. For arg < 0, this can cause the
4980 ;; cursor to get stuck. (Bug#3020).
4984 nil)))))
4986 ;; This is the guts of next-line and previous-line.
4987 ;; Arg says how many lines to move.
4988 ;; The value is t if we can move the specified number of lines.
4990 ;; Don't run any point-motion hooks, and disregard intangibility,
4991 ;; for intermediate positions.
5003 ;; Don't count beg of empty line as end of line
5004 ;; unless we just did explicit end-of-line.
5006 most-positive-fixnum
5010 line-move-ignore-invisible))
5011 ;; Use just newline characters.
5012 ;; Set ARG to 0 if we move as many lines as requested.
5015 ;; This way of moving forward ARG lines
5016 ;; verifies that we have a newline after the last one.
5017 ;; It doesn't get confused by intangible text.
5026 'beginning-of-buffer
5028 nil)))
5029 ;; Move by arg lines, but ignore invisible ones.
5032 ;; If the following character is currently invisible,
5033 ;; skip all characters with that same `invisible' property value.
5036 ;; Move a line.
5037 ;; We don't use `end-of-line', since we want to escape
5038 ;; from field boundaries occurring exactly at point.
5044 ;; If there's no invisibility here, move over the newline.
5053 ;; We avoid vertical-motion when possible
5054 ;; because that has to fontify.
5056 ;; Otherwise move a more sophisticated way.
5063 ;; The logic of this is the same as the loop above,
5064 ;; it just goes in the other direction.
5066 ;; For completely consistency with the forward-motion
5067 ;; case, we should call beginning-of-line here.
5068 ;; However, if point is inside a field and on a
5069 ;; continued line, the call to (vertical-motion -1)
5070 ;; below won't move us back far enough; then we return
5071 ;; to the same column in line-move-finish, and point
5072 ;; gets stuck -- cyd
5090 ;; if our target is the middle of this line.
5095 ;; This is the value the function returns.
5099 ;; If we did not move down as far as desired, at least go
5100 ;; to end of line. Be sure to call point-entered and
5101 ;; point-left-hooks.
5107 ;; If we did not move up as far as desired,
5108 ;; at least go to beginning of line.
5120 ;; Set REPEAT to t to repeat the whole thing.
5127 ;; Compute the end of the line
5128 ;; ignoring effectively invisible newlines.
5130 ;; Like end-of-line but ignores fields.
5137 ;; Move to the desired column.
5140 ;; Corner case: suppose we start out in a field boundary in
5141 ;; the middle of a continued line. When we get to
5142 ;; line-move-finish, point is at the start of a new *screen*
5143 ;; line but the same text line; then line-move-to-column would
5144 ;; move us backwards. Test using C-n with point on the "x" in
5145 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5152 ;; Process intangibility within a line.
5153 ;; With inhibit-point-motion-hooks bound to nil, a call to
5154 ;; goto-char moves point past intangible text.
5156 ;; However, inhibit-point-motion-hooks controls both the
5157 ;; intangibility and the point-entered/point-left hooks. The
5158 ;; following hack avoids calling the point-* hooks
5159 ;; unnecessarily. Note that we move *forward* past intangible
5160 ;; text when the initial and final points are the same.
5165 ;; If intangibility moves us to a different (later) place
5166 ;; in the same line, use that as the destination.
5169 ;; If that position is "too late",
5170 ;; try the previous allowable position.
5171 ;; See if it is ok.
5174 ;; If going forward, don't accept the previous
5175 ;; allowable position if it is before the target line.
5177 ;; If going backward, don't accept the previous
5178 ;; allowable position if it is still after the target line.
5181 ;; As a last resort, use the end of the line.
5184 ;; Now move to the updated destination, processing fields
5185 ;; as well as intangibility.
5189 ;; Ignore field boundaries if the initial and final
5190 ;; positions have the same `field' property, even if the
5191 ;; fields are non-contiguous. This seems to be "nicer"
5192 ;; behavior in many situations.
5195 new
5199 ;; If all this moved us to a different line,
5200 ;; retry everything within that new line.
5202 ;; Repeat the intangibility and field processing.
5206 "Try to find column COL, considering invisibility.
5207 This function works only in certain cases,
5208 because what we really need is for `move-to-column'
5209 and `current-column' to be able to ignore invisible text."
5218 ;; If the following character is currently invisible,
5219 ;; skip all characters with that same `invisible' property value.
5223 ;; Have we advanced to a larger column position?
5225 ;; We have made some progress towards the desired column.
5226 ;; See if we can make any further progress.
5228 ;; Otherwise, go to the place we originally found
5229 ;; and move back over invisible text.
5230 ;; that will get us to the same place on the screen
5231 ;; but with a more reasonable buffer position.
5238 "Move point to end of current line as displayed.
5239 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5240 If point reaches the beginning or end of buffer, it stops there.
5242 To ignore the effects of the `intangible' text or overlay
5243 property, bind `inhibit-point-motion-hooks' to t.
5244 If there is an image in the current line, this function
5245 disregards newlines that are part of the text on which the image
5246 rests."
5256 ;; With bidi reordering, we may not be at bol,
5257 ;; so make sure we are.
5272 ;; If we skipped something intangible and now we're not
5273 ;; really at eol, keep going.
5278 "Move point to beginning of current line as displayed.
5279 \(If there's an image in the line, this disregards newlines
5280 which are part of the text that the image rests on.)
5282 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5283 If point reaches the beginning or end of buffer, it stops there.
5284 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5289 first-vis first-vis-field-value)
5291 ;; Move by lines, if ARG is not 1 (the default).
5296 ;; Move to beginning-of-line, ignoring fields and invisible text.
5302 ;; Now find first visible char in the line
5307 ;; See if fields would stop us from reaching FIRST-VIS.
5312 ;; If yes, obey them.
5313 first-vis-field-value
5314 ;; Otherwise, move to START with attention to fields.
5315 ;; (It is possible that fields never matter in this case.)
5320 ;; Many people have said they rarely use this feature, and often type
5321 ;; it by accident. Maybe it shouldn't even be on a key.
5326 Those commands will move to this position in the line moved to
5327 rather than trying to keep the same horizontal position.
5328 With a non-nil argument ARG, clears out the goal column
5330 The goal column is stored in the variable `goal-column'."
5337 ;; The older method below can be erroneous if `set-goal-column' is bound
5338 ;; to a sequence containing %
5339 ;;(message (substitute-command-keys
5340 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
5341 ;;goal-column)
5348 )
5349 nil)
5350 \f
5351 ;;; Editing based on visual lines, as opposed to logical lines.
5354 "Move point to end of current visual line.
5355 With argument N not nil or 1, move forward N - 1 visual lines first.
5356 If point reaches the beginning or end of buffer, it stops there.
5357 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5363 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5364 ;; constrain to field boundaries, so we don't either.
5368 "Move point to beginning of current visual line.
5369 With argument N not nil or 1, move forward N - 1 visual lines first.
5370 If point reaches the beginning or end of buffer, it stops there.
5371 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5379 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5383 "Kill the rest of the visual line.
5384 With prefix argument ARG, kill that many visual lines from point.
5385 If ARG is negative, kill visual lines backward.
5386 If ARG is zero, kill the text before point on the current visual
5387 line.
5389 If you want to append the killed line to the last killed text,
5392 If the buffer is read-only, Emacs will beep and refrain from deleting
5393 the line, but put the line in the kill ring anyway. This means that
5394 you can use this command to copy text from a read-only buffer.
5395 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5396 even beep.)"
5398 ;; Like in `kill-line', it's better to move point to the other end
5399 ;; of the kill before killing.
5407 ;; Skip any trailing whitespace at the end of the visual line.
5408 ;; We used to do this only if `show-trailing-whitespace' is
5409 ;; nil, but that's wrong; the correct thing would be to check
5410 ;; whether the trailing whitespace is highlighted. But, it's
5411 ;; OK to just do this unconditionally.
5418 "Move cursor vertically down ARG lines.
5419 This is identical to `next-line', except that it always moves
5420 by logical lines instead of visual lines, ignoring the value of
5421 the variable `line-move-visual'."
5428 "Move cursor vertically up ARG lines.
5429 This is identical to `previous-line', except that it always moves
5430 by logical lines instead of visual lines, ignoring the value of
5431 the variable `line-move-visual'."
5438 "Editing based on visual lines."
5447 ;; These keybindings interfere with xterm function keys. Are
5448 ;; there any other suitable bindings?
5449 ;; (define-key map "\M-[" 'previous-logical-line)
5450 ;; (define-key map "\M-]" 'next-logical-line)
5451 map))
5454 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5455 The value should be a list of the form (LEFT RIGHT), where LEFT
5456 and RIGHT are symbols representing the bitmaps to display, to
5457 indicate wrapped lines, in the left and right fringes respectively.
5458 See also `fringe-indicator-alist'.
5459 The default is not to display fringe indicators for wrapped lines.
5460 This variable does not affect fringe indicators displayed for
5461 other purposes."
5476 'continuation
5483 "Toggle visual line based editing (Visual Line mode).
5484 With a prefix argument ARG, enable Visual Line mode if ARG is
5485 positive, and disable it otherwise. If called from Lisp, enable
5486 the mode if ARG is omitted or nil.
5488 When Visual Line mode is enabled, `word-wrap' is turned on in
5489 this buffer, and simple editing commands are redefined to act on
5490 visual lines, not logical lines. See Info node `Visual Line
5491 Mode' for details."
5492 :keymap visual-line-mode-map
5498 ;; Save the local values of some variables, to be restored if
5499 ;; visual-line-mode is turned off.
5501 truncate-partial-width-windows
5502 word-wrap fringe-indicator-alist))
5505 visual-line--saved-state)))
5509 word-wrap t
5510 fringe-indicator-alist
5512 fringe-indicator-alist)))
5526 visual-line-mode turn-on-visual-line-mode)
5528 \f
5530 "Interchange characters around point, moving forward one character.
5531 With prefix arg ARG, effect is to take character before point
5532 and drag it forward past ARG other characters (backward if ARG negative).
5533 If no argument and at end of line, the previous two chars are exchanged."
5539 "Interchange words around point, leaving point at end of them.
5540 With prefix arg ARG, effect is to take word before or around point
5541 and drag it forward past ARG other words (backward if ARG negative).
5542 If ARG is zero, the words around or after point and around or after mark
5543 are interchanged."
5544 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5550 Does not work on a sexp that point is in the middle of
5551 if it is a list or string."
5555 ;; Here we should try to simulate the behavior of
5556 ;; (cons (progn (forward-sexp x) (point))
5557 ;; (progn (forward-sexp (- x)) (point)))
5558 ;; Except that we don't want to rely on the second forward-sexp
5559 ;; putting us back to where we want to be, since forward-sexp-function
5560 ;; might do funny things like infix-precedence.
5565 ;; Jumping over a symbol. We might be inside it, mind you.
5570 ;; Otherwise, we're between sexps. Take a step back before jumping
5571 ;; to make sure we'll obey the same precedence no matter which direction
5572 ;; we're going.
5577 'skip-syntax-forward
5584 "Exchange current line and previous line, leaving point after both.
5585 With argument ARG, takes previous line and moves it past ARG lines.
5586 With argument 0, interchanges line point is in with line mark is in."
5592 ;; Move forward over ARG lines,
5593 ;; but create newlines if necessary.
5600 arg))
5602 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5603 ;; which seems inconsistent with the ARG /= 0 case.
5604 ;; FIXME document SPECIAL.
5606 "Subroutine to do the work of transposing objects.
5607 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5608 moves forward by units of the given object (e.g. forward-sentence,
5609 forward-paragraph). If ARG is zero, exchanges the current object
5610 with the one containing mark. If ARG is an integer, moves the
5611 current object past ARG following (if ARG is positive) or
5612 preceding (if ARG is negative) objects, leaving point after the
5613 current object."
5618 pos1 pos2)
5646 ;; This sequence of insertions attempts to preserve marker
5647 ;; positions at the start and end of the transposed objects.
5661 \f
5663 "Move backward until encountering the beginning of a word.
5664 With argument ARG, do this that many times.
5665 If ARG is omitted or nil, move point backward one word."
5670 "Set mark ARG words away from point.
5672 move to with the same argument.
5673 Interactively, if this command is repeated
5674 or (in Transient Mark mode) if the mark is active,
5675 it marks the next ARG words after the ones already marked."
5692 nil t))))
5695 "Kill characters forward until encountering the end of a word.
5696 With argument ARG, do this that many times."
5701 "Kill characters backward until encountering the beginning of a word.
5702 With argument ARG, do this that many times."
5707 "Return the symbol or word that point is on (or a nearby one) as a string.
5708 The return value includes no text properties.
5709 If optional arg STRICT is non-nil, return nil unless point is within
5710 or adjacent to a symbol or word. In all cases the value can be nil
5711 if there is no word nearby.
5712 The function, belying its name, normally finds a symbol.
5713 If optional arg REALLY-WORD is non-nil, it finds just a word."
5722 ;; Point is neither within nor adjacent to a word.
5724 ;; Look for preceding word in same line.
5727 ;; No preceding word in same line.
5728 ;; Look for following word in same line.
5737 ;; If we found something nonempty, return it as a string.
5740 \f
5742 "String for filling to insert at front of new line, or nil for none."
5744 string)
5750 "Regexp to match lines which should not be auto-filled."
5752 regexp)
5756 "The default value for `normal-auto-fill-function'.
5757 This is the default auto-fill function, some major modes use a different one.
5758 Returns t if it really did any work."
5768 nil ;; Auto-filling not required
5772 ;; Choose a fill-prefix automatically.
5780 ;; Use auto-indentation rather than a guessed empty prefix.
5786 ;; Determine where to split the line.
5799 ;; See whether the place we found is any good.
5803 ;; There is no use breaking at end of line.
5805 ;; It is futile to split at the end of the prefix
5806 ;; since we would just insert the prefix again.
5808 ;; Don't split right after a comment starter
5809 ;; since we would just make another comment starter.
5814 limit t)
5816 ;; No good place to break => stop trying.
5818 ;; Ok, we have a useful place to break the line. Do it.
5820 ;; If point is at the fill-point, do not `save-excursion'.
5821 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5822 ;; point will end up before it rather than after it.
5830 ;; Now do justification, if required
5835 ;; If making the new line didn't reduce the hpos of
5836 ;; the end of the line, then give up now;
5837 ;; trying again will not help.
5840 ;; Justify last line.
5842 t)))
5845 "Mode-specific function which line breaks and continues a comment.
5846 This function is called during auto-filling when a comment syntax
5847 is defined.
5848 The function should take a single optional argument, which is a flag
5852 "Break line at point and indent.
5853 If a comment syntax is defined, call `comment-indent-new-line'.
5855 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5856 unless optional argument SOFT is non-nil."
5860 ;; Insert the newline before removing empty space so that markers
5861 ;; get preserved better.
5867 ;; Blindly trust a non-adaptive fill-prefix.
5873 ;; If there's an adaptive prefix, use it unless we're inside
5874 ;; a comment and the prefix is not a comment starter.
5878 ;; If we're not inside a comment, just try to indent.
5882 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5886 ;; `functions' and `hooks' are usually unsafe to set, but setting
5887 ;; auto-fill-function to nil in a file-local setting is safe and
5888 ;; can be useful to prevent auto-filling.
5892 "Toggle automatic line breaking (Auto Fill mode).
5893 With a prefix argument ARG, enable Auto Fill mode if ARG is
5894 positive, and disable it otherwise. If called from Lisp, enable
5895 the mode if ARG is omitted or nil.
5897 When Auto Fill mode is enabled, inserting a space at a column
5898 beyond `current-fill-column' automatically breaks the line at a
5899 previous space.
5901 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5902 non-`nil'.
5904 The value of `normal-auto-fill-function' specifies the function to use
5905 for `auto-fill-function' when turning Auto Fill mode on."
5910 ;; This holds a document string used to document auto-fill-mode.
5912 "Automatically break line at a previous space, in insertion of text."
5913 nil)
5916 "Unconditionally turn on Auto Fill mode."
5920 "Unconditionally turn off Auto Fill mode."
5926 "Set `fill-column' to specified argument.
5931 ;; We used to use current-column silently, but C-x f is too easily
5932 ;; typed as a typo for C-x C-f, so we turned it into an error and
5933 ;; now an interactive prompt.
5938 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5942 \f
5944 "Set `selective-display' to ARG; clear it if no arg.
5945 When the value of `selective-display' is a number > 0,
5946 lines whose indentation is >= that value are not displayed.
5947 The variable `selective-display' has a separate value for each buffer."
5967 "Toggle truncating of long lines for the current buffer.
5968 When truncating is off, long lines are folded.
5969 With prefix argument ARG, truncate long lines if ARG is positive,
5970 otherwise fold them. Note that in side-by-side windows, this
5971 command has no effect if `truncate-partial-width-windows' is
5972 non-nil."
5984 nil t)))
5989 "Toggle whether to use word-wrapping for continuation lines.
5990 With prefix argument ARG, wrap continuation lines at word boundaries
5991 if ARG is positive, otherwise wrap them at the right screen edge.
5992 This command toggles the value of `word-wrap'. It has no effect
5993 if long lines are truncated."
6009 "Toggle Overwrite mode.
6010 With a prefix argument ARG, enable Overwrite mode if ARG is
6011 positive, and disable it otherwise. If called from Lisp, enable
6012 the mode if ARG is omitted or nil.
6014 When Overwrite mode is enabled, printing characters typed in
6015 replace existing text on a one-for-one basis, rather than pushing
6016 it to the right. At the end of a line, such characters extend
6017 the line. Before a tab, such characters insert until the tab is
6019 overwrite mode; this is supposed to make it easier to insert
6020 characters when necessary."
6025 "Toggle Binary Overwrite mode.
6026 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6027 is positive, and disable it otherwise. If called from Lisp,
6028 enable the mode if ARG is omitted or nil.
6030 When Binary Overwrite mode is enabled, printing characters typed
6031 in replace existing text. Newlines are not treated specially, so
6032 typing at the end of a line joins the line to the next, with the
6033 typed character between them. Typing before a tab character
6034 simply replaces the tab with the character typed.
6036 ordinary typing characters do.
6038 Note that Binary Overwrite mode is not its own minor mode; it is
6039 a specialization of overwrite mode, entered by setting the
6040 `overwrite-mode' variable to `overwrite-mode-binary'."
6045 "Toggle line number display in the mode line (Line Number mode).
6046 With a prefix argument ARG, enable Line Number mode if ARG is
6047 positive, and disable it otherwise. If called from Lisp, enable
6048 the mode if ARG is omitted or nil.
6050 Line numbers do not appear for very large buffers and buffers
6051 with very long lines; see variables `line-number-display-limit'
6052 and `line-number-display-limit-width'."
6056 "Toggle column number display in the mode line (Column Number mode).
6057 With a prefix argument ARG, enable Column Number mode if ARG is
6058 positive, and disable it otherwise.
6060 If called from Lisp, enable the mode if ARG is omitted or nil."
6064 "Toggle buffer size display in the mode line (Size Indication mode).
6065 With a prefix argument ARG, enable Size Indication mode if ARG is
6066 positive, and disable it otherwise.
6068 If called from Lisp, enable the mode if ARG is omitted or nil."
6072 "Toggle auto-saving in the current buffer (Auto Save mode).
6073 With a prefix argument ARG, enable Auto Save mode if ARG is
6074 positive, and disable it otherwise.
6076 If called from Lisp, enable the mode if ARG is omitted or nil."
6078 ;; If auto-save is off because buffer has shrunk,
6079 ;; then toggling should turn it on.
6087 buffer-file-name)
6089 ;; If -1 was stored here, to temporarily turn off saving,
6090 ;; turn it back on.
6093 \f
6095 "Blinking matching of parens and expressions."
6100 "Non-nil means show matching open-paren when close-paren is inserted."
6105 "Non-nil means show matching open-paren when it is on screen.
6106 If nil, don't show it (but the open-paren can still be shown
6107 when it is off screen).
6109 This variable has no effect if `blink-matching-paren' is nil.
6110 \(In that case, the open-paren is never shown.)
6111 It is also ignored if `show-paren-mode' is enabled."
6116 "If non-nil, maximum distance to search backwards for matching open-paren.
6117 If nil, search stops at the beginning of the accessible portion of the buffer."
6123 "Time in seconds to delay after showing a matching paren."
6128 "If nil, `blink-matching-paren' ignores comments.
6129 More precisely, when looking for the matching parenthesis,
6130 it skips the contents of comments that end before point."
6135 "Return whether or not START...END are matching parens.
6136 END is the current point and START is the blink position.
6137 START might be nil if no matching starter was found.
6138 Returns non-nil if we find there is a mismatch."
6143 ;; For self-matched chars like " and $, we can't know when they're
6144 ;; mismatched or unmatched, so we can only do it for parens.
6149 ;; The cdr might hold a new paren-class info rather than
6150 ;; a matching-char info, in which case the two CDRs
6151 ;; should match.
6155 "Function to check parentheses mismatches.
6156 The function takes two arguments (START and END) where START is the
6157 position just before the opening token and END is the position right after.
6158 START can be nil, if it was not found.
6162 "Move cursor momentarily to the beginning of the sexp before point."
6165 blink-matching-paren)
6175 oldpos))
6182 ;; backward-sexp skips backward over prefix chars,
6183 ;; so move back to the matching paren.
6204 ;; Matching open within window, temporarily move to blinkpos but only
6205 ;; if `blink-matching-paren-on-screen' is non-nil.
6215 ;; Show what precedes the open in its line, if anything.
6220 ;; Show what follows the open in its line, if anything.
6227 ;; Otherwise show the previous nonblank line,
6228 ;; if there is one.
6237 ;; Replace the newline and other whitespace with `...'.
6238 "..."
6240 ;; There is nothing to show except the char itself.
6246 "Function called, if non-nil, whenever a close parenthesis is inserted.
6252 blink-paren-function
6255 ;; Verify an even number of quoting characters precede the close.
6264 ;; Most likely, this hook is nil, so this arg doesn't matter,
6265 ;; but I use it as a reminder that this function usually
6266 ;; likes to be run after others since it does `sit-for'.
6268 \f
6269 ;; This executes C-g typed while Emacs is waiting for a command.
6270 ;; Quitting out of a program does not go through here;
6271 ;; that happens in the QUIT macro at the C code level.
6273 "Signal a `quit' condition.
6274 During execution of Lisp code, this character causes a quit directly.
6275 At top-level, as an editor command, this simply beeps."
6277 ;; Avoid adding the region to the window selection.
6294 This command can exit an interactive command such as `query-replace',
6295 can clear out a prefix argument or a region,
6296 can get out of the minibuffer or other recursive edit,
6297 cancel the use of the current buffer (for special-purpose buffers),
6298 or go back to just one window (by deleting all but the selected window)."
6306 nil)
6317 "Play sound stored in FILE.
6318 VOLUME and DEVICE correspond to the keywords of the sound
6319 specification for `play-sound'."
6329 \f
6331 "Your preference for a mail reading package.
6332 This is used by some keybindings which support reading mail.
6333 See also `mail-user-agent' concerning sending mail."
6343 "Your preference for a mail composition package.
6344 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6345 outgoing email message. This variable lets you specify which
6346 mail-sending package you prefer.
6348 Valid values include:
6350 `message-user-agent' -- use the Message package.
6351 See Info node `(message)'.
6352 `sendmail-user-agent' -- use the Mail package.
6353 See Info node `(emacs)Sending Mail'.
6354 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6355 See Info node `(mh-e)'.
6356 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6357 paraphernalia if Gnus is running, particularly
6358 the Gcc: header for archiving.
6360 Additional valid symbols may be available; check with the author of
6361 your package for details. The function should return non-nil if it
6362 succeeds.
6364 See also `read-mail-command' concerning reading mail."
6367 message-user-agent)
6370 sendmail-user-agent)
6373 mh-e-user-agent)
6376 gnus-user-agent)
6382 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6383 If the value of `mail-user-agent' is the default, and the user
6384 appears to have customizations applying to the old default,
6385 `compose-mail' issues a warning."
6391 "If the buffer starts with a mail header, move point to the header's end.
6392 Otherwise, moves to `point-min'.
6393 The end of the header is the start of the next line, if there is one,
6394 else the end of the last line. This function obeys RFC822."
6400 ;; Used by Rmail (e.g., rmail-forward).
6402 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6406 switch-function yank-action send-actions
6407 return-action)
6408 "Start composing a mail message to send.
6409 This uses the user's chosen mail composition package
6410 as selected with the variable `mail-user-agent'.
6411 The optional arguments TO and SUBJECT specify recipients
6412 and the initial Subject field, respectively.
6414 OTHER-HEADERS is an alist specifying additional
6415 header fields. Elements look like (HEADER . VALUE) where both
6416 HEADER and VALUE are strings.
6418 CONTINUE, if non-nil, says to continue editing a message already
6419 being composed. Interactively, CONTINUE is the prefix argument.
6421 SWITCH-FUNCTION, if non-nil, is a function to use to
6422 switch to and display the buffer used for mail composition.
6424 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6425 to insert the raw text of the message being replied to.
6426 It has the form (FUNCTION . ARGS). The user agent will apply
6427 FUNCTION to ARGS, to insert the raw text of the original message.
6428 \(The user agent will also run `mail-citation-hook', *after* the
6429 original text has been inserted in this way.)
6431 SEND-ACTIONS is a list of actions to call when the message is sent.
6432 Each action has the form (FUNCTION . ARGS).
6434 RETURN-ACTION, if non-nil, is an action for returning to the
6435 caller. It has the form (FUNCTION . ARGS). The function is
6436 called after the mail has been sent or put aside, and the mail
6437 buffer buried."
6441 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6442 ;; from sendmail-user-agent to message-user-agent. Some users may
6443 ;; encounter incompatibilities. This hack tries to detect problems
6444 ;; and warn about them.
6449 mail-yank-hooks mail-archive-file-name
6450 mail-default-reply-to mail-mailing-lists
6451 mail-self-blind))
6458 The default mail mode is now Message mode.
6459 You have the following Mail mode variable%s customized:
6461 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6468 yank-action send-actions return-action)))
6471 yank-action send-actions
6472 return-action)
6476 'switch-to-buffer-other-window yank-action send-actions
6477 return-action))
6480 yank-action send-actions
6481 return-action)
6485 'switch-to-buffer-other-frame yank-action send-actions
6486 return-action))
6488 \f
6490 "History of values entered with `set-variable'.
6492 Maximum length of the history list is determined by the value
6496 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6497 VARIABLE should be a user option variable name, a Lisp variable
6498 meant to be customized by users. You should enter VALUE in Lisp syntax,
6499 so if you want VALUE to be a string, you must surround it with doublequotes.
6500 VALUE is used literally, not evaluated.
6502 If VARIABLE has a `variable-interactive' property, that is used as if
6503 it were the arg to `interactive' (which see) to interactively read VALUE.
6505 If VARIABLE has been defined with `defcustom', then the type information
6506 in the definition is used to check that VALUE is valid.
6508 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6513 default-var)
6529 var obsolete)
6532 ;; Use VAR's `variable-interactive' property
6533 ;; as an interactive spec for prompting.
6536 arg))
6538 read-expression-map t
6539 'set-variable-value-history
6548 ;; Match with custom type.
6560 ;; Force a thorough redisplay for the case that the variable
6561 ;; has an effect on the display, like `tab-width' has.
6563 \f
6564 ;; Define the major mode for lists of completions.
6574 (define-key map [right] 'next-completion)
6575 (define-key map "q" 'quit-window)
6576 (define-key map "z" 'kill-this-buffer)
6577 map)
6578 "Local map for completion list buffers.")
6580 ;; Completion mode is suitable only for specially formatted data.
6581 (put 'completion-list-mode 'mode-class 'special)
6583 (defvar completion-reference-buffer nil
6584 "Record the buffer that was current when the completion list was requested.
6585 This is a local variable in the completion list buffer.
6586 Initial value is nil to avoid some compiler warnings.")
6588 (defvar completion-no-auto-exit nil
6589 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6590 This also applies to other functions such as `choose-completion'.")
6592 (defvar completion-base-position nil
6593 "Position of the base of the text corresponding to the shown completions.
6594 This variable is used in the *Completions* buffers.
6595 Its value is a list of the form (START END) where START is the place
6596 where the completion should be inserted and END (if non-nil) is the end
6597 of the text to replace. If END is nil, point is used instead.")
6599 (defvar completion-list-insert-choice-function #'completion--replace
6600 "Function to use to insert the text chosen in *Completions*.
6601 Called with three arguments (BEG END TEXT), it should replace the text
6602 between BEG and END with TEXT. Expected to be set buffer-locally
6603 in the *Completions* buffer.")
6605 (defvar completion-base-size nil
6606 "Number of chars before point not involved in completion.
6607 This is a local variable in the completion list buffer.
6608 It refers to the chars in the minibuffer if completing in the
6609 minibuffer, or in `completion-reference-buffer' otherwise.
6610 Only characters in the field at point are included.
6612 If nil, Emacs determines which part of the tail end of the
6613 buffer's text is involved in completion by comparing the text
6614 directly.")
6615 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6617 (defun delete-completion-window ()
6618 "Delete the completion list window.
6619 Go to the window from which completion was requested."
6620 (interactive)
6621 (let ((buf completion-reference-buffer))
6622 (if (one-window-p t)
6623 (if (window-dedicated-p) (delete-frame))
6624 (delete-window (selected-window))
6625 (if (get-buffer-window buf)
6626 (select-window (get-buffer-window buf))))))
6628 (defun previous-completion (n)
6629 "Move to the previous item in the completion list."
6630 (interactive "p")
6631 (next-completion (- n)))
6633 (defun next-completion (n)
6634 "Move to the next item in the completion list.
6635 With prefix argument N, move N items (negative N means move backward)."
6636 (interactive "p")
6637 (let ((beg (point-min)) (end (point-max)))
6638 (while (and (> n 0) (not (eobp)))
6639 ;; If in a completion, move to the end of it.
6640 (when (get-text-property (point) 'mouse-face)
6641 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6642 ;; Move to start of next one.
6643 (unless (get-text-property (point) 'mouse-face)
6644 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6645 (setq n (1- n)))
6646 (while (and (< n 0) (not (bobp)))
6647 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6648 ;; If in a completion, move to the start of it.
6649 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6650 (goto-char (previous-single-property-change
6651 (point) 'mouse-face nil beg)))
6652 ;; Move to end of the previous completion.
6653 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6654 (goto-char (previous-single-property-change
6655 (point) 'mouse-face nil beg)))
6656 ;; Move to the start of that one.
6657 (goto-char (previous-single-property-change
6658 (point) 'mouse-face nil beg))
6659 (setq n (1+ n))))))
6661 (defun choose-completion (&optional event)
6662 "Choose the completion at point."
6663 (interactive (list last-nonmenu-event))
6664 ;; In case this is run via the mouse, give temporary modes such as
6665 ;; isearch a chance to turn off.
6666 (run-hooks 'mouse-leave-buffer-hook)
6667 (with-current-buffer (window-buffer (posn-window (event-start event)))
6668 (let ((buffer completion-reference-buffer)
6669 (base-size completion-base-size)
6670 (base-position completion-base-position)
6671 (insert-function completion-list-insert-choice-function)
6672 (choice
6673 (save-excursion
6674 (goto-char (posn-point (event-start event)))
6675 (let (beg end)
6676 (cond
6677 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6678 (setq end (point) beg (1+ (point))))
6679 ((and (not (bobp))
6680 (get-text-property (1- (point)) 'mouse-face))
6681 (setq end (1- (point)) beg (point)))
6682 (t (error "No completion here")))
6683 (setq beg (previous-single-property-change beg 'mouse-face))
6684 (setq end (or (next-single-property-change end 'mouse-face)
6685 (point-max)))
6686 (buffer-substring-no-properties beg end)))))
6688 (unless (buffer-live-p buffer)
6689 (error "Destination buffer is dead"))
6690 (quit-window nil (posn-window (event-start event)))
6692 (with-current-buffer buffer
6693 (choose-completion-string
6694 choice buffer
6695 (or base-position
6696 (when base-size
6697 ;; Someone's using old completion code that doesn't know
6698 ;; about base-position yet.
6699 (list (+ base-size (field-beginning))))
6700 ;; If all else fails, just guess.
6701 (list (choose-completion-guess-base-position choice)))
6702 insert-function)))))
6704 ;; Delete the longest partial match for STRING
6705 ;; that can be found before POINT.
6706 (defun choose-completion-guess-base-position (string)
6707 (save-excursion
6708 (let ((opoint (point))
6709 len)
6710 ;; Try moving back by the length of the string.
6711 (goto-char (max (- (point) (length string))
6712 (minibuffer-prompt-end)))
6713 ;; See how far back we were actually able to move. That is the
6714 ;; upper bound on how much we can match and delete.
6715 (setq len (- opoint (point)))
6716 (if completion-ignore-case
6717 (setq string (downcase string)))
6718 (while (and (> len 0)
6719 (let ((tail (buffer-substring (point) opoint)))
6720 (if completion-ignore-case
6721 (setq tail (downcase tail)))
6722 (not (string= tail (substring string 0 len)))))
6723 (setq len (1- len))
6724 (forward-char 1))
6725 (point))))
6727 (defun choose-completion-delete-max-match (string)
6728 (declare (obsolete choose-completion-guess-base-position "23.2"))
6729 (delete-region (choose-completion-guess-base-position string) (point)))
6731 (defvar choose-completion-string-functions nil
6732 "Functions that may override the normal insertion of a completion choice.
6733 These functions are called in order with four arguments:
6734 CHOICE - the string to insert in the buffer,
6735 BUFFER - the buffer in which the choice should be inserted,
6736 MINI-P - non-nil if BUFFER is a minibuffer, and
6737 BASE-SIZE - the number of characters in BUFFER before
6738 the string being completed.
6740 If a function in the list returns non-nil, that function is supposed
6741 to have inserted the CHOICE in the BUFFER, and possibly exited
6742 the minibuffer; no further functions will be called.
6744 If all functions in the list return nil, that means to use
6745 the default method of inserting the completion in BUFFER.")
6747 (defun choose-completion-string (choice &optional
6748 buffer base-position insert-function)
6749 "Switch to BUFFER and insert the completion choice CHOICE.
6750 BASE-POSITION says where to insert the completion.
6751 INSERT-FUNCTION says how to insert the completion and falls
6752 back on `completion-list-insert-choice-function' when nil."
6754 ;; If BUFFER is the minibuffer, exit the minibuffer
6755 ;; unless it is reading a file name and CHOICE is a directory,
6756 ;; or completion-no-auto-exit is non-nil.
6758 ;; Some older code may call us passing `base-size' instead of
6759 ;; `base-position'. It's difficult to make any use of `base-size',
6760 ;; so we just ignore it.
6761 (unless (consp base-position)
6762 (message "Obsolete `base-size' passed to choose-completion-string")
6763 (setq base-position nil))
6765 (let* ((buffer (or buffer completion-reference-buffer))
6766 (mini-p (minibufferp buffer)))
6767 ;; If BUFFER is a minibuffer, barf unless it's the currently
6768 ;; active minibuffer.
6769 (if (and mini-p
6770 (not (and (active-minibuffer-window)
6771 (equal buffer
6772 (window-buffer (active-minibuffer-window))))))
6773 (error "Minibuffer is not active for completion")
6774 ;; Set buffer so buffer-local choose-completion-string-functions works.
6775 (set-buffer buffer)
6776 (unless (run-hook-with-args-until-success
6777 'choose-completion-string-functions
6778 ;; The fourth arg used to be `mini-p' but was useless
6779 ;; (since minibufferp can be used on the `buffer' arg)
6780 ;; and indeed unused. The last used to be `base-size', so we
6781 ;; keep it to try and avoid breaking old code.
6782 choice buffer base-position nil)
6783 ;; This remove-text-properties should be unnecessary since `choice'
6784 ;; comes from buffer-substring-no-properties.
6785 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6786 ;; Insert the completion into the buffer where it was requested.
6787 (funcall (or insert-function completion-list-insert-choice-function)
6788 (or (car base-position) (point))
6789 (or (cadr base-position) (point))
6790 choice)
6791 ;; Update point in the window that BUFFER is showing in.
6792 (let ((window (get-buffer-window buffer t)))
6793 (set-window-point window (point)))
6794 ;; If completing for the minibuffer, exit it with this choice.
6795 (and (not completion-no-auto-exit)
6796 (minibufferp buffer)
6797 minibuffer-completion-table
6798 ;; If this is reading a file name, and the file name chosen
6799 ;; is a directory, don't exit the minibuffer.
6800 (let* ((result (buffer-substring (field-beginning) (point)))
6801 (bounds
6802 (completion-boundaries result minibuffer-completion-table
6803 minibuffer-completion-predicate
6804 "")))
6805 (if (eq (car bounds) (length result))
6806 ;; The completion chosen leads to a new set of completions
6807 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6808 (let ((mini (active-minibuffer-window)))
6809 (select-window mini)
6810 (when minibuffer-auto-raise
6811 (raise-frame (window-frame mini))))
6812 (exit-minibuffer))))))))
6814 (define-derived-mode completion-list-mode nil "Completion List"
6815 "Major mode for buffers showing lists of possible completions.
6817 to select the completion near point.
6819 with the mouse.
6822 (set (make-local-variable 'completion-base-size) nil))
6824 (defun completion-list-mode-finish ()
6825 "Finish setup of the completions buffer.
6826 Called from `temp-buffer-show-hook'."
6827 (when (eq major-mode 'completion-list-mode)
6828 (setq buffer-read-only t)))
6830 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6833 ;; Variables and faces used in `completion-setup-function'.
6835 (defcustom completion-show-help t
6836 "Non-nil means show help message in *Completions* buffer."
6837 :type 'boolean
6838 :version "22.1"
6839 :group 'completion)
6841 ;; This function goes in completion-setup-hook, so that it is called
6842 ;; after the text of the completion list buffer is written.
6843 (defun completion-setup-function ()
6844 (let* ((mainbuf (current-buffer))
6845 (base-dir
6846 ;; FIXME: This is a bad hack. We try to set the default-directory
6847 ;; in the *Completions* buffer so that the relative file names
6848 ;; displayed there can be treated as valid file names, independently
6849 ;; from the completion context. But this suffers from many problems:
6850 ;; - It's not clear when the completions are file names. With some
6851 ;; completion tables (e.g. bzr revision specs), the listed
6852 ;; completions can mix file names and other things.
6853 ;; - It doesn't pay attention to possible quoting.
6854 ;; - With fancy completion styles, the code below will not always
6855 ;; find the right base directory.
6856 (if minibuffer-completing-file-name
6857 (file-name-as-directory
6858 (expand-file-name
6859 (buffer-substring (minibuffer-prompt-end)
6860 (- (point) (or completion-base-size 0))))))))
6861 (with-current-buffer standard-output
6862 (let ((base-size completion-base-size) ;Read before killing localvars.
6863 (base-position completion-base-position)
6864 (insert-fun completion-list-insert-choice-function))
6865 (completion-list-mode)
6866 (set (make-local-variable 'completion-base-size) base-size)
6867 (set (make-local-variable 'completion-base-position) base-position)
6868 (set (make-local-variable 'completion-list-insert-choice-function)
6869 insert-fun))
6870 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6871 (if base-dir (setq default-directory base-dir))
6872 ;; Maybe insert help string.
6873 (when completion-show-help
6874 (goto-char (point-min))
6875 (if (display-mouse-p)
6876 (insert (substitute-command-keys
6878 (insert (substitute-command-keys
6882 (add-hook 'completion-setup-hook 'completion-setup-function)
6884 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6885 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6887 (defun switch-to-completions ()
6888 "Select the completion list window."
6889 (interactive)
6890 (let ((window (or (get-buffer-window "*Completions*" 0)
6891 ;; Make sure we have a completions window.
6892 (progn (minibuffer-completion-help)
6893 (get-buffer-window "*Completions*" 0)))))
6894 (when window
6895 (select-window window)
6896 ;; In the new buffer, go to the first completion.
6897 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6898 (when (bobp)
6899 (next-completion 1)))))
6900 \f
6901 ;;; Support keyboard commands to turn on various modifiers.
6903 ;; These functions -- which are not commands -- each add one modifier
6904 ;; to the following event.
6906 (defun event-apply-alt-modifier (_ignore-prompt)
6909 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6910 (defun event-apply-super-modifier (_ignore-prompt)
6913 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6914 (defun event-apply-hyper-modifier (_ignore-prompt)
6917 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6918 (defun event-apply-shift-modifier (_ignore-prompt)
6921 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6922 (defun event-apply-control-modifier (_ignore-prompt)
6925 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6926 (defun event-apply-meta-modifier (_ignore-prompt)
6929 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6931 (defun event-apply-modifier (event symbol lshiftby prefix)
6932 "Apply a modifier flag to event EVENT.
6933 SYMBOL is the name of this modifier, as a symbol.
6934 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6935 PREFIX is the string that represents this modifier in an event type symbol."
6936 (if (numberp event)
6937 (cond ((eq symbol 'control)
6938 (if (and (<= (downcase event) ?z)
6939 (>= (downcase event) ?a))
6940 (- (downcase event) ?a -1)
6941 (if (and (<= (downcase event) ?Z)
6942 (>= (downcase event) ?A))
6943 (- (downcase event) ?A -1)
6944 (logior (lsh 1 lshiftby) event))))
6945 ((eq symbol 'shift)
6946 (if (and (<= (downcase event) ?z)
6947 (>= (downcase event) ?a))
6948 (upcase event)
6949 (logior (lsh 1 lshiftby) event)))
6950 (t
6951 (logior (lsh 1 lshiftby) event)))
6952 (if (memq symbol (event-modifiers event))
6953 event
6954 (let ((event-type (if (symbolp event) event (car event))))
6955 (setq event-type (intern (concat prefix (symbol-name event-type))))
6956 (if (symbolp event)
6957 event-type
6958 (cons event-type (cdr event)))))))
6960 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6961 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6962 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6963 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6964 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6965 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6966 \f
6967 ;;;; Keypad support.
6969 ;; Make the keypad keys act like ordinary typing keys. If people add
6970 ;; bindings for the function key symbols, then those bindings will
6971 ;; override these, so this shouldn't interfere with any existing
6972 ;; bindings.
6974 ;; Also tell read-char how to handle these keys.
6975 (mapc
6976 (lambda (keypad-normal)
6977 (let ((keypad (nth 0 keypad-normal))
6978 (normal (nth 1 keypad-normal)))
6979 (put keypad 'ascii-character normal)
6980 (define-key function-key-map (vector keypad) (vector normal))))
6981 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6982 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6983 (kp-space ?\s)
6986 (kp-multiply ?*)
6987 (kp-add ?+)
6988 (kp-separator ?,)
6989 (kp-subtract ?-)
6990 (kp-decimal ?.)
6991 (kp-divide ?/)
6992 (kp-equal ?=)
6993 ;; Do the same for various keys that are represented as symbols under
6994 ;; GUIs but naturally correspond to characters.
6995 (backspace 127)
6996 (delete 127)
6999 (clear ?\C-l)
7000 (return ?\C-m)
7001 (escape ?\e)
7002 ))
7003 \f
7004 ;;;;
7005 ;;;; forking a twin copy of a buffer.
7006 ;;;;
7008 (defvar clone-buffer-hook nil
7009 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7011 (defvar clone-indirect-buffer-hook nil
7012 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7014 (defun clone-process (process &optional newname)
7015 "Create a twin copy of PROCESS.
7016 If NEWNAME is nil, it defaults to PROCESS' name;
7017 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7018 If PROCESS is associated with a buffer, the new process will be associated
7019 with the current buffer instead.
7020 Returns nil if PROCESS has already terminated."
7021 (setq newname (or newname (process-name process)))
7023 (setq newname (substring newname 0 (match-beginning 0))))
7024 (when (memq (process-status process) '(run stop open))
7025 (let* ((process-connection-type (process-tty-name process))
7026 (new-process
7027 (if (memq (process-status process) '(open))
7028 (let ((args (process-contact process t)))
7029 (setq args (plist-put args :name newname))
7030 (setq args (plist-put args :buffer
7031 (if (process-buffer process)
7032 (current-buffer))))
7033 (apply 'make-network-process args))
7034 (apply 'start-process newname
7035 (if (process-buffer process) (current-buffer))
7036 (process-command process)))))
7037 (set-process-query-on-exit-flag
7038 new-process (process-query-on-exit-flag process))
7039 (set-process-inherit-coding-system-flag
7040 new-process (process-inherit-coding-system-flag process))
7041 (set-process-filter new-process (process-filter process))
7042 (set-process-sentinel new-process (process-sentinel process))
7043 (set-process-plist new-process (copy-sequence (process-plist process)))
7044 new-process)))
7046 ;; things to maybe add (currently partly covered by `funcall mode'):
7047 ;; - syntax-table
7048 ;; - overlays
7049 (defun clone-buffer (&optional newname display-flag)
7050 "Create and return a twin copy of the current buffer.
7051 Unlike an indirect buffer, the new buffer can be edited
7052 independently of the old one (if it is not read-only).
7053 NEWNAME is the name of the new buffer. It may be modified by
7054 adding or incrementing <N> at the end as necessary to create a
7055 unique buffer name. If nil, it defaults to the name of the
7056 current buffer, with the proper suffix. If DISPLAY-FLAG is
7057 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7058 clone a file-visiting buffer, or a buffer whose major mode symbol
7059 has a non-nil `no-clone' property, results in an error.
7061 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7062 current buffer with appropriate suffix. However, if a prefix
7063 argument is given, then the command prompts for NEWNAME in the
7064 minibuffer.
7066 This runs the normal hook `clone-buffer-hook' in the new buffer
7067 after it has been set up properly in other respects."
7068 (interactive
7069 (progn
7070 (if buffer-file-name
7071 (error "Cannot clone a file-visiting buffer"))
7072 (if (get major-mode 'no-clone)
7073 (error "Cannot clone a buffer in %s mode" mode-name))
7074 (list (if current-prefix-arg
7075 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7076 t)))
7077 (if buffer-file-name
7078 (error "Cannot clone a file-visiting buffer"))
7079 (if (get major-mode 'no-clone)
7080 (error "Cannot clone a buffer in %s mode" mode-name))
7081 (setq newname (or newname (buffer-name)))
7083 (setq newname (substring newname 0 (match-beginning 0))))
7084 (let ((buf (current-buffer))
7085 (ptmin (point-min))
7086 (ptmax (point-max))
7087 (pt (point))
7088 (mk (if mark-active (mark t)))
7089 (modified (buffer-modified-p))
7090 (mode major-mode)
7091 (lvars (buffer-local-variables))
7092 (process (get-buffer-process (current-buffer)))
7093 (new (generate-new-buffer (or newname (buffer-name)))))
7094 (save-restriction
7095 (widen)
7096 (with-current-buffer new
7097 (insert-buffer-substring buf)))
7098 (with-current-buffer new
7099 (narrow-to-region ptmin ptmax)
7100 (goto-char pt)
7101 (if mk (set-mark mk))
7102 (set-buffer-modified-p modified)
7104 ;; Clone the old buffer's process, if any.
7105 (when process (clone-process process))
7107 ;; Now set up the major mode.
7108 (funcall mode)
7110 ;; Set up other local variables.
7111 (mapc (lambda (v)
7112 (condition-case () ;in case var is read-only
7113 (if (symbolp v)
7114 (makunbound v)
7115 (set (make-local-variable (car v)) (cdr v)))
7116 (error nil)))
7117 lvars)
7119 ;; Run any hooks (typically set up by the major mode
7120 ;; for cloning to work properly).
7121 (run-hooks 'clone-buffer-hook))
7122 (if display-flag
7123 ;; Presumably the current buffer is shown in the selected frame, so
7124 ;; we want to display the clone elsewhere.
7125 (let ((same-window-regexps nil)
7126 (same-window-buffer-names))
7127 (pop-to-buffer new)))
7128 new))
7131 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7132 "Create an indirect buffer that is a twin copy of the current buffer.
7134 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7135 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7136 or if not called with a prefix arg, NEWNAME defaults to the current
7137 buffer's name. The name is modified by adding a `<N>' suffix to it
7138 or by incrementing the N in an existing suffix. Trying to clone a
7139 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7140 property results in an error.
7142 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7143 This is always done when called interactively.
7145 Optional third arg NORECORD non-nil means do not put this buffer at the
7146 front of the list of recently selected ones."
7147 (interactive
7148 (progn
7149 (if (get major-mode 'no-clone-indirect)
7150 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7151 (list (if current-prefix-arg
7152 (read-buffer "Name of indirect buffer: " (current-buffer)))
7153 t)))
7154 (if (get major-mode 'no-clone-indirect)
7155 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7156 (setq newname (or newname (buffer-name)))
7158 (setq newname (substring newname 0 (match-beginning 0))))
7159 (let* ((name (generate-new-buffer-name newname))
7160 (buffer (make-indirect-buffer (current-buffer) name t)))
7161 (with-current-buffer buffer
7162 (run-hooks 'clone-indirect-buffer-hook))
7163 (when display-flag
7164 (pop-to-buffer buffer norecord))
7165 buffer))
7168 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7169 "Like `clone-indirect-buffer' but display in another window."
7170 (interactive
7171 (progn
7172 (if (get major-mode 'no-clone-indirect)
7173 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7174 (list (if current-prefix-arg
7175 (read-buffer "Name of indirect buffer: " (current-buffer)))
7176 t)))
7177 (let ((pop-up-windows t))
7178 (clone-indirect-buffer newname display-flag norecord)))
7180 \f
7181 ;;; Handling of Backspace and Delete keys.
7183 (defcustom normal-erase-is-backspace 'maybe
7184 "Set the default behavior of the Delete and Backspace keys.
7186 If set to t, Delete key deletes forward and Backspace key deletes
7187 backward.
7189 If set to nil, both Delete and Backspace keys delete backward.
7191 If set to 'maybe (which is the default), Emacs automatically
7192 selects a behavior. On window systems, the behavior depends on
7193 the keyboard used. If the keyboard has both a Backspace key and
7194 a Delete key, and both are mapped to their usual meanings, the
7195 option's default value is set to t, so that Backspace can be used
7196 to delete backward, and Delete can be used to delete forward.
7198 If not running under a window system, customizing this option
7199 accomplishes a similar effect by mapping C-h, which is usually
7200 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7201 via `keyboard-translate'. The former functionality of C-h is
7202 available on the F1 key. You should probably not use this
7203 setting if you don't have both Backspace, Delete and F1 keys.
7205 Setting this variable with setq doesn't take effect. Programmatically,
7206 call `normal-erase-is-backspace-mode' (which see) instead."
7207 :type '(choice (const :tag "Off" nil)
7208 (const :tag "Maybe" maybe)
7209 (other :tag "On" t))
7210 :group 'editing-basics
7211 :version "21.1"
7212 :set (lambda (symbol value)
7213 ;; The fboundp is because of a problem with :set when
7214 ;; dumping Emacs. It doesn't really matter.
7215 (if (fboundp 'normal-erase-is-backspace-mode)
7216 (normal-erase-is-backspace-mode (or value 0))
7217 (set-default symbol value))))
7219 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7220 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7221 (unless frame (setq frame (selected-frame)))
7222 (with-selected-frame frame
7223 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7224 (normal-erase-is-backspace-mode
7225 (if (if (eq normal-erase-is-backspace 'maybe)
7226 (and (not noninteractive)
7227 (or (memq system-type '(ms-dos windows-nt))
7228 (memq window-system '(w32 ns))
7229 (and (memq window-system '(x))
7230 (fboundp 'x-backspace-delete-keys-p)
7231 (x-backspace-delete-keys-p))
7232 ;; If the terminal Emacs is running on has erase char
7233 ;; set to ^H, use the Backspace key for deleting
7234 ;; backward, and the Delete key for deleting forward.
7235 (and (null window-system)
7236 (eq tty-erase-char ?\^H))))
7237 normal-erase-is-backspace)
7238 1 0)))))
7240 (define-minor-mode normal-erase-is-backspace-mode
7241 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7242 With a prefix argument ARG, enable this feature if ARG is
7243 positive, and disable it otherwise. If called from Lisp, enable
7244 the mode if ARG is omitted or nil.
7246 On window systems, when this mode is on, Delete is mapped to C-d
7247 and Backspace is mapped to DEL; when this mode is off, both
7248 Delete and Backspace are mapped to DEL. (The remapping goes via
7249 `local-function-key-map', so binding Delete or Backspace in the
7250 global or local keymap will override that.)
7252 In addition, on window systems, the bindings of C-Delete, M-Delete,
7253 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7254 the global keymap in accordance with the functionality of Delete and
7255 Backspace. For example, if Delete is remapped to C-d, which deletes
7256 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7257 to DEL, which deletes backward, C-Delete is bound to
7258 `backward-kill-word'.
7260 If not running on a window system, a similar effect is accomplished by
7261 remapping C-h (normally produced by the Backspace key) and DEL via
7262 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7263 to C-d; if it's off, the keys are not remapped.
7265 When not running on a window system, and this mode is turned on, the
7266 former functionality of C-h is available on the F1 key. You should
7267 probably not turn on this mode on a text-only terminal if you don't
7268 have both Backspace, Delete and F1 keys.
7270 See also `normal-erase-is-backspace'."
7271 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7272 . (lambda (v)
7273 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7274 (if v 1 0))))
7275 (let ((enabled (eq 1 (terminal-parameter
7276 nil 'normal-erase-is-backspace))))
7278 (cond ((or (memq window-system '(x w32 ns pc))
7279 (memq system-type '(ms-dos windows-nt)))
7280 (let ((bindings
7281 `(([M-delete] [M-backspace])
7282 ([C-M-delete] [C-M-backspace])
7283 ([?\e C-delete] [?\e C-backspace]))))
7285 (if enabled
7286 (progn
7287 (define-key local-function-key-map [delete] [deletechar])
7288 (define-key local-function-key-map [kp-delete] [?\C-d])
7289 (define-key local-function-key-map [backspace] [?\C-?])
7290 (dolist (b bindings)
7291 ;; Not sure if input-decode-map is really right, but
7292 ;; keyboard-translate-table (used below) only works
7293 ;; for integer events, and key-translation-table is
7294 ;; global (like the global-map, used earlier).
7295 (define-key input-decode-map (car b) nil)
7296 (define-key input-decode-map (cadr b) nil)))
7297 (define-key local-function-key-map [delete] [?\C-?])
7298 (define-key local-function-key-map [kp-delete] [?\C-?])
7299 (define-key local-function-key-map [backspace] [?\C-?])
7300 (dolist (b bindings)
7301 (define-key input-decode-map (car b) (cadr b))
7302 (define-key input-decode-map (cadr b) (car b))))))
7303 (t
7304 (if enabled
7305 (progn
7306 (keyboard-translate ?\C-h ?\C-?)
7307 (keyboard-translate ?\C-? ?\C-d))
7308 (keyboard-translate ?\C-h ?\C-h)
7309 (keyboard-translate ?\C-? ?\C-?))))
7311 (if (called-interactively-p 'interactive)
7312 (message "Delete key deletes %s"
7313 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7314 "forward" "backward")))))
7315 \f
7316 (defvar vis-mode-saved-buffer-invisibility-spec nil
7317 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7319 (define-minor-mode read-only-mode
7320 "Change whether the current buffer is read-only.
7321 With prefix argument ARG, make the buffer read-only if ARG is
7322 positive, otherwise make it writable. If buffer is read-only
7323 and `view-read-only' is non-nil, enter view mode.
7325 Do not call this from a Lisp program unless you really intend to
7327 possibly enabling or disabling View mode. Also, note that this
7328 command works by setting the variable `buffer-read-only', which
7329 does not affect read-only regions caused by text properties. To
7330 ignore read-only status in a Lisp program (whether due to text
7331 properties or buffer state), bind `inhibit-read-only' temporarily
7332 to a non-nil value."
7333 :variable buffer-read-only
7334 (cond
7335 ((and (not buffer-read-only) view-mode)
7336 (View-exit-and-edit)
7337 (make-local-variable 'view-read-only)
7338 (setq view-read-only t)) ; Must leave view mode.
7339 ((and buffer-read-only view-read-only
7340 ;; If view-mode is already active, `view-mode-enter' is a nop.
7341 (not view-mode)
7342 (not (eq (get major-mode 'mode-class) 'special)))
7343 (view-mode-enter))))
7345 (define-minor-mode visible-mode
7346 "Toggle making all invisible text temporarily visible (Visible mode).
7347 With a prefix argument ARG, enable Visible mode if ARG is
7348 positive, and disable it otherwise. If called from Lisp, enable
7349 the mode if ARG is omitted or nil.
7351 This mode works by saving the value of `buffer-invisibility-spec'
7352 and setting it to nil."
7353 :lighter " Vis"
7354 :group 'editing-basics
7355 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7356 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7357 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7358 (when visible-mode
7359 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7360 buffer-invisibility-spec)
7361 (setq buffer-invisibility-spec nil)))
7362 \f
7363 (defvar messages-buffer-mode-map
7364 (let ((map (make-sparse-keymap)))
7365 (set-keymap-parent map special-mode-map)
7366 (define-key map "g" nil) ; nothing to revert
7367 map))
7369 (define-derived-mode messages-buffer-mode special-mode "Messages"
7372 (defun messages-buffer ()
7374 If it does not exist, create and it switch it to `messages-buffer-mode'."
7375 (or (get-buffer "*Messages*")
7376 (with-current-buffer (get-buffer-create "*Messages*")
7377 (messages-buffer-mode)
7378 (current-buffer))))
7380 \f
7381 ;; Minibuffer prompt stuff.
7383 ;;(defun minibuffer-prompt-modification (start end)
7384 ;; (error "You cannot modify the prompt"))
7385 ;;
7386 ;;
7387 ;;(defun minibuffer-prompt-insertion (start end)
7388 ;; (let ((inhibit-modification-hooks t))
7389 ;; (delete-region start end)
7390 ;; ;; Discard undo information for the text insertion itself
7391 ;; ;; and for the text deletion.above.
7392 ;; (when (consp buffer-undo-list)
7393 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7394 ;; (message "You cannot modify the prompt")))
7395 ;;
7396 ;;
7397 ;;(setq minibuffer-prompt-properties
7398 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7399 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7401 \f
7402 ;;;; Problematic external packages.
7404 ;; rms says this should be done by specifying symbols that define
7405 ;; versions together with bad values. This is therefore not as
7406 ;; flexible as it could be. See the thread:
7407 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7408 (defconst bad-packages-alist
7409 ;; Not sure exactly which semantic versions have problems.
7410 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7412 "The version of `semantic' loaded does not work in Emacs 22.
7413 It can cause constant high CPU load.
7414 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7415 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7416 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7417 ;; provided the `CUA-mode' feature. Since this is no longer true,
7418 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7419 (CUA-mode t nil
7420 "CUA-mode is now part of the standard GNU Emacs distribution,
7421 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7423 You have loaded an older version of CUA-mode which does not work
7424 correctly with this version of Emacs. You should remove the old
7425 version and use the one distributed with Emacs."))
7426 "Alist of packages known to cause problems in this version of Emacs.
7427 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7428 PACKAGE is either a regular expression to match file names, or a
7429 symbol (a feature name), like for `with-eval-after-load'.
7430 SYMBOL is either the name of a string variable, or `t'. Upon
7431 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7432 warning using STRING as the message.")
7434 (defun bad-package-check (package)
7435 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7436 (condition-case nil
7437 (let* ((list (assoc package bad-packages-alist))
7438 (symbol (nth 1 list)))
7439 (and list
7440 (boundp symbol)
7441 (or (eq symbol t)
7442 (and (stringp (setq symbol (eval symbol)))
7443 (string-match-p (nth 2 list) symbol)))
7444 (display-warning package (nth 3 list) :warning)))
7445 (error nil)))
7447 (dolist (elem bad-packages-alist)
7448 (let ((pkg (car elem)))
7449 (with-eval-after-load pkg
7450 (bad-package-check pkg))))
7452 \f
7453 ;;; Generic dispatcher commands
7455 ;; Macro `define-alternatives' is used to create generic commands.
7456 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
7457 ;; that can have different alternative implementations where choosing
7458 ;; among them is exclusively a matter of user preference.
7460 ;; (define-alternatives COMMAND) creates a new interactive command
7461 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
7462 ;; Typically, the user will not need to customize this variable; packages
7463 ;; wanting to add alternative implementations should use
7464 ;;
7465 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
7467 (defmacro define-alternatives (command &rest customizations)
7468 "Define new command `COMMAND'.
7469 The variable `COMMAND-alternatives' will contain alternative
7470 implementations of COMMAND, so that running `C-u M-x COMMAND'
7471 will allow the user to chose among them.
7472 CUSTOMIZATIONS, if non-nil, should be composed of alternating
7473 `defcustom' keywords and values to add to the declaration of
7474 `COMMAND-alternatives' (typically :group and :version)."
7475 (let* ((command-name (symbol-name command))
7476 (varalt-name (concat command-name "-alternatives"))
7477 (varalt-sym (intern varalt-name))
7478 (varimp-sym (intern (concat command-name "--implementation"))))
7479 `(progn
7481 (defcustom ,varalt-sym nil
7482 ,(format "Alist of alternative implementations for the `%s' command.
7484 Each entry must be a pair (ALTNAME . ALTFUN), where:
7485 ALTNAME - The name shown at user to describe the alternative implementation.
7486 ALTFUN - The function called to implement this alternative."
7487 command-name)
7488 :type '(alist :key-type string :value-type function)
7489 ,@customizations)
7491 (defvar ,varimp-sym nil "Internal use only.")
7493 (defun ,command (&optional arg)
7494 ,(format "Run generic command `%s'.
7495 If used for the first time, or with interactive ARG, ask the user which
7496 implementation to use for `%s'. The variable `%s'
7497 contains the list of implementations currently supported for this command."
7498 command-name command-name varalt-name)
7499 (interactive "P")
7500 (when (or arg (null ,varimp-sym))
7501 (let ((val (completing-read
7502 ,(format "Select implementation for command `%s': " command-name)
7503 ,varalt-sym nil t)))
7504 (unless (string-equal val "")
7505 (customize-save-variable ',varimp-sym
7506 (cdr (assoc-string val ,varalt-sym))))))
7507 (if ,varimp-sym
7508 (funcall ,varimp-sym)
7509 (message ,(format "No implementation selected for command `%s'"
7510 command-name)))))))
7512 (provide 'simple)
7514 ;;; simple.el ends here