Rename `chinese-cns11643-6' to `=cns11643-6'.
[chise/xemacs-chise.git.1] / lisp / simple.el
1 ;;; simple.el --- basic editing commands for XEmacs
2
3 ;; Copyright (C) 1985-7, 1993-5, 1997 Free Software Foundation, Inc.
4 ;; Copyright (C) 1995 Tinker Systems and INS Engineering Corp.
5 ;; Copyright (C) 2000 Ben Wing.
6
7 ;; Maintainer: XEmacs Development Team
8 ;; Keywords: lisp, extensions, internal, dumped
9
10 ;; This file is part of XEmacs.
11
12 ;; XEmacs is free software; you can redistribute it and/or modify it
13 ;; under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
16
17 ;; XEmacs is distributed in the hope that it will be useful, but
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20 ;; General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with XEmacs; see the file COPYING.  If not, write to the Free
24 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
25 ;; 02111-1307, USA.
26
27 ;;; Synched up with: FSF 19.34 [But not very closely].
28
29 ;;; Commentary:
30
31 ;; This file is dumped with XEmacs.
32
33 ;; A grab-bag of basic XEmacs commands not specifically related to some
34 ;; major mode or to file-handling.
35
36 ;; Changes for zmacs-style active-regions:
37 ;;
38 ;; beginning-of-buffer, end-of-buffer, count-lines-region,
39 ;; count-lines-buffer, what-line, what-cursor-position, set-goal-column,
40 ;; set-fill-column, prefix-arg-internal, and line-move (which is used by
41 ;; next-line and previous-line) set zmacs-region-stays to t, so that they
42 ;; don't affect the current region-hilighting state.
43 ;;
44 ;; mark-whole-buffer, mark-word, exchange-point-and-mark, and
45 ;; set-mark-command (without an argument) call zmacs-activate-region.
46 ;;
47 ;; mark takes an optional arg like the new Fmark_marker() does.  When
48 ;; the region is not active, mark returns nil unless the optional arg is true.
49 ;;
50 ;; push-mark, pop-mark, exchange-point-and-mark, and set-marker, and
51 ;; set-mark-command use (mark t) so that they can access the mark whether
52 ;; the region is active or not.
53 ;;
54 ;; shell-command, shell-command-on-region, yank, and yank-pop (which all
55 ;; push a mark) have been altered to call exchange-point-and-mark with an
56 ;; argument, meaning "don't activate the region".  These commands  only use
57 ;; exchange-point-and-mark to position the newly-pushed mark correctly, so
58 ;; this isn't a user-visible change.  These functions have also been altered
59 ;; to use (mark t) for the same reason.
60
61 ;; 97/3/14 Jareth Hein (jhod@po.iijnet.or.jp) added kinsoku processing (support
62 ;; for filling of Asian text) into the fill code. This was ripped bleeding from
63 ;; Mule-2.3, and could probably use some feature additions (like additional wrap
64 ;; styles, etc)
65
66 ;; 97/06/11 Steve Baur (steve@xemacs.org) Convert use of
67 ;;  (preceding|following)-char to char-(after|before).
68
69 ;;; Code:
70
71 (defgroup editing-basics nil
72   "Most basic editing variables."
73   :group 'editing)
74
75 (defgroup killing nil
76   "Killing and yanking commands."
77   :group 'editing)
78
79 (defgroup fill-comments nil
80   "Indenting and filling of comments."
81   :prefix "comment-"
82   :group 'fill)
83
84 (defgroup paren-matching nil
85   "Highlight (un)matching of parens and expressions."
86   :prefix "paren-"
87   :group 'matching)
88
89 (defgroup log-message nil
90   "Messages logging and display customizations."
91   :group 'minibuffer)
92
93 (defgroup warnings nil
94   "Warnings customizations."
95   :group 'minibuffer)
96
97
98 (defcustom search-caps-disable-folding t
99   "*If non-nil, upper case chars disable case fold searching.
100 This does not apply to \"yanked\" strings."
101   :type 'boolean
102   :group 'editing-basics)
103
104 ;; This is stolen (and slightly modified) from FSF emacs's
105 ;; `isearch-no-upper-case-p'.
106 (defun no-upper-case-p (string &optional regexp-flag)
107   "Return t if there are no upper case chars in STRING.
108 If REGEXP-FLAG is non-nil, disregard letters preceded by `\\' (but not `\\\\')
109 since they have special meaning in a regexp."
110   (let ((case-fold-search nil))
111     (not (string-match (if regexp-flag
112                            "\\(^\\|\\\\\\\\\\|[^\\]\\)[A-Z]"
113                          "[A-Z]")
114                        string))
115     ))
116
117 (defmacro with-search-caps-disable-folding (string regexp-flag &rest body) "\
118 Eval BODY with `case-fold-search' let to nil if `search-caps-disable-folding'
119 is non-nil, and if STRING (either a string or a regular expression according
120 to REGEXP-FLAG) contains uppercase letters."
121   `(let ((case-fold-search
122           (if (and case-fold-search search-caps-disable-folding)
123               (no-upper-case-p ,string ,regexp-flag)
124             case-fold-search)))
125      ,@body))
126 (put 'with-search-caps-disable-folding 'lisp-indent-function 2)
127 (put 'with-search-caps-disable-folding 'edebug-form-spec
128      '(sexp sexp &rest form))
129
130 (defmacro with-interactive-search-caps-disable-folding (string regexp-flag
131                                                                &rest body)
132   "Same as `with-search-caps-disable-folding', but only in the case of a
133 function called interactively."
134   `(let ((case-fold-search
135           (if (and (interactive-p)
136                    case-fold-search search-caps-disable-folding)
137               (no-upper-case-p ,string ,regexp-flag)
138             case-fold-search)))
139      ,@body))
140 (put 'with-interactive-search-caps-disable-folding 'lisp-indent-function 2)
141 (put 'with-interactive-search-caps-disable-folding 'edebug-form-spec
142      '(sexp sexp &rest form))
143
144 (defun newline (&optional n)
145   "Insert a newline, and move to left margin of the new line if it's blank.
146 The newline is marked with the text-property `hard'.
147 With optional arg N, insert that many newlines.
148 In Auto Fill mode, if no numeric arg, break the preceding line if it's long."
149   (interactive "*P")
150   (barf-if-buffer-read-only nil (point))
151   ;; Inserting a newline at the end of a line produces better redisplay in
152   ;; try_window_id than inserting at the beginning of a line, and the textual
153   ;; result is the same.  So, if we're at beginning of line, pretend to be at
154   ;; the end of the previous line.
155   ;; #### Does this have any relevance in XEmacs?
156   (let ((flag (and (not (bobp))
157                    (bolp)
158                    ;; Make sure the newline before point isn't intangible.
159                    (not (get-char-property (1- (point)) 'intangible))
160                    ;; Make sure the newline before point isn't read-only.
161                    (not (get-char-property (1- (point)) 'read-only))
162                    ;; Make sure the newline before point isn't invisible.
163                    (not (get-char-property (1- (point)) 'invisible))
164                    ;; This should probably also test for the previous char
165                    ;;  being the *last* character too.
166                    (not (get-char-property (1- (point)) 'end-open))
167                    ;; Make sure the newline before point has the same
168                    ;; properties as the char before it (if any).
169                    (< (or (previous-extent-change (point)) -2)
170                       (- (point) 2))))
171         (was-page-start (and (bolp)
172                              (looking-at page-delimiter)))
173         (beforepos (point)))
174     (if flag (backward-char 1))
175     ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
176     ;; Set last-command-char to tell self-insert what to insert.
177     (let ((last-command-char ?\n)
178           ;; Don't auto-fill if we have a numeric argument.
179           ;; Also not if flag is true (it would fill wrong line);
180           ;; there is no need to since we're at BOL.
181           (auto-fill-function (if (or n flag) nil auto-fill-function)))
182       (unwind-protect
183           (self-insert-command (prefix-numeric-value n))
184         ;; If we get an error in self-insert-command, put point at right place.
185         (if flag (forward-char 1))))
186     ;; If we did *not* get an error, cancel that forward-char.
187     (if flag (backward-char 1))
188     ;; Mark the newline(s) `hard'.
189     (if use-hard-newlines
190         (let* ((from (- (point) (if n (prefix-numeric-value n) 1)))
191                (sticky (get-text-property from 'end-open))) ; XEmacs
192           (put-text-property from (point) 'hard 't)
193           ;; If end-open is not "t", add 'hard to end-open list
194           (if (and (listp sticky) (not (memq 'hard sticky)))
195               (put-text-property from (point) 'end-open ; XEmacs
196                                  (cons 'hard sticky)))))
197     ;; If the newline leaves the previous line blank,
198     ;; and we have a left margin, delete that from the blank line.
199     (or flag
200         (save-excursion
201           (goto-char beforepos)
202           (beginning-of-line)
203           (and (looking-at "[ \t]$")
204                (> (current-left-margin) 0)
205                (delete-region (point) (progn (end-of-line) (point))))))
206     (if flag (forward-char 1))
207     ;; Indent the line after the newline, except in one case:
208     ;; when we added the newline at the beginning of a line
209     ;; which starts a page.
210     (or was-page-start
211         (move-to-left-margin nil t)))
212   nil)
213
214 (defun set-hard-newline-properties (from to)
215   (let ((sticky (get-text-property from 'rear-nonsticky)))
216     (put-text-property from to 'hard 't)
217     ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
218     (if (and (listp sticky) (not (memq 'hard sticky)))
219         (put-text-property from (point) 'rear-nonsticky
220                            (cons 'hard sticky)))))
221
222 (defun open-line (n)
223   "Insert a newline and leave point before it.
224 If there is a fill prefix and/or a left-margin, insert them on the new line
225 if the line would have been blank.
226 With arg N, insert N newlines."
227   (interactive "*p")
228   (let* ((do-fill-prefix (and fill-prefix (bolp)))
229          (do-left-margin (and (bolp) (> (current-left-margin) 0)))
230          (loc (point)))
231     (newline n)
232     (goto-char loc)
233     (while (> n 0)
234       (cond ((bolp)
235              (if do-left-margin (indent-to (current-left-margin)))
236              (if do-fill-prefix (insert fill-prefix))))
237       (forward-line 1)
238       (setq n (1- n)))
239     (goto-char loc)
240     (end-of-line)))
241
242 (defun split-line ()
243   "Split current line, moving portion beyond point vertically down."
244   (interactive "*")
245   (skip-chars-forward " \t")
246   (let ((col (current-column))
247         (pos (point)))
248     (newline 1)
249     (indent-to col 0)
250     (goto-char pos)))
251
252 (defun quoted-insert (arg)
253   "Read next input character and insert it.
254 This is useful for inserting control characters.
255 You may also type up to 3 octal digits, to insert a character with that code.
256
257 In overwrite mode, this function inserts the character anyway, and
258 does not handle octal digits specially.  This means that if you use
259 overwrite as your normal editing mode, you can use this function to
260 insert characters when necessary.
261
262 In binary overwrite mode, this function does overwrite, and octal
263 digits are interpreted as a character code.  This is supposed to make
264 this function useful in editing binary files."
265   (interactive "*p")
266   (let ((char (if (or (not overwrite-mode)
267                       (eq overwrite-mode 'overwrite-mode-binary))
268                   (read-quoted-char)
269                 ;; read-char obeys C-g, so we should protect.  FSF
270                 ;; doesn't have the protection here, but it's a bug in
271                 ;; FSF.
272                 (let ((inhibit-quit t))
273                   (read-char)))))
274     (if (> arg 0)
275         (if (eq overwrite-mode 'overwrite-mode-binary)
276             (delete-char arg)))
277     (while (> arg 0)
278       (insert char)
279       (setq arg (1- arg)))))
280
281 (defun delete-indentation (&optional arg)
282   "Join this line to previous and fix up whitespace at join.
283 If there is a fill prefix, delete it from the beginning of this line.
284 With argument, join this line to following line."
285   (interactive "*P")
286   (beginning-of-line)
287   (if arg (forward-line 1))
288   (if (eq (char-before (point)) ?\n)
289       (progn
290         (delete-region (point) (1- (point)))
291         ;; If the second line started with the fill prefix,
292         ;; delete the prefix.
293         (if (and fill-prefix
294                  (<= (+ (point) (length fill-prefix)) (point-max))
295                  (string= fill-prefix
296                           (buffer-substring (point)
297                                             (+ (point) (length fill-prefix)))))
298             (delete-region (point) (+ (point) (length fill-prefix))))
299         (fixup-whitespace))))
300
301 (defalias 'join-line 'delete-indentation)
302
303 (defun fixup-whitespace ()
304   "Fixup white space between objects around point.
305 Leave one space or none, according to the context."
306   (interactive "*")
307   (save-excursion
308     (delete-horizontal-space)
309     (if (or (looking-at "^\\|\\s)")
310             (save-excursion (backward-char 1)
311                             (looking-at "$\\|\\s(\\|\\s'")))
312         nil
313       (insert ?\ ))))
314
315 (defun delete-horizontal-space ()
316   "Delete all spaces and tabs around point."
317   (interactive "*")
318   (skip-chars-backward " \t")
319   (delete-region (point) (progn (skip-chars-forward " \t") (point))))
320
321 (defun just-one-space ()
322   "Delete all spaces and tabs around point, leaving one space."
323   (interactive "*")
324   (if abbrev-mode ; XEmacs
325       (expand-abbrev))
326   (skip-chars-backward " \t")
327   (if (eq (char-after (point)) ? ) ; XEmacs
328       (forward-char 1)
329     (insert ? ))
330   (delete-region (point) (progn (skip-chars-forward " \t") (point))))
331
332 (defun delete-blank-lines ()
333   "On blank line, delete all surrounding blank lines, leaving just one.
334 On isolated blank line, delete that one.
335 On nonblank line, delete any immediately following blank lines."
336   (interactive "*")
337   (let (thisblank singleblank)
338     (save-excursion
339       (beginning-of-line)
340       (setq thisblank (looking-at "[ \t]*$"))
341       ;; Set singleblank if there is just one blank line here.
342       (setq singleblank
343             (and thisblank
344                  (not (looking-at "[ \t]*\n[ \t]*$"))
345                  (or (bobp)
346                      (progn (forward-line -1)
347                             (not (looking-at "[ \t]*$")))))))
348     ;; Delete preceding blank lines, and this one too if it's the only one.
349     (if thisblank
350         (progn
351           (beginning-of-line)
352           (if singleblank (forward-line 1))
353           (delete-region (point)
354                          (if (re-search-backward "[^ \t\n]" nil t)
355                              (progn (forward-line 1) (point))
356                            (point-min)))))
357     ;; Delete following blank lines, unless the current line is blank
358     ;; and there are no following blank lines.
359     (if (not (and thisblank singleblank))
360         (save-excursion
361           (end-of-line)
362           (forward-line 1)
363           (delete-region (point)
364                          (if (re-search-forward "[^ \t\n]" nil t)
365                              (progn (beginning-of-line) (point))
366                            (point-max)))))
367     ;; Handle the special case where point is followed by newline and eob.
368     ;; Delete the line, leaving point at eob.
369     (if (looking-at "^[ \t]*\n\\'")
370         (delete-region (point) (point-max)))))
371
372 (defun back-to-indentation ()
373   "Move point to the first non-whitespace character on this line."
374   ;; XEmacs change
375   (interactive "_")
376   (beginning-of-line 1)
377   (skip-chars-forward " \t"))
378
379 (defun newline-and-indent ()
380   "Insert a newline, then indent according to major mode.
381 Indentation is done using the value of `indent-line-function'.
382 In programming language modes, this is the same as TAB.
383 In some text modes, where TAB inserts a tab, this command indents to the
384 column specified by the function `current-left-margin'."
385   (interactive "*")
386   (delete-region (point) (progn (skip-chars-backward " \t") (point)))
387   (newline)
388   (indent-according-to-mode))
389
390 (defun reindent-then-newline-and-indent ()
391   "Reindent current line, insert newline, then indent the new line.
392 Indentation of both lines is done according to the current major mode,
393 which means calling the current value of `indent-line-function'.
394 In programming language modes, this is the same as TAB.
395 In some text modes, where TAB inserts a tab, this indents to the
396 column specified by the function `current-left-margin'."
397   (interactive "*")
398   (save-excursion
399     (delete-region (point) (progn (skip-chars-backward " \t") (point)))
400     (indent-according-to-mode))
401   (newline)
402   (indent-according-to-mode))
403
404 ;; Internal subroutine of delete-char
405 (defun kill-forward-chars (arg)
406   (if (listp arg) (setq arg (car arg)))
407   (if (eq arg '-) (setq arg -1))
408   (kill-region (point) (+ (point) arg)))
409
410 ;; Internal subroutine of backward-delete-char
411 (defun kill-backward-chars (arg)
412   (if (listp arg) (setq arg (car arg)))
413   (if (eq arg '-) (setq arg -1))
414   (kill-region (point) (- (point) arg)))
415
416 (defun backward-delete-char-untabify (arg &optional killp)
417   "Delete characters backward, changing tabs into spaces.
418 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
419 Interactively, ARG is the prefix arg (default 1)
420 and KILLP is t if a prefix arg was specified."
421   (interactive "*p\nP")
422   (let ((count arg))
423     (save-excursion
424       (while (and (> count 0) (not (bobp)))
425         (if (eq (char-before (point)) ?\t) ; XEmacs
426             (let ((col (current-column)))
427               (backward-char 1)
428               (setq col (- col (current-column)))
429               (insert-char ?\ col)
430               (delete-char 1)))
431         (backward-char 1)
432         (setq count (1- count)))))
433   (delete-backward-char arg killp)
434   ;; XEmacs: In overwrite mode, back over columns while clearing them out,
435   ;; unless at end of line.
436   (and overwrite-mode (not (eolp))
437        (save-excursion (insert-char ?\  arg))))
438
439 (defcustom delete-key-deletes-forward t
440   "*If non-nil, the DEL key will erase one character forwards.
441 If nil, the DEL key will erase one character backwards."
442   :type 'boolean
443   :group 'editing-basics)
444
445 (defcustom backward-delete-function 'delete-backward-char
446   "*Function called to delete backwards on a delete keypress.
447 If `delete-key-deletes-forward' is nil, `backward-or-forward-delete-char'
448 calls this function to erase one character backwards.  Default value
449 is `delete-backward-char', with `backward-delete-char-untabify' being a
450 popular alternate setting."
451   :type 'function
452   :group 'editing-basics)
453
454 ;; Trash me, baby.
455 (defsubst delete-forward-p ()
456   (and delete-key-deletes-forward
457        (or (not (eq (device-type) 'x))
458            (x-keysym-on-keyboard-sans-modifiers-p 'backspace))))
459
460 (defun backward-or-forward-delete-char (arg)
461   "Delete either one character backwards or one character forwards.
462 Controlled by the state of `delete-key-deletes-forward' and whether the
463 BackSpace keysym even exists on your keyboard.  If you don't have a
464 BackSpace keysym, the delete key should always delete one character
465 backwards."
466   (interactive "*p")
467   (if (delete-forward-p)
468       (delete-char arg)
469     (funcall backward-delete-function arg)))
470
471 (defun backward-or-forward-kill-word (arg)
472   "Delete either one word backwards or one word forwards.
473 Controlled by the state of `delete-key-deletes-forward' and whether the
474 BackSpace keysym even exists on your keyboard.  If you don't have a
475 BackSpace keysym, the delete key should always delete one character
476 backwards."
477   (interactive "*p")
478   (if (delete-forward-p)
479       (kill-word arg)
480     (backward-kill-word arg)))
481
482 (defun backward-or-forward-kill-sentence (arg)
483     "Delete either one sentence backwards or one sentence forwards.
484 Controlled by the state of `delete-key-deletes-forward' and whether the
485 BackSpace keysym even exists on your keyboard.  If you don't have a
486 BackSpace keysym, the delete key should always delete one character
487 backwards."
488   (interactive "*P")
489   (if (delete-forward-p)
490       (kill-sentence arg)
491     (backward-kill-sentence (prefix-numeric-value arg))))
492
493 (defun backward-or-forward-kill-sexp (arg)
494     "Delete either one sexpr backwards or one sexpr forwards.
495 Controlled by the state of `delete-key-deletes-forward' and whether the
496 BackSpace keysym even exists on your keyboard.  If you don't have a
497 BackSpace keysym, the delete key should always delete one character
498 backwards."
499   (interactive "*p")
500   (if (delete-forward-p)
501       (kill-sexp arg)
502     (backward-kill-sexp arg)))
503
504 (defun zap-to-char (arg char)
505   "Kill up to and including ARG'th occurrence of CHAR.
506 Goes backward if ARG is negative; error if CHAR not found."
507   (interactive "*p\ncZap to char: ")
508   (kill-region (point) (with-interactive-search-caps-disable-folding
509                            (char-to-string char) nil
510                          (search-forward (char-to-string char) nil nil arg)
511                          (point))))
512
513 (defun zap-up-to-char (arg char)
514   "Kill up to ARG'th occurrence of CHAR.
515 Goes backward if ARG is negative; error if CHAR not found."
516   (interactive "*p\ncZap up to char: ")
517   (kill-region (point) (with-interactive-search-caps-disable-folding
518                            (char-to-string char) nil
519                          (search-forward (char-to-string char) nil nil arg)
520                          (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
521                          (point))))
522
523 (defun beginning-of-buffer (&optional arg)
524   "Move point to the beginning of the buffer; leave mark at previous position.
525 With arg N, put point N/10 of the way from the beginning.
526
527 If the buffer is narrowed, this command uses the beginning and size
528 of the accessible part of the buffer.
529
530 The characters that are moved over may be added to the current selection
531 \(i.e. active region) if the Shift key is held down, a motion key is used
532 to invoke this command, and `shifted-motion-keys-select-region' is t; see
533 the documentation for this variable for more details.
534
535 Don't use this command in Lisp programs!
536 \(goto-char (point-min)) is faster and avoids clobbering the mark."
537   ;; XEmacs change
538   (interactive "_P")
539   (push-mark)
540   (let ((size (- (point-max) (point-min))))
541     (goto-char (if arg
542                    (+ (point-min)
543                       (if (> size 10000)
544                           ;; Avoid overflow for large buffer sizes!
545                           (* (prefix-numeric-value arg)
546                              (/ size 10))
547                         (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
548                  (point-min))))
549   (if arg (forward-line 1)))
550
551 (defun end-of-buffer (&optional arg)
552   "Move point to the end of the buffer; leave mark at previous position.
553 With arg N, put point N/10 of the way from the end.
554
555 If the buffer is narrowed, this command uses the beginning and size
556 of the accessible part of the buffer.
557
558 The characters that are moved over may be added to the current selection
559 \(i.e. active region) if the Shift key is held down, a motion key is used
560 to invoke this command, and `shifted-motion-keys-select-region' is t; see
561 the documentation for this variable for more details.
562
563 Don't use this command in Lisp programs!
564 \(goto-char (point-max)) is faster and avoids clobbering the mark."
565   ;; XEmacs change
566   (interactive "_P")
567   (push-mark)
568   ;; XEmacs changes here.
569   (let ((scroll-to-end (not (pos-visible-in-window-p (point-max))))
570         (size (- (point-max) (point-min))))
571     (goto-char (if arg
572                    (- (point-max)
573                       (if (> size 10000)
574                           ;; Avoid overflow for large buffer sizes!
575                           (* (prefix-numeric-value arg)
576                              (/ size 10))
577                         (/ (* size (prefix-numeric-value arg)) 10)))
578                  (point-max)))
579     (cond (arg
580            ;; If we went to a place in the middle of the buffer,
581            ;; adjust it to the beginning of a line.
582            (forward-line 1))
583           ;; XEmacs change
584           (scroll-to-end
585            ;; If the end of the buffer is not already on the screen,
586            ;; then scroll specially to put it near, but not at, the bottom.
587            (recenter -3)))))
588
589 ;; XEmacs (not in FSF)
590 (defun mark-beginning-of-buffer (&optional arg)
591   "Push a mark at the beginning of the buffer; leave point where it is.
592 With arg N, push mark N/10 of the way from the true beginning."
593   (interactive "P")
594   (push-mark (if arg
595                  (if (> (buffer-size) 10000)
596                      ;; Avoid overflow for large buffer sizes!
597                      (* (prefix-numeric-value arg)
598                         (/ (buffer-size) 10))
599                    (/ (+ 10 (* (buffer-size) (prefix-numeric-value arg))) 10))
600                (point-min))
601              nil
602              t))
603 (define-function 'mark-bob 'mark-beginning-of-buffer)
604
605 ;; XEmacs (not in FSF)
606 (defun mark-end-of-buffer (&optional arg)
607   "Push a mark at the end of the buffer; leave point where it is.
608 With arg N, push mark N/10 of the way from the true end."
609   (interactive "P")
610   (push-mark (if arg
611                  (- (1+ (buffer-size))
612                     (if (> (buffer-size) 10000)
613                         ;; Avoid overflow for large buffer sizes!
614                         (* (prefix-numeric-value arg)
615                            (/ (buffer-size) 10))
616                       (/ (* (buffer-size) (prefix-numeric-value arg)) 10)))
617                  (point-max))
618              nil
619              t))
620 (define-function 'mark-eob 'mark-end-of-buffer)
621
622 (defun mark-whole-buffer ()
623   "Put point at beginning and mark at end of buffer.
624 You probably should not use this function in Lisp programs;
625 it is usually a mistake for a Lisp function to use any subroutine
626 that uses or sets the mark."
627   (interactive)
628   (push-mark (point))
629   (push-mark (point-max) nil t)
630   (goto-char (point-min)))
631
632 ;; XEmacs
633 (defun eval-current-buffer (&optional printflag)
634   "Evaluate the current buffer as Lisp code.
635 Programs can pass argument PRINTFLAG which controls printing of output:
636 nil means discard it; anything else is stream for print."
637   (interactive)
638   (eval-buffer (current-buffer) printflag))
639
640 ;; XEmacs
641 (defun count-words-buffer (&optional buffer)
642   "Print the number of words in BUFFER.
643 If called noninteractively, the value is returned rather than printed.
644 BUFFER defaults to the current buffer."
645   (interactive)
646   (let ((words (count-words-region (point-min) (point-max) buffer)))
647     (when (interactive-p)
648       (message "Buffer has %d words" words))
649     words))
650
651 ;; XEmacs
652 (defun count-words-region (start end &optional buffer)
653   "Print the number of words in region between START and END in BUFFER.
654 If called noninteractively, the value is returned rather than printed.
655 BUFFER defaults to the current buffer."
656   (interactive "_r")
657   (save-excursion
658     (set-buffer (or buffer (current-buffer)))
659     (let ((words 0))
660       (goto-char start)
661       (while (< (point) end)
662         (when (forward-word 1)
663           (incf words)))
664       (when  (interactive-p)
665         (message "Region has %d words" words))
666       words)))
667
668 (defun count-lines-region (start end)
669   "Print number of lines and characters in the region."
670   ;; XEmacs change
671   (interactive "_r")
672   (message "Region has %d lines, %d characters"
673            (count-lines start end) (- end start)))
674
675 ;; XEmacs
676 (defun count-lines-buffer (&optional buffer)
677   "Print number of lines and characters in BUFFER."
678   (interactive)
679   (with-current-buffer (or buffer (current-buffer))
680     (let ((cnt (count-lines (point-min) (point-max))))
681       (message "Buffer has %d lines, %d characters"
682                cnt (- (point-max) (point-min)))
683       cnt)))
684
685 ;;; Modified by Bob Weiner, 8/24/95, to print narrowed line number also.
686 ;;; Expanded by Bob Weiner, BeOpen, on 02/12/1997
687 (defun what-line ()
688   "Print the following variants of the line number of point:
689      Region line     - displayed line within the active region
690      Collapsed line  - includes only selectively displayed lines;
691      Buffer line     - physical line in the buffer;
692      Narrowed line   - line number from the start of the buffer narrowing."
693   ;; XEmacs change
694   (interactive "_")
695   (let ((opoint (point)) start)
696     (save-excursion
697       (save-restriction
698         (if (region-active-p)
699             (goto-char (region-beginning))
700           (goto-char (point-min)))
701         (widen)
702         (beginning-of-line)
703         (setq start (point))
704         (goto-char opoint)
705         (beginning-of-line)
706         (let* ((buffer-line (1+ (count-lines 1 (point))))
707                (narrowed-p (or (/= start 1)
708                                (/= (point-max) (1+ (buffer-size)))))
709                (narrowed-line (if narrowed-p (1+ (count-lines start (point)))))
710                (selective-line (if selective-display
711                                    (1+ (count-lines start (point) t))))
712                (region-line (if (region-active-p)
713                                 (1+ (count-lines start (point) selective-display)))))
714           (cond (region-line
715                  (message "Region line %d; Buffer line %d"
716                           region-line buffer-line))
717                 ((and narrowed-p selective-line (/= selective-line narrowed-line))
718                  ;; buffer narrowed and some lines selectively displayed
719                  (message "Collapsed line %d; Buffer line %d; Narrowed line %d"
720                           selective-line buffer-line narrowed-line))
721                 (narrowed-p
722                  ;; buffer narrowed
723                  (message "Buffer line %d; Narrowed line %d"
724                           buffer-line narrowed-line))
725                 ((and selective-line (/= selective-line buffer-line))
726                  ;; some lines selectively displayed
727                  (message "Collapsed line %d; Buffer line %d"
728                           selective-line buffer-line))
729                 (t
730                  ;; give a basic line count
731                  (message "Line %d" buffer-line)))))))
732   (setq zmacs-region-stays t))
733
734 ;; new in XEmacs 21.2 (not in FSF).
735 (defun line-number (&optional pos respect-narrowing)
736   "Return the line number of POS (defaults to point).
737 If RESPECT-NARROWING is non-nil, then the narrowed line number is returned;
738 otherwise, the absolute line number is returned.  The returned line can always
739 be given to `goto-line' to get back to the current line."
740   (if (and pos (/= pos (point)))
741       (save-excursion
742         (goto-char pos)
743         (line-number nil respect-narrowing))
744     (1+ (count-lines (if respect-narrowing (point-min) 1) (point-at-bol)))))
745
746 (defun count-lines (start end &optional ignore-invisible-lines-flag)
747   "Return number of lines between START and END.
748 This is usually the number of newlines between them,
749 but can be one more if START is not equal to END
750 and the greater of them is not at the start of a line.
751
752 With optional IGNORE-INVISIBLE-LINES-FLAG non-nil, lines collapsed with
753 selective-display are excluded from the line count.
754
755 NOTE: The expression to return the current line number is not obvious:
756
757 (1+ (count-lines 1 (point-at-bol)))
758
759 See also `line-number'."
760   (save-excursion
761     (save-restriction
762       (narrow-to-region start end)
763       (goto-char (point-min))
764       (if (and (not ignore-invisible-lines-flag) (eq selective-display t))
765           (save-match-data
766             (let ((done 0))
767               (while (re-search-forward "[\n\C-m]" nil t 40)
768                 (setq done (+ 40 done)))
769               (while (re-search-forward "[\n\C-m]" nil t 1)
770                 (setq done (+ 1 done)))
771               (goto-char (point-max))
772               (if (and (/= start end)
773                        (not (bolp)))
774                   (1+ done)
775                 done)))
776         (- (buffer-size) (forward-line (buffer-size)))))))
777
778 (defun what-cursor-position ()
779   "Print info on cursor position (on screen and within buffer)."
780   ;; XEmacs change
781   (interactive "_")
782   (let* ((char (char-after (point))) ; XEmacs
783          (beg (point-min))
784          (end (point-max))
785          (pos (point))
786          (total (buffer-size))
787          (percent (if (> total 50000)
788                       ;; Avoid overflow from multiplying by 100!
789                       (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
790                     (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
791          (hscroll (if (= (window-hscroll) 0)
792                       ""
793                     (format " Hscroll=%d" (window-hscroll))))
794          (col (+ (current-column) (if column-number-start-at-one 1 0))))
795     (if (= pos end)
796         (if (or (/= beg 1) (/= end (1+ total)))
797             (message "point=%d of %d(%d%%) <%d - %d>  column %d %s"
798                      pos total percent beg end col hscroll)
799           (message "point=%d of %d(%d%%)  column %d %s"
800                    pos total percent col hscroll))
801       ;; XEmacs: don't use single-key-description
802       (if (or (/= beg 1) (/= end (1+ total)))
803           (message "Char: %s (0%o, %d, 0x%x)  point=%d of %d(%d%%) <%d - %d>  column %d %s"
804                    (text-char-description char) char char char pos total
805                    percent beg end col hscroll)
806         (message "Char: %s (0%o, %d, 0x%x)  point=%d of %d(%d%%)  column %d %s"
807                  (text-char-description char) char char char pos total
808                  percent col hscroll)))))
809
810 (defun fundamental-mode ()
811   "Major mode not specialized for anything in particular.
812 Other major modes are defined by comparison with this one."
813   (interactive)
814   (kill-all-local-variables))
815
816 ;; XEmacs the following are declared elsewhere
817 ;(defvar read-expression-map (cons 'keymap minibuffer-local-map)
818 ;  "Minibuffer keymap used for reading Lisp expressions.")
819 ;(define-key read-expression-map "\M-\t" 'lisp-complete-symbol)
820
821 ;(put 'eval-expression 'disabled t)
822
823 ;(defvar read-expression-history nil)
824
825 ;; We define this, rather than making `eval' interactive,
826 ;; for the sake of completion of names like eval-region, eval-current-buffer.
827 (defun eval-expression (expression &optional eval-expression-insert-value)
828   "Evaluate EXPRESSION and print value in minibuffer.
829 Value is also consed on to front of the variable `values'.
830 With prefix argument, insert the result to the current buffer."
831   ;(interactive "xEval: ")
832   (interactive
833    (list (read-from-minibuffer "Eval: "
834                                nil read-expression-map t
835                                'read-expression-history)
836          current-prefix-arg))
837   (setq values (cons (eval expression) values))
838   (prin1 (car values)
839          (if eval-expression-insert-value (current-buffer) t)))
840
841 ;; XEmacs -- extra parameter (variant, but equivalent logic)
842 (defun edit-and-eval-command (prompt form &optional history)
843   "Prompting with PROMPT, let user edit FORM and eval result.
844 FORM is a Lisp expression.  Let user edit that expression in
845 the minibuffer, then read and evaluate the result."
846   (let ((form (read-expression prompt
847                                ;; first try to format the thing readably;
848                                ;; and if that fails, print it normally.
849                                (condition-case ()
850                                    (let ((print-readably t))
851                                      (prin1-to-string form))
852                                  (error (prin1-to-string form)))
853                                (or history '(command-history . 1)))))
854     (or history (setq history 'command-history))
855     (if (consp history)
856         (setq history (car history)))
857     (if (eq history t)
858         nil
859       ;; If form was added to the history as a string,
860       ;; get rid of that.  We want only evallable expressions there.
861       (if (stringp (car (symbol-value history)))
862           (set history (cdr (symbol-value history))))
863
864       ;; If form to be redone does not match front of history,
865       ;; add it to the history.
866       (or (equal form (car (symbol-value history)))
867           (set history (cons form (symbol-value history)))))
868     (eval form)))
869
870 (defun repeat-complex-command (arg)
871   "Edit and re-evaluate last complex command, or ARGth from last.
872 A complex command is one which used the minibuffer.
873 The command is placed in the minibuffer as a Lisp form for editing.
874 The result is executed, repeating the command as changed.
875 If the command has been changed or is not the most recent previous command
876 it is added to the front of the command history.
877 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
878 to get different commands to edit and resubmit."
879   (interactive "p")
880   ;; XEmacs: It looks like our version is better -sb
881   (let ((print-level nil))
882     (edit-and-eval-command "Redo: "
883                            (or (nth (1- arg) command-history)
884                                (error ""))
885                            (cons 'command-history arg))))
886
887 ;; XEmacs: Functions moved to minibuf.el
888 ;; previous-matching-history-element
889 ;; next-matching-history-element
890 ;; next-history-element
891 ;; previous-history-element
892 ;; next-complete-history-element
893 ;; previous-complete-history-element
894 \f
895 (defun goto-line (line)
896   "Goto line LINE, counting from line 1 at beginning of buffer."
897   (interactive "NGoto line: ")
898   (setq line (prefix-numeric-value line))
899   (save-restriction
900     (widen)
901     (goto-char 1)
902     (if (eq selective-display t)
903         (re-search-forward "[\n\C-m]" nil 'end (1- line))
904       (forward-line (1- line)))))
905
906 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
907 (define-function 'advertised-undo 'undo)
908
909 (defun undo (&optional count)
910   "Undo some previous changes.
911 Repeat this command to undo more changes.
912 A numeric argument serves as a repeat count."
913   (interactive "*p")
914   ;; If we don't get all the way through, make last-command indicate that
915   ;; for the following command.
916   (setq this-command t)
917   (let ((modified (buffer-modified-p))
918         (recent-save (recent-auto-save-p)))
919     (or (eq (selected-window) (minibuffer-window))
920         (display-message 'command "Undo!"))
921     (or (and (eq last-command 'undo)
922              (eq (current-buffer) last-undo-buffer)) ; XEmacs
923         (progn (undo-start)
924                (undo-more 1)))
925     (undo-more (or count 1))
926     ;; Don't specify a position in the undo record for the undo command.
927     ;; Instead, undoing this should move point to where the change is.
928     (let ((tail buffer-undo-list)
929           done)
930       (while (and tail (not done) (not (null (car tail))))
931         (if (integerp (car tail))
932             (progn
933               (setq done t)
934               (setq buffer-undo-list (delq (car tail) buffer-undo-list))))
935         (setq tail (cdr tail))))
936     (and modified (not (buffer-modified-p))
937          (delete-auto-save-file-if-necessary recent-save)))
938   ;; If we do get all the way through, make this-command indicate that.
939   (setq this-command 'undo))
940
941 (defvar pending-undo-list nil
942   "Within a run of consecutive undo commands, list remaining to be undone.")
943
944 (defvar last-undo-buffer nil)   ; XEmacs
945
946 (defun undo-start ()
947   "Set `pending-undo-list' to the front of the undo list.
948 The next call to `undo-more' will undo the most recently made change."
949   (if (eq buffer-undo-list t)
950       (error "No undo information in this buffer"))
951   (setq pending-undo-list buffer-undo-list))
952
953 (defun undo-more (count)
954   "Undo back N undo-boundaries beyond what was already undone recently.
955 Call `undo-start' to get ready to undo recent changes,
956 then call `undo-more' one or more times to undo them."
957   (or pending-undo-list
958       (error "No further undo information"))
959   (setq pending-undo-list (primitive-undo count pending-undo-list)
960         last-undo-buffer (current-buffer)))     ; XEmacs
961
962 ;; XEmacs
963 (defun call-with-transparent-undo (fn &rest args)
964   "Apply FN to ARGS, and then undo all changes made by FN to the current
965 buffer.  The undo records are processed even if FN returns non-locally.
966 There is no trace of the changes made by FN in the buffer's undo history.
967
968 You can use this in a write-file-hooks function with continue-save-buffer
969 to make the contents of a disk file differ from its in-memory buffer."
970   (let ((buffer-undo-list nil)
971         ;; Kludge to prevent undo list truncation:
972         (undo-high-threshold -1)
973         (undo-threshold -1)
974         (obuffer (current-buffer)))
975     (unwind-protect
976         (apply fn args)
977       ;; Go to the buffer we will restore and make it writable:
978       (set-buffer obuffer)
979       (save-excursion
980         (let ((buffer-read-only nil))
981           (save-restriction
982             (widen)
983             ;; Perform all undos, with further undo logging disabled:
984             (let ((tail buffer-undo-list))
985               (setq buffer-undo-list t)
986               (while tail
987                 (setq tail (primitive-undo (length tail) tail))))))))))
988
989 ;; XEmacs: The following are in other files
990 ;; shell-command-history
991 ;; shell-command-switch
992 ;; shell-command
993 ;; shell-command-sentinel
994
995 \f
996 (defconst universal-argument-map
997   (let ((map (make-sparse-keymap)))
998     (set-keymap-default-binding map 'universal-argument-other-key)
999     ;FSFmacs (define-key map [switch-frame] nil)
1000     (define-key map [(t)] 'universal-argument-other-key)
1001     (define-key map [(meta t)] 'universal-argument-other-key)
1002     (define-key map [(control u)] 'universal-argument-more)
1003     (define-key map [?-] 'universal-argument-minus)
1004     (define-key map [?0] 'digit-argument)
1005     (define-key map [?1] 'digit-argument)
1006     (define-key map [?2] 'digit-argument)
1007     (define-key map [?3] 'digit-argument)
1008     (define-key map [?4] 'digit-argument)
1009     (define-key map [?5] 'digit-argument)
1010     (define-key map [?6] 'digit-argument)
1011     (define-key map [?7] 'digit-argument)
1012     (define-key map [?8] 'digit-argument)
1013     (define-key map [?9] 'digit-argument)
1014     map)
1015   "Keymap used while processing \\[universal-argument].")
1016
1017 (defvar universal-argument-num-events nil
1018   "Number of argument-specifying events read by `universal-argument'.
1019 `universal-argument-other-key' uses this to discard those events
1020 from (this-command-keys), and reread only the final command.")
1021
1022 (defun universal-argument ()
1023   "Begin a numeric argument for the following command.
1024 Digits or minus sign following \\[universal-argument] make up the numeric argument.
1025 \\[universal-argument] following the digits or minus sign ends the argument.
1026 \\[universal-argument] without digits or minus sign provides 4 as argument.
1027 Repeating \\[universal-argument] without digits or minus sign
1028  multiplies the argument by 4 each time."
1029   (interactive)
1030   (setq prefix-arg (list 4))
1031   (setq zmacs-region-stays t)   ; XEmacs
1032   (setq universal-argument-num-events (length (this-command-keys)))
1033   (setq overriding-terminal-local-map universal-argument-map))
1034
1035 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
1036 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
1037 (defun universal-argument-more (arg)
1038   (interactive "_P")                    ; XEmacs
1039   (if (consp arg)
1040       (setq prefix-arg (list (* 4 (car arg))))
1041     (setq prefix-arg arg)
1042     (setq overriding-terminal-local-map nil))
1043   (setq universal-argument-num-events (length (this-command-keys))))
1044
1045 (defun negative-argument (arg)
1046   "Begin a negative numeric argument for the next command.
1047 \\[universal-argument] following digits or minus sign ends the argument."
1048   (interactive "_P")                    ; XEmacs
1049   (cond ((integerp arg)
1050           (setq prefix-arg (- arg)))
1051          ((eq arg '-)
1052           (setq prefix-arg nil))
1053          (t
1054           (setq prefix-arg '-)))
1055   (setq universal-argument-num-events (length (this-command-keys)))
1056   (setq overriding-terminal-local-map universal-argument-map))
1057
1058 ;; XEmacs:  This function not synched with FSF
1059 (defun digit-argument (arg)
1060   "Part of the numeric argument for the next command.
1061 \\[universal-argument] following digits or minus sign ends the argument."
1062   (interactive "_P")                    ; XEmacs
1063   (let* ((event last-command-event)
1064          (key (and (key-press-event-p event)
1065                    (event-key event)))
1066          (digit (and key (characterp key) (>= key ?0) (<= key ?9)
1067                      (- key ?0))))
1068     (if (null digit)
1069         (universal-argument-other-key arg)
1070       (cond ((integerp arg)
1071              (setq prefix-arg (+ (* arg 10)
1072                                  (if (< arg 0) (- digit) digit))))
1073             ((eq arg '-)
1074              ;; Treat -0 as just -, so that -01 will work.
1075              (setq prefix-arg (if (zerop digit) '- (- digit))))
1076             (t
1077              (setq prefix-arg digit)))
1078       (setq universal-argument-num-events (length (this-command-keys)))
1079       (setq overriding-terminal-local-map universal-argument-map))))
1080
1081 ;; For backward compatibility, minus with no modifiers is an ordinary
1082 ;; command if digits have already been entered.
1083 (defun universal-argument-minus (arg)
1084   (interactive "_P") ; XEmacs
1085   (if (integerp arg)
1086       (universal-argument-other-key arg)
1087     (negative-argument arg)))
1088
1089 ;; Anything else terminates the argument and is left in the queue to be
1090 ;; executed as a command.
1091 (defun universal-argument-other-key (arg)
1092   (interactive "_P")                    ; XEmacs
1093   (setq prefix-arg arg)
1094   (let* ((key (this-command-keys))
1095          ;; FSF calls silly function `listify-key-sequence' here.
1096           (keylist (append key nil)))
1097     (setq unread-command-events
1098            (append (nthcdr universal-argument-num-events keylist)
1099                    unread-command-events)))
1100   (reset-this-command-lengths)
1101   (setq overriding-terminal-local-map nil))
1102
1103 \f
1104 ;; XEmacs -- keep zmacs-region active.
1105 (defun forward-to-indentation (count)
1106   "Move forward COUNT lines and position at first nonblank character."
1107   (interactive "_p")
1108   (forward-line count)
1109   (skip-chars-forward " \t"))
1110
1111 (defun backward-to-indentation (count)
1112   "Move backward COUNT lines and position at first nonblank character."
1113   (interactive "_p")
1114   (forward-line (- count))
1115   (skip-chars-forward " \t"))
1116
1117 (defcustom kill-whole-line nil
1118   "*If non-nil, kill the whole line if point is at the beginning.
1119 Otherwise, `kill-line' kills only up to the end of the line, but not
1120 the terminating newline.
1121
1122 WARNING: This is a misnamed variable!  It should be called something
1123 like `kill-whole-line-when-at-beginning'.  If you simply want
1124 \\[kill-line] to kill the entire current line, bind it to the function
1125 `kill-entire-line'.  "
1126   :type 'boolean
1127   :group 'killing)
1128
1129 (defun kill-line-1 (arg entire-line)
1130   (kill-region (if entire-line
1131                    (save-excursion
1132                      (beginning-of-line)
1133                      (point))
1134                  (point))
1135                ;; Don't shift point before doing the delete; that way,
1136                ;; undo will record the right position of point.
1137 ;; FSF
1138 ;              ;; It is better to move point to the other end of the kill
1139 ;              ;; before killing.  That way, in a read-only buffer, point
1140 ;              ;; moves across the text that is copied to the kill ring.
1141 ;              ;; The choice has no effect on undo now that undo records
1142 ;              ;; the value of point from before the command was run.
1143 ;              (progn
1144                (save-excursion
1145                  (if arg
1146                      (forward-line (prefix-numeric-value arg))
1147                    (if (eobp)
1148                        (signal 'end-of-buffer nil))
1149                    (if (or (looking-at "[ \t]*$")
1150                            (or entire-line
1151                                (and kill-whole-line (bolp))))
1152                        (forward-line 1)
1153                      (end-of-line)))
1154                  (point))))
1155
1156 (defun kill-entire-line (&optional arg)
1157   "Kill the entire line.
1158 With prefix argument, kill that many lines from point.  Negative
1159 arguments kill lines backward.
1160
1161 When calling from a program, nil means \"no arg\",
1162 a number counts as a prefix arg."
1163   (interactive "*P")
1164   (kill-line-1 arg t))
1165
1166 (defun kill-line (&optional arg)
1167   "Kill the rest of the current line, or the entire line.
1168 If no nonblanks there, kill thru newline.  If called interactively,
1169 may kill the entire line when given no argument at the beginning of a
1170 line; see `kill-whole-line'.  With prefix argument, kill that many
1171 lines from point.  Negative arguments kill lines backward.
1172
1173 WARNING: This is a misnamed function!  It should be called something
1174 like `kill-to-end-of-line'.  If you simply want to kill the entire
1175 current line, use `kill-entire-line'.
1176
1177 When calling from a program, nil means \"no arg\",
1178 a number counts as a prefix arg."
1179   (interactive "*P")
1180   (kill-line-1 arg nil))
1181
1182 ;; XEmacs
1183 (defun backward-kill-line nil
1184   "Kill back to the beginning of the line."
1185   (interactive)
1186   (let ((point (point)))
1187     (beginning-of-line nil)
1188     (kill-region (point) point)))
1189
1190 \f
1191 ;;;; Window system cut and paste hooks.
1192 ;;;
1193 ;;; I think that kill-hooks is a better name and more general mechanism
1194 ;;; than interprogram-cut-function (from FSFmacs).  I don't like the behavior
1195 ;;; of interprogram-paste-function: ^Y should always come from the kill ring,
1196 ;;; not the X selection.  But if that were provided, it should be called (and
1197 ;;; behave as) yank-hooks instead.  -- jwz
1198
1199 ;; [... code snipped ...]
1200
1201 (defcustom kill-hooks nil
1202   "*Functions run when something is added to the XEmacs kill ring.
1203 These functions are called with one argument, the string most recently
1204 cut or copied.  You can use this to, for example, make the most recent
1205 kill become the X Clipboard selection."
1206   :type 'hook
1207   :group 'killing)
1208
1209 ;;; `kill-hooks' seems not sufficient because
1210 ;;; `interprogram-cut-function' requires more variable about to rotate
1211 ;;; the cut buffers.  I'm afraid to change interface of `kill-hooks',
1212 ;;; so I add it. (1997-11-03 by MORIOKA Tomohiko)
1213
1214 (defcustom interprogram-cut-function 'own-clipboard
1215   "Function to call to make a killed region available to other programs.
1216
1217 Most window systems provide some sort of facility for cutting and
1218 pasting text between the windows of different programs.
1219 This variable holds a function that Emacs calls whenever text
1220 is put in the kill ring, to make the new kill available to other
1221 programs.
1222
1223 The function takes one or two arguments.
1224 The first argument, TEXT, is a string containing
1225 the text which should be made available.
1226 The second, PUSH, if non-nil means this is a \"new\" kill;
1227 nil means appending to an \"old\" kill.
1228
1229 One reasonable choice is `own-clipboard' (the default)."
1230   :type '(radio (function-item :tag "Send to Clipboard"
1231                                :format "%t\n"
1232                                own-clipboard)
1233                 (const :tag "None" nil)
1234                 (function :tag "Other"))
1235   :group 'killing)
1236
1237 (defcustom interprogram-paste-function 'get-clipboard-foreign
1238   "Function to call to get text cut from other programs.
1239
1240 Most window systems provide some sort of facility for cutting and
1241 pasting text between the windows of different programs.
1242 This variable holds a function that Emacs calls to obtain
1243 text that other programs have provided for pasting.
1244
1245 The function should be called with no arguments.  If the function
1246 returns nil, then no other program has provided such text, and the top
1247 of the Emacs kill ring should be used.  If the function returns a
1248 string, that string should be put in the kill ring as the latest kill.
1249
1250 Note that the function should return a string only if a program other
1251 than Emacs has provided a string for pasting; if Emacs provided the
1252 most recent string, the function should return nil.  If it is
1253 difficult to tell whether Emacs or some other program provided the
1254 current string, it is probably good enough to return nil if the string
1255 is equal (according to `string=') to the last text Emacs provided.
1256
1257 Reasonable choices include `get-clipboard-foreign' (the default), and
1258 functions calling `get-selection-foreign' (q.v.)."
1259   :type '(radio (function-item :tag "Get from Clipboard"
1260                                :format "%t\n"
1261                                get-clipboard-foreign)
1262                 (const :tag "None" nil)
1263                 (function :tag "Other"))
1264   :group 'killing)
1265
1266 \f
1267 ;;;; The kill ring data structure.
1268
1269 (defvar kill-ring nil
1270   "List of killed text sequences.
1271 Since the kill ring is supposed to interact nicely with cut-and-paste
1272 facilities offered by window systems, use of this variable should
1273 interact nicely with `interprogram-cut-function' and
1274 `interprogram-paste-function'.  The functions `kill-new',
1275 `kill-append', and `current-kill' are supposed to implement this
1276 interaction; you may want to use them instead of manipulating the kill
1277 ring directly.")
1278
1279 (defcustom kill-ring-max 30
1280   "*Maximum length of kill ring before oldest elements are thrown away."
1281   :type 'integer
1282   :group 'killing)
1283
1284 (defvar kill-ring-yank-pointer nil
1285   "The tail of the kill ring whose car is the last thing yanked.")
1286
1287 (defun kill-new (string &optional replace)
1288   "Make STRING the latest kill in the kill ring.
1289 Set `kill-ring-yank-pointer' to point to it.
1290 Run `kill-hooks'.
1291 Optional second argument REPLACE non-nil means that STRING will replace
1292 the front of the kill ring, rather than being added to the list."
1293 ;  (and (fboundp 'menu-bar-update-yank-menu)
1294 ;       (menu-bar-update-yank-menu string (and replace (car kill-ring))))
1295   (if replace
1296       (setcar kill-ring string)
1297     (setq kill-ring (cons string kill-ring))
1298     (if (> (length kill-ring) kill-ring-max)
1299         (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
1300   (setq kill-ring-yank-pointer kill-ring)
1301   (if interprogram-cut-function
1302       (funcall interprogram-cut-function string (not replace)))
1303   (run-hook-with-args 'kill-hooks string))
1304
1305 (defun kill-append (string before-p)
1306   "Append STRING to the end of the latest kill in the kill ring.
1307 If BEFORE-P is non-nil, prepend STRING to the kill.
1308 Run `kill-hooks'."
1309   (kill-new (if before-p
1310                 (concat string (car kill-ring))
1311               (concat (car kill-ring) string)) t))
1312
1313 (defun current-kill (n &optional do-not-move)
1314   "Rotate the yanking point by N places, and then return that kill.
1315 If N is zero, `interprogram-paste-function' is set, and calling it
1316 returns a string, then that string is added to the front of the
1317 kill ring and returned as the latest kill.
1318 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1319 yanking point\; just return the Nth kill forward."
1320   (let ((interprogram-paste (and (= n 0)
1321                                  interprogram-paste-function
1322                                  (funcall interprogram-paste-function))))
1323     (if interprogram-paste
1324         (progn
1325           ;; Disable the interprogram cut function when we add the new
1326           ;; text to the kill ring, so Emacs doesn't try to own the
1327           ;; selection, with identical text.
1328           (let ((interprogram-cut-function nil))
1329             (kill-new interprogram-paste))
1330           interprogram-paste)
1331       (or kill-ring (error "Kill ring is empty"))
1332       (let* ((tem (nthcdr (mod (- n (length kill-ring-yank-pointer))
1333                                (length kill-ring))
1334                           kill-ring)))
1335         (or do-not-move
1336             (setq kill-ring-yank-pointer tem))
1337         (car tem)))))
1338
1339
1340 \f
1341 ;;;; Commands for manipulating the kill ring.
1342
1343 ;; In FSF killing read-only text just pastes it into kill-ring.  Which
1344 ;; is a very bad idea -- see Jamie's comment below.
1345
1346 ;(defvar kill-read-only-ok nil
1347 ;  "*Non-nil means don't signal an error for killing read-only text.")
1348
1349 (defun kill-region (start end &optional verbose) ; verbose is XEmacs addition
1350   "Kill between point and mark.
1351 The text is deleted but saved in the kill ring.
1352 The command \\[yank] can retrieve it from there.
1353 \(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
1354
1355 This is the primitive for programs to kill text (as opposed to deleting it).
1356 Supply two arguments, character numbers indicating the stretch of text
1357  to be killed.
1358 Any command that calls this function is a \"kill command\".
1359 If the previous command was also a kill command,
1360 the text killed this time appends to the text killed last time
1361 to make one entry in the kill ring."
1362   (interactive "*r\np")
1363 ;  (interactive
1364 ;   (let ((region-hack (and zmacs-regions (eq last-command 'yank))))
1365 ;     ;; This lets "^Y^W" work.  I think this is dumb, but zwei did it.
1366 ;     (if region-hack (zmacs-activate-region))
1367 ;     (prog1
1368 ;        (list (point) (mark) current-prefix-arg)
1369 ;       (if region-hack (zmacs-deactivate-region)))))
1370   ;; start and end can be markers but the rest of this function is
1371   ;; written as if they are only integers
1372   (if (markerp start) (setq start (marker-position start)))
1373   (if (markerp end) (setq end (marker-position end)))
1374   (or (and start end) (if zmacs-regions ;; rewritten for I18N3 snarfing
1375                         (error "The region is not active now")
1376                       (error "The mark is not set now")))
1377   (if verbose (if buffer-read-only
1378                   (lmessage 'command "Copying %d characters"
1379                             (- (max start end) (min start end)))
1380                 (lmessage 'command "Killing %d characters"
1381                           (- (max start end) (min start end)))))
1382   (cond
1383
1384    ;; I don't like this large change in behavior -- jwz
1385    ;; Read-Only text means it shouldn't be deleted, so I'm restoring
1386    ;; this code, but only for text-properties and not full extents. -sb
1387    ;; If the buffer is read-only, we should beep, in case the person
1388    ;; just isn't aware of this.  However, there's no harm in putting
1389    ;; the region's text in the kill ring, anyway.
1390    ((or (and buffer-read-only (not inhibit-read-only))
1391         (text-property-not-all (min start end) (max start end) 'read-only nil))
1392    ;; This is redundant.
1393    ;; (if verbose (message "Copying %d characters"
1394    ;;                    (- (max start end) (min start end))))
1395     (copy-region-as-kill start end)
1396    ;; ;; This should always barf, and give us the correct error.
1397    ;; (if kill-read-only-ok
1398    ;;     (message "Read only text copied to kill ring")
1399     (setq this-command 'kill-region)
1400     (barf-if-buffer-read-only)
1401     (signal 'buffer-read-only (list (current-buffer))))
1402
1403    ;; In certain cases, we can arrange for the undo list and the kill
1404    ;; ring to share the same string object.  This code does that.
1405    ((not (or (eq buffer-undo-list t)
1406              (eq last-command 'kill-region)
1407              ;; Use = since positions may be numbers or markers.
1408              (= start end)))
1409     ;; Don't let the undo list be truncated before we can even access it.
1410     ;; FSF calls this `undo-strong-limit'
1411     (let ((undo-high-threshold (+ (- end start) 100))
1412           ;(old-list buffer-undo-list)
1413           tail)
1414       (delete-region start end)
1415       ;; Search back in buffer-undo-list for this string,
1416       ;; in case a change hook made property changes.
1417       (setq tail buffer-undo-list)
1418       (while (and tail
1419                   (not (stringp (car-safe (car-safe tail))))) ; XEmacs
1420         (pop tail))
1421       ;; Take the same string recorded for undo
1422       ;; and put it in the kill-ring.
1423       (and tail
1424            (kill-new (car (car tail))))))
1425
1426    (t
1427     ;; if undo is not kept, grab the string then delete it (which won't
1428     ;; add another string to the undo list).
1429     (copy-region-as-kill start end)
1430     (delete-region start end)))
1431   (setq this-command 'kill-region))
1432
1433 ;; copy-region-as-kill no longer sets this-command, because it's confusing
1434 ;; to get two copies of the text when the user accidentally types M-w and
1435 ;; then corrects it with the intended C-w.
1436 (defun copy-region-as-kill (start end)
1437   "Save the region as if killed, but don't kill it.
1438 Run `kill-hooks'."
1439   (interactive "r")
1440   (if (eq last-command 'kill-region)
1441       (kill-append (buffer-substring start end) (< end start))
1442     (kill-new (buffer-substring start end)))
1443   nil)
1444
1445 (defun kill-ring-save (start end)
1446   "Save the region as if killed, but don't kill it.
1447 This command is similar to `copy-region-as-kill', except that it gives
1448 visual feedback indicating the extent of the region being copied."
1449   (interactive "r")
1450   (copy-region-as-kill start end)
1451   ;; copy before delay, for xclipboard's benefit
1452   (if (interactive-p)
1453       (let ((other-end (if (= (point) start) end start))
1454             (opoint (point))
1455             ;; Inhibit quitting so we can make a quit here
1456             ;; look like a C-g typed as a command.
1457             (inhibit-quit t))
1458         (if (pos-visible-in-window-p other-end (selected-window))
1459             (progn
1460               ;; FSF (I'm not sure what this does -sb)
1461 ;             ;; Swap point and mark.
1462 ;             (set-marker (mark-marker) (point) (current-buffer))
1463               (goto-char other-end)
1464               (sit-for 1)
1465 ;             ;; Swap back.
1466 ;             (set-marker (mark-marker) other-end (current-buffer))
1467               (goto-char opoint)
1468               ;; If user quit, deactivate the mark
1469               ;; as C-g would as a command.
1470               (and quit-flag (mark)
1471                    (zmacs-deactivate-region)))
1472           ;; too noisy. -- jwz
1473 ;         (let* ((killed-text (current-kill 0))
1474 ;                (message-len (min (length killed-text) 40)))
1475 ;           (if (= (point) start)
1476 ;               ;; Don't say "killed"; that is misleading.
1477 ;               (message "Saved text until \"%s\""
1478 ;                       (substring killed-text (- message-len)))
1479 ;             (message "Saved text from \"%s\""
1480 ;                     (substring killed-text 0 message-len))))
1481           ))))
1482
1483 (defun append-next-kill ()
1484   "Cause following command, if it kills, to append to previous kill."
1485   ;; XEmacs
1486   (interactive "_")
1487   (if (interactive-p)
1488       (progn
1489         (setq this-command 'kill-region)
1490         (display-message 'command
1491           "If the next command is a kill, it will append"))
1492     (setq last-command 'kill-region)))
1493
1494 (defun yank-pop (arg)
1495   "Replace just-yanked stretch of killed text with a different stretch.
1496 This command is allowed only immediately after a `yank' or a `yank-pop'.
1497 At such a time, the region contains a stretch of reinserted
1498 previously-killed text.  `yank-pop' deletes that text and inserts in its
1499 place a different stretch of killed text.
1500
1501 With no argument, the previous kill is inserted.
1502 With argument N, insert the Nth previous kill.
1503 If N is negative, this is a more recent kill.
1504
1505 The sequence of kills wraps around, so that after the oldest one
1506 comes the newest one."
1507   (interactive "*p")
1508   (if (not (eq last-command 'yank))
1509       (error "Previous command was not a yank"))
1510   (setq this-command 'yank)
1511   (let ((inhibit-read-only t)
1512         (before (< (point) (mark t))))
1513     (delete-region (point) (mark t))
1514     ;;(set-marker (mark-marker) (point) (current-buffer))
1515     (set-mark (point))
1516     (insert (current-kill arg))
1517     (if before
1518         ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1519         ;; It is cleaner to avoid activation, even though the command
1520         ;; loop would deactivate the mark because we inserted text.
1521         (goto-char (prog1 (mark t)
1522                      (set-marker (mark-marker t) (point) (current-buffer))))))
1523   nil)
1524
1525
1526 (defun yank (&optional arg)
1527   "Reinsert the last stretch of killed text.
1528 More precisely, reinsert the stretch of killed text most recently
1529 killed OR yanked.  Put point at end, and set mark at beginning.
1530 With just C-u as argument, same but put point at beginning (and mark at end).
1531 With argument N, reinsert the Nth most recently killed stretch of killed
1532 text.
1533 See also the command \\[yank-pop]."
1534   (interactive "*P")
1535   ;; If we don't get all the way through, make last-command indicate that
1536   ;; for the following command.
1537   (setq this-command t)
1538   (push-mark (point))
1539   (insert (current-kill (cond
1540                          ((listp arg) 0)
1541                          ((eq arg '-) -1)
1542                          (t (1- arg)))))
1543   (if (consp arg)
1544       ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1545       ;; It is cleaner to avoid activation, even though the command
1546       ;; loop would deactivate the mark because we inserted text.
1547       ;; (But it's an unnecessary kludge in XEmacs.)
1548       ;(goto-char (prog1 (mark t)
1549                    ;(set-marker (mark-marker) (point) (current-buffer)))))
1550       (exchange-point-and-mark t))
1551   ;; If we do get all the way thru, make this-command indicate that.
1552   (setq this-command 'yank)
1553   nil)
1554
1555 (defun rotate-yank-pointer (arg)
1556   "Rotate the yanking point in the kill ring.
1557 With argument, rotate that many kills forward (or backward, if negative)."
1558   (interactive "p")
1559   (current-kill arg))
1560
1561 \f
1562 (defun insert-buffer (buffer)
1563   "Insert after point the contents of BUFFER.
1564 Puts mark after the inserted text.
1565 BUFFER may be a buffer or a buffer name."
1566   (interactive
1567    (list
1568     (progn
1569       (barf-if-buffer-read-only)
1570       (read-buffer "Insert buffer: "
1571                    ;; XEmacs: we have different args
1572                    (other-buffer (current-buffer) nil t)
1573                    t))))
1574   (or (bufferp buffer)
1575       (setq buffer (get-buffer buffer)))
1576   (let (start end newmark)
1577     (save-excursion
1578       (save-excursion
1579         (set-buffer buffer)
1580         (setq start (point-min) end (point-max)))
1581       (insert-buffer-substring buffer start end)
1582       (setq newmark (point)))
1583     (push-mark newmark))
1584   nil)
1585
1586 (defun append-to-buffer (buffer start end)
1587   "Append to specified buffer the text of the region.
1588 It is inserted into that buffer before its point.
1589
1590 When calling from a program, give three arguments:
1591 BUFFER (or buffer name), START and END.
1592 START and END specify the portion of the current buffer to be copied."
1593   (interactive
1594    ;; XEmacs: we have different args to other-buffer
1595    (list (read-buffer "Append to buffer: " (other-buffer (current-buffer)
1596                                                          nil t))
1597          (region-beginning) (region-end)))
1598   (let ((oldbuf (current-buffer)))
1599     (save-excursion
1600       (set-buffer (get-buffer-create buffer))
1601       (insert-buffer-substring oldbuf start end))))
1602
1603 (defun prepend-to-buffer (buffer start end)
1604   "Prepend to specified buffer the text of the region.
1605 It is inserted into that buffer after its point.
1606
1607 When calling from a program, give three arguments:
1608 BUFFER (or buffer name), START and END.
1609 START and END specify the portion of the current buffer to be copied."
1610   (interactive "BPrepend to buffer: \nr")
1611   (let ((oldbuf (current-buffer)))
1612     (save-excursion
1613       (set-buffer (get-buffer-create buffer))
1614       (save-excursion
1615         (insert-buffer-substring oldbuf start end)))))
1616
1617 (defun copy-to-buffer (buffer start end)
1618   "Copy to specified buffer the text of the region.
1619 It is inserted into that buffer, replacing existing text there.
1620
1621 When calling from a program, give three arguments:
1622 BUFFER (or buffer name), START and END.
1623 START and END specify the portion of the current buffer to be copied."
1624   (interactive "BCopy to buffer: \nr")
1625   (let ((oldbuf (current-buffer)))
1626     (save-excursion
1627       (set-buffer (get-buffer-create buffer))
1628       (erase-buffer)
1629       (save-excursion
1630         (insert-buffer-substring oldbuf start end)))))
1631 \f
1632 ;FSFmacs
1633 ;(put 'mark-inactive 'error-conditions '(mark-inactive error))
1634 ;(put 'mark-inactive 'error-message "The mark is not active now")
1635
1636 (defun mark (&optional force buffer)
1637   "Return this buffer's mark value as integer, or nil if no mark.
1638
1639 If `zmacs-regions' is true, then this returns nil unless the region is
1640 currently in the active (highlighted) state.  With an argument of t, this
1641 returns the mark (if there is one) regardless of the active-region state.
1642 You should *generally* not use the mark unless the region is active, if
1643 the user has expressed a preference for the active-region model.
1644
1645 If you are using this in an editing command, you are most likely making
1646 a mistake; see the documentation of `set-mark'."
1647   (setq buffer (decode-buffer buffer))
1648 ;FSFmacs version:
1649 ;  (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
1650 ;      (marker-position (mark-marker))
1651 ;    (signal 'mark-inactive nil)))
1652   (let ((m (mark-marker force buffer)))
1653     (and m (marker-position m))))
1654
1655 ;;;#### FSFmacs
1656 ;;; Many places set mark-active directly, and several of them failed to also
1657 ;;; run deactivate-mark-hook.  This shorthand should simplify.
1658 ;(defsubst deactivate-mark ()
1659 ;  "Deactivate the mark by setting `mark-active' to nil.
1660 ;\(That makes a difference only in Transient Mark mode.)
1661 ;Also runs the hook `deactivate-mark-hook'."
1662 ;  (if transient-mark-mode
1663 ;      (progn
1664 ;       (setq mark-active nil)
1665 ;       (run-hooks 'deactivate-mark-hook))))
1666
1667 (defun set-mark (pos &optional buffer)
1668   "Set this buffer's mark to POS.  Don't use this function!
1669 That is to say, don't use this function unless you want
1670 the user to see that the mark has moved, and you want the previous
1671 mark position to be lost.
1672
1673 Normally, when a new mark is set, the old one should go on the stack.
1674 This is why most applications should use `push-mark', not `set-mark'.
1675
1676 Novice Emacs Lisp programmers often try to use the mark for the wrong
1677 purposes.  The mark saves a location for the user's convenience.
1678 Most editing commands should not alter the mark.
1679 To remember a location for internal use in the Lisp program,
1680 store it in a Lisp variable.  Example:
1681
1682    (let ((start (point))) (forward-line 1) (delete-region start (point)))."
1683
1684   (setq buffer (decode-buffer buffer))
1685   (set-marker (mark-marker t buffer) pos buffer))
1686 ;; FSF
1687 ;  (if pos
1688 ;     (progn
1689 ;       (setq mark-active t)
1690 ;       (run-hooks 'activate-mark-hook)
1691 ;       (set-marker (mark-marker) pos (current-buffer)))
1692 ;    ;; Normally we never clear mark-active except in Transient Mark mode.
1693 ;    ;; But when we actually clear out the mark value too,
1694 ;    ;; we must clear mark-active in any mode.
1695 ;    (setq mark-active nil)
1696 ;    (run-hooks 'deactivate-mark-hook)
1697 ;    (set-marker (mark-marker) nil)))
1698
1699 (defvar mark-ring nil
1700   "The list of former marks of the current buffer, most recent first.
1701 This variable is automatically buffer-local.")
1702 (make-variable-buffer-local 'mark-ring)
1703 (put 'mark-ring 'permanent-local t)
1704
1705 (defvar dont-record-current-mark nil
1706   "If set to t, the current mark value should not be recorded on the mark ring.
1707 This is set by commands that manipulate the mark incidentally, to avoid
1708 cluttering the mark ring unnecessarily.  Under most circumstances, you do
1709 not need to set this directly; it is automatically reset each time
1710 `push-mark' is called, according to `mark-ring-unrecorded-commands'.  This
1711 variable is automatically buffer-local.")
1712 (make-variable-buffer-local 'dont-record-current-mark)
1713 (put 'dont-record-current-mark 'permanent-local t)
1714
1715 ;; a conspiracy between push-mark and handle-pre-motion-command
1716 (defvar in-shifted-motion-command nil)
1717
1718 (defcustom mark-ring-unrecorded-commands '(shifted-motion-commands
1719                                            yank
1720                                            mark-beginning-of-buffer
1721                                            mark-bob
1722                                            mark-defun
1723                                            mark-end-of-buffer
1724                                            mark-end-of-line
1725                                            mark-end-of-sentence
1726                                            mark-eob
1727                                            mark-marker
1728                                            mark-page
1729                                            mark-paragraph
1730                                            mark-sexp
1731                                            mark-whole-buffer
1732                                            mark-word)
1733   "*List of commands whose marks should not be recorded on the mark stack.
1734 Many commands set the mark as part of their action.  Normally, all such
1735 marks get recorded onto the mark stack.  However, this tends to clutter up
1736 the mark stack unnecessarily.  You can control this by putting a command
1737 onto this list.  Then, any marks set by the function will not be recorded.
1738
1739 The special value `shifted-motion-commands' causes marks set as a result
1740 of selection using any shifted motion commands to not be recorded.
1741
1742 The value `yank' affects all yank-like commands, as well as just `yank'."
1743   :type '(repeat (choice (const :tag "shifted motion commands"
1744                                 shifted-motion-commands)
1745                          (const :tag "functions that select text"
1746                                 :inline t
1747                                 (mark-beginning-of-buffer
1748                                  mark-bob
1749                                  mark-defun
1750                                  mark-end-of-buffer
1751                                  mark-end-of-line
1752                                  mark-end-of-sentence
1753                                  mark-eob
1754                                  mark-marker
1755                                  mark-page
1756                                  mark-paragraph
1757                                  mark-sexp
1758                                  mark-whole-buffer
1759                                  mark-word))
1760                          (const :tag "functions that paste text"
1761                                 yank)
1762                          function))
1763   :group 'killing)
1764
1765 (defcustom mark-ring-max 16
1766   "*Maximum size of mark ring.  Start discarding off end if gets this big."
1767   :type 'integer
1768   :group 'killing)
1769
1770 (defvar global-mark-ring nil
1771   "The list of saved global marks, most recent first.")
1772
1773 (defcustom global-mark-ring-max 16
1774   "*Maximum size of global mark ring.  \
1775 Start discarding off end if gets this big."
1776   :type 'integer
1777   :group 'killing)
1778
1779 (defun set-mark-command (arg)
1780   "Set mark at where point is, or jump to mark.
1781 With no prefix argument, set mark, push old mark position on local mark
1782 ring, and push mark on global mark ring.
1783 With argument, jump to mark, and pop a new position for mark off the ring
1784 \(does not affect global mark ring\).
1785
1786 The mark ring is a per-buffer stack of marks, most recent first.  Its
1787 maximum length is controlled by `mark-ring-max'.  Generally, when new
1788 marks are set, the current mark is pushed onto the stack.  You can pop
1789 marks off the stack using \\[universal-argument] \\[set-mark-command].  The term \"ring\" is used because when
1790 you pop a mark off the stack, the current mark value is pushed onto the
1791 far end of the stack.  If this is confusing, just think of the mark ring
1792 as a stack.
1793
1794 Novice Emacs Lisp programmers often try to use the mark for the wrong
1795 purposes.  See the documentation of `set-mark' for more information."
1796   (interactive "P")
1797   (if (null arg)
1798       (push-mark nil nil t)
1799     (if (null (mark t))
1800         (error "No mark set in this buffer")
1801       (if dont-record-current-mark (pop-mark))
1802       (goto-char (mark t))
1803       (pop-mark))))
1804
1805 ;; XEmacs: Extra parameter
1806 (defun push-mark (&optional location nomsg activate-region buffer)
1807   "Set mark at LOCATION (point, by default) and push old mark on mark ring.
1808 If the last global mark pushed was not in the current buffer,
1809 also push LOCATION on the global mark ring.
1810 Display `Mark set' unless the optional second arg NOMSG is non-nil.
1811 Activate mark if optional third arg ACTIVATE-REGION non-nil.
1812
1813 Novice Emacs Lisp programmers often try to use the mark for the wrong
1814 purposes.  See the documentation of `set-mark' for more information."
1815   (setq buffer (decode-buffer buffer)) ; XEmacs
1816   (if (or dont-record-current-mark (null (mark t buffer))) ; XEmacs
1817       nil
1818     ;; The save-excursion / set-buffer is necessary because mark-ring
1819     ;; is a buffer local variable
1820     (save-excursion
1821       (set-buffer buffer)
1822       (setq mark-ring (cons (copy-marker (mark-marker t buffer)) mark-ring))
1823       (if (> (length mark-ring) mark-ring-max)
1824           (progn
1825             (move-marker (car (nthcdr mark-ring-max mark-ring)) nil buffer)
1826             (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))))
1827   (set-mark (or location (point buffer)) buffer)
1828 ; (set-marker (mark-marker) (or location (point)) (current-buffer)) ; FSF
1829   ;; Now push the mark on the global mark ring.
1830   (if (and (not dont-record-current-mark)
1831            (or (null global-mark-ring)
1832                (not (eq (marker-buffer (car global-mark-ring)) buffer))))
1833       ;; The last global mark pushed wasn't in this same buffer.
1834       (progn
1835         (setq global-mark-ring (cons (copy-marker (mark-marker t buffer))
1836                                      global-mark-ring))
1837         (if (> (length global-mark-ring) global-mark-ring-max)
1838             (progn
1839               (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
1840                            nil buffer)
1841               (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))))
1842   (setq dont-record-current-mark
1843         (not (not (or (and in-shifted-motion-command
1844                            (memq 'shifted-motion-commands
1845                                  mark-ring-unrecorded-commands))
1846                       (memq this-command mark-ring-unrecorded-commands)))))
1847   (or dont-record-current-mark nomsg executing-kbd-macro
1848       (> (minibuffer-depth) 0)
1849       (display-message 'command "Mark set"))
1850   (if activate-region
1851       (progn
1852         (setq zmacs-region-stays t)
1853         (zmacs-activate-region)))
1854 ; (if (or activate (not transient-mark-mode)) ; FSF
1855 ;     (set-mark (mark t))) ; FSF
1856   nil)
1857
1858 (defun pop-mark ()
1859   "Pop off mark ring into the buffer's actual mark.
1860 Does not set point.  Does nothing if mark ring is empty."
1861   (if mark-ring
1862       (progn
1863         (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker t)))))
1864         (set-mark (car mark-ring))
1865         (move-marker (car mark-ring) nil)
1866         (if (null (mark t)) (ding))
1867         (setq mark-ring (cdr mark-ring)))))
1868
1869 (define-function 'exchange-dot-and-mark 'exchange-point-and-mark)
1870 (defun exchange-point-and-mark (&optional dont-activate-region)
1871   "Put the mark where point is now, and point where the mark is now.
1872 The mark is activated unless DONT-ACTIVATE-REGION is non-nil."
1873   (interactive nil)
1874   (let ((omark (mark t)))
1875     (if (null omark)
1876         (error "No mark set in this buffer"))
1877     (set-mark (point))
1878     (goto-char omark)
1879     (or dont-activate-region (zmacs-activate-region)) ; XEmacs
1880     nil))
1881
1882 ;; XEmacs
1883 (defun mark-something (mark-fn movement-fn arg)
1884   "internal function used by mark-sexp, mark-word, etc."
1885   (let (newmark (pushp t))
1886     (save-excursion
1887       (if (and (eq last-command mark-fn) (mark))
1888           ;; Extend the previous state in the same direction:
1889           (progn
1890             (if (< (mark) (point)) (setq arg (- arg)))
1891             (goto-char (mark))
1892             (setq pushp nil)))
1893       (funcall movement-fn arg)
1894       (setq newmark (point)))
1895     (if pushp
1896         (push-mark newmark nil t)
1897       ;; Do not mess with the mark stack, but merely adjust the previous state:
1898       (set-mark newmark)
1899       (activate-region))))
1900
1901 ;(defun transient-mark-mode (arg)
1902 ;  "Toggle Transient Mark mode.
1903 ;With arg, turn Transient Mark mode on if arg is positive, off otherwise.
1904 ;
1905 ;In Transient Mark mode, when the mark is active, the region is highlighted.
1906 ;Changing the buffer \"deactivates\" the mark.
1907 ;So do certain other operations that set the mark
1908 ;but whose main purpose is something else--for example,
1909 ;incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]."
1910 ;  (interactive "P")
1911 ;  (setq transient-mark-mode
1912 ;       (if (null arg)
1913 ;           (not transient-mark-mode)
1914 ;         (> (prefix-numeric-value arg) 0))))
1915
1916 (defun pop-global-mark ()
1917   "Pop off global mark ring and jump to the top location."
1918   (interactive)
1919   ;; Pop entries which refer to non-existent buffers.
1920   (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
1921     (setq global-mark-ring (cdr global-mark-ring)))
1922   (or global-mark-ring
1923       (error "No global mark set"))
1924   (let* ((marker (car global-mark-ring))
1925          (buffer (marker-buffer marker))
1926          (position (marker-position marker)))
1927     (setq global-mark-ring (nconc (cdr global-mark-ring)
1928                                   (list (car global-mark-ring))))
1929     (set-buffer buffer)
1930     (or (and (>= position (point-min))
1931              (<= position (point-max)))
1932         (widen))
1933     (goto-char position)
1934     (switch-to-buffer buffer)))
1935
1936 \f
1937 (defcustom signal-error-on-buffer-boundary t
1938   "*If Non-nil, beep or signal an error when moving past buffer boundary.
1939 The commands that honor this variable are
1940
1941 forward-char-command
1942 backward-char-command
1943 next-line
1944 previous-line
1945 scroll-up-command
1946 scroll-down-command"
1947   :type 'boolean
1948   :group 'editing-basics)
1949
1950 ;;; After 8 years of waiting ... -sb
1951 (defcustom next-line-add-newlines nil  ; XEmacs
1952   "*If non-nil, `next-line' inserts newline when the point is at end of buffer.
1953 This behavior used to be the default, and is still default in FSF Emacs.
1954 We think it is an unnecessary and unwanted side-effect."
1955   :type 'boolean
1956   :group 'editing-basics)
1957
1958 (defcustom shifted-motion-keys-select-region t
1959   "*If non-nil, shifted motion keys select text, like in MS Windows.
1960
1961 More specifically, if a keystroke that matches one of the key
1962 specifications in `motion-keys-for-shifted-motion' is pressed along
1963 with the Shift key, and the command invoked moves the cursor and
1964 preserves the active region (see `zmacs-region-stays'), the
1965 intervening text will be added to the active region.
1966
1967 When the region has been enabled or augmented as a result of a shifted
1968 motion key, an unshifted motion key will normally deselect the region.
1969 However, if `unshifted-motion-keys-deselect-region' is t, the region
1970 will remain active, augmented by the characters moved over by this
1971 motion key.
1972
1973 This functionality is specifically interpreted in terms of keys, and
1974 *NOT* in terms of particular commands, because that produces the most
1975 intuitive behavior: `forward-char' will work with shifted motion
1976 when invoked by `right' but not `C-f', and user-written motion commands
1977 bound to motion keys will automatically work with shifted motion."
1978   :type 'boolean
1979   :group 'editing-basics)
1980
1981 (defcustom unshifted-motion-keys-deselect-region t
1982   "*If non-nil, unshifted motion keys deselect a shifted-motion region.
1983 This only occurs after a region has been selected or augmented using
1984 shifted motion keys (not when using the traditional set-mark-then-move
1985 method), and has no effect if `shifted-motion-keys-select-region' is
1986 nil."
1987   :type 'boolean
1988   :group 'editing-basics)
1989
1990 (defcustom motion-keys-for-shifted-motion
1991   '(left right up down home end prior next
1992          kp-left kp-right kp-up kp-down kp-home kp-end kp-prior kp-next)
1993   "*List of keys considered motion keys for the purpose of shifted selection.
1994 When one of these keys is pressed along with the Shift key, and the
1995 command invoked moves the cursor and preserves the active region (see
1996 `zmacs-region-stays'), the intervening text will be added to the active
1997 region.  See `shifted-motion-keys-select-region' for more details.
1998
1999 Each entry should be a keysym or a list (MODIFIERS ... KEYSYM),
2000 i.e. zero or more modifiers followed by a keysym.  When a keysym alone
2001 is given, a keystroke consisting of that keysym, with or without any
2002 modifiers, is considered a motion key.  When the list form is given,
2003 only a keystroke with exactly those modifiers and no others (with the
2004 exception of the Shift key) is considered a motion key.
2005
2006 NOTE: Currently, the keysym cannot be a non-alphabetic character key
2007 such as the `=/+' key.  In any case, the shifted-motion paradigm does
2008 not make much sense with those keys.  The keysym can, however, be an
2009 alphabetic key without problem, and you can specify the key using
2010 either a character or a symbol, uppercase or lowercase."
2011   :type '(repeat (choice (const :tag "normal cursor-pad (\"gray\") keys"
2012                                 :inline t
2013                                 (left right up down home end prior next))
2014                          (const :tag "keypad motion keys"
2015                                 :inline t
2016                                 (kp-left kp-right kp-up kp-down
2017                                          kp-home kp-end kp-prior kp-next))
2018                          (const :tag "alphabetic motion keys"
2019                                 :inline t
2020                                 ((control b) (control f)
2021                                  (control p) (control n)
2022                                  (control a) (control e)
2023                                  (control v) (meta v)
2024                                  (meta b) (meta f)
2025                                  (meta a) (meta e)
2026                                  (meta m) ; back-to-indentation
2027                                  (meta r) ; move-to-window-line
2028                                  (meta control b) (meta control f)
2029                                  (meta control p) (meta control n)
2030                                  (meta control a) (meta control e)
2031                                  (meta control d) ;; down-list
2032                                  (meta control u) ;; backward-up-list
2033                                  ))
2034                          symbol))
2035   :group 'editing-basics)
2036
2037 (defun handle-pre-motion-command-current-command-is-motion ()
2038   (and (key-press-event-p last-input-event)
2039        (let ((key (event-key last-input-event))
2040              (mods (delq 'shift (event-modifiers last-input-event))))
2041          ;(princ (format "key: %s mods: %s\n" key mods) 'external-debugging-output)
2042          (catch 'handle-pre-motion-command-current-command-is-motion
2043            (flet ((keysyms-equal (a b)
2044                     (if (characterp a)
2045                         (setq a (intern (char-to-string (downcase a)))))
2046                     (if (characterp b)
2047                         (setq b (intern (char-to-string (downcase b)))))
2048                     (eq a b)))
2049              (mapc #'(lambda (keysym)
2050                        (when (if (listp keysym)
2051                                  (and (equal mods (butlast keysym))
2052                                       (keysyms-equal key (car (last keysym))))
2053                                (keysyms-equal key keysym))
2054                          (throw
2055                           'handle-pre-motion-command-current-command-is-motion
2056                           t)))
2057                    motion-keys-for-shifted-motion)
2058              nil)))))
2059
2060 (defun handle-pre-motion-command ()
2061   (if (and
2062        (handle-pre-motion-command-current-command-is-motion)
2063        zmacs-regions
2064        shifted-motion-keys-select-region
2065        (not (region-active-p))
2066        ;; Special-case alphabetic keysyms, because the `shift'
2067        ;; modifier does not appear on them. (Unfortunately, we have no
2068        ;; way of determining Shift-key status on non-alphabetic ASCII
2069        ;; keysyms.  However, in this case, using Shift will invoke a
2070        ;; separate command from the non-shifted version, so the
2071        ;; "shifted motion" paradigm makes no sense.)
2072        (or (memq 'shift (event-modifiers last-input-event))
2073            (let ((key (event-key last-input-event)))
2074              (and (characterp key)
2075                   (not (eq key (downcase key)))))))
2076       (let ((in-shifted-motion-command t))
2077         (push-mark nil nil t))))
2078
2079 (defun handle-post-motion-command ()
2080   (if
2081       (and
2082        (handle-pre-motion-command-current-command-is-motion)
2083        zmacs-regions
2084        (region-active-p))
2085       ;; Special-case alphabetic keysyms, because the `shift'
2086       ;; modifier does not appear on them.  See above.
2087       (cond ((or (memq 'shift (event-modifiers last-input-event))
2088                  (let ((key (event-key last-input-event)))
2089                    (and (characterp key)
2090                         (not (eq key (downcase key))))))
2091              (if shifted-motion-keys-select-region
2092                  (putf this-command-properties 'shifted-motion-command t))
2093              (setq zmacs-region-stays t))
2094             ((and (getf last-command-properties 'shifted-motion-command)
2095                   unshifted-motion-keys-deselect-region)
2096              (setq zmacs-region-stays nil)))))
2097
2098 (defun forward-char-command (&optional arg buffer)
2099   "Move point right ARG characters (left if ARG negative) in BUFFER.
2100 On attempt to pass end of buffer, stop and signal `end-of-buffer'.
2101 On attempt to pass beginning of buffer, stop and signal `beginning-of-buffer'.
2102 Error signaling is suppressed if `signal-error-on-buffer-boundary'
2103 is nil.  If BUFFER is nil, the current buffer is assumed.
2104
2105 The characters that are moved over may be added to the current selection
2106 \(i.e. active region) if the Shift key is held down, a motion key is used
2107 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2108 the documentation for this variable for more details."
2109   (interactive "_p")
2110   (if signal-error-on-buffer-boundary
2111       (forward-char arg buffer)
2112     (condition-case nil
2113         (forward-char arg buffer)
2114       (beginning-of-buffer nil)
2115       (end-of-buffer nil))))
2116
2117 (defun backward-char-command (&optional arg buffer)
2118   "Move point left ARG characters (right if ARG negative) in BUFFER.
2119 On attempt to pass end of buffer, stop and signal `end-of-buffer'.
2120 On attempt to pass beginning of buffer, stop and signal `beginning-of-buffer'.
2121 Error signaling is suppressed if `signal-error-on-buffer-boundary'
2122 is nil.  If BUFFER is nil, the current buffer is assumed.
2123
2124 The characters that are moved over may be added to the current selection
2125 \(i.e. active region) if the Shift key is held down, a motion key is used
2126 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2127 the documentation for this variable for more details."
2128   (interactive "_p")
2129   (if signal-error-on-buffer-boundary
2130       (backward-char arg buffer)
2131     (condition-case nil
2132         (backward-char arg buffer)
2133       (beginning-of-buffer nil)
2134       (end-of-buffer nil))))
2135
2136 (defun scroll-up-one ()
2137   "Scroll text of current window upward one line.
2138 On attempt to scroll past end of buffer, `end-of-buffer' is signaled.
2139 On attempt to scroll past beginning of buffer, `beginning-of-buffer' is
2140 signaled.
2141
2142 If `signal-error-on-buffer-boundary' is nil, attempts to scroll past buffer
2143 boundaries do not cause an error to be signaled."
2144   (interactive "_")
2145   (scroll-up-command 1))
2146
2147 (defun scroll-up-command (&optional n)
2148   "Scroll current window upward N lines; or near full screen if N is nil.
2149 A near full screen is `next-screen-context-lines' less than a full screen.
2150 Negative N means scroll downward.
2151 When calling from a program, supply a number as argument or nil.
2152 On attempt to scroll past end of buffer, `end-of-buffer' is signaled.
2153 On attempt to scroll past beginning of buffer, `beginning-of-buffer' is
2154 signaled.
2155
2156 The characters that are moved over may be added to the current selection
2157 \(i.e. active region) if the Shift key is held down, a motion key is used
2158 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2159 the documentation for this variable for more details.
2160
2161 If `signal-error-on-buffer-boundary' is nil, attempts to scroll past buffer
2162 boundaries do not cause an error to be signaled."
2163   (interactive "_P")
2164   (if signal-error-on-buffer-boundary
2165       (scroll-up n)
2166     (condition-case nil
2167         (scroll-up n)
2168       (beginning-of-buffer nil)
2169       (end-of-buffer nil))))
2170
2171 (defun scroll-down-one ()
2172   "Scroll text of current window downward one line.
2173 On attempt to scroll past end of buffer, `end-of-buffer' is signaled.
2174 On attempt to scroll past beginning of buffer, `beginning-of-buffer' is
2175 signaled.
2176
2177 If `signal-error-on-buffer-boundary' is nil, attempts to scroll past buffer
2178 boundaries do not cause an error to be signaled."
2179   (interactive "_")
2180   (scroll-down-command 1))
2181
2182 (defun scroll-down-command (&optional n)
2183   "Scroll current window downward N lines; or near full screen if N is nil.
2184 A near full screen is `next-screen-context-lines' less than a full screen.
2185 Negative N means scroll upward.
2186 When calling from a program, supply a number as argument or nil.
2187 On attempt to scroll past end of buffer, `end-of-buffer' is signaled.
2188 On attempt to scroll past beginning of buffer, `beginning-of-buffer' is
2189 signaled.
2190
2191 If `signal-error-on-buffer-boundary' is nil, attempts to scroll past buffer
2192 boundaries do not cause an error to be signaled.
2193
2194 The characters that are moved over may be added to the current selection
2195 \(i.e. active region) if the Shift key is held down, a motion key is used
2196 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2197 the documentation for this variable for more details."
2198   (interactive "_P")
2199   (if signal-error-on-buffer-boundary
2200       (scroll-down n)
2201     (condition-case nil
2202         (scroll-down n)
2203       (beginning-of-buffer nil)
2204       (end-of-buffer nil))))
2205
2206 (defun next-line (count)
2207   "Move cursor vertically down COUNT lines.
2208 If there is no character in the target line exactly under the current column,
2209 the cursor is positioned after the character in that line which spans this
2210 column, or at the end of the line if it is not long enough.
2211
2212 If there is no line in the buffer after this one, behavior depends on the
2213 value of `next-line-add-newlines'.  If non-nil, it inserts a newline character
2214 to create a line, and moves the cursor to that line.  Otherwise it moves the
2215 cursor to the end of the buffer.
2216
2217 The command \\[set-goal-column] can be used to create
2218 a semipermanent goal column to which this command always moves.
2219 Then it does not try to move vertically.  This goal column is stored
2220 in `goal-column', which is nil when there is none.
2221
2222 The characters that are moved over may be added to the current selection
2223 \(i.e. active region) if the Shift key is held down, a motion key is used
2224 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2225 the documentation for this variable for more details.
2226
2227 If you are thinking of using this in a Lisp program, consider
2228 using `forward-line' instead.  It is usually easier to use
2229 and more reliable (no dependence on goal column, etc.)."
2230   (interactive "_p")
2231   (if (and next-line-add-newlines (= count 1))
2232       (let ((opoint (point)))
2233         (end-of-line)
2234         (if (eobp)
2235             (newline 1)
2236           (goto-char opoint)
2237           (line-move count)))
2238     (if (interactive-p)
2239         ;; XEmacs:  Not sure what to do about this.  It's inconsistent. -sb
2240         (condition-case nil
2241             (line-move count)
2242           ((beginning-of-buffer end-of-buffer)
2243            (when signal-error-on-buffer-boundary
2244              (ding nil 'buffer-bound))))
2245       (line-move count)))
2246   nil)
2247
2248 (defun previous-line (count)
2249   "Move cursor vertically up COUNT lines.
2250 If there is no character in the target line exactly over the current column,
2251 the cursor is positioned after the character in that line which spans this
2252 column, or at the end of the line if it is not long enough.
2253
2254 The command \\[set-goal-column] can be used to create
2255 a semipermanent goal column to which this command always moves.
2256 Then it does not try to move vertically.
2257
2258 The characters that are moved over may be added to the current selection
2259 \(i.e. active region) if the Shift key is held down, a motion key is used
2260 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2261 the documentation for this variable for more details.
2262
2263 If you are thinking of using this in a Lisp program, consider using
2264 `forward-line' with a negative argument instead.  It is usually easier
2265 to use and more reliable (no dependence on goal column, etc.)."
2266   (interactive "_p")
2267   (if (interactive-p)
2268       (condition-case nil
2269           (line-move (- count))
2270         ((beginning-of-buffer end-of-buffer)
2271          (when signal-error-on-buffer-boundary ; XEmacs
2272            (ding nil 'buffer-bound))))
2273     (line-move (- count)))
2274   nil)
2275
2276 (defcustom block-movement-size 6
2277   "*Number of lines that \"block movement\" commands (\\[forward-block-of-lines], \\[backward-block-of-lines]) move by."
2278   :type 'integer
2279   :group 'editing-basics)
2280
2281 (defun backward-block-of-lines ()
2282   "Move backward by one \"block\" of lines.
2283 The number of lines that make up a block is controlled by
2284 `block-movement-size', which defaults to 6.
2285
2286 The characters that are moved over may be added to the current selection
2287 \(i.e. active region) if the Shift key is held down, a motion key is used
2288 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2289 the documentation for this variable for more details."
2290   (interactive "_")
2291   (forward-line (- block-movement-size)))
2292
2293 (defun forward-block-of-lines ()
2294   "Move forward by one \"block\" of lines.
2295 The number of lines that make up a block is controlled by
2296 `block-movement-size', which defaults to 6.
2297
2298 The characters that are moved over may be added to the current selection
2299 \(i.e. active region) if the Shift key is held down, a motion key is used
2300 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2301 the documentation for this variable for more details."
2302   (interactive "_")
2303   (forward-line block-movement-size))
2304
2305 (defcustom track-eol nil
2306   "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
2307 This means moving to the end of each line moved onto.
2308 The beginning of a blank line does not count as the end of a line."
2309   :type 'boolean
2310   :group 'editing-basics)
2311
2312 (defcustom goal-column nil
2313   "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
2314   :type '(choice integer (const :tag "None" nil))
2315   :group 'editing-basics)
2316 (make-variable-buffer-local 'goal-column)
2317
2318 (defvar temporary-goal-column 0
2319   "Current goal column for vertical motion.
2320 It is the column where point was
2321 at the start of current run of vertical motion commands.
2322 When the `track-eol' feature is doing its job, the value is 9999.")
2323 (make-variable-buffer-local 'temporary-goal-column)
2324
2325 ;XEmacs: not yet ported, so avoid compiler warnings
2326 (eval-when-compile
2327   (defvar inhibit-point-motion-hooks))
2328
2329 (defcustom line-move-ignore-invisible nil
2330   "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
2331 Use with care, as it slows down movement significantly.  Outline mode sets this."
2332   :type 'boolean
2333   :group 'editing-basics)
2334
2335 ;; This is the guts of next-line and previous-line.
2336 ;; Count says how many lines to move.
2337 (defun line-move (count)
2338   ;; Don't run any point-motion hooks, and disregard intangibility,
2339   ;; for intermediate positions.
2340   (let ((inhibit-point-motion-hooks t)
2341         (opoint (point))
2342         new)
2343     (unwind-protect
2344         (progn
2345           (if (not (or (eq last-command 'next-line)
2346                        (eq last-command 'previous-line)))
2347               (setq temporary-goal-column
2348                     (if (and track-eol (eolp)
2349                              ;; Don't count start of empty line as end of line
2350                              ;; unless we just did explicit end-of-line.
2351                              (or (not (bolp)) (eq last-command 'end-of-line)))
2352                         9999
2353                       (current-column))))
2354           (if (and (not (integerp selective-display))
2355                    (not line-move-ignore-invisible))
2356               ;; Use just newline characters.
2357               (or (if (> count 0)
2358                       (progn (if (> count 1) (forward-line (1- count)))
2359                              ;; This way of moving forward COUNT lines
2360                              ;; verifies that we have a newline after the last one.
2361                              ;; It doesn't get confused by intangible text.
2362                              (end-of-line)
2363                              (zerop (forward-line 1)))
2364                     (and (zerop (forward-line count))
2365                          (bolp)))
2366                   (signal (if (< count 0)
2367                               'beginning-of-buffer
2368                             'end-of-buffer)
2369                           nil))
2370             ;; Move by count lines, but ignore invisible ones.
2371             (while (> count 0)
2372               (end-of-line)
2373               (and (zerop (vertical-motion 1))
2374                    (signal 'end-of-buffer nil))
2375               ;; If the following character is currently invisible,
2376               ;; skip all characters with that same `invisible' property value.
2377               (while (and (not (eobp))
2378                           (let ((prop
2379                                  (get-char-property (point) 'invisible)))
2380                             (if (eq buffer-invisibility-spec t)
2381                                 prop
2382                               (or (memq prop buffer-invisibility-spec)
2383                                   (assq prop buffer-invisibility-spec)))))
2384                 (if (get-text-property (point) 'invisible)
2385                     (goto-char (next-single-property-change (point) 'invisible))
2386                   (goto-char (next-extent-change (point))))) ; XEmacs
2387               (setq count (1- count)))
2388             (while (< count 0)
2389               (beginning-of-line)
2390               (and (zerop (vertical-motion -1))
2391                    (signal 'beginning-of-buffer nil))
2392               (while (and (not (bobp))
2393                           (let ((prop
2394                                  (get-char-property (1- (point)) 'invisible)))
2395                             (if (eq buffer-invisibility-spec t)
2396                                 prop
2397                               (or (memq prop buffer-invisibility-spec)
2398                                   (assq prop buffer-invisibility-spec)))))
2399                 (if (get-text-property (1- (point)) 'invisible)
2400                     (goto-char (previous-single-property-change (point) 'invisible))
2401                   (goto-char (previous-extent-change (point))))) ; XEmacs
2402               (setq count (1+ count))))
2403           (move-to-column (or goal-column temporary-goal-column)))
2404       ;; Remember where we moved to, go back home,
2405       ;; then do the motion over again
2406       ;; in just one step, with intangibility and point-motion hooks
2407       ;; enabled this time.
2408       (setq new (point))
2409       (goto-char opoint)
2410       (setq inhibit-point-motion-hooks nil)
2411       (goto-char new)))
2412   nil)
2413
2414 ;;; Many people have said they rarely use this feature, and often type
2415 ;;; it by accident.  Maybe it shouldn't even be on a key.
2416 ;; It's not on a key, as of 20.2.  So no need for this.
2417 ;(put 'set-goal-column 'disabled t)
2418
2419 (defun set-goal-column (column)
2420   "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
2421 Those commands will move to this position in the line moved to
2422 rather than trying to keep the same horizontal position.
2423 With a non-nil argument, clears out the goal column
2424 so that \\[next-line] and \\[previous-line] resume vertical motion.
2425 The goal column is stored in the variable `goal-column'."
2426   (interactive "_P") ; XEmacs
2427   (if column
2428       (progn
2429         (setq goal-column nil)
2430         (display-message 'command "No goal column"))
2431     (setq goal-column (current-column))
2432     (lmessage 'command
2433         "Goal column %d (use %s with a prefix arg to unset it)"
2434       goal-column
2435       (substitute-command-keys "\\[set-goal-column]")))
2436   nil)
2437 \f
2438 ;; deleted FSFmacs terminal randomness hscroll-point-visible stuff.
2439 ;; hscroll-step
2440 ;; hscroll-point-visible
2441 ;; hscroll-window-column
2442 ;; right-arrow
2443 ;; left-arrow
2444
2445 (defun scroll-other-window-down (lines)
2446   "Scroll the \"other window\" down.
2447 For more details, see the documentation for `scroll-other-window'."
2448   (interactive "P")
2449   (scroll-other-window
2450    ;; Just invert the argument's meaning.
2451    ;; We can do that without knowing which window it will be.
2452    (if (eq lines '-) nil
2453      (if (null lines) '-
2454        (- (prefix-numeric-value lines))))))
2455 ;(define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
2456
2457 (defun beginning-of-buffer-other-window (arg)
2458   "Move point to the beginning of the buffer in the other window.
2459 Leave mark at previous position.
2460 With arg N, put point N/10 of the way from the true beginning."
2461   (interactive "P")
2462   (let ((orig-window (selected-window))
2463         (window (other-window-for-scrolling)))
2464     ;; We use unwind-protect rather than save-window-excursion
2465     ;; because the latter would preserve the things we want to change.
2466     (unwind-protect
2467         (progn
2468           (select-window window)
2469           ;; Set point and mark in that window's buffer.
2470           (beginning-of-buffer arg)
2471           ;; Set point accordingly.
2472           (recenter '(t)))
2473       (select-window orig-window))))
2474
2475 (defun end-of-buffer-other-window (arg)
2476   "Move point to the end of the buffer in the other window.
2477 Leave mark at previous position.
2478 With arg N, put point N/10 of the way from the true end."
2479   (interactive "P")
2480   ;; See beginning-of-buffer-other-window for comments.
2481   (let ((orig-window (selected-window))
2482         (window (other-window-for-scrolling)))
2483     (unwind-protect
2484         (progn
2485           (select-window window)
2486           (end-of-buffer arg)
2487           (recenter '(t)))
2488       (select-window orig-window))))
2489 \f
2490 (defun transpose-chars (arg)
2491   "Interchange characters around point, moving forward one character.
2492 With prefix arg ARG, effect is to take character before point
2493 and drag it forward past ARG other characters (backward if ARG negative).
2494 If no argument and at end of line, the previous two chars are exchanged."
2495   (interactive "*P")
2496   (and (null arg) (eolp) (backward-char 1))
2497   (transpose-subr 'forward-char (prefix-numeric-value arg)))
2498
2499 ;;; A very old implementation of transpose-chars from the old days ...
2500 (defun transpose-preceding-chars (arg)
2501   "Interchange characters before point.
2502 With prefix arg ARG, effect is to take character before point
2503 and drag it forward past ARG other characters (backward if ARG negative).
2504 If no argument and not at start of line, the previous two chars are exchanged."
2505   (interactive "*P")
2506   (and (null arg) (not (bolp)) (backward-char 1))
2507   (transpose-subr 'forward-char (prefix-numeric-value arg)))
2508
2509
2510 (defun transpose-words (arg)
2511   "Interchange words around point, leaving point at end of them.
2512 With prefix arg ARG, effect is to take word before or around point
2513 and drag it forward past ARG other words (backward if ARG negative).
2514 If ARG is zero, the words around or after point and around or after mark
2515 are interchanged."
2516   (interactive "*p")
2517   (transpose-subr 'forward-word arg))
2518
2519 (defun transpose-sexps (arg)
2520   "Like \\[transpose-words] but applies to sexps.
2521 Does not work on a sexp that point is in the middle of
2522 if it is a list or string."
2523   (interactive "*p")
2524   (transpose-subr 'forward-sexp arg))
2525
2526 (defun transpose-lines (arg)
2527   "Exchange current line and previous line, leaving point after both.
2528 With argument ARG, takes previous line and moves it past ARG lines.
2529 With argument 0, interchanges line point is in with line mark is in."
2530   (interactive "*p")
2531   (transpose-subr #'(lambda (arg)
2532                      (if (= arg 1)
2533                          (progn
2534                            ;; Move forward over a line,
2535                            ;; but create a newline if none exists yet.
2536                            (end-of-line)
2537                            (if (eobp)
2538                                (newline)
2539                              (forward-char 1)))
2540                        (forward-line arg)))
2541                   arg))
2542
2543 (defun transpose-line-up (arg)
2544   "Move current line one line up, leaving point at beginning of that line.
2545 This can be run repeatedly to move the current line up a number of lines."
2546   (interactive "*p")
2547   ;; Move forward over a line,
2548   ;; but create a newline if none exists yet.
2549   (end-of-line)
2550   (if (eobp)
2551       (newline)
2552     (forward-char 1))
2553   (transpose-lines (- arg))
2554   (forward-line -1))
2555
2556 (defun transpose-line-down (arg)
2557   "Move current line one line down, leaving point at beginning of that line.
2558 This can be run repeatedly to move the current line down a number of lines."
2559   (interactive "*p")
2560   ;; Move forward over a line,
2561   ;; but create a newline if none exists yet.
2562   (end-of-line)
2563   (if (eobp)
2564       (newline)
2565     (forward-char 1))
2566   (transpose-lines arg)
2567   (forward-line -1))
2568
2569 (defun transpose-subr (mover arg)
2570   (let (start1 end1 start2 end2)
2571     ;; XEmacs -- use flet instead of defining a separate function and
2572     ;; relying on dynamic scope!!!
2573     (flet ((transpose-subr-1 ()
2574              (if (> (min end1 end2) (max start1 start2))
2575                  (error "Don't have two things to transpose"))
2576              (let ((word1 (buffer-substring start1 end1))
2577                    (word2 (buffer-substring start2 end2)))
2578                (delete-region start2 end2)
2579                (goto-char start2)
2580                (insert word1)
2581                (goto-char (if (< start1 start2) start1
2582                             (+ start1 (- (length word1) (length word2)))))
2583                (delete-char (length word1))
2584                (insert word2))))
2585       (if (= arg 0)
2586           (progn
2587             (save-excursion
2588               (funcall mover 1)
2589               (setq end2 (point))
2590               (funcall mover -1)
2591               (setq start2 (point))
2592               (goto-char (mark t)) ; XEmacs
2593               (funcall mover 1)
2594               (setq end1 (point))
2595               (funcall mover -1)
2596               (setq start1 (point))
2597               (transpose-subr-1))
2598             (exchange-point-and-mark t))) ; XEmacs
2599       (while (> arg 0)
2600         (funcall mover -1)
2601         (setq start1 (point))
2602         (funcall mover 1)
2603         (setq end1 (point))
2604         (funcall mover 1)
2605         (setq end2 (point))
2606         (funcall mover -1)
2607         (setq start2 (point))
2608         (transpose-subr-1)
2609         (goto-char end2)
2610         (setq arg (1- arg)))
2611       (while (< arg 0)
2612         (funcall mover -1)
2613         (setq start2 (point))
2614         (funcall mover -1)
2615         (setq start1 (point))
2616         (funcall mover 1)
2617         (setq end1 (point))
2618         (funcall mover 1)
2619         (setq end2 (point))
2620         (transpose-subr-1)
2621         (setq arg (1+ arg))))))
2622
2623 \f
2624 (defcustom comment-column 32
2625   "*Column to indent right-margin comments to.
2626 Setting this variable automatically makes it local to the current buffer.
2627 Each mode establishes a different default value for this variable; you
2628 can set the value for a particular mode using that mode's hook."
2629   :type 'integer
2630   :group 'fill-comments)
2631 (make-variable-buffer-local 'comment-column)
2632
2633 (defcustom comment-start nil
2634   "*String to insert to start a new comment, or nil if no comment syntax."
2635   :type '(choice (const :tag "None" nil)
2636                  string)
2637   :group 'fill-comments)
2638
2639 (defcustom comment-start-skip nil
2640   "*Regexp to match the start of a comment plus everything up to its body.
2641 If there are any \\(...\\) pairs, the comment delimiter text is held to begin
2642 at the place matched by the close of the first pair."
2643   :type '(choice (const :tag "None" nil)
2644                  regexp)
2645   :group 'fill-comments)
2646
2647 (defcustom comment-end ""
2648   "*String to insert to end a new comment.
2649 Should be an empty string if comments are terminated by end-of-line."
2650   :type 'string
2651   :group 'fill-comments)
2652
2653 (defconst comment-indent-hook nil
2654   "Obsolete variable for function to compute desired indentation for a comment.
2655 Use `comment-indent-function' instead.
2656 This function is called with no args with point at the beginning of
2657 the comment's starting delimiter.")
2658
2659 (defconst comment-indent-function
2660   ;; XEmacs - add at least one space after the end of the text on the
2661   ;; current line...
2662   (lambda ()
2663     (save-excursion
2664       (beginning-of-line)
2665       (let ((eol (save-excursion (end-of-line) (point))))
2666         (and comment-start-skip
2667              (re-search-forward comment-start-skip eol t)
2668              (setq eol (match-beginning 0)))
2669         (goto-char eol)
2670         (skip-chars-backward " \t")
2671         (max comment-column (1+ (current-column))))))
2672   "Function to compute desired indentation for a comment.
2673 This function is called with no args with point at the beginning of
2674 the comment's starting delimiter.")
2675
2676 (defcustom block-comment-start nil
2677   "*String to insert to start a new comment on a line by itself.
2678 If nil, use `comment-start' instead.
2679 Note that the regular expression `comment-start-skip' should skip this string
2680 as well as the `comment-start' string."
2681   :type '(choice (const :tag "Use `comment-start'" nil)
2682                  string)
2683   :group 'fill-comments)
2684
2685 (defcustom block-comment-end nil
2686   "*String to insert to end a new comment on a line by itself.
2687 Should be an empty string if comments are terminated by end-of-line.
2688 If nil, use `comment-end' instead."
2689   :type '(choice (const :tag "Use `comment-end'" nil)
2690                  string)
2691   :group 'fill-comments)
2692
2693 (defun indent-for-comment ()
2694   "Indent this line's comment to comment column, or insert an empty
2695 comment.  Comments starting in column 0 are not moved."
2696   (interactive "*")
2697   (let* ((empty (save-excursion (beginning-of-line)
2698                                 (looking-at "[ \t]*$")))
2699          (starter (or (and empty block-comment-start) comment-start))
2700          (ender (or (and empty block-comment-end) comment-end)))
2701     (if (null starter)
2702         (error "No comment syntax defined")
2703       (let* ((eolpos (save-excursion (end-of-line) (point)))
2704              cpos indent begpos)
2705         (beginning-of-line)
2706         (if (re-search-forward comment-start-skip eolpos 'move)
2707             (progn (setq cpos (point-marker))
2708                    ;; Find the start of the comment delimiter.
2709                    ;; If there were paren-pairs in comment-start-skip,
2710                    ;; position at the end of the first pair.
2711                    (if (match-end 1)
2712                        (goto-char (match-end 1))
2713                      ;; If comment-start-skip matched a string with
2714                      ;; internal whitespace (not final whitespace) then
2715                      ;; the delimiter start at the end of that
2716                      ;; whitespace.  Otherwise, it starts at the
2717                      ;; beginning of what was matched.
2718                      (skip-syntax-backward " " (match-beginning 0))
2719                      (skip-syntax-backward "^ " (match-beginning 0)))))
2720         (setq begpos (point))
2721         ;; Compute desired indent.
2722         ;; XEmacs change: Preserve indentation of comments starting in
2723         ;; column 0, as documented.
2724         (cond
2725          ((= (current-column) 0)
2726           (goto-char begpos))
2727          ((= (current-column)
2728              (setq indent (funcall comment-indent-function)))
2729           (goto-char begpos))
2730          (t
2731           ;; If that's different from current, change it.
2732           (skip-chars-backward " \t")
2733           (delete-region (point) begpos)
2734           (indent-to indent)))
2735         ;; An existing comment?
2736         (if cpos
2737             (progn (goto-char cpos)
2738                    (set-marker cpos nil))
2739           ;; No, insert one.
2740           (insert starter)
2741           (save-excursion
2742             (insert ender)))))))
2743
2744 (defun set-comment-column (arg)
2745   "Set the comment column based on point.
2746 With no arg, set the comment column to the current column.
2747 With just minus as arg, kill any comment on this line.
2748 With any other arg, set comment column to indentation of the previous comment
2749  and then align or create a comment on this line at that column."
2750   (interactive "P")
2751   (if (eq arg '-)
2752       (kill-comment nil)
2753     (if arg
2754         (progn
2755           (save-excursion
2756             (beginning-of-line)
2757             (re-search-backward comment-start-skip)
2758             (beginning-of-line)
2759             (re-search-forward comment-start-skip)
2760             (goto-char (match-beginning 0))
2761             (setq comment-column (current-column))
2762             (lmessage 'command "Comment column set to %d" comment-column))
2763           (indent-for-comment))
2764       (setq comment-column (current-column))
2765       (lmessage 'command "Comment column set to %d" comment-column))))
2766
2767 (defun kill-comment (arg)
2768   "Kill the comment on this line, if any.
2769 With argument, kill comments on that many lines starting with this one."
2770   ;; this function loses in a lot of situations.  it incorrectly recognizes
2771   ;; comment delimiters sometimes (ergo, inside a string), doesn't work
2772   ;; with multi-line comments, can kill extra whitespace if comment wasn't
2773   ;; through end-of-line, et cetera.
2774   (interactive "*P")
2775   (or comment-start-skip (error "No comment syntax defined"))
2776   (let ((count (prefix-numeric-value arg)) endc)
2777     (while (> count 0)
2778       (save-excursion
2779         (end-of-line)
2780         (setq endc (point))
2781         (beginning-of-line)
2782         (and (string< "" comment-end)
2783              (setq endc
2784                    (progn
2785                      (re-search-forward (regexp-quote comment-end) endc 'move)
2786                      (skip-chars-forward " \t")
2787                      (point))))
2788         (beginning-of-line)
2789         (if (re-search-forward comment-start-skip endc t)
2790             (progn
2791               (goto-char (match-beginning 0))
2792               (skip-chars-backward " \t")
2793               (kill-region (point) endc)
2794               ;; to catch comments a line beginnings
2795               (indent-according-to-mode))))
2796       (if arg (forward-line 1))
2797       (setq count (1- count)))))
2798
2799 (defun comment-region (start end &optional arg)
2800   "Comment or uncomment each line in the region.
2801 With just C-u prefix arg, uncomment each line in region.
2802 Numeric prefix arg ARG means use ARG comment characters.
2803 If ARG is negative, delete that many comment characters instead.
2804 Comments are terminated on each line, even for syntax in which newline does
2805 not end the comment.  Blank lines do not get comments."
2806   ;; if someone wants it to only put a comment-start at the beginning and
2807   ;; comment-end at the end then typing it, C-x C-x, closing it, C-x C-x
2808   ;; is easy enough.  No option is made here for other than commenting
2809   ;; every line.
2810   (interactive "r\nP")
2811   (or comment-start (error "No comment syntax is defined"))
2812   (if (> start end) (let (mid) (setq mid start start end end mid)))
2813   (save-excursion
2814     (save-restriction
2815       (let ((cs comment-start) (ce comment-end)
2816             numarg)
2817         (if (consp arg) (setq numarg t)
2818           (setq numarg (prefix-numeric-value arg))
2819           ;; For positive arg > 1, replicate the comment delims now,
2820           ;; then insert the replicated strings just once.
2821           (while (> numarg 1)
2822             (setq cs (concat cs comment-start)
2823                   ce (concat ce comment-end))
2824             (setq numarg (1- numarg))))
2825         ;; Loop over all lines from START to END.
2826         (narrow-to-region start end)
2827         (goto-char start)
2828         (while (not (eobp))
2829           (if (or (eq numarg t) (< numarg 0))
2830               (progn
2831                 ;; Delete comment start from beginning of line.
2832                 (if (eq numarg t)
2833                     (while (looking-at (regexp-quote cs))
2834                       (delete-char (length cs)))
2835                   (let ((count numarg))
2836                     (while (and (> 1 (setq count (1+ count)))
2837                                 (looking-at (regexp-quote cs)))
2838                       (delete-char (length cs)))))
2839                 ;; Delete comment end from end of line.
2840                 (if (string= "" ce)
2841                     nil
2842                   (if (eq numarg t)
2843                       (progn
2844                         (end-of-line)
2845                         ;; This is questionable if comment-end ends in
2846                         ;; whitespace.  That is pretty brain-damaged,
2847                         ;; though.
2848                         (skip-chars-backward " \t")
2849                         (if (and (>= (- (point) (point-min)) (length ce))
2850                                  (save-excursion
2851                                    (backward-char (length ce))
2852                                    (looking-at (regexp-quote ce))))
2853                             (delete-char (- (length ce)))))
2854                     (let ((count numarg))
2855                       (while (> 1 (setq count (1+ count)))
2856                         (end-of-line)
2857                         ;; This is questionable if comment-end ends in
2858                         ;; whitespace.  That is pretty brain-damaged though
2859                         (skip-chars-backward " \t")
2860                         (save-excursion
2861                           (backward-char (length ce))
2862                           (if (looking-at (regexp-quote ce))
2863                               (delete-char (length ce))))))))
2864                 (forward-line 1))
2865             ;; Insert at beginning and at end.
2866             (if (looking-at "[ \t]*$") ()
2867               (insert cs)
2868               (if (string= "" ce) ()
2869                 (end-of-line)
2870                 (insert ce)))
2871             (search-forward "\n" nil 'move)))))))
2872
2873 ;; XEmacs
2874 (defun prefix-region (prefix)
2875   "Add a prefix string to each line between mark and point."
2876   (interactive "sPrefix string: ")
2877   (if prefix
2878       (let ((count (count-lines (mark) (point))))
2879         (goto-char (min (mark) (point)))
2880         (while (> count 0)
2881           (setq count (1- count))
2882           (beginning-of-line 1)
2883           (insert prefix)
2884           (end-of-line 1)
2885           (forward-char 1)))))
2886
2887 \f
2888 (defun backward-word (&optional count buffer)
2889   "Move point backward COUNT words (forward if COUNT is negative).
2890 Normally t is returned, but if an edge of the buffer is reached,
2891 point is left there and nil is returned.
2892
2893 COUNT defaults to 1, and BUFFER defaults to the current buffer.
2894
2895 The characters that are moved over may be added to the current selection
2896 \(i.e. active region) if the Shift key is held down, a motion key is used
2897 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2898 the documentation for this variable for more details."
2899   (interactive "_p")
2900   (forward-word (- (or count 1)) buffer))
2901
2902 (defun mark-word (&optional count)
2903   "Mark the text from point until encountering the end of a word.
2904 With optional argument COUNT, mark COUNT words."
2905   (interactive "p")
2906   (mark-something 'mark-word 'forward-word count))
2907
2908 (defun kill-word (&optional count)
2909   "Kill characters forward until encountering the end of a word.
2910 With optional argument COUNT, do this that many times."
2911   (interactive "*p")
2912   (kill-region (point) (save-excursion (forward-word count) (point))))
2913
2914 (defun backward-kill-word (&optional count)
2915   "Kill characters backward until encountering the end of a word.
2916 With argument, do this that many times."
2917   (interactive "*p")
2918   (kill-word (- (or count 1))))
2919
2920 (defun current-word (&optional strict)
2921   "Return the word point is on (or a nearby word) as a string.
2922 If optional arg STRICT is non-nil, return nil unless point is within
2923 or adjacent to a word.
2924 If point is not between two word-constituent characters, but immediately
2925 follows one, move back first.
2926 Otherwise, if point precedes a word constituent, move forward first.
2927 Otherwise, move backwards until a word constituent is found and get that word;
2928 if you a newlines is reached first, move forward instead."
2929   (save-excursion
2930     (let ((oldpoint (point)) (start (point)) (end (point)))
2931       (skip-syntax-backward "w_") (setq start (point))
2932       (goto-char oldpoint)
2933       (skip-syntax-forward "w_") (setq end (point))
2934       (if (and (eq start oldpoint) (eq end oldpoint))
2935           ;; Point is neither within nor adjacent to a word.
2936           (and (not strict)
2937                (progn
2938                  ;; Look for preceding word in same line.
2939                  (skip-syntax-backward "^w_"
2940                                        (save-excursion
2941                                          (beginning-of-line) (point)))
2942                  (if (bolp)
2943                      ;; No preceding word in same line.
2944                      ;; Look for following word in same line.
2945                      (progn
2946                        (skip-syntax-forward "^w_"
2947                                             (save-excursion
2948                                               (end-of-line) (point)))
2949                        (setq start (point))
2950                        (skip-syntax-forward "w_")
2951                        (setq end (point)))
2952                      (setq end (point))
2953                      (skip-syntax-backward "w_")
2954                      (setq start (point)))
2955                  (buffer-substring start end)))
2956           (buffer-substring start end)))))
2957 \f
2958 (defcustom fill-prefix nil
2959   "*String for filling to insert at front of new line, or nil for none.
2960 Setting this variable automatically makes it local to the current buffer."
2961   :type '(choice (const :tag "None" nil)
2962                  string)
2963   :group 'fill)
2964 (make-variable-buffer-local 'fill-prefix)
2965
2966 (defcustom auto-fill-inhibit-regexp nil
2967   "*Regexp to match lines which should not be auto-filled."
2968   :type '(choice (const :tag "None" nil)
2969                  regexp)
2970   :group 'fill)
2971
2972 (defvar comment-line-break-function 'indent-new-comment-line
2973   "*Mode-specific function which line breaks and continues a comment.
2974
2975 This function is only called during auto-filling of a comment section.
2976 The function should take a single optional argument which is a flag
2977 indicating whether soft newlines should be inserted.")
2978
2979 ;; defined in mule-base/mule-category.el
2980 (defvar word-across-newline)
2981
2982 ;; This function is the auto-fill-function of a buffer
2983 ;; when Auto-Fill mode is enabled.
2984 ;; It returns t if it really did any work.
2985 ;; XEmacs:  This function is totally different.
2986 (defun do-auto-fill ()
2987   (let (give-up)
2988     (or (and auto-fill-inhibit-regexp
2989              (save-excursion (beginning-of-line)
2990                              (looking-at auto-fill-inhibit-regexp)))
2991         (while (and (not give-up) (> (current-column) fill-column))
2992           ;; Determine where to split the line.
2993           (let ((fill-prefix fill-prefix)
2994                 (fill-point
2995                  (let ((opoint (point))
2996                        bounce
2997                        ;; 97/3/14 jhod: Kinsoku
2998                        (re-break-point (if (featurep 'mule)
2999                                             (concat "[ \t\n]\\|" word-across-newline
3000                                                     ".\\|." word-across-newline)
3001                                         "[ \t\n]"))
3002                        ;; end patch
3003                        (first t))
3004                    (save-excursion
3005                      (move-to-column (1+ fill-column))
3006                      ;; Move back to a word boundary.
3007                      (while (or first
3008                                 ;; If this is after period and a single space,
3009                                 ;; move back once more--we don't want to break
3010                                 ;; the line there and make it look like a
3011                                 ;; sentence end.
3012                                 (and (not (bobp))
3013                                      (not bounce)
3014                                      sentence-end-double-space
3015                                      (save-excursion (backward-char 1)
3016                                                      (and (looking-at "\\. ")
3017                                                           (not (looking-at "\\.  "))))))
3018                        (setq first nil)
3019                        ;; 97/3/14 jhod: Kinsoku
3020                        ; (skip-chars-backward "^ \t\n"))
3021                        (fill-move-backward-to-break-point re-break-point)
3022                        ;; end patch
3023                        ;; If we find nowhere on the line to break it,
3024                        ;; break after one word.  Set bounce to t
3025                        ;; so we will not keep going in this while loop.
3026                        (if (bolp)
3027                            (progn
3028                              ;; 97/3/14 jhod: Kinsoku
3029                              ; (re-search-forward "[ \t]" opoint t)
3030                              (fill-move-forward-to-break-point re-break-point
3031                                                                opoint)
3032                              ;; end patch
3033                              (setq bounce t)))
3034                        (skip-chars-backward " \t"))
3035                      (if (and (featurep 'mule)
3036                               (or bounce (bolp))) (kinsoku-process)) ;; 97/3/14 jhod: Kinsoku
3037                      ;; Let fill-point be set to the place where we end up.
3038                      (point)))))
3039
3040             ;; I'm not sure why Stig made this change but it breaks
3041             ;; auto filling in at least C mode so I'm taking it back
3042             ;; out.  --cet
3043             ;; XEmacs - adaptive fill.
3044             ;;(maybe-adapt-fill-prefix
3045             ;; (or from (setq from (save-excursion (beginning-of-line)
3046             ;;                                   (point))))
3047             ;; (or to   (setq to (save-excursion (beginning-of-line 2)
3048             ;;                                 (point))))
3049             ;; t)
3050
3051             ;; If that place is not the beginning of the line,
3052             ;; break the line there.
3053             (if (save-excursion
3054                   (goto-char fill-point)
3055                   (not (or (bolp) (eolp)))) ; 97/3/14 jhod: during kinsoku processing it is possible to move beyond
3056                 (let ((prev-column (current-column)))
3057                   ;; If point is at the fill-point, do not `save-excursion'.
3058                   ;; Otherwise, if a comment prefix or fill-prefix is inserted,
3059                   ;; point will end up before it rather than after it.
3060                   (if (save-excursion
3061                         (skip-chars-backward " \t")
3062                         (= (point) fill-point))
3063                       ;; 1999-09-17 hniksic: turn off Kinsoku until
3064                       ;; it's debugged.
3065                       (funcall comment-line-break-function)
3066                       ;; 97/3/14 jhod: Kinsoku processing
3067 ;                     ;(indent-new-comment-line)
3068 ;                     (let ((spacep (memq (char-before (point)) '(?\  ?\t))))
3069 ;                       (funcall comment-line-break-function)
3070 ;                       ;; if user type space explicitly, leave SPC
3071 ;                       ;; even if there is no WAN.
3072 ;                       (if spacep
3073 ;                           (save-excursion
3074 ;                             (goto-char fill-point)
3075 ;                             ;; put SPC except that there is SPC
3076 ;                             ;; already or there is sentence end.
3077 ;                             (or (memq (char-after (point)) '(?\  ?\t))
3078 ;                                 (fill-end-of-sentence-p)
3079 ;                                 (insert ?\ )))))
3080                     (save-excursion
3081                       (goto-char fill-point)
3082                       (funcall comment-line-break-function)))
3083                   ;; If making the new line didn't reduce the hpos of
3084                   ;; the end of the line, then give up now;
3085                   ;; trying again will not help.
3086                   (if (>= (current-column) prev-column)
3087                       (setq give-up t)))
3088               ;; No place to break => stop trying.
3089               (setq give-up t)))))))
3090
3091 ;; Put FSF one in until I can one or the other working properly, then the
3092 ;; other one is history.
3093 ;(defun fsf:do-auto-fill ()
3094 ;  (let (fc justify
3095 ;          ;; bol
3096 ;          give-up
3097 ;          (fill-prefix fill-prefix))
3098 ;    (if (or (not (setq justify (current-justification)))
3099 ;           (null (setq fc (current-fill-column)))
3100 ;           (and (eq justify 'left)
3101 ;                (<= (current-column) fc))
3102 ;           (save-excursion (beginning-of-line)
3103 ;                           ;; (setq bol (point))
3104 ;                           (and auto-fill-inhibit-regexp
3105 ;                                (looking-at auto-fill-inhibit-regexp))))
3106 ;       nil ;; Auto-filling not required
3107 ;      (if (memq justify '(full center right))
3108 ;         (save-excursion (unjustify-current-line)))
3109
3110 ;      ;; Choose a fill-prefix automatically.
3111 ;      (if (and adaptive-fill-mode
3112 ;              (or (null fill-prefix) (string= fill-prefix "")))
3113 ;         (let ((prefix
3114 ;                (fill-context-prefix
3115 ;                 (save-excursion (backward-paragraph 1) (point))
3116 ;                 (save-excursion (forward-paragraph 1) (point))
3117 ;                 ;; Don't accept a non-whitespace fill prefix
3118 ;                 ;; from the first line of a paragraph.
3119 ;                 "^[ \t]*$")))
3120 ;           (and prefix (not (equal prefix ""))
3121 ;                (setq fill-prefix prefix))))
3122
3123 ;      (while (and (not give-up) (> (current-column) fc))
3124 ;       ;; Determine where to split the line.
3125 ;       (let ((fill-point
3126 ;              (let ((opoint (point))
3127 ;                    bounce
3128 ;                    (first t))
3129 ;                (save-excursion
3130 ;                  (move-to-column (1+ fc))
3131 ;                  ;; Move back to a word boundary.
3132 ;                  (while (or first
3133 ;                             ;; If this is after period and a single space,
3134 ;                             ;; move back once more--we don't want to break
3135 ;                             ;; the line there and make it look like a
3136 ;                             ;; sentence end.
3137 ;                             (and (not (bobp))
3138 ;                                  (not bounce)
3139 ;                                  sentence-end-double-space
3140 ;                                  (save-excursion (backward-char 1)
3141 ;                                                  (and (looking-at "\\. ")
3142 ;                                                       (not (looking-at "\\.  "))))))
3143 ;                    (setq first nil)
3144 ;                    (skip-chars-backward "^ \t\n")
3145 ;                    ;; If we find nowhere on the line to break it,
3146 ;                    ;; break after one word.  Set bounce to t
3147 ;                    ;; so we will not keep going in this while loop.
3148 ;                    (if (bolp)
3149 ;                        (progn
3150 ;                          (re-search-forward "[ \t]" opoint t)
3151 ;                          (setq bounce t)))
3152 ;                    (skip-chars-backward " \t"))
3153 ;                  ;; Let fill-point be set to the place where we end up.
3154 ;                  (point)))))
3155 ;         ;; If that place is not the beginning of the line,
3156 ;         ;; break the line there.
3157 ;         (if (save-excursion
3158 ;               (goto-char fill-point)
3159 ;               (not (bolp)))
3160 ;             (let ((prev-column (current-column)))
3161 ;               ;; If point is at the fill-point, do not `save-excursion'.
3162 ;               ;; Otherwise, if a comment prefix or fill-prefix is inserted,
3163 ;               ;; point will end up before it rather than after it.
3164 ;               (if (save-excursion
3165 ;                     (skip-chars-backward " \t")
3166 ;                     (= (point) fill-point))
3167 ;                   (funcall comment-line-break-function t)
3168 ;                 (save-excursion
3169 ;                   (goto-char fill-point)
3170 ;                   (funcall comment-line-break-function t)))
3171 ;               ;; Now do justification, if required
3172 ;               (if (not (eq justify 'left))
3173 ;                   (save-excursion
3174 ;                     (end-of-line 0)
3175 ;                     (justify-current-line justify nil t)))
3176 ;               ;; If making the new line didn't reduce the hpos of
3177 ;               ;; the end of the line, then give up now;
3178 ;               ;; trying again will not help.
3179 ;               (if (>= (current-column) prev-column)
3180 ;                   (setq give-up t)))
3181 ;           ;; No place to break => stop trying.
3182 ;           (setq give-up t))))
3183 ;      ;; Justify last line.
3184 ;      (justify-current-line justify t t)
3185 ;      t)))
3186
3187 (defvar normal-auto-fill-function 'do-auto-fill
3188   "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
3189 Some major modes set this.")
3190
3191 (defun auto-fill-mode (&optional arg)
3192   "Toggle auto-fill mode.
3193 With arg, turn auto-fill mode on if and only if arg is positive.
3194 In Auto-Fill mode, inserting a space at a column beyond `current-fill-column'
3195 automatically breaks the line at a previous space.
3196
3197 The value of `normal-auto-fill-function' specifies the function to use
3198 for `auto-fill-function' when turning Auto Fill mode on."
3199   (interactive "P")
3200   (prog1 (setq auto-fill-function
3201                (if (if (null arg)
3202                        (not auto-fill-function)
3203                        (> (prefix-numeric-value arg) 0))
3204                    normal-auto-fill-function
3205                    nil))
3206     (redraw-modeline)))
3207
3208 ;; This holds a document string used to document auto-fill-mode.
3209 (defun auto-fill-function ()
3210   "Automatically break line at a previous space, in insertion of text."
3211   nil)
3212
3213 (defun turn-on-auto-fill ()
3214   "Unconditionally turn on Auto Fill mode."
3215   (interactive)
3216   (auto-fill-mode 1))
3217
3218 (defun set-fill-column (arg)
3219   "Set `fill-column' to specified argument.
3220 Just \\[universal-argument] as argument means to use the current column
3221 The variable `fill-column' has a separate value for each buffer."
3222   (interactive "_P") ; XEmacs
3223   (cond ((integerp arg)
3224          (setq fill-column arg))
3225         ((consp arg)
3226          (setq fill-column (current-column)))
3227         ;; Disallow missing argument; it's probably a typo for C-x C-f.
3228         (t
3229          (error "set-fill-column requires an explicit argument")))
3230   (lmessage 'command "fill-column set to %d" fill-column))
3231 \f
3232 (defcustom comment-multi-line t ; XEmacs - this works well with adaptive fill
3233   "*Non-nil means \\[indent-new-comment-line] should continue same comment
3234 on new line, with no new terminator or starter.
3235 This is obsolete because you might as well use \\[newline-and-indent]."
3236   :type 'boolean
3237   :group 'fill-comments)
3238
3239 (defun indent-new-comment-line (&optional soft)
3240   "Break line at point and indent, continuing comment if within one.
3241 This indents the body of the continued comment
3242 under the previous comment line.
3243
3244 This command is intended for styles where you write a comment per line,
3245 starting a new comment (and terminating it if necessary) on each line.
3246 If you want to continue one comment across several lines, use \\[newline-and-indent].
3247
3248 If a fill column is specified, it overrides the use of the comment column
3249 or comment indentation.
3250
3251 The inserted newline is marked hard if `use-hard-newlines' is true,
3252 unless optional argument SOFT is non-nil."
3253   (interactive)
3254   (let (comcol comstart)
3255     (skip-chars-backward " \t")
3256     ;; 97/3/14 jhod: Kinsoku processing
3257     (if (featurep 'mule)
3258         (kinsoku-process))
3259     (delete-region (point)
3260                    (progn (skip-chars-forward " \t")
3261                           (point)))
3262     (if soft (insert ?\n) (newline 1))
3263     (if fill-prefix
3264         (progn
3265           (indent-to-left-margin)
3266           (insert fill-prefix))
3267     ;; #### - Eric Eide reverts to v18 semantics for this function in
3268     ;; fa-extras, which I'm not gonna do.  His changes are to (1) execute
3269     ;; the save-excursion below unconditionally, and (2) uncomment the check
3270     ;; for (not comment-multi-line) further below.  --Stig
3271       ;;#### jhod: probably need to fix this for kinsoku processing
3272       (if (not comment-multi-line)
3273           (save-excursion
3274             (if (and comment-start-skip
3275                      (let ((opoint (point)))
3276                        (forward-line -1)
3277                        (re-search-forward comment-start-skip opoint t)))
3278                 ;; The old line is a comment.
3279                 ;; Set WIN to the pos of the comment-start.
3280                 ;; But if the comment is empty, look at preceding lines
3281                 ;; to find one that has a nonempty comment.
3282
3283                 ;; If comment-start-skip contains a \(...\) pair,
3284                 ;; the real comment delimiter starts at the end of that pair.
3285                 (let ((win (or (match-end 1) (match-beginning 0))))
3286                   (while (and (eolp) (not (bobp))
3287                               (let (opoint)
3288                                 (beginning-of-line)
3289                                 (setq opoint (point))
3290                                 (forward-line -1)
3291                                 (re-search-forward comment-start-skip opoint t)))
3292                     (setq win (or (match-end 1) (match-beginning 0))))
3293                   ;; Indent this line like what we found.
3294                   (goto-char win)
3295                   (setq comcol (current-column))
3296                   (setq comstart
3297                         (buffer-substring (point) (match-end 0)))))))
3298       (if (and comcol (not fill-prefix))  ; XEmacs - (ENE) from fa-extras.
3299           (let ((comment-column comcol)
3300                 (comment-start comstart)
3301                 (block-comment-start comstart)
3302                 (comment-end comment-end))
3303             (and comment-end (not (equal comment-end ""))
3304   ;            (if (not comment-multi-line)
3305                      (progn
3306                        (backward-char 1)
3307                        (insert comment-end)
3308                        (forward-char 1))
3309   ;              (setq comment-column (+ comment-column (length comment-start))
3310   ;                    comment-start "")
3311   ;                )
3312                  )
3313             (if (not (eolp))
3314                 (setq comment-end ""))
3315             (insert ?\n)
3316             (backward-char 1)
3317             (indent-for-comment)
3318             (save-excursion
3319               ;; Make sure we delete the newline inserted above.
3320               (end-of-line)
3321               (delete-char 1)))
3322         (indent-according-to-mode)))))
3323
3324 \f
3325 (defun set-selective-display (arg)
3326   "Set `selective-display' to ARG; clear it if no arg.
3327 When the value of `selective-display' is a number > 0,
3328 lines whose indentation is >= that value are not displayed.
3329 The variable `selective-display' has a separate value for each buffer."
3330   (interactive "P")
3331   (if (eq selective-display t)
3332       (error "selective-display already in use for marked lines"))
3333   (let ((current-vpos
3334          (save-restriction
3335            (narrow-to-region (point-min) (point))
3336            (goto-char (window-start))
3337            (vertical-motion (window-height)))))
3338     (setq selective-display
3339           (and arg (prefix-numeric-value arg)))
3340     (recenter current-vpos))
3341   (set-window-start (selected-window) (window-start (selected-window)))
3342   ;; #### doesn't localize properly:
3343   (princ "selective-display set to " t)
3344   (prin1 selective-display t)
3345   (princ "." t))
3346
3347 ;; XEmacs
3348 (defun nuke-selective-display ()
3349   "Ensure that the buffer is not in selective-display mode.
3350 If `selective-display' is t, then restore the buffer text to its original
3351 state before disabling selective display."
3352   ;; by Stig@hackvan.com
3353   (interactive)
3354   (and (eq t selective-display)
3355        (save-excursion
3356          (save-restriction
3357            (widen)
3358            (goto-char (point-min))
3359            (let ((mod-p (buffer-modified-p))
3360                  (buffer-read-only nil))
3361              (while (search-forward "\r" nil t)
3362                (delete-char -1)
3363                (insert "\n"))
3364              (set-buffer-modified-p mod-p)
3365              ))))
3366   (setq selective-display nil))
3367
3368 (add-hook 'change-major-mode-hook 'nuke-selective-display)
3369
3370 (defconst overwrite-mode-textual " Ovwrt"
3371   "The string displayed in the mode line when in overwrite mode.")
3372 (defconst overwrite-mode-binary " Bin Ovwrt"
3373   "The string displayed in the mode line when in binary overwrite mode.")
3374
3375 (defun overwrite-mode (arg)
3376   "Toggle overwrite mode.
3377 With arg, enable overwrite mode if arg is positive, else disable.
3378 In overwrite mode, printing characters typed in replace existing text
3379 on a one-for-one basis, rather than pushing it to the right.  At the
3380 end of a line, such characters extend the line.  Before a tab,
3381 such characters insert until the tab is filled in.
3382 \\[quoted-insert] still inserts characters in overwrite mode; this
3383 is supposed to make it easier to insert characters when necessary."
3384   (interactive "P")
3385   (setq overwrite-mode
3386         (if (if (null arg) (not overwrite-mode)
3387               (> (prefix-numeric-value arg) 0))
3388             'overwrite-mode-textual))
3389   (redraw-modeline))
3390
3391 (defun binary-overwrite-mode (arg)
3392   "Toggle binary overwrite mode.
3393 With arg, enable binary overwrite mode if arg is positive, else disable.
3394 In binary overwrite mode, printing characters typed in replace
3395 existing text.  Newlines are not treated specially, so typing at the
3396 end of a line joins the line to the next, with the typed character
3397 between them.  Typing before a tab character simply replaces the tab
3398 with the character typed.
3399 \\[quoted-insert] replaces the text at the cursor, just as ordinary
3400 typing characters do.
3401
3402 Note that binary overwrite mode is not its own minor mode; it is a
3403 specialization of overwrite-mode, entered by setting the
3404 `overwrite-mode' variable to `overwrite-mode-binary'."
3405   (interactive "P")
3406   (setq overwrite-mode
3407         (if (if (null arg)
3408                 (not (eq overwrite-mode 'overwrite-mode-binary))
3409               (> (prefix-numeric-value arg) 0))
3410             'overwrite-mode-binary))
3411   (redraw-modeline))
3412 \f
3413 (defcustom line-number-mode nil
3414   "*Non-nil means display line number in modeline."
3415   :type 'boolean
3416   :group 'editing-basics)
3417
3418 (defun line-number-mode (arg)
3419   "Toggle Line Number mode.
3420 With arg, enable Line Number mode if arg is positive, else disable.
3421 When Line Number mode is enabled, the line number appears
3422 in the mode line."
3423   (interactive "P")
3424   (setq line-number-mode
3425         (if (null arg) (not line-number-mode)
3426           (> (prefix-numeric-value arg) 0)))
3427   (redraw-modeline))
3428
3429 (defcustom column-number-mode nil
3430   "*Non-nil means display column number in mode line."
3431   :type 'boolean
3432   :group 'editing-basics)
3433
3434 (defun column-number-mode (arg)
3435   "Toggle Column Number mode.
3436 With arg, enable Column Number mode if arg is positive, else disable.
3437 When Column Number mode is enabled, the column number appears
3438 in the mode line."
3439   (interactive "P")
3440   (setq column-number-mode
3441         (if (null arg) (not column-number-mode)
3442           (> (prefix-numeric-value arg) 0)))
3443   (redraw-modeline))
3444
3445 \f
3446 (defcustom blink-matching-paren t
3447   "*Non-nil means show matching open-paren when close-paren is inserted."
3448   :type 'boolean
3449   :group 'paren-blinking)
3450
3451 (defcustom blink-matching-paren-on-screen t
3452   "*Non-nil means show matching open-paren when it is on screen.
3453 nil means don't show it (but the open-paren can still be shown
3454 when it is off screen."
3455   :type 'boolean
3456   :group 'paren-blinking)
3457
3458 (defcustom blink-matching-paren-distance 12000
3459   "*If non-nil, is maximum distance to search for matching open-paren."
3460   :type '(choice integer (const nil))
3461   :group 'paren-blinking)
3462
3463 (defcustom blink-matching-delay 1
3464   "*The number of seconds that `blink-matching-open' will delay at a match."
3465   :type 'number
3466   :group 'paren-blinking)
3467
3468 (defcustom blink-matching-paren-dont-ignore-comments nil
3469   "*Non-nil means `blink-matching-paren' should not ignore comments."
3470   :type 'boolean
3471   :group 'paren-blinking)
3472
3473 (defun blink-matching-open ()
3474   "Move cursor momentarily to the beginning of the sexp before point."
3475   (interactive "_") ; XEmacs
3476   (and (> (point) (1+ (point-min)))
3477        blink-matching-paren
3478        ;; Verify an even number of quoting characters precede the close.
3479        (= 1 (logand 1 (- (point)
3480                          (save-excursion
3481                            (backward-char 1)
3482                            (skip-syntax-backward "/\\")
3483                            (point)))))
3484        (let* ((oldpos (point))
3485               (blinkpos)
3486               (mismatch))
3487          (save-excursion
3488            (save-restriction
3489              (if blink-matching-paren-distance
3490                  (narrow-to-region (max (point-min)
3491                                         (- (point) blink-matching-paren-distance))
3492                                    oldpos))
3493              (condition-case ()
3494                  (let ((parse-sexp-ignore-comments
3495                         (and parse-sexp-ignore-comments
3496                              (not blink-matching-paren-dont-ignore-comments))))
3497                    (setq blinkpos (scan-sexps oldpos -1)))
3498                (error nil)))
3499            (and blinkpos
3500                 (/= (char-syntax (char-after blinkpos))
3501                     ?\$)
3502                 (setq mismatch
3503                       (or (null (matching-paren (char-after blinkpos)))
3504                           (/= (char-after (1- oldpos))
3505                               (matching-paren (char-after blinkpos))))))
3506            (if mismatch (setq blinkpos nil))
3507            (if blinkpos
3508                (progn
3509                 (goto-char blinkpos)
3510                 (if (pos-visible-in-window-p)
3511                     (and blink-matching-paren-on-screen
3512                          (progn
3513                            (auto-show-make-point-visible)
3514                            (sit-for blink-matching-delay)))
3515                   (goto-char blinkpos)
3516                   (lmessage 'command "Matches %s"
3517                     ;; Show what precedes the open in its line, if anything.
3518                     (if (save-excursion
3519                           (skip-chars-backward " \t")
3520                           (not (bolp)))
3521                         (buffer-substring (progn (beginning-of-line) (point))
3522                                           (1+ blinkpos))
3523                       ;; Show what follows the open in its line, if anything.
3524                       (if (save-excursion
3525                             (forward-char 1)
3526                             (skip-chars-forward " \t")
3527                             (not (eolp)))
3528                           (buffer-substring blinkpos
3529                                             (progn (end-of-line) (point)))
3530                         ;; Otherwise show the previous nonblank line,
3531                         ;; if there is one.
3532                         (if (save-excursion
3533                               (skip-chars-backward "\n \t")
3534                               (not (bobp)))
3535                             (concat
3536                              (buffer-substring (progn
3537                                                  (skip-chars-backward "\n \t")
3538                                                  (beginning-of-line)
3539                                                  (point))
3540                                                (progn (end-of-line)
3541                                                       (skip-chars-backward " \t")
3542                                                       (point)))
3543                              ;; Replace the newline and other whitespace with `...'.
3544                              "..."
3545                              (buffer-substring blinkpos (1+ blinkpos)))
3546                           ;; There is nothing to show except the char itself.
3547                           (buffer-substring blinkpos (1+ blinkpos))))))))
3548              (cond (mismatch
3549                     (display-message 'no-log "Mismatched parentheses"))
3550                    ((not blink-matching-paren-distance)
3551                     (display-message 'no-log "Unmatched parenthesis"))))))))
3552
3553 ;Turned off because it makes dbx bomb out.
3554 (setq blink-paren-function 'blink-matching-open)
3555 \f
3556
3557 ;; XEmacs: Some functions moved to cmdloop.el:
3558 ;; keyboard-quit
3559 ;; buffer-quit-function
3560 ;; keyboard-escape-quit
3561
3562 (defun assoc-ignore-case (key alist)
3563   "Like `assoc', but assumes KEY is a string and ignores case when comparing."
3564   (setq key (downcase key))
3565   (let (element)
3566     (while (and alist (not element))
3567       (if (equal key (downcase (car (car alist))))
3568           (setq element (car alist)))
3569       (setq alist (cdr alist)))
3570     element))
3571
3572 \f
3573 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3574 ;;                          mail composition code                        ;;
3575 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3576
3577 (defcustom mail-user-agent 'sendmail-user-agent
3578   "*Your preference for a mail composition package.
3579 Various Emacs Lisp packages (e.g. reporter) require you to compose an
3580 outgoing email message.  This variable lets you specify which
3581 mail-sending package you prefer.
3582
3583 Valid values include:
3584
3585     sendmail-user-agent -- use the default Emacs Mail package
3586     mh-e-user-agent     -- use the Emacs interface to the MH mail system
3587     message-user-agent  -- use the GNUS mail sending package
3588
3589 Additional valid symbols may be available; check with the author of
3590 your package for details."
3591   :type '(radio (function-item :tag "Default Emacs mail"
3592                                :format "%t\n"
3593                                sendmail-user-agent)
3594                 (function-item :tag "Gnus mail sending package"
3595                                :format "%t\n"
3596                                message-user-agent)
3597                 (function :tag "Other"))
3598   :group 'mail)
3599
3600 (defun define-mail-user-agent (symbol composefunc sendfunc
3601                                       &optional abortfunc hookvar)
3602   "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3603
3604 SYMBOL can be any Lisp symbol.  Its function definition and/or
3605 value as a variable do not matter for this usage; we use only certain
3606 properties on its property list, to encode the rest of the arguments.
3607
3608 COMPOSEFUNC is program callable function that composes an outgoing
3609 mail message buffer.  This function should set up the basics of the
3610 buffer without requiring user interaction.  It should populate the
3611 standard mail headers, leaving the `to:' and `subject:' headers blank
3612 by default.
3613
3614 COMPOSEFUNC should accept several optional arguments--the same
3615 arguments that `compose-mail' takes.  See that function's documentation.
3616
3617 SENDFUNC is the command a user would run to send the message.
3618
3619 Optional ABORTFUNC is the command a user would run to abort the
3620 message.  For mail packages that don't have a separate abort function,
3621 this can be `kill-buffer' (the equivalent of omitting this argument).
3622
3623 Optional HOOKVAR is a hook variable that gets run before the message
3624 is actually sent.  Callers that use the `mail-user-agent' may
3625 install a hook function temporarily on this hook variable.
3626 If HOOKVAR is nil, `mail-send-hook' is used.
3627
3628 The properties used on SYMBOL are `composefunc', `sendfunc',
3629 `abortfunc', and `hookvar'."
3630   (put symbol 'composefunc composefunc)
3631   (put symbol 'sendfunc sendfunc)
3632   (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3633   (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3634
3635 (define-mail-user-agent 'sendmail-user-agent
3636   'sendmail-user-agent-compose 'mail-send-and-exit)
3637
3638 (define-mail-user-agent 'message-user-agent
3639   'message-mail 'message-send-and-exit
3640   'message-kill-buffer 'message-send-hook)
3641
3642 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
3643                                               switch-function yank-action
3644                                               send-actions)
3645   (if switch-function
3646       (let ((special-display-buffer-names nil)
3647             (special-display-regexps nil)
3648             (same-window-buffer-names nil)
3649             (same-window-regexps nil))
3650         (funcall switch-function "*mail*")))
3651   (let ((cc (cdr (assoc-ignore-case "cc" other-headers)))
3652         (in-reply-to (cdr (assoc-ignore-case "in-reply-to" other-headers))))
3653     (or (mail continue to subject in-reply-to cc yank-action send-actions)
3654         continue
3655         (error "Message aborted"))
3656     (save-excursion
3657       (goto-char (point-min))
3658       (search-forward mail-header-separator)
3659       (beginning-of-line)
3660       (while other-headers
3661         (if (not (member (car (car other-headers)) '("in-reply-to" "cc")))
3662             (insert (car (car other-headers)) ": "
3663                     (cdr (car other-headers)) "\n"))
3664         (setq other-headers (cdr other-headers)))
3665       t)))
3666
3667 (define-mail-user-agent 'mh-e-user-agent
3668   'mh-user-agent-compose 'mh-send-letter 'mh-fully-kill-draft
3669   'mh-before-send-letter-hook)
3670
3671 (defun compose-mail (&optional to subject other-headers continue
3672                                switch-function yank-action send-actions)
3673   "Start composing a mail message to send.
3674 This uses the user's chosen mail composition package
3675 as selected with the variable `mail-user-agent'.
3676 The optional arguments TO and SUBJECT specify recipients
3677 and the initial Subject field, respectively.
3678
3679 OTHER-HEADERS is an alist specifying additional
3680 header fields.  Elements look like (HEADER . VALUE) where both
3681 HEADER and VALUE are strings.
3682
3683 CONTINUE, if non-nil, says to continue editing a message already
3684 being composed.
3685
3686 SWITCH-FUNCTION, if non-nil, is a function to use to
3687 switch to and display the buffer used for mail composition.
3688
3689 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
3690 to insert the raw text of the message being replied to.
3691 It has the form (FUNCTION . ARGS).  The user agent will apply
3692 FUNCTION to ARGS, to insert the raw text of the original message.
3693 \(The user agent will also run `mail-citation-hook', *after* the
3694 original text has been inserted in this way.)
3695
3696 SEND-ACTIONS is a list of actions to call when the message is sent.
3697 Each action has the form (FUNCTION . ARGS)."
3698   (interactive
3699    (list nil nil nil current-prefix-arg))
3700   (let ((function (get mail-user-agent 'composefunc)))
3701     (funcall function to subject other-headers continue
3702              switch-function yank-action send-actions)))
3703
3704 (defun compose-mail-other-window (&optional to subject other-headers continue
3705                                             yank-action send-actions)
3706   "Like \\[compose-mail], but edit the outgoing message in another window."
3707   (interactive
3708    (list nil nil nil current-prefix-arg))
3709   (compose-mail to subject other-headers continue
3710                 'switch-to-buffer-other-window yank-action send-actions))
3711
3712
3713 (defun compose-mail-other-frame (&optional to subject other-headers continue
3714                                             yank-action send-actions)
3715   "Like \\[compose-mail], but edit the outgoing message in another frame."
3716   (interactive
3717    (list nil nil nil current-prefix-arg))
3718   (compose-mail to subject other-headers continue
3719                 'switch-to-buffer-other-frame yank-action send-actions))
3720
3721 \f
3722 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3723 ;;                             set variable                              ;;
3724 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3725
3726 (defun set-variable (var val)
3727   "Set VARIABLE to VALUE.  VALUE is a Lisp object.
3728 When using this interactively, supply a Lisp expression for VALUE.
3729 If you want VALUE to be a string, you must surround it with doublequotes.
3730 If VARIABLE is a specifier, VALUE is added to it as an instantiator in
3731 the 'global locale with nil tag set (see `set-specifier').
3732
3733 If VARIABLE has a `variable-interactive' property, that is used as if
3734 it were the arg to `interactive' (which see) to interactively read the value."
3735   (interactive
3736    (let* ((var (read-variable "Set variable: "))
3737           ;; #### - yucky code replication here.  This should use something
3738           ;; from help.el or hyper-apropos.el
3739           (myhelp
3740            #'(lambda ()
3741               (with-output-to-temp-buffer "*Help*"
3742                 (prin1 var)
3743                 (princ "\nDocumentation:\n")
3744                 (princ (substring (documentation-property var 'variable-documentation)
3745                                   1))
3746                 (if (boundp var)
3747                     (let ((print-length 20))
3748                       (princ "\n\nCurrent value: ")
3749                       (prin1 (symbol-value var))))
3750                 (save-excursion
3751                   (set-buffer standard-output)
3752                   (help-mode))
3753                 nil)))
3754           (minibuffer-help-form
3755            '(funcall myhelp)))
3756      (list var
3757            (let ((prop (get var 'variable-interactive)))
3758              (if prop
3759                  ;; Use VAR's `variable-interactive' property
3760                  ;; as an interactive spec for prompting.
3761                  (call-interactively (list 'lambda '(arg)
3762                                            (list 'interactive prop)
3763                                            'arg))
3764                (eval-minibuffer (format "Set %s to value: " var)))))))
3765   (if (and (boundp var) (specifierp (symbol-value var)))
3766       (set-specifier (symbol-value var) val)
3767     (set var val)))
3768
3769 \f
3770 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3771 ;;                           case changing code                          ;;
3772 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3773
3774 ;; A bunch of stuff was moved elsewhere:
3775 ;; completion-list-mode-map
3776 ;; completion-reference-buffer
3777 ;; completion-base-size
3778 ;; delete-completion-window
3779 ;; previous-completion
3780 ;; next-completion
3781 ;; choose-completion
3782 ;; choose-completion-delete-max-match
3783 ;; choose-completion-string
3784 ;; completion-list-mode
3785 ;; completion-fixup-function
3786 ;; completion-setup-function
3787 ;; switch-to-completions
3788 ;; event stuffs
3789 ;; keypad stuffs
3790
3791 ;; The rest of this file is not in Lisp in FSF
3792 (defun capitalize-region-or-word (arg)
3793   "Capitalize the selected region or the following word (or ARG words)."
3794   (interactive "p")
3795   (if (region-active-p)
3796       (capitalize-region (region-beginning) (region-end))
3797     (capitalize-word arg)))
3798
3799 (defun upcase-region-or-word (arg)
3800   "Upcase the selected region or the following word (or ARG words)."
3801   (interactive "p")
3802   (if (region-active-p)
3803       (upcase-region (region-beginning) (region-end))
3804     (upcase-word arg)))
3805
3806 (defun downcase-region-or-word (arg)
3807   "Downcase the selected region or the following word (or ARG words)."
3808   (interactive "p")
3809   (if (region-active-p)
3810       (downcase-region (region-beginning) (region-end))
3811     (downcase-word arg)))
3812
3813 ;; #### not localized
3814 (defvar uncapitalized-title-words
3815   '("the" "a" "an" "in" "of" "for" "to" "and" "but" "at" "on" "as" "by"))
3816
3817 (defvar uncapitalized-title-word-regexp
3818   (concat "[ \t]*\\(" (mapconcat #'identity uncapitalized-title-words "\\|")
3819           "\\)\\>"))
3820
3821 (defun capitalize-string-as-title (string)
3822   "Capitalize the words in the string, except for small words (as in titles).
3823 The words not capitalized are specified in `uncapitalized-title-words'."
3824   (let ((buffer (get-buffer-create " *capitalize-string-as-title*")))
3825     (unwind-protect
3826         (progn
3827           (insert-string string buffer)
3828           (capitalize-region-as-title 1 (point-max buffer) buffer)
3829           (buffer-string buffer))
3830       (kill-buffer buffer))))
3831
3832 (defun capitalize-region-as-title (b e &optional buffer)
3833   "Capitalize the words in the region, except for small words (as in titles).
3834 The words not capitalized are specified in `uncapitalized-title-words'."
3835   (interactive "r")
3836   (save-excursion
3837     (and buffer
3838          (set-buffer buffer))
3839     (save-restriction
3840       (narrow-to-region b e)
3841       (goto-char (point-min))
3842       (let ((first t))
3843         (while (< (point) (point-max))
3844           (if (or first
3845                   (not (looking-at uncapitalized-title-word-regexp)))
3846               (capitalize-word 1)
3847             (forward-word 1))
3848           (setq first nil))))))
3849
3850 \f
3851 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3852 ;;                          zmacs active region code                     ;;
3853 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3854
3855 ;; Most of the zmacs code is now in elisp.  The only thing left in C
3856 ;; are the variables zmacs-regions, zmacs-region-active-p and
3857 ;; zmacs-region-stays plus the function zmacs_update_region which
3858 ;; simply calls the lisp level zmacs-update-region.  It must remain
3859 ;; for convenience, since it is called by core C code.
3860
3861 ;; XEmacs
3862 (defun activate-region ()
3863   "Activate the region, if `zmacs-regions' is true.
3864 Setting `zmacs-regions' to true causes LISPM-style active regions to be used.
3865 This function has no effect if `zmacs-regions' is false."
3866   (interactive)
3867   (and zmacs-regions (zmacs-activate-region)))
3868
3869 ;; XEmacs
3870 (defsubst region-exists-p ()
3871   "Return t if the region exists.
3872 If active regions are in use (i.e. `zmacs-regions' is true), this means that
3873  the region is active.  Otherwise, this means that the user has pushed
3874  a mark in this buffer at some point in the past.
3875 The functions `region-beginning' and `region-end' can be used to find the
3876  limits of the region.
3877
3878 You should use this, *NOT* `region-active-p', in a menu item
3879 specification that you want grayed out when the region is not active:
3880
3881   [ ... ... :active (region-exists-p)]
3882
3883 This correctly caters to the user's setting of `zmacs-regions'."
3884   (not (null (mark))))
3885
3886 ;; XEmacs
3887 (defun region-active-p ()
3888   "Return non-nil if the region is active.
3889 If `zmacs-regions' is true, this is equivalent to `region-exists-p'.
3890 Otherwise, this function always returns false.
3891
3892 You should generally *NOT* use this in a menu item specification that you
3893 want grayed out when the region is not active.  Instead, use this:
3894
3895   [ ... ... :active (region-exists-p)]
3896
3897 Which correctly caters to the user's setting of `zmacs-regions'."
3898   (and zmacs-regions zmacs-region-extent))
3899
3900 (defvar zmacs-activate-region-hook nil
3901   "Function or functions called when the region becomes active;
3902 see the variable `zmacs-regions'.")
3903
3904 (defvar zmacs-deactivate-region-hook nil
3905   "Function or functions called when the region becomes inactive;
3906 see the variable `zmacs-regions'.")
3907
3908 (defvar zmacs-update-region-hook nil
3909   "Function or functions called when the active region changes.
3910 This is called after each command that sets `zmacs-region-stays' to t.
3911 See the variable `zmacs-regions'.")
3912
3913 (defvar zmacs-region-extent nil
3914   "The extent of the zmacs region; don't use this.")
3915
3916 (defvar zmacs-region-rectangular-p nil
3917   "Whether the zmacs region is a rectangle; don't use this.")
3918
3919 (defun zmacs-make-extent-for-region (region)
3920   ;; Given a region, this makes an extent in the buffer which holds that
3921   ;; region, for highlighting purposes.  If the region isn't associated
3922   ;; with a buffer, this does nothing.
3923   (let ((buffer nil)
3924         (valid (and (extentp zmacs-region-extent)
3925                     (extent-object zmacs-region-extent)
3926                     (buffer-live-p (extent-object zmacs-region-extent))))
3927         start end)
3928     (cond ((consp region)
3929            (setq start (min (car region) (cdr region))
3930                  end (max (car region) (cdr region))
3931                  valid (and valid
3932                             (eq (marker-buffer (car region))
3933                                 (extent-object zmacs-region-extent)))
3934                  buffer (marker-buffer (car region))))
3935           (t
3936            (signal 'error (list "Invalid region" region))))
3937
3938     (if valid
3939         nil
3940       ;; The condition case is in case any of the extents are dead or
3941       ;; otherwise incapacitated.
3942       (condition-case ()
3943           (if (listp zmacs-region-extent)
3944               (mapc 'delete-extent zmacs-region-extent)
3945             (delete-extent zmacs-region-extent))
3946         (error nil)))
3947
3948     (if valid
3949         (set-extent-endpoints zmacs-region-extent start end)
3950       (setq zmacs-region-extent (make-extent start end buffer))
3951
3952       ;; Make the extent be closed on the right, which means that if
3953       ;; characters are inserted exactly at the end of the extent, the
3954       ;; extent will grow to cover them.  This is important for shell
3955       ;; buffers - suppose one makes a region, and one end is at point-max.
3956       ;; If the shell produces output, that marker will remain at point-max
3957       ;; (its position will increase).  So it's important that the extent
3958       ;; exhibit the same behavior, lest the region covered by the extent
3959       ;; (the visual indication), and the region between point and mark
3960       ;; (the actual region value) become different!
3961       (set-extent-property zmacs-region-extent 'end-open nil)
3962
3963       ;; use same priority as mouse-highlighting so that conflicts between
3964       ;; the region extent and a mouse-highlighted extent are resolved by
3965       ;; the usual size-and-endpoint-comparison method.
3966       (set-extent-priority zmacs-region-extent mouse-highlight-priority)
3967       (set-extent-face zmacs-region-extent 'zmacs-region)
3968
3969       ;; #### It might be better to actually break
3970       ;; default-mouse-track-next-move-rect out of mouse.el so that we
3971       ;; can use its logic here.
3972       (cond
3973        (zmacs-region-rectangular-p
3974         (setq zmacs-region-extent (list zmacs-region-extent))
3975         (default-mouse-track-next-move-rect start end zmacs-region-extent)
3976         ))
3977
3978       zmacs-region-extent)))
3979
3980 (defun zmacs-region-buffer ()
3981   "Return the buffer containing the zmacs region, or nil."
3982   ;; #### this is horrible and kludgy!  This stuff needs to be rethought.
3983   (and zmacs-regions zmacs-region-active-p
3984        (or (marker-buffer (mark-marker t))
3985            (and (extent-live-p zmacs-region-extent)
3986                 (buffer-live-p (extent-object zmacs-region-extent))
3987                 (extent-object zmacs-region-extent)))))
3988
3989 (defun zmacs-activate-region ()
3990   "Make the region between `point' and `mark' be active (highlighted),
3991 if `zmacs-regions' is true.  Only a very small number of commands
3992 should ever do this.  Calling this function will call the hook
3993 `zmacs-activate-region-hook', if the region was previously inactive.
3994 Calling this function ensures that the region stays active after the
3995 current command terminates, even if `zmacs-region-stays' is not set.
3996 Returns t if the region was activated (i.e. if `zmacs-regions' if t)."
3997   (if (not zmacs-regions)
3998       nil
3999     (setq zmacs-region-active-p t
4000           zmacs-region-stays t
4001           zmacs-region-rectangular-p (and (boundp 'mouse-track-rectangle-p)
4002                                           mouse-track-rectangle-p))
4003     (if (marker-buffer (mark-marker t))
4004         (zmacs-make-extent-for-region (cons (point-marker t) (mark-marker t))))
4005     (run-hooks 'zmacs-activate-region-hook)
4006     t))
4007
4008 (defun zmacs-deactivate-region ()
4009   "Make the region between `point' and `mark' no longer be active,
4010 if `zmacs-regions' is true.  You shouldn't need to call this; the
4011 command loop calls it when appropriate.  Calling this function will
4012 call the hook `zmacs-deactivate-region-hook', if the region was
4013 previously active.  Returns t if the region had been active, nil
4014 otherwise."
4015   (if (not zmacs-region-active-p)
4016       nil
4017     (setq zmacs-region-active-p nil
4018           zmacs-region-stays nil
4019           zmacs-region-rectangular-p nil)
4020     (if zmacs-region-extent
4021         (let ((inhibit-quit t))
4022           (if (listp zmacs-region-extent)
4023               (mapc 'delete-extent zmacs-region-extent)
4024             (delete-extent zmacs-region-extent))
4025           (setq zmacs-region-extent nil)))
4026     (run-hooks 'zmacs-deactivate-region-hook)
4027     t))
4028
4029 (defun zmacs-update-region ()
4030   "Update the highlighted region between `point' and `mark'.
4031 You shouldn't need to call this; the command loop calls it
4032 when appropriate.  Calling this function will call the hook
4033 `zmacs-update-region-hook', if the region is active."
4034   (when zmacs-region-active-p
4035     (when (marker-buffer (mark-marker t))
4036       (zmacs-make-extent-for-region (cons (point-marker t)
4037                                           (mark-marker t))))
4038     (run-hooks 'zmacs-update-region-hook)))
4039
4040 \f
4041 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4042 ;;                           message logging code                        ;;
4043 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4044
4045 ;;; #### Should this be moved to a separate file, for clarity?
4046 ;;; -hniksic
4047
4048 ;;; The `message-stack' is an alist of labels with messages; the first
4049 ;;; message in this list is always in the echo area.  A call to
4050 ;;; `display-message' inserts a label/message pair at the head of the
4051 ;;; list, and removes any other pairs with that label.  Calling
4052 ;;; `clear-message' causes any pair with matching label to be removed,
4053 ;;; and this may cause the displayed message to change or vanish.  If
4054 ;;; the label arg is nil, the entire message stack is cleared.
4055 ;;;
4056 ;;; Message/error filtering will be a little tricker to implement than
4057 ;;; logging, since messages can be built up incrementally
4058 ;;; using clear-message followed by repeated calls to append-message
4059 ;;; (this happens with error messages).  For messages which aren't
4060 ;;; created this way, filtering could be implemented at display-message
4061 ;;; very easily.
4062 ;;;
4063 ;;; Bits of the logging code are borrowed from log-messages.el by
4064 ;;; Robert Potter (rpotter@grip.cis.upenn.edu).
4065
4066 ;; need this to terminate the currently-displayed message
4067 ;; ("Loading simple ...")
4068 (when (and
4069        (not (fboundp 'display-message))
4070        (not (featurep 'debug)))
4071   (send-string-to-terminal "\n"))
4072
4073 (defvar message-stack nil
4074   "An alist of label/string pairs representing active echo-area messages.
4075 The first element in the list is currently displayed in the echo area.
4076 Do not modify this directly--use the `message' or
4077 `display-message'/`clear-message' functions.")
4078
4079 (defvar remove-message-hook 'log-message
4080   "A function or list of functions to be called when a message is removed
4081 from the echo area at the bottom of the frame.  The label of the removed
4082 message is passed as the first argument, and the text of the message
4083 as the second argument.")
4084
4085 (defcustom log-message-max-size 50000
4086   "Maximum size of the \" *Message-Log*\" buffer.  See `log-message'."
4087   :type 'integer
4088   :group 'log-message)
4089 (make-compatible-variable 'message-log-max 'log-message-max-size)
4090
4091 ;; We used to reject quite a lot of stuff here, but it was a bad idea,
4092 ;; for two reasons:
4093 ;;
4094 ;; a) In most circumstances, you *want* to see the message in the log.
4095 ;;    The explicitly non-loggable messages should be marked as such by
4096 ;;    the issuer.  Gratuitous non-displaying of random regexps made
4097 ;;    debugging harder, too (because various reasonable debugging
4098 ;;    messages would get eaten).
4099 ;;
4100 ;; b) It slowed things down.  Yes, visibly.
4101 ;;
4102 ;; So, I left only a few of the really useless ones on this kill-list.
4103 ;;
4104 ;;                                            --hniksic
4105 (defcustom log-message-ignore-regexps
4106   '(;; Note: adding entries to this list slows down messaging
4107     ;; significantly.  Wherever possible, use message labels.
4108
4109     ;; Often-seen messages
4110     "\\`\\'"                            ; empty message
4111     "\\`\\(Beginning\\|End\\) of buffer\\'"
4112     ;;"^Quit$"
4113     ;; completions
4114     ;; Many packages print this -- impossible to categorize
4115     ;;"^Making completion list"
4116     ;; Gnus
4117     ;; "^No news is no news$"
4118     ;; "^No more\\( unread\\)? newsgroups$"
4119     ;; "^Opening [^ ]+ server\\.\\.\\."
4120     ;; "^[^:]+: Reading incoming mail"
4121     ;; "^Getting mail from "
4122     ;; "^\\(Generating Summary\\|Sorting threads\\|Making sparse threads\\|Scoring\\|Checking new news\\|Expiring articles\\|Sending\\)\\.\\.\\."
4123     ;; "^\\(Fetching headers for\\|Retrieving newsgroup\\|Reading active file\\)"
4124     ;; "^No more\\( unread\\)? articles"
4125     ;; "^Deleting article "
4126     ;; W3
4127     ;; "^Parsed [0-9]+ of [0-9]+ ([0-9]+%)"
4128     )
4129   "List of regular expressions matching messages which shouldn't be logged.
4130 See `log-message'.
4131
4132 Ideally, packages which generate messages which might need to be ignored
4133 should label them with 'progress, 'prompt, or 'no-log, so they can be
4134 filtered by the log-message-ignore-labels."
4135   :type '(repeat regexp)
4136   :group 'log-message)
4137
4138 (defcustom log-message-ignore-labels
4139   '(help-echo command progress prompt no-log garbage-collecting auto-saving)
4140   "List of symbols indicating labels of messages which shouldn't be logged.
4141 See `display-message' for some common labels.  See also `log-message'."
4142   :type '(repeat (symbol :tag "Label"))
4143   :group 'log-message)
4144
4145 ;;Subsumed by view-lossage
4146 ;; Not really, I'm adding it back by popular demand. -slb
4147 (defun show-message-log ()
4148   "Show the \" *Message-Log*\" buffer, which contains old messages and errors."
4149   (interactive)
4150   (pop-to-buffer (get-buffer-create " *Message-Log*")))
4151
4152 (defvar log-message-filter-function 'log-message-filter
4153   "Value must be a function of two arguments: a symbol (label) and
4154 a string (message).  It should return non-nil to indicate a message
4155 should be logged.  Possible values include 'log-message-filter and
4156 'log-message-filter-errors-only.")
4157
4158 (defun log-message-filter (label message)
4159   "Default value of `log-message-filter-function'.
4160 Messages whose text matches one of the `log-message-ignore-regexps'
4161 or whose label appears in `log-message-ignore-labels' are not saved."
4162   (let ((r  log-message-ignore-regexps)
4163         (ok (not (memq label log-message-ignore-labels))))
4164     (save-match-data
4165       (while (and r ok)
4166         (when (string-match (car r) message)
4167           (setq ok nil))
4168         (setq r (cdr r))))
4169     ok))
4170
4171 (defun log-message-filter-errors-only (label message)
4172   "For use as the `log-message-filter-function'.  Only logs error messages."
4173   (eq label 'error))
4174
4175 (defun log-message (label message)
4176   "Stuff a copy of the message into the \" *Message-Log*\" buffer,
4177 if it satisfies the `log-message-filter-function'.
4178
4179 For use on `remove-message-hook'."
4180   (when (and (not noninteractive)
4181              (funcall log-message-filter-function label message))
4182     ;; Use save-excursion rather than save-current-buffer because we
4183     ;; change the value of point.
4184     (save-excursion
4185       (set-buffer (get-buffer-create " *Message-Log*"))
4186       (goto-char (point-max))
4187       ;(insert (concat (upcase (symbol-name label)) ": "  message "\n"))
4188       (let (extent)
4189         ;; Mark multiline message with an extent, which `view-lossage'
4190         ;; will recognize.
4191         (when (string-match "\n" message)
4192           (setq extent (make-extent (point) (point)))
4193           (set-extent-properties extent '(end-open nil message-multiline t)))
4194         (insert message "\n")
4195         (when extent
4196           (set-extent-property extent 'end-open t)))
4197       (when (> (point-max) (max log-message-max-size (point-min)))
4198         ;; Trim log to ~90% of max size.
4199         (goto-char (max (- (point-max)
4200                            (truncate (* 0.9 log-message-max-size)))
4201                         (point-min)))
4202         (forward-line 1)
4203         (delete-region (point-min) (point))))))
4204
4205 (defun message-displayed-p (&optional return-string frame)
4206   "Return a non-nil value if a message is presently displayed in the\n\
4207 minibuffer's echo area.  If optional argument RETURN-STRING is non-nil,\n\
4208 return a string containing the message, otherwise just return t."
4209   ;; by definition, a message is displayed if the echo area buffer is
4210   ;; non-empty (see also echo_area_active()).  It had better also
4211   ;; be the case that message-stack is nil exactly when the echo area
4212   ;; is non-empty.
4213   (let ((buffer (get-buffer " *Echo Area*")))
4214     (and (< (point-min buffer) (point-max buffer))
4215          (if return-string
4216              (buffer-substring nil nil buffer)
4217            t))))
4218
4219 ;;; Returns the string which remains in the echo area, or nil if none.
4220 ;;; If label is nil, the whole message stack is cleared.
4221 (defun clear-message (&optional label frame stdout-p no-restore)
4222   "Remove any message with the given LABEL from the message-stack,
4223 erasing it from the echo area if it's currently displayed there.
4224 If a message remains at the head of the message-stack and NO-RESTORE
4225 is nil, it will be displayed.  The string which remains in the echo
4226 area will be returned, or nil if the message-stack is now empty.
4227 If LABEL is nil, the entire message-stack is cleared.
4228
4229 Unless you need the return value or you need to specify a label,
4230 you should just use (message nil)."
4231   (or frame (setq frame (selected-frame)))
4232   (let ((clear-stream (and message-stack (eq 'stream (frame-type frame)))))
4233     (remove-message label frame)
4234     (let ((inhibit-read-only t)
4235           (zmacs-region-stays zmacs-region-stays)) ; preserve from change
4236       (erase-buffer " *Echo Area*"))
4237     (if clear-stream
4238         (send-string-to-terminal ?\n stdout-p))
4239     (if no-restore
4240         nil                     ; just preparing to put another msg up
4241       (if message-stack
4242           (let ((oldmsg (cdr (car message-stack))))
4243             (raw-append-message oldmsg frame stdout-p)
4244             oldmsg)
4245         ;; #### Should we (redisplay-echo-area) here?  Messes some
4246         ;; things up.
4247         nil))))
4248
4249 (defun remove-message (&optional label frame)
4250   ;; If label is nil, we want to remove all matching messages.
4251   ;; Must reverse the stack first to log them in the right order.
4252   (let ((log nil))
4253     (while (and message-stack
4254                 (or (null label)        ; null label means clear whole stack
4255                     (eq label (car (car message-stack)))))
4256       (push (car message-stack) log)
4257       (setq message-stack (cdr message-stack)))
4258     (let ((s  message-stack))
4259       (while (cdr s)
4260         (let ((msg (car (cdr s))))
4261           (if (eq label (car msg))
4262               (progn
4263                 (push msg log)
4264                 (setcdr s (cdr (cdr s))))
4265             (setq s (cdr s))))))
4266     ;; (possibly) log each removed message
4267     (while log
4268       (condition-case e
4269           (run-hook-with-args 'remove-message-hook
4270                               (car (car log)) (cdr (car log)))
4271         (error (setq remove-message-hook nil)
4272                (lwarn 'message-log 'warning
4273                  "Error caught in `remove-message-hook': %s"
4274                  (error-message-string e))
4275                (let ((inhibit-read-only t))
4276                  (erase-buffer " *Echo Area*"))
4277                (signal (car e) (cdr e))))
4278       (setq log (cdr log)))))
4279
4280 (defun append-message (label message &optional frame stdout-p)
4281   (or frame (setq frame (selected-frame)))
4282   ;; Add a new entry to the message-stack, or modify an existing one
4283   (let ((top (car message-stack)))
4284     (if (eq label (car top))
4285         (setcdr top (concat (cdr top) message))
4286       (push (cons label message) message-stack)))
4287   (raw-append-message message frame stdout-p))
4288
4289 ;; Really append the message to the echo area.  no fiddling with
4290 ;; message-stack.
4291 (defun raw-append-message (message &optional frame stdout-p)
4292   (unless (equal message "")
4293     (let ((inhibit-read-only t)
4294           (zmacs-region-stays zmacs-region-stays)) ; preserve from change
4295       (insert-string message " *Echo Area*")
4296       ;; Conditionalizing on the device type in this way is not that clean,
4297       ;; but neither is having a device method, as I originally implemented
4298       ;; it: all non-stream devices behave in the same way.  Perhaps
4299       ;; the cleanest way is to make the concept of a "redisplayable"
4300       ;; device, which stream devices are not.  Look into this more if
4301       ;; we ever create another non-redisplayable device type (e.g.
4302       ;; processes?  printers?).
4303
4304       ;; Don't redisplay the echo area if we are executing a macro.
4305       (if (not executing-kbd-macro)
4306           (if (eq 'stream (frame-type frame))
4307               (send-string-to-terminal message stdout-p (frame-device frame))
4308             (redisplay-echo-area))))))
4309
4310 (defun display-message (label message &optional frame stdout-p)
4311   "Print a one-line message at the bottom of the frame.  First argument
4312 LABEL is an identifier for this message.  MESSAGE is the string to display.
4313 Use `clear-message' to remove a labelled message.
4314
4315 Here are some standard labels (those marked with `*' are not logged
4316 by default--see the `log-message-ignore-labels' variable):
4317     message       default label used by the `message' function
4318     error         default label used for reporting errors
4319   * progress      progress indicators like \"Converting... 45%\"
4320   * prompt        prompt-like messages like \"I-search: foo\"
4321   * command       helper command messages like \"Mark set\"
4322   * no-log        messages that should never be logged"
4323   (clear-message label frame stdout-p t)
4324   (append-message label message frame stdout-p))
4325
4326 (defun current-message (&optional frame)
4327   "Return the current message in the echo area, or nil.
4328 The FRAME argument is currently unused."
4329   (cdr (car message-stack)))
4330
4331 ;;; may eventually be frame-dependent
4332 (defun current-message-label (&optional frame)
4333   (car (car message-stack)))
4334
4335 (defun message (fmt &rest args)
4336   "Print a one-line message at the bottom of the frame.
4337 The arguments are the same as to `format'.
4338
4339 If the only argument is nil, clear any existing message; let the
4340 minibuffer contents show."
4341   ;; questionable junk in the C code
4342   ;; (if (framep default-minibuffer-frame)
4343   ;;     (make-frame-visible default-minibuffer-frame))
4344   (if (and (null fmt) (null args))
4345       (prog1 nil
4346         (clear-message nil))
4347     (let ((str (apply 'format fmt args)))
4348       (display-message 'message str)
4349       str)))
4350
4351 (defun lmessage (label fmt &rest args)
4352   "Print a one-line message at the bottom of the frame.
4353 First argument LABEL is an identifier for this message.  The rest of the
4354 arguments are the same as to `format'.
4355
4356 See `display-message' for a list of standard labels."
4357   (if (and (null fmt) (null args))
4358       (prog1 nil
4359         (clear-message label nil))
4360     (let ((str (apply 'format fmt args)))
4361       (display-message label str)
4362       str)))
4363
4364 \f
4365 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4366 ;;                              warning code                             ;;
4367 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4368
4369 (defcustom log-warning-minimum-level 'info
4370   "Minimum level of warnings that should be logged.
4371 The warnings in levels below this are completely ignored, as if they never
4372 happened.
4373
4374 The recognized warning levels, in decreasing order of priority, are
4375 'emergency, 'alert, 'critical, 'error, 'warning, 'notice, 'info, and
4376 'debug.
4377
4378 See also `display-warning-minimum-level'.
4379
4380 You can also control which warnings are displayed on a class-by-class
4381 basis.  See `display-warning-suppressed-classes' and
4382 `log-warning-suppressed-classes'."
4383   :type '(choice (const emergency) (const alert) (const critical)
4384                  (const error) (const warning) (const notice)
4385                  (const info) (const debug))
4386   :group 'warnings)
4387
4388 (defcustom display-warning-minimum-level 'info
4389   "Minimum level of warnings that should be displayed.
4390 The warnings in levels below this will be generated, but not
4391 displayed.
4392
4393 The recognized warning levels, in decreasing order of priority, are
4394 'emergency, 'alert, 'critical, 'error, 'warning, 'notice, 'info, and
4395 'debug.
4396
4397 See also `log-warning-minimum-level'.
4398
4399 You can also control which warnings are displayed on a class-by-class
4400 basis.  See `display-warning-suppressed-classes' and
4401 `log-warning-suppressed-classes'."
4402   :type '(choice (const emergency) (const alert) (const critical)
4403                  (const error) (const warning) (const notice)
4404                  (const info) (const debug))
4405   :group 'warnings)
4406
4407 (defvar log-warning-suppressed-classes nil
4408   "List of classes of warnings that shouldn't be logged or displayed.
4409 If any of the CLASS symbols associated with a warning is the same as
4410 any of the symbols listed here, the warning will be completely ignored,
4411 as it they never happened.
4412
4413 NOTE: In most circumstances, you should *not* set this variable.
4414 Set `display-warning-suppressed-classes' instead.  That way the suppressed
4415 warnings are not displayed but are still unobtrusively logged.
4416
4417 See also `log-warning-minimum-level' and `display-warning-minimum-level'.")
4418
4419 (defcustom display-warning-suppressed-classes nil
4420   "List of classes of warnings that shouldn't be displayed.
4421 If any of the CLASS symbols associated with a warning is the same as
4422 any of the symbols listed here, the warning will not be displayed.
4423 The warning will still logged in the *Warnings* buffer (unless also
4424 contained in `log-warning-suppressed-classes'), but the buffer will
4425 not be automatically popped up.
4426
4427 See also `log-warning-minimum-level' and `display-warning-minimum-level'."
4428   :type '(repeat symbol)
4429   :group 'warnings)
4430
4431 (defvar warning-count 0
4432   "Count of the number of warning messages displayed so far.")
4433
4434 (defconst warning-level-alist '((emergency . 8)
4435                                 (alert . 7)
4436                                 (critical . 6)
4437                                 (error . 5)
4438                                 (warning . 4)
4439                                 (notice . 3)
4440                                 (info . 2)
4441                                 (debug . 1)))
4442
4443 (defun warning-level-p (level)
4444   "Non-nil if LEVEL specifies a warning level."
4445   (and (symbolp level) (assq level warning-level-alist)))
4446
4447 ;; If you're interested in rewriting this function, be aware that it
4448 ;; could be called at arbitrary points in a Lisp program (when a
4449 ;; built-in function wants to issue a warning, it will call out to
4450 ;; this function the next time some Lisp code is evaluated).  Therefore,
4451 ;; this function *must* not permanently modify any global variables
4452 ;; (e.g. the current buffer) except those that specifically apply
4453 ;; to the warning system.
4454
4455 (defvar before-init-deferred-warnings nil)
4456
4457 (defun after-init-display-warnings ()
4458   "Display warnings deferred till after the init file is run.
4459 Warnings that occur before then are deferred so that warning
4460 suppression in the .emacs file will be honored."
4461   (while before-init-deferred-warnings
4462     (apply 'display-warning (car before-init-deferred-warnings))
4463     (setq before-init-deferred-warnings
4464           (cdr before-init-deferred-warnings))))
4465
4466 (add-hook 'after-init-hook 'after-init-display-warnings)
4467
4468 (defun display-warning (class message &optional level)
4469   "Display a warning message.
4470 CLASS should be a symbol describing what sort of warning this is, such
4471 as `resource' or `key-mapping'.  A list of such symbols is also
4472 accepted. (Individual classes can be suppressed; see
4473 `display-warning-suppressed-classes'.)  Optional argument LEVEL can
4474 be used to specify a priority for the warning, other than default priority
4475 `warning'. (See `display-warning-minimum-level').  The message is
4476 inserted into the *Warnings* buffer, which is made visible at appropriate
4477 times."
4478   (or level (setq level 'warning))
4479   (or (listp class) (setq class (list class)))
4480   (check-argument-type 'warning-level-p level)
4481   (if (and (not (featurep 'infodock))
4482            (not init-file-loaded))
4483       (push (list class message level) before-init-deferred-warnings)
4484     (catch 'ignored
4485       (let ((display-p t)
4486             (level-num (cdr (assq level warning-level-alist))))
4487         (if (< level-num (cdr (assq log-warning-minimum-level
4488                                     warning-level-alist)))
4489             (throw 'ignored nil))
4490         (if (intersection class log-warning-suppressed-classes)
4491             (throw 'ignored nil))
4492
4493         (if (< level-num (cdr (assq display-warning-minimum-level
4494                                     warning-level-alist)))
4495             (setq display-p nil))
4496         (if (and display-p
4497                  (intersection class display-warning-suppressed-classes))
4498             (setq display-p nil))
4499         (let ((buffer (get-buffer-create "*Warnings*")))
4500           (when display-p
4501             ;; The C code looks at display-warning-tick to determine
4502             ;; when it should call `display-warning-buffer'.  Change it
4503             ;; to get the C code's attention.
4504             (incf display-warning-tick))
4505           (with-current-buffer buffer
4506             (goto-char (point-max))
4507             (incf warning-count)
4508             (princ (format "(%d) (%s/%s) "
4509                            warning-count
4510                            (mapconcat 'symbol-name class ",")
4511                            level)
4512                    buffer)
4513             (princ message buffer)
4514             (terpri buffer)
4515             (terpri buffer)))))))
4516
4517 (defun warn (&rest args)
4518   "Display a warning message.
4519 The message is constructed by passing all args to `format'.  The message
4520 is placed in the *Warnings* buffer, which will be popped up at the next
4521 redisplay.  The class of the warning is `warning'.  See also
4522 `display-warning'."
4523   (display-warning 'warning (apply 'format args)))
4524
4525 (defun lwarn (class level &rest args)
4526   "Display a labeled warning message.
4527 CLASS should be a symbol describing what sort of warning this is, such
4528 as `resource' or `key-mapping'.  A list of such symbols is also
4529 accepted. (Individual classes can be suppressed; see
4530 `display-warning-suppressed-classes'.)  If non-nil, LEVEL can be used
4531 to specify a priority for the warning, other than default priority
4532 `warning'. (See `display-warning-minimum-level').  The message is
4533 inserted into the *Warnings* buffer, which is made visible at appropriate
4534 times.
4535
4536 The rest of the arguments are passed to `format'."
4537   (display-warning class (apply 'format args)
4538                    (or level 'warning)))
4539
4540 (defvar warning-marker nil)
4541
4542 ;; When this function is called by the C code, all non-local exits are
4543 ;; trapped and C-g is inhibited; therefore, it would be a very, very
4544 ;; bad idea for this function to get into an infinite loop.
4545
4546 (defun display-warning-buffer ()
4547   "Make the buffer that contains the warnings be visible.
4548 The C code calls this periodically, right before redisplay."
4549   (let ((buffer (get-buffer-create "*Warnings*")))
4550     (when (or (not warning-marker)
4551               (not (eq (marker-buffer warning-marker) buffer)))
4552       (setq warning-marker (make-marker))
4553       (set-marker warning-marker 1 buffer))
4554     (if temp-buffer-show-function
4555         (progn
4556           (funcall temp-buffer-show-function buffer)
4557           (mapc #'(lambda (win) (set-window-start win warning-marker))
4558                 (windows-of-buffer buffer nil t)))
4559       (set-window-start (display-buffer buffer) warning-marker))
4560     (set-marker warning-marker (point-max buffer) buffer)))
4561
4562 \f
4563 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4564 ;;                                misc junk                              ;;
4565 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4566
4567 (defun emacs-name ()
4568   "Return the printable name of this instance of Emacs."
4569   (cond ((featurep 'infodock) "InfoDock")
4570         ((featurep 'xemacs) "XEmacs")
4571         (t "Emacs")))
4572
4573 (defun debug-print (format &rest args)
4574   "Send a string to the debugging output.
4575 The string is formatted using (apply #'format FORMAT ARGS)."
4576   (princ (apply #'format format args) 'external-debugging-output))
4577
4578 ;;; simple.el ends here