annotate lisp/page.el @ 2929:92ef390fc71f

[xemacs-hg @ 2005-09-14 04:07:08 by stephent] update for cucumber
author stephent
date Wed, 14 Sep 2005 04:07:08 +0000
parents 6f72d9a709c3
children 308d34e9f07d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2510
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
1 ;;; page.el --- page motion commands for Emacs
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
2
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
3 ;; Copyright (C) 1985, 1997 Free Software Foundation, Inc.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
4
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
5 ;; Maintainer: FSF
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
6 ;; Keywords: extensions, dumped
2510
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
7 ;; Keywords: wp convenience
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
8
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
9 ;; This file is part of XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
10
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
11 ;; XEmacs is free software; you can redistribute it and/or modify it
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
12 ;; under the terms of the GNU General Public License as published by
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
14 ;; any later version.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
15
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
16 ;; XEmacs is distributed in the hope that it will be useful, but
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
19 ;; General Public License for more details.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
20
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
22 ;; along with XEmacs; see the file COPYING. If not, write to the Free
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
23 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
24 ;; 02111-1307, USA.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
25
2510
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
26 ;;; Synched up with: FSF 21.3.
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
27
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
28 ;;; Commentary:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
29
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
30 ;; This file is dumped with XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
31
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
32 ;; This code provides the page-oriented movement and selection commands
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
33 ;; documented in the XEmacs Reference Manual.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
34
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
35 ;;; Code:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
36
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
37 (defun forward-page (&optional count)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
38 "Move forward to page boundary. With arg, repeat, or go back if negative.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
39 A page boundary is any line whose beginning matches the regexp
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
40 `page-delimiter'."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
41 (interactive "_p") ; XEmacs
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
42 (or count (setq count 1))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
43 (while (and (> count 0) (not (eobp)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
44 ;; In case the page-delimiter matches the null string,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
45 ;; don't find a match without moving.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
46 (if (bolp) (forward-char 1))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
47 (if (re-search-forward page-delimiter nil t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
48 nil
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
49 (goto-char (point-max)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
50 (setq count (1- count)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
51 (while (and (< count 0) (not (bobp)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
52 ;; In case the page-delimiter matches the null string,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
53 ;; don't find a match without moving.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
54 (and (save-excursion (re-search-backward page-delimiter nil t))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
55 (= (match-end 0) (point))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
56 (goto-char (match-beginning 0)))
446
1ccc32a20af4 Import from CVS: tag r21-2-38
cvs
parents: 209
diff changeset
57 (backward-char 1)
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
58 (if (re-search-backward page-delimiter nil t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
59 ;; We found one--move to the end of it.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
60 (goto-char (match-end 0))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
61 ;; We found nothing--go to beg of buffer.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
62 (goto-char (point-min)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
63 (setq count (1+ count))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
64
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
65 (defun backward-page (&optional count)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
66 "Move backward to page boundary. With arg, repeat, or go fwd if negative.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
67 A page boundary is any line whose beginning matches the regexp
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
68 `page-delimiter'."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
69 (interactive "_p") ; XEmacs
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
70 (or count (setq count 1))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
71 (forward-page (- count)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
72
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
73 (defun mark-page (&optional arg)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
74 "Put mark at end of page, point at beginning.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
75 A numeric arg specifies to move forward or backward by that many pages,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
76 thus marking a page other than the one point was originally in."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
77 (interactive "P")
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
78 (setq arg (if arg (prefix-numeric-value arg) 0))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
79 (if (> arg 0)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
80 (forward-page arg)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
81 (if (< arg 0)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
82 (forward-page (1- arg))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
83 (forward-page)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
84 (push-mark nil t t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
85 (forward-page -1))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
86
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
87 (defun narrow-to-page (&optional arg)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
88 "Make text outside current page invisible.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
89 A numeric arg specifies to move forward or backward by that many pages,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
90 thus showing a page other than the one point was originally in."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
91 (interactive "P")
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
92 (setq arg (if arg (prefix-numeric-value arg) 0))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
93 (save-excursion
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
94 (widen)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
95 (if (> arg 0)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
96 (forward-page arg)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
97 (if (< arg 0)
2510
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
98 (let ((adjust 0)
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
99 (opoint (point)))
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
100 ;; If we are not now at the beginning of a page,
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
101 ;; move back one extra time, to get to the start of this page.
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
102 (save-excursion
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
103 (beginning-of-line)
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
104 (or (and (looking-at page-delimiter)
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
105 (eq (match-end 0) opoint))
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
106 (setq adjust 1)))
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
107 (forward-page (- arg adjust)))))
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
108 ;; Find the end of the page.
2510
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
109 (set-match-data nil)
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
110 (forward-page)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
111 ;; If we stopped due to end of buffer, stay there.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
112 ;; If we stopped after a page delimiter, put end of restriction
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
113 ;; at the beginning of that line.
2510
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
114 ;; Before checking the match that was found,
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
115 ;; verify that forward-page actually set the match data.
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
116 (if (and (match-beginning 0)
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
117 (save-excursion
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
118 (goto-char (match-beginning 0)) ; was (beginning-of-line)
6f72d9a709c3 [xemacs-hg @ 2005-01-26 09:56:05 by ben]
ben
parents: 446
diff changeset
119 (looking-at page-delimiter)))
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
120 (beginning-of-line))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
121 (narrow-to-region (point)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
122 (progn
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
123 ;; Find the top of the page.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
124 (forward-page -1)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
125 ;; If we found beginning of buffer, stay there.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
126 ;; If extra text follows page delimiter on same line,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
127 ;; include it.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
128 ;; Otherwise, show text starting with following line.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
129 (if (and (eolp) (not (bobp)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
130 (forward-line 1))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
131 (point)))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
132 (put 'narrow-to-page 'disabled t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
133
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
134 (defun count-lines-page ()
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
135 "Report number of lines on current page, and how many are before or after point."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
136 (interactive "_") ; XEmacs
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
137 (save-excursion
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
138 (let ((opoint (point)) beg end
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
139 total before after)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
140 (forward-page)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
141 (beginning-of-line)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
142 (or (looking-at page-delimiter)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
143 (end-of-line))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
144 (setq end (point))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
145 (backward-page)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
146 (setq beg (point))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
147 (setq total (count-lines beg end)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
148 before (count-lines beg opoint)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
149 after (count-lines opoint end))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
150 (message "Page has %d lines (%d + %d)" total before after))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
151
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
152 (defun what-page ()
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
153 "Print page and line number of point."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
154 (interactive "_") ; XEmacs
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
155 (save-restriction
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
156 (widen)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
157 (save-excursion
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
158 (beginning-of-line)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
159 (let ((count 1)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
160 (opoint (point)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
161 (goto-char 1)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
162 (while (re-search-forward page-delimiter opoint t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
163 (setq count (1+ count)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
164 (message "Page %d, line %d"
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
165 count
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
166 (1+ (count-lines (point) opoint)))))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
167
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
168 ;;; Place `provide' at end of file.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
169 (provide 'page)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
170
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
171 ;;; page.el ends here