page.el 4.49 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; page.el --- page motion commands for emacs.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
3 4
;; Copyright (C) 1985 Free Software Foundation, Inc.

Eric S. Raymond's avatar
Eric S. Raymond committed
5 6
;; Maintainer: FSF

Joseph Arceneaux's avatar
Joseph Arceneaux committed
7 8 9 10
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
11
;; the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
12 13 14 15 16 17 18 19 20 21 22
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

23 24 25 26 27
;;; Commentary:

;; This code provides the page-oriented movement and selection commands
;; documented in the Emacs manual.

Eric S. Raymond's avatar
Eric S. Raymond committed
28
;;; Code:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
29 30 31

(defun forward-page (&optional count)
  "Move forward to page boundary.  With arg, repeat, or go back if negative.
Jim Blandy's avatar
Jim Blandy committed
32 33
A page boundary is any line whose beginning matches the regexp
`page-delimiter'."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
34 35 36
  (interactive "p")
  (or count (setq count 1))
  (while (and (> count 0) (not (eobp)))
Richard M. Stallman's avatar
Richard M. Stallman committed
37 38 39
    ;; In case the page-delimiter matches the null string,
    ;; don't find a match without moving.
    (if (bolp) (forward-char 1))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
40 41 42 43 44 45 46 47 48 49 50 51 52
    (if (re-search-forward page-delimiter nil t)
	nil
      (goto-char (point-max)))
    (setq count (1- count)))
  (while (and (< count 0) (not (bobp)))
    (forward-char -1)
    (if (re-search-backward page-delimiter nil t)
	(goto-char (match-end 0))
      (goto-char (point-min)))
    (setq count (1+ count))))

(defun backward-page (&optional count)
  "Move backward to page boundary.  With arg, repeat, or go fwd if negative.
Jim Blandy's avatar
Jim Blandy committed
53 54
A page boundary is any line whose beginning matches the regexp
`page-delimiter'."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
  (interactive "p")
  (or count (setq count 1))
  (forward-page (- count)))

(defun mark-page (&optional arg)
  "Put mark at end of page, point at beginning.
A numeric arg specifies to move forward or backward by that many pages,
thus marking a page other than the one point was originally in."
  (interactive "P")
  (setq arg (if arg (prefix-numeric-value arg) 0))
  (if (> arg 0)
      (forward-page arg)
    (if (< arg 0)
        (forward-page (1- arg))))
  (forward-page)
70
  (push-mark nil t t)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
  (forward-page -1))

(defun narrow-to-page (&optional arg)
  "Make text outside current page invisible.
A numeric arg specifies to move forward or backward by that many pages,
thus showing a page other than the one point was originally in."
  (interactive "P")
  (setq arg (if arg (prefix-numeric-value arg) 0))
  (save-excursion
    (widen)
    (if (> arg 0)
	(forward-page arg)
      (if (< arg 0)
	  (forward-page (1- arg))))
    ;; Find the end of the page.
    (forward-page)
    ;; If we stopped due to end of buffer, stay there.
    ;; If we stopped after a page delimiter, put end of restriction
    ;; at the beginning of that line.
Richard M. Stallman's avatar
Richard M. Stallman committed
90 91 92
    (if (save-excursion
	  (goto-char (match-beginning 0)) ; was (beginning-of-line)
	  (looking-at page-delimiter))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
93 94 95 96 97 98 99 100 101 102 103 104
	(beginning-of-line))
    (narrow-to-region (point)
		      (progn
			;; Find the top of the page.
			(forward-page -1)
			;; If we found beginning of buffer, stay there.
			;; If extra text follows page delimiter on same line,
			;; include it.
			;; Otherwise, show text starting with following line.
			(if (and (eolp) (not (bobp)))
			    (forward-line 1))
			(point)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
105
(put 'narrow-to-page 'disabled t)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139

(defun count-lines-page ()
  "Report number of lines on current page, and how many are before or after point."
  (interactive)
  (save-excursion
    (let ((opoint (point)) beg end
	  total before after)
      (forward-page)
      (beginning-of-line)
      (or (looking-at page-delimiter)
	  (end-of-line))
      (setq end (point))
      (backward-page)
      (setq beg (point))
      (setq total (count-lines beg end)
	    before (count-lines beg opoint)
	    after (count-lines opoint end))
      (message "Page has %d lines (%d + %d)" total before after))))

(defun what-page ()
  "Print page and line number of point."
  (interactive)
  (save-restriction
    (widen)
    (save-excursion
      (beginning-of-line)
      (let ((count 1)
	    (opoint (point)))
	(goto-char 1)
	(while (re-search-forward page-delimiter opoint t)
	  (setq count (1+ count)))
	(message "Page %d, line %d"
		 count
		 (1+ (count-lines (point) opoint)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
140 141 142

;;; Place `provide' at end of file.
(provide 'page)
Eric S. Raymond's avatar
Eric S. Raymond committed
143 144

;;; page.el ends here