| blob | 6825c41becc14e2dc5a73b36ea2db78b49a66116 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2013 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."
354 ;; 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 ;; Making and deleting lines.
381 "Insert a newline, and move to left margin of the new line if it's blank.
382 If option `use-hard-newlines' is non-nil, the newline is marked with the
383 text-property `hard'.
384 With ARG, insert that many newlines.
385 Call `auto-fill-function' if the current column number is greater
386 than the value of `fill-column' and ARG is nil."
389 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
390 ;; Set last-command-event to tell self-insert what to insert.
394 ;; Don't auto-fill if we have a numeric argument.
397 ;; Do the rest in post-self-insert-hook, because we want to do it
398 ;; *before* other functions on that hook.
400 ;; Mark the newline(s) `hard'.
404 ;; If the newline leaves the previous line blank, and we
405 ;; have a left margin, delete that from the blank line.
413 ;; Indent the line after the newline, except in one case:
414 ;; when we added the newline at the beginning of a line which
415 ;; starts a page.
422 ;; We first used let-binding to protect the hook, but that was naive
423 ;; since add-hook affects the symbol-default value of the variable,
424 ;; whereas the let-binding might only protect the buffer-local value.
426 nil)
431 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
437 "Insert a newline and leave point before it.
438 If there is a fill prefix and/or a `left-margin', insert them
439 on the new line if the line would have been blank.
440 With arg N, insert N newlines."
445 ;; Don't expand an abbrev before point.
459 "Split current line, moving portion beyond point vertically down.
460 If the current line starts with `fill-prefix', insert it on the new
461 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
463 When called from Lisp code, ARG may be a prefix string to copy."
468 ;; What prefix should we check for (nil means don't).
472 ;; Does this line start with it?
483 "Join this line to previous and fix up whitespace at join.
484 If there is a fill prefix, delete it from the beginning of this line.
485 With argument, join this line to following line."
492 ;; If the second line started with the fill prefix,
493 ;; delete the prefix.
505 "On blank line, delete all surrounding blank lines, leaving just one.
506 On isolated blank line, delete that one.
507 On nonblank line, delete any immediately following blank lines."
513 ;; Set singleblank if there is just one blank line here.
520 ;; Delete preceding blank lines, and this one too if it's the only one.
529 ;; Delete following blank lines, unless the current line is blank
530 ;; and there are no following blank lines.
539 ;; Handle the special case where point is followed by newline and eob.
540 ;; Delete the line, leaving point at eob.
546 Trailing lines are deleted only if `delete-trailing-whitespace'
547 is called on the entire buffer (rather than an active region)."
553 "Delete trailing whitespace between START and END.
554 If called interactively, START and END are the start/end of the
555 region if the mark is active, or of the buffer's accessible
556 portion if the mark is inactive.
558 This command deletes whitespace characters after the last
559 non-whitespace character in each line between START and END. It
560 does not consider formfeed characters to be whitespace.
562 If this command acts on the entire buffer (i.e. if called
563 interactively with the mark inactive, or called from Lisp with
564 END nil), it also deletes all trailing lines at the end of the
565 buffer if the variable `delete-trailing-lines' is non-nil."
578 ;; Don't delete formfeeds, even if they are considered whitespace.
582 ;; Delete trailing empty lines.
585 delete-trailing-lines
586 ;; Really the end of buffer.
591 ;; Return nil for the benefit of `write-file-functions'.
592 nil)
595 "Insert a newline, then indent according to major mode.
596 Indentation is done using the value of `indent-line-function'.
597 In programming language modes, this is the same as TAB.
598 In some text modes, where TAB inserts a tab, this command indents to the
599 column specified by the function `current-left-margin'."
606 "Reindent current line, insert newline, then indent the new line.
607 Indentation of both lines is done according to the current major mode,
608 which means calling the current value of `indent-line-function'.
609 In programming language modes, this is the same as TAB.
610 In some text modes, where TAB inserts a tab, this indents to the
611 column specified by the function `current-left-margin'."
614 ;; Be careful to insert the newline before indenting the line.
615 ;; Otherwise, the indentation might be wrong.
619 ;; We are at EOL before the call to indent-according-to-mode, and
620 ;; after it we usually are as well, but not always. We tried to
621 ;; address it with `save-excursion' but that uses a normal marker
622 ;; whereas we need `move after insertion', so we do the save/restore
623 ;; by hand.
627 ;; Remove the trailing white-space after indentation because
628 ;; indentation may introduce the whitespace.
633 "Read next input character and insert it.
634 This is useful for inserting control characters.
635 With argument, insert ARG copies of the character.
637 If the first character you type after this command is an octal digit,
638 you should type a sequence of octal digits which specify a character code.
639 Any nondigit terminates the sequence. If the terminator is a RET,
640 it is discarded; any other terminator is used itself as input.
641 The variable `read-quoted-char-radix' specifies the radix for this feature;
642 set it to 10 or 16 to use decimal or hex instead of octal.
644 In overwrite mode, this function inserts the character anyway, and
645 does not handle octal digits specially. This means that if you use
646 overwrite as your normal editing mode, you can use this function to
647 insert characters when necessary.
649 In binary overwrite mode, this function does overwrite, and octal
650 digits are interpreted as a character code. This is intended to be
651 useful for editing binary files."
654 ;; Avoid "obsolete" warnings for translation-table-for-input.
661 ;; This used to assume character codes 0240 - 0377 stand for
662 ;; characters in some single-byte character set, and converted them
663 ;; to Emacs characters. But in 23.1 this feature is deprecated
664 ;; in favor of inserting the corresponding Unicode characters.
665 ;; (if (and enable-multibyte-characters
666 ;; (>= char ?\240)
667 ;; (<= char ?\377))
668 ;; (setq char (unibyte-char-to-multibyte char)))
677 "Move forward ARG lines and position at first nonblank character."
683 "Move backward ARG lines and position at first nonblank character."
689 "Move point to the first non-whitespace character on this line."
693 ;; Move back over chars that have whitespace syntax but have the p flag.
697 "Fixup white space between objects around point.
698 Leave one space or none, according to the context."
705 nil
709 "Delete all spaces and tabs around point.
710 If BACKWARD-ONLY is non-nil, only delete them before point."
715 orig-pos
724 "Delete all spaces and tabs around point, leaving one space (or N spaces).
725 If N is negative, delete newlines as well, leaving -N spaces."
730 "Store context used in consecutive calls to `cycle-spacing' command.
731 The first time this function is run, it saves the original point
732 position and original spacing around the point in this
736 "Manipulate spaces around the point in a smart way.
738 When run as an interactive command, the first time it's called
739 in a sequence, deletes all spaces and tabs around point leaving
740 one (or N spaces). If this does not change content of the
741 buffer, skips to the second step:
743 When run for the second time in a sequence, deletes all the
744 spaces it has previously inserted.
746 When run for the third time, returns the whitespace and point in
747 a state encountered when it had been run for the first time.
750 point, calling `cycle-spacing' command will replace two spaces with
751 a single space, calling it again immediately after, will remove all
752 spaces, and calling it for the third time will bring two spaces back
753 together.
755 If N is negative, delete newlines as well. However, if
756 PRESERVE-NL-BACK is t new line characters prior to the point
757 won't be removed.
759 If SINGLE-SHOT is non-nil, will only perform the first step. In
760 other words, it will work just like `just-one-space' command."
768 ;; Command run for the first time or single-shot is non-nil.
779 ;; Special handling for case where there was no space at all.
782 ;; If this run causes no change in buffer content, delete all spaces,
783 ;; otherwise delete all excess spaces.
788 ;; Command run for the second time.
792 ;; Command run for the third time.
797 \f
799 "Move point to the beginning of the buffer.
800 With numeric arg N, put point N/10 of the way from the beginning.
801 If the buffer is narrowed, this command uses the beginning of the
802 accessible part of the buffer.
804 If Transient Mark mode is disabled, leave mark at previous
807 Don't use this command in Lisp programs!
808 \(goto-char (point-min)) is faster."
817 ;; Avoid overflow for large buffer sizes!
825 "Move point to the end of the buffer.
826 With numeric arg N, put point N/10 of the way from the end.
827 If the buffer is narrowed, this command uses the end of the
828 accessible part of the buffer.
830 If Transient Mark mode is disabled, leave mark at previous
833 Don't use this command in Lisp programs!
834 \(goto-char (point-max)) is faster."
841 ;; Avoid overflow for large buffer sizes!
846 ;; If we went to a place in the middle of the buffer,
847 ;; adjust it to the beginning of a line.
851 ;; If the end of the buffer is not already on the screen,
852 ;; then scroll specially to put it near, but not at, the bottom.
857 "Whether single-char deletion commands delete an active region.
858 This has an effect only if Transient Mark mode is enabled, and
859 affects `delete-forward-char' and `delete-backward-char', though
860 not `delete-char'.
862 If the value is the symbol `kill', the active region is killed
863 instead of deleted."
871 "Delete the previous N characters (following if N is negative).
872 If Transient Mark mode is enabled, the mark is active, and N is 1,
873 delete the text in the region and deactivate the mark instead.
874 To disable this, set option `delete-active-region' to nil.
876 Optional second arg KILLFLAG, if non-nil, means to kill (save in
877 kill ring) instead of delete. Interactively, N is the prefix
878 arg, and KILLFLAG is set if N is explicitly specified.
880 In Overwrite mode, single character backward deletion may replace
881 tabs with spaces so as to back over columns, unless point is at
882 the end of the line."
887 delete-active-region
889 ;; If a region is active, kill or delete it.
893 ;; In Overwrite mode, maybe untabify while deleting
903 ;; Otherwise, do simple deletion.
907 "Delete the following N characters (previous if N is negative).
908 If Transient Mark mode is enabled, the mark is active, and N is 1,
909 delete the text in the region and deactivate the mark instead.
910 To disable this, set variable `delete-active-region' to nil.
912 Optional second arg KILLFLAG non-nil means to kill (save in kill
913 ring) instead of delete. Interactively, N is the prefix arg, and
914 KILLFLAG is set if N was explicitly specified."
919 delete-active-region
921 ;; If a region is active, kill or delete it.
925 ;; Otherwise, do simple deletion.
929 "Put point at beginning and mark at end of buffer.
930 If narrowing is in effect, only uses the accessible part of the buffer.
931 You probably should not use this function in Lisp programs;
932 it is usually a mistake for a Lisp function to use any subroutine
933 that uses or sets the mark."
938 \f
940 ;; Counting lines, one way or another.
943 "Go to LINE, counting from line 1 at beginning of buffer.
944 If called interactively, a numeric prefix argument specifies
945 LINE; without a numeric prefix argument, read LINE from the
946 minibuffer.
948 If optional argument BUFFER is non-nil, switch to that buffer and
950 as argument, BUFFER is the most recently selected other buffer.
952 Prior to moving point, this function sets the mark (without
953 activating it), unless Transient Mark mode is enabled and the
954 mark is already active.
956 This function is usually the wrong thing to use in a Lisp program.
957 What you probably want instead is something like:
958 (goto-char (point-min))
959 (forward-line (1- N))
960 If at all possible, an even better solution is to use char counts
961 rather than line counts."
965 ;; Look for a default, a number in the buffer at point.
975 ;; Decide if we're switching buffers.
983 ;; Read the argument, offering that number (if any) as default.
986 buffer))))
987 ;; Switch to the desired buffer, one way or another.
992 ;; Leave mark at previous position
994 ;; Move to the specified line number in that buffer.
1003 "Count the number of words in the region.
1004 If called interactively, print a message reporting the number of
1005 lines, words, and characters in the region (whether or not the
1006 region is active); with prefix ARG, report for the entire buffer
1007 rather than the region.
1009 If called from Lisp, return the number of words between positions
1010 START and END."
1022 "Count words between START and END.
1023 If called interactively, START and END are normally the start and
1024 end of the buffer; but if the region is active, START and END are
1025 the start and end of the region. Print a message reporting the
1026 number of lines, words, and chars.
1028 If called from Lisp, return the number of words between START and
1029 END, without printing any message."
1039 words))
1055 str
1063 "Print the current buffer line number and narrowed line number of point."
1076 "Return number of lines between START and END.
1077 This is usually the number of newlines between them,
1078 but can be one more if START is not equal to END
1079 and the greater of them is not at the start of a line."
1095 done)))
1099 "Return (narrowed) buffer line number at position POS.
1100 If POS is nil, use current buffer location.
1101 Counting starts at (point-min), so the value refers
1102 to the contents of the accessible portion of the buffer."
1112 "Print info on cursor position (on screen and within buffer).
1113 Also describe the character after point, and give its character code
1114 in octal, decimal and hex.
1116 For a non-ASCII multibyte character, also give its encoding in the
1117 buffer's selected coding system if the coding system encodes the
1118 character safely. If the character is encoded into one byte, that
1119 code is shown in hex. If the character is encoded into more than one
1122 In addition, with prefix argument, show details about that character
1123 in *Help* buffer. See also the command `describe-char'."
1128 ;; If the character is one of LRE, LRO, RLE, RLO, it
1129 ;; will start a directional embedding, which could
1130 ;; completely disrupt the rest of the line (e.g., RLO
1131 ;; will display the rest of the line right-to-left).
1132 ;; So we put an invisible PDF character after these
1133 ;; characters, to end the embedding, which eliminates
1134 ;; any effects on the rest of the line.
1136 ;; Strong right-to-left characters cause reordering of
1137 ;; the following numerical characters which show the
1138 ;; codepoint, so append LRM to countermand that.
1148 ;; Avoid overflow from multiplying by 100!
1152 ""
1158 pos total percent beg end col hscroll)
1160 pos total col hscroll))
1162 encoded encoding-msg display-prop under-display)
1169 ;; Check if the character is displayed with some `display'
1170 ;; text property. In that case, set under-display to the
1171 ;; buffer substring covered by that property.
1182 under-display)))
1188 char char char under-display)
1190 char char char under-display display-prop))
1193 char char char
1195 "..."
1199 ;; We show the detailed information about CHAR.
1206 bidi-fixer
1207 encoding-msg pos total percent beg end col hscroll)
1214 bidi-fixer encoding-msg pos total percent col hscroll))))))
1215 \f
1216 ;; Initialize read-expression-map. It is defined at C level.
1220 ;; Might as well bind TAB to completion, since inserting a TAB char is
1221 ;; much too rarely useful.
1224 m))
1227 "Return a Lisp object read using the minibuffer, unevaluated.
1228 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1229 is a string to insert in the minibuffer before reading.
1230 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1231 Such arguments are used as in `read-from-minibuffer'.)"
1232 ;; Used for interactive spec `x'.
1234 t minibuffer-history))
1237 "Return value of Lisp expression read using the minibuffer.
1238 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1239 is a string to insert in the minibuffer before reading.
1240 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1241 Such arguments are used as in `read-from-minibuffer'.)"
1242 ;; Used for interactive spec `X'.
1250 "The current default value or list of default values in the minibuffer.
1251 The functions `read-from-minibuffer' and `completing-read' bind
1255 "Value for `print-level' while printing value in `eval-expression'.
1256 A value of nil means no limit."
1262 "Value for `print-length' while printing value in `eval-expression'.
1263 A value of nil means no limit."
1269 "If non-nil set `debug-on-error' to t in `eval-expression'.
1270 If nil, don't change the value of `debug-on-error'."
1276 "Format VALUE as a result of evaluated expression.
1277 Return a formatted string which is displayed in the echo area
1278 in addition to the value printed by prin1 in functions which
1279 display the result of expression evaluation."
1303 read-expression-map t
1306 ;; We define this, rather than making `eval' interactive,
1307 ;; for the sake of completion of names like eval-region, eval-buffer.
1309 "Evaluate EXP and print value in the echo area.
1310 When called interactively, read an Emacs Lisp expression and
1311 evaluate it.
1312 Value is also consed on to front of the variable `values'.
1313 Optional argument INSERT-VALUE non-nil (interactively,
1314 with prefix argument) means insert the result into the current buffer
1315 instead of printing it in the echo area. Truncates long output
1316 according to the value of the variables `eval-expression-print-length'
1317 and `eval-expression-print-level'.
1319 If `eval-expression-debug-on-error' is non-nil, which is the default,
1320 this command arranges for all errors to enter the debugger."
1323 current-prefix-arg))
1328 ;; Bind debug-on-error to something unique so that we can
1329 ;; detect when evalled code changes it.
1333 ;; If evalled code has changed the value of debug-on-error,
1334 ;; propagate that change to the global binding.
1351 "Prompting with PROMPT, let user edit COMMAND and eval result.
1352 COMMAND is a Lisp expression. Let user edit that expression in
1353 the minibuffer, then read and evaluate the result."
1360 read-expression-map t
1362 ;; If command was added to command-history as a string,
1363 ;; get rid of that. We want only evaluable expressions there.
1367 ;; If command to be redone does not match front of history,
1368 ;; add it to the history.
1374 "Edit and re-evaluate last complex command, or ARGth from last.
1375 A complex command is one which used the minibuffer.
1376 The command is placed in the minibuffer as a Lisp form for editing.
1377 The result is executed, repeating the command as changed.
1378 If the command has been changed or is not the most recent previous
1379 command it is added to the front of the command history.
1380 You can use the minibuffer history commands \
1382 to get different commands to edit and resubmit."
1385 newcmd)
1397 ;; If command was added to command-history as a
1398 ;; string, get rid of that. We want only
1399 ;; evaluable expressions there.
1403 ;; If command to be redone does not match front of history,
1404 ;; add it to the history.
1415 "Read command name to invoke in `execute-extended-command'."
1420 ;; Get a command name at point in the original buffer
1421 ;; to propose it after M-n.
1425 ;; Read a string, completing from and restricting to the set of
1426 ;; all defined commands. Don't provide any initial input.
1427 ;; Save the command read on the extended-command history list.
1438 ;; This isn't strictly correct if `execute-extended-command'
1439 ;; is bound to anything else (e.g. [menu]).
1440 ;; It could use (key-description (this-single-command-keys)),
1441 ;; but actually a prompt other than "M-x" would be confusing,
1442 ;; because "M-x" is a well-known prompt to read a command
1443 ;; and it serves as a shorthand for "Extended command: ".
1448 "Non-nil means show the equivalent key-binding when M-x command has one.
1449 The value can be a length of time to show the message for.
1450 If the value is non-nil and not a number, we wait 2 seconds."
1457 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1458 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1459 "Read function name, then read its arguments and call it.
1461 To pass a numeric argument to the command you are invoking, specify
1462 the numeric argument to this command.
1464 Noninteractively, the argument PREFIXARG is the prefix argument to
1465 give to the command you invoke, if it asks for an argument."
1467 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1478 ;; Normally `real-this-command' should never be changed, but here we really
1479 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1480 ;; binding" for <cmd>, so the command the user really wanted to run is
1481 ;; `function' and not `execute-extended-command'. The difference is
1482 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1486 ;; If enabled, show which key runs this command.
1488 ;; But first wait, and skip the message if there is input.
1490 ;; If this command displayed something in the echo area;
1491 ;; wait a few seconds, then display our suggestion message.
1501 suggest-key-bindings
1505 ;; BEWARE: Called directly from the C code.
1506 "Execute CMD as an editor command.
1507 CMD must be a symbol that satisfies the `commandp' predicate.
1508 Optional second arg RECORD-FLAG non-nil
1509 means unconditionally put this command in the variable `command-history'.
1510 Otherwise, that is done only if an arg is read using the minibuffer.
1511 The argument KEYS specifies the value to use instead of (this-command-keys)
1512 when reading the arguments; if it is nil, (this-command-keys) is used.
1513 The argument SPECIAL, if non-nil, means that this command is executing
1514 a special event, so ignore the prefix argument and don't clear it."
1522 ;; FIXME: Weird calling convention!
1532 ;; If requested, place the macro in the command history. For
1533 ;; other sorts of commands, call-interactively takes care of this.
1536 ;; Don't keep command history around forever.
1542 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1550 \f
1552 "Default minibuffer history list.
1553 This is used for all minibuffer input
1554 except when an alternate history list is specified.
1556 Maximum length of the history list is determined by the value
1559 "Control whether history list elements are expressions or strings.
1560 If the value of this variable equals current minibuffer depth,
1561 they are expressions; otherwise they are strings.
1562 \(That convention is designed to do the right thing for
1569 "Text that was in this minibuffer before any history commands.
1570 This is nil if there have not yet been any history commands
1579 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1583 "Minibuffer history variables for which matching should ignore case.
1584 If a history variable is a member of this list, then the
1586 commands ignore case when searching it, regardless of `case-fold-search'."
1591 "Find the previous history element that matches REGEXP.
1592 \(Previous history elements refer to earlier actions.)
1593 With prefix argument N, search for Nth previous match.
1594 If N is negative, find the next or Nth next match.
1595 Normally, history elements are matched case-insensitively if
1596 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1597 makes the search case-sensitive.
1598 See also `minibuffer-history-case-insensitive-variables'."
1602 nil
1603 minibuffer-local-map
1604 nil
1605 'minibuffer-history-search-history
1607 ;; Use the last regexp specified, by default, if input is empty.
1612 regexp)
1622 ;; On some systems, ignore case for file names.
1624 minibuffer-history-case-insensitive-variables)
1625 t
1626 ;; Respect the user's setting for case-fold-search:
1627 case-fold-search)
1628 nil))
1629 prevpos
1630 match-string
1631 match-offset
1638 "No later matching history item"
1659 next-matching-history-element))
1663 "Find the next history element that matches REGEXP.
1664 \(The next history element refers to a more recent action.)
1665 With prefix argument N, search for Nth next match.
1666 If N is negative, find the previous or Nth previous match.
1667 Normally, history elements are matched case-insensitively if
1668 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1669 makes the search case-sensitive."
1673 nil
1674 minibuffer-local-map
1675 nil
1676 'minibuffer-history-search-history
1678 ;; Use the last regexp specified, by default, if input is empty.
1683 regexp)
1690 "Function run by `goto-history-element' before consuming default values.
1691 This is useful to dynamically add more elements to the list of default values
1692 when `goto-history-element' reaches the end of this list.
1693 Before calling this function `goto-history-element' sets the variable
1694 `minibuffer-default-add-done' to t, so it will call this function only
1695 once. In special cases, when this function needs to be called more
1696 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1700 "When nil, add more elements to the end of the list of default values.
1701 The value nil causes `goto-history-element' to add more elements to
1702 the list of defaults when it reaches the end of this list. It does
1708 "Return a list of all completions without the default value.
1709 This function is used to add all elements of the completion table to
1710 the end of the list of defaults just after the default value."
1713 minibuffer-completion-table
1714 minibuffer-completion-predicate)))
1720 "Puts element of the minibuffer history in the minibuffer.
1721 The argument NABS specifies the absolute history position."
1735 elt minibuffer-returned-to-present)
1742 "End of defaults; no next item"
1747 previous-history-element))
1759 minibuffer-default)))
1771 elt))
1775 "Puts next element of the minibuffer history in the minibuffer.
1776 With argument N, it uses the Nth following element."
1782 "Puts previous element of the minibuffer history in the minibuffer.
1783 With argument N, it uses the Nth previous element."
1789 "Get next history element which completes the minibuffer before the point.
1790 The contents of the minibuffer after the point are deleted, and replaced
1791 by the new completion."
1797 n)
1798 ;; next-matching-history-element always puts us at (point-min).
1799 ;; Move to the position we were at before changing the buffer contents.
1800 ;; This is still sensible, because the text before point has not changed.
1804 "\
1805 Get previous history element which completes the minibuffer before the point.
1806 The contents of the minibuffer after the point are deleted, and replaced
1807 by the new completion."
1811 ;; For compatibility with the old subr of the same name.
1813 "Return the display width of the minibuffer prompt.
1814 Return 0 if current buffer is not a minibuffer."
1815 ;; Return the width of everything before the field at the end of
1816 ;; the buffer; this should be 0 for normal buffers.
1818 \f
1819 ;; isearch minibuffer history
1826 "Set up a minibuffer for using isearch to search the minibuffer history.
1827 Intended to be added to `minibuffer-setup-hook'."
1839 "Clean up the minibuffer after terminating isearch in the minibuffer."
1844 "Return the proper search function, for isearch in minibuffer history."
1847 ;; Use standard functions to search within minibuffer text
1849 found)
1850 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1851 ;; searching forward. Lazy-highlight calls this lambda with the
1852 ;; bound arg, so skip the minibuffer prompt.
1856 ;; 1. First try searching in the initial minibuffer text
1859 noerror)
1860 ;; 2. If the above search fails, start putting next/prev history
1861 ;; elements in the minibuffer successively, and search the string
1862 ;; in them. Do this only when bound is nil (i.e. not while
1863 ;; lazy-highlighting search strings in the current minibuffer text).
1875 ;; After putting the next/prev history element, search
1876 ;; the string in them again, until next-history-element
1877 ;; or previous-history-element raises an error at the
1878 ;; beginning/end of history.
1881 ;; For backward search, don't search
1882 ;; in the minibuffer prompt
1884 noerror)))
1885 ;; Return point of the new search result
1887 ;; Return nil when next(prev)-history-element fails
1891 "Display the minibuffer history search prompt.
1892 If there are no search errors, this function displays an overlay with
1893 the isearch prompt which replaces the original minibuffer prompt.
1894 Otherwise, it displays the standard isearch message returned from
1895 the function `isearch-message'."
1897 ;; Use standard function `isearch-message' when not in the minibuffer,
1898 ;; or search fails, or has an error (like incomplete regexp).
1899 ;; This function overwrites minibuffer text with isearch message,
1900 ;; so it's possible to see what is wrong in the search string.
1902 ;; Otherwise, put the overlay with the standard isearch prompt over
1903 ;; the initial minibuffer prompt.
1912 ;; And clear any previous isearch message.
1916 "Wrap the minibuffer history search when search fails.
1917 Move point to the first history element for a forward search,
1918 or to the last history element for a backward search."
1919 ;; When `minibuffer-history-isearch-search' fails on reaching the
1920 ;; beginning/end of the history, wrap the search to the first/last
1921 ;; minibuffer history element.
1929 "Save a function restoring the state of minibuffer history search.
1930 Save `minibuffer-history-position' to the additional state parameter
1931 in the search status stack."
1937 "Restore the minibuffer history search state.
1938 Go to the history element by the absolute history position HIST-POS."
1941 \f
1942 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1946 "Table mapping redo records to the corresponding undo one.
1947 A redo record for undo-in-region maps to t.
1957 "Within a run of consecutive undo commands, list remaining to be undone.
1961 "Undo some previous changes.
1962 Repeat this command to undo more changes.
1963 A numeric ARG serves as a repeat count.
1965 In Transient Mark mode when the mark is active, only undo changes within
1967 as an argument limits undo to changes within the current region."
1969 ;; Make last-command indicate for the next command that this was an undo.
1970 ;; That way, another undo will undo more.
1971 ;; If we get to the end of the undo history and get an error,
1972 ;; another undo command will find the undo history empty
1973 ;; and will get another error. To begin undoing the undos,
1974 ;; you must type some other command.
1976 ;; For an indirect buffer, look in the base buffer for the
1977 ;; auto-save data.
1981 message)
1982 ;; If we get an error in undo-start,
1983 ;; the next command should not be a "consecutive undo".
1984 ;; So set `this-command' to something other than `undo'.
1989 ;; If something (a timer or filter?) changed the buffer
1990 ;; since the previous command, don't continue the undo seq.
1994 ;; If the last undo record made was made by undo
1995 ;; it shows nothing else happened in between.
2002 ;; get rid of initial undo boundary
2004 ;; If we got this far, the next command should be a consecutive undo.
2006 ;; Check to see whether we're hitting a redo record, and if
2007 ;; so, ask the user whether she wants to skip the redo/undo pair.
2015 ;; The equiv entry might point to another redo record if we have done
2016 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2024 ;; Record the fact that the just-generated undo records come from an
2025 ;; undo operation--that is, they are redo records.
2026 ;; In the ordinary case (not within a region), map the redo
2027 ;; record to the following undos.
2028 ;; I don't know how to do that in the undo-in-region case.
2030 ;; Strip any leading undo boundaries there might be, like we do
2031 ;; above when checking.
2035 undo-equiv-table))
2036 ;; Don't specify a position in the undo record for the undo command.
2037 ;; Instead, undoing this should move point to where the change is.
2056 ;; Record what the current undo list says,
2057 ;; so the next command can tell if the buffer was modified in between.
2061 ;; Display a message announcing success.
2066 "Make BUFFER stop keeping undo information.
2067 No argument or nil as argument means do this for the current buffer."
2073 "Undo some previous changes.
2074 Repeat this command to undo more changes.
2075 A numeric ARG serves as a repeat count.
2076 Contrary to `undo', this will not redo a previous undo."
2081 "Non-nil while performing an undo.
2085 "Undo back N undo-boundaries beyond what was already undone recently.
2086 Call `undo-start' to get ready to undo recent changes,
2087 then call `undo-more' one or more times to undo them."
2092 ;; Note: The following, while pulling elements off
2093 ;; `pending-undo-list' will call primitive change functions which
2094 ;; will push more elements onto `buffer-undo-list'.
2100 "Undo N records from the front of the list LIST.
2101 Return what remains of the list."
2103 ;; This is a good feature, but would make undo-start
2104 ;; unable to do what is expected.
2105 ;;(when (null (car (list)))
2106 ;; ;; If the head of the list is a boundary, it is the boundary
2107 ;; ;; preceding this command. Get rid of it and don't count it.
2108 ;; (setq list (cdr list))))
2111 ;; In a writable buffer, enable undoing read-only text that is
2112 ;; so because of text properties.
2114 ;; Don't let `intangible' properties interfere with undo.
2116 ;; We use oldlist only to check for EQ. ++kfs
2122 ;; Handle an integer by setting point to that value.
2125 ;; Element (t . TIME) records previous modtime.
2126 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2127 ;; UNKNOWN_MODTIME_NSECS.
2129 ;; If this records an obsolete save
2130 ;; (not matching the actual disk file)
2131 ;; then don't mark unmodified.
2139 ;; Element (nil PROP VAL BEG . END) is property change.
2144 ;; Element (BEG . END) means range was inserted.
2146 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2147 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2150 ;; Set point first thing, so that undoing this undo
2151 ;; does not send point back to where it is now.
2154 ;; Element (apply FUN . ARGS) means call FUN to undo.
2158 ;; Long format: (apply DELTA START END FUN . ARGS).
2165 ;; Check that the function did what the entry
2166 ;; said it would do.
2176 ;; Element (STRING . POS) means STRING was deleted.
2186 ;; Now that we record marker adjustments
2187 ;; (caused by deletion) for undo,
2188 ;; we should always insert after markers,
2189 ;; so that undoing the marker adjustments
2190 ;; put the markers back in the right place.
2193 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2201 ;; Make sure an apply entry produces at least one undo entry,
2202 ;; so the test in `undo' for continuing an undo series
2203 ;; will work right.
2208 list)
2210 ;; Deep copy of a list
2212 "Make a copy of undo list LIST."
2218 elt))
2221 "Set `pending-undo-list' to the front of the undo list.
2222 The next call to `undo-more' will undo the most recently made change.
2223 If BEG and END are specified, then only undo elements
2224 that apply to text between BEG and END are used; other undo elements
2225 are ignored. If BEG and END are nil, all undo elements are used."
2231 buffer-undo-list)))
2236 "Return a list of undo elements for the region START to END.
2237 The elements come from `buffer-undo-list', but we keep only
2238 the elements inside this region, and discard those outside this region.
2239 If we find an element that crosses an edge of this region,
2240 we stop and ignore all further elements."
2243 undo-adjusted-markers
2244 some-rejected
2245 undo-elt temp-undo-list delta)
2250 ;; This is a "was unmodified" element.
2251 ;; Keep it if we have kept everything thus far.
2258 ;; Don't put two nils together in the list
2272 ;; Loop down the earlier events adjusting their buffer
2273 ;; positions to reflect the fact that a change to the buffer
2274 ;; isn't being undone. We only need to process those element
2275 ;; types which undo-elt-in-region will return as being in
2276 ;; the region since only those types can ever get into the
2277 ;; output
2286 ;; (TEXT . POSITION)
2293 ;; (BEGIN . END)
2298 ;; (nil PROPERTY VALUE BEG . END)
2308 "Determine whether UNDO-ELT falls inside the region START ... END.
2309 If it crosses the edge, we return nil."
2314 t)
2316 nil)
2318 ;; (TEXT . POSITION)
2322 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2323 ;; See if MARKER is inside the region.
2334 ;; (nil PROPERTY VALUE BEG . END)
2339 ;; (BEGIN . END)
2344 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2345 This assumes we have already decided that UNDO-ELT
2346 is not *inside* the region START...END."
2349 ;; (nil PROPERTY VALUE BEG . END)
2354 ;; (BEGIN . END)
2358 ;; Return the first affected buffer position and the delta for an undo element
2359 ;; delta is defined as the change in subsequent buffer positions if we *did*
2360 ;; the undo.
2364 ;; (TEXT . POSITION)
2367 ;; (BEGIN . END)
2374 "If non-nil ask about discarding undo info for the current command.
2375 Normally, Emacs discards the undo info for the current command if
2376 it exceeds `undo-outer-limit'. But if you set this option
2377 non-nil, it asks in the echo area whether to discard the info.
2378 If you answer no, there is a slight risk that Emacs might crash, so
2379 only do it if you really want to undo the command.
2381 This option is mainly intended for debugging. You have to be
2382 careful if you use it for other purposes. Garbage collection is
2383 inhibited while the question is asked, meaning that Emacs might
2384 leak memory. So you should make sure that you do not wait
2385 excessively long before answering the question."
2391 "If non-nil, an extra level of size that's ok in an undo item.
2392 We don't ask the user about truncating the undo list until the
2393 current item gets bigger than this amount.
2398 ;; When the first undo batch in an undo list is longer than
2399 ;; undo-outer-limit, this function gets called to warn the user that
2400 ;; the undo info for the current command was discarded. Garbage
2401 ;; collection is inhibited around the call, so it had better not do a
2402 ;; lot of consing.
2408 ;; Don't ask the question again unless it gets even bigger.
2409 ;; This applies, in particular, if the user quits from the question.
2410 ;; Such a quit quits out of GC, but something else will call GC
2411 ;; again momentarily. It will call this function again,
2412 ;; but we don't want to ask the question again.
2419 t)
2420 nil))
2425 "The undo info was discarded because it exceeded \
2426 `undo-outer-limit'.
2428 This is normal if you executed a command that made a huge change
2429 to the buffer. In that case, to prevent similar problems in the
2430 future, set `undo-outer-limit' to a value that is large enough to
2431 cover the maximum size of normal changes you expect a single
2432 command to make, but not so large that it might exceed the
2433 maximum memory allotted to Emacs.
2435 If you did not execute any such command, the situation is
2436 probably due to a bug and you should report it.
2438 You can disable the popping up of this buffer by adding the entry
2439 \(undo discard-info) to the user option `warning-suppress-types',
2443 t))
2444 \f
2446 "History list for some commands that read shell commands.
2448 Maximum length of the history list is determined by the value
2455 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2456 This buffer is used when `shell-command' or `shell-command-on-region'
2457 is run interactively. A value of nil means that output to stderr and
2464 "Return a list of all commands associated with the current file.
2465 This function is used to add all related commands retrieved by `mailcap'
2466 to the end of the list of defaults just after the default value."
2470 minibuffer-default))
2475 commands))
2486 map)
2490 "Read a shell command from the minibuffer.
2491 The arguments are the same as the ones of `read-from-minibuffer',
2492 except READ and KEYMAP are missing and HIST defaults
2493 to `shell-command-history'."
2501 minibuffer-local-shell-command-map
2502 nil
2504 args)))
2507 "What to do when the output buffer is used by another shell command.
2508 This option specifies how to resolve the conflict where a new command
2509 wants to direct its output to the buffer `*Async Shell Command*',
2510 but this buffer is already taken by another running shell command.
2512 The value `confirm-kill-process' is used to ask for confirmation before
2513 killing the already running process and running a new process
2514 in the same buffer, `confirm-new-buffer' for confirmation before running
2515 the command in a new buffer with a name other than the default buffer name,
2516 `new-buffer' for doing the same without confirmation,
2517 `confirm-rename-buffer' for confirmation before renaming the existing
2518 output buffer and running a new command in the default buffer,
2519 `rename-buffer' for doing the same without confirmation."
2521 confirm-kill-process)
2523 confirm-new-buffer)
2525 new-buffer)
2527 confirm-rename-buffer)
2529 rename-buffer))
2534 "Execute string COMMAND asynchronously in background.
2536 Like `shell-command', but adds `&' at the end of COMMAND
2537 to execute it asynchronously.
2539 The output appears in the buffer `*Async Shell Command*'.
2540 That buffer is in shell mode.
2542 In Elisp, you will often be better served by calling `start-process'
2543 directly, since it offers more control and does not impose the use of a
2544 shell (with its need to quote arguments)."
2554 current-prefix-arg
2555 shell-command-default-error-buffer))
2561 "Execute string COMMAND in inferior shell; display output, if any.
2562 With prefix argument, insert the COMMAND's output at point.
2564 If COMMAND ends in `&', execute it asynchronously.
2565 The output appears in the buffer `*Async Shell Command*'.
2566 That buffer is in shell mode. You can also use
2567 `async-shell-command' that automatically adds `&'.
2569 Otherwise, COMMAND is executed synchronously. The output appears in
2570 the buffer `*Shell Command Output*'. If the output is short enough to
2571 display in the echo area (which is determined by the variables
2572 `resize-mini-windows' and `max-mini-window-height'), it is shown
2573 there, but it is nonetheless available in buffer `*Shell Command
2574 Output*' even though that buffer is not automatically displayed.
2576 To specify a coding system for converting non-ASCII characters
2578 before this command.
2580 Noninteractive callers can specify coding systems by binding
2581 `coding-system-for-read' and `coding-system-for-write'.
2583 The optional second argument OUTPUT-BUFFER, if non-nil,
2584 says to put the output in some other buffer.
2585 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2586 If OUTPUT-BUFFER is not a buffer and not nil,
2587 insert output in current buffer. (This cannot be done asynchronously.)
2588 In either case, the buffer is first erased, and the output is
2589 inserted after point (leaving mark after it).
2591 If the command terminates without error, but generates output,
2593 the output can be displayed in the echo area or in its buffer.
2594 If the output is short enough to display in the echo area
2595 \(determined by the variable `max-mini-window-height' if
2596 `resize-mini-windows' is non-nil), it is shown there.
2597 Otherwise,the buffer containing the output is displayed.
2601 of the output.
2603 If there is no output, or if output is inserted in the current buffer,
2604 then `*Shell Command Output*' is deleted.
2606 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2607 or buffer name to which to direct the command's standard error output.
2608 If it is nil, error output is mingled with regular output.
2609 In an interactive call, the variable `shell-command-default-error-buffer'
2610 specifies the value of ERROR-BUFFER.
2612 In Elisp, you will often be better served by calling `call-process' or
2613 `start-process' directly, since it offers more control and does not impose
2614 the use of a shell (with its need to quote arguments)."
2625 current-prefix-arg
2626 shell-command-default-error-buffer))
2627 ;; Look for a handler in case default-directory is a remote file name.
2635 ;; Output goes in current buffer.
2641 temporary-file-directory)))
2642 nil)))
2645 ;; We do not use -f for csh; we will not support broken use of
2646 ;; .cshrcs. Even the BSD csh manual says to use
2647 ;; "if ($?prompt) exit" before things which are not useful
2648 ;; non-interactively. Besides, if someone wants their other
2649 ;; aliases for shell commands then they can still have them.
2653 t)
2654 nil shell-command-switch command)
2661 ;; Do no formatting while reading error file,
2662 ;; because that can run a shell command, and we
2663 ;; don't want that to cause an infinite recursion.
2665 ;; Put point after the inserted errors.
2669 ;; This is like exchange-point-and-mark, but doesn't
2670 ;; activate the mark. It is cleaner to avoid activation,
2671 ;; even though the command loop would deactivate the mark
2672 ;; because we inserted text.
2676 ;; Output goes in a separate buffer.
2677 ;; Preserve the match data in case called from a program.
2680 ;; Command ending with ampersand means asynchronous.
2684 proc)
2685 ;; Remove the ampersand.
2687 ;; Ask the user what to do with already running process.
2692 ;; If will kill a process, query first.
2697 ;; If will create a new buffer, query first.
2703 ;; It will create a new buffer.
2707 ;; If will rename the buffer, query first.
2716 ;; It will rename the buffer.
2723 ;; Setting buffer-read-only to nil doesn't suffice
2724 ;; if some text has a non-nil read-only property,
2725 ;; which comint sometimes adds for prompts.
2731 shell-command-switch command))
2735 ;; Use the comint filter for proper handling of carriage motion
2736 ;; (see `comint-inhibit-carriage-motion'),.
2738 ))
2739 ;; Otherwise, command is executed synchronously.
2741 output-buffer nil error-buffer)))))))
2745 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2746 MESSAGE may be either a string or a buffer.
2748 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2749 the maximum height of the echo area, as defined by `max-mini-window-height'
2750 if `resize-mini-windows' is non-nil.
2752 Returns either the string shown in the echo area, or when a pop-up
2753 buffer is used, the window used to display it.
2755 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2756 name of the buffer used to display it in the case where a pop-up buffer
2757 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2758 string and it is displayed in the echo area, it is not specified whether
2759 the contents are inserted into the buffer anyway.
2761 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2762 and only used if a buffer is displayed."
2764 ;; Trivial case where we can use the echo area
2768 ;; Trivial case where we can just remove single trailing newline
2771 ;; General case
2774 message
2783 0
2787 (<= lines
2791 max-mini-window-height))
2793 max-mini-window-height)
2797 ;; Don't use the echo area if the output buffer is
2798 ;; already displayed in the selected frame.
2800 ;; Echo area
2806 ;; Buffer
2809 not-this-window frame))))))))
2812 ;; We have a sentinel to prevent insertion of a termination message
2813 ;; in the buffer itself.
2821 &optional output-buffer replace
2822 error-buffer display-error-buffer)
2823 "Execute string COMMAND in inferior shell with region as input.
2824 Normally display output (if any) in temp buffer `*Shell Command Output*';
2825 Prefix arg means replace the region with it. Return the exit code of
2826 COMMAND.
2828 To specify a coding system for converting non-ASCII characters
2830 before this command. By default, the input (from the current buffer)
2831 is encoded using coding-system specified by `process-coding-system-alist',
2832 falling back to `default-process-coding-system' if no match for COMMAND
2833 is found in `process-coding-system-alist'.
2835 Noninteractive callers can specify coding systems by binding
2836 `coding-system-for-read' and `coding-system-for-write'.
2838 If the command generates output, the output may be displayed
2839 in the echo area or in a buffer.
2840 If the output is short enough to display in the echo area
2841 \(determined by the variable `max-mini-window-height' if
2842 `resize-mini-windows' is non-nil), it is shown there.
2843 Otherwise it is displayed in the buffer `*Shell Command Output*'.
2844 The output is available in that buffer in both cases.
2846 If there is output and an error, a message about the error
2847 appears at the end of the output. If there is no output, or if
2848 output is inserted in the current buffer, the buffer `*Shell
2849 Command Output*' is deleted.
2851 Optional fourth arg OUTPUT-BUFFER specifies where to put the
2852 command's output. If the value is a buffer or buffer name,
2853 put the output there. If the value is nil, use the buffer
2854 `*Shell Command Output*'. Any other value, excluding nil,
2855 means to insert the output in the current buffer. In either case,
2856 the output is inserted after point (leaving mark after it).
2858 Optional fifth arg REPLACE, if non-nil, means to insert the
2859 output in place of text from START to END, putting point and mark
2860 around it.
2862 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
2863 or buffer name to which to direct the command's standard error
2864 output. If nil, error output is mingled with regular output.
2865 When called interactively, `shell-command-default-error-buffer'
2866 is used for ERROR-BUFFER.
2868 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
2869 display the error buffer if there were any errors. When called
2870 interactively, this is t."
2874 ;; Do this before calling region-beginning
2875 ;; and region-end, in case subprocess output
2876 ;; relocates them while we are in the minibuffer.
2878 ;; call-interactively recognizes region-beginning and
2879 ;; region-end specially, leaving them in the history.
2881 string
2882 current-prefix-arg
2883 current-prefix-arg
2884 shell-command-default-error-buffer
2885 t)))
2891 temporary-file-directory)))
2892 nil))
2893 exit-status)
2897 ;; Replace specified region with output from command.
2899 ;; Don't muck with mark unless REPLACE says we should.
2906 t)
2907 nil shell-command-switch command))
2908 ;; It is rude to delete a buffer which the command is not using.
2909 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2910 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2911 ;; (kill-buffer shell-buffer)))
2912 ;; Don't muck with mark unless REPLACE says we should.
2914 ;; No prefix argument: put the output in a temp buffer,
2915 ;; replacing its entire contents.
2920 ;; If the input is the same buffer as the output,
2921 ;; delete everything but the specified region,
2922 ;; then replace that region with the output.
2928 shell-file-name t
2931 t)
2932 nil shell-command-switch
2933 command)))
2934 ;; Clear the output buffer, then run the command with
2935 ;; output there.
2946 buffer)
2947 nil shell-command-switch command)))
2948 ;; Report the output.
2958 ;; There's some output, display it
2960 ;; No output; error?
2967 shell-command-default-error-buffer)
2974 output))
2977 exit-status))
2980 exit-status output))))
2981 ;; Don't kill: there might be useful info in the undo-log.
2982 ;; (kill-buffer buffer)
2983 ))))
2991 ;; Do no formatting while reading error file,
2992 ;; because that can run a shell command, and we
2993 ;; don't want that to cause an infinite recursion.
2995 ;; Put point after the inserted errors.
3000 exit-status))
3003 "Execute shell command COMMAND and return its output as a string."
3006 standard-output
3010 "Process files synchronously in a separate process.
3011 Similar to `call-process', but may invoke a file handler based on
3012 `default-directory'. The current working directory of the
3013 subprocess is `default-directory'.
3015 File names in INFILE and BUFFER are handled normally, but file
3016 names in ARGS should be relative to `default-directory', as they
3017 are passed to the process verbatim. \(This is a difference to
3018 `call-process' which does not support file handlers for INFILE
3019 and BUFFER.\)
3021 Some file handlers might not support all variants, for example
3022 they might behave as if DISPLAY was nil, regardless of the actual
3023 value passed."
3025 lc stderr-file)
3035 display args)
3041 "Whether a call of `process-file' changes remote files.
3043 By default, this variable is always set to `t', meaning that a
3044 call of `process-file' could potentially change any file on a
3045 remote host. When set to `nil', a file handler could optimize
3046 its behavior with respect to remote file attribute caching.
3048 You should only ever change this variable with a let-binding;
3052 "Start a program in a subprocess. Return the process object for it.
3054 Similar to `start-process', but may invoke a file handler based on
3055 `default-directory'. See Info node `(elisp)Magic File Names'.
3057 This handler ought to run PROGRAM, perhaps on the local host,
3058 perhaps on a remote host that corresponds to `default-directory'.
3059 In the latter case, the local part of `default-directory' becomes
3060 the working directory of the process.
3062 PROGRAM and PROGRAM-ARGS might be file names. They are not
3063 objects of file handler invocation. File handlers might not
3064 support pty association, if PROGRAM is nil."
3068 \f
3069 ;;;; Process menu
3081 "Major mode for listing the processes called by Emacs."
3093 "Recompute the list of processes for the Process List buffer.
3094 Also, delete any process that is exited or signaled."
3107 face link
3110 follow-link t
3111 process-buffer ,buf
3112 action process-menu-visit-buffer)
3121 "datagram"
3138 tabulated-list-entries))))))
3144 "Display a list of all processes that are Emacs sub-processes.
3145 If optional argument QUERY-ONLY is non-nil, only processes with
3146 the query-on-exit flag set are listed.
3147 Any process listed as exited or signaled is actually eliminated
3148 after the listing is made.
3149 Optional argument BUFFER specifies a buffer to use, instead of
3151 The return value is always nil.
3153 This function lists only processes that were launched by Emacs. To
3154 see other processes running on the system, use `list-system-processes'."
3166 nil)
3167 \f
3171 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
3172 (define-key map [switch-frame] nil)
3173 (define-key map [?\C-u] 'universal-argument-more)
3174 (define-key map [?-] 'universal-argument-minus)
3175 (define-key map [?0] 'digit-argument)
3176 (define-key map [?1] 'digit-argument)
3177 (define-key map [?2] 'digit-argument)
3178 (define-key map [?3] 'digit-argument)
3179 (define-key map [?4] 'digit-argument)
3180 (define-key map [?5] 'digit-argument)
3181 (define-key map [?6] 'digit-argument)
3182 (define-key map [?7] 'digit-argument)
3183 (define-key map [?8] 'digit-argument)
3184 (define-key map [?9] 'digit-argument)
3185 (define-key map [kp-0] 'digit-argument)
3186 (define-key map [kp-1] 'digit-argument)
3187 (define-key map [kp-2] 'digit-argument)
3188 (define-key map [kp-3] 'digit-argument)
3189 (define-key map [kp-4] 'digit-argument)
3190 (define-key map [kp-5] 'digit-argument)
3191 (define-key map [kp-6] 'digit-argument)
3192 (define-key map [kp-7] 'digit-argument)
3193 (define-key map [kp-8] 'digit-argument)
3194 (define-key map [kp-9] 'digit-argument)
3195 (define-key map [kp-subtract] 'universal-argument-minus)
3196 map)
3199 (defvar universal-argument-num-events nil
3200 "Number of argument-specifying events read by `universal-argument'.
3201 `universal-argument-other-key' uses this to discard those events
3202 from (this-command-keys), and reread only the final command.")
3204 (defvar saved-overriding-map t
3205 "The saved value of `overriding-terminal-local-map'.
3209 (defun save&set-overriding-map (map)
3210 "Set `overriding-terminal-local-map' to MAP."
3211 (when (eq saved-overriding-map t)
3212 (setq saved-overriding-map overriding-terminal-local-map)
3213 (setq overriding-terminal-local-map map)))
3215 (defun restore-overriding-map ()
3216 "Restore `overriding-terminal-local-map' to its saved value."
3217 (setq overriding-terminal-local-map saved-overriding-map)
3218 (setq saved-overriding-map t))
3220 (defun universal-argument ()
3221 "Begin a numeric argument for the following command.
3226 multiplies the argument by 4 each time.
3228 which is different in effect from any particular numeric argument.
3230 (interactive)
3231 (setq prefix-arg (list 4))
3232 (setq universal-argument-num-events (length (this-command-keys)))
3233 (save&set-overriding-map universal-argument-map))
3235 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3236 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3237 (defun universal-argument-more (arg)
3238 (interactive "P")
3239 (if (consp arg)
3240 (setq prefix-arg (list (* 4 (car arg))))
3241 (if (eq arg '-)
3242 (setq prefix-arg (list -4))
3243 (setq prefix-arg arg)
3244 (restore-overriding-map)))
3245 (setq universal-argument-num-events (length (this-command-keys))))
3247 (defun negative-argument (arg)
3248 "Begin a negative numeric argument for the next command.
3250 (interactive "P")
3251 (cond ((integerp arg)
3252 (setq prefix-arg (- arg)))
3253 ((eq arg '-)
3254 (setq prefix-arg nil))
3255 (t
3256 (setq prefix-arg '-)))
3257 (setq universal-argument-num-events (length (this-command-keys)))
3258 (save&set-overriding-map universal-argument-map))
3260 (defun digit-argument (arg)
3261 "Part of the numeric argument for the next command.
3263 (interactive "P")
3264 (let* ((char (if (integerp last-command-event)
3265 last-command-event
3266 (get last-command-event 'ascii-character)))
3268 (cond ((integerp arg)
3269 (setq prefix-arg (+ (* arg 10)
3270 (if (< arg 0) (- digit) digit))))
3271 ((eq arg '-)
3272 ;; Treat -0 as just -, so that -01 will work.
3273 (setq prefix-arg (if (zerop digit) '- (- digit))))
3274 (t
3275 (setq prefix-arg digit))))
3276 (setq universal-argument-num-events (length (this-command-keys)))
3277 (save&set-overriding-map universal-argument-map))
3279 ;; For backward compatibility, minus with no modifiers is an ordinary
3280 ;; command if digits have already been entered.
3281 (defun universal-argument-minus (arg)
3282 (interactive "P")
3283 (if (integerp arg)
3284 (universal-argument-other-key arg)
3285 (negative-argument arg)))
3287 ;; Anything else terminates the argument and is left in the queue to be
3288 ;; executed as a command.
3289 (defun universal-argument-other-key (arg)
3290 (interactive "P")
3291 (setq prefix-arg arg)
3292 (let* ((key (this-command-keys))
3293 (keylist (listify-key-sequence key)))
3294 (setq unread-command-events
3295 (append (nthcdr universal-argument-num-events keylist)
3296 unread-command-events)))
3297 (reset-this-command-lengths)
3298 (restore-overriding-map))
3299 \f
3301 (defvar filter-buffer-substring-functions nil
3302 "This variable is a wrapper hook around `filter-buffer-substring'.")
3303 (make-obsolete-variable 'filter-buffer-substring-functions
3304 'filter-buffer-substring-function "24.4")
3306 (defvar filter-buffer-substring-function #'buffer-substring--filter
3307 "Function to perform the filtering in `filter-buffer-substring'.
3308 The function is called with 3 arguments:
3309 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
3310 as those of `filter-buffer-substring' in each case.
3311 It should return the buffer substring between BEG and END, after filtering.")
3313 (defvar buffer-substring-filters nil
3314 "List of filter functions for `filter-buffer-substring'.
3315 Each function must accept a single argument, a string, and return
3316 a string. The buffer substring is passed to the first function
3317 in the list, and the return value of each function is passed to
3318 the next.
3319 As a special convention, point is set to the start of the buffer text
3320 being operated on (i.e., the first argument of `filter-buffer-substring')
3321 before these functions are called.")
3322 (make-obsolete-variable 'buffer-substring-filters
3323 'filter-buffer-substring-function "24.1")
3325 (defun filter-buffer-substring (beg end &optional delete)
3326 "Return the buffer substring between BEG and END, after filtering.
3327 The hook `filter-buffer-substring-function' performs the actual filtering.
3328 By default, no filtering is done.
3330 If DELETE is non-nil, the text between BEG and END is deleted
3331 from the buffer.
3333 This function should be used instead of `buffer-substring',
3334 `buffer-substring-no-properties', or `delete-and-extract-region'
3335 when you want to allow filtering to take place. For example,
3336 major or minor modes can use `filter-buffer-substring-function' to
3337 extract characters that are special to a buffer, and should not
3338 be copied into other buffers."
3339 (funcall filter-buffer-substring-function beg end delete))
3341 ;; FIXME: `with-wrapper-hook' is obsolete
3342 (defun buffer-substring--filter (beg end &optional delete)
3343 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
3344 (cond
3345 ((or delete buffer-substring-filters)
3346 (save-excursion
3347 (goto-char beg)
3348 (let ((string (if delete (delete-and-extract-region beg end)
3349 (buffer-substring beg end))))
3350 (dolist (filter buffer-substring-filters)
3351 (setq string (funcall filter string)))
3352 string)))
3353 (t
3354 (buffer-substring beg end)))))
3357 ;;;; Window system cut and paste hooks.
3359 (defvar interprogram-cut-function nil
3360 "Function to call to make a killed region available to other programs.
3361 Most window systems provide a facility for cutting and pasting
3362 text between different programs, such as the clipboard on X and
3363 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3365 This variable holds a function that Emacs calls whenever text is
3366 put in the kill ring, to make the new kill available to other
3367 programs. The function takes one argument, TEXT, which is a
3368 string containing the text which should be made available.")
3370 (defvar interprogram-paste-function nil
3371 "Function to call to get text cut from other programs.
3372 Most window systems provide a facility for cutting and pasting
3373 text between different programs, such as the clipboard on X and
3374 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3376 This variable holds a function that Emacs calls to obtain text
3377 that other programs have provided for pasting. The function is
3378 called with no arguments. If no other program has provided text
3379 to paste, the function should return nil (in which case the
3380 caller, usually `current-kill', should use the top of the Emacs
3381 kill ring). If another program has provided text to paste, the
3382 function should return that text as a string (in which case the
3383 caller should put this string in the kill ring as the latest
3384 kill).
3386 The function may also return a list of strings if the window
3387 system supports multiple selections. The first string will be
3388 used as the pasted text, but the other will be placed in the kill
3389 ring for easy access via `yank-pop'.
3391 Note that the function should return a string only if a program
3392 other than Emacs has provided a string for pasting; if Emacs
3393 provided the most recent string, the function should return nil.
3394 If it is difficult to tell whether Emacs or some other program
3395 provided the current string, it is probably good enough to return
3396 nil if the string is equal (according to `string=') to the last
3397 text Emacs provided.")
3398 \f
3401 ;;;; The kill ring data structure.
3403 (defvar kill-ring nil
3404 "List of killed text sequences.
3405 Since the kill ring is supposed to interact nicely with cut-and-paste
3406 facilities offered by window systems, use of this variable should
3407 interact nicely with `interprogram-cut-function' and
3408 `interprogram-paste-function'. The functions `kill-new',
3409 `kill-append', and `current-kill' are supposed to implement this
3410 interaction; you may want to use them instead of manipulating the kill
3411 ring directly.")
3413 (defcustom kill-ring-max 60
3414 "Maximum length of kill ring before oldest elements are thrown away."
3415 :type 'integer
3416 :group 'killing)
3418 (defvar kill-ring-yank-pointer nil
3419 "The tail of the kill ring whose car is the last thing yanked.")
3421 (defcustom save-interprogram-paste-before-kill nil
3422 "Save clipboard strings into kill ring before replacing them.
3423 When one selects something in another program to paste it into Emacs,
3424 but kills something in Emacs before actually pasting it,
3425 this selection is gone unless this variable is non-nil,
3426 in which case the other program's selection is saved in the `kill-ring'
3428 :type 'boolean
3429 :group 'killing
3430 :version "23.2")
3432 (defcustom kill-do-not-save-duplicates nil
3433 "Do not add a new string to `kill-ring' if it duplicates the last one.
3434 The comparison is done using `equal-including-properties'."
3435 :type 'boolean
3436 :group 'killing
3437 :version "23.2")
3439 (defun kill-new (string &optional replace yank-handler)
3440 "Make STRING the latest kill in the kill ring.
3441 Set `kill-ring-yank-pointer' to point to it.
3442 If `interprogram-cut-function' is non-nil, apply it to STRING.
3443 Optional second argument REPLACE non-nil means that STRING will replace
3444 the front of the kill ring, rather than being added to the list.
3446 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3447 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3448 STRING.
3450 When the yank handler has a non-nil PARAM element, the original STRING
3451 argument is not used by `insert-for-yank'. However, since Lisp code
3452 may access and use elements from the kill ring directly, the STRING
3454 (if (> (length string) 0)
3455 (if yank-handler
3456 (put-text-property 0 (length string)
3457 'yank-handler yank-handler string))
3458 (if yank-handler
3459 (signal 'args-out-of-range
3460 (list string "yank-handler specified for empty string"))))
3461 (unless (and kill-do-not-save-duplicates
3462 ;; Due to text properties such as 'yank-handler that
3463 ;; can alter the contents to yank, comparison using
3464 ;; `equal' is unsafe.
3465 (equal-including-properties string (car kill-ring)))
3466 (if (fboundp 'menu-bar-update-yank-menu)
3467 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3468 (when save-interprogram-paste-before-kill
3469 (let ((interprogram-paste (and interprogram-paste-function
3470 (funcall interprogram-paste-function))))
3471 (when interprogram-paste
3472 (dolist (s (if (listp interprogram-paste)
3473 (nreverse interprogram-paste)
3474 (list interprogram-paste)))
3475 (unless (and kill-do-not-save-duplicates
3476 (equal-including-properties s (car kill-ring)))
3477 (push s kill-ring))))))
3478 (unless (and kill-do-not-save-duplicates
3479 (equal-including-properties string (car kill-ring)))
3480 (if (and replace kill-ring)
3481 (setcar kill-ring string)
3482 (push string kill-ring)
3483 (if (> (length kill-ring) kill-ring-max)
3484 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3485 (setq kill-ring-yank-pointer kill-ring)
3486 (if interprogram-cut-function
3487 (funcall interprogram-cut-function string)))
3488 (set-advertised-calling-convention
3489 'kill-new '(string &optional replace) "23.3")
3491 (defun kill-append (string before-p &optional yank-handler)
3492 "Append STRING to the end of the latest kill in the kill ring.
3493 If BEFORE-P is non-nil, prepend STRING to the kill.
3494 If `interprogram-cut-function' is set, pass the resulting kill to it."
3495 (let* ((cur (car kill-ring)))
3496 (kill-new (if before-p (concat string cur) (concat cur string))
3497 (or (= (length cur) 0)
3498 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3499 yank-handler)))
3500 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3502 (defcustom yank-pop-change-selection nil
3503 "Whether rotating the kill ring changes the window system selection.
3504 If non-nil, whenever the kill ring is rotated (usually via the
3505 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3506 to copy the new kill to the window system selection."
3507 :type 'boolean
3508 :group 'killing
3509 :version "23.1")
3511 (defun current-kill (n &optional do-not-move)
3512 "Rotate the yanking point by N places, and then return that kill.
3513 If N is zero and `interprogram-paste-function' is set to a
3514 function that returns a string or a list of strings, and if that
3515 function doesn't return nil, then that string (or list) is added
3516 to the front of the kill ring and the string (or first string in
3517 the list) is returned as the latest kill.
3519 If N is not zero, and if `yank-pop-change-selection' is
3520 non-nil, use `interprogram-cut-function' to transfer the
3521 kill at the new yank point into the window system selection.
3523 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3524 move the yanking point; just return the Nth kill forward."
3526 (let ((interprogram-paste (and (= n 0)
3527 interprogram-paste-function
3528 (funcall interprogram-paste-function))))
3529 (if interprogram-paste
3530 (progn
3531 ;; Disable the interprogram cut function when we add the new
3532 ;; text to the kill ring, so Emacs doesn't try to own the
3533 ;; selection, with identical text.
3534 (let ((interprogram-cut-function nil))
3535 (if (listp interprogram-paste)
3536 (mapc 'kill-new (nreverse interprogram-paste))
3537 (kill-new interprogram-paste)))
3538 (car kill-ring))
3539 (or kill-ring (error "Kill ring is empty"))
3540 (let ((ARGth-kill-element
3541 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3542 (length kill-ring))
3543 kill-ring)))
3544 (unless do-not-move
3545 (setq kill-ring-yank-pointer ARGth-kill-element)
3546 (when (and yank-pop-change-selection
3547 (> n 0)
3548 interprogram-cut-function)
3549 (funcall interprogram-cut-function (car ARGth-kill-element))))
3550 (car ARGth-kill-element)))))
3554 ;;;; Commands for manipulating the kill ring.
3556 (defcustom kill-read-only-ok nil
3557 "Non-nil means don't signal an error for killing read-only text."
3558 :type 'boolean
3559 :group 'killing)
3561 (defun kill-region (beg end &optional yank-handler)
3563 This deletes the text from the buffer and saves it in the kill ring.
3567 If you want to append the killed region to the last killed text,
3570 If the buffer is read-only, Emacs will beep and refrain from deleting
3571 the text, but put the text in the kill ring anyway. This means that
3572 you can use the killing commands to copy text from a read-only buffer.
3574 Lisp programs should use this function for killing text.
3575 (To delete text, use `delete-region'.)
3576 Supply two arguments, character positions indicating the stretch of text
3577 to be killed.
3579 If the previous command was also a kill command,
3580 the text killed this time appends to the text killed last time
3581 to make one entry in the kill ring."
3582 ;; Pass point first, then mark, because the order matters
3583 ;; when calling kill-append.
3584 (interactive (list (point) (mark)))
3585 (unless (and beg end)
3586 (error "The mark is not set now, so there is no region"))
3587 (condition-case nil
3588 (let ((string (filter-buffer-substring beg end t)))
3589 (when string ;STRING is nil if BEG = END
3590 ;; Add that string to the kill ring, one way or another.
3591 (if (eq last-command 'kill-region)
3592 (kill-append string (< end beg) yank-handler)
3593 (kill-new string nil yank-handler)))
3594 (when (or string (eq last-command 'kill-region))
3595 (setq this-command 'kill-region))
3596 (setq deactivate-mark t)
3597 nil)
3598 ((buffer-read-only text-read-only)
3599 ;; The code above failed because the buffer, or some of the characters
3600 ;; in the region, are read-only.
3601 ;; We should beep, in case the user just isn't aware of this.
3602 ;; However, there's no harm in putting
3603 ;; the region's text in the kill ring, anyway.
3604 (copy-region-as-kill beg end)
3605 ;; Set this-command now, so it will be set even if we get an error.
3606 (setq this-command 'kill-region)
3607 ;; This should barf, if appropriate, and give us the correct error.
3608 (if kill-read-only-ok
3609 (progn (message "Read only text copied to kill ring") nil)
3610 ;; Signal an error if the buffer is read-only.
3611 (barf-if-buffer-read-only)
3612 ;; If the buffer isn't read-only, the text is.
3613 (signal 'text-read-only (list (current-buffer)))))))
3614 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3616 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3617 ;; to get two copies of the text when the user accidentally types M-w and
3618 ;; then corrects it with the intended C-w.
3619 (defun copy-region-as-kill (beg end)
3620 "Save the region as if killed, but don't kill it.
3621 In Transient Mark mode, deactivate the mark.
3622 If `interprogram-cut-function' is non-nil, also save the text for a window
3623 system cut and paste.
3625 This command's old key binding has been given to `kill-ring-save'."
3626 (interactive "r")
3627 (if (eq last-command 'kill-region)
3628 (kill-append (filter-buffer-substring beg end) (< end beg))
3629 (kill-new (filter-buffer-substring beg end)))
3630 (setq deactivate-mark t)
3631 nil)
3633 (defun kill-ring-save (beg end)
3634 "Save the region as if killed, but don't kill it.
3635 In Transient Mark mode, deactivate the mark.
3636 If `interprogram-cut-function' is non-nil, also save the text for a window
3637 system cut and paste.
3639 If you want to append the killed line to the last killed text,
3642 This command is similar to `copy-region-as-kill', except that it gives
3643 visual feedback indicating the extent of the region being copied."
3644 (interactive "r")
3645 (copy-region-as-kill beg end)
3646 ;; This use of called-interactively-p is correct because the code it
3647 ;; controls just gives the user visual feedback.
3648 (if (called-interactively-p 'interactive)
3649 (indicate-copied-region)))
3651 (defun indicate-copied-region (&optional message-len)
3652 "Indicate that the region text has been copied interactively.
3653 If the mark is visible in the selected window, blink the cursor
3654 between point and mark if there is currently no active region
3655 highlighting.
3657 If the mark lies outside the selected window, display an
3658 informative message containing a sample of the copied text. The
3659 optional argument MESSAGE-LEN, if non-nil, specifies the length
3660 of this sample text; it defaults to 40."
3661 (let ((mark (mark t))
3662 (point (point))
3663 ;; Inhibit quitting so we can make a quit here
3664 ;; look like a C-g typed as a command.
3665 (inhibit-quit t))
3666 (if (pos-visible-in-window-p mark (selected-window))
3667 ;; Swap point-and-mark quickly so as to show the region that
3668 ;; was selected. Don't do it if the region is highlighted.
3669 (unless (and (region-active-p)
3670 (face-background 'region))
3671 ;; Swap point and mark.
3672 (set-marker (mark-marker) (point) (current-buffer))
3673 (goto-char mark)
3674 (sit-for blink-matching-delay)
3675 ;; Swap back.
3676 (set-marker (mark-marker) mark (current-buffer))
3677 (goto-char point)
3678 ;; If user quit, deactivate the mark
3679 ;; as C-g would as a command.
3680 (and quit-flag mark-active
3681 (deactivate-mark)))
3682 (let ((len (min (abs (- mark point))
3683 (or message-len 40))))
3684 (if (< point mark)
3685 ;; Don't say "killed"; that is misleading.
3687 (buffer-substring-no-properties (- mark len) mark))
3689 (buffer-substring-no-properties mark (+ mark len))))))))
3691 (defun append-next-kill (&optional interactive)
3692 "Cause following command, if it kills, to append to previous kill.
3693 The argument is used for internal purposes; do not supply one."
3694 (interactive "p")
3695 ;; We don't use (interactive-p), since that breaks kbd macros.
3696 (if interactive
3697 (progn
3698 (setq this-command 'kill-region)
3699 (message "If the next command is a kill, it will append"))
3700 (setq last-command 'kill-region)))
3701 \f
3702 ;; Yanking.
3704 (defcustom yank-handled-properties
3705 '((font-lock-face . yank-handle-font-lock-face-property)
3706 (category . yank-handle-category-property))
3707 "List of special text property handling conditions for yanking.
3708 Each element should have the form (PROP . FUN), where PROP is a
3709 property symbol and FUN is a function. When the `yank' command
3710 inserts text into the buffer, it scans the inserted text for
3711 stretches of text that have `eq' values of the text property
3712 PROP; for each such stretch of text, FUN is called with three
3713 arguments: the property's value in that text, and the start and
3714 end positions of the text.
3716 This is done prior to removing the properties specified by
3717 `yank-excluded-properties'."
3718 :group 'killing
3719 :version "24.3")
3721 ;; This is actually used in subr.el but defcustom does not work there.
3722 (defcustom yank-excluded-properties
3723 '(category field follow-link fontified font-lock-face help-echo
3724 intangible invisible keymap local-map mouse-face read-only
3725 yank-handler)
3726 "Text properties to discard when yanking.
3727 The value should be a list of text properties to discard or t,
3728 which means to discard all text properties.
3730 See also `yank-handled-properties'."
3731 :type '(choice (const :tag "All" t) (repeat symbol))
3732 :group 'killing
3733 :version "24.3")
3735 (defvar yank-window-start nil)
3736 (defvar yank-undo-function nil
3737 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3738 Function is called with two parameters, START and END corresponding to
3739 the value of the mark and point; it is guaranteed that START <= END.
3740 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3742 (defun yank-pop (&optional arg)
3743 "Replace just-yanked stretch of killed text with a different stretch.
3744 This command is allowed only immediately after a `yank' or a `yank-pop'.
3745 At such a time, the region contains a stretch of reinserted
3746 previously-killed text. `yank-pop' deletes that text and inserts in its
3747 place a different stretch of killed text.
3749 With no argument, the previous kill is inserted.
3750 With argument N, insert the Nth previous kill.
3751 If N is negative, this is a more recent kill.
3753 The sequence of kills wraps around, so that after the oldest one
3754 comes the newest one.
3756 When this command inserts killed text into the buffer, it honors
3757 `yank-excluded-properties' and `yank-handler' as described in the
3758 doc string for `insert-for-yank-1', which see."
3759 (interactive "*p")
3760 (if (not (eq last-command 'yank))
3761 (error "Previous command was not a yank"))
3762 (setq this-command 'yank)
3763 (unless arg (setq arg 1))
3764 (let ((inhibit-read-only t)
3765 (before (< (point) (mark t))))
3766 (if before
3767 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3768 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3769 (setq yank-undo-function nil)
3770 (set-marker (mark-marker) (point) (current-buffer))
3771 (insert-for-yank (current-kill arg))
3772 ;; Set the window start back where it was in the yank command,
3773 ;; if possible.
3774 (set-window-start (selected-window) yank-window-start t)
3775 (if before
3776 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3777 ;; It is cleaner to avoid activation, even though the command
3778 ;; loop would deactivate the mark because we inserted text.
3779 (goto-char (prog1 (mark t)
3780 (set-marker (mark-marker) (point) (current-buffer))))))
3781 nil)
3783 (defun yank (&optional arg)
3785 More precisely, reinsert the most recent kill, which is the
3786 stretch of killed text most recently killed OR yanked. Put point
3787 at the end, and set mark at the beginning without activating it.
3789 With argument N, reinsert the Nth most recent kill.
3791 When this command inserts text into the buffer, it honors the
3792 `yank-handled-properties' and `yank-excluded-properties'
3793 variables, and the `yank-handler' text property. See
3794 `insert-for-yank-1' for details.
3797 (interactive "*P")
3798 (setq yank-window-start (window-start))
3799 ;; If we don't get all the way thru, make last-command indicate that
3800 ;; for the following command.
3801 (setq this-command t)
3802 (push-mark (point))
3803 (insert-for-yank (current-kill (cond
3804 ((listp arg) 0)
3805 ((eq arg '-) -2)
3806 (t (1- arg)))))
3807 (if (consp arg)
3808 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3809 ;; It is cleaner to avoid activation, even though the command
3810 ;; loop would deactivate the mark because we inserted text.
3811 (goto-char (prog1 (mark t)
3812 (set-marker (mark-marker) (point) (current-buffer)))))
3813 ;; If we do get all the way thru, make this-command indicate that.
3814 (if (eq this-command t)
3815 (setq this-command 'yank))
3816 nil)
3818 (defun rotate-yank-pointer (arg)
3819 "Rotate the yanking point in the kill ring.
3820 With ARG, rotate that many kills forward (or backward, if negative)."
3821 (interactive "p")
3822 (current-kill arg))
3823 \f
3824 ;; Some kill commands.
3826 ;; Internal subroutine of delete-char
3827 (defun kill-forward-chars (arg)
3828 (if (listp arg) (setq arg (car arg)))
3829 (if (eq arg '-) (setq arg -1))
3830 (kill-region (point) (+ (point) arg)))
3832 ;; Internal subroutine of backward-delete-char
3833 (defun kill-backward-chars (arg)
3834 (if (listp arg) (setq arg (car arg)))
3835 (if (eq arg '-) (setq arg -1))
3836 (kill-region (point) (- (point) arg)))
3838 (defcustom backward-delete-char-untabify-method 'untabify
3839 "The method for untabifying when deleting backward.
3840 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3841 `hungry' -- delete all whitespace, both tabs and spaces;
3842 `all' -- delete all whitespace, including tabs, spaces and newlines;
3843 nil -- just delete one character."
3844 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3845 :version "20.3"
3846 :group 'killing)
3848 (defun backward-delete-char-untabify (arg &optional killp)
3849 "Delete characters backward, changing tabs into spaces.
3850 The exact behavior depends on `backward-delete-char-untabify-method'.
3851 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3852 Interactively, ARG is the prefix arg (default 1)
3853 and KILLP is t if a prefix arg was specified."
3855 (when (eq backward-delete-char-untabify-method 'untabify)
3856 (let ((count arg))
3857 (save-excursion
3858 (while (and (> count 0) (not (bobp)))
3860 (let ((col (current-column)))
3861 (forward-char -1)
3862 (setq col (- col (current-column)))
3863 (insert-char ?\s col)
3864 (delete-char 1)))
3865 (forward-char -1)
3866 (setq count (1- count))))))
3868 ((eq backward-delete-char-untabify-method 'all)
3870 (n (if skip
3871 (let* ((oldpt (point))
3872 (wh (- oldpt (save-excursion
3873 (skip-chars-backward skip)
3874 (constrain-to-field nil oldpt)))))
3875 (+ arg (if (zerop wh) 0 (1- wh))))
3876 arg)))
3877 ;; Avoid warning about delete-backward-char
3878 (with-no-warnings (delete-backward-char n killp))))
3880 (defun zap-to-char (arg char)
3881 "Kill up to and including ARGth occurrence of CHAR.
3882 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3883 Goes backward if ARG is negative; error if CHAR not found."
3884 (interactive (list (prefix-numeric-value current-prefix-arg)
3885 (read-char "Zap to char: " t)))
3886 ;; Avoid "obsolete" warnings for translation-table-for-input.
3887 (with-no-warnings
3888 (if (char-table-p translation-table-for-input)
3889 (setq char (or (aref translation-table-for-input char) char))))
3890 (kill-region (point) (progn
3891 (search-forward (char-to-string char) nil nil arg)
3892 (point))))
3894 ;; kill-line and its subroutines.
3896 (defcustom kill-whole-line nil
3897 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
3898 :type 'boolean
3899 :group 'killing)
3901 (defun kill-line (&optional arg)
3902 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3903 With prefix argument ARG, kill that many lines from point.
3904 Negative arguments kill lines backward.
3905 With zero argument, kills the text before point on the current line.
3908 a number counts as a prefix arg.
3910 To kill a whole line, when point is not at the beginning, type \
3913 If `show-trailing-whitespace' is non-nil, this command will just
3914 kill the rest of the current line, even if there are only
3915 nonblanks there.
3917 If option `kill-whole-line' is non-nil, then this command kills the whole line
3918 including its terminating newline, when used at the beginning of a line
3919 with no argument. As a consequence, you can always kill a whole line
3922 If you want to append the killed line to the last killed text,
3925 If the buffer is read-only, Emacs will beep and refrain from deleting
3926 the line, but put the line in the kill ring anyway. This means that
3927 you can use this command to copy text from a read-only buffer.
3928 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3929 even beep.)"
3930 (interactive "P")
3931 (kill-region (point)
3932 ;; It is better to move point to the other end of the kill
3933 ;; before killing. That way, in a read-only buffer, point
3934 ;; moves across the text that is copied to the kill ring.
3935 ;; The choice has no effect on undo now that undo records
3936 ;; the value of point from before the command was run.
3937 (progn
3938 (if arg
3939 (forward-visible-line (prefix-numeric-value arg))
3940 (if (eobp)
3941 (signal 'end-of-buffer nil))
3942 (let ((end
3943 (save-excursion
3944 (end-of-visible-line) (point))))
3945 (if (or (save-excursion
3946 ;; If trailing whitespace is visible,
3947 ;; don't treat it as nothing.
3948 (unless show-trailing-whitespace
3950 (= (point) end))
3951 (and kill-whole-line (bolp)))
3952 (forward-visible-line 1)
3953 (goto-char end))))
3954 (point))))
3956 (defun kill-whole-line (&optional arg)
3957 "Kill current line.
3958 With prefix ARG, kill that many lines starting from the current line.
3959 If ARG is negative, kill backward. Also kill the preceding newline.
3961 If ARG is zero, kill current line but exclude the trailing newline."
3962 (interactive "p")
3963 (or arg (setq arg 1))
3964 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3965 (signal 'end-of-buffer nil))
3966 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3967 (signal 'beginning-of-buffer nil))
3968 (unless (eq last-command 'kill-region)
3969 (kill-new "")
3970 (setq last-command 'kill-region))
3971 (cond ((zerop arg)
3972 ;; We need to kill in two steps, because the previous command
3973 ;; could have been a kill command, in which case the text
3974 ;; before point needs to be prepended to the current kill
3975 ;; ring entry and the text after point appended. Also, we
3976 ;; need to use save-excursion to avoid copying the same text
3977 ;; twice to the kill ring in read-only buffers.
3978 (save-excursion
3979 (kill-region (point) (progn (forward-visible-line 0) (point))))
3980 (kill-region (point) (progn (end-of-visible-line) (point))))
3981 ((< arg 0)
3982 (save-excursion
3983 (kill-region (point) (progn (end-of-visible-line) (point))))
3984 (kill-region (point)
3985 (progn (forward-visible-line (1+ arg))
3986 (unless (bobp) (backward-char))
3987 (point))))
3988 (t
3989 (save-excursion
3990 (kill-region (point) (progn (forward-visible-line 0) (point))))
3991 (kill-region (point)
3992 (progn (forward-visible-line arg) (point))))))
3994 (defun forward-visible-line (arg)
3995 "Move forward by ARG lines, ignoring currently invisible newlines only.
3996 If ARG is negative, move backward -ARG lines.
3997 If ARG is zero, move to the beginning of the current line."
3998 (condition-case nil
3999 (if (> arg 0)
4000 (progn
4001 (while (> arg 0)
4002 (or (zerop (forward-line 1))
4003 (signal 'end-of-buffer nil))
4004 ;; If the newline we just skipped is invisible,
4005 ;; don't count it.
4006 (let ((prop
4007 (get-char-property (1- (point)) 'invisible)))
4008 (if (if (eq buffer-invisibility-spec t)
4009 prop
4010 (or (memq prop buffer-invisibility-spec)
4011 (assq prop buffer-invisibility-spec)))
4012 (setq arg (1+ arg))))
4013 (setq arg (1- arg)))
4014 ;; If invisible text follows, and it is a number of complete lines,
4015 ;; skip it.
4016 (let ((opoint (point)))
4017 (while (and (not (eobp))
4018 (let ((prop
4019 (get-char-property (point) 'invisible)))
4020 (if (eq buffer-invisibility-spec t)
4021 prop
4022 (or (memq prop buffer-invisibility-spec)
4023 (assq prop buffer-invisibility-spec)))))
4024 (goto-char
4025 (if (get-text-property (point) 'invisible)
4026 (or (next-single-property-change (point) 'invisible)
4027 (point-max))
4028 (next-overlay-change (point)))))
4029 (unless (bolp)
4030 (goto-char opoint))))
4031 (let ((first t))
4032 (while (or first (<= arg 0))
4033 (if first
4034 (beginning-of-line)
4035 (or (zerop (forward-line -1))
4036 (signal 'beginning-of-buffer nil)))
4037 ;; If the newline we just moved to is invisible,
4038 ;; don't count it.
4039 (unless (bobp)
4040 (let ((prop
4041 (get-char-property (1- (point)) 'invisible)))
4042 (unless (if (eq buffer-invisibility-spec t)
4043 prop
4044 (or (memq prop buffer-invisibility-spec)
4045 (assq prop buffer-invisibility-spec)))
4046 (setq arg (1+ arg)))))
4047 (setq first nil))
4048 ;; If invisible text follows, and it is a number of complete lines,
4049 ;; skip it.
4050 (let ((opoint (point)))
4051 (while (and (not (bobp))
4052 (let ((prop
4053 (get-char-property (1- (point)) 'invisible)))
4054 (if (eq buffer-invisibility-spec t)
4055 prop
4056 (or (memq prop buffer-invisibility-spec)
4057 (assq prop buffer-invisibility-spec)))))
4058 (goto-char
4059 (if (get-text-property (1- (point)) 'invisible)
4060 (or (previous-single-property-change (point) 'invisible)
4061 (point-min))
4062 (previous-overlay-change (point)))))
4063 (unless (bolp)
4064 (goto-char opoint)))))
4065 ((beginning-of-buffer end-of-buffer)
4066 nil)))
4068 (defun end-of-visible-line ()
4069 "Move to end of current visible line."
4070 (end-of-line)
4071 ;; If the following character is currently invisible,
4072 ;; skip all characters with that same `invisible' property value,
4073 ;; then find the next newline.
4074 (while (and (not (eobp))
4075 (save-excursion
4077 (let ((prop
4078 (get-char-property (point) 'invisible)))
4079 (if (eq buffer-invisibility-spec t)
4080 prop
4081 (or (memq prop buffer-invisibility-spec)
4082 (assq prop buffer-invisibility-spec))))))
4084 (if (get-text-property (point) 'invisible)
4085 (goto-char (or (next-single-property-change (point) 'invisible)
4086 (point-max)))
4087 (goto-char (next-overlay-change (point))))
4088 (end-of-line)))
4089 \f
4090 (defun insert-buffer (buffer)
4091 "Insert after point the contents of BUFFER.
4092 Puts mark after the inserted text.
4093 BUFFER may be a buffer or a buffer name.
4095 This function is meant for the user to run interactively.
4096 Don't call it from programs: use `insert-buffer-substring' instead!"
4097 (interactive
4098 (list
4099 (progn
4100 (barf-if-buffer-read-only)
4101 (read-buffer "Insert buffer: "
4102 (if (eq (selected-window) (next-window))
4103 (other-buffer (current-buffer))
4104 (window-buffer (next-window)))
4105 t))))
4106 (push-mark
4107 (save-excursion
4108 (insert-buffer-substring (get-buffer buffer))
4109 (point)))
4110 nil)
4112 (defun append-to-buffer (buffer start end)
4113 "Append to specified buffer the text of the region.
4114 It is inserted into that buffer before its point.
4116 When calling from a program, give three arguments:
4117 BUFFER (or buffer name), START and END.
4118 START and END specify the portion of the current buffer to be copied."
4119 (interactive
4120 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
4121 (region-beginning) (region-end)))
4122 (let* ((oldbuf (current-buffer))
4123 (append-to (get-buffer-create buffer))
4124 (windows (get-buffer-window-list append-to t t))
4125 point)
4126 (save-excursion
4127 (with-current-buffer append-to
4128 (setq point (point))
4129 (barf-if-buffer-read-only)
4130 (insert-buffer-substring oldbuf start end)
4131 (dolist (window windows)
4132 (when (= (window-point window) point)
4133 (set-window-point window (point))))))))
4135 (defun prepend-to-buffer (buffer start end)
4136 "Prepend to specified buffer the text of the region.
4137 It is inserted into that buffer after its point.
4139 When calling from a program, give three arguments:
4140 BUFFER (or buffer name), START and END.
4141 START and END specify the portion of the current buffer to be copied."
4143 (let ((oldbuf (current-buffer)))
4144 (with-current-buffer (get-buffer-create buffer)
4145 (barf-if-buffer-read-only)
4146 (save-excursion
4147 (insert-buffer-substring oldbuf start end)))))
4149 (defun copy-to-buffer (buffer start end)
4150 "Copy to specified buffer the text of the region.
4151 It is inserted into that buffer, replacing existing text there.
4153 When calling from a program, give three arguments:
4154 BUFFER (or buffer name), START and END.
4155 START and END specify the portion of the current buffer to be copied."
4157 (let ((oldbuf (current-buffer)))
4158 (with-current-buffer (get-buffer-create buffer)
4159 (barf-if-buffer-read-only)
4160 (erase-buffer)
4161 (save-excursion
4162 (insert-buffer-substring oldbuf start end)))))
4163 \f
4164 (define-error 'mark-inactive (purecopy "The mark is not active now"))
4166 (defvar activate-mark-hook nil
4167 "Hook run when the mark becomes active.
4168 It is also run at the end of a command, if the mark is active and
4169 it is possible that the region may have changed.")
4171 (defvar deactivate-mark-hook nil
4172 "Hook run when the mark becomes inactive.")
4174 (defun mark (&optional force)
4175 "Return this buffer's mark value as integer, or nil if never set.
4177 In Transient Mark mode, this function signals an error if
4178 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4179 or the argument FORCE is non-nil, it disregards whether the mark
4180 is active, and returns an integer or nil in the usual way.
4182 If you are using this in an editing command, you are most likely making
4183 a mistake; see the documentation of `set-mark'."
4184 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
4185 (marker-position (mark-marker))
4186 (signal 'mark-inactive nil)))
4188 (defun deactivate-mark (&optional force)
4189 "Deactivate the mark.
4190 If Transient Mark mode is disabled, this function normally does
4191 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4193 Deactivating the mark sets `mark-active' to nil, updates the
4194 primary selection according to `select-active-regions', and runs
4195 `deactivate-mark-hook'.
4197 If Transient Mark mode was temporarily enabled, reset the value
4198 of the variable `transient-mark-mode'; if this causes Transient
4199 Mark mode to be disabled, don't change `mark-active' to nil or
4200 run `deactivate-mark-hook'."
4201 (when (or transient-mark-mode force)
4202 (when (and (if (eq select-active-regions 'only)
4203 (eq (car-safe transient-mark-mode) 'only)
4204 select-active-regions)
4205 (region-active-p)
4206 (display-selections-p))
4207 ;; The var `saved-region-selection', if non-nil, is the text in
4208 ;; the region prior to the last command modifying the buffer.
4209 ;; Set the selection to that, or to the current region.
4210 (cond (saved-region-selection
4211 (x-set-selection 'PRIMARY saved-region-selection)
4212 (setq saved-region-selection nil))
4213 ;; If another program has acquired the selection, region
4214 ;; deactivation should not clobber it (Bug#11772).
4215 ((and (/= (region-beginning) (region-end))
4216 (or (x-selection-owner-p 'PRIMARY)
4217 (null (x-selection-exists-p 'PRIMARY))))
4218 (x-set-selection 'PRIMARY
4219 (buffer-substring (region-beginning)
4220 (region-end))))))
4221 (if (and (null force)
4222 (or (eq transient-mark-mode 'lambda)
4223 (and (eq (car-safe transient-mark-mode) 'only)
4224 (null (cdr transient-mark-mode)))))
4225 ;; When deactivating a temporary region, don't change
4226 ;; `mark-active' or run `deactivate-mark-hook'.
4227 (setq transient-mark-mode nil)
4228 (if (eq (car-safe transient-mark-mode) 'only)
4229 (setq transient-mark-mode (cdr transient-mark-mode)))
4230 (setq mark-active nil)
4231 (run-hooks 'deactivate-mark-hook))))
4233 (defun activate-mark ()
4234 "Activate the mark."
4235 (when (mark t)
4236 (setq mark-active t)
4237 (unless transient-mark-mode
4238 (setq transient-mark-mode 'lambda))
4239 (run-hooks 'activate-mark-hook)))
4241 (defun set-mark (pos)
4242 "Set this buffer's mark to POS. Don't use this function!
4243 That is to say, don't use this function unless you want
4244 the user to see that the mark has moved, and you want the previous
4245 mark position to be lost.
4247 Normally, when a new mark is set, the old one should go on the stack.
4248 This is why most applications should use `push-mark', not `set-mark'.
4250 Novice Emacs Lisp programmers often try to use the mark for the wrong
4251 purposes. The mark saves a location for the user's convenience.
4252 Most editing commands should not alter the mark.
4253 To remember a location for internal use in the Lisp program,
4254 store it in a Lisp variable. Example:
4256 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4258 (if pos
4259 (progn
4260 (setq mark-active t)
4261 (run-hooks 'activate-mark-hook)
4262 (set-marker (mark-marker) pos (current-buffer)))
4263 ;; Normally we never clear mark-active except in Transient Mark mode.
4264 ;; But when we actually clear out the mark value too, we must
4265 ;; clear mark-active in any mode.
4266 (deactivate-mark t)
4267 (set-marker (mark-marker) nil)))
4269 (defcustom use-empty-active-region nil
4271 If nil, region-aware commands treat empty regions as inactive.
4272 If non-nil, region-aware commands treat the region as active as
4273 long as the mark is active, even if the region is empty.
4275 Region-aware commands are those that act on the region if it is
4276 active and Transient Mark mode is enabled, and on the text near
4277 point otherwise."
4278 :type 'boolean
4279 :version "23.1"
4280 :group 'editing-basics)
4282 (defun use-region-p ()
4283 "Return t if the region is active and it is appropriate to act on it.
4284 This is used by commands that act specially on the region under
4285 Transient Mark mode.
4287 The return value is t if Transient Mark mode is enabled and the
4288 mark is active; furthermore, if `use-empty-active-region' is nil,
4289 the region must not be empty. Otherwise, the return value is nil.
4291 For some commands, it may be appropriate to ignore the value of
4292 `use-empty-active-region'; in that case, use `region-active-p'."
4293 (and (region-active-p)
4294 (or use-empty-active-region (> (region-end) (region-beginning)))))
4296 (defun region-active-p ()
4297 "Return t if Transient Mark mode is enabled and the mark is active.
4299 Some commands act specially on the region when Transient Mark
4300 mode is enabled. Usually, such commands should use
4301 `use-region-p' instead of this function, because `use-region-p'
4302 also checks the value of `use-empty-active-region'."
4303 (and transient-mark-mode mark-active))
4305 (defvar mark-ring nil
4306 "The list of former marks of the current buffer, most recent first.")
4307 (make-variable-buffer-local 'mark-ring)
4308 (put 'mark-ring 'permanent-local t)
4310 (defcustom mark-ring-max 16
4311 "Maximum size of mark ring. Start discarding off end if gets this big."
4312 :type 'integer
4313 :group 'editing-basics)
4315 (defvar global-mark-ring nil
4316 "The list of saved global marks, most recent first.")
4318 (defcustom global-mark-ring-max 16
4319 "Maximum size of global mark ring. \
4320 Start discarding off end if gets this big."
4321 :type 'integer
4322 :group 'editing-basics)
4324 (defun pop-to-mark-command ()
4325 "Jump to mark, and pop a new position for mark off the ring.
4326 \(Does not affect global mark ring\)."
4327 (interactive)
4328 (if (null (mark t))
4329 (error "No mark set in this buffer")
4330 (if (= (point) (mark t))
4331 (message "Mark popped"))
4332 (goto-char (mark t))
4333 (pop-mark)))
4335 (defun push-mark-command (arg &optional nomsg)
4336 "Set mark at where point is.
4337 If no prefix ARG and mark is already set there, just activate it.
4338 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4339 (interactive "P")
4340 (let ((mark (marker-position (mark-marker))))
4341 (if (or arg (null mark) (/= mark (point)))
4342 (push-mark nil nomsg t)
4343 (setq mark-active t)
4344 (run-hooks 'activate-mark-hook)
4345 (unless nomsg
4346 (message "Mark activated")))))
4348 (defcustom set-mark-command-repeat-pop nil
4351 will pop the mark twice, and
4353 will pop the mark three times.
4357 :type 'boolean
4358 :group 'editing-basics)
4360 (defun set-mark-command (arg)
4361 "Set the mark where point is, or jump to the mark.
4362 Setting the mark also alters the region, which is the text
4363 between point and mark; this is the closest equivalent in
4366 With no prefix argument, set the mark at point, and push the
4367 old mark position on local mark ring. Also push the old mark on
4368 global mark ring, if the previous mark was set in another buffer.
4370 When Transient Mark Mode is off, immediately repeating this
4371 command activates `transient-mark-mode' temporarily.
4374 jump to the mark, and set the mark from
4375 position popped off the local mark ring \(this does not affect the global
4377 mark ring \(see `pop-global-mark'\).
4379 If `set-mark-command-repeat-pop' is non-nil, repeating
4381 off the local (or global) mark ring and jumps there.
4384 argument, unconditionally set mark where point is, even if
4385 `set-mark-command-repeat-pop' is non-nil.
4387 Novice Emacs Lisp programmers often try to use the mark for the wrong
4388 purposes. See the documentation of `set-mark' for more information."
4389 (interactive "P")
4390 (cond ((eq transient-mark-mode 'lambda)
4391 (setq transient-mark-mode nil))
4392 ((eq (car-safe transient-mark-mode) 'only)
4393 (deactivate-mark)))
4394 (cond
4395 ((and (consp arg) (> (prefix-numeric-value arg) 4))
4396 (push-mark-command nil))
4397 ((not (eq this-command 'set-mark-command))
4398 (if arg
4399 (pop-to-mark-command)
4400 (push-mark-command t)))
4401 ((and set-mark-command-repeat-pop
4402 (eq last-command 'pop-to-mark-command))
4403 (setq this-command 'pop-to-mark-command)
4404 (pop-to-mark-command))
4405 ((and set-mark-command-repeat-pop
4406 (eq last-command 'pop-global-mark)
4407 (not arg))
4408 (setq this-command 'pop-global-mark)
4409 (pop-global-mark))
4410 (arg
4411 (setq this-command 'pop-to-mark-command)
4412 (pop-to-mark-command))
4413 ((eq last-command 'set-mark-command)
4414 (if (region-active-p)
4415 (progn
4416 (deactivate-mark)
4417 (message "Mark deactivated"))
4418 (activate-mark)
4419 (message "Mark activated")))
4420 (t
4421 (push-mark-command nil))))
4423 (defun push-mark (&optional location nomsg activate)
4424 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4425 If the last global mark pushed was not in the current buffer,
4426 also push LOCATION on the global mark ring.
4427 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4429 Novice Emacs Lisp programmers often try to use the mark for the wrong
4430 purposes. See the documentation of `set-mark' for more information.
4432 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4433 (unless (null (mark t))
4434 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
4435 (when (> (length mark-ring) mark-ring-max)
4436 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
4437 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
4438 (set-marker (mark-marker) (or location (point)) (current-buffer))
4439 ;; Now push the mark on the global mark ring.
4440 (if (and global-mark-ring
4441 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
4442 ;; The last global mark pushed was in this same buffer.
4443 ;; Don't push another one.
4444 nil
4445 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4446 (when (> (length global-mark-ring) global-mark-ring-max)
4447 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4448 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4449 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4450 (message "Mark set"))
4451 (if (or activate (not transient-mark-mode))
4452 (set-mark (mark t)))
4453 nil)
4455 (defun pop-mark ()
4456 "Pop off mark ring into the buffer's actual mark.
4457 Does not set point. Does nothing if mark ring is empty."
4458 (when mark-ring
4459 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4460 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4461 (move-marker (car mark-ring) nil)
4462 (if (null (mark t)) (ding))
4463 (setq mark-ring (cdr mark-ring)))
4464 (deactivate-mark))
4466 (define-obsolete-function-alias
4467 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4468 (defun exchange-point-and-mark (&optional arg)
4469 "Put the mark where point is now, and point where the mark is now.
4470 This command works even when the mark is not active,
4471 and it reactivates the mark.
4473 If Transient Mark mode is on, a prefix ARG deactivates the mark
4474 if it is active, and otherwise avoids reactivating it. If
4475 Transient Mark mode is off, a prefix ARG enables Transient Mark
4476 mode temporarily."
4477 (interactive "P")
4478 (let ((omark (mark t))
4479 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4480 (if (null omark)
4481 (error "No mark set in this buffer"))
4482 (deactivate-mark)
4483 (set-mark (point))
4484 (goto-char omark)
4485 (cond (temp-highlight
4486 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4487 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4488 (not (or arg (region-active-p))))
4489 (deactivate-mark))
4490 (t (activate-mark)))
4491 nil))
4493 (defcustom shift-select-mode t
4494 "When non-nil, shifted motion keys activate the mark momentarily.
4496 While the mark is activated in this way, any shift-translated point
4497 motion key extends the region, and if Transient Mark mode was off, it
4498 is temporarily turned on. Furthermore, the mark will be deactivated
4499 by any subsequent point motion key that was not shift-translated, or
4500 by any action that normally deactivates the mark in Transient Mark mode.
4502 See `this-command-keys-shift-translated' for the meaning of
4503 shift-translation."
4504 :type 'boolean
4505 :group 'editing-basics)
4507 (defun handle-shift-selection ()
4508 "Activate/deactivate mark depending on invocation thru shift translation.
4509 This function is called by `call-interactively' when a command
4510 with a `^' character in its `interactive' spec is invoked, before
4511 running the command itself.
4513 If `shift-select-mode' is enabled and the command was invoked
4514 through shift translation, set the mark and activate the region
4515 temporarily, unless it was already set in this way. See
4516 `this-command-keys-shift-translated' for the meaning of shift
4517 translation.
4519 Otherwise, if the region has been activated temporarily,
4520 deactivate it, and restore the variable `transient-mark-mode' to
4521 its earlier value."
4522 (cond ((and shift-select-mode this-command-keys-shift-translated)
4523 (unless (and mark-active
4524 (eq (car-safe transient-mark-mode) 'only))
4525 (setq transient-mark-mode
4526 (cons 'only
4527 (unless (eq transient-mark-mode 'lambda)
4528 transient-mark-mode)))
4529 (push-mark nil nil t)))
4530 ((eq (car-safe transient-mark-mode) 'only)
4531 (setq transient-mark-mode (cdr transient-mark-mode))
4532 (deactivate-mark))))
4534 (define-minor-mode transient-mark-mode
4535 "Toggle Transient Mark mode.
4536 With a prefix argument ARG, enable Transient Mark mode if ARG is
4537 positive, and disable it otherwise. If called from Lisp, enable
4538 Transient Mark mode if ARG is omitted or nil.
4540 Transient Mark mode is a global minor mode. When enabled, the
4541 region is highlighted whenever the mark is active. The mark is
4543 operations that set the mark but whose main purpose is something
4549 Many commands change their behavior when Transient Mark mode is
4550 in effect and the mark is active, by acting on the region instead
4551 of their usual default part of the buffer's text. Examples of
4554 To see the documentation of commands which are sensitive to the
4557 :global t
4558 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4559 :variable transient-mark-mode)
4561 (defvar widen-automatically t
4562 "Non-nil means it is ok for commands to call `widen' when they want to.
4563 Some commands will do this in order to go to positions outside
4564 the current accessible part of the buffer.
4566 If `widen-automatically' is nil, these commands will do something else
4567 as a fallback, and won't change the buffer bounds.")
4569 (defvar non-essential nil
4570 "Whether the currently executing code is performing an essential task.
4571 This variable should be non-nil only when running code which should not
4572 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4573 user for a password when we are simply scanning a set of files in the
4574 background or displaying possible completions before the user even asked
4575 for it.")
4577 (defun pop-global-mark ()
4578 "Pop off global mark ring and jump to the top location."
4579 (interactive)
4580 ;; Pop entries which refer to non-existent buffers.
4581 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4582 (setq global-mark-ring (cdr global-mark-ring)))
4583 (or global-mark-ring
4584 (error "No global mark set"))
4585 (let* ((marker (car global-mark-ring))
4586 (buffer (marker-buffer marker))
4587 (position (marker-position marker)))
4588 (setq global-mark-ring (nconc (cdr global-mark-ring)
4589 (list (car global-mark-ring))))
4590 (set-buffer buffer)
4591 (or (and (>= position (point-min))
4592 (<= position (point-max)))
4593 (if widen-automatically
4594 (widen)
4595 (error "Global mark position is outside accessible part of buffer")))
4596 (goto-char position)
4597 (switch-to-buffer buffer)))
4598 \f
4599 (defcustom next-line-add-newlines nil
4600 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4601 :type 'boolean
4602 :version "21.1"
4603 :group 'editing-basics)
4605 (defun next-line (&optional arg try-vscroll)
4606 "Move cursor vertically down ARG lines.
4607 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4608 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4609 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4610 function will not vscroll.
4612 ARG defaults to 1.
4614 If there is no character in the target line exactly under the current column,
4615 the cursor is positioned after the character in that line which spans this
4616 column, or at the end of the line if it is not long enough.
4617 If there is no line in the buffer after this one, behavior depends on the
4618 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4619 to create a line, and moves the cursor to that line. Otherwise it moves the
4620 cursor to the end of the buffer.
4622 If the variable `line-move-visual' is non-nil, this command moves
4623 by display lines. Otherwise, it moves by buffer lines, without
4624 taking variable-width characters or continued lines into account.
4627 a semipermanent goal column for this command.
4628 Then instead of trying to move exactly vertically (or as close as possible),
4629 this command moves to the specified goal column (or as close as possible).
4630 The goal column is stored in the variable `goal-column', which is nil
4631 when there is no goal column. Note that setting `goal-column'
4632 overrides `line-move-visual' and causes this command to move by buffer
4633 lines rather than by display lines.
4635 If you are thinking of using this in a Lisp program, consider
4636 using `forward-line' instead. It is usually easier to use
4637 and more reliable (no dependence on goal column, etc.)."
4639 (or arg (setq arg 1))
4640 (if (and next-line-add-newlines (= arg 1))
4641 (if (save-excursion (end-of-line) (eobp))
4642 ;; When adding a newline, don't expand an abbrev.
4643 (let ((abbrev-mode nil))
4644 (end-of-line)
4646 (line-move arg nil nil try-vscroll))
4647 (if (called-interactively-p 'interactive)
4648 (condition-case err
4649 (line-move arg nil nil try-vscroll)
4650 ((beginning-of-buffer end-of-buffer)
4651 (signal (car err) (cdr err))))
4652 (line-move arg nil nil try-vscroll)))
4653 nil)
4655 (defun previous-line (&optional arg try-vscroll)
4656 "Move cursor vertically up ARG lines.
4657 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4658 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4659 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4660 function will not vscroll.
4662 ARG defaults to 1.
4664 If there is no character in the target line exactly over the current column,
4665 the cursor is positioned after the character in that line which spans this
4666 column, or at the end of the line if it is not long enough.
4668 If the variable `line-move-visual' is non-nil, this command moves
4669 by display lines. Otherwise, it moves by buffer lines, without
4670 taking variable-width characters or continued lines into account.
4673 a semipermanent goal column for this command.
4674 Then instead of trying to move exactly vertically (or as close as possible),
4675 this command moves to the specified goal column (or as close as possible).
4676 The goal column is stored in the variable `goal-column', which is nil
4677 when there is no goal column. Note that setting `goal-column'
4678 overrides `line-move-visual' and causes this command to move by buffer
4679 lines rather than by display lines.
4681 If you are thinking of using this in a Lisp program, consider using
4682 `forward-line' with a negative argument instead. It is usually easier
4683 to use and more reliable (no dependence on goal column, etc.)."
4685 (or arg (setq arg 1))
4686 (if (called-interactively-p 'interactive)
4687 (condition-case err
4688 (line-move (- arg) nil nil try-vscroll)
4689 ((beginning-of-buffer end-of-buffer)
4690 (signal (car err) (cdr err))))
4691 (line-move (- arg) nil nil try-vscroll))
4692 nil)
4694 (defcustom track-eol nil
4695 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4696 This means moving to the end of each line moved onto.
4697 The beginning of a blank line does not count as the end of a line.
4698 This has no effect when the variable `line-move-visual' is non-nil."
4699 :type 'boolean
4700 :group 'editing-basics)
4702 (defcustom goal-column nil
4704 A non-nil setting overrides the variable `line-move-visual', which see."
4705 :type '(choice integer
4706 (const :tag "None" nil))
4707 :group 'editing-basics)
4708 (make-variable-buffer-local 'goal-column)
4710 (defvar temporary-goal-column 0
4711 "Current goal column for vertical motion.
4712 It is the column where point was at the start of the current run
4713 of vertical motion commands.
4715 When moving by visual lines via the function `line-move-visual', it is a cons
4716 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4717 divided by the default column width, and HSCROLL is the number of
4718 columns by which window is scrolled from left margin.
4720 When the `track-eol' feature is doing its job, the value is
4721 `most-positive-fixnum'.")
4723 (defcustom line-move-ignore-invisible t
4725 Outline mode sets this."
4726 :type 'boolean
4727 :group 'editing-basics)
4729 (defcustom line-move-visual t
4730 "When non-nil, `line-move' moves point by visual lines.
4731 This movement is based on where the cursor is displayed on the
4732 screen, instead of relying on buffer contents alone. It takes
4733 into account variable-width characters and line continuation.
4734 If nil, `line-move' moves point by logical lines.
4735 A non-nil setting of `goal-column' overrides the value of this variable
4736 and forces movement by logical lines.
4737 A window that is horizontally scrolled also forces movement by logical
4738 lines."
4739 :type 'boolean
4740 :group 'editing-basics
4741 :version "23.1")
4743 (defun default-font-height ()
4744 "Return the height in pixels of the current buffer's default face font."
4745 (let ((default-font (face-font 'default)))
4746 (cond
4747 ((and (display-multi-font-p)
4748 ;; Avoid calling font-info if the frame's default font was
4749 ;; not changed since the frame was created. That's because
4750 ;; font-info is expensive for some fonts, see bug #14838.
4751 (not (string= (frame-parameter nil 'font) default-font)))
4752 (aref (font-info default-font) 3))
4753 (t (frame-char-height)))))
4755 (defun default-line-height ()
4756 "Return the pixel height of current buffer's default-face text line.
4758 The value includes `line-spacing', if any, defined for the buffer
4759 or the frame."
4760 (let ((dfh (default-font-height))
4761 (lsp (if (display-graphic-p)
4762 (or line-spacing
4763 (default-value 'line-spacing)
4764 (frame-parameter nil 'line-spacing)
4765 0)
4766 0)))
4767 (if (floatp lsp)
4768 (setq lsp (* dfh lsp)))
4769 (+ dfh lsp)))
4771 (defun window-screen-lines ()
4772 "Return the number of screen lines in the text area of the selected window.
4774 This is different from `window-text-height' in that this function counts
4775 lines in units of the height of the font used by the default face displayed
4776 in the window, not in units of the frame's default font, and also accounts
4777 for `line-spacing', if any, defined for the window's buffer or frame.
4779 The value is a floating-point number."
4780 (let ((canonical (window-text-height))
4781 (fch (frame-char-height))
4782 (dlh (default-line-height)))
4783 (/ (* (float canonical) fch) dlh)))
4785 ;; Returns non-nil if partial move was done.
4786 (defun line-move-partial (arg noerror to-end)
4787 (if (< arg 0)
4788 ;; Move backward (up).
4789 ;; If already vscrolled, reduce vscroll
4790 (let ((vs (window-vscroll nil t))
4791 (dlh (default-line-height)))
4792 (when (> vs dlh)
4793 (set-window-vscroll nil (- vs dlh) t)))
4795 ;; Move forward (down).
4796 (let* ((lh (window-line-height -1))
4797 (rowh (car lh))
4798 (vpos (nth 1 lh))
4799 (ypos (nth 2 lh))
4800 (rbot (nth 3 lh))
4801 (this-lh (window-line-height))
4802 (this-height (car this-lh))
4803 (this-ypos (nth 2 this-lh))
4804 (dlh (default-line-height))
4805 (wslines (window-screen-lines))
4806 (edges (window-inside-pixel-edges))
4807 (winh (- (nth 3 edges) (nth 1 edges) 1))
4808 py vs last-line)
4809 (if (> (mod wslines 1.0) 0.0)
4810 (setq wslines (round (+ wslines 0.5))))
4811 (when (or (null lh)
4812 (>= rbot dlh)
4813 (<= ypos (- dlh))
4814 (null this-lh)
4815 (<= this-ypos (- dlh)))
4816 (unless lh
4817 (let ((wend (pos-visible-in-window-p t nil t)))
4818 (setq rbot (nth 3 wend)
4819 rowh (nth 4 wend)
4820 vpos (nth 5 wend))))
4821 (unless this-lh
4822 (let ((wstart (pos-visible-in-window-p nil nil t)))
4823 (setq this-ypos (nth 2 wstart)
4824 this-height (nth 4 wstart))))
4825 (setq py
4826 (or (nth 1 this-lh)
4827 (let ((ppos (posn-at-point))
4828 col-row)
4829 (setq col-row (posn-actual-col-row ppos))
4830 (if col-row
4831 (- (cdr col-row) (window-vscroll))
4832 (cdr (posn-col-row ppos))))))
4833 ;; VPOS > 0 means the last line is only partially visible.
4834 ;; But if the part that is visible is at least as tall as the
4835 ;; default font, that means the line is actually fully
4836 ;; readable, and something like line-spacing is hidden. So in
4837 ;; that case we accept the last line in the window as still
4838 ;; visible, and consider the margin as starting one line
4839 ;; later.
4840 (if (and vpos (> vpos 0))
4841 (if (and rowh
4842 (>= rowh (default-font-height))
4843 (< rowh dlh))
4844 (setq last-line (min (- wslines scroll-margin) vpos))
4845 (setq last-line (min (- wslines scroll-margin 1) (1- vpos)))))
4846 (cond
4847 ;; If last line of window is fully visible, and vscrolling
4848 ;; more would make this line invisible, move forward.
4849 ((and (or (< (setq vs (window-vscroll nil t)) dlh)
4850 (null this-height)
4851 (<= this-height dlh))
4852 (or (null rbot) (= rbot 0)))
4853 nil)
4854 ;; If cursor is not in the bottom scroll margin, and the
4855 ;; current line is is not too tall, move forward.
4856 ((and (or (null this-height) (<= this-height winh))
4857 vpos
4858 (> vpos 0)
4859 (< py last-line))
4860 nil)
4861 ;; When already vscrolled, we vscroll some more if we can,
4862 ;; or clear vscroll and move forward at end of tall image.
4863 ((> vs 0)
4864 (when (or (and rbot (> rbot 0))
4865 (and this-height (> this-height dlh)))
4866 (set-window-vscroll nil (+ vs dlh) t)))
4867 ;; If cursor just entered the bottom scroll margin, move forward,
4868 ;; but also optionally vscroll one line so redisplay won't recenter.
4869 ((and vpos
4870 (> vpos 0)
4871 (= py last-line))
4872 ;; Don't vscroll if the partially-visible line at window
4873 ;; bottom is not too tall (a.k.a. "just one more text
4874 ;; line"): in that case, we do want redisplay to behave
4875 ;; normally, i.e. recenter or whatever.
4876 ;;
4877 ;; Note: ROWH + RBOT from the value returned by
4878 ;; pos-visible-in-window-p give the total height of the
4879 ;; partially-visible glyph row at the end of the window. As
4880 ;; we are dealing with floats, we disregard sub-pixel
4881 ;; discrepancies between that and DLH.
4882 (if (and rowh rbot (>= (- (+ rowh rbot) winh) 1))
4883 (set-window-vscroll nil dlh t))
4884 (line-move-1 arg noerror to-end)
4885 t)
4886 ;; If there are lines above the last line, scroll-up one line.
4887 ((and vpos (> vpos 0))
4888 (scroll-up 1)
4889 t)
4890 ;; Finally, start vscroll.
4891 (t
4892 (set-window-vscroll nil dlh t)))))))
4895 ;; This is like line-move-1 except that it also performs
4896 ;; vertical scrolling of tall images if appropriate.
4897 ;; That is not really a clean thing to do, since it mixes
4898 ;; scrolling with cursor motion. But so far we don't have
4899 ;; a cleaner solution to the problem of making C-n do something
4900 ;; useful given a tall image.
4901 (defun line-move (arg &optional noerror to-end try-vscroll)
4902 (if noninteractive
4903 (forward-line arg)
4904 (unless (and auto-window-vscroll try-vscroll
4905 ;; Only vscroll for single line moves
4906 (= (abs arg) 1)
4907 ;; Under scroll-conservatively, the display engine
4908 ;; does this better.
4909 (zerop scroll-conservatively)
4910 ;; But don't vscroll in a keyboard macro.
4911 (not defining-kbd-macro)
4912 (not executing-kbd-macro)
4913 (line-move-partial arg noerror to-end))
4914 (set-window-vscroll nil 0 t)
4915 (if (and line-move-visual
4916 ;; Display-based column are incompatible with goal-column.
4917 (not goal-column)
4918 ;; When the text in the window is scrolled to the left,
4919 ;; display-based motion doesn't make sense (because each
4920 ;; logical line occupies exactly one screen line).
4921 (not (> (window-hscroll) 0)))
4922 (prog1 (line-move-visual arg noerror)
4923 ;; If we moved into a tall line, set vscroll to make
4924 ;; scrolling through tall images more smooth.
4925 (let ((lh (line-pixel-height))
4926 (edges (window-inside-pixel-edges))
4927 (dlh (default-line-height))
4928 winh)
4929 (setq winh (- (nth 3 edges) (nth 1 edges) 1))
4930 (if (and (< arg 0)
4931 (< (point) (window-start))
4932 (> lh winh))
4933 (set-window-vscroll
4934 nil
4935 (- lh dlh) t))))
4936 (line-move-1 arg noerror to-end)))))
4938 ;; Display-based alternative to line-move-1.
4939 ;; Arg says how many lines to move. The value is t if we can move the
4940 ;; specified number of lines.
4941 (defun line-move-visual (arg &optional noerror)
4942 (let ((opoint (point))
4943 (hscroll (window-hscroll))
4944 target-hscroll)
4945 ;; Check if the previous command was a line-motion command, or if
4946 ;; we were called from some other command.
4947 (if (and (consp temporary-goal-column)
4948 (memq last-command `(next-line previous-line ,this-command)))
4949 ;; If so, there's no need to reset `temporary-goal-column',
4950 ;; but we may need to hscroll.
4951 (if (or (/= (cdr temporary-goal-column) hscroll)
4952 (> (cdr temporary-goal-column) 0))
4953 (setq target-hscroll (cdr temporary-goal-column)))
4954 ;; Otherwise, we should reset `temporary-goal-column'.
4955 (let ((posn (posn-at-point)))
4956 (cond
4957 ;; Handle the `overflow-newline-into-fringe' case:
4958 ((eq (nth 1 posn) 'right-fringe)
4959 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4960 ((car (posn-x-y posn))
4961 (setq temporary-goal-column
4962 (cons (/ (float (car (posn-x-y posn)))
4963 (frame-char-width)) hscroll))))))
4964 (if target-hscroll
4965 (set-window-hscroll (selected-window) target-hscroll))
4966 ;; vertical-motion can move more than it was asked to if it moves
4967 ;; across display strings with newlines. We don't want to ring
4968 ;; the bell and announce beginning/end of buffer in that case.
4969 (or (and (or (and (>= arg 0)
4970 (>= (vertical-motion
4971 (cons (or goal-column
4972 (if (consp temporary-goal-column)
4973 (car temporary-goal-column)
4974 temporary-goal-column))
4975 arg))
4976 arg))
4977 (and (< arg 0)
4978 (<= (vertical-motion
4979 (cons (or goal-column
4980 (if (consp temporary-goal-column)
4981 (car temporary-goal-column)
4982 temporary-goal-column))
4983 arg))
4984 arg)))
4985 (or (>= arg 0)
4986 (/= (point) opoint)
4987 ;; If the goal column lies on a display string,
4988 ;; `vertical-motion' advances the cursor to the end
4989 ;; of the string. For arg < 0, this can cause the
4990 ;; cursor to get stuck. (Bug#3020).
4991 (= (vertical-motion arg) arg)))
4992 (unless noerror
4993 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4994 nil)))))
4996 ;; This is the guts of next-line and previous-line.
4997 ;; Arg says how many lines to move.
4998 ;; The value is t if we can move the specified number of lines.
4999 (defun line-move-1 (arg &optional noerror _to-end)
5000 ;; Don't run any point-motion hooks, and disregard intangibility,
5001 ;; for intermediate positions.
5002 (let ((inhibit-point-motion-hooks t)
5003 (opoint (point))
5004 (orig-arg arg))
5005 (if (consp temporary-goal-column)
5006 (setq temporary-goal-column (+ (car temporary-goal-column)
5007 (cdr temporary-goal-column))))
5008 (unwind-protect
5009 (progn
5010 (if (not (memq last-command '(next-line previous-line)))
5011 (setq temporary-goal-column
5012 (if (and track-eol (eolp)
5013 ;; Don't count beg of empty line as end of line
5014 ;; unless we just did explicit end-of-line.
5015 (or (not (bolp)) (eq last-command 'move-end-of-line)))
5016 most-positive-fixnum
5017 (current-column))))
5019 (if (not (or (integerp selective-display)
5020 line-move-ignore-invisible))
5021 ;; Use just newline characters.
5022 ;; Set ARG to 0 if we move as many lines as requested.
5023 (or (if (> arg 0)
5024 (progn (if (> arg 1) (forward-line (1- arg)))
5025 ;; This way of moving forward ARG lines
5026 ;; verifies that we have a newline after the last one.
5027 ;; It doesn't get confused by intangible text.
5028 (end-of-line)
5029 (if (zerop (forward-line 1))
5030 (setq arg 0)))
5031 (and (zerop (forward-line arg))
5032 (bolp)
5033 (setq arg 0)))
5034 (unless noerror
5035 (signal (if (< arg 0)
5036 'beginning-of-buffer
5037 'end-of-buffer)
5038 nil)))
5039 ;; Move by arg lines, but ignore invisible ones.
5040 (let (done)
5041 (while (and (> arg 0) (not done))
5042 ;; If the following character is currently invisible,
5043 ;; skip all characters with that same `invisible' property value.
5044 (while (and (not (eobp)) (invisible-p (point)))
5045 (goto-char (next-char-property-change (point))))
5046 ;; Move a line.
5047 ;; We don't use `end-of-line', since we want to escape
5048 ;; from field boundaries occurring exactly at point.
5049 (goto-char (constrain-to-field
5050 (let ((inhibit-field-text-motion t))
5051 (line-end-position))
5052 (point) t t
5053 'inhibit-line-move-field-capture))
5054 ;; If there's no invisibility here, move over the newline.
5055 (cond
5056 ((eobp)
5057 (if (not noerror)
5058 (signal 'end-of-buffer nil)
5059 (setq done t)))
5060 ((and (> arg 1) ;; Use vertical-motion for last move
5061 (not (integerp selective-display))
5062 (not (invisible-p (point))))
5063 ;; We avoid vertical-motion when possible
5064 ;; because that has to fontify.
5065 (forward-line 1))
5066 ;; Otherwise move a more sophisticated way.
5067 ((zerop (vertical-motion 1))
5068 (if (not noerror)
5069 (signal 'end-of-buffer nil)
5070 (setq done t))))
5071 (unless done
5072 (setq arg (1- arg))))
5073 ;; The logic of this is the same as the loop above,
5074 ;; it just goes in the other direction.
5075 (while (and (< arg 0) (not done))
5076 ;; For completely consistency with the forward-motion
5077 ;; case, we should call beginning-of-line here.
5078 ;; However, if point is inside a field and on a
5079 ;; continued line, the call to (vertical-motion -1)
5080 ;; below won't move us back far enough; then we return
5081 ;; to the same column in line-move-finish, and point
5082 ;; gets stuck -- cyd
5083 (forward-line 0)
5084 (cond
5085 ((bobp)
5086 (if (not noerror)
5087 (signal 'beginning-of-buffer nil)
5088 (setq done t)))
5089 ((and (< arg -1) ;; Use vertical-motion for last move
5090 (not (integerp selective-display))
5091 (not (invisible-p (1- (point)))))
5092 (forward-line -1))
5093 ((zerop (vertical-motion -1))
5094 (if (not noerror)
5095 (signal 'beginning-of-buffer nil)
5096 (setq done t))))
5097 (unless done
5098 (setq arg (1+ arg))
5099 (while (and ;; Don't move over previous invis lines
5100 ;; if our target is the middle of this line.
5101 (or (zerop (or goal-column temporary-goal-column))
5102 (< arg 0))
5103 (not (bobp)) (invisible-p (1- (point))))
5104 (goto-char (previous-char-property-change (point))))))))
5105 ;; This is the value the function returns.
5106 (= arg 0))
5108 (cond ((> arg 0)
5109 ;; If we did not move down as far as desired, at least go
5110 ;; to end of line. Be sure to call point-entered and
5111 ;; point-left-hooks.
5112 (let* ((npoint (prog1 (line-end-position)
5113 (goto-char opoint)))
5114 (inhibit-point-motion-hooks nil))
5115 (goto-char npoint)))
5116 ((< arg 0)
5117 ;; If we did not move up as far as desired,
5118 ;; at least go to beginning of line.
5119 (let* ((npoint (prog1 (line-beginning-position)
5120 (goto-char opoint)))
5121 (inhibit-point-motion-hooks nil))
5122 (goto-char npoint)))
5123 (t
5124 (line-move-finish (or goal-column temporary-goal-column)
5125 opoint (> orig-arg 0)))))))
5127 (defun line-move-finish (column opoint forward)
5128 (let ((repeat t))
5129 (while repeat
5130 ;; Set REPEAT to t to repeat the whole thing.
5131 (setq repeat nil)
5133 (let (new
5134 (old (point))
5135 (line-beg (line-beginning-position))
5136 (line-end
5137 ;; Compute the end of the line
5138 ;; ignoring effectively invisible newlines.
5139 (save-excursion
5140 ;; Like end-of-line but ignores fields.
5142 (while (and (not (eobp)) (invisible-p (point)))
5143 (goto-char (next-char-property-change (point)))
5145 (point))))
5147 ;; Move to the desired column.
5148 (line-move-to-column (truncate column))
5150 ;; Corner case: suppose we start out in a field boundary in
5151 ;; the middle of a continued line. When we get to
5152 ;; line-move-finish, point is at the start of a new *screen*
5153 ;; line but the same text line; then line-move-to-column would
5154 ;; move us backwards. Test using C-n with point on the "x" in
5155 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5156 (and forward
5157 (< (point) old)
5158 (goto-char old))
5160 (setq new (point))
5162 ;; Process intangibility within a line.
5163 ;; With inhibit-point-motion-hooks bound to nil, a call to
5164 ;; goto-char moves point past intangible text.
5166 ;; However, inhibit-point-motion-hooks controls both the
5167 ;; intangibility and the point-entered/point-left hooks. The
5168 ;; following hack avoids calling the point-* hooks
5169 ;; unnecessarily. Note that we move *forward* past intangible
5170 ;; text when the initial and final points are the same.
5171 (goto-char new)
5172 (let ((inhibit-point-motion-hooks nil))
5173 (goto-char new)
5175 ;; If intangibility moves us to a different (later) place
5176 ;; in the same line, use that as the destination.
5177 (if (<= (point) line-end)
5178 (setq new (point))
5179 ;; If that position is "too late",
5180 ;; try the previous allowable position.
5181 ;; See if it is ok.
5182 (backward-char)
5183 (if (if forward
5184 ;; If going forward, don't accept the previous
5185 ;; allowable position if it is before the target line.
5186 (< line-beg (point))
5187 ;; If going backward, don't accept the previous
5188 ;; allowable position if it is still after the target line.
5189 (<= (point) line-end))
5190 (setq new (point))
5191 ;; As a last resort, use the end of the line.
5192 (setq new line-end))))
5194 ;; Now move to the updated destination, processing fields
5195 ;; as well as intangibility.
5196 (goto-char opoint)
5197 (let ((inhibit-point-motion-hooks nil))
5198 (goto-char
5199 ;; Ignore field boundaries if the initial and final
5200 ;; positions have the same `field' property, even if the
5201 ;; fields are non-contiguous. This seems to be "nicer"
5202 ;; behavior in many situations.
5203 (if (eq (get-char-property new 'field)
5204 (get-char-property opoint 'field))
5205 new
5206 (constrain-to-field new opoint t t
5207 'inhibit-line-move-field-capture))))
5209 ;; If all this moved us to a different line,
5210 ;; retry everything within that new line.
5211 (when (or (< (point) line-beg) (> (point) line-end))
5212 ;; Repeat the intangibility and field processing.
5213 (setq repeat t))))))
5215 (defun line-move-to-column (col)
5216 "Try to find column COL, considering invisibility.
5217 This function works only in certain cases,
5218 because what we really need is for `move-to-column'
5219 and `current-column' to be able to ignore invisible text."
5220 (if (zerop col)
5221 (beginning-of-line)
5222 (move-to-column col))
5224 (when (and line-move-ignore-invisible
5225 (not (bolp)) (invisible-p (1- (point))))
5226 (let ((normal-location (point))
5227 (normal-column (current-column)))
5228 ;; If the following character is currently invisible,
5229 ;; skip all characters with that same `invisible' property value.
5230 (while (and (not (eobp))
5231 (invisible-p (point)))
5232 (goto-char (next-char-property-change (point))))
5233 ;; Have we advanced to a larger column position?
5234 (if (> (current-column) normal-column)
5235 ;; We have made some progress towards the desired column.
5236 ;; See if we can make any further progress.
5237 (line-move-to-column (+ (current-column) (- col normal-column)))
5238 ;; Otherwise, go to the place we originally found
5239 ;; and move back over invisible text.
5240 ;; that will get us to the same place on the screen
5241 ;; but with a more reasonable buffer position.
5242 (goto-char normal-location)
5243 (let ((line-beg (line-beginning-position)))
5244 (while (and (not (bolp)) (invisible-p (1- (point))))
5245 (goto-char (previous-char-property-change (point) line-beg))))))))
5247 (defun move-end-of-line (arg)
5248 "Move point to end of current line as displayed.
5249 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5250 If point reaches the beginning or end of buffer, it stops there.
5252 To ignore the effects of the `intangible' text or overlay
5253 property, bind `inhibit-point-motion-hooks' to t.
5254 If there is an image in the current line, this function
5255 disregards newlines that are part of the text on which the image
5256 rests."
5257 (interactive "^p")
5258 (or arg (setq arg 1))
5259 (let (done)
5260 (while (not done)
5261 (let ((newpos
5262 (save-excursion
5263 (let ((goal-column 0)
5264 (line-move-visual nil))
5265 (and (line-move arg t)
5266 ;; With bidi reordering, we may not be at bol,
5267 ;; so make sure we are.
5269 (not (bobp))
5270 (progn
5271 (while (and (not (bobp)) (invisible-p (1- (point))))
5272 (goto-char (previous-single-char-property-change
5273 (point) 'invisible)))
5274 (backward-char 1)))
5275 (point)))))
5276 (goto-char newpos)
5277 (if (and (> (point) newpos)
5279 (backward-char 1)
5280 (if (and (> (point) newpos) (not (eobp))
5282 ;; If we skipped something intangible and now we're not
5283 ;; really at eol, keep going.
5284 (setq arg 1)
5285 (setq done t)))))))
5287 (defun move-beginning-of-line (arg)
5288 "Move point to beginning of current line as displayed.
5289 \(If there's an image in the line, this disregards newlines
5290 which are part of the text that the image rests on.)
5292 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5293 If point reaches the beginning or end of buffer, it stops there.
5294 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5295 (interactive "^p")
5296 (or arg (setq arg 1))
5298 (let ((orig (point))
5299 first-vis first-vis-field-value)
5301 ;; Move by lines, if ARG is not 1 (the default).
5302 (if (/= arg 1)
5303 (let ((line-move-visual nil))
5304 (line-move (1- arg) t)))
5306 ;; Move to beginning-of-line, ignoring fields and invisible text.
5308 (while (and (not (bobp)) (invisible-p (1- (point))))
5309 (goto-char (previous-char-property-change (point)))
5312 ;; Now find first visible char in the line
5313 (while (and (not (eobp)) (invisible-p (point)))
5314 (goto-char (next-char-property-change (point))))
5315 (setq first-vis (point))
5317 ;; See if fields would stop us from reaching FIRST-VIS.
5318 (setq first-vis-field-value
5319 (constrain-to-field first-vis orig (/= arg 1) t nil))
5321 (goto-char (if (/= first-vis-field-value first-vis)
5322 ;; If yes, obey them.
5323 first-vis-field-value
5324 ;; Otherwise, move to START with attention to fields.
5325 ;; (It is possible that fields never matter in this case.)
5326 (constrain-to-field (point) orig
5327 (/= arg 1) t nil)))))
5330 ;; Many people have said they rarely use this feature, and often type
5331 ;; it by accident. Maybe it shouldn't even be on a key.
5332 (put 'set-goal-column 'disabled t)
5334 (defun set-goal-column (arg)
5336 Those commands will move to this position in the line moved to
5337 rather than trying to keep the same horizontal position.
5338 With a non-nil argument ARG, clears out the goal column
5340 The goal column is stored in the variable `goal-column'."
5341 (interactive "P")
5342 (if arg
5343 (progn
5344 (setq goal-column nil)
5345 (message "No goal column"))
5346 (setq goal-column (current-column))
5347 ;; The older method below can be erroneous if `set-goal-column' is bound
5348 ;; to a sequence containing %
5349 ;;(message (substitute-command-keys
5351 ;;goal-column)
5352 (message "%s"
5353 (concat
5354 (format "Goal column %d " goal-column)
5355 (substitute-command-keys
5358 )
5359 nil)
5360 \f
5361 ;;; Editing based on visual lines, as opposed to logical lines.
5363 (defun end-of-visual-line (&optional n)
5364 "Move point to end of current visual line.
5365 With argument N not nil or 1, move forward N - 1 visual lines first.
5366 If point reaches the beginning or end of buffer, it stops there.
5367 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5368 (interactive "^p")
5369 (or n (setq n 1))
5370 (if (/= n 1)
5371 (let ((line-move-visual t))
5372 (line-move (1- n) t)))
5373 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5374 ;; constrain to field boundaries, so we don't either.
5375 (vertical-motion (cons (window-width) 0)))
5377 (defun beginning-of-visual-line (&optional n)
5378 "Move point to beginning of current visual line.
5379 With argument N not nil or 1, move forward N - 1 visual lines first.
5380 If point reaches the beginning or end of buffer, it stops there.
5381 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5382 (interactive "^p")
5383 (or n (setq n 1))
5384 (let ((opoint (point)))
5385 (if (/= n 1)
5386 (let ((line-move-visual t))
5387 (line-move (1- n) t)))
5388 (vertical-motion 0)
5389 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5390 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
5392 (defun kill-visual-line (&optional arg)
5393 "Kill the rest of the visual line.
5394 With prefix argument ARG, kill that many visual lines from point.
5395 If ARG is negative, kill visual lines backward.
5396 If ARG is zero, kill the text before point on the current visual
5397 line.
5399 If you want to append the killed line to the last killed text,
5402 If the buffer is read-only, Emacs will beep and refrain from deleting
5403 the line, but put the line in the kill ring anyway. This means that
5404 you can use this command to copy text from a read-only buffer.
5405 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5406 even beep.)"
5407 (interactive "P")
5408 ;; Like in `kill-line', it's better to move point to the other end
5409 ;; of the kill before killing.
5410 (let ((opoint (point))
5411 (kill-whole-line (and kill-whole-line (bolp))))
5412 (if arg
5413 (vertical-motion (prefix-numeric-value arg))
5414 (end-of-visual-line 1)
5415 (if (= (point) opoint)
5416 (vertical-motion 1)
5417 ;; Skip any trailing whitespace at the end of the visual line.
5418 ;; We used to do this only if `show-trailing-whitespace' is
5419 ;; nil, but that's wrong; the correct thing would be to check
5420 ;; whether the trailing whitespace is highlighted. But, it's
5421 ;; OK to just do this unconditionally.
5424 (1+ (point))
5425 (point)))))
5427 (defun next-logical-line (&optional arg try-vscroll)
5428 "Move cursor vertically down ARG lines.
5429 This is identical to `next-line', except that it always moves
5430 by logical lines instead of visual lines, ignoring the value of
5431 the variable `line-move-visual'."
5433 (let ((line-move-visual nil))
5434 (with-no-warnings
5435 (next-line arg try-vscroll))))
5437 (defun previous-logical-line (&optional arg try-vscroll)
5438 "Move cursor vertically up ARG lines.
5439 This is identical to `previous-line', except that it always moves
5440 by logical lines instead of visual lines, ignoring the value of
5441 the variable `line-move-visual'."
5443 (let ((line-move-visual nil))
5444 (with-no-warnings
5445 (previous-line arg try-vscroll))))
5447 (defgroup visual-line nil
5448 "Editing based on visual lines."
5449 :group 'convenience
5450 :version "23.1")
5452 (defvar visual-line-mode-map
5453 (let ((map (make-sparse-keymap)))
5454 (define-key map [remap kill-line] 'kill-visual-line)
5455 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
5456 (define-key map [remap move-end-of-line] 'end-of-visual-line)
5457 ;; These keybindings interfere with xterm function keys. Are
5458 ;; there any other suitable bindings?
5459 ;; (define-key map "\M-[" 'previous-logical-line)
5460 ;; (define-key map "\M-]" 'next-logical-line)
5461 map))
5463 (defcustom visual-line-fringe-indicators '(nil nil)
5464 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5465 The value should be a list of the form (LEFT RIGHT), where LEFT
5466 and RIGHT are symbols representing the bitmaps to display, to
5467 indicate wrapped lines, in the left and right fringes respectively.
5468 See also `fringe-indicator-alist'.
5469 The default is not to display fringe indicators for wrapped lines.
5470 This variable does not affect fringe indicators displayed for
5471 other purposes."
5472 :type '(list (choice (const :tag "Hide left indicator" nil)
5473 (const :tag "Left curly arrow" left-curly-arrow)
5474 (symbol :tag "Other bitmap"))
5475 (choice (const :tag "Hide right indicator" nil)
5476 (const :tag "Right curly arrow" right-curly-arrow)
5477 (symbol :tag "Other bitmap")))
5478 :set (lambda (symbol value)
5479 (dolist (buf (buffer-list))
5480 (with-current-buffer buf
5481 (when (and (boundp 'visual-line-mode)
5482 (symbol-value 'visual-line-mode))
5483 (setq fringe-indicator-alist
5484 (cons (cons 'continuation value)
5485 (assq-delete-all
5486 'continuation
5487 (copy-tree fringe-indicator-alist)))))))
5488 (set-default symbol value)))
5490 (defvar visual-line--saved-state nil)
5492 (define-minor-mode visual-line-mode
5493 "Toggle visual line based editing (Visual Line mode).
5494 With a prefix argument ARG, enable Visual Line mode if ARG is
5495 positive, and disable it otherwise. If called from Lisp, enable
5496 the mode if ARG is omitted or nil.
5498 When Visual Line mode is enabled, `word-wrap' is turned on in
5499 this buffer, and simple editing commands are redefined to act on
5500 visual lines, not logical lines. See Info node `Visual Line
5501 Mode' for details."
5502 :keymap visual-line-mode-map
5503 :group 'visual-line
5504 :lighter " Wrap"
5505 (if visual-line-mode
5506 (progn
5507 (set (make-local-variable 'visual-line--saved-state) nil)
5508 ;; Save the local values of some variables, to be restored if
5509 ;; visual-line-mode is turned off.
5510 (dolist (var '(line-move-visual truncate-lines
5511 truncate-partial-width-windows
5512 word-wrap fringe-indicator-alist))
5513 (if (local-variable-p var)
5514 (push (cons var (symbol-value var))
5515 visual-line--saved-state)))
5516 (set (make-local-variable 'line-move-visual) t)
5517 (set (make-local-variable 'truncate-partial-width-windows) nil)
5518 (setq truncate-lines nil
5519 word-wrap t
5520 fringe-indicator-alist
5521 (cons (cons 'continuation visual-line-fringe-indicators)
5522 fringe-indicator-alist)))
5523 (kill-local-variable 'line-move-visual)
5524 (kill-local-variable 'word-wrap)
5525 (kill-local-variable 'truncate-lines)
5526 (kill-local-variable 'truncate-partial-width-windows)
5527 (kill-local-variable 'fringe-indicator-alist)
5528 (dolist (saved visual-line--saved-state)
5529 (set (make-local-variable (car saved)) (cdr saved)))
5530 (kill-local-variable 'visual-line--saved-state)))
5532 (defun turn-on-visual-line-mode ()
5533 (visual-line-mode 1))
5535 (define-globalized-minor-mode global-visual-line-mode
5536 visual-line-mode turn-on-visual-line-mode)
5538 \f
5539 (defun transpose-chars (arg)
5540 "Interchange characters around point, moving forward one character.
5541 With prefix arg ARG, effect is to take character before point
5542 and drag it forward past ARG other characters (backward if ARG negative).
5543 If no argument and at end of line, the previous two chars are exchanged."
5544 (interactive "*P")
5545 (and (null arg) (eolp) (forward-char -1))
5546 (transpose-subr 'forward-char (prefix-numeric-value arg)))
5548 (defun transpose-words (arg)
5549 "Interchange words around point, leaving point at end of them.
5550 With prefix arg ARG, effect is to take word before or around point
5551 and drag it forward past ARG other words (backward if ARG negative).
5552 If ARG is zero, the words around or after point and around or after mark
5553 are interchanged."
5554 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5555 (interactive "*p")
5556 (transpose-subr 'forward-word arg))
5558 (defun transpose-sexps (arg)
5560 Does not work on a sexp that point is in the middle of
5561 if it is a list or string."
5562 (interactive "*p")
5563 (transpose-subr
5564 (lambda (arg)
5565 ;; Here we should try to simulate the behavior of
5566 ;; (cons (progn (forward-sexp x) (point))
5567 ;; (progn (forward-sexp (- x)) (point)))
5568 ;; Except that we don't want to rely on the second forward-sexp
5569 ;; putting us back to where we want to be, since forward-sexp-function
5570 ;; might do funny things like infix-precedence.
5571 (if (if (> arg 0)
5573 (and (not (bobp))
5575 ;; Jumping over a symbol. We might be inside it, mind you.
5576 (progn (funcall (if (> arg 0)
5577 'skip-syntax-backward 'skip-syntax-forward)
5578 "w_")
5579 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5580 ;; Otherwise, we're between sexps. Take a step back before jumping
5581 ;; to make sure we'll obey the same precedence no matter which direction
5582 ;; we're going.
5583 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5584 (cons (save-excursion (forward-sexp arg) (point))
5585 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5586 (not (zerop (funcall (if (> arg 0)
5587 'skip-syntax-forward
5588 'skip-syntax-backward)
5589 ".")))))
5590 (point)))))
5591 arg 'special))
5593 (defun transpose-lines (arg)
5594 "Exchange current line and previous line, leaving point after both.
5595 With argument ARG, takes previous line and moves it past ARG lines.
5596 With argument 0, interchanges line point is in with line mark is in."
5597 (interactive "*p")
5598 (transpose-subr (function
5599 (lambda (arg)
5600 (if (> arg 0)
5601 (progn
5602 ;; Move forward over ARG lines,
5603 ;; but create newlines if necessary.
5604 (setq arg (forward-line arg))
5606 (setq arg (1+ arg)))
5607 (if (> arg 0)
5608 (newline arg)))
5609 (forward-line arg))))
5610 arg))
5612 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5613 ;; which seems inconsistent with the ARG /= 0 case.
5614 ;; FIXME document SPECIAL.
5615 (defun transpose-subr (mover arg &optional special)
5616 "Subroutine to do the work of transposing objects.
5617 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5618 moves forward by units of the given object (e.g. forward-sentence,
5619 forward-paragraph). If ARG is zero, exchanges the current object
5620 with the one containing mark. If ARG is an integer, moves the
5621 current object past ARG following (if ARG is positive) or
5622 preceding (if ARG is negative) objects, leaving point after the
5623 current object."
5624 (let ((aux (if special mover
5625 (lambda (x)
5626 (cons (progn (funcall mover x) (point))
5627 (progn (funcall mover (- x)) (point))))))
5628 pos1 pos2)
5629 (cond
5630 ((= arg 0)
5631 (save-excursion
5632 (setq pos1 (funcall aux 1))
5633 (goto-char (or (mark) (error "No mark set in this buffer")))
5634 (setq pos2 (funcall aux 1))
5635 (transpose-subr-1 pos1 pos2))
5636 (exchange-point-and-mark))
5637 ((> arg 0)
5638 (setq pos1 (funcall aux -1))
5639 (setq pos2 (funcall aux arg))
5640 (transpose-subr-1 pos1 pos2)
5641 (goto-char (car pos2)))
5642 (t
5643 (setq pos1 (funcall aux -1))
5644 (goto-char (car pos1))
5645 (setq pos2 (funcall aux arg))
5646 (transpose-subr-1 pos1 pos2)))))
5648 (defun transpose-subr-1 (pos1 pos2)
5649 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5650 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5651 (when (> (car pos1) (car pos2))
5652 (let ((swap pos1))
5653 (setq pos1 pos2 pos2 swap)))
5654 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5655 (atomic-change-group
5656 ;; This sequence of insertions attempts to preserve marker
5657 ;; positions at the start and end of the transposed objects.
5658 (let* ((word (buffer-substring (car pos2) (cdr pos2)))
5659 (len1 (- (cdr pos1) (car pos1)))
5660 (len2 (length word))
5661 (boundary (make-marker)))
5662 (set-marker boundary (car pos2))
5663 (goto-char (cdr pos1))
5664 (insert-before-markers word)
5665 (setq word (delete-and-extract-region (car pos1) (+ (car pos1) len1)))
5666 (goto-char boundary)
5667 (insert word)
5668 (goto-char (+ boundary len1))
5669 (delete-region (point) (+ (point) len2))
5670 (set-marker boundary nil))))
5671 \f
5672 (defun backward-word (&optional arg)
5673 "Move backward until encountering the beginning of a word.
5674 With argument ARG, do this that many times.
5675 If ARG is omitted or nil, move point backward one word."
5676 (interactive "^p")
5677 (forward-word (- (or arg 1))))
5679 (defun mark-word (&optional arg allow-extend)
5680 "Set mark ARG words away from point.
5682 move to with the same argument.
5683 Interactively, if this command is repeated
5684 or (in Transient Mark mode) if the mark is active,
5685 it marks the next ARG words after the ones already marked."
5687 (cond ((and allow-extend
5688 (or (and (eq last-command this-command) (mark t))
5689 (region-active-p)))
5690 (setq arg (if arg (prefix-numeric-value arg)
5691 (if (< (mark) (point)) -1 1)))
5692 (set-mark
5693 (save-excursion
5694 (goto-char (mark))
5695 (forward-word arg)
5696 (point))))
5697 (t
5698 (push-mark
5699 (save-excursion
5700 (forward-word (prefix-numeric-value arg))
5701 (point))
5702 nil t))))
5704 (defun kill-word (arg)
5705 "Kill characters forward until encountering the end of a word.
5706 With argument ARG, do this that many times."
5707 (interactive "p")
5708 (kill-region (point) (progn (forward-word arg) (point))))
5710 (defun backward-kill-word (arg)
5711 "Kill characters backward until encountering the beginning of a word.
5712 With argument ARG, do this that many times."
5713 (interactive "p")
5714 (kill-word (- arg)))
5716 (defun current-word (&optional strict really-word)
5717 "Return the symbol or word that point is on (or a nearby one) as a string.
5718 The return value includes no text properties.
5719 If optional arg STRICT is non-nil, return nil unless point is within
5720 or adjacent to a symbol or word. In all cases the value can be nil
5721 if there is no word nearby.
5722 The function, belying its name, normally finds a symbol.
5723 If optional arg REALLY-WORD is non-nil, it finds just a word."
5724 (save-excursion
5725 (let* ((oldpoint (point)) (start (point)) (end (point))
5726 (syntaxes (if really-word "w" "w_"))
5727 (not-syntaxes (concat "^" syntaxes)))
5728 (skip-syntax-backward syntaxes) (setq start (point))
5729 (goto-char oldpoint)
5730 (skip-syntax-forward syntaxes) (setq end (point))
5731 (when (and (eq start oldpoint) (eq end oldpoint)
5732 ;; Point is neither within nor adjacent to a word.
5733 (not strict))
5734 ;; Look for preceding word in same line.
5735 (skip-syntax-backward not-syntaxes (line-beginning-position))
5736 (if (bolp)
5737 ;; No preceding word in same line.
5738 ;; Look for following word in same line.
5739 (progn
5740 (skip-syntax-forward not-syntaxes (line-end-position))
5741 (setq start (point))
5742 (skip-syntax-forward syntaxes)
5743 (setq end (point)))
5744 (setq end (point))
5745 (skip-syntax-backward syntaxes)
5746 (setq start (point))))
5747 ;; If we found something nonempty, return it as a string.
5748 (unless (= start end)
5749 (buffer-substring-no-properties start end)))))
5750 \f
5751 (defcustom fill-prefix nil
5752 "String for filling to insert at front of new line, or nil for none."
5753 :type '(choice (const :tag "None" nil)
5754 string)
5755 :group 'fill)
5756 (make-variable-buffer-local 'fill-prefix)
5757 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5759 (defcustom auto-fill-inhibit-regexp nil
5760 "Regexp to match lines which should not be auto-filled."
5761 :type '(choice (const :tag "None" nil)
5762 regexp)
5763 :group 'fill)
5765 (defun do-auto-fill ()
5766 "The default value for `normal-auto-fill-function'.
5767 This is the default auto-fill function, some major modes use a different one.
5768 Returns t if it really did any work."
5769 (let (fc justify give-up
5770 (fill-prefix fill-prefix))
5771 (if (or (not (setq justify (current-justification)))
5772 (null (setq fc (current-fill-column)))
5773 (and (eq justify 'left)
5774 (<= (current-column) fc))
5775 (and auto-fill-inhibit-regexp
5776 (save-excursion (beginning-of-line)
5777 (looking-at auto-fill-inhibit-regexp))))
5778 nil ;; Auto-filling not required
5779 (if (memq justify '(full center right))
5780 (save-excursion (unjustify-current-line)))
5782 ;; Choose a fill-prefix automatically.
5783 (when (and adaptive-fill-mode
5784 (or (null fill-prefix) (string= fill-prefix "")))
5785 (let ((prefix
5786 (fill-context-prefix
5787 (save-excursion (fill-forward-paragraph -1) (point))
5788 (save-excursion (fill-forward-paragraph 1) (point)))))
5789 (and prefix (not (equal prefix ""))
5790 ;; Use auto-indentation rather than a guessed empty prefix.
5791 (not (and fill-indent-according-to-mode
5793 (setq fill-prefix prefix))))
5795 (while (and (not give-up) (> (current-column) fc))
5796 ;; Determine where to split the line.
5797 (let* (after-prefix
5798 (fill-point
5799 (save-excursion
5800 (beginning-of-line)
5801 (setq after-prefix (point))
5802 (and fill-prefix
5803 (looking-at (regexp-quote fill-prefix))
5804 (setq after-prefix (match-end 0)))
5805 (move-to-column (1+ fc))
5806 (fill-move-to-break-point after-prefix)
5807 (point))))
5809 ;; See whether the place we found is any good.
5810 (if (save-excursion
5811 (goto-char fill-point)
5812 (or (bolp)
5813 ;; There is no use breaking at end of line.
5814 (save-excursion (skip-chars-forward " ") (eolp))
5815 ;; It is futile to split at the end of the prefix
5816 ;; since we would just insert the prefix again.
5817 (and after-prefix (<= (point) after-prefix))
5818 ;; Don't split right after a comment starter
5819 ;; since we would just make another comment starter.
5820 (and comment-start-skip
5821 (let ((limit (point)))
5822 (beginning-of-line)
5823 (and (re-search-forward comment-start-skip
5824 limit t)
5825 (eq (point) limit))))))
5826 ;; No good place to break => stop trying.
5827 (setq give-up t)
5828 ;; Ok, we have a useful place to break the line. Do it.
5829 (let ((prev-column (current-column)))
5830 ;; If point is at the fill-point, do not `save-excursion'.
5831 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5832 ;; point will end up before it rather than after it.
5833 (if (save-excursion
5835 (= (point) fill-point))
5836 (default-indent-new-line t)
5837 (save-excursion
5838 (goto-char fill-point)
5839 (default-indent-new-line t)))
5840 ;; Now do justification, if required
5841 (if (not (eq justify 'left))
5842 (save-excursion
5843 (end-of-line 0)
5844 (justify-current-line justify nil t)))
5845 ;; If making the new line didn't reduce the hpos of
5846 ;; the end of the line, then give up now;
5847 ;; trying again will not help.
5848 (if (>= (current-column) prev-column)
5849 (setq give-up t))))))
5850 ;; Justify last line.
5851 (justify-current-line justify t t)
5852 t)))
5854 (defvar comment-line-break-function 'comment-indent-new-line
5855 "Mode-specific function which line breaks and continues a comment.
5856 This function is called during auto-filling when a comment syntax
5857 is defined.
5858 The function should take a single optional argument, which is a flag
5859 indicating whether it should use soft newlines.")
5861 (defun default-indent-new-line (&optional soft)
5862 "Break line at point and indent.
5863 If a comment syntax is defined, call `comment-indent-new-line'.
5865 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5866 unless optional argument SOFT is non-nil."
5867 (interactive)
5868 (if comment-start
5869 (funcall comment-line-break-function soft)
5870 ;; Insert the newline before removing empty space so that markers
5871 ;; get preserved better.
5873 (save-excursion (forward-char -1) (delete-horizontal-space))
5874 (delete-horizontal-space)
5876 (if (and fill-prefix (not adaptive-fill-mode))
5877 ;; Blindly trust a non-adaptive fill-prefix.
5878 (progn
5879 (indent-to-left-margin)
5880 (insert-before-markers-and-inherit fill-prefix))
5882 (cond
5883 ;; If there's an adaptive prefix, use it unless we're inside
5884 ;; a comment and the prefix is not a comment starter.
5885 (fill-prefix
5886 (indent-to-left-margin)
5887 (insert-and-inherit fill-prefix))
5888 ;; If we're not inside a comment, just try to indent.
5889 (t (indent-according-to-mode))))))
5891 (defvar normal-auto-fill-function 'do-auto-fill
5892 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5893 Some major modes set this.")
5895 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5896 ;; `functions' and `hooks' are usually unsafe to set, but setting
5897 ;; auto-fill-function to nil in a file-local setting is safe and
5898 ;; can be useful to prevent auto-filling.
5899 (put 'auto-fill-function 'safe-local-variable 'null)
5901 (define-minor-mode auto-fill-mode
5902 "Toggle automatic line breaking (Auto Fill mode).
5903 With a prefix argument ARG, enable Auto Fill mode if ARG is
5904 positive, and disable it otherwise. If called from Lisp, enable
5905 the mode if ARG is omitted or nil.
5907 When Auto Fill mode is enabled, inserting a space at a column
5908 beyond `current-fill-column' automatically breaks the line at a
5909 previous space.
5911 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5912 non-`nil'.
5914 The value of `normal-auto-fill-function' specifies the function to use
5915 for `auto-fill-function' when turning Auto Fill mode on."
5916 :variable (auto-fill-function
5917 . (lambda (v) (setq auto-fill-function
5918 (if v normal-auto-fill-function)))))
5920 ;; This holds a document string used to document auto-fill-mode.
5921 (defun auto-fill-function ()
5922 "Automatically break line at a previous space, in insertion of text."
5923 nil)
5925 (defun turn-on-auto-fill ()
5926 "Unconditionally turn on Auto Fill mode."
5927 (auto-fill-mode 1))
5929 (defun turn-off-auto-fill ()
5930 "Unconditionally turn off Auto Fill mode."
5931 (auto-fill-mode -1))
5933 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5935 (defun set-fill-column (arg)
5936 "Set `fill-column' to specified argument.
5939 (interactive
5940 (list (or current-prefix-arg
5941 ;; We used to use current-column silently, but C-x f is too easily
5942 ;; typed as a typo for C-x C-f, so we turned it into an error and
5943 ;; now an interactive prompt.
5944 (read-number "Set fill-column to: " (current-column)))))
5945 (if (consp arg)
5946 (setq arg (current-column)))
5947 (if (not (integerp arg))
5948 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5949 (error "set-fill-column requires an explicit argument")
5950 (message "Fill column set to %d (was %d)" arg fill-column)
5951 (setq fill-column arg)))
5952 \f
5953 (defun set-selective-display (arg)
5954 "Set `selective-display' to ARG; clear it if no arg.
5955 When the value of `selective-display' is a number > 0,
5956 lines whose indentation is >= that value are not displayed.
5957 The variable `selective-display' has a separate value for each buffer."
5958 (interactive "P")
5959 (if (eq selective-display t)
5960 (error "selective-display already in use for marked lines"))
5961 (let ((current-vpos
5962 (save-restriction
5963 (narrow-to-region (point-min) (point))
5964 (goto-char (window-start))
5965 (vertical-motion (window-height)))))
5966 (setq selective-display
5967 (and arg (prefix-numeric-value arg)))
5968 (recenter current-vpos))
5969 (set-window-start (selected-window) (window-start))
5970 (princ "selective-display set to " t)
5971 (prin1 selective-display t)
5972 (princ "." t))
5974 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5976 (defun toggle-truncate-lines (&optional arg)
5977 "Toggle truncating of long lines for the current buffer.
5978 When truncating is off, long lines are folded.
5979 With prefix argument ARG, truncate long lines if ARG is positive,
5980 otherwise fold them. Note that in side-by-side windows, this
5981 command has no effect if `truncate-partial-width-windows' is
5982 non-nil."
5983 (interactive "P")
5984 (setq truncate-lines
5985 (if (null arg)
5986 (not truncate-lines)
5987 (> (prefix-numeric-value arg) 0)))
5988 (force-mode-line-update)
5989 (unless truncate-lines
5990 (let ((buffer (current-buffer)))
5991 (walk-windows (lambda (window)
5992 (if (eq buffer (window-buffer window))
5993 (set-window-hscroll window 0)))
5994 nil t)))
5995 (message "Truncate long lines %s"
5996 (if truncate-lines "enabled" "disabled")))
5998 (defun toggle-word-wrap (&optional arg)
5999 "Toggle whether to use word-wrapping for continuation lines.
6000 With prefix argument ARG, wrap continuation lines at word boundaries
6001 if ARG is positive, otherwise wrap them at the right screen edge.
6002 This command toggles the value of `word-wrap'. It has no effect
6003 if long lines are truncated."
6004 (interactive "P")
6005 (setq word-wrap
6006 (if (null arg)
6007 (not word-wrap)
6008 (> (prefix-numeric-value arg) 0)))
6009 (force-mode-line-update)
6010 (message "Word wrapping %s"
6011 (if word-wrap "enabled" "disabled")))
6013 (defvar overwrite-mode-textual (purecopy " Ovwrt")
6014 "The string displayed in the mode line when in overwrite mode.")
6015 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
6016 "The string displayed in the mode line when in binary overwrite mode.")
6018 (define-minor-mode overwrite-mode
6019 "Toggle Overwrite mode.
6020 With a prefix argument ARG, enable Overwrite mode if ARG is
6021 positive, and disable it otherwise. If called from Lisp, enable
6022 the mode if ARG is omitted or nil.
6024 When Overwrite mode is enabled, printing characters typed in
6025 replace existing text on a one-for-one basis, rather than pushing
6026 it to the right. At the end of a line, such characters extend
6027 the line. Before a tab, such characters insert until the tab is
6029 overwrite mode; this is supposed to make it easier to insert
6030 characters when necessary."
6031 :variable (overwrite-mode
6032 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-textual)))))
6034 (define-minor-mode binary-overwrite-mode
6035 "Toggle Binary Overwrite mode.
6036 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6037 is positive, and disable it otherwise. If called from Lisp,
6038 enable the mode if ARG is omitted or nil.
6040 When Binary Overwrite mode is enabled, printing characters typed
6041 in replace existing text. Newlines are not treated specially, so
6042 typing at the end of a line joins the line to the next, with the
6043 typed character between them. Typing before a tab character
6044 simply replaces the tab with the character typed.
6046 ordinary typing characters do.
6048 Note that Binary Overwrite mode is not its own minor mode; it is
6049 a specialization of overwrite mode, entered by setting the
6050 `overwrite-mode' variable to `overwrite-mode-binary'."
6051 :variable (overwrite-mode
6052 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-binary)))))
6054 (define-minor-mode line-number-mode
6055 "Toggle line number display in the mode line (Line Number mode).
6056 With a prefix argument ARG, enable Line Number mode if ARG is
6057 positive, and disable it otherwise. If called from Lisp, enable
6058 the mode if ARG is omitted or nil.
6060 Line numbers do not appear for very large buffers and buffers
6061 with very long lines; see variables `line-number-display-limit'
6062 and `line-number-display-limit-width'."
6063 :init-value t :global t :group 'mode-line)
6065 (define-minor-mode column-number-mode
6066 "Toggle column number display in the mode line (Column Number mode).
6067 With a prefix argument ARG, enable Column Number mode if ARG is
6068 positive, and disable it otherwise.
6070 If called from Lisp, enable the mode if ARG is omitted or nil."
6071 :global t :group 'mode-line)
6073 (define-minor-mode size-indication-mode
6074 "Toggle buffer size display in the mode line (Size Indication mode).
6075 With a prefix argument ARG, enable Size Indication mode if ARG is
6076 positive, and disable it otherwise.
6078 If called from Lisp, enable the mode if ARG is omitted or nil."
6079 :global t :group 'mode-line)
6081 (define-minor-mode auto-save-mode
6082 "Toggle auto-saving in the current buffer (Auto Save mode).
6083 With a prefix argument ARG, enable Auto Save mode if ARG is
6084 positive, and disable it otherwise.
6086 If called from Lisp, enable the mode if ARG is omitted or nil."
6087 :variable ((and buffer-auto-save-file-name
6088 ;; If auto-save is off because buffer has shrunk,
6089 ;; then toggling should turn it on.
6090 (>= buffer-saved-size 0))
6091 . (lambda (val)
6092 (setq buffer-auto-save-file-name
6093 (cond
6094 ((null val) nil)
6095 ((and buffer-file-name auto-save-visited-file-name
6096 (not buffer-read-only))
6097 buffer-file-name)
6098 (t (make-auto-save-file-name))))))
6099 ;; If -1 was stored here, to temporarily turn off saving,
6100 ;; turn it back on.
6101 (and (< buffer-saved-size 0)
6102 (setq buffer-saved-size 0)))
6103 \f
6104 (defgroup paren-blinking nil
6105 "Blinking matching of parens and expressions."
6106 :prefix "blink-matching-"
6107 :group 'paren-matching)
6109 (defcustom blink-matching-paren t
6110 "Non-nil means show matching open-paren when close-paren is inserted."
6111 :type 'boolean
6112 :group 'paren-blinking)
6114 (defcustom blink-matching-paren-on-screen t
6115 "Non-nil means show matching open-paren when it is on screen.
6116 If nil, don't show it (but the open-paren can still be shown
6117 when it is off screen).
6119 This variable has no effect if `blink-matching-paren' is nil.
6120 \(In that case, the open-paren is never shown.)
6121 It is also ignored if `show-paren-mode' is enabled."
6122 :type 'boolean
6123 :group 'paren-blinking)
6125 (defcustom blink-matching-paren-distance (* 100 1024)
6126 "If non-nil, maximum distance to search backwards for matching open-paren.
6127 If nil, search stops at the beginning of the accessible portion of the buffer."
6128 :version "23.2" ; 25->100k
6129 :type '(choice (const nil) integer)
6130 :group 'paren-blinking)
6132 (defcustom blink-matching-delay 1
6133 "Time in seconds to delay after showing a matching paren."
6134 :type 'number
6135 :group 'paren-blinking)
6137 (defcustom blink-matching-paren-dont-ignore-comments nil
6138 "If nil, `blink-matching-paren' ignores comments.
6139 More precisely, when looking for the matching parenthesis,
6140 it skips the contents of comments that end before point."
6141 :type 'boolean
6142 :group 'paren-blinking)
6144 (defun blink-matching-check-mismatch (start end)
6145 "Return whether or not START...END are matching parens.
6146 END is the current point and START is the blink position.
6147 START might be nil if no matching starter was found.
6148 Returns non-nil if we find there is a mismatch."
6149 (let* ((end-syntax (syntax-after (1- end)))
6150 (matching-paren (and (consp end-syntax)
6151 (eq (syntax-class end-syntax) 5)
6152 (cdr end-syntax))))
6153 ;; For self-matched chars like " and $, we can't know when they're
6154 ;; mismatched or unmatched, so we can only do it for parens.
6155 (when matching-paren
6156 (not (and start
6157 (or
6158 (eq (char-after start) matching-paren)
6159 ;; The cdr might hold a new paren-class info rather than
6160 ;; a matching-char info, in which case the two CDRs
6161 ;; should match.
6162 (eq matching-paren (cdr-safe (syntax-after start)))))))))
6164 (defvar blink-matching-check-function #'blink-matching-check-mismatch
6165 "Function to check parentheses mismatches.
6166 The function takes two arguments (START and END) where START is the
6167 position just before the opening token and END is the position right after.
6168 START can be nil, if it was not found.
6169 The function should return non-nil if the two tokens do not match.")
6171 (defun blink-matching-open ()
6172 "Move cursor momentarily to the beginning of the sexp before point."
6173 (interactive)
6174 (when (and (not (bobp))
6175 blink-matching-paren)
6176 (let* ((oldpos (point))
6177 (message-log-max nil) ; Don't log messages about paren matching.
6178 (blinkpos
6179 (save-excursion
6180 (save-restriction
6181 (if blink-matching-paren-distance
6182 (narrow-to-region
6183 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
6184 (- (point) blink-matching-paren-distance))
6185 oldpos))
6186 (let ((parse-sexp-ignore-comments
6187 (and parse-sexp-ignore-comments
6188 (not blink-matching-paren-dont-ignore-comments))))
6189 (condition-case ()
6190 (progn
6191 (forward-sexp -1)
6192 ;; backward-sexp skips backward over prefix chars,
6193 ;; so move back to the matching paren.
6194 (while (and (< (point) (1- oldpos))
6195 (let ((code (syntax-after (point))))
6196 (or (eq (syntax-class code) 6)
6197 (eq (logand 1048576 (car code))
6198 1048576))))
6199 (forward-char 1))
6200 (point))
6201 (error nil))))))
6202 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
6203 (cond
6204 (mismatch
6205 (if blinkpos
6206 (if (minibufferp)
6207 (minibuffer-message "Mismatched parentheses")
6208 (message "Mismatched parentheses"))
6209 (if (minibufferp)
6210 (minibuffer-message "No matching parenthesis found")
6211 (message "No matching parenthesis found"))))
6212 ((not blinkpos) nil)
6213 ((pos-visible-in-window-p blinkpos)
6214 ;; Matching open within window, temporarily move to blinkpos but only
6215 ;; if `blink-matching-paren-on-screen' is non-nil.
6216 (and blink-matching-paren-on-screen
6217 (not show-paren-mode)
6218 (save-excursion
6219 (goto-char blinkpos)
6220 (sit-for blink-matching-delay))))
6221 (t
6222 (save-excursion
6223 (goto-char blinkpos)
6224 (let ((open-paren-line-string
6225 ;; Show what precedes the open in its line, if anything.
6226 (cond
6228 (buffer-substring (line-beginning-position)
6229 (1+ blinkpos)))
6230 ;; Show what follows the open in its line, if anything.
6231 ((save-excursion
6232 (forward-char 1)
6234 (not (eolp)))
6235 (buffer-substring blinkpos
6236 (line-end-position)))
6237 ;; Otherwise show the previous nonblank line,
6238 ;; if there is one.
6240 (concat
6241 (buffer-substring (progn
6243 (line-beginning-position))
6244 (progn (end-of-line)
6246 (point)))
6247 ;; Replace the newline and other whitespace with `...'.
6248 "..."
6249 (buffer-substring blinkpos (1+ blinkpos))))
6250 ;; There is nothing to show except the char itself.
6251 (t (buffer-substring blinkpos (1+ blinkpos))))))
6252 (message "Matches %s"
6253 (substring-no-properties open-paren-line-string)))))))))
6255 (defvar blink-paren-function 'blink-matching-open
6256 "Function called, if non-nil, whenever a close parenthesis is inserted.
6257 More precisely, a char with closeparen syntax is self-inserted.")
6259 (defun blink-paren-post-self-insert-function ()
6260 (when (and (eq (char-before) last-command-event) ; Sanity check.
6261 (memq (char-syntax last-command-event) '(?\) ?\$))
6262 blink-paren-function
6263 (not executing-kbd-macro)
6264 (not noninteractive)
6265 ;; Verify an even number of quoting characters precede the close.
6266 (= 1 (logand 1 (- (point)
6267 (save-excursion
6268 (forward-char -1)
6270 (point))))))
6271 (funcall blink-paren-function)))
6273 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
6274 ;; Most likely, this hook is nil, so this arg doesn't matter,
6275 ;; but I use it as a reminder that this function usually
6276 ;; likes to be run after others since it does `sit-for'.
6277 'append)
6278 \f
6279 ;; This executes C-g typed while Emacs is waiting for a command.
6280 ;; Quitting out of a program does not go through here;
6281 ;; that happens in the QUIT macro at the C code level.
6282 (defun keyboard-quit ()
6283 "Signal a `quit' condition.
6284 During execution of Lisp code, this character causes a quit directly.
6285 At top-level, as an editor command, this simply beeps."
6286 (interactive)
6287 ;; Avoid adding the region to the window selection.
6288 (setq saved-region-selection nil)
6289 (let (select-active-regions)
6290 (deactivate-mark))
6291 (if (fboundp 'kmacro-keyboard-quit)
6292 (kmacro-keyboard-quit))
6293 (setq defining-kbd-macro nil)
6294 (let ((debug-on-quit nil))
6295 (signal 'quit nil)))
6297 (defvar buffer-quit-function nil
6300 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
6302 (defun keyboard-escape-quit ()
6304 This command can exit an interactive command such as `query-replace',
6305 can clear out a prefix argument or a region,
6306 can get out of the minibuffer or other recursive edit,
6307 cancel the use of the current buffer (for special-purpose buffers),
6308 or go back to just one window (by deleting all but the selected window)."
6309 (interactive)
6310 (cond ((eq last-command 'mode-exited) nil)
6311 ((region-active-p)
6312 (deactivate-mark))
6313 ((> (minibuffer-depth) 0)
6314 (abort-recursive-edit))
6315 (current-prefix-arg
6316 nil)
6317 ((> (recursion-depth) 0)
6318 (exit-recursive-edit))
6319 (buffer-quit-function
6320 (funcall buffer-quit-function))
6321 ((not (one-window-p t))
6322 (delete-other-windows))
6324 (bury-buffer))))
6326 (defun play-sound-file (file &optional volume device)
6327 "Play sound stored in FILE.
6328 VOLUME and DEVICE correspond to the keywords of the sound
6329 specification for `play-sound'."
6330 (interactive "fPlay sound file: ")
6331 (let ((sound (list :file file)))
6332 (if volume
6333 (plist-put sound :volume volume))
6334 (if device
6335 (plist-put sound :device device))
6336 (push 'sound sound)
6337 (play-sound sound)))
6339 \f
6340 (defcustom read-mail-command 'rmail
6341 "Your preference for a mail reading package.
6342 This is used by some keybindings which support reading mail.
6343 See also `mail-user-agent' concerning sending mail."
6346 (function-item :tag "Emacs interface to MH"
6348 (function :tag "Other"))
6349 :version "21.1"
6350 :group 'mail)
6352 (defcustom mail-user-agent 'message-user-agent
6353 "Your preference for a mail composition package.
6354 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6355 outgoing email message. This variable lets you specify which
6356 mail-sending package you prefer.
6358 Valid values include:
6360 `message-user-agent' -- use the Message package.
6361 See Info node `(message)'.
6362 `sendmail-user-agent' -- use the Mail package.
6363 See Info node `(emacs)Sending Mail'.
6364 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6365 See Info node `(mh-e)'.
6366 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6367 paraphernalia if Gnus is running, particularly
6368 the Gcc: header for archiving.
6370 Additional valid symbols may be available; check with the author of
6371 your package for details. The function should return non-nil if it
6372 succeeds.
6374 See also `read-mail-command' concerning reading mail."
6375 :type '(radio (function-item :tag "Message package"
6377 message-user-agent)
6378 (function-item :tag "Mail package"
6380 sendmail-user-agent)
6381 (function-item :tag "Emacs interface to MH"
6383 mh-e-user-agent)
6384 (function-item :tag "Message with full Gnus features"
6386 gnus-user-agent)
6387 (function :tag "Other"))
6388 :version "23.2" ; sendmail->message
6389 :group 'mail)
6391 (defcustom compose-mail-user-agent-warnings t
6392 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6393 If the value of `mail-user-agent' is the default, and the user
6394 appears to have customizations applying to the old default,
6395 `compose-mail' issues a warning."
6396 :type 'boolean
6397 :version "23.2"
6398 :group 'mail)
6400 (defun rfc822-goto-eoh ()
6401 "If the buffer starts with a mail header, move point to the header's end.
6402 Otherwise, moves to `point-min'.
6403 The end of the header is the start of the next line, if there is one,
6404 else the end of the last line. This function obeys RFC822."
6405 (goto-char (point-min))
6406 (when (re-search-forward
6408 (goto-char (match-beginning 0))))
6410 ;; Used by Rmail (e.g., rmail-forward).
6411 (defvar mail-encode-mml nil
6412 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6413 the outgoing message before sending it.")
6415 (defun compose-mail (&optional to subject other-headers continue
6416 switch-function yank-action send-actions
6417 return-action)
6418 "Start composing a mail message to send.
6419 This uses the user's chosen mail composition package
6420 as selected with the variable `mail-user-agent'.
6421 The optional arguments TO and SUBJECT specify recipients
6422 and the initial Subject field, respectively.
6424 OTHER-HEADERS is an alist specifying additional
6425 header fields. Elements look like (HEADER . VALUE) where both
6426 HEADER and VALUE are strings.
6428 CONTINUE, if non-nil, says to continue editing a message already
6429 being composed. Interactively, CONTINUE is the prefix argument.
6431 SWITCH-FUNCTION, if non-nil, is a function to use to
6432 switch to and display the buffer used for mail composition.
6434 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6435 to insert the raw text of the message being replied to.
6436 It has the form (FUNCTION . ARGS). The user agent will apply
6437 FUNCTION to ARGS, to insert the raw text of the original message.
6438 \(The user agent will also run `mail-citation-hook', *after* the
6439 original text has been inserted in this way.)
6441 SEND-ACTIONS is a list of actions to call when the message is sent.
6442 Each action has the form (FUNCTION . ARGS).
6444 RETURN-ACTION, if non-nil, is an action for returning to the
6445 caller. It has the form (FUNCTION . ARGS). The function is
6446 called after the mail has been sent or put aside, and the mail
6447 buffer buried."
6448 (interactive
6449 (list nil nil nil current-prefix-arg))
6451 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6452 ;; from sendmail-user-agent to message-user-agent. Some users may
6453 ;; encounter incompatibilities. This hack tries to detect problems
6454 ;; and warn about them.
6455 (and compose-mail-user-agent-warnings
6456 (eq mail-user-agent 'message-user-agent)
6457 (let (warn-vars)
6458 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
6459 mail-yank-hooks mail-archive-file-name
6460 mail-default-reply-to mail-mailing-lists
6461 mail-self-blind))
6462 (and (boundp var)
6463 (symbol-value var)
6464 (push var warn-vars)))
6465 (when warn-vars
6466 (display-warning 'mail
6467 (format "\
6468 The default mail mode is now Message mode.
6469 You have the following Mail mode variable%s customized:
6471 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6472 (if (> (length warn-vars) 1) "s" "")
6473 (mapconcat 'symbol-name
6474 warn-vars " "))))))
6476 (let ((function (get mail-user-agent 'composefunc)))
6477 (funcall function to subject other-headers continue switch-function
6478 yank-action send-actions return-action)))
6480 (defun compose-mail-other-window (&optional to subject other-headers continue
6481 yank-action send-actions
6482 return-action)
6484 (interactive (list nil nil nil current-prefix-arg))
6485 (compose-mail to subject other-headers continue
6486 'switch-to-buffer-other-window yank-action send-actions
6487 return-action))
6489 (defun compose-mail-other-frame (&optional to subject other-headers continue
6490 yank-action send-actions
6491 return-action)
6493 (interactive (list nil nil nil current-prefix-arg))
6494 (compose-mail to subject other-headers continue
6495 'switch-to-buffer-other-frame yank-action send-actions
6496 return-action))
6498 \f
6499 (defvar set-variable-value-history nil
6500 "History of values entered with `set-variable'.
6502 Maximum length of the history list is determined by the value
6503 of `history-length', which see.")
6505 (defun set-variable (variable value &optional make-local)
6506 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6507 VARIABLE should be a user option variable name, a Lisp variable
6508 meant to be customized by users. You should enter VALUE in Lisp syntax,
6509 so if you want VALUE to be a string, you must surround it with doublequotes.
6510 VALUE is used literally, not evaluated.
6512 If VARIABLE has a `variable-interactive' property, that is used as if
6513 it were the arg to `interactive' (which see) to interactively read VALUE.
6515 If VARIABLE has been defined with `defcustom', then the type information
6516 in the definition is used to check that VALUE is valid.
6518 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6519 (interactive
6520 (let* ((default-var (variable-at-point))
6521 (var (if (custom-variable-p default-var)
6522 (read-variable (format "Set variable (default %s): " default-var)
6523 default-var)
6524 (read-variable "Set variable: ")))
6525 (minibuffer-help-form '(describe-variable var))
6526 (prop (get var 'variable-interactive))
6527 (obsolete (car (get var 'byte-obsolete-variable)))
6528 (prompt (format "Set %s %s to value: " var
6529 (cond ((local-variable-p var)
6530 "(buffer-local)")
6531 ((or current-prefix-arg
6532 (local-variable-if-set-p var))
6533 "buffer-locally")
6534 (t "globally"))))
6535 (val (progn
6536 (when obsolete
6537 (message (concat "`%S' is obsolete; "
6538 (if (symbolp obsolete) "use `%S' instead" "%s"))
6539 var obsolete)
6540 (sit-for 3))
6541 (if prop
6542 ;; Use VAR's `variable-interactive' property
6543 ;; as an interactive spec for prompting.
6544 (call-interactively `(lambda (arg)
6545 (interactive ,prop)
6546 arg))
6547 (read-from-minibuffer prompt nil
6548 read-expression-map t
6549 'set-variable-value-history
6550 (format "%S" (symbol-value var)))))))
6551 (list var val current-prefix-arg)))
6553 (and (custom-variable-p variable)
6554 (not (get variable 'custom-type))
6555 (custom-load-symbol variable))
6556 (let ((type (get variable 'custom-type)))
6557 (when type
6558 ;; Match with custom type.
6559 (require 'cus-edit)
6560 (setq type (widget-convert type))
6561 (unless (widget-apply type :match value)
6562 (error "Value `%S' does not match type %S of %S"
6563 value (car type) variable))))
6565 (if make-local
6566 (make-local-variable variable))
6568 (set variable value)
6570 ;; Force a thorough redisplay for the case that the variable
6571 ;; has an effect on the display, like `tab-width' has.
6572 (force-mode-line-update))
6573 \f
6574 ;; Define the major mode for lists of completions.
6576 (defvar completion-list-mode-map
6577 (let ((map (make-sparse-keymap)))
6578 (define-key map [mouse-2] 'mouse-choose-completion)
6579 (define-key map [follow-link] 'mouse-face)
6580 (define-key map [down-mouse-2] nil)
6581 (define-key map "\C-m" 'choose-completion)
6582 (define-key map "\e\e\e" 'delete-completion-window)
6583 (define-key map [left] 'previous-completion)
6584 (define-key map [right] 'next-completion)
6585 (define-key map "q" 'quit-window)
6586 (define-key map "z" 'kill-this-buffer)
6587 map)
6588 "Local map for completion list buffers.")
6590 ;; Completion mode is suitable only for specially formatted data.
6591 (put 'completion-list-mode 'mode-class 'special)
6593 (defvar completion-reference-buffer nil
6594 "Record the buffer that was current when the completion list was requested.
6595 This is a local variable in the completion list buffer.
6596 Initial value is nil to avoid some compiler warnings.")
6598 (defvar completion-no-auto-exit nil
6599 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6600 This also applies to other functions such as `choose-completion'.")
6602 (defvar completion-base-position nil
6603 "Position of the base of the text corresponding to the shown completions.
6604 This variable is used in the *Completions* buffers.
6605 Its value is a list of the form (START END) where START is the place
6606 where the completion should be inserted and END (if non-nil) is the end
6607 of the text to replace. If END is nil, point is used instead.")
6609 (defvar completion-list-insert-choice-function #'completion--replace
6610 "Function to use to insert the text chosen in *Completions*.
6611 Called with three arguments (BEG END TEXT), it should replace the text
6612 between BEG and END with TEXT. Expected to be set buffer-locally
6613 in the *Completions* buffer.")
6615 (defvar completion-base-size nil
6616 "Number of chars before point not involved in completion.
6617 This is a local variable in the completion list buffer.
6618 It refers to the chars in the minibuffer if completing in the
6619 minibuffer, or in `completion-reference-buffer' otherwise.
6620 Only characters in the field at point are included.
6622 If nil, Emacs determines which part of the tail end of the
6623 buffer's text is involved in completion by comparing the text
6624 directly.")
6625 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6627 (defun delete-completion-window ()
6628 "Delete the completion list window.
6629 Go to the window from which completion was requested."
6630 (interactive)
6631 (let ((buf completion-reference-buffer))
6632 (if (one-window-p t)
6633 (if (window-dedicated-p) (delete-frame))
6634 (delete-window (selected-window))
6635 (if (get-buffer-window buf)
6636 (select-window (get-buffer-window buf))))))
6638 (defun previous-completion (n)
6639 "Move to the previous item in the completion list."
6640 (interactive "p")
6641 (next-completion (- n)))
6643 (defun next-completion (n)
6644 "Move to the next item in the completion list.
6645 With prefix argument N, move N items (negative N means move backward)."
6646 (interactive "p")
6647 (let ((beg (point-min)) (end (point-max)))
6648 (while (and (> n 0) (not (eobp)))
6649 ;; If in a completion, move to the end of it.
6650 (when (get-text-property (point) 'mouse-face)
6651 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6652 ;; Move to start of next one.
6653 (unless (get-text-property (point) 'mouse-face)
6654 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6655 (setq n (1- n)))
6656 (while (and (< n 0) (not (bobp)))
6657 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6658 ;; If in a completion, move to the start of it.
6659 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6660 (goto-char (previous-single-property-change
6661 (point) 'mouse-face nil beg)))
6662 ;; Move to end of the previous completion.
6663 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6664 (goto-char (previous-single-property-change
6665 (point) 'mouse-face nil beg)))
6666 ;; Move to the start of that one.
6667 (goto-char (previous-single-property-change
6668 (point) 'mouse-face nil beg))
6669 (setq n (1+ n))))))
6671 (defun choose-completion (&optional event)
6672 "Choose the completion at point."
6673 (interactive (list last-nonmenu-event))
6674 ;; In case this is run via the mouse, give temporary modes such as
6675 ;; isearch a chance to turn off.
6676 (run-hooks 'mouse-leave-buffer-hook)
6677 (with-current-buffer (window-buffer (posn-window (event-start event)))
6678 (let ((buffer completion-reference-buffer)
6679 (base-size completion-base-size)
6680 (base-position completion-base-position)
6681 (insert-function completion-list-insert-choice-function)
6682 (choice
6683 (save-excursion
6684 (goto-char (posn-point (event-start event)))
6685 (let (beg end)
6686 (cond
6687 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6688 (setq end (point) beg (1+ (point))))
6689 ((and (not (bobp))
6690 (get-text-property (1- (point)) 'mouse-face))
6691 (setq end (1- (point)) beg (point)))
6692 (t (error "No completion here")))
6693 (setq beg (previous-single-property-change beg 'mouse-face))
6694 (setq end (or (next-single-property-change end 'mouse-face)
6695 (point-max)))
6696 (buffer-substring-no-properties beg end)))))
6698 (unless (buffer-live-p buffer)
6699 (error "Destination buffer is dead"))
6700 (quit-window nil (posn-window (event-start event)))
6702 (with-current-buffer buffer
6703 (choose-completion-string
6704 choice buffer
6705 (or base-position
6706 (when base-size
6707 ;; Someone's using old completion code that doesn't know
6708 ;; about base-position yet.
6709 (list (+ base-size (field-beginning))))
6710 ;; If all else fails, just guess.
6711 (list (choose-completion-guess-base-position choice)))
6712 insert-function)))))
6714 ;; Delete the longest partial match for STRING
6715 ;; that can be found before POINT.
6716 (defun choose-completion-guess-base-position (string)
6717 (save-excursion
6718 (let ((opoint (point))
6719 len)
6720 ;; Try moving back by the length of the string.
6721 (goto-char (max (- (point) (length string))
6722 (minibuffer-prompt-end)))
6723 ;; See how far back we were actually able to move. That is the
6724 ;; upper bound on how much we can match and delete.
6725 (setq len (- opoint (point)))
6726 (if completion-ignore-case
6727 (setq string (downcase string)))
6728 (while (and (> len 0)
6729 (let ((tail (buffer-substring (point) opoint)))
6730 (if completion-ignore-case
6731 (setq tail (downcase tail)))
6732 (not (string= tail (substring string 0 len)))))
6733 (setq len (1- len))
6734 (forward-char 1))
6735 (point))))
6737 (defun choose-completion-delete-max-match (string)
6738 (declare (obsolete choose-completion-guess-base-position "23.2"))
6739 (delete-region (choose-completion-guess-base-position string) (point)))
6741 (defvar choose-completion-string-functions nil
6742 "Functions that may override the normal insertion of a completion choice.
6743 These functions are called in order with four arguments:
6744 CHOICE - the string to insert in the buffer,
6745 BUFFER - the buffer in which the choice should be inserted,
6746 MINI-P - non-nil if BUFFER is a minibuffer, and
6747 BASE-SIZE - the number of characters in BUFFER before
6748 the string being completed.
6750 If a function in the list returns non-nil, that function is supposed
6751 to have inserted the CHOICE in the BUFFER, and possibly exited
6752 the minibuffer; no further functions will be called.
6754 If all functions in the list return nil, that means to use
6755 the default method of inserting the completion in BUFFER.")
6757 (defun choose-completion-string (choice &optional
6758 buffer base-position insert-function)
6759 "Switch to BUFFER and insert the completion choice CHOICE.
6760 BASE-POSITION says where to insert the completion.
6761 INSERT-FUNCTION says how to insert the completion and falls
6762 back on `completion-list-insert-choice-function' when nil."
6764 ;; If BUFFER is the minibuffer, exit the minibuffer
6765 ;; unless it is reading a file name and CHOICE is a directory,
6766 ;; or completion-no-auto-exit is non-nil.
6768 ;; Some older code may call us passing `base-size' instead of
6769 ;; `base-position'. It's difficult to make any use of `base-size',
6770 ;; so we just ignore it.
6771 (unless (consp base-position)
6772 (message "Obsolete `base-size' passed to choose-completion-string")
6773 (setq base-position nil))
6775 (let* ((buffer (or buffer completion-reference-buffer))
6776 (mini-p (minibufferp buffer)))
6777 ;; If BUFFER is a minibuffer, barf unless it's the currently
6778 ;; active minibuffer.
6779 (if (and mini-p
6780 (not (and (active-minibuffer-window)
6781 (equal buffer
6782 (window-buffer (active-minibuffer-window))))))
6783 (error "Minibuffer is not active for completion")
6784 ;; Set buffer so buffer-local choose-completion-string-functions works.
6785 (set-buffer buffer)
6786 (unless (run-hook-with-args-until-success
6787 'choose-completion-string-functions
6788 ;; The fourth arg used to be `mini-p' but was useless
6789 ;; (since minibufferp can be used on the `buffer' arg)
6790 ;; and indeed unused. The last used to be `base-size', so we
6791 ;; keep it to try and avoid breaking old code.
6792 choice buffer base-position nil)
6793 ;; This remove-text-properties should be unnecessary since `choice'
6794 ;; comes from buffer-substring-no-properties.
6795 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6796 ;; Insert the completion into the buffer where it was requested.
6797 (funcall (or insert-function completion-list-insert-choice-function)
6798 (or (car base-position) (point))
6799 (or (cadr base-position) (point))
6800 choice)
6801 ;; Update point in the window that BUFFER is showing in.
6802 (let ((window (get-buffer-window buffer t)))
6803 (set-window-point window (point)))
6804 ;; If completing for the minibuffer, exit it with this choice.
6805 (and (not completion-no-auto-exit)
6806 (minibufferp buffer)
6807 minibuffer-completion-table
6808 ;; If this is reading a file name, and the file name chosen
6809 ;; is a directory, don't exit the minibuffer.
6810 (let* ((result (buffer-substring (field-beginning) (point)))
6811 (bounds
6812 (completion-boundaries result minibuffer-completion-table
6813 minibuffer-completion-predicate
6814 "")))
6815 (if (eq (car bounds) (length result))
6816 ;; The completion chosen leads to a new set of completions
6817 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6818 (let ((mini (active-minibuffer-window)))
6819 (select-window mini)
6820 (when minibuffer-auto-raise
6821 (raise-frame (window-frame mini))))
6822 (exit-minibuffer))))))))
6824 (define-derived-mode completion-list-mode nil "Completion List"
6825 "Major mode for buffers showing lists of possible completions.
6827 to select the completion near point.
6829 with the mouse.
6832 (set (make-local-variable 'completion-base-size) nil))
6834 (defun completion-list-mode-finish ()
6835 "Finish setup of the completions buffer.
6836 Called from `temp-buffer-show-hook'."
6837 (when (eq major-mode 'completion-list-mode)
6838 (setq buffer-read-only t)))
6840 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6843 ;; Variables and faces used in `completion-setup-function'.
6845 (defcustom completion-show-help t
6846 "Non-nil means show help message in *Completions* buffer."
6847 :type 'boolean
6848 :version "22.1"
6849 :group 'completion)
6851 ;; This function goes in completion-setup-hook, so that it is called
6852 ;; after the text of the completion list buffer is written.
6853 (defun completion-setup-function ()
6854 (let* ((mainbuf (current-buffer))
6855 (base-dir
6856 ;; FIXME: This is a bad hack. We try to set the default-directory
6857 ;; in the *Completions* buffer so that the relative file names
6858 ;; displayed there can be treated as valid file names, independently
6859 ;; from the completion context. But this suffers from many problems:
6860 ;; - It's not clear when the completions are file names. With some
6861 ;; completion tables (e.g. bzr revision specs), the listed
6862 ;; completions can mix file names and other things.
6863 ;; - It doesn't pay attention to possible quoting.
6864 ;; - With fancy completion styles, the code below will not always
6865 ;; find the right base directory.
6866 (if minibuffer-completing-file-name
6867 (file-name-as-directory
6868 (expand-file-name
6869 (buffer-substring (minibuffer-prompt-end)
6870 (- (point) (or completion-base-size 0))))))))
6871 (with-current-buffer standard-output
6872 (let ((base-size completion-base-size) ;Read before killing localvars.
6873 (base-position completion-base-position)
6874 (insert-fun completion-list-insert-choice-function))
6875 (completion-list-mode)
6876 (set (make-local-variable 'completion-base-size) base-size)
6877 (set (make-local-variable 'completion-base-position) base-position)
6878 (set (make-local-variable 'completion-list-insert-choice-function)
6879 insert-fun))
6880 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6881 (if base-dir (setq default-directory base-dir))
6882 ;; Maybe insert help string.
6883 (when completion-show-help
6884 (goto-char (point-min))
6885 (if (display-mouse-p)
6886 (insert (substitute-command-keys
6888 (insert (substitute-command-keys
6892 (add-hook 'completion-setup-hook 'completion-setup-function)
6894 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6895 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6897 (defun switch-to-completions ()
6898 "Select the completion list window."
6899 (interactive)
6900 (let ((window (or (get-buffer-window "*Completions*" 0)
6901 ;; Make sure we have a completions window.
6902 (progn (minibuffer-completion-help)
6903 (get-buffer-window "*Completions*" 0)))))
6904 (when window
6905 (select-window window)
6906 ;; In the new buffer, go to the first completion.
6907 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6908 (when (bobp)
6909 (next-completion 1)))))
6910 \f
6911 ;;; Support keyboard commands to turn on various modifiers.
6913 ;; These functions -- which are not commands -- each add one modifier
6914 ;; to the following event.
6916 (defun event-apply-alt-modifier (_ignore-prompt)
6919 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6920 (defun event-apply-super-modifier (_ignore-prompt)
6923 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6924 (defun event-apply-hyper-modifier (_ignore-prompt)
6927 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6928 (defun event-apply-shift-modifier (_ignore-prompt)
6931 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6932 (defun event-apply-control-modifier (_ignore-prompt)
6935 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6936 (defun event-apply-meta-modifier (_ignore-prompt)
6939 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6941 (defun event-apply-modifier (event symbol lshiftby prefix)
6942 "Apply a modifier flag to event EVENT.
6943 SYMBOL is the name of this modifier, as a symbol.
6944 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6945 PREFIX is the string that represents this modifier in an event type symbol."
6946 (if (numberp event)
6947 (cond ((eq symbol 'control)
6948 (if (and (<= (downcase event) ?z)
6949 (>= (downcase event) ?a))
6950 (- (downcase event) ?a -1)
6951 (if (and (<= (downcase event) ?Z)
6952 (>= (downcase event) ?A))
6953 (- (downcase event) ?A -1)
6954 (logior (lsh 1 lshiftby) event))))
6955 ((eq symbol 'shift)
6956 (if (and (<= (downcase event) ?z)
6957 (>= (downcase event) ?a))
6958 (upcase event)
6959 (logior (lsh 1 lshiftby) event)))
6960 (t
6961 (logior (lsh 1 lshiftby) event)))
6962 (if (memq symbol (event-modifiers event))
6963 event
6964 (let ((event-type (if (symbolp event) event (car event))))
6965 (setq event-type (intern (concat prefix (symbol-name event-type))))
6966 (if (symbolp event)
6967 event-type
6968 (cons event-type (cdr event)))))))
6970 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6971 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6972 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6973 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6974 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6975 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6976 \f
6977 ;;;; Keypad support.
6979 ;; Make the keypad keys act like ordinary typing keys. If people add
6980 ;; bindings for the function key symbols, then those bindings will
6981 ;; override these, so this shouldn't interfere with any existing
6982 ;; bindings.
6984 ;; Also tell read-char how to handle these keys.
6985 (mapc
6986 (lambda (keypad-normal)
6987 (let ((keypad (nth 0 keypad-normal))
6988 (normal (nth 1 keypad-normal)))
6989 (put keypad 'ascii-character normal)
6990 (define-key function-key-map (vector keypad) (vector normal))))
6991 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6992 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6993 (kp-space ?\s)
6996 (kp-multiply ?*)
6997 (kp-add ?+)
6998 (kp-separator ?,)
6999 (kp-subtract ?-)
7000 (kp-decimal ?.)
7001 (kp-divide ?/)
7002 (kp-equal ?=)
7003 ;; Do the same for various keys that are represented as symbols under
7004 ;; GUIs but naturally correspond to characters.
7005 (backspace 127)
7006 (delete 127)
7009 (clear ?\C-l)
7010 (return ?\C-m)
7011 (escape ?\e)
7012 ))
7013 \f
7014 ;;;;
7015 ;;;; forking a twin copy of a buffer.
7016 ;;;;
7018 (defvar clone-buffer-hook nil
7019 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7021 (defvar clone-indirect-buffer-hook nil
7022 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7024 (defun clone-process (process &optional newname)
7025 "Create a twin copy of PROCESS.
7026 If NEWNAME is nil, it defaults to PROCESS' name;
7027 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7028 If PROCESS is associated with a buffer, the new process will be associated
7029 with the current buffer instead.
7030 Returns nil if PROCESS has already terminated."
7031 (setq newname (or newname (process-name process)))
7033 (setq newname (substring newname 0 (match-beginning 0))))
7034 (when (memq (process-status process) '(run stop open))
7035 (let* ((process-connection-type (process-tty-name process))
7036 (new-process
7037 (if (memq (process-status process) '(open))
7038 (let ((args (process-contact process t)))
7039 (setq args (plist-put args :name newname))
7040 (setq args (plist-put args :buffer
7041 (if (process-buffer process)
7042 (current-buffer))))
7043 (apply 'make-network-process args))
7044 (apply 'start-process newname
7045 (if (process-buffer process) (current-buffer))
7046 (process-command process)))))
7047 (set-process-query-on-exit-flag
7048 new-process (process-query-on-exit-flag process))
7049 (set-process-inherit-coding-system-flag
7050 new-process (process-inherit-coding-system-flag process))
7051 (set-process-filter new-process (process-filter process))
7052 (set-process-sentinel new-process (process-sentinel process))
7053 (set-process-plist new-process (copy-sequence (process-plist process)))
7054 new-process)))
7056 ;; things to maybe add (currently partly covered by `funcall mode'):
7057 ;; - syntax-table
7058 ;; - overlays
7059 (defun clone-buffer (&optional newname display-flag)
7060 "Create and return a twin copy of the current buffer.
7061 Unlike an indirect buffer, the new buffer can be edited
7062 independently of the old one (if it is not read-only).
7063 NEWNAME is the name of the new buffer. It may be modified by
7064 adding or incrementing <N> at the end as necessary to create a
7065 unique buffer name. If nil, it defaults to the name of the
7066 current buffer, with the proper suffix. If DISPLAY-FLAG is
7067 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7068 clone a file-visiting buffer, or a buffer whose major mode symbol
7069 has a non-nil `no-clone' property, results in an error.
7071 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7072 current buffer with appropriate suffix. However, if a prefix
7073 argument is given, then the command prompts for NEWNAME in the
7074 minibuffer.
7076 This runs the normal hook `clone-buffer-hook' in the new buffer
7077 after it has been set up properly in other respects."
7078 (interactive
7079 (progn
7080 (if buffer-file-name
7081 (error "Cannot clone a file-visiting buffer"))
7082 (if (get major-mode 'no-clone)
7083 (error "Cannot clone a buffer in %s mode" mode-name))
7084 (list (if current-prefix-arg
7085 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7086 t)))
7087 (if buffer-file-name
7088 (error "Cannot clone a file-visiting buffer"))
7089 (if (get major-mode 'no-clone)
7090 (error "Cannot clone a buffer in %s mode" mode-name))
7091 (setq newname (or newname (buffer-name)))
7093 (setq newname (substring newname 0 (match-beginning 0))))
7094 (let ((buf (current-buffer))
7095 (ptmin (point-min))
7096 (ptmax (point-max))
7097 (pt (point))
7098 (mk (if mark-active (mark t)))
7099 (modified (buffer-modified-p))
7100 (mode major-mode)
7101 (lvars (buffer-local-variables))
7102 (process (get-buffer-process (current-buffer)))
7103 (new (generate-new-buffer (or newname (buffer-name)))))
7104 (save-restriction
7105 (widen)
7106 (with-current-buffer new
7107 (insert-buffer-substring buf)))
7108 (with-current-buffer new
7109 (narrow-to-region ptmin ptmax)
7110 (goto-char pt)
7111 (if mk (set-mark mk))
7112 (set-buffer-modified-p modified)
7114 ;; Clone the old buffer's process, if any.
7115 (when process (clone-process process))
7117 ;; Now set up the major mode.
7118 (funcall mode)
7120 ;; Set up other local variables.
7121 (mapc (lambda (v)
7122 (condition-case () ;in case var is read-only
7123 (if (symbolp v)
7124 (makunbound v)
7125 (set (make-local-variable (car v)) (cdr v)))
7126 (error nil)))
7127 lvars)
7129 ;; Run any hooks (typically set up by the major mode
7130 ;; for cloning to work properly).
7131 (run-hooks 'clone-buffer-hook))
7132 (if display-flag
7133 ;; Presumably the current buffer is shown in the selected frame, so
7134 ;; we want to display the clone elsewhere.
7135 (let ((same-window-regexps nil)
7136 (same-window-buffer-names))
7137 (pop-to-buffer new)))
7138 new))
7141 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7142 "Create an indirect buffer that is a twin copy of the current buffer.
7144 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7145 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7146 or if not called with a prefix arg, NEWNAME defaults to the current
7147 buffer's name. The name is modified by adding a `<N>' suffix to it
7148 or by incrementing the N in an existing suffix. Trying to clone a
7149 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7150 property results in an error.
7152 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7153 This is always done when called interactively.
7155 Optional third arg NORECORD non-nil means do not put this buffer at the
7156 front of the list of recently selected ones."
7157 (interactive
7158 (progn
7159 (if (get major-mode 'no-clone-indirect)
7160 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7161 (list (if current-prefix-arg
7162 (read-buffer "Name of indirect buffer: " (current-buffer)))
7163 t)))
7164 (if (get major-mode 'no-clone-indirect)
7165 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7166 (setq newname (or newname (buffer-name)))
7168 (setq newname (substring newname 0 (match-beginning 0))))
7169 (let* ((name (generate-new-buffer-name newname))
7170 (buffer (make-indirect-buffer (current-buffer) name t)))
7171 (with-current-buffer buffer
7172 (run-hooks 'clone-indirect-buffer-hook))
7173 (when display-flag
7174 (pop-to-buffer buffer norecord))
7175 buffer))
7178 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7179 "Like `clone-indirect-buffer' but display in another window."
7180 (interactive
7181 (progn
7182 (if (get major-mode 'no-clone-indirect)
7183 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7184 (list (if current-prefix-arg
7185 (read-buffer "Name of indirect buffer: " (current-buffer)))
7186 t)))
7187 (let ((pop-up-windows t))
7188 (clone-indirect-buffer newname display-flag norecord)))
7190 \f
7191 ;;; Handling of Backspace and Delete keys.
7193 (defcustom normal-erase-is-backspace 'maybe
7194 "Set the default behavior of the Delete and Backspace keys.
7196 If set to t, Delete key deletes forward and Backspace key deletes
7197 backward.
7199 If set to nil, both Delete and Backspace keys delete backward.
7201 If set to 'maybe (which is the default), Emacs automatically
7202 selects a behavior. On window systems, the behavior depends on
7203 the keyboard used. If the keyboard has both a Backspace key and
7204 a Delete key, and both are mapped to their usual meanings, the
7205 option's default value is set to t, so that Backspace can be used
7206 to delete backward, and Delete can be used to delete forward.
7208 If not running under a window system, customizing this option
7209 accomplishes a similar effect by mapping C-h, which is usually
7210 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7211 via `keyboard-translate'. The former functionality of C-h is
7212 available on the F1 key. You should probably not use this
7213 setting if you don't have both Backspace, Delete and F1 keys.
7215 Setting this variable with setq doesn't take effect. Programmatically,
7216 call `normal-erase-is-backspace-mode' (which see) instead."
7217 :type '(choice (const :tag "Off" nil)
7218 (const :tag "Maybe" maybe)
7219 (other :tag "On" t))
7220 :group 'editing-basics
7221 :version "21.1"
7222 :set (lambda (symbol value)
7223 ;; The fboundp is because of a problem with :set when
7224 ;; dumping Emacs. It doesn't really matter.
7225 (if (fboundp 'normal-erase-is-backspace-mode)
7226 (normal-erase-is-backspace-mode (or value 0))
7227 (set-default symbol value))))
7229 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7230 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7231 (unless frame (setq frame (selected-frame)))
7232 (with-selected-frame frame
7233 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7234 (normal-erase-is-backspace-mode
7235 (if (if (eq normal-erase-is-backspace 'maybe)
7236 (and (not noninteractive)
7237 (or (memq system-type '(ms-dos windows-nt))
7238 (memq window-system '(w32 ns))
7239 (and (memq window-system '(x))
7240 (fboundp 'x-backspace-delete-keys-p)
7241 (x-backspace-delete-keys-p))
7242 ;; If the terminal Emacs is running on has erase char
7243 ;; set to ^H, use the Backspace key for deleting
7244 ;; backward, and the Delete key for deleting forward.
7245 (and (null window-system)
7246 (eq tty-erase-char ?\^H))))
7247 normal-erase-is-backspace)
7248 1 0)))))
7250 (define-minor-mode normal-erase-is-backspace-mode
7251 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7252 With a prefix argument ARG, enable this feature if ARG is
7253 positive, and disable it otherwise. If called from Lisp, enable
7254 the mode if ARG is omitted or nil.
7256 On window systems, when this mode is on, Delete is mapped to C-d
7257 and Backspace is mapped to DEL; when this mode is off, both
7258 Delete and Backspace are mapped to DEL. (The remapping goes via
7259 `local-function-key-map', so binding Delete or Backspace in the
7260 global or local keymap will override that.)
7262 In addition, on window systems, the bindings of C-Delete, M-Delete,
7263 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7264 the global keymap in accordance with the functionality of Delete and
7265 Backspace. For example, if Delete is remapped to C-d, which deletes
7266 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7267 to DEL, which deletes backward, C-Delete is bound to
7268 `backward-kill-word'.
7270 If not running on a window system, a similar effect is accomplished by
7271 remapping C-h (normally produced by the Backspace key) and DEL via
7272 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7273 to C-d; if it's off, the keys are not remapped.
7275 When not running on a window system, and this mode is turned on, the
7276 former functionality of C-h is available on the F1 key. You should
7277 probably not turn on this mode on a text-only terminal if you don't
7278 have both Backspace, Delete and F1 keys.
7280 See also `normal-erase-is-backspace'."
7281 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7282 . (lambda (v)
7283 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7284 (if v 1 0))))
7285 (let ((enabled (eq 1 (terminal-parameter
7286 nil 'normal-erase-is-backspace))))
7288 (cond ((or (memq window-system '(x w32 ns pc))
7289 (memq system-type '(ms-dos windows-nt)))
7290 (let ((bindings
7291 `(([M-delete] [M-backspace])
7292 ([C-M-delete] [C-M-backspace])
7293 ([?\e C-delete] [?\e C-backspace]))))
7295 (if enabled
7296 (progn
7297 (define-key local-function-key-map [delete] [deletechar])
7298 (define-key local-function-key-map [kp-delete] [?\C-d])
7299 (define-key local-function-key-map [backspace] [?\C-?])
7300 (dolist (b bindings)
7301 ;; Not sure if input-decode-map is really right, but
7302 ;; keyboard-translate-table (used below) only works
7303 ;; for integer events, and key-translation-table is
7304 ;; global (like the global-map, used earlier).
7305 (define-key input-decode-map (car b) nil)
7306 (define-key input-decode-map (cadr b) nil)))
7307 (define-key local-function-key-map [delete] [?\C-?])
7308 (define-key local-function-key-map [kp-delete] [?\C-?])
7309 (define-key local-function-key-map [backspace] [?\C-?])
7310 (dolist (b bindings)
7311 (define-key input-decode-map (car b) (cadr b))
7312 (define-key input-decode-map (cadr b) (car b))))))
7313 (t
7314 (if enabled
7315 (progn
7316 (keyboard-translate ?\C-h ?\C-?)
7317 (keyboard-translate ?\C-? ?\C-d))
7318 (keyboard-translate ?\C-h ?\C-h)
7319 (keyboard-translate ?\C-? ?\C-?))))
7321 (if (called-interactively-p 'interactive)
7322 (message "Delete key deletes %s"
7323 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7324 "forward" "backward")))))
7325 \f
7326 (defvar vis-mode-saved-buffer-invisibility-spec nil
7327 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7329 (define-minor-mode read-only-mode
7330 "Change whether the current buffer is read-only.
7331 With prefix argument ARG, make the buffer read-only if ARG is
7332 positive, otherwise make it writable. If buffer is read-only
7333 and `view-read-only' is non-nil, enter view mode.
7335 Do not call this from a Lisp program unless you really intend to
7337 possibly enabling or disabling View mode. Also, note that this
7338 command works by setting the variable `buffer-read-only', which
7339 does not affect read-only regions caused by text properties. To
7340 ignore read-only status in a Lisp program (whether due to text
7341 properties or buffer state), bind `inhibit-read-only' temporarily
7342 to a non-nil value."
7343 :variable buffer-read-only
7344 (cond
7345 ((and (not buffer-read-only) view-mode)
7346 (View-exit-and-edit)
7347 (make-local-variable 'view-read-only)
7348 (setq view-read-only t)) ; Must leave view mode.
7349 ((and buffer-read-only view-read-only
7350 ;; If view-mode is already active, `view-mode-enter' is a nop.
7351 (not view-mode)
7352 (not (eq (get major-mode 'mode-class) 'special)))
7353 (view-mode-enter))))
7355 (define-minor-mode visible-mode
7356 "Toggle making all invisible text temporarily visible (Visible mode).
7357 With a prefix argument ARG, enable Visible mode if ARG is
7358 positive, and disable it otherwise. If called from Lisp, enable
7359 the mode if ARG is omitted or nil.
7361 This mode works by saving the value of `buffer-invisibility-spec'
7362 and setting it to nil."
7363 :lighter " Vis"
7364 :group 'editing-basics
7365 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7366 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7367 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7368 (when visible-mode
7369 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7370 buffer-invisibility-spec)
7371 (setq buffer-invisibility-spec nil)))
7372 \f
7373 ;; Minibuffer prompt stuff.
7375 ;;(defun minibuffer-prompt-modification (start end)
7376 ;; (error "You cannot modify the prompt"))
7377 ;;
7378 ;;
7379 ;;(defun minibuffer-prompt-insertion (start end)
7380 ;; (let ((inhibit-modification-hooks t))
7381 ;; (delete-region start end)
7382 ;; ;; Discard undo information for the text insertion itself
7383 ;; ;; and for the text deletion.above.
7384 ;; (when (consp buffer-undo-list)
7385 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7386 ;; (message "You cannot modify the prompt")))
7387 ;;
7388 ;;
7389 ;;(setq minibuffer-prompt-properties
7390 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7391 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7393 \f
7394 ;;;; Problematic external packages.
7396 ;; rms says this should be done by specifying symbols that define
7397 ;; versions together with bad values. This is therefore not as
7398 ;; flexible as it could be. See the thread:
7399 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7400 (defconst bad-packages-alist
7401 ;; Not sure exactly which semantic versions have problems.
7402 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7404 "The version of `semantic' loaded does not work in Emacs 22.
7405 It can cause constant high CPU load.
7406 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7407 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7408 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7409 ;; provided the `CUA-mode' feature. Since this is no longer true,
7410 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7411 (CUA-mode t nil
7412 "CUA-mode is now part of the standard GNU Emacs distribution,
7413 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7415 You have loaded an older version of CUA-mode which does not work
7416 correctly with this version of Emacs. You should remove the old
7417 version and use the one distributed with Emacs."))
7418 "Alist of packages known to cause problems in this version of Emacs.
7419 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7420 PACKAGE is either a regular expression to match file names, or a
7421 symbol (a feature name), like for `with-eval-after-load'.
7422 SYMBOL is either the name of a string variable, or `t'. Upon
7423 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7424 warning using STRING as the message.")
7426 (defun bad-package-check (package)
7427 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7428 (condition-case nil
7429 (let* ((list (assoc package bad-packages-alist))
7430 (symbol (nth 1 list)))
7431 (and list
7432 (boundp symbol)
7433 (or (eq symbol t)
7434 (and (stringp (setq symbol (eval symbol)))
7435 (string-match-p (nth 2 list) symbol)))
7436 (display-warning package (nth 3 list) :warning)))
7437 (error nil)))
7439 (dolist (elem bad-packages-alist)
7440 (let ((pkg (car elem)))
7441 (with-eval-after-load pkg
7442 (bad-package-check pkg))))
7444 \f
7445 ;;; Generic dispatcher commands
7447 ;; Macro `define-alternatives' is used to create generic commands.
7448 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
7449 ;; that can have different alternative implementations where choosing
7450 ;; among them is exclusively a matter of user preference.
7452 ;; (define-alternatives COMMAND) creates a new interactive command
7453 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
7454 ;; Typically, the user will not need to customize this variable; packages
7455 ;; wanting to add alternative implementations should use
7456 ;;
7457 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
7459 (defmacro define-alternatives (command &rest customizations)
7460 "Define new command `COMMAND'.
7461 The variable `COMMAND-alternatives' will contain alternative
7462 implementations of COMMAND, so that running `C-u M-x COMMAND'
7463 will allow the user to chose among them.
7464 CUSTOMIZATIONS, if non-nil, should be composed of alternating
7465 `defcustom' keywords and values to add to the declaration of
7466 `COMMAND-alternatives' (typically :group and :version)."
7467 (let* ((command-name (symbol-name command))
7468 (varalt-name (concat command-name "-alternatives"))
7469 (varalt-sym (intern varalt-name))
7470 (varimp-sym (intern (concat command-name "--implementation"))))
7471 `(progn
7473 (defcustom ,varalt-sym nil
7474 ,(format "Alist of alternative implementations for the `%s' command.
7476 Each entry must be a pair (ALTNAME . ALTFUN), where:
7477 ALTNAME - The name shown at user to describe the alternative implementation.
7478 ALTFUN - The function called to implement this alternative."
7479 command-name)
7480 :type '(alist :key-type string :value-type function)
7481 ,@customizations)
7483 (defvar ,varimp-sym nil "Internal use only.")
7485 (defun ,command (&optional arg)
7486 ,(format "Run generic command `%s'.
7487 If used for the first time, or with interactive ARG, ask the user which
7488 implementation to use for `%s'. The variable `%s'
7489 contains the list of implementations currently supported for this command."
7490 command-name command-name varalt-name)
7491 (interactive "P")
7492 (when (or arg (null ,varimp-sym))
7493 (let ((val (completing-read
7494 ,(format "Select implementation for command `%s': " command-name)
7495 ,varalt-sym nil t)))
7496 (unless (string-equal val "")
7497 (customize-save-variable ',varimp-sym
7498 (cdr (assoc-string val ,varalt-sym))))))
7499 (if ,varimp-sym
7500 (funcall ,varimp-sym)
7501 (message ,(format "No implementation selected for command `%s'"
7502 command-name)))))))
7504 (provide 'simple)
7506 ;;; simple.el ends here