| blob | f42ea3e7a50b84b3f8d1868e6be9059a6dd9bfdc |
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: ".
1357 \f
1359 "Default minibuffer history list.
1360 This is used for all minibuffer input
1361 except when an alternate history list is specified.
1363 Maximum length of the history list is determined by the value
1366 "Control whether history list elements are expressions or strings.
1367 If the value of this variable equals current minibuffer depth,
1368 they are expressions; otherwise they are strings.
1369 \(That convention is designed to do the right thing for
1376 "Text that was in this minibuffer before any history commands.
1377 This is nil if there have not yet been any history commands
1386 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1390 "Minibuffer history variables for which matching should ignore case.
1391 If a history variable is a member of this list, then the
1393 commands ignore case when searching it, regardless of `case-fold-search'."
1398 "Find the previous history element that matches REGEXP.
1399 \(Previous history elements refer to earlier actions.)
1400 With prefix argument N, search for Nth previous match.
1401 If N is negative, find the next or Nth next match.
1402 Normally, history elements are matched case-insensitively if
1403 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1404 makes the search case-sensitive.
1405 See also `minibuffer-history-case-insensitive-variables'."
1409 nil
1410 minibuffer-local-map
1411 nil
1412 'minibuffer-history-search-history
1414 ;; Use the last regexp specified, by default, if input is empty.
1419 regexp)
1429 ;; On some systems, ignore case for file names.
1431 minibuffer-history-case-insensitive-variables)
1432 t
1433 ;; Respect the user's setting for case-fold-search:
1434 case-fold-search)
1435 nil))
1436 prevpos
1437 match-string
1438 match-offset
1445 "No later matching history item"
1466 next-matching-history-element))
1470 "Find the next history element that matches REGEXP.
1471 \(The next history element refers to a more recent action.)
1472 With prefix argument N, search for Nth next match.
1473 If N is negative, find the previous or Nth previous match.
1474 Normally, history elements are matched case-insensitively if
1475 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1476 makes the search case-sensitive."
1480 nil
1481 minibuffer-local-map
1482 nil
1483 'minibuffer-history-search-history
1485 ;; Use the last regexp specified, by default, if input is empty.
1490 regexp)
1497 "Function run by `goto-history-element' before consuming default values.
1498 This is useful to dynamically add more elements to the list of default values
1499 when `goto-history-element' reaches the end of this list.
1500 Before calling this function `goto-history-element' sets the variable
1501 `minibuffer-default-add-done' to t, so it will call this function only
1502 once. In special cases, when this function needs to be called more
1503 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1507 "When nil, add more elements to the end of the list of default values.
1508 The value nil causes `goto-history-element' to add more elements to
1509 the list of defaults when it reaches the end of this list. It does
1515 "Return a list of all completions without the default value.
1516 This function is used to add all elements of the completion table to
1517 the end of the list of defaults just after the default value."
1520 minibuffer-completion-table
1521 minibuffer-completion-predicate)))
1527 "Puts element of the minibuffer history in the minibuffer.
1528 The argument NABS specifies the absolute history position."
1542 elt minibuffer-returned-to-present)
1554 previous-history-element))
1566 minibuffer-default)))
1578 elt))
1582 "Puts next element of the minibuffer history in the minibuffer.
1583 With argument N, it uses the Nth following element."
1589 "Puts previous element of the minibuffer history in the minibuffer.
1590 With argument N, it uses the Nth previous element."
1596 "Get next history element which completes the minibuffer before the point.
1597 The contents of the minibuffer after the point are deleted, and replaced
1598 by the new completion."
1604 n)
1605 ;; next-matching-history-element always puts us at (point-min).
1606 ;; Move to the position we were at before changing the buffer contents.
1607 ;; This is still sensible, because the text before point has not changed.
1611 "\
1612 Get previous history element which completes the minibuffer before the point.
1613 The contents of the minibuffer after the point are deleted, and replaced
1614 by the new completion."
1618 ;; For compatibility with the old subr of the same name.
1620 "Return the display width of the minibuffer prompt.
1621 Return 0 if current buffer is not a minibuffer."
1622 ;; Return the width of everything before the field at the end of
1623 ;; the buffer; this should be 0 for normal buffers.
1625 \f
1626 ;; isearch minibuffer history
1633 "Set up a minibuffer for using isearch to search the minibuffer history.
1634 Intended to be added to `minibuffer-setup-hook'."
1646 "Clean up the minibuffer after terminating isearch in the minibuffer."
1651 "Return the proper search function, for isearch in minibuffer history."
1658 ;; Use standard functions to search within minibuffer text
1664 found)
1665 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1666 ;; searching forward. Lazy-highlight calls this lambda with the
1667 ;; bound arg, so skip the minibuffer prompt.
1671 ;; 1. First try searching in the initial minibuffer text
1674 noerror)
1675 ;; 2. If the above search fails, start putting next/prev history
1676 ;; elements in the minibuffer successively, and search the string
1677 ;; in them. Do this only when bound is nil (i.e. not while
1678 ;; lazy-highlighting search strings in the current minibuffer text).
1690 ;; After putting the next/prev history element, search
1691 ;; the string in them again, until next-history-element
1692 ;; or previous-history-element raises an error at the
1693 ;; beginning/end of history.
1696 ;; For backward search, don't search
1697 ;; in the minibuffer prompt
1699 noerror)))
1700 ;; Return point of the new search result
1702 ;; Return nil when next(prev)-history-element fails
1706 "Display the minibuffer history search prompt.
1707 If there are no search errors, this function displays an overlay with
1708 the isearch prompt which replaces the original minibuffer prompt.
1709 Otherwise, it displays the standard isearch message returned from
1710 `isearch-message'."
1712 ;; Use standard function `isearch-message' when not in the minibuffer,
1713 ;; or search fails, or has an error (like incomplete regexp).
1714 ;; This function overwrites minibuffer text with isearch message,
1715 ;; so it's possible to see what is wrong in the search string.
1717 ;; Otherwise, put the overlay with the standard isearch prompt over
1718 ;; the initial minibuffer prompt.
1727 ;; And clear any previous isearch message.
1731 "Wrap the minibuffer history search when search fails.
1732 Move point to the first history element for a forward search,
1733 or to the last history element for a backward search."
1735 ;; When `minibuffer-history-isearch-search' fails on reaching the
1736 ;; beginning/end of the history, wrap the search to the first/last
1737 ;; minibuffer history element.
1745 "Save a function restoring the state of minibuffer history search.
1746 Save `minibuffer-history-position' to the additional state parameter
1747 in the search status stack."
1752 "Restore the minibuffer history search state.
1753 Go to the history element by the absolute history position HIST-POS."
1756 \f
1757 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1761 "Table mapping redo records to the corresponding undo one.
1762 A redo record for undo-in-region maps to t.
1772 "Within a run of consecutive undo commands, list remaining to be undone.
1776 "Undo some previous changes.
1777 Repeat this command to undo more changes.
1778 A numeric ARG serves as a repeat count.
1780 In Transient Mark mode when the mark is active, only undo changes within
1782 as an argument limits undo to changes within the current region."
1784 ;; Make last-command indicate for the next command that this was an undo.
1785 ;; That way, another undo will undo more.
1786 ;; If we get to the end of the undo history and get an error,
1787 ;; another undo command will find the undo history empty
1788 ;; and will get another error. To begin undoing the undos,
1789 ;; you must type some other command.
1792 message)
1793 ;; If we get an error in undo-start,
1794 ;; the next command should not be a "consecutive undo".
1795 ;; So set `this-command' to something other than `undo'.
1800 ;; If something (a timer or filter?) changed the buffer
1801 ;; since the previous command, don't continue the undo seq.
1805 ;; If the last undo record made was made by undo
1806 ;; it shows nothing else happened in between.
1813 ;; get rid of initial undo boundary
1815 ;; If we got this far, the next command should be a consecutive undo.
1817 ;; Check to see whether we're hitting a redo record, and if
1818 ;; so, ask the user whether she wants to skip the redo/undo pair.
1825 ;; The equiv entry might point to another redo record if we have done
1826 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1834 ;; Record the fact that the just-generated undo records come from an
1835 ;; undo operation--that is, they are redo records.
1836 ;; In the ordinary case (not within a region), map the redo
1837 ;; record to the following undos.
1838 ;; I don't know how to do that in the undo-in-region case.
1840 ;; Strip any leading undo boundaries there might be, like we do
1841 ;; above when checking.
1845 undo-equiv-table))
1846 ;; Don't specify a position in the undo record for the undo command.
1847 ;; Instead, undoing this should move point to where the change is.
1866 ;; Record what the current undo list says,
1867 ;; so the next command can tell if the buffer was modified in between.
1870 ;; Display a message announcing success.
1875 "Make BUFFER stop keeping undo information.
1876 No argument or nil as argument means do this for the current buffer."
1882 "Undo some previous changes.
1883 Repeat this command to undo more changes.
1884 A numeric ARG serves as a repeat count.
1885 Contrary to `undo', this will not redo a previous undo."
1890 "Non-nil while performing an undo.
1894 "Undo back N undo-boundaries beyond what was already undone recently.
1895 Call `undo-start' to get ready to undo recent changes,
1896 then call `undo-more' one or more times to undo them."
1901 ;; Note: The following, while pulling elements off
1902 ;; `pending-undo-list' will call primitive change functions which
1903 ;; will push more elements onto `buffer-undo-list'.
1908 ;; Deep copy of a list
1910 "Make a copy of undo list LIST."
1916 elt))
1919 "Set `pending-undo-list' to the front of the undo list.
1920 The next call to `undo-more' will undo the most recently made change.
1921 If BEG and END are specified, then only undo elements
1922 that apply to text between BEG and END are used; other undo elements
1923 are ignored. If BEG and END are nil, all undo elements are used."
1929 buffer-undo-list)))
1934 "Return a list of undo elements for the region START to END.
1935 The elements come from `buffer-undo-list', but we keep only
1936 the elements inside this region, and discard those outside this region.
1937 If we find an element that crosses an edge of this region,
1938 we stop and ignore all further elements."
1941 undo-adjusted-markers
1942 some-rejected
1943 undo-elt temp-undo-list delta)
1948 ;; This is a "was unmodified" element.
1949 ;; Keep it if we have kept everything thus far.
1956 ;; Don't put two nils together in the list
1970 ;; Loop down the earlier events adjusting their buffer
1971 ;; positions to reflect the fact that a change to the buffer
1972 ;; isn't being undone. We only need to process those element
1973 ;; types which undo-elt-in-region will return as being in
1974 ;; the region since only those types can ever get into the
1975 ;; output
1984 ;; (TEXT . POSITION)
1991 ;; (BEGIN . END)
1996 ;; (nil PROPERTY VALUE BEG . END)
2006 "Determine whether UNDO-ELT falls inside the region START ... END.
2007 If it crosses the edge, we return nil."
2012 t)
2014 nil)
2016 ;; (TEXT . POSITION)
2020 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2021 ;; See if MARKER is inside the region.
2032 ;; (nil PROPERTY VALUE BEG . END)
2037 ;; (BEGIN . END)
2042 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2043 This assumes we have already decided that UNDO-ELT
2044 is not *inside* the region START...END."
2047 ;; (nil PROPERTY VALUE BEG . END)
2052 ;; (BEGIN . END)
2056 ;; Return the first affected buffer position and the delta for an undo element
2057 ;; delta is defined as the change in subsequent buffer positions if we *did*
2058 ;; the undo.
2062 ;; (TEXT . POSITION)
2065 ;; (BEGIN . END)
2072 "If non-nil ask about discarding undo info for the current command.
2073 Normally, Emacs discards the undo info for the current command if
2074 it exceeds `undo-outer-limit'. But if you set this option
2075 non-nil, it asks in the echo area whether to discard the info.
2076 If you answer no, there is a slight risk that Emacs might crash, so
2077 only do it if you really want to undo the command.
2079 This option is mainly intended for debugging. You have to be
2080 careful if you use it for other purposes. Garbage collection is
2081 inhibited while the question is asked, meaning that Emacs might
2082 leak memory. So you should make sure that you do not wait
2083 excessively long before answering the question."
2089 "If non-nil, an extra level of size that's ok in an undo item.
2090 We don't ask the user about truncating the undo list until the
2091 current item gets bigger than this amount.
2096 ;; When the first undo batch in an undo list is longer than
2097 ;; undo-outer-limit, this function gets called to warn the user that
2098 ;; the undo info for the current command was discarded. Garbage
2099 ;; collection is inhibited around the call, so it had better not do a
2100 ;; lot of consing.
2106 ;; Don't ask the question again unless it gets even bigger.
2107 ;; This applies, in particular, if the user quits from the question.
2108 ;; Such a quit quits out of GC, but something else will call GC
2109 ;; again momentarily. It will call this function again,
2110 ;; but we don't want to ask the question again.
2117 t)
2118 nil))
2123 "The undo info was discarded because it exceeded \
2124 `undo-outer-limit'.
2126 This is normal if you executed a command that made a huge change
2127 to the buffer. In that case, to prevent similar problems in the
2128 future, set `undo-outer-limit' to a value that is large enough to
2129 cover the maximum size of normal changes you expect a single
2130 command to make, but not so large that it might exceed the
2131 maximum memory allotted to Emacs.
2133 If you did not execute any such command, the situation is
2134 probably due to a bug and you should report it.
2136 You can disable the popping up of this buffer by adding the entry
2137 \(undo discard-info) to the user option `warning-suppress-types',
2141 t))
2142 \f
2144 "History list for some commands that read shell commands.
2146 Maximum length of the history list is determined by the value
2153 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2154 This buffer is used when `shell-command' or `shell-command-on-region'
2155 is run interactively. A value of nil means that output to stderr and
2162 "Return a list of all commands associated with the current file.
2163 This function is used to add all related commands retrieved by `mailcap'
2164 to the end of the list of defaults just after the default value."
2168 minibuffer-default))
2173 commands))
2184 map)
2188 "Read a shell command from the minibuffer.
2189 The arguments are the same as the ones of `read-from-minibuffer',
2190 except READ and KEYMAP are missing and HIST defaults
2191 to `shell-command-history'."
2199 minibuffer-local-shell-command-map
2200 nil
2202 args)))
2205 "Execute string COMMAND asynchronously in background.
2207 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2208 surrounded by whitespace and executes the command asynchronously.
2209 The output appears in the buffer `*Async Shell Command*'.
2211 In Elisp, you will often be better served by calling `start-process'
2212 directly, since it offers more control and does not impose the use of a
2213 shell (with its need to quote arguments)."
2219 current-prefix-arg
2220 shell-command-default-error-buffer))
2226 "Execute string COMMAND in inferior shell; display output, if any.
2227 With prefix argument, insert the COMMAND's output at point.
2229 If COMMAND ends in ampersand, execute it asynchronously.
2230 The output appears in the buffer `*Async Shell Command*'.
2231 That buffer is in shell mode.
2233 Otherwise, COMMAND is executed synchronously. The output appears in
2234 the buffer `*Shell Command Output*'. If the output is short enough to
2235 display in the echo area (which is determined by the variables
2236 `resize-mini-windows' and `max-mini-window-height'), it is shown
2237 there, but it is nonetheless available in buffer `*Shell Command
2238 Output*' even though that buffer is not automatically displayed.
2240 To specify a coding system for converting non-ASCII characters
2242 before this command.
2244 Noninteractive callers can specify coding systems by binding
2245 `coding-system-for-read' and `coding-system-for-write'.
2247 The optional second argument OUTPUT-BUFFER, if non-nil,
2248 says to put the output in some other buffer.
2249 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2250 If OUTPUT-BUFFER is not a buffer and not nil,
2251 insert output in current buffer. (This cannot be done asynchronously.)
2252 In either case, the buffer is first erased, and the output is
2253 inserted after point (leaving mark after it).
2255 If the command terminates without error, but generates output,
2257 the output can be displayed in the echo area or in its buffer.
2258 If the output is short enough to display in the echo area
2259 \(determined by the variable `max-mini-window-height' if
2260 `resize-mini-windows' is non-nil), it is shown there.
2261 Otherwise,the buffer containing the output is displayed.
2265 of the output.
2267 If there is no output, or if output is inserted in the current buffer,
2268 then `*Shell Command Output*' is deleted.
2270 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2271 or buffer name to which to direct the command's standard error output.
2272 If it is nil, error output is mingled with regular output.
2273 In an interactive call, the variable `shell-command-default-error-buffer'
2274 specifies the value of ERROR-BUFFER.
2276 In Elisp, you will often be better served by calling `call-process' or
2277 `start-process' directly, since it offers more control and does not impose
2278 the use of a shell (with its need to quote arguments)."
2289 current-prefix-arg
2290 shell-command-default-error-buffer))
2291 ;; Look for a handler in case default-directory is a remote file name.
2299 ;; Output goes in current buffer.
2305 temporary-file-directory)))
2306 nil)))
2309 ;; We do not use -f for csh; we will not support broken use of
2310 ;; .cshrcs. Even the BSD csh manual says to use
2311 ;; "if ($?prompt) exit" before things which are not useful
2312 ;; non-interactively. Besides, if someone wants their other
2313 ;; aliases for shell commands then they can still have them.
2317 t)
2318 nil shell-command-switch command)
2325 ;; Do no formatting while reading error file,
2326 ;; because that can run a shell command, and we
2327 ;; don't want that to cause an infinite recursion.
2329 ;; Put point after the inserted errors.
2333 ;; This is like exchange-point-and-mark, but doesn't
2334 ;; activate the mark. It is cleaner to avoid activation,
2335 ;; even though the command loop would deactivate the mark
2336 ;; because we inserted text.
2340 ;; Output goes in a separate buffer.
2341 ;; Preserve the match data in case called from a program.
2344 ;; Command ending with ampersand means asynchronous.
2348 proc)
2349 ;; Remove the ampersand.
2351 ;; If will kill a process, query first.
2359 ;; Setting buffer-read-only to nil doesn't suffice
2360 ;; if some text has a non-nil read-only property,
2361 ;; which comint sometimes adds for prompts.
2367 shell-command-switch command))
2371 ;; Use the comint filter for proper handling of carriage motion
2372 ;; (see `comint-inhibit-carriage-motion'),.
2374 ))
2375 ;; Otherwise, command is executed synchronously.
2377 output-buffer nil error-buffer)))))))
2381 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2382 MESSAGE may be either a string or a buffer.
2384 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2385 the maximum height of the echo area, as defined by `max-mini-window-height'
2386 if `resize-mini-windows' is non-nil.
2388 Returns either the string shown in the echo area, or when a pop-up
2389 buffer is used, the window used to display it.
2391 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2392 name of the buffer used to display it in the case where a pop-up buffer
2393 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2394 string and it is displayed in the echo area, it is not specified whether
2395 the contents are inserted into the buffer anyway.
2397 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2398 and only used if a buffer is displayed."
2400 ;; Trivial case where we can use the echo area
2404 ;; Trivial case where we can just remove single trailing newline
2407 ;; General case
2410 message
2419 0
2423 (<= lines
2427 max-mini-window-height))
2429 max-mini-window-height)
2433 ;; Don't use the echo area if the output buffer is
2434 ;; already displayed in the selected frame.
2436 ;; Echo area
2442 ;; Buffer
2445 not-this-window frame))))))))
2448 ;; We have a sentinel to prevent insertion of a termination message
2449 ;; in the buffer itself.
2457 &optional output-buffer replace
2458 error-buffer display-error-buffer)
2459 "Execute string COMMAND in inferior shell with region as input.
2460 Normally display output (if any) in temp buffer `*Shell Command Output*';
2461 Prefix arg means replace the region with it. Return the exit code of
2462 COMMAND.
2464 To specify a coding system for converting non-ASCII characters
2466 before this command. By default, the input (from the current buffer)
2467 is encoded in the same coding system that will be used to save the file,
2468 `buffer-file-coding-system'. If the output is going to replace the region,
2469 then it is decoded from that same coding system.
2471 The noninteractive arguments are START, END, COMMAND,
2472 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2473 Noninteractive callers can specify coding systems by binding
2474 `coding-system-for-read' and `coding-system-for-write'.
2476 If the command generates output, the output may be displayed
2477 in the echo area or in a buffer.
2478 If the output is short enough to display in the echo area
2479 \(determined by the variable `max-mini-window-height' if
2480 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2481 it is displayed in the buffer `*Shell Command Output*'. The output
2482 is available in that buffer in both cases.
2484 If there is output and an error, a message about the error
2485 appears at the end of the output.
2487 If there is no output, or if output is inserted in the current buffer,
2488 then `*Shell Command Output*' is deleted.
2490 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2491 that says to put the output in some other buffer.
2492 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2493 If OUTPUT-BUFFER is not a buffer and not nil,
2494 insert output in the current buffer.
2495 In either case, the output is inserted after point (leaving mark after it).
2497 If REPLACE, the optional fifth argument, is non-nil, that means insert
2498 the output in place of text from START to END, putting point and mark
2499 around it.
2501 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2502 or buffer name to which to direct the command's standard error output.
2503 If it is nil, error output is mingled with regular output.
2504 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2505 were any errors. (This is always t, interactively.)
2506 In an interactive call, the variable `shell-command-default-error-buffer'
2507 specifies the value of ERROR-BUFFER."
2511 ;; Do this before calling region-beginning
2512 ;; and region-end, in case subprocess output
2513 ;; relocates them while we are in the minibuffer.
2515 ;; call-interactively recognizes region-beginning and
2516 ;; region-end specially, leaving them in the history.
2518 string
2519 current-prefix-arg
2520 current-prefix-arg
2521 shell-command-default-error-buffer
2522 t)))
2528 temporary-file-directory)))
2529 nil))
2530 exit-status)
2534 ;; Replace specified region with output from command.
2536 ;; Don't muck with mark unless REPLACE says we should.
2543 t)
2544 nil shell-command-switch command))
2545 ;; It is rude to delete a buffer which the command is not using.
2546 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2547 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2548 ;; (kill-buffer shell-buffer)))
2549 ;; Don't muck with mark unless REPLACE says we should.
2551 ;; No prefix argument: put the output in a temp buffer,
2552 ;; replacing its entire contents.
2557 ;; If the input is the same buffer as the output,
2558 ;; delete everything but the specified region,
2559 ;; then replace that region with the output.
2565 shell-file-name t
2568 t)
2569 nil shell-command-switch
2570 command)))
2571 ;; Clear the output buffer, then run the command with
2572 ;; output there.
2583 buffer)
2584 nil shell-command-switch command)))
2585 ;; Report the output.
2595 ;; There's some output, display it
2597 ;; No output; error?
2604 shell-command-default-error-buffer)
2611 output))
2614 exit-status))
2617 exit-status output))))
2618 ;; Don't kill: there might be useful info in the undo-log.
2619 ;; (kill-buffer buffer)
2620 ))))
2628 ;; Do no formatting while reading error file,
2629 ;; because that can run a shell command, and we
2630 ;; don't want that to cause an infinite recursion.
2632 ;; Put point after the inserted errors.
2637 exit-status))
2640 "Execute shell command COMMAND and return its output as a string."
2643 standard-output
2647 "Process files synchronously in a separate process.
2648 Similar to `call-process', but may invoke a file handler based on
2649 `default-directory'. The current working directory of the
2650 subprocess is `default-directory'.
2652 File names in INFILE and BUFFER are handled normally, but file
2653 names in ARGS should be relative to `default-directory', as they
2654 are passed to the process verbatim. \(This is a difference to
2655 `call-process' which does not support file handlers for INFILE
2656 and BUFFER.\)
2658 Some file handlers might not support all variants, for example
2659 they might behave as if DISPLAY was nil, regardless of the actual
2660 value passed."
2662 lc stderr-file)
2672 display args)
2678 "Whether a call of `process-file' changes remote files.
2680 Per default, this variable is always set to `t', meaning that a
2681 call of `process-file' could potentially change any file on a
2682 remote host. When set to `nil', a file handler could optimize
2683 its behavior with respect to remote file attributes caching.
2685 This variable should never be changed by `setq'. Instead of, it
2689 "Start a program in a subprocess. Return the process object for it.
2691 Similar to `start-process', but may invoke a file handler based on
2692 `default-directory'. See Info node `(elisp)Magic File Names'.
2694 This handler ought to run PROGRAM, perhaps on the local host,
2695 perhaps on a remote host that corresponds to `default-directory'.
2696 In the latter case, the local part of `default-directory' becomes
2697 the working directory of the process.
2699 PROGRAM and PROGRAM-ARGS might be file names. They are not
2700 objects of file handler invocation. File handlers might not
2701 support pty association, if PROGRAM is nil."
2705 \f
2706 ;;;; Process menu
2718 "Major mode for listing the processes called by Emacs."
2730 "Recompute the list of processes for the Process List buffer.
2731 Also, delete any process that is exited or signaled."
2744 face link
2747 follow-link t
2748 process-buffer ,buf
2749 action process-menu-visit-buffer)
2758 "datagram"
2773 tabulated-list-entries))))))
2779 "Display a list of all processes.
2780 If optional argument QUERY-ONLY is non-nil, only processes with
2781 the query-on-exit flag set are listed.
2782 Any process listed as exited or signaled is actually eliminated
2783 after the listing is made.
2784 Optional argument BUFFER specifies a buffer to use, instead of
2786 The return value is always nil."
2798 nil)
2799 \f
2803 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2804 (define-key map [switch-frame] nil)
2805 (define-key map [?\C-u] 'universal-argument-more)
2806 (define-key map [?-] 'universal-argument-minus)
2807 (define-key map [?0] 'digit-argument)
2808 (define-key map [?1] 'digit-argument)
2809 (define-key map [?2] 'digit-argument)
2810 (define-key map [?3] 'digit-argument)
2811 (define-key map [?4] 'digit-argument)
2812 (define-key map [?5] 'digit-argument)
2813 (define-key map [?6] 'digit-argument)
2814 (define-key map [?7] 'digit-argument)
2815 (define-key map [?8] 'digit-argument)
2816 (define-key map [?9] 'digit-argument)
2817 (define-key map [kp-0] 'digit-argument)
2818 (define-key map [kp-1] 'digit-argument)
2819 (define-key map [kp-2] 'digit-argument)
2820 (define-key map [kp-3] 'digit-argument)
2821 (define-key map [kp-4] 'digit-argument)
2822 (define-key map [kp-5] 'digit-argument)
2823 (define-key map [kp-6] 'digit-argument)
2824 (define-key map [kp-7] 'digit-argument)
2825 (define-key map [kp-8] 'digit-argument)
2826 (define-key map [kp-9] 'digit-argument)
2827 (define-key map [kp-subtract] 'universal-argument-minus)
2828 map)
2831 (defvar universal-argument-num-events nil
2832 "Number of argument-specifying events read by `universal-argument'.
2833 `universal-argument-other-key' uses this to discard those events
2834 from (this-command-keys), and reread only the final command.")
2836 (defvar saved-overriding-map t
2837 "The saved value of `overriding-terminal-local-map'.
2841 (defun save&set-overriding-map (map)
2842 "Set `overriding-terminal-local-map' to MAP."
2843 (when (eq saved-overriding-map t)
2844 (setq saved-overriding-map overriding-terminal-local-map)
2845 (setq overriding-terminal-local-map map)))
2847 (defun restore-overriding-map ()
2848 "Restore `overriding-terminal-local-map' to its saved value."
2849 (setq overriding-terminal-local-map saved-overriding-map)
2850 (setq saved-overriding-map t))
2852 (defun universal-argument ()
2853 "Begin a numeric argument for the following command.
2858 multiplies the argument by 4 each time.
2860 which is different in effect from any particular numeric argument.
2862 (interactive)
2863 (setq prefix-arg (list 4))
2864 (setq universal-argument-num-events (length (this-command-keys)))
2865 (save&set-overriding-map universal-argument-map))
2867 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2868 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2869 (defun universal-argument-more (arg)
2870 (interactive "P")
2871 (if (consp arg)
2872 (setq prefix-arg (list (* 4 (car arg))))
2873 (if (eq arg '-)
2874 (setq prefix-arg (list -4))
2875 (setq prefix-arg arg)
2876 (restore-overriding-map)))
2877 (setq universal-argument-num-events (length (this-command-keys))))
2879 (defun negative-argument (arg)
2880 "Begin a negative numeric argument for the next command.
2882 (interactive "P")
2883 (cond ((integerp arg)
2884 (setq prefix-arg (- arg)))
2885 ((eq arg '-)
2886 (setq prefix-arg nil))
2887 (t
2888 (setq prefix-arg '-)))
2889 (setq universal-argument-num-events (length (this-command-keys)))
2890 (save&set-overriding-map universal-argument-map))
2892 (defun digit-argument (arg)
2893 "Part of the numeric argument for the next command.
2895 (interactive "P")
2896 (let* ((char (if (integerp last-command-event)
2897 last-command-event
2898 (get last-command-event 'ascii-character)))
2900 (cond ((integerp arg)
2901 (setq prefix-arg (+ (* arg 10)
2902 (if (< arg 0) (- digit) digit))))
2903 ((eq arg '-)
2904 ;; Treat -0 as just -, so that -01 will work.
2905 (setq prefix-arg (if (zerop digit) '- (- digit))))
2906 (t
2907 (setq prefix-arg digit))))
2908 (setq universal-argument-num-events (length (this-command-keys)))
2909 (save&set-overriding-map universal-argument-map))
2911 ;; For backward compatibility, minus with no modifiers is an ordinary
2912 ;; command if digits have already been entered.
2913 (defun universal-argument-minus (arg)
2914 (interactive "P")
2915 (if (integerp arg)
2916 (universal-argument-other-key arg)
2917 (negative-argument arg)))
2919 ;; Anything else terminates the argument and is left in the queue to be
2920 ;; executed as a command.
2921 (defun universal-argument-other-key (arg)
2922 (interactive "P")
2923 (setq prefix-arg arg)
2924 (let* ((key (this-command-keys))
2925 (keylist (listify-key-sequence key)))
2926 (setq unread-command-events
2927 (append (nthcdr universal-argument-num-events keylist)
2928 unread-command-events)))
2929 (reset-this-command-lengths)
2930 (restore-overriding-map))
2931 \f
2933 (defvar filter-buffer-substring-functions nil
2934 "This variable is a wrapper hook around `filter-buffer-substring'.
2935 Each member of the hook should be a function accepting four arguments:
2936 \(FUN BEG END DELETE), where FUN is itself a function of three arguments
2937 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
2938 as those of `filter-buffer-substring' in each case.
2940 The first hook function to be called receives a FUN equivalent
2941 to the default operation of `filter-buffer-substring',
2942 i.e. one that returns the buffer-substring between BEG and
2943 END (processed by any `buffer-substring-filters'). Normally,
2944 the hook function will call FUN and then do its own processing
2945 of the result. The next hook function receives a FUN equivalent
2946 to the previous hook function, calls it, and does its own
2947 processing, and so on. The overall result is that of all hook
2948 functions acting in sequence.
2950 Any hook may choose not to call FUN though, in which case it
2951 effectively replaces the default behavior with whatever it chooses.
2952 Of course, a later hook function may do the same thing.")
2954 (defvar buffer-substring-filters nil
2955 "List of filter functions for `filter-buffer-substring'.
2956 Each function must accept a single argument, a string, and return
2957 a string. The buffer substring is passed to the first function
2958 in the list, and the return value of each function is passed to
2959 the next. The final result (if `buffer-substring-filters' is
2960 nil, this is the unfiltered buffer-substring) is passed to the
2961 first function on `filter-buffer-substring-functions'.
2963 As a special convention, point is set to the start of the buffer text
2964 being operated on (i.e., the first argument of `filter-buffer-substring')
2965 before these functions are called.")
2966 (make-obsolete-variable 'buffer-substring-filters
2967 'filter-buffer-substring-functions "24.1")
2969 (defun filter-buffer-substring (beg end &optional delete)
2970 "Return the buffer substring between BEG and END, after filtering.
2971 The wrapper hook `filter-buffer-substring-functions' performs
2972 the actual filtering. The obsolete variable `buffer-substring-filters'
2973 is also consulted. If both of these are nil, no filtering is done.
2975 If DELETE is non-nil, the text between BEG and END is deleted
2976 from the buffer.
2978 This function should be used instead of `buffer-substring',
2979 `buffer-substring-no-properties', or `delete-and-extract-region'
2980 when you want to allow filtering to take place. For example,
2981 major or minor modes can use `filter-buffer-substring-functions' to
2982 extract characters that are special to a buffer, and should not
2983 be copied into other buffers."
2984 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2985 (cond
2986 ((or delete buffer-substring-filters)
2987 (save-excursion
2988 (goto-char beg)
2989 (let ((string (if delete (delete-and-extract-region beg end)
2990 (buffer-substring beg end))))
2991 (dolist (filter buffer-substring-filters)
2992 (setq string (funcall filter string)))
2993 string)))
2994 (t
2995 (buffer-substring beg end)))))
2998 ;;;; Window system cut and paste hooks.
3000 (defvar interprogram-cut-function nil
3001 "Function to call to make a killed region available to other programs.
3003 Most window systems provide some sort of facility for cutting and
3004 pasting text between the windows of different programs.
3005 This variable holds a function that Emacs calls whenever text
3006 is put in the kill ring, to make the new kill available to other
3007 programs.
3009 The function takes one argument, TEXT, which is a string containing
3010 the text which should be made available.")
3012 (defvar interprogram-paste-function nil
3013 "Function to call to get text cut from other programs.
3015 Most window systems provide some sort of facility for cutting and
3016 pasting text between the windows of different programs.
3017 This variable holds a function that Emacs calls to obtain
3018 text that other programs have provided for pasting.
3020 The function should be called with no arguments. If the function
3021 returns nil, then no other program has provided such text, and the top
3022 of the Emacs kill ring should be used. If the function returns a
3023 string, then the caller of the function \(usually `current-kill')
3024 should put this string in the kill ring as the latest kill.
3026 This function may also return a list of strings if the window
3027 system supports multiple selections. The first string will be
3028 used as the pasted text, but the other will be placed in the
3029 kill ring for easy access via `yank-pop'.
3031 Note that the function should return a string only if a program other
3032 than Emacs has provided a string for pasting; if Emacs provided the
3033 most recent string, the function should return nil. If it is
3034 difficult to tell whether Emacs or some other program provided the
3035 current string, it is probably good enough to return nil if the string
3036 is equal (according to `string=') to the last text Emacs provided.")
3037 \f
3040 ;;;; The kill ring data structure.
3042 (defvar kill-ring nil
3043 "List of killed text sequences.
3044 Since the kill ring is supposed to interact nicely with cut-and-paste
3045 facilities offered by window systems, use of this variable should
3046 interact nicely with `interprogram-cut-function' and
3047 `interprogram-paste-function'. The functions `kill-new',
3048 `kill-append', and `current-kill' are supposed to implement this
3049 interaction; you may want to use them instead of manipulating the kill
3050 ring directly.")
3052 (defcustom kill-ring-max 60
3053 "Maximum length of kill ring before oldest elements are thrown away."
3054 :type 'integer
3055 :group 'killing)
3057 (defvar kill-ring-yank-pointer nil
3058 "The tail of the kill ring whose car is the last thing yanked.")
3060 (defcustom save-interprogram-paste-before-kill nil
3061 "Save clipboard strings into kill ring before replacing them.
3062 When one selects something in another program to paste it into Emacs,
3063 but kills something in Emacs before actually pasting it,
3064 this selection is gone unless this variable is non-nil,
3065 in which case the other program's selection is saved in the `kill-ring'
3067 :type 'boolean
3068 :group 'killing
3069 :version "23.2")
3071 (defcustom kill-do-not-save-duplicates nil
3072 "Do not add a new string to `kill-ring' when it is the same as the last one."
3073 :type 'boolean
3074 :group 'killing
3075 :version "23.2")
3077 (defun kill-new (string &optional replace yank-handler)
3078 "Make STRING the latest kill in the kill ring.
3079 Set `kill-ring-yank-pointer' to point to it.
3080 If `interprogram-cut-function' is non-nil, apply it to STRING.
3081 Optional second argument REPLACE non-nil means that STRING will replace
3082 the front of the kill ring, rather than being added to the list.
3084 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3085 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3086 STRING.
3088 When the yank handler has a non-nil PARAM element, the original STRING
3089 argument is not used by `insert-for-yank'. However, since Lisp code
3090 may access and use elements from the kill ring directly, the STRING
3092 (if (> (length string) 0)
3093 (if yank-handler
3094 (put-text-property 0 (length string)
3095 'yank-handler yank-handler string))
3096 (if yank-handler
3097 (signal 'args-out-of-range
3098 (list string "yank-handler specified for empty string"))))
3099 (unless (and kill-do-not-save-duplicates
3100 (equal string (car kill-ring)))
3101 (if (fboundp 'menu-bar-update-yank-menu)
3102 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3103 (when save-interprogram-paste-before-kill
3104 (let ((interprogram-paste (and interprogram-paste-function
3105 (funcall interprogram-paste-function))))
3106 (when interprogram-paste
3107 (dolist (s (if (listp interprogram-paste)
3108 (nreverse interprogram-paste)
3109 (list interprogram-paste)))
3110 (unless (and kill-do-not-save-duplicates
3111 (equal s (car kill-ring)))
3112 (push s kill-ring))))))
3113 (unless (and kill-do-not-save-duplicates
3114 (equal string (car kill-ring)))
3115 (if (and replace kill-ring)
3116 (setcar kill-ring string)
3117 (push string kill-ring)
3118 (if (> (length kill-ring) kill-ring-max)
3119 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3120 (setq kill-ring-yank-pointer kill-ring)
3121 (if interprogram-cut-function
3122 (funcall interprogram-cut-function string)))
3123 (set-advertised-calling-convention
3124 'kill-new '(string &optional replace) "23.3")
3126 (defun kill-append (string before-p &optional yank-handler)
3127 "Append STRING to the end of the latest kill in the kill ring.
3128 If BEFORE-P is non-nil, prepend STRING to the kill.
3129 If `interprogram-cut-function' is set, pass the resulting kill to it."
3130 (let* ((cur (car kill-ring)))
3131 (kill-new (if before-p (concat string cur) (concat cur string))
3132 (or (= (length cur) 0)
3133 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3134 yank-handler)))
3135 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3137 (defcustom yank-pop-change-selection nil
3138 "If non-nil, rotating the kill ring changes the window system selection."
3139 :type 'boolean
3140 :group 'killing
3141 :version "23.1")
3143 (defun current-kill (n &optional do-not-move)
3144 "Rotate the yanking point by N places, and then return that kill.
3145 If N is zero and `interprogram-paste-function' is set to a
3146 function that returns a string or a list of strings, and if that
3147 function doesn't return nil, then that string (or list) is added
3148 to the front of the kill ring and the string (or first string in
3149 the list) is returned as the latest kill.
3151 If N is not zero, and if `yank-pop-change-selection' is
3152 non-nil, use `interprogram-cut-function' to transfer the
3153 kill at the new yank point into the window system selection.
3155 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3156 move the yanking point; just return the Nth kill forward."
3158 (let ((interprogram-paste (and (= n 0)
3159 interprogram-paste-function
3160 (funcall interprogram-paste-function))))
3161 (if interprogram-paste
3162 (progn
3163 ;; Disable the interprogram cut function when we add the new
3164 ;; text to the kill ring, so Emacs doesn't try to own the
3165 ;; selection, with identical text.
3166 (let ((interprogram-cut-function nil))
3167 (if (listp interprogram-paste)
3168 (mapc 'kill-new (nreverse interprogram-paste))
3169 (kill-new interprogram-paste)))
3170 (car kill-ring))
3171 (or kill-ring (error "Kill ring is empty"))
3172 (let ((ARGth-kill-element
3173 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3174 (length kill-ring))
3175 kill-ring)))
3176 (unless do-not-move
3177 (setq kill-ring-yank-pointer ARGth-kill-element)
3178 (when (and yank-pop-change-selection
3179 (> n 0)
3180 interprogram-cut-function)
3181 (funcall interprogram-cut-function (car ARGth-kill-element))))
3182 (car ARGth-kill-element)))))
3186 ;;;; Commands for manipulating the kill ring.
3188 (defcustom kill-read-only-ok nil
3189 "Non-nil means don't signal an error for killing read-only text."
3190 :type 'boolean
3191 :group 'killing)
3193 (put 'text-read-only 'error-conditions
3194 '(text-read-only buffer-read-only error))
3195 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3197 (defun kill-region (beg end &optional yank-handler)
3199 This deletes the text from the buffer and saves it in the kill ring.
3203 If you want to append the killed region to the last killed text,
3206 If the buffer is read-only, Emacs will beep and refrain from deleting
3207 the text, but put the text in the kill ring anyway. This means that
3208 you can use the killing commands to copy text from a read-only buffer.
3210 Lisp programs should use this function for killing text.
3211 (To delete text, use `delete-region'.)
3212 Supply two arguments, character positions indicating the stretch of text
3213 to be killed.
3215 If the previous command was also a kill command,
3216 the text killed this time appends to the text killed last time
3217 to make one entry in the kill ring."
3218 ;; Pass point first, then mark, because the order matters
3219 ;; when calling kill-append.
3220 (interactive (list (point) (mark)))
3221 (unless (and beg end)
3222 (error "The mark is not set now, so there is no region"))
3223 (condition-case nil
3224 (let ((string (filter-buffer-substring beg end t)))
3225 (when string ;STRING is nil if BEG = END
3226 ;; Add that string to the kill ring, one way or another.
3227 (if (eq last-command 'kill-region)
3228 (kill-append string (< end beg) yank-handler)
3229 (kill-new string nil yank-handler)))
3230 (when (or string (eq last-command 'kill-region))
3231 (setq this-command 'kill-region))
3232 nil)
3233 ((buffer-read-only text-read-only)
3234 ;; The code above failed because the buffer, or some of the characters
3235 ;; in the region, are read-only.
3236 ;; We should beep, in case the user just isn't aware of this.
3237 ;; However, there's no harm in putting
3238 ;; the region's text in the kill ring, anyway.
3239 (copy-region-as-kill beg end)
3240 ;; Set this-command now, so it will be set even if we get an error.
3241 (setq this-command 'kill-region)
3242 ;; This should barf, if appropriate, and give us the correct error.
3243 (if kill-read-only-ok
3244 (progn (message "Read only text copied to kill ring") nil)
3245 ;; Signal an error if the buffer is read-only.
3246 (barf-if-buffer-read-only)
3247 ;; If the buffer isn't read-only, the text is.
3248 (signal 'text-read-only (list (current-buffer)))))))
3249 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3251 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3252 ;; to get two copies of the text when the user accidentally types M-w and
3253 ;; then corrects it with the intended C-w.
3254 (defun copy-region-as-kill (beg end)
3255 "Save the region as if killed, but don't kill it.
3256 In Transient Mark mode, deactivate the mark.
3257 If `interprogram-cut-function' is non-nil, also save the text for a window
3258 system cut and paste.
3260 This command's old key binding has been given to `kill-ring-save'."
3261 (interactive "r")
3262 (if (eq last-command 'kill-region)
3263 (kill-append (filter-buffer-substring beg end) (< end beg))
3264 (kill-new (filter-buffer-substring beg end)))
3265 (setq deactivate-mark t)
3266 nil)
3268 (defun kill-ring-save (beg end)
3269 "Save the region as if killed, but don't kill it.
3270 In Transient Mark mode, deactivate the mark.
3271 If `interprogram-cut-function' is non-nil, also save the text for a window
3272 system cut and paste.
3274 If you want to append the killed line to the last killed text,
3277 This command is similar to `copy-region-as-kill', except that it gives
3278 visual feedback indicating the extent of the region being copied."
3279 (interactive "r")
3280 (copy-region-as-kill beg end)
3281 ;; This use of called-interactively-p is correct
3282 ;; because the code it controls just gives the user visual feedback.
3283 (if (called-interactively-p 'interactive)
3284 (let ((other-end (if (= (point) beg) end beg))
3285 (opoint (point))
3286 ;; Inhibit quitting so we can make a quit here
3287 ;; look like a C-g typed as a command.
3288 (inhibit-quit t))
3289 (if (pos-visible-in-window-p other-end (selected-window))
3290 ;; Swap point-and-mark quickly so as to show the region that
3291 ;; was selected. Don't do it if the region is highlighted.
3292 (unless (and (region-active-p)
3293 (face-background 'region))
3294 ;; Swap point and mark.
3295 (set-marker (mark-marker) (point) (current-buffer))
3296 (goto-char other-end)
3297 (sit-for blink-matching-delay)
3298 ;; Swap back.
3299 (set-marker (mark-marker) other-end (current-buffer))
3300 (goto-char opoint)
3301 ;; If user quit, deactivate the mark
3302 ;; as C-g would as a command.
3303 (and quit-flag mark-active
3304 (deactivate-mark)))
3305 (let* ((killed-text (current-kill 0))
3306 (message-len (min (length killed-text) 40)))
3307 (if (= (point) beg)
3308 ;; Don't say "killed"; that is misleading.
3310 (substring killed-text (- message-len)))
3312 (substring killed-text 0 message-len))))))))
3314 (defun append-next-kill (&optional interactive)
3315 "Cause following command, if it kills, to append to previous kill.
3316 The argument is used for internal purposes; do not supply one."
3317 (interactive "p")
3318 ;; We don't use (interactive-p), since that breaks kbd macros.
3319 (if interactive
3320 (progn
3321 (setq this-command 'kill-region)
3322 (message "If the next command is a kill, it will append"))
3323 (setq last-command 'kill-region)))
3324 \f
3325 ;; Yanking.
3327 ;; This is actually used in subr.el but defcustom does not work there.
3328 (defcustom yank-excluded-properties
3329 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3330 yank-handler follow-link fontified)
3331 "Text properties to discard when yanking.
3332 The value should be a list of text properties to discard or t,
3333 which means to discard all text properties."
3334 :type '(choice (const :tag "All" t) (repeat symbol))
3335 :group 'killing
3336 :version "22.1")
3338 (defvar yank-window-start nil)
3339 (defvar yank-undo-function nil
3340 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3341 Function is called with two parameters, START and END corresponding to
3342 the value of the mark and point; it is guaranteed that START <= END.
3343 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3345 (defun yank-pop (&optional arg)
3346 "Replace just-yanked stretch of killed text with a different stretch.
3347 This command is allowed only immediately after a `yank' or a `yank-pop'.
3348 At such a time, the region contains a stretch of reinserted
3349 previously-killed text. `yank-pop' deletes that text and inserts in its
3350 place a different stretch of killed text.
3352 With no argument, the previous kill is inserted.
3353 With argument N, insert the Nth previous kill.
3354 If N is negative, this is a more recent kill.
3356 The sequence of kills wraps around, so that after the oldest one
3357 comes the newest one.
3359 When this command inserts killed text into the buffer, it honors
3360 `yank-excluded-properties' and `yank-handler' as described in the
3361 doc string for `insert-for-yank-1', which see."
3362 (interactive "*p")
3363 (if (not (eq last-command 'yank))
3364 (error "Previous command was not a yank"))
3365 (setq this-command 'yank)
3366 (unless arg (setq arg 1))
3367 (let ((inhibit-read-only t)
3368 (before (< (point) (mark t))))
3369 (if before
3370 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3371 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3372 (setq yank-undo-function nil)
3373 (set-marker (mark-marker) (point) (current-buffer))
3374 (insert-for-yank (current-kill arg))
3375 ;; Set the window start back where it was in the yank command,
3376 ;; if possible.
3377 (set-window-start (selected-window) yank-window-start t)
3378 (if before
3379 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3380 ;; It is cleaner to avoid activation, even though the command
3381 ;; loop would deactivate the mark because we inserted text.
3382 (goto-char (prog1 (mark t)
3383 (set-marker (mark-marker) (point) (current-buffer))))))
3384 nil)
3386 (defun yank (&optional arg)
3388 More precisely, reinsert the stretch of killed text most recently
3389 killed OR yanked. Put point at end, and set mark at beginning.
3390 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3391 With argument N, reinsert the Nth most recently killed stretch of killed
3392 text.
3394 When this command inserts killed text into the buffer, it honors
3395 `yank-excluded-properties' and `yank-handler' as described in the
3396 doc string for `insert-for-yank-1', which see.
3399 (interactive "*P")
3400 (setq yank-window-start (window-start))
3401 ;; If we don't get all the way thru, make last-command indicate that
3402 ;; for the following command.
3403 (setq this-command t)
3404 (push-mark (point))
3405 (insert-for-yank (current-kill (cond
3406 ((listp arg) 0)
3407 ((eq arg '-) -2)
3408 (t (1- arg)))))
3409 (if (consp arg)
3410 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3411 ;; It is cleaner to avoid activation, even though the command
3412 ;; loop would deactivate the mark because we inserted text.
3413 (goto-char (prog1 (mark t)
3414 (set-marker (mark-marker) (point) (current-buffer)))))
3415 ;; If we do get all the way thru, make this-command indicate that.
3416 (if (eq this-command t)
3417 (setq this-command 'yank))
3418 nil)
3420 (defun rotate-yank-pointer (arg)
3421 "Rotate the yanking point in the kill ring.
3422 With ARG, rotate that many kills forward (or backward, if negative)."
3423 (interactive "p")
3424 (current-kill arg))
3425 \f
3426 ;; Some kill commands.
3428 ;; Internal subroutine of delete-char
3429 (defun kill-forward-chars (arg)
3430 (if (listp arg) (setq arg (car arg)))
3431 (if (eq arg '-) (setq arg -1))
3432 (kill-region (point) (+ (point) arg)))
3434 ;; Internal subroutine of backward-delete-char
3435 (defun kill-backward-chars (arg)
3436 (if (listp arg) (setq arg (car arg)))
3437 (if (eq arg '-) (setq arg -1))
3438 (kill-region (point) (- (point) arg)))
3440 (defcustom backward-delete-char-untabify-method 'untabify
3441 "The method for untabifying when deleting backward.
3442 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3443 `hungry' -- delete all whitespace, both tabs and spaces;
3444 `all' -- delete all whitespace, including tabs, spaces and newlines;
3445 nil -- just delete one character."
3446 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3447 :version "20.3"
3448 :group 'killing)
3450 (defun backward-delete-char-untabify (arg &optional killp)
3451 "Delete characters backward, changing tabs into spaces.
3452 The exact behavior depends on `backward-delete-char-untabify-method'.
3453 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3454 Interactively, ARG is the prefix arg (default 1)
3455 and KILLP is t if a prefix arg was specified."
3457 (when (eq backward-delete-char-untabify-method 'untabify)
3458 (let ((count arg))
3459 (save-excursion
3460 (while (and (> count 0) (not (bobp)))
3462 (let ((col (current-column)))
3463 (forward-char -1)
3464 (setq col (- col (current-column)))
3465 (insert-char ?\s col)
3466 (delete-char 1)))
3467 (forward-char -1)
3468 (setq count (1- count))))))
3470 ((eq backward-delete-char-untabify-method 'all)
3472 (n (if skip
3473 (let* ((oldpt (point))
3474 (wh (- oldpt (save-excursion
3475 (skip-chars-backward skip)
3476 (constrain-to-field nil oldpt)))))
3477 (+ arg (if (zerop wh) 0 (1- wh))))
3478 arg)))
3479 ;; Avoid warning about delete-backward-char
3480 (with-no-warnings (delete-backward-char n killp))))
3482 (defun zap-to-char (arg char)
3483 "Kill up to and including ARGth occurrence of CHAR.
3484 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3485 Goes backward if ARG is negative; error if CHAR not found."
3487 ;; Avoid "obsolete" warnings for translation-table-for-input.
3488 (with-no-warnings
3489 (if (char-table-p translation-table-for-input)
3490 (setq char (or (aref translation-table-for-input char) char))))
3491 (kill-region (point) (progn
3492 (search-forward (char-to-string char) nil nil arg)
3493 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3494 (point))))
3496 ;; kill-line and its subroutines.
3498 (defcustom kill-whole-line nil
3499 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3500 :type 'boolean
3501 :group 'killing)
3503 (defun kill-line (&optional arg)
3504 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3505 With prefix argument ARG, kill that many lines from point.
3506 Negative arguments kill lines backward.
3507 With zero argument, kills the text before point on the current line.
3510 a number counts as a prefix arg.
3512 To kill a whole line, when point is not at the beginning, type \
3515 If `show-trailing-whitespace' is non-nil, this command will just
3516 kill the rest of the current line, even if there are only
3517 nonblanks there.
3519 If `kill-whole-line' is non-nil, then this command kills the whole line
3520 including its terminating newline, when used at the beginning of a line
3521 with no argument. As a consequence, you can always kill a whole line
3524 If you want to append the killed line to the last killed text,
3527 If the buffer is read-only, Emacs will beep and refrain from deleting
3528 the line, but put the line in the kill ring anyway. This means that
3529 you can use this command to copy text from a read-only buffer.
3530 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3531 even beep.)"
3532 (interactive "P")
3533 (kill-region (point)
3534 ;; It is better to move point to the other end of the kill
3535 ;; before killing. That way, in a read-only buffer, point
3536 ;; moves across the text that is copied to the kill ring.
3537 ;; The choice has no effect on undo now that undo records
3538 ;; the value of point from before the command was run.
3539 (progn
3540 (if arg
3541 (forward-visible-line (prefix-numeric-value arg))
3542 (if (eobp)
3543 (signal 'end-of-buffer nil))
3544 (let ((end
3545 (save-excursion
3546 (end-of-visible-line) (point))))
3547 (if (or (save-excursion
3548 ;; If trailing whitespace is visible,
3549 ;; don't treat it as nothing.
3550 (unless show-trailing-whitespace
3552 (= (point) end))
3553 (and kill-whole-line (bolp)))
3554 (forward-visible-line 1)
3555 (goto-char end))))
3556 (point))))
3558 (defun kill-whole-line (&optional arg)
3559 "Kill current line.
3560 With prefix ARG, kill that many lines starting from the current line.
3561 If ARG is negative, kill backward. Also kill the preceding newline.
3563 If ARG is zero, kill current line but exclude the trailing newline."
3564 (interactive "p")
3565 (or arg (setq arg 1))
3566 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3567 (signal 'end-of-buffer nil))
3568 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3569 (signal 'beginning-of-buffer nil))
3570 (unless (eq last-command 'kill-region)
3571 (kill-new "")
3572 (setq last-command 'kill-region))
3573 (cond ((zerop arg)
3574 ;; We need to kill in two steps, because the previous command
3575 ;; could have been a kill command, in which case the text
3576 ;; before point needs to be prepended to the current kill
3577 ;; ring entry and the text after point appended. Also, we
3578 ;; need to use save-excursion to avoid copying the same text
3579 ;; twice to the kill ring in read-only buffers.
3580 (save-excursion
3581 (kill-region (point) (progn (forward-visible-line 0) (point))))
3582 (kill-region (point) (progn (end-of-visible-line) (point))))
3583 ((< arg 0)
3584 (save-excursion
3585 (kill-region (point) (progn (end-of-visible-line) (point))))
3586 (kill-region (point)
3587 (progn (forward-visible-line (1+ arg))
3588 (unless (bobp) (backward-char))
3589 (point))))
3590 (t
3591 (save-excursion
3592 (kill-region (point) (progn (forward-visible-line 0) (point))))
3593 (kill-region (point)
3594 (progn (forward-visible-line arg) (point))))))
3596 (defun forward-visible-line (arg)
3597 "Move forward by ARG lines, ignoring currently invisible newlines only.
3598 If ARG is negative, move backward -ARG lines.
3599 If ARG is zero, move to the beginning of the current line."
3600 (condition-case nil
3601 (if (> arg 0)
3602 (progn
3603 (while (> arg 0)
3604 (or (zerop (forward-line 1))
3605 (signal 'end-of-buffer nil))
3606 ;; If the newline we just skipped is invisible,
3607 ;; don't count it.
3608 (let ((prop
3609 (get-char-property (1- (point)) 'invisible)))
3610 (if (if (eq buffer-invisibility-spec t)
3611 prop
3612 (or (memq prop buffer-invisibility-spec)
3613 (assq prop buffer-invisibility-spec)))
3614 (setq arg (1+ arg))))
3615 (setq arg (1- arg)))
3616 ;; If invisible text follows, and it is a number of complete lines,
3617 ;; skip it.
3618 (let ((opoint (point)))
3619 (while (and (not (eobp))
3620 (let ((prop
3621 (get-char-property (point) 'invisible)))
3622 (if (eq buffer-invisibility-spec t)
3623 prop
3624 (or (memq prop buffer-invisibility-spec)
3625 (assq prop buffer-invisibility-spec)))))
3626 (goto-char
3627 (if (get-text-property (point) 'invisible)
3628 (or (next-single-property-change (point) 'invisible)
3629 (point-max))
3630 (next-overlay-change (point)))))
3631 (unless (bolp)
3632 (goto-char opoint))))
3633 (let ((first t))
3634 (while (or first (<= arg 0))
3635 (if first
3636 (beginning-of-line)
3637 (or (zerop (forward-line -1))
3638 (signal 'beginning-of-buffer nil)))
3639 ;; If the newline we just moved to is invisible,
3640 ;; don't count it.
3641 (unless (bobp)
3642 (let ((prop
3643 (get-char-property (1- (point)) 'invisible)))
3644 (unless (if (eq buffer-invisibility-spec t)
3645 prop
3646 (or (memq prop buffer-invisibility-spec)
3647 (assq prop buffer-invisibility-spec)))
3648 (setq arg (1+ arg)))))
3649 (setq first nil))
3650 ;; If invisible text follows, and it is a number of complete lines,
3651 ;; skip it.
3652 (let ((opoint (point)))
3653 (while (and (not (bobp))
3654 (let ((prop
3655 (get-char-property (1- (point)) 'invisible)))
3656 (if (eq buffer-invisibility-spec t)
3657 prop
3658 (or (memq prop buffer-invisibility-spec)
3659 (assq prop buffer-invisibility-spec)))))
3660 (goto-char
3661 (if (get-text-property (1- (point)) 'invisible)
3662 (or (previous-single-property-change (point) 'invisible)
3663 (point-min))
3664 (previous-overlay-change (point)))))
3665 (unless (bolp)
3666 (goto-char opoint)))))
3667 ((beginning-of-buffer end-of-buffer)
3668 nil)))
3670 (defun end-of-visible-line ()
3671 "Move to end of current visible line."
3672 (end-of-line)
3673 ;; If the following character is currently invisible,
3674 ;; skip all characters with that same `invisible' property value,
3675 ;; then find the next newline.
3676 (while (and (not (eobp))
3677 (save-excursion
3679 (let ((prop
3680 (get-char-property (point) 'invisible)))
3681 (if (eq buffer-invisibility-spec t)
3682 prop
3683 (or (memq prop buffer-invisibility-spec)
3684 (assq prop buffer-invisibility-spec))))))
3686 (if (get-text-property (point) 'invisible)
3687 (goto-char (next-single-property-change (point) 'invisible))
3688 (goto-char (next-overlay-change (point))))
3689 (end-of-line)))
3690 \f
3691 (defun insert-buffer (buffer)
3692 "Insert after point the contents of BUFFER.
3693 Puts mark after the inserted text.
3694 BUFFER may be a buffer or a buffer name.
3696 This function is meant for the user to run interactively.
3697 Don't call it from programs: use `insert-buffer-substring' instead!"
3698 (interactive
3699 (list
3700 (progn
3701 (barf-if-buffer-read-only)
3702 (read-buffer "Insert buffer: "
3703 (if (eq (selected-window) (next-window (selected-window)))
3704 (other-buffer (current-buffer))
3705 (window-buffer (next-window (selected-window))))
3706 t))))
3707 (push-mark
3708 (save-excursion
3709 (insert-buffer-substring (get-buffer buffer))
3710 (point)))
3711 nil)
3713 (defun append-to-buffer (buffer start end)
3714 "Append to specified buffer the text of the region.
3715 It is inserted into that buffer before its point.
3717 When calling from a program, give three arguments:
3718 BUFFER (or buffer name), START and END.
3719 START and END specify the portion of the current buffer to be copied."
3720 (interactive
3721 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3722 (region-beginning) (region-end)))
3723 (let* ((oldbuf (current-buffer))
3724 (append-to (get-buffer-create buffer))
3725 (windows (get-buffer-window-list append-to t t))
3726 point)
3727 (save-excursion
3728 (with-current-buffer append-to
3729 (setq point (point))
3730 (barf-if-buffer-read-only)
3731 (insert-buffer-substring oldbuf start end)
3732 (dolist (window windows)
3733 (when (= (window-point window) point)
3734 (set-window-point window (point))))))))
3736 (defun prepend-to-buffer (buffer start end)
3737 "Prepend to specified buffer the text of the region.
3738 It is inserted into that buffer after its point.
3740 When calling from a program, give three arguments:
3741 BUFFER (or buffer name), START and END.
3742 START and END specify the portion of the current buffer to be copied."
3744 (let ((oldbuf (current-buffer)))
3745 (with-current-buffer (get-buffer-create buffer)
3746 (barf-if-buffer-read-only)
3747 (save-excursion
3748 (insert-buffer-substring oldbuf start end)))))
3750 (defun copy-to-buffer (buffer start end)
3751 "Copy to specified buffer the text of the region.
3752 It is inserted into that buffer, replacing existing text there.
3754 When calling from a program, give three arguments:
3755 BUFFER (or buffer name), START and END.
3756 START and END specify the portion of the current buffer to be copied."
3758 (let ((oldbuf (current-buffer)))
3759 (with-current-buffer (get-buffer-create buffer)
3760 (barf-if-buffer-read-only)
3761 (erase-buffer)
3762 (save-excursion
3763 (insert-buffer-substring oldbuf start end)))))
3764 \f
3765 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3766 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3768 (defvar activate-mark-hook nil
3769 "Hook run when the mark becomes active.
3770 It is also run at the end of a command, if the mark is active and
3771 it is possible that the region may have changed.")
3773 (defvar deactivate-mark-hook nil
3774 "Hook run when the mark becomes inactive.")
3776 (defun mark (&optional force)
3777 "Return this buffer's mark value as integer, or nil if never set.
3779 In Transient Mark mode, this function signals an error if
3780 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3781 or the argument FORCE is non-nil, it disregards whether the mark
3782 is active, and returns an integer or nil in the usual way.
3784 If you are using this in an editing command, you are most likely making
3785 a mistake; see the documentation of `set-mark'."
3786 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3787 (marker-position (mark-marker))
3788 (signal 'mark-inactive nil)))
3790 (defsubst deactivate-mark (&optional force)
3791 "Deactivate the mark.
3792 If Transient Mark mode is disabled, this function normally does
3793 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
3795 Deactivating the mark sets `mark-active' to nil, updates the
3796 primary selection according to `select-active-regions', and runs
3797 `deactivate-mark-hook'.
3799 If Transient Mark mode was temporarily enabled, reset the value
3800 of the variable `transient-mark-mode'; if this causes Transient
3801 Mark mode to be disabled, don't change `mark-active' to nil or
3802 run `deactivate-mark-hook'."
3803 (when (or transient-mark-mode force)
3804 (when (and (if (eq select-active-regions 'only)
3805 (eq (car-safe transient-mark-mode) 'only)
3806 select-active-regions)
3807 (region-active-p)
3808 (display-selections-p))
3809 ;; The var `saved-region-selection', if non-nil, is the text in
3810 ;; the region prior to the last command modifying the buffer.
3811 ;; Set the selection to that, or to the current region.
3812 (cond (saved-region-selection
3813 (x-set-selection 'PRIMARY saved-region-selection)
3814 (setq saved-region-selection nil))
3815 ((/= (region-beginning) (region-end))
3816 (x-set-selection 'PRIMARY
3817 (buffer-substring-no-properties
3818 (region-beginning)
3819 (region-end))))))
3820 (if (and (null force)
3821 (or (eq transient-mark-mode 'lambda)
3822 (and (eq (car-safe transient-mark-mode) 'only)
3823 (null (cdr transient-mark-mode)))))
3824 ;; When deactivating a temporary region, don't change
3825 ;; `mark-active' or run `deactivate-mark-hook'.
3826 (setq transient-mark-mode nil)
3827 (if (eq (car-safe transient-mark-mode) 'only)
3828 (setq transient-mark-mode (cdr transient-mark-mode)))
3829 (setq mark-active nil)
3830 (run-hooks 'deactivate-mark-hook))))
3832 (defun activate-mark ()
3833 "Activate the mark."
3834 (when (mark t)
3835 (setq mark-active t)
3836 (unless transient-mark-mode
3837 (setq transient-mark-mode 'lambda))))
3839 (defun set-mark (pos)
3840 "Set this buffer's mark to POS. Don't use this function!
3841 That is to say, don't use this function unless you want
3842 the user to see that the mark has moved, and you want the previous
3843 mark position to be lost.
3845 Normally, when a new mark is set, the old one should go on the stack.
3846 This is why most applications should use `push-mark', not `set-mark'.
3848 Novice Emacs Lisp programmers often try to use the mark for the wrong
3849 purposes. The mark saves a location for the user's convenience.
3850 Most editing commands should not alter the mark.
3851 To remember a location for internal use in the Lisp program,
3852 store it in a Lisp variable. Example:
3854 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3856 (if pos
3857 (progn
3858 (setq mark-active t)
3859 (run-hooks 'activate-mark-hook)
3860 (set-marker (mark-marker) pos (current-buffer)))
3861 ;; Normally we never clear mark-active except in Transient Mark mode.
3862 ;; But when we actually clear out the mark value too, we must
3863 ;; clear mark-active in any mode.
3864 (deactivate-mark t)
3865 (set-marker (mark-marker) nil)))
3867 (defcustom use-empty-active-region nil
3869 If nil, region-aware commands treat empty regions as inactive.
3870 If non-nil, region-aware commands treat the region as active as
3871 long as the mark is active, even if the region is empty.
3873 Region-aware commands are those that act on the region if it is
3874 active and Transient Mark mode is enabled, and on the text near
3875 point otherwise."
3876 :type 'boolean
3877 :version "23.1"
3878 :group 'editing-basics)
3880 (defun use-region-p ()
3881 "Return t if the region is active and it is appropriate to act on it.
3882 This is used by commands that act specially on the region under
3883 Transient Mark mode.
3885 The return value is t if Transient Mark mode is enabled and the
3886 mark is active; furthermore, if `use-empty-active-region' is nil,
3887 the region must not be empty. Otherwise, the return value is nil.
3889 For some commands, it may be appropriate to ignore the value of
3890 `use-empty-active-region'; in that case, use `region-active-p'."
3891 (and (region-active-p)
3892 (or use-empty-active-region (> (region-end) (region-beginning)))))
3894 (defun region-active-p ()
3895 "Return t if Transient Mark mode is enabled and the mark is active.
3897 Some commands act specially on the region when Transient Mark
3898 mode is enabled. Usually, such commands should use
3899 `use-region-p' instead of this function, because `use-region-p'
3900 also checks the value of `use-empty-active-region'."
3901 (and transient-mark-mode mark-active))
3903 (defvar mark-ring nil
3904 "The list of former marks of the current buffer, most recent first.")
3905 (make-variable-buffer-local 'mark-ring)
3906 (put 'mark-ring 'permanent-local t)
3908 (defcustom mark-ring-max 16
3909 "Maximum size of mark ring. Start discarding off end if gets this big."
3910 :type 'integer
3911 :group 'editing-basics)
3913 (defvar global-mark-ring nil
3914 "The list of saved global marks, most recent first.")
3916 (defcustom global-mark-ring-max 16
3917 "Maximum size of global mark ring. \
3918 Start discarding off end if gets this big."
3919 :type 'integer
3920 :group 'editing-basics)
3922 (defun pop-to-mark-command ()
3923 "Jump to mark, and pop a new position for mark off the ring.
3924 \(Does not affect global mark ring\)."
3925 (interactive)
3926 (if (null (mark t))
3927 (error "No mark set in this buffer")
3928 (if (= (point) (mark t))
3929 (message "Mark popped"))
3930 (goto-char (mark t))
3931 (pop-mark)))
3933 (defun push-mark-command (arg &optional nomsg)
3934 "Set mark at where point is.
3935 If no prefix ARG and mark is already set there, just activate it.
3936 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3937 (interactive "P")
3938 (let ((mark (marker-position (mark-marker))))
3939 (if (or arg (null mark) (/= mark (point)))
3940 (push-mark nil nomsg t)
3941 (setq mark-active t)
3942 (run-hooks 'activate-mark-hook)
3943 (unless nomsg
3944 (message "Mark activated")))))
3946 (defcustom set-mark-command-repeat-pop nil
3949 will pop the mark twice, and
3951 will pop the mark three times.
3955 :type 'boolean
3956 :group 'editing-basics)
3958 (defcustom set-mark-default-inactive nil
3959 "If non-nil, setting the mark does not activate it.
3961 behave the same whether or not `transient-mark-mode' is enabled."
3962 :type 'boolean
3963 :group 'editing-basics
3964 :version "23.1")
3966 (defun set-mark-command (arg)
3967 "Set the mark where point is, or jump to the mark.
3968 Setting the mark also alters the region, which is the text
3969 between point and mark; this is the closest equivalent in
3972 With no prefix argument, set the mark at point, and push the
3973 old mark position on local mark ring. Also push the old mark on
3974 global mark ring, if the previous mark was set in another buffer.
3976 When Transient Mark Mode is off, immediately repeating this
3977 command activates `transient-mark-mode' temporarily.
3980 jump to the mark, and set the mark from
3981 position popped off the local mark ring \(this does not affect the global
3983 mark ring \(see `pop-global-mark'\).
3985 If `set-mark-command-repeat-pop' is non-nil, repeating
3987 off the local (or global) mark ring and jumps there.
3990 argument, unconditionally set mark where point is, even if
3991 `set-mark-command-repeat-pop' is non-nil.
3993 Novice Emacs Lisp programmers often try to use the mark for the wrong
3994 purposes. See the documentation of `set-mark' for more information."
3995 (interactive "P")
3996 (cond ((eq transient-mark-mode 'lambda)
3997 (setq transient-mark-mode nil))
3998 ((eq (car-safe transient-mark-mode) 'only)
3999 (deactivate-mark)))
4000 (cond
4001 ((and (consp arg) (> (prefix-numeric-value arg) 4))
4002 (push-mark-command nil))
4003 ((not (eq this-command 'set-mark-command))
4004 (if arg
4005 (pop-to-mark-command)
4006 (push-mark-command t)))
4007 ((and set-mark-command-repeat-pop
4008 (eq last-command 'pop-to-mark-command))
4009 (setq this-command 'pop-to-mark-command)
4010 (pop-to-mark-command))
4011 ((and set-mark-command-repeat-pop
4012 (eq last-command 'pop-global-mark)
4013 (not arg))
4014 (setq this-command 'pop-global-mark)
4015 (pop-global-mark))
4016 (arg
4017 (setq this-command 'pop-to-mark-command)
4018 (pop-to-mark-command))
4019 ((eq last-command 'set-mark-command)
4020 (if (region-active-p)
4021 (progn
4022 (deactivate-mark)
4023 (message "Mark deactivated"))
4024 (activate-mark)
4025 (message "Mark activated")))
4026 (t
4027 (push-mark-command nil)
4028 (if set-mark-default-inactive (deactivate-mark)))))
4030 (defun push-mark (&optional location nomsg activate)
4031 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4032 If the last global mark pushed was not in the current buffer,
4033 also push LOCATION on the global mark ring.
4034 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4036 Novice Emacs Lisp programmers often try to use the mark for the wrong
4037 purposes. See the documentation of `set-mark' for more information.
4039 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4040 (unless (null (mark t))
4041 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
4042 (when (> (length mark-ring) mark-ring-max)
4043 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
4044 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
4045 (set-marker (mark-marker) (or location (point)) (current-buffer))
4046 ;; Now push the mark on the global mark ring.
4047 (if (and global-mark-ring
4048 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
4049 ;; The last global mark pushed was in this same buffer.
4050 ;; Don't push another one.
4051 nil
4052 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4053 (when (> (length global-mark-ring) global-mark-ring-max)
4054 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4055 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4056 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4057 (message "Mark set"))
4058 (if (or activate (not transient-mark-mode))
4059 (set-mark (mark t)))
4060 nil)
4062 (defun pop-mark ()
4063 "Pop off mark ring into the buffer's actual mark.
4064 Does not set point. Does nothing if mark ring is empty."
4065 (when mark-ring
4066 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4067 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4068 (move-marker (car mark-ring) nil)
4069 (if (null (mark t)) (ding))
4070 (setq mark-ring (cdr mark-ring)))
4071 (deactivate-mark))
4073 (define-obsolete-function-alias
4074 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4075 (defun exchange-point-and-mark (&optional arg)
4076 "Put the mark where point is now, and point where the mark is now.
4077 This command works even when the mark is not active,
4078 and it reactivates the mark.
4080 If Transient Mark mode is on, a prefix ARG deactivates the mark
4081 if it is active, and otherwise avoids reactivating it. If
4082 Transient Mark mode is off, a prefix ARG enables Transient Mark
4083 mode temporarily."
4084 (interactive "P")
4085 (let ((omark (mark t))
4086 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4087 (if (null omark)
4088 (error "No mark set in this buffer"))
4089 (deactivate-mark)
4090 (set-mark (point))
4091 (goto-char omark)
4092 (if set-mark-default-inactive (deactivate-mark))
4093 (cond (temp-highlight
4094 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4095 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4096 (not (or arg (region-active-p))))
4097 (deactivate-mark))
4098 (t (activate-mark)))
4099 nil))
4101 (defcustom shift-select-mode t
4102 "When non-nil, shifted motion keys activate the mark momentarily.
4104 While the mark is activated in this way, any shift-translated point
4105 motion key extends the region, and if Transient Mark mode was off, it
4106 is temporarily turned on. Furthermore, the mark will be deactivated
4107 by any subsequent point motion key that was not shift-translated, or
4108 by any action that normally deactivates the mark in Transient Mark mode.
4110 See `this-command-keys-shift-translated' for the meaning of
4111 shift-translation."
4112 :type 'boolean
4113 :group 'editing-basics)
4115 (defun handle-shift-selection ()
4116 "Activate/deactivate mark depending on invocation thru shift translation.
4117 This function is called by `call-interactively' when a command
4118 with a `^' character in its `interactive' spec is invoked, before
4119 running the command itself.
4121 If `shift-select-mode' is enabled and the command was invoked
4122 through shift translation, set the mark and activate the region
4123 temporarily, unless it was already set in this way. See
4124 `this-command-keys-shift-translated' for the meaning of shift
4125 translation.
4127 Otherwise, if the region has been activated temporarily,
4128 deactivate it, and restore the variable `transient-mark-mode' to
4129 its earlier value."
4130 (cond ((and shift-select-mode this-command-keys-shift-translated)
4131 (unless (and mark-active
4132 (eq (car-safe transient-mark-mode) 'only))
4133 (setq transient-mark-mode
4134 (cons 'only
4135 (unless (eq transient-mark-mode 'lambda)
4136 transient-mark-mode)))
4137 (push-mark nil nil t)))
4138 ((eq (car-safe transient-mark-mode) 'only)
4139 (setq transient-mark-mode (cdr transient-mark-mode))
4140 (deactivate-mark))))
4142 (define-minor-mode transient-mark-mode
4143 "Toggle Transient Mark mode.
4144 With a prefix argument ARG, enable Transient Mark mode if ARG is
4145 positive, and disable it otherwise. If called from Lisp, enable
4146 Transient Mark mode if ARG is omitted or nil.
4148 Transient Mark mode is a global minor mode. When enabled, the
4149 region is highlighted whenever the mark is active. The mark is
4151 operations that set the mark but whose main purpose is something
4157 Many commands change their behavior when Transient Mark mode is in effect
4158 and the mark is active, by acting on the region instead of their usual
4159 default part of the buffer's text. Examples of such commands include
4164 commands which are sensitive to the Transient Mark mode."
4165 :global t
4166 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4167 :variable transient-mark-mode)
4169 (defvar widen-automatically t
4170 "Non-nil means it is ok for commands to call `widen' when they want to.
4171 Some commands will do this in order to go to positions outside
4172 the current accessible part of the buffer.
4174 If `widen-automatically' is nil, these commands will do something else
4175 as a fallback, and won't change the buffer bounds.")
4177 (defvar non-essential nil
4178 "Whether the currently executing code is performing an essential task.
4179 This variable should be non-nil only when running code which should not
4180 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4181 user for a password when we are simply scanning a set of files in the
4182 background or displaying possible completions before the user even asked
4183 for it.")
4185 (defun pop-global-mark ()
4186 "Pop off global mark ring and jump to the top location."
4187 (interactive)
4188 ;; Pop entries which refer to non-existent buffers.
4189 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4190 (setq global-mark-ring (cdr global-mark-ring)))
4191 (or global-mark-ring
4192 (error "No global mark set"))
4193 (let* ((marker (car global-mark-ring))
4194 (buffer (marker-buffer marker))
4195 (position (marker-position marker)))
4196 (setq global-mark-ring (nconc (cdr global-mark-ring)
4197 (list (car global-mark-ring))))
4198 (set-buffer buffer)
4199 (or (and (>= position (point-min))
4200 (<= position (point-max)))
4201 (if widen-automatically
4202 (widen)
4203 (error "Global mark position is outside accessible part of buffer")))
4204 (goto-char position)
4205 (switch-to-buffer buffer)))
4206 \f
4207 (defcustom next-line-add-newlines nil
4208 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4209 :type 'boolean
4210 :version "21.1"
4211 :group 'editing-basics)
4213 (defun next-line (&optional arg try-vscroll)
4214 "Move cursor vertically down ARG lines.
4215 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4216 If there is no character in the target line exactly under the current column,
4217 the cursor is positioned after the character in that line which spans this
4218 column, or at the end of the line if it is not long enough.
4219 If there is no line in the buffer after this one, behavior depends on the
4220 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4221 to create a line, and moves the cursor to that line. Otherwise it moves the
4222 cursor to the end of the buffer.
4224 If the variable `line-move-visual' is non-nil, this command moves
4225 by display lines. Otherwise, it moves by buffer lines, without
4226 taking variable-width characters or continued lines into account.
4229 a semipermanent goal column for this command.
4230 Then instead of trying to move exactly vertically (or as close as possible),
4231 this command moves to the specified goal column (or as close as possible).
4232 The goal column is stored in the variable `goal-column', which is nil
4233 when there is no goal column. Note that setting `goal-column'
4234 overrides `line-move-visual' and causes this command to move by buffer
4235 lines rather than by display lines.
4237 If you are thinking of using this in a Lisp program, consider
4238 using `forward-line' instead. It is usually easier to use
4239 and more reliable (no dependence on goal column, etc.)."
4241 (or arg (setq arg 1))
4242 (if (and next-line-add-newlines (= arg 1))
4243 (if (save-excursion (end-of-line) (eobp))
4244 ;; When adding a newline, don't expand an abbrev.
4245 (let ((abbrev-mode nil))
4246 (end-of-line)
4248 (line-move arg nil nil try-vscroll))
4249 (if (called-interactively-p 'interactive)
4250 (condition-case err
4251 (line-move arg nil nil try-vscroll)
4252 ((beginning-of-buffer end-of-buffer)
4253 (signal (car err) (cdr err))))
4254 (line-move arg nil nil try-vscroll)))
4255 nil)
4257 (defun previous-line (&optional arg try-vscroll)
4258 "Move cursor vertically up ARG lines.
4259 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4260 If there is no character in the target line exactly over the current column,
4261 the cursor is positioned after the character in that line which spans this
4262 column, or at the end of the line if it is not long enough.
4264 If the variable `line-move-visual' is non-nil, this command moves
4265 by display lines. Otherwise, it moves by buffer lines, without
4266 taking variable-width characters or continued lines into account.
4269 a semipermanent goal column for this command.
4270 Then instead of trying to move exactly vertically (or as close as possible),
4271 this command moves to the specified goal column (or as close as possible).
4272 The goal column is stored in the variable `goal-column', which is nil
4273 when there is no goal column. Note that setting `goal-column'
4274 overrides `line-move-visual' and causes this command to move by buffer
4275 lines rather than by display lines.
4277 If you are thinking of using this in a Lisp program, consider using
4278 `forward-line' with a negative argument instead. It is usually easier
4279 to use and more reliable (no dependence on goal column, etc.)."
4281 (or arg (setq arg 1))
4282 (if (called-interactively-p 'interactive)
4283 (condition-case err
4284 (line-move (- arg) nil nil try-vscroll)
4285 ((beginning-of-buffer end-of-buffer)
4286 (signal (car err) (cdr err))))
4287 (line-move (- arg) nil nil try-vscroll))
4288 nil)
4290 (defcustom track-eol nil
4291 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4292 This means moving to the end of each line moved onto.
4293 The beginning of a blank line does not count as the end of a line.
4294 This has no effect when `line-move-visual' is non-nil."
4295 :type 'boolean
4296 :group 'editing-basics)
4298 (defcustom goal-column nil
4300 A non-nil setting overrides `line-move-visual', which see."
4301 :type '(choice integer
4302 (const :tag "None" nil))
4303 :group 'editing-basics)
4304 (make-variable-buffer-local 'goal-column)
4306 (defvar temporary-goal-column 0
4307 "Current goal column for vertical motion.
4308 It is the column where point was at the start of the current run
4309 of vertical motion commands.
4311 When moving by visual lines via `line-move-visual', it is a cons
4312 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4313 divided by the default column width, and HSCROLL is the number of
4314 columns by which window is scrolled from left margin.
4316 When the `track-eol' feature is doing its job, the value is
4317 `most-positive-fixnum'.")
4319 (defcustom line-move-ignore-invisible t
4321 Outline mode sets this."
4322 :type 'boolean
4323 :group 'editing-basics)
4325 (defcustom line-move-visual t
4326 "When non-nil, `line-move' moves point by visual lines.
4327 This movement is based on where the cursor is displayed on the
4328 screen, instead of relying on buffer contents alone. It takes
4329 into account variable-width characters and line continuation.
4330 If nil, `line-move' moves point by logical lines.
4331 A non-nil setting of `goal-column' overrides the value of this variable
4332 and forces movement by logical lines.
4333 A window that is horizontally scrolled also forces movement by logical
4334 lines."
4335 :type 'boolean
4336 :group 'editing-basics
4337 :version "23.1")
4339 ;; Returns non-nil if partial move was done.
4340 (defun line-move-partial (arg noerror to-end)
4341 (if (< arg 0)
4342 ;; Move backward (up).
4343 ;; If already vscrolled, reduce vscroll
4344 (let ((vs (window-vscroll nil t)))
4345 (when (> vs (frame-char-height))
4346 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4348 ;; Move forward (down).
4349 (let* ((lh (window-line-height -1))
4350 (vpos (nth 1 lh))
4351 (ypos (nth 2 lh))
4352 (rbot (nth 3 lh))
4353 py vs)
4354 (when (or (null lh)
4355 (>= rbot (frame-char-height))
4356 (<= ypos (- (frame-char-height))))
4357 (unless lh
4358 (let ((wend (pos-visible-in-window-p t nil t)))
4359 (setq rbot (nth 3 wend)
4360 vpos (nth 5 wend))))
4361 (cond
4362 ;; If last line of window is fully visible, move forward.
4363 ((or (null rbot) (= rbot 0))
4364 nil)
4365 ;; If cursor is not in the bottom scroll margin, move forward.
4366 ((and (> vpos 0)
4367 (< (setq py
4368 (or (nth 1 (window-line-height))
4369 (let ((ppos (posn-at-point)))
4370 (cdr (or (posn-actual-col-row ppos)
4371 (posn-col-row ppos))))))
4372 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4373 nil)
4374 ;; When already vscrolled, we vscroll some more if we can,
4375 ;; or clear vscroll and move forward at end of tall image.
4376 ((> (setq vs (window-vscroll nil t)) 0)
4377 (when (> rbot 0)
4378 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4379 ;; If cursor just entered the bottom scroll margin, move forward,
4380 ;; but also vscroll one line so redisplay won't recenter.
4381 ((and (> vpos 0)
4382 (= py (min (- (window-text-height) scroll-margin 1)
4383 (1- vpos))))
4384 (set-window-vscroll nil (frame-char-height) t)
4385 (line-move-1 arg noerror to-end)
4386 t)
4387 ;; If there are lines above the last line, scroll-up one line.
4388 ((> vpos 0)
4389 (scroll-up 1)
4390 t)
4391 ;; Finally, start vscroll.
4392 (t
4393 (set-window-vscroll nil (frame-char-height) t)))))))
4396 ;; This is like line-move-1 except that it also performs
4397 ;; vertical scrolling of tall images if appropriate.
4398 ;; That is not really a clean thing to do, since it mixes
4399 ;; scrolling with cursor motion. But so far we don't have
4400 ;; a cleaner solution to the problem of making C-n do something
4401 ;; useful given a tall image.
4402 (defun line-move (arg &optional noerror to-end try-vscroll)
4403 (unless (and auto-window-vscroll try-vscroll
4404 ;; Only vscroll for single line moves
4405 (= (abs arg) 1)
4406 ;; But don't vscroll in a keyboard macro.
4407 (not defining-kbd-macro)
4408 (not executing-kbd-macro)
4409 (line-move-partial arg noerror to-end))
4410 (set-window-vscroll nil 0 t)
4411 (if (and line-move-visual
4412 ;; Display-based column are incompatible with goal-column.
4413 (not goal-column)
4414 ;; When the text in the window is scrolled to the left,
4415 ;; display-based motion doesn't make sense (because each
4416 ;; logical line occupies exactly one screen line).
4417 (not (> (window-hscroll) 0)))
4418 (line-move-visual arg noerror)
4419 (line-move-1 arg noerror to-end))))
4421 ;; Display-based alternative to line-move-1.
4422 ;; Arg says how many lines to move. The value is t if we can move the
4423 ;; specified number of lines.
4424 (defun line-move-visual (arg &optional noerror)
4425 (let ((opoint (point))
4426 (hscroll (window-hscroll))
4427 target-hscroll)
4428 ;; Check if the previous command was a line-motion command, or if
4429 ;; we were called from some other command.
4430 (if (and (consp temporary-goal-column)
4431 (memq last-command `(next-line previous-line ,this-command)))
4432 ;; If so, there's no need to reset `temporary-goal-column',
4433 ;; but we may need to hscroll.
4434 (if (or (/= (cdr temporary-goal-column) hscroll)
4435 (> (cdr temporary-goal-column) 0))
4436 (setq target-hscroll (cdr temporary-goal-column)))
4437 ;; Otherwise, we should reset `temporary-goal-column'.
4438 (let ((posn (posn-at-point)))
4439 (cond
4440 ;; Handle the `overflow-newline-into-fringe' case:
4441 ((eq (nth 1 posn) 'right-fringe)
4442 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4443 ((car (posn-x-y posn))
4444 (setq temporary-goal-column
4445 (cons (/ (float (car (posn-x-y posn)))
4446 (frame-char-width)) hscroll))))))
4447 (if target-hscroll
4448 (set-window-hscroll (selected-window) target-hscroll))
4449 (or (and (= (vertical-motion
4450 (cons (or goal-column
4451 (if (consp temporary-goal-column)
4452 (car temporary-goal-column)
4453 temporary-goal-column))
4454 arg))
4455 arg)
4456 (or (>= arg 0)
4457 (/= (point) opoint)
4458 ;; If the goal column lies on a display string,
4459 ;; `vertical-motion' advances the cursor to the end
4460 ;; of the string. For arg < 0, this can cause the
4461 ;; cursor to get stuck. (Bug#3020).
4462 (= (vertical-motion arg) arg)))
4463 (unless noerror
4464 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4465 nil)))))
4467 ;; This is the guts of next-line and previous-line.
4468 ;; Arg says how many lines to move.
4469 ;; The value is t if we can move the specified number of lines.
4470 (defun line-move-1 (arg &optional noerror _to-end)
4471 ;; Don't run any point-motion hooks, and disregard intangibility,
4472 ;; for intermediate positions.
4473 (let ((inhibit-point-motion-hooks t)
4474 (opoint (point))
4475 (orig-arg arg))
4476 (if (consp temporary-goal-column)
4477 (setq temporary-goal-column (+ (car temporary-goal-column)
4478 (cdr temporary-goal-column))))
4479 (unwind-protect
4480 (progn
4481 (if (not (memq last-command '(next-line previous-line)))
4482 (setq temporary-goal-column
4483 (if (and track-eol (eolp)
4484 ;; Don't count beg of empty line as end of line
4485 ;; unless we just did explicit end-of-line.
4486 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4487 most-positive-fixnum
4488 (current-column))))
4490 (if (not (or (integerp selective-display)
4491 line-move-ignore-invisible))
4492 ;; Use just newline characters.
4493 ;; Set ARG to 0 if we move as many lines as requested.
4494 (or (if (> arg 0)
4495 (progn (if (> arg 1) (forward-line (1- arg)))
4496 ;; This way of moving forward ARG lines
4497 ;; verifies that we have a newline after the last one.
4498 ;; It doesn't get confused by intangible text.
4499 (end-of-line)
4500 (if (zerop (forward-line 1))
4501 (setq arg 0)))
4502 (and (zerop (forward-line arg))
4503 (bolp)
4504 (setq arg 0)))
4505 (unless noerror
4506 (signal (if (< arg 0)
4507 'beginning-of-buffer
4508 'end-of-buffer)
4509 nil)))
4510 ;; Move by arg lines, but ignore invisible ones.
4511 (let (done)
4512 (while (and (> arg 0) (not done))
4513 ;; If the following character is currently invisible,
4514 ;; skip all characters with that same `invisible' property value.
4515 (while (and (not (eobp)) (invisible-p (point)))
4516 (goto-char (next-char-property-change (point))))
4517 ;; Move a line.
4518 ;; We don't use `end-of-line', since we want to escape
4519 ;; from field boundaries occurring exactly at point.
4520 (goto-char (constrain-to-field
4521 (let ((inhibit-field-text-motion t))
4522 (line-end-position))
4523 (point) t t
4524 'inhibit-line-move-field-capture))
4525 ;; If there's no invisibility here, move over the newline.
4526 (cond
4527 ((eobp)
4528 (if (not noerror)
4529 (signal 'end-of-buffer nil)
4530 (setq done t)))
4531 ((and (> arg 1) ;; Use vertical-motion for last move
4532 (not (integerp selective-display))
4533 (not (invisible-p (point))))
4534 ;; We avoid vertical-motion when possible
4535 ;; because that has to fontify.
4536 (forward-line 1))
4537 ;; Otherwise move a more sophisticated way.
4538 ((zerop (vertical-motion 1))
4539 (if (not noerror)
4540 (signal 'end-of-buffer nil)
4541 (setq done t))))
4542 (unless done
4543 (setq arg (1- arg))))
4544 ;; The logic of this is the same as the loop above,
4545 ;; it just goes in the other direction.
4546 (while (and (< arg 0) (not done))
4547 ;; For completely consistency with the forward-motion
4548 ;; case, we should call beginning-of-line here.
4549 ;; However, if point is inside a field and on a
4550 ;; continued line, the call to (vertical-motion -1)
4551 ;; below won't move us back far enough; then we return
4552 ;; to the same column in line-move-finish, and point
4553 ;; gets stuck -- cyd
4554 (forward-line 0)
4555 (cond
4556 ((bobp)
4557 (if (not noerror)
4558 (signal 'beginning-of-buffer nil)
4559 (setq done t)))
4560 ((and (< arg -1) ;; Use vertical-motion for last move
4561 (not (integerp selective-display))
4562 (not (invisible-p (1- (point)))))
4563 (forward-line -1))
4564 ((zerop (vertical-motion -1))
4565 (if (not noerror)
4566 (signal 'beginning-of-buffer nil)
4567 (setq done t))))
4568 (unless done
4569 (setq arg (1+ arg))
4570 (while (and ;; Don't move over previous invis lines
4571 ;; if our target is the middle of this line.
4572 (or (zerop (or goal-column temporary-goal-column))
4573 (< arg 0))
4574 (not (bobp)) (invisible-p (1- (point))))
4575 (goto-char (previous-char-property-change (point))))))))
4576 ;; This is the value the function returns.
4577 (= arg 0))
4579 (cond ((> arg 0)
4580 ;; If we did not move down as far as desired, at least go
4581 ;; to end of line. Be sure to call point-entered and
4582 ;; point-left-hooks.
4583 (let* ((npoint (prog1 (line-end-position)
4584 (goto-char opoint)))
4585 (inhibit-point-motion-hooks nil))
4586 (goto-char npoint)))
4587 ((< arg 0)
4588 ;; If we did not move up as far as desired,
4589 ;; at least go to beginning of line.
4590 (let* ((npoint (prog1 (line-beginning-position)
4591 (goto-char opoint)))
4592 (inhibit-point-motion-hooks nil))
4593 (goto-char npoint)))
4594 (t
4595 (line-move-finish (or goal-column temporary-goal-column)
4596 opoint (> orig-arg 0)))))))
4598 (defun line-move-finish (column opoint forward)
4599 (let ((repeat t))
4600 (while repeat
4601 ;; Set REPEAT to t to repeat the whole thing.
4602 (setq repeat nil)
4604 (let (new
4605 (old (point))
4606 (line-beg (line-beginning-position))
4607 (line-end
4608 ;; Compute the end of the line
4609 ;; ignoring effectively invisible newlines.
4610 (save-excursion
4611 ;; Like end-of-line but ignores fields.
4613 (while (and (not (eobp)) (invisible-p (point)))
4614 (goto-char (next-char-property-change (point)))
4616 (point))))
4618 ;; Move to the desired column.
4619 (line-move-to-column (truncate column))
4621 ;; Corner case: suppose we start out in a field boundary in
4622 ;; the middle of a continued line. When we get to
4623 ;; line-move-finish, point is at the start of a new *screen*
4624 ;; line but the same text line; then line-move-to-column would
4625 ;; move us backwards. Test using C-n with point on the "x" in
4626 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4627 (and forward
4628 (< (point) old)
4629 (goto-char old))
4631 (setq new (point))
4633 ;; Process intangibility within a line.
4634 ;; With inhibit-point-motion-hooks bound to nil, a call to
4635 ;; goto-char moves point past intangible text.
4637 ;; However, inhibit-point-motion-hooks controls both the
4638 ;; intangibility and the point-entered/point-left hooks. The
4639 ;; following hack avoids calling the point-* hooks
4640 ;; unnecessarily. Note that we move *forward* past intangible
4641 ;; text when the initial and final points are the same.
4642 (goto-char new)
4643 (let ((inhibit-point-motion-hooks nil))
4644 (goto-char new)
4646 ;; If intangibility moves us to a different (later) place
4647 ;; in the same line, use that as the destination.
4648 (if (<= (point) line-end)
4649 (setq new (point))
4650 ;; If that position is "too late",
4651 ;; try the previous allowable position.
4652 ;; See if it is ok.
4653 (backward-char)
4654 (if (if forward
4655 ;; If going forward, don't accept the previous
4656 ;; allowable position if it is before the target line.
4657 (< line-beg (point))
4658 ;; If going backward, don't accept the previous
4659 ;; allowable position if it is still after the target line.
4660 (<= (point) line-end))
4661 (setq new (point))
4662 ;; As a last resort, use the end of the line.
4663 (setq new line-end))))
4665 ;; Now move to the updated destination, processing fields
4666 ;; as well as intangibility.
4667 (goto-char opoint)
4668 (let ((inhibit-point-motion-hooks nil))
4669 (goto-char
4670 ;; Ignore field boundaries if the initial and final
4671 ;; positions have the same `field' property, even if the
4672 ;; fields are non-contiguous. This seems to be "nicer"
4673 ;; behavior in many situations.
4674 (if (eq (get-char-property new 'field)
4675 (get-char-property opoint 'field))
4676 new
4677 (constrain-to-field new opoint t t
4678 'inhibit-line-move-field-capture))))
4680 ;; If all this moved us to a different line,
4681 ;; retry everything within that new line.
4682 (when (or (< (point) line-beg) (> (point) line-end))
4683 ;; Repeat the intangibility and field processing.
4684 (setq repeat t))))))
4686 (defun line-move-to-column (col)
4687 "Try to find column COL, considering invisibility.
4688 This function works only in certain cases,
4689 because what we really need is for `move-to-column'
4690 and `current-column' to be able to ignore invisible text."
4691 (if (zerop col)
4692 (beginning-of-line)
4693 (move-to-column col))
4695 (when (and line-move-ignore-invisible
4696 (not (bolp)) (invisible-p (1- (point))))
4697 (let ((normal-location (point))
4698 (normal-column (current-column)))
4699 ;; If the following character is currently invisible,
4700 ;; skip all characters with that same `invisible' property value.
4701 (while (and (not (eobp))
4702 (invisible-p (point)))
4703 (goto-char (next-char-property-change (point))))
4704 ;; Have we advanced to a larger column position?
4705 (if (> (current-column) normal-column)
4706 ;; We have made some progress towards the desired column.
4707 ;; See if we can make any further progress.
4708 (line-move-to-column (+ (current-column) (- col normal-column)))
4709 ;; Otherwise, go to the place we originally found
4710 ;; and move back over invisible text.
4711 ;; that will get us to the same place on the screen
4712 ;; but with a more reasonable buffer position.
4713 (goto-char normal-location)
4714 (let ((line-beg (line-beginning-position)))
4715 (while (and (not (bolp)) (invisible-p (1- (point))))
4716 (goto-char (previous-char-property-change (point) line-beg))))))))
4718 (defun move-end-of-line (arg)
4719 "Move point to end of current line as displayed.
4720 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4721 If point reaches the beginning or end of buffer, it stops there.
4723 To ignore the effects of the `intangible' text or overlay
4724 property, bind `inhibit-point-motion-hooks' to t.
4725 If there is an image in the current line, this function
4726 disregards newlines that are part of the text on which the image
4727 rests."
4728 (interactive "^p")
4729 (or arg (setq arg 1))
4730 (let (done)
4731 (while (not done)
4732 (let ((newpos
4733 (save-excursion
4734 (let ((goal-column 0)
4735 (line-move-visual nil))
4736 (and (line-move arg t)
4737 ;; With bidi reordering, we may not be at bol,
4738 ;; so make sure we are.
4740 (not (bobp))
4741 (progn
4742 (while (and (not (bobp)) (invisible-p (1- (point))))
4743 (goto-char (previous-single-char-property-change
4744 (point) 'invisible)))
4745 (backward-char 1)))
4746 (point)))))
4747 (goto-char newpos)
4748 (if (and (> (point) newpos)
4750 (backward-char 1)
4751 (if (and (> (point) newpos) (not (eobp))
4753 ;; If we skipped something intangible and now we're not
4754 ;; really at eol, keep going.
4755 (setq arg 1)
4756 (setq done t)))))))
4758 (defun move-beginning-of-line (arg)
4759 "Move point to beginning of current line as displayed.
4760 \(If there's an image in the line, this disregards newlines
4761 which are part of the text that the image rests on.)
4763 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4764 If point reaches the beginning or end of buffer, it stops there.
4765 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4766 (interactive "^p")
4767 (or arg (setq arg 1))
4769 (let ((orig (point))
4770 first-vis first-vis-field-value)
4772 ;; Move by lines, if ARG is not 1 (the default).
4773 (if (/= arg 1)
4774 (let ((line-move-visual nil))
4775 (line-move (1- arg) t)))
4777 ;; Move to beginning-of-line, ignoring fields and invisible text.
4779 (while (and (not (bobp)) (invisible-p (1- (point))))
4780 (goto-char (previous-char-property-change (point)))
4783 ;; Now find first visible char in the line
4784 (while (and (not (eobp)) (invisible-p (point)))
4785 (goto-char (next-char-property-change (point))))
4786 (setq first-vis (point))
4788 ;; See if fields would stop us from reaching FIRST-VIS.
4789 (setq first-vis-field-value
4790 (constrain-to-field first-vis orig (/= arg 1) t nil))
4792 (goto-char (if (/= first-vis-field-value first-vis)
4793 ;; If yes, obey them.
4794 first-vis-field-value
4795 ;; Otherwise, move to START with attention to fields.
4796 ;; (It is possible that fields never matter in this case.)
4797 (constrain-to-field (point) orig
4798 (/= arg 1) t nil)))))
4801 ;; Many people have said they rarely use this feature, and often type
4802 ;; it by accident. Maybe it shouldn't even be on a key.
4803 (put 'set-goal-column 'disabled t)
4805 (defun set-goal-column (arg)
4807 Those commands will move to this position in the line moved to
4808 rather than trying to keep the same horizontal position.
4809 With a non-nil argument ARG, clears out the goal column
4811 The goal column is stored in the variable `goal-column'."
4812 (interactive "P")
4813 (if arg
4814 (progn
4815 (setq goal-column nil)
4816 (message "No goal column"))
4817 (setq goal-column (current-column))
4818 ;; The older method below can be erroneous if `set-goal-column' is bound
4819 ;; to a sequence containing %
4820 ;;(message (substitute-command-keys
4822 ;;goal-column)
4823 (message "%s"
4824 (concat
4825 (format "Goal column %d " goal-column)
4826 (substitute-command-keys
4829 )
4830 nil)
4831 \f
4832 ;;; Editing based on visual lines, as opposed to logical lines.
4834 (defun end-of-visual-line (&optional n)
4835 "Move point to end of current visual line.
4836 With argument N not nil or 1, move forward N - 1 visual lines first.
4837 If point reaches the beginning or end of buffer, it stops there.
4838 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4839 (interactive "^p")
4840 (or n (setq n 1))
4841 (if (/= n 1)
4842 (let ((line-move-visual t))
4843 (line-move (1- n) t)))
4844 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4845 ;; constrain to field boundaries, so we don't either.
4846 (vertical-motion (cons (window-width) 0)))
4848 (defun beginning-of-visual-line (&optional n)
4849 "Move point to beginning of current visual line.
4850 With argument N not nil or 1, move forward N - 1 visual lines first.
4851 If point reaches the beginning or end of buffer, it stops there.
4852 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4853 (interactive "^p")
4854 (or n (setq n 1))
4855 (let ((opoint (point)))
4856 (if (/= n 1)
4857 (let ((line-move-visual t))
4858 (line-move (1- n) t)))
4859 (vertical-motion 0)
4860 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4861 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4863 (defun kill-visual-line (&optional arg)
4864 "Kill the rest of the visual line.
4865 With prefix argument ARG, kill that many visual lines from point.
4866 If ARG is negative, kill visual lines backward.
4867 If ARG is zero, kill the text before point on the current visual
4868 line.
4870 If you want to append the killed line to the last killed text,
4873 If the buffer is read-only, Emacs will beep and refrain from deleting
4874 the line, but put the line in the kill ring anyway. This means that
4875 you can use this command to copy text from a read-only buffer.
4876 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4877 even beep.)"
4878 (interactive "P")
4879 ;; Like in `kill-line', it's better to move point to the other end
4880 ;; of the kill before killing.
4881 (let ((opoint (point))
4882 (kill-whole-line (and kill-whole-line (bolp))))
4883 (if arg
4884 (vertical-motion (prefix-numeric-value arg))
4885 (end-of-visual-line 1)
4886 (if (= (point) opoint)
4887 (vertical-motion 1)
4888 ;; Skip any trailing whitespace at the end of the visual line.
4889 ;; We used to do this only if `show-trailing-whitespace' is
4890 ;; nil, but that's wrong; the correct thing would be to check
4891 ;; whether the trailing whitespace is highlighted. But, it's
4892 ;; OK to just do this unconditionally.
4895 (1+ (point))
4896 (point)))))
4898 (defun next-logical-line (&optional arg try-vscroll)
4899 "Move cursor vertically down ARG lines.
4900 This is identical to `next-line', except that it always moves
4901 by logical lines instead of visual lines, ignoring the value of
4902 the variable `line-move-visual'."
4904 (let ((line-move-visual nil))
4905 (with-no-warnings
4906 (next-line arg try-vscroll))))
4908 (defun previous-logical-line (&optional arg try-vscroll)
4909 "Move cursor vertically up ARG lines.
4910 This is identical to `previous-line', except that it always moves
4911 by logical lines instead of visual lines, ignoring the value of
4912 the variable `line-move-visual'."
4914 (let ((line-move-visual nil))
4915 (with-no-warnings
4916 (previous-line arg try-vscroll))))
4918 (defgroup visual-line nil
4919 "Editing based on visual lines."
4920 :group 'convenience
4921 :version "23.1")
4923 (defvar visual-line-mode-map
4924 (let ((map (make-sparse-keymap)))
4925 (define-key map [remap kill-line] 'kill-visual-line)
4926 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4927 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4928 ;; These keybindings interfere with xterm function keys. Are
4929 ;; there any other suitable bindings?
4930 ;; (define-key map "\M-[" 'previous-logical-line)
4931 ;; (define-key map "\M-]" 'next-logical-line)
4932 map))
4934 (defcustom visual-line-fringe-indicators '(nil nil)
4935 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4936 The value should be a list of the form (LEFT RIGHT), where LEFT
4937 and RIGHT are symbols representing the bitmaps to display, to
4938 indicate wrapped lines, in the left and right fringes respectively.
4939 See also `fringe-indicator-alist'.
4940 The default is not to display fringe indicators for wrapped lines.
4941 This variable does not affect fringe indicators displayed for
4942 other purposes."
4943 :type '(list (choice (const :tag "Hide left indicator" nil)
4944 (const :tag "Left curly arrow" left-curly-arrow)
4945 (symbol :tag "Other bitmap"))
4946 (choice (const :tag "Hide right indicator" nil)
4947 (const :tag "Right curly arrow" right-curly-arrow)
4948 (symbol :tag "Other bitmap")))
4949 :set (lambda (symbol value)
4950 (dolist (buf (buffer-list))
4951 (with-current-buffer buf
4952 (when (and (boundp 'visual-line-mode)
4953 (symbol-value 'visual-line-mode))
4954 (setq fringe-indicator-alist
4955 (cons (cons 'continuation value)
4956 (assq-delete-all
4957 'continuation
4958 (copy-tree fringe-indicator-alist)))))))
4959 (set-default symbol value)))
4961 (defvar visual-line--saved-state nil)
4963 (define-minor-mode visual-line-mode
4964 "Toggle visual line based editing (Visual Line mode).
4965 With a prefix argument ARG, enable Visual Line mode if ARG is
4966 positive, and disable it otherwise. If called from Lisp, enable
4967 the mode if ARG is omitted or nil.
4969 When Visual Line mode is enabled, `word-wrap' is turned on in
4970 this buffer, and simple editing commands are redefined to act on
4971 visual lines, not logical lines. See Info node `Visual Line
4972 Mode' for details."
4973 :keymap visual-line-mode-map
4974 :group 'visual-line
4975 :lighter " Wrap"
4976 (if visual-line-mode
4977 (progn
4978 (set (make-local-variable 'visual-line--saved-state) nil)
4979 ;; Save the local values of some variables, to be restored if
4980 ;; visual-line-mode is turned off.
4981 (dolist (var '(line-move-visual truncate-lines
4982 truncate-partial-width-windows
4983 word-wrap fringe-indicator-alist))
4984 (if (local-variable-p var)
4985 (push (cons var (symbol-value var))
4986 visual-line--saved-state)))
4987 (set (make-local-variable 'line-move-visual) t)
4988 (set (make-local-variable 'truncate-partial-width-windows) nil)
4989 (setq truncate-lines nil
4990 word-wrap t
4991 fringe-indicator-alist
4992 (cons (cons 'continuation visual-line-fringe-indicators)
4993 fringe-indicator-alist)))
4994 (kill-local-variable 'line-move-visual)
4995 (kill-local-variable 'word-wrap)
4996 (kill-local-variable 'truncate-lines)
4997 (kill-local-variable 'truncate-partial-width-windows)
4998 (kill-local-variable 'fringe-indicator-alist)
4999 (dolist (saved visual-line--saved-state)
5000 (set (make-local-variable (car saved)) (cdr saved)))
5001 (kill-local-variable 'visual-line--saved-state)))
5003 (defun turn-on-visual-line-mode ()
5004 (visual-line-mode 1))
5006 (define-globalized-minor-mode global-visual-line-mode
5007 visual-line-mode turn-on-visual-line-mode
5008 :lighter " vl")
5010 \f
5011 (defun transpose-chars (arg)
5012 "Interchange characters around point, moving forward one character.
5013 With prefix arg ARG, effect is to take character before point
5014 and drag it forward past ARG other characters (backward if ARG negative).
5015 If no argument and at end of line, the previous two chars are exchanged."
5016 (interactive "*P")
5017 (and (null arg) (eolp) (forward-char -1))
5018 (transpose-subr 'forward-char (prefix-numeric-value arg)))
5020 (defun transpose-words (arg)
5021 "Interchange words around point, leaving point at end of them.
5022 With prefix arg ARG, effect is to take word before or around point
5023 and drag it forward past ARG other words (backward if ARG negative).
5024 If ARG is zero, the words around or after point and around or after mark
5025 are interchanged."
5026 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5027 (interactive "*p")
5028 (transpose-subr 'forward-word arg))
5030 (defun transpose-sexps (arg)
5032 Does not work on a sexp that point is in the middle of
5033 if it is a list or string."
5034 (interactive "*p")
5035 (transpose-subr
5036 (lambda (arg)
5037 ;; Here we should try to simulate the behavior of
5038 ;; (cons (progn (forward-sexp x) (point))
5039 ;; (progn (forward-sexp (- x)) (point)))
5040 ;; Except that we don't want to rely on the second forward-sexp
5041 ;; putting us back to where we want to be, since forward-sexp-function
5042 ;; might do funny things like infix-precedence.
5043 (if (if (> arg 0)
5045 (and (not (bobp))
5047 ;; Jumping over a symbol. We might be inside it, mind you.
5048 (progn (funcall (if (> arg 0)
5049 'skip-syntax-backward 'skip-syntax-forward)
5050 "w_")
5051 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5052 ;; Otherwise, we're between sexps. Take a step back before jumping
5053 ;; to make sure we'll obey the same precedence no matter which direction
5054 ;; we're going.
5055 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5056 (cons (save-excursion (forward-sexp arg) (point))
5057 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5058 (not (zerop (funcall (if (> arg 0)
5059 'skip-syntax-forward
5060 'skip-syntax-backward)
5061 ".")))))
5062 (point)))))
5063 arg 'special))
5065 (defun transpose-lines (arg)
5066 "Exchange current line and previous line, leaving point after both.
5067 With argument ARG, takes previous line and moves it past ARG lines.
5068 With argument 0, interchanges line point is in with line mark is in."
5069 (interactive "*p")
5070 (transpose-subr (function
5071 (lambda (arg)
5072 (if (> arg 0)
5073 (progn
5074 ;; Move forward over ARG lines,
5075 ;; but create newlines if necessary.
5076 (setq arg (forward-line arg))
5078 (setq arg (1+ arg)))
5079 (if (> arg 0)
5080 (newline arg)))
5081 (forward-line arg))))
5082 arg))
5084 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5085 ;; which seems inconsistent with the ARG /= 0 case.
5086 ;; FIXME document SPECIAL.
5087 (defun transpose-subr (mover arg &optional special)
5088 "Subroutine to do the work of transposing objects.
5089 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5090 moves forward by units of the given object (e.g. forward-sentence,
5091 forward-paragraph). If ARG is zero, exchanges the current object
5092 with the one containing mark. If ARG is an integer, moves the
5093 current object past ARG following (if ARG is positive) or
5094 preceding (if ARG is negative) objects, leaving point after the
5095 current object."
5096 (let ((aux (if special mover
5097 (lambda (x)
5098 (cons (progn (funcall mover x) (point))
5099 (progn (funcall mover (- x)) (point))))))
5100 pos1 pos2)
5101 (cond
5102 ((= arg 0)
5103 (save-excursion
5104 (setq pos1 (funcall aux 1))
5105 (goto-char (or (mark) (error "No mark set in this buffer")))
5106 (setq pos2 (funcall aux 1))
5107 (transpose-subr-1 pos1 pos2))
5108 (exchange-point-and-mark))
5109 ((> arg 0)
5110 (setq pos1 (funcall aux -1))
5111 (setq pos2 (funcall aux arg))
5112 (transpose-subr-1 pos1 pos2)
5113 (goto-char (car pos2)))
5114 (t
5115 (setq pos1 (funcall aux -1))
5116 (goto-char (car pos1))
5117 (setq pos2 (funcall aux arg))
5118 (transpose-subr-1 pos1 pos2)))))
5120 (defun transpose-subr-1 (pos1 pos2)
5121 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5122 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5123 (when (> (car pos1) (car pos2))
5124 (let ((swap pos1))
5125 (setq pos1 pos2 pos2 swap)))
5126 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5127 (atomic-change-group
5128 (let (word2)
5129 ;; FIXME: We first delete the two pieces of text, so markers that
5130 ;; used to point to after the text end up pointing to before it :-(
5131 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5132 (goto-char (car pos2))
5133 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5134 (goto-char (car pos1))
5135 (insert word2))))
5136 \f
5137 (defun backward-word (&optional arg)
5138 "Move backward until encountering the beginning of a word.
5139 With argument ARG, do this that many times."
5140 (interactive "^p")
5141 (forward-word (- (or arg 1))))
5143 (defun mark-word (&optional arg allow-extend)
5144 "Set mark ARG words away from point.
5146 move to with the same argument.
5147 Interactively, if this command is repeated
5148 or (in Transient Mark mode) if the mark is active,
5149 it marks the next ARG words after the ones already marked."
5151 (cond ((and allow-extend
5152 (or (and (eq last-command this-command) (mark t))
5153 (region-active-p)))
5154 (setq arg (if arg (prefix-numeric-value arg)
5155 (if (< (mark) (point)) -1 1)))
5156 (set-mark
5157 (save-excursion
5158 (goto-char (mark))
5159 (forward-word arg)
5160 (point))))
5161 (t
5162 (push-mark
5163 (save-excursion
5164 (forward-word (prefix-numeric-value arg))
5165 (point))
5166 nil t))))
5168 (defun kill-word (arg)
5169 "Kill characters forward until encountering the end of a word.
5170 With argument ARG, do this that many times."
5171 (interactive "p")
5172 (kill-region (point) (progn (forward-word arg) (point))))
5174 (defun backward-kill-word (arg)
5175 "Kill characters backward until encountering the beginning of a word.
5176 With argument ARG, do this that many times."
5177 (interactive "p")
5178 (kill-word (- arg)))
5180 (defun current-word (&optional strict really-word)
5181 "Return the symbol or word that point is on (or a nearby one) as a string.
5182 The return value includes no text properties.
5183 If optional arg STRICT is non-nil, return nil unless point is within
5184 or adjacent to a symbol or word. In all cases the value can be nil
5185 if there is no word nearby.
5186 The function, belying its name, normally finds a symbol.
5187 If optional arg REALLY-WORD is non-nil, it finds just a word."
5188 (save-excursion
5189 (let* ((oldpoint (point)) (start (point)) (end (point))
5190 (syntaxes (if really-word "w" "w_"))
5191 (not-syntaxes (concat "^" syntaxes)))
5192 (skip-syntax-backward syntaxes) (setq start (point))
5193 (goto-char oldpoint)
5194 (skip-syntax-forward syntaxes) (setq end (point))
5195 (when (and (eq start oldpoint) (eq end oldpoint)
5196 ;; Point is neither within nor adjacent to a word.
5197 (not strict))
5198 ;; Look for preceding word in same line.
5199 (skip-syntax-backward not-syntaxes (line-beginning-position))
5200 (if (bolp)
5201 ;; No preceding word in same line.
5202 ;; Look for following word in same line.
5203 (progn
5204 (skip-syntax-forward not-syntaxes (line-end-position))
5205 (setq start (point))
5206 (skip-syntax-forward syntaxes)
5207 (setq end (point)))
5208 (setq end (point))
5209 (skip-syntax-backward syntaxes)
5210 (setq start (point))))
5211 ;; If we found something nonempty, return it as a string.
5212 (unless (= start end)
5213 (buffer-substring-no-properties start end)))))
5214 \f
5215 (defcustom fill-prefix nil
5216 "String for filling to insert at front of new line, or nil for none."
5217 :type '(choice (const :tag "None" nil)
5218 string)
5219 :group 'fill)
5220 (make-variable-buffer-local 'fill-prefix)
5221 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5223 (defcustom auto-fill-inhibit-regexp nil
5224 "Regexp to match lines which should not be auto-filled."
5225 :type '(choice (const :tag "None" nil)
5226 regexp)
5227 :group 'fill)
5229 (defun do-auto-fill ()
5230 "The default value for `normal-auto-fill-function'.
5231 This is the default auto-fill function, some major modes use a different one.
5232 Returns t if it really did any work."
5233 (let (fc justify give-up
5234 (fill-prefix fill-prefix))
5235 (if (or (not (setq justify (current-justification)))
5236 (null (setq fc (current-fill-column)))
5237 (and (eq justify 'left)
5238 (<= (current-column) fc))
5239 (and auto-fill-inhibit-regexp
5240 (save-excursion (beginning-of-line)
5241 (looking-at auto-fill-inhibit-regexp))))
5242 nil ;; Auto-filling not required
5243 (if (memq justify '(full center right))
5244 (save-excursion (unjustify-current-line)))
5246 ;; Choose a fill-prefix automatically.
5247 (when (and adaptive-fill-mode
5248 (or (null fill-prefix) (string= fill-prefix "")))
5249 (let ((prefix
5250 (fill-context-prefix
5251 (save-excursion (fill-forward-paragraph -1) (point))
5252 (save-excursion (fill-forward-paragraph 1) (point)))))
5253 (and prefix (not (equal prefix ""))
5254 ;; Use auto-indentation rather than a guessed empty prefix.
5255 (not (and fill-indent-according-to-mode
5257 (setq fill-prefix prefix))))
5259 (while (and (not give-up) (> (current-column) fc))
5260 ;; Determine where to split the line.
5261 (let* (after-prefix
5262 (fill-point
5263 (save-excursion
5264 (beginning-of-line)
5265 (setq after-prefix (point))
5266 (and fill-prefix
5267 (looking-at (regexp-quote fill-prefix))
5268 (setq after-prefix (match-end 0)))
5269 (move-to-column (1+ fc))
5270 (fill-move-to-break-point after-prefix)
5271 (point))))
5273 ;; See whether the place we found is any good.
5274 (if (save-excursion
5275 (goto-char fill-point)
5276 (or (bolp)
5277 ;; There is no use breaking at end of line.
5278 (save-excursion (skip-chars-forward " ") (eolp))
5279 ;; It is futile to split at the end of the prefix
5280 ;; since we would just insert the prefix again.
5281 (and after-prefix (<= (point) after-prefix))
5282 ;; Don't split right after a comment starter
5283 ;; since we would just make another comment starter.
5284 (and comment-start-skip
5285 (let ((limit (point)))
5286 (beginning-of-line)
5287 (and (re-search-forward comment-start-skip
5288 limit t)
5289 (eq (point) limit))))))
5290 ;; No good place to break => stop trying.
5291 (setq give-up t)
5292 ;; Ok, we have a useful place to break the line. Do it.
5293 (let ((prev-column (current-column)))
5294 ;; If point is at the fill-point, do not `save-excursion'.
5295 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5296 ;; point will end up before it rather than after it.
5297 (if (save-excursion
5299 (= (point) fill-point))
5300 (default-indent-new-line t)
5301 (save-excursion
5302 (goto-char fill-point)
5303 (default-indent-new-line t)))
5304 ;; Now do justification, if required
5305 (if (not (eq justify 'left))
5306 (save-excursion
5307 (end-of-line 0)
5308 (justify-current-line justify nil t)))
5309 ;; If making the new line didn't reduce the hpos of
5310 ;; the end of the line, then give up now;
5311 ;; trying again will not help.
5312 (if (>= (current-column) prev-column)
5313 (setq give-up t))))))
5314 ;; Justify last line.
5315 (justify-current-line justify t t)
5316 t)))
5318 (defvar comment-line-break-function 'comment-indent-new-line
5319 "*Mode-specific function which line breaks and continues a comment.
5320 This function is called during auto-filling when a comment syntax
5321 is defined.
5322 The function should take a single optional argument, which is a flag
5323 indicating whether it should use soft newlines.")
5325 (defun default-indent-new-line (&optional soft)
5326 "Break line at point and indent.
5327 If a comment syntax is defined, call `comment-indent-new-line'.
5329 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5330 unless optional argument SOFT is non-nil."
5331 (interactive)
5332 (if comment-start
5333 (funcall comment-line-break-function soft)
5334 ;; Insert the newline before removing empty space so that markers
5335 ;; get preserved better.
5337 (save-excursion (forward-char -1) (delete-horizontal-space))
5338 (delete-horizontal-space)
5340 (if (and fill-prefix (not adaptive-fill-mode))
5341 ;; Blindly trust a non-adaptive fill-prefix.
5342 (progn
5343 (indent-to-left-margin)
5344 (insert-before-markers-and-inherit fill-prefix))
5346 (cond
5347 ;; If there's an adaptive prefix, use it unless we're inside
5348 ;; a comment and the prefix is not a comment starter.
5349 (fill-prefix
5350 (indent-to-left-margin)
5351 (insert-and-inherit fill-prefix))
5352 ;; If we're not inside a comment, just try to indent.
5353 (t (indent-according-to-mode))))))
5355 (defvar normal-auto-fill-function 'do-auto-fill
5356 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5357 Some major modes set this.")
5359 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5360 ;; `functions' and `hooks' are usually unsafe to set, but setting
5361 ;; auto-fill-function to nil in a file-local setting is safe and
5362 ;; can be useful to prevent auto-filling.
5363 (put 'auto-fill-function 'safe-local-variable 'null)
5365 (define-minor-mode auto-fill-mode
5366 "Toggle automatic line breaking (Auto Fill mode).
5367 With a prefix argument ARG, enable Auto Fill mode if ARG is
5368 positive, and disable it otherwise. If called from Lisp, enable
5369 the mode if ARG is omitted or nil.
5371 When Auto Fill mode is enabled, inserting a space at a column
5372 beyond `current-fill-column' automatically breaks the line at a
5373 previous space.
5375 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5376 non-`nil'.
5378 The value of `normal-auto-fill-function' specifies the function to use
5379 for `auto-fill-function' when turning Auto Fill mode on."
5380 :variable (eq auto-fill-function normal-auto-fill-function))
5382 ;; This holds a document string used to document auto-fill-mode.
5383 (defun auto-fill-function ()
5384 "Automatically break line at a previous space, in insertion of text."
5385 nil)
5387 (defun turn-on-auto-fill ()
5388 "Unconditionally turn on Auto Fill mode."
5389 (auto-fill-mode 1))
5391 (defun turn-off-auto-fill ()
5392 "Unconditionally turn off Auto Fill mode."
5393 (auto-fill-mode -1))
5395 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5397 (defun set-fill-column (arg)
5398 "Set `fill-column' to specified argument.
5401 (interactive
5402 (list (or current-prefix-arg
5403 ;; We used to use current-column silently, but C-x f is too easily
5404 ;; typed as a typo for C-x C-f, so we turned it into an error and
5405 ;; now an interactive prompt.
5406 (read-number "Set fill-column to: " (current-column)))))
5407 (if (consp arg)
5408 (setq arg (current-column)))
5409 (if (not (integerp arg))
5410 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5411 (error "set-fill-column requires an explicit argument")
5412 (message "Fill column set to %d (was %d)" arg fill-column)
5413 (setq fill-column arg)))
5414 \f
5415 (defun set-selective-display (arg)
5416 "Set `selective-display' to ARG; clear it if no arg.
5417 When the value of `selective-display' is a number > 0,
5418 lines whose indentation is >= that value are not displayed.
5419 The variable `selective-display' has a separate value for each buffer."
5420 (interactive "P")
5421 (if (eq selective-display t)
5422 (error "selective-display already in use for marked lines"))
5423 (let ((current-vpos
5424 (save-restriction
5425 (narrow-to-region (point-min) (point))
5426 (goto-char (window-start))
5427 (vertical-motion (window-height)))))
5428 (setq selective-display
5429 (and arg (prefix-numeric-value arg)))
5430 (recenter current-vpos))
5431 (set-window-start (selected-window) (window-start (selected-window)))
5432 (princ "selective-display set to " t)
5433 (prin1 selective-display t)
5434 (princ "." t))
5436 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5438 (defun toggle-truncate-lines (&optional arg)
5439 "Toggle truncating of long lines for the current buffer.
5440 When truncating is off, long lines are folded.
5441 With prefix argument ARG, truncate long lines if ARG is positive,
5442 otherwise fold them. Note that in side-by-side windows, this
5443 command has no effect if `truncate-partial-width-windows' is
5444 non-nil."
5445 (interactive "P")
5446 (setq truncate-lines
5447 (if (null arg)
5448 (not truncate-lines)
5449 (> (prefix-numeric-value arg) 0)))
5450 (force-mode-line-update)
5451 (unless truncate-lines
5452 (let ((buffer (current-buffer)))
5453 (walk-windows (lambda (window)
5454 (if (eq buffer (window-buffer window))
5455 (set-window-hscroll window 0)))
5456 nil t)))
5457 (message "Truncate long lines %s"
5458 (if truncate-lines "enabled" "disabled")))
5460 (defun toggle-word-wrap (&optional arg)
5461 "Toggle whether to use word-wrapping for continuation lines.
5462 With prefix argument ARG, wrap continuation lines at word boundaries
5463 if ARG is positive, otherwise wrap them at the right screen edge.
5464 This command toggles the value of `word-wrap'. It has no effect
5465 if long lines are truncated."
5466 (interactive "P")
5467 (setq word-wrap
5468 (if (null arg)
5469 (not word-wrap)
5470 (> (prefix-numeric-value arg) 0)))
5471 (force-mode-line-update)
5472 (message "Word wrapping %s"
5473 (if word-wrap "enabled" "disabled")))
5475 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5476 "The string displayed in the mode line when in overwrite mode.")
5477 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5478 "The string displayed in the mode line when in binary overwrite mode.")
5480 (define-minor-mode overwrite-mode
5481 "Toggle Overwrite mode.
5482 With a prefix argument ARG, enable Overwrite mode if ARG is
5483 positive, and disable it otherwise. If called from Lisp, enable
5484 the mode if ARG is omitted or nil.
5486 When Overwrite mode is enabled, printing characters typed in
5487 replace existing text on a one-for-one basis, rather than pushing
5488 it to the right. At the end of a line, such characters extend
5489 the line. Before a tab, such characters insert until the tab is
5491 overwrite mode; this is supposed to make it easier to insert
5492 characters when necessary."
5493 :variable (eq overwrite-mode 'overwrite-mode-textual))
5495 (define-minor-mode binary-overwrite-mode
5496 "Toggle Binary Overwrite mode.
5497 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5498 is positive, and disable it otherwise. If called from Lisp,
5499 enable the mode if ARG is omitted or nil.
5501 When Binary Overwrite mode is enabled, printing characters typed
5502 in replace existing text. Newlines are not treated specially, so
5503 typing at the end of a line joins the line to the next, with the
5504 typed character between them. Typing before a tab character
5505 simply replaces the tab with the character typed.
5507 ordinary typing characters do.
5509 Note that Binary Overwrite mode is not its own minor mode; it is
5510 a specialization of overwrite mode, entered by setting the
5511 `overwrite-mode' variable to `overwrite-mode-binary'."
5512 :variable (eq overwrite-mode 'overwrite-mode-binary))
5514 (define-minor-mode line-number-mode
5515 "Toggle line number display in the mode line (Line Number mode).
5516 With a prefix argument ARG, enable Line Number mode if ARG is
5517 positive, and disable it otherwise. If called from Lisp, enable
5518 the mode if ARG is omitted or nil.
5520 Line numbers do not appear for very large buffers and buffers
5521 with very long lines; see variables `line-number-display-limit'
5522 and `line-number-display-limit-width'."
5523 :init-value t :global t :group 'mode-line)
5525 (define-minor-mode column-number-mode
5526 "Toggle column number display in the mode line (Column Number mode).
5527 With a prefix argument ARG, enable Column Number mode if ARG is
5528 positive, and disable it otherwise.
5530 If called from Lisp, enable the mode if ARG is omitted or nil."
5531 :global t :group 'mode-line)
5533 (define-minor-mode size-indication-mode
5534 "Toggle buffer size display in the mode line (Size Indication mode).
5535 With a prefix argument ARG, enable Size Indication mode if ARG is
5536 positive, and disable it otherwise.
5538 If called from Lisp, enable the mode if ARG is omitted or nil."
5539 :global t :group 'mode-line)
5541 (define-minor-mode auto-save-mode
5542 "Toggle auto-saving in the current buffer (Auto Save mode).
5543 With a prefix argument ARG, enable Auto Save mode if ARG is
5544 positive, and disable it otherwise.
5546 If called from Lisp, enable the mode if ARG is omitted or nil."
5547 :variable ((and buffer-auto-save-file-name
5548 ;; If auto-save is off because buffer has shrunk,
5549 ;; then toggling should turn it on.
5550 (>= buffer-saved-size 0))
5551 . (lambda (val)
5552 (setq buffer-auto-save-file-name
5553 (cond
5554 ((null val) nil)
5555 ((and buffer-file-name auto-save-visited-file-name
5556 (not buffer-read-only))
5557 buffer-file-name)
5558 (t (make-auto-save-file-name))))))
5559 ;; If -1 was stored here, to temporarily turn off saving,
5560 ;; turn it back on.
5561 (and (< buffer-saved-size 0)
5562 (setq buffer-saved-size 0)))
5563 \f
5564 (defgroup paren-blinking nil
5565 "Blinking matching of parens and expressions."
5566 :prefix "blink-matching-"
5567 :group 'paren-matching)
5569 (defcustom blink-matching-paren t
5570 "Non-nil means show matching open-paren when close-paren is inserted."
5571 :type 'boolean
5572 :group 'paren-blinking)
5574 (defcustom blink-matching-paren-on-screen t
5575 "Non-nil means show matching open-paren when it is on screen.
5576 If nil, don't show it (but the open-paren can still be shown
5577 when it is off screen).
5579 This variable has no effect if `blink-matching-paren' is nil.
5580 \(In that case, the open-paren is never shown.)
5581 It is also ignored if `show-paren-mode' is enabled."
5582 :type 'boolean
5583 :group 'paren-blinking)
5585 (defcustom blink-matching-paren-distance (* 100 1024)
5586 "If non-nil, maximum distance to search backwards for matching open-paren.
5587 If nil, search stops at the beginning of the accessible portion of the buffer."
5588 :version "23.2" ; 25->100k
5589 :type '(choice (const nil) integer)
5590 :group 'paren-blinking)
5592 (defcustom blink-matching-delay 1
5593 "Time in seconds to delay after showing a matching paren."
5594 :type 'number
5595 :group 'paren-blinking)
5597 (defcustom blink-matching-paren-dont-ignore-comments nil
5598 "If nil, `blink-matching-paren' ignores comments.
5599 More precisely, when looking for the matching parenthesis,
5600 it skips the contents of comments that end before point."
5601 :type 'boolean
5602 :group 'paren-blinking)
5604 (defun blink-matching-check-mismatch (start end)
5605 "Return whether or not START...END are matching parens.
5606 END is the current point and START is the blink position.
5607 START might be nil if no matching starter was found.
5608 Returns non-nil if we find there is a mismatch."
5609 (let* ((end-syntax (syntax-after (1- end)))
5610 (matching-paren (and (consp end-syntax)
5611 (eq (syntax-class end-syntax) 5)
5612 (cdr end-syntax))))
5613 ;; For self-matched chars like " and $, we can't know when they're
5614 ;; mismatched or unmatched, so we can only do it for parens.
5615 (when matching-paren
5616 (not (and start
5617 (or
5618 (eq (char-after start) matching-paren)
5619 ;; The cdr might hold a new paren-class info rather than
5620 ;; a matching-char info, in which case the two CDRs
5621 ;; should match.
5622 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5624 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5625 "Function to check parentheses mismatches.
5626 The function takes two arguments (START and END) where START is the
5627 position just before the opening token and END is the position right after.
5628 START can be nil, if it was not found.
5629 The function should return non-nil if the two tokens do not match.")
5631 (defun blink-matching-open ()
5632 "Move cursor momentarily to the beginning of the sexp before point."
5633 (interactive)
5634 (when (and (not (bobp))
5635 blink-matching-paren)
5636 (let* ((oldpos (point))
5637 (message-log-max nil) ; Don't log messages about paren matching.
5638 (blinkpos
5639 (save-excursion
5640 (save-restriction
5641 (if blink-matching-paren-distance
5642 (narrow-to-region
5643 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5644 (- (point) blink-matching-paren-distance))
5645 oldpos))
5646 (let ((parse-sexp-ignore-comments
5647 (and parse-sexp-ignore-comments
5648 (not blink-matching-paren-dont-ignore-comments))))
5649 (condition-case ()
5650 (progn
5651 (forward-sexp -1)
5652 ;; backward-sexp skips backward over prefix chars,
5653 ;; so move back to the matching paren.
5654 (while (and (< (point) (1- oldpos))
5655 (let ((code (syntax-after (point))))
5656 (or (eq (syntax-class code) 6)
5657 (eq (logand 1048576 (car code))
5658 1048576))))
5659 (forward-char 1))
5660 (point))
5661 (error nil))))))
5662 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5663 (cond
5664 (mismatch
5665 (if blinkpos
5666 (if (minibufferp)
5667 (minibuffer-message "Mismatched parentheses")
5668 (message "Mismatched parentheses"))
5669 (if (minibufferp)
5670 (minibuffer-message "No matching parenthesis found")
5671 (message "No matching parenthesis found"))))
5672 ((not blinkpos) nil)
5673 ((pos-visible-in-window-p blinkpos)
5674 ;; Matching open within window, temporarily move to blinkpos but only
5675 ;; if `blink-matching-paren-on-screen' is non-nil.
5676 (and blink-matching-paren-on-screen
5677 (not show-paren-mode)
5678 (save-excursion
5679 (goto-char blinkpos)
5680 (sit-for blink-matching-delay))))
5681 (t
5682 (save-excursion
5683 (goto-char blinkpos)
5684 (let ((open-paren-line-string
5685 ;; Show what precedes the open in its line, if anything.
5686 (cond
5688 (buffer-substring (line-beginning-position)
5689 (1+ blinkpos)))
5690 ;; Show what follows the open in its line, if anything.
5691 ((save-excursion
5692 (forward-char 1)
5694 (not (eolp)))
5695 (buffer-substring blinkpos
5696 (line-end-position)))
5697 ;; Otherwise show the previous nonblank line,
5698 ;; if there is one.
5700 (concat
5701 (buffer-substring (progn
5703 (line-beginning-position))
5704 (progn (end-of-line)
5706 (point)))
5707 ;; Replace the newline and other whitespace with `...'.
5708 "..."
5709 (buffer-substring blinkpos (1+ blinkpos))))
5710 ;; There is nothing to show except the char itself.
5711 (t (buffer-substring blinkpos (1+ blinkpos))))))
5712 (message "Matches %s"
5713 (substring-no-properties open-paren-line-string)))))))))
5715 (defvar blink-paren-function 'blink-matching-open
5716 "Function called, if non-nil, whenever a close parenthesis is inserted.
5717 More precisely, a char with closeparen syntax is self-inserted.")
5719 (defun blink-paren-post-self-insert-function ()
5720 (when (and (eq (char-before) last-command-event) ; Sanity check.
5721 (memq (char-syntax last-command-event) '(?\) ?\$))
5722 blink-paren-function
5723 (not executing-kbd-macro)
5724 (not noninteractive)
5725 ;; Verify an even number of quoting characters precede the close.
5726 (= 1 (logand 1 (- (point)
5727 (save-excursion
5728 (forward-char -1)
5730 (point))))))
5731 (funcall blink-paren-function)))
5733 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5734 ;; Most likely, this hook is nil, so this arg doesn't matter,
5735 ;; but I use it as a reminder that this function usually
5736 ;; likes to be run after others since it does `sit-for'.
5737 'append)
5738 \f
5739 ;; This executes C-g typed while Emacs is waiting for a command.
5740 ;; Quitting out of a program does not go through here;
5741 ;; that happens in the QUIT macro at the C code level.
5742 (defun keyboard-quit ()
5743 "Signal a `quit' condition.
5744 During execution of Lisp code, this character causes a quit directly.
5745 At top-level, as an editor command, this simply beeps."
5746 (interactive)
5747 ;; Avoid adding the region to the window selection.
5748 (setq saved-region-selection nil)
5749 (let (select-active-regions)
5750 (deactivate-mark))
5751 (if (fboundp 'kmacro-keyboard-quit)
5752 (kmacro-keyboard-quit))
5753 (setq defining-kbd-macro nil)
5754 (let ((debug-on-quit nil))
5755 (signal 'quit nil)))
5757 (defvar buffer-quit-function nil
5760 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
5762 (defun keyboard-escape-quit ()
5764 This command can exit an interactive command such as `query-replace',
5765 can clear out a prefix argument or a region,
5766 can get out of the minibuffer or other recursive edit,
5767 cancel the use of the current buffer (for special-purpose buffers),
5768 or go back to just one window (by deleting all but the selected window)."
5769 (interactive)
5770 (cond ((eq last-command 'mode-exited) nil)
5771 ((region-active-p)
5772 (deactivate-mark))
5773 ((> (minibuffer-depth) 0)
5774 (abort-recursive-edit))
5775 (current-prefix-arg
5776 nil)
5777 ((> (recursion-depth) 0)
5778 (exit-recursive-edit))
5779 (buffer-quit-function
5780 (funcall buffer-quit-function))
5781 ((not (one-window-p t))
5782 (delete-other-windows))
5784 (bury-buffer))))
5786 (defun play-sound-file (file &optional volume device)
5787 "Play sound stored in FILE.
5788 VOLUME and DEVICE correspond to the keywords of the sound
5789 specification for `play-sound'."
5790 (interactive "fPlay sound file: ")
5791 (let ((sound (list :file file)))
5792 (if volume
5793 (plist-put sound :volume volume))
5794 (if device
5795 (plist-put sound :device device))
5796 (push 'sound sound)
5797 (play-sound sound)))
5799 \f
5800 (defcustom read-mail-command 'rmail
5801 "Your preference for a mail reading package.
5802 This is used by some keybindings which support reading mail.
5803 See also `mail-user-agent' concerning sending mail."
5806 (function-item :tag "Emacs interface to MH"
5808 (function :tag "Other"))
5809 :version "21.1"
5810 :group 'mail)
5812 (defcustom mail-user-agent 'message-user-agent
5813 "Your preference for a mail composition package.
5814 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5815 outgoing email message. This variable lets you specify which
5816 mail-sending package you prefer.
5818 Valid values include:
5820 `message-user-agent' -- use the Message package.
5821 See Info node `(message)'.
5822 `sendmail-user-agent' -- use the Mail package.
5823 See Info node `(emacs)Sending Mail'.
5824 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5825 See Info node `(mh-e)'.
5826 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5827 paraphernalia if Gnus is running, particularly
5828 the Gcc: header for archiving.
5830 Additional valid symbols may be available; check with the author of
5831 your package for details. The function should return non-nil if it
5832 succeeds.
5834 See also `read-mail-command' concerning reading mail."
5835 :type '(radio (function-item :tag "Message package"
5837 message-user-agent)
5838 (function-item :tag "Mail package"
5840 sendmail-user-agent)
5841 (function-item :tag "Emacs interface to MH"
5843 mh-e-user-agent)
5844 (function-item :tag "Message with full Gnus features"
5846 gnus-user-agent)
5847 (function :tag "Other"))
5848 :version "23.2" ; sendmail->message
5849 :group 'mail)
5851 (defcustom compose-mail-user-agent-warnings t
5852 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5853 If the value of `mail-user-agent' is the default, and the user
5854 appears to have customizations applying to the old default,
5855 `compose-mail' issues a warning."
5856 :type 'boolean
5857 :version "23.2"
5858 :group 'mail)
5860 (defun rfc822-goto-eoh ()
5861 "If the buffer starts with a mail header, move point to the header's end.
5862 Otherwise, moves to `point-min'.
5863 The end of the header is the start of the next line, if there is one,
5864 else the end of the last line. This function obeys RFC822."
5865 (goto-char (point-min))
5866 (when (re-search-forward
5868 (goto-char (match-beginning 0))))
5870 ;; Used by Rmail (e.g., rmail-forward).
5871 (defvar mail-encode-mml nil
5872 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
5873 the outgoing message before sending it.")
5875 (defun compose-mail (&optional to subject other-headers continue
5876 switch-function yank-action send-actions
5877 return-action)
5878 "Start composing a mail message to send.
5879 This uses the user's chosen mail composition package
5880 as selected with the variable `mail-user-agent'.
5881 The optional arguments TO and SUBJECT specify recipients
5882 and the initial Subject field, respectively.
5884 OTHER-HEADERS is an alist specifying additional
5885 header fields. Elements look like (HEADER . VALUE) where both
5886 HEADER and VALUE are strings.
5888 CONTINUE, if non-nil, says to continue editing a message already
5889 being composed. Interactively, CONTINUE is the prefix argument.
5891 SWITCH-FUNCTION, if non-nil, is a function to use to
5892 switch to and display the buffer used for mail composition.
5894 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5895 to insert the raw text of the message being replied to.
5896 It has the form (FUNCTION . ARGS). The user agent will apply
5897 FUNCTION to ARGS, to insert the raw text of the original message.
5898 \(The user agent will also run `mail-citation-hook', *after* the
5899 original text has been inserted in this way.)
5901 SEND-ACTIONS is a list of actions to call when the message is sent.
5902 Each action has the form (FUNCTION . ARGS).
5904 RETURN-ACTION, if non-nil, is an action for returning to the
5905 caller. It has the form (FUNCTION . ARGS). The function is
5906 called after the mail has been sent or put aside, and the mail
5907 buffer buried."
5908 (interactive
5909 (list nil nil nil current-prefix-arg))
5911 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5912 ;; from sendmail-user-agent to message-user-agent. Some users may
5913 ;; encounter incompatibilities. This hack tries to detect problems
5914 ;; and warn about them.
5915 (and compose-mail-user-agent-warnings
5916 (eq mail-user-agent 'message-user-agent)
5917 (let (warn-vars)
5918 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5919 mail-yank-hooks mail-archive-file-name
5920 mail-default-reply-to mail-mailing-lists
5921 mail-self-blind))
5922 (and (boundp var)
5923 (symbol-value var)
5924 (push var warn-vars)))
5925 (when warn-vars
5926 (display-warning 'mail
5927 (format "\
5928 The default mail mode is now Message mode.
5929 You have the following Mail mode variable%s customized:
5931 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5932 (if (> (length warn-vars) 1) "s" "")
5933 (mapconcat 'symbol-name
5934 warn-vars " "))))))
5936 (let ((function (get mail-user-agent 'composefunc)))
5937 (funcall function to subject other-headers continue switch-function
5938 yank-action send-actions return-action)))
5940 (defun compose-mail-other-window (&optional to subject other-headers continue
5941 yank-action send-actions
5942 return-action)
5944 (interactive (list nil nil nil current-prefix-arg))
5945 (compose-mail to subject other-headers continue
5946 'switch-to-buffer-other-window yank-action send-actions
5947 return-action))
5949 (defun compose-mail-other-frame (&optional to subject other-headers continue
5950 yank-action send-actions
5951 return-action)
5953 (interactive (list nil nil nil current-prefix-arg))
5954 (compose-mail to subject other-headers continue
5955 'switch-to-buffer-other-frame yank-action send-actions
5956 return-action))
5958 \f
5959 (defvar set-variable-value-history nil
5960 "History of values entered with `set-variable'.
5962 Maximum length of the history list is determined by the value
5963 of `history-length', which see.")
5965 (defun set-variable (variable value &optional make-local)
5966 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5967 VARIABLE should be a user option variable name, a Lisp variable
5968 meant to be customized by users. You should enter VALUE in Lisp syntax,
5969 so if you want VALUE to be a string, you must surround it with doublequotes.
5970 VALUE is used literally, not evaluated.
5972 If VARIABLE has a `variable-interactive' property, that is used as if
5973 it were the arg to `interactive' (which see) to interactively read VALUE.
5975 If VARIABLE has been defined with `defcustom', then the type information
5976 in the definition is used to check that VALUE is valid.
5978 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5979 (interactive
5980 (let* ((default-var (variable-at-point))
5981 (var (if (user-variable-p default-var)
5982 (read-variable (format "Set variable (default %s): " default-var)
5983 default-var)
5984 (read-variable "Set variable: ")))
5985 (minibuffer-help-form '(describe-variable var))
5986 (prop (get var 'variable-interactive))
5987 (obsolete (car (get var 'byte-obsolete-variable)))
5988 (prompt (format "Set %s %s to value: " var
5989 (cond ((local-variable-p var)
5990 "(buffer-local)")
5991 ((or current-prefix-arg
5992 (local-variable-if-set-p var))
5993 "buffer-locally")
5994 (t "globally"))))
5995 (val (progn
5996 (when obsolete
5997 (message (concat "`%S' is obsolete; "
5998 (if (symbolp obsolete) "use `%S' instead" "%s"))
5999 var obsolete)
6000 (sit-for 3))
6001 (if prop
6002 ;; Use VAR's `variable-interactive' property
6003 ;; as an interactive spec for prompting.
6004 (call-interactively `(lambda (arg)
6005 (interactive ,prop)
6006 arg))
6007 (read
6008 (read-string prompt nil
6009 'set-variable-value-history
6010 (format "%S" (symbol-value var))))))))
6011 (list var val current-prefix-arg)))
6013 (and (custom-variable-p variable)
6014 (not (get variable 'custom-type))
6015 (custom-load-symbol variable))
6016 (let ((type (get variable 'custom-type)))
6017 (when type
6018 ;; Match with custom type.
6019 (require 'cus-edit)
6020 (setq type (widget-convert type))
6021 (unless (widget-apply type :match value)
6022 (error "Value `%S' does not match type %S of %S"
6023 value (car type) variable))))
6025 (if make-local
6026 (make-local-variable variable))
6028 (set variable value)
6030 ;; Force a thorough redisplay for the case that the variable
6031 ;; has an effect on the display, like `tab-width' has.
6032 (force-mode-line-update))
6033 \f
6034 ;; Define the major mode for lists of completions.
6036 (defvar completion-list-mode-map
6037 (let ((map (make-sparse-keymap)))
6038 (define-key map [mouse-2] 'mouse-choose-completion)
6039 (define-key map [follow-link] 'mouse-face)
6040 (define-key map [down-mouse-2] nil)
6041 (define-key map "\C-m" 'choose-completion)
6042 (define-key map "\e\e\e" 'delete-completion-window)
6043 (define-key map [left] 'previous-completion)
6044 (define-key map [right] 'next-completion)
6045 (define-key map "q" 'quit-window)
6046 (define-key map "z" 'kill-this-buffer)
6047 map)
6048 "Local map for completion list buffers.")
6050 ;; Completion mode is suitable only for specially formatted data.
6051 (put 'completion-list-mode 'mode-class 'special)
6053 (defvar completion-reference-buffer nil
6054 "Record the buffer that was current when the completion list was requested.
6055 This is a local variable in the completion list buffer.
6056 Initial value is nil to avoid some compiler warnings.")
6058 (defvar completion-no-auto-exit nil
6059 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6060 This also applies to other functions such as `choose-completion'.")
6062 (defvar completion-base-position nil
6063 "Position of the base of the text corresponding to the shown completions.
6064 This variable is used in the *Completions* buffers.
6065 Its value is a list of the form (START END) where START is the place
6066 where the completion should be inserted and END (if non-nil) is the end
6067 of the text to replace. If END is nil, point is used instead.")
6069 (defvar completion-list-insert-choice-function #'completion--replace
6070 "Function to use to insert the text chosen in *Completions*.
6071 Called with three arguments (BEG END TEXT), it should replace the text
6072 between BEG and END with TEXT. Expected to be set buffer-locally
6073 in the *Completions* buffer.")
6075 (defvar completion-base-size nil
6076 "Number of chars before point not involved in completion.
6077 This is a local variable in the completion list buffer.
6078 It refers to the chars in the minibuffer if completing in the
6079 minibuffer, or in `completion-reference-buffer' otherwise.
6080 Only characters in the field at point are included.
6082 If nil, Emacs determines which part of the tail end of the
6083 buffer's text is involved in completion by comparing the text
6084 directly.")
6085 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6087 (defun delete-completion-window ()
6088 "Delete the completion list window.
6089 Go to the window from which completion was requested."
6090 (interactive)
6091 (let ((buf completion-reference-buffer))
6092 (if (one-window-p t)
6093 (if (window-dedicated-p (selected-window))
6094 (delete-frame (selected-frame)))
6095 (delete-window (selected-window))
6096 (if (get-buffer-window buf)
6097 (select-window (get-buffer-window buf))))))
6099 (defun previous-completion (n)
6100 "Move to the previous item in the completion list."
6101 (interactive "p")
6102 (next-completion (- n)))
6104 (defun next-completion (n)
6105 "Move to the next item in the completion list.
6106 With prefix argument N, move N items (negative N means move backward)."
6107 (interactive "p")
6108 (let ((beg (point-min)) (end (point-max)))
6109 (while (and (> n 0) (not (eobp)))
6110 ;; If in a completion, move to the end of it.
6111 (when (get-text-property (point) 'mouse-face)
6112 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6113 ;; Move to start of next one.
6114 (unless (get-text-property (point) 'mouse-face)
6115 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6116 (setq n (1- n)))
6117 (while (and (< n 0) (not (bobp)))
6118 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6119 ;; If in a completion, move to the start of it.
6120 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6121 (goto-char (previous-single-property-change
6122 (point) 'mouse-face nil beg)))
6123 ;; Move to end of the previous completion.
6124 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6125 (goto-char (previous-single-property-change
6126 (point) 'mouse-face nil beg)))
6127 ;; Move to the start of that one.
6128 (goto-char (previous-single-property-change
6129 (point) 'mouse-face nil beg))
6130 (setq n (1+ n))))))
6132 (defun choose-completion (&optional event)
6133 "Choose the completion at point."
6134 (interactive (list last-nonmenu-event))
6135 ;; In case this is run via the mouse, give temporary modes such as
6136 ;; isearch a chance to turn off.
6137 (run-hooks 'mouse-leave-buffer-hook)
6138 (with-current-buffer (window-buffer (posn-window (event-start event)))
6139 (let ((buffer completion-reference-buffer)
6140 (base-size completion-base-size)
6141 (base-position completion-base-position)
6142 (insert-function completion-list-insert-choice-function)
6143 (choice
6144 (save-excursion
6145 (goto-char (posn-point (event-start event)))
6146 (let (beg end)
6147 (cond
6148 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6149 (setq end (point) beg (1+ (point))))
6150 ((and (not (bobp))
6151 (get-text-property (1- (point)) 'mouse-face))
6152 (setq end (1- (point)) beg (point)))
6153 (t (error "No completion here")))
6154 (setq beg (previous-single-property-change beg 'mouse-face))
6155 (setq end (or (next-single-property-change end 'mouse-face)
6156 (point-max)))
6157 (buffer-substring-no-properties beg end))))
6158 (owindow (selected-window)))
6160 (unless (buffer-live-p buffer)
6161 (error "Destination buffer is dead"))
6162 (select-window (posn-window (event-start event)))
6163 (if (and (one-window-p t 'selected-frame)
6164 (window-dedicated-p (selected-window)))
6165 ;; This is a special buffer's frame
6166 (iconify-frame (selected-frame))
6167 (or (window-dedicated-p (selected-window))
6168 (bury-buffer)))
6169 (select-window
6170 (or (get-buffer-window buffer 0)
6171 owindow))
6173 (with-current-buffer buffer
6174 (choose-completion-string
6175 choice buffer
6176 (or base-position
6177 (when base-size
6178 ;; Someone's using old completion code that doesn't know
6179 ;; about base-position yet.
6180 (list (+ base-size (field-beginning))))
6181 ;; If all else fails, just guess.
6182 (list (choose-completion-guess-base-position choice)))
6183 insert-function)))))
6185 ;; Delete the longest partial match for STRING
6186 ;; that can be found before POINT.
6187 (defun choose-completion-guess-base-position (string)
6188 (save-excursion
6189 (let ((opoint (point))
6190 len)
6191 ;; Try moving back by the length of the string.
6192 (goto-char (max (- (point) (length string))
6193 (minibuffer-prompt-end)))
6194 ;; See how far back we were actually able to move. That is the
6195 ;; upper bound on how much we can match and delete.
6196 (setq len (- opoint (point)))
6197 (if completion-ignore-case
6198 (setq string (downcase string)))
6199 (while (and (> len 0)
6200 (let ((tail (buffer-substring (point) opoint)))
6201 (if completion-ignore-case
6202 (setq tail (downcase tail)))
6203 (not (string= tail (substring string 0 len)))))
6204 (setq len (1- len))
6205 (forward-char 1))
6206 (point))))
6208 (defun choose-completion-delete-max-match (string)
6209 (delete-region (choose-completion-guess-base-position string) (point)))
6210 (make-obsolete 'choose-completion-delete-max-match
6211 'choose-completion-guess-base-position "23.2")
6213 (defvar choose-completion-string-functions nil
6214 "Functions that may override the normal insertion of a completion choice.
6215 These functions are called in order with four arguments:
6216 CHOICE - the string to insert in the buffer,
6217 BUFFER - the buffer in which the choice should be inserted,
6218 MINI-P - non-nil if BUFFER is a minibuffer, and
6219 BASE-SIZE - the number of characters in BUFFER before
6220 the string being completed.
6222 If a function in the list returns non-nil, that function is supposed
6223 to have inserted the CHOICE in the BUFFER, and possibly exited
6224 the minibuffer; no further functions will be called.
6226 If all functions in the list return nil, that means to use
6227 the default method of inserting the completion in BUFFER.")
6229 (defun choose-completion-string (choice &optional
6230 buffer base-position insert-function)
6231 "Switch to BUFFER and insert the completion choice CHOICE.
6232 BASE-POSITION, says where to insert the completion."
6234 ;; If BUFFER is the minibuffer, exit the minibuffer
6235 ;; unless it is reading a file name and CHOICE is a directory,
6236 ;; or completion-no-auto-exit is non-nil.
6238 ;; Some older code may call us passing `base-size' instead of
6239 ;; `base-position'. It's difficult to make any use of `base-size',
6240 ;; so we just ignore it.
6241 (unless (consp base-position)
6242 (message "Obsolete `base-size' passed to choose-completion-string")
6243 (setq base-position nil))
6245 (let* ((buffer (or buffer completion-reference-buffer))
6246 (mini-p (minibufferp buffer)))
6247 ;; If BUFFER is a minibuffer, barf unless it's the currently
6248 ;; active minibuffer.
6249 (if (and mini-p
6250 (not (and (active-minibuffer-window)
6251 (equal buffer
6252 (window-buffer (active-minibuffer-window))))))
6253 (error "Minibuffer is not active for completion")
6254 ;; Set buffer so buffer-local choose-completion-string-functions works.
6255 (set-buffer buffer)
6256 (unless (run-hook-with-args-until-success
6257 'choose-completion-string-functions
6258 ;; The fourth arg used to be `mini-p' but was useless
6259 ;; (since minibufferp can be used on the `buffer' arg)
6260 ;; and indeed unused. The last used to be `base-size', so we
6261 ;; keep it to try and avoid breaking old code.
6262 choice buffer base-position nil)
6263 ;; This remove-text-properties should be unnecessary since `choice'
6264 ;; comes from buffer-substring-no-properties.
6265 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6266 ;; Insert the completion into the buffer where it was requested.
6267 (funcall (or insert-function completion-list-insert-choice-function)
6268 (or (car base-position) (point))
6269 (or (cadr base-position) (point))
6270 choice)
6271 ;; Update point in the window that BUFFER is showing in.
6272 (let ((window (get-buffer-window buffer t)))
6273 (set-window-point window (point)))
6274 ;; If completing for the minibuffer, exit it with this choice.
6275 (and (not completion-no-auto-exit)
6276 (minibufferp buffer)
6277 minibuffer-completion-table
6278 ;; If this is reading a file name, and the file name chosen
6279 ;; is a directory, don't exit the minibuffer.
6280 (let* ((result (buffer-substring (field-beginning) (point)))
6281 (bounds
6282 (completion-boundaries result minibuffer-completion-table
6283 minibuffer-completion-predicate
6284 "")))
6285 (if (eq (car bounds) (length result))
6286 ;; The completion chosen leads to a new set of completions
6287 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6288 (let ((mini (active-minibuffer-window)))
6289 (select-window mini)
6290 (when minibuffer-auto-raise
6291 (raise-frame (window-frame mini))))
6292 (exit-minibuffer))))))))
6294 (define-derived-mode completion-list-mode nil "Completion List"
6295 "Major mode for buffers showing lists of possible completions.
6297 to select the completion near point.
6299 with the mouse.
6302 (set (make-local-variable 'completion-base-size) nil))
6304 (defun completion-list-mode-finish ()
6305 "Finish setup of the completions buffer.
6306 Called from `temp-buffer-show-hook'."
6307 (when (eq major-mode 'completion-list-mode)
6308 (toggle-read-only 1)))
6310 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6313 ;; Variables and faces used in `completion-setup-function'.
6315 (defcustom completion-show-help t
6316 "Non-nil means show help message in *Completions* buffer."
6317 :type 'boolean
6318 :version "22.1"
6319 :group 'completion)
6321 ;; This function goes in completion-setup-hook, so that it is called
6322 ;; after the text of the completion list buffer is written.
6323 (defun completion-setup-function ()
6324 (let* ((mainbuf (current-buffer))
6325 (base-dir
6326 ;; When reading a file name in the minibuffer,
6327 ;; try and find the right default-directory to set in the
6328 ;; completion list buffer.
6329 ;; FIXME: Why do we do that, actually? --Stef
6330 (if minibuffer-completing-file-name
6331 (file-name-as-directory
6332 (expand-file-name
6333 (substring (minibuffer-completion-contents)
6334 0 (or completion-base-size 0)))))))
6335 (with-current-buffer standard-output
6336 (let ((base-size completion-base-size) ;Read before killing localvars.
6337 (base-position completion-base-position)
6338 (insert-fun completion-list-insert-choice-function))
6339 (completion-list-mode)
6340 (set (make-local-variable 'completion-base-size) base-size)
6341 (set (make-local-variable 'completion-base-position) base-position)
6342 (set (make-local-variable 'completion-list-insert-choice-function)
6343 insert-fun))
6344 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6345 (if base-dir (setq default-directory base-dir))
6346 ;; Maybe insert help string.
6347 (when completion-show-help
6348 (goto-char (point-min))
6349 (if (display-mouse-p)
6350 (insert (substitute-command-keys
6352 (insert (substitute-command-keys
6356 (add-hook 'completion-setup-hook 'completion-setup-function)
6358 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6359 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6361 (defun switch-to-completions ()
6362 "Select the completion list window."
6363 (interactive)
6364 (let ((window (or (get-buffer-window "*Completions*" 0)
6365 ;; Make sure we have a completions window.
6366 (progn (minibuffer-completion-help)
6367 (get-buffer-window "*Completions*" 0)))))
6368 (when window
6369 (select-window window)
6370 ;; In the new buffer, go to the first completion.
6371 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6372 (when (bobp)
6373 (next-completion 1)))))
6374 \f
6375 ;;; Support keyboard commands to turn on various modifiers.
6377 ;; These functions -- which are not commands -- each add one modifier
6378 ;; to the following event.
6380 (defun event-apply-alt-modifier (_ignore-prompt)
6383 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6384 (defun event-apply-super-modifier (_ignore-prompt)
6387 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6388 (defun event-apply-hyper-modifier (_ignore-prompt)
6391 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6392 (defun event-apply-shift-modifier (_ignore-prompt)
6395 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6396 (defun event-apply-control-modifier (_ignore-prompt)
6399 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6400 (defun event-apply-meta-modifier (_ignore-prompt)
6403 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6405 (defun event-apply-modifier (event symbol lshiftby prefix)
6406 "Apply a modifier flag to event EVENT.
6407 SYMBOL is the name of this modifier, as a symbol.
6408 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6409 PREFIX is the string that represents this modifier in an event type symbol."
6410 (if (numberp event)
6411 (cond ((eq symbol 'control)
6412 (if (and (<= (downcase event) ?z)
6413 (>= (downcase event) ?a))
6414 (- (downcase event) ?a -1)
6415 (if (and (<= (downcase event) ?Z)
6416 (>= (downcase event) ?A))
6417 (- (downcase event) ?A -1)
6418 (logior (lsh 1 lshiftby) event))))
6419 ((eq symbol 'shift)
6420 (if (and (<= (downcase event) ?z)
6421 (>= (downcase event) ?a))
6422 (upcase event)
6423 (logior (lsh 1 lshiftby) event)))
6424 (t
6425 (logior (lsh 1 lshiftby) event)))
6426 (if (memq symbol (event-modifiers event))
6427 event
6428 (let ((event-type (if (symbolp event) event (car event))))
6429 (setq event-type (intern (concat prefix (symbol-name event-type))))
6430 (if (symbolp event)
6431 event-type
6432 (cons event-type (cdr event)))))))
6434 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6435 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6436 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6437 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6438 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6439 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6440 \f
6441 ;;;; Keypad support.
6443 ;; Make the keypad keys act like ordinary typing keys. If people add
6444 ;; bindings for the function key symbols, then those bindings will
6445 ;; override these, so this shouldn't interfere with any existing
6446 ;; bindings.
6448 ;; Also tell read-char how to handle these keys.
6449 (mapc
6450 (lambda (keypad-normal)
6451 (let ((keypad (nth 0 keypad-normal))
6452 (normal (nth 1 keypad-normal)))
6453 (put keypad 'ascii-character normal)
6454 (define-key function-key-map (vector keypad) (vector normal))))
6455 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6456 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6457 (kp-space ?\s)
6460 (kp-multiply ?*)
6461 (kp-add ?+)
6462 (kp-separator ?,)
6463 (kp-subtract ?-)
6464 (kp-decimal ?.)
6465 (kp-divide ?/)
6466 (kp-equal ?=)
6467 ;; Do the same for various keys that are represented as symbols under
6468 ;; GUIs but naturally correspond to characters.
6469 (backspace 127)
6470 (delete 127)
6473 (clear ?\C-l)
6474 (return ?\C-m)
6475 (escape ?\e)
6476 ))
6477 \f
6478 ;;;;
6479 ;;;; forking a twin copy of a buffer.
6480 ;;;;
6482 (defvar clone-buffer-hook nil
6483 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6485 (defvar clone-indirect-buffer-hook nil
6486 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6488 (defun clone-process (process &optional newname)
6489 "Create a twin copy of PROCESS.
6490 If NEWNAME is nil, it defaults to PROCESS' name;
6491 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6492 If PROCESS is associated with a buffer, the new process will be associated
6493 with the current buffer instead.
6494 Returns nil if PROCESS has already terminated."
6495 (setq newname (or newname (process-name process)))
6497 (setq newname (substring newname 0 (match-beginning 0))))
6498 (when (memq (process-status process) '(run stop open))
6499 (let* ((process-connection-type (process-tty-name process))
6500 (new-process
6501 (if (memq (process-status process) '(open))
6502 (let ((args (process-contact process t)))
6503 (setq args (plist-put args :name newname))
6504 (setq args (plist-put args :buffer
6505 (if (process-buffer process)
6506 (current-buffer))))
6507 (apply 'make-network-process args))
6508 (apply 'start-process newname
6509 (if (process-buffer process) (current-buffer))
6510 (process-command process)))))
6511 (set-process-query-on-exit-flag
6512 new-process (process-query-on-exit-flag process))
6513 (set-process-inherit-coding-system-flag
6514 new-process (process-inherit-coding-system-flag process))
6515 (set-process-filter new-process (process-filter process))
6516 (set-process-sentinel new-process (process-sentinel process))
6517 (set-process-plist new-process (copy-sequence (process-plist process)))
6518 new-process)))
6520 ;; things to maybe add (currently partly covered by `funcall mode'):
6521 ;; - syntax-table
6522 ;; - overlays
6523 (defun clone-buffer (&optional newname display-flag)
6524 "Create and return a twin copy of the current buffer.
6525 Unlike an indirect buffer, the new buffer can be edited
6526 independently of the old one (if it is not read-only).
6527 NEWNAME is the name of the new buffer. It may be modified by
6528 adding or incrementing <N> at the end as necessary to create a
6529 unique buffer name. If nil, it defaults to the name of the
6530 current buffer, with the proper suffix. If DISPLAY-FLAG is
6531 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6532 clone a file-visiting buffer, or a buffer whose major mode symbol
6533 has a non-nil `no-clone' property, results in an error.
6535 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6536 current buffer with appropriate suffix. However, if a prefix
6537 argument is given, then the command prompts for NEWNAME in the
6538 minibuffer.
6540 This runs the normal hook `clone-buffer-hook' in the new buffer
6541 after it has been set up properly in other respects."
6542 (interactive
6543 (progn
6544 (if buffer-file-name
6545 (error "Cannot clone a file-visiting buffer"))
6546 (if (get major-mode 'no-clone)
6547 (error "Cannot clone a buffer in %s mode" mode-name))
6548 (list (if current-prefix-arg
6549 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6550 t)))
6551 (if buffer-file-name
6552 (error "Cannot clone a file-visiting buffer"))
6553 (if (get major-mode 'no-clone)
6554 (error "Cannot clone a buffer in %s mode" mode-name))
6555 (setq newname (or newname (buffer-name)))
6557 (setq newname (substring newname 0 (match-beginning 0))))
6558 (let ((buf (current-buffer))
6559 (ptmin (point-min))
6560 (ptmax (point-max))
6561 (pt (point))
6562 (mk (if mark-active (mark t)))
6563 (modified (buffer-modified-p))
6564 (mode major-mode)
6565 (lvars (buffer-local-variables))
6566 (process (get-buffer-process (current-buffer)))
6567 (new (generate-new-buffer (or newname (buffer-name)))))
6568 (save-restriction
6569 (widen)
6570 (with-current-buffer new
6571 (insert-buffer-substring buf)))
6572 (with-current-buffer new
6573 (narrow-to-region ptmin ptmax)
6574 (goto-char pt)
6575 (if mk (set-mark mk))
6576 (set-buffer-modified-p modified)
6578 ;; Clone the old buffer's process, if any.
6579 (when process (clone-process process))
6581 ;; Now set up the major mode.
6582 (funcall mode)
6584 ;; Set up other local variables.
6585 (mapc (lambda (v)
6586 (condition-case () ;in case var is read-only
6587 (if (symbolp v)
6588 (makunbound v)
6589 (set (make-local-variable (car v)) (cdr v)))
6590 (error nil)))
6591 lvars)
6593 ;; Run any hooks (typically set up by the major mode
6594 ;; for cloning to work properly).
6595 (run-hooks 'clone-buffer-hook))
6596 (if display-flag
6597 ;; Presumably the current buffer is shown in the selected frame, so
6598 ;; we want to display the clone elsewhere.
6599 (let ((same-window-regexps nil)
6600 (same-window-buffer-names))
6601 (pop-to-buffer new)))
6602 new))
6605 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6606 "Create an indirect buffer that is a twin copy of the current buffer.
6608 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6609 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6610 or if not called with a prefix arg, NEWNAME defaults to the current
6611 buffer's name. The name is modified by adding a `<N>' suffix to it
6612 or by incrementing the N in an existing suffix. Trying to clone a
6613 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6614 property results in an error.
6616 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6617 This is always done when called interactively.
6619 Optional third arg NORECORD non-nil means do not put this buffer at the
6620 front of the list of recently selected ones."
6621 (interactive
6622 (progn
6623 (if (get major-mode 'no-clone-indirect)
6624 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6625 (list (if current-prefix-arg
6626 (read-buffer "Name of indirect buffer: " (current-buffer)))
6627 t)))
6628 (if (get major-mode 'no-clone-indirect)
6629 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6630 (setq newname (or newname (buffer-name)))
6632 (setq newname (substring newname 0 (match-beginning 0))))
6633 (let* ((name (generate-new-buffer-name newname))
6634 (buffer (make-indirect-buffer (current-buffer) name t)))
6635 (with-current-buffer buffer
6636 (run-hooks 'clone-indirect-buffer-hook))
6637 (when display-flag
6638 (pop-to-buffer buffer norecord))
6639 buffer))
6642 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6643 "Like `clone-indirect-buffer' but display in another window."
6644 (interactive
6645 (progn
6646 (if (get major-mode 'no-clone-indirect)
6647 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6648 (list (if current-prefix-arg
6649 (read-buffer "Name of indirect buffer: " (current-buffer)))
6650 t)))
6651 (let ((pop-up-windows t))
6652 (clone-indirect-buffer newname display-flag norecord)))
6654 \f
6655 ;;; Handling of Backspace and Delete keys.
6657 (defcustom normal-erase-is-backspace 'maybe
6658 "Set the default behavior of the Delete and Backspace keys.
6660 If set to t, Delete key deletes forward and Backspace key deletes
6661 backward.
6663 If set to nil, both Delete and Backspace keys delete backward.
6665 If set to 'maybe (which is the default), Emacs automatically
6666 selects a behavior. On window systems, the behavior depends on
6667 the keyboard used. If the keyboard has both a Backspace key and
6668 a Delete key, and both are mapped to their usual meanings, the
6669 option's default value is set to t, so that Backspace can be used
6670 to delete backward, and Delete can be used to delete forward.
6672 If not running under a window system, customizing this option
6673 accomplishes a similar effect by mapping C-h, which is usually
6674 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6675 via `keyboard-translate'. The former functionality of C-h is
6676 available on the F1 key. You should probably not use this
6677 setting if you don't have both Backspace, Delete and F1 keys.
6679 Setting this variable with setq doesn't take effect. Programmatically,
6680 call `normal-erase-is-backspace-mode' (which see) instead."
6681 :type '(choice (const :tag "Off" nil)
6682 (const :tag "Maybe" maybe)
6683 (other :tag "On" t))
6684 :group 'editing-basics
6685 :version "21.1"
6686 :set (lambda (symbol value)
6687 ;; The fboundp is because of a problem with :set when
6688 ;; dumping Emacs. It doesn't really matter.
6689 (if (fboundp 'normal-erase-is-backspace-mode)
6690 (normal-erase-is-backspace-mode (or value 0))
6691 (set-default symbol value))))
6693 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6694 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6695 (unless frame (setq frame (selected-frame)))
6696 (with-selected-frame frame
6697 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6698 (normal-erase-is-backspace-mode
6699 (if (if (eq normal-erase-is-backspace 'maybe)
6700 (and (not noninteractive)
6701 (or (memq system-type '(ms-dos windows-nt))
6702 (memq window-system '(ns))
6703 (and (memq window-system '(x))
6704 (fboundp 'x-backspace-delete-keys-p)
6705 (x-backspace-delete-keys-p))
6706 ;; If the terminal Emacs is running on has erase char
6707 ;; set to ^H, use the Backspace key for deleting
6708 ;; backward, and the Delete key for deleting forward.
6709 (and (null window-system)
6710 (eq tty-erase-char ?\^H))))
6711 normal-erase-is-backspace)
6712 1 0)))))
6714 (define-minor-mode normal-erase-is-backspace-mode
6715 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6716 With a prefix argument ARG, enable this feature if ARG is
6717 positive, and disable it otherwise. If called from Lisp, enable
6718 the mode if ARG is omitted or nil.
6720 On window systems, when this mode is on, Delete is mapped to C-d
6721 and Backspace is mapped to DEL; when this mode is off, both
6722 Delete and Backspace are mapped to DEL. (The remapping goes via
6723 `local-function-key-map', so binding Delete or Backspace in the
6724 global or local keymap will override that.)
6726 In addition, on window systems, the bindings of C-Delete, M-Delete,
6727 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6728 the global keymap in accordance with the functionality of Delete and
6729 Backspace. For example, if Delete is remapped to C-d, which deletes
6730 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6731 to DEL, which deletes backward, C-Delete is bound to
6732 `backward-kill-word'.
6734 If not running on a window system, a similar effect is accomplished by
6735 remapping C-h (normally produced by the Backspace key) and DEL via
6736 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6737 to C-d; if it's off, the keys are not remapped.
6739 When not running on a window system, and this mode is turned on, the
6740 former functionality of C-h is available on the F1 key. You should
6741 probably not turn on this mode on a text-only terminal if you don't
6742 have both Backspace, Delete and F1 keys.
6744 See also `normal-erase-is-backspace'."
6745 :variable (eq (terminal-parameter
6746 nil 'normal-erase-is-backspace) 1)
6747 (let ((enabled (eq 1 (terminal-parameter
6748 nil 'normal-erase-is-backspace))))
6750 (cond ((or (memq window-system '(x w32 ns pc))
6751 (memq system-type '(ms-dos windows-nt)))
6752 (let ((bindings
6753 `(([M-delete] [M-backspace])
6754 ([C-M-delete] [C-M-backspace])
6755 ([?\e C-delete] [?\e C-backspace]))))
6757 (if enabled
6758 (progn
6759 (define-key local-function-key-map [delete] [deletechar])
6760 (define-key local-function-key-map [kp-delete] [?\C-d])
6761 (define-key local-function-key-map [backspace] [?\C-?])
6762 (dolist (b bindings)
6763 ;; Not sure if input-decode-map is really right, but
6764 ;; keyboard-translate-table (used below) only works
6765 ;; for integer events, and key-translation-table is
6766 ;; global (like the global-map, used earlier).
6767 (define-key input-decode-map (car b) nil)
6768 (define-key input-decode-map (cadr b) nil)))
6769 (define-key local-function-key-map [delete] [?\C-?])
6770 (define-key local-function-key-map [kp-delete] [?\C-?])
6771 (define-key local-function-key-map [backspace] [?\C-?])
6772 (dolist (b bindings)
6773 (define-key input-decode-map (car b) (cadr b))
6774 (define-key input-decode-map (cadr b) (car b))))))
6775 (t
6776 (if enabled
6777 (progn
6778 (keyboard-translate ?\C-h ?\C-?)
6779 (keyboard-translate ?\C-? ?\C-d))
6780 (keyboard-translate ?\C-h ?\C-h)
6781 (keyboard-translate ?\C-? ?\C-?))))
6783 (if (called-interactively-p 'interactive)
6784 (message "Delete key deletes %s"
6785 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6786 "forward" "backward")))))
6787 \f
6788 (defvar vis-mode-saved-buffer-invisibility-spec nil
6789 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6791 (define-minor-mode visible-mode
6792 "Toggle making all invisible text temporarily visible (Visible mode).
6793 With a prefix argument ARG, enable Visible mode if ARG is
6794 positive, and disable it otherwise. If called from Lisp, enable
6795 the mode if ARG is omitted or nil.
6797 This mode works by saving the value of `buffer-invisibility-spec'
6798 and setting it to nil."
6799 :lighter " Vis"
6800 :group 'editing-basics
6801 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6802 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6803 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6804 (when visible-mode
6805 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6806 buffer-invisibility-spec)
6807 (setq buffer-invisibility-spec nil)))
6808 \f
6809 ;; Minibuffer prompt stuff.
6811 ;;(defun minibuffer-prompt-modification (start end)
6812 ;; (error "You cannot modify the prompt"))
6813 ;;
6814 ;;
6815 ;;(defun minibuffer-prompt-insertion (start end)
6816 ;; (let ((inhibit-modification-hooks t))
6817 ;; (delete-region start end)
6818 ;; ;; Discard undo information for the text insertion itself
6819 ;; ;; and for the text deletion.above.
6820 ;; (when (consp buffer-undo-list)
6821 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6822 ;; (message "You cannot modify the prompt")))
6823 ;;
6824 ;;
6825 ;;(setq minibuffer-prompt-properties
6826 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6827 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6829 \f
6830 ;;;; Problematic external packages.
6832 ;; rms says this should be done by specifying symbols that define
6833 ;; versions together with bad values. This is therefore not as
6834 ;; flexible as it could be. See the thread:
6835 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6836 (defconst bad-packages-alist
6837 ;; Not sure exactly which semantic versions have problems.
6838 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6840 "The version of `semantic' loaded does not work in Emacs 22.
6841 It can cause constant high CPU load.
6842 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6843 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6844 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6845 ;; provided the `CUA-mode' feature. Since this is no longer true,
6846 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6847 (CUA-mode t nil
6848 "CUA-mode is now part of the standard GNU Emacs distribution,
6849 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6851 You have loaded an older version of CUA-mode which does not work
6852 correctly with this version of Emacs. You should remove the old
6853 version and use the one distributed with Emacs."))
6854 "Alist of packages known to cause problems in this version of Emacs.
6855 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6856 PACKAGE is either a regular expression to match file names, or a
6857 symbol (a feature name); see the documentation of
6858 `after-load-alist', to which this variable adds functions.
6859 SYMBOL is either the name of a string variable, or `t'. Upon
6860 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6861 warning using STRING as the message.")
6863 (defun bad-package-check (package)
6864 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6865 (condition-case nil
6866 (let* ((list (assoc package bad-packages-alist))
6867 (symbol (nth 1 list)))
6868 (and list
6869 (boundp symbol)
6870 (or (eq symbol t)
6871 (and (stringp (setq symbol (eval symbol)))
6872 (string-match-p (nth 2 list) symbol)))
6873 (display-warning package (nth 3 list) :warning)))
6874 (error nil)))
6876 (mapc (lambda (elem)
6877 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6878 bad-packages-alist)
6881 (provide 'simple)
6883 ;;; simple.el ends here