| blob | f81b02b0acf16b1560f809528881d263b28177bf |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2013 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
34 ;;; From compile.el
39 "Idle time delay before updating various things on the screen.
40 Various Emacs features that update auxiliary information when point moves
41 wait this many seconds after Emacs becomes idle before doing an update."
47 "Killing and yanking commands."
51 "Highlight (un)matching of parens and expressions."
53 \f
54 ;;; next-error support framework
57 "`next-error' support framework."
63 "Face used to highlight next error locus."
68 "Highlighting of locations in selected source buffers.
69 If a number, highlight the locus in `next-error' face for the given time
70 in seconds, or until the next command is executed.
71 If t, highlight the locus until the next command is executed, or until
72 some other locus replaces it.
73 If nil, don't highlight the locus in the source buffer.
74 If `fringe-arrow', indicate the locus by the fringe arrow
75 indefinitely until some other locus replaces it."
84 "Highlighting of locations in `next-error-no-select'.
85 If number, highlight the locus in `next-error' face for given time in seconds.
86 If t, highlight the locus indefinitely until some other locus replaces it.
87 If nil, don't highlight the locus in the source buffer.
88 If `fringe-arrow', indicate the locus by the fringe arrow
89 indefinitely until some other locus replaces it."
98 "Display the line in the visited source file recentered as specified.
99 If non-nil, the value is passed directly to `recenter'."
107 "List of hook functions run by `next-error' after visiting source file."
118 "The most recent `next-error' buffer.
119 A buffer becomes most recent when its compilation, grep, or
124 "Function to use to find the next error in the current buffer.
125 The function is called with 2 parameters:
126 ARG is an integer specifying by how many errors to move.
127 RESET is a boolean which, if non-nil, says to go back to the beginning
128 of the errors before moving.
129 Major modes providing compile-like functionality should set this variable
130 to indicate to `next-error' that this is a candidate buffer and how
135 "Function to use to move to an error locus.
136 It takes two arguments, a buffer position in the error buffer
137 and a buffer position in the error locus buffer.
138 The buffer for the error locus should already be current.
143 &optional avoid-current
144 extra-test-inclusive
145 extra-test-exclusive)
146 "Test if BUFFER is a `next-error' capable buffer.
148 If AVOID-CURRENT is non-nil, treat the current buffer
149 as an absolute last resort only.
151 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
152 that normally would not qualify. If it returns t, the buffer
153 in question is treated as usable.
155 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
156 that would normally be considered usable. If it returns nil,
157 that buffer is rejected."
162 ;; Optionally reject some buffers.
165 t)
166 ;; Optionally accept some other buffers.
171 extra-test-inclusive
172 extra-test-exclusive)
173 "Return a `next-error' capable buffer.
175 If AVOID-CURRENT is non-nil, treat the current buffer
176 as an absolute last resort only.
178 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
179 that normally would not qualify. If it returns t, the buffer
180 in question is treated as usable.
182 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
183 that would normally be considered usable. If it returns nil,
184 that buffer is rejected."
186 ;; 1. If one window on the selected frame displays such buffer, return it.
192 avoid-current
193 extra-test-inclusive extra-test-exclusive)
198 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
201 extra-test-inclusive extra-test-exclusive))
202 next-error-last-buffer)
203 ;; 3. If the current buffer is acceptable, choose it.
205 extra-test-inclusive extra-test-exclusive)
207 ;; 4. Look for any acceptable buffer.
212 extra-test-inclusive extra-test-exclusive)))
215 ;; 5. Use the current buffer as a last resort if it qualifies,
216 ;; even despite AVOID-CURRENT.
219 extra-test-inclusive extra-test-exclusive)
223 ;; 6. Give up.
227 "Visit next `next-error' message and corresponding source code.
229 If all the error messages parsed so far have been processed already,
230 the message buffer is checked for new ones.
232 A prefix ARG specifies how many error messages to move;
233 negative means move back to previous error messages.
235 and start at the first error.
237 The RESET argument specifies that we should restart from the beginning.
240 compilation, grep, or occur buffer. It can also operate on any
242 more generally, on any buffer in Compilation mode or with
243 Compilation Minor mode enabled, or any buffer in which
244 `next-error-function' is bound to an appropriate function.
245 To specify use of a particular buffer for error messages, type
247 in the current frame.
250 runs `next-error-hook' with `run-hooks', and stays with that buffer
251 until you use it in some other buffer which uses Compilation mode
252 or Compilation Minor mode.
254 To control which errors are matched, customize the variable
255 `compilation-error-regexp-alist'."
259 ;; we know here that next-error-function is a valid symbol we can funcall
267 "Visit the source code corresponding to the `next-error' message at point."
269 ;; we know here that next-error-function is a valid symbol we can funcall
280 "Visit previous `next-error' message and corresponding source code.
282 Prefix arg N says how many error messages to move backwards (or
283 forwards, if negative).
290 "Restart at the first error.
291 Visit corresponding source code.
292 With prefix arg N, visit the source code of the Nth error.
298 "Move point to the next error in the `next-error' buffer and highlight match.
299 Prefix arg N says how many error messages to move forwards (or
300 backwards, if negative).
302 select the source buffer."
309 "Move point to the previous error in the `next-error' buffer and highlight match.
310 Prefix arg N says how many error messages to move backwards (or
311 forwards, if negative).
313 select the source buffer."
317 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
321 "Minor mode for compilation, occur and diff modes.
322 With a prefix argument ARG, enable mode if ARG is positive, and
323 disable it otherwise. If called from Lisp, enable mode if ARG is
324 omitted or nil.
325 When turned on, cursor motion in the compilation, grep, occur or diff
326 buffer causes automatic display of the corresponding source code location."
333 ;; Used as a `post-command-hook' by `next-error-follow-mode'
334 ;; for the *Compilation* *grep* and *Occur* buffers.
344 \f
345 ;;;
348 "Major mode not specialized for anything in particular.
349 Other major modes are defined by comparison with this one."
354 ;; Special major modes to view specially formatted data rather than files.
368 map))
372 "Parent major mode from which special major modes should inherit."
375 ;; Major mode meant to be the parent of programming modes.
380 map)
384 "Indent the expression after point.
385 When interactively called with prefix, indent the enclosing defun
386 instead."
397 "Major mode for editing programming language source code."
400 ;; Any programming language is always written left to right.
403 ;; Making and deleting lines.
409 "Insert a newline, and move to left margin of the new line if it's blank.
410 If option `use-hard-newlines' is non-nil, the newline is marked with the
411 text-property `hard'.
412 With ARG, insert that many newlines.
413 Call `auto-fill-function' if the current column number is greater
414 than the value of `fill-column' and ARG is nil."
417 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
418 ;; Set last-command-event to tell self-insert what to insert.
422 ;; Don't auto-fill if we have a numeric argument.
425 ;; Do the rest in post-self-insert-hook, because we want to do it
426 ;; *before* other functions on that hook.
428 ;; Mark the newline(s) `hard'.
432 ;; If the newline leaves the previous line blank, and we
433 ;; have a left margin, delete that from the blank line.
441 ;; Indent the line after the newline, except in one case:
442 ;; when we added the newline at the beginning of a line which
443 ;; starts a page.
450 ;; We first used let-binding to protect the hook, but that was naive
451 ;; since add-hook affects the symbol-default value of the variable,
452 ;; whereas the let-binding might only protect the buffer-local value.
454 nil)
459 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
465 "Insert a newline and leave point before it.
466 If there is a fill prefix and/or a `left-margin', insert them
467 on the new line if the line would have been blank.
468 With arg N, insert N newlines."
473 ;; Don't expand an abbrev before point.
487 "Split current line, moving portion beyond point vertically down.
488 If the current line starts with `fill-prefix', insert it on the new
489 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
491 When called from Lisp code, ARG may be a prefix string to copy."
496 ;; What prefix should we check for (nil means don't).
500 ;; Does this line start with it?
511 "Join this line to previous and fix up whitespace at join.
512 If there is a fill prefix, delete it from the beginning of this line.
513 With argument, join this line to following line."
520 ;; If the second line started with the fill prefix,
521 ;; delete the prefix.
533 "On blank line, delete all surrounding blank lines, leaving just one.
534 On isolated blank line, delete that one.
535 On nonblank line, delete any immediately following blank lines."
541 ;; Set singleblank if there is just one blank line here.
548 ;; Delete preceding blank lines, and this one too if it's the only one.
557 ;; Delete following blank lines, unless the current line is blank
558 ;; and there are no following blank lines.
567 ;; Handle the special case where point is followed by newline and eob.
568 ;; Delete the line, leaving point at eob.
574 Trailing lines are deleted only if `delete-trailing-whitespace'
575 is called on the entire buffer (rather than an active region)."
581 "Delete trailing whitespace between START and END.
582 If called interactively, START and END are the start/end of the
583 region if the mark is active, or of the buffer's accessible
584 portion if the mark is inactive.
586 This command deletes whitespace characters after the last
587 non-whitespace character in each line between START and END. It
588 does not consider formfeed characters to be whitespace.
590 If this command acts on the entire buffer (i.e. if called
591 interactively with the mark inactive, or called from Lisp with
592 END nil), it also deletes all trailing lines at the end of the
593 buffer if the variable `delete-trailing-lines' is non-nil."
606 ;; Don't delete formfeeds, even if they are considered whitespace.
610 ;; Delete trailing empty lines.
613 delete-trailing-lines
614 ;; Really the end of buffer.
619 ;; Return nil for the benefit of `write-file-functions'.
620 nil)
623 "Insert a newline, then indent according to major mode.
624 Indentation is done using the value of `indent-line-function'.
625 In programming language modes, this is the same as TAB.
626 In some text modes, where TAB inserts a tab, this command indents to the
627 column specified by the function `current-left-margin'."
634 "Reindent current line, insert newline, then indent the new line.
635 Indentation of both lines is done according to the current major mode,
636 which means calling the current value of `indent-line-function'.
637 In programming language modes, this is the same as TAB.
638 In some text modes, where TAB inserts a tab, this indents to the
639 column specified by the function `current-left-margin'."
642 ;; Be careful to insert the newline before indenting the line.
643 ;; Otherwise, the indentation might be wrong.
647 ;; We are at EOL before the call to indent-according-to-mode, and
648 ;; after it we usually are as well, but not always. We tried to
649 ;; address it with `save-excursion' but that uses a normal marker
650 ;; whereas we need `move after insertion', so we do the save/restore
651 ;; by hand.
655 ;; Remove the trailing white-space after indentation because
656 ;; indentation may introduce the whitespace.
661 "Read next input character and insert it.
662 This is useful for inserting control characters.
663 With argument, insert ARG copies of the character.
665 If the first character you type after this command is an octal digit,
666 you should type a sequence of octal digits which specify a character code.
667 Any nondigit terminates the sequence. If the terminator is a RET,
668 it is discarded; any other terminator is used itself as input.
669 The variable `read-quoted-char-radix' specifies the radix for this feature;
670 set it to 10 or 16 to use decimal or hex instead of octal.
672 In overwrite mode, this function inserts the character anyway, and
673 does not handle octal digits specially. This means that if you use
674 overwrite as your normal editing mode, you can use this function to
675 insert characters when necessary.
677 In binary overwrite mode, this function does overwrite, and octal
678 digits are interpreted as a character code. This is intended to be
679 useful for editing binary files."
682 ;; Avoid "obsolete" warnings for translation-table-for-input.
689 ;; This used to assume character codes 0240 - 0377 stand for
690 ;; characters in some single-byte character set, and converted them
691 ;; to Emacs characters. But in 23.1 this feature is deprecated
692 ;; in favor of inserting the corresponding Unicode characters.
693 ;; (if (and enable-multibyte-characters
694 ;; (>= char ?\240)
695 ;; (<= char ?\377))
696 ;; (setq char (unibyte-char-to-multibyte char)))
705 "Move forward ARG lines and position at first nonblank character."
711 "Move backward ARG lines and position at first nonblank character."
717 "Move point to the first non-whitespace character on this line."
721 ;; Move back over chars that have whitespace syntax but have the p flag.
725 "Fixup white space between objects around point.
726 Leave one space or none, according to the context."
733 nil
737 "Delete all spaces and tabs around point.
738 If BACKWARD-ONLY is non-nil, only delete them before point."
743 orig-pos
752 "Delete all spaces and tabs around point, leaving one space (or N spaces).
753 If N is negative, delete newlines as well, leaving -N spaces."
758 "Store context used in consecutive calls to `cycle-spacing' command.
759 The first time this function is run, it saves the original point
760 position and original spacing around the point in this
764 "Manipulate spaces around the point in a smart way.
766 When run as an interactive command, the first time it's called
767 in a sequence, deletes all spaces and tabs around point leaving
768 one (or N spaces). If this does not change content of the
769 buffer, skips to the second step:
771 When run for the second time in a sequence, deletes all the
772 spaces it has previously inserted.
774 When run for the third time, returns the whitespace and point in
775 a state encountered when it had been run for the first time.
778 point, calling `cycle-spacing' command will replace two spaces with
779 a single space, calling it again immediately after, will remove all
780 spaces, and calling it for the third time will bring two spaces back
781 together.
783 If N is negative, delete newlines as well. However, if
784 PRESERVE-NL-BACK is t new line characters prior to the point
785 won't be removed.
787 If SINGLE-SHOT is non-nil, will only perform the first step. In
788 other words, it will work just like `just-one-space' command."
796 ;; Command run for the first time or single-shot is non-nil.
807 ;; Special handling for case where there was no space at all.
810 ;; If this run causes no change in buffer content, delete all spaces,
811 ;; otherwise delete all excess spaces.
816 ;; Command run for the second time.
820 ;; Command run for the third time.
825 \f
827 "Move point to the beginning of the buffer.
828 With numeric arg N, put point N/10 of the way from the beginning.
829 If the buffer is narrowed, this command uses the beginning of the
830 accessible part of the buffer.
832 If Transient Mark mode is disabled, leave mark at previous
835 Don't use this command in Lisp programs!
836 \(goto-char (point-min)) is faster."
845 ;; Avoid overflow for large buffer sizes!
853 "Move point to the end of the buffer.
854 With numeric arg N, put point N/10 of the way from the end.
855 If the buffer is narrowed, this command uses the end of the
856 accessible part of the buffer.
858 If Transient Mark mode is disabled, leave mark at previous
861 Don't use this command in Lisp programs!
862 \(goto-char (point-max)) is faster."
869 ;; Avoid overflow for large buffer sizes!
874 ;; If we went to a place in the middle of the buffer,
875 ;; adjust it to the beginning of a line.
879 ;; If the end of the buffer is not already on the screen,
880 ;; then scroll specially to put it near, but not at, the bottom.
885 "Whether single-char deletion commands delete an active region.
886 This has an effect only if Transient Mark mode is enabled, and
887 affects `delete-forward-char' and `delete-backward-char', though
888 not `delete-char'.
890 If the value is the symbol `kill', the active region is killed
891 instead of deleted."
899 "Delete the previous N characters (following if N is negative).
900 If Transient Mark mode is enabled, the mark is active, and N is 1,
901 delete the text in the region and deactivate the mark instead.
902 To disable this, set option `delete-active-region' to nil.
904 Optional second arg KILLFLAG, if non-nil, means to kill (save in
905 kill ring) instead of delete. Interactively, N is the prefix
906 arg, and KILLFLAG is set if N is explicitly specified.
908 In Overwrite mode, single character backward deletion may replace
909 tabs with spaces so as to back over columns, unless point is at
910 the end of the line."
915 delete-active-region
917 ;; If a region is active, kill or delete it.
921 ;; In Overwrite mode, maybe untabify while deleting
931 ;; Otherwise, do simple deletion.
935 "Delete the following N characters (previous if N is negative).
936 If Transient Mark mode is enabled, the mark is active, and N is 1,
937 delete the text in the region and deactivate the mark instead.
938 To disable this, set variable `delete-active-region' to nil.
940 Optional second arg KILLFLAG non-nil means to kill (save in kill
941 ring) instead of delete. Interactively, N is the prefix arg, and
942 KILLFLAG is set if N was explicitly specified."
947 delete-active-region
949 ;; If a region is active, kill or delete it.
953 ;; Otherwise, do simple deletion.
957 "Put point at beginning and mark at end of buffer.
958 If narrowing is in effect, only uses the accessible part of the buffer.
959 You probably should not use this function in Lisp programs;
960 it is usually a mistake for a Lisp function to use any subroutine
961 that uses or sets the mark."
966 \f
968 ;; Counting lines, one way or another.
971 "Go to LINE, counting from line 1 at beginning of buffer.
972 If called interactively, a numeric prefix argument specifies
973 LINE; without a numeric prefix argument, read LINE from the
974 minibuffer.
976 If optional argument BUFFER is non-nil, switch to that buffer and
978 as argument, BUFFER is the most recently selected other buffer.
980 Prior to moving point, this function sets the mark (without
981 activating it), unless Transient Mark mode is enabled and the
982 mark is already active.
984 This function is usually the wrong thing to use in a Lisp program.
985 What you probably want instead is something like:
986 (goto-char (point-min))
987 (forward-line (1- N))
988 If at all possible, an even better solution is to use char counts
989 rather than line counts."
993 ;; Look for a default, a number in the buffer at point.
1003 ;; Decide if we're switching buffers.
1011 ;; Read the argument, offering that number (if any) as default.
1014 buffer))))
1015 ;; Switch to the desired buffer, one way or another.
1020 ;; Leave mark at previous position
1022 ;; Move to the specified line number in that buffer.
1031 "Count the number of words in the region.
1032 If called interactively, print a message reporting the number of
1033 lines, words, and characters in the region (whether or not the
1034 region is active); with prefix ARG, report for the entire buffer
1035 rather than the region.
1037 If called from Lisp, return the number of words between positions
1038 START and END."
1050 "Count words between START and END.
1051 If called interactively, START and END are normally the start and
1052 end of the buffer; but if the region is active, START and END are
1053 the start and end of the region. Print a message reporting the
1054 number of lines, words, and chars.
1056 If called from Lisp, return the number of words between START and
1057 END, without printing any message."
1067 words))
1083 str
1091 "Print the current buffer line number and narrowed line number of point."
1104 "Return number of lines between START and END.
1105 This is usually the number of newlines between them,
1106 but can be one more if START is not equal to END
1107 and the greater of them is not at the start of a line."
1123 done)))
1127 "Return (narrowed) buffer line number at position POS.
1128 If POS is nil, use current buffer location.
1129 Counting starts at (point-min), so the value refers
1130 to the contents of the accessible portion of the buffer."
1140 "Print info on cursor position (on screen and within buffer).
1141 Also describe the character after point, and give its character code
1142 in octal, decimal and hex.
1144 For a non-ASCII multibyte character, also give its encoding in the
1145 buffer's selected coding system if the coding system encodes the
1146 character safely. If the character is encoded into one byte, that
1147 code is shown in hex. If the character is encoded into more than one
1150 In addition, with prefix argument, show details about that character
1151 in *Help* buffer. See also the command `describe-char'."
1156 ;; If the character is one of LRE, LRO, RLE, RLO, it
1157 ;; will start a directional embedding, which could
1158 ;; completely disrupt the rest of the line (e.g., RLO
1159 ;; will display the rest of the line right-to-left).
1160 ;; So we put an invisible PDF character after these
1161 ;; characters, to end the embedding, which eliminates
1162 ;; any effects on the rest of the line.
1164 ;; Strong right-to-left characters cause reordering of
1165 ;; the following numerical characters which show the
1166 ;; codepoint, so append LRM to countermand that.
1176 ;; Avoid overflow from multiplying by 100!
1180 ""
1186 pos total percent beg end col hscroll)
1188 pos total col hscroll))
1190 encoded encoding-msg display-prop under-display)
1197 ;; Check if the character is displayed with some `display'
1198 ;; text property. In that case, set under-display to the
1199 ;; buffer substring covered by that property.
1210 under-display)))
1216 char char char under-display)
1218 char char char under-display display-prop))
1221 char char char
1223 "..."
1227 ;; We show the detailed information about CHAR.
1234 bidi-fixer
1235 encoding-msg pos total percent beg end col hscroll)
1242 bidi-fixer encoding-msg pos total percent col hscroll))))))
1243 \f
1244 ;; Initialize read-expression-map. It is defined at C level.
1248 ;; Might as well bind TAB to completion, since inserting a TAB char is
1249 ;; much too rarely useful.
1252 m))
1255 "Return a Lisp object read using the minibuffer, unevaluated.
1256 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1257 is a string to insert in the minibuffer before reading.
1258 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1259 Such arguments are used as in `read-from-minibuffer'.)"
1260 ;; Used for interactive spec `x'.
1262 t minibuffer-history))
1265 "Return value of Lisp expression read using the minibuffer.
1266 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1267 is a string to insert in the minibuffer before reading.
1268 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1269 Such arguments are used as in `read-from-minibuffer'.)"
1270 ;; Used for interactive spec `X'.
1271 ;; FIXME: Share code with `eval-expression'.
1273 t read-expression-history)))
1280 "The current default value or list of default values in the minibuffer.
1281 The functions `read-from-minibuffer' and `completing-read' bind
1285 "Value for `print-level' while printing value in `eval-expression'.
1286 A value of nil means no limit."
1292 "Value for `print-length' while printing value in `eval-expression'.
1293 A value of nil means no limit."
1299 "If non-nil set `debug-on-error' to t in `eval-expression'.
1300 If nil, don't change the value of `debug-on-error'."
1306 "Format VALUE as a result of evaluated expression.
1307 Return a formatted string which is displayed in the echo area
1308 in addition to the value printed by prin1 in functions which
1309 display the result of expression evaluation."
1325 ;; We define this, rather than making `eval' interactive,
1326 ;; for the sake of completion of names like eval-region, eval-buffer.
1328 "Evaluate EXP and print value in the echo area.
1329 When called interactively, read an Emacs Lisp expression and
1330 evaluate it.
1331 Value is also consed on to front of the variable `values'.
1332 Optional argument INSERT-VALUE non-nil (interactively,
1333 with prefix argument) means insert the result into the current buffer
1334 instead of printing it in the echo area. Truncates long output
1335 according to the value of the variables `eval-expression-print-length'
1336 and `eval-expression-print-level'.
1338 If `eval-expression-debug-on-error' is non-nil, which is the default,
1339 this command arranges for all errors to enter the debugger."
1345 nil read-expression-map t
1347 current-prefix-arg))
1352 ;; Bind debug-on-error to something unique so that we can
1353 ;; detect when evalled code changes it.
1357 ;; If evalled code has changed the value of debug-on-error,
1358 ;; propagate that change to the global binding.
1375 "Prompting with PROMPT, let user edit COMMAND and eval result.
1376 COMMAND is a Lisp expression. Let user edit that expression in
1377 the minibuffer, then read and evaluate the result."
1384 read-expression-map t
1386 ;; If command was added to command-history as a string,
1387 ;; get rid of that. We want only evaluable expressions there.
1391 ;; If command to be redone does not match front of history,
1392 ;; add it to the history.
1398 "Edit and re-evaluate last complex command, or ARGth from last.
1399 A complex command is one which used the minibuffer.
1400 The command is placed in the minibuffer as a Lisp form for editing.
1401 The result is executed, repeating the command as changed.
1402 If the command has been changed or is not the most recent previous
1403 command it is added to the front of the command history.
1404 You can use the minibuffer history commands \
1406 to get different commands to edit and resubmit."
1409 newcmd)
1421 ;; If command was added to command-history as a
1422 ;; string, get rid of that. We want only
1423 ;; evaluable expressions there.
1427 ;; If command to be redone does not match front of history,
1428 ;; add it to the history.
1439 "Read command name to invoke in `execute-extended-command'."
1444 ;; Get a command name at point in the original buffer
1445 ;; to propose it after M-n.
1449 ;; Read a string, completing from and restricting to the set of
1450 ;; all defined commands. Don't provide any initial input.
1451 ;; Save the command read on the extended-command history list.
1462 ;; This isn't strictly correct if `execute-extended-command'
1463 ;; is bound to anything else (e.g. [menu]).
1464 ;; It could use (key-description (this-single-command-keys)),
1465 ;; but actually a prompt other than "M-x" would be confusing,
1466 ;; because "M-x" is a well-known prompt to read a command
1467 ;; and it serves as a shorthand for "Extended command: ".
1472 "Non-nil means show the equivalent key-binding when M-x command has one.
1473 The value can be a length of time to show the message for.
1474 If the value is non-nil and not a number, we wait 2 seconds."
1481 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1482 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1483 "Read function name, then read its arguments and call it.
1485 To pass a numeric argument to the command you are invoking, specify
1486 the numeric argument to this command.
1488 Noninteractively, the argument PREFIXARG is the prefix argument to
1489 give to the command you invoke, if it asks for an argument."
1491 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1502 ;; Normally `real-this-command' should never be changed, but here we really
1503 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1504 ;; binding" for <cmd>, so the command the user really wanted to run is
1505 ;; `function' and not `execute-extended-command'. The difference is
1506 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1510 ;; If enabled, show which key runs this command.
1512 ;; But first wait, and skip the message if there is input.
1514 ;; If this command displayed something in the echo area;
1515 ;; wait a few seconds, then display our suggestion message.
1525 suggest-key-bindings
1529 ;; BEWARE: Called directly from the C code.
1530 "Execute CMD as an editor command.
1531 CMD must be a symbol that satisfies the `commandp' predicate.
1532 Optional second arg RECORD-FLAG non-nil
1533 means unconditionally put this command in the variable `command-history'.
1534 Otherwise, that is done only if an arg is read using the minibuffer.
1535 The argument KEYS specifies the value to use instead of (this-command-keys)
1536 when reading the arguments; if it is nil, (this-command-keys) is used.
1537 The argument SPECIAL, if non-nil, means that this command is executing
1538 a special event, so ignore the prefix argument and don't clear it."
1546 ;; FIXME: Weird calling convention!
1556 ;; If requested, place the macro in the command history. For
1557 ;; other sorts of commands, call-interactively takes care of this.
1560 ;; Don't keep command history around forever.
1566 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1574 \f
1576 "Default minibuffer history list.
1577 This is used for all minibuffer input
1578 except when an alternate history list is specified.
1580 Maximum length of the history list is determined by the value
1583 "Control whether history list elements are expressions or strings.
1584 If the value of this variable equals current minibuffer depth,
1585 they are expressions; otherwise they are strings.
1586 \(That convention is designed to do the right thing for
1593 "Text that was in this minibuffer before any history commands.
1594 This is nil if there have not yet been any history commands
1603 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1607 "Minibuffer history variables for which matching should ignore case.
1608 If a history variable is a member of this list, then the
1610 commands ignore case when searching it, regardless of `case-fold-search'."
1615 "Find the previous history element that matches REGEXP.
1616 \(Previous history elements refer to earlier actions.)
1617 With prefix argument N, search for Nth previous match.
1618 If N is negative, find the next or Nth next match.
1619 Normally, history elements are matched case-insensitively if
1620 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1621 makes the search case-sensitive.
1622 See also `minibuffer-history-case-insensitive-variables'."
1626 nil
1627 minibuffer-local-map
1628 nil
1629 'minibuffer-history-search-history
1631 ;; Use the last regexp specified, by default, if input is empty.
1636 regexp)
1646 ;; On some systems, ignore case for file names.
1648 minibuffer-history-case-insensitive-variables)
1649 t
1650 ;; Respect the user's setting for case-fold-search:
1651 case-fold-search)
1652 nil))
1653 prevpos
1654 match-string
1655 match-offset
1662 "No later matching history item"
1683 next-matching-history-element))
1687 "Find the next history element that matches REGEXP.
1688 \(The next history element refers to a more recent action.)
1689 With prefix argument N, search for Nth next match.
1690 If N is negative, find the previous or Nth previous match.
1691 Normally, history elements are matched case-insensitively if
1692 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1693 makes the search case-sensitive."
1697 nil
1698 minibuffer-local-map
1699 nil
1700 'minibuffer-history-search-history
1702 ;; Use the last regexp specified, by default, if input is empty.
1707 regexp)
1714 "Function run by `goto-history-element' before consuming default values.
1715 This is useful to dynamically add more elements to the list of default values
1716 when `goto-history-element' reaches the end of this list.
1717 Before calling this function `goto-history-element' sets the variable
1718 `minibuffer-default-add-done' to t, so it will call this function only
1719 once. In special cases, when this function needs to be called more
1720 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1724 "When nil, add more elements to the end of the list of default values.
1725 The value nil causes `goto-history-element' to add more elements to
1726 the list of defaults when it reaches the end of this list. It does
1732 "Return a list of all completions without the default value.
1733 This function is used to add all elements of the completion table to
1734 the end of the list of defaults just after the default value."
1737 minibuffer-completion-table
1738 minibuffer-completion-predicate)))
1744 "Puts element of the minibuffer history in the minibuffer.
1745 The argument NABS specifies the absolute history position."
1759 elt minibuffer-returned-to-present)
1766 "End of defaults; no next item"
1771 previous-history-element))
1783 minibuffer-default)))
1795 elt))
1799 "Puts next element of the minibuffer history in the minibuffer.
1800 With argument N, it uses the Nth following element."
1806 "Puts previous element of the minibuffer history in the minibuffer.
1807 With argument N, it uses the Nth previous element."
1813 "Get next history element which completes the minibuffer before the point.
1814 The contents of the minibuffer after the point are deleted, and replaced
1815 by the new completion."
1821 n)
1822 ;; next-matching-history-element always puts us at (point-min).
1823 ;; Move to the position we were at before changing the buffer contents.
1824 ;; This is still sensible, because the text before point has not changed.
1828 "\
1829 Get previous history element which completes the minibuffer before the point.
1830 The contents of the minibuffer after the point are deleted, and replaced
1831 by the new completion."
1835 ;; For compatibility with the old subr of the same name.
1837 "Return the display width of the minibuffer prompt.
1838 Return 0 if current buffer is not a minibuffer."
1839 ;; Return the width of everything before the field at the end of
1840 ;; the buffer; this should be 0 for normal buffers.
1842 \f
1843 ;; isearch minibuffer history
1850 "Set up a minibuffer for using isearch to search the minibuffer history.
1851 Intended to be added to `minibuffer-setup-hook'."
1863 "Clean up the minibuffer after terminating isearch in the minibuffer."
1868 "Return the proper search function, for isearch in minibuffer history."
1871 ;; Use standard functions to search within minibuffer text
1873 found)
1874 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1875 ;; searching forward. Lazy-highlight calls this lambda with the
1876 ;; bound arg, so skip the minibuffer prompt.
1880 ;; 1. First try searching in the initial minibuffer text
1883 noerror)
1884 ;; 2. If the above search fails, start putting next/prev history
1885 ;; elements in the minibuffer successively, and search the string
1886 ;; in them. Do this only when bound is nil (i.e. not while
1887 ;; lazy-highlighting search strings in the current minibuffer text).
1899 ;; After putting the next/prev history element, search
1900 ;; the string in them again, until next-history-element
1901 ;; or previous-history-element raises an error at the
1902 ;; beginning/end of history.
1905 ;; For backward search, don't search
1906 ;; in the minibuffer prompt
1908 noerror)))
1909 ;; Return point of the new search result
1911 ;; Return nil when next(prev)-history-element fails
1915 "Display the minibuffer history search prompt.
1916 If there are no search errors, this function displays an overlay with
1917 the isearch prompt which replaces the original minibuffer prompt.
1918 Otherwise, it displays the standard isearch message returned from
1919 the function `isearch-message'."
1921 ;; Use standard function `isearch-message' when not in the minibuffer,
1922 ;; or search fails, or has an error (like incomplete regexp).
1923 ;; This function overwrites minibuffer text with isearch message,
1924 ;; so it's possible to see what is wrong in the search string.
1926 ;; Otherwise, put the overlay with the standard isearch prompt over
1927 ;; the initial minibuffer prompt.
1936 ;; And clear any previous isearch message.
1940 "Wrap the minibuffer history search when search fails.
1941 Move point to the first history element for a forward search,
1942 or to the last history element for a backward search."
1943 ;; When `minibuffer-history-isearch-search' fails on reaching the
1944 ;; beginning/end of the history, wrap the search to the first/last
1945 ;; minibuffer history element.
1953 "Save a function restoring the state of minibuffer history search.
1954 Save `minibuffer-history-position' to the additional state parameter
1955 in the search status stack."
1961 "Restore the minibuffer history search state.
1962 Go to the history element by the absolute history position HIST-POS."
1965 \f
1966 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1970 "Table mapping redo records to the corresponding undo one.
1971 A redo record for undo-in-region maps to t.
1981 "Within a run of consecutive undo commands, list remaining to be undone.
1985 "Undo some previous changes.
1986 Repeat this command to undo more changes.
1987 A numeric ARG serves as a repeat count.
1989 In Transient Mark mode when the mark is active, only undo changes within
1991 as an argument limits undo to changes within the current region."
1993 ;; Make last-command indicate for the next command that this was an undo.
1994 ;; That way, another undo will undo more.
1995 ;; If we get to the end of the undo history and get an error,
1996 ;; another undo command will find the undo history empty
1997 ;; and will get another error. To begin undoing the undos,
1998 ;; you must type some other command.
2000 ;; For an indirect buffer, look in the base buffer for the
2001 ;; auto-save data.
2005 message)
2006 ;; If we get an error in undo-start,
2007 ;; the next command should not be a "consecutive undo".
2008 ;; So set `this-command' to something other than `undo'.
2013 ;; If something (a timer or filter?) changed the buffer
2014 ;; since the previous command, don't continue the undo seq.
2018 ;; If the last undo record made was made by undo
2019 ;; it shows nothing else happened in between.
2026 ;; get rid of initial undo boundary
2028 ;; If we got this far, the next command should be a consecutive undo.
2030 ;; Check to see whether we're hitting a redo record, and if
2031 ;; so, ask the user whether she wants to skip the redo/undo pair.
2039 ;; The equiv entry might point to another redo record if we have done
2040 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2048 ;; Record the fact that the just-generated undo records come from an
2049 ;; undo operation--that is, they are redo records.
2050 ;; In the ordinary case (not within a region), map the redo
2051 ;; record to the following undos.
2052 ;; I don't know how to do that in the undo-in-region case.
2054 ;; Strip any leading undo boundaries there might be, like we do
2055 ;; above when checking.
2059 undo-equiv-table))
2060 ;; Don't specify a position in the undo record for the undo command.
2061 ;; Instead, undoing this should move point to where the change is.
2080 ;; Record what the current undo list says,
2081 ;; so the next command can tell if the buffer was modified in between.
2085 ;; Display a message announcing success.
2090 "Make BUFFER stop keeping undo information.
2091 No argument or nil as argument means do this for the current buffer."
2097 "Undo some previous changes.
2098 Repeat this command to undo more changes.
2099 A numeric ARG serves as a repeat count.
2100 Contrary to `undo', this will not redo a previous undo."
2105 "Non-nil while performing an undo.
2109 "Undo back N undo-boundaries beyond what was already undone recently.
2110 Call `undo-start' to get ready to undo recent changes,
2111 then call `undo-more' one or more times to undo them."
2116 ;; Note: The following, while pulling elements off
2117 ;; `pending-undo-list' will call primitive change functions which
2118 ;; will push more elements onto `buffer-undo-list'.
2124 "Undo N records from the front of the list LIST.
2125 Return what remains of the list."
2127 ;; This is a good feature, but would make undo-start
2128 ;; unable to do what is expected.
2129 ;;(when (null (car (list)))
2130 ;; ;; If the head of the list is a boundary, it is the boundary
2131 ;; ;; preceding this command. Get rid of it and don't count it.
2132 ;; (setq list (cdr list))))
2135 ;; In a writable buffer, enable undoing read-only text that is
2136 ;; so because of text properties.
2138 ;; Don't let `intangible' properties interfere with undo.
2140 ;; We use oldlist only to check for EQ. ++kfs
2146 ;; Handle an integer by setting point to that value.
2149 ;; Element (t . TIME) records previous modtime.
2150 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2151 ;; UNKNOWN_MODTIME_NSECS.
2153 ;; If this records an obsolete save
2154 ;; (not matching the actual disk file)
2155 ;; then don't mark unmodified.
2163 ;; Element (nil PROP VAL BEG . END) is property change.
2168 ;; Element (BEG . END) means range was inserted.
2170 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2171 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2174 ;; Set point first thing, so that undoing this undo
2175 ;; does not send point back to where it is now.
2178 ;; Element (apply FUN . ARGS) means call FUN to undo.
2182 ;; Long format: (apply DELTA START END FUN . ARGS).
2189 ;; Check that the function did what the entry
2190 ;; said it would do.
2200 ;; Element (STRING . POS) means STRING was deleted.
2210 ;; Now that we record marker adjustments
2211 ;; (caused by deletion) for undo,
2212 ;; we should always insert after markers,
2213 ;; so that undoing the marker adjustments
2214 ;; put the markers back in the right place.
2217 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2225 ;; Make sure an apply entry produces at least one undo entry,
2226 ;; so the test in `undo' for continuing an undo series
2227 ;; will work right.
2232 list)
2234 ;; Deep copy of a list
2236 "Make a copy of undo list LIST."
2242 elt))
2245 "Set `pending-undo-list' to the front of the undo list.
2246 The next call to `undo-more' will undo the most recently made change.
2247 If BEG and END are specified, then only undo elements
2248 that apply to text between BEG and END are used; other undo elements
2249 are ignored. If BEG and END are nil, all undo elements are used."
2255 buffer-undo-list)))
2260 "Return a list of undo elements for the region START to END.
2261 The elements come from `buffer-undo-list', but we keep only
2262 the elements inside this region, and discard those outside this region.
2263 If we find an element that crosses an edge of this region,
2264 we stop and ignore all further elements."
2267 undo-adjusted-markers
2268 some-rejected
2269 undo-elt temp-undo-list delta)
2274 ;; This is a "was unmodified" element.
2275 ;; Keep it if we have kept everything thus far.
2282 ;; Don't put two nils together in the list
2296 ;; Loop down the earlier events adjusting their buffer
2297 ;; positions to reflect the fact that a change to the buffer
2298 ;; isn't being undone. We only need to process those element
2299 ;; types which undo-elt-in-region will return as being in
2300 ;; the region since only those types can ever get into the
2301 ;; output
2310 ;; (TEXT . POSITION)
2317 ;; (BEGIN . END)
2322 ;; (nil PROPERTY VALUE BEG . END)
2332 "Determine whether UNDO-ELT falls inside the region START ... END.
2333 If it crosses the edge, we return nil."
2338 t)
2340 nil)
2342 ;; (TEXT . POSITION)
2346 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2347 ;; See if MARKER is inside the region.
2358 ;; (nil PROPERTY VALUE BEG . END)
2363 ;; (BEGIN . END)
2368 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2369 This assumes we have already decided that UNDO-ELT
2370 is not *inside* the region START...END."
2373 ;; (nil PROPERTY VALUE BEG . END)
2378 ;; (BEGIN . END)
2382 ;; Return the first affected buffer position and the delta for an undo element
2383 ;; delta is defined as the change in subsequent buffer positions if we *did*
2384 ;; the undo.
2388 ;; (TEXT . POSITION)
2391 ;; (BEGIN . END)
2398 "If non-nil ask about discarding undo info for the current command.
2399 Normally, Emacs discards the undo info for the current command if
2400 it exceeds `undo-outer-limit'. But if you set this option
2401 non-nil, it asks in the echo area whether to discard the info.
2402 If you answer no, there is a slight risk that Emacs might crash, so
2403 only do it if you really want to undo the command.
2405 This option is mainly intended for debugging. You have to be
2406 careful if you use it for other purposes. Garbage collection is
2407 inhibited while the question is asked, meaning that Emacs might
2408 leak memory. So you should make sure that you do not wait
2409 excessively long before answering the question."
2415 "If non-nil, an extra level of size that's ok in an undo item.
2416 We don't ask the user about truncating the undo list until the
2417 current item gets bigger than this amount.
2422 ;; When the first undo batch in an undo list is longer than
2423 ;; undo-outer-limit, this function gets called to warn the user that
2424 ;; the undo info for the current command was discarded. Garbage
2425 ;; collection is inhibited around the call, so it had better not do a
2426 ;; lot of consing.
2432 ;; Don't ask the question again unless it gets even bigger.
2433 ;; This applies, in particular, if the user quits from the question.
2434 ;; Such a quit quits out of GC, but something else will call GC
2435 ;; again momentarily. It will call this function again,
2436 ;; but we don't want to ask the question again.
2443 t)
2444 nil))
2449 "The undo info was discarded because it exceeded \
2450 `undo-outer-limit'.
2452 This is normal if you executed a command that made a huge change
2453 to the buffer. In that case, to prevent similar problems in the
2454 future, set `undo-outer-limit' to a value that is large enough to
2455 cover the maximum size of normal changes you expect a single
2456 command to make, but not so large that it might exceed the
2457 maximum memory allotted to Emacs.
2459 If you did not execute any such command, the situation is
2460 probably due to a bug and you should report it.
2462 You can disable the popping up of this buffer by adding the entry
2463 \(undo discard-info) to the user option `warning-suppress-types',
2467 t))
2468 \f
2470 "History list for some commands that read shell commands.
2472 Maximum length of the history list is determined by the value
2479 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2480 This buffer is used when `shell-command' or `shell-command-on-region'
2481 is run interactively. A value of nil means that output to stderr and
2488 "Return a list of all commands associated with the current file.
2489 This function is used to add all related commands retrieved by `mailcap'
2490 to the end of the list of defaults just after the default value."
2494 minibuffer-default))
2499 commands))
2510 map)
2514 "Read a shell command from the minibuffer.
2515 The arguments are the same as the ones of `read-from-minibuffer',
2516 except READ and KEYMAP are missing and HIST defaults
2517 to `shell-command-history'."
2525 minibuffer-local-shell-command-map
2526 nil
2528 args)))
2531 "What to do when the output buffer is used by another shell command.
2532 This option specifies how to resolve the conflict where a new command
2533 wants to direct its output to the buffer `*Async Shell Command*',
2534 but this buffer is already taken by another running shell command.
2536 The value `confirm-kill-process' is used to ask for confirmation before
2537 killing the already running process and running a new process
2538 in the same buffer, `confirm-new-buffer' for confirmation before running
2539 the command in a new buffer with a name other than the default buffer name,
2540 `new-buffer' for doing the same without confirmation,
2541 `confirm-rename-buffer' for confirmation before renaming the existing
2542 output buffer and running a new command in the default buffer,
2543 `rename-buffer' for doing the same without confirmation."
2545 confirm-kill-process)
2547 confirm-new-buffer)
2549 new-buffer)
2551 confirm-rename-buffer)
2553 rename-buffer))
2558 "Execute string COMMAND asynchronously in background.
2560 Like `shell-command', but adds `&' at the end of COMMAND
2561 to execute it asynchronously.
2563 The output appears in the buffer `*Async Shell Command*'.
2564 That buffer is in shell mode.
2566 In Elisp, you will often be better served by calling `start-process'
2567 directly, since it offers more control and does not impose the use of a
2568 shell (with its need to quote arguments)."
2578 current-prefix-arg
2579 shell-command-default-error-buffer))
2585 "Execute string COMMAND in inferior shell; display output, if any.
2586 With prefix argument, insert the COMMAND's output at point.
2588 If COMMAND ends in `&', execute it asynchronously.
2589 The output appears in the buffer `*Async Shell Command*'.
2590 That buffer is in shell mode. You can also use
2591 `async-shell-command' that automatically adds `&'.
2593 Otherwise, COMMAND is executed synchronously. The output appears in
2594 the buffer `*Shell Command Output*'. If the output is short enough to
2595 display in the echo area (which is determined by the variables
2596 `resize-mini-windows' and `max-mini-window-height'), it is shown
2597 there, but it is nonetheless available in buffer `*Shell Command
2598 Output*' even though that buffer is not automatically displayed.
2600 To specify a coding system for converting non-ASCII characters
2602 before this command.
2604 Noninteractive callers can specify coding systems by binding
2605 `coding-system-for-read' and `coding-system-for-write'.
2607 The optional second argument OUTPUT-BUFFER, if non-nil,
2608 says to put the output in some other buffer.
2609 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2610 If OUTPUT-BUFFER is not a buffer and not nil,
2611 insert output in current buffer. (This cannot be done asynchronously.)
2612 In either case, the buffer is first erased, and the output is
2613 inserted after point (leaving mark after it).
2615 If the command terminates without error, but generates output,
2617 the output can be displayed in the echo area or in its buffer.
2618 If the output is short enough to display in the echo area
2619 \(determined by the variable `max-mini-window-height' if
2620 `resize-mini-windows' is non-nil), it is shown there.
2621 Otherwise,the buffer containing the output is displayed.
2625 of the output.
2627 If there is no output, or if output is inserted in the current buffer,
2628 then `*Shell Command Output*' is deleted.
2630 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2631 or buffer name to which to direct the command's standard error output.
2632 If it is nil, error output is mingled with regular output.
2633 In an interactive call, the variable `shell-command-default-error-buffer'
2634 specifies the value of ERROR-BUFFER.
2636 In Elisp, you will often be better served by calling `call-process' or
2637 `start-process' directly, since it offers more control and does not impose
2638 the use of a shell (with its need to quote arguments)."
2649 current-prefix-arg
2650 shell-command-default-error-buffer))
2651 ;; Look for a handler in case default-directory is a remote file name.
2659 ;; Output goes in current buffer.
2665 temporary-file-directory)))
2666 nil)))
2669 ;; We do not use -f for csh; we will not support broken use of
2670 ;; .cshrcs. Even the BSD csh manual says to use
2671 ;; "if ($?prompt) exit" before things which are not useful
2672 ;; non-interactively. Besides, if someone wants their other
2673 ;; aliases for shell commands then they can still have them.
2677 t)
2678 nil shell-command-switch command)
2685 ;; Do no formatting while reading error file,
2686 ;; because that can run a shell command, and we
2687 ;; don't want that to cause an infinite recursion.
2689 ;; Put point after the inserted errors.
2693 ;; This is like exchange-point-and-mark, but doesn't
2694 ;; activate the mark. It is cleaner to avoid activation,
2695 ;; even though the command loop would deactivate the mark
2696 ;; because we inserted text.
2700 ;; Output goes in a separate buffer.
2701 ;; Preserve the match data in case called from a program.
2704 ;; Command ending with ampersand means asynchronous.
2708 proc)
2709 ;; Remove the ampersand.
2711 ;; Ask the user what to do with already running process.
2716 ;; If will kill a process, query first.
2721 ;; If will create a new buffer, query first.
2727 ;; It will create a new buffer.
2731 ;; If will rename the buffer, query first.
2740 ;; It will rename the buffer.
2747 ;; Setting buffer-read-only to nil doesn't suffice
2748 ;; if some text has a non-nil read-only property,
2749 ;; which comint sometimes adds for prompts.
2755 shell-command-switch command))
2759 ;; Use the comint filter for proper handling of carriage motion
2760 ;; (see `comint-inhibit-carriage-motion'),.
2762 ))
2763 ;; Otherwise, command is executed synchronously.
2765 output-buffer nil error-buffer)))))))
2769 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2770 MESSAGE may be either a string or a buffer.
2772 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2773 the maximum height of the echo area, as defined by `max-mini-window-height'
2774 if `resize-mini-windows' is non-nil.
2776 Returns either the string shown in the echo area, or when a pop-up
2777 buffer is used, the window used to display it.
2779 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2780 name of the buffer used to display it in the case where a pop-up buffer
2781 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2782 string and it is displayed in the echo area, it is not specified whether
2783 the contents are inserted into the buffer anyway.
2785 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2786 and only used if a buffer is displayed."
2788 ;; Trivial case where we can use the echo area
2792 ;; Trivial case where we can just remove single trailing newline
2795 ;; General case
2798 message
2807 0
2811 (<= lines
2815 max-mini-window-height))
2817 max-mini-window-height)
2821 ;; Don't use the echo area if the output buffer is
2822 ;; already displayed in the selected frame.
2824 ;; Echo area
2830 ;; Buffer
2833 not-this-window frame))))))))
2836 ;; We have a sentinel to prevent insertion of a termination message
2837 ;; in the buffer itself.
2845 &optional output-buffer replace
2846 error-buffer display-error-buffer)
2847 "Execute string COMMAND in inferior shell with region as input.
2848 Normally display output (if any) in temp buffer `*Shell Command Output*';
2849 Prefix arg means replace the region with it. Return the exit code of
2850 COMMAND.
2852 To specify a coding system for converting non-ASCII characters
2854 before this command. By default, the input (from the current buffer)
2855 is encoded using coding-system specified by `process-coding-system-alist',
2856 falling back to `default-process-coding-system' if no match for COMMAND
2857 is found in `process-coding-system-alist'.
2859 Noninteractive callers can specify coding systems by binding
2860 `coding-system-for-read' and `coding-system-for-write'.
2862 If the command generates output, the output may be displayed
2863 in the echo area or in a buffer.
2864 If the output is short enough to display in the echo area
2865 \(determined by the variable `max-mini-window-height' if
2866 `resize-mini-windows' is non-nil), it is shown there.
2867 Otherwise it is displayed in the buffer `*Shell Command Output*'.
2868 The output is available in that buffer in both cases.
2870 If there is output and an error, a message about the error
2871 appears at the end of the output. If there is no output, or if
2872 output is inserted in the current buffer, the buffer `*Shell
2873 Command Output*' is deleted.
2875 Optional fourth arg OUTPUT-BUFFER specifies where to put the
2876 command's output. If the value is a buffer or buffer name, put
2877 the output there. Any other value, excluding nil, means to
2878 insert the output in the current buffer. In either case, the
2879 output is inserted after point (leaving mark after it).
2881 Optional fifth arg REPLACE, if non-nil, means to insert the
2882 output in place of text from START to END, putting point and mark
2883 around it.
2885 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
2886 or buffer name to which to direct the command's standard error
2887 output. If nil, error output is mingled with regular output.
2888 When called interactively, `shell-command-default-error-buffer'
2889 is used for ERROR-BUFFER.
2891 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
2892 display the error buffer if there were any errors. When called
2893 interactively, this is t."
2897 ;; Do this before calling region-beginning
2898 ;; and region-end, in case subprocess output
2899 ;; relocates them while we are in the minibuffer.
2901 ;; call-interactively recognizes region-beginning and
2902 ;; region-end specially, leaving them in the history.
2904 string
2905 current-prefix-arg
2906 current-prefix-arg
2907 shell-command-default-error-buffer
2908 t)))
2914 temporary-file-directory)))
2915 nil))
2916 exit-status)
2920 ;; Replace specified region with output from command.
2922 ;; Don't muck with mark unless REPLACE says we should.
2929 t)
2930 nil shell-command-switch command))
2931 ;; It is rude to delete a buffer which the command is not using.
2932 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2933 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2934 ;; (kill-buffer shell-buffer)))
2935 ;; Don't muck with mark unless REPLACE says we should.
2937 ;; No prefix argument: put the output in a temp buffer,
2938 ;; replacing its entire contents.
2943 ;; If the input is the same buffer as the output,
2944 ;; delete everything but the specified region,
2945 ;; then replace that region with the output.
2951 shell-file-name t
2954 t)
2955 nil shell-command-switch
2956 command)))
2957 ;; Clear the output buffer, then run the command with
2958 ;; output there.
2969 buffer)
2970 nil shell-command-switch command)))
2971 ;; Report the output.
2981 ;; There's some output, display it
2983 ;; No output; error?
2990 shell-command-default-error-buffer)
2997 output))
3000 exit-status))
3003 exit-status output))))
3004 ;; Don't kill: there might be useful info in the undo-log.
3005 ;; (kill-buffer buffer)
3006 ))))
3014 ;; Do no formatting while reading error file,
3015 ;; because that can run a shell command, and we
3016 ;; don't want that to cause an infinite recursion.
3018 ;; Put point after the inserted errors.
3023 exit-status))
3026 "Execute shell command COMMAND and return its output as a string."
3029 standard-output
3033 "Process files synchronously in a separate process.
3034 Similar to `call-process', but may invoke a file handler based on
3035 `default-directory'. The current working directory of the
3036 subprocess is `default-directory'.
3038 File names in INFILE and BUFFER are handled normally, but file
3039 names in ARGS should be relative to `default-directory', as they
3040 are passed to the process verbatim. \(This is a difference to
3041 `call-process' which does not support file handlers for INFILE
3042 and BUFFER.\)
3044 Some file handlers might not support all variants, for example
3045 they might behave as if DISPLAY was nil, regardless of the actual
3046 value passed."
3048 lc stderr-file)
3058 display args)
3064 "Whether a call of `process-file' changes remote files.
3066 By default, this variable is always set to `t', meaning that a
3067 call of `process-file' could potentially change any file on a
3068 remote host. When set to `nil', a file handler could optimize
3069 its behavior with respect to remote file attribute caching.
3071 You should only ever change this variable with a let-binding;
3075 "Start a program in a subprocess. Return the process object for it.
3077 Similar to `start-process', but may invoke a file handler based on
3078 `default-directory'. See Info node `(elisp)Magic File Names'.
3080 This handler ought to run PROGRAM, perhaps on the local host,
3081 perhaps on a remote host that corresponds to `default-directory'.
3082 In the latter case, the local part of `default-directory' becomes
3083 the working directory of the process.
3085 PROGRAM and PROGRAM-ARGS might be file names. They are not
3086 objects of file handler invocation. File handlers might not
3087 support pty association, if PROGRAM is nil."
3091 \f
3092 ;;;; Process menu
3104 "Major mode for listing the processes called by Emacs."
3116 "Recompute the list of processes for the Process List buffer.
3117 Also, delete any process that is exited or signaled."
3130 face link
3133 follow-link t
3134 process-buffer ,buf
3135 action process-menu-visit-buffer)
3144 "datagram"
3161 tabulated-list-entries))))))
3167 "Display a list of all processes.
3168 If optional argument QUERY-ONLY is non-nil, only processes with
3169 the query-on-exit flag set are listed.
3170 Any process listed as exited or signaled is actually eliminated
3171 after the listing is made.
3172 Optional argument BUFFER specifies a buffer to use, instead of
3174 The return value is always nil."
3186 nil)
3187 \f
3191 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
3192 (define-key map [switch-frame] nil)
3193 (define-key map [?\C-u] 'universal-argument-more)
3194 (define-key map [?-] 'universal-argument-minus)
3195 (define-key map [?0] 'digit-argument)
3196 (define-key map [?1] 'digit-argument)
3197 (define-key map [?2] 'digit-argument)
3198 (define-key map [?3] 'digit-argument)
3199 (define-key map [?4] 'digit-argument)
3200 (define-key map [?5] 'digit-argument)
3201 (define-key map [?6] 'digit-argument)
3202 (define-key map [?7] 'digit-argument)
3203 (define-key map [?8] 'digit-argument)
3204 (define-key map [?9] 'digit-argument)
3205 (define-key map [kp-0] 'digit-argument)
3206 (define-key map [kp-1] 'digit-argument)
3207 (define-key map [kp-2] 'digit-argument)
3208 (define-key map [kp-3] 'digit-argument)
3209 (define-key map [kp-4] 'digit-argument)
3210 (define-key map [kp-5] 'digit-argument)
3211 (define-key map [kp-6] 'digit-argument)
3212 (define-key map [kp-7] 'digit-argument)
3213 (define-key map [kp-8] 'digit-argument)
3214 (define-key map [kp-9] 'digit-argument)
3215 (define-key map [kp-subtract] 'universal-argument-minus)
3216 map)
3219 (defvar universal-argument-num-events nil
3220 "Number of argument-specifying events read by `universal-argument'.
3221 `universal-argument-other-key' uses this to discard those events
3222 from (this-command-keys), and reread only the final command.")
3224 (defvar saved-overriding-map t
3225 "The saved value of `overriding-terminal-local-map'.
3229 (defun save&set-overriding-map (map)
3230 "Set `overriding-terminal-local-map' to MAP."
3231 (when (eq saved-overriding-map t)
3232 (setq saved-overriding-map overriding-terminal-local-map)
3233 (setq overriding-terminal-local-map map)))
3235 (defun restore-overriding-map ()
3236 "Restore `overriding-terminal-local-map' to its saved value."
3237 (setq overriding-terminal-local-map saved-overriding-map)
3238 (setq saved-overriding-map t))
3240 (defun universal-argument ()
3241 "Begin a numeric argument for the following command.
3246 multiplies the argument by 4 each time.
3248 which is different in effect from any particular numeric argument.
3250 (interactive)
3251 (setq prefix-arg (list 4))
3252 (setq universal-argument-num-events (length (this-command-keys)))
3253 (save&set-overriding-map universal-argument-map))
3255 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3256 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3257 (defun universal-argument-more (arg)
3258 (interactive "P")
3259 (if (consp arg)
3260 (setq prefix-arg (list (* 4 (car arg))))
3261 (if (eq arg '-)
3262 (setq prefix-arg (list -4))
3263 (setq prefix-arg arg)
3264 (restore-overriding-map)))
3265 (setq universal-argument-num-events (length (this-command-keys))))
3267 (defun negative-argument (arg)
3268 "Begin a negative numeric argument for the next command.
3270 (interactive "P")
3271 (cond ((integerp arg)
3272 (setq prefix-arg (- arg)))
3273 ((eq arg '-)
3274 (setq prefix-arg nil))
3275 (t
3276 (setq prefix-arg '-)))
3277 (setq universal-argument-num-events (length (this-command-keys)))
3278 (save&set-overriding-map universal-argument-map))
3280 (defun digit-argument (arg)
3281 "Part of the numeric argument for the next command.
3283 (interactive "P")
3284 (let* ((char (if (integerp last-command-event)
3285 last-command-event
3286 (get last-command-event 'ascii-character)))
3288 (cond ((integerp arg)
3289 (setq prefix-arg (+ (* arg 10)
3290 (if (< arg 0) (- digit) digit))))
3291 ((eq arg '-)
3292 ;; Treat -0 as just -, so that -01 will work.
3293 (setq prefix-arg (if (zerop digit) '- (- digit))))
3294 (t
3295 (setq prefix-arg digit))))
3296 (setq universal-argument-num-events (length (this-command-keys)))
3297 (save&set-overriding-map universal-argument-map))
3299 ;; For backward compatibility, minus with no modifiers is an ordinary
3300 ;; command if digits have already been entered.
3301 (defun universal-argument-minus (arg)
3302 (interactive "P")
3303 (if (integerp arg)
3304 (universal-argument-other-key arg)
3305 (negative-argument arg)))
3307 ;; Anything else terminates the argument and is left in the queue to be
3308 ;; executed as a command.
3309 (defun universal-argument-other-key (arg)
3310 (interactive "P")
3311 (setq prefix-arg arg)
3312 (let* ((key (this-command-keys))
3313 (keylist (listify-key-sequence key)))
3314 (setq unread-command-events
3315 (append (nthcdr universal-argument-num-events keylist)
3316 unread-command-events)))
3317 (reset-this-command-lengths)
3318 (restore-overriding-map))
3319 \f
3321 (defvar filter-buffer-substring-functions nil
3322 "This variable is a wrapper hook around `filter-buffer-substring'.")
3323 (make-obsolete-variable 'filter-buffer-substring-functions
3324 'filter-buffer-substring-function "24.4")
3326 (defvar filter-buffer-substring-function #'buffer-substring--filter
3327 "Function to perform the filtering in `filter-buffer-substring'.
3328 The function is called with 3 arguments:
3329 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
3330 as those of `filter-buffer-substring' in each case.
3331 It should return the buffer substring between BEG and END, after filtering.")
3333 (defvar buffer-substring-filters nil
3334 "List of filter functions for `filter-buffer-substring'.
3335 Each function must accept a single argument, a string, and return
3336 a string. The buffer substring is passed to the first function
3337 in the list, and the return value of each function is passed to
3338 the next.
3339 As a special convention, point is set to the start of the buffer text
3340 being operated on (i.e., the first argument of `filter-buffer-substring')
3341 before these functions are called.")
3342 (make-obsolete-variable 'buffer-substring-filters
3343 'filter-buffer-substring-function "24.1")
3345 (defun filter-buffer-substring (beg end &optional delete)
3346 "Return the buffer substring between BEG and END, after filtering.
3347 The hook `filter-buffer-substring-function' performs the actual filtering.
3348 By default, no filtering is done.
3350 If DELETE is non-nil, the text between BEG and END is deleted
3351 from the buffer.
3353 This function should be used instead of `buffer-substring',
3354 `buffer-substring-no-properties', or `delete-and-extract-region'
3355 when you want to allow filtering to take place. For example,
3356 major or minor modes can use `filter-buffer-substring-function' to
3357 extract characters that are special to a buffer, and should not
3358 be copied into other buffers."
3359 (funcall filter-buffer-substring-function beg end delete))
3361 (defun buffer-substring--filter (beg end &optional delete)
3362 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
3363 (cond
3364 ((or delete buffer-substring-filters)
3365 (save-excursion
3366 (goto-char beg)
3367 (let ((string (if delete (delete-and-extract-region beg end)
3368 (buffer-substring beg end))))
3369 (dolist (filter buffer-substring-filters)
3370 (setq string (funcall filter string)))
3371 string)))
3372 (t
3373 (buffer-substring beg end)))))
3376 ;;;; Window system cut and paste hooks.
3378 (defvar interprogram-cut-function nil
3379 "Function to call to make a killed region available to other programs.
3380 Most window systems provide a facility for cutting and pasting
3381 text between different programs, such as the clipboard on X and
3382 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3384 This variable holds a function that Emacs calls whenever text is
3385 put in the kill ring, to make the new kill available to other
3386 programs. The function takes one argument, TEXT, which is a
3387 string containing the text which should be made available.")
3389 (defvar interprogram-paste-function nil
3390 "Function to call to get text cut from other programs.
3391 Most window systems provide a facility for cutting and pasting
3392 text between different programs, such as the clipboard on X and
3393 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3395 This variable holds a function that Emacs calls to obtain text
3396 that other programs have provided for pasting. The function is
3397 called with no arguments. If no other program has provided text
3398 to paste, the function should return nil (in which case the
3399 caller, usually `current-kill', should use the top of the Emacs
3400 kill ring). If another program has provided text to paste, the
3401 function should return that text as a string (in which case the
3402 caller should put this string in the kill ring as the latest
3403 kill).
3405 The function may also return a list of strings if the window
3406 system supports multiple selections. The first string will be
3407 used as the pasted text, but the other will be placed in the kill
3408 ring for easy access via `yank-pop'.
3410 Note that the function should return a string only if a program
3411 other than Emacs has provided a string for pasting; if Emacs
3412 provided the most recent string, the function should return nil.
3413 If it is difficult to tell whether Emacs or some other program
3414 provided the current string, it is probably good enough to return
3415 nil if the string is equal (according to `string=') to the last
3416 text Emacs provided.")
3417 \f
3420 ;;;; The kill ring data structure.
3422 (defvar kill-ring nil
3423 "List of killed text sequences.
3424 Since the kill ring is supposed to interact nicely with cut-and-paste
3425 facilities offered by window systems, use of this variable should
3426 interact nicely with `interprogram-cut-function' and
3427 `interprogram-paste-function'. The functions `kill-new',
3428 `kill-append', and `current-kill' are supposed to implement this
3429 interaction; you may want to use them instead of manipulating the kill
3430 ring directly.")
3432 (defcustom kill-ring-max 60
3433 "Maximum length of kill ring before oldest elements are thrown away."
3434 :type 'integer
3435 :group 'killing)
3437 (defvar kill-ring-yank-pointer nil
3438 "The tail of the kill ring whose car is the last thing yanked.")
3440 (defcustom save-interprogram-paste-before-kill nil
3441 "Save clipboard strings into kill ring before replacing them.
3442 When one selects something in another program to paste it into Emacs,
3443 but kills something in Emacs before actually pasting it,
3444 this selection is gone unless this variable is non-nil,
3445 in which case the other program's selection is saved in the `kill-ring'
3447 :type 'boolean
3448 :group 'killing
3449 :version "23.2")
3451 (defcustom kill-do-not-save-duplicates nil
3452 "Do not add a new string to `kill-ring' if it duplicates the last one.
3453 The comparison is done using `equal-including-properties'."
3454 :type 'boolean
3455 :group 'killing
3456 :version "23.2")
3458 (defun kill-new (string &optional replace yank-handler)
3459 "Make STRING the latest kill in the kill ring.
3460 Set `kill-ring-yank-pointer' to point to it.
3461 If `interprogram-cut-function' is non-nil, apply it to STRING.
3462 Optional second argument REPLACE non-nil means that STRING will replace
3463 the front of the kill ring, rather than being added to the list.
3465 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3466 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3467 STRING.
3469 When the yank handler has a non-nil PARAM element, the original STRING
3470 argument is not used by `insert-for-yank'. However, since Lisp code
3471 may access and use elements from the kill ring directly, the STRING
3473 (if (> (length string) 0)
3474 (if yank-handler
3475 (put-text-property 0 (length string)
3476 'yank-handler yank-handler string))
3477 (if yank-handler
3478 (signal 'args-out-of-range
3479 (list string "yank-handler specified for empty string"))))
3480 (unless (and kill-do-not-save-duplicates
3481 ;; Due to text properties such as 'yank-handler that
3482 ;; can alter the contents to yank, comparison using
3483 ;; `equal' is unsafe.
3484 (equal-including-properties string (car kill-ring)))
3485 (if (fboundp 'menu-bar-update-yank-menu)
3486 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3487 (when save-interprogram-paste-before-kill
3488 (let ((interprogram-paste (and interprogram-paste-function
3489 (funcall interprogram-paste-function))))
3490 (when interprogram-paste
3491 (dolist (s (if (listp interprogram-paste)
3492 (nreverse interprogram-paste)
3493 (list interprogram-paste)))
3494 (unless (and kill-do-not-save-duplicates
3495 (equal-including-properties s (car kill-ring)))
3496 (push s kill-ring))))))
3497 (unless (and kill-do-not-save-duplicates
3498 (equal-including-properties string (car kill-ring)))
3499 (if (and replace kill-ring)
3500 (setcar kill-ring string)
3501 (push string kill-ring)
3502 (if (> (length kill-ring) kill-ring-max)
3503 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3504 (setq kill-ring-yank-pointer kill-ring)
3505 (if interprogram-cut-function
3506 (funcall interprogram-cut-function string)))
3507 (set-advertised-calling-convention
3508 'kill-new '(string &optional replace) "23.3")
3510 (defun kill-append (string before-p &optional yank-handler)
3511 "Append STRING to the end of the latest kill in the kill ring.
3512 If BEFORE-P is non-nil, prepend STRING to the kill.
3513 If `interprogram-cut-function' is set, pass the resulting kill to it."
3514 (let* ((cur (car kill-ring)))
3515 (kill-new (if before-p (concat string cur) (concat cur string))
3516 (or (= (length cur) 0)
3517 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3518 yank-handler)))
3519 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3521 (defcustom yank-pop-change-selection nil
3522 "Whether rotating the kill ring changes the window system selection.
3523 If non-nil, whenever the kill ring is rotated (usually via the
3524 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3525 to copy the new kill to the window system selection."
3526 :type 'boolean
3527 :group 'killing
3528 :version "23.1")
3530 (defun current-kill (n &optional do-not-move)
3531 "Rotate the yanking point by N places, and then return that kill.
3532 If N is zero and `interprogram-paste-function' is set to a
3533 function that returns a string or a list of strings, and if that
3534 function doesn't return nil, then that string (or list) is added
3535 to the front of the kill ring and the string (or first string in
3536 the list) is returned as the latest kill.
3538 If N is not zero, and if `yank-pop-change-selection' is
3539 non-nil, use `interprogram-cut-function' to transfer the
3540 kill at the new yank point into the window system selection.
3542 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3543 move the yanking point; just return the Nth kill forward."
3545 (let ((interprogram-paste (and (= n 0)
3546 interprogram-paste-function
3547 (funcall interprogram-paste-function))))
3548 (if interprogram-paste
3549 (progn
3550 ;; Disable the interprogram cut function when we add the new
3551 ;; text to the kill ring, so Emacs doesn't try to own the
3552 ;; selection, with identical text.
3553 (let ((interprogram-cut-function nil))
3554 (if (listp interprogram-paste)
3555 (mapc 'kill-new (nreverse interprogram-paste))
3556 (kill-new interprogram-paste)))
3557 (car kill-ring))
3558 (or kill-ring (error "Kill ring is empty"))
3559 (let ((ARGth-kill-element
3560 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3561 (length kill-ring))
3562 kill-ring)))
3563 (unless do-not-move
3564 (setq kill-ring-yank-pointer ARGth-kill-element)
3565 (when (and yank-pop-change-selection
3566 (> n 0)
3567 interprogram-cut-function)
3568 (funcall interprogram-cut-function (car ARGth-kill-element))))
3569 (car ARGth-kill-element)))))
3573 ;;;; Commands for manipulating the kill ring.
3575 (defcustom kill-read-only-ok nil
3576 "Non-nil means don't signal an error for killing read-only text."
3577 :type 'boolean
3578 :group 'killing)
3580 (defun kill-region (beg end &optional yank-handler)
3582 This deletes the text from the buffer and saves it in the kill ring.
3586 If you want to append the killed region to the last killed text,
3589 If the buffer is read-only, Emacs will beep and refrain from deleting
3590 the text, but put the text in the kill ring anyway. This means that
3591 you can use the killing commands to copy text from a read-only buffer.
3593 Lisp programs should use this function for killing text.
3594 (To delete text, use `delete-region'.)
3595 Supply two arguments, character positions indicating the stretch of text
3596 to be killed.
3598 If the previous command was also a kill command,
3599 the text killed this time appends to the text killed last time
3600 to make one entry in the kill ring."
3601 ;; Pass point first, then mark, because the order matters
3602 ;; when calling kill-append.
3603 (interactive (list (point) (mark)))
3604 (unless (and beg end)
3605 (error "The mark is not set now, so there is no region"))
3606 (condition-case nil
3607 (let ((string (filter-buffer-substring beg end t)))
3608 (when string ;STRING is nil if BEG = END
3609 ;; Add that string to the kill ring, one way or another.
3610 (if (eq last-command 'kill-region)
3611 (kill-append string (< end beg) yank-handler)
3612 (kill-new string nil yank-handler)))
3613 (when (or string (eq last-command 'kill-region))
3614 (setq this-command 'kill-region))
3615 (setq deactivate-mark t)
3616 nil)
3617 ((buffer-read-only text-read-only)
3618 ;; The code above failed because the buffer, or some of the characters
3619 ;; in the region, are read-only.
3620 ;; We should beep, in case the user just isn't aware of this.
3621 ;; However, there's no harm in putting
3622 ;; the region's text in the kill ring, anyway.
3623 (copy-region-as-kill beg end)
3624 ;; Set this-command now, so it will be set even if we get an error.
3625 (setq this-command 'kill-region)
3626 ;; This should barf, if appropriate, and give us the correct error.
3627 (if kill-read-only-ok
3628 (progn (message "Read only text copied to kill ring") nil)
3629 ;; Signal an error if the buffer is read-only.
3630 (barf-if-buffer-read-only)
3631 ;; If the buffer isn't read-only, the text is.
3632 (signal 'text-read-only (list (current-buffer)))))))
3633 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3635 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3636 ;; to get two copies of the text when the user accidentally types M-w and
3637 ;; then corrects it with the intended C-w.
3638 (defun copy-region-as-kill (beg end)
3639 "Save the region as if killed, but don't kill it.
3640 In Transient Mark mode, deactivate the mark.
3641 If `interprogram-cut-function' is non-nil, also save the text for a window
3642 system cut and paste.
3644 This command's old key binding has been given to `kill-ring-save'."
3645 (interactive "r")
3646 (if (eq last-command 'kill-region)
3647 (kill-append (filter-buffer-substring beg end) (< end beg))
3648 (kill-new (filter-buffer-substring beg end)))
3649 (setq deactivate-mark t)
3650 nil)
3652 (defun kill-ring-save (beg end)
3653 "Save the region as if killed, but don't kill it.
3654 In Transient Mark mode, deactivate the mark.
3655 If `interprogram-cut-function' is non-nil, also save the text for a window
3656 system cut and paste.
3658 If you want to append the killed line to the last killed text,
3661 This command is similar to `copy-region-as-kill', except that it gives
3662 visual feedback indicating the extent of the region being copied."
3663 (interactive "r")
3664 (copy-region-as-kill beg end)
3665 ;; This use of called-interactively-p is correct because the code it
3666 ;; controls just gives the user visual feedback.
3667 (if (called-interactively-p 'interactive)
3668 (indicate-copied-region)))
3670 (defun indicate-copied-region (&optional message-len)
3671 "Indicate that the region text has been copied interactively.
3672 If the mark is visible in the selected window, blink the cursor
3673 between point and mark if there is currently no active region
3674 highlighting.
3676 If the mark lies outside the selected window, display an
3677 informative message containing a sample of the copied text. The
3678 optional argument MESSAGE-LEN, if non-nil, specifies the length
3679 of this sample text; it defaults to 40."
3680 (let ((mark (mark t))
3681 (point (point))
3682 ;; Inhibit quitting so we can make a quit here
3683 ;; look like a C-g typed as a command.
3684 (inhibit-quit t))
3685 (if (pos-visible-in-window-p mark (selected-window))
3686 ;; Swap point-and-mark quickly so as to show the region that
3687 ;; was selected. Don't do it if the region is highlighted.
3688 (unless (and (region-active-p)
3689 (face-background 'region))
3690 ;; Swap point and mark.
3691 (set-marker (mark-marker) (point) (current-buffer))
3692 (goto-char mark)
3693 (sit-for blink-matching-delay)
3694 ;; Swap back.
3695 (set-marker (mark-marker) mark (current-buffer))
3696 (goto-char point)
3697 ;; If user quit, deactivate the mark
3698 ;; as C-g would as a command.
3699 (and quit-flag mark-active
3700 (deactivate-mark)))
3701 (let ((len (min (abs (- mark point))
3702 (or message-len 40))))
3703 (if (< point mark)
3704 ;; Don't say "killed"; that is misleading.
3706 (buffer-substring-no-properties (- mark len) mark))
3708 (buffer-substring-no-properties mark (+ mark len))))))))
3710 (defun append-next-kill (&optional interactive)
3711 "Cause following command, if it kills, to append to previous kill.
3712 The argument is used for internal purposes; do not supply one."
3713 (interactive "p")
3714 ;; We don't use (interactive-p), since that breaks kbd macros.
3715 (if interactive
3716 (progn
3717 (setq this-command 'kill-region)
3718 (message "If the next command is a kill, it will append"))
3719 (setq last-command 'kill-region)))
3720 \f
3721 ;; Yanking.
3723 (defcustom yank-handled-properties
3724 '((font-lock-face . yank-handle-font-lock-face-property)
3725 (category . yank-handle-category-property))
3726 "List of special text property handling conditions for yanking.
3727 Each element should have the form (PROP . FUN), where PROP is a
3728 property symbol and FUN is a function. When the `yank' command
3729 inserts text into the buffer, it scans the inserted text for
3730 stretches of text that have `eq' values of the text property
3731 PROP; for each such stretch of text, FUN is called with three
3732 arguments: the property's value in that text, and the start and
3733 end positions of the text.
3735 This is done prior to removing the properties specified by
3736 `yank-excluded-properties'."
3737 :group 'killing
3738 :version "24.3")
3740 ;; This is actually used in subr.el but defcustom does not work there.
3741 (defcustom yank-excluded-properties
3742 '(category field follow-link fontified font-lock-face help-echo
3743 intangible invisible keymap local-map mouse-face read-only
3744 yank-handler)
3745 "Text properties to discard when yanking.
3746 The value should be a list of text properties to discard or t,
3747 which means to discard all text properties.
3749 See also `yank-handled-properties'."
3750 :type '(choice (const :tag "All" t) (repeat symbol))
3751 :group 'killing
3752 :version "24.3")
3754 (defvar yank-window-start nil)
3755 (defvar yank-undo-function nil
3756 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3757 Function is called with two parameters, START and END corresponding to
3758 the value of the mark and point; it is guaranteed that START <= END.
3759 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3761 (defun yank-pop (&optional arg)
3762 "Replace just-yanked stretch of killed text with a different stretch.
3763 This command is allowed only immediately after a `yank' or a `yank-pop'.
3764 At such a time, the region contains a stretch of reinserted
3765 previously-killed text. `yank-pop' deletes that text and inserts in its
3766 place a different stretch of killed text.
3768 With no argument, the previous kill is inserted.
3769 With argument N, insert the Nth previous kill.
3770 If N is negative, this is a more recent kill.
3772 The sequence of kills wraps around, so that after the oldest one
3773 comes the newest one.
3775 When this command inserts killed text into the buffer, it honors
3776 `yank-excluded-properties' and `yank-handler' as described in the
3777 doc string for `insert-for-yank-1', which see."
3778 (interactive "*p")
3779 (if (not (eq last-command 'yank))
3780 (error "Previous command was not a yank"))
3781 (setq this-command 'yank)
3782 (unless arg (setq arg 1))
3783 (let ((inhibit-read-only t)
3784 (before (< (point) (mark t))))
3785 (if before
3786 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3787 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3788 (setq yank-undo-function nil)
3789 (set-marker (mark-marker) (point) (current-buffer))
3790 (insert-for-yank (current-kill arg))
3791 ;; Set the window start back where it was in the yank command,
3792 ;; if possible.
3793 (set-window-start (selected-window) yank-window-start t)
3794 (if before
3795 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3796 ;; It is cleaner to avoid activation, even though the command
3797 ;; loop would deactivate the mark because we inserted text.
3798 (goto-char (prog1 (mark t)
3799 (set-marker (mark-marker) (point) (current-buffer))))))
3800 nil)
3802 (defun yank (&optional arg)
3804 More precisely, reinsert the most recent kill, which is the
3805 stretch of killed text most recently killed OR yanked. Put point
3806 at the end, and set mark at the beginning without activating it.
3808 With argument N, reinsert the Nth most recent kill.
3810 When this command inserts text into the buffer, it honors the
3811 `yank-handled-properties' and `yank-excluded-properties'
3812 variables, and the `yank-handler' text property. See
3813 `insert-for-yank-1' for details.
3816 (interactive "*P")
3817 (setq yank-window-start (window-start))
3818 ;; If we don't get all the way thru, make last-command indicate that
3819 ;; for the following command.
3820 (setq this-command t)
3821 (push-mark (point))
3822 (insert-for-yank (current-kill (cond
3823 ((listp arg) 0)
3824 ((eq arg '-) -2)
3825 (t (1- arg)))))
3826 (if (consp arg)
3827 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3828 ;; It is cleaner to avoid activation, even though the command
3829 ;; loop would deactivate the mark because we inserted text.
3830 (goto-char (prog1 (mark t)
3831 (set-marker (mark-marker) (point) (current-buffer)))))
3832 ;; If we do get all the way thru, make this-command indicate that.
3833 (if (eq this-command t)
3834 (setq this-command 'yank))
3835 nil)
3837 (defun rotate-yank-pointer (arg)
3838 "Rotate the yanking point in the kill ring.
3839 With ARG, rotate that many kills forward (or backward, if negative)."
3840 (interactive "p")
3841 (current-kill arg))
3842 \f
3843 ;; Some kill commands.
3845 ;; Internal subroutine of delete-char
3846 (defun kill-forward-chars (arg)
3847 (if (listp arg) (setq arg (car arg)))
3848 (if (eq arg '-) (setq arg -1))
3849 (kill-region (point) (+ (point) arg)))
3851 ;; Internal subroutine of backward-delete-char
3852 (defun kill-backward-chars (arg)
3853 (if (listp arg) (setq arg (car arg)))
3854 (if (eq arg '-) (setq arg -1))
3855 (kill-region (point) (- (point) arg)))
3857 (defcustom backward-delete-char-untabify-method 'untabify
3858 "The method for untabifying when deleting backward.
3859 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3860 `hungry' -- delete all whitespace, both tabs and spaces;
3861 `all' -- delete all whitespace, including tabs, spaces and newlines;
3862 nil -- just delete one character."
3863 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3864 :version "20.3"
3865 :group 'killing)
3867 (defun backward-delete-char-untabify (arg &optional killp)
3868 "Delete characters backward, changing tabs into spaces.
3869 The exact behavior depends on `backward-delete-char-untabify-method'.
3870 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3871 Interactively, ARG is the prefix arg (default 1)
3872 and KILLP is t if a prefix arg was specified."
3874 (when (eq backward-delete-char-untabify-method 'untabify)
3875 (let ((count arg))
3876 (save-excursion
3877 (while (and (> count 0) (not (bobp)))
3879 (let ((col (current-column)))
3880 (forward-char -1)
3881 (setq col (- col (current-column)))
3882 (insert-char ?\s col)
3883 (delete-char 1)))
3884 (forward-char -1)
3885 (setq count (1- count))))))
3887 ((eq backward-delete-char-untabify-method 'all)
3889 (n (if skip
3890 (let* ((oldpt (point))
3891 (wh (- oldpt (save-excursion
3892 (skip-chars-backward skip)
3893 (constrain-to-field nil oldpt)))))
3894 (+ arg (if (zerop wh) 0 (1- wh))))
3895 arg)))
3896 ;; Avoid warning about delete-backward-char
3897 (with-no-warnings (delete-backward-char n killp))))
3899 (defun zap-to-char (arg char)
3900 "Kill up to and including ARGth occurrence of CHAR.
3901 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3902 Goes backward if ARG is negative; error if CHAR not found."
3903 (interactive (list (prefix-numeric-value current-prefix-arg)
3904 (read-char "Zap to char: " t)))
3905 ;; Avoid "obsolete" warnings for translation-table-for-input.
3906 (with-no-warnings
3907 (if (char-table-p translation-table-for-input)
3908 (setq char (or (aref translation-table-for-input char) char))))
3909 (kill-region (point) (progn
3910 (search-forward (char-to-string char) nil nil arg)
3911 (point))))
3913 ;; kill-line and its subroutines.
3915 (defcustom kill-whole-line nil
3916 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
3917 :type 'boolean
3918 :group 'killing)
3920 (defun kill-line (&optional arg)
3921 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3922 With prefix argument ARG, kill that many lines from point.
3923 Negative arguments kill lines backward.
3924 With zero argument, kills the text before point on the current line.
3927 a number counts as a prefix arg.
3929 To kill a whole line, when point is not at the beginning, type \
3932 If `show-trailing-whitespace' is non-nil, this command will just
3933 kill the rest of the current line, even if there are only
3934 nonblanks there.
3936 If option `kill-whole-line' is non-nil, then this command kills the whole line
3937 including its terminating newline, when used at the beginning of a line
3938 with no argument. As a consequence, you can always kill a whole line
3941 If you want to append the killed line to the last killed text,
3944 If the buffer is read-only, Emacs will beep and refrain from deleting
3945 the line, but put the line in the kill ring anyway. This means that
3946 you can use this command to copy text from a read-only buffer.
3947 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3948 even beep.)"
3949 (interactive "P")
3950 (kill-region (point)
3951 ;; It is better to move point to the other end of the kill
3952 ;; before killing. That way, in a read-only buffer, point
3953 ;; moves across the text that is copied to the kill ring.
3954 ;; The choice has no effect on undo now that undo records
3955 ;; the value of point from before the command was run.
3956 (progn
3957 (if arg
3958 (forward-visible-line (prefix-numeric-value arg))
3959 (if (eobp)
3960 (signal 'end-of-buffer nil))
3961 (let ((end
3962 (save-excursion
3963 (end-of-visible-line) (point))))
3964 (if (or (save-excursion
3965 ;; If trailing whitespace is visible,
3966 ;; don't treat it as nothing.
3967 (unless show-trailing-whitespace
3969 (= (point) end))
3970 (and kill-whole-line (bolp)))
3971 (forward-visible-line 1)
3972 (goto-char end))))
3973 (point))))
3975 (defun kill-whole-line (&optional arg)
3976 "Kill current line.
3977 With prefix ARG, kill that many lines starting from the current line.
3978 If ARG is negative, kill backward. Also kill the preceding newline.
3980 If ARG is zero, kill current line but exclude the trailing newline."
3981 (interactive "p")
3982 (or arg (setq arg 1))
3983 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3984 (signal 'end-of-buffer nil))
3985 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3986 (signal 'beginning-of-buffer nil))
3987 (unless (eq last-command 'kill-region)
3988 (kill-new "")
3989 (setq last-command 'kill-region))
3990 (cond ((zerop arg)
3991 ;; We need to kill in two steps, because the previous command
3992 ;; could have been a kill command, in which case the text
3993 ;; before point needs to be prepended to the current kill
3994 ;; ring entry and the text after point appended. Also, we
3995 ;; need to use save-excursion to avoid copying the same text
3996 ;; twice to the kill ring in read-only buffers.
3997 (save-excursion
3998 (kill-region (point) (progn (forward-visible-line 0) (point))))
3999 (kill-region (point) (progn (end-of-visible-line) (point))))
4000 ((< arg 0)
4001 (save-excursion
4002 (kill-region (point) (progn (end-of-visible-line) (point))))
4003 (kill-region (point)
4004 (progn (forward-visible-line (1+ arg))
4005 (unless (bobp) (backward-char))
4006 (point))))
4007 (t
4008 (save-excursion
4009 (kill-region (point) (progn (forward-visible-line 0) (point))))
4010 (kill-region (point)
4011 (progn (forward-visible-line arg) (point))))))
4013 (defun forward-visible-line (arg)
4014 "Move forward by ARG lines, ignoring currently invisible newlines only.
4015 If ARG is negative, move backward -ARG lines.
4016 If ARG is zero, move to the beginning of the current line."
4017 (condition-case nil
4018 (if (> arg 0)
4019 (progn
4020 (while (> arg 0)
4021 (or (zerop (forward-line 1))
4022 (signal 'end-of-buffer nil))
4023 ;; If the newline we just skipped is invisible,
4024 ;; don't count it.
4025 (let ((prop
4026 (get-char-property (1- (point)) 'invisible)))
4027 (if (if (eq buffer-invisibility-spec t)
4028 prop
4029 (or (memq prop buffer-invisibility-spec)
4030 (assq prop buffer-invisibility-spec)))
4031 (setq arg (1+ arg))))
4032 (setq arg (1- arg)))
4033 ;; If invisible text follows, and it is a number of complete lines,
4034 ;; skip it.
4035 (let ((opoint (point)))
4036 (while (and (not (eobp))
4037 (let ((prop
4038 (get-char-property (point) 'invisible)))
4039 (if (eq buffer-invisibility-spec t)
4040 prop
4041 (or (memq prop buffer-invisibility-spec)
4042 (assq prop buffer-invisibility-spec)))))
4043 (goto-char
4044 (if (get-text-property (point) 'invisible)
4045 (or (next-single-property-change (point) 'invisible)
4046 (point-max))
4047 (next-overlay-change (point)))))
4048 (unless (bolp)
4049 (goto-char opoint))))
4050 (let ((first t))
4051 (while (or first (<= arg 0))
4052 (if first
4053 (beginning-of-line)
4054 (or (zerop (forward-line -1))
4055 (signal 'beginning-of-buffer nil)))
4056 ;; If the newline we just moved to is invisible,
4057 ;; don't count it.
4058 (unless (bobp)
4059 (let ((prop
4060 (get-char-property (1- (point)) 'invisible)))
4061 (unless (if (eq buffer-invisibility-spec t)
4062 prop
4063 (or (memq prop buffer-invisibility-spec)
4064 (assq prop buffer-invisibility-spec)))
4065 (setq arg (1+ arg)))))
4066 (setq first nil))
4067 ;; If invisible text follows, and it is a number of complete lines,
4068 ;; skip it.
4069 (let ((opoint (point)))
4070 (while (and (not (bobp))
4071 (let ((prop
4072 (get-char-property (1- (point)) 'invisible)))
4073 (if (eq buffer-invisibility-spec t)
4074 prop
4075 (or (memq prop buffer-invisibility-spec)
4076 (assq prop buffer-invisibility-spec)))))
4077 (goto-char
4078 (if (get-text-property (1- (point)) 'invisible)
4079 (or (previous-single-property-change (point) 'invisible)
4080 (point-min))
4081 (previous-overlay-change (point)))))
4082 (unless (bolp)
4083 (goto-char opoint)))))
4084 ((beginning-of-buffer end-of-buffer)
4085 nil)))
4087 (defun end-of-visible-line ()
4088 "Move to end of current visible line."
4089 (end-of-line)
4090 ;; If the following character is currently invisible,
4091 ;; skip all characters with that same `invisible' property value,
4092 ;; then find the next newline.
4093 (while (and (not (eobp))
4094 (save-excursion
4096 (let ((prop
4097 (get-char-property (point) 'invisible)))
4098 (if (eq buffer-invisibility-spec t)
4099 prop
4100 (or (memq prop buffer-invisibility-spec)
4101 (assq prop buffer-invisibility-spec))))))
4103 (if (get-text-property (point) 'invisible)
4104 (goto-char (or (next-single-property-change (point) 'invisible)
4105 (point-max)))
4106 (goto-char (next-overlay-change (point))))
4107 (end-of-line)))
4108 \f
4109 (defun insert-buffer (buffer)
4110 "Insert after point the contents of BUFFER.
4111 Puts mark after the inserted text.
4112 BUFFER may be a buffer or a buffer name.
4114 This function is meant for the user to run interactively.
4115 Don't call it from programs: use `insert-buffer-substring' instead!"
4116 (interactive
4117 (list
4118 (progn
4119 (barf-if-buffer-read-only)
4120 (read-buffer "Insert buffer: "
4121 (if (eq (selected-window) (next-window (selected-window)))
4122 (other-buffer (current-buffer))
4123 (window-buffer (next-window (selected-window))))
4124 t))))
4125 (push-mark
4126 (save-excursion
4127 (insert-buffer-substring (get-buffer buffer))
4128 (point)))
4129 nil)
4131 (defun append-to-buffer (buffer start end)
4132 "Append to specified buffer the text of the region.
4133 It is inserted into that buffer before its point.
4135 When calling from a program, give three arguments:
4136 BUFFER (or buffer name), START and END.
4137 START and END specify the portion of the current buffer to be copied."
4138 (interactive
4139 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
4140 (region-beginning) (region-end)))
4141 (let* ((oldbuf (current-buffer))
4142 (append-to (get-buffer-create buffer))
4143 (windows (get-buffer-window-list append-to t t))
4144 point)
4145 (save-excursion
4146 (with-current-buffer append-to
4147 (setq point (point))
4148 (barf-if-buffer-read-only)
4149 (insert-buffer-substring oldbuf start end)
4150 (dolist (window windows)
4151 (when (= (window-point window) point)
4152 (set-window-point window (point))))))))
4154 (defun prepend-to-buffer (buffer start end)
4155 "Prepend to specified buffer the text of the region.
4156 It is inserted into that buffer after its point.
4158 When calling from a program, give three arguments:
4159 BUFFER (or buffer name), START and END.
4160 START and END specify the portion of the current buffer to be copied."
4162 (let ((oldbuf (current-buffer)))
4163 (with-current-buffer (get-buffer-create buffer)
4164 (barf-if-buffer-read-only)
4165 (save-excursion
4166 (insert-buffer-substring oldbuf start end)))))
4168 (defun copy-to-buffer (buffer start end)
4169 "Copy to specified buffer the text of the region.
4170 It is inserted into that buffer, replacing existing text there.
4172 When calling from a program, give three arguments:
4173 BUFFER (or buffer name), START and END.
4174 START and END specify the portion of the current buffer to be copied."
4176 (let ((oldbuf (current-buffer)))
4177 (with-current-buffer (get-buffer-create buffer)
4178 (barf-if-buffer-read-only)
4179 (erase-buffer)
4180 (save-excursion
4181 (insert-buffer-substring oldbuf start end)))))
4182 \f
4183 (put 'mark-inactive 'error-conditions '(mark-inactive error))
4184 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
4186 (defvar activate-mark-hook nil
4187 "Hook run when the mark becomes active.
4188 It is also run at the end of a command, if the mark is active and
4189 it is possible that the region may have changed.")
4191 (defvar deactivate-mark-hook nil
4192 "Hook run when the mark becomes inactive.")
4194 (defun mark (&optional force)
4195 "Return this buffer's mark value as integer, or nil if never set.
4197 In Transient Mark mode, this function signals an error if
4198 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4199 or the argument FORCE is non-nil, it disregards whether the mark
4200 is active, and returns an integer or nil in the usual way.
4202 If you are using this in an editing command, you are most likely making
4203 a mistake; see the documentation of `set-mark'."
4204 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
4205 (marker-position (mark-marker))
4206 (signal 'mark-inactive nil)))
4208 (defun deactivate-mark (&optional force)
4209 "Deactivate the mark.
4210 If Transient Mark mode is disabled, this function normally does
4211 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4213 Deactivating the mark sets `mark-active' to nil, updates the
4214 primary selection according to `select-active-regions', and runs
4215 `deactivate-mark-hook'.
4217 If Transient Mark mode was temporarily enabled, reset the value
4218 of the variable `transient-mark-mode'; if this causes Transient
4219 Mark mode to be disabled, don't change `mark-active' to nil or
4220 run `deactivate-mark-hook'."
4221 (when (or transient-mark-mode force)
4222 (when (and (if (eq select-active-regions 'only)
4223 (eq (car-safe transient-mark-mode) 'only)
4224 select-active-regions)
4225 (region-active-p)
4226 (display-selections-p))
4227 ;; The var `saved-region-selection', if non-nil, is the text in
4228 ;; the region prior to the last command modifying the buffer.
4229 ;; Set the selection to that, or to the current region.
4230 (cond (saved-region-selection
4231 (x-set-selection 'PRIMARY saved-region-selection)
4232 (setq saved-region-selection nil))
4233 ;; If another program has acquired the selection, region
4234 ;; deactivation should not clobber it (Bug#11772).
4235 ((and (/= (region-beginning) (region-end))
4236 (or (x-selection-owner-p 'PRIMARY)
4237 (null (x-selection-exists-p 'PRIMARY))))
4238 (x-set-selection 'PRIMARY
4239 (buffer-substring (region-beginning)
4240 (region-end))))))
4241 (if (and (null force)
4242 (or (eq transient-mark-mode 'lambda)
4243 (and (eq (car-safe transient-mark-mode) 'only)
4244 (null (cdr transient-mark-mode)))))
4245 ;; When deactivating a temporary region, don't change
4246 ;; `mark-active' or run `deactivate-mark-hook'.
4247 (setq transient-mark-mode nil)
4248 (if (eq (car-safe transient-mark-mode) 'only)
4249 (setq transient-mark-mode (cdr transient-mark-mode)))
4250 (setq mark-active nil)
4251 (run-hooks 'deactivate-mark-hook))))
4253 (defun activate-mark ()
4254 "Activate the mark."
4255 (when (mark t)
4256 (setq mark-active t)
4257 (unless transient-mark-mode
4258 (setq transient-mark-mode 'lambda))
4259 (run-hooks 'activate-mark-hook)))
4261 (defun set-mark (pos)
4262 "Set this buffer's mark to POS. Don't use this function!
4263 That is to say, don't use this function unless you want
4264 the user to see that the mark has moved, and you want the previous
4265 mark position to be lost.
4267 Normally, when a new mark is set, the old one should go on the stack.
4268 This is why most applications should use `push-mark', not `set-mark'.
4270 Novice Emacs Lisp programmers often try to use the mark for the wrong
4271 purposes. The mark saves a location for the user's convenience.
4272 Most editing commands should not alter the mark.
4273 To remember a location for internal use in the Lisp program,
4274 store it in a Lisp variable. Example:
4276 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4278 (if pos
4279 (progn
4280 (setq mark-active t)
4281 (run-hooks 'activate-mark-hook)
4282 (set-marker (mark-marker) pos (current-buffer)))
4283 ;; Normally we never clear mark-active except in Transient Mark mode.
4284 ;; But when we actually clear out the mark value too, we must
4285 ;; clear mark-active in any mode.
4286 (deactivate-mark t)
4287 (set-marker (mark-marker) nil)))
4289 (defcustom use-empty-active-region nil
4291 If nil, region-aware commands treat empty regions as inactive.
4292 If non-nil, region-aware commands treat the region as active as
4293 long as the mark is active, even if the region is empty.
4295 Region-aware commands are those that act on the region if it is
4296 active and Transient Mark mode is enabled, and on the text near
4297 point otherwise."
4298 :type 'boolean
4299 :version "23.1"
4300 :group 'editing-basics)
4302 (defun use-region-p ()
4303 "Return t if the region is active and it is appropriate to act on it.
4304 This is used by commands that act specially on the region under
4305 Transient Mark mode.
4307 The return value is t if Transient Mark mode is enabled and the
4308 mark is active; furthermore, if `use-empty-active-region' is nil,
4309 the region must not be empty. Otherwise, the return value is nil.
4311 For some commands, it may be appropriate to ignore the value of
4312 `use-empty-active-region'; in that case, use `region-active-p'."
4313 (and (region-active-p)
4314 (or use-empty-active-region (> (region-end) (region-beginning)))))
4316 (defun region-active-p ()
4317 "Return t if Transient Mark mode is enabled and the mark is active.
4319 Some commands act specially on the region when Transient Mark
4320 mode is enabled. Usually, such commands should use
4321 `use-region-p' instead of this function, because `use-region-p'
4322 also checks the value of `use-empty-active-region'."
4323 (and transient-mark-mode mark-active))
4325 (defvar mark-ring nil
4326 "The list of former marks of the current buffer, most recent first.")
4327 (make-variable-buffer-local 'mark-ring)
4328 (put 'mark-ring 'permanent-local t)
4330 (defcustom mark-ring-max 16
4331 "Maximum size of mark ring. Start discarding off end if gets this big."
4332 :type 'integer
4333 :group 'editing-basics)
4335 (defvar global-mark-ring nil
4336 "The list of saved global marks, most recent first.")
4338 (defcustom global-mark-ring-max 16
4339 "Maximum size of global mark ring. \
4340 Start discarding off end if gets this big."
4341 :type 'integer
4342 :group 'editing-basics)
4344 (defun pop-to-mark-command ()
4345 "Jump to mark, and pop a new position for mark off the ring.
4346 \(Does not affect global mark ring\)."
4347 (interactive)
4348 (if (null (mark t))
4349 (error "No mark set in this buffer")
4350 (if (= (point) (mark t))
4351 (message "Mark popped"))
4352 (goto-char (mark t))
4353 (pop-mark)))
4355 (defun push-mark-command (arg &optional nomsg)
4356 "Set mark at where point is.
4357 If no prefix ARG and mark is already set there, just activate it.
4358 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4359 (interactive "P")
4360 (let ((mark (marker-position (mark-marker))))
4361 (if (or arg (null mark) (/= mark (point)))
4362 (push-mark nil nomsg t)
4363 (setq mark-active t)
4364 (run-hooks 'activate-mark-hook)
4365 (unless nomsg
4366 (message "Mark activated")))))
4368 (defcustom set-mark-command-repeat-pop nil
4371 will pop the mark twice, and
4373 will pop the mark three times.
4377 :type 'boolean
4378 :group 'editing-basics)
4380 (defun set-mark-command (arg)
4381 "Set the mark where point is, or jump to the mark.
4382 Setting the mark also alters the region, which is the text
4383 between point and mark; this is the closest equivalent in
4386 With no prefix argument, set the mark at point, and push the
4387 old mark position on local mark ring. Also push the old mark on
4388 global mark ring, if the previous mark was set in another buffer.
4390 When Transient Mark Mode is off, immediately repeating this
4391 command activates `transient-mark-mode' temporarily.
4394 jump to the mark, and set the mark from
4395 position popped off the local mark ring \(this does not affect the global
4397 mark ring \(see `pop-global-mark'\).
4399 If `set-mark-command-repeat-pop' is non-nil, repeating
4401 off the local (or global) mark ring and jumps there.
4404 argument, unconditionally set mark where point is, even if
4405 `set-mark-command-repeat-pop' is non-nil.
4407 Novice Emacs Lisp programmers often try to use the mark for the wrong
4408 purposes. See the documentation of `set-mark' for more information."
4409 (interactive "P")
4410 (cond ((eq transient-mark-mode 'lambda)
4411 (setq transient-mark-mode nil))
4412 ((eq (car-safe transient-mark-mode) 'only)
4413 (deactivate-mark)))
4414 (cond
4415 ((and (consp arg) (> (prefix-numeric-value arg) 4))
4416 (push-mark-command nil))
4417 ((not (eq this-command 'set-mark-command))
4418 (if arg
4419 (pop-to-mark-command)
4420 (push-mark-command t)))
4421 ((and set-mark-command-repeat-pop
4422 (eq last-command 'pop-to-mark-command))
4423 (setq this-command 'pop-to-mark-command)
4424 (pop-to-mark-command))
4425 ((and set-mark-command-repeat-pop
4426 (eq last-command 'pop-global-mark)
4427 (not arg))
4428 (setq this-command 'pop-global-mark)
4429 (pop-global-mark))
4430 (arg
4431 (setq this-command 'pop-to-mark-command)
4432 (pop-to-mark-command))
4433 ((eq last-command 'set-mark-command)
4434 (if (region-active-p)
4435 (progn
4436 (deactivate-mark)
4437 (message "Mark deactivated"))
4438 (activate-mark)
4439 (message "Mark activated")))
4440 (t
4441 (push-mark-command nil))))
4443 (defun push-mark (&optional location nomsg activate)
4444 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4445 If the last global mark pushed was not in the current buffer,
4446 also push LOCATION on the global mark ring.
4447 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4449 Novice Emacs Lisp programmers often try to use the mark for the wrong
4450 purposes. See the documentation of `set-mark' for more information.
4452 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4453 (unless (null (mark t))
4454 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
4455 (when (> (length mark-ring) mark-ring-max)
4456 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
4457 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
4458 (set-marker (mark-marker) (or location (point)) (current-buffer))
4459 ;; Now push the mark on the global mark ring.
4460 (if (and global-mark-ring
4461 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
4462 ;; The last global mark pushed was in this same buffer.
4463 ;; Don't push another one.
4464 nil
4465 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4466 (when (> (length global-mark-ring) global-mark-ring-max)
4467 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4468 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4469 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4470 (message "Mark set"))
4471 (if (or activate (not transient-mark-mode))
4472 (set-mark (mark t)))
4473 nil)
4475 (defun pop-mark ()
4476 "Pop off mark ring into the buffer's actual mark.
4477 Does not set point. Does nothing if mark ring is empty."
4478 (when mark-ring
4479 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4480 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4481 (move-marker (car mark-ring) nil)
4482 (if (null (mark t)) (ding))
4483 (setq mark-ring (cdr mark-ring)))
4484 (deactivate-mark))
4486 (define-obsolete-function-alias
4487 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4488 (defun exchange-point-and-mark (&optional arg)
4489 "Put the mark where point is now, and point where the mark is now.
4490 This command works even when the mark is not active,
4491 and it reactivates the mark.
4493 If Transient Mark mode is on, a prefix ARG deactivates the mark
4494 if it is active, and otherwise avoids reactivating it. If
4495 Transient Mark mode is off, a prefix ARG enables Transient Mark
4496 mode temporarily."
4497 (interactive "P")
4498 (let ((omark (mark t))
4499 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4500 (if (null omark)
4501 (error "No mark set in this buffer"))
4502 (deactivate-mark)
4503 (set-mark (point))
4504 (goto-char omark)
4505 (cond (temp-highlight
4506 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4507 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4508 (not (or arg (region-active-p))))
4509 (deactivate-mark))
4510 (t (activate-mark)))
4511 nil))
4513 (defcustom shift-select-mode t
4514 "When non-nil, shifted motion keys activate the mark momentarily.
4516 While the mark is activated in this way, any shift-translated point
4517 motion key extends the region, and if Transient Mark mode was off, it
4518 is temporarily turned on. Furthermore, the mark will be deactivated
4519 by any subsequent point motion key that was not shift-translated, or
4520 by any action that normally deactivates the mark in Transient Mark mode.
4522 See `this-command-keys-shift-translated' for the meaning of
4523 shift-translation."
4524 :type 'boolean
4525 :group 'editing-basics)
4527 (defun handle-shift-selection ()
4528 "Activate/deactivate mark depending on invocation thru shift translation.
4529 This function is called by `call-interactively' when a command
4530 with a `^' character in its `interactive' spec is invoked, before
4531 running the command itself.
4533 If `shift-select-mode' is enabled and the command was invoked
4534 through shift translation, set the mark and activate the region
4535 temporarily, unless it was already set in this way. See
4536 `this-command-keys-shift-translated' for the meaning of shift
4537 translation.
4539 Otherwise, if the region has been activated temporarily,
4540 deactivate it, and restore the variable `transient-mark-mode' to
4541 its earlier value."
4542 (cond ((and shift-select-mode this-command-keys-shift-translated)
4543 (unless (and mark-active
4544 (eq (car-safe transient-mark-mode) 'only))
4545 (setq transient-mark-mode
4546 (cons 'only
4547 (unless (eq transient-mark-mode 'lambda)
4548 transient-mark-mode)))
4549 (push-mark nil nil t)))
4550 ((eq (car-safe transient-mark-mode) 'only)
4551 (setq transient-mark-mode (cdr transient-mark-mode))
4552 (deactivate-mark))))
4554 (define-minor-mode transient-mark-mode
4555 "Toggle Transient Mark mode.
4556 With a prefix argument ARG, enable Transient Mark mode if ARG is
4557 positive, and disable it otherwise. If called from Lisp, enable
4558 Transient Mark mode if ARG is omitted or nil.
4560 Transient Mark mode is a global minor mode. When enabled, the
4561 region is highlighted whenever the mark is active. The mark is
4563 operations that set the mark but whose main purpose is something
4569 Many commands change their behavior when Transient Mark mode is
4570 in effect and the mark is active, by acting on the region instead
4571 of their usual default part of the buffer's text. Examples of
4574 To see the documentation of commands which are sensitive to the
4577 :global t
4578 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4579 :variable transient-mark-mode)
4581 (defvar widen-automatically t
4582 "Non-nil means it is ok for commands to call `widen' when they want to.
4583 Some commands will do this in order to go to positions outside
4584 the current accessible part of the buffer.
4586 If `widen-automatically' is nil, these commands will do something else
4587 as a fallback, and won't change the buffer bounds.")
4589 (defvar non-essential nil
4590 "Whether the currently executing code is performing an essential task.
4591 This variable should be non-nil only when running code which should not
4592 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4593 user for a password when we are simply scanning a set of files in the
4594 background or displaying possible completions before the user even asked
4595 for it.")
4597 (defun pop-global-mark ()
4598 "Pop off global mark ring and jump to the top location."
4599 (interactive)
4600 ;; Pop entries which refer to non-existent buffers.
4601 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4602 (setq global-mark-ring (cdr global-mark-ring)))
4603 (or global-mark-ring
4604 (error "No global mark set"))
4605 (let* ((marker (car global-mark-ring))
4606 (buffer (marker-buffer marker))
4607 (position (marker-position marker)))
4608 (setq global-mark-ring (nconc (cdr global-mark-ring)
4609 (list (car global-mark-ring))))
4610 (set-buffer buffer)
4611 (or (and (>= position (point-min))
4612 (<= position (point-max)))
4613 (if widen-automatically
4614 (widen)
4615 (error "Global mark position is outside accessible part of buffer")))
4616 (goto-char position)
4617 (switch-to-buffer buffer)))
4618 \f
4619 (defcustom next-line-add-newlines nil
4620 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4621 :type 'boolean
4622 :version "21.1"
4623 :group 'editing-basics)
4625 (defun next-line (&optional arg try-vscroll)
4626 "Move cursor vertically down ARG lines.
4627 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4628 If there is no character in the target line exactly under the current column,
4629 the cursor is positioned after the character in that line which spans this
4630 column, or at the end of the line if it is not long enough.
4631 If there is no line in the buffer after this one, behavior depends on the
4632 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4633 to create a line, and moves the cursor to that line. Otherwise it moves the
4634 cursor to the end of the buffer.
4636 If the variable `line-move-visual' is non-nil, this command moves
4637 by display lines. Otherwise, it moves by buffer lines, without
4638 taking variable-width characters or continued lines into account.
4641 a semipermanent goal column for this command.
4642 Then instead of trying to move exactly vertically (or as close as possible),
4643 this command moves to the specified goal column (or as close as possible).
4644 The goal column is stored in the variable `goal-column', which is nil
4645 when there is no goal column. Note that setting `goal-column'
4646 overrides `line-move-visual' and causes this command to move by buffer
4647 lines rather than by display lines.
4649 If you are thinking of using this in a Lisp program, consider
4650 using `forward-line' instead. It is usually easier to use
4651 and more reliable (no dependence on goal column, etc.)."
4653 (or arg (setq arg 1))
4654 (if (and next-line-add-newlines (= arg 1))
4655 (if (save-excursion (end-of-line) (eobp))
4656 ;; When adding a newline, don't expand an abbrev.
4657 (let ((abbrev-mode nil))
4658 (end-of-line)
4660 (line-move arg nil nil try-vscroll))
4661 (if (called-interactively-p 'interactive)
4662 (condition-case err
4663 (line-move arg nil nil try-vscroll)
4664 ((beginning-of-buffer end-of-buffer)
4665 (signal (car err) (cdr err))))
4666 (line-move arg nil nil try-vscroll)))
4667 nil)
4669 (defun previous-line (&optional arg try-vscroll)
4670 "Move cursor vertically up ARG lines.
4671 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4672 If there is no character in the target line exactly over the current column,
4673 the cursor is positioned after the character in that line which spans this
4674 column, or at the end of the line if it is not long enough.
4676 If the variable `line-move-visual' is non-nil, this command moves
4677 by display lines. Otherwise, it moves by buffer lines, without
4678 taking variable-width characters or continued lines into account.
4681 a semipermanent goal column for this command.
4682 Then instead of trying to move exactly vertically (or as close as possible),
4683 this command moves to the specified goal column (or as close as possible).
4684 The goal column is stored in the variable `goal-column', which is nil
4685 when there is no goal column. Note that setting `goal-column'
4686 overrides `line-move-visual' and causes this command to move by buffer
4687 lines rather than by display lines.
4689 If you are thinking of using this in a Lisp program, consider using
4690 `forward-line' with a negative argument instead. It is usually easier
4691 to use and more reliable (no dependence on goal column, etc.)."
4693 (or arg (setq arg 1))
4694 (if (called-interactively-p 'interactive)
4695 (condition-case err
4696 (line-move (- arg) nil nil try-vscroll)
4697 ((beginning-of-buffer end-of-buffer)
4698 (signal (car err) (cdr err))))
4699 (line-move (- arg) nil nil try-vscroll))
4700 nil)
4702 (defcustom track-eol nil
4703 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4704 This means moving to the end of each line moved onto.
4705 The beginning of a blank line does not count as the end of a line.
4706 This has no effect when the variable `line-move-visual' is non-nil."
4707 :type 'boolean
4708 :group 'editing-basics)
4710 (defcustom goal-column nil
4712 A non-nil setting overrides the variable `line-move-visual', which see."
4713 :type '(choice integer
4714 (const :tag "None" nil))
4715 :group 'editing-basics)
4716 (make-variable-buffer-local 'goal-column)
4718 (defvar temporary-goal-column 0
4719 "Current goal column for vertical motion.
4720 It is the column where point was at the start of the current run
4721 of vertical motion commands.
4723 When moving by visual lines via the function `line-move-visual', it is a cons
4724 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4725 divided by the default column width, and HSCROLL is the number of
4726 columns by which window is scrolled from left margin.
4728 When the `track-eol' feature is doing its job, the value is
4729 `most-positive-fixnum'.")
4731 (defcustom line-move-ignore-invisible t
4733 Outline mode sets this."
4734 :type 'boolean
4735 :group 'editing-basics)
4737 (defcustom line-move-visual t
4738 "When non-nil, `line-move' moves point by visual lines.
4739 This movement is based on where the cursor is displayed on the
4740 screen, instead of relying on buffer contents alone. It takes
4741 into account variable-width characters and line continuation.
4742 If nil, `line-move' moves point by logical lines.
4743 A non-nil setting of `goal-column' overrides the value of this variable
4744 and forces movement by logical lines.
4745 A window that is horizontally scrolled also forces movement by logical
4746 lines."
4747 :type 'boolean
4748 :group 'editing-basics
4749 :version "23.1")
4751 ;; Returns non-nil if partial move was done.
4752 (defun line-move-partial (arg noerror to-end)
4753 (if (< arg 0)
4754 ;; Move backward (up).
4755 ;; If already vscrolled, reduce vscroll
4756 (let ((vs (window-vscroll nil t)))
4757 (when (> vs (frame-char-height))
4758 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4760 ;; Move forward (down).
4761 (let* ((lh (window-line-height -1))
4762 (vpos (nth 1 lh))
4763 (ypos (nth 2 lh))
4764 (rbot (nth 3 lh))
4765 py vs)
4766 (when (or (null lh)
4767 (>= rbot (frame-char-height))
4768 (<= ypos (- (frame-char-height))))
4769 (unless lh
4770 (let ((wend (pos-visible-in-window-p t nil t)))
4771 (setq rbot (nth 3 wend)
4772 vpos (nth 5 wend))))
4773 (cond
4774 ;; If last line of window is fully visible, move forward.
4775 ((or (null rbot) (= rbot 0))
4776 nil)
4777 ;; If cursor is not in the bottom scroll margin, move forward.
4778 ((and (> vpos 0)
4779 (< (setq py
4780 (or (nth 1 (window-line-height))
4781 (let ((ppos (posn-at-point)))
4782 (cdr (or (posn-actual-col-row ppos)
4783 (posn-col-row ppos))))))
4784 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4785 nil)
4786 ;; When already vscrolled, we vscroll some more if we can,
4787 ;; or clear vscroll and move forward at end of tall image.
4788 ((> (setq vs (window-vscroll nil t)) 0)
4789 (when (> rbot 0)
4790 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4791 ;; If cursor just entered the bottom scroll margin, move forward,
4792 ;; but also vscroll one line so redisplay won't recenter.
4793 ((and (> vpos 0)
4794 (= py (min (- (window-text-height) scroll-margin 1)
4795 (1- vpos))))
4796 (set-window-vscroll nil (frame-char-height) t)
4797 (line-move-1 arg noerror to-end)
4798 t)
4799 ;; If there are lines above the last line, scroll-up one line.
4800 ((> vpos 0)
4801 (scroll-up 1)
4802 t)
4803 ;; Finally, start vscroll.
4804 (t
4805 (set-window-vscroll nil (frame-char-height) t)))))))
4808 ;; This is like line-move-1 except that it also performs
4809 ;; vertical scrolling of tall images if appropriate.
4810 ;; That is not really a clean thing to do, since it mixes
4811 ;; scrolling with cursor motion. But so far we don't have
4812 ;; a cleaner solution to the problem of making C-n do something
4813 ;; useful given a tall image.
4814 (defun line-move (arg &optional noerror to-end try-vscroll)
4815 (if noninteractive
4816 (forward-line arg)
4817 (unless (and auto-window-vscroll try-vscroll
4818 ;; Only vscroll for single line moves
4819 (= (abs arg) 1)
4820 ;; Under scroll-conservatively, the display engine
4821 ;; does this better.
4822 (zerop scroll-conservatively)
4823 ;; But don't vscroll in a keyboard macro.
4824 (not defining-kbd-macro)
4825 (not executing-kbd-macro)
4826 (line-move-partial arg noerror to-end))
4827 (set-window-vscroll nil 0 t)
4828 (if (and line-move-visual
4829 ;; Display-based column are incompatible with goal-column.
4830 (not goal-column)
4831 ;; When the text in the window is scrolled to the left,
4832 ;; display-based motion doesn't make sense (because each
4833 ;; logical line occupies exactly one screen line).
4834 (not (> (window-hscroll) 0)))
4835 (line-move-visual arg noerror)
4836 (line-move-1 arg noerror to-end)))))
4838 ;; Display-based alternative to line-move-1.
4839 ;; Arg says how many lines to move. The value is t if we can move the
4840 ;; specified number of lines.
4841 (defun line-move-visual (arg &optional noerror)
4842 (let ((opoint (point))
4843 (hscroll (window-hscroll))
4844 target-hscroll)
4845 ;; Check if the previous command was a line-motion command, or if
4846 ;; we were called from some other command.
4847 (if (and (consp temporary-goal-column)
4848 (memq last-command `(next-line previous-line ,this-command)))
4849 ;; If so, there's no need to reset `temporary-goal-column',
4850 ;; but we may need to hscroll.
4851 (if (or (/= (cdr temporary-goal-column) hscroll)
4852 (> (cdr temporary-goal-column) 0))
4853 (setq target-hscroll (cdr temporary-goal-column)))
4854 ;; Otherwise, we should reset `temporary-goal-column'.
4855 (let ((posn (posn-at-point)))
4856 (cond
4857 ;; Handle the `overflow-newline-into-fringe' case:
4858 ((eq (nth 1 posn) 'right-fringe)
4859 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4860 ((car (posn-x-y posn))
4861 (setq temporary-goal-column
4862 (cons (/ (float (car (posn-x-y posn)))
4863 (frame-char-width)) hscroll))))))
4864 (if target-hscroll
4865 (set-window-hscroll (selected-window) target-hscroll))
4866 ;; vertical-motion can move more than it was asked to if it moves
4867 ;; across display strings with newlines. We don't want to ring
4868 ;; the bell and announce beginning/end of buffer in that case.
4869 (or (and (or (and (>= arg 0)
4870 (>= (vertical-motion
4871 (cons (or goal-column
4872 (if (consp temporary-goal-column)
4873 (car temporary-goal-column)
4874 temporary-goal-column))
4875 arg))
4876 arg))
4877 (and (< arg 0)
4878 (<= (vertical-motion
4879 (cons (or goal-column
4880 (if (consp temporary-goal-column)
4881 (car temporary-goal-column)
4882 temporary-goal-column))
4883 arg))
4884 arg)))
4885 (or (>= arg 0)
4886 (/= (point) opoint)
4887 ;; If the goal column lies on a display string,
4888 ;; `vertical-motion' advances the cursor to the end
4889 ;; of the string. For arg < 0, this can cause the
4890 ;; cursor to get stuck. (Bug#3020).
4891 (= (vertical-motion arg) arg)))
4892 (unless noerror
4893 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4894 nil)))))
4896 ;; This is the guts of next-line and previous-line.
4897 ;; Arg says how many lines to move.
4898 ;; The value is t if we can move the specified number of lines.
4899 (defun line-move-1 (arg &optional noerror _to-end)
4900 ;; Don't run any point-motion hooks, and disregard intangibility,
4901 ;; for intermediate positions.
4902 (let ((inhibit-point-motion-hooks t)
4903 (opoint (point))
4904 (orig-arg arg))
4905 (if (consp temporary-goal-column)
4906 (setq temporary-goal-column (+ (car temporary-goal-column)
4907 (cdr temporary-goal-column))))
4908 (unwind-protect
4909 (progn
4910 (if (not (memq last-command '(next-line previous-line)))
4911 (setq temporary-goal-column
4912 (if (and track-eol (eolp)
4913 ;; Don't count beg of empty line as end of line
4914 ;; unless we just did explicit end-of-line.
4915 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4916 most-positive-fixnum
4917 (current-column))))
4919 (if (not (or (integerp selective-display)
4920 line-move-ignore-invisible))
4921 ;; Use just newline characters.
4922 ;; Set ARG to 0 if we move as many lines as requested.
4923 (or (if (> arg 0)
4924 (progn (if (> arg 1) (forward-line (1- arg)))
4925 ;; This way of moving forward ARG lines
4926 ;; verifies that we have a newline after the last one.
4927 ;; It doesn't get confused by intangible text.
4928 (end-of-line)
4929 (if (zerop (forward-line 1))
4930 (setq arg 0)))
4931 (and (zerop (forward-line arg))
4932 (bolp)
4933 (setq arg 0)))
4934 (unless noerror
4935 (signal (if (< arg 0)
4936 'beginning-of-buffer
4937 'end-of-buffer)
4938 nil)))
4939 ;; Move by arg lines, but ignore invisible ones.
4940 (let (done)
4941 (while (and (> arg 0) (not done))
4942 ;; If the following character is currently invisible,
4943 ;; skip all characters with that same `invisible' property value.
4944 (while (and (not (eobp)) (invisible-p (point)))
4945 (goto-char (next-char-property-change (point))))
4946 ;; Move a line.
4947 ;; We don't use `end-of-line', since we want to escape
4948 ;; from field boundaries occurring exactly at point.
4949 (goto-char (constrain-to-field
4950 (let ((inhibit-field-text-motion t))
4951 (line-end-position))
4952 (point) t t
4953 'inhibit-line-move-field-capture))
4954 ;; If there's no invisibility here, move over the newline.
4955 (cond
4956 ((eobp)
4957 (if (not noerror)
4958 (signal 'end-of-buffer nil)
4959 (setq done t)))
4960 ((and (> arg 1) ;; Use vertical-motion for last move
4961 (not (integerp selective-display))
4962 (not (invisible-p (point))))
4963 ;; We avoid vertical-motion when possible
4964 ;; because that has to fontify.
4965 (forward-line 1))
4966 ;; Otherwise move a more sophisticated way.
4967 ((zerop (vertical-motion 1))
4968 (if (not noerror)
4969 (signal 'end-of-buffer nil)
4970 (setq done t))))
4971 (unless done
4972 (setq arg (1- arg))))
4973 ;; The logic of this is the same as the loop above,
4974 ;; it just goes in the other direction.
4975 (while (and (< arg 0) (not done))
4976 ;; For completely consistency with the forward-motion
4977 ;; case, we should call beginning-of-line here.
4978 ;; However, if point is inside a field and on a
4979 ;; continued line, the call to (vertical-motion -1)
4980 ;; below won't move us back far enough; then we return
4981 ;; to the same column in line-move-finish, and point
4982 ;; gets stuck -- cyd
4983 (forward-line 0)
4984 (cond
4985 ((bobp)
4986 (if (not noerror)
4987 (signal 'beginning-of-buffer nil)
4988 (setq done t)))
4989 ((and (< arg -1) ;; Use vertical-motion for last move
4990 (not (integerp selective-display))
4991 (not (invisible-p (1- (point)))))
4992 (forward-line -1))
4993 ((zerop (vertical-motion -1))
4994 (if (not noerror)
4995 (signal 'beginning-of-buffer nil)
4996 (setq done t))))
4997 (unless done
4998 (setq arg (1+ arg))
4999 (while (and ;; Don't move over previous invis lines
5000 ;; if our target is the middle of this line.
5001 (or (zerop (or goal-column temporary-goal-column))
5002 (< arg 0))
5003 (not (bobp)) (invisible-p (1- (point))))
5004 (goto-char (previous-char-property-change (point))))))))
5005 ;; This is the value the function returns.
5006 (= arg 0))
5008 (cond ((> arg 0)
5009 ;; If we did not move down as far as desired, at least go
5010 ;; to end of line. Be sure to call point-entered and
5011 ;; point-left-hooks.
5012 (let* ((npoint (prog1 (line-end-position)
5013 (goto-char opoint)))
5014 (inhibit-point-motion-hooks nil))
5015 (goto-char npoint)))
5016 ((< arg 0)
5017 ;; If we did not move up as far as desired,
5018 ;; at least go to beginning of line.
5019 (let* ((npoint (prog1 (line-beginning-position)
5020 (goto-char opoint)))
5021 (inhibit-point-motion-hooks nil))
5022 (goto-char npoint)))
5023 (t
5024 (line-move-finish (or goal-column temporary-goal-column)
5025 opoint (> orig-arg 0)))))))
5027 (defun line-move-finish (column opoint forward)
5028 (let ((repeat t))
5029 (while repeat
5030 ;; Set REPEAT to t to repeat the whole thing.
5031 (setq repeat nil)
5033 (let (new
5034 (old (point))
5035 (line-beg (line-beginning-position))
5036 (line-end
5037 ;; Compute the end of the line
5038 ;; ignoring effectively invisible newlines.
5039 (save-excursion
5040 ;; Like end-of-line but ignores fields.
5042 (while (and (not (eobp)) (invisible-p (point)))
5043 (goto-char (next-char-property-change (point)))
5045 (point))))
5047 ;; Move to the desired column.
5048 (line-move-to-column (truncate column))
5050 ;; Corner case: suppose we start out in a field boundary in
5051 ;; the middle of a continued line. When we get to
5052 ;; line-move-finish, point is at the start of a new *screen*
5053 ;; line but the same text line; then line-move-to-column would
5054 ;; move us backwards. Test using C-n with point on the "x" in
5055 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5056 (and forward
5057 (< (point) old)
5058 (goto-char old))
5060 (setq new (point))
5062 ;; Process intangibility within a line.
5063 ;; With inhibit-point-motion-hooks bound to nil, a call to
5064 ;; goto-char moves point past intangible text.
5066 ;; However, inhibit-point-motion-hooks controls both the
5067 ;; intangibility and the point-entered/point-left hooks. The
5068 ;; following hack avoids calling the point-* hooks
5069 ;; unnecessarily. Note that we move *forward* past intangible
5070 ;; text when the initial and final points are the same.
5071 (goto-char new)
5072 (let ((inhibit-point-motion-hooks nil))
5073 (goto-char new)
5075 ;; If intangibility moves us to a different (later) place
5076 ;; in the same line, use that as the destination.
5077 (if (<= (point) line-end)
5078 (setq new (point))
5079 ;; If that position is "too late",
5080 ;; try the previous allowable position.
5081 ;; See if it is ok.
5082 (backward-char)
5083 (if (if forward
5084 ;; If going forward, don't accept the previous
5085 ;; allowable position if it is before the target line.
5086 (< line-beg (point))
5087 ;; If going backward, don't accept the previous
5088 ;; allowable position if it is still after the target line.
5089 (<= (point) line-end))
5090 (setq new (point))
5091 ;; As a last resort, use the end of the line.
5092 (setq new line-end))))
5094 ;; Now move to the updated destination, processing fields
5095 ;; as well as intangibility.
5096 (goto-char opoint)
5097 (let ((inhibit-point-motion-hooks nil))
5098 (goto-char
5099 ;; Ignore field boundaries if the initial and final
5100 ;; positions have the same `field' property, even if the
5101 ;; fields are non-contiguous. This seems to be "nicer"
5102 ;; behavior in many situations.
5103 (if (eq (get-char-property new 'field)
5104 (get-char-property opoint 'field))
5105 new
5106 (constrain-to-field new opoint t t
5107 'inhibit-line-move-field-capture))))
5109 ;; If all this moved us to a different line,
5110 ;; retry everything within that new line.
5111 (when (or (< (point) line-beg) (> (point) line-end))
5112 ;; Repeat the intangibility and field processing.
5113 (setq repeat t))))))
5115 (defun line-move-to-column (col)
5116 "Try to find column COL, considering invisibility.
5117 This function works only in certain cases,
5118 because what we really need is for `move-to-column'
5119 and `current-column' to be able to ignore invisible text."
5120 (if (zerop col)
5121 (beginning-of-line)
5122 (move-to-column col))
5124 (when (and line-move-ignore-invisible
5125 (not (bolp)) (invisible-p (1- (point))))
5126 (let ((normal-location (point))
5127 (normal-column (current-column)))
5128 ;; If the following character is currently invisible,
5129 ;; skip all characters with that same `invisible' property value.
5130 (while (and (not (eobp))
5131 (invisible-p (point)))
5132 (goto-char (next-char-property-change (point))))
5133 ;; Have we advanced to a larger column position?
5134 (if (> (current-column) normal-column)
5135 ;; We have made some progress towards the desired column.
5136 ;; See if we can make any further progress.
5137 (line-move-to-column (+ (current-column) (- col normal-column)))
5138 ;; Otherwise, go to the place we originally found
5139 ;; and move back over invisible text.
5140 ;; that will get us to the same place on the screen
5141 ;; but with a more reasonable buffer position.
5142 (goto-char normal-location)
5143 (let ((line-beg (line-beginning-position)))
5144 (while (and (not (bolp)) (invisible-p (1- (point))))
5145 (goto-char (previous-char-property-change (point) line-beg))))))))
5147 (defun move-end-of-line (arg)
5148 "Move point to end of current line as displayed.
5149 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5150 If point reaches the beginning or end of buffer, it stops there.
5152 To ignore the effects of the `intangible' text or overlay
5153 property, bind `inhibit-point-motion-hooks' to t.
5154 If there is an image in the current line, this function
5155 disregards newlines that are part of the text on which the image
5156 rests."
5157 (interactive "^p")
5158 (or arg (setq arg 1))
5159 (let (done)
5160 (while (not done)
5161 (let ((newpos
5162 (save-excursion
5163 (let ((goal-column 0)
5164 (line-move-visual nil))
5165 (and (line-move arg t)
5166 ;; With bidi reordering, we may not be at bol,
5167 ;; so make sure we are.
5169 (not (bobp))
5170 (progn
5171 (while (and (not (bobp)) (invisible-p (1- (point))))
5172 (goto-char (previous-single-char-property-change
5173 (point) 'invisible)))
5174 (backward-char 1)))
5175 (point)))))
5176 (goto-char newpos)
5177 (if (and (> (point) newpos)
5179 (backward-char 1)
5180 (if (and (> (point) newpos) (not (eobp))
5182 ;; If we skipped something intangible and now we're not
5183 ;; really at eol, keep going.
5184 (setq arg 1)
5185 (setq done t)))))))
5187 (defun move-beginning-of-line (arg)
5188 "Move point to beginning of current line as displayed.
5189 \(If there's an image in the line, this disregards newlines
5190 which are part of the text that the image rests on.)
5192 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5193 If point reaches the beginning or end of buffer, it stops there.
5194 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5195 (interactive "^p")
5196 (or arg (setq arg 1))
5198 (let ((orig (point))
5199 first-vis first-vis-field-value)
5201 ;; Move by lines, if ARG is not 1 (the default).
5202 (if (/= arg 1)
5203 (let ((line-move-visual nil))
5204 (line-move (1- arg) t)))
5206 ;; Move to beginning-of-line, ignoring fields and invisible text.
5208 (while (and (not (bobp)) (invisible-p (1- (point))))
5209 (goto-char (previous-char-property-change (point)))
5212 ;; Now find first visible char in the line
5213 (while (and (not (eobp)) (invisible-p (point)))
5214 (goto-char (next-char-property-change (point))))
5215 (setq first-vis (point))
5217 ;; See if fields would stop us from reaching FIRST-VIS.
5218 (setq first-vis-field-value
5219 (constrain-to-field first-vis orig (/= arg 1) t nil))
5221 (goto-char (if (/= first-vis-field-value first-vis)
5222 ;; If yes, obey them.
5223 first-vis-field-value
5224 ;; Otherwise, move to START with attention to fields.
5225 ;; (It is possible that fields never matter in this case.)
5226 (constrain-to-field (point) orig
5227 (/= arg 1) t nil)))))
5230 ;; Many people have said they rarely use this feature, and often type
5231 ;; it by accident. Maybe it shouldn't even be on a key.
5232 (put 'set-goal-column 'disabled t)
5234 (defun set-goal-column (arg)
5236 Those commands will move to this position in the line moved to
5237 rather than trying to keep the same horizontal position.
5238 With a non-nil argument ARG, clears out the goal column
5240 The goal column is stored in the variable `goal-column'."
5241 (interactive "P")
5242 (if arg
5243 (progn
5244 (setq goal-column nil)
5245 (message "No goal column"))
5246 (setq goal-column (current-column))
5247 ;; The older method below can be erroneous if `set-goal-column' is bound
5248 ;; to a sequence containing %
5249 ;;(message (substitute-command-keys
5251 ;;goal-column)
5252 (message "%s"
5253 (concat
5254 (format "Goal column %d " goal-column)
5255 (substitute-command-keys
5258 )
5259 nil)
5260 \f
5261 ;;; Editing based on visual lines, as opposed to logical lines.
5263 (defun end-of-visual-line (&optional n)
5264 "Move point to end of current visual line.
5265 With argument N not nil or 1, move forward N - 1 visual lines first.
5266 If point reaches the beginning or end of buffer, it stops there.
5267 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5268 (interactive "^p")
5269 (or n (setq n 1))
5270 (if (/= n 1)
5271 (let ((line-move-visual t))
5272 (line-move (1- n) t)))
5273 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5274 ;; constrain to field boundaries, so we don't either.
5275 (vertical-motion (cons (window-width) 0)))
5277 (defun beginning-of-visual-line (&optional n)
5278 "Move point to beginning of current visual line.
5279 With argument N not nil or 1, move forward N - 1 visual lines first.
5280 If point reaches the beginning or end of buffer, it stops there.
5281 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5282 (interactive "^p")
5283 (or n (setq n 1))
5284 (let ((opoint (point)))
5285 (if (/= n 1)
5286 (let ((line-move-visual t))
5287 (line-move (1- n) t)))
5288 (vertical-motion 0)
5289 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5290 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
5292 (defun kill-visual-line (&optional arg)
5293 "Kill the rest of the visual line.
5294 With prefix argument ARG, kill that many visual lines from point.
5295 If ARG is negative, kill visual lines backward.
5296 If ARG is zero, kill the text before point on the current visual
5297 line.
5299 If you want to append the killed line to the last killed text,
5302 If the buffer is read-only, Emacs will beep and refrain from deleting
5303 the line, but put the line in the kill ring anyway. This means that
5304 you can use this command to copy text from a read-only buffer.
5305 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5306 even beep.)"
5307 (interactive "P")
5308 ;; Like in `kill-line', it's better to move point to the other end
5309 ;; of the kill before killing.
5310 (let ((opoint (point))
5311 (kill-whole-line (and kill-whole-line (bolp))))
5312 (if arg
5313 (vertical-motion (prefix-numeric-value arg))
5314 (end-of-visual-line 1)
5315 (if (= (point) opoint)
5316 (vertical-motion 1)
5317 ;; Skip any trailing whitespace at the end of the visual line.
5318 ;; We used to do this only if `show-trailing-whitespace' is
5319 ;; nil, but that's wrong; the correct thing would be to check
5320 ;; whether the trailing whitespace is highlighted. But, it's
5321 ;; OK to just do this unconditionally.
5324 (1+ (point))
5325 (point)))))
5327 (defun next-logical-line (&optional arg try-vscroll)
5328 "Move cursor vertically down ARG lines.
5329 This is identical to `next-line', except that it always moves
5330 by logical lines instead of visual lines, ignoring the value of
5331 the variable `line-move-visual'."
5333 (let ((line-move-visual nil))
5334 (with-no-warnings
5335 (next-line arg try-vscroll))))
5337 (defun previous-logical-line (&optional arg try-vscroll)
5338 "Move cursor vertically up ARG lines.
5339 This is identical to `previous-line', except that it always moves
5340 by logical lines instead of visual lines, ignoring the value of
5341 the variable `line-move-visual'."
5343 (let ((line-move-visual nil))
5344 (with-no-warnings
5345 (previous-line arg try-vscroll))))
5347 (defgroup visual-line nil
5348 "Editing based on visual lines."
5349 :group 'convenience
5350 :version "23.1")
5352 (defvar visual-line-mode-map
5353 (let ((map (make-sparse-keymap)))
5354 (define-key map [remap kill-line] 'kill-visual-line)
5355 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
5356 (define-key map [remap move-end-of-line] 'end-of-visual-line)
5357 ;; These keybindings interfere with xterm function keys. Are
5358 ;; there any other suitable bindings?
5359 ;; (define-key map "\M-[" 'previous-logical-line)
5360 ;; (define-key map "\M-]" 'next-logical-line)
5361 map))
5363 (defcustom visual-line-fringe-indicators '(nil nil)
5364 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5365 The value should be a list of the form (LEFT RIGHT), where LEFT
5366 and RIGHT are symbols representing the bitmaps to display, to
5367 indicate wrapped lines, in the left and right fringes respectively.
5368 See also `fringe-indicator-alist'.
5369 The default is not to display fringe indicators for wrapped lines.
5370 This variable does not affect fringe indicators displayed for
5371 other purposes."
5372 :type '(list (choice (const :tag "Hide left indicator" nil)
5373 (const :tag "Left curly arrow" left-curly-arrow)
5374 (symbol :tag "Other bitmap"))
5375 (choice (const :tag "Hide right indicator" nil)
5376 (const :tag "Right curly arrow" right-curly-arrow)
5377 (symbol :tag "Other bitmap")))
5378 :set (lambda (symbol value)
5379 (dolist (buf (buffer-list))
5380 (with-current-buffer buf
5381 (when (and (boundp 'visual-line-mode)
5382 (symbol-value 'visual-line-mode))
5383 (setq fringe-indicator-alist
5384 (cons (cons 'continuation value)
5385 (assq-delete-all
5386 'continuation
5387 (copy-tree fringe-indicator-alist)))))))
5388 (set-default symbol value)))
5390 (defvar visual-line--saved-state nil)
5392 (define-minor-mode visual-line-mode
5393 "Toggle visual line based editing (Visual Line mode).
5394 With a prefix argument ARG, enable Visual Line mode if ARG is
5395 positive, and disable it otherwise. If called from Lisp, enable
5396 the mode if ARG is omitted or nil.
5398 When Visual Line mode is enabled, `word-wrap' is turned on in
5399 this buffer, and simple editing commands are redefined to act on
5400 visual lines, not logical lines. See Info node `Visual Line
5401 Mode' for details."
5402 :keymap visual-line-mode-map
5403 :group 'visual-line
5404 :lighter " Wrap"
5405 (if visual-line-mode
5406 (progn
5407 (set (make-local-variable 'visual-line--saved-state) nil)
5408 ;; Save the local values of some variables, to be restored if
5409 ;; visual-line-mode is turned off.
5410 (dolist (var '(line-move-visual truncate-lines
5411 truncate-partial-width-windows
5412 word-wrap fringe-indicator-alist))
5413 (if (local-variable-p var)
5414 (push (cons var (symbol-value var))
5415 visual-line--saved-state)))
5416 (set (make-local-variable 'line-move-visual) t)
5417 (set (make-local-variable 'truncate-partial-width-windows) nil)
5418 (setq truncate-lines nil
5419 word-wrap t
5420 fringe-indicator-alist
5421 (cons (cons 'continuation visual-line-fringe-indicators)
5422 fringe-indicator-alist)))
5423 (kill-local-variable 'line-move-visual)
5424 (kill-local-variable 'word-wrap)
5425 (kill-local-variable 'truncate-lines)
5426 (kill-local-variable 'truncate-partial-width-windows)
5427 (kill-local-variable 'fringe-indicator-alist)
5428 (dolist (saved visual-line--saved-state)
5429 (set (make-local-variable (car saved)) (cdr saved)))
5430 (kill-local-variable 'visual-line--saved-state)))
5432 (defun turn-on-visual-line-mode ()
5433 (visual-line-mode 1))
5435 (define-globalized-minor-mode global-visual-line-mode
5436 visual-line-mode turn-on-visual-line-mode
5437 :lighter " vl")
5439 \f
5440 (defun transpose-chars (arg)
5441 "Interchange characters around point, moving forward one character.
5442 With prefix arg ARG, effect is to take character before point
5443 and drag it forward past ARG other characters (backward if ARG negative).
5444 If no argument and at end of line, the previous two chars are exchanged."
5445 (interactive "*P")
5446 (and (null arg) (eolp) (forward-char -1))
5447 (transpose-subr 'forward-char (prefix-numeric-value arg)))
5449 (defun transpose-words (arg)
5450 "Interchange words around point, leaving point at end of them.
5451 With prefix arg ARG, effect is to take word before or around point
5452 and drag it forward past ARG other words (backward if ARG negative).
5453 If ARG is zero, the words around or after point and around or after mark
5454 are interchanged."
5455 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5456 (interactive "*p")
5457 (transpose-subr 'forward-word arg))
5459 (defun transpose-sexps (arg)
5461 Does not work on a sexp that point is in the middle of
5462 if it is a list or string."
5463 (interactive "*p")
5464 (transpose-subr
5465 (lambda (arg)
5466 ;; Here we should try to simulate the behavior of
5467 ;; (cons (progn (forward-sexp x) (point))
5468 ;; (progn (forward-sexp (- x)) (point)))
5469 ;; Except that we don't want to rely on the second forward-sexp
5470 ;; putting us back to where we want to be, since forward-sexp-function
5471 ;; might do funny things like infix-precedence.
5472 (if (if (> arg 0)
5474 (and (not (bobp))
5476 ;; Jumping over a symbol. We might be inside it, mind you.
5477 (progn (funcall (if (> arg 0)
5478 'skip-syntax-backward 'skip-syntax-forward)
5479 "w_")
5480 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5481 ;; Otherwise, we're between sexps. Take a step back before jumping
5482 ;; to make sure we'll obey the same precedence no matter which direction
5483 ;; we're going.
5484 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5485 (cons (save-excursion (forward-sexp arg) (point))
5486 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5487 (not (zerop (funcall (if (> arg 0)
5488 'skip-syntax-forward
5489 'skip-syntax-backward)
5490 ".")))))
5491 (point)))))
5492 arg 'special))
5494 (defun transpose-lines (arg)
5495 "Exchange current line and previous line, leaving point after both.
5496 With argument ARG, takes previous line and moves it past ARG lines.
5497 With argument 0, interchanges line point is in with line mark is in."
5498 (interactive "*p")
5499 (transpose-subr (function
5500 (lambda (arg)
5501 (if (> arg 0)
5502 (progn
5503 ;; Move forward over ARG lines,
5504 ;; but create newlines if necessary.
5505 (setq arg (forward-line arg))
5507 (setq arg (1+ arg)))
5508 (if (> arg 0)
5509 (newline arg)))
5510 (forward-line arg))))
5511 arg))
5513 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5514 ;; which seems inconsistent with the ARG /= 0 case.
5515 ;; FIXME document SPECIAL.
5516 (defun transpose-subr (mover arg &optional special)
5517 "Subroutine to do the work of transposing objects.
5518 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5519 moves forward by units of the given object (e.g. forward-sentence,
5520 forward-paragraph). If ARG is zero, exchanges the current object
5521 with the one containing mark. If ARG is an integer, moves the
5522 current object past ARG following (if ARG is positive) or
5523 preceding (if ARG is negative) objects, leaving point after the
5524 current object."
5525 (let ((aux (if special mover
5526 (lambda (x)
5527 (cons (progn (funcall mover x) (point))
5528 (progn (funcall mover (- x)) (point))))))
5529 pos1 pos2)
5530 (cond
5531 ((= arg 0)
5532 (save-excursion
5533 (setq pos1 (funcall aux 1))
5534 (goto-char (or (mark) (error "No mark set in this buffer")))
5535 (setq pos2 (funcall aux 1))
5536 (transpose-subr-1 pos1 pos2))
5537 (exchange-point-and-mark))
5538 ((> arg 0)
5539 (setq pos1 (funcall aux -1))
5540 (setq pos2 (funcall aux arg))
5541 (transpose-subr-1 pos1 pos2)
5542 (goto-char (car pos2)))
5543 (t
5544 (setq pos1 (funcall aux -1))
5545 (goto-char (car pos1))
5546 (setq pos2 (funcall aux arg))
5547 (transpose-subr-1 pos1 pos2)))))
5549 (defun transpose-subr-1 (pos1 pos2)
5550 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5551 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5552 (when (> (car pos1) (car pos2))
5553 (let ((swap pos1))
5554 (setq pos1 pos2 pos2 swap)))
5555 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5556 (atomic-change-group
5557 ;; This sequence of insertions attempts to preserve marker
5558 ;; positions at the start and end of the transposed objects.
5559 (let* ((word (buffer-substring (car pos2) (cdr pos2)))
5560 (len1 (- (cdr pos1) (car pos1)))
5561 (len2 (length word))
5562 (boundary (make-marker)))
5563 (set-marker boundary (car pos2))
5564 (goto-char (cdr pos1))
5565 (insert-before-markers word)
5566 (setq word (delete-and-extract-region (car pos1) (+ (car pos1) len1)))
5567 (goto-char boundary)
5568 (insert word)
5569 (goto-char (+ boundary len1))
5570 (delete-region (point) (+ (point) len2))
5571 (set-marker boundary nil))))
5572 \f
5573 (defun backward-word (&optional arg)
5574 "Move backward until encountering the beginning of a word.
5575 With argument ARG, do this that many times."
5576 (interactive "^p")
5577 (forward-word (- (or arg 1))))
5579 (defun mark-word (&optional arg allow-extend)
5580 "Set mark ARG words away from point.
5582 move to with the same argument.
5583 Interactively, if this command is repeated
5584 or (in Transient Mark mode) if the mark is active,
5585 it marks the next ARG words after the ones already marked."
5587 (cond ((and allow-extend
5588 (or (and (eq last-command this-command) (mark t))
5589 (region-active-p)))
5590 (setq arg (if arg (prefix-numeric-value arg)
5591 (if (< (mark) (point)) -1 1)))
5592 (set-mark
5593 (save-excursion
5594 (goto-char (mark))
5595 (forward-word arg)
5596 (point))))
5597 (t
5598 (push-mark
5599 (save-excursion
5600 (forward-word (prefix-numeric-value arg))
5601 (point))
5602 nil t))))
5604 (defun kill-word (arg)
5605 "Kill characters forward until encountering the end of a word.
5606 With argument ARG, do this that many times."
5607 (interactive "p")
5608 (kill-region (point) (progn (forward-word arg) (point))))
5610 (defun backward-kill-word (arg)
5611 "Kill characters backward until encountering the beginning of a word.
5612 With argument ARG, do this that many times."
5613 (interactive "p")
5614 (kill-word (- arg)))
5616 (defun current-word (&optional strict really-word)
5617 "Return the symbol or word that point is on (or a nearby one) as a string.
5618 The return value includes no text properties.
5619 If optional arg STRICT is non-nil, return nil unless point is within
5620 or adjacent to a symbol or word. In all cases the value can be nil
5621 if there is no word nearby.
5622 The function, belying its name, normally finds a symbol.
5623 If optional arg REALLY-WORD is non-nil, it finds just a word."
5624 (save-excursion
5625 (let* ((oldpoint (point)) (start (point)) (end (point))
5626 (syntaxes (if really-word "w" "w_"))
5627 (not-syntaxes (concat "^" syntaxes)))
5628 (skip-syntax-backward syntaxes) (setq start (point))
5629 (goto-char oldpoint)
5630 (skip-syntax-forward syntaxes) (setq end (point))
5631 (when (and (eq start oldpoint) (eq end oldpoint)
5632 ;; Point is neither within nor adjacent to a word.
5633 (not strict))
5634 ;; Look for preceding word in same line.
5635 (skip-syntax-backward not-syntaxes (line-beginning-position))
5636 (if (bolp)
5637 ;; No preceding word in same line.
5638 ;; Look for following word in same line.
5639 (progn
5640 (skip-syntax-forward not-syntaxes (line-end-position))
5641 (setq start (point))
5642 (skip-syntax-forward syntaxes)
5643 (setq end (point)))
5644 (setq end (point))
5645 (skip-syntax-backward syntaxes)
5646 (setq start (point))))
5647 ;; If we found something nonempty, return it as a string.
5648 (unless (= start end)
5649 (buffer-substring-no-properties start end)))))
5650 \f
5651 (defcustom fill-prefix nil
5652 "String for filling to insert at front of new line, or nil for none."
5653 :type '(choice (const :tag "None" nil)
5654 string)
5655 :group 'fill)
5656 (make-variable-buffer-local 'fill-prefix)
5657 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5659 (defcustom auto-fill-inhibit-regexp nil
5660 "Regexp to match lines which should not be auto-filled."
5661 :type '(choice (const :tag "None" nil)
5662 regexp)
5663 :group 'fill)
5665 (defun do-auto-fill ()
5666 "The default value for `normal-auto-fill-function'.
5667 This is the default auto-fill function, some major modes use a different one.
5668 Returns t if it really did any work."
5669 (let (fc justify give-up
5670 (fill-prefix fill-prefix))
5671 (if (or (not (setq justify (current-justification)))
5672 (null (setq fc (current-fill-column)))
5673 (and (eq justify 'left)
5674 (<= (current-column) fc))
5675 (and auto-fill-inhibit-regexp
5676 (save-excursion (beginning-of-line)
5677 (looking-at auto-fill-inhibit-regexp))))
5678 nil ;; Auto-filling not required
5679 (if (memq justify '(full center right))
5680 (save-excursion (unjustify-current-line)))
5682 ;; Choose a fill-prefix automatically.
5683 (when (and adaptive-fill-mode
5684 (or (null fill-prefix) (string= fill-prefix "")))
5685 (let ((prefix
5686 (fill-context-prefix
5687 (save-excursion (fill-forward-paragraph -1) (point))
5688 (save-excursion (fill-forward-paragraph 1) (point)))))
5689 (and prefix (not (equal prefix ""))
5690 ;; Use auto-indentation rather than a guessed empty prefix.
5691 (not (and fill-indent-according-to-mode
5693 (setq fill-prefix prefix))))
5695 (while (and (not give-up) (> (current-column) fc))
5696 ;; Determine where to split the line.
5697 (let* (after-prefix
5698 (fill-point
5699 (save-excursion
5700 (beginning-of-line)
5701 (setq after-prefix (point))
5702 (and fill-prefix
5703 (looking-at (regexp-quote fill-prefix))
5704 (setq after-prefix (match-end 0)))
5705 (move-to-column (1+ fc))
5706 (fill-move-to-break-point after-prefix)
5707 (point))))
5709 ;; See whether the place we found is any good.
5710 (if (save-excursion
5711 (goto-char fill-point)
5712 (or (bolp)
5713 ;; There is no use breaking at end of line.
5714 (save-excursion (skip-chars-forward " ") (eolp))
5715 ;; It is futile to split at the end of the prefix
5716 ;; since we would just insert the prefix again.
5717 (and after-prefix (<= (point) after-prefix))
5718 ;; Don't split right after a comment starter
5719 ;; since we would just make another comment starter.
5720 (and comment-start-skip
5721 (let ((limit (point)))
5722 (beginning-of-line)
5723 (and (re-search-forward comment-start-skip
5724 limit t)
5725 (eq (point) limit))))))
5726 ;; No good place to break => stop trying.
5727 (setq give-up t)
5728 ;; Ok, we have a useful place to break the line. Do it.
5729 (let ((prev-column (current-column)))
5730 ;; If point is at the fill-point, do not `save-excursion'.
5731 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5732 ;; point will end up before it rather than after it.
5733 (if (save-excursion
5735 (= (point) fill-point))
5736 (default-indent-new-line t)
5737 (save-excursion
5738 (goto-char fill-point)
5739 (default-indent-new-line t)))
5740 ;; Now do justification, if required
5741 (if (not (eq justify 'left))
5742 (save-excursion
5743 (end-of-line 0)
5744 (justify-current-line justify nil t)))
5745 ;; If making the new line didn't reduce the hpos of
5746 ;; the end of the line, then give up now;
5747 ;; trying again will not help.
5748 (if (>= (current-column) prev-column)
5749 (setq give-up t))))))
5750 ;; Justify last line.
5751 (justify-current-line justify t t)
5752 t)))
5754 (defvar comment-line-break-function 'comment-indent-new-line
5755 "Mode-specific function which line breaks and continues a comment.
5756 This function is called during auto-filling when a comment syntax
5757 is defined.
5758 The function should take a single optional argument, which is a flag
5759 indicating whether it should use soft newlines.")
5761 (defun default-indent-new-line (&optional soft)
5762 "Break line at point and indent.
5763 If a comment syntax is defined, call `comment-indent-new-line'.
5765 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5766 unless optional argument SOFT is non-nil."
5767 (interactive)
5768 (if comment-start
5769 (funcall comment-line-break-function soft)
5770 ;; Insert the newline before removing empty space so that markers
5771 ;; get preserved better.
5773 (save-excursion (forward-char -1) (delete-horizontal-space))
5774 (delete-horizontal-space)
5776 (if (and fill-prefix (not adaptive-fill-mode))
5777 ;; Blindly trust a non-adaptive fill-prefix.
5778 (progn
5779 (indent-to-left-margin)
5780 (insert-before-markers-and-inherit fill-prefix))
5782 (cond
5783 ;; If there's an adaptive prefix, use it unless we're inside
5784 ;; a comment and the prefix is not a comment starter.
5785 (fill-prefix
5786 (indent-to-left-margin)
5787 (insert-and-inherit fill-prefix))
5788 ;; If we're not inside a comment, just try to indent.
5789 (t (indent-according-to-mode))))))
5791 (defvar normal-auto-fill-function 'do-auto-fill
5792 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5793 Some major modes set this.")
5795 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5796 ;; `functions' and `hooks' are usually unsafe to set, but setting
5797 ;; auto-fill-function to nil in a file-local setting is safe and
5798 ;; can be useful to prevent auto-filling.
5799 (put 'auto-fill-function 'safe-local-variable 'null)
5801 (define-minor-mode auto-fill-mode
5802 "Toggle automatic line breaking (Auto Fill mode).
5803 With a prefix argument ARG, enable Auto Fill mode if ARG is
5804 positive, and disable it otherwise. If called from Lisp, enable
5805 the mode if ARG is omitted or nil.
5807 When Auto Fill mode is enabled, inserting a space at a column
5808 beyond `current-fill-column' automatically breaks the line at a
5809 previous space.
5811 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5812 non-`nil'.
5814 The value of `normal-auto-fill-function' specifies the function to use
5815 for `auto-fill-function' when turning Auto Fill mode on."
5816 :variable (auto-fill-function
5817 . (lambda (v) (setq auto-fill-function
5818 (if v normal-auto-fill-function)))))
5820 ;; This holds a document string used to document auto-fill-mode.
5821 (defun auto-fill-function ()
5822 "Automatically break line at a previous space, in insertion of text."
5823 nil)
5825 (defun turn-on-auto-fill ()
5826 "Unconditionally turn on Auto Fill mode."
5827 (auto-fill-mode 1))
5829 (defun turn-off-auto-fill ()
5830 "Unconditionally turn off Auto Fill mode."
5831 (auto-fill-mode -1))
5833 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5835 (defun set-fill-column (arg)
5836 "Set `fill-column' to specified argument.
5839 (interactive
5840 (list (or current-prefix-arg
5841 ;; We used to use current-column silently, but C-x f is too easily
5842 ;; typed as a typo for C-x C-f, so we turned it into an error and
5843 ;; now an interactive prompt.
5844 (read-number "Set fill-column to: " (current-column)))))
5845 (if (consp arg)
5846 (setq arg (current-column)))
5847 (if (not (integerp arg))
5848 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5849 (error "set-fill-column requires an explicit argument")
5850 (message "Fill column set to %d (was %d)" arg fill-column)
5851 (setq fill-column arg)))
5852 \f
5853 (defun set-selective-display (arg)
5854 "Set `selective-display' to ARG; clear it if no arg.
5855 When the value of `selective-display' is a number > 0,
5856 lines whose indentation is >= that value are not displayed.
5857 The variable `selective-display' has a separate value for each buffer."
5858 (interactive "P")
5859 (if (eq selective-display t)
5860 (error "selective-display already in use for marked lines"))
5861 (let ((current-vpos
5862 (save-restriction
5863 (narrow-to-region (point-min) (point))
5864 (goto-char (window-start))
5865 (vertical-motion (window-height)))))
5866 (setq selective-display
5867 (and arg (prefix-numeric-value arg)))
5868 (recenter current-vpos))
5869 (set-window-start (selected-window) (window-start (selected-window)))
5870 (princ "selective-display set to " t)
5871 (prin1 selective-display t)
5872 (princ "." t))
5874 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5876 (defun toggle-truncate-lines (&optional arg)
5877 "Toggle truncating of long lines for the current buffer.
5878 When truncating is off, long lines are folded.
5879 With prefix argument ARG, truncate long lines if ARG is positive,
5880 otherwise fold them. Note that in side-by-side windows, this
5881 command has no effect if `truncate-partial-width-windows' is
5882 non-nil."
5883 (interactive "P")
5884 (setq truncate-lines
5885 (if (null arg)
5886 (not truncate-lines)
5887 (> (prefix-numeric-value arg) 0)))
5888 (force-mode-line-update)
5889 (unless truncate-lines
5890 (let ((buffer (current-buffer)))
5891 (walk-windows (lambda (window)
5892 (if (eq buffer (window-buffer window))
5893 (set-window-hscroll window 0)))
5894 nil t)))
5895 (message "Truncate long lines %s"
5896 (if truncate-lines "enabled" "disabled")))
5898 (defun toggle-word-wrap (&optional arg)
5899 "Toggle whether to use word-wrapping for continuation lines.
5900 With prefix argument ARG, wrap continuation lines at word boundaries
5901 if ARG is positive, otherwise wrap them at the right screen edge.
5902 This command toggles the value of `word-wrap'. It has no effect
5903 if long lines are truncated."
5904 (interactive "P")
5905 (setq word-wrap
5906 (if (null arg)
5907 (not word-wrap)
5908 (> (prefix-numeric-value arg) 0)))
5909 (force-mode-line-update)
5910 (message "Word wrapping %s"
5911 (if word-wrap "enabled" "disabled")))
5913 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5914 "The string displayed in the mode line when in overwrite mode.")
5915 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5916 "The string displayed in the mode line when in binary overwrite mode.")
5918 (define-minor-mode overwrite-mode
5919 "Toggle Overwrite mode.
5920 With a prefix argument ARG, enable Overwrite mode if ARG is
5921 positive, and disable it otherwise. If called from Lisp, enable
5922 the mode if ARG is omitted or nil.
5924 When Overwrite mode is enabled, printing characters typed in
5925 replace existing text on a one-for-one basis, rather than pushing
5926 it to the right. At the end of a line, such characters extend
5927 the line. Before a tab, such characters insert until the tab is
5929 overwrite mode; this is supposed to make it easier to insert
5930 characters when necessary."
5931 :variable (overwrite-mode
5932 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-textual)))))
5934 (define-minor-mode binary-overwrite-mode
5935 "Toggle Binary Overwrite mode.
5936 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5937 is positive, and disable it otherwise. If called from Lisp,
5938 enable the mode if ARG is omitted or nil.
5940 When Binary Overwrite mode is enabled, printing characters typed
5941 in replace existing text. Newlines are not treated specially, so
5942 typing at the end of a line joins the line to the next, with the
5943 typed character between them. Typing before a tab character
5944 simply replaces the tab with the character typed.
5946 ordinary typing characters do.
5948 Note that Binary Overwrite mode is not its own minor mode; it is
5949 a specialization of overwrite mode, entered by setting the
5950 `overwrite-mode' variable to `overwrite-mode-binary'."
5951 :variable (overwrite-mode
5952 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-binary)))))
5954 (define-minor-mode line-number-mode
5955 "Toggle line number display in the mode line (Line Number mode).
5956 With a prefix argument ARG, enable Line Number mode if ARG is
5957 positive, and disable it otherwise. If called from Lisp, enable
5958 the mode if ARG is omitted or nil.
5960 Line numbers do not appear for very large buffers and buffers
5961 with very long lines; see variables `line-number-display-limit'
5962 and `line-number-display-limit-width'."
5963 :init-value t :global t :group 'mode-line)
5965 (define-minor-mode column-number-mode
5966 "Toggle column number display in the mode line (Column Number mode).
5967 With a prefix argument ARG, enable Column Number mode if ARG is
5968 positive, and disable it otherwise.
5970 If called from Lisp, enable the mode if ARG is omitted or nil."
5971 :global t :group 'mode-line)
5973 (define-minor-mode size-indication-mode
5974 "Toggle buffer size display in the mode line (Size Indication mode).
5975 With a prefix argument ARG, enable Size Indication mode if ARG is
5976 positive, and disable it otherwise.
5978 If called from Lisp, enable the mode if ARG is omitted or nil."
5979 :global t :group 'mode-line)
5981 (define-minor-mode auto-save-mode
5982 "Toggle auto-saving in the current buffer (Auto Save mode).
5983 With a prefix argument ARG, enable Auto Save mode if ARG is
5984 positive, and disable it otherwise.
5986 If called from Lisp, enable the mode if ARG is omitted or nil."
5987 :variable ((and buffer-auto-save-file-name
5988 ;; If auto-save is off because buffer has shrunk,
5989 ;; then toggling should turn it on.
5990 (>= buffer-saved-size 0))
5991 . (lambda (val)
5992 (setq buffer-auto-save-file-name
5993 (cond
5994 ((null val) nil)
5995 ((and buffer-file-name auto-save-visited-file-name
5996 (not buffer-read-only))
5997 buffer-file-name)
5998 (t (make-auto-save-file-name))))))
5999 ;; If -1 was stored here, to temporarily turn off saving,
6000 ;; turn it back on.
6001 (and (< buffer-saved-size 0)
6002 (setq buffer-saved-size 0)))
6003 \f
6004 (defgroup paren-blinking nil
6005 "Blinking matching of parens and expressions."
6006 :prefix "blink-matching-"
6007 :group 'paren-matching)
6009 (defcustom blink-matching-paren t
6010 "Non-nil means show matching open-paren when close-paren is inserted."
6011 :type 'boolean
6012 :group 'paren-blinking)
6014 (defcustom blink-matching-paren-on-screen t
6015 "Non-nil means show matching open-paren when it is on screen.
6016 If nil, don't show it (but the open-paren can still be shown
6017 when it is off screen).
6019 This variable has no effect if `blink-matching-paren' is nil.
6020 \(In that case, the open-paren is never shown.)
6021 It is also ignored if `show-paren-mode' is enabled."
6022 :type 'boolean
6023 :group 'paren-blinking)
6025 (defcustom blink-matching-paren-distance (* 100 1024)
6026 "If non-nil, maximum distance to search backwards for matching open-paren.
6027 If nil, search stops at the beginning of the accessible portion of the buffer."
6028 :version "23.2" ; 25->100k
6029 :type '(choice (const nil) integer)
6030 :group 'paren-blinking)
6032 (defcustom blink-matching-delay 1
6033 "Time in seconds to delay after showing a matching paren."
6034 :type 'number
6035 :group 'paren-blinking)
6037 (defcustom blink-matching-paren-dont-ignore-comments nil
6038 "If nil, `blink-matching-paren' ignores comments.
6039 More precisely, when looking for the matching parenthesis,
6040 it skips the contents of comments that end before point."
6041 :type 'boolean
6042 :group 'paren-blinking)
6044 (defun blink-matching-check-mismatch (start end)
6045 "Return whether or not START...END are matching parens.
6046 END is the current point and START is the blink position.
6047 START might be nil if no matching starter was found.
6048 Returns non-nil if we find there is a mismatch."
6049 (let* ((end-syntax (syntax-after (1- end)))
6050 (matching-paren (and (consp end-syntax)
6051 (eq (syntax-class end-syntax) 5)
6052 (cdr end-syntax))))
6053 ;; For self-matched chars like " and $, we can't know when they're
6054 ;; mismatched or unmatched, so we can only do it for parens.
6055 (when matching-paren
6056 (not (and start
6057 (or
6058 (eq (char-after start) matching-paren)
6059 ;; The cdr might hold a new paren-class info rather than
6060 ;; a matching-char info, in which case the two CDRs
6061 ;; should match.
6062 (eq matching-paren (cdr-safe (syntax-after start)))))))))
6064 (defvar blink-matching-check-function #'blink-matching-check-mismatch
6065 "Function to check parentheses mismatches.
6066 The function takes two arguments (START and END) where START is the
6067 position just before the opening token and END is the position right after.
6068 START can be nil, if it was not found.
6069 The function should return non-nil if the two tokens do not match.")
6071 (defun blink-matching-open ()
6072 "Move cursor momentarily to the beginning of the sexp before point."
6073 (interactive)
6074 (when (and (not (bobp))
6075 blink-matching-paren)
6076 (let* ((oldpos (point))
6077 (message-log-max nil) ; Don't log messages about paren matching.
6078 (blinkpos
6079 (save-excursion
6080 (save-restriction
6081 (if blink-matching-paren-distance
6082 (narrow-to-region
6083 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
6084 (- (point) blink-matching-paren-distance))
6085 oldpos))
6086 (let ((parse-sexp-ignore-comments
6087 (and parse-sexp-ignore-comments
6088 (not blink-matching-paren-dont-ignore-comments))))
6089 (condition-case ()
6090 (progn
6091 (forward-sexp -1)
6092 ;; backward-sexp skips backward over prefix chars,
6093 ;; so move back to the matching paren.
6094 (while (and (< (point) (1- oldpos))
6095 (let ((code (syntax-after (point))))
6096 (or (eq (syntax-class code) 6)
6097 (eq (logand 1048576 (car code))
6098 1048576))))
6099 (forward-char 1))
6100 (point))
6101 (error nil))))))
6102 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
6103 (cond
6104 (mismatch
6105 (if blinkpos
6106 (if (minibufferp)
6107 (minibuffer-message "Mismatched parentheses")
6108 (message "Mismatched parentheses"))
6109 (if (minibufferp)
6110 (minibuffer-message "No matching parenthesis found")
6111 (message "No matching parenthesis found"))))
6112 ((not blinkpos) nil)
6113 ((pos-visible-in-window-p blinkpos)
6114 ;; Matching open within window, temporarily move to blinkpos but only
6115 ;; if `blink-matching-paren-on-screen' is non-nil.
6116 (and blink-matching-paren-on-screen
6117 (not show-paren-mode)
6118 (save-excursion
6119 (goto-char blinkpos)
6120 (sit-for blink-matching-delay))))
6121 (t
6122 (save-excursion
6123 (goto-char blinkpos)
6124 (let ((open-paren-line-string
6125 ;; Show what precedes the open in its line, if anything.
6126 (cond
6128 (buffer-substring (line-beginning-position)
6129 (1+ blinkpos)))
6130 ;; Show what follows the open in its line, if anything.
6131 ((save-excursion
6132 (forward-char 1)
6134 (not (eolp)))
6135 (buffer-substring blinkpos
6136 (line-end-position)))
6137 ;; Otherwise show the previous nonblank line,
6138 ;; if there is one.
6140 (concat
6141 (buffer-substring (progn
6143 (line-beginning-position))
6144 (progn (end-of-line)
6146 (point)))
6147 ;; Replace the newline and other whitespace with `...'.
6148 "..."
6149 (buffer-substring blinkpos (1+ blinkpos))))
6150 ;; There is nothing to show except the char itself.
6151 (t (buffer-substring blinkpos (1+ blinkpos))))))
6152 (message "Matches %s"
6153 (substring-no-properties open-paren-line-string)))))))))
6155 (defvar blink-paren-function 'blink-matching-open
6156 "Function called, if non-nil, whenever a close parenthesis is inserted.
6157 More precisely, a char with closeparen syntax is self-inserted.")
6159 (defun blink-paren-post-self-insert-function ()
6160 (when (and (eq (char-before) last-command-event) ; Sanity check.
6161 (memq (char-syntax last-command-event) '(?\) ?\$))
6162 blink-paren-function
6163 (not executing-kbd-macro)
6164 (not noninteractive)
6165 ;; Verify an even number of quoting characters precede the close.
6166 (= 1 (logand 1 (- (point)
6167 (save-excursion
6168 (forward-char -1)
6170 (point))))))
6171 (funcall blink-paren-function)))
6173 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
6174 ;; Most likely, this hook is nil, so this arg doesn't matter,
6175 ;; but I use it as a reminder that this function usually
6176 ;; likes to be run after others since it does `sit-for'.
6177 'append)
6178 \f
6179 ;; This executes C-g typed while Emacs is waiting for a command.
6180 ;; Quitting out of a program does not go through here;
6181 ;; that happens in the QUIT macro at the C code level.
6182 (defun keyboard-quit ()
6183 "Signal a `quit' condition.
6184 During execution of Lisp code, this character causes a quit directly.
6185 At top-level, as an editor command, this simply beeps."
6186 (interactive)
6187 ;; Avoid adding the region to the window selection.
6188 (setq saved-region-selection nil)
6189 (let (select-active-regions)
6190 (deactivate-mark))
6191 (if (fboundp 'kmacro-keyboard-quit)
6192 (kmacro-keyboard-quit))
6193 (setq defining-kbd-macro nil)
6194 (let ((debug-on-quit nil))
6195 (signal 'quit nil)))
6197 (defvar buffer-quit-function nil
6200 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
6202 (defun keyboard-escape-quit ()
6204 This command can exit an interactive command such as `query-replace',
6205 can clear out a prefix argument or a region,
6206 can get out of the minibuffer or other recursive edit,
6207 cancel the use of the current buffer (for special-purpose buffers),
6208 or go back to just one window (by deleting all but the selected window)."
6209 (interactive)
6210 (cond ((eq last-command 'mode-exited) nil)
6211 ((region-active-p)
6212 (deactivate-mark))
6213 ((> (minibuffer-depth) 0)
6214 (abort-recursive-edit))
6215 (current-prefix-arg
6216 nil)
6217 ((> (recursion-depth) 0)
6218 (exit-recursive-edit))
6219 (buffer-quit-function
6220 (funcall buffer-quit-function))
6221 ((not (one-window-p t))
6222 (delete-other-windows))
6224 (bury-buffer))))
6226 (defun play-sound-file (file &optional volume device)
6227 "Play sound stored in FILE.
6228 VOLUME and DEVICE correspond to the keywords of the sound
6229 specification for `play-sound'."
6230 (interactive "fPlay sound file: ")
6231 (let ((sound (list :file file)))
6232 (if volume
6233 (plist-put sound :volume volume))
6234 (if device
6235 (plist-put sound :device device))
6236 (push 'sound sound)
6237 (play-sound sound)))
6239 \f
6240 (defcustom read-mail-command 'rmail
6241 "Your preference for a mail reading package.
6242 This is used by some keybindings which support reading mail.
6243 See also `mail-user-agent' concerning sending mail."
6246 (function-item :tag "Emacs interface to MH"
6248 (function :tag "Other"))
6249 :version "21.1"
6250 :group 'mail)
6252 (defcustom mail-user-agent 'message-user-agent
6253 "Your preference for a mail composition package.
6254 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6255 outgoing email message. This variable lets you specify which
6256 mail-sending package you prefer.
6258 Valid values include:
6260 `message-user-agent' -- use the Message package.
6261 See Info node `(message)'.
6262 `sendmail-user-agent' -- use the Mail package.
6263 See Info node `(emacs)Sending Mail'.
6264 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6265 See Info node `(mh-e)'.
6266 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6267 paraphernalia if Gnus is running, particularly
6268 the Gcc: header for archiving.
6270 Additional valid symbols may be available; check with the author of
6271 your package for details. The function should return non-nil if it
6272 succeeds.
6274 See also `read-mail-command' concerning reading mail."
6275 :type '(radio (function-item :tag "Message package"
6277 message-user-agent)
6278 (function-item :tag "Mail package"
6280 sendmail-user-agent)
6281 (function-item :tag "Emacs interface to MH"
6283 mh-e-user-agent)
6284 (function-item :tag "Message with full Gnus features"
6286 gnus-user-agent)
6287 (function :tag "Other"))
6288 :version "23.2" ; sendmail->message
6289 :group 'mail)
6291 (defcustom compose-mail-user-agent-warnings t
6292 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6293 If the value of `mail-user-agent' is the default, and the user
6294 appears to have customizations applying to the old default,
6295 `compose-mail' issues a warning."
6296 :type 'boolean
6297 :version "23.2"
6298 :group 'mail)
6300 (defun rfc822-goto-eoh ()
6301 "If the buffer starts with a mail header, move point to the header's end.
6302 Otherwise, moves to `point-min'.
6303 The end of the header is the start of the next line, if there is one,
6304 else the end of the last line. This function obeys RFC822."
6305 (goto-char (point-min))
6306 (when (re-search-forward
6308 (goto-char (match-beginning 0))))
6310 ;; Used by Rmail (e.g., rmail-forward).
6311 (defvar mail-encode-mml nil
6312 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6313 the outgoing message before sending it.")
6315 (defun compose-mail (&optional to subject other-headers continue
6316 switch-function yank-action send-actions
6317 return-action)
6318 "Start composing a mail message to send.
6319 This uses the user's chosen mail composition package
6320 as selected with the variable `mail-user-agent'.
6321 The optional arguments TO and SUBJECT specify recipients
6322 and the initial Subject field, respectively.
6324 OTHER-HEADERS is an alist specifying additional
6325 header fields. Elements look like (HEADER . VALUE) where both
6326 HEADER and VALUE are strings.
6328 CONTINUE, if non-nil, says to continue editing a message already
6329 being composed. Interactively, CONTINUE is the prefix argument.
6331 SWITCH-FUNCTION, if non-nil, is a function to use to
6332 switch to and display the buffer used for mail composition.
6334 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6335 to insert the raw text of the message being replied to.
6336 It has the form (FUNCTION . ARGS). The user agent will apply
6337 FUNCTION to ARGS, to insert the raw text of the original message.
6338 \(The user agent will also run `mail-citation-hook', *after* the
6339 original text has been inserted in this way.)
6341 SEND-ACTIONS is a list of actions to call when the message is sent.
6342 Each action has the form (FUNCTION . ARGS).
6344 RETURN-ACTION, if non-nil, is an action for returning to the
6345 caller. It has the form (FUNCTION . ARGS). The function is
6346 called after the mail has been sent or put aside, and the mail
6347 buffer buried."
6348 (interactive
6349 (list nil nil nil current-prefix-arg))
6351 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6352 ;; from sendmail-user-agent to message-user-agent. Some users may
6353 ;; encounter incompatibilities. This hack tries to detect problems
6354 ;; and warn about them.
6355 (and compose-mail-user-agent-warnings
6356 (eq mail-user-agent 'message-user-agent)
6357 (let (warn-vars)
6358 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
6359 mail-yank-hooks mail-archive-file-name
6360 mail-default-reply-to mail-mailing-lists
6361 mail-self-blind))
6362 (and (boundp var)
6363 (symbol-value var)
6364 (push var warn-vars)))
6365 (when warn-vars
6366 (display-warning 'mail
6367 (format "\
6368 The default mail mode is now Message mode.
6369 You have the following Mail mode variable%s customized:
6371 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6372 (if (> (length warn-vars) 1) "s" "")
6373 (mapconcat 'symbol-name
6374 warn-vars " "))))))
6376 (let ((function (get mail-user-agent 'composefunc)))
6377 (funcall function to subject other-headers continue switch-function
6378 yank-action send-actions return-action)))
6380 (defun compose-mail-other-window (&optional to subject other-headers continue
6381 yank-action send-actions
6382 return-action)
6384 (interactive (list nil nil nil current-prefix-arg))
6385 (compose-mail to subject other-headers continue
6386 'switch-to-buffer-other-window yank-action send-actions
6387 return-action))
6389 (defun compose-mail-other-frame (&optional to subject other-headers continue
6390 yank-action send-actions
6391 return-action)
6393 (interactive (list nil nil nil current-prefix-arg))
6394 (compose-mail to subject other-headers continue
6395 'switch-to-buffer-other-frame yank-action send-actions
6396 return-action))
6398 \f
6399 (defvar set-variable-value-history nil
6400 "History of values entered with `set-variable'.
6402 Maximum length of the history list is determined by the value
6403 of `history-length', which see.")
6405 (defun set-variable (variable value &optional make-local)
6406 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6407 VARIABLE should be a user option variable name, a Lisp variable
6408 meant to be customized by users. You should enter VALUE in Lisp syntax,
6409 so if you want VALUE to be a string, you must surround it with doublequotes.
6410 VALUE is used literally, not evaluated.
6412 If VARIABLE has a `variable-interactive' property, that is used as if
6413 it were the arg to `interactive' (which see) to interactively read VALUE.
6415 If VARIABLE has been defined with `defcustom', then the type information
6416 in the definition is used to check that VALUE is valid.
6418 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6419 (interactive
6420 (let* ((default-var (variable-at-point))
6421 (var (if (custom-variable-p default-var)
6422 (read-variable (format "Set variable (default %s): " default-var)
6423 default-var)
6424 (read-variable "Set variable: ")))
6425 (minibuffer-help-form '(describe-variable var))
6426 (prop (get var 'variable-interactive))
6427 (obsolete (car (get var 'byte-obsolete-variable)))
6428 (prompt (format "Set %s %s to value: " var
6429 (cond ((local-variable-p var)
6430 "(buffer-local)")
6431 ((or current-prefix-arg
6432 (local-variable-if-set-p var))
6433 "buffer-locally")
6434 (t "globally"))))
6435 (val (progn
6436 (when obsolete
6437 (message (concat "`%S' is obsolete; "
6438 (if (symbolp obsolete) "use `%S' instead" "%s"))
6439 var obsolete)
6440 (sit-for 3))
6441 (if prop
6442 ;; Use VAR's `variable-interactive' property
6443 ;; as an interactive spec for prompting.
6444 (call-interactively `(lambda (arg)
6445 (interactive ,prop)
6446 arg))
6447 (read
6448 (read-string prompt nil
6449 'set-variable-value-history
6450 (format "%S" (symbol-value var))))))))
6451 (list var val current-prefix-arg)))
6453 (and (custom-variable-p variable)
6454 (not (get variable 'custom-type))
6455 (custom-load-symbol variable))
6456 (let ((type (get variable 'custom-type)))
6457 (when type
6458 ;; Match with custom type.
6459 (require 'cus-edit)
6460 (setq type (widget-convert type))
6461 (unless (widget-apply type :match value)
6462 (error "Value `%S' does not match type %S of %S"
6463 value (car type) variable))))
6465 (if make-local
6466 (make-local-variable variable))
6468 (set variable value)
6470 ;; Force a thorough redisplay for the case that the variable
6471 ;; has an effect on the display, like `tab-width' has.
6472 (force-mode-line-update))
6473 \f
6474 ;; Define the major mode for lists of completions.
6476 (defvar completion-list-mode-map
6477 (let ((map (make-sparse-keymap)))
6478 (define-key map [mouse-2] 'mouse-choose-completion)
6479 (define-key map [follow-link] 'mouse-face)
6480 (define-key map [down-mouse-2] nil)
6481 (define-key map "\C-m" 'choose-completion)
6482 (define-key map "\e\e\e" 'delete-completion-window)
6483 (define-key map [left] 'previous-completion)
6484 (define-key map [right] 'next-completion)
6485 (define-key map "q" 'quit-window)
6486 (define-key map "z" 'kill-this-buffer)
6487 map)
6488 "Local map for completion list buffers.")
6490 ;; Completion mode is suitable only for specially formatted data.
6491 (put 'completion-list-mode 'mode-class 'special)
6493 (defvar completion-reference-buffer nil
6494 "Record the buffer that was current when the completion list was requested.
6495 This is a local variable in the completion list buffer.
6496 Initial value is nil to avoid some compiler warnings.")
6498 (defvar completion-no-auto-exit nil
6499 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6500 This also applies to other functions such as `choose-completion'.")
6502 (defvar completion-base-position nil
6503 "Position of the base of the text corresponding to the shown completions.
6504 This variable is used in the *Completions* buffers.
6505 Its value is a list of the form (START END) where START is the place
6506 where the completion should be inserted and END (if non-nil) is the end
6507 of the text to replace. If END is nil, point is used instead.")
6509 (defvar completion-list-insert-choice-function #'completion--replace
6510 "Function to use to insert the text chosen in *Completions*.
6511 Called with three arguments (BEG END TEXT), it should replace the text
6512 between BEG and END with TEXT. Expected to be set buffer-locally
6513 in the *Completions* buffer.")
6515 (defvar completion-base-size nil
6516 "Number of chars before point not involved in completion.
6517 This is a local variable in the completion list buffer.
6518 It refers to the chars in the minibuffer if completing in the
6519 minibuffer, or in `completion-reference-buffer' otherwise.
6520 Only characters in the field at point are included.
6522 If nil, Emacs determines which part of the tail end of the
6523 buffer's text is involved in completion by comparing the text
6524 directly.")
6525 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6527 (defun delete-completion-window ()
6528 "Delete the completion list window.
6529 Go to the window from which completion was requested."
6530 (interactive)
6531 (let ((buf completion-reference-buffer))
6532 (if (one-window-p t)
6533 (if (window-dedicated-p (selected-window))
6534 (delete-frame (selected-frame)))
6535 (delete-window (selected-window))
6536 (if (get-buffer-window buf)
6537 (select-window (get-buffer-window buf))))))
6539 (defun previous-completion (n)
6540 "Move to the previous item in the completion list."
6541 (interactive "p")
6542 (next-completion (- n)))
6544 (defun next-completion (n)
6545 "Move to the next item in the completion list.
6546 With prefix argument N, move N items (negative N means move backward)."
6547 (interactive "p")
6548 (let ((beg (point-min)) (end (point-max)))
6549 (while (and (> n 0) (not (eobp)))
6550 ;; If in a completion, move to the end of it.
6551 (when (get-text-property (point) 'mouse-face)
6552 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6553 ;; Move to start of next one.
6554 (unless (get-text-property (point) 'mouse-face)
6555 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6556 (setq n (1- n)))
6557 (while (and (< n 0) (not (bobp)))
6558 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6559 ;; If in a completion, move to the start of it.
6560 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6561 (goto-char (previous-single-property-change
6562 (point) 'mouse-face nil beg)))
6563 ;; Move to end of the previous completion.
6564 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6565 (goto-char (previous-single-property-change
6566 (point) 'mouse-face nil beg)))
6567 ;; Move to the start of that one.
6568 (goto-char (previous-single-property-change
6569 (point) 'mouse-face nil beg))
6570 (setq n (1+ n))))))
6572 (defun choose-completion (&optional event)
6573 "Choose the completion at point."
6574 (interactive (list last-nonmenu-event))
6575 ;; In case this is run via the mouse, give temporary modes such as
6576 ;; isearch a chance to turn off.
6577 (run-hooks 'mouse-leave-buffer-hook)
6578 (with-current-buffer (window-buffer (posn-window (event-start event)))
6579 (let ((buffer completion-reference-buffer)
6580 (base-size completion-base-size)
6581 (base-position completion-base-position)
6582 (insert-function completion-list-insert-choice-function)
6583 (choice
6584 (save-excursion
6585 (goto-char (posn-point (event-start event)))
6586 (let (beg end)
6587 (cond
6588 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6589 (setq end (point) beg (1+ (point))))
6590 ((and (not (bobp))
6591 (get-text-property (1- (point)) 'mouse-face))
6592 (setq end (1- (point)) beg (point)))
6593 (t (error "No completion here")))
6594 (setq beg (previous-single-property-change beg 'mouse-face))
6595 (setq end (or (next-single-property-change end 'mouse-face)
6596 (point-max)))
6597 (buffer-substring-no-properties beg end)))))
6599 (unless (buffer-live-p buffer)
6600 (error "Destination buffer is dead"))
6601 (quit-window nil (posn-window (event-start event)))
6603 (with-current-buffer buffer
6604 (choose-completion-string
6605 choice buffer
6606 (or base-position
6607 (when base-size
6608 ;; Someone's using old completion code that doesn't know
6609 ;; about base-position yet.
6610 (list (+ base-size (field-beginning))))
6611 ;; If all else fails, just guess.
6612 (list (choose-completion-guess-base-position choice)))
6613 insert-function)))))
6615 ;; Delete the longest partial match for STRING
6616 ;; that can be found before POINT.
6617 (defun choose-completion-guess-base-position (string)
6618 (save-excursion
6619 (let ((opoint (point))
6620 len)
6621 ;; Try moving back by the length of the string.
6622 (goto-char (max (- (point) (length string))
6623 (minibuffer-prompt-end)))
6624 ;; See how far back we were actually able to move. That is the
6625 ;; upper bound on how much we can match and delete.
6626 (setq len (- opoint (point)))
6627 (if completion-ignore-case
6628 (setq string (downcase string)))
6629 (while (and (> len 0)
6630 (let ((tail (buffer-substring (point) opoint)))
6631 (if completion-ignore-case
6632 (setq tail (downcase tail)))
6633 (not (string= tail (substring string 0 len)))))
6634 (setq len (1- len))
6635 (forward-char 1))
6636 (point))))
6638 (defun choose-completion-delete-max-match (string)
6639 (declare (obsolete choose-completion-guess-base-position "23.2"))
6640 (delete-region (choose-completion-guess-base-position string) (point)))
6642 (defvar choose-completion-string-functions nil
6643 "Functions that may override the normal insertion of a completion choice.
6644 These functions are called in order with four arguments:
6645 CHOICE - the string to insert in the buffer,
6646 BUFFER - the buffer in which the choice should be inserted,
6647 MINI-P - non-nil if BUFFER is a minibuffer, and
6648 BASE-SIZE - the number of characters in BUFFER before
6649 the string being completed.
6651 If a function in the list returns non-nil, that function is supposed
6652 to have inserted the CHOICE in the BUFFER, and possibly exited
6653 the minibuffer; no further functions will be called.
6655 If all functions in the list return nil, that means to use
6656 the default method of inserting the completion in BUFFER.")
6658 (defun choose-completion-string (choice &optional
6659 buffer base-position insert-function)
6660 "Switch to BUFFER and insert the completion choice CHOICE.
6661 BASE-POSITION says where to insert the completion.
6662 INSERT-FUNCTION says how to insert the completion and falls
6663 back on `completion-list-insert-choice-function' when nil."
6665 ;; If BUFFER is the minibuffer, exit the minibuffer
6666 ;; unless it is reading a file name and CHOICE is a directory,
6667 ;; or completion-no-auto-exit is non-nil.
6669 ;; Some older code may call us passing `base-size' instead of
6670 ;; `base-position'. It's difficult to make any use of `base-size',
6671 ;; so we just ignore it.
6672 (unless (consp base-position)
6673 (message "Obsolete `base-size' passed to choose-completion-string")
6674 (setq base-position nil))
6676 (let* ((buffer (or buffer completion-reference-buffer))
6677 (mini-p (minibufferp buffer)))
6678 ;; If BUFFER is a minibuffer, barf unless it's the currently
6679 ;; active minibuffer.
6680 (if (and mini-p
6681 (not (and (active-minibuffer-window)
6682 (equal buffer
6683 (window-buffer (active-minibuffer-window))))))
6684 (error "Minibuffer is not active for completion")
6685 ;; Set buffer so buffer-local choose-completion-string-functions works.
6686 (set-buffer buffer)
6687 (unless (run-hook-with-args-until-success
6688 'choose-completion-string-functions
6689 ;; The fourth arg used to be `mini-p' but was useless
6690 ;; (since minibufferp can be used on the `buffer' arg)
6691 ;; and indeed unused. The last used to be `base-size', so we
6692 ;; keep it to try and avoid breaking old code.
6693 choice buffer base-position nil)
6694 ;; This remove-text-properties should be unnecessary since `choice'
6695 ;; comes from buffer-substring-no-properties.
6696 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6697 ;; Insert the completion into the buffer where it was requested.
6698 (funcall (or insert-function completion-list-insert-choice-function)
6699 (or (car base-position) (point))
6700 (or (cadr base-position) (point))
6701 choice)
6702 ;; Update point in the window that BUFFER is showing in.
6703 (let ((window (get-buffer-window buffer t)))
6704 (set-window-point window (point)))
6705 ;; If completing for the minibuffer, exit it with this choice.
6706 (and (not completion-no-auto-exit)
6707 (minibufferp buffer)
6708 minibuffer-completion-table
6709 ;; If this is reading a file name, and the file name chosen
6710 ;; is a directory, don't exit the minibuffer.
6711 (let* ((result (buffer-substring (field-beginning) (point)))
6712 (bounds
6713 (completion-boundaries result minibuffer-completion-table
6714 minibuffer-completion-predicate
6715 "")))
6716 (if (eq (car bounds) (length result))
6717 ;; The completion chosen leads to a new set of completions
6718 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6719 (let ((mini (active-minibuffer-window)))
6720 (select-window mini)
6721 (when minibuffer-auto-raise
6722 (raise-frame (window-frame mini))))
6723 (exit-minibuffer))))))))
6725 (define-derived-mode completion-list-mode nil "Completion List"
6726 "Major mode for buffers showing lists of possible completions.
6728 to select the completion near point.
6730 with the mouse.
6733 (set (make-local-variable 'completion-base-size) nil))
6735 (defun completion-list-mode-finish ()
6736 "Finish setup of the completions buffer.
6737 Called from `temp-buffer-show-hook'."
6738 (when (eq major-mode 'completion-list-mode)
6739 (setq buffer-read-only t)))
6741 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6744 ;; Variables and faces used in `completion-setup-function'.
6746 (defcustom completion-show-help t
6747 "Non-nil means show help message in *Completions* buffer."
6748 :type 'boolean
6749 :version "22.1"
6750 :group 'completion)
6752 ;; This function goes in completion-setup-hook, so that it is called
6753 ;; after the text of the completion list buffer is written.
6754 (defun completion-setup-function ()
6755 (let* ((mainbuf (current-buffer))
6756 (base-dir
6757 ;; FIXME: This is a bad hack. We try to set the default-directory
6758 ;; in the *Completions* buffer so that the relative file names
6759 ;; displayed there can be treated as valid file names, independently
6760 ;; from the completion context. But this suffers from many problems:
6761 ;; - It's not clear when the completions are file names. With some
6762 ;; completion tables (e.g. bzr revision specs), the listed
6763 ;; completions can mix file names and other things.
6764 ;; - It doesn't pay attention to possible quoting.
6765 ;; - With fancy completion styles, the code below will not always
6766 ;; find the right base directory.
6767 (if minibuffer-completing-file-name
6768 (file-name-as-directory
6769 (expand-file-name
6770 (buffer-substring (minibuffer-prompt-end)
6771 (- (point) (or completion-base-size 0))))))))
6772 (with-current-buffer standard-output
6773 (let ((base-size completion-base-size) ;Read before killing localvars.
6774 (base-position completion-base-position)
6775 (insert-fun completion-list-insert-choice-function))
6776 (completion-list-mode)
6777 (set (make-local-variable 'completion-base-size) base-size)
6778 (set (make-local-variable 'completion-base-position) base-position)
6779 (set (make-local-variable 'completion-list-insert-choice-function)
6780 insert-fun))
6781 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6782 (if base-dir (setq default-directory base-dir))
6783 ;; Maybe insert help string.
6784 (when completion-show-help
6785 (goto-char (point-min))
6786 (if (display-mouse-p)
6787 (insert (substitute-command-keys
6789 (insert (substitute-command-keys
6793 (add-hook 'completion-setup-hook 'completion-setup-function)
6795 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6796 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6798 (defun switch-to-completions ()
6799 "Select the completion list window."
6800 (interactive)
6801 (let ((window (or (get-buffer-window "*Completions*" 0)
6802 ;; Make sure we have a completions window.
6803 (progn (minibuffer-completion-help)
6804 (get-buffer-window "*Completions*" 0)))))
6805 (when window
6806 (select-window window)
6807 ;; In the new buffer, go to the first completion.
6808 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6809 (when (bobp)
6810 (next-completion 1)))))
6811 \f
6812 ;;; Support keyboard commands to turn on various modifiers.
6814 ;; These functions -- which are not commands -- each add one modifier
6815 ;; to the following event.
6817 (defun event-apply-alt-modifier (_ignore-prompt)
6820 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6821 (defun event-apply-super-modifier (_ignore-prompt)
6824 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6825 (defun event-apply-hyper-modifier (_ignore-prompt)
6828 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6829 (defun event-apply-shift-modifier (_ignore-prompt)
6832 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6833 (defun event-apply-control-modifier (_ignore-prompt)
6836 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6837 (defun event-apply-meta-modifier (_ignore-prompt)
6840 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6842 (defun event-apply-modifier (event symbol lshiftby prefix)
6843 "Apply a modifier flag to event EVENT.
6844 SYMBOL is the name of this modifier, as a symbol.
6845 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6846 PREFIX is the string that represents this modifier in an event type symbol."
6847 (if (numberp event)
6848 (cond ((eq symbol 'control)
6849 (if (and (<= (downcase event) ?z)
6850 (>= (downcase event) ?a))
6851 (- (downcase event) ?a -1)
6852 (if (and (<= (downcase event) ?Z)
6853 (>= (downcase event) ?A))
6854 (- (downcase event) ?A -1)
6855 (logior (lsh 1 lshiftby) event))))
6856 ((eq symbol 'shift)
6857 (if (and (<= (downcase event) ?z)
6858 (>= (downcase event) ?a))
6859 (upcase event)
6860 (logior (lsh 1 lshiftby) event)))
6861 (t
6862 (logior (lsh 1 lshiftby) event)))
6863 (if (memq symbol (event-modifiers event))
6864 event
6865 (let ((event-type (if (symbolp event) event (car event))))
6866 (setq event-type (intern (concat prefix (symbol-name event-type))))
6867 (if (symbolp event)
6868 event-type
6869 (cons event-type (cdr event)))))))
6871 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6872 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6873 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6874 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6875 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6876 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6877 \f
6878 ;;;; Keypad support.
6880 ;; Make the keypad keys act like ordinary typing keys. If people add
6881 ;; bindings for the function key symbols, then those bindings will
6882 ;; override these, so this shouldn't interfere with any existing
6883 ;; bindings.
6885 ;; Also tell read-char how to handle these keys.
6886 (mapc
6887 (lambda (keypad-normal)
6888 (let ((keypad (nth 0 keypad-normal))
6889 (normal (nth 1 keypad-normal)))
6890 (put keypad 'ascii-character normal)
6891 (define-key function-key-map (vector keypad) (vector normal))))
6892 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6893 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6894 (kp-space ?\s)
6897 (kp-multiply ?*)
6898 (kp-add ?+)
6899 (kp-separator ?,)
6900 (kp-subtract ?-)
6901 (kp-decimal ?.)
6902 (kp-divide ?/)
6903 (kp-equal ?=)
6904 ;; Do the same for various keys that are represented as symbols under
6905 ;; GUIs but naturally correspond to characters.
6906 (backspace 127)
6907 (delete 127)
6910 (clear ?\C-l)
6911 (return ?\C-m)
6912 (escape ?\e)
6913 ))
6914 \f
6915 ;;;;
6916 ;;;; forking a twin copy of a buffer.
6917 ;;;;
6919 (defvar clone-buffer-hook nil
6920 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6922 (defvar clone-indirect-buffer-hook nil
6923 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6925 (defun clone-process (process &optional newname)
6926 "Create a twin copy of PROCESS.
6927 If NEWNAME is nil, it defaults to PROCESS' name;
6928 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6929 If PROCESS is associated with a buffer, the new process will be associated
6930 with the current buffer instead.
6931 Returns nil if PROCESS has already terminated."
6932 (setq newname (or newname (process-name process)))
6934 (setq newname (substring newname 0 (match-beginning 0))))
6935 (when (memq (process-status process) '(run stop open))
6936 (let* ((process-connection-type (process-tty-name process))
6937 (new-process
6938 (if (memq (process-status process) '(open))
6939 (let ((args (process-contact process t)))
6940 (setq args (plist-put args :name newname))
6941 (setq args (plist-put args :buffer
6942 (if (process-buffer process)
6943 (current-buffer))))
6944 (apply 'make-network-process args))
6945 (apply 'start-process newname
6946 (if (process-buffer process) (current-buffer))
6947 (process-command process)))))
6948 (set-process-query-on-exit-flag
6949 new-process (process-query-on-exit-flag process))
6950 (set-process-inherit-coding-system-flag
6951 new-process (process-inherit-coding-system-flag process))
6952 (set-process-filter new-process (process-filter process))
6953 (set-process-sentinel new-process (process-sentinel process))
6954 (set-process-plist new-process (copy-sequence (process-plist process)))
6955 new-process)))
6957 ;; things to maybe add (currently partly covered by `funcall mode'):
6958 ;; - syntax-table
6959 ;; - overlays
6960 (defun clone-buffer (&optional newname display-flag)
6961 "Create and return a twin copy of the current buffer.
6962 Unlike an indirect buffer, the new buffer can be edited
6963 independently of the old one (if it is not read-only).
6964 NEWNAME is the name of the new buffer. It may be modified by
6965 adding or incrementing <N> at the end as necessary to create a
6966 unique buffer name. If nil, it defaults to the name of the
6967 current buffer, with the proper suffix. If DISPLAY-FLAG is
6968 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6969 clone a file-visiting buffer, or a buffer whose major mode symbol
6970 has a non-nil `no-clone' property, results in an error.
6972 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6973 current buffer with appropriate suffix. However, if a prefix
6974 argument is given, then the command prompts for NEWNAME in the
6975 minibuffer.
6977 This runs the normal hook `clone-buffer-hook' in the new buffer
6978 after it has been set up properly in other respects."
6979 (interactive
6980 (progn
6981 (if buffer-file-name
6982 (error "Cannot clone a file-visiting buffer"))
6983 (if (get major-mode 'no-clone)
6984 (error "Cannot clone a buffer in %s mode" mode-name))
6985 (list (if current-prefix-arg
6986 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6987 t)))
6988 (if buffer-file-name
6989 (error "Cannot clone a file-visiting buffer"))
6990 (if (get major-mode 'no-clone)
6991 (error "Cannot clone a buffer in %s mode" mode-name))
6992 (setq newname (or newname (buffer-name)))
6994 (setq newname (substring newname 0 (match-beginning 0))))
6995 (let ((buf (current-buffer))
6996 (ptmin (point-min))
6997 (ptmax (point-max))
6998 (pt (point))
6999 (mk (if mark-active (mark t)))
7000 (modified (buffer-modified-p))
7001 (mode major-mode)
7002 (lvars (buffer-local-variables))
7003 (process (get-buffer-process (current-buffer)))
7004 (new (generate-new-buffer (or newname (buffer-name)))))
7005 (save-restriction
7006 (widen)
7007 (with-current-buffer new
7008 (insert-buffer-substring buf)))
7009 (with-current-buffer new
7010 (narrow-to-region ptmin ptmax)
7011 (goto-char pt)
7012 (if mk (set-mark mk))
7013 (set-buffer-modified-p modified)
7015 ;; Clone the old buffer's process, if any.
7016 (when process (clone-process process))
7018 ;; Now set up the major mode.
7019 (funcall mode)
7021 ;; Set up other local variables.
7022 (mapc (lambda (v)
7023 (condition-case () ;in case var is read-only
7024 (if (symbolp v)
7025 (makunbound v)
7026 (set (make-local-variable (car v)) (cdr v)))
7027 (error nil)))
7028 lvars)
7030 ;; Run any hooks (typically set up by the major mode
7031 ;; for cloning to work properly).
7032 (run-hooks 'clone-buffer-hook))
7033 (if display-flag
7034 ;; Presumably the current buffer is shown in the selected frame, so
7035 ;; we want to display the clone elsewhere.
7036 (let ((same-window-regexps nil)
7037 (same-window-buffer-names))
7038 (pop-to-buffer new)))
7039 new))
7042 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7043 "Create an indirect buffer that is a twin copy of the current buffer.
7045 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7046 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7047 or if not called with a prefix arg, NEWNAME defaults to the current
7048 buffer's name. The name is modified by adding a `<N>' suffix to it
7049 or by incrementing the N in an existing suffix. Trying to clone a
7050 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7051 property results in an error.
7053 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7054 This is always done when called interactively.
7056 Optional third arg NORECORD non-nil means do not put this buffer at the
7057 front of the list of recently selected ones."
7058 (interactive
7059 (progn
7060 (if (get major-mode 'no-clone-indirect)
7061 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7062 (list (if current-prefix-arg
7063 (read-buffer "Name of indirect buffer: " (current-buffer)))
7064 t)))
7065 (if (get major-mode 'no-clone-indirect)
7066 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7067 (setq newname (or newname (buffer-name)))
7069 (setq newname (substring newname 0 (match-beginning 0))))
7070 (let* ((name (generate-new-buffer-name newname))
7071 (buffer (make-indirect-buffer (current-buffer) name t)))
7072 (with-current-buffer buffer
7073 (run-hooks 'clone-indirect-buffer-hook))
7074 (when display-flag
7075 (pop-to-buffer buffer norecord))
7076 buffer))
7079 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7080 "Like `clone-indirect-buffer' but display in another window."
7081 (interactive
7082 (progn
7083 (if (get major-mode 'no-clone-indirect)
7084 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7085 (list (if current-prefix-arg
7086 (read-buffer "Name of indirect buffer: " (current-buffer)))
7087 t)))
7088 (let ((pop-up-windows t))
7089 (clone-indirect-buffer newname display-flag norecord)))
7091 \f
7092 ;;; Handling of Backspace and Delete keys.
7094 (defcustom normal-erase-is-backspace 'maybe
7095 "Set the default behavior of the Delete and Backspace keys.
7097 If set to t, Delete key deletes forward and Backspace key deletes
7098 backward.
7100 If set to nil, both Delete and Backspace keys delete backward.
7102 If set to 'maybe (which is the default), Emacs automatically
7103 selects a behavior. On window systems, the behavior depends on
7104 the keyboard used. If the keyboard has both a Backspace key and
7105 a Delete key, and both are mapped to their usual meanings, the
7106 option's default value is set to t, so that Backspace can be used
7107 to delete backward, and Delete can be used to delete forward.
7109 If not running under a window system, customizing this option
7110 accomplishes a similar effect by mapping C-h, which is usually
7111 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7112 via `keyboard-translate'. The former functionality of C-h is
7113 available on the F1 key. You should probably not use this
7114 setting if you don't have both Backspace, Delete and F1 keys.
7116 Setting this variable with setq doesn't take effect. Programmatically,
7117 call `normal-erase-is-backspace-mode' (which see) instead."
7118 :type '(choice (const :tag "Off" nil)
7119 (const :tag "Maybe" maybe)
7120 (other :tag "On" t))
7121 :group 'editing-basics
7122 :version "21.1"
7123 :set (lambda (symbol value)
7124 ;; The fboundp is because of a problem with :set when
7125 ;; dumping Emacs. It doesn't really matter.
7126 (if (fboundp 'normal-erase-is-backspace-mode)
7127 (normal-erase-is-backspace-mode (or value 0))
7128 (set-default symbol value))))
7130 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7131 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7132 (unless frame (setq frame (selected-frame)))
7133 (with-selected-frame frame
7134 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7135 (normal-erase-is-backspace-mode
7136 (if (if (eq normal-erase-is-backspace 'maybe)
7137 (and (not noninteractive)
7138 (or (memq system-type '(ms-dos windows-nt))
7139 (memq window-system '(w32 ns))
7140 (and (memq window-system '(x))
7141 (fboundp 'x-backspace-delete-keys-p)
7142 (x-backspace-delete-keys-p))
7143 ;; If the terminal Emacs is running on has erase char
7144 ;; set to ^H, use the Backspace key for deleting
7145 ;; backward, and the Delete key for deleting forward.
7146 (and (null window-system)
7147 (eq tty-erase-char ?\^H))))
7148 normal-erase-is-backspace)
7149 1 0)))))
7151 (define-minor-mode normal-erase-is-backspace-mode
7152 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7153 With a prefix argument ARG, enable this feature if ARG is
7154 positive, and disable it otherwise. If called from Lisp, enable
7155 the mode if ARG is omitted or nil.
7157 On window systems, when this mode is on, Delete is mapped to C-d
7158 and Backspace is mapped to DEL; when this mode is off, both
7159 Delete and Backspace are mapped to DEL. (The remapping goes via
7160 `local-function-key-map', so binding Delete or Backspace in the
7161 global or local keymap will override that.)
7163 In addition, on window systems, the bindings of C-Delete, M-Delete,
7164 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7165 the global keymap in accordance with the functionality of Delete and
7166 Backspace. For example, if Delete is remapped to C-d, which deletes
7167 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7168 to DEL, which deletes backward, C-Delete is bound to
7169 `backward-kill-word'.
7171 If not running on a window system, a similar effect is accomplished by
7172 remapping C-h (normally produced by the Backspace key) and DEL via
7173 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7174 to C-d; if it's off, the keys are not remapped.
7176 When not running on a window system, and this mode is turned on, the
7177 former functionality of C-h is available on the F1 key. You should
7178 probably not turn on this mode on a text-only terminal if you don't
7179 have both Backspace, Delete and F1 keys.
7181 See also `normal-erase-is-backspace'."
7182 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7183 . (lambda (v)
7184 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7185 (if v 1 0))))
7186 (let ((enabled (eq 1 (terminal-parameter
7187 nil 'normal-erase-is-backspace))))
7189 (cond ((or (memq window-system '(x w32 ns pc))
7190 (memq system-type '(ms-dos windows-nt)))
7191 (let ((bindings
7192 `(([M-delete] [M-backspace])
7193 ([C-M-delete] [C-M-backspace])
7194 ([?\e C-delete] [?\e C-backspace]))))
7196 (if enabled
7197 (progn
7198 (define-key local-function-key-map [delete] [deletechar])
7199 (define-key local-function-key-map [kp-delete] [?\C-d])
7200 (define-key local-function-key-map [backspace] [?\C-?])
7201 (dolist (b bindings)
7202 ;; Not sure if input-decode-map is really right, but
7203 ;; keyboard-translate-table (used below) only works
7204 ;; for integer events, and key-translation-table is
7205 ;; global (like the global-map, used earlier).
7206 (define-key input-decode-map (car b) nil)
7207 (define-key input-decode-map (cadr b) nil)))
7208 (define-key local-function-key-map [delete] [?\C-?])
7209 (define-key local-function-key-map [kp-delete] [?\C-?])
7210 (define-key local-function-key-map [backspace] [?\C-?])
7211 (dolist (b bindings)
7212 (define-key input-decode-map (car b) (cadr b))
7213 (define-key input-decode-map (cadr b) (car b))))))
7214 (t
7215 (if enabled
7216 (progn
7217 (keyboard-translate ?\C-h ?\C-?)
7218 (keyboard-translate ?\C-? ?\C-d))
7219 (keyboard-translate ?\C-h ?\C-h)
7220 (keyboard-translate ?\C-? ?\C-?))))
7222 (if (called-interactively-p 'interactive)
7223 (message "Delete key deletes %s"
7224 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7225 "forward" "backward")))))
7226 \f
7227 (defvar vis-mode-saved-buffer-invisibility-spec nil
7228 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7230 (define-minor-mode read-only-mode
7231 "Change whether the current buffer is read-only.
7232 With prefix argument ARG, make the buffer read-only if ARG is
7233 positive, otherwise make it writable. If buffer is read-only
7234 and `view-read-only' is non-nil, enter view mode.
7236 Do not call this from a Lisp program unless you really intend to
7238 possibly enabling or disabling View mode. Also, note that this
7239 command works by setting the variable `buffer-read-only', which
7240 does not affect read-only regions caused by text properties. To
7241 ignore read-only status in a Lisp program (whether due to text
7242 properties or buffer state), bind `inhibit-read-only' temporarily
7243 to a non-nil value."
7244 :variable buffer-read-only
7245 (cond
7246 ((and (not buffer-read-only) view-mode)
7247 (View-exit-and-edit)
7248 (make-local-variable 'view-read-only)
7249 (setq view-read-only t)) ; Must leave view mode.
7250 ((and buffer-read-only view-read-only
7251 ;; If view-mode is already active, `view-mode-enter' is a nop.
7252 (not view-mode)
7253 (not (eq (get major-mode 'mode-class) 'special)))
7254 (view-mode-enter))))
7256 (define-minor-mode visible-mode
7257 "Toggle making all invisible text temporarily visible (Visible mode).
7258 With a prefix argument ARG, enable Visible mode if ARG is
7259 positive, and disable it otherwise. If called from Lisp, enable
7260 the mode if ARG is omitted or nil.
7262 This mode works by saving the value of `buffer-invisibility-spec'
7263 and setting it to nil."
7264 :lighter " Vis"
7265 :group 'editing-basics
7266 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7267 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7268 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7269 (when visible-mode
7270 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7271 buffer-invisibility-spec)
7272 (setq buffer-invisibility-spec nil)))
7273 \f
7274 ;; Minibuffer prompt stuff.
7276 ;;(defun minibuffer-prompt-modification (start end)
7277 ;; (error "You cannot modify the prompt"))
7278 ;;
7279 ;;
7280 ;;(defun minibuffer-prompt-insertion (start end)
7281 ;; (let ((inhibit-modification-hooks t))
7282 ;; (delete-region start end)
7283 ;; ;; Discard undo information for the text insertion itself
7284 ;; ;; and for the text deletion.above.
7285 ;; (when (consp buffer-undo-list)
7286 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7287 ;; (message "You cannot modify the prompt")))
7288 ;;
7289 ;;
7290 ;;(setq minibuffer-prompt-properties
7291 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7292 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7294 \f
7295 ;;;; Problematic external packages.
7297 ;; rms says this should be done by specifying symbols that define
7298 ;; versions together with bad values. This is therefore not as
7299 ;; flexible as it could be. See the thread:
7300 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7301 (defconst bad-packages-alist
7302 ;; Not sure exactly which semantic versions have problems.
7303 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7305 "The version of `semantic' loaded does not work in Emacs 22.
7306 It can cause constant high CPU load.
7307 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7308 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7309 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7310 ;; provided the `CUA-mode' feature. Since this is no longer true,
7311 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7312 (CUA-mode t nil
7313 "CUA-mode is now part of the standard GNU Emacs distribution,
7314 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7316 You have loaded an older version of CUA-mode which does not work
7317 correctly with this version of Emacs. You should remove the old
7318 version and use the one distributed with Emacs."))
7319 "Alist of packages known to cause problems in this version of Emacs.
7320 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7321 PACKAGE is either a regular expression to match file names, or a
7322 symbol (a feature name); see the documentation of
7323 `after-load-alist', to which this variable adds functions.
7324 SYMBOL is either the name of a string variable, or `t'. Upon
7325 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7326 warning using STRING as the message.")
7328 (defun bad-package-check (package)
7329 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7330 (condition-case nil
7331 (let* ((list (assoc package bad-packages-alist))
7332 (symbol (nth 1 list)))
7333 (and list
7334 (boundp symbol)
7335 (or (eq symbol t)
7336 (and (stringp (setq symbol (eval symbol)))
7337 (string-match-p (nth 2 list) symbol)))
7338 (display-warning package (nth 3 list) :warning)))
7339 (error nil)))
7341 (mapc (lambda (elem)
7342 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
7343 bad-packages-alist)
7346 (provide 'simple)
7348 ;;; simple.el ends here