| blob | 78b765795847e8c9c5c386fbfecd406e1f0baabf |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985-1987, 1993-2012 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:
34 ;;; From compile.el
39 "Idle time delay before updating various things on the screen.
40 Various Emacs features that update auxiliary information when point moves
41 wait this many seconds after Emacs becomes idle before doing an update."
47 "Killing and yanking commands."
51 "Highlight (un)matching of parens and expressions."
53 \f
54 ;;; next-error support framework
57 "`next-error' support framework."
63 "Face used to highlight next error locus."
68 "Highlighting of locations in selected source buffers.
69 If a number, highlight the locus in `next-error' face for the given time
70 in seconds, or until the next command is executed.
71 If t, highlight the locus until the next command is executed, or until
72 some other locus replaces it.
73 If nil, don't highlight the locus in the source buffer.
74 If `fringe-arrow', indicate the locus by the fringe arrow
75 indefinitely until some other locus replaces it."
84 "Highlighting of locations in `next-error-no-select'.
85 If number, highlight the locus in `next-error' face for given time in seconds.
86 If t, highlight the locus indefinitely until some other locus replaces it.
87 If nil, don't highlight the locus in the source buffer.
88 If `fringe-arrow', indicate the locus by the fringe arrow
89 indefinitely until some other locus replaces it."
98 "Display the line in the visited source file recentered as specified.
99 If non-nil, the value is passed directly to `recenter'."
107 "List of hook functions run by `next-error' after visiting source file."
118 "The most recent `next-error' buffer.
119 A buffer becomes most recent when its compilation, grep, or
124 "Function to use to find the next error in the current buffer.
125 The function is called with 2 parameters:
126 ARG is an integer specifying by how many errors to move.
127 RESET is a boolean which, if non-nil, says to go back to the beginning
128 of the errors before moving.
129 Major modes providing compile-like functionality should set this variable
130 to indicate to `next-error' that this is a candidate buffer and how
135 "Function to use to move to an error locus.
136 It takes two arguments, a buffer position in the error buffer
137 and a buffer position in the error locus buffer.
138 The buffer for the error locus should already be current.
143 &optional avoid-current
144 extra-test-inclusive
145 extra-test-exclusive)
146 "Test if BUFFER is a `next-error' capable buffer.
148 If AVOID-CURRENT is non-nil, treat the current buffer
149 as an absolute last resort only.
151 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
152 that normally would not qualify. If it returns t, the buffer
153 in question is treated as usable.
155 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
156 that would normally be considered usable. If it returns nil,
157 that buffer is rejected."
162 ;; Optionally reject some buffers.
165 t)
166 ;; Optionally accept some other buffers.
171 extra-test-inclusive
172 extra-test-exclusive)
173 "Return a `next-error' capable buffer.
175 If AVOID-CURRENT is non-nil, treat the current buffer
176 as an absolute last resort only.
178 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
179 that normally would not qualify. If it returns t, the buffer
180 in question is treated as usable.
182 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
183 that would normally be considered usable. If it returns nil,
184 that buffer is rejected."
186 ;; 1. If one window on the selected frame displays such buffer, return it.
192 avoid-current
193 extra-test-inclusive extra-test-exclusive)
198 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
201 extra-test-inclusive extra-test-exclusive))
202 next-error-last-buffer)
203 ;; 3. If the current buffer is acceptable, choose it.
205 extra-test-inclusive extra-test-exclusive)
207 ;; 4. Look for any acceptable buffer.
212 extra-test-inclusive extra-test-exclusive)))
215 ;; 5. Use the current buffer as a last resort if it qualifies,
216 ;; even despite AVOID-CURRENT.
219 extra-test-inclusive extra-test-exclusive)
223 ;; 6. Give up.
227 "Visit next `next-error' message and corresponding source code.
229 If all the error messages parsed so far have been processed already,
230 the message buffer is checked for new ones.
232 A prefix ARG specifies how many error messages to move;
233 negative means move back to previous error messages.
235 and start at the first error.
237 The RESET argument specifies that we should restart from the beginning.
240 compilation, grep, or occur buffer. It can also operate on any
242 more generally, on any buffer in Compilation mode or with
243 Compilation Minor mode enabled, or any buffer in which
244 `next-error-function' is bound to an appropriate function.
245 To specify use of a particular buffer for error messages, type
247 in the current frame.
250 runs `next-error-hook' with `run-hooks', and stays with that buffer
251 until you use it in some other buffer which uses Compilation mode
252 or Compilation Minor mode.
254 To control which errors are matched, customize the variable
255 `compilation-error-regexp-alist'."
259 ;; we know here that next-error-function is a valid symbol we can funcall
267 "Visit the source code corresponding to the `next-error' message at point."
269 ;; we know here that next-error-function is a valid symbol we can funcall
280 "Visit previous `next-error' message and corresponding source code.
282 Prefix arg N says how many error messages to move backwards (or
283 forwards, if negative).
290 "Restart at the first error.
291 Visit corresponding source code.
292 With prefix arg N, visit the source code of the Nth error.
298 "Move point to the next error in the `next-error' buffer and highlight match.
299 Prefix arg N says how many error messages to move forwards (or
300 backwards, if negative).
302 select the source buffer."
309 "Move point to the previous error in the `next-error' buffer and highlight match.
310 Prefix arg N says how many error messages to move backwards (or
311 forwards, if negative).
313 select the source buffer."
317 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
321 "Minor mode for compilation, occur and diff modes.
322 With a prefix argument ARG, enable mode if ARG is positive, and
323 disable it otherwise. If called from Lisp, enable mode if ARG is
324 omitted or nil.
325 When turned on, cursor motion in the compilation, grep, occur or diff
326 buffer causes automatic display of the corresponding source code location."
333 ;; Used as a `post-command-hook' by `next-error-follow-mode'
334 ;; for the *Compilation* *grep* and *Occur* buffers.
344 \f
345 ;;;
348 "Major mode not specialized for anything in particular.
349 Other major modes are defined by comparison with this one."
355 ;; Special major modes to view specially formatted data rather than files.
368 map))
372 "Parent major mode from which special major modes should inherit."
375 ;; Major mode meant to be the parent of programming modes.
380 map)
384 "Indent the expression after point."
391 "Major mode for editing programming language source code."
394 ;; Any programming language is always written left to right.
397 ;; Making and deleting lines.
403 "Insert a newline, and move to left margin of the new line if it's blank.
404 If `use-hard-newlines' is non-nil, the newline is marked with the
405 text-property `hard'.
406 With ARG, insert that many newlines.
407 Call `auto-fill-function' if the current column number is greater
408 than the value of `fill-column' and ARG is nil."
411 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
412 ;; Set last-command-event to tell self-insert what to insert.
416 ;; Don't auto-fill if we have a numeric argument.
419 ;; Do the rest in post-self-insert-hook, because we want to do it
420 ;; *before* other functions on that hook.
422 ;; Mark the newline(s) `hard'.
426 ;; If the newline leaves the previous line blank, and we
427 ;; have a left margin, delete that from the blank line.
435 ;; Indent the line after the newline, except in one case:
436 ;; when we added the newline at the beginning of a line which
437 ;; starts a page.
444 ;; We first used let-binding to protect the hook, but that was naive
445 ;; since add-hook affects the symbol-default value of the variable,
446 ;; whereas the let-binding might only protect the buffer-local value.
448 nil)
453 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
459 "Insert a newline and leave point before it.
460 If there is a fill prefix and/or a `left-margin', insert them
461 on the new line if the line would have been blank.
462 With arg N, insert N newlines."
467 ;; Don't expand an abbrev before point.
481 "Split current line, moving portion beyond point vertically down.
482 If the current line starts with `fill-prefix', insert it on the new
483 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
485 When called from Lisp code, ARG may be a prefix string to copy."
490 ;; What prefix should we check for (nil means don't).
494 ;; Does this line start with it?
505 "Join this line to previous and fix up whitespace at join.
506 If there is a fill prefix, delete it from the beginning of this line.
507 With argument, join this line to following line."
514 ;; If the second line started with the fill prefix,
515 ;; delete the prefix.
527 "On blank line, delete all surrounding blank lines, leaving just one.
528 On isolated blank line, delete that one.
529 On nonblank line, delete any immediately following blank lines."
535 ;; Set singleblank if there is just one blank line here.
542 ;; Delete preceding blank lines, and this one too if it's the only one.
551 ;; Delete following blank lines, unless the current line is blank
552 ;; and there are no following blank lines.
561 ;; Handle the special case where point is followed by newline and eob.
562 ;; Delete the line, leaving point at eob.
568 Trailing lines are deleted only if `delete-trailing-whitespace'
569 is called on the entire buffer (rather than an active region)."
575 "Delete trailing whitespace between START and END.
576 If called interactively, START and END are the start/end of the
577 region if the mark is active, or of the buffer's accessible
578 portion if the mark is inactive.
580 This command deletes whitespace characters after the last
581 non-whitespace character in each line between START and END. It
582 does not consider formfeed characters to be whitespace.
584 If this command acts on the entire buffer (i.e. if called
585 interactively with the mark inactive, or called from Lisp with
586 END nil), it also deletes all trailing lines at the end of the
587 buffer if the variable `delete-trailing-lines' is non-nil."
600 ;; Don't delete formfeeds, even if they are considered whitespace.
604 ;; Delete trailing empty lines.
607 delete-trailing-lines
608 ;; Really the end of buffer.
613 ;; Return nil for the benefit of `write-file-functions'.
614 nil)
617 "Insert a newline, then indent according to major mode.
618 Indentation is done using the value of `indent-line-function'.
619 In programming language modes, this is the same as TAB.
620 In some text modes, where TAB inserts a tab, this command indents to the
621 column specified by the function `current-left-margin'."
628 "Reindent current line, insert newline, then indent the new line.
629 Indentation of both lines is done according to the current major mode,
630 which means calling the current value of `indent-line-function'.
631 In programming language modes, this is the same as TAB.
632 In some text modes, where TAB inserts a tab, this indents to the
633 column specified by the function `current-left-margin'."
636 ;; Be careful to insert the newline before indenting the line.
637 ;; Otherwise, the indentation might be wrong.
641 ;; We are at EOL before the call to indent-according-to-mode, and
642 ;; after it we usually are as well, but not always. We tried to
643 ;; address it with `save-excursion' but that uses a normal marker
644 ;; whereas we need `move after insertion', so we do the save/restore
645 ;; by hand.
649 ;; Remove the trailing white-space after indentation because
650 ;; indentation may introduce the whitespace.
655 "Read next input character and insert it.
656 This is useful for inserting control characters.
657 With argument, insert ARG copies of the character.
659 If the first character you type after this command is an octal digit,
660 you should type a sequence of octal digits which specify a character code.
661 Any nondigit terminates the sequence. If the terminator is a RET,
662 it is discarded; any other terminator is used itself as input.
663 The variable `read-quoted-char-radix' specifies the radix for this feature;
664 set it to 10 or 16 to use decimal or hex instead of octal.
666 In overwrite mode, this function inserts the character anyway, and
667 does not handle octal digits specially. This means that if you use
668 overwrite as your normal editing mode, you can use this function to
669 insert characters when necessary.
671 In binary overwrite mode, this function does overwrite, and octal
672 digits are interpreted as a character code. This is intended to be
673 useful for editing binary files."
676 ;; Avoid "obsolete" warnings for translation-table-for-input.
683 ;; This used to assume character codes 0240 - 0377 stand for
684 ;; characters in some single-byte character set, and converted them
685 ;; to Emacs characters. But in 23.1 this feature is deprecated
686 ;; in favor of inserting the corresponding Unicode characters.
687 ;; (if (and enable-multibyte-characters
688 ;; (>= char ?\240)
689 ;; (<= char ?\377))
690 ;; (setq char (unibyte-char-to-multibyte char)))
699 "Move forward ARG lines and position at first nonblank character."
705 "Move backward ARG lines and position at first nonblank character."
711 "Move point to the first non-whitespace character on this line."
715 ;; Move back over chars that have whitespace syntax but have the p flag.
719 "Fixup white space between objects around point.
720 Leave one space or none, according to the context."
727 nil
731 "Delete all spaces and tabs around point.
732 If BACKWARD-ONLY is non-nil, only delete them before point."
737 orig-pos
746 "Delete all spaces and tabs around point, leaving one space (or N spaces).
747 If N is negative, delete newlines as well, leaving -N spaces."
764 \f
766 "Move point to the beginning of the buffer.
767 With numeric arg N, put point N/10 of the way from the beginning.
768 If the buffer is narrowed, this command uses the beginning of the
769 accessible part of the buffer.
771 If Transient Mark mode is disabled, leave mark at previous
774 Don't use this command in Lisp programs!
775 \(goto-char (point-min)) is faster."
784 ;; Avoid overflow for large buffer sizes!
792 "Move point to the end of the buffer.
793 With numeric arg N, put point N/10 of the way from the end.
794 If the buffer is narrowed, this command uses the end 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-max)) is faster."
808 ;; Avoid overflow for large buffer sizes!
813 ;; If we went to a place in the middle of the buffer,
814 ;; adjust it to the beginning of a line.
817 ;; If the end of the buffer is not already on the screen,
818 ;; then scroll specially to put it near, but not at, the bottom.
823 "Whether single-char deletion commands delete an active region.
824 This has an effect only if Transient Mark mode is enabled, and
825 affects `delete-forward-char' and `delete-backward-char', though
826 not `delete-char'.
828 If the value is the symbol `kill', the active region is killed
829 instead of deleted."
837 "Delete the previous N characters (following if N is negative).
838 If Transient Mark mode is enabled, the mark is active, and N is 1,
839 delete the text in the region and deactivate the mark instead.
840 To disable this, set `delete-active-region' to nil.
842 Optional second arg KILLFLAG, if non-nil, means to kill (save in
843 kill ring) instead of delete. Interactively, N is the prefix
844 arg, and KILLFLAG is set if N is explicitly specified.
846 In Overwrite mode, single character backward deletion may replace
847 tabs with spaces so as to back over columns, unless point is at
848 the end of the line."
853 delete-active-region
855 ;; If a region is active, kill or delete it.
859 ;; In Overwrite mode, maybe untabify while deleting
869 ;; Otherwise, do simple deletion.
873 "Delete the following N characters (previous if N is negative).
874 If Transient Mark mode is enabled, the mark is active, and N is 1,
875 delete the text in the region and deactivate the mark instead.
876 To disable this, set `delete-active-region' to nil.
878 Optional second arg KILLFLAG non-nil means to kill (save in kill
879 ring) instead of delete. Interactively, N is the prefix arg, and
880 KILLFLAG is set if N was explicitly specified."
885 delete-active-region
887 ;; If a region is active, kill or delete it.
891 ;; Otherwise, do simple deletion.
895 "Put point at beginning and mark at end of buffer.
896 If narrowing is in effect, only uses the accessible part of the buffer.
897 You probably should not use this function in Lisp programs;
898 it is usually a mistake for a Lisp function to use any subroutine
899 that uses or sets the mark."
904 \f
906 ;; Counting lines, one way or another.
909 "Go to LINE, counting from line 1 at beginning of buffer.
910 If called interactively, a numeric prefix argument specifies
911 LINE; without a numeric prefix argument, read LINE from the
912 minibuffer.
914 If optional argument BUFFER is non-nil, switch to that buffer and
916 as argument, BUFFER is the most recently selected other buffer.
918 Prior to moving point, this function sets the mark (without
919 activating it), unless Transient Mark mode is enabled and the
920 mark is already active.
922 This function is usually the wrong thing to use in a Lisp program.
923 What you probably want instead is something like:
924 (goto-char (point-min))
925 (forward-line (1- N))
926 If at all possible, an even better solution is to use char counts
927 rather than line counts."
931 ;; Look for a default, a number in the buffer at point.
941 ;; Decide if we're switching buffers.
949 ;; Read the argument, offering that number (if any) as default.
952 buffer))))
953 ;; Switch to the desired buffer, one way or another.
958 ;; Leave mark at previous position
960 ;; Move to the specified line number in that buffer.
969 "Count the number of words in the region.
970 If called interactively, print a message reporting the number of
971 lines, words, and characters in the region (whether or not the
972 region is active); with prefix ARG, report for the entire buffer
973 rather than the region.
975 If called from Lisp, return the number of words between positions
976 START and END."
988 "Count words between START and END.
989 If called interactively, START and END are normally the start and
990 end of the buffer; but if the region is active, START and END are
991 the start and end of the region. Print a message reporting the
992 number of lines, words, and chars.
994 If called from Lisp, return the number of words between START and
995 END, without printing any message."
1005 words))
1021 str
1029 "Print the current buffer line number and narrowed line number of point."
1042 "Return number of lines between START and END.
1043 This is usually the number of newlines between them,
1044 but can be one more if START is not equal to END
1045 and the greater of them is not at the start of a line."
1061 done)))
1065 "Return (narrowed) buffer line number at position POS.
1066 If POS is nil, use current buffer location.
1067 Counting starts at (point-min), so the value refers
1068 to the contents of the accessible portion of the buffer."
1078 "Print info on cursor position (on screen and within buffer).
1079 Also describe the character after point, and give its character code
1080 in octal, decimal and hex.
1082 For a non-ASCII multibyte character, also give its encoding in the
1083 buffer's selected coding system if the coding system encodes the
1084 character safely. If the character is encoded into one byte, that
1085 code is shown in hex. If the character is encoded into more than one
1088 In addition, with prefix argument, show details about that character
1089 in *Help* buffer. See also the command `describe-char'."
1094 ;; If the character is one of LRE, LRO, RLE, RLO, it
1095 ;; will start a directional embedding, which could
1096 ;; completely disrupt the rest of the line (e.g., RLO
1097 ;; will display the rest of the line right-to-left).
1098 ;; So we put an invisible PDF character after these
1099 ;; characters, to end the embedding, which eliminates
1100 ;; any effects on the rest of the line.
1102 ;; Strong right-to-left characters cause reordering of
1103 ;; the following numerical characters which show the
1104 ;; codepoint, so append LRM to countermand that.
1114 ;; Avoid overflow from multiplying by 100!
1118 ""
1124 pos total percent beg end col hscroll)
1126 pos total col hscroll))
1128 encoded encoding-msg display-prop under-display)
1135 ;; Check if the character is displayed with some `display'
1136 ;; text property. In that case, set under-display to the
1137 ;; buffer substring covered by that property.
1148 under-display)))
1154 char char char under-display)
1156 char char char under-display display-prop))
1159 char char char
1161 "..."
1165 ;; We show the detailed information about CHAR.
1172 bidi-fixer
1173 encoding-msg pos total percent beg end col hscroll)
1180 bidi-fixer encoding-msg pos total percent col hscroll))))))
1181 \f
1182 ;; Initialize read-expression-map. It is defined at C level.
1185 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1186 ;; too rarely useful.
1196 "The current default value or list of default values in the minibuffer.
1197 The functions `read-from-minibuffer' and `completing-read' bind
1201 "Value for `print-level' while printing value in `eval-expression'.
1202 A value of nil means no limit."
1208 "Value for `print-length' while printing value in `eval-expression'.
1209 A value of nil means no limit."
1215 "If non-nil set `debug-on-error' to t in `eval-expression'.
1216 If nil, don't change the value of `debug-on-error'."
1222 "Format VALUE as a result of evaluated expression.
1223 Return a formatted string which is displayed in the echo area
1224 in addition to the value printed by prin1 in functions which
1225 display the result of expression evaluation."
1238 ;; We define this, rather than making `eval' interactive,
1239 ;; for the sake of completion of names like eval-region, eval-buffer.
1242 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1243 When called interactively, read an Emacs Lisp expression and
1244 evaluate it.
1245 Value is also consed on to front of the variable `values'.
1246 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1247 with prefix argument) means insert the result into the current buffer
1248 instead of printing it in the echo area. Truncates long output
1249 according to the value of the variables `eval-expression-print-length'
1250 and `eval-expression-print-level'.
1252 If `eval-expression-debug-on-error' is non-nil, which is the default,
1253 this command arranges for all errors to enter the debugger."
1257 nil read-expression-map t
1259 current-prefix-arg))
1264 ;; Bind debug-on-error to something unique so that we can
1265 ;; detect when evalled code changes it.
1269 ;; If evalled code has changed the value of debug-on-error,
1270 ;; propagate that change to the global binding.
1286 "Prompting with PROMPT, let user edit COMMAND and eval result.
1287 COMMAND is a Lisp expression. Let user edit that expression in
1288 the minibuffer, then read and evaluate the result."
1295 read-expression-map t
1297 ;; If command was added to command-history as a string,
1298 ;; get rid of that. We want only evaluable expressions there.
1302 ;; If command to be redone does not match front of history,
1303 ;; add it to the history.
1309 "Edit and re-evaluate last complex command, or ARGth from last.
1310 A complex command is one which used the minibuffer.
1311 The command is placed in the minibuffer as a Lisp form for editing.
1312 The result is executed, repeating the command as changed.
1313 If the command has been changed or is not the most recent previous
1314 command it is added to the front of the command history.
1315 You can use the minibuffer history commands \
1317 to get different commands to edit and resubmit."
1320 newcmd)
1332 ;; If command was added to command-history as a
1333 ;; string, get rid of that. We want only
1334 ;; evaluable expressions there.
1338 ;; If command to be redone does not match front of history,
1339 ;; add it to the history.
1348 "Read command name to invoke in `execute-extended-command'."
1353 ;; Get a command name at point in the original buffer
1354 ;; to propose it after M-n.
1358 ;; Read a string, completing from and restricting to the set of
1359 ;; all defined commands. Don't provide any initial input.
1360 ;; Save the command read on the extended-command history list.
1371 ;; This isn't strictly correct if `execute-extended-command'
1372 ;; is bound to anything else (e.g. [menu]).
1373 ;; It could use (key-description (this-single-command-keys)),
1374 ;; but actually a prompt other than "M-x" would be confusing,
1375 ;; because "M-x" is a well-known prompt to read a command
1376 ;; and it serves as a shorthand for "Extended command: ".
1381 "Non-nil means show the equivalent key-binding when M-x command has one.
1382 The value can be a length of time to show the message for.
1383 If the value is non-nil and not a number, we wait 2 seconds."
1390 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1391 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1392 "Read function name, then read its arguments and call it.
1394 To pass a numeric argument to the command you are invoking with, specify
1395 the numeric argument to this command.
1397 Noninteractively, the argument PREFIXARG is the prefix argument to
1398 give to the command you invoke, if it asks for an argument."
1400 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1409 ;; Normally `real-this-command' should never be changed, but here we really
1410 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1411 ;; binding" for <cmd>, so the command the user really wanted to run is
1412 ;; `function' and not `execute-extended-command'. The difference is
1413 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1417 ;; If enabled, show which key runs this command.
1419 ;; But first wait, and skip the message if there is input.
1421 ;; If this command displayed something in the echo area;
1422 ;; wait a few seconds, then display our suggestion message.
1432 suggest-key-bindings
1434 \f
1436 "Default minibuffer history list.
1437 This is used for all minibuffer input
1438 except when an alternate history list is specified.
1440 Maximum length of the history list is determined by the value
1443 "Control whether history list elements are expressions or strings.
1444 If the value of this variable equals current minibuffer depth,
1445 they are expressions; otherwise they are strings.
1446 \(That convention is designed to do the right thing for
1453 "Text that was in this minibuffer before any history commands.
1454 This is nil if there have not yet been any history commands
1463 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1467 "Minibuffer history variables for which matching should ignore case.
1468 If a history variable is a member of this list, then the
1470 commands ignore case when searching it, regardless of `case-fold-search'."
1475 "Find the previous history element that matches REGEXP.
1476 \(Previous history elements refer to earlier actions.)
1477 With prefix argument N, search for Nth previous match.
1478 If N is negative, find the next or Nth next match.
1479 Normally, history elements are matched case-insensitively if
1480 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1481 makes the search case-sensitive.
1482 See also `minibuffer-history-case-insensitive-variables'."
1486 nil
1487 minibuffer-local-map
1488 nil
1489 'minibuffer-history-search-history
1491 ;; Use the last regexp specified, by default, if input is empty.
1496 regexp)
1506 ;; On some systems, ignore case for file names.
1508 minibuffer-history-case-insensitive-variables)
1509 t
1510 ;; Respect the user's setting for case-fold-search:
1511 case-fold-search)
1512 nil))
1513 prevpos
1514 match-string
1515 match-offset
1522 "No later matching history item"
1543 next-matching-history-element))
1547 "Find the next history element that matches REGEXP.
1548 \(The next history element refers to a more recent action.)
1549 With prefix argument N, search for Nth next match.
1550 If N is negative, find the previous or Nth previous match.
1551 Normally, history elements are matched case-insensitively if
1552 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1553 makes the search case-sensitive."
1557 nil
1558 minibuffer-local-map
1559 nil
1560 'minibuffer-history-search-history
1562 ;; Use the last regexp specified, by default, if input is empty.
1567 regexp)
1574 "Function run by `goto-history-element' before consuming default values.
1575 This is useful to dynamically add more elements to the list of default values
1576 when `goto-history-element' reaches the end of this list.
1577 Before calling this function `goto-history-element' sets the variable
1578 `minibuffer-default-add-done' to t, so it will call this function only
1579 once. In special cases, when this function needs to be called more
1580 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1584 "When nil, add more elements to the end of the list of default values.
1585 The value nil causes `goto-history-element' to add more elements to
1586 the list of defaults when it reaches the end of this list. It does
1592 "Return a list of all completions without the default value.
1593 This function is used to add all elements of the completion table to
1594 the end of the list of defaults just after the default value."
1597 minibuffer-completion-table
1598 minibuffer-completion-predicate)))
1604 "Puts element of the minibuffer history in the minibuffer.
1605 The argument NABS specifies the absolute history position."
1619 elt minibuffer-returned-to-present)
1626 "End of defaults; no next item"
1631 previous-history-element))
1643 minibuffer-default)))
1655 elt))
1659 "Puts next element of the minibuffer history in the minibuffer.
1660 With argument N, it uses the Nth following element."
1666 "Puts previous element of the minibuffer history in the minibuffer.
1667 With argument N, it uses the Nth previous element."
1673 "Get next history element which completes the minibuffer before the point.
1674 The contents of the minibuffer after the point are deleted, and replaced
1675 by the new completion."
1681 n)
1682 ;; next-matching-history-element always puts us at (point-min).
1683 ;; Move to the position we were at before changing the buffer contents.
1684 ;; This is still sensible, because the text before point has not changed.
1688 "\
1689 Get previous history element which completes the minibuffer before the point.
1690 The contents of the minibuffer after the point are deleted, and replaced
1691 by the new completion."
1695 ;; For compatibility with the old subr of the same name.
1697 "Return the display width of the minibuffer prompt.
1698 Return 0 if current buffer is not a minibuffer."
1699 ;; Return the width of everything before the field at the end of
1700 ;; the buffer; this should be 0 for normal buffers.
1702 \f
1703 ;; isearch minibuffer history
1710 "Set up a minibuffer for using isearch to search the minibuffer history.
1711 Intended to be added to `minibuffer-setup-hook'."
1723 "Clean up the minibuffer after terminating isearch in the minibuffer."
1728 "Return the proper search function, for isearch in minibuffer history."
1731 ;; Use standard functions to search within minibuffer text
1733 found)
1734 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1735 ;; searching forward. Lazy-highlight calls this lambda with the
1736 ;; bound arg, so skip the minibuffer prompt.
1740 ;; 1. First try searching in the initial minibuffer text
1743 noerror)
1744 ;; 2. If the above search fails, start putting next/prev history
1745 ;; elements in the minibuffer successively, and search the string
1746 ;; in them. Do this only when bound is nil (i.e. not while
1747 ;; lazy-highlighting search strings in the current minibuffer text).
1759 ;; After putting the next/prev history element, search
1760 ;; the string in them again, until next-history-element
1761 ;; or previous-history-element raises an error at the
1762 ;; beginning/end of history.
1765 ;; For backward search, don't search
1766 ;; in the minibuffer prompt
1768 noerror)))
1769 ;; Return point of the new search result
1771 ;; Return nil when next(prev)-history-element fails
1775 "Display the minibuffer history search prompt.
1776 If there are no search errors, this function displays an overlay with
1777 the isearch prompt which replaces the original minibuffer prompt.
1778 Otherwise, it displays the standard isearch message returned from
1779 `isearch-message'."
1781 ;; Use standard function `isearch-message' when not in the minibuffer,
1782 ;; or search fails, or has an error (like incomplete regexp).
1783 ;; This function overwrites minibuffer text with isearch message,
1784 ;; so it's possible to see what is wrong in the search string.
1786 ;; Otherwise, put the overlay with the standard isearch prompt over
1787 ;; the initial minibuffer prompt.
1796 ;; And clear any previous isearch message.
1800 "Wrap the minibuffer history search when search fails.
1801 Move point to the first history element for a forward search,
1802 or to the last history element for a backward search."
1803 ;; When `minibuffer-history-isearch-search' fails on reaching the
1804 ;; beginning/end of the history, wrap the search to the first/last
1805 ;; minibuffer history element.
1813 "Save a function restoring the state of minibuffer history search.
1814 Save `minibuffer-history-position' to the additional state parameter
1815 in the search status stack."
1820 "Restore the minibuffer history search state.
1821 Go to the history element by the absolute history position HIST-POS."
1824 \f
1825 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1829 "Table mapping redo records to the corresponding undo one.
1830 A redo record for undo-in-region maps to t.
1840 "Within a run of consecutive undo commands, list remaining to be undone.
1844 "Undo some previous changes.
1845 Repeat this command to undo more changes.
1846 A numeric ARG serves as a repeat count.
1848 In Transient Mark mode when the mark is active, only undo changes within
1850 as an argument limits undo to changes within the current region."
1852 ;; Make last-command indicate for the next command that this was an undo.
1853 ;; That way, another undo will undo more.
1854 ;; If we get to the end of the undo history and get an error,
1855 ;; another undo command will find the undo history empty
1856 ;; and will get another error. To begin undoing the undos,
1857 ;; you must type some other command.
1859 ;; For an indirect buffer, look in the base buffer for the
1860 ;; auto-save data.
1864 message)
1865 ;; If we get an error in undo-start,
1866 ;; the next command should not be a "consecutive undo".
1867 ;; So set `this-command' to something other than `undo'.
1872 ;; If something (a timer or filter?) changed the buffer
1873 ;; since the previous command, don't continue the undo seq.
1877 ;; If the last undo record made was made by undo
1878 ;; it shows nothing else happened in between.
1885 ;; get rid of initial undo boundary
1887 ;; If we got this far, the next command should be a consecutive undo.
1889 ;; Check to see whether we're hitting a redo record, and if
1890 ;; so, ask the user whether she wants to skip the redo/undo pair.
1898 ;; The equiv entry might point to another redo record if we have done
1899 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1907 ;; Record the fact that the just-generated undo records come from an
1908 ;; undo operation--that is, they are redo records.
1909 ;; In the ordinary case (not within a region), map the redo
1910 ;; record to the following undos.
1911 ;; I don't know how to do that in the undo-in-region case.
1913 ;; Strip any leading undo boundaries there might be, like we do
1914 ;; above when checking.
1918 undo-equiv-table))
1919 ;; Don't specify a position in the undo record for the undo command.
1920 ;; Instead, undoing this should move point to where the change is.
1939 ;; Record what the current undo list says,
1940 ;; so the next command can tell if the buffer was modified in between.
1944 ;; Display a message announcing success.
1949 "Make BUFFER stop keeping undo information.
1950 No argument or nil as argument means do this for the current buffer."
1956 "Undo some previous changes.
1957 Repeat this command to undo more changes.
1958 A numeric ARG serves as a repeat count.
1959 Contrary to `undo', this will not redo a previous undo."
1964 "Non-nil while performing an undo.
1968 "Undo back N undo-boundaries beyond what was already undone recently.
1969 Call `undo-start' to get ready to undo recent changes,
1970 then call `undo-more' one or more times to undo them."
1975 ;; Note: The following, while pulling elements off
1976 ;; `pending-undo-list' will call primitive change functions which
1977 ;; will push more elements onto `buffer-undo-list'.
1982 ;; Deep copy of a list
1984 "Make a copy of undo list LIST."
1990 elt))
1993 "Set `pending-undo-list' to the front of the undo list.
1994 The next call to `undo-more' will undo the most recently made change.
1995 If BEG and END are specified, then only undo elements
1996 that apply to text between BEG and END are used; other undo elements
1997 are ignored. If BEG and END are nil, all undo elements are used."
2003 buffer-undo-list)))
2008 "Return a list of undo elements for the region START to END.
2009 The elements come from `buffer-undo-list', but we keep only
2010 the elements inside this region, and discard those outside this region.
2011 If we find an element that crosses an edge of this region,
2012 we stop and ignore all further elements."
2015 undo-adjusted-markers
2016 some-rejected
2017 undo-elt temp-undo-list delta)
2022 ;; This is a "was unmodified" element.
2023 ;; Keep it if we have kept everything thus far.
2030 ;; Don't put two nils together in the list
2044 ;; Loop down the earlier events adjusting their buffer
2045 ;; positions to reflect the fact that a change to the buffer
2046 ;; isn't being undone. We only need to process those element
2047 ;; types which undo-elt-in-region will return as being in
2048 ;; the region since only those types can ever get into the
2049 ;; output
2058 ;; (TEXT . POSITION)
2065 ;; (BEGIN . END)
2070 ;; (nil PROPERTY VALUE BEG . END)
2080 "Determine whether UNDO-ELT falls inside the region START ... END.
2081 If it crosses the edge, we return nil."
2086 t)
2088 nil)
2090 ;; (TEXT . POSITION)
2094 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2095 ;; See if MARKER is inside the region.
2106 ;; (nil PROPERTY VALUE BEG . END)
2111 ;; (BEGIN . END)
2116 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2117 This assumes we have already decided that UNDO-ELT
2118 is not *inside* the region START...END."
2121 ;; (nil PROPERTY VALUE BEG . END)
2126 ;; (BEGIN . END)
2130 ;; Return the first affected buffer position and the delta for an undo element
2131 ;; delta is defined as the change in subsequent buffer positions if we *did*
2132 ;; the undo.
2136 ;; (TEXT . POSITION)
2139 ;; (BEGIN . END)
2146 "If non-nil ask about discarding undo info for the current command.
2147 Normally, Emacs discards the undo info for the current command if
2148 it exceeds `undo-outer-limit'. But if you set this option
2149 non-nil, it asks in the echo area whether to discard the info.
2150 If you answer no, there is a slight risk that Emacs might crash, so
2151 only do it if you really want to undo the command.
2153 This option is mainly intended for debugging. You have to be
2154 careful if you use it for other purposes. Garbage collection is
2155 inhibited while the question is asked, meaning that Emacs might
2156 leak memory. So you should make sure that you do not wait
2157 excessively long before answering the question."
2163 "If non-nil, an extra level of size that's ok in an undo item.
2164 We don't ask the user about truncating the undo list until the
2165 current item gets bigger than this amount.
2170 ;; When the first undo batch in an undo list is longer than
2171 ;; undo-outer-limit, this function gets called to warn the user that
2172 ;; the undo info for the current command was discarded. Garbage
2173 ;; collection is inhibited around the call, so it had better not do a
2174 ;; lot of consing.
2180 ;; Don't ask the question again unless it gets even bigger.
2181 ;; This applies, in particular, if the user quits from the question.
2182 ;; Such a quit quits out of GC, but something else will call GC
2183 ;; again momentarily. It will call this function again,
2184 ;; but we don't want to ask the question again.
2191 t)
2192 nil))
2197 "The undo info was discarded because it exceeded \
2198 `undo-outer-limit'.
2200 This is normal if you executed a command that made a huge change
2201 to the buffer. In that case, to prevent similar problems in the
2202 future, set `undo-outer-limit' to a value that is large enough to
2203 cover the maximum size of normal changes you expect a single
2204 command to make, but not so large that it might exceed the
2205 maximum memory allotted to Emacs.
2207 If you did not execute any such command, the situation is
2208 probably due to a bug and you should report it.
2210 You can disable the popping up of this buffer by adding the entry
2211 \(undo discard-info) to the user option `warning-suppress-types',
2215 t))
2216 \f
2218 "History list for some commands that read shell commands.
2220 Maximum length of the history list is determined by the value
2227 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2228 This buffer is used when `shell-command' or `shell-command-on-region'
2229 is run interactively. A value of nil means that output to stderr and
2236 "Return a list of all commands associated with the current file.
2237 This function is used to add all related commands retrieved by `mailcap'
2238 to the end of the list of defaults just after the default value."
2242 minibuffer-default))
2247 commands))
2258 map)
2262 "Read a shell command from the minibuffer.
2263 The arguments are the same as the ones of `read-from-minibuffer',
2264 except READ and KEYMAP are missing and HIST defaults
2265 to `shell-command-history'."
2273 minibuffer-local-shell-command-map
2274 nil
2276 args)))
2279 "What to do when the output buffer is used by another shell command.
2280 This option specifies how to resolve the conflict where a new command
2281 wants to direct its output to the buffer `*Async Shell Command*',
2282 but this buffer is already taken by another running shell command.
2284 The value `confirm-kill-process' is used to ask for confirmation before
2285 killing the already running process and running a new process
2286 in the same buffer, `confirm-new-buffer' for confirmation before running
2287 the command in a new buffer with a name other than the default buffer name,
2288 `new-buffer' for doing the same without confirmation,
2289 `confirm-rename-buffer' for confirmation before renaming the existing
2290 output buffer and running a new command in the default buffer,
2291 `rename-buffer' for doing the same without confirmation."
2293 confirm-kill-process)
2295 confirm-new-buffer)
2297 new-buffer)
2299 confirm-rename-buffer)
2301 rename-buffer))
2306 "Execute string COMMAND asynchronously in background.
2308 Like `shell-command', but adds `&' at the end of COMMAND
2309 to execute it asynchronously.
2311 The output appears in the buffer `*Async Shell Command*'.
2312 That buffer is in shell mode.
2314 In Elisp, you will often be better served by calling `start-process'
2315 directly, since it offers more control and does not impose the use of a
2316 shell (with its need to quote arguments)."
2326 current-prefix-arg
2327 shell-command-default-error-buffer))
2333 "Execute string COMMAND in inferior shell; display output, if any.
2334 With prefix argument, insert the COMMAND's output at point.
2336 If COMMAND ends in `&', execute it asynchronously.
2337 The output appears in the buffer `*Async Shell Command*'.
2338 That buffer is in shell mode. You can also use
2339 `async-shell-command' that automatically adds `&'.
2341 Otherwise, COMMAND is executed synchronously. The output appears in
2342 the buffer `*Shell Command Output*'. If the output is short enough to
2343 display in the echo area (which is determined by the variables
2344 `resize-mini-windows' and `max-mini-window-height'), it is shown
2345 there, but it is nonetheless available in buffer `*Shell Command
2346 Output*' even though that buffer is not automatically displayed.
2348 To specify a coding system for converting non-ASCII characters
2350 before this command.
2352 Noninteractive callers can specify coding systems by binding
2353 `coding-system-for-read' and `coding-system-for-write'.
2355 The optional second argument OUTPUT-BUFFER, if non-nil,
2356 says to put the output in some other buffer.
2357 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2358 If OUTPUT-BUFFER is not a buffer and not nil,
2359 insert output in current buffer. (This cannot be done asynchronously.)
2360 In either case, the buffer is first erased, and the output is
2361 inserted after point (leaving mark after it).
2363 If the command terminates without error, but generates output,
2365 the output can be displayed in the echo area or in its buffer.
2366 If the output is short enough to display in the echo area
2367 \(determined by the variable `max-mini-window-height' if
2368 `resize-mini-windows' is non-nil), it is shown there.
2369 Otherwise,the buffer containing the output is displayed.
2373 of the output.
2375 If there is no output, or if output is inserted in the current buffer,
2376 then `*Shell Command Output*' is deleted.
2378 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2379 or buffer name to which to direct the command's standard error output.
2380 If it is nil, error output is mingled with regular output.
2381 In an interactive call, the variable `shell-command-default-error-buffer'
2382 specifies the value of ERROR-BUFFER.
2384 In Elisp, you will often be better served by calling `call-process' or
2385 `start-process' directly, since it offers more control and does not impose
2386 the use of a shell (with its need to quote arguments)."
2397 current-prefix-arg
2398 shell-command-default-error-buffer))
2399 ;; Look for a handler in case default-directory is a remote file name.
2407 ;; Output goes in current buffer.
2413 temporary-file-directory)))
2414 nil)))
2417 ;; We do not use -f for csh; we will not support broken use of
2418 ;; .cshrcs. Even the BSD csh manual says to use
2419 ;; "if ($?prompt) exit" before things which are not useful
2420 ;; non-interactively. Besides, if someone wants their other
2421 ;; aliases for shell commands then they can still have them.
2425 t)
2426 nil shell-command-switch command)
2433 ;; Do no formatting while reading error file,
2434 ;; because that can run a shell command, and we
2435 ;; don't want that to cause an infinite recursion.
2437 ;; Put point after the inserted errors.
2441 ;; This is like exchange-point-and-mark, but doesn't
2442 ;; activate the mark. It is cleaner to avoid activation,
2443 ;; even though the command loop would deactivate the mark
2444 ;; because we inserted text.
2448 ;; Output goes in a separate buffer.
2449 ;; Preserve the match data in case called from a program.
2452 ;; Command ending with ampersand means asynchronous.
2456 proc)
2457 ;; Remove the ampersand.
2459 ;; Ask the user what to do with already running process.
2464 ;; If will kill a process, query first.
2469 ;; If will create a new buffer, query first.
2475 ;; It will create a new buffer.
2479 ;; If will rename the buffer, query first.
2488 ;; It will rename the buffer.
2495 ;; Setting buffer-read-only to nil doesn't suffice
2496 ;; if some text has a non-nil read-only property,
2497 ;; which comint sometimes adds for prompts.
2503 shell-command-switch command))
2507 ;; Use the comint filter for proper handling of carriage motion
2508 ;; (see `comint-inhibit-carriage-motion'),.
2510 ))
2511 ;; Otherwise, command is executed synchronously.
2513 output-buffer nil error-buffer)))))))
2517 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2518 MESSAGE may be either a string or a buffer.
2520 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2521 the maximum height of the echo area, as defined by `max-mini-window-height'
2522 if `resize-mini-windows' is non-nil.
2524 Returns either the string shown in the echo area, or when a pop-up
2525 buffer is used, the window used to display it.
2527 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2528 name of the buffer used to display it in the case where a pop-up buffer
2529 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2530 string and it is displayed in the echo area, it is not specified whether
2531 the contents are inserted into the buffer anyway.
2533 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2534 and only used if a buffer is displayed."
2536 ;; Trivial case where we can use the echo area
2540 ;; Trivial case where we can just remove single trailing newline
2543 ;; General case
2546 message
2555 0
2559 (<= lines
2563 max-mini-window-height))
2565 max-mini-window-height)
2569 ;; Don't use the echo area if the output buffer is
2570 ;; already displayed in the selected frame.
2572 ;; Echo area
2578 ;; Buffer
2581 not-this-window frame))))))))
2584 ;; We have a sentinel to prevent insertion of a termination message
2585 ;; in the buffer itself.
2593 &optional output-buffer replace
2594 error-buffer display-error-buffer)
2595 "Execute string COMMAND in inferior shell with region as input.
2596 Normally display output (if any) in temp buffer `*Shell Command Output*';
2597 Prefix arg means replace the region with it. Return the exit code of
2598 COMMAND.
2600 To specify a coding system for converting non-ASCII characters
2602 before this command. By default, the input (from the current buffer)
2603 is encoded using coding-system specified by `process-coding-system-alist',
2604 falling back to `default-process-coding-system' if no match for COMMAND
2605 is found in `process-coding-system-alist'.
2607 Noninteractive callers can specify coding systems by binding
2608 `coding-system-for-read' and `coding-system-for-write'.
2610 If the command generates output, the output may be displayed
2611 in the echo area or in a buffer.
2612 If the output is short enough to display in the echo area
2613 \(determined by the variable `max-mini-window-height' if
2614 `resize-mini-windows' is non-nil), it is shown there.
2615 Otherwise it is displayed in the buffer `*Shell Command Output*'.
2616 The output is available in that buffer in both cases.
2618 If there is output and an error, a message about the error
2619 appears at the end of the output. If there is no output, or if
2620 output is inserted in the current buffer, the buffer `*Shell
2621 Command Output*' is deleted.
2623 Optional fourth arg OUTPUT-BUFFER specifies where to put the
2624 command's output. If the value is a buffer or buffer name, put
2625 the output there. Any other value, including nil, means to
2626 insert the output in the current buffer. In either case, the
2627 output is inserted after point (leaving mark after it).
2629 Optional fifth arg REPLACE, if non-nil, means to insert the
2630 output in place of text from START to END, putting point and mark
2631 around it.
2633 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
2634 or buffer name to which to direct the command's standard error
2635 output. If nil, error output is mingled with regular output.
2636 When called interactively, `shell-command-default-error-buffer'
2637 is used for ERROR-BUFFER.
2639 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
2640 display the error buffer if there were any errors. When called
2641 interactively, this is t."
2645 ;; Do this before calling region-beginning
2646 ;; and region-end, in case subprocess output
2647 ;; relocates them while we are in the minibuffer.
2649 ;; call-interactively recognizes region-beginning and
2650 ;; region-end specially, leaving them in the history.
2652 string
2653 current-prefix-arg
2654 current-prefix-arg
2655 shell-command-default-error-buffer
2656 t)))
2662 temporary-file-directory)))
2663 nil))
2664 exit-status)
2668 ;; Replace specified region with output from command.
2670 ;; Don't muck with mark unless REPLACE says we should.
2677 t)
2678 nil shell-command-switch command))
2679 ;; It is rude to delete a buffer which the command is not using.
2680 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2681 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2682 ;; (kill-buffer shell-buffer)))
2683 ;; Don't muck with mark unless REPLACE says we should.
2685 ;; No prefix argument: put the output in a temp buffer,
2686 ;; replacing its entire contents.
2691 ;; If the input is the same buffer as the output,
2692 ;; delete everything but the specified region,
2693 ;; then replace that region with the output.
2699 shell-file-name t
2702 t)
2703 nil shell-command-switch
2704 command)))
2705 ;; Clear the output buffer, then run the command with
2706 ;; output there.
2717 buffer)
2718 nil shell-command-switch command)))
2719 ;; Report the output.
2729 ;; There's some output, display it
2731 ;; No output; error?
2738 shell-command-default-error-buffer)
2745 output))
2748 exit-status))
2751 exit-status output))))
2752 ;; Don't kill: there might be useful info in the undo-log.
2753 ;; (kill-buffer buffer)
2754 ))))
2762 ;; Do no formatting while reading error file,
2763 ;; because that can run a shell command, and we
2764 ;; don't want that to cause an infinite recursion.
2766 ;; Put point after the inserted errors.
2771 exit-status))
2774 "Execute shell command COMMAND and return its output as a string."
2777 standard-output
2781 "Process files synchronously in a separate process.
2782 Similar to `call-process', but may invoke a file handler based on
2783 `default-directory'. The current working directory of the
2784 subprocess is `default-directory'.
2786 File names in INFILE and BUFFER are handled normally, but file
2787 names in ARGS should be relative to `default-directory', as they
2788 are passed to the process verbatim. \(This is a difference to
2789 `call-process' which does not support file handlers for INFILE
2790 and BUFFER.\)
2792 Some file handlers might not support all variants, for example
2793 they might behave as if DISPLAY was nil, regardless of the actual
2794 value passed."
2796 lc stderr-file)
2806 display args)
2812 "Whether a call of `process-file' changes remote files.
2814 By default, this variable is always set to `t', meaning that a
2815 call of `process-file' could potentially change any file on a
2816 remote host. When set to `nil', a file handler could optimize
2817 its behavior with respect to remote file attribute caching.
2819 You should only ever change this variable with a let-binding;
2823 "Start a program in a subprocess. Return the process object for it.
2825 Similar to `start-process', but may invoke a file handler based on
2826 `default-directory'. See Info node `(elisp)Magic File Names'.
2828 This handler ought to run PROGRAM, perhaps on the local host,
2829 perhaps on a remote host that corresponds to `default-directory'.
2830 In the latter case, the local part of `default-directory' becomes
2831 the working directory of the process.
2833 PROGRAM and PROGRAM-ARGS might be file names. They are not
2834 objects of file handler invocation. File handlers might not
2835 support pty association, if PROGRAM is nil."
2839 \f
2840 ;;;; Process menu
2852 "Major mode for listing the processes called by Emacs."
2864 "Recompute the list of processes for the Process List buffer.
2865 Also, delete any process that is exited or signaled."
2878 face link
2881 follow-link t
2882 process-buffer ,buf
2883 action process-menu-visit-buffer)
2892 "datagram"
2909 tabulated-list-entries))))))
2915 "Display a list of all processes.
2916 If optional argument QUERY-ONLY is non-nil, only processes with
2917 the query-on-exit flag set are listed.
2918 Any process listed as exited or signaled is actually eliminated
2919 after the listing is made.
2920 Optional argument BUFFER specifies a buffer to use, instead of
2922 The return value is always nil."
2934 nil)
2935 \f
2939 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2940 (define-key map [switch-frame] nil)
2941 (define-key map [?\C-u] 'universal-argument-more)
2942 (define-key map [?-] 'universal-argument-minus)
2943 (define-key map [?0] 'digit-argument)
2944 (define-key map [?1] 'digit-argument)
2945 (define-key map [?2] 'digit-argument)
2946 (define-key map [?3] 'digit-argument)
2947 (define-key map [?4] 'digit-argument)
2948 (define-key map [?5] 'digit-argument)
2949 (define-key map [?6] 'digit-argument)
2950 (define-key map [?7] 'digit-argument)
2951 (define-key map [?8] 'digit-argument)
2952 (define-key map [?9] 'digit-argument)
2953 (define-key map [kp-0] 'digit-argument)
2954 (define-key map [kp-1] 'digit-argument)
2955 (define-key map [kp-2] 'digit-argument)
2956 (define-key map [kp-3] 'digit-argument)
2957 (define-key map [kp-4] 'digit-argument)
2958 (define-key map [kp-5] 'digit-argument)
2959 (define-key map [kp-6] 'digit-argument)
2960 (define-key map [kp-7] 'digit-argument)
2961 (define-key map [kp-8] 'digit-argument)
2962 (define-key map [kp-9] 'digit-argument)
2963 (define-key map [kp-subtract] 'universal-argument-minus)
2964 map)
2967 (defvar universal-argument-num-events nil
2968 "Number of argument-specifying events read by `universal-argument'.
2969 `universal-argument-other-key' uses this to discard those events
2970 from (this-command-keys), and reread only the final command.")
2972 (defvar saved-overriding-map t
2973 "The saved value of `overriding-terminal-local-map'.
2977 (defun save&set-overriding-map (map)
2978 "Set `overriding-terminal-local-map' to MAP."
2979 (when (eq saved-overriding-map t)
2980 (setq saved-overriding-map overriding-terminal-local-map)
2981 (setq overriding-terminal-local-map map)))
2983 (defun restore-overriding-map ()
2984 "Restore `overriding-terminal-local-map' to its saved value."
2985 (setq overriding-terminal-local-map saved-overriding-map)
2986 (setq saved-overriding-map t))
2988 (defun universal-argument ()
2989 "Begin a numeric argument for the following command.
2994 multiplies the argument by 4 each time.
2996 which is different in effect from any particular numeric argument.
2998 (interactive)
2999 (setq prefix-arg (list 4))
3000 (setq universal-argument-num-events (length (this-command-keys)))
3001 (save&set-overriding-map universal-argument-map))
3003 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3004 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3005 (defun universal-argument-more (arg)
3006 (interactive "P")
3007 (if (consp arg)
3008 (setq prefix-arg (list (* 4 (car arg))))
3009 (if (eq arg '-)
3010 (setq prefix-arg (list -4))
3011 (setq prefix-arg arg)
3012 (restore-overriding-map)))
3013 (setq universal-argument-num-events (length (this-command-keys))))
3015 (defun negative-argument (arg)
3016 "Begin a negative numeric argument for the next command.
3018 (interactive "P")
3019 (cond ((integerp arg)
3020 (setq prefix-arg (- arg)))
3021 ((eq arg '-)
3022 (setq prefix-arg nil))
3023 (t
3024 (setq prefix-arg '-)))
3025 (setq universal-argument-num-events (length (this-command-keys)))
3026 (save&set-overriding-map universal-argument-map))
3028 (defun digit-argument (arg)
3029 "Part of the numeric argument for the next command.
3031 (interactive "P")
3032 (let* ((char (if (integerp last-command-event)
3033 last-command-event
3034 (get last-command-event 'ascii-character)))
3036 (cond ((integerp arg)
3037 (setq prefix-arg (+ (* arg 10)
3038 (if (< arg 0) (- digit) digit))))
3039 ((eq arg '-)
3040 ;; Treat -0 as just -, so that -01 will work.
3041 (setq prefix-arg (if (zerop digit) '- (- digit))))
3042 (t
3043 (setq prefix-arg digit))))
3044 (setq universal-argument-num-events (length (this-command-keys)))
3045 (save&set-overriding-map universal-argument-map))
3047 ;; For backward compatibility, minus with no modifiers is an ordinary
3048 ;; command if digits have already been entered.
3049 (defun universal-argument-minus (arg)
3050 (interactive "P")
3051 (if (integerp arg)
3052 (universal-argument-other-key arg)
3053 (negative-argument arg)))
3055 ;; Anything else terminates the argument and is left in the queue to be
3056 ;; executed as a command.
3057 (defun universal-argument-other-key (arg)
3058 (interactive "P")
3059 (setq prefix-arg arg)
3060 (let* ((key (this-command-keys))
3061 (keylist (listify-key-sequence key)))
3062 (setq unread-command-events
3063 (append (nthcdr universal-argument-num-events keylist)
3064 unread-command-events)))
3065 (reset-this-command-lengths)
3066 (restore-overriding-map))
3067 \f
3069 (defvar filter-buffer-substring-functions nil
3070 "This variable is a wrapper hook around `filter-buffer-substring'.
3071 Each member of the hook should be a function accepting four arguments:
3072 \(FUN BEG END DELETE), where FUN is itself a function of three arguments
3073 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
3074 as those of `filter-buffer-substring' in each case.
3076 The first hook function to be called receives a FUN equivalent
3077 to the default operation of `filter-buffer-substring',
3078 i.e. one that returns the buffer-substring between BEG and
3079 END (processed by any `buffer-substring-filters'). Normally,
3080 the hook function will call FUN and then do its own processing
3081 of the result. The next hook function receives a FUN equivalent
3082 to the previous hook function, calls it, and does its own
3083 processing, and so on. The overall result is that of all hook
3084 functions acting in sequence.
3086 Any hook may choose not to call FUN though, in which case it
3087 effectively replaces the default behavior with whatever it chooses.
3088 Of course, a later hook function may do the same thing.")
3090 (defvar buffer-substring-filters nil
3091 "List of filter functions for `filter-buffer-substring'.
3092 Each function must accept a single argument, a string, and return
3093 a string. The buffer substring is passed to the first function
3094 in the list, and the return value of each function is passed to
3095 the next. The final result (if `buffer-substring-filters' is
3096 nil, this is the unfiltered buffer-substring) is passed to the
3097 first function on `filter-buffer-substring-functions'.
3099 As a special convention, point is set to the start of the buffer text
3100 being operated on (i.e., the first argument of `filter-buffer-substring')
3101 before these functions are called.")
3102 (make-obsolete-variable 'buffer-substring-filters
3103 'filter-buffer-substring-functions "24.1")
3105 (defun filter-buffer-substring (beg end &optional delete)
3106 "Return the buffer substring between BEG and END, after filtering.
3107 The wrapper hook `filter-buffer-substring-functions' performs
3108 the actual filtering. The obsolete variable `buffer-substring-filters'
3109 is also consulted. If both of these are nil, no filtering is done.
3111 If DELETE is non-nil, the text between BEG and END is deleted
3112 from the buffer.
3114 This function should be used instead of `buffer-substring',
3115 `buffer-substring-no-properties', or `delete-and-extract-region'
3116 when you want to allow filtering to take place. For example,
3117 major or minor modes can use `filter-buffer-substring-functions' to
3118 extract characters that are special to a buffer, and should not
3119 be copied into other buffers."
3120 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
3121 (cond
3122 ((or delete buffer-substring-filters)
3123 (save-excursion
3124 (goto-char beg)
3125 (let ((string (if delete (delete-and-extract-region beg end)
3126 (buffer-substring beg end))))
3127 (dolist (filter buffer-substring-filters)
3128 (setq string (funcall filter string)))
3129 string)))
3130 (t
3131 (buffer-substring beg end)))))
3134 ;;;; Window system cut and paste hooks.
3136 (defvar interprogram-cut-function nil
3137 "Function to call to make a killed region available to other programs.
3138 Most window systems provide a facility for cutting and pasting
3139 text between different programs, such as the clipboard on X and
3140 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3142 This variable holds a function that Emacs calls whenever text is
3143 put in the kill ring, to make the new kill available to other
3144 programs. The function takes one argument, TEXT, which is a
3145 string containing the text which should be made available.")
3147 (defvar interprogram-paste-function nil
3148 "Function to call to get text cut from other programs.
3149 Most window systems provide a facility for cutting and pasting
3150 text between different programs, such as the clipboard on X and
3151 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3153 This variable holds a function that Emacs calls to obtain text
3154 that other programs have provided for pasting. The function is
3155 called with no arguments. If no other program has provided text
3156 to paste, the function should return nil (in which case the
3157 caller, usually `current-kill', should use the top of the Emacs
3158 kill ring). If another program has provided text to paste, the
3159 function should return that text as a string (in which case the
3160 caller should put this string in the kill ring as the latest
3161 kill).
3163 The function may also return a list of strings if the window
3164 system supports multiple selections. The first string will be
3165 used as the pasted text, but the other will be placed in the kill
3166 ring for easy access via `yank-pop'.
3168 Note that the function should return a string only if a program
3169 other than Emacs has provided a string for pasting; if Emacs
3170 provided the most recent string, the function should return nil.
3171 If it is difficult to tell whether Emacs or some other program
3172 provided the current string, it is probably good enough to return
3173 nil if the string is equal (according to `string=') to the last
3174 text Emacs provided.")
3175 \f
3178 ;;;; The kill ring data structure.
3180 (defvar kill-ring nil
3181 "List of killed text sequences.
3182 Since the kill ring is supposed to interact nicely with cut-and-paste
3183 facilities offered by window systems, use of this variable should
3184 interact nicely with `interprogram-cut-function' and
3185 `interprogram-paste-function'. The functions `kill-new',
3186 `kill-append', and `current-kill' are supposed to implement this
3187 interaction; you may want to use them instead of manipulating the kill
3188 ring directly.")
3190 (defcustom kill-ring-max 60
3191 "Maximum length of kill ring before oldest elements are thrown away."
3192 :type 'integer
3193 :group 'killing)
3195 (defvar kill-ring-yank-pointer nil
3196 "The tail of the kill ring whose car is the last thing yanked.")
3198 (defcustom save-interprogram-paste-before-kill nil
3199 "Save clipboard strings into kill ring before replacing them.
3200 When one selects something in another program to paste it into Emacs,
3201 but kills something in Emacs before actually pasting it,
3202 this selection is gone unless this variable is non-nil,
3203 in which case the other program's selection is saved in the `kill-ring'
3205 :type 'boolean
3206 :group 'killing
3207 :version "23.2")
3209 (defcustom kill-do-not-save-duplicates nil
3210 "Do not add a new string to `kill-ring' if it duplicates the last one.
3211 The comparison is done using `equal-including-properties'."
3212 :type 'boolean
3213 :group 'killing
3214 :version "23.2")
3216 (defun kill-new (string &optional replace yank-handler)
3217 "Make STRING the latest kill in the kill ring.
3218 Set `kill-ring-yank-pointer' to point to it.
3219 If `interprogram-cut-function' is non-nil, apply it to STRING.
3220 Optional second argument REPLACE non-nil means that STRING will replace
3221 the front of the kill ring, rather than being added to the list.
3223 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3224 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3225 STRING.
3227 When the yank handler has a non-nil PARAM element, the original STRING
3228 argument is not used by `insert-for-yank'. However, since Lisp code
3229 may access and use elements from the kill ring directly, the STRING
3231 (if (> (length string) 0)
3232 (if yank-handler
3233 (put-text-property 0 (length string)
3234 'yank-handler yank-handler string))
3235 (if yank-handler
3236 (signal 'args-out-of-range
3237 (list string "yank-handler specified for empty string"))))
3238 (unless (and kill-do-not-save-duplicates
3239 ;; Due to text properties such as 'yank-handler that
3240 ;; can alter the contents to yank, comparison using
3241 ;; `equal' is unsafe.
3242 (equal-including-properties string (car kill-ring)))
3243 (if (fboundp 'menu-bar-update-yank-menu)
3244 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3245 (when save-interprogram-paste-before-kill
3246 (let ((interprogram-paste (and interprogram-paste-function
3247 (funcall interprogram-paste-function))))
3248 (when interprogram-paste
3249 (dolist (s (if (listp interprogram-paste)
3250 (nreverse interprogram-paste)
3251 (list interprogram-paste)))
3252 (unless (and kill-do-not-save-duplicates
3253 (equal-including-properties s (car kill-ring)))
3254 (push s kill-ring))))))
3255 (unless (and kill-do-not-save-duplicates
3256 (equal-including-properties string (car kill-ring)))
3257 (if (and replace kill-ring)
3258 (setcar kill-ring string)
3259 (push string kill-ring)
3260 (if (> (length kill-ring) kill-ring-max)
3261 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3262 (setq kill-ring-yank-pointer kill-ring)
3263 (if interprogram-cut-function
3264 (funcall interprogram-cut-function string)))
3265 (set-advertised-calling-convention
3266 'kill-new '(string &optional replace) "23.3")
3268 (defun kill-append (string before-p &optional yank-handler)
3269 "Append STRING to the end of the latest kill in the kill ring.
3270 If BEFORE-P is non-nil, prepend STRING to the kill.
3271 If `interprogram-cut-function' is set, pass the resulting kill to it."
3272 (let* ((cur (car kill-ring)))
3273 (kill-new (if before-p (concat string cur) (concat cur string))
3274 (or (= (length cur) 0)
3275 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3276 yank-handler)))
3277 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3279 (defcustom yank-pop-change-selection nil
3280 "Whether rotating the kill ring changes the window system selection.
3281 If non-nil, whenever the kill ring is rotated (usually via the
3282 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3283 to copy the new kill to the window system selection."
3284 :type 'boolean
3285 :group 'killing
3286 :version "23.1")
3288 (defun current-kill (n &optional do-not-move)
3289 "Rotate the yanking point by N places, and then return that kill.
3290 If N is zero and `interprogram-paste-function' is set to a
3291 function that returns a string or a list of strings, and if that
3292 function doesn't return nil, then that string (or list) is added
3293 to the front of the kill ring and the string (or first string in
3294 the list) is returned as the latest kill.
3296 If N is not zero, and if `yank-pop-change-selection' is
3297 non-nil, use `interprogram-cut-function' to transfer the
3298 kill at the new yank point into the window system selection.
3300 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3301 move the yanking point; just return the Nth kill forward."
3303 (let ((interprogram-paste (and (= n 0)
3304 interprogram-paste-function
3305 (funcall interprogram-paste-function))))
3306 (if interprogram-paste
3307 (progn
3308 ;; Disable the interprogram cut function when we add the new
3309 ;; text to the kill ring, so Emacs doesn't try to own the
3310 ;; selection, with identical text.
3311 (let ((interprogram-cut-function nil))
3312 (if (listp interprogram-paste)
3313 (mapc 'kill-new (nreverse interprogram-paste))
3314 (kill-new interprogram-paste)))
3315 (car kill-ring))
3316 (or kill-ring (error "Kill ring is empty"))
3317 (let ((ARGth-kill-element
3318 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3319 (length kill-ring))
3320 kill-ring)))
3321 (unless do-not-move
3322 (setq kill-ring-yank-pointer ARGth-kill-element)
3323 (when (and yank-pop-change-selection
3324 (> n 0)
3325 interprogram-cut-function)
3326 (funcall interprogram-cut-function (car ARGth-kill-element))))
3327 (car ARGth-kill-element)))))
3331 ;;;; Commands for manipulating the kill ring.
3333 (defcustom kill-read-only-ok nil
3334 "Non-nil means don't signal an error for killing read-only text."
3335 :type 'boolean
3336 :group 'killing)
3338 (defun kill-region (beg end &optional yank-handler)
3340 This deletes the text from the buffer and saves it in the kill ring.
3344 If you want to append the killed region to the last killed text,
3347 If the buffer is read-only, Emacs will beep and refrain from deleting
3348 the text, but put the text in the kill ring anyway. This means that
3349 you can use the killing commands to copy text from a read-only buffer.
3351 Lisp programs should use this function for killing text.
3352 (To delete text, use `delete-region'.)
3353 Supply two arguments, character positions indicating the stretch of text
3354 to be killed.
3356 If the previous command was also a kill command,
3357 the text killed this time appends to the text killed last time
3358 to make one entry in the kill ring."
3359 ;; Pass point first, then mark, because the order matters
3360 ;; when calling kill-append.
3361 (interactive (list (point) (mark)))
3362 (unless (and beg end)
3363 (error "The mark is not set now, so there is no region"))
3364 (condition-case nil
3365 (let ((string (filter-buffer-substring beg end t)))
3366 (when string ;STRING is nil if BEG = END
3367 ;; Add that string to the kill ring, one way or another.
3368 (if (eq last-command 'kill-region)
3369 (kill-append string (< end beg) yank-handler)
3370 (kill-new string nil yank-handler)))
3371 (when (or string (eq last-command 'kill-region))
3372 (setq this-command 'kill-region))
3373 nil)
3374 ((buffer-read-only text-read-only)
3375 ;; The code above failed because the buffer, or some of the characters
3376 ;; in the region, are read-only.
3377 ;; We should beep, in case the user just isn't aware of this.
3378 ;; However, there's no harm in putting
3379 ;; the region's text in the kill ring, anyway.
3380 (copy-region-as-kill beg end)
3381 ;; Set this-command now, so it will be set even if we get an error.
3382 (setq this-command 'kill-region)
3383 ;; This should barf, if appropriate, and give us the correct error.
3384 (if kill-read-only-ok
3385 (progn (message "Read only text copied to kill ring") nil)
3386 ;; Signal an error if the buffer is read-only.
3387 (barf-if-buffer-read-only)
3388 ;; If the buffer isn't read-only, the text is.
3389 (signal 'text-read-only (list (current-buffer)))))))
3390 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3392 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3393 ;; to get two copies of the text when the user accidentally types M-w and
3394 ;; then corrects it with the intended C-w.
3395 (defun copy-region-as-kill (beg end)
3396 "Save the region as if killed, but don't kill it.
3397 In Transient Mark mode, deactivate the mark.
3398 If `interprogram-cut-function' is non-nil, also save the text for a window
3399 system cut and paste.
3401 This command's old key binding has been given to `kill-ring-save'."
3402 (interactive "r")
3403 (if (eq last-command 'kill-region)
3404 (kill-append (filter-buffer-substring beg end) (< end beg))
3405 (kill-new (filter-buffer-substring beg end)))
3406 (setq deactivate-mark t)
3407 nil)
3409 (defun kill-ring-save (beg end)
3410 "Save the region as if killed, but don't kill it.
3411 In Transient Mark mode, deactivate the mark.
3412 If `interprogram-cut-function' is non-nil, also save the text for a window
3413 system cut and paste.
3415 If you want to append the killed line to the last killed text,
3418 This command is similar to `copy-region-as-kill', except that it gives
3419 visual feedback indicating the extent of the region being copied."
3420 (interactive "r")
3421 (copy-region-as-kill beg end)
3422 ;; This use of called-interactively-p is correct because the code it
3423 ;; controls just gives the user visual feedback.
3424 (if (called-interactively-p 'interactive)
3425 (indicate-copied-region)))
3427 (defun indicate-copied-region (&optional message-len)
3428 "Indicate that the region text has been copied interactively.
3429 If the mark is visible in the selected window, blink the cursor
3430 between point and mark if there is currently no active region
3431 highlighting.
3433 If the mark lies outside the selected window, display an
3434 informative message containing a sample of the copied text. The
3435 optional argument MESSAGE-LEN, if non-nil, specifies the length
3436 of this sample text; it defaults to 40."
3437 (let ((mark (mark t))
3438 (point (point))
3439 ;; Inhibit quitting so we can make a quit here
3440 ;; look like a C-g typed as a command.
3441 (inhibit-quit t))
3442 (if (pos-visible-in-window-p mark (selected-window))
3443 ;; Swap point-and-mark quickly so as to show the region that
3444 ;; was selected. Don't do it if the region is highlighted.
3445 (unless (and (region-active-p)
3446 (face-background 'region))
3447 ;; Swap point and mark.
3448 (set-marker (mark-marker) (point) (current-buffer))
3449 (goto-char mark)
3450 (sit-for blink-matching-delay)
3451 ;; Swap back.
3452 (set-marker (mark-marker) mark (current-buffer))
3453 (goto-char point)
3454 ;; If user quit, deactivate the mark
3455 ;; as C-g would as a command.
3456 (and quit-flag mark-active
3457 (deactivate-mark)))
3458 (let ((len (min (abs (- mark point))
3459 (or message-len 40))))
3460 (if (< point mark)
3461 ;; Don't say "killed"; that is misleading.
3463 (buffer-substring-no-properties (- mark len) mark))
3465 (buffer-substring-no-properties mark (+ mark len))))))))
3467 (defun append-next-kill (&optional interactive)
3468 "Cause following command, if it kills, to append to previous kill.
3469 The argument is used for internal purposes; do not supply one."
3470 (interactive "p")
3471 ;; We don't use (interactive-p), since that breaks kbd macros.
3472 (if interactive
3473 (progn
3474 (setq this-command 'kill-region)
3475 (message "If the next command is a kill, it will append"))
3476 (setq last-command 'kill-region)))
3477 \f
3478 ;; Yanking.
3480 (defcustom yank-handled-properties
3481 '((font-lock-face . yank-handle-font-lock-face-property)
3482 (category . yank-handle-category-property))
3483 "List of special text property handling conditions for yanking.
3484 Each element should have the form (PROP . FUN), where PROP is a
3485 property symbol and FUN is a function. When the `yank' command
3486 inserts text into the buffer, it scans the inserted text for
3487 stretches of text that have `eq' values of the text property
3488 PROP; for each such stretch of text, FUN is called with three
3489 arguments: the property's value in that text, and the start and
3490 end positions of the text.
3492 This is done prior to removing the properties specified by
3493 `yank-excluded-properties'."
3494 :group 'killing
3495 :version "24.3")
3497 ;; This is actually used in subr.el but defcustom does not work there.
3498 (defcustom yank-excluded-properties
3499 '(category field follow-link fontified font-lock-face help-echo
3500 intangible invisible keymap local-map mouse-face read-only
3501 yank-handler)
3502 "Text properties to discard when yanking.
3503 The value should be a list of text properties to discard or t,
3504 which means to discard all text properties.
3506 See also `yank-handled-properties'."
3507 :type '(choice (const :tag "All" t) (repeat symbol))
3508 :group 'killing
3509 :version "24.3")
3511 (defvar yank-window-start nil)
3512 (defvar yank-undo-function nil
3513 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3514 Function is called with two parameters, START and END corresponding to
3515 the value of the mark and point; it is guaranteed that START <= END.
3516 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3518 (defun yank-pop (&optional arg)
3519 "Replace just-yanked stretch of killed text with a different stretch.
3520 This command is allowed only immediately after a `yank' or a `yank-pop'.
3521 At such a time, the region contains a stretch of reinserted
3522 previously-killed text. `yank-pop' deletes that text and inserts in its
3523 place a different stretch of killed text.
3525 With no argument, the previous kill is inserted.
3526 With argument N, insert the Nth previous kill.
3527 If N is negative, this is a more recent kill.
3529 The sequence of kills wraps around, so that after the oldest one
3530 comes the newest one.
3532 When this command inserts killed text into the buffer, it honors
3533 `yank-excluded-properties' and `yank-handler' as described in the
3534 doc string for `insert-for-yank-1', which see."
3535 (interactive "*p")
3536 (if (not (eq last-command 'yank))
3537 (error "Previous command was not a yank"))
3538 (setq this-command 'yank)
3539 (unless arg (setq arg 1))
3540 (let ((inhibit-read-only t)
3541 (before (< (point) (mark t))))
3542 (if before
3543 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3544 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3545 (setq yank-undo-function nil)
3546 (set-marker (mark-marker) (point) (current-buffer))
3547 (insert-for-yank (current-kill arg))
3548 ;; Set the window start back where it was in the yank command,
3549 ;; if possible.
3550 (set-window-start (selected-window) yank-window-start t)
3551 (if before
3552 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3553 ;; It is cleaner to avoid activation, even though the command
3554 ;; loop would deactivate the mark because we inserted text.
3555 (goto-char (prog1 (mark t)
3556 (set-marker (mark-marker) (point) (current-buffer))))))
3557 nil)
3559 (defun yank (&optional arg)
3561 More precisely, reinsert the most recent kill, which is the
3562 stretch of killed text most recently killed OR yanked. Put point
3563 at the end, and set mark at the beginning without activating it.
3565 With argument N, reinsert the Nth most recent kill.
3567 When this command inserts text into the buffer, it honors the
3568 `yank-handled-properties' and `yank-excluded-properties'
3569 variables, and the `yank-handler' text property. See
3570 `insert-for-yank-1' for details.
3573 (interactive "*P")
3574 (setq yank-window-start (window-start))
3575 ;; If we don't get all the way thru, make last-command indicate that
3576 ;; for the following command.
3577 (setq this-command t)
3578 (push-mark (point))
3579 (insert-for-yank (current-kill (cond
3580 ((listp arg) 0)
3581 ((eq arg '-) -2)
3582 (t (1- arg)))))
3583 (if (consp arg)
3584 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3585 ;; It is cleaner to avoid activation, even though the command
3586 ;; loop would deactivate the mark because we inserted text.
3587 (goto-char (prog1 (mark t)
3588 (set-marker (mark-marker) (point) (current-buffer)))))
3589 ;; If we do get all the way thru, make this-command indicate that.
3590 (if (eq this-command t)
3591 (setq this-command 'yank))
3592 nil)
3594 (defun rotate-yank-pointer (arg)
3595 "Rotate the yanking point in the kill ring.
3596 With ARG, rotate that many kills forward (or backward, if negative)."
3597 (interactive "p")
3598 (current-kill arg))
3599 \f
3600 ;; Some kill commands.
3602 ;; Internal subroutine of delete-char
3603 (defun kill-forward-chars (arg)
3604 (if (listp arg) (setq arg (car arg)))
3605 (if (eq arg '-) (setq arg -1))
3606 (kill-region (point) (+ (point) arg)))
3608 ;; Internal subroutine of backward-delete-char
3609 (defun kill-backward-chars (arg)
3610 (if (listp arg) (setq arg (car arg)))
3611 (if (eq arg '-) (setq arg -1))
3612 (kill-region (point) (- (point) arg)))
3614 (defcustom backward-delete-char-untabify-method 'untabify
3615 "The method for untabifying when deleting backward.
3616 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3617 `hungry' -- delete all whitespace, both tabs and spaces;
3618 `all' -- delete all whitespace, including tabs, spaces and newlines;
3619 nil -- just delete one character."
3620 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3621 :version "20.3"
3622 :group 'killing)
3624 (defun backward-delete-char-untabify (arg &optional killp)
3625 "Delete characters backward, changing tabs into spaces.
3626 The exact behavior depends on `backward-delete-char-untabify-method'.
3627 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3628 Interactively, ARG is the prefix arg (default 1)
3629 and KILLP is t if a prefix arg was specified."
3631 (when (eq backward-delete-char-untabify-method 'untabify)
3632 (let ((count arg))
3633 (save-excursion
3634 (while (and (> count 0) (not (bobp)))
3636 (let ((col (current-column)))
3637 (forward-char -1)
3638 (setq col (- col (current-column)))
3639 (insert-char ?\s col)
3640 (delete-char 1)))
3641 (forward-char -1)
3642 (setq count (1- count))))))
3644 ((eq backward-delete-char-untabify-method 'all)
3646 (n (if skip
3647 (let* ((oldpt (point))
3648 (wh (- oldpt (save-excursion
3649 (skip-chars-backward skip)
3650 (constrain-to-field nil oldpt)))))
3651 (+ arg (if (zerop wh) 0 (1- wh))))
3652 arg)))
3653 ;; Avoid warning about delete-backward-char
3654 (with-no-warnings (delete-backward-char n killp))))
3656 (defun zap-to-char (arg char)
3657 "Kill up to and including ARGth occurrence of CHAR.
3658 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3659 Goes backward if ARG is negative; error if CHAR not found."
3660 (interactive (list (prefix-numeric-value current-prefix-arg)
3661 (read-char "Zap to char: " t)))
3662 ;; Avoid "obsolete" warnings for translation-table-for-input.
3663 (with-no-warnings
3664 (if (char-table-p translation-table-for-input)
3665 (setq char (or (aref translation-table-for-input char) char))))
3666 (kill-region (point) (progn
3667 (search-forward (char-to-string char) nil nil arg)
3668 (point))))
3670 ;; kill-line and its subroutines.
3672 (defcustom kill-whole-line nil
3673 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
3674 :type 'boolean
3675 :group 'killing)
3677 (defun kill-line (&optional arg)
3678 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3679 With prefix argument ARG, kill that many lines from point.
3680 Negative arguments kill lines backward.
3681 With zero argument, kills the text before point on the current line.
3684 a number counts as a prefix arg.
3686 To kill a whole line, when point is not at the beginning, type \
3689 If `show-trailing-whitespace' is non-nil, this command will just
3690 kill the rest of the current line, even if there are only
3691 nonblanks there.
3693 If `kill-whole-line' is non-nil, then this command kills the whole line
3694 including its terminating newline, when used at the beginning of a line
3695 with no argument. As a consequence, you can always kill a whole line
3698 If you want to append the killed line to the last killed text,
3701 If the buffer is read-only, Emacs will beep and refrain from deleting
3702 the line, but put the line in the kill ring anyway. This means that
3703 you can use this command to copy text from a read-only buffer.
3704 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3705 even beep.)"
3706 (interactive "P")
3707 (kill-region (point)
3708 ;; It is better to move point to the other end of the kill
3709 ;; before killing. That way, in a read-only buffer, point
3710 ;; moves across the text that is copied to the kill ring.
3711 ;; The choice has no effect on undo now that undo records
3712 ;; the value of point from before the command was run.
3713 (progn
3714 (if arg
3715 (forward-visible-line (prefix-numeric-value arg))
3716 (if (eobp)
3717 (signal 'end-of-buffer nil))
3718 (let ((end
3719 (save-excursion
3720 (end-of-visible-line) (point))))
3721 (if (or (save-excursion
3722 ;; If trailing whitespace is visible,
3723 ;; don't treat it as nothing.
3724 (unless show-trailing-whitespace
3726 (= (point) end))
3727 (and kill-whole-line (bolp)))
3728 (forward-visible-line 1)
3729 (goto-char end))))
3730 (point))))
3732 (defun kill-whole-line (&optional arg)
3733 "Kill current line.
3734 With prefix ARG, kill that many lines starting from the current line.
3735 If ARG is negative, kill backward. Also kill the preceding newline.
3737 If ARG is zero, kill current line but exclude the trailing newline."
3738 (interactive "p")
3739 (or arg (setq arg 1))
3740 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3741 (signal 'end-of-buffer nil))
3742 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3743 (signal 'beginning-of-buffer nil))
3744 (unless (eq last-command 'kill-region)
3745 (kill-new "")
3746 (setq last-command 'kill-region))
3747 (cond ((zerop arg)
3748 ;; We need to kill in two steps, because the previous command
3749 ;; could have been a kill command, in which case the text
3750 ;; before point needs to be prepended to the current kill
3751 ;; ring entry and the text after point appended. Also, we
3752 ;; need to use save-excursion to avoid copying the same text
3753 ;; twice to the kill ring in read-only buffers.
3754 (save-excursion
3755 (kill-region (point) (progn (forward-visible-line 0) (point))))
3756 (kill-region (point) (progn (end-of-visible-line) (point))))
3757 ((< arg 0)
3758 (save-excursion
3759 (kill-region (point) (progn (end-of-visible-line) (point))))
3760 (kill-region (point)
3761 (progn (forward-visible-line (1+ arg))
3762 (unless (bobp) (backward-char))
3763 (point))))
3764 (t
3765 (save-excursion
3766 (kill-region (point) (progn (forward-visible-line 0) (point))))
3767 (kill-region (point)
3768 (progn (forward-visible-line arg) (point))))))
3770 (defun forward-visible-line (arg)
3771 "Move forward by ARG lines, ignoring currently invisible newlines only.
3772 If ARG is negative, move backward -ARG lines.
3773 If ARG is zero, move to the beginning of the current line."
3774 (condition-case nil
3775 (if (> arg 0)
3776 (progn
3777 (while (> arg 0)
3778 (or (zerop (forward-line 1))
3779 (signal 'end-of-buffer nil))
3780 ;; If the newline we just skipped is invisible,
3781 ;; don't count it.
3782 (let ((prop
3783 (get-char-property (1- (point)) 'invisible)))
3784 (if (if (eq buffer-invisibility-spec t)
3785 prop
3786 (or (memq prop buffer-invisibility-spec)
3787 (assq prop buffer-invisibility-spec)))
3788 (setq arg (1+ arg))))
3789 (setq arg (1- arg)))
3790 ;; If invisible text follows, and it is a number of complete lines,
3791 ;; skip it.
3792 (let ((opoint (point)))
3793 (while (and (not (eobp))
3794 (let ((prop
3795 (get-char-property (point) 'invisible)))
3796 (if (eq buffer-invisibility-spec t)
3797 prop
3798 (or (memq prop buffer-invisibility-spec)
3799 (assq prop buffer-invisibility-spec)))))
3800 (goto-char
3801 (if (get-text-property (point) 'invisible)
3802 (or (next-single-property-change (point) 'invisible)
3803 (point-max))
3804 (next-overlay-change (point)))))
3805 (unless (bolp)
3806 (goto-char opoint))))
3807 (let ((first t))
3808 (while (or first (<= arg 0))
3809 (if first
3810 (beginning-of-line)
3811 (or (zerop (forward-line -1))
3812 (signal 'beginning-of-buffer nil)))
3813 ;; If the newline we just moved to is invisible,
3814 ;; don't count it.
3815 (unless (bobp)
3816 (let ((prop
3817 (get-char-property (1- (point)) 'invisible)))
3818 (unless (if (eq buffer-invisibility-spec t)
3819 prop
3820 (or (memq prop buffer-invisibility-spec)
3821 (assq prop buffer-invisibility-spec)))
3822 (setq arg (1+ arg)))))
3823 (setq first nil))
3824 ;; If invisible text follows, and it is a number of complete lines,
3825 ;; skip it.
3826 (let ((opoint (point)))
3827 (while (and (not (bobp))
3828 (let ((prop
3829 (get-char-property (1- (point)) 'invisible)))
3830 (if (eq buffer-invisibility-spec t)
3831 prop
3832 (or (memq prop buffer-invisibility-spec)
3833 (assq prop buffer-invisibility-spec)))))
3834 (goto-char
3835 (if (get-text-property (1- (point)) 'invisible)
3836 (or (previous-single-property-change (point) 'invisible)
3837 (point-min))
3838 (previous-overlay-change (point)))))
3839 (unless (bolp)
3840 (goto-char opoint)))))
3841 ((beginning-of-buffer end-of-buffer)
3842 nil)))
3844 (defun end-of-visible-line ()
3845 "Move to end of current visible line."
3846 (end-of-line)
3847 ;; If the following character is currently invisible,
3848 ;; skip all characters with that same `invisible' property value,
3849 ;; then find the next newline.
3850 (while (and (not (eobp))
3851 (save-excursion
3853 (let ((prop
3854 (get-char-property (point) 'invisible)))
3855 (if (eq buffer-invisibility-spec t)
3856 prop
3857 (or (memq prop buffer-invisibility-spec)
3858 (assq prop buffer-invisibility-spec))))))
3860 (if (get-text-property (point) 'invisible)
3861 (goto-char (or (next-single-property-change (point) 'invisible)
3862 (point-max)))
3863 (goto-char (next-overlay-change (point))))
3864 (end-of-line)))
3865 \f
3866 (defun insert-buffer (buffer)
3867 "Insert after point the contents of BUFFER.
3868 Puts mark after the inserted text.
3869 BUFFER may be a buffer or a buffer name.
3871 This function is meant for the user to run interactively.
3872 Don't call it from programs: use `insert-buffer-substring' instead!"
3873 (interactive
3874 (list
3875 (progn
3876 (barf-if-buffer-read-only)
3877 (read-buffer "Insert buffer: "
3878 (if (eq (selected-window) (next-window (selected-window)))
3879 (other-buffer (current-buffer))
3880 (window-buffer (next-window (selected-window))))
3881 t))))
3882 (push-mark
3883 (save-excursion
3884 (insert-buffer-substring (get-buffer buffer))
3885 (point)))
3886 nil)
3888 (defun append-to-buffer (buffer start end)
3889 "Append to specified buffer the text of the region.
3890 It is inserted into that buffer before its point.
3892 When calling from a program, give three arguments:
3893 BUFFER (or buffer name), START and END.
3894 START and END specify the portion of the current buffer to be copied."
3895 (interactive
3896 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3897 (region-beginning) (region-end)))
3898 (let* ((oldbuf (current-buffer))
3899 (append-to (get-buffer-create buffer))
3900 (windows (get-buffer-window-list append-to t t))
3901 point)
3902 (save-excursion
3903 (with-current-buffer append-to
3904 (setq point (point))
3905 (barf-if-buffer-read-only)
3906 (insert-buffer-substring oldbuf start end)
3907 (dolist (window windows)
3908 (when (= (window-point window) point)
3909 (set-window-point window (point))))))))
3911 (defun prepend-to-buffer (buffer start end)
3912 "Prepend to specified buffer the text of the region.
3913 It is inserted into that buffer after its point.
3915 When calling from a program, give three arguments:
3916 BUFFER (or buffer name), START and END.
3917 START and END specify the portion of the current buffer to be copied."
3919 (let ((oldbuf (current-buffer)))
3920 (with-current-buffer (get-buffer-create buffer)
3921 (barf-if-buffer-read-only)
3922 (save-excursion
3923 (insert-buffer-substring oldbuf start end)))))
3925 (defun copy-to-buffer (buffer start end)
3926 "Copy to specified buffer the text of the region.
3927 It is inserted into that buffer, replacing existing text there.
3929 When calling from a program, give three arguments:
3930 BUFFER (or buffer name), START and END.
3931 START and END specify the portion of the current buffer to be copied."
3933 (let ((oldbuf (current-buffer)))
3934 (with-current-buffer (get-buffer-create buffer)
3935 (barf-if-buffer-read-only)
3936 (erase-buffer)
3937 (save-excursion
3938 (insert-buffer-substring oldbuf start end)))))
3939 \f
3940 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3941 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3943 (defvar activate-mark-hook nil
3944 "Hook run when the mark becomes active.
3945 It is also run at the end of a command, if the mark is active and
3946 it is possible that the region may have changed.")
3948 (defvar deactivate-mark-hook nil
3949 "Hook run when the mark becomes inactive.")
3951 (defun mark (&optional force)
3952 "Return this buffer's mark value as integer, or nil if never set.
3954 In Transient Mark mode, this function signals an error if
3955 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3956 or the argument FORCE is non-nil, it disregards whether the mark
3957 is active, and returns an integer or nil in the usual way.
3959 If you are using this in an editing command, you are most likely making
3960 a mistake; see the documentation of `set-mark'."
3961 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3962 (marker-position (mark-marker))
3963 (signal 'mark-inactive nil)))
3965 (defsubst deactivate-mark (&optional force)
3966 "Deactivate the mark.
3967 If Transient Mark mode is disabled, this function normally does
3968 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
3970 Deactivating the mark sets `mark-active' to nil, updates the
3971 primary selection according to `select-active-regions', and runs
3972 `deactivate-mark-hook'.
3974 If Transient Mark mode was temporarily enabled, reset the value
3975 of the variable `transient-mark-mode'; if this causes Transient
3976 Mark mode to be disabled, don't change `mark-active' to nil or
3977 run `deactivate-mark-hook'."
3978 (when (or transient-mark-mode force)
3979 (when (and (if (eq select-active-regions 'only)
3980 (eq (car-safe transient-mark-mode) 'only)
3981 select-active-regions)
3982 (region-active-p)
3983 (display-selections-p))
3984 ;; The var `saved-region-selection', if non-nil, is the text in
3985 ;; the region prior to the last command modifying the buffer.
3986 ;; Set the selection to that, or to the current region.
3987 (cond (saved-region-selection
3988 (x-set-selection 'PRIMARY saved-region-selection)
3989 (setq saved-region-selection nil))
3990 ;; If another program has acquired the selection, region
3991 ;; deactivation should not clobber it (Bug#11772).
3992 ((and (/= (region-beginning) (region-end))
3993 (or (x-selection-owner-p 'PRIMARY)
3994 (null (x-selection-exists-p 'PRIMARY))))
3995 (x-set-selection 'PRIMARY
3996 (buffer-substring (region-beginning)
3997 (region-end))))))
3998 (if (and (null force)
3999 (or (eq transient-mark-mode 'lambda)
4000 (and (eq (car-safe transient-mark-mode) 'only)
4001 (null (cdr transient-mark-mode)))))
4002 ;; When deactivating a temporary region, don't change
4003 ;; `mark-active' or run `deactivate-mark-hook'.
4004 (setq transient-mark-mode nil)
4005 (if (eq (car-safe transient-mark-mode) 'only)
4006 (setq transient-mark-mode (cdr transient-mark-mode)))
4007 (setq mark-active nil)
4008 (run-hooks 'deactivate-mark-hook))))
4010 (defun activate-mark ()
4011 "Activate the mark."
4012 (when (mark t)
4013 (setq mark-active t)
4014 (unless transient-mark-mode
4015 (setq transient-mark-mode 'lambda))
4016 (run-hooks 'activate-mark-hook)))
4018 (defun set-mark (pos)
4019 "Set this buffer's mark to POS. Don't use this function!
4020 That is to say, don't use this function unless you want
4021 the user to see that the mark has moved, and you want the previous
4022 mark position to be lost.
4024 Normally, when a new mark is set, the old one should go on the stack.
4025 This is why most applications should use `push-mark', not `set-mark'.
4027 Novice Emacs Lisp programmers often try to use the mark for the wrong
4028 purposes. The mark saves a location for the user's convenience.
4029 Most editing commands should not alter the mark.
4030 To remember a location for internal use in the Lisp program,
4031 store it in a Lisp variable. Example:
4033 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4035 (if pos
4036 (progn
4037 (setq mark-active t)
4038 (run-hooks 'activate-mark-hook)
4039 (set-marker (mark-marker) pos (current-buffer)))
4040 ;; Normally we never clear mark-active except in Transient Mark mode.
4041 ;; But when we actually clear out the mark value too, we must
4042 ;; clear mark-active in any mode.
4043 (deactivate-mark t)
4044 (set-marker (mark-marker) nil)))
4046 (defcustom use-empty-active-region nil
4048 If nil, region-aware commands treat empty regions as inactive.
4049 If non-nil, region-aware commands treat the region as active as
4050 long as the mark is active, even if the region is empty.
4052 Region-aware commands are those that act on the region if it is
4053 active and Transient Mark mode is enabled, and on the text near
4054 point otherwise."
4055 :type 'boolean
4056 :version "23.1"
4057 :group 'editing-basics)
4059 (defun use-region-p ()
4060 "Return t if the region is active and it is appropriate to act on it.
4061 This is used by commands that act specially on the region under
4062 Transient Mark mode.
4064 The return value is t if Transient Mark mode is enabled and the
4065 mark is active; furthermore, if `use-empty-active-region' is nil,
4066 the region must not be empty. Otherwise, the return value is nil.
4068 For some commands, it may be appropriate to ignore the value of
4069 `use-empty-active-region'; in that case, use `region-active-p'."
4070 (and (region-active-p)
4071 (or use-empty-active-region (> (region-end) (region-beginning)))))
4073 (defun region-active-p ()
4074 "Return t if Transient Mark mode is enabled and the mark is active.
4076 Some commands act specially on the region when Transient Mark
4077 mode is enabled. Usually, such commands should use
4078 `use-region-p' instead of this function, because `use-region-p'
4079 also checks the value of `use-empty-active-region'."
4080 (and transient-mark-mode mark-active))
4082 (defvar mark-ring nil
4083 "The list of former marks of the current buffer, most recent first.")
4084 (make-variable-buffer-local 'mark-ring)
4085 (put 'mark-ring 'permanent-local t)
4087 (defcustom mark-ring-max 16
4088 "Maximum size of mark ring. Start discarding off end if gets this big."
4089 :type 'integer
4090 :group 'editing-basics)
4092 (defvar global-mark-ring nil
4093 "The list of saved global marks, most recent first.")
4095 (defcustom global-mark-ring-max 16
4096 "Maximum size of global mark ring. \
4097 Start discarding off end if gets this big."
4098 :type 'integer
4099 :group 'editing-basics)
4101 (defun pop-to-mark-command ()
4102 "Jump to mark, and pop a new position for mark off the ring.
4103 \(Does not affect global mark ring\)."
4104 (interactive)
4105 (if (null (mark t))
4106 (error "No mark set in this buffer")
4107 (if (= (point) (mark t))
4108 (message "Mark popped"))
4109 (goto-char (mark t))
4110 (pop-mark)))
4112 (defun push-mark-command (arg &optional nomsg)
4113 "Set mark at where point is.
4114 If no prefix ARG and mark is already set there, just activate it.
4115 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4116 (interactive "P")
4117 (let ((mark (marker-position (mark-marker))))
4118 (if (or arg (null mark) (/= mark (point)))
4119 (push-mark nil nomsg t)
4120 (setq mark-active t)
4121 (run-hooks 'activate-mark-hook)
4122 (unless nomsg
4123 (message "Mark activated")))))
4125 (defcustom set-mark-command-repeat-pop nil
4128 will pop the mark twice, and
4130 will pop the mark three times.
4134 :type 'boolean
4135 :group 'editing-basics)
4137 (defun set-mark-command (arg)
4138 "Set the mark where point is, or jump to the mark.
4139 Setting the mark also alters the region, which is the text
4140 between point and mark; this is the closest equivalent in
4143 With no prefix argument, set the mark at point, and push the
4144 old mark position on local mark ring. Also push the old mark on
4145 global mark ring, if the previous mark was set in another buffer.
4147 When Transient Mark Mode is off, immediately repeating this
4148 command activates `transient-mark-mode' temporarily.
4151 jump to the mark, and set the mark from
4152 position popped off the local mark ring \(this does not affect the global
4154 mark ring \(see `pop-global-mark'\).
4156 If `set-mark-command-repeat-pop' is non-nil, repeating
4158 off the local (or global) mark ring and jumps there.
4161 argument, unconditionally set mark where point is, even if
4162 `set-mark-command-repeat-pop' is non-nil.
4164 Novice Emacs Lisp programmers often try to use the mark for the wrong
4165 purposes. See the documentation of `set-mark' for more information."
4166 (interactive "P")
4167 (cond ((eq transient-mark-mode 'lambda)
4168 (setq transient-mark-mode nil))
4169 ((eq (car-safe transient-mark-mode) 'only)
4170 (deactivate-mark)))
4171 (cond
4172 ((and (consp arg) (> (prefix-numeric-value arg) 4))
4173 (push-mark-command nil))
4174 ((not (eq this-command 'set-mark-command))
4175 (if arg
4176 (pop-to-mark-command)
4177 (push-mark-command t)))
4178 ((and set-mark-command-repeat-pop
4179 (eq last-command 'pop-to-mark-command))
4180 (setq this-command 'pop-to-mark-command)
4181 (pop-to-mark-command))
4182 ((and set-mark-command-repeat-pop
4183 (eq last-command 'pop-global-mark)
4184 (not arg))
4185 (setq this-command 'pop-global-mark)
4186 (pop-global-mark))
4187 (arg
4188 (setq this-command 'pop-to-mark-command)
4189 (pop-to-mark-command))
4190 ((eq last-command 'set-mark-command)
4191 (if (region-active-p)
4192 (progn
4193 (deactivate-mark)
4194 (message "Mark deactivated"))
4195 (activate-mark)
4196 (message "Mark activated")))
4197 (t
4198 (push-mark-command nil))))
4200 (defun push-mark (&optional location nomsg activate)
4201 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4202 If the last global mark pushed was not in the current buffer,
4203 also push LOCATION on the global mark ring.
4204 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4206 Novice Emacs Lisp programmers often try to use the mark for the wrong
4207 purposes. See the documentation of `set-mark' for more information.
4209 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4210 (unless (null (mark t))
4211 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
4212 (when (> (length mark-ring) mark-ring-max)
4213 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
4214 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
4215 (set-marker (mark-marker) (or location (point)) (current-buffer))
4216 ;; Now push the mark on the global mark ring.
4217 (if (and global-mark-ring
4218 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
4219 ;; The last global mark pushed was in this same buffer.
4220 ;; Don't push another one.
4221 nil
4222 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4223 (when (> (length global-mark-ring) global-mark-ring-max)
4224 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4225 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4226 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4227 (message "Mark set"))
4228 (if (or activate (not transient-mark-mode))
4229 (set-mark (mark t)))
4230 nil)
4232 (defun pop-mark ()
4233 "Pop off mark ring into the buffer's actual mark.
4234 Does not set point. Does nothing if mark ring is empty."
4235 (when mark-ring
4236 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4237 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4238 (move-marker (car mark-ring) nil)
4239 (if (null (mark t)) (ding))
4240 (setq mark-ring (cdr mark-ring)))
4241 (deactivate-mark))
4243 (define-obsolete-function-alias
4244 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4245 (defun exchange-point-and-mark (&optional arg)
4246 "Put the mark where point is now, and point where the mark is now.
4247 This command works even when the mark is not active,
4248 and it reactivates the mark.
4250 If Transient Mark mode is on, a prefix ARG deactivates the mark
4251 if it is active, and otherwise avoids reactivating it. If
4252 Transient Mark mode is off, a prefix ARG enables Transient Mark
4253 mode temporarily."
4254 (interactive "P")
4255 (let ((omark (mark t))
4256 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4257 (if (null omark)
4258 (error "No mark set in this buffer"))
4259 (deactivate-mark)
4260 (set-mark (point))
4261 (goto-char omark)
4262 (cond (temp-highlight
4263 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4264 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4265 (not (or arg (region-active-p))))
4266 (deactivate-mark))
4267 (t (activate-mark)))
4268 nil))
4270 (defcustom shift-select-mode t
4271 "When non-nil, shifted motion keys activate the mark momentarily.
4273 While the mark is activated in this way, any shift-translated point
4274 motion key extends the region, and if Transient Mark mode was off, it
4275 is temporarily turned on. Furthermore, the mark will be deactivated
4276 by any subsequent point motion key that was not shift-translated, or
4277 by any action that normally deactivates the mark in Transient Mark mode.
4279 See `this-command-keys-shift-translated' for the meaning of
4280 shift-translation."
4281 :type 'boolean
4282 :group 'editing-basics)
4284 (defun handle-shift-selection ()
4285 "Activate/deactivate mark depending on invocation thru shift translation.
4286 This function is called by `call-interactively' when a command
4287 with a `^' character in its `interactive' spec is invoked, before
4288 running the command itself.
4290 If `shift-select-mode' is enabled and the command was invoked
4291 through shift translation, set the mark and activate the region
4292 temporarily, unless it was already set in this way. See
4293 `this-command-keys-shift-translated' for the meaning of shift
4294 translation.
4296 Otherwise, if the region has been activated temporarily,
4297 deactivate it, and restore the variable `transient-mark-mode' to
4298 its earlier value."
4299 (cond ((and shift-select-mode this-command-keys-shift-translated)
4300 (unless (and mark-active
4301 (eq (car-safe transient-mark-mode) 'only))
4302 (setq transient-mark-mode
4303 (cons 'only
4304 (unless (eq transient-mark-mode 'lambda)
4305 transient-mark-mode)))
4306 (push-mark nil nil t)))
4307 ((eq (car-safe transient-mark-mode) 'only)
4308 (setq transient-mark-mode (cdr transient-mark-mode))
4309 (deactivate-mark))))
4311 (define-minor-mode transient-mark-mode
4312 "Toggle Transient Mark mode.
4313 With a prefix argument ARG, enable Transient Mark mode if ARG is
4314 positive, and disable it otherwise. If called from Lisp, enable
4315 Transient Mark mode if ARG is omitted or nil.
4317 Transient Mark mode is a global minor mode. When enabled, the
4318 region is highlighted whenever the mark is active. The mark is
4320 operations that set the mark but whose main purpose is something
4326 Many commands change their behavior when Transient Mark mode is
4327 in effect and the mark is active, by acting on the region instead
4328 of their usual default part of the buffer's text. Examples of
4331 To see the documentation of commands which are sensitive to the
4334 :global t
4335 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4336 :variable transient-mark-mode)
4338 (defvar widen-automatically t
4339 "Non-nil means it is ok for commands to call `widen' when they want to.
4340 Some commands will do this in order to go to positions outside
4341 the current accessible part of the buffer.
4343 If `widen-automatically' is nil, these commands will do something else
4344 as a fallback, and won't change the buffer bounds.")
4346 (defvar non-essential nil
4347 "Whether the currently executing code is performing an essential task.
4348 This variable should be non-nil only when running code which should not
4349 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4350 user for a password when we are simply scanning a set of files in the
4351 background or displaying possible completions before the user even asked
4352 for it.")
4354 (defun pop-global-mark ()
4355 "Pop off global mark ring and jump to the top location."
4356 (interactive)
4357 ;; Pop entries which refer to non-existent buffers.
4358 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4359 (setq global-mark-ring (cdr global-mark-ring)))
4360 (or global-mark-ring
4361 (error "No global mark set"))
4362 (let* ((marker (car global-mark-ring))
4363 (buffer (marker-buffer marker))
4364 (position (marker-position marker)))
4365 (setq global-mark-ring (nconc (cdr global-mark-ring)
4366 (list (car global-mark-ring))))
4367 (set-buffer buffer)
4368 (or (and (>= position (point-min))
4369 (<= position (point-max)))
4370 (if widen-automatically
4371 (widen)
4372 (error "Global mark position is outside accessible part of buffer")))
4373 (goto-char position)
4374 (switch-to-buffer buffer)))
4375 \f
4376 (defcustom next-line-add-newlines nil
4377 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4378 :type 'boolean
4379 :version "21.1"
4380 :group 'editing-basics)
4382 (defun next-line (&optional arg try-vscroll)
4383 "Move cursor vertically down ARG lines.
4384 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4385 If there is no character in the target line exactly under the current column,
4386 the cursor is positioned after the character in that line which spans this
4387 column, or at the end of the line if it is not long enough.
4388 If there is no line in the buffer after this one, behavior depends on the
4389 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4390 to create a line, and moves the cursor to that line. Otherwise it moves the
4391 cursor to the end of the buffer.
4393 If the variable `line-move-visual' is non-nil, this command moves
4394 by display lines. Otherwise, it moves by buffer lines, without
4395 taking variable-width characters or continued lines into account.
4398 a semipermanent goal column for this command.
4399 Then instead of trying to move exactly vertically (or as close as possible),
4400 this command moves to the specified goal column (or as close as possible).
4401 The goal column is stored in the variable `goal-column', which is nil
4402 when there is no goal column. Note that setting `goal-column'
4403 overrides `line-move-visual' and causes this command to move by buffer
4404 lines rather than by display lines.
4406 If you are thinking of using this in a Lisp program, consider
4407 using `forward-line' instead. It is usually easier to use
4408 and more reliable (no dependence on goal column, etc.)."
4410 (or arg (setq arg 1))
4411 (if (and next-line-add-newlines (= arg 1))
4412 (if (save-excursion (end-of-line) (eobp))
4413 ;; When adding a newline, don't expand an abbrev.
4414 (let ((abbrev-mode nil))
4415 (end-of-line)
4417 (line-move arg nil nil try-vscroll))
4418 (if (called-interactively-p 'interactive)
4419 (condition-case err
4420 (line-move arg nil nil try-vscroll)
4421 ((beginning-of-buffer end-of-buffer)
4422 (signal (car err) (cdr err))))
4423 (line-move arg nil nil try-vscroll)))
4424 nil)
4426 (defun previous-line (&optional arg try-vscroll)
4427 "Move cursor vertically up ARG lines.
4428 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4429 If there is no character in the target line exactly over the current column,
4430 the cursor is positioned after the character in that line which spans this
4431 column, or at the end of the line if it is not long enough.
4433 If the variable `line-move-visual' is non-nil, this command moves
4434 by display lines. Otherwise, it moves by buffer lines, without
4435 taking variable-width characters or continued lines into account.
4438 a semipermanent goal column for this command.
4439 Then instead of trying to move exactly vertically (or as close as possible),
4440 this command moves to the specified goal column (or as close as possible).
4441 The goal column is stored in the variable `goal-column', which is nil
4442 when there is no goal column. Note that setting `goal-column'
4443 overrides `line-move-visual' and causes this command to move by buffer
4444 lines rather than by display lines.
4446 If you are thinking of using this in a Lisp program, consider using
4447 `forward-line' with a negative argument instead. It is usually easier
4448 to use and more reliable (no dependence on goal column, etc.)."
4450 (or arg (setq arg 1))
4451 (if (called-interactively-p 'interactive)
4452 (condition-case err
4453 (line-move (- arg) nil nil try-vscroll)
4454 ((beginning-of-buffer end-of-buffer)
4455 (signal (car err) (cdr err))))
4456 (line-move (- arg) nil nil try-vscroll))
4457 nil)
4459 (defcustom track-eol nil
4460 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4461 This means moving to the end of each line moved onto.
4462 The beginning of a blank line does not count as the end of a line.
4463 This has no effect when `line-move-visual' is non-nil."
4464 :type 'boolean
4465 :group 'editing-basics)
4467 (defcustom goal-column nil
4469 A non-nil setting overrides `line-move-visual', which see."
4470 :type '(choice integer
4471 (const :tag "None" nil))
4472 :group 'editing-basics)
4473 (make-variable-buffer-local 'goal-column)
4475 (defvar temporary-goal-column 0
4476 "Current goal column for vertical motion.
4477 It is the column where point was at the start of the current run
4478 of vertical motion commands.
4480 When moving by visual lines via `line-move-visual', it is a cons
4481 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4482 divided by the default column width, and HSCROLL is the number of
4483 columns by which window is scrolled from left margin.
4485 When the `track-eol' feature is doing its job, the value is
4486 `most-positive-fixnum'.")
4488 (defcustom line-move-ignore-invisible t
4490 Outline mode sets this."
4491 :type 'boolean
4492 :group 'editing-basics)
4494 (defcustom line-move-visual t
4495 "When non-nil, `line-move' moves point by visual lines.
4496 This movement is based on where the cursor is displayed on the
4497 screen, instead of relying on buffer contents alone. It takes
4498 into account variable-width characters and line continuation.
4499 If nil, `line-move' moves point by logical lines.
4500 A non-nil setting of `goal-column' overrides the value of this variable
4501 and forces movement by logical lines.
4502 A window that is horizontally scrolled also forces movement by logical
4503 lines."
4504 :type 'boolean
4505 :group 'editing-basics
4506 :version "23.1")
4508 ;; Returns non-nil if partial move was done.
4509 (defun line-move-partial (arg noerror to-end)
4510 (if (< arg 0)
4511 ;; Move backward (up).
4512 ;; If already vscrolled, reduce vscroll
4513 (let ((vs (window-vscroll nil t)))
4514 (when (> vs (frame-char-height))
4515 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4517 ;; Move forward (down).
4518 (let* ((lh (window-line-height -1))
4519 (vpos (nth 1 lh))
4520 (ypos (nth 2 lh))
4521 (rbot (nth 3 lh))
4522 py vs)
4523 (when (or (null lh)
4524 (>= rbot (frame-char-height))
4525 (<= ypos (- (frame-char-height))))
4526 (unless lh
4527 (let ((wend (pos-visible-in-window-p t nil t)))
4528 (setq rbot (nth 3 wend)
4529 vpos (nth 5 wend))))
4530 (cond
4531 ;; If last line of window is fully visible, move forward.
4532 ((or (null rbot) (= rbot 0))
4533 nil)
4534 ;; If cursor is not in the bottom scroll margin, move forward.
4535 ((and (> vpos 0)
4536 (< (setq py
4537 (or (nth 1 (window-line-height))
4538 (let ((ppos (posn-at-point)))
4539 (cdr (or (posn-actual-col-row ppos)
4540 (posn-col-row ppos))))))
4541 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4542 nil)
4543 ;; When already vscrolled, we vscroll some more if we can,
4544 ;; or clear vscroll and move forward at end of tall image.
4545 ((> (setq vs (window-vscroll nil t)) 0)
4546 (when (> rbot 0)
4547 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4548 ;; If cursor just entered the bottom scroll margin, move forward,
4549 ;; but also vscroll one line so redisplay won't recenter.
4550 ((and (> vpos 0)
4551 (= py (min (- (window-text-height) scroll-margin 1)
4552 (1- vpos))))
4553 (set-window-vscroll nil (frame-char-height) t)
4554 (line-move-1 arg noerror to-end)
4555 t)
4556 ;; If there are lines above the last line, scroll-up one line.
4557 ((> vpos 0)
4558 (scroll-up 1)
4559 t)
4560 ;; Finally, start vscroll.
4561 (t
4562 (set-window-vscroll nil (frame-char-height) t)))))))
4565 ;; This is like line-move-1 except that it also performs
4566 ;; vertical scrolling of tall images if appropriate.
4567 ;; That is not really a clean thing to do, since it mixes
4568 ;; scrolling with cursor motion. But so far we don't have
4569 ;; a cleaner solution to the problem of making C-n do something
4570 ;; useful given a tall image.
4571 (defun line-move (arg &optional noerror to-end try-vscroll)
4572 (if noninteractive
4573 (forward-line arg)
4574 (unless (and auto-window-vscroll try-vscroll
4575 ;; Only vscroll for single line moves
4576 (= (abs arg) 1)
4577 ;; Under scroll-conservatively, the display engine
4578 ;; does this better.
4579 (zerop scroll-conservatively)
4580 ;; But don't vscroll in a keyboard macro.
4581 (not defining-kbd-macro)
4582 (not executing-kbd-macro)
4583 (line-move-partial arg noerror to-end))
4584 (set-window-vscroll nil 0 t)
4585 (if (and line-move-visual
4586 ;; Display-based column are incompatible with goal-column.
4587 (not goal-column)
4588 ;; When the text in the window is scrolled to the left,
4589 ;; display-based motion doesn't make sense (because each
4590 ;; logical line occupies exactly one screen line).
4591 (not (> (window-hscroll) 0)))
4592 (line-move-visual arg noerror)
4593 (line-move-1 arg noerror to-end)))))
4595 ;; Display-based alternative to line-move-1.
4596 ;; Arg says how many lines to move. The value is t if we can move the
4597 ;; specified number of lines.
4598 (defun line-move-visual (arg &optional noerror)
4599 (let ((opoint (point))
4600 (hscroll (window-hscroll))
4601 target-hscroll)
4602 ;; Check if the previous command was a line-motion command, or if
4603 ;; we were called from some other command.
4604 (if (and (consp temporary-goal-column)
4605 (memq last-command `(next-line previous-line ,this-command)))
4606 ;; If so, there's no need to reset `temporary-goal-column',
4607 ;; but we may need to hscroll.
4608 (if (or (/= (cdr temporary-goal-column) hscroll)
4609 (> (cdr temporary-goal-column) 0))
4610 (setq target-hscroll (cdr temporary-goal-column)))
4611 ;; Otherwise, we should reset `temporary-goal-column'.
4612 (let ((posn (posn-at-point)))
4613 (cond
4614 ;; Handle the `overflow-newline-into-fringe' case:
4615 ((eq (nth 1 posn) 'right-fringe)
4616 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4617 ((car (posn-x-y posn))
4618 (setq temporary-goal-column
4619 (cons (/ (float (car (posn-x-y posn)))
4620 (frame-char-width)) hscroll))))))
4621 (if target-hscroll
4622 (set-window-hscroll (selected-window) target-hscroll))
4623 (or (and (= (vertical-motion
4624 (cons (or goal-column
4625 (if (consp temporary-goal-column)
4626 (car temporary-goal-column)
4627 temporary-goal-column))
4628 arg))
4629 arg)
4630 (or (>= arg 0)
4631 (/= (point) opoint)
4632 ;; If the goal column lies on a display string,
4633 ;; `vertical-motion' advances the cursor to the end
4634 ;; of the string. For arg < 0, this can cause the
4635 ;; cursor to get stuck. (Bug#3020).
4636 (= (vertical-motion arg) arg)))
4637 (unless noerror
4638 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4639 nil)))))
4641 ;; This is the guts of next-line and previous-line.
4642 ;; Arg says how many lines to move.
4643 ;; The value is t if we can move the specified number of lines.
4644 (defun line-move-1 (arg &optional noerror _to-end)
4645 ;; Don't run any point-motion hooks, and disregard intangibility,
4646 ;; for intermediate positions.
4647 (let ((inhibit-point-motion-hooks t)
4648 (opoint (point))
4649 (orig-arg arg))
4650 (if (consp temporary-goal-column)
4651 (setq temporary-goal-column (+ (car temporary-goal-column)
4652 (cdr temporary-goal-column))))
4653 (unwind-protect
4654 (progn
4655 (if (not (memq last-command '(next-line previous-line)))
4656 (setq temporary-goal-column
4657 (if (and track-eol (eolp)
4658 ;; Don't count beg of empty line as end of line
4659 ;; unless we just did explicit end-of-line.
4660 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4661 most-positive-fixnum
4662 (current-column))))
4664 (if (not (or (integerp selective-display)
4665 line-move-ignore-invisible))
4666 ;; Use just newline characters.
4667 ;; Set ARG to 0 if we move as many lines as requested.
4668 (or (if (> arg 0)
4669 (progn (if (> arg 1) (forward-line (1- arg)))
4670 ;; This way of moving forward ARG lines
4671 ;; verifies that we have a newline after the last one.
4672 ;; It doesn't get confused by intangible text.
4673 (end-of-line)
4674 (if (zerop (forward-line 1))
4675 (setq arg 0)))
4676 (and (zerop (forward-line arg))
4677 (bolp)
4678 (setq arg 0)))
4679 (unless noerror
4680 (signal (if (< arg 0)
4681 'beginning-of-buffer
4682 'end-of-buffer)
4683 nil)))
4684 ;; Move by arg lines, but ignore invisible ones.
4685 (let (done)
4686 (while (and (> arg 0) (not done))
4687 ;; If the following character is currently invisible,
4688 ;; skip all characters with that same `invisible' property value.
4689 (while (and (not (eobp)) (invisible-p (point)))
4690 (goto-char (next-char-property-change (point))))
4691 ;; Move a line.
4692 ;; We don't use `end-of-line', since we want to escape
4693 ;; from field boundaries occurring exactly at point.
4694 (goto-char (constrain-to-field
4695 (let ((inhibit-field-text-motion t))
4696 (line-end-position))
4697 (point) t t
4698 'inhibit-line-move-field-capture))
4699 ;; If there's no invisibility here, move over the newline.
4700 (cond
4701 ((eobp)
4702 (if (not noerror)
4703 (signal 'end-of-buffer nil)
4704 (setq done t)))
4705 ((and (> arg 1) ;; Use vertical-motion for last move
4706 (not (integerp selective-display))
4707 (not (invisible-p (point))))
4708 ;; We avoid vertical-motion when possible
4709 ;; because that has to fontify.
4710 (forward-line 1))
4711 ;; Otherwise move a more sophisticated way.
4712 ((zerop (vertical-motion 1))
4713 (if (not noerror)
4714 (signal 'end-of-buffer nil)
4715 (setq done t))))
4716 (unless done
4717 (setq arg (1- arg))))
4718 ;; The logic of this is the same as the loop above,
4719 ;; it just goes in the other direction.
4720 (while (and (< arg 0) (not done))
4721 ;; For completely consistency with the forward-motion
4722 ;; case, we should call beginning-of-line here.
4723 ;; However, if point is inside a field and on a
4724 ;; continued line, the call to (vertical-motion -1)
4725 ;; below won't move us back far enough; then we return
4726 ;; to the same column in line-move-finish, and point
4727 ;; gets stuck -- cyd
4728 (forward-line 0)
4729 (cond
4730 ((bobp)
4731 (if (not noerror)
4732 (signal 'beginning-of-buffer nil)
4733 (setq done t)))
4734 ((and (< arg -1) ;; Use vertical-motion for last move
4735 (not (integerp selective-display))
4736 (not (invisible-p (1- (point)))))
4737 (forward-line -1))
4738 ((zerop (vertical-motion -1))
4739 (if (not noerror)
4740 (signal 'beginning-of-buffer nil)
4741 (setq done t))))
4742 (unless done
4743 (setq arg (1+ arg))
4744 (while (and ;; Don't move over previous invis lines
4745 ;; if our target is the middle of this line.
4746 (or (zerop (or goal-column temporary-goal-column))
4747 (< arg 0))
4748 (not (bobp)) (invisible-p (1- (point))))
4749 (goto-char (previous-char-property-change (point))))))))
4750 ;; This is the value the function returns.
4751 (= arg 0))
4753 (cond ((> arg 0)
4754 ;; If we did not move down as far as desired, at least go
4755 ;; to end of line. Be sure to call point-entered and
4756 ;; point-left-hooks.
4757 (let* ((npoint (prog1 (line-end-position)
4758 (goto-char opoint)))
4759 (inhibit-point-motion-hooks nil))
4760 (goto-char npoint)))
4761 ((< arg 0)
4762 ;; If we did not move up as far as desired,
4763 ;; at least go to beginning of line.
4764 (let* ((npoint (prog1 (line-beginning-position)
4765 (goto-char opoint)))
4766 (inhibit-point-motion-hooks nil))
4767 (goto-char npoint)))
4768 (t
4769 (line-move-finish (or goal-column temporary-goal-column)
4770 opoint (> orig-arg 0)))))))
4772 (defun line-move-finish (column opoint forward)
4773 (let ((repeat t))
4774 (while repeat
4775 ;; Set REPEAT to t to repeat the whole thing.
4776 (setq repeat nil)
4778 (let (new
4779 (old (point))
4780 (line-beg (line-beginning-position))
4781 (line-end
4782 ;; Compute the end of the line
4783 ;; ignoring effectively invisible newlines.
4784 (save-excursion
4785 ;; Like end-of-line but ignores fields.
4787 (while (and (not (eobp)) (invisible-p (point)))
4788 (goto-char (next-char-property-change (point)))
4790 (point))))
4792 ;; Move to the desired column.
4793 (line-move-to-column (truncate column))
4795 ;; Corner case: suppose we start out in a field boundary in
4796 ;; the middle of a continued line. When we get to
4797 ;; line-move-finish, point is at the start of a new *screen*
4798 ;; line but the same text line; then line-move-to-column would
4799 ;; move us backwards. Test using C-n with point on the "x" in
4800 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4801 (and forward
4802 (< (point) old)
4803 (goto-char old))
4805 (setq new (point))
4807 ;; Process intangibility within a line.
4808 ;; With inhibit-point-motion-hooks bound to nil, a call to
4809 ;; goto-char moves point past intangible text.
4811 ;; However, inhibit-point-motion-hooks controls both the
4812 ;; intangibility and the point-entered/point-left hooks. The
4813 ;; following hack avoids calling the point-* hooks
4814 ;; unnecessarily. Note that we move *forward* past intangible
4815 ;; text when the initial and final points are the same.
4816 (goto-char new)
4817 (let ((inhibit-point-motion-hooks nil))
4818 (goto-char new)
4820 ;; If intangibility moves us to a different (later) place
4821 ;; in the same line, use that as the destination.
4822 (if (<= (point) line-end)
4823 (setq new (point))
4824 ;; If that position is "too late",
4825 ;; try the previous allowable position.
4826 ;; See if it is ok.
4827 (backward-char)
4828 (if (if forward
4829 ;; If going forward, don't accept the previous
4830 ;; allowable position if it is before the target line.
4831 (< line-beg (point))
4832 ;; If going backward, don't accept the previous
4833 ;; allowable position if it is still after the target line.
4834 (<= (point) line-end))
4835 (setq new (point))
4836 ;; As a last resort, use the end of the line.
4837 (setq new line-end))))
4839 ;; Now move to the updated destination, processing fields
4840 ;; as well as intangibility.
4841 (goto-char opoint)
4842 (let ((inhibit-point-motion-hooks nil))
4843 (goto-char
4844 ;; Ignore field boundaries if the initial and final
4845 ;; positions have the same `field' property, even if the
4846 ;; fields are non-contiguous. This seems to be "nicer"
4847 ;; behavior in many situations.
4848 (if (eq (get-char-property new 'field)
4849 (get-char-property opoint 'field))
4850 new
4851 (constrain-to-field new opoint t t
4852 'inhibit-line-move-field-capture))))
4854 ;; If all this moved us to a different line,
4855 ;; retry everything within that new line.
4856 (when (or (< (point) line-beg) (> (point) line-end))
4857 ;; Repeat the intangibility and field processing.
4858 (setq repeat t))))))
4860 (defun line-move-to-column (col)
4861 "Try to find column COL, considering invisibility.
4862 This function works only in certain cases,
4863 because what we really need is for `move-to-column'
4864 and `current-column' to be able to ignore invisible text."
4865 (if (zerop col)
4866 (beginning-of-line)
4867 (move-to-column col))
4869 (when (and line-move-ignore-invisible
4870 (not (bolp)) (invisible-p (1- (point))))
4871 (let ((normal-location (point))
4872 (normal-column (current-column)))
4873 ;; If the following character is currently invisible,
4874 ;; skip all characters with that same `invisible' property value.
4875 (while (and (not (eobp))
4876 (invisible-p (point)))
4877 (goto-char (next-char-property-change (point))))
4878 ;; Have we advanced to a larger column position?
4879 (if (> (current-column) normal-column)
4880 ;; We have made some progress towards the desired column.
4881 ;; See if we can make any further progress.
4882 (line-move-to-column (+ (current-column) (- col normal-column)))
4883 ;; Otherwise, go to the place we originally found
4884 ;; and move back over invisible text.
4885 ;; that will get us to the same place on the screen
4886 ;; but with a more reasonable buffer position.
4887 (goto-char normal-location)
4888 (let ((line-beg (line-beginning-position)))
4889 (while (and (not (bolp)) (invisible-p (1- (point))))
4890 (goto-char (previous-char-property-change (point) line-beg))))))))
4892 (defun move-end-of-line (arg)
4893 "Move point to end of current line as displayed.
4894 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4895 If point reaches the beginning or end of buffer, it stops there.
4897 To ignore the effects of the `intangible' text or overlay
4898 property, bind `inhibit-point-motion-hooks' to t.
4899 If there is an image in the current line, this function
4900 disregards newlines that are part of the text on which the image
4901 rests."
4902 (interactive "^p")
4903 (or arg (setq arg 1))
4904 (let (done)
4905 (while (not done)
4906 (let ((newpos
4907 (save-excursion
4908 (let ((goal-column 0)
4909 (line-move-visual nil))
4910 (and (line-move arg t)
4911 ;; With bidi reordering, we may not be at bol,
4912 ;; so make sure we are.
4914 (not (bobp))
4915 (progn
4916 (while (and (not (bobp)) (invisible-p (1- (point))))
4917 (goto-char (previous-single-char-property-change
4918 (point) 'invisible)))
4919 (backward-char 1)))
4920 (point)))))
4921 (goto-char newpos)
4922 (if (and (> (point) newpos)
4924 (backward-char 1)
4925 (if (and (> (point) newpos) (not (eobp))
4927 ;; If we skipped something intangible and now we're not
4928 ;; really at eol, keep going.
4929 (setq arg 1)
4930 (setq done t)))))))
4932 (defun move-beginning-of-line (arg)
4933 "Move point to beginning of current line as displayed.
4934 \(If there's an image in the line, this disregards newlines
4935 which are part of the text that the image rests on.)
4937 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4938 If point reaches the beginning or end of buffer, it stops there.
4939 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4940 (interactive "^p")
4941 (or arg (setq arg 1))
4943 (let ((orig (point))
4944 first-vis first-vis-field-value)
4946 ;; Move by lines, if ARG is not 1 (the default).
4947 (if (/= arg 1)
4948 (let ((line-move-visual nil))
4949 (line-move (1- arg) t)))
4951 ;; Move to beginning-of-line, ignoring fields and invisible text.
4953 (while (and (not (bobp)) (invisible-p (1- (point))))
4954 (goto-char (previous-char-property-change (point)))
4957 ;; Now find first visible char in the line
4958 (while (and (not (eobp)) (invisible-p (point)))
4959 (goto-char (next-char-property-change (point))))
4960 (setq first-vis (point))
4962 ;; See if fields would stop us from reaching FIRST-VIS.
4963 (setq first-vis-field-value
4964 (constrain-to-field first-vis orig (/= arg 1) t nil))
4966 (goto-char (if (/= first-vis-field-value first-vis)
4967 ;; If yes, obey them.
4968 first-vis-field-value
4969 ;; Otherwise, move to START with attention to fields.
4970 ;; (It is possible that fields never matter in this case.)
4971 (constrain-to-field (point) orig
4972 (/= arg 1) t nil)))))
4975 ;; Many people have said they rarely use this feature, and often type
4976 ;; it by accident. Maybe it shouldn't even be on a key.
4977 (put 'set-goal-column 'disabled t)
4979 (defun set-goal-column (arg)
4981 Those commands will move to this position in the line moved to
4982 rather than trying to keep the same horizontal position.
4983 With a non-nil argument ARG, clears out the goal column
4985 The goal column is stored in the variable `goal-column'."
4986 (interactive "P")
4987 (if arg
4988 (progn
4989 (setq goal-column nil)
4990 (message "No goal column"))
4991 (setq goal-column (current-column))
4992 ;; The older method below can be erroneous if `set-goal-column' is bound
4993 ;; to a sequence containing %
4994 ;;(message (substitute-command-keys
4996 ;;goal-column)
4997 (message "%s"
4998 (concat
4999 (format "Goal column %d " goal-column)
5000 (substitute-command-keys
5003 )
5004 nil)
5005 \f
5006 ;;; Editing based on visual lines, as opposed to logical lines.
5008 (defun end-of-visual-line (&optional n)
5009 "Move point to end of current visual line.
5010 With argument N not nil or 1, move forward N - 1 visual lines first.
5011 If point reaches the beginning or end of buffer, it stops there.
5012 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5013 (interactive "^p")
5014 (or n (setq n 1))
5015 (if (/= n 1)
5016 (let ((line-move-visual t))
5017 (line-move (1- n) t)))
5018 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5019 ;; constrain to field boundaries, so we don't either.
5020 (vertical-motion (cons (window-width) 0)))
5022 (defun beginning-of-visual-line (&optional n)
5023 "Move point to beginning of current visual line.
5024 With argument N not nil or 1, move forward N - 1 visual lines first.
5025 If point reaches the beginning or end of buffer, it stops there.
5026 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5027 (interactive "^p")
5028 (or n (setq n 1))
5029 (let ((opoint (point)))
5030 (if (/= n 1)
5031 (let ((line-move-visual t))
5032 (line-move (1- n) t)))
5033 (vertical-motion 0)
5034 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5035 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
5037 (defun kill-visual-line (&optional arg)
5038 "Kill the rest of the visual line.
5039 With prefix argument ARG, kill that many visual lines from point.
5040 If ARG is negative, kill visual lines backward.
5041 If ARG is zero, kill the text before point on the current visual
5042 line.
5044 If you want to append the killed line to the last killed text,
5047 If the buffer is read-only, Emacs will beep and refrain from deleting
5048 the line, but put the line in the kill ring anyway. This means that
5049 you can use this command to copy text from a read-only buffer.
5050 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5051 even beep.)"
5052 (interactive "P")
5053 ;; Like in `kill-line', it's better to move point to the other end
5054 ;; of the kill before killing.
5055 (let ((opoint (point))
5056 (kill-whole-line (and kill-whole-line (bolp))))
5057 (if arg
5058 (vertical-motion (prefix-numeric-value arg))
5059 (end-of-visual-line 1)
5060 (if (= (point) opoint)
5061 (vertical-motion 1)
5062 ;; Skip any trailing whitespace at the end of the visual line.
5063 ;; We used to do this only if `show-trailing-whitespace' is
5064 ;; nil, but that's wrong; the correct thing would be to check
5065 ;; whether the trailing whitespace is highlighted. But, it's
5066 ;; OK to just do this unconditionally.
5069 (1+ (point))
5070 (point)))))
5072 (defun next-logical-line (&optional arg try-vscroll)
5073 "Move cursor vertically down ARG lines.
5074 This is identical to `next-line', except that it always moves
5075 by logical lines instead of visual lines, ignoring the value of
5076 the variable `line-move-visual'."
5078 (let ((line-move-visual nil))
5079 (with-no-warnings
5080 (next-line arg try-vscroll))))
5082 (defun previous-logical-line (&optional arg try-vscroll)
5083 "Move cursor vertically up ARG lines.
5084 This is identical to `previous-line', except that it always moves
5085 by logical lines instead of visual lines, ignoring the value of
5086 the variable `line-move-visual'."
5088 (let ((line-move-visual nil))
5089 (with-no-warnings
5090 (previous-line arg try-vscroll))))
5092 (defgroup visual-line nil
5093 "Editing based on visual lines."
5094 :group 'convenience
5095 :version "23.1")
5097 (defvar visual-line-mode-map
5098 (let ((map (make-sparse-keymap)))
5099 (define-key map [remap kill-line] 'kill-visual-line)
5100 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
5101 (define-key map [remap move-end-of-line] 'end-of-visual-line)
5102 ;; These keybindings interfere with xterm function keys. Are
5103 ;; there any other suitable bindings?
5104 ;; (define-key map "\M-[" 'previous-logical-line)
5105 ;; (define-key map "\M-]" 'next-logical-line)
5106 map))
5108 (defcustom visual-line-fringe-indicators '(nil nil)
5109 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5110 The value should be a list of the form (LEFT RIGHT), where LEFT
5111 and RIGHT are symbols representing the bitmaps to display, to
5112 indicate wrapped lines, in the left and right fringes respectively.
5113 See also `fringe-indicator-alist'.
5114 The default is not to display fringe indicators for wrapped lines.
5115 This variable does not affect fringe indicators displayed for
5116 other purposes."
5117 :type '(list (choice (const :tag "Hide left indicator" nil)
5118 (const :tag "Left curly arrow" left-curly-arrow)
5119 (symbol :tag "Other bitmap"))
5120 (choice (const :tag "Hide right indicator" nil)
5121 (const :tag "Right curly arrow" right-curly-arrow)
5122 (symbol :tag "Other bitmap")))
5123 :set (lambda (symbol value)
5124 (dolist (buf (buffer-list))
5125 (with-current-buffer buf
5126 (when (and (boundp 'visual-line-mode)
5127 (symbol-value 'visual-line-mode))
5128 (setq fringe-indicator-alist
5129 (cons (cons 'continuation value)
5130 (assq-delete-all
5131 'continuation
5132 (copy-tree fringe-indicator-alist)))))))
5133 (set-default symbol value)))
5135 (defvar visual-line--saved-state nil)
5137 (define-minor-mode visual-line-mode
5138 "Toggle visual line based editing (Visual Line mode).
5139 With a prefix argument ARG, enable Visual Line mode if ARG is
5140 positive, and disable it otherwise. If called from Lisp, enable
5141 the mode if ARG is omitted or nil.
5143 When Visual Line mode is enabled, `word-wrap' is turned on in
5144 this buffer, and simple editing commands are redefined to act on
5145 visual lines, not logical lines. See Info node `Visual Line
5146 Mode' for details."
5147 :keymap visual-line-mode-map
5148 :group 'visual-line
5149 :lighter " Wrap"
5150 (if visual-line-mode
5151 (progn
5152 (set (make-local-variable 'visual-line--saved-state) nil)
5153 ;; Save the local values of some variables, to be restored if
5154 ;; visual-line-mode is turned off.
5155 (dolist (var '(line-move-visual truncate-lines
5156 truncate-partial-width-windows
5157 word-wrap fringe-indicator-alist))
5158 (if (local-variable-p var)
5159 (push (cons var (symbol-value var))
5160 visual-line--saved-state)))
5161 (set (make-local-variable 'line-move-visual) t)
5162 (set (make-local-variable 'truncate-partial-width-windows) nil)
5163 (setq truncate-lines nil
5164 word-wrap t
5165 fringe-indicator-alist
5166 (cons (cons 'continuation visual-line-fringe-indicators)
5167 fringe-indicator-alist)))
5168 (kill-local-variable 'line-move-visual)
5169 (kill-local-variable 'word-wrap)
5170 (kill-local-variable 'truncate-lines)
5171 (kill-local-variable 'truncate-partial-width-windows)
5172 (kill-local-variable 'fringe-indicator-alist)
5173 (dolist (saved visual-line--saved-state)
5174 (set (make-local-variable (car saved)) (cdr saved)))
5175 (kill-local-variable 'visual-line--saved-state)))
5177 (defun turn-on-visual-line-mode ()
5178 (visual-line-mode 1))
5180 (define-globalized-minor-mode global-visual-line-mode
5181 visual-line-mode turn-on-visual-line-mode
5182 :lighter " vl")
5184 \f
5185 (defun transpose-chars (arg)
5186 "Interchange characters around point, moving forward one character.
5187 With prefix arg ARG, effect is to take character before point
5188 and drag it forward past ARG other characters (backward if ARG negative).
5189 If no argument and at end of line, the previous two chars are exchanged."
5190 (interactive "*P")
5191 (and (null arg) (eolp) (forward-char -1))
5192 (transpose-subr 'forward-char (prefix-numeric-value arg)))
5194 (defun transpose-words (arg)
5195 "Interchange words around point, leaving point at end of them.
5196 With prefix arg ARG, effect is to take word before or around point
5197 and drag it forward past ARG other words (backward if ARG negative).
5198 If ARG is zero, the words around or after point and around or after mark
5199 are interchanged."
5200 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5201 (interactive "*p")
5202 (transpose-subr 'forward-word arg))
5204 (defun transpose-sexps (arg)
5206 Does not work on a sexp that point is in the middle of
5207 if it is a list or string."
5208 (interactive "*p")
5209 (transpose-subr
5210 (lambda (arg)
5211 ;; Here we should try to simulate the behavior of
5212 ;; (cons (progn (forward-sexp x) (point))
5213 ;; (progn (forward-sexp (- x)) (point)))
5214 ;; Except that we don't want to rely on the second forward-sexp
5215 ;; putting us back to where we want to be, since forward-sexp-function
5216 ;; might do funny things like infix-precedence.
5217 (if (if (> arg 0)
5219 (and (not (bobp))
5221 ;; Jumping over a symbol. We might be inside it, mind you.
5222 (progn (funcall (if (> arg 0)
5223 'skip-syntax-backward 'skip-syntax-forward)
5224 "w_")
5225 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5226 ;; Otherwise, we're between sexps. Take a step back before jumping
5227 ;; to make sure we'll obey the same precedence no matter which direction
5228 ;; we're going.
5229 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5230 (cons (save-excursion (forward-sexp arg) (point))
5231 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5232 (not (zerop (funcall (if (> arg 0)
5233 'skip-syntax-forward
5234 'skip-syntax-backward)
5235 ".")))))
5236 (point)))))
5237 arg 'special))
5239 (defun transpose-lines (arg)
5240 "Exchange current line and previous line, leaving point after both.
5241 With argument ARG, takes previous line and moves it past ARG lines.
5242 With argument 0, interchanges line point is in with line mark is in."
5243 (interactive "*p")
5244 (transpose-subr (function
5245 (lambda (arg)
5246 (if (> arg 0)
5247 (progn
5248 ;; Move forward over ARG lines,
5249 ;; but create newlines if necessary.
5250 (setq arg (forward-line arg))
5252 (setq arg (1+ arg)))
5253 (if (> arg 0)
5254 (newline arg)))
5255 (forward-line arg))))
5256 arg))
5258 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5259 ;; which seems inconsistent with the ARG /= 0 case.
5260 ;; FIXME document SPECIAL.
5261 (defun transpose-subr (mover arg &optional special)
5262 "Subroutine to do the work of transposing objects.
5263 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5264 moves forward by units of the given object (e.g. forward-sentence,
5265 forward-paragraph). If ARG is zero, exchanges the current object
5266 with the one containing mark. If ARG is an integer, moves the
5267 current object past ARG following (if ARG is positive) or
5268 preceding (if ARG is negative) objects, leaving point after the
5269 current object."
5270 (let ((aux (if special mover
5271 (lambda (x)
5272 (cons (progn (funcall mover x) (point))
5273 (progn (funcall mover (- x)) (point))))))
5274 pos1 pos2)
5275 (cond
5276 ((= arg 0)
5277 (save-excursion
5278 (setq pos1 (funcall aux 1))
5279 (goto-char (or (mark) (error "No mark set in this buffer")))
5280 (setq pos2 (funcall aux 1))
5281 (transpose-subr-1 pos1 pos2))
5282 (exchange-point-and-mark))
5283 ((> arg 0)
5284 (setq pos1 (funcall aux -1))
5285 (setq pos2 (funcall aux arg))
5286 (transpose-subr-1 pos1 pos2)
5287 (goto-char (car pos2)))
5288 (t
5289 (setq pos1 (funcall aux -1))
5290 (goto-char (car pos1))
5291 (setq pos2 (funcall aux arg))
5292 (transpose-subr-1 pos1 pos2)))))
5294 (defun transpose-subr-1 (pos1 pos2)
5295 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5296 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5297 (when (> (car pos1) (car pos2))
5298 (let ((swap pos1))
5299 (setq pos1 pos2 pos2 swap)))
5300 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5301 (atomic-change-group
5302 (let (word2)
5303 ;; FIXME: We first delete the two pieces of text, so markers that
5304 ;; used to point to after the text end up pointing to before it :-(
5305 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5306 (goto-char (car pos2))
5307 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5308 (goto-char (car pos1))
5309 (insert word2))))
5310 \f
5311 (defun backward-word (&optional arg)
5312 "Move backward until encountering the beginning of a word.
5313 With argument ARG, do this that many times."
5314 (interactive "^p")
5315 (forward-word (- (or arg 1))))
5317 (defun mark-word (&optional arg allow-extend)
5318 "Set mark ARG words away from point.
5320 move to with the same argument.
5321 Interactively, if this command is repeated
5322 or (in Transient Mark mode) if the mark is active,
5323 it marks the next ARG words after the ones already marked."
5325 (cond ((and allow-extend
5326 (or (and (eq last-command this-command) (mark t))
5327 (region-active-p)))
5328 (setq arg (if arg (prefix-numeric-value arg)
5329 (if (< (mark) (point)) -1 1)))
5330 (set-mark
5331 (save-excursion
5332 (goto-char (mark))
5333 (forward-word arg)
5334 (point))))
5335 (t
5336 (push-mark
5337 (save-excursion
5338 (forward-word (prefix-numeric-value arg))
5339 (point))
5340 nil t))))
5342 (defun kill-word (arg)
5343 "Kill characters forward until encountering the end of a word.
5344 With argument ARG, do this that many times."
5345 (interactive "p")
5346 (kill-region (point) (progn (forward-word arg) (point))))
5348 (defun backward-kill-word (arg)
5349 "Kill characters backward until encountering the beginning of a word.
5350 With argument ARG, do this that many times."
5351 (interactive "p")
5352 (kill-word (- arg)))
5354 (defun current-word (&optional strict really-word)
5355 "Return the symbol or word that point is on (or a nearby one) as a string.
5356 The return value includes no text properties.
5357 If optional arg STRICT is non-nil, return nil unless point is within
5358 or adjacent to a symbol or word. In all cases the value can be nil
5359 if there is no word nearby.
5360 The function, belying its name, normally finds a symbol.
5361 If optional arg REALLY-WORD is non-nil, it finds just a word."
5362 (save-excursion
5363 (let* ((oldpoint (point)) (start (point)) (end (point))
5364 (syntaxes (if really-word "w" "w_"))
5365 (not-syntaxes (concat "^" syntaxes)))
5366 (skip-syntax-backward syntaxes) (setq start (point))
5367 (goto-char oldpoint)
5368 (skip-syntax-forward syntaxes) (setq end (point))
5369 (when (and (eq start oldpoint) (eq end oldpoint)
5370 ;; Point is neither within nor adjacent to a word.
5371 (not strict))
5372 ;; Look for preceding word in same line.
5373 (skip-syntax-backward not-syntaxes (line-beginning-position))
5374 (if (bolp)
5375 ;; No preceding word in same line.
5376 ;; Look for following word in same line.
5377 (progn
5378 (skip-syntax-forward not-syntaxes (line-end-position))
5379 (setq start (point))
5380 (skip-syntax-forward syntaxes)
5381 (setq end (point)))
5382 (setq end (point))
5383 (skip-syntax-backward syntaxes)
5384 (setq start (point))))
5385 ;; If we found something nonempty, return it as a string.
5386 (unless (= start end)
5387 (buffer-substring-no-properties start end)))))
5388 \f
5389 (defcustom fill-prefix nil
5390 "String for filling to insert at front of new line, or nil for none."
5391 :type '(choice (const :tag "None" nil)
5392 string)
5393 :group 'fill)
5394 (make-variable-buffer-local 'fill-prefix)
5395 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5397 (defcustom auto-fill-inhibit-regexp nil
5398 "Regexp to match lines which should not be auto-filled."
5399 :type '(choice (const :tag "None" nil)
5400 regexp)
5401 :group 'fill)
5403 (defun do-auto-fill ()
5404 "The default value for `normal-auto-fill-function'.
5405 This is the default auto-fill function, some major modes use a different one.
5406 Returns t if it really did any work."
5407 (let (fc justify give-up
5408 (fill-prefix fill-prefix))
5409 (if (or (not (setq justify (current-justification)))
5410 (null (setq fc (current-fill-column)))
5411 (and (eq justify 'left)
5412 (<= (current-column) fc))
5413 (and auto-fill-inhibit-regexp
5414 (save-excursion (beginning-of-line)
5415 (looking-at auto-fill-inhibit-regexp))))
5416 nil ;; Auto-filling not required
5417 (if (memq justify '(full center right))
5418 (save-excursion (unjustify-current-line)))
5420 ;; Choose a fill-prefix automatically.
5421 (when (and adaptive-fill-mode
5422 (or (null fill-prefix) (string= fill-prefix "")))
5423 (let ((prefix
5424 (fill-context-prefix
5425 (save-excursion (fill-forward-paragraph -1) (point))
5426 (save-excursion (fill-forward-paragraph 1) (point)))))
5427 (and prefix (not (equal prefix ""))
5428 ;; Use auto-indentation rather than a guessed empty prefix.
5429 (not (and fill-indent-according-to-mode
5431 (setq fill-prefix prefix))))
5433 (while (and (not give-up) (> (current-column) fc))
5434 ;; Determine where to split the line.
5435 (let* (after-prefix
5436 (fill-point
5437 (save-excursion
5438 (beginning-of-line)
5439 (setq after-prefix (point))
5440 (and fill-prefix
5441 (looking-at (regexp-quote fill-prefix))
5442 (setq after-prefix (match-end 0)))
5443 (move-to-column (1+ fc))
5444 (fill-move-to-break-point after-prefix)
5445 (point))))
5447 ;; See whether the place we found is any good.
5448 (if (save-excursion
5449 (goto-char fill-point)
5450 (or (bolp)
5451 ;; There is no use breaking at end of line.
5452 (save-excursion (skip-chars-forward " ") (eolp))
5453 ;; It is futile to split at the end of the prefix
5454 ;; since we would just insert the prefix again.
5455 (and after-prefix (<= (point) after-prefix))
5456 ;; Don't split right after a comment starter
5457 ;; since we would just make another comment starter.
5458 (and comment-start-skip
5459 (let ((limit (point)))
5460 (beginning-of-line)
5461 (and (re-search-forward comment-start-skip
5462 limit t)
5463 (eq (point) limit))))))
5464 ;; No good place to break => stop trying.
5465 (setq give-up t)
5466 ;; Ok, we have a useful place to break the line. Do it.
5467 (let ((prev-column (current-column)))
5468 ;; If point is at the fill-point, do not `save-excursion'.
5469 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5470 ;; point will end up before it rather than after it.
5471 (if (save-excursion
5473 (= (point) fill-point))
5474 (default-indent-new-line t)
5475 (save-excursion
5476 (goto-char fill-point)
5477 (default-indent-new-line t)))
5478 ;; Now do justification, if required
5479 (if (not (eq justify 'left))
5480 (save-excursion
5481 (end-of-line 0)
5482 (justify-current-line justify nil t)))
5483 ;; If making the new line didn't reduce the hpos of
5484 ;; the end of the line, then give up now;
5485 ;; trying again will not help.
5486 (if (>= (current-column) prev-column)
5487 (setq give-up t))))))
5488 ;; Justify last line.
5489 (justify-current-line justify t t)
5490 t)))
5492 (defvar comment-line-break-function 'comment-indent-new-line
5493 "Mode-specific function which line breaks and continues a comment.
5494 This function is called during auto-filling when a comment syntax
5495 is defined.
5496 The function should take a single optional argument, which is a flag
5497 indicating whether it should use soft newlines.")
5499 (defun default-indent-new-line (&optional soft)
5500 "Break line at point and indent.
5501 If a comment syntax is defined, call `comment-indent-new-line'.
5503 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5504 unless optional argument SOFT is non-nil."
5505 (interactive)
5506 (if comment-start
5507 (funcall comment-line-break-function soft)
5508 ;; Insert the newline before removing empty space so that markers
5509 ;; get preserved better.
5511 (save-excursion (forward-char -1) (delete-horizontal-space))
5512 (delete-horizontal-space)
5514 (if (and fill-prefix (not adaptive-fill-mode))
5515 ;; Blindly trust a non-adaptive fill-prefix.
5516 (progn
5517 (indent-to-left-margin)
5518 (insert-before-markers-and-inherit fill-prefix))
5520 (cond
5521 ;; If there's an adaptive prefix, use it unless we're inside
5522 ;; a comment and the prefix is not a comment starter.
5523 (fill-prefix
5524 (indent-to-left-margin)
5525 (insert-and-inherit fill-prefix))
5526 ;; If we're not inside a comment, just try to indent.
5527 (t (indent-according-to-mode))))))
5529 (defvar normal-auto-fill-function 'do-auto-fill
5530 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5531 Some major modes set this.")
5533 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5534 ;; `functions' and `hooks' are usually unsafe to set, but setting
5535 ;; auto-fill-function to nil in a file-local setting is safe and
5536 ;; can be useful to prevent auto-filling.
5537 (put 'auto-fill-function 'safe-local-variable 'null)
5539 (define-minor-mode auto-fill-mode
5540 "Toggle automatic line breaking (Auto Fill mode).
5541 With a prefix argument ARG, enable Auto Fill mode if ARG is
5542 positive, and disable it otherwise. If called from Lisp, enable
5543 the mode if ARG is omitted or nil.
5545 When Auto Fill mode is enabled, inserting a space at a column
5546 beyond `current-fill-column' automatically breaks the line at a
5547 previous space.
5549 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5550 non-`nil'.
5552 The value of `normal-auto-fill-function' specifies the function to use
5553 for `auto-fill-function' when turning Auto Fill mode on."
5554 :variable (auto-fill-function
5555 . (lambda (v) (setq auto-fill-function
5556 (if v normal-auto-fill-function)))))
5558 ;; This holds a document string used to document auto-fill-mode.
5559 (defun auto-fill-function ()
5560 "Automatically break line at a previous space, in insertion of text."
5561 nil)
5563 (defun turn-on-auto-fill ()
5564 "Unconditionally turn on Auto Fill mode."
5565 (auto-fill-mode 1))
5567 (defun turn-off-auto-fill ()
5568 "Unconditionally turn off Auto Fill mode."
5569 (auto-fill-mode -1))
5571 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5573 (defun set-fill-column (arg)
5574 "Set `fill-column' to specified argument.
5577 (interactive
5578 (list (or current-prefix-arg
5579 ;; We used to use current-column silently, but C-x f is too easily
5580 ;; typed as a typo for C-x C-f, so we turned it into an error and
5581 ;; now an interactive prompt.
5582 (read-number "Set fill-column to: " (current-column)))))
5583 (if (consp arg)
5584 (setq arg (current-column)))
5585 (if (not (integerp arg))
5586 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5587 (error "set-fill-column requires an explicit argument")
5588 (message "Fill column set to %d (was %d)" arg fill-column)
5589 (setq fill-column arg)))
5590 \f
5591 (defun set-selective-display (arg)
5592 "Set `selective-display' to ARG; clear it if no arg.
5593 When the value of `selective-display' is a number > 0,
5594 lines whose indentation is >= that value are not displayed.
5595 The variable `selective-display' has a separate value for each buffer."
5596 (interactive "P")
5597 (if (eq selective-display t)
5598 (error "selective-display already in use for marked lines"))
5599 (let ((current-vpos
5600 (save-restriction
5601 (narrow-to-region (point-min) (point))
5602 (goto-char (window-start))
5603 (vertical-motion (window-height)))))
5604 (setq selective-display
5605 (and arg (prefix-numeric-value arg)))
5606 (recenter current-vpos))
5607 (set-window-start (selected-window) (window-start (selected-window)))
5608 (princ "selective-display set to " t)
5609 (prin1 selective-display t)
5610 (princ "." t))
5612 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5614 (defun toggle-truncate-lines (&optional arg)
5615 "Toggle truncating of long lines for the current buffer.
5616 When truncating is off, long lines are folded.
5617 With prefix argument ARG, truncate long lines if ARG is positive,
5618 otherwise fold them. Note that in side-by-side windows, this
5619 command has no effect if `truncate-partial-width-windows' is
5620 non-nil."
5621 (interactive "P")
5622 (setq truncate-lines
5623 (if (null arg)
5624 (not truncate-lines)
5625 (> (prefix-numeric-value arg) 0)))
5626 (force-mode-line-update)
5627 (unless truncate-lines
5628 (let ((buffer (current-buffer)))
5629 (walk-windows (lambda (window)
5630 (if (eq buffer (window-buffer window))
5631 (set-window-hscroll window 0)))
5632 nil t)))
5633 (message "Truncate long lines %s"
5634 (if truncate-lines "enabled" "disabled")))
5636 (defun toggle-word-wrap (&optional arg)
5637 "Toggle whether to use word-wrapping for continuation lines.
5638 With prefix argument ARG, wrap continuation lines at word boundaries
5639 if ARG is positive, otherwise wrap them at the right screen edge.
5640 This command toggles the value of `word-wrap'. It has no effect
5641 if long lines are truncated."
5642 (interactive "P")
5643 (setq word-wrap
5644 (if (null arg)
5645 (not word-wrap)
5646 (> (prefix-numeric-value arg) 0)))
5647 (force-mode-line-update)
5648 (message "Word wrapping %s"
5649 (if word-wrap "enabled" "disabled")))
5651 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5652 "The string displayed in the mode line when in overwrite mode.")
5653 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5654 "The string displayed in the mode line when in binary overwrite mode.")
5656 (define-minor-mode overwrite-mode
5657 "Toggle Overwrite mode.
5658 With a prefix argument ARG, enable Overwrite mode if ARG is
5659 positive, and disable it otherwise. If called from Lisp, enable
5660 the mode if ARG is omitted or nil.
5662 When Overwrite mode is enabled, printing characters typed in
5663 replace existing text on a one-for-one basis, rather than pushing
5664 it to the right. At the end of a line, such characters extend
5665 the line. Before a tab, such characters insert until the tab is
5667 overwrite mode; this is supposed to make it easier to insert
5668 characters when necessary."
5669 :variable (overwrite-mode
5670 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-textual)))))
5672 (define-minor-mode binary-overwrite-mode
5673 "Toggle Binary Overwrite mode.
5674 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5675 is positive, and disable it otherwise. If called from Lisp,
5676 enable the mode if ARG is omitted or nil.
5678 When Binary Overwrite mode is enabled, printing characters typed
5679 in replace existing text. Newlines are not treated specially, so
5680 typing at the end of a line joins the line to the next, with the
5681 typed character between them. Typing before a tab character
5682 simply replaces the tab with the character typed.
5684 ordinary typing characters do.
5686 Note that Binary Overwrite mode is not its own minor mode; it is
5687 a specialization of overwrite mode, entered by setting the
5688 `overwrite-mode' variable to `overwrite-mode-binary'."
5689 :variable (overwrite-mode
5690 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-binary)))))
5692 (define-minor-mode line-number-mode
5693 "Toggle line number display in the mode line (Line Number mode).
5694 With a prefix argument ARG, enable Line Number mode if ARG is
5695 positive, and disable it otherwise. If called from Lisp, enable
5696 the mode if ARG is omitted or nil.
5698 Line numbers do not appear for very large buffers and buffers
5699 with very long lines; see variables `line-number-display-limit'
5700 and `line-number-display-limit-width'."
5701 :init-value t :global t :group 'mode-line)
5703 (define-minor-mode column-number-mode
5704 "Toggle column number display in the mode line (Column Number mode).
5705 With a prefix argument ARG, enable Column Number mode if ARG is
5706 positive, and disable it otherwise.
5708 If called from Lisp, enable the mode if ARG is omitted or nil."
5709 :global t :group 'mode-line)
5711 (define-minor-mode size-indication-mode
5712 "Toggle buffer size display in the mode line (Size Indication mode).
5713 With a prefix argument ARG, enable Size Indication mode if ARG is
5714 positive, and disable it otherwise.
5716 If called from Lisp, enable the mode if ARG is omitted or nil."
5717 :global t :group 'mode-line)
5719 (define-minor-mode auto-save-mode
5720 "Toggle auto-saving in the current buffer (Auto Save mode).
5721 With a prefix argument ARG, enable Auto Save mode if ARG is
5722 positive, and disable it otherwise.
5724 If called from Lisp, enable the mode if ARG is omitted or nil."
5725 :variable ((and buffer-auto-save-file-name
5726 ;; If auto-save is off because buffer has shrunk,
5727 ;; then toggling should turn it on.
5728 (>= buffer-saved-size 0))
5729 . (lambda (val)
5730 (setq buffer-auto-save-file-name
5731 (cond
5732 ((null val) nil)
5733 ((and buffer-file-name auto-save-visited-file-name
5734 (not buffer-read-only))
5735 buffer-file-name)
5736 (t (make-auto-save-file-name))))))
5737 ;; If -1 was stored here, to temporarily turn off saving,
5738 ;; turn it back on.
5739 (and (< buffer-saved-size 0)
5740 (setq buffer-saved-size 0)))
5741 \f
5742 (defgroup paren-blinking nil
5743 "Blinking matching of parens and expressions."
5744 :prefix "blink-matching-"
5745 :group 'paren-matching)
5747 (defcustom blink-matching-paren t
5748 "Non-nil means show matching open-paren when close-paren is inserted."
5749 :type 'boolean
5750 :group 'paren-blinking)
5752 (defcustom blink-matching-paren-on-screen t
5753 "Non-nil means show matching open-paren when it is on screen.
5754 If nil, don't show it (but the open-paren can still be shown
5755 when it is off screen).
5757 This variable has no effect if `blink-matching-paren' is nil.
5758 \(In that case, the open-paren is never shown.)
5759 It is also ignored if `show-paren-mode' is enabled."
5760 :type 'boolean
5761 :group 'paren-blinking)
5763 (defcustom blink-matching-paren-distance (* 100 1024)
5764 "If non-nil, maximum distance to search backwards for matching open-paren.
5765 If nil, search stops at the beginning of the accessible portion of the buffer."
5766 :version "23.2" ; 25->100k
5767 :type '(choice (const nil) integer)
5768 :group 'paren-blinking)
5770 (defcustom blink-matching-delay 1
5771 "Time in seconds to delay after showing a matching paren."
5772 :type 'number
5773 :group 'paren-blinking)
5775 (defcustom blink-matching-paren-dont-ignore-comments nil
5776 "If nil, `blink-matching-paren' ignores comments.
5777 More precisely, when looking for the matching parenthesis,
5778 it skips the contents of comments that end before point."
5779 :type 'boolean
5780 :group 'paren-blinking)
5782 (defun blink-matching-check-mismatch (start end)
5783 "Return whether or not START...END are matching parens.
5784 END is the current point and START is the blink position.
5785 START might be nil if no matching starter was found.
5786 Returns non-nil if we find there is a mismatch."
5787 (let* ((end-syntax (syntax-after (1- end)))
5788 (matching-paren (and (consp end-syntax)
5789 (eq (syntax-class end-syntax) 5)
5790 (cdr end-syntax))))
5791 ;; For self-matched chars like " and $, we can't know when they're
5792 ;; mismatched or unmatched, so we can only do it for parens.
5793 (when matching-paren
5794 (not (and start
5795 (or
5796 (eq (char-after start) matching-paren)
5797 ;; The cdr might hold a new paren-class info rather than
5798 ;; a matching-char info, in which case the two CDRs
5799 ;; should match.
5800 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5802 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5803 "Function to check parentheses mismatches.
5804 The function takes two arguments (START and END) where START is the
5805 position just before the opening token and END is the position right after.
5806 START can be nil, if it was not found.
5807 The function should return non-nil if the two tokens do not match.")
5809 (defun blink-matching-open ()
5810 "Move cursor momentarily to the beginning of the sexp before point."
5811 (interactive)
5812 (when (and (not (bobp))
5813 blink-matching-paren)
5814 (let* ((oldpos (point))
5815 (message-log-max nil) ; Don't log messages about paren matching.
5816 (blinkpos
5817 (save-excursion
5818 (save-restriction
5819 (if blink-matching-paren-distance
5820 (narrow-to-region
5821 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5822 (- (point) blink-matching-paren-distance))
5823 oldpos))
5824 (let ((parse-sexp-ignore-comments
5825 (and parse-sexp-ignore-comments
5826 (not blink-matching-paren-dont-ignore-comments))))
5827 (condition-case ()
5828 (progn
5829 (forward-sexp -1)
5830 ;; backward-sexp skips backward over prefix chars,
5831 ;; so move back to the matching paren.
5832 (while (and (< (point) (1- oldpos))
5833 (let ((code (syntax-after (point))))
5834 (or (eq (syntax-class code) 6)
5835 (eq (logand 1048576 (car code))
5836 1048576))))
5837 (forward-char 1))
5838 (point))
5839 (error nil))))))
5840 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5841 (cond
5842 (mismatch
5843 (if blinkpos
5844 (if (minibufferp)
5845 (minibuffer-message "Mismatched parentheses")
5846 (message "Mismatched parentheses"))
5847 (if (minibufferp)
5848 (minibuffer-message "No matching parenthesis found")
5849 (message "No matching parenthesis found"))))
5850 ((not blinkpos) nil)
5851 ((pos-visible-in-window-p blinkpos)
5852 ;; Matching open within window, temporarily move to blinkpos but only
5853 ;; if `blink-matching-paren-on-screen' is non-nil.
5854 (and blink-matching-paren-on-screen
5855 (not show-paren-mode)
5856 (save-excursion
5857 (goto-char blinkpos)
5858 (sit-for blink-matching-delay))))
5859 (t
5860 (save-excursion
5861 (goto-char blinkpos)
5862 (let ((open-paren-line-string
5863 ;; Show what precedes the open in its line, if anything.
5864 (cond
5866 (buffer-substring (line-beginning-position)
5867 (1+ blinkpos)))
5868 ;; Show what follows the open in its line, if anything.
5869 ((save-excursion
5870 (forward-char 1)
5872 (not (eolp)))
5873 (buffer-substring blinkpos
5874 (line-end-position)))
5875 ;; Otherwise show the previous nonblank line,
5876 ;; if there is one.
5878 (concat
5879 (buffer-substring (progn
5881 (line-beginning-position))
5882 (progn (end-of-line)
5884 (point)))
5885 ;; Replace the newline and other whitespace with `...'.
5886 "..."
5887 (buffer-substring blinkpos (1+ blinkpos))))
5888 ;; There is nothing to show except the char itself.
5889 (t (buffer-substring blinkpos (1+ blinkpos))))))
5890 (message "Matches %s"
5891 (substring-no-properties open-paren-line-string)))))))))
5893 (defvar blink-paren-function 'blink-matching-open
5894 "Function called, if non-nil, whenever a close parenthesis is inserted.
5895 More precisely, a char with closeparen syntax is self-inserted.")
5897 (defun blink-paren-post-self-insert-function ()
5898 (when (and (eq (char-before) last-command-event) ; Sanity check.
5899 (memq (char-syntax last-command-event) '(?\) ?\$))
5900 blink-paren-function
5901 (not executing-kbd-macro)
5902 (not noninteractive)
5903 ;; Verify an even number of quoting characters precede the close.
5904 (= 1 (logand 1 (- (point)
5905 (save-excursion
5906 (forward-char -1)
5908 (point))))))
5909 (funcall blink-paren-function)))
5911 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5912 ;; Most likely, this hook is nil, so this arg doesn't matter,
5913 ;; but I use it as a reminder that this function usually
5914 ;; likes to be run after others since it does `sit-for'.
5915 'append)
5916 \f
5917 ;; This executes C-g typed while Emacs is waiting for a command.
5918 ;; Quitting out of a program does not go through here;
5919 ;; that happens in the QUIT macro at the C code level.
5920 (defun keyboard-quit ()
5921 "Signal a `quit' condition.
5922 During execution of Lisp code, this character causes a quit directly.
5923 At top-level, as an editor command, this simply beeps."
5924 (interactive)
5925 ;; Avoid adding the region to the window selection.
5926 (setq saved-region-selection nil)
5927 (let (select-active-regions)
5928 (deactivate-mark))
5929 (if (fboundp 'kmacro-keyboard-quit)
5930 (kmacro-keyboard-quit))
5931 (setq defining-kbd-macro nil)
5932 (let ((debug-on-quit nil))
5933 (signal 'quit nil)))
5935 (defvar buffer-quit-function nil
5938 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
5940 (defun keyboard-escape-quit ()
5942 This command can exit an interactive command such as `query-replace',
5943 can clear out a prefix argument or a region,
5944 can get out of the minibuffer or other recursive edit,
5945 cancel the use of the current buffer (for special-purpose buffers),
5946 or go back to just one window (by deleting all but the selected window)."
5947 (interactive)
5948 (cond ((eq last-command 'mode-exited) nil)
5949 ((region-active-p)
5950 (deactivate-mark))
5951 ((> (minibuffer-depth) 0)
5952 (abort-recursive-edit))
5953 (current-prefix-arg
5954 nil)
5955 ((> (recursion-depth) 0)
5956 (exit-recursive-edit))
5957 (buffer-quit-function
5958 (funcall buffer-quit-function))
5959 ((not (one-window-p t))
5960 (delete-other-windows))
5962 (bury-buffer))))
5964 (defun play-sound-file (file &optional volume device)
5965 "Play sound stored in FILE.
5966 VOLUME and DEVICE correspond to the keywords of the sound
5967 specification for `play-sound'."
5968 (interactive "fPlay sound file: ")
5969 (let ((sound (list :file file)))
5970 (if volume
5971 (plist-put sound :volume volume))
5972 (if device
5973 (plist-put sound :device device))
5974 (push 'sound sound)
5975 (play-sound sound)))
5977 \f
5978 (defcustom read-mail-command 'rmail
5979 "Your preference for a mail reading package.
5980 This is used by some keybindings which support reading mail.
5981 See also `mail-user-agent' concerning sending mail."
5984 (function-item :tag "Emacs interface to MH"
5986 (function :tag "Other"))
5987 :version "21.1"
5988 :group 'mail)
5990 (defcustom mail-user-agent 'message-user-agent
5991 "Your preference for a mail composition package.
5992 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5993 outgoing email message. This variable lets you specify which
5994 mail-sending package you prefer.
5996 Valid values include:
5998 `message-user-agent' -- use the Message package.
5999 See Info node `(message)'.
6000 `sendmail-user-agent' -- use the Mail package.
6001 See Info node `(emacs)Sending Mail'.
6002 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6003 See Info node `(mh-e)'.
6004 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6005 paraphernalia if Gnus is running, particularly
6006 the Gcc: header for archiving.
6008 Additional valid symbols may be available; check with the author of
6009 your package for details. The function should return non-nil if it
6010 succeeds.
6012 See also `read-mail-command' concerning reading mail."
6013 :type '(radio (function-item :tag "Message package"
6015 message-user-agent)
6016 (function-item :tag "Mail package"
6018 sendmail-user-agent)
6019 (function-item :tag "Emacs interface to MH"
6021 mh-e-user-agent)
6022 (function-item :tag "Message with full Gnus features"
6024 gnus-user-agent)
6025 (function :tag "Other"))
6026 :version "23.2" ; sendmail->message
6027 :group 'mail)
6029 (defcustom compose-mail-user-agent-warnings t
6030 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6031 If the value of `mail-user-agent' is the default, and the user
6032 appears to have customizations applying to the old default,
6033 `compose-mail' issues a warning."
6034 :type 'boolean
6035 :version "23.2"
6036 :group 'mail)
6038 (defun rfc822-goto-eoh ()
6039 "If the buffer starts with a mail header, move point to the header's end.
6040 Otherwise, moves to `point-min'.
6041 The end of the header is the start of the next line, if there is one,
6042 else the end of the last line. This function obeys RFC822."
6043 (goto-char (point-min))
6044 (when (re-search-forward
6046 (goto-char (match-beginning 0))))
6048 ;; Used by Rmail (e.g., rmail-forward).
6049 (defvar mail-encode-mml nil
6050 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6051 the outgoing message before sending it.")
6053 (defun compose-mail (&optional to subject other-headers continue
6054 switch-function yank-action send-actions
6055 return-action)
6056 "Start composing a mail message to send.
6057 This uses the user's chosen mail composition package
6058 as selected with the variable `mail-user-agent'.
6059 The optional arguments TO and SUBJECT specify recipients
6060 and the initial Subject field, respectively.
6062 OTHER-HEADERS is an alist specifying additional
6063 header fields. Elements look like (HEADER . VALUE) where both
6064 HEADER and VALUE are strings.
6066 CONTINUE, if non-nil, says to continue editing a message already
6067 being composed. Interactively, CONTINUE is the prefix argument.
6069 SWITCH-FUNCTION, if non-nil, is a function to use to
6070 switch to and display the buffer used for mail composition.
6072 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6073 to insert the raw text of the message being replied to.
6074 It has the form (FUNCTION . ARGS). The user agent will apply
6075 FUNCTION to ARGS, to insert the raw text of the original message.
6076 \(The user agent will also run `mail-citation-hook', *after* the
6077 original text has been inserted in this way.)
6079 SEND-ACTIONS is a list of actions to call when the message is sent.
6080 Each action has the form (FUNCTION . ARGS).
6082 RETURN-ACTION, if non-nil, is an action for returning to the
6083 caller. It has the form (FUNCTION . ARGS). The function is
6084 called after the mail has been sent or put aside, and the mail
6085 buffer buried."
6086 (interactive
6087 (list nil nil nil current-prefix-arg))
6089 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6090 ;; from sendmail-user-agent to message-user-agent. Some users may
6091 ;; encounter incompatibilities. This hack tries to detect problems
6092 ;; and warn about them.
6093 (and compose-mail-user-agent-warnings
6094 (eq mail-user-agent 'message-user-agent)
6095 (let (warn-vars)
6096 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
6097 mail-yank-hooks mail-archive-file-name
6098 mail-default-reply-to mail-mailing-lists
6099 mail-self-blind))
6100 (and (boundp var)
6101 (symbol-value var)
6102 (push var warn-vars)))
6103 (when warn-vars
6104 (display-warning 'mail
6105 (format "\
6106 The default mail mode is now Message mode.
6107 You have the following Mail mode variable%s customized:
6109 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6110 (if (> (length warn-vars) 1) "s" "")
6111 (mapconcat 'symbol-name
6112 warn-vars " "))))))
6114 (let ((function (get mail-user-agent 'composefunc)))
6115 (funcall function to subject other-headers continue switch-function
6116 yank-action send-actions return-action)))
6118 (defun compose-mail-other-window (&optional to subject other-headers continue
6119 yank-action send-actions
6120 return-action)
6122 (interactive (list nil nil nil current-prefix-arg))
6123 (compose-mail to subject other-headers continue
6124 'switch-to-buffer-other-window yank-action send-actions
6125 return-action))
6127 (defun compose-mail-other-frame (&optional to subject other-headers continue
6128 yank-action send-actions
6129 return-action)
6131 (interactive (list nil nil nil current-prefix-arg))
6132 (compose-mail to subject other-headers continue
6133 'switch-to-buffer-other-frame yank-action send-actions
6134 return-action))
6136 \f
6137 (defvar set-variable-value-history nil
6138 "History of values entered with `set-variable'.
6140 Maximum length of the history list is determined by the value
6141 of `history-length', which see.")
6143 (defun set-variable (variable value &optional make-local)
6144 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6145 VARIABLE should be a user option variable name, a Lisp variable
6146 meant to be customized by users. You should enter VALUE in Lisp syntax,
6147 so if you want VALUE to be a string, you must surround it with doublequotes.
6148 VALUE is used literally, not evaluated.
6150 If VARIABLE has a `variable-interactive' property, that is used as if
6151 it were the arg to `interactive' (which see) to interactively read VALUE.
6153 If VARIABLE has been defined with `defcustom', then the type information
6154 in the definition is used to check that VALUE is valid.
6156 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6157 (interactive
6158 (let* ((default-var (variable-at-point))
6159 (var (if (custom-variable-p default-var)
6160 (read-variable (format "Set variable (default %s): " default-var)
6161 default-var)
6162 (read-variable "Set variable: ")))
6163 (minibuffer-help-form '(describe-variable var))
6164 (prop (get var 'variable-interactive))
6165 (obsolete (car (get var 'byte-obsolete-variable)))
6166 (prompt (format "Set %s %s to value: " var
6167 (cond ((local-variable-p var)
6168 "(buffer-local)")
6169 ((or current-prefix-arg
6170 (local-variable-if-set-p var))
6171 "buffer-locally")
6172 (t "globally"))))
6173 (val (progn
6174 (when obsolete
6175 (message (concat "`%S' is obsolete; "
6176 (if (symbolp obsolete) "use `%S' instead" "%s"))
6177 var obsolete)
6178 (sit-for 3))
6179 (if prop
6180 ;; Use VAR's `variable-interactive' property
6181 ;; as an interactive spec for prompting.
6182 (call-interactively `(lambda (arg)
6183 (interactive ,prop)
6184 arg))
6185 (read
6186 (read-string prompt nil
6187 'set-variable-value-history
6188 (format "%S" (symbol-value var))))))))
6189 (list var val current-prefix-arg)))
6191 (and (custom-variable-p variable)
6192 (not (get variable 'custom-type))
6193 (custom-load-symbol variable))
6194 (let ((type (get variable 'custom-type)))
6195 (when type
6196 ;; Match with custom type.
6197 (require 'cus-edit)
6198 (setq type (widget-convert type))
6199 (unless (widget-apply type :match value)
6200 (error "Value `%S' does not match type %S of %S"
6201 value (car type) variable))))
6203 (if make-local
6204 (make-local-variable variable))
6206 (set variable value)
6208 ;; Force a thorough redisplay for the case that the variable
6209 ;; has an effect on the display, like `tab-width' has.
6210 (force-mode-line-update))
6211 \f
6212 ;; Define the major mode for lists of completions.
6214 (defvar completion-list-mode-map
6215 (let ((map (make-sparse-keymap)))
6216 (define-key map [mouse-2] 'mouse-choose-completion)
6217 (define-key map [follow-link] 'mouse-face)
6218 (define-key map [down-mouse-2] nil)
6219 (define-key map "\C-m" 'choose-completion)
6220 (define-key map "\e\e\e" 'delete-completion-window)
6221 (define-key map [left] 'previous-completion)
6222 (define-key map [right] 'next-completion)
6223 (define-key map "q" 'quit-window)
6224 (define-key map "z" 'kill-this-buffer)
6225 map)
6226 "Local map for completion list buffers.")
6228 ;; Completion mode is suitable only for specially formatted data.
6229 (put 'completion-list-mode 'mode-class 'special)
6231 (defvar completion-reference-buffer nil
6232 "Record the buffer that was current when the completion list was requested.
6233 This is a local variable in the completion list buffer.
6234 Initial value is nil to avoid some compiler warnings.")
6236 (defvar completion-no-auto-exit nil
6237 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6238 This also applies to other functions such as `choose-completion'.")
6240 (defvar completion-base-position nil
6241 "Position of the base of the text corresponding to the shown completions.
6242 This variable is used in the *Completions* buffers.
6243 Its value is a list of the form (START END) where START is the place
6244 where the completion should be inserted and END (if non-nil) is the end
6245 of the text to replace. If END is nil, point is used instead.")
6247 (defvar completion-list-insert-choice-function #'completion--replace
6248 "Function to use to insert the text chosen in *Completions*.
6249 Called with three arguments (BEG END TEXT), it should replace the text
6250 between BEG and END with TEXT. Expected to be set buffer-locally
6251 in the *Completions* buffer.")
6253 (defvar completion-base-size nil
6254 "Number of chars before point not involved in completion.
6255 This is a local variable in the completion list buffer.
6256 It refers to the chars in the minibuffer if completing in the
6257 minibuffer, or in `completion-reference-buffer' otherwise.
6258 Only characters in the field at point are included.
6260 If nil, Emacs determines which part of the tail end of the
6261 buffer's text is involved in completion by comparing the text
6262 directly.")
6263 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6265 (defun delete-completion-window ()
6266 "Delete the completion list window.
6267 Go to the window from which completion was requested."
6268 (interactive)
6269 (let ((buf completion-reference-buffer))
6270 (if (one-window-p t)
6271 (if (window-dedicated-p (selected-window))
6272 (delete-frame (selected-frame)))
6273 (delete-window (selected-window))
6274 (if (get-buffer-window buf)
6275 (select-window (get-buffer-window buf))))))
6277 (defun previous-completion (n)
6278 "Move to the previous item in the completion list."
6279 (interactive "p")
6280 (next-completion (- n)))
6282 (defun next-completion (n)
6283 "Move to the next item in the completion list.
6284 With prefix argument N, move N items (negative N means move backward)."
6285 (interactive "p")
6286 (let ((beg (point-min)) (end (point-max)))
6287 (while (and (> n 0) (not (eobp)))
6288 ;; If in a completion, move to the end of it.
6289 (when (get-text-property (point) 'mouse-face)
6290 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6291 ;; Move to start of next one.
6292 (unless (get-text-property (point) 'mouse-face)
6293 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6294 (setq n (1- n)))
6295 (while (and (< n 0) (not (bobp)))
6296 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6297 ;; If in a completion, move to the start of it.
6298 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6299 (goto-char (previous-single-property-change
6300 (point) 'mouse-face nil beg)))
6301 ;; Move to end of the previous completion.
6302 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6303 (goto-char (previous-single-property-change
6304 (point) 'mouse-face nil beg)))
6305 ;; Move to the start of that one.
6306 (goto-char (previous-single-property-change
6307 (point) 'mouse-face nil beg))
6308 (setq n (1+ n))))))
6310 (defun choose-completion (&optional event)
6311 "Choose the completion at point."
6312 (interactive (list last-nonmenu-event))
6313 ;; In case this is run via the mouse, give temporary modes such as
6314 ;; isearch a chance to turn off.
6315 (run-hooks 'mouse-leave-buffer-hook)
6316 (with-current-buffer (window-buffer (posn-window (event-start event)))
6317 (let ((buffer completion-reference-buffer)
6318 (base-size completion-base-size)
6319 (base-position completion-base-position)
6320 (insert-function completion-list-insert-choice-function)
6321 (choice
6322 (save-excursion
6323 (goto-char (posn-point (event-start event)))
6324 (let (beg end)
6325 (cond
6326 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6327 (setq end (point) beg (1+ (point))))
6328 ((and (not (bobp))
6329 (get-text-property (1- (point)) 'mouse-face))
6330 (setq end (1- (point)) beg (point)))
6331 (t (error "No completion here")))
6332 (setq beg (previous-single-property-change beg 'mouse-face))
6333 (setq end (or (next-single-property-change end 'mouse-face)
6334 (point-max)))
6335 (buffer-substring-no-properties beg end)))))
6337 (unless (buffer-live-p buffer)
6338 (error "Destination buffer is dead"))
6339 (quit-window nil (posn-window (event-start event)))
6341 (with-current-buffer buffer
6342 (choose-completion-string
6343 choice buffer
6344 (or base-position
6345 (when base-size
6346 ;; Someone's using old completion code that doesn't know
6347 ;; about base-position yet.
6348 (list (+ base-size (field-beginning))))
6349 ;; If all else fails, just guess.
6350 (list (choose-completion-guess-base-position choice)))
6351 insert-function)))))
6353 ;; Delete the longest partial match for STRING
6354 ;; that can be found before POINT.
6355 (defun choose-completion-guess-base-position (string)
6356 (save-excursion
6357 (let ((opoint (point))
6358 len)
6359 ;; Try moving back by the length of the string.
6360 (goto-char (max (- (point) (length string))
6361 (minibuffer-prompt-end)))
6362 ;; See how far back we were actually able to move. That is the
6363 ;; upper bound on how much we can match and delete.
6364 (setq len (- opoint (point)))
6365 (if completion-ignore-case
6366 (setq string (downcase string)))
6367 (while (and (> len 0)
6368 (let ((tail (buffer-substring (point) opoint)))
6369 (if completion-ignore-case
6370 (setq tail (downcase tail)))
6371 (not (string= tail (substring string 0 len)))))
6372 (setq len (1- len))
6373 (forward-char 1))
6374 (point))))
6376 (defun choose-completion-delete-max-match (string)
6377 (declare (obsolete choose-completion-guess-base-position "23.2"))
6378 (delete-region (choose-completion-guess-base-position string) (point)))
6380 (defvar choose-completion-string-functions nil
6381 "Functions that may override the normal insertion of a completion choice.
6382 These functions are called in order with four arguments:
6383 CHOICE - the string to insert in the buffer,
6384 BUFFER - the buffer in which the choice should be inserted,
6385 MINI-P - non-nil if BUFFER is a minibuffer, and
6386 BASE-SIZE - the number of characters in BUFFER before
6387 the string being completed.
6389 If a function in the list returns non-nil, that function is supposed
6390 to have inserted the CHOICE in the BUFFER, and possibly exited
6391 the minibuffer; no further functions will be called.
6393 If all functions in the list return nil, that means to use
6394 the default method of inserting the completion in BUFFER.")
6396 (defun choose-completion-string (choice &optional
6397 buffer base-position insert-function)
6398 "Switch to BUFFER and insert the completion choice CHOICE.
6399 BASE-POSITION, says where to insert the completion."
6401 ;; If BUFFER is the minibuffer, exit the minibuffer
6402 ;; unless it is reading a file name and CHOICE is a directory,
6403 ;; or completion-no-auto-exit is non-nil.
6405 ;; Some older code may call us passing `base-size' instead of
6406 ;; `base-position'. It's difficult to make any use of `base-size',
6407 ;; so we just ignore it.
6408 (unless (consp base-position)
6409 (message "Obsolete `base-size' passed to choose-completion-string")
6410 (setq base-position nil))
6412 (let* ((buffer (or buffer completion-reference-buffer))
6413 (mini-p (minibufferp buffer)))
6414 ;; If BUFFER is a minibuffer, barf unless it's the currently
6415 ;; active minibuffer.
6416 (if (and mini-p
6417 (not (and (active-minibuffer-window)
6418 (equal buffer
6419 (window-buffer (active-minibuffer-window))))))
6420 (error "Minibuffer is not active for completion")
6421 ;; Set buffer so buffer-local choose-completion-string-functions works.
6422 (set-buffer buffer)
6423 (unless (run-hook-with-args-until-success
6424 'choose-completion-string-functions
6425 ;; The fourth arg used to be `mini-p' but was useless
6426 ;; (since minibufferp can be used on the `buffer' arg)
6427 ;; and indeed unused. The last used to be `base-size', so we
6428 ;; keep it to try and avoid breaking old code.
6429 choice buffer base-position nil)
6430 ;; This remove-text-properties should be unnecessary since `choice'
6431 ;; comes from buffer-substring-no-properties.
6432 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6433 ;; Insert the completion into the buffer where it was requested.
6434 (funcall (or insert-function completion-list-insert-choice-function)
6435 (or (car base-position) (point))
6436 (or (cadr base-position) (point))
6437 choice)
6438 ;; Update point in the window that BUFFER is showing in.
6439 (let ((window (get-buffer-window buffer t)))
6440 (set-window-point window (point)))
6441 ;; If completing for the minibuffer, exit it with this choice.
6442 (and (not completion-no-auto-exit)
6443 (minibufferp buffer)
6444 minibuffer-completion-table
6445 ;; If this is reading a file name, and the file name chosen
6446 ;; is a directory, don't exit the minibuffer.
6447 (let* ((result (buffer-substring (field-beginning) (point)))
6448 (bounds
6449 (completion-boundaries result minibuffer-completion-table
6450 minibuffer-completion-predicate
6451 "")))
6452 (if (eq (car bounds) (length result))
6453 ;; The completion chosen leads to a new set of completions
6454 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6455 (let ((mini (active-minibuffer-window)))
6456 (select-window mini)
6457 (when minibuffer-auto-raise
6458 (raise-frame (window-frame mini))))
6459 (exit-minibuffer))))))))
6461 (define-derived-mode completion-list-mode nil "Completion List"
6462 "Major mode for buffers showing lists of possible completions.
6464 to select the completion near point.
6466 with the mouse.
6469 (set (make-local-variable 'completion-base-size) nil))
6471 (defun completion-list-mode-finish ()
6472 "Finish setup of the completions buffer.
6473 Called from `temp-buffer-show-hook'."
6474 (when (eq major-mode 'completion-list-mode)
6475 (setq buffer-read-only t)))
6477 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6480 ;; Variables and faces used in `completion-setup-function'.
6482 (defcustom completion-show-help t
6483 "Non-nil means show help message in *Completions* buffer."
6484 :type 'boolean
6485 :version "22.1"
6486 :group 'completion)
6488 ;; This function goes in completion-setup-hook, so that it is called
6489 ;; after the text of the completion list buffer is written.
6490 (defun completion-setup-function ()
6491 (let* ((mainbuf (current-buffer))
6492 (base-dir
6493 ;; When reading a file name in the minibuffer,
6494 ;; try and find the right default-directory to set in the
6495 ;; completion list buffer.
6496 ;; FIXME: Why do we do that, actually? --Stef
6497 (if minibuffer-completing-file-name
6498 (file-name-as-directory
6499 (expand-file-name
6500 (substring (minibuffer-completion-contents)
6501 0 (or completion-base-size 0)))))))
6502 (with-current-buffer standard-output
6503 (let ((base-size completion-base-size) ;Read before killing localvars.
6504 (base-position completion-base-position)
6505 (insert-fun completion-list-insert-choice-function))
6506 (completion-list-mode)
6507 (set (make-local-variable 'completion-base-size) base-size)
6508 (set (make-local-variable 'completion-base-position) base-position)
6509 (set (make-local-variable 'completion-list-insert-choice-function)
6510 insert-fun))
6511 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6512 (if base-dir (setq default-directory base-dir))
6513 ;; Maybe insert help string.
6514 (when completion-show-help
6515 (goto-char (point-min))
6516 (if (display-mouse-p)
6517 (insert (substitute-command-keys
6519 (insert (substitute-command-keys
6523 (add-hook 'completion-setup-hook 'completion-setup-function)
6525 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6526 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6528 (defun switch-to-completions ()
6529 "Select the completion list window."
6530 (interactive)
6531 (let ((window (or (get-buffer-window "*Completions*" 0)
6532 ;; Make sure we have a completions window.
6533 (progn (minibuffer-completion-help)
6534 (get-buffer-window "*Completions*" 0)))))
6535 (when window
6536 (select-window window)
6537 ;; In the new buffer, go to the first completion.
6538 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6539 (when (bobp)
6540 (next-completion 1)))))
6541 \f
6542 ;;; Support keyboard commands to turn on various modifiers.
6544 ;; These functions -- which are not commands -- each add one modifier
6545 ;; to the following event.
6547 (defun event-apply-alt-modifier (_ignore-prompt)
6550 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6551 (defun event-apply-super-modifier (_ignore-prompt)
6554 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6555 (defun event-apply-hyper-modifier (_ignore-prompt)
6558 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6559 (defun event-apply-shift-modifier (_ignore-prompt)
6562 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6563 (defun event-apply-control-modifier (_ignore-prompt)
6566 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6567 (defun event-apply-meta-modifier (_ignore-prompt)
6570 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6572 (defun event-apply-modifier (event symbol lshiftby prefix)
6573 "Apply a modifier flag to event EVENT.
6574 SYMBOL is the name of this modifier, as a symbol.
6575 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6576 PREFIX is the string that represents this modifier in an event type symbol."
6577 (if (numberp event)
6578 (cond ((eq symbol 'control)
6579 (if (and (<= (downcase event) ?z)
6580 (>= (downcase event) ?a))
6581 (- (downcase event) ?a -1)
6582 (if (and (<= (downcase event) ?Z)
6583 (>= (downcase event) ?A))
6584 (- (downcase event) ?A -1)
6585 (logior (lsh 1 lshiftby) event))))
6586 ((eq symbol 'shift)
6587 (if (and (<= (downcase event) ?z)
6588 (>= (downcase event) ?a))
6589 (upcase event)
6590 (logior (lsh 1 lshiftby) event)))
6591 (t
6592 (logior (lsh 1 lshiftby) event)))
6593 (if (memq symbol (event-modifiers event))
6594 event
6595 (let ((event-type (if (symbolp event) event (car event))))
6596 (setq event-type (intern (concat prefix (symbol-name event-type))))
6597 (if (symbolp event)
6598 event-type
6599 (cons event-type (cdr event)))))))
6601 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6602 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6603 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6604 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6605 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6606 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6607 \f
6608 ;;;; Keypad support.
6610 ;; Make the keypad keys act like ordinary typing keys. If people add
6611 ;; bindings for the function key symbols, then those bindings will
6612 ;; override these, so this shouldn't interfere with any existing
6613 ;; bindings.
6615 ;; Also tell read-char how to handle these keys.
6616 (mapc
6617 (lambda (keypad-normal)
6618 (let ((keypad (nth 0 keypad-normal))
6619 (normal (nth 1 keypad-normal)))
6620 (put keypad 'ascii-character normal)
6621 (define-key function-key-map (vector keypad) (vector normal))))
6622 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6623 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6624 (kp-space ?\s)
6627 (kp-multiply ?*)
6628 (kp-add ?+)
6629 (kp-separator ?,)
6630 (kp-subtract ?-)
6631 (kp-decimal ?.)
6632 (kp-divide ?/)
6633 (kp-equal ?=)
6634 ;; Do the same for various keys that are represented as symbols under
6635 ;; GUIs but naturally correspond to characters.
6636 (backspace 127)
6637 (delete 127)
6640 (clear ?\C-l)
6641 (return ?\C-m)
6642 (escape ?\e)
6643 ))
6644 \f
6645 ;;;;
6646 ;;;; forking a twin copy of a buffer.
6647 ;;;;
6649 (defvar clone-buffer-hook nil
6650 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6652 (defvar clone-indirect-buffer-hook nil
6653 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6655 (defun clone-process (process &optional newname)
6656 "Create a twin copy of PROCESS.
6657 If NEWNAME is nil, it defaults to PROCESS' name;
6658 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6659 If PROCESS is associated with a buffer, the new process will be associated
6660 with the current buffer instead.
6661 Returns nil if PROCESS has already terminated."
6662 (setq newname (or newname (process-name process)))
6664 (setq newname (substring newname 0 (match-beginning 0))))
6665 (when (memq (process-status process) '(run stop open))
6666 (let* ((process-connection-type (process-tty-name process))
6667 (new-process
6668 (if (memq (process-status process) '(open))
6669 (let ((args (process-contact process t)))
6670 (setq args (plist-put args :name newname))
6671 (setq args (plist-put args :buffer
6672 (if (process-buffer process)
6673 (current-buffer))))
6674 (apply 'make-network-process args))
6675 (apply 'start-process newname
6676 (if (process-buffer process) (current-buffer))
6677 (process-command process)))))
6678 (set-process-query-on-exit-flag
6679 new-process (process-query-on-exit-flag process))
6680 (set-process-inherit-coding-system-flag
6681 new-process (process-inherit-coding-system-flag process))
6682 (set-process-filter new-process (process-filter process))
6683 (set-process-sentinel new-process (process-sentinel process))
6684 (set-process-plist new-process (copy-sequence (process-plist process)))
6685 new-process)))
6687 ;; things to maybe add (currently partly covered by `funcall mode'):
6688 ;; - syntax-table
6689 ;; - overlays
6690 (defun clone-buffer (&optional newname display-flag)
6691 "Create and return a twin copy of the current buffer.
6692 Unlike an indirect buffer, the new buffer can be edited
6693 independently of the old one (if it is not read-only).
6694 NEWNAME is the name of the new buffer. It may be modified by
6695 adding or incrementing <N> at the end as necessary to create a
6696 unique buffer name. If nil, it defaults to the name of the
6697 current buffer, with the proper suffix. If DISPLAY-FLAG is
6698 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6699 clone a file-visiting buffer, or a buffer whose major mode symbol
6700 has a non-nil `no-clone' property, results in an error.
6702 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6703 current buffer with appropriate suffix. However, if a prefix
6704 argument is given, then the command prompts for NEWNAME in the
6705 minibuffer.
6707 This runs the normal hook `clone-buffer-hook' in the new buffer
6708 after it has been set up properly in other respects."
6709 (interactive
6710 (progn
6711 (if buffer-file-name
6712 (error "Cannot clone a file-visiting buffer"))
6713 (if (get major-mode 'no-clone)
6714 (error "Cannot clone a buffer in %s mode" mode-name))
6715 (list (if current-prefix-arg
6716 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6717 t)))
6718 (if buffer-file-name
6719 (error "Cannot clone a file-visiting buffer"))
6720 (if (get major-mode 'no-clone)
6721 (error "Cannot clone a buffer in %s mode" mode-name))
6722 (setq newname (or newname (buffer-name)))
6724 (setq newname (substring newname 0 (match-beginning 0))))
6725 (let ((buf (current-buffer))
6726 (ptmin (point-min))
6727 (ptmax (point-max))
6728 (pt (point))
6729 (mk (if mark-active (mark t)))
6730 (modified (buffer-modified-p))
6731 (mode major-mode)
6732 (lvars (buffer-local-variables))
6733 (process (get-buffer-process (current-buffer)))
6734 (new (generate-new-buffer (or newname (buffer-name)))))
6735 (save-restriction
6736 (widen)
6737 (with-current-buffer new
6738 (insert-buffer-substring buf)))
6739 (with-current-buffer new
6740 (narrow-to-region ptmin ptmax)
6741 (goto-char pt)
6742 (if mk (set-mark mk))
6743 (set-buffer-modified-p modified)
6745 ;; Clone the old buffer's process, if any.
6746 (when process (clone-process process))
6748 ;; Now set up the major mode.
6749 (funcall mode)
6751 ;; Set up other local variables.
6752 (mapc (lambda (v)
6753 (condition-case () ;in case var is read-only
6754 (if (symbolp v)
6755 (makunbound v)
6756 (set (make-local-variable (car v)) (cdr v)))
6757 (error nil)))
6758 lvars)
6760 ;; Run any hooks (typically set up by the major mode
6761 ;; for cloning to work properly).
6762 (run-hooks 'clone-buffer-hook))
6763 (if display-flag
6764 ;; Presumably the current buffer is shown in the selected frame, so
6765 ;; we want to display the clone elsewhere.
6766 (let ((same-window-regexps nil)
6767 (same-window-buffer-names))
6768 (pop-to-buffer new)))
6769 new))
6772 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6773 "Create an indirect buffer that is a twin copy of the current buffer.
6775 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6776 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6777 or if not called with a prefix arg, NEWNAME defaults to the current
6778 buffer's name. The name is modified by adding a `<N>' suffix to it
6779 or by incrementing the N in an existing suffix. Trying to clone a
6780 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6781 property results in an error.
6783 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6784 This is always done when called interactively.
6786 Optional third arg NORECORD non-nil means do not put this buffer at the
6787 front of the list of recently selected ones."
6788 (interactive
6789 (progn
6790 (if (get major-mode 'no-clone-indirect)
6791 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6792 (list (if current-prefix-arg
6793 (read-buffer "Name of indirect buffer: " (current-buffer)))
6794 t)))
6795 (if (get major-mode 'no-clone-indirect)
6796 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6797 (setq newname (or newname (buffer-name)))
6799 (setq newname (substring newname 0 (match-beginning 0))))
6800 (let* ((name (generate-new-buffer-name newname))
6801 (buffer (make-indirect-buffer (current-buffer) name t)))
6802 (with-current-buffer buffer
6803 (run-hooks 'clone-indirect-buffer-hook))
6804 (when display-flag
6805 (pop-to-buffer buffer norecord))
6806 buffer))
6809 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6810 "Like `clone-indirect-buffer' but display in another window."
6811 (interactive
6812 (progn
6813 (if (get major-mode 'no-clone-indirect)
6814 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6815 (list (if current-prefix-arg
6816 (read-buffer "Name of indirect buffer: " (current-buffer)))
6817 t)))
6818 (let ((pop-up-windows t))
6819 (clone-indirect-buffer newname display-flag norecord)))
6821 \f
6822 ;;; Handling of Backspace and Delete keys.
6824 (defcustom normal-erase-is-backspace 'maybe
6825 "Set the default behavior of the Delete and Backspace keys.
6827 If set to t, Delete key deletes forward and Backspace key deletes
6828 backward.
6830 If set to nil, both Delete and Backspace keys delete backward.
6832 If set to 'maybe (which is the default), Emacs automatically
6833 selects a behavior. On window systems, the behavior depends on
6834 the keyboard used. If the keyboard has both a Backspace key and
6835 a Delete key, and both are mapped to their usual meanings, the
6836 option's default value is set to t, so that Backspace can be used
6837 to delete backward, and Delete can be used to delete forward.
6839 If not running under a window system, customizing this option
6840 accomplishes a similar effect by mapping C-h, which is usually
6841 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6842 via `keyboard-translate'. The former functionality of C-h is
6843 available on the F1 key. You should probably not use this
6844 setting if you don't have both Backspace, Delete and F1 keys.
6846 Setting this variable with setq doesn't take effect. Programmatically,
6847 call `normal-erase-is-backspace-mode' (which see) instead."
6848 :type '(choice (const :tag "Off" nil)
6849 (const :tag "Maybe" maybe)
6850 (other :tag "On" t))
6851 :group 'editing-basics
6852 :version "21.1"
6853 :set (lambda (symbol value)
6854 ;; The fboundp is because of a problem with :set when
6855 ;; dumping Emacs. It doesn't really matter.
6856 (if (fboundp 'normal-erase-is-backspace-mode)
6857 (normal-erase-is-backspace-mode (or value 0))
6858 (set-default symbol value))))
6860 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6861 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6862 (unless frame (setq frame (selected-frame)))
6863 (with-selected-frame frame
6864 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6865 (normal-erase-is-backspace-mode
6866 (if (if (eq normal-erase-is-backspace 'maybe)
6867 (and (not noninteractive)
6868 (or (memq system-type '(ms-dos windows-nt))
6869 (memq window-system '(w32 ns))
6870 (and (memq window-system '(x))
6871 (fboundp 'x-backspace-delete-keys-p)
6872 (x-backspace-delete-keys-p))
6873 ;; If the terminal Emacs is running on has erase char
6874 ;; set to ^H, use the Backspace key for deleting
6875 ;; backward, and the Delete key for deleting forward.
6876 (and (null window-system)
6877 (eq tty-erase-char ?\^H))))
6878 normal-erase-is-backspace)
6879 1 0)))))
6881 (define-minor-mode normal-erase-is-backspace-mode
6882 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6883 With a prefix argument ARG, enable this feature if ARG is
6884 positive, and disable it otherwise. If called from Lisp, enable
6885 the mode if ARG is omitted or nil.
6887 On window systems, when this mode is on, Delete is mapped to C-d
6888 and Backspace is mapped to DEL; when this mode is off, both
6889 Delete and Backspace are mapped to DEL. (The remapping goes via
6890 `local-function-key-map', so binding Delete or Backspace in the
6891 global or local keymap will override that.)
6893 In addition, on window systems, the bindings of C-Delete, M-Delete,
6894 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6895 the global keymap in accordance with the functionality of Delete and
6896 Backspace. For example, if Delete is remapped to C-d, which deletes
6897 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6898 to DEL, which deletes backward, C-Delete is bound to
6899 `backward-kill-word'.
6901 If not running on a window system, a similar effect is accomplished by
6902 remapping C-h (normally produced by the Backspace key) and DEL via
6903 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6904 to C-d; if it's off, the keys are not remapped.
6906 When not running on a window system, and this mode is turned on, the
6907 former functionality of C-h is available on the F1 key. You should
6908 probably not turn on this mode on a text-only terminal if you don't
6909 have both Backspace, Delete and F1 keys.
6911 See also `normal-erase-is-backspace'."
6912 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
6913 . (lambda (v)
6914 (setf (terminal-parameter nil 'normal-erase-is-backspace)
6915 (if v 1 0))))
6916 (let ((enabled (eq 1 (terminal-parameter
6917 nil 'normal-erase-is-backspace))))
6919 (cond ((or (memq window-system '(x w32 ns pc))
6920 (memq system-type '(ms-dos windows-nt)))
6921 (let ((bindings
6922 `(([M-delete] [M-backspace])
6923 ([C-M-delete] [C-M-backspace])
6924 ([?\e C-delete] [?\e C-backspace]))))
6926 (if enabled
6927 (progn
6928 (define-key local-function-key-map [delete] [deletechar])
6929 (define-key local-function-key-map [kp-delete] [?\C-d])
6930 (define-key local-function-key-map [backspace] [?\C-?])
6931 (dolist (b bindings)
6932 ;; Not sure if input-decode-map is really right, but
6933 ;; keyboard-translate-table (used below) only works
6934 ;; for integer events, and key-translation-table is
6935 ;; global (like the global-map, used earlier).
6936 (define-key input-decode-map (car b) nil)
6937 (define-key input-decode-map (cadr b) nil)))
6938 (define-key local-function-key-map [delete] [?\C-?])
6939 (define-key local-function-key-map [kp-delete] [?\C-?])
6940 (define-key local-function-key-map [backspace] [?\C-?])
6941 (dolist (b bindings)
6942 (define-key input-decode-map (car b) (cadr b))
6943 (define-key input-decode-map (cadr b) (car b))))))
6944 (t
6945 (if enabled
6946 (progn
6947 (keyboard-translate ?\C-h ?\C-?)
6948 (keyboard-translate ?\C-? ?\C-d))
6949 (keyboard-translate ?\C-h ?\C-h)
6950 (keyboard-translate ?\C-? ?\C-?))))
6952 (if (called-interactively-p 'interactive)
6953 (message "Delete key deletes %s"
6954 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6955 "forward" "backward")))))
6956 \f
6957 (defvar vis-mode-saved-buffer-invisibility-spec nil
6958 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6960 (define-minor-mode read-only-mode
6961 "Change whether the current buffer is read-only.
6962 With prefix argument ARG, make the buffer read-only if ARG is
6963 positive, otherwise make it writable. If buffer is read-only
6964 and `view-read-only' is non-nil, enter view mode.
6966 Do not call this from a Lisp program unless you really intend to
6968 possibly enabling or disabling View mode. Also, note that this
6969 command works by setting the variable `buffer-read-only', which
6970 does not affect read-only regions caused by text properties. To
6971 ignore read-only status in a Lisp program (whether due to text
6972 properties or buffer state), bind `inhibit-read-only' temporarily
6973 to a non-nil value."
6974 :variable buffer-read-only
6975 (cond
6976 ((and (not buffer-read-only) view-mode)
6977 (View-exit-and-edit)
6978 (make-local-variable 'view-read-only)
6979 (setq view-read-only t)) ; Must leave view mode.
6980 ((and buffer-read-only view-read-only
6981 ;; If view-mode is already active, `view-mode-enter' is a nop.
6982 (not view-mode)
6983 (not (eq (get major-mode 'mode-class) 'special)))
6984 (view-mode-enter))))
6986 (define-minor-mode visible-mode
6987 "Toggle making all invisible text temporarily visible (Visible mode).
6988 With a prefix argument ARG, enable Visible mode if ARG is
6989 positive, and disable it otherwise. If called from Lisp, enable
6990 the mode if ARG is omitted or nil.
6992 This mode works by saving the value of `buffer-invisibility-spec'
6993 and setting it to nil."
6994 :lighter " Vis"
6995 :group 'editing-basics
6996 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6997 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6998 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6999 (when visible-mode
7000 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7001 buffer-invisibility-spec)
7002 (setq buffer-invisibility-spec nil)))
7003 \f
7004 ;; Minibuffer prompt stuff.
7006 ;;(defun minibuffer-prompt-modification (start end)
7007 ;; (error "You cannot modify the prompt"))
7008 ;;
7009 ;;
7010 ;;(defun minibuffer-prompt-insertion (start end)
7011 ;; (let ((inhibit-modification-hooks t))
7012 ;; (delete-region start end)
7013 ;; ;; Discard undo information for the text insertion itself
7014 ;; ;; and for the text deletion.above.
7015 ;; (when (consp buffer-undo-list)
7016 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7017 ;; (message "You cannot modify the prompt")))
7018 ;;
7019 ;;
7020 ;;(setq minibuffer-prompt-properties
7021 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7022 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7024 \f
7025 ;;;; Problematic external packages.
7027 ;; rms says this should be done by specifying symbols that define
7028 ;; versions together with bad values. This is therefore not as
7029 ;; flexible as it could be. See the thread:
7030 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7031 (defconst bad-packages-alist
7032 ;; Not sure exactly which semantic versions have problems.
7033 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7035 "The version of `semantic' loaded does not work in Emacs 22.
7036 It can cause constant high CPU load.
7037 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7038 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7039 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7040 ;; provided the `CUA-mode' feature. Since this is no longer true,
7041 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7042 (CUA-mode t nil
7043 "CUA-mode is now part of the standard GNU Emacs distribution,
7044 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7046 You have loaded an older version of CUA-mode which does not work
7047 correctly with this version of Emacs. You should remove the old
7048 version and use the one distributed with Emacs."))
7049 "Alist of packages known to cause problems in this version of Emacs.
7050 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7051 PACKAGE is either a regular expression to match file names, or a
7052 symbol (a feature name); see the documentation of
7053 `after-load-alist', to which this variable adds functions.
7054 SYMBOL is either the name of a string variable, or `t'. Upon
7055 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7056 warning using STRING as the message.")
7058 (defun bad-package-check (package)
7059 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7060 (condition-case nil
7061 (let* ((list (assoc package bad-packages-alist))
7062 (symbol (nth 1 list)))
7063 (and list
7064 (boundp symbol)
7065 (or (eq symbol t)
7066 (and (stringp (setq symbol (eval symbol)))
7067 (string-match-p (nth 2 list) symbol)))
7068 (display-warning package (nth 3 list) :warning)))
7069 (error nil)))
7071 (mapc (lambda (elem)
7072 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
7073 bad-packages-alist)
7076 (provide 'simple)
7078 ;;; simple.el ends here