| blob | fe46e36fdac818ae59ca6c57001c93e8ea840e5b |
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."
85 "Highlighting of locations in `next-error-no-select'.
86 If number, highlight the locus in `next-error' face for given time in seconds.
87 If t, highlight the locus indefinitely until some other locus replaces it.
88 If nil, don't highlight the locus in the source buffer.
89 If `fringe-arrow', indicate the locus by the fringe arrow."
98 "Display the line in the visited source file recentered as specified.
99 If non-nil, the value is passed directly to `recenter'."
107 "List of hook functions run by `next-error' after visiting source file."
118 "The most recent `next-error' buffer.
119 A buffer becomes most recent when its compilation, grep, or
124 "Function to use to find the next error in the current buffer.
125 The function is called with 2 parameters:
126 ARG is an integer specifying by how many errors to move.
127 RESET is a boolean which, if non-nil, says to go back to the beginning
128 of the errors before moving.
129 Major modes providing compile-like functionality should set this variable
130 to indicate to `next-error' that this is a candidate buffer and how
135 "Function to use to move to an error locus.
136 It takes two arguments, a buffer position in the error buffer
137 and a buffer position in the error locus buffer.
138 The buffer for the error locus should already be current.
143 &optional avoid-current
144 extra-test-inclusive
145 extra-test-exclusive)
146 "Test if BUFFER is a `next-error' capable buffer.
148 If AVOID-CURRENT is non-nil, treat the current buffer
149 as an absolute last resort only.
151 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
152 that normally would not qualify. If it returns t, the buffer
153 in question is treated as usable.
155 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
156 that would normally be considered usable. If it returns nil,
157 that buffer is rejected."
162 ;; Optionally reject some buffers.
165 t)
166 ;; Optionally accept some other buffers.
171 extra-test-inclusive
172 extra-test-exclusive)
173 "Return a `next-error' capable buffer.
175 If AVOID-CURRENT is non-nil, treat the current buffer
176 as an absolute last resort only.
178 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
179 that normally would not qualify. If it returns t, the buffer
180 in question is treated as usable.
182 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
183 that would normally be considered usable. If it returns nil,
184 that buffer is rejected."
186 ;; 1. If one window on the selected frame displays such buffer, return it.
192 avoid-current
193 extra-test-inclusive extra-test-exclusive)
198 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
201 extra-test-inclusive extra-test-exclusive))
202 next-error-last-buffer)
203 ;; 3. If the current buffer is acceptable, choose it.
205 extra-test-inclusive extra-test-exclusive)
207 ;; 4. Look for any acceptable buffer.
212 extra-test-inclusive extra-test-exclusive)))
215 ;; 5. Use the current buffer as a last resort if it qualifies,
216 ;; even despite AVOID-CURRENT.
219 extra-test-inclusive extra-test-exclusive)
223 ;; 6. Give up.
227 "Visit next `next-error' message and corresponding source code.
229 If all the error messages parsed so far have been processed already,
230 the message buffer is checked for new ones.
232 A prefix ARG specifies how many error messages to move;
233 negative means move back to previous error messages.
235 and start at the first error.
237 The RESET argument specifies that we should restart from the beginning.
240 compilation, grep, or occur buffer. It can also operate on any
242 more generally, on any buffer in Compilation mode or with
243 Compilation Minor mode enabled, or any buffer in which
244 `next-error-function' is bound to an appropriate function.
245 To specify use of a particular buffer for error messages, type
247 in the current frame.
250 runs `next-error-hook' with `run-hooks', and stays with that buffer
251 until you use it in some other buffer which uses Compilation mode
252 or Compilation Minor mode.
254 To control which errors are matched, customize the variable
255 `compilation-error-regexp-alist'."
259 ;; we know here that next-error-function is a valid symbol we can funcall
267 "Visit the source code corresponding to the `next-error' message at point."
269 ;; we know here that next-error-function is a valid symbol we can funcall
280 "Visit previous `next-error' message and corresponding source code.
282 Prefix arg N says how many error messages to move backwards (or
283 forwards, if negative).
290 "Restart at the first error.
291 Visit corresponding source code.
292 With prefix arg N, visit the source code of the Nth error.
298 "Move point to the next error in the `next-error' buffer and highlight match.
299 Prefix arg N says how many error messages to move forwards (or
300 backwards, if negative).
302 select the source buffer."
309 "Move point to the previous error in the `next-error' buffer and highlight match.
310 Prefix arg N says how many error messages to move backwards (or
311 forwards, if negative).
313 select the source buffer."
317 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
321 "Minor mode for compilation, occur and diff modes.
322 When turned on, cursor motion in the compilation, grep, occur or diff
323 buffer causes automatic display of the corresponding source code
324 location."
331 ;; Used as a `post-command-hook' by `next-error-follow-mode'
332 ;; for the *Compilation* *grep* and *Occur* buffers.
342 \f
343 ;;;
346 "Major mode not specialized for anything in particular.
347 Other major modes are defined by comparison with this one."
352 ;; Special major modes to view specially formatted data rather than files.
366 map))
370 "Parent major mode from which special major modes should inherit."
373 ;; Major mode meant to be the parent of programming modes.
378 map)
382 "Indent the expression after point."
389 "Major mode for editing programming language source code."
392 ;; Any programming language is always written left to right.
395 ;; Making and deleting lines.
401 "Insert a newline, and move to left margin of the new line if it's blank.
402 If `use-hard-newlines' is non-nil, the newline is marked with the
403 text-property `hard'.
404 With ARG, insert that many newlines.
405 Call `auto-fill-function' if the current column number is greater
406 than the value of `fill-column' and ARG is nil."
409 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
410 ;; Set last-command-event to tell self-insert what to insert.
414 ;; Don't auto-fill if we have a numeric argument.
417 ;; Do the rest in post-self-insert-hook, because we want to do it
418 ;; *before* other functions on that hook.
420 ;; Mark the newline(s) `hard'.
424 ;; If the newline leaves the previous line blank, and we
425 ;; have a left margin, delete that from the blank line.
433 ;; Indent the line after the newline, except in one case:
434 ;; when we added the newline at the beginning of a line which
435 ;; starts a page.
442 ;; We first used let-binding to protect the hook, but that was naive
443 ;; since add-hook affects the symbol-default value of the variable,
444 ;; whereas the let-binding might only protect the buffer-local value.
446 nil)
451 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
457 "Insert a newline and leave point before it.
458 If there is a fill prefix and/or a `left-margin', insert them
459 on the new line if the line would have been blank.
460 With arg N, insert N newlines."
465 ;; Don't expand an abbrev before point.
479 "Split current line, moving portion beyond point vertically down.
480 If the current line starts with `fill-prefix', insert it on the new
481 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
483 When called from Lisp code, ARG may be a prefix string to copy."
488 ;; What prefix should we check for (nil means don't).
492 ;; Does this line start with it?
503 "Join this line to previous and fix up whitespace at join.
504 If there is a fill prefix, delete it from the beginning of this line.
505 With argument, join this line to following line."
512 ;; If the second line started with the fill prefix,
513 ;; delete the prefix.
525 "On blank line, delete all surrounding blank lines, leaving just one.
526 On isolated blank line, delete that one.
527 On nonblank line, delete any immediately following blank lines."
533 ;; Set singleblank if there is just one blank line here.
540 ;; Delete preceding blank lines, and this one too if it's the only one.
549 ;; Delete following blank lines, unless the current line is blank
550 ;; and there are no following blank lines.
559 ;; Handle the special case where point is followed by newline and eob.
560 ;; Delete the line, leaving point at eob.
565 "Delete all the trailing whitespace across the current buffer.
566 All whitespace after the last non-whitespace character in a line is deleted.
568 A formfeed is not considered whitespace by this function.
569 If the region is active, only delete whitespace within the region."
582 ;; Don't delete formfeeds, even if they are considered whitespace.
588 ;; Return nil for the benefit of `write-file-functions'.
589 nil)
592 "Insert a newline, then indent according to major mode.
593 Indentation is done using the value of `indent-line-function'.
594 In programming language modes, this is the same as TAB.
595 In some text modes, where TAB inserts a tab, this command indents to the
596 column specified by the function `current-left-margin'."
603 "Reindent current line, insert newline, then indent the new line.
604 Indentation of both lines is done according to the current major mode,
605 which means calling the current value of `indent-line-function'.
606 In programming language modes, this is the same as TAB.
607 In some text modes, where TAB inserts a tab, this indents to the
608 column specified by the function `current-left-margin'."
611 ;; Be careful to insert the newline before indenting the line.
612 ;; Otherwise, the indentation might be wrong.
616 ;; We are at EOL before the call to indent-according-to-mode, and
617 ;; after it we usually are as well, but not always. We tried to
618 ;; address it with `save-excursion' but that uses a normal marker
619 ;; whereas we need `move after insertion', so we do the save/restore
620 ;; by hand.
624 ;; Remove the trailing white-space after indentation because
625 ;; indentation may introduce the whitespace.
630 "Read next input character and insert it.
631 This is useful for inserting control characters.
632 With argument, insert ARG copies of the character.
634 If the first character you type after this command is an octal digit,
635 you should type a sequence of octal digits which specify a character code.
636 Any nondigit terminates the sequence. If the terminator is a RET,
637 it is discarded; any other terminator is used itself as input.
638 The variable `read-quoted-char-radix' specifies the radix for this feature;
639 set it to 10 or 16 to use decimal or hex instead of octal.
641 In overwrite mode, this function inserts the character anyway, and
642 does not handle octal digits specially. This means that if you use
643 overwrite as your normal editing mode, you can use this function to
644 insert characters when necessary.
646 In binary overwrite mode, this function does overwrite, and octal
647 digits are interpreted as a character code. This is intended to be
648 useful for editing binary files."
651 ;; Avoid "obsolete" warnings for translation-table-for-input.
658 ;; This used to assume character codes 0240 - 0377 stand for
659 ;; characters in some single-byte character set, and converted them
660 ;; to Emacs characters. But in 23.1 this feature is deprecated
661 ;; in favor of inserting the corresponding Unicode characters.
662 ;; (if (and enable-multibyte-characters
663 ;; (>= char ?\240)
664 ;; (<= char ?\377))
665 ;; (setq char (unibyte-char-to-multibyte char)))
674 "Move forward ARG lines and position at first nonblank character."
680 "Move backward ARG lines and position at first nonblank character."
686 "Move point to the first non-whitespace character on this line."
690 ;; Move back over chars that have whitespace syntax but have the p flag.
694 "Fixup white space between objects around point.
695 Leave one space or none, according to the context."
702 nil
706 "Delete all spaces and tabs around point.
707 If BACKWARD-ONLY is non-nil, only delete them before point."
712 orig-pos
721 "Delete all spaces and tabs around point, leaving one space (or N spaces).
722 If N is negative, delete newlines as well."
739 \f
741 "Move point to the beginning of the buffer.
742 With numeric arg N, put point N/10 of the way from the beginning.
743 If the buffer is narrowed, this command uses the beginning of the
744 accessible part of the buffer.
746 If Transient Mark mode is disabled, leave mark at previous
749 Don't use this command in Lisp programs!
750 \(goto-char (point-min)) is faster."
759 ;; Avoid overflow for large buffer sizes!
767 "Move point to the end of the buffer.
768 With numeric arg N, put point N/10 of the way from the end.
769 If the buffer is narrowed, this command uses the end of the
770 accessible part of the buffer.
772 If Transient Mark mode is disabled, leave mark at previous
775 Don't use this command in Lisp programs!
776 \(goto-char (point-max)) is faster."
783 ;; Avoid overflow for large buffer sizes!
788 ;; If we went to a place in the middle of the buffer,
789 ;; adjust it to the beginning of a line.
792 ;; If the end of the buffer is not already on the screen,
793 ;; then scroll specially to put it near, but not at, the bottom.
798 "Whether single-char deletion commands delete an active region.
799 This has an effect only if Transient Mark mode is enabled, and
800 affects `delete-forward-char' and `delete-backward-char', though
801 not `delete-char'.
803 If the value is the symbol `kill', the active region is killed
804 instead of deleted."
812 "Delete the previous N characters (following if N is negative).
813 If Transient Mark mode is enabled, the mark is active, and N is 1,
814 delete the text in the region and deactivate the mark instead.
815 To disable this, set `delete-active-region' to nil.
817 Optional second arg KILLFLAG, if non-nil, means to kill (save in
818 kill ring) instead of delete. Interactively, N is the prefix
819 arg, and KILLFLAG is set if N is explicitly specified.
821 In Overwrite mode, single character backward deletion may replace
822 tabs with spaces so as to back over columns, unless point is at
823 the end of the line."
828 delete-active-region
830 ;; If a region is active, kill or delete it.
834 ;; In Overwrite mode, maybe untabify while deleting
844 ;; Otherwise, do simple deletion.
848 "Delete the following N characters (previous if N is negative).
849 If Transient Mark mode is enabled, the mark is active, and N is 1,
850 delete the text in the region and deactivate the mark instead.
851 To disable this, set `delete-active-region' to nil.
853 Optional second arg KILLFLAG non-nil means to kill (save in kill
854 ring) instead of delete. Interactively, N is the prefix arg, and
855 KILLFLAG is set if N was explicitly specified."
860 delete-active-region
862 ;; If a region is active, kill or delete it.
866 ;; Otherwise, do simple deletion.
870 "Put point at beginning and mark at end of buffer.
871 You probably should not use this function in Lisp programs;
872 it is usually a mistake for a Lisp function to use any subroutine
873 that uses or sets the mark."
878 \f
880 ;; Counting lines, one way or another.
883 "Goto LINE, counting from line 1 at beginning of buffer.
884 Normally, move point in the current buffer, and leave mark at the
886 move point in the most recently selected other buffer, and switch to it.
888 If there's a number in the buffer at point, it is the default for LINE.
890 This function is usually the wrong thing to use in a Lisp program.
891 What you probably want instead is something like:
892 (goto-char (point-min)) (forward-line (1- N))
893 If at all possible, an even better solution is to use char counts
894 rather than line counts."
898 ;; Look for a default, a number in the buffer at point.
908 ;; Decide if we're switching buffers.
916 ;; Read the argument, offering that number (if any) as default.
919 buffer-prompt
920 default)
921 default)
922 buffer))))
923 ;; Switch to the desired buffer, one way or another.
928 ;; Leave mark at previous position
930 ;; Move to the specified line number in that buffer.
939 "Print the number of words in the region.
940 When called interactively, the word count is printed in echo area."
951 count))
954 "Print number of lines and characters in the region."
960 "Print the current buffer line number and narrowed line number of point."
973 "Return number of lines between START and END.
974 This is usually the number of newlines between them,
975 but can be one more if START is not equal to END
976 and the greater of them is not at the start of a line."
992 done)))
996 "Return (narrowed) buffer line number at position POS.
997 If POS is nil, use current buffer location.
998 Counting starts at (point-min), so the value refers
999 to the contents of the accessible portion of the buffer."
1009 "Print info on cursor position (on screen and within buffer).
1010 Also describe the character after point, and give its character code
1011 in octal, decimal and hex.
1013 For a non-ASCII multibyte character, also give its encoding in the
1014 buffer's selected coding system if the coding system encodes the
1015 character safely. If the character is encoded into one byte, that
1016 code is shown in hex. If the character is encoded into more than one
1019 In addition, with prefix argument, show details about that character
1020 in *Help* buffer. See also the command `describe-char'."
1028 ;; Avoid overflow from multiplying by 100!
1032 ""
1038 pos total percent beg end col hscroll)
1040 pos total col hscroll))
1042 encoded encoding-msg display-prop under-display)
1049 ;; Check if the character is displayed with some `display'
1050 ;; text property. In that case, set under-display to the
1051 ;; buffer substring covered by that property.
1062 under-display)))
1068 char char char under-display)
1070 char char char under-display display-prop))
1073 char char char
1075 "..."
1079 ;; We show the detailed information about CHAR.
1086 encoding-msg pos total percent beg end col hscroll)
1093 encoding-msg pos total percent col hscroll))))))
1094 \f
1095 ;; Initialize read-expression-map. It is defined at C level.
1098 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1099 ;; too rarely useful.
1109 "The current default value or list of default values in the minibuffer.
1110 The functions `read-from-minibuffer' and `completing-read' bind
1114 "Value for `print-level' while printing value in `eval-expression'.
1115 A value of nil means no limit."
1121 "Value for `print-length' while printing value in `eval-expression'.
1122 A value of nil means no limit."
1128 "If non-nil set `debug-on-error' to t in `eval-expression'.
1129 If nil, don't change the value of `debug-on-error'."
1135 "Format VALUE as a result of evaluated expression.
1136 Return a formatted string which is displayed in the echo area
1137 in addition to the value printed by prin1 in functions which
1138 display the result of expression evaluation."
1151 ;; We define this, rather than making `eval' interactive,
1152 ;; for the sake of completion of names like eval-region, eval-buffer.
1155 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1156 When called interactively, read an Emacs Lisp expression and
1157 evaluate it.
1158 Value is also consed on to front of the variable `values'.
1159 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1160 with prefix argument) means insert the result into the current buffer
1161 instead of printing it in the echo area. Truncates long output
1162 according to the value of the variables `eval-expression-print-length'
1163 and `eval-expression-print-level'.
1165 If `eval-expression-debug-on-error' is non-nil, which is the default,
1166 this command arranges for all errors to enter the debugger."
1170 nil read-expression-map t
1172 current-prefix-arg))
1177 ;; Bind debug-on-error to something unique so that we can
1178 ;; detect when evaled code changes it.
1182 ;; If evaled code has changed the value of debug-on-error,
1183 ;; propagate that change to the global binding.
1199 "Prompting with PROMPT, let user edit COMMAND and eval result.
1200 COMMAND is a Lisp expression. Let user edit that expression in
1201 the minibuffer, then read and evaluate the result."
1208 read-expression-map t
1210 ;; If command was added to command-history as a string,
1211 ;; get rid of that. We want only evaluable expressions there.
1215 ;; If command to be redone does not match front of history,
1216 ;; add it to the history.
1222 "Edit and re-evaluate last complex command, or ARGth from last.
1223 A complex command is one which used the minibuffer.
1224 The command is placed in the minibuffer as a Lisp form for editing.
1225 The result is executed, repeating the command as changed.
1226 If the command has been changed or is not the most recent previous
1227 command it is added to the front of the command history.
1228 You can use the minibuffer history commands \
1230 to get different commands to edit and resubmit."
1233 newcmd)
1245 ;; If command was added to command-history as a
1246 ;; string, get rid of that. We want only
1247 ;; evaluable expressions there.
1251 ;; If command to be redone does not match front of history,
1252 ;; add it to the history.
1261 "Read command name to invoke in `execute-extended-command'."
1266 ;; Get a command name at point in the original buffer
1267 ;; to propose it after M-n.
1271 ;; Read a string, completing from and restricting to the set of
1272 ;; all defined commands. Don't provide any initial input.
1273 ;; Save the command read on the extended-command history list.
1284 ;; This isn't strictly correct if `execute-extended-command'
1285 ;; is bound to anything else (e.g. [menu]).
1286 ;; It could use (key-description (this-single-command-keys)),
1287 ;; but actually a prompt other than "M-x" would be confusing,
1288 ;; because "M-x" is a well-known prompt to read a command
1289 ;; and it serves as a shorthand for "Extended command: ".
1293 \f
1295 "Default minibuffer history list.
1296 This is used for all minibuffer input
1297 except when an alternate history list is specified.
1299 Maximum length of the history list is determined by the value
1302 "Control whether history list elements are expressions or strings.
1303 If the value of this variable equals current minibuffer depth,
1304 they are expressions; otherwise they are strings.
1305 \(That convention is designed to do the right thing for
1312 "Text that was in this minibuffer before any history commands.
1313 This is nil if there have not yet been any history commands
1322 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1326 "Minibuffer history variables for which matching should ignore case.
1327 If a history variable is a member of this list, then the
1329 commands ignore case when searching it, regardless of `case-fold-search'."
1334 "Find the previous history element that matches REGEXP.
1335 \(Previous history elements refer to earlier actions.)
1336 With prefix argument N, search for Nth previous match.
1337 If N is negative, find the next or Nth next match.
1338 Normally, history elements are matched case-insensitively if
1339 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1340 makes the search case-sensitive.
1341 See also `minibuffer-history-case-insensitive-variables'."
1345 nil
1346 minibuffer-local-map
1347 nil
1348 'minibuffer-history-search-history
1350 ;; Use the last regexp specified, by default, if input is empty.
1355 regexp)
1365 ;; On some systems, ignore case for file names.
1367 minibuffer-history-case-insensitive-variables)
1368 t
1369 ;; Respect the user's setting for case-fold-search:
1370 case-fold-search)
1371 nil))
1372 prevpos
1373 match-string
1374 match-offset
1381 "No later matching history item"
1402 next-matching-history-element))
1406 "Find the next history element that matches REGEXP.
1407 \(The next history element refers to a more recent action.)
1408 With prefix argument N, search for Nth next match.
1409 If N is negative, find the previous or Nth previous match.
1410 Normally, history elements are matched case-insensitively if
1411 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1412 makes the search case-sensitive."
1416 nil
1417 minibuffer-local-map
1418 nil
1419 'minibuffer-history-search-history
1421 ;; Use the last regexp specified, by default, if input is empty.
1426 regexp)
1433 "Function run by `goto-history-element' before consuming default values.
1434 This is useful to dynamically add more elements to the list of default values
1435 when `goto-history-element' reaches the end of this list.
1436 Before calling this function `goto-history-element' sets the variable
1437 `minibuffer-default-add-done' to t, so it will call this function only
1438 once. In special cases, when this function needs to be called more
1439 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1443 "When nil, add more elements to the end of the list of default values.
1444 The value nil causes `goto-history-element' to add more elements to
1445 the list of defaults when it reaches the end of this list. It does
1451 "Return a list of all completions without the default value.
1452 This function is used to add all elements of the completion table to
1453 the end of the list of defaults just after the default value."
1456 minibuffer-completion-table
1457 minibuffer-completion-predicate)))
1463 "Puts element of the minibuffer history in the minibuffer.
1464 The argument NABS specifies the absolute history position."
1478 elt minibuffer-returned-to-present)
1490 previous-history-element))
1502 minibuffer-default)))
1514 elt))
1518 "Puts next element of the minibuffer history in the minibuffer.
1519 With argument N, it uses the Nth following element."
1525 "Puts previous element of the minibuffer history in the minibuffer.
1526 With argument N, it uses the Nth previous element."
1532 "Get next history element which completes the minibuffer before the point.
1533 The contents of the minibuffer after the point are deleted, and replaced
1534 by the new completion."
1540 n)
1541 ;; next-matching-history-element always puts us at (point-min).
1542 ;; Move to the position we were at before changing the buffer contents.
1543 ;; This is still sensical, because the text before point has not changed.
1547 "\
1548 Get previous history element which completes the minibuffer before the point.
1549 The contents of the minibuffer after the point are deleted, and replaced
1550 by the new completion."
1554 ;; For compatibility with the old subr of the same name.
1556 "Return the display width of the minibuffer prompt.
1557 Return 0 if current buffer is not a minibuffer."
1558 ;; Return the width of everything before the field at the end of
1559 ;; the buffer; this should be 0 for normal buffers.
1561 \f
1562 ;; isearch minibuffer history
1569 "Set up a minibuffer for using isearch to search the minibuffer history.
1570 Intended to be added to `minibuffer-setup-hook'."
1582 "Clean up the minibuffer after terminating isearch in the minibuffer."
1587 "Return the proper search function, for isearch in minibuffer history."
1594 ;; Use standard functions to search within minibuffer text
1600 found)
1601 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1602 ;; searching forward. Lazy-highlight calls this lambda with the
1603 ;; bound arg, so skip the minibuffer prompt.
1607 ;; 1. First try searching in the initial minibuffer text
1610 noerror)
1611 ;; 2. If the above search fails, start putting next/prev history
1612 ;; elements in the minibuffer successively, and search the string
1613 ;; in them. Do this only when bound is nil (i.e. not while
1614 ;; lazy-highlighting search strings in the current minibuffer text).
1626 ;; After putting the next/prev history element, search
1627 ;; the string in them again, until next-history-element
1628 ;; or previous-history-element raises an error at the
1629 ;; beginning/end of history.
1632 ;; For backward search, don't search
1633 ;; in the minibuffer prompt
1635 noerror)))
1636 ;; Return point of the new search result
1638 ;; Return nil when next(prev)-history-element fails
1642 "Display the minibuffer history search prompt.
1643 If there are no search errors, this function displays an overlay with
1644 the isearch prompt which replaces the original minibuffer prompt.
1645 Otherwise, it displays the standard isearch message returned from
1646 `isearch-message'."
1648 ;; Use standard function `isearch-message' when not in the minibuffer,
1649 ;; or search fails, or has an error (like incomplete regexp).
1650 ;; This function overwrites minibuffer text with isearch message,
1651 ;; so it's possible to see what is wrong in the search string.
1653 ;; Otherwise, put the overlay with the standard isearch prompt over
1654 ;; the initial minibuffer prompt.
1663 ;; And clear any previous isearch message.
1667 "Wrap the minibuffer history search when search fails.
1668 Move point to the first history element for a forward search,
1669 or to the last history element for a backward search."
1671 ;; When `minibuffer-history-isearch-search' fails on reaching the
1672 ;; beginning/end of the history, wrap the search to the first/last
1673 ;; minibuffer history element.
1681 "Save a function restoring the state of minibuffer history search.
1682 Save `minibuffer-history-position' to the additional state parameter
1683 in the search status stack."
1688 "Restore the minibuffer history search state.
1689 Go to the history element by the absolute history position HIST-POS."
1692 \f
1693 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1697 "Table mapping redo records to the corresponding undo one.
1698 A redo record for undo-in-region maps to t.
1708 "Within a run of consecutive undo commands, list remaining to be undone.
1712 "Undo some previous changes.
1713 Repeat this command to undo more changes.
1714 A numeric ARG serves as a repeat count.
1716 In Transient Mark mode when the mark is active, only undo changes within
1718 as an argument limits undo to changes within the current region."
1720 ;; Make last-command indicate for the next command that this was an undo.
1721 ;; That way, another undo will undo more.
1722 ;; If we get to the end of the undo history and get an error,
1723 ;; another undo command will find the undo history empty
1724 ;; and will get another error. To begin undoing the undos,
1725 ;; you must type some other command.
1728 message)
1729 ;; If we get an error in undo-start,
1730 ;; the next command should not be a "consecutive undo".
1731 ;; So set `this-command' to something other than `undo'.
1736 ;; If something (a timer or filter?) changed the buffer
1737 ;; since the previous command, don't continue the undo seq.
1741 ;; If the last undo record made was made by undo
1742 ;; it shows nothing else happened in between.
1749 ;; get rid of initial undo boundary
1751 ;; If we got this far, the next command should be a consecutive undo.
1753 ;; Check to see whether we're hitting a redo record, and if
1754 ;; so, ask the user whether she wants to skip the redo/undo pair.
1761 ;; The equiv entry might point to another redo record if we have done
1762 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1770 ;; Record the fact that the just-generated undo records come from an
1771 ;; undo operation--that is, they are redo records.
1772 ;; In the ordinary case (not within a region), map the redo
1773 ;; record to the following undos.
1774 ;; I don't know how to do that in the undo-in-region case.
1776 ;; Strip any leading undo boundaries there might be, like we do
1777 ;; above when checking.
1781 undo-equiv-table))
1782 ;; Don't specify a position in the undo record for the undo command.
1783 ;; Instead, undoing this should move point to where the change is.
1802 ;; Record what the current undo list says,
1803 ;; so the next command can tell if the buffer was modified in between.
1806 ;; Display a message announcing success.
1811 "Make BUFFER stop keeping undo information.
1812 No argument or nil as argument means do this for the current buffer."
1818 "Undo some previous changes.
1819 Repeat this command to undo more changes.
1820 A numeric ARG serves as a repeat count.
1821 Contrary to `undo', this will not redo a previous undo."
1826 "Non-nil while performing an undo.
1830 "Undo back N undo-boundaries beyond what was already undone recently.
1831 Call `undo-start' to get ready to undo recent changes,
1832 then call `undo-more' one or more times to undo them."
1837 ;; Note: The following, while pulling elements off
1838 ;; `pending-undo-list' will call primitive change functions which
1839 ;; will push more elements onto `buffer-undo-list'.
1844 ;; Deep copy of a list
1846 "Make a copy of undo list LIST."
1852 elt))
1855 "Set `pending-undo-list' to the front of the undo list.
1856 The next call to `undo-more' will undo the most recently made change.
1857 If BEG and END are specified, then only undo elements
1858 that apply to text between BEG and END are used; other undo elements
1859 are ignored. If BEG and END are nil, all undo elements are used."
1865 buffer-undo-list)))
1870 "Return a list of undo elements for the region START to END.
1871 The elements come from `buffer-undo-list', but we keep only
1872 the elements inside this region, and discard those outside this region.
1873 If we find an element that crosses an edge of this region,
1874 we stop and ignore all further elements."
1877 undo-adjusted-markers
1878 some-rejected
1879 undo-elt temp-undo-list delta)
1884 ;; This is a "was unmodified" element.
1885 ;; Keep it if we have kept everything thus far.
1892 ;; Don't put two nils together in the list
1906 ;; Loop down the earlier events adjusting their buffer
1907 ;; positions to reflect the fact that a change to the buffer
1908 ;; isn't being undone. We only need to process those element
1909 ;; types which undo-elt-in-region will return as being in
1910 ;; the region since only those types can ever get into the
1911 ;; output
1920 ;; (TEXT . POSITION)
1927 ;; (BEGIN . END)
1932 ;; (nil PROPERTY VALUE BEG . END)
1942 "Determine whether UNDO-ELT falls inside the region START ... END.
1943 If it crosses the edge, we return nil."
1948 t)
1950 nil)
1952 ;; (TEXT . POSITION)
1956 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1957 ;; See if MARKER is inside the region.
1968 ;; (nil PROPERTY VALUE BEG . END)
1973 ;; (BEGIN . END)
1978 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1979 This assumes we have already decided that UNDO-ELT
1980 is not *inside* the region START...END."
1983 ;; (nil PROPERTY VALUE BEG . END)
1988 ;; (BEGIN . END)
1992 ;; Return the first affected buffer position and the delta for an undo element
1993 ;; delta is defined as the change in subsequent buffer positions if we *did*
1994 ;; the undo.
1998 ;; (TEXT . POSITION)
2001 ;; (BEGIN . END)
2008 "If non-nil ask about discarding undo info for the current command.
2009 Normally, Emacs discards the undo info for the current command if
2010 it exceeds `undo-outer-limit'. But if you set this option
2011 non-nil, it asks in the echo area whether to discard the info.
2012 If you answer no, there is a slight risk that Emacs might crash, so
2013 only do it if you really want to undo the command.
2015 This option is mainly intended for debugging. You have to be
2016 careful if you use it for other purposes. Garbage collection is
2017 inhibited while the question is asked, meaning that Emacs might
2018 leak memory. So you should make sure that you do not wait
2019 excessively long before answering the question."
2025 "If non-nil, an extra level of size that's ok in an undo item.
2026 We don't ask the user about truncating the undo list until the
2027 current item gets bigger than this amount.
2032 ;; When the first undo batch in an undo list is longer than
2033 ;; undo-outer-limit, this function gets called to warn the user that
2034 ;; the undo info for the current command was discarded. Garbage
2035 ;; collection is inhibited around the call, so it had better not do a
2036 ;; lot of consing.
2042 ;; Don't ask the question again unless it gets even bigger.
2043 ;; This applies, in particular, if the user quits from the question.
2044 ;; Such a quit quits out of GC, but something else will call GC
2045 ;; again momentarily. It will call this function again,
2046 ;; but we don't want to ask the question again.
2053 t)
2054 nil))
2059 "The undo info was discarded because it exceeded \
2060 `undo-outer-limit'.
2062 This is normal if you executed a command that made a huge change
2063 to the buffer. In that case, to prevent similar problems in the
2064 future, set `undo-outer-limit' to a value that is large enough to
2065 cover the maximum size of normal changes you expect a single
2066 command to make, but not so large that it might exceed the
2067 maximum memory allotted to Emacs.
2069 If you did not execute any such command, the situation is
2070 probably due to a bug and you should report it.
2072 You can disable the popping up of this buffer by adding the entry
2073 \(undo discard-info) to the user option `warning-suppress-types',
2077 t))
2078 \f
2080 "History list for some commands that read shell commands.
2082 Maximum length of the history list is determined by the value
2089 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2090 This buffer is used when `shell-command' or `shell-command-on-region'
2091 is run interactively. A value of nil means that output to stderr and
2098 "Return a list of all commands associated with the current file.
2099 This function is used to add all related commands retrieved by `mailcap'
2100 to the end of the list of defaults just after the default value."
2104 minibuffer-default))
2109 commands))
2120 map)
2124 "Read a shell command from the minibuffer.
2125 The arguments are the same as the ones of `read-from-minibuffer',
2126 except READ and KEYMAP are missing and HIST defaults
2127 to `shell-command-history'."
2135 minibuffer-local-shell-command-map
2136 nil
2138 args)))
2141 "Execute string COMMAND asynchronously in background.
2143 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2144 surrounded by whitespace and executes the command asynchronously.
2145 The output appears in the buffer `*Async Shell Command*'.
2147 In Elisp, you will often be better served by calling `start-process'
2148 directly, since it offers more control and does not impose the use of a
2149 shell (with its need to quote arguments)."
2155 current-prefix-arg
2156 shell-command-default-error-buffer))
2162 "Execute string COMMAND in inferior shell; display output, if any.
2163 With prefix argument, insert the COMMAND's output at point.
2165 If COMMAND ends in ampersand, execute it asynchronously.
2166 The output appears in the buffer `*Async Shell Command*'.
2167 That buffer is in shell mode.
2169 Otherwise, COMMAND is executed synchronously. The output appears in
2170 the buffer `*Shell Command Output*'. If the output is short enough to
2171 display in the echo area (which is determined by the variables
2172 `resize-mini-windows' and `max-mini-window-height'), it is shown
2173 there, but it is nonetheless available in buffer `*Shell Command
2174 Output*' even though that buffer is not automatically displayed.
2176 To specify a coding system for converting non-ASCII characters
2178 before this command.
2180 Noninteractive callers can specify coding systems by binding
2181 `coding-system-for-read' and `coding-system-for-write'.
2183 The optional second argument OUTPUT-BUFFER, if non-nil,
2184 says to put the output in some other buffer.
2185 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2186 If OUTPUT-BUFFER is not a buffer and not nil,
2187 insert output in current buffer. (This cannot be done asynchronously.)
2188 In either case, the buffer is first erased, and the output is
2189 inserted after point (leaving mark after it).
2191 If the command terminates without error, but generates output,
2193 the output can be displayed in the echo area or in its buffer.
2194 If the output is short enough to display in the echo area
2195 \(determined by the variable `max-mini-window-height' if
2196 `resize-mini-windows' is non-nil), it is shown there.
2197 Otherwise,the buffer containing the output is displayed.
2201 of the output.
2203 If there is no output, or if output is inserted in the current buffer,
2204 then `*Shell Command Output*' is deleted.
2206 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2207 or buffer name to which to direct the command's standard error output.
2208 If it is nil, error output is mingled with regular output.
2209 In an interactive call, the variable `shell-command-default-error-buffer'
2210 specifies the value of ERROR-BUFFER.
2212 In Elisp, you will often be better served by calling `call-process' or
2213 `start-process' directly, since it offers more control and does not impose
2214 the use of a shell (with its need to quote arguments)."
2225 current-prefix-arg
2226 shell-command-default-error-buffer))
2227 ;; Look for a handler in case default-directory is a remote file name.
2235 ;; Output goes in current buffer.
2241 temporary-file-directory)))
2242 nil)))
2245 ;; We do not use -f for csh; we will not support broken use of
2246 ;; .cshrcs. Even the BSD csh manual says to use
2247 ;; "if ($?prompt) exit" before things which are not useful
2248 ;; non-interactively. Besides, if someone wants their other
2249 ;; aliases for shell commands then they can still have them.
2253 t)
2254 nil shell-command-switch command)
2261 ;; Do no formatting while reading error file,
2262 ;; because that can run a shell command, and we
2263 ;; don't want that to cause an infinite recursion.
2265 ;; Put point after the inserted errors.
2269 ;; This is like exchange-point-and-mark, but doesn't
2270 ;; activate the mark. It is cleaner to avoid activation,
2271 ;; even though the command loop would deactivate the mark
2272 ;; because we inserted text.
2276 ;; Output goes in a separate buffer.
2277 ;; Preserve the match data in case called from a program.
2280 ;; Command ending with ampersand means asynchronous.
2284 proc)
2285 ;; Remove the ampersand.
2287 ;; If will kill a process, query first.
2295 ;; Setting buffer-read-only to nil doesn't suffice
2296 ;; if some text has a non-nil read-only property,
2297 ;; which comint sometimes adds for prompts.
2303 shell-command-switch command))
2307 ;; Use the comint filter for proper handling of carriage motion
2308 ;; (see `comint-inhibit-carriage-motion'),.
2310 ))
2311 ;; Otherwise, command is executed synchronously.
2313 output-buffer nil error-buffer)))))))
2317 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2318 MESSAGE may be either a string or a buffer.
2320 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2321 the maximum height of the echo area, as defined by `max-mini-window-height'
2322 if `resize-mini-windows' is non-nil.
2324 Returns either the string shown in the echo area, or when a pop-up
2325 buffer is used, the window used to display it.
2327 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2328 name of the buffer used to display it in the case where a pop-up buffer
2329 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2330 string and it is displayed in the echo area, it is not specified whether
2331 the contents are inserted into the buffer anyway.
2333 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2334 and only used if a buffer is displayed."
2336 ;; Trivial case where we can use the echo area
2340 ;; Trivial case where we can just remove single trailing newline
2343 ;; General case
2346 message
2355 0
2359 (<= lines
2363 max-mini-window-height))
2365 max-mini-window-height)
2369 ;; Don't use the echo area if the output buffer is
2370 ;; already dispayed in the selected frame.
2372 ;; Echo area
2378 ;; Buffer
2381 not-this-window frame))))))))
2384 ;; We have a sentinel to prevent insertion of a termination message
2385 ;; in the buffer itself.
2393 &optional output-buffer replace
2394 error-buffer display-error-buffer)
2395 "Execute string COMMAND in inferior shell with region as input.
2396 Normally display output (if any) in temp buffer `*Shell Command Output*';
2397 Prefix arg means replace the region with it. Return the exit code of
2398 COMMAND.
2400 To specify a coding system for converting non-ASCII characters
2402 before this command. By default, the input (from the current buffer)
2403 is encoded in the same coding system that will be used to save the file,
2404 `buffer-file-coding-system'. If the output is going to replace the region,
2405 then it is decoded from that same coding system.
2407 The noninteractive arguments are START, END, COMMAND,
2408 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2409 Noninteractive callers can specify coding systems by binding
2410 `coding-system-for-read' and `coding-system-for-write'.
2412 If the command generates output, the output may be displayed
2413 in the echo area or in a buffer.
2414 If the output is short enough to display in the echo area
2415 \(determined by the variable `max-mini-window-height' if
2416 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2417 it is displayed in the buffer `*Shell Command Output*'. The output
2418 is available in that buffer in both cases.
2420 If there is output and an error, a message about the error
2421 appears at the end of the output.
2423 If there is no output, or if output is inserted in the current buffer,
2424 then `*Shell Command Output*' is deleted.
2426 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2427 that says to put the output in some other buffer.
2428 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2429 If OUTPUT-BUFFER is not a buffer and not nil,
2430 insert output in the current buffer.
2431 In either case, the output is inserted after point (leaving mark after it).
2433 If REPLACE, the optional fifth argument, is non-nil, that means insert
2434 the output in place of text from START to END, putting point and mark
2435 around it.
2437 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2438 or buffer name to which to direct the command's standard error output.
2439 If it is nil, error output is mingled with regular output.
2440 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2441 were any errors. (This is always t, interactively.)
2442 In an interactive call, the variable `shell-command-default-error-buffer'
2443 specifies the value of ERROR-BUFFER."
2447 ;; Do this before calling region-beginning
2448 ;; and region-end, in case subprocess output
2449 ;; relocates them while we are in the minibuffer.
2451 ;; call-interactively recognizes region-beginning and
2452 ;; region-end specially, leaving them in the history.
2454 string
2455 current-prefix-arg
2456 current-prefix-arg
2457 shell-command-default-error-buffer
2458 t)))
2464 temporary-file-directory)))
2465 nil))
2466 exit-status)
2470 ;; Replace specified region with output from command.
2472 ;; Don't muck with mark unless REPLACE says we should.
2479 t)
2480 nil shell-command-switch command))
2481 ;; It is rude to delete a buffer which the command is not using.
2482 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2483 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2484 ;; (kill-buffer shell-buffer)))
2485 ;; Don't muck with mark unless REPLACE says we should.
2487 ;; No prefix argument: put the output in a temp buffer,
2488 ;; replacing its entire contents.
2493 ;; If the input is the same buffer as the output,
2494 ;; delete everything but the specified region,
2495 ;; then replace that region with the output.
2501 shell-file-name t
2504 t)
2505 nil shell-command-switch
2506 command)))
2507 ;; Clear the output buffer, then run the command with
2508 ;; output there.
2519 buffer)
2520 nil shell-command-switch command)))
2521 ;; Report the output.
2531 ;; There's some output, display it
2533 ;; No output; error?
2540 shell-command-default-error-buffer)
2547 output))
2550 exit-status))
2553 exit-status output))))
2554 ;; Don't kill: there might be useful info in the undo-log.
2555 ;; (kill-buffer buffer)
2556 ))))
2564 ;; Do no formatting while reading error file,
2565 ;; because that can run a shell command, and we
2566 ;; don't want that to cause an infinite recursion.
2568 ;; Put point after the inserted errors.
2573 exit-status))
2576 "Execute shell command COMMAND and return its output as a string."
2579 standard-output
2583 "Process files synchronously in a separate process.
2584 Similar to `call-process', but may invoke a file handler based on
2585 `default-directory'. The current working directory of the
2586 subprocess is `default-directory'.
2588 File names in INFILE and BUFFER are handled normally, but file
2589 names in ARGS should be relative to `default-directory', as they
2590 are passed to the process verbatim. \(This is a difference to
2591 `call-process' which does not support file handlers for INFILE
2592 and BUFFER.\)
2594 Some file handlers might not support all variants, for example
2595 they might behave as if DISPLAY was nil, regardless of the actual
2596 value passed."
2598 lc stderr-file)
2608 display args)
2614 "Whether a call of `process-file' changes remote files.
2616 Per default, this variable is always set to `t', meaning that a
2617 call of `process-file' could potentially change any file on a
2618 remote host. When set to `nil', a file handler could optimize
2619 its behaviour with respect to remote file attributes caching.
2621 This variable should never be changed by `setq'. Instead of, it
2625 "Start a program in a subprocess. Return the process object for it.
2627 Similar to `start-process', but may invoke a file handler based on
2628 `default-directory'. See Info node `(elisp)Magic File Names'.
2630 This handler ought to run PROGRAM, perhaps on the local host,
2631 perhaps on a remote host that corresponds to `default-directory'.
2632 In the latter case, the local part of `default-directory' becomes
2633 the working directory of the process.
2635 PROGRAM and PROGRAM-ARGS might be file names. They are not
2636 objects of file handler invocation. File handlers might not
2637 support pty association, if PROGRAM is nil."
2641 \f
2642 ;;;; Process menu
2654 "Major mode for listing the processes called by Emacs."
2666 "Recompute the list of processes for the Process List buffer."
2677 face link
2680 follow-link t
2681 process-buffer ,buf
2682 action process-menu-visit-buffer)
2691 "datagram"
2706 tabulated-list-entries)))))
2712 "Display a list of all processes.
2713 If optional argument QUERY-ONLY is non-nil, only processes with
2714 the query-on-exit flag set are listed.
2715 Any process listed as exited or signaled is actually eliminated
2716 after the listing is made.
2717 Optional argument BUFFER specifies a buffer to use, instead of
2719 The return value is always nil."
2731 nil)
2732 \f
2736 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2737 (define-key map [switch-frame] nil)
2738 (define-key map [?\C-u] 'universal-argument-more)
2739 (define-key map [?-] 'universal-argument-minus)
2740 (define-key map [?0] 'digit-argument)
2741 (define-key map [?1] 'digit-argument)
2742 (define-key map [?2] 'digit-argument)
2743 (define-key map [?3] 'digit-argument)
2744 (define-key map [?4] 'digit-argument)
2745 (define-key map [?5] 'digit-argument)
2746 (define-key map [?6] 'digit-argument)
2747 (define-key map [?7] 'digit-argument)
2748 (define-key map [?8] 'digit-argument)
2749 (define-key map [?9] 'digit-argument)
2750 (define-key map [kp-0] 'digit-argument)
2751 (define-key map [kp-1] 'digit-argument)
2752 (define-key map [kp-2] 'digit-argument)
2753 (define-key map [kp-3] 'digit-argument)
2754 (define-key map [kp-4] 'digit-argument)
2755 (define-key map [kp-5] 'digit-argument)
2756 (define-key map [kp-6] 'digit-argument)
2757 (define-key map [kp-7] 'digit-argument)
2758 (define-key map [kp-8] 'digit-argument)
2759 (define-key map [kp-9] 'digit-argument)
2760 (define-key map [kp-subtract] 'universal-argument-minus)
2761 map)
2764 (defvar universal-argument-num-events nil
2765 "Number of argument-specifying events read by `universal-argument'.
2766 `universal-argument-other-key' uses this to discard those events
2767 from (this-command-keys), and reread only the final command.")
2769 (defvar saved-overriding-map t
2770 "The saved value of `overriding-terminal-local-map'.
2774 (defun save&set-overriding-map (map)
2775 "Set `overriding-terminal-local-map' to MAP."
2776 (when (eq saved-overriding-map t)
2777 (setq saved-overriding-map overriding-terminal-local-map)
2778 (setq overriding-terminal-local-map map)))
2780 (defun restore-overriding-map ()
2781 "Restore `overriding-terminal-local-map' to its saved value."
2782 (setq overriding-terminal-local-map saved-overriding-map)
2783 (setq saved-overriding-map t))
2785 (defun universal-argument ()
2786 "Begin a numeric argument for the following command.
2791 multiplies the argument by 4 each time.
2793 which is different in effect from any particular numeric argument.
2795 (interactive)
2796 (setq prefix-arg (list 4))
2797 (setq universal-argument-num-events (length (this-command-keys)))
2798 (save&set-overriding-map universal-argument-map))
2800 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2801 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2802 (defun universal-argument-more (arg)
2803 (interactive "P")
2804 (if (consp arg)
2805 (setq prefix-arg (list (* 4 (car arg))))
2806 (if (eq arg '-)
2807 (setq prefix-arg (list -4))
2808 (setq prefix-arg arg)
2809 (restore-overriding-map)))
2810 (setq universal-argument-num-events (length (this-command-keys))))
2812 (defun negative-argument (arg)
2813 "Begin a negative numeric argument for the next command.
2815 (interactive "P")
2816 (cond ((integerp arg)
2817 (setq prefix-arg (- arg)))
2818 ((eq arg '-)
2819 (setq prefix-arg nil))
2820 (t
2821 (setq prefix-arg '-)))
2822 (setq universal-argument-num-events (length (this-command-keys)))
2823 (save&set-overriding-map universal-argument-map))
2825 (defun digit-argument (arg)
2826 "Part of the numeric argument for the next command.
2828 (interactive "P")
2829 (let* ((char (if (integerp last-command-event)
2830 last-command-event
2831 (get last-command-event 'ascii-character)))
2833 (cond ((integerp arg)
2834 (setq prefix-arg (+ (* arg 10)
2835 (if (< arg 0) (- digit) digit))))
2836 ((eq arg '-)
2837 ;; Treat -0 as just -, so that -01 will work.
2838 (setq prefix-arg (if (zerop digit) '- (- digit))))
2839 (t
2840 (setq prefix-arg digit))))
2841 (setq universal-argument-num-events (length (this-command-keys)))
2842 (save&set-overriding-map universal-argument-map))
2844 ;; For backward compatibility, minus with no modifiers is an ordinary
2845 ;; command if digits have already been entered.
2846 (defun universal-argument-minus (arg)
2847 (interactive "P")
2848 (if (integerp arg)
2849 (universal-argument-other-key arg)
2850 (negative-argument arg)))
2852 ;; Anything else terminates the argument and is left in the queue to be
2853 ;; executed as a command.
2854 (defun universal-argument-other-key (arg)
2855 (interactive "P")
2856 (setq prefix-arg arg)
2857 (let* ((key (this-command-keys))
2858 (keylist (listify-key-sequence key)))
2859 (setq unread-command-events
2860 (append (nthcdr universal-argument-num-events keylist)
2861 unread-command-events)))
2862 (reset-this-command-lengths)
2863 (restore-overriding-map))
2864 \f
2866 (defvar filter-buffer-substring-functions nil
2867 "Wrapper hook around `filter-buffer-substring'.
2868 The functions on this special hook are called with 4 arguments:
2869 NEXT-FUN BEG END DELETE
2870 NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2871 that performs the default operation. The other 3 arguments are like
2872 the ones passed to `filter-buffer-substring'.")
2874 (defvar buffer-substring-filters nil
2875 "List of filter functions for `filter-buffer-substring'.
2876 Each function must accept a single argument, a string, and return
2877 a string. The buffer substring is passed to the first function
2878 in the list, and the return value of each function is passed to
2879 the next. The return value of the last function is used as the
2880 return value of `filter-buffer-substring'.
2882 If this variable is nil, no filtering is performed.")
2883 (make-obsolete-variable 'buffer-substring-filters
2884 'filter-buffer-substring-functions "24.1")
2886 (defun filter-buffer-substring (beg end &optional delete)
2887 "Return the buffer substring between BEG and END, after filtering.
2888 The filtering is performed by `filter-buffer-substring-functions'.
2890 If DELETE is non-nil, the text between BEG and END is deleted
2891 from the buffer.
2893 This function should be used instead of `buffer-substring',
2894 `buffer-substring-no-properties', or `delete-and-extract-region'
2895 when you want to allow filtering to take place. For example,
2896 major or minor modes can use `filter-buffer-substring-functions' to
2897 extract characters that are special to a buffer, and should not
2898 be copied into other buffers."
2899 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2900 (cond
2901 ((or delete buffer-substring-filters)
2902 (save-excursion
2903 (goto-char beg)
2904 (let ((string (if delete (delete-and-extract-region beg end)
2905 (buffer-substring beg end))))
2906 (dolist (filter buffer-substring-filters)
2907 (setq string (funcall filter string)))
2908 string)))
2909 (t
2910 (buffer-substring beg end)))))
2913 ;;;; Window system cut and paste hooks.
2915 (defvar interprogram-cut-function nil
2916 "Function to call to make a killed region available to other programs.
2918 Most window systems provide some sort of facility for cutting and
2919 pasting text between the windows of different programs.
2920 This variable holds a function that Emacs calls whenever text
2921 is put in the kill ring, to make the new kill available to other
2922 programs.
2924 The function takes one argument, TEXT, which is a string containing
2925 the text which should be made available.")
2927 (defvar interprogram-paste-function nil
2928 "Function to call to get text cut from other programs.
2930 Most window systems provide some sort of facility for cutting and
2931 pasting text between the windows of different programs.
2932 This variable holds a function that Emacs calls to obtain
2933 text that other programs have provided for pasting.
2935 The function should be called with no arguments. If the function
2936 returns nil, then no other program has provided such text, and the top
2937 of the Emacs kill ring should be used. If the function returns a
2938 string, then the caller of the function \(usually `current-kill')
2939 should put this string in the kill ring as the latest kill.
2941 This function may also return a list of strings if the window
2942 system supports multiple selections. The first string will be
2943 used as the pasted text, but the other will be placed in the
2944 kill ring for easy access via `yank-pop'.
2946 Note that the function should return a string only if a program other
2947 than Emacs has provided a string for pasting; if Emacs provided the
2948 most recent string, the function should return nil. If it is
2949 difficult to tell whether Emacs or some other program provided the
2950 current string, it is probably good enough to return nil if the string
2951 is equal (according to `string=') to the last text Emacs provided.")
2952 \f
2955 ;;;; The kill ring data structure.
2957 (defvar kill-ring nil
2958 "List of killed text sequences.
2959 Since the kill ring is supposed to interact nicely with cut-and-paste
2960 facilities offered by window systems, use of this variable should
2961 interact nicely with `interprogram-cut-function' and
2962 `interprogram-paste-function'. The functions `kill-new',
2963 `kill-append', and `current-kill' are supposed to implement this
2964 interaction; you may want to use them instead of manipulating the kill
2965 ring directly.")
2967 (defcustom kill-ring-max 60
2968 "Maximum length of kill ring before oldest elements are thrown away."
2969 :type 'integer
2970 :group 'killing)
2972 (defvar kill-ring-yank-pointer nil
2973 "The tail of the kill ring whose car is the last thing yanked.")
2975 (defcustom save-interprogram-paste-before-kill nil
2976 "Save clipboard strings into kill ring before replacing them.
2977 When one selects something in another program to paste it into Emacs,
2978 but kills something in Emacs before actually pasting it,
2979 this selection is gone unless this variable is non-nil,
2980 in which case the other program's selection is saved in the `kill-ring'
2982 :type 'boolean
2983 :group 'killing
2984 :version "23.2")
2986 (defcustom kill-do-not-save-duplicates nil
2987 "Do not add a new string to `kill-ring' when it is the same as the last one."
2988 :type 'boolean
2989 :group 'killing
2990 :version "23.2")
2992 (defun kill-new (string &optional replace yank-handler)
2993 "Make STRING the latest kill in the kill ring.
2994 Set `kill-ring-yank-pointer' to point to it.
2995 If `interprogram-cut-function' is non-nil, apply it to STRING.
2996 Optional second argument REPLACE non-nil means that STRING will replace
2997 the front of the kill ring, rather than being added to the list.
2999 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3000 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3001 STRING.
3003 When the yank handler has a non-nil PARAM element, the original STRING
3004 argument is not used by `insert-for-yank'. However, since Lisp code
3005 may access and use elements from the kill ring directly, the STRING
3007 (if (> (length string) 0)
3008 (if yank-handler
3009 (put-text-property 0 (length string)
3010 'yank-handler yank-handler string))
3011 (if yank-handler
3012 (signal 'args-out-of-range
3013 (list string "yank-handler specified for empty string"))))
3014 (unless (and kill-do-not-save-duplicates
3015 (equal string (car kill-ring)))
3016 (if (fboundp 'menu-bar-update-yank-menu)
3017 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3018 (when save-interprogram-paste-before-kill
3019 (let ((interprogram-paste (and interprogram-paste-function
3020 (funcall interprogram-paste-function))))
3021 (when interprogram-paste
3022 (dolist (s (if (listp interprogram-paste)
3023 (nreverse interprogram-paste)
3024 (list interprogram-paste)))
3025 (unless (and kill-do-not-save-duplicates
3026 (equal s (car kill-ring)))
3027 (push s kill-ring))))))
3028 (unless (and kill-do-not-save-duplicates
3029 (equal string (car kill-ring)))
3030 (if (and replace kill-ring)
3031 (setcar kill-ring string)
3032 (push string kill-ring)
3033 (if (> (length kill-ring) kill-ring-max)
3034 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3035 (setq kill-ring-yank-pointer kill-ring)
3036 (if interprogram-cut-function
3037 (funcall interprogram-cut-function string)))
3038 (set-advertised-calling-convention
3039 'kill-new '(string &optional replace) "23.3")
3041 (defun kill-append (string before-p &optional yank-handler)
3042 "Append STRING to the end of the latest kill in the kill ring.
3043 If BEFORE-P is non-nil, prepend STRING to the kill.
3044 If `interprogram-cut-function' is set, pass the resulting kill to it."
3045 (let* ((cur (car kill-ring)))
3046 (kill-new (if before-p (concat string cur) (concat cur string))
3047 (or (= (length cur) 0)
3048 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3049 yank-handler)))
3050 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3052 (defcustom yank-pop-change-selection nil
3053 "If non-nil, rotating the kill ring changes the window system selection."
3054 :type 'boolean
3055 :group 'killing
3056 :version "23.1")
3058 (defun current-kill (n &optional do-not-move)
3059 "Rotate the yanking point by N places, and then return that kill.
3060 If N is zero and `interprogram-paste-function' is set to a
3061 function that returns a string or a list of strings, and if that
3062 function doesn't return nil, then that string (or list) is added
3063 to the front of the kill ring and the string (or first string in
3064 the list) is returned as the latest kill.
3066 If N is not zero, and if `yank-pop-change-selection' is
3067 non-nil, use `interprogram-cut-function' to transfer the
3068 kill at the new yank point into the window system selection.
3070 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3071 move the yanking point; just return the Nth kill forward."
3073 (let ((interprogram-paste (and (= n 0)
3074 interprogram-paste-function
3075 (funcall interprogram-paste-function))))
3076 (if interprogram-paste
3077 (progn
3078 ;; Disable the interprogram cut function when we add the new
3079 ;; text to the kill ring, so Emacs doesn't try to own the
3080 ;; selection, with identical text.
3081 (let ((interprogram-cut-function nil))
3082 (if (listp interprogram-paste)
3083 (mapc 'kill-new (nreverse interprogram-paste))
3084 (kill-new interprogram-paste)))
3085 (car kill-ring))
3086 (or kill-ring (error "Kill ring is empty"))
3087 (let ((ARGth-kill-element
3088 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3089 (length kill-ring))
3090 kill-ring)))
3091 (unless do-not-move
3092 (setq kill-ring-yank-pointer ARGth-kill-element)
3093 (when (and yank-pop-change-selection
3094 (> n 0)
3095 interprogram-cut-function)
3096 (funcall interprogram-cut-function (car ARGth-kill-element))))
3097 (car ARGth-kill-element)))))
3101 ;;;; Commands for manipulating the kill ring.
3103 (defcustom kill-read-only-ok nil
3104 "Non-nil means don't signal an error for killing read-only text."
3105 :type 'boolean
3106 :group 'killing)
3108 (put 'text-read-only 'error-conditions
3109 '(text-read-only buffer-read-only error))
3110 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3112 (defun kill-region (beg end &optional yank-handler)
3114 This deletes the text from the buffer and saves it in the kill ring.
3118 If you want to append the killed region to the last killed text,
3121 If the buffer is read-only, Emacs will beep and refrain from deleting
3122 the text, but put the text in the kill ring anyway. This means that
3123 you can use the killing commands to copy text from a read-only buffer.
3125 Lisp programs should use this function for killing text.
3126 (To delete text, use `delete-region'.)
3127 Supply two arguments, character positions indicating the stretch of text
3128 to be killed.
3130 If the previous command was also a kill command,
3131 the text killed this time appends to the text killed last time
3132 to make one entry in the kill ring."
3133 ;; Pass point first, then mark, because the order matters
3134 ;; when calling kill-append.
3135 (interactive (list (point) (mark)))
3136 (unless (and beg end)
3137 (error "The mark is not set now, so there is no region"))
3138 (condition-case nil
3139 (let ((string (filter-buffer-substring beg end t)))
3140 (when string ;STRING is nil if BEG = END
3141 ;; Add that string to the kill ring, one way or another.
3142 (if (eq last-command 'kill-region)
3143 (kill-append string (< end beg) yank-handler)
3144 (kill-new string nil yank-handler)))
3145 (when (or string (eq last-command 'kill-region))
3146 (setq this-command 'kill-region))
3147 nil)
3148 ((buffer-read-only text-read-only)
3149 ;; The code above failed because the buffer, or some of the characters
3150 ;; in the region, are read-only.
3151 ;; We should beep, in case the user just isn't aware of this.
3152 ;; However, there's no harm in putting
3153 ;; the region's text in the kill ring, anyway.
3154 (copy-region-as-kill beg end)
3155 ;; Set this-command now, so it will be set even if we get an error.
3156 (setq this-command 'kill-region)
3157 ;; This should barf, if appropriate, and give us the correct error.
3158 (if kill-read-only-ok
3159 (progn (message "Read only text copied to kill ring") nil)
3160 ;; Signal an error if the buffer is read-only.
3161 (barf-if-buffer-read-only)
3162 ;; If the buffer isn't read-only, the text is.
3163 (signal 'text-read-only (list (current-buffer)))))))
3164 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3166 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3167 ;; to get two copies of the text when the user accidentally types M-w and
3168 ;; then corrects it with the intended C-w.
3169 (defun copy-region-as-kill (beg end)
3170 "Save the region as if killed, but don't kill it.
3171 In Transient Mark mode, deactivate the mark.
3172 If `interprogram-cut-function' is non-nil, also save the text for a window
3173 system cut and paste.
3175 This command's old key binding has been given to `kill-ring-save'."
3176 (interactive "r")
3177 (if (eq last-command 'kill-region)
3178 (kill-append (filter-buffer-substring beg end) (< end beg))
3179 (kill-new (filter-buffer-substring beg end)))
3180 (setq deactivate-mark t)
3181 nil)
3183 (defun kill-ring-save (beg end)
3184 "Save the region as if killed, but don't kill it.
3185 In Transient Mark mode, deactivate the mark.
3186 If `interprogram-cut-function' is non-nil, also save the text for a window
3187 system cut and paste.
3189 If you want to append the killed line to the last killed text,
3192 This command is similar to `copy-region-as-kill', except that it gives
3193 visual feedback indicating the extent of the region being copied."
3194 (interactive "r")
3195 (copy-region-as-kill beg end)
3196 ;; This use of called-interactively-p is correct
3197 ;; because the code it controls just gives the user visual feedback.
3198 (if (called-interactively-p 'interactive)
3199 (let ((other-end (if (= (point) beg) end beg))
3200 (opoint (point))
3201 ;; Inhibit quitting so we can make a quit here
3202 ;; look like a C-g typed as a command.
3203 (inhibit-quit t))
3204 (if (pos-visible-in-window-p other-end (selected-window))
3205 ;; Swap point-and-mark quickly so as to show the region that
3206 ;; was selected. Don't do it if the region is highlighted.
3207 (unless (and (region-active-p)
3208 (face-background 'region))
3209 ;; Swap point and mark.
3210 (set-marker (mark-marker) (point) (current-buffer))
3211 (goto-char other-end)
3212 (sit-for blink-matching-delay)
3213 ;; Swap back.
3214 (set-marker (mark-marker) other-end (current-buffer))
3215 (goto-char opoint)
3216 ;; If user quit, deactivate the mark
3217 ;; as C-g would as a command.
3218 (and quit-flag mark-active
3219 (deactivate-mark)))
3220 (let* ((killed-text (current-kill 0))
3221 (message-len (min (length killed-text) 40)))
3222 (if (= (point) beg)
3223 ;; Don't say "killed"; that is misleading.
3225 (substring killed-text (- message-len)))
3227 (substring killed-text 0 message-len))))))))
3229 (defun append-next-kill (&optional interactive)
3230 "Cause following command, if it kills, to append to previous kill.
3231 The argument is used for internal purposes; do not supply one."
3232 (interactive "p")
3233 ;; We don't use (interactive-p), since that breaks kbd macros.
3234 (if interactive
3235 (progn
3236 (setq this-command 'kill-region)
3237 (message "If the next command is a kill, it will append"))
3238 (setq last-command 'kill-region)))
3239 \f
3240 ;; Yanking.
3242 ;; This is actually used in subr.el but defcustom does not work there.
3243 (defcustom yank-excluded-properties
3244 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3245 yank-handler follow-link fontified)
3246 "Text properties to discard when yanking.
3247 The value should be a list of text properties to discard or t,
3248 which means to discard all text properties."
3249 :type '(choice (const :tag "All" t) (repeat symbol))
3250 :group 'killing
3251 :version "22.1")
3253 (defvar yank-window-start nil)
3254 (defvar yank-undo-function nil
3255 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3256 Function is called with two parameters, START and END corresponding to
3257 the value of the mark and point; it is guaranteed that START <= END.
3258 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3260 (defun yank-pop (&optional arg)
3261 "Replace just-yanked stretch of killed text with a different stretch.
3262 This command is allowed only immediately after a `yank' or a `yank-pop'.
3263 At such a time, the region contains a stretch of reinserted
3264 previously-killed text. `yank-pop' deletes that text and inserts in its
3265 place a different stretch of killed text.
3267 With no argument, the previous kill is inserted.
3268 With argument N, insert the Nth previous kill.
3269 If N is negative, this is a more recent kill.
3271 The sequence of kills wraps around, so that after the oldest one
3272 comes the newest one.
3274 When this command inserts killed text into the buffer, it honors
3275 `yank-excluded-properties' and `yank-handler' as described in the
3276 doc string for `insert-for-yank-1', which see."
3277 (interactive "*p")
3278 (if (not (eq last-command 'yank))
3279 (error "Previous command was not a yank"))
3280 (setq this-command 'yank)
3281 (unless arg (setq arg 1))
3282 (let ((inhibit-read-only t)
3283 (before (< (point) (mark t))))
3284 (if before
3285 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3286 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3287 (setq yank-undo-function nil)
3288 (set-marker (mark-marker) (point) (current-buffer))
3289 (insert-for-yank (current-kill arg))
3290 ;; Set the window start back where it was in the yank command,
3291 ;; if possible.
3292 (set-window-start (selected-window) yank-window-start t)
3293 (if before
3294 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3295 ;; It is cleaner to avoid activation, even though the command
3296 ;; loop would deactivate the mark because we inserted text.
3297 (goto-char (prog1 (mark t)
3298 (set-marker (mark-marker) (point) (current-buffer))))))
3299 nil)
3301 (defun yank (&optional arg)
3303 More precisely, reinsert the stretch of killed text most recently
3304 killed OR yanked. Put point at end, and set mark at beginning.
3305 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3306 With argument N, reinsert the Nth most recently killed stretch of killed
3307 text.
3309 When this command inserts killed text into the buffer, it honors
3310 `yank-excluded-properties' and `yank-handler' as described in the
3311 doc string for `insert-for-yank-1', which see.
3314 (interactive "*P")
3315 (setq yank-window-start (window-start))
3316 ;; If we don't get all the way thru, make last-command indicate that
3317 ;; for the following command.
3318 (setq this-command t)
3319 (push-mark (point))
3320 (insert-for-yank (current-kill (cond
3321 ((listp arg) 0)
3322 ((eq arg '-) -2)
3323 (t (1- arg)))))
3324 (if (consp arg)
3325 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3326 ;; It is cleaner to avoid activation, even though the command
3327 ;; loop would deactivate the mark because we inserted text.
3328 (goto-char (prog1 (mark t)
3329 (set-marker (mark-marker) (point) (current-buffer)))))
3330 ;; If we do get all the way thru, make this-command indicate that.
3331 (if (eq this-command t)
3332 (setq this-command 'yank))
3333 nil)
3335 (defun rotate-yank-pointer (arg)
3336 "Rotate the yanking point in the kill ring.
3337 With ARG, rotate that many kills forward (or backward, if negative)."
3338 (interactive "p")
3339 (current-kill arg))
3340 \f
3341 ;; Some kill commands.
3343 ;; Internal subroutine of delete-char
3344 (defun kill-forward-chars (arg)
3345 (if (listp arg) (setq arg (car arg)))
3346 (if (eq arg '-) (setq arg -1))
3347 (kill-region (point) (+ (point) arg)))
3349 ;; Internal subroutine of backward-delete-char
3350 (defun kill-backward-chars (arg)
3351 (if (listp arg) (setq arg (car arg)))
3352 (if (eq arg '-) (setq arg -1))
3353 (kill-region (point) (- (point) arg)))
3355 (defcustom backward-delete-char-untabify-method 'untabify
3356 "The method for untabifying when deleting backward.
3357 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3358 `hungry' -- delete all whitespace, both tabs and spaces;
3359 `all' -- delete all whitespace, including tabs, spaces and newlines;
3360 nil -- just delete one character."
3361 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3362 :version "20.3"
3363 :group 'killing)
3365 (defun backward-delete-char-untabify (arg &optional killp)
3366 "Delete characters backward, changing tabs into spaces.
3367 The exact behavior depends on `backward-delete-char-untabify-method'.
3368 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3369 Interactively, ARG is the prefix arg (default 1)
3370 and KILLP is t if a prefix arg was specified."
3372 (when (eq backward-delete-char-untabify-method 'untabify)
3373 (let ((count arg))
3374 (save-excursion
3375 (while (and (> count 0) (not (bobp)))
3377 (let ((col (current-column)))
3378 (forward-char -1)
3379 (setq col (- col (current-column)))
3380 (insert-char ?\s col)
3381 (delete-char 1)))
3382 (forward-char -1)
3383 (setq count (1- count))))))
3385 ((eq backward-delete-char-untabify-method 'all)
3387 (n (if skip
3388 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3389 (point)))))
3390 (+ arg (if (zerop wh) 0 (1- wh))))
3391 arg)))
3392 ;; Avoid warning about delete-backward-char
3393 (with-no-warnings (delete-backward-char n killp))))
3395 (defun zap-to-char (arg char)
3396 "Kill up to and including ARGth occurrence of CHAR.
3397 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3398 Goes backward if ARG is negative; error if CHAR not found."
3400 ;; Avoid "obsolete" warnings for translation-table-for-input.
3401 (with-no-warnings
3402 (if (char-table-p translation-table-for-input)
3403 (setq char (or (aref translation-table-for-input char) char))))
3404 (kill-region (point) (progn
3405 (search-forward (char-to-string char) nil nil arg)
3406 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3407 (point))))
3409 ;; kill-line and its subroutines.
3411 (defcustom kill-whole-line nil
3412 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3413 :type 'boolean
3414 :group 'killing)
3416 (defun kill-line (&optional arg)
3417 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3418 With prefix argument ARG, kill that many lines from point.
3419 Negative arguments kill lines backward.
3420 With zero argument, kills the text before point on the current line.
3423 a number counts as a prefix arg.
3425 To kill a whole line, when point is not at the beginning, type \
3428 If `kill-whole-line' is non-nil, then this command kills the whole line
3429 including its terminating newline, when used at the beginning of a line
3430 with no argument. As a consequence, you can always kill a whole line
3433 If you want to append the killed line to the last killed text,
3436 If the buffer is read-only, Emacs will beep and refrain from deleting
3437 the line, but put the line in the kill ring anyway. This means that
3438 you can use this command to copy text from a read-only buffer.
3439 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3440 even beep.)"
3441 (interactive "P")
3442 (kill-region (point)
3443 ;; It is better to move point to the other end of the kill
3444 ;; before killing. That way, in a read-only buffer, point
3445 ;; moves across the text that is copied to the kill ring.
3446 ;; The choice has no effect on undo now that undo records
3447 ;; the value of point from before the command was run.
3448 (progn
3449 (if arg
3450 (forward-visible-line (prefix-numeric-value arg))
3451 (if (eobp)
3452 (signal 'end-of-buffer nil))
3453 (let ((end
3454 (save-excursion
3455 (end-of-visible-line) (point))))
3456 (if (or (save-excursion
3457 ;; If trailing whitespace is visible,
3458 ;; don't treat it as nothing.
3459 (unless show-trailing-whitespace
3461 (= (point) end))
3462 (and kill-whole-line (bolp)))
3463 (forward-visible-line 1)
3464 (goto-char end))))
3465 (point))))
3467 (defun kill-whole-line (&optional arg)
3468 "Kill current line.
3469 With prefix ARG, kill that many lines starting from the current line.
3470 If ARG is negative, kill backward. Also kill the preceding newline.
3472 If ARG is zero, kill current line but exclude the trailing newline."
3473 (interactive "p")
3474 (or arg (setq arg 1))
3475 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3476 (signal 'end-of-buffer nil))
3477 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3478 (signal 'beginning-of-buffer nil))
3479 (unless (eq last-command 'kill-region)
3480 (kill-new "")
3481 (setq last-command 'kill-region))
3482 (cond ((zerop arg)
3483 ;; We need to kill in two steps, because the previous command
3484 ;; could have been a kill command, in which case the text
3485 ;; before point needs to be prepended to the current kill
3486 ;; ring entry and the text after point appended. Also, we
3487 ;; need to use save-excursion to avoid copying the same text
3488 ;; twice to the kill ring in read-only buffers.
3489 (save-excursion
3490 (kill-region (point) (progn (forward-visible-line 0) (point))))
3491 (kill-region (point) (progn (end-of-visible-line) (point))))
3492 ((< arg 0)
3493 (save-excursion
3494 (kill-region (point) (progn (end-of-visible-line) (point))))
3495 (kill-region (point)
3496 (progn (forward-visible-line (1+ arg))
3497 (unless (bobp) (backward-char))
3498 (point))))
3499 (t
3500 (save-excursion
3501 (kill-region (point) (progn (forward-visible-line 0) (point))))
3502 (kill-region (point)
3503 (progn (forward-visible-line arg) (point))))))
3505 (defun forward-visible-line (arg)
3506 "Move forward by ARG lines, ignoring currently invisible newlines only.
3507 If ARG is negative, move backward -ARG lines.
3508 If ARG is zero, move to the beginning of the current line."
3509 (condition-case nil
3510 (if (> arg 0)
3511 (progn
3512 (while (> arg 0)
3513 (or (zerop (forward-line 1))
3514 (signal 'end-of-buffer nil))
3515 ;; If the newline we just skipped is invisible,
3516 ;; don't count it.
3517 (let ((prop
3518 (get-char-property (1- (point)) 'invisible)))
3519 (if (if (eq buffer-invisibility-spec t)
3520 prop
3521 (or (memq prop buffer-invisibility-spec)
3522 (assq prop buffer-invisibility-spec)))
3523 (setq arg (1+ arg))))
3524 (setq arg (1- arg)))
3525 ;; If invisible text follows, and it is a number of complete lines,
3526 ;; skip it.
3527 (let ((opoint (point)))
3528 (while (and (not (eobp))
3529 (let ((prop
3530 (get-char-property (point) 'invisible)))
3531 (if (eq buffer-invisibility-spec t)
3532 prop
3533 (or (memq prop buffer-invisibility-spec)
3534 (assq prop buffer-invisibility-spec)))))
3535 (goto-char
3536 (if (get-text-property (point) 'invisible)
3537 (or (next-single-property-change (point) 'invisible)
3538 (point-max))
3539 (next-overlay-change (point)))))
3540 (unless (bolp)
3541 (goto-char opoint))))
3542 (let ((first t))
3543 (while (or first (<= arg 0))
3544 (if first
3545 (beginning-of-line)
3546 (or (zerop (forward-line -1))
3547 (signal 'beginning-of-buffer nil)))
3548 ;; If the newline we just moved to is invisible,
3549 ;; don't count it.
3550 (unless (bobp)
3551 (let ((prop
3552 (get-char-property (1- (point)) 'invisible)))
3553 (unless (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 first nil))
3559 ;; If invisible text follows, and it is a number of complete lines,
3560 ;; skip it.
3561 (let ((opoint (point)))
3562 (while (and (not (bobp))
3563 (let ((prop
3564 (get-char-property (1- (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 (1- (point)) 'invisible)
3571 (or (previous-single-property-change (point) 'invisible)
3572 (point-min))
3573 (previous-overlay-change (point)))))
3574 (unless (bolp)
3575 (goto-char opoint)))))
3576 ((beginning-of-buffer end-of-buffer)
3577 nil)))
3579 (defun end-of-visible-line ()
3580 "Move to end of current visible line."
3581 (end-of-line)
3582 ;; If the following character is currently invisible,
3583 ;; skip all characters with that same `invisible' property value,
3584 ;; then find the next newline.
3585 (while (and (not (eobp))
3586 (save-excursion
3588 (let ((prop
3589 (get-char-property (point) 'invisible)))
3590 (if (eq buffer-invisibility-spec t)
3591 prop
3592 (or (memq prop buffer-invisibility-spec)
3593 (assq prop buffer-invisibility-spec))))))
3595 (if (get-text-property (point) 'invisible)
3596 (goto-char (next-single-property-change (point) 'invisible))
3597 (goto-char (next-overlay-change (point))))
3598 (end-of-line)))
3599 \f
3600 (defun insert-buffer (buffer)
3601 "Insert after point the contents of BUFFER.
3602 Puts mark after the inserted text.
3603 BUFFER may be a buffer or a buffer name.
3605 This function is meant for the user to run interactively.
3606 Don't call it from programs: use `insert-buffer-substring' instead!"
3607 (interactive
3608 (list
3609 (progn
3610 (barf-if-buffer-read-only)
3611 (read-buffer "Insert buffer: "
3612 (if (eq (selected-window) (next-window (selected-window)))
3613 (other-buffer (current-buffer))
3614 (window-buffer (next-window (selected-window))))
3615 t))))
3616 (push-mark
3617 (save-excursion
3618 (insert-buffer-substring (get-buffer buffer))
3619 (point)))
3620 nil)
3622 (defun append-to-buffer (buffer start end)
3623 "Append to specified buffer the text of the region.
3624 It is inserted into that buffer before its point.
3626 When calling from a program, give three arguments:
3627 BUFFER (or buffer name), START and END.
3628 START and END specify the portion of the current buffer to be copied."
3629 (interactive
3630 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3631 (region-beginning) (region-end)))
3632 (let* ((oldbuf (current-buffer))
3633 (append-to (get-buffer-create buffer))
3634 (windows (get-buffer-window-list append-to t t))
3635 point)
3636 (save-excursion
3637 (with-current-buffer append-to
3638 (setq point (point))
3639 (barf-if-buffer-read-only)
3640 (insert-buffer-substring oldbuf start end)
3641 (dolist (window windows)
3642 (when (= (window-point window) point)
3643 (set-window-point window (point))))))))
3645 (defun prepend-to-buffer (buffer start end)
3646 "Prepend to specified buffer the text of the region.
3647 It is inserted into that buffer after its point.
3649 When calling from a program, give three arguments:
3650 BUFFER (or buffer name), START and END.
3651 START and END specify the portion of the current buffer to be copied."
3653 (let ((oldbuf (current-buffer)))
3654 (with-current-buffer (get-buffer-create buffer)
3655 (barf-if-buffer-read-only)
3656 (save-excursion
3657 (insert-buffer-substring oldbuf start end)))))
3659 (defun copy-to-buffer (buffer start end)
3660 "Copy to specified buffer the text of the region.
3661 It is inserted into that buffer, replacing existing text there.
3663 When calling from a program, give three arguments:
3664 BUFFER (or buffer name), START and END.
3665 START and END specify the portion of the current buffer to be copied."
3667 (let ((oldbuf (current-buffer)))
3668 (with-current-buffer (get-buffer-create buffer)
3669 (barf-if-buffer-read-only)
3670 (erase-buffer)
3671 (save-excursion
3672 (insert-buffer-substring oldbuf start end)))))
3673 \f
3674 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3675 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3677 (defvar activate-mark-hook nil
3678 "Hook run when the mark becomes active.
3679 It is also run at the end of a command, if the mark is active and
3680 it is possible that the region may have changed.")
3682 (defvar deactivate-mark-hook nil
3683 "Hook run when the mark becomes inactive.")
3685 (defun mark (&optional force)
3686 "Return this buffer's mark value as integer, or nil if never set.
3688 In Transient Mark mode, this function signals an error if
3689 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3690 or the argument FORCE is non-nil, it disregards whether the mark
3691 is active, and returns an integer or nil in the usual way.
3693 If you are using this in an editing command, you are most likely making
3694 a mistake; see the documentation of `set-mark'."
3695 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3696 (marker-position (mark-marker))
3697 (signal 'mark-inactive nil)))
3699 (defsubst deactivate-mark (&optional force)
3700 "Deactivate the mark by setting `mark-active' to nil.
3701 Unless FORCE is non-nil, this function does nothing if Transient
3702 Mark mode is disabled.
3703 This function also runs `deactivate-mark-hook'."
3704 (when (or transient-mark-mode force)
3705 (when (and (if (eq select-active-regions 'only)
3706 (eq (car-safe transient-mark-mode) 'only)
3707 select-active-regions)
3708 (region-active-p)
3709 (display-selections-p))
3710 ;; The var `saved-region-selection', if non-nil, is the text in
3711 ;; the region prior to the last command modifying the buffer.
3712 ;; Set the selection to that, or to the current region.
3713 (cond (saved-region-selection
3714 (x-set-selection 'PRIMARY saved-region-selection)
3715 (setq saved-region-selection nil))
3716 ((/= (region-beginning) (region-end))
3717 (x-set-selection 'PRIMARY
3718 (buffer-substring-no-properties
3719 (region-beginning)
3720 (region-end))))))
3721 (if (and (null force)
3722 (or (eq transient-mark-mode 'lambda)
3723 (and (eq (car-safe transient-mark-mode) 'only)
3724 (null (cdr transient-mark-mode)))))
3725 ;; When deactivating a temporary region, don't change
3726 ;; `mark-active' or run `deactivate-mark-hook'.
3727 (setq transient-mark-mode nil)
3728 (if (eq (car-safe transient-mark-mode) 'only)
3729 (setq transient-mark-mode (cdr transient-mark-mode)))
3730 (setq mark-active nil)
3731 (run-hooks 'deactivate-mark-hook))))
3733 (defun activate-mark ()
3734 "Activate the mark."
3735 (when (mark t)
3736 (setq mark-active t)
3737 (unless transient-mark-mode
3738 (setq transient-mark-mode 'lambda))))
3740 (defun set-mark (pos)
3741 "Set this buffer's mark to POS. Don't use this function!
3742 That is to say, don't use this function unless you want
3743 the user to see that the mark has moved, and you want the previous
3744 mark position to be lost.
3746 Normally, when a new mark is set, the old one should go on the stack.
3747 This is why most applications should use `push-mark', not `set-mark'.
3749 Novice Emacs Lisp programmers often try to use the mark for the wrong
3750 purposes. The mark saves a location for the user's convenience.
3751 Most editing commands should not alter the mark.
3752 To remember a location for internal use in the Lisp program,
3753 store it in a Lisp variable. Example:
3755 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3757 (if pos
3758 (progn
3759 (setq mark-active t)
3760 (run-hooks 'activate-mark-hook)
3761 (set-marker (mark-marker) pos (current-buffer)))
3762 ;; Normally we never clear mark-active except in Transient Mark mode.
3763 ;; But when we actually clear out the mark value too, we must
3764 ;; clear mark-active in any mode.
3765 (deactivate-mark t)
3766 (set-marker (mark-marker) nil)))
3768 (defcustom use-empty-active-region nil
3770 If nil, region-aware commands treat empty regions as inactive.
3771 If non-nil, region-aware commands treat the region as active as
3772 long as the mark is active, even if the region is empty.
3774 Region-aware commands are those that act on the region if it is
3775 active and Transient Mark mode is enabled, and on the text near
3776 point otherwise."
3777 :type 'boolean
3778 :version "23.1"
3779 :group 'editing-basics)
3781 (defun use-region-p ()
3782 "Return t if the region is active and it is appropriate to act on it.
3783 This is used by commands that act specially on the region under
3784 Transient Mark mode.
3786 The return value is t if Transient Mark mode is enabled and the
3787 mark is active; furthermore, if `use-empty-active-region' is nil,
3788 the region must not be empty. Otherwise, the return value is nil.
3790 For some commands, it may be appropriate to ignore the value of
3791 `use-empty-active-region'; in that case, use `region-active-p'."
3792 (and (region-active-p)
3793 (or use-empty-active-region (> (region-end) (region-beginning)))))
3795 (defun region-active-p ()
3796 "Return t if Transient Mark mode is enabled and the mark is active.
3798 Some commands act specially on the region when Transient Mark
3799 mode is enabled. Usually, such commands should use
3800 `use-region-p' instead of this function, because `use-region-p'
3801 also checks the value of `use-empty-active-region'."
3802 (and transient-mark-mode mark-active))
3804 (defvar mark-ring nil
3805 "The list of former marks of the current buffer, most recent first.")
3806 (make-variable-buffer-local 'mark-ring)
3807 (put 'mark-ring 'permanent-local t)
3809 (defcustom mark-ring-max 16
3810 "Maximum size of mark ring. Start discarding off end if gets this big."
3811 :type 'integer
3812 :group 'editing-basics)
3814 (defvar global-mark-ring nil
3815 "The list of saved global marks, most recent first.")
3817 (defcustom global-mark-ring-max 16
3818 "Maximum size of global mark ring. \
3819 Start discarding off end if gets this big."
3820 :type 'integer
3821 :group 'editing-basics)
3823 (defun pop-to-mark-command ()
3824 "Jump to mark, and pop a new position for mark off the ring.
3825 \(Does not affect global mark ring\)."
3826 (interactive)
3827 (if (null (mark t))
3828 (error "No mark set in this buffer")
3829 (if (= (point) (mark t))
3830 (message "Mark popped"))
3831 (goto-char (mark t))
3832 (pop-mark)))
3834 (defun push-mark-command (arg &optional nomsg)
3835 "Set mark at where point is.
3836 If no prefix ARG and mark is already set there, just activate it.
3837 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3838 (interactive "P")
3839 (let ((mark (marker-position (mark-marker))))
3840 (if (or arg (null mark) (/= mark (point)))
3841 (push-mark nil nomsg t)
3842 (setq mark-active t)
3843 (run-hooks 'activate-mark-hook)
3844 (unless nomsg
3845 (message "Mark activated")))))
3847 (defcustom set-mark-command-repeat-pop nil
3850 will pop the mark twice, and
3852 will pop the mark three times.
3856 :type 'boolean
3857 :group 'editing-basics)
3859 (defcustom set-mark-default-inactive nil
3860 "If non-nil, setting the mark does not activate it.
3862 behave the same whether or not `transient-mark-mode' is enabled."
3863 :type 'boolean
3864 :group 'editing-basics
3865 :version "23.1")
3867 (defun set-mark-command (arg)
3868 "Set the mark where point is, or jump to the mark.
3869 Setting the mark also alters the region, which is the text
3870 between point and mark; this is the closest equivalent in
3873 With no prefix argument, set the mark at point, and push the
3874 old mark position on local mark ring. Also push the old mark on
3875 global mark ring, if the previous mark was set in another buffer.
3877 When Transient Mark Mode is off, immediately repeating this
3878 command activates `transient-mark-mode' temporarily.
3881 jump to the mark, and set the mark from
3882 position popped off the local mark ring \(this does not affect the global
3884 mark ring \(see `pop-global-mark'\).
3886 If `set-mark-command-repeat-pop' is non-nil, repeating
3888 off the local (or global) mark ring and jumps there.
3891 argument, unconditionally set mark where point is, even if
3892 `set-mark-command-repeat-pop' is non-nil.
3894 Novice Emacs Lisp programmers often try to use the mark for the wrong
3895 purposes. See the documentation of `set-mark' for more information."
3896 (interactive "P")
3897 (cond ((eq transient-mark-mode 'lambda)
3898 (setq transient-mark-mode nil))
3899 ((eq (car-safe transient-mark-mode) 'only)
3900 (deactivate-mark)))
3901 (cond
3902 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3903 (push-mark-command nil))
3904 ((not (eq this-command 'set-mark-command))
3905 (if arg
3906 (pop-to-mark-command)
3907 (push-mark-command t)))
3908 ((and set-mark-command-repeat-pop
3909 (eq last-command 'pop-to-mark-command))
3910 (setq this-command 'pop-to-mark-command)
3911 (pop-to-mark-command))
3912 ((and set-mark-command-repeat-pop
3913 (eq last-command 'pop-global-mark)
3914 (not arg))
3915 (setq this-command 'pop-global-mark)
3916 (pop-global-mark))
3917 (arg
3918 (setq this-command 'pop-to-mark-command)
3919 (pop-to-mark-command))
3920 ((eq last-command 'set-mark-command)
3921 (if (region-active-p)
3922 (progn
3923 (deactivate-mark)
3924 (message "Mark deactivated"))
3925 (activate-mark)
3926 (message "Mark activated")))
3927 (t
3928 (push-mark-command nil)
3929 (if set-mark-default-inactive (deactivate-mark)))))
3931 (defun push-mark (&optional location nomsg activate)
3932 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3933 If the last global mark pushed was not in the current buffer,
3934 also push LOCATION on the global mark ring.
3935 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3937 Novice Emacs Lisp programmers often try to use the mark for the wrong
3938 purposes. See the documentation of `set-mark' for more information.
3940 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3941 (unless (null (mark t))
3942 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3943 (when (> (length mark-ring) mark-ring-max)
3944 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3945 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3946 (set-marker (mark-marker) (or location (point)) (current-buffer))
3947 ;; Now push the mark on the global mark ring.
3948 (if (and global-mark-ring
3949 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3950 ;; The last global mark pushed was in this same buffer.
3951 ;; Don't push another one.
3952 nil
3953 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3954 (when (> (length global-mark-ring) global-mark-ring-max)
3955 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3956 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3957 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3958 (message "Mark set"))
3959 (if (or activate (not transient-mark-mode))
3960 (set-mark (mark t)))
3961 nil)
3963 (defun pop-mark ()
3964 "Pop off mark ring into the buffer's actual mark.
3965 Does not set point. Does nothing if mark ring is empty."
3966 (when mark-ring
3967 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3968 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3969 (move-marker (car mark-ring) nil)
3970 (if (null (mark t)) (ding))
3971 (setq mark-ring (cdr mark-ring)))
3972 (deactivate-mark))
3974 (define-obsolete-function-alias
3975 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
3976 (defun exchange-point-and-mark (&optional arg)
3977 "Put the mark where point is now, and point where the mark is now.
3978 This command works even when the mark is not active,
3979 and it reactivates the mark.
3981 If Transient Mark mode is on, a prefix ARG deactivates the mark
3982 if it is active, and otherwise avoids reactivating it. If
3983 Transient Mark mode is off, a prefix ARG enables Transient Mark
3984 mode temporarily."
3985 (interactive "P")
3986 (let ((omark (mark t))
3987 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
3988 (if (null omark)
3989 (error "No mark set in this buffer"))
3990 (deactivate-mark)
3991 (set-mark (point))
3992 (goto-char omark)
3993 (if set-mark-default-inactive (deactivate-mark))
3994 (cond (temp-highlight
3995 (setq transient-mark-mode (cons 'only transient-mark-mode)))
3996 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
3997 (not (or arg (region-active-p))))
3998 (deactivate-mark))
3999 (t (activate-mark)))
4000 nil))
4002 (defcustom shift-select-mode t
4003 "When non-nil, shifted motion keys activate the mark momentarily.
4005 While the mark is activated in this way, any shift-translated point
4006 motion key extends the region, and if Transient Mark mode was off, it
4007 is temporarily turned on. Furthermore, the mark will be deactivated
4008 by any subsequent point motion key that was not shift-translated, or
4009 by any action that normally deactivates the mark in Transient Mark mode.
4011 See `this-command-keys-shift-translated' for the meaning of
4012 shift-translation."
4013 :type 'boolean
4014 :group 'editing-basics)
4016 (defun handle-shift-selection ()
4017 "Activate/deactivate mark depending on invocation thru shift translation.
4018 This function is called by `call-interactively' when a command
4019 with a `^' character in its `interactive' spec is invoked, before
4020 running the command itself.
4022 If `shift-select-mode' is enabled and the command was invoked
4023 through shift translation, set the mark and activate the region
4024 temporarily, unless it was already set in this way. See
4025 `this-command-keys-shift-translated' for the meaning of shift
4026 translation.
4028 Otherwise, if the region has been activated temporarily,
4029 deactivate it, and restore the variable `transient-mark-mode' to
4030 its earlier value."
4031 (cond ((and shift-select-mode this-command-keys-shift-translated)
4032 (unless (and mark-active
4033 (eq (car-safe transient-mark-mode) 'only))
4034 (setq transient-mark-mode
4035 (cons 'only
4036 (unless (eq transient-mark-mode 'lambda)
4037 transient-mark-mode)))
4038 (push-mark nil nil t)))
4039 ((eq (car-safe transient-mark-mode) 'only)
4040 (setq transient-mark-mode (cdr transient-mark-mode))
4041 (deactivate-mark))))
4043 (define-minor-mode transient-mark-mode
4044 "Toggle Transient Mark mode.
4045 With ARG, turn Transient Mark mode on if ARG is positive, off otherwise.
4047 In Transient Mark mode, when the mark is active, the region is highlighted.
4049 So do certain other operations that set the mark
4050 but whose main purpose is something else--for example,
4056 Many commands change their behavior when Transient Mark mode is in effect
4057 and the mark is active, by acting on the region instead of their usual
4058 default part of the buffer's text. Examples of such commands include
4063 commands which are sensitive to the Transient Mark mode."
4064 :global t
4065 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4066 :variable transient-mark-mode)
4068 (defvar widen-automatically t
4069 "Non-nil means it is ok for commands to call `widen' when they want to.
4070 Some commands will do this in order to go to positions outside
4071 the current accessible part of the buffer.
4073 If `widen-automatically' is nil, these commands will do something else
4074 as a fallback, and won't change the buffer bounds.")
4076 (defvar non-essential nil
4077 "Whether the currently executing code is performing an essential task.
4078 This variable should be non-nil only when running code which should not
4079 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4080 user for a password when we are simply scanning a set of files in the
4081 background or displaying possible completions before the user even asked
4082 for it.")
4084 (defun pop-global-mark ()
4085 "Pop off global mark ring and jump to the top location."
4086 (interactive)
4087 ;; Pop entries which refer to non-existent buffers.
4088 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4089 (setq global-mark-ring (cdr global-mark-ring)))
4090 (or global-mark-ring
4091 (error "No global mark set"))
4092 (let* ((marker (car global-mark-ring))
4093 (buffer (marker-buffer marker))
4094 (position (marker-position marker)))
4095 (setq global-mark-ring (nconc (cdr global-mark-ring)
4096 (list (car global-mark-ring))))
4097 (set-buffer buffer)
4098 (or (and (>= position (point-min))
4099 (<= position (point-max)))
4100 (if widen-automatically
4101 (widen)
4102 (error "Global mark position is outside accessible part of buffer")))
4103 (goto-char position)
4104 (switch-to-buffer buffer)))
4105 \f
4106 (defcustom next-line-add-newlines nil
4107 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4108 :type 'boolean
4109 :version "21.1"
4110 :group 'editing-basics)
4112 (defun next-line (&optional arg try-vscroll)
4113 "Move cursor vertically down ARG lines.
4114 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4115 If there is no character in the target line exactly under the current column,
4116 the cursor is positioned after the character in that line which spans this
4117 column, or at the end of the line if it is not long enough.
4118 If there is no line in the buffer after this one, behavior depends on the
4119 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4120 to create a line, and moves the cursor to that line. Otherwise it moves the
4121 cursor to the end of the buffer.
4123 If the variable `line-move-visual' is non-nil, this command moves
4124 by display lines. Otherwise, it moves by buffer lines, without
4125 taking variable-width characters or continued lines into account.
4128 a semipermanent goal column for this command.
4129 Then instead of trying to move exactly vertically (or as close as possible),
4130 this command moves to the specified goal column (or as close as possible).
4131 The goal column is stored in the variable `goal-column', which is nil
4132 when there is no goal column.
4134 If you are thinking of using this in a Lisp program, consider
4135 using `forward-line' instead. It is usually easier to use
4136 and more reliable (no dependence on goal column, etc.)."
4138 (or arg (setq arg 1))
4139 (if (and next-line-add-newlines (= arg 1))
4140 (if (save-excursion (end-of-line) (eobp))
4141 ;; When adding a newline, don't expand an abbrev.
4142 (let ((abbrev-mode nil))
4143 (end-of-line)
4145 (line-move arg nil nil try-vscroll))
4146 (if (called-interactively-p 'interactive)
4147 (condition-case err
4148 (line-move arg nil nil try-vscroll)
4149 ((beginning-of-buffer end-of-buffer)
4150 (signal (car err) (cdr err))))
4151 (line-move arg nil nil try-vscroll)))
4152 nil)
4154 (defun previous-line (&optional arg try-vscroll)
4155 "Move cursor vertically up ARG lines.
4156 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4157 If there is no character in the target line exactly over the current column,
4158 the cursor is positioned after the character in that line which spans this
4159 column, or at the end of the line if it is not long enough.
4161 If the variable `line-move-visual' is non-nil, this command moves
4162 by display lines. Otherwise, it moves by buffer lines, without
4163 taking variable-width characters or continued lines into account.
4166 a semipermanent goal column for this command.
4167 Then instead of trying to move exactly vertically (or as close as possible),
4168 this command moves to the specified goal column (or as close as possible).
4169 The goal column is stored in the variable `goal-column', which is nil
4170 when there is no goal column.
4172 If you are thinking of using this in a Lisp program, consider using
4173 `forward-line' with a negative argument instead. It is usually easier
4174 to use and more reliable (no dependence on goal column, etc.)."
4176 (or arg (setq arg 1))
4177 (if (called-interactively-p 'interactive)
4178 (condition-case err
4179 (line-move (- arg) nil nil try-vscroll)
4180 ((beginning-of-buffer end-of-buffer)
4181 (signal (car err) (cdr err))))
4182 (line-move (- arg) nil nil try-vscroll))
4183 nil)
4185 (defcustom track-eol nil
4186 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4187 This means moving to the end of each line moved onto.
4188 The beginning of a blank line does not count as the end of a line.
4189 This has no effect when `line-move-visual' is non-nil."
4190 :type 'boolean
4191 :group 'editing-basics)
4193 (defcustom goal-column nil
4195 :type '(choice integer
4196 (const :tag "None" nil))
4197 :group 'editing-basics)
4198 (make-variable-buffer-local 'goal-column)
4200 (defvar temporary-goal-column 0
4201 "Current goal column for vertical motion.
4202 It is the column where point was at the start of the current run
4203 of vertical motion commands.
4205 When moving by visual lines via `line-move-visual', it is a cons
4206 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4207 divided by the default column width, and HSCROLL is the number of
4208 columns by which window is scrolled from left margin.
4210 When the `track-eol' feature is doing its job, the value is
4211 `most-positive-fixnum'.")
4213 (defcustom line-move-ignore-invisible t
4215 Outline mode sets this."
4216 :type 'boolean
4217 :group 'editing-basics)
4219 (defcustom line-move-visual t
4220 "When non-nil, `line-move' moves point by visual lines.
4221 This movement is based on where the cursor is displayed on the
4222 screen, instead of relying on buffer contents alone. It takes
4223 into account variable-width characters and line continuation.
4224 If nil, `line-move' moves point by logical lines."
4225 :type 'boolean
4226 :group 'editing-basics
4227 :version "23.1")
4229 ;; Returns non-nil if partial move was done.
4230 (defun line-move-partial (arg noerror to-end)
4231 (if (< arg 0)
4232 ;; Move backward (up).
4233 ;; If already vscrolled, reduce vscroll
4234 (let ((vs (window-vscroll nil t)))
4235 (when (> vs (frame-char-height))
4236 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4238 ;; Move forward (down).
4239 (let* ((lh (window-line-height -1))
4240 (vpos (nth 1 lh))
4241 (ypos (nth 2 lh))
4242 (rbot (nth 3 lh))
4243 py vs)
4244 (when (or (null lh)
4245 (>= rbot (frame-char-height))
4246 (<= ypos (- (frame-char-height))))
4247 (unless lh
4248 (let ((wend (pos-visible-in-window-p t nil t)))
4249 (setq rbot (nth 3 wend)
4250 vpos (nth 5 wend))))
4251 (cond
4252 ;; If last line of window is fully visible, move forward.
4253 ((or (null rbot) (= rbot 0))
4254 nil)
4255 ;; If cursor is not in the bottom scroll margin, move forward.
4256 ((and (> vpos 0)
4257 (< (setq py
4258 (or (nth 1 (window-line-height))
4259 (let ((ppos (posn-at-point)))
4260 (cdr (or (posn-actual-col-row ppos)
4261 (posn-col-row ppos))))))
4262 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4263 nil)
4264 ;; When already vscrolled, we vscroll some more if we can,
4265 ;; or clear vscroll and move forward at end of tall image.
4266 ((> (setq vs (window-vscroll nil t)) 0)
4267 (when (> rbot 0)
4268 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4269 ;; If cursor just entered the bottom scroll margin, move forward,
4270 ;; but also vscroll one line so redisplay wont recenter.
4271 ((and (> vpos 0)
4272 (= py (min (- (window-text-height) scroll-margin 1)
4273 (1- vpos))))
4274 (set-window-vscroll nil (frame-char-height) t)
4275 (line-move-1 arg noerror to-end)
4276 t)
4277 ;; If there are lines above the last line, scroll-up one line.
4278 ((> vpos 0)
4279 (scroll-up 1)
4280 t)
4281 ;; Finally, start vscroll.
4282 (t
4283 (set-window-vscroll nil (frame-char-height) t)))))))
4286 ;; This is like line-move-1 except that it also performs
4287 ;; vertical scrolling of tall images if appropriate.
4288 ;; That is not really a clean thing to do, since it mixes
4289 ;; scrolling with cursor motion. But so far we don't have
4290 ;; a cleaner solution to the problem of making C-n do something
4291 ;; useful given a tall image.
4292 (defun line-move (arg &optional noerror to-end try-vscroll)
4293 (unless (and auto-window-vscroll try-vscroll
4294 ;; Only vscroll for single line moves
4295 (= (abs arg) 1)
4296 ;; But don't vscroll in a keyboard macro.
4297 (not defining-kbd-macro)
4298 (not executing-kbd-macro)
4299 (line-move-partial arg noerror to-end))
4300 (set-window-vscroll nil 0 t)
4301 (if line-move-visual
4302 (line-move-visual arg noerror)
4303 (line-move-1 arg noerror to-end))))
4305 ;; Display-based alternative to line-move-1.
4306 ;; Arg says how many lines to move. The value is t if we can move the
4307 ;; specified number of lines.
4308 (defun line-move-visual (arg &optional noerror)
4309 (let ((opoint (point))
4310 (hscroll (window-hscroll))
4311 target-hscroll)
4312 ;; Check if the previous command was a line-motion command, or if
4313 ;; we were called from some other command.
4314 (if (and (consp temporary-goal-column)
4315 (memq last-command `(next-line previous-line ,this-command)))
4316 ;; If so, there's no need to reset `temporary-goal-column',
4317 ;; but we may need to hscroll.
4318 (if (or (/= (cdr temporary-goal-column) hscroll)
4319 (> (cdr temporary-goal-column) 0))
4320 (setq target-hscroll (cdr temporary-goal-column)))
4321 ;; Otherwise, we should reset `temporary-goal-column'.
4322 (let ((posn (posn-at-point)))
4323 (cond
4324 ;; Handle the `overflow-newline-into-fringe' case:
4325 ((eq (nth 1 posn) 'right-fringe)
4326 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4327 ((car (posn-x-y posn))
4328 (setq temporary-goal-column
4329 (cons (/ (float (car (posn-x-y posn)))
4330 (frame-char-width)) hscroll))))))
4331 (if target-hscroll
4332 (set-window-hscroll (selected-window) target-hscroll))
4333 (or (and (= (vertical-motion
4334 (cons (or goal-column
4335 (if (consp temporary-goal-column)
4336 (car temporary-goal-column)
4337 temporary-goal-column))
4338 arg))
4339 arg)
4340 (or (>= arg 0)
4341 (/= (point) opoint)
4342 ;; If the goal column lies on a display string,
4343 ;; `vertical-motion' advances the cursor to the end
4344 ;; of the string. For arg < 0, this can cause the
4345 ;; cursor to get stuck. (Bug#3020).
4346 (= (vertical-motion arg) arg)))
4347 (unless noerror
4348 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4349 nil)))))
4351 ;; This is the guts of next-line and previous-line.
4352 ;; Arg says how many lines to move.
4353 ;; The value is t if we can move the specified number of lines.
4354 (defun line-move-1 (arg &optional noerror _to-end)
4355 ;; Don't run any point-motion hooks, and disregard intangibility,
4356 ;; for intermediate positions.
4357 (let ((inhibit-point-motion-hooks t)
4358 (opoint (point))
4359 (orig-arg arg))
4360 (if (consp temporary-goal-column)
4361 (setq temporary-goal-column (+ (car temporary-goal-column)
4362 (cdr temporary-goal-column))))
4363 (unwind-protect
4364 (progn
4365 (if (not (memq last-command '(next-line previous-line)))
4366 (setq temporary-goal-column
4367 (if (and track-eol (eolp)
4368 ;; Don't count beg of empty line as end of line
4369 ;; unless we just did explicit end-of-line.
4370 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4371 most-positive-fixnum
4372 (current-column))))
4374 (if (not (or (integerp selective-display)
4375 line-move-ignore-invisible))
4376 ;; Use just newline characters.
4377 ;; Set ARG to 0 if we move as many lines as requested.
4378 (or (if (> arg 0)
4379 (progn (if (> arg 1) (forward-line (1- arg)))
4380 ;; This way of moving forward ARG lines
4381 ;; verifies that we have a newline after the last one.
4382 ;; It doesn't get confused by intangible text.
4383 (end-of-line)
4384 (if (zerop (forward-line 1))
4385 (setq arg 0)))
4386 (and (zerop (forward-line arg))
4387 (bolp)
4388 (setq arg 0)))
4389 (unless noerror
4390 (signal (if (< arg 0)
4391 'beginning-of-buffer
4392 'end-of-buffer)
4393 nil)))
4394 ;; Move by arg lines, but ignore invisible ones.
4395 (let (done)
4396 (while (and (> arg 0) (not done))
4397 ;; If the following character is currently invisible,
4398 ;; skip all characters with that same `invisible' property value.
4399 (while (and (not (eobp)) (invisible-p (point)))
4400 (goto-char (next-char-property-change (point))))
4401 ;; Move a line.
4402 ;; We don't use `end-of-line', since we want to escape
4403 ;; from field boundaries occurring exactly at point.
4404 (goto-char (constrain-to-field
4405 (let ((inhibit-field-text-motion t))
4406 (line-end-position))
4407 (point) t t
4408 'inhibit-line-move-field-capture))
4409 ;; If there's no invisibility here, move over the newline.
4410 (cond
4411 ((eobp)
4412 (if (not noerror)
4413 (signal 'end-of-buffer nil)
4414 (setq done t)))
4415 ((and (> arg 1) ;; Use vertical-motion for last move
4416 (not (integerp selective-display))
4417 (not (invisible-p (point))))
4418 ;; We avoid vertical-motion when possible
4419 ;; because that has to fontify.
4420 (forward-line 1))
4421 ;; Otherwise move a more sophisticated way.
4422 ((zerop (vertical-motion 1))
4423 (if (not noerror)
4424 (signal 'end-of-buffer nil)
4425 (setq done t))))
4426 (unless done
4427 (setq arg (1- arg))))
4428 ;; The logic of this is the same as the loop above,
4429 ;; it just goes in the other direction.
4430 (while (and (< arg 0) (not done))
4431 ;; For completely consistency with the forward-motion
4432 ;; case, we should call beginning-of-line here.
4433 ;; However, if point is inside a field and on a
4434 ;; continued line, the call to (vertical-motion -1)
4435 ;; below won't move us back far enough; then we return
4436 ;; to the same column in line-move-finish, and point
4437 ;; gets stuck -- cyd
4438 (forward-line 0)
4439 (cond
4440 ((bobp)
4441 (if (not noerror)
4442 (signal 'beginning-of-buffer nil)
4443 (setq done t)))
4444 ((and (< arg -1) ;; Use vertical-motion for last move
4445 (not (integerp selective-display))
4446 (not (invisible-p (1- (point)))))
4447 (forward-line -1))
4448 ((zerop (vertical-motion -1))
4449 (if (not noerror)
4450 (signal 'beginning-of-buffer nil)
4451 (setq done t))))
4452 (unless done
4453 (setq arg (1+ arg))
4454 (while (and ;; Don't move over previous invis lines
4455 ;; if our target is the middle of this line.
4456 (or (zerop (or goal-column temporary-goal-column))
4457 (< arg 0))
4458 (not (bobp)) (invisible-p (1- (point))))
4459 (goto-char (previous-char-property-change (point))))))))
4460 ;; This is the value the function returns.
4461 (= arg 0))
4463 (cond ((> arg 0)
4464 ;; If we did not move down as far as desired, at least go
4465 ;; to end of line. Be sure to call point-entered and
4466 ;; point-left-hooks.
4467 (let* ((npoint (prog1 (line-end-position)
4468 (goto-char opoint)))
4469 (inhibit-point-motion-hooks nil))
4470 (goto-char npoint)))
4471 ((< arg 0)
4472 ;; If we did not move up as far as desired,
4473 ;; at least go to beginning of line.
4474 (let* ((npoint (prog1 (line-beginning-position)
4475 (goto-char opoint)))
4476 (inhibit-point-motion-hooks nil))
4477 (goto-char npoint)))
4478 (t
4479 (line-move-finish (or goal-column temporary-goal-column)
4480 opoint (> orig-arg 0)))))))
4482 (defun line-move-finish (column opoint forward)
4483 (let ((repeat t))
4484 (while repeat
4485 ;; Set REPEAT to t to repeat the whole thing.
4486 (setq repeat nil)
4488 (let (new
4489 (old (point))
4490 (line-beg (line-beginning-position))
4491 (line-end
4492 ;; Compute the end of the line
4493 ;; ignoring effectively invisible newlines.
4494 (save-excursion
4495 ;; Like end-of-line but ignores fields.
4497 (while (and (not (eobp)) (invisible-p (point)))
4498 (goto-char (next-char-property-change (point)))
4500 (point))))
4502 ;; Move to the desired column.
4503 (line-move-to-column (truncate column))
4505 ;; Corner case: suppose we start out in a field boundary in
4506 ;; the middle of a continued line. When we get to
4507 ;; line-move-finish, point is at the start of a new *screen*
4508 ;; line but the same text line; then line-move-to-column would
4509 ;; move us backwards. Test using C-n with point on the "x" in
4510 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4511 (and forward
4512 (< (point) old)
4513 (goto-char old))
4515 (setq new (point))
4517 ;; Process intangibility within a line.
4518 ;; With inhibit-point-motion-hooks bound to nil, a call to
4519 ;; goto-char moves point past intangible text.
4521 ;; However, inhibit-point-motion-hooks controls both the
4522 ;; intangibility and the point-entered/point-left hooks. The
4523 ;; following hack avoids calling the point-* hooks
4524 ;; unnecessarily. Note that we move *forward* past intangible
4525 ;; text when the initial and final points are the same.
4526 (goto-char new)
4527 (let ((inhibit-point-motion-hooks nil))
4528 (goto-char new)
4530 ;; If intangibility moves us to a different (later) place
4531 ;; in the same line, use that as the destination.
4532 (if (<= (point) line-end)
4533 (setq new (point))
4534 ;; If that position is "too late",
4535 ;; try the previous allowable position.
4536 ;; See if it is ok.
4537 (backward-char)
4538 (if (if forward
4539 ;; If going forward, don't accept the previous
4540 ;; allowable position if it is before the target line.
4541 (< line-beg (point))
4542 ;; If going backward, don't accept the previous
4543 ;; allowable position if it is still after the target line.
4544 (<= (point) line-end))
4545 (setq new (point))
4546 ;; As a last resort, use the end of the line.
4547 (setq new line-end))))
4549 ;; Now move to the updated destination, processing fields
4550 ;; as well as intangibility.
4551 (goto-char opoint)
4552 (let ((inhibit-point-motion-hooks nil))
4553 (goto-char
4554 ;; Ignore field boundaries if the initial and final
4555 ;; positions have the same `field' property, even if the
4556 ;; fields are non-contiguous. This seems to be "nicer"
4557 ;; behavior in many situations.
4558 (if (eq (get-char-property new 'field)
4559 (get-char-property opoint 'field))
4560 new
4561 (constrain-to-field new opoint t t
4562 'inhibit-line-move-field-capture))))
4564 ;; If all this moved us to a different line,
4565 ;; retry everything within that new line.
4566 (when (or (< (point) line-beg) (> (point) line-end))
4567 ;; Repeat the intangibility and field processing.
4568 (setq repeat t))))))
4570 (defun line-move-to-column (col)
4571 "Try to find column COL, considering invisibility.
4572 This function works only in certain cases,
4573 because what we really need is for `move-to-column'
4574 and `current-column' to be able to ignore invisible text."
4575 (if (zerop col)
4576 (beginning-of-line)
4577 (move-to-column col))
4579 (when (and line-move-ignore-invisible
4580 (not (bolp)) (invisible-p (1- (point))))
4581 (let ((normal-location (point))
4582 (normal-column (current-column)))
4583 ;; If the following character is currently invisible,
4584 ;; skip all characters with that same `invisible' property value.
4585 (while (and (not (eobp))
4586 (invisible-p (point)))
4587 (goto-char (next-char-property-change (point))))
4588 ;; Have we advanced to a larger column position?
4589 (if (> (current-column) normal-column)
4590 ;; We have made some progress towards the desired column.
4591 ;; See if we can make any further progress.
4592 (line-move-to-column (+ (current-column) (- col normal-column)))
4593 ;; Otherwise, go to the place we originally found
4594 ;; and move back over invisible text.
4595 ;; that will get us to the same place on the screen
4596 ;; but with a more reasonable buffer position.
4597 (goto-char normal-location)
4598 (let ((line-beg (line-beginning-position)))
4599 (while (and (not (bolp)) (invisible-p (1- (point))))
4600 (goto-char (previous-char-property-change (point) line-beg))))))))
4602 (defun move-end-of-line (arg)
4603 "Move point to end of current line as displayed.
4604 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4605 If point reaches the beginning or end of buffer, it stops there.
4607 To ignore the effects of the `intangible' text or overlay
4608 property, bind `inhibit-point-motion-hooks' to t.
4609 If there is an image in the current line, this function
4610 disregards newlines that are part of the text on which the image
4611 rests."
4612 (interactive "^p")
4613 (or arg (setq arg 1))
4614 (let (done)
4615 (while (not done)
4616 (let ((newpos
4617 (save-excursion
4618 (let ((goal-column 0)
4619 (line-move-visual nil))
4620 (and (line-move arg t)
4621 ;; With bidi reordering, we may not be at bol,
4622 ;; so make sure we are.
4624 (not (bobp))
4625 (progn
4626 (while (and (not (bobp)) (invisible-p (1- (point))))
4627 (goto-char (previous-single-char-property-change
4628 (point) 'invisible)))
4629 (backward-char 1)))
4630 (point)))))
4631 (goto-char newpos)
4632 (if (and (> (point) newpos)
4634 (backward-char 1)
4635 (if (and (> (point) newpos) (not (eobp))
4637 ;; If we skipped something intangible and now we're not
4638 ;; really at eol, keep going.
4639 (setq arg 1)
4640 (setq done t)))))))
4642 (defun move-beginning-of-line (arg)
4643 "Move point to beginning of current line as displayed.
4644 \(If there's an image in the line, this disregards newlines
4645 which are part of the text that the image rests on.)
4647 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4648 If point reaches the beginning or end of buffer, it stops there.
4649 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4650 (interactive "^p")
4651 (or arg (setq arg 1))
4653 (let ((orig (point))
4654 first-vis first-vis-field-value)
4656 ;; Move by lines, if ARG is not 1 (the default).
4657 (if (/= arg 1)
4658 (let ((line-move-visual nil))
4659 (line-move (1- arg) t)))
4661 ;; Move to beginning-of-line, ignoring fields and invisibles.
4663 (while (and (not (bobp)) (invisible-p (1- (point))))
4664 (goto-char (previous-char-property-change (point)))
4667 ;; Now find first visible char in the line
4668 (while (and (not (eobp)) (invisible-p (point)))
4669 (goto-char (next-char-property-change (point))))
4670 (setq first-vis (point))
4672 ;; See if fields would stop us from reaching FIRST-VIS.
4673 (setq first-vis-field-value
4674 (constrain-to-field first-vis orig (/= arg 1) t nil))
4676 (goto-char (if (/= first-vis-field-value first-vis)
4677 ;; If yes, obey them.
4678 first-vis-field-value
4679 ;; Otherwise, move to START with attention to fields.
4680 ;; (It is possible that fields never matter in this case.)
4681 (constrain-to-field (point) orig
4682 (/= arg 1) t nil)))))
4685 ;; Many people have said they rarely use this feature, and often type
4686 ;; it by accident. Maybe it shouldn't even be on a key.
4687 (put 'set-goal-column 'disabled t)
4689 (defun set-goal-column (arg)
4691 Those commands will move to this position in the line moved to
4692 rather than trying to keep the same horizontal position.
4693 With a non-nil argument ARG, clears out the goal column
4695 The goal column is stored in the variable `goal-column'."
4696 (interactive "P")
4697 (if arg
4698 (progn
4699 (setq goal-column nil)
4700 (message "No goal column"))
4701 (setq goal-column (current-column))
4702 ;; The older method below can be erroneous if `set-goal-column' is bound
4703 ;; to a sequence containing %
4704 ;;(message (substitute-command-keys
4706 ;;goal-column)
4707 (message "%s"
4708 (concat
4709 (format "Goal column %d " goal-column)
4710 (substitute-command-keys
4713 )
4714 nil)
4715 \f
4716 ;;; Editing based on visual lines, as opposed to logical lines.
4718 (defun end-of-visual-line (&optional n)
4719 "Move point to end of current visual line.
4720 With argument N not nil or 1, move forward N - 1 visual lines first.
4721 If point reaches the beginning or end of buffer, it stops there.
4722 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4723 (interactive "^p")
4724 (or n (setq n 1))
4725 (if (/= n 1)
4726 (let ((line-move-visual t))
4727 (line-move (1- n) t)))
4728 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4729 ;; constrain to field boundaries, so we don't either.
4730 (vertical-motion (cons (window-width) 0)))
4732 (defun beginning-of-visual-line (&optional n)
4733 "Move point to beginning of current visual line.
4734 With argument N not nil or 1, move forward N - 1 visual lines first.
4735 If point reaches the beginning or end of buffer, it stops there.
4736 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4737 (interactive "^p")
4738 (or n (setq n 1))
4739 (let ((opoint (point)))
4740 (if (/= n 1)
4741 (let ((line-move-visual t))
4742 (line-move (1- n) t)))
4743 (vertical-motion 0)
4744 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4745 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4747 (defun kill-visual-line (&optional arg)
4748 "Kill the rest of the visual line.
4749 With prefix argument ARG, kill that many visual lines from point.
4750 If ARG is negative, kill visual lines backward.
4751 If ARG is zero, kill the text before point on the current visual
4752 line.
4754 If you want to append the killed line to the last killed text,
4757 If the buffer is read-only, Emacs will beep and refrain from deleting
4758 the line, but put the line in the kill ring anyway. This means that
4759 you can use this command to copy text from a read-only buffer.
4760 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4761 even beep.)"
4762 (interactive "P")
4763 ;; Like in `kill-line', it's better to move point to the other end
4764 ;; of the kill before killing.
4765 (let ((opoint (point))
4766 (kill-whole-line (and kill-whole-line (bolp))))
4767 (if arg
4768 (vertical-motion (prefix-numeric-value arg))
4769 (end-of-visual-line 1)
4770 (if (= (point) opoint)
4771 (vertical-motion 1)
4772 ;; Skip any trailing whitespace at the end of the visual line.
4773 ;; We used to do this only if `show-trailing-whitespace' is
4774 ;; nil, but that's wrong; the correct thing would be to check
4775 ;; whether the trailing whitespace is highlighted. But, it's
4776 ;; OK to just do this unconditionally.
4779 (1+ (point))
4780 (point)))))
4782 (defun next-logical-line (&optional arg try-vscroll)
4783 "Move cursor vertically down ARG lines.
4784 This is identical to `next-line', except that it always moves
4785 by logical lines instead of visual lines, ignoring the value of
4786 the variable `line-move-visual'."
4788 (let ((line-move-visual nil))
4789 (with-no-warnings
4790 (next-line arg try-vscroll))))
4792 (defun previous-logical-line (&optional arg try-vscroll)
4793 "Move cursor vertically up ARG lines.
4794 This is identical to `previous-line', except that it always moves
4795 by logical lines instead of visual lines, ignoring the value of
4796 the variable `line-move-visual'."
4798 (let ((line-move-visual nil))
4799 (with-no-warnings
4800 (previous-line arg try-vscroll))))
4802 (defgroup visual-line nil
4803 "Editing based on visual lines."
4804 :group 'convenience
4805 :version "23.1")
4807 (defvar visual-line-mode-map
4808 (let ((map (make-sparse-keymap)))
4809 (define-key map [remap kill-line] 'kill-visual-line)
4810 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4811 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4812 ;; These keybindings interfere with xterm function keys. Are
4813 ;; there any other suitable bindings?
4814 ;; (define-key map "\M-[" 'previous-logical-line)
4815 ;; (define-key map "\M-]" 'next-logical-line)
4816 map))
4818 (defcustom visual-line-fringe-indicators '(nil nil)
4819 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4820 The value should be a list of the form (LEFT RIGHT), where LEFT
4821 and RIGHT are symbols representing the bitmaps to display, to
4822 indicate wrapped lines, in the left and right fringes respectively.
4823 See also `fringe-indicator-alist'.
4824 The default is not to display fringe indicators for wrapped lines.
4825 This variable does not affect fringe indicators displayed for
4826 other purposes."
4827 :type '(list (choice (const :tag "Hide left indicator" nil)
4828 (const :tag "Left curly arrow" left-curly-arrow)
4829 (symbol :tag "Other bitmap"))
4830 (choice (const :tag "Hide right indicator" nil)
4831 (const :tag "Right curly arrow" right-curly-arrow)
4832 (symbol :tag "Other bitmap")))
4833 :set (lambda (symbol value)
4834 (dolist (buf (buffer-list))
4835 (with-current-buffer buf
4836 (when (and (boundp 'visual-line-mode)
4837 (symbol-value 'visual-line-mode))
4838 (setq fringe-indicator-alist
4839 (cons (cons 'continuation value)
4840 (assq-delete-all
4841 'continuation
4842 (copy-tree fringe-indicator-alist)))))))
4843 (set-default symbol value)))
4845 (defvar visual-line--saved-state nil)
4847 (define-minor-mode visual-line-mode
4848 "Redefine simple editing commands to act on visual lines, not logical lines.
4849 This also turns on `word-wrap' in the buffer."
4850 :keymap visual-line-mode-map
4851 :group 'visual-line
4852 :lighter " Wrap"
4853 (if visual-line-mode
4854 (progn
4855 (set (make-local-variable 'visual-line--saved-state) nil)
4856 ;; Save the local values of some variables, to be restored if
4857 ;; visual-line-mode is turned off.
4858 (dolist (var '(line-move-visual truncate-lines
4859 truncate-partial-width-windows
4860 word-wrap fringe-indicator-alist))
4861 (if (local-variable-p var)
4862 (push (cons var (symbol-value var))
4863 visual-line--saved-state)))
4864 (set (make-local-variable 'line-move-visual) t)
4865 (set (make-local-variable 'truncate-partial-width-windows) nil)
4866 (setq truncate-lines nil
4867 word-wrap t
4868 fringe-indicator-alist
4869 (cons (cons 'continuation visual-line-fringe-indicators)
4870 fringe-indicator-alist)))
4871 (kill-local-variable 'line-move-visual)
4872 (kill-local-variable 'word-wrap)
4873 (kill-local-variable 'truncate-lines)
4874 (kill-local-variable 'truncate-partial-width-windows)
4875 (kill-local-variable 'fringe-indicator-alist)
4876 (dolist (saved visual-line--saved-state)
4877 (set (make-local-variable (car saved)) (cdr saved)))
4878 (kill-local-variable 'visual-line--saved-state)))
4880 (defun turn-on-visual-line-mode ()
4881 (visual-line-mode 1))
4883 (define-globalized-minor-mode global-visual-line-mode
4884 visual-line-mode turn-on-visual-line-mode
4885 :lighter " vl")
4887 \f
4888 (defun transpose-chars (arg)
4889 "Interchange characters around point, moving forward one character.
4890 With prefix arg ARG, effect is to take character before point
4891 and drag it forward past ARG other characters (backward if ARG negative).
4892 If no argument and at end of line, the previous two chars are exchanged."
4893 (interactive "*P")
4894 (and (null arg) (eolp) (forward-char -1))
4895 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4897 (defun transpose-words (arg)
4898 "Interchange words around point, leaving point at end of them.
4899 With prefix arg ARG, effect is to take word before or around point
4900 and drag it forward past ARG other words (backward if ARG negative).
4901 If ARG is zero, the words around or after point and around or after mark
4902 are interchanged."
4903 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4904 (interactive "*p")
4905 (transpose-subr 'forward-word arg))
4907 (defun transpose-sexps (arg)
4909 Does not work on a sexp that point is in the middle of
4910 if it is a list or string."
4911 (interactive "*p")
4912 (transpose-subr
4913 (lambda (arg)
4914 ;; Here we should try to simulate the behavior of
4915 ;; (cons (progn (forward-sexp x) (point))
4916 ;; (progn (forward-sexp (- x)) (point)))
4917 ;; Except that we don't want to rely on the second forward-sexp
4918 ;; putting us back to where we want to be, since forward-sexp-function
4919 ;; might do funny things like infix-precedence.
4920 (if (if (> arg 0)
4922 (and (not (bobp))
4924 ;; Jumping over a symbol. We might be inside it, mind you.
4925 (progn (funcall (if (> arg 0)
4926 'skip-syntax-backward 'skip-syntax-forward)
4927 "w_")
4928 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4929 ;; Otherwise, we're between sexps. Take a step back before jumping
4930 ;; to make sure we'll obey the same precedence no matter which direction
4931 ;; we're going.
4932 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4933 (cons (save-excursion (forward-sexp arg) (point))
4934 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4935 (not (zerop (funcall (if (> arg 0)
4936 'skip-syntax-forward
4937 'skip-syntax-backward)
4938 ".")))))
4939 (point)))))
4940 arg 'special))
4942 (defun transpose-lines (arg)
4943 "Exchange current line and previous line, leaving point after both.
4944 With argument ARG, takes previous line and moves it past ARG lines.
4945 With argument 0, interchanges line point is in with line mark is in."
4946 (interactive "*p")
4947 (transpose-subr (function
4948 (lambda (arg)
4949 (if (> arg 0)
4950 (progn
4951 ;; Move forward over ARG lines,
4952 ;; but create newlines if necessary.
4953 (setq arg (forward-line arg))
4955 (setq arg (1+ arg)))
4956 (if (> arg 0)
4957 (newline arg)))
4958 (forward-line arg))))
4959 arg))
4961 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
4962 ;; which seems inconsistent with the ARG /= 0 case.
4963 ;; FIXME document SPECIAL.
4964 (defun transpose-subr (mover arg &optional special)
4965 "Subroutine to do the work of transposing objects.
4966 Works for lines, sentences, paragraphs, etc. MOVER is a function that
4967 moves forward by units of the given object (e.g. forward-sentence,
4968 forward-paragraph). If ARG is zero, exchanges the current object
4969 with the one containing mark. If ARG is an integer, moves the
4970 current object past ARG following (if ARG is positive) or
4971 preceding (if ARG is negative) objects, leaving point after the
4972 current object."
4973 (let ((aux (if special mover
4974 (lambda (x)
4975 (cons (progn (funcall mover x) (point))
4976 (progn (funcall mover (- x)) (point))))))
4977 pos1 pos2)
4978 (cond
4979 ((= arg 0)
4980 (save-excursion
4981 (setq pos1 (funcall aux 1))
4982 (goto-char (or (mark) (error "No mark set in this buffer")))
4983 (setq pos2 (funcall aux 1))
4984 (transpose-subr-1 pos1 pos2))
4985 (exchange-point-and-mark))
4986 ((> arg 0)
4987 (setq pos1 (funcall aux -1))
4988 (setq pos2 (funcall aux arg))
4989 (transpose-subr-1 pos1 pos2)
4990 (goto-char (car pos2)))
4991 (t
4992 (setq pos1 (funcall aux -1))
4993 (goto-char (car pos1))
4994 (setq pos2 (funcall aux arg))
4995 (transpose-subr-1 pos1 pos2)))))
4997 (defun transpose-subr-1 (pos1 pos2)
4998 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
4999 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5000 (when (> (car pos1) (car pos2))
5001 (let ((swap pos1))
5002 (setq pos1 pos2 pos2 swap)))
5003 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5004 (atomic-change-group
5005 (let (word2)
5006 ;; FIXME: We first delete the two pieces of text, so markers that
5007 ;; used to point to after the text end up pointing to before it :-(
5008 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5009 (goto-char (car pos2))
5010 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5011 (goto-char (car pos1))
5012 (insert word2))))
5013 \f
5014 (defun backward-word (&optional arg)
5015 "Move backward until encountering the beginning of a word.
5016 With argument ARG, do this that many times."
5017 (interactive "^p")
5018 (forward-word (- (or arg 1))))
5020 (defun mark-word (&optional arg allow-extend)
5021 "Set mark ARG words away from point.
5023 move to with the same argument.
5024 Interactively, if this command is repeated
5025 or (in Transient Mark mode) if the mark is active,
5026 it marks the next ARG words after the ones already marked."
5028 (cond ((and allow-extend
5029 (or (and (eq last-command this-command) (mark t))
5030 (region-active-p)))
5031 (setq arg (if arg (prefix-numeric-value arg)
5032 (if (< (mark) (point)) -1 1)))
5033 (set-mark
5034 (save-excursion
5035 (goto-char (mark))
5036 (forward-word arg)
5037 (point))))
5038 (t
5039 (push-mark
5040 (save-excursion
5041 (forward-word (prefix-numeric-value arg))
5042 (point))
5043 nil t))))
5045 (defun kill-word (arg)
5046 "Kill characters forward until encountering the end of a word.
5047 With argument ARG, do this that many times."
5048 (interactive "p")
5049 (kill-region (point) (progn (forward-word arg) (point))))
5051 (defun backward-kill-word (arg)
5052 "Kill characters backward until encountering the beginning of a word.
5053 With argument ARG, do this that many times."
5054 (interactive "p")
5055 (kill-word (- arg)))
5057 (defun current-word (&optional strict really-word)
5058 "Return the symbol or word that point is on (or a nearby one) as a string.
5059 The return value includes no text properties.
5060 If optional arg STRICT is non-nil, return nil unless point is within
5061 or adjacent to a symbol or word. In all cases the value can be nil
5062 if there is no word nearby.
5063 The function, belying its name, normally finds a symbol.
5064 If optional arg REALLY-WORD is non-nil, it finds just a word."
5065 (save-excursion
5066 (let* ((oldpoint (point)) (start (point)) (end (point))
5067 (syntaxes (if really-word "w" "w_"))
5068 (not-syntaxes (concat "^" syntaxes)))
5069 (skip-syntax-backward syntaxes) (setq start (point))
5070 (goto-char oldpoint)
5071 (skip-syntax-forward syntaxes) (setq end (point))
5072 (when (and (eq start oldpoint) (eq end oldpoint)
5073 ;; Point is neither within nor adjacent to a word.
5074 (not strict))
5075 ;; Look for preceding word in same line.
5076 (skip-syntax-backward not-syntaxes (line-beginning-position))
5077 (if (bolp)
5078 ;; No preceding word in same line.
5079 ;; Look for following word in same line.
5080 (progn
5081 (skip-syntax-forward not-syntaxes (line-end-position))
5082 (setq start (point))
5083 (skip-syntax-forward syntaxes)
5084 (setq end (point)))
5085 (setq end (point))
5086 (skip-syntax-backward syntaxes)
5087 (setq start (point))))
5088 ;; If we found something nonempty, return it as a string.
5089 (unless (= start end)
5090 (buffer-substring-no-properties start end)))))
5091 \f
5092 (defcustom fill-prefix nil
5093 "String for filling to insert at front of new line, or nil for none."
5094 :type '(choice (const :tag "None" nil)
5095 string)
5096 :group 'fill)
5097 (make-variable-buffer-local 'fill-prefix)
5098 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5100 (defcustom auto-fill-inhibit-regexp nil
5101 "Regexp to match lines which should not be auto-filled."
5102 :type '(choice (const :tag "None" nil)
5103 regexp)
5104 :group 'fill)
5106 (defun do-auto-fill ()
5107 "The default value for `normal-auto-fill-function'.
5108 This is the default auto-fill function, some major modes use a different one.
5109 Returns t if it really did any work."
5110 (let (fc justify give-up
5111 (fill-prefix fill-prefix))
5112 (if (or (not (setq justify (current-justification)))
5113 (null (setq fc (current-fill-column)))
5114 (and (eq justify 'left)
5115 (<= (current-column) fc))
5116 (and auto-fill-inhibit-regexp
5117 (save-excursion (beginning-of-line)
5118 (looking-at auto-fill-inhibit-regexp))))
5119 nil ;; Auto-filling not required
5120 (if (memq justify '(full center right))
5121 (save-excursion (unjustify-current-line)))
5123 ;; Choose a fill-prefix automatically.
5124 (when (and adaptive-fill-mode
5125 (or (null fill-prefix) (string= fill-prefix "")))
5126 (let ((prefix
5127 (fill-context-prefix
5128 (save-excursion (fill-forward-paragraph -1) (point))
5129 (save-excursion (fill-forward-paragraph 1) (point)))))
5130 (and prefix (not (equal prefix ""))
5131 ;; Use auto-indentation rather than a guessed empty prefix.
5132 (not (and fill-indent-according-to-mode
5134 (setq fill-prefix prefix))))
5136 (while (and (not give-up) (> (current-column) fc))
5137 ;; Determine where to split the line.
5138 (let* (after-prefix
5139 (fill-point
5140 (save-excursion
5141 (beginning-of-line)
5142 (setq after-prefix (point))
5143 (and fill-prefix
5144 (looking-at (regexp-quote fill-prefix))
5145 (setq after-prefix (match-end 0)))
5146 (move-to-column (1+ fc))
5147 (fill-move-to-break-point after-prefix)
5148 (point))))
5150 ;; See whether the place we found is any good.
5151 (if (save-excursion
5152 (goto-char fill-point)
5153 (or (bolp)
5154 ;; There is no use breaking at end of line.
5155 (save-excursion (skip-chars-forward " ") (eolp))
5156 ;; It is futile to split at the end of the prefix
5157 ;; since we would just insert the prefix again.
5158 (and after-prefix (<= (point) after-prefix))
5159 ;; Don't split right after a comment starter
5160 ;; since we would just make another comment starter.
5161 (and comment-start-skip
5162 (let ((limit (point)))
5163 (beginning-of-line)
5164 (and (re-search-forward comment-start-skip
5165 limit t)
5166 (eq (point) limit))))))
5167 ;; No good place to break => stop trying.
5168 (setq give-up t)
5169 ;; Ok, we have a useful place to break the line. Do it.
5170 (let ((prev-column (current-column)))
5171 ;; If point is at the fill-point, do not `save-excursion'.
5172 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5173 ;; point will end up before it rather than after it.
5174 (if (save-excursion
5176 (= (point) fill-point))
5177 (default-indent-new-line t)
5178 (save-excursion
5179 (goto-char fill-point)
5180 (default-indent-new-line t)))
5181 ;; Now do justification, if required
5182 (if (not (eq justify 'left))
5183 (save-excursion
5184 (end-of-line 0)
5185 (justify-current-line justify nil t)))
5186 ;; If making the new line didn't reduce the hpos of
5187 ;; the end of the line, then give up now;
5188 ;; trying again will not help.
5189 (if (>= (current-column) prev-column)
5190 (setq give-up t))))))
5191 ;; Justify last line.
5192 (justify-current-line justify t t)
5193 t)))
5195 (defvar comment-line-break-function 'comment-indent-new-line
5196 "*Mode-specific function which line breaks and continues a comment.
5197 This function is called during auto-filling when a comment syntax
5198 is defined.
5199 The function should take a single optional argument, which is a flag
5200 indicating whether it should use soft newlines.")
5202 (defun default-indent-new-line (&optional soft)
5203 "Break line at point and indent.
5204 If a comment syntax is defined, call `comment-indent-new-line'.
5206 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5207 unless optional argument SOFT is non-nil."
5208 (interactive)
5209 (if comment-start
5210 (funcall comment-line-break-function soft)
5211 ;; Insert the newline before removing empty space so that markers
5212 ;; get preserved better.
5214 (save-excursion (forward-char -1) (delete-horizontal-space))
5215 (delete-horizontal-space)
5217 (if (and fill-prefix (not adaptive-fill-mode))
5218 ;; Blindly trust a non-adaptive fill-prefix.
5219 (progn
5220 (indent-to-left-margin)
5221 (insert-before-markers-and-inherit fill-prefix))
5223 (cond
5224 ;; If there's an adaptive prefix, use it unless we're inside
5225 ;; a comment and the prefix is not a comment starter.
5226 (fill-prefix
5227 (indent-to-left-margin)
5228 (insert-and-inherit fill-prefix))
5229 ;; If we're not inside a comment, just try to indent.
5230 (t (indent-according-to-mode))))))
5232 (defvar normal-auto-fill-function 'do-auto-fill
5233 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5234 Some major modes set this.")
5236 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5237 ;; `functions' and `hooks' are usually unsafe to set, but setting
5238 ;; auto-fill-function to nil in a file-local setting is safe and
5239 ;; can be useful to prevent auto-filling.
5240 (put 'auto-fill-function 'safe-local-variable 'null)
5242 (define-minor-mode auto-fill-mode
5243 "Toggle Auto Fill mode.
5244 With ARG, turn Auto Fill mode on if and only if ARG is positive.
5245 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
5246 automatically breaks the line at a previous space.
5248 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5249 non-`nil'.
5251 The value of `normal-auto-fill-function' specifies the function to use
5252 for `auto-fill-function' when turning Auto Fill mode on."
5253 :variable (eq auto-fill-function normal-auto-fill-function))
5255 ;; This holds a document string used to document auto-fill-mode.
5256 (defun auto-fill-function ()
5257 "Automatically break line at a previous space, in insertion of text."
5258 nil)
5260 (defun turn-on-auto-fill ()
5261 "Unconditionally turn on Auto Fill mode."
5262 (auto-fill-mode 1))
5264 (defun turn-off-auto-fill ()
5265 "Unconditionally turn off Auto Fill mode."
5266 (auto-fill-mode -1))
5268 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5270 (defun set-fill-column (arg)
5271 "Set `fill-column' to specified argument.
5274 (interactive
5275 (list (or current-prefix-arg
5276 ;; We used to use current-column silently, but C-x f is too easily
5277 ;; typed as a typo for C-x C-f, so we turned it into an error and
5278 ;; now an interactive prompt.
5279 (read-number "Set fill-column to: " (current-column)))))
5280 (if (consp arg)
5281 (setq arg (current-column)))
5282 (if (not (integerp arg))
5283 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5284 (error "set-fill-column requires an explicit argument")
5285 (message "Fill column set to %d (was %d)" arg fill-column)
5286 (setq fill-column arg)))
5287 \f
5288 (defun set-selective-display (arg)
5289 "Set `selective-display' to ARG; clear it if no arg.
5290 When the value of `selective-display' is a number > 0,
5291 lines whose indentation is >= that value are not displayed.
5292 The variable `selective-display' has a separate value for each buffer."
5293 (interactive "P")
5294 (if (eq selective-display t)
5295 (error "selective-display already in use for marked lines"))
5296 (let ((current-vpos
5297 (save-restriction
5298 (narrow-to-region (point-min) (point))
5299 (goto-char (window-start))
5300 (vertical-motion (window-height)))))
5301 (setq selective-display
5302 (and arg (prefix-numeric-value arg)))
5303 (recenter current-vpos))
5304 (set-window-start (selected-window) (window-start (selected-window)))
5305 (princ "selective-display set to " t)
5306 (prin1 selective-display t)
5307 (princ "." t))
5309 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5311 (defun toggle-truncate-lines (&optional arg)
5312 "Toggle truncating of long lines for the current buffer.
5313 When truncating is off, long lines are folded.
5314 With prefix argument ARG, truncate long lines if ARG is positive,
5315 otherwise fold them. Note that in side-by-side windows, this
5316 command has no effect if `truncate-partial-width-windows' is
5317 non-nil."
5318 (interactive "P")
5319 (setq truncate-lines
5320 (if (null arg)
5321 (not truncate-lines)
5322 (> (prefix-numeric-value arg) 0)))
5323 (force-mode-line-update)
5324 (unless truncate-lines
5325 (let ((buffer (current-buffer)))
5326 (walk-windows (lambda (window)
5327 (if (eq buffer (window-buffer window))
5328 (set-window-hscroll window 0)))
5329 nil t)))
5330 (message "Truncate long lines %s"
5331 (if truncate-lines "enabled" "disabled")))
5333 (defun toggle-word-wrap (&optional arg)
5334 "Toggle whether to use word-wrapping for continuation lines.
5335 With prefix argument ARG, wrap continuation lines at word boundaries
5336 if ARG is positive, otherwise wrap them at the right screen edge.
5337 This command toggles the value of `word-wrap'. It has no effect
5338 if long lines are truncated."
5339 (interactive "P")
5340 (setq word-wrap
5341 (if (null arg)
5342 (not word-wrap)
5343 (> (prefix-numeric-value arg) 0)))
5344 (force-mode-line-update)
5345 (message "Word wrapping %s"
5346 (if word-wrap "enabled" "disabled")))
5348 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5349 "The string displayed in the mode line when in overwrite mode.")
5350 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5351 "The string displayed in the mode line when in binary overwrite mode.")
5353 (define-minor-mode overwrite-mode
5354 "Toggle overwrite mode.
5355 With prefix argument ARG, turn overwrite mode on if ARG is positive,
5356 otherwise turn it off. In overwrite mode, printing characters typed
5357 in replace existing text on a one-for-one basis, rather than pushing
5358 it to the right. At the end of a line, such characters extend the line.
5359 Before a tab, such characters insert until the tab is filled in.
5361 is supposed to make it easier to insert characters when necessary."
5362 :variable (eq overwrite-mode 'overwrite-mode-textual))
5364 (define-minor-mode binary-overwrite-mode
5365 "Toggle binary overwrite mode.
5366 With prefix argument ARG, turn binary overwrite mode on if ARG is
5367 positive, otherwise turn it off. In binary overwrite mode, printing
5368 characters typed in replace existing text. Newlines are not treated
5369 specially, so typing at the end of a line joins the line to the next,
5370 with the typed character between them. Typing before a tab character
5372 replaces the text at the cursor, just as ordinary typing characters do.
5374 Note that binary overwrite mode is not its own minor mode; it is a
5375 specialization of overwrite mode, entered by setting the
5376 `overwrite-mode' variable to `overwrite-mode-binary'."
5377 :variable (eq overwrite-mode 'overwrite-mode-binary))
5379 (define-minor-mode line-number-mode
5380 "Toggle Line Number mode.
5381 With ARG, turn Line Number mode on if ARG is positive, otherwise
5382 turn it off. When Line Number mode is enabled, the line number
5383 appears in the mode line.
5385 Line numbers do not appear for very large buffers and buffers
5386 with very long lines; see variables `line-number-display-limit'
5387 and `line-number-display-limit-width'."
5388 :init-value t :global t :group 'mode-line)
5390 (define-minor-mode column-number-mode
5391 "Toggle Column Number mode.
5392 With ARG, turn Column Number mode on if ARG is positive,
5393 otherwise turn it off. When Column Number mode is enabled, the
5394 column number appears in the mode line."
5395 :global t :group 'mode-line)
5397 (define-minor-mode size-indication-mode
5398 "Toggle Size Indication mode.
5399 With ARG, turn Size Indication mode on if ARG is positive,
5400 otherwise turn it off. When Size Indication mode is enabled, the
5401 size of the accessible part of the buffer appears in the mode line."
5402 :global t :group 'mode-line)
5404 (define-minor-mode auto-save-mode
5405 "Toggle auto-saving of contents of current buffer.
5406 With prefix argument ARG, turn auto-saving on if positive, else off."
5407 :variable ((and buffer-auto-save-file-name
5408 ;; If auto-save is off because buffer has shrunk,
5409 ;; then toggling should turn it on.
5410 (>= buffer-saved-size 0))
5411 . (lambda (val)
5412 (setq buffer-auto-save-file-name
5413 (cond
5414 ((null val) nil)
5415 ((and buffer-file-name auto-save-visited-file-name
5416 (not buffer-read-only))
5417 buffer-file-name)
5418 (t (make-auto-save-file-name))))))
5419 ;; If -1 was stored here, to temporarily turn off saving,
5420 ;; turn it back on.
5421 (and (< buffer-saved-size 0)
5422 (setq buffer-saved-size 0)))
5423 \f
5424 (defgroup paren-blinking nil
5425 "Blinking matching of parens and expressions."
5426 :prefix "blink-matching-"
5427 :group 'paren-matching)
5429 (defcustom blink-matching-paren t
5430 "Non-nil means show matching open-paren when close-paren is inserted."
5431 :type 'boolean
5432 :group 'paren-blinking)
5434 (defcustom blink-matching-paren-on-screen t
5435 "Non-nil means show matching open-paren when it is on screen.
5436 If nil, don't show it (but the open-paren can still be shown
5437 when it is off screen).
5439 This variable has no effect if `blink-matching-paren' is nil.
5440 \(In that case, the open-paren is never shown.)
5441 It is also ignored if `show-paren-mode' is enabled."
5442 :type 'boolean
5443 :group 'paren-blinking)
5445 (defcustom blink-matching-paren-distance (* 100 1024)
5446 "If non-nil, maximum distance to search backwards for matching open-paren.
5447 If nil, search stops at the beginning of the accessible portion of the buffer."
5448 :version "23.2" ; 25->100k
5449 :type '(choice (const nil) integer)
5450 :group 'paren-blinking)
5452 (defcustom blink-matching-delay 1
5453 "Time in seconds to delay after showing a matching paren."
5454 :type 'number
5455 :group 'paren-blinking)
5457 (defcustom blink-matching-paren-dont-ignore-comments nil
5458 "If nil, `blink-matching-paren' ignores comments.
5459 More precisely, when looking for the matching parenthesis,
5460 it skips the contents of comments that end before point."
5461 :type 'boolean
5462 :group 'paren-blinking)
5464 (defun blink-matching-check-mismatch (start end)
5465 "Return whether or not START...END are matching parens.
5466 END is the current point and START is the blink position.
5467 START might be nil if no matching starter was found.
5468 Returns non-nil if we find there is a mismatch."
5469 (let* ((end-syntax (syntax-after (1- end)))
5470 (matching-paren (and (consp end-syntax)
5471 (eq (syntax-class end-syntax) 5)
5472 (cdr end-syntax))))
5473 ;; For self-matched chars like " and $, we can't know when they're
5474 ;; mismatched or unmatched, so we can only do it for parens.
5475 (when matching-paren
5476 (not (and start
5477 (or
5478 (eq (char-after start) matching-paren)
5479 ;; The cdr might hold a new paren-class info rather than
5480 ;; a matching-char info, in which case the two CDRs
5481 ;; should match.
5482 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5484 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5485 "Function to check parentheses mismatches.
5486 The function takes two arguments (START and END) where START is the
5487 position just before the opening token and END is the position right after.
5488 START can be nil, if it was not found.
5489 The function should return non-nil if the two tokens do not match.")
5491 (defun blink-matching-open ()
5492 "Move cursor momentarily to the beginning of the sexp before point."
5493 (interactive)
5494 (when (and (not (bobp))
5495 blink-matching-paren)
5496 (let* ((oldpos (point))
5497 (message-log-max nil) ; Don't log messages about paren matching.
5498 (blinkpos
5499 (save-excursion
5500 (save-restriction
5501 (if blink-matching-paren-distance
5502 (narrow-to-region
5503 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5504 (- (point) blink-matching-paren-distance))
5505 oldpos))
5506 (let ((parse-sexp-ignore-comments
5507 (and parse-sexp-ignore-comments
5508 (not blink-matching-paren-dont-ignore-comments))))
5509 (condition-case ()
5510 (progn
5511 (forward-sexp -1)
5512 ;; backward-sexp skips backward over prefix chars,
5513 ;; so move back to the matching paren.
5514 (while (and (< (point) (1- oldpos))
5515 (let ((code (syntax-after (point))))
5516 (or (eq (syntax-class code) 6)
5517 (eq (logand 1048576 (car code))
5518 1048576))))
5519 (forward-char 1))
5520 (point))
5521 (error nil))))))
5522 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5523 (cond
5524 (mismatch
5525 (if blinkpos
5526 (if (minibufferp)
5527 (minibuffer-message "Mismatched parentheses")
5528 (message "Mismatched parentheses"))
5529 (if (minibufferp)
5530 (minibuffer-message "No matching parenthesis found")
5531 (message "No matching parenthesis found"))))
5532 ((not blinkpos) nil)
5533 ((pos-visible-in-window-p blinkpos)
5534 ;; Matching open within window, temporarily move to blinkpos but only
5535 ;; if `blink-matching-paren-on-screen' is non-nil.
5536 (and blink-matching-paren-on-screen
5537 (not show-paren-mode)
5538 (save-excursion
5539 (goto-char blinkpos)
5540 (sit-for blink-matching-delay))))
5541 (t
5542 (save-excursion
5543 (goto-char blinkpos)
5544 (let ((open-paren-line-string
5545 ;; Show what precedes the open in its line, if anything.
5546 (cond
5548 (buffer-substring (line-beginning-position)
5549 (1+ blinkpos)))
5550 ;; Show what follows the open in its line, if anything.
5551 ((save-excursion
5552 (forward-char 1)
5554 (not (eolp)))
5555 (buffer-substring blinkpos
5556 (line-end-position)))
5557 ;; Otherwise show the previous nonblank line,
5558 ;; if there is one.
5560 (concat
5561 (buffer-substring (progn
5563 (line-beginning-position))
5564 (progn (end-of-line)
5566 (point)))
5567 ;; Replace the newline and other whitespace with `...'.
5568 "..."
5569 (buffer-substring blinkpos (1+ blinkpos))))
5570 ;; There is nothing to show except the char itself.
5571 (t (buffer-substring blinkpos (1+ blinkpos))))))
5572 (message "Matches %s"
5573 (substring-no-properties open-paren-line-string)))))))))
5575 (defvar blink-paren-function 'blink-matching-open
5576 "Function called, if non-nil, whenever a close parenthesis is inserted.
5577 More precisely, a char with closeparen syntax is self-inserted.")
5579 (defun blink-paren-post-self-insert-function ()
5580 (when (and (eq (char-before) last-command-event) ; Sanity check.
5581 (memq (char-syntax last-command-event) '(?\) ?\$))
5582 blink-paren-function
5583 (not executing-kbd-macro)
5584 (not noninteractive)
5585 ;; Verify an even number of quoting characters precede the close.
5586 (= 1 (logand 1 (- (point)
5587 (save-excursion
5588 (forward-char -1)
5590 (point))))))
5591 (funcall blink-paren-function)))
5593 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5594 ;; Most likely, this hook is nil, so this arg doesn't matter,
5595 ;; but I use it as a reminder that this function usually
5596 ;; likes to be run after others since it does `sit-for'.
5597 'append)
5598 \f
5599 ;; This executes C-g typed while Emacs is waiting for a command.
5600 ;; Quitting out of a program does not go through here;
5601 ;; that happens in the QUIT macro at the C code level.
5602 (defun keyboard-quit ()
5603 "Signal a `quit' condition.
5604 During execution of Lisp code, this character causes a quit directly.
5605 At top-level, as an editor command, this simply beeps."
5606 (interactive)
5607 ;; Avoid adding the region to the window selection.
5608 (setq saved-region-selection nil)
5609 (let (select-active-regions)
5610 (deactivate-mark))
5611 (if (fboundp 'kmacro-keyboard-quit)
5612 (kmacro-keyboard-quit))
5613 (setq defining-kbd-macro nil)
5614 (let ((debug-on-quit nil))
5615 (signal 'quit nil)))
5617 (defvar buffer-quit-function nil
5620 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5622 (defun keyboard-escape-quit ()
5624 This command can exit an interactive command such as `query-replace',
5625 can clear out a prefix argument or a region,
5626 can get out of the minibuffer or other recursive edit,
5627 cancel the use of the current buffer (for special-purpose buffers),
5628 or go back to just one window (by deleting all but the selected window)."
5629 (interactive)
5630 (cond ((eq last-command 'mode-exited) nil)
5631 ((region-active-p)
5632 (deactivate-mark))
5633 ((> (minibuffer-depth) 0)
5634 (abort-recursive-edit))
5635 (current-prefix-arg
5636 nil)
5637 ((> (recursion-depth) 0)
5638 (exit-recursive-edit))
5639 (buffer-quit-function
5640 (funcall buffer-quit-function))
5641 ((not (one-window-p t))
5642 (delete-other-windows))
5644 (bury-buffer))))
5646 (defun play-sound-file (file &optional volume device)
5647 "Play sound stored in FILE.
5648 VOLUME and DEVICE correspond to the keywords of the sound
5649 specification for `play-sound'."
5650 (interactive "fPlay sound file: ")
5651 (let ((sound (list :file file)))
5652 (if volume
5653 (plist-put sound :volume volume))
5654 (if device
5655 (plist-put sound :device device))
5656 (push 'sound sound)
5657 (play-sound sound)))
5659 \f
5660 (defcustom read-mail-command 'rmail
5661 "Your preference for a mail reading package.
5662 This is used by some keybindings which support reading mail.
5663 See also `mail-user-agent' concerning sending mail."
5666 (function-item :tag "Emacs interface to MH"
5668 (function :tag "Other"))
5669 :version "21.1"
5670 :group 'mail)
5672 (defcustom mail-user-agent 'message-user-agent
5673 "Your preference for a mail composition package.
5674 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5675 outgoing email message. This variable lets you specify which
5676 mail-sending package you prefer.
5678 Valid values include:
5680 `message-user-agent' -- use the Message package.
5681 See Info node `(message)'.
5682 `sendmail-user-agent' -- use the Mail package.
5683 See Info node `(emacs)Sending Mail'.
5684 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5685 See Info node `(mh-e)'.
5686 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5687 paraphernalia, particularly the Gcc: header for
5688 archiving.
5690 Additional valid symbols may be available; check with the author of
5691 your package for details. The function should return non-nil if it
5692 succeeds.
5694 See also `read-mail-command' concerning reading mail."
5695 :type '(radio (function-item :tag "Message package"
5697 message-user-agent)
5698 (function-item :tag "Mail package"
5700 sendmail-user-agent)
5701 (function-item :tag "Emacs interface to MH"
5703 mh-e-user-agent)
5704 (function-item :tag "Message with full Gnus features"
5706 gnus-user-agent)
5707 (function :tag "Other"))
5708 :version "23.2" ; sendmail->message
5709 :group 'mail)
5711 (defcustom compose-mail-user-agent-warnings t
5712 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5713 If the value of `mail-user-agent' is the default, and the user
5714 appears to have customizations applying to the old default,
5715 `compose-mail' issues a warning."
5716 :type 'boolean
5717 :version "23.2"
5718 :group 'mail)
5720 (defun rfc822-goto-eoh ()
5721 "If the buffer starts with a mail header, move point to the header's end.
5722 Otherwise, moves to `point-min'.
5723 The end of the header is the start of the next line, if there is one,
5724 else the end of the last line. This function obeys RFC822."
5725 (goto-char (point-min))
5726 (when (re-search-forward
5728 (goto-char (match-beginning 0))))
5730 (defun compose-mail (&optional to subject other-headers continue
5731 switch-function yank-action send-actions
5732 return-action)
5733 "Start composing a mail message to send.
5734 This uses the user's chosen mail composition package
5735 as selected with the variable `mail-user-agent'.
5736 The optional arguments TO and SUBJECT specify recipients
5737 and the initial Subject field, respectively.
5739 OTHER-HEADERS is an alist specifying additional
5740 header fields. Elements look like (HEADER . VALUE) where both
5741 HEADER and VALUE are strings.
5743 CONTINUE, if non-nil, says to continue editing a message already
5744 being composed. Interactively, CONTINUE is the prefix argument.
5746 SWITCH-FUNCTION, if non-nil, is a function to use to
5747 switch to and display the buffer used for mail composition.
5749 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5750 to insert the raw text of the message being replied to.
5751 It has the form (FUNCTION . ARGS). The user agent will apply
5752 FUNCTION to ARGS, to insert the raw text of the original message.
5753 \(The user agent will also run `mail-citation-hook', *after* the
5754 original text has been inserted in this way.)
5756 SEND-ACTIONS is a list of actions to call when the message is sent.
5757 Each action has the form (FUNCTION . ARGS).
5759 RETURN-ACTION, if non-nil, is an action for returning to the
5760 caller. It has the form (FUNCTION . ARGS). The function is
5761 called after the mail has been sent or put aside, and the mail
5762 buffer buried."
5763 (interactive
5764 (list nil nil nil current-prefix-arg))
5766 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5767 ;; from sendmail-user-agent to message-user-agent. Some users may
5768 ;; encounter incompatibilities. This hack tries to detect problems
5769 ;; and warn about them.
5770 (and compose-mail-user-agent-warnings
5771 (eq mail-user-agent 'message-user-agent)
5772 (let (warn-vars)
5773 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5774 mail-yank-hooks mail-archive-file-name
5775 mail-default-reply-to mail-mailing-lists
5776 mail-self-blind))
5777 (and (boundp var)
5778 (symbol-value var)
5779 (push var warn-vars)))
5780 (when warn-vars
5781 (display-warning 'mail
5782 (format "\
5783 The default mail mode is now Message mode.
5784 You have the following Mail mode variable%s customized:
5786 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5787 (if (> (length warn-vars) 1) "s" "")
5788 (mapconcat 'symbol-name
5789 warn-vars " "))))))
5791 (let ((function (get mail-user-agent 'composefunc)))
5792 (funcall function to subject other-headers continue switch-function
5793 yank-action send-actions return-action)))
5795 (defun compose-mail-other-window (&optional to subject other-headers continue
5796 yank-action send-actions
5797 return-action)
5799 (interactive (list nil nil nil current-prefix-arg))
5800 (compose-mail to subject other-headers continue
5801 'switch-to-buffer-other-window yank-action send-actions
5802 return-action))
5804 (defun compose-mail-other-frame (&optional to subject other-headers continue
5805 yank-action send-actions
5806 return-action)
5808 (interactive (list nil nil nil current-prefix-arg))
5809 (compose-mail to subject other-headers continue
5810 'switch-to-buffer-other-frame yank-action send-actions
5811 return-action))
5813 \f
5814 (defvar set-variable-value-history nil
5815 "History of values entered with `set-variable'.
5817 Maximum length of the history list is determined by the value
5818 of `history-length', which see.")
5820 (defun set-variable (variable value &optional make-local)
5821 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5822 VARIABLE should be a user option variable name, a Lisp variable
5823 meant to be customized by users. You should enter VALUE in Lisp syntax,
5824 so if you want VALUE to be a string, you must surround it with doublequotes.
5825 VALUE is used literally, not evaluated.
5827 If VARIABLE has a `variable-interactive' property, that is used as if
5828 it were the arg to `interactive' (which see) to interactively read VALUE.
5830 If VARIABLE has been defined with `defcustom', then the type information
5831 in the definition is used to check that VALUE is valid.
5833 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5834 (interactive
5835 (let* ((default-var (variable-at-point))
5836 (var (if (user-variable-p default-var)
5837 (read-variable (format "Set variable (default %s): " default-var)
5838 default-var)
5839 (read-variable "Set variable: ")))
5840 (minibuffer-help-form '(describe-variable var))
5841 (prop (get var 'variable-interactive))
5842 (obsolete (car (get var 'byte-obsolete-variable)))
5843 (prompt (format "Set %s %s to value: " var
5844 (cond ((local-variable-p var)
5845 "(buffer-local)")
5846 ((or current-prefix-arg
5847 (local-variable-if-set-p var))
5848 "buffer-locally")
5849 (t "globally"))))
5850 (val (progn
5851 (when obsolete
5852 (message (concat "`%S' is obsolete; "
5853 (if (symbolp obsolete) "use `%S' instead" "%s"))
5854 var obsolete)
5855 (sit-for 3))
5856 (if prop
5857 ;; Use VAR's `variable-interactive' property
5858 ;; as an interactive spec for prompting.
5859 (call-interactively `(lambda (arg)
5860 (interactive ,prop)
5861 arg))
5862 (read
5863 (read-string prompt nil
5864 'set-variable-value-history
5865 (format "%S" (symbol-value var))))))))
5866 (list var val current-prefix-arg)))
5868 (and (custom-variable-p variable)
5869 (not (get variable 'custom-type))
5870 (custom-load-symbol variable))
5871 (let ((type (get variable 'custom-type)))
5872 (when type
5873 ;; Match with custom type.
5874 (require 'cus-edit)
5875 (setq type (widget-convert type))
5876 (unless (widget-apply type :match value)
5877 (error "Value `%S' does not match type %S of %S"
5878 value (car type) variable))))
5880 (if make-local
5881 (make-local-variable variable))
5883 (set variable value)
5885 ;; Force a thorough redisplay for the case that the variable
5886 ;; has an effect on the display, like `tab-width' has.
5887 (force-mode-line-update))
5888 \f
5889 ;; Define the major mode for lists of completions.
5891 (defvar completion-list-mode-map
5892 (let ((map (make-sparse-keymap)))
5893 (define-key map [mouse-2] 'mouse-choose-completion)
5894 (define-key map [follow-link] 'mouse-face)
5895 (define-key map [down-mouse-2] nil)
5896 (define-key map "\C-m" 'choose-completion)
5897 (define-key map "\e\e\e" 'delete-completion-window)
5898 (define-key map [left] 'previous-completion)
5899 (define-key map [right] 'next-completion)
5900 (define-key map "q" 'quit-window)
5901 (define-key map "z" 'kill-this-buffer)
5902 map)
5903 "Local map for completion list buffers.")
5905 ;; Completion mode is suitable only for specially formatted data.
5906 (put 'completion-list-mode 'mode-class 'special)
5908 (defvar completion-reference-buffer nil
5909 "Record the buffer that was current when the completion list was requested.
5910 This is a local variable in the completion list buffer.
5911 Initial value is nil to avoid some compiler warnings.")
5913 (defvar completion-no-auto-exit nil
5914 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5915 This also applies to other functions such as `choose-completion'.")
5917 (defvar completion-base-position nil
5918 "Position of the base of the text corresponding to the shown completions.
5919 This variable is used in the *Completions* buffers.
5920 Its value is a list of the form (START END) where START is the place
5921 where the completion should be inserted and END (if non-nil) is the end
5922 of the text to replace. If END is nil, point is used instead.")
5924 (defvar completion-list-insert-choice-function #'completion--replace
5925 "Function to use to insert the text chosen in *Completions*.
5926 Called with 3 arguments (BEG END TEXT), it should replace the text
5927 between BEG and END with TEXT. Expected to be set buffer-locally
5928 in the *Completions* buffer.")
5930 (defvar completion-base-size nil
5931 "Number of chars before point not involved in completion.
5932 This is a local variable in the completion list buffer.
5933 It refers to the chars in the minibuffer if completing in the
5934 minibuffer, or in `completion-reference-buffer' otherwise.
5935 Only characters in the field at point are included.
5937 If nil, Emacs determines which part of the tail end of the
5938 buffer's text is involved in completion by comparing the text
5939 directly.")
5940 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
5942 (defun delete-completion-window ()
5943 "Delete the completion list window.
5944 Go to the window from which completion was requested."
5945 (interactive)
5946 (let ((buf completion-reference-buffer))
5947 (if (one-window-p t)
5948 (if (window-dedicated-p (selected-window))
5949 (delete-frame (selected-frame)))
5950 (delete-window (selected-window))
5951 (if (get-buffer-window buf)
5952 (select-window (get-buffer-window buf))))))
5954 (defun previous-completion (n)
5955 "Move to the previous item in the completion list."
5956 (interactive "p")
5957 (next-completion (- n)))
5959 (defun next-completion (n)
5960 "Move to the next item in the completion list.
5961 With prefix argument N, move N items (negative N means move backward)."
5962 (interactive "p")
5963 (let ((beg (point-min)) (end (point-max)))
5964 (while (and (> n 0) (not (eobp)))
5965 ;; If in a completion, move to the end of it.
5966 (when (get-text-property (point) 'mouse-face)
5967 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5968 ;; Move to start of next one.
5969 (unless (get-text-property (point) 'mouse-face)
5970 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5971 (setq n (1- n)))
5972 (while (and (< n 0) (not (bobp)))
5973 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
5974 ;; If in a completion, move to the start of it.
5975 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
5976 (goto-char (previous-single-property-change
5977 (point) 'mouse-face nil beg)))
5978 ;; Move to end of the previous completion.
5979 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
5980 (goto-char (previous-single-property-change
5981 (point) 'mouse-face nil beg)))
5982 ;; Move to the start of that one.
5983 (goto-char (previous-single-property-change
5984 (point) 'mouse-face nil beg))
5985 (setq n (1+ n))))))
5987 (defun choose-completion (&optional event)
5988 "Choose the completion at point."
5989 (interactive (list last-nonmenu-event))
5990 ;; In case this is run via the mouse, give temporary modes such as
5991 ;; isearch a chance to turn off.
5992 (run-hooks 'mouse-leave-buffer-hook)
5993 (with-current-buffer (window-buffer (posn-window (event-start event)))
5994 (let ((buffer completion-reference-buffer)
5995 (base-size completion-base-size)
5996 (base-position completion-base-position)
5997 (insert-function completion-list-insert-choice-function)
5998 (choice
5999 (save-excursion
6000 (goto-char (posn-point (event-start event)))
6001 (let (beg end)
6002 (cond
6003 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6004 (setq end (point) beg (1+ (point))))
6005 ((and (not (bobp))
6006 (get-text-property (1- (point)) 'mouse-face))
6007 (setq end (1- (point)) beg (point)))
6008 (t (error "No completion here")))
6009 (setq beg (previous-single-property-change beg 'mouse-face))
6010 (setq end (or (next-single-property-change end 'mouse-face)
6011 (point-max)))
6012 (buffer-substring-no-properties beg end))))
6013 (owindow (selected-window)))
6015 (unless (buffer-live-p buffer)
6016 (error "Destination buffer is dead"))
6017 (select-window (posn-window (event-start event)))
6018 (if (and (one-window-p t 'selected-frame)
6019 (window-dedicated-p (selected-window)))
6020 ;; This is a special buffer's frame
6021 (iconify-frame (selected-frame))
6022 (or (window-dedicated-p (selected-window))
6023 (bury-buffer)))
6024 (select-window
6025 (or (get-buffer-window buffer 0)
6026 owindow))
6028 (with-current-buffer buffer
6029 (choose-completion-string
6030 choice buffer
6031 (or base-position
6032 (when base-size
6033 ;; Someone's using old completion code that doesn't know
6034 ;; about base-position yet.
6035 (list (+ base-size (field-beginning))))
6036 ;; If all else fails, just guess.
6037 (list (choose-completion-guess-base-position choice)))
6038 insert-function)))))
6040 ;; Delete the longest partial match for STRING
6041 ;; that can be found before POINT.
6042 (defun choose-completion-guess-base-position (string)
6043 (save-excursion
6044 (let ((opoint (point))
6045 len)
6046 ;; Try moving back by the length of the string.
6047 (goto-char (max (- (point) (length string))
6048 (minibuffer-prompt-end)))
6049 ;; See how far back we were actually able to move. That is the
6050 ;; upper bound on how much we can match and delete.
6051 (setq len (- opoint (point)))
6052 (if completion-ignore-case
6053 (setq string (downcase string)))
6054 (while (and (> len 0)
6055 (let ((tail (buffer-substring (point) opoint)))
6056 (if completion-ignore-case
6057 (setq tail (downcase tail)))
6058 (not (string= tail (substring string 0 len)))))
6059 (setq len (1- len))
6060 (forward-char 1))
6061 (point))))
6063 (defun choose-completion-delete-max-match (string)
6064 (delete-region (choose-completion-guess-base-position string) (point)))
6065 (make-obsolete 'choose-completion-delete-max-match
6066 'choose-completion-guess-base-position "23.2")
6068 (defvar choose-completion-string-functions nil
6069 "Functions that may override the normal insertion of a completion choice.
6070 These functions are called in order with four arguments:
6071 CHOICE - the string to insert in the buffer,
6072 BUFFER - the buffer in which the choice should be inserted,
6073 MINI-P - non-nil if BUFFER is a minibuffer, and
6074 BASE-SIZE - the number of characters in BUFFER before
6075 the string being completed.
6077 If a function in the list returns non-nil, that function is supposed
6078 to have inserted the CHOICE in the BUFFER, and possibly exited
6079 the minibuffer; no further functions will be called.
6081 If all functions in the list return nil, that means to use
6082 the default method of inserting the completion in BUFFER.")
6084 (defun choose-completion-string (choice &optional
6085 buffer base-position insert-function)
6086 "Switch to BUFFER and insert the completion choice CHOICE.
6087 BASE-POSITION, says where to insert the completion."
6089 ;; If BUFFER is the minibuffer, exit the minibuffer
6090 ;; unless it is reading a file name and CHOICE is a directory,
6091 ;; or completion-no-auto-exit is non-nil.
6093 ;; Some older code may call us passing `base-size' instead of
6094 ;; `base-position'. It's difficult to make any use of `base-size',
6095 ;; so we just ignore it.
6096 (unless (consp base-position)
6097 (message "Obsolete `base-size' passed to choose-completion-string")
6098 (setq base-position nil))
6100 (let* ((buffer (or buffer completion-reference-buffer))
6101 (mini-p (minibufferp buffer)))
6102 ;; If BUFFER is a minibuffer, barf unless it's the currently
6103 ;; active minibuffer.
6104 (if (and mini-p
6105 (not (and (active-minibuffer-window)
6106 (equal buffer
6107 (window-buffer (active-minibuffer-window))))))
6108 (error "Minibuffer is not active for completion")
6109 ;; Set buffer so buffer-local choose-completion-string-functions works.
6110 (set-buffer buffer)
6111 (unless (run-hook-with-args-until-success
6112 'choose-completion-string-functions
6113 ;; The fourth arg used to be `mini-p' but was useless
6114 ;; (since minibufferp can be used on the `buffer' arg)
6115 ;; and indeed unused. The last used to be `base-size', so we
6116 ;; keep it to try and avoid breaking old code.
6117 choice buffer base-position nil)
6118 ;; This remove-text-properties should be unnecessary since `choice'
6119 ;; comes from buffer-substring-no-properties.
6120 ;;(remove-text-properties 0 (lenth choice) '(mouse-face nil) choice)
6121 ;; Insert the completion into the buffer where it was requested.
6122 (funcall (or insert-function completion-list-insert-choice-function)
6123 (or (car base-position) (point))
6124 (or (cadr base-position) (point))
6125 choice)
6126 ;; Update point in the window that BUFFER is showing in.
6127 (let ((window (get-buffer-window buffer t)))
6128 (set-window-point window (point)))
6129 ;; If completing for the minibuffer, exit it with this choice.
6130 (and (not completion-no-auto-exit)
6131 (minibufferp buffer)
6132 minibuffer-completion-table
6133 ;; If this is reading a file name, and the file name chosen
6134 ;; is a directory, don't exit the minibuffer.
6135 (let* ((result (buffer-substring (field-beginning) (point)))
6136 (bounds
6137 (completion-boundaries result minibuffer-completion-table
6138 minibuffer-completion-predicate
6139 "")))
6140 (if (eq (car bounds) (length result))
6141 ;; The completion chosen leads to a new set of completions
6142 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6143 (let ((mini (active-minibuffer-window)))
6144 (select-window mini)
6145 (when minibuffer-auto-raise
6146 (raise-frame (window-frame mini))))
6147 (exit-minibuffer))))))))
6149 (define-derived-mode completion-list-mode nil "Completion List"
6150 "Major mode for buffers showing lists of possible completions.
6152 to select the completion near point.
6154 with the mouse.
6157 (set (make-local-variable 'completion-base-size) nil))
6159 (defun completion-list-mode-finish ()
6160 "Finish setup of the completions buffer.
6161 Called from `temp-buffer-show-hook'."
6162 (when (eq major-mode 'completion-list-mode)
6163 (toggle-read-only 1)))
6165 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6168 ;; Variables and faces used in `completion-setup-function'.
6170 (defcustom completion-show-help t
6171 "Non-nil means show help message in *Completions* buffer."
6172 :type 'boolean
6173 :version "22.1"
6174 :group 'completion)
6176 ;; This function goes in completion-setup-hook, so that it is called
6177 ;; after the text of the completion list buffer is written.
6178 (defun completion-setup-function ()
6179 (let* ((mainbuf (current-buffer))
6180 (base-dir
6181 ;; When reading a file name in the minibuffer,
6182 ;; try and find the right default-directory to set in the
6183 ;; completion list buffer.
6184 ;; FIXME: Why do we do that, actually? --Stef
6185 (if minibuffer-completing-file-name
6186 (file-name-as-directory
6187 (expand-file-name
6188 (substring (minibuffer-completion-contents)
6189 0 (or completion-base-size 0)))))))
6190 (with-current-buffer standard-output
6191 (let ((base-size completion-base-size) ;Read before killing localvars.
6192 (base-position completion-base-position)
6193 (insert-fun completion-list-insert-choice-function))
6194 (completion-list-mode)
6195 (set (make-local-variable 'completion-base-size) base-size)
6196 (set (make-local-variable 'completion-base-position) base-position)
6197 (set (make-local-variable 'completion-list-insert-choice-function)
6198 insert-fun))
6199 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6200 (if base-dir (setq default-directory base-dir))
6201 ;; Maybe insert help string.
6202 (when completion-show-help
6203 (goto-char (point-min))
6204 (if (display-mouse-p)
6205 (insert (substitute-command-keys
6207 (insert (substitute-command-keys
6211 (add-hook 'completion-setup-hook 'completion-setup-function)
6213 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6214 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6216 (defun switch-to-completions ()
6217 "Select the completion list window."
6218 (interactive)
6219 (let ((window (or (get-buffer-window "*Completions*" 0)
6220 ;; Make sure we have a completions window.
6221 (progn (minibuffer-completion-help)
6222 (get-buffer-window "*Completions*" 0)))))
6223 (when window
6224 (select-window window)
6225 ;; In the new buffer, go to the first completion.
6226 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6227 (when (bobp)
6228 (next-completion 1)))))
6229 \f
6230 ;;; Support keyboard commands to turn on various modifiers.
6232 ;; These functions -- which are not commands -- each add one modifier
6233 ;; to the following event.
6235 (defun event-apply-alt-modifier (_ignore-prompt)
6238 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6239 (defun event-apply-super-modifier (_ignore-prompt)
6242 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6243 (defun event-apply-hyper-modifier (_ignore-prompt)
6246 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6247 (defun event-apply-shift-modifier (_ignore-prompt)
6250 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6251 (defun event-apply-control-modifier (_ignore-prompt)
6254 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6255 (defun event-apply-meta-modifier (_ignore-prompt)
6258 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6260 (defun event-apply-modifier (event symbol lshiftby prefix)
6261 "Apply a modifier flag to event EVENT.
6262 SYMBOL is the name of this modifier, as a symbol.
6263 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6264 PREFIX is the string that represents this modifier in an event type symbol."
6265 (if (numberp event)
6266 (cond ((eq symbol 'control)
6267 (if (and (<= (downcase event) ?z)
6268 (>= (downcase event) ?a))
6269 (- (downcase event) ?a -1)
6270 (if (and (<= (downcase event) ?Z)
6271 (>= (downcase event) ?A))
6272 (- (downcase event) ?A -1)
6273 (logior (lsh 1 lshiftby) event))))
6274 ((eq symbol 'shift)
6275 (if (and (<= (downcase event) ?z)
6276 (>= (downcase event) ?a))
6277 (upcase event)
6278 (logior (lsh 1 lshiftby) event)))
6279 (t
6280 (logior (lsh 1 lshiftby) event)))
6281 (if (memq symbol (event-modifiers event))
6282 event
6283 (let ((event-type (if (symbolp event) event (car event))))
6284 (setq event-type (intern (concat prefix (symbol-name event-type))))
6285 (if (symbolp event)
6286 event-type
6287 (cons event-type (cdr event)))))))
6289 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6290 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6291 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6292 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6293 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6294 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6295 \f
6296 ;;;; Keypad support.
6298 ;; Make the keypad keys act like ordinary typing keys. If people add
6299 ;; bindings for the function key symbols, then those bindings will
6300 ;; override these, so this shouldn't interfere with any existing
6301 ;; bindings.
6303 ;; Also tell read-char how to handle these keys.
6304 (mapc
6305 (lambda (keypad-normal)
6306 (let ((keypad (nth 0 keypad-normal))
6307 (normal (nth 1 keypad-normal)))
6308 (put keypad 'ascii-character normal)
6309 (define-key function-key-map (vector keypad) (vector normal))))
6310 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6311 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6312 (kp-space ?\s)
6315 (kp-multiply ?*)
6316 (kp-add ?+)
6317 (kp-separator ?,)
6318 (kp-subtract ?-)
6319 (kp-decimal ?.)
6320 (kp-divide ?/)
6321 (kp-equal ?=)
6322 ;; Do the same for various keys that are represented as symbols under
6323 ;; GUIs but naturally correspond to characters.
6324 (backspace 127)
6325 (delete 127)
6328 (clear ?\C-l)
6329 (return ?\C-m)
6330 (escape ?\e)
6331 ))
6332 \f
6333 ;;;;
6334 ;;;; forking a twin copy of a buffer.
6335 ;;;;
6337 (defvar clone-buffer-hook nil
6338 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6340 (defvar clone-indirect-buffer-hook nil
6341 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6343 (defun clone-process (process &optional newname)
6344 "Create a twin copy of PROCESS.
6345 If NEWNAME is nil, it defaults to PROCESS' name;
6346 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6347 If PROCESS is associated with a buffer, the new process will be associated
6348 with the current buffer instead.
6349 Returns nil if PROCESS has already terminated."
6350 (setq newname (or newname (process-name process)))
6352 (setq newname (substring newname 0 (match-beginning 0))))
6353 (when (memq (process-status process) '(run stop open))
6354 (let* ((process-connection-type (process-tty-name process))
6355 (new-process
6356 (if (memq (process-status process) '(open))
6357 (let ((args (process-contact process t)))
6358 (setq args (plist-put args :name newname))
6359 (setq args (plist-put args :buffer
6360 (if (process-buffer process)
6361 (current-buffer))))
6362 (apply 'make-network-process args))
6363 (apply 'start-process newname
6364 (if (process-buffer process) (current-buffer))
6365 (process-command process)))))
6366 (set-process-query-on-exit-flag
6367 new-process (process-query-on-exit-flag process))
6368 (set-process-inherit-coding-system-flag
6369 new-process (process-inherit-coding-system-flag process))
6370 (set-process-filter new-process (process-filter process))
6371 (set-process-sentinel new-process (process-sentinel process))
6372 (set-process-plist new-process (copy-sequence (process-plist process)))
6373 new-process)))
6375 ;; things to maybe add (currently partly covered by `funcall mode'):
6376 ;; - syntax-table
6377 ;; - overlays
6378 (defun clone-buffer (&optional newname display-flag)
6379 "Create and return a twin copy of the current buffer.
6380 Unlike an indirect buffer, the new buffer can be edited
6381 independently of the old one (if it is not read-only).
6382 NEWNAME is the name of the new buffer. It may be modified by
6383 adding or incrementing <N> at the end as necessary to create a
6384 unique buffer name. If nil, it defaults to the name of the
6385 current buffer, with the proper suffix. If DISPLAY-FLAG is
6386 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6387 clone a file-visiting buffer, or a buffer whose major mode symbol
6388 has a non-nil `no-clone' property, results in an error.
6390 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6391 current buffer with appropriate suffix. However, if a prefix
6392 argument is given, then the command prompts for NEWNAME in the
6393 minibuffer.
6395 This runs the normal hook `clone-buffer-hook' in the new buffer
6396 after it has been set up properly in other respects."
6397 (interactive
6398 (progn
6399 (if buffer-file-name
6400 (error "Cannot clone a file-visiting buffer"))
6401 (if (get major-mode 'no-clone)
6402 (error "Cannot clone a buffer in %s mode" mode-name))
6403 (list (if current-prefix-arg
6404 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6405 t)))
6406 (if buffer-file-name
6407 (error "Cannot clone a file-visiting buffer"))
6408 (if (get major-mode 'no-clone)
6409 (error "Cannot clone a buffer in %s mode" mode-name))
6410 (setq newname (or newname (buffer-name)))
6412 (setq newname (substring newname 0 (match-beginning 0))))
6413 (let ((buf (current-buffer))
6414 (ptmin (point-min))
6415 (ptmax (point-max))
6416 (pt (point))
6417 (mk (if mark-active (mark t)))
6418 (modified (buffer-modified-p))
6419 (mode major-mode)
6420 (lvars (buffer-local-variables))
6421 (process (get-buffer-process (current-buffer)))
6422 (new (generate-new-buffer (or newname (buffer-name)))))
6423 (save-restriction
6424 (widen)
6425 (with-current-buffer new
6426 (insert-buffer-substring buf)))
6427 (with-current-buffer new
6428 (narrow-to-region ptmin ptmax)
6429 (goto-char pt)
6430 (if mk (set-mark mk))
6431 (set-buffer-modified-p modified)
6433 ;; Clone the old buffer's process, if any.
6434 (when process (clone-process process))
6436 ;; Now set up the major mode.
6437 (funcall mode)
6439 ;; Set up other local variables.
6440 (mapc (lambda (v)
6441 (condition-case () ;in case var is read-only
6442 (if (symbolp v)
6443 (makunbound v)
6444 (set (make-local-variable (car v)) (cdr v)))
6445 (error nil)))
6446 lvars)
6448 ;; Run any hooks (typically set up by the major mode
6449 ;; for cloning to work properly).
6450 (run-hooks 'clone-buffer-hook))
6451 (if display-flag
6452 ;; Presumably the current buffer is shown in the selected frame, so
6453 ;; we want to display the clone elsewhere.
6454 (let ((same-window-regexps nil)
6455 (same-window-buffer-names))
6456 (pop-to-buffer new)))
6457 new))
6460 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6461 "Create an indirect buffer that is a twin copy of the current buffer.
6463 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6464 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6465 or if not called with a prefix arg, NEWNAME defaults to the current
6466 buffer's name. The name is modified by adding a `<N>' suffix to it
6467 or by incrementing the N in an existing suffix. Trying to clone a
6468 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6469 property results in an error.
6471 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6472 This is always done when called interactively.
6474 Optional third arg NORECORD non-nil means do not put this buffer at the
6475 front of the list of recently selected ones."
6476 (interactive
6477 (progn
6478 (if (get major-mode 'no-clone-indirect)
6479 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6480 (list (if current-prefix-arg
6481 (read-buffer "Name of indirect buffer: " (current-buffer)))
6482 t)))
6483 (if (get major-mode 'no-clone-indirect)
6484 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6485 (setq newname (or newname (buffer-name)))
6487 (setq newname (substring newname 0 (match-beginning 0))))
6488 (let* ((name (generate-new-buffer-name newname))
6489 (buffer (make-indirect-buffer (current-buffer) name t)))
6490 (with-current-buffer buffer
6491 (run-hooks 'clone-indirect-buffer-hook))
6492 (when display-flag
6493 (pop-to-buffer buffer norecord))
6494 buffer))
6497 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6498 "Like `clone-indirect-buffer' but display in another window."
6499 (interactive
6500 (progn
6501 (if (get major-mode 'no-clone-indirect)
6502 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6503 (list (if current-prefix-arg
6504 (read-buffer "Name of indirect buffer: " (current-buffer)))
6505 t)))
6506 (let ((pop-up-windows t))
6507 (clone-indirect-buffer newname display-flag norecord)))
6509 \f
6510 ;;; Handling of Backspace and Delete keys.
6512 (defcustom normal-erase-is-backspace 'maybe
6513 "Set the default behavior of the Delete and Backspace keys.
6515 If set to t, Delete key deletes forward and Backspace key deletes
6516 backward.
6518 If set to nil, both Delete and Backspace keys delete backward.
6520 If set to 'maybe (which is the default), Emacs automatically
6521 selects a behavior. On window systems, the behavior depends on
6522 the keyboard used. If the keyboard has both a Backspace key and
6523 a Delete key, and both are mapped to their usual meanings, the
6524 option's default value is set to t, so that Backspace can be used
6525 to delete backward, and Delete can be used to delete forward.
6527 If not running under a window system, customizing this option
6528 accomplishes a similar effect by mapping C-h, which is usually
6529 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6530 via `keyboard-translate'. The former functionality of C-h is
6531 available on the F1 key. You should probably not use this
6532 setting if you don't have both Backspace, Delete and F1 keys.
6534 Setting this variable with setq doesn't take effect. Programmatically,
6535 call `normal-erase-is-backspace-mode' (which see) instead."
6536 :type '(choice (const :tag "Off" nil)
6537 (const :tag "Maybe" maybe)
6538 (other :tag "On" t))
6539 :group 'editing-basics
6540 :version "21.1"
6541 :set (lambda (symbol value)
6542 ;; The fboundp is because of a problem with :set when
6543 ;; dumping Emacs. It doesn't really matter.
6544 (if (fboundp 'normal-erase-is-backspace-mode)
6545 (normal-erase-is-backspace-mode (or value 0))
6546 (set-default symbol value))))
6548 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6549 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6550 (unless frame (setq frame (selected-frame)))
6551 (with-selected-frame frame
6552 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6553 (normal-erase-is-backspace-mode
6554 (if (if (eq normal-erase-is-backspace 'maybe)
6555 (and (not noninteractive)
6556 (or (memq system-type '(ms-dos windows-nt))
6557 (memq window-system '(ns))
6558 (and (memq window-system '(x))
6559 (fboundp 'x-backspace-delete-keys-p)
6560 (x-backspace-delete-keys-p))
6561 ;; If the terminal Emacs is running on has erase char
6562 ;; set to ^H, use the Backspace key for deleting
6563 ;; backward, and the Delete key for deleting forward.
6564 (and (null window-system)
6565 (eq tty-erase-char ?\^H))))
6566 normal-erase-is-backspace)
6567 1 0)))))
6569 (define-minor-mode normal-erase-is-backspace-mode
6570 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6572 With numeric ARG, turn the mode on if and only if ARG is positive.
6574 On window systems, when this mode is on, Delete is mapped to C-d
6575 and Backspace is mapped to DEL; when this mode is off, both
6576 Delete and Backspace are mapped to DEL. (The remapping goes via
6577 `local-function-key-map', so binding Delete or Backspace in the
6578 global or local keymap will override that.)
6580 In addition, on window systems, the bindings of C-Delete, M-Delete,
6581 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6582 the global keymap in accordance with the functionality of Delete and
6583 Backspace. For example, if Delete is remapped to C-d, which deletes
6584 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6585 to DEL, which deletes backward, C-Delete is bound to
6586 `backward-kill-word'.
6588 If not running on a window system, a similar effect is accomplished by
6589 remapping C-h (normally produced by the Backspace key) and DEL via
6590 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6591 to C-d; if it's off, the keys are not remapped.
6593 When not running on a window system, and this mode is turned on, the
6594 former functionality of C-h is available on the F1 key. You should
6595 probably not turn on this mode on a text-only terminal if you don't
6596 have both Backspace, Delete and F1 keys.
6598 See also `normal-erase-is-backspace'."
6599 :variable (eq (terminal-parameter
6600 nil 'normal-erase-is-backspace) 1)
6601 (let ((enabled (eq 1 (terminal-parameter
6602 nil 'normal-erase-is-backspace))))
6604 (cond ((or (memq window-system '(x w32 ns pc))
6605 (memq system-type '(ms-dos windows-nt)))
6606 (let ((bindings
6607 `(([M-delete] [M-backspace])
6608 ([C-M-delete] [C-M-backspace])
6609 ([?\e C-delete] [?\e C-backspace]))))
6611 (if enabled
6612 (progn
6613 (define-key local-function-key-map [delete] [deletechar])
6614 (define-key local-function-key-map [kp-delete] [?\C-d])
6615 (define-key local-function-key-map [backspace] [?\C-?])
6616 (dolist (b bindings)
6617 ;; Not sure if input-decode-map is really right, but
6618 ;; keyboard-translate-table (used below) only works
6619 ;; for integer events, and key-translation-table is
6620 ;; global (like the global-map, used earlier).
6621 (define-key input-decode-map (car b) nil)
6622 (define-key input-decode-map (cadr b) nil)))
6623 (define-key local-function-key-map [delete] [?\C-?])
6624 (define-key local-function-key-map [kp-delete] [?\C-?])
6625 (define-key local-function-key-map [backspace] [?\C-?])
6626 (dolist (b bindings)
6627 (define-key input-decode-map (car b) (cadr b))
6628 (define-key input-decode-map (cadr b) (car b))))))
6629 (t
6630 (if enabled
6631 (progn
6632 (keyboard-translate ?\C-h ?\C-?)
6633 (keyboard-translate ?\C-? ?\C-d))
6634 (keyboard-translate ?\C-h ?\C-h)
6635 (keyboard-translate ?\C-? ?\C-?))))
6637 (if (called-interactively-p 'interactive)
6638 (message "Delete key deletes %s"
6639 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6640 "forward" "backward")))))
6641 \f
6642 (defvar vis-mode-saved-buffer-invisibility-spec nil
6643 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6645 (define-minor-mode visible-mode
6646 "Toggle Visible mode.
6647 With argument ARG turn Visible mode on if ARG is positive, otherwise
6648 turn it off.
6650 Enabling Visible mode makes all invisible text temporarily visible.
6651 Disabling Visible mode turns off that effect. Visible mode works by
6652 saving the value of `buffer-invisibility-spec' and setting it to nil."
6653 :lighter " Vis"
6654 :group 'editing-basics
6655 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6656 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6657 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6658 (when visible-mode
6659 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6660 buffer-invisibility-spec)
6661 (setq buffer-invisibility-spec nil)))
6662 \f
6663 ;; Minibuffer prompt stuff.
6665 ;;(defun minibuffer-prompt-modification (start end)
6666 ;; (error "You cannot modify the prompt"))
6667 ;;
6668 ;;
6669 ;;(defun minibuffer-prompt-insertion (start end)
6670 ;; (let ((inhibit-modification-hooks t))
6671 ;; (delete-region start end)
6672 ;; ;; Discard undo information for the text insertion itself
6673 ;; ;; and for the text deletion.above.
6674 ;; (when (consp buffer-undo-list)
6675 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6676 ;; (message "You cannot modify the prompt")))
6677 ;;
6678 ;;
6679 ;;(setq minibuffer-prompt-properties
6680 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6681 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6683 \f
6684 ;;;; Problematic external packages.
6686 ;; rms says this should be done by specifying symbols that define
6687 ;; versions together with bad values. This is therefore not as
6688 ;; flexible as it could be. See the thread:
6689 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6690 (defconst bad-packages-alist
6691 ;; Not sure exactly which semantic versions have problems.
6692 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6694 "The version of `semantic' loaded does not work in Emacs 22.
6695 It can cause constant high CPU load.
6696 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6697 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6698 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6699 ;; provided the `CUA-mode' feature. Since this is no longer true,
6700 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6701 (CUA-mode t nil
6702 "CUA-mode is now part of the standard GNU Emacs distribution,
6703 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6705 You have loaded an older version of CUA-mode which does not work
6706 correctly with this version of Emacs. You should remove the old
6707 version and use the one distributed with Emacs."))
6708 "Alist of packages known to cause problems in this version of Emacs.
6709 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6710 PACKAGE is either a regular expression to match file names, or a
6711 symbol (a feature name); see the documentation of
6712 `after-load-alist', to which this variable adds functions.
6713 SYMBOL is either the name of a string variable, or `t'. Upon
6714 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6715 warning using STRING as the message.")
6717 (defun bad-package-check (package)
6718 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6719 (condition-case nil
6720 (let* ((list (assoc package bad-packages-alist))
6721 (symbol (nth 1 list)))
6722 (and list
6723 (boundp symbol)
6724 (or (eq symbol t)
6725 (and (stringp (setq symbol (eval symbol)))
6726 (string-match-p (nth 2 list) symbol)))
6727 (display-warning package (nth 3 list) :warning)))
6728 (error nil)))
6730 (mapc (lambda (elem)
6731 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6732 bad-packages-alist)
6735 (provide 'simple)
6737 ;;; simple.el ends here