| blob | aa4b9a97182895a13174fc1dcad237fdd72002d7 |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
5 ;; 2010 Free Software Foundation, Inc.
7 ;; Maintainer: FSF
8 ;; Keywords: internal
9 ;; Package: emacs
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; A grab-bag of basic Emacs commands not specifically related to some
29 ;; major mode or to file-handling.
31 ;;; Code:
33 ;; This is for lexical-let in apply-partially.
42 "Idle time delay before updating various things on the screen.
43 Various Emacs features that update auxiliary information when point moves
44 wait this many seconds after Emacs becomes idle before doing an update."
50 "Killing and yanking commands."
54 "Highlight (un)matching of parens and expressions."
58 "Search LIST for a valid buffer to display in FRAME.
59 Return nil when all buffers in LIST are undesirable for display,
60 otherwise return the first suitable buffer in LIST.
62 Buffers not visible in windows are preferred to visible buffers,
63 unless VISIBLE-OK is non-nil.
64 If the optional argument FRAME is nil, it defaults to the selected frame.
65 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
66 ;; This logic is more or less copied from other-buffer.
69 found buf)
82 "Return the last buffer in FRAME's buffer list.
83 If BUFFER is the last buffer, return the preceding buffer instead.
84 Buffers not visible in windows are preferred to visible buffers,
85 unless optional argument VISIBLE-OK is non-nil.
86 Optional third argument FRAME nil or omitted means use the
87 selected frame's buffer list.
88 If no such buffer exists, return the buffer `*scratch*', creating
89 it if necessary."
92 buffer visible-ok frame)
96 scratch)))
99 "Switch to the next buffer in cyclic order."
106 "Switch to the previous buffer in cyclic order."
110 \f
111 ;;; next-error support framework
114 "`next-error' support framework."
120 "Face used to highlight next error locus."
125 "Highlighting of locations in selected source buffers.
126 If a number, highlight the locus in `next-error' face for the given time
127 in seconds, or until the next command is executed.
128 If t, highlight the locus until the next command is executed, or until
129 some other locus replaces it.
130 If nil, don't highlight the locus in the source buffer.
131 If `fringe-arrow', indicate the locus by the fringe arrow."
140 "Highlighting of locations in `next-error-no-select'.
141 If number, highlight the locus in `next-error' face for given time in seconds.
142 If t, highlight the locus indefinitely until some other locus replaces it.
143 If nil, don't highlight the locus in the source buffer.
144 If `fringe-arrow', indicate the locus by the fringe arrow."
153 "Display the line in the visited source file recentered as specified.
154 If non-nil, the value is passed directly to `recenter'."
162 "List of hook functions run by `next-error' after visiting source file."
173 "The most recent `next-error' buffer.
174 A buffer becomes most recent when its compilation, grep, or
179 "Function to use to find the next error in the current buffer.
180 The function is called with 2 parameters:
181 ARG is an integer specifying by how many errors to move.
182 RESET is a boolean which, if non-nil, says to go back to the beginning
183 of the errors before moving.
184 Major modes providing compile-like functionality should set this variable
185 to indicate to `next-error' that this is a candidate buffer and how
190 "Function to use to move to an error locus.
191 It takes two arguments, a buffer position in the error buffer
192 and a buffer position in the error locus buffer.
193 The buffer for the error locus should already be current.
198 &optional avoid-current
199 extra-test-inclusive
200 extra-test-exclusive)
201 "Test if BUFFER is a `next-error' capable buffer.
203 If AVOID-CURRENT is non-nil, treat the current buffer
204 as an absolute last resort only.
206 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
207 that normally would not qualify. If it returns t, the buffer
208 in question is treated as usable.
210 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
211 that would normally be considered usable. If it returns nil,
212 that buffer is rejected."
217 ;; Optionally reject some buffers.
220 t)
221 ;; Optionally accept some other buffers.
226 extra-test-inclusive
227 extra-test-exclusive)
228 "Return a `next-error' capable buffer.
230 If AVOID-CURRENT is non-nil, treat the current buffer
231 as an absolute last resort only.
233 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
234 that normally would not qualify. If it returns t, the buffer
235 in question is treated as usable.
237 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
238 that would normally be considered usable. If it returns nil,
239 that buffer is rejected."
241 ;; 1. If one window on the selected frame displays such buffer, return it.
247 avoid-current
248 extra-test-inclusive extra-test-exclusive)
253 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
256 extra-test-inclusive extra-test-exclusive))
257 next-error-last-buffer)
258 ;; 3. If the current buffer is acceptable, choose it.
260 extra-test-inclusive extra-test-exclusive)
262 ;; 4. Look for any acceptable buffer.
267 extra-test-inclusive extra-test-exclusive)))
270 ;; 5. Use the current buffer as a last resort if it qualifies,
271 ;; even despite AVOID-CURRENT.
274 extra-test-inclusive extra-test-exclusive)
278 ;; 6. Give up.
282 "Visit next `next-error' message and corresponding source code.
284 If all the error messages parsed so far have been processed already,
285 the message buffer is checked for new ones.
287 A prefix ARG specifies how many error messages to move;
288 negative means move back to previous error messages.
290 and start at the first error.
292 The RESET argument specifies that we should restart from the beginning.
295 compilation, grep, or occur buffer. It can also operate on any
297 more generally, on any buffer in Compilation mode or with
298 Compilation Minor mode enabled, or any buffer in which
299 `next-error-function' is bound to an appropriate function.
300 To specify use of a particular buffer for error messages, type
302 in the current frame.
305 runs `next-error-hook' with `run-hooks', and stays with that buffer
306 until you use it in some other buffer which uses Compilation mode
307 or Compilation Minor mode.
309 See variables `compilation-parse-errors-function' and
310 \`compilation-error-regexp-alist' for customization ideas."
314 ;; we know here that next-error-function is a valid symbol we can funcall
322 "Visit the source code corresponding to the `next-error' message at point."
324 ;; we know here that next-error-function is a valid symbol we can funcall
335 "Visit previous `next-error' message and corresponding source code.
337 Prefix arg N says how many error messages to move backwards (or
338 forwards, if negative).
345 "Restart at the first error.
346 Visit corresponding source code.
347 With prefix arg N, visit the source code of the Nth error.
353 "Move point to the next error in the `next-error' buffer and highlight match.
354 Prefix arg N says how many error messages to move forwards (or
355 backwards, if negative).
357 select the source buffer."
364 "Move point to the previous error in the `next-error' buffer and highlight match.
365 Prefix arg N says how many error messages to move backwards (or
366 forwards, if negative).
368 select the source buffer."
372 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
376 "Minor mode for compilation, occur and diff modes.
377 When turned on, cursor motion in the compilation, grep, occur or diff
378 buffer causes automatic display of the corresponding source code
379 location."
386 ;; Used as a `post-command-hook' by `next-error-follow-mode'
387 ;; for the *Compilation* *grep* and *Occur* buffers.
397 \f
398 ;;;
401 "Major mode not specialized for anything in particular.
402 Other major modes are defined by comparison with this one."
407 ;; Special major modes to view specially formatted data rather than files.
419 map))
423 "Parent major mode from which special major modes should inherit."
426 ;; Major mode meant to be the parent of programming modes.
431 map)
435 "Indent the expression after point."
442 "Major mode for editing programming language source code."
446 ;; Making and deleting lines.
452 "Insert a newline, and move to left margin of the new line if it's blank.
453 If `use-hard-newlines' is non-nil, the newline is marked with the
454 text-property `hard'.
455 With ARG, insert that many newlines.
456 Call `auto-fill-function' if the current column number is greater
457 than the value of `fill-column' and ARG is nil."
460 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
461 ;; Set last-command-event to tell self-insert what to insert.
465 ;; Don't auto-fill if we have a numeric argument.
468 ;; Do the rest in post-self-insert-hook, because we want to do it
469 ;; *before* other functions on that hook.
471 ;; Mark the newline(s) `hard'.
475 ;; If the newline leaves the previous line blank, and we
476 ;; have a left margin, delete that from the blank line.
484 ;; Indent the line after the newline, except in one case:
485 ;; when we added the newline at the beginning of a line which
486 ;; starts a page.
493 ;; We first used let-binding to protect the hook, but that was naive
494 ;; since add-hook affects the symbol-default value of the variable,
495 ;; whereas the let-binding might only protect the buffer-local value.
497 nil)
502 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
508 "Insert a newline and leave point before it.
509 If there is a fill prefix and/or a `left-margin', insert them
510 on the new line if the line would have been blank.
511 With arg N, insert N newlines."
516 ;; Don't expand an abbrev before point.
530 "Split current line, moving portion beyond point vertically down.
531 If the current line starts with `fill-prefix', insert it on the new
532 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
534 When called from Lisp code, ARG may be a prefix string to copy."
539 ;; What prefix should we check for (nil means don't).
543 ;; Does this line start with it?
554 "Join this line to previous and fix up whitespace at join.
555 If there is a fill prefix, delete it from the beginning of this line.
556 With argument, join this line to following line."
563 ;; If the second line started with the fill prefix,
564 ;; delete the prefix.
576 "On blank line, delete all surrounding blank lines, leaving just one.
577 On isolated blank line, delete that one.
578 On nonblank line, delete any immediately following blank lines."
584 ;; Set singleblank if there is just one blank line here.
591 ;; Delete preceding blank lines, and this one too if it's the only one.
600 ;; Delete following blank lines, unless the current line is blank
601 ;; and there are no following blank lines.
610 ;; Handle the special case where point is followed by newline and eob.
611 ;; Delete the line, leaving point at eob.
616 "Delete all the trailing whitespace across the current buffer.
617 All whitespace after the last non-whitespace character in a line is deleted.
619 A formfeed is not considered whitespace by this function."
626 ;; Don't delete formfeeds, even if they are considered whitespace.
633 "Insert a newline, then indent according to major mode.
634 Indentation is done using the value of `indent-line-function'.
635 In programming language modes, this is the same as TAB.
636 In some text modes, where TAB inserts a tab, this command indents to the
637 column specified by the function `current-left-margin'."
644 "Reindent current line, insert newline, then indent the new line.
645 Indentation of both lines is done according to the current major mode,
646 which means calling the current value of `indent-line-function'.
647 In programming language modes, this is the same as TAB.
648 In some text modes, where TAB inserts a tab, this indents to the
649 column specified by the function `current-left-margin'."
652 ;; Be careful to insert the newline before indenting the line.
653 ;; Otherwise, the indentation might be wrong.
657 ;; We are at EOL before the call to indent-according-to-mode, and
658 ;; after it we usually are as well, but not always. We tried to
659 ;; address it with `save-excursion' but that uses a normal marker
660 ;; whereas we need `move after insertion', so we do the save/restore
661 ;; by hand.
665 ;; Remove the trailing white-space after indentation because
666 ;; indentation may introduce the whitespace.
671 "Read next input character and insert it.
672 This is useful for inserting control characters.
673 With argument, insert ARG copies of the character.
675 If the first character you type after this command is an octal digit,
676 you should type a sequence of octal digits which specify a character code.
677 Any nondigit terminates the sequence. If the terminator is a RET,
678 it is discarded; any other terminator is used itself as input.
679 The variable `read-quoted-char-radix' specifies the radix for this feature;
680 set it to 10 or 16 to use decimal or hex instead of octal.
682 In overwrite mode, this function inserts the character anyway, and
683 does not handle octal digits specially. This means that if you use
684 overwrite as your normal editing mode, you can use this function to
685 insert characters when necessary.
687 In binary overwrite mode, this function does overwrite, and octal
688 digits are interpreted as a character code. This is intended to be
689 useful for editing binary files."
692 ;; Avoid "obsolete" warnings for translation-table-for-input.
699 ;; This used to assume character codes 0240 - 0377 stand for
700 ;; characters in some single-byte character set, and converted them
701 ;; to Emacs characters. But in 23.1 this feature is deprecated
702 ;; in favor of inserting the corresponding Unicode characters.
703 ;; (if (and enable-multibyte-characters
704 ;; (>= char ?\240)
705 ;; (<= char ?\377))
706 ;; (setq char (unibyte-char-to-multibyte char)))
715 "Move forward ARG lines and position at first nonblank character."
721 "Move backward ARG lines and position at first nonblank character."
727 "Move point to the first non-whitespace character on this line."
731 ;; Move back over chars that have whitespace syntax but have the p flag.
735 "Fixup white space between objects around point.
736 Leave one space or none, according to the context."
743 nil
747 "Delete all spaces and tabs around point.
748 If BACKWARD-ONLY is non-nil, only delete them before point."
753 orig-pos
762 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
776 \f
778 "Move point to the beginning of the buffer.
779 With numeric arg N, put point N/10 of the way from the beginning.
780 If the buffer is narrowed, this command uses the beginning of the
781 accessible part of the buffer.
783 If Transient Mark mode is disabled, leave mark at previous
786 Don't use this command in Lisp programs!
787 \(goto-char (point-min)) is faster."
796 ;; Avoid overflow for large buffer sizes!
804 "Move point to the end of the buffer.
805 With numeric arg N, put point N/10 of the way from the end.
806 If the buffer is narrowed, this command uses the end of the
807 accessible part of the buffer.
809 If Transient Mark mode is disabled, leave mark at previous
812 Don't use this command in Lisp programs!
813 \(goto-char (point-max)) is faster."
820 ;; Avoid overflow for large buffer sizes!
825 ;; If we went to a place in the middle of the buffer,
826 ;; adjust it to the beginning of a line.
829 ;; If the end of the buffer is not already on the screen,
830 ;; then scroll specially to put it near, but not at, the bottom.
835 "Whether single-char deletion commands delete an active region.
836 This has an effect only if Transient Mark mode is enabled, and
837 affects `delete-forward-char' and `delete-backward-char', though
838 not `delete-char'.
840 If the value is the symbol `kill', the active region is killed
841 instead of deleted."
849 "Delete the previous N characters (following if N is negative).
850 If Transient Mark mode is enabled, the mark is active, and N is 1,
851 delete the text in the region and deactivate the mark instead.
852 To disable this, set `delete-active-region' to nil.
854 Optional second arg KILLFLAG, if non-nil, means to kill (save in
855 kill ring) instead of delete. Interactively, N is the prefix
856 arg, and KILLFLAG is set if N is explicitly specified.
858 In Overwrite mode, single character backward deletion may replace
859 tabs with spaces so as to back over columns, unless point is at
860 the end of the line."
865 delete-active-region
867 ;; If a region is active, kill or delete it.
871 ;; In Overwrite mode, maybe untabify while deleting
881 ;; Otherwise, do simple deletion.
885 "Delete the following N characters (previous if N is negative).
886 If Transient Mark mode is enabled, the mark is active, and N is 1,
887 delete the text in the region and deactivate the mark instead.
888 To disable this, set `delete-active-region' to nil.
890 Optional second arg KILLFLAG non-nil means to kill (save in kill
891 ring) instead of delete. Interactively, N is the prefix arg, and
892 KILLFLAG is set if N was explicitly specified."
897 delete-active-region
899 ;; If a region is active, kill or delete it.
903 ;; Otherwise, do simple deletion.
907 "Put point at beginning and mark at end of buffer.
908 You probably should not use this function in Lisp programs;
909 it is usually a mistake for a Lisp function to use any subroutine
910 that uses or sets the mark."
915 \f
917 ;; Counting lines, one way or another.
920 "Goto LINE, counting from line 1 at beginning of buffer.
921 Normally, move point in the current buffer, and leave mark at the
923 move point in the most recently selected other buffer, and switch to it.
925 If there's a number in the buffer at point, it is the default for LINE.
927 This function is usually the wrong thing to use in a Lisp program.
928 What you probably want instead is something like:
929 (goto-char (point-min)) (forward-line (1- N))
930 If at all possible, an even better solution is to use char counts
931 rather than line counts."
935 ;; Look for a default, a number in the buffer at point.
944 ;; Decide if we're switching buffers.
952 ;; Read the argument, offering that number (if any) as default.
955 buffer-prompt
956 default)
957 nil nil t
958 'minibuffer-history
959 default)
960 buffer))))
961 ;; Switch to the desired buffer, one way or another.
966 ;; Leave mark at previous position
968 ;; Move to the specified line number in that buffer.
977 "Print the number of words in the region.
978 When called interactively, the word count is printed in echo area."
989 count))
992 "Print number of lines and characters in the region."
998 "Print the current buffer line number and narrowed line number of point."
1011 "Return number of lines between START and END.
1012 This is usually the number of newlines between them,
1013 but can be one more if START is not equal to END
1014 and the greater of them is not at the start of a line."
1030 done)))
1034 "Return (narrowed) buffer line number at position POS.
1035 If POS is nil, use current buffer location.
1036 Counting starts at (point-min), so the value refers
1037 to the contents of the accessible portion of the buffer."
1047 "Print info on cursor position (on screen and within buffer).
1048 Also describe the character after point, and give its character code
1049 in octal, decimal and hex.
1051 For a non-ASCII multibyte character, also give its encoding in the
1052 buffer's selected coding system if the coding system encodes the
1053 character safely. If the character is encoded into one byte, that
1054 code is shown in hex. If the character is encoded into more than one
1057 In addition, with prefix argument, show details about that character
1058 in *Help* buffer. See also the command `describe-char'."
1066 ;; Avoid overflow from multiplying by 100!
1070 ""
1076 pos total percent beg end col hscroll)
1078 pos total col hscroll))
1080 encoded encoding-msg display-prop under-display)
1087 ;; Check if the character is displayed with some `display'
1088 ;; text property. In that case, set under-display to the
1089 ;; buffer substring covered by that property.
1100 under-display)))
1106 char char char under-display)
1108 char char char under-display display-prop))
1111 char char char
1113 "..."
1117 ;; We show the detailed information about CHAR.
1124 encoding-msg pos total percent beg end col hscroll)
1131 encoding-msg pos total percent col hscroll))))))
1132 \f
1133 ;; Initialize read-expression-map. It is defined at C level.
1145 "The current default value or list of default values in the minibuffer.
1146 The functions `read-from-minibuffer' and `completing-read' bind
1150 "Value for `print-level' while printing value in `eval-expression'.
1151 A value of nil means no limit."
1157 "Value for `print-length' while printing value in `eval-expression'.
1158 A value of nil means no limit."
1164 "If non-nil set `debug-on-error' to t in `eval-expression'.
1165 If nil, don't change the value of `debug-on-error'."
1171 "Format VALUE as a result of evaluated expression.
1172 Return a formatted string which is displayed in the echo area
1173 in addition to the value printed by prin1 in functions which
1174 display the result of expression evaluation."
1187 ;; We define this, rather than making `eval' interactive,
1188 ;; for the sake of completion of names like eval-region, eval-buffer.
1191 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1192 Value is also consed on to front of the variable `values'.
1193 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1194 with prefix argument) means insert the result into the current buffer
1195 instead of printing it in the echo area. Truncates long output
1196 according to the value of the variables `eval-expression-print-length'
1197 and `eval-expression-print-level'.
1199 If `eval-expression-debug-on-error' is non-nil, which is the default,
1200 this command arranges for all errors to enter the debugger."
1204 nil read-expression-map t
1206 current-prefix-arg))
1211 ;; Bind debug-on-error to something unique so that we can
1212 ;; detect when evaled code changes it.
1216 ;; If evaled code has changed the value of debug-on-error,
1217 ;; propagate that change to the global binding.
1233 "Prompting with PROMPT, let user edit COMMAND and eval result.
1234 COMMAND is a Lisp expression. Let user edit that expression in
1235 the minibuffer, then read and evaluate the result."
1242 read-expression-map t
1244 ;; If command was added to command-history as a string,
1245 ;; get rid of that. We want only evaluable expressions there.
1249 ;; If command to be redone does not match front of history,
1250 ;; add it to the history.
1256 "Edit and re-evaluate last complex command, or ARGth from last.
1257 A complex command is one which used the minibuffer.
1258 The command is placed in the minibuffer as a Lisp form for editing.
1259 The result is executed, repeating the command as changed.
1260 If the command has been changed or is not the most recent previous
1261 command it is added to the front of the command history.
1262 You can use the minibuffer history commands \
1264 to get different commands to edit and resubmit."
1267 newcmd)
1279 ;; If command was added to command-history as a
1280 ;; string, get rid of that. We want only
1281 ;; evaluable expressions there.
1285 ;; If command to be redone does not match front of history,
1286 ;; add it to the history.
1295 "Read command name to invoke in `execute-extended-command'."
1300 ;; Get a command name at point in the original buffer
1301 ;; to propose it after M-n.
1305 ;; Read a string, completing from and restricting to the set of
1306 ;; all defined commands. Don't provide any initial input.
1307 ;; Save the command read on the extended-command history list.
1318 ;; This isn't strictly correct if `execute-extended-command'
1319 ;; is bound to anything else (e.g. [menu]).
1320 ;; It could use (key-description (this-single-command-keys)),
1321 ;; but actually a prompt other than "M-x" would be confusing,
1322 ;; because "M-x" is a well-known prompt to read a command
1323 ;; and it serves as a shorthand for "Extended command: ".
1327 \f
1329 "Default minibuffer history list.
1330 This is used for all minibuffer input
1331 except when an alternate history list is specified.
1333 Maximum length of the history list is determined by the value
1336 "Control whether history list elements are expressions or strings.
1337 If the value of this variable equals current minibuffer depth,
1338 they are expressions; otherwise they are strings.
1339 \(That convention is designed to do the right thing for
1346 "Text that was in this minibuffer before any history commands.
1347 This is nil if there have not yet been any history commands
1356 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1360 "Minibuffer history variables for which matching should ignore case.
1361 If a history variable is a member of this list, then the
1363 commands ignore case when searching it, regardless of `case-fold-search'."
1368 "Find the previous history element that matches REGEXP.
1369 \(Previous history elements refer to earlier actions.)
1370 With prefix argument N, search for Nth previous match.
1371 If N is negative, find the next or Nth next match.
1372 Normally, history elements are matched case-insensitively if
1373 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1374 makes the search case-sensitive.
1375 See also `minibuffer-history-case-insensitive-variables'."
1379 nil
1380 minibuffer-local-map
1381 nil
1382 'minibuffer-history-search-history
1384 ;; Use the last regexp specified, by default, if input is empty.
1389 regexp)
1399 ;; On some systems, ignore case for file names.
1401 minibuffer-history-case-insensitive-variables)
1402 t
1403 ;; Respect the user's setting for case-fold-search:
1404 case-fold-search)
1405 nil))
1406 prevpos
1407 match-string
1408 match-offset
1415 "No later matching history item"
1436 next-matching-history-element))
1440 "Find the next history element that matches REGEXP.
1441 \(The next history element refers to a more recent action.)
1442 With prefix argument N, search for Nth next match.
1443 If N is negative, find the previous or Nth previous match.
1444 Normally, history elements are matched case-insensitively if
1445 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1446 makes the search case-sensitive."
1450 nil
1451 minibuffer-local-map
1452 nil
1453 'minibuffer-history-search-history
1455 ;; Use the last regexp specified, by default, if input is empty.
1460 regexp)
1467 "Function run by `goto-history-element' before consuming default values.
1468 This is useful to dynamically add more elements to the list of default values
1469 when `goto-history-element' reaches the end of this list.
1470 Before calling this function `goto-history-element' sets the variable
1471 `minibuffer-default-add-done' to t, so it will call this function only
1472 once. In special cases, when this function needs to be called more
1473 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1477 "When nil, add more elements to the end of the list of default values.
1478 The value nil causes `goto-history-element' to add more elements to
1479 the list of defaults when it reaches the end of this list. It does
1485 "Return a list of all completions without the default value.
1486 This function is used to add all elements of the completion table to
1487 the end of the list of defaults just after the default value."
1490 minibuffer-completion-table
1491 minibuffer-completion-predicate)))
1497 "Puts element of the minibuffer history in the minibuffer.
1498 The argument NABS specifies the absolute history position."
1512 elt minibuffer-returned-to-present)
1524 previous-history-element))
1536 minibuffer-default)))
1548 elt))
1552 "Puts next element of the minibuffer history in the minibuffer.
1553 With argument N, it uses the Nth following element."
1559 "Puts previous element of the minibuffer history in the minibuffer.
1560 With argument N, it uses the Nth previous element."
1566 "Get next history element which completes the minibuffer before the point.
1567 The contents of the minibuffer after the point are deleted, and replaced
1568 by the new completion."
1574 n)
1575 ;; next-matching-history-element always puts us at (point-min).
1576 ;; Move to the position we were at before changing the buffer contents.
1577 ;; This is still sensical, because the text before point has not changed.
1581 "\
1582 Get previous history element which completes the minibuffer before the point.
1583 The contents of the minibuffer after the point are deleted, and replaced
1584 by the new completion."
1588 ;; For compatibility with the old subr of the same name.
1590 "Return the display width of the minibuffer prompt.
1591 Return 0 if current buffer is not a minibuffer."
1592 ;; Return the width of everything before the field at the end of
1593 ;; the buffer; this should be 0 for normal buffers.
1595 \f
1596 ;; isearch minibuffer history
1603 "Set up a minibuffer for using isearch to search the minibuffer history.
1604 Intended to be added to `minibuffer-setup-hook'."
1616 "Clean up the minibuffer after terminating isearch in the minibuffer."
1621 "Return the proper search function, for isearch in minibuffer history."
1628 ;; Use standard functions to search within minibuffer text
1634 found)
1635 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1636 ;; searching forward. Lazy-highlight calls this lambda with the
1637 ;; bound arg, so skip the minibuffer prompt.
1641 ;; 1. First try searching in the initial minibuffer text
1644 noerror)
1645 ;; 2. If the above search fails, start putting next/prev history
1646 ;; elements in the minibuffer successively, and search the string
1647 ;; in them. Do this only when bound is nil (i.e. not while
1648 ;; lazy-highlighting search strings in the current minibuffer text).
1660 ;; After putting the next/prev history element, search
1661 ;; the string in them again, until next-history-element
1662 ;; or previous-history-element raises an error at the
1663 ;; beginning/end of history.
1666 ;; For backward search, don't search
1667 ;; in the minibuffer prompt
1669 noerror)))
1670 ;; Return point of the new search result
1672 ;; Return nil when next(prev)-history-element fails
1676 "Display the minibuffer history search prompt.
1677 If there are no search errors, this function displays an overlay with
1678 the isearch prompt which replaces the original minibuffer prompt.
1679 Otherwise, it displays the standard isearch message returned from
1680 `isearch-message'."
1682 ;; Use standard function `isearch-message' when not in the minibuffer,
1683 ;; or search fails, or has an error (like incomplete regexp).
1684 ;; This function overwrites minibuffer text with isearch message,
1685 ;; so it's possible to see what is wrong in the search string.
1687 ;; Otherwise, put the overlay with the standard isearch prompt over
1688 ;; the initial minibuffer prompt.
1697 ;; And clear any previous isearch message.
1701 "Wrap the minibuffer history search when search fails.
1702 Move point to the first history element for a forward search,
1703 or to the last history element for a backward search."
1705 ;; When `minibuffer-history-isearch-search' fails on reaching the
1706 ;; beginning/end of the history, wrap the search to the first/last
1707 ;; minibuffer history element.
1715 "Save a function restoring the state of minibuffer history search.
1716 Save `minibuffer-history-position' to the additional state parameter
1717 in the search status stack."
1722 "Restore the minibuffer history search state.
1723 Go to the history element by the absolute history position HIST-POS."
1726 \f
1727 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1731 "Table mapping redo records to the corresponding undo one.
1732 A redo record for undo-in-region maps to t.
1742 "Within a run of consecutive undo commands, list remaining to be undone.
1746 "Undo some previous changes.
1747 Repeat this command to undo more changes.
1748 A numeric ARG serves as a repeat count.
1750 In Transient Mark mode when the mark is active, only undo changes within
1752 as an argument limits undo to changes within the current region."
1754 ;; Make last-command indicate for the next command that this was an undo.
1755 ;; That way, another undo will undo more.
1756 ;; If we get to the end of the undo history and get an error,
1757 ;; another undo command will find the undo history empty
1758 ;; and will get another error. To begin undoing the undos,
1759 ;; you must type some other command.
1762 message)
1763 ;; If we get an error in undo-start,
1764 ;; the next command should not be a "consecutive undo".
1765 ;; So set `this-command' to something other than `undo'.
1770 ;; If something (a timer or filter?) changed the buffer
1771 ;; since the previous command, don't continue the undo seq.
1775 ;; If the last undo record made was made by undo
1776 ;; it shows nothing else happened in between.
1783 ;; get rid of initial undo boundary
1785 ;; If we got this far, the next command should be a consecutive undo.
1787 ;; Check to see whether we're hitting a redo record, and if
1788 ;; so, ask the user whether she wants to skip the redo/undo pair.
1795 ;; The equiv entry might point to another redo record if we have done
1796 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1804 ;; Record the fact that the just-generated undo records come from an
1805 ;; undo operation--that is, they are redo records.
1806 ;; In the ordinary case (not within a region), map the redo
1807 ;; record to the following undos.
1808 ;; I don't know how to do that in the undo-in-region case.
1810 ;; Strip any leading undo boundaries there might be, like we do
1811 ;; above when checking.
1815 undo-equiv-table))
1816 ;; Don't specify a position in the undo record for the undo command.
1817 ;; Instead, undoing this should move point to where the change is.
1836 ;; Record what the current undo list says,
1837 ;; so the next command can tell if the buffer was modified in between.
1840 ;; Display a message announcing success.
1845 "Make BUFFER stop keeping undo information.
1846 No argument or nil as argument means do this for the current buffer."
1852 "Undo some previous changes.
1853 Repeat this command to undo more changes.
1854 A numeric ARG serves as a repeat count.
1855 Contrary to `undo', this will not redo a previous undo."
1860 "Non-nil while performing an undo.
1864 "Undo back N undo-boundaries beyond what was already undone recently.
1865 Call `undo-start' to get ready to undo recent changes,
1866 then call `undo-more' one or more times to undo them."
1871 ;; Note: The following, while pulling elements off
1872 ;; `pending-undo-list' will call primitive change functions which
1873 ;; will push more elements onto `buffer-undo-list'.
1878 ;; Deep copy of a list
1880 "Make a copy of undo list LIST."
1886 elt))
1889 "Set `pending-undo-list' to the front of the undo list.
1890 The next call to `undo-more' will undo the most recently made change.
1891 If BEG and END are specified, then only undo elements
1892 that apply to text between BEG and END are used; other undo elements
1893 are ignored. If BEG and END are nil, all undo elements are used."
1899 buffer-undo-list)))
1904 "Return a list of undo elements for the region START to END.
1905 The elements come from `buffer-undo-list', but we keep only
1906 the elements inside this region, and discard those outside this region.
1907 If we find an element that crosses an edge of this region,
1908 we stop and ignore all further elements."
1911 undo-adjusted-markers
1912 some-rejected
1913 undo-elt undo-elt temp-undo-list delta)
1918 ;; This is a "was unmodified" element.
1919 ;; Keep it if we have kept everything thus far.
1926 ;; Don't put two nils together in the list
1940 ;; Loop down the earlier events adjusting their buffer
1941 ;; positions to reflect the fact that a change to the buffer
1942 ;; isn't being undone. We only need to process those element
1943 ;; types which undo-elt-in-region will return as being in
1944 ;; the region since only those types can ever get into the
1945 ;; output
1954 ;; (TEXT . POSITION)
1961 ;; (BEGIN . END)
1966 ;; (nil PROPERTY VALUE BEG . END)
1976 "Determine whether UNDO-ELT falls inside the region START ... END.
1977 If it crosses the edge, we return nil."
1982 t)
1984 nil)
1986 ;; (TEXT . POSITION)
1990 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1991 ;; See if MARKER is inside the region.
2002 ;; (nil PROPERTY VALUE BEG . END)
2007 ;; (BEGIN . END)
2012 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2013 This assumes we have already decided that UNDO-ELT
2014 is not *inside* the region START...END."
2017 ;; (nil PROPERTY VALUE BEG . END)
2022 ;; (BEGIN . END)
2026 ;; Return the first affected buffer position and the delta for an undo element
2027 ;; delta is defined as the change in subsequent buffer positions if we *did*
2028 ;; the undo.
2032 ;; (TEXT . POSITION)
2035 ;; (BEGIN . END)
2042 "If non-nil ask about discarding undo info for the current command.
2043 Normally, Emacs discards the undo info for the current command if
2044 it exceeds `undo-outer-limit'. But if you set this option
2045 non-nil, it asks in the echo area whether to discard the info.
2046 If you answer no, there is a slight risk that Emacs might crash, so
2047 only do it if you really want to undo the command.
2049 This option is mainly intended for debugging. You have to be
2050 careful if you use it for other purposes. Garbage collection is
2051 inhibited while the question is asked, meaning that Emacs might
2052 leak memory. So you should make sure that you do not wait
2053 excessively long before answering the question."
2059 "If non-nil, an extra level of size that's ok in an undo item.
2060 We don't ask the user about truncating the undo list until the
2061 current item gets bigger than this amount.
2066 ;; When the first undo batch in an undo list is longer than
2067 ;; undo-outer-limit, this function gets called to warn the user that
2068 ;; the undo info for the current command was discarded. Garbage
2069 ;; collection is inhibited around the call, so it had better not do a
2070 ;; lot of consing.
2076 ;; Don't ask the question again unless it gets even bigger.
2077 ;; This applies, in particular, if the user quits from the question.
2078 ;; Such a quit quits out of GC, but something else will call GC
2079 ;; again momentarily. It will call this function again,
2080 ;; but we don't want to ask the question again.
2087 t)
2088 nil))
2093 "The undo info was discarded because it exceeded \
2094 `undo-outer-limit'.
2096 This is normal if you executed a command that made a huge change
2097 to the buffer. In that case, to prevent similar problems in the
2098 future, set `undo-outer-limit' to a value that is large enough to
2099 cover the maximum size of normal changes you expect a single
2100 command to make, but not so large that it might exceed the
2101 maximum memory allotted to Emacs.
2103 If you did not execute any such command, the situation is
2104 probably due to a bug and you should report it.
2106 You can disable the popping up of this buffer by adding the entry
2107 \(undo discard-info) to the user option `warning-suppress-types',
2111 t))
2112 \f
2114 "History list for some commands that read shell commands.
2116 Maximum length of the history list is determined by the value
2123 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2124 This buffer is used when `shell-command' or `shell-command-on-region'
2125 is run interactively. A value of nil means that output to stderr and
2132 "Return a list of all commands associated with the current file.
2133 This function is used to add all related commands retrieved by `mailcap'
2134 to the end of the list of defaults just after the default value."
2138 minibuffer-default))
2143 commands))
2153 "Dynamically complete shell command at point."
2165 map)
2169 "Read a shell command from the minibuffer.
2170 The arguments are the same as the ones of `read-from-minibuffer',
2171 except READ and KEYMAP are missing and HIST defaults
2172 to `shell-command-history'."
2178 minibuffer-local-shell-command-map
2179 nil
2181 args)))
2184 "Execute string COMMAND asynchronously in background.
2186 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2187 surrounded by whitespace and executes the command asynchronously.
2188 The output appears in the buffer `*Async Shell Command*'.
2190 In Elisp, you will often be better served by calling `start-process'
2191 directly, since it offers more control and does not impose the use of a
2192 shell (with its need to quote arguments)."
2198 current-prefix-arg
2199 shell-command-default-error-buffer))
2205 "Execute string COMMAND in inferior shell; display output, if any.
2206 With prefix argument, insert the COMMAND's output at point.
2208 If COMMAND ends in ampersand, execute it asynchronously.
2209 The output appears in the buffer `*Async Shell Command*'.
2210 That buffer is in shell mode.
2212 Otherwise, COMMAND is executed synchronously. The output appears in
2213 the buffer `*Shell Command Output*'. If the output is short enough to
2214 display in the echo area (which is determined by the variables
2215 `resize-mini-windows' and `max-mini-window-height'), it is shown
2216 there, but it is nonetheless available in buffer `*Shell Command
2217 Output*' even though that buffer is not automatically displayed.
2219 To specify a coding system for converting non-ASCII characters
2221 before this command.
2223 Noninteractive callers can specify coding systems by binding
2224 `coding-system-for-read' and `coding-system-for-write'.
2226 The optional second argument OUTPUT-BUFFER, if non-nil,
2227 says to put the output in some other buffer.
2228 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2229 If OUTPUT-BUFFER is not a buffer and not nil,
2230 insert output in current buffer. (This cannot be done asynchronously.)
2231 In either case, the buffer is first erased, and the output is
2232 inserted after point (leaving mark after it).
2234 If the command terminates without error, but generates output,
2236 the output can be displayed in the echo area or in its buffer.
2237 If the output is short enough to display in the echo area
2238 \(determined by the variable `max-mini-window-height' if
2239 `resize-mini-windows' is non-nil), it is shown there.
2240 Otherwise,the buffer containing the output is displayed.
2244 of the output.
2246 If there is no output, or if output is inserted in the current buffer,
2247 then `*Shell Command Output*' is deleted.
2249 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2250 or buffer name to which to direct the command's standard error output.
2251 If it is nil, error output is mingled with regular output.
2252 In an interactive call, the variable `shell-command-default-error-buffer'
2253 specifies the value of ERROR-BUFFER.
2255 In Elisp, you will often be better served by calling `call-process' or
2256 `start-process' directly, since it offers more control and does not impose
2257 the use of a shell (with its need to quote arguments)."
2268 current-prefix-arg
2269 shell-command-default-error-buffer))
2270 ;; Look for a handler in case default-directory is a remote file name.
2278 ;; Output goes in current buffer.
2284 temporary-file-directory)))
2285 nil)))
2288 ;; We do not use -f for csh; we will not support broken use of
2289 ;; .cshrcs. Even the BSD csh manual says to use
2290 ;; "if ($?prompt) exit" before things which are not useful
2291 ;; non-interactively. Besides, if someone wants their other
2292 ;; aliases for shell commands then they can still have them.
2296 t)
2297 nil shell-command-switch command)
2304 ;; Do no formatting while reading error file,
2305 ;; because that can run a shell command, and we
2306 ;; don't want that to cause an infinite recursion.
2308 ;; Put point after the inserted errors.
2312 ;; This is like exchange-point-and-mark, but doesn't
2313 ;; activate the mark. It is cleaner to avoid activation,
2314 ;; even though the command loop would deactivate the mark
2315 ;; because we inserted text.
2319 ;; Output goes in a separate buffer.
2320 ;; Preserve the match data in case called from a program.
2323 ;; Command ending with ampersand means asynchronous.
2327 proc)
2328 ;; Remove the ampersand.
2330 ;; If will kill a process, query first.
2342 shell-command-switch command))
2346 ;; Use the comint filter for proper handling of carriage motion
2347 ;; (see `comint-inhibit-carriage-motion'),.
2349 ))
2350 ;; Otherwise, command is executed synchronously.
2352 output-buffer nil error-buffer)))))))
2356 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2357 MESSAGE may be either a string or a buffer.
2359 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2360 the maximum height of the echo area, as defined by `max-mini-window-height'
2361 if `resize-mini-windows' is non-nil.
2363 Returns either the string shown in the echo area, or when a pop-up
2364 buffer is used, the window used to display it.
2366 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2367 name of the buffer used to display it in the case where a pop-up buffer
2368 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2369 string and it is displayed in the echo area, it is not specified whether
2370 the contents are inserted into the buffer anyway.
2372 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2373 and only used if a buffer is displayed."
2375 ;; Trivial case where we can use the echo area
2379 ;; Trivial case where we can just remove single trailing newline
2382 ;; General case
2385 message
2394 0
2398 (<= lines
2402 max-mini-window-height))
2404 max-mini-window-height)
2408 ;; Don't use the echo area if the output buffer is
2409 ;; already dispayed in the selected frame.
2411 ;; Echo area
2417 ;; Buffer
2420 not-this-window frame))))))))
2423 ;; We have a sentinel to prevent insertion of a termination message
2424 ;; in the buffer itself.
2432 &optional output-buffer replace
2433 error-buffer display-error-buffer)
2434 "Execute string COMMAND in inferior shell with region as input.
2435 Normally display output (if any) in temp buffer `*Shell Command Output*';
2436 Prefix arg means replace the region with it. Return the exit code of
2437 COMMAND.
2439 To specify a coding system for converting non-ASCII characters
2441 before this command. By default, the input (from the current buffer)
2442 is encoded in the same coding system that will be used to save the file,
2443 `buffer-file-coding-system'. If the output is going to replace the region,
2444 then it is decoded from that same coding system.
2446 The noninteractive arguments are START, END, COMMAND,
2447 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2448 Noninteractive callers can specify coding systems by binding
2449 `coding-system-for-read' and `coding-system-for-write'.
2451 If the command generates output, the output may be displayed
2452 in the echo area or in a buffer.
2453 If the output is short enough to display in the echo area
2454 \(determined by the variable `max-mini-window-height' if
2455 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2456 it is displayed in the buffer `*Shell Command Output*'. The output
2457 is available in that buffer in both cases.
2459 If there is output and an error, a message about the error
2460 appears at the end of the output.
2462 If there is no output, or if output is inserted in the current buffer,
2463 then `*Shell Command Output*' is deleted.
2465 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2466 that says to put the output in some other buffer.
2467 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2468 If OUTPUT-BUFFER is not a buffer and not nil,
2469 insert output in the current buffer.
2470 In either case, the output is inserted after point (leaving mark after it).
2472 If REPLACE, the optional fifth argument, is non-nil, that means insert
2473 the output in place of text from START to END, putting point and mark
2474 around it.
2476 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2477 or buffer name to which to direct the command's standard error output.
2478 If it is nil, error output is mingled with regular output.
2479 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2480 were any errors. (This is always t, interactively.)
2481 In an interactive call, the variable `shell-command-default-error-buffer'
2482 specifies the value of ERROR-BUFFER."
2486 ;; Do this before calling region-beginning
2487 ;; and region-end, in case subprocess output
2488 ;; relocates them while we are in the minibuffer.
2490 ;; call-interactively recognizes region-beginning and
2491 ;; region-end specially, leaving them in the history.
2493 string
2494 current-prefix-arg
2495 current-prefix-arg
2496 shell-command-default-error-buffer
2497 t)))
2503 temporary-file-directory)))
2504 nil))
2505 exit-status)
2509 ;; Replace specified region with output from command.
2511 ;; Don't muck with mark unless REPLACE says we should.
2518 t)
2519 nil shell-command-switch command))
2520 ;; It is rude to delete a buffer which the command is not using.
2521 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2522 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2523 ;; (kill-buffer shell-buffer)))
2524 ;; Don't muck with mark unless REPLACE says we should.
2526 ;; No prefix argument: put the output in a temp buffer,
2527 ;; replacing its entire contents.
2532 ;; If the input is the same buffer as the output,
2533 ;; delete everything but the specified region,
2534 ;; then replace that region with the output.
2540 shell-file-name t
2543 t)
2544 nil shell-command-switch
2545 command)))
2546 ;; Clear the output buffer, then run the command with
2547 ;; output there.
2558 buffer)
2559 nil shell-command-switch command)))
2560 ;; Report the output.
2570 ;; There's some output, display it
2572 ;; No output; error?
2576 "some error output"
2582 output))
2585 exit-status))
2588 exit-status output))))
2589 ;; Don't kill: there might be useful info in the undo-log.
2590 ;; (kill-buffer buffer)
2591 ))))
2599 ;; Do no formatting while reading error file,
2600 ;; because that can run a shell command, and we
2601 ;; don't want that to cause an infinite recursion.
2603 ;; Put point after the inserted errors.
2608 exit-status))
2611 "Execute shell command COMMAND and return its output as a string."
2614 standard-output
2618 "Process files synchronously in a separate process.
2619 Similar to `call-process', but may invoke a file handler based on
2620 `default-directory'. The current working directory of the
2621 subprocess is `default-directory'.
2623 File names in INFILE and BUFFER are handled normally, but file
2624 names in ARGS should be relative to `default-directory', as they
2625 are passed to the process verbatim. \(This is a difference to
2626 `call-process' which does not support file handlers for INFILE
2627 and BUFFER.\)
2629 Some file handlers might not support all variants, for example
2630 they might behave as if DISPLAY was nil, regardless of the actual
2631 value passed."
2633 lc stderr-file)
2643 display args)
2649 "Whether a call of `process-file' changes remote files.
2651 Per default, this variable is always set to `t', meaning that a
2652 call of `process-file' could potentially change any file on a
2653 remote host. When set to `nil', a file handler could optimize
2654 its behaviour with respect to remote file attributes caching.
2656 This variable should never be changed by `setq'. Instead of, it
2660 "Start a program in a subprocess. Return the process object for it.
2662 Similar to `start-process', but may invoke a file handler based on
2663 `default-directory'. See Info node `(elisp)Magic File Names'.
2665 This handler ought to run PROGRAM, perhaps on the local host,
2666 perhaps on a remote host that corresponds to `default-directory'.
2667 In the latter case, the local part of `default-directory' becomes
2668 the working directory of the process.
2670 PROGRAM and PROGRAM-ARGS might be file names. They are not
2671 objects of file handler invocation. File handlers might not
2672 support pty association, if PROGRAM is nil."
2677 \f
2681 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2682 (define-key map [switch-frame] nil)
2683 (define-key map [?\C-u] 'universal-argument-more)
2684 (define-key map [?-] 'universal-argument-minus)
2685 (define-key map [?0] 'digit-argument)
2686 (define-key map [?1] 'digit-argument)
2687 (define-key map [?2] 'digit-argument)
2688 (define-key map [?3] 'digit-argument)
2689 (define-key map [?4] 'digit-argument)
2690 (define-key map [?5] 'digit-argument)
2691 (define-key map [?6] 'digit-argument)
2692 (define-key map [?7] 'digit-argument)
2693 (define-key map [?8] 'digit-argument)
2694 (define-key map [?9] 'digit-argument)
2695 (define-key map [kp-0] 'digit-argument)
2696 (define-key map [kp-1] 'digit-argument)
2697 (define-key map [kp-2] 'digit-argument)
2698 (define-key map [kp-3] 'digit-argument)
2699 (define-key map [kp-4] 'digit-argument)
2700 (define-key map [kp-5] 'digit-argument)
2701 (define-key map [kp-6] 'digit-argument)
2702 (define-key map [kp-7] 'digit-argument)
2703 (define-key map [kp-8] 'digit-argument)
2704 (define-key map [kp-9] 'digit-argument)
2705 (define-key map [kp-subtract] 'universal-argument-minus)
2706 map)
2709 (defvar universal-argument-num-events nil
2710 "Number of argument-specifying events read by `universal-argument'.
2711 `universal-argument-other-key' uses this to discard those events
2712 from (this-command-keys), and reread only the final command.")
2714 (defvar overriding-map-is-bound nil
2715 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2717 (defvar saved-overriding-map nil
2718 "The saved value of `overriding-terminal-local-map'.
2722 (defun ensure-overriding-map-is-bound ()
2723 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2724 (unless overriding-map-is-bound
2725 (setq saved-overriding-map overriding-terminal-local-map)
2726 (setq overriding-terminal-local-map universal-argument-map)
2727 (setq overriding-map-is-bound t)))
2729 (defun restore-overriding-map ()
2730 "Restore `overriding-terminal-local-map' to its saved value."
2731 (setq overriding-terminal-local-map saved-overriding-map)
2732 (setq overriding-map-is-bound nil))
2734 (defun universal-argument ()
2735 "Begin a numeric argument for the following command.
2740 multiplies the argument by 4 each time.
2742 which is different in effect from any particular numeric argument.
2744 (interactive)
2745 (setq prefix-arg (list 4))
2746 (setq universal-argument-num-events (length (this-command-keys)))
2747 (ensure-overriding-map-is-bound))
2749 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2750 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2751 (defun universal-argument-more (arg)
2752 (interactive "P")
2753 (if (consp arg)
2754 (setq prefix-arg (list (* 4 (car arg))))
2755 (if (eq arg '-)
2756 (setq prefix-arg (list -4))
2757 (setq prefix-arg arg)
2758 (restore-overriding-map)))
2759 (setq universal-argument-num-events (length (this-command-keys))))
2761 (defun negative-argument (arg)
2762 "Begin a negative numeric argument for the next command.
2764 (interactive "P")
2765 (cond ((integerp arg)
2766 (setq prefix-arg (- arg)))
2767 ((eq arg '-)
2768 (setq prefix-arg nil))
2769 (t
2770 (setq prefix-arg '-)))
2771 (setq universal-argument-num-events (length (this-command-keys)))
2772 (ensure-overriding-map-is-bound))
2774 (defun digit-argument (arg)
2775 "Part of the numeric argument for the next command.
2777 (interactive "P")
2778 (let* ((char (if (integerp last-command-event)
2779 last-command-event
2780 (get last-command-event 'ascii-character)))
2782 (cond ((integerp arg)
2783 (setq prefix-arg (+ (* arg 10)
2784 (if (< arg 0) (- digit) digit))))
2785 ((eq arg '-)
2786 ;; Treat -0 as just -, so that -01 will work.
2787 (setq prefix-arg (if (zerop digit) '- (- digit))))
2788 (t
2789 (setq prefix-arg digit))))
2790 (setq universal-argument-num-events (length (this-command-keys)))
2791 (ensure-overriding-map-is-bound))
2793 ;; For backward compatibility, minus with no modifiers is an ordinary
2794 ;; command if digits have already been entered.
2795 (defun universal-argument-minus (arg)
2796 (interactive "P")
2797 (if (integerp arg)
2798 (universal-argument-other-key arg)
2799 (negative-argument arg)))
2801 ;; Anything else terminates the argument and is left in the queue to be
2802 ;; executed as a command.
2803 (defun universal-argument-other-key (arg)
2804 (interactive "P")
2805 (setq prefix-arg arg)
2806 (let* ((key (this-command-keys))
2807 (keylist (listify-key-sequence key)))
2808 (setq unread-command-events
2809 (append (nthcdr universal-argument-num-events keylist)
2810 unread-command-events)))
2811 (reset-this-command-lengths)
2812 (restore-overriding-map))
2813 \f
2814 ;; This function is here rather than in subr.el because it uses CL.
2815 (defmacro with-wrapper-hook (var args &rest body)
2816 "Run BODY wrapped with the VAR hook.
2817 VAR is a special hook: its functions are called with a first argument
2819 the original function, or call it any number of times (including not calling
2820 it at all). This is similar to an `around' advice.
2821 VAR is normally a symbol (a variable) in which case it is treated like
2822 a hook, with a buffer-local and a global part. But it can also be an
2823 arbitrary expression.
2824 ARGS is a list of variables which will be passed as additional arguments
2825 to each function, after the initial argument, and which the first argument
2826 expects to receive when called."
2827 (declare (indent 2) (debug t))
2828 ;; We need those two gensyms because CL's lexical scoping is not available
2829 ;; for function arguments :-(
2830 (let ((funs (make-symbol "funs"))
2831 (global (make-symbol "global"))
2832 (argssym (make-symbol "args")))
2833 ;; Since the hook is a wrapper, the loop has to be done via
2834 ;; recursion: a given hook function will call its parameter in order to
2835 ;; continue looping.
2836 `(labels ((runrestofhook (,funs ,global ,argssym)
2837 ;; `funs' holds the functions left on the hook and `global'
2838 ;; holds the functions left on the global part of the hook
2839 ;; (in case the hook is local).
2840 (lexical-let ((funs ,funs)
2841 (global ,global))
2842 (if (consp funs)
2843 (if (eq t (car funs))
2844 (runrestofhook
2845 (append global (cdr funs)) nil ,argssym)
2846 (apply (car funs)
2847 (lambda (&rest ,argssym)
2848 (runrestofhook (cdr funs) global ,argssym))
2849 ,argssym))
2850 ;; Once there are no more functions on the hook, run
2851 ;; the original body.
2852 (apply (lambda ,args ,@body) ,argssym)))))
2853 (runrestofhook ,var
2854 ;; The global part of the hook, if any.
2855 ,(if (symbolp var)
2856 `(if (local-variable-p ',var)
2857 (default-value ',var)))
2858 (list ,@args)))))
2860 (defvar filter-buffer-substring-functions nil
2861 "Wrapper hook around `filter-buffer-substring'.
2862 The functions on this special hook are called with 4 arguments:
2863 NEXT-FUN BEG END DELETE
2864 NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2865 that performs the default operation. The other 3 arguments are like
2866 the ones passed to `filter-buffer-substring'.")
2868 (defvar buffer-substring-filters nil
2869 "List of filter functions for `filter-buffer-substring'.
2870 Each function must accept a single argument, a string, and return
2871 a string. The buffer substring is passed to the first function
2872 in the list, and the return value of each function is passed to
2873 the next. The return value of the last function is used as the
2874 return value of `filter-buffer-substring'.
2876 If this variable is nil, no filtering is performed.")
2877 (make-obsolete-variable 'buffer-substring-filters
2878 'filter-buffer-substring-functions "24.1")
2880 (defun filter-buffer-substring (beg end &optional delete)
2881 "Return the buffer substring between BEG and END, after filtering.
2882 The filtering is performed by `filter-buffer-substring-functions'.
2884 If DELETE is non-nil, the text between BEG and END is deleted
2885 from the buffer.
2887 This function should be used instead of `buffer-substring',
2888 `buffer-substring-no-properties', or `delete-and-extract-region'
2889 when you want to allow filtering to take place. For example,
2890 major or minor modes can use `filter-buffer-substring-functions' to
2891 extract characters that are special to a buffer, and should not
2892 be copied into other buffers."
2893 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2894 (cond
2895 ((or delete buffer-substring-filters)
2896 (save-excursion
2897 (goto-char beg)
2898 (let ((string (if delete (delete-and-extract-region beg end)
2899 (buffer-substring beg end))))
2900 (dolist (filter buffer-substring-filters)
2901 (setq string (funcall filter string)))
2902 string)))
2903 (t
2904 (buffer-substring beg end)))))
2907 ;;;; Window system cut and paste hooks.
2909 (defvar interprogram-cut-function nil
2910 "Function to call to make a killed region available to other programs.
2912 Most window systems provide some sort of facility for cutting and
2913 pasting text between the windows of different programs.
2914 This variable holds a function that Emacs calls whenever text
2915 is put in the kill ring, to make the new kill available to other
2916 programs.
2918 The function takes one argument, TEXT, which is a string containing
2919 the text which should be made available.")
2921 (defvar interprogram-paste-function nil
2922 "Function to call to get text cut from other programs.
2924 Most window systems provide some sort of facility for cutting and
2925 pasting text between the windows of different programs.
2926 This variable holds a function that Emacs calls to obtain
2927 text that other programs have provided for pasting.
2929 The function should be called with no arguments. If the function
2930 returns nil, then no other program has provided such text, and the top
2931 of the Emacs kill ring should be used. If the function returns a
2932 string, then the caller of the function \(usually `current-kill')
2933 should put this string in the kill ring as the latest kill.
2935 This function may also return a list of strings if the window
2936 system supports multiple selections. The first string will be
2937 used as the pasted text, but the other will be placed in the
2938 kill ring for easy access via `yank-pop'.
2940 Note that the function should return a string only if a program other
2941 than Emacs has provided a string for pasting; if Emacs provided the
2942 most recent string, the function should return nil. If it is
2943 difficult to tell whether Emacs or some other program provided the
2944 current string, it is probably good enough to return nil if the string
2945 is equal (according to `string=') to the last text Emacs provided.")
2946 \f
2949 ;;;; The kill ring data structure.
2951 (defvar kill-ring nil
2952 "List of killed text sequences.
2953 Since the kill ring is supposed to interact nicely with cut-and-paste
2954 facilities offered by window systems, use of this variable should
2955 interact nicely with `interprogram-cut-function' and
2956 `interprogram-paste-function'. The functions `kill-new',
2957 `kill-append', and `current-kill' are supposed to implement this
2958 interaction; you may want to use them instead of manipulating the kill
2959 ring directly.")
2961 (defcustom kill-ring-max 60
2962 "Maximum length of kill ring before oldest elements are thrown away."
2963 :type 'integer
2964 :group 'killing)
2966 (defvar kill-ring-yank-pointer nil
2967 "The tail of the kill ring whose car is the last thing yanked.")
2969 (defcustom save-interprogram-paste-before-kill nil
2970 "Save clipboard strings into kill ring before replacing them.
2971 When one selects something in another program to paste it into Emacs,
2972 but kills something in Emacs before actually pasting it,
2973 this selection is gone unless this variable is non-nil,
2974 in which case the other program's selection is saved in the `kill-ring'
2976 :type 'boolean
2977 :group 'killing
2978 :version "23.2")
2980 (defcustom kill-do-not-save-duplicates nil
2981 "Do not add a new string to `kill-ring' when it is the same as the last one."
2982 :type 'boolean
2983 :group 'killing
2984 :version "23.2")
2986 (defun kill-new (string &optional replace yank-handler)
2987 "Make STRING the latest kill in the kill ring.
2988 Set `kill-ring-yank-pointer' to point to it.
2989 If `interprogram-cut-function' is non-nil, apply it to STRING.
2990 Optional second argument REPLACE non-nil means that STRING will replace
2991 the front of the kill ring, rather than being added to the list.
2993 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
2994 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
2995 STRING.
2997 When the yank handler has a non-nil PARAM element, the original STRING
2998 argument is not used by `insert-for-yank'. However, since Lisp code
2999 may access and use elements from the kill ring directly, the STRING
3001 (if (> (length string) 0)
3002 (if yank-handler
3003 (put-text-property 0 (length string)
3004 'yank-handler yank-handler string))
3005 (if yank-handler
3006 (signal 'args-out-of-range
3007 (list string "yank-handler specified for empty string"))))
3008 (unless (and kill-do-not-save-duplicates
3009 (equal string (car kill-ring)))
3010 (if (fboundp 'menu-bar-update-yank-menu)
3011 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3012 (when save-interprogram-paste-before-kill
3013 (let ((interprogram-paste (and interprogram-paste-function
3014 (funcall interprogram-paste-function))))
3015 (when interprogram-paste
3016 (dolist (s (if (listp interprogram-paste)
3017 (nreverse interprogram-paste)
3018 (list interprogram-paste)))
3019 (unless (and kill-do-not-save-duplicates
3020 (equal s (car kill-ring)))
3021 (push s kill-ring))))))
3022 (unless (and kill-do-not-save-duplicates
3023 (equal string (car kill-ring)))
3024 (if (and replace kill-ring)
3025 (setcar kill-ring string)
3026 (push string kill-ring)
3027 (if (> (length kill-ring) kill-ring-max)
3028 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3029 (setq kill-ring-yank-pointer kill-ring)
3030 (if interprogram-cut-function
3031 (funcall interprogram-cut-function string)))
3032 (set-advertised-calling-convention
3033 'kill-new '(string &optional replace) "23.3")
3035 (defun kill-append (string before-p &optional yank-handler)
3036 "Append STRING to the end of the latest kill in the kill ring.
3037 If BEFORE-P is non-nil, prepend STRING to the kill.
3038 If `interprogram-cut-function' is set, pass the resulting kill to it."
3039 (let* ((cur (car kill-ring)))
3040 (kill-new (if before-p (concat string cur) (concat cur string))
3041 (or (= (length cur) 0)
3042 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3043 yank-handler)))
3044 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3046 (defcustom yank-pop-change-selection nil
3047 "If non-nil, rotating the kill ring changes the window system selection."
3048 :type 'boolean
3049 :group 'killing
3050 :version "23.1")
3052 (defun current-kill (n &optional do-not-move)
3053 "Rotate the yanking point by N places, and then return that kill.
3054 If N is zero, `interprogram-paste-function' is set, and calling
3055 it returns a string or list of strings, then that string (or
3056 list) is added to the front of the kill ring and the string (or
3057 first string in the list) is returned as the latest kill.
3059 If N is not zero, and if `yank-pop-change-selection' is
3060 non-nil, use `interprogram-cut-function' to transfer the
3061 kill at the new yank point into the window system selection.
3063 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3064 move the yanking point; just return the Nth kill forward."
3066 (let ((interprogram-paste (and (= n 0)
3067 interprogram-paste-function
3068 (funcall interprogram-paste-function))))
3069 (if interprogram-paste
3070 (progn
3071 ;; Disable the interprogram cut function when we add the new
3072 ;; text to the kill ring, so Emacs doesn't try to own the
3073 ;; selection, with identical text.
3074 (let ((interprogram-cut-function nil))
3075 (if (listp interprogram-paste)
3076 (mapc 'kill-new (nreverse interprogram-paste))
3077 (kill-new interprogram-paste)))
3078 (car kill-ring))
3079 (or kill-ring (error "Kill ring is empty"))
3080 (let ((ARGth-kill-element
3081 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3082 (length kill-ring))
3083 kill-ring)))
3084 (unless do-not-move
3085 (setq kill-ring-yank-pointer ARGth-kill-element)
3086 (when (and yank-pop-change-selection
3087 (> n 0)
3088 interprogram-cut-function)
3089 (funcall interprogram-cut-function (car ARGth-kill-element))))
3090 (car ARGth-kill-element)))))
3094 ;;;; Commands for manipulating the kill ring.
3096 (defcustom kill-read-only-ok nil
3097 "Non-nil means don't signal an error for killing read-only text."
3098 :type 'boolean
3099 :group 'killing)
3101 (put 'text-read-only 'error-conditions
3102 '(text-read-only buffer-read-only error))
3103 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3105 (defun kill-region (beg end &optional yank-handler)
3107 This deletes the text from the buffer and saves it in the kill ring.
3111 If you want to append the killed region to the last killed text,
3114 If the buffer is read-only, Emacs will beep and refrain from deleting
3115 the text, but put the text in the kill ring anyway. This means that
3116 you can use the killing commands to copy text from a read-only buffer.
3118 Lisp programs should use this function for killing text.
3119 (To delete text, use `delete-region'.)
3120 Supply two arguments, character positions indicating the stretch of text
3121 to be killed.
3123 If the previous command was also a kill command,
3124 the text killed this time appends to the text killed last time
3125 to make one entry in the kill ring."
3126 ;; Pass point first, then mark, because the order matters
3127 ;; when calling kill-append.
3128 (interactive (list (point) (mark)))
3129 (unless (and beg end)
3130 (error "The mark is not set now, so there is no region"))
3131 (condition-case nil
3132 (let ((string (filter-buffer-substring beg end t)))
3133 (when string ;STRING is nil if BEG = END
3134 ;; Add that string to the kill ring, one way or another.
3135 (if (eq last-command 'kill-region)
3136 (kill-append string (< end beg) yank-handler)
3137 (kill-new string nil yank-handler)))
3138 (when (or string (eq last-command 'kill-region))
3139 (setq this-command 'kill-region))
3140 nil)
3141 ((buffer-read-only text-read-only)
3142 ;; The code above failed because the buffer, or some of the characters
3143 ;; in the region, are read-only.
3144 ;; We should beep, in case the user just isn't aware of this.
3145 ;; However, there's no harm in putting
3146 ;; the region's text in the kill ring, anyway.
3147 (copy-region-as-kill beg end)
3148 ;; Set this-command now, so it will be set even if we get an error.
3149 (setq this-command 'kill-region)
3150 ;; This should barf, if appropriate, and give us the correct error.
3151 (if kill-read-only-ok
3152 (progn (message "Read only text copied to kill ring") nil)
3153 ;; Signal an error if the buffer is read-only.
3154 (barf-if-buffer-read-only)
3155 ;; If the buffer isn't read-only, the text is.
3156 (signal 'text-read-only (list (current-buffer)))))))
3157 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3159 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3160 ;; to get two copies of the text when the user accidentally types M-w and
3161 ;; then corrects it with the intended C-w.
3162 (defun copy-region-as-kill (beg end)
3163 "Save the region as if killed, but don't kill it.
3164 In Transient Mark mode, deactivate the mark.
3165 If `interprogram-cut-function' is non-nil, also save the text for a window
3166 system cut and paste.
3168 This command's old key binding has been given to `kill-ring-save'."
3169 (interactive "r")
3170 (if (eq last-command 'kill-region)
3171 (kill-append (filter-buffer-substring beg end) (< end beg))
3172 (kill-new (filter-buffer-substring beg end)))
3173 (setq deactivate-mark t)
3174 nil)
3176 (defun kill-ring-save (beg end)
3177 "Save the region as if killed, but don't kill it.
3178 In Transient Mark mode, deactivate the mark.
3179 If `interprogram-cut-function' is non-nil, also save the text for a window
3180 system cut and paste.
3182 If you want to append the killed line to the last killed text,
3185 This command is similar to `copy-region-as-kill', except that it gives
3186 visual feedback indicating the extent of the region being copied."
3187 (interactive "r")
3188 (copy-region-as-kill beg end)
3189 ;; This use of called-interactively-p is correct
3190 ;; because the code it controls just gives the user visual feedback.
3191 (if (called-interactively-p 'interactive)
3192 (let ((other-end (if (= (point) beg) end beg))
3193 (opoint (point))
3194 ;; Inhibit quitting so we can make a quit here
3195 ;; look like a C-g typed as a command.
3196 (inhibit-quit t))
3197 (if (pos-visible-in-window-p other-end (selected-window))
3198 ;; Swap point-and-mark quickly so as to show the region that
3199 ;; was selected. Don't do it if the region is highlighted.
3200 (unless (and (region-active-p)
3201 (face-background 'region))
3202 ;; Swap point and mark.
3203 (set-marker (mark-marker) (point) (current-buffer))
3204 (goto-char other-end)
3205 (sit-for blink-matching-delay)
3206 ;; Swap back.
3207 (set-marker (mark-marker) other-end (current-buffer))
3208 (goto-char opoint)
3209 ;; If user quit, deactivate the mark
3210 ;; as C-g would as a command.
3211 (and quit-flag mark-active
3212 (deactivate-mark)))
3213 (let* ((killed-text (current-kill 0))
3214 (message-len (min (length killed-text) 40)))
3215 (if (= (point) beg)
3216 ;; Don't say "killed"; that is misleading.
3218 (substring killed-text (- message-len)))
3220 (substring killed-text 0 message-len))))))))
3222 (defun append-next-kill (&optional interactive)
3223 "Cause following command, if it kills, to append to previous kill.
3224 The argument is used for internal purposes; do not supply one."
3225 (interactive "p")
3226 ;; We don't use (interactive-p), since that breaks kbd macros.
3227 (if interactive
3228 (progn
3229 (setq this-command 'kill-region)
3230 (message "If the next command is a kill, it will append"))
3231 (setq last-command 'kill-region)))
3232 \f
3233 ;; Yanking.
3235 ;; This is actually used in subr.el but defcustom does not work there.
3236 (defcustom yank-excluded-properties
3237 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3238 yank-handler follow-link fontified)
3239 "Text properties to discard when yanking.
3240 The value should be a list of text properties to discard or t,
3241 which means to discard all text properties."
3242 :type '(choice (const :tag "All" t) (repeat symbol))
3243 :group 'killing
3244 :version "22.1")
3246 (defvar yank-window-start nil)
3247 (defvar yank-undo-function nil
3248 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3249 Function is called with two parameters, START and END corresponding to
3250 the value of the mark and point; it is guaranteed that START <= END.
3251 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3253 (defun yank-pop (&optional arg)
3254 "Replace just-yanked stretch of killed text with a different stretch.
3255 This command is allowed only immediately after a `yank' or a `yank-pop'.
3256 At such a time, the region contains a stretch of reinserted
3257 previously-killed text. `yank-pop' deletes that text and inserts in its
3258 place a different stretch of killed text.
3260 With no argument, the previous kill is inserted.
3261 With argument N, insert the Nth previous kill.
3262 If N is negative, this is a more recent kill.
3264 The sequence of kills wraps around, so that after the oldest one
3265 comes the newest one.
3267 When this command inserts killed text into the buffer, it honors
3268 `yank-excluded-properties' and `yank-handler' as described in the
3269 doc string for `insert-for-yank-1', which see."
3270 (interactive "*p")
3271 (if (not (eq last-command 'yank))
3272 (error "Previous command was not a yank"))
3273 (setq this-command 'yank)
3274 (unless arg (setq arg 1))
3275 (let ((inhibit-read-only t)
3276 (before (< (point) (mark t))))
3277 (if before
3278 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3279 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3280 (setq yank-undo-function nil)
3281 (set-marker (mark-marker) (point) (current-buffer))
3282 (insert-for-yank (current-kill arg))
3283 ;; Set the window start back where it was in the yank command,
3284 ;; if possible.
3285 (set-window-start (selected-window) yank-window-start t)
3286 (if before
3287 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3288 ;; It is cleaner to avoid activation, even though the command
3289 ;; loop would deactivate the mark because we inserted text.
3290 (goto-char (prog1 (mark t)
3291 (set-marker (mark-marker) (point) (current-buffer))))))
3292 nil)
3294 (defun yank (&optional arg)
3296 More precisely, reinsert the stretch of killed text most recently
3297 killed OR yanked. Put point at end, and set mark at beginning.
3298 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3299 With argument N, reinsert the Nth most recently killed stretch of killed
3300 text.
3302 When this command inserts killed text into the buffer, it honors
3303 `yank-excluded-properties' and `yank-handler' as described in the
3304 doc string for `insert-for-yank-1', which see.
3307 (interactive "*P")
3308 (setq yank-window-start (window-start))
3309 ;; If we don't get all the way thru, make last-command indicate that
3310 ;; for the following command.
3311 (setq this-command t)
3312 (push-mark (point))
3313 (insert-for-yank (current-kill (cond
3314 ((listp arg) 0)
3315 ((eq arg '-) -2)
3316 (t (1- arg)))))
3317 (if (consp arg)
3318 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3319 ;; It is cleaner to avoid activation, even though the command
3320 ;; loop would deactivate the mark because we inserted text.
3321 (goto-char (prog1 (mark t)
3322 (set-marker (mark-marker) (point) (current-buffer)))))
3323 ;; If we do get all the way thru, make this-command indicate that.
3324 (if (eq this-command t)
3325 (setq this-command 'yank))
3326 nil)
3328 (defun rotate-yank-pointer (arg)
3329 "Rotate the yanking point in the kill ring.
3330 With ARG, rotate that many kills forward (or backward, if negative)."
3331 (interactive "p")
3332 (current-kill arg))
3333 \f
3334 ;; Some kill commands.
3336 ;; Internal subroutine of delete-char
3337 (defun kill-forward-chars (arg)
3338 (if (listp arg) (setq arg (car arg)))
3339 (if (eq arg '-) (setq arg -1))
3340 (kill-region (point) (+ (point) arg)))
3342 ;; Internal subroutine of backward-delete-char
3343 (defun kill-backward-chars (arg)
3344 (if (listp arg) (setq arg (car arg)))
3345 (if (eq arg '-) (setq arg -1))
3346 (kill-region (point) (- (point) arg)))
3348 (defcustom backward-delete-char-untabify-method 'untabify
3349 "The method for untabifying when deleting backward.
3350 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3351 `hungry' -- delete all whitespace, both tabs and spaces;
3352 `all' -- delete all whitespace, including tabs, spaces and newlines;
3353 nil -- just delete one character."
3354 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3355 :version "20.3"
3356 :group 'killing)
3358 (defun backward-delete-char-untabify (arg &optional killp)
3359 "Delete characters backward, changing tabs into spaces.
3360 The exact behavior depends on `backward-delete-char-untabify-method'.
3361 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3362 Interactively, ARG is the prefix arg (default 1)
3363 and KILLP is t if a prefix arg was specified."
3365 (when (eq backward-delete-char-untabify-method 'untabify)
3366 (let ((count arg))
3367 (save-excursion
3368 (while (and (> count 0) (not (bobp)))
3370 (let ((col (current-column)))
3371 (forward-char -1)
3372 (setq col (- col (current-column)))
3373 (insert-char ?\s col)
3374 (delete-char 1)))
3375 (forward-char -1)
3376 (setq count (1- count))))))
3377 (delete-backward-char
3379 ((eq backward-delete-char-untabify-method 'all)
3381 (if skip
3382 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3383 (point)))))
3384 (+ arg (if (zerop wh) 0 (1- wh))))
3385 arg))
3386 killp))
3388 (defun zap-to-char (arg char)
3389 "Kill up to and including ARGth occurrence of CHAR.
3390 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3391 Goes backward if ARG is negative; error if CHAR not found."
3393 ;; Avoid "obsolete" warnings for translation-table-for-input.
3394 (with-no-warnings
3395 (if (char-table-p translation-table-for-input)
3396 (setq char (or (aref translation-table-for-input char) char))))
3397 (kill-region (point) (progn
3398 (search-forward (char-to-string char) nil nil arg)
3399 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3400 (point))))
3402 ;; kill-line and its subroutines.
3404 (defcustom kill-whole-line nil
3405 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3406 :type 'boolean
3407 :group 'killing)
3409 (defun kill-line (&optional arg)
3410 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3411 With prefix argument ARG, kill that many lines from point.
3412 Negative arguments kill lines backward.
3413 With zero argument, kills the text before point on the current line.
3416 a number counts as a prefix arg.
3418 To kill a whole line, when point is not at the beginning, type \
3421 If `kill-whole-line' is non-nil, then this command kills the whole line
3422 including its terminating newline, when used at the beginning of a line
3423 with no argument. As a consequence, you can always kill a whole line
3426 If you want to append the killed line to the last killed text,
3429 If the buffer is read-only, Emacs will beep and refrain from deleting
3430 the line, but put the line in the kill ring anyway. This means that
3431 you can use this command to copy text from a read-only buffer.
3432 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3433 even beep.)"
3434 (interactive "P")
3435 (kill-region (point)
3436 ;; It is better to move point to the other end of the kill
3437 ;; before killing. That way, in a read-only buffer, point
3438 ;; moves across the text that is copied to the kill ring.
3439 ;; The choice has no effect on undo now that undo records
3440 ;; the value of point from before the command was run.
3441 (progn
3442 (if arg
3443 (forward-visible-line (prefix-numeric-value arg))
3444 (if (eobp)
3445 (signal 'end-of-buffer nil))
3446 (let ((end
3447 (save-excursion
3448 (end-of-visible-line) (point))))
3449 (if (or (save-excursion
3450 ;; If trailing whitespace is visible,
3451 ;; don't treat it as nothing.
3452 (unless show-trailing-whitespace
3454 (= (point) end))
3455 (and kill-whole-line (bolp)))
3456 (forward-visible-line 1)
3457 (goto-char end))))
3458 (point))))
3460 (defun kill-whole-line (&optional arg)
3461 "Kill current line.
3462 With prefix ARG, kill that many lines starting from the current line.
3463 If ARG is negative, kill backward. Also kill the preceding newline.
3465 If ARG is zero, kill current line but exclude the trailing newline."
3466 (interactive "p")
3467 (or arg (setq arg 1))
3468 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3469 (signal 'end-of-buffer nil))
3470 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3471 (signal 'beginning-of-buffer nil))
3472 (unless (eq last-command 'kill-region)
3473 (kill-new "")
3474 (setq last-command 'kill-region))
3475 (cond ((zerop arg)
3476 ;; We need to kill in two steps, because the previous command
3477 ;; could have been a kill command, in which case the text
3478 ;; before point needs to be prepended to the current kill
3479 ;; ring entry and the text after point appended. Also, we
3480 ;; need to use save-excursion to avoid copying the same text
3481 ;; twice to the kill ring in read-only buffers.
3482 (save-excursion
3483 (kill-region (point) (progn (forward-visible-line 0) (point))))
3484 (kill-region (point) (progn (end-of-visible-line) (point))))
3485 ((< arg 0)
3486 (save-excursion
3487 (kill-region (point) (progn (end-of-visible-line) (point))))
3488 (kill-region (point)
3489 (progn (forward-visible-line (1+ arg))
3490 (unless (bobp) (backward-char))
3491 (point))))
3492 (t
3493 (save-excursion
3494 (kill-region (point) (progn (forward-visible-line 0) (point))))
3495 (kill-region (point)
3496 (progn (forward-visible-line arg) (point))))))
3498 (defun forward-visible-line (arg)
3499 "Move forward by ARG lines, ignoring currently invisible newlines only.
3500 If ARG is negative, move backward -ARG lines.
3501 If ARG is zero, move to the beginning of the current line."
3502 (condition-case nil
3503 (if (> arg 0)
3504 (progn
3505 (while (> arg 0)
3506 (or (zerop (forward-line 1))
3507 (signal 'end-of-buffer nil))
3508 ;; If the newline we just skipped is invisible,
3509 ;; don't count it.
3510 (let ((prop
3511 (get-char-property (1- (point)) 'invisible)))
3512 (if (if (eq buffer-invisibility-spec t)
3513 prop
3514 (or (memq prop buffer-invisibility-spec)
3515 (assq prop buffer-invisibility-spec)))
3516 (setq arg (1+ arg))))
3517 (setq arg (1- arg)))
3518 ;; If invisible text follows, and it is a number of complete lines,
3519 ;; skip it.
3520 (let ((opoint (point)))
3521 (while (and (not (eobp))
3522 (let ((prop
3523 (get-char-property (point) 'invisible)))
3524 (if (eq buffer-invisibility-spec t)
3525 prop
3526 (or (memq prop buffer-invisibility-spec)
3527 (assq prop buffer-invisibility-spec)))))
3528 (goto-char
3529 (if (get-text-property (point) 'invisible)
3530 (or (next-single-property-change (point) 'invisible)
3531 (point-max))
3532 (next-overlay-change (point)))))
3533 (unless (bolp)
3534 (goto-char opoint))))
3535 (let ((first t))
3536 (while (or first (<= arg 0))
3537 (if first
3538 (beginning-of-line)
3539 (or (zerop (forward-line -1))
3540 (signal 'beginning-of-buffer nil)))
3541 ;; If the newline we just moved to is invisible,
3542 ;; don't count it.
3543 (unless (bobp)
3544 (let ((prop
3545 (get-char-property (1- (point)) 'invisible)))
3546 (unless (if (eq buffer-invisibility-spec t)
3547 prop
3548 (or (memq prop buffer-invisibility-spec)
3549 (assq prop buffer-invisibility-spec)))
3550 (setq arg (1+ arg)))))
3551 (setq first nil))
3552 ;; If invisible text follows, and it is a number of complete lines,
3553 ;; skip it.
3554 (let ((opoint (point)))
3555 (while (and (not (bobp))
3556 (let ((prop
3557 (get-char-property (1- (point)) 'invisible)))
3558 (if (eq buffer-invisibility-spec t)
3559 prop
3560 (or (memq prop buffer-invisibility-spec)
3561 (assq prop buffer-invisibility-spec)))))
3562 (goto-char
3563 (if (get-text-property (1- (point)) 'invisible)
3564 (or (previous-single-property-change (point) 'invisible)
3565 (point-min))
3566 (previous-overlay-change (point)))))
3567 (unless (bolp)
3568 (goto-char opoint)))))
3569 ((beginning-of-buffer end-of-buffer)
3570 nil)))
3572 (defun end-of-visible-line ()
3573 "Move to end of current visible line."
3574 (end-of-line)
3575 ;; If the following character is currently invisible,
3576 ;; skip all characters with that same `invisible' property value,
3577 ;; then find the next newline.
3578 (while (and (not (eobp))
3579 (save-excursion
3581 (let ((prop
3582 (get-char-property (point) 'invisible)))
3583 (if (eq buffer-invisibility-spec t)
3584 prop
3585 (or (memq prop buffer-invisibility-spec)
3586 (assq prop buffer-invisibility-spec))))))
3588 (if (get-text-property (point) 'invisible)
3589 (goto-char (next-single-property-change (point) 'invisible))
3590 (goto-char (next-overlay-change (point))))
3591 (end-of-line)))
3592 \f
3593 (defun insert-buffer (buffer)
3594 "Insert after point the contents of BUFFER.
3595 Puts mark after the inserted text.
3596 BUFFER may be a buffer or a buffer name.
3598 This function is meant for the user to run interactively.
3599 Don't call it from programs: use `insert-buffer-substring' instead!"
3600 (interactive
3601 (list
3602 (progn
3603 (barf-if-buffer-read-only)
3604 (read-buffer "Insert buffer: "
3605 (if (eq (selected-window) (next-window (selected-window)))
3606 (other-buffer (current-buffer))
3607 (window-buffer (next-window (selected-window))))
3608 t))))
3609 (push-mark
3610 (save-excursion
3611 (insert-buffer-substring (get-buffer buffer))
3612 (point)))
3613 nil)
3615 (defun append-to-buffer (buffer start end)
3616 "Append to specified buffer the text of the region.
3617 It is inserted into that buffer before its point.
3619 When calling from a program, give three arguments:
3620 BUFFER (or buffer name), START and END.
3621 START and END specify the portion of the current buffer to be copied."
3622 (interactive
3623 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3624 (region-beginning) (region-end)))
3625 (let* ((oldbuf (current-buffer))
3626 (append-to (get-buffer-create buffer))
3627 (windows (get-buffer-window-list append-to t t))
3628 point)
3629 (save-excursion
3630 (with-current-buffer append-to
3631 (setq point (point))
3632 (barf-if-buffer-read-only)
3633 (insert-buffer-substring oldbuf start end)
3634 (dolist (window windows)
3635 (when (= (window-point window) point)
3636 (set-window-point window (point))))))))
3638 (defun prepend-to-buffer (buffer start end)
3639 "Prepend to specified buffer the text of the region.
3640 It is inserted into that buffer after its point.
3642 When calling from a program, give three arguments:
3643 BUFFER (or buffer name), START and END.
3644 START and END specify the portion of the current buffer to be copied."
3646 (let ((oldbuf (current-buffer)))
3647 (with-current-buffer (get-buffer-create buffer)
3648 (barf-if-buffer-read-only)
3649 (save-excursion
3650 (insert-buffer-substring oldbuf start end)))))
3652 (defun copy-to-buffer (buffer start end)
3653 "Copy to specified buffer the text of the region.
3654 It is inserted into that buffer, replacing existing text there.
3656 When calling from a program, give three arguments:
3657 BUFFER (or buffer name), START and END.
3658 START and END specify the portion of the current buffer to be copied."
3660 (let ((oldbuf (current-buffer)))
3661 (with-current-buffer (get-buffer-create buffer)
3662 (barf-if-buffer-read-only)
3663 (erase-buffer)
3664 (save-excursion
3665 (insert-buffer-substring oldbuf start end)))))
3666 \f
3667 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3668 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3670 (defvar activate-mark-hook nil
3671 "Hook run when the mark becomes active.
3672 It is also run at the end of a command, if the mark is active and
3673 it is possible that the region may have changed.")
3675 (defvar deactivate-mark-hook nil
3676 "Hook run when the mark becomes inactive.")
3678 (defun mark (&optional force)
3679 "Return this buffer's mark value as integer, or nil if never set.
3681 In Transient Mark mode, this function signals an error if
3682 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3683 or the argument FORCE is non-nil, it disregards whether the mark
3684 is active, and returns an integer or nil in the usual way.
3686 If you are using this in an editing command, you are most likely making
3687 a mistake; see the documentation of `set-mark'."
3688 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3689 (marker-position (mark-marker))
3690 (signal 'mark-inactive nil)))
3692 (defsubst deactivate-mark (&optional force)
3693 "Deactivate the mark by setting `mark-active' to nil.
3694 Unless FORCE is non-nil, this function does nothing if Transient
3695 Mark mode is disabled.
3696 This function also runs `deactivate-mark-hook'."
3697 (when (or transient-mark-mode force)
3698 (when (and (if (eq select-active-regions 'only)
3699 (eq (car-safe transient-mark-mode) 'only)
3700 select-active-regions)
3701 (region-active-p)
3702 (display-selections-p))
3703 ;; The var `saved-region-selection', if non-nil, is the text in
3704 ;; the region prior to the last command modifying the buffer.
3705 ;; Set the selection to that, or to the current region.
3706 (cond (saved-region-selection
3707 (x-set-selection 'PRIMARY saved-region-selection)
3708 (setq saved-region-selection nil))
3709 ((/= (region-beginning) (region-end))
3710 (x-set-selection 'PRIMARY
3711 (buffer-substring-no-properties
3712 (region-beginning)
3713 (region-end))))))
3714 (if (and (null force)
3715 (or (eq transient-mark-mode 'lambda)
3716 (and (eq (car-safe transient-mark-mode) 'only)
3717 (null (cdr transient-mark-mode)))))
3718 ;; When deactivating a temporary region, don't change
3719 ;; `mark-active' or run `deactivate-mark-hook'.
3720 (setq transient-mark-mode nil)
3721 (if (eq (car-safe transient-mark-mode) 'only)
3722 (setq transient-mark-mode (cdr transient-mark-mode)))
3723 (setq mark-active nil)
3724 (run-hooks 'deactivate-mark-hook))))
3726 (defun activate-mark ()
3727 "Activate the mark."
3728 (when (mark t)
3729 (setq mark-active t)
3730 (unless transient-mark-mode
3731 (setq transient-mark-mode 'lambda))))
3733 (defun set-mark (pos)
3734 "Set this buffer's mark to POS. Don't use this function!
3735 That is to say, don't use this function unless you want
3736 the user to see that the mark has moved, and you want the previous
3737 mark position to be lost.
3739 Normally, when a new mark is set, the old one should go on the stack.
3740 This is why most applications should use `push-mark', not `set-mark'.
3742 Novice Emacs Lisp programmers often try to use the mark for the wrong
3743 purposes. The mark saves a location for the user's convenience.
3744 Most editing commands should not alter the mark.
3745 To remember a location for internal use in the Lisp program,
3746 store it in a Lisp variable. Example:
3748 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3750 (if pos
3751 (progn
3752 (setq mark-active t)
3753 (run-hooks 'activate-mark-hook)
3754 (set-marker (mark-marker) pos (current-buffer)))
3755 ;; Normally we never clear mark-active except in Transient Mark mode.
3756 ;; But when we actually clear out the mark value too, we must
3757 ;; clear mark-active in any mode.
3758 (deactivate-mark t)
3759 (set-marker (mark-marker) nil)))
3761 (defcustom use-empty-active-region nil
3763 If nil, region-aware commands treat empty regions as inactive.
3764 If non-nil, region-aware commands treat the region as active as
3765 long as the mark is active, even if the region is empty.
3767 Region-aware commands are those that act on the region if it is
3768 active and Transient Mark mode is enabled, and on the text near
3769 point otherwise."
3770 :type 'boolean
3771 :version "23.1"
3772 :group 'editing-basics)
3774 (defun use-region-p ()
3775 "Return t if the region is active and it is appropriate to act on it.
3776 This is used by commands that act specially on the region under
3777 Transient Mark mode.
3779 The return value is t if Transient Mark mode is enabled and the
3780 mark is active; furthermore, if `use-empty-active-region' is nil,
3781 the region must not be empty. Otherwise, the return value is nil.
3783 For some commands, it may be appropriate to ignore the value of
3784 `use-empty-active-region'; in that case, use `region-active-p'."
3785 (and (region-active-p)
3786 (or use-empty-active-region (> (region-end) (region-beginning)))))
3788 (defun region-active-p ()
3789 "Return t if Transient Mark mode is enabled and the mark is active.
3791 Some commands act specially on the region when Transient Mark
3792 mode is enabled. Usually, such commands should use
3793 `use-region-p' instead of this function, because `use-region-p'
3794 also checks the value of `use-empty-active-region'."
3795 (and transient-mark-mode mark-active))
3797 (defvar mark-ring nil
3798 "The list of former marks of the current buffer, most recent first.")
3799 (make-variable-buffer-local 'mark-ring)
3800 (put 'mark-ring 'permanent-local t)
3802 (defcustom mark-ring-max 16
3803 "Maximum size of mark ring. Start discarding off end if gets this big."
3804 :type 'integer
3805 :group 'editing-basics)
3807 (defvar global-mark-ring nil
3808 "The list of saved global marks, most recent first.")
3810 (defcustom global-mark-ring-max 16
3811 "Maximum size of global mark ring. \
3812 Start discarding off end if gets this big."
3813 :type 'integer
3814 :group 'editing-basics)
3816 (defun pop-to-mark-command ()
3817 "Jump to mark, and pop a new position for mark off the ring.
3818 \(Does not affect global mark ring\)."
3819 (interactive)
3820 (if (null (mark t))
3821 (error "No mark set in this buffer")
3822 (if (= (point) (mark t))
3823 (message "Mark popped"))
3824 (goto-char (mark t))
3825 (pop-mark)))
3827 (defun push-mark-command (arg &optional nomsg)
3828 "Set mark at where point is.
3829 If no prefix ARG and mark is already set there, just activate it.
3830 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3831 (interactive "P")
3832 (let ((mark (marker-position (mark-marker))))
3833 (if (or arg (null mark) (/= mark (point)))
3834 (push-mark nil nomsg t)
3835 (setq mark-active t)
3836 (run-hooks 'activate-mark-hook)
3837 (unless nomsg
3838 (message "Mark activated")))))
3840 (defcustom set-mark-command-repeat-pop nil
3843 will pop the mark twice, and
3845 will pop the mark three times.
3849 :type 'boolean
3850 :group 'editing-basics)
3852 (defcustom set-mark-default-inactive nil
3853 "If non-nil, setting the mark does not activate it.
3855 behave the same whether or not `transient-mark-mode' is enabled."
3856 :type 'boolean
3857 :group 'editing-basics
3858 :version "23.1")
3860 (defun set-mark-command (arg)
3861 "Set the mark where point is, or jump to the mark.
3862 Setting the mark also alters the region, which is the text
3863 between point and mark; this is the closest equivalent in
3866 With no prefix argument, set the mark at point, and push the
3867 old mark position on local mark ring. Also push the old mark on
3868 global mark ring, if the previous mark was set in another buffer.
3870 When Transient Mark Mode is off, immediately repeating this
3871 command activates `transient-mark-mode' temporarily.
3874 jump to the mark, and set the mark from
3875 position popped off the local mark ring \(this does not affect the global
3877 mark ring \(see `pop-global-mark'\).
3879 If `set-mark-command-repeat-pop' is non-nil, repeating
3881 off the local (or global) mark ring and jumps there.
3884 argument, unconditionally set mark where point is, even if
3885 `set-mark-command-repeat-pop' is non-nil.
3887 Novice Emacs Lisp programmers often try to use the mark for the wrong
3888 purposes. See the documentation of `set-mark' for more information."
3889 (interactive "P")
3890 (cond ((eq transient-mark-mode 'lambda)
3891 (setq transient-mark-mode nil))
3892 ((eq (car-safe transient-mark-mode) 'only)
3893 (deactivate-mark)))
3894 (cond
3895 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3896 (push-mark-command nil))
3897 ((not (eq this-command 'set-mark-command))
3898 (if arg
3899 (pop-to-mark-command)
3900 (push-mark-command t)))
3901 ((and set-mark-command-repeat-pop
3902 (eq last-command 'pop-to-mark-command))
3903 (setq this-command 'pop-to-mark-command)
3904 (pop-to-mark-command))
3905 ((and set-mark-command-repeat-pop
3906 (eq last-command 'pop-global-mark)
3907 (not arg))
3908 (setq this-command 'pop-global-mark)
3909 (pop-global-mark))
3910 (arg
3911 (setq this-command 'pop-to-mark-command)
3912 (pop-to-mark-command))
3913 ((eq last-command 'set-mark-command)
3914 (if (region-active-p)
3915 (progn
3916 (deactivate-mark)
3917 (message "Mark deactivated"))
3918 (activate-mark)
3919 (message "Mark activated")))
3920 (t
3921 (push-mark-command nil)
3922 (if set-mark-default-inactive (deactivate-mark)))))
3924 (defun push-mark (&optional location nomsg activate)
3925 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3926 If the last global mark pushed was not in the current buffer,
3927 also push LOCATION on the global mark ring.
3928 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3930 Novice Emacs Lisp programmers often try to use the mark for the wrong
3931 purposes. See the documentation of `set-mark' for more information.
3933 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3934 (unless (null (mark t))
3935 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3936 (when (> (length mark-ring) mark-ring-max)
3937 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3938 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3939 (set-marker (mark-marker) (or location (point)) (current-buffer))
3940 ;; Now push the mark on the global mark ring.
3941 (if (and global-mark-ring
3942 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3943 ;; The last global mark pushed was in this same buffer.
3944 ;; Don't push another one.
3945 nil
3946 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3947 (when (> (length global-mark-ring) global-mark-ring-max)
3948 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3949 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3950 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3951 (message "Mark set"))
3952 (if (or activate (not transient-mark-mode))
3953 (set-mark (mark t)))
3954 nil)
3956 (defun pop-mark ()
3957 "Pop off mark ring into the buffer's actual mark.
3958 Does not set point. Does nothing if mark ring is empty."
3959 (when mark-ring
3960 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3961 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3962 (move-marker (car mark-ring) nil)
3963 (if (null (mark t)) (ding))
3964 (setq mark-ring (cdr mark-ring)))
3965 (deactivate-mark))
3967 (define-obsolete-function-alias
3968 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
3969 (defun exchange-point-and-mark (&optional arg)
3970 "Put the mark where point is now, and point where the mark is now.
3971 This command works even when the mark is not active,
3972 and it reactivates the mark.
3974 If Transient Mark mode is on, a prefix ARG deactivates the mark
3975 if it is active, and otherwise avoids reactivating it. If
3976 Transient Mark mode is off, a prefix ARG enables Transient Mark
3977 mode temporarily."
3978 (interactive "P")
3979 (let ((omark (mark t))
3980 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
3981 (if (null omark)
3982 (error "No mark set in this buffer"))
3983 (deactivate-mark)
3984 (set-mark (point))
3985 (goto-char omark)
3986 (if set-mark-default-inactive (deactivate-mark))
3987 (cond (temp-highlight
3988 (setq transient-mark-mode (cons 'only transient-mark-mode)))
3989 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
3990 (not (or arg (region-active-p))))
3991 (deactivate-mark))
3992 (t (activate-mark)))
3993 nil))
3995 (defcustom shift-select-mode t
3996 "When non-nil, shifted motion keys activate the mark momentarily.
3998 While the mark is activated in this way, any shift-translated point
3999 motion key extends the region, and if Transient Mark mode was off, it
4000 is temporarily turned on. Furthermore, the mark will be deactivated
4001 by any subsequent point motion key that was not shift-translated, or
4002 by any action that normally deactivates the mark in Transient Mark mode.
4004 See `this-command-keys-shift-translated' for the meaning of
4005 shift-translation."
4006 :type 'boolean
4007 :group 'editing-basics)
4009 (defun handle-shift-selection ()
4010 "Activate/deactivate mark depending on invocation thru shift translation.
4011 This function is called by `call-interactively' when a command
4012 with a `^' character in its `interactive' spec is invoked, before
4013 running the command itself.
4015 If `shift-select-mode' is enabled and the command was invoked
4016 through shift translation, set the mark and activate the region
4017 temporarily, unless it was already set in this way. See
4018 `this-command-keys-shift-translated' for the meaning of shift
4019 translation.
4021 Otherwise, if the region has been activated temporarily,
4022 deactivate it, and restore the variable `transient-mark-mode' to
4023 its earlier value."
4024 (cond ((and shift-select-mode this-command-keys-shift-translated)
4025 (unless (and mark-active
4026 (eq (car-safe transient-mark-mode) 'only))
4027 (setq transient-mark-mode
4028 (cons 'only
4029 (unless (eq transient-mark-mode 'lambda)
4030 transient-mark-mode)))
4031 (push-mark nil nil t)))
4032 ((eq (car-safe transient-mark-mode) 'only)
4033 (setq transient-mark-mode (cdr transient-mark-mode))
4034 (deactivate-mark))))
4036 (define-minor-mode transient-mark-mode
4037 "Toggle Transient Mark mode.
4038 With ARG, turn Transient Mark mode on if ARG is positive, off otherwise.
4040 In Transient Mark mode, when the mark is active, the region is highlighted.
4042 So do certain other operations that set the mark
4043 but whose main purpose is something else--for example,
4049 Many commands change their behavior when Transient Mark mode is in effect
4050 and the mark is active, by acting on the region instead of their usual
4051 default part of the buffer's text. Examples of such commands include
4056 commands which are sensitive to the Transient Mark mode."
4057 :global t
4058 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4059 :variable transient-mark-mode)
4061 (defvar widen-automatically t
4062 "Non-nil means it is ok for commands to call `widen' when they want to.
4063 Some commands will do this in order to go to positions outside
4064 the current accessible part of the buffer.
4066 If `widen-automatically' is nil, these commands will do something else
4067 as a fallback, and won't change the buffer bounds.")
4069 (defvar non-essential nil
4070 "Whether the currently executing code is performing an essential task.
4071 This variable should be non-nil only when running code which should not
4072 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4073 user for a password when we are simply scanning a set of files in the
4074 background or displaying possible completions before the user even asked
4075 for it.")
4077 (defun pop-global-mark ()
4078 "Pop off global mark ring and jump to the top location."
4079 (interactive)
4080 ;; Pop entries which refer to non-existent buffers.
4081 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4082 (setq global-mark-ring (cdr global-mark-ring)))
4083 (or global-mark-ring
4084 (error "No global mark set"))
4085 (let* ((marker (car global-mark-ring))
4086 (buffer (marker-buffer marker))
4087 (position (marker-position marker)))
4088 (setq global-mark-ring (nconc (cdr global-mark-ring)
4089 (list (car global-mark-ring))))
4090 (set-buffer buffer)
4091 (or (and (>= position (point-min))
4092 (<= position (point-max)))
4093 (if widen-automatically
4094 (widen)
4095 (error "Global mark position is outside accessible part of buffer")))
4096 (goto-char position)
4097 (switch-to-buffer buffer)))
4098 \f
4099 (defcustom next-line-add-newlines nil
4100 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4101 :type 'boolean
4102 :version "21.1"
4103 :group 'editing-basics)
4105 (defun next-line (&optional arg try-vscroll)
4106 "Move cursor vertically down ARG lines.
4107 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4108 If there is no character in the target line exactly under the current column,
4109 the cursor is positioned after the character in that line which spans this
4110 column, or at the end of the line if it is not long enough.
4111 If there is no line in the buffer after this one, behavior depends on the
4112 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4113 to create a line, and moves the cursor to that line. Otherwise it moves the
4114 cursor to the end of the buffer.
4116 If the variable `line-move-visual' is non-nil, this command moves
4117 by display lines. Otherwise, it moves by buffer lines, without
4118 taking variable-width characters or continued lines into account.
4121 a semipermanent goal column for this command.
4122 Then instead of trying to move exactly vertically (or as close as possible),
4123 this command moves to the specified goal column (or as close as possible).
4124 The goal column is stored in the variable `goal-column', which is nil
4125 when there is no goal column.
4127 If you are thinking of using this in a Lisp program, consider
4128 using `forward-line' instead. It is usually easier to use
4129 and more reliable (no dependence on goal column, etc.)."
4131 (or arg (setq arg 1))
4132 (if (and next-line-add-newlines (= arg 1))
4133 (if (save-excursion (end-of-line) (eobp))
4134 ;; When adding a newline, don't expand an abbrev.
4135 (let ((abbrev-mode nil))
4136 (end-of-line)
4138 (line-move arg nil nil try-vscroll))
4139 (if (called-interactively-p 'interactive)
4140 (condition-case err
4141 (line-move arg nil nil try-vscroll)
4142 ((beginning-of-buffer end-of-buffer)
4143 (signal (car err) (cdr err))))
4144 (line-move arg nil nil try-vscroll)))
4145 nil)
4147 (defun previous-line (&optional arg try-vscroll)
4148 "Move cursor vertically up ARG lines.
4149 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4150 If there is no character in the target line exactly over the current column,
4151 the cursor is positioned after the character in that line which spans this
4152 column, or at the end of the line if it is not long enough.
4154 If the variable `line-move-visual' is non-nil, this command moves
4155 by display lines. Otherwise, it moves by buffer lines, without
4156 taking variable-width characters or continued lines into account.
4159 a semipermanent goal column for this command.
4160 Then instead of trying to move exactly vertically (or as close as possible),
4161 this command moves to the specified goal column (or as close as possible).
4162 The goal column is stored in the variable `goal-column', which is nil
4163 when there is no goal column.
4165 If you are thinking of using this in a Lisp program, consider using
4166 `forward-line' with a negative argument instead. It is usually easier
4167 to use and more reliable (no dependence on goal column, etc.)."
4169 (or arg (setq arg 1))
4170 (if (called-interactively-p 'interactive)
4171 (condition-case err
4172 (line-move (- arg) nil nil try-vscroll)
4173 ((beginning-of-buffer end-of-buffer)
4174 (signal (car err) (cdr err))))
4175 (line-move (- arg) nil nil try-vscroll))
4176 nil)
4178 (defcustom track-eol nil
4179 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4180 This means moving to the end of each line moved onto.
4181 The beginning of a blank line does not count as the end of a line.
4182 This has no effect when `line-move-visual' is non-nil."
4183 :type 'boolean
4184 :group 'editing-basics)
4186 (defcustom goal-column nil
4188 :type '(choice integer
4189 (const :tag "None" nil))
4190 :group 'editing-basics)
4191 (make-variable-buffer-local 'goal-column)
4193 (defvar temporary-goal-column 0
4194 "Current goal column for vertical motion.
4195 It is the column where point was at the start of the current run
4196 of vertical motion commands.
4198 When moving by visual lines via `line-move-visual', it is a cons
4199 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4200 divided by the default column width, and HSCROLL is the number of
4201 columns by which window is scrolled from left margin.
4203 When the `track-eol' feature is doing its job, the value is
4204 `most-positive-fixnum'.")
4206 (defcustom line-move-ignore-invisible t
4208 Outline mode sets this."
4209 :type 'boolean
4210 :group 'editing-basics)
4212 (defcustom line-move-visual t
4213 "When non-nil, `line-move' moves point by visual lines.
4214 This movement is based on where the cursor is displayed on the
4215 screen, instead of relying on buffer contents alone. It takes
4216 into account variable-width characters and line continuation."
4217 :type 'boolean
4218 :group 'editing-basics)
4220 ;; Returns non-nil if partial move was done.
4221 (defun line-move-partial (arg noerror to-end)
4222 (if (< arg 0)
4223 ;; Move backward (up).
4224 ;; If already vscrolled, reduce vscroll
4225 (let ((vs (window-vscroll nil t)))
4226 (when (> vs (frame-char-height))
4227 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4229 ;; Move forward (down).
4230 (let* ((lh (window-line-height -1))
4231 (vpos (nth 1 lh))
4232 (ypos (nth 2 lh))
4233 (rbot (nth 3 lh))
4234 py vs)
4235 (when (or (null lh)
4236 (>= rbot (frame-char-height))
4237 (<= ypos (- (frame-char-height))))
4238 (unless lh
4239 (let ((wend (pos-visible-in-window-p t nil t)))
4240 (setq rbot (nth 3 wend)
4241 vpos (nth 5 wend))))
4242 (cond
4243 ;; If last line of window is fully visible, move forward.
4244 ((or (null rbot) (= rbot 0))
4245 nil)
4246 ;; If cursor is not in the bottom scroll margin, move forward.
4247 ((and (> vpos 0)
4248 (< (setq py
4249 (or (nth 1 (window-line-height))
4250 (let ((ppos (posn-at-point)))
4251 (cdr (or (posn-actual-col-row ppos)
4252 (posn-col-row ppos))))))
4253 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4254 nil)
4255 ;; When already vscrolled, we vscroll some more if we can,
4256 ;; or clear vscroll and move forward at end of tall image.
4257 ((> (setq vs (window-vscroll nil t)) 0)
4258 (when (> rbot 0)
4259 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4260 ;; If cursor just entered the bottom scroll margin, move forward,
4261 ;; but also vscroll one line so redisplay wont recenter.
4262 ((and (> vpos 0)
4263 (= py (min (- (window-text-height) scroll-margin 1)
4264 (1- vpos))))
4265 (set-window-vscroll nil (frame-char-height) t)
4266 (line-move-1 arg noerror to-end)
4267 t)
4268 ;; If there are lines above the last line, scroll-up one line.
4269 ((> vpos 0)
4270 (scroll-up 1)
4271 t)
4272 ;; Finally, start vscroll.
4273 (t
4274 (set-window-vscroll nil (frame-char-height) t)))))))
4277 ;; This is like line-move-1 except that it also performs
4278 ;; vertical scrolling of tall images if appropriate.
4279 ;; That is not really a clean thing to do, since it mixes
4280 ;; scrolling with cursor motion. But so far we don't have
4281 ;; a cleaner solution to the problem of making C-n do something
4282 ;; useful given a tall image.
4283 (defun line-move (arg &optional noerror to-end try-vscroll)
4284 (unless (and auto-window-vscroll try-vscroll
4285 ;; Only vscroll for single line moves
4286 (= (abs arg) 1)
4287 ;; But don't vscroll in a keyboard macro.
4288 (not defining-kbd-macro)
4289 (not executing-kbd-macro)
4290 (line-move-partial arg noerror to-end))
4291 (set-window-vscroll nil 0 t)
4292 (if line-move-visual
4293 (line-move-visual arg noerror)
4294 (line-move-1 arg noerror to-end))))
4296 ;; Display-based alternative to line-move-1.
4297 ;; Arg says how many lines to move. The value is t if we can move the
4298 ;; specified number of lines.
4299 (defun line-move-visual (arg &optional noerror)
4300 (let ((opoint (point))
4301 (hscroll (window-hscroll))
4302 target-hscroll)
4303 ;; Check if the previous command was a line-motion command, or if
4304 ;; we were called from some other command.
4305 (if (and (consp temporary-goal-column)
4306 (memq last-command `(next-line previous-line ,this-command)))
4307 ;; If so, there's no need to reset `temporary-goal-column',
4308 ;; but we may need to hscroll.
4309 (if (or (/= (cdr temporary-goal-column) hscroll)
4310 (> (cdr temporary-goal-column) 0))
4311 (setq target-hscroll (cdr temporary-goal-column)))
4312 ;; Otherwise, we should reset `temporary-goal-column'.
4313 (let ((posn (posn-at-point)))
4314 (cond
4315 ;; Handle the `overflow-newline-into-fringe' case:
4316 ((eq (nth 1 posn) 'right-fringe)
4317 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4318 ((car (posn-x-y posn))
4319 (setq temporary-goal-column
4320 (cons (/ (float (car (posn-x-y posn)))
4321 (frame-char-width)) hscroll))))))
4322 (if target-hscroll
4323 (set-window-hscroll (selected-window) target-hscroll))
4324 (or (and (= (vertical-motion
4325 (cons (or goal-column
4326 (if (consp temporary-goal-column)
4327 (car temporary-goal-column)
4328 temporary-goal-column))
4329 arg))
4330 arg)
4331 (or (>= arg 0)
4332 (/= (point) opoint)
4333 ;; If the goal column lies on a display string,
4334 ;; `vertical-motion' advances the cursor to the end
4335 ;; of the string. For arg < 0, this can cause the
4336 ;; cursor to get stuck. (Bug#3020).
4337 (= (vertical-motion arg) arg)))
4338 (unless noerror
4339 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4340 nil)))))
4342 ;; This is the guts of next-line and previous-line.
4343 ;; Arg says how many lines to move.
4344 ;; The value is t if we can move the specified number of lines.
4345 (defun line-move-1 (arg &optional noerror to-end)
4346 ;; Don't run any point-motion hooks, and disregard intangibility,
4347 ;; for intermediate positions.
4348 (let ((inhibit-point-motion-hooks t)
4349 (opoint (point))
4350 (orig-arg arg))
4351 (if (consp temporary-goal-column)
4352 (setq temporary-goal-column (+ (car temporary-goal-column)
4353 (cdr temporary-goal-column))))
4354 (unwind-protect
4355 (progn
4356 (if (not (memq last-command '(next-line previous-line)))
4357 (setq temporary-goal-column
4358 (if (and track-eol (eolp)
4359 ;; Don't count beg of empty line as end of line
4360 ;; unless we just did explicit end-of-line.
4361 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4362 most-positive-fixnum
4363 (current-column))))
4365 (if (not (or (integerp selective-display)
4366 line-move-ignore-invisible))
4367 ;; Use just newline characters.
4368 ;; Set ARG to 0 if we move as many lines as requested.
4369 (or (if (> arg 0)
4370 (progn (if (> arg 1) (forward-line (1- arg)))
4371 ;; This way of moving forward ARG lines
4372 ;; verifies that we have a newline after the last one.
4373 ;; It doesn't get confused by intangible text.
4374 (end-of-line)
4375 (if (zerop (forward-line 1))
4376 (setq arg 0)))
4377 (and (zerop (forward-line arg))
4378 (bolp)
4379 (setq arg 0)))
4380 (unless noerror
4381 (signal (if (< arg 0)
4382 'beginning-of-buffer
4383 'end-of-buffer)
4384 nil)))
4385 ;; Move by arg lines, but ignore invisible ones.
4386 (let (done)
4387 (while (and (> arg 0) (not done))
4388 ;; If the following character is currently invisible,
4389 ;; skip all characters with that same `invisible' property value.
4390 (while (and (not (eobp)) (invisible-p (point)))
4391 (goto-char (next-char-property-change (point))))
4392 ;; Move a line.
4393 ;; We don't use `end-of-line', since we want to escape
4394 ;; from field boundaries occurring exactly at point.
4395 (goto-char (constrain-to-field
4396 (let ((inhibit-field-text-motion t))
4397 (line-end-position))
4398 (point) t t
4399 'inhibit-line-move-field-capture))
4400 ;; If there's no invisibility here, move over the newline.
4401 (cond
4402 ((eobp)
4403 (if (not noerror)
4404 (signal 'end-of-buffer nil)
4405 (setq done t)))
4406 ((and (> arg 1) ;; Use vertical-motion for last move
4407 (not (integerp selective-display))
4408 (not (invisible-p (point))))
4409 ;; We avoid vertical-motion when possible
4410 ;; because that has to fontify.
4411 (forward-line 1))
4412 ;; Otherwise move a more sophisticated way.
4413 ((zerop (vertical-motion 1))
4414 (if (not noerror)
4415 (signal 'end-of-buffer nil)
4416 (setq done t))))
4417 (unless done
4418 (setq arg (1- arg))))
4419 ;; The logic of this is the same as the loop above,
4420 ;; it just goes in the other direction.
4421 (while (and (< arg 0) (not done))
4422 ;; For completely consistency with the forward-motion
4423 ;; case, we should call beginning-of-line here.
4424 ;; However, if point is inside a field and on a
4425 ;; continued line, the call to (vertical-motion -1)
4426 ;; below won't move us back far enough; then we return
4427 ;; to the same column in line-move-finish, and point
4428 ;; gets stuck -- cyd
4429 (forward-line 0)
4430 (cond
4431 ((bobp)
4432 (if (not noerror)
4433 (signal 'beginning-of-buffer nil)
4434 (setq done t)))
4435 ((and (< arg -1) ;; Use vertical-motion for last move
4436 (not (integerp selective-display))
4437 (not (invisible-p (1- (point)))))
4438 (forward-line -1))
4439 ((zerop (vertical-motion -1))
4440 (if (not noerror)
4441 (signal 'beginning-of-buffer nil)
4442 (setq done t))))
4443 (unless done
4444 (setq arg (1+ arg))
4445 (while (and ;; Don't move over previous invis lines
4446 ;; if our target is the middle of this line.
4447 (or (zerop (or goal-column temporary-goal-column))
4448 (< arg 0))
4449 (not (bobp)) (invisible-p (1- (point))))
4450 (goto-char (previous-char-property-change (point))))))))
4451 ;; This is the value the function returns.
4452 (= arg 0))
4454 (cond ((> arg 0)
4455 ;; If we did not move down as far as desired, at least go
4456 ;; to end of line. Be sure to call point-entered and
4457 ;; point-left-hooks.
4458 (let* ((npoint (prog1 (line-end-position)
4459 (goto-char opoint)))
4460 (inhibit-point-motion-hooks nil))
4461 (goto-char npoint)))
4462 ((< arg 0)
4463 ;; If we did not move up as far as desired,
4464 ;; at least go to beginning of line.
4465 (let* ((npoint (prog1 (line-beginning-position)
4466 (goto-char opoint)))
4467 (inhibit-point-motion-hooks nil))
4468 (goto-char npoint)))
4469 (t
4470 (line-move-finish (or goal-column temporary-goal-column)
4471 opoint (> orig-arg 0)))))))
4473 (defun line-move-finish (column opoint forward)
4474 (let ((repeat t))
4475 (while repeat
4476 ;; Set REPEAT to t to repeat the whole thing.
4477 (setq repeat nil)
4479 (let (new
4480 (old (point))
4481 (line-beg (line-beginning-position))
4482 (line-end
4483 ;; Compute the end of the line
4484 ;; ignoring effectively invisible newlines.
4485 (save-excursion
4486 ;; Like end-of-line but ignores fields.
4488 (while (and (not (eobp)) (invisible-p (point)))
4489 (goto-char (next-char-property-change (point)))
4491 (point))))
4493 ;; Move to the desired column.
4494 (line-move-to-column (truncate column))
4496 ;; Corner case: suppose we start out in a field boundary in
4497 ;; the middle of a continued line. When we get to
4498 ;; line-move-finish, point is at the start of a new *screen*
4499 ;; line but the same text line; then line-move-to-column would
4500 ;; move us backwards. Test using C-n with point on the "x" in
4501 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4502 (and forward
4503 (< (point) old)
4504 (goto-char old))
4506 (setq new (point))
4508 ;; Process intangibility within a line.
4509 ;; With inhibit-point-motion-hooks bound to nil, a call to
4510 ;; goto-char moves point past intangible text.
4512 ;; However, inhibit-point-motion-hooks controls both the
4513 ;; intangibility and the point-entered/point-left hooks. The
4514 ;; following hack avoids calling the point-* hooks
4515 ;; unnecessarily. Note that we move *forward* past intangible
4516 ;; text when the initial and final points are the same.
4517 (goto-char new)
4518 (let ((inhibit-point-motion-hooks nil))
4519 (goto-char new)
4521 ;; If intangibility moves us to a different (later) place
4522 ;; in the same line, use that as the destination.
4523 (if (<= (point) line-end)
4524 (setq new (point))
4525 ;; If that position is "too late",
4526 ;; try the previous allowable position.
4527 ;; See if it is ok.
4528 (backward-char)
4529 (if (if forward
4530 ;; If going forward, don't accept the previous
4531 ;; allowable position if it is before the target line.
4532 (< line-beg (point))
4533 ;; If going backward, don't accept the previous
4534 ;; allowable position if it is still after the target line.
4535 (<= (point) line-end))
4536 (setq new (point))
4537 ;; As a last resort, use the end of the line.
4538 (setq new line-end))))
4540 ;; Now move to the updated destination, processing fields
4541 ;; as well as intangibility.
4542 (goto-char opoint)
4543 (let ((inhibit-point-motion-hooks nil))
4544 (goto-char
4545 ;; Ignore field boundaries if the initial and final
4546 ;; positions have the same `field' property, even if the
4547 ;; fields are non-contiguous. This seems to be "nicer"
4548 ;; behavior in many situations.
4549 (if (eq (get-char-property new 'field)
4550 (get-char-property opoint 'field))
4551 new
4552 (constrain-to-field new opoint t t
4553 'inhibit-line-move-field-capture))))
4555 ;; If all this moved us to a different line,
4556 ;; retry everything within that new line.
4557 (when (or (< (point) line-beg) (> (point) line-end))
4558 ;; Repeat the intangibility and field processing.
4559 (setq repeat t))))))
4561 (defun line-move-to-column (col)
4562 "Try to find column COL, considering invisibility.
4563 This function works only in certain cases,
4564 because what we really need is for `move-to-column'
4565 and `current-column' to be able to ignore invisible text."
4566 (if (zerop col)
4567 (beginning-of-line)
4568 (move-to-column col))
4570 (when (and line-move-ignore-invisible
4571 (not (bolp)) (invisible-p (1- (point))))
4572 (let ((normal-location (point))
4573 (normal-column (current-column)))
4574 ;; If the following character is currently invisible,
4575 ;; skip all characters with that same `invisible' property value.
4576 (while (and (not (eobp))
4577 (invisible-p (point)))
4578 (goto-char (next-char-property-change (point))))
4579 ;; Have we advanced to a larger column position?
4580 (if (> (current-column) normal-column)
4581 ;; We have made some progress towards the desired column.
4582 ;; See if we can make any further progress.
4583 (line-move-to-column (+ (current-column) (- col normal-column)))
4584 ;; Otherwise, go to the place we originally found
4585 ;; and move back over invisible text.
4586 ;; that will get us to the same place on the screen
4587 ;; but with a more reasonable buffer position.
4588 (goto-char normal-location)
4589 (let ((line-beg (line-beginning-position)))
4590 (while (and (not (bolp)) (invisible-p (1- (point))))
4591 (goto-char (previous-char-property-change (point) line-beg))))))))
4593 (defun move-end-of-line (arg)
4594 "Move point to end of current line as displayed.
4595 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4596 If point reaches the beginning or end of buffer, it stops there.
4598 To ignore the effects of the `intangible' text or overlay
4599 property, bind `inhibit-point-motion-hooks' to t.
4600 If there is an image in the current line, this function
4601 disregards newlines that are part of the text on which the image
4602 rests."
4603 (interactive "^p")
4604 (or arg (setq arg 1))
4605 (let (done)
4606 (while (not done)
4607 (let ((newpos
4608 (save-excursion
4609 (let ((goal-column 0)
4610 (line-move-visual nil))
4611 (and (line-move arg t)
4612 ;; With bidi reordering, we may not be at bol,
4613 ;; so make sure we are.
4615 (not (bobp))
4616 (progn
4617 (while (and (not (bobp)) (invisible-p (1- (point))))
4618 (goto-char (previous-single-char-property-change
4619 (point) 'invisible)))
4620 (backward-char 1)))
4621 (point)))))
4622 (goto-char newpos)
4623 (if (and (> (point) newpos)
4625 (backward-char 1)
4626 (if (and (> (point) newpos) (not (eobp))
4628 ;; If we skipped something intangible and now we're not
4629 ;; really at eol, keep going.
4630 (setq arg 1)
4631 (setq done t)))))))
4633 (defun move-beginning-of-line (arg)
4634 "Move point to beginning of current line as displayed.
4635 \(If there's an image in the line, this disregards newlines
4636 which are part of the text that the image rests on.)
4638 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4639 If point reaches the beginning or end of buffer, it stops there.
4640 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4641 (interactive "^p")
4642 (or arg (setq arg 1))
4644 (let ((orig (point))
4645 first-vis first-vis-field-value)
4647 ;; Move by lines, if ARG is not 1 (the default).
4648 (if (/= arg 1)
4649 (let ((line-move-visual nil))
4650 (line-move (1- arg) t)))
4652 ;; Move to beginning-of-line, ignoring fields and invisibles.
4654 (while (and (not (bobp)) (invisible-p (1- (point))))
4655 (goto-char (previous-char-property-change (point)))
4658 ;; Now find first visible char in the line
4659 (while (and (not (eobp)) (invisible-p (point)))
4660 (goto-char (next-char-property-change (point))))
4661 (setq first-vis (point))
4663 ;; See if fields would stop us from reaching FIRST-VIS.
4664 (setq first-vis-field-value
4665 (constrain-to-field first-vis orig (/= arg 1) t nil))
4667 (goto-char (if (/= first-vis-field-value first-vis)
4668 ;; If yes, obey them.
4669 first-vis-field-value
4670 ;; Otherwise, move to START with attention to fields.
4671 ;; (It is possible that fields never matter in this case.)
4672 (constrain-to-field (point) orig
4673 (/= arg 1) t nil)))))
4676 ;; Many people have said they rarely use this feature, and often type
4677 ;; it by accident. Maybe it shouldn't even be on a key.
4678 (put 'set-goal-column 'disabled t)
4680 (defun set-goal-column (arg)
4682 Those commands will move to this position in the line moved to
4683 rather than trying to keep the same horizontal position.
4684 With a non-nil argument ARG, clears out the goal column
4686 The goal column is stored in the variable `goal-column'."
4687 (interactive "P")
4688 (if arg
4689 (progn
4690 (setq goal-column nil)
4691 (message "No goal column"))
4692 (setq goal-column (current-column))
4693 ;; The older method below can be erroneous if `set-goal-column' is bound
4694 ;; to a sequence containing %
4695 ;;(message (substitute-command-keys
4697 ;;goal-column)
4698 (message "%s"
4699 (concat
4700 (format "Goal column %d " goal-column)
4701 (substitute-command-keys
4704 )
4705 nil)
4706 \f
4707 ;;; Editing based on visual lines, as opposed to logical lines.
4709 (defun end-of-visual-line (&optional n)
4710 "Move point to end of current visual line.
4711 With argument N not nil or 1, move forward N - 1 visual lines first.
4712 If point reaches the beginning or end of buffer, it stops there.
4713 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4714 (interactive "^p")
4715 (or n (setq n 1))
4716 (if (/= n 1)
4717 (let ((line-move-visual t))
4718 (line-move (1- n) t)))
4719 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4720 ;; constrain to field boundaries, so we don't either.
4721 (vertical-motion (cons (window-width) 0)))
4723 (defun beginning-of-visual-line (&optional n)
4724 "Move point to beginning of current visual line.
4725 With argument N not nil or 1, move forward N - 1 visual lines first.
4726 If point reaches the beginning or end of buffer, it stops there.
4727 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4728 (interactive "^p")
4729 (or n (setq n 1))
4730 (let ((opoint (point)))
4731 (if (/= n 1)
4732 (let ((line-move-visual t))
4733 (line-move (1- n) t)))
4734 (vertical-motion 0)
4735 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4736 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4738 (defun kill-visual-line (&optional arg)
4739 "Kill the rest of the visual line.
4740 With prefix argument ARG, kill that many visual lines from point.
4741 If ARG is negative, kill visual lines backward.
4742 If ARG is zero, kill the text before point on the current visual
4743 line.
4745 If you want to append the killed line to the last killed text,
4748 If the buffer is read-only, Emacs will beep and refrain from deleting
4749 the line, but put the line in the kill ring anyway. This means that
4750 you can use this command to copy text from a read-only buffer.
4751 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4752 even beep.)"
4753 (interactive "P")
4754 ;; Like in `kill-line', it's better to move point to the other end
4755 ;; of the kill before killing.
4756 (let ((opoint (point))
4757 (kill-whole-line (and kill-whole-line (bolp))))
4758 (if arg
4759 (vertical-motion (prefix-numeric-value arg))
4760 (end-of-visual-line 1)
4761 (if (= (point) opoint)
4762 (vertical-motion 1)
4763 ;; Skip any trailing whitespace at the end of the visual line.
4764 ;; We used to do this only if `show-trailing-whitespace' is
4765 ;; nil, but that's wrong; the correct thing would be to check
4766 ;; whether the trailing whitespace is highlighted. But, it's
4767 ;; OK to just do this unconditionally.
4770 (1+ (point))
4771 (point)))))
4773 (defun next-logical-line (&optional arg try-vscroll)
4774 "Move cursor vertically down ARG lines.
4775 This is identical to `next-line', except that it always moves
4776 by logical lines instead of visual lines, ignoring the value of
4777 the variable `line-move-visual'."
4779 (let ((line-move-visual nil))
4780 (with-no-warnings
4781 (next-line arg try-vscroll))))
4783 (defun previous-logical-line (&optional arg try-vscroll)
4784 "Move cursor vertically up ARG lines.
4785 This is identical to `previous-line', except that it always moves
4786 by logical lines instead of visual lines, ignoring the value of
4787 the variable `line-move-visual'."
4789 (let ((line-move-visual nil))
4790 (with-no-warnings
4791 (previous-line arg try-vscroll))))
4793 (defgroup visual-line nil
4794 "Editing based on visual lines."
4795 :group 'convenience
4796 :version "23.1")
4798 (defvar visual-line-mode-map
4799 (let ((map (make-sparse-keymap)))
4800 (define-key map [remap kill-line] 'kill-visual-line)
4801 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4802 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4803 ;; These keybindings interfere with xterm function keys. Are
4804 ;; there any other suitable bindings?
4805 ;; (define-key map "\M-[" 'previous-logical-line)
4806 ;; (define-key map "\M-]" 'next-logical-line)
4807 map))
4809 (defcustom visual-line-fringe-indicators '(nil nil)
4810 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4811 The value should be a list of the form (LEFT RIGHT), where LEFT
4812 and RIGHT are symbols representing the bitmaps to display, to
4813 indicate wrapped lines, in the left and right fringes respectively.
4814 See also `fringe-indicator-alist'.
4815 The default is not to display fringe indicators for wrapped lines.
4816 This variable does not affect fringe indicators displayed for
4817 other purposes."
4818 :type '(list (choice (const :tag "Hide left indicator" nil)
4819 (const :tag "Left curly arrow" left-curly-arrow)
4820 (symbol :tag "Other bitmap"))
4821 (choice (const :tag "Hide right indicator" nil)
4822 (const :tag "Right curly arrow" right-curly-arrow)
4823 (symbol :tag "Other bitmap")))
4824 :set (lambda (symbol value)
4825 (dolist (buf (buffer-list))
4826 (with-current-buffer buf
4827 (when (and (boundp 'visual-line-mode)
4828 (symbol-value 'visual-line-mode))
4829 (setq fringe-indicator-alist
4830 (cons (cons 'continuation value)
4831 (assq-delete-all
4832 'continuation
4833 (copy-tree fringe-indicator-alist)))))))
4834 (set-default symbol value)))
4836 (defvar visual-line--saved-state nil)
4838 (define-minor-mode visual-line-mode
4839 "Redefine simple editing commands to act on visual lines, not logical lines.
4840 This also turns on `word-wrap' in the buffer."
4841 :keymap visual-line-mode-map
4842 :group 'visual-line
4843 :lighter " Wrap"
4844 (if visual-line-mode
4845 (progn
4846 (set (make-local-variable 'visual-line--saved-state) nil)
4847 ;; Save the local values of some variables, to be restored if
4848 ;; visual-line-mode is turned off.
4849 (dolist (var '(line-move-visual truncate-lines
4850 truncate-partial-width-windows
4851 word-wrap fringe-indicator-alist))
4852 (if (local-variable-p var)
4853 (push (cons var (symbol-value var))
4854 visual-line--saved-state)))
4855 (set (make-local-variable 'line-move-visual) t)
4856 (set (make-local-variable 'truncate-partial-width-windows) nil)
4857 (setq truncate-lines nil
4858 word-wrap t
4859 fringe-indicator-alist
4860 (cons (cons 'continuation visual-line-fringe-indicators)
4861 fringe-indicator-alist)))
4862 (kill-local-variable 'line-move-visual)
4863 (kill-local-variable 'word-wrap)
4864 (kill-local-variable 'truncate-lines)
4865 (kill-local-variable 'truncate-partial-width-windows)
4866 (kill-local-variable 'fringe-indicator-alist)
4867 (dolist (saved visual-line--saved-state)
4868 (set (make-local-variable (car saved)) (cdr saved)))
4869 (kill-local-variable 'visual-line--saved-state)))
4871 (defun turn-on-visual-line-mode ()
4872 (visual-line-mode 1))
4874 (define-globalized-minor-mode global-visual-line-mode
4875 visual-line-mode turn-on-visual-line-mode
4876 :lighter " vl")
4878 \f
4879 (defun transpose-chars (arg)
4880 "Interchange characters around point, moving forward one character.
4881 With prefix arg ARG, effect is to take character before point
4882 and drag it forward past ARG other characters (backward if ARG negative).
4883 If no argument and at end of line, the previous two chars are exchanged."
4884 (interactive "*P")
4885 (and (null arg) (eolp) (forward-char -1))
4886 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4888 (defun transpose-words (arg)
4889 "Interchange words around point, leaving point at end of them.
4890 With prefix arg ARG, effect is to take word before or around point
4891 and drag it forward past ARG other words (backward if ARG negative).
4892 If ARG is zero, the words around or after point and around or after mark
4893 are interchanged."
4894 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4895 (interactive "*p")
4896 (transpose-subr 'forward-word arg))
4898 (defun transpose-sexps (arg)
4900 Does not work on a sexp that point is in the middle of
4901 if it is a list or string."
4902 (interactive "*p")
4903 (transpose-subr
4904 (lambda (arg)
4905 ;; Here we should try to simulate the behavior of
4906 ;; (cons (progn (forward-sexp x) (point))
4907 ;; (progn (forward-sexp (- x)) (point)))
4908 ;; Except that we don't want to rely on the second forward-sexp
4909 ;; putting us back to where we want to be, since forward-sexp-function
4910 ;; might do funny things like infix-precedence.
4911 (if (if (> arg 0)
4913 (and (not (bobp))
4915 ;; Jumping over a symbol. We might be inside it, mind you.
4916 (progn (funcall (if (> arg 0)
4917 'skip-syntax-backward 'skip-syntax-forward)
4918 "w_")
4919 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4920 ;; Otherwise, we're between sexps. Take a step back before jumping
4921 ;; to make sure we'll obey the same precedence no matter which direction
4922 ;; we're going.
4923 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4924 (cons (save-excursion (forward-sexp arg) (point))
4925 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4926 (not (zerop (funcall (if (> arg 0)
4927 'skip-syntax-forward
4928 'skip-syntax-backward)
4929 ".")))))
4930 (point)))))
4931 arg 'special))
4933 (defun transpose-lines (arg)
4934 "Exchange current line and previous line, leaving point after both.
4935 With argument ARG, takes previous line and moves it past ARG lines.
4936 With argument 0, interchanges line point is in with line mark is in."
4937 (interactive "*p")
4938 (transpose-subr (function
4939 (lambda (arg)
4940 (if (> arg 0)
4941 (progn
4942 ;; Move forward over ARG lines,
4943 ;; but create newlines if necessary.
4944 (setq arg (forward-line arg))
4946 (setq arg (1+ arg)))
4947 (if (> arg 0)
4948 (newline arg)))
4949 (forward-line arg))))
4950 arg))
4952 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
4953 ;; which seems inconsistent with the ARG /= 0 case.
4954 ;; FIXME document SPECIAL.
4955 (defun transpose-subr (mover arg &optional special)
4956 "Subroutine to do the work of transposing objects.
4957 Works for lines, sentences, paragraphs, etc. MOVER is a function that
4958 moves forward by units of the given object (e.g. forward-sentence,
4959 forward-paragraph). If ARG is zero, exchanges the current object
4960 with the one containing mark. If ARG is an integer, moves the
4961 current object past ARG following (if ARG is positive) or
4962 preceding (if ARG is negative) objects, leaving point after the
4963 current object."
4964 (let ((aux (if special mover
4965 (lambda (x)
4966 (cons (progn (funcall mover x) (point))
4967 (progn (funcall mover (- x)) (point))))))
4968 pos1 pos2)
4969 (cond
4970 ((= arg 0)
4971 (save-excursion
4972 (setq pos1 (funcall aux 1))
4973 (goto-char (or (mark) (error "No mark set in this buffer")))
4974 (setq pos2 (funcall aux 1))
4975 (transpose-subr-1 pos1 pos2))
4976 (exchange-point-and-mark))
4977 ((> arg 0)
4978 (setq pos1 (funcall aux -1))
4979 (setq pos2 (funcall aux arg))
4980 (transpose-subr-1 pos1 pos2)
4981 (goto-char (car pos2)))
4982 (t
4983 (setq pos1 (funcall aux -1))
4984 (goto-char (car pos1))
4985 (setq pos2 (funcall aux arg))
4986 (transpose-subr-1 pos1 pos2)))))
4988 (defun transpose-subr-1 (pos1 pos2)
4989 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
4990 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
4991 (when (> (car pos1) (car pos2))
4992 (let ((swap pos1))
4993 (setq pos1 pos2 pos2 swap)))
4994 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
4995 (atomic-change-group
4996 (let (word2)
4997 ;; FIXME: We first delete the two pieces of text, so markers that
4998 ;; used to point to after the text end up pointing to before it :-(
4999 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5000 (goto-char (car pos2))
5001 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5002 (goto-char (car pos1))
5003 (insert word2))))
5004 \f
5005 (defun backward-word (&optional arg)
5006 "Move backward until encountering the beginning of a word.
5007 With argument ARG, do this that many times."
5008 (interactive "^p")
5009 (forward-word (- (or arg 1))))
5011 (defun mark-word (&optional arg allow-extend)
5012 "Set mark ARG words away from point.
5014 move to with the same argument.
5015 Interactively, if this command is repeated
5016 or (in Transient Mark mode) if the mark is active,
5017 it marks the next ARG words after the ones already marked."
5019 (cond ((and allow-extend
5020 (or (and (eq last-command this-command) (mark t))
5021 (region-active-p)))
5022 (setq arg (if arg (prefix-numeric-value arg)
5023 (if (< (mark) (point)) -1 1)))
5024 (set-mark
5025 (save-excursion
5026 (goto-char (mark))
5027 (forward-word arg)
5028 (point))))
5029 (t
5030 (push-mark
5031 (save-excursion
5032 (forward-word (prefix-numeric-value arg))
5033 (point))
5034 nil t))))
5036 (defun kill-word (arg)
5037 "Kill characters forward until encountering the end of a word.
5038 With argument ARG, do this that many times."
5039 (interactive "p")
5040 (kill-region (point) (progn (forward-word arg) (point))))
5042 (defun backward-kill-word (arg)
5043 "Kill characters backward until encountering the beginning of a word.
5044 With argument ARG, do this that many times."
5045 (interactive "p")
5046 (kill-word (- arg)))
5048 (defun current-word (&optional strict really-word)
5049 "Return the symbol or word that point is on (or a nearby one) as a string.
5050 The return value includes no text properties.
5051 If optional arg STRICT is non-nil, return nil unless point is within
5052 or adjacent to a symbol or word. In all cases the value can be nil
5053 if there is no word nearby.
5054 The function, belying its name, normally finds a symbol.
5055 If optional arg REALLY-WORD is non-nil, it finds just a word."
5056 (save-excursion
5057 (let* ((oldpoint (point)) (start (point)) (end (point))
5058 (syntaxes (if really-word "w" "w_"))
5059 (not-syntaxes (concat "^" syntaxes)))
5060 (skip-syntax-backward syntaxes) (setq start (point))
5061 (goto-char oldpoint)
5062 (skip-syntax-forward syntaxes) (setq end (point))
5063 (when (and (eq start oldpoint) (eq end oldpoint)
5064 ;; Point is neither within nor adjacent to a word.
5065 (not strict))
5066 ;; Look for preceding word in same line.
5067 (skip-syntax-backward not-syntaxes (line-beginning-position))
5068 (if (bolp)
5069 ;; No preceding word in same line.
5070 ;; Look for following word in same line.
5071 (progn
5072 (skip-syntax-forward not-syntaxes (line-end-position))
5073 (setq start (point))
5074 (skip-syntax-forward syntaxes)
5075 (setq end (point)))
5076 (setq end (point))
5077 (skip-syntax-backward syntaxes)
5078 (setq start (point))))
5079 ;; If we found something nonempty, return it as a string.
5080 (unless (= start end)
5081 (buffer-substring-no-properties start end)))))
5082 \f
5083 (defcustom fill-prefix nil
5084 "String for filling to insert at front of new line, or nil for none."
5085 :type '(choice (const :tag "None" nil)
5086 string)
5087 :group 'fill)
5088 (make-variable-buffer-local 'fill-prefix)
5089 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5091 (defcustom auto-fill-inhibit-regexp nil
5092 "Regexp to match lines which should not be auto-filled."
5093 :type '(choice (const :tag "None" nil)
5094 regexp)
5095 :group 'fill)
5097 ;; This function is used as the auto-fill-function of a buffer
5098 ;; when Auto-Fill mode is enabled.
5099 ;; It returns t if it really did any work.
5100 ;; (Actually some major modes use a different auto-fill function,
5101 ;; but this one is the default one.)
5102 (defun do-auto-fill ()
5103 (let (fc justify give-up
5104 (fill-prefix fill-prefix))
5105 (if (or (not (setq justify (current-justification)))
5106 (null (setq fc (current-fill-column)))
5107 (and (eq justify 'left)
5108 (<= (current-column) fc))
5109 (and auto-fill-inhibit-regexp
5110 (save-excursion (beginning-of-line)
5111 (looking-at auto-fill-inhibit-regexp))))
5112 nil ;; Auto-filling not required
5113 (if (memq justify '(full center right))
5114 (save-excursion (unjustify-current-line)))
5116 ;; Choose a fill-prefix automatically.
5117 (when (and adaptive-fill-mode
5118 (or (null fill-prefix) (string= fill-prefix "")))
5119 (let ((prefix
5120 (fill-context-prefix
5121 (save-excursion (backward-paragraph 1) (point))
5122 (save-excursion (forward-paragraph 1) (point)))))
5123 (and prefix (not (equal prefix ""))
5124 ;; Use auto-indentation rather than a guessed empty prefix.
5125 (not (and fill-indent-according-to-mode
5127 (setq fill-prefix prefix))))
5129 (while (and (not give-up) (> (current-column) fc))
5130 ;; Determine where to split the line.
5131 (let* (after-prefix
5132 (fill-point
5133 (save-excursion
5134 (beginning-of-line)
5135 (setq after-prefix (point))
5136 (and fill-prefix
5137 (looking-at (regexp-quote fill-prefix))
5138 (setq after-prefix (match-end 0)))
5139 (move-to-column (1+ fc))
5140 (fill-move-to-break-point after-prefix)
5141 (point))))
5143 ;; See whether the place we found is any good.
5144 (if (save-excursion
5145 (goto-char fill-point)
5146 (or (bolp)
5147 ;; There is no use breaking at end of line.
5148 (save-excursion (skip-chars-forward " ") (eolp))
5149 ;; It is futile to split at the end of the prefix
5150 ;; since we would just insert the prefix again.
5151 (and after-prefix (<= (point) after-prefix))
5152 ;; Don't split right after a comment starter
5153 ;; since we would just make another comment starter.
5154 (and comment-start-skip
5155 (let ((limit (point)))
5156 (beginning-of-line)
5157 (and (re-search-forward comment-start-skip
5158 limit t)
5159 (eq (point) limit))))))
5160 ;; No good place to break => stop trying.
5161 (setq give-up t)
5162 ;; Ok, we have a useful place to break the line. Do it.
5163 (let ((prev-column (current-column)))
5164 ;; If point is at the fill-point, do not `save-excursion'.
5165 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5166 ;; point will end up before it rather than after it.
5167 (if (save-excursion
5169 (= (point) fill-point))
5170 (default-indent-new-line t)
5171 (save-excursion
5172 (goto-char fill-point)
5173 (default-indent-new-line t)))
5174 ;; Now do justification, if required
5175 (if (not (eq justify 'left))
5176 (save-excursion
5177 (end-of-line 0)
5178 (justify-current-line justify nil t)))
5179 ;; If making the new line didn't reduce the hpos of
5180 ;; the end of the line, then give up now;
5181 ;; trying again will not help.
5182 (if (>= (current-column) prev-column)
5183 (setq give-up t))))))
5184 ;; Justify last line.
5185 (justify-current-line justify t t)
5186 t)))
5188 (defvar comment-line-break-function 'comment-indent-new-line
5189 "*Mode-specific function which line breaks and continues a comment.
5190 This function is called during auto-filling when a comment syntax
5191 is defined.
5192 The function should take a single optional argument, which is a flag
5193 indicating whether it should use soft newlines.")
5195 (defun default-indent-new-line (&optional soft)
5196 "Break line at point and indent.
5197 If a comment syntax is defined, call `comment-indent-new-line'.
5199 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5200 unless optional argument SOFT is non-nil."
5201 (interactive)
5202 (if comment-start
5203 (funcall comment-line-break-function soft)
5204 ;; Insert the newline before removing empty space so that markers
5205 ;; get preserved better.
5207 (save-excursion (forward-char -1) (delete-horizontal-space))
5208 (delete-horizontal-space)
5210 (if (and fill-prefix (not adaptive-fill-mode))
5211 ;; Blindly trust a non-adaptive fill-prefix.
5212 (progn
5213 (indent-to-left-margin)
5214 (insert-before-markers-and-inherit fill-prefix))
5216 (cond
5217 ;; If there's an adaptive prefix, use it unless we're inside
5218 ;; a comment and the prefix is not a comment starter.
5219 (fill-prefix
5220 (indent-to-left-margin)
5221 (insert-and-inherit fill-prefix))
5222 ;; If we're not inside a comment, just try to indent.
5223 (t (indent-according-to-mode))))))
5225 (defvar normal-auto-fill-function 'do-auto-fill
5226 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5227 Some major modes set this.")
5229 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5230 ;; `functions' and `hooks' are usually unsafe to set, but setting
5231 ;; auto-fill-function to nil in a file-local setting is safe and
5232 ;; can be useful to prevent auto-filling.
5233 (put 'auto-fill-function 'safe-local-variable 'null)
5234 ;; FIXME: turn into a proper minor mode.
5235 ;; Add a global minor mode version of it.
5236 (define-minor-mode auto-fill-mode
5237 "Toggle Auto Fill mode.
5238 With ARG, turn Auto Fill mode on if and only if ARG is positive.
5239 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
5240 automatically breaks the line at a previous space.
5242 The value of `normal-auto-fill-function' specifies the function to use
5243 for `auto-fill-function' when turning Auto Fill mode on."
5244 :variable (eq auto-fill-function normal-auto-fill-function))
5246 ;; This holds a document string used to document auto-fill-mode.
5247 (defun auto-fill-function ()
5248 "Automatically break line at a previous space, in insertion of text."
5249 nil)
5251 (defun turn-on-auto-fill ()
5252 "Unconditionally turn on Auto Fill mode."
5253 (auto-fill-mode 1))
5255 (defun turn-off-auto-fill ()
5256 "Unconditionally turn off Auto Fill mode."
5257 (auto-fill-mode -1))
5259 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5261 (defun set-fill-column (arg)
5262 "Set `fill-column' to specified argument.
5265 (interactive
5266 (list (or current-prefix-arg
5267 ;; We used to use current-column silently, but C-x f is too easily
5268 ;; typed as a typo for C-x C-f, so we turned it into an error and
5269 ;; now an interactive prompt.
5270 (read-number "Set fill-column to: " (current-column)))))
5271 (if (consp arg)
5272 (setq arg (current-column)))
5273 (if (not (integerp arg))
5274 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5275 (error "set-fill-column requires an explicit argument")
5276 (message "Fill column set to %d (was %d)" arg fill-column)
5277 (setq fill-column arg)))
5278 \f
5279 (defun set-selective-display (arg)
5280 "Set `selective-display' to ARG; clear it if no arg.
5281 When the value of `selective-display' is a number > 0,
5282 lines whose indentation is >= that value are not displayed.
5283 The variable `selective-display' has a separate value for each buffer."
5284 (interactive "P")
5285 (if (eq selective-display t)
5286 (error "selective-display already in use for marked lines"))
5287 (let ((current-vpos
5288 (save-restriction
5289 (narrow-to-region (point-min) (point))
5290 (goto-char (window-start))
5291 (vertical-motion (window-height)))))
5292 (setq selective-display
5293 (and arg (prefix-numeric-value arg)))
5294 (recenter current-vpos))
5295 (set-window-start (selected-window) (window-start (selected-window)))
5296 (princ "selective-display set to " t)
5297 (prin1 selective-display t)
5298 (princ "." t))
5300 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5302 (defun toggle-truncate-lines (&optional arg)
5303 "Toggle whether to fold or truncate long lines for the current buffer.
5304 With prefix argument ARG, truncate long lines if ARG is positive,
5305 otherwise don't truncate them. Note that in side-by-side windows,
5306 this command has no effect if `truncate-partial-width-windows'
5307 is non-nil."
5308 (interactive "P")
5309 (setq truncate-lines
5310 (if (null arg)
5311 (not truncate-lines)
5312 (> (prefix-numeric-value arg) 0)))
5313 (force-mode-line-update)
5314 (unless truncate-lines
5315 (let ((buffer (current-buffer)))
5316 (walk-windows (lambda (window)
5317 (if (eq buffer (window-buffer window))
5318 (set-window-hscroll window 0)))
5319 nil t)))
5320 (message "Truncate long lines %s"
5321 (if truncate-lines "enabled" "disabled")))
5323 (defun toggle-word-wrap (&optional arg)
5324 "Toggle whether to use word-wrapping for continuation lines.
5325 With prefix argument ARG, wrap continuation lines at word boundaries
5326 if ARG is positive, otherwise wrap them at the right screen edge.
5327 This command toggles the value of `word-wrap'. It has no effect
5328 if long lines are truncated."
5329 (interactive "P")
5330 (setq word-wrap
5331 (if (null arg)
5332 (not word-wrap)
5333 (> (prefix-numeric-value arg) 0)))
5334 (force-mode-line-update)
5335 (message "Word wrapping %s"
5336 (if word-wrap "enabled" "disabled")))
5338 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5339 "The string displayed in the mode line when in overwrite mode.")
5340 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5341 "The string displayed in the mode line when in binary overwrite mode.")
5343 (define-minor-mode overwrite-mode
5344 "Toggle overwrite mode.
5345 With prefix argument ARG, turn overwrite mode on if ARG is positive,
5346 otherwise turn it off. In overwrite mode, printing characters typed
5347 in replace existing text on a one-for-one basis, rather than pushing
5348 it to the right. At the end of a line, such characters extend the line.
5349 Before a tab, such characters insert until the tab is filled in.
5351 is supposed to make it easier to insert characters when necessary."
5352 :variable (eq overwrite-mode 'overwrite-mode-textual))
5354 (define-minor-mode binary-overwrite-mode
5355 "Toggle binary overwrite mode.
5356 With prefix argument ARG, turn binary overwrite mode on if ARG is
5357 positive, otherwise turn it off. In binary overwrite mode, printing
5358 characters typed in replace existing text. Newlines are not treated
5359 specially, so typing at the end of a line joins the line to the next,
5360 with the typed character between them. Typing before a tab character
5362 replaces the text at the cursor, just as ordinary typing characters do.
5364 Note that binary overwrite mode is not its own minor mode; it is a
5365 specialization of overwrite mode, entered by setting the
5366 `overwrite-mode' variable to `overwrite-mode-binary'."
5367 :variable (eq overwrite-mode 'overwrite-mode-binary))
5369 (define-minor-mode line-number-mode
5370 "Toggle Line Number mode.
5371 With ARG, turn Line Number mode on if ARG is positive, otherwise
5372 turn it off. When Line Number mode is enabled, the line number
5373 appears in the mode line.
5375 Line numbers do not appear for very large buffers and buffers
5376 with very long lines; see variables `line-number-display-limit'
5377 and `line-number-display-limit-width'."
5378 :init-value t :global t :group 'mode-line)
5380 (define-minor-mode column-number-mode
5381 "Toggle Column Number mode.
5382 With ARG, turn Column Number mode on if ARG is positive,
5383 otherwise turn it off. When Column Number mode is enabled, the
5384 column number appears in the mode line."
5385 :global t :group 'mode-line)
5387 (define-minor-mode size-indication-mode
5388 "Toggle Size Indication mode.
5389 With ARG, turn Size Indication mode on if ARG is positive,
5390 otherwise turn it off. When Size Indication mode is enabled, the
5391 size of the accessible part of the buffer appears in the mode line."
5392 :global t :group 'mode-line)
5394 (define-minor-mode auto-save-mode
5395 "Toggle auto-saving of contents of current buffer.
5396 With prefix argument ARG, turn auto-saving on if positive, else off."
5397 :variable ((and buffer-auto-save-file-name
5398 ;; If auto-save is off because buffer has shrunk,
5399 ;; then toggling should turn it on.
5400 (>= buffer-saved-size 0))
5401 . (lambda (val)
5402 (setq buffer-auto-save-file-name
5403 (cond
5404 ((null val) nil)
5405 ((and buffer-file-name auto-save-visited-file-name
5406 (not buffer-read-only))
5407 buffer-file-name)
5408 (t (make-auto-save-file-name))))))
5409 ;; If -1 was stored here, to temporarily turn off saving,
5410 ;; turn it back on.
5411 (and (< buffer-saved-size 0)
5412 (setq buffer-saved-size 0)))
5413 \f
5414 (defgroup paren-blinking nil
5415 "Blinking matching of parens and expressions."
5416 :prefix "blink-matching-"
5417 :group 'paren-matching)
5419 (defcustom blink-matching-paren t
5420 "Non-nil means show matching open-paren when close-paren is inserted."
5421 :type 'boolean
5422 :group 'paren-blinking)
5424 (defcustom blink-matching-paren-on-screen t
5425 "Non-nil means show matching open-paren when it is on screen.
5426 If nil, don't show it (but the open-paren can still be shown
5427 when it is off screen).
5429 This variable has no effect if `blink-matching-paren' is nil.
5430 \(In that case, the open-paren is never shown.)
5431 It is also ignored if `show-paren-mode' is enabled."
5432 :type 'boolean
5433 :group 'paren-blinking)
5435 (defcustom blink-matching-paren-distance (* 100 1024)
5436 "If non-nil, maximum distance to search backwards for matching open-paren.
5437 If nil, search stops at the beginning of the accessible portion of the buffer."
5438 :version "23.2" ; 25->100k
5439 :type '(choice (const nil) integer)
5440 :group 'paren-blinking)
5442 (defcustom blink-matching-delay 1
5443 "Time in seconds to delay after showing a matching paren."
5444 :type 'number
5445 :group 'paren-blinking)
5447 (defcustom blink-matching-paren-dont-ignore-comments nil
5448 "If nil, `blink-matching-paren' ignores comments.
5449 More precisely, when looking for the matching parenthesis,
5450 it skips the contents of comments that end before point."
5451 :type 'boolean
5452 :group 'paren-blinking)
5454 (defun blink-matching-check-mismatch (start end)
5455 "Return whether or not START...END are matching parens.
5456 END is the current point and START is the blink position.
5457 START might be nil if no matching starter was found.
5458 Returns non-nil if we find there is a mismatch."
5459 (let* ((end-syntax (syntax-after (1- end)))
5460 (matching-paren (and (consp end-syntax)
5461 (eq (syntax-class end-syntax) 5)
5462 (cdr end-syntax))))
5463 ;; For self-matched chars like " and $, we can't know when they're
5464 ;; mismatched or unmatched, so we can only do it for parens.
5465 (when matching-paren
5466 (not (and start
5467 (or
5468 (eq (char-after start) matching-paren)
5469 ;; The cdr might hold a new paren-class info rather than
5470 ;; a matching-char info, in which case the two CDRs
5471 ;; should match.
5472 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5474 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5475 "Function to check parentheses mismatches.
5476 The function takes two arguments (START and END) where START is the
5477 position just before the opening token and END is the position right after.
5478 START can be nil, if it was not found.
5479 The function should return non-nil if the two tokens do not match.")
5481 (defun blink-matching-open ()
5482 "Move cursor momentarily to the beginning of the sexp before point."
5483 (interactive)
5484 (when (and (not (bobp))
5485 blink-matching-paren)
5486 (let* ((oldpos (point))
5487 (message-log-max nil) ; Don't log messages about paren matching.
5488 (blinkpos
5489 (save-excursion
5490 (save-restriction
5491 (if blink-matching-paren-distance
5492 (narrow-to-region
5493 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5494 (- (point) blink-matching-paren-distance))
5495 oldpos))
5496 (let ((parse-sexp-ignore-comments
5497 (and parse-sexp-ignore-comments
5498 (not blink-matching-paren-dont-ignore-comments))))
5499 (condition-case ()
5500 (progn
5501 (forward-sexp -1)
5502 ;; backward-sexp skips backward over prefix chars,
5503 ;; so move back to the matching paren.
5504 (while (and (< (point) (1- oldpos))
5505 (let ((code (syntax-after (point))))
5506 (or (eq (syntax-class code) 6)
5507 (eq (logand 1048576 (car code))
5508 1048576))))
5509 (forward-char 1))
5510 (point))
5511 (error nil))))))
5512 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5513 (cond
5514 (mismatch
5515 (if blinkpos
5516 (if (minibufferp)
5517 (minibuffer-message " [Mismatched parentheses]")
5518 (message "Mismatched parentheses"))
5519 (if (minibufferp)
5520 (minibuffer-message " [Unmatched parenthesis]")
5521 (message "Unmatched parenthesis"))))
5522 ((not blinkpos) nil)
5523 ((pos-visible-in-window-p blinkpos)
5524 ;; Matching open within window, temporarily move to blinkpos but only
5525 ;; if `blink-matching-paren-on-screen' is non-nil.
5526 (and blink-matching-paren-on-screen
5527 (not show-paren-mode)
5528 (save-excursion
5529 (goto-char blinkpos)
5530 (sit-for blink-matching-delay))))
5531 (t
5532 (save-excursion
5533 (goto-char blinkpos)
5534 (let ((open-paren-line-string
5535 ;; Show what precedes the open in its line, if anything.
5536 (cond
5538 (buffer-substring (line-beginning-position)
5539 (1+ blinkpos)))
5540 ;; Show what follows the open in its line, if anything.
5541 ((save-excursion
5542 (forward-char 1)
5544 (not (eolp)))
5545 (buffer-substring blinkpos
5546 (line-end-position)))
5547 ;; Otherwise show the previous nonblank line,
5548 ;; if there is one.
5550 (concat
5551 (buffer-substring (progn
5553 (line-beginning-position))
5554 (progn (end-of-line)
5556 (point)))
5557 ;; Replace the newline and other whitespace with `...'.
5558 "..."
5559 (buffer-substring blinkpos (1+ blinkpos))))
5560 ;; There is nothing to show except the char itself.
5561 (t (buffer-substring blinkpos (1+ blinkpos))))))
5562 (message "Matches %s"
5563 (substring-no-properties open-paren-line-string)))))))))
5565 (defvar blink-paren-function 'blink-matching-open
5566 "Function called, if non-nil, whenever a close parenthesis is inserted.
5567 More precisely, a char with closeparen syntax is self-inserted.")
5569 (defun blink-paren-post-self-insert-function ()
5570 (when (and (eq (char-before) last-command-event) ; Sanity check.
5571 (memq (char-syntax last-command-event) '(?\) ?\$))
5572 blink-paren-function
5573 (not executing-kbd-macro)
5574 (not noninteractive)
5575 ;; Verify an even number of quoting characters precede the close.
5576 (= 1 (logand 1 (- (point)
5577 (save-excursion
5578 (forward-char -1)
5580 (point))))))
5581 (funcall blink-paren-function)))
5583 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5584 ;; Most likely, this hook is nil, so this arg doesn't matter,
5585 ;; but I use it as a reminder that this function usually
5586 ;; likes to be run after others since it does `sit-for'.
5587 'append)
5588 \f
5589 ;; This executes C-g typed while Emacs is waiting for a command.
5590 ;; Quitting out of a program does not go through here;
5591 ;; that happens in the QUIT macro at the C code level.
5592 (defun keyboard-quit ()
5593 "Signal a `quit' condition.
5594 During execution of Lisp code, this character causes a quit directly.
5595 At top-level, as an editor command, this simply beeps."
5596 (interactive)
5597 ;; Avoid adding the region to the window selection.
5598 (setq saved-region-selection nil)
5599 (let (select-active-regions)
5600 (deactivate-mark))
5601 (if (fboundp 'kmacro-keyboard-quit)
5602 (kmacro-keyboard-quit))
5603 (setq defining-kbd-macro nil)
5604 (signal 'quit nil))
5606 (defvar buffer-quit-function nil
5609 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5611 (defun keyboard-escape-quit ()
5613 This command can exit an interactive command such as `query-replace',
5614 can clear out a prefix argument or a region,
5615 can get out of the minibuffer or other recursive edit,
5616 cancel the use of the current buffer (for special-purpose buffers),
5617 or go back to just one window (by deleting all but the selected window)."
5618 (interactive)
5619 (cond ((eq last-command 'mode-exited) nil)
5620 ((region-active-p)
5621 (deactivate-mark))
5622 ((> (minibuffer-depth) 0)
5623 (abort-recursive-edit))
5624 (current-prefix-arg
5625 nil)
5626 ((> (recursion-depth) 0)
5627 (exit-recursive-edit))
5628 (buffer-quit-function
5629 (funcall buffer-quit-function))
5630 ((not (one-window-p t))
5631 (delete-other-windows))
5633 (bury-buffer))))
5635 (defun play-sound-file (file &optional volume device)
5636 "Play sound stored in FILE.
5637 VOLUME and DEVICE correspond to the keywords of the sound
5638 specification for `play-sound'."
5639 (interactive "fPlay sound file: ")
5640 (let ((sound (list :file file)))
5641 (if volume
5642 (plist-put sound :volume volume))
5643 (if device
5644 (plist-put sound :device device))
5645 (push 'sound sound)
5646 (play-sound sound)))
5648 \f
5649 (defcustom read-mail-command 'rmail
5650 "Your preference for a mail reading package.
5651 This is used by some keybindings which support reading mail.
5652 See also `mail-user-agent' concerning sending mail."
5655 (function-item :tag "Emacs interface to MH"
5657 (function :tag "Other"))
5658 :version "21.1"
5659 :group 'mail)
5661 (defcustom mail-user-agent 'message-user-agent
5662 "Your preference for a mail composition package.
5663 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5664 outgoing email message. This variable lets you specify which
5665 mail-sending package you prefer.
5667 Valid values include:
5669 `message-user-agent' -- use the Message package.
5670 See Info node `(message)'.
5671 `sendmail-user-agent' -- use the Mail package.
5672 See Info node `(emacs)Sending Mail'.
5673 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5674 See Info node `(mh-e)'.
5675 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5676 paraphernalia, particularly the Gcc: header for
5677 archiving.
5679 Additional valid symbols may be available; check with the author of
5680 your package for details. The function should return non-nil if it
5681 succeeds.
5683 See also `read-mail-command' concerning reading mail."
5684 :type '(radio (function-item :tag "Message package"
5686 message-user-agent)
5687 (function-item :tag "Mail package"
5689 sendmail-user-agent)
5690 (function-item :tag "Emacs interface to MH"
5692 mh-e-user-agent)
5693 (function-item :tag "Message with full Gnus features"
5695 gnus-user-agent)
5696 (function :tag "Other"))
5697 :version "23.2" ; sendmail->message
5698 :group 'mail)
5700 (defcustom compose-mail-user-agent-warnings t
5701 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5702 If the value of `mail-user-agent' is the default, and the user
5703 appears to have customizations applying to the old default,
5704 `compose-mail' issues a warning."
5705 :type 'boolean
5706 :version "23.2"
5707 :group 'mail)
5709 (define-mail-user-agent 'sendmail-user-agent
5710 'sendmail-user-agent-compose
5711 'mail-send-and-exit)
5713 (defun rfc822-goto-eoh ()
5714 ;; Go to header delimiter line in a mail message, following RFC822 rules
5715 (goto-char (point-min))
5716 (when (re-search-forward
5718 (goto-char (match-beginning 0))))
5720 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
5721 switch-function yank-action
5722 send-actions)
5723 (if switch-function
5724 (let ((special-display-buffer-names nil)
5725 (special-display-regexps nil)
5726 (same-window-buffer-names nil)
5727 (same-window-regexps nil))
5728 (funcall switch-function "*mail*")))
5729 (let ((cc (cdr (assoc-string "cc" other-headers t)))
5730 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
5731 (body (cdr (assoc-string "body" other-headers t))))
5732 (or (mail continue to subject in-reply-to cc yank-action send-actions)
5733 continue
5734 (error "Message aborted"))
5735 (save-excursion
5736 (rfc822-goto-eoh)
5737 (while other-headers
5738 (unless (member-ignore-case (car (car other-headers))
5739 '("in-reply-to" "cc" "body"))
5740 (insert (car (car other-headers)) ": "
5741 (cdr (car other-headers))
5743 (setq other-headers (cdr other-headers)))
5744 (when body
5745 (forward-line 1)
5746 (insert body))
5747 t)))
5749 (defun compose-mail (&optional to subject other-headers continue
5750 switch-function yank-action send-actions)
5751 "Start composing a mail message to send.
5752 This uses the user's chosen mail composition package
5753 as selected with the variable `mail-user-agent'.
5754 The optional arguments TO and SUBJECT specify recipients
5755 and the initial Subject field, respectively.
5757 OTHER-HEADERS is an alist specifying additional
5758 header fields. Elements look like (HEADER . VALUE) where both
5759 HEADER and VALUE are strings.
5761 CONTINUE, if non-nil, says to continue editing a message already
5762 being composed. Interactively, CONTINUE is the prefix argument.
5764 SWITCH-FUNCTION, if non-nil, is a function to use to
5765 switch to and display the buffer used for mail composition.
5767 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5768 to insert the raw text of the message being replied to.
5769 It has the form (FUNCTION . ARGS). The user agent will apply
5770 FUNCTION to ARGS, to insert the raw text of the original message.
5771 \(The user agent will also run `mail-citation-hook', *after* the
5772 original text has been inserted in this way.)
5774 SEND-ACTIONS is a list of actions to call when the message is sent.
5775 Each action has the form (FUNCTION . ARGS)."
5776 (interactive
5777 (list nil nil nil current-prefix-arg))
5779 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5780 ;; from sendmail-user-agent to message-user-agent. Some users may
5781 ;; encounter incompatibilities. This hack tries to detect problems
5782 ;; and warn about them.
5783 (and compose-mail-user-agent-warnings
5784 (eq mail-user-agent 'message-user-agent)
5785 (let (warn-vars)
5786 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5787 mail-yank-hooks mail-archive-file-name
5788 mail-default-reply-to mail-mailing-lists
5789 mail-self-blind))
5790 (and (boundp var)
5791 (symbol-value var)
5792 (push var warn-vars)))
5793 (when warn-vars
5794 (display-warning 'mail
5795 (format "\
5796 The default mail mode is now Message mode.
5797 You have the following Mail mode variable%s customized:
5799 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5800 (if (> (length warn-vars) 1) "s" "")
5801 (mapconcat 'symbol-name
5802 warn-vars " "))))))
5804 (let ((function (get mail-user-agent 'composefunc)))
5805 (funcall function to subject other-headers continue
5806 switch-function yank-action send-actions)))
5808 (defun compose-mail-other-window (&optional to subject other-headers continue
5809 yank-action send-actions)
5811 (interactive
5812 (list nil nil nil current-prefix-arg))
5813 (compose-mail to subject other-headers continue
5814 'switch-to-buffer-other-window yank-action send-actions))
5817 (defun compose-mail-other-frame (&optional to subject other-headers continue
5818 yank-action send-actions)
5820 (interactive
5821 (list nil nil nil current-prefix-arg))
5822 (compose-mail to subject other-headers continue
5823 'switch-to-buffer-other-frame yank-action send-actions))
5824 \f
5825 (defvar set-variable-value-history nil
5826 "History of values entered with `set-variable'.
5828 Maximum length of the history list is determined by the value
5829 of `history-length', which see.")
5831 (defun set-variable (variable value &optional make-local)
5832 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5833 VARIABLE should be a user option variable name, a Lisp variable
5834 meant to be customized by users. You should enter VALUE in Lisp syntax,
5835 so if you want VALUE to be a string, you must surround it with doublequotes.
5836 VALUE is used literally, not evaluated.
5838 If VARIABLE has a `variable-interactive' property, that is used as if
5839 it were the arg to `interactive' (which see) to interactively read VALUE.
5841 If VARIABLE has been defined with `defcustom', then the type information
5842 in the definition is used to check that VALUE is valid.
5844 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5845 (interactive
5846 (let* ((default-var (variable-at-point))
5847 (var (if (user-variable-p default-var)
5848 (read-variable (format "Set variable (default %s): " default-var)
5849 default-var)
5850 (read-variable "Set variable: ")))
5851 (minibuffer-help-form '(describe-variable var))
5852 (prop (get var 'variable-interactive))
5853 (obsolete (car (get var 'byte-obsolete-variable)))
5854 (prompt (format "Set %s %s to value: " var
5855 (cond ((local-variable-p var)
5856 "(buffer-local)")
5857 ((or current-prefix-arg
5858 (local-variable-if-set-p var))
5859 "buffer-locally")
5860 (t "globally"))))
5861 (val (progn
5862 (when obsolete
5863 (message (concat "`%S' is obsolete; "
5864 (if (symbolp obsolete) "use `%S' instead" "%s"))
5865 var obsolete)
5866 (sit-for 3))
5867 (if prop
5868 ;; Use VAR's `variable-interactive' property
5869 ;; as an interactive spec for prompting.
5870 (call-interactively `(lambda (arg)
5871 (interactive ,prop)
5872 arg))
5873 (read
5874 (read-string prompt nil
5875 'set-variable-value-history
5876 (format "%S" (symbol-value var))))))))
5877 (list var val current-prefix-arg)))
5879 (and (custom-variable-p variable)
5880 (not (get variable 'custom-type))
5881 (custom-load-symbol variable))
5882 (let ((type (get variable 'custom-type)))
5883 (when type
5884 ;; Match with custom type.
5885 (require 'cus-edit)
5886 (setq type (widget-convert type))
5887 (unless (widget-apply type :match value)
5888 (error "Value `%S' does not match type %S of %S"
5889 value (car type) variable))))
5891 (if make-local
5892 (make-local-variable variable))
5894 (set variable value)
5896 ;; Force a thorough redisplay for the case that the variable
5897 ;; has an effect on the display, like `tab-width' has.
5898 (force-mode-line-update))
5899 \f
5900 ;; Define the major mode for lists of completions.
5902 (defvar completion-list-mode-map
5903 (let ((map (make-sparse-keymap)))
5904 (define-key map [mouse-2] 'mouse-choose-completion)
5905 (define-key map [follow-link] 'mouse-face)
5906 (define-key map [down-mouse-2] nil)
5907 (define-key map "\C-m" 'choose-completion)
5908 (define-key map "\e\e\e" 'delete-completion-window)
5909 (define-key map [left] 'previous-completion)
5910 (define-key map [right] 'next-completion)
5911 (define-key map "q" 'quit-window)
5912 map)
5913 "Local map for completion list buffers.")
5915 ;; Completion mode is suitable only for specially formatted data.
5916 (put 'completion-list-mode 'mode-class 'special)
5918 (defvar completion-reference-buffer nil
5919 "Record the buffer that was current when the completion list was requested.
5920 This is a local variable in the completion list buffer.
5921 Initial value is nil to avoid some compiler warnings.")
5923 (defvar completion-no-auto-exit nil
5924 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5925 This also applies to other functions such as `choose-completion'.")
5927 (defvar completion-base-position nil
5928 "Position of the base of the text corresponding to the shown completions.
5929 This variable is used in the *Completions* buffers.
5930 Its value is a list of the form (START END) where START is the place
5931 where the completion should be inserted and END (if non-nil) is the end
5932 of the text to replace. If END is nil, point is used instead.")
5934 (defvar completion-base-size nil
5935 "Number of chars before point not involved in completion.
5936 This is a local variable in the completion list buffer.
5937 It refers to the chars in the minibuffer if completing in the
5938 minibuffer, or in `completion-reference-buffer' otherwise.
5939 Only characters in the field at point are included.
5941 If nil, Emacs determines which part of the tail end of the
5942 buffer's text is involved in completion by comparing the text
5943 directly.")
5944 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
5946 (defun delete-completion-window ()
5947 "Delete the completion list window.
5948 Go to the window from which completion was requested."
5949 (interactive)
5950 (let ((buf completion-reference-buffer))
5951 (if (one-window-p t)
5952 (if (window-dedicated-p (selected-window))
5953 (delete-frame (selected-frame)))
5954 (delete-window (selected-window))
5955 (if (get-buffer-window buf)
5956 (select-window (get-buffer-window buf))))))
5958 (defun previous-completion (n)
5959 "Move to the previous item in the completion list."
5960 (interactive "p")
5961 (next-completion (- n)))
5963 (defun next-completion (n)
5964 "Move to the next item in the completion list.
5965 With prefix argument N, move N items (negative N means move backward)."
5966 (interactive "p")
5967 (let ((beg (point-min)) (end (point-max)))
5968 (while (and (> n 0) (not (eobp)))
5969 ;; If in a completion, move to the end of it.
5970 (when (get-text-property (point) 'mouse-face)
5971 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5972 ;; Move to start of next one.
5973 (unless (get-text-property (point) 'mouse-face)
5974 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5975 (setq n (1- n)))
5976 (while (and (< n 0) (not (bobp)))
5977 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
5978 ;; If in a completion, move to the start of it.
5979 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
5980 (goto-char (previous-single-property-change
5981 (point) 'mouse-face nil beg)))
5982 ;; Move to end of the previous completion.
5983 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
5984 (goto-char (previous-single-property-change
5985 (point) 'mouse-face nil beg)))
5986 ;; Move to the start of that one.
5987 (goto-char (previous-single-property-change
5988 (point) 'mouse-face nil beg))
5989 (setq n (1+ n))))))
5991 (defun choose-completion (&optional event)
5992 "Choose the completion at point."
5993 (interactive (list last-nonmenu-event))
5994 ;; In case this is run via the mouse, give temporary modes such as
5995 ;; isearch a chance to turn off.
5996 (run-hooks 'mouse-leave-buffer-hook)
5997 (let (buffer base-size base-position choice)
5998 (with-current-buffer (window-buffer (posn-window (event-start event)))
5999 (setq buffer completion-reference-buffer)
6000 (setq base-size completion-base-size)
6001 (setq base-position completion-base-position)
6002 (save-excursion
6003 (goto-char (posn-point (event-start event)))
6004 (let (beg end)
6005 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
6006 (setq end (point) beg (1+ (point))))
6007 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
6008 (setq end (1- (point)) beg (point)))
6009 (if (null beg)
6010 (error "No completion here"))
6011 (setq beg (previous-single-property-change beg 'mouse-face))
6012 (setq end (or (next-single-property-change end 'mouse-face)
6013 (point-max)))
6014 (setq choice (buffer-substring-no-properties beg end)))))
6016 (let ((owindow (selected-window)))
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 (and (buffer-live-p buffer)
6026 (get-buffer-window buffer 0))
6027 owindow)))
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 (with-current-buffer buffer (field-beginning)))))
6036 ;; If all else fails, just guess.
6037 (with-current-buffer buffer
6038 (list (choose-completion-guess-base-position choice)))))))
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 buffer base-position)
6085 "Switch to BUFFER and insert the completion choice CHOICE.
6086 BASE-POSITION, says where to insert the completion."
6088 ;; If BUFFER is the minibuffer, exit the minibuffer
6089 ;; unless it is reading a file name and CHOICE is a directory,
6090 ;; or completion-no-auto-exit is non-nil.
6092 ;; Some older code may call us passing `base-size' instead of
6093 ;; `base-position'. It's difficult to make any use of `base-size',
6094 ;; so we just ignore it.
6095 (unless (consp base-position)
6096 (message "Obsolete `base-size' passed to choose-completion-string")
6097 (setq base-position nil))
6099 (let* ((buffer (or buffer completion-reference-buffer))
6100 (mini-p (minibufferp buffer)))
6101 ;; If BUFFER is a minibuffer, barf unless it's the currently
6102 ;; active minibuffer.
6103 (if (and mini-p
6104 (or (not (active-minibuffer-window))
6105 (not (equal buffer
6106 (window-buffer (active-minibuffer-window))))))
6107 (error "Minibuffer is not active for completion")
6108 ;; Set buffer so buffer-local choose-completion-string-functions works.
6109 (set-buffer buffer)
6110 (unless (run-hook-with-args-until-success
6111 'choose-completion-string-functions
6112 ;; The fourth arg used to be `mini-p' but was useless
6113 ;; (since minibufferp can be used on the `buffer' arg)
6114 ;; and indeed unused. The last used to be `base-size', so we
6115 ;; keep it to try and avoid breaking old code.
6116 choice buffer base-position nil)
6117 ;; Insert the completion into the buffer where it was requested.
6118 (delete-region (or (car base-position) (point))
6119 (or (cadr base-position) (point)))
6120 (insert choice)
6121 (remove-text-properties (- (point) (length choice)) (point)
6122 '(mouse-face nil))
6123 ;; Update point in the window that BUFFER is showing in.
6124 (let ((window (get-buffer-window buffer t)))
6125 (set-window-point window (point)))
6126 ;; If completing for the minibuffer, exit it with this choice.
6127 (and (not completion-no-auto-exit)
6128 (minibufferp buffer)
6129 minibuffer-completion-table
6130 ;; If this is reading a file name, and the file name chosen
6131 ;; is a directory, don't exit the minibuffer.
6132 (let* ((result (buffer-substring (field-beginning) (point)))
6133 (bounds
6134 (completion-boundaries result minibuffer-completion-table
6135 minibuffer-completion-predicate
6136 "")))
6137 (if (eq (car bounds) (length result))
6138 ;; The completion chosen leads to a new set of completions
6139 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6140 (let ((mini (active-minibuffer-window)))
6141 (select-window mini)
6142 (when minibuffer-auto-raise
6143 (raise-frame (window-frame mini))))
6144 (exit-minibuffer))))))))
6146 (define-derived-mode completion-list-mode nil "Completion List"
6147 "Major mode for buffers showing lists of possible completions.
6149 to select the completion near point.
6151 with the mouse.
6154 (set (make-local-variable 'completion-base-size) nil))
6156 (defun completion-list-mode-finish ()
6157 "Finish setup of the completions buffer.
6158 Called from `temp-buffer-show-hook'."
6159 (when (eq major-mode 'completion-list-mode)
6160 (toggle-read-only 1)))
6162 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6165 ;; Variables and faces used in `completion-setup-function'.
6167 (defcustom completion-show-help t
6168 "Non-nil means show help message in *Completions* buffer."
6169 :type 'boolean
6170 :version "22.1"
6171 :group 'completion)
6173 ;; This function goes in completion-setup-hook, so that it is called
6174 ;; after the text of the completion list buffer is written.
6175 (defun completion-setup-function ()
6176 (let* ((mainbuf (current-buffer))
6177 (base-dir
6178 ;; When reading a file name in the minibuffer,
6179 ;; try and find the right default-directory to set in the
6180 ;; completion list buffer.
6181 ;; FIXME: Why do we do that, actually? --Stef
6182 (if minibuffer-completing-file-name
6183 (file-name-as-directory
6184 (expand-file-name
6185 (substring (minibuffer-completion-contents)
6186 0 (or completion-base-size 0)))))))
6187 (with-current-buffer standard-output
6188 (let ((base-size completion-base-size) ;Read before killing localvars.
6189 (base-position completion-base-position))
6190 (completion-list-mode)
6191 (set (make-local-variable 'completion-base-size) base-size)
6192 (set (make-local-variable 'completion-base-position) base-position))
6193 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6194 (if base-dir (setq default-directory base-dir))
6195 ;; Maybe insert help string.
6196 (when completion-show-help
6197 (goto-char (point-min))
6198 (if (display-mouse-p)
6199 (insert (substitute-command-keys
6201 (insert (substitute-command-keys
6205 (add-hook 'completion-setup-hook 'completion-setup-function)
6207 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6208 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6210 (defun switch-to-completions ()
6211 "Select the completion list window."
6212 (interactive)
6213 (let ((window (or (get-buffer-window "*Completions*" 0)
6214 ;; Make sure we have a completions window.
6215 (progn (minibuffer-completion-help)
6216 (get-buffer-window "*Completions*" 0)))))
6217 (when window
6218 (select-window window)
6219 ;; In the new buffer, go to the first completion.
6220 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6221 (when (bobp)
6222 (next-completion 1)))))
6223 \f
6224 ;;; Support keyboard commands to turn on various modifiers.
6226 ;; These functions -- which are not commands -- each add one modifier
6227 ;; to the following event.
6229 (defun event-apply-alt-modifier (ignore-prompt)
6232 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6233 (defun event-apply-super-modifier (ignore-prompt)
6236 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6237 (defun event-apply-hyper-modifier (ignore-prompt)
6240 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6241 (defun event-apply-shift-modifier (ignore-prompt)
6244 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6245 (defun event-apply-control-modifier (ignore-prompt)
6248 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6249 (defun event-apply-meta-modifier (ignore-prompt)
6252 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6254 (defun event-apply-modifier (event symbol lshiftby prefix)
6255 "Apply a modifier flag to event EVENT.
6256 SYMBOL is the name of this modifier, as a symbol.
6257 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6258 PREFIX is the string that represents this modifier in an event type symbol."
6259 (if (numberp event)
6260 (cond ((eq symbol 'control)
6261 (if (and (<= (downcase event) ?z)
6262 (>= (downcase event) ?a))
6263 (- (downcase event) ?a -1)
6264 (if (and (<= (downcase event) ?Z)
6265 (>= (downcase event) ?A))
6266 (- (downcase event) ?A -1)
6267 (logior (lsh 1 lshiftby) event))))
6268 ((eq symbol 'shift)
6269 (if (and (<= (downcase event) ?z)
6270 (>= (downcase event) ?a))
6271 (upcase event)
6272 (logior (lsh 1 lshiftby) event)))
6273 (t
6274 (logior (lsh 1 lshiftby) event)))
6275 (if (memq symbol (event-modifiers event))
6276 event
6277 (let ((event-type (if (symbolp event) event (car event))))
6278 (setq event-type (intern (concat prefix (symbol-name event-type))))
6279 (if (symbolp event)
6280 event-type
6281 (cons event-type (cdr event)))))))
6283 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6284 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6285 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6286 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6287 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6288 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6289 \f
6290 ;;;; Keypad support.
6292 ;; Make the keypad keys act like ordinary typing keys. If people add
6293 ;; bindings for the function key symbols, then those bindings will
6294 ;; override these, so this shouldn't interfere with any existing
6295 ;; bindings.
6297 ;; Also tell read-char how to handle these keys.
6298 (mapc
6299 (lambda (keypad-normal)
6300 (let ((keypad (nth 0 keypad-normal))
6301 (normal (nth 1 keypad-normal)))
6302 (put keypad 'ascii-character normal)
6303 (define-key function-key-map (vector keypad) (vector normal))))
6304 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6305 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6306 (kp-space ?\s)
6309 (kp-multiply ?*)
6310 (kp-add ?+)
6311 (kp-separator ?,)
6312 (kp-subtract ?-)
6313 (kp-decimal ?.)
6314 (kp-divide ?/)
6315 (kp-equal ?=)
6316 ;; Do the same for various keys that are represented as symbols under
6317 ;; GUIs but naturally correspond to characters.
6318 (backspace 127)
6319 (delete 127)
6322 (clear ?\C-l)
6323 (return ?\C-m)
6324 (escape ?\e)
6325 ))
6326 \f
6327 ;;;;
6328 ;;;; forking a twin copy of a buffer.
6329 ;;;;
6331 (defvar clone-buffer-hook nil
6332 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6334 (defvar clone-indirect-buffer-hook nil
6335 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6337 (defun clone-process (process &optional newname)
6338 "Create a twin copy of PROCESS.
6339 If NEWNAME is nil, it defaults to PROCESS' name;
6340 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6341 If PROCESS is associated with a buffer, the new process will be associated
6342 with the current buffer instead.
6343 Returns nil if PROCESS has already terminated."
6344 (setq newname (or newname (process-name process)))
6346 (setq newname (substring newname 0 (match-beginning 0))))
6347 (when (memq (process-status process) '(run stop open))
6348 (let* ((process-connection-type (process-tty-name process))
6349 (new-process
6350 (if (memq (process-status process) '(open))
6351 (let ((args (process-contact process t)))
6352 (setq args (plist-put args :name newname))
6353 (setq args (plist-put args :buffer
6354 (if (process-buffer process)
6355 (current-buffer))))
6356 (apply 'make-network-process args))
6357 (apply 'start-process newname
6358 (if (process-buffer process) (current-buffer))
6359 (process-command process)))))
6360 (set-process-query-on-exit-flag
6361 new-process (process-query-on-exit-flag process))
6362 (set-process-inherit-coding-system-flag
6363 new-process (process-inherit-coding-system-flag process))
6364 (set-process-filter new-process (process-filter process))
6365 (set-process-sentinel new-process (process-sentinel process))
6366 (set-process-plist new-process (copy-sequence (process-plist process)))
6367 new-process)))
6369 ;; things to maybe add (currently partly covered by `funcall mode'):
6370 ;; - syntax-table
6371 ;; - overlays
6372 (defun clone-buffer (&optional newname display-flag)
6373 "Create and return a twin copy of the current buffer.
6374 Unlike an indirect buffer, the new buffer can be edited
6375 independently of the old one (if it is not read-only).
6376 NEWNAME is the name of the new buffer. It may be modified by
6377 adding or incrementing <N> at the end as necessary to create a
6378 unique buffer name. If nil, it defaults to the name of the
6379 current buffer, with the proper suffix. If DISPLAY-FLAG is
6380 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6381 clone a file-visiting buffer, or a buffer whose major mode symbol
6382 has a non-nil `no-clone' property, results in an error.
6384 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6385 current buffer with appropriate suffix. However, if a prefix
6386 argument is given, then the command prompts for NEWNAME in the
6387 minibuffer.
6389 This runs the normal hook `clone-buffer-hook' in the new buffer
6390 after it has been set up properly in other respects."
6391 (interactive
6392 (progn
6393 (if buffer-file-name
6394 (error "Cannot clone a file-visiting buffer"))
6395 (if (get major-mode 'no-clone)
6396 (error "Cannot clone a buffer in %s mode" mode-name))
6397 (list (if current-prefix-arg
6398 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6399 t)))
6400 (if buffer-file-name
6401 (error "Cannot clone a file-visiting buffer"))
6402 (if (get major-mode 'no-clone)
6403 (error "Cannot clone a buffer in %s mode" mode-name))
6404 (setq newname (or newname (buffer-name)))
6406 (setq newname (substring newname 0 (match-beginning 0))))
6407 (let ((buf (current-buffer))
6408 (ptmin (point-min))
6409 (ptmax (point-max))
6410 (pt (point))
6411 (mk (if mark-active (mark t)))
6412 (modified (buffer-modified-p))
6413 (mode major-mode)
6414 (lvars (buffer-local-variables))
6415 (process (get-buffer-process (current-buffer)))
6416 (new (generate-new-buffer (or newname (buffer-name)))))
6417 (save-restriction
6418 (widen)
6419 (with-current-buffer new
6420 (insert-buffer-substring buf)))
6421 (with-current-buffer new
6422 (narrow-to-region ptmin ptmax)
6423 (goto-char pt)
6424 (if mk (set-mark mk))
6425 (set-buffer-modified-p modified)
6427 ;; Clone the old buffer's process, if any.
6428 (when process (clone-process process))
6430 ;; Now set up the major mode.
6431 (funcall mode)
6433 ;; Set up other local variables.
6434 (mapc (lambda (v)
6435 (condition-case () ;in case var is read-only
6436 (if (symbolp v)
6437 (makunbound v)
6438 (set (make-local-variable (car v)) (cdr v)))
6439 (error nil)))
6440 lvars)
6442 ;; Run any hooks (typically set up by the major mode
6443 ;; for cloning to work properly).
6444 (run-hooks 'clone-buffer-hook))
6445 (if display-flag
6446 ;; Presumably the current buffer is shown in the selected frame, so
6447 ;; we want to display the clone elsewhere.
6448 (let ((same-window-regexps nil)
6449 (same-window-buffer-names))
6450 (pop-to-buffer new)))
6451 new))
6454 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6455 "Create an indirect buffer that is a twin copy of the current buffer.
6457 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6458 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6459 or if not called with a prefix arg, NEWNAME defaults to the current
6460 buffer's name. The name is modified by adding a `<N>' suffix to it
6461 or by incrementing the N in an existing suffix. Trying to clone a
6462 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6463 property results in an error.
6465 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6466 This is always done when called interactively.
6468 Optional third arg NORECORD non-nil means do not put this buffer at the
6469 front of the list of recently selected ones."
6470 (interactive
6471 (progn
6472 (if (get major-mode 'no-clone-indirect)
6473 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6474 (list (if current-prefix-arg
6475 (read-buffer "Name of indirect buffer: " (current-buffer)))
6476 t)))
6477 (if (get major-mode 'no-clone-indirect)
6478 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6479 (setq newname (or newname (buffer-name)))
6481 (setq newname (substring newname 0 (match-beginning 0))))
6482 (let* ((name (generate-new-buffer-name newname))
6483 (buffer (make-indirect-buffer (current-buffer) name t)))
6484 (with-current-buffer buffer
6485 (run-hooks 'clone-indirect-buffer-hook))
6486 (when display-flag
6487 (pop-to-buffer buffer norecord))
6488 buffer))
6491 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6492 "Like `clone-indirect-buffer' but display in another window."
6493 (interactive
6494 (progn
6495 (if (get major-mode 'no-clone-indirect)
6496 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6497 (list (if current-prefix-arg
6498 (read-buffer "Name of indirect buffer: " (current-buffer)))
6499 t)))
6500 (let ((pop-up-windows t))
6501 (clone-indirect-buffer newname display-flag norecord)))
6503 \f
6504 ;;; Handling of Backspace and Delete keys.
6506 (defcustom normal-erase-is-backspace 'maybe
6507 "Set the default behavior of the Delete and Backspace keys.
6509 If set to t, Delete key deletes forward and Backspace key deletes
6510 backward.
6512 If set to nil, both Delete and Backspace keys delete backward.
6514 If set to 'maybe (which is the default), Emacs automatically
6515 selects a behavior. On window systems, the behavior depends on
6516 the keyboard used. If the keyboard has both a Backspace key and
6517 a Delete key, and both are mapped to their usual meanings, the
6518 option's default value is set to t, so that Backspace can be used
6519 to delete backward, and Delete can be used to delete forward.
6521 If not running under a window system, customizing this option
6522 accomplishes a similar effect by mapping C-h, which is usually
6523 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6524 via `keyboard-translate'. The former functionality of C-h is
6525 available on the F1 key. You should probably not use this
6526 setting if you don't have both Backspace, Delete and F1 keys.
6528 Setting this variable with setq doesn't take effect. Programmatically,
6529 call `normal-erase-is-backspace-mode' (which see) instead."
6530 :type '(choice (const :tag "Off" nil)
6531 (const :tag "Maybe" maybe)
6532 (other :tag "On" t))
6533 :group 'editing-basics
6534 :version "21.1"
6535 :set (lambda (symbol value)
6536 ;; The fboundp is because of a problem with :set when
6537 ;; dumping Emacs. It doesn't really matter.
6538 (if (fboundp 'normal-erase-is-backspace-mode)
6539 (normal-erase-is-backspace-mode (or value 0))
6540 (set-default symbol value))))
6542 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6543 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6544 (unless frame (setq frame (selected-frame)))
6545 (with-selected-frame frame
6546 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6547 (normal-erase-is-backspace-mode
6548 (if (if (eq normal-erase-is-backspace 'maybe)
6549 (and (not noninteractive)
6550 (or (memq system-type '(ms-dos windows-nt))
6551 (memq window-system '(ns))
6552 (and (memq window-system '(x))
6553 (fboundp 'x-backspace-delete-keys-p)
6554 (x-backspace-delete-keys-p))
6555 ;; If the terminal Emacs is running on has erase char
6556 ;; set to ^H, use the Backspace key for deleting
6557 ;; backward, and the Delete key for deleting forward.
6558 (and (null window-system)
6559 (eq tty-erase-char ?\^H))))
6560 normal-erase-is-backspace)
6561 1 0)))))
6563 (define-minor-mode normal-erase-is-backspace-mode
6564 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6566 With numeric ARG, turn the mode on if and only if ARG is positive.
6568 On window systems, when this mode is on, Delete is mapped to C-d
6569 and Backspace is mapped to DEL; when this mode is off, both
6570 Delete and Backspace are mapped to DEL. (The remapping goes via
6571 `local-function-key-map', so binding Delete or Backspace in the
6572 global or local keymap will override that.)
6574 In addition, on window systems, the bindings of C-Delete, M-Delete,
6575 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6576 the global keymap in accordance with the functionality of Delete and
6577 Backspace. For example, if Delete is remapped to C-d, which deletes
6578 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6579 to DEL, which deletes backward, C-Delete is bound to
6580 `backward-kill-word'.
6582 If not running on a window system, a similar effect is accomplished by
6583 remapping C-h (normally produced by the Backspace key) and DEL via
6584 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6585 to C-d; if it's off, the keys are not remapped.
6587 When not running on a window system, and this mode is turned on, the
6588 former functionality of C-h is available on the F1 key. You should
6589 probably not turn on this mode on a text-only terminal if you don't
6590 have both Backspace, Delete and F1 keys.
6592 See also `normal-erase-is-backspace'."
6593 :variable (eq (terminal-parameter
6594 nil 'normal-erase-is-backspace) 1)
6595 (let ((enabled (eq 1 (terminal-parameter
6596 nil 'normal-erase-is-backspace))))
6598 (cond ((or (memq window-system '(x w32 ns pc))
6599 (memq system-type '(ms-dos windows-nt)))
6600 (let* ((bindings
6601 `(([M-delete] [M-backspace])
6602 ([C-M-delete] [C-M-backspace])
6603 ([?\e C-delete] [?\e C-backspace])))
6604 (old-state (lookup-key local-function-key-map [delete])))
6606 (if enabled
6607 (progn
6608 (define-key local-function-key-map [delete] [deletechar])
6609 (define-key local-function-key-map [kp-delete] [?\C-d])
6610 (define-key local-function-key-map [backspace] [?\C-?])
6611 (dolist (b bindings)
6612 ;; Not sure if input-decode-map is really right, but
6613 ;; keyboard-translate-table (used below) only works
6614 ;; for integer events, and key-translation-table is
6615 ;; global (like the global-map, used earlier).
6616 (define-key input-decode-map (car b) nil)
6617 (define-key input-decode-map (cadr b) nil)))
6618 (define-key local-function-key-map [delete] [?\C-?])
6619 (define-key local-function-key-map [kp-delete] [?\C-?])
6620 (define-key local-function-key-map [backspace] [?\C-?])
6621 (dolist (b bindings)
6622 (define-key input-decode-map (car b) (cadr b))
6623 (define-key input-decode-map (cadr b) (car b))))))
6624 (t
6625 (if enabled
6626 (progn
6627 (keyboard-translate ?\C-h ?\C-?)
6628 (keyboard-translate ?\C-? ?\C-d))
6629 (keyboard-translate ?\C-h ?\C-h)
6630 (keyboard-translate ?\C-? ?\C-?))))
6632 (if (called-interactively-p 'interactive)
6633 (message "Delete key deletes %s"
6634 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6635 "forward" "backward")))))
6636 \f
6637 (defvar vis-mode-saved-buffer-invisibility-spec nil
6638 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6640 (define-minor-mode visible-mode
6641 "Toggle Visible mode.
6642 With argument ARG turn Visible mode on if ARG is positive, otherwise
6643 turn it off.
6645 Enabling Visible mode makes all invisible text temporarily visible.
6646 Disabling Visible mode turns off that effect. Visible mode works by
6647 saving the value of `buffer-invisibility-spec' and setting it to nil."
6648 :lighter " Vis"
6649 :group 'editing-basics
6650 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6651 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6652 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6653 (when visible-mode
6654 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6655 buffer-invisibility-spec)
6656 (setq buffer-invisibility-spec nil)))
6657 \f
6658 ;; Partial application of functions (similar to "currying").
6659 ;; This function is here rather than in subr.el because it uses CL.
6660 (defun apply-partially (fun &rest args)
6661 "Return a function that is a partial application of FUN to ARGS.
6662 ARGS is a list of the first N arguments to pass to FUN.
6663 The result is a new function which does the same as FUN, except that
6664 the first N arguments are fixed at the values with which this function
6665 was called."
6666 (lexical-let ((fun fun) (args1 args))
6667 (lambda (&rest args2) (apply fun (append args1 args2)))))
6668 \f
6669 ;; Minibuffer prompt stuff.
6671 ;(defun minibuffer-prompt-modification (start end)
6672 ; (error "You cannot modify the prompt"))
6673 ;
6674 ;
6675 ;(defun minibuffer-prompt-insertion (start end)
6676 ; (let ((inhibit-modification-hooks t))
6677 ; (delete-region start end)
6678 ; ;; Discard undo information for the text insertion itself
6679 ; ;; and for the text deletion.above.
6680 ; (when (consp buffer-undo-list)
6681 ; (setq buffer-undo-list (cddr buffer-undo-list)))
6682 ; (message "You cannot modify the prompt")))
6683 ;
6684 ;
6685 ;(setq minibuffer-prompt-properties
6686 ; (list 'modification-hooks '(minibuffer-prompt-modification)
6687 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6688 ;
6690 \f
6691 ;;;; Problematic external packages.
6693 ;; rms says this should be done by specifying symbols that define
6694 ;; versions together with bad values. This is therefore not as
6695 ;; flexible as it could be. See the thread:
6696 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6697 (defconst bad-packages-alist
6698 ;; Not sure exactly which semantic versions have problems.
6699 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6701 "The version of `semantic' loaded does not work in Emacs 22.
6702 It can cause constant high CPU load.
6703 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6704 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6705 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6706 ;; provided the `CUA-mode' feature. Since this is no longer true,
6707 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6708 (CUA-mode t nil
6709 "CUA-mode is now part of the standard GNU Emacs distribution,
6710 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6712 You have loaded an older version of CUA-mode which does not work
6713 correctly with this version of Emacs. You should remove the old
6714 version and use the one distributed with Emacs."))
6715 "Alist of packages known to cause problems in this version of Emacs.
6716 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6717 PACKAGE is either a regular expression to match file names, or a
6718 symbol (a feature name); see the documentation of
6719 `after-load-alist', to which this variable adds functions.
6720 SYMBOL is either the name of a string variable, or `t'. Upon
6721 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6722 warning using STRING as the message.")
6724 (defun bad-package-check (package)
6725 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6726 (condition-case nil
6727 (let* ((list (assoc package bad-packages-alist))
6728 (symbol (nth 1 list)))
6729 (and list
6730 (boundp symbol)
6731 (or (eq symbol t)
6732 (and (stringp (setq symbol (eval symbol)))
6733 (string-match-p (nth 2 list) symbol)))
6734 (display-warning package (nth 3 list) :warning)))
6735 (error nil)))
6737 (mapc (lambda (elem)
6738 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6739 bad-packages-alist)
6742 (provide 'simple)
6744 ;;; simple.el ends here