| blob | 4527a9da0dc2de382b1991b933b031067a78def4 |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985-1987, 1993-2012 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:
36 ;;; From compile.el
41 "Idle time delay before updating various things on the screen.
42 Various Emacs features that update auxiliary information when point moves
43 wait this many seconds after Emacs becomes idle before doing an update."
49 "Killing and yanking commands."
53 "Highlight (un)matching of parens and expressions."
55 \f
56 ;;; next-error support framework
59 "`next-error' support framework."
65 "Face used to highlight next error locus."
70 "Highlighting of locations in selected source buffers.
71 If a number, highlight the locus in `next-error' face for the given time
72 in seconds, or until the next command is executed.
73 If t, highlight the locus until the next command is executed, or until
74 some other locus replaces it.
75 If nil, don't highlight the locus in the source buffer.
76 If `fringe-arrow', indicate the locus by the fringe arrow
77 indefinitely until some other locus replaces it."
86 "Highlighting of locations in `next-error-no-select'.
87 If number, highlight the locus in `next-error' face for given time in seconds.
88 If t, highlight the locus indefinitely until some other locus replaces it.
89 If nil, don't highlight the locus in the source buffer.
90 If `fringe-arrow', indicate the locus by the fringe arrow
91 indefinitely until some other locus replaces it."
100 "Display the line in the visited source file recentered as specified.
101 If non-nil, the value is passed directly to `recenter'."
109 "List of hook functions run by `next-error' after visiting source file."
120 "The most recent `next-error' buffer.
121 A buffer becomes most recent when its compilation, grep, or
126 "Function to use to find the next error in the current buffer.
127 The function is called with 2 parameters:
128 ARG is an integer specifying by how many errors to move.
129 RESET is a boolean which, if non-nil, says to go back to the beginning
130 of the errors before moving.
131 Major modes providing compile-like functionality should set this variable
132 to indicate to `next-error' that this is a candidate buffer and how
137 "Function to use to move to an error locus.
138 It takes two arguments, a buffer position in the error buffer
139 and a buffer position in the error locus buffer.
140 The buffer for the error locus should already be current.
145 &optional avoid-current
146 extra-test-inclusive
147 extra-test-exclusive)
148 "Test if BUFFER is a `next-error' capable buffer.
150 If AVOID-CURRENT is non-nil, treat the current buffer
151 as an absolute last resort only.
153 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
154 that normally would not qualify. If it returns t, the buffer
155 in question is treated as usable.
157 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
158 that would normally be considered usable. If it returns nil,
159 that buffer is rejected."
164 ;; Optionally reject some buffers.
167 t)
168 ;; Optionally accept some other buffers.
173 extra-test-inclusive
174 extra-test-exclusive)
175 "Return a `next-error' capable buffer.
177 If AVOID-CURRENT is non-nil, treat the current buffer
178 as an absolute last resort only.
180 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
181 that normally would not qualify. If it returns t, the buffer
182 in question is treated as usable.
184 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
185 that would normally be considered usable. If it returns nil,
186 that buffer is rejected."
188 ;; 1. If one window on the selected frame displays such buffer, return it.
194 avoid-current
195 extra-test-inclusive extra-test-exclusive)
200 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
203 extra-test-inclusive extra-test-exclusive))
204 next-error-last-buffer)
205 ;; 3. If the current buffer is acceptable, choose it.
207 extra-test-inclusive extra-test-exclusive)
209 ;; 4. Look for any acceptable buffer.
214 extra-test-inclusive extra-test-exclusive)))
217 ;; 5. Use the current buffer as a last resort if it qualifies,
218 ;; even despite AVOID-CURRENT.
221 extra-test-inclusive extra-test-exclusive)
225 ;; 6. Give up.
229 "Visit next `next-error' message and corresponding source code.
231 If all the error messages parsed so far have been processed already,
232 the message buffer is checked for new ones.
234 A prefix ARG specifies how many error messages to move;
235 negative means move back to previous error messages.
237 and start at the first error.
239 The RESET argument specifies that we should restart from the beginning.
242 compilation, grep, or occur buffer. It can also operate on any
244 more generally, on any buffer in Compilation mode or with
245 Compilation Minor mode enabled, or any buffer in which
246 `next-error-function' is bound to an appropriate function.
247 To specify use of a particular buffer for error messages, type
249 in the current frame.
252 runs `next-error-hook' with `run-hooks', and stays with that buffer
253 until you use it in some other buffer which uses Compilation mode
254 or Compilation Minor mode.
256 To control which errors are matched, customize the variable
257 `compilation-error-regexp-alist'."
261 ;; we know here that next-error-function is a valid symbol we can funcall
269 "Visit the source code corresponding to the `next-error' message at point."
271 ;; we know here that next-error-function is a valid symbol we can funcall
282 "Visit previous `next-error' message and corresponding source code.
284 Prefix arg N says how many error messages to move backwards (or
285 forwards, if negative).
292 "Restart at the first error.
293 Visit corresponding source code.
294 With prefix arg N, visit the source code of the Nth error.
300 "Move point to the next error in the `next-error' buffer and highlight match.
301 Prefix arg N says how many error messages to move forwards (or
302 backwards, if negative).
304 select the source buffer."
311 "Move point to the previous error in the `next-error' buffer and highlight match.
312 Prefix arg N says how many error messages to move backwards (or
313 forwards, if negative).
315 select the source buffer."
319 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
323 "Minor mode for compilation, occur and diff modes.
324 With a prefix argument ARG, enable mode if ARG is positive, and
325 disable it otherwise. If called from Lisp, enable mode if ARG is
326 omitted or nil.
327 When turned on, cursor motion in the compilation, grep, occur or diff
328 buffer causes automatic display of the corresponding source code location."
335 ;; Used as a `post-command-hook' by `next-error-follow-mode'
336 ;; for the *Compilation* *grep* and *Occur* buffers.
346 \f
347 ;;;
350 "Major mode not specialized for anything in particular.
351 Other major modes are defined by comparison with this one."
357 ;; Special major modes to view specially formatted data rather than files.
371 map))
375 "Parent major mode from which special major modes should inherit."
378 ;; Major mode meant to be the parent of programming modes.
383 map)
387 "Indent the expression after point."
394 "Major mode for editing programming language source code."
397 ;; Any programming language is always written left to right.
400 ;; Making and deleting lines.
406 "Insert a newline, and move to left margin of the new line if it's blank.
407 If `use-hard-newlines' is non-nil, the newline is marked with the
408 text-property `hard'.
409 With ARG, insert that many newlines.
410 Call `auto-fill-function' if the current column number is greater
411 than the value of `fill-column' and ARG is nil."
414 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
415 ;; Set last-command-event to tell self-insert what to insert.
419 ;; Don't auto-fill if we have a numeric argument.
422 ;; Do the rest in post-self-insert-hook, because we want to do it
423 ;; *before* other functions on that hook.
425 ;; Mark the newline(s) `hard'.
429 ;; If the newline leaves the previous line blank, and we
430 ;; have a left margin, delete that from the blank line.
438 ;; Indent the line after the newline, except in one case:
439 ;; when we added the newline at the beginning of a line which
440 ;; starts a page.
447 ;; We first used let-binding to protect the hook, but that was naive
448 ;; since add-hook affects the symbol-default value of the variable,
449 ;; whereas the let-binding might only protect the buffer-local value.
451 nil)
456 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
462 "Insert a newline and leave point before it.
463 If there is a fill prefix and/or a `left-margin', insert them
464 on the new line if the line would have been blank.
465 With arg N, insert N newlines."
470 ;; Don't expand an abbrev before point.
484 "Split current line, moving portion beyond point vertically down.
485 If the current line starts with `fill-prefix', insert it on the new
486 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
488 When called from Lisp code, ARG may be a prefix string to copy."
493 ;; What prefix should we check for (nil means don't).
497 ;; Does this line start with it?
508 "Join this line to previous and fix up whitespace at join.
509 If there is a fill prefix, delete it from the beginning of this line.
510 With argument, join this line to following line."
517 ;; If the second line started with the fill prefix,
518 ;; delete the prefix.
530 "On blank line, delete all surrounding blank lines, leaving just one.
531 On isolated blank line, delete that one.
532 On nonblank line, delete any immediately following blank lines."
538 ;; Set singleblank if there is just one blank line here.
545 ;; Delete preceding blank lines, and this one too if it's the only one.
554 ;; Delete following blank lines, unless the current line is blank
555 ;; and there are no following blank lines.
564 ;; Handle the special case where point is followed by newline and eob.
565 ;; Delete the line, leaving point at eob.
570 "Delete all the trailing whitespace across the current buffer.
571 All whitespace after the last non-whitespace character in a line is deleted.
573 A formfeed is not considered whitespace by this function.
574 If END is nil, also delete all trailing lines at the end of the buffer.
575 If the region is active, only delete whitespace within the region."
588 ;; Don't delete formfeeds, even if they are considered whitespace.
592 ;; Delete trailing empty lines.
595 ;; Really the end of buffer.
600 ;; Return nil for the benefit of `write-file-functions'.
601 nil)
604 "Insert a newline, then indent according to major mode.
605 Indentation is done using the value of `indent-line-function'.
606 In programming language modes, this is the same as TAB.
607 In some text modes, where TAB inserts a tab, this command indents to the
608 column specified by the function `current-left-margin'."
615 "Reindent current line, insert newline, then indent the new line.
616 Indentation of both lines is done according to the current major mode,
617 which means calling the current value of `indent-line-function'.
618 In programming language modes, this is the same as TAB.
619 In some text modes, where TAB inserts a tab, this indents to the
620 column specified by the function `current-left-margin'."
623 ;; Be careful to insert the newline before indenting the line.
624 ;; Otherwise, the indentation might be wrong.
628 ;; We are at EOL before the call to indent-according-to-mode, and
629 ;; after it we usually are as well, but not always. We tried to
630 ;; address it with `save-excursion' but that uses a normal marker
631 ;; whereas we need `move after insertion', so we do the save/restore
632 ;; by hand.
636 ;; Remove the trailing white-space after indentation because
637 ;; indentation may introduce the whitespace.
642 "Read next input character and insert it.
643 This is useful for inserting control characters.
644 With argument, insert ARG copies of the character.
646 If the first character you type after this command is an octal digit,
647 you should type a sequence of octal digits which specify a character code.
648 Any nondigit terminates the sequence. If the terminator is a RET,
649 it is discarded; any other terminator is used itself as input.
650 The variable `read-quoted-char-radix' specifies the radix for this feature;
651 set it to 10 or 16 to use decimal or hex instead of octal.
653 In overwrite mode, this function inserts the character anyway, and
654 does not handle octal digits specially. This means that if you use
655 overwrite as your normal editing mode, you can use this function to
656 insert characters when necessary.
658 In binary overwrite mode, this function does overwrite, and octal
659 digits are interpreted as a character code. This is intended to be
660 useful for editing binary files."
663 ;; Avoid "obsolete" warnings for translation-table-for-input.
670 ;; This used to assume character codes 0240 - 0377 stand for
671 ;; characters in some single-byte character set, and converted them
672 ;; to Emacs characters. But in 23.1 this feature is deprecated
673 ;; in favor of inserting the corresponding Unicode characters.
674 ;; (if (and enable-multibyte-characters
675 ;; (>= char ?\240)
676 ;; (<= char ?\377))
677 ;; (setq char (unibyte-char-to-multibyte char)))
686 "Move forward ARG lines and position at first nonblank character."
692 "Move backward ARG lines and position at first nonblank character."
698 "Move point to the first non-whitespace character on this line."
702 ;; Move back over chars that have whitespace syntax but have the p flag.
706 "Fixup white space between objects around point.
707 Leave one space or none, according to the context."
714 nil
718 "Delete all spaces and tabs around point.
719 If BACKWARD-ONLY is non-nil, only delete them before point."
724 orig-pos
733 "Delete all spaces and tabs around point, leaving one space (or N spaces).
734 If N is negative, delete newlines as well."
751 \f
753 "Move point to the beginning of the buffer.
754 With numeric arg N, put point N/10 of the way from the beginning.
755 If the buffer is narrowed, this command uses the beginning of the
756 accessible part of the buffer.
758 If Transient Mark mode is disabled, leave mark at previous
761 Don't use this command in Lisp programs!
762 \(goto-char (point-min)) is faster."
771 ;; Avoid overflow for large buffer sizes!
779 "Move point to the end of the buffer.
780 With numeric arg N, put point N/10 of the way from the end.
781 If the buffer is narrowed, this command uses the end of the
782 accessible part of the buffer.
784 If Transient Mark mode is disabled, leave mark at previous
787 Don't use this command in Lisp programs!
788 \(goto-char (point-max)) is faster."
795 ;; Avoid overflow for large buffer sizes!
800 ;; If we went to a place in the middle of the buffer,
801 ;; adjust it to the beginning of a line.
804 ;; If the end of the buffer is not already on the screen,
805 ;; then scroll specially to put it near, but not at, the bottom.
810 "Whether single-char deletion commands delete an active region.
811 This has an effect only if Transient Mark mode is enabled, and
812 affects `delete-forward-char' and `delete-backward-char', though
813 not `delete-char'.
815 If the value is the symbol `kill', the active region is killed
816 instead of deleted."
824 "Delete the previous N characters (following if N is negative).
825 If Transient Mark mode is enabled, the mark is active, and N is 1,
826 delete the text in the region and deactivate the mark instead.
827 To disable this, set `delete-active-region' to nil.
829 Optional second arg KILLFLAG, if non-nil, means to kill (save in
830 kill ring) instead of delete. Interactively, N is the prefix
831 arg, and KILLFLAG is set if N is explicitly specified.
833 In Overwrite mode, single character backward deletion may replace
834 tabs with spaces so as to back over columns, unless point is at
835 the end of the line."
840 delete-active-region
842 ;; If a region is active, kill or delete it.
846 ;; In Overwrite mode, maybe untabify while deleting
856 ;; Otherwise, do simple deletion.
860 "Delete the following N characters (previous if N is negative).
861 If Transient Mark mode is enabled, the mark is active, and N is 1,
862 delete the text in the region and deactivate the mark instead.
863 To disable this, set `delete-active-region' to nil.
865 Optional second arg KILLFLAG non-nil means to kill (save in kill
866 ring) instead of delete. Interactively, N is the prefix arg, and
867 KILLFLAG is set if N was explicitly specified."
872 delete-active-region
874 ;; If a region is active, kill or delete it.
878 ;; Otherwise, do simple deletion.
882 "Put point at beginning and mark at end of buffer.
883 If narrowing is in effect, only uses the accessible part of the buffer.
884 You probably should not use this function in Lisp programs;
885 it is usually a mistake for a Lisp function to use any subroutine
886 that uses or sets the mark."
891 \f
893 ;; Counting lines, one way or another.
896 "Go to LINE, counting from line 1 at beginning of buffer.
897 If called interactively, a numeric prefix argument specifies
898 LINE; without a numeric prefix argument, read LINE from the
899 minibuffer.
901 If optional argument BUFFER is non-nil, switch to that buffer and
903 as argument, BUFFER is the most recently selected other buffer.
905 Prior to moving point, this function sets the mark (without
906 activating it), unless Transient Mark mode is enabled and the
907 mark is already active.
909 This function is usually the wrong thing to use in a Lisp program.
910 What you probably want instead is something like:
911 (goto-char (point-min))
912 (forward-line (1- N))
913 If at all possible, an even better solution is to use char counts
914 rather than line counts."
918 ;; Look for a default, a number in the buffer at point.
928 ;; Decide if we're switching buffers.
936 ;; Read the argument, offering that number (if any) as default.
939 buffer-prompt
940 default)
941 default)
942 buffer))))
943 ;; Switch to the desired buffer, one way or another.
948 ;; Leave mark at previous position
950 ;; Move to the specified line number in that buffer.
959 "Count the number of words in the region.
960 If called interactively, print a message reporting the number of
961 lines, words, and chars in the region.
962 If called from Lisp, return the number of words between positions
963 START and END."
970 "Count words between START and END.
971 If called interactively, START and END are normally the start and
972 end of the buffer; but if the region is active, START and END are
973 the start and end of the region. Print a message reporting the
974 number of lines, words, and chars.
976 If called from Lisp, return the number of words between START and
977 END, without printing any message."
987 words))
998 str
1006 "Print the current buffer line number and narrowed line number of point."
1019 "Return number of lines between START and END.
1020 This is usually the number of newlines between them,
1021 but can be one more if START is not equal to END
1022 and the greater of them is not at the start of a line."
1038 done)))
1042 "Return (narrowed) buffer line number at position POS.
1043 If POS is nil, use current buffer location.
1044 Counting starts at (point-min), so the value refers
1045 to the contents of the accessible portion of the buffer."
1055 "Print info on cursor position (on screen and within buffer).
1056 Also describe the character after point, and give its character code
1057 in octal, decimal and hex.
1059 For a non-ASCII multibyte character, also give its encoding in the
1060 buffer's selected coding system if the coding system encodes the
1061 character safely. If the character is encoded into one byte, that
1062 code is shown in hex. If the character is encoded into more than one
1065 In addition, with prefix argument, show details about that character
1066 in *Help* buffer. See also the command `describe-char'."
1071 ;; If the character is one of LRE, LRO, RLE, RLO, it
1072 ;; will start a directional embedding, which could
1073 ;; completely disrupt the rest of the line (e.g., RLO
1074 ;; will display the rest of the line right-to-left).
1075 ;; So we put an invisible PDF character after these
1076 ;; characters, to end the embedding, which eliminates
1077 ;; any effects on the rest of the line.
1079 ;; Strong right-to-left characters cause reordering of
1080 ;; the following numerical characters which show the
1081 ;; codepoint, so append LRM to countermand that.
1091 ;; Avoid overflow from multiplying by 100!
1095 ""
1101 pos total percent beg end col hscroll)
1103 pos total col hscroll))
1105 encoded encoding-msg display-prop under-display)
1112 ;; Check if the character is displayed with some `display'
1113 ;; text property. In that case, set under-display to the
1114 ;; buffer substring covered by that property.
1125 under-display)))
1131 char char char under-display)
1133 char char char under-display display-prop))
1136 char char char
1138 "..."
1142 ;; We show the detailed information about CHAR.
1149 bidi-fixer
1150 encoding-msg pos total percent beg end col hscroll)
1157 bidi-fixer encoding-msg pos total percent col hscroll))))))
1158 \f
1159 ;; Initialize read-expression-map. It is defined at C level.
1162 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1163 ;; too rarely useful.
1173 "The current default value or list of default values in the minibuffer.
1174 The functions `read-from-minibuffer' and `completing-read' bind
1178 "Value for `print-level' while printing value in `eval-expression'.
1179 A value of nil means no limit."
1185 "Value for `print-length' while printing value in `eval-expression'.
1186 A value of nil means no limit."
1192 "If non-nil set `debug-on-error' to t in `eval-expression'.
1193 If nil, don't change the value of `debug-on-error'."
1199 "Format VALUE as a result of evaluated expression.
1200 Return a formatted string which is displayed in the echo area
1201 in addition to the value printed by prin1 in functions which
1202 display the result of expression evaluation."
1215 ;; We define this, rather than making `eval' interactive,
1216 ;; for the sake of completion of names like eval-region, eval-buffer.
1219 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1220 When called interactively, read an Emacs Lisp expression and
1221 evaluate it.
1222 Value is also consed on to front of the variable `values'.
1223 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1224 with prefix argument) means insert the result into the current buffer
1225 instead of printing it in the echo area. Truncates long output
1226 according to the value of the variables `eval-expression-print-length'
1227 and `eval-expression-print-level'.
1229 If `eval-expression-debug-on-error' is non-nil, which is the default,
1230 this command arranges for all errors to enter the debugger."
1234 nil read-expression-map t
1236 current-prefix-arg))
1241 ;; Bind debug-on-error to something unique so that we can
1242 ;; detect when evalled code changes it.
1246 ;; If evalled code has changed the value of debug-on-error,
1247 ;; propagate that change to the global binding.
1263 "Prompting with PROMPT, let user edit COMMAND and eval result.
1264 COMMAND is a Lisp expression. Let user edit that expression in
1265 the minibuffer, then read and evaluate the result."
1272 read-expression-map t
1274 ;; If command was added to command-history as a string,
1275 ;; get rid of that. We want only evaluable expressions there.
1279 ;; If command to be redone does not match front of history,
1280 ;; add it to the history.
1286 "Edit and re-evaluate last complex command, or ARGth from last.
1287 A complex command is one which used the minibuffer.
1288 The command is placed in the minibuffer as a Lisp form for editing.
1289 The result is executed, repeating the command as changed.
1290 If the command has been changed or is not the most recent previous
1291 command it is added to the front of the command history.
1292 You can use the minibuffer history commands \
1294 to get different commands to edit and resubmit."
1297 newcmd)
1309 ;; If command was added to command-history as a
1310 ;; string, get rid of that. We want only
1311 ;; evaluable expressions there.
1315 ;; If command to be redone does not match front of history,
1316 ;; add it to the history.
1325 "Read command name to invoke in `execute-extended-command'."
1330 ;; Get a command name at point in the original buffer
1331 ;; to propose it after M-n.
1335 ;; Read a string, completing from and restricting to the set of
1336 ;; all defined commands. Don't provide any initial input.
1337 ;; Save the command read on the extended-command history list.
1348 ;; This isn't strictly correct if `execute-extended-command'
1349 ;; is bound to anything else (e.g. [menu]).
1350 ;; It could use (key-description (this-single-command-keys)),
1351 ;; but actually a prompt other than "M-x" would be confusing,
1352 ;; because "M-x" is a well-known prompt to read a command
1353 ;; and it serves as a shorthand for "Extended command: ".
1358 "Non-nil means show the equivalent key-binding when M-x command has one.
1359 The value can be a length of time to show the message for.
1360 If the value is non-nil and not a number, we wait 2 seconds."
1367 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1368 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1369 "Read function name, then read its arguments and call it.
1371 To pass a numeric argument to the command you are invoking with, specify
1372 the numeric argument to this command.
1374 Noninteractively, the argument PREFIXARG is the prefix argument to
1375 give to the command you invoke, if it asks for an argument."
1377 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1386 ;; Normally `real-this-command' should never be changed, but here we really
1387 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1388 ;; binding" for <cmd>, so the command the user really wanted to run is
1389 ;; `function' and not `execute-extended-command'. The difference is
1390 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1394 ;; If enabled, show which key runs this command.
1396 ;; But first wait, and skip the message if there is input.
1398 ;; If this command displayed something in the echo area;
1399 ;; wait a few seconds, then display our suggestion message.
1409 suggest-key-bindings
1411 \f
1413 "Default minibuffer history list.
1414 This is used for all minibuffer input
1415 except when an alternate history list is specified.
1417 Maximum length of the history list is determined by the value
1420 "Control whether history list elements are expressions or strings.
1421 If the value of this variable equals current minibuffer depth,
1422 they are expressions; otherwise they are strings.
1423 \(That convention is designed to do the right thing for
1430 "Text that was in this minibuffer before any history commands.
1431 This is nil if there have not yet been any history commands
1440 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1444 "Minibuffer history variables for which matching should ignore case.
1445 If a history variable is a member of this list, then the
1447 commands ignore case when searching it, regardless of `case-fold-search'."
1452 "Find the previous history element that matches REGEXP.
1453 \(Previous history elements refer to earlier actions.)
1454 With prefix argument N, search for Nth previous match.
1455 If N is negative, find the next or Nth next match.
1456 Normally, history elements are matched case-insensitively if
1457 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1458 makes the search case-sensitive.
1459 See also `minibuffer-history-case-insensitive-variables'."
1463 nil
1464 minibuffer-local-map
1465 nil
1466 'minibuffer-history-search-history
1468 ;; Use the last regexp specified, by default, if input is empty.
1473 regexp)
1483 ;; On some systems, ignore case for file names.
1485 minibuffer-history-case-insensitive-variables)
1486 t
1487 ;; Respect the user's setting for case-fold-search:
1488 case-fold-search)
1489 nil))
1490 prevpos
1491 match-string
1492 match-offset
1499 "No later matching history item"
1520 next-matching-history-element))
1524 "Find the next history element that matches REGEXP.
1525 \(The next history element refers to a more recent action.)
1526 With prefix argument N, search for Nth next match.
1527 If N is negative, find the previous or Nth previous match.
1528 Normally, history elements are matched case-insensitively if
1529 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1530 makes the search case-sensitive."
1534 nil
1535 minibuffer-local-map
1536 nil
1537 'minibuffer-history-search-history
1539 ;; Use the last regexp specified, by default, if input is empty.
1544 regexp)
1551 "Function run by `goto-history-element' before consuming default values.
1552 This is useful to dynamically add more elements to the list of default values
1553 when `goto-history-element' reaches the end of this list.
1554 Before calling this function `goto-history-element' sets the variable
1555 `minibuffer-default-add-done' to t, so it will call this function only
1556 once. In special cases, when this function needs to be called more
1557 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1561 "When nil, add more elements to the end of the list of default values.
1562 The value nil causes `goto-history-element' to add more elements to
1563 the list of defaults when it reaches the end of this list. It does
1569 "Return a list of all completions without the default value.
1570 This function is used to add all elements of the completion table to
1571 the end of the list of defaults just after the default value."
1574 minibuffer-completion-table
1575 minibuffer-completion-predicate)))
1581 "Puts element of the minibuffer history in the minibuffer.
1582 The argument NABS specifies the absolute history position."
1596 elt minibuffer-returned-to-present)
1603 "End of defaults; no next item"
1608 previous-history-element))
1620 minibuffer-default)))
1632 elt))
1636 "Puts next element of the minibuffer history in the minibuffer.
1637 With argument N, it uses the Nth following element."
1643 "Puts previous element of the minibuffer history in the minibuffer.
1644 With argument N, it uses the Nth previous element."
1650 "Get next history element which completes the minibuffer before the point.
1651 The contents of the minibuffer after the point are deleted, and replaced
1652 by the new completion."
1658 n)
1659 ;; next-matching-history-element always puts us at (point-min).
1660 ;; Move to the position we were at before changing the buffer contents.
1661 ;; This is still sensible, because the text before point has not changed.
1665 "\
1666 Get previous history element which completes the minibuffer before the point.
1667 The contents of the minibuffer after the point are deleted, and replaced
1668 by the new completion."
1672 ;; For compatibility with the old subr of the same name.
1674 "Return the display width of the minibuffer prompt.
1675 Return 0 if current buffer is not a minibuffer."
1676 ;; Return the width of everything before the field at the end of
1677 ;; the buffer; this should be 0 for normal buffers.
1679 \f
1680 ;; isearch minibuffer history
1687 "Set up a minibuffer for using isearch to search the minibuffer history.
1688 Intended to be added to `minibuffer-setup-hook'."
1700 "Clean up the minibuffer after terminating isearch in the minibuffer."
1705 "Return the proper search function, for isearch in minibuffer history."
1708 ;; Use standard functions to search within minibuffer text
1710 found)
1711 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1712 ;; searching forward. Lazy-highlight calls this lambda with the
1713 ;; bound arg, so skip the minibuffer prompt.
1717 ;; 1. First try searching in the initial minibuffer text
1720 noerror)
1721 ;; 2. If the above search fails, start putting next/prev history
1722 ;; elements in the minibuffer successively, and search the string
1723 ;; in them. Do this only when bound is nil (i.e. not while
1724 ;; lazy-highlighting search strings in the current minibuffer text).
1736 ;; After putting the next/prev history element, search
1737 ;; the string in them again, until next-history-element
1738 ;; or previous-history-element raises an error at the
1739 ;; beginning/end of history.
1742 ;; For backward search, don't search
1743 ;; in the minibuffer prompt
1745 noerror)))
1746 ;; Return point of the new search result
1748 ;; Return nil when next(prev)-history-element fails
1752 "Display the minibuffer history search prompt.
1753 If there are no search errors, this function displays an overlay with
1754 the isearch prompt which replaces the original minibuffer prompt.
1755 Otherwise, it displays the standard isearch message returned from
1756 `isearch-message'."
1758 ;; Use standard function `isearch-message' when not in the minibuffer,
1759 ;; or search fails, or has an error (like incomplete regexp).
1760 ;; This function overwrites minibuffer text with isearch message,
1761 ;; so it's possible to see what is wrong in the search string.
1763 ;; Otherwise, put the overlay with the standard isearch prompt over
1764 ;; the initial minibuffer prompt.
1773 ;; And clear any previous isearch message.
1777 "Wrap the minibuffer history search when search fails.
1778 Move point to the first history element for a forward search,
1779 or to the last history element for a backward search."
1780 ;; When `minibuffer-history-isearch-search' fails on reaching the
1781 ;; beginning/end of the history, wrap the search to the first/last
1782 ;; minibuffer history element.
1790 "Save a function restoring the state of minibuffer history search.
1791 Save `minibuffer-history-position' to the additional state parameter
1792 in the search status stack."
1797 "Restore the minibuffer history search state.
1798 Go to the history element by the absolute history position HIST-POS."
1801 \f
1802 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1806 "Table mapping redo records to the corresponding undo one.
1807 A redo record for undo-in-region maps to t.
1817 "Within a run of consecutive undo commands, list remaining to be undone.
1821 "Undo some previous changes.
1822 Repeat this command to undo more changes.
1823 A numeric ARG serves as a repeat count.
1825 In Transient Mark mode when the mark is active, only undo changes within
1827 as an argument limits undo to changes within the current region."
1829 ;; Make last-command indicate for the next command that this was an undo.
1830 ;; That way, another undo will undo more.
1831 ;; If we get to the end of the undo history and get an error,
1832 ;; another undo command will find the undo history empty
1833 ;; and will get another error. To begin undoing the undos,
1834 ;; you must type some other command.
1837 message)
1838 ;; If we get an error in undo-start,
1839 ;; the next command should not be a "consecutive undo".
1840 ;; So set `this-command' to something other than `undo'.
1845 ;; If something (a timer or filter?) changed the buffer
1846 ;; since the previous command, don't continue the undo seq.
1850 ;; If the last undo record made was made by undo
1851 ;; it shows nothing else happened in between.
1858 ;; get rid of initial undo boundary
1860 ;; If we got this far, the next command should be a consecutive undo.
1862 ;; Check to see whether we're hitting a redo record, and if
1863 ;; so, ask the user whether she wants to skip the redo/undo pair.
1870 ;; The equiv entry might point to another redo record if we have done
1871 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1879 ;; Record the fact that the just-generated undo records come from an
1880 ;; undo operation--that is, they are redo records.
1881 ;; In the ordinary case (not within a region), map the redo
1882 ;; record to the following undos.
1883 ;; I don't know how to do that in the undo-in-region case.
1885 ;; Strip any leading undo boundaries there might be, like we do
1886 ;; above when checking.
1890 undo-equiv-table))
1891 ;; Don't specify a position in the undo record for the undo command.
1892 ;; Instead, undoing this should move point to where the change is.
1911 ;; Record what the current undo list says,
1912 ;; so the next command can tell if the buffer was modified in between.
1915 ;; Display a message announcing success.
1920 "Make BUFFER stop keeping undo information.
1921 No argument or nil as argument means do this for the current buffer."
1927 "Undo some previous changes.
1928 Repeat this command to undo more changes.
1929 A numeric ARG serves as a repeat count.
1930 Contrary to `undo', this will not redo a previous undo."
1935 "Non-nil while performing an undo.
1939 "Undo back N undo-boundaries beyond what was already undone recently.
1940 Call `undo-start' to get ready to undo recent changes,
1941 then call `undo-more' one or more times to undo them."
1946 ;; Note: The following, while pulling elements off
1947 ;; `pending-undo-list' will call primitive change functions which
1948 ;; will push more elements onto `buffer-undo-list'.
1953 ;; Deep copy of a list
1955 "Make a copy of undo list LIST."
1961 elt))
1964 "Set `pending-undo-list' to the front of the undo list.
1965 The next call to `undo-more' will undo the most recently made change.
1966 If BEG and END are specified, then only undo elements
1967 that apply to text between BEG and END are used; other undo elements
1968 are ignored. If BEG and END are nil, all undo elements are used."
1974 buffer-undo-list)))
1979 "Return a list of undo elements for the region START to END.
1980 The elements come from `buffer-undo-list', but we keep only
1981 the elements inside this region, and discard those outside this region.
1982 If we find an element that crosses an edge of this region,
1983 we stop and ignore all further elements."
1986 undo-adjusted-markers
1987 some-rejected
1988 undo-elt temp-undo-list delta)
1993 ;; This is a "was unmodified" element.
1994 ;; Keep it if we have kept everything thus far.
2001 ;; Don't put two nils together in the list
2015 ;; Loop down the earlier events adjusting their buffer
2016 ;; positions to reflect the fact that a change to the buffer
2017 ;; isn't being undone. We only need to process those element
2018 ;; types which undo-elt-in-region will return as being in
2019 ;; the region since only those types can ever get into the
2020 ;; output
2029 ;; (TEXT . POSITION)
2036 ;; (BEGIN . END)
2041 ;; (nil PROPERTY VALUE BEG . END)
2051 "Determine whether UNDO-ELT falls inside the region START ... END.
2052 If it crosses the edge, we return nil."
2057 t)
2059 nil)
2061 ;; (TEXT . POSITION)
2065 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2066 ;; See if MARKER is inside the region.
2077 ;; (nil PROPERTY VALUE BEG . END)
2082 ;; (BEGIN . END)
2087 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2088 This assumes we have already decided that UNDO-ELT
2089 is not *inside* the region START...END."
2092 ;; (nil PROPERTY VALUE BEG . END)
2097 ;; (BEGIN . END)
2101 ;; Return the first affected buffer position and the delta for an undo element
2102 ;; delta is defined as the change in subsequent buffer positions if we *did*
2103 ;; the undo.
2107 ;; (TEXT . POSITION)
2110 ;; (BEGIN . END)
2117 "If non-nil ask about discarding undo info for the current command.
2118 Normally, Emacs discards the undo info for the current command if
2119 it exceeds `undo-outer-limit'. But if you set this option
2120 non-nil, it asks in the echo area whether to discard the info.
2121 If you answer no, there is a slight risk that Emacs might crash, so
2122 only do it if you really want to undo the command.
2124 This option is mainly intended for debugging. You have to be
2125 careful if you use it for other purposes. Garbage collection is
2126 inhibited while the question is asked, meaning that Emacs might
2127 leak memory. So you should make sure that you do not wait
2128 excessively long before answering the question."
2134 "If non-nil, an extra level of size that's ok in an undo item.
2135 We don't ask the user about truncating the undo list until the
2136 current item gets bigger than this amount.
2141 ;; When the first undo batch in an undo list is longer than
2142 ;; undo-outer-limit, this function gets called to warn the user that
2143 ;; the undo info for the current command was discarded. Garbage
2144 ;; collection is inhibited around the call, so it had better not do a
2145 ;; lot of consing.
2151 ;; Don't ask the question again unless it gets even bigger.
2152 ;; This applies, in particular, if the user quits from the question.
2153 ;; Such a quit quits out of GC, but something else will call GC
2154 ;; again momentarily. It will call this function again,
2155 ;; but we don't want to ask the question again.
2162 t)
2163 nil))
2168 "The undo info was discarded because it exceeded \
2169 `undo-outer-limit'.
2171 This is normal if you executed a command that made a huge change
2172 to the buffer. In that case, to prevent similar problems in the
2173 future, set `undo-outer-limit' to a value that is large enough to
2174 cover the maximum size of normal changes you expect a single
2175 command to make, but not so large that it might exceed the
2176 maximum memory allotted to Emacs.
2178 If you did not execute any such command, the situation is
2179 probably due to a bug and you should report it.
2181 You can disable the popping up of this buffer by adding the entry
2182 \(undo discard-info) to the user option `warning-suppress-types',
2186 t))
2187 \f
2189 "History list for some commands that read shell commands.
2191 Maximum length of the history list is determined by the value
2198 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2199 This buffer is used when `shell-command' or `shell-command-on-region'
2200 is run interactively. A value of nil means that output to stderr and
2207 "Return a list of all commands associated with the current file.
2208 This function is used to add all related commands retrieved by `mailcap'
2209 to the end of the list of defaults just after the default value."
2213 minibuffer-default))
2218 commands))
2229 map)
2233 "Read a shell command from the minibuffer.
2234 The arguments are the same as the ones of `read-from-minibuffer',
2235 except READ and KEYMAP are missing and HIST defaults
2236 to `shell-command-history'."
2244 minibuffer-local-shell-command-map
2245 nil
2247 args)))
2250 "Execute string COMMAND asynchronously in background.
2252 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2253 surrounded by whitespace and executes the command asynchronously.
2254 The output appears in the buffer `*Async Shell Command*'.
2256 In Elisp, you will often be better served by calling `start-process'
2257 directly, since it offers more control and does not impose the use of a
2258 shell (with its need to quote arguments)."
2264 current-prefix-arg
2265 shell-command-default-error-buffer))
2271 "Execute string COMMAND in inferior shell; display output, if any.
2272 With prefix argument, insert the COMMAND's output at point.
2274 If COMMAND ends in ampersand, execute it asynchronously.
2275 The output appears in the buffer `*Async Shell Command*'.
2276 That buffer is in shell mode.
2278 Otherwise, COMMAND is executed synchronously. The output appears in
2279 the buffer `*Shell Command Output*'. If the output is short enough to
2280 display in the echo area (which is determined by the variables
2281 `resize-mini-windows' and `max-mini-window-height'), it is shown
2282 there, but it is nonetheless available in buffer `*Shell Command
2283 Output*' even though that buffer is not automatically displayed.
2285 To specify a coding system for converting non-ASCII characters
2287 before this command.
2289 Noninteractive callers can specify coding systems by binding
2290 `coding-system-for-read' and `coding-system-for-write'.
2292 The optional second argument OUTPUT-BUFFER, if non-nil,
2293 says to put the output in some other buffer.
2294 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2295 If OUTPUT-BUFFER is not a buffer and not nil,
2296 insert output in current buffer. (This cannot be done asynchronously.)
2297 In either case, the buffer is first erased, and the output is
2298 inserted after point (leaving mark after it).
2300 If the command terminates without error, but generates output,
2302 the output can be displayed in the echo area or in its buffer.
2303 If the output is short enough to display in the echo area
2304 \(determined by the variable `max-mini-window-height' if
2305 `resize-mini-windows' is non-nil), it is shown there.
2306 Otherwise,the buffer containing the output is displayed.
2310 of the output.
2312 If there is no output, or if output is inserted in the current buffer,
2313 then `*Shell Command Output*' is deleted.
2315 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2316 or buffer name to which to direct the command's standard error output.
2317 If it is nil, error output is mingled with regular output.
2318 In an interactive call, the variable `shell-command-default-error-buffer'
2319 specifies the value of ERROR-BUFFER.
2321 In Elisp, you will often be better served by calling `call-process' or
2322 `start-process' directly, since it offers more control and does not impose
2323 the use of a shell (with its need to quote arguments)."
2334 current-prefix-arg
2335 shell-command-default-error-buffer))
2336 ;; Look for a handler in case default-directory is a remote file name.
2344 ;; Output goes in current buffer.
2350 temporary-file-directory)))
2351 nil)))
2354 ;; We do not use -f for csh; we will not support broken use of
2355 ;; .cshrcs. Even the BSD csh manual says to use
2356 ;; "if ($?prompt) exit" before things which are not useful
2357 ;; non-interactively. Besides, if someone wants their other
2358 ;; aliases for shell commands then they can still have them.
2362 t)
2363 nil shell-command-switch command)
2370 ;; Do no formatting while reading error file,
2371 ;; because that can run a shell command, and we
2372 ;; don't want that to cause an infinite recursion.
2374 ;; Put point after the inserted errors.
2378 ;; This is like exchange-point-and-mark, but doesn't
2379 ;; activate the mark. It is cleaner to avoid activation,
2380 ;; even though the command loop would deactivate the mark
2381 ;; because we inserted text.
2385 ;; Output goes in a separate buffer.
2386 ;; Preserve the match data in case called from a program.
2389 ;; Command ending with ampersand means asynchronous.
2393 proc)
2394 ;; Remove the ampersand.
2396 ;; If will kill a process, query first.
2404 ;; Setting buffer-read-only to nil doesn't suffice
2405 ;; if some text has a non-nil read-only property,
2406 ;; which comint sometimes adds for prompts.
2412 shell-command-switch command))
2416 ;; Use the comint filter for proper handling of carriage motion
2417 ;; (see `comint-inhibit-carriage-motion'),.
2419 ))
2420 ;; Otherwise, command is executed synchronously.
2422 output-buffer nil error-buffer)))))))
2426 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2427 MESSAGE may be either a string or a buffer.
2429 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2430 the maximum height of the echo area, as defined by `max-mini-window-height'
2431 if `resize-mini-windows' is non-nil.
2433 Returns either the string shown in the echo area, or when a pop-up
2434 buffer is used, the window used to display it.
2436 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2437 name of the buffer used to display it in the case where a pop-up buffer
2438 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2439 string and it is displayed in the echo area, it is not specified whether
2440 the contents are inserted into the buffer anyway.
2442 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2443 and only used if a buffer is displayed."
2445 ;; Trivial case where we can use the echo area
2449 ;; Trivial case where we can just remove single trailing newline
2452 ;; General case
2455 message
2464 0
2468 (<= lines
2472 max-mini-window-height))
2474 max-mini-window-height)
2478 ;; Don't use the echo area if the output buffer is
2479 ;; already displayed in the selected frame.
2481 ;; Echo area
2487 ;; Buffer
2490 not-this-window frame))))))))
2493 ;; We have a sentinel to prevent insertion of a termination message
2494 ;; in the buffer itself.
2502 &optional output-buffer replace
2503 error-buffer display-error-buffer)
2504 "Execute string COMMAND in inferior shell with region as input.
2505 Normally display output (if any) in temp buffer `*Shell Command Output*';
2506 Prefix arg means replace the region with it. Return the exit code of
2507 COMMAND.
2509 To specify a coding system for converting non-ASCII characters
2511 before this command. By default, the input (from the current buffer)
2512 is encoded using coding-system specified by `process-coding-system-alist',
2513 falling back to `default-process-coding-system' if no match for COMMAND
2514 is found in `process-coding-system-alist'.
2516 The noninteractive arguments are START, END, COMMAND,
2517 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2518 Noninteractive callers can specify coding systems by binding
2519 `coding-system-for-read' and `coding-system-for-write'.
2521 If the command generates output, the output may be displayed
2522 in the echo area or in a buffer.
2523 If the output is short enough to display in the echo area
2524 \(determined by the variable `max-mini-window-height' if
2525 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2526 it is displayed in the buffer `*Shell Command Output*'. The output
2527 is available in that buffer in both cases.
2529 If there is output and an error, a message about the error
2530 appears at the end of the output.
2532 If there is no output, or if output is inserted in the current buffer,
2533 then `*Shell Command Output*' is deleted.
2535 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2536 that says to put the output in some other buffer.
2537 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2538 If OUTPUT-BUFFER is not a buffer and not nil,
2539 insert output in the current buffer.
2540 In either case, the output is inserted after point (leaving mark after it).
2542 If REPLACE, the optional fifth argument, is non-nil, that means insert
2543 the output in place of text from START to END, putting point and mark
2544 around it.
2546 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2547 or buffer name to which to direct the command's standard error output.
2548 If it is nil, error output is mingled with regular output.
2549 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2550 were any errors. (This is always t, interactively.)
2551 In an interactive call, the variable `shell-command-default-error-buffer'
2552 specifies the value of ERROR-BUFFER."
2556 ;; Do this before calling region-beginning
2557 ;; and region-end, in case subprocess output
2558 ;; relocates them while we are in the minibuffer.
2560 ;; call-interactively recognizes region-beginning and
2561 ;; region-end specially, leaving them in the history.
2563 string
2564 current-prefix-arg
2565 current-prefix-arg
2566 shell-command-default-error-buffer
2567 t)))
2573 temporary-file-directory)))
2574 nil))
2575 exit-status)
2579 ;; Replace specified region with output from command.
2581 ;; Don't muck with mark unless REPLACE says we should.
2588 t)
2589 nil shell-command-switch command))
2590 ;; It is rude to delete a buffer which the command is not using.
2591 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2592 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2593 ;; (kill-buffer shell-buffer)))
2594 ;; Don't muck with mark unless REPLACE says we should.
2596 ;; No prefix argument: put the output in a temp buffer,
2597 ;; replacing its entire contents.
2602 ;; If the input is the same buffer as the output,
2603 ;; delete everything but the specified region,
2604 ;; then replace that region with the output.
2610 shell-file-name t
2613 t)
2614 nil shell-command-switch
2615 command)))
2616 ;; Clear the output buffer, then run the command with
2617 ;; output there.
2628 buffer)
2629 nil shell-command-switch command)))
2630 ;; Report the output.
2640 ;; There's some output, display it
2642 ;; No output; error?
2649 shell-command-default-error-buffer)
2656 output))
2659 exit-status))
2662 exit-status output))))
2663 ;; Don't kill: there might be useful info in the undo-log.
2664 ;; (kill-buffer buffer)
2665 ))))
2673 ;; Do no formatting while reading error file,
2674 ;; because that can run a shell command, and we
2675 ;; don't want that to cause an infinite recursion.
2677 ;; Put point after the inserted errors.
2682 exit-status))
2685 "Execute shell command COMMAND and return its output as a string."
2688 standard-output
2692 "Process files synchronously in a separate process.
2693 Similar to `call-process', but may invoke a file handler based on
2694 `default-directory'. The current working directory of the
2695 subprocess is `default-directory'.
2697 File names in INFILE and BUFFER are handled normally, but file
2698 names in ARGS should be relative to `default-directory', as they
2699 are passed to the process verbatim. \(This is a difference to
2700 `call-process' which does not support file handlers for INFILE
2701 and BUFFER.\)
2703 Some file handlers might not support all variants, for example
2704 they might behave as if DISPLAY was nil, regardless of the actual
2705 value passed."
2707 lc stderr-file)
2717 display args)
2723 "Whether a call of `process-file' changes remote files.
2725 By default, this variable is always set to `t', meaning that a
2726 call of `process-file' could potentially change any file on a
2727 remote host. When set to `nil', a file handler could optimize
2728 its behavior with respect to remote file attribute caching.
2730 You should only ever change this variable with a let-binding;
2734 "Start a program in a subprocess. Return the process object for it.
2736 Similar to `start-process', but may invoke a file handler based on
2737 `default-directory'. See Info node `(elisp)Magic File Names'.
2739 This handler ought to run PROGRAM, perhaps on the local host,
2740 perhaps on a remote host that corresponds to `default-directory'.
2741 In the latter case, the local part of `default-directory' becomes
2742 the working directory of the process.
2744 PROGRAM and PROGRAM-ARGS might be file names. They are not
2745 objects of file handler invocation. File handlers might not
2746 support pty association, if PROGRAM is nil."
2750 \f
2751 ;;;; Process menu
2763 "Major mode for listing the processes called by Emacs."
2775 "Recompute the list of processes for the Process List buffer.
2776 Also, delete any process that is exited or signaled."
2789 face link
2792 follow-link t
2793 process-buffer ,buf
2794 action process-menu-visit-buffer)
2803 "datagram"
2818 tabulated-list-entries))))))
2824 "Display a list of all processes.
2825 If optional argument QUERY-ONLY is non-nil, only processes with
2826 the query-on-exit flag set are listed.
2827 Any process listed as exited or signaled is actually eliminated
2828 after the listing is made.
2829 Optional argument BUFFER specifies a buffer to use, instead of
2831 The return value is always nil."
2843 nil)
2844 \f
2848 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2849 (define-key map [switch-frame] nil)
2850 (define-key map [?\C-u] 'universal-argument-more)
2851 (define-key map [?-] 'universal-argument-minus)
2852 (define-key map [?0] 'digit-argument)
2853 (define-key map [?1] 'digit-argument)
2854 (define-key map [?2] 'digit-argument)
2855 (define-key map [?3] 'digit-argument)
2856 (define-key map [?4] 'digit-argument)
2857 (define-key map [?5] 'digit-argument)
2858 (define-key map [?6] 'digit-argument)
2859 (define-key map [?7] 'digit-argument)
2860 (define-key map [?8] 'digit-argument)
2861 (define-key map [?9] 'digit-argument)
2862 (define-key map [kp-0] 'digit-argument)
2863 (define-key map [kp-1] 'digit-argument)
2864 (define-key map [kp-2] 'digit-argument)
2865 (define-key map [kp-3] 'digit-argument)
2866 (define-key map [kp-4] 'digit-argument)
2867 (define-key map [kp-5] 'digit-argument)
2868 (define-key map [kp-6] 'digit-argument)
2869 (define-key map [kp-7] 'digit-argument)
2870 (define-key map [kp-8] 'digit-argument)
2871 (define-key map [kp-9] 'digit-argument)
2872 (define-key map [kp-subtract] 'universal-argument-minus)
2873 map)
2876 (defvar universal-argument-num-events nil
2877 "Number of argument-specifying events read by `universal-argument'.
2878 `universal-argument-other-key' uses this to discard those events
2879 from (this-command-keys), and reread only the final command.")
2881 (defvar saved-overriding-map t
2882 "The saved value of `overriding-terminal-local-map'.
2886 (defun save&set-overriding-map (map)
2887 "Set `overriding-terminal-local-map' to MAP."
2888 (when (eq saved-overriding-map t)
2889 (setq saved-overriding-map overriding-terminal-local-map)
2890 (setq overriding-terminal-local-map map)))
2892 (defun restore-overriding-map ()
2893 "Restore `overriding-terminal-local-map' to its saved value."
2894 (setq overriding-terminal-local-map saved-overriding-map)
2895 (setq saved-overriding-map t))
2897 (defun universal-argument ()
2898 "Begin a numeric argument for the following command.
2903 multiplies the argument by 4 each time.
2905 which is different in effect from any particular numeric argument.
2907 (interactive)
2908 (setq prefix-arg (list 4))
2909 (setq universal-argument-num-events (length (this-command-keys)))
2910 (save&set-overriding-map universal-argument-map))
2912 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2913 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2914 (defun universal-argument-more (arg)
2915 (interactive "P")
2916 (if (consp arg)
2917 (setq prefix-arg (list (* 4 (car arg))))
2918 (if (eq arg '-)
2919 (setq prefix-arg (list -4))
2920 (setq prefix-arg arg)
2921 (restore-overriding-map)))
2922 (setq universal-argument-num-events (length (this-command-keys))))
2924 (defun negative-argument (arg)
2925 "Begin a negative numeric argument for the next command.
2927 (interactive "P")
2928 (cond ((integerp arg)
2929 (setq prefix-arg (- arg)))
2930 ((eq arg '-)
2931 (setq prefix-arg nil))
2932 (t
2933 (setq prefix-arg '-)))
2934 (setq universal-argument-num-events (length (this-command-keys)))
2935 (save&set-overriding-map universal-argument-map))
2937 (defun digit-argument (arg)
2938 "Part of the numeric argument for the next command.
2940 (interactive "P")
2941 (let* ((char (if (integerp last-command-event)
2942 last-command-event
2943 (get last-command-event 'ascii-character)))
2945 (cond ((integerp arg)
2946 (setq prefix-arg (+ (* arg 10)
2947 (if (< arg 0) (- digit) digit))))
2948 ((eq arg '-)
2949 ;; Treat -0 as just -, so that -01 will work.
2950 (setq prefix-arg (if (zerop digit) '- (- digit))))
2951 (t
2952 (setq prefix-arg digit))))
2953 (setq universal-argument-num-events (length (this-command-keys)))
2954 (save&set-overriding-map universal-argument-map))
2956 ;; For backward compatibility, minus with no modifiers is an ordinary
2957 ;; command if digits have already been entered.
2958 (defun universal-argument-minus (arg)
2959 (interactive "P")
2960 (if (integerp arg)
2961 (universal-argument-other-key arg)
2962 (negative-argument arg)))
2964 ;; Anything else terminates the argument and is left in the queue to be
2965 ;; executed as a command.
2966 (defun universal-argument-other-key (arg)
2967 (interactive "P")
2968 (setq prefix-arg arg)
2969 (let* ((key (this-command-keys))
2970 (keylist (listify-key-sequence key)))
2971 (setq unread-command-events
2972 (append (nthcdr universal-argument-num-events keylist)
2973 unread-command-events)))
2974 (reset-this-command-lengths)
2975 (restore-overriding-map))
2976 \f
2978 (defvar filter-buffer-substring-functions nil
2979 "This variable is a wrapper hook around `filter-buffer-substring'.
2980 Each member of the hook should be a function accepting four arguments:
2981 \(FUN BEG END DELETE), where FUN is itself a function of three arguments
2982 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
2983 as those of `filter-buffer-substring' in each case.
2985 The first hook function to be called receives a FUN equivalent
2986 to the default operation of `filter-buffer-substring',
2987 i.e. one that returns the buffer-substring between BEG and
2988 END (processed by any `buffer-substring-filters'). Normally,
2989 the hook function will call FUN and then do its own processing
2990 of the result. The next hook function receives a FUN equivalent
2991 to the previous hook function, calls it, and does its own
2992 processing, and so on. The overall result is that of all hook
2993 functions acting in sequence.
2995 Any hook may choose not to call FUN though, in which case it
2996 effectively replaces the default behavior with whatever it chooses.
2997 Of course, a later hook function may do the same thing.")
2999 (defvar buffer-substring-filters nil
3000 "List of filter functions for `filter-buffer-substring'.
3001 Each function must accept a single argument, a string, and return
3002 a string. The buffer substring is passed to the first function
3003 in the list, and the return value of each function is passed to
3004 the next. The final result (if `buffer-substring-filters' is
3005 nil, this is the unfiltered buffer-substring) is passed to the
3006 first function on `filter-buffer-substring-functions'.
3008 As a special convention, point is set to the start of the buffer text
3009 being operated on (i.e., the first argument of `filter-buffer-substring')
3010 before these functions are called.")
3011 (make-obsolete-variable 'buffer-substring-filters
3012 'filter-buffer-substring-functions "24.1")
3014 (defun filter-buffer-substring (beg end &optional delete)
3015 "Return the buffer substring between BEG and END, after filtering.
3016 The wrapper hook `filter-buffer-substring-functions' performs
3017 the actual filtering. The obsolete variable `buffer-substring-filters'
3018 is also consulted. If both of these are nil, no filtering is done.
3020 If DELETE is non-nil, the text between BEG and END is deleted
3021 from the buffer.
3023 This function should be used instead of `buffer-substring',
3024 `buffer-substring-no-properties', or `delete-and-extract-region'
3025 when you want to allow filtering to take place. For example,
3026 major or minor modes can use `filter-buffer-substring-functions' to
3027 extract characters that are special to a buffer, and should not
3028 be copied into other buffers."
3029 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
3030 (cond
3031 ((or delete buffer-substring-filters)
3032 (save-excursion
3033 (goto-char beg)
3034 (let ((string (if delete (delete-and-extract-region beg end)
3035 (buffer-substring beg end))))
3036 (dolist (filter buffer-substring-filters)
3037 (setq string (funcall filter string)))
3038 string)))
3039 (t
3040 (buffer-substring beg end)))))
3043 ;;;; Window system cut and paste hooks.
3045 (defvar interprogram-cut-function nil
3046 "Function to call to make a killed region available to other programs.
3047 Most window systems provide a facility for cutting and pasting
3048 text between different programs, such as the clipboard on X and
3049 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3051 This variable holds a function that Emacs calls whenever text is
3052 put in the kill ring, to make the new kill available to other
3053 programs. The function takes one argument, TEXT, which is a
3054 string containing the text which should be made available.")
3056 (defvar interprogram-paste-function nil
3057 "Function to call to get text cut from other programs.
3058 Most window systems provide a facility for cutting and pasting
3059 text between different programs, such as the clipboard on X and
3060 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3062 This variable holds a function that Emacs calls to obtain text
3063 that other programs have provided for pasting. The function is
3064 called with no arguments. If no other program has provided text
3065 to paste, the function should return nil (in which case the
3066 caller, usually `current-kill', should use the top of the Emacs
3067 kill ring). If another program has provided text to paste, the
3068 function should return that text as a string (in which case the
3069 caller should put this string in the kill ring as the latest
3070 kill).
3072 The function may also return a list of strings if the window
3073 system supports multiple selections. The first string will be
3074 used as the pasted text, but the other will be placed in the kill
3075 ring for easy access via `yank-pop'.
3077 Note that the function should return a string only if a program
3078 other than Emacs has provided a string for pasting; if Emacs
3079 provided the most recent string, the function should return nil.
3080 If it is difficult to tell whether Emacs or some other program
3081 provided the current string, it is probably good enough to return
3082 nil if the string is equal (according to `string=') to the last
3083 text Emacs provided.")
3084 \f
3087 ;;;; The kill ring data structure.
3089 (defvar kill-ring nil
3090 "List of killed text sequences.
3091 Since the kill ring is supposed to interact nicely with cut-and-paste
3092 facilities offered by window systems, use of this variable should
3093 interact nicely with `interprogram-cut-function' and
3094 `interprogram-paste-function'. The functions `kill-new',
3095 `kill-append', and `current-kill' are supposed to implement this
3096 interaction; you may want to use them instead of manipulating the kill
3097 ring directly.")
3099 (defcustom kill-ring-max 60
3100 "Maximum length of kill ring before oldest elements are thrown away."
3101 :type 'integer
3102 :group 'killing)
3104 (defvar kill-ring-yank-pointer nil
3105 "The tail of the kill ring whose car is the last thing yanked.")
3107 (defcustom save-interprogram-paste-before-kill nil
3108 "Save clipboard strings into kill ring before replacing them.
3109 When one selects something in another program to paste it into Emacs,
3110 but kills something in Emacs before actually pasting it,
3111 this selection is gone unless this variable is non-nil,
3112 in which case the other program's selection is saved in the `kill-ring'
3114 :type 'boolean
3115 :group 'killing
3116 :version "23.2")
3118 (defcustom kill-do-not-save-duplicates nil
3119 "Do not add a new string to `kill-ring' if it duplicates the last one.
3120 The comparison is done using `equal-including-properties'."
3121 :type 'boolean
3122 :group 'killing
3123 :version "23.2")
3125 (defun kill-new (string &optional replace yank-handler)
3126 "Make STRING the latest kill in the kill ring.
3127 Set `kill-ring-yank-pointer' to point to it.
3128 If `interprogram-cut-function' is non-nil, apply it to STRING.
3129 Optional second argument REPLACE non-nil means that STRING will replace
3130 the front of the kill ring, rather than being added to the list.
3132 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3133 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3134 STRING.
3136 When the yank handler has a non-nil PARAM element, the original STRING
3137 argument is not used by `insert-for-yank'. However, since Lisp code
3138 may access and use elements from the kill ring directly, the STRING
3140 (if (> (length string) 0)
3141 (if yank-handler
3142 (put-text-property 0 (length string)
3143 'yank-handler yank-handler string))
3144 (if yank-handler
3145 (signal 'args-out-of-range
3146 (list string "yank-handler specified for empty string"))))
3147 (unless (and kill-do-not-save-duplicates
3148 ;; Due to text properties such as 'yank-handler that
3149 ;; can alter the contents to yank, comparison using
3150 ;; `equal' is unsafe.
3151 (equal-including-properties string (car kill-ring)))
3152 (if (fboundp 'menu-bar-update-yank-menu)
3153 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3154 (when save-interprogram-paste-before-kill
3155 (let ((interprogram-paste (and interprogram-paste-function
3156 (funcall interprogram-paste-function))))
3157 (when interprogram-paste
3158 (dolist (s (if (listp interprogram-paste)
3159 (nreverse interprogram-paste)
3160 (list interprogram-paste)))
3161 (unless (and kill-do-not-save-duplicates
3162 (equal-including-properties s (car kill-ring)))
3163 (push s kill-ring))))))
3164 (unless (and kill-do-not-save-duplicates
3165 (equal-including-properties string (car kill-ring)))
3166 (if (and replace kill-ring)
3167 (setcar kill-ring string)
3168 (push string kill-ring)
3169 (if (> (length kill-ring) kill-ring-max)
3170 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3171 (setq kill-ring-yank-pointer kill-ring)
3172 (if interprogram-cut-function
3173 (funcall interprogram-cut-function string)))
3174 (set-advertised-calling-convention
3175 'kill-new '(string &optional replace) "23.3")
3177 (defun kill-append (string before-p &optional yank-handler)
3178 "Append STRING to the end of the latest kill in the kill ring.
3179 If BEFORE-P is non-nil, prepend STRING to the kill.
3180 If `interprogram-cut-function' is set, pass the resulting kill to it."
3181 (let* ((cur (car kill-ring)))
3182 (kill-new (if before-p (concat string cur) (concat cur string))
3183 (or (= (length cur) 0)
3184 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3185 yank-handler)))
3186 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3188 (defcustom yank-pop-change-selection nil
3189 "Whether rotating the kill ring changes the window system selection.
3190 If non-nil, whenever the kill ring is rotated (usually via the
3191 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3192 to copy the new kill to the window system selection."
3193 :type 'boolean
3194 :group 'killing
3195 :version "23.1")
3197 (defun current-kill (n &optional do-not-move)
3198 "Rotate the yanking point by N places, and then return that kill.
3199 If N is zero and `interprogram-paste-function' is set to a
3200 function that returns a string or a list of strings, and if that
3201 function doesn't return nil, then that string (or list) is added
3202 to the front of the kill ring and the string (or first string in
3203 the list) is returned as the latest kill.
3205 If N is not zero, and if `yank-pop-change-selection' is
3206 non-nil, use `interprogram-cut-function' to transfer the
3207 kill at the new yank point into the window system selection.
3209 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3210 move the yanking point; just return the Nth kill forward."
3212 (let ((interprogram-paste (and (= n 0)
3213 interprogram-paste-function
3214 (funcall interprogram-paste-function))))
3215 (if interprogram-paste
3216 (progn
3217 ;; Disable the interprogram cut function when we add the new
3218 ;; text to the kill ring, so Emacs doesn't try to own the
3219 ;; selection, with identical text.
3220 (let ((interprogram-cut-function nil))
3221 (if (listp interprogram-paste)
3222 (mapc 'kill-new (nreverse interprogram-paste))
3223 (kill-new interprogram-paste)))
3224 (car kill-ring))
3225 (or kill-ring (error "Kill ring is empty"))
3226 (let ((ARGth-kill-element
3227 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3228 (length kill-ring))
3229 kill-ring)))
3230 (unless do-not-move
3231 (setq kill-ring-yank-pointer ARGth-kill-element)
3232 (when (and yank-pop-change-selection
3233 (> n 0)
3234 interprogram-cut-function)
3235 (funcall interprogram-cut-function (car ARGth-kill-element))))
3236 (car ARGth-kill-element)))))
3240 ;;;; Commands for manipulating the kill ring.
3242 (defcustom kill-read-only-ok nil
3243 "Non-nil means don't signal an error for killing read-only text."
3244 :type 'boolean
3245 :group 'killing)
3247 (defun kill-region (beg end &optional yank-handler)
3249 This deletes the text from the buffer and saves it in the kill ring.
3253 If you want to append the killed region to the last killed text,
3256 If the buffer is read-only, Emacs will beep and refrain from deleting
3257 the text, but put the text in the kill ring anyway. This means that
3258 you can use the killing commands to copy text from a read-only buffer.
3260 Lisp programs should use this function for killing text.
3261 (To delete text, use `delete-region'.)
3262 Supply two arguments, character positions indicating the stretch of text
3263 to be killed.
3265 If the previous command was also a kill command,
3266 the text killed this time appends to the text killed last time
3267 to make one entry in the kill ring."
3268 ;; Pass point first, then mark, because the order matters
3269 ;; when calling kill-append.
3270 (interactive (list (point) (mark)))
3271 (unless (and beg end)
3272 (error "The mark is not set now, so there is no region"))
3273 (condition-case nil
3274 (let ((string (filter-buffer-substring beg end t)))
3275 (when string ;STRING is nil if BEG = END
3276 ;; Add that string to the kill ring, one way or another.
3277 (if (eq last-command 'kill-region)
3278 (kill-append string (< end beg) yank-handler)
3279 (kill-new string nil yank-handler)))
3280 (when (or string (eq last-command 'kill-region))
3281 (setq this-command 'kill-region))
3282 nil)
3283 ((buffer-read-only text-read-only)
3284 ;; The code above failed because the buffer, or some of the characters
3285 ;; in the region, are read-only.
3286 ;; We should beep, in case the user just isn't aware of this.
3287 ;; However, there's no harm in putting
3288 ;; the region's text in the kill ring, anyway.
3289 (copy-region-as-kill beg end)
3290 ;; Set this-command now, so it will be set even if we get an error.
3291 (setq this-command 'kill-region)
3292 ;; This should barf, if appropriate, and give us the correct error.
3293 (if kill-read-only-ok
3294 (progn (message "Read only text copied to kill ring") nil)
3295 ;; Signal an error if the buffer is read-only.
3296 (barf-if-buffer-read-only)
3297 ;; If the buffer isn't read-only, the text is.
3298 (signal 'text-read-only (list (current-buffer)))))))
3299 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3301 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3302 ;; to get two copies of the text when the user accidentally types M-w and
3303 ;; then corrects it with the intended C-w.
3304 (defun copy-region-as-kill (beg end)
3305 "Save the region as if killed, but don't kill it.
3306 In Transient Mark mode, deactivate the mark.
3307 If `interprogram-cut-function' is non-nil, also save the text for a window
3308 system cut and paste.
3310 This command's old key binding has been given to `kill-ring-save'."
3311 (interactive "r")
3312 (if (eq last-command 'kill-region)
3313 (kill-append (filter-buffer-substring beg end) (< end beg))
3314 (kill-new (filter-buffer-substring beg end)))
3315 (setq deactivate-mark t)
3316 nil)
3318 (defun kill-ring-save (beg end)
3319 "Save the region as if killed, but don't kill it.
3320 In Transient Mark mode, deactivate the mark.
3321 If `interprogram-cut-function' is non-nil, also save the text for a window
3322 system cut and paste.
3324 If you want to append the killed line to the last killed text,
3327 This command is similar to `copy-region-as-kill', except that it gives
3328 visual feedback indicating the extent of the region being copied."
3329 (interactive "r")
3330 (copy-region-as-kill beg end)
3331 ;; This use of called-interactively-p is correct
3332 ;; because the code it controls just gives the user visual feedback.
3333 (if (called-interactively-p 'interactive)
3334 (let ((other-end (if (= (point) beg) end beg))
3335 (opoint (point))
3336 ;; Inhibit quitting so we can make a quit here
3337 ;; look like a C-g typed as a command.
3338 (inhibit-quit t))
3339 (if (pos-visible-in-window-p other-end (selected-window))
3340 ;; Swap point-and-mark quickly so as to show the region that
3341 ;; was selected. Don't do it if the region is highlighted.
3342 (unless (and (region-active-p)
3343 (face-background 'region))
3344 ;; Swap point and mark.
3345 (set-marker (mark-marker) (point) (current-buffer))
3346 (goto-char other-end)
3347 (sit-for blink-matching-delay)
3348 ;; Swap back.
3349 (set-marker (mark-marker) other-end (current-buffer))
3350 (goto-char opoint)
3351 ;; If user quit, deactivate the mark
3352 ;; as C-g would as a command.
3353 (and quit-flag mark-active
3354 (deactivate-mark)))
3355 (let* ((killed-text (current-kill 0))
3356 (message-len (min (length killed-text) 40)))
3357 (if (= (point) beg)
3358 ;; Don't say "killed"; that is misleading.
3360 (substring killed-text (- message-len)))
3362 (substring killed-text 0 message-len))))))))
3364 (defun append-next-kill (&optional interactive)
3365 "Cause following command, if it kills, to append to previous kill.
3366 The argument is used for internal purposes; do not supply one."
3367 (interactive "p")
3368 ;; We don't use (interactive-p), since that breaks kbd macros.
3369 (if interactive
3370 (progn
3371 (setq this-command 'kill-region)
3372 (message "If the next command is a kill, it will append"))
3373 (setq last-command 'kill-region)))
3374 \f
3375 ;; Yanking.
3377 ;; This is actually used in subr.el but defcustom does not work there.
3378 (defcustom yank-excluded-properties
3379 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3380 yank-handler follow-link fontified)
3381 "Text properties to discard when yanking.
3382 The value should be a list of text properties to discard or t,
3383 which means to discard all text properties."
3384 :type '(choice (const :tag "All" t) (repeat symbol))
3385 :group 'killing
3386 :version "22.1")
3388 (defvar yank-window-start nil)
3389 (defvar yank-undo-function nil
3390 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3391 Function is called with two parameters, START and END corresponding to
3392 the value of the mark and point; it is guaranteed that START <= END.
3393 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3395 (defun yank-pop (&optional arg)
3396 "Replace just-yanked stretch of killed text with a different stretch.
3397 This command is allowed only immediately after a `yank' or a `yank-pop'.
3398 At such a time, the region contains a stretch of reinserted
3399 previously-killed text. `yank-pop' deletes that text and inserts in its
3400 place a different stretch of killed text.
3402 With no argument, the previous kill is inserted.
3403 With argument N, insert the Nth previous kill.
3404 If N is negative, this is a more recent kill.
3406 The sequence of kills wraps around, so that after the oldest one
3407 comes the newest one.
3409 When this command inserts killed text into the buffer, it honors
3410 `yank-excluded-properties' and `yank-handler' as described in the
3411 doc string for `insert-for-yank-1', which see."
3412 (interactive "*p")
3413 (if (not (eq last-command 'yank))
3414 (error "Previous command was not a yank"))
3415 (setq this-command 'yank)
3416 (unless arg (setq arg 1))
3417 (let ((inhibit-read-only t)
3418 (before (< (point) (mark t))))
3419 (if before
3420 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3421 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3422 (setq yank-undo-function nil)
3423 (set-marker (mark-marker) (point) (current-buffer))
3424 (insert-for-yank (current-kill arg))
3425 ;; Set the window start back where it was in the yank command,
3426 ;; if possible.
3427 (set-window-start (selected-window) yank-window-start t)
3428 (if before
3429 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3430 ;; It is cleaner to avoid activation, even though the command
3431 ;; loop would deactivate the mark because we inserted text.
3432 (goto-char (prog1 (mark t)
3433 (set-marker (mark-marker) (point) (current-buffer))))))
3434 nil)
3436 (defun yank (&optional arg)
3438 More precisely, reinsert the stretch of killed text most recently
3439 killed OR yanked. Put point at end, and set mark at beginning.
3440 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3441 With argument N, reinsert the Nth most recently killed stretch of killed
3442 text.
3444 When this command inserts killed text into the buffer, it honors
3445 `yank-excluded-properties' and `yank-handler' as described in the
3446 doc string for `insert-for-yank-1', which see.
3449 (interactive "*P")
3450 (setq yank-window-start (window-start))
3451 ;; If we don't get all the way thru, make last-command indicate that
3452 ;; for the following command.
3453 (setq this-command t)
3454 (push-mark (point))
3455 (insert-for-yank (current-kill (cond
3456 ((listp arg) 0)
3457 ((eq arg '-) -2)
3458 (t (1- arg)))))
3459 (if (consp arg)
3460 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3461 ;; It is cleaner to avoid activation, even though the command
3462 ;; loop would deactivate the mark because we inserted text.
3463 (goto-char (prog1 (mark t)
3464 (set-marker (mark-marker) (point) (current-buffer)))))
3465 ;; If we do get all the way thru, make this-command indicate that.
3466 (if (eq this-command t)
3467 (setq this-command 'yank))
3468 nil)
3470 (defun rotate-yank-pointer (arg)
3471 "Rotate the yanking point in the kill ring.
3472 With ARG, rotate that many kills forward (or backward, if negative)."
3473 (interactive "p")
3474 (current-kill arg))
3475 \f
3476 ;; Some kill commands.
3478 ;; Internal subroutine of delete-char
3479 (defun kill-forward-chars (arg)
3480 (if (listp arg) (setq arg (car arg)))
3481 (if (eq arg '-) (setq arg -1))
3482 (kill-region (point) (+ (point) arg)))
3484 ;; Internal subroutine of backward-delete-char
3485 (defun kill-backward-chars (arg)
3486 (if (listp arg) (setq arg (car arg)))
3487 (if (eq arg '-) (setq arg -1))
3488 (kill-region (point) (- (point) arg)))
3490 (defcustom backward-delete-char-untabify-method 'untabify
3491 "The method for untabifying when deleting backward.
3492 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3493 `hungry' -- delete all whitespace, both tabs and spaces;
3494 `all' -- delete all whitespace, including tabs, spaces and newlines;
3495 nil -- just delete one character."
3496 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3497 :version "20.3"
3498 :group 'killing)
3500 (defun backward-delete-char-untabify (arg &optional killp)
3501 "Delete characters backward, changing tabs into spaces.
3502 The exact behavior depends on `backward-delete-char-untabify-method'.
3503 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3504 Interactively, ARG is the prefix arg (default 1)
3505 and KILLP is t if a prefix arg was specified."
3507 (when (eq backward-delete-char-untabify-method 'untabify)
3508 (let ((count arg))
3509 (save-excursion
3510 (while (and (> count 0) (not (bobp)))
3512 (let ((col (current-column)))
3513 (forward-char -1)
3514 (setq col (- col (current-column)))
3515 (insert-char ?\s col)
3516 (delete-char 1)))
3517 (forward-char -1)
3518 (setq count (1- count))))))
3520 ((eq backward-delete-char-untabify-method 'all)
3522 (n (if skip
3523 (let* ((oldpt (point))
3524 (wh (- oldpt (save-excursion
3525 (skip-chars-backward skip)
3526 (constrain-to-field nil oldpt)))))
3527 (+ arg (if (zerop wh) 0 (1- wh))))
3528 arg)))
3529 ;; Avoid warning about delete-backward-char
3530 (with-no-warnings (delete-backward-char n killp))))
3532 (defun zap-to-char (arg char)
3533 "Kill up to and including ARGth occurrence of CHAR.
3534 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3535 Goes backward if ARG is negative; error if CHAR not found."
3536 (interactive (list (prefix-numeric-value current-prefix-arg)
3537 (read-char "Zap to char: " t)))
3538 ;; Avoid "obsolete" warnings for translation-table-for-input.
3539 (with-no-warnings
3540 (if (char-table-p translation-table-for-input)
3541 (setq char (or (aref translation-table-for-input char) char))))
3542 (kill-region (point) (progn
3543 (search-forward (char-to-string char) nil nil arg)
3544 (point))))
3546 ;; kill-line and its subroutines.
3548 (defcustom kill-whole-line nil
3549 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
3550 :type 'boolean
3551 :group 'killing)
3553 (defun kill-line (&optional arg)
3554 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3555 With prefix argument ARG, kill that many lines from point.
3556 Negative arguments kill lines backward.
3557 With zero argument, kills the text before point on the current line.
3560 a number counts as a prefix arg.
3562 To kill a whole line, when point is not at the beginning, type \
3565 If `show-trailing-whitespace' is non-nil, this command will just
3566 kill the rest of the current line, even if there are only
3567 nonblanks there.
3569 If `kill-whole-line' is non-nil, then this command kills the whole line
3570 including its terminating newline, when used at the beginning of a line
3571 with no argument. As a consequence, you can always kill a whole line
3574 If you want to append the killed line to the last killed text,
3577 If the buffer is read-only, Emacs will beep and refrain from deleting
3578 the line, but put the line in the kill ring anyway. This means that
3579 you can use this command to copy text from a read-only buffer.
3580 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3581 even beep.)"
3582 (interactive "P")
3583 (kill-region (point)
3584 ;; It is better to move point to the other end of the kill
3585 ;; before killing. That way, in a read-only buffer, point
3586 ;; moves across the text that is copied to the kill ring.
3587 ;; The choice has no effect on undo now that undo records
3588 ;; the value of point from before the command was run.
3589 (progn
3590 (if arg
3591 (forward-visible-line (prefix-numeric-value arg))
3592 (if (eobp)
3593 (signal 'end-of-buffer nil))
3594 (let ((end
3595 (save-excursion
3596 (end-of-visible-line) (point))))
3597 (if (or (save-excursion
3598 ;; If trailing whitespace is visible,
3599 ;; don't treat it as nothing.
3600 (unless show-trailing-whitespace
3602 (= (point) end))
3603 (and kill-whole-line (bolp)))
3604 (forward-visible-line 1)
3605 (goto-char end))))
3606 (point))))
3608 (defun kill-whole-line (&optional arg)
3609 "Kill current line.
3610 With prefix ARG, kill that many lines starting from the current line.
3611 If ARG is negative, kill backward. Also kill the preceding newline.
3613 If ARG is zero, kill current line but exclude the trailing newline."
3614 (interactive "p")
3615 (or arg (setq arg 1))
3616 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3617 (signal 'end-of-buffer nil))
3618 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3619 (signal 'beginning-of-buffer nil))
3620 (unless (eq last-command 'kill-region)
3621 (kill-new "")
3622 (setq last-command 'kill-region))
3623 (cond ((zerop arg)
3624 ;; We need to kill in two steps, because the previous command
3625 ;; could have been a kill command, in which case the text
3626 ;; before point needs to be prepended to the current kill
3627 ;; ring entry and the text after point appended. Also, we
3628 ;; need to use save-excursion to avoid copying the same text
3629 ;; twice to the kill ring in read-only buffers.
3630 (save-excursion
3631 (kill-region (point) (progn (forward-visible-line 0) (point))))
3632 (kill-region (point) (progn (end-of-visible-line) (point))))
3633 ((< arg 0)
3634 (save-excursion
3635 (kill-region (point) (progn (end-of-visible-line) (point))))
3636 (kill-region (point)
3637 (progn (forward-visible-line (1+ arg))
3638 (unless (bobp) (backward-char))
3639 (point))))
3640 (t
3641 (save-excursion
3642 (kill-region (point) (progn (forward-visible-line 0) (point))))
3643 (kill-region (point)
3644 (progn (forward-visible-line arg) (point))))))
3646 (defun forward-visible-line (arg)
3647 "Move forward by ARG lines, ignoring currently invisible newlines only.
3648 If ARG is negative, move backward -ARG lines.
3649 If ARG is zero, move to the beginning of the current line."
3650 (condition-case nil
3651 (if (> arg 0)
3652 (progn
3653 (while (> arg 0)
3654 (or (zerop (forward-line 1))
3655 (signal 'end-of-buffer nil))
3656 ;; If the newline we just skipped is invisible,
3657 ;; don't count it.
3658 (let ((prop
3659 (get-char-property (1- (point)) 'invisible)))
3660 (if (if (eq buffer-invisibility-spec t)
3661 prop
3662 (or (memq prop buffer-invisibility-spec)
3663 (assq prop buffer-invisibility-spec)))
3664 (setq arg (1+ arg))))
3665 (setq arg (1- arg)))
3666 ;; If invisible text follows, and it is a number of complete lines,
3667 ;; skip it.
3668 (let ((opoint (point)))
3669 (while (and (not (eobp))
3670 (let ((prop
3671 (get-char-property (point) 'invisible)))
3672 (if (eq buffer-invisibility-spec t)
3673 prop
3674 (or (memq prop buffer-invisibility-spec)
3675 (assq prop buffer-invisibility-spec)))))
3676 (goto-char
3677 (if (get-text-property (point) 'invisible)
3678 (or (next-single-property-change (point) 'invisible)
3679 (point-max))
3680 (next-overlay-change (point)))))
3681 (unless (bolp)
3682 (goto-char opoint))))
3683 (let ((first t))
3684 (while (or first (<= arg 0))
3685 (if first
3686 (beginning-of-line)
3687 (or (zerop (forward-line -1))
3688 (signal 'beginning-of-buffer nil)))
3689 ;; If the newline we just moved to is invisible,
3690 ;; don't count it.
3691 (unless (bobp)
3692 (let ((prop
3693 (get-char-property (1- (point)) 'invisible)))
3694 (unless (if (eq buffer-invisibility-spec t)
3695 prop
3696 (or (memq prop buffer-invisibility-spec)
3697 (assq prop buffer-invisibility-spec)))
3698 (setq arg (1+ arg)))))
3699 (setq first nil))
3700 ;; If invisible text follows, and it is a number of complete lines,
3701 ;; skip it.
3702 (let ((opoint (point)))
3703 (while (and (not (bobp))
3704 (let ((prop
3705 (get-char-property (1- (point)) 'invisible)))
3706 (if (eq buffer-invisibility-spec t)
3707 prop
3708 (or (memq prop buffer-invisibility-spec)
3709 (assq prop buffer-invisibility-spec)))))
3710 (goto-char
3711 (if (get-text-property (1- (point)) 'invisible)
3712 (or (previous-single-property-change (point) 'invisible)
3713 (point-min))
3714 (previous-overlay-change (point)))))
3715 (unless (bolp)
3716 (goto-char opoint)))))
3717 ((beginning-of-buffer end-of-buffer)
3718 nil)))
3720 (defun end-of-visible-line ()
3721 "Move to end of current visible line."
3722 (end-of-line)
3723 ;; If the following character is currently invisible,
3724 ;; skip all characters with that same `invisible' property value,
3725 ;; then find the next newline.
3726 (while (and (not (eobp))
3727 (save-excursion
3729 (let ((prop
3730 (get-char-property (point) 'invisible)))
3731 (if (eq buffer-invisibility-spec t)
3732 prop
3733 (or (memq prop buffer-invisibility-spec)
3734 (assq prop buffer-invisibility-spec))))))
3736 (if (get-text-property (point) 'invisible)
3737 (goto-char (or (next-single-property-change (point) 'invisible)
3738 (point-max)))
3739 (goto-char (next-overlay-change (point))))
3740 (end-of-line)))
3741 \f
3742 (defun insert-buffer (buffer)
3743 "Insert after point the contents of BUFFER.
3744 Puts mark after the inserted text.
3745 BUFFER may be a buffer or a buffer name.
3747 This function is meant for the user to run interactively.
3748 Don't call it from programs: use `insert-buffer-substring' instead!"
3749 (interactive
3750 (list
3751 (progn
3752 (barf-if-buffer-read-only)
3753 (read-buffer "Insert buffer: "
3754 (if (eq (selected-window) (next-window (selected-window)))
3755 (other-buffer (current-buffer))
3756 (window-buffer (next-window (selected-window))))
3757 t))))
3758 (push-mark
3759 (save-excursion
3760 (insert-buffer-substring (get-buffer buffer))
3761 (point)))
3762 nil)
3764 (defun append-to-buffer (buffer start end)
3765 "Append to specified buffer the text of the region.
3766 It is inserted into that buffer before its point.
3768 When calling from a program, give three arguments:
3769 BUFFER (or buffer name), START and END.
3770 START and END specify the portion of the current buffer to be copied."
3771 (interactive
3772 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3773 (region-beginning) (region-end)))
3774 (let* ((oldbuf (current-buffer))
3775 (append-to (get-buffer-create buffer))
3776 (windows (get-buffer-window-list append-to t t))
3777 point)
3778 (save-excursion
3779 (with-current-buffer append-to
3780 (setq point (point))
3781 (barf-if-buffer-read-only)
3782 (insert-buffer-substring oldbuf start end)
3783 (dolist (window windows)
3784 (when (= (window-point window) point)
3785 (set-window-point window (point))))))))
3787 (defun prepend-to-buffer (buffer start end)
3788 "Prepend to specified buffer the text of the region.
3789 It is inserted into that buffer after its point.
3791 When calling from a program, give three arguments:
3792 BUFFER (or buffer name), START and END.
3793 START and END specify the portion of the current buffer to be copied."
3795 (let ((oldbuf (current-buffer)))
3796 (with-current-buffer (get-buffer-create buffer)
3797 (barf-if-buffer-read-only)
3798 (save-excursion
3799 (insert-buffer-substring oldbuf start end)))))
3801 (defun copy-to-buffer (buffer start end)
3802 "Copy to specified buffer the text of the region.
3803 It is inserted into that buffer, replacing existing text there.
3805 When calling from a program, give three arguments:
3806 BUFFER (or buffer name), START and END.
3807 START and END specify the portion of the current buffer to be copied."
3809 (let ((oldbuf (current-buffer)))
3810 (with-current-buffer (get-buffer-create buffer)
3811 (barf-if-buffer-read-only)
3812 (erase-buffer)
3813 (save-excursion
3814 (insert-buffer-substring oldbuf start end)))))
3815 \f
3816 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3817 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3819 (defvar activate-mark-hook nil
3820 "Hook run when the mark becomes active.
3821 It is also run at the end of a command, if the mark is active and
3822 it is possible that the region may have changed.")
3824 (defvar deactivate-mark-hook nil
3825 "Hook run when the mark becomes inactive.")
3827 (defun mark (&optional force)
3828 "Return this buffer's mark value as integer, or nil if never set.
3830 In Transient Mark mode, this function signals an error if
3831 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3832 or the argument FORCE is non-nil, it disregards whether the mark
3833 is active, and returns an integer or nil in the usual way.
3835 If you are using this in an editing command, you are most likely making
3836 a mistake; see the documentation of `set-mark'."
3837 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3838 (marker-position (mark-marker))
3839 (signal 'mark-inactive nil)))
3841 (defsubst deactivate-mark (&optional force)
3842 "Deactivate the mark.
3843 If Transient Mark mode is disabled, this function normally does
3844 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
3846 Deactivating the mark sets `mark-active' to nil, updates the
3847 primary selection according to `select-active-regions', and runs
3848 `deactivate-mark-hook'.
3850 If Transient Mark mode was temporarily enabled, reset the value
3851 of the variable `transient-mark-mode'; if this causes Transient
3852 Mark mode to be disabled, don't change `mark-active' to nil or
3853 run `deactivate-mark-hook'."
3854 (when (or transient-mark-mode force)
3855 (when (and (if (eq select-active-regions 'only)
3856 (eq (car-safe transient-mark-mode) 'only)
3857 select-active-regions)
3858 (region-active-p)
3859 (display-selections-p))
3860 ;; The var `saved-region-selection', if non-nil, is the text in
3861 ;; the region prior to the last command modifying the buffer.
3862 ;; Set the selection to that, or to the current region.
3863 (cond (saved-region-selection
3864 (x-set-selection 'PRIMARY saved-region-selection)
3865 (setq saved-region-selection nil))
3866 ((/= (region-beginning) (region-end))
3867 (x-set-selection 'PRIMARY
3868 (buffer-substring-no-properties
3869 (region-beginning)
3870 (region-end))))))
3871 (if (and (null force)
3872 (or (eq transient-mark-mode 'lambda)
3873 (and (eq (car-safe transient-mark-mode) 'only)
3874 (null (cdr transient-mark-mode)))))
3875 ;; When deactivating a temporary region, don't change
3876 ;; `mark-active' or run `deactivate-mark-hook'.
3877 (setq transient-mark-mode nil)
3878 (if (eq (car-safe transient-mark-mode) 'only)
3879 (setq transient-mark-mode (cdr transient-mark-mode)))
3880 (setq mark-active nil)
3881 (run-hooks 'deactivate-mark-hook))))
3883 (defun activate-mark ()
3884 "Activate the mark."
3885 (when (mark t)
3886 (setq mark-active t)
3887 (unless transient-mark-mode
3888 (setq transient-mark-mode 'lambda))))
3890 (defun set-mark (pos)
3891 "Set this buffer's mark to POS. Don't use this function!
3892 That is to say, don't use this function unless you want
3893 the user to see that the mark has moved, and you want the previous
3894 mark position to be lost.
3896 Normally, when a new mark is set, the old one should go on the stack.
3897 This is why most applications should use `push-mark', not `set-mark'.
3899 Novice Emacs Lisp programmers often try to use the mark for the wrong
3900 purposes. The mark saves a location for the user's convenience.
3901 Most editing commands should not alter the mark.
3902 To remember a location for internal use in the Lisp program,
3903 store it in a Lisp variable. Example:
3905 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3907 (if pos
3908 (progn
3909 (setq mark-active t)
3910 (run-hooks 'activate-mark-hook)
3911 (set-marker (mark-marker) pos (current-buffer)))
3912 ;; Normally we never clear mark-active except in Transient Mark mode.
3913 ;; But when we actually clear out the mark value too, we must
3914 ;; clear mark-active in any mode.
3915 (deactivate-mark t)
3916 (set-marker (mark-marker) nil)))
3918 (defcustom use-empty-active-region nil
3920 If nil, region-aware commands treat empty regions as inactive.
3921 If non-nil, region-aware commands treat the region as active as
3922 long as the mark is active, even if the region is empty.
3924 Region-aware commands are those that act on the region if it is
3925 active and Transient Mark mode is enabled, and on the text near
3926 point otherwise."
3927 :type 'boolean
3928 :version "23.1"
3929 :group 'editing-basics)
3931 (defun use-region-p ()
3932 "Return t if the region is active and it is appropriate to act on it.
3933 This is used by commands that act specially on the region under
3934 Transient Mark mode.
3936 The return value is t if Transient Mark mode is enabled and the
3937 mark is active; furthermore, if `use-empty-active-region' is nil,
3938 the region must not be empty. Otherwise, the return value is nil.
3940 For some commands, it may be appropriate to ignore the value of
3941 `use-empty-active-region'; in that case, use `region-active-p'."
3942 (and (region-active-p)
3943 (or use-empty-active-region (> (region-end) (region-beginning)))))
3945 (defun region-active-p ()
3946 "Return t if Transient Mark mode is enabled and the mark is active.
3948 Some commands act specially on the region when Transient Mark
3949 mode is enabled. Usually, such commands should use
3950 `use-region-p' instead of this function, because `use-region-p'
3951 also checks the value of `use-empty-active-region'."
3952 (and transient-mark-mode mark-active))
3954 (defvar mark-ring nil
3955 "The list of former marks of the current buffer, most recent first.")
3956 (make-variable-buffer-local 'mark-ring)
3957 (put 'mark-ring 'permanent-local t)
3959 (defcustom mark-ring-max 16
3960 "Maximum size of mark ring. Start discarding off end if gets this big."
3961 :type 'integer
3962 :group 'editing-basics)
3964 (defvar global-mark-ring nil
3965 "The list of saved global marks, most recent first.")
3967 (defcustom global-mark-ring-max 16
3968 "Maximum size of global mark ring. \
3969 Start discarding off end if gets this big."
3970 :type 'integer
3971 :group 'editing-basics)
3973 (defun pop-to-mark-command ()
3974 "Jump to mark, and pop a new position for mark off the ring.
3975 \(Does not affect global mark ring\)."
3976 (interactive)
3977 (if (null (mark t))
3978 (error "No mark set in this buffer")
3979 (if (= (point) (mark t))
3980 (message "Mark popped"))
3981 (goto-char (mark t))
3982 (pop-mark)))
3984 (defun push-mark-command (arg &optional nomsg)
3985 "Set mark at where point is.
3986 If no prefix ARG and mark is already set there, just activate it.
3987 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3988 (interactive "P")
3989 (let ((mark (marker-position (mark-marker))))
3990 (if (or arg (null mark) (/= mark (point)))
3991 (push-mark nil nomsg t)
3992 (setq mark-active t)
3993 (run-hooks 'activate-mark-hook)
3994 (unless nomsg
3995 (message "Mark activated")))))
3997 (defcustom set-mark-command-repeat-pop nil
4000 will pop the mark twice, and
4002 will pop the mark three times.
4006 :type 'boolean
4007 :group 'editing-basics)
4009 (defcustom set-mark-default-inactive nil
4010 "If non-nil, setting the mark does not activate it.
4012 behave the same whether or not `transient-mark-mode' is enabled."
4013 :type 'boolean
4014 :group 'editing-basics
4015 :version "23.1")
4017 (defun set-mark-command (arg)
4018 "Set the mark where point is, or jump to the mark.
4019 Setting the mark also alters the region, which is the text
4020 between point and mark; this is the closest equivalent in
4023 With no prefix argument, set the mark at point, and push the
4024 old mark position on local mark ring. Also push the old mark on
4025 global mark ring, if the previous mark was set in another buffer.
4027 When Transient Mark Mode is off, immediately repeating this
4028 command activates `transient-mark-mode' temporarily.
4031 jump to the mark, and set the mark from
4032 position popped off the local mark ring \(this does not affect the global
4034 mark ring \(see `pop-global-mark'\).
4036 If `set-mark-command-repeat-pop' is non-nil, repeating
4038 off the local (or global) mark ring and jumps there.
4041 argument, unconditionally set mark where point is, even if
4042 `set-mark-command-repeat-pop' is non-nil.
4044 Novice Emacs Lisp programmers often try to use the mark for the wrong
4045 purposes. See the documentation of `set-mark' for more information."
4046 (interactive "P")
4047 (cond ((eq transient-mark-mode 'lambda)
4048 (setq transient-mark-mode nil))
4049 ((eq (car-safe transient-mark-mode) 'only)
4050 (deactivate-mark)))
4051 (cond
4052 ((and (consp arg) (> (prefix-numeric-value arg) 4))
4053 (push-mark-command nil))
4054 ((not (eq this-command 'set-mark-command))
4055 (if arg
4056 (pop-to-mark-command)
4057 (push-mark-command t)))
4058 ((and set-mark-command-repeat-pop
4059 (eq last-command 'pop-to-mark-command))
4060 (setq this-command 'pop-to-mark-command)
4061 (pop-to-mark-command))
4062 ((and set-mark-command-repeat-pop
4063 (eq last-command 'pop-global-mark)
4064 (not arg))
4065 (setq this-command 'pop-global-mark)
4066 (pop-global-mark))
4067 (arg
4068 (setq this-command 'pop-to-mark-command)
4069 (pop-to-mark-command))
4070 ((eq last-command 'set-mark-command)
4071 (if (region-active-p)
4072 (progn
4073 (deactivate-mark)
4074 (message "Mark deactivated"))
4075 (activate-mark)
4076 (message "Mark activated")))
4077 (t
4078 (push-mark-command nil)
4079 (if set-mark-default-inactive (deactivate-mark)))))
4081 (defun push-mark (&optional location nomsg activate)
4082 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4083 If the last global mark pushed was not in the current buffer,
4084 also push LOCATION on the global mark ring.
4085 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4087 Novice Emacs Lisp programmers often try to use the mark for the wrong
4088 purposes. See the documentation of `set-mark' for more information.
4090 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4091 (unless (null (mark t))
4092 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
4093 (when (> (length mark-ring) mark-ring-max)
4094 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
4095 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
4096 (set-marker (mark-marker) (or location (point)) (current-buffer))
4097 ;; Now push the mark on the global mark ring.
4098 (if (and global-mark-ring
4099 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
4100 ;; The last global mark pushed was in this same buffer.
4101 ;; Don't push another one.
4102 nil
4103 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4104 (when (> (length global-mark-ring) global-mark-ring-max)
4105 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4106 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4107 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4108 (message "Mark set"))
4109 (if (or activate (not transient-mark-mode))
4110 (set-mark (mark t)))
4111 nil)
4113 (defun pop-mark ()
4114 "Pop off mark ring into the buffer's actual mark.
4115 Does not set point. Does nothing if mark ring is empty."
4116 (when mark-ring
4117 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4118 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4119 (move-marker (car mark-ring) nil)
4120 (if (null (mark t)) (ding))
4121 (setq mark-ring (cdr mark-ring)))
4122 (deactivate-mark))
4124 (define-obsolete-function-alias
4125 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4126 (defun exchange-point-and-mark (&optional arg)
4127 "Put the mark where point is now, and point where the mark is now.
4128 This command works even when the mark is not active,
4129 and it reactivates the mark.
4131 If Transient Mark mode is on, a prefix ARG deactivates the mark
4132 if it is active, and otherwise avoids reactivating it. If
4133 Transient Mark mode is off, a prefix ARG enables Transient Mark
4134 mode temporarily."
4135 (interactive "P")
4136 (let ((omark (mark t))
4137 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4138 (if (null omark)
4139 (error "No mark set in this buffer"))
4140 (deactivate-mark)
4141 (set-mark (point))
4142 (goto-char omark)
4143 (if set-mark-default-inactive (deactivate-mark))
4144 (cond (temp-highlight
4145 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4146 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4147 (not (or arg (region-active-p))))
4148 (deactivate-mark))
4149 (t (activate-mark)))
4150 nil))
4152 (defcustom shift-select-mode t
4153 "When non-nil, shifted motion keys activate the mark momentarily.
4155 While the mark is activated in this way, any shift-translated point
4156 motion key extends the region, and if Transient Mark mode was off, it
4157 is temporarily turned on. Furthermore, the mark will be deactivated
4158 by any subsequent point motion key that was not shift-translated, or
4159 by any action that normally deactivates the mark in Transient Mark mode.
4161 See `this-command-keys-shift-translated' for the meaning of
4162 shift-translation."
4163 :type 'boolean
4164 :group 'editing-basics)
4166 (defun handle-shift-selection ()
4167 "Activate/deactivate mark depending on invocation thru shift translation.
4168 This function is called by `call-interactively' when a command
4169 with a `^' character in its `interactive' spec is invoked, before
4170 running the command itself.
4172 If `shift-select-mode' is enabled and the command was invoked
4173 through shift translation, set the mark and activate the region
4174 temporarily, unless it was already set in this way. See
4175 `this-command-keys-shift-translated' for the meaning of shift
4176 translation.
4178 Otherwise, if the region has been activated temporarily,
4179 deactivate it, and restore the variable `transient-mark-mode' to
4180 its earlier value."
4181 (cond ((and shift-select-mode this-command-keys-shift-translated)
4182 (unless (and mark-active
4183 (eq (car-safe transient-mark-mode) 'only))
4184 (setq transient-mark-mode
4185 (cons 'only
4186 (unless (eq transient-mark-mode 'lambda)
4187 transient-mark-mode)))
4188 (push-mark nil nil t)))
4189 ((eq (car-safe transient-mark-mode) 'only)
4190 (setq transient-mark-mode (cdr transient-mark-mode))
4191 (deactivate-mark))))
4193 (define-minor-mode transient-mark-mode
4194 "Toggle Transient Mark mode.
4195 With a prefix argument ARG, enable Transient Mark mode if ARG is
4196 positive, and disable it otherwise. If called from Lisp, enable
4197 Transient Mark mode if ARG is omitted or nil.
4199 Transient Mark mode is a global minor mode. When enabled, the
4200 region is highlighted whenever the mark is active. The mark is
4202 operations that set the mark but whose main purpose is something
4208 Many commands change their behavior when Transient Mark mode is in effect
4209 and the mark is active, by acting on the region instead of their usual
4210 default part of the buffer's text. Examples of such commands include
4215 commands which are sensitive to the Transient Mark mode."
4216 :global t
4217 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4218 :variable transient-mark-mode)
4220 (defvar widen-automatically t
4221 "Non-nil means it is ok for commands to call `widen' when they want to.
4222 Some commands will do this in order to go to positions outside
4223 the current accessible part of the buffer.
4225 If `widen-automatically' is nil, these commands will do something else
4226 as a fallback, and won't change the buffer bounds.")
4228 (defvar non-essential nil
4229 "Whether the currently executing code is performing an essential task.
4230 This variable should be non-nil only when running code which should not
4231 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4232 user for a password when we are simply scanning a set of files in the
4233 background or displaying possible completions before the user even asked
4234 for it.")
4236 (defun pop-global-mark ()
4237 "Pop off global mark ring and jump to the top location."
4238 (interactive)
4239 ;; Pop entries which refer to non-existent buffers.
4240 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4241 (setq global-mark-ring (cdr global-mark-ring)))
4242 (or global-mark-ring
4243 (error "No global mark set"))
4244 (let* ((marker (car global-mark-ring))
4245 (buffer (marker-buffer marker))
4246 (position (marker-position marker)))
4247 (setq global-mark-ring (nconc (cdr global-mark-ring)
4248 (list (car global-mark-ring))))
4249 (set-buffer buffer)
4250 (or (and (>= position (point-min))
4251 (<= position (point-max)))
4252 (if widen-automatically
4253 (widen)
4254 (error "Global mark position is outside accessible part of buffer")))
4255 (goto-char position)
4256 (switch-to-buffer buffer)))
4257 \f
4258 (defcustom next-line-add-newlines nil
4259 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4260 :type 'boolean
4261 :version "21.1"
4262 :group 'editing-basics)
4264 (defun next-line (&optional arg try-vscroll)
4265 "Move cursor vertically down ARG lines.
4266 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4267 If there is no character in the target line exactly under the current column,
4268 the cursor is positioned after the character in that line which spans this
4269 column, or at the end of the line if it is not long enough.
4270 If there is no line in the buffer after this one, behavior depends on the
4271 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4272 to create a line, and moves the cursor to that line. Otherwise it moves the
4273 cursor to the end of the buffer.
4275 If the variable `line-move-visual' is non-nil, this command moves
4276 by display lines. Otherwise, it moves by buffer lines, without
4277 taking variable-width characters or continued lines into account.
4280 a semipermanent goal column for this command.
4281 Then instead of trying to move exactly vertically (or as close as possible),
4282 this command moves to the specified goal column (or as close as possible).
4283 The goal column is stored in the variable `goal-column', which is nil
4284 when there is no goal column. Note that setting `goal-column'
4285 overrides `line-move-visual' and causes this command to move by buffer
4286 lines rather than by display lines.
4288 If you are thinking of using this in a Lisp program, consider
4289 using `forward-line' instead. It is usually easier to use
4290 and more reliable (no dependence on goal column, etc.)."
4292 (or arg (setq arg 1))
4293 (if (and next-line-add-newlines (= arg 1))
4294 (if (save-excursion (end-of-line) (eobp))
4295 ;; When adding a newline, don't expand an abbrev.
4296 (let ((abbrev-mode nil))
4297 (end-of-line)
4299 (line-move arg nil nil try-vscroll))
4300 (if (called-interactively-p 'interactive)
4301 (condition-case err
4302 (line-move arg nil nil try-vscroll)
4303 ((beginning-of-buffer end-of-buffer)
4304 (signal (car err) (cdr err))))
4305 (line-move arg nil nil try-vscroll)))
4306 nil)
4308 (defun previous-line (&optional arg try-vscroll)
4309 "Move cursor vertically up ARG lines.
4310 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4311 If there is no character in the target line exactly over the current column,
4312 the cursor is positioned after the character in that line which spans this
4313 column, or at the end of the line if it is not long enough.
4315 If the variable `line-move-visual' is non-nil, this command moves
4316 by display lines. Otherwise, it moves by buffer lines, without
4317 taking variable-width characters or continued lines into account.
4320 a semipermanent goal column for this command.
4321 Then instead of trying to move exactly vertically (or as close as possible),
4322 this command moves to the specified goal column (or as close as possible).
4323 The goal column is stored in the variable `goal-column', which is nil
4324 when there is no goal column. Note that setting `goal-column'
4325 overrides `line-move-visual' and causes this command to move by buffer
4326 lines rather than by display lines.
4328 If you are thinking of using this in a Lisp program, consider using
4329 `forward-line' with a negative argument instead. It is usually easier
4330 to use and more reliable (no dependence on goal column, etc.)."
4332 (or arg (setq arg 1))
4333 (if (called-interactively-p 'interactive)
4334 (condition-case err
4335 (line-move (- arg) nil nil try-vscroll)
4336 ((beginning-of-buffer end-of-buffer)
4337 (signal (car err) (cdr err))))
4338 (line-move (- arg) nil nil try-vscroll))
4339 nil)
4341 (defcustom track-eol nil
4342 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4343 This means moving to the end of each line moved onto.
4344 The beginning of a blank line does not count as the end of a line.
4345 This has no effect when `line-move-visual' is non-nil."
4346 :type 'boolean
4347 :group 'editing-basics)
4349 (defcustom goal-column nil
4351 A non-nil setting overrides `line-move-visual', which see."
4352 :type '(choice integer
4353 (const :tag "None" nil))
4354 :group 'editing-basics)
4355 (make-variable-buffer-local 'goal-column)
4357 (defvar temporary-goal-column 0
4358 "Current goal column for vertical motion.
4359 It is the column where point was at the start of the current run
4360 of vertical motion commands.
4362 When moving by visual lines via `line-move-visual', it is a cons
4363 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4364 divided by the default column width, and HSCROLL is the number of
4365 columns by which window is scrolled from left margin.
4367 When the `track-eol' feature is doing its job, the value is
4368 `most-positive-fixnum'.")
4370 (defcustom line-move-ignore-invisible t
4372 Outline mode sets this."
4373 :type 'boolean
4374 :group 'editing-basics)
4376 (defcustom line-move-visual t
4377 "When non-nil, `line-move' moves point by visual lines.
4378 This movement is based on where the cursor is displayed on the
4379 screen, instead of relying on buffer contents alone. It takes
4380 into account variable-width characters and line continuation.
4381 If nil, `line-move' moves point by logical lines.
4382 A non-nil setting of `goal-column' overrides the value of this variable
4383 and forces movement by logical lines.
4384 A window that is horizontally scrolled also forces movement by logical
4385 lines."
4386 :type 'boolean
4387 :group 'editing-basics
4388 :version "23.1")
4390 ;; Returns non-nil if partial move was done.
4391 (defun line-move-partial (arg noerror to-end)
4392 (if (< arg 0)
4393 ;; Move backward (up).
4394 ;; If already vscrolled, reduce vscroll
4395 (let ((vs (window-vscroll nil t)))
4396 (when (> vs (frame-char-height))
4397 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4399 ;; Move forward (down).
4400 (let* ((lh (window-line-height -1))
4401 (vpos (nth 1 lh))
4402 (ypos (nth 2 lh))
4403 (rbot (nth 3 lh))
4404 py vs)
4405 (when (or (null lh)
4406 (>= rbot (frame-char-height))
4407 (<= ypos (- (frame-char-height))))
4408 (unless lh
4409 (let ((wend (pos-visible-in-window-p t nil t)))
4410 (setq rbot (nth 3 wend)
4411 vpos (nth 5 wend))))
4412 (cond
4413 ;; If last line of window is fully visible, move forward.
4414 ((or (null rbot) (= rbot 0))
4415 nil)
4416 ;; If cursor is not in the bottom scroll margin, move forward.
4417 ((and (> vpos 0)
4418 (< (setq py
4419 (or (nth 1 (window-line-height))
4420 (let ((ppos (posn-at-point)))
4421 (cdr (or (posn-actual-col-row ppos)
4422 (posn-col-row ppos))))))
4423 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4424 nil)
4425 ;; When already vscrolled, we vscroll some more if we can,
4426 ;; or clear vscroll and move forward at end of tall image.
4427 ((> (setq vs (window-vscroll nil t)) 0)
4428 (when (> rbot 0)
4429 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4430 ;; If cursor just entered the bottom scroll margin, move forward,
4431 ;; but also vscroll one line so redisplay won't recenter.
4432 ((and (> vpos 0)
4433 (= py (min (- (window-text-height) scroll-margin 1)
4434 (1- vpos))))
4435 (set-window-vscroll nil (frame-char-height) t)
4436 (line-move-1 arg noerror to-end)
4437 t)
4438 ;; If there are lines above the last line, scroll-up one line.
4439 ((> vpos 0)
4440 (scroll-up 1)
4441 t)
4442 ;; Finally, start vscroll.
4443 (t
4444 (set-window-vscroll nil (frame-char-height) t)))))))
4447 ;; This is like line-move-1 except that it also performs
4448 ;; vertical scrolling of tall images if appropriate.
4449 ;; That is not really a clean thing to do, since it mixes
4450 ;; scrolling with cursor motion. But so far we don't have
4451 ;; a cleaner solution to the problem of making C-n do something
4452 ;; useful given a tall image.
4453 (defun line-move (arg &optional noerror to-end try-vscroll)
4454 (if noninteractive
4455 (forward-line arg)
4456 (unless (and auto-window-vscroll try-vscroll
4457 ;; Only vscroll for single line moves
4458 (= (abs arg) 1)
4459 ;; But don't vscroll in a keyboard macro.
4460 (not defining-kbd-macro)
4461 (not executing-kbd-macro)
4462 (line-move-partial arg noerror to-end))
4463 (set-window-vscroll nil 0 t)
4464 (if (and line-move-visual
4465 ;; Display-based column are incompatible with goal-column.
4466 (not goal-column)
4467 ;; When the text in the window is scrolled to the left,
4468 ;; display-based motion doesn't make sense (because each
4469 ;; logical line occupies exactly one screen line).
4470 (not (> (window-hscroll) 0)))
4471 (line-move-visual arg noerror)
4472 (line-move-1 arg noerror to-end)))))
4474 ;; Display-based alternative to line-move-1.
4475 ;; Arg says how many lines to move. The value is t if we can move the
4476 ;; specified number of lines.
4477 (defun line-move-visual (arg &optional noerror)
4478 (let ((opoint (point))
4479 (hscroll (window-hscroll))
4480 target-hscroll)
4481 ;; Check if the previous command was a line-motion command, or if
4482 ;; we were called from some other command.
4483 (if (and (consp temporary-goal-column)
4484 (memq last-command `(next-line previous-line ,this-command)))
4485 ;; If so, there's no need to reset `temporary-goal-column',
4486 ;; but we may need to hscroll.
4487 (if (or (/= (cdr temporary-goal-column) hscroll)
4488 (> (cdr temporary-goal-column) 0))
4489 (setq target-hscroll (cdr temporary-goal-column)))
4490 ;; Otherwise, we should reset `temporary-goal-column'.
4491 (let ((posn (posn-at-point)))
4492 (cond
4493 ;; Handle the `overflow-newline-into-fringe' case:
4494 ((eq (nth 1 posn) 'right-fringe)
4495 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4496 ((car (posn-x-y posn))
4497 (setq temporary-goal-column
4498 (cons (/ (float (car (posn-x-y posn)))
4499 (frame-char-width)) hscroll))))))
4500 (if target-hscroll
4501 (set-window-hscroll (selected-window) target-hscroll))
4502 (or (and (= (vertical-motion
4503 (cons (or goal-column
4504 (if (consp temporary-goal-column)
4505 (car temporary-goal-column)
4506 temporary-goal-column))
4507 arg))
4508 arg)
4509 (or (>= arg 0)
4510 (/= (point) opoint)
4511 ;; If the goal column lies on a display string,
4512 ;; `vertical-motion' advances the cursor to the end
4513 ;; of the string. For arg < 0, this can cause the
4514 ;; cursor to get stuck. (Bug#3020).
4515 (= (vertical-motion arg) arg)))
4516 (unless noerror
4517 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4518 nil)))))
4520 ;; This is the guts of next-line and previous-line.
4521 ;; Arg says how many lines to move.
4522 ;; The value is t if we can move the specified number of lines.
4523 (defun line-move-1 (arg &optional noerror _to-end)
4524 ;; Don't run any point-motion hooks, and disregard intangibility,
4525 ;; for intermediate positions.
4526 (let ((inhibit-point-motion-hooks t)
4527 (opoint (point))
4528 (orig-arg arg))
4529 (if (consp temporary-goal-column)
4530 (setq temporary-goal-column (+ (car temporary-goal-column)
4531 (cdr temporary-goal-column))))
4532 (unwind-protect
4533 (progn
4534 (if (not (memq last-command '(next-line previous-line)))
4535 (setq temporary-goal-column
4536 (if (and track-eol (eolp)
4537 ;; Don't count beg of empty line as end of line
4538 ;; unless we just did explicit end-of-line.
4539 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4540 most-positive-fixnum
4541 (current-column))))
4543 (if (not (or (integerp selective-display)
4544 line-move-ignore-invisible))
4545 ;; Use just newline characters.
4546 ;; Set ARG to 0 if we move as many lines as requested.
4547 (or (if (> arg 0)
4548 (progn (if (> arg 1) (forward-line (1- arg)))
4549 ;; This way of moving forward ARG lines
4550 ;; verifies that we have a newline after the last one.
4551 ;; It doesn't get confused by intangible text.
4552 (end-of-line)
4553 (if (zerop (forward-line 1))
4554 (setq arg 0)))
4555 (and (zerop (forward-line arg))
4556 (bolp)
4557 (setq arg 0)))
4558 (unless noerror
4559 (signal (if (< arg 0)
4560 'beginning-of-buffer
4561 'end-of-buffer)
4562 nil)))
4563 ;; Move by arg lines, but ignore invisible ones.
4564 (let (done)
4565 (while (and (> arg 0) (not done))
4566 ;; If the following character is currently invisible,
4567 ;; skip all characters with that same `invisible' property value.
4568 (while (and (not (eobp)) (invisible-p (point)))
4569 (goto-char (next-char-property-change (point))))
4570 ;; Move a line.
4571 ;; We don't use `end-of-line', since we want to escape
4572 ;; from field boundaries occurring exactly at point.
4573 (goto-char (constrain-to-field
4574 (let ((inhibit-field-text-motion t))
4575 (line-end-position))
4576 (point) t t
4577 'inhibit-line-move-field-capture))
4578 ;; If there's no invisibility here, move over the newline.
4579 (cond
4580 ((eobp)
4581 (if (not noerror)
4582 (signal 'end-of-buffer nil)
4583 (setq done t)))
4584 ((and (> arg 1) ;; Use vertical-motion for last move
4585 (not (integerp selective-display))
4586 (not (invisible-p (point))))
4587 ;; We avoid vertical-motion when possible
4588 ;; because that has to fontify.
4589 (forward-line 1))
4590 ;; Otherwise move a more sophisticated way.
4591 ((zerop (vertical-motion 1))
4592 (if (not noerror)
4593 (signal 'end-of-buffer nil)
4594 (setq done t))))
4595 (unless done
4596 (setq arg (1- arg))))
4597 ;; The logic of this is the same as the loop above,
4598 ;; it just goes in the other direction.
4599 (while (and (< arg 0) (not done))
4600 ;; For completely consistency with the forward-motion
4601 ;; case, we should call beginning-of-line here.
4602 ;; However, if point is inside a field and on a
4603 ;; continued line, the call to (vertical-motion -1)
4604 ;; below won't move us back far enough; then we return
4605 ;; to the same column in line-move-finish, and point
4606 ;; gets stuck -- cyd
4607 (forward-line 0)
4608 (cond
4609 ((bobp)
4610 (if (not noerror)
4611 (signal 'beginning-of-buffer nil)
4612 (setq done t)))
4613 ((and (< arg -1) ;; Use vertical-motion for last move
4614 (not (integerp selective-display))
4615 (not (invisible-p (1- (point)))))
4616 (forward-line -1))
4617 ((zerop (vertical-motion -1))
4618 (if (not noerror)
4619 (signal 'beginning-of-buffer nil)
4620 (setq done t))))
4621 (unless done
4622 (setq arg (1+ arg))
4623 (while (and ;; Don't move over previous invis lines
4624 ;; if our target is the middle of this line.
4625 (or (zerop (or goal-column temporary-goal-column))
4626 (< arg 0))
4627 (not (bobp)) (invisible-p (1- (point))))
4628 (goto-char (previous-char-property-change (point))))))))
4629 ;; This is the value the function returns.
4630 (= arg 0))
4632 (cond ((> arg 0)
4633 ;; If we did not move down as far as desired, at least go
4634 ;; to end of line. Be sure to call point-entered and
4635 ;; point-left-hooks.
4636 (let* ((npoint (prog1 (line-end-position)
4637 (goto-char opoint)))
4638 (inhibit-point-motion-hooks nil))
4639 (goto-char npoint)))
4640 ((< arg 0)
4641 ;; If we did not move up as far as desired,
4642 ;; at least go to beginning of line.
4643 (let* ((npoint (prog1 (line-beginning-position)
4644 (goto-char opoint)))
4645 (inhibit-point-motion-hooks nil))
4646 (goto-char npoint)))
4647 (t
4648 (line-move-finish (or goal-column temporary-goal-column)
4649 opoint (> orig-arg 0)))))))
4651 (defun line-move-finish (column opoint forward)
4652 (let ((repeat t))
4653 (while repeat
4654 ;; Set REPEAT to t to repeat the whole thing.
4655 (setq repeat nil)
4657 (let (new
4658 (old (point))
4659 (line-beg (line-beginning-position))
4660 (line-end
4661 ;; Compute the end of the line
4662 ;; ignoring effectively invisible newlines.
4663 (save-excursion
4664 ;; Like end-of-line but ignores fields.
4666 (while (and (not (eobp)) (invisible-p (point)))
4667 (goto-char (next-char-property-change (point)))
4669 (point))))
4671 ;; Move to the desired column.
4672 (line-move-to-column (truncate column))
4674 ;; Corner case: suppose we start out in a field boundary in
4675 ;; the middle of a continued line. When we get to
4676 ;; line-move-finish, point is at the start of a new *screen*
4677 ;; line but the same text line; then line-move-to-column would
4678 ;; move us backwards. Test using C-n with point on the "x" in
4679 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4680 (and forward
4681 (< (point) old)
4682 (goto-char old))
4684 (setq new (point))
4686 ;; Process intangibility within a line.
4687 ;; With inhibit-point-motion-hooks bound to nil, a call to
4688 ;; goto-char moves point past intangible text.
4690 ;; However, inhibit-point-motion-hooks controls both the
4691 ;; intangibility and the point-entered/point-left hooks. The
4692 ;; following hack avoids calling the point-* hooks
4693 ;; unnecessarily. Note that we move *forward* past intangible
4694 ;; text when the initial and final points are the same.
4695 (goto-char new)
4696 (let ((inhibit-point-motion-hooks nil))
4697 (goto-char new)
4699 ;; If intangibility moves us to a different (later) place
4700 ;; in the same line, use that as the destination.
4701 (if (<= (point) line-end)
4702 (setq new (point))
4703 ;; If that position is "too late",
4704 ;; try the previous allowable position.
4705 ;; See if it is ok.
4706 (backward-char)
4707 (if (if forward
4708 ;; If going forward, don't accept the previous
4709 ;; allowable position if it is before the target line.
4710 (< line-beg (point))
4711 ;; If going backward, don't accept the previous
4712 ;; allowable position if it is still after the target line.
4713 (<= (point) line-end))
4714 (setq new (point))
4715 ;; As a last resort, use the end of the line.
4716 (setq new line-end))))
4718 ;; Now move to the updated destination, processing fields
4719 ;; as well as intangibility.
4720 (goto-char opoint)
4721 (let ((inhibit-point-motion-hooks nil))
4722 (goto-char
4723 ;; Ignore field boundaries if the initial and final
4724 ;; positions have the same `field' property, even if the
4725 ;; fields are non-contiguous. This seems to be "nicer"
4726 ;; behavior in many situations.
4727 (if (eq (get-char-property new 'field)
4728 (get-char-property opoint 'field))
4729 new
4730 (constrain-to-field new opoint t t
4731 'inhibit-line-move-field-capture))))
4733 ;; If all this moved us to a different line,
4734 ;; retry everything within that new line.
4735 (when (or (< (point) line-beg) (> (point) line-end))
4736 ;; Repeat the intangibility and field processing.
4737 (setq repeat t))))))
4739 (defun line-move-to-column (col)
4740 "Try to find column COL, considering invisibility.
4741 This function works only in certain cases,
4742 because what we really need is for `move-to-column'
4743 and `current-column' to be able to ignore invisible text."
4744 (if (zerop col)
4745 (beginning-of-line)
4746 (move-to-column col))
4748 (when (and line-move-ignore-invisible
4749 (not (bolp)) (invisible-p (1- (point))))
4750 (let ((normal-location (point))
4751 (normal-column (current-column)))
4752 ;; If the following character is currently invisible,
4753 ;; skip all characters with that same `invisible' property value.
4754 (while (and (not (eobp))
4755 (invisible-p (point)))
4756 (goto-char (next-char-property-change (point))))
4757 ;; Have we advanced to a larger column position?
4758 (if (> (current-column) normal-column)
4759 ;; We have made some progress towards the desired column.
4760 ;; See if we can make any further progress.
4761 (line-move-to-column (+ (current-column) (- col normal-column)))
4762 ;; Otherwise, go to the place we originally found
4763 ;; and move back over invisible text.
4764 ;; that will get us to the same place on the screen
4765 ;; but with a more reasonable buffer position.
4766 (goto-char normal-location)
4767 (let ((line-beg (line-beginning-position)))
4768 (while (and (not (bolp)) (invisible-p (1- (point))))
4769 (goto-char (previous-char-property-change (point) line-beg))))))))
4771 (defun move-end-of-line (arg)
4772 "Move point to end of current line as displayed.
4773 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4774 If point reaches the beginning or end of buffer, it stops there.
4776 To ignore the effects of the `intangible' text or overlay
4777 property, bind `inhibit-point-motion-hooks' to t.
4778 If there is an image in the current line, this function
4779 disregards newlines that are part of the text on which the image
4780 rests."
4781 (interactive "^p")
4782 (or arg (setq arg 1))
4783 (let (done)
4784 (while (not done)
4785 (let ((newpos
4786 (save-excursion
4787 (let ((goal-column 0)
4788 (line-move-visual nil))
4789 (and (line-move arg t)
4790 ;; With bidi reordering, we may not be at bol,
4791 ;; so make sure we are.
4793 (not (bobp))
4794 (progn
4795 (while (and (not (bobp)) (invisible-p (1- (point))))
4796 (goto-char (previous-single-char-property-change
4797 (point) 'invisible)))
4798 (backward-char 1)))
4799 (point)))))
4800 (goto-char newpos)
4801 (if (and (> (point) newpos)
4803 (backward-char 1)
4804 (if (and (> (point) newpos) (not (eobp))
4806 ;; If we skipped something intangible and now we're not
4807 ;; really at eol, keep going.
4808 (setq arg 1)
4809 (setq done t)))))))
4811 (defun move-beginning-of-line (arg)
4812 "Move point to beginning of current line as displayed.
4813 \(If there's an image in the line, this disregards newlines
4814 which are part of the text that the image rests on.)
4816 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4817 If point reaches the beginning or end of buffer, it stops there.
4818 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4819 (interactive "^p")
4820 (or arg (setq arg 1))
4822 (let ((orig (point))
4823 first-vis first-vis-field-value)
4825 ;; Move by lines, if ARG is not 1 (the default).
4826 (if (/= arg 1)
4827 (let ((line-move-visual nil))
4828 (line-move (1- arg) t)))
4830 ;; Move to beginning-of-line, ignoring fields and invisible text.
4832 (while (and (not (bobp)) (invisible-p (1- (point))))
4833 (goto-char (previous-char-property-change (point)))
4836 ;; Now find first visible char in the line
4837 (while (and (not (eobp)) (invisible-p (point)))
4838 (goto-char (next-char-property-change (point))))
4839 (setq first-vis (point))
4841 ;; See if fields would stop us from reaching FIRST-VIS.
4842 (setq first-vis-field-value
4843 (constrain-to-field first-vis orig (/= arg 1) t nil))
4845 (goto-char (if (/= first-vis-field-value first-vis)
4846 ;; If yes, obey them.
4847 first-vis-field-value
4848 ;; Otherwise, move to START with attention to fields.
4849 ;; (It is possible that fields never matter in this case.)
4850 (constrain-to-field (point) orig
4851 (/= arg 1) t nil)))))
4854 ;; Many people have said they rarely use this feature, and often type
4855 ;; it by accident. Maybe it shouldn't even be on a key.
4856 (put 'set-goal-column 'disabled t)
4858 (defun set-goal-column (arg)
4860 Those commands will move to this position in the line moved to
4861 rather than trying to keep the same horizontal position.
4862 With a non-nil argument ARG, clears out the goal column
4864 The goal column is stored in the variable `goal-column'."
4865 (interactive "P")
4866 (if arg
4867 (progn
4868 (setq goal-column nil)
4869 (message "No goal column"))
4870 (setq goal-column (current-column))
4871 ;; The older method below can be erroneous if `set-goal-column' is bound
4872 ;; to a sequence containing %
4873 ;;(message (substitute-command-keys
4875 ;;goal-column)
4876 (message "%s"
4877 (concat
4878 (format "Goal column %d " goal-column)
4879 (substitute-command-keys
4882 )
4883 nil)
4884 \f
4885 ;;; Editing based on visual lines, as opposed to logical lines.
4887 (defun end-of-visual-line (&optional n)
4888 "Move point to end of current visual line.
4889 With argument N not nil or 1, move forward N - 1 visual lines first.
4890 If point reaches the beginning or end of buffer, it stops there.
4891 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4892 (interactive "^p")
4893 (or n (setq n 1))
4894 (if (/= n 1)
4895 (let ((line-move-visual t))
4896 (line-move (1- n) t)))
4897 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4898 ;; constrain to field boundaries, so we don't either.
4899 (vertical-motion (cons (window-width) 0)))
4901 (defun beginning-of-visual-line (&optional n)
4902 "Move point to beginning of current visual line.
4903 With argument N not nil or 1, move forward N - 1 visual lines first.
4904 If point reaches the beginning or end of buffer, it stops there.
4905 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4906 (interactive "^p")
4907 (or n (setq n 1))
4908 (let ((opoint (point)))
4909 (if (/= n 1)
4910 (let ((line-move-visual t))
4911 (line-move (1- n) t)))
4912 (vertical-motion 0)
4913 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4914 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4916 (defun kill-visual-line (&optional arg)
4917 "Kill the rest of the visual line.
4918 With prefix argument ARG, kill that many visual lines from point.
4919 If ARG is negative, kill visual lines backward.
4920 If ARG is zero, kill the text before point on the current visual
4921 line.
4923 If you want to append the killed line to the last killed text,
4926 If the buffer is read-only, Emacs will beep and refrain from deleting
4927 the line, but put the line in the kill ring anyway. This means that
4928 you can use this command to copy text from a read-only buffer.
4929 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4930 even beep.)"
4931 (interactive "P")
4932 ;; Like in `kill-line', it's better to move point to the other end
4933 ;; of the kill before killing.
4934 (let ((opoint (point))
4935 (kill-whole-line (and kill-whole-line (bolp))))
4936 (if arg
4937 (vertical-motion (prefix-numeric-value arg))
4938 (end-of-visual-line 1)
4939 (if (= (point) opoint)
4940 (vertical-motion 1)
4941 ;; Skip any trailing whitespace at the end of the visual line.
4942 ;; We used to do this only if `show-trailing-whitespace' is
4943 ;; nil, but that's wrong; the correct thing would be to check
4944 ;; whether the trailing whitespace is highlighted. But, it's
4945 ;; OK to just do this unconditionally.
4948 (1+ (point))
4949 (point)))))
4951 (defun next-logical-line (&optional arg try-vscroll)
4952 "Move cursor vertically down ARG lines.
4953 This is identical to `next-line', except that it always moves
4954 by logical lines instead of visual lines, ignoring the value of
4955 the variable `line-move-visual'."
4957 (let ((line-move-visual nil))
4958 (with-no-warnings
4959 (next-line arg try-vscroll))))
4961 (defun previous-logical-line (&optional arg try-vscroll)
4962 "Move cursor vertically up ARG lines.
4963 This is identical to `previous-line', except that it always moves
4964 by logical lines instead of visual lines, ignoring the value of
4965 the variable `line-move-visual'."
4967 (let ((line-move-visual nil))
4968 (with-no-warnings
4969 (previous-line arg try-vscroll))))
4971 (defgroup visual-line nil
4972 "Editing based on visual lines."
4973 :group 'convenience
4974 :version "23.1")
4976 (defvar visual-line-mode-map
4977 (let ((map (make-sparse-keymap)))
4978 (define-key map [remap kill-line] 'kill-visual-line)
4979 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4980 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4981 ;; These keybindings interfere with xterm function keys. Are
4982 ;; there any other suitable bindings?
4983 ;; (define-key map "\M-[" 'previous-logical-line)
4984 ;; (define-key map "\M-]" 'next-logical-line)
4985 map))
4987 (defcustom visual-line-fringe-indicators '(nil nil)
4988 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4989 The value should be a list of the form (LEFT RIGHT), where LEFT
4990 and RIGHT are symbols representing the bitmaps to display, to
4991 indicate wrapped lines, in the left and right fringes respectively.
4992 See also `fringe-indicator-alist'.
4993 The default is not to display fringe indicators for wrapped lines.
4994 This variable does not affect fringe indicators displayed for
4995 other purposes."
4996 :type '(list (choice (const :tag "Hide left indicator" nil)
4997 (const :tag "Left curly arrow" left-curly-arrow)
4998 (symbol :tag "Other bitmap"))
4999 (choice (const :tag "Hide right indicator" nil)
5000 (const :tag "Right curly arrow" right-curly-arrow)
5001 (symbol :tag "Other bitmap")))
5002 :set (lambda (symbol value)
5003 (dolist (buf (buffer-list))
5004 (with-current-buffer buf
5005 (when (and (boundp 'visual-line-mode)
5006 (symbol-value 'visual-line-mode))
5007 (setq fringe-indicator-alist
5008 (cons (cons 'continuation value)
5009 (assq-delete-all
5010 'continuation
5011 (copy-tree fringe-indicator-alist)))))))
5012 (set-default symbol value)))
5014 (defvar visual-line--saved-state nil)
5016 (define-minor-mode visual-line-mode
5017 "Toggle visual line based editing (Visual Line mode).
5018 With a prefix argument ARG, enable Visual Line mode if ARG is
5019 positive, and disable it otherwise. If called from Lisp, enable
5020 the mode if ARG is omitted or nil.
5022 When Visual Line mode is enabled, `word-wrap' is turned on in
5023 this buffer, and simple editing commands are redefined to act on
5024 visual lines, not logical lines. See Info node `Visual Line
5025 Mode' for details."
5026 :keymap visual-line-mode-map
5027 :group 'visual-line
5028 :lighter " Wrap"
5029 (if visual-line-mode
5030 (progn
5031 (set (make-local-variable 'visual-line--saved-state) nil)
5032 ;; Save the local values of some variables, to be restored if
5033 ;; visual-line-mode is turned off.
5034 (dolist (var '(line-move-visual truncate-lines
5035 truncate-partial-width-windows
5036 word-wrap fringe-indicator-alist))
5037 (if (local-variable-p var)
5038 (push (cons var (symbol-value var))
5039 visual-line--saved-state)))
5040 (set (make-local-variable 'line-move-visual) t)
5041 (set (make-local-variable 'truncate-partial-width-windows) nil)
5042 (setq truncate-lines nil
5043 word-wrap t
5044 fringe-indicator-alist
5045 (cons (cons 'continuation visual-line-fringe-indicators)
5046 fringe-indicator-alist)))
5047 (kill-local-variable 'line-move-visual)
5048 (kill-local-variable 'word-wrap)
5049 (kill-local-variable 'truncate-lines)
5050 (kill-local-variable 'truncate-partial-width-windows)
5051 (kill-local-variable 'fringe-indicator-alist)
5052 (dolist (saved visual-line--saved-state)
5053 (set (make-local-variable (car saved)) (cdr saved)))
5054 (kill-local-variable 'visual-line--saved-state)))
5056 (defun turn-on-visual-line-mode ()
5057 (visual-line-mode 1))
5059 (define-globalized-minor-mode global-visual-line-mode
5060 visual-line-mode turn-on-visual-line-mode
5061 :lighter " vl")
5063 \f
5064 (defun transpose-chars (arg)
5065 "Interchange characters around point, moving forward one character.
5066 With prefix arg ARG, effect is to take character before point
5067 and drag it forward past ARG other characters (backward if ARG negative).
5068 If no argument and at end of line, the previous two chars are exchanged."
5069 (interactive "*P")
5070 (and (null arg) (eolp) (forward-char -1))
5071 (transpose-subr 'forward-char (prefix-numeric-value arg)))
5073 (defun transpose-words (arg)
5074 "Interchange words around point, leaving point at end of them.
5075 With prefix arg ARG, effect is to take word before or around point
5076 and drag it forward past ARG other words (backward if ARG negative).
5077 If ARG is zero, the words around or after point and around or after mark
5078 are interchanged."
5079 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5080 (interactive "*p")
5081 (transpose-subr 'forward-word arg))
5083 (defun transpose-sexps (arg)
5085 Does not work on a sexp that point is in the middle of
5086 if it is a list or string."
5087 (interactive "*p")
5088 (transpose-subr
5089 (lambda (arg)
5090 ;; Here we should try to simulate the behavior of
5091 ;; (cons (progn (forward-sexp x) (point))
5092 ;; (progn (forward-sexp (- x)) (point)))
5093 ;; Except that we don't want to rely on the second forward-sexp
5094 ;; putting us back to where we want to be, since forward-sexp-function
5095 ;; might do funny things like infix-precedence.
5096 (if (if (> arg 0)
5098 (and (not (bobp))
5100 ;; Jumping over a symbol. We might be inside it, mind you.
5101 (progn (funcall (if (> arg 0)
5102 'skip-syntax-backward 'skip-syntax-forward)
5103 "w_")
5104 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5105 ;; Otherwise, we're between sexps. Take a step back before jumping
5106 ;; to make sure we'll obey the same precedence no matter which direction
5107 ;; we're going.
5108 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5109 (cons (save-excursion (forward-sexp arg) (point))
5110 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5111 (not (zerop (funcall (if (> arg 0)
5112 'skip-syntax-forward
5113 'skip-syntax-backward)
5114 ".")))))
5115 (point)))))
5116 arg 'special))
5118 (defun transpose-lines (arg)
5119 "Exchange current line and previous line, leaving point after both.
5120 With argument ARG, takes previous line and moves it past ARG lines.
5121 With argument 0, interchanges line point is in with line mark is in."
5122 (interactive "*p")
5123 (transpose-subr (function
5124 (lambda (arg)
5125 (if (> arg 0)
5126 (progn
5127 ;; Move forward over ARG lines,
5128 ;; but create newlines if necessary.
5129 (setq arg (forward-line arg))
5131 (setq arg (1+ arg)))
5132 (if (> arg 0)
5133 (newline arg)))
5134 (forward-line arg))))
5135 arg))
5137 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5138 ;; which seems inconsistent with the ARG /= 0 case.
5139 ;; FIXME document SPECIAL.
5140 (defun transpose-subr (mover arg &optional special)
5141 "Subroutine to do the work of transposing objects.
5142 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5143 moves forward by units of the given object (e.g. forward-sentence,
5144 forward-paragraph). If ARG is zero, exchanges the current object
5145 with the one containing mark. If ARG is an integer, moves the
5146 current object past ARG following (if ARG is positive) or
5147 preceding (if ARG is negative) objects, leaving point after the
5148 current object."
5149 (let ((aux (if special mover
5150 (lambda (x)
5151 (cons (progn (funcall mover x) (point))
5152 (progn (funcall mover (- x)) (point))))))
5153 pos1 pos2)
5154 (cond
5155 ((= arg 0)
5156 (save-excursion
5157 (setq pos1 (funcall aux 1))
5158 (goto-char (or (mark) (error "No mark set in this buffer")))
5159 (setq pos2 (funcall aux 1))
5160 (transpose-subr-1 pos1 pos2))
5161 (exchange-point-and-mark))
5162 ((> arg 0)
5163 (setq pos1 (funcall aux -1))
5164 (setq pos2 (funcall aux arg))
5165 (transpose-subr-1 pos1 pos2)
5166 (goto-char (car pos2)))
5167 (t
5168 (setq pos1 (funcall aux -1))
5169 (goto-char (car pos1))
5170 (setq pos2 (funcall aux arg))
5171 (transpose-subr-1 pos1 pos2)))))
5173 (defun transpose-subr-1 (pos1 pos2)
5174 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5175 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5176 (when (> (car pos1) (car pos2))
5177 (let ((swap pos1))
5178 (setq pos1 pos2 pos2 swap)))
5179 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5180 (atomic-change-group
5181 (let (word2)
5182 ;; FIXME: We first delete the two pieces of text, so markers that
5183 ;; used to point to after the text end up pointing to before it :-(
5184 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5185 (goto-char (car pos2))
5186 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5187 (goto-char (car pos1))
5188 (insert word2))))
5189 \f
5190 (defun backward-word (&optional arg)
5191 "Move backward until encountering the beginning of a word.
5192 With argument ARG, do this that many times."
5193 (interactive "^p")
5194 (forward-word (- (or arg 1))))
5196 (defun mark-word (&optional arg allow-extend)
5197 "Set mark ARG words away from point.
5199 move to with the same argument.
5200 Interactively, if this command is repeated
5201 or (in Transient Mark mode) if the mark is active,
5202 it marks the next ARG words after the ones already marked."
5204 (cond ((and allow-extend
5205 (or (and (eq last-command this-command) (mark t))
5206 (region-active-p)))
5207 (setq arg (if arg (prefix-numeric-value arg)
5208 (if (< (mark) (point)) -1 1)))
5209 (set-mark
5210 (save-excursion
5211 (goto-char (mark))
5212 (forward-word arg)
5213 (point))))
5214 (t
5215 (push-mark
5216 (save-excursion
5217 (forward-word (prefix-numeric-value arg))
5218 (point))
5219 nil t))))
5221 (defun kill-word (arg)
5222 "Kill characters forward until encountering the end of a word.
5223 With argument ARG, do this that many times."
5224 (interactive "p")
5225 (kill-region (point) (progn (forward-word arg) (point))))
5227 (defun backward-kill-word (arg)
5228 "Kill characters backward until encountering the beginning of a word.
5229 With argument ARG, do this that many times."
5230 (interactive "p")
5231 (kill-word (- arg)))
5233 (defun current-word (&optional strict really-word)
5234 "Return the symbol or word that point is on (or a nearby one) as a string.
5235 The return value includes no text properties.
5236 If optional arg STRICT is non-nil, return nil unless point is within
5237 or adjacent to a symbol or word. In all cases the value can be nil
5238 if there is no word nearby.
5239 The function, belying its name, normally finds a symbol.
5240 If optional arg REALLY-WORD is non-nil, it finds just a word."
5241 (save-excursion
5242 (let* ((oldpoint (point)) (start (point)) (end (point))
5243 (syntaxes (if really-word "w" "w_"))
5244 (not-syntaxes (concat "^" syntaxes)))
5245 (skip-syntax-backward syntaxes) (setq start (point))
5246 (goto-char oldpoint)
5247 (skip-syntax-forward syntaxes) (setq end (point))
5248 (when (and (eq start oldpoint) (eq end oldpoint)
5249 ;; Point is neither within nor adjacent to a word.
5250 (not strict))
5251 ;; Look for preceding word in same line.
5252 (skip-syntax-backward not-syntaxes (line-beginning-position))
5253 (if (bolp)
5254 ;; No preceding word in same line.
5255 ;; Look for following word in same line.
5256 (progn
5257 (skip-syntax-forward not-syntaxes (line-end-position))
5258 (setq start (point))
5259 (skip-syntax-forward syntaxes)
5260 (setq end (point)))
5261 (setq end (point))
5262 (skip-syntax-backward syntaxes)
5263 (setq start (point))))
5264 ;; If we found something nonempty, return it as a string.
5265 (unless (= start end)
5266 (buffer-substring-no-properties start end)))))
5267 \f
5268 (defcustom fill-prefix nil
5269 "String for filling to insert at front of new line, or nil for none."
5270 :type '(choice (const :tag "None" nil)
5271 string)
5272 :group 'fill)
5273 (make-variable-buffer-local 'fill-prefix)
5274 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5276 (defcustom auto-fill-inhibit-regexp nil
5277 "Regexp to match lines which should not be auto-filled."
5278 :type '(choice (const :tag "None" nil)
5279 regexp)
5280 :group 'fill)
5282 (defun do-auto-fill ()
5283 "The default value for `normal-auto-fill-function'.
5284 This is the default auto-fill function, some major modes use a different one.
5285 Returns t if it really did any work."
5286 (let (fc justify give-up
5287 (fill-prefix fill-prefix))
5288 (if (or (not (setq justify (current-justification)))
5289 (null (setq fc (current-fill-column)))
5290 (and (eq justify 'left)
5291 (<= (current-column) fc))
5292 (and auto-fill-inhibit-regexp
5293 (save-excursion (beginning-of-line)
5294 (looking-at auto-fill-inhibit-regexp))))
5295 nil ;; Auto-filling not required
5296 (if (memq justify '(full center right))
5297 (save-excursion (unjustify-current-line)))
5299 ;; Choose a fill-prefix automatically.
5300 (when (and adaptive-fill-mode
5301 (or (null fill-prefix) (string= fill-prefix "")))
5302 (let ((prefix
5303 (fill-context-prefix
5304 (save-excursion (fill-forward-paragraph -1) (point))
5305 (save-excursion (fill-forward-paragraph 1) (point)))))
5306 (and prefix (not (equal prefix ""))
5307 ;; Use auto-indentation rather than a guessed empty prefix.
5308 (not (and fill-indent-according-to-mode
5310 (setq fill-prefix prefix))))
5312 (while (and (not give-up) (> (current-column) fc))
5313 ;; Determine where to split the line.
5314 (let* (after-prefix
5315 (fill-point
5316 (save-excursion
5317 (beginning-of-line)
5318 (setq after-prefix (point))
5319 (and fill-prefix
5320 (looking-at (regexp-quote fill-prefix))
5321 (setq after-prefix (match-end 0)))
5322 (move-to-column (1+ fc))
5323 (fill-move-to-break-point after-prefix)
5324 (point))))
5326 ;; See whether the place we found is any good.
5327 (if (save-excursion
5328 (goto-char fill-point)
5329 (or (bolp)
5330 ;; There is no use breaking at end of line.
5331 (save-excursion (skip-chars-forward " ") (eolp))
5332 ;; It is futile to split at the end of the prefix
5333 ;; since we would just insert the prefix again.
5334 (and after-prefix (<= (point) after-prefix))
5335 ;; Don't split right after a comment starter
5336 ;; since we would just make another comment starter.
5337 (and comment-start-skip
5338 (let ((limit (point)))
5339 (beginning-of-line)
5340 (and (re-search-forward comment-start-skip
5341 limit t)
5342 (eq (point) limit))))))
5343 ;; No good place to break => stop trying.
5344 (setq give-up t)
5345 ;; Ok, we have a useful place to break the line. Do it.
5346 (let ((prev-column (current-column)))
5347 ;; If point is at the fill-point, do not `save-excursion'.
5348 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5349 ;; point will end up before it rather than after it.
5350 (if (save-excursion
5352 (= (point) fill-point))
5353 (default-indent-new-line t)
5354 (save-excursion
5355 (goto-char fill-point)
5356 (default-indent-new-line t)))
5357 ;; Now do justification, if required
5358 (if (not (eq justify 'left))
5359 (save-excursion
5360 (end-of-line 0)
5361 (justify-current-line justify nil t)))
5362 ;; If making the new line didn't reduce the hpos of
5363 ;; the end of the line, then give up now;
5364 ;; trying again will not help.
5365 (if (>= (current-column) prev-column)
5366 (setq give-up t))))))
5367 ;; Justify last line.
5368 (justify-current-line justify t t)
5369 t)))
5371 (defvar comment-line-break-function 'comment-indent-new-line
5372 "Mode-specific function which line breaks and continues a comment.
5373 This function is called during auto-filling when a comment syntax
5374 is defined.
5375 The function should take a single optional argument, which is a flag
5376 indicating whether it should use soft newlines.")
5378 (defun default-indent-new-line (&optional soft)
5379 "Break line at point and indent.
5380 If a comment syntax is defined, call `comment-indent-new-line'.
5382 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5383 unless optional argument SOFT is non-nil."
5384 (interactive)
5385 (if comment-start
5386 (funcall comment-line-break-function soft)
5387 ;; Insert the newline before removing empty space so that markers
5388 ;; get preserved better.
5390 (save-excursion (forward-char -1) (delete-horizontal-space))
5391 (delete-horizontal-space)
5393 (if (and fill-prefix (not adaptive-fill-mode))
5394 ;; Blindly trust a non-adaptive fill-prefix.
5395 (progn
5396 (indent-to-left-margin)
5397 (insert-before-markers-and-inherit fill-prefix))
5399 (cond
5400 ;; If there's an adaptive prefix, use it unless we're inside
5401 ;; a comment and the prefix is not a comment starter.
5402 (fill-prefix
5403 (indent-to-left-margin)
5404 (insert-and-inherit fill-prefix))
5405 ;; If we're not inside a comment, just try to indent.
5406 (t (indent-according-to-mode))))))
5408 (defvar normal-auto-fill-function 'do-auto-fill
5409 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5410 Some major modes set this.")
5412 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5413 ;; `functions' and `hooks' are usually unsafe to set, but setting
5414 ;; auto-fill-function to nil in a file-local setting is safe and
5415 ;; can be useful to prevent auto-filling.
5416 (put 'auto-fill-function 'safe-local-variable 'null)
5418 (define-minor-mode auto-fill-mode
5419 "Toggle automatic line breaking (Auto Fill mode).
5420 With a prefix argument ARG, enable Auto Fill mode if ARG is
5421 positive, and disable it otherwise. If called from Lisp, enable
5422 the mode if ARG is omitted or nil.
5424 When Auto Fill mode is enabled, inserting a space at a column
5425 beyond `current-fill-column' automatically breaks the line at a
5426 previous space.
5428 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5429 non-`nil'.
5431 The value of `normal-auto-fill-function' specifies the function to use
5432 for `auto-fill-function' when turning Auto Fill mode on."
5433 :variable (auto-fill-function
5434 . (lambda (v) (setq auto-fill-function
5435 (if v normal-auto-fill-function)))))
5437 ;; This holds a document string used to document auto-fill-mode.
5438 (defun auto-fill-function ()
5439 "Automatically break line at a previous space, in insertion of text."
5440 nil)
5442 (defun turn-on-auto-fill ()
5443 "Unconditionally turn on Auto Fill mode."
5444 (auto-fill-mode 1))
5446 (defun turn-off-auto-fill ()
5447 "Unconditionally turn off Auto Fill mode."
5448 (auto-fill-mode -1))
5450 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5452 (defun set-fill-column (arg)
5453 "Set `fill-column' to specified argument.
5456 (interactive
5457 (list (or current-prefix-arg
5458 ;; We used to use current-column silently, but C-x f is too easily
5459 ;; typed as a typo for C-x C-f, so we turned it into an error and
5460 ;; now an interactive prompt.
5461 (read-number "Set fill-column to: " (current-column)))))
5462 (if (consp arg)
5463 (setq arg (current-column)))
5464 (if (not (integerp arg))
5465 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5466 (error "set-fill-column requires an explicit argument")
5467 (message "Fill column set to %d (was %d)" arg fill-column)
5468 (setq fill-column arg)))
5469 \f
5470 (defun set-selective-display (arg)
5471 "Set `selective-display' to ARG; clear it if no arg.
5472 When the value of `selective-display' is a number > 0,
5473 lines whose indentation is >= that value are not displayed.
5474 The variable `selective-display' has a separate value for each buffer."
5475 (interactive "P")
5476 (if (eq selective-display t)
5477 (error "selective-display already in use for marked lines"))
5478 (let ((current-vpos
5479 (save-restriction
5480 (narrow-to-region (point-min) (point))
5481 (goto-char (window-start))
5482 (vertical-motion (window-height)))))
5483 (setq selective-display
5484 (and arg (prefix-numeric-value arg)))
5485 (recenter current-vpos))
5486 (set-window-start (selected-window) (window-start (selected-window)))
5487 (princ "selective-display set to " t)
5488 (prin1 selective-display t)
5489 (princ "." t))
5491 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5493 (defun toggle-truncate-lines (&optional arg)
5494 "Toggle truncating of long lines for the current buffer.
5495 When truncating is off, long lines are folded.
5496 With prefix argument ARG, truncate long lines if ARG is positive,
5497 otherwise fold them. Note that in side-by-side windows, this
5498 command has no effect if `truncate-partial-width-windows' is
5499 non-nil."
5500 (interactive "P")
5501 (setq truncate-lines
5502 (if (null arg)
5503 (not truncate-lines)
5504 (> (prefix-numeric-value arg) 0)))
5505 (force-mode-line-update)
5506 (unless truncate-lines
5507 (let ((buffer (current-buffer)))
5508 (walk-windows (lambda (window)
5509 (if (eq buffer (window-buffer window))
5510 (set-window-hscroll window 0)))
5511 nil t)))
5512 (message "Truncate long lines %s"
5513 (if truncate-lines "enabled" "disabled")))
5515 (defun toggle-word-wrap (&optional arg)
5516 "Toggle whether to use word-wrapping for continuation lines.
5517 With prefix argument ARG, wrap continuation lines at word boundaries
5518 if ARG is positive, otherwise wrap them at the right screen edge.
5519 This command toggles the value of `word-wrap'. It has no effect
5520 if long lines are truncated."
5521 (interactive "P")
5522 (setq word-wrap
5523 (if (null arg)
5524 (not word-wrap)
5525 (> (prefix-numeric-value arg) 0)))
5526 (force-mode-line-update)
5527 (message "Word wrapping %s"
5528 (if word-wrap "enabled" "disabled")))
5530 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5531 "The string displayed in the mode line when in overwrite mode.")
5532 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5533 "The string displayed in the mode line when in binary overwrite mode.")
5535 (define-minor-mode overwrite-mode
5536 "Toggle Overwrite mode.
5537 With a prefix argument ARG, enable Overwrite mode if ARG is
5538 positive, and disable it otherwise. If called from Lisp, enable
5539 the mode if ARG is omitted or nil.
5541 When Overwrite mode is enabled, printing characters typed in
5542 replace existing text on a one-for-one basis, rather than pushing
5543 it to the right. At the end of a line, such characters extend
5544 the line. Before a tab, such characters insert until the tab is
5546 overwrite mode; this is supposed to make it easier to insert
5547 characters when necessary."
5548 :variable (overwrite-mode
5549 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-textual)))))
5551 (define-minor-mode binary-overwrite-mode
5552 "Toggle Binary Overwrite mode.
5553 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5554 is positive, and disable it otherwise. If called from Lisp,
5555 enable the mode if ARG is omitted or nil.
5557 When Binary Overwrite mode is enabled, printing characters typed
5558 in replace existing text. Newlines are not treated specially, so
5559 typing at the end of a line joins the line to the next, with the
5560 typed character between them. Typing before a tab character
5561 simply replaces the tab with the character typed.
5563 ordinary typing characters do.
5565 Note that Binary Overwrite mode is not its own minor mode; it is
5566 a specialization of overwrite mode, entered by setting the
5567 `overwrite-mode' variable to `overwrite-mode-binary'."
5568 :variable (overwrite-mode
5569 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-binary)))))
5571 (define-minor-mode line-number-mode
5572 "Toggle line number display in the mode line (Line Number mode).
5573 With a prefix argument ARG, enable Line Number mode if ARG is
5574 positive, and disable it otherwise. If called from Lisp, enable
5575 the mode if ARG is omitted or nil.
5577 Line numbers do not appear for very large buffers and buffers
5578 with very long lines; see variables `line-number-display-limit'
5579 and `line-number-display-limit-width'."
5580 :init-value t :global t :group 'mode-line)
5582 (define-minor-mode column-number-mode
5583 "Toggle column number display in the mode line (Column Number mode).
5584 With a prefix argument ARG, enable Column Number mode if ARG is
5585 positive, and disable it otherwise.
5587 If called from Lisp, enable the mode if ARG is omitted or nil."
5588 :global t :group 'mode-line)
5590 (define-minor-mode size-indication-mode
5591 "Toggle buffer size display in the mode line (Size Indication mode).
5592 With a prefix argument ARG, enable Size Indication mode if ARG is
5593 positive, and disable it otherwise.
5595 If called from Lisp, enable the mode if ARG is omitted or nil."
5596 :global t :group 'mode-line)
5598 (define-minor-mode auto-save-mode
5599 "Toggle auto-saving in the current buffer (Auto Save mode).
5600 With a prefix argument ARG, enable Auto Save mode if ARG is
5601 positive, and disable it otherwise.
5603 If called from Lisp, enable the mode if ARG is omitted or nil."
5604 :variable ((and buffer-auto-save-file-name
5605 ;; If auto-save is off because buffer has shrunk,
5606 ;; then toggling should turn it on.
5607 (>= buffer-saved-size 0))
5608 . (lambda (val)
5609 (setq buffer-auto-save-file-name
5610 (cond
5611 ((null val) nil)
5612 ((and buffer-file-name auto-save-visited-file-name
5613 (not buffer-read-only))
5614 buffer-file-name)
5615 (t (make-auto-save-file-name))))))
5616 ;; If -1 was stored here, to temporarily turn off saving,
5617 ;; turn it back on.
5618 (and (< buffer-saved-size 0)
5619 (setq buffer-saved-size 0)))
5620 \f
5621 (defgroup paren-blinking nil
5622 "Blinking matching of parens and expressions."
5623 :prefix "blink-matching-"
5624 :group 'paren-matching)
5626 (defcustom blink-matching-paren t
5627 "Non-nil means show matching open-paren when close-paren is inserted."
5628 :type 'boolean
5629 :group 'paren-blinking)
5631 (defcustom blink-matching-paren-on-screen t
5632 "Non-nil means show matching open-paren when it is on screen.
5633 If nil, don't show it (but the open-paren can still be shown
5634 when it is off screen).
5636 This variable has no effect if `blink-matching-paren' is nil.
5637 \(In that case, the open-paren is never shown.)
5638 It is also ignored if `show-paren-mode' is enabled."
5639 :type 'boolean
5640 :group 'paren-blinking)
5642 (defcustom blink-matching-paren-distance (* 100 1024)
5643 "If non-nil, maximum distance to search backwards for matching open-paren.
5644 If nil, search stops at the beginning of the accessible portion of the buffer."
5645 :version "23.2" ; 25->100k
5646 :type '(choice (const nil) integer)
5647 :group 'paren-blinking)
5649 (defcustom blink-matching-delay 1
5650 "Time in seconds to delay after showing a matching paren."
5651 :type 'number
5652 :group 'paren-blinking)
5654 (defcustom blink-matching-paren-dont-ignore-comments nil
5655 "If nil, `blink-matching-paren' ignores comments.
5656 More precisely, when looking for the matching parenthesis,
5657 it skips the contents of comments that end before point."
5658 :type 'boolean
5659 :group 'paren-blinking)
5661 (defun blink-matching-check-mismatch (start end)
5662 "Return whether or not START...END are matching parens.
5663 END is the current point and START is the blink position.
5664 START might be nil if no matching starter was found.
5665 Returns non-nil if we find there is a mismatch."
5666 (let* ((end-syntax (syntax-after (1- end)))
5667 (matching-paren (and (consp end-syntax)
5668 (eq (syntax-class end-syntax) 5)
5669 (cdr end-syntax))))
5670 ;; For self-matched chars like " and $, we can't know when they're
5671 ;; mismatched or unmatched, so we can only do it for parens.
5672 (when matching-paren
5673 (not (and start
5674 (or
5675 (eq (char-after start) matching-paren)
5676 ;; The cdr might hold a new paren-class info rather than
5677 ;; a matching-char info, in which case the two CDRs
5678 ;; should match.
5679 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5681 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5682 "Function to check parentheses mismatches.
5683 The function takes two arguments (START and END) where START is the
5684 position just before the opening token and END is the position right after.
5685 START can be nil, if it was not found.
5686 The function should return non-nil if the two tokens do not match.")
5688 (defun blink-matching-open ()
5689 "Move cursor momentarily to the beginning of the sexp before point."
5690 (interactive)
5691 (when (and (not (bobp))
5692 blink-matching-paren)
5693 (let* ((oldpos (point))
5694 (message-log-max nil) ; Don't log messages about paren matching.
5695 (blinkpos
5696 (save-excursion
5697 (save-restriction
5698 (if blink-matching-paren-distance
5699 (narrow-to-region
5700 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5701 (- (point) blink-matching-paren-distance))
5702 oldpos))
5703 (let ((parse-sexp-ignore-comments
5704 (and parse-sexp-ignore-comments
5705 (not blink-matching-paren-dont-ignore-comments))))
5706 (condition-case ()
5707 (progn
5708 (forward-sexp -1)
5709 ;; backward-sexp skips backward over prefix chars,
5710 ;; so move back to the matching paren.
5711 (while (and (< (point) (1- oldpos))
5712 (let ((code (syntax-after (point))))
5713 (or (eq (syntax-class code) 6)
5714 (eq (logand 1048576 (car code))
5715 1048576))))
5716 (forward-char 1))
5717 (point))
5718 (error nil))))))
5719 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5720 (cond
5721 (mismatch
5722 (if blinkpos
5723 (if (minibufferp)
5724 (minibuffer-message "Mismatched parentheses")
5725 (message "Mismatched parentheses"))
5726 (if (minibufferp)
5727 (minibuffer-message "No matching parenthesis found")
5728 (message "No matching parenthesis found"))))
5729 ((not blinkpos) nil)
5730 ((pos-visible-in-window-p blinkpos)
5731 ;; Matching open within window, temporarily move to blinkpos but only
5732 ;; if `blink-matching-paren-on-screen' is non-nil.
5733 (and blink-matching-paren-on-screen
5734 (not show-paren-mode)
5735 (save-excursion
5736 (goto-char blinkpos)
5737 (sit-for blink-matching-delay))))
5738 (t
5739 (save-excursion
5740 (goto-char blinkpos)
5741 (let ((open-paren-line-string
5742 ;; Show what precedes the open in its line, if anything.
5743 (cond
5745 (buffer-substring (line-beginning-position)
5746 (1+ blinkpos)))
5747 ;; Show what follows the open in its line, if anything.
5748 ((save-excursion
5749 (forward-char 1)
5751 (not (eolp)))
5752 (buffer-substring blinkpos
5753 (line-end-position)))
5754 ;; Otherwise show the previous nonblank line,
5755 ;; if there is one.
5757 (concat
5758 (buffer-substring (progn
5760 (line-beginning-position))
5761 (progn (end-of-line)
5763 (point)))
5764 ;; Replace the newline and other whitespace with `...'.
5765 "..."
5766 (buffer-substring blinkpos (1+ blinkpos))))
5767 ;; There is nothing to show except the char itself.
5768 (t (buffer-substring blinkpos (1+ blinkpos))))))
5769 (message "Matches %s"
5770 (substring-no-properties open-paren-line-string)))))))))
5772 (defvar blink-paren-function 'blink-matching-open
5773 "Function called, if non-nil, whenever a close parenthesis is inserted.
5774 More precisely, a char with closeparen syntax is self-inserted.")
5776 (defun blink-paren-post-self-insert-function ()
5777 (when (and (eq (char-before) last-command-event) ; Sanity check.
5778 (memq (char-syntax last-command-event) '(?\) ?\$))
5779 blink-paren-function
5780 (not executing-kbd-macro)
5781 (not noninteractive)
5782 ;; Verify an even number of quoting characters precede the close.
5783 (= 1 (logand 1 (- (point)
5784 (save-excursion
5785 (forward-char -1)
5787 (point))))))
5788 (funcall blink-paren-function)))
5790 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5791 ;; Most likely, this hook is nil, so this arg doesn't matter,
5792 ;; but I use it as a reminder that this function usually
5793 ;; likes to be run after others since it does `sit-for'.
5794 'append)
5795 \f
5796 ;; This executes C-g typed while Emacs is waiting for a command.
5797 ;; Quitting out of a program does not go through here;
5798 ;; that happens in the QUIT macro at the C code level.
5799 (defun keyboard-quit ()
5800 "Signal a `quit' condition.
5801 During execution of Lisp code, this character causes a quit directly.
5802 At top-level, as an editor command, this simply beeps."
5803 (interactive)
5804 ;; Avoid adding the region to the window selection.
5805 (setq saved-region-selection nil)
5806 (let (select-active-regions)
5807 (deactivate-mark))
5808 (if (fboundp 'kmacro-keyboard-quit)
5809 (kmacro-keyboard-quit))
5810 (setq defining-kbd-macro nil)
5811 (let ((debug-on-quit nil))
5812 (signal 'quit nil)))
5814 (defvar buffer-quit-function nil
5817 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
5819 (defun keyboard-escape-quit ()
5821 This command can exit an interactive command such as `query-replace',
5822 can clear out a prefix argument or a region,
5823 can get out of the minibuffer or other recursive edit,
5824 cancel the use of the current buffer (for special-purpose buffers),
5825 or go back to just one window (by deleting all but the selected window)."
5826 (interactive)
5827 (cond ((eq last-command 'mode-exited) nil)
5828 ((region-active-p)
5829 (deactivate-mark))
5830 ((> (minibuffer-depth) 0)
5831 (abort-recursive-edit))
5832 (current-prefix-arg
5833 nil)
5834 ((> (recursion-depth) 0)
5835 (exit-recursive-edit))
5836 (buffer-quit-function
5837 (funcall buffer-quit-function))
5838 ((not (one-window-p t))
5839 (delete-other-windows))
5841 (bury-buffer))))
5843 (defun play-sound-file (file &optional volume device)
5844 "Play sound stored in FILE.
5845 VOLUME and DEVICE correspond to the keywords of the sound
5846 specification for `play-sound'."
5847 (interactive "fPlay sound file: ")
5848 (let ((sound (list :file file)))
5849 (if volume
5850 (plist-put sound :volume volume))
5851 (if device
5852 (plist-put sound :device device))
5853 (push 'sound sound)
5854 (play-sound sound)))
5856 \f
5857 (defcustom read-mail-command 'rmail
5858 "Your preference for a mail reading package.
5859 This is used by some keybindings which support reading mail.
5860 See also `mail-user-agent' concerning sending mail."
5863 (function-item :tag "Emacs interface to MH"
5865 (function :tag "Other"))
5866 :version "21.1"
5867 :group 'mail)
5869 (defcustom mail-user-agent 'message-user-agent
5870 "Your preference for a mail composition package.
5871 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5872 outgoing email message. This variable lets you specify which
5873 mail-sending package you prefer.
5875 Valid values include:
5877 `message-user-agent' -- use the Message package.
5878 See Info node `(message)'.
5879 `sendmail-user-agent' -- use the Mail package.
5880 See Info node `(emacs)Sending Mail'.
5881 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5882 See Info node `(mh-e)'.
5883 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5884 paraphernalia if Gnus is running, particularly
5885 the Gcc: header for archiving.
5887 Additional valid symbols may be available; check with the author of
5888 your package for details. The function should return non-nil if it
5889 succeeds.
5891 See also `read-mail-command' concerning reading mail."
5892 :type '(radio (function-item :tag "Message package"
5894 message-user-agent)
5895 (function-item :tag "Mail package"
5897 sendmail-user-agent)
5898 (function-item :tag "Emacs interface to MH"
5900 mh-e-user-agent)
5901 (function-item :tag "Message with full Gnus features"
5903 gnus-user-agent)
5904 (function :tag "Other"))
5905 :version "23.2" ; sendmail->message
5906 :group 'mail)
5908 (defcustom compose-mail-user-agent-warnings t
5909 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5910 If the value of `mail-user-agent' is the default, and the user
5911 appears to have customizations applying to the old default,
5912 `compose-mail' issues a warning."
5913 :type 'boolean
5914 :version "23.2"
5915 :group 'mail)
5917 (defun rfc822-goto-eoh ()
5918 "If the buffer starts with a mail header, move point to the header's end.
5919 Otherwise, moves to `point-min'.
5920 The end of the header is the start of the next line, if there is one,
5921 else the end of the last line. This function obeys RFC822."
5922 (goto-char (point-min))
5923 (when (re-search-forward
5925 (goto-char (match-beginning 0))))
5927 ;; Used by Rmail (e.g., rmail-forward).
5928 (defvar mail-encode-mml nil
5929 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
5930 the outgoing message before sending it.")
5932 (defun compose-mail (&optional to subject other-headers continue
5933 switch-function yank-action send-actions
5934 return-action)
5935 "Start composing a mail message to send.
5936 This uses the user's chosen mail composition package
5937 as selected with the variable `mail-user-agent'.
5938 The optional arguments TO and SUBJECT specify recipients
5939 and the initial Subject field, respectively.
5941 OTHER-HEADERS is an alist specifying additional
5942 header fields. Elements look like (HEADER . VALUE) where both
5943 HEADER and VALUE are strings.
5945 CONTINUE, if non-nil, says to continue editing a message already
5946 being composed. Interactively, CONTINUE is the prefix argument.
5948 SWITCH-FUNCTION, if non-nil, is a function to use to
5949 switch to and display the buffer used for mail composition.
5951 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5952 to insert the raw text of the message being replied to.
5953 It has the form (FUNCTION . ARGS). The user agent will apply
5954 FUNCTION to ARGS, to insert the raw text of the original message.
5955 \(The user agent will also run `mail-citation-hook', *after* the
5956 original text has been inserted in this way.)
5958 SEND-ACTIONS is a list of actions to call when the message is sent.
5959 Each action has the form (FUNCTION . ARGS).
5961 RETURN-ACTION, if non-nil, is an action for returning to the
5962 caller. It has the form (FUNCTION . ARGS). The function is
5963 called after the mail has been sent or put aside, and the mail
5964 buffer buried."
5965 (interactive
5966 (list nil nil nil current-prefix-arg))
5968 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5969 ;; from sendmail-user-agent to message-user-agent. Some users may
5970 ;; encounter incompatibilities. This hack tries to detect problems
5971 ;; and warn about them.
5972 (and compose-mail-user-agent-warnings
5973 (eq mail-user-agent 'message-user-agent)
5974 (let (warn-vars)
5975 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5976 mail-yank-hooks mail-archive-file-name
5977 mail-default-reply-to mail-mailing-lists
5978 mail-self-blind))
5979 (and (boundp var)
5980 (symbol-value var)
5981 (push var warn-vars)))
5982 (when warn-vars
5983 (display-warning 'mail
5984 (format "\
5985 The default mail mode is now Message mode.
5986 You have the following Mail mode variable%s customized:
5988 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5989 (if (> (length warn-vars) 1) "s" "")
5990 (mapconcat 'symbol-name
5991 warn-vars " "))))))
5993 (let ((function (get mail-user-agent 'composefunc)))
5994 (funcall function to subject other-headers continue switch-function
5995 yank-action send-actions return-action)))
5997 (defun compose-mail-other-window (&optional to subject other-headers continue
5998 yank-action send-actions
5999 return-action)
6001 (interactive (list nil nil nil current-prefix-arg))
6002 (compose-mail to subject other-headers continue
6003 'switch-to-buffer-other-window yank-action send-actions
6004 return-action))
6006 (defun compose-mail-other-frame (&optional to subject other-headers continue
6007 yank-action send-actions
6008 return-action)
6010 (interactive (list nil nil nil current-prefix-arg))
6011 (compose-mail to subject other-headers continue
6012 'switch-to-buffer-other-frame yank-action send-actions
6013 return-action))
6015 \f
6016 (defvar set-variable-value-history nil
6017 "History of values entered with `set-variable'.
6019 Maximum length of the history list is determined by the value
6020 of `history-length', which see.")
6022 (defun set-variable (variable value &optional make-local)
6023 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6024 VARIABLE should be a user option variable name, a Lisp variable
6025 meant to be customized by users. You should enter VALUE in Lisp syntax,
6026 so if you want VALUE to be a string, you must surround it with doublequotes.
6027 VALUE is used literally, not evaluated.
6029 If VARIABLE has a `variable-interactive' property, that is used as if
6030 it were the arg to `interactive' (which see) to interactively read VALUE.
6032 If VARIABLE has been defined with `defcustom', then the type information
6033 in the definition is used to check that VALUE is valid.
6035 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6036 (interactive
6037 (let* ((default-var (variable-at-point))
6038 (var (if (custom-variable-p default-var)
6039 (read-variable (format "Set variable (default %s): " default-var)
6040 default-var)
6041 (read-variable "Set variable: ")))
6042 (minibuffer-help-form '(describe-variable var))
6043 (prop (get var 'variable-interactive))
6044 (obsolete (car (get var 'byte-obsolete-variable)))
6045 (prompt (format "Set %s %s to value: " var
6046 (cond ((local-variable-p var)
6047 "(buffer-local)")
6048 ((or current-prefix-arg
6049 (local-variable-if-set-p var))
6050 "buffer-locally")
6051 (t "globally"))))
6052 (val (progn
6053 (when obsolete
6054 (message (concat "`%S' is obsolete; "
6055 (if (symbolp obsolete) "use `%S' instead" "%s"))
6056 var obsolete)
6057 (sit-for 3))
6058 (if prop
6059 ;; Use VAR's `variable-interactive' property
6060 ;; as an interactive spec for prompting.
6061 (call-interactively `(lambda (arg)
6062 (interactive ,prop)
6063 arg))
6064 (read
6065 (read-string prompt nil
6066 'set-variable-value-history
6067 (format "%S" (symbol-value var))))))))
6068 (list var val current-prefix-arg)))
6070 (and (custom-variable-p variable)
6071 (not (get variable 'custom-type))
6072 (custom-load-symbol variable))
6073 (let ((type (get variable 'custom-type)))
6074 (when type
6075 ;; Match with custom type.
6076 (require 'cus-edit)
6077 (setq type (widget-convert type))
6078 (unless (widget-apply type :match value)
6079 (error "Value `%S' does not match type %S of %S"
6080 value (car type) variable))))
6082 (if make-local
6083 (make-local-variable variable))
6085 (set variable value)
6087 ;; Force a thorough redisplay for the case that the variable
6088 ;; has an effect on the display, like `tab-width' has.
6089 (force-mode-line-update))
6090 \f
6091 ;; Define the major mode for lists of completions.
6093 (defvar completion-list-mode-map
6094 (let ((map (make-sparse-keymap)))
6095 (define-key map [mouse-2] 'mouse-choose-completion)
6096 (define-key map [follow-link] 'mouse-face)
6097 (define-key map [down-mouse-2] nil)
6098 (define-key map "\C-m" 'choose-completion)
6099 (define-key map "\e\e\e" 'delete-completion-window)
6100 (define-key map [left] 'previous-completion)
6101 (define-key map [right] 'next-completion)
6102 (define-key map "q" 'quit-window)
6103 (define-key map "z" 'kill-this-buffer)
6104 map)
6105 "Local map for completion list buffers.")
6107 ;; Completion mode is suitable only for specially formatted data.
6108 (put 'completion-list-mode 'mode-class 'special)
6110 (defvar completion-reference-buffer nil
6111 "Record the buffer that was current when the completion list was requested.
6112 This is a local variable in the completion list buffer.
6113 Initial value is nil to avoid some compiler warnings.")
6115 (defvar completion-no-auto-exit nil
6116 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6117 This also applies to other functions such as `choose-completion'.")
6119 (defvar completion-base-position nil
6120 "Position of the base of the text corresponding to the shown completions.
6121 This variable is used in the *Completions* buffers.
6122 Its value is a list of the form (START END) where START is the place
6123 where the completion should be inserted and END (if non-nil) is the end
6124 of the text to replace. If END is nil, point is used instead.")
6126 (defvar completion-list-insert-choice-function #'completion--replace
6127 "Function to use to insert the text chosen in *Completions*.
6128 Called with three arguments (BEG END TEXT), it should replace the text
6129 between BEG and END with TEXT. Expected to be set buffer-locally
6130 in the *Completions* buffer.")
6132 (defvar completion-base-size nil
6133 "Number of chars before point not involved in completion.
6134 This is a local variable in the completion list buffer.
6135 It refers to the chars in the minibuffer if completing in the
6136 minibuffer, or in `completion-reference-buffer' otherwise.
6137 Only characters in the field at point are included.
6139 If nil, Emacs determines which part of the tail end of the
6140 buffer's text is involved in completion by comparing the text
6141 directly.")
6142 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6144 (defun delete-completion-window ()
6145 "Delete the completion list window.
6146 Go to the window from which completion was requested."
6147 (interactive)
6148 (let ((buf completion-reference-buffer))
6149 (if (one-window-p t)
6150 (if (window-dedicated-p (selected-window))
6151 (delete-frame (selected-frame)))
6152 (delete-window (selected-window))
6153 (if (get-buffer-window buf)
6154 (select-window (get-buffer-window buf))))))
6156 (defun previous-completion (n)
6157 "Move to the previous item in the completion list."
6158 (interactive "p")
6159 (next-completion (- n)))
6161 (defun next-completion (n)
6162 "Move to the next item in the completion list.
6163 With prefix argument N, move N items (negative N means move backward)."
6164 (interactive "p")
6165 (let ((beg (point-min)) (end (point-max)))
6166 (while (and (> n 0) (not (eobp)))
6167 ;; If in a completion, move to the end of it.
6168 (when (get-text-property (point) 'mouse-face)
6169 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6170 ;; Move to start of next one.
6171 (unless (get-text-property (point) 'mouse-face)
6172 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6173 (setq n (1- n)))
6174 (while (and (< n 0) (not (bobp)))
6175 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6176 ;; If in a completion, move to the start of it.
6177 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6178 (goto-char (previous-single-property-change
6179 (point) 'mouse-face nil beg)))
6180 ;; Move to end of the previous completion.
6181 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6182 (goto-char (previous-single-property-change
6183 (point) 'mouse-face nil beg)))
6184 ;; Move to the start of that one.
6185 (goto-char (previous-single-property-change
6186 (point) 'mouse-face nil beg))
6187 (setq n (1+ n))))))
6189 (defun choose-completion (&optional event)
6190 "Choose the completion at point."
6191 (interactive (list last-nonmenu-event))
6192 ;; In case this is run via the mouse, give temporary modes such as
6193 ;; isearch a chance to turn off.
6194 (run-hooks 'mouse-leave-buffer-hook)
6195 (with-current-buffer (window-buffer (posn-window (event-start event)))
6196 (let ((buffer completion-reference-buffer)
6197 (base-size completion-base-size)
6198 (base-position completion-base-position)
6199 (insert-function completion-list-insert-choice-function)
6200 (choice
6201 (save-excursion
6202 (goto-char (posn-point (event-start event)))
6203 (let (beg end)
6204 (cond
6205 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6206 (setq end (point) beg (1+ (point))))
6207 ((and (not (bobp))
6208 (get-text-property (1- (point)) 'mouse-face))
6209 (setq end (1- (point)) beg (point)))
6210 (t (error "No completion here")))
6211 (setq beg (previous-single-property-change beg 'mouse-face))
6212 (setq end (or (next-single-property-change end 'mouse-face)
6213 (point-max)))
6214 (buffer-substring-no-properties beg end)))))
6216 (unless (buffer-live-p buffer)
6217 (error "Destination buffer is dead"))
6218 (quit-window nil (posn-window (event-start event)))
6220 (with-current-buffer buffer
6221 (choose-completion-string
6222 choice buffer
6223 (or base-position
6224 (when base-size
6225 ;; Someone's using old completion code that doesn't know
6226 ;; about base-position yet.
6227 (list (+ base-size (field-beginning))))
6228 ;; If all else fails, just guess.
6229 (list (choose-completion-guess-base-position choice)))
6230 insert-function)))))
6232 ;; Delete the longest partial match for STRING
6233 ;; that can be found before POINT.
6234 (defun choose-completion-guess-base-position (string)
6235 (save-excursion
6236 (let ((opoint (point))
6237 len)
6238 ;; Try moving back by the length of the string.
6239 (goto-char (max (- (point) (length string))
6240 (minibuffer-prompt-end)))
6241 ;; See how far back we were actually able to move. That is the
6242 ;; upper bound on how much we can match and delete.
6243 (setq len (- opoint (point)))
6244 (if completion-ignore-case
6245 (setq string (downcase string)))
6246 (while (and (> len 0)
6247 (let ((tail (buffer-substring (point) opoint)))
6248 (if completion-ignore-case
6249 (setq tail (downcase tail)))
6250 (not (string= tail (substring string 0 len)))))
6251 (setq len (1- len))
6252 (forward-char 1))
6253 (point))))
6255 (defun choose-completion-delete-max-match (string)
6256 (delete-region (choose-completion-guess-base-position string) (point)))
6257 (make-obsolete 'choose-completion-delete-max-match
6258 'choose-completion-guess-base-position "23.2")
6260 (defvar choose-completion-string-functions nil
6261 "Functions that may override the normal insertion of a completion choice.
6262 These functions are called in order with four arguments:
6263 CHOICE - the string to insert in the buffer,
6264 BUFFER - the buffer in which the choice should be inserted,
6265 MINI-P - non-nil if BUFFER is a minibuffer, and
6266 BASE-SIZE - the number of characters in BUFFER before
6267 the string being completed.
6269 If a function in the list returns non-nil, that function is supposed
6270 to have inserted the CHOICE in the BUFFER, and possibly exited
6271 the minibuffer; no further functions will be called.
6273 If all functions in the list return nil, that means to use
6274 the default method of inserting the completion in BUFFER.")
6276 (defun choose-completion-string (choice &optional
6277 buffer base-position insert-function)
6278 "Switch to BUFFER and insert the completion choice CHOICE.
6279 BASE-POSITION, says where to insert the completion."
6281 ;; If BUFFER is the minibuffer, exit the minibuffer
6282 ;; unless it is reading a file name and CHOICE is a directory,
6283 ;; or completion-no-auto-exit is non-nil.
6285 ;; Some older code may call us passing `base-size' instead of
6286 ;; `base-position'. It's difficult to make any use of `base-size',
6287 ;; so we just ignore it.
6288 (unless (consp base-position)
6289 (message "Obsolete `base-size' passed to choose-completion-string")
6290 (setq base-position nil))
6292 (let* ((buffer (or buffer completion-reference-buffer))
6293 (mini-p (minibufferp buffer)))
6294 ;; If BUFFER is a minibuffer, barf unless it's the currently
6295 ;; active minibuffer.
6296 (if (and mini-p
6297 (not (and (active-minibuffer-window)
6298 (equal buffer
6299 (window-buffer (active-minibuffer-window))))))
6300 (error "Minibuffer is not active for completion")
6301 ;; Set buffer so buffer-local choose-completion-string-functions works.
6302 (set-buffer buffer)
6303 (unless (run-hook-with-args-until-success
6304 'choose-completion-string-functions
6305 ;; The fourth arg used to be `mini-p' but was useless
6306 ;; (since minibufferp can be used on the `buffer' arg)
6307 ;; and indeed unused. The last used to be `base-size', so we
6308 ;; keep it to try and avoid breaking old code.
6309 choice buffer base-position nil)
6310 ;; This remove-text-properties should be unnecessary since `choice'
6311 ;; comes from buffer-substring-no-properties.
6312 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6313 ;; Insert the completion into the buffer where it was requested.
6314 (funcall (or insert-function completion-list-insert-choice-function)
6315 (or (car base-position) (point))
6316 (or (cadr base-position) (point))
6317 choice)
6318 ;; Update point in the window that BUFFER is showing in.
6319 (let ((window (get-buffer-window buffer t)))
6320 (set-window-point window (point)))
6321 ;; If completing for the minibuffer, exit it with this choice.
6322 (and (not completion-no-auto-exit)
6323 (minibufferp buffer)
6324 minibuffer-completion-table
6325 ;; If this is reading a file name, and the file name chosen
6326 ;; is a directory, don't exit the minibuffer.
6327 (let* ((result (buffer-substring (field-beginning) (point)))
6328 (bounds
6329 (completion-boundaries result minibuffer-completion-table
6330 minibuffer-completion-predicate
6331 "")))
6332 (if (eq (car bounds) (length result))
6333 ;; The completion chosen leads to a new set of completions
6334 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6335 (let ((mini (active-minibuffer-window)))
6336 (select-window mini)
6337 (when minibuffer-auto-raise
6338 (raise-frame (window-frame mini))))
6339 (exit-minibuffer))))))))
6341 (define-derived-mode completion-list-mode nil "Completion List"
6342 "Major mode for buffers showing lists of possible completions.
6344 to select the completion near point.
6346 with the mouse.
6349 (set (make-local-variable 'completion-base-size) nil))
6351 (defun completion-list-mode-finish ()
6352 "Finish setup of the completions buffer.
6353 Called from `temp-buffer-show-hook'."
6354 (when (eq major-mode 'completion-list-mode)
6355 (setq buffer-read-only t)))
6357 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6360 ;; Variables and faces used in `completion-setup-function'.
6362 (defcustom completion-show-help t
6363 "Non-nil means show help message in *Completions* buffer."
6364 :type 'boolean
6365 :version "22.1"
6366 :group 'completion)
6368 ;; This function goes in completion-setup-hook, so that it is called
6369 ;; after the text of the completion list buffer is written.
6370 (defun completion-setup-function ()
6371 (let* ((mainbuf (current-buffer))
6372 (base-dir
6373 ;; When reading a file name in the minibuffer,
6374 ;; try and find the right default-directory to set in the
6375 ;; completion list buffer.
6376 ;; FIXME: Why do we do that, actually? --Stef
6377 (if minibuffer-completing-file-name
6378 (file-name-as-directory
6379 (expand-file-name
6380 (substring (minibuffer-completion-contents)
6381 0 (or completion-base-size 0)))))))
6382 (with-current-buffer standard-output
6383 (let ((base-size completion-base-size) ;Read before killing localvars.
6384 (base-position completion-base-position)
6385 (insert-fun completion-list-insert-choice-function))
6386 (completion-list-mode)
6387 (set (make-local-variable 'completion-base-size) base-size)
6388 (set (make-local-variable 'completion-base-position) base-position)
6389 (set (make-local-variable 'completion-list-insert-choice-function)
6390 insert-fun))
6391 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6392 (if base-dir (setq default-directory base-dir))
6393 ;; Maybe insert help string.
6394 (when completion-show-help
6395 (goto-char (point-min))
6396 (if (display-mouse-p)
6397 (insert (substitute-command-keys
6399 (insert (substitute-command-keys
6403 (add-hook 'completion-setup-hook 'completion-setup-function)
6405 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6406 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6408 (defun switch-to-completions ()
6409 "Select the completion list window."
6410 (interactive)
6411 (let ((window (or (get-buffer-window "*Completions*" 0)
6412 ;; Make sure we have a completions window.
6413 (progn (minibuffer-completion-help)
6414 (get-buffer-window "*Completions*" 0)))))
6415 (when window
6416 (select-window window)
6417 ;; In the new buffer, go to the first completion.
6418 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6419 (when (bobp)
6420 (next-completion 1)))))
6421 \f
6422 ;;; Support keyboard commands to turn on various modifiers.
6424 ;; These functions -- which are not commands -- each add one modifier
6425 ;; to the following event.
6427 (defun event-apply-alt-modifier (_ignore-prompt)
6430 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6431 (defun event-apply-super-modifier (_ignore-prompt)
6434 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6435 (defun event-apply-hyper-modifier (_ignore-prompt)
6438 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6439 (defun event-apply-shift-modifier (_ignore-prompt)
6442 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6443 (defun event-apply-control-modifier (_ignore-prompt)
6446 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6447 (defun event-apply-meta-modifier (_ignore-prompt)
6450 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6452 (defun event-apply-modifier (event symbol lshiftby prefix)
6453 "Apply a modifier flag to event EVENT.
6454 SYMBOL is the name of this modifier, as a symbol.
6455 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6456 PREFIX is the string that represents this modifier in an event type symbol."
6457 (if (numberp event)
6458 (cond ((eq symbol 'control)
6459 (if (and (<= (downcase event) ?z)
6460 (>= (downcase event) ?a))
6461 (- (downcase event) ?a -1)
6462 (if (and (<= (downcase event) ?Z)
6463 (>= (downcase event) ?A))
6464 (- (downcase event) ?A -1)
6465 (logior (lsh 1 lshiftby) event))))
6466 ((eq symbol 'shift)
6467 (if (and (<= (downcase event) ?z)
6468 (>= (downcase event) ?a))
6469 (upcase event)
6470 (logior (lsh 1 lshiftby) event)))
6471 (t
6472 (logior (lsh 1 lshiftby) event)))
6473 (if (memq symbol (event-modifiers event))
6474 event
6475 (let ((event-type (if (symbolp event) event (car event))))
6476 (setq event-type (intern (concat prefix (symbol-name event-type))))
6477 (if (symbolp event)
6478 event-type
6479 (cons event-type (cdr event)))))))
6481 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6482 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6483 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6484 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6485 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6486 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6487 \f
6488 ;;;; Keypad support.
6490 ;; Make the keypad keys act like ordinary typing keys. If people add
6491 ;; bindings for the function key symbols, then those bindings will
6492 ;; override these, so this shouldn't interfere with any existing
6493 ;; bindings.
6495 ;; Also tell read-char how to handle these keys.
6496 (mapc
6497 (lambda (keypad-normal)
6498 (let ((keypad (nth 0 keypad-normal))
6499 (normal (nth 1 keypad-normal)))
6500 (put keypad 'ascii-character normal)
6501 (define-key function-key-map (vector keypad) (vector normal))))
6502 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6503 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6504 (kp-space ?\s)
6507 (kp-multiply ?*)
6508 (kp-add ?+)
6509 (kp-separator ?,)
6510 (kp-subtract ?-)
6511 (kp-decimal ?.)
6512 (kp-divide ?/)
6513 (kp-equal ?=)
6514 ;; Do the same for various keys that are represented as symbols under
6515 ;; GUIs but naturally correspond to characters.
6516 (backspace 127)
6517 (delete 127)
6520 (clear ?\C-l)
6521 (return ?\C-m)
6522 (escape ?\e)
6523 ))
6524 \f
6525 ;;;;
6526 ;;;; forking a twin copy of a buffer.
6527 ;;;;
6529 (defvar clone-buffer-hook nil
6530 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6532 (defvar clone-indirect-buffer-hook nil
6533 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6535 (defun clone-process (process &optional newname)
6536 "Create a twin copy of PROCESS.
6537 If NEWNAME is nil, it defaults to PROCESS' name;
6538 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6539 If PROCESS is associated with a buffer, the new process will be associated
6540 with the current buffer instead.
6541 Returns nil if PROCESS has already terminated."
6542 (setq newname (or newname (process-name process)))
6544 (setq newname (substring newname 0 (match-beginning 0))))
6545 (when (memq (process-status process) '(run stop open))
6546 (let* ((process-connection-type (process-tty-name process))
6547 (new-process
6548 (if (memq (process-status process) '(open))
6549 (let ((args (process-contact process t)))
6550 (setq args (plist-put args :name newname))
6551 (setq args (plist-put args :buffer
6552 (if (process-buffer process)
6553 (current-buffer))))
6554 (apply 'make-network-process args))
6555 (apply 'start-process newname
6556 (if (process-buffer process) (current-buffer))
6557 (process-command process)))))
6558 (set-process-query-on-exit-flag
6559 new-process (process-query-on-exit-flag process))
6560 (set-process-inherit-coding-system-flag
6561 new-process (process-inherit-coding-system-flag process))
6562 (set-process-filter new-process (process-filter process))
6563 (set-process-sentinel new-process (process-sentinel process))
6564 (set-process-plist new-process (copy-sequence (process-plist process)))
6565 new-process)))
6567 ;; things to maybe add (currently partly covered by `funcall mode'):
6568 ;; - syntax-table
6569 ;; - overlays
6570 (defun clone-buffer (&optional newname display-flag)
6571 "Create and return a twin copy of the current buffer.
6572 Unlike an indirect buffer, the new buffer can be edited
6573 independently of the old one (if it is not read-only).
6574 NEWNAME is the name of the new buffer. It may be modified by
6575 adding or incrementing <N> at the end as necessary to create a
6576 unique buffer name. If nil, it defaults to the name of the
6577 current buffer, with the proper suffix. If DISPLAY-FLAG is
6578 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6579 clone a file-visiting buffer, or a buffer whose major mode symbol
6580 has a non-nil `no-clone' property, results in an error.
6582 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6583 current buffer with appropriate suffix. However, if a prefix
6584 argument is given, then the command prompts for NEWNAME in the
6585 minibuffer.
6587 This runs the normal hook `clone-buffer-hook' in the new buffer
6588 after it has been set up properly in other respects."
6589 (interactive
6590 (progn
6591 (if buffer-file-name
6592 (error "Cannot clone a file-visiting buffer"))
6593 (if (get major-mode 'no-clone)
6594 (error "Cannot clone a buffer in %s mode" mode-name))
6595 (list (if current-prefix-arg
6596 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6597 t)))
6598 (if buffer-file-name
6599 (error "Cannot clone a file-visiting buffer"))
6600 (if (get major-mode 'no-clone)
6601 (error "Cannot clone a buffer in %s mode" mode-name))
6602 (setq newname (or newname (buffer-name)))
6604 (setq newname (substring newname 0 (match-beginning 0))))
6605 (let ((buf (current-buffer))
6606 (ptmin (point-min))
6607 (ptmax (point-max))
6608 (pt (point))
6609 (mk (if mark-active (mark t)))
6610 (modified (buffer-modified-p))
6611 (mode major-mode)
6612 (lvars (buffer-local-variables))
6613 (process (get-buffer-process (current-buffer)))
6614 (new (generate-new-buffer (or newname (buffer-name)))))
6615 (save-restriction
6616 (widen)
6617 (with-current-buffer new
6618 (insert-buffer-substring buf)))
6619 (with-current-buffer new
6620 (narrow-to-region ptmin ptmax)
6621 (goto-char pt)
6622 (if mk (set-mark mk))
6623 (set-buffer-modified-p modified)
6625 ;; Clone the old buffer's process, if any.
6626 (when process (clone-process process))
6628 ;; Now set up the major mode.
6629 (funcall mode)
6631 ;; Set up other local variables.
6632 (mapc (lambda (v)
6633 (condition-case () ;in case var is read-only
6634 (if (symbolp v)
6635 (makunbound v)
6636 (set (make-local-variable (car v)) (cdr v)))
6637 (error nil)))
6638 lvars)
6640 ;; Run any hooks (typically set up by the major mode
6641 ;; for cloning to work properly).
6642 (run-hooks 'clone-buffer-hook))
6643 (if display-flag
6644 ;; Presumably the current buffer is shown in the selected frame, so
6645 ;; we want to display the clone elsewhere.
6646 (let ((same-window-regexps nil)
6647 (same-window-buffer-names))
6648 (pop-to-buffer new)))
6649 new))
6652 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6653 "Create an indirect buffer that is a twin copy of the current buffer.
6655 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6656 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6657 or if not called with a prefix arg, NEWNAME defaults to the current
6658 buffer's name. The name is modified by adding a `<N>' suffix to it
6659 or by incrementing the N in an existing suffix. Trying to clone a
6660 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6661 property results in an error.
6663 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6664 This is always done when called interactively.
6666 Optional third arg NORECORD non-nil means do not put this buffer at the
6667 front of the list of recently selected ones."
6668 (interactive
6669 (progn
6670 (if (get major-mode 'no-clone-indirect)
6671 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6672 (list (if current-prefix-arg
6673 (read-buffer "Name of indirect buffer: " (current-buffer)))
6674 t)))
6675 (if (get major-mode 'no-clone-indirect)
6676 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6677 (setq newname (or newname (buffer-name)))
6679 (setq newname (substring newname 0 (match-beginning 0))))
6680 (let* ((name (generate-new-buffer-name newname))
6681 (buffer (make-indirect-buffer (current-buffer) name t)))
6682 (with-current-buffer buffer
6683 (run-hooks 'clone-indirect-buffer-hook))
6684 (when display-flag
6685 (pop-to-buffer buffer norecord))
6686 buffer))
6689 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6690 "Like `clone-indirect-buffer' but display in another window."
6691 (interactive
6692 (progn
6693 (if (get major-mode 'no-clone-indirect)
6694 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6695 (list (if current-prefix-arg
6696 (read-buffer "Name of indirect buffer: " (current-buffer)))
6697 t)))
6698 (let ((pop-up-windows t))
6699 (clone-indirect-buffer newname display-flag norecord)))
6701 \f
6702 ;;; Handling of Backspace and Delete keys.
6704 (defcustom normal-erase-is-backspace 'maybe
6705 "Set the default behavior of the Delete and Backspace keys.
6707 If set to t, Delete key deletes forward and Backspace key deletes
6708 backward.
6710 If set to nil, both Delete and Backspace keys delete backward.
6712 If set to 'maybe (which is the default), Emacs automatically
6713 selects a behavior. On window systems, the behavior depends on
6714 the keyboard used. If the keyboard has both a Backspace key and
6715 a Delete key, and both are mapped to their usual meanings, the
6716 option's default value is set to t, so that Backspace can be used
6717 to delete backward, and Delete can be used to delete forward.
6719 If not running under a window system, customizing this option
6720 accomplishes a similar effect by mapping C-h, which is usually
6721 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6722 via `keyboard-translate'. The former functionality of C-h is
6723 available on the F1 key. You should probably not use this
6724 setting if you don't have both Backspace, Delete and F1 keys.
6726 Setting this variable with setq doesn't take effect. Programmatically,
6727 call `normal-erase-is-backspace-mode' (which see) instead."
6728 :type '(choice (const :tag "Off" nil)
6729 (const :tag "Maybe" maybe)
6730 (other :tag "On" t))
6731 :group 'editing-basics
6732 :version "21.1"
6733 :set (lambda (symbol value)
6734 ;; The fboundp is because of a problem with :set when
6735 ;; dumping Emacs. It doesn't really matter.
6736 (if (fboundp 'normal-erase-is-backspace-mode)
6737 (normal-erase-is-backspace-mode (or value 0))
6738 (set-default symbol value))))
6740 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6741 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6742 (unless frame (setq frame (selected-frame)))
6743 (with-selected-frame frame
6744 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6745 (normal-erase-is-backspace-mode
6746 (if (if (eq normal-erase-is-backspace 'maybe)
6747 (and (not noninteractive)
6748 (or (memq system-type '(ms-dos windows-nt))
6749 (memq window-system '(ns))
6750 (and (memq window-system '(x))
6751 (fboundp 'x-backspace-delete-keys-p)
6752 (x-backspace-delete-keys-p))
6753 ;; If the terminal Emacs is running on has erase char
6754 ;; set to ^H, use the Backspace key for deleting
6755 ;; backward, and the Delete key for deleting forward.
6756 (and (null window-system)
6757 (eq tty-erase-char ?\^H))))
6758 normal-erase-is-backspace)
6759 1 0)))))
6761 (define-minor-mode normal-erase-is-backspace-mode
6762 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6763 With a prefix argument ARG, enable this feature if ARG is
6764 positive, and disable it otherwise. If called from Lisp, enable
6765 the mode if ARG is omitted or nil.
6767 On window systems, when this mode is on, Delete is mapped to C-d
6768 and Backspace is mapped to DEL; when this mode is off, both
6769 Delete and Backspace are mapped to DEL. (The remapping goes via
6770 `local-function-key-map', so binding Delete or Backspace in the
6771 global or local keymap will override that.)
6773 In addition, on window systems, the bindings of C-Delete, M-Delete,
6774 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6775 the global keymap in accordance with the functionality of Delete and
6776 Backspace. For example, if Delete is remapped to C-d, which deletes
6777 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6778 to DEL, which deletes backward, C-Delete is bound to
6779 `backward-kill-word'.
6781 If not running on a window system, a similar effect is accomplished by
6782 remapping C-h (normally produced by the Backspace key) and DEL via
6783 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6784 to C-d; if it's off, the keys are not remapped.
6786 When not running on a window system, and this mode is turned on, the
6787 former functionality of C-h is available on the F1 key. You should
6788 probably not turn on this mode on a text-only terminal if you don't
6789 have both Backspace, Delete and F1 keys.
6791 See also `normal-erase-is-backspace'."
6792 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
6793 . (lambda (v)
6794 (setf (terminal-parameter nil 'normal-erase-is-backspace)
6795 (if v 1 0))))
6796 (let ((enabled (eq 1 (terminal-parameter
6797 nil 'normal-erase-is-backspace))))
6799 (cond ((or (memq window-system '(x w32 ns pc))
6800 (memq system-type '(ms-dos windows-nt)))
6801 (let ((bindings
6802 `(([M-delete] [M-backspace])
6803 ([C-M-delete] [C-M-backspace])
6804 ([?\e C-delete] [?\e C-backspace]))))
6806 (if enabled
6807 (progn
6808 (define-key local-function-key-map [delete] [deletechar])
6809 (define-key local-function-key-map [kp-delete] [?\C-d])
6810 (define-key local-function-key-map [backspace] [?\C-?])
6811 (dolist (b bindings)
6812 ;; Not sure if input-decode-map is really right, but
6813 ;; keyboard-translate-table (used below) only works
6814 ;; for integer events, and key-translation-table is
6815 ;; global (like the global-map, used earlier).
6816 (define-key input-decode-map (car b) nil)
6817 (define-key input-decode-map (cadr b) nil)))
6818 (define-key local-function-key-map [delete] [?\C-?])
6819 (define-key local-function-key-map [kp-delete] [?\C-?])
6820 (define-key local-function-key-map [backspace] [?\C-?])
6821 (dolist (b bindings)
6822 (define-key input-decode-map (car b) (cadr b))
6823 (define-key input-decode-map (cadr b) (car b))))))
6824 (t
6825 (if enabled
6826 (progn
6827 (keyboard-translate ?\C-h ?\C-?)
6828 (keyboard-translate ?\C-? ?\C-d))
6829 (keyboard-translate ?\C-h ?\C-h)
6830 (keyboard-translate ?\C-? ?\C-?))))
6832 (if (called-interactively-p 'interactive)
6833 (message "Delete key deletes %s"
6834 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6835 "forward" "backward")))))
6836 \f
6837 (defvar vis-mode-saved-buffer-invisibility-spec nil
6838 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6840 (define-minor-mode visible-mode
6841 "Toggle making all invisible text temporarily visible (Visible mode).
6842 With a prefix argument ARG, enable Visible mode if ARG is
6843 positive, and disable it otherwise. If called from Lisp, enable
6844 the mode if ARG is omitted or nil.
6846 This mode works by saving the value of `buffer-invisibility-spec'
6847 and setting it to nil."
6848 :lighter " Vis"
6849 :group 'editing-basics
6850 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6851 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6852 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6853 (when visible-mode
6854 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6855 buffer-invisibility-spec)
6856 (setq buffer-invisibility-spec nil)))
6857 \f
6858 ;; Minibuffer prompt stuff.
6860 ;;(defun minibuffer-prompt-modification (start end)
6861 ;; (error "You cannot modify the prompt"))
6862 ;;
6863 ;;
6864 ;;(defun minibuffer-prompt-insertion (start end)
6865 ;; (let ((inhibit-modification-hooks t))
6866 ;; (delete-region start end)
6867 ;; ;; Discard undo information for the text insertion itself
6868 ;; ;; and for the text deletion.above.
6869 ;; (when (consp buffer-undo-list)
6870 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6871 ;; (message "You cannot modify the prompt")))
6872 ;;
6873 ;;
6874 ;;(setq minibuffer-prompt-properties
6875 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6876 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6878 \f
6879 ;;;; Problematic external packages.
6881 ;; rms says this should be done by specifying symbols that define
6882 ;; versions together with bad values. This is therefore not as
6883 ;; flexible as it could be. See the thread:
6884 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6885 (defconst bad-packages-alist
6886 ;; Not sure exactly which semantic versions have problems.
6887 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6889 "The version of `semantic' loaded does not work in Emacs 22.
6890 It can cause constant high CPU load.
6891 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6892 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6893 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6894 ;; provided the `CUA-mode' feature. Since this is no longer true,
6895 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6896 (CUA-mode t nil
6897 "CUA-mode is now part of the standard GNU Emacs distribution,
6898 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6900 You have loaded an older version of CUA-mode which does not work
6901 correctly with this version of Emacs. You should remove the old
6902 version and use the one distributed with Emacs."))
6903 "Alist of packages known to cause problems in this version of Emacs.
6904 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6905 PACKAGE is either a regular expression to match file names, or a
6906 symbol (a feature name); see the documentation of
6907 `after-load-alist', to which this variable adds functions.
6908 SYMBOL is either the name of a string variable, or `t'. Upon
6909 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6910 warning using STRING as the message.")
6912 (defun bad-package-check (package)
6913 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6914 (condition-case nil
6915 (let* ((list (assoc package bad-packages-alist))
6916 (symbol (nth 1 list)))
6917 (and list
6918 (boundp symbol)
6919 (or (eq symbol t)
6920 (and (stringp (setq symbol (eval symbol)))
6921 (string-match-p (nth 2 list) symbol)))
6922 (display-warning package (nth 3 list) :warning)))
6923 (error nil)))
6925 (mapc (lambda (elem)
6926 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6927 bad-packages-alist)
6930 (provide 'simple)
6932 ;;; simple.el ends here