| blob | a2dda5f04d204abb993672e3500d0c5284a73732 |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985-1987, 1993-2011 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
31 ;; This is for lexical-let in apply-partially.
40 "Idle time delay before updating various things on the screen.
41 Various Emacs features that update auxiliary information when point moves
42 wait this many seconds after Emacs becomes idle before doing an update."
48 "Killing and yanking commands."
52 "Highlight (un)matching of parens and expressions."
56 "Search LIST for a valid buffer to display in FRAME.
57 Return nil when all buffers in LIST are undesirable for display,
58 otherwise return the first suitable buffer in LIST.
60 Buffers not visible in windows are preferred to visible buffers,
61 unless VISIBLE-OK is non-nil.
62 If the optional argument FRAME is nil, it defaults to the selected frame.
63 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
64 ;; This logic is more or less copied from other-buffer.
67 found buf)
80 "Return the last buffer in FRAME's buffer list.
81 If BUFFER is the last buffer, return the preceding buffer instead.
82 Buffers not visible in windows are preferred to visible buffers,
83 unless optional argument VISIBLE-OK is non-nil.
84 Optional third argument FRAME nil or omitted means use the
85 selected frame's buffer list.
86 If no such buffer exists, return the buffer `*scratch*', creating
87 it if necessary."
90 buffer visible-ok frame)
94 scratch)))
97 "Switch to the next buffer in cyclic order."
104 "Switch to the previous buffer in cyclic order."
108 \f
109 ;;; next-error support framework
112 "`next-error' support framework."
118 "Face used to highlight next error locus."
123 "Highlighting of locations in selected source buffers.
124 If a number, highlight the locus in `next-error' face for the given time
125 in seconds, or until the next command is executed.
126 If t, highlight the locus until the next command is executed, or until
127 some other locus replaces it.
128 If nil, don't highlight the locus in the source buffer.
129 If `fringe-arrow', indicate the locus by the fringe arrow."
138 "Highlighting of locations in `next-error-no-select'.
139 If number, highlight the locus in `next-error' face for given time in seconds.
140 If t, highlight the locus indefinitely until some other locus replaces it.
141 If nil, don't highlight the locus in the source buffer.
142 If `fringe-arrow', indicate the locus by the fringe arrow."
151 "Display the line in the visited source file recentered as specified.
152 If non-nil, the value is passed directly to `recenter'."
160 "List of hook functions run by `next-error' after visiting source file."
171 "The most recent `next-error' buffer.
172 A buffer becomes most recent when its compilation, grep, or
177 "Function to use to find the next error in the current buffer.
178 The function is called with 2 parameters:
179 ARG is an integer specifying by how many errors to move.
180 RESET is a boolean which, if non-nil, says to go back to the beginning
181 of the errors before moving.
182 Major modes providing compile-like functionality should set this variable
183 to indicate to `next-error' that this is a candidate buffer and how
188 "Function to use to move to an error locus.
189 It takes two arguments, a buffer position in the error buffer
190 and a buffer position in the error locus buffer.
191 The buffer for the error locus should already be current.
196 &optional avoid-current
197 extra-test-inclusive
198 extra-test-exclusive)
199 "Test if BUFFER is a `next-error' capable buffer.
201 If AVOID-CURRENT is non-nil, treat the current buffer
202 as an absolute last resort only.
204 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
205 that normally would not qualify. If it returns t, the buffer
206 in question is treated as usable.
208 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
209 that would normally be considered usable. If it returns nil,
210 that buffer is rejected."
215 ;; Optionally reject some buffers.
218 t)
219 ;; Optionally accept some other buffers.
224 extra-test-inclusive
225 extra-test-exclusive)
226 "Return a `next-error' capable buffer.
228 If AVOID-CURRENT is non-nil, treat the current buffer
229 as an absolute last resort only.
231 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
232 that normally would not qualify. If it returns t, the buffer
233 in question is treated as usable.
235 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
236 that would normally be considered usable. If it returns nil,
237 that buffer is rejected."
239 ;; 1. If one window on the selected frame displays such buffer, return it.
245 avoid-current
246 extra-test-inclusive extra-test-exclusive)
251 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
254 extra-test-inclusive extra-test-exclusive))
255 next-error-last-buffer)
256 ;; 3. If the current buffer is acceptable, choose it.
258 extra-test-inclusive extra-test-exclusive)
260 ;; 4. Look for any acceptable buffer.
265 extra-test-inclusive extra-test-exclusive)))
268 ;; 5. Use the current buffer as a last resort if it qualifies,
269 ;; even despite AVOID-CURRENT.
272 extra-test-inclusive extra-test-exclusive)
276 ;; 6. Give up.
280 "Visit next `next-error' message and corresponding source code.
282 If all the error messages parsed so far have been processed already,
283 the message buffer is checked for new ones.
285 A prefix ARG specifies how many error messages to move;
286 negative means move back to previous error messages.
288 and start at the first error.
290 The RESET argument specifies that we should restart from the beginning.
293 compilation, grep, or occur buffer. It can also operate on any
295 more generally, on any buffer in Compilation mode or with
296 Compilation Minor mode enabled, or any buffer in which
297 `next-error-function' is bound to an appropriate function.
298 To specify use of a particular buffer for error messages, type
300 in the current frame.
303 runs `next-error-hook' with `run-hooks', and stays with that buffer
304 until you use it in some other buffer which uses Compilation mode
305 or Compilation Minor mode.
307 To control which errors are matched, customize the variable
308 `compilation-error-regexp-alist'."
312 ;; we know here that next-error-function is a valid symbol we can funcall
320 "Visit the source code corresponding to the `next-error' message at point."
322 ;; we know here that next-error-function is a valid symbol we can funcall
333 "Visit previous `next-error' message and corresponding source code.
335 Prefix arg N says how many error messages to move backwards (or
336 forwards, if negative).
343 "Restart at the first error.
344 Visit corresponding source code.
345 With prefix arg N, visit the source code of the Nth error.
351 "Move point to the next error in the `next-error' buffer and highlight match.
352 Prefix arg N says how many error messages to move forwards (or
353 backwards, if negative).
355 select the source buffer."
362 "Move point to the previous error in the `next-error' buffer and highlight match.
363 Prefix arg N says how many error messages to move backwards (or
364 forwards, if negative).
366 select the source buffer."
370 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
374 "Minor mode for compilation, occur and diff modes.
375 When turned on, cursor motion in the compilation, grep, occur or diff
376 buffer causes automatic display of the corresponding source code
377 location."
384 ;; Used as a `post-command-hook' by `next-error-follow-mode'
385 ;; for the *Compilation* *grep* and *Occur* buffers.
395 \f
396 ;;;
399 "Major mode not specialized for anything in particular.
400 Other major modes are defined by comparison with this one."
405 ;; 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."
445 ;; Any programming language is always written left to right.
448 ;; Making and deleting lines.
454 "Insert a newline, and move to left margin of the new line if it's blank.
455 If `use-hard-newlines' is non-nil, the newline is marked with the
456 text-property `hard'.
457 With ARG, insert that many newlines.
458 Call `auto-fill-function' if the current column number is greater
459 than the value of `fill-column' and ARG is nil."
462 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
463 ;; Set last-command-event to tell self-insert what to insert.
467 ;; Don't auto-fill if we have a numeric argument.
470 ;; Do the rest in post-self-insert-hook, because we want to do it
471 ;; *before* other functions on that hook.
473 ;; Mark the newline(s) `hard'.
477 ;; If the newline leaves the previous line blank, and we
478 ;; have a left margin, delete that from the blank line.
486 ;; Indent the line after the newline, except in one case:
487 ;; when we added the newline at the beginning of a line which
488 ;; starts a page.
495 ;; We first used let-binding to protect the hook, but that was naive
496 ;; since add-hook affects the symbol-default value of the variable,
497 ;; whereas the let-binding might only protect the buffer-local value.
499 nil)
504 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
510 "Insert a newline and leave point before it.
511 If there is a fill prefix and/or a `left-margin', insert them
512 on the new line if the line would have been blank.
513 With arg N, insert N newlines."
518 ;; Don't expand an abbrev before point.
532 "Split current line, moving portion beyond point vertically down.
533 If the current line starts with `fill-prefix', insert it on the new
534 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
536 When called from Lisp code, ARG may be a prefix string to copy."
541 ;; What prefix should we check for (nil means don't).
545 ;; Does this line start with it?
556 "Join this line to previous and fix up whitespace at join.
557 If there is a fill prefix, delete it from the beginning of this line.
558 With argument, join this line to following line."
565 ;; If the second line started with the fill prefix,
566 ;; delete the prefix.
578 "On blank line, delete all surrounding blank lines, leaving just one.
579 On isolated blank line, delete that one.
580 On nonblank line, delete any immediately following blank lines."
586 ;; Set singleblank if there is just one blank line here.
593 ;; Delete preceding blank lines, and this one too if it's the only one.
602 ;; Delete following blank lines, unless the current line is blank
603 ;; and there are no following blank lines.
612 ;; Handle the special case where point is followed by newline and eob.
613 ;; Delete the line, leaving point at eob.
618 "Delete all the trailing whitespace across the current buffer.
619 All whitespace after the last non-whitespace character in a line is deleted.
621 A formfeed is not considered whitespace by this function.
622 If the region is active, only delete whitespace within the region."
635 ;; Don't delete formfeeds, even if they are considered whitespace.
643 "Insert a newline, then indent according to major mode.
644 Indentation is done using the value of `indent-line-function'.
645 In programming language modes, this is the same as TAB.
646 In some text modes, where TAB inserts a tab, this command indents to the
647 column specified by the function `current-left-margin'."
654 "Reindent current line, insert newline, then indent the new line.
655 Indentation of both lines is done according to the current major mode,
656 which means calling the current value of `indent-line-function'.
657 In programming language modes, this is the same as TAB.
658 In some text modes, where TAB inserts a tab, this indents to the
659 column specified by the function `current-left-margin'."
662 ;; Be careful to insert the newline before indenting the line.
663 ;; Otherwise, the indentation might be wrong.
667 ;; We are at EOL before the call to indent-according-to-mode, and
668 ;; after it we usually are as well, but not always. We tried to
669 ;; address it with `save-excursion' but that uses a normal marker
670 ;; whereas we need `move after insertion', so we do the save/restore
671 ;; by hand.
675 ;; Remove the trailing white-space after indentation because
676 ;; indentation may introduce the whitespace.
681 "Read next input character and insert it.
682 This is useful for inserting control characters.
683 With argument, insert ARG copies of the character.
685 If the first character you type after this command is an octal digit,
686 you should type a sequence of octal digits which specify a character code.
687 Any nondigit terminates the sequence. If the terminator is a RET,
688 it is discarded; any other terminator is used itself as input.
689 The variable `read-quoted-char-radix' specifies the radix for this feature;
690 set it to 10 or 16 to use decimal or hex instead of octal.
692 In overwrite mode, this function inserts the character anyway, and
693 does not handle octal digits specially. This means that if you use
694 overwrite as your normal editing mode, you can use this function to
695 insert characters when necessary.
697 In binary overwrite mode, this function does overwrite, and octal
698 digits are interpreted as a character code. This is intended to be
699 useful for editing binary files."
702 ;; Avoid "obsolete" warnings for translation-table-for-input.
709 ;; This used to assume character codes 0240 - 0377 stand for
710 ;; characters in some single-byte character set, and converted them
711 ;; to Emacs characters. But in 23.1 this feature is deprecated
712 ;; in favor of inserting the corresponding Unicode characters.
713 ;; (if (and enable-multibyte-characters
714 ;; (>= char ?\240)
715 ;; (<= char ?\377))
716 ;; (setq char (unibyte-char-to-multibyte char)))
725 "Move forward ARG lines and position at first nonblank character."
731 "Move backward ARG lines and position at first nonblank character."
737 "Move point to the first non-whitespace character on this line."
741 ;; Move back over chars that have whitespace syntax but have the p flag.
745 "Fixup white space between objects around point.
746 Leave one space or none, according to the context."
753 nil
757 "Delete all spaces and tabs around point.
758 If BACKWARD-ONLY is non-nil, only delete them before point."
763 orig-pos
772 "Delete all spaces and tabs around point, leaving one space (or N spaces).
773 If N is negative, delete newlines as well."
790 \f
792 "Move point to the beginning of the buffer.
793 With numeric arg N, put point N/10 of the way from the beginning.
794 If the buffer is narrowed, this command uses the beginning of the
795 accessible part of the buffer.
797 If Transient Mark mode is disabled, leave mark at previous
800 Don't use this command in Lisp programs!
801 \(goto-char (point-min)) is faster."
810 ;; Avoid overflow for large buffer sizes!
818 "Move point to the end of the buffer.
819 With numeric arg N, put point N/10 of the way from the end.
820 If the buffer is narrowed, this command uses the end of the
821 accessible part of the buffer.
823 If Transient Mark mode is disabled, leave mark at previous
826 Don't use this command in Lisp programs!
827 \(goto-char (point-max)) is faster."
834 ;; Avoid overflow for large buffer sizes!
839 ;; If we went to a place in the middle of the buffer,
840 ;; adjust it to the beginning of a line.
843 ;; If the end of the buffer is not already on the screen,
844 ;; then scroll specially to put it near, but not at, the bottom.
849 "Whether single-char deletion commands delete an active region.
850 This has an effect only if Transient Mark mode is enabled, and
851 affects `delete-forward-char' and `delete-backward-char', though
852 not `delete-char'.
854 If the value is the symbol `kill', the active region is killed
855 instead of deleted."
863 "Delete the previous N characters (following if N is negative).
864 If Transient Mark mode is enabled, the mark is active, and N is 1,
865 delete the text in the region and deactivate the mark instead.
866 To disable this, set `delete-active-region' to nil.
868 Optional second arg KILLFLAG, if non-nil, means to kill (save in
869 kill ring) instead of delete. Interactively, N is the prefix
870 arg, and KILLFLAG is set if N is explicitly specified.
872 In Overwrite mode, single character backward deletion may replace
873 tabs with spaces so as to back over columns, unless point is at
874 the end of the line."
879 delete-active-region
881 ;; If a region is active, kill or delete it.
885 ;; In Overwrite mode, maybe untabify while deleting
895 ;; Otherwise, do simple deletion.
899 "Delete the following N characters (previous if N is negative).
900 If Transient Mark mode is enabled, the mark is active, and N is 1,
901 delete the text in the region and deactivate the mark instead.
902 To disable this, set `delete-active-region' to nil.
904 Optional second arg KILLFLAG non-nil means to kill (save in kill
905 ring) instead of delete. Interactively, N is the prefix arg, and
906 KILLFLAG is set if N was explicitly specified."
911 delete-active-region
913 ;; If a region is active, kill or delete it.
917 ;; Otherwise, do simple deletion.
921 "Put point at beginning and mark at end of buffer.
922 You probably should not use this function in Lisp programs;
923 it is usually a mistake for a Lisp function to use any subroutine
924 that uses or sets the mark."
929 \f
931 ;; Counting lines, one way or another.
934 "Goto LINE, counting from line 1 at beginning of buffer.
935 Normally, move point in the current buffer, and leave mark at the
937 move point in the most recently selected other buffer, and switch to it.
939 If there's a number in the buffer at point, it is the default for LINE.
941 This function is usually the wrong thing to use in a Lisp program.
942 What you probably want instead is something like:
943 (goto-char (point-min)) (forward-line (1- N))
944 If at all possible, an even better solution is to use char counts
945 rather than line counts."
949 ;; Look for a default, a number in the buffer at point.
958 ;; Decide if we're switching buffers.
966 ;; Read the argument, offering that number (if any) as default.
969 buffer-prompt
970 default)
971 nil nil t
972 'minibuffer-history
973 default)
974 buffer))))
975 ;; Switch to the desired buffer, one way or another.
980 ;; Leave mark at previous position
982 ;; Move to the specified line number in that buffer.
991 "Print the number of words in the region.
992 When called interactively, the word count is printed in echo area."
1003 count))
1006 "Print number of lines and characters in the region."
1012 "Print the current buffer line number and narrowed line number of point."
1025 "Return number of lines between START and END.
1026 This is usually the number of newlines between them,
1027 but can be one more if START is not equal to END
1028 and the greater of them is not at the start of a line."
1044 done)))
1048 "Return (narrowed) buffer line number at position POS.
1049 If POS is nil, use current buffer location.
1050 Counting starts at (point-min), so the value refers
1051 to the contents of the accessible portion of the buffer."
1061 "Print info on cursor position (on screen and within buffer).
1062 Also describe the character after point, and give its character code
1063 in octal, decimal and hex.
1065 For a non-ASCII multibyte character, also give its encoding in the
1066 buffer's selected coding system if the coding system encodes the
1067 character safely. If the character is encoded into one byte, that
1068 code is shown in hex. If the character is encoded into more than one
1071 In addition, with prefix argument, show details about that character
1072 in *Help* buffer. See also the command `describe-char'."
1080 ;; Avoid overflow from multiplying by 100!
1084 ""
1090 pos total percent beg end col hscroll)
1092 pos total col hscroll))
1094 encoded encoding-msg display-prop under-display)
1101 ;; Check if the character is displayed with some `display'
1102 ;; text property. In that case, set under-display to the
1103 ;; buffer substring covered by that property.
1114 under-display)))
1120 char char char under-display)
1122 char char char under-display display-prop))
1125 char char char
1127 "..."
1131 ;; We show the detailed information about CHAR.
1138 encoding-msg pos total percent beg end col hscroll)
1145 encoding-msg pos total percent col hscroll))))))
1146 \f
1147 ;; Initialize read-expression-map. It is defined at C level.
1157 "The current default value or list of default values in the minibuffer.
1158 The functions `read-from-minibuffer' and `completing-read' bind
1162 "Value for `print-level' while printing value in `eval-expression'.
1163 A value of nil means no limit."
1169 "Value for `print-length' while printing value in `eval-expression'.
1170 A value of nil means no limit."
1176 "If non-nil set `debug-on-error' to t in `eval-expression'.
1177 If nil, don't change the value of `debug-on-error'."
1183 "Format VALUE as a result of evaluated expression.
1184 Return a formatted string which is displayed in the echo area
1185 in addition to the value printed by prin1 in functions which
1186 display the result of expression evaluation."
1199 ;; We define this, rather than making `eval' interactive,
1200 ;; for the sake of completion of names like eval-region, eval-buffer.
1203 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1204 Value is also consed on to front of the variable `values'.
1205 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1206 with prefix argument) means insert the result into the current buffer
1207 instead of printing it in the echo area. Truncates long output
1208 according to the value of the variables `eval-expression-print-length'
1209 and `eval-expression-print-level'.
1211 If `eval-expression-debug-on-error' is non-nil, which is the default,
1212 this command arranges for all errors to enter the debugger."
1216 nil read-expression-map t
1218 current-prefix-arg))
1223 ;; Bind debug-on-error to something unique so that we can
1224 ;; detect when evaled code changes it.
1228 ;; If evaled code has changed the value of debug-on-error,
1229 ;; propagate that change to the global binding.
1245 "Prompting with PROMPT, let user edit COMMAND and eval result.
1246 COMMAND is a Lisp expression. Let user edit that expression in
1247 the minibuffer, then read and evaluate the result."
1254 read-expression-map t
1256 ;; If command was added to command-history as a string,
1257 ;; get rid of that. We want only evaluable expressions there.
1261 ;; If command to be redone does not match front of history,
1262 ;; add it to the history.
1268 "Edit and re-evaluate last complex command, or ARGth from last.
1269 A complex command is one which used the minibuffer.
1270 The command is placed in the minibuffer as a Lisp form for editing.
1271 The result is executed, repeating the command as changed.
1272 If the command has been changed or is not the most recent previous
1273 command it is added to the front of the command history.
1274 You can use the minibuffer history commands \
1276 to get different commands to edit and resubmit."
1279 newcmd)
1291 ;; If command was added to command-history as a
1292 ;; string, get rid of that. We want only
1293 ;; evaluable expressions there.
1297 ;; If command to be redone does not match front of history,
1298 ;; add it to the history.
1307 "Read command name to invoke in `execute-extended-command'."
1312 ;; Get a command name at point in the original buffer
1313 ;; to propose it after M-n.
1317 ;; Read a string, completing from and restricting to the set of
1318 ;; all defined commands. Don't provide any initial input.
1319 ;; Save the command read on the extended-command history list.
1330 ;; This isn't strictly correct if `execute-extended-command'
1331 ;; is bound to anything else (e.g. [menu]).
1332 ;; It could use (key-description (this-single-command-keys)),
1333 ;; but actually a prompt other than "M-x" would be confusing,
1334 ;; because "M-x" is a well-known prompt to read a command
1335 ;; and it serves as a shorthand for "Extended command: ".
1339 \f
1341 "Default minibuffer history list.
1342 This is used for all minibuffer input
1343 except when an alternate history list is specified.
1345 Maximum length of the history list is determined by the value
1348 "Control whether history list elements are expressions or strings.
1349 If the value of this variable equals current minibuffer depth,
1350 they are expressions; otherwise they are strings.
1351 \(That convention is designed to do the right thing for
1358 "Text that was in this minibuffer before any history commands.
1359 This is nil if there have not yet been any history commands
1368 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1372 "Minibuffer history variables for which matching should ignore case.
1373 If a history variable is a member of this list, then the
1375 commands ignore case when searching it, regardless of `case-fold-search'."
1380 "Find the previous history element that matches REGEXP.
1381 \(Previous history elements refer to earlier actions.)
1382 With prefix argument N, search for Nth previous match.
1383 If N is negative, find the next or Nth next match.
1384 Normally, history elements are matched case-insensitively if
1385 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1386 makes the search case-sensitive.
1387 See also `minibuffer-history-case-insensitive-variables'."
1391 nil
1392 minibuffer-local-map
1393 nil
1394 'minibuffer-history-search-history
1396 ;; Use the last regexp specified, by default, if input is empty.
1401 regexp)
1411 ;; On some systems, ignore case for file names.
1413 minibuffer-history-case-insensitive-variables)
1414 t
1415 ;; Respect the user's setting for case-fold-search:
1416 case-fold-search)
1417 nil))
1418 prevpos
1419 match-string
1420 match-offset
1427 "No later matching history item"
1448 next-matching-history-element))
1452 "Find the next history element that matches REGEXP.
1453 \(The next history element refers to a more recent action.)
1454 With prefix argument N, search for Nth next match.
1455 If N is negative, find the previous or Nth previous match.
1456 Normally, history elements are matched case-insensitively if
1457 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1458 makes the search case-sensitive."
1462 nil
1463 minibuffer-local-map
1464 nil
1465 'minibuffer-history-search-history
1467 ;; Use the last regexp specified, by default, if input is empty.
1472 regexp)
1479 "Function run by `goto-history-element' before consuming default values.
1480 This is useful to dynamically add more elements to the list of default values
1481 when `goto-history-element' reaches the end of this list.
1482 Before calling this function `goto-history-element' sets the variable
1483 `minibuffer-default-add-done' to t, so it will call this function only
1484 once. In special cases, when this function needs to be called more
1485 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1489 "When nil, add more elements to the end of the list of default values.
1490 The value nil causes `goto-history-element' to add more elements to
1491 the list of defaults when it reaches the end of this list. It does
1497 "Return a list of all completions without the default value.
1498 This function is used to add all elements of the completion table to
1499 the end of the list of defaults just after the default value."
1502 minibuffer-completion-table
1503 minibuffer-completion-predicate)))
1509 "Puts element of the minibuffer history in the minibuffer.
1510 The argument NABS specifies the absolute history position."
1524 elt minibuffer-returned-to-present)
1536 previous-history-element))
1548 minibuffer-default)))
1560 elt))
1564 "Puts next element of the minibuffer history in the minibuffer.
1565 With argument N, it uses the Nth following element."
1571 "Puts previous element of the minibuffer history in the minibuffer.
1572 With argument N, it uses the Nth previous element."
1578 "Get next history element which completes the minibuffer before the point.
1579 The contents of the minibuffer after the point are deleted, and replaced
1580 by the new completion."
1586 n)
1587 ;; next-matching-history-element always puts us at (point-min).
1588 ;; Move to the position we were at before changing the buffer contents.
1589 ;; This is still sensical, because the text before point has not changed.
1593 "\
1594 Get previous history element which completes the minibuffer before the point.
1595 The contents of the minibuffer after the point are deleted, and replaced
1596 by the new completion."
1600 ;; For compatibility with the old subr of the same name.
1602 "Return the display width of the minibuffer prompt.
1603 Return 0 if current buffer is not a minibuffer."
1604 ;; Return the width of everything before the field at the end of
1605 ;; the buffer; this should be 0 for normal buffers.
1607 \f
1608 ;; isearch minibuffer history
1615 "Set up a minibuffer for using isearch to search the minibuffer history.
1616 Intended to be added to `minibuffer-setup-hook'."
1628 "Clean up the minibuffer after terminating isearch in the minibuffer."
1633 "Return the proper search function, for isearch in minibuffer history."
1640 ;; Use standard functions to search within minibuffer text
1646 found)
1647 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1648 ;; searching forward. Lazy-highlight calls this lambda with the
1649 ;; bound arg, so skip the minibuffer prompt.
1653 ;; 1. First try searching in the initial minibuffer text
1656 noerror)
1657 ;; 2. If the above search fails, start putting next/prev history
1658 ;; elements in the minibuffer successively, and search the string
1659 ;; in them. Do this only when bound is nil (i.e. not while
1660 ;; lazy-highlighting search strings in the current minibuffer text).
1672 ;; After putting the next/prev history element, search
1673 ;; the string in them again, until next-history-element
1674 ;; or previous-history-element raises an error at the
1675 ;; beginning/end of history.
1678 ;; For backward search, don't search
1679 ;; in the minibuffer prompt
1681 noerror)))
1682 ;; Return point of the new search result
1684 ;; Return nil when next(prev)-history-element fails
1688 "Display the minibuffer history search prompt.
1689 If there are no search errors, this function displays an overlay with
1690 the isearch prompt which replaces the original minibuffer prompt.
1691 Otherwise, it displays the standard isearch message returned from
1692 `isearch-message'."
1694 ;; Use standard function `isearch-message' when not in the minibuffer,
1695 ;; or search fails, or has an error (like incomplete regexp).
1696 ;; This function overwrites minibuffer text with isearch message,
1697 ;; so it's possible to see what is wrong in the search string.
1699 ;; Otherwise, put the overlay with the standard isearch prompt over
1700 ;; the initial minibuffer prompt.
1709 ;; And clear any previous isearch message.
1713 "Wrap the minibuffer history search when search fails.
1714 Move point to the first history element for a forward search,
1715 or to the last history element for a backward search."
1717 ;; When `minibuffer-history-isearch-search' fails on reaching the
1718 ;; beginning/end of the history, wrap the search to the first/last
1719 ;; minibuffer history element.
1727 "Save a function restoring the state of minibuffer history search.
1728 Save `minibuffer-history-position' to the additional state parameter
1729 in the search status stack."
1734 "Restore the minibuffer history search state.
1735 Go to the history element by the absolute history position HIST-POS."
1738 \f
1739 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1743 "Table mapping redo records to the corresponding undo one.
1744 A redo record for undo-in-region maps to t.
1754 "Within a run of consecutive undo commands, list remaining to be undone.
1758 "Undo some previous changes.
1759 Repeat this command to undo more changes.
1760 A numeric ARG serves as a repeat count.
1762 In Transient Mark mode when the mark is active, only undo changes within
1764 as an argument limits undo to changes within the current region."
1766 ;; Make last-command indicate for the next command that this was an undo.
1767 ;; That way, another undo will undo more.
1768 ;; If we get to the end of the undo history and get an error,
1769 ;; another undo command will find the undo history empty
1770 ;; and will get another error. To begin undoing the undos,
1771 ;; you must type some other command.
1774 message)
1775 ;; If we get an error in undo-start,
1776 ;; the next command should not be a "consecutive undo".
1777 ;; So set `this-command' to something other than `undo'.
1782 ;; If something (a timer or filter?) changed the buffer
1783 ;; since the previous command, don't continue the undo seq.
1787 ;; If the last undo record made was made by undo
1788 ;; it shows nothing else happened in between.
1795 ;; get rid of initial undo boundary
1797 ;; If we got this far, the next command should be a consecutive undo.
1799 ;; Check to see whether we're hitting a redo record, and if
1800 ;; so, ask the user whether she wants to skip the redo/undo pair.
1807 ;; The equiv entry might point to another redo record if we have done
1808 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1816 ;; Record the fact that the just-generated undo records come from an
1817 ;; undo operation--that is, they are redo records.
1818 ;; In the ordinary case (not within a region), map the redo
1819 ;; record to the following undos.
1820 ;; I don't know how to do that in the undo-in-region case.
1822 ;; Strip any leading undo boundaries there might be, like we do
1823 ;; above when checking.
1827 undo-equiv-table))
1828 ;; Don't specify a position in the undo record for the undo command.
1829 ;; Instead, undoing this should move point to where the change is.
1848 ;; Record what the current undo list says,
1849 ;; so the next command can tell if the buffer was modified in between.
1852 ;; Display a message announcing success.
1857 "Make BUFFER stop keeping undo information.
1858 No argument or nil as argument means do this for the current buffer."
1864 "Undo some previous changes.
1865 Repeat this command to undo more changes.
1866 A numeric ARG serves as a repeat count.
1867 Contrary to `undo', this will not redo a previous undo."
1872 "Non-nil while performing an undo.
1876 "Undo back N undo-boundaries beyond what was already undone recently.
1877 Call `undo-start' to get ready to undo recent changes,
1878 then call `undo-more' one or more times to undo them."
1883 ;; Note: The following, while pulling elements off
1884 ;; `pending-undo-list' will call primitive change functions which
1885 ;; will push more elements onto `buffer-undo-list'.
1890 ;; Deep copy of a list
1892 "Make a copy of undo list LIST."
1898 elt))
1901 "Set `pending-undo-list' to the front of the undo list.
1902 The next call to `undo-more' will undo the most recently made change.
1903 If BEG and END are specified, then only undo elements
1904 that apply to text between BEG and END are used; other undo elements
1905 are ignored. If BEG and END are nil, all undo elements are used."
1911 buffer-undo-list)))
1916 "Return a list of undo elements for the region START to END.
1917 The elements come from `buffer-undo-list', but we keep only
1918 the elements inside this region, and discard those outside this region.
1919 If we find an element that crosses an edge of this region,
1920 we stop and ignore all further elements."
1923 undo-adjusted-markers
1924 some-rejected
1925 undo-elt undo-elt temp-undo-list delta)
1930 ;; This is a "was unmodified" element.
1931 ;; Keep it if we have kept everything thus far.
1938 ;; Don't put two nils together in the list
1952 ;; Loop down the earlier events adjusting their buffer
1953 ;; positions to reflect the fact that a change to the buffer
1954 ;; isn't being undone. We only need to process those element
1955 ;; types which undo-elt-in-region will return as being in
1956 ;; the region since only those types can ever get into the
1957 ;; output
1966 ;; (TEXT . POSITION)
1973 ;; (BEGIN . END)
1978 ;; (nil PROPERTY VALUE BEG . END)
1988 "Determine whether UNDO-ELT falls inside the region START ... END.
1989 If it crosses the edge, we return nil."
1994 t)
1996 nil)
1998 ;; (TEXT . POSITION)
2002 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2003 ;; See if MARKER is inside the region.
2014 ;; (nil PROPERTY VALUE BEG . END)
2019 ;; (BEGIN . END)
2024 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2025 This assumes we have already decided that UNDO-ELT
2026 is not *inside* the region START...END."
2029 ;; (nil PROPERTY VALUE BEG . END)
2034 ;; (BEGIN . END)
2038 ;; Return the first affected buffer position and the delta for an undo element
2039 ;; delta is defined as the change in subsequent buffer positions if we *did*
2040 ;; the undo.
2044 ;; (TEXT . POSITION)
2047 ;; (BEGIN . END)
2054 "If non-nil ask about discarding undo info for the current command.
2055 Normally, Emacs discards the undo info for the current command if
2056 it exceeds `undo-outer-limit'. But if you set this option
2057 non-nil, it asks in the echo area whether to discard the info.
2058 If you answer no, there is a slight risk that Emacs might crash, so
2059 only do it if you really want to undo the command.
2061 This option is mainly intended for debugging. You have to be
2062 careful if you use it for other purposes. Garbage collection is
2063 inhibited while the question is asked, meaning that Emacs might
2064 leak memory. So you should make sure that you do not wait
2065 excessively long before answering the question."
2071 "If non-nil, an extra level of size that's ok in an undo item.
2072 We don't ask the user about truncating the undo list until the
2073 current item gets bigger than this amount.
2078 ;; When the first undo batch in an undo list is longer than
2079 ;; undo-outer-limit, this function gets called to warn the user that
2080 ;; the undo info for the current command was discarded. Garbage
2081 ;; collection is inhibited around the call, so it had better not do a
2082 ;; lot of consing.
2088 ;; Don't ask the question again unless it gets even bigger.
2089 ;; This applies, in particular, if the user quits from the question.
2090 ;; Such a quit quits out of GC, but something else will call GC
2091 ;; again momentarily. It will call this function again,
2092 ;; but we don't want to ask the question again.
2099 t)
2100 nil))
2105 "The undo info was discarded because it exceeded \
2106 `undo-outer-limit'.
2108 This is normal if you executed a command that made a huge change
2109 to the buffer. In that case, to prevent similar problems in the
2110 future, set `undo-outer-limit' to a value that is large enough to
2111 cover the maximum size of normal changes you expect a single
2112 command to make, but not so large that it might exceed the
2113 maximum memory allotted to Emacs.
2115 If you did not execute any such command, the situation is
2116 probably due to a bug and you should report it.
2118 You can disable the popping up of this buffer by adding the entry
2119 \(undo discard-info) to the user option `warning-suppress-types',
2123 t))
2124 \f
2126 "History list for some commands that read shell commands.
2128 Maximum length of the history list is determined by the value
2135 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2136 This buffer is used when `shell-command' or `shell-command-on-region'
2137 is run interactively. A value of nil means that output to stderr and
2144 "Return a list of all commands associated with the current file.
2145 This function is used to add all related commands retrieved by `mailcap'
2146 to the end of the list of defaults just after the default value."
2150 minibuffer-default))
2155 commands))
2165 "Dynamically complete shell command at point."
2177 map)
2181 "Read a shell command from the minibuffer.
2182 The arguments are the same as the ones of `read-from-minibuffer',
2183 except READ and KEYMAP are missing and HIST defaults
2184 to `shell-command-history'."
2190 minibuffer-local-shell-command-map
2191 nil
2193 args)))
2196 "Execute string COMMAND asynchronously in background.
2198 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2199 surrounded by whitespace and executes the command asynchronously.
2200 The output appears in the buffer `*Async Shell Command*'.
2202 In Elisp, you will often be better served by calling `start-process'
2203 directly, since it offers more control and does not impose the use of a
2204 shell (with its need to quote arguments)."
2210 current-prefix-arg
2211 shell-command-default-error-buffer))
2217 "Execute string COMMAND in inferior shell; display output, if any.
2218 With prefix argument, insert the COMMAND's output at point.
2220 If COMMAND ends in ampersand, execute it asynchronously.
2221 The output appears in the buffer `*Async Shell Command*'.
2222 That buffer is in shell mode.
2224 Otherwise, COMMAND is executed synchronously. The output appears in
2225 the buffer `*Shell Command Output*'. If the output is short enough to
2226 display in the echo area (which is determined by the variables
2227 `resize-mini-windows' and `max-mini-window-height'), it is shown
2228 there, but it is nonetheless available in buffer `*Shell Command
2229 Output*' even though that buffer is not automatically displayed.
2231 To specify a coding system for converting non-ASCII characters
2233 before this command.
2235 Noninteractive callers can specify coding systems by binding
2236 `coding-system-for-read' and `coding-system-for-write'.
2238 The optional second argument OUTPUT-BUFFER, if non-nil,
2239 says to put the output in some other buffer.
2240 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2241 If OUTPUT-BUFFER is not a buffer and not nil,
2242 insert output in current buffer. (This cannot be done asynchronously.)
2243 In either case, the buffer is first erased, and the output is
2244 inserted after point (leaving mark after it).
2246 If the command terminates without error, but generates output,
2248 the output can be displayed in the echo area or in its buffer.
2249 If the output is short enough to display in the echo area
2250 \(determined by the variable `max-mini-window-height' if
2251 `resize-mini-windows' is non-nil), it is shown there.
2252 Otherwise,the buffer containing the output is displayed.
2256 of the output.
2258 If there is no output, or if output is inserted in the current buffer,
2259 then `*Shell Command Output*' is deleted.
2261 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2262 or buffer name to which to direct the command's standard error output.
2263 If it is nil, error output is mingled with regular output.
2264 In an interactive call, the variable `shell-command-default-error-buffer'
2265 specifies the value of ERROR-BUFFER.
2267 In Elisp, you will often be better served by calling `call-process' or
2268 `start-process' directly, since it offers more control and does not impose
2269 the use of a shell (with its need to quote arguments)."
2280 current-prefix-arg
2281 shell-command-default-error-buffer))
2282 ;; Look for a handler in case default-directory is a remote file name.
2290 ;; Output goes in current buffer.
2296 temporary-file-directory)))
2297 nil)))
2300 ;; We do not use -f for csh; we will not support broken use of
2301 ;; .cshrcs. Even the BSD csh manual says to use
2302 ;; "if ($?prompt) exit" before things which are not useful
2303 ;; non-interactively. Besides, if someone wants their other
2304 ;; aliases for shell commands then they can still have them.
2308 t)
2309 nil shell-command-switch command)
2316 ;; Do no formatting while reading error file,
2317 ;; because that can run a shell command, and we
2318 ;; don't want that to cause an infinite recursion.
2320 ;; Put point after the inserted errors.
2324 ;; This is like exchange-point-and-mark, but doesn't
2325 ;; activate the mark. It is cleaner to avoid activation,
2326 ;; even though the command loop would deactivate the mark
2327 ;; because we inserted text.
2331 ;; Output goes in a separate buffer.
2332 ;; Preserve the match data in case called from a program.
2335 ;; Command ending with ampersand means asynchronous.
2339 proc)
2340 ;; Remove the ampersand.
2342 ;; If will kill a process, query first.
2350 ;; Setting buffer-read-only to nil doesn't suffice
2351 ;; if some text has a non-nil read-only property,
2352 ;; which comint sometimes adds for prompts.
2358 shell-command-switch command))
2362 ;; Use the comint filter for proper handling of carriage motion
2363 ;; (see `comint-inhibit-carriage-motion'),.
2365 ))
2366 ;; Otherwise, command is executed synchronously.
2368 output-buffer nil error-buffer)))))))
2372 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2373 MESSAGE may be either a string or a buffer.
2375 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2376 the maximum height of the echo area, as defined by `max-mini-window-height'
2377 if `resize-mini-windows' is non-nil.
2379 Returns either the string shown in the echo area, or when a pop-up
2380 buffer is used, the window used to display it.
2382 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2383 name of the buffer used to display it in the case where a pop-up buffer
2384 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2385 string and it is displayed in the echo area, it is not specified whether
2386 the contents are inserted into the buffer anyway.
2388 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2389 and only used if a buffer is displayed."
2391 ;; Trivial case where we can use the echo area
2395 ;; Trivial case where we can just remove single trailing newline
2398 ;; General case
2401 message
2410 0
2414 (<= lines
2418 max-mini-window-height))
2420 max-mini-window-height)
2424 ;; Don't use the echo area if the output buffer is
2425 ;; already dispayed in the selected frame.
2427 ;; Echo area
2433 ;; Buffer
2436 not-this-window frame))))))))
2439 ;; We have a sentinel to prevent insertion of a termination message
2440 ;; in the buffer itself.
2448 &optional output-buffer replace
2449 error-buffer display-error-buffer)
2450 "Execute string COMMAND in inferior shell with region as input.
2451 Normally display output (if any) in temp buffer `*Shell Command Output*';
2452 Prefix arg means replace the region with it. Return the exit code of
2453 COMMAND.
2455 To specify a coding system for converting non-ASCII characters
2457 before this command. By default, the input (from the current buffer)
2458 is encoded in the same coding system that will be used to save the file,
2459 `buffer-file-coding-system'. If the output is going to replace the region,
2460 then it is decoded from that same coding system.
2462 The noninteractive arguments are START, END, COMMAND,
2463 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2464 Noninteractive callers can specify coding systems by binding
2465 `coding-system-for-read' and `coding-system-for-write'.
2467 If the command generates output, the output may be displayed
2468 in the echo area or in a buffer.
2469 If the output is short enough to display in the echo area
2470 \(determined by the variable `max-mini-window-height' if
2471 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2472 it is displayed in the buffer `*Shell Command Output*'. The output
2473 is available in that buffer in both cases.
2475 If there is output and an error, a message about the error
2476 appears at the end of the output.
2478 If there is no output, or if output is inserted in the current buffer,
2479 then `*Shell Command Output*' is deleted.
2481 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2482 that says to put the output in some other buffer.
2483 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2484 If OUTPUT-BUFFER is not a buffer and not nil,
2485 insert output in the current buffer.
2486 In either case, the output is inserted after point (leaving mark after it).
2488 If REPLACE, the optional fifth argument, is non-nil, that means insert
2489 the output in place of text from START to END, putting point and mark
2490 around it.
2492 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2493 or buffer name to which to direct the command's standard error output.
2494 If it is nil, error output is mingled with regular output.
2495 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2496 were any errors. (This is always t, interactively.)
2497 In an interactive call, the variable `shell-command-default-error-buffer'
2498 specifies the value of ERROR-BUFFER."
2502 ;; Do this before calling region-beginning
2503 ;; and region-end, in case subprocess output
2504 ;; relocates them while we are in the minibuffer.
2506 ;; call-interactively recognizes region-beginning and
2507 ;; region-end specially, leaving them in the history.
2509 string
2510 current-prefix-arg
2511 current-prefix-arg
2512 shell-command-default-error-buffer
2513 t)))
2519 temporary-file-directory)))
2520 nil))
2521 exit-status)
2525 ;; Replace specified region with output from command.
2527 ;; Don't muck with mark unless REPLACE says we should.
2534 t)
2535 nil shell-command-switch command))
2536 ;; It is rude to delete a buffer which the command is not using.
2537 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2538 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2539 ;; (kill-buffer shell-buffer)))
2540 ;; Don't muck with mark unless REPLACE says we should.
2542 ;; No prefix argument: put the output in a temp buffer,
2543 ;; replacing its entire contents.
2548 ;; If the input is the same buffer as the output,
2549 ;; delete everything but the specified region,
2550 ;; then replace that region with the output.
2556 shell-file-name t
2559 t)
2560 nil shell-command-switch
2561 command)))
2562 ;; Clear the output buffer, then run the command with
2563 ;; output there.
2574 buffer)
2575 nil shell-command-switch command)))
2576 ;; Report the output.
2586 ;; There's some output, display it
2588 ;; No output; error?
2592 "some error output"
2598 output))
2601 exit-status))
2604 exit-status output))))
2605 ;; Don't kill: there might be useful info in the undo-log.
2606 ;; (kill-buffer buffer)
2607 ))))
2615 ;; Do no formatting while reading error file,
2616 ;; because that can run a shell command, and we
2617 ;; don't want that to cause an infinite recursion.
2619 ;; Put point after the inserted errors.
2624 exit-status))
2627 "Execute shell command COMMAND and return its output as a string."
2630 standard-output
2634 "Process files synchronously in a separate process.
2635 Similar to `call-process', but may invoke a file handler based on
2636 `default-directory'. The current working directory of the
2637 subprocess is `default-directory'.
2639 File names in INFILE and BUFFER are handled normally, but file
2640 names in ARGS should be relative to `default-directory', as they
2641 are passed to the process verbatim. \(This is a difference to
2642 `call-process' which does not support file handlers for INFILE
2643 and BUFFER.\)
2645 Some file handlers might not support all variants, for example
2646 they might behave as if DISPLAY was nil, regardless of the actual
2647 value passed."
2649 lc stderr-file)
2659 display args)
2665 "Whether a call of `process-file' changes remote files.
2667 Per default, this variable is always set to `t', meaning that a
2668 call of `process-file' could potentially change any file on a
2669 remote host. When set to `nil', a file handler could optimize
2670 its behaviour with respect to remote file attributes caching.
2672 This variable should never be changed by `setq'. Instead of, it
2676 "Start a program in a subprocess. Return the process object for it.
2678 Similar to `start-process', but may invoke a file handler based on
2679 `default-directory'. See Info node `(elisp)Magic File Names'.
2681 This handler ought to run PROGRAM, perhaps on the local host,
2682 perhaps on a remote host that corresponds to `default-directory'.
2683 In the latter case, the local part of `default-directory' becomes
2684 the working directory of the process.
2686 PROGRAM and PROGRAM-ARGS might be file names. They are not
2687 objects of file handler invocation. File handlers might not
2688 support pty association, if PROGRAM is nil."
2693 \f
2697 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2698 (define-key map [switch-frame] nil)
2699 (define-key map [?\C-u] 'universal-argument-more)
2700 (define-key map [?-] 'universal-argument-minus)
2701 (define-key map [?0] 'digit-argument)
2702 (define-key map [?1] 'digit-argument)
2703 (define-key map [?2] 'digit-argument)
2704 (define-key map [?3] 'digit-argument)
2705 (define-key map [?4] 'digit-argument)
2706 (define-key map [?5] 'digit-argument)
2707 (define-key map [?6] 'digit-argument)
2708 (define-key map [?7] 'digit-argument)
2709 (define-key map [?8] 'digit-argument)
2710 (define-key map [?9] 'digit-argument)
2711 (define-key map [kp-0] 'digit-argument)
2712 (define-key map [kp-1] 'digit-argument)
2713 (define-key map [kp-2] 'digit-argument)
2714 (define-key map [kp-3] 'digit-argument)
2715 (define-key map [kp-4] 'digit-argument)
2716 (define-key map [kp-5] 'digit-argument)
2717 (define-key map [kp-6] 'digit-argument)
2718 (define-key map [kp-7] 'digit-argument)
2719 (define-key map [kp-8] 'digit-argument)
2720 (define-key map [kp-9] 'digit-argument)
2721 (define-key map [kp-subtract] 'universal-argument-minus)
2722 map)
2725 (defvar universal-argument-num-events nil
2726 "Number of argument-specifying events read by `universal-argument'.
2727 `universal-argument-other-key' uses this to discard those events
2728 from (this-command-keys), and reread only the final command.")
2730 (defvar overriding-map-is-bound nil
2731 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2733 (defvar saved-overriding-map nil
2734 "The saved value of `overriding-terminal-local-map'.
2738 (defun ensure-overriding-map-is-bound ()
2739 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2740 (unless overriding-map-is-bound
2741 (setq saved-overriding-map overriding-terminal-local-map)
2742 (setq overriding-terminal-local-map universal-argument-map)
2743 (setq overriding-map-is-bound t)))
2745 (defun restore-overriding-map ()
2746 "Restore `overriding-terminal-local-map' to its saved value."
2747 (setq overriding-terminal-local-map saved-overriding-map)
2748 (setq overriding-map-is-bound nil))
2750 (defun universal-argument ()
2751 "Begin a numeric argument for the following command.
2756 multiplies the argument by 4 each time.
2758 which is different in effect from any particular numeric argument.
2760 (interactive)
2761 (setq prefix-arg (list 4))
2762 (setq universal-argument-num-events (length (this-command-keys)))
2763 (ensure-overriding-map-is-bound))
2765 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2766 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2767 (defun universal-argument-more (arg)
2768 (interactive "P")
2769 (if (consp arg)
2770 (setq prefix-arg (list (* 4 (car arg))))
2771 (if (eq arg '-)
2772 (setq prefix-arg (list -4))
2773 (setq prefix-arg arg)
2774 (restore-overriding-map)))
2775 (setq universal-argument-num-events (length (this-command-keys))))
2777 (defun negative-argument (arg)
2778 "Begin a negative numeric argument for the next command.
2780 (interactive "P")
2781 (cond ((integerp arg)
2782 (setq prefix-arg (- arg)))
2783 ((eq arg '-)
2784 (setq prefix-arg nil))
2785 (t
2786 (setq prefix-arg '-)))
2787 (setq universal-argument-num-events (length (this-command-keys)))
2788 (ensure-overriding-map-is-bound))
2790 (defun digit-argument (arg)
2791 "Part of the numeric argument for the next command.
2793 (interactive "P")
2794 (let* ((char (if (integerp last-command-event)
2795 last-command-event
2796 (get last-command-event 'ascii-character)))
2798 (cond ((integerp arg)
2799 (setq prefix-arg (+ (* arg 10)
2800 (if (< arg 0) (- digit) digit))))
2801 ((eq arg '-)
2802 ;; Treat -0 as just -, so that -01 will work.
2803 (setq prefix-arg (if (zerop digit) '- (- digit))))
2804 (t
2805 (setq prefix-arg digit))))
2806 (setq universal-argument-num-events (length (this-command-keys)))
2807 (ensure-overriding-map-is-bound))
2809 ;; For backward compatibility, minus with no modifiers is an ordinary
2810 ;; command if digits have already been entered.
2811 (defun universal-argument-minus (arg)
2812 (interactive "P")
2813 (if (integerp arg)
2814 (universal-argument-other-key arg)
2815 (negative-argument arg)))
2817 ;; Anything else terminates the argument and is left in the queue to be
2818 ;; executed as a command.
2819 (defun universal-argument-other-key (arg)
2820 (interactive "P")
2821 (setq prefix-arg arg)
2822 (let* ((key (this-command-keys))
2823 (keylist (listify-key-sequence key)))
2824 (setq unread-command-events
2825 (append (nthcdr universal-argument-num-events keylist)
2826 unread-command-events)))
2827 (reset-this-command-lengths)
2828 (restore-overriding-map))
2829 \f
2830 ;; This function is here rather than in subr.el because it uses CL.
2831 (defmacro with-wrapper-hook (var args &rest body)
2832 "Run BODY wrapped with the VAR hook.
2833 VAR is a special hook: its functions are called with a first argument
2835 the original function, or call it any number of times (including not calling
2836 it at all). This is similar to an `around' advice.
2837 VAR is normally a symbol (a variable) in which case it is treated like
2838 a hook, with a buffer-local and a global part. But it can also be an
2839 arbitrary expression.
2840 ARGS is a list of variables which will be passed as additional arguments
2841 to each function, after the initial argument, and which the first argument
2842 expects to receive when called."
2843 (declare (indent 2) (debug t))
2844 ;; We need those two gensyms because CL's lexical scoping is not available
2845 ;; for function arguments :-(
2846 (let ((funs (make-symbol "funs"))
2847 (global (make-symbol "global"))
2848 (argssym (make-symbol "args")))
2849 ;; Since the hook is a wrapper, the loop has to be done via
2850 ;; recursion: a given hook function will call its parameter in order to
2851 ;; continue looping.
2852 `(labels ((runrestofhook (,funs ,global ,argssym)
2853 ;; `funs' holds the functions left on the hook and `global'
2854 ;; holds the functions left on the global part of the hook
2855 ;; (in case the hook is local).
2856 (lexical-let ((funs ,funs)
2857 (global ,global))
2858 (if (consp funs)
2859 (if (eq t (car funs))
2860 (runrestofhook
2861 (append global (cdr funs)) nil ,argssym)
2862 (apply (car funs)
2863 (lambda (&rest ,argssym)
2864 (runrestofhook (cdr funs) global ,argssym))
2865 ,argssym))
2866 ;; Once there are no more functions on the hook, run
2867 ;; the original body.
2868 (apply (lambda ,args ,@body) ,argssym)))))
2869 (runrestofhook ,var
2870 ;; The global part of the hook, if any.
2871 ,(if (symbolp var)
2872 `(if (local-variable-p ',var)
2873 (default-value ',var)))
2874 (list ,@args)))))
2876 (defvar filter-buffer-substring-functions nil
2877 "Wrapper hook around `filter-buffer-substring'.
2878 The functions on this special hook are called with 4 arguments:
2879 NEXT-FUN BEG END DELETE
2880 NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2881 that performs the default operation. The other 3 arguments are like
2882 the ones passed to `filter-buffer-substring'.")
2884 (defvar buffer-substring-filters nil
2885 "List of filter functions for `filter-buffer-substring'.
2886 Each function must accept a single argument, a string, and return
2887 a string. The buffer substring is passed to the first function
2888 in the list, and the return value of each function is passed to
2889 the next. The return value of the last function is used as the
2890 return value of `filter-buffer-substring'.
2892 If this variable is nil, no filtering is performed.")
2893 (make-obsolete-variable 'buffer-substring-filters
2894 'filter-buffer-substring-functions "24.1")
2896 (defun filter-buffer-substring (beg end &optional delete)
2897 "Return the buffer substring between BEG and END, after filtering.
2898 The filtering is performed by `filter-buffer-substring-functions'.
2900 If DELETE is non-nil, the text between BEG and END is deleted
2901 from the buffer.
2903 This function should be used instead of `buffer-substring',
2904 `buffer-substring-no-properties', or `delete-and-extract-region'
2905 when you want to allow filtering to take place. For example,
2906 major or minor modes can use `filter-buffer-substring-functions' to
2907 extract characters that are special to a buffer, and should not
2908 be copied into other buffers."
2909 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2910 (cond
2911 ((or delete buffer-substring-filters)
2912 (save-excursion
2913 (goto-char beg)
2914 (let ((string (if delete (delete-and-extract-region beg end)
2915 (buffer-substring beg end))))
2916 (dolist (filter buffer-substring-filters)
2917 (setq string (funcall filter string)))
2918 string)))
2919 (t
2920 (buffer-substring beg end)))))
2923 ;;;; Window system cut and paste hooks.
2925 (defvar interprogram-cut-function nil
2926 "Function to call to make a killed region available to other programs.
2928 Most window systems provide some sort of facility for cutting and
2929 pasting text between the windows of different programs.
2930 This variable holds a function that Emacs calls whenever text
2931 is put in the kill ring, to make the new kill available to other
2932 programs.
2934 The function takes one argument, TEXT, which is a string containing
2935 the text which should be made available.")
2937 (defvar interprogram-paste-function nil
2938 "Function to call to get text cut from other programs.
2940 Most window systems provide some sort of facility for cutting and
2941 pasting text between the windows of different programs.
2942 This variable holds a function that Emacs calls to obtain
2943 text that other programs have provided for pasting.
2945 The function should be called with no arguments. If the function
2946 returns nil, then no other program has provided such text, and the top
2947 of the Emacs kill ring should be used. If the function returns a
2948 string, then the caller of the function \(usually `current-kill')
2949 should put this string in the kill ring as the latest kill.
2951 This function may also return a list of strings if the window
2952 system supports multiple selections. The first string will be
2953 used as the pasted text, but the other will be placed in the
2954 kill ring for easy access via `yank-pop'.
2956 Note that the function should return a string only if a program other
2957 than Emacs has provided a string for pasting; if Emacs provided the
2958 most recent string, the function should return nil. If it is
2959 difficult to tell whether Emacs or some other program provided the
2960 current string, it is probably good enough to return nil if the string
2961 is equal (according to `string=') to the last text Emacs provided.")
2962 \f
2965 ;;;; The kill ring data structure.
2967 (defvar kill-ring nil
2968 "List of killed text sequences.
2969 Since the kill ring is supposed to interact nicely with cut-and-paste
2970 facilities offered by window systems, use of this variable should
2971 interact nicely with `interprogram-cut-function' and
2972 `interprogram-paste-function'. The functions `kill-new',
2973 `kill-append', and `current-kill' are supposed to implement this
2974 interaction; you may want to use them instead of manipulating the kill
2975 ring directly.")
2977 (defcustom kill-ring-max 60
2978 "Maximum length of kill ring before oldest elements are thrown away."
2979 :type 'integer
2980 :group 'killing)
2982 (defvar kill-ring-yank-pointer nil
2983 "The tail of the kill ring whose car is the last thing yanked.")
2985 (defcustom save-interprogram-paste-before-kill nil
2986 "Save clipboard strings into kill ring before replacing them.
2987 When one selects something in another program to paste it into Emacs,
2988 but kills something in Emacs before actually pasting it,
2989 this selection is gone unless this variable is non-nil,
2990 in which case the other program's selection is saved in the `kill-ring'
2992 :type 'boolean
2993 :group 'killing
2994 :version "23.2")
2996 (defcustom kill-do-not-save-duplicates nil
2997 "Do not add a new string to `kill-ring' when it is the same as the last one."
2998 :type 'boolean
2999 :group 'killing
3000 :version "23.2")
3002 (defun kill-new (string &optional replace yank-handler)
3003 "Make STRING the latest kill in the kill ring.
3004 Set `kill-ring-yank-pointer' to point to it.
3005 If `interprogram-cut-function' is non-nil, apply it to STRING.
3006 Optional second argument REPLACE non-nil means that STRING will replace
3007 the front of the kill ring, rather than being added to the list.
3009 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3010 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3011 STRING.
3013 When the yank handler has a non-nil PARAM element, the original STRING
3014 argument is not used by `insert-for-yank'. However, since Lisp code
3015 may access and use elements from the kill ring directly, the STRING
3017 (if (> (length string) 0)
3018 (if yank-handler
3019 (put-text-property 0 (length string)
3020 'yank-handler yank-handler string))
3021 (if yank-handler
3022 (signal 'args-out-of-range
3023 (list string "yank-handler specified for empty string"))))
3024 (unless (and kill-do-not-save-duplicates
3025 (equal string (car kill-ring)))
3026 (if (fboundp 'menu-bar-update-yank-menu)
3027 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3028 (when save-interprogram-paste-before-kill
3029 (let ((interprogram-paste (and interprogram-paste-function
3030 (funcall interprogram-paste-function))))
3031 (when interprogram-paste
3032 (dolist (s (if (listp interprogram-paste)
3033 (nreverse interprogram-paste)
3034 (list interprogram-paste)))
3035 (unless (and kill-do-not-save-duplicates
3036 (equal s (car kill-ring)))
3037 (push s kill-ring))))))
3038 (unless (and kill-do-not-save-duplicates
3039 (equal string (car kill-ring)))
3040 (if (and replace kill-ring)
3041 (setcar kill-ring string)
3042 (push string kill-ring)
3043 (if (> (length kill-ring) kill-ring-max)
3044 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3045 (setq kill-ring-yank-pointer kill-ring)
3046 (if interprogram-cut-function
3047 (funcall interprogram-cut-function string)))
3048 (set-advertised-calling-convention
3049 'kill-new '(string &optional replace) "23.3")
3051 (defun kill-append (string before-p &optional yank-handler)
3052 "Append STRING to the end of the latest kill in the kill ring.
3053 If BEFORE-P is non-nil, prepend STRING to the kill.
3054 If `interprogram-cut-function' is set, pass the resulting kill to it."
3055 (let* ((cur (car kill-ring)))
3056 (kill-new (if before-p (concat string cur) (concat cur string))
3057 (or (= (length cur) 0)
3058 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3059 yank-handler)))
3060 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3062 (defcustom yank-pop-change-selection nil
3063 "If non-nil, rotating the kill ring changes the window system selection."
3064 :type 'boolean
3065 :group 'killing
3066 :version "23.1")
3068 (defun current-kill (n &optional do-not-move)
3069 "Rotate the yanking point by N places, and then return that kill.
3070 If N is zero, `interprogram-paste-function' is set, and calling
3071 it returns a string or list of strings, then that string (or
3072 list) is added to the front of the kill ring and the string (or
3073 first string in the list) is returned as the latest kill.
3075 If N is not zero, and if `yank-pop-change-selection' is
3076 non-nil, use `interprogram-cut-function' to transfer the
3077 kill at the new yank point into the window system selection.
3079 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3080 move the yanking point; just return the Nth kill forward."
3082 (let ((interprogram-paste (and (= n 0)
3083 interprogram-paste-function
3084 (funcall interprogram-paste-function))))
3085 (if interprogram-paste
3086 (progn
3087 ;; Disable the interprogram cut function when we add the new
3088 ;; text to the kill ring, so Emacs doesn't try to own the
3089 ;; selection, with identical text.
3090 (let ((interprogram-cut-function nil))
3091 (if (listp interprogram-paste)
3092 (mapc 'kill-new (nreverse interprogram-paste))
3093 (kill-new interprogram-paste)))
3094 (car kill-ring))
3095 (or kill-ring (error "Kill ring is empty"))
3096 (let ((ARGth-kill-element
3097 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3098 (length kill-ring))
3099 kill-ring)))
3100 (unless do-not-move
3101 (setq kill-ring-yank-pointer ARGth-kill-element)
3102 (when (and yank-pop-change-selection
3103 (> n 0)
3104 interprogram-cut-function)
3105 (funcall interprogram-cut-function (car ARGth-kill-element))))
3106 (car ARGth-kill-element)))))
3110 ;;;; Commands for manipulating the kill ring.
3112 (defcustom kill-read-only-ok nil
3113 "Non-nil means don't signal an error for killing read-only text."
3114 :type 'boolean
3115 :group 'killing)
3117 (put 'text-read-only 'error-conditions
3118 '(text-read-only buffer-read-only error))
3119 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3121 (defun kill-region (beg end &optional yank-handler)
3123 This deletes the text from the buffer and saves it in the kill ring.
3127 If you want to append the killed region to the last killed text,
3130 If the buffer is read-only, Emacs will beep and refrain from deleting
3131 the text, but put the text in the kill ring anyway. This means that
3132 you can use the killing commands to copy text from a read-only buffer.
3134 Lisp programs should use this function for killing text.
3135 (To delete text, use `delete-region'.)
3136 Supply two arguments, character positions indicating the stretch of text
3137 to be killed.
3139 If the previous command was also a kill command,
3140 the text killed this time appends to the text killed last time
3141 to make one entry in the kill ring."
3142 ;; Pass point first, then mark, because the order matters
3143 ;; when calling kill-append.
3144 (interactive (list (point) (mark)))
3145 (unless (and beg end)
3146 (error "The mark is not set now, so there is no region"))
3147 (condition-case nil
3148 (let ((string (filter-buffer-substring beg end t)))
3149 (when string ;STRING is nil if BEG = END
3150 ;; Add that string to the kill ring, one way or another.
3151 (if (eq last-command 'kill-region)
3152 (kill-append string (< end beg) yank-handler)
3153 (kill-new string nil yank-handler)))
3154 (when (or string (eq last-command 'kill-region))
3155 (setq this-command 'kill-region))
3156 nil)
3157 ((buffer-read-only text-read-only)
3158 ;; The code above failed because the buffer, or some of the characters
3159 ;; in the region, are read-only.
3160 ;; We should beep, in case the user just isn't aware of this.
3161 ;; However, there's no harm in putting
3162 ;; the region's text in the kill ring, anyway.
3163 (copy-region-as-kill beg end)
3164 ;; Set this-command now, so it will be set even if we get an error.
3165 (setq this-command 'kill-region)
3166 ;; This should barf, if appropriate, and give us the correct error.
3167 (if kill-read-only-ok
3168 (progn (message "Read only text copied to kill ring") nil)
3169 ;; Signal an error if the buffer is read-only.
3170 (barf-if-buffer-read-only)
3171 ;; If the buffer isn't read-only, the text is.
3172 (signal 'text-read-only (list (current-buffer)))))))
3173 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3175 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3176 ;; to get two copies of the text when the user accidentally types M-w and
3177 ;; then corrects it with the intended C-w.
3178 (defun copy-region-as-kill (beg end)
3179 "Save the region as if killed, but don't kill it.
3180 In Transient Mark mode, deactivate the mark.
3181 If `interprogram-cut-function' is non-nil, also save the text for a window
3182 system cut and paste.
3184 This command's old key binding has been given to `kill-ring-save'."
3185 (interactive "r")
3186 (if (eq last-command 'kill-region)
3187 (kill-append (filter-buffer-substring beg end) (< end beg))
3188 (kill-new (filter-buffer-substring beg end)))
3189 (setq deactivate-mark t)
3190 nil)
3192 (defun kill-ring-save (beg end)
3193 "Save the region as if killed, but don't kill it.
3194 In Transient Mark mode, deactivate the mark.
3195 If `interprogram-cut-function' is non-nil, also save the text for a window
3196 system cut and paste.
3198 If you want to append the killed line to the last killed text,
3201 This command is similar to `copy-region-as-kill', except that it gives
3202 visual feedback indicating the extent of the region being copied."
3203 (interactive "r")
3204 (copy-region-as-kill beg end)
3205 ;; This use of called-interactively-p is correct
3206 ;; because the code it controls just gives the user visual feedback.
3207 (if (called-interactively-p 'interactive)
3208 (let ((other-end (if (= (point) beg) end beg))
3209 (opoint (point))
3210 ;; Inhibit quitting so we can make a quit here
3211 ;; look like a C-g typed as a command.
3212 (inhibit-quit t))
3213 (if (pos-visible-in-window-p other-end (selected-window))
3214 ;; Swap point-and-mark quickly so as to show the region that
3215 ;; was selected. Don't do it if the region is highlighted.
3216 (unless (and (region-active-p)
3217 (face-background 'region))
3218 ;; Swap point and mark.
3219 (set-marker (mark-marker) (point) (current-buffer))
3220 (goto-char other-end)
3221 (sit-for blink-matching-delay)
3222 ;; Swap back.
3223 (set-marker (mark-marker) other-end (current-buffer))
3224 (goto-char opoint)
3225 ;; If user quit, deactivate the mark
3226 ;; as C-g would as a command.
3227 (and quit-flag mark-active
3228 (deactivate-mark)))
3229 (let* ((killed-text (current-kill 0))
3230 (message-len (min (length killed-text) 40)))
3231 (if (= (point) beg)
3232 ;; Don't say "killed"; that is misleading.
3234 (substring killed-text (- message-len)))
3236 (substring killed-text 0 message-len))))))))
3238 (defun append-next-kill (&optional interactive)
3239 "Cause following command, if it kills, to append to previous kill.
3240 The argument is used for internal purposes; do not supply one."
3241 (interactive "p")
3242 ;; We don't use (interactive-p), since that breaks kbd macros.
3243 (if interactive
3244 (progn
3245 (setq this-command 'kill-region)
3246 (message "If the next command is a kill, it will append"))
3247 (setq last-command 'kill-region)))
3248 \f
3249 ;; Yanking.
3251 ;; This is actually used in subr.el but defcustom does not work there.
3252 (defcustom yank-excluded-properties
3253 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3254 yank-handler follow-link fontified)
3255 "Text properties to discard when yanking.
3256 The value should be a list of text properties to discard or t,
3257 which means to discard all text properties."
3258 :type '(choice (const :tag "All" t) (repeat symbol))
3259 :group 'killing
3260 :version "22.1")
3262 (defvar yank-window-start nil)
3263 (defvar yank-undo-function nil
3264 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3265 Function is called with two parameters, START and END corresponding to
3266 the value of the mark and point; it is guaranteed that START <= END.
3267 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3269 (defun yank-pop (&optional arg)
3270 "Replace just-yanked stretch of killed text with a different stretch.
3271 This command is allowed only immediately after a `yank' or a `yank-pop'.
3272 At such a time, the region contains a stretch of reinserted
3273 previously-killed text. `yank-pop' deletes that text and inserts in its
3274 place a different stretch of killed text.
3276 With no argument, the previous kill is inserted.
3277 With argument N, insert the Nth previous kill.
3278 If N is negative, this is a more recent kill.
3280 The sequence of kills wraps around, so that after the oldest one
3281 comes the newest one.
3283 When this command inserts killed text into the buffer, it honors
3284 `yank-excluded-properties' and `yank-handler' as described in the
3285 doc string for `insert-for-yank-1', which see."
3286 (interactive "*p")
3287 (if (not (eq last-command 'yank))
3288 (error "Previous command was not a yank"))
3289 (setq this-command 'yank)
3290 (unless arg (setq arg 1))
3291 (let ((inhibit-read-only t)
3292 (before (< (point) (mark t))))
3293 (if before
3294 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3295 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3296 (setq yank-undo-function nil)
3297 (set-marker (mark-marker) (point) (current-buffer))
3298 (insert-for-yank (current-kill arg))
3299 ;; Set the window start back where it was in the yank command,
3300 ;; if possible.
3301 (set-window-start (selected-window) yank-window-start t)
3302 (if before
3303 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3304 ;; It is cleaner to avoid activation, even though the command
3305 ;; loop would deactivate the mark because we inserted text.
3306 (goto-char (prog1 (mark t)
3307 (set-marker (mark-marker) (point) (current-buffer))))))
3308 nil)
3310 (defun yank (&optional arg)
3312 More precisely, reinsert the stretch of killed text most recently
3313 killed OR yanked. Put point at end, and set mark at beginning.
3314 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3315 With argument N, reinsert the Nth most recently killed stretch of killed
3316 text.
3318 When this command inserts killed text into the buffer, it honors
3319 `yank-excluded-properties' and `yank-handler' as described in the
3320 doc string for `insert-for-yank-1', which see.
3323 (interactive "*P")
3324 (setq yank-window-start (window-start))
3325 ;; If we don't get all the way thru, make last-command indicate that
3326 ;; for the following command.
3327 (setq this-command t)
3328 (push-mark (point))
3329 (insert-for-yank (current-kill (cond
3330 ((listp arg) 0)
3331 ((eq arg '-) -2)
3332 (t (1- arg)))))
3333 (if (consp arg)
3334 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3335 ;; It is cleaner to avoid activation, even though the command
3336 ;; loop would deactivate the mark because we inserted text.
3337 (goto-char (prog1 (mark t)
3338 (set-marker (mark-marker) (point) (current-buffer)))))
3339 ;; If we do get all the way thru, make this-command indicate that.
3340 (if (eq this-command t)
3341 (setq this-command 'yank))
3342 nil)
3344 (defun rotate-yank-pointer (arg)
3345 "Rotate the yanking point in the kill ring.
3346 With ARG, rotate that many kills forward (or backward, if negative)."
3347 (interactive "p")
3348 (current-kill arg))
3349 \f
3350 ;; Some kill commands.
3352 ;; Internal subroutine of delete-char
3353 (defun kill-forward-chars (arg)
3354 (if (listp arg) (setq arg (car arg)))
3355 (if (eq arg '-) (setq arg -1))
3356 (kill-region (point) (+ (point) arg)))
3358 ;; Internal subroutine of backward-delete-char
3359 (defun kill-backward-chars (arg)
3360 (if (listp arg) (setq arg (car arg)))
3361 (if (eq arg '-) (setq arg -1))
3362 (kill-region (point) (- (point) arg)))
3364 (defcustom backward-delete-char-untabify-method 'untabify
3365 "The method for untabifying when deleting backward.
3366 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3367 `hungry' -- delete all whitespace, both tabs and spaces;
3368 `all' -- delete all whitespace, including tabs, spaces and newlines;
3369 nil -- just delete one character."
3370 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3371 :version "20.3"
3372 :group 'killing)
3374 (defun backward-delete-char-untabify (arg &optional killp)
3375 "Delete characters backward, changing tabs into spaces.
3376 The exact behavior depends on `backward-delete-char-untabify-method'.
3377 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3378 Interactively, ARG is the prefix arg (default 1)
3379 and KILLP is t if a prefix arg was specified."
3381 (when (eq backward-delete-char-untabify-method 'untabify)
3382 (let ((count arg))
3383 (save-excursion
3384 (while (and (> count 0) (not (bobp)))
3386 (let ((col (current-column)))
3387 (forward-char -1)
3388 (setq col (- col (current-column)))
3389 (insert-char ?\s col)
3390 (delete-char 1)))
3391 (forward-char -1)
3392 (setq count (1- count))))))
3393 (delete-backward-char
3395 ((eq backward-delete-char-untabify-method 'all)
3397 (if skip
3398 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3399 (point)))))
3400 (+ arg (if (zerop wh) 0 (1- wh))))
3401 arg))
3402 killp))
3404 (defun zap-to-char (arg char)
3405 "Kill up to and including ARGth occurrence of CHAR.
3406 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3407 Goes backward if ARG is negative; error if CHAR not found."
3409 ;; Avoid "obsolete" warnings for translation-table-for-input.
3410 (with-no-warnings
3411 (if (char-table-p translation-table-for-input)
3412 (setq char (or (aref translation-table-for-input char) char))))
3413 (kill-region (point) (progn
3414 (search-forward (char-to-string char) nil nil arg)
3415 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3416 (point))))
3418 ;; kill-line and its subroutines.
3420 (defcustom kill-whole-line nil
3421 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3422 :type 'boolean
3423 :group 'killing)
3425 (defun kill-line (&optional arg)
3426 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3427 With prefix argument ARG, kill that many lines from point.
3428 Negative arguments kill lines backward.
3429 With zero argument, kills the text before point on the current line.
3432 a number counts as a prefix arg.
3434 To kill a whole line, when point is not at the beginning, type \
3437 If `kill-whole-line' is non-nil, then this command kills the whole line
3438 including its terminating newline, when used at the beginning of a line
3439 with no argument. As a consequence, you can always kill a whole line
3442 If you want to append the killed line to the last killed text,
3445 If the buffer is read-only, Emacs will beep and refrain from deleting
3446 the line, but put the line in the kill ring anyway. This means that
3447 you can use this command to copy text from a read-only buffer.
3448 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3449 even beep.)"
3450 (interactive "P")
3451 (kill-region (point)
3452 ;; It is better to move point to the other end of the kill
3453 ;; before killing. That way, in a read-only buffer, point
3454 ;; moves across the text that is copied to the kill ring.
3455 ;; The choice has no effect on undo now that undo records
3456 ;; the value of point from before the command was run.
3457 (progn
3458 (if arg
3459 (forward-visible-line (prefix-numeric-value arg))
3460 (if (eobp)
3461 (signal 'end-of-buffer nil))
3462 (let ((end
3463 (save-excursion
3464 (end-of-visible-line) (point))))
3465 (if (or (save-excursion
3466 ;; If trailing whitespace is visible,
3467 ;; don't treat it as nothing.
3468 (unless show-trailing-whitespace
3470 (= (point) end))
3471 (and kill-whole-line (bolp)))
3472 (forward-visible-line 1)
3473 (goto-char end))))
3474 (point))))
3476 (defun kill-whole-line (&optional arg)
3477 "Kill current line.
3478 With prefix ARG, kill that many lines starting from the current line.
3479 If ARG is negative, kill backward. Also kill the preceding newline.
3481 If ARG is zero, kill current line but exclude the trailing newline."
3482 (interactive "p")
3483 (or arg (setq arg 1))
3484 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3485 (signal 'end-of-buffer nil))
3486 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3487 (signal 'beginning-of-buffer nil))
3488 (unless (eq last-command 'kill-region)
3489 (kill-new "")
3490 (setq last-command 'kill-region))
3491 (cond ((zerop arg)
3492 ;; We need to kill in two steps, because the previous command
3493 ;; could have been a kill command, in which case the text
3494 ;; before point needs to be prepended to the current kill
3495 ;; ring entry and the text after point appended. Also, we
3496 ;; need to use save-excursion to avoid copying the same text
3497 ;; twice to the kill ring in read-only buffers.
3498 (save-excursion
3499 (kill-region (point) (progn (forward-visible-line 0) (point))))
3500 (kill-region (point) (progn (end-of-visible-line) (point))))
3501 ((< arg 0)
3502 (save-excursion
3503 (kill-region (point) (progn (end-of-visible-line) (point))))
3504 (kill-region (point)
3505 (progn (forward-visible-line (1+ arg))
3506 (unless (bobp) (backward-char))
3507 (point))))
3508 (t
3509 (save-excursion
3510 (kill-region (point) (progn (forward-visible-line 0) (point))))
3511 (kill-region (point)
3512 (progn (forward-visible-line arg) (point))))))
3514 (defun forward-visible-line (arg)
3515 "Move forward by ARG lines, ignoring currently invisible newlines only.
3516 If ARG is negative, move backward -ARG lines.
3517 If ARG is zero, move to the beginning of the current line."
3518 (condition-case nil
3519 (if (> arg 0)
3520 (progn
3521 (while (> arg 0)
3522 (or (zerop (forward-line 1))
3523 (signal 'end-of-buffer nil))
3524 ;; If the newline we just skipped is invisible,
3525 ;; don't count it.
3526 (let ((prop
3527 (get-char-property (1- (point)) 'invisible)))
3528 (if (if (eq buffer-invisibility-spec t)
3529 prop
3530 (or (memq prop buffer-invisibility-spec)
3531 (assq prop buffer-invisibility-spec)))
3532 (setq arg (1+ arg))))
3533 (setq arg (1- arg)))
3534 ;; If invisible text follows, and it is a number of complete lines,
3535 ;; skip it.
3536 (let ((opoint (point)))
3537 (while (and (not (eobp))
3538 (let ((prop
3539 (get-char-property (point) 'invisible)))
3540 (if (eq buffer-invisibility-spec t)
3541 prop
3542 (or (memq prop buffer-invisibility-spec)
3543 (assq prop buffer-invisibility-spec)))))
3544 (goto-char
3545 (if (get-text-property (point) 'invisible)
3546 (or (next-single-property-change (point) 'invisible)
3547 (point-max))
3548 (next-overlay-change (point)))))
3549 (unless (bolp)
3550 (goto-char opoint))))
3551 (let ((first t))
3552 (while (or first (<= arg 0))
3553 (if first
3554 (beginning-of-line)
3555 (or (zerop (forward-line -1))
3556 (signal 'beginning-of-buffer nil)))
3557 ;; If the newline we just moved to is invisible,
3558 ;; don't count it.
3559 (unless (bobp)
3560 (let ((prop
3561 (get-char-property (1- (point)) 'invisible)))
3562 (unless (if (eq buffer-invisibility-spec t)
3563 prop
3564 (or (memq prop buffer-invisibility-spec)
3565 (assq prop buffer-invisibility-spec)))
3566 (setq arg (1+ arg)))))
3567 (setq first nil))
3568 ;; If invisible text follows, and it is a number of complete lines,
3569 ;; skip it.
3570 (let ((opoint (point)))
3571 (while (and (not (bobp))
3572 (let ((prop
3573 (get-char-property (1- (point)) 'invisible)))
3574 (if (eq buffer-invisibility-spec t)
3575 prop
3576 (or (memq prop buffer-invisibility-spec)
3577 (assq prop buffer-invisibility-spec)))))
3578 (goto-char
3579 (if (get-text-property (1- (point)) 'invisible)
3580 (or (previous-single-property-change (point) 'invisible)
3581 (point-min))
3582 (previous-overlay-change (point)))))
3583 (unless (bolp)
3584 (goto-char opoint)))))
3585 ((beginning-of-buffer end-of-buffer)
3586 nil)))
3588 (defun end-of-visible-line ()
3589 "Move to end of current visible line."
3590 (end-of-line)
3591 ;; If the following character is currently invisible,
3592 ;; skip all characters with that same `invisible' property value,
3593 ;; then find the next newline.
3594 (while (and (not (eobp))
3595 (save-excursion
3597 (let ((prop
3598 (get-char-property (point) 'invisible)))
3599 (if (eq buffer-invisibility-spec t)
3600 prop
3601 (or (memq prop buffer-invisibility-spec)
3602 (assq prop buffer-invisibility-spec))))))
3604 (if (get-text-property (point) 'invisible)
3605 (goto-char (next-single-property-change (point) 'invisible))
3606 (goto-char (next-overlay-change (point))))
3607 (end-of-line)))
3608 \f
3609 (defun insert-buffer (buffer)
3610 "Insert after point the contents of BUFFER.
3611 Puts mark after the inserted text.
3612 BUFFER may be a buffer or a buffer name.
3614 This function is meant for the user to run interactively.
3615 Don't call it from programs: use `insert-buffer-substring' instead!"
3616 (interactive
3617 (list
3618 (progn
3619 (barf-if-buffer-read-only)
3620 (read-buffer "Insert buffer: "
3621 (if (eq (selected-window) (next-window (selected-window)))
3622 (other-buffer (current-buffer))
3623 (window-buffer (next-window (selected-window))))
3624 t))))
3625 (push-mark
3626 (save-excursion
3627 (insert-buffer-substring (get-buffer buffer))
3628 (point)))
3629 nil)
3631 (defun append-to-buffer (buffer start end)
3632 "Append to specified buffer the text of the region.
3633 It is inserted into that buffer before its point.
3635 When calling from a program, give three arguments:
3636 BUFFER (or buffer name), START and END.
3637 START and END specify the portion of the current buffer to be copied."
3638 (interactive
3639 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3640 (region-beginning) (region-end)))
3641 (let* ((oldbuf (current-buffer))
3642 (append-to (get-buffer-create buffer))
3643 (windows (get-buffer-window-list append-to t t))
3644 point)
3645 (save-excursion
3646 (with-current-buffer append-to
3647 (setq point (point))
3648 (barf-if-buffer-read-only)
3649 (insert-buffer-substring oldbuf start end)
3650 (dolist (window windows)
3651 (when (= (window-point window) point)
3652 (set-window-point window (point))))))))
3654 (defun prepend-to-buffer (buffer start end)
3655 "Prepend to specified buffer the text of the region.
3656 It is inserted into that buffer after its point.
3658 When calling from a program, give three arguments:
3659 BUFFER (or buffer name), START and END.
3660 START and END specify the portion of the current buffer to be copied."
3662 (let ((oldbuf (current-buffer)))
3663 (with-current-buffer (get-buffer-create buffer)
3664 (barf-if-buffer-read-only)
3665 (save-excursion
3666 (insert-buffer-substring oldbuf start end)))))
3668 (defun copy-to-buffer (buffer start end)
3669 "Copy to specified buffer the text of the region.
3670 It is inserted into that buffer, replacing existing text there.
3672 When calling from a program, give three arguments:
3673 BUFFER (or buffer name), START and END.
3674 START and END specify the portion of the current buffer to be copied."
3676 (let ((oldbuf (current-buffer)))
3677 (with-current-buffer (get-buffer-create buffer)
3678 (barf-if-buffer-read-only)
3679 (erase-buffer)
3680 (save-excursion
3681 (insert-buffer-substring oldbuf start end)))))
3682 \f
3683 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3684 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3686 (defvar activate-mark-hook nil
3687 "Hook run when the mark becomes active.
3688 It is also run at the end of a command, if the mark is active and
3689 it is possible that the region may have changed.")
3691 (defvar deactivate-mark-hook nil
3692 "Hook run when the mark becomes inactive.")
3694 (defun mark (&optional force)
3695 "Return this buffer's mark value as integer, or nil if never set.
3697 In Transient Mark mode, this function signals an error if
3698 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3699 or the argument FORCE is non-nil, it disregards whether the mark
3700 is active, and returns an integer or nil in the usual way.
3702 If you are using this in an editing command, you are most likely making
3703 a mistake; see the documentation of `set-mark'."
3704 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3705 (marker-position (mark-marker))
3706 (signal 'mark-inactive nil)))
3708 (defsubst deactivate-mark (&optional force)
3709 "Deactivate the mark by setting `mark-active' to nil.
3710 Unless FORCE is non-nil, this function does nothing if Transient
3711 Mark mode is disabled.
3712 This function also runs `deactivate-mark-hook'."
3713 (when (or transient-mark-mode force)
3714 (when (and (if (eq select-active-regions 'only)
3715 (eq (car-safe transient-mark-mode) 'only)
3716 select-active-regions)
3717 (region-active-p)
3718 (display-selections-p))
3719 ;; The var `saved-region-selection', if non-nil, is the text in
3720 ;; the region prior to the last command modifying the buffer.
3721 ;; Set the selection to that, or to the current region.
3722 (cond (saved-region-selection
3723 (x-set-selection 'PRIMARY saved-region-selection)
3724 (setq saved-region-selection nil))
3725 ((/= (region-beginning) (region-end))
3726 (x-set-selection 'PRIMARY
3727 (buffer-substring-no-properties
3728 (region-beginning)
3729 (region-end))))))
3730 (if (and (null force)
3731 (or (eq transient-mark-mode 'lambda)
3732 (and (eq (car-safe transient-mark-mode) 'only)
3733 (null (cdr transient-mark-mode)))))
3734 ;; When deactivating a temporary region, don't change
3735 ;; `mark-active' or run `deactivate-mark-hook'.
3736 (setq transient-mark-mode nil)
3737 (if (eq (car-safe transient-mark-mode) 'only)
3738 (setq transient-mark-mode (cdr transient-mark-mode)))
3739 (setq mark-active nil)
3740 (run-hooks 'deactivate-mark-hook))))
3742 (defun activate-mark ()
3743 "Activate the mark."
3744 (when (mark t)
3745 (setq mark-active t)
3746 (unless transient-mark-mode
3747 (setq transient-mark-mode 'lambda))))
3749 (defun set-mark (pos)
3750 "Set this buffer's mark to POS. Don't use this function!
3751 That is to say, don't use this function unless you want
3752 the user to see that the mark has moved, and you want the previous
3753 mark position to be lost.
3755 Normally, when a new mark is set, the old one should go on the stack.
3756 This is why most applications should use `push-mark', not `set-mark'.
3758 Novice Emacs Lisp programmers often try to use the mark for the wrong
3759 purposes. The mark saves a location for the user's convenience.
3760 Most editing commands should not alter the mark.
3761 To remember a location for internal use in the Lisp program,
3762 store it in a Lisp variable. Example:
3764 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3766 (if pos
3767 (progn
3768 (setq mark-active t)
3769 (run-hooks 'activate-mark-hook)
3770 (set-marker (mark-marker) pos (current-buffer)))
3771 ;; Normally we never clear mark-active except in Transient Mark mode.
3772 ;; But when we actually clear out the mark value too, we must
3773 ;; clear mark-active in any mode.
3774 (deactivate-mark t)
3775 (set-marker (mark-marker) nil)))
3777 (defcustom use-empty-active-region nil
3779 If nil, region-aware commands treat empty regions as inactive.
3780 If non-nil, region-aware commands treat the region as active as
3781 long as the mark is active, even if the region is empty.
3783 Region-aware commands are those that act on the region if it is
3784 active and Transient Mark mode is enabled, and on the text near
3785 point otherwise."
3786 :type 'boolean
3787 :version "23.1"
3788 :group 'editing-basics)
3790 (defun use-region-p ()
3791 "Return t if the region is active and it is appropriate to act on it.
3792 This is used by commands that act specially on the region under
3793 Transient Mark mode.
3795 The return value is t if Transient Mark mode is enabled and the
3796 mark is active; furthermore, if `use-empty-active-region' is nil,
3797 the region must not be empty. Otherwise, the return value is nil.
3799 For some commands, it may be appropriate to ignore the value of
3800 `use-empty-active-region'; in that case, use `region-active-p'."
3801 (and (region-active-p)
3802 (or use-empty-active-region (> (region-end) (region-beginning)))))
3804 (defun region-active-p ()
3805 "Return t if Transient Mark mode is enabled and the mark is active.
3807 Some commands act specially on the region when Transient Mark
3808 mode is enabled. Usually, such commands should use
3809 `use-region-p' instead of this function, because `use-region-p'
3810 also checks the value of `use-empty-active-region'."
3811 (and transient-mark-mode mark-active))
3813 (defvar mark-ring nil
3814 "The list of former marks of the current buffer, most recent first.")
3815 (make-variable-buffer-local 'mark-ring)
3816 (put 'mark-ring 'permanent-local t)
3818 (defcustom mark-ring-max 16
3819 "Maximum size of mark ring. Start discarding off end if gets this big."
3820 :type 'integer
3821 :group 'editing-basics)
3823 (defvar global-mark-ring nil
3824 "The list of saved global marks, most recent first.")
3826 (defcustom global-mark-ring-max 16
3827 "Maximum size of global mark ring. \
3828 Start discarding off end if gets this big."
3829 :type 'integer
3830 :group 'editing-basics)
3832 (defun pop-to-mark-command ()
3833 "Jump to mark, and pop a new position for mark off the ring.
3834 \(Does not affect global mark ring\)."
3835 (interactive)
3836 (if (null (mark t))
3837 (error "No mark set in this buffer")
3838 (if (= (point) (mark t))
3839 (message "Mark popped"))
3840 (goto-char (mark t))
3841 (pop-mark)))
3843 (defun push-mark-command (arg &optional nomsg)
3844 "Set mark at where point is.
3845 If no prefix ARG and mark is already set there, just activate it.
3846 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3847 (interactive "P")
3848 (let ((mark (marker-position (mark-marker))))
3849 (if (or arg (null mark) (/= mark (point)))
3850 (push-mark nil nomsg t)
3851 (setq mark-active t)
3852 (run-hooks 'activate-mark-hook)
3853 (unless nomsg
3854 (message "Mark activated")))))
3856 (defcustom set-mark-command-repeat-pop nil
3859 will pop the mark twice, and
3861 will pop the mark three times.
3865 :type 'boolean
3866 :group 'editing-basics)
3868 (defcustom set-mark-default-inactive nil
3869 "If non-nil, setting the mark does not activate it.
3871 behave the same whether or not `transient-mark-mode' is enabled."
3872 :type 'boolean
3873 :group 'editing-basics
3874 :version "23.1")
3876 (defun set-mark-command (arg)
3877 "Set the mark where point is, or jump to the mark.
3878 Setting the mark also alters the region, which is the text
3879 between point and mark; this is the closest equivalent in
3882 With no prefix argument, set the mark at point, and push the
3883 old mark position on local mark ring. Also push the old mark on
3884 global mark ring, if the previous mark was set in another buffer.
3886 When Transient Mark Mode is off, immediately repeating this
3887 command activates `transient-mark-mode' temporarily.
3890 jump to the mark, and set the mark from
3891 position popped off the local mark ring \(this does not affect the global
3893 mark ring \(see `pop-global-mark'\).
3895 If `set-mark-command-repeat-pop' is non-nil, repeating
3897 off the local (or global) mark ring and jumps there.
3900 argument, unconditionally set mark where point is, even if
3901 `set-mark-command-repeat-pop' is non-nil.
3903 Novice Emacs Lisp programmers often try to use the mark for the wrong
3904 purposes. See the documentation of `set-mark' for more information."
3905 (interactive "P")
3906 (cond ((eq transient-mark-mode 'lambda)
3907 (setq transient-mark-mode nil))
3908 ((eq (car-safe transient-mark-mode) 'only)
3909 (deactivate-mark)))
3910 (cond
3911 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3912 (push-mark-command nil))
3913 ((not (eq this-command 'set-mark-command))
3914 (if arg
3915 (pop-to-mark-command)
3916 (push-mark-command t)))
3917 ((and set-mark-command-repeat-pop
3918 (eq last-command 'pop-to-mark-command))
3919 (setq this-command 'pop-to-mark-command)
3920 (pop-to-mark-command))
3921 ((and set-mark-command-repeat-pop
3922 (eq last-command 'pop-global-mark)
3923 (not arg))
3924 (setq this-command 'pop-global-mark)
3925 (pop-global-mark))
3926 (arg
3927 (setq this-command 'pop-to-mark-command)
3928 (pop-to-mark-command))
3929 ((eq last-command 'set-mark-command)
3930 (if (region-active-p)
3931 (progn
3932 (deactivate-mark)
3933 (message "Mark deactivated"))
3934 (activate-mark)
3935 (message "Mark activated")))
3936 (t
3937 (push-mark-command nil)
3938 (if set-mark-default-inactive (deactivate-mark)))))
3940 (defun push-mark (&optional location nomsg activate)
3941 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3942 If the last global mark pushed was not in the current buffer,
3943 also push LOCATION on the global mark ring.
3944 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3946 Novice Emacs Lisp programmers often try to use the mark for the wrong
3947 purposes. See the documentation of `set-mark' for more information.
3949 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3950 (unless (null (mark t))
3951 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3952 (when (> (length mark-ring) mark-ring-max)
3953 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3954 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3955 (set-marker (mark-marker) (or location (point)) (current-buffer))
3956 ;; Now push the mark on the global mark ring.
3957 (if (and global-mark-ring
3958 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3959 ;; The last global mark pushed was in this same buffer.
3960 ;; Don't push another one.
3961 nil
3962 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3963 (when (> (length global-mark-ring) global-mark-ring-max)
3964 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3965 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3966 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3967 (message "Mark set"))
3968 (if (or activate (not transient-mark-mode))
3969 (set-mark (mark t)))
3970 nil)
3972 (defun pop-mark ()
3973 "Pop off mark ring into the buffer's actual mark.
3974 Does not set point. Does nothing if mark ring is empty."
3975 (when mark-ring
3976 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3977 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3978 (move-marker (car mark-ring) nil)
3979 (if (null (mark t)) (ding))
3980 (setq mark-ring (cdr mark-ring)))
3981 (deactivate-mark))
3983 (define-obsolete-function-alias
3984 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
3985 (defun exchange-point-and-mark (&optional arg)
3986 "Put the mark where point is now, and point where the mark is now.
3987 This command works even when the mark is not active,
3988 and it reactivates the mark.
3990 If Transient Mark mode is on, a prefix ARG deactivates the mark
3991 if it is active, and otherwise avoids reactivating it. If
3992 Transient Mark mode is off, a prefix ARG enables Transient Mark
3993 mode temporarily."
3994 (interactive "P")
3995 (let ((omark (mark t))
3996 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
3997 (if (null omark)
3998 (error "No mark set in this buffer"))
3999 (deactivate-mark)
4000 (set-mark (point))
4001 (goto-char omark)
4002 (if set-mark-default-inactive (deactivate-mark))
4003 (cond (temp-highlight
4004 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4005 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4006 (not (or arg (region-active-p))))
4007 (deactivate-mark))
4008 (t (activate-mark)))
4009 nil))
4011 (defcustom shift-select-mode t
4012 "When non-nil, shifted motion keys activate the mark momentarily.
4014 While the mark is activated in this way, any shift-translated point
4015 motion key extends the region, and if Transient Mark mode was off, it
4016 is temporarily turned on. Furthermore, the mark will be deactivated
4017 by any subsequent point motion key that was not shift-translated, or
4018 by any action that normally deactivates the mark in Transient Mark mode.
4020 See `this-command-keys-shift-translated' for the meaning of
4021 shift-translation."
4022 :type 'boolean
4023 :group 'editing-basics)
4025 (defun handle-shift-selection ()
4026 "Activate/deactivate mark depending on invocation thru shift translation.
4027 This function is called by `call-interactively' when a command
4028 with a `^' character in its `interactive' spec is invoked, before
4029 running the command itself.
4031 If `shift-select-mode' is enabled and the command was invoked
4032 through shift translation, set the mark and activate the region
4033 temporarily, unless it was already set in this way. See
4034 `this-command-keys-shift-translated' for the meaning of shift
4035 translation.
4037 Otherwise, if the region has been activated temporarily,
4038 deactivate it, and restore the variable `transient-mark-mode' to
4039 its earlier value."
4040 (cond ((and shift-select-mode this-command-keys-shift-translated)
4041 (unless (and mark-active
4042 (eq (car-safe transient-mark-mode) 'only))
4043 (setq transient-mark-mode
4044 (cons 'only
4045 (unless (eq transient-mark-mode 'lambda)
4046 transient-mark-mode)))
4047 (push-mark nil nil t)))
4048 ((eq (car-safe transient-mark-mode) 'only)
4049 (setq transient-mark-mode (cdr transient-mark-mode))
4050 (deactivate-mark))))
4052 (define-minor-mode transient-mark-mode
4053 "Toggle Transient Mark mode.
4054 With ARG, turn Transient Mark mode on if ARG is positive, off otherwise.
4056 In Transient Mark mode, when the mark is active, the region is highlighted.
4058 So do certain other operations that set the mark
4059 but whose main purpose is something else--for example,
4065 Many commands change their behavior when Transient Mark mode is in effect
4066 and the mark is active, by acting on the region instead of their usual
4067 default part of the buffer's text. Examples of such commands include
4072 commands which are sensitive to the Transient Mark mode."
4073 :global t
4074 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4075 :variable transient-mark-mode)
4077 (defvar widen-automatically t
4078 "Non-nil means it is ok for commands to call `widen' when they want to.
4079 Some commands will do this in order to go to positions outside
4080 the current accessible part of the buffer.
4082 If `widen-automatically' is nil, these commands will do something else
4083 as a fallback, and won't change the buffer bounds.")
4085 (defvar non-essential nil
4086 "Whether the currently executing code is performing an essential task.
4087 This variable should be non-nil only when running code which should not
4088 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4089 user for a password when we are simply scanning a set of files in the
4090 background or displaying possible completions before the user even asked
4091 for it.")
4093 (defun pop-global-mark ()
4094 "Pop off global mark ring and jump to the top location."
4095 (interactive)
4096 ;; Pop entries which refer to non-existent buffers.
4097 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4098 (setq global-mark-ring (cdr global-mark-ring)))
4099 (or global-mark-ring
4100 (error "No global mark set"))
4101 (let* ((marker (car global-mark-ring))
4102 (buffer (marker-buffer marker))
4103 (position (marker-position marker)))
4104 (setq global-mark-ring (nconc (cdr global-mark-ring)
4105 (list (car global-mark-ring))))
4106 (set-buffer buffer)
4107 (or (and (>= position (point-min))
4108 (<= position (point-max)))
4109 (if widen-automatically
4110 (widen)
4111 (error "Global mark position is outside accessible part of buffer")))
4112 (goto-char position)
4113 (switch-to-buffer buffer)))
4114 \f
4115 (defcustom next-line-add-newlines nil
4116 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4117 :type 'boolean
4118 :version "21.1"
4119 :group 'editing-basics)
4121 (defun next-line (&optional arg try-vscroll)
4122 "Move cursor vertically down ARG lines.
4123 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4124 If there is no character in the target line exactly under the current column,
4125 the cursor is positioned after the character in that line which spans this
4126 column, or at the end of the line if it is not long enough.
4127 If there is no line in the buffer after this one, behavior depends on the
4128 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4129 to create a line, and moves the cursor to that line. Otherwise it moves the
4130 cursor to the end of the buffer.
4132 If the variable `line-move-visual' is non-nil, this command moves
4133 by display lines. Otherwise, it moves by buffer lines, without
4134 taking variable-width characters or continued lines into account.
4137 a semipermanent goal column for this command.
4138 Then instead of trying to move exactly vertically (or as close as possible),
4139 this command moves to the specified goal column (or as close as possible).
4140 The goal column is stored in the variable `goal-column', which is nil
4141 when there is no goal column.
4143 If you are thinking of using this in a Lisp program, consider
4144 using `forward-line' instead. It is usually easier to use
4145 and more reliable (no dependence on goal column, etc.)."
4147 (or arg (setq arg 1))
4148 (if (and next-line-add-newlines (= arg 1))
4149 (if (save-excursion (end-of-line) (eobp))
4150 ;; When adding a newline, don't expand an abbrev.
4151 (let ((abbrev-mode nil))
4152 (end-of-line)
4154 (line-move arg nil nil try-vscroll))
4155 (if (called-interactively-p 'interactive)
4156 (condition-case err
4157 (line-move arg nil nil try-vscroll)
4158 ((beginning-of-buffer end-of-buffer)
4159 (signal (car err) (cdr err))))
4160 (line-move arg nil nil try-vscroll)))
4161 nil)
4163 (defun previous-line (&optional arg try-vscroll)
4164 "Move cursor vertically up ARG lines.
4165 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4166 If there is no character in the target line exactly over the current column,
4167 the cursor is positioned after the character in that line which spans this
4168 column, or at the end of the line if it is not long enough.
4170 If the variable `line-move-visual' is non-nil, this command moves
4171 by display lines. Otherwise, it moves by buffer lines, without
4172 taking variable-width characters or continued lines into account.
4175 a semipermanent goal column for this command.
4176 Then instead of trying to move exactly vertically (or as close as possible),
4177 this command moves to the specified goal column (or as close as possible).
4178 The goal column is stored in the variable `goal-column', which is nil
4179 when there is no goal column.
4181 If you are thinking of using this in a Lisp program, consider using
4182 `forward-line' with a negative argument instead. It is usually easier
4183 to use and more reliable (no dependence on goal column, etc.)."
4185 (or arg (setq arg 1))
4186 (if (called-interactively-p 'interactive)
4187 (condition-case err
4188 (line-move (- arg) nil nil try-vscroll)
4189 ((beginning-of-buffer end-of-buffer)
4190 (signal (car err) (cdr err))))
4191 (line-move (- arg) nil nil try-vscroll))
4192 nil)
4194 (defcustom track-eol nil
4195 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4196 This means moving to the end of each line moved onto.
4197 The beginning of a blank line does not count as the end of a line.
4198 This has no effect when `line-move-visual' is non-nil."
4199 :type 'boolean
4200 :group 'editing-basics)
4202 (defcustom goal-column nil
4204 :type '(choice integer
4205 (const :tag "None" nil))
4206 :group 'editing-basics)
4207 (make-variable-buffer-local 'goal-column)
4209 (defvar temporary-goal-column 0
4210 "Current goal column for vertical motion.
4211 It is the column where point was at the start of the current run
4212 of vertical motion commands.
4214 When moving by visual lines via `line-move-visual', it is a cons
4215 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4216 divided by the default column width, and HSCROLL is the number of
4217 columns by which window is scrolled from left margin.
4219 When the `track-eol' feature is doing its job, the value is
4220 `most-positive-fixnum'.")
4222 (defcustom line-move-ignore-invisible t
4224 Outline mode sets this."
4225 :type 'boolean
4226 :group 'editing-basics)
4228 (defcustom line-move-visual t
4229 "When non-nil, `line-move' moves point by visual lines.
4230 This movement is based on where the cursor is displayed on the
4231 screen, instead of relying on buffer contents alone. It takes
4232 into account variable-width characters and line continuation.
4233 If nil, `line-move' moves point by logical lines."
4234 :type 'boolean
4235 :group 'editing-basics
4236 :version "23.1")
4238 ;; Returns non-nil if partial move was done.
4239 (defun line-move-partial (arg noerror to-end)
4240 (if (< arg 0)
4241 ;; Move backward (up).
4242 ;; If already vscrolled, reduce vscroll
4243 (let ((vs (window-vscroll nil t)))
4244 (when (> vs (frame-char-height))
4245 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4247 ;; Move forward (down).
4248 (let* ((lh (window-line-height -1))
4249 (vpos (nth 1 lh))
4250 (ypos (nth 2 lh))
4251 (rbot (nth 3 lh))
4252 py vs)
4253 (when (or (null lh)
4254 (>= rbot (frame-char-height))
4255 (<= ypos (- (frame-char-height))))
4256 (unless lh
4257 (let ((wend (pos-visible-in-window-p t nil t)))
4258 (setq rbot (nth 3 wend)
4259 vpos (nth 5 wend))))
4260 (cond
4261 ;; If last line of window is fully visible, move forward.
4262 ((or (null rbot) (= rbot 0))
4263 nil)
4264 ;; If cursor is not in the bottom scroll margin, move forward.
4265 ((and (> vpos 0)
4266 (< (setq py
4267 (or (nth 1 (window-line-height))
4268 (let ((ppos (posn-at-point)))
4269 (cdr (or (posn-actual-col-row ppos)
4270 (posn-col-row ppos))))))
4271 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4272 nil)
4273 ;; When already vscrolled, we vscroll some more if we can,
4274 ;; or clear vscroll and move forward at end of tall image.
4275 ((> (setq vs (window-vscroll nil t)) 0)
4276 (when (> rbot 0)
4277 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4278 ;; If cursor just entered the bottom scroll margin, move forward,
4279 ;; but also vscroll one line so redisplay wont recenter.
4280 ((and (> vpos 0)
4281 (= py (min (- (window-text-height) scroll-margin 1)
4282 (1- vpos))))
4283 (set-window-vscroll nil (frame-char-height) t)
4284 (line-move-1 arg noerror to-end)
4285 t)
4286 ;; If there are lines above the last line, scroll-up one line.
4287 ((> vpos 0)
4288 (scroll-up 1)
4289 t)
4290 ;; Finally, start vscroll.
4291 (t
4292 (set-window-vscroll nil (frame-char-height) t)))))))
4295 ;; This is like line-move-1 except that it also performs
4296 ;; vertical scrolling of tall images if appropriate.
4297 ;; That is not really a clean thing to do, since it mixes
4298 ;; scrolling with cursor motion. But so far we don't have
4299 ;; a cleaner solution to the problem of making C-n do something
4300 ;; useful given a tall image.
4301 (defun line-move (arg &optional noerror to-end try-vscroll)
4302 (unless (and auto-window-vscroll try-vscroll
4303 ;; Only vscroll for single line moves
4304 (= (abs arg) 1)
4305 ;; But don't vscroll in a keyboard macro.
4306 (not defining-kbd-macro)
4307 (not executing-kbd-macro)
4308 (line-move-partial arg noerror to-end))
4309 (set-window-vscroll nil 0 t)
4310 (if line-move-visual
4311 (line-move-visual arg noerror)
4312 (line-move-1 arg noerror to-end))))
4314 ;; Display-based alternative to line-move-1.
4315 ;; Arg says how many lines to move. The value is t if we can move the
4316 ;; specified number of lines.
4317 (defun line-move-visual (arg &optional noerror)
4318 (let ((opoint (point))
4319 (hscroll (window-hscroll))
4320 target-hscroll)
4321 ;; Check if the previous command was a line-motion command, or if
4322 ;; we were called from some other command.
4323 (if (and (consp temporary-goal-column)
4324 (memq last-command `(next-line previous-line ,this-command)))
4325 ;; If so, there's no need to reset `temporary-goal-column',
4326 ;; but we may need to hscroll.
4327 (if (or (/= (cdr temporary-goal-column) hscroll)
4328 (> (cdr temporary-goal-column) 0))
4329 (setq target-hscroll (cdr temporary-goal-column)))
4330 ;; Otherwise, we should reset `temporary-goal-column'.
4331 (let ((posn (posn-at-point)))
4332 (cond
4333 ;; Handle the `overflow-newline-into-fringe' case:
4334 ((eq (nth 1 posn) 'right-fringe)
4335 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4336 ((car (posn-x-y posn))
4337 (setq temporary-goal-column
4338 (cons (/ (float (car (posn-x-y posn)))
4339 (frame-char-width)) hscroll))))))
4340 (if target-hscroll
4341 (set-window-hscroll (selected-window) target-hscroll))
4342 (or (and (= (vertical-motion
4343 (cons (or goal-column
4344 (if (consp temporary-goal-column)
4345 (car temporary-goal-column)
4346 temporary-goal-column))
4347 arg))
4348 arg)
4349 (or (>= arg 0)
4350 (/= (point) opoint)
4351 ;; If the goal column lies on a display string,
4352 ;; `vertical-motion' advances the cursor to the end
4353 ;; of the string. For arg < 0, this can cause the
4354 ;; cursor to get stuck. (Bug#3020).
4355 (= (vertical-motion arg) arg)))
4356 (unless noerror
4357 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4358 nil)))))
4360 ;; This is the guts of next-line and previous-line.
4361 ;; Arg says how many lines to move.
4362 ;; The value is t if we can move the specified number of lines.
4363 (defun line-move-1 (arg &optional noerror to-end)
4364 ;; Don't run any point-motion hooks, and disregard intangibility,
4365 ;; for intermediate positions.
4366 (let ((inhibit-point-motion-hooks t)
4367 (opoint (point))
4368 (orig-arg arg))
4369 (if (consp temporary-goal-column)
4370 (setq temporary-goal-column (+ (car temporary-goal-column)
4371 (cdr temporary-goal-column))))
4372 (unwind-protect
4373 (progn
4374 (if (not (memq last-command '(next-line previous-line)))
4375 (setq temporary-goal-column
4376 (if (and track-eol (eolp)
4377 ;; Don't count beg of empty line as end of line
4378 ;; unless we just did explicit end-of-line.
4379 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4380 most-positive-fixnum
4381 (current-column))))
4383 (if (not (or (integerp selective-display)
4384 line-move-ignore-invisible))
4385 ;; Use just newline characters.
4386 ;; Set ARG to 0 if we move as many lines as requested.
4387 (or (if (> arg 0)
4388 (progn (if (> arg 1) (forward-line (1- arg)))
4389 ;; This way of moving forward ARG lines
4390 ;; verifies that we have a newline after the last one.
4391 ;; It doesn't get confused by intangible text.
4392 (end-of-line)
4393 (if (zerop (forward-line 1))
4394 (setq arg 0)))
4395 (and (zerop (forward-line arg))
4396 (bolp)
4397 (setq arg 0)))
4398 (unless noerror
4399 (signal (if (< arg 0)
4400 'beginning-of-buffer
4401 'end-of-buffer)
4402 nil)))
4403 ;; Move by arg lines, but ignore invisible ones.
4404 (let (done)
4405 (while (and (> arg 0) (not done))
4406 ;; If the following character is currently invisible,
4407 ;; skip all characters with that same `invisible' property value.
4408 (while (and (not (eobp)) (invisible-p (point)))
4409 (goto-char (next-char-property-change (point))))
4410 ;; Move a line.
4411 ;; We don't use `end-of-line', since we want to escape
4412 ;; from field boundaries occurring exactly at point.
4413 (goto-char (constrain-to-field
4414 (let ((inhibit-field-text-motion t))
4415 (line-end-position))
4416 (point) t t
4417 'inhibit-line-move-field-capture))
4418 ;; If there's no invisibility here, move over the newline.
4419 (cond
4420 ((eobp)
4421 (if (not noerror)
4422 (signal 'end-of-buffer nil)
4423 (setq done t)))
4424 ((and (> arg 1) ;; Use vertical-motion for last move
4425 (not (integerp selective-display))
4426 (not (invisible-p (point))))
4427 ;; We avoid vertical-motion when possible
4428 ;; because that has to fontify.
4429 (forward-line 1))
4430 ;; Otherwise move a more sophisticated way.
4431 ((zerop (vertical-motion 1))
4432 (if (not noerror)
4433 (signal 'end-of-buffer nil)
4434 (setq done t))))
4435 (unless done
4436 (setq arg (1- arg))))
4437 ;; The logic of this is the same as the loop above,
4438 ;; it just goes in the other direction.
4439 (while (and (< arg 0) (not done))
4440 ;; For completely consistency with the forward-motion
4441 ;; case, we should call beginning-of-line here.
4442 ;; However, if point is inside a field and on a
4443 ;; continued line, the call to (vertical-motion -1)
4444 ;; below won't move us back far enough; then we return
4445 ;; to the same column in line-move-finish, and point
4446 ;; gets stuck -- cyd
4447 (forward-line 0)
4448 (cond
4449 ((bobp)
4450 (if (not noerror)
4451 (signal 'beginning-of-buffer nil)
4452 (setq done t)))
4453 ((and (< arg -1) ;; Use vertical-motion for last move
4454 (not (integerp selective-display))
4455 (not (invisible-p (1- (point)))))
4456 (forward-line -1))
4457 ((zerop (vertical-motion -1))
4458 (if (not noerror)
4459 (signal 'beginning-of-buffer nil)
4460 (setq done t))))
4461 (unless done
4462 (setq arg (1+ arg))
4463 (while (and ;; Don't move over previous invis lines
4464 ;; if our target is the middle of this line.
4465 (or (zerop (or goal-column temporary-goal-column))
4466 (< arg 0))
4467 (not (bobp)) (invisible-p (1- (point))))
4468 (goto-char (previous-char-property-change (point))))))))
4469 ;; This is the value the function returns.
4470 (= arg 0))
4472 (cond ((> arg 0)
4473 ;; If we did not move down as far as desired, at least go
4474 ;; to end of line. Be sure to call point-entered and
4475 ;; point-left-hooks.
4476 (let* ((npoint (prog1 (line-end-position)
4477 (goto-char opoint)))
4478 (inhibit-point-motion-hooks nil))
4479 (goto-char npoint)))
4480 ((< arg 0)
4481 ;; If we did not move up as far as desired,
4482 ;; at least go to beginning of line.
4483 (let* ((npoint (prog1 (line-beginning-position)
4484 (goto-char opoint)))
4485 (inhibit-point-motion-hooks nil))
4486 (goto-char npoint)))
4487 (t
4488 (line-move-finish (or goal-column temporary-goal-column)
4489 opoint (> orig-arg 0)))))))
4491 (defun line-move-finish (column opoint forward)
4492 (let ((repeat t))
4493 (while repeat
4494 ;; Set REPEAT to t to repeat the whole thing.
4495 (setq repeat nil)
4497 (let (new
4498 (old (point))
4499 (line-beg (line-beginning-position))
4500 (line-end
4501 ;; Compute the end of the line
4502 ;; ignoring effectively invisible newlines.
4503 (save-excursion
4504 ;; Like end-of-line but ignores fields.
4506 (while (and (not (eobp)) (invisible-p (point)))
4507 (goto-char (next-char-property-change (point)))
4509 (point))))
4511 ;; Move to the desired column.
4512 (line-move-to-column (truncate column))
4514 ;; Corner case: suppose we start out in a field boundary in
4515 ;; the middle of a continued line. When we get to
4516 ;; line-move-finish, point is at the start of a new *screen*
4517 ;; line but the same text line; then line-move-to-column would
4518 ;; move us backwards. Test using C-n with point on the "x" in
4519 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4520 (and forward
4521 (< (point) old)
4522 (goto-char old))
4524 (setq new (point))
4526 ;; Process intangibility within a line.
4527 ;; With inhibit-point-motion-hooks bound to nil, a call to
4528 ;; goto-char moves point past intangible text.
4530 ;; However, inhibit-point-motion-hooks controls both the
4531 ;; intangibility and the point-entered/point-left hooks. The
4532 ;; following hack avoids calling the point-* hooks
4533 ;; unnecessarily. Note that we move *forward* past intangible
4534 ;; text when the initial and final points are the same.
4535 (goto-char new)
4536 (let ((inhibit-point-motion-hooks nil))
4537 (goto-char new)
4539 ;; If intangibility moves us to a different (later) place
4540 ;; in the same line, use that as the destination.
4541 (if (<= (point) line-end)
4542 (setq new (point))
4543 ;; If that position is "too late",
4544 ;; try the previous allowable position.
4545 ;; See if it is ok.
4546 (backward-char)
4547 (if (if forward
4548 ;; If going forward, don't accept the previous
4549 ;; allowable position if it is before the target line.
4550 (< line-beg (point))
4551 ;; If going backward, don't accept the previous
4552 ;; allowable position if it is still after the target line.
4553 (<= (point) line-end))
4554 (setq new (point))
4555 ;; As a last resort, use the end of the line.
4556 (setq new line-end))))
4558 ;; Now move to the updated destination, processing fields
4559 ;; as well as intangibility.
4560 (goto-char opoint)
4561 (let ((inhibit-point-motion-hooks nil))
4562 (goto-char
4563 ;; Ignore field boundaries if the initial and final
4564 ;; positions have the same `field' property, even if the
4565 ;; fields are non-contiguous. This seems to be "nicer"
4566 ;; behavior in many situations.
4567 (if (eq (get-char-property new 'field)
4568 (get-char-property opoint 'field))
4569 new
4570 (constrain-to-field new opoint t t
4571 'inhibit-line-move-field-capture))))
4573 ;; If all this moved us to a different line,
4574 ;; retry everything within that new line.
4575 (when (or (< (point) line-beg) (> (point) line-end))
4576 ;; Repeat the intangibility and field processing.
4577 (setq repeat t))))))
4579 (defun line-move-to-column (col)
4580 "Try to find column COL, considering invisibility.
4581 This function works only in certain cases,
4582 because what we really need is for `move-to-column'
4583 and `current-column' to be able to ignore invisible text."
4584 (if (zerop col)
4585 (beginning-of-line)
4586 (move-to-column col))
4588 (when (and line-move-ignore-invisible
4589 (not (bolp)) (invisible-p (1- (point))))
4590 (let ((normal-location (point))
4591 (normal-column (current-column)))
4592 ;; If the following character is currently invisible,
4593 ;; skip all characters with that same `invisible' property value.
4594 (while (and (not (eobp))
4595 (invisible-p (point)))
4596 (goto-char (next-char-property-change (point))))
4597 ;; Have we advanced to a larger column position?
4598 (if (> (current-column) normal-column)
4599 ;; We have made some progress towards the desired column.
4600 ;; See if we can make any further progress.
4601 (line-move-to-column (+ (current-column) (- col normal-column)))
4602 ;; Otherwise, go to the place we originally found
4603 ;; and move back over invisible text.
4604 ;; that will get us to the same place on the screen
4605 ;; but with a more reasonable buffer position.
4606 (goto-char normal-location)
4607 (let ((line-beg (line-beginning-position)))
4608 (while (and (not (bolp)) (invisible-p (1- (point))))
4609 (goto-char (previous-char-property-change (point) line-beg))))))))
4611 (defun move-end-of-line (arg)
4612 "Move point to end of current line as displayed.
4613 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4614 If point reaches the beginning or end of buffer, it stops there.
4616 To ignore the effects of the `intangible' text or overlay
4617 property, bind `inhibit-point-motion-hooks' to t.
4618 If there is an image in the current line, this function
4619 disregards newlines that are part of the text on which the image
4620 rests."
4621 (interactive "^p")
4622 (or arg (setq arg 1))
4623 (let (done)
4624 (while (not done)
4625 (let ((newpos
4626 (save-excursion
4627 (let ((goal-column 0)
4628 (line-move-visual nil))
4629 (and (line-move arg t)
4630 ;; With bidi reordering, we may not be at bol,
4631 ;; so make sure we are.
4633 (not (bobp))
4634 (progn
4635 (while (and (not (bobp)) (invisible-p (1- (point))))
4636 (goto-char (previous-single-char-property-change
4637 (point) 'invisible)))
4638 (backward-char 1)))
4639 (point)))))
4640 (goto-char newpos)
4641 (if (and (> (point) newpos)
4643 (backward-char 1)
4644 (if (and (> (point) newpos) (not (eobp))
4646 ;; If we skipped something intangible and now we're not
4647 ;; really at eol, keep going.
4648 (setq arg 1)
4649 (setq done t)))))))
4651 (defun move-beginning-of-line (arg)
4652 "Move point to beginning of current line as displayed.
4653 \(If there's an image in the line, this disregards newlines
4654 which are part of the text that the image rests on.)
4656 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4657 If point reaches the beginning or end of buffer, it stops there.
4658 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4659 (interactive "^p")
4660 (or arg (setq arg 1))
4662 (let ((orig (point))
4663 first-vis first-vis-field-value)
4665 ;; Move by lines, if ARG is not 1 (the default).
4666 (if (/= arg 1)
4667 (let ((line-move-visual nil))
4668 (line-move (1- arg) t)))
4670 ;; Move to beginning-of-line, ignoring fields and invisibles.
4672 (while (and (not (bobp)) (invisible-p (1- (point))))
4673 (goto-char (previous-char-property-change (point)))
4676 ;; Now find first visible char in the line
4677 (while (and (not (eobp)) (invisible-p (point)))
4678 (goto-char (next-char-property-change (point))))
4679 (setq first-vis (point))
4681 ;; See if fields would stop us from reaching FIRST-VIS.
4682 (setq first-vis-field-value
4683 (constrain-to-field first-vis orig (/= arg 1) t nil))
4685 (goto-char (if (/= first-vis-field-value first-vis)
4686 ;; If yes, obey them.
4687 first-vis-field-value
4688 ;; Otherwise, move to START with attention to fields.
4689 ;; (It is possible that fields never matter in this case.)
4690 (constrain-to-field (point) orig
4691 (/= arg 1) t nil)))))
4694 ;; Many people have said they rarely use this feature, and often type
4695 ;; it by accident. Maybe it shouldn't even be on a key.
4696 (put 'set-goal-column 'disabled t)
4698 (defun set-goal-column (arg)
4700 Those commands will move to this position in the line moved to
4701 rather than trying to keep the same horizontal position.
4702 With a non-nil argument ARG, clears out the goal column
4704 The goal column is stored in the variable `goal-column'."
4705 (interactive "P")
4706 (if arg
4707 (progn
4708 (setq goal-column nil)
4709 (message "No goal column"))
4710 (setq goal-column (current-column))
4711 ;; The older method below can be erroneous if `set-goal-column' is bound
4712 ;; to a sequence containing %
4713 ;;(message (substitute-command-keys
4715 ;;goal-column)
4716 (message "%s"
4717 (concat
4718 (format "Goal column %d " goal-column)
4719 (substitute-command-keys
4722 )
4723 nil)
4724 \f
4725 ;;; Editing based on visual lines, as opposed to logical lines.
4727 (defun end-of-visual-line (&optional n)
4728 "Move point to end of current visual line.
4729 With argument N not nil or 1, move forward N - 1 visual lines first.
4730 If point reaches the beginning or end of buffer, it stops there.
4731 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4732 (interactive "^p")
4733 (or n (setq n 1))
4734 (if (/= n 1)
4735 (let ((line-move-visual t))
4736 (line-move (1- n) t)))
4737 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4738 ;; constrain to field boundaries, so we don't either.
4739 (vertical-motion (cons (window-width) 0)))
4741 (defun beginning-of-visual-line (&optional n)
4742 "Move point to beginning of current visual line.
4743 With argument N not nil or 1, move forward N - 1 visual lines first.
4744 If point reaches the beginning or end of buffer, it stops there.
4745 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4746 (interactive "^p")
4747 (or n (setq n 1))
4748 (let ((opoint (point)))
4749 (if (/= n 1)
4750 (let ((line-move-visual t))
4751 (line-move (1- n) t)))
4752 (vertical-motion 0)
4753 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4754 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4756 (defun kill-visual-line (&optional arg)
4757 "Kill the rest of the visual line.
4758 With prefix argument ARG, kill that many visual lines from point.
4759 If ARG is negative, kill visual lines backward.
4760 If ARG is zero, kill the text before point on the current visual
4761 line.
4763 If you want to append the killed line to the last killed text,
4766 If the buffer is read-only, Emacs will beep and refrain from deleting
4767 the line, but put the line in the kill ring anyway. This means that
4768 you can use this command to copy text from a read-only buffer.
4769 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4770 even beep.)"
4771 (interactive "P")
4772 ;; Like in `kill-line', it's better to move point to the other end
4773 ;; of the kill before killing.
4774 (let ((opoint (point))
4775 (kill-whole-line (and kill-whole-line (bolp))))
4776 (if arg
4777 (vertical-motion (prefix-numeric-value arg))
4778 (end-of-visual-line 1)
4779 (if (= (point) opoint)
4780 (vertical-motion 1)
4781 ;; Skip any trailing whitespace at the end of the visual line.
4782 ;; We used to do this only if `show-trailing-whitespace' is
4783 ;; nil, but that's wrong; the correct thing would be to check
4784 ;; whether the trailing whitespace is highlighted. But, it's
4785 ;; OK to just do this unconditionally.
4788 (1+ (point))
4789 (point)))))
4791 (defun next-logical-line (&optional arg try-vscroll)
4792 "Move cursor vertically down ARG lines.
4793 This is identical to `next-line', except that it always moves
4794 by logical lines instead of visual lines, ignoring the value of
4795 the variable `line-move-visual'."
4797 (let ((line-move-visual nil))
4798 (with-no-warnings
4799 (next-line arg try-vscroll))))
4801 (defun previous-logical-line (&optional arg try-vscroll)
4802 "Move cursor vertically up ARG lines.
4803 This is identical to `previous-line', except that it always moves
4804 by logical lines instead of visual lines, ignoring the value of
4805 the variable `line-move-visual'."
4807 (let ((line-move-visual nil))
4808 (with-no-warnings
4809 (previous-line arg try-vscroll))))
4811 (defgroup visual-line nil
4812 "Editing based on visual lines."
4813 :group 'convenience
4814 :version "23.1")
4816 (defvar visual-line-mode-map
4817 (let ((map (make-sparse-keymap)))
4818 (define-key map [remap kill-line] 'kill-visual-line)
4819 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4820 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4821 ;; These keybindings interfere with xterm function keys. Are
4822 ;; there any other suitable bindings?
4823 ;; (define-key map "\M-[" 'previous-logical-line)
4824 ;; (define-key map "\M-]" 'next-logical-line)
4825 map))
4827 (defcustom visual-line-fringe-indicators '(nil nil)
4828 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4829 The value should be a list of the form (LEFT RIGHT), where LEFT
4830 and RIGHT are symbols representing the bitmaps to display, to
4831 indicate wrapped lines, in the left and right fringes respectively.
4832 See also `fringe-indicator-alist'.
4833 The default is not to display fringe indicators for wrapped lines.
4834 This variable does not affect fringe indicators displayed for
4835 other purposes."
4836 :type '(list (choice (const :tag "Hide left indicator" nil)
4837 (const :tag "Left curly arrow" left-curly-arrow)
4838 (symbol :tag "Other bitmap"))
4839 (choice (const :tag "Hide right indicator" nil)
4840 (const :tag "Right curly arrow" right-curly-arrow)
4841 (symbol :tag "Other bitmap")))
4842 :set (lambda (symbol value)
4843 (dolist (buf (buffer-list))
4844 (with-current-buffer buf
4845 (when (and (boundp 'visual-line-mode)
4846 (symbol-value 'visual-line-mode))
4847 (setq fringe-indicator-alist
4848 (cons (cons 'continuation value)
4849 (assq-delete-all
4850 'continuation
4851 (copy-tree fringe-indicator-alist)))))))
4852 (set-default symbol value)))
4854 (defvar visual-line--saved-state nil)
4856 (define-minor-mode visual-line-mode
4857 "Redefine simple editing commands to act on visual lines, not logical lines.
4858 This also turns on `word-wrap' in the buffer."
4859 :keymap visual-line-mode-map
4860 :group 'visual-line
4861 :lighter " Wrap"
4862 (if visual-line-mode
4863 (progn
4864 (set (make-local-variable 'visual-line--saved-state) nil)
4865 ;; Save the local values of some variables, to be restored if
4866 ;; visual-line-mode is turned off.
4867 (dolist (var '(line-move-visual truncate-lines
4868 truncate-partial-width-windows
4869 word-wrap fringe-indicator-alist))
4870 (if (local-variable-p var)
4871 (push (cons var (symbol-value var))
4872 visual-line--saved-state)))
4873 (set (make-local-variable 'line-move-visual) t)
4874 (set (make-local-variable 'truncate-partial-width-windows) nil)
4875 (setq truncate-lines nil
4876 word-wrap t
4877 fringe-indicator-alist
4878 (cons (cons 'continuation visual-line-fringe-indicators)
4879 fringe-indicator-alist)))
4880 (kill-local-variable 'line-move-visual)
4881 (kill-local-variable 'word-wrap)
4882 (kill-local-variable 'truncate-lines)
4883 (kill-local-variable 'truncate-partial-width-windows)
4884 (kill-local-variable 'fringe-indicator-alist)
4885 (dolist (saved visual-line--saved-state)
4886 (set (make-local-variable (car saved)) (cdr saved)))
4887 (kill-local-variable 'visual-line--saved-state)))
4889 (defun turn-on-visual-line-mode ()
4890 (visual-line-mode 1))
4892 (define-globalized-minor-mode global-visual-line-mode
4893 visual-line-mode turn-on-visual-line-mode
4894 :lighter " vl")
4896 \f
4897 (defun transpose-chars (arg)
4898 "Interchange characters around point, moving forward one character.
4899 With prefix arg ARG, effect is to take character before point
4900 and drag it forward past ARG other characters (backward if ARG negative).
4901 If no argument and at end of line, the previous two chars are exchanged."
4902 (interactive "*P")
4903 (and (null arg) (eolp) (forward-char -1))
4904 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4906 (defun transpose-words (arg)
4907 "Interchange words around point, leaving point at end of them.
4908 With prefix arg ARG, effect is to take word before or around point
4909 and drag it forward past ARG other words (backward if ARG negative).
4910 If ARG is zero, the words around or after point and around or after mark
4911 are interchanged."
4912 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4913 (interactive "*p")
4914 (transpose-subr 'forward-word arg))
4916 (defun transpose-sexps (arg)
4918 Does not work on a sexp that point is in the middle of
4919 if it is a list or string."
4920 (interactive "*p")
4921 (transpose-subr
4922 (lambda (arg)
4923 ;; Here we should try to simulate the behavior of
4924 ;; (cons (progn (forward-sexp x) (point))
4925 ;; (progn (forward-sexp (- x)) (point)))
4926 ;; Except that we don't want to rely on the second forward-sexp
4927 ;; putting us back to where we want to be, since forward-sexp-function
4928 ;; might do funny things like infix-precedence.
4929 (if (if (> arg 0)
4931 (and (not (bobp))
4933 ;; Jumping over a symbol. We might be inside it, mind you.
4934 (progn (funcall (if (> arg 0)
4935 'skip-syntax-backward 'skip-syntax-forward)
4936 "w_")
4937 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4938 ;; Otherwise, we're between sexps. Take a step back before jumping
4939 ;; to make sure we'll obey the same precedence no matter which direction
4940 ;; we're going.
4941 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4942 (cons (save-excursion (forward-sexp arg) (point))
4943 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4944 (not (zerop (funcall (if (> arg 0)
4945 'skip-syntax-forward
4946 'skip-syntax-backward)
4947 ".")))))
4948 (point)))))
4949 arg 'special))
4951 (defun transpose-lines (arg)
4952 "Exchange current line and previous line, leaving point after both.
4953 With argument ARG, takes previous line and moves it past ARG lines.
4954 With argument 0, interchanges line point is in with line mark is in."
4955 (interactive "*p")
4956 (transpose-subr (function
4957 (lambda (arg)
4958 (if (> arg 0)
4959 (progn
4960 ;; Move forward over ARG lines,
4961 ;; but create newlines if necessary.
4962 (setq arg (forward-line arg))
4964 (setq arg (1+ arg)))
4965 (if (> arg 0)
4966 (newline arg)))
4967 (forward-line arg))))
4968 arg))
4970 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
4971 ;; which seems inconsistent with the ARG /= 0 case.
4972 ;; FIXME document SPECIAL.
4973 (defun transpose-subr (mover arg &optional special)
4974 "Subroutine to do the work of transposing objects.
4975 Works for lines, sentences, paragraphs, etc. MOVER is a function that
4976 moves forward by units of the given object (e.g. forward-sentence,
4977 forward-paragraph). If ARG is zero, exchanges the current object
4978 with the one containing mark. If ARG is an integer, moves the
4979 current object past ARG following (if ARG is positive) or
4980 preceding (if ARG is negative) objects, leaving point after the
4981 current object."
4982 (let ((aux (if special mover
4983 (lambda (x)
4984 (cons (progn (funcall mover x) (point))
4985 (progn (funcall mover (- x)) (point))))))
4986 pos1 pos2)
4987 (cond
4988 ((= arg 0)
4989 (save-excursion
4990 (setq pos1 (funcall aux 1))
4991 (goto-char (or (mark) (error "No mark set in this buffer")))
4992 (setq pos2 (funcall aux 1))
4993 (transpose-subr-1 pos1 pos2))
4994 (exchange-point-and-mark))
4995 ((> arg 0)
4996 (setq pos1 (funcall aux -1))
4997 (setq pos2 (funcall aux arg))
4998 (transpose-subr-1 pos1 pos2)
4999 (goto-char (car pos2)))
5000 (t
5001 (setq pos1 (funcall aux -1))
5002 (goto-char (car pos1))
5003 (setq pos2 (funcall aux arg))
5004 (transpose-subr-1 pos1 pos2)))))
5006 (defun transpose-subr-1 (pos1 pos2)
5007 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5008 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5009 (when (> (car pos1) (car pos2))
5010 (let ((swap pos1))
5011 (setq pos1 pos2 pos2 swap)))
5012 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5013 (atomic-change-group
5014 (let (word2)
5015 ;; FIXME: We first delete the two pieces of text, so markers that
5016 ;; used to point to after the text end up pointing to before it :-(
5017 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5018 (goto-char (car pos2))
5019 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5020 (goto-char (car pos1))
5021 (insert word2))))
5022 \f
5023 (defun backward-word (&optional arg)
5024 "Move backward until encountering the beginning of a word.
5025 With argument ARG, do this that many times."
5026 (interactive "^p")
5027 (forward-word (- (or arg 1))))
5029 (defun mark-word (&optional arg allow-extend)
5030 "Set mark ARG words away from point.
5032 move to with the same argument.
5033 Interactively, if this command is repeated
5034 or (in Transient Mark mode) if the mark is active,
5035 it marks the next ARG words after the ones already marked."
5037 (cond ((and allow-extend
5038 (or (and (eq last-command this-command) (mark t))
5039 (region-active-p)))
5040 (setq arg (if arg (prefix-numeric-value arg)
5041 (if (< (mark) (point)) -1 1)))
5042 (set-mark
5043 (save-excursion
5044 (goto-char (mark))
5045 (forward-word arg)
5046 (point))))
5047 (t
5048 (push-mark
5049 (save-excursion
5050 (forward-word (prefix-numeric-value arg))
5051 (point))
5052 nil t))))
5054 (defun kill-word (arg)
5055 "Kill characters forward until encountering the end of a word.
5056 With argument ARG, do this that many times."
5057 (interactive "p")
5058 (kill-region (point) (progn (forward-word arg) (point))))
5060 (defun backward-kill-word (arg)
5061 "Kill characters backward until encountering the beginning of a word.
5062 With argument ARG, do this that many times."
5063 (interactive "p")
5064 (kill-word (- arg)))
5066 (defun current-word (&optional strict really-word)
5067 "Return the symbol or word that point is on (or a nearby one) as a string.
5068 The return value includes no text properties.
5069 If optional arg STRICT is non-nil, return nil unless point is within
5070 or adjacent to a symbol or word. In all cases the value can be nil
5071 if there is no word nearby.
5072 The function, belying its name, normally finds a symbol.
5073 If optional arg REALLY-WORD is non-nil, it finds just a word."
5074 (save-excursion
5075 (let* ((oldpoint (point)) (start (point)) (end (point))
5076 (syntaxes (if really-word "w" "w_"))
5077 (not-syntaxes (concat "^" syntaxes)))
5078 (skip-syntax-backward syntaxes) (setq start (point))
5079 (goto-char oldpoint)
5080 (skip-syntax-forward syntaxes) (setq end (point))
5081 (when (and (eq start oldpoint) (eq end oldpoint)
5082 ;; Point is neither within nor adjacent to a word.
5083 (not strict))
5084 ;; Look for preceding word in same line.
5085 (skip-syntax-backward not-syntaxes (line-beginning-position))
5086 (if (bolp)
5087 ;; No preceding word in same line.
5088 ;; Look for following word in same line.
5089 (progn
5090 (skip-syntax-forward not-syntaxes (line-end-position))
5091 (setq start (point))
5092 (skip-syntax-forward syntaxes)
5093 (setq end (point)))
5094 (setq end (point))
5095 (skip-syntax-backward syntaxes)
5096 (setq start (point))))
5097 ;; If we found something nonempty, return it as a string.
5098 (unless (= start end)
5099 (buffer-substring-no-properties start end)))))
5100 \f
5101 (defcustom fill-prefix nil
5102 "String for filling to insert at front of new line, or nil for none."
5103 :type '(choice (const :tag "None" nil)
5104 string)
5105 :group 'fill)
5106 (make-variable-buffer-local 'fill-prefix)
5107 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5109 (defcustom auto-fill-inhibit-regexp nil
5110 "Regexp to match lines which should not be auto-filled."
5111 :type '(choice (const :tag "None" nil)
5112 regexp)
5113 :group 'fill)
5115 (defun do-auto-fill ()
5116 "The default value for `normal-auto-fill-function'.
5117 This is the default auto-fill function, some major modes use a different one.
5118 Returns t if it really did any work."
5119 (let (fc justify give-up
5120 (fill-prefix fill-prefix))
5121 (if (or (not (setq justify (current-justification)))
5122 (null (setq fc (current-fill-column)))
5123 (and (eq justify 'left)
5124 (<= (current-column) fc))
5125 (and auto-fill-inhibit-regexp
5126 (save-excursion (beginning-of-line)
5127 (looking-at auto-fill-inhibit-regexp))))
5128 nil ;; Auto-filling not required
5129 (if (memq justify '(full center right))
5130 (save-excursion (unjustify-current-line)))
5132 ;; Choose a fill-prefix automatically.
5133 (when (and adaptive-fill-mode
5134 (or (null fill-prefix) (string= fill-prefix "")))
5135 (let ((prefix
5136 (fill-context-prefix
5137 (save-excursion (backward-paragraph 1) (point))
5138 (save-excursion (forward-paragraph 1) (point)))))
5139 (and prefix (not (equal prefix ""))
5140 ;; Use auto-indentation rather than a guessed empty prefix.
5141 (not (and fill-indent-according-to-mode
5143 (setq fill-prefix prefix))))
5145 (while (and (not give-up) (> (current-column) fc))
5146 ;; Determine where to split the line.
5147 (let* (after-prefix
5148 (fill-point
5149 (save-excursion
5150 (beginning-of-line)
5151 (setq after-prefix (point))
5152 (and fill-prefix
5153 (looking-at (regexp-quote fill-prefix))
5154 (setq after-prefix (match-end 0)))
5155 (move-to-column (1+ fc))
5156 (fill-move-to-break-point after-prefix)
5157 (point))))
5159 ;; See whether the place we found is any good.
5160 (if (save-excursion
5161 (goto-char fill-point)
5162 (or (bolp)
5163 ;; There is no use breaking at end of line.
5164 (save-excursion (skip-chars-forward " ") (eolp))
5165 ;; It is futile to split at the end of the prefix
5166 ;; since we would just insert the prefix again.
5167 (and after-prefix (<= (point) after-prefix))
5168 ;; Don't split right after a comment starter
5169 ;; since we would just make another comment starter.
5170 (and comment-start-skip
5171 (let ((limit (point)))
5172 (beginning-of-line)
5173 (and (re-search-forward comment-start-skip
5174 limit t)
5175 (eq (point) limit))))))
5176 ;; No good place to break => stop trying.
5177 (setq give-up t)
5178 ;; Ok, we have a useful place to break the line. Do it.
5179 (let ((prev-column (current-column)))
5180 ;; If point is at the fill-point, do not `save-excursion'.
5181 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5182 ;; point will end up before it rather than after it.
5183 (if (save-excursion
5185 (= (point) fill-point))
5186 (default-indent-new-line t)
5187 (save-excursion
5188 (goto-char fill-point)
5189 (default-indent-new-line t)))
5190 ;; Now do justification, if required
5191 (if (not (eq justify 'left))
5192 (save-excursion
5193 (end-of-line 0)
5194 (justify-current-line justify nil t)))
5195 ;; If making the new line didn't reduce the hpos of
5196 ;; the end of the line, then give up now;
5197 ;; trying again will not help.
5198 (if (>= (current-column) prev-column)
5199 (setq give-up t))))))
5200 ;; Justify last line.
5201 (justify-current-line justify t t)
5202 t)))
5204 (defvar comment-line-break-function 'comment-indent-new-line
5205 "*Mode-specific function which line breaks and continues a comment.
5206 This function is called during auto-filling when a comment syntax
5207 is defined.
5208 The function should take a single optional argument, which is a flag
5209 indicating whether it should use soft newlines.")
5211 (defun default-indent-new-line (&optional soft)
5212 "Break line at point and indent.
5213 If a comment syntax is defined, call `comment-indent-new-line'.
5215 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5216 unless optional argument SOFT is non-nil."
5217 (interactive)
5218 (if comment-start
5219 (funcall comment-line-break-function soft)
5220 ;; Insert the newline before removing empty space so that markers
5221 ;; get preserved better.
5223 (save-excursion (forward-char -1) (delete-horizontal-space))
5224 (delete-horizontal-space)
5226 (if (and fill-prefix (not adaptive-fill-mode))
5227 ;; Blindly trust a non-adaptive fill-prefix.
5228 (progn
5229 (indent-to-left-margin)
5230 (insert-before-markers-and-inherit fill-prefix))
5232 (cond
5233 ;; If there's an adaptive prefix, use it unless we're inside
5234 ;; a comment and the prefix is not a comment starter.
5235 (fill-prefix
5236 (indent-to-left-margin)
5237 (insert-and-inherit fill-prefix))
5238 ;; If we're not inside a comment, just try to indent.
5239 (t (indent-according-to-mode))))))
5241 (defvar normal-auto-fill-function 'do-auto-fill
5242 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5243 Some major modes set this.")
5245 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5246 ;; `functions' and `hooks' are usually unsafe to set, but setting
5247 ;; auto-fill-function to nil in a file-local setting is safe and
5248 ;; can be useful to prevent auto-filling.
5249 (put 'auto-fill-function 'safe-local-variable 'null)
5250 ;; FIXME: turn into a proper minor mode.
5251 ;; Add a global minor mode version of it.
5252 (define-minor-mode auto-fill-mode
5253 "Toggle Auto Fill mode.
5254 With ARG, turn Auto Fill mode on if and only if ARG is positive.
5255 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
5256 automatically breaks the line at a previous space.
5258 The value of `normal-auto-fill-function' specifies the function to use
5259 for `auto-fill-function' when turning Auto Fill mode on."
5260 :variable (eq auto-fill-function normal-auto-fill-function))
5262 ;; This holds a document string used to document auto-fill-mode.
5263 (defun auto-fill-function ()
5264 "Automatically break line at a previous space, in insertion of text."
5265 nil)
5267 (defun turn-on-auto-fill ()
5268 "Unconditionally turn on Auto Fill mode."
5269 (auto-fill-mode 1))
5271 (defun turn-off-auto-fill ()
5272 "Unconditionally turn off Auto Fill mode."
5273 (auto-fill-mode -1))
5275 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5277 (defun set-fill-column (arg)
5278 "Set `fill-column' to specified argument.
5281 (interactive
5282 (list (or current-prefix-arg
5283 ;; We used to use current-column silently, but C-x f is too easily
5284 ;; typed as a typo for C-x C-f, so we turned it into an error and
5285 ;; now an interactive prompt.
5286 (read-number "Set fill-column to: " (current-column)))))
5287 (if (consp arg)
5288 (setq arg (current-column)))
5289 (if (not (integerp arg))
5290 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5291 (error "set-fill-column requires an explicit argument")
5292 (message "Fill column set to %d (was %d)" arg fill-column)
5293 (setq fill-column arg)))
5294 \f
5295 (defun set-selective-display (arg)
5296 "Set `selective-display' to ARG; clear it if no arg.
5297 When the value of `selective-display' is a number > 0,
5298 lines whose indentation is >= that value are not displayed.
5299 The variable `selective-display' has a separate value for each buffer."
5300 (interactive "P")
5301 (if (eq selective-display t)
5302 (error "selective-display already in use for marked lines"))
5303 (let ((current-vpos
5304 (save-restriction
5305 (narrow-to-region (point-min) (point))
5306 (goto-char (window-start))
5307 (vertical-motion (window-height)))))
5308 (setq selective-display
5309 (and arg (prefix-numeric-value arg)))
5310 (recenter current-vpos))
5311 (set-window-start (selected-window) (window-start (selected-window)))
5312 (princ "selective-display set to " t)
5313 (prin1 selective-display t)
5314 (princ "." t))
5316 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5318 (defun toggle-truncate-lines (&optional arg)
5319 "Toggle whether to fold or truncate long lines for the current buffer.
5320 With prefix argument ARG, truncate long lines if ARG is positive,
5321 otherwise don't truncate them. Note that in side-by-side windows,
5322 this command has no effect if `truncate-partial-width-windows'
5323 is non-nil."
5324 (interactive "P")
5325 (setq truncate-lines
5326 (if (null arg)
5327 (not truncate-lines)
5328 (> (prefix-numeric-value arg) 0)))
5329 (force-mode-line-update)
5330 (unless truncate-lines
5331 (let ((buffer (current-buffer)))
5332 (walk-windows (lambda (window)
5333 (if (eq buffer (window-buffer window))
5334 (set-window-hscroll window 0)))
5335 nil t)))
5336 (message "Truncate long lines %s"
5337 (if truncate-lines "enabled" "disabled")))
5339 (defun toggle-word-wrap (&optional arg)
5340 "Toggle whether to use word-wrapping for continuation lines.
5341 With prefix argument ARG, wrap continuation lines at word boundaries
5342 if ARG is positive, otherwise wrap them at the right screen edge.
5343 This command toggles the value of `word-wrap'. It has no effect
5344 if long lines are truncated."
5345 (interactive "P")
5346 (setq word-wrap
5347 (if (null arg)
5348 (not word-wrap)
5349 (> (prefix-numeric-value arg) 0)))
5350 (force-mode-line-update)
5351 (message "Word wrapping %s"
5352 (if word-wrap "enabled" "disabled")))
5354 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5355 "The string displayed in the mode line when in overwrite mode.")
5356 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5357 "The string displayed in the mode line when in binary overwrite mode.")
5359 (define-minor-mode overwrite-mode
5360 "Toggle overwrite mode.
5361 With prefix argument ARG, turn overwrite mode on if ARG is positive,
5362 otherwise turn it off. In overwrite mode, printing characters typed
5363 in replace existing text on a one-for-one basis, rather than pushing
5364 it to the right. At the end of a line, such characters extend the line.
5365 Before a tab, such characters insert until the tab is filled in.
5367 is supposed to make it easier to insert characters when necessary."
5368 :variable (eq overwrite-mode 'overwrite-mode-textual))
5370 (define-minor-mode binary-overwrite-mode
5371 "Toggle binary overwrite mode.
5372 With prefix argument ARG, turn binary overwrite mode on if ARG is
5373 positive, otherwise turn it off. In binary overwrite mode, printing
5374 characters typed in replace existing text. Newlines are not treated
5375 specially, so typing at the end of a line joins the line to the next,
5376 with the typed character between them. Typing before a tab character
5378 replaces the text at the cursor, just as ordinary typing characters do.
5380 Note that binary overwrite mode is not its own minor mode; it is a
5381 specialization of overwrite mode, entered by setting the
5382 `overwrite-mode' variable to `overwrite-mode-binary'."
5383 :variable (eq overwrite-mode 'overwrite-mode-binary))
5385 (define-minor-mode line-number-mode
5386 "Toggle Line Number mode.
5387 With ARG, turn Line Number mode on if ARG is positive, otherwise
5388 turn it off. When Line Number mode is enabled, the line number
5389 appears in the mode line.
5391 Line numbers do not appear for very large buffers and buffers
5392 with very long lines; see variables `line-number-display-limit'
5393 and `line-number-display-limit-width'."
5394 :init-value t :global t :group 'mode-line)
5396 (define-minor-mode column-number-mode
5397 "Toggle Column Number mode.
5398 With ARG, turn Column Number mode on if ARG is positive,
5399 otherwise turn it off. When Column Number mode is enabled, the
5400 column number appears in the mode line."
5401 :global t :group 'mode-line)
5403 (define-minor-mode size-indication-mode
5404 "Toggle Size Indication mode.
5405 With ARG, turn Size Indication mode on if ARG is positive,
5406 otherwise turn it off. When Size Indication mode is enabled, the
5407 size of the accessible part of the buffer appears in the mode line."
5408 :global t :group 'mode-line)
5410 (define-minor-mode auto-save-mode
5411 "Toggle auto-saving of contents of current buffer.
5412 With prefix argument ARG, turn auto-saving on if positive, else off."
5413 :variable ((and buffer-auto-save-file-name
5414 ;; If auto-save is off because buffer has shrunk,
5415 ;; then toggling should turn it on.
5416 (>= buffer-saved-size 0))
5417 . (lambda (val)
5418 (setq buffer-auto-save-file-name
5419 (cond
5420 ((null val) nil)
5421 ((and buffer-file-name auto-save-visited-file-name
5422 (not buffer-read-only))
5423 buffer-file-name)
5424 (t (make-auto-save-file-name))))))
5425 ;; If -1 was stored here, to temporarily turn off saving,
5426 ;; turn it back on.
5427 (and (< buffer-saved-size 0)
5428 (setq buffer-saved-size 0)))
5429 \f
5430 (defgroup paren-blinking nil
5431 "Blinking matching of parens and expressions."
5432 :prefix "blink-matching-"
5433 :group 'paren-matching)
5435 (defcustom blink-matching-paren t
5436 "Non-nil means show matching open-paren when close-paren is inserted."
5437 :type 'boolean
5438 :group 'paren-blinking)
5440 (defcustom blink-matching-paren-on-screen t
5441 "Non-nil means show matching open-paren when it is on screen.
5442 If nil, don't show it (but the open-paren can still be shown
5443 when it is off screen).
5445 This variable has no effect if `blink-matching-paren' is nil.
5446 \(In that case, the open-paren is never shown.)
5447 It is also ignored if `show-paren-mode' is enabled."
5448 :type 'boolean
5449 :group 'paren-blinking)
5451 (defcustom blink-matching-paren-distance (* 100 1024)
5452 "If non-nil, maximum distance to search backwards for matching open-paren.
5453 If nil, search stops at the beginning of the accessible portion of the buffer."
5454 :version "23.2" ; 25->100k
5455 :type '(choice (const nil) integer)
5456 :group 'paren-blinking)
5458 (defcustom blink-matching-delay 1
5459 "Time in seconds to delay after showing a matching paren."
5460 :type 'number
5461 :group 'paren-blinking)
5463 (defcustom blink-matching-paren-dont-ignore-comments nil
5464 "If nil, `blink-matching-paren' ignores comments.
5465 More precisely, when looking for the matching parenthesis,
5466 it skips the contents of comments that end before point."
5467 :type 'boolean
5468 :group 'paren-blinking)
5470 (defun blink-matching-check-mismatch (start end)
5471 "Return whether or not START...END are matching parens.
5472 END is the current point and START is the blink position.
5473 START might be nil if no matching starter was found.
5474 Returns non-nil if we find there is a mismatch."
5475 (let* ((end-syntax (syntax-after (1- end)))
5476 (matching-paren (and (consp end-syntax)
5477 (eq (syntax-class end-syntax) 5)
5478 (cdr end-syntax))))
5479 ;; For self-matched chars like " and $, we can't know when they're
5480 ;; mismatched or unmatched, so we can only do it for parens.
5481 (when matching-paren
5482 (not (and start
5483 (or
5484 (eq (char-after start) matching-paren)
5485 ;; The cdr might hold a new paren-class info rather than
5486 ;; a matching-char info, in which case the two CDRs
5487 ;; should match.
5488 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5490 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5491 "Function to check parentheses mismatches.
5492 The function takes two arguments (START and END) where START is the
5493 position just before the opening token and END is the position right after.
5494 START can be nil, if it was not found.
5495 The function should return non-nil if the two tokens do not match.")
5497 (defun blink-matching-open ()
5498 "Move cursor momentarily to the beginning of the sexp before point."
5499 (interactive)
5500 (when (and (not (bobp))
5501 blink-matching-paren)
5502 (let* ((oldpos (point))
5503 (message-log-max nil) ; Don't log messages about paren matching.
5504 (blinkpos
5505 (save-excursion
5506 (save-restriction
5507 (if blink-matching-paren-distance
5508 (narrow-to-region
5509 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5510 (- (point) blink-matching-paren-distance))
5511 oldpos))
5512 (let ((parse-sexp-ignore-comments
5513 (and parse-sexp-ignore-comments
5514 (not blink-matching-paren-dont-ignore-comments))))
5515 (condition-case ()
5516 (progn
5517 (forward-sexp -1)
5518 ;; backward-sexp skips backward over prefix chars,
5519 ;; so move back to the matching paren.
5520 (while (and (< (point) (1- oldpos))
5521 (let ((code (syntax-after (point))))
5522 (or (eq (syntax-class code) 6)
5523 (eq (logand 1048576 (car code))
5524 1048576))))
5525 (forward-char 1))
5526 (point))
5527 (error nil))))))
5528 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5529 (cond
5530 (mismatch
5531 (if blinkpos
5532 (if (minibufferp)
5533 (minibuffer-message " [Mismatched parentheses]")
5534 (message "Mismatched parentheses"))
5535 (if (minibufferp)
5536 (minibuffer-message " [Unmatched parenthesis]")
5537 (message "Unmatched parenthesis"))))
5538 ((not blinkpos) nil)
5539 ((pos-visible-in-window-p blinkpos)
5540 ;; Matching open within window, temporarily move to blinkpos but only
5541 ;; if `blink-matching-paren-on-screen' is non-nil.
5542 (and blink-matching-paren-on-screen
5543 (not show-paren-mode)
5544 (save-excursion
5545 (goto-char blinkpos)
5546 (sit-for blink-matching-delay))))
5547 (t
5548 (save-excursion
5549 (goto-char blinkpos)
5550 (let ((open-paren-line-string
5551 ;; Show what precedes the open in its line, if anything.
5552 (cond
5554 (buffer-substring (line-beginning-position)
5555 (1+ blinkpos)))
5556 ;; Show what follows the open in its line, if anything.
5557 ((save-excursion
5558 (forward-char 1)
5560 (not (eolp)))
5561 (buffer-substring blinkpos
5562 (line-end-position)))
5563 ;; Otherwise show the previous nonblank line,
5564 ;; if there is one.
5566 (concat
5567 (buffer-substring (progn
5569 (line-beginning-position))
5570 (progn (end-of-line)
5572 (point)))
5573 ;; Replace the newline and other whitespace with `...'.
5574 "..."
5575 (buffer-substring blinkpos (1+ blinkpos))))
5576 ;; There is nothing to show except the char itself.
5577 (t (buffer-substring blinkpos (1+ blinkpos))))))
5578 (message "Matches %s"
5579 (substring-no-properties open-paren-line-string)))))))))
5581 (defvar blink-paren-function 'blink-matching-open
5582 "Function called, if non-nil, whenever a close parenthesis is inserted.
5583 More precisely, a char with closeparen syntax is self-inserted.")
5585 (defun blink-paren-post-self-insert-function ()
5586 (when (and (eq (char-before) last-command-event) ; Sanity check.
5587 (memq (char-syntax last-command-event) '(?\) ?\$))
5588 blink-paren-function
5589 (not executing-kbd-macro)
5590 (not noninteractive)
5591 ;; Verify an even number of quoting characters precede the close.
5592 (= 1 (logand 1 (- (point)
5593 (save-excursion
5594 (forward-char -1)
5596 (point))))))
5597 (funcall blink-paren-function)))
5599 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5600 ;; Most likely, this hook is nil, so this arg doesn't matter,
5601 ;; but I use it as a reminder that this function usually
5602 ;; likes to be run after others since it does `sit-for'.
5603 'append)
5604 \f
5605 ;; This executes C-g typed while Emacs is waiting for a command.
5606 ;; Quitting out of a program does not go through here;
5607 ;; that happens in the QUIT macro at the C code level.
5608 (defun keyboard-quit ()
5609 "Signal a `quit' condition.
5610 During execution of Lisp code, this character causes a quit directly.
5611 At top-level, as an editor command, this simply beeps."
5612 (interactive)
5613 ;; Avoid adding the region to the window selection.
5614 (setq saved-region-selection nil)
5615 (let (select-active-regions)
5616 (deactivate-mark))
5617 (if (fboundp 'kmacro-keyboard-quit)
5618 (kmacro-keyboard-quit))
5619 (setq defining-kbd-macro nil)
5620 (signal 'quit nil))
5622 (defvar buffer-quit-function nil
5625 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5627 (defun keyboard-escape-quit ()
5629 This command can exit an interactive command such as `query-replace',
5630 can clear out a prefix argument or a region,
5631 can get out of the minibuffer or other recursive edit,
5632 cancel the use of the current buffer (for special-purpose buffers),
5633 or go back to just one window (by deleting all but the selected window)."
5634 (interactive)
5635 (cond ((eq last-command 'mode-exited) nil)
5636 ((region-active-p)
5637 (deactivate-mark))
5638 ((> (minibuffer-depth) 0)
5639 (abort-recursive-edit))
5640 (current-prefix-arg
5641 nil)
5642 ((> (recursion-depth) 0)
5643 (exit-recursive-edit))
5644 (buffer-quit-function
5645 (funcall buffer-quit-function))
5646 ((not (one-window-p t))
5647 (delete-other-windows))
5649 (bury-buffer))))
5651 (defun play-sound-file (file &optional volume device)
5652 "Play sound stored in FILE.
5653 VOLUME and DEVICE correspond to the keywords of the sound
5654 specification for `play-sound'."
5655 (interactive "fPlay sound file: ")
5656 (let ((sound (list :file file)))
5657 (if volume
5658 (plist-put sound :volume volume))
5659 (if device
5660 (plist-put sound :device device))
5661 (push 'sound sound)
5662 (play-sound sound)))
5664 \f
5665 (defcustom read-mail-command 'rmail
5666 "Your preference for a mail reading package.
5667 This is used by some keybindings which support reading mail.
5668 See also `mail-user-agent' concerning sending mail."
5671 (function-item :tag "Emacs interface to MH"
5673 (function :tag "Other"))
5674 :version "21.1"
5675 :group 'mail)
5677 (defcustom mail-user-agent 'message-user-agent
5678 "Your preference for a mail composition package.
5679 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5680 outgoing email message. This variable lets you specify which
5681 mail-sending package you prefer.
5683 Valid values include:
5685 `message-user-agent' -- use the Message package.
5686 See Info node `(message)'.
5687 `sendmail-user-agent' -- use the Mail package.
5688 See Info node `(emacs)Sending Mail'.
5689 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5690 See Info node `(mh-e)'.
5691 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5692 paraphernalia, particularly the Gcc: header for
5693 archiving.
5695 Additional valid symbols may be available; check with the author of
5696 your package for details. The function should return non-nil if it
5697 succeeds.
5699 See also `read-mail-command' concerning reading mail."
5700 :type '(radio (function-item :tag "Message package"
5702 message-user-agent)
5703 (function-item :tag "Mail package"
5705 sendmail-user-agent)
5706 (function-item :tag "Emacs interface to MH"
5708 mh-e-user-agent)
5709 (function-item :tag "Message with full Gnus features"
5711 gnus-user-agent)
5712 (function :tag "Other"))
5713 :version "23.2" ; sendmail->message
5714 :group 'mail)
5716 (defcustom compose-mail-user-agent-warnings t
5717 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5718 If the value of `mail-user-agent' is the default, and the user
5719 appears to have customizations applying to the old default,
5720 `compose-mail' issues a warning."
5721 :type 'boolean
5722 :version "23.2"
5723 :group 'mail)
5725 (defun rfc822-goto-eoh ()
5726 "If the buffer starts with a mail header, move point to the header's end.
5727 Otherwise, moves to `point-min'.
5728 The end of the header is the start of the next line, if there is one,
5729 else the end of the last line. This function obeys RFC822."
5730 (goto-char (point-min))
5731 (when (re-search-forward
5733 (goto-char (match-beginning 0))))
5735 (defun compose-mail (&optional to subject other-headers continue
5736 switch-function yank-action send-actions
5737 return-action)
5738 "Start composing a mail message to send.
5739 This uses the user's chosen mail composition package
5740 as selected with the variable `mail-user-agent'.
5741 The optional arguments TO and SUBJECT specify recipients
5742 and the initial Subject field, respectively.
5744 OTHER-HEADERS is an alist specifying additional
5745 header fields. Elements look like (HEADER . VALUE) where both
5746 HEADER and VALUE are strings.
5748 CONTINUE, if non-nil, says to continue editing a message already
5749 being composed. Interactively, CONTINUE is the prefix argument.
5751 SWITCH-FUNCTION, if non-nil, is a function to use to
5752 switch to and display the buffer used for mail composition.
5754 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5755 to insert the raw text of the message being replied to.
5756 It has the form (FUNCTION . ARGS). The user agent will apply
5757 FUNCTION to ARGS, to insert the raw text of the original message.
5758 \(The user agent will also run `mail-citation-hook', *after* the
5759 original text has been inserted in this way.)
5761 SEND-ACTIONS is a list of actions to call when the message is sent.
5762 Each action has the form (FUNCTION . ARGS).
5764 RETURN-ACTION, if non-nil, is an action for returning to the
5765 caller. It has the form (FUNCTION . ARGS). The function is
5766 called after the mail has been sent or put aside, and the mail
5767 buffer buried."
5768 (interactive
5769 (list nil nil nil current-prefix-arg))
5771 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5772 ;; from sendmail-user-agent to message-user-agent. Some users may
5773 ;; encounter incompatibilities. This hack tries to detect problems
5774 ;; and warn about them.
5775 (and compose-mail-user-agent-warnings
5776 (eq mail-user-agent 'message-user-agent)
5777 (let (warn-vars)
5778 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5779 mail-yank-hooks mail-archive-file-name
5780 mail-default-reply-to mail-mailing-lists
5781 mail-self-blind))
5782 (and (boundp var)
5783 (symbol-value var)
5784 (push var warn-vars)))
5785 (when warn-vars
5786 (display-warning 'mail
5787 (format "\
5788 The default mail mode is now Message mode.
5789 You have the following Mail mode variable%s customized:
5791 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5792 (if (> (length warn-vars) 1) "s" "")
5793 (mapconcat 'symbol-name
5794 warn-vars " "))))))
5796 (let ((function (get mail-user-agent 'composefunc)))
5797 (funcall function to subject other-headers continue switch-function
5798 yank-action send-actions return-action)))
5800 (defun compose-mail-other-window (&optional to subject other-headers continue
5801 yank-action send-actions
5802 return-action)
5804 (interactive (list nil nil nil current-prefix-arg))
5805 (compose-mail to subject other-headers continue
5806 'switch-to-buffer-other-window yank-action send-actions
5807 return-action))
5809 (defun compose-mail-other-frame (&optional to subject other-headers continue
5810 yank-action send-actions
5811 return-action)
5813 (interactive (list nil nil nil current-prefix-arg))
5814 (compose-mail to subject other-headers continue
5815 'switch-to-buffer-other-frame yank-action send-actions
5816 return-action))
5818 \f
5819 (defvar set-variable-value-history nil
5820 "History of values entered with `set-variable'.
5822 Maximum length of the history list is determined by the value
5823 of `history-length', which see.")
5825 (defun set-variable (variable value &optional make-local)
5826 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5827 VARIABLE should be a user option variable name, a Lisp variable
5828 meant to be customized by users. You should enter VALUE in Lisp syntax,
5829 so if you want VALUE to be a string, you must surround it with doublequotes.
5830 VALUE is used literally, not evaluated.
5832 If VARIABLE has a `variable-interactive' property, that is used as if
5833 it were the arg to `interactive' (which see) to interactively read VALUE.
5835 If VARIABLE has been defined with `defcustom', then the type information
5836 in the definition is used to check that VALUE is valid.
5838 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5839 (interactive
5840 (let* ((default-var (variable-at-point))
5841 (var (if (user-variable-p default-var)
5842 (read-variable (format "Set variable (default %s): " default-var)
5843 default-var)
5844 (read-variable "Set variable: ")))
5845 (minibuffer-help-form '(describe-variable var))
5846 (prop (get var 'variable-interactive))
5847 (obsolete (car (get var 'byte-obsolete-variable)))
5848 (prompt (format "Set %s %s to value: " var
5849 (cond ((local-variable-p var)
5850 "(buffer-local)")
5851 ((or current-prefix-arg
5852 (local-variable-if-set-p var))
5853 "buffer-locally")
5854 (t "globally"))))
5855 (val (progn
5856 (when obsolete
5857 (message (concat "`%S' is obsolete; "
5858 (if (symbolp obsolete) "use `%S' instead" "%s"))
5859 var obsolete)
5860 (sit-for 3))
5861 (if prop
5862 ;; Use VAR's `variable-interactive' property
5863 ;; as an interactive spec for prompting.
5864 (call-interactively `(lambda (arg)
5865 (interactive ,prop)
5866 arg))
5867 (read
5868 (read-string prompt nil
5869 'set-variable-value-history
5870 (format "%S" (symbol-value var))))))))
5871 (list var val current-prefix-arg)))
5873 (and (custom-variable-p variable)
5874 (not (get variable 'custom-type))
5875 (custom-load-symbol variable))
5876 (let ((type (get variable 'custom-type)))
5877 (when type
5878 ;; Match with custom type.
5879 (require 'cus-edit)
5880 (setq type (widget-convert type))
5881 (unless (widget-apply type :match value)
5882 (error "Value `%S' does not match type %S of %S"
5883 value (car type) variable))))
5885 (if make-local
5886 (make-local-variable variable))
5888 (set variable value)
5890 ;; Force a thorough redisplay for the case that the variable
5891 ;; has an effect on the display, like `tab-width' has.
5892 (force-mode-line-update))
5893 \f
5894 ;; Define the major mode for lists of completions.
5896 (defvar completion-list-mode-map
5897 (let ((map (make-sparse-keymap)))
5898 (define-key map [mouse-2] 'mouse-choose-completion)
5899 (define-key map [follow-link] 'mouse-face)
5900 (define-key map [down-mouse-2] nil)
5901 (define-key map "\C-m" 'choose-completion)
5902 (define-key map "\e\e\e" 'delete-completion-window)
5903 (define-key map [left] 'previous-completion)
5904 (define-key map [right] 'next-completion)
5905 (define-key map "q" 'quit-window)
5906 (define-key map "z" 'kill-this-buffer)
5907 map)
5908 "Local map for completion list buffers.")
5910 ;; Completion mode is suitable only for specially formatted data.
5911 (put 'completion-list-mode 'mode-class 'special)
5913 (defvar completion-reference-buffer nil
5914 "Record the buffer that was current when the completion list was requested.
5915 This is a local variable in the completion list buffer.
5916 Initial value is nil to avoid some compiler warnings.")
5918 (defvar completion-no-auto-exit nil
5919 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5920 This also applies to other functions such as `choose-completion'.")
5922 (defvar completion-base-position nil
5923 "Position of the base of the text corresponding to the shown completions.
5924 This variable is used in the *Completions* buffers.
5925 Its value is a list of the form (START END) where START is the place
5926 where the completion should be inserted and END (if non-nil) is the end
5927 of the text to replace. If END is nil, point is used instead.")
5929 (defvar completion-base-size nil
5930 "Number of chars before point not involved in completion.
5931 This is a local variable in the completion list buffer.
5932 It refers to the chars in the minibuffer if completing in the
5933 minibuffer, or in `completion-reference-buffer' otherwise.
5934 Only characters in the field at point are included.
5936 If nil, Emacs determines which part of the tail end of the
5937 buffer's text is involved in completion by comparing the text
5938 directly.")
5939 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
5941 (defun delete-completion-window ()
5942 "Delete the completion list window.
5943 Go to the window from which completion was requested."
5944 (interactive)
5945 (let ((buf completion-reference-buffer))
5946 (if (one-window-p t)
5947 (if (window-dedicated-p (selected-window))
5948 (delete-frame (selected-frame)))
5949 (delete-window (selected-window))
5950 (if (get-buffer-window buf)
5951 (select-window (get-buffer-window buf))))))
5953 (defun previous-completion (n)
5954 "Move to the previous item in the completion list."
5955 (interactive "p")
5956 (next-completion (- n)))
5958 (defun next-completion (n)
5959 "Move to the next item in the completion list.
5960 With prefix argument N, move N items (negative N means move backward)."
5961 (interactive "p")
5962 (let ((beg (point-min)) (end (point-max)))
5963 (while (and (> n 0) (not (eobp)))
5964 ;; If in a completion, move to the end of it.
5965 (when (get-text-property (point) 'mouse-face)
5966 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5967 ;; Move to start of next one.
5968 (unless (get-text-property (point) 'mouse-face)
5969 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5970 (setq n (1- n)))
5971 (while (and (< n 0) (not (bobp)))
5972 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
5973 ;; If in a completion, move to the start of it.
5974 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
5975 (goto-char (previous-single-property-change
5976 (point) 'mouse-face nil beg)))
5977 ;; Move to end of the previous completion.
5978 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
5979 (goto-char (previous-single-property-change
5980 (point) 'mouse-face nil beg)))
5981 ;; Move to the start of that one.
5982 (goto-char (previous-single-property-change
5983 (point) 'mouse-face nil beg))
5984 (setq n (1+ n))))))
5986 (defun choose-completion (&optional event)
5987 "Choose the completion at point."
5988 (interactive (list last-nonmenu-event))
5989 ;; In case this is run via the mouse, give temporary modes such as
5990 ;; isearch a chance to turn off.
5991 (run-hooks 'mouse-leave-buffer-hook)
5992 (let (buffer base-size base-position choice)
5993 (with-current-buffer (window-buffer (posn-window (event-start event)))
5994 (setq buffer completion-reference-buffer)
5995 (setq base-size completion-base-size)
5996 (setq base-position completion-base-position)
5997 (save-excursion
5998 (goto-char (posn-point (event-start event)))
5999 (let (beg end)
6000 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
6001 (setq end (point) beg (1+ (point))))
6002 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
6003 (setq end (1- (point)) beg (point)))
6004 (if (null beg)
6005 (error "No completion here"))
6006 (setq beg (previous-single-property-change beg 'mouse-face))
6007 (setq end (or (next-single-property-change end 'mouse-face)
6008 (point-max)))
6009 (setq choice (buffer-substring-no-properties beg end)))))
6011 (let ((owindow (selected-window)))
6012 (select-window (posn-window (event-start event)))
6013 (if (and (one-window-p t 'selected-frame)
6014 (window-dedicated-p (selected-window)))
6015 ;; This is a special buffer's frame
6016 (iconify-frame (selected-frame))
6017 (or (window-dedicated-p (selected-window))
6018 (bury-buffer)))
6019 (select-window
6020 (or (and (buffer-live-p buffer)
6021 (get-buffer-window buffer 0))
6022 owindow)))
6024 (choose-completion-string
6025 choice buffer
6026 (or base-position
6027 (when base-size
6028 ;; Someone's using old completion code that doesn't know
6029 ;; about base-position yet.
6030 (list (+ base-size (with-current-buffer buffer (field-beginning)))))
6031 ;; If all else fails, just guess.
6032 (with-current-buffer buffer
6033 (list (choose-completion-guess-base-position choice)))))))
6035 ;; Delete the longest partial match for STRING
6036 ;; that can be found before POINT.
6037 (defun choose-completion-guess-base-position (string)
6038 (save-excursion
6039 (let ((opoint (point))
6040 len)
6041 ;; Try moving back by the length of the string.
6042 (goto-char (max (- (point) (length string))
6043 (minibuffer-prompt-end)))
6044 ;; See how far back we were actually able to move. That is the
6045 ;; upper bound on how much we can match and delete.
6046 (setq len (- opoint (point)))
6047 (if completion-ignore-case
6048 (setq string (downcase string)))
6049 (while (and (> len 0)
6050 (let ((tail (buffer-substring (point) opoint)))
6051 (if completion-ignore-case
6052 (setq tail (downcase tail)))
6053 (not (string= tail (substring string 0 len)))))
6054 (setq len (1- len))
6055 (forward-char 1))
6056 (point))))
6058 (defun choose-completion-delete-max-match (string)
6059 (delete-region (choose-completion-guess-base-position string) (point)))
6060 (make-obsolete 'choose-completion-delete-max-match
6061 'choose-completion-guess-base-position "23.2")
6063 (defvar choose-completion-string-functions nil
6064 "Functions that may override the normal insertion of a completion choice.
6065 These functions are called in order with four arguments:
6066 CHOICE - the string to insert in the buffer,
6067 BUFFER - the buffer in which the choice should be inserted,
6068 MINI-P - non-nil if BUFFER is a minibuffer, and
6069 BASE-SIZE - the number of characters in BUFFER before
6070 the string being completed.
6072 If a function in the list returns non-nil, that function is supposed
6073 to have inserted the CHOICE in the BUFFER, and possibly exited
6074 the minibuffer; no further functions will be called.
6076 If all functions in the list return nil, that means to use
6077 the default method of inserting the completion in BUFFER.")
6079 (defun choose-completion-string (choice &optional buffer base-position)
6080 "Switch to BUFFER and insert the completion choice CHOICE.
6081 BASE-POSITION, says where to insert the completion."
6083 ;; If BUFFER is the minibuffer, exit the minibuffer
6084 ;; unless it is reading a file name and CHOICE is a directory,
6085 ;; or completion-no-auto-exit is non-nil.
6087 ;; Some older code may call us passing `base-size' instead of
6088 ;; `base-position'. It's difficult to make any use of `base-size',
6089 ;; so we just ignore it.
6090 (unless (consp base-position)
6091 (message "Obsolete `base-size' passed to choose-completion-string")
6092 (setq base-position nil))
6094 (let* ((buffer (or buffer completion-reference-buffer))
6095 (mini-p (minibufferp buffer)))
6096 ;; If BUFFER is a minibuffer, barf unless it's the currently
6097 ;; active minibuffer.
6098 (if (and mini-p
6099 (or (not (active-minibuffer-window))
6100 (not (equal buffer
6101 (window-buffer (active-minibuffer-window))))))
6102 (error "Minibuffer is not active for completion")
6103 ;; Set buffer so buffer-local choose-completion-string-functions works.
6104 (set-buffer buffer)
6105 (unless (run-hook-with-args-until-success
6106 'choose-completion-string-functions
6107 ;; The fourth arg used to be `mini-p' but was useless
6108 ;; (since minibufferp can be used on the `buffer' arg)
6109 ;; and indeed unused. The last used to be `base-size', so we
6110 ;; keep it to try and avoid breaking old code.
6111 choice buffer base-position nil)
6112 ;; Insert the completion into the buffer where it was requested.
6113 (delete-region (or (car base-position) (point))
6114 (or (cadr base-position) (point)))
6115 (insert choice)
6116 (remove-text-properties (- (point) (length choice)) (point)
6117 '(mouse-face nil))
6118 ;; Update point in the window that BUFFER is showing in.
6119 (let ((window (get-buffer-window buffer t)))
6120 (set-window-point window (point)))
6121 ;; If completing for the minibuffer, exit it with this choice.
6122 (and (not completion-no-auto-exit)
6123 (minibufferp buffer)
6124 minibuffer-completion-table
6125 ;; If this is reading a file name, and the file name chosen
6126 ;; is a directory, don't exit the minibuffer.
6127 (let* ((result (buffer-substring (field-beginning) (point)))
6128 (bounds
6129 (completion-boundaries result minibuffer-completion-table
6130 minibuffer-completion-predicate
6131 "")))
6132 (if (eq (car bounds) (length result))
6133 ;; The completion chosen leads to a new set of completions
6134 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6135 (let ((mini (active-minibuffer-window)))
6136 (select-window mini)
6137 (when minibuffer-auto-raise
6138 (raise-frame (window-frame mini))))
6139 (exit-minibuffer))))))))
6141 (define-derived-mode completion-list-mode nil "Completion List"
6142 "Major mode for buffers showing lists of possible completions.
6144 to select the completion near point.
6146 with the mouse.
6149 (set (make-local-variable 'completion-base-size) nil))
6151 (defun completion-list-mode-finish ()
6152 "Finish setup of the completions buffer.
6153 Called from `temp-buffer-show-hook'."
6154 (when (eq major-mode 'completion-list-mode)
6155 (toggle-read-only 1)))
6157 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6160 ;; Variables and faces used in `completion-setup-function'.
6162 (defcustom completion-show-help t
6163 "Non-nil means show help message in *Completions* buffer."
6164 :type 'boolean
6165 :version "22.1"
6166 :group 'completion)
6168 ;; This function goes in completion-setup-hook, so that it is called
6169 ;; after the text of the completion list buffer is written.
6170 (defun completion-setup-function ()
6171 (let* ((mainbuf (current-buffer))
6172 (base-dir
6173 ;; When reading a file name in the minibuffer,
6174 ;; try and find the right default-directory to set in the
6175 ;; completion list buffer.
6176 ;; FIXME: Why do we do that, actually? --Stef
6177 (if minibuffer-completing-file-name
6178 (file-name-as-directory
6179 (expand-file-name
6180 (substring (minibuffer-completion-contents)
6181 0 (or completion-base-size 0)))))))
6182 (with-current-buffer standard-output
6183 (let ((base-size completion-base-size) ;Read before killing localvars.
6184 (base-position completion-base-position))
6185 (completion-list-mode)
6186 (set (make-local-variable 'completion-base-size) base-size)
6187 (set (make-local-variable 'completion-base-position) base-position))
6188 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6189 (if base-dir (setq default-directory base-dir))
6190 ;; Maybe insert help string.
6191 (when completion-show-help
6192 (goto-char (point-min))
6193 (if (display-mouse-p)
6194 (insert (substitute-command-keys
6196 (insert (substitute-command-keys
6200 (add-hook 'completion-setup-hook 'completion-setup-function)
6202 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6203 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6205 (defun switch-to-completions ()
6206 "Select the completion list window."
6207 (interactive)
6208 (let ((window (or (get-buffer-window "*Completions*" 0)
6209 ;; Make sure we have a completions window.
6210 (progn (minibuffer-completion-help)
6211 (get-buffer-window "*Completions*" 0)))))
6212 (when window
6213 (select-window window)
6214 ;; In the new buffer, go to the first completion.
6215 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6216 (when (bobp)
6217 (next-completion 1)))))
6218 \f
6219 ;;; Support keyboard commands to turn on various modifiers.
6221 ;; These functions -- which are not commands -- each add one modifier
6222 ;; to the following event.
6224 (defun event-apply-alt-modifier (ignore-prompt)
6227 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6228 (defun event-apply-super-modifier (ignore-prompt)
6231 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6232 (defun event-apply-hyper-modifier (ignore-prompt)
6235 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6236 (defun event-apply-shift-modifier (ignore-prompt)
6239 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6240 (defun event-apply-control-modifier (ignore-prompt)
6243 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6244 (defun event-apply-meta-modifier (ignore-prompt)
6247 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6249 (defun event-apply-modifier (event symbol lshiftby prefix)
6250 "Apply a modifier flag to event EVENT.
6251 SYMBOL is the name of this modifier, as a symbol.
6252 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6253 PREFIX is the string that represents this modifier in an event type symbol."
6254 (if (numberp event)
6255 (cond ((eq symbol 'control)
6256 (if (and (<= (downcase event) ?z)
6257 (>= (downcase event) ?a))
6258 (- (downcase event) ?a -1)
6259 (if (and (<= (downcase event) ?Z)
6260 (>= (downcase event) ?A))
6261 (- (downcase event) ?A -1)
6262 (logior (lsh 1 lshiftby) event))))
6263 ((eq symbol 'shift)
6264 (if (and (<= (downcase event) ?z)
6265 (>= (downcase event) ?a))
6266 (upcase event)
6267 (logior (lsh 1 lshiftby) event)))
6268 (t
6269 (logior (lsh 1 lshiftby) event)))
6270 (if (memq symbol (event-modifiers event))
6271 event
6272 (let ((event-type (if (symbolp event) event (car event))))
6273 (setq event-type (intern (concat prefix (symbol-name event-type))))
6274 (if (symbolp event)
6275 event-type
6276 (cons event-type (cdr event)))))))
6278 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6279 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6280 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6281 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6282 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6283 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6284 \f
6285 ;;;; Keypad support.
6287 ;; Make the keypad keys act like ordinary typing keys. If people add
6288 ;; bindings for the function key symbols, then those bindings will
6289 ;; override these, so this shouldn't interfere with any existing
6290 ;; bindings.
6292 ;; Also tell read-char how to handle these keys.
6293 (mapc
6294 (lambda (keypad-normal)
6295 (let ((keypad (nth 0 keypad-normal))
6296 (normal (nth 1 keypad-normal)))
6297 (put keypad 'ascii-character normal)
6298 (define-key function-key-map (vector keypad) (vector normal))))
6299 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6300 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6301 (kp-space ?\s)
6304 (kp-multiply ?*)
6305 (kp-add ?+)
6306 (kp-separator ?,)
6307 (kp-subtract ?-)
6308 (kp-decimal ?.)
6309 (kp-divide ?/)
6310 (kp-equal ?=)
6311 ;; Do the same for various keys that are represented as symbols under
6312 ;; GUIs but naturally correspond to characters.
6313 (backspace 127)
6314 (delete 127)
6317 (clear ?\C-l)
6318 (return ?\C-m)
6319 (escape ?\e)
6320 ))
6321 \f
6322 ;;;;
6323 ;;;; forking a twin copy of a buffer.
6324 ;;;;
6326 (defvar clone-buffer-hook nil
6327 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6329 (defvar clone-indirect-buffer-hook nil
6330 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6332 (defun clone-process (process &optional newname)
6333 "Create a twin copy of PROCESS.
6334 If NEWNAME is nil, it defaults to PROCESS' name;
6335 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6336 If PROCESS is associated with a buffer, the new process will be associated
6337 with the current buffer instead.
6338 Returns nil if PROCESS has already terminated."
6339 (setq newname (or newname (process-name process)))
6341 (setq newname (substring newname 0 (match-beginning 0))))
6342 (when (memq (process-status process) '(run stop open))
6343 (let* ((process-connection-type (process-tty-name process))
6344 (new-process
6345 (if (memq (process-status process) '(open))
6346 (let ((args (process-contact process t)))
6347 (setq args (plist-put args :name newname))
6348 (setq args (plist-put args :buffer
6349 (if (process-buffer process)
6350 (current-buffer))))
6351 (apply 'make-network-process args))
6352 (apply 'start-process newname
6353 (if (process-buffer process) (current-buffer))
6354 (process-command process)))))
6355 (set-process-query-on-exit-flag
6356 new-process (process-query-on-exit-flag process))
6357 (set-process-inherit-coding-system-flag
6358 new-process (process-inherit-coding-system-flag process))
6359 (set-process-filter new-process (process-filter process))
6360 (set-process-sentinel new-process (process-sentinel process))
6361 (set-process-plist new-process (copy-sequence (process-plist process)))
6362 new-process)))
6364 ;; things to maybe add (currently partly covered by `funcall mode'):
6365 ;; - syntax-table
6366 ;; - overlays
6367 (defun clone-buffer (&optional newname display-flag)
6368 "Create and return a twin copy of the current buffer.
6369 Unlike an indirect buffer, the new buffer can be edited
6370 independently of the old one (if it is not read-only).
6371 NEWNAME is the name of the new buffer. It may be modified by
6372 adding or incrementing <N> at the end as necessary to create a
6373 unique buffer name. If nil, it defaults to the name of the
6374 current buffer, with the proper suffix. If DISPLAY-FLAG is
6375 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6376 clone a file-visiting buffer, or a buffer whose major mode symbol
6377 has a non-nil `no-clone' property, results in an error.
6379 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6380 current buffer with appropriate suffix. However, if a prefix
6381 argument is given, then the command prompts for NEWNAME in the
6382 minibuffer.
6384 This runs the normal hook `clone-buffer-hook' in the new buffer
6385 after it has been set up properly in other respects."
6386 (interactive
6387 (progn
6388 (if buffer-file-name
6389 (error "Cannot clone a file-visiting buffer"))
6390 (if (get major-mode 'no-clone)
6391 (error "Cannot clone a buffer in %s mode" mode-name))
6392 (list (if current-prefix-arg
6393 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6394 t)))
6395 (if buffer-file-name
6396 (error "Cannot clone a file-visiting buffer"))
6397 (if (get major-mode 'no-clone)
6398 (error "Cannot clone a buffer in %s mode" mode-name))
6399 (setq newname (or newname (buffer-name)))
6401 (setq newname (substring newname 0 (match-beginning 0))))
6402 (let ((buf (current-buffer))
6403 (ptmin (point-min))
6404 (ptmax (point-max))
6405 (pt (point))
6406 (mk (if mark-active (mark t)))
6407 (modified (buffer-modified-p))
6408 (mode major-mode)
6409 (lvars (buffer-local-variables))
6410 (process (get-buffer-process (current-buffer)))
6411 (new (generate-new-buffer (or newname (buffer-name)))))
6412 (save-restriction
6413 (widen)
6414 (with-current-buffer new
6415 (insert-buffer-substring buf)))
6416 (with-current-buffer new
6417 (narrow-to-region ptmin ptmax)
6418 (goto-char pt)
6419 (if mk (set-mark mk))
6420 (set-buffer-modified-p modified)
6422 ;; Clone the old buffer's process, if any.
6423 (when process (clone-process process))
6425 ;; Now set up the major mode.
6426 (funcall mode)
6428 ;; Set up other local variables.
6429 (mapc (lambda (v)
6430 (condition-case () ;in case var is read-only
6431 (if (symbolp v)
6432 (makunbound v)
6433 (set (make-local-variable (car v)) (cdr v)))
6434 (error nil)))
6435 lvars)
6437 ;; Run any hooks (typically set up by the major mode
6438 ;; for cloning to work properly).
6439 (run-hooks 'clone-buffer-hook))
6440 (if display-flag
6441 ;; Presumably the current buffer is shown in the selected frame, so
6442 ;; we want to display the clone elsewhere.
6443 (let ((same-window-regexps nil)
6444 (same-window-buffer-names))
6445 (pop-to-buffer new)))
6446 new))
6449 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6450 "Create an indirect buffer that is a twin copy of the current buffer.
6452 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6453 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6454 or if not called with a prefix arg, NEWNAME defaults to the current
6455 buffer's name. The name is modified by adding a `<N>' suffix to it
6456 or by incrementing the N in an existing suffix. Trying to clone a
6457 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6458 property results in an error.
6460 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6461 This is always done when called interactively.
6463 Optional third arg NORECORD non-nil means do not put this buffer at the
6464 front of the list of recently selected ones."
6465 (interactive
6466 (progn
6467 (if (get major-mode 'no-clone-indirect)
6468 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6469 (list (if current-prefix-arg
6470 (read-buffer "Name of indirect buffer: " (current-buffer)))
6471 t)))
6472 (if (get major-mode 'no-clone-indirect)
6473 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6474 (setq newname (or newname (buffer-name)))
6476 (setq newname (substring newname 0 (match-beginning 0))))
6477 (let* ((name (generate-new-buffer-name newname))
6478 (buffer (make-indirect-buffer (current-buffer) name t)))
6479 (with-current-buffer buffer
6480 (run-hooks 'clone-indirect-buffer-hook))
6481 (when display-flag
6482 (pop-to-buffer buffer norecord))
6483 buffer))
6486 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6487 "Like `clone-indirect-buffer' but display in another window."
6488 (interactive
6489 (progn
6490 (if (get major-mode 'no-clone-indirect)
6491 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6492 (list (if current-prefix-arg
6493 (read-buffer "Name of indirect buffer: " (current-buffer)))
6494 t)))
6495 (let ((pop-up-windows t))
6496 (clone-indirect-buffer newname display-flag norecord)))
6498 \f
6499 ;;; Handling of Backspace and Delete keys.
6501 (defcustom normal-erase-is-backspace 'maybe
6502 "Set the default behavior of the Delete and Backspace keys.
6504 If set to t, Delete key deletes forward and Backspace key deletes
6505 backward.
6507 If set to nil, both Delete and Backspace keys delete backward.
6509 If set to 'maybe (which is the default), Emacs automatically
6510 selects a behavior. On window systems, the behavior depends on
6511 the keyboard used. If the keyboard has both a Backspace key and
6512 a Delete key, and both are mapped to their usual meanings, the
6513 option's default value is set to t, so that Backspace can be used
6514 to delete backward, and Delete can be used to delete forward.
6516 If not running under a window system, customizing this option
6517 accomplishes a similar effect by mapping C-h, which is usually
6518 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6519 via `keyboard-translate'. The former functionality of C-h is
6520 available on the F1 key. You should probably not use this
6521 setting if you don't have both Backspace, Delete and F1 keys.
6523 Setting this variable with setq doesn't take effect. Programmatically,
6524 call `normal-erase-is-backspace-mode' (which see) instead."
6525 :type '(choice (const :tag "Off" nil)
6526 (const :tag "Maybe" maybe)
6527 (other :tag "On" t))
6528 :group 'editing-basics
6529 :version "21.1"
6530 :set (lambda (symbol value)
6531 ;; The fboundp is because of a problem with :set when
6532 ;; dumping Emacs. It doesn't really matter.
6533 (if (fboundp 'normal-erase-is-backspace-mode)
6534 (normal-erase-is-backspace-mode (or value 0))
6535 (set-default symbol value))))
6537 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6538 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6539 (unless frame (setq frame (selected-frame)))
6540 (with-selected-frame frame
6541 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6542 (normal-erase-is-backspace-mode
6543 (if (if (eq normal-erase-is-backspace 'maybe)
6544 (and (not noninteractive)
6545 (or (memq system-type '(ms-dos windows-nt))
6546 (memq window-system '(ns))
6547 (and (memq window-system '(x))
6548 (fboundp 'x-backspace-delete-keys-p)
6549 (x-backspace-delete-keys-p))
6550 ;; If the terminal Emacs is running on has erase char
6551 ;; set to ^H, use the Backspace key for deleting
6552 ;; backward, and the Delete key for deleting forward.
6553 (and (null window-system)
6554 (eq tty-erase-char ?\^H))))
6555 normal-erase-is-backspace)
6556 1 0)))))
6558 (define-minor-mode normal-erase-is-backspace-mode
6559 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6561 With numeric ARG, turn the mode on if and only if ARG is positive.
6563 On window systems, when this mode is on, Delete is mapped to C-d
6564 and Backspace is mapped to DEL; when this mode is off, both
6565 Delete and Backspace are mapped to DEL. (The remapping goes via
6566 `local-function-key-map', so binding Delete or Backspace in the
6567 global or local keymap will override that.)
6569 In addition, on window systems, the bindings of C-Delete, M-Delete,
6570 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6571 the global keymap in accordance with the functionality of Delete and
6572 Backspace. For example, if Delete is remapped to C-d, which deletes
6573 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6574 to DEL, which deletes backward, C-Delete is bound to
6575 `backward-kill-word'.
6577 If not running on a window system, a similar effect is accomplished by
6578 remapping C-h (normally produced by the Backspace key) and DEL via
6579 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6580 to C-d; if it's off, the keys are not remapped.
6582 When not running on a window system, and this mode is turned on, the
6583 former functionality of C-h is available on the F1 key. You should
6584 probably not turn on this mode on a text-only terminal if you don't
6585 have both Backspace, Delete and F1 keys.
6587 See also `normal-erase-is-backspace'."
6588 :variable (eq (terminal-parameter
6589 nil 'normal-erase-is-backspace) 1)
6590 (let ((enabled (eq 1 (terminal-parameter
6591 nil 'normal-erase-is-backspace))))
6593 (cond ((or (memq window-system '(x w32 ns pc))
6594 (memq system-type '(ms-dos windows-nt)))
6595 (let* ((bindings
6596 `(([M-delete] [M-backspace])
6597 ([C-M-delete] [C-M-backspace])
6598 ([?\e C-delete] [?\e C-backspace])))
6599 (old-state (lookup-key local-function-key-map [delete])))
6601 (if enabled
6602 (progn
6603 (define-key local-function-key-map [delete] [deletechar])
6604 (define-key local-function-key-map [kp-delete] [?\C-d])
6605 (define-key local-function-key-map [backspace] [?\C-?])
6606 (dolist (b bindings)
6607 ;; Not sure if input-decode-map is really right, but
6608 ;; keyboard-translate-table (used below) only works
6609 ;; for integer events, and key-translation-table is
6610 ;; global (like the global-map, used earlier).
6611 (define-key input-decode-map (car b) nil)
6612 (define-key input-decode-map (cadr b) nil)))
6613 (define-key local-function-key-map [delete] [?\C-?])
6614 (define-key local-function-key-map [kp-delete] [?\C-?])
6615 (define-key local-function-key-map [backspace] [?\C-?])
6616 (dolist (b bindings)
6617 (define-key input-decode-map (car b) (cadr b))
6618 (define-key input-decode-map (cadr b) (car b))))))
6619 (t
6620 (if enabled
6621 (progn
6622 (keyboard-translate ?\C-h ?\C-?)
6623 (keyboard-translate ?\C-? ?\C-d))
6624 (keyboard-translate ?\C-h ?\C-h)
6625 (keyboard-translate ?\C-? ?\C-?))))
6627 (if (called-interactively-p 'interactive)
6628 (message "Delete key deletes %s"
6629 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6630 "forward" "backward")))))
6631 \f
6632 (defvar vis-mode-saved-buffer-invisibility-spec nil
6633 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6635 (define-minor-mode visible-mode
6636 "Toggle Visible mode.
6637 With argument ARG turn Visible mode on if ARG is positive, otherwise
6638 turn it off.
6640 Enabling Visible mode makes all invisible text temporarily visible.
6641 Disabling Visible mode turns off that effect. Visible mode works by
6642 saving the value of `buffer-invisibility-spec' and setting it to nil."
6643 :lighter " Vis"
6644 :group 'editing-basics
6645 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6646 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6647 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6648 (when visible-mode
6649 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6650 buffer-invisibility-spec)
6651 (setq buffer-invisibility-spec nil)))
6652 \f
6653 ;; Partial application of functions (similar to "currying").
6654 ;; This function is here rather than in subr.el because it uses CL.
6655 (defun apply-partially (fun &rest args)
6656 "Return a function that is a partial application of FUN to ARGS.
6657 ARGS is a list of the first N arguments to pass to FUN.
6658 The result is a new function which does the same as FUN, except that
6659 the first N arguments are fixed at the values with which this function
6660 was called."
6661 (lexical-let ((fun fun) (args1 args))
6662 (lambda (&rest args2) (apply fun (append args1 args2)))))
6663 \f
6664 ;; Minibuffer prompt stuff.
6666 ;(defun minibuffer-prompt-modification (start end)
6667 ; (error "You cannot modify the prompt"))
6668 ;
6669 ;
6670 ;(defun minibuffer-prompt-insertion (start end)
6671 ; (let ((inhibit-modification-hooks t))
6672 ; (delete-region start end)
6673 ; ;; Discard undo information for the text insertion itself
6674 ; ;; and for the text deletion.above.
6675 ; (when (consp buffer-undo-list)
6676 ; (setq buffer-undo-list (cddr buffer-undo-list)))
6677 ; (message "You cannot modify the prompt")))
6678 ;
6679 ;
6680 ;(setq minibuffer-prompt-properties
6681 ; (list 'modification-hooks '(minibuffer-prompt-modification)
6682 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6683 ;
6685 \f
6686 ;;;; Problematic external packages.
6688 ;; rms says this should be done by specifying symbols that define
6689 ;; versions together with bad values. This is therefore not as
6690 ;; flexible as it could be. See the thread:
6691 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6692 (defconst bad-packages-alist
6693 ;; Not sure exactly which semantic versions have problems.
6694 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6696 "The version of `semantic' loaded does not work in Emacs 22.
6697 It can cause constant high CPU load.
6698 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6699 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6700 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6701 ;; provided the `CUA-mode' feature. Since this is no longer true,
6702 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6703 (CUA-mode t nil
6704 "CUA-mode is now part of the standard GNU Emacs distribution,
6705 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6707 You have loaded an older version of CUA-mode which does not work
6708 correctly with this version of Emacs. You should remove the old
6709 version and use the one distributed with Emacs."))
6710 "Alist of packages known to cause problems in this version of Emacs.
6711 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6712 PACKAGE is either a regular expression to match file names, or a
6713 symbol (a feature name); see the documentation of
6714 `after-load-alist', to which this variable adds functions.
6715 SYMBOL is either the name of a string variable, or `t'. Upon
6716 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6717 warning using STRING as the message.")
6719 (defun bad-package-check (package)
6720 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6721 (condition-case nil
6722 (let* ((list (assoc package bad-packages-alist))
6723 (symbol (nth 1 list)))
6724 (and list
6725 (boundp symbol)
6726 (or (eq symbol t)
6727 (and (stringp (setq symbol (eval symbol)))
6728 (string-match-p (nth 2 list) symbol)))
6729 (display-warning package (nth 3 list) :warning)))
6730 (error nil)))
6732 (mapc (lambda (elem)
6733 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6734 bad-packages-alist)
6737 (provide 'simple)
6739 ;;; simple.el ends here