| blob | f80faae80d873ca6e7a4a31dad9306b2411650f3 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2015 Free Software Foundation, Inc.
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "Idle time delay before updating various things on the screen.
42 Various Emacs features that update auxiliary information when point moves
43 wait this many seconds after Emacs becomes idle before doing an update."
49 "Killing and yanking commands."
53 "Highlight (un)matching of parens and expressions."
55 \f
56 ;;; next-error support framework
59 "`next-error' support framework."
65 "Face used to highlight next error locus."
70 "Highlighting of locations in selected source buffers.
71 If a number, highlight the locus in `next-error' face for the given time
72 in seconds, or until the next command is executed.
73 If t, highlight the locus until the next command is executed, or until
74 some other locus replaces it.
75 If nil, don't highlight the locus in the source buffer.
76 If `fringe-arrow', indicate the locus by the fringe arrow
77 indefinitely until some other locus replaces it."
86 "Highlighting of locations in `next-error-no-select'.
87 If number, highlight the locus in `next-error' face for given time in seconds.
88 If t, highlight the locus indefinitely until some other locus replaces it.
89 If nil, don't highlight the locus in the source buffer.
90 If `fringe-arrow', indicate the locus by the fringe arrow
91 indefinitely until some other locus replaces it."
100 "Display the line in the visited source file recentered as specified.
101 If non-nil, the value is passed directly to `recenter'."
109 "List of hook functions run by `next-error' after visiting source file."
120 "The most recent `next-error' buffer.
121 A buffer becomes most recent when its compilation, grep, or
126 "Function to use to find the next error in the current buffer.
127 The function is called with 2 parameters:
128 ARG is an integer specifying by how many errors to move.
129 RESET is a boolean which, if non-nil, says to go back to the beginning
130 of the errors before moving.
131 Major modes providing compile-like functionality should set this variable
132 to indicate to `next-error' that this is a candidate buffer and how
137 "Function to use to move to an error locus.
138 It takes two arguments, a buffer position in the error buffer
139 and a buffer position in the error locus buffer.
140 The buffer for the error locus should already be current.
145 &optional avoid-current
146 extra-test-inclusive
147 extra-test-exclusive)
148 "Test if BUFFER is a `next-error' capable buffer.
150 If AVOID-CURRENT is non-nil, treat the current buffer
151 as an absolute last resort only.
153 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
154 that normally would not qualify. If it returns t, the buffer
155 in question is treated as usable.
157 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
158 that would normally be considered usable. If it returns nil,
159 that buffer is rejected."
164 ;; Optionally reject some buffers.
167 t)
168 ;; Optionally accept some other buffers.
173 extra-test-inclusive
174 extra-test-exclusive)
175 "Return a `next-error' capable buffer.
177 If AVOID-CURRENT is non-nil, treat the current buffer
178 as an absolute last resort only.
180 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
181 that normally would not qualify. If it returns t, the buffer
182 in question is treated as usable.
184 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
185 that would normally be considered usable. If it returns nil,
186 that buffer is rejected."
188 ;; 1. If one window on the selected frame displays such buffer, return it.
194 avoid-current
195 extra-test-inclusive extra-test-exclusive)
200 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
203 extra-test-inclusive extra-test-exclusive))
204 next-error-last-buffer)
205 ;; 3. If the current buffer is acceptable, choose it.
207 extra-test-inclusive extra-test-exclusive)
209 ;; 4. Look for any acceptable buffer.
214 extra-test-inclusive extra-test-exclusive)))
217 ;; 5. Use the current buffer as a last resort if it qualifies,
218 ;; even despite AVOID-CURRENT.
221 extra-test-inclusive extra-test-exclusive)
225 ;; 6. Give up.
229 "Visit next `next-error' message and corresponding source code.
231 If all the error messages parsed so far have been processed already,
232 the message buffer is checked for new ones.
234 A prefix ARG specifies how many error messages to move;
235 negative means move back to previous error messages.
237 and start at the first error.
239 The RESET argument specifies that we should restart from the beginning.
242 compilation, grep, or occur buffer. It can also operate on any
244 more generally, on any buffer in Compilation mode or with
245 Compilation Minor mode enabled, or any buffer in which
246 `next-error-function' is bound to an appropriate function.
247 To specify use of a particular buffer for error messages, type
249 in the current frame.
252 runs `next-error-hook' with `run-hooks', and stays with that buffer
253 until you use it in some other buffer which uses Compilation mode
254 or Compilation Minor mode.
256 To control which errors are matched, customize the variable
257 `compilation-error-regexp-alist'."
261 ;; we know here that next-error-function is a valid symbol we can funcall
269 "Visit the source code corresponding to the `next-error' message at point."
271 ;; we know here that next-error-function is a valid symbol we can funcall
282 "Visit previous `next-error' message and corresponding source code.
284 Prefix arg N says how many error messages to move backwards (or
285 forwards, if negative).
292 "Restart at the first error.
293 Visit corresponding source code.
294 With prefix arg N, visit the source code of the Nth error.
300 "Move point to the next error in the `next-error' buffer and highlight match.
301 Prefix arg N says how many error messages to move forwards (or
302 backwards, if negative).
304 select the source buffer."
311 "Move point to the previous error in the `next-error' buffer and highlight match.
312 Prefix arg N says how many error messages to move backwards (or
313 forwards, if negative).
315 select the source buffer."
319 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
323 "Minor mode for compilation, occur and diff modes.
324 With a prefix argument ARG, enable mode if ARG is positive, and
325 disable it otherwise. If called from Lisp, enable mode if ARG is
326 omitted or nil.
327 When turned on, cursor motion in the compilation, grep, occur or diff
328 buffer causes automatic display of the corresponding source code location."
335 ;; Used as a `post-command-hook' by `next-error-follow-mode'
336 ;; for the *Compilation* *grep* and *Occur* buffers.
346 \f
347 ;;;
350 "Major mode not specialized for anything in particular.
351 Other major modes are defined by comparison with this one."
356 ;; Special major modes to view specially formatted data rather than files.
370 map))
374 "Parent major mode from which special major modes should inherit."
377 ;; Making and deleting lines.
380 "Special hook to tell if `self-insert-command' will use the region.
381 It must be called via `run-hook-with-args-until-success' with no arguments.
382 Any `post-self-insert-command' which consumes the region should
383 register a function on this hook so that things like `delete-selection-mode'
390 "Insert a newline, and move to left margin of the new line if it's blank.
391 If option `use-hard-newlines' is non-nil, the newline is marked with the
392 text-property `hard'.
393 With ARG, insert that many newlines.
395 If `electric-indent-mode' is enabled, this indents the final new line
396 that it adds, and reindents the preceding line. To just insert
399 Calls `auto-fill-function' if the current column number is greater
400 than the value of `fill-column' and ARG is nil.
401 A non-nil INTERACTIVE argument means to run the `post-self-insert-hook'."
404 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
405 ;; Set last-command-event to tell self-insert what to insert.
409 ;; Don't auto-fill if we have a numeric argument.
412 ;; Do the rest in post-self-insert-hook, because we want to do it
413 ;; *before* other functions on that hook.
416 ;; Mark the newline(s) `hard'.
420 ;; If the newline leaves the previous line blank, and we
421 ;; have a left margin, delete that from the blank line.
429 ;; Indent the line after the newline, except in one case:
430 ;; when we added the newline at the beginning of a line which
431 ;; starts a page.
436 ;; FIXME: For non-interactive uses, many calls actually just want
437 ;; (insert "\n"), so maybe we should do just that, so as to avoid
438 ;; the risk of filling or running abbrevs unexpectedly.
445 ;; We first used let-binding to protect the hook, but that was naive
446 ;; since add-hook affects the symbol-default value of the variable,
447 ;; whereas the let-binding might only protect the buffer-local value.
451 nil)
456 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
462 "Insert a newline and leave point before it.
463 If there is a fill prefix and/or a `left-margin', insert them
464 on the new line if the line would have been blank.
465 With arg N, insert N newlines."
470 ;; Don't expand an abbrev before point.
484 "Split current line, moving portion beyond point vertically down.
485 If the current line starts with `fill-prefix', insert it on the new
486 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
488 When called from Lisp code, ARG may be a prefix string to copy."
493 ;; What prefix should we check for (nil means don't).
497 ;; Does this line start with it?
508 "Join this line to previous and fix up whitespace at join.
509 If there is a fill prefix, delete it from the beginning of this line.
510 With argument, join this line to following line."
517 ;; If the second line started with the fill prefix,
518 ;; delete the prefix.
530 "On blank line, delete all surrounding blank lines, leaving just one.
531 On isolated blank line, delete that one.
532 On nonblank line, delete any immediately following blank lines."
538 ;; Set singleblank if there is just one blank line here.
545 ;; Delete preceding blank lines, and this one too if it's the only one.
554 ;; Delete following blank lines, unless the current line is blank
555 ;; and there are no following blank lines.
564 ;; Handle the special case where point is followed by newline and eob.
565 ;; Delete the line, leaving point at eob.
571 Trailing lines are deleted only if `delete-trailing-whitespace'
572 is called on the entire buffer (rather than an active region)."
578 "Delete trailing whitespace between START and END.
579 If called interactively, START and END are the start/end of the
580 region if the mark is active, or of the buffer's accessible
581 portion if the mark is inactive.
583 This command deletes whitespace characters after the last
584 non-whitespace character in each line between START and END. It
585 does not consider formfeed characters to be whitespace.
587 If this command acts on the entire buffer (i.e. if called
588 interactively with the mark inactive, or called from Lisp with
589 END nil), it also deletes all trailing lines at the end of the
590 buffer if the variable `delete-trailing-lines' is non-nil."
603 ;; Don't delete formfeeds, even if they are considered whitespace.
607 ;; Delete trailing empty lines.
610 delete-trailing-lines
611 ;; Really the end of buffer.
616 ;; Return nil for the benefit of `write-file-functions'.
617 nil)
620 "Insert a newline, then indent according to major mode.
621 Indentation is done using the value of `indent-line-function'.
622 In programming language modes, this is the same as TAB.
623 In some text modes, where TAB inserts a tab, this command indents to the
624 column specified by the function `current-left-margin'."
631 "Reindent current line, insert newline, then indent the new line.
632 Indentation of both lines is done according to the current major mode,
633 which means calling the current value of `indent-line-function'.
634 In programming language modes, this is the same as TAB.
635 In some text modes, where TAB inserts a tab, this indents to the
636 column specified by the function `current-left-margin'."
639 ;; Be careful to insert the newline before indenting the line.
640 ;; Otherwise, the indentation might be wrong.
644 ;; We are at EOL before the call to indent-according-to-mode, and
645 ;; after it we usually are as well, but not always. We tried to
646 ;; address it with `save-excursion' but that uses a normal marker
647 ;; whereas we need `move after insertion', so we do the save/restore
648 ;; by hand.
652 ;; Remove the trailing white-space after indentation because
653 ;; indentation may introduce the whitespace.
659 Legitimate radix values are 8, 10 and 16."
664 "Like `read-char', but do not allow quitting.
665 Also, if the first character read is an octal digit,
666 we read any number of octal digits and return the
667 specified character code. Any nondigit terminates the sequence.
668 If the terminator is RET, it is discarded;
669 any other terminator is used itself as input.
671 The optional argument PROMPT specifies a string to use to prompt the user.
672 The variable `read-quoted-char-radix' controls which radix to use
673 for numeric input."
676 help-event-list)))
680 ;; Don't let C-h or other help chars get the help
681 ;; message--only help function keys. See bug#16617.
685 "Type the special character you want to use,
686 or the octal character code.
687 RET terminates the character code and is discarded;
697 unread-command-events)
698 done t))
700 ;; Turn a meta-character into a character with the 0200 bit set.
702 done t))
718 unread-command-events)
719 done t))
721 done t)))
723 code))
726 "Read next input character and insert it.
727 This is useful for inserting control characters.
728 With argument, insert ARG copies of the character.
730 If the first character you type after this command is an octal digit,
731 you should type a sequence of octal digits which specify a character code.
732 Any nondigit terminates the sequence. If the terminator is a RET,
733 it is discarded; any other terminator is used itself as input.
734 The variable `read-quoted-char-radix' specifies the radix for this feature;
735 set it to 10 or 16 to use decimal or hex instead of octal.
737 In overwrite mode, this function inserts the character anyway, and
738 does not handle octal digits specially. This means that if you use
739 overwrite as your normal editing mode, you can use this function to
740 insert characters when necessary.
742 In binary overwrite mode, this function does overwrite, and octal
743 digits are interpreted as a character code. This is intended to be
744 useful for editing binary files."
747 ;; Avoid "obsolete" warnings for translation-table-for-input.
754 ;; This used to assume character codes 0240 - 0377 stand for
755 ;; characters in some single-byte character set, and converted them
756 ;; to Emacs characters. But in 23.1 this feature is deprecated
757 ;; in favor of inserting the corresponding Unicode characters.
758 ;; (if (and enable-multibyte-characters
759 ;; (>= char ?\240)
760 ;; (<= char ?\377))
761 ;; (setq char (unibyte-char-to-multibyte char)))
773 "Move forward ARG lines and position at first nonblank character."
779 "Move backward ARG lines and position at first nonblank character."
785 "Move point to the first non-whitespace character on this line."
789 ;; Move back over chars that have whitespace syntax but have the p flag.
793 "Fixup white space between objects around point.
794 Leave one space or none, according to the context."
801 nil
805 "Delete all spaces and tabs around point.
806 If BACKWARD-ONLY is non-nil, only delete them before point."
811 orig-pos
820 "Delete all spaces and tabs around point, leaving one space (or N spaces).
821 If N is negative, delete newlines as well, leaving -N spaces.
822 See also `cycle-spacing'."
827 "Store context used in consecutive calls to `cycle-spacing' command.
828 The first time `cycle-spacing' runs, it saves in this variable:
829 its N argument, the original point position, and the original spacing
833 "Manipulate whitespace around point in a smart way.
834 In interactive use, this function behaves differently in successive
835 consecutive calls.
837 The first call in a sequence acts like `just-one-space'.
838 It deletes all spaces and tabs around point, leaving one space
839 \(or N spaces). N is the prefix argument. If N is negative,
840 it deletes newlines as well, leaving -N spaces.
841 \(If PRESERVE-NL-BACK is non-nil, it does not delete newlines before point.)
843 The second call in a sequence deletes all spaces.
845 The third call in a sequence restores the original whitespace (and point).
847 If MODE is `single-shot', it only performs the first step in the sequence.
848 If MODE is `fast' and the first step would not result in any change
849 \(i.e., there are exactly (abs N) spaces around point),
850 the function goes straight to the second step.
852 Repeatedly calling the function with different values of N starts a
853 new sequence each time."
861 ;; Command run for the first time, single-shot mode or different argument
873 ;; Special handling for case where there was no space at all.
876 ;; If this run causes no change in buffer content, delete all spaces,
877 ;; otherwise delete all excess spaces.
882 ;; Command run for the second time.
886 ;; Command run for the third time.
891 \f
893 "Move point to the beginning of the buffer.
894 With numeric arg N, put point N/10 of the way from the beginning.
895 If the buffer is narrowed, this command uses the beginning of the
896 accessible part of the buffer.
898 If Transient Mark mode is disabled, leave mark at previous
909 ;; Avoid overflow for large buffer sizes!
917 "Move point to the end of the buffer.
918 With numeric arg N, put point N/10 of the way from the end.
919 If the buffer is narrowed, this command uses the end of the
920 accessible part of the buffer.
922 If Transient Mark mode is disabled, leave mark at previous
931 ;; Avoid overflow for large buffer sizes!
936 ;; If we went to a place in the middle of the buffer,
937 ;; adjust it to the beginning of a line.
941 ;; If the end of the buffer is not already on the screen,
942 ;; then scroll specially to put it near, but not at, the bottom.
947 "Whether single-char deletion commands delete an active region.
948 This has an effect only if Transient Mark mode is enabled, and
949 affects `delete-forward-char' and `delete-backward-char', though
950 not `delete-char'.
952 If the value is the symbol `kill', the active region is killed
953 instead of deleted."
966 "Function to get the region's content.
967 Called with one argument DELETE.
968 If DELETE is `delete-only', then only delete the region and the return value
969 is undefined. If DELETE is nil, just return the content as a string.
973 "Delete the previous N characters (following if N is negative).
974 If Transient Mark mode is enabled, the mark is active, and N is 1,
975 delete the text in the region and deactivate the mark instead.
976 To disable this, set option `delete-active-region' to nil.
978 Optional second arg KILLFLAG, if non-nil, means to kill (save in
979 kill ring) instead of delete. Interactively, N is the prefix
980 arg, and KILLFLAG is set if N is explicitly specified.
982 In Overwrite mode, single character backward deletion may replace
983 tabs with spaces so as to back over columns, unless point is at
984 the end of the line."
990 delete-active-region
992 ;; If a region is active, kill or delete it.
996 ;; In Overwrite mode, maybe untabify while deleting
1006 ;; Otherwise, do simple deletion.
1010 "Delete the following N characters (previous if N is negative).
1011 If Transient Mark mode is enabled, the mark is active, and N is 1,
1012 delete the text in the region and deactivate the mark instead.
1013 To disable this, set variable `delete-active-region' to nil.
1015 Optional second arg KILLFLAG non-nil means to kill (save in kill
1016 ring) instead of delete. Interactively, N is the prefix arg, and
1017 KILLFLAG is set if N was explicitly specified."
1023 delete-active-region
1025 ;; If a region is active, kill or delete it.
1030 ;; Otherwise, do simple deletion.
1034 "Put point at beginning and mark at end of buffer.
1035 If narrowing is in effect, only uses the accessible part of the buffer.
1036 You probably should not use this function in Lisp programs;
1037 it is usually a mistake for a Lisp function to use any subroutine
1038 that uses or sets the mark."
1044 \f
1046 ;; Counting lines, one way or another.
1049 "Go to LINE, counting from line 1 at beginning of buffer.
1050 If called interactively, a numeric prefix argument specifies
1051 LINE; without a numeric prefix argument, read LINE from the
1052 minibuffer.
1054 If optional argument BUFFER is non-nil, switch to that buffer and
1056 as argument, BUFFER is the most recently selected other buffer.
1058 Prior to moving point, this function sets the mark (without
1059 activating it), unless Transient Mark mode is enabled and the
1060 mark is already active.
1062 This function is usually the wrong thing to use in a Lisp program.
1063 What you probably want instead is something like:
1064 (goto-char (point-min))
1065 (forward-line (1- N))
1066 If at all possible, an even better solution is to use char counts
1067 rather than line counts."
1072 ;; Look for a default, a number in the buffer at point.
1082 ;; Decide if we're switching buffers.
1090 ;; Read the argument, offering that number (if any) as default.
1093 buffer))))
1094 ;; Switch to the desired buffer, one way or another.
1099 ;; Leave mark at previous position
1101 ;; Move to the specified line number in that buffer.
1110 "Count the number of words in the region.
1111 If called interactively, print a message reporting the number of
1112 lines, words, and characters in the region (whether or not the
1113 region is active); with prefix ARG, report for the entire buffer
1114 rather than the region.
1116 If called from Lisp, return the number of words between positions
1117 START and END."
1129 "Count words between START and END.
1130 If called interactively, START and END are normally the start and
1131 end of the buffer; but if the region is active, START and END are
1132 the start and end of the region. Print a message reporting the
1133 number of lines, words, and chars.
1135 If called from Lisp, return the number of words between START and
1136 END, without printing any message."
1146 words))
1162 str
1170 "Print the current buffer line number and narrowed line number of point."
1183 "Return number of lines between START and END.
1184 This is usually the number of newlines between them,
1185 but can be one more if START is not equal to END
1186 and the greater of them is not at the start of a line."
1202 done)))
1206 "Return (narrowed) buffer line number at position POS.
1207 If POS is nil, use current buffer location.
1208 Counting starts at (point-min), so the value refers
1209 to the contents of the accessible portion of the buffer."
1219 "Print info on cursor position (on screen and within buffer).
1220 Also describe the character after point, and give its character code
1221 in octal, decimal and hex.
1223 For a non-ASCII multibyte character, also give its encoding in the
1224 buffer's selected coding system if the coding system encodes the
1225 character safely. If the character is encoded into one byte, that
1226 code is shown in hex. If the character is encoded into more than one
1229 In addition, with prefix argument, show details about that character
1230 in *Help* buffer. See also the command `describe-char'."
1234 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1235 ;; start a directional embedding, which could completely
1236 ;; disrupt the rest of the line (e.g., RLO will display the
1237 ;; rest of the line right-to-left). So we put an invisible
1238 ;; PDF character after these characters, to end the
1239 ;; embedding, which eliminates any effects on the rest of
1240 ;; the line. For RLE and RLO we also append an invisible
1241 ;; LRM, to avoid reordering the following numerical
1242 ;; characters. For LRI/RLI/FSI we append a PDI.
1249 ;; Strong right-to-left characters cause reordering of
1250 ;; the following numerical characters which show the
1251 ;; codepoint, so append LRM to countermand that.
1262 ""
1268 pos total percent beg end col hscroll)
1270 pos total col hscroll))
1272 encoded encoding-msg display-prop under-display)
1279 ;; Check if the character is displayed with some `display'
1280 ;; text property. In that case, set under-display to the
1281 ;; buffer substring covered by that property.
1292 under-display)))
1298 char char char under-display)
1300 char char char under-display display-prop))
1303 char char char
1305 "..."
1309 ;; We show the detailed information about CHAR.
1316 bidi-fixer
1317 encoding-msg pos total percent beg end col hscroll)
1324 bidi-fixer encoding-msg pos total percent col hscroll))))))
1325 \f
1326 ;; Initialize read-expression-map. It is defined at C level.
1330 ;; Might as well bind TAB to completion, since inserting a TAB char is
1331 ;; much too rarely useful.
1334 m))
1337 "Return a Lisp object read using the minibuffer, unevaluated.
1338 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1339 is a string to insert in the minibuffer before reading.
1340 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1341 Such arguments are used as in `read-from-minibuffer'.)"
1342 ;; Used for interactive spec `x'.
1347 "Return value of Lisp expression read using the minibuffer.
1348 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1349 is a string to insert in the minibuffer before reading.
1350 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1351 Such arguments are used as in `read-from-minibuffer'.)"
1352 ;; Used for interactive spec `X'.
1360 "The current default value or list of default values in the minibuffer.
1361 The functions `read-from-minibuffer' and `completing-read' bind
1365 "Value for `print-level' while printing value in `eval-expression'.
1366 A value of nil means no limit."
1372 "Value for `print-length' while printing value in `eval-expression'.
1373 A value of nil means no limit."
1379 "If non-nil set `debug-on-error' to t in `eval-expression'.
1380 If nil, don't change the value of `debug-on-error'."
1386 "Format VALUE as a result of evaluated expression.
1387 Return a formatted string which is displayed in the echo area
1388 in addition to the value printed by prin1 in functions which
1389 display the result of expression evaluation."
1408 ;; FIXME: call emacs-lisp-mode?
1415 read-expression-map t
1418 ;; We define this, rather than making `eval' interactive,
1419 ;; for the sake of completion of names like eval-region, eval-buffer.
1421 "Evaluate EXP and print value in the echo area.
1422 When called interactively, read an Emacs Lisp expression and evaluate it.
1423 Value is also consed on to front of the variable `values'.
1424 Optional argument INSERT-VALUE non-nil (interactively, with prefix
1425 argument) means insert the result into the current buffer instead of
1426 printing it in the echo area.
1428 Normally, this function truncates long output according to the value
1429 of the variables `eval-expression-print-length' and
1430 `eval-expression-print-level'. With a prefix argument of zero,
1431 however, there is no such truncation. Such a prefix argument
1432 also causes integers to be printed in several additional formats
1433 \(octal, hexadecimal, and character).
1435 Runs the hook `eval-expression-minibuffer-setup-hook' on entering the
1436 minibuffer.
1438 If `eval-expression-debug-on-error' is non-nil, which is the default,
1439 this command arranges for all errors to enter the debugger."
1442 current-prefix-arg))
1447 ;; Bind debug-on-error to something unique so that we can
1448 ;; detect when evalled code changes it.
1452 ;; If evalled code has changed the value of debug-on-error,
1453 ;; propagate that change to the global binding.
1458 eval-expression-print-length))
1460 eval-expression-print-level))
1476 "Prompting with PROMPT, let user edit COMMAND and eval result.
1477 COMMAND is a Lisp expression. Let user edit that expression in
1478 the minibuffer, then read and evaluate the result."
1485 read-expression-map t
1487 ;; If command was added to command-history as a string,
1488 ;; get rid of that. We want only evaluable expressions there.
1492 ;; If command to be redone does not match front of history,
1493 ;; add it to the history.
1499 "Edit and re-evaluate last complex command, or ARGth from last.
1500 A complex command is one which used the minibuffer.
1501 The command is placed in the minibuffer as a Lisp form for editing.
1502 The result is executed, repeating the command as changed.
1503 If the command has been changed or is not the most recent previous
1504 command it is added to the front of the command history.
1505 You can use the minibuffer history commands \
1507 to get different commands to edit and resubmit."
1510 newcmd)
1522 ;; If command was added to command-history as a
1523 ;; string, get rid of that. We want only
1524 ;; evaluable expressions there.
1528 ;; If command to be redone does not match front of history,
1529 ;; add it to the history.
1544 "Read command name to invoke in `execute-extended-command'."
1554 ;; Get a command name at point in the original buffer
1555 ;; to propose it after M-n.
1559 ;; Read a string, completing from and restricting to the set of
1560 ;; all defined commands. Don't provide any initial input.
1561 ;; Save the command read on the extended-command history list.
1572 ;; This isn't strictly correct if `execute-extended-command'
1573 ;; is bound to anything else (e.g. [menu]).
1574 ;; It could use (key-description (this-single-command-keys)),
1575 ;; but actually a prompt other than "M-x" would be confusing,
1576 ;; because "M-x" is a well-known prompt to read a command
1577 ;; and it serves as a shorthand for "Extended command: ".
1582 ;; Exclude obsolete commands from completions.
1587 pred)))
1592 "Non-nil means show the equivalent key-binding when M-x command has one.
1593 The value can be a length of time to show the message for.
1594 If the value is non-nil and not a number, we wait 2 seconds."
1616 binding)
1622 name len)))
1623 ;; Don't show the help message if the binding isn't
1624 ;; significantly shorter than the M-x command the user typed.
1631 binding))
1634 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1635 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1636 "Read a command name, then read the arguments and call the command.
1637 To pass a prefix argument to the command you are
1638 invoking, give a prefix argument to `execute-extended-command'."
1640 ;; FIXME: Remember the actual text typed by the user before completion,
1641 ;; so that we don't later on suggest the same shortening.
1646 execute-extended-command--last-typed)))
1647 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1660 ;; Normally `real-this-command' should never be changed, but here we really
1661 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1662 ;; binding" for <cmd>, so the command the user really wanted to run is
1663 ;; `function' and not `execute-extended-command'. The difference is
1664 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1668 ;; If enabled, show which key runs this command.
1669 ;; But first wait, and skip the message if there is input.
1671 ;; If this command displayed something in the echo area;
1672 ;; wait a few seconds, then display our suggestion message.
1673 ;; FIXME: Wait *after* running post-command-hook!
1674 ;; FIXME: Don't wait if execute-extended-command--shorter won't
1675 ;; find a better answer anyway!
1684 ;; There's no binding for CMD. Let's try and find the shortest
1685 ;; string to use in M-x.
1686 ;; FIXME: Can be slow. Cache it maybe?
1693 function
1698 suggest-key-bindings
1702 ;; BEWARE: Called directly from the C code.
1703 "Execute CMD as an editor command.
1704 CMD must be a symbol that satisfies the `commandp' predicate.
1705 Optional second arg RECORD-FLAG non-nil
1706 means unconditionally put this command in the variable `command-history'.
1707 Otherwise, that is done only if an arg is read using the minibuffer.
1708 The argument KEYS specifies the value to use instead of (this-command-keys)
1709 when reading the arguments; if it is nil, (this-command-keys) is used.
1710 The argument SPECIAL, if non-nil, means that this command is executing
1711 a special event, so ignore the prefix argument and don't clear it."
1714 ;; FIXME: This should probably be done around
1715 ;; pre-command-hook rather than here!
1723 disabled-command-function)
1724 ;; FIXME: Weird calling convention!
1734 ;; If requested, place the macro in the command history. For
1735 ;; other sorts of commands, call-interactively takes care of this.
1738 ;; Don't keep command history around forever.
1744 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1752 \f
1754 "Default minibuffer history list.
1755 This is used for all minibuffer input
1756 except when an alternate history list is specified.
1758 Maximum length of the history list is determined by the value
1761 "Control whether history list elements are expressions or strings.
1762 If the value of this variable equals current minibuffer depth,
1763 they are expressions; otherwise they are strings.
1764 \(That convention is designed to do the right thing for
1771 "Text that was in this minibuffer before any history commands.
1772 This is nil if there have not yet been any history commands
1781 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1786 "Minibuffer history variables for which matching should ignore case.
1787 If a history variable is a member of this list, then the
1789 commands ignore case when searching it, regardless of `case-fold-search'."
1794 "Find the previous history element that matches REGEXP.
1795 \(Previous history elements refer to earlier actions.)
1796 With prefix argument N, search for Nth previous match.
1797 If N is negative, find the next or Nth next match.
1798 Normally, history elements are matched case-insensitively if
1799 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1800 makes the search case-sensitive.
1801 See also `minibuffer-history-case-insensitive-variables'."
1805 nil
1806 minibuffer-local-map
1807 nil
1808 'minibuffer-history-search-history
1810 ;; Use the last regexp specified, by default, if input is empty.
1815 regexp)
1825 ;; On some systems, ignore case for file names.
1827 minibuffer-history-case-insensitive-variables)
1828 t
1829 ;; Respect the user's setting for case-fold-search:
1830 case-fold-search)
1831 nil))
1832 prevpos
1833 match-string
1834 match-offset
1841 "No later matching history item"
1862 next-matching-history-element))
1866 "Find the next history element that matches REGEXP.
1867 \(The next history element refers to a more recent action.)
1868 With prefix argument N, search for Nth next match.
1869 If N is negative, find the previous or Nth previous match.
1870 Normally, history elements are matched case-insensitively if
1871 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1872 makes the search case-sensitive."
1876 nil
1877 minibuffer-local-map
1878 nil
1879 'minibuffer-history-search-history
1881 ;; Use the last regexp specified, by default, if input is empty.
1886 regexp)
1893 "Function run by `goto-history-element' before consuming default values.
1894 This is useful to dynamically add more elements to the list of default values
1895 when `goto-history-element' reaches the end of this list.
1896 Before calling this function `goto-history-element' sets the variable
1897 `minibuffer-default-add-done' to t, so it will call this function only
1898 once. In special cases, when this function needs to be called more
1899 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1903 "When nil, add more elements to the end of the list of default values.
1904 The value nil causes `goto-history-element' to add more elements to
1905 the list of defaults when it reaches the end of this list. It does
1911 "Return a list of all completions without the default value.
1912 This function is used to add all elements of the completion table to
1913 the end of the list of defaults just after the default value."
1916 minibuffer-completion-table
1917 minibuffer-completion-predicate)))
1923 "Puts element of the minibuffer history in the minibuffer.
1924 The argument NABS specifies the absolute history position."
1938 elt minibuffer-returned-to-present)
1945 "End of defaults; no next item"
1952 previous-history-element))
1964 minibuffer-default)))
1976 elt))
1980 "Puts next element of the minibuffer history in the minibuffer.
1981 With argument N, it uses the Nth following element."
1987 "Puts previous element of the minibuffer history in the minibuffer.
1988 With argument N, it uses the Nth previous element."
1994 "Move cursor vertically down ARG lines, or to the next history element.
1995 When point moves over the bottom line of multi-line minibuffer, puts ARGth
1996 next element of the minibuffer history in the minibuffer."
2000 ;; Remember the original goal column of possibly multi-line input
2001 ;; excluding the length of the prompt on the first line.
2011 ;; Restore old position since `line-move-visual' moves point to
2012 ;; the end of the line when it fails to go to the next line.
2015 ;; Restore the original goal column on the last line
2016 ;; of possibly multi-line input.
2024 "Move cursor vertically up ARG lines, or to the previous history element.
2025 When point moves over the top line of multi-line minibuffer, puts ARGth
2026 previous element of the minibuffer history in the minibuffer."
2030 ;; Remember the original goal column of possibly multi-line input
2031 ;; excluding the length of the prompt on the first line.
2041 ;; Restore old position since `line-move-visual' moves point to
2042 ;; the beginning of the line when it fails to go to the previous line.
2045 ;; Restore the original goal column on the first line
2046 ;; of possibly multi-line input.
2055 "Get next history element which completes the minibuffer before the point.
2056 The contents of the minibuffer after the point are deleted, and replaced
2057 by the new completion."
2063 n)
2064 ;; next-matching-history-element always puts us at (point-min).
2065 ;; Move to the position we were at before changing the buffer contents.
2066 ;; This is still sensible, because the text before point has not changed.
2070 "\
2071 Get previous history element which completes the minibuffer before the point.
2072 The contents of the minibuffer after the point are deleted, and replaced
2073 by the new completion."
2077 ;; For compatibility with the old subr of the same name.
2079 "Return the display width of the minibuffer prompt.
2080 Return 0 if current buffer is not a minibuffer."
2081 ;; Return the width of everything before the field at the end of
2082 ;; the buffer; this should be 0 for normal buffers.
2084 \f
2085 ;; isearch minibuffer history
2092 "Set up a minibuffer for using isearch to search the minibuffer history.
2093 Intended to be added to `minibuffer-setup-hook'."
2105 "Clean up the minibuffer after terminating isearch in the minibuffer."
2110 "Return the proper search function, for isearch in minibuffer history."
2113 ;; Use standard functions to search within minibuffer text
2115 found)
2116 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
2117 ;; searching forward. Lazy-highlight calls this lambda with the
2118 ;; bound arg, so skip the minibuffer prompt.
2122 ;; 1. First try searching in the initial minibuffer text
2125 noerror)
2126 ;; 2. If the above search fails, start putting next/prev history
2127 ;; elements in the minibuffer successively, and search the string
2128 ;; in them. Do this only when bound is nil (i.e. not while
2129 ;; lazy-highlighting search strings in the current minibuffer text).
2141 ;; After putting the next/prev history element, search
2142 ;; the string in them again, until next-history-element
2143 ;; or previous-history-element raises an error at the
2144 ;; beginning/end of history.
2147 ;; For backward search, don't search
2148 ;; in the minibuffer prompt
2150 noerror)))
2151 ;; Return point of the new search result
2153 ;; Return nil when next(prev)-history-element fails
2157 "Display the minibuffer history search prompt.
2158 If there are no search errors, this function displays an overlay with
2159 the isearch prompt which replaces the original minibuffer prompt.
2160 Otherwise, it displays the standard isearch message returned from
2161 the function `isearch-message'."
2163 ;; Use standard function `isearch-message' when not in the minibuffer,
2164 ;; or search fails, or has an error (like incomplete regexp).
2165 ;; This function overwrites minibuffer text with isearch message,
2166 ;; so it's possible to see what is wrong in the search string.
2168 ;; Otherwise, put the overlay with the standard isearch prompt over
2169 ;; the initial minibuffer prompt.
2178 ;; And clear any previous isearch message.
2182 "Wrap the minibuffer history search when search fails.
2183 Move point to the first history element for a forward search,
2184 or to the last history element for a backward search."
2185 ;; When `minibuffer-history-isearch-search' fails on reaching the
2186 ;; beginning/end of the history, wrap the search to the first/last
2187 ;; minibuffer history element.
2195 "Save a function restoring the state of minibuffer history search.
2196 Save `minibuffer-history-position' to the additional state parameter
2197 in the search status stack."
2203 "Restore the minibuffer history search state.
2204 Go to the history element by the absolute history position HIST-POS."
2207 \f
2208 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
2212 "Table mapping redo records to the corresponding undo one.
2213 A redo record for undo-in-region maps to t.
2223 "Within a run of consecutive undo commands, list remaining to be undone.
2227 "Undo some previous changes.
2228 Repeat this command to undo more changes.
2229 A numeric ARG serves as a repeat count.
2231 In Transient Mark mode when the mark is active, only undo changes within
2233 as an argument limits undo to changes within the current region."
2235 ;; Make last-command indicate for the next command that this was an undo.
2236 ;; That way, another undo will undo more.
2237 ;; If we get to the end of the undo history and get an error,
2238 ;; another undo command will find the undo history empty
2239 ;; and will get another error. To begin undoing the undos,
2240 ;; you must type some other command.
2242 ;; For an indirect buffer, look in the base buffer for the
2243 ;; auto-save data.
2247 message)
2248 ;; If we get an error in undo-start,
2249 ;; the next command should not be a "consecutive undo".
2250 ;; So set `this-command' to something other than `undo'.
2255 ;; If something (a timer or filter?) changed the buffer
2256 ;; since the previous command, don't continue the undo seq.
2260 ;; If the last undo record made was made by undo
2261 ;; it shows nothing else happened in between.
2268 ;; get rid of initial undo boundary
2270 ;; If we got this far, the next command should be a consecutive undo.
2272 ;; Check to see whether we're hitting a redo record, and if
2273 ;; so, ask the user whether she wants to skip the redo/undo pair.
2281 ;; The equiv entry might point to another redo record if we have done
2282 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2290 ;; Record the fact that the just-generated undo records come from an
2291 ;; undo operation--that is, they are redo records.
2292 ;; In the ordinary case (not within a region), map the redo
2293 ;; record to the following undos.
2294 ;; I don't know how to do that in the undo-in-region case.
2296 ;; Strip any leading undo boundaries there might be, like we do
2297 ;; above when checking.
2301 ;; Prevent identity mapping. This can happen if
2302 ;; consecutive nils are erroneously in undo list.
2304 t
2305 pending-undo-list)
2306 undo-equiv-table))
2307 ;; Don't specify a position in the undo record for the undo command.
2308 ;; Instead, undoing this should move point to where the change is.
2327 ;; Record what the current undo list says,
2328 ;; so the next command can tell if the buffer was modified in between.
2332 ;; Display a message announcing success.
2337 "Make BUFFER stop keeping undo information.
2338 No argument or nil as argument means do this for the current buffer."
2344 "Undo some previous changes.
2345 Repeat this command to undo more changes.
2346 A numeric ARG serves as a repeat count.
2347 Contrary to `undo', this will not redo a previous undo."
2352 "Non-nil while performing an undo.
2356 "Undo back N undo-boundaries beyond what was already undone recently.
2357 Call `undo-start' to get ready to undo recent changes,
2358 then call `undo-more' one or more times to undo them."
2363 ;; Note: The following, while pulling elements off
2364 ;; `pending-undo-list' will call primitive change functions which
2365 ;; will push more elements onto `buffer-undo-list'.
2371 "Undo N records from the front of the list LIST.
2372 Return what remains of the list."
2374 ;; This is a good feature, but would make undo-start
2375 ;; unable to do what is expected.
2376 ;;(when (null (car (list)))
2377 ;; ;; If the head of the list is a boundary, it is the boundary
2378 ;; ;; preceding this command. Get rid of it and don't count it.
2379 ;; (setq list (cdr list))))
2382 ;; In a writable buffer, enable undoing read-only text that is
2383 ;; so because of text properties.
2385 ;; Don't let `intangible' properties interfere with undo.
2387 ;; We use oldlist only to check for EQ. ++kfs
2393 ;; Handle an integer by setting point to that value.
2396 ;; Element (t . TIME) records previous modtime.
2397 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2398 ;; UNKNOWN_MODTIME_NSECS.
2400 ;; If this records an obsolete save
2401 ;; (not matching the actual disk file)
2402 ;; then don't mark unmodified.
2410 ;; Element (nil PROP VAL BEG . END) is property change.
2415 ;; Element (BEG . END) means range was inserted.
2417 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2418 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2421 ;; Set point first thing, so that undoing this undo
2422 ;; does not send point back to where it is now.
2425 ;; Element (apply FUN . ARGS) means call FUN to undo.
2429 ;; Long format: (apply DELTA START END FUN . ARGS).
2436 ;; Check that the function did what the entry
2437 ;; said it would do.
2447 ;; Element (STRING . POS) means STRING was deleted.
2453 ;; Check that marker adjustments which were recorded
2454 ;; with the (STRING . POS) record are still valid, ie
2455 ;; the markers haven't moved. We check their validity
2456 ;; before reinserting the string so as we don't need to
2457 ;; mind marker insertion-type.
2465 ;; Insert string and adjust point
2473 ;; Adjust the valid marker adjustments
2477 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2480 next)
2481 ;; Even though these elements are not expected in the undo
2482 ;; list, adjust them to be conservative for the 24.4
2483 ;; release. (Bug#16818)
2490 ;; Make sure an apply entry produces at least one undo entry,
2491 ;; so the test in `undo' for continuing an undo series
2492 ;; will work right.
2497 list)
2499 ;; Deep copy of a list
2501 "Make a copy of undo list LIST."
2507 elt))
2510 "Set `pending-undo-list' to the front of the undo list.
2511 The next call to `undo-more' will undo the most recently made change.
2512 If BEG and END are specified, then only undo elements
2513 that apply to text between BEG and END are used; other undo elements
2514 are ignored. If BEG and END are nil, all undo elements are used."
2520 buffer-undo-list)))
2522 ;; The positions given in elements of the undo list are the positions
2523 ;; as of the time that element was recorded to undo history. In
2524 ;; general, subsequent buffer edits render those positions invalid in
2525 ;; the current buffer, unless adjusted according to the intervening
2526 ;; undo elements.
2527 ;;
2528 ;; Undo in region is a use case that requires adjustments to undo
2529 ;; elements. It must adjust positions of elements in the region based
2530 ;; on newer elements not in the region so as they may be correctly
2531 ;; applied in the current buffer. undo-make-selective-list
2532 ;; accomplishes this with its undo-deltas list of adjustments. An
2533 ;; example undo history from oldest to newest:
2534 ;;
2535 ;; buf pos:
2536 ;; 123456789 buffer-undo-list undo-deltas
2537 ;; --------- ---------------- -----------
2538 ;; aaa (1 . 4) (1 . -3)
2539 ;; aaba (3 . 4) N/A (in region)
2540 ;; ccaaba (1 . 3) (1 . -2)
2541 ;; ccaabaddd (7 . 10) (7 . -3)
2542 ;; ccaabdd ("ad" . 6) (6 . 2)
2543 ;; ccaabaddd (6 . 8) (6 . -2)
2544 ;; | |<-- region: "caab", from 2 to 6
2545 ;;
2546 ;; When the user starts a run of undos in region,
2547 ;; undo-make-selective-list is called to create the full list of in
2548 ;; region elements. Each element is adjusted forward chronologically
2549 ;; through undo-deltas to determine if it is in the region.
2550 ;;
2551 ;; In the above example, the insertion of "b" is (3 . 4) in the
2552 ;; buffer-undo-list. The undo-delta (1 . -2) causes (3 . 4) to become
2553 ;; (5 . 6). The next three undo-deltas cause no adjustment, so (5
2554 ;; . 6) is assessed as in the region and placed in the selective list.
2555 ;; Notably, the end of region itself adjusts from "2 to 6" to "2 to 5"
2556 ;; due to the selected element. The "b" insertion is the only element
2557 ;; fully in the region, so in this example undo-make-selective-list
2558 ;; returns (nil (5 . 6)).
2559 ;;
2560 ;; The adjustment of the (7 . 10) insertion of "ddd" shows an edge
2561 ;; case. It is adjusted through the undo-deltas: ((6 . 2) (6 . -2)).
2562 ;; Normally an undo-delta of (6 . 2) would cause positions after 6 to
2563 ;; adjust by 2. However, they shouldn't adjust to less than 6, so (7
2564 ;; . 10) adjusts to (6 . 8) due to the first undo delta.
2565 ;;
2566 ;; More interesting is how to adjust the "ddd" insertion due to the
2567 ;; next undo-delta: (6 . -2), corresponding to reinsertion of "ad".
2568 ;; If the reinsertion was a manual retyping of "ad", then the total
2569 ;; adjustment should be (7 . 10) -> (6 . 8) -> (8 . 10). However, if
2570 ;; the reinsertion was due to undo, one might expect the first "d"
2571 ;; character would again be a part of the "ddd" text, meaning its
2572 ;; total adjustment would be (7 . 10) -> (6 . 8) -> (7 . 10).
2573 ;;
2574 ;; undo-make-selective-list assumes in this situation that "ad" was a
2575 ;; new edit, even if it was inserted because of an undo.
2576 ;; Consequently, if the user undos in region "8 to 10" of the
2577 ;; "ccaabaddd" buffer, they could be surprised that it becomes
2578 ;; "ccaabad", as though the first "d" became detached from the
2579 ;; original "ddd" insertion. This quirk is a FIXME.
2582 "Return a list of undo elements for the region START to END.
2583 The elements come from `buffer-undo-list', but we keep only the
2584 elements inside this region, and discard those outside this
2585 region. The elements' positions are adjusted so as the returned
2586 list can be applied to the current buffer."
2588 ;; A list of position adjusted undo elements in the region.
2590 ;; A list of undo-deltas for out of region undo elements.
2591 undo-deltas
2592 undo-elt)
2600 ;; Don't put two nils together in the list
2604 ;; This is a "was unmodified" element. Keep it
2605 ;; if we have kept everything thus far.
2608 ;; Skip over marker adjustments, instead relying
2609 ;; on finding them after (TEXT . POS) elements
2611 nil)
2614 undo-deltas)))
2619 ;; Keep (MARKER . ADJUSTMENT) if their (TEXT . POS) was
2620 ;; kept. primitive-undo may discard them later.
2633 "Determine whether UNDO-ELT falls inside the region START ... END.
2634 If it crosses the edge, we return nil.
2636 Generally this function is not useful for determining
2637 whether (MARKER . ADJUSTMENT) undo elements are in the region,
2638 because markers can be arbitrarily relocated. Instead, pass the
2639 marker adjustment's corresponding (TEXT . POS) element."
2644 t)
2646 nil)
2648 ;; (TEXT . POSITION)
2652 ;; (MARKER . ADJUSTMENT)
2655 ;; (nil PROPERTY VALUE BEG . END)
2660 ;; (BEGIN . END)
2665 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2666 This assumes we have already decided that UNDO-ELT
2667 is not *inside* the region START...END."
2671 ;; (nil PROPERTY VALUE BEG . END)
2676 ;; (BEGIN . END)
2681 "Return adjustment of undo element ELT by the undo DELTAS
2682 list."
2684 ;; POSITION
2687 ;; (BEG . END)
2690 ;; (TEXT . POSITION)
2694 ;; (nil PROPERTY VALUE BEG . END)
2697 ;; (apply DELTA START END FUN . ARGS)
2698 ;; FIXME
2699 ;; All others return same elt
2702 ;; (BEG . END) can adjust to the same positions, commonly when an
2703 ;; insertion was undone and they are out of region, for example:
2704 ;;
2705 ;; buf pos:
2706 ;; 123456789 buffer-undo-list undo-deltas
2707 ;; --------- ---------------- -----------
2708 ;; [...]
2709 ;; abbaa (2 . 4) (2 . -2)
2710 ;; aaa ("bb" . 2) (2 . 2)
2711 ;; [...]
2712 ;;
2713 ;; "bb" insertion (2 . 4) adjusts to (2 . 2) because of the subsequent
2714 ;; undo. Further adjustments to such an element should be the same as
2715 ;; for (TEXT . POSITION) elements. The options are:
2716 ;;
2717 ;; 1: POSITION adjusts using <= (use-< nil), resulting in behavior
2718 ;; analogous to marker insertion-type t.
2719 ;;
2720 ;; 2: POSITION adjusts using <, resulting in behavior analogous to
2721 ;; marker insertion-type nil.
2722 ;;
2723 ;; There was no strong reason to prefer one or the other, except that
2724 ;; the first is more consistent with prior undo in region behavior.
2726 "Return cons of adjustments to BEG and END by the undo DELTAS
2727 list."
2729 ;; Note: option 2 above would be like (cons (min ...) adj-end)
2734 "Return adjustment of POS by the undo DELTAS list, comparing
2735 with < or <= based on USE-<."
2741 ;; Don't allow pos to become less than the undo-delta
2742 ;; position. This edge case is described in the overview
2743 ;; comments.
2746 ;; Return the first affected buffer position and the delta for an undo element
2747 ;; delta is defined as the change in subsequent buffer positions if we *did*
2748 ;; the undo.
2752 ;; (TEXT . POSITION)
2755 ;; (BEGIN . END)
2762 "If non-nil ask about discarding undo info for the current command.
2763 Normally, Emacs discards the undo info for the current command if
2764 it exceeds `undo-outer-limit'. But if you set this option
2765 non-nil, it asks in the echo area whether to discard the info.
2766 If you answer no, there is a slight risk that Emacs might crash, so
2767 only do it if you really want to undo the command.
2769 This option is mainly intended for debugging. You have to be
2770 careful if you use it for other purposes. Garbage collection is
2771 inhibited while the question is asked, meaning that Emacs might
2772 leak memory. So you should make sure that you do not wait
2773 excessively long before answering the question."
2779 "If non-nil, an extra level of size that's ok in an undo item.
2780 We don't ask the user about truncating the undo list until the
2781 current item gets bigger than this amount.
2786 ;; When the first undo batch in an undo list is longer than
2787 ;; undo-outer-limit, this function gets called to warn the user that
2788 ;; the undo info for the current command was discarded. Garbage
2789 ;; collection is inhibited around the call, so it had better not do a
2790 ;; lot of consing.
2796 ;; Don't ask the question again unless it gets even bigger.
2797 ;; This applies, in particular, if the user quits from the question.
2798 ;; Such a quit quits out of GC, but something else will call GC
2799 ;; again momentarily. It will call this function again,
2800 ;; but we don't want to ask the question again.
2804 "Buffer `%s' undo info is %d bytes long; discard it? "
2808 t)
2809 nil))
2815 "The undo info was discarded because it exceeded \
2816 `undo-outer-limit'.
2818 This is normal if you executed a command that made a huge change
2819 to the buffer. In that case, to prevent similar problems in the
2820 future, set `undo-outer-limit' to a value that is large enough to
2821 cover the maximum size of normal changes you expect a single
2822 command to make, but not so large that it might exceed the
2823 maximum memory allotted to Emacs.
2825 If you did not execute any such command, the situation is
2826 probably due to a bug and you should report it.
2828 You can disable the popping up of this buffer by adding the entry
2829 \(undo discard-info) to the user option `warning-suppress-types',
2833 t))
2834 \f
2837 ; These are sorted according to the GNU en_US locale.
2880 )
2882 This is used by Shell mode and other parts of Emacs to recognize
2883 password prompts, including prompts in languages other than
2884 English. Different case choices should not be assumed to be
2885 included; callers should bind `case-fold-search' to t."
2891 "History list for some commands that read shell commands.
2893 Maximum length of the history list is determined by the value
2900 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2901 This buffer is used when `shell-command' or `shell-command-on-region'
2902 is run interactively. A value of nil means that output to stderr and
2909 "Return a list of all commands associated with the current file.
2910 This function is used to add all related commands retrieved by `mailcap'
2911 to the end of the list of defaults just after the default value."
2915 minibuffer-default))
2920 commands))
2931 map)
2935 "Read a shell command from the minibuffer.
2936 The arguments are the same as the ones of `read-from-minibuffer',
2937 except READ and KEYMAP are missing and HIST defaults
2938 to `shell-command-history'."
2946 minibuffer-local-shell-command-map
2947 nil
2949 args)))
2952 "What to do when the output buffer is used by another shell command.
2953 This option specifies how to resolve the conflict where a new command
2954 wants to direct its output to the buffer `*Async Shell Command*',
2955 but this buffer is already taken by another running shell command.
2957 The value `confirm-kill-process' is used to ask for confirmation before
2958 killing the already running process and running a new process
2959 in the same buffer, `confirm-new-buffer' for confirmation before running
2960 the command in a new buffer with a name other than the default buffer name,
2961 `new-buffer' for doing the same without confirmation,
2962 `confirm-rename-buffer' for confirmation before renaming the existing
2963 output buffer and running a new command in the default buffer,
2964 `rename-buffer' for doing the same without confirmation."
2966 confirm-kill-process)
2968 confirm-new-buffer)
2970 new-buffer)
2972 confirm-rename-buffer)
2974 rename-buffer))
2979 "Execute string COMMAND asynchronously in background.
2981 Like `shell-command', but adds `&' at the end of COMMAND
2982 to execute it asynchronously.
2984 The output appears in the buffer `*Async Shell Command*'.
2985 That buffer is in shell mode.
2987 You can configure `async-shell-command-buffer' to specify what to do in
2988 case when `*Async Shell Command*' buffer is already taken by another
2989 running shell command. To run COMMAND without displaying the output
2990 in a window you can configure `display-buffer-alist' to use the action
2991 `display-buffer-no-window' for the buffer `*Async Shell Command*'.
2993 In Elisp, you will often be better served by calling `start-process'
2994 directly, since it offers more control and does not impose the use of a
2995 shell (with its need to quote arguments)."
3005 current-prefix-arg
3006 shell-command-default-error-buffer))
3012 "Execute string COMMAND in inferior shell; display output, if any.
3013 With prefix argument, insert the COMMAND's output at point.
3015 If COMMAND ends in `&', execute it asynchronously.
3016 The output appears in the buffer `*Async Shell Command*'.
3017 That buffer is in shell mode. You can also use
3018 `async-shell-command' that automatically adds `&'.
3020 Otherwise, COMMAND is executed synchronously. The output appears in
3021 the buffer `*Shell Command Output*'. If the output is short enough to
3022 display in the echo area (which is determined by the variables
3023 `resize-mini-windows' and `max-mini-window-height'), it is shown
3024 there, but it is nonetheless available in buffer `*Shell Command
3025 Output*' even though that buffer is not automatically displayed.
3027 To specify a coding system for converting non-ASCII characters
3029 before this command.
3031 Noninteractive callers can specify coding systems by binding
3032 `coding-system-for-read' and `coding-system-for-write'.
3034 The optional second argument OUTPUT-BUFFER, if non-nil,
3035 says to put the output in some other buffer.
3036 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
3037 If OUTPUT-BUFFER is not a buffer and not nil,
3038 insert output in current buffer. (This cannot be done asynchronously.)
3039 In either case, the buffer is first erased, and the output is
3040 inserted after point (leaving mark after it).
3042 If the command terminates without error, but generates output,
3044 the output can be displayed in the echo area or in its buffer.
3045 If the output is short enough to display in the echo area
3046 \(determined by the variable `max-mini-window-height' if
3047 `resize-mini-windows' is non-nil), it is shown there.
3048 Otherwise,the buffer containing the output is displayed.
3052 of the output.
3054 If there is no output, or if output is inserted in the current buffer,
3055 then `*Shell Command Output*' is deleted.
3057 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
3058 or buffer name to which to direct the command's standard error output.
3059 If it is nil, error output is mingled with regular output.
3060 In an interactive call, the variable `shell-command-default-error-buffer'
3061 specifies the value of ERROR-BUFFER.
3063 In Elisp, you will often be better served by calling `call-process' or
3064 `start-process' directly, since it offers more control and does not impose
3065 the use of a shell (with its need to quote arguments)."
3076 current-prefix-arg
3077 shell-command-default-error-buffer))
3078 ;; Look for a handler in case default-directory is a remote file name.
3086 ;; Output goes in current buffer.
3092 temporary-file-directory)))
3093 nil)))
3096 ;; We do not use -f for csh; we will not support broken use of
3097 ;; .cshrcs. Even the BSD csh manual says to use
3098 ;; "if ($?prompt) exit" before things which are not useful
3099 ;; non-interactively. Besides, if someone wants their other
3100 ;; aliases for shell commands then they can still have them.
3104 t)
3105 nil shell-command-switch command)
3112 ;; Do no formatting while reading error file,
3113 ;; because that can run a shell command, and we
3114 ;; don't want that to cause an infinite recursion.
3116 ;; Put point after the inserted errors.
3120 ;; This is like exchange-point-and-mark, but doesn't
3121 ;; activate the mark. It is cleaner to avoid activation,
3122 ;; even though the command loop would deactivate the mark
3123 ;; because we inserted text.
3127 ;; Output goes in a separate buffer.
3128 ;; Preserve the match data in case called from a program.
3131 ;; Command ending with ampersand means asynchronous.
3135 proc)
3136 ;; Remove the ampersand.
3138 ;; Ask the user what to do with already running process.
3143 ;; If will kill a process, query first.
3148 ;; If will create a new buffer, query first.
3155 ;; It will create a new buffer.
3160 ;; If will rename the buffer, query first.
3169 ;; It will rename the buffer.
3176 ;; Setting buffer-read-only to nil doesn't suffice
3177 ;; if some text has a non-nil read-only property,
3178 ;; which comint sometimes adds for prompts.
3184 shell-command-switch command))
3188 ;; Use the comint filter for proper handling of carriage motion
3189 ;; (see `comint-inhibit-carriage-motion'),.
3191 ))
3192 ;; Otherwise, command is executed synchronously.
3194 output-buffer nil error-buffer)))))))
3198 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
3199 MESSAGE may be either a string or a buffer.
3201 A buffer is displayed using `display-buffer' if MESSAGE is too long for
3202 the maximum height of the echo area, as defined by `max-mini-window-height'
3203 if `resize-mini-windows' is non-nil.
3205 Returns either the string shown in the echo area, or when a pop-up
3206 buffer is used, the window used to display it.
3208 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
3209 name of the buffer used to display it in the case where a pop-up buffer
3210 is used, defaulting to `*Message*'. In the case where MESSAGE is a
3211 string and it is displayed in the echo area, it is not specified whether
3212 the contents are inserted into the buffer anyway.
3214 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
3215 and only used if a buffer is displayed."
3217 ;; Trivial case where we can use the echo area
3221 ;; Trivial case where we can just remove single trailing newline
3224 ;; General case
3227 message
3236 0
3240 (<= lines
3244 max-mini-window-height))
3246 max-mini-window-height)
3250 ;; Don't use the echo area if the output buffer is
3251 ;; already displayed in the selected frame.
3253 ;; Echo area
3259 ;; Buffer
3262 not-this-window frame))))))))
3265 ;; We have a sentinel to prevent insertion of a termination message
3266 ;; in the buffer itself.
3274 &optional output-buffer replace
3275 error-buffer display-error-buffer)
3276 "Execute string COMMAND in inferior shell with region as input.
3277 Normally display output (if any) in temp buffer `*Shell Command Output*';
3278 Prefix arg means replace the region with it. Return the exit code of
3279 COMMAND.
3281 To specify a coding system for converting non-ASCII characters
3283 before this command. By default, the input (from the current buffer)
3284 is encoded using coding-system specified by `process-coding-system-alist',
3285 falling back to `default-process-coding-system' if no match for COMMAND
3286 is found in `process-coding-system-alist'.
3288 Noninteractive callers can specify coding systems by binding
3289 `coding-system-for-read' and `coding-system-for-write'.
3291 If the command generates output, the output may be displayed
3292 in the echo area or in a buffer.
3293 If the output is short enough to display in the echo area
3294 \(determined by the variable `max-mini-window-height' if
3295 `resize-mini-windows' is non-nil), it is shown there.
3296 Otherwise it is displayed in the buffer `*Shell Command Output*'.
3297 The output is available in that buffer in both cases.
3299 If there is output and an error, a message about the error
3300 appears at the end of the output. If there is no output, or if
3301 output is inserted in the current buffer, the buffer `*Shell
3302 Command Output*' is deleted.
3304 Optional fourth arg OUTPUT-BUFFER specifies where to put the
3305 command's output. If the value is a buffer or buffer name,
3306 put the output there. If the value is nil, use the buffer
3307 `*Shell Command Output*'. Any other value, excluding nil,
3308 means to insert the output in the current buffer. In either case,
3309 the output is inserted after point (leaving mark after it).
3311 Optional fifth arg REPLACE, if non-nil, means to insert the
3312 output in place of text from START to END, putting point and mark
3313 around it.
3315 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
3316 or buffer name to which to direct the command's standard error
3317 output. If nil, error output is mingled with regular output.
3318 When called interactively, `shell-command-default-error-buffer'
3319 is used for ERROR-BUFFER.
3321 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
3322 display the error buffer if there were any errors. When called
3323 interactively, this is t."
3327 ;; Do this before calling region-beginning
3328 ;; and region-end, in case subprocess output
3329 ;; relocates them while we are in the minibuffer.
3331 ;; call-interactively recognizes region-beginning and
3332 ;; region-end specially, leaving them in the history.
3334 string
3335 current-prefix-arg
3336 current-prefix-arg
3337 shell-command-default-error-buffer
3338 t)))
3344 temporary-file-directory)))
3345 nil))
3346 exit-status)
3350 ;; Replace specified region with output from command.
3352 ;; Don't muck with mark unless REPLACE says we should.
3359 t)
3360 nil shell-command-switch command))
3361 ;; It is rude to delete a buffer which the command is not using.
3362 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
3363 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
3364 ;; (kill-buffer shell-buffer)))
3365 ;; Don't muck with mark unless REPLACE says we should.
3367 ;; No prefix argument: put the output in a temp buffer,
3368 ;; replacing its entire contents.
3373 ;; If the input is the same buffer as the output,
3374 ;; delete everything but the specified region,
3375 ;; then replace that region with the output.
3381 shell-file-name t
3384 t)
3385 nil shell-command-switch
3386 command)))
3387 ;; Clear the output buffer, then run the command with
3388 ;; output there.
3399 buffer)
3400 nil shell-command-switch command)))
3401 ;; Report the output.
3411 ;; There's some output, display it
3413 ;; No output; error?
3420 shell-command-default-error-buffer)
3427 output))
3430 exit-status))
3433 exit-status output))))
3434 ;; Don't kill: there might be useful info in the undo-log.
3435 ;; (kill-buffer buffer)
3436 ))))
3444 ;; Do no formatting while reading error file,
3445 ;; because that can run a shell command, and we
3446 ;; don't want that to cause an infinite recursion.
3448 ;; Put point after the inserted errors.
3453 exit-status))
3456 "Execute shell command COMMAND and return its output as a string."
3459 standard-output
3463 "Process files synchronously in a separate process.
3464 Similar to `call-process', but may invoke a file handler based on
3465 `default-directory'. The current working directory of the
3466 subprocess is `default-directory'.
3468 File names in INFILE and BUFFER are handled normally, but file
3469 names in ARGS should be relative to `default-directory', as they
3470 are passed to the process verbatim. (This is a difference to
3471 `call-process' which does not support file handlers for INFILE
3472 and BUFFER.)
3474 Some file handlers might not support all variants, for example
3475 they might behave as if DISPLAY was nil, regardless of the actual
3476 value passed."
3478 lc stderr-file)
3488 display args)
3494 "Whether a call of `process-file' changes remote files.
3496 By default, this variable is always set to t, meaning that a
3497 call of `process-file' could potentially change any file on a
3498 remote host. When set to nil, a file handler could optimize
3499 its behavior with respect to remote file attribute caching.
3501 You should only ever change this variable with a let-binding;
3505 "Start a program in a subprocess. Return the process object for it.
3507 Similar to `start-process', but may invoke a file handler based on
3508 `default-directory'. See Info node `(elisp)Magic File Names'.
3510 This handler ought to run PROGRAM, perhaps on the local host,
3511 perhaps on a remote host that corresponds to `default-directory'.
3512 In the latter case, the local part of `default-directory' becomes
3513 the working directory of the process.
3515 PROGRAM and PROGRAM-ARGS might be file names. They are not
3516 objects of file handler invocation. File handlers might not
3517 support pty association, if PROGRAM is nil."
3521 \f
3522 ;;;; Process menu
3536 map))
3539 "Major mode for listing the processes called by Emacs."
3551 "Kill process at point in a `list-processes' buffer."
3557 "Recompute the list of processes for the Process List buffer.
3558 Also, delete any process that is exited or signaled."
3571 face link
3573 "Visit buffer `%s'"
3575 follow-link t
3576 process-buffer ,buf
3577 action process-menu-visit-buffer)
3586 "datagram"
3603 tabulated-list-entries))))))
3609 "Display a list of all processes that are Emacs sub-processes.
3610 If optional argument QUERY-ONLY is non-nil, only processes with
3611 the query-on-exit flag set are listed.
3612 Any process listed as exited or signaled is actually eliminated
3613 after the listing is made.
3614 Optional argument BUFFER specifies a buffer to use, instead of
3616 The return value is always nil.
3618 This function lists only processes that were launched by Emacs. To
3619 see other processes running on the system, use `list-system-processes'."
3631 nil)
3632 \f
3633 ;;;; Prefix commands
3639 ;; BEWARE: Called directly from the C code.
3641 prefix-command--last-echo
3650 "Abnormal hook which constructs the description of the current prefix state.
3654 "Update state of prefix commands.
3662 "Pass the current prefix command state to the next command.
3663 Should be called by all prefix commands.
3664 Runs `prefix-command-preserve-state-hook'."
3666 ;; If the current command is a prefix command, we don't want the next (real)
3667 ;; command to have `last-command' set to, say, `universal-argument'.
3674 nil)
3676 ;;;;; The main prefix command.
3678 ;; FIXME: Declaration of `prefix-arg' should be moved here!?
3703 ;; For backward compatibility, minus with no modifiers is an ordinary
3704 ;; command if digits have already been entered.
3734 map)
3742 "Begin a numeric argument for the following command.
3747 multiplies the argument by 4 each time.
3749 which is different in effect from any particular numeric argument.
3757 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3758 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3765 arg)))
3769 "Begin a negative numeric argument for the next command.
3779 "Part of the numeric argument for the next command.
3784 last-command-event
3791 ;; Treat -0 as just -, so that -01 will work.
3794 digit))))
3796 \f
3804 "Function to perform the filtering in `filter-buffer-substring'.
3805 The function is called with the same 3 arguments (BEG END DELETE)
3806 that `filter-buffer-substring' received. It should return the
3807 buffer substring between BEG and END, after filtering. If DELETE is
3811 "List of filter functions for `buffer-substring--filter'.
3812 Each function must accept a single argument, a string, and return a string.
3813 The buffer substring is passed to the first function in the list,
3814 and the return value of each function is passed to the next.
3815 As a special convention, point is set to the start of the buffer text
3816 being operated on (i.e., the first argument of `buffer-substring--filter')
3822 "Return the buffer substring between BEG and END, after filtering.
3823 If DELETE is non-nil, delete the text between BEG and END from the buffer.
3825 This calls the function that `filter-buffer-substring-function' specifies
3826 \(passing the same three arguments that it received) to do the work,
3827 and returns whatever it does. The default function does no filtering,
3828 unless a hook has been set.
3830 Use `filter-buffer-substring' instead of `buffer-substring',
3831 `buffer-substring-no-properties', or `delete-and-extract-region' when
3832 you want to allow filtering to take place. For example, major or minor
3833 modes can use `filter-buffer-substring-function' to extract characters
3834 that are special to a buffer, and should not be copied into other buffers."
3838 "Default function to use for `filter-buffer-substring-function'.
3839 Its arguments and return value are as specified for `filter-buffer-substring'.
3840 This respects the wrapper hook `filter-buffer-substring-functions',
3841 and the abnormal hook `buffer-substring-filters'.
3842 No filtering is done unless a hook says to."
3852 string)))
3857 ;;;; Window system cut and paste hooks.
3860 "Function to call to make a killed region available to other programs.
3861 Most window systems provide a facility for cutting and pasting
3862 text between different programs, such as the clipboard on X and
3863 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3865 This variable holds a function that Emacs calls whenever text is
3866 put in the kill ring, to make the new kill available to other
3867 programs. The function takes one argument, TEXT, which is a
3871 "Function to call to get text cut from other programs.
3872 Most window systems provide a facility for cutting and pasting
3873 text between different programs, such as the clipboard on X and
3874 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3876 This variable holds a function that Emacs calls to obtain text
3877 that other programs have provided for pasting. The function is
3878 called with no arguments. If no other program has provided text
3879 to paste, the function should return nil (in which case the
3880 caller, usually `current-kill', should use the top of the Emacs
3881 kill ring). If another program has provided text to paste, the
3882 function should return that text as a string (in which case the
3883 caller should put this string in the kill ring as the latest
3884 kill).
3886 The function may also return a list of strings if the window
3887 system supports multiple selections. The first string will be
3888 used as the pasted text, but the other will be placed in the kill
3889 ring for easy access via `yank-pop'.
3891 Note that the function should return a string only if a program
3892 other than Emacs has provided a string for pasting; if Emacs
3893 provided the most recent string, the function should return nil.
3894 If it is difficult to tell whether Emacs or some other program
3895 provided the current string, it is probably good enough to return
3896 nil if the string is equal (according to `string=') to the last
3898 \f
3901 ;;;; The kill ring data structure.
3904 "List of killed text sequences.
3905 Since the kill ring is supposed to interact nicely with cut-and-paste
3906 facilities offered by window systems, use of this variable should
3907 interact nicely with `interprogram-cut-function' and
3908 `interprogram-paste-function'. The functions `kill-new',
3909 `kill-append', and `current-kill' are supposed to implement this
3910 interaction; you may want to use them instead of manipulating the kill
3914 "Maximum length of kill ring before oldest elements are thrown away."
3922 "Save clipboard strings into kill ring before replacing them.
3923 When one selects something in another program to paste it into Emacs,
3924 but kills something in Emacs before actually pasting it,
3925 this selection is gone unless this variable is non-nil,
3926 in which case the other program's selection is saved in the `kill-ring'
3933 "Do not add a new string to `kill-ring' if it duplicates the last one.
3934 The comparison is done using `equal-including-properties'."
3940 "Make STRING the latest kill in the kill ring.
3941 Set `kill-ring-yank-pointer' to point to it.
3942 If `interprogram-cut-function' is non-nil, apply it to STRING.
3943 Optional second argument REPLACE non-nil means that STRING will replace
3944 the front of the kill ring, rather than being added to the list.
3946 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3947 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3948 STRING.
3950 When the yank handler has a non-nil PARAM element, the original STRING
3951 argument is not used by `insert-for-yank'. However, since Lisp code
3952 may access and use elements from the kill ring directly, the STRING
3955 ;; Due to text properties such as 'yank-handler that
3956 ;; can alter the contents to yank, comparison using
3957 ;; `equal' is unsafe.
3982 ;; It has been argued that this should work similar to `self-insert-command'
3983 ;; which merges insertions in undo-list in groups of 20 (hard-coded in cmds.c).
3985 "Whether appending to kill ring also makes \\[undo] restore both pieces of text simultaneously."
3991 "Append STRING to the end of the latest kill in the kill ring.
3992 If BEFORE-P is non-nil, prepend STRING to the kill.
3993 Also removes the last undo boundary in the current buffer,
3994 depending on `kill-append-merge-undo'.
3995 If `interprogram-cut-function' is set, pass the resulting kill to it."
4003 ;; find the next undo boundary
4007 ;; remove this undo boundary
4012 "Whether rotating the kill ring changes the window system selection.
4013 If non-nil, whenever the kill ring is rotated (usually via the
4014 `yank-pop' command), Emacs also calls `interprogram-cut-function'
4015 to copy the new kill to the window system selection."
4021 "Rotate the yanking point by N places, and then return that kill.
4022 If N is zero and `interprogram-paste-function' is set to a
4023 function that returns a string or a list of strings, and if that
4024 function doesn't return nil, then that string (or list) is added
4025 to the front of the kill ring and the string (or first string in
4026 the list) is returned as the latest kill.
4028 If N is not zero, and if `yank-pop-change-selection' is
4029 non-nil, use `interprogram-cut-function' to transfer the
4030 kill at the new yank point into the window system selection.
4032 If optional arg DO-NOT-MOVE is non-nil, then don't actually
4033 move the yanking point; just return the Nth kill forward."
4036 interprogram-paste-function
4040 ;; Disable the interprogram cut function when we add the new
4041 ;; text to the kill ring, so Emacs doesn't try to own the
4042 ;; selection, with identical text.
4052 kill-ring)))
4057 interprogram-cut-function)
4063 ;;;; Commands for manipulating the kill ring.
4066 "Non-nil means don't signal an error for killing read-only text."
4072 This deletes the text from the buffer and saves it in the kill ring.
4076 If you want to append the killed region to the last killed text,
4079 If the buffer is read-only, Emacs will beep and refrain from deleting
4080 the text, but put the text in the kill ring anyway. This means that
4081 you can use the killing commands to copy text from a read-only buffer.
4083 Lisp programs should use this function for killing text.
4084 (To delete text, use `delete-region'.)
4085 Supply two arguments, character positions indicating the stretch of text
4086 to be killed.
4088 If the previous command was also a kill command,
4089 the text killed this time appends to the text killed last time
4090 to make one entry in the kill ring.
4092 The optional argument REGION if non-nil, indicates that we're not just killing
4093 some text between BEG and END, but we're killing the region."
4094 ;; Pass mark first, then point, because the order matters when
4095 ;; calling `kill-append'.
4104 ;; Add that string to the kill ring, one way or another.
4111 nil)
4113 ;; The code above failed because the buffer, or some of the characters
4114 ;; in the region, are read-only.
4115 ;; We should beep, in case the user just isn't aware of this.
4116 ;; However, there's no harm in putting
4117 ;; the region's text in the kill ring, anyway.
4119 ;; Set this-command now, so it will be set even if we get an error.
4121 ;; This should barf, if appropriate, and give us the correct error.
4124 ;; Signal an error if the buffer is read-only.
4126 ;; If the buffer isn't read-only, the text is.
4129 ;; copy-region-as-kill no longer sets this-command, because it's confusing
4130 ;; to get two copies of the text when the user accidentally types M-w and
4131 ;; then corrects it with the intended C-w.
4133 "Save the region as if killed, but don't kill it.
4134 In Transient Mark mode, deactivate the mark.
4135 If `interprogram-cut-function' is non-nil, also save the text for a window
4136 system cut and paste.
4138 The optional argument REGION if non-nil, indicates that we're not just copying
4139 some text between BEG and END, but we're copying the region.
4141 This command's old key binding has been given to `kill-ring-save'."
4142 ;; Pass mark first, then point, because the order matters when
4143 ;; calling `kill-append'.
4153 nil)
4156 "Save the region as if killed, but don't kill it.
4157 In Transient Mark mode, deactivate the mark.
4158 If `interprogram-cut-function' is non-nil, also save the text for a window
4159 system cut and paste.
4161 If you want to append the killed line to the last killed text,
4164 The optional argument REGION if non-nil, indicates that we're not just copying
4165 some text between BEG and END, but we're copying the region.
4167 This command is similar to `copy-region-as-kill', except that it gives
4168 visual feedback indicating the extent of the region being copied."
4169 ;; Pass mark first, then point, because the order matters when
4170 ;; calling `kill-append'.
4174 ;; This use of called-interactively-p is correct because the code it
4175 ;; controls just gives the user visual feedback.
4180 "Indicate that the region text has been copied interactively.
4181 If the mark is visible in the selected window, blink the cursor
4182 between point and mark if there is currently no active region
4183 highlighting.
4185 If the mark lies outside the selected window, display an
4186 informative message containing a sample of the copied text. The
4187 optional argument MESSAGE-LEN, if non-nil, specifies the length
4188 of this sample text; it defaults to 40."
4191 ;; Inhibit quitting so we can make a quit here
4192 ;; look like a C-g typed as a command.
4195 ;; Swap point-and-mark quickly so as to show the region that
4196 ;; was selected. Don't do it if the region is highlighted.
4199 ;; Swap point and mark.
4203 ;; Swap back.
4206 ;; If user quit, deactivate the mark
4207 ;; as C-g would as a command.
4213 ;; Don't say "killed"; that is misleading.
4220 "Cause following command, if it kills, to add to previous kill.
4221 If the next command kills forward from point, the kill is
4222 appended to the previous killed text. If the command kills
4223 backward, the kill is prepended. Kill commands that act on the
4224 region, such as `kill-region', are regarded as killing forward if
4225 point is after mark, and killing backward if point is before
4226 mark.
4228 If the next command is not a kill command, `append-next-kill' has
4229 no effect.
4231 The argument is used for internal purposes; do not supply one."
4233 ;; We don't use (interactive-p), since that breaks kbd macros.
4247 "A subroutine of `squeeze-bidi-context'.
4248 FROM and TO should be markers, CATEGORY and REPLACEMENT should be strings."
4252 lim1)
4259 ;; L and R categories include embedding and
4260 ;; override controls, but we don't want to
4261 ;; replace them, because that might change
4262 ;; the visual order. Likewise with PDF and
4263 ;; isolate controls.
4265 bidi-directional-non-controls-chars
4266 limit)))))
4267 ;; Replace any run of non-RTL characters by a single LRM.
4269 ;; No more characters of CATEGORY, we are done.
4274 ;; Skip directional controls, if any.
4279 "Replace characters between FROM and TO while keeping bidi context.
4281 This function replaces the region of text with as few characters
4282 as possible, while preserving the effect that region will have on
4283 bidirectional display before and after the region."
4287 ;; This is for when they copy text with read-only text
4288 ;; properties.
4292 ;; Replace each run of non-RTL characters with a single LRM.
4294 ;; Replace each run of non-LTR characters with a single RLM. Note
4295 ;; that the \cR category includes both the Arabic Letter (AL) and
4296 ;; R characters; here we ignore the distinction between them,
4297 ;; because that distinction only affects Arabic Number (AN)
4298 ;; characters, which are weak and don't affect the reordering.
4302 "Return buffer text between START and END with its bidi context.
4304 START and END are assumed to belong to the same physical line
4305 of buffer text. This function prepends and appends to the text
4306 between START and END bidi control characters that preserve the
4307 visual order of that text when it is inserted at some other place."
4312 substr para-dir from to)
4319 ;; If we don't have any mixed directional characters in the
4320 ;; entire line, we can just copy the substring without adding
4321 ;; any context.
4336 ;; Wrap the string in LRI/RLI..PDI pair to achieve 2 effects:
4337 ;; (1) force the string to have the same base embedding
4338 ;; direction as the paragraph direction at the source, no matter
4339 ;; what is the paragraph direction at destination; and (2) avoid
4340 ;; affecting the visual order of the surrounding text at
4341 ;; destination if there are characters of different
4342 ;; directionality there.
4347 "Return portion of current buffer between START and END with bidi context.
4349 This function works similar to `buffer-substring', but it prepends and
4350 appends to the text bidi directional control characters necessary to
4351 preserve the visual appearance of the text if it is inserted at another
4352 place. This is useful when the buffer substring includes bidirectional
4353 text and control characters that cause non-trivial reordering on display.
4354 If copied verbatim, such text can have a very different visual appearance,
4355 and can also change the visual appearance of the surrounding text at the
4356 destination of the copy.
4358 Optional argument NO-PROPERTIES, if non-nil, means copy the text without
4359 the text properties."
4372 no-properties)))
4376 substr)))
4377 \f
4378 ;; Yanking.
4383 "List of special text property handling conditions for yanking.
4384 Each element should have the form (PROP . FUN), where PROP is a
4385 property symbol and FUN is a function. When the `yank' command
4386 inserts text into the buffer, it scans the inserted text for
4387 stretches of text that have `eq' values of the text property
4388 PROP; for each such stretch of text, FUN is called with three
4389 arguments: the property's value in that text, and the start and
4390 end positions of the text.
4392 This is done prior to removing the properties specified by
4393 `yank-excluded-properties'."
4396 function))
4399 ;; This is actually used in subr.el but defcustom does not work there.
4402 intangible invisible keymap local-map mouse-face read-only
4403 yank-handler)
4404 "Text properties to discard when yanking.
4405 The value should be a list of text properties to discard or t,
4406 which means to discard all text properties.
4408 See also `yank-handled-properties'."
4415 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
4416 Function is called with two parameters, START and END corresponding to
4417 the value of the mark and point; it is guaranteed that START <= END.
4421 "Replace just-yanked stretch of killed text with a different stretch.
4422 This command is allowed only immediately after a `yank' or a `yank-pop'.
4423 At such a time, the region contains a stretch of reinserted
4424 previously-killed text. `yank-pop' deletes that text and inserts in its
4425 place a different stretch of killed text.
4427 With no argument, the previous kill is inserted.
4428 With argument N, insert the Nth previous kill.
4429 If N is negative, this is a more recent kill.
4431 The sequence of kills wraps around, so that after the oldest one
4432 comes the newest one.
4434 When this command inserts killed text into the buffer, it honors
4435 `yank-excluded-properties' and `yank-handler' as described in the
4436 doc string for `insert-for-yank-1', which see."
4450 ;; Set the window start back where it was in the yank command,
4451 ;; if possible.
4454 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4455 ;; It is cleaner to avoid activation, even though the command
4456 ;; loop would deactivate the mark because we inserted text.
4459 nil)
4463 More precisely, reinsert the most recent kill, which is the
4464 stretch of killed text most recently killed OR yanked. Put point
4465 at the end, and set mark at the beginning without activating it.
4467 With argument N, reinsert the Nth most recent kill.
4469 When this command inserts text into the buffer, it honors the
4470 `yank-handled-properties' and `yank-excluded-properties'
4471 variables, and the `yank-handler' text property. See
4472 `insert-for-yank-1' for details.
4477 ;; If we don't get all the way thru, make last-command indicate that
4478 ;; for the following command.
4486 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
4487 ;; It is cleaner to avoid activation, even though the command
4488 ;; loop would deactivate the mark because we inserted text.
4491 ;; If we do get all the way thru, make this-command indicate that.
4494 nil)
4497 "Rotate the yanking point in the kill ring.
4498 With ARG, rotate that many kills forward (or backward, if negative)."
4501 \f
4502 ;; Some kill commands.
4504 ;; Internal subroutine of delete-char
4510 ;; Internal subroutine of backward-delete-char
4517 "The method for untabifying when deleting backward.
4518 Can be `untabify' -- turn a tab to many spaces, then delete one space;
4519 `hungry' -- delete all whitespace, both tabs and spaces;
4520 `all' -- delete all whitespace, including tabs, spaces and newlines;
4521 nil -- just delete one character."
4527 "Delete characters backward, changing tabs into spaces.
4528 The exact behavior depends on `backward-delete-char-untabify-method'.
4529 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
4530 Interactively, ARG is the prefix arg (default 1)
4531 and KILLP is t if a prefix arg was specified."
4554 arg)))
4555 ;; Avoid warning about delete-backward-char
4559 "Kill up to and including ARGth occurrence of CHAR.
4560 Case is ignored if `case-fold-search' is non-nil in the current buffer.
4561 Goes backward if ARG is negative; error if CHAR not found."
4564 ;; Avoid "obsolete" warnings for translation-table-for-input.
4572 ;; kill-line and its subroutines.
4575 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
4580 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
4581 With prefix argument ARG, kill that many lines from point.
4582 Negative arguments kill lines backward.
4583 With zero argument, kills the text before point on the current line.
4586 a number counts as a prefix arg.
4588 To kill a whole line, when point is not at the beginning, type \
4591 If `show-trailing-whitespace' is non-nil, this command will just
4592 kill the rest of the current line, even if there are only
4593 nonblanks there.
4595 If option `kill-whole-line' is non-nil, then this command kills the whole line
4596 including its terminating newline, when used at the beginning of a line
4597 with no argument. As a consequence, you can always kill a whole line
4600 If you want to append the killed line to the last killed text,
4603 If the buffer is read-only, Emacs will beep and refrain from deleting
4604 the line, but put the line in the kill ring anyway. This means that
4605 you can use this command to copy text from a read-only buffer.
4606 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4607 even beep.)"
4610 ;; It is better to move point to the other end of the kill
4611 ;; before killing. That way, in a read-only buffer, point
4612 ;; moves across the text that is copied to the kill ring.
4613 ;; The choice has no effect on undo now that undo records
4614 ;; the value of point from before the command was run.
4624 ;; If trailing whitespace is visible,
4625 ;; don't treat it as nothing.
4635 "Kill current line.
4636 With prefix ARG, kill that many lines starting from the current line.
4637 If ARG is negative, kill backward. Also kill the preceding newline.
4639 If ARG is zero, kill current line but exclude the trailing newline."
4650 ;; We need to kill in two steps, because the previous command
4651 ;; could have been a kill command, in which case the text
4652 ;; before point needs to be prepended to the current kill
4653 ;; ring entry and the text after point appended. Also, we
4654 ;; need to use save-excursion to avoid copying the same text
4655 ;; twice to the kill ring in read-only buffers.
4673 "Move forward by ARG lines, ignoring currently invisible newlines only.
4674 If ARG is negative, move backward -ARG lines.
4675 If ARG is zero, move to the beginning of the current line."
4682 ;; If the newline we just skipped is invisible,
4683 ;; don't count it.
4687 prop
4692 ;; If invisible text follows, and it is a number of complete lines,
4693 ;; skip it.
4699 prop
4715 ;; If the newline we just moved to is invisible,
4716 ;; don't count it.
4721 prop
4726 ;; If invisible text follows, and it is a number of complete lines,
4727 ;; skip it.
4733 prop
4744 nil)))
4747 "Move to end of current visible line."
4749 ;; If the following character is currently invisible,
4750 ;; skip all characters with that same `invisible' property value,
4751 ;; then find the next newline.
4758 prop
4767 \f
4769 "Insert after point the contents of BUFFER.
4770 Puts mark after the inserted text.
4771 BUFFER may be a buffer or a buffer name."
4781 t))))
4786 nil)
4789 "Append to specified buffer the text of the region.
4790 It is inserted into that buffer before its point.
4792 When calling from a program, give three arguments:
4793 BUFFER (or buffer name), START and END.
4794 START and END specify the portion of the current buffer to be copied."
4801 point)
4812 "Prepend to specified buffer the text of the region.
4813 It is inserted into that buffer after its point.
4815 When calling from a program, give three arguments:
4816 BUFFER (or buffer name), START and END.
4817 START and END specify the portion of the current buffer to be copied."
4826 "Copy to specified buffer the text of the region.
4827 It is inserted into that buffer, replacing existing text there.
4829 When calling from a program, give three arguments:
4830 BUFFER (or buffer name), START and END.
4831 START and END specify the portion of the current buffer to be copied."
4839 \f
4843 "Hook run when the mark becomes active.
4844 It is also run at the end of a command, if the mark is active and
4851 "Return this buffer's mark value as integer, or nil if never set.
4853 In Transient Mark mode, this function signals an error if
4854 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4855 or the argument FORCE is non-nil, it disregards whether the mark
4856 is active, and returns an integer or nil in the usual way.
4858 If you are using this in an editing command, you are most likely making
4859 a mistake; see the documentation of `set-mark'."
4864 ;; Behind display-selections-p.
4867 "Deactivate the mark.
4868 If Transient Mark mode is disabled, this function normally does
4869 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4871 Deactivating the mark sets `mark-active' to nil, updates the
4872 primary selection according to `select-active-regions', and runs
4873 `deactivate-mark-hook'.
4875 If Transient Mark mode was temporarily enabled, reset the value
4876 of the variable `transient-mark-mode'; if this causes Transient
4877 Mark mode to be disabled, don't change `mark-active' to nil or
4878 run `deactivate-mark-hook'."
4882 select-active-regions)
4885 ;; The var `saved-region-selection', if non-nil, is the text in
4886 ;; the region prior to the last command modifying the buffer.
4887 ;; Set the selection to that, or to the current region.
4892 ;; If another program has acquired the selection, region
4893 ;; deactivation should not clobber it (Bug#11772).
4912 "Activate the mark.
4913 If NO-TMM is non-nil, leave `transient-mark-mode' alone."
4923 "Set this buffer's mark to POS. Don't use this function!
4924 That is to say, don't use this function unless you want
4925 the user to see that the mark has moved, and you want the previous
4926 mark position to be lost.
4928 Normally, when a new mark is set, the old one should go on the stack.
4929 This is why most applications should use `push-mark', not `set-mark'.
4931 Novice Emacs Lisp programmers often try to use the mark for the wrong
4932 purposes. The mark saves a location for the user's convenience.
4933 Most editing commands should not alter the mark.
4934 To remember a location for internal use in the Lisp program,
4935 store it in a Lisp variable. Example:
4937 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4942 ;; Normally we never clear mark-active except in Transient Mark mode.
4943 ;; But when we actually clear out the mark value too, we must
4944 ;; clear mark-active in any mode.
4946 ;; `deactivate-mark' sometimes leaves mark-active non-nil, but
4947 ;; it should never be nil if the mark is nil.
4955 mark-active))
4962 ;; Mark marker
4968 ;; Mark active
4971 ;; If mark is active now, and either was not active or was at a
4972 ;; different place, run the activate hook.
4977 ;; If mark has ceased to be active, run deactivate hook.
4982 "Like `save-excursion', but also save and restore the mark state.
4983 This macro does what `save-excursion' did before Emacs 25.1."
4992 If nil, region-aware commands treat empty regions as inactive.
4993 If non-nil, region-aware commands treat the region as active as
4994 long as the mark is active, even if the region is empty.
4996 Region-aware commands are those that act on the region if it is
4997 active and Transient Mark mode is enabled, and on the text near
4998 point otherwise."
5004 "Return t if the region is active and it is appropriate to act on it.
5005 This is used by commands that act specially on the region under
5006 Transient Mark mode.
5008 The return value is t if Transient Mark mode is enabled and the
5009 mark is active; furthermore, if `use-empty-active-region' is nil,
5010 the region must not be empty. Otherwise, the return value is nil.
5012 For some commands, it may be appropriate to ignore the value of
5013 `use-empty-active-region'; in that case, use `region-active-p'."
5018 "Return non-nil if Transient Mark mode is enabled and the mark is active.
5020 Some commands act specially on the region when Transient Mark
5021 mode is enabled. Usually, such commands should use
5022 `use-region-p' instead of this function, because `use-region-p'
5023 also checks the value of `use-empty-active-region'."
5025 ;; FIXME: Somehow we sometimes end up with mark-active non-nil but
5026 ;; without the mark being set (e.g. bug#17324). We really should fix
5027 ;; that problem, but in the mean time, let's make sure we don't say the
5028 ;; region is active when there's no mark.
5042 ;; Normal priority so that a large region doesn't hide all the
5043 ;; overlays within it, but high secondary priority so that if it
5044 ;; ends/starts in the middle of a small overlay, that small overlay
5045 ;; won't hide the region's boundaries.
5047 nrol)
5052 rol)))
5068 start end window rol)))
5071 new))))))
5074 "Hook run just before redisplay.
5075 It is called in each window that is to be redisplayed. It takes one argument,
5076 which is the window that will be redisplayed. When run, the `current-buffer'
5097 "Maximum size of mark ring. Start discarding off end if gets this big."
5105 "Maximum size of global mark ring. \
5106 Start discarding off end if gets this big."
5111 "Jump to mark, and pop a new position for mark off the ring.
5112 \(Does not affect global mark ring)."
5122 "Set mark at where point is.
5123 If no prefix ARG and mark is already set there, just activate it.
5124 Display `Mark set' unless the optional second arg NOMSG is non-nil."
5136 will pop the mark twice, and
5138 will pop the mark three times.
5146 "Set the mark where point is, or jump to the mark.
5147 Setting the mark also alters the region, which is the text
5148 between point and mark; this is the closest equivalent in
5151 With no prefix argument, set the mark at point, and push the
5152 old mark position on local mark ring. Also push the old mark on
5153 global mark ring, if the previous mark was set in another buffer.
5155 When Transient Mark Mode is off, immediately repeating this
5156 command activates `transient-mark-mode' temporarily.
5159 jump to the mark, and set the mark from
5160 position popped off the local mark ring (this does not affect the global
5162 mark ring (see `pop-global-mark').
5164 If `set-mark-command-repeat-pop' is non-nil, repeating
5166 off the local (or global) mark ring and jumps there.
5169 argument, unconditionally set mark where point is, even if
5170 `set-mark-command-repeat-pop' is non-nil.
5172 Novice Emacs Lisp programmers often try to use the mark for the wrong
5173 purposes. See the documentation of `set-mark' for more information."
5193 arg)
5207 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
5208 If the last global mark pushed was not in the current buffer,
5209 also push LOCATION on the global mark ring.
5210 Display `Mark set' unless the optional second arg NOMSG is non-nil.
5212 Novice Emacs Lisp programmers often try to use the mark for the wrong
5213 purposes. See the documentation of `set-mark' for more information.
5215 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
5222 ;; Now push the mark on the global mark ring.
5225 ;; The last global mark pushed was in this same buffer.
5226 ;; Don't push another one.
5227 nil
5236 nil)
5239 "Pop off mark ring into the buffer's actual mark.
5240 Does not set point. Does nothing if mark ring is empty."
5252 "Put the mark where point is now, and point where the mark is now.
5253 This command works even when the mark is not active,
5254 and it reactivates the mark.
5256 If Transient Mark mode is on, a prefix ARG deactivates the mark
5257 if it is active, and otherwise avoids reactivating it. If
5258 Transient Mark mode is off, a prefix ARG enables Transient Mark
5259 mode temporarily."
5273 nil))
5276 "When non-nil, shifted motion keys activate the mark momentarily.
5278 While the mark is activated in this way, any shift-translated point
5279 motion key extends the region, and if Transient Mark mode was off, it
5280 is temporarily turned on. Furthermore, the mark will be deactivated
5281 by any subsequent point motion key that was not shift-translated, or
5282 by any action that normally deactivates the mark in Transient Mark mode.
5284 See `this-command-keys-shift-translated' for the meaning of
5285 shift-translation."
5290 "Activate/deactivate mark depending on invocation thru shift translation.
5291 This function is called by `call-interactively' when a command
5292 with a `^' character in its `interactive' spec is invoked, before
5293 running the command itself.
5295 If `shift-select-mode' is enabled and the command was invoked
5296 through shift translation, set the mark and activate the region
5297 temporarily, unless it was already set in this way. See
5298 `this-command-keys-shift-translated' for the meaning of shift
5299 translation.
5301 Otherwise, if the region has been activated temporarily,
5302 deactivate it, and restore the variable `transient-mark-mode' to
5303 its earlier value."
5310 transient-mark-mode)))
5319 "Toggle Transient Mark mode.
5320 With a prefix argument ARG, enable Transient Mark mode if ARG is
5321 positive, and disable it otherwise. If called from Lisp, enable
5322 Transient Mark mode if ARG is omitted or nil.
5324 Transient Mark mode is a global minor mode. When enabled, the
5325 region is highlighted with the `region' face whenever the mark
5327 and after certain other operations that set the mark but whose
5328 main purpose is something else--for example, incremental search,
5334 Many commands change their behavior when Transient Mark mode is
5335 in effect and the mark is active, by acting on the region instead
5336 of their usual default part of the buffer's text. Examples of
5339 To see the documentation of commands which are sensitive to the
5342 :global t
5343 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
5347 "Non-nil means it is ok for commands to call `widen' when they want to.
5348 Some commands will do this in order to go to positions outside
5349 the current accessible part of the buffer.
5351 If `widen-automatically' is nil, these commands will do something else
5355 "Whether the currently executing code is performing an essential task.
5356 This variable should be non-nil only when running code which should not
5357 disturb the user. E.g. it can be used to prevent Tramp from prompting the
5358 user for a password when we are simply scanning a set of files in the
5359 background or displaying possible completions before the user even asked
5363 "Pop off global mark ring and jump to the top location."
5365 ;; Pop entries which refer to non-existent buffers.
5383 \f
5385 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
5391 "Move cursor vertically down ARG lines.
5392 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5393 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5394 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5395 function will not vscroll.
5397 ARG defaults to 1.
5399 If there is no character in the target line exactly under the current column,
5400 the cursor is positioned after the character in that line which spans this
5401 column, or at the end of the line if it is not long enough.
5402 If there is no line in the buffer after this one, behavior depends on the
5403 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
5404 to create a line, and moves the cursor to that line. Otherwise it moves the
5405 cursor to the end of the buffer.
5407 If the variable `line-move-visual' is non-nil, this command moves
5408 by display lines. Otherwise, it moves by buffer lines, without
5409 taking variable-width characters or continued lines into account.
5412 a semipermanent goal column for this command.
5413 Then instead of trying to move exactly vertically (or as close as possible),
5414 this command moves to the specified goal column (or as close as possible).
5415 The goal column is stored in the variable `goal-column', which is nil
5416 when there is no goal column. Note that setting `goal-column'
5417 overrides `line-move-visual' and causes this command to move by buffer
5418 lines rather than by display lines."
5424 ;; When adding a newline, don't expand an abbrev.
5435 nil)
5438 "Move cursor vertically up ARG lines.
5439 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
5440 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
5441 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
5442 function will not vscroll.
5444 ARG defaults to 1.
5446 If there is no character in the target line exactly over the current column,
5447 the cursor is positioned after the character in that line which spans this
5448 column, or at the end of the line if it is not long enough.
5450 If the variable `line-move-visual' is non-nil, this command moves
5451 by display lines. Otherwise, it moves by buffer lines, without
5452 taking variable-width characters or continued lines into account.
5455 a semipermanent goal column for this command.
5456 Then instead of trying to move exactly vertically (or as close as possible),
5457 this command moves to the specified goal column (or as close as possible).
5458 The goal column is stored in the variable `goal-column', which is nil
5459 when there is no goal column. Note that setting `goal-column'
5460 overrides `line-move-visual' and causes this command to move by buffer
5461 lines rather than by display lines."
5472 nil)
5475 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
5476 This means moving to the end of each line moved onto.
5477 The beginning of a blank line does not count as the end of a line.
5478 This has no effect when the variable `line-move-visual' is non-nil."
5484 A non-nil setting overrides the variable `line-move-visual', which see."
5491 "Current goal column for vertical motion.
5492 It is the column where point was at the start of the current run
5493 of vertical motion commands.
5495 When moving by visual lines via the function `line-move-visual', it is a cons
5496 cell (COL . HSCROLL), where COL is the x-position, in pixels,
5497 divided by the default column width, and HSCROLL is the number of
5498 columns by which window is scrolled from left margin.
5500 When the `track-eol' feature is doing its job, the value is
5504 "Non-nil means commands that move by lines ignore invisible newlines.
5505 When this option is non-nil, \\[next-line], \\[previous-line], \\[move-end-of-line], and \\[move-beginning-of-line] behave
5506 as if newlines that are invisible didn't exist, and count
5507 only visible newlines. Thus, moving across across 2 newlines
5508 one of which is invisible will be counted as a one-line move.
5509 Also, a non-nil value causes invisible text to be ignored when
5510 counting columns for the purposes of keeping point in the same
5513 Outline mode sets this."
5518 "When non-nil, `line-move' moves point by visual lines.
5519 This movement is based on where the cursor is displayed on the
5520 screen, instead of relying on buffer contents alone. It takes
5521 into account variable-width characters and line continuation.
5522 If nil, `line-move' moves point by logical lines.
5523 A non-nil setting of `goal-column' overrides the value of this variable
5524 and forces movement by logical lines.
5525 A window that is horizontally scrolled also forces movement by logical
5526 lines."
5531 ;; Only used if display-graphic-p.
5535 "Return the height in pixels of the current buffer's default face font.
5537 If the default font is remapped (see `face-remapping-alist'), the
5538 function returns the height of the remapped face."
5542 ;; Avoid calling font-info if the frame's default font was
5543 ;; not changed since the frame was created. That's because
5544 ;; font-info is expensive for some fonts, see bug #14838.
5550 "Return the width in pixels of the current buffer's default face font.
5552 If the default font is remapped (see `face-remapping-alist'), the
5553 function returns the width of the remapped face."
5557 ;; Avoid calling font-info if the frame's default font was
5558 ;; not changed since the frame was created. That's because
5559 ;; font-info is expensive for some fonts, see bug #14838.
5564 width
5569 "Return the pixel height of current buffer's default-face text line.
5571 The value includes `line-spacing', if any, defined for the buffer
5572 or the frame."
5585 "Return the number of screen lines in the text area of the selected window.
5587 This is different from `window-text-height' in that this function counts
5588 lines in units of the height of the font used by the default face displayed
5589 in the window, not in units of the frame's default font, and also accounts
5590 for `line-spacing', if any, defined for the window's buffer or frame.
5592 The value is a floating-point number."
5597 ;; Returns non-nil if partial move was done.
5600 ;; Move backward (up).
5601 ;; If already vscrolled, reduce vscroll
5607 ;; Move forward (down).
5620 py vs last-line)
5640 col-row)
5645 ;; VPOS > 0 means the last line is only partially visible.
5646 ;; But if the part that is visible is at least as tall as the
5647 ;; default font, that means the line is actually fully
5648 ;; readable, and something like line-spacing is hidden. So in
5649 ;; that case we accept the last line in the window as still
5650 ;; visible, and consider the margin as starting one line
5651 ;; later.
5659 ;; If last line of window is fully visible, and vscrolling
5660 ;; more would make this line invisible, move forward.
5665 nil)
5666 ;; If cursor is not in the bottom scroll margin, and the
5667 ;; current line is is not too tall, move forward.
5669 vpos
5672 nil)
5673 ;; When already vscrolled, we vscroll some more if we can,
5674 ;; or clear vscroll and move forward at end of tall image.
5679 ;; If cursor just entered the bottom scroll margin, move forward,
5680 ;; but also optionally vscroll one line so redisplay won't recenter.
5684 ;; Don't vscroll if the partially-visible line at window
5685 ;; bottom is not too tall (a.k.a. "just one more text
5686 ;; line"): in that case, we do want redisplay to behave
5687 ;; normally, i.e. recenter or whatever.
5688 ;;
5689 ;; Note: ROWH + RBOT from the value returned by
5690 ;; pos-visible-in-window-p give the total height of the
5691 ;; partially-visible glyph row at the end of the window. As
5692 ;; we are dealing with floats, we disregard sub-pixel
5693 ;; discrepancies between that and DLH.
5697 t)
5698 ;; If there are lines above the last line, scroll-up one line.
5701 t)
5702 ;; Finally, start vscroll.
5707 ;; This is like line-move-1 except that it also performs
5708 ;; vertical scrolling of tall images if appropriate.
5709 ;; That is not really a clean thing to do, since it mixes
5710 ;; scrolling with cursor motion. But so far we don't have
5711 ;; a cleaner solution to the problem of making C-n do something
5712 ;; useful given a tall image.
5714 "Move forward ARG lines.
5715 If NOERROR, don't signal an error if we can't move ARG lines.
5716 TO-END is unused.
5717 TRY-VSCROLL controls whether to vscroll tall lines: if either
5718 `auto-window-vscroll' or TRY-VSCROLL is nil, this function will
5719 not vscroll."
5723 ;; Only vscroll for single line moves
5725 ;; Under scroll-conservatively, the display engine
5726 ;; does this better.
5728 ;; But don't vscroll in a keyboard macro.
5734 ;; Display-based column are incompatible with goal-column.
5736 ;; When the text in the window is scrolled to the left,
5737 ;; display-based motion doesn't make sense (because each
5738 ;; logical line occupies exactly one screen line).
5740 ;; Likewise when the text _was_ scrolled to the left
5741 ;; when the current run of vertical motion commands
5742 ;; started.
5745 auto-hscroll-mode
5747 (>= temporary-goal-column
5750 ;; If we moved into a tall line, set vscroll to make
5751 ;; scrolling through tall images more smooth.
5755 winh)
5761 nil
5765 ;; Display-based alternative to line-move-1.
5766 ;; Arg says how many lines to move. The value is t if we can move the
5767 ;; specified number of lines.
5769 "Move ARG lines forward.
5770 If NOERROR, don't signal an error if we can't move that many lines."
5773 target-hscroll)
5774 ;; Check if the previous command was a line-motion command, or if
5775 ;; we were called from some other command.
5778 ;; If so, there's no need to reset `temporary-goal-column',
5779 ;; but we may need to hscroll.
5783 ;; Otherwise, we should reset `temporary-goal-column'.
5785 x-pos)
5787 ;; Handle the `overflow-newline-into-fringe' case:
5792 ;; In R2L lines, the X pixel coordinate is measured from the
5793 ;; left edge of the window, but columns are still counted
5794 ;; from the logical-order beginning of the line, i.e. from
5795 ;; the right edge in this case. We need to adjust for that.
5801 hscroll))))))
5804 ;; vertical-motion can move more than it was asked to if it moves
5805 ;; across display strings with newlines. We don't want to ring
5806 ;; the bell and announce beginning/end of buffer in that case.
5812 temporary-goal-column))
5813 arg))
5814 arg))
5820 temporary-goal-column))
5821 arg))
5822 arg)))
5825 ;; If the goal column lies on a display string,
5826 ;; `vertical-motion' advances the cursor to the end
5827 ;; of the string. For arg < 0, this can cause the
5828 ;; cursor to get stuck. (Bug#3020).
5832 nil)))))
5834 ;; This is the guts of next-line and previous-line.
5835 ;; Arg says how many lines to move.
5836 ;; The value is t if we can move the specified number of lines.
5838 ;; Don't run any point-motion hooks, and disregard intangibility,
5839 ;; for intermediate positions.
5851 ;; Don't count beg of empty line as end of line
5852 ;; unless we just did explicit end-of-line.
5854 most-positive-fixnum
5858 line-move-ignore-invisible))
5859 ;; Use just newline characters.
5860 ;; Set ARG to 0 if we move as many lines as requested.
5863 ;; This way of moving forward ARG lines
5864 ;; verifies that we have a newline after the last one.
5865 ;; It doesn't get confused by intangible text.
5874 'beginning-of-buffer
5876 nil)))
5877 ;; Move by arg lines, but ignore invisible ones.
5880 ;; If the following character is currently invisible,
5881 ;; skip all characters with that same `invisible' property value.
5884 ;; Move a line.
5885 ;; We don't use `end-of-line', since we want to escape
5886 ;; from field boundaries occurring exactly at point.
5892 ;; If there's no invisibility here, move over the newline.
5901 ;; We avoid vertical-motion when possible
5902 ;; because that has to fontify.
5904 ;; Otherwise move a more sophisticated way.
5911 ;; The logic of this is the same as the loop above,
5912 ;; it just goes in the other direction.
5914 ;; For completely consistency with the forward-motion
5915 ;; case, we should call beginning-of-line here.
5916 ;; However, if point is inside a field and on a
5917 ;; continued line, the call to (vertical-motion -1)
5918 ;; below won't move us back far enough; then we return
5919 ;; to the same column in line-move-finish, and point
5920 ;; gets stuck -- cyd
5938 ;; if our target is the middle of this line.
5943 ;; This is the value the function returns.
5947 ;; If we did not move down as far as desired, at least go
5948 ;; to end of line. Be sure to call point-entered and
5949 ;; point-left-hooks.
5955 ;; If we did not move up as far as desired,
5956 ;; at least go to beginning of line.
5968 ;; Set REPEAT to t to repeat the whole thing.
5975 ;; Compute the end of the line
5976 ;; ignoring effectively invisible newlines.
5978 ;; Like end-of-line but ignores fields.
5985 ;; Move to the desired column.
5988 ;; Corner case: suppose we start out in a field boundary in
5989 ;; the middle of a continued line. When we get to
5990 ;; line-move-finish, point is at the start of a new *screen*
5991 ;; line but the same text line; then line-move-to-column would
5992 ;; move us backwards. Test using C-n with point on the "x" in
5993 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
6000 ;; Process intangibility within a line.
6001 ;; With inhibit-point-motion-hooks bound to nil, a call to
6002 ;; goto-char moves point past intangible text.
6004 ;; However, inhibit-point-motion-hooks controls both the
6005 ;; intangibility and the point-entered/point-left hooks. The
6006 ;; following hack avoids calling the point-* hooks
6007 ;; unnecessarily. Note that we move *forward* past intangible
6008 ;; text when the initial and final points are the same.
6013 ;; If intangibility moves us to a different (later) place
6014 ;; in the same line, use that as the destination.
6017 ;; If that position is "too late",
6018 ;; try the previous allowable position.
6019 ;; See if it is ok.
6022 ;; If going forward, don't accept the previous
6023 ;; allowable position if it is before the target line.
6025 ;; If going backward, don't accept the previous
6026 ;; allowable position if it is still after the target line.
6029 ;; As a last resort, use the end of the line.
6032 ;; Now move to the updated destination, processing fields
6033 ;; as well as intangibility.
6037 ;; Ignore field boundaries if the initial and final
6038 ;; positions have the same `field' property, even if the
6039 ;; fields are non-contiguous. This seems to be "nicer"
6040 ;; behavior in many situations.
6043 new
6047 ;; If all this moved us to a different line,
6048 ;; retry everything within that new line.
6050 ;; Repeat the intangibility and field processing.
6054 "Try to find column COL, considering invisibility.
6055 This function works only in certain cases,
6056 because what we really need is for `move-to-column'
6057 and `current-column' to be able to ignore invisible text."
6066 ;; If the following character is currently invisible,
6067 ;; skip all characters with that same `invisible' property value.
6071 ;; Have we advanced to a larger column position?
6073 ;; We have made some progress towards the desired column.
6074 ;; See if we can make any further progress.
6076 ;; Otherwise, go to the place we originally found
6077 ;; and move back over invisible text.
6078 ;; that will get us to the same place on the screen
6079 ;; but with a more reasonable buffer position.
6082 ;; We want the real line beginning, so it's consistent
6083 ;; with bolp below, otherwise we might infloop.
6090 "Move point to end of current line as displayed.
6091 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6092 If point reaches the beginning or end of buffer, it stops there.
6094 To ignore the effects of the `intangible' text or overlay
6095 property, bind `inhibit-point-motion-hooks' to t.
6096 If there is an image in the current line, this function
6097 disregards newlines that are part of the text on which the image
6098 rests."
6108 ;; With bidi reordering, we may not be at bol,
6109 ;; so make sure we are.
6124 ;; If we skipped something intangible and now we're not
6125 ;; really at eol, keep going.
6130 "Move point to beginning of current line as displayed.
6131 \(If there's an image in the line, this disregards newlines
6132 which are part of the text that the image rests on.)
6134 With argument ARG not nil or 1, move forward ARG - 1 lines first.
6135 If point reaches the beginning or end of buffer, it stops there.
6136 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6141 first-vis first-vis-field-value)
6143 ;; Move by lines, if ARG is not 1 (the default).
6148 ;; Move to beginning-of-line, ignoring fields and invisible text.
6154 ;; Now find first visible char in the line.
6159 ;; See if fields would stop us from reaching FIRST-VIS.
6164 ;; If yes, obey them.
6165 first-vis-field-value
6166 ;; Otherwise, move to START with attention to fields.
6167 ;; (It is possible that fields never matter in this case.)
6172 ;; Many people have said they rarely use this feature, and often type
6173 ;; it by accident. Maybe it shouldn't even be on a key.
6178 Those commands will move to this position in the line moved to
6179 rather than trying to keep the same horizontal position.
6180 With a non-nil argument ARG, clears out the goal column
6182 The goal column is stored in the variable `goal-column'."
6189 ;; The older method below can be erroneous if `set-goal-column' is bound
6190 ;; to a sequence containing %
6191 ;;(message (substitute-command-keys
6192 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
6193 ;;goal-column)
6200 )
6201 nil)
6202 \f
6203 ;;; Editing based on visual lines, as opposed to logical lines.
6206 "Move point to end of current visual line.
6207 With argument N not nil or 1, move forward N - 1 visual lines first.
6208 If point reaches the beginning or end of buffer, it stops there.
6209 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6215 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
6216 ;; constrain to field boundaries, so we don't either.
6220 "Move point to beginning of current visual line.
6221 With argument N not nil or 1, move forward N - 1 visual lines first.
6222 If point reaches the beginning or end of buffer, it stops there.
6223 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
6231 ;; Constrain to field boundaries, like `move-beginning-of-line'.
6235 "Kill the rest of the visual line.
6236 With prefix argument ARG, kill that many visual lines from point.
6237 If ARG is negative, kill visual lines backward.
6238 If ARG is zero, kill the text before point on the current visual
6239 line.
6241 If you want to append the killed line to the last killed text,
6244 If the buffer is read-only, Emacs will beep and refrain from deleting
6245 the line, but put the line in the kill ring anyway. This means that
6246 you can use this command to copy text from a read-only buffer.
6247 \(If the variable `kill-read-only-ok' is non-nil, then this won't
6248 even beep.)"
6250 ;; Like in `kill-line', it's better to move point to the other end
6251 ;; of the kill before killing.
6259 ;; Skip any trailing whitespace at the end of the visual line.
6260 ;; We used to do this only if `show-trailing-whitespace' is
6261 ;; nil, but that's wrong; the correct thing would be to check
6262 ;; whether the trailing whitespace is highlighted. But, it's
6263 ;; OK to just do this unconditionally.
6270 "Move cursor vertically down ARG lines.
6271 This is identical to `next-line', except that it always moves
6272 by logical lines instead of visual lines, ignoring the value of
6273 the variable `line-move-visual'."
6280 "Move cursor vertically up ARG lines.
6281 This is identical to `previous-line', except that it always moves
6282 by logical lines instead of visual lines, ignoring the value of
6283 the variable `line-move-visual'."
6290 "Editing based on visual lines."
6299 ;; These keybindings interfere with xterm function keys. Are
6300 ;; there any other suitable bindings?
6301 ;; (define-key map "\M-[" 'previous-logical-line)
6302 ;; (define-key map "\M-]" 'next-logical-line)
6303 map))
6306 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
6307 The value should be a list of the form (LEFT RIGHT), where LEFT
6308 and RIGHT are symbols representing the bitmaps to display, to
6309 indicate wrapped lines, in the left and right fringes respectively.
6310 See also `fringe-indicator-alist'.
6311 The default is not to display fringe indicators for wrapped lines.
6312 This variable does not affect fringe indicators displayed for
6313 other purposes."
6328 'continuation
6335 "Toggle visual line based editing (Visual Line mode).
6336 With a prefix argument ARG, enable Visual Line mode if ARG is
6337 positive, and disable it otherwise. If called from Lisp, enable
6338 the mode if ARG is omitted or nil.
6340 When Visual Line mode is enabled, `word-wrap' is turned on in
6341 this buffer, and simple editing commands are redefined to act on
6342 visual lines, not logical lines. See Info node `Visual Line
6343 Mode' for details."
6344 :keymap visual-line-mode-map
6350 ;; Save the local values of some variables, to be restored if
6351 ;; visual-line-mode is turned off.
6353 truncate-partial-width-windows
6354 word-wrap fringe-indicator-alist))
6357 visual-line--saved-state)))
6361 word-wrap t
6362 fringe-indicator-alist
6364 fringe-indicator-alist)))
6378 visual-line-mode turn-on-visual-line-mode)
6380 \f
6382 "Interchange characters around point, moving forward one character.
6383 With prefix arg ARG, effect is to take character before point
6384 and drag it forward past ARG other characters (backward if ARG negative).
6385 If no argument and at end of line, the previous two chars are exchanged."
6393 "Interchange words around point, leaving point at end of them.
6394 With prefix arg ARG, effect is to take word before or around point
6395 and drag it forward past ARG other words (backward if ARG negative).
6396 If ARG is zero, the words around or after point and around or after mark
6397 are interchanged."
6398 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
6404 Does not work on a sexp that point is in the middle of
6405 if it is a list or string."
6409 ;; Here we should try to simulate the behavior of
6410 ;; (cons (progn (forward-sexp x) (point))
6411 ;; (progn (forward-sexp (- x)) (point)))
6412 ;; Except that we don't want to rely on the second forward-sexp
6413 ;; putting us back to where we want to be, since forward-sexp-function
6414 ;; might do funny things like infix-precedence.
6419 ;; Jumping over a symbol. We might be inside it, mind you.
6424 ;; Otherwise, we're between sexps. Take a step back before jumping
6425 ;; to make sure we'll obey the same precedence no matter which direction
6426 ;; we're going.
6431 'skip-syntax-forward
6438 "Exchange current line and previous line, leaving point after both.
6439 With argument ARG, takes previous line and moves it past ARG lines.
6440 With argument 0, interchanges line point is in with line mark is in."
6446 ;; Move forward over ARG lines,
6447 ;; but create newlines if necessary.
6454 arg))
6456 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
6457 ;; which seems inconsistent with the ARG /= 0 case.
6458 ;; FIXME document SPECIAL.
6460 "Subroutine to do the work of transposing objects.
6461 Works for lines, sentences, paragraphs, etc. MOVER is a function that
6462 moves forward by units of the given object (e.g. forward-sentence,
6463 forward-paragraph). If ARG is zero, exchanges the current object
6464 with the one containing mark. If ARG is an integer, moves the
6465 current object past ARG following (if ARG is positive) or
6466 preceding (if ARG is negative) objects, leaving point after the
6467 current object."
6472 pos1 pos2)
6500 ;; This sequence of insertions attempts to preserve marker
6501 ;; positions at the start and end of the transposed objects.
6515 \f
6517 "Move backward until encountering the beginning of a word.
6518 With argument ARG, do this that many times.
6519 If ARG is omitted or nil, move point backward one word."
6524 "Set mark ARG words away from point.
6526 move to with the same argument.
6527 Interactively, if this command is repeated
6528 or (in Transient Mark mode) if the mark is active,
6529 it marks the next ARG words after the ones already marked."
6546 nil t))))
6549 "Kill characters forward until encountering the end of a word.
6550 With argument ARG, do this that many times."
6555 "Kill characters backward until encountering the beginning of a word.
6556 With argument ARG, do this that many times."
6561 "Return the symbol or word that point is on (or a nearby one) as a string.
6562 The return value includes no text properties.
6563 If optional arg STRICT is non-nil, return nil unless point is within
6564 or adjacent to a symbol or word. In all cases the value can be nil
6565 if there is no word nearby.
6566 The function, belying its name, normally finds a symbol.
6567 If optional arg REALLY-WORD is non-nil, it finds just a word."
6576 ;; Point is neither within nor adjacent to a word.
6578 ;; Look for preceding word in same line.
6581 ;; No preceding word in same line.
6582 ;; Look for following word in same line.
6591 ;; If we found something nonempty, return it as a string.
6594 \f
6596 "String for filling to insert at front of new line, or nil for none."
6598 string)
6604 "Regexp to match lines which should not be auto-filled."
6606 regexp)
6610 "The default value for `normal-auto-fill-function'.
6611 This is the default auto-fill function, some major modes use a different one.
6612 Returns t if it really did any work."
6622 nil ;; Auto-filling not required
6626 ;; Choose a fill-prefix automatically.
6634 ;; Use auto-indentation rather than a guessed empty prefix.
6640 ;; Determine where to split the line.
6653 ;; See whether the place we found is any good.
6657 ;; There is no use breaking at end of line.
6659 ;; It is futile to split at the end of the prefix
6660 ;; since we would just insert the prefix again.
6662 ;; Don't split right after a comment starter
6663 ;; since we would just make another comment starter.
6668 limit t)
6670 ;; No good place to break => stop trying.
6672 ;; Ok, we have a useful place to break the line. Do it.
6674 ;; If point is at the fill-point, do not `save-excursion'.
6675 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
6676 ;; point will end up before it rather than after it.
6684 ;; Now do justification, if required
6689 ;; If making the new line didn't reduce the hpos of
6690 ;; the end of the line, then give up now;
6691 ;; trying again will not help.
6694 ;; Justify last line.
6696 t)))
6699 "Mode-specific function which line breaks and continues a comment.
6700 This function is called during auto-filling when a comment syntax
6701 is defined.
6702 The function should take a single optional argument, which is a flag
6706 "Break line at point and indent.
6707 If a comment syntax is defined, call `comment-indent-new-line'.
6709 The inserted newline is marked hard if variable `use-hard-newlines' is true,
6710 unless optional argument SOFT is non-nil."
6714 ;; Insert the newline before removing empty space so that markers
6715 ;; get preserved better.
6721 ;; Blindly trust a non-adaptive fill-prefix.
6727 ;; If there's an adaptive prefix, use it unless we're inside
6728 ;; a comment and the prefix is not a comment starter.
6732 ;; If we're not inside a comment, just try to indent.
6736 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
6740 ;; `functions' and `hooks' are usually unsafe to set, but setting
6741 ;; auto-fill-function to nil in a file-local setting is safe and
6742 ;; can be useful to prevent auto-filling.
6746 "Toggle automatic line breaking (Auto Fill mode).
6747 With a prefix argument ARG, enable Auto Fill mode if ARG is
6748 positive, and disable it otherwise. If called from Lisp, enable
6749 the mode if ARG is omitted or nil.
6751 When Auto Fill mode is enabled, inserting a space at a column
6752 beyond `current-fill-column' automatically breaks the line at a
6753 previous space.
6755 When `auto-fill-mode' is on, the `auto-fill-function' variable is
6756 non-nil.
6758 The value of `normal-auto-fill-function' specifies the function to use
6759 for `auto-fill-function' when turning Auto Fill mode on."
6764 ;; This holds a document string used to document auto-fill-mode.
6766 "Automatically break line at a previous space, in insertion of text."
6767 nil)
6770 "Unconditionally turn on Auto Fill mode."
6774 "Unconditionally turn off Auto Fill mode."
6780 "Set `fill-column' to specified argument.
6785 ;; We used to use current-column silently, but C-x f is too easily
6786 ;; typed as a typo for C-x C-f, so we turned it into an error and
6787 ;; now an interactive prompt.
6792 ;; Disallow missing argument; it's probably a typo for C-x C-f.
6796 \f
6798 "Set `selective-display' to ARG; clear it if no arg.
6799 When the value of `selective-display' is a number > 0,
6800 lines whose indentation is >= that value are not displayed.
6801 The variable `selective-display' has a separate value for each buffer."
6821 "Toggle truncating of long lines for the current buffer.
6822 When truncating is off, long lines are folded.
6823 With prefix argument ARG, truncate long lines if ARG is positive,
6824 otherwise fold them. Note that in side-by-side windows, this
6825 command has no effect if `truncate-partial-width-windows' is
6826 non-nil."
6838 nil t)))
6843 "Toggle whether to use word-wrapping for continuation lines.
6844 With prefix argument ARG, wrap continuation lines at word boundaries
6845 if ARG is positive, otherwise wrap them at the right screen edge.
6846 This command toggles the value of `word-wrap'. It has no effect
6847 if long lines are truncated."
6863 "Toggle Overwrite mode.
6864 With a prefix argument ARG, enable Overwrite mode if ARG is
6865 positive, and disable it otherwise. If called from Lisp, enable
6866 the mode if ARG is omitted or nil.
6868 When Overwrite mode is enabled, printing characters typed in
6869 replace existing text on a one-for-one basis, rather than pushing
6870 it to the right. At the end of a line, such characters extend
6871 the line. Before a tab, such characters insert until the tab is
6873 overwrite mode; this is supposed to make it easier to insert
6874 characters when necessary."
6879 "Toggle Binary Overwrite mode.
6880 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6881 is positive, and disable it otherwise. If called from Lisp,
6882 enable the mode if ARG is omitted or nil.
6884 When Binary Overwrite mode is enabled, printing characters typed
6885 in replace existing text. Newlines are not treated specially, so
6886 typing at the end of a line joins the line to the next, with the
6887 typed character between them. Typing before a tab character
6888 simply replaces the tab with the character typed.
6890 ordinary typing characters do.
6892 Note that Binary Overwrite mode is not its own minor mode; it is
6893 a specialization of overwrite mode, entered by setting the
6894 `overwrite-mode' variable to `overwrite-mode-binary'."
6899 "Toggle line number display in the mode line (Line Number mode).
6900 With a prefix argument ARG, enable Line Number mode if ARG is
6901 positive, and disable it otherwise. If called from Lisp, enable
6902 the mode if ARG is omitted or nil.
6904 Line numbers do not appear for very large buffers and buffers
6905 with very long lines; see variables `line-number-display-limit'
6906 and `line-number-display-limit-width'."
6910 "Toggle column number display in the mode line (Column Number mode).
6911 With a prefix argument ARG, enable Column Number mode if ARG is
6912 positive, and disable it otherwise.
6914 If called from Lisp, enable the mode if ARG is omitted or nil."
6918 "Toggle buffer size display in the mode line (Size Indication mode).
6919 With a prefix argument ARG, enable Size Indication mode if ARG is
6920 positive, and disable it otherwise.
6922 If called from Lisp, enable the mode if ARG is omitted or nil."
6926 "Toggle auto-saving in the current buffer (Auto Save mode).
6927 With a prefix argument ARG, enable Auto Save mode if ARG is
6928 positive, and disable it otherwise.
6930 If called from Lisp, enable the mode if ARG is omitted or nil."
6932 ;; If auto-save is off because buffer has shrunk,
6933 ;; then toggling should turn it on.
6941 buffer-file-name)
6943 ;; If -1 was stored here, to temporarily turn off saving,
6944 ;; turn it back on.
6947 \f
6949 "Blinking matching of parens and expressions."
6954 "Non-nil means show matching open-paren when close-paren is inserted.
6955 If t, highlight the paren. If `jump', briefly move cursor to its
6956 position. If `jump-offscreen', move cursor there even if the
6957 position is off screen. With any other non-nil value, the
6958 off-screen position of the opening paren will be shown in the
6959 echo area."
6968 "Non-nil means show matching open-paren when it is on screen.
6969 If nil, don't show it (but the open-paren can still be shown
6970 in the echo area when it is off screen).
6972 This variable has no effect if `blink-matching-paren' is nil.
6973 \(In that case, the open-paren is never shown.)
6974 It is also ignored if `show-paren-mode' is enabled."
6979 "If non-nil, maximum distance to search backwards for matching open-paren.
6980 If nil, search stops at the beginning of the accessible portion of the buffer."
6986 "Time in seconds to delay after showing a matching paren."
6991 "If nil, `blink-matching-paren' ignores comments.
6992 More precisely, when looking for the matching parenthesis,
6993 it skips the contents of comments that end before point."
6998 "Return whether or not START...END are matching parens.
6999 END is the current point and START is the blink position.
7000 START might be nil if no matching starter was found.
7001 Returns non-nil if we find there is a mismatch."
7006 ;; For self-matched chars like " and $, we can't know when they're
7007 ;; mismatched or unmatched, so we can only do it for parens.
7012 ;; The cdr might hold a new paren-class info rather than
7013 ;; a matching-char info, in which case the two CDRs
7014 ;; should match.
7018 "Function to check parentheses mismatches.
7019 The function takes two arguments (START and END) where START is the
7020 position just before the opening token and END is the position right after.
7021 START can be nil, if it was not found.
7028 ol)
7032 "Momentarily highlight the beginning of the sexp before point."
7035 blink-matching-paren)
7045 oldpos))
7053 ;; backward-sexp skips backward over prefix chars,
7054 ;; so move back to the matching paren.
7077 ;; Matching open within window, temporarily move to or highlight
7078 ;; char after blinkpos but only if `blink-matching-paren-on-screen'
7079 ;; is non-nil.
7096 ;; Show what precedes the open in its line, if anything.
7101 ;; Show what follows the open in its line, if anything.
7108 ;; Otherwise show the previous nonblank line,
7109 ;; if there is one.
7118 ;; Replace the newline and other whitespace with `...'.
7119 "..."
7121 ;; There is nothing to show except the char itself.
7124 "Matches %s"
7128 "Function called, if non-nil, whenever a close parenthesis is inserted.
7134 blink-paren-function
7137 ;; Verify an even number of quoting characters precede the close.
7138 ;; FIXME: Also check if this parenthesis closes a comment as
7139 ;; can happen in Pascal and SML.
7150 ;; Most likely, this hook is nil, so this arg doesn't matter,
7151 ;; but I use it as a reminder that this function usually
7152 ;; likes to be run after others since it does
7153 ;; `sit-for'. That's also the reason it get a `priority' prop
7154 ;; of 100.
7156 \f
7157 ;; This executes C-g typed while Emacs is waiting for a command.
7158 ;; Quitting out of a program does not go through here;
7159 ;; that happens in the QUIT macro at the C code level.
7161 "Signal a `quit' condition.
7162 During execution of Lisp code, this character causes a quit directly.
7163 At top-level, as an editor command, this simply beeps."
7165 ;; Avoid adding the region to the window selection.
7173 ;; Force the next redisplay cycle to remove the "Def" indicator from
7174 ;; all the mode lines.
7188 This command can exit an interactive command such as `query-replace',
7189 can clear out a prefix argument or a region,
7190 can get out of the minibuffer or other recursive edit,
7191 cancel the use of the current buffer (for special-purpose buffers),
7192 or go back to just one window (by deleting all but the selected window)."
7200 nil)
7211 "Play sound stored in FILE.
7212 VOLUME and DEVICE correspond to the keywords of the sound
7213 specification for `play-sound'."
7223 \f
7225 "Your preference for a mail reading package.
7226 This is used by some keybindings which support reading mail.
7227 See also `mail-user-agent' concerning sending mail."
7237 "Your preference for a mail composition package.
7238 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
7239 outgoing email message. This variable lets you specify which
7240 mail-sending package you prefer.
7242 Valid values include:
7244 `message-user-agent' -- use the Message package.
7245 See Info node `(message)'.
7246 `sendmail-user-agent' -- use the Mail package.
7247 See Info node `(emacs)Sending Mail'.
7248 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
7249 See Info node `(mh-e)'.
7250 `gnus-user-agent' -- like `message-user-agent', but with Gnus
7251 paraphernalia if Gnus is running, particularly
7252 the Gcc: header for archiving.
7254 Additional valid symbols may be available; check with the author of
7255 your package for details. The function should return non-nil if it
7256 succeeds.
7258 See also `read-mail-command' concerning reading mail."
7261 message-user-agent)
7264 sendmail-user-agent)
7267 mh-e-user-agent)
7270 gnus-user-agent)
7276 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
7277 If the value of `mail-user-agent' is the default, and the user
7278 appears to have customizations applying to the old default,
7279 `compose-mail' issues a warning."
7285 "If the buffer starts with a mail header, move point to the header's end.
7286 Otherwise, moves to `point-min'.
7287 The end of the header is the start of the next line, if there is one,
7288 else the end of the last line. This function obeys RFC822."
7294 ;; Used by Rmail (e.g., rmail-forward).
7296 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
7300 switch-function yank-action send-actions
7301 return-action)
7302 "Start composing a mail message to send.
7303 This uses the user's chosen mail composition package
7304 as selected with the variable `mail-user-agent'.
7305 The optional arguments TO and SUBJECT specify recipients
7306 and the initial Subject field, respectively.
7308 OTHER-HEADERS is an alist specifying additional
7309 header fields. Elements look like (HEADER . VALUE) where both
7310 HEADER and VALUE are strings.
7312 CONTINUE, if non-nil, says to continue editing a message already
7313 being composed. Interactively, CONTINUE is the prefix argument.
7315 SWITCH-FUNCTION, if non-nil, is a function to use to
7316 switch to and display the buffer used for mail composition.
7318 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
7319 to insert the raw text of the message being replied to.
7320 It has the form (FUNCTION . ARGS). The user agent will apply
7321 FUNCTION to ARGS, to insert the raw text of the original message.
7322 \(The user agent will also run `mail-citation-hook', *after* the
7323 original text has been inserted in this way.)
7325 SEND-ACTIONS is a list of actions to call when the message is sent.
7326 Each action has the form (FUNCTION . ARGS).
7328 RETURN-ACTION, if non-nil, is an action for returning to the
7329 caller. It has the form (FUNCTION . ARGS). The function is
7330 called after the mail has been sent or put aside, and the mail
7331 buffer buried."
7335 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
7336 ;; from sendmail-user-agent to message-user-agent. Some users may
7337 ;; encounter incompatibilities. This hack tries to detect problems
7338 ;; and warn about them.
7343 mail-yank-hooks mail-archive-file-name
7344 mail-default-reply-to mail-mailing-lists
7345 mail-self-blind))
7352 The default mail mode is now Message mode.
7353 You have the following Mail mode variable%s customized:
7355 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
7362 yank-action send-actions return-action)))
7365 yank-action send-actions
7366 return-action)
7370 'switch-to-buffer-other-window yank-action send-actions
7371 return-action))
7374 yank-action send-actions
7375 return-action)
7379 'switch-to-buffer-other-frame yank-action send-actions
7380 return-action))
7382 \f
7384 "History of values entered with `set-variable'.
7386 Maximum length of the history list is determined by the value
7390 "Set VARIABLE to VALUE. VALUE is a Lisp object.
7391 VARIABLE should be a user option variable name, a Lisp variable
7392 meant to be customized by users. You should enter VALUE in Lisp syntax,
7393 so if you want VALUE to be a string, you must surround it with doublequotes.
7394 VALUE is used literally, not evaluated.
7396 If VARIABLE has a `variable-interactive' property, that is used as if
7397 it were the arg to `interactive' (which see) to interactively read VALUE.
7399 If VARIABLE has been defined with `defcustom', then the type information
7400 in the definition is used to check that VALUE is valid.
7402 Note that this function is at heart equivalent to the basic `set' function.
7403 For a variable defined with `defcustom', it does not pay attention to
7404 any :set property that the variable might have (if you want that, use
7407 With a prefix argument, set VARIABLE to VALUE buffer-locally."
7412 default-var)
7428 var obsolete)
7431 ;; Use VAR's `variable-interactive' property
7432 ;; as an interactive spec for prompting.
7435 arg))
7437 read-expression-map t
7438 'set-variable-value-history
7447 ;; Match with custom type.
7459 ;; Force a thorough redisplay for the case that the variable
7460 ;; has an effect on the display, like `tab-width' has.
7462 \f
7463 ;; Define the major mode for lists of completions.
7473 (define-key map [right] 'next-completion)
7475 (define-key map [backtab] 'previous-completion)
7476 (define-key map "q" 'quit-window)
7477 (define-key map "z" 'kill-this-buffer)
7478 map)
7479 "Local map for completion list buffers.")
7481 ;; Completion mode is suitable only for specially formatted data.
7482 (put 'completion-list-mode 'mode-class 'special)
7484 (defvar completion-reference-buffer nil
7485 "Record the buffer that was current when the completion list was requested.
7486 This is a local variable in the completion list buffer.
7487 Initial value is nil to avoid some compiler warnings.")
7489 (defvar completion-no-auto-exit nil
7490 "Non-nil means `choose-completion-string' should never exit the minibuffer.
7491 This also applies to other functions such as `choose-completion'.")
7493 (defvar completion-base-position nil
7494 "Position of the base of the text corresponding to the shown completions.
7495 This variable is used in the *Completions* buffers.
7496 Its value is a list of the form (START END) where START is the place
7497 where the completion should be inserted and END (if non-nil) is the end
7498 of the text to replace. If END is nil, point is used instead.")
7500 (defvar completion-list-insert-choice-function #'completion--replace
7501 "Function to use to insert the text chosen in *Completions*.
7502 Called with three arguments (BEG END TEXT), it should replace the text
7503 between BEG and END with TEXT. Expected to be set buffer-locally
7504 in the *Completions* buffer.")
7506 (defvar completion-base-size nil
7507 "Number of chars before point not involved in completion.
7508 This is a local variable in the completion list buffer.
7509 It refers to the chars in the minibuffer if completing in the
7510 minibuffer, or in `completion-reference-buffer' otherwise.
7511 Only characters in the field at point are included.
7513 If nil, Emacs determines which part of the tail end of the
7514 buffer's text is involved in completion by comparing the text
7515 directly.")
7516 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
7518 (defun delete-completion-window ()
7519 "Delete the completion list window.
7520 Go to the window from which completion was requested."
7521 (interactive)
7522 (let ((buf completion-reference-buffer))
7523 (if (one-window-p t)
7524 (if (window-dedicated-p) (delete-frame))
7525 (delete-window (selected-window))
7526 (if (get-buffer-window buf)
7527 (select-window (get-buffer-window buf))))))
7529 (defun previous-completion (n)
7530 "Move to the previous item in the completion list."
7531 (interactive "p")
7532 (next-completion (- n)))
7534 (defun next-completion (n)
7535 "Move to the next item in the completion list.
7536 With prefix argument N, move N items (negative N means move backward)."
7537 (interactive "p")
7538 (let ((beg (point-min)) (end (point-max)))
7539 (while (and (> n 0) (not (eobp)))
7540 ;; If in a completion, move to the end of it.
7541 (when (get-text-property (point) 'mouse-face)
7542 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7543 ;; Move to start of next one.
7544 (unless (get-text-property (point) 'mouse-face)
7545 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
7546 (setq n (1- n)))
7547 (while (and (< n 0) (not (bobp)))
7548 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
7549 ;; If in a completion, move to the start of it.
7550 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
7551 (goto-char (previous-single-property-change
7552 (point) 'mouse-face nil beg)))
7553 ;; Move to end of the previous completion.
7554 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
7555 (goto-char (previous-single-property-change
7556 (point) 'mouse-face nil beg)))
7557 ;; Move to the start of that one.
7558 (goto-char (previous-single-property-change
7559 (point) 'mouse-face nil beg))
7560 (setq n (1+ n))))))
7562 (defun choose-completion (&optional event)
7563 "Choose the completion at point.
7564 If EVENT, use EVENT's position to determine the starting position."
7565 (interactive (list last-nonmenu-event))
7566 ;; In case this is run via the mouse, give temporary modes such as
7567 ;; isearch a chance to turn off.
7568 (run-hooks 'mouse-leave-buffer-hook)
7569 (with-current-buffer (window-buffer (posn-window (event-start event)))
7570 (let ((buffer completion-reference-buffer)
7571 (base-size completion-base-size)
7572 (base-position completion-base-position)
7573 (insert-function completion-list-insert-choice-function)
7574 (choice
7575 (save-excursion
7576 (goto-char (posn-point (event-start event)))
7577 (let (beg end)
7578 (cond
7579 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
7580 (setq end (point) beg (1+ (point))))
7581 ((and (not (bobp))
7582 (get-text-property (1- (point)) 'mouse-face))
7583 (setq end (1- (point)) beg (point)))
7584 (t (error "No completion here")))
7585 (setq beg (previous-single-property-change beg 'mouse-face))
7586 (setq end (or (next-single-property-change end 'mouse-face)
7587 (point-max)))
7588 (buffer-substring-no-properties beg end)))))
7590 (unless (buffer-live-p buffer)
7591 (error "Destination buffer is dead"))
7592 (quit-window nil (posn-window (event-start event)))
7594 (with-current-buffer buffer
7595 (choose-completion-string
7596 choice buffer
7597 (or base-position
7598 (when base-size
7599 ;; Someone's using old completion code that doesn't know
7600 ;; about base-position yet.
7601 (list (+ base-size (field-beginning))))
7602 ;; If all else fails, just guess.
7603 (list (choose-completion-guess-base-position choice)))
7604 insert-function)))))
7606 ;; Delete the longest partial match for STRING
7607 ;; that can be found before POINT.
7608 (defun choose-completion-guess-base-position (string)
7609 (save-excursion
7610 (let ((opoint (point))
7611 len)
7612 ;; Try moving back by the length of the string.
7613 (goto-char (max (- (point) (length string))
7614 (minibuffer-prompt-end)))
7615 ;; See how far back we were actually able to move. That is the
7616 ;; upper bound on how much we can match and delete.
7617 (setq len (- opoint (point)))
7618 (if completion-ignore-case
7619 (setq string (downcase string)))
7620 (while (and (> len 0)
7621 (let ((tail (buffer-substring (point) opoint)))
7622 (if completion-ignore-case
7623 (setq tail (downcase tail)))
7624 (not (string= tail (substring string 0 len)))))
7625 (setq len (1- len))
7626 (forward-char 1))
7627 (point))))
7629 (defun choose-completion-delete-max-match (string)
7630 (declare (obsolete choose-completion-guess-base-position "23.2"))
7631 (delete-region (choose-completion-guess-base-position string) (point)))
7633 (defvar choose-completion-string-functions nil
7634 "Functions that may override the normal insertion of a completion choice.
7635 These functions are called in order with three arguments:
7636 CHOICE - the string to insert in the buffer,
7637 BUFFER - the buffer in which the choice should be inserted,
7638 BASE-POSITION - where to insert the completion.
7640 If a function in the list returns non-nil, that function is supposed
7641 to have inserted the CHOICE in the BUFFER, and possibly exited
7642 the minibuffer; no further functions will be called.
7644 If all functions in the list return nil, that means to use
7645 the default method of inserting the completion in BUFFER.")
7647 (defun choose-completion-string (choice &optional
7648 buffer base-position insert-function)
7649 "Switch to BUFFER and insert the completion choice CHOICE.
7650 BASE-POSITION says where to insert the completion.
7651 INSERT-FUNCTION says how to insert the completion and falls
7652 back on `completion-list-insert-choice-function' when nil."
7654 ;; If BUFFER is the minibuffer, exit the minibuffer
7655 ;; unless it is reading a file name and CHOICE is a directory,
7656 ;; or completion-no-auto-exit is non-nil.
7658 ;; Some older code may call us passing `base-size' instead of
7659 ;; `base-position'. It's difficult to make any use of `base-size',
7660 ;; so we just ignore it.
7661 (unless (consp base-position)
7662 (message "Obsolete `base-size' passed to choose-completion-string")
7663 (setq base-position nil))
7665 (let* ((buffer (or buffer completion-reference-buffer))
7666 (mini-p (minibufferp buffer)))
7667 ;; If BUFFER is a minibuffer, barf unless it's the currently
7668 ;; active minibuffer.
7669 (if (and mini-p
7670 (not (and (active-minibuffer-window)
7671 (equal buffer
7672 (window-buffer (active-minibuffer-window))))))
7673 (error "Minibuffer is not active for completion")
7674 ;; Set buffer so buffer-local choose-completion-string-functions works.
7675 (set-buffer buffer)
7676 (unless (run-hook-with-args-until-success
7677 'choose-completion-string-functions
7678 ;; The fourth arg used to be `mini-p' but was useless
7679 ;; (since minibufferp can be used on the `buffer' arg)
7680 ;; and indeed unused. The last used to be `base-size', so we
7681 ;; keep it to try and avoid breaking old code.
7682 choice buffer base-position nil)
7683 ;; This remove-text-properties should be unnecessary since `choice'
7684 ;; comes from buffer-substring-no-properties.
7685 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
7686 ;; Insert the completion into the buffer where it was requested.
7687 (funcall (or insert-function completion-list-insert-choice-function)
7688 (or (car base-position) (point))
7689 (or (cadr base-position) (point))
7690 choice)
7691 ;; Update point in the window that BUFFER is showing in.
7692 (let ((window (get-buffer-window buffer t)))
7693 (set-window-point window (point)))
7694 ;; If completing for the minibuffer, exit it with this choice.
7695 (and (not completion-no-auto-exit)
7696 (minibufferp buffer)
7697 minibuffer-completion-table
7698 ;; If this is reading a file name, and the file name chosen
7699 ;; is a directory, don't exit the minibuffer.
7700 (let* ((result (buffer-substring (field-beginning) (point)))
7701 (bounds
7702 (completion-boundaries result minibuffer-completion-table
7703 minibuffer-completion-predicate
7704 "")))
7705 (if (eq (car bounds) (length result))
7706 ;; The completion chosen leads to a new set of completions
7707 ;; (e.g. it's a directory): don't exit the minibuffer yet.
7708 (let ((mini (active-minibuffer-window)))
7709 (select-window mini)
7710 (when minibuffer-auto-raise
7711 (raise-frame (window-frame mini))))
7712 (exit-minibuffer))))))))
7714 (define-derived-mode completion-list-mode nil "Completion List"
7715 "Major mode for buffers showing lists of possible completions.
7717 to select the completion near point.
7718 Or click to select one with the mouse.
7721 (set (make-local-variable 'completion-base-size) nil))
7723 (defun completion-list-mode-finish ()
7724 "Finish setup of the completions buffer.
7725 Called from `temp-buffer-show-hook'."
7726 (when (eq major-mode 'completion-list-mode)
7727 (setq buffer-read-only t)))
7729 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
7732 ;; Variables and faces used in `completion-setup-function'.
7734 (defcustom completion-show-help t
7735 "Non-nil means show help message in *Completions* buffer."
7736 :type 'boolean
7737 :version "22.1"
7738 :group 'completion)
7740 ;; This function goes in completion-setup-hook, so that it is called
7741 ;; after the text of the completion list buffer is written.
7742 (defun completion-setup-function ()
7743 (let* ((mainbuf (current-buffer))
7744 (base-dir
7745 ;; FIXME: This is a bad hack. We try to set the default-directory
7746 ;; in the *Completions* buffer so that the relative file names
7747 ;; displayed there can be treated as valid file names, independently
7748 ;; from the completion context. But this suffers from many problems:
7749 ;; - It's not clear when the completions are file names. With some
7750 ;; completion tables (e.g. bzr revision specs), the listed
7751 ;; completions can mix file names and other things.
7752 ;; - It doesn't pay attention to possible quoting.
7753 ;; - With fancy completion styles, the code below will not always
7754 ;; find the right base directory.
7755 (if minibuffer-completing-file-name
7756 (file-name-as-directory
7757 (expand-file-name
7758 (buffer-substring (minibuffer-prompt-end)
7759 (- (point) (or completion-base-size 0))))))))
7760 (with-current-buffer standard-output
7761 (let ((base-size completion-base-size) ;Read before killing localvars.
7762 (base-position completion-base-position)
7763 (insert-fun completion-list-insert-choice-function))
7764 (completion-list-mode)
7765 (set (make-local-variable 'completion-base-size) base-size)
7766 (set (make-local-variable 'completion-base-position) base-position)
7767 (set (make-local-variable 'completion-list-insert-choice-function)
7768 insert-fun))
7769 (set (make-local-variable 'completion-reference-buffer) mainbuf)
7770 (if base-dir (setq default-directory base-dir))
7771 ;; Maybe insert help string.
7772 (when completion-show-help
7773 (goto-char (point-min))
7774 (if (display-mouse-p)
7776 (insert (substitute-command-keys
7780 (add-hook 'completion-setup-hook 'completion-setup-function)
7782 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
7783 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
7785 (defun switch-to-completions ()
7786 "Select the completion list window."
7787 (interactive)
7788 (let ((window (or (get-buffer-window "*Completions*" 0)
7789 ;; Make sure we have a completions window.
7790 (progn (minibuffer-completion-help)
7791 (get-buffer-window "*Completions*" 0)))))
7792 (when window
7793 (select-window window)
7794 ;; In the new buffer, go to the first completion.
7795 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
7796 (when (bobp)
7797 (next-completion 1)))))
7798 \f
7799 ;;; Support keyboard commands to turn on various modifiers.
7801 ;; These functions -- which are not commands -- each add one modifier
7802 ;; to the following event.
7804 (defun event-apply-alt-modifier (_ignore-prompt)
7807 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
7808 (defun event-apply-super-modifier (_ignore-prompt)
7811 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
7812 (defun event-apply-hyper-modifier (_ignore-prompt)
7815 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
7816 (defun event-apply-shift-modifier (_ignore-prompt)
7819 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
7820 (defun event-apply-control-modifier (_ignore-prompt)
7823 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
7824 (defun event-apply-meta-modifier (_ignore-prompt)
7827 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
7829 (defun event-apply-modifier (event symbol lshiftby prefix)
7830 "Apply a modifier flag to event EVENT.
7831 SYMBOL is the name of this modifier, as a symbol.
7832 LSHIFTBY is the numeric value of this modifier, in keyboard events.
7833 PREFIX is the string that represents this modifier in an event type symbol."
7834 (if (numberp event)
7835 (cond ((eq symbol 'control)
7836 (if (and (<= (downcase event) ?z)
7837 (>= (downcase event) ?a))
7838 (- (downcase event) ?a -1)
7839 (if (and (<= (downcase event) ?Z)
7840 (>= (downcase event) ?A))
7841 (- (downcase event) ?A -1)
7842 (logior (lsh 1 lshiftby) event))))
7843 ((eq symbol 'shift)
7844 (if (and (<= (downcase event) ?z)
7845 (>= (downcase event) ?a))
7846 (upcase event)
7847 (logior (lsh 1 lshiftby) event)))
7848 (t
7849 (logior (lsh 1 lshiftby) event)))
7850 (if (memq symbol (event-modifiers event))
7851 event
7852 (let ((event-type (if (symbolp event) event (car event))))
7853 (setq event-type (intern (concat prefix (symbol-name event-type))))
7854 (if (symbolp event)
7855 event-type
7856 (cons event-type (cdr event)))))))
7858 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
7859 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
7860 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
7861 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
7862 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
7863 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
7864 \f
7865 ;;;; Keypad support.
7867 ;; Make the keypad keys act like ordinary typing keys. If people add
7868 ;; bindings for the function key symbols, then those bindings will
7869 ;; override these, so this shouldn't interfere with any existing
7870 ;; bindings.
7872 ;; Also tell read-char how to handle these keys.
7873 (mapc
7874 (lambda (keypad-normal)
7875 (let ((keypad (nth 0 keypad-normal))
7876 (normal (nth 1 keypad-normal)))
7877 (put keypad 'ascii-character normal)
7878 (define-key function-key-map (vector keypad) (vector normal))))
7879 ;; See also kp-keys bound in bindings.el.
7880 '((kp-space ?\s)
7883 (kp-separator ?,)
7884 (kp-equal ?=)
7885 ;; Do the same for various keys that are represented as symbols under
7886 ;; GUIs but naturally correspond to characters.
7887 (backspace 127)
7888 (delete 127)
7891 (clear ?\C-l)
7892 (return ?\C-m)
7893 (escape ?\e)
7894 ))
7895 \f
7896 ;;;;
7897 ;;;; forking a twin copy of a buffer.
7898 ;;;;
7900 (defvar clone-buffer-hook nil
7901 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7903 (defvar clone-indirect-buffer-hook nil
7904 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7906 (defun clone-process (process &optional newname)
7907 "Create a twin copy of PROCESS.
7908 If NEWNAME is nil, it defaults to PROCESS' name;
7909 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7910 If PROCESS is associated with a buffer, the new process will be associated
7911 with the current buffer instead.
7912 Returns nil if PROCESS has already terminated."
7913 (setq newname (or newname (process-name process)))
7915 (setq newname (substring newname 0 (match-beginning 0))))
7916 (when (memq (process-status process) '(run stop open))
7917 (let* ((process-connection-type (process-tty-name process))
7918 (new-process
7919 (if (memq (process-status process) '(open))
7920 (let ((args (process-contact process t)))
7921 (setq args (plist-put args :name newname))
7922 (setq args (plist-put args :buffer
7923 (if (process-buffer process)
7924 (current-buffer))))
7925 (apply 'make-network-process args))
7926 (apply 'start-process newname
7927 (if (process-buffer process) (current-buffer))
7928 (process-command process)))))
7929 (set-process-query-on-exit-flag
7930 new-process (process-query-on-exit-flag process))
7931 (set-process-inherit-coding-system-flag
7932 new-process (process-inherit-coding-system-flag process))
7933 (set-process-filter new-process (process-filter process))
7934 (set-process-sentinel new-process (process-sentinel process))
7935 (set-process-plist new-process (copy-sequence (process-plist process)))
7936 new-process)))
7938 ;; things to maybe add (currently partly covered by `funcall mode'):
7939 ;; - syntax-table
7940 ;; - overlays
7941 (defun clone-buffer (&optional newname display-flag)
7942 "Create and return a twin copy of the current buffer.
7943 Unlike an indirect buffer, the new buffer can be edited
7944 independently of the old one (if it is not read-only).
7945 NEWNAME is the name of the new buffer. It may be modified by
7946 adding or incrementing <N> at the end as necessary to create a
7947 unique buffer name. If nil, it defaults to the name of the
7948 current buffer, with the proper suffix. If DISPLAY-FLAG is
7949 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7950 clone a file-visiting buffer, or a buffer whose major mode symbol
7951 has a non-nil `no-clone' property, results in an error.
7953 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7954 current buffer with appropriate suffix. However, if a prefix
7955 argument is given, then the command prompts for NEWNAME in the
7956 minibuffer.
7958 This runs the normal hook `clone-buffer-hook' in the new buffer
7959 after it has been set up properly in other respects."
7960 (interactive
7961 (progn
7962 (if buffer-file-name
7963 (error "Cannot clone a file-visiting buffer"))
7964 (if (get major-mode 'no-clone)
7965 (error "Cannot clone a buffer in %s mode" mode-name))
7966 (list (if current-prefix-arg
7967 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7968 t)))
7969 (if buffer-file-name
7970 (error "Cannot clone a file-visiting buffer"))
7971 (if (get major-mode 'no-clone)
7972 (error "Cannot clone a buffer in %s mode" mode-name))
7973 (setq newname (or newname (buffer-name)))
7975 (setq newname (substring newname 0 (match-beginning 0))))
7976 (let ((buf (current-buffer))
7977 (ptmin (point-min))
7978 (ptmax (point-max))
7979 (pt (point))
7980 (mk (if mark-active (mark t)))
7981 (modified (buffer-modified-p))
7982 (mode major-mode)
7983 (lvars (buffer-local-variables))
7984 (process (get-buffer-process (current-buffer)))
7985 (new (generate-new-buffer (or newname (buffer-name)))))
7986 (save-restriction
7987 (widen)
7988 (with-current-buffer new
7989 (insert-buffer-substring buf)))
7990 (with-current-buffer new
7991 (narrow-to-region ptmin ptmax)
7992 (goto-char pt)
7993 (if mk (set-mark mk))
7994 (set-buffer-modified-p modified)
7996 ;; Clone the old buffer's process, if any.
7997 (when process (clone-process process))
7999 ;; Now set up the major mode.
8000 (funcall mode)
8002 ;; Set up other local variables.
8003 (mapc (lambda (v)
8004 (condition-case () ;in case var is read-only
8005 (if (symbolp v)
8006 (makunbound v)
8007 (set (make-local-variable (car v)) (cdr v)))
8008 (error nil)))
8009 lvars)
8011 ;; Run any hooks (typically set up by the major mode
8012 ;; for cloning to work properly).
8013 (run-hooks 'clone-buffer-hook))
8014 (if display-flag
8015 ;; Presumably the current buffer is shown in the selected frame, so
8016 ;; we want to display the clone elsewhere.
8017 (let ((same-window-regexps nil)
8018 (same-window-buffer-names))
8019 (pop-to-buffer new)))
8020 new))
8023 (defun clone-indirect-buffer (newname display-flag &optional norecord)
8024 "Create an indirect buffer that is a twin copy of the current buffer.
8026 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
8027 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
8028 or if not called with a prefix arg, NEWNAME defaults to the current
8029 buffer's name. The name is modified by adding a `<N>' suffix to it
8030 or by incrementing the N in an existing suffix. Trying to clone a
8031 buffer whose major mode symbol has a non-nil `no-clone-indirect'
8032 property results in an error.
8034 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
8035 This is always done when called interactively.
8037 Optional third arg NORECORD non-nil means do not put this buffer at the
8038 front of the list of recently selected ones.
8040 Returns the newly created indirect buffer."
8041 (interactive
8042 (progn
8043 (if (get major-mode 'no-clone-indirect)
8044 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8045 (list (if current-prefix-arg
8046 (read-buffer "Name of indirect buffer: " (current-buffer)))
8047 t)))
8048 (if (get major-mode 'no-clone-indirect)
8049 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8050 (setq newname (or newname (buffer-name)))
8052 (setq newname (substring newname 0 (match-beginning 0))))
8053 (let* ((name (generate-new-buffer-name newname))
8054 (buffer (make-indirect-buffer (current-buffer) name t)))
8055 (with-current-buffer buffer
8056 (run-hooks 'clone-indirect-buffer-hook))
8057 (when display-flag
8058 (pop-to-buffer buffer norecord))
8059 buffer))
8062 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
8063 "Like `clone-indirect-buffer' but display in another window."
8064 (interactive
8065 (progn
8066 (if (get major-mode 'no-clone-indirect)
8067 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
8068 (list (if current-prefix-arg
8069 (read-buffer "Name of indirect buffer: " (current-buffer)))
8070 t)))
8071 (let ((pop-up-windows t))
8072 (clone-indirect-buffer newname display-flag norecord)))
8074 \f
8075 ;;; Handling of Backspace and Delete keys.
8077 (defcustom normal-erase-is-backspace 'maybe
8078 "Set the default behavior of the Delete and Backspace keys.
8080 If set to t, Delete key deletes forward and Backspace key deletes
8081 backward.
8083 If set to nil, both Delete and Backspace keys delete backward.
8085 If set to 'maybe (which is the default), Emacs automatically
8086 selects a behavior. On window systems, the behavior depends on
8087 the keyboard used. If the keyboard has both a Backspace key and
8088 a Delete key, and both are mapped to their usual meanings, the
8089 option's default value is set to t, so that Backspace can be used
8090 to delete backward, and Delete can be used to delete forward.
8092 If not running under a window system, customizing this option
8093 accomplishes a similar effect by mapping C-h, which is usually
8094 generated by the Backspace key, to DEL, and by mapping DEL to C-d
8095 via `keyboard-translate'. The former functionality of C-h is
8096 available on the F1 key. You should probably not use this
8097 setting if you don't have both Backspace, Delete and F1 keys.
8099 Setting this variable with setq doesn't take effect. Programmatically,
8100 call `normal-erase-is-backspace-mode' (which see) instead."
8101 :type '(choice (const :tag "Off" nil)
8102 (const :tag "Maybe" maybe)
8103 (other :tag "On" t))
8104 :group 'editing-basics
8105 :version "21.1"
8106 :set (lambda (symbol value)
8107 ;; The fboundp is because of a problem with :set when
8108 ;; dumping Emacs. It doesn't really matter.
8109 (if (fboundp 'normal-erase-is-backspace-mode)
8110 (normal-erase-is-backspace-mode (or value 0))
8111 (set-default symbol value))))
8113 (defun normal-erase-is-backspace-setup-frame (&optional frame)
8114 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
8115 (unless frame (setq frame (selected-frame)))
8116 (with-selected-frame frame
8117 (unless (terminal-parameter nil 'normal-erase-is-backspace)
8118 (normal-erase-is-backspace-mode
8119 (if (if (eq normal-erase-is-backspace 'maybe)
8120 (and (not noninteractive)
8121 (or (memq system-type '(ms-dos windows-nt))
8122 (memq window-system '(w32 ns))
8123 (and (memq window-system '(x))
8124 (fboundp 'x-backspace-delete-keys-p)
8125 (x-backspace-delete-keys-p))
8126 ;; If the terminal Emacs is running on has erase char
8127 ;; set to ^H, use the Backspace key for deleting
8128 ;; backward, and the Delete key for deleting forward.
8129 (and (null window-system)
8130 (eq tty-erase-char ?\^H))))
8131 normal-erase-is-backspace)
8132 1 0)))))
8134 (define-minor-mode normal-erase-is-backspace-mode
8135 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
8136 With a prefix argument ARG, enable this feature if ARG is
8137 positive, and disable it otherwise. If called from Lisp, enable
8138 the mode if ARG is omitted or nil.
8140 On window systems, when this mode is on, Delete is mapped to C-d
8141 and Backspace is mapped to DEL; when this mode is off, both
8142 Delete and Backspace are mapped to DEL. (The remapping goes via
8143 `local-function-key-map', so binding Delete or Backspace in the
8144 global or local keymap will override that.)
8146 In addition, on window systems, the bindings of C-Delete, M-Delete,
8147 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
8148 the global keymap in accordance with the functionality of Delete and
8149 Backspace. For example, if Delete is remapped to C-d, which deletes
8150 forward, C-Delete is bound to `kill-word', but if Delete is remapped
8151 to DEL, which deletes backward, C-Delete is bound to
8152 `backward-kill-word'.
8154 If not running on a window system, a similar effect is accomplished by
8155 remapping C-h (normally produced by the Backspace key) and DEL via
8156 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
8157 to C-d; if it's off, the keys are not remapped.
8159 When not running on a window system, and this mode is turned on, the
8160 former functionality of C-h is available on the F1 key. You should
8161 probably not turn on this mode on a text-only terminal if you don't
8162 have both Backspace, Delete and F1 keys.
8164 See also `normal-erase-is-backspace'."
8165 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
8166 . (lambda (v)
8167 (setf (terminal-parameter nil 'normal-erase-is-backspace)
8168 (if v 1 0))))
8169 (let ((enabled (eq 1 (terminal-parameter
8170 nil 'normal-erase-is-backspace))))
8172 (cond ((or (memq window-system '(x w32 ns pc))
8173 (memq system-type '(ms-dos windows-nt)))
8174 (let ((bindings
8175 `(([M-delete] [M-backspace])
8176 ([C-M-delete] [C-M-backspace])
8177 ([?\e C-delete] [?\e C-backspace]))))
8179 (if enabled
8180 (progn
8181 (define-key local-function-key-map [delete] [deletechar])
8182 (define-key local-function-key-map [kp-delete] [deletechar])
8183 (define-key local-function-key-map [backspace] [?\C-?])
8184 (dolist (b bindings)
8185 ;; Not sure if input-decode-map is really right, but
8186 ;; keyboard-translate-table (used below) only works
8187 ;; for integer events, and key-translation-table is
8188 ;; global (like the global-map, used earlier).
8189 (define-key input-decode-map (car b) nil)
8190 (define-key input-decode-map (cadr b) nil)))
8191 (define-key local-function-key-map [delete] [?\C-?])
8192 (define-key local-function-key-map [kp-delete] [?\C-?])
8193 (define-key local-function-key-map [backspace] [?\C-?])
8194 (dolist (b bindings)
8195 (define-key input-decode-map (car b) (cadr b))
8196 (define-key input-decode-map (cadr b) (car b))))))
8197 (t
8198 (if enabled
8199 (progn
8200 (keyboard-translate ?\C-h ?\C-?)
8201 (keyboard-translate ?\C-? ?\C-d))
8202 (keyboard-translate ?\C-h ?\C-h)
8203 (keyboard-translate ?\C-? ?\C-?))))
8205 (if (called-interactively-p 'interactive)
8206 (message "Delete key deletes %s"
8207 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
8208 "forward" "backward")))))
8209 \f
8210 (defvar vis-mode-saved-buffer-invisibility-spec nil
8211 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
8213 (define-minor-mode read-only-mode
8214 "Change whether the current buffer is read-only.
8215 With prefix argument ARG, make the buffer read-only if ARG is
8216 positive, otherwise make it writable. If buffer is read-only
8217 and `view-read-only' is non-nil, enter view mode.
8219 Do not call this from a Lisp program unless you really intend to
8221 possibly enabling or disabling View mode. Also, note that this
8222 command works by setting the variable `buffer-read-only', which
8223 does not affect read-only regions caused by text properties. To
8224 ignore read-only status in a Lisp program (whether due to text
8225 properties or buffer state), bind `inhibit-read-only' temporarily
8226 to a non-nil value."
8227 :variable buffer-read-only
8228 (cond
8229 ((and (not buffer-read-only) view-mode)
8230 (View-exit-and-edit)
8231 (make-local-variable 'view-read-only)
8232 (setq view-read-only t)) ; Must leave view mode.
8233 ((and buffer-read-only view-read-only
8234 ;; If view-mode is already active, `view-mode-enter' is a nop.
8235 (not view-mode)
8236 (not (eq (get major-mode 'mode-class) 'special)))
8237 (view-mode-enter))))
8239 (define-minor-mode visible-mode
8240 "Toggle making all invisible text temporarily visible (Visible mode).
8241 With a prefix argument ARG, enable Visible mode if ARG is
8242 positive, and disable it otherwise. If called from Lisp, enable
8243 the mode if ARG is omitted or nil.
8245 This mode works by saving the value of `buffer-invisibility-spec'
8246 and setting it to nil."
8247 :lighter " Vis"
8248 :group 'editing-basics
8249 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
8250 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
8251 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
8252 (when visible-mode
8253 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
8254 buffer-invisibility-spec)
8255 (setq buffer-invisibility-spec nil)))
8256 \f
8257 (defvar messages-buffer-mode-map
8258 (let ((map (make-sparse-keymap)))
8259 (set-keymap-parent map special-mode-map)
8260 (define-key map "g" nil) ; nothing to revert
8261 map))
8263 (define-derived-mode messages-buffer-mode special-mode "Messages"
8266 (defun messages-buffer ()
8268 If it does not exist, create and it switch it to `messages-buffer-mode'."
8269 (or (get-buffer "*Messages*")
8270 (with-current-buffer (get-buffer-create "*Messages*")
8271 (messages-buffer-mode)
8272 (current-buffer))))
8274 \f
8275 ;; Minibuffer prompt stuff.
8277 ;;(defun minibuffer-prompt-modification (start end)
8278 ;; (error "You cannot modify the prompt"))
8279 ;;
8280 ;;
8281 ;;(defun minibuffer-prompt-insertion (start end)
8282 ;; (let ((inhibit-modification-hooks t))
8283 ;; (delete-region start end)
8284 ;; ;; Discard undo information for the text insertion itself
8285 ;; ;; and for the text deletion.above.
8286 ;; (when (consp buffer-undo-list)
8287 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
8288 ;; (message "You cannot modify the prompt")))
8289 ;;
8290 ;;
8291 ;;(setq minibuffer-prompt-properties
8292 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
8293 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
8295 \f
8296 ;;;; Problematic external packages.
8298 ;; rms says this should be done by specifying symbols that define
8299 ;; versions together with bad values. This is therefore not as
8300 ;; flexible as it could be. See the thread:
8301 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
8302 (defconst bad-packages-alist
8303 ;; Not sure exactly which semantic versions have problems.
8304 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
8306 "The version of `semantic' loaded does not work in Emacs 22.
8307 It can cause constant high CPU load.
8308 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
8309 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
8310 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
8311 ;; provided the `CUA-mode' feature. Since this is no longer true,
8312 ;; we can warn the user if the `CUA-mode' feature is ever provided.
8313 (CUA-mode t nil
8314 "CUA-mode is now part of the standard GNU Emacs distribution,
8315 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
8317 You have loaded an older version of CUA-mode which does not work
8318 correctly with this version of Emacs. You should remove the old
8319 version and use the one distributed with Emacs."))
8320 "Alist of packages known to cause problems in this version of Emacs.
8321 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
8322 PACKAGE is either a regular expression to match file names, or a
8323 symbol (a feature name), like for `with-eval-after-load'.
8324 SYMBOL is either the name of a string variable, or t. Upon
8325 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
8326 warning using STRING as the message.")
8328 (defun bad-package-check (package)
8329 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
8330 (condition-case nil
8331 (let* ((list (assoc package bad-packages-alist))
8332 (symbol (nth 1 list)))
8333 (and list
8334 (boundp symbol)
8335 (or (eq symbol t)
8336 (and (stringp (setq symbol (eval symbol)))
8337 (string-match-p (nth 2 list) symbol)))
8338 (display-warning package (nth 3 list) :warning)))
8339 (error nil)))
8341 (dolist (elem bad-packages-alist)
8342 (let ((pkg (car elem)))
8343 (with-eval-after-load pkg
8344 (bad-package-check pkg))))
8346 \f
8347 ;;; Generic dispatcher commands
8349 ;; Macro `define-alternatives' is used to create generic commands.
8350 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
8351 ;; that can have different alternative implementations where choosing
8352 ;; among them is exclusively a matter of user preference.
8354 ;; (define-alternatives COMMAND) creates a new interactive command
8355 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
8356 ;; Typically, the user will not need to customize this variable; packages
8357 ;; wanting to add alternative implementations should use
8358 ;;
8359 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
8361 (defmacro define-alternatives (command &rest customizations)
8362 "Define the new command `COMMAND'.
8364 The argument `COMMAND' should be a symbol.
8366 Running `M-x COMMAND RET' for the first time prompts for which
8367 alternative to use and records the selected command as a custom
8368 variable.
8370 Running `C-u M-x COMMAND RET' prompts again for an alternative
8371 and overwrites the previous choice.
8373 The variable `COMMAND-alternatives' contains an alist with
8374 alternative implementations of COMMAND. `define-alternatives'
8375 does not have any effect until this variable is set.
8377 CUSTOMIZATIONS, if non-nil, should be composed of alternating
8378 `defcustom' keywords and values to add to the declaration of
8379 `COMMAND-alternatives' (typically :group and :version)."
8380 (let* ((command-name (symbol-name command))
8381 (varalt-name (concat command-name "-alternatives"))
8382 (varalt-sym (intern varalt-name))
8383 (varimp-sym (intern (concat command-name "--implementation"))))
8384 `(progn
8386 (defcustom ,varalt-sym nil
8387 ,(format "Alist of alternative implementations for the `%s' command.
8389 Each entry must be a pair (ALTNAME . ALTFUN), where:
8390 ALTNAME - The name shown at user to describe the alternative implementation.
8391 ALTFUN - The function called to implement this alternative."
8392 command-name)
8393 :type '(alist :key-type string :value-type function)
8394 ,@customizations)
8396 (put ',varalt-sym 'definition-name ',command)
8397 (defvar ,varimp-sym nil "Internal use only.")
8399 (defun ,command (&optional arg)
8400 ,(format "Run generic command `%s'.
8401 If used for the first time, or with interactive ARG, ask the user which
8402 implementation to use for `%s'. The variable `%s'
8403 contains the list of implementations currently supported for this command."
8404 command-name command-name varalt-name)
8405 (interactive "P")
8406 (when (or arg (null ,varimp-sym))
8407 (let ((val (completing-read
8408 ,(format-message
8409 "Select implementation for command `%s': "
8410 command-name)
8411 ,varalt-sym nil t)))
8412 (unless (string-equal val "")
8413 (when (null ,varimp-sym)
8414 (message
8415 "Use C-u M-x %s RET`to select another implementation"
8416 ,command-name)
8417 (sit-for 3))
8418 (customize-save-variable ',varimp-sym
8419 (cdr (assoc-string val ,varalt-sym))))))
8420 (if ,varimp-sym
8421 (call-interactively ,varimp-sym)
8422 (message "%s" ,(format-message
8423 "No implementation selected for command `%s'"
8424 command-name)))))))
8426 \f
8428 (provide 'simple)
8430 ;;; simple.el ends here