| blob | af6d855d9c0dea626e5e284ce8e1dc96e79763e0 |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985-1987, 1993-2011 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 When turned on, cursor motion in the compilation, grep, occur or diff
325 buffer causes automatic display of the corresponding source code
326 location."
333 ;; Used as a `post-command-hook' by `next-error-follow-mode'
334 ;; for the *Compilation* *grep* and *Occur* buffers.
344 \f
345 ;;;
348 "Major mode not specialized for anything in particular.
349 Other major modes are defined by comparison with this one."
354 ;; Special major modes to view specially formatted data rather than files.
368 map))
372 "Parent major mode from which special major modes should inherit."
375 ;; Major mode meant to be the parent of programming modes.
380 map)
384 "Indent the expression after point."
391 "Major mode for editing programming language source code."
394 ;; Any programming language is always written left to right.
397 ;; Making and deleting lines.
403 "Insert a newline, and move to left margin of the new line if it's blank.
404 If `use-hard-newlines' is non-nil, the newline is marked with the
405 text-property `hard'.
406 With ARG, insert that many newlines.
407 Call `auto-fill-function' if the current column number is greater
408 than the value of `fill-column' and ARG is nil."
411 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
412 ;; Set last-command-event to tell self-insert what to insert.
416 ;; Don't auto-fill if we have a numeric argument.
419 ;; Do the rest in post-self-insert-hook, because we want to do it
420 ;; *before* other functions on that hook.
422 ;; Mark the newline(s) `hard'.
426 ;; If the newline leaves the previous line blank, and we
427 ;; have a left margin, delete that from the blank line.
435 ;; Indent the line after the newline, except in one case:
436 ;; when we added the newline at the beginning of a line which
437 ;; starts a page.
444 ;; We first used let-binding to protect the hook, but that was naive
445 ;; since add-hook affects the symbol-default value of the variable,
446 ;; whereas the let-binding might only protect the buffer-local value.
448 nil)
453 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
459 "Insert a newline and leave point before it.
460 If there is a fill prefix and/or a `left-margin', insert them
461 on the new line if the line would have been blank.
462 With arg N, insert N newlines."
467 ;; Don't expand an abbrev before point.
481 "Split current line, moving portion beyond point vertically down.
482 If the current line starts with `fill-prefix', insert it on the new
483 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
485 When called from Lisp code, ARG may be a prefix string to copy."
490 ;; What prefix should we check for (nil means don't).
494 ;; Does this line start with it?
505 "Join this line to previous and fix up whitespace at join.
506 If there is a fill prefix, delete it from the beginning of this line.
507 With argument, join this line to following line."
514 ;; If the second line started with the fill prefix,
515 ;; delete the prefix.
527 "On blank line, delete all surrounding blank lines, leaving just one.
528 On isolated blank line, delete that one.
529 On nonblank line, delete any immediately following blank lines."
535 ;; Set singleblank if there is just one blank line here.
542 ;; Delete preceding blank lines, and this one too if it's the only one.
551 ;; Delete following blank lines, unless the current line is blank
552 ;; and there are no following blank lines.
561 ;; Handle the special case where point is followed by newline and eob.
562 ;; Delete the line, leaving point at eob.
567 "Delete all the trailing whitespace across the current buffer.
568 All whitespace after the last non-whitespace character in a line is deleted.
570 A formfeed is not considered whitespace by this function.
571 If END is nil, also delete all trailing lines at the end of the buffer.
572 If the region is active, only delete whitespace within the region."
585 ;; Don't delete formfeeds, even if they are considered whitespace.
589 ;; Delete trailing empty lines.
592 ;; Really the end of buffer.
597 ;; Return nil for the benefit of `write-file-functions'.
598 nil)
601 "Insert a newline, then indent according to major mode.
602 Indentation is done using the value of `indent-line-function'.
603 In programming language modes, this is the same as TAB.
604 In some text modes, where TAB inserts a tab, this command indents to the
605 column specified by the function `current-left-margin'."
612 "Reindent current line, insert newline, then indent the new line.
613 Indentation of both lines is done according to the current major mode,
614 which means calling the current value of `indent-line-function'.
615 In programming language modes, this is the same as TAB.
616 In some text modes, where TAB inserts a tab, this indents to the
617 column specified by the function `current-left-margin'."
620 ;; Be careful to insert the newline before indenting the line.
621 ;; Otherwise, the indentation might be wrong.
625 ;; We are at EOL before the call to indent-according-to-mode, and
626 ;; after it we usually are as well, but not always. We tried to
627 ;; address it with `save-excursion' but that uses a normal marker
628 ;; whereas we need `move after insertion', so we do the save/restore
629 ;; by hand.
633 ;; Remove the trailing white-space after indentation because
634 ;; indentation may introduce the whitespace.
639 "Read next input character and insert it.
640 This is useful for inserting control characters.
641 With argument, insert ARG copies of the character.
643 If the first character you type after this command is an octal digit,
644 you should type a sequence of octal digits which specify a character code.
645 Any nondigit terminates the sequence. If the terminator is a RET,
646 it is discarded; any other terminator is used itself as input.
647 The variable `read-quoted-char-radix' specifies the radix for this feature;
648 set it to 10 or 16 to use decimal or hex instead of octal.
650 In overwrite mode, this function inserts the character anyway, and
651 does not handle octal digits specially. This means that if you use
652 overwrite as your normal editing mode, you can use this function to
653 insert characters when necessary.
655 In binary overwrite mode, this function does overwrite, and octal
656 digits are interpreted as a character code. This is intended to be
657 useful for editing binary files."
660 ;; Avoid "obsolete" warnings for translation-table-for-input.
667 ;; This used to assume character codes 0240 - 0377 stand for
668 ;; characters in some single-byte character set, and converted them
669 ;; to Emacs characters. But in 23.1 this feature is deprecated
670 ;; in favor of inserting the corresponding Unicode characters.
671 ;; (if (and enable-multibyte-characters
672 ;; (>= char ?\240)
673 ;; (<= char ?\377))
674 ;; (setq char (unibyte-char-to-multibyte char)))
683 "Move forward ARG lines and position at first nonblank character."
689 "Move backward ARG lines and position at first nonblank character."
695 "Move point to the first non-whitespace character on this line."
699 ;; Move back over chars that have whitespace syntax but have the p flag.
703 "Fixup white space between objects around point.
704 Leave one space or none, according to the context."
711 nil
715 "Delete all spaces and tabs around point.
716 If BACKWARD-ONLY is non-nil, only delete them before point."
721 orig-pos
730 "Delete all spaces and tabs around point, leaving one space (or N spaces).
731 If N is negative, delete newlines as well."
748 \f
750 "Move point to the beginning of the buffer.
751 With numeric arg N, put point N/10 of the way from the beginning.
752 If the buffer is narrowed, this command uses the beginning of the
753 accessible part of the buffer.
755 If Transient Mark mode is disabled, leave mark at previous
758 Don't use this command in Lisp programs!
759 \(goto-char (point-min)) is faster."
768 ;; Avoid overflow for large buffer sizes!
776 "Move point to the end of the buffer.
777 With numeric arg N, put point N/10 of the way from the end.
778 If the buffer is narrowed, this command uses the end of the
779 accessible part of the buffer.
781 If Transient Mark mode is disabled, leave mark at previous
784 Don't use this command in Lisp programs!
785 \(goto-char (point-max)) is faster."
792 ;; Avoid overflow for large buffer sizes!
797 ;; If we went to a place in the middle of the buffer,
798 ;; adjust it to the beginning of a line.
801 ;; If the end of the buffer is not already on the screen,
802 ;; then scroll specially to put it near, but not at, the bottom.
807 "Whether single-char deletion commands delete an active region.
808 This has an effect only if Transient Mark mode is enabled, and
809 affects `delete-forward-char' and `delete-backward-char', though
810 not `delete-char'.
812 If the value is the symbol `kill', the active region is killed
813 instead of deleted."
821 "Delete the previous N characters (following if N is negative).
822 If Transient Mark mode is enabled, the mark is active, and N is 1,
823 delete the text in the region and deactivate the mark instead.
824 To disable this, set `delete-active-region' to nil.
826 Optional second arg KILLFLAG, if non-nil, means to kill (save in
827 kill ring) instead of delete. Interactively, N is the prefix
828 arg, and KILLFLAG is set if N is explicitly specified.
830 In Overwrite mode, single character backward deletion may replace
831 tabs with spaces so as to back over columns, unless point is at
832 the end of the line."
837 delete-active-region
839 ;; If a region is active, kill or delete it.
843 ;; In Overwrite mode, maybe untabify while deleting
853 ;; Otherwise, do simple deletion.
857 "Delete the following N characters (previous if N is negative).
858 If Transient Mark mode is enabled, the mark is active, and N is 1,
859 delete the text in the region and deactivate the mark instead.
860 To disable this, set `delete-active-region' to nil.
862 Optional second arg KILLFLAG non-nil means to kill (save in kill
863 ring) instead of delete. Interactively, N is the prefix arg, and
864 KILLFLAG is set if N was explicitly specified."
869 delete-active-region
871 ;; If a region is active, kill or delete it.
875 ;; Otherwise, do simple deletion.
879 "Put point at beginning and mark at end of buffer.
880 You probably should not use this function in Lisp programs;
881 it is usually a mistake for a Lisp function to use any subroutine
882 that uses or sets the mark."
887 \f
889 ;; Counting lines, one way or another.
892 "Goto LINE, counting from line 1 at beginning of buffer.
893 Normally, move point in the current buffer, and leave mark at the
895 move point in the most recently selected other buffer, and switch to it.
897 If there's a number in the buffer at point, it is the default for LINE.
899 This function is usually the wrong thing to use in a Lisp program.
900 What you probably want instead is something like:
901 (goto-char (point-min)) (forward-line (1- N))
902 If at all possible, an even better solution is to use char counts
903 rather than line counts."
907 ;; Look for a default, a number in the buffer at point.
917 ;; Decide if we're switching buffers.
925 ;; Read the argument, offering that number (if any) as default.
928 buffer-prompt
929 default)
930 default)
931 buffer))))
932 ;; Switch to the desired buffer, one way or another.
937 ;; Leave mark at previous position
939 ;; Move to the specified line number in that buffer.
948 "Return the number of words between START and END.
949 If called interactively, print a message reporting the number of
950 lines, words, and characters in the region."
962 words
964 words))
967 "Display the number of lines, words, and characters in the buffer.
968 In Transient Mark mode when the mark is active, display the
969 number of lines, words, and characters in the region."
982 str
990 "Print the current buffer line number and narrowed line number of point."
1003 "Return number of lines between START and END.
1004 This is usually the number of newlines between them,
1005 but can be one more if START is not equal to END
1006 and the greater of them is not at the start of a line."
1022 done)))
1026 "Return (narrowed) buffer line number at position POS.
1027 If POS is nil, use current buffer location.
1028 Counting starts at (point-min), so the value refers
1029 to the contents of the accessible portion of the buffer."
1039 "Print info on cursor position (on screen and within buffer).
1040 Also describe the character after point, and give its character code
1041 in octal, decimal and hex.
1043 For a non-ASCII multibyte character, also give its encoding in the
1044 buffer's selected coding system if the coding system encodes the
1045 character safely. If the character is encoded into one byte, that
1046 code is shown in hex. If the character is encoded into more than one
1049 In addition, with prefix argument, show details about that character
1050 in *Help* buffer. See also the command `describe-char'."
1058 ;; Avoid overflow from multiplying by 100!
1062 ""
1068 pos total percent beg end col hscroll)
1070 pos total col hscroll))
1072 encoded encoding-msg display-prop under-display)
1079 ;; Check if the character is displayed with some `display'
1080 ;; text property. In that case, set under-display to the
1081 ;; buffer substring covered by that property.
1092 under-display)))
1098 char char char under-display)
1100 char char char under-display display-prop))
1103 char char char
1105 "..."
1109 ;; We show the detailed information about CHAR.
1116 encoding-msg pos total percent beg end col hscroll)
1123 encoding-msg pos total percent col hscroll))))))
1124 \f
1125 ;; Initialize read-expression-map. It is defined at C level.
1128 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1129 ;; too rarely useful.
1139 "The current default value or list of default values in the minibuffer.
1140 The functions `read-from-minibuffer' and `completing-read' bind
1144 "Value for `print-level' while printing value in `eval-expression'.
1145 A value of nil means no limit."
1151 "Value for `print-length' while printing value in `eval-expression'.
1152 A value of nil means no limit."
1158 "If non-nil set `debug-on-error' to t in `eval-expression'.
1159 If nil, don't change the value of `debug-on-error'."
1165 "Format VALUE as a result of evaluated expression.
1166 Return a formatted string which is displayed in the echo area
1167 in addition to the value printed by prin1 in functions which
1168 display the result of expression evaluation."
1181 ;; We define this, rather than making `eval' interactive,
1182 ;; for the sake of completion of names like eval-region, eval-buffer.
1185 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1186 When called interactively, read an Emacs Lisp expression and
1187 evaluate it.
1188 Value is also consed on to front of the variable `values'.
1189 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1190 with prefix argument) means insert the result into the current buffer
1191 instead of printing it in the echo area. Truncates long output
1192 according to the value of the variables `eval-expression-print-length'
1193 and `eval-expression-print-level'.
1195 If `eval-expression-debug-on-error' is non-nil, which is the default,
1196 this command arranges for all errors to enter the debugger."
1200 nil read-expression-map t
1202 current-prefix-arg))
1207 ;; Bind debug-on-error to something unique so that we can
1208 ;; detect when evaled code changes it.
1212 ;; If evaled code has changed the value of debug-on-error,
1213 ;; propagate that change to the global binding.
1229 "Prompting with PROMPT, let user edit COMMAND and eval result.
1230 COMMAND is a Lisp expression. Let user edit that expression in
1231 the minibuffer, then read and evaluate the result."
1238 read-expression-map t
1240 ;; If command was added to command-history as a string,
1241 ;; get rid of that. We want only evaluable expressions there.
1245 ;; If command to be redone does not match front of history,
1246 ;; add it to the history.
1252 "Edit and re-evaluate last complex command, or ARGth from last.
1253 A complex command is one which used the minibuffer.
1254 The command is placed in the minibuffer as a Lisp form for editing.
1255 The result is executed, repeating the command as changed.
1256 If the command has been changed or is not the most recent previous
1257 command it is added to the front of the command history.
1258 You can use the minibuffer history commands \
1260 to get different commands to edit and resubmit."
1263 newcmd)
1275 ;; If command was added to command-history as a
1276 ;; string, get rid of that. We want only
1277 ;; evaluable expressions there.
1281 ;; If command to be redone does not match front of history,
1282 ;; add it to the history.
1291 "Read command name to invoke in `execute-extended-command'."
1296 ;; Get a command name at point in the original buffer
1297 ;; to propose it after M-n.
1301 ;; Read a string, completing from and restricting to the set of
1302 ;; all defined commands. Don't provide any initial input.
1303 ;; Save the command read on the extended-command history list.
1314 ;; This isn't strictly correct if `execute-extended-command'
1315 ;; is bound to anything else (e.g. [menu]).
1316 ;; It could use (key-description (this-single-command-keys)),
1317 ;; but actually a prompt other than "M-x" would be confusing,
1318 ;; because "M-x" is a well-known prompt to read a command
1319 ;; and it serves as a shorthand for "Extended command: ".
1323 \f
1325 "Default minibuffer history list.
1326 This is used for all minibuffer input
1327 except when an alternate history list is specified.
1329 Maximum length of the history list is determined by the value
1332 "Control whether history list elements are expressions or strings.
1333 If the value of this variable equals current minibuffer depth,
1334 they are expressions; otherwise they are strings.
1335 \(That convention is designed to do the right thing for
1342 "Text that was in this minibuffer before any history commands.
1343 This is nil if there have not yet been any history commands
1352 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1356 "Minibuffer history variables for which matching should ignore case.
1357 If a history variable is a member of this list, then the
1359 commands ignore case when searching it, regardless of `case-fold-search'."
1364 "Find the previous history element that matches REGEXP.
1365 \(Previous history elements refer to earlier actions.)
1366 With prefix argument N, search for Nth previous match.
1367 If N is negative, find the next or Nth next match.
1368 Normally, history elements are matched case-insensitively if
1369 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1370 makes the search case-sensitive.
1371 See also `minibuffer-history-case-insensitive-variables'."
1375 nil
1376 minibuffer-local-map
1377 nil
1378 'minibuffer-history-search-history
1380 ;; Use the last regexp specified, by default, if input is empty.
1385 regexp)
1395 ;; On some systems, ignore case for file names.
1397 minibuffer-history-case-insensitive-variables)
1398 t
1399 ;; Respect the user's setting for case-fold-search:
1400 case-fold-search)
1401 nil))
1402 prevpos
1403 match-string
1404 match-offset
1411 "No later matching history item"
1432 next-matching-history-element))
1436 "Find the next history element that matches REGEXP.
1437 \(The next history element refers to a more recent action.)
1438 With prefix argument N, search for Nth next match.
1439 If N is negative, find the previous or Nth previous match.
1440 Normally, history elements are matched case-insensitively if
1441 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1442 makes the search case-sensitive."
1446 nil
1447 minibuffer-local-map
1448 nil
1449 'minibuffer-history-search-history
1451 ;; Use the last regexp specified, by default, if input is empty.
1456 regexp)
1463 "Function run by `goto-history-element' before consuming default values.
1464 This is useful to dynamically add more elements to the list of default values
1465 when `goto-history-element' reaches the end of this list.
1466 Before calling this function `goto-history-element' sets the variable
1467 `minibuffer-default-add-done' to t, so it will call this function only
1468 once. In special cases, when this function needs to be called more
1469 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1473 "When nil, add more elements to the end of the list of default values.
1474 The value nil causes `goto-history-element' to add more elements to
1475 the list of defaults when it reaches the end of this list. It does
1481 "Return a list of all completions without the default value.
1482 This function is used to add all elements of the completion table to
1483 the end of the list of defaults just after the default value."
1486 minibuffer-completion-table
1487 minibuffer-completion-predicate)))
1493 "Puts element of the minibuffer history in the minibuffer.
1494 The argument NABS specifies the absolute history position."
1508 elt minibuffer-returned-to-present)
1520 previous-history-element))
1532 minibuffer-default)))
1544 elt))
1548 "Puts next element of the minibuffer history in the minibuffer.
1549 With argument N, it uses the Nth following element."
1555 "Puts previous element of the minibuffer history in the minibuffer.
1556 With argument N, it uses the Nth previous element."
1562 "Get next history element which completes the minibuffer before the point.
1563 The contents of the minibuffer after the point are deleted, and replaced
1564 by the new completion."
1570 n)
1571 ;; next-matching-history-element always puts us at (point-min).
1572 ;; Move to the position we were at before changing the buffer contents.
1573 ;; This is still sensical, because the text before point has not changed.
1577 "\
1578 Get previous history element which completes the minibuffer before the point.
1579 The contents of the minibuffer after the point are deleted, and replaced
1580 by the new completion."
1584 ;; For compatibility with the old subr of the same name.
1586 "Return the display width of the minibuffer prompt.
1587 Return 0 if current buffer is not a minibuffer."
1588 ;; Return the width of everything before the field at the end of
1589 ;; the buffer; this should be 0 for normal buffers.
1591 \f
1592 ;; isearch minibuffer history
1599 "Set up a minibuffer for using isearch to search the minibuffer history.
1600 Intended to be added to `minibuffer-setup-hook'."
1612 "Clean up the minibuffer after terminating isearch in the minibuffer."
1617 "Return the proper search function, for isearch in minibuffer history."
1624 ;; Use standard functions to search within minibuffer text
1630 found)
1631 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1632 ;; searching forward. Lazy-highlight calls this lambda with the
1633 ;; bound arg, so skip the minibuffer prompt.
1637 ;; 1. First try searching in the initial minibuffer text
1640 noerror)
1641 ;; 2. If the above search fails, start putting next/prev history
1642 ;; elements in the minibuffer successively, and search the string
1643 ;; in them. Do this only when bound is nil (i.e. not while
1644 ;; lazy-highlighting search strings in the current minibuffer text).
1656 ;; After putting the next/prev history element, search
1657 ;; the string in them again, until next-history-element
1658 ;; or previous-history-element raises an error at the
1659 ;; beginning/end of history.
1662 ;; For backward search, don't search
1663 ;; in the minibuffer prompt
1665 noerror)))
1666 ;; Return point of the new search result
1668 ;; Return nil when next(prev)-history-element fails
1672 "Display the minibuffer history search prompt.
1673 If there are no search errors, this function displays an overlay with
1674 the isearch prompt which replaces the original minibuffer prompt.
1675 Otherwise, it displays the standard isearch message returned from
1676 `isearch-message'."
1678 ;; Use standard function `isearch-message' when not in the minibuffer,
1679 ;; or search fails, or has an error (like incomplete regexp).
1680 ;; This function overwrites minibuffer text with isearch message,
1681 ;; so it's possible to see what is wrong in the search string.
1683 ;; Otherwise, put the overlay with the standard isearch prompt over
1684 ;; the initial minibuffer prompt.
1693 ;; And clear any previous isearch message.
1697 "Wrap the minibuffer history search when search fails.
1698 Move point to the first history element for a forward search,
1699 or to the last history element for a backward search."
1701 ;; When `minibuffer-history-isearch-search' fails on reaching the
1702 ;; beginning/end of the history, wrap the search to the first/last
1703 ;; minibuffer history element.
1711 "Save a function restoring the state of minibuffer history search.
1712 Save `minibuffer-history-position' to the additional state parameter
1713 in the search status stack."
1718 "Restore the minibuffer history search state.
1719 Go to the history element by the absolute history position HIST-POS."
1722 \f
1723 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1727 "Table mapping redo records to the corresponding undo one.
1728 A redo record for undo-in-region maps to t.
1738 "Within a run of consecutive undo commands, list remaining to be undone.
1742 "Undo some previous changes.
1743 Repeat this command to undo more changes.
1744 A numeric ARG serves as a repeat count.
1746 In Transient Mark mode when the mark is active, only undo changes within
1748 as an argument limits undo to changes within the current region."
1750 ;; Make last-command indicate for the next command that this was an undo.
1751 ;; That way, another undo will undo more.
1752 ;; If we get to the end of the undo history and get an error,
1753 ;; another undo command will find the undo history empty
1754 ;; and will get another error. To begin undoing the undos,
1755 ;; you must type some other command.
1758 message)
1759 ;; If we get an error in undo-start,
1760 ;; the next command should not be a "consecutive undo".
1761 ;; So set `this-command' to something other than `undo'.
1766 ;; If something (a timer or filter?) changed the buffer
1767 ;; since the previous command, don't continue the undo seq.
1771 ;; If the last undo record made was made by undo
1772 ;; it shows nothing else happened in between.
1779 ;; get rid of initial undo boundary
1781 ;; If we got this far, the next command should be a consecutive undo.
1783 ;; Check to see whether we're hitting a redo record, and if
1784 ;; so, ask the user whether she wants to skip the redo/undo pair.
1791 ;; The equiv entry might point to another redo record if we have done
1792 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1800 ;; Record the fact that the just-generated undo records come from an
1801 ;; undo operation--that is, they are redo records.
1802 ;; In the ordinary case (not within a region), map the redo
1803 ;; record to the following undos.
1804 ;; I don't know how to do that in the undo-in-region case.
1806 ;; Strip any leading undo boundaries there might be, like we do
1807 ;; above when checking.
1811 undo-equiv-table))
1812 ;; Don't specify a position in the undo record for the undo command.
1813 ;; Instead, undoing this should move point to where the change is.
1832 ;; Record what the current undo list says,
1833 ;; so the next command can tell if the buffer was modified in between.
1836 ;; Display a message announcing success.
1841 "Make BUFFER stop keeping undo information.
1842 No argument or nil as argument means do this for the current buffer."
1848 "Undo some previous changes.
1849 Repeat this command to undo more changes.
1850 A numeric ARG serves as a repeat count.
1851 Contrary to `undo', this will not redo a previous undo."
1856 "Non-nil while performing an undo.
1860 "Undo back N undo-boundaries beyond what was already undone recently.
1861 Call `undo-start' to get ready to undo recent changes,
1862 then call `undo-more' one or more times to undo them."
1867 ;; Note: The following, while pulling elements off
1868 ;; `pending-undo-list' will call primitive change functions which
1869 ;; will push more elements onto `buffer-undo-list'.
1874 ;; Deep copy of a list
1876 "Make a copy of undo list LIST."
1882 elt))
1885 "Set `pending-undo-list' to the front of the undo list.
1886 The next call to `undo-more' will undo the most recently made change.
1887 If BEG and END are specified, then only undo elements
1888 that apply to text between BEG and END are used; other undo elements
1889 are ignored. If BEG and END are nil, all undo elements are used."
1895 buffer-undo-list)))
1900 "Return a list of undo elements for the region START to END.
1901 The elements come from `buffer-undo-list', but we keep only
1902 the elements inside this region, and discard those outside this region.
1903 If we find an element that crosses an edge of this region,
1904 we stop and ignore all further elements."
1907 undo-adjusted-markers
1908 some-rejected
1909 undo-elt temp-undo-list delta)
1914 ;; This is a "was unmodified" element.
1915 ;; Keep it if we have kept everything thus far.
1922 ;; Don't put two nils together in the list
1936 ;; Loop down the earlier events adjusting their buffer
1937 ;; positions to reflect the fact that a change to the buffer
1938 ;; isn't being undone. We only need to process those element
1939 ;; types which undo-elt-in-region will return as being in
1940 ;; the region since only those types can ever get into the
1941 ;; output
1950 ;; (TEXT . POSITION)
1957 ;; (BEGIN . END)
1962 ;; (nil PROPERTY VALUE BEG . END)
1972 "Determine whether UNDO-ELT falls inside the region START ... END.
1973 If it crosses the edge, we return nil."
1978 t)
1980 nil)
1982 ;; (TEXT . POSITION)
1986 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1987 ;; See if MARKER is inside the region.
1998 ;; (nil PROPERTY VALUE BEG . END)
2003 ;; (BEGIN . END)
2008 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2009 This assumes we have already decided that UNDO-ELT
2010 is not *inside* the region START...END."
2013 ;; (nil PROPERTY VALUE BEG . END)
2018 ;; (BEGIN . END)
2022 ;; Return the first affected buffer position and the delta for an undo element
2023 ;; delta is defined as the change in subsequent buffer positions if we *did*
2024 ;; the undo.
2028 ;; (TEXT . POSITION)
2031 ;; (BEGIN . END)
2038 "If non-nil ask about discarding undo info for the current command.
2039 Normally, Emacs discards the undo info for the current command if
2040 it exceeds `undo-outer-limit'. But if you set this option
2041 non-nil, it asks in the echo area whether to discard the info.
2042 If you answer no, there is a slight risk that Emacs might crash, so
2043 only do it if you really want to undo the command.
2045 This option is mainly intended for debugging. You have to be
2046 careful if you use it for other purposes. Garbage collection is
2047 inhibited while the question is asked, meaning that Emacs might
2048 leak memory. So you should make sure that you do not wait
2049 excessively long before answering the question."
2055 "If non-nil, an extra level of size that's ok in an undo item.
2056 We don't ask the user about truncating the undo list until the
2057 current item gets bigger than this amount.
2062 ;; When the first undo batch in an undo list is longer than
2063 ;; undo-outer-limit, this function gets called to warn the user that
2064 ;; the undo info for the current command was discarded. Garbage
2065 ;; collection is inhibited around the call, so it had better not do a
2066 ;; lot of consing.
2072 ;; Don't ask the question again unless it gets even bigger.
2073 ;; This applies, in particular, if the user quits from the question.
2074 ;; Such a quit quits out of GC, but something else will call GC
2075 ;; again momentarily. It will call this function again,
2076 ;; but we don't want to ask the question again.
2083 t)
2084 nil))
2089 "The undo info was discarded because it exceeded \
2090 `undo-outer-limit'.
2092 This is normal if you executed a command that made a huge change
2093 to the buffer. In that case, to prevent similar problems in the
2094 future, set `undo-outer-limit' to a value that is large enough to
2095 cover the maximum size of normal changes you expect a single
2096 command to make, but not so large that it might exceed the
2097 maximum memory allotted to Emacs.
2099 If you did not execute any such command, the situation is
2100 probably due to a bug and you should report it.
2102 You can disable the popping up of this buffer by adding the entry
2103 \(undo discard-info) to the user option `warning-suppress-types',
2107 t))
2108 \f
2110 "History list for some commands that read shell commands.
2112 Maximum length of the history list is determined by the value
2119 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2120 This buffer is used when `shell-command' or `shell-command-on-region'
2121 is run interactively. A value of nil means that output to stderr and
2128 "Return a list of all commands associated with the current file.
2129 This function is used to add all related commands retrieved by `mailcap'
2130 to the end of the list of defaults just after the default value."
2134 minibuffer-default))
2139 commands))
2150 map)
2154 "Read a shell command from the minibuffer.
2155 The arguments are the same as the ones of `read-from-minibuffer',
2156 except READ and KEYMAP are missing and HIST defaults
2157 to `shell-command-history'."
2165 minibuffer-local-shell-command-map
2166 nil
2168 args)))
2171 "Execute string COMMAND asynchronously in background.
2173 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2174 surrounded by whitespace and executes the command asynchronously.
2175 The output appears in the buffer `*Async Shell Command*'.
2177 In Elisp, you will often be better served by calling `start-process'
2178 directly, since it offers more control and does not impose the use of a
2179 shell (with its need to quote arguments)."
2185 current-prefix-arg
2186 shell-command-default-error-buffer))
2192 "Execute string COMMAND in inferior shell; display output, if any.
2193 With prefix argument, insert the COMMAND's output at point.
2195 If COMMAND ends in ampersand, execute it asynchronously.
2196 The output appears in the buffer `*Async Shell Command*'.
2197 That buffer is in shell mode.
2199 Otherwise, COMMAND is executed synchronously. The output appears in
2200 the buffer `*Shell Command Output*'. If the output is short enough to
2201 display in the echo area (which is determined by the variables
2202 `resize-mini-windows' and `max-mini-window-height'), it is shown
2203 there, but it is nonetheless available in buffer `*Shell Command
2204 Output*' even though that buffer is not automatically displayed.
2206 To specify a coding system for converting non-ASCII characters
2208 before this command.
2210 Noninteractive callers can specify coding systems by binding
2211 `coding-system-for-read' and `coding-system-for-write'.
2213 The optional second argument OUTPUT-BUFFER, if non-nil,
2214 says to put the output in some other buffer.
2215 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2216 If OUTPUT-BUFFER is not a buffer and not nil,
2217 insert output in current buffer. (This cannot be done asynchronously.)
2218 In either case, the buffer is first erased, and the output is
2219 inserted after point (leaving mark after it).
2221 If the command terminates without error, but generates output,
2223 the output can be displayed in the echo area or in its buffer.
2224 If the output is short enough to display in the echo area
2225 \(determined by the variable `max-mini-window-height' if
2226 `resize-mini-windows' is non-nil), it is shown there.
2227 Otherwise,the buffer containing the output is displayed.
2231 of the output.
2233 If there is no output, or if output is inserted in the current buffer,
2234 then `*Shell Command Output*' is deleted.
2236 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2237 or buffer name to which to direct the command's standard error output.
2238 If it is nil, error output is mingled with regular output.
2239 In an interactive call, the variable `shell-command-default-error-buffer'
2240 specifies the value of ERROR-BUFFER.
2242 In Elisp, you will often be better served by calling `call-process' or
2243 `start-process' directly, since it offers more control and does not impose
2244 the use of a shell (with its need to quote arguments)."
2255 current-prefix-arg
2256 shell-command-default-error-buffer))
2257 ;; Look for a handler in case default-directory is a remote file name.
2265 ;; Output goes in current buffer.
2271 temporary-file-directory)))
2272 nil)))
2275 ;; We do not use -f for csh; we will not support broken use of
2276 ;; .cshrcs. Even the BSD csh manual says to use
2277 ;; "if ($?prompt) exit" before things which are not useful
2278 ;; non-interactively. Besides, if someone wants their other
2279 ;; aliases for shell commands then they can still have them.
2283 t)
2284 nil shell-command-switch command)
2291 ;; Do no formatting while reading error file,
2292 ;; because that can run a shell command, and we
2293 ;; don't want that to cause an infinite recursion.
2295 ;; Put point after the inserted errors.
2299 ;; This is like exchange-point-and-mark, but doesn't
2300 ;; activate the mark. It is cleaner to avoid activation,
2301 ;; even though the command loop would deactivate the mark
2302 ;; because we inserted text.
2306 ;; Output goes in a separate buffer.
2307 ;; Preserve the match data in case called from a program.
2310 ;; Command ending with ampersand means asynchronous.
2314 proc)
2315 ;; Remove the ampersand.
2317 ;; If will kill a process, query first.
2325 ;; Setting buffer-read-only to nil doesn't suffice
2326 ;; if some text has a non-nil read-only property,
2327 ;; which comint sometimes adds for prompts.
2333 shell-command-switch command))
2337 ;; Use the comint filter for proper handling of carriage motion
2338 ;; (see `comint-inhibit-carriage-motion'),.
2340 ))
2341 ;; Otherwise, command is executed synchronously.
2343 output-buffer nil error-buffer)))))))
2347 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2348 MESSAGE may be either a string or a buffer.
2350 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2351 the maximum height of the echo area, as defined by `max-mini-window-height'
2352 if `resize-mini-windows' is non-nil.
2354 Returns either the string shown in the echo area, or when a pop-up
2355 buffer is used, the window used to display it.
2357 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2358 name of the buffer used to display it in the case where a pop-up buffer
2359 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2360 string and it is displayed in the echo area, it is not specified whether
2361 the contents are inserted into the buffer anyway.
2363 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2364 and only used if a buffer is displayed."
2366 ;; Trivial case where we can use the echo area
2370 ;; Trivial case where we can just remove single trailing newline
2373 ;; General case
2376 message
2385 0
2389 (<= lines
2393 max-mini-window-height))
2395 max-mini-window-height)
2399 ;; Don't use the echo area if the output buffer is
2400 ;; already dispayed in the selected frame.
2402 ;; Echo area
2408 ;; Buffer
2411 not-this-window frame))))))))
2414 ;; We have a sentinel to prevent insertion of a termination message
2415 ;; in the buffer itself.
2423 &optional output-buffer replace
2424 error-buffer display-error-buffer)
2425 "Execute string COMMAND in inferior shell with region as input.
2426 Normally display output (if any) in temp buffer `*Shell Command Output*';
2427 Prefix arg means replace the region with it. Return the exit code of
2428 COMMAND.
2430 To specify a coding system for converting non-ASCII characters
2432 before this command. By default, the input (from the current buffer)
2433 is encoded in the same coding system that will be used to save the file,
2434 `buffer-file-coding-system'. If the output is going to replace the region,
2435 then it is decoded from that same coding system.
2437 The noninteractive arguments are START, END, COMMAND,
2438 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2439 Noninteractive callers can specify coding systems by binding
2440 `coding-system-for-read' and `coding-system-for-write'.
2442 If the command generates output, the output may be displayed
2443 in the echo area or in a buffer.
2444 If the output is short enough to display in the echo area
2445 \(determined by the variable `max-mini-window-height' if
2446 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2447 it is displayed in the buffer `*Shell Command Output*'. The output
2448 is available in that buffer in both cases.
2450 If there is output and an error, a message about the error
2451 appears at the end of the output.
2453 If there is no output, or if output is inserted in the current buffer,
2454 then `*Shell Command Output*' is deleted.
2456 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2457 that says to put the output in some other buffer.
2458 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2459 If OUTPUT-BUFFER is not a buffer and not nil,
2460 insert output in the current buffer.
2461 In either case, the output is inserted after point (leaving mark after it).
2463 If REPLACE, the optional fifth argument, is non-nil, that means insert
2464 the output in place of text from START to END, putting point and mark
2465 around it.
2467 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2468 or buffer name to which to direct the command's standard error output.
2469 If it is nil, error output is mingled with regular output.
2470 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2471 were any errors. (This is always t, interactively.)
2472 In an interactive call, the variable `shell-command-default-error-buffer'
2473 specifies the value of ERROR-BUFFER."
2477 ;; Do this before calling region-beginning
2478 ;; and region-end, in case subprocess output
2479 ;; relocates them while we are in the minibuffer.
2481 ;; call-interactively recognizes region-beginning and
2482 ;; region-end specially, leaving them in the history.
2484 string
2485 current-prefix-arg
2486 current-prefix-arg
2487 shell-command-default-error-buffer
2488 t)))
2494 temporary-file-directory)))
2495 nil))
2496 exit-status)
2500 ;; Replace specified region with output from command.
2502 ;; Don't muck with mark unless REPLACE says we should.
2509 t)
2510 nil shell-command-switch command))
2511 ;; It is rude to delete a buffer which the command is not using.
2512 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2513 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2514 ;; (kill-buffer shell-buffer)))
2515 ;; Don't muck with mark unless REPLACE says we should.
2517 ;; No prefix argument: put the output in a temp buffer,
2518 ;; replacing its entire contents.
2523 ;; If the input is the same buffer as the output,
2524 ;; delete everything but the specified region,
2525 ;; then replace that region with the output.
2531 shell-file-name t
2534 t)
2535 nil shell-command-switch
2536 command)))
2537 ;; Clear the output buffer, then run the command with
2538 ;; output there.
2549 buffer)
2550 nil shell-command-switch command)))
2551 ;; Report the output.
2561 ;; There's some output, display it
2563 ;; No output; error?
2570 shell-command-default-error-buffer)
2577 output))
2580 exit-status))
2583 exit-status output))))
2584 ;; Don't kill: there might be useful info in the undo-log.
2585 ;; (kill-buffer buffer)
2586 ))))
2594 ;; Do no formatting while reading error file,
2595 ;; because that can run a shell command, and we
2596 ;; don't want that to cause an infinite recursion.
2598 ;; Put point after the inserted errors.
2603 exit-status))
2606 "Execute shell command COMMAND and return its output as a string."
2609 standard-output
2613 "Process files synchronously in a separate process.
2614 Similar to `call-process', but may invoke a file handler based on
2615 `default-directory'. The current working directory of the
2616 subprocess is `default-directory'.
2618 File names in INFILE and BUFFER are handled normally, but file
2619 names in ARGS should be relative to `default-directory', as they
2620 are passed to the process verbatim. \(This is a difference to
2621 `call-process' which does not support file handlers for INFILE
2622 and BUFFER.\)
2624 Some file handlers might not support all variants, for example
2625 they might behave as if DISPLAY was nil, regardless of the actual
2626 value passed."
2628 lc stderr-file)
2638 display args)
2644 "Whether a call of `process-file' changes remote files.
2646 Per default, this variable is always set to `t', meaning that a
2647 call of `process-file' could potentially change any file on a
2648 remote host. When set to `nil', a file handler could optimize
2649 its behaviour with respect to remote file attributes caching.
2651 This variable should never be changed by `setq'. Instead of, it
2655 "Start a program in a subprocess. Return the process object for it.
2657 Similar to `start-process', but may invoke a file handler based on
2658 `default-directory'. See Info node `(elisp)Magic File Names'.
2660 This handler ought to run PROGRAM, perhaps on the local host,
2661 perhaps on a remote host that corresponds to `default-directory'.
2662 In the latter case, the local part of `default-directory' becomes
2663 the working directory of the process.
2665 PROGRAM and PROGRAM-ARGS might be file names. They are not
2666 objects of file handler invocation. File handlers might not
2667 support pty association, if PROGRAM is nil."
2671 \f
2672 ;;;; Process menu
2684 "Major mode for listing the processes called by Emacs."
2696 "Recompute the list of processes for the Process List buffer."
2707 face link
2710 follow-link t
2711 process-buffer ,buf
2712 action process-menu-visit-buffer)
2721 "datagram"
2736 tabulated-list-entries)))))
2742 "Display a list of all processes.
2743 If optional argument QUERY-ONLY is non-nil, only processes with
2744 the query-on-exit flag set are listed.
2745 Any process listed as exited or signaled is actually eliminated
2746 after the listing is made.
2747 Optional argument BUFFER specifies a buffer to use, instead of
2749 The return value is always nil."
2761 nil)
2762 \f
2766 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2767 (define-key map [switch-frame] nil)
2768 (define-key map [?\C-u] 'universal-argument-more)
2769 (define-key map [?-] 'universal-argument-minus)
2770 (define-key map [?0] 'digit-argument)
2771 (define-key map [?1] 'digit-argument)
2772 (define-key map [?2] 'digit-argument)
2773 (define-key map [?3] 'digit-argument)
2774 (define-key map [?4] 'digit-argument)
2775 (define-key map [?5] 'digit-argument)
2776 (define-key map [?6] 'digit-argument)
2777 (define-key map [?7] 'digit-argument)
2778 (define-key map [?8] 'digit-argument)
2779 (define-key map [?9] 'digit-argument)
2780 (define-key map [kp-0] 'digit-argument)
2781 (define-key map [kp-1] 'digit-argument)
2782 (define-key map [kp-2] 'digit-argument)
2783 (define-key map [kp-3] 'digit-argument)
2784 (define-key map [kp-4] 'digit-argument)
2785 (define-key map [kp-5] 'digit-argument)
2786 (define-key map [kp-6] 'digit-argument)
2787 (define-key map [kp-7] 'digit-argument)
2788 (define-key map [kp-8] 'digit-argument)
2789 (define-key map [kp-9] 'digit-argument)
2790 (define-key map [kp-subtract] 'universal-argument-minus)
2791 map)
2794 (defvar universal-argument-num-events nil
2795 "Number of argument-specifying events read by `universal-argument'.
2796 `universal-argument-other-key' uses this to discard those events
2797 from (this-command-keys), and reread only the final command.")
2799 (defvar saved-overriding-map t
2800 "The saved value of `overriding-terminal-local-map'.
2804 (defun save&set-overriding-map (map)
2805 "Set `overriding-terminal-local-map' to MAP."
2806 (when (eq saved-overriding-map t)
2807 (setq saved-overriding-map overriding-terminal-local-map)
2808 (setq overriding-terminal-local-map map)))
2810 (defun restore-overriding-map ()
2811 "Restore `overriding-terminal-local-map' to its saved value."
2812 (setq overriding-terminal-local-map saved-overriding-map)
2813 (setq saved-overriding-map t))
2815 (defun universal-argument ()
2816 "Begin a numeric argument for the following command.
2821 multiplies the argument by 4 each time.
2823 which is different in effect from any particular numeric argument.
2825 (interactive)
2826 (setq prefix-arg (list 4))
2827 (setq universal-argument-num-events (length (this-command-keys)))
2828 (save&set-overriding-map universal-argument-map))
2830 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2831 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2832 (defun universal-argument-more (arg)
2833 (interactive "P")
2834 (if (consp arg)
2835 (setq prefix-arg (list (* 4 (car arg))))
2836 (if (eq arg '-)
2837 (setq prefix-arg (list -4))
2838 (setq prefix-arg arg)
2839 (restore-overriding-map)))
2840 (setq universal-argument-num-events (length (this-command-keys))))
2842 (defun negative-argument (arg)
2843 "Begin a negative numeric argument for the next command.
2845 (interactive "P")
2846 (cond ((integerp arg)
2847 (setq prefix-arg (- arg)))
2848 ((eq arg '-)
2849 (setq prefix-arg nil))
2850 (t
2851 (setq prefix-arg '-)))
2852 (setq universal-argument-num-events (length (this-command-keys)))
2853 (save&set-overriding-map universal-argument-map))
2855 (defun digit-argument (arg)
2856 "Part of the numeric argument for the next command.
2858 (interactive "P")
2859 (let* ((char (if (integerp last-command-event)
2860 last-command-event
2861 (get last-command-event 'ascii-character)))
2863 (cond ((integerp arg)
2864 (setq prefix-arg (+ (* arg 10)
2865 (if (< arg 0) (- digit) digit))))
2866 ((eq arg '-)
2867 ;; Treat -0 as just -, so that -01 will work.
2868 (setq prefix-arg (if (zerop digit) '- (- digit))))
2869 (t
2870 (setq prefix-arg digit))))
2871 (setq universal-argument-num-events (length (this-command-keys)))
2872 (save&set-overriding-map universal-argument-map))
2874 ;; For backward compatibility, minus with no modifiers is an ordinary
2875 ;; command if digits have already been entered.
2876 (defun universal-argument-minus (arg)
2877 (interactive "P")
2878 (if (integerp arg)
2879 (universal-argument-other-key arg)
2880 (negative-argument arg)))
2882 ;; Anything else terminates the argument and is left in the queue to be
2883 ;; executed as a command.
2884 (defun universal-argument-other-key (arg)
2885 (interactive "P")
2886 (setq prefix-arg arg)
2887 (let* ((key (this-command-keys))
2888 (keylist (listify-key-sequence key)))
2889 (setq unread-command-events
2890 (append (nthcdr universal-argument-num-events keylist)
2891 unread-command-events)))
2892 (reset-this-command-lengths)
2893 (restore-overriding-map))
2894 \f
2896 (defvar filter-buffer-substring-functions nil
2897 "Wrapper hook around `filter-buffer-substring'.
2898 The functions on this special hook are called with 4 arguments:
2899 NEXT-FUN BEG END DELETE
2900 NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2901 that performs the default operation. The other 3 arguments are like
2902 the ones passed to `filter-buffer-substring'.")
2904 (defvar buffer-substring-filters nil
2905 "List of filter functions for `filter-buffer-substring'.
2906 Each function must accept a single argument, a string, and return
2907 a string. The buffer substring is passed to the first function
2908 in the list, and the return value of each function is passed to
2909 the next. The return value of the last function is used as the
2910 return value of `filter-buffer-substring'.
2912 If this variable is nil, no filtering is performed.")
2913 (make-obsolete-variable 'buffer-substring-filters
2914 'filter-buffer-substring-functions "24.1")
2916 (defun filter-buffer-substring (beg end &optional delete)
2917 "Return the buffer substring between BEG and END, after filtering.
2918 The filtering is performed by `filter-buffer-substring-functions'.
2920 If DELETE is non-nil, the text between BEG and END is deleted
2921 from the buffer.
2923 This function should be used instead of `buffer-substring',
2924 `buffer-substring-no-properties', or `delete-and-extract-region'
2925 when you want to allow filtering to take place. For example,
2926 major or minor modes can use `filter-buffer-substring-functions' to
2927 extract characters that are special to a buffer, and should not
2928 be copied into other buffers."
2929 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2930 (cond
2931 ((or delete buffer-substring-filters)
2932 (save-excursion
2933 (goto-char beg)
2934 (let ((string (if delete (delete-and-extract-region beg end)
2935 (buffer-substring beg end))))
2936 (dolist (filter buffer-substring-filters)
2937 (setq string (funcall filter string)))
2938 string)))
2939 (t
2940 (buffer-substring beg end)))))
2943 ;;;; Window system cut and paste hooks.
2945 (defvar interprogram-cut-function nil
2946 "Function to call to make a killed region available to other programs.
2948 Most window systems provide some sort of facility for cutting and
2949 pasting text between the windows of different programs.
2950 This variable holds a function that Emacs calls whenever text
2951 is put in the kill ring, to make the new kill available to other
2952 programs.
2954 The function takes one argument, TEXT, which is a string containing
2955 the text which should be made available.")
2957 (defvar interprogram-paste-function nil
2958 "Function to call to get text cut from other programs.
2960 Most window systems provide some sort of facility for cutting and
2961 pasting text between the windows of different programs.
2962 This variable holds a function that Emacs calls to obtain
2963 text that other programs have provided for pasting.
2965 The function should be called with no arguments. If the function
2966 returns nil, then no other program has provided such text, and the top
2967 of the Emacs kill ring should be used. If the function returns a
2968 string, then the caller of the function \(usually `current-kill')
2969 should put this string in the kill ring as the latest kill.
2971 This function may also return a list of strings if the window
2972 system supports multiple selections. The first string will be
2973 used as the pasted text, but the other will be placed in the
2974 kill ring for easy access via `yank-pop'.
2976 Note that the function should return a string only if a program other
2977 than Emacs has provided a string for pasting; if Emacs provided the
2978 most recent string, the function should return nil. If it is
2979 difficult to tell whether Emacs or some other program provided the
2980 current string, it is probably good enough to return nil if the string
2981 is equal (according to `string=') to the last text Emacs provided.")
2982 \f
2985 ;;;; The kill ring data structure.
2987 (defvar kill-ring nil
2988 "List of killed text sequences.
2989 Since the kill ring is supposed to interact nicely with cut-and-paste
2990 facilities offered by window systems, use of this variable should
2991 interact nicely with `interprogram-cut-function' and
2992 `interprogram-paste-function'. The functions `kill-new',
2993 `kill-append', and `current-kill' are supposed to implement this
2994 interaction; you may want to use them instead of manipulating the kill
2995 ring directly.")
2997 (defcustom kill-ring-max 60
2998 "Maximum length of kill ring before oldest elements are thrown away."
2999 :type 'integer
3000 :group 'killing)
3002 (defvar kill-ring-yank-pointer nil
3003 "The tail of the kill ring whose car is the last thing yanked.")
3005 (defcustom save-interprogram-paste-before-kill nil
3006 "Save clipboard strings into kill ring before replacing them.
3007 When one selects something in another program to paste it into Emacs,
3008 but kills something in Emacs before actually pasting it,
3009 this selection is gone unless this variable is non-nil,
3010 in which case the other program's selection is saved in the `kill-ring'
3012 :type 'boolean
3013 :group 'killing
3014 :version "23.2")
3016 (defcustom kill-do-not-save-duplicates nil
3017 "Do not add a new string to `kill-ring' when it is the same as the last one."
3018 :type 'boolean
3019 :group 'killing
3020 :version "23.2")
3022 (defun kill-new (string &optional replace yank-handler)
3023 "Make STRING the latest kill in the kill ring.
3024 Set `kill-ring-yank-pointer' to point to it.
3025 If `interprogram-cut-function' is non-nil, apply it to STRING.
3026 Optional second argument REPLACE non-nil means that STRING will replace
3027 the front of the kill ring, rather than being added to the list.
3029 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3030 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3031 STRING.
3033 When the yank handler has a non-nil PARAM element, the original STRING
3034 argument is not used by `insert-for-yank'. However, since Lisp code
3035 may access and use elements from the kill ring directly, the STRING
3037 (if (> (length string) 0)
3038 (if yank-handler
3039 (put-text-property 0 (length string)
3040 'yank-handler yank-handler string))
3041 (if yank-handler
3042 (signal 'args-out-of-range
3043 (list string "yank-handler specified for empty string"))))
3044 (unless (and kill-do-not-save-duplicates
3045 (equal string (car kill-ring)))
3046 (if (fboundp 'menu-bar-update-yank-menu)
3047 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3048 (when save-interprogram-paste-before-kill
3049 (let ((interprogram-paste (and interprogram-paste-function
3050 (funcall interprogram-paste-function))))
3051 (when interprogram-paste
3052 (dolist (s (if (listp interprogram-paste)
3053 (nreverse interprogram-paste)
3054 (list interprogram-paste)))
3055 (unless (and kill-do-not-save-duplicates
3056 (equal s (car kill-ring)))
3057 (push s kill-ring))))))
3058 (unless (and kill-do-not-save-duplicates
3059 (equal string (car kill-ring)))
3060 (if (and replace kill-ring)
3061 (setcar kill-ring string)
3062 (push string kill-ring)
3063 (if (> (length kill-ring) kill-ring-max)
3064 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3065 (setq kill-ring-yank-pointer kill-ring)
3066 (if interprogram-cut-function
3067 (funcall interprogram-cut-function string)))
3068 (set-advertised-calling-convention
3069 'kill-new '(string &optional replace) "23.3")
3071 (defun kill-append (string before-p &optional yank-handler)
3072 "Append STRING to the end of the latest kill in the kill ring.
3073 If BEFORE-P is non-nil, prepend STRING to the kill.
3074 If `interprogram-cut-function' is set, pass the resulting kill to it."
3075 (let* ((cur (car kill-ring)))
3076 (kill-new (if before-p (concat string cur) (concat cur string))
3077 (or (= (length cur) 0)
3078 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3079 yank-handler)))
3080 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3082 (defcustom yank-pop-change-selection nil
3083 "If non-nil, rotating the kill ring changes the window system selection."
3084 :type 'boolean
3085 :group 'killing
3086 :version "23.1")
3088 (defun current-kill (n &optional do-not-move)
3089 "Rotate the yanking point by N places, and then return that kill.
3090 If N is zero and `interprogram-paste-function' is set to a
3091 function that returns a string or a list of strings, and if that
3092 function doesn't return nil, then that string (or list) is added
3093 to the front of the kill ring and the string (or first string in
3094 the list) is returned as the latest kill.
3096 If N is not zero, and if `yank-pop-change-selection' is
3097 non-nil, use `interprogram-cut-function' to transfer the
3098 kill at the new yank point into the window system selection.
3100 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3101 move the yanking point; just return the Nth kill forward."
3103 (let ((interprogram-paste (and (= n 0)
3104 interprogram-paste-function
3105 (funcall interprogram-paste-function))))
3106 (if interprogram-paste
3107 (progn
3108 ;; Disable the interprogram cut function when we add the new
3109 ;; text to the kill ring, so Emacs doesn't try to own the
3110 ;; selection, with identical text.
3111 (let ((interprogram-cut-function nil))
3112 (if (listp interprogram-paste)
3113 (mapc 'kill-new (nreverse interprogram-paste))
3114 (kill-new interprogram-paste)))
3115 (car kill-ring))
3116 (or kill-ring (error "Kill ring is empty"))
3117 (let ((ARGth-kill-element
3118 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3119 (length kill-ring))
3120 kill-ring)))
3121 (unless do-not-move
3122 (setq kill-ring-yank-pointer ARGth-kill-element)
3123 (when (and yank-pop-change-selection
3124 (> n 0)
3125 interprogram-cut-function)
3126 (funcall interprogram-cut-function (car ARGth-kill-element))))
3127 (car ARGth-kill-element)))))
3131 ;;;; Commands for manipulating the kill ring.
3133 (defcustom kill-read-only-ok nil
3134 "Non-nil means don't signal an error for killing read-only text."
3135 :type 'boolean
3136 :group 'killing)
3138 (put 'text-read-only 'error-conditions
3139 '(text-read-only buffer-read-only error))
3140 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3142 (defun kill-region (beg end &optional yank-handler)
3144 This deletes the text from the buffer and saves it in the kill ring.
3148 If you want to append the killed region to the last killed text,
3151 If the buffer is read-only, Emacs will beep and refrain from deleting
3152 the text, but put the text in the kill ring anyway. This means that
3153 you can use the killing commands to copy text from a read-only buffer.
3155 Lisp programs should use this function for killing text.
3156 (To delete text, use `delete-region'.)
3157 Supply two arguments, character positions indicating the stretch of text
3158 to be killed.
3160 If the previous command was also a kill command,
3161 the text killed this time appends to the text killed last time
3162 to make one entry in the kill ring."
3163 ;; Pass point first, then mark, because the order matters
3164 ;; when calling kill-append.
3165 (interactive (list (point) (mark)))
3166 (unless (and beg end)
3167 (error "The mark is not set now, so there is no region"))
3168 (condition-case nil
3169 (let ((string (filter-buffer-substring beg end t)))
3170 (when string ;STRING is nil if BEG = END
3171 ;; Add that string to the kill ring, one way or another.
3172 (if (eq last-command 'kill-region)
3173 (kill-append string (< end beg) yank-handler)
3174 (kill-new string nil yank-handler)))
3175 (when (or string (eq last-command 'kill-region))
3176 (setq this-command 'kill-region))
3177 nil)
3178 ((buffer-read-only text-read-only)
3179 ;; The code above failed because the buffer, or some of the characters
3180 ;; in the region, are read-only.
3181 ;; We should beep, in case the user just isn't aware of this.
3182 ;; However, there's no harm in putting
3183 ;; the region's text in the kill ring, anyway.
3184 (copy-region-as-kill beg end)
3185 ;; Set this-command now, so it will be set even if we get an error.
3186 (setq this-command 'kill-region)
3187 ;; This should barf, if appropriate, and give us the correct error.
3188 (if kill-read-only-ok
3189 (progn (message "Read only text copied to kill ring") nil)
3190 ;; Signal an error if the buffer is read-only.
3191 (barf-if-buffer-read-only)
3192 ;; If the buffer isn't read-only, the text is.
3193 (signal 'text-read-only (list (current-buffer)))))))
3194 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3196 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3197 ;; to get two copies of the text when the user accidentally types M-w and
3198 ;; then corrects it with the intended C-w.
3199 (defun copy-region-as-kill (beg end)
3200 "Save the region as if killed, but don't kill it.
3201 In Transient Mark mode, deactivate the mark.
3202 If `interprogram-cut-function' is non-nil, also save the text for a window
3203 system cut and paste.
3205 This command's old key binding has been given to `kill-ring-save'."
3206 (interactive "r")
3207 (if (eq last-command 'kill-region)
3208 (kill-append (filter-buffer-substring beg end) (< end beg))
3209 (kill-new (filter-buffer-substring beg end)))
3210 (setq deactivate-mark t)
3211 nil)
3213 (defun kill-ring-save (beg end)
3214 "Save the region as if killed, but don't kill it.
3215 In Transient Mark mode, deactivate the mark.
3216 If `interprogram-cut-function' is non-nil, also save the text for a window
3217 system cut and paste.
3219 If you want to append the killed line to the last killed text,
3222 This command is similar to `copy-region-as-kill', except that it gives
3223 visual feedback indicating the extent of the region being copied."
3224 (interactive "r")
3225 (copy-region-as-kill beg end)
3226 ;; This use of called-interactively-p is correct
3227 ;; because the code it controls just gives the user visual feedback.
3228 (if (called-interactively-p 'interactive)
3229 (let ((other-end (if (= (point) beg) end beg))
3230 (opoint (point))
3231 ;; Inhibit quitting so we can make a quit here
3232 ;; look like a C-g typed as a command.
3233 (inhibit-quit t))
3234 (if (pos-visible-in-window-p other-end (selected-window))
3235 ;; Swap point-and-mark quickly so as to show the region that
3236 ;; was selected. Don't do it if the region is highlighted.
3237 (unless (and (region-active-p)
3238 (face-background 'region))
3239 ;; Swap point and mark.
3240 (set-marker (mark-marker) (point) (current-buffer))
3241 (goto-char other-end)
3242 (sit-for blink-matching-delay)
3243 ;; Swap back.
3244 (set-marker (mark-marker) other-end (current-buffer))
3245 (goto-char opoint)
3246 ;; If user quit, deactivate the mark
3247 ;; as C-g would as a command.
3248 (and quit-flag mark-active
3249 (deactivate-mark)))
3250 (let* ((killed-text (current-kill 0))
3251 (message-len (min (length killed-text) 40)))
3252 (if (= (point) beg)
3253 ;; Don't say "killed"; that is misleading.
3255 (substring killed-text (- message-len)))
3257 (substring killed-text 0 message-len))))))))
3259 (defun append-next-kill (&optional interactive)
3260 "Cause following command, if it kills, to append to previous kill.
3261 The argument is used for internal purposes; do not supply one."
3262 (interactive "p")
3263 ;; We don't use (interactive-p), since that breaks kbd macros.
3264 (if interactive
3265 (progn
3266 (setq this-command 'kill-region)
3267 (message "If the next command is a kill, it will append"))
3268 (setq last-command 'kill-region)))
3269 \f
3270 ;; Yanking.
3272 ;; This is actually used in subr.el but defcustom does not work there.
3273 (defcustom yank-excluded-properties
3274 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3275 yank-handler follow-link fontified)
3276 "Text properties to discard when yanking.
3277 The value should be a list of text properties to discard or t,
3278 which means to discard all text properties."
3279 :type '(choice (const :tag "All" t) (repeat symbol))
3280 :group 'killing
3281 :version "22.1")
3283 (defvar yank-window-start nil)
3284 (defvar yank-undo-function nil
3285 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3286 Function is called with two parameters, START and END corresponding to
3287 the value of the mark and point; it is guaranteed that START <= END.
3288 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3290 (defun yank-pop (&optional arg)
3291 "Replace just-yanked stretch of killed text with a different stretch.
3292 This command is allowed only immediately after a `yank' or a `yank-pop'.
3293 At such a time, the region contains a stretch of reinserted
3294 previously-killed text. `yank-pop' deletes that text and inserts in its
3295 place a different stretch of killed text.
3297 With no argument, the previous kill is inserted.
3298 With argument N, insert the Nth previous kill.
3299 If N is negative, this is a more recent kill.
3301 The sequence of kills wraps around, so that after the oldest one
3302 comes the newest one.
3304 When this command inserts killed text into the buffer, it honors
3305 `yank-excluded-properties' and `yank-handler' as described in the
3306 doc string for `insert-for-yank-1', which see."
3307 (interactive "*p")
3308 (if (not (eq last-command 'yank))
3309 (error "Previous command was not a yank"))
3310 (setq this-command 'yank)
3311 (unless arg (setq arg 1))
3312 (let ((inhibit-read-only t)
3313 (before (< (point) (mark t))))
3314 (if before
3315 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3316 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3317 (setq yank-undo-function nil)
3318 (set-marker (mark-marker) (point) (current-buffer))
3319 (insert-for-yank (current-kill arg))
3320 ;; Set the window start back where it was in the yank command,
3321 ;; if possible.
3322 (set-window-start (selected-window) yank-window-start t)
3323 (if before
3324 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3325 ;; It is cleaner to avoid activation, even though the command
3326 ;; loop would deactivate the mark because we inserted text.
3327 (goto-char (prog1 (mark t)
3328 (set-marker (mark-marker) (point) (current-buffer))))))
3329 nil)
3331 (defun yank (&optional arg)
3333 More precisely, reinsert the stretch of killed text most recently
3334 killed OR yanked. Put point at end, and set mark at beginning.
3335 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3336 With argument N, reinsert the Nth most recently killed stretch of killed
3337 text.
3339 When this command inserts killed text into the buffer, it honors
3340 `yank-excluded-properties' and `yank-handler' as described in the
3341 doc string for `insert-for-yank-1', which see.
3344 (interactive "*P")
3345 (setq yank-window-start (window-start))
3346 ;; If we don't get all the way thru, make last-command indicate that
3347 ;; for the following command.
3348 (setq this-command t)
3349 (push-mark (point))
3350 (insert-for-yank (current-kill (cond
3351 ((listp arg) 0)
3352 ((eq arg '-) -2)
3353 (t (1- arg)))))
3354 (if (consp arg)
3355 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3356 ;; It is cleaner to avoid activation, even though the command
3357 ;; loop would deactivate the mark because we inserted text.
3358 (goto-char (prog1 (mark t)
3359 (set-marker (mark-marker) (point) (current-buffer)))))
3360 ;; If we do get all the way thru, make this-command indicate that.
3361 (if (eq this-command t)
3362 (setq this-command 'yank))
3363 nil)
3365 (defun rotate-yank-pointer (arg)
3366 "Rotate the yanking point in the kill ring.
3367 With ARG, rotate that many kills forward (or backward, if negative)."
3368 (interactive "p")
3369 (current-kill arg))
3370 \f
3371 ;; Some kill commands.
3373 ;; Internal subroutine of delete-char
3374 (defun kill-forward-chars (arg)
3375 (if (listp arg) (setq arg (car arg)))
3376 (if (eq arg '-) (setq arg -1))
3377 (kill-region (point) (+ (point) arg)))
3379 ;; Internal subroutine of backward-delete-char
3380 (defun kill-backward-chars (arg)
3381 (if (listp arg) (setq arg (car arg)))
3382 (if (eq arg '-) (setq arg -1))
3383 (kill-region (point) (- (point) arg)))
3385 (defcustom backward-delete-char-untabify-method 'untabify
3386 "The method for untabifying when deleting backward.
3387 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3388 `hungry' -- delete all whitespace, both tabs and spaces;
3389 `all' -- delete all whitespace, including tabs, spaces and newlines;
3390 nil -- just delete one character."
3391 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3392 :version "20.3"
3393 :group 'killing)
3395 (defun backward-delete-char-untabify (arg &optional killp)
3396 "Delete characters backward, changing tabs into spaces.
3397 The exact behavior depends on `backward-delete-char-untabify-method'.
3398 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3399 Interactively, ARG is the prefix arg (default 1)
3400 and KILLP is t if a prefix arg was specified."
3402 (when (eq backward-delete-char-untabify-method 'untabify)
3403 (let ((count arg))
3404 (save-excursion
3405 (while (and (> count 0) (not (bobp)))
3407 (let ((col (current-column)))
3408 (forward-char -1)
3409 (setq col (- col (current-column)))
3410 (insert-char ?\s col)
3411 (delete-char 1)))
3412 (forward-char -1)
3413 (setq count (1- count))))))
3415 ((eq backward-delete-char-untabify-method 'all)
3417 (n (if skip
3418 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3419 (point)))))
3420 (+ arg (if (zerop wh) 0 (1- wh))))
3421 arg)))
3422 ;; Avoid warning about delete-backward-char
3423 (with-no-warnings (delete-backward-char n killp))))
3425 (defun zap-to-char (arg char)
3426 "Kill up to and including ARGth occurrence of CHAR.
3427 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3428 Goes backward if ARG is negative; error if CHAR not found."
3430 ;; Avoid "obsolete" warnings for translation-table-for-input.
3431 (with-no-warnings
3432 (if (char-table-p translation-table-for-input)
3433 (setq char (or (aref translation-table-for-input char) char))))
3434 (kill-region (point) (progn
3435 (search-forward (char-to-string char) nil nil arg)
3436 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3437 (point))))
3439 ;; kill-line and its subroutines.
3441 (defcustom kill-whole-line nil
3442 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3443 :type 'boolean
3444 :group 'killing)
3446 (defun kill-line (&optional arg)
3447 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3448 With prefix argument ARG, kill that many lines from point.
3449 Negative arguments kill lines backward.
3450 With zero argument, kills the text before point on the current line.
3453 a number counts as a prefix arg.
3455 To kill a whole line, when point is not at the beginning, type \
3458 If `show-trailing-whitespace' is non-nil, this command will just
3459 kill the rest of the current line, even if there are only
3460 nonblanks there.
3462 If `kill-whole-line' is non-nil, then this command kills the whole line
3463 including its terminating newline, when used at the beginning of a line
3464 with no argument. As a consequence, you can always kill a whole line
3467 If you want to append the killed line to the last killed text,
3470 If the buffer is read-only, Emacs will beep and refrain from deleting
3471 the line, but put the line in the kill ring anyway. This means that
3472 you can use this command to copy text from a read-only buffer.
3473 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3474 even beep.)"
3475 (interactive "P")
3476 (kill-region (point)
3477 ;; It is better to move point to the other end of the kill
3478 ;; before killing. That way, in a read-only buffer, point
3479 ;; moves across the text that is copied to the kill ring.
3480 ;; The choice has no effect on undo now that undo records
3481 ;; the value of point from before the command was run.
3482 (progn
3483 (if arg
3484 (forward-visible-line (prefix-numeric-value arg))
3485 (if (eobp)
3486 (signal 'end-of-buffer nil))
3487 (let ((end
3488 (save-excursion
3489 (end-of-visible-line) (point))))
3490 (if (or (save-excursion
3491 ;; If trailing whitespace is visible,
3492 ;; don't treat it as nothing.
3493 (unless show-trailing-whitespace
3495 (= (point) end))
3496 (and kill-whole-line (bolp)))
3497 (forward-visible-line 1)
3498 (goto-char end))))
3499 (point))))
3501 (defun kill-whole-line (&optional arg)
3502 "Kill current line.
3503 With prefix ARG, kill that many lines starting from the current line.
3504 If ARG is negative, kill backward. Also kill the preceding newline.
3506 If ARG is zero, kill current line but exclude the trailing newline."
3507 (interactive "p")
3508 (or arg (setq arg 1))
3509 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3510 (signal 'end-of-buffer nil))
3511 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3512 (signal 'beginning-of-buffer nil))
3513 (unless (eq last-command 'kill-region)
3514 (kill-new "")
3515 (setq last-command 'kill-region))
3516 (cond ((zerop arg)
3517 ;; We need to kill in two steps, because the previous command
3518 ;; could have been a kill command, in which case the text
3519 ;; before point needs to be prepended to the current kill
3520 ;; ring entry and the text after point appended. Also, we
3521 ;; need to use save-excursion to avoid copying the same text
3522 ;; twice to the kill ring in read-only buffers.
3523 (save-excursion
3524 (kill-region (point) (progn (forward-visible-line 0) (point))))
3525 (kill-region (point) (progn (end-of-visible-line) (point))))
3526 ((< arg 0)
3527 (save-excursion
3528 (kill-region (point) (progn (end-of-visible-line) (point))))
3529 (kill-region (point)
3530 (progn (forward-visible-line (1+ arg))
3531 (unless (bobp) (backward-char))
3532 (point))))
3533 (t
3534 (save-excursion
3535 (kill-region (point) (progn (forward-visible-line 0) (point))))
3536 (kill-region (point)
3537 (progn (forward-visible-line arg) (point))))))
3539 (defun forward-visible-line (arg)
3540 "Move forward by ARG lines, ignoring currently invisible newlines only.
3541 If ARG is negative, move backward -ARG lines.
3542 If ARG is zero, move to the beginning of the current line."
3543 (condition-case nil
3544 (if (> arg 0)
3545 (progn
3546 (while (> arg 0)
3547 (or (zerop (forward-line 1))
3548 (signal 'end-of-buffer nil))
3549 ;; If the newline we just skipped is invisible,
3550 ;; don't count it.
3551 (let ((prop
3552 (get-char-property (1- (point)) 'invisible)))
3553 (if (if (eq buffer-invisibility-spec t)
3554 prop
3555 (or (memq prop buffer-invisibility-spec)
3556 (assq prop buffer-invisibility-spec)))
3557 (setq arg (1+ arg))))
3558 (setq arg (1- arg)))
3559 ;; If invisible text follows, and it is a number of complete lines,
3560 ;; skip it.
3561 (let ((opoint (point)))
3562 (while (and (not (eobp))
3563 (let ((prop
3564 (get-char-property (point) 'invisible)))
3565 (if (eq buffer-invisibility-spec t)
3566 prop
3567 (or (memq prop buffer-invisibility-spec)
3568 (assq prop buffer-invisibility-spec)))))
3569 (goto-char
3570 (if (get-text-property (point) 'invisible)
3571 (or (next-single-property-change (point) 'invisible)
3572 (point-max))
3573 (next-overlay-change (point)))))
3574 (unless (bolp)
3575 (goto-char opoint))))
3576 (let ((first t))
3577 (while (or first (<= arg 0))
3578 (if first
3579 (beginning-of-line)
3580 (or (zerop (forward-line -1))
3581 (signal 'beginning-of-buffer nil)))
3582 ;; If the newline we just moved to is invisible,
3583 ;; don't count it.
3584 (unless (bobp)
3585 (let ((prop
3586 (get-char-property (1- (point)) 'invisible)))
3587 (unless (if (eq buffer-invisibility-spec t)
3588 prop
3589 (or (memq prop buffer-invisibility-spec)
3590 (assq prop buffer-invisibility-spec)))
3591 (setq arg (1+ arg)))))
3592 (setq first nil))
3593 ;; If invisible text follows, and it is a number of complete lines,
3594 ;; skip it.
3595 (let ((opoint (point)))
3596 (while (and (not (bobp))
3597 (let ((prop
3598 (get-char-property (1- (point)) 'invisible)))
3599 (if (eq buffer-invisibility-spec t)
3600 prop
3601 (or (memq prop buffer-invisibility-spec)
3602 (assq prop buffer-invisibility-spec)))))
3603 (goto-char
3604 (if (get-text-property (1- (point)) 'invisible)
3605 (or (previous-single-property-change (point) 'invisible)
3606 (point-min))
3607 (previous-overlay-change (point)))))
3608 (unless (bolp)
3609 (goto-char opoint)))))
3610 ((beginning-of-buffer end-of-buffer)
3611 nil)))
3613 (defun end-of-visible-line ()
3614 "Move to end of current visible line."
3615 (end-of-line)
3616 ;; If the following character is currently invisible,
3617 ;; skip all characters with that same `invisible' property value,
3618 ;; then find the next newline.
3619 (while (and (not (eobp))
3620 (save-excursion
3622 (let ((prop
3623 (get-char-property (point) 'invisible)))
3624 (if (eq buffer-invisibility-spec t)
3625 prop
3626 (or (memq prop buffer-invisibility-spec)
3627 (assq prop buffer-invisibility-spec))))))
3629 (if (get-text-property (point) 'invisible)
3630 (goto-char (next-single-property-change (point) 'invisible))
3631 (goto-char (next-overlay-change (point))))
3632 (end-of-line)))
3633 \f
3634 (defun insert-buffer (buffer)
3635 "Insert after point the contents of BUFFER.
3636 Puts mark after the inserted text.
3637 BUFFER may be a buffer or a buffer name.
3639 This function is meant for the user to run interactively.
3640 Don't call it from programs: use `insert-buffer-substring' instead!"
3641 (interactive
3642 (list
3643 (progn
3644 (barf-if-buffer-read-only)
3645 (read-buffer "Insert buffer: "
3646 (if (eq (selected-window) (next-window (selected-window)))
3647 (other-buffer (current-buffer))
3648 (window-buffer (next-window (selected-window))))
3649 t))))
3650 (push-mark
3651 (save-excursion
3652 (insert-buffer-substring (get-buffer buffer))
3653 (point)))
3654 nil)
3656 (defun append-to-buffer (buffer start end)
3657 "Append to specified buffer the text of the region.
3658 It is inserted into that buffer before its point.
3660 When calling from a program, give three arguments:
3661 BUFFER (or buffer name), START and END.
3662 START and END specify the portion of the current buffer to be copied."
3663 (interactive
3664 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3665 (region-beginning) (region-end)))
3666 (let* ((oldbuf (current-buffer))
3667 (append-to (get-buffer-create buffer))
3668 (windows (get-buffer-window-list append-to t t))
3669 point)
3670 (save-excursion
3671 (with-current-buffer append-to
3672 (setq point (point))
3673 (barf-if-buffer-read-only)
3674 (insert-buffer-substring oldbuf start end)
3675 (dolist (window windows)
3676 (when (= (window-point window) point)
3677 (set-window-point window (point))))))))
3679 (defun prepend-to-buffer (buffer start end)
3680 "Prepend to specified buffer the text of the region.
3681 It is inserted into that buffer after its point.
3683 When calling from a program, give three arguments:
3684 BUFFER (or buffer name), START and END.
3685 START and END specify the portion of the current buffer to be copied."
3687 (let ((oldbuf (current-buffer)))
3688 (with-current-buffer (get-buffer-create buffer)
3689 (barf-if-buffer-read-only)
3690 (save-excursion
3691 (insert-buffer-substring oldbuf start end)))))
3693 (defun copy-to-buffer (buffer start end)
3694 "Copy to specified buffer the text of the region.
3695 It is inserted into that buffer, replacing existing text there.
3697 When calling from a program, give three arguments:
3698 BUFFER (or buffer name), START and END.
3699 START and END specify the portion of the current buffer to be copied."
3701 (let ((oldbuf (current-buffer)))
3702 (with-current-buffer (get-buffer-create buffer)
3703 (barf-if-buffer-read-only)
3704 (erase-buffer)
3705 (save-excursion
3706 (insert-buffer-substring oldbuf start end)))))
3707 \f
3708 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3709 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3711 (defvar activate-mark-hook nil
3712 "Hook run when the mark becomes active.
3713 It is also run at the end of a command, if the mark is active and
3714 it is possible that the region may have changed.")
3716 (defvar deactivate-mark-hook nil
3717 "Hook run when the mark becomes inactive.")
3719 (defun mark (&optional force)
3720 "Return this buffer's mark value as integer, or nil if never set.
3722 In Transient Mark mode, this function signals an error if
3723 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3724 or the argument FORCE is non-nil, it disregards whether the mark
3725 is active, and returns an integer or nil in the usual way.
3727 If you are using this in an editing command, you are most likely making
3728 a mistake; see the documentation of `set-mark'."
3729 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3730 (marker-position (mark-marker))
3731 (signal 'mark-inactive nil)))
3733 (defsubst deactivate-mark (&optional force)
3734 "Deactivate the mark by setting `mark-active' to nil.
3735 Unless FORCE is non-nil, this function does nothing if Transient
3736 Mark mode is disabled.
3737 This function also runs `deactivate-mark-hook'."
3738 (when (or transient-mark-mode force)
3739 (when (and (if (eq select-active-regions 'only)
3740 (eq (car-safe transient-mark-mode) 'only)
3741 select-active-regions)
3742 (region-active-p)
3743 (display-selections-p))
3744 ;; The var `saved-region-selection', if non-nil, is the text in
3745 ;; the region prior to the last command modifying the buffer.
3746 ;; Set the selection to that, or to the current region.
3747 (cond (saved-region-selection
3748 (x-set-selection 'PRIMARY saved-region-selection)
3749 (setq saved-region-selection nil))
3750 ((/= (region-beginning) (region-end))
3751 (x-set-selection 'PRIMARY
3752 (buffer-substring-no-properties
3753 (region-beginning)
3754 (region-end))))))
3755 (if (and (null force)
3756 (or (eq transient-mark-mode 'lambda)
3757 (and (eq (car-safe transient-mark-mode) 'only)
3758 (null (cdr transient-mark-mode)))))
3759 ;; When deactivating a temporary region, don't change
3760 ;; `mark-active' or run `deactivate-mark-hook'.
3761 (setq transient-mark-mode nil)
3762 (if (eq (car-safe transient-mark-mode) 'only)
3763 (setq transient-mark-mode (cdr transient-mark-mode)))
3764 (setq mark-active nil)
3765 (run-hooks 'deactivate-mark-hook))))
3767 (defun activate-mark ()
3768 "Activate the mark."
3769 (when (mark t)
3770 (setq mark-active t)
3771 (unless transient-mark-mode
3772 (setq transient-mark-mode 'lambda))))
3774 (defun set-mark (pos)
3775 "Set this buffer's mark to POS. Don't use this function!
3776 That is to say, don't use this function unless you want
3777 the user to see that the mark has moved, and you want the previous
3778 mark position to be lost.
3780 Normally, when a new mark is set, the old one should go on the stack.
3781 This is why most applications should use `push-mark', not `set-mark'.
3783 Novice Emacs Lisp programmers often try to use the mark for the wrong
3784 purposes. The mark saves a location for the user's convenience.
3785 Most editing commands should not alter the mark.
3786 To remember a location for internal use in the Lisp program,
3787 store it in a Lisp variable. Example:
3789 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3791 (if pos
3792 (progn
3793 (setq mark-active t)
3794 (run-hooks 'activate-mark-hook)
3795 (set-marker (mark-marker) pos (current-buffer)))
3796 ;; Normally we never clear mark-active except in Transient Mark mode.
3797 ;; But when we actually clear out the mark value too, we must
3798 ;; clear mark-active in any mode.
3799 (deactivate-mark t)
3800 (set-marker (mark-marker) nil)))
3802 (defcustom use-empty-active-region nil
3804 If nil, region-aware commands treat empty regions as inactive.
3805 If non-nil, region-aware commands treat the region as active as
3806 long as the mark is active, even if the region is empty.
3808 Region-aware commands are those that act on the region if it is
3809 active and Transient Mark mode is enabled, and on the text near
3810 point otherwise."
3811 :type 'boolean
3812 :version "23.1"
3813 :group 'editing-basics)
3815 (defun use-region-p ()
3816 "Return t if the region is active and it is appropriate to act on it.
3817 This is used by commands that act specially on the region under
3818 Transient Mark mode.
3820 The return value is t if Transient Mark mode is enabled and the
3821 mark is active; furthermore, if `use-empty-active-region' is nil,
3822 the region must not be empty. Otherwise, the return value is nil.
3824 For some commands, it may be appropriate to ignore the value of
3825 `use-empty-active-region'; in that case, use `region-active-p'."
3826 (and (region-active-p)
3827 (or use-empty-active-region (> (region-end) (region-beginning)))))
3829 (defun region-active-p ()
3830 "Return t if Transient Mark mode is enabled and the mark is active.
3832 Some commands act specially on the region when Transient Mark
3833 mode is enabled. Usually, such commands should use
3834 `use-region-p' instead of this function, because `use-region-p'
3835 also checks the value of `use-empty-active-region'."
3836 (and transient-mark-mode mark-active))
3838 (defvar mark-ring nil
3839 "The list of former marks of the current buffer, most recent first.")
3840 (make-variable-buffer-local 'mark-ring)
3841 (put 'mark-ring 'permanent-local t)
3843 (defcustom mark-ring-max 16
3844 "Maximum size of mark ring. Start discarding off end if gets this big."
3845 :type 'integer
3846 :group 'editing-basics)
3848 (defvar global-mark-ring nil
3849 "The list of saved global marks, most recent first.")
3851 (defcustom global-mark-ring-max 16
3852 "Maximum size of global mark ring. \
3853 Start discarding off end if gets this big."
3854 :type 'integer
3855 :group 'editing-basics)
3857 (defun pop-to-mark-command ()
3858 "Jump to mark, and pop a new position for mark off the ring.
3859 \(Does not affect global mark ring\)."
3860 (interactive)
3861 (if (null (mark t))
3862 (error "No mark set in this buffer")
3863 (if (= (point) (mark t))
3864 (message "Mark popped"))
3865 (goto-char (mark t))
3866 (pop-mark)))
3868 (defun push-mark-command (arg &optional nomsg)
3869 "Set mark at where point is.
3870 If no prefix ARG and mark is already set there, just activate it.
3871 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3872 (interactive "P")
3873 (let ((mark (marker-position (mark-marker))))
3874 (if (or arg (null mark) (/= mark (point)))
3875 (push-mark nil nomsg t)
3876 (setq mark-active t)
3877 (run-hooks 'activate-mark-hook)
3878 (unless nomsg
3879 (message "Mark activated")))))
3881 (defcustom set-mark-command-repeat-pop nil
3884 will pop the mark twice, and
3886 will pop the mark three times.
3890 :type 'boolean
3891 :group 'editing-basics)
3893 (defcustom set-mark-default-inactive nil
3894 "If non-nil, setting the mark does not activate it.
3896 behave the same whether or not `transient-mark-mode' is enabled."
3897 :type 'boolean
3898 :group 'editing-basics
3899 :version "23.1")
3901 (defun set-mark-command (arg)
3902 "Set the mark where point is, or jump to the mark.
3903 Setting the mark also alters the region, which is the text
3904 between point and mark; this is the closest equivalent in
3907 With no prefix argument, set the mark at point, and push the
3908 old mark position on local mark ring. Also push the old mark on
3909 global mark ring, if the previous mark was set in another buffer.
3911 When Transient Mark Mode is off, immediately repeating this
3912 command activates `transient-mark-mode' temporarily.
3915 jump to the mark, and set the mark from
3916 position popped off the local mark ring \(this does not affect the global
3918 mark ring \(see `pop-global-mark'\).
3920 If `set-mark-command-repeat-pop' is non-nil, repeating
3922 off the local (or global) mark ring and jumps there.
3925 argument, unconditionally set mark where point is, even if
3926 `set-mark-command-repeat-pop' is non-nil.
3928 Novice Emacs Lisp programmers often try to use the mark for the wrong
3929 purposes. See the documentation of `set-mark' for more information."
3930 (interactive "P")
3931 (cond ((eq transient-mark-mode 'lambda)
3932 (setq transient-mark-mode nil))
3933 ((eq (car-safe transient-mark-mode) 'only)
3934 (deactivate-mark)))
3935 (cond
3936 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3937 (push-mark-command nil))
3938 ((not (eq this-command 'set-mark-command))
3939 (if arg
3940 (pop-to-mark-command)
3941 (push-mark-command t)))
3942 ((and set-mark-command-repeat-pop
3943 (eq last-command 'pop-to-mark-command))
3944 (setq this-command 'pop-to-mark-command)
3945 (pop-to-mark-command))
3946 ((and set-mark-command-repeat-pop
3947 (eq last-command 'pop-global-mark)
3948 (not arg))
3949 (setq this-command 'pop-global-mark)
3950 (pop-global-mark))
3951 (arg
3952 (setq this-command 'pop-to-mark-command)
3953 (pop-to-mark-command))
3954 ((eq last-command 'set-mark-command)
3955 (if (region-active-p)
3956 (progn
3957 (deactivate-mark)
3958 (message "Mark deactivated"))
3959 (activate-mark)
3960 (message "Mark activated")))
3961 (t
3962 (push-mark-command nil)
3963 (if set-mark-default-inactive (deactivate-mark)))))
3965 (defun push-mark (&optional location nomsg activate)
3966 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3967 If the last global mark pushed was not in the current buffer,
3968 also push LOCATION on the global mark ring.
3969 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3971 Novice Emacs Lisp programmers often try to use the mark for the wrong
3972 purposes. See the documentation of `set-mark' for more information.
3974 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3975 (unless (null (mark t))
3976 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3977 (when (> (length mark-ring) mark-ring-max)
3978 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3979 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3980 (set-marker (mark-marker) (or location (point)) (current-buffer))
3981 ;; Now push the mark on the global mark ring.
3982 (if (and global-mark-ring
3983 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3984 ;; The last global mark pushed was in this same buffer.
3985 ;; Don't push another one.
3986 nil
3987 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3988 (when (> (length global-mark-ring) global-mark-ring-max)
3989 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3990 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3991 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3992 (message "Mark set"))
3993 (if (or activate (not transient-mark-mode))
3994 (set-mark (mark t)))
3995 nil)
3997 (defun pop-mark ()
3998 "Pop off mark ring into the buffer's actual mark.
3999 Does not set point. Does nothing if mark ring is empty."
4000 (when mark-ring
4001 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4002 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4003 (move-marker (car mark-ring) nil)
4004 (if (null (mark t)) (ding))
4005 (setq mark-ring (cdr mark-ring)))
4006 (deactivate-mark))
4008 (define-obsolete-function-alias
4009 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4010 (defun exchange-point-and-mark (&optional arg)
4011 "Put the mark where point is now, and point where the mark is now.
4012 This command works even when the mark is not active,
4013 and it reactivates the mark.
4015 If Transient Mark mode is on, a prefix ARG deactivates the mark
4016 if it is active, and otherwise avoids reactivating it. If
4017 Transient Mark mode is off, a prefix ARG enables Transient Mark
4018 mode temporarily."
4019 (interactive "P")
4020 (let ((omark (mark t))
4021 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4022 (if (null omark)
4023 (error "No mark set in this buffer"))
4024 (deactivate-mark)
4025 (set-mark (point))
4026 (goto-char omark)
4027 (if set-mark-default-inactive (deactivate-mark))
4028 (cond (temp-highlight
4029 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4030 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4031 (not (or arg (region-active-p))))
4032 (deactivate-mark))
4033 (t (activate-mark)))
4034 nil))
4036 (defcustom shift-select-mode t
4037 "When non-nil, shifted motion keys activate the mark momentarily.
4039 While the mark is activated in this way, any shift-translated point
4040 motion key extends the region, and if Transient Mark mode was off, it
4041 is temporarily turned on. Furthermore, the mark will be deactivated
4042 by any subsequent point motion key that was not shift-translated, or
4043 by any action that normally deactivates the mark in Transient Mark mode.
4045 See `this-command-keys-shift-translated' for the meaning of
4046 shift-translation."
4047 :type 'boolean
4048 :group 'editing-basics)
4050 (defun handle-shift-selection ()
4051 "Activate/deactivate mark depending on invocation thru shift translation.
4052 This function is called by `call-interactively' when a command
4053 with a `^' character in its `interactive' spec is invoked, before
4054 running the command itself.
4056 If `shift-select-mode' is enabled and the command was invoked
4057 through shift translation, set the mark and activate the region
4058 temporarily, unless it was already set in this way. See
4059 `this-command-keys-shift-translated' for the meaning of shift
4060 translation.
4062 Otherwise, if the region has been activated temporarily,
4063 deactivate it, and restore the variable `transient-mark-mode' to
4064 its earlier value."
4065 (cond ((and shift-select-mode this-command-keys-shift-translated)
4066 (unless (and mark-active
4067 (eq (car-safe transient-mark-mode) 'only))
4068 (setq transient-mark-mode
4069 (cons 'only
4070 (unless (eq transient-mark-mode 'lambda)
4071 transient-mark-mode)))
4072 (push-mark nil nil t)))
4073 ((eq (car-safe transient-mark-mode) 'only)
4074 (setq transient-mark-mode (cdr transient-mark-mode))
4075 (deactivate-mark))))
4077 (define-minor-mode transient-mark-mode
4078 "Toggle Transient Mark mode.
4079 With ARG, turn Transient Mark mode on if ARG is positive, off otherwise.
4081 In Transient Mark mode, when the mark is active, the region is highlighted.
4083 So do certain other operations that set the mark
4084 but whose main purpose is something else--for example,
4090 Many commands change their behavior when Transient Mark mode is in effect
4091 and the mark is active, by acting on the region instead of their usual
4092 default part of the buffer's text. Examples of such commands include
4097 commands which are sensitive to the Transient Mark mode."
4098 :global t
4099 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4100 :variable transient-mark-mode)
4102 (defvar widen-automatically t
4103 "Non-nil means it is ok for commands to call `widen' when they want to.
4104 Some commands will do this in order to go to positions outside
4105 the current accessible part of the buffer.
4107 If `widen-automatically' is nil, these commands will do something else
4108 as a fallback, and won't change the buffer bounds.")
4110 (defvar non-essential nil
4111 "Whether the currently executing code is performing an essential task.
4112 This variable should be non-nil only when running code which should not
4113 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4114 user for a password when we are simply scanning a set of files in the
4115 background or displaying possible completions before the user even asked
4116 for it.")
4118 (defun pop-global-mark ()
4119 "Pop off global mark ring and jump to the top location."
4120 (interactive)
4121 ;; Pop entries which refer to non-existent buffers.
4122 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4123 (setq global-mark-ring (cdr global-mark-ring)))
4124 (or global-mark-ring
4125 (error "No global mark set"))
4126 (let* ((marker (car global-mark-ring))
4127 (buffer (marker-buffer marker))
4128 (position (marker-position marker)))
4129 (setq global-mark-ring (nconc (cdr global-mark-ring)
4130 (list (car global-mark-ring))))
4131 (set-buffer buffer)
4132 (or (and (>= position (point-min))
4133 (<= position (point-max)))
4134 (if widen-automatically
4135 (widen)
4136 (error "Global mark position is outside accessible part of buffer")))
4137 (goto-char position)
4138 (switch-to-buffer buffer)))
4139 \f
4140 (defcustom next-line-add-newlines nil
4141 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4142 :type 'boolean
4143 :version "21.1"
4144 :group 'editing-basics)
4146 (defun next-line (&optional arg try-vscroll)
4147 "Move cursor vertically down ARG lines.
4148 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4149 If there is no character in the target line exactly under the current column,
4150 the cursor is positioned after the character in that line which spans this
4151 column, or at the end of the line if it is not long enough.
4152 If there is no line in the buffer after this one, behavior depends on the
4153 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4154 to create a line, and moves the cursor to that line. Otherwise it moves the
4155 cursor to the end of the buffer.
4157 If the variable `line-move-visual' is non-nil, this command moves
4158 by display lines. Otherwise, it moves by buffer lines, without
4159 taking variable-width characters or continued lines into account.
4162 a semipermanent goal column for this command.
4163 Then instead of trying to move exactly vertically (or as close as possible),
4164 this command moves to the specified goal column (or as close as possible).
4165 The goal column is stored in the variable `goal-column', which is nil
4166 when there is no goal column. Note that setting `goal-column'
4167 overrides `line-move-visual' and causes this command to move by buffer
4168 lines rather than by display lines.
4170 If you are thinking of using this in a Lisp program, consider
4171 using `forward-line' instead. It is usually easier to use
4172 and more reliable (no dependence on goal column, etc.)."
4174 (or arg (setq arg 1))
4175 (if (and next-line-add-newlines (= arg 1))
4176 (if (save-excursion (end-of-line) (eobp))
4177 ;; When adding a newline, don't expand an abbrev.
4178 (let ((abbrev-mode nil))
4179 (end-of-line)
4181 (line-move arg nil nil try-vscroll))
4182 (if (called-interactively-p 'interactive)
4183 (condition-case err
4184 (line-move arg nil nil try-vscroll)
4185 ((beginning-of-buffer end-of-buffer)
4186 (signal (car err) (cdr err))))
4187 (line-move arg nil nil try-vscroll)))
4188 nil)
4190 (defun previous-line (&optional arg try-vscroll)
4191 "Move cursor vertically up ARG lines.
4192 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4193 If there is no character in the target line exactly over the current column,
4194 the cursor is positioned after the character in that line which spans this
4195 column, or at the end of the line if it is not long enough.
4197 If the variable `line-move-visual' is non-nil, this command moves
4198 by display lines. Otherwise, it moves by buffer lines, without
4199 taking variable-width characters or continued lines into account.
4202 a semipermanent goal column for this command.
4203 Then instead of trying to move exactly vertically (or as close as possible),
4204 this command moves to the specified goal column (or as close as possible).
4205 The goal column is stored in the variable `goal-column', which is nil
4206 when there is no goal column. Note that setting `goal-column'
4207 overrides `line-move-visual' and causes this command to move by buffer
4208 lines rather than by display lines.
4210 If you are thinking of using this in a Lisp program, consider using
4211 `forward-line' with a negative argument instead. It is usually easier
4212 to use and more reliable (no dependence on goal column, etc.)."
4214 (or arg (setq arg 1))
4215 (if (called-interactively-p 'interactive)
4216 (condition-case err
4217 (line-move (- arg) nil nil try-vscroll)
4218 ((beginning-of-buffer end-of-buffer)
4219 (signal (car err) (cdr err))))
4220 (line-move (- arg) nil nil try-vscroll))
4221 nil)
4223 (defcustom track-eol nil
4224 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4225 This means moving to the end of each line moved onto.
4226 The beginning of a blank line does not count as the end of a line.
4227 This has no effect when `line-move-visual' is non-nil."
4228 :type 'boolean
4229 :group 'editing-basics)
4231 (defcustom goal-column nil
4233 A non-nil setting overrides `line-move-visual', which see."
4234 :type '(choice integer
4235 (const :tag "None" nil))
4236 :group 'editing-basics)
4237 (make-variable-buffer-local 'goal-column)
4239 (defvar temporary-goal-column 0
4240 "Current goal column for vertical motion.
4241 It is the column where point was at the start of the current run
4242 of vertical motion commands.
4244 When moving by visual lines via `line-move-visual', it is a cons
4245 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4246 divided by the default column width, and HSCROLL is the number of
4247 columns by which window is scrolled from left margin.
4249 When the `track-eol' feature is doing its job, the value is
4250 `most-positive-fixnum'.")
4252 (defcustom line-move-ignore-invisible t
4254 Outline mode sets this."
4255 :type 'boolean
4256 :group 'editing-basics)
4258 (defcustom line-move-visual t
4259 "When non-nil, `line-move' moves point by visual lines.
4260 This movement is based on where the cursor is displayed on the
4261 screen, instead of relying on buffer contents alone. It takes
4262 into account variable-width characters and line continuation.
4263 If nil, `line-move' moves point by logical lines.
4264 A non-nil setting of `goal-column' overrides the value of this variable
4265 and forces movement by logical lines.
4266 Disabling `auto-hscroll-mode' also overrides forces movement by logical
4267 lines when the window is horizontally scrolled."
4268 :type 'boolean
4269 :group 'editing-basics
4270 :version "23.1")
4272 ;; Returns non-nil if partial move was done.
4273 (defun line-move-partial (arg noerror to-end)
4274 (if (< arg 0)
4275 ;; Move backward (up).
4276 ;; If already vscrolled, reduce vscroll
4277 (let ((vs (window-vscroll nil t)))
4278 (when (> vs (frame-char-height))
4279 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4281 ;; Move forward (down).
4282 (let* ((lh (window-line-height -1))
4283 (vpos (nth 1 lh))
4284 (ypos (nth 2 lh))
4285 (rbot (nth 3 lh))
4286 py vs)
4287 (when (or (null lh)
4288 (>= rbot (frame-char-height))
4289 (<= ypos (- (frame-char-height))))
4290 (unless lh
4291 (let ((wend (pos-visible-in-window-p t nil t)))
4292 (setq rbot (nth 3 wend)
4293 vpos (nth 5 wend))))
4294 (cond
4295 ;; If last line of window is fully visible, move forward.
4296 ((or (null rbot) (= rbot 0))
4297 nil)
4298 ;; If cursor is not in the bottom scroll margin, move forward.
4299 ((and (> vpos 0)
4300 (< (setq py
4301 (or (nth 1 (window-line-height))
4302 (let ((ppos (posn-at-point)))
4303 (cdr (or (posn-actual-col-row ppos)
4304 (posn-col-row ppos))))))
4305 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4306 nil)
4307 ;; When already vscrolled, we vscroll some more if we can,
4308 ;; or clear vscroll and move forward at end of tall image.
4309 ((> (setq vs (window-vscroll nil t)) 0)
4310 (when (> rbot 0)
4311 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4312 ;; If cursor just entered the bottom scroll margin, move forward,
4313 ;; but also vscroll one line so redisplay wont recenter.
4314 ((and (> vpos 0)
4315 (= py (min (- (window-text-height) scroll-margin 1)
4316 (1- vpos))))
4317 (set-window-vscroll nil (frame-char-height) t)
4318 (line-move-1 arg noerror to-end)
4319 t)
4320 ;; If there are lines above the last line, scroll-up one line.
4321 ((> vpos 0)
4322 (scroll-up 1)
4323 t)
4324 ;; Finally, start vscroll.
4325 (t
4326 (set-window-vscroll nil (frame-char-height) t)))))))
4329 ;; This is like line-move-1 except that it also performs
4330 ;; vertical scrolling of tall images if appropriate.
4331 ;; That is not really a clean thing to do, since it mixes
4332 ;; scrolling with cursor motion. But so far we don't have
4333 ;; a cleaner solution to the problem of making C-n do something
4334 ;; useful given a tall image.
4335 (defun line-move (arg &optional noerror to-end try-vscroll)
4336 (unless (and auto-window-vscroll try-vscroll
4337 ;; Only vscroll for single line moves
4338 (= (abs arg) 1)
4339 ;; But don't vscroll in a keyboard macro.
4340 (not defining-kbd-macro)
4341 (not executing-kbd-macro)
4342 (line-move-partial arg noerror to-end))
4343 (set-window-vscroll nil 0 t)
4344 (if (and line-move-visual
4345 ;; Display-based column are incompatible with goal-column.
4346 (not goal-column)
4347 ;; When auto-hscroll-mode is turned off and the text in
4348 ;; the window is scrolled to the left, display-based
4349 ;; motion doesn't make sense (because each logical line
4350 ;; occupies exactly one screen line).
4351 (not (and (null auto-hscroll-mode)
4352 (> (window-hscroll) 0))))
4353 (line-move-visual arg noerror)
4354 (line-move-1 arg noerror to-end))))
4356 ;; Display-based alternative to line-move-1.
4357 ;; Arg says how many lines to move. The value is t if we can move the
4358 ;; specified number of lines.
4359 (defun line-move-visual (arg &optional noerror)
4360 (let ((opoint (point))
4361 (hscroll (window-hscroll))
4362 target-hscroll)
4363 ;; Check if the previous command was a line-motion command, or if
4364 ;; we were called from some other command.
4365 (if (and (consp temporary-goal-column)
4366 (memq last-command `(next-line previous-line ,this-command)))
4367 ;; If so, there's no need to reset `temporary-goal-column',
4368 ;; but we may need to hscroll.
4369 (if (or (/= (cdr temporary-goal-column) hscroll)
4370 (> (cdr temporary-goal-column) 0))
4371 (setq target-hscroll (cdr temporary-goal-column)))
4372 ;; Otherwise, we should reset `temporary-goal-column'.
4373 (let ((posn (posn-at-point)))
4374 (cond
4375 ;; Handle the `overflow-newline-into-fringe' case:
4376 ((eq (nth 1 posn) 'right-fringe)
4377 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4378 ((car (posn-x-y posn))
4379 (setq temporary-goal-column
4380 (cons (/ (float (car (posn-x-y posn)))
4381 (frame-char-width)) hscroll))))))
4382 (if target-hscroll
4383 (set-window-hscroll (selected-window) target-hscroll))
4384 (or (and (= (vertical-motion
4385 (cons (or goal-column
4386 (if (consp temporary-goal-column)
4387 (car temporary-goal-column)
4388 temporary-goal-column))
4389 arg))
4390 arg)
4391 (or (>= arg 0)
4392 (/= (point) opoint)
4393 ;; If the goal column lies on a display string,
4394 ;; `vertical-motion' advances the cursor to the end
4395 ;; of the string. For arg < 0, this can cause the
4396 ;; cursor to get stuck. (Bug#3020).
4397 (= (vertical-motion arg) arg)))
4398 (unless noerror
4399 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4400 nil)))))
4402 ;; This is the guts of next-line and previous-line.
4403 ;; Arg says how many lines to move.
4404 ;; The value is t if we can move the specified number of lines.
4405 (defun line-move-1 (arg &optional noerror _to-end)
4406 ;; Don't run any point-motion hooks, and disregard intangibility,
4407 ;; for intermediate positions.
4408 (let ((inhibit-point-motion-hooks t)
4409 (opoint (point))
4410 (orig-arg arg))
4411 (if (consp temporary-goal-column)
4412 (setq temporary-goal-column (+ (car temporary-goal-column)
4413 (cdr temporary-goal-column))))
4414 (unwind-protect
4415 (progn
4416 (if (not (memq last-command '(next-line previous-line)))
4417 (setq temporary-goal-column
4418 (if (and track-eol (eolp)
4419 ;; Don't count beg of empty line as end of line
4420 ;; unless we just did explicit end-of-line.
4421 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4422 most-positive-fixnum
4423 (current-column))))
4425 (if (not (or (integerp selective-display)
4426 line-move-ignore-invisible))
4427 ;; Use just newline characters.
4428 ;; Set ARG to 0 if we move as many lines as requested.
4429 (or (if (> arg 0)
4430 (progn (if (> arg 1) (forward-line (1- arg)))
4431 ;; This way of moving forward ARG lines
4432 ;; verifies that we have a newline after the last one.
4433 ;; It doesn't get confused by intangible text.
4434 (end-of-line)
4435 (if (zerop (forward-line 1))
4436 (setq arg 0)))
4437 (and (zerop (forward-line arg))
4438 (bolp)
4439 (setq arg 0)))
4440 (unless noerror
4441 (signal (if (< arg 0)
4442 'beginning-of-buffer
4443 'end-of-buffer)
4444 nil)))
4445 ;; Move by arg lines, but ignore invisible ones.
4446 (let (done)
4447 (while (and (> arg 0) (not done))
4448 ;; If the following character is currently invisible,
4449 ;; skip all characters with that same `invisible' property value.
4450 (while (and (not (eobp)) (invisible-p (point)))
4451 (goto-char (next-char-property-change (point))))
4452 ;; Move a line.
4453 ;; We don't use `end-of-line', since we want to escape
4454 ;; from field boundaries occurring exactly at point.
4455 (goto-char (constrain-to-field
4456 (let ((inhibit-field-text-motion t))
4457 (line-end-position))
4458 (point) t t
4459 'inhibit-line-move-field-capture))
4460 ;; If there's no invisibility here, move over the newline.
4461 (cond
4462 ((eobp)
4463 (if (not noerror)
4464 (signal 'end-of-buffer nil)
4465 (setq done t)))
4466 ((and (> arg 1) ;; Use vertical-motion for last move
4467 (not (integerp selective-display))
4468 (not (invisible-p (point))))
4469 ;; We avoid vertical-motion when possible
4470 ;; because that has to fontify.
4471 (forward-line 1))
4472 ;; Otherwise move a more sophisticated way.
4473 ((zerop (vertical-motion 1))
4474 (if (not noerror)
4475 (signal 'end-of-buffer nil)
4476 (setq done t))))
4477 (unless done
4478 (setq arg (1- arg))))
4479 ;; The logic of this is the same as the loop above,
4480 ;; it just goes in the other direction.
4481 (while (and (< arg 0) (not done))
4482 ;; For completely consistency with the forward-motion
4483 ;; case, we should call beginning-of-line here.
4484 ;; However, if point is inside a field and on a
4485 ;; continued line, the call to (vertical-motion -1)
4486 ;; below won't move us back far enough; then we return
4487 ;; to the same column in line-move-finish, and point
4488 ;; gets stuck -- cyd
4489 (forward-line 0)
4490 (cond
4491 ((bobp)
4492 (if (not noerror)
4493 (signal 'beginning-of-buffer nil)
4494 (setq done t)))
4495 ((and (< arg -1) ;; Use vertical-motion for last move
4496 (not (integerp selective-display))
4497 (not (invisible-p (1- (point)))))
4498 (forward-line -1))
4499 ((zerop (vertical-motion -1))
4500 (if (not noerror)
4501 (signal 'beginning-of-buffer nil)
4502 (setq done t))))
4503 (unless done
4504 (setq arg (1+ arg))
4505 (while (and ;; Don't move over previous invis lines
4506 ;; if our target is the middle of this line.
4507 (or (zerop (or goal-column temporary-goal-column))
4508 (< arg 0))
4509 (not (bobp)) (invisible-p (1- (point))))
4510 (goto-char (previous-char-property-change (point))))))))
4511 ;; This is the value the function returns.
4512 (= arg 0))
4514 (cond ((> arg 0)
4515 ;; If we did not move down as far as desired, at least go
4516 ;; to end of line. Be sure to call point-entered and
4517 ;; point-left-hooks.
4518 (let* ((npoint (prog1 (line-end-position)
4519 (goto-char opoint)))
4520 (inhibit-point-motion-hooks nil))
4521 (goto-char npoint)))
4522 ((< arg 0)
4523 ;; If we did not move up as far as desired,
4524 ;; at least go to beginning of line.
4525 (let* ((npoint (prog1 (line-beginning-position)
4526 (goto-char opoint)))
4527 (inhibit-point-motion-hooks nil))
4528 (goto-char npoint)))
4529 (t
4530 (line-move-finish (or goal-column temporary-goal-column)
4531 opoint (> orig-arg 0)))))))
4533 (defun line-move-finish (column opoint forward)
4534 (let ((repeat t))
4535 (while repeat
4536 ;; Set REPEAT to t to repeat the whole thing.
4537 (setq repeat nil)
4539 (let (new
4540 (old (point))
4541 (line-beg (line-beginning-position))
4542 (line-end
4543 ;; Compute the end of the line
4544 ;; ignoring effectively invisible newlines.
4545 (save-excursion
4546 ;; Like end-of-line but ignores fields.
4548 (while (and (not (eobp)) (invisible-p (point)))
4549 (goto-char (next-char-property-change (point)))
4551 (point))))
4553 ;; Move to the desired column.
4554 (line-move-to-column (truncate column))
4556 ;; Corner case: suppose we start out in a field boundary in
4557 ;; the middle of a continued line. When we get to
4558 ;; line-move-finish, point is at the start of a new *screen*
4559 ;; line but the same text line; then line-move-to-column would
4560 ;; move us backwards. Test using C-n with point on the "x" in
4561 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4562 (and forward
4563 (< (point) old)
4564 (goto-char old))
4566 (setq new (point))
4568 ;; Process intangibility within a line.
4569 ;; With inhibit-point-motion-hooks bound to nil, a call to
4570 ;; goto-char moves point past intangible text.
4572 ;; However, inhibit-point-motion-hooks controls both the
4573 ;; intangibility and the point-entered/point-left hooks. The
4574 ;; following hack avoids calling the point-* hooks
4575 ;; unnecessarily. Note that we move *forward* past intangible
4576 ;; text when the initial and final points are the same.
4577 (goto-char new)
4578 (let ((inhibit-point-motion-hooks nil))
4579 (goto-char new)
4581 ;; If intangibility moves us to a different (later) place
4582 ;; in the same line, use that as the destination.
4583 (if (<= (point) line-end)
4584 (setq new (point))
4585 ;; If that position is "too late",
4586 ;; try the previous allowable position.
4587 ;; See if it is ok.
4588 (backward-char)
4589 (if (if forward
4590 ;; If going forward, don't accept the previous
4591 ;; allowable position if it is before the target line.
4592 (< line-beg (point))
4593 ;; If going backward, don't accept the previous
4594 ;; allowable position if it is still after the target line.
4595 (<= (point) line-end))
4596 (setq new (point))
4597 ;; As a last resort, use the end of the line.
4598 (setq new line-end))))
4600 ;; Now move to the updated destination, processing fields
4601 ;; as well as intangibility.
4602 (goto-char opoint)
4603 (let ((inhibit-point-motion-hooks nil))
4604 (goto-char
4605 ;; Ignore field boundaries if the initial and final
4606 ;; positions have the same `field' property, even if the
4607 ;; fields are non-contiguous. This seems to be "nicer"
4608 ;; behavior in many situations.
4609 (if (eq (get-char-property new 'field)
4610 (get-char-property opoint 'field))
4611 new
4612 (constrain-to-field new opoint t t
4613 'inhibit-line-move-field-capture))))
4615 ;; If all this moved us to a different line,
4616 ;; retry everything within that new line.
4617 (when (or (< (point) line-beg) (> (point) line-end))
4618 ;; Repeat the intangibility and field processing.
4619 (setq repeat t))))))
4621 (defun line-move-to-column (col)
4622 "Try to find column COL, considering invisibility.
4623 This function works only in certain cases,
4624 because what we really need is for `move-to-column'
4625 and `current-column' to be able to ignore invisible text."
4626 (if (zerop col)
4627 (beginning-of-line)
4628 (move-to-column col))
4630 (when (and line-move-ignore-invisible
4631 (not (bolp)) (invisible-p (1- (point))))
4632 (let ((normal-location (point))
4633 (normal-column (current-column)))
4634 ;; If the following character is currently invisible,
4635 ;; skip all characters with that same `invisible' property value.
4636 (while (and (not (eobp))
4637 (invisible-p (point)))
4638 (goto-char (next-char-property-change (point))))
4639 ;; Have we advanced to a larger column position?
4640 (if (> (current-column) normal-column)
4641 ;; We have made some progress towards the desired column.
4642 ;; See if we can make any further progress.
4643 (line-move-to-column (+ (current-column) (- col normal-column)))
4644 ;; Otherwise, go to the place we originally found
4645 ;; and move back over invisible text.
4646 ;; that will get us to the same place on the screen
4647 ;; but with a more reasonable buffer position.
4648 (goto-char normal-location)
4649 (let ((line-beg (line-beginning-position)))
4650 (while (and (not (bolp)) (invisible-p (1- (point))))
4651 (goto-char (previous-char-property-change (point) line-beg))))))))
4653 (defun move-end-of-line (arg)
4654 "Move point to end of current line as displayed.
4655 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4656 If point reaches the beginning or end of buffer, it stops there.
4658 To ignore the effects of the `intangible' text or overlay
4659 property, bind `inhibit-point-motion-hooks' to t.
4660 If there is an image in the current line, this function
4661 disregards newlines that are part of the text on which the image
4662 rests."
4663 (interactive "^p")
4664 (or arg (setq arg 1))
4665 (let (done)
4666 (while (not done)
4667 (let ((newpos
4668 (save-excursion
4669 (let ((goal-column 0)
4670 (line-move-visual nil))
4671 (and (line-move arg t)
4672 ;; With bidi reordering, we may not be at bol,
4673 ;; so make sure we are.
4675 (not (bobp))
4676 (progn
4677 (while (and (not (bobp)) (invisible-p (1- (point))))
4678 (goto-char (previous-single-char-property-change
4679 (point) 'invisible)))
4680 (backward-char 1)))
4681 (point)))))
4682 (goto-char newpos)
4683 (if (and (> (point) newpos)
4685 (backward-char 1)
4686 (if (and (> (point) newpos) (not (eobp))
4688 ;; If we skipped something intangible and now we're not
4689 ;; really at eol, keep going.
4690 (setq arg 1)
4691 (setq done t)))))))
4693 (defun move-beginning-of-line (arg)
4694 "Move point to beginning of current line as displayed.
4695 \(If there's an image in the line, this disregards newlines
4696 which are part of the text that the image rests on.)
4698 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4699 If point reaches the beginning or end of buffer, it stops there.
4700 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4701 (interactive "^p")
4702 (or arg (setq arg 1))
4704 (let ((orig (point))
4705 first-vis first-vis-field-value)
4707 ;; Move by lines, if ARG is not 1 (the default).
4708 (if (/= arg 1)
4709 (let ((line-move-visual nil))
4710 (line-move (1- arg) t)))
4712 ;; Move to beginning-of-line, ignoring fields and invisibles.
4714 (while (and (not (bobp)) (invisible-p (1- (point))))
4715 (goto-char (previous-char-property-change (point)))
4718 ;; Now find first visible char in the line
4719 (while (and (not (eobp)) (invisible-p (point)))
4720 (goto-char (next-char-property-change (point))))
4721 (setq first-vis (point))
4723 ;; See if fields would stop us from reaching FIRST-VIS.
4724 (setq first-vis-field-value
4725 (constrain-to-field first-vis orig (/= arg 1) t nil))
4727 (goto-char (if (/= first-vis-field-value first-vis)
4728 ;; If yes, obey them.
4729 first-vis-field-value
4730 ;; Otherwise, move to START with attention to fields.
4731 ;; (It is possible that fields never matter in this case.)
4732 (constrain-to-field (point) orig
4733 (/= arg 1) t nil)))))
4736 ;; Many people have said they rarely use this feature, and often type
4737 ;; it by accident. Maybe it shouldn't even be on a key.
4738 (put 'set-goal-column 'disabled t)
4740 (defun set-goal-column (arg)
4742 Those commands will move to this position in the line moved to
4743 rather than trying to keep the same horizontal position.
4744 With a non-nil argument ARG, clears out the goal column
4746 The goal column is stored in the variable `goal-column'."
4747 (interactive "P")
4748 (if arg
4749 (progn
4750 (setq goal-column nil)
4751 (message "No goal column"))
4752 (setq goal-column (current-column))
4753 ;; The older method below can be erroneous if `set-goal-column' is bound
4754 ;; to a sequence containing %
4755 ;;(message (substitute-command-keys
4757 ;;goal-column)
4758 (message "%s"
4759 (concat
4760 (format "Goal column %d " goal-column)
4761 (substitute-command-keys
4764 )
4765 nil)
4766 \f
4767 ;;; Editing based on visual lines, as opposed to logical lines.
4769 (defun end-of-visual-line (&optional n)
4770 "Move point to end of current visual line.
4771 With argument N not nil or 1, move forward N - 1 visual lines first.
4772 If point reaches the beginning or end of buffer, it stops there.
4773 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4774 (interactive "^p")
4775 (or n (setq n 1))
4776 (if (/= n 1)
4777 (let ((line-move-visual t))
4778 (line-move (1- n) t)))
4779 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4780 ;; constrain to field boundaries, so we don't either.
4781 (vertical-motion (cons (window-width) 0)))
4783 (defun beginning-of-visual-line (&optional n)
4784 "Move point to beginning of current visual line.
4785 With argument N not nil or 1, move forward N - 1 visual lines first.
4786 If point reaches the beginning or end of buffer, it stops there.
4787 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4788 (interactive "^p")
4789 (or n (setq n 1))
4790 (let ((opoint (point)))
4791 (if (/= n 1)
4792 (let ((line-move-visual t))
4793 (line-move (1- n) t)))
4794 (vertical-motion 0)
4795 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4796 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4798 (defun kill-visual-line (&optional arg)
4799 "Kill the rest of the visual line.
4800 With prefix argument ARG, kill that many visual lines from point.
4801 If ARG is negative, kill visual lines backward.
4802 If ARG is zero, kill the text before point on the current visual
4803 line.
4805 If you want to append the killed line to the last killed text,
4808 If the buffer is read-only, Emacs will beep and refrain from deleting
4809 the line, but put the line in the kill ring anyway. This means that
4810 you can use this command to copy text from a read-only buffer.
4811 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4812 even beep.)"
4813 (interactive "P")
4814 ;; Like in `kill-line', it's better to move point to the other end
4815 ;; of the kill before killing.
4816 (let ((opoint (point))
4817 (kill-whole-line (and kill-whole-line (bolp))))
4818 (if arg
4819 (vertical-motion (prefix-numeric-value arg))
4820 (end-of-visual-line 1)
4821 (if (= (point) opoint)
4822 (vertical-motion 1)
4823 ;; Skip any trailing whitespace at the end of the visual line.
4824 ;; We used to do this only if `show-trailing-whitespace' is
4825 ;; nil, but that's wrong; the correct thing would be to check
4826 ;; whether the trailing whitespace is highlighted. But, it's
4827 ;; OK to just do this unconditionally.
4830 (1+ (point))
4831 (point)))))
4833 (defun next-logical-line (&optional arg try-vscroll)
4834 "Move cursor vertically down ARG lines.
4835 This is identical to `next-line', except that it always moves
4836 by logical lines instead of visual lines, ignoring the value of
4837 the variable `line-move-visual'."
4839 (let ((line-move-visual nil))
4840 (with-no-warnings
4841 (next-line arg try-vscroll))))
4843 (defun previous-logical-line (&optional arg try-vscroll)
4844 "Move cursor vertically up ARG lines.
4845 This is identical to `previous-line', except that it always moves
4846 by logical lines instead of visual lines, ignoring the value of
4847 the variable `line-move-visual'."
4849 (let ((line-move-visual nil))
4850 (with-no-warnings
4851 (previous-line arg try-vscroll))))
4853 (defgroup visual-line nil
4854 "Editing based on visual lines."
4855 :group 'convenience
4856 :version "23.1")
4858 (defvar visual-line-mode-map
4859 (let ((map (make-sparse-keymap)))
4860 (define-key map [remap kill-line] 'kill-visual-line)
4861 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4862 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4863 ;; These keybindings interfere with xterm function keys. Are
4864 ;; there any other suitable bindings?
4865 ;; (define-key map "\M-[" 'previous-logical-line)
4866 ;; (define-key map "\M-]" 'next-logical-line)
4867 map))
4869 (defcustom visual-line-fringe-indicators '(nil nil)
4870 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4871 The value should be a list of the form (LEFT RIGHT), where LEFT
4872 and RIGHT are symbols representing the bitmaps to display, to
4873 indicate wrapped lines, in the left and right fringes respectively.
4874 See also `fringe-indicator-alist'.
4875 The default is not to display fringe indicators for wrapped lines.
4876 This variable does not affect fringe indicators displayed for
4877 other purposes."
4878 :type '(list (choice (const :tag "Hide left indicator" nil)
4879 (const :tag "Left curly arrow" left-curly-arrow)
4880 (symbol :tag "Other bitmap"))
4881 (choice (const :tag "Hide right indicator" nil)
4882 (const :tag "Right curly arrow" right-curly-arrow)
4883 (symbol :tag "Other bitmap")))
4884 :set (lambda (symbol value)
4885 (dolist (buf (buffer-list))
4886 (with-current-buffer buf
4887 (when (and (boundp 'visual-line-mode)
4888 (symbol-value 'visual-line-mode))
4889 (setq fringe-indicator-alist
4890 (cons (cons 'continuation value)
4891 (assq-delete-all
4892 'continuation
4893 (copy-tree fringe-indicator-alist)))))))
4894 (set-default symbol value)))
4896 (defvar visual-line--saved-state nil)
4898 (define-minor-mode visual-line-mode
4899 "Redefine simple editing commands to act on visual lines, not logical lines.
4900 This also turns on `word-wrap' in the buffer."
4901 :keymap visual-line-mode-map
4902 :group 'visual-line
4903 :lighter " Wrap"
4904 (if visual-line-mode
4905 (progn
4906 (set (make-local-variable 'visual-line--saved-state) nil)
4907 ;; Save the local values of some variables, to be restored if
4908 ;; visual-line-mode is turned off.
4909 (dolist (var '(line-move-visual truncate-lines
4910 truncate-partial-width-windows
4911 word-wrap fringe-indicator-alist))
4912 (if (local-variable-p var)
4913 (push (cons var (symbol-value var))
4914 visual-line--saved-state)))
4915 (set (make-local-variable 'line-move-visual) t)
4916 (set (make-local-variable 'truncate-partial-width-windows) nil)
4917 (setq truncate-lines nil
4918 word-wrap t
4919 fringe-indicator-alist
4920 (cons (cons 'continuation visual-line-fringe-indicators)
4921 fringe-indicator-alist)))
4922 (kill-local-variable 'line-move-visual)
4923 (kill-local-variable 'word-wrap)
4924 (kill-local-variable 'truncate-lines)
4925 (kill-local-variable 'truncate-partial-width-windows)
4926 (kill-local-variable 'fringe-indicator-alist)
4927 (dolist (saved visual-line--saved-state)
4928 (set (make-local-variable (car saved)) (cdr saved)))
4929 (kill-local-variable 'visual-line--saved-state)))
4931 (defun turn-on-visual-line-mode ()
4932 (visual-line-mode 1))
4934 (define-globalized-minor-mode global-visual-line-mode
4935 visual-line-mode turn-on-visual-line-mode
4936 :lighter " vl")
4938 \f
4939 (defun transpose-chars (arg)
4940 "Interchange characters around point, moving forward one character.
4941 With prefix arg ARG, effect is to take character before point
4942 and drag it forward past ARG other characters (backward if ARG negative).
4943 If no argument and at end of line, the previous two chars are exchanged."
4944 (interactive "*P")
4945 (and (null arg) (eolp) (forward-char -1))
4946 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4948 (defun transpose-words (arg)
4949 "Interchange words around point, leaving point at end of them.
4950 With prefix arg ARG, effect is to take word before or around point
4951 and drag it forward past ARG other words (backward if ARG negative).
4952 If ARG is zero, the words around or after point and around or after mark
4953 are interchanged."
4954 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4955 (interactive "*p")
4956 (transpose-subr 'forward-word arg))
4958 (defun transpose-sexps (arg)
4960 Does not work on a sexp that point is in the middle of
4961 if it is a list or string."
4962 (interactive "*p")
4963 (transpose-subr
4964 (lambda (arg)
4965 ;; Here we should try to simulate the behavior of
4966 ;; (cons (progn (forward-sexp x) (point))
4967 ;; (progn (forward-sexp (- x)) (point)))
4968 ;; Except that we don't want to rely on the second forward-sexp
4969 ;; putting us back to where we want to be, since forward-sexp-function
4970 ;; might do funny things like infix-precedence.
4971 (if (if (> arg 0)
4973 (and (not (bobp))
4975 ;; Jumping over a symbol. We might be inside it, mind you.
4976 (progn (funcall (if (> arg 0)
4977 'skip-syntax-backward 'skip-syntax-forward)
4978 "w_")
4979 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4980 ;; Otherwise, we're between sexps. Take a step back before jumping
4981 ;; to make sure we'll obey the same precedence no matter which direction
4982 ;; we're going.
4983 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4984 (cons (save-excursion (forward-sexp arg) (point))
4985 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4986 (not (zerop (funcall (if (> arg 0)
4987 'skip-syntax-forward
4988 'skip-syntax-backward)
4989 ".")))))
4990 (point)))))
4991 arg 'special))
4993 (defun transpose-lines (arg)
4994 "Exchange current line and previous line, leaving point after both.
4995 With argument ARG, takes previous line and moves it past ARG lines.
4996 With argument 0, interchanges line point is in with line mark is in."
4997 (interactive "*p")
4998 (transpose-subr (function
4999 (lambda (arg)
5000 (if (> arg 0)
5001 (progn
5002 ;; Move forward over ARG lines,
5003 ;; but create newlines if necessary.
5004 (setq arg (forward-line arg))
5006 (setq arg (1+ arg)))
5007 (if (> arg 0)
5008 (newline arg)))
5009 (forward-line arg))))
5010 arg))
5012 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5013 ;; which seems inconsistent with the ARG /= 0 case.
5014 ;; FIXME document SPECIAL.
5015 (defun transpose-subr (mover arg &optional special)
5016 "Subroutine to do the work of transposing objects.
5017 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5018 moves forward by units of the given object (e.g. forward-sentence,
5019 forward-paragraph). If ARG is zero, exchanges the current object
5020 with the one containing mark. If ARG is an integer, moves the
5021 current object past ARG following (if ARG is positive) or
5022 preceding (if ARG is negative) objects, leaving point after the
5023 current object."
5024 (let ((aux (if special mover
5025 (lambda (x)
5026 (cons (progn (funcall mover x) (point))
5027 (progn (funcall mover (- x)) (point))))))
5028 pos1 pos2)
5029 (cond
5030 ((= arg 0)
5031 (save-excursion
5032 (setq pos1 (funcall aux 1))
5033 (goto-char (or (mark) (error "No mark set in this buffer")))
5034 (setq pos2 (funcall aux 1))
5035 (transpose-subr-1 pos1 pos2))
5036 (exchange-point-and-mark))
5037 ((> arg 0)
5038 (setq pos1 (funcall aux -1))
5039 (setq pos2 (funcall aux arg))
5040 (transpose-subr-1 pos1 pos2)
5041 (goto-char (car pos2)))
5042 (t
5043 (setq pos1 (funcall aux -1))
5044 (goto-char (car pos1))
5045 (setq pos2 (funcall aux arg))
5046 (transpose-subr-1 pos1 pos2)))))
5048 (defun transpose-subr-1 (pos1 pos2)
5049 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5050 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5051 (when (> (car pos1) (car pos2))
5052 (let ((swap pos1))
5053 (setq pos1 pos2 pos2 swap)))
5054 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5055 (atomic-change-group
5056 (let (word2)
5057 ;; FIXME: We first delete the two pieces of text, so markers that
5058 ;; used to point to after the text end up pointing to before it :-(
5059 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5060 (goto-char (car pos2))
5061 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5062 (goto-char (car pos1))
5063 (insert word2))))
5064 \f
5065 (defun backward-word (&optional arg)
5066 "Move backward until encountering the beginning of a word.
5067 With argument ARG, do this that many times."
5068 (interactive "^p")
5069 (forward-word (- (or arg 1))))
5071 (defun mark-word (&optional arg allow-extend)
5072 "Set mark ARG words away from point.
5074 move to with the same argument.
5075 Interactively, if this command is repeated
5076 or (in Transient Mark mode) if the mark is active,
5077 it marks the next ARG words after the ones already marked."
5079 (cond ((and allow-extend
5080 (or (and (eq last-command this-command) (mark t))
5081 (region-active-p)))
5082 (setq arg (if arg (prefix-numeric-value arg)
5083 (if (< (mark) (point)) -1 1)))
5084 (set-mark
5085 (save-excursion
5086 (goto-char (mark))
5087 (forward-word arg)
5088 (point))))
5089 (t
5090 (push-mark
5091 (save-excursion
5092 (forward-word (prefix-numeric-value arg))
5093 (point))
5094 nil t))))
5096 (defun kill-word (arg)
5097 "Kill characters forward until encountering the end of a word.
5098 With argument ARG, do this that many times."
5099 (interactive "p")
5100 (kill-region (point) (progn (forward-word arg) (point))))
5102 (defun backward-kill-word (arg)
5103 "Kill characters backward until encountering the beginning of a word.
5104 With argument ARG, do this that many times."
5105 (interactive "p")
5106 (kill-word (- arg)))
5108 (defun current-word (&optional strict really-word)
5109 "Return the symbol or word that point is on (or a nearby one) as a string.
5110 The return value includes no text properties.
5111 If optional arg STRICT is non-nil, return nil unless point is within
5112 or adjacent to a symbol or word. In all cases the value can be nil
5113 if there is no word nearby.
5114 The function, belying its name, normally finds a symbol.
5115 If optional arg REALLY-WORD is non-nil, it finds just a word."
5116 (save-excursion
5117 (let* ((oldpoint (point)) (start (point)) (end (point))
5118 (syntaxes (if really-word "w" "w_"))
5119 (not-syntaxes (concat "^" syntaxes)))
5120 (skip-syntax-backward syntaxes) (setq start (point))
5121 (goto-char oldpoint)
5122 (skip-syntax-forward syntaxes) (setq end (point))
5123 (when (and (eq start oldpoint) (eq end oldpoint)
5124 ;; Point is neither within nor adjacent to a word.
5125 (not strict))
5126 ;; Look for preceding word in same line.
5127 (skip-syntax-backward not-syntaxes (line-beginning-position))
5128 (if (bolp)
5129 ;; No preceding word in same line.
5130 ;; Look for following word in same line.
5131 (progn
5132 (skip-syntax-forward not-syntaxes (line-end-position))
5133 (setq start (point))
5134 (skip-syntax-forward syntaxes)
5135 (setq end (point)))
5136 (setq end (point))
5137 (skip-syntax-backward syntaxes)
5138 (setq start (point))))
5139 ;; If we found something nonempty, return it as a string.
5140 (unless (= start end)
5141 (buffer-substring-no-properties start end)))))
5142 \f
5143 (defcustom fill-prefix nil
5144 "String for filling to insert at front of new line, or nil for none."
5145 :type '(choice (const :tag "None" nil)
5146 string)
5147 :group 'fill)
5148 (make-variable-buffer-local 'fill-prefix)
5149 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5151 (defcustom auto-fill-inhibit-regexp nil
5152 "Regexp to match lines which should not be auto-filled."
5153 :type '(choice (const :tag "None" nil)
5154 regexp)
5155 :group 'fill)
5157 (defun do-auto-fill ()
5158 "The default value for `normal-auto-fill-function'.
5159 This is the default auto-fill function, some major modes use a different one.
5160 Returns t if it really did any work."
5161 (let (fc justify give-up
5162 (fill-prefix fill-prefix))
5163 (if (or (not (setq justify (current-justification)))
5164 (null (setq fc (current-fill-column)))
5165 (and (eq justify 'left)
5166 (<= (current-column) fc))
5167 (and auto-fill-inhibit-regexp
5168 (save-excursion (beginning-of-line)
5169 (looking-at auto-fill-inhibit-regexp))))
5170 nil ;; Auto-filling not required
5171 (if (memq justify '(full center right))
5172 (save-excursion (unjustify-current-line)))
5174 ;; Choose a fill-prefix automatically.
5175 (when (and adaptive-fill-mode
5176 (or (null fill-prefix) (string= fill-prefix "")))
5177 (let ((prefix
5178 (fill-context-prefix
5179 (save-excursion (fill-forward-paragraph -1) (point))
5180 (save-excursion (fill-forward-paragraph 1) (point)))))
5181 (and prefix (not (equal prefix ""))
5182 ;; Use auto-indentation rather than a guessed empty prefix.
5183 (not (and fill-indent-according-to-mode
5185 (setq fill-prefix prefix))))
5187 (while (and (not give-up) (> (current-column) fc))
5188 ;; Determine where to split the line.
5189 (let* (after-prefix
5190 (fill-point
5191 (save-excursion
5192 (beginning-of-line)
5193 (setq after-prefix (point))
5194 (and fill-prefix
5195 (looking-at (regexp-quote fill-prefix))
5196 (setq after-prefix (match-end 0)))
5197 (move-to-column (1+ fc))
5198 (fill-move-to-break-point after-prefix)
5199 (point))))
5201 ;; See whether the place we found is any good.
5202 (if (save-excursion
5203 (goto-char fill-point)
5204 (or (bolp)
5205 ;; There is no use breaking at end of line.
5206 (save-excursion (skip-chars-forward " ") (eolp))
5207 ;; It is futile to split at the end of the prefix
5208 ;; since we would just insert the prefix again.
5209 (and after-prefix (<= (point) after-prefix))
5210 ;; Don't split right after a comment starter
5211 ;; since we would just make another comment starter.
5212 (and comment-start-skip
5213 (let ((limit (point)))
5214 (beginning-of-line)
5215 (and (re-search-forward comment-start-skip
5216 limit t)
5217 (eq (point) limit))))))
5218 ;; No good place to break => stop trying.
5219 (setq give-up t)
5220 ;; Ok, we have a useful place to break the line. Do it.
5221 (let ((prev-column (current-column)))
5222 ;; If point is at the fill-point, do not `save-excursion'.
5223 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5224 ;; point will end up before it rather than after it.
5225 (if (save-excursion
5227 (= (point) fill-point))
5228 (default-indent-new-line t)
5229 (save-excursion
5230 (goto-char fill-point)
5231 (default-indent-new-line t)))
5232 ;; Now do justification, if required
5233 (if (not (eq justify 'left))
5234 (save-excursion
5235 (end-of-line 0)
5236 (justify-current-line justify nil t)))
5237 ;; If making the new line didn't reduce the hpos of
5238 ;; the end of the line, then give up now;
5239 ;; trying again will not help.
5240 (if (>= (current-column) prev-column)
5241 (setq give-up t))))))
5242 ;; Justify last line.
5243 (justify-current-line justify t t)
5244 t)))
5246 (defvar comment-line-break-function 'comment-indent-new-line
5247 "*Mode-specific function which line breaks and continues a comment.
5248 This function is called during auto-filling when a comment syntax
5249 is defined.
5250 The function should take a single optional argument, which is a flag
5251 indicating whether it should use soft newlines.")
5253 (defun default-indent-new-line (&optional soft)
5254 "Break line at point and indent.
5255 If a comment syntax is defined, call `comment-indent-new-line'.
5257 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5258 unless optional argument SOFT is non-nil."
5259 (interactive)
5260 (if comment-start
5261 (funcall comment-line-break-function soft)
5262 ;; Insert the newline before removing empty space so that markers
5263 ;; get preserved better.
5265 (save-excursion (forward-char -1) (delete-horizontal-space))
5266 (delete-horizontal-space)
5268 (if (and fill-prefix (not adaptive-fill-mode))
5269 ;; Blindly trust a non-adaptive fill-prefix.
5270 (progn
5271 (indent-to-left-margin)
5272 (insert-before-markers-and-inherit fill-prefix))
5274 (cond
5275 ;; If there's an adaptive prefix, use it unless we're inside
5276 ;; a comment and the prefix is not a comment starter.
5277 (fill-prefix
5278 (indent-to-left-margin)
5279 (insert-and-inherit fill-prefix))
5280 ;; If we're not inside a comment, just try to indent.
5281 (t (indent-according-to-mode))))))
5283 (defvar normal-auto-fill-function 'do-auto-fill
5284 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5285 Some major modes set this.")
5287 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5288 ;; `functions' and `hooks' are usually unsafe to set, but setting
5289 ;; auto-fill-function to nil in a file-local setting is safe and
5290 ;; can be useful to prevent auto-filling.
5291 (put 'auto-fill-function 'safe-local-variable 'null)
5293 (define-minor-mode auto-fill-mode
5294 "Toggle Auto Fill mode.
5295 With ARG, turn Auto Fill mode on if and only if ARG is positive.
5296 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
5297 automatically breaks the line at a previous space.
5299 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5300 non-`nil'.
5302 The value of `normal-auto-fill-function' specifies the function to use
5303 for `auto-fill-function' when turning Auto Fill mode on."
5304 :variable (eq auto-fill-function normal-auto-fill-function))
5306 ;; This holds a document string used to document auto-fill-mode.
5307 (defun auto-fill-function ()
5308 "Automatically break line at a previous space, in insertion of text."
5309 nil)
5311 (defun turn-on-auto-fill ()
5312 "Unconditionally turn on Auto Fill mode."
5313 (auto-fill-mode 1))
5315 (defun turn-off-auto-fill ()
5316 "Unconditionally turn off Auto Fill mode."
5317 (auto-fill-mode -1))
5319 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5321 (defun set-fill-column (arg)
5322 "Set `fill-column' to specified argument.
5325 (interactive
5326 (list (or current-prefix-arg
5327 ;; We used to use current-column silently, but C-x f is too easily
5328 ;; typed as a typo for C-x C-f, so we turned it into an error and
5329 ;; now an interactive prompt.
5330 (read-number "Set fill-column to: " (current-column)))))
5331 (if (consp arg)
5332 (setq arg (current-column)))
5333 (if (not (integerp arg))
5334 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5335 (error "set-fill-column requires an explicit argument")
5336 (message "Fill column set to %d (was %d)" arg fill-column)
5337 (setq fill-column arg)))
5338 \f
5339 (defun set-selective-display (arg)
5340 "Set `selective-display' to ARG; clear it if no arg.
5341 When the value of `selective-display' is a number > 0,
5342 lines whose indentation is >= that value are not displayed.
5343 The variable `selective-display' has a separate value for each buffer."
5344 (interactive "P")
5345 (if (eq selective-display t)
5346 (error "selective-display already in use for marked lines"))
5347 (let ((current-vpos
5348 (save-restriction
5349 (narrow-to-region (point-min) (point))
5350 (goto-char (window-start))
5351 (vertical-motion (window-height)))))
5352 (setq selective-display
5353 (and arg (prefix-numeric-value arg)))
5354 (recenter current-vpos))
5355 (set-window-start (selected-window) (window-start (selected-window)))
5356 (princ "selective-display set to " t)
5357 (prin1 selective-display t)
5358 (princ "." t))
5360 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5362 (defun toggle-truncate-lines (&optional arg)
5363 "Toggle truncating of long lines for the current buffer.
5364 When truncating is off, long lines are folded.
5365 With prefix argument ARG, truncate long lines if ARG is positive,
5366 otherwise fold them. Note that in side-by-side windows, this
5367 command has no effect if `truncate-partial-width-windows' is
5368 non-nil."
5369 (interactive "P")
5370 (setq truncate-lines
5371 (if (null arg)
5372 (not truncate-lines)
5373 (> (prefix-numeric-value arg) 0)))
5374 (force-mode-line-update)
5375 (unless truncate-lines
5376 (let ((buffer (current-buffer)))
5377 (walk-windows (lambda (window)
5378 (if (eq buffer (window-buffer window))
5379 (set-window-hscroll window 0)))
5380 nil t)))
5381 (message "Truncate long lines %s"
5382 (if truncate-lines "enabled" "disabled")))
5384 (defun toggle-word-wrap (&optional arg)
5385 "Toggle whether to use word-wrapping for continuation lines.
5386 With prefix argument ARG, wrap continuation lines at word boundaries
5387 if ARG is positive, otherwise wrap them at the right screen edge.
5388 This command toggles the value of `word-wrap'. It has no effect
5389 if long lines are truncated."
5390 (interactive "P")
5391 (setq word-wrap
5392 (if (null arg)
5393 (not word-wrap)
5394 (> (prefix-numeric-value arg) 0)))
5395 (force-mode-line-update)
5396 (message "Word wrapping %s"
5397 (if word-wrap "enabled" "disabled")))
5399 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5400 "The string displayed in the mode line when in overwrite mode.")
5401 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5402 "The string displayed in the mode line when in binary overwrite mode.")
5404 (define-minor-mode overwrite-mode
5405 "Toggle overwrite mode.
5406 With prefix argument ARG, turn overwrite mode on if ARG is positive,
5407 otherwise turn it off. In overwrite mode, printing characters typed
5408 in replace existing text on a one-for-one basis, rather than pushing
5409 it to the right. At the end of a line, such characters extend the line.
5410 Before a tab, such characters insert until the tab is filled in.
5412 is supposed to make it easier to insert characters when necessary."
5413 :variable (eq overwrite-mode 'overwrite-mode-textual))
5415 (define-minor-mode binary-overwrite-mode
5416 "Toggle binary overwrite mode.
5417 With prefix argument ARG, turn binary overwrite mode on if ARG is
5418 positive, otherwise turn it off. In binary overwrite mode, printing
5419 characters typed in replace existing text. Newlines are not treated
5420 specially, so typing at the end of a line joins the line to the next,
5421 with the typed character between them. Typing before a tab character
5423 replaces the text at the cursor, just as ordinary typing characters do.
5425 Note that binary overwrite mode is not its own minor mode; it is a
5426 specialization of overwrite mode, entered by setting the
5427 `overwrite-mode' variable to `overwrite-mode-binary'."
5428 :variable (eq overwrite-mode 'overwrite-mode-binary))
5430 (define-minor-mode line-number-mode
5431 "Toggle Line Number mode.
5432 With ARG, turn Line Number mode on if ARG is positive, otherwise
5433 turn it off. When Line Number mode is enabled, the line number
5434 appears in the mode line.
5436 Line numbers do not appear for very large buffers and buffers
5437 with very long lines; see variables `line-number-display-limit'
5438 and `line-number-display-limit-width'."
5439 :init-value t :global t :group 'mode-line)
5441 (define-minor-mode column-number-mode
5442 "Toggle Column Number mode.
5443 With ARG, turn Column Number mode on if ARG is positive,
5444 otherwise turn it off. When Column Number mode is enabled, the
5445 column number appears in the mode line."
5446 :global t :group 'mode-line)
5448 (define-minor-mode size-indication-mode
5449 "Toggle Size Indication mode.
5450 With ARG, turn Size Indication mode on if ARG is positive,
5451 otherwise turn it off. When Size Indication mode is enabled, the
5452 size of the accessible part of the buffer appears in the mode line."
5453 :global t :group 'mode-line)
5455 (define-minor-mode auto-save-mode
5456 "Toggle auto-saving of contents of current buffer.
5457 With prefix argument ARG, turn auto-saving on if positive, else off."
5458 :variable ((and buffer-auto-save-file-name
5459 ;; If auto-save is off because buffer has shrunk,
5460 ;; then toggling should turn it on.
5461 (>= buffer-saved-size 0))
5462 . (lambda (val)
5463 (setq buffer-auto-save-file-name
5464 (cond
5465 ((null val) nil)
5466 ((and buffer-file-name auto-save-visited-file-name
5467 (not buffer-read-only))
5468 buffer-file-name)
5469 (t (make-auto-save-file-name))))))
5470 ;; If -1 was stored here, to temporarily turn off saving,
5471 ;; turn it back on.
5472 (and (< buffer-saved-size 0)
5473 (setq buffer-saved-size 0)))
5474 \f
5475 (defgroup paren-blinking nil
5476 "Blinking matching of parens and expressions."
5477 :prefix "blink-matching-"
5478 :group 'paren-matching)
5480 (defcustom blink-matching-paren t
5481 "Non-nil means show matching open-paren when close-paren is inserted."
5482 :type 'boolean
5483 :group 'paren-blinking)
5485 (defcustom blink-matching-paren-on-screen t
5486 "Non-nil means show matching open-paren when it is on screen.
5487 If nil, don't show it (but the open-paren can still be shown
5488 when it is off screen).
5490 This variable has no effect if `blink-matching-paren' is nil.
5491 \(In that case, the open-paren is never shown.)
5492 It is also ignored if `show-paren-mode' is enabled."
5493 :type 'boolean
5494 :group 'paren-blinking)
5496 (defcustom blink-matching-paren-distance (* 100 1024)
5497 "If non-nil, maximum distance to search backwards for matching open-paren.
5498 If nil, search stops at the beginning of the accessible portion of the buffer."
5499 :version "23.2" ; 25->100k
5500 :type '(choice (const nil) integer)
5501 :group 'paren-blinking)
5503 (defcustom blink-matching-delay 1
5504 "Time in seconds to delay after showing a matching paren."
5505 :type 'number
5506 :group 'paren-blinking)
5508 (defcustom blink-matching-paren-dont-ignore-comments nil
5509 "If nil, `blink-matching-paren' ignores comments.
5510 More precisely, when looking for the matching parenthesis,
5511 it skips the contents of comments that end before point."
5512 :type 'boolean
5513 :group 'paren-blinking)
5515 (defun blink-matching-check-mismatch (start end)
5516 "Return whether or not START...END are matching parens.
5517 END is the current point and START is the blink position.
5518 START might be nil if no matching starter was found.
5519 Returns non-nil if we find there is a mismatch."
5520 (let* ((end-syntax (syntax-after (1- end)))
5521 (matching-paren (and (consp end-syntax)
5522 (eq (syntax-class end-syntax) 5)
5523 (cdr end-syntax))))
5524 ;; For self-matched chars like " and $, we can't know when they're
5525 ;; mismatched or unmatched, so we can only do it for parens.
5526 (when matching-paren
5527 (not (and start
5528 (or
5529 (eq (char-after start) matching-paren)
5530 ;; The cdr might hold a new paren-class info rather than
5531 ;; a matching-char info, in which case the two CDRs
5532 ;; should match.
5533 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5535 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5536 "Function to check parentheses mismatches.
5537 The function takes two arguments (START and END) where START is the
5538 position just before the opening token and END is the position right after.
5539 START can be nil, if it was not found.
5540 The function should return non-nil if the two tokens do not match.")
5542 (defun blink-matching-open ()
5543 "Move cursor momentarily to the beginning of the sexp before point."
5544 (interactive)
5545 (when (and (not (bobp))
5546 blink-matching-paren)
5547 (let* ((oldpos (point))
5548 (message-log-max nil) ; Don't log messages about paren matching.
5549 (blinkpos
5550 (save-excursion
5551 (save-restriction
5552 (if blink-matching-paren-distance
5553 (narrow-to-region
5554 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5555 (- (point) blink-matching-paren-distance))
5556 oldpos))
5557 (let ((parse-sexp-ignore-comments
5558 (and parse-sexp-ignore-comments
5559 (not blink-matching-paren-dont-ignore-comments))))
5560 (condition-case ()
5561 (progn
5562 (forward-sexp -1)
5563 ;; backward-sexp skips backward over prefix chars,
5564 ;; so move back to the matching paren.
5565 (while (and (< (point) (1- oldpos))
5566 (let ((code (syntax-after (point))))
5567 (or (eq (syntax-class code) 6)
5568 (eq (logand 1048576 (car code))
5569 1048576))))
5570 (forward-char 1))
5571 (point))
5572 (error nil))))))
5573 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5574 (cond
5575 (mismatch
5576 (if blinkpos
5577 (if (minibufferp)
5578 (minibuffer-message "Mismatched parentheses")
5579 (message "Mismatched parentheses"))
5580 (if (minibufferp)
5581 (minibuffer-message "No matching parenthesis found")
5582 (message "No matching parenthesis found"))))
5583 ((not blinkpos) nil)
5584 ((pos-visible-in-window-p blinkpos)
5585 ;; Matching open within window, temporarily move to blinkpos but only
5586 ;; if `blink-matching-paren-on-screen' is non-nil.
5587 (and blink-matching-paren-on-screen
5588 (not show-paren-mode)
5589 (save-excursion
5590 (goto-char blinkpos)
5591 (sit-for blink-matching-delay))))
5592 (t
5593 (save-excursion
5594 (goto-char blinkpos)
5595 (let ((open-paren-line-string
5596 ;; Show what precedes the open in its line, if anything.
5597 (cond
5599 (buffer-substring (line-beginning-position)
5600 (1+ blinkpos)))
5601 ;; Show what follows the open in its line, if anything.
5602 ((save-excursion
5603 (forward-char 1)
5605 (not (eolp)))
5606 (buffer-substring blinkpos
5607 (line-end-position)))
5608 ;; Otherwise show the previous nonblank line,
5609 ;; if there is one.
5611 (concat
5612 (buffer-substring (progn
5614 (line-beginning-position))
5615 (progn (end-of-line)
5617 (point)))
5618 ;; Replace the newline and other whitespace with `...'.
5619 "..."
5620 (buffer-substring blinkpos (1+ blinkpos))))
5621 ;; There is nothing to show except the char itself.
5622 (t (buffer-substring blinkpos (1+ blinkpos))))))
5623 (message "Matches %s"
5624 (substring-no-properties open-paren-line-string)))))))))
5626 (defvar blink-paren-function 'blink-matching-open
5627 "Function called, if non-nil, whenever a close parenthesis is inserted.
5628 More precisely, a char with closeparen syntax is self-inserted.")
5630 (defun blink-paren-post-self-insert-function ()
5631 (when (and (eq (char-before) last-command-event) ; Sanity check.
5632 (memq (char-syntax last-command-event) '(?\) ?\$))
5633 blink-paren-function
5634 (not executing-kbd-macro)
5635 (not noninteractive)
5636 ;; Verify an even number of quoting characters precede the close.
5637 (= 1 (logand 1 (- (point)
5638 (save-excursion
5639 (forward-char -1)
5641 (point))))))
5642 (funcall blink-paren-function)))
5644 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5645 ;; Most likely, this hook is nil, so this arg doesn't matter,
5646 ;; but I use it as a reminder that this function usually
5647 ;; likes to be run after others since it does `sit-for'.
5648 'append)
5649 \f
5650 ;; This executes C-g typed while Emacs is waiting for a command.
5651 ;; Quitting out of a program does not go through here;
5652 ;; that happens in the QUIT macro at the C code level.
5653 (defun keyboard-quit ()
5654 "Signal a `quit' condition.
5655 During execution of Lisp code, this character causes a quit directly.
5656 At top-level, as an editor command, this simply beeps."
5657 (interactive)
5658 ;; Avoid adding the region to the window selection.
5659 (setq saved-region-selection nil)
5660 (let (select-active-regions)
5661 (deactivate-mark))
5662 (if (fboundp 'kmacro-keyboard-quit)
5663 (kmacro-keyboard-quit))
5664 (setq defining-kbd-macro nil)
5665 (let ((debug-on-quit nil))
5666 (signal 'quit nil)))
5668 (defvar buffer-quit-function nil
5671 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5673 (defun keyboard-escape-quit ()
5675 This command can exit an interactive command such as `query-replace',
5676 can clear out a prefix argument or a region,
5677 can get out of the minibuffer or other recursive edit,
5678 cancel the use of the current buffer (for special-purpose buffers),
5679 or go back to just one window (by deleting all but the selected window)."
5680 (interactive)
5681 (cond ((eq last-command 'mode-exited) nil)
5682 ((region-active-p)
5683 (deactivate-mark))
5684 ((> (minibuffer-depth) 0)
5685 (abort-recursive-edit))
5686 (current-prefix-arg
5687 nil)
5688 ((> (recursion-depth) 0)
5689 (exit-recursive-edit))
5690 (buffer-quit-function
5691 (funcall buffer-quit-function))
5692 ((not (one-window-p t))
5693 (delete-other-windows))
5695 (bury-buffer))))
5697 (defun play-sound-file (file &optional volume device)
5698 "Play sound stored in FILE.
5699 VOLUME and DEVICE correspond to the keywords of the sound
5700 specification for `play-sound'."
5701 (interactive "fPlay sound file: ")
5702 (let ((sound (list :file file)))
5703 (if volume
5704 (plist-put sound :volume volume))
5705 (if device
5706 (plist-put sound :device device))
5707 (push 'sound sound)
5708 (play-sound sound)))
5710 \f
5711 (defcustom read-mail-command 'rmail
5712 "Your preference for a mail reading package.
5713 This is used by some keybindings which support reading mail.
5714 See also `mail-user-agent' concerning sending mail."
5717 (function-item :tag "Emacs interface to MH"
5719 (function :tag "Other"))
5720 :version "21.1"
5721 :group 'mail)
5723 (defcustom mail-user-agent 'message-user-agent
5724 "Your preference for a mail composition package.
5725 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5726 outgoing email message. This variable lets you specify which
5727 mail-sending package you prefer.
5729 Valid values include:
5731 `message-user-agent' -- use the Message package.
5732 See Info node `(message)'.
5733 `sendmail-user-agent' -- use the Mail package.
5734 See Info node `(emacs)Sending Mail'.
5735 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5736 See Info node `(mh-e)'.
5737 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5738 paraphernalia, particularly the Gcc: header for
5739 archiving.
5741 Additional valid symbols may be available; check with the author of
5742 your package for details. The function should return non-nil if it
5743 succeeds.
5745 See also `read-mail-command' concerning reading mail."
5746 :type '(radio (function-item :tag "Message package"
5748 message-user-agent)
5749 (function-item :tag "Mail package"
5751 sendmail-user-agent)
5752 (function-item :tag "Emacs interface to MH"
5754 mh-e-user-agent)
5755 (function-item :tag "Message with full Gnus features"
5757 gnus-user-agent)
5758 (function :tag "Other"))
5759 :version "23.2" ; sendmail->message
5760 :group 'mail)
5762 (defcustom compose-mail-user-agent-warnings t
5763 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5764 If the value of `mail-user-agent' is the default, and the user
5765 appears to have customizations applying to the old default,
5766 `compose-mail' issues a warning."
5767 :type 'boolean
5768 :version "23.2"
5769 :group 'mail)
5771 (defun rfc822-goto-eoh ()
5772 "If the buffer starts with a mail header, move point to the header's end.
5773 Otherwise, moves to `point-min'.
5774 The end of the header is the start of the next line, if there is one,
5775 else the end of the last line. This function obeys RFC822."
5776 (goto-char (point-min))
5777 (when (re-search-forward
5779 (goto-char (match-beginning 0))))
5781 ;; Used by Rmail (e.g., rmail-forward).
5782 (defvar mail-encode-mml nil
5783 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
5784 the outgoing message before sending it.")
5786 (defun compose-mail (&optional to subject other-headers continue
5787 switch-function yank-action send-actions
5788 return-action)
5789 "Start composing a mail message to send.
5790 This uses the user's chosen mail composition package
5791 as selected with the variable `mail-user-agent'.
5792 The optional arguments TO and SUBJECT specify recipients
5793 and the initial Subject field, respectively.
5795 OTHER-HEADERS is an alist specifying additional
5796 header fields. Elements look like (HEADER . VALUE) where both
5797 HEADER and VALUE are strings.
5799 CONTINUE, if non-nil, says to continue editing a message already
5800 being composed. Interactively, CONTINUE is the prefix argument.
5802 SWITCH-FUNCTION, if non-nil, is a function to use to
5803 switch to and display the buffer used for mail composition.
5805 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5806 to insert the raw text of the message being replied to.
5807 It has the form (FUNCTION . ARGS). The user agent will apply
5808 FUNCTION to ARGS, to insert the raw text of the original message.
5809 \(The user agent will also run `mail-citation-hook', *after* the
5810 original text has been inserted in this way.)
5812 SEND-ACTIONS is a list of actions to call when the message is sent.
5813 Each action has the form (FUNCTION . ARGS).
5815 RETURN-ACTION, if non-nil, is an action for returning to the
5816 caller. It has the form (FUNCTION . ARGS). The function is
5817 called after the mail has been sent or put aside, and the mail
5818 buffer buried."
5819 (interactive
5820 (list nil nil nil current-prefix-arg))
5822 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5823 ;; from sendmail-user-agent to message-user-agent. Some users may
5824 ;; encounter incompatibilities. This hack tries to detect problems
5825 ;; and warn about them.
5826 (and compose-mail-user-agent-warnings
5827 (eq mail-user-agent 'message-user-agent)
5828 (let (warn-vars)
5829 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5830 mail-yank-hooks mail-archive-file-name
5831 mail-default-reply-to mail-mailing-lists
5832 mail-self-blind))
5833 (and (boundp var)
5834 (symbol-value var)
5835 (push var warn-vars)))
5836 (when warn-vars
5837 (display-warning 'mail
5838 (format "\
5839 The default mail mode is now Message mode.
5840 You have the following Mail mode variable%s customized:
5842 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5843 (if (> (length warn-vars) 1) "s" "")
5844 (mapconcat 'symbol-name
5845 warn-vars " "))))))
5847 (let ((function (get mail-user-agent 'composefunc)))
5848 (funcall function to subject other-headers continue switch-function
5849 yank-action send-actions return-action)))
5851 (defun compose-mail-other-window (&optional to subject other-headers continue
5852 yank-action send-actions
5853 return-action)
5855 (interactive (list nil nil nil current-prefix-arg))
5856 (compose-mail to subject other-headers continue
5857 'switch-to-buffer-other-window yank-action send-actions
5858 return-action))
5860 (defun compose-mail-other-frame (&optional to subject other-headers continue
5861 yank-action send-actions
5862 return-action)
5864 (interactive (list nil nil nil current-prefix-arg))
5865 (compose-mail to subject other-headers continue
5866 'switch-to-buffer-other-frame yank-action send-actions
5867 return-action))
5869 \f
5870 (defvar set-variable-value-history nil
5871 "History of values entered with `set-variable'.
5873 Maximum length of the history list is determined by the value
5874 of `history-length', which see.")
5876 (defun set-variable (variable value &optional make-local)
5877 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5878 VARIABLE should be a user option variable name, a Lisp variable
5879 meant to be customized by users. You should enter VALUE in Lisp syntax,
5880 so if you want VALUE to be a string, you must surround it with doublequotes.
5881 VALUE is used literally, not evaluated.
5883 If VARIABLE has a `variable-interactive' property, that is used as if
5884 it were the arg to `interactive' (which see) to interactively read VALUE.
5886 If VARIABLE has been defined with `defcustom', then the type information
5887 in the definition is used to check that VALUE is valid.
5889 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5890 (interactive
5891 (let* ((default-var (variable-at-point))
5892 (var (if (user-variable-p default-var)
5893 (read-variable (format "Set variable (default %s): " default-var)
5894 default-var)
5895 (read-variable "Set variable: ")))
5896 (minibuffer-help-form '(describe-variable var))
5897 (prop (get var 'variable-interactive))
5898 (obsolete (car (get var 'byte-obsolete-variable)))
5899 (prompt (format "Set %s %s to value: " var
5900 (cond ((local-variable-p var)
5901 "(buffer-local)")
5902 ((or current-prefix-arg
5903 (local-variable-if-set-p var))
5904 "buffer-locally")
5905 (t "globally"))))
5906 (val (progn
5907 (when obsolete
5908 (message (concat "`%S' is obsolete; "
5909 (if (symbolp obsolete) "use `%S' instead" "%s"))
5910 var obsolete)
5911 (sit-for 3))
5912 (if prop
5913 ;; Use VAR's `variable-interactive' property
5914 ;; as an interactive spec for prompting.
5915 (call-interactively `(lambda (arg)
5916 (interactive ,prop)
5917 arg))
5918 (read
5919 (read-string prompt nil
5920 'set-variable-value-history
5921 (format "%S" (symbol-value var))))))))
5922 (list var val current-prefix-arg)))
5924 (and (custom-variable-p variable)
5925 (not (get variable 'custom-type))
5926 (custom-load-symbol variable))
5927 (let ((type (get variable 'custom-type)))
5928 (when type
5929 ;; Match with custom type.
5930 (require 'cus-edit)
5931 (setq type (widget-convert type))
5932 (unless (widget-apply type :match value)
5933 (error "Value `%S' does not match type %S of %S"
5934 value (car type) variable))))
5936 (if make-local
5937 (make-local-variable variable))
5939 (set variable value)
5941 ;; Force a thorough redisplay for the case that the variable
5942 ;; has an effect on the display, like `tab-width' has.
5943 (force-mode-line-update))
5944 \f
5945 ;; Define the major mode for lists of completions.
5947 (defvar completion-list-mode-map
5948 (let ((map (make-sparse-keymap)))
5949 (define-key map [mouse-2] 'mouse-choose-completion)
5950 (define-key map [follow-link] 'mouse-face)
5951 (define-key map [down-mouse-2] nil)
5952 (define-key map "\C-m" 'choose-completion)
5953 (define-key map "\e\e\e" 'delete-completion-window)
5954 (define-key map [left] 'previous-completion)
5955 (define-key map [right] 'next-completion)
5956 (define-key map "q" 'quit-window)
5957 (define-key map "z" 'kill-this-buffer)
5958 map)
5959 "Local map for completion list buffers.")
5961 ;; Completion mode is suitable only for specially formatted data.
5962 (put 'completion-list-mode 'mode-class 'special)
5964 (defvar completion-reference-buffer nil
5965 "Record the buffer that was current when the completion list was requested.
5966 This is a local variable in the completion list buffer.
5967 Initial value is nil to avoid some compiler warnings.")
5969 (defvar completion-no-auto-exit nil
5970 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5971 This also applies to other functions such as `choose-completion'.")
5973 (defvar completion-base-position nil
5974 "Position of the base of the text corresponding to the shown completions.
5975 This variable is used in the *Completions* buffers.
5976 Its value is a list of the form (START END) where START is the place
5977 where the completion should be inserted and END (if non-nil) is the end
5978 of the text to replace. If END is nil, point is used instead.")
5980 (defvar completion-list-insert-choice-function #'completion--replace
5981 "Function to use to insert the text chosen in *Completions*.
5982 Called with 3 arguments (BEG END TEXT), it should replace the text
5983 between BEG and END with TEXT. Expected to be set buffer-locally
5984 in the *Completions* buffer.")
5986 (defvar completion-base-size nil
5987 "Number of chars before point not involved in completion.
5988 This is a local variable in the completion list buffer.
5989 It refers to the chars in the minibuffer if completing in the
5990 minibuffer, or in `completion-reference-buffer' otherwise.
5991 Only characters in the field at point are included.
5993 If nil, Emacs determines which part of the tail end of the
5994 buffer's text is involved in completion by comparing the text
5995 directly.")
5996 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
5998 (defun delete-completion-window ()
5999 "Delete the completion list window.
6000 Go to the window from which completion was requested."
6001 (interactive)
6002 (let ((buf completion-reference-buffer))
6003 (if (one-window-p t)
6004 (if (window-dedicated-p (selected-window))
6005 (delete-frame (selected-frame)))
6006 (delete-window (selected-window))
6007 (if (get-buffer-window buf)
6008 (select-window (get-buffer-window buf))))))
6010 (defun previous-completion (n)
6011 "Move to the previous item in the completion list."
6012 (interactive "p")
6013 (next-completion (- n)))
6015 (defun next-completion (n)
6016 "Move to the next item in the completion list.
6017 With prefix argument N, move N items (negative N means move backward)."
6018 (interactive "p")
6019 (let ((beg (point-min)) (end (point-max)))
6020 (while (and (> n 0) (not (eobp)))
6021 ;; If in a completion, move to the end of it.
6022 (when (get-text-property (point) 'mouse-face)
6023 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6024 ;; Move to start of next one.
6025 (unless (get-text-property (point) 'mouse-face)
6026 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6027 (setq n (1- n)))
6028 (while (and (< n 0) (not (bobp)))
6029 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6030 ;; If in a completion, move to the start of it.
6031 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6032 (goto-char (previous-single-property-change
6033 (point) 'mouse-face nil beg)))
6034 ;; Move to end of the previous completion.
6035 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6036 (goto-char (previous-single-property-change
6037 (point) 'mouse-face nil beg)))
6038 ;; Move to the start of that one.
6039 (goto-char (previous-single-property-change
6040 (point) 'mouse-face nil beg))
6041 (setq n (1+ n))))))
6043 (defun choose-completion (&optional event)
6044 "Choose the completion at point."
6045 (interactive (list last-nonmenu-event))
6046 ;; In case this is run via the mouse, give temporary modes such as
6047 ;; isearch a chance to turn off.
6048 (run-hooks 'mouse-leave-buffer-hook)
6049 (with-current-buffer (window-buffer (posn-window (event-start event)))
6050 (let ((buffer completion-reference-buffer)
6051 (base-size completion-base-size)
6052 (base-position completion-base-position)
6053 (insert-function completion-list-insert-choice-function)
6054 (choice
6055 (save-excursion
6056 (goto-char (posn-point (event-start event)))
6057 (let (beg end)
6058 (cond
6059 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6060 (setq end (point) beg (1+ (point))))
6061 ((and (not (bobp))
6062 (get-text-property (1- (point)) 'mouse-face))
6063 (setq end (1- (point)) beg (point)))
6064 (t (error "No completion here")))
6065 (setq beg (previous-single-property-change beg 'mouse-face))
6066 (setq end (or (next-single-property-change end 'mouse-face)
6067 (point-max)))
6068 (buffer-substring-no-properties beg end))))
6069 (owindow (selected-window)))
6071 (unless (buffer-live-p buffer)
6072 (error "Destination buffer is dead"))
6073 (select-window (posn-window (event-start event)))
6074 (if (and (one-window-p t 'selected-frame)
6075 (window-dedicated-p (selected-window)))
6076 ;; This is a special buffer's frame
6077 (iconify-frame (selected-frame))
6078 (or (window-dedicated-p (selected-window))
6079 (bury-buffer)))
6080 (select-window
6081 (or (get-buffer-window buffer 0)
6082 owindow))
6084 (with-current-buffer buffer
6085 (choose-completion-string
6086 choice buffer
6087 (or base-position
6088 (when base-size
6089 ;; Someone's using old completion code that doesn't know
6090 ;; about base-position yet.
6091 (list (+ base-size (field-beginning))))
6092 ;; If all else fails, just guess.
6093 (list (choose-completion-guess-base-position choice)))
6094 insert-function)))))
6096 ;; Delete the longest partial match for STRING
6097 ;; that can be found before POINT.
6098 (defun choose-completion-guess-base-position (string)
6099 (save-excursion
6100 (let ((opoint (point))
6101 len)
6102 ;; Try moving back by the length of the string.
6103 (goto-char (max (- (point) (length string))
6104 (minibuffer-prompt-end)))
6105 ;; See how far back we were actually able to move. That is the
6106 ;; upper bound on how much we can match and delete.
6107 (setq len (- opoint (point)))
6108 (if completion-ignore-case
6109 (setq string (downcase string)))
6110 (while (and (> len 0)
6111 (let ((tail (buffer-substring (point) opoint)))
6112 (if completion-ignore-case
6113 (setq tail (downcase tail)))
6114 (not (string= tail (substring string 0 len)))))
6115 (setq len (1- len))
6116 (forward-char 1))
6117 (point))))
6119 (defun choose-completion-delete-max-match (string)
6120 (delete-region (choose-completion-guess-base-position string) (point)))
6121 (make-obsolete 'choose-completion-delete-max-match
6122 'choose-completion-guess-base-position "23.2")
6124 (defvar choose-completion-string-functions nil
6125 "Functions that may override the normal insertion of a completion choice.
6126 These functions are called in order with four arguments:
6127 CHOICE - the string to insert in the buffer,
6128 BUFFER - the buffer in which the choice should be inserted,
6129 MINI-P - non-nil if BUFFER is a minibuffer, and
6130 BASE-SIZE - the number of characters in BUFFER before
6131 the string being completed.
6133 If a function in the list returns non-nil, that function is supposed
6134 to have inserted the CHOICE in the BUFFER, and possibly exited
6135 the minibuffer; no further functions will be called.
6137 If all functions in the list return nil, that means to use
6138 the default method of inserting the completion in BUFFER.")
6140 (defun choose-completion-string (choice &optional
6141 buffer base-position insert-function)
6142 "Switch to BUFFER and insert the completion choice CHOICE.
6143 BASE-POSITION, says where to insert the completion."
6145 ;; If BUFFER is the minibuffer, exit the minibuffer
6146 ;; unless it is reading a file name and CHOICE is a directory,
6147 ;; or completion-no-auto-exit is non-nil.
6149 ;; Some older code may call us passing `base-size' instead of
6150 ;; `base-position'. It's difficult to make any use of `base-size',
6151 ;; so we just ignore it.
6152 (unless (consp base-position)
6153 (message "Obsolete `base-size' passed to choose-completion-string")
6154 (setq base-position nil))
6156 (let* ((buffer (or buffer completion-reference-buffer))
6157 (mini-p (minibufferp buffer)))
6158 ;; If BUFFER is a minibuffer, barf unless it's the currently
6159 ;; active minibuffer.
6160 (if (and mini-p
6161 (not (and (active-minibuffer-window)
6162 (equal buffer
6163 (window-buffer (active-minibuffer-window))))))
6164 (error "Minibuffer is not active for completion")
6165 ;; Set buffer so buffer-local choose-completion-string-functions works.
6166 (set-buffer buffer)
6167 (unless (run-hook-with-args-until-success
6168 'choose-completion-string-functions
6169 ;; The fourth arg used to be `mini-p' but was useless
6170 ;; (since minibufferp can be used on the `buffer' arg)
6171 ;; and indeed unused. The last used to be `base-size', so we
6172 ;; keep it to try and avoid breaking old code.
6173 choice buffer base-position nil)
6174 ;; This remove-text-properties should be unnecessary since `choice'
6175 ;; comes from buffer-substring-no-properties.
6176 ;;(remove-text-properties 0 (lenth choice) '(mouse-face nil) choice)
6177 ;; Insert the completion into the buffer where it was requested.
6178 (funcall (or insert-function completion-list-insert-choice-function)
6179 (or (car base-position) (point))
6180 (or (cadr base-position) (point))
6181 choice)
6182 ;; Update point in the window that BUFFER is showing in.
6183 (let ((window (get-buffer-window buffer t)))
6184 (set-window-point window (point)))
6185 ;; If completing for the minibuffer, exit it with this choice.
6186 (and (not completion-no-auto-exit)
6187 (minibufferp buffer)
6188 minibuffer-completion-table
6189 ;; If this is reading a file name, and the file name chosen
6190 ;; is a directory, don't exit the minibuffer.
6191 (let* ((result (buffer-substring (field-beginning) (point)))
6192 (bounds
6193 (completion-boundaries result minibuffer-completion-table
6194 minibuffer-completion-predicate
6195 "")))
6196 (if (eq (car bounds) (length result))
6197 ;; The completion chosen leads to a new set of completions
6198 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6199 (let ((mini (active-minibuffer-window)))
6200 (select-window mini)
6201 (when minibuffer-auto-raise
6202 (raise-frame (window-frame mini))))
6203 (exit-minibuffer))))))))
6205 (define-derived-mode completion-list-mode nil "Completion List"
6206 "Major mode for buffers showing lists of possible completions.
6208 to select the completion near point.
6210 with the mouse.
6213 (set (make-local-variable 'completion-base-size) nil))
6215 (defun completion-list-mode-finish ()
6216 "Finish setup of the completions buffer.
6217 Called from `temp-buffer-show-hook'."
6218 (when (eq major-mode 'completion-list-mode)
6219 (toggle-read-only 1)))
6221 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6224 ;; Variables and faces used in `completion-setup-function'.
6226 (defcustom completion-show-help t
6227 "Non-nil means show help message in *Completions* buffer."
6228 :type 'boolean
6229 :version "22.1"
6230 :group 'completion)
6232 ;; This function goes in completion-setup-hook, so that it is called
6233 ;; after the text of the completion list buffer is written.
6234 (defun completion-setup-function ()
6235 (let* ((mainbuf (current-buffer))
6236 (base-dir
6237 ;; When reading a file name in the minibuffer,
6238 ;; try and find the right default-directory to set in the
6239 ;; completion list buffer.
6240 ;; FIXME: Why do we do that, actually? --Stef
6241 (if minibuffer-completing-file-name
6242 (file-name-as-directory
6243 (expand-file-name
6244 (substring (minibuffer-completion-contents)
6245 0 (or completion-base-size 0)))))))
6246 (with-current-buffer standard-output
6247 (let ((base-size completion-base-size) ;Read before killing localvars.
6248 (base-position completion-base-position)
6249 (insert-fun completion-list-insert-choice-function))
6250 (completion-list-mode)
6251 (set (make-local-variable 'completion-base-size) base-size)
6252 (set (make-local-variable 'completion-base-position) base-position)
6253 (set (make-local-variable 'completion-list-insert-choice-function)
6254 insert-fun))
6255 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6256 (if base-dir (setq default-directory base-dir))
6257 ;; Maybe insert help string.
6258 (when completion-show-help
6259 (goto-char (point-min))
6260 (if (display-mouse-p)
6261 (insert (substitute-command-keys
6263 (insert (substitute-command-keys
6267 (add-hook 'completion-setup-hook 'completion-setup-function)
6269 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6270 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6272 (defun switch-to-completions ()
6273 "Select the completion list window."
6274 (interactive)
6275 (let ((window (or (get-buffer-window "*Completions*" 0)
6276 ;; Make sure we have a completions window.
6277 (progn (minibuffer-completion-help)
6278 (get-buffer-window "*Completions*" 0)))))
6279 (when window
6280 (select-window window)
6281 ;; In the new buffer, go to the first completion.
6282 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6283 (when (bobp)
6284 (next-completion 1)))))
6285 \f
6286 ;;; Support keyboard commands to turn on various modifiers.
6288 ;; These functions -- which are not commands -- each add one modifier
6289 ;; to the following event.
6291 (defun event-apply-alt-modifier (_ignore-prompt)
6294 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6295 (defun event-apply-super-modifier (_ignore-prompt)
6298 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6299 (defun event-apply-hyper-modifier (_ignore-prompt)
6302 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6303 (defun event-apply-shift-modifier (_ignore-prompt)
6306 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6307 (defun event-apply-control-modifier (_ignore-prompt)
6310 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6311 (defun event-apply-meta-modifier (_ignore-prompt)
6314 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6316 (defun event-apply-modifier (event symbol lshiftby prefix)
6317 "Apply a modifier flag to event EVENT.
6318 SYMBOL is the name of this modifier, as a symbol.
6319 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6320 PREFIX is the string that represents this modifier in an event type symbol."
6321 (if (numberp event)
6322 (cond ((eq symbol 'control)
6323 (if (and (<= (downcase event) ?z)
6324 (>= (downcase event) ?a))
6325 (- (downcase event) ?a -1)
6326 (if (and (<= (downcase event) ?Z)
6327 (>= (downcase event) ?A))
6328 (- (downcase event) ?A -1)
6329 (logior (lsh 1 lshiftby) event))))
6330 ((eq symbol 'shift)
6331 (if (and (<= (downcase event) ?z)
6332 (>= (downcase event) ?a))
6333 (upcase event)
6334 (logior (lsh 1 lshiftby) event)))
6335 (t
6336 (logior (lsh 1 lshiftby) event)))
6337 (if (memq symbol (event-modifiers event))
6338 event
6339 (let ((event-type (if (symbolp event) event (car event))))
6340 (setq event-type (intern (concat prefix (symbol-name event-type))))
6341 (if (symbolp event)
6342 event-type
6343 (cons event-type (cdr event)))))))
6345 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6346 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6347 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6348 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6349 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6350 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6351 \f
6352 ;;;; Keypad support.
6354 ;; Make the keypad keys act like ordinary typing keys. If people add
6355 ;; bindings for the function key symbols, then those bindings will
6356 ;; override these, so this shouldn't interfere with any existing
6357 ;; bindings.
6359 ;; Also tell read-char how to handle these keys.
6360 (mapc
6361 (lambda (keypad-normal)
6362 (let ((keypad (nth 0 keypad-normal))
6363 (normal (nth 1 keypad-normal)))
6364 (put keypad 'ascii-character normal)
6365 (define-key function-key-map (vector keypad) (vector normal))))
6366 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6367 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6368 (kp-space ?\s)
6371 (kp-multiply ?*)
6372 (kp-add ?+)
6373 (kp-separator ?,)
6374 (kp-subtract ?-)
6375 (kp-decimal ?.)
6376 (kp-divide ?/)
6377 (kp-equal ?=)
6378 ;; Do the same for various keys that are represented as symbols under
6379 ;; GUIs but naturally correspond to characters.
6380 (backspace 127)
6381 (delete 127)
6384 (clear ?\C-l)
6385 (return ?\C-m)
6386 (escape ?\e)
6387 ))
6388 \f
6389 ;;;;
6390 ;;;; forking a twin copy of a buffer.
6391 ;;;;
6393 (defvar clone-buffer-hook nil
6394 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6396 (defvar clone-indirect-buffer-hook nil
6397 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6399 (defun clone-process (process &optional newname)
6400 "Create a twin copy of PROCESS.
6401 If NEWNAME is nil, it defaults to PROCESS' name;
6402 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6403 If PROCESS is associated with a buffer, the new process will be associated
6404 with the current buffer instead.
6405 Returns nil if PROCESS has already terminated."
6406 (setq newname (or newname (process-name process)))
6408 (setq newname (substring newname 0 (match-beginning 0))))
6409 (when (memq (process-status process) '(run stop open))
6410 (let* ((process-connection-type (process-tty-name process))
6411 (new-process
6412 (if (memq (process-status process) '(open))
6413 (let ((args (process-contact process t)))
6414 (setq args (plist-put args :name newname))
6415 (setq args (plist-put args :buffer
6416 (if (process-buffer process)
6417 (current-buffer))))
6418 (apply 'make-network-process args))
6419 (apply 'start-process newname
6420 (if (process-buffer process) (current-buffer))
6421 (process-command process)))))
6422 (set-process-query-on-exit-flag
6423 new-process (process-query-on-exit-flag process))
6424 (set-process-inherit-coding-system-flag
6425 new-process (process-inherit-coding-system-flag process))
6426 (set-process-filter new-process (process-filter process))
6427 (set-process-sentinel new-process (process-sentinel process))
6428 (set-process-plist new-process (copy-sequence (process-plist process)))
6429 new-process)))
6431 ;; things to maybe add (currently partly covered by `funcall mode'):
6432 ;; - syntax-table
6433 ;; - overlays
6434 (defun clone-buffer (&optional newname display-flag)
6435 "Create and return a twin copy of the current buffer.
6436 Unlike an indirect buffer, the new buffer can be edited
6437 independently of the old one (if it is not read-only).
6438 NEWNAME is the name of the new buffer. It may be modified by
6439 adding or incrementing <N> at the end as necessary to create a
6440 unique buffer name. If nil, it defaults to the name of the
6441 current buffer, with the proper suffix. If DISPLAY-FLAG is
6442 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6443 clone a file-visiting buffer, or a buffer whose major mode symbol
6444 has a non-nil `no-clone' property, results in an error.
6446 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6447 current buffer with appropriate suffix. However, if a prefix
6448 argument is given, then the command prompts for NEWNAME in the
6449 minibuffer.
6451 This runs the normal hook `clone-buffer-hook' in the new buffer
6452 after it has been set up properly in other respects."
6453 (interactive
6454 (progn
6455 (if buffer-file-name
6456 (error "Cannot clone a file-visiting buffer"))
6457 (if (get major-mode 'no-clone)
6458 (error "Cannot clone a buffer in %s mode" mode-name))
6459 (list (if current-prefix-arg
6460 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6461 t)))
6462 (if buffer-file-name
6463 (error "Cannot clone a file-visiting buffer"))
6464 (if (get major-mode 'no-clone)
6465 (error "Cannot clone a buffer in %s mode" mode-name))
6466 (setq newname (or newname (buffer-name)))
6468 (setq newname (substring newname 0 (match-beginning 0))))
6469 (let ((buf (current-buffer))
6470 (ptmin (point-min))
6471 (ptmax (point-max))
6472 (pt (point))
6473 (mk (if mark-active (mark t)))
6474 (modified (buffer-modified-p))
6475 (mode major-mode)
6476 (lvars (buffer-local-variables))
6477 (process (get-buffer-process (current-buffer)))
6478 (new (generate-new-buffer (or newname (buffer-name)))))
6479 (save-restriction
6480 (widen)
6481 (with-current-buffer new
6482 (insert-buffer-substring buf)))
6483 (with-current-buffer new
6484 (narrow-to-region ptmin ptmax)
6485 (goto-char pt)
6486 (if mk (set-mark mk))
6487 (set-buffer-modified-p modified)
6489 ;; Clone the old buffer's process, if any.
6490 (when process (clone-process process))
6492 ;; Now set up the major mode.
6493 (funcall mode)
6495 ;; Set up other local variables.
6496 (mapc (lambda (v)
6497 (condition-case () ;in case var is read-only
6498 (if (symbolp v)
6499 (makunbound v)
6500 (set (make-local-variable (car v)) (cdr v)))
6501 (error nil)))
6502 lvars)
6504 ;; Run any hooks (typically set up by the major mode
6505 ;; for cloning to work properly).
6506 (run-hooks 'clone-buffer-hook))
6507 (if display-flag
6508 ;; Presumably the current buffer is shown in the selected frame, so
6509 ;; we want to display the clone elsewhere.
6510 (let ((same-window-regexps nil)
6511 (same-window-buffer-names))
6512 (pop-to-buffer new)))
6513 new))
6516 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6517 "Create an indirect buffer that is a twin copy of the current buffer.
6519 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6520 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6521 or if not called with a prefix arg, NEWNAME defaults to the current
6522 buffer's name. The name is modified by adding a `<N>' suffix to it
6523 or by incrementing the N in an existing suffix. Trying to clone a
6524 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6525 property results in an error.
6527 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6528 This is always done when called interactively.
6530 Optional third arg NORECORD non-nil means do not put this buffer at the
6531 front of the list of recently selected ones."
6532 (interactive
6533 (progn
6534 (if (get major-mode 'no-clone-indirect)
6535 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6536 (list (if current-prefix-arg
6537 (read-buffer "Name of indirect buffer: " (current-buffer)))
6538 t)))
6539 (if (get major-mode 'no-clone-indirect)
6540 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6541 (setq newname (or newname (buffer-name)))
6543 (setq newname (substring newname 0 (match-beginning 0))))
6544 (let* ((name (generate-new-buffer-name newname))
6545 (buffer (make-indirect-buffer (current-buffer) name t)))
6546 (with-current-buffer buffer
6547 (run-hooks 'clone-indirect-buffer-hook))
6548 (when display-flag
6549 (pop-to-buffer buffer norecord))
6550 buffer))
6553 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6554 "Like `clone-indirect-buffer' but display in another window."
6555 (interactive
6556 (progn
6557 (if (get major-mode 'no-clone-indirect)
6558 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6559 (list (if current-prefix-arg
6560 (read-buffer "Name of indirect buffer: " (current-buffer)))
6561 t)))
6562 (let ((pop-up-windows t))
6563 (clone-indirect-buffer newname display-flag norecord)))
6565 \f
6566 ;;; Handling of Backspace and Delete keys.
6568 (defcustom normal-erase-is-backspace 'maybe
6569 "Set the default behavior of the Delete and Backspace keys.
6571 If set to t, Delete key deletes forward and Backspace key deletes
6572 backward.
6574 If set to nil, both Delete and Backspace keys delete backward.
6576 If set to 'maybe (which is the default), Emacs automatically
6577 selects a behavior. On window systems, the behavior depends on
6578 the keyboard used. If the keyboard has both a Backspace key and
6579 a Delete key, and both are mapped to their usual meanings, the
6580 option's default value is set to t, so that Backspace can be used
6581 to delete backward, and Delete can be used to delete forward.
6583 If not running under a window system, customizing this option
6584 accomplishes a similar effect by mapping C-h, which is usually
6585 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6586 via `keyboard-translate'. The former functionality of C-h is
6587 available on the F1 key. You should probably not use this
6588 setting if you don't have both Backspace, Delete and F1 keys.
6590 Setting this variable with setq doesn't take effect. Programmatically,
6591 call `normal-erase-is-backspace-mode' (which see) instead."
6592 :type '(choice (const :tag "Off" nil)
6593 (const :tag "Maybe" maybe)
6594 (other :tag "On" t))
6595 :group 'editing-basics
6596 :version "21.1"
6597 :set (lambda (symbol value)
6598 ;; The fboundp is because of a problem with :set when
6599 ;; dumping Emacs. It doesn't really matter.
6600 (if (fboundp 'normal-erase-is-backspace-mode)
6601 (normal-erase-is-backspace-mode (or value 0))
6602 (set-default symbol value))))
6604 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6605 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6606 (unless frame (setq frame (selected-frame)))
6607 (with-selected-frame frame
6608 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6609 (normal-erase-is-backspace-mode
6610 (if (if (eq normal-erase-is-backspace 'maybe)
6611 (and (not noninteractive)
6612 (or (memq system-type '(ms-dos windows-nt))
6613 (memq window-system '(ns))
6614 (and (memq window-system '(x))
6615 (fboundp 'x-backspace-delete-keys-p)
6616 (x-backspace-delete-keys-p))
6617 ;; If the terminal Emacs is running on has erase char
6618 ;; set to ^H, use the Backspace key for deleting
6619 ;; backward, and the Delete key for deleting forward.
6620 (and (null window-system)
6621 (eq tty-erase-char ?\^H))))
6622 normal-erase-is-backspace)
6623 1 0)))))
6625 (define-minor-mode normal-erase-is-backspace-mode
6626 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6628 With numeric ARG, turn the mode on if and only if ARG is positive.
6630 On window systems, when this mode is on, Delete is mapped to C-d
6631 and Backspace is mapped to DEL; when this mode is off, both
6632 Delete and Backspace are mapped to DEL. (The remapping goes via
6633 `local-function-key-map', so binding Delete or Backspace in the
6634 global or local keymap will override that.)
6636 In addition, on window systems, the bindings of C-Delete, M-Delete,
6637 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6638 the global keymap in accordance with the functionality of Delete and
6639 Backspace. For example, if Delete is remapped to C-d, which deletes
6640 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6641 to DEL, which deletes backward, C-Delete is bound to
6642 `backward-kill-word'.
6644 If not running on a window system, a similar effect is accomplished by
6645 remapping C-h (normally produced by the Backspace key) and DEL via
6646 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6647 to C-d; if it's off, the keys are not remapped.
6649 When not running on a window system, and this mode is turned on, the
6650 former functionality of C-h is available on the F1 key. You should
6651 probably not turn on this mode on a text-only terminal if you don't
6652 have both Backspace, Delete and F1 keys.
6654 See also `normal-erase-is-backspace'."
6655 :variable (eq (terminal-parameter
6656 nil 'normal-erase-is-backspace) 1)
6657 (let ((enabled (eq 1 (terminal-parameter
6658 nil 'normal-erase-is-backspace))))
6660 (cond ((or (memq window-system '(x w32 ns pc))
6661 (memq system-type '(ms-dos windows-nt)))
6662 (let ((bindings
6663 `(([M-delete] [M-backspace])
6664 ([C-M-delete] [C-M-backspace])
6665 ([?\e C-delete] [?\e C-backspace]))))
6667 (if enabled
6668 (progn
6669 (define-key local-function-key-map [delete] [deletechar])
6670 (define-key local-function-key-map [kp-delete] [?\C-d])
6671 (define-key local-function-key-map [backspace] [?\C-?])
6672 (dolist (b bindings)
6673 ;; Not sure if input-decode-map is really right, but
6674 ;; keyboard-translate-table (used below) only works
6675 ;; for integer events, and key-translation-table is
6676 ;; global (like the global-map, used earlier).
6677 (define-key input-decode-map (car b) nil)
6678 (define-key input-decode-map (cadr b) nil)))
6679 (define-key local-function-key-map [delete] [?\C-?])
6680 (define-key local-function-key-map [kp-delete] [?\C-?])
6681 (define-key local-function-key-map [backspace] [?\C-?])
6682 (dolist (b bindings)
6683 (define-key input-decode-map (car b) (cadr b))
6684 (define-key input-decode-map (cadr b) (car b))))))
6685 (t
6686 (if enabled
6687 (progn
6688 (keyboard-translate ?\C-h ?\C-?)
6689 (keyboard-translate ?\C-? ?\C-d))
6690 (keyboard-translate ?\C-h ?\C-h)
6691 (keyboard-translate ?\C-? ?\C-?))))
6693 (if (called-interactively-p 'interactive)
6694 (message "Delete key deletes %s"
6695 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6696 "forward" "backward")))))
6697 \f
6698 (defvar vis-mode-saved-buffer-invisibility-spec nil
6699 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6701 (define-minor-mode visible-mode
6702 "Toggle Visible mode.
6703 With argument ARG turn Visible mode on if ARG is positive, otherwise
6704 turn it off.
6706 Enabling Visible mode makes all invisible text temporarily visible.
6707 Disabling Visible mode turns off that effect. Visible mode works by
6708 saving the value of `buffer-invisibility-spec' and setting it to nil."
6709 :lighter " Vis"
6710 :group 'editing-basics
6711 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6712 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6713 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6714 (when visible-mode
6715 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6716 buffer-invisibility-spec)
6717 (setq buffer-invisibility-spec nil)))
6718 \f
6719 ;; Minibuffer prompt stuff.
6721 ;;(defun minibuffer-prompt-modification (start end)
6722 ;; (error "You cannot modify the prompt"))
6723 ;;
6724 ;;
6725 ;;(defun minibuffer-prompt-insertion (start end)
6726 ;; (let ((inhibit-modification-hooks t))
6727 ;; (delete-region start end)
6728 ;; ;; Discard undo information for the text insertion itself
6729 ;; ;; and for the text deletion.above.
6730 ;; (when (consp buffer-undo-list)
6731 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6732 ;; (message "You cannot modify the prompt")))
6733 ;;
6734 ;;
6735 ;;(setq minibuffer-prompt-properties
6736 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6737 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6739 \f
6740 ;;;; Problematic external packages.
6742 ;; rms says this should be done by specifying symbols that define
6743 ;; versions together with bad values. This is therefore not as
6744 ;; flexible as it could be. See the thread:
6745 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6746 (defconst bad-packages-alist
6747 ;; Not sure exactly which semantic versions have problems.
6748 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6750 "The version of `semantic' loaded does not work in Emacs 22.
6751 It can cause constant high CPU load.
6752 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6753 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6754 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6755 ;; provided the `CUA-mode' feature. Since this is no longer true,
6756 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6757 (CUA-mode t nil
6758 "CUA-mode is now part of the standard GNU Emacs distribution,
6759 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6761 You have loaded an older version of CUA-mode which does not work
6762 correctly with this version of Emacs. You should remove the old
6763 version and use the one distributed with Emacs."))
6764 "Alist of packages known to cause problems in this version of Emacs.
6765 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6766 PACKAGE is either a regular expression to match file names, or a
6767 symbol (a feature name); see the documentation of
6768 `after-load-alist', to which this variable adds functions.
6769 SYMBOL is either the name of a string variable, or `t'. Upon
6770 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6771 warning using STRING as the message.")
6773 (defun bad-package-check (package)
6774 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6775 (condition-case nil
6776 (let* ((list (assoc package bad-packages-alist))
6777 (symbol (nth 1 list)))
6778 (and list
6779 (boundp symbol)
6780 (or (eq symbol t)
6781 (and (stringp (setq symbol (eval symbol)))
6782 (string-match-p (nth 2 list) symbol)))
6783 (display-warning package (nth 3 list) :warning)))
6784 (error nil)))
6786 (mapc (lambda (elem)
6787 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6788 bad-packages-alist)
6791 (provide 'simple)
6793 ;;; simple.el ends here