| blob | d259851dc8524ed515df0085866e90c91fc95dd7 |
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'.
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.
1409 ;; Trick called-interactively-p into thinking that `newcmd' is
1410 ;; an interactive call (bug#14136).
1429 "Read command name to invoke in `execute-extended-command'."
1434 ;; Get a command name at point in the original buffer
1435 ;; to propose it after M-n.
1439 ;; Read a string, completing from and restricting to the set of
1440 ;; all defined commands. Don't provide any initial input.
1441 ;; Save the command read on the extended-command history list.
1452 ;; This isn't strictly correct if `execute-extended-command'
1453 ;; is bound to anything else (e.g. [menu]).
1454 ;; It could use (key-description (this-single-command-keys)),
1455 ;; but actually a prompt other than "M-x" would be confusing,
1456 ;; because "M-x" is a well-known prompt to read a command
1457 ;; and it serves as a shorthand for "Extended command: ".
1462 "Non-nil means show the equivalent key-binding when M-x command has one.
1463 The value can be a length of time to show the message for.
1464 If the value is non-nil and not a number, we wait 2 seconds."
1471 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1472 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1473 "Read function name, then read its arguments and call it.
1475 To pass a numeric argument to the command you are invoking, specify
1476 the numeric argument to this command.
1478 Noninteractively, the argument PREFIXARG is the prefix argument to
1479 give to the command you invoke, if it asks for an argument."
1481 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1492 ;; Normally `real-this-command' should never be changed, but here we really
1493 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1494 ;; binding" for <cmd>, so the command the user really wanted to run is
1495 ;; `function' and not `execute-extended-command'. The difference is
1496 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1500 ;; If enabled, show which key runs this command.
1502 ;; But first wait, and skip the message if there is input.
1504 ;; If this command displayed something in the echo area;
1505 ;; wait a few seconds, then display our suggestion message.
1515 suggest-key-bindings
1519 ;; BEWARE: Called directly from the C code.
1520 "Execute CMD as an editor command.
1521 CMD must be a symbol that satisfies the `commandp' predicate.
1522 Optional second arg RECORD-FLAG non-nil
1523 means unconditionally put this command in the variable `command-history'.
1524 Otherwise, that is done only if an arg is read using the minibuffer.
1525 The argument KEYS specifies the value to use instead of (this-command-keys)
1526 when reading the arguments; if it is nil, (this-command-keys) is used.
1527 The argument SPECIAL, if non-nil, means that this command is executing
1528 a special event, so ignore the prefix argument and don't clear it."
1536 ;; FIXME: Weird calling convention!
1546 ;; If requested, place the macro in the command history. For
1547 ;; other sorts of commands, call-interactively takes care of this.
1550 ;; Don't keep command history around forever.
1556 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1564 \f
1566 "Default minibuffer history list.
1567 This is used for all minibuffer input
1568 except when an alternate history list is specified.
1570 Maximum length of the history list is determined by the value
1573 "Control whether history list elements are expressions or strings.
1574 If the value of this variable equals current minibuffer depth,
1575 they are expressions; otherwise they are strings.
1576 \(That convention is designed to do the right thing for
1583 "Text that was in this minibuffer before any history commands.
1584 This is nil if there have not yet been any history commands
1593 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1597 "Minibuffer history variables for which matching should ignore case.
1598 If a history variable is a member of this list, then the
1600 commands ignore case when searching it, regardless of `case-fold-search'."
1605 "Find the previous history element that matches REGEXP.
1606 \(Previous history elements refer to earlier actions.)
1607 With prefix argument N, search for Nth previous match.
1608 If N is negative, find the next or Nth next match.
1609 Normally, history elements are matched case-insensitively if
1610 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1611 makes the search case-sensitive.
1612 See also `minibuffer-history-case-insensitive-variables'."
1616 nil
1617 minibuffer-local-map
1618 nil
1619 'minibuffer-history-search-history
1621 ;; Use the last regexp specified, by default, if input is empty.
1626 regexp)
1636 ;; On some systems, ignore case for file names.
1638 minibuffer-history-case-insensitive-variables)
1639 t
1640 ;; Respect the user's setting for case-fold-search:
1641 case-fold-search)
1642 nil))
1643 prevpos
1644 match-string
1645 match-offset
1652 "No later matching history item"
1673 next-matching-history-element))
1677 "Find the next history element that matches REGEXP.
1678 \(The next history element refers to a more recent action.)
1679 With prefix argument N, search for Nth next match.
1680 If N is negative, find the previous or Nth previous match.
1681 Normally, history elements are matched case-insensitively if
1682 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1683 makes the search case-sensitive."
1687 nil
1688 minibuffer-local-map
1689 nil
1690 'minibuffer-history-search-history
1692 ;; Use the last regexp specified, by default, if input is empty.
1697 regexp)
1704 "Function run by `goto-history-element' before consuming default values.
1705 This is useful to dynamically add more elements to the list of default values
1706 when `goto-history-element' reaches the end of this list.
1707 Before calling this function `goto-history-element' sets the variable
1708 `minibuffer-default-add-done' to t, so it will call this function only
1709 once. In special cases, when this function needs to be called more
1710 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1714 "When nil, add more elements to the end of the list of default values.
1715 The value nil causes `goto-history-element' to add more elements to
1716 the list of defaults when it reaches the end of this list. It does
1722 "Return a list of all completions without the default value.
1723 This function is used to add all elements of the completion table to
1724 the end of the list of defaults just after the default value."
1727 minibuffer-completion-table
1728 minibuffer-completion-predicate)))
1734 "Puts element of the minibuffer history in the minibuffer.
1735 The argument NABS specifies the absolute history position."
1749 elt minibuffer-returned-to-present)
1756 "End of defaults; no next item"
1761 previous-history-element))
1773 minibuffer-default)))
1785 elt))
1789 "Puts next element of the minibuffer history in the minibuffer.
1790 With argument N, it uses the Nth following element."
1796 "Puts previous element of the minibuffer history in the minibuffer.
1797 With argument N, it uses the Nth previous element."
1803 "Get next history element which completes the minibuffer before the point.
1804 The contents of the minibuffer after the point are deleted, and replaced
1805 by the new completion."
1811 n)
1812 ;; next-matching-history-element always puts us at (point-min).
1813 ;; Move to the position we were at before changing the buffer contents.
1814 ;; This is still sensible, because the text before point has not changed.
1818 "\
1819 Get previous history element which completes the minibuffer before the point.
1820 The contents of the minibuffer after the point are deleted, and replaced
1821 by the new completion."
1825 ;; For compatibility with the old subr of the same name.
1827 "Return the display width of the minibuffer prompt.
1828 Return 0 if current buffer is not a minibuffer."
1829 ;; Return the width of everything before the field at the end of
1830 ;; the buffer; this should be 0 for normal buffers.
1832 \f
1833 ;; isearch minibuffer history
1840 "Set up a minibuffer for using isearch to search the minibuffer history.
1841 Intended to be added to `minibuffer-setup-hook'."
1853 "Clean up the minibuffer after terminating isearch in the minibuffer."
1858 "Return the proper search function, for isearch in minibuffer history."
1861 ;; Use standard functions to search within minibuffer text
1863 found)
1864 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1865 ;; searching forward. Lazy-highlight calls this lambda with the
1866 ;; bound arg, so skip the minibuffer prompt.
1870 ;; 1. First try searching in the initial minibuffer text
1873 noerror)
1874 ;; 2. If the above search fails, start putting next/prev history
1875 ;; elements in the minibuffer successively, and search the string
1876 ;; in them. Do this only when bound is nil (i.e. not while
1877 ;; lazy-highlighting search strings in the current minibuffer text).
1889 ;; After putting the next/prev history element, search
1890 ;; the string in them again, until next-history-element
1891 ;; or previous-history-element raises an error at the
1892 ;; beginning/end of history.
1895 ;; For backward search, don't search
1896 ;; in the minibuffer prompt
1898 noerror)))
1899 ;; Return point of the new search result
1901 ;; Return nil when next(prev)-history-element fails
1905 "Display the minibuffer history search prompt.
1906 If there are no search errors, this function displays an overlay with
1907 the isearch prompt which replaces the original minibuffer prompt.
1908 Otherwise, it displays the standard isearch message returned from
1909 the function `isearch-message'."
1911 ;; Use standard function `isearch-message' when not in the minibuffer,
1912 ;; or search fails, or has an error (like incomplete regexp).
1913 ;; This function overwrites minibuffer text with isearch message,
1914 ;; so it's possible to see what is wrong in the search string.
1916 ;; Otherwise, put the overlay with the standard isearch prompt over
1917 ;; the initial minibuffer prompt.
1926 ;; And clear any previous isearch message.
1930 "Wrap the minibuffer history search when search fails.
1931 Move point to the first history element for a forward search,
1932 or to the last history element for a backward search."
1933 ;; When `minibuffer-history-isearch-search' fails on reaching the
1934 ;; beginning/end of the history, wrap the search to the first/last
1935 ;; minibuffer history element.
1943 "Save a function restoring the state of minibuffer history search.
1944 Save `minibuffer-history-position' to the additional state parameter
1945 in the search status stack."
1951 "Restore the minibuffer history search state.
1952 Go to the history element by the absolute history position HIST-POS."
1955 \f
1956 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1960 "Table mapping redo records to the corresponding undo one.
1961 A redo record for undo-in-region maps to t.
1971 "Within a run of consecutive undo commands, list remaining to be undone.
1975 "Undo some previous changes.
1976 Repeat this command to undo more changes.
1977 A numeric ARG serves as a repeat count.
1979 In Transient Mark mode when the mark is active, only undo changes within
1981 as an argument limits undo to changes within the current region."
1983 ;; Make last-command indicate for the next command that this was an undo.
1984 ;; That way, another undo will undo more.
1985 ;; If we get to the end of the undo history and get an error,
1986 ;; another undo command will find the undo history empty
1987 ;; and will get another error. To begin undoing the undos,
1988 ;; you must type some other command.
1990 ;; For an indirect buffer, look in the base buffer for the
1991 ;; auto-save data.
1995 message)
1996 ;; If we get an error in undo-start,
1997 ;; the next command should not be a "consecutive undo".
1998 ;; So set `this-command' to something other than `undo'.
2003 ;; If something (a timer or filter?) changed the buffer
2004 ;; since the previous command, don't continue the undo seq.
2008 ;; If the last undo record made was made by undo
2009 ;; it shows nothing else happened in between.
2016 ;; get rid of initial undo boundary
2018 ;; If we got this far, the next command should be a consecutive undo.
2020 ;; Check to see whether we're hitting a redo record, and if
2021 ;; so, ask the user whether she wants to skip the redo/undo pair.
2029 ;; The equiv entry might point to another redo record if we have done
2030 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2038 ;; Record the fact that the just-generated undo records come from an
2039 ;; undo operation--that is, they are redo records.
2040 ;; In the ordinary case (not within a region), map the redo
2041 ;; record to the following undos.
2042 ;; I don't know how to do that in the undo-in-region case.
2044 ;; Strip any leading undo boundaries there might be, like we do
2045 ;; above when checking.
2049 undo-equiv-table))
2050 ;; Don't specify a position in the undo record for the undo command.
2051 ;; Instead, undoing this should move point to where the change is.
2070 ;; Record what the current undo list says,
2071 ;; so the next command can tell if the buffer was modified in between.
2075 ;; Display a message announcing success.
2080 "Make BUFFER stop keeping undo information.
2081 No argument or nil as argument means do this for the current buffer."
2087 "Undo some previous changes.
2088 Repeat this command to undo more changes.
2089 A numeric ARG serves as a repeat count.
2090 Contrary to `undo', this will not redo a previous undo."
2095 "Non-nil while performing an undo.
2099 "Undo back N undo-boundaries beyond what was already undone recently.
2100 Call `undo-start' to get ready to undo recent changes,
2101 then call `undo-more' one or more times to undo them."
2106 ;; Note: The following, while pulling elements off
2107 ;; `pending-undo-list' will call primitive change functions which
2108 ;; will push more elements onto `buffer-undo-list'.
2114 "Undo N records from the front of the list LIST.
2115 Return what remains of the list."
2117 ;; This is a good feature, but would make undo-start
2118 ;; unable to do what is expected.
2119 ;;(when (null (car (list)))
2120 ;; ;; If the head of the list is a boundary, it is the boundary
2121 ;; ;; preceding this command. Get rid of it and don't count it.
2122 ;; (setq list (cdr list))))
2125 ;; In a writable buffer, enable undoing read-only text that is
2126 ;; so because of text properties.
2128 ;; Don't let `intangible' properties interfere with undo.
2130 ;; We use oldlist only to check for EQ. ++kfs
2136 ;; Handle an integer by setting point to that value.
2139 ;; Element (t . TIME) records previous modtime.
2140 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2141 ;; UNKNOWN_MODTIME_NSECS.
2143 ;; If this records an obsolete save
2144 ;; (not matching the actual disk file)
2145 ;; then don't mark unmodified.
2153 ;; Element (nil PROP VAL BEG . END) is property change.
2158 ;; Element (BEG . END) means range was inserted.
2160 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2161 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2164 ;; Set point first thing, so that undoing this undo
2165 ;; does not send point back to where it is now.
2168 ;; Element (apply FUN . ARGS) means call FUN to undo.
2172 ;; Long format: (apply DELTA START END FUN . ARGS).
2179 ;; Check that the function did what the entry
2180 ;; said it would do.
2190 ;; Element (STRING . POS) means STRING was deleted.
2200 ;; Now that we record marker adjustments
2201 ;; (caused by deletion) for undo,
2202 ;; we should always insert after markers,
2203 ;; so that undoing the marker adjustments
2204 ;; put the markers back in the right place.
2207 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2215 ;; Make sure an apply entry produces at least one undo entry,
2216 ;; so the test in `undo' for continuing an undo series
2217 ;; will work right.
2222 list)
2224 ;; Deep copy of a list
2226 "Make a copy of undo list LIST."
2232 elt))
2235 "Set `pending-undo-list' to the front of the undo list.
2236 The next call to `undo-more' will undo the most recently made change.
2237 If BEG and END are specified, then only undo elements
2238 that apply to text between BEG and END are used; other undo elements
2239 are ignored. If BEG and END are nil, all undo elements are used."
2245 buffer-undo-list)))
2250 "Return a list of undo elements for the region START to END.
2251 The elements come from `buffer-undo-list', but we keep only
2252 the elements inside this region, and discard those outside this region.
2253 If we find an element that crosses an edge of this region,
2254 we stop and ignore all further elements."
2257 undo-adjusted-markers
2258 some-rejected
2259 undo-elt temp-undo-list delta)
2264 ;; This is a "was unmodified" element.
2265 ;; Keep it if we have kept everything thus far.
2272 ;; Don't put two nils together in the list
2286 ;; Loop down the earlier events adjusting their buffer
2287 ;; positions to reflect the fact that a change to the buffer
2288 ;; isn't being undone. We only need to process those element
2289 ;; types which undo-elt-in-region will return as being in
2290 ;; the region since only those types can ever get into the
2291 ;; output
2300 ;; (TEXT . POSITION)
2307 ;; (BEGIN . END)
2312 ;; (nil PROPERTY VALUE BEG . END)
2322 "Determine whether UNDO-ELT falls inside the region START ... END.
2323 If it crosses the edge, we return nil."
2328 t)
2330 nil)
2332 ;; (TEXT . POSITION)
2336 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2337 ;; See if MARKER is inside the region.
2348 ;; (nil PROPERTY VALUE BEG . END)
2353 ;; (BEGIN . END)
2358 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2359 This assumes we have already decided that UNDO-ELT
2360 is not *inside* the region START...END."
2363 ;; (nil PROPERTY VALUE BEG . END)
2368 ;; (BEGIN . END)
2372 ;; Return the first affected buffer position and the delta for an undo element
2373 ;; delta is defined as the change in subsequent buffer positions if we *did*
2374 ;; the undo.
2378 ;; (TEXT . POSITION)
2381 ;; (BEGIN . END)
2388 "If non-nil ask about discarding undo info for the current command.
2389 Normally, Emacs discards the undo info for the current command if
2390 it exceeds `undo-outer-limit'. But if you set this option
2391 non-nil, it asks in the echo area whether to discard the info.
2392 If you answer no, there is a slight risk that Emacs might crash, so
2393 only do it if you really want to undo the command.
2395 This option is mainly intended for debugging. You have to be
2396 careful if you use it for other purposes. Garbage collection is
2397 inhibited while the question is asked, meaning that Emacs might
2398 leak memory. So you should make sure that you do not wait
2399 excessively long before answering the question."
2405 "If non-nil, an extra level of size that's ok in an undo item.
2406 We don't ask the user about truncating the undo list until the
2407 current item gets bigger than this amount.
2412 ;; When the first undo batch in an undo list is longer than
2413 ;; undo-outer-limit, this function gets called to warn the user that
2414 ;; the undo info for the current command was discarded. Garbage
2415 ;; collection is inhibited around the call, so it had better not do a
2416 ;; lot of consing.
2422 ;; Don't ask the question again unless it gets even bigger.
2423 ;; This applies, in particular, if the user quits from the question.
2424 ;; Such a quit quits out of GC, but something else will call GC
2425 ;; again momentarily. It will call this function again,
2426 ;; but we don't want to ask the question again.
2433 t)
2434 nil))
2439 "The undo info was discarded because it exceeded \
2440 `undo-outer-limit'.
2442 This is normal if you executed a command that made a huge change
2443 to the buffer. In that case, to prevent similar problems in the
2444 future, set `undo-outer-limit' to a value that is large enough to
2445 cover the maximum size of normal changes you expect a single
2446 command to make, but not so large that it might exceed the
2447 maximum memory allotted to Emacs.
2449 If you did not execute any such command, the situation is
2450 probably due to a bug and you should report it.
2452 You can disable the popping up of this buffer by adding the entry
2453 \(undo discard-info) to the user option `warning-suppress-types',
2457 t))
2458 \f
2460 "History list for some commands that read shell commands.
2462 Maximum length of the history list is determined by the value
2469 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2470 This buffer is used when `shell-command' or `shell-command-on-region'
2471 is run interactively. A value of nil means that output to stderr and
2478 "Return a list of all commands associated with the current file.
2479 This function is used to add all related commands retrieved by `mailcap'
2480 to the end of the list of defaults just after the default value."
2484 minibuffer-default))
2489 commands))
2500 map)
2504 "Read a shell command from the minibuffer.
2505 The arguments are the same as the ones of `read-from-minibuffer',
2506 except READ and KEYMAP are missing and HIST defaults
2507 to `shell-command-history'."
2515 minibuffer-local-shell-command-map
2516 nil
2518 args)))
2521 "What to do when the output buffer is used by another shell command.
2522 This option specifies how to resolve the conflict where a new command
2523 wants to direct its output to the buffer `*Async Shell Command*',
2524 but this buffer is already taken by another running shell command.
2526 The value `confirm-kill-process' is used to ask for confirmation before
2527 killing the already running process and running a new process
2528 in the same buffer, `confirm-new-buffer' for confirmation before running
2529 the command in a new buffer with a name other than the default buffer name,
2530 `new-buffer' for doing the same without confirmation,
2531 `confirm-rename-buffer' for confirmation before renaming the existing
2532 output buffer and running a new command in the default buffer,
2533 `rename-buffer' for doing the same without confirmation."
2535 confirm-kill-process)
2537 confirm-new-buffer)
2539 new-buffer)
2541 confirm-rename-buffer)
2543 rename-buffer))
2548 "Execute string COMMAND asynchronously in background.
2550 Like `shell-command', but adds `&' at the end of COMMAND
2551 to execute it asynchronously.
2553 The output appears in the buffer `*Async Shell Command*'.
2554 That buffer is in shell mode.
2556 In Elisp, you will often be better served by calling `start-process'
2557 directly, since it offers more control and does not impose the use of a
2558 shell (with its need to quote arguments)."
2568 current-prefix-arg
2569 shell-command-default-error-buffer))
2575 "Execute string COMMAND in inferior shell; display output, if any.
2576 With prefix argument, insert the COMMAND's output at point.
2578 If COMMAND ends in `&', execute it asynchronously.
2579 The output appears in the buffer `*Async Shell Command*'.
2580 That buffer is in shell mode. You can also use
2581 `async-shell-command' that automatically adds `&'.
2583 Otherwise, COMMAND is executed synchronously. The output appears in
2584 the buffer `*Shell Command Output*'. If the output is short enough to
2585 display in the echo area (which is determined by the variables
2586 `resize-mini-windows' and `max-mini-window-height'), it is shown
2587 there, but it is nonetheless available in buffer `*Shell Command
2588 Output*' even though that buffer is not automatically displayed.
2590 To specify a coding system for converting non-ASCII characters
2592 before this command.
2594 Noninteractive callers can specify coding systems by binding
2595 `coding-system-for-read' and `coding-system-for-write'.
2597 The optional second argument OUTPUT-BUFFER, if non-nil,
2598 says to put the output in some other buffer.
2599 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2600 If OUTPUT-BUFFER is not a buffer and not nil,
2601 insert output in current buffer. (This cannot be done asynchronously.)
2602 In either case, the buffer is first erased, and the output is
2603 inserted after point (leaving mark after it).
2605 If the command terminates without error, but generates output,
2607 the output can be displayed in the echo area or in its buffer.
2608 If the output is short enough to display in the echo area
2609 \(determined by the variable `max-mini-window-height' if
2610 `resize-mini-windows' is non-nil), it is shown there.
2611 Otherwise,the buffer containing the output is displayed.
2615 of the output.
2617 If there is no output, or if output is inserted in the current buffer,
2618 then `*Shell Command Output*' is deleted.
2620 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2621 or buffer name to which to direct the command's standard error output.
2622 If it is nil, error output is mingled with regular output.
2623 In an interactive call, the variable `shell-command-default-error-buffer'
2624 specifies the value of ERROR-BUFFER.
2626 In Elisp, you will often be better served by calling `call-process' or
2627 `start-process' directly, since it offers more control and does not impose
2628 the use of a shell (with its need to quote arguments)."
2639 current-prefix-arg
2640 shell-command-default-error-buffer))
2641 ;; Look for a handler in case default-directory is a remote file name.
2649 ;; Output goes in current buffer.
2655 temporary-file-directory)))
2656 nil)))
2659 ;; We do not use -f for csh; we will not support broken use of
2660 ;; .cshrcs. Even the BSD csh manual says to use
2661 ;; "if ($?prompt) exit" before things which are not useful
2662 ;; non-interactively. Besides, if someone wants their other
2663 ;; aliases for shell commands then they can still have them.
2667 t)
2668 nil shell-command-switch command)
2675 ;; Do no formatting while reading error file,
2676 ;; because that can run a shell command, and we
2677 ;; don't want that to cause an infinite recursion.
2679 ;; Put point after the inserted errors.
2683 ;; This is like exchange-point-and-mark, but doesn't
2684 ;; activate the mark. It is cleaner to avoid activation,
2685 ;; even though the command loop would deactivate the mark
2686 ;; because we inserted text.
2690 ;; Output goes in a separate buffer.
2691 ;; Preserve the match data in case called from a program.
2694 ;; Command ending with ampersand means asynchronous.
2698 proc)
2699 ;; Remove the ampersand.
2701 ;; Ask the user what to do with already running process.
2706 ;; If will kill a process, query first.
2711 ;; If will create a new buffer, query first.
2717 ;; It will create a new buffer.
2721 ;; If will rename the buffer, query first.
2730 ;; It will rename the buffer.
2737 ;; Setting buffer-read-only to nil doesn't suffice
2738 ;; if some text has a non-nil read-only property,
2739 ;; which comint sometimes adds for prompts.
2745 shell-command-switch command))
2749 ;; Use the comint filter for proper handling of carriage motion
2750 ;; (see `comint-inhibit-carriage-motion'),.
2752 ))
2753 ;; Otherwise, command is executed synchronously.
2755 output-buffer nil error-buffer)))))))
2759 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2760 MESSAGE may be either a string or a buffer.
2762 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2763 the maximum height of the echo area, as defined by `max-mini-window-height'
2764 if `resize-mini-windows' is non-nil.
2766 Returns either the string shown in the echo area, or when a pop-up
2767 buffer is used, the window used to display it.
2769 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2770 name of the buffer used to display it in the case where a pop-up buffer
2771 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2772 string and it is displayed in the echo area, it is not specified whether
2773 the contents are inserted into the buffer anyway.
2775 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2776 and only used if a buffer is displayed."
2778 ;; Trivial case where we can use the echo area
2782 ;; Trivial case where we can just remove single trailing newline
2785 ;; General case
2788 message
2797 0
2801 (<= lines
2805 max-mini-window-height))
2807 max-mini-window-height)
2811 ;; Don't use the echo area if the output buffer is
2812 ;; already displayed in the selected frame.
2814 ;; Echo area
2820 ;; Buffer
2823 not-this-window frame))))))))
2826 ;; We have a sentinel to prevent insertion of a termination message
2827 ;; in the buffer itself.
2835 &optional output-buffer replace
2836 error-buffer display-error-buffer)
2837 "Execute string COMMAND in inferior shell with region as input.
2838 Normally display output (if any) in temp buffer `*Shell Command Output*';
2839 Prefix arg means replace the region with it. Return the exit code of
2840 COMMAND.
2842 To specify a coding system for converting non-ASCII characters
2844 before this command. By default, the input (from the current buffer)
2845 is encoded using coding-system specified by `process-coding-system-alist',
2846 falling back to `default-process-coding-system' if no match for COMMAND
2847 is found in `process-coding-system-alist'.
2849 Noninteractive callers can specify coding systems by binding
2850 `coding-system-for-read' and `coding-system-for-write'.
2852 If the command generates output, the output may be displayed
2853 in the echo area or in a buffer.
2854 If the output is short enough to display in the echo area
2855 \(determined by the variable `max-mini-window-height' if
2856 `resize-mini-windows' is non-nil), it is shown there.
2857 Otherwise it is displayed in the buffer `*Shell Command Output*'.
2858 The output is available in that buffer in both cases.
2860 If there is output and an error, a message about the error
2861 appears at the end of the output. If there is no output, or if
2862 output is inserted in the current buffer, the buffer `*Shell
2863 Command Output*' is deleted.
2865 Optional fourth arg OUTPUT-BUFFER specifies where to put the
2866 command's output. If the value is a buffer or buffer name,
2867 put the output there. If the value is nil, use the buffer
2868 `*Shell Command Output*'. Any other value, excluding nil,
2869 means to insert the output in the current buffer. In either case,
2870 the output is inserted after point (leaving mark after it).
2872 Optional fifth arg REPLACE, if non-nil, means to insert the
2873 output in place of text from START to END, putting point and mark
2874 around it.
2876 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
2877 or buffer name to which to direct the command's standard error
2878 output. If nil, error output is mingled with regular output.
2879 When called interactively, `shell-command-default-error-buffer'
2880 is used for ERROR-BUFFER.
2882 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
2883 display the error buffer if there were any errors. When called
2884 interactively, this is t."
2888 ;; Do this before calling region-beginning
2889 ;; and region-end, in case subprocess output
2890 ;; relocates them while we are in the minibuffer.
2892 ;; call-interactively recognizes region-beginning and
2893 ;; region-end specially, leaving them in the history.
2895 string
2896 current-prefix-arg
2897 current-prefix-arg
2898 shell-command-default-error-buffer
2899 t)))
2905 temporary-file-directory)))
2906 nil))
2907 exit-status)
2911 ;; Replace specified region with output from command.
2913 ;; Don't muck with mark unless REPLACE says we should.
2920 t)
2921 nil shell-command-switch command))
2922 ;; It is rude to delete a buffer which the command is not using.
2923 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2924 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2925 ;; (kill-buffer shell-buffer)))
2926 ;; Don't muck with mark unless REPLACE says we should.
2928 ;; No prefix argument: put the output in a temp buffer,
2929 ;; replacing its entire contents.
2934 ;; If the input is the same buffer as the output,
2935 ;; delete everything but the specified region,
2936 ;; then replace that region with the output.
2942 shell-file-name t
2945 t)
2946 nil shell-command-switch
2947 command)))
2948 ;; Clear the output buffer, then run the command with
2949 ;; output there.
2960 buffer)
2961 nil shell-command-switch command)))
2962 ;; Report the output.
2972 ;; There's some output, display it
2974 ;; No output; error?
2981 shell-command-default-error-buffer)
2988 output))
2991 exit-status))
2994 exit-status output))))
2995 ;; Don't kill: there might be useful info in the undo-log.
2996 ;; (kill-buffer buffer)
2997 ))))
3005 ;; Do no formatting while reading error file,
3006 ;; because that can run a shell command, and we
3007 ;; don't want that to cause an infinite recursion.
3009 ;; Put point after the inserted errors.
3014 exit-status))
3017 "Execute shell command COMMAND and return its output as a string."
3020 standard-output
3024 "Process files synchronously in a separate process.
3025 Similar to `call-process', but may invoke a file handler based on
3026 `default-directory'. The current working directory of the
3027 subprocess is `default-directory'.
3029 File names in INFILE and BUFFER are handled normally, but file
3030 names in ARGS should be relative to `default-directory', as they
3031 are passed to the process verbatim. \(This is a difference to
3032 `call-process' which does not support file handlers for INFILE
3033 and BUFFER.\)
3035 Some file handlers might not support all variants, for example
3036 they might behave as if DISPLAY was nil, regardless of the actual
3037 value passed."
3039 lc stderr-file)
3049 display args)
3055 "Whether a call of `process-file' changes remote files.
3057 By default, this variable is always set to `t', meaning that a
3058 call of `process-file' could potentially change any file on a
3059 remote host. When set to `nil', a file handler could optimize
3060 its behavior with respect to remote file attribute caching.
3062 You should only ever change this variable with a let-binding;
3066 "Start a program in a subprocess. Return the process object for it.
3068 Similar to `start-process', but may invoke a file handler based on
3069 `default-directory'. See Info node `(elisp)Magic File Names'.
3071 This handler ought to run PROGRAM, perhaps on the local host,
3072 perhaps on a remote host that corresponds to `default-directory'.
3073 In the latter case, the local part of `default-directory' becomes
3074 the working directory of the process.
3076 PROGRAM and PROGRAM-ARGS might be file names. They are not
3077 objects of file handler invocation. File handlers might not
3078 support pty association, if PROGRAM is nil."
3082 \f
3083 ;;;; Process menu
3095 "Major mode for listing the processes called by Emacs."
3107 "Recompute the list of processes for the Process List buffer.
3108 Also, delete any process that is exited or signaled."
3121 face link
3124 follow-link t
3125 process-buffer ,buf
3126 action process-menu-visit-buffer)
3135 "datagram"
3152 tabulated-list-entries))))))
3158 "Display a list of all processes that are Emacs sub-processes.
3159 If optional argument QUERY-ONLY is non-nil, only processes with
3160 the query-on-exit flag set are listed.
3161 Any process listed as exited or signaled is actually eliminated
3162 after the listing is made.
3163 Optional argument BUFFER specifies a buffer to use, instead of
3165 The return value is always nil.
3167 This function lists only processes that were launched by Emacs. To
3168 see other processes running on the system, use `list-system-processes'."
3180 nil)
3181 \f
3185 ;; For backward compatibility, minus with no modifiers is an ordinary
3186 ;; command if digits have already been entered.
3216 map)
3223 "Begin a numeric argument for the following command.
3228 multiplies the argument by 4 each time.
3230 which is different in effect from any particular numeric argument.
3237 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3238 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3244 arg)))
3248 "Begin a negative numeric argument for the next command.
3257 "Part of the numeric argument for the next command.
3261 last-command-event
3268 ;; Treat -0 as just -, so that -01 will work.
3271 digit))))
3273 \f
3281 "Function to perform the filtering in `filter-buffer-substring'.
3282 The function is called with 3 arguments:
3283 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
3284 as those of `filter-buffer-substring' in each case.
3288 "List of filter functions for `filter-buffer-substring'.
3289 Each function must accept a single argument, a string, and return
3290 a string. The buffer substring is passed to the first function
3291 in the list, and the return value of each function is passed to
3292 the next.
3293 As a special convention, point is set to the start of the buffer text
3294 being operated on (i.e., the first argument of `filter-buffer-substring')
3300 "Return the buffer substring between BEG and END, after filtering.
3301 The hook `filter-buffer-substring-function' performs the actual filtering.
3302 By default, no filtering is done.
3304 If DELETE is non-nil, the text between BEG and END is deleted
3305 from the buffer.
3307 This function should be used instead of `buffer-substring',
3308 `buffer-substring-no-properties', or `delete-and-extract-region'
3309 when you want to allow filtering to take place. For example,
3310 major or minor modes can use `filter-buffer-substring-function' to
3311 extract characters that are special to a buffer, and should not
3312 be copied into other buffers."
3315 ;; FIXME: `with-wrapper-hook' is obsolete
3326 string)))
3331 ;;;; Window system cut and paste hooks.
3334 "Function to call to make a killed region available to other programs.
3335 Most window systems provide a facility for cutting and pasting
3336 text between different programs, such as the clipboard on X and
3337 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3339 This variable holds a function that Emacs calls whenever text is
3340 put in the kill ring, to make the new kill available to other
3341 programs. The function takes one argument, TEXT, which is a
3345 "Function to call to get text cut from other programs.
3346 Most window systems provide a facility for cutting and pasting
3347 text between different programs, such as the clipboard on X and
3348 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3350 This variable holds a function that Emacs calls to obtain text
3351 that other programs have provided for pasting. The function is
3352 called with no arguments. If no other program has provided text
3353 to paste, the function should return nil (in which case the
3354 caller, usually `current-kill', should use the top of the Emacs
3355 kill ring). If another program has provided text to paste, the
3356 function should return that text as a string (in which case the
3357 caller should put this string in the kill ring as the latest
3358 kill).
3360 The function may also return a list of strings if the window
3361 system supports multiple selections. The first string will be
3362 used as the pasted text, but the other will be placed in the kill
3363 ring for easy access via `yank-pop'.
3365 Note that the function should return a string only if a program
3366 other than Emacs has provided a string for pasting; if Emacs
3367 provided the most recent string, the function should return nil.
3368 If it is difficult to tell whether Emacs or some other program
3369 provided the current string, it is probably good enough to return
3370 nil if the string is equal (according to `string=') to the last
3372 \f
3375 ;;;; The kill ring data structure.
3378 "List of killed text sequences.
3379 Since the kill ring is supposed to interact nicely with cut-and-paste
3380 facilities offered by window systems, use of this variable should
3381 interact nicely with `interprogram-cut-function' and
3382 `interprogram-paste-function'. The functions `kill-new',
3383 `kill-append', and `current-kill' are supposed to implement this
3384 interaction; you may want to use them instead of manipulating the kill
3388 "Maximum length of kill ring before oldest elements are thrown away."
3396 "Save clipboard strings into kill ring before replacing them.
3397 When one selects something in another program to paste it into Emacs,
3398 but kills something in Emacs before actually pasting it,
3399 this selection is gone unless this variable is non-nil,
3400 in which case the other program's selection is saved in the `kill-ring'
3407 "Do not add a new string to `kill-ring' if it duplicates the last one.
3408 The comparison is done using `equal-including-properties'."
3414 "Make STRING the latest kill in the kill ring.
3415 Set `kill-ring-yank-pointer' to point to it.
3416 If `interprogram-cut-function' is non-nil, apply it to STRING.
3417 Optional second argument REPLACE non-nil means that STRING will replace
3418 the front of the kill ring, rather than being added to the list.
3420 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3421 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3422 STRING.
3424 When the yank handler has a non-nil PARAM element, the original STRING
3425 argument is not used by `insert-for-yank'. However, since Lisp code
3426 may access and use elements from the kill ring directly, the STRING
3436 ;; Due to text properties such as 'yank-handler that
3437 ;; can alter the contents to yank, comparison using
3438 ;; `equal' is unsafe.
3466 "Append STRING to the end of the latest kill in the kill ring.
3467 If BEFORE-P is non-nil, prepend STRING to the kill.
3468 If `interprogram-cut-function' is set, pass the resulting kill to it."
3473 yank-handler)))
3477 "Whether rotating the kill ring changes the window system selection.
3478 If non-nil, whenever the kill ring is rotated (usually via the
3479 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3480 to copy the new kill to the window system selection."
3486 "Rotate the yanking point by N places, and then return that kill.
3487 If N is zero and `interprogram-paste-function' is set to a
3488 function that returns a string or a list of strings, and if that
3489 function doesn't return nil, then that string (or list) is added
3490 to the front of the kill ring and the string (or first string in
3491 the list) is returned as the latest kill.
3493 If N is not zero, and if `yank-pop-change-selection' is
3494 non-nil, use `interprogram-cut-function' to transfer the
3495 kill at the new yank point into the window system selection.
3497 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3498 move the yanking point; just return the Nth kill forward."
3501 interprogram-paste-function
3505 ;; Disable the interprogram cut function when we add the new
3506 ;; text to the kill ring, so Emacs doesn't try to own the
3507 ;; selection, with identical text.
3517 kill-ring)))
3522 interprogram-cut-function)
3528 ;;;; Commands for manipulating the kill ring.
3531 "Non-nil means don't signal an error for killing read-only text."
3537 This deletes the text from the buffer and saves it in the kill ring.
3541 If you want to append the killed region to the last killed text,
3544 If the buffer is read-only, Emacs will beep and refrain from deleting
3545 the text, but put the text in the kill ring anyway. This means that
3546 you can use the killing commands to copy text from a read-only buffer.
3548 Lisp programs should use this function for killing text.
3549 (To delete text, use `delete-region'.)
3550 Supply two arguments, character positions indicating the stretch of text
3551 to be killed.
3553 If the previous command was also a kill command,
3554 the text killed this time appends to the text killed last time
3555 to make one entry in the kill ring."
3556 ;; Pass point first, then mark, because the order matters
3557 ;; when calling kill-append.
3564 ;; Add that string to the kill ring, one way or another.
3571 nil)
3573 ;; The code above failed because the buffer, or some of the characters
3574 ;; in the region, are read-only.
3575 ;; We should beep, in case the user just isn't aware of this.
3576 ;; However, there's no harm in putting
3577 ;; the region's text in the kill ring, anyway.
3579 ;; Set this-command now, so it will be set even if we get an error.
3581 ;; This should barf, if appropriate, and give us the correct error.
3584 ;; Signal an error if the buffer is read-only.
3586 ;; If the buffer isn't read-only, the text is.
3590 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3591 ;; to get two copies of the text when the user accidentally types M-w and
3592 ;; then corrects it with the intended C-w.
3594 "Save the region as if killed, but don't kill it.
3595 In Transient Mark mode, deactivate the mark.
3596 If `interprogram-cut-function' is non-nil, also save the text for a window
3597 system cut and paste.
3599 This command's old key binding has been given to `kill-ring-save'."
3605 nil)
3608 "Save the region as if killed, but don't kill it.
3609 In Transient Mark mode, deactivate the mark.
3610 If `interprogram-cut-function' is non-nil, also save the text for a window
3611 system cut and paste.
3613 If you want to append the killed line to the last killed text,
3616 This command is similar to `copy-region-as-kill', except that it gives
3617 visual feedback indicating the extent of the region being copied."
3620 ;; This use of called-interactively-p is correct because the code it
3621 ;; controls just gives the user visual feedback.
3626 "Indicate that the region text has been copied interactively.
3627 If the mark is visible in the selected window, blink the cursor
3628 between point and mark if there is currently no active region
3629 highlighting.
3631 If the mark lies outside the selected window, display an
3632 informative message containing a sample of the copied text. The
3633 optional argument MESSAGE-LEN, if non-nil, specifies the length
3634 of this sample text; it defaults to 40."
3637 ;; Inhibit quitting so we can make a quit here
3638 ;; look like a C-g typed as a command.
3641 ;; Swap point-and-mark quickly so as to show the region that
3642 ;; was selected. Don't do it if the region is highlighted.
3645 ;; Swap point and mark.
3649 ;; Swap back.
3652 ;; If user quit, deactivate the mark
3653 ;; as C-g would as a command.
3659 ;; Don't say "killed"; that is misleading.
3666 "Cause following command, if it kills, to append to previous kill.
3667 The argument is used for internal purposes; do not supply one."
3669 ;; We don't use (interactive-p), since that breaks kbd macros.
3675 \f
3676 ;; Yanking.
3681 "List of special text property handling conditions for yanking.
3682 Each element should have the form (PROP . FUN), where PROP is a
3683 property symbol and FUN is a function. When the `yank' command
3684 inserts text into the buffer, it scans the inserted text for
3685 stretches of text that have `eq' values of the text property
3686 PROP; for each such stretch of text, FUN is called with three
3687 arguments: the property's value in that text, and the start and
3688 end positions of the text.
3690 This is done prior to removing the properties specified by
3691 `yank-excluded-properties'."
3695 ;; This is actually used in subr.el but defcustom does not work there.
3698 intangible invisible keymap local-map mouse-face read-only
3699 yank-handler)
3700 "Text properties to discard when yanking.
3701 The value should be a list of text properties to discard or t,
3702 which means to discard all text properties.
3704 See also `yank-handled-properties'."
3711 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3712 Function is called with two parameters, START and END corresponding to
3713 the value of the mark and point; it is guaranteed that START <= END.
3717 "Replace just-yanked stretch of killed text with a different stretch.
3718 This command is allowed only immediately after a `yank' or a `yank-pop'.
3719 At such a time, the region contains a stretch of reinserted
3720 previously-killed text. `yank-pop' deletes that text and inserts in its
3721 place a different stretch of killed text.
3723 With no argument, the previous kill is inserted.
3724 With argument N, insert the Nth previous kill.
3725 If N is negative, this is a more recent kill.
3727 The sequence of kills wraps around, so that after the oldest one
3728 comes the newest one.
3730 When this command inserts killed text into the buffer, it honors
3731 `yank-excluded-properties' and `yank-handler' as described in the
3732 doc string for `insert-for-yank-1', which see."
3746 ;; Set the window start back where it was in the yank command,
3747 ;; if possible.
3750 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3751 ;; It is cleaner to avoid activation, even though the command
3752 ;; loop would deactivate the mark because we inserted text.
3755 nil)
3759 More precisely, reinsert the most recent kill, which is the
3760 stretch of killed text most recently killed OR yanked. Put point
3761 at the end, and set mark at the beginning without activating it.
3763 With argument N, reinsert the Nth most recent kill.
3765 When this command inserts text into the buffer, it honors the
3766 `yank-handled-properties' and `yank-excluded-properties'
3767 variables, and the `yank-handler' text property. See
3768 `insert-for-yank-1' for details.
3773 ;; If we don't get all the way thru, make last-command indicate that
3774 ;; for the following command.
3782 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3783 ;; It is cleaner to avoid activation, even though the command
3784 ;; loop would deactivate the mark because we inserted text.
3787 ;; If we do get all the way thru, make this-command indicate that.
3790 nil)
3793 "Rotate the yanking point in the kill ring.
3794 With ARG, rotate that many kills forward (or backward, if negative)."
3797 \f
3798 ;; Some kill commands.
3800 ;; Internal subroutine of delete-char
3806 ;; Internal subroutine of backward-delete-char
3813 "The method for untabifying when deleting backward.
3814 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3815 `hungry' -- delete all whitespace, both tabs and spaces;
3816 `all' -- delete all whitespace, including tabs, spaces and newlines;
3817 nil -- just delete one character."
3823 "Delete characters backward, changing tabs into spaces.
3824 The exact behavior depends on `backward-delete-char-untabify-method'.
3825 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3826 Interactively, ARG is the prefix arg (default 1)
3827 and KILLP is t if a prefix arg was specified."
3850 arg)))
3851 ;; Avoid warning about delete-backward-char
3855 "Kill up to and including ARGth occurrence of CHAR.
3856 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3857 Goes backward if ARG is negative; error if CHAR not found."
3860 ;; Avoid "obsolete" warnings for translation-table-for-input.
3868 ;; kill-line and its subroutines.
3871 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
3876 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3877 With prefix argument ARG, kill that many lines from point.
3878 Negative arguments kill lines backward.
3879 With zero argument, kills the text before point on the current line.
3882 a number counts as a prefix arg.
3884 To kill a whole line, when point is not at the beginning, type \
3887 If `show-trailing-whitespace' is non-nil, this command will just
3888 kill the rest of the current line, even if there are only
3889 nonblanks there.
3891 If option `kill-whole-line' is non-nil, then this command kills the whole line
3892 including its terminating newline, when used at the beginning of a line
3893 with no argument. As a consequence, you can always kill a whole line
3896 If you want to append the killed line to the last killed text,
3899 If the buffer is read-only, Emacs will beep and refrain from deleting
3900 the line, but put the line in the kill ring anyway. This means that
3901 you can use this command to copy text from a read-only buffer.
3902 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3903 even beep.)"
3906 ;; It is better to move point to the other end of the kill
3907 ;; before killing. That way, in a read-only buffer, point
3908 ;; moves across the text that is copied to the kill ring.
3909 ;; The choice has no effect on undo now that undo records
3910 ;; the value of point from before the command was run.
3920 ;; If trailing whitespace is visible,
3921 ;; don't treat it as nothing.
3931 "Kill current line.
3932 With prefix ARG, kill that many lines starting from the current line.
3933 If ARG is negative, kill backward. Also kill the preceding newline.
3935 If ARG is zero, kill current line but exclude the trailing newline."
3946 ;; We need to kill in two steps, because the previous command
3947 ;; could have been a kill command, in which case the text
3948 ;; before point needs to be prepended to the current kill
3949 ;; ring entry and the text after point appended. Also, we
3950 ;; need to use save-excursion to avoid copying the same text
3951 ;; twice to the kill ring in read-only buffers.
3969 "Move forward by ARG lines, ignoring currently invisible newlines only.
3970 If ARG is negative, move backward -ARG lines.
3971 If ARG is zero, move to the beginning of the current line."
3978 ;; If the newline we just skipped is invisible,
3979 ;; don't count it.
3983 prop
3988 ;; If invisible text follows, and it is a number of complete lines,
3989 ;; skip it.
3995 prop
4011 ;; If the newline we just moved to is invisible,
4012 ;; don't count it.
4017 prop
4022 ;; If invisible text follows, and it is a number of complete lines,
4023 ;; skip it.
4029 prop
4040 nil)))
4043 "Move to end of current visible line."
4045 ;; If the following character is currently invisible,
4046 ;; skip all characters with that same `invisible' property value,
4047 ;; then find the next newline.
4054 prop
4063 \f
4065 "Insert after point the contents of BUFFER.
4066 Puts mark after the inserted text.
4067 BUFFER may be a buffer or a buffer name.
4069 This function is meant for the user to run interactively.
4070 Don't call it from programs: use `insert-buffer-substring' instead!"
4079 t))))
4084 nil)
4087 "Append to specified buffer the text of the region.
4088 It is inserted into that buffer before its point.
4090 When calling from a program, give three arguments:
4091 BUFFER (or buffer name), START and END.
4092 START and END specify the portion of the current buffer to be copied."
4099 point)
4110 "Prepend to specified buffer the text of the region.
4111 It is inserted into that buffer after its point.
4113 When calling from a program, give three arguments:
4114 BUFFER (or buffer name), START and END.
4115 START and END specify the portion of the current buffer to be copied."
4124 "Copy to specified buffer the text of the region.
4125 It is inserted into that buffer, replacing existing text there.
4127 When calling from a program, give three arguments:
4128 BUFFER (or buffer name), START and END.
4129 START and END specify the portion of the current buffer to be copied."
4137 \f
4141 "Hook run when the mark becomes active.
4142 It is also run at the end of a command, if the mark is active and
4149 "Return this buffer's mark value as integer, or nil if never set.
4151 In Transient Mark mode, this function signals an error if
4152 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4153 or the argument FORCE is non-nil, it disregards whether the mark
4154 is active, and returns an integer or nil in the usual way.
4156 If you are using this in an editing command, you are most likely making
4157 a mistake; see the documentation of `set-mark'."
4162 ;; Behind display-selections-p.
4169 "Deactivate the mark.
4170 If Transient Mark mode is disabled, this function normally does
4171 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4173 Deactivating the mark sets `mark-active' to nil, updates the
4174 primary selection according to `select-active-regions', and runs
4175 `deactivate-mark-hook'.
4177 If Transient Mark mode was temporarily enabled, reset the value
4178 of the variable `transient-mark-mode'; if this causes Transient
4179 Mark mode to be disabled, don't change `mark-active' to nil or
4180 run `deactivate-mark-hook'."
4184 select-active-regions)
4187 ;; The var `saved-region-selection', if non-nil, is the text in
4188 ;; the region prior to the last command modifying the buffer.
4189 ;; Set the selection to that, or to the current region.
4193 ;; If another program has acquired the selection, region
4194 ;; deactivation should not clobber it (Bug#11772).
4205 ;; When deactivating a temporary region, don't change
4206 ;; `mark-active' or run `deactivate-mark-hook'.
4214 "Activate the mark."
4222 "Set this buffer's mark to POS. Don't use this function!
4223 That is to say, don't use this function unless you want
4224 the user to see that the mark has moved, and you want the previous
4225 mark position to be lost.
4227 Normally, when a new mark is set, the old one should go on the stack.
4228 This is why most applications should use `push-mark', not `set-mark'.
4230 Novice Emacs Lisp programmers often try to use the mark for the wrong
4231 purposes. The mark saves a location for the user's convenience.
4232 Most editing commands should not alter the mark.
4233 To remember a location for internal use in the Lisp program,
4234 store it in a Lisp variable. Example:
4236 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4243 ;; Normally we never clear mark-active except in Transient Mark mode.
4244 ;; But when we actually clear out the mark value too, we must
4245 ;; clear mark-active in any mode.
4251 If nil, region-aware commands treat empty regions as inactive.
4252 If non-nil, region-aware commands treat the region as active as
4253 long as the mark is active, even if the region is empty.
4255 Region-aware commands are those that act on the region if it is
4256 active and Transient Mark mode is enabled, and on the text near
4257 point otherwise."
4263 "Return t if the region is active and it is appropriate to act on it.
4264 This is used by commands that act specially on the region under
4265 Transient Mark mode.
4267 The return value is t if Transient Mark mode is enabled and the
4268 mark is active; furthermore, if `use-empty-active-region' is nil,
4269 the region must not be empty. Otherwise, the return value is nil.
4271 For some commands, it may be appropriate to ignore the value of
4272 `use-empty-active-region'; in that case, use `region-active-p'."
4277 "Return t if Transient Mark mode is enabled and the mark is active.
4279 Some commands act specially on the region when Transient Mark
4280 mode is enabled. Usually, such commands should use
4281 `use-region-p' instead of this function, because `use-region-p'
4282 also checks the value of `use-empty-active-region'."
4291 "Maximum size of mark ring. Start discarding off end if gets this big."
4299 "Maximum size of global mark ring. \
4300 Start discarding off end if gets this big."
4305 "Jump to mark, and pop a new position for mark off the ring.
4306 \(Does not affect global mark ring\)."
4316 "Set mark at where point is.
4317 If no prefix ARG and mark is already set there, just activate it.
4318 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4331 will pop the mark twice, and
4333 will pop the mark three times.
4341 "Set the mark where point is, or jump to the mark.
4342 Setting the mark also alters the region, which is the text
4343 between point and mark; this is the closest equivalent in
4346 With no prefix argument, set the mark at point, and push the
4347 old mark position on local mark ring. Also push the old mark on
4348 global mark ring, if the previous mark was set in another buffer.
4350 When Transient Mark Mode is off, immediately repeating this
4351 command activates `transient-mark-mode' temporarily.
4354 jump to the mark, and set the mark from
4355 position popped off the local mark ring \(this does not affect the global
4357 mark ring \(see `pop-global-mark'\).
4359 If `set-mark-command-repeat-pop' is non-nil, repeating
4361 off the local (or global) mark ring and jumps there.
4364 argument, unconditionally set mark where point is, even if
4365 `set-mark-command-repeat-pop' is non-nil.
4367 Novice Emacs Lisp programmers often try to use the mark for the wrong
4368 purposes. See the documentation of `set-mark' for more information."
4404 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4405 If the last global mark pushed was not in the current buffer,
4406 also push LOCATION on the global mark ring.
4407 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4409 Novice Emacs Lisp programmers often try to use the mark for the wrong
4410 purposes. See the documentation of `set-mark' for more information.
4412 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4419 ;; Now push the mark on the global mark ring.
4422 ;; The last global mark pushed was in this same buffer.
4423 ;; Don't push another one.
4424 nil
4433 nil)
4436 "Pop off mark ring into the buffer's actual mark.
4437 Does not set point. Does nothing if mark ring is empty."
4449 "Put the mark where point is now, and point where the mark is now.
4450 This command works even when the mark is not active,
4451 and it reactivates the mark.
4453 If Transient Mark mode is on, a prefix ARG deactivates the mark
4454 if it is active, and otherwise avoids reactivating it. If
4455 Transient Mark mode is off, a prefix ARG enables Transient Mark
4456 mode temporarily."
4471 nil))
4474 "When non-nil, shifted motion keys activate the mark momentarily.
4476 While the mark is activated in this way, any shift-translated point
4477 motion key extends the region, and if Transient Mark mode was off, it
4478 is temporarily turned on. Furthermore, the mark will be deactivated
4479 by any subsequent point motion key that was not shift-translated, or
4480 by any action that normally deactivates the mark in Transient Mark mode.
4482 See `this-command-keys-shift-translated' for the meaning of
4483 shift-translation."
4488 "Activate/deactivate mark depending on invocation thru shift translation.
4489 This function is called by `call-interactively' when a command
4490 with a `^' character in its `interactive' spec is invoked, before
4491 running the command itself.
4493 If `shift-select-mode' is enabled and the command was invoked
4494 through shift translation, set the mark and activate the region
4495 temporarily, unless it was already set in this way. See
4496 `this-command-keys-shift-translated' for the meaning of shift
4497 translation.
4499 Otherwise, if the region has been activated temporarily,
4500 deactivate it, and restore the variable `transient-mark-mode' to
4501 its earlier value."
4508 transient-mark-mode)))
4515 "Toggle Transient Mark mode.
4516 With a prefix argument ARG, enable Transient Mark mode if ARG is
4517 positive, and disable it otherwise. If called from Lisp, enable
4518 Transient Mark mode if ARG is omitted or nil.
4520 Transient Mark mode is a global minor mode. When enabled, the
4521 region is highlighted whenever the mark is active. The mark is
4523 operations that set the mark but whose main purpose is something
4529 Many commands change their behavior when Transient Mark mode is
4530 in effect and the mark is active, by acting on the region instead
4531 of their usual default part of the buffer's text. Examples of
4534 To see the documentation of commands which are sensitive to the
4537 :global t
4538 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4542 "Non-nil means it is ok for commands to call `widen' when they want to.
4543 Some commands will do this in order to go to positions outside
4544 the current accessible part of the buffer.
4546 If `widen-automatically' is nil, these commands will do something else
4550 "Whether the currently executing code is performing an essential task.
4551 This variable should be non-nil only when running code which should not
4552 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4553 user for a password when we are simply scanning a set of files in the
4554 background or displaying possible completions before the user even asked
4558 "Pop off global mark ring and jump to the top location."
4560 ;; Pop entries which refer to non-existent buffers.
4578 \f
4580 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4586 "Move cursor vertically down ARG lines.
4587 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4588 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4589 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4590 function will not vscroll.
4592 ARG defaults to 1.
4594 If there is no character in the target line exactly under the current column,
4595 the cursor is positioned after the character in that line which spans this
4596 column, or at the end of the line if it is not long enough.
4597 If there is no line in the buffer after this one, behavior depends on the
4598 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4599 to create a line, and moves the cursor to that line. Otherwise it moves the
4600 cursor to the end of the buffer.
4602 If the variable `line-move-visual' is non-nil, this command moves
4603 by display lines. Otherwise, it moves by buffer lines, without
4604 taking variable-width characters or continued lines into account.
4607 a semipermanent goal column for this command.
4608 Then instead of trying to move exactly vertically (or as close as possible),
4609 this command moves to the specified goal column (or as close as possible).
4610 The goal column is stored in the variable `goal-column', which is nil
4611 when there is no goal column. Note that setting `goal-column'
4612 overrides `line-move-visual' and causes this command to move by buffer
4613 lines rather than by display lines.
4615 If you are thinking of using this in a Lisp program, consider
4616 using `forward-line' instead. It is usually easier to use
4617 and more reliable (no dependence on goal column, etc.)."
4622 ;; When adding a newline, don't expand an abbrev.
4633 nil)
4636 "Move cursor vertically up ARG lines.
4637 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4638 Non-interactively, use TRY-VSCROLL to control whether to vscroll tall
4639 lines: if either `auto-window-vscroll' or TRY-VSCROLL is nil, this
4640 function will not vscroll.
4642 ARG defaults to 1.
4644 If there is no character in the target line exactly over the current column,
4645 the cursor is positioned after the character in that line which spans this
4646 column, or at the end of the line if it is not long enough.
4648 If the variable `line-move-visual' is non-nil, this command moves
4649 by display lines. Otherwise, it moves by buffer lines, without
4650 taking variable-width characters or continued lines into account.
4653 a semipermanent goal column for this command.
4654 Then instead of trying to move exactly vertically (or as close as possible),
4655 this command moves to the specified goal column (or as close as possible).
4656 The goal column is stored in the variable `goal-column', which is nil
4657 when there is no goal column. Note that setting `goal-column'
4658 overrides `line-move-visual' and causes this command to move by buffer
4659 lines rather than by display lines.
4661 If you are thinking of using this in a Lisp program, consider using
4662 `forward-line' with a negative argument instead. It is usually easier
4663 to use and more reliable (no dependence on goal column, etc.)."
4672 nil)
4675 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4676 This means moving to the end of each line moved onto.
4677 The beginning of a blank line does not count as the end of a line.
4678 This has no effect when the variable `line-move-visual' is non-nil."
4684 A non-nil setting overrides the variable `line-move-visual', which see."
4691 "Current goal column for vertical motion.
4692 It is the column where point was at the start of the current run
4693 of vertical motion commands.
4695 When moving by visual lines via the function `line-move-visual', it is a cons
4696 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4697 divided by the default column width, and HSCROLL is the number of
4698 columns by which window is scrolled from left margin.
4700 When the `track-eol' feature is doing its job, the value is
4705 Outline mode sets this."
4710 "When non-nil, `line-move' moves point by visual lines.
4711 This movement is based on where the cursor is displayed on the
4712 screen, instead of relying on buffer contents alone. It takes
4713 into account variable-width characters and line continuation.
4714 If nil, `line-move' moves point by logical lines.
4715 A non-nil setting of `goal-column' overrides the value of this variable
4716 and forces movement by logical lines.
4717 A window that is horizontally scrolled also forces movement by logical
4718 lines."
4723 ;; Only used if display-graphic-p.
4727 "Return the height in pixels of the current buffer's default face font."
4731 ;; Avoid calling font-info if the frame's default font was
4732 ;; not changed since the frame was created. That's because
4733 ;; font-info is expensive for some fonts, see bug #14838.
4739 "Return the pixel height of current buffer's default-face text line.
4741 The value includes `line-spacing', if any, defined for the buffer
4742 or the frame."
4755 "Return the number of screen lines in the text area of the selected window.
4757 This is different from `window-text-height' in that this function counts
4758 lines in units of the height of the font used by the default face displayed
4759 in the window, not in units of the frame's default font, and also accounts
4760 for `line-spacing', if any, defined for the window's buffer or frame.
4762 The value is a floating-point number."
4768 ;; Returns non-nil if partial move was done.
4771 ;; Move backward (up).
4772 ;; If already vscrolled, reduce vscroll
4778 ;; Move forward (down).
4791 py vs last-line)
4811 col-row)
4816 ;; VPOS > 0 means the last line is only partially visible.
4817 ;; But if the part that is visible is at least as tall as the
4818 ;; default font, that means the line is actually fully
4819 ;; readable, and something like line-spacing is hidden. So in
4820 ;; that case we accept the last line in the window as still
4821 ;; visible, and consider the margin as starting one line
4822 ;; later.
4830 ;; If last line of window is fully visible, and vscrolling
4831 ;; more would make this line invisible, move forward.
4836 nil)
4837 ;; If cursor is not in the bottom scroll margin, and the
4838 ;; current line is is not too tall, move forward.
4840 vpos
4843 nil)
4844 ;; When already vscrolled, we vscroll some more if we can,
4845 ;; or clear vscroll and move forward at end of tall image.
4850 ;; If cursor just entered the bottom scroll margin, move forward,
4851 ;; but also optionally vscroll one line so redisplay won't recenter.
4855 ;; Don't vscroll if the partially-visible line at window
4856 ;; bottom is not too tall (a.k.a. "just one more text
4857 ;; line"): in that case, we do want redisplay to behave
4858 ;; normally, i.e. recenter or whatever.
4859 ;;
4860 ;; Note: ROWH + RBOT from the value returned by
4861 ;; pos-visible-in-window-p give the total height of the
4862 ;; partially-visible glyph row at the end of the window. As
4863 ;; we are dealing with floats, we disregard sub-pixel
4864 ;; discrepancies between that and DLH.
4868 t)
4869 ;; If there are lines above the last line, scroll-up one line.
4872 t)
4873 ;; Finally, start vscroll.
4878 ;; This is like line-move-1 except that it also performs
4879 ;; vertical scrolling of tall images if appropriate.
4880 ;; That is not really a clean thing to do, since it mixes
4881 ;; scrolling with cursor motion. But so far we don't have
4882 ;; a cleaner solution to the problem of making C-n do something
4883 ;; useful given a tall image.
4888 ;; Only vscroll for single line moves
4890 ;; Under scroll-conservatively, the display engine
4891 ;; does this better.
4893 ;; But don't vscroll in a keyboard macro.
4899 ;; Display-based column are incompatible with goal-column.
4901 ;; When the text in the window is scrolled to the left,
4902 ;; display-based motion doesn't make sense (because each
4903 ;; logical line occupies exactly one screen line).
4906 ;; If we moved into a tall line, set vscroll to make
4907 ;; scrolling through tall images more smooth.
4911 winh)
4917 nil
4921 ;; Display-based alternative to line-move-1.
4922 ;; Arg says how many lines to move. The value is t if we can move the
4923 ;; specified number of lines.
4927 target-hscroll)
4928 ;; Check if the previous command was a line-motion command, or if
4929 ;; we were called from some other command.
4932 ;; If so, there's no need to reset `temporary-goal-column',
4933 ;; but we may need to hscroll.
4937 ;; Otherwise, we should reset `temporary-goal-column'.
4940 ;; Handle the `overflow-newline-into-fringe' case:
4949 ;; vertical-motion can move more than it was asked to if it moves
4950 ;; across display strings with newlines. We don't want to ring
4951 ;; the bell and announce beginning/end of buffer in that case.
4957 temporary-goal-column))
4958 arg))
4959 arg))
4965 temporary-goal-column))
4966 arg))
4967 arg)))
4970 ;; If the goal column lies on a display string,
4971 ;; `vertical-motion' advances the cursor to the end
4972 ;; of the string. For arg < 0, this can cause the
4973 ;; cursor to get stuck. (Bug#3020).
4977 nil)))))
4979 ;; This is the guts of next-line and previous-line.
4980 ;; Arg says how many lines to move.
4981 ;; The value is t if we can move the specified number of lines.
4983 ;; Don't run any point-motion hooks, and disregard intangibility,
4984 ;; for intermediate positions.
4996 ;; Don't count beg of empty line as end of line
4997 ;; unless we just did explicit end-of-line.
4999 most-positive-fixnum
5003 line-move-ignore-invisible))
5004 ;; Use just newline characters.
5005 ;; Set ARG to 0 if we move as many lines as requested.
5008 ;; This way of moving forward ARG lines
5009 ;; verifies that we have a newline after the last one.
5010 ;; It doesn't get confused by intangible text.
5019 'beginning-of-buffer
5021 nil)))
5022 ;; Move by arg lines, but ignore invisible ones.
5025 ;; If the following character is currently invisible,
5026 ;; skip all characters with that same `invisible' property value.
5029 ;; Move a line.
5030 ;; We don't use `end-of-line', since we want to escape
5031 ;; from field boundaries occurring exactly at point.
5037 ;; If there's no invisibility here, move over the newline.
5046 ;; We avoid vertical-motion when possible
5047 ;; because that has to fontify.
5049 ;; Otherwise move a more sophisticated way.
5056 ;; The logic of this is the same as the loop above,
5057 ;; it just goes in the other direction.
5059 ;; For completely consistency with the forward-motion
5060 ;; case, we should call beginning-of-line here.
5061 ;; However, if point is inside a field and on a
5062 ;; continued line, the call to (vertical-motion -1)
5063 ;; below won't move us back far enough; then we return
5064 ;; to the same column in line-move-finish, and point
5065 ;; gets stuck -- cyd
5083 ;; if our target is the middle of this line.
5088 ;; This is the value the function returns.
5092 ;; If we did not move down as far as desired, at least go
5093 ;; to end of line. Be sure to call point-entered and
5094 ;; point-left-hooks.
5100 ;; If we did not move up as far as desired,
5101 ;; at least go to beginning of line.
5113 ;; Set REPEAT to t to repeat the whole thing.
5120 ;; Compute the end of the line
5121 ;; ignoring effectively invisible newlines.
5123 ;; Like end-of-line but ignores fields.
5130 ;; Move to the desired column.
5133 ;; Corner case: suppose we start out in a field boundary in
5134 ;; the middle of a continued line. When we get to
5135 ;; line-move-finish, point is at the start of a new *screen*
5136 ;; line but the same text line; then line-move-to-column would
5137 ;; move us backwards. Test using C-n with point on the "x" in
5138 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5145 ;; Process intangibility within a line.
5146 ;; With inhibit-point-motion-hooks bound to nil, a call to
5147 ;; goto-char moves point past intangible text.
5149 ;; However, inhibit-point-motion-hooks controls both the
5150 ;; intangibility and the point-entered/point-left hooks. The
5151 ;; following hack avoids calling the point-* hooks
5152 ;; unnecessarily. Note that we move *forward* past intangible
5153 ;; text when the initial and final points are the same.
5158 ;; If intangibility moves us to a different (later) place
5159 ;; in the same line, use that as the destination.
5162 ;; If that position is "too late",
5163 ;; try the previous allowable position.
5164 ;; See if it is ok.
5167 ;; If going forward, don't accept the previous
5168 ;; allowable position if it is before the target line.
5170 ;; If going backward, don't accept the previous
5171 ;; allowable position if it is still after the target line.
5174 ;; As a last resort, use the end of the line.
5177 ;; Now move to the updated destination, processing fields
5178 ;; as well as intangibility.
5182 ;; Ignore field boundaries if the initial and final
5183 ;; positions have the same `field' property, even if the
5184 ;; fields are non-contiguous. This seems to be "nicer"
5185 ;; behavior in many situations.
5188 new
5192 ;; If all this moved us to a different line,
5193 ;; retry everything within that new line.
5195 ;; Repeat the intangibility and field processing.
5199 "Try to find column COL, considering invisibility.
5200 This function works only in certain cases,
5201 because what we really need is for `move-to-column'
5202 and `current-column' to be able to ignore invisible text."
5211 ;; If the following character is currently invisible,
5212 ;; skip all characters with that same `invisible' property value.
5216 ;; Have we advanced to a larger column position?
5218 ;; We have made some progress towards the desired column.
5219 ;; See if we can make any further progress.
5221 ;; Otherwise, go to the place we originally found
5222 ;; and move back over invisible text.
5223 ;; that will get us to the same place on the screen
5224 ;; but with a more reasonable buffer position.
5231 "Move point to end of current line as displayed.
5232 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5233 If point reaches the beginning or end of buffer, it stops there.
5235 To ignore the effects of the `intangible' text or overlay
5236 property, bind `inhibit-point-motion-hooks' to t.
5237 If there is an image in the current line, this function
5238 disregards newlines that are part of the text on which the image
5239 rests."
5249 ;; With bidi reordering, we may not be at bol,
5250 ;; so make sure we are.
5265 ;; If we skipped something intangible and now we're not
5266 ;; really at eol, keep going.
5271 "Move point to beginning of current line as displayed.
5272 \(If there's an image in the line, this disregards newlines
5273 which are part of the text that the image rests on.)
5275 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5276 If point reaches the beginning or end of buffer, it stops there.
5277 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5282 first-vis first-vis-field-value)
5284 ;; Move by lines, if ARG is not 1 (the default).
5289 ;; Move to beginning-of-line, ignoring fields and invisible text.
5295 ;; Now find first visible char in the line
5300 ;; See if fields would stop us from reaching FIRST-VIS.
5305 ;; If yes, obey them.
5306 first-vis-field-value
5307 ;; Otherwise, move to START with attention to fields.
5308 ;; (It is possible that fields never matter in this case.)
5313 ;; Many people have said they rarely use this feature, and often type
5314 ;; it by accident. Maybe it shouldn't even be on a key.
5319 Those commands will move to this position in the line moved to
5320 rather than trying to keep the same horizontal position.
5321 With a non-nil argument ARG, clears out the goal column
5323 The goal column is stored in the variable `goal-column'."
5330 ;; The older method below can be erroneous if `set-goal-column' is bound
5331 ;; to a sequence containing %
5332 ;;(message (substitute-command-keys
5333 ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)")
5334 ;;goal-column)
5341 )
5342 nil)
5343 \f
5344 ;;; Editing based on visual lines, as opposed to logical lines.
5347 "Move point to end of current visual line.
5348 With argument N not nil or 1, move forward N - 1 visual lines first.
5349 If point reaches the beginning or end of buffer, it stops there.
5350 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5356 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5357 ;; constrain to field boundaries, so we don't either.
5361 "Move point to beginning of current visual line.
5362 With argument N not nil or 1, move forward N - 1 visual lines first.
5363 If point reaches the beginning or end of buffer, it stops there.
5364 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5372 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5376 "Kill the rest of the visual line.
5377 With prefix argument ARG, kill that many visual lines from point.
5378 If ARG is negative, kill visual lines backward.
5379 If ARG is zero, kill the text before point on the current visual
5380 line.
5382 If you want to append the killed line to the last killed text,
5385 If the buffer is read-only, Emacs will beep and refrain from deleting
5386 the line, but put the line in the kill ring anyway. This means that
5387 you can use this command to copy text from a read-only buffer.
5388 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5389 even beep.)"
5391 ;; Like in `kill-line', it's better to move point to the other end
5392 ;; of the kill before killing.
5400 ;; Skip any trailing whitespace at the end of the visual line.
5401 ;; We used to do this only if `show-trailing-whitespace' is
5402 ;; nil, but that's wrong; the correct thing would be to check
5403 ;; whether the trailing whitespace is highlighted. But, it's
5404 ;; OK to just do this unconditionally.
5411 "Move cursor vertically down ARG lines.
5412 This is identical to `next-line', except that it always moves
5413 by logical lines instead of visual lines, ignoring the value of
5414 the variable `line-move-visual'."
5421 "Move cursor vertically up ARG lines.
5422 This is identical to `previous-line', except that it always moves
5423 by logical lines instead of visual lines, ignoring the value of
5424 the variable `line-move-visual'."
5431 "Editing based on visual lines."
5440 ;; These keybindings interfere with xterm function keys. Are
5441 ;; there any other suitable bindings?
5442 ;; (define-key map "\M-[" 'previous-logical-line)
5443 ;; (define-key map "\M-]" 'next-logical-line)
5444 map))
5447 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5448 The value should be a list of the form (LEFT RIGHT), where LEFT
5449 and RIGHT are symbols representing the bitmaps to display, to
5450 indicate wrapped lines, in the left and right fringes respectively.
5451 See also `fringe-indicator-alist'.
5452 The default is not to display fringe indicators for wrapped lines.
5453 This variable does not affect fringe indicators displayed for
5454 other purposes."
5469 'continuation
5476 "Toggle visual line based editing (Visual Line mode).
5477 With a prefix argument ARG, enable Visual Line mode if ARG is
5478 positive, and disable it otherwise. If called from Lisp, enable
5479 the mode if ARG is omitted or nil.
5481 When Visual Line mode is enabled, `word-wrap' is turned on in
5482 this buffer, and simple editing commands are redefined to act on
5483 visual lines, not logical lines. See Info node `Visual Line
5484 Mode' for details."
5485 :keymap visual-line-mode-map
5491 ;; Save the local values of some variables, to be restored if
5492 ;; visual-line-mode is turned off.
5494 truncate-partial-width-windows
5495 word-wrap fringe-indicator-alist))
5498 visual-line--saved-state)))
5502 word-wrap t
5503 fringe-indicator-alist
5505 fringe-indicator-alist)))
5519 visual-line-mode turn-on-visual-line-mode)
5521 \f
5523 "Interchange characters around point, moving forward one character.
5524 With prefix arg ARG, effect is to take character before point
5525 and drag it forward past ARG other characters (backward if ARG negative).
5526 If no argument and at end of line, the previous two chars are exchanged."
5532 "Interchange words around point, leaving point at end of them.
5533 With prefix arg ARG, effect is to take word before or around point
5534 and drag it forward past ARG other words (backward if ARG negative).
5535 If ARG is zero, the words around or after point and around or after mark
5536 are interchanged."
5537 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5543 Does not work on a sexp that point is in the middle of
5544 if it is a list or string."
5548 ;; Here we should try to simulate the behavior of
5549 ;; (cons (progn (forward-sexp x) (point))
5550 ;; (progn (forward-sexp (- x)) (point)))
5551 ;; Except that we don't want to rely on the second forward-sexp
5552 ;; putting us back to where we want to be, since forward-sexp-function
5553 ;; might do funny things like infix-precedence.
5558 ;; Jumping over a symbol. We might be inside it, mind you.
5563 ;; Otherwise, we're between sexps. Take a step back before jumping
5564 ;; to make sure we'll obey the same precedence no matter which direction
5565 ;; we're going.
5570 'skip-syntax-forward
5577 "Exchange current line and previous line, leaving point after both.
5578 With argument ARG, takes previous line and moves it past ARG lines.
5579 With argument 0, interchanges line point is in with line mark is in."
5585 ;; Move forward over ARG lines,
5586 ;; but create newlines if necessary.
5593 arg))
5595 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5596 ;; which seems inconsistent with the ARG /= 0 case.
5597 ;; FIXME document SPECIAL.
5599 "Subroutine to do the work of transposing objects.
5600 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5601 moves forward by units of the given object (e.g. forward-sentence,
5602 forward-paragraph). If ARG is zero, exchanges the current object
5603 with the one containing mark. If ARG is an integer, moves the
5604 current object past ARG following (if ARG is positive) or
5605 preceding (if ARG is negative) objects, leaving point after the
5606 current object."
5611 pos1 pos2)
5639 ;; This sequence of insertions attempts to preserve marker
5640 ;; positions at the start and end of the transposed objects.
5654 \f
5656 "Move backward until encountering the beginning of a word.
5657 With argument ARG, do this that many times.
5658 If ARG is omitted or nil, move point backward one word."
5663 "Set mark ARG words away from point.
5665 move to with the same argument.
5666 Interactively, if this command is repeated
5667 or (in Transient Mark mode) if the mark is active,
5668 it marks the next ARG words after the ones already marked."
5685 nil t))))
5688 "Kill characters forward until encountering the end of a word.
5689 With argument ARG, do this that many times."
5694 "Kill characters backward until encountering the beginning of a word.
5695 With argument ARG, do this that many times."
5700 "Return the symbol or word that point is on (or a nearby one) as a string.
5701 The return value includes no text properties.
5702 If optional arg STRICT is non-nil, return nil unless point is within
5703 or adjacent to a symbol or word. In all cases the value can be nil
5704 if there is no word nearby.
5705 The function, belying its name, normally finds a symbol.
5706 If optional arg REALLY-WORD is non-nil, it finds just a word."
5715 ;; Point is neither within nor adjacent to a word.
5717 ;; Look for preceding word in same line.
5720 ;; No preceding word in same line.
5721 ;; Look for following word in same line.
5730 ;; If we found something nonempty, return it as a string.
5733 \f
5735 "String for filling to insert at front of new line, or nil for none."
5737 string)
5743 "Regexp to match lines which should not be auto-filled."
5745 regexp)
5749 "The default value for `normal-auto-fill-function'.
5750 This is the default auto-fill function, some major modes use a different one.
5751 Returns t if it really did any work."
5761 nil ;; Auto-filling not required
5765 ;; Choose a fill-prefix automatically.
5773 ;; Use auto-indentation rather than a guessed empty prefix.
5779 ;; Determine where to split the line.
5792 ;; See whether the place we found is any good.
5796 ;; There is no use breaking at end of line.
5798 ;; It is futile to split at the end of the prefix
5799 ;; since we would just insert the prefix again.
5801 ;; Don't split right after a comment starter
5802 ;; since we would just make another comment starter.
5807 limit t)
5809 ;; No good place to break => stop trying.
5811 ;; Ok, we have a useful place to break the line. Do it.
5813 ;; If point is at the fill-point, do not `save-excursion'.
5814 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5815 ;; point will end up before it rather than after it.
5823 ;; Now do justification, if required
5828 ;; If making the new line didn't reduce the hpos of
5829 ;; the end of the line, then give up now;
5830 ;; trying again will not help.
5833 ;; Justify last line.
5835 t)))
5838 "Mode-specific function which line breaks and continues a comment.
5839 This function is called during auto-filling when a comment syntax
5840 is defined.
5841 The function should take a single optional argument, which is a flag
5845 "Break line at point and indent.
5846 If a comment syntax is defined, call `comment-indent-new-line'.
5848 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5849 unless optional argument SOFT is non-nil."
5853 ;; Insert the newline before removing empty space so that markers
5854 ;; get preserved better.
5860 ;; Blindly trust a non-adaptive fill-prefix.
5866 ;; If there's an adaptive prefix, use it unless we're inside
5867 ;; a comment and the prefix is not a comment starter.
5871 ;; If we're not inside a comment, just try to indent.
5875 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5879 ;; `functions' and `hooks' are usually unsafe to set, but setting
5880 ;; auto-fill-function to nil in a file-local setting is safe and
5881 ;; can be useful to prevent auto-filling.
5885 "Toggle automatic line breaking (Auto Fill mode).
5886 With a prefix argument ARG, enable Auto Fill mode if ARG is
5887 positive, and disable it otherwise. If called from Lisp, enable
5888 the mode if ARG is omitted or nil.
5890 When Auto Fill mode is enabled, inserting a space at a column
5891 beyond `current-fill-column' automatically breaks the line at a
5892 previous space.
5894 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5895 non-`nil'.
5897 The value of `normal-auto-fill-function' specifies the function to use
5898 for `auto-fill-function' when turning Auto Fill mode on."
5903 ;; This holds a document string used to document auto-fill-mode.
5905 "Automatically break line at a previous space, in insertion of text."
5906 nil)
5909 "Unconditionally turn on Auto Fill mode."
5913 "Unconditionally turn off Auto Fill mode."
5919 "Set `fill-column' to specified argument.
5924 ;; We used to use current-column silently, but C-x f is too easily
5925 ;; typed as a typo for C-x C-f, so we turned it into an error and
5926 ;; now an interactive prompt.
5931 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5935 \f
5937 "Set `selective-display' to ARG; clear it if no arg.
5938 When the value of `selective-display' is a number > 0,
5939 lines whose indentation is >= that value are not displayed.
5940 The variable `selective-display' has a separate value for each buffer."
5960 "Toggle truncating of long lines for the current buffer.
5961 When truncating is off, long lines are folded.
5962 With prefix argument ARG, truncate long lines if ARG is positive,
5963 otherwise fold them. Note that in side-by-side windows, this
5964 command has no effect if `truncate-partial-width-windows' is
5965 non-nil."
5977 nil t)))
5982 "Toggle whether to use word-wrapping for continuation lines.
5983 With prefix argument ARG, wrap continuation lines at word boundaries
5984 if ARG is positive, otherwise wrap them at the right screen edge.
5985 This command toggles the value of `word-wrap'. It has no effect
5986 if long lines are truncated."
6002 "Toggle Overwrite mode.
6003 With a prefix argument ARG, enable Overwrite mode if ARG is
6004 positive, and disable it otherwise. If called from Lisp, enable
6005 the mode if ARG is omitted or nil.
6007 When Overwrite mode is enabled, printing characters typed in
6008 replace existing text on a one-for-one basis, rather than pushing
6009 it to the right. At the end of a line, such characters extend
6010 the line. Before a tab, such characters insert until the tab is
6012 overwrite mode; this is supposed to make it easier to insert
6013 characters when necessary."
6018 "Toggle Binary Overwrite mode.
6019 With a prefix argument ARG, enable Binary Overwrite mode if ARG
6020 is positive, and disable it otherwise. If called from Lisp,
6021 enable the mode if ARG is omitted or nil.
6023 When Binary Overwrite mode is enabled, printing characters typed
6024 in replace existing text. Newlines are not treated specially, so
6025 typing at the end of a line joins the line to the next, with the
6026 typed character between them. Typing before a tab character
6027 simply replaces the tab with the character typed.
6029 ordinary typing characters do.
6031 Note that Binary Overwrite mode is not its own minor mode; it is
6032 a specialization of overwrite mode, entered by setting the
6033 `overwrite-mode' variable to `overwrite-mode-binary'."
6038 "Toggle line number display in the mode line (Line Number mode).
6039 With a prefix argument ARG, enable Line Number mode if ARG is
6040 positive, and disable it otherwise. If called from Lisp, enable
6041 the mode if ARG is omitted or nil.
6043 Line numbers do not appear for very large buffers and buffers
6044 with very long lines; see variables `line-number-display-limit'
6045 and `line-number-display-limit-width'."
6049 "Toggle column number display in the mode line (Column Number mode).
6050 With a prefix argument ARG, enable Column Number mode if ARG is
6051 positive, and disable it otherwise.
6053 If called from Lisp, enable the mode if ARG is omitted or nil."
6057 "Toggle buffer size display in the mode line (Size Indication mode).
6058 With a prefix argument ARG, enable Size Indication mode if ARG is
6059 positive, and disable it otherwise.
6061 If called from Lisp, enable the mode if ARG is omitted or nil."
6065 "Toggle auto-saving in the current buffer (Auto Save mode).
6066 With a prefix argument ARG, enable Auto Save mode if ARG is
6067 positive, and disable it otherwise.
6069 If called from Lisp, enable the mode if ARG is omitted or nil."
6071 ;; If auto-save is off because buffer has shrunk,
6072 ;; then toggling should turn it on.
6080 buffer-file-name)
6082 ;; If -1 was stored here, to temporarily turn off saving,
6083 ;; turn it back on.
6086 \f
6088 "Blinking matching of parens and expressions."
6093 "Non-nil means show matching open-paren when close-paren is inserted."
6098 "Non-nil means show matching open-paren when it is on screen.
6099 If nil, don't show it (but the open-paren can still be shown
6100 when it is off screen).
6102 This variable has no effect if `blink-matching-paren' is nil.
6103 \(In that case, the open-paren is never shown.)
6104 It is also ignored if `show-paren-mode' is enabled."
6109 "If non-nil, maximum distance to search backwards for matching open-paren.
6110 If nil, search stops at the beginning of the accessible portion of the buffer."
6116 "Time in seconds to delay after showing a matching paren."
6121 "If nil, `blink-matching-paren' ignores comments.
6122 More precisely, when looking for the matching parenthesis,
6123 it skips the contents of comments that end before point."
6128 "Return whether or not START...END are matching parens.
6129 END is the current point and START is the blink position.
6130 START might be nil if no matching starter was found.
6131 Returns non-nil if we find there is a mismatch."
6136 ;; For self-matched chars like " and $, we can't know when they're
6137 ;; mismatched or unmatched, so we can only do it for parens.
6142 ;; The cdr might hold a new paren-class info rather than
6143 ;; a matching-char info, in which case the two CDRs
6144 ;; should match.
6148 "Function to check parentheses mismatches.
6149 The function takes two arguments (START and END) where START is the
6150 position just before the opening token and END is the position right after.
6151 START can be nil, if it was not found.
6155 "Move cursor momentarily to the beginning of the sexp before point."
6158 blink-matching-paren)
6168 oldpos))
6175 ;; backward-sexp skips backward over prefix chars,
6176 ;; so move back to the matching paren.
6197 ;; Matching open within window, temporarily move to blinkpos but only
6198 ;; if `blink-matching-paren-on-screen' is non-nil.
6208 ;; Show what precedes the open in its line, if anything.
6213 ;; Show what follows the open in its line, if anything.
6220 ;; Otherwise show the previous nonblank line,
6221 ;; if there is one.
6230 ;; Replace the newline and other whitespace with `...'.
6231 "..."
6233 ;; There is nothing to show except the char itself.
6239 "Function called, if non-nil, whenever a close parenthesis is inserted.
6245 blink-paren-function
6248 ;; Verify an even number of quoting characters precede the close.
6257 ;; Most likely, this hook is nil, so this arg doesn't matter,
6258 ;; but I use it as a reminder that this function usually
6259 ;; likes to be run after others since it does `sit-for'.
6261 \f
6262 ;; This executes C-g typed while Emacs is waiting for a command.
6263 ;; Quitting out of a program does not go through here;
6264 ;; that happens in the QUIT macro at the C code level.
6266 "Signal a `quit' condition.
6267 During execution of Lisp code, this character causes a quit directly.
6268 At top-level, as an editor command, this simply beeps."
6270 ;; Avoid adding the region to the window selection.
6287 This command can exit an interactive command such as `query-replace',
6288 can clear out a prefix argument or a region,
6289 can get out of the minibuffer or other recursive edit,
6290 cancel the use of the current buffer (for special-purpose buffers),
6291 or go back to just one window (by deleting all but the selected window)."
6299 nil)
6310 "Play sound stored in FILE.
6311 VOLUME and DEVICE correspond to the keywords of the sound
6312 specification for `play-sound'."
6322 \f
6324 "Your preference for a mail reading package.
6325 This is used by some keybindings which support reading mail.
6326 See also `mail-user-agent' concerning sending mail."
6336 "Your preference for a mail composition package.
6337 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6338 outgoing email message. This variable lets you specify which
6339 mail-sending package you prefer.
6341 Valid values include:
6343 `message-user-agent' -- use the Message package.
6344 See Info node `(message)'.
6345 `sendmail-user-agent' -- use the Mail package.
6346 See Info node `(emacs)Sending Mail'.
6347 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6348 See Info node `(mh-e)'.
6349 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6350 paraphernalia if Gnus is running, particularly
6351 the Gcc: header for archiving.
6353 Additional valid symbols may be available; check with the author of
6354 your package for details. The function should return non-nil if it
6355 succeeds.
6357 See also `read-mail-command' concerning reading mail."
6360 message-user-agent)
6363 sendmail-user-agent)
6366 mh-e-user-agent)
6369 gnus-user-agent)
6375 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6376 If the value of `mail-user-agent' is the default, and the user
6377 appears to have customizations applying to the old default,
6378 `compose-mail' issues a warning."
6384 "If the buffer starts with a mail header, move point to the header's end.
6385 Otherwise, moves to `point-min'.
6386 The end of the header is the start of the next line, if there is one,
6387 else the end of the last line. This function obeys RFC822."
6393 ;; Used by Rmail (e.g., rmail-forward).
6395 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6399 switch-function yank-action send-actions
6400 return-action)
6401 "Start composing a mail message to send.
6402 This uses the user's chosen mail composition package
6403 as selected with the variable `mail-user-agent'.
6404 The optional arguments TO and SUBJECT specify recipients
6405 and the initial Subject field, respectively.
6407 OTHER-HEADERS is an alist specifying additional
6408 header fields. Elements look like (HEADER . VALUE) where both
6409 HEADER and VALUE are strings.
6411 CONTINUE, if non-nil, says to continue editing a message already
6412 being composed. Interactively, CONTINUE is the prefix argument.
6414 SWITCH-FUNCTION, if non-nil, is a function to use to
6415 switch to and display the buffer used for mail composition.
6417 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6418 to insert the raw text of the message being replied to.
6419 It has the form (FUNCTION . ARGS). The user agent will apply
6420 FUNCTION to ARGS, to insert the raw text of the original message.
6421 \(The user agent will also run `mail-citation-hook', *after* the
6422 original text has been inserted in this way.)
6424 SEND-ACTIONS is a list of actions to call when the message is sent.
6425 Each action has the form (FUNCTION . ARGS).
6427 RETURN-ACTION, if non-nil, is an action for returning to the
6428 caller. It has the form (FUNCTION . ARGS). The function is
6429 called after the mail has been sent or put aside, and the mail
6430 buffer buried."
6434 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6435 ;; from sendmail-user-agent to message-user-agent. Some users may
6436 ;; encounter incompatibilities. This hack tries to detect problems
6437 ;; and warn about them.
6442 mail-yank-hooks mail-archive-file-name
6443 mail-default-reply-to mail-mailing-lists
6444 mail-self-blind))
6451 The default mail mode is now Message mode.
6452 You have the following Mail mode variable%s customized:
6454 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6461 yank-action send-actions return-action)))
6464 yank-action send-actions
6465 return-action)
6469 'switch-to-buffer-other-window yank-action send-actions
6470 return-action))
6473 yank-action send-actions
6474 return-action)
6478 'switch-to-buffer-other-frame yank-action send-actions
6479 return-action))
6481 \f
6483 "History of values entered with `set-variable'.
6485 Maximum length of the history list is determined by the value
6489 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6490 VARIABLE should be a user option variable name, a Lisp variable
6491 meant to be customized by users. You should enter VALUE in Lisp syntax,
6492 so if you want VALUE to be a string, you must surround it with doublequotes.
6493 VALUE is used literally, not evaluated.
6495 If VARIABLE has a `variable-interactive' property, that is used as if
6496 it were the arg to `interactive' (which see) to interactively read VALUE.
6498 If VARIABLE has been defined with `defcustom', then the type information
6499 in the definition is used to check that VALUE is valid.
6501 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6506 default-var)
6522 var obsolete)
6525 ;; Use VAR's `variable-interactive' property
6526 ;; as an interactive spec for prompting.
6529 arg))
6531 read-expression-map t
6532 'set-variable-value-history
6541 ;; Match with custom type.
6553 ;; Force a thorough redisplay for the case that the variable
6554 ;; has an effect on the display, like `tab-width' has.
6556 \f
6557 ;; Define the major mode for lists of completions.
6567 (define-key map [right] 'next-completion)
6568 (define-key map "q" 'quit-window)
6569 (define-key map "z" 'kill-this-buffer)
6570 map)
6571 "Local map for completion list buffers.")
6573 ;; Completion mode is suitable only for specially formatted data.
6574 (put 'completion-list-mode 'mode-class 'special)
6576 (defvar completion-reference-buffer nil
6577 "Record the buffer that was current when the completion list was requested.
6578 This is a local variable in the completion list buffer.
6579 Initial value is nil to avoid some compiler warnings.")
6581 (defvar completion-no-auto-exit nil
6582 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6583 This also applies to other functions such as `choose-completion'.")
6585 (defvar completion-base-position nil
6586 "Position of the base of the text corresponding to the shown completions.
6587 This variable is used in the *Completions* buffers.
6588 Its value is a list of the form (START END) where START is the place
6589 where the completion should be inserted and END (if non-nil) is the end
6590 of the text to replace. If END is nil, point is used instead.")
6592 (defvar completion-list-insert-choice-function #'completion--replace
6593 "Function to use to insert the text chosen in *Completions*.
6594 Called with three arguments (BEG END TEXT), it should replace the text
6595 between BEG and END with TEXT. Expected to be set buffer-locally
6596 in the *Completions* buffer.")
6598 (defvar completion-base-size nil
6599 "Number of chars before point not involved in completion.
6600 This is a local variable in the completion list buffer.
6601 It refers to the chars in the minibuffer if completing in the
6602 minibuffer, or in `completion-reference-buffer' otherwise.
6603 Only characters in the field at point are included.
6605 If nil, Emacs determines which part of the tail end of the
6606 buffer's text is involved in completion by comparing the text
6607 directly.")
6608 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6610 (defun delete-completion-window ()
6611 "Delete the completion list window.
6612 Go to the window from which completion was requested."
6613 (interactive)
6614 (let ((buf completion-reference-buffer))
6615 (if (one-window-p t)
6616 (if (window-dedicated-p) (delete-frame))
6617 (delete-window (selected-window))
6618 (if (get-buffer-window buf)
6619 (select-window (get-buffer-window buf))))))
6621 (defun previous-completion (n)
6622 "Move to the previous item in the completion list."
6623 (interactive "p")
6624 (next-completion (- n)))
6626 (defun next-completion (n)
6627 "Move to the next item in the completion list.
6628 With prefix argument N, move N items (negative N means move backward)."
6629 (interactive "p")
6630 (let ((beg (point-min)) (end (point-max)))
6631 (while (and (> n 0) (not (eobp)))
6632 ;; If in a completion, move to the end of it.
6633 (when (get-text-property (point) 'mouse-face)
6634 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6635 ;; Move to start of next one.
6636 (unless (get-text-property (point) 'mouse-face)
6637 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6638 (setq n (1- n)))
6639 (while (and (< n 0) (not (bobp)))
6640 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6641 ;; If in a completion, move to the start of it.
6642 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6643 (goto-char (previous-single-property-change
6644 (point) 'mouse-face nil beg)))
6645 ;; Move to end of the previous completion.
6646 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6647 (goto-char (previous-single-property-change
6648 (point) 'mouse-face nil beg)))
6649 ;; Move to the start of that one.
6650 (goto-char (previous-single-property-change
6651 (point) 'mouse-face nil beg))
6652 (setq n (1+ n))))))
6654 (defun choose-completion (&optional event)
6655 "Choose the completion at point."
6656 (interactive (list last-nonmenu-event))
6657 ;; In case this is run via the mouse, give temporary modes such as
6658 ;; isearch a chance to turn off.
6659 (run-hooks 'mouse-leave-buffer-hook)
6660 (with-current-buffer (window-buffer (posn-window (event-start event)))
6661 (let ((buffer completion-reference-buffer)
6662 (base-size completion-base-size)
6663 (base-position completion-base-position)
6664 (insert-function completion-list-insert-choice-function)
6665 (choice
6666 (save-excursion
6667 (goto-char (posn-point (event-start event)))
6668 (let (beg end)
6669 (cond
6670 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6671 (setq end (point) beg (1+ (point))))
6672 ((and (not (bobp))
6673 (get-text-property (1- (point)) 'mouse-face))
6674 (setq end (1- (point)) beg (point)))
6675 (t (error "No completion here")))
6676 (setq beg (previous-single-property-change beg 'mouse-face))
6677 (setq end (or (next-single-property-change end 'mouse-face)
6678 (point-max)))
6679 (buffer-substring-no-properties beg end)))))
6681 (unless (buffer-live-p buffer)
6682 (error "Destination buffer is dead"))
6683 (quit-window nil (posn-window (event-start event)))
6685 (with-current-buffer buffer
6686 (choose-completion-string
6687 choice buffer
6688 (or base-position
6689 (when base-size
6690 ;; Someone's using old completion code that doesn't know
6691 ;; about base-position yet.
6692 (list (+ base-size (field-beginning))))
6693 ;; If all else fails, just guess.
6694 (list (choose-completion-guess-base-position choice)))
6695 insert-function)))))
6697 ;; Delete the longest partial match for STRING
6698 ;; that can be found before POINT.
6699 (defun choose-completion-guess-base-position (string)
6700 (save-excursion
6701 (let ((opoint (point))
6702 len)
6703 ;; Try moving back by the length of the string.
6704 (goto-char (max (- (point) (length string))
6705 (minibuffer-prompt-end)))
6706 ;; See how far back we were actually able to move. That is the
6707 ;; upper bound on how much we can match and delete.
6708 (setq len (- opoint (point)))
6709 (if completion-ignore-case
6710 (setq string (downcase string)))
6711 (while (and (> len 0)
6712 (let ((tail (buffer-substring (point) opoint)))
6713 (if completion-ignore-case
6714 (setq tail (downcase tail)))
6715 (not (string= tail (substring string 0 len)))))
6716 (setq len (1- len))
6717 (forward-char 1))
6718 (point))))
6720 (defun choose-completion-delete-max-match (string)
6721 (declare (obsolete choose-completion-guess-base-position "23.2"))
6722 (delete-region (choose-completion-guess-base-position string) (point)))
6724 (defvar choose-completion-string-functions nil
6725 "Functions that may override the normal insertion of a completion choice.
6726 These functions are called in order with four arguments:
6727 CHOICE - the string to insert in the buffer,
6728 BUFFER - the buffer in which the choice should be inserted,
6729 MINI-P - non-nil if BUFFER is a minibuffer, and
6730 BASE-SIZE - the number of characters in BUFFER before
6731 the string being completed.
6733 If a function in the list returns non-nil, that function is supposed
6734 to have inserted the CHOICE in the BUFFER, and possibly exited
6735 the minibuffer; no further functions will be called.
6737 If all functions in the list return nil, that means to use
6738 the default method of inserting the completion in BUFFER.")
6740 (defun choose-completion-string (choice &optional
6741 buffer base-position insert-function)
6742 "Switch to BUFFER and insert the completion choice CHOICE.
6743 BASE-POSITION says where to insert the completion.
6744 INSERT-FUNCTION says how to insert the completion and falls
6745 back on `completion-list-insert-choice-function' when nil."
6747 ;; If BUFFER is the minibuffer, exit the minibuffer
6748 ;; unless it is reading a file name and CHOICE is a directory,
6749 ;; or completion-no-auto-exit is non-nil.
6751 ;; Some older code may call us passing `base-size' instead of
6752 ;; `base-position'. It's difficult to make any use of `base-size',
6753 ;; so we just ignore it.
6754 (unless (consp base-position)
6755 (message "Obsolete `base-size' passed to choose-completion-string")
6756 (setq base-position nil))
6758 (let* ((buffer (or buffer completion-reference-buffer))
6759 (mini-p (minibufferp buffer)))
6760 ;; If BUFFER is a minibuffer, barf unless it's the currently
6761 ;; active minibuffer.
6762 (if (and mini-p
6763 (not (and (active-minibuffer-window)
6764 (equal buffer
6765 (window-buffer (active-minibuffer-window))))))
6766 (error "Minibuffer is not active for completion")
6767 ;; Set buffer so buffer-local choose-completion-string-functions works.
6768 (set-buffer buffer)
6769 (unless (run-hook-with-args-until-success
6770 'choose-completion-string-functions
6771 ;; The fourth arg used to be `mini-p' but was useless
6772 ;; (since minibufferp can be used on the `buffer' arg)
6773 ;; and indeed unused. The last used to be `base-size', so we
6774 ;; keep it to try and avoid breaking old code.
6775 choice buffer base-position nil)
6776 ;; This remove-text-properties should be unnecessary since `choice'
6777 ;; comes from buffer-substring-no-properties.
6778 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6779 ;; Insert the completion into the buffer where it was requested.
6780 (funcall (or insert-function completion-list-insert-choice-function)
6781 (or (car base-position) (point))
6782 (or (cadr base-position) (point))
6783 choice)
6784 ;; Update point in the window that BUFFER is showing in.
6785 (let ((window (get-buffer-window buffer t)))
6786 (set-window-point window (point)))
6787 ;; If completing for the minibuffer, exit it with this choice.
6788 (and (not completion-no-auto-exit)
6789 (minibufferp buffer)
6790 minibuffer-completion-table
6791 ;; If this is reading a file name, and the file name chosen
6792 ;; is a directory, don't exit the minibuffer.
6793 (let* ((result (buffer-substring (field-beginning) (point)))
6794 (bounds
6795 (completion-boundaries result minibuffer-completion-table
6796 minibuffer-completion-predicate
6797 "")))
6798 (if (eq (car bounds) (length result))
6799 ;; The completion chosen leads to a new set of completions
6800 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6801 (let ((mini (active-minibuffer-window)))
6802 (select-window mini)
6803 (when minibuffer-auto-raise
6804 (raise-frame (window-frame mini))))
6805 (exit-minibuffer))))))))
6807 (define-derived-mode completion-list-mode nil "Completion List"
6808 "Major mode for buffers showing lists of possible completions.
6810 to select the completion near point.
6812 with the mouse.
6815 (set (make-local-variable 'completion-base-size) nil))
6817 (defun completion-list-mode-finish ()
6818 "Finish setup of the completions buffer.
6819 Called from `temp-buffer-show-hook'."
6820 (when (eq major-mode 'completion-list-mode)
6821 (setq buffer-read-only t)))
6823 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6826 ;; Variables and faces used in `completion-setup-function'.
6828 (defcustom completion-show-help t
6829 "Non-nil means show help message in *Completions* buffer."
6830 :type 'boolean
6831 :version "22.1"
6832 :group 'completion)
6834 ;; This function goes in completion-setup-hook, so that it is called
6835 ;; after the text of the completion list buffer is written.
6836 (defun completion-setup-function ()
6837 (let* ((mainbuf (current-buffer))
6838 (base-dir
6839 ;; FIXME: This is a bad hack. We try to set the default-directory
6840 ;; in the *Completions* buffer so that the relative file names
6841 ;; displayed there can be treated as valid file names, independently
6842 ;; from the completion context. But this suffers from many problems:
6843 ;; - It's not clear when the completions are file names. With some
6844 ;; completion tables (e.g. bzr revision specs), the listed
6845 ;; completions can mix file names and other things.
6846 ;; - It doesn't pay attention to possible quoting.
6847 ;; - With fancy completion styles, the code below will not always
6848 ;; find the right base directory.
6849 (if minibuffer-completing-file-name
6850 (file-name-as-directory
6851 (expand-file-name
6852 (buffer-substring (minibuffer-prompt-end)
6853 (- (point) (or completion-base-size 0))))))))
6854 (with-current-buffer standard-output
6855 (let ((base-size completion-base-size) ;Read before killing localvars.
6856 (base-position completion-base-position)
6857 (insert-fun completion-list-insert-choice-function))
6858 (completion-list-mode)
6859 (set (make-local-variable 'completion-base-size) base-size)
6860 (set (make-local-variable 'completion-base-position) base-position)
6861 (set (make-local-variable 'completion-list-insert-choice-function)
6862 insert-fun))
6863 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6864 (if base-dir (setq default-directory base-dir))
6865 ;; Maybe insert help string.
6866 (when completion-show-help
6867 (goto-char (point-min))
6868 (if (display-mouse-p)
6869 (insert (substitute-command-keys
6871 (insert (substitute-command-keys
6875 (add-hook 'completion-setup-hook 'completion-setup-function)
6877 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6878 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6880 (defun switch-to-completions ()
6881 "Select the completion list window."
6882 (interactive)
6883 (let ((window (or (get-buffer-window "*Completions*" 0)
6884 ;; Make sure we have a completions window.
6885 (progn (minibuffer-completion-help)
6886 (get-buffer-window "*Completions*" 0)))))
6887 (when window
6888 (select-window window)
6889 ;; In the new buffer, go to the first completion.
6890 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6891 (when (bobp)
6892 (next-completion 1)))))
6893 \f
6894 ;;; Support keyboard commands to turn on various modifiers.
6896 ;; These functions -- which are not commands -- each add one modifier
6897 ;; to the following event.
6899 (defun event-apply-alt-modifier (_ignore-prompt)
6902 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6903 (defun event-apply-super-modifier (_ignore-prompt)
6906 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6907 (defun event-apply-hyper-modifier (_ignore-prompt)
6910 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6911 (defun event-apply-shift-modifier (_ignore-prompt)
6914 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6915 (defun event-apply-control-modifier (_ignore-prompt)
6918 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6919 (defun event-apply-meta-modifier (_ignore-prompt)
6922 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6924 (defun event-apply-modifier (event symbol lshiftby prefix)
6925 "Apply a modifier flag to event EVENT.
6926 SYMBOL is the name of this modifier, as a symbol.
6927 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6928 PREFIX is the string that represents this modifier in an event type symbol."
6929 (if (numberp event)
6930 (cond ((eq symbol 'control)
6931 (if (and (<= (downcase event) ?z)
6932 (>= (downcase event) ?a))
6933 (- (downcase event) ?a -1)
6934 (if (and (<= (downcase event) ?Z)
6935 (>= (downcase event) ?A))
6936 (- (downcase event) ?A -1)
6937 (logior (lsh 1 lshiftby) event))))
6938 ((eq symbol 'shift)
6939 (if (and (<= (downcase event) ?z)
6940 (>= (downcase event) ?a))
6941 (upcase event)
6942 (logior (lsh 1 lshiftby) event)))
6943 (t
6944 (logior (lsh 1 lshiftby) event)))
6945 (if (memq symbol (event-modifiers event))
6946 event
6947 (let ((event-type (if (symbolp event) event (car event))))
6948 (setq event-type (intern (concat prefix (symbol-name event-type))))
6949 (if (symbolp event)
6950 event-type
6951 (cons event-type (cdr event)))))))
6953 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6954 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6955 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6956 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6957 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6958 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6959 \f
6960 ;;;; Keypad support.
6962 ;; Make the keypad keys act like ordinary typing keys. If people add
6963 ;; bindings for the function key symbols, then those bindings will
6964 ;; override these, so this shouldn't interfere with any existing
6965 ;; bindings.
6967 ;; Also tell read-char how to handle these keys.
6968 (mapc
6969 (lambda (keypad-normal)
6970 (let ((keypad (nth 0 keypad-normal))
6971 (normal (nth 1 keypad-normal)))
6972 (put keypad 'ascii-character normal)
6973 (define-key function-key-map (vector keypad) (vector normal))))
6974 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6975 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6976 (kp-space ?\s)
6979 (kp-multiply ?*)
6980 (kp-add ?+)
6981 (kp-separator ?,)
6982 (kp-subtract ?-)
6983 (kp-decimal ?.)
6984 (kp-divide ?/)
6985 (kp-equal ?=)
6986 ;; Do the same for various keys that are represented as symbols under
6987 ;; GUIs but naturally correspond to characters.
6988 (backspace 127)
6989 (delete 127)
6992 (clear ?\C-l)
6993 (return ?\C-m)
6994 (escape ?\e)
6995 ))
6996 \f
6997 ;;;;
6998 ;;;; forking a twin copy of a buffer.
6999 ;;;;
7001 (defvar clone-buffer-hook nil
7002 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
7004 (defvar clone-indirect-buffer-hook nil
7005 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
7007 (defun clone-process (process &optional newname)
7008 "Create a twin copy of PROCESS.
7009 If NEWNAME is nil, it defaults to PROCESS' name;
7010 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
7011 If PROCESS is associated with a buffer, the new process will be associated
7012 with the current buffer instead.
7013 Returns nil if PROCESS has already terminated."
7014 (setq newname (or newname (process-name process)))
7016 (setq newname (substring newname 0 (match-beginning 0))))
7017 (when (memq (process-status process) '(run stop open))
7018 (let* ((process-connection-type (process-tty-name process))
7019 (new-process
7020 (if (memq (process-status process) '(open))
7021 (let ((args (process-contact process t)))
7022 (setq args (plist-put args :name newname))
7023 (setq args (plist-put args :buffer
7024 (if (process-buffer process)
7025 (current-buffer))))
7026 (apply 'make-network-process args))
7027 (apply 'start-process newname
7028 (if (process-buffer process) (current-buffer))
7029 (process-command process)))))
7030 (set-process-query-on-exit-flag
7031 new-process (process-query-on-exit-flag process))
7032 (set-process-inherit-coding-system-flag
7033 new-process (process-inherit-coding-system-flag process))
7034 (set-process-filter new-process (process-filter process))
7035 (set-process-sentinel new-process (process-sentinel process))
7036 (set-process-plist new-process (copy-sequence (process-plist process)))
7037 new-process)))
7039 ;; things to maybe add (currently partly covered by `funcall mode'):
7040 ;; - syntax-table
7041 ;; - overlays
7042 (defun clone-buffer (&optional newname display-flag)
7043 "Create and return a twin copy of the current buffer.
7044 Unlike an indirect buffer, the new buffer can be edited
7045 independently of the old one (if it is not read-only).
7046 NEWNAME is the name of the new buffer. It may be modified by
7047 adding or incrementing <N> at the end as necessary to create a
7048 unique buffer name. If nil, it defaults to the name of the
7049 current buffer, with the proper suffix. If DISPLAY-FLAG is
7050 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
7051 clone a file-visiting buffer, or a buffer whose major mode symbol
7052 has a non-nil `no-clone' property, results in an error.
7054 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
7055 current buffer with appropriate suffix. However, if a prefix
7056 argument is given, then the command prompts for NEWNAME in the
7057 minibuffer.
7059 This runs the normal hook `clone-buffer-hook' in the new buffer
7060 after it has been set up properly in other respects."
7061 (interactive
7062 (progn
7063 (if buffer-file-name
7064 (error "Cannot clone a file-visiting buffer"))
7065 (if (get major-mode 'no-clone)
7066 (error "Cannot clone a buffer in %s mode" mode-name))
7067 (list (if current-prefix-arg
7068 (read-buffer "Name of new cloned buffer: " (current-buffer)))
7069 t)))
7070 (if buffer-file-name
7071 (error "Cannot clone a file-visiting buffer"))
7072 (if (get major-mode 'no-clone)
7073 (error "Cannot clone a buffer in %s mode" mode-name))
7074 (setq newname (or newname (buffer-name)))
7076 (setq newname (substring newname 0 (match-beginning 0))))
7077 (let ((buf (current-buffer))
7078 (ptmin (point-min))
7079 (ptmax (point-max))
7080 (pt (point))
7081 (mk (if mark-active (mark t)))
7082 (modified (buffer-modified-p))
7083 (mode major-mode)
7084 (lvars (buffer-local-variables))
7085 (process (get-buffer-process (current-buffer)))
7086 (new (generate-new-buffer (or newname (buffer-name)))))
7087 (save-restriction
7088 (widen)
7089 (with-current-buffer new
7090 (insert-buffer-substring buf)))
7091 (with-current-buffer new
7092 (narrow-to-region ptmin ptmax)
7093 (goto-char pt)
7094 (if mk (set-mark mk))
7095 (set-buffer-modified-p modified)
7097 ;; Clone the old buffer's process, if any.
7098 (when process (clone-process process))
7100 ;; Now set up the major mode.
7101 (funcall mode)
7103 ;; Set up other local variables.
7104 (mapc (lambda (v)
7105 (condition-case () ;in case var is read-only
7106 (if (symbolp v)
7107 (makunbound v)
7108 (set (make-local-variable (car v)) (cdr v)))
7109 (error nil)))
7110 lvars)
7112 ;; Run any hooks (typically set up by the major mode
7113 ;; for cloning to work properly).
7114 (run-hooks 'clone-buffer-hook))
7115 (if display-flag
7116 ;; Presumably the current buffer is shown in the selected frame, so
7117 ;; we want to display the clone elsewhere.
7118 (let ((same-window-regexps nil)
7119 (same-window-buffer-names))
7120 (pop-to-buffer new)))
7121 new))
7124 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7125 "Create an indirect buffer that is a twin copy of the current buffer.
7127 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7128 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7129 or if not called with a prefix arg, NEWNAME defaults to the current
7130 buffer's name. The name is modified by adding a `<N>' suffix to it
7131 or by incrementing the N in an existing suffix. Trying to clone a
7132 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7133 property results in an error.
7135 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7136 This is always done when called interactively.
7138 Optional third arg NORECORD non-nil means do not put this buffer at the
7139 front of the list of recently selected ones."
7140 (interactive
7141 (progn
7142 (if (get major-mode 'no-clone-indirect)
7143 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7144 (list (if current-prefix-arg
7145 (read-buffer "Name of indirect buffer: " (current-buffer)))
7146 t)))
7147 (if (get major-mode 'no-clone-indirect)
7148 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7149 (setq newname (or newname (buffer-name)))
7151 (setq newname (substring newname 0 (match-beginning 0))))
7152 (let* ((name (generate-new-buffer-name newname))
7153 (buffer (make-indirect-buffer (current-buffer) name t)))
7154 (with-current-buffer buffer
7155 (run-hooks 'clone-indirect-buffer-hook))
7156 (when display-flag
7157 (pop-to-buffer buffer norecord))
7158 buffer))
7161 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7162 "Like `clone-indirect-buffer' but display in another window."
7163 (interactive
7164 (progn
7165 (if (get major-mode 'no-clone-indirect)
7166 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7167 (list (if current-prefix-arg
7168 (read-buffer "Name of indirect buffer: " (current-buffer)))
7169 t)))
7170 (let ((pop-up-windows t))
7171 (clone-indirect-buffer newname display-flag norecord)))
7173 \f
7174 ;;; Handling of Backspace and Delete keys.
7176 (defcustom normal-erase-is-backspace 'maybe
7177 "Set the default behavior of the Delete and Backspace keys.
7179 If set to t, Delete key deletes forward and Backspace key deletes
7180 backward.
7182 If set to nil, both Delete and Backspace keys delete backward.
7184 If set to 'maybe (which is the default), Emacs automatically
7185 selects a behavior. On window systems, the behavior depends on
7186 the keyboard used. If the keyboard has both a Backspace key and
7187 a Delete key, and both are mapped to their usual meanings, the
7188 option's default value is set to t, so that Backspace can be used
7189 to delete backward, and Delete can be used to delete forward.
7191 If not running under a window system, customizing this option
7192 accomplishes a similar effect by mapping C-h, which is usually
7193 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7194 via `keyboard-translate'. The former functionality of C-h is
7195 available on the F1 key. You should probably not use this
7196 setting if you don't have both Backspace, Delete and F1 keys.
7198 Setting this variable with setq doesn't take effect. Programmatically,
7199 call `normal-erase-is-backspace-mode' (which see) instead."
7200 :type '(choice (const :tag "Off" nil)
7201 (const :tag "Maybe" maybe)
7202 (other :tag "On" t))
7203 :group 'editing-basics
7204 :version "21.1"
7205 :set (lambda (symbol value)
7206 ;; The fboundp is because of a problem with :set when
7207 ;; dumping Emacs. It doesn't really matter.
7208 (if (fboundp 'normal-erase-is-backspace-mode)
7209 (normal-erase-is-backspace-mode (or value 0))
7210 (set-default symbol value))))
7212 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7213 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7214 (unless frame (setq frame (selected-frame)))
7215 (with-selected-frame frame
7216 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7217 (normal-erase-is-backspace-mode
7218 (if (if (eq normal-erase-is-backspace 'maybe)
7219 (and (not noninteractive)
7220 (or (memq system-type '(ms-dos windows-nt))
7221 (memq window-system '(w32 ns))
7222 (and (memq window-system '(x))
7223 (fboundp 'x-backspace-delete-keys-p)
7224 (x-backspace-delete-keys-p))
7225 ;; If the terminal Emacs is running on has erase char
7226 ;; set to ^H, use the Backspace key for deleting
7227 ;; backward, and the Delete key for deleting forward.
7228 (and (null window-system)
7229 (eq tty-erase-char ?\^H))))
7230 normal-erase-is-backspace)
7231 1 0)))))
7233 (define-minor-mode normal-erase-is-backspace-mode
7234 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7235 With a prefix argument ARG, enable this feature if ARG is
7236 positive, and disable it otherwise. If called from Lisp, enable
7237 the mode if ARG is omitted or nil.
7239 On window systems, when this mode is on, Delete is mapped to C-d
7240 and Backspace is mapped to DEL; when this mode is off, both
7241 Delete and Backspace are mapped to DEL. (The remapping goes via
7242 `local-function-key-map', so binding Delete or Backspace in the
7243 global or local keymap will override that.)
7245 In addition, on window systems, the bindings of C-Delete, M-Delete,
7246 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7247 the global keymap in accordance with the functionality of Delete and
7248 Backspace. For example, if Delete is remapped to C-d, which deletes
7249 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7250 to DEL, which deletes backward, C-Delete is bound to
7251 `backward-kill-word'.
7253 If not running on a window system, a similar effect is accomplished by
7254 remapping C-h (normally produced by the Backspace key) and DEL via
7255 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7256 to C-d; if it's off, the keys are not remapped.
7258 When not running on a window system, and this mode is turned on, the
7259 former functionality of C-h is available on the F1 key. You should
7260 probably not turn on this mode on a text-only terminal if you don't
7261 have both Backspace, Delete and F1 keys.
7263 See also `normal-erase-is-backspace'."
7264 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7265 . (lambda (v)
7266 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7267 (if v 1 0))))
7268 (let ((enabled (eq 1 (terminal-parameter
7269 nil 'normal-erase-is-backspace))))
7271 (cond ((or (memq window-system '(x w32 ns pc))
7272 (memq system-type '(ms-dos windows-nt)))
7273 (let ((bindings
7274 `(([M-delete] [M-backspace])
7275 ([C-M-delete] [C-M-backspace])
7276 ([?\e C-delete] [?\e C-backspace]))))
7278 (if enabled
7279 (progn
7280 (define-key local-function-key-map [delete] [deletechar])
7281 (define-key local-function-key-map [kp-delete] [?\C-d])
7282 (define-key local-function-key-map [backspace] [?\C-?])
7283 (dolist (b bindings)
7284 ;; Not sure if input-decode-map is really right, but
7285 ;; keyboard-translate-table (used below) only works
7286 ;; for integer events, and key-translation-table is
7287 ;; global (like the global-map, used earlier).
7288 (define-key input-decode-map (car b) nil)
7289 (define-key input-decode-map (cadr b) nil)))
7290 (define-key local-function-key-map [delete] [?\C-?])
7291 (define-key local-function-key-map [kp-delete] [?\C-?])
7292 (define-key local-function-key-map [backspace] [?\C-?])
7293 (dolist (b bindings)
7294 (define-key input-decode-map (car b) (cadr b))
7295 (define-key input-decode-map (cadr b) (car b))))))
7296 (t
7297 (if enabled
7298 (progn
7299 (keyboard-translate ?\C-h ?\C-?)
7300 (keyboard-translate ?\C-? ?\C-d))
7301 (keyboard-translate ?\C-h ?\C-h)
7302 (keyboard-translate ?\C-? ?\C-?))))
7304 (if (called-interactively-p 'interactive)
7305 (message "Delete key deletes %s"
7306 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7307 "forward" "backward")))))
7308 \f
7309 (defvar vis-mode-saved-buffer-invisibility-spec nil
7310 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7312 (define-minor-mode read-only-mode
7313 "Change whether the current buffer is read-only.
7314 With prefix argument ARG, make the buffer read-only if ARG is
7315 positive, otherwise make it writable. If buffer is read-only
7316 and `view-read-only' is non-nil, enter view mode.
7318 Do not call this from a Lisp program unless you really intend to
7320 possibly enabling or disabling View mode. Also, note that this
7321 command works by setting the variable `buffer-read-only', which
7322 does not affect read-only regions caused by text properties. To
7323 ignore read-only status in a Lisp program (whether due to text
7324 properties or buffer state), bind `inhibit-read-only' temporarily
7325 to a non-nil value."
7326 :variable buffer-read-only
7327 (cond
7328 ((and (not buffer-read-only) view-mode)
7329 (View-exit-and-edit)
7330 (make-local-variable 'view-read-only)
7331 (setq view-read-only t)) ; Must leave view mode.
7332 ((and buffer-read-only view-read-only
7333 ;; If view-mode is already active, `view-mode-enter' is a nop.
7334 (not view-mode)
7335 (not (eq (get major-mode 'mode-class) 'special)))
7336 (view-mode-enter))))
7338 (define-minor-mode visible-mode
7339 "Toggle making all invisible text temporarily visible (Visible mode).
7340 With a prefix argument ARG, enable Visible mode if ARG is
7341 positive, and disable it otherwise. If called from Lisp, enable
7342 the mode if ARG is omitted or nil.
7344 This mode works by saving the value of `buffer-invisibility-spec'
7345 and setting it to nil."
7346 :lighter " Vis"
7347 :group 'editing-basics
7348 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7349 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7350 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7351 (when visible-mode
7352 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7353 buffer-invisibility-spec)
7354 (setq buffer-invisibility-spec nil)))
7355 \f
7356 (defvar messages-buffer-mode-map
7357 (let ((map (make-sparse-keymap)))
7358 (set-keymap-parent map special-mode-map)
7359 (define-key map "g" nil) ; nothing to revert
7360 map))
7362 (define-derived-mode messages-buffer-mode special-mode "Messages"
7365 (defun messages-buffer ()
7367 If it does not exist, create and it switch it to `messages-buffer-mode'."
7368 (or (get-buffer "*Messages*")
7369 (with-current-buffer (get-buffer-create "*Messages*")
7370 (messages-buffer-mode)
7371 (current-buffer))))
7373 \f
7374 ;; Minibuffer prompt stuff.
7376 ;;(defun minibuffer-prompt-modification (start end)
7377 ;; (error "You cannot modify the prompt"))
7378 ;;
7379 ;;
7380 ;;(defun minibuffer-prompt-insertion (start end)
7381 ;; (let ((inhibit-modification-hooks t))
7382 ;; (delete-region start end)
7383 ;; ;; Discard undo information for the text insertion itself
7384 ;; ;; and for the text deletion.above.
7385 ;; (when (consp buffer-undo-list)
7386 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7387 ;; (message "You cannot modify the prompt")))
7388 ;;
7389 ;;
7390 ;;(setq minibuffer-prompt-properties
7391 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7392 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7394 \f
7395 ;;;; Problematic external packages.
7397 ;; rms says this should be done by specifying symbols that define
7398 ;; versions together with bad values. This is therefore not as
7399 ;; flexible as it could be. See the thread:
7400 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7401 (defconst bad-packages-alist
7402 ;; Not sure exactly which semantic versions have problems.
7403 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7405 "The version of `semantic' loaded does not work in Emacs 22.
7406 It can cause constant high CPU load.
7407 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7408 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7409 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7410 ;; provided the `CUA-mode' feature. Since this is no longer true,
7411 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7412 (CUA-mode t nil
7413 "CUA-mode is now part of the standard GNU Emacs distribution,
7414 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7416 You have loaded an older version of CUA-mode which does not work
7417 correctly with this version of Emacs. You should remove the old
7418 version and use the one distributed with Emacs."))
7419 "Alist of packages known to cause problems in this version of Emacs.
7420 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7421 PACKAGE is either a regular expression to match file names, or a
7422 symbol (a feature name), like for `with-eval-after-load'.
7423 SYMBOL is either the name of a string variable, or `t'. Upon
7424 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7425 warning using STRING as the message.")
7427 (defun bad-package-check (package)
7428 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7429 (condition-case nil
7430 (let* ((list (assoc package bad-packages-alist))
7431 (symbol (nth 1 list)))
7432 (and list
7433 (boundp symbol)
7434 (or (eq symbol t)
7435 (and (stringp (setq symbol (eval symbol)))
7436 (string-match-p (nth 2 list) symbol)))
7437 (display-warning package (nth 3 list) :warning)))
7438 (error nil)))
7440 (dolist (elem bad-packages-alist)
7441 (let ((pkg (car elem)))
7442 (with-eval-after-load pkg
7443 (bad-package-check pkg))))
7445 \f
7446 ;;; Generic dispatcher commands
7448 ;; Macro `define-alternatives' is used to create generic commands.
7449 ;; Generic commands are these (like web, mail, news, encrypt, irc, etc.)
7450 ;; that can have different alternative implementations where choosing
7451 ;; among them is exclusively a matter of user preference.
7453 ;; (define-alternatives COMMAND) creates a new interactive command
7454 ;; M-x COMMAND and a customizable variable COMMAND-alternatives.
7455 ;; Typically, the user will not need to customize this variable; packages
7456 ;; wanting to add alternative implementations should use
7457 ;;
7458 ;; ;;;###autoload (push '("My impl name" . my-impl-symbol) COMMAND-alternatives
7460 (defmacro define-alternatives (command &rest customizations)
7461 "Define new command `COMMAND'.
7462 The variable `COMMAND-alternatives' will contain alternative
7463 implementations of COMMAND, so that running `C-u M-x COMMAND'
7464 will allow the user to chose among them.
7465 CUSTOMIZATIONS, if non-nil, should be composed of alternating
7466 `defcustom' keywords and values to add to the declaration of
7467 `COMMAND-alternatives' (typically :group and :version)."
7468 (let* ((command-name (symbol-name command))
7469 (varalt-name (concat command-name "-alternatives"))
7470 (varalt-sym (intern varalt-name))
7471 (varimp-sym (intern (concat command-name "--implementation"))))
7472 `(progn
7474 (defcustom ,varalt-sym nil
7475 ,(format "Alist of alternative implementations for the `%s' command.
7477 Each entry must be a pair (ALTNAME . ALTFUN), where:
7478 ALTNAME - The name shown at user to describe the alternative implementation.
7479 ALTFUN - The function called to implement this alternative."
7480 command-name)
7481 :type '(alist :key-type string :value-type function)
7482 ,@customizations)
7484 (defvar ,varimp-sym nil "Internal use only.")
7486 (defun ,command (&optional arg)
7487 ,(format "Run generic command `%s'.
7488 If used for the first time, or with interactive ARG, ask the user which
7489 implementation to use for `%s'. The variable `%s'
7490 contains the list of implementations currently supported for this command."
7491 command-name command-name varalt-name)
7492 (interactive "P")
7493 (when (or arg (null ,varimp-sym))
7494 (let ((val (completing-read
7495 ,(format "Select implementation for command `%s': " command-name)
7496 ,varalt-sym nil t)))
7497 (unless (string-equal val "")
7498 (customize-save-variable ',varimp-sym
7499 (cdr (assoc-string val ,varalt-sym))))))
7500 (if ,varimp-sym
7501 (funcall ,varimp-sym)
7502 (message ,(format "No implementation selected for command `%s'"
7503 command-name)))))))
7505 (provide 'simple)
7507 ;;; simple.el ends here