| blob | 36931c7777ca75e9e53ec44a865e75c142dc506a |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 ;; 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 number of lines and characters in the region."
983 "Print the current buffer line number and narrowed line number of point."
996 "Return number of lines between START and END.
997 This is usually the number of newlines between them,
998 but can be one more if START is not equal to END
999 and the greater of them is not at the start of a line."
1015 done)))
1019 "Return (narrowed) buffer line number at position POS.
1020 If POS is nil, use current buffer location.
1021 Counting starts at (point-min), so the value refers
1022 to the contents of the accessible portion of the buffer."
1032 "Print info on cursor position (on screen and within buffer).
1033 Also describe the character after point, and give its character code
1034 in octal, decimal and hex.
1036 For a non-ASCII multibyte character, also give its encoding in the
1037 buffer's selected coding system if the coding system encodes the
1038 character safely. If the character is encoded into one byte, that
1039 code is shown in hex. If the character is encoded into more than one
1042 In addition, with prefix argument, show details about that character
1043 in *Help* buffer. See also the command `describe-char'."
1051 ;; Avoid overflow from multiplying by 100!
1055 ""
1061 pos total percent beg end col hscroll)
1063 pos total col hscroll))
1065 encoded encoding-msg display-prop under-display)
1072 ;; Check if the character is displayed with some `display'
1073 ;; text property. In that case, set under-display to the
1074 ;; buffer substring covered by that property.
1085 under-display)))
1091 char char char under-display)
1093 char char char under-display display-prop))
1096 char char char
1098 "..."
1102 ;; We show the detailed information about CHAR.
1109 encoding-msg pos total percent beg end col hscroll)
1116 encoding-msg pos total percent col hscroll))))))
1117 \f
1118 ;; Initialize read-expression-map. It is defined at C level.
1130 "The current default value or list of default values in the minibuffer.
1131 The functions `read-from-minibuffer' and `completing-read' bind
1135 "Value for `print-level' while printing value in `eval-expression'.
1136 A value of nil means no limit."
1142 "Value for `print-length' while printing value in `eval-expression'.
1143 A value of nil means no limit."
1149 "If non-nil set `debug-on-error' to t in `eval-expression'.
1150 If nil, don't change the value of `debug-on-error'."
1156 "Format VALUE as a result of evaluated expression.
1157 Return a formatted string which is displayed in the echo area
1158 in addition to the value printed by prin1 in functions which
1159 display the result of expression evaluation."
1172 ;; We define this, rather than making `eval' interactive,
1173 ;; for the sake of completion of names like eval-region, eval-buffer.
1176 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1177 Value is also consed on to front of the variable `values'.
1178 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1179 with prefix argument) means insert the result into the current buffer
1180 instead of printing it in the echo area. Truncates long output
1181 according to the value of the variables `eval-expression-print-length'
1182 and `eval-expression-print-level'.
1184 If `eval-expression-debug-on-error' is non-nil, which is the default,
1185 this command arranges for all errors to enter the debugger."
1189 nil read-expression-map t
1191 current-prefix-arg))
1196 ;; Bind debug-on-error to something unique so that we can
1197 ;; detect when evaled code changes it.
1201 ;; If evaled code has changed the value of debug-on-error,
1202 ;; propagate that change to the global binding.
1218 "Prompting with PROMPT, let user edit COMMAND and eval result.
1219 COMMAND is a Lisp expression. Let user edit that expression in
1220 the minibuffer, then read and evaluate the result."
1227 read-expression-map t
1229 ;; If command was added to command-history as a string,
1230 ;; get rid of that. We want only evaluable expressions there.
1234 ;; If command to be redone does not match front of history,
1235 ;; add it to the history.
1241 "Edit and re-evaluate last complex command, or ARGth from last.
1242 A complex command is one which used the minibuffer.
1243 The command is placed in the minibuffer as a Lisp form for editing.
1244 The result is executed, repeating the command as changed.
1245 If the command has been changed or is not the most recent previous
1246 command it is added to the front of the command history.
1247 You can use the minibuffer history commands \
1249 to get different commands to edit and resubmit."
1252 newcmd)
1264 ;; If command was added to command-history as a
1265 ;; string, get rid of that. We want only
1266 ;; evaluable expressions there.
1270 ;; If command to be redone does not match front of history,
1271 ;; add it to the history.
1280 "Read command name to invoke in `execute-extended-command'."
1285 ;; Get a command name at point in the original buffer
1286 ;; to propose it after M-n.
1290 ;; Read a string, completing from and restricting to the set of
1291 ;; all defined commands. Don't provide any initial input.
1292 ;; Save the command read on the extended-command history list.
1303 ;; This isn't strictly correct if `execute-extended-command'
1304 ;; is bound to anything else (e.g. [menu]).
1305 ;; It could use (key-description (this-single-command-keys)),
1306 ;; but actually a prompt other than "M-x" would be confusing,
1307 ;; because "M-x" is a well-known prompt to read a command
1308 ;; and it serves as a shorthand for "Extended command: ".
1312 \f
1314 "Default minibuffer history list.
1315 This is used for all minibuffer input
1316 except when an alternate history list is specified.
1318 Maximum length of the history list is determined by the value
1321 "Control whether history list elements are expressions or strings.
1322 If the value of this variable equals current minibuffer depth,
1323 they are expressions; otherwise they are strings.
1324 \(That convention is designed to do the right thing for
1331 "Text that was in this minibuffer before any history commands.
1332 This is nil if there have not yet been any history commands
1341 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1345 "Minibuffer history variables for which matching should ignore case.
1346 If a history variable is a member of this list, then the
1348 commands ignore case when searching it, regardless of `case-fold-search'."
1353 "Find the previous history element that matches REGEXP.
1354 \(Previous history elements refer to earlier actions.)
1355 With prefix argument N, search for Nth previous match.
1356 If N is negative, find the next or Nth next match.
1357 Normally, history elements are matched case-insensitively if
1358 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1359 makes the search case-sensitive.
1360 See also `minibuffer-history-case-insensitive-variables'."
1364 nil
1365 minibuffer-local-map
1366 nil
1367 'minibuffer-history-search-history
1369 ;; Use the last regexp specified, by default, if input is empty.
1374 regexp)
1384 ;; On some systems, ignore case for file names.
1386 minibuffer-history-case-insensitive-variables)
1387 t
1388 ;; Respect the user's setting for case-fold-search:
1389 case-fold-search)
1390 nil))
1391 prevpos
1392 match-string
1393 match-offset
1400 "No later matching history item"
1421 next-matching-history-element))
1425 "Find the next history element that matches REGEXP.
1426 \(The next history element refers to a more recent action.)
1427 With prefix argument N, search for Nth next match.
1428 If N is negative, find the previous or Nth previous match.
1429 Normally, history elements are matched case-insensitively if
1430 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1431 makes the search case-sensitive."
1435 nil
1436 minibuffer-local-map
1437 nil
1438 'minibuffer-history-search-history
1440 ;; Use the last regexp specified, by default, if input is empty.
1445 regexp)
1452 "Function run by `goto-history-element' before consuming default values.
1453 This is useful to dynamically add more elements to the list of default values
1454 when `goto-history-element' reaches the end of this list.
1455 Before calling this function `goto-history-element' sets the variable
1456 `minibuffer-default-add-done' to t, so it will call this function only
1457 once. In special cases, when this function needs to be called more
1458 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1462 "When nil, add more elements to the end of the list of default values.
1463 The value nil causes `goto-history-element' to add more elements to
1464 the list of defaults when it reaches the end of this list. It does
1470 "Return a list of all completions without the default value.
1471 This function is used to add all elements of the completion table to
1472 the end of the list of defaults just after the default value."
1475 minibuffer-completion-table
1476 minibuffer-completion-predicate)))
1482 "Puts element of the minibuffer history in the minibuffer.
1483 The argument NABS specifies the absolute history position."
1497 elt minibuffer-returned-to-present)
1509 previous-history-element))
1521 minibuffer-default)))
1533 elt))
1537 "Puts next element of the minibuffer history in the minibuffer.
1538 With argument N, it uses the Nth following element."
1544 "Puts previous element of the minibuffer history in the minibuffer.
1545 With argument N, it uses the Nth previous element."
1551 "Get next history element which completes the minibuffer before the point.
1552 The contents of the minibuffer after the point are deleted, and replaced
1553 by the new completion."
1559 n)
1560 ;; next-matching-history-element always puts us at (point-min).
1561 ;; Move to the position we were at before changing the buffer contents.
1562 ;; This is still sensical, because the text before point has not changed.
1566 "\
1567 Get previous history element which completes the minibuffer before the point.
1568 The contents of the minibuffer after the point are deleted, and replaced
1569 by the new completion."
1573 ;; For compatibility with the old subr of the same name.
1575 "Return the display width of the minibuffer prompt.
1576 Return 0 if current buffer is not a minibuffer."
1577 ;; Return the width of everything before the field at the end of
1578 ;; the buffer; this should be 0 for normal buffers.
1580 \f
1581 ;; isearch minibuffer history
1588 "Set up a minibuffer for using isearch to search the minibuffer history.
1589 Intended to be added to `minibuffer-setup-hook'."
1601 "Clean up the minibuffer after terminating isearch in the minibuffer."
1606 "Return the proper search function, for isearch in minibuffer history."
1613 ;; Use standard functions to search within minibuffer text
1619 found)
1620 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1621 ;; searching forward. Lazy-highlight calls this lambda with the
1622 ;; bound arg, so skip the minibuffer prompt.
1626 ;; 1. First try searching in the initial minibuffer text
1629 noerror)
1630 ;; 2. If the above search fails, start putting next/prev history
1631 ;; elements in the minibuffer successively, and search the string
1632 ;; in them. Do this only when bound is nil (i.e. not while
1633 ;; lazy-highlighting search strings in the current minibuffer text).
1645 ;; After putting the next/prev history element, search
1646 ;; the string in them again, until next-history-element
1647 ;; or previous-history-element raises an error at the
1648 ;; beginning/end of history.
1651 ;; For backward search, don't search
1652 ;; in the minibuffer prompt
1654 noerror)))
1655 ;; Return point of the new search result
1657 ;; Return nil when next(prev)-history-element fails
1661 "Display the minibuffer history search prompt.
1662 If there are no search errors, this function displays an overlay with
1663 the isearch prompt which replaces the original minibuffer prompt.
1664 Otherwise, it displays the standard isearch message returned from
1665 `isearch-message'."
1667 ;; Use standard function `isearch-message' when not in the minibuffer,
1668 ;; or search fails, or has an error (like incomplete regexp).
1669 ;; This function overwrites minibuffer text with isearch message,
1670 ;; so it's possible to see what is wrong in the search string.
1672 ;; Otherwise, put the overlay with the standard isearch prompt over
1673 ;; the initial minibuffer prompt.
1682 ;; And clear any previous isearch message.
1686 "Wrap the minibuffer history search when search fails.
1687 Move point to the first history element for a forward search,
1688 or to the last history element for a backward search."
1690 ;; When `minibuffer-history-isearch-search' fails on reaching the
1691 ;; beginning/end of the history, wrap the search to the first/last
1692 ;; minibuffer history element.
1700 "Save a function restoring the state of minibuffer history search.
1701 Save `minibuffer-history-position' to the additional state parameter
1702 in the search status stack."
1707 "Restore the minibuffer history search state.
1708 Go to the history element by the absolute history position HIST-POS."
1711 \f
1712 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1716 "Table mapping redo records to the corresponding undo one.
1717 A redo record for undo-in-region maps to t.
1727 "Within a run of consecutive undo commands, list remaining to be undone.
1731 "Undo some previous changes.
1732 Repeat this command to undo more changes.
1733 A numeric ARG serves as a repeat count.
1735 In Transient Mark mode when the mark is active, only undo changes within
1737 as an argument limits undo to changes within the current region."
1739 ;; Make last-command indicate for the next command that this was an undo.
1740 ;; That way, another undo will undo more.
1741 ;; If we get to the end of the undo history and get an error,
1742 ;; another undo command will find the undo history empty
1743 ;; and will get another error. To begin undoing the undos,
1744 ;; you must type some other command.
1747 message)
1748 ;; If we get an error in undo-start,
1749 ;; the next command should not be a "consecutive undo".
1750 ;; So set `this-command' to something other than `undo'.
1755 ;; If something (a timer or filter?) changed the buffer
1756 ;; since the previous command, don't continue the undo seq.
1760 ;; If the last undo record made was made by undo
1761 ;; it shows nothing else happened in between.
1768 ;; get rid of initial undo boundary
1770 ;; If we got this far, the next command should be a consecutive undo.
1772 ;; Check to see whether we're hitting a redo record, and if
1773 ;; so, ask the user whether she wants to skip the redo/undo pair.
1780 ;; The equiv entry might point to another redo record if we have done
1781 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1789 ;; Record the fact that the just-generated undo records come from an
1790 ;; undo operation--that is, they are redo records.
1791 ;; In the ordinary case (not within a region), map the redo
1792 ;; record to the following undos.
1793 ;; I don't know how to do that in the undo-in-region case.
1795 ;; Strip any leading undo boundaries there might be, like we do
1796 ;; above when checking.
1800 undo-equiv-table))
1801 ;; Don't specify a position in the undo record for the undo command.
1802 ;; Instead, undoing this should move point to where the change is.
1821 ;; Record what the current undo list says,
1822 ;; so the next command can tell if the buffer was modified in between.
1825 ;; Display a message announcing success.
1830 "Make BUFFER stop keeping undo information.
1831 No argument or nil as argument means do this for the current buffer."
1837 "Undo some previous changes.
1838 Repeat this command to undo more changes.
1839 A numeric ARG serves as a repeat count.
1840 Contrary to `undo', this will not redo a previous undo."
1845 "Non-nil while performing an undo.
1849 "Undo back N undo-boundaries beyond what was already undone recently.
1850 Call `undo-start' to get ready to undo recent changes,
1851 then call `undo-more' one or more times to undo them."
1856 ;; Note: The following, while pulling elements off
1857 ;; `pending-undo-list' will call primitive change functions which
1858 ;; will push more elements onto `buffer-undo-list'.
1863 ;; Deep copy of a list
1865 "Make a copy of undo list LIST."
1871 elt))
1874 "Set `pending-undo-list' to the front of the undo list.
1875 The next call to `undo-more' will undo the most recently made change.
1876 If BEG and END are specified, then only undo elements
1877 that apply to text between BEG and END are used; other undo elements
1878 are ignored. If BEG and END are nil, all undo elements are used."
1884 buffer-undo-list)))
1889 "Return a list of undo elements for the region START to END.
1890 The elements come from `buffer-undo-list', but we keep only
1891 the elements inside this region, and discard those outside this region.
1892 If we find an element that crosses an edge of this region,
1893 we stop and ignore all further elements."
1896 undo-adjusted-markers
1897 some-rejected
1898 undo-elt undo-elt temp-undo-list delta)
1903 ;; This is a "was unmodified" element.
1904 ;; Keep it if we have kept everything thus far.
1911 ;; Don't put two nils together in the list
1925 ;; Loop down the earlier events adjusting their buffer
1926 ;; positions to reflect the fact that a change to the buffer
1927 ;; isn't being undone. We only need to process those element
1928 ;; types which undo-elt-in-region will return as being in
1929 ;; the region since only those types can ever get into the
1930 ;; output
1939 ;; (TEXT . POSITION)
1946 ;; (BEGIN . END)
1951 ;; (nil PROPERTY VALUE BEG . END)
1961 "Determine whether UNDO-ELT falls inside the region START ... END.
1962 If it crosses the edge, we return nil."
1967 t)
1969 nil)
1971 ;; (TEXT . POSITION)
1975 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1976 ;; See if MARKER is inside the region.
1987 ;; (nil PROPERTY VALUE BEG . END)
1992 ;; (BEGIN . END)
1997 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1998 This assumes we have already decided that UNDO-ELT
1999 is not *inside* the region START...END."
2002 ;; (nil PROPERTY VALUE BEG . END)
2007 ;; (BEGIN . END)
2011 ;; Return the first affected buffer position and the delta for an undo element
2012 ;; delta is defined as the change in subsequent buffer positions if we *did*
2013 ;; the undo.
2017 ;; (TEXT . POSITION)
2020 ;; (BEGIN . END)
2027 "If non-nil ask about discarding undo info for the current command.
2028 Normally, Emacs discards the undo info for the current command if
2029 it exceeds `undo-outer-limit'. But if you set this option
2030 non-nil, it asks in the echo area whether to discard the info.
2031 If you answer no, there is a slight risk that Emacs might crash, so
2032 only do it if you really want to undo the command.
2034 This option is mainly intended for debugging. You have to be
2035 careful if you use it for other purposes. Garbage collection is
2036 inhibited while the question is asked, meaning that Emacs might
2037 leak memory. So you should make sure that you do not wait
2038 excessively long before answering the question."
2044 "If non-nil, an extra level of size that's ok in an undo item.
2045 We don't ask the user about truncating the undo list until the
2046 current item gets bigger than this amount.
2051 ;; When the first undo batch in an undo list is longer than
2052 ;; undo-outer-limit, this function gets called to warn the user that
2053 ;; the undo info for the current command was discarded. Garbage
2054 ;; collection is inhibited around the call, so it had better not do a
2055 ;; lot of consing.
2061 ;; Don't ask the question again unless it gets even bigger.
2062 ;; This applies, in particular, if the user quits from the question.
2063 ;; Such a quit quits out of GC, but something else will call GC
2064 ;; again momentarily. It will call this function again,
2065 ;; but we don't want to ask the question again.
2072 t)
2073 nil))
2078 "The undo info was discarded because it exceeded \
2079 `undo-outer-limit'.
2081 This is normal if you executed a command that made a huge change
2082 to the buffer. In that case, to prevent similar problems in the
2083 future, set `undo-outer-limit' to a value that is large enough to
2084 cover the maximum size of normal changes you expect a single
2085 command to make, but not so large that it might exceed the
2086 maximum memory allotted to Emacs.
2088 If you did not execute any such command, the situation is
2089 probably due to a bug and you should report it.
2091 You can disable the popping up of this buffer by adding the entry
2092 \(undo discard-info) to the user option `warning-suppress-types',
2096 t))
2097 \f
2099 "History list for some commands that read shell commands.
2101 Maximum length of the history list is determined by the value
2108 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2109 This buffer is used when `shell-command' or `shell-command-on-region'
2110 is run interactively. A value of nil means that output to stderr and
2117 "Return a list of all commands associated with the current file.
2118 This function is used to add all related commands retrieved by `mailcap'
2119 to the end of the list of defaults just after the default value."
2123 minibuffer-default))
2128 commands))
2138 "Dynamically complete shell command at point."
2150 map)
2154 "Read a shell command from the minibuffer.
2155 The arguments are the same as the ones of `read-from-minibuffer',
2156 except READ and KEYMAP are missing and HIST defaults
2157 to `shell-command-history'."
2163 minibuffer-local-shell-command-map
2164 nil
2166 args)))
2169 "Execute string COMMAND asynchronously in background.
2171 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2172 surrounded by whitespace and executes the command asynchronously.
2173 The output appears in the buffer `*Async Shell Command*'.
2175 In Elisp, you will often be better served by calling `start-process'
2176 directly, since it offers more control and does not impose the use of a
2177 shell (with its need to quote arguments)."
2183 current-prefix-arg
2184 shell-command-default-error-buffer))
2190 "Execute string COMMAND in inferior shell; display output, if any.
2191 With prefix argument, insert the COMMAND's output at point.
2193 If COMMAND ends in ampersand, execute it asynchronously.
2194 The output appears in the buffer `*Async Shell Command*'.
2195 That buffer is in shell mode.
2197 Otherwise, COMMAND is executed synchronously. The output appears in
2198 the buffer `*Shell Command Output*'. If the output is short enough to
2199 display in the echo area (which is determined by the variables
2200 `resize-mini-windows' and `max-mini-window-height'), it is shown
2201 there, but it is nonetheless available in buffer `*Shell Command
2202 Output*' even though that buffer is not automatically displayed.
2204 To specify a coding system for converting non-ASCII characters
2206 before this command.
2208 Noninteractive callers can specify coding systems by binding
2209 `coding-system-for-read' and `coding-system-for-write'.
2211 The optional second argument OUTPUT-BUFFER, if non-nil,
2212 says to put the output in some other buffer.
2213 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2214 If OUTPUT-BUFFER is not a buffer and not nil,
2215 insert output in current buffer. (This cannot be done asynchronously.)
2216 In either case, the buffer is first erased, and the output is
2217 inserted after point (leaving mark after it).
2219 If the command terminates without error, but generates output,
2221 the output can be displayed in the echo area or in its buffer.
2222 If the output is short enough to display in the echo area
2223 \(determined by the variable `max-mini-window-height' if
2224 `resize-mini-windows' is non-nil), it is shown there.
2225 Otherwise,the buffer containing the output is displayed.
2229 of the output.
2231 If there is no output, or if output is inserted in the current buffer,
2232 then `*Shell Command Output*' is deleted.
2234 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2235 or buffer name to which to direct the command's standard error output.
2236 If it is nil, error output is mingled with regular output.
2237 In an interactive call, the variable `shell-command-default-error-buffer'
2238 specifies the value of ERROR-BUFFER.
2240 In Elisp, you will often be better served by calling `call-process' or
2241 `start-process' directly, since it offers more control and does not impose
2242 the use of a shell (with its need to quote arguments)."
2253 current-prefix-arg
2254 shell-command-default-error-buffer))
2255 ;; Look for a handler in case default-directory is a remote file name.
2263 ;; Output goes in current buffer.
2269 temporary-file-directory)))
2270 nil)))
2273 ;; We do not use -f for csh; we will not support broken use of
2274 ;; .cshrcs. Even the BSD csh manual says to use
2275 ;; "if ($?prompt) exit" before things which are not useful
2276 ;; non-interactively. Besides, if someone wants their other
2277 ;; aliases for shell commands then they can still have them.
2281 t)
2282 nil shell-command-switch command)
2289 ;; Do no formatting while reading error file,
2290 ;; because that can run a shell command, and we
2291 ;; don't want that to cause an infinite recursion.
2293 ;; Put point after the inserted errors.
2297 ;; This is like exchange-point-and-mark, but doesn't
2298 ;; activate the mark. It is cleaner to avoid activation,
2299 ;; even though the command loop would deactivate the mark
2300 ;; because we inserted text.
2304 ;; Output goes in a separate buffer.
2305 ;; Preserve the match data in case called from a program.
2308 ;; Command ending with ampersand means asynchronous.
2312 proc)
2313 ;; Remove the ampersand.
2315 ;; If will kill a process, query first.
2327 shell-command-switch command))
2331 ;; Use the comint filter for proper handling of carriage motion
2332 ;; (see `comint-inhibit-carriage-motion'),.
2334 ))
2335 ;; Otherwise, command is executed synchronously.
2337 output-buffer nil error-buffer)))))))
2341 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2342 MESSAGE may be either a string or a buffer.
2344 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2345 the maximum height of the echo area, as defined by `max-mini-window-height'
2346 if `resize-mini-windows' is non-nil.
2348 Returns either the string shown in the echo area, or when a pop-up
2349 buffer is used, the window used to display it.
2351 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2352 name of the buffer used to display it in the case where a pop-up buffer
2353 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2354 string and it is displayed in the echo area, it is not specified whether
2355 the contents are inserted into the buffer anyway.
2357 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2358 and only used if a buffer is displayed."
2360 ;; Trivial case where we can use the echo area
2364 ;; Trivial case where we can just remove single trailing newline
2367 ;; General case
2370 message
2379 0
2383 (<= lines
2387 max-mini-window-height))
2389 max-mini-window-height)
2393 ;; Don't use the echo area if the output buffer is
2394 ;; already dispayed in the selected frame.
2396 ;; Echo area
2402 ;; Buffer
2405 not-this-window frame))))))))
2408 ;; We have a sentinel to prevent insertion of a termination message
2409 ;; in the buffer itself.
2417 &optional output-buffer replace
2418 error-buffer display-error-buffer)
2419 "Execute string COMMAND in inferior shell with region as input.
2420 Normally display output (if any) in temp buffer `*Shell Command Output*';
2421 Prefix arg means replace the region with it. Return the exit code of
2422 COMMAND.
2424 To specify a coding system for converting non-ASCII characters
2426 before this command. By default, the input (from the current buffer)
2427 is encoded in the same coding system that will be used to save the file,
2428 `buffer-file-coding-system'. If the output is going to replace the region,
2429 then it is decoded from that same coding system.
2431 The noninteractive arguments are START, END, COMMAND,
2432 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2433 Noninteractive callers can specify coding systems by binding
2434 `coding-system-for-read' and `coding-system-for-write'.
2436 If the command generates output, the output may be displayed
2437 in the echo area or in a buffer.
2438 If the output is short enough to display in the echo area
2439 \(determined by the variable `max-mini-window-height' if
2440 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2441 it is displayed in the buffer `*Shell Command Output*'. The output
2442 is available in that buffer in both cases.
2444 If there is output and an error, a message about the error
2445 appears at the end of the output.
2447 If there is no output, or if output is inserted in the current buffer,
2448 then `*Shell Command Output*' is deleted.
2450 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2451 that says to put the output in some other buffer.
2452 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2453 If OUTPUT-BUFFER is not a buffer and not nil,
2454 insert output in the current buffer.
2455 In either case, the output is inserted after point (leaving mark after it).
2457 If REPLACE, the optional fifth argument, is non-nil, that means insert
2458 the output in place of text from START to END, putting point and mark
2459 around it.
2461 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2462 or buffer name to which to direct the command's standard error output.
2463 If it is nil, error output is mingled with regular output.
2464 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2465 were any errors. (This is always t, interactively.)
2466 In an interactive call, the variable `shell-command-default-error-buffer'
2467 specifies the value of ERROR-BUFFER."
2471 ;; Do this before calling region-beginning
2472 ;; and region-end, in case subprocess output
2473 ;; relocates them while we are in the minibuffer.
2475 ;; call-interactively recognizes region-beginning and
2476 ;; region-end specially, leaving them in the history.
2478 string
2479 current-prefix-arg
2480 current-prefix-arg
2481 shell-command-default-error-buffer
2482 t)))
2488 temporary-file-directory)))
2489 nil))
2490 exit-status)
2494 ;; Replace specified region with output from command.
2496 ;; Don't muck with mark unless REPLACE says we should.
2503 t)
2504 nil shell-command-switch command))
2505 ;; It is rude to delete a buffer which the command is not using.
2506 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2507 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2508 ;; (kill-buffer shell-buffer)))
2509 ;; Don't muck with mark unless REPLACE says we should.
2511 ;; No prefix argument: put the output in a temp buffer,
2512 ;; replacing its entire contents.
2517 ;; If the input is the same buffer as the output,
2518 ;; delete everything but the specified region,
2519 ;; then replace that region with the output.
2525 shell-file-name t
2528 t)
2529 nil shell-command-switch
2530 command)))
2531 ;; Clear the output buffer, then run the command with
2532 ;; output there.
2543 buffer)
2544 nil shell-command-switch command)))
2545 ;; Report the output.
2555 ;; There's some output, display it
2557 ;; No output; error?
2561 "some error output"
2567 output))
2570 exit-status))
2573 exit-status output))))
2574 ;; Don't kill: there might be useful info in the undo-log.
2575 ;; (kill-buffer buffer)
2576 ))))
2584 ;; Do no formatting while reading error file,
2585 ;; because that can run a shell command, and we
2586 ;; don't want that to cause an infinite recursion.
2588 ;; Put point after the inserted errors.
2593 exit-status))
2596 "Execute shell command COMMAND and return its output as a string."
2599 standard-output
2603 "Process files synchronously in a separate process.
2604 Similar to `call-process', but may invoke a file handler based on
2605 `default-directory'. The current working directory of the
2606 subprocess is `default-directory'.
2608 File names in INFILE and BUFFER are handled normally, but file
2609 names in ARGS should be relative to `default-directory', as they
2610 are passed to the process verbatim. \(This is a difference to
2611 `call-process' which does not support file handlers for INFILE
2612 and BUFFER.\)
2614 Some file handlers might not support all variants, for example
2615 they might behave as if DISPLAY was nil, regardless of the actual
2616 value passed."
2618 lc stderr-file)
2628 display args)
2634 "Whether a call of `process-file' changes remote files.
2636 Per default, this variable is always set to `t', meaning that a
2637 call of `process-file' could potentially change any file on a
2638 remote host. When set to `nil', a file handler could optimize
2639 its behaviour with respect to remote file attributes caching.
2641 This variable should never be changed by `setq'. Instead of, it
2645 "Start a program in a subprocess. Return the process object for it.
2647 Similar to `start-process', but may invoke a file handler based on
2648 `default-directory'. See Info node `(elisp)Magic File Names'.
2650 This handler ought to run PROGRAM, perhaps on the local host,
2651 perhaps on a remote host that corresponds to `default-directory'.
2652 In the latter case, the local part of `default-directory' becomes
2653 the working directory of the process.
2655 PROGRAM and PROGRAM-ARGS might be file names. They are not
2656 objects of file handler invocation. File handlers might not
2657 support pty association, if PROGRAM is nil."
2662 \f
2666 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2667 (define-key map [switch-frame] nil)
2668 (define-key map [?\C-u] 'universal-argument-more)
2669 (define-key map [?-] 'universal-argument-minus)
2670 (define-key map [?0] 'digit-argument)
2671 (define-key map [?1] 'digit-argument)
2672 (define-key map [?2] 'digit-argument)
2673 (define-key map [?3] 'digit-argument)
2674 (define-key map [?4] 'digit-argument)
2675 (define-key map [?5] 'digit-argument)
2676 (define-key map [?6] 'digit-argument)
2677 (define-key map [?7] 'digit-argument)
2678 (define-key map [?8] 'digit-argument)
2679 (define-key map [?9] 'digit-argument)
2680 (define-key map [kp-0] 'digit-argument)
2681 (define-key map [kp-1] 'digit-argument)
2682 (define-key map [kp-2] 'digit-argument)
2683 (define-key map [kp-3] 'digit-argument)
2684 (define-key map [kp-4] 'digit-argument)
2685 (define-key map [kp-5] 'digit-argument)
2686 (define-key map [kp-6] 'digit-argument)
2687 (define-key map [kp-7] 'digit-argument)
2688 (define-key map [kp-8] 'digit-argument)
2689 (define-key map [kp-9] 'digit-argument)
2690 (define-key map [kp-subtract] 'universal-argument-minus)
2691 map)
2694 (defvar universal-argument-num-events nil
2695 "Number of argument-specifying events read by `universal-argument'.
2696 `universal-argument-other-key' uses this to discard those events
2697 from (this-command-keys), and reread only the final command.")
2699 (defvar overriding-map-is-bound nil
2700 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2702 (defvar saved-overriding-map nil
2703 "The saved value of `overriding-terminal-local-map'.
2707 (defun ensure-overriding-map-is-bound ()
2708 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2709 (unless overriding-map-is-bound
2710 (setq saved-overriding-map overriding-terminal-local-map)
2711 (setq overriding-terminal-local-map universal-argument-map)
2712 (setq overriding-map-is-bound t)))
2714 (defun restore-overriding-map ()
2715 "Restore `overriding-terminal-local-map' to its saved value."
2716 (setq overriding-terminal-local-map saved-overriding-map)
2717 (setq overriding-map-is-bound nil))
2719 (defun universal-argument ()
2720 "Begin a numeric argument for the following command.
2725 multiplies the argument by 4 each time.
2727 which is different in effect from any particular numeric argument.
2729 (interactive)
2730 (setq prefix-arg (list 4))
2731 (setq universal-argument-num-events (length (this-command-keys)))
2732 (ensure-overriding-map-is-bound))
2734 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2735 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2736 (defun universal-argument-more (arg)
2737 (interactive "P")
2738 (if (consp arg)
2739 (setq prefix-arg (list (* 4 (car arg))))
2740 (if (eq arg '-)
2741 (setq prefix-arg (list -4))
2742 (setq prefix-arg arg)
2743 (restore-overriding-map)))
2744 (setq universal-argument-num-events (length (this-command-keys))))
2746 (defun negative-argument (arg)
2747 "Begin a negative numeric argument for the next command.
2749 (interactive "P")
2750 (cond ((integerp arg)
2751 (setq prefix-arg (- arg)))
2752 ((eq arg '-)
2753 (setq prefix-arg nil))
2754 (t
2755 (setq prefix-arg '-)))
2756 (setq universal-argument-num-events (length (this-command-keys)))
2757 (ensure-overriding-map-is-bound))
2759 (defun digit-argument (arg)
2760 "Part of the numeric argument for the next command.
2762 (interactive "P")
2763 (let* ((char (if (integerp last-command-event)
2764 last-command-event
2765 (get last-command-event 'ascii-character)))
2767 (cond ((integerp arg)
2768 (setq prefix-arg (+ (* arg 10)
2769 (if (< arg 0) (- digit) digit))))
2770 ((eq arg '-)
2771 ;; Treat -0 as just -, so that -01 will work.
2772 (setq prefix-arg (if (zerop digit) '- (- digit))))
2773 (t
2774 (setq prefix-arg digit))))
2775 (setq universal-argument-num-events (length (this-command-keys)))
2776 (ensure-overriding-map-is-bound))
2778 ;; For backward compatibility, minus with no modifiers is an ordinary
2779 ;; command if digits have already been entered.
2780 (defun universal-argument-minus (arg)
2781 (interactive "P")
2782 (if (integerp arg)
2783 (universal-argument-other-key arg)
2784 (negative-argument arg)))
2786 ;; Anything else terminates the argument and is left in the queue to be
2787 ;; executed as a command.
2788 (defun universal-argument-other-key (arg)
2789 (interactive "P")
2790 (setq prefix-arg arg)
2791 (let* ((key (this-command-keys))
2792 (keylist (listify-key-sequence key)))
2793 (setq unread-command-events
2794 (append (nthcdr universal-argument-num-events keylist)
2795 unread-command-events)))
2796 (reset-this-command-lengths)
2797 (restore-overriding-map))
2798 \f
2799 ;; This function is here rather than in subr.el because it uses CL.
2800 (defmacro with-wrapper-hook (var args &rest body)
2801 "Run BODY wrapped with the VAR hook.
2802 VAR is a special hook: its functions are called with a first argument
2804 the original function, or call it any number of times (including not calling
2805 it at all). This is similar to an `around' advice.
2806 VAR is normally a symbol (a variable) in which case it is treated like
2807 a hook, with a buffer-local and a global part. But it can also be an
2808 arbitrary expression.
2809 ARGS is a list of variables which will be passed as additional arguments
2810 to each function, after the initial argument, and which the first argument
2811 expects to receive when called."
2812 (declare (indent 2) (debug t))
2813 ;; We need those two gensyms because CL's lexical scoping is not available
2814 ;; for function arguments :-(
2815 (let ((funs (make-symbol "funs"))
2816 (global (make-symbol "global"))
2817 (argssym (make-symbol "args")))
2818 ;; Since the hook is a wrapper, the loop has to be done via
2819 ;; recursion: a given hook function will call its parameter in order to
2820 ;; continue looping.
2821 `(labels ((runrestofhook (,funs ,global ,argssym)
2822 ;; `funs' holds the functions left on the hook and `global'
2823 ;; holds the functions left on the global part of the hook
2824 ;; (in case the hook is local).
2825 (lexical-let ((funs ,funs)
2826 (global ,global))
2827 (if (consp funs)
2828 (if (eq t (car funs))
2829 (runrestofhook
2830 (append global (cdr funs)) nil ,argssym)
2831 (apply (car funs)
2832 (lambda (&rest ,argssym)
2833 (runrestofhook (cdr funs) global ,argssym))
2834 ,argssym))
2835 ;; Once there are no more functions on the hook, run
2836 ;; the original body.
2837 (apply (lambda ,args ,@body) ,argssym)))))
2838 (runrestofhook ,var
2839 ;; The global part of the hook, if any.
2840 ,(if (symbolp var)
2841 `(if (local-variable-p ',var)
2842 (default-value ',var)))
2843 (list ,@args)))))
2845 (defvar filter-buffer-substring-functions nil
2846 "Wrapper hook around `filter-buffer-substring'.
2847 The functions on this special hook are called with 4 arguments:
2848 NEXT-FUN BEG END DELETE
2849 NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2850 that performs the default operation. The other 3 arguments are like
2851 the ones passed to `filter-buffer-substring'.")
2853 (defvar buffer-substring-filters nil
2854 "List of filter functions for `filter-buffer-substring'.
2855 Each function must accept a single argument, a string, and return
2856 a string. The buffer substring is passed to the first function
2857 in the list, and the return value of each function is passed to
2858 the next. The return value of the last function is used as the
2859 return value of `filter-buffer-substring'.
2861 If this variable is nil, no filtering is performed.")
2862 (make-obsolete-variable 'buffer-substring-filters
2863 'filter-buffer-substring-functions "24.1")
2865 (defun filter-buffer-substring (beg end &optional delete)
2866 "Return the buffer substring between BEG and END, after filtering.
2867 The filtering is performed by `filter-buffer-substring-functions'.
2869 If DELETE is non-nil, the text between BEG and END is deleted
2870 from the buffer.
2872 This function should be used instead of `buffer-substring',
2873 `buffer-substring-no-properties', or `delete-and-extract-region'
2874 when you want to allow filtering to take place. For example,
2875 major or minor modes can use `filter-buffer-substring-functions' to
2876 extract characters that are special to a buffer, and should not
2877 be copied into other buffers."
2878 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2879 (cond
2880 ((or delete buffer-substring-filters)
2881 (save-excursion
2882 (goto-char beg)
2883 (let ((string (if delete (delete-and-extract-region beg end)
2884 (buffer-substring beg end))))
2885 (dolist (filter buffer-substring-filters)
2886 (setq string (funcall filter string)))
2887 string)))
2888 (t
2889 (buffer-substring beg end)))))
2892 ;;;; Window system cut and paste hooks.
2894 (defvar interprogram-cut-function nil
2895 "Function to call to make a killed region available to other programs.
2897 Most window systems provide some sort of facility for cutting and
2898 pasting text between the windows of different programs.
2899 This variable holds a function that Emacs calls whenever text
2900 is put in the kill ring, to make the new kill available to other
2901 programs.
2903 The function takes one argument, TEXT, which is a string containing
2904 the text which should be made available.")
2906 (defvar interprogram-paste-function nil
2907 "Function to call to get text cut from other programs.
2909 Most window systems provide some sort of facility for cutting and
2910 pasting text between the windows of different programs.
2911 This variable holds a function that Emacs calls to obtain
2912 text that other programs have provided for pasting.
2914 The function should be called with no arguments. If the function
2915 returns nil, then no other program has provided such text, and the top
2916 of the Emacs kill ring should be used. If the function returns a
2917 string, then the caller of the function \(usually `current-kill')
2918 should put this string in the kill ring as the latest kill.
2920 This function may also return a list of strings if the window
2921 system supports multiple selections. The first string will be
2922 used as the pasted text, but the other will be placed in the
2923 kill ring for easy access via `yank-pop'.
2925 Note that the function should return a string only if a program other
2926 than Emacs has provided a string for pasting; if Emacs provided the
2927 most recent string, the function should return nil. If it is
2928 difficult to tell whether Emacs or some other program provided the
2929 current string, it is probably good enough to return nil if the string
2930 is equal (according to `string=') to the last text Emacs provided.")
2931 \f
2934 ;;;; The kill ring data structure.
2936 (defvar kill-ring nil
2937 "List of killed text sequences.
2938 Since the kill ring is supposed to interact nicely with cut-and-paste
2939 facilities offered by window systems, use of this variable should
2940 interact nicely with `interprogram-cut-function' and
2941 `interprogram-paste-function'. The functions `kill-new',
2942 `kill-append', and `current-kill' are supposed to implement this
2943 interaction; you may want to use them instead of manipulating the kill
2944 ring directly.")
2946 (defcustom kill-ring-max 60
2947 "Maximum length of kill ring before oldest elements are thrown away."
2948 :type 'integer
2949 :group 'killing)
2951 (defvar kill-ring-yank-pointer nil
2952 "The tail of the kill ring whose car is the last thing yanked.")
2954 (defcustom save-interprogram-paste-before-kill nil
2955 "Save clipboard strings into kill ring before replacing them.
2956 When one selects something in another program to paste it into Emacs,
2957 but kills something in Emacs before actually pasting it,
2958 this selection is gone unless this variable is non-nil,
2959 in which case the other program's selection is saved in the `kill-ring'
2961 :type 'boolean
2962 :group 'killing
2963 :version "23.2")
2965 (defcustom kill-do-not-save-duplicates nil
2966 "Do not add a new string to `kill-ring' when it is the same as the last one."
2967 :type 'boolean
2968 :group 'killing
2969 :version "23.2")
2971 (defun kill-new (string &optional replace yank-handler)
2972 "Make STRING the latest kill in the kill ring.
2973 Set `kill-ring-yank-pointer' to point to it.
2974 If `interprogram-cut-function' is non-nil, apply it to STRING.
2975 Optional second argument REPLACE non-nil means that STRING will replace
2976 the front of the kill ring, rather than being added to the list.
2978 Optional third arguments YANK-HANDLER controls how the STRING is later
2979 inserted into a buffer; see `insert-for-yank' for details.
2980 When a yank handler is specified, STRING must be non-empty (the yank
2981 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2983 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
2984 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
2985 STRING.
2987 When the yank handler has a non-nil PARAM element, the original STRING
2988 argument is not used by `insert-for-yank'. However, since Lisp code
2989 may access and use elements from the kill ring directly, the STRING
2991 (if (> (length string) 0)
2992 (if yank-handler
2993 (put-text-property 0 (length string)
2994 'yank-handler yank-handler string))
2995 (if yank-handler
2996 (signal 'args-out-of-range
2997 (list string "yank-handler specified for empty string"))))
2998 (unless (and kill-do-not-save-duplicates
2999 (equal string (car kill-ring)))
3000 (if (fboundp 'menu-bar-update-yank-menu)
3001 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3002 (when save-interprogram-paste-before-kill
3003 (let ((interprogram-paste (and interprogram-paste-function
3004 (funcall interprogram-paste-function))))
3005 (when interprogram-paste
3006 (dolist (s (if (listp interprogram-paste)
3007 (nreverse interprogram-paste)
3008 (list interprogram-paste)))
3009 (unless (and kill-do-not-save-duplicates
3010 (equal s (car kill-ring)))
3011 (push s kill-ring))))))
3012 (unless (and kill-do-not-save-duplicates
3013 (equal string (car kill-ring)))
3014 (if (and replace kill-ring)
3015 (setcar kill-ring string)
3016 (push string kill-ring)
3017 (if (> (length kill-ring) kill-ring-max)
3018 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3019 (setq kill-ring-yank-pointer kill-ring)
3020 (if interprogram-cut-function
3021 (funcall interprogram-cut-function string)))
3023 (defun kill-append (string before-p &optional yank-handler)
3024 "Append STRING to the end of the latest kill in the kill ring.
3025 If BEFORE-P is non-nil, prepend STRING to the kill.
3026 Optional third argument YANK-HANDLER, if non-nil, specifies the
3027 yank-handler text property to be set on the combined kill ring
3028 string. If the specified yank-handler arg differs from the
3029 yank-handler property of the latest kill string, this function
3030 adds the combined string to the kill ring as a new element,
3031 instead of replacing the last kill with it.
3032 If `interprogram-cut-function' is set, pass the resulting kill to it."
3033 (let* ((cur (car kill-ring)))
3034 (kill-new (if before-p (concat string cur) (concat cur string))
3035 (or (= (length cur) 0)
3036 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3037 yank-handler)))
3039 (defcustom yank-pop-change-selection nil
3040 "If non-nil, rotating the kill ring changes the window system selection."
3041 :type 'boolean
3042 :group 'killing
3043 :version "23.1")
3045 (defun current-kill (n &optional do-not-move)
3046 "Rotate the yanking point by N places, and then return that kill.
3047 If N is zero, `interprogram-paste-function' is set, and calling
3048 it returns a string or list of strings, then that string (or
3049 list) is added to the front of the kill ring and the string (or
3050 first string in the list) is returned as the latest kill.
3052 If N is not zero, and if `yank-pop-change-selection' is
3053 non-nil, use `interprogram-cut-function' to transfer the
3054 kill at the new yank point into the window system selection.
3056 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3057 move the yanking point; just return the Nth kill forward."
3059 (let ((interprogram-paste (and (= n 0)
3060 interprogram-paste-function
3061 (funcall interprogram-paste-function))))
3062 (if interprogram-paste
3063 (progn
3064 ;; Disable the interprogram cut function when we add the new
3065 ;; text to the kill ring, so Emacs doesn't try to own the
3066 ;; selection, with identical text.
3067 (let ((interprogram-cut-function nil))
3068 (if (listp interprogram-paste)
3069 (mapc 'kill-new (nreverse interprogram-paste))
3070 (kill-new interprogram-paste)))
3071 (car kill-ring))
3072 (or kill-ring (error "Kill ring is empty"))
3073 (let ((ARGth-kill-element
3074 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3075 (length kill-ring))
3076 kill-ring)))
3077 (unless do-not-move
3078 (setq kill-ring-yank-pointer ARGth-kill-element)
3079 (when (and yank-pop-change-selection
3080 (> n 0)
3081 interprogram-cut-function)
3082 (funcall interprogram-cut-function (car ARGth-kill-element))))
3083 (car ARGth-kill-element)))))
3087 ;;;; Commands for manipulating the kill ring.
3089 (defcustom kill-read-only-ok nil
3090 "Non-nil means don't signal an error for killing read-only text."
3091 :type 'boolean
3092 :group 'killing)
3094 (put 'text-read-only 'error-conditions
3095 '(text-read-only buffer-read-only error))
3096 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3098 (defun kill-region (beg end &optional yank-handler)
3100 This deletes the text from the buffer and saves it in the kill ring.
3104 If you want to append the killed region to the last killed text,
3107 If the buffer is read-only, Emacs will beep and refrain from deleting
3108 the text, but put the text in the kill ring anyway. This means that
3109 you can use the killing commands to copy text from a read-only buffer.
3111 Lisp programs should use this function for killing text.
3112 (To delete text, use `delete-region'.)
3113 Supply two arguments, character positions indicating the stretch of text
3114 to be killed.
3116 If the previous command was also a kill command,
3117 the text killed this time appends to the text killed last time
3118 to make one entry in the kill ring.
3120 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
3121 specifies the yank-handler text property to be set on the killed
3122 text. See `insert-for-yank'."
3123 ;; Pass point first, then mark, because the order matters
3124 ;; when calling kill-append.
3125 (interactive (list (point) (mark)))
3126 (unless (and beg end)
3127 (error "The mark is not set now, so there is no region"))
3128 (condition-case nil
3129 (let ((string (filter-buffer-substring beg end t)))
3130 (when string ;STRING is nil if BEG = END
3131 ;; Add that string to the kill ring, one way or another.
3132 (if (eq last-command 'kill-region)
3133 (kill-append string (< end beg) yank-handler)
3134 (kill-new string nil yank-handler)))
3135 (when (or string (eq last-command 'kill-region))
3136 (setq this-command 'kill-region))
3137 nil)
3138 ((buffer-read-only text-read-only)
3139 ;; The code above failed because the buffer, or some of the characters
3140 ;; in the region, are read-only.
3141 ;; We should beep, in case the user just isn't aware of this.
3142 ;; However, there's no harm in putting
3143 ;; the region's text in the kill ring, anyway.
3144 (copy-region-as-kill beg end)
3145 ;; Set this-command now, so it will be set even if we get an error.
3146 (setq this-command 'kill-region)
3147 ;; This should barf, if appropriate, and give us the correct error.
3148 (if kill-read-only-ok
3149 (progn (message "Read only text copied to kill ring") nil)
3150 ;; Signal an error if the buffer is read-only.
3151 (barf-if-buffer-read-only)
3152 ;; If the buffer isn't read-only, the text is.
3153 (signal 'text-read-only (list (current-buffer)))))))
3155 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3156 ;; to get two copies of the text when the user accidentally types M-w and
3157 ;; then corrects it with the intended C-w.
3158 (defun copy-region-as-kill (beg end)
3159 "Save the region as if killed, but don't kill it.
3160 In Transient Mark mode, deactivate the mark.
3161 If `interprogram-cut-function' is non-nil, also save the text for a window
3162 system cut and paste.
3164 This command's old key binding has been given to `kill-ring-save'."
3165 (interactive "r")
3166 (if (eq last-command 'kill-region)
3167 (kill-append (filter-buffer-substring beg end) (< end beg))
3168 (kill-new (filter-buffer-substring beg end)))
3169 (setq deactivate-mark t)
3170 nil)
3172 (defun kill-ring-save (beg end)
3173 "Save the region as if killed, but don't kill it.
3174 In Transient Mark mode, deactivate the mark.
3175 If `interprogram-cut-function' is non-nil, also save the text for a window
3176 system cut and paste.
3178 If you want to append the killed line to the last killed text,
3181 This command is similar to `copy-region-as-kill', except that it gives
3182 visual feedback indicating the extent of the region being copied."
3183 (interactive "r")
3184 (copy-region-as-kill beg end)
3185 ;; This use of called-interactively-p is correct
3186 ;; because the code it controls just gives the user visual feedback.
3187 (if (called-interactively-p 'interactive)
3188 (let ((other-end (if (= (point) beg) end beg))
3189 (opoint (point))
3190 ;; Inhibit quitting so we can make a quit here
3191 ;; look like a C-g typed as a command.
3192 (inhibit-quit t))
3193 (if (pos-visible-in-window-p other-end (selected-window))
3194 ;; Swap point-and-mark quickly so as to show the region that
3195 ;; was selected. Don't do it if the region is highlighted.
3196 (unless (and (region-active-p)
3197 (face-background 'region))
3198 ;; Swap point and mark.
3199 (set-marker (mark-marker) (point) (current-buffer))
3200 (goto-char other-end)
3201 (sit-for blink-matching-delay)
3202 ;; Swap back.
3203 (set-marker (mark-marker) other-end (current-buffer))
3204 (goto-char opoint)
3205 ;; If user quit, deactivate the mark
3206 ;; as C-g would as a command.
3207 (and quit-flag mark-active
3208 (deactivate-mark)))
3209 (let* ((killed-text (current-kill 0))
3210 (message-len (min (length killed-text) 40)))
3211 (if (= (point) beg)
3212 ;; Don't say "killed"; that is misleading.
3214 (substring killed-text (- message-len)))
3216 (substring killed-text 0 message-len))))))))
3218 (defun append-next-kill (&optional interactive)
3219 "Cause following command, if it kills, to append to previous kill.
3220 The argument is used for internal purposes; do not supply one."
3221 (interactive "p")
3222 ;; We don't use (interactive-p), since that breaks kbd macros.
3223 (if interactive
3224 (progn
3225 (setq this-command 'kill-region)
3226 (message "If the next command is a kill, it will append"))
3227 (setq last-command 'kill-region)))
3228 \f
3229 ;; Yanking.
3231 ;; This is actually used in subr.el but defcustom does not work there.
3232 (defcustom yank-excluded-properties
3233 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3234 yank-handler follow-link fontified)
3235 "Text properties to discard when yanking.
3236 The value should be a list of text properties to discard or t,
3237 which means to discard all text properties."
3238 :type '(choice (const :tag "All" t) (repeat symbol))
3239 :group 'killing
3240 :version "22.1")
3242 (defvar yank-window-start nil)
3243 (defvar yank-undo-function nil
3244 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3245 Function is called with two parameters, START and END corresponding to
3246 the value of the mark and point; it is guaranteed that START <= END.
3247 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3249 (defun yank-pop (&optional arg)
3250 "Replace just-yanked stretch of killed text with a different stretch.
3251 This command is allowed only immediately after a `yank' or a `yank-pop'.
3252 At such a time, the region contains a stretch of reinserted
3253 previously-killed text. `yank-pop' deletes that text and inserts in its
3254 place a different stretch of killed text.
3256 With no argument, the previous kill is inserted.
3257 With argument N, insert the Nth previous kill.
3258 If N is negative, this is a more recent kill.
3260 The sequence of kills wraps around, so that after the oldest one
3261 comes the newest one.
3263 When this command inserts killed text into the buffer, it honors
3264 `yank-excluded-properties' and `yank-handler' as described in the
3265 doc string for `insert-for-yank-1', which see."
3266 (interactive "*p")
3267 (if (not (eq last-command 'yank))
3268 (error "Previous command was not a yank"))
3269 (setq this-command 'yank)
3270 (unless arg (setq arg 1))
3271 (let ((inhibit-read-only t)
3272 (before (< (point) (mark t))))
3273 (if before
3274 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3275 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3276 (setq yank-undo-function nil)
3277 (set-marker (mark-marker) (point) (current-buffer))
3278 (insert-for-yank (current-kill arg))
3279 ;; Set the window start back where it was in the yank command,
3280 ;; if possible.
3281 (set-window-start (selected-window) yank-window-start t)
3282 (if before
3283 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3284 ;; It is cleaner to avoid activation, even though the command
3285 ;; loop would deactivate the mark because we inserted text.
3286 (goto-char (prog1 (mark t)
3287 (set-marker (mark-marker) (point) (current-buffer))))))
3288 nil)
3290 (defun yank (&optional arg)
3292 More precisely, reinsert the stretch of killed text most recently
3293 killed OR yanked. Put point at end, and set mark at beginning.
3294 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3295 With argument N, reinsert the Nth most recently killed stretch of killed
3296 text.
3298 When this command inserts killed text into the buffer, it honors
3299 `yank-excluded-properties' and `yank-handler' as described in the
3300 doc string for `insert-for-yank-1', which see.
3303 (interactive "*P")
3304 (setq yank-window-start (window-start))
3305 ;; If we don't get all the way thru, make last-command indicate that
3306 ;; for the following command.
3307 (setq this-command t)
3308 (push-mark (point))
3309 (insert-for-yank (current-kill (cond
3310 ((listp arg) 0)
3311 ((eq arg '-) -2)
3312 (t (1- arg)))))
3313 (if (consp arg)
3314 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3315 ;; It is cleaner to avoid activation, even though the command
3316 ;; loop would deactivate the mark because we inserted text.
3317 (goto-char (prog1 (mark t)
3318 (set-marker (mark-marker) (point) (current-buffer)))))
3319 ;; If we do get all the way thru, make this-command indicate that.
3320 (if (eq this-command t)
3321 (setq this-command 'yank))
3322 nil)
3324 (defun rotate-yank-pointer (arg)
3325 "Rotate the yanking point in the kill ring.
3326 With ARG, rotate that many kills forward (or backward, if negative)."
3327 (interactive "p")
3328 (current-kill arg))
3329 \f
3330 ;; Some kill commands.
3332 ;; Internal subroutine of delete-char
3333 (defun kill-forward-chars (arg)
3334 (if (listp arg) (setq arg (car arg)))
3335 (if (eq arg '-) (setq arg -1))
3336 (kill-region (point) (+ (point) arg)))
3338 ;; Internal subroutine of backward-delete-char
3339 (defun kill-backward-chars (arg)
3340 (if (listp arg) (setq arg (car arg)))
3341 (if (eq arg '-) (setq arg -1))
3342 (kill-region (point) (- (point) arg)))
3344 (defcustom backward-delete-char-untabify-method 'untabify
3345 "The method for untabifying when deleting backward.
3346 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3347 `hungry' -- delete all whitespace, both tabs and spaces;
3348 `all' -- delete all whitespace, including tabs, spaces and newlines;
3349 nil -- just delete one character."
3350 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3351 :version "20.3"
3352 :group 'killing)
3354 (defun backward-delete-char-untabify (arg &optional killp)
3355 "Delete characters backward, changing tabs into spaces.
3356 The exact behavior depends on `backward-delete-char-untabify-method'.
3357 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3358 Interactively, ARG is the prefix arg (default 1)
3359 and KILLP is t if a prefix arg was specified."
3361 (when (eq backward-delete-char-untabify-method 'untabify)
3362 (let ((count arg))
3363 (save-excursion
3364 (while (and (> count 0) (not (bobp)))
3366 (let ((col (current-column)))
3367 (forward-char -1)
3368 (setq col (- col (current-column)))
3369 (insert-char ?\s col)
3370 (delete-char 1)))
3371 (forward-char -1)
3372 (setq count (1- count))))))
3373 (delete-backward-char
3375 ((eq backward-delete-char-untabify-method 'all)
3377 (if skip
3378 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3379 (point)))))
3380 (+ arg (if (zerop wh) 0 (1- wh))))
3381 arg))
3382 killp))
3384 (defun zap-to-char (arg char)
3385 "Kill up to and including ARGth occurrence of CHAR.
3386 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3387 Goes backward if ARG is negative; error if CHAR not found."
3389 ;; Avoid "obsolete" warnings for translation-table-for-input.
3390 (with-no-warnings
3391 (if (char-table-p translation-table-for-input)
3392 (setq char (or (aref translation-table-for-input char) char))))
3393 (kill-region (point) (progn
3394 (search-forward (char-to-string char) nil nil arg)
3395 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3396 (point))))
3398 ;; kill-line and its subroutines.
3400 (defcustom kill-whole-line nil
3401 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3402 :type 'boolean
3403 :group 'killing)
3405 (defun kill-line (&optional arg)
3406 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3407 With prefix argument ARG, kill that many lines from point.
3408 Negative arguments kill lines backward.
3409 With zero argument, kills the text before point on the current line.
3412 a number counts as a prefix arg.
3414 To kill a whole line, when point is not at the beginning, type \
3417 If `kill-whole-line' is non-nil, then this command kills the whole line
3418 including its terminating newline, when used at the beginning of a line
3419 with no argument. As a consequence, you can always kill a whole line
3422 If you want to append the killed line to the last killed text,
3425 If the buffer is read-only, Emacs will beep and refrain from deleting
3426 the line, but put the line in the kill ring anyway. This means that
3427 you can use this command to copy text from a read-only buffer.
3428 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3429 even beep.)"
3430 (interactive "P")
3431 (kill-region (point)
3432 ;; It is better to move point to the other end of the kill
3433 ;; before killing. That way, in a read-only buffer, point
3434 ;; moves across the text that is copied to the kill ring.
3435 ;; The choice has no effect on undo now that undo records
3436 ;; the value of point from before the command was run.
3437 (progn
3438 (if arg
3439 (forward-visible-line (prefix-numeric-value arg))
3440 (if (eobp)
3441 (signal 'end-of-buffer nil))
3442 (let ((end
3443 (save-excursion
3444 (end-of-visible-line) (point))))
3445 (if (or (save-excursion
3446 ;; If trailing whitespace is visible,
3447 ;; don't treat it as nothing.
3448 (unless show-trailing-whitespace
3450 (= (point) end))
3451 (and kill-whole-line (bolp)))
3452 (forward-visible-line 1)
3453 (goto-char end))))
3454 (point))))
3456 (defun kill-whole-line (&optional arg)
3457 "Kill current line.
3458 With prefix ARG, kill that many lines starting from the current line.
3459 If ARG is negative, kill backward. Also kill the preceding newline.
3461 If ARG is zero, kill current line but exclude the trailing newline."
3462 (interactive "p")
3463 (or arg (setq arg 1))
3464 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3465 (signal 'end-of-buffer nil))
3466 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3467 (signal 'beginning-of-buffer nil))
3468 (unless (eq last-command 'kill-region)
3469 (kill-new "")
3470 (setq last-command 'kill-region))
3471 (cond ((zerop arg)
3472 ;; We need to kill in two steps, because the previous command
3473 ;; could have been a kill command, in which case the text
3474 ;; before point needs to be prepended to the current kill
3475 ;; ring entry and the text after point appended. Also, we
3476 ;; need to use save-excursion to avoid copying the same text
3477 ;; twice to the kill ring in read-only buffers.
3478 (save-excursion
3479 (kill-region (point) (progn (forward-visible-line 0) (point))))
3480 (kill-region (point) (progn (end-of-visible-line) (point))))
3481 ((< arg 0)
3482 (save-excursion
3483 (kill-region (point) (progn (end-of-visible-line) (point))))
3484 (kill-region (point)
3485 (progn (forward-visible-line (1+ arg))
3486 (unless (bobp) (backward-char))
3487 (point))))
3488 (t
3489 (save-excursion
3490 (kill-region (point) (progn (forward-visible-line 0) (point))))
3491 (kill-region (point)
3492 (progn (forward-visible-line arg) (point))))))
3494 (defun forward-visible-line (arg)
3495 "Move forward by ARG lines, ignoring currently invisible newlines only.
3496 If ARG is negative, move backward -ARG lines.
3497 If ARG is zero, move to the beginning of the current line."
3498 (condition-case nil
3499 (if (> arg 0)
3500 (progn
3501 (while (> arg 0)
3502 (or (zerop (forward-line 1))
3503 (signal 'end-of-buffer nil))
3504 ;; If the newline we just skipped is invisible,
3505 ;; don't count it.
3506 (let ((prop
3507 (get-char-property (1- (point)) 'invisible)))
3508 (if (if (eq buffer-invisibility-spec t)
3509 prop
3510 (or (memq prop buffer-invisibility-spec)
3511 (assq prop buffer-invisibility-spec)))
3512 (setq arg (1+ arg))))
3513 (setq arg (1- arg)))
3514 ;; If invisible text follows, and it is a number of complete lines,
3515 ;; skip it.
3516 (let ((opoint (point)))
3517 (while (and (not (eobp))
3518 (let ((prop
3519 (get-char-property (point) 'invisible)))
3520 (if (eq buffer-invisibility-spec t)
3521 prop
3522 (or (memq prop buffer-invisibility-spec)
3523 (assq prop buffer-invisibility-spec)))))
3524 (goto-char
3525 (if (get-text-property (point) 'invisible)
3526 (or (next-single-property-change (point) 'invisible)
3527 (point-max))
3528 (next-overlay-change (point)))))
3529 (unless (bolp)
3530 (goto-char opoint))))
3531 (let ((first t))
3532 (while (or first (<= arg 0))
3533 (if first
3534 (beginning-of-line)
3535 (or (zerop (forward-line -1))
3536 (signal 'beginning-of-buffer nil)))
3537 ;; If the newline we just moved to is invisible,
3538 ;; don't count it.
3539 (unless (bobp)
3540 (let ((prop
3541 (get-char-property (1- (point)) 'invisible)))
3542 (unless (if (eq buffer-invisibility-spec t)
3543 prop
3544 (or (memq prop buffer-invisibility-spec)
3545 (assq prop buffer-invisibility-spec)))
3546 (setq arg (1+ arg)))))
3547 (setq first nil))
3548 ;; If invisible text follows, and it is a number of complete lines,
3549 ;; skip it.
3550 (let ((opoint (point)))
3551 (while (and (not (bobp))
3552 (let ((prop
3553 (get-char-property (1- (point)) 'invisible)))
3554 (if (eq buffer-invisibility-spec t)
3555 prop
3556 (or (memq prop buffer-invisibility-spec)
3557 (assq prop buffer-invisibility-spec)))))
3558 (goto-char
3559 (if (get-text-property (1- (point)) 'invisible)
3560 (or (previous-single-property-change (point) 'invisible)
3561 (point-min))
3562 (previous-overlay-change (point)))))
3563 (unless (bolp)
3564 (goto-char opoint)))))
3565 ((beginning-of-buffer end-of-buffer)
3566 nil)))
3568 (defun end-of-visible-line ()
3569 "Move to end of current visible line."
3570 (end-of-line)
3571 ;; If the following character is currently invisible,
3572 ;; skip all characters with that same `invisible' property value,
3573 ;; then find the next newline.
3574 (while (and (not (eobp))
3575 (save-excursion
3577 (let ((prop
3578 (get-char-property (point) 'invisible)))
3579 (if (eq buffer-invisibility-spec t)
3580 prop
3581 (or (memq prop buffer-invisibility-spec)
3582 (assq prop buffer-invisibility-spec))))))
3584 (if (get-text-property (point) 'invisible)
3585 (goto-char (next-single-property-change (point) 'invisible))
3586 (goto-char (next-overlay-change (point))))
3587 (end-of-line)))
3588 \f
3589 (defun insert-buffer (buffer)
3590 "Insert after point the contents of BUFFER.
3591 Puts mark after the inserted text.
3592 BUFFER may be a buffer or a buffer name.
3594 This function is meant for the user to run interactively.
3595 Don't call it from programs: use `insert-buffer-substring' instead!"
3596 (interactive
3597 (list
3598 (progn
3599 (barf-if-buffer-read-only)
3600 (read-buffer "Insert buffer: "
3601 (if (eq (selected-window) (next-window (selected-window)))
3602 (other-buffer (current-buffer))
3603 (window-buffer (next-window (selected-window))))
3604 t))))
3605 (push-mark
3606 (save-excursion
3607 (insert-buffer-substring (get-buffer buffer))
3608 (point)))
3609 nil)
3611 (defun append-to-buffer (buffer start end)
3612 "Append to specified buffer the text of the region.
3613 It is inserted into that buffer before its point.
3615 When calling from a program, give three arguments:
3616 BUFFER (or buffer name), START and END.
3617 START and END specify the portion of the current buffer to be copied."
3618 (interactive
3619 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3620 (region-beginning) (region-end)))
3621 (let* ((oldbuf (current-buffer))
3622 (append-to (get-buffer-create buffer))
3623 (windows (get-buffer-window-list append-to t t))
3624 point)
3625 (save-excursion
3626 (with-current-buffer append-to
3627 (setq point (point))
3628 (barf-if-buffer-read-only)
3629 (insert-buffer-substring oldbuf start end)
3630 (dolist (window windows)
3631 (when (= (window-point window) point)
3632 (set-window-point window (point))))))))
3634 (defun prepend-to-buffer (buffer start end)
3635 "Prepend to specified buffer the text of the region.
3636 It is inserted into that buffer after its point.
3638 When calling from a program, give three arguments:
3639 BUFFER (or buffer name), START and END.
3640 START and END specify the portion of the current buffer to be copied."
3642 (let ((oldbuf (current-buffer)))
3643 (with-current-buffer (get-buffer-create buffer)
3644 (barf-if-buffer-read-only)
3645 (save-excursion
3646 (insert-buffer-substring oldbuf start end)))))
3648 (defun copy-to-buffer (buffer start end)
3649 "Copy to specified buffer the text of the region.
3650 It is inserted into that buffer, replacing existing text there.
3652 When calling from a program, give three arguments:
3653 BUFFER (or buffer name), START and END.
3654 START and END specify the portion of the current buffer to be copied."
3656 (let ((oldbuf (current-buffer)))
3657 (with-current-buffer (get-buffer-create buffer)
3658 (barf-if-buffer-read-only)
3659 (erase-buffer)
3660 (save-excursion
3661 (insert-buffer-substring oldbuf start end)))))
3662 \f
3663 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3664 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3666 (defvar activate-mark-hook nil
3667 "Hook run when the mark becomes active.
3668 It is also run at the end of a command, if the mark is active and
3669 it is possible that the region may have changed.")
3671 (defvar deactivate-mark-hook nil
3672 "Hook run when the mark becomes inactive.")
3674 (defun mark (&optional force)
3675 "Return this buffer's mark value as integer, or nil if never set.
3677 In Transient Mark mode, this function signals an error if
3678 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3679 or the argument FORCE is non-nil, it disregards whether the mark
3680 is active, and returns an integer or nil in the usual way.
3682 If you are using this in an editing command, you are most likely making
3683 a mistake; see the documentation of `set-mark'."
3684 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3685 (marker-position (mark-marker))
3686 (signal 'mark-inactive nil)))
3688 (declare-function x-selection-owner-p "xselect.c" (&optional selection))
3690 (defsubst deactivate-mark (&optional force)
3691 "Deactivate the mark by setting `mark-active' to nil.
3692 Unless FORCE is non-nil, this function does nothing if Transient
3693 Mark mode is disabled.
3694 This function also runs `deactivate-mark-hook'."
3695 (when (or transient-mark-mode force)
3696 (when (and (if (eq select-active-regions 'only)
3697 (eq (car-safe transient-mark-mode) 'only)
3698 select-active-regions)
3699 (region-active-p)
3700 (display-selections-p))
3701 ;; The var `saved-region-selection', if non-nil, is the text in
3702 ;; the region prior to the last command modifying the buffer.
3703 ;; Set the selection to that, or to the current region.
3704 (cond (saved-region-selection
3705 (x-set-selection 'PRIMARY saved-region-selection)
3706 (setq saved-region-selection nil))
3707 ((/= (region-beginning) (region-end))
3708 (x-set-selection 'PRIMARY
3709 (buffer-substring-no-properties
3710 (region-beginning)
3711 (region-end))))))
3712 (if (and (null force)
3713 (or (eq transient-mark-mode 'lambda)
3714 (and (eq (car-safe transient-mark-mode) 'only)
3715 (null (cdr transient-mark-mode)))))
3716 ;; When deactivating a temporary region, don't change
3717 ;; `mark-active' or run `deactivate-mark-hook'.
3718 (setq transient-mark-mode nil)
3719 (if (eq (car-safe transient-mark-mode) 'only)
3720 (setq transient-mark-mode (cdr transient-mark-mode)))
3721 (setq mark-active nil)
3722 (run-hooks 'deactivate-mark-hook))))
3724 (defun activate-mark ()
3725 "Activate the mark."
3726 (when (mark t)
3727 (setq mark-active t)
3728 (unless transient-mark-mode
3729 (setq transient-mark-mode 'lambda))))
3731 (defun set-mark (pos)
3732 "Set this buffer's mark to POS. Don't use this function!
3733 That is to say, don't use this function unless you want
3734 the user to see that the mark has moved, and you want the previous
3735 mark position to be lost.
3737 Normally, when a new mark is set, the old one should go on the stack.
3738 This is why most applications should use `push-mark', not `set-mark'.
3740 Novice Emacs Lisp programmers often try to use the mark for the wrong
3741 purposes. The mark saves a location for the user's convenience.
3742 Most editing commands should not alter the mark.
3743 To remember a location for internal use in the Lisp program,
3744 store it in a Lisp variable. Example:
3746 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3748 (if pos
3749 (progn
3750 (setq mark-active t)
3751 (run-hooks 'activate-mark-hook)
3752 (set-marker (mark-marker) pos (current-buffer)))
3753 ;; Normally we never clear mark-active except in Transient Mark mode.
3754 ;; But when we actually clear out the mark value too, we must
3755 ;; clear mark-active in any mode.
3756 (deactivate-mark t)
3757 (set-marker (mark-marker) nil)))
3759 (defcustom use-empty-active-region nil
3761 If nil, region-aware commands treat empty regions as inactive.
3762 If non-nil, region-aware commands treat the region as active as
3763 long as the mark is active, even if the region is empty.
3765 Region-aware commands are those that act on the region if it is
3766 active and Transient Mark mode is enabled, and on the text near
3767 point otherwise."
3768 :type 'boolean
3769 :version "23.1"
3770 :group 'editing-basics)
3772 (defun use-region-p ()
3773 "Return t if the region is active and it is appropriate to act on it.
3774 This is used by commands that act specially on the region under
3775 Transient Mark mode.
3777 The return value is t if Transient Mark mode is enabled and the
3778 mark is active; furthermore, if `use-empty-active-region' is nil,
3779 the region must not be empty. Otherwise, the return value is nil.
3781 For some commands, it may be appropriate to ignore the value of
3782 `use-empty-active-region'; in that case, use `region-active-p'."
3783 (and (region-active-p)
3784 (or use-empty-active-region (> (region-end) (region-beginning)))))
3786 (defun region-active-p ()
3787 "Return t if Transient Mark mode is enabled and the mark is active.
3789 Some commands act specially on the region when Transient Mark
3790 mode is enabled. Usually, such commands should use
3791 `use-region-p' instead of this function, because `use-region-p'
3792 also checks the value of `use-empty-active-region'."
3793 (and transient-mark-mode mark-active))
3795 (defvar mark-ring nil
3796 "The list of former marks of the current buffer, most recent first.")
3797 (make-variable-buffer-local 'mark-ring)
3798 (put 'mark-ring 'permanent-local t)
3800 (defcustom mark-ring-max 16
3801 "Maximum size of mark ring. Start discarding off end if gets this big."
3802 :type 'integer
3803 :group 'editing-basics)
3805 (defvar global-mark-ring nil
3806 "The list of saved global marks, most recent first.")
3808 (defcustom global-mark-ring-max 16
3809 "Maximum size of global mark ring. \
3810 Start discarding off end if gets this big."
3811 :type 'integer
3812 :group 'editing-basics)
3814 (defun pop-to-mark-command ()
3815 "Jump to mark, and pop a new position for mark off the ring.
3816 \(Does not affect global mark ring\)."
3817 (interactive)
3818 (if (null (mark t))
3819 (error "No mark set in this buffer")
3820 (if (= (point) (mark t))
3821 (message "Mark popped"))
3822 (goto-char (mark t))
3823 (pop-mark)))
3825 (defun push-mark-command (arg &optional nomsg)
3826 "Set mark at where point is.
3827 If no prefix ARG and mark is already set there, just activate it.
3828 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3829 (interactive "P")
3830 (let ((mark (marker-position (mark-marker))))
3831 (if (or arg (null mark) (/= mark (point)))
3832 (push-mark nil nomsg t)
3833 (setq mark-active t)
3834 (run-hooks 'activate-mark-hook)
3835 (unless nomsg
3836 (message "Mark activated")))))
3838 (defcustom set-mark-command-repeat-pop nil
3841 will pop the mark twice, and
3843 will pop the mark three times.
3847 :type 'boolean
3848 :group 'editing-basics)
3850 (defcustom set-mark-default-inactive nil
3851 "If non-nil, setting the mark does not activate it.
3853 behave the same whether or not `transient-mark-mode' is enabled."
3854 :type 'boolean
3855 :group 'editing-basics
3856 :version "23.1")
3858 (defun set-mark-command (arg)
3859 "Set the mark where point is, or jump to the mark.
3860 Setting the mark also alters the region, which is the text
3861 between point and mark; this is the closest equivalent in
3864 With no prefix argument, set the mark at point, and push the
3865 old mark position on local mark ring. Also push the old mark on
3866 global mark ring, if the previous mark was set in another buffer.
3868 When Transient Mark Mode is off, immediately repeating this
3869 command activates `transient-mark-mode' temporarily.
3872 jump to the mark, and set the mark from
3873 position popped off the local mark ring \(this does not affect the global
3875 mark ring \(see `pop-global-mark'\).
3877 If `set-mark-command-repeat-pop' is non-nil, repeating
3879 off the local (or global) mark ring and jumps there.
3882 argument, unconditionally set mark where point is, even if
3883 `set-mark-command-repeat-pop' is non-nil.
3885 Novice Emacs Lisp programmers often try to use the mark for the wrong
3886 purposes. See the documentation of `set-mark' for more information."
3887 (interactive "P")
3888 (cond ((eq transient-mark-mode 'lambda)
3889 (setq transient-mark-mode nil))
3890 ((eq (car-safe transient-mark-mode) 'only)
3891 (deactivate-mark)))
3892 (cond
3893 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3894 (push-mark-command nil))
3895 ((not (eq this-command 'set-mark-command))
3896 (if arg
3897 (pop-to-mark-command)
3898 (push-mark-command t)))
3899 ((and set-mark-command-repeat-pop
3900 (eq last-command 'pop-to-mark-command))
3901 (setq this-command 'pop-to-mark-command)
3902 (pop-to-mark-command))
3903 ((and set-mark-command-repeat-pop
3904 (eq last-command 'pop-global-mark)
3905 (not arg))
3906 (setq this-command 'pop-global-mark)
3907 (pop-global-mark))
3908 (arg
3909 (setq this-command 'pop-to-mark-command)
3910 (pop-to-mark-command))
3911 ((eq last-command 'set-mark-command)
3912 (if (region-active-p)
3913 (progn
3914 (deactivate-mark)
3915 (message "Mark deactivated"))
3916 (activate-mark)
3917 (message "Mark activated")))
3918 (t
3919 (push-mark-command nil)
3920 (if set-mark-default-inactive (deactivate-mark)))))
3922 (defun push-mark (&optional location nomsg activate)
3923 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3924 If the last global mark pushed was not in the current buffer,
3925 also push LOCATION on the global mark ring.
3926 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3928 Novice Emacs Lisp programmers often try to use the mark for the wrong
3929 purposes. See the documentation of `set-mark' for more information.
3931 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3932 (unless (null (mark t))
3933 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3934 (when (> (length mark-ring) mark-ring-max)
3935 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3936 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3937 (set-marker (mark-marker) (or location (point)) (current-buffer))
3938 ;; Now push the mark on the global mark ring.
3939 (if (and global-mark-ring
3940 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3941 ;; The last global mark pushed was in this same buffer.
3942 ;; Don't push another one.
3943 nil
3944 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3945 (when (> (length global-mark-ring) global-mark-ring-max)
3946 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3947 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3948 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3949 (message "Mark set"))
3950 (if (or activate (not transient-mark-mode))
3951 (set-mark (mark t)))
3952 nil)
3954 (defun pop-mark ()
3955 "Pop off mark ring into the buffer's actual mark.
3956 Does not set point. Does nothing if mark ring is empty."
3957 (when mark-ring
3958 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3959 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3960 (move-marker (car mark-ring) nil)
3961 (if (null (mark t)) (ding))
3962 (setq mark-ring (cdr mark-ring)))
3963 (deactivate-mark))
3965 (define-obsolete-function-alias
3966 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
3967 (defun exchange-point-and-mark (&optional arg)
3968 "Put the mark where point is now, and point where the mark is now.
3969 This command works even when the mark is not active,
3970 and it reactivates the mark.
3972 If Transient Mark mode is on, a prefix ARG deactivates the mark
3973 if it is active, and otherwise avoids reactivating it. If
3974 Transient Mark mode is off, a prefix ARG enables Transient Mark
3975 mode temporarily."
3976 (interactive "P")
3977 (let ((omark (mark t))
3978 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
3979 (if (null omark)
3980 (error "No mark set in this buffer"))
3981 (deactivate-mark)
3982 (set-mark (point))
3983 (goto-char omark)
3984 (if set-mark-default-inactive (deactivate-mark))
3985 (cond (temp-highlight
3986 (setq transient-mark-mode (cons 'only transient-mark-mode)))
3987 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
3988 (not (or arg (region-active-p))))
3989 (deactivate-mark))
3990 (t (activate-mark)))
3991 nil))
3993 (defcustom shift-select-mode t
3994 "When non-nil, shifted motion keys activate the mark momentarily.
3996 While the mark is activated in this way, any shift-translated point
3997 motion key extends the region, and if Transient Mark mode was off, it
3998 is temporarily turned on. Furthermore, the mark will be deactivated
3999 by any subsequent point motion key that was not shift-translated, or
4000 by any action that normally deactivates the mark in Transient Mark mode.
4002 See `this-command-keys-shift-translated' for the meaning of
4003 shift-translation."
4004 :type 'boolean
4005 :group 'editing-basics)
4007 (defun handle-shift-selection ()
4008 "Activate/deactivate mark depending on invocation thru shift translation.
4009 This function is called by `call-interactively' when a command
4010 with a `^' character in its `interactive' spec is invoked, before
4011 running the command itself.
4013 If `shift-select-mode' is enabled and the command was invoked
4014 through shift translation, set the mark and activate the region
4015 temporarily, unless it was already set in this way. See
4016 `this-command-keys-shift-translated' for the meaning of shift
4017 translation.
4019 Otherwise, if the region has been activated temporarily,
4020 deactivate it, and restore the variable `transient-mark-mode' to
4021 its earlier value."
4022 (cond ((and shift-select-mode this-command-keys-shift-translated)
4023 (unless (and mark-active
4024 (eq (car-safe transient-mark-mode) 'only))
4025 (setq transient-mark-mode
4026 (cons 'only
4027 (unless (eq transient-mark-mode 'lambda)
4028 transient-mark-mode)))
4029 (push-mark nil nil t)))
4030 ((eq (car-safe transient-mark-mode) 'only)
4031 (setq transient-mark-mode (cdr transient-mark-mode))
4032 (deactivate-mark))))
4034 (define-minor-mode transient-mark-mode
4035 "Toggle Transient Mark mode.
4036 With ARG, turn Transient Mark mode on if ARG is positive, off otherwise.
4038 In Transient Mark mode, when the mark is active, the region is highlighted.
4040 So do certain other operations that set the mark
4041 but whose main purpose is something else--for example,
4047 Many commands change their behavior when Transient Mark mode is in effect
4048 and the mark is active, by acting on the region instead of their usual
4049 default part of the buffer's text. Examples of such commands include
4054 commands which are sensitive to the Transient Mark mode."
4055 :global t
4056 :init-value (not noninteractive)
4057 :initialize 'custom-initialize-delay
4058 :group 'editing-basics)
4060 ;; The variable transient-mark-mode is ugly: it can take on special
4061 ;; values. Document these here.
4062 (defvar transient-mark-mode t
4063 "*Non-nil if Transient Mark mode is enabled.
4064 See the command `transient-mark-mode' for a description of this minor mode.
4066 Non-nil also enables highlighting of the region whenever the mark is active.
4067 The variable `highlight-nonselected-windows' controls whether to highlight
4068 all windows or just the selected window.
4070 If the value is `lambda', that enables Transient Mark mode temporarily.
4071 After any subsequent action that would normally deactivate the mark
4072 \(such as buffer modification), Transient Mark mode is turned off.
4074 If the value is (only . OLDVAL), that enables Transient Mark mode
4075 temporarily. After any subsequent point motion command that is not
4076 shift-translated, or any other action that would normally deactivate
4077 the mark (such as buffer modification), the value of
4078 `transient-mark-mode' is set to OLDVAL.")
4080 (defvar widen-automatically t
4081 "Non-nil means it is ok for commands to call `widen' when they want to.
4082 Some commands will do this in order to go to positions outside
4083 the current accessible part of the buffer.
4085 If `widen-automatically' is nil, these commands will do something else
4086 as a fallback, and won't change the buffer bounds.")
4088 (defvar non-essential nil
4089 "Whether the currently executing code is performing an essential task.
4090 This variable should be non-nil only when running code which should not
4091 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4092 user for a password when we are simply scanning a set of files in the
4093 background or displaying possible completions before the user even asked
4094 for it.")
4096 (defun pop-global-mark ()
4097 "Pop off global mark ring and jump to the top location."
4098 (interactive)
4099 ;; Pop entries which refer to non-existent buffers.
4100 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4101 (setq global-mark-ring (cdr global-mark-ring)))
4102 (or global-mark-ring
4103 (error "No global mark set"))
4104 (let* ((marker (car global-mark-ring))
4105 (buffer (marker-buffer marker))
4106 (position (marker-position marker)))
4107 (setq global-mark-ring (nconc (cdr global-mark-ring)
4108 (list (car global-mark-ring))))
4109 (set-buffer buffer)
4110 (or (and (>= position (point-min))
4111 (<= position (point-max)))
4112 (if widen-automatically
4113 (widen)
4114 (error "Global mark position is outside accessible part of buffer")))
4115 (goto-char position)
4116 (switch-to-buffer buffer)))
4117 \f
4118 (defcustom next-line-add-newlines nil
4119 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4120 :type 'boolean
4121 :version "21.1"
4122 :group 'editing-basics)
4124 (defun next-line (&optional arg try-vscroll)
4125 "Move cursor vertically down ARG lines.
4126 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4127 If there is no character in the target line exactly under the current column,
4128 the cursor is positioned after the character in that line which spans this
4129 column, or at the end of the line if it is not long enough.
4130 If there is no line in the buffer after this one, behavior depends on the
4131 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4132 to create a line, and moves the cursor to that line. Otherwise it moves the
4133 cursor to the end of the buffer.
4135 If the variable `line-move-visual' is non-nil, this command moves
4136 by display lines. Otherwise, it moves by buffer lines, without
4137 taking variable-width characters or continued lines into account.
4140 a semipermanent goal column for this command.
4141 Then instead of trying to move exactly vertically (or as close as possible),
4142 this command moves to the specified goal column (or as close as possible).
4143 The goal column is stored in the variable `goal-column', which is nil
4144 when there is no goal column.
4146 If you are thinking of using this in a Lisp program, consider
4147 using `forward-line' instead. It is usually easier to use
4148 and more reliable (no dependence on goal column, etc.)."
4150 (or arg (setq arg 1))
4151 (if (and next-line-add-newlines (= arg 1))
4152 (if (save-excursion (end-of-line) (eobp))
4153 ;; When adding a newline, don't expand an abbrev.
4154 (let ((abbrev-mode nil))
4155 (end-of-line)
4157 (line-move arg nil nil try-vscroll))
4158 (if (called-interactively-p 'interactive)
4159 (condition-case err
4160 (line-move arg nil nil try-vscroll)
4161 ((beginning-of-buffer end-of-buffer)
4162 (signal (car err) (cdr err))))
4163 (line-move arg nil nil try-vscroll)))
4164 nil)
4166 (defun previous-line (&optional arg try-vscroll)
4167 "Move cursor vertically up ARG lines.
4168 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4169 If there is no character in the target line exactly over the current column,
4170 the cursor is positioned after the character in that line which spans this
4171 column, or at the end of the line if it is not long enough.
4173 If the variable `line-move-visual' is non-nil, this command moves
4174 by display lines. Otherwise, it moves by buffer lines, without
4175 taking variable-width characters or continued lines into account.
4178 a semipermanent goal column for this command.
4179 Then instead of trying to move exactly vertically (or as close as possible),
4180 this command moves to the specified goal column (or as close as possible).
4181 The goal column is stored in the variable `goal-column', which is nil
4182 when there is no goal column.
4184 If you are thinking of using this in a Lisp program, consider using
4185 `forward-line' with a negative argument instead. It is usually easier
4186 to use and more reliable (no dependence on goal column, etc.)."
4188 (or arg (setq arg 1))
4189 (if (called-interactively-p 'interactive)
4190 (condition-case err
4191 (line-move (- arg) nil nil try-vscroll)
4192 ((beginning-of-buffer end-of-buffer)
4193 (signal (car err) (cdr err))))
4194 (line-move (- arg) nil nil try-vscroll))
4195 nil)
4197 (defcustom track-eol nil
4198 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4199 This means moving to the end of each line moved onto.
4200 The beginning of a blank line does not count as the end of a line.
4201 This has no effect when `line-move-visual' is non-nil."
4202 :type 'boolean
4203 :group 'editing-basics)
4205 (defcustom goal-column nil
4207 :type '(choice integer
4208 (const :tag "None" nil))
4209 :group 'editing-basics)
4210 (make-variable-buffer-local 'goal-column)
4212 (defvar temporary-goal-column 0
4213 "Current goal column for vertical motion.
4214 It is the column where point was at the start of the current run
4215 of vertical motion commands.
4217 When moving by visual lines via `line-move-visual', it is a cons
4218 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4219 divided by the default column width, and HSCROLL is the number of
4220 columns by which window is scrolled from left margin.
4222 When the `track-eol' feature is doing its job, the value is
4223 `most-positive-fixnum'.")
4225 (defcustom line-move-ignore-invisible t
4227 Outline mode sets this."
4228 :type 'boolean
4229 :group 'editing-basics)
4231 (defcustom line-move-visual t
4232 "When non-nil, `line-move' moves point by visual lines.
4233 This movement is based on where the cursor is displayed on the
4234 screen, instead of relying on buffer contents alone. It takes
4235 into account variable-width characters and line continuation."
4236 :type 'boolean
4237 :group 'editing-basics)
4239 ;; Returns non-nil if partial move was done.
4240 (defun line-move-partial (arg noerror to-end)
4241 (if (< arg 0)
4242 ;; Move backward (up).
4243 ;; If already vscrolled, reduce vscroll
4244 (let ((vs (window-vscroll nil t)))
4245 (when (> vs (frame-char-height))
4246 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4248 ;; Move forward (down).
4249 (let* ((lh (window-line-height -1))
4250 (vpos (nth 1 lh))
4251 (ypos (nth 2 lh))
4252 (rbot (nth 3 lh))
4253 py vs)
4254 (when (or (null lh)
4255 (>= rbot (frame-char-height))
4256 (<= ypos (- (frame-char-height))))
4257 (unless lh
4258 (let ((wend (pos-visible-in-window-p t nil t)))
4259 (setq rbot (nth 3 wend)
4260 vpos (nth 5 wend))))
4261 (cond
4262 ;; If last line of window is fully visible, move forward.
4263 ((or (null rbot) (= rbot 0))
4264 nil)
4265 ;; If cursor is not in the bottom scroll margin, move forward.
4266 ((and (> vpos 0)
4267 (< (setq py
4268 (or (nth 1 (window-line-height))
4269 (let ((ppos (posn-at-point)))
4270 (cdr (or (posn-actual-col-row ppos)
4271 (posn-col-row ppos))))))
4272 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4273 nil)
4274 ;; When already vscrolled, we vscroll some more if we can,
4275 ;; or clear vscroll and move forward at end of tall image.
4276 ((> (setq vs (window-vscroll nil t)) 0)
4277 (when (> rbot 0)
4278 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4279 ;; If cursor just entered the bottom scroll margin, move forward,
4280 ;; but also vscroll one line so redisplay wont recenter.
4281 ((and (> vpos 0)
4282 (= py (min (- (window-text-height) scroll-margin 1)
4283 (1- vpos))))
4284 (set-window-vscroll nil (frame-char-height) t)
4285 (line-move-1 arg noerror to-end)
4286 t)
4287 ;; If there are lines above the last line, scroll-up one line.
4288 ((> vpos 0)
4289 (scroll-up 1)
4290 t)
4291 ;; Finally, start vscroll.
4292 (t
4293 (set-window-vscroll nil (frame-char-height) t)))))))
4296 ;; This is like line-move-1 except that it also performs
4297 ;; vertical scrolling of tall images if appropriate.
4298 ;; That is not really a clean thing to do, since it mixes
4299 ;; scrolling with cursor motion. But so far we don't have
4300 ;; a cleaner solution to the problem of making C-n do something
4301 ;; useful given a tall image.
4302 (defun line-move (arg &optional noerror to-end try-vscroll)
4303 (unless (and auto-window-vscroll try-vscroll
4304 ;; Only vscroll for single line moves
4305 (= (abs arg) 1)
4306 ;; But don't vscroll in a keyboard macro.
4307 (not defining-kbd-macro)
4308 (not executing-kbd-macro)
4309 (line-move-partial arg noerror to-end))
4310 (set-window-vscroll nil 0 t)
4311 (if line-move-visual
4312 (line-move-visual arg noerror)
4313 (line-move-1 arg noerror to-end))))
4315 ;; Display-based alternative to line-move-1.
4316 ;; Arg says how many lines to move. The value is t if we can move the
4317 ;; specified number of lines.
4318 (defun line-move-visual (arg &optional noerror)
4319 (let ((opoint (point))
4320 (hscroll (window-hscroll))
4321 target-hscroll)
4322 ;; Check if the previous command was a line-motion command, or if
4323 ;; we were called from some other command.
4324 (if (and (consp temporary-goal-column)
4325 (memq last-command `(next-line previous-line ,this-command)))
4326 ;; If so, there's no need to reset `temporary-goal-column',
4327 ;; but we may need to hscroll.
4328 (if (or (/= (cdr temporary-goal-column) hscroll)
4329 (> (cdr temporary-goal-column) 0))
4330 (setq target-hscroll (cdr temporary-goal-column)))
4331 ;; Otherwise, we should reset `temporary-goal-column'.
4332 (let ((posn (posn-at-point)))
4333 (cond
4334 ;; Handle the `overflow-newline-into-fringe' case:
4335 ((eq (nth 1 posn) 'right-fringe)
4336 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4337 ((car (posn-x-y posn))
4338 (setq temporary-goal-column
4339 (cons (/ (float (car (posn-x-y posn)))
4340 (frame-char-width)) hscroll))))))
4341 (if target-hscroll
4342 (set-window-hscroll (selected-window) target-hscroll))
4343 (or (and (= (vertical-motion
4344 (cons (or goal-column
4345 (if (consp temporary-goal-column)
4346 (truncate (car temporary-goal-column))
4347 temporary-goal-column))
4348 arg))
4349 arg)
4350 (or (>= arg 0)
4351 (/= (point) opoint)
4352 ;; If the goal column lies on a display string,
4353 ;; `vertical-motion' advances the cursor to the end
4354 ;; of the string. For arg < 0, this can cause the
4355 ;; cursor to get stuck. (Bug#3020).
4356 (= (vertical-motion arg) arg)))
4357 (unless noerror
4358 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4359 nil)))))
4361 ;; This is the guts of next-line and previous-line.
4362 ;; Arg says how many lines to move.
4363 ;; The value is t if we can move the specified number of lines.
4364 (defun line-move-1 (arg &optional noerror to-end)
4365 ;; Don't run any point-motion hooks, and disregard intangibility,
4366 ;; for intermediate positions.
4367 (let ((inhibit-point-motion-hooks t)
4368 (opoint (point))
4369 (orig-arg arg))
4370 (if (consp temporary-goal-column)
4371 (setq temporary-goal-column (+ (car temporary-goal-column)
4372 (cdr temporary-goal-column))))
4373 (unwind-protect
4374 (progn
4375 (if (not (memq last-command '(next-line previous-line)))
4376 (setq temporary-goal-column
4377 (if (and track-eol (eolp)
4378 ;; Don't count beg of empty line as end of line
4379 ;; unless we just did explicit end-of-line.
4380 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4381 most-positive-fixnum
4382 (current-column))))
4384 (if (not (or (integerp selective-display)
4385 line-move-ignore-invisible))
4386 ;; Use just newline characters.
4387 ;; Set ARG to 0 if we move as many lines as requested.
4388 (or (if (> arg 0)
4389 (progn (if (> arg 1) (forward-line (1- arg)))
4390 ;; This way of moving forward ARG lines
4391 ;; verifies that we have a newline after the last one.
4392 ;; It doesn't get confused by intangible text.
4393 (end-of-line)
4394 (if (zerop (forward-line 1))
4395 (setq arg 0)))
4396 (and (zerop (forward-line arg))
4397 (bolp)
4398 (setq arg 0)))
4399 (unless noerror
4400 (signal (if (< arg 0)
4401 'beginning-of-buffer
4402 'end-of-buffer)
4403 nil)))
4404 ;; Move by arg lines, but ignore invisible ones.
4405 (let (done)
4406 (while (and (> arg 0) (not done))
4407 ;; If the following character is currently invisible,
4408 ;; skip all characters with that same `invisible' property value.
4409 (while (and (not (eobp)) (invisible-p (point)))
4410 (goto-char (next-char-property-change (point))))
4411 ;; Move a line.
4412 ;; We don't use `end-of-line', since we want to escape
4413 ;; from field boundaries ocurring exactly at point.
4414 (goto-char (constrain-to-field
4415 (let ((inhibit-field-text-motion t))
4416 (line-end-position))
4417 (point) t t
4418 'inhibit-line-move-field-capture))
4419 ;; If there's no invisibility here, move over the newline.
4420 (cond
4421 ((eobp)
4422 (if (not noerror)
4423 (signal 'end-of-buffer nil)
4424 (setq done t)))
4425 ((and (> arg 1) ;; Use vertical-motion for last move
4426 (not (integerp selective-display))
4427 (not (invisible-p (point))))
4428 ;; We avoid vertical-motion when possible
4429 ;; because that has to fontify.
4430 (forward-line 1))
4431 ;; Otherwise move a more sophisticated way.
4432 ((zerop (vertical-motion 1))
4433 (if (not noerror)
4434 (signal 'end-of-buffer nil)
4435 (setq done t))))
4436 (unless done
4437 (setq arg (1- arg))))
4438 ;; The logic of this is the same as the loop above,
4439 ;; it just goes in the other direction.
4440 (while (and (< arg 0) (not done))
4441 ;; For completely consistency with the forward-motion
4442 ;; case, we should call beginning-of-line here.
4443 ;; However, if point is inside a field and on a
4444 ;; continued line, the call to (vertical-motion -1)
4445 ;; below won't move us back far enough; then we return
4446 ;; to the same column in line-move-finish, and point
4447 ;; gets stuck -- cyd
4448 (forward-line 0)
4449 (cond
4450 ((bobp)
4451 (if (not noerror)
4452 (signal 'beginning-of-buffer nil)
4453 (setq done t)))
4454 ((and (< arg -1) ;; Use vertical-motion for last move
4455 (not (integerp selective-display))
4456 (not (invisible-p (1- (point)))))
4457 (forward-line -1))
4458 ((zerop (vertical-motion -1))
4459 (if (not noerror)
4460 (signal 'beginning-of-buffer nil)
4461 (setq done t))))
4462 (unless done
4463 (setq arg (1+ arg))
4464 (while (and ;; Don't move over previous invis lines
4465 ;; if our target is the middle of this line.
4466 (or (zerop (or goal-column temporary-goal-column))
4467 (< arg 0))
4468 (not (bobp)) (invisible-p (1- (point))))
4469 (goto-char (previous-char-property-change (point))))))))
4470 ;; This is the value the function returns.
4471 (= arg 0))
4473 (cond ((> arg 0)
4474 ;; If we did not move down as far as desired, at least go
4475 ;; to end of line. Be sure to call point-entered and
4476 ;; point-left-hooks.
4477 (let* ((npoint (prog1 (line-end-position)
4478 (goto-char opoint)))
4479 (inhibit-point-motion-hooks nil))
4480 (goto-char npoint)))
4481 ((< arg 0)
4482 ;; If we did not move up as far as desired,
4483 ;; at least go to beginning of line.
4484 (let* ((npoint (prog1 (line-beginning-position)
4485 (goto-char opoint)))
4486 (inhibit-point-motion-hooks nil))
4487 (goto-char npoint)))
4488 (t
4489 (line-move-finish (or goal-column temporary-goal-column)
4490 opoint (> orig-arg 0)))))))
4492 (defun line-move-finish (column opoint forward)
4493 (let ((repeat t))
4494 (while repeat
4495 ;; Set REPEAT to t to repeat the whole thing.
4496 (setq repeat nil)
4498 (let (new
4499 (old (point))
4500 (line-beg (save-excursion (beginning-of-line) (point)))
4501 (line-end
4502 ;; Compute the end of the line
4503 ;; ignoring effectively invisible newlines.
4504 (save-excursion
4505 ;; Like end-of-line but ignores fields.
4507 (while (and (not (eobp)) (invisible-p (point)))
4508 (goto-char (next-char-property-change (point)))
4510 (point))))
4512 ;; Move to the desired column.
4513 (line-move-to-column (truncate column))
4515 ;; Corner case: suppose we start out in a field boundary in
4516 ;; the middle of a continued line. When we get to
4517 ;; line-move-finish, point is at the start of a new *screen*
4518 ;; line but the same text line; then line-move-to-column would
4519 ;; move us backwards. Test using C-n with point on the "x" in
4520 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4521 (and forward
4522 (< (point) old)
4523 (goto-char old))
4525 (setq new (point))
4527 ;; Process intangibility within a line.
4528 ;; With inhibit-point-motion-hooks bound to nil, a call to
4529 ;; goto-char moves point past intangible text.
4531 ;; However, inhibit-point-motion-hooks controls both the
4532 ;; intangibility and the point-entered/point-left hooks. The
4533 ;; following hack avoids calling the point-* hooks
4534 ;; unnecessarily. Note that we move *forward* past intangible
4535 ;; text when the initial and final points are the same.
4536 (goto-char new)
4537 (let ((inhibit-point-motion-hooks nil))
4538 (goto-char new)
4540 ;; If intangibility moves us to a different (later) place
4541 ;; in the same line, use that as the destination.
4542 (if (<= (point) line-end)
4543 (setq new (point))
4544 ;; If that position is "too late",
4545 ;; try the previous allowable position.
4546 ;; See if it is ok.
4547 (backward-char)
4548 (if (if forward
4549 ;; If going forward, don't accept the previous
4550 ;; allowable position if it is before the target line.
4551 (< line-beg (point))
4552 ;; If going backward, don't accept the previous
4553 ;; allowable position if it is still after the target line.
4554 (<= (point) line-end))
4555 (setq new (point))
4556 ;; As a last resort, use the end of the line.
4557 (setq new line-end))))
4559 ;; Now move to the updated destination, processing fields
4560 ;; as well as intangibility.
4561 (goto-char opoint)
4562 (let ((inhibit-point-motion-hooks nil))
4563 (goto-char
4564 ;; Ignore field boundaries if the initial and final
4565 ;; positions have the same `field' property, even if the
4566 ;; fields are non-contiguous. This seems to be "nicer"
4567 ;; behavior in many situations.
4568 (if (eq (get-char-property new 'field)
4569 (get-char-property opoint 'field))
4570 new
4571 (constrain-to-field new opoint t t
4572 'inhibit-line-move-field-capture))))
4574 ;; If all this moved us to a different line,
4575 ;; retry everything within that new line.
4576 (when (or (< (point) line-beg) (> (point) line-end))
4577 ;; Repeat the intangibility and field processing.
4578 (setq repeat t))))))
4580 (defun line-move-to-column (col)
4581 "Try to find column COL, considering invisibility.
4582 This function works only in certain cases,
4583 because what we really need is for `move-to-column'
4584 and `current-column' to be able to ignore invisible text."
4585 (if (zerop col)
4586 (beginning-of-line)
4587 (move-to-column col))
4589 (when (and line-move-ignore-invisible
4590 (not (bolp)) (invisible-p (1- (point))))
4591 (let ((normal-location (point))
4592 (normal-column (current-column)))
4593 ;; If the following character is currently invisible,
4594 ;; skip all characters with that same `invisible' property value.
4595 (while (and (not (eobp))
4596 (invisible-p (point)))
4597 (goto-char (next-char-property-change (point))))
4598 ;; Have we advanced to a larger column position?
4599 (if (> (current-column) normal-column)
4600 ;; We have made some progress towards the desired column.
4601 ;; See if we can make any further progress.
4602 (line-move-to-column (+ (current-column) (- col normal-column)))
4603 ;; Otherwise, go to the place we originally found
4604 ;; and move back over invisible text.
4605 ;; that will get us to the same place on the screen
4606 ;; but with a more reasonable buffer position.
4607 (goto-char normal-location)
4608 (let ((line-beg (save-excursion (beginning-of-line) (point))))
4609 (while (and (not (bolp)) (invisible-p (1- (point))))
4610 (goto-char (previous-char-property-change (point) line-beg))))))))
4612 (defun move-end-of-line (arg)
4613 "Move point to end of current line as displayed.
4614 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4615 If point reaches the beginning or end of buffer, it stops there.
4617 To ignore the effects of the `intangible' text or overlay
4618 property, bind `inhibit-point-motion-hooks' to t.
4619 If there is an image in the current line, this function
4620 disregards newlines that are part of the text on which the image
4621 rests."
4622 (interactive "^p")
4623 (or arg (setq arg 1))
4624 (let (done)
4625 (while (not done)
4626 (let ((newpos
4627 (save-excursion
4628 (let ((goal-column 0)
4629 (line-move-visual nil))
4630 (and (line-move arg t)
4631 ;; With bidi reordering, we may not be at bol,
4632 ;; so make sure we are.
4634 (not (bobp))
4635 (progn
4636 (while (and (not (bobp)) (invisible-p (1- (point))))
4637 (goto-char (previous-single-char-property-change
4638 (point) 'invisible)))
4639 (backward-char 1)))
4640 (point)))))
4641 (goto-char newpos)
4642 (if (and (> (point) newpos)
4644 (backward-char 1)
4645 (if (and (> (point) newpos) (not (eobp))
4647 ;; If we skipped something intangible and now we're not
4648 ;; really at eol, keep going.
4649 (setq arg 1)
4650 (setq done t)))))))
4652 (defun move-beginning-of-line (arg)
4653 "Move point to beginning of current line as displayed.
4654 \(If there's an image in the line, this disregards newlines
4655 which are part of the text that the image rests on.)
4657 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4658 If point reaches the beginning or end of buffer, it stops there.
4659 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4660 (interactive "^p")
4661 (or arg (setq arg 1))
4663 (let ((orig (point))
4664 first-vis first-vis-field-value)
4666 ;; Move by lines, if ARG is not 1 (the default).
4667 (if (/= arg 1)
4668 (let ((line-move-visual nil))
4669 (line-move (1- arg) t)))
4671 ;; Move to beginning-of-line, ignoring fields and invisibles.
4673 (while (and (not (bobp)) (invisible-p (1- (point))))
4674 (goto-char (previous-char-property-change (point)))
4677 ;; Now find first visible char in the line
4678 (while (and (not (eobp)) (invisible-p (point)))
4679 (goto-char (next-char-property-change (point))))
4680 (setq first-vis (point))
4682 ;; See if fields would stop us from reaching FIRST-VIS.
4683 (setq first-vis-field-value
4684 (constrain-to-field first-vis orig (/= arg 1) t nil))
4686 (goto-char (if (/= first-vis-field-value first-vis)
4687 ;; If yes, obey them.
4688 first-vis-field-value
4689 ;; Otherwise, move to START with attention to fields.
4690 ;; (It is possible that fields never matter in this case.)
4691 (constrain-to-field (point) orig
4692 (/= arg 1) t nil)))))
4695 ;; Many people have said they rarely use this feature, and often type
4696 ;; it by accident. Maybe it shouldn't even be on a key.
4697 (put 'set-goal-column 'disabled t)
4699 (defun set-goal-column (arg)
4701 Those commands will move to this position in the line moved to
4702 rather than trying to keep the same horizontal position.
4703 With a non-nil argument ARG, clears out the goal column
4705 The goal column is stored in the variable `goal-column'."
4706 (interactive "P")
4707 (if arg
4708 (progn
4709 (setq goal-column nil)
4710 (message "No goal column"))
4711 (setq goal-column (current-column))
4712 ;; The older method below can be erroneous if `set-goal-column' is bound
4713 ;; to a sequence containing %
4714 ;;(message (substitute-command-keys
4716 ;;goal-column)
4717 (message "%s"
4718 (concat
4719 (format "Goal column %d " goal-column)
4720 (substitute-command-keys
4723 )
4724 nil)
4725 \f
4726 ;;; Editing based on visual lines, as opposed to logical lines.
4728 (defun end-of-visual-line (&optional n)
4729 "Move point to end of current visual line.
4730 With argument N not nil or 1, move forward N - 1 visual lines first.
4731 If point reaches the beginning or end of buffer, it stops there.
4732 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4733 (interactive "^p")
4734 (or n (setq n 1))
4735 (if (/= n 1)
4736 (let ((line-move-visual t))
4737 (line-move (1- n) t)))
4738 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4739 ;; constrain to field boundaries, so we don't either.
4740 (vertical-motion (cons (window-width) 0)))
4742 (defun beginning-of-visual-line (&optional n)
4743 "Move point to beginning of current visual line.
4744 With argument N not nil or 1, move forward N - 1 visual lines first.
4745 If point reaches the beginning or end of buffer, it stops there.
4746 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4747 (interactive "^p")
4748 (or n (setq n 1))
4749 (let ((opoint (point)))
4750 (if (/= n 1)
4751 (let ((line-move-visual t))
4752 (line-move (1- n) t)))
4753 (vertical-motion 0)
4754 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4755 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4757 (defun kill-visual-line (&optional arg)
4758 "Kill the rest of the visual line.
4759 With prefix argument ARG, kill that many visual lines from point.
4760 If ARG is negative, kill visual lines backward.
4761 If ARG is zero, kill the text before point on the current visual
4762 line.
4764 If you want to append the killed line to the last killed text,
4767 If the buffer is read-only, Emacs will beep and refrain from deleting
4768 the line, but put the line in the kill ring anyway. This means that
4769 you can use this command to copy text from a read-only buffer.
4770 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4771 even beep.)"
4772 (interactive "P")
4773 ;; Like in `kill-line', it's better to move point to the other end
4774 ;; of the kill before killing.
4775 (let ((opoint (point))
4776 (kill-whole-line (and kill-whole-line (bolp))))
4777 (if arg
4778 (vertical-motion (prefix-numeric-value arg))
4779 (end-of-visual-line 1)
4780 (if (= (point) opoint)
4781 (vertical-motion 1)
4782 ;; Skip any trailing whitespace at the end of the visual line.
4783 ;; We used to do this only if `show-trailing-whitespace' is
4784 ;; nil, but that's wrong; the correct thing would be to check
4785 ;; whether the trailing whitespace is highlighted. But, it's
4786 ;; OK to just do this unconditionally.
4789 (1+ (point))
4790 (point)))))
4792 (defun next-logical-line (&optional arg try-vscroll)
4793 "Move cursor vertically down ARG lines.
4794 This is identical to `next-line', except that it always moves
4795 by logical lines instead of visual lines, ignoring the value of
4796 the variable `line-move-visual'."
4798 (let ((line-move-visual nil))
4799 (with-no-warnings
4800 (next-line arg try-vscroll))))
4802 (defun previous-logical-line (&optional arg try-vscroll)
4803 "Move cursor vertically up ARG lines.
4804 This is identical to `previous-line', except that it always moves
4805 by logical lines instead of visual lines, ignoring the value of
4806 the variable `line-move-visual'."
4808 (let ((line-move-visual nil))
4809 (with-no-warnings
4810 (previous-line arg try-vscroll))))
4812 (defgroup visual-line nil
4813 "Editing based on visual lines."
4814 :group 'convenience
4815 :version "23.1")
4817 (defvar visual-line-mode-map
4818 (let ((map (make-sparse-keymap)))
4819 (define-key map [remap kill-line] 'kill-visual-line)
4820 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4821 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4822 ;; These keybindings interfere with xterm function keys. Are
4823 ;; there any other suitable bindings?
4824 ;; (define-key map "\M-[" 'previous-logical-line)
4825 ;; (define-key map "\M-]" 'next-logical-line)
4826 map))
4828 (defcustom visual-line-fringe-indicators '(nil nil)
4829 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4830 The value should be a list of the form (LEFT RIGHT), where LEFT
4831 and RIGHT are symbols representing the bitmaps to display, to
4832 indicate wrapped lines, in the left and right fringes respectively.
4833 See also `fringe-indicator-alist'.
4834 The default is not to display fringe indicators for wrapped lines.
4835 This variable does not affect fringe indicators displayed for
4836 other purposes."
4837 :type '(list (choice (const :tag "Hide left indicator" nil)
4838 (const :tag "Left curly arrow" left-curly-arrow)
4839 (symbol :tag "Other bitmap"))
4840 (choice (const :tag "Hide right indicator" nil)
4841 (const :tag "Right curly arrow" right-curly-arrow)
4842 (symbol :tag "Other bitmap")))
4843 :set (lambda (symbol value)
4844 (dolist (buf (buffer-list))
4845 (with-current-buffer buf
4846 (when (and (boundp 'visual-line-mode)
4847 (symbol-value 'visual-line-mode))
4848 (setq fringe-indicator-alist
4849 (cons (cons 'continuation value)
4850 (assq-delete-all
4851 'continuation
4852 (copy-tree fringe-indicator-alist)))))))
4853 (set-default symbol value)))
4855 (defvar visual-line--saved-state nil)
4857 (define-minor-mode visual-line-mode
4858 "Redefine simple editing commands to act on visual lines, not logical lines.
4859 This also turns on `word-wrap' in the buffer."
4860 :keymap visual-line-mode-map
4861 :group 'visual-line
4862 :lighter " Wrap"
4863 (if visual-line-mode
4864 (progn
4865 (set (make-local-variable 'visual-line--saved-state) nil)
4866 ;; Save the local values of some variables, to be restored if
4867 ;; visual-line-mode is turned off.
4868 (dolist (var '(line-move-visual truncate-lines
4869 truncate-partial-width-windows
4870 word-wrap fringe-indicator-alist))
4871 (if (local-variable-p var)
4872 (push (cons var (symbol-value var))
4873 visual-line--saved-state)))
4874 (set (make-local-variable 'line-move-visual) t)
4875 (set (make-local-variable 'truncate-partial-width-windows) nil)
4876 (setq truncate-lines nil
4877 word-wrap t
4878 fringe-indicator-alist
4879 (cons (cons 'continuation visual-line-fringe-indicators)
4880 fringe-indicator-alist)))
4881 (kill-local-variable 'line-move-visual)
4882 (kill-local-variable 'word-wrap)
4883 (kill-local-variable 'truncate-lines)
4884 (kill-local-variable 'truncate-partial-width-windows)
4885 (kill-local-variable 'fringe-indicator-alist)
4886 (dolist (saved visual-line--saved-state)
4887 (set (make-local-variable (car saved)) (cdr saved)))
4888 (kill-local-variable 'visual-line--saved-state)))
4890 (defun turn-on-visual-line-mode ()
4891 (visual-line-mode 1))
4893 (define-globalized-minor-mode global-visual-line-mode
4894 visual-line-mode turn-on-visual-line-mode
4895 :lighter " vl")
4897 \f
4898 (defun transpose-chars (arg)
4899 "Interchange characters around point, moving forward one character.
4900 With prefix arg ARG, effect is to take character before point
4901 and drag it forward past ARG other characters (backward if ARG negative).
4902 If no argument and at end of line, the previous two chars are exchanged."
4903 (interactive "*P")
4904 (and (null arg) (eolp) (forward-char -1))
4905 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4907 (defun transpose-words (arg)
4908 "Interchange words around point, leaving point at end of them.
4909 With prefix arg ARG, effect is to take word before or around point
4910 and drag it forward past ARG other words (backward if ARG negative).
4911 If ARG is zero, the words around or after point and around or after mark
4912 are interchanged."
4913 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4914 (interactive "*p")
4915 (transpose-subr 'forward-word arg))
4917 (defun transpose-sexps (arg)
4919 Does not work on a sexp that point is in the middle of
4920 if it is a list or string."
4921 (interactive "*p")
4922 (transpose-subr
4923 (lambda (arg)
4924 ;; Here we should try to simulate the behavior of
4925 ;; (cons (progn (forward-sexp x) (point))
4926 ;; (progn (forward-sexp (- x)) (point)))
4927 ;; Except that we don't want to rely on the second forward-sexp
4928 ;; putting us back to where we want to be, since forward-sexp-function
4929 ;; might do funny things like infix-precedence.
4930 (if (if (> arg 0)
4932 (and (not (bobp))
4934 ;; Jumping over a symbol. We might be inside it, mind you.
4935 (progn (funcall (if (> arg 0)
4936 'skip-syntax-backward 'skip-syntax-forward)
4937 "w_")
4938 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4939 ;; Otherwise, we're between sexps. Take a step back before jumping
4940 ;; to make sure we'll obey the same precedence no matter which direction
4941 ;; we're going.
4942 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4943 (cons (save-excursion (forward-sexp arg) (point))
4944 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4945 (not (zerop (funcall (if (> arg 0)
4946 'skip-syntax-forward
4947 'skip-syntax-backward)
4948 ".")))))
4949 (point)))))
4950 arg 'special))
4952 (defun transpose-lines (arg)
4953 "Exchange current line and previous line, leaving point after both.
4954 With argument ARG, takes previous line and moves it past ARG lines.
4955 With argument 0, interchanges line point is in with line mark is in."
4956 (interactive "*p")
4957 (transpose-subr (function
4958 (lambda (arg)
4959 (if (> arg 0)
4960 (progn
4961 ;; Move forward over ARG lines,
4962 ;; but create newlines if necessary.
4963 (setq arg (forward-line arg))
4965 (setq arg (1+ arg)))
4966 (if (> arg 0)
4967 (newline arg)))
4968 (forward-line arg))))
4969 arg))
4971 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
4972 ;; which seems inconsistent with the ARG /= 0 case.
4973 ;; FIXME document SPECIAL.
4974 (defun transpose-subr (mover arg &optional special)
4975 "Subroutine to do the work of transposing objects.
4976 Works for lines, sentences, paragraphs, etc. MOVER is a function that
4977 moves forward by units of the given object (e.g. forward-sentence,
4978 forward-paragraph). If ARG is zero, exchanges the current object
4979 with the one containing mark. If ARG is an integer, moves the
4980 current object past ARG following (if ARG is positive) or
4981 preceding (if ARG is negative) objects, leaving point after the
4982 current object."
4983 (let ((aux (if special mover
4984 (lambda (x)
4985 (cons (progn (funcall mover x) (point))
4986 (progn (funcall mover (- x)) (point))))))
4987 pos1 pos2)
4988 (cond
4989 ((= arg 0)
4990 (save-excursion
4991 (setq pos1 (funcall aux 1))
4992 (goto-char (or (mark) (error "No mark set in this buffer")))
4993 (setq pos2 (funcall aux 1))
4994 (transpose-subr-1 pos1 pos2))
4995 (exchange-point-and-mark))
4996 ((> arg 0)
4997 (setq pos1 (funcall aux -1))
4998 (setq pos2 (funcall aux arg))
4999 (transpose-subr-1 pos1 pos2)
5000 (goto-char (car pos2)))
5001 (t
5002 (setq pos1 (funcall aux -1))
5003 (goto-char (car pos1))
5004 (setq pos2 (funcall aux arg))
5005 (transpose-subr-1 pos1 pos2)))))
5007 (defun transpose-subr-1 (pos1 pos2)
5008 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5009 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5010 (when (> (car pos1) (car pos2))
5011 (let ((swap pos1))
5012 (setq pos1 pos2 pos2 swap)))
5013 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5014 (atomic-change-group
5015 (let (word2)
5016 ;; FIXME: We first delete the two pieces of text, so markers that
5017 ;; used to point to after the text end up pointing to before it :-(
5018 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5019 (goto-char (car pos2))
5020 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5021 (goto-char (car pos1))
5022 (insert word2))))
5023 \f
5024 (defun backward-word (&optional arg)
5025 "Move backward until encountering the beginning of a word.
5026 With argument ARG, do this that many times."
5027 (interactive "^p")
5028 (forward-word (- (or arg 1))))
5030 (defun mark-word (&optional arg allow-extend)
5031 "Set mark ARG words away from point.
5033 move to with the same argument.
5034 Interactively, if this command is repeated
5035 or (in Transient Mark mode) if the mark is active,
5036 it marks the next ARG words after the ones already marked."
5038 (cond ((and allow-extend
5039 (or (and (eq last-command this-command) (mark t))
5040 (region-active-p)))
5041 (setq arg (if arg (prefix-numeric-value arg)
5042 (if (< (mark) (point)) -1 1)))
5043 (set-mark
5044 (save-excursion
5045 (goto-char (mark))
5046 (forward-word arg)
5047 (point))))
5048 (t
5049 (push-mark
5050 (save-excursion
5051 (forward-word (prefix-numeric-value arg))
5052 (point))
5053 nil t))))
5055 (defun kill-word (arg)
5056 "Kill characters forward until encountering the end of a word.
5057 With argument ARG, do this that many times."
5058 (interactive "p")
5059 (kill-region (point) (progn (forward-word arg) (point))))
5061 (defun backward-kill-word (arg)
5062 "Kill characters backward until encountering the beginning of a word.
5063 With argument ARG, do this that many times."
5064 (interactive "p")
5065 (kill-word (- arg)))
5067 (defun current-word (&optional strict really-word)
5068 "Return the symbol or word that point is on (or a nearby one) as a string.
5069 The return value includes no text properties.
5070 If optional arg STRICT is non-nil, return nil unless point is within
5071 or adjacent to a symbol or word. In all cases the value can be nil
5072 if there is no word nearby.
5073 The function, belying its name, normally finds a symbol.
5074 If optional arg REALLY-WORD is non-nil, it finds just a word."
5075 (save-excursion
5076 (let* ((oldpoint (point)) (start (point)) (end (point))
5077 (syntaxes (if really-word "w" "w_"))
5078 (not-syntaxes (concat "^" syntaxes)))
5079 (skip-syntax-backward syntaxes) (setq start (point))
5080 (goto-char oldpoint)
5081 (skip-syntax-forward syntaxes) (setq end (point))
5082 (when (and (eq start oldpoint) (eq end oldpoint)
5083 ;; Point is neither within nor adjacent to a word.
5084 (not strict))
5085 ;; Look for preceding word in same line.
5086 (skip-syntax-backward not-syntaxes
5087 (save-excursion (beginning-of-line)
5088 (point)))
5089 (if (bolp)
5090 ;; No preceding word in same line.
5091 ;; Look for following word in same line.
5092 (progn
5093 (skip-syntax-forward not-syntaxes
5094 (save-excursion (end-of-line)
5095 (point)))
5096 (setq start (point))
5097 (skip-syntax-forward syntaxes)
5098 (setq end (point)))
5099 (setq end (point))
5100 (skip-syntax-backward syntaxes)
5101 (setq start (point))))
5102 ;; If we found something nonempty, return it as a string.
5103 (unless (= start end)
5104 (buffer-substring-no-properties start end)))))
5105 \f
5106 (defcustom fill-prefix nil
5107 "String for filling to insert at front of new line, or nil for none."
5108 :type '(choice (const :tag "None" nil)
5109 string)
5110 :group 'fill)
5111 (make-variable-buffer-local 'fill-prefix)
5112 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5114 (defcustom auto-fill-inhibit-regexp nil
5115 "Regexp to match lines which should not be auto-filled."
5116 :type '(choice (const :tag "None" nil)
5117 regexp)
5118 :group 'fill)
5120 ;; This function is used as the auto-fill-function of a buffer
5121 ;; when Auto-Fill mode is enabled.
5122 ;; It returns t if it really did any work.
5123 ;; (Actually some major modes use a different auto-fill function,
5124 ;; but this one is the default one.)
5125 (defun do-auto-fill ()
5126 (let (fc justify give-up
5127 (fill-prefix fill-prefix))
5128 (if (or (not (setq justify (current-justification)))
5129 (null (setq fc (current-fill-column)))
5130 (and (eq justify 'left)
5131 (<= (current-column) fc))
5132 (and auto-fill-inhibit-regexp
5133 (save-excursion (beginning-of-line)
5134 (looking-at auto-fill-inhibit-regexp))))
5135 nil ;; Auto-filling not required
5136 (if (memq justify '(full center right))
5137 (save-excursion (unjustify-current-line)))
5139 ;; Choose a fill-prefix automatically.
5140 (when (and adaptive-fill-mode
5141 (or (null fill-prefix) (string= fill-prefix "")))
5142 (let ((prefix
5143 (fill-context-prefix
5144 (save-excursion (backward-paragraph 1) (point))
5145 (save-excursion (forward-paragraph 1) (point)))))
5146 (and prefix (not (equal prefix ""))
5147 ;; Use auto-indentation rather than a guessed empty prefix.
5148 (not (and fill-indent-according-to-mode
5150 (setq fill-prefix prefix))))
5152 (while (and (not give-up) (> (current-column) fc))
5153 ;; Determine where to split the line.
5154 (let* (after-prefix
5155 (fill-point
5156 (save-excursion
5157 (beginning-of-line)
5158 (setq after-prefix (point))
5159 (and fill-prefix
5160 (looking-at (regexp-quote fill-prefix))
5161 (setq after-prefix (match-end 0)))
5162 (move-to-column (1+ fc))
5163 (fill-move-to-break-point after-prefix)
5164 (point))))
5166 ;; See whether the place we found is any good.
5167 (if (save-excursion
5168 (goto-char fill-point)
5169 (or (bolp)
5170 ;; There is no use breaking at end of line.
5171 (save-excursion (skip-chars-forward " ") (eolp))
5172 ;; It is futile to split at the end of the prefix
5173 ;; since we would just insert the prefix again.
5174 (and after-prefix (<= (point) after-prefix))
5175 ;; Don't split right after a comment starter
5176 ;; since we would just make another comment starter.
5177 (and comment-start-skip
5178 (let ((limit (point)))
5179 (beginning-of-line)
5180 (and (re-search-forward comment-start-skip
5181 limit t)
5182 (eq (point) limit))))))
5183 ;; No good place to break => stop trying.
5184 (setq give-up t)
5185 ;; Ok, we have a useful place to break the line. Do it.
5186 (let ((prev-column (current-column)))
5187 ;; If point is at the fill-point, do not `save-excursion'.
5188 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5189 ;; point will end up before it rather than after it.
5190 (if (save-excursion
5192 (= (point) fill-point))
5193 (default-indent-new-line t)
5194 (save-excursion
5195 (goto-char fill-point)
5196 (default-indent-new-line t)))
5197 ;; Now do justification, if required
5198 (if (not (eq justify 'left))
5199 (save-excursion
5200 (end-of-line 0)
5201 (justify-current-line justify nil t)))
5202 ;; If making the new line didn't reduce the hpos of
5203 ;; the end of the line, then give up now;
5204 ;; trying again will not help.
5205 (if (>= (current-column) prev-column)
5206 (setq give-up t))))))
5207 ;; Justify last line.
5208 (justify-current-line justify t t)
5209 t)))
5211 (defvar comment-line-break-function 'comment-indent-new-line
5212 "*Mode-specific function which line breaks and continues a comment.
5213 This function is called during auto-filling when a comment syntax
5214 is defined.
5215 The function should take a single optional argument, which is a flag
5216 indicating whether it should use soft newlines.")
5218 (defun default-indent-new-line (&optional soft)
5219 "Break line at point and indent.
5220 If a comment syntax is defined, call `comment-indent-new-line'.
5222 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5223 unless optional argument SOFT is non-nil."
5224 (interactive)
5225 (if comment-start
5226 (funcall comment-line-break-function soft)
5227 ;; Insert the newline before removing empty space so that markers
5228 ;; get preserved better.
5230 (save-excursion (forward-char -1) (delete-horizontal-space))
5231 (delete-horizontal-space)
5233 (if (and fill-prefix (not adaptive-fill-mode))
5234 ;; Blindly trust a non-adaptive fill-prefix.
5235 (progn
5236 (indent-to-left-margin)
5237 (insert-before-markers-and-inherit fill-prefix))
5239 (cond
5240 ;; If there's an adaptive prefix, use it unless we're inside
5241 ;; a comment and the prefix is not a comment starter.
5242 (fill-prefix
5243 (indent-to-left-margin)
5244 (insert-and-inherit fill-prefix))
5245 ;; If we're not inside a comment, just try to indent.
5246 (t (indent-according-to-mode))))))
5248 (defvar normal-auto-fill-function 'do-auto-fill
5249 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5250 Some major modes set this.")
5252 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5253 ;; `functions' and `hooks' are usually unsafe to set, but setting
5254 ;; auto-fill-function to nil in a file-local setting is safe and
5255 ;; can be useful to prevent auto-filling.
5256 (put 'auto-fill-function 'safe-local-variable 'null)
5257 ;; FIXME: turn into a proper minor mode.
5258 ;; Add a global minor mode version of it.
5259 (define-minor-mode auto-fill-mode
5260 "Toggle Auto Fill mode.
5261 With ARG, turn Auto Fill mode on if and only if ARG is positive.
5262 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
5263 automatically breaks the line at a previous space.
5265 The value of `normal-auto-fill-function' specifies the function to use
5266 for `auto-fill-function' when turning Auto Fill mode on."
5267 :variable (eq auto-fill-function normal-auto-fill-function))
5269 ;; This holds a document string used to document auto-fill-mode.
5270 (defun auto-fill-function ()
5271 "Automatically break line at a previous space, in insertion of text."
5272 nil)
5274 (defun turn-on-auto-fill ()
5275 "Unconditionally turn on Auto Fill mode."
5276 (auto-fill-mode 1))
5278 (defun turn-off-auto-fill ()
5279 "Unconditionally turn off Auto Fill mode."
5280 (auto-fill-mode -1))
5282 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5284 (defun set-fill-column (arg)
5285 "Set `fill-column' to specified argument.
5288 (interactive
5289 (list (or current-prefix-arg
5290 ;; We used to use current-column silently, but C-x f is too easily
5291 ;; typed as a typo for C-x C-f, so we turned it into an error and
5292 ;; now an interactive prompt.
5293 (read-number "Set fill-column to: " (current-column)))))
5294 (if (consp arg)
5295 (setq arg (current-column)))
5296 (if (not (integerp arg))
5297 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5298 (error "set-fill-column requires an explicit argument")
5299 (message "Fill column set to %d (was %d)" arg fill-column)
5300 (setq fill-column arg)))
5301 \f
5302 (defun set-selective-display (arg)
5303 "Set `selective-display' to ARG; clear it if no arg.
5304 When the value of `selective-display' is a number > 0,
5305 lines whose indentation is >= that value are not displayed.
5306 The variable `selective-display' has a separate value for each buffer."
5307 (interactive "P")
5308 (if (eq selective-display t)
5309 (error "selective-display already in use for marked lines"))
5310 (let ((current-vpos
5311 (save-restriction
5312 (narrow-to-region (point-min) (point))
5313 (goto-char (window-start))
5314 (vertical-motion (window-height)))))
5315 (setq selective-display
5316 (and arg (prefix-numeric-value arg)))
5317 (recenter current-vpos))
5318 (set-window-start (selected-window) (window-start (selected-window)))
5319 (princ "selective-display set to " t)
5320 (prin1 selective-display t)
5321 (princ "." t))
5323 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5325 (defun toggle-truncate-lines (&optional arg)
5326 "Toggle whether to fold or truncate long lines for the current buffer.
5327 With prefix argument ARG, truncate long lines if ARG is positive,
5328 otherwise don't truncate them. Note that in side-by-side windows,
5329 this command has no effect if `truncate-partial-width-windows'
5330 is non-nil."
5331 (interactive "P")
5332 (setq truncate-lines
5333 (if (null arg)
5334 (not truncate-lines)
5335 (> (prefix-numeric-value arg) 0)))
5336 (force-mode-line-update)
5337 (unless truncate-lines
5338 (let ((buffer (current-buffer)))
5339 (walk-windows (lambda (window)
5340 (if (eq buffer (window-buffer window))
5341 (set-window-hscroll window 0)))
5342 nil t)))
5343 (message "Truncate long lines %s"
5344 (if truncate-lines "enabled" "disabled")))
5346 (defun toggle-word-wrap (&optional arg)
5347 "Toggle whether to use word-wrapping for continuation lines.
5348 With prefix argument ARG, wrap continuation lines at word boundaries
5349 if ARG is positive, otherwise wrap them at the right screen edge.
5350 This command toggles the value of `word-wrap'. It has no effect
5351 if long lines are truncated."
5352 (interactive "P")
5353 (setq word-wrap
5354 (if (null arg)
5355 (not word-wrap)
5356 (> (prefix-numeric-value arg) 0)))
5357 (force-mode-line-update)
5358 (message "Word wrapping %s"
5359 (if word-wrap "enabled" "disabled")))
5361 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5362 "The string displayed in the mode line when in overwrite mode.")
5363 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5364 "The string displayed in the mode line when in binary overwrite mode.")
5366 (define-minor-mode overwrite-mode
5367 "Toggle overwrite mode.
5368 With prefix argument ARG, turn overwrite mode on if ARG is positive,
5369 otherwise turn it off. In overwrite mode, printing characters typed
5370 in replace existing text on a one-for-one basis, rather than pushing
5371 it to the right. At the end of a line, such characters extend the line.
5372 Before a tab, such characters insert until the tab is filled in.
5374 is supposed to make it easier to insert characters when necessary."
5375 :variable (eq overwrite-mode 'overwrite-mode-textual))
5377 (define-minor-mode binary-overwrite-mode
5378 "Toggle binary overwrite mode.
5379 With prefix argument ARG, turn binary overwrite mode on if ARG is
5380 positive, otherwise turn it off. In binary overwrite mode, printing
5381 characters typed in replace existing text. Newlines are not treated
5382 specially, so typing at the end of a line joins the line to the next,
5383 with the typed character between them. Typing before a tab character
5385 replaces the text at the cursor, just as ordinary typing characters do.
5387 Note that binary overwrite mode is not its own minor mode; it is a
5388 specialization of overwrite mode, entered by setting the
5389 `overwrite-mode' variable to `overwrite-mode-binary'."
5390 :variable (eq overwrite-mode 'overwrite-mode-binary))
5392 (define-minor-mode line-number-mode
5393 "Toggle Line Number mode.
5394 With ARG, turn Line Number mode on if ARG is positive, otherwise
5395 turn it off. When Line Number mode is enabled, the line number
5396 appears in the mode line.
5398 Line numbers do not appear for very large buffers and buffers
5399 with very long lines; see variables `line-number-display-limit'
5400 and `line-number-display-limit-width'."
5401 :init-value t :global t :group 'mode-line)
5403 (define-minor-mode column-number-mode
5404 "Toggle Column Number mode.
5405 With ARG, turn Column Number mode on if ARG is positive,
5406 otherwise turn it off. When Column Number mode is enabled, the
5407 column number appears in the mode line."
5408 :global t :group 'mode-line)
5410 (define-minor-mode size-indication-mode
5411 "Toggle Size Indication mode.
5412 With ARG, turn Size Indication mode on if ARG is positive,
5413 otherwise turn it off. When Size Indication mode is enabled, the
5414 size of the accessible part of the buffer appears in the mode line."
5415 :global t :group 'mode-line)
5417 (define-minor-mode auto-save-mode
5418 "Toggle auto-saving of contents of current buffer.
5419 With prefix argument ARG, turn auto-saving on if positive, else off."
5420 :variable ((and buffer-auto-save-file-name
5421 ;; If auto-save is off because buffer has shrunk,
5422 ;; then toggling should turn it on.
5423 (>= buffer-saved-size 0))
5424 . (lambda (val)
5425 (setq buffer-auto-save-file-name
5426 (cond
5427 ((null val) nil)
5428 ((and buffer-file-name auto-save-visited-file-name
5429 (not buffer-read-only))
5430 buffer-file-name)
5431 (t (make-auto-save-file-name))))))
5432 ;; If -1 was stored here, to temporarily turn off saving,
5433 ;; turn it back on.
5434 (and (< buffer-saved-size 0)
5435 (setq buffer-saved-size 0)))
5436 \f
5437 (defgroup paren-blinking nil
5438 "Blinking matching of parens and expressions."
5439 :prefix "blink-matching-"
5440 :group 'paren-matching)
5442 (defcustom blink-matching-paren t
5443 "Non-nil means show matching open-paren when close-paren is inserted."
5444 :type 'boolean
5445 :group 'paren-blinking)
5447 (defcustom blink-matching-paren-on-screen t
5448 "Non-nil means show matching open-paren when it is on screen.
5449 If nil, don't show it (but the open-paren can still be shown
5450 when it is off screen).
5452 This variable has no effect if `blink-matching-paren' is nil.
5453 \(In that case, the open-paren is never shown.)
5454 It is also ignored if `show-paren-mode' is enabled."
5455 :type 'boolean
5456 :group 'paren-blinking)
5458 (defcustom blink-matching-paren-distance (* 100 1024)
5459 "If non-nil, maximum distance to search backwards for matching open-paren.
5460 If nil, search stops at the beginning of the accessible portion of the buffer."
5461 :version "23.2" ; 25->100k
5462 :type '(choice (const nil) integer)
5463 :group 'paren-blinking)
5465 (defcustom blink-matching-delay 1
5466 "Time in seconds to delay after showing a matching paren."
5467 :type 'number
5468 :group 'paren-blinking)
5470 (defcustom blink-matching-paren-dont-ignore-comments nil
5471 "If nil, `blink-matching-paren' ignores comments.
5472 More precisely, when looking for the matching parenthesis,
5473 it skips the contents of comments that end before point."
5474 :type 'boolean
5475 :group 'paren-blinking)
5477 (defun blink-matching-check-mismatch (start end)
5478 "Return whether or not START...END are matching parens.
5479 END is the current point and START is the blink position.
5480 START might be nil if no matching starter was found.
5481 Returns non-nil if we find there is a mismatch."
5482 (let* ((end-syntax (syntax-after (1- end)))
5483 (matching-paren (and (consp end-syntax)
5484 (eq (syntax-class end-syntax) 5)
5485 (cdr end-syntax))))
5486 ;; For self-matched chars like " and $, we can't know when they're
5487 ;; mismatched or unmatched, so we can only do it for parens.
5488 (when matching-paren
5489 (not (and start
5490 (or
5491 (eq (char-after start) matching-paren)
5492 ;; The cdr might hold a new paren-class info rather than
5493 ;; a matching-char info, in which case the two CDRs
5494 ;; should match.
5495 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5497 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5498 "Function to check parentheses mismatches.
5499 The function takes two arguments (START and END) where START is the
5500 position just before the opening token and END is the position right after.
5501 START can be nil, if it was not found.
5502 The function should return non-nil if the two tokens do not match.")
5504 (defun blink-matching-open ()
5505 "Move cursor momentarily to the beginning of the sexp before point."
5506 (interactive)
5507 (when (and (not (bobp))
5508 blink-matching-paren)
5509 (let* ((oldpos (point))
5510 (message-log-max nil) ; Don't log messages about paren matching.
5511 (blinkpos
5512 (save-excursion
5513 (save-restriction
5514 (if blink-matching-paren-distance
5515 (narrow-to-region
5516 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5517 (- (point) blink-matching-paren-distance))
5518 oldpos))
5519 (let ((parse-sexp-ignore-comments
5520 (and parse-sexp-ignore-comments
5521 (not blink-matching-paren-dont-ignore-comments))))
5522 (condition-case ()
5523 (progn
5524 (forward-sexp -1)
5525 ;; backward-sexp skips backward over prefix chars,
5526 ;; so move back to the matching paren.
5527 (while (and (< (point) (1- oldpos))
5528 (let ((code (car (syntax-after (point)))))
5529 (or (eq (logand 65536 code) 6)
5530 (eq (logand 1048576 code) 1048576))))
5531 (forward-char 1))
5532 (point))
5533 (error nil))))))
5534 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5535 (cond
5536 (mismatch
5537 (if blinkpos
5538 (if (minibufferp)
5539 (minibuffer-message " [Mismatched parentheses]")
5540 (message "Mismatched parentheses"))
5541 (if (minibufferp)
5542 (minibuffer-message " [Unmatched parenthesis]")
5543 (message "Unmatched parenthesis"))))
5544 ((not blinkpos) nil)
5545 ((pos-visible-in-window-p blinkpos)
5546 ;; Matching open within window, temporarily move to blinkpos but only
5547 ;; if `blink-matching-paren-on-screen' is non-nil.
5548 (and blink-matching-paren-on-screen
5549 (not show-paren-mode)
5550 (save-excursion
5551 (goto-char blinkpos)
5552 (sit-for blink-matching-delay))))
5553 (t
5554 (save-excursion
5555 (goto-char blinkpos)
5556 (let ((open-paren-line-string
5557 ;; Show what precedes the open in its line, if anything.
5558 (cond
5560 (buffer-substring (line-beginning-position)
5561 (1+ blinkpos)))
5562 ;; Show what follows the open in its line, if anything.
5563 ((save-excursion
5564 (forward-char 1)
5566 (not (eolp)))
5567 (buffer-substring blinkpos
5568 (line-end-position)))
5569 ;; Otherwise show the previous nonblank line,
5570 ;; if there is one.
5572 (concat
5573 (buffer-substring (progn
5575 (line-beginning-position))
5576 (progn (end-of-line)
5578 (point)))
5579 ;; Replace the newline and other whitespace with `...'.
5580 "..."
5581 (buffer-substring blinkpos (1+ blinkpos))))
5582 ;; There is nothing to show except the char itself.
5583 (t (buffer-substring blinkpos (1+ blinkpos))))))
5584 (message "Matches %s"
5585 (substring-no-properties open-paren-line-string)))))))))
5587 (defvar blink-paren-function 'blink-matching-open
5588 "Function called, if non-nil, whenever a close parenthesis is inserted.
5589 More precisely, a char with closeparen syntax is self-inserted.")
5591 (defun blink-paren-post-self-insert-function ()
5592 (when (and (eq (char-before) last-command-event) ; Sanity check.
5593 (memq (char-syntax last-command-event) '(?\) ?\$))
5594 blink-paren-function
5595 (not executing-kbd-macro)
5596 (not noninteractive)
5597 ;; Verify an even number of quoting characters precede the close.
5598 (= 1 (logand 1 (- (point)
5599 (save-excursion
5600 (forward-char -1)
5602 (point))))))
5603 (funcall blink-paren-function)))
5605 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5606 ;; Most likely, this hook is nil, so this arg doesn't matter,
5607 ;; but I use it as a reminder that this function usually
5608 ;; likes to be run after others since it does `sit-for'.
5609 'append)
5610 \f
5611 ;; This executes C-g typed while Emacs is waiting for a command.
5612 ;; Quitting out of a program does not go through here;
5613 ;; that happens in the QUIT macro at the C code level.
5614 (defun keyboard-quit ()
5615 "Signal a `quit' condition.
5616 During execution of Lisp code, this character causes a quit directly.
5617 At top-level, as an editor command, this simply beeps."
5618 (interactive)
5619 ;; Avoid adding the region to the window selection.
5620 (setq saved-region-selection nil)
5621 (let (select-active-regions)
5622 (deactivate-mark))
5623 (if (fboundp 'kmacro-keyboard-quit)
5624 (kmacro-keyboard-quit))
5625 (setq defining-kbd-macro nil)
5626 (signal 'quit nil))
5628 (defvar buffer-quit-function nil
5631 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5633 (defun keyboard-escape-quit ()
5635 This command can exit an interactive command such as `query-replace',
5636 can clear out a prefix argument or a region,
5637 can get out of the minibuffer or other recursive edit,
5638 cancel the use of the current buffer (for special-purpose buffers),
5639 or go back to just one window (by deleting all but the selected window)."
5640 (interactive)
5641 (cond ((eq last-command 'mode-exited) nil)
5642 ((region-active-p)
5643 (deactivate-mark))
5644 ((> (minibuffer-depth) 0)
5645 (abort-recursive-edit))
5646 (current-prefix-arg
5647 nil)
5648 ((> (recursion-depth) 0)
5649 (exit-recursive-edit))
5650 (buffer-quit-function
5651 (funcall buffer-quit-function))
5652 ((not (one-window-p t))
5653 (delete-other-windows))
5655 (bury-buffer))))
5657 (defun play-sound-file (file &optional volume device)
5658 "Play sound stored in FILE.
5659 VOLUME and DEVICE correspond to the keywords of the sound
5660 specification for `play-sound'."
5661 (interactive "fPlay sound file: ")
5662 (let ((sound (list :file file)))
5663 (if volume
5664 (plist-put sound :volume volume))
5665 (if device
5666 (plist-put sound :device device))
5667 (push 'sound sound)
5668 (play-sound sound)))
5670 \f
5671 (defcustom read-mail-command 'rmail
5672 "Your preference for a mail reading package.
5673 This is used by some keybindings which support reading mail.
5674 See also `mail-user-agent' concerning sending mail."
5677 (function-item :tag "Emacs interface to MH"
5679 (function :tag "Other"))
5680 :version "21.1"
5681 :group 'mail)
5683 (defcustom mail-user-agent 'message-user-agent
5684 "Your preference for a mail composition package.
5685 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5686 outgoing email message. This variable lets you specify which
5687 mail-sending package you prefer.
5689 Valid values include:
5691 `message-user-agent' -- use the Message package.
5692 See Info node `(message)'.
5693 `sendmail-user-agent' -- use the Mail package.
5694 See Info node `(emacs)Sending Mail'.
5695 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5696 See Info node `(mh-e)'.
5697 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5698 paraphernalia, particularly the Gcc: header for
5699 archiving.
5701 Additional valid symbols may be available; check with the author of
5702 your package for details. The function should return non-nil if it
5703 succeeds.
5705 See also `read-mail-command' concerning reading mail."
5706 :type '(radio (function-item :tag "Message package"
5708 message-user-agent)
5709 (function-item :tag "Mail package"
5711 sendmail-user-agent)
5712 (function-item :tag "Emacs interface to MH"
5714 mh-e-user-agent)
5715 (function-item :tag "Message with full Gnus features"
5717 gnus-user-agent)
5718 (function :tag "Other"))
5719 :version "23.2" ; sendmail->message
5720 :group 'mail)
5722 (defcustom compose-mail-user-agent-warnings t
5723 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5724 If the value of `mail-user-agent' is the default, and the user
5725 appears to have customizations applying to the old default,
5726 `compose-mail' issues a warning."
5727 :type 'boolean
5728 :version "23.2"
5729 :group 'mail)
5731 (define-mail-user-agent 'sendmail-user-agent
5732 'sendmail-user-agent-compose
5733 'mail-send-and-exit)
5735 (defun rfc822-goto-eoh ()
5736 ;; Go to header delimiter line in a mail message, following RFC822 rules
5737 (goto-char (point-min))
5738 (when (re-search-forward
5740 (goto-char (match-beginning 0))))
5742 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
5743 switch-function yank-action
5744 send-actions)
5745 (if switch-function
5746 (let ((special-display-buffer-names nil)
5747 (special-display-regexps nil)
5748 (same-window-buffer-names nil)
5749 (same-window-regexps nil))
5750 (funcall switch-function "*mail*")))
5751 (let ((cc (cdr (assoc-string "cc" other-headers t)))
5752 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
5753 (body (cdr (assoc-string "body" other-headers t))))
5754 (or (mail continue to subject in-reply-to cc yank-action send-actions)
5755 continue
5756 (error "Message aborted"))
5757 (save-excursion
5758 (rfc822-goto-eoh)
5759 (while other-headers
5760 (unless (member-ignore-case (car (car other-headers))
5761 '("in-reply-to" "cc" "body"))
5762 (insert (car (car other-headers)) ": "
5763 (cdr (car other-headers))
5765 (setq other-headers (cdr other-headers)))
5766 (when body
5767 (forward-line 1)
5768 (insert body))
5769 t)))
5771 (defun compose-mail (&optional to subject other-headers continue
5772 switch-function yank-action send-actions)
5773 "Start composing a mail message to send.
5774 This uses the user's chosen mail composition package
5775 as selected with the variable `mail-user-agent'.
5776 The optional arguments TO and SUBJECT specify recipients
5777 and the initial Subject field, respectively.
5779 OTHER-HEADERS is an alist specifying additional
5780 header fields. Elements look like (HEADER . VALUE) where both
5781 HEADER and VALUE are strings.
5783 CONTINUE, if non-nil, says to continue editing a message already
5784 being composed. Interactively, CONTINUE is the prefix argument.
5786 SWITCH-FUNCTION, if non-nil, is a function to use to
5787 switch to and display the buffer used for mail composition.
5789 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5790 to insert the raw text of the message being replied to.
5791 It has the form (FUNCTION . ARGS). The user agent will apply
5792 FUNCTION to ARGS, to insert the raw text of the original message.
5793 \(The user agent will also run `mail-citation-hook', *after* the
5794 original text has been inserted in this way.)
5796 SEND-ACTIONS is a list of actions to call when the message is sent.
5797 Each action has the form (FUNCTION . ARGS)."
5798 (interactive
5799 (list nil nil nil current-prefix-arg))
5801 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5802 ;; from sendmail-user-agent to message-user-agent. Some users may
5803 ;; encounter incompatibilities. This hack tries to detect problems
5804 ;; and warn about them.
5805 (and compose-mail-user-agent-warnings
5806 (eq mail-user-agent 'message-user-agent)
5807 (let (warn-vars)
5808 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5809 mail-yank-hooks mail-archive-file-name
5810 mail-default-reply-to mail-mailing-lists
5811 mail-self-blind))
5812 (and (boundp var)
5813 (symbol-value var)
5814 (push var warn-vars)))
5815 (when warn-vars
5816 (display-warning 'mail
5817 (format "\
5818 The default mail mode is now Message mode.
5819 You have the following Mail mode variable%s customized:
5821 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5822 (if (> (length warn-vars) 1) "s" "")
5823 (mapconcat 'symbol-name
5824 warn-vars " "))))))
5826 (let ((function (get mail-user-agent 'composefunc)))
5827 (funcall function to subject other-headers continue
5828 switch-function yank-action send-actions)))
5830 (defun compose-mail-other-window (&optional to subject other-headers continue
5831 yank-action send-actions)
5833 (interactive
5834 (list nil nil nil current-prefix-arg))
5835 (compose-mail to subject other-headers continue
5836 'switch-to-buffer-other-window yank-action send-actions))
5839 (defun compose-mail-other-frame (&optional to subject other-headers continue
5840 yank-action send-actions)
5842 (interactive
5843 (list nil nil nil current-prefix-arg))
5844 (compose-mail to subject other-headers continue
5845 'switch-to-buffer-other-frame yank-action send-actions))
5846 \f
5847 (defvar set-variable-value-history nil
5848 "History of values entered with `set-variable'.
5850 Maximum length of the history list is determined by the value
5851 of `history-length', which see.")
5853 (defun set-variable (variable value &optional make-local)
5854 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5855 VARIABLE should be a user option variable name, a Lisp variable
5856 meant to be customized by users. You should enter VALUE in Lisp syntax,
5857 so if you want VALUE to be a string, you must surround it with doublequotes.
5858 VALUE is used literally, not evaluated.
5860 If VARIABLE has a `variable-interactive' property, that is used as if
5861 it were the arg to `interactive' (which see) to interactively read VALUE.
5863 If VARIABLE has been defined with `defcustom', then the type information
5864 in the definition is used to check that VALUE is valid.
5866 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5867 (interactive
5868 (let* ((default-var (variable-at-point))
5869 (var (if (user-variable-p default-var)
5870 (read-variable (format "Set variable (default %s): " default-var)
5871 default-var)
5872 (read-variable "Set variable: ")))
5873 (minibuffer-help-form '(describe-variable var))
5874 (prop (get var 'variable-interactive))
5875 (obsolete (car (get var 'byte-obsolete-variable)))
5876 (prompt (format "Set %s %s to value: " var
5877 (cond ((local-variable-p var)
5878 "(buffer-local)")
5879 ((or current-prefix-arg
5880 (local-variable-if-set-p var))
5881 "buffer-locally")
5882 (t "globally"))))
5883 (val (progn
5884 (when obsolete
5885 (message (concat "`%S' is obsolete; "
5886 (if (symbolp obsolete) "use `%S' instead" "%s"))
5887 var obsolete)
5888 (sit-for 3))
5889 (if prop
5890 ;; Use VAR's `variable-interactive' property
5891 ;; as an interactive spec for prompting.
5892 (call-interactively `(lambda (arg)
5893 (interactive ,prop)
5894 arg))
5895 (read
5896 (read-string prompt nil
5897 'set-variable-value-history
5898 (format "%S" (symbol-value var))))))))
5899 (list var val current-prefix-arg)))
5901 (and (custom-variable-p variable)
5902 (not (get variable 'custom-type))
5903 (custom-load-symbol variable))
5904 (let ((type (get variable 'custom-type)))
5905 (when type
5906 ;; Match with custom type.
5907 (require 'cus-edit)
5908 (setq type (widget-convert type))
5909 (unless (widget-apply type :match value)
5910 (error "Value `%S' does not match type %S of %S"
5911 value (car type) variable))))
5913 (if make-local
5914 (make-local-variable variable))
5916 (set variable value)
5918 ;; Force a thorough redisplay for the case that the variable
5919 ;; has an effect on the display, like `tab-width' has.
5920 (force-mode-line-update))
5921 \f
5922 ;; Define the major mode for lists of completions.
5924 (defvar completion-list-mode-map
5925 (let ((map (make-sparse-keymap)))
5926 (define-key map [mouse-2] 'mouse-choose-completion)
5927 (define-key map [follow-link] 'mouse-face)
5928 (define-key map [down-mouse-2] nil)
5929 (define-key map "\C-m" 'choose-completion)
5930 (define-key map "\e\e\e" 'delete-completion-window)
5931 (define-key map [left] 'previous-completion)
5932 (define-key map [right] 'next-completion)
5933 (define-key map "q" 'quit-window)
5934 map)
5935 "Local map for completion list buffers.")
5937 ;; Completion mode is suitable only for specially formatted data.
5938 (put 'completion-list-mode 'mode-class 'special)
5940 (defvar completion-reference-buffer nil
5941 "Record the buffer that was current when the completion list was requested.
5942 This is a local variable in the completion list buffer.
5943 Initial value is nil to avoid some compiler warnings.")
5945 (defvar completion-no-auto-exit nil
5946 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5947 This also applies to other functions such as `choose-completion'.")
5949 (defvar completion-base-position nil
5950 "Position of the base of the text corresponding to the shown completions.
5951 This variable is used in the *Completions* buffers.
5952 Its value is a list of the form (START END) where START is the place
5953 where the completion should be inserted and END (if non-nil) is the end
5954 of the text to replace. If END is nil, point is used instead.")
5956 (defvar completion-base-size nil
5957 "Number of chars before point not involved in completion.
5958 This is a local variable in the completion list buffer.
5959 It refers to the chars in the minibuffer if completing in the
5960 minibuffer, or in `completion-reference-buffer' otherwise.
5961 Only characters in the field at point are included.
5963 If nil, Emacs determines which part of the tail end of the
5964 buffer's text is involved in completion by comparing the text
5965 directly.")
5966 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
5968 (defun delete-completion-window ()
5969 "Delete the completion list window.
5970 Go to the window from which completion was requested."
5971 (interactive)
5972 (let ((buf completion-reference-buffer))
5973 (if (one-window-p t)
5974 (if (window-dedicated-p (selected-window))
5975 (delete-frame (selected-frame)))
5976 (delete-window (selected-window))
5977 (if (get-buffer-window buf)
5978 (select-window (get-buffer-window buf))))))
5980 (defun previous-completion (n)
5981 "Move to the previous item in the completion list."
5982 (interactive "p")
5983 (next-completion (- n)))
5985 (defun next-completion (n)
5986 "Move to the next item in the completion list.
5987 With prefix argument N, move N items (negative N means move backward)."
5988 (interactive "p")
5989 (let ((beg (point-min)) (end (point-max)))
5990 (while (and (> n 0) (not (eobp)))
5991 ;; If in a completion, move to the end of it.
5992 (when (get-text-property (point) 'mouse-face)
5993 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5994 ;; Move to start of next one.
5995 (unless (get-text-property (point) 'mouse-face)
5996 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5997 (setq n (1- n)))
5998 (while (and (< n 0) (not (bobp)))
5999 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6000 ;; If in a completion, move to the start of it.
6001 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6002 (goto-char (previous-single-property-change
6003 (point) 'mouse-face nil beg)))
6004 ;; Move to end of the previous completion.
6005 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6006 (goto-char (previous-single-property-change
6007 (point) 'mouse-face nil beg)))
6008 ;; Move to the start of that one.
6009 (goto-char (previous-single-property-change
6010 (point) 'mouse-face nil beg))
6011 (setq n (1+ n))))))
6013 (defun choose-completion (&optional event)
6014 "Choose the completion at point."
6015 (interactive (list last-nonmenu-event))
6016 ;; In case this is run via the mouse, give temporary modes such as
6017 ;; isearch a chance to turn off.
6018 (run-hooks 'mouse-leave-buffer-hook)
6019 (let (buffer base-size base-position choice)
6020 (with-current-buffer (window-buffer (posn-window (event-start event)))
6021 (setq buffer completion-reference-buffer)
6022 (setq base-size completion-base-size)
6023 (setq base-position completion-base-position)
6024 (save-excursion
6025 (goto-char (posn-point (event-start event)))
6026 (let (beg end)
6027 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
6028 (setq end (point) beg (1+ (point))))
6029 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
6030 (setq end (1- (point)) beg (point)))
6031 (if (null beg)
6032 (error "No completion here"))
6033 (setq beg (previous-single-property-change beg 'mouse-face))
6034 (setq end (or (next-single-property-change end 'mouse-face)
6035 (point-max)))
6036 (setq choice (buffer-substring-no-properties beg end)))))
6038 (let ((owindow (selected-window)))
6039 (select-window (posn-window (event-start event)))
6040 (if (and (one-window-p t 'selected-frame)
6041 (window-dedicated-p (selected-window)))
6042 ;; This is a special buffer's frame
6043 (iconify-frame (selected-frame))
6044 (or (window-dedicated-p (selected-window))
6045 (bury-buffer)))
6046 (select-window
6047 (or (and (buffer-live-p buffer)
6048 (get-buffer-window buffer 0))
6049 owindow)))
6051 (choose-completion-string
6052 choice buffer
6053 (or base-position
6054 (when base-size
6055 ;; Someone's using old completion code that doesn't know
6056 ;; about base-position yet.
6057 (list (+ base-size (with-current-buffer buffer (field-beginning)))))
6058 ;; If all else fails, just guess.
6059 (with-current-buffer buffer
6060 (list (choose-completion-guess-base-position choice)))))))
6062 ;; Delete the longest partial match for STRING
6063 ;; that can be found before POINT.
6064 (defun choose-completion-guess-base-position (string)
6065 (save-excursion
6066 (let ((opoint (point))
6067 len)
6068 ;; Try moving back by the length of the string.
6069 (goto-char (max (- (point) (length string))
6070 (minibuffer-prompt-end)))
6071 ;; See how far back we were actually able to move. That is the
6072 ;; upper bound on how much we can match and delete.
6073 (setq len (- opoint (point)))
6074 (if completion-ignore-case
6075 (setq string (downcase string)))
6076 (while (and (> len 0)
6077 (let ((tail (buffer-substring (point) opoint)))
6078 (if completion-ignore-case
6079 (setq tail (downcase tail)))
6080 (not (string= tail (substring string 0 len)))))
6081 (setq len (1- len))
6082 (forward-char 1))
6083 (point))))
6085 (defun choose-completion-delete-max-match (string)
6086 (delete-region (choose-completion-guess-base-position string) (point)))
6087 (make-obsolete 'choose-completion-delete-max-match
6088 'choose-completion-guess-base-position "23.2")
6090 (defvar choose-completion-string-functions nil
6091 "Functions that may override the normal insertion of a completion choice.
6092 These functions are called in order with four arguments:
6093 CHOICE - the string to insert in the buffer,
6094 BUFFER - the buffer in which the choice should be inserted,
6095 MINI-P - non-nil if BUFFER is a minibuffer, and
6096 BASE-SIZE - the number of characters in BUFFER before
6097 the string being completed.
6099 If a function in the list returns non-nil, that function is supposed
6100 to have inserted the CHOICE in the BUFFER, and possibly exited
6101 the minibuffer; no further functions will be called.
6103 If all functions in the list return nil, that means to use
6104 the default method of inserting the completion in BUFFER.")
6106 (defun choose-completion-string (choice &optional buffer base-position)
6107 "Switch to BUFFER and insert the completion choice CHOICE.
6108 BASE-POSITION, says where to insert the completion."
6110 ;; If BUFFER is the minibuffer, exit the minibuffer
6111 ;; unless it is reading a file name and CHOICE is a directory,
6112 ;; or completion-no-auto-exit is non-nil.
6114 ;; Some older code may call us passing `base-size' instead of
6115 ;; `base-position'. It's difficult to make any use of `base-size',
6116 ;; so we just ignore it.
6117 (unless (consp base-position)
6118 (message "Obsolete `base-size' passed to choose-completion-string")
6119 (setq base-position nil))
6121 (let* ((buffer (or buffer completion-reference-buffer))
6122 (mini-p (minibufferp buffer)))
6123 ;; If BUFFER is a minibuffer, barf unless it's the currently
6124 ;; active minibuffer.
6125 (if (and mini-p
6126 (or (not (active-minibuffer-window))
6127 (not (equal buffer
6128 (window-buffer (active-minibuffer-window))))))
6129 (error "Minibuffer is not active for completion")
6130 ;; Set buffer so buffer-local choose-completion-string-functions works.
6131 (set-buffer buffer)
6132 (unless (run-hook-with-args-until-success
6133 'choose-completion-string-functions
6134 ;; The fourth arg used to be `mini-p' but was useless
6135 ;; (since minibufferp can be used on the `buffer' arg)
6136 ;; and indeed unused. The last used to be `base-size', so we
6137 ;; keep it to try and avoid breaking old code.
6138 choice buffer base-position nil)
6139 ;; Insert the completion into the buffer where it was requested.
6140 (delete-region (or (car base-position) (point))
6141 (or (cadr base-position) (point)))
6142 (insert choice)
6143 (remove-text-properties (- (point) (length choice)) (point)
6144 '(mouse-face nil))
6145 ;; Update point in the window that BUFFER is showing in.
6146 (let ((window (get-buffer-window buffer t)))
6147 (set-window-point window (point)))
6148 ;; If completing for the minibuffer, exit it with this choice.
6149 (and (not completion-no-auto-exit)
6150 (minibufferp buffer)
6151 minibuffer-completion-table
6152 ;; If this is reading a file name, and the file name chosen
6153 ;; is a directory, don't exit the minibuffer.
6154 (let* ((result (buffer-substring (field-beginning) (point)))
6155 (bounds
6156 (completion-boundaries result minibuffer-completion-table
6157 minibuffer-completion-predicate
6158 "")))
6159 (if (eq (car bounds) (length result))
6160 ;; The completion chosen leads to a new set of completions
6161 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6162 (let ((mini (active-minibuffer-window)))
6163 (select-window mini)
6164 (when minibuffer-auto-raise
6165 (raise-frame (window-frame mini))))
6166 (exit-minibuffer))))))))
6168 (define-derived-mode completion-list-mode nil "Completion List"
6169 "Major mode for buffers showing lists of possible completions.
6171 to select the completion near point.
6173 with the mouse.
6176 (set (make-local-variable 'completion-base-size) nil))
6178 (defun completion-list-mode-finish ()
6179 "Finish setup of the completions buffer.
6180 Called from `temp-buffer-show-hook'."
6181 (when (eq major-mode 'completion-list-mode)
6182 (toggle-read-only 1)))
6184 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6187 ;; Variables and faces used in `completion-setup-function'.
6189 (defcustom completion-show-help t
6190 "Non-nil means show help message in *Completions* buffer."
6191 :type 'boolean
6192 :version "22.1"
6193 :group 'completion)
6195 ;; This function goes in completion-setup-hook, so that it is called
6196 ;; after the text of the completion list buffer is written.
6197 (defun completion-setup-function ()
6198 (let* ((mainbuf (current-buffer))
6199 (base-dir
6200 ;; When reading a file name in the minibuffer,
6201 ;; try and find the right default-directory to set in the
6202 ;; completion list buffer.
6203 ;; FIXME: Why do we do that, actually? --Stef
6204 (if minibuffer-completing-file-name
6205 (file-name-as-directory
6206 (expand-file-name
6207 (substring (minibuffer-completion-contents)
6208 0 (or completion-base-size 0)))))))
6209 (with-current-buffer standard-output
6210 (let ((base-size completion-base-size) ;Read before killing localvars.
6211 (base-position completion-base-position))
6212 (completion-list-mode)
6213 (set (make-local-variable 'completion-base-size) base-size)
6214 (set (make-local-variable 'completion-base-position) base-position))
6215 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6216 (if base-dir (setq default-directory base-dir))
6217 ;; Maybe insert help string.
6218 (when completion-show-help
6219 (goto-char (point-min))
6220 (if (display-mouse-p)
6221 (insert (substitute-command-keys
6223 (insert (substitute-command-keys
6227 (add-hook 'completion-setup-hook 'completion-setup-function)
6229 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6230 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6232 (defun switch-to-completions ()
6233 "Select the completion list window."
6234 (interactive)
6235 (let ((window (or (get-buffer-window "*Completions*" 0)
6236 ;; Make sure we have a completions window.
6237 (progn (minibuffer-completion-help)
6238 (get-buffer-window "*Completions*" 0)))))
6239 (when window
6240 (select-window window)
6241 ;; In the new buffer, go to the first completion.
6242 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6243 (when (bobp)
6244 (next-completion 1)))))
6245 \f
6246 ;;; Support keyboard commands to turn on various modifiers.
6248 ;; These functions -- which are not commands -- each add one modifier
6249 ;; to the following event.
6251 (defun event-apply-alt-modifier (ignore-prompt)
6254 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6255 (defun event-apply-super-modifier (ignore-prompt)
6258 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6259 (defun event-apply-hyper-modifier (ignore-prompt)
6262 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6263 (defun event-apply-shift-modifier (ignore-prompt)
6266 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6267 (defun event-apply-control-modifier (ignore-prompt)
6270 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6271 (defun event-apply-meta-modifier (ignore-prompt)
6274 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6276 (defun event-apply-modifier (event symbol lshiftby prefix)
6277 "Apply a modifier flag to event EVENT.
6278 SYMBOL is the name of this modifier, as a symbol.
6279 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6280 PREFIX is the string that represents this modifier in an event type symbol."
6281 (if (numberp event)
6282 (cond ((eq symbol 'control)
6283 (if (and (<= (downcase event) ?z)
6284 (>= (downcase event) ?a))
6285 (- (downcase event) ?a -1)
6286 (if (and (<= (downcase event) ?Z)
6287 (>= (downcase event) ?A))
6288 (- (downcase event) ?A -1)
6289 (logior (lsh 1 lshiftby) event))))
6290 ((eq symbol 'shift)
6291 (if (and (<= (downcase event) ?z)
6292 (>= (downcase event) ?a))
6293 (upcase event)
6294 (logior (lsh 1 lshiftby) event)))
6295 (t
6296 (logior (lsh 1 lshiftby) event)))
6297 (if (memq symbol (event-modifiers event))
6298 event
6299 (let ((event-type (if (symbolp event) event (car event))))
6300 (setq event-type (intern (concat prefix (symbol-name event-type))))
6301 (if (symbolp event)
6302 event-type
6303 (cons event-type (cdr event)))))))
6305 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6306 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6307 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6308 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6309 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6310 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6311 \f
6312 ;;;; Keypad support.
6314 ;; Make the keypad keys act like ordinary typing keys. If people add
6315 ;; bindings for the function key symbols, then those bindings will
6316 ;; override these, so this shouldn't interfere with any existing
6317 ;; bindings.
6319 ;; Also tell read-char how to handle these keys.
6320 (mapc
6321 (lambda (keypad-normal)
6322 (let ((keypad (nth 0 keypad-normal))
6323 (normal (nth 1 keypad-normal)))
6324 (put keypad 'ascii-character normal)
6325 (define-key function-key-map (vector keypad) (vector normal))))
6326 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6327 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6328 (kp-space ?\s)
6331 (kp-multiply ?*)
6332 (kp-add ?+)
6333 (kp-separator ?,)
6334 (kp-subtract ?-)
6335 (kp-decimal ?.)
6336 (kp-divide ?/)
6337 (kp-equal ?=)
6338 ;; Do the same for various keys that are represented as symbols under
6339 ;; GUIs but naturally correspond to characters.
6340 (backspace 127)
6341 (delete 127)
6344 (clear ?\C-l)
6345 (return ?\C-m)
6346 (escape ?\e)
6347 ))
6348 \f
6349 ;;;;
6350 ;;;; forking a twin copy of a buffer.
6351 ;;;;
6353 (defvar clone-buffer-hook nil
6354 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6356 (defvar clone-indirect-buffer-hook nil
6357 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6359 (defun clone-process (process &optional newname)
6360 "Create a twin copy of PROCESS.
6361 If NEWNAME is nil, it defaults to PROCESS' name;
6362 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6363 If PROCESS is associated with a buffer, the new process will be associated
6364 with the current buffer instead.
6365 Returns nil if PROCESS has already terminated."
6366 (setq newname (or newname (process-name process)))
6368 (setq newname (substring newname 0 (match-beginning 0))))
6369 (when (memq (process-status process) '(run stop open))
6370 (let* ((process-connection-type (process-tty-name process))
6371 (new-process
6372 (if (memq (process-status process) '(open))
6373 (let ((args (process-contact process t)))
6374 (setq args (plist-put args :name newname))
6375 (setq args (plist-put args :buffer
6376 (if (process-buffer process)
6377 (current-buffer))))
6378 (apply 'make-network-process args))
6379 (apply 'start-process newname
6380 (if (process-buffer process) (current-buffer))
6381 (process-command process)))))
6382 (set-process-query-on-exit-flag
6383 new-process (process-query-on-exit-flag process))
6384 (set-process-inherit-coding-system-flag
6385 new-process (process-inherit-coding-system-flag process))
6386 (set-process-filter new-process (process-filter process))
6387 (set-process-sentinel new-process (process-sentinel process))
6388 (set-process-plist new-process (copy-sequence (process-plist process)))
6389 new-process)))
6391 ;; things to maybe add (currently partly covered by `funcall mode'):
6392 ;; - syntax-table
6393 ;; - overlays
6394 (defun clone-buffer (&optional newname display-flag)
6395 "Create and return a twin copy of the current buffer.
6396 Unlike an indirect buffer, the new buffer can be edited
6397 independently of the old one (if it is not read-only).
6398 NEWNAME is the name of the new buffer. It may be modified by
6399 adding or incrementing <N> at the end as necessary to create a
6400 unique buffer name. If nil, it defaults to the name of the
6401 current buffer, with the proper suffix. If DISPLAY-FLAG is
6402 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6403 clone a file-visiting buffer, or a buffer whose major mode symbol
6404 has a non-nil `no-clone' property, results in an error.
6406 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6407 current buffer with appropriate suffix. However, if a prefix
6408 argument is given, then the command prompts for NEWNAME in the
6409 minibuffer.
6411 This runs the normal hook `clone-buffer-hook' in the new buffer
6412 after it has been set up properly in other respects."
6413 (interactive
6414 (progn
6415 (if buffer-file-name
6416 (error "Cannot clone a file-visiting buffer"))
6417 (if (get major-mode 'no-clone)
6418 (error "Cannot clone a buffer in %s mode" mode-name))
6419 (list (if current-prefix-arg
6420 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6421 t)))
6422 (if buffer-file-name
6423 (error "Cannot clone a file-visiting buffer"))
6424 (if (get major-mode 'no-clone)
6425 (error "Cannot clone a buffer in %s mode" mode-name))
6426 (setq newname (or newname (buffer-name)))
6428 (setq newname (substring newname 0 (match-beginning 0))))
6429 (let ((buf (current-buffer))
6430 (ptmin (point-min))
6431 (ptmax (point-max))
6432 (pt (point))
6433 (mk (if mark-active (mark t)))
6434 (modified (buffer-modified-p))
6435 (mode major-mode)
6436 (lvars (buffer-local-variables))
6437 (process (get-buffer-process (current-buffer)))
6438 (new (generate-new-buffer (or newname (buffer-name)))))
6439 (save-restriction
6440 (widen)
6441 (with-current-buffer new
6442 (insert-buffer-substring buf)))
6443 (with-current-buffer new
6444 (narrow-to-region ptmin ptmax)
6445 (goto-char pt)
6446 (if mk (set-mark mk))
6447 (set-buffer-modified-p modified)
6449 ;; Clone the old buffer's process, if any.
6450 (when process (clone-process process))
6452 ;; Now set up the major mode.
6453 (funcall mode)
6455 ;; Set up other local variables.
6456 (mapc (lambda (v)
6457 (condition-case () ;in case var is read-only
6458 (if (symbolp v)
6459 (makunbound v)
6460 (set (make-local-variable (car v)) (cdr v)))
6461 (error nil)))
6462 lvars)
6464 ;; Run any hooks (typically set up by the major mode
6465 ;; for cloning to work properly).
6466 (run-hooks 'clone-buffer-hook))
6467 (if display-flag
6468 ;; Presumably the current buffer is shown in the selected frame, so
6469 ;; we want to display the clone elsewhere.
6470 (let ((same-window-regexps nil)
6471 (same-window-buffer-names))
6472 (pop-to-buffer new)))
6473 new))
6476 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6477 "Create an indirect buffer that is a twin copy of the current buffer.
6479 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6480 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6481 or if not called with a prefix arg, NEWNAME defaults to the current
6482 buffer's name. The name is modified by adding a `<N>' suffix to it
6483 or by incrementing the N in an existing suffix. Trying to clone a
6484 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6485 property results in an error.
6487 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6488 This is always done when called interactively.
6490 Optional third arg NORECORD non-nil means do not put this buffer at the
6491 front of the list of recently selected ones."
6492 (interactive
6493 (progn
6494 (if (get major-mode 'no-clone-indirect)
6495 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6496 (list (if current-prefix-arg
6497 (read-buffer "Name of indirect buffer: " (current-buffer)))
6498 t)))
6499 (if (get major-mode 'no-clone-indirect)
6500 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6501 (setq newname (or newname (buffer-name)))
6503 (setq newname (substring newname 0 (match-beginning 0))))
6504 (let* ((name (generate-new-buffer-name newname))
6505 (buffer (make-indirect-buffer (current-buffer) name t)))
6506 (with-current-buffer buffer
6507 (run-hooks 'clone-indirect-buffer-hook))
6508 (when display-flag
6509 (pop-to-buffer buffer norecord))
6510 buffer))
6513 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6514 "Like `clone-indirect-buffer' but display in another window."
6515 (interactive
6516 (progn
6517 (if (get major-mode 'no-clone-indirect)
6518 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6519 (list (if current-prefix-arg
6520 (read-buffer "Name of indirect buffer: " (current-buffer)))
6521 t)))
6522 (let ((pop-up-windows t))
6523 (clone-indirect-buffer newname display-flag norecord)))
6525 \f
6526 ;;; Handling of Backspace and Delete keys.
6528 (defcustom normal-erase-is-backspace 'maybe
6529 "Set the default behavior of the Delete and Backspace keys.
6531 If set to t, Delete key deletes forward and Backspace key deletes
6532 backward.
6534 If set to nil, both Delete and Backspace keys delete backward.
6536 If set to 'maybe (which is the default), Emacs automatically
6537 selects a behavior. On window systems, the behavior depends on
6538 the keyboard used. If the keyboard has both a Backspace key and
6539 a Delete key, and both are mapped to their usual meanings, the
6540 option's default value is set to t, so that Backspace can be used
6541 to delete backward, and Delete can be used to delete forward.
6543 If not running under a window system, customizing this option
6544 accomplishes a similar effect by mapping C-h, which is usually
6545 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6546 via `keyboard-translate'. The former functionality of C-h is
6547 available on the F1 key. You should probably not use this
6548 setting if you don't have both Backspace, Delete and F1 keys.
6550 Setting this variable with setq doesn't take effect. Programmatically,
6551 call `normal-erase-is-backspace-mode' (which see) instead."
6552 :type '(choice (const :tag "Off" nil)
6553 (const :tag "Maybe" maybe)
6554 (other :tag "On" t))
6555 :group 'editing-basics
6556 :version "21.1"
6557 :set (lambda (symbol value)
6558 ;; The fboundp is because of a problem with :set when
6559 ;; dumping Emacs. It doesn't really matter.
6560 (if (fboundp 'normal-erase-is-backspace-mode)
6561 (normal-erase-is-backspace-mode (or value 0))
6562 (set-default symbol value))))
6564 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6565 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6566 (unless frame (setq frame (selected-frame)))
6567 (with-selected-frame frame
6568 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6569 (normal-erase-is-backspace-mode
6570 (if (if (eq normal-erase-is-backspace 'maybe)
6571 (and (not noninteractive)
6572 (or (memq system-type '(ms-dos windows-nt))
6573 (memq window-system '(ns))
6574 (and (memq window-system '(x))
6575 (fboundp 'x-backspace-delete-keys-p)
6576 (x-backspace-delete-keys-p))
6577 ;; If the terminal Emacs is running on has erase char
6578 ;; set to ^H, use the Backspace key for deleting
6579 ;; backward, and the Delete key for deleting forward.
6580 (and (null window-system)
6581 (eq tty-erase-char ?\^H))))
6582 normal-erase-is-backspace)
6583 1 0)))))
6585 (define-minor-mode normal-erase-is-backspace-mode
6586 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6588 With numeric ARG, turn the mode on if and only if ARG is positive.
6590 On window systems, when this mode is on, Delete is mapped to C-d
6591 and Backspace is mapped to DEL; when this mode is off, both
6592 Delete and Backspace are mapped to DEL. (The remapping goes via
6593 `local-function-key-map', so binding Delete or Backspace in the
6594 global or local keymap will override that.)
6596 In addition, on window systems, the bindings of C-Delete, M-Delete,
6597 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6598 the global keymap in accordance with the functionality of Delete and
6599 Backspace. For example, if Delete is remapped to C-d, which deletes
6600 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6601 to DEL, which deletes backward, C-Delete is bound to
6602 `backward-kill-word'.
6604 If not running on a window system, a similar effect is accomplished by
6605 remapping C-h (normally produced by the Backspace key) and DEL via
6606 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6607 to C-d; if it's off, the keys are not remapped.
6609 When not running on a window system, and this mode is turned on, the
6610 former functionality of C-h is available on the F1 key. You should
6611 probably not turn on this mode on a text-only terminal if you don't
6612 have both Backspace, Delete and F1 keys.
6614 See also `normal-erase-is-backspace'."
6615 :variable (eq (terminal-parameter
6616 nil 'normal-erase-is-backspace) 1)
6617 (let ((enabled (eq 1 (terminal-parameter
6618 nil 'normal-erase-is-backspace))))
6620 (cond ((or (memq window-system '(x w32 ns pc))
6621 (memq system-type '(ms-dos windows-nt)))
6622 (let* ((bindings
6623 `(([M-delete] [M-backspace])
6624 ([C-M-delete] [C-M-backspace])
6625 ([?\e C-delete] [?\e C-backspace])))
6626 (old-state (lookup-key local-function-key-map [delete])))
6628 (if enabled
6629 (progn
6630 (define-key local-function-key-map [delete] [?\C-d])
6631 (define-key local-function-key-map [kp-delete] [?\C-d])
6632 (define-key local-function-key-map [backspace] [?\C-?])
6633 (dolist (b bindings)
6634 ;; Not sure if input-decode-map is really right, but
6635 ;; keyboard-translate-table (used below) only works
6636 ;; for integer events, and key-translation-table is
6637 ;; global (like the global-map, used earlier).
6638 (define-key input-decode-map (car b) nil)
6639 (define-key input-decode-map (cadr b) nil)))
6640 (define-key local-function-key-map [delete] [?\C-?])
6641 (define-key local-function-key-map [kp-delete] [?\C-?])
6642 (define-key local-function-key-map [backspace] [?\C-?])
6643 (dolist (b bindings)
6644 (define-key input-decode-map (car b) (cadr b))
6645 (define-key input-decode-map (cadr b) (car b))))))
6646 (t
6647 (if enabled
6648 (progn
6649 (keyboard-translate ?\C-h ?\C-?)
6650 (keyboard-translate ?\C-? ?\C-d))
6651 (keyboard-translate ?\C-h ?\C-h)
6652 (keyboard-translate ?\C-? ?\C-?))))
6654 (if (called-interactively-p 'interactive)
6655 (message "Delete key deletes %s"
6656 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6657 "forward" "backward")))))
6658 \f
6659 (defvar vis-mode-saved-buffer-invisibility-spec nil
6660 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6662 (define-minor-mode visible-mode
6663 "Toggle Visible mode.
6664 With argument ARG turn Visible mode on if ARG is positive, otherwise
6665 turn it off.
6667 Enabling Visible mode makes all invisible text temporarily visible.
6668 Disabling Visible mode turns off that effect. Visible mode works by
6669 saving the value of `buffer-invisibility-spec' and setting it to nil."
6670 :lighter " Vis"
6671 :group 'editing-basics
6672 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6673 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6674 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6675 (when visible-mode
6676 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6677 buffer-invisibility-spec)
6678 (setq buffer-invisibility-spec nil)))
6679 \f
6680 ;; Partial application of functions (similar to "currying").
6681 ;; This function is here rather than in subr.el because it uses CL.
6682 (defun apply-partially (fun &rest args)
6683 "Return a function that is a partial application of FUN to ARGS.
6684 ARGS is a list of the first N arguments to pass to FUN.
6685 The result is a new function which does the same as FUN, except that
6686 the first N arguments are fixed at the values with which this function
6687 was called."
6688 (lexical-let ((fun fun) (args1 args))
6689 (lambda (&rest args2) (apply fun (append args1 args2)))))
6690 \f
6691 ;; Minibuffer prompt stuff.
6693 ;(defun minibuffer-prompt-modification (start end)
6694 ; (error "You cannot modify the prompt"))
6695 ;
6696 ;
6697 ;(defun minibuffer-prompt-insertion (start end)
6698 ; (let ((inhibit-modification-hooks t))
6699 ; (delete-region start end)
6700 ; ;; Discard undo information for the text insertion itself
6701 ; ;; and for the text deletion.above.
6702 ; (when (consp buffer-undo-list)
6703 ; (setq buffer-undo-list (cddr buffer-undo-list)))
6704 ; (message "You cannot modify the prompt")))
6705 ;
6706 ;
6707 ;(setq minibuffer-prompt-properties
6708 ; (list 'modification-hooks '(minibuffer-prompt-modification)
6709 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6710 ;
6712 \f
6713 ;;;; Problematic external packages.
6715 ;; rms says this should be done by specifying symbols that define
6716 ;; versions together with bad values. This is therefore not as
6717 ;; flexible as it could be. See the thread:
6718 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6719 (defconst bad-packages-alist
6720 ;; Not sure exactly which semantic versions have problems.
6721 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6723 "The version of `semantic' loaded does not work in Emacs 22.
6724 It can cause constant high CPU load.
6725 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6726 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6727 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6728 ;; provided the `CUA-mode' feature. Since this is no longer true,
6729 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6730 (CUA-mode t nil
6731 "CUA-mode is now part of the standard GNU Emacs distribution,
6732 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6734 You have loaded an older version of CUA-mode which does not work
6735 correctly with this version of Emacs. You should remove the old
6736 version and use the one distributed with Emacs."))
6737 "Alist of packages known to cause problems in this version of Emacs.
6738 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6739 PACKAGE is either a regular expression to match file names, or a
6740 symbol (a feature name); see the documentation of
6741 `after-load-alist', to which this variable adds functions.
6742 SYMBOL is either the name of a string variable, or `t'. Upon
6743 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6744 warning using STRING as the message.")
6746 (defun bad-package-check (package)
6747 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6748 (condition-case nil
6749 (let* ((list (assoc package bad-packages-alist))
6750 (symbol (nth 1 list)))
6751 (and list
6752 (boundp symbol)
6753 (or (eq symbol t)
6754 (and (stringp (setq symbol (eval symbol)))
6755 (string-match-p (nth 2 list) symbol)))
6756 (display-warning package (nth 3 list) :warning)))
6757 (error nil)))
6759 (mapc (lambda (elem)
6760 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6761 bad-packages-alist)
6764 (provide 'simple)
6766 ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
6767 ;;; simple.el ends here